Fork of the official mbed C/C SDK provides the software platform and libraries to build your applications for RenBED.

Dependents:   1-RenBuggyTimed RenBED_RGB RenBED_RGB_PWM RenBED_RGB

Fork of mbed by mbed official

Committer:
elijahorr
Date:
Thu Apr 14 07:28:54 2016 +0000
Revision:
121:672067c3ada4
Parent:
110:165afa46840b
.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Kojto 110:165afa46840b 1 /**
Kojto 110:165afa46840b 2 ******************************************************************************
Kojto 110:165afa46840b 3 * @file stm32f4xx_hal_nor.h
Kojto 110:165afa46840b 4 * @author MCD Application Team
Kojto 110:165afa46840b 5 * @version V1.4.1
Kojto 110:165afa46840b 6 * @date 09-October-2015
Kojto 110:165afa46840b 7 * @brief Header file of NOR HAL module.
Kojto 110:165afa46840b 8 ******************************************************************************
Kojto 110:165afa46840b 9 * @attention
Kojto 110:165afa46840b 10 *
Kojto 110:165afa46840b 11 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
Kojto 110:165afa46840b 12 *
Kojto 110:165afa46840b 13 * Redistribution and use in source and binary forms, with or without modification,
Kojto 110:165afa46840b 14 * are permitted provided that the following conditions are met:
Kojto 110:165afa46840b 15 * 1. Redistributions of source code must retain the above copyright notice,
Kojto 110:165afa46840b 16 * this list of conditions and the following disclaimer.
Kojto 110:165afa46840b 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
Kojto 110:165afa46840b 18 * this list of conditions and the following disclaimer in the documentation
Kojto 110:165afa46840b 19 * and/or other materials provided with the distribution.
Kojto 110:165afa46840b 20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
Kojto 110:165afa46840b 21 * may be used to endorse or promote products derived from this software
Kojto 110:165afa46840b 22 * without specific prior written permission.
Kojto 110:165afa46840b 23 *
Kojto 110:165afa46840b 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
Kojto 110:165afa46840b 25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
Kojto 110:165afa46840b 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
Kojto 110:165afa46840b 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
Kojto 110:165afa46840b 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
Kojto 110:165afa46840b 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
Kojto 110:165afa46840b 30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
Kojto 110:165afa46840b 31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
Kojto 110:165afa46840b 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
Kojto 110:165afa46840b 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Kojto 110:165afa46840b 34 *
Kojto 110:165afa46840b 35 ******************************************************************************
Kojto 110:165afa46840b 36 */
Kojto 110:165afa46840b 37
Kojto 110:165afa46840b 38 /* Define to prevent recursive inclusion -------------------------------------*/
Kojto 110:165afa46840b 39 #ifndef __STM32F4xx_HAL_NOR_H
Kojto 110:165afa46840b 40 #define __STM32F4xx_HAL_NOR_H
Kojto 110:165afa46840b 41
Kojto 110:165afa46840b 42 #ifdef __cplusplus
Kojto 110:165afa46840b 43 extern "C" {
Kojto 110:165afa46840b 44 #endif
Kojto 110:165afa46840b 45
Kojto 110:165afa46840b 46 /* Includes ------------------------------------------------------------------*/
Kojto 110:165afa46840b 47 #if defined(STM32F405xx) || defined(STM32F415xx) || defined(STM32F407xx) || defined(STM32F417xx)
Kojto 110:165afa46840b 48 #include "stm32f4xx_ll_fsmc.h"
Kojto 110:165afa46840b 49 #endif /* STM32F405xx || STM32F415xx || STM32F407xx || STM32F417xx */
Kojto 110:165afa46840b 50
Kojto 110:165afa46840b 51 #if defined(STM32F427xx) || defined(STM32F437xx) || defined(STM32F429xx) || defined(STM32F439xx) ||\
Kojto 110:165afa46840b 52 defined(STM32F446xx) || defined(STM32F469xx) || defined(STM32F479xx)
Kojto 110:165afa46840b 53 #include "stm32f4xx_ll_fmc.h"
Kojto 110:165afa46840b 54 #endif /* STM32F427xx || STM32F437xx || STM32F429xx || STM32F439xx || STM32F446xx || STM32F469xx || STM32F479xx */
Kojto 110:165afa46840b 55
Kojto 110:165afa46840b 56 /** @addtogroup STM32F4xx_HAL_Driver
Kojto 110:165afa46840b 57 * @{
Kojto 110:165afa46840b 58 */
Kojto 110:165afa46840b 59
Kojto 110:165afa46840b 60 /** @addtogroup NOR
Kojto 110:165afa46840b 61 * @{
Kojto 110:165afa46840b 62 */
Kojto 110:165afa46840b 63
Kojto 110:165afa46840b 64 #if defined(STM32F405xx) || defined(STM32F415xx) || defined(STM32F407xx) || defined(STM32F417xx) ||\
Kojto 110:165afa46840b 65 defined(STM32F427xx) || defined(STM32F437xx) || defined(STM32F429xx) || defined(STM32F439xx) ||\
Kojto 110:165afa46840b 66 defined(STM32F446xx) || defined(STM32F469xx) || defined(STM32F479xx)
Kojto 110:165afa46840b 67
Kojto 110:165afa46840b 68 /* Exported typedef ----------------------------------------------------------*/
Kojto 110:165afa46840b 69 /** @defgroup NOR_Exported_Types NOR Exported Types
Kojto 110:165afa46840b 70 * @{
Kojto 110:165afa46840b 71 */
Kojto 110:165afa46840b 72
Kojto 110:165afa46840b 73 /**
Kojto 110:165afa46840b 74 * @brief HAL SRAM State structures definition
Kojto 110:165afa46840b 75 */
Kojto 110:165afa46840b 76 typedef enum
Kojto 110:165afa46840b 77 {
Kojto 110:165afa46840b 78 HAL_NOR_STATE_RESET = 0x00, /*!< NOR not yet initialized or disabled */
Kojto 110:165afa46840b 79 HAL_NOR_STATE_READY = 0x01, /*!< NOR initialized and ready for use */
Kojto 110:165afa46840b 80 HAL_NOR_STATE_BUSY = 0x02, /*!< NOR internal processing is ongoing */
Kojto 110:165afa46840b 81 HAL_NOR_STATE_ERROR = 0x03, /*!< NOR error state */
Kojto 110:165afa46840b 82 HAL_NOR_STATE_PROTECTED = 0x04 /*!< NOR NORSRAM device write protected */
Kojto 110:165afa46840b 83 }HAL_NOR_StateTypeDef;
Kojto 110:165afa46840b 84
Kojto 110:165afa46840b 85 /**
Kojto 110:165afa46840b 86 * @brief FMC NOR Status typedef
Kojto 110:165afa46840b 87 */
Kojto 110:165afa46840b 88 typedef enum
Kojto 110:165afa46840b 89 {
Kojto 110:165afa46840b 90 HAL_NOR_STATUS_SUCCESS = 0,
Kojto 110:165afa46840b 91 HAL_NOR_STATUS_ONGOING,
Kojto 110:165afa46840b 92 HAL_NOR_STATUS_ERROR,
Kojto 110:165afa46840b 93 HAL_NOR_STATUS_TIMEOUT
Kojto 110:165afa46840b 94 }HAL_NOR_StatusTypeDef;
Kojto 110:165afa46840b 95
Kojto 110:165afa46840b 96 /**
Kojto 110:165afa46840b 97 * @brief FMC NOR ID typedef
Kojto 110:165afa46840b 98 */
Kojto 110:165afa46840b 99 typedef struct
Kojto 110:165afa46840b 100 {
Kojto 110:165afa46840b 101 uint16_t Manufacturer_Code; /*!< Defines the device's manufacturer code used to identify the memory */
Kojto 110:165afa46840b 102
Kojto 110:165afa46840b 103 uint16_t Device_Code1;
Kojto 110:165afa46840b 104
Kojto 110:165afa46840b 105 uint16_t Device_Code2;
Kojto 110:165afa46840b 106
Kojto 110:165afa46840b 107 uint16_t Device_Code3; /*!< Defines the device's codes used to identify the memory.
Kojto 110:165afa46840b 108 These codes can be accessed by performing read operations with specific
Kojto 110:165afa46840b 109 control signals and addresses set.They can also be accessed by issuing
Kojto 110:165afa46840b 110 an Auto Select command */
Kojto 110:165afa46840b 111 }NOR_IDTypeDef;
Kojto 110:165afa46840b 112
Kojto 110:165afa46840b 113 /**
Kojto 110:165afa46840b 114 * @brief FMC NOR CFI typedef
Kojto 110:165afa46840b 115 */
Kojto 110:165afa46840b 116 typedef struct
Kojto 110:165afa46840b 117 {
Kojto 110:165afa46840b 118 /*!< Defines the information stored in the memory's Common flash interface
Kojto 110:165afa46840b 119 which contains a description of various electrical and timing parameters,
Kojto 110:165afa46840b 120 density information and functions supported by the memory */
Kojto 110:165afa46840b 121
Kojto 110:165afa46840b 122 uint16_t CFI_1;
Kojto 110:165afa46840b 123
Kojto 110:165afa46840b 124 uint16_t CFI_2;
Kojto 110:165afa46840b 125
Kojto 110:165afa46840b 126 uint16_t CFI_3;
Kojto 110:165afa46840b 127
Kojto 110:165afa46840b 128 uint16_t CFI_4;
Kojto 110:165afa46840b 129 }NOR_CFITypeDef;
Kojto 110:165afa46840b 130
Kojto 110:165afa46840b 131 /**
Kojto 110:165afa46840b 132 * @brief NOR handle Structure definition
Kojto 110:165afa46840b 133 */
Kojto 110:165afa46840b 134 typedef struct
Kojto 110:165afa46840b 135 {
Kojto 110:165afa46840b 136 FMC_NORSRAM_TypeDef *Instance; /*!< Register base address */
Kojto 110:165afa46840b 137
Kojto 110:165afa46840b 138 FMC_NORSRAM_EXTENDED_TypeDef *Extended; /*!< Extended mode register base address */
Kojto 110:165afa46840b 139
Kojto 110:165afa46840b 140 FMC_NORSRAM_InitTypeDef Init; /*!< NOR device control configuration parameters */
Kojto 110:165afa46840b 141
Kojto 110:165afa46840b 142 HAL_LockTypeDef Lock; /*!< NOR locking object */
Kojto 110:165afa46840b 143
Kojto 110:165afa46840b 144 __IO HAL_NOR_StateTypeDef State; /*!< NOR device access state */
Kojto 110:165afa46840b 145
Kojto 110:165afa46840b 146 }NOR_HandleTypeDef;
Kojto 110:165afa46840b 147 /**
Kojto 110:165afa46840b 148 * @}
Kojto 110:165afa46840b 149 */
Kojto 110:165afa46840b 150
Kojto 110:165afa46840b 151 /* Exported constants --------------------------------------------------------*/
Kojto 110:165afa46840b 152 /* Exported macros ------------------------------------------------------------*/
Kojto 110:165afa46840b 153 /** @defgroup NOR_Exported_Macros NOR Exported Macros
Kojto 110:165afa46840b 154 * @{
Kojto 110:165afa46840b 155 */
Kojto 110:165afa46840b 156 /** @brief Reset NOR handle state
Kojto 110:165afa46840b 157 * @param __HANDLE__: specifies the NOR handle.
Kojto 110:165afa46840b 158 * @retval None
Kojto 110:165afa46840b 159 */
Kojto 110:165afa46840b 160 #define __HAL_NOR_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_NOR_STATE_RESET)
Kojto 110:165afa46840b 161 /**
Kojto 110:165afa46840b 162 * @}
Kojto 110:165afa46840b 163 */
Kojto 110:165afa46840b 164
Kojto 110:165afa46840b 165 /* Exported functions --------------------------------------------------------*/
Kojto 110:165afa46840b 166 /** @addtogroup NOR_Exported_Functions
Kojto 110:165afa46840b 167 * @{
Kojto 110:165afa46840b 168 */
Kojto 110:165afa46840b 169
Kojto 110:165afa46840b 170 /** @addtogroup NOR_Exported_Functions_Group1
Kojto 110:165afa46840b 171 * @{
Kojto 110:165afa46840b 172 */
Kojto 110:165afa46840b 173 /* Initialization/de-initialization functions ********************************/
Kojto 110:165afa46840b 174 HAL_StatusTypeDef HAL_NOR_Init(NOR_HandleTypeDef *hnor, FMC_NORSRAM_TimingTypeDef *Timing, FMC_NORSRAM_TimingTypeDef *ExtTiming);
Kojto 110:165afa46840b 175 HAL_StatusTypeDef HAL_NOR_DeInit(NOR_HandleTypeDef *hnor);
Kojto 110:165afa46840b 176 void HAL_NOR_MspInit(NOR_HandleTypeDef *hnor);
Kojto 110:165afa46840b 177 void HAL_NOR_MspDeInit(NOR_HandleTypeDef *hnor);
Kojto 110:165afa46840b 178 void HAL_NOR_MspWait(NOR_HandleTypeDef *hnor, uint32_t Timeout);
Kojto 110:165afa46840b 179 /**
Kojto 110:165afa46840b 180 * @}
Kojto 110:165afa46840b 181 */
Kojto 110:165afa46840b 182
Kojto 110:165afa46840b 183 /** @addtogroup NOR_Exported_Functions_Group2
Kojto 110:165afa46840b 184 * @{
Kojto 110:165afa46840b 185 */
Kojto 110:165afa46840b 186 /* I/O operation functions ***************************************************/
Kojto 110:165afa46840b 187 HAL_StatusTypeDef HAL_NOR_Read_ID(NOR_HandleTypeDef *hnor, NOR_IDTypeDef *pNOR_ID);
Kojto 110:165afa46840b 188 HAL_StatusTypeDef HAL_NOR_ReturnToReadMode(NOR_HandleTypeDef *hnor);
Kojto 110:165afa46840b 189 HAL_StatusTypeDef HAL_NOR_Read(NOR_HandleTypeDef *hnor, uint32_t *pAddress, uint16_t *pData);
Kojto 110:165afa46840b 190 HAL_StatusTypeDef HAL_NOR_Program(NOR_HandleTypeDef *hnor, uint32_t *pAddress, uint16_t *pData);
Kojto 110:165afa46840b 191
Kojto 110:165afa46840b 192 HAL_StatusTypeDef HAL_NOR_ReadBuffer(NOR_HandleTypeDef *hnor, uint32_t uwAddress, uint16_t *pData, uint32_t uwBufferSize);
Kojto 110:165afa46840b 193 HAL_StatusTypeDef HAL_NOR_ProgramBuffer(NOR_HandleTypeDef *hnor, uint32_t uwAddress, uint16_t *pData, uint32_t uwBufferSize);
Kojto 110:165afa46840b 194
Kojto 110:165afa46840b 195 HAL_StatusTypeDef HAL_NOR_Erase_Block(NOR_HandleTypeDef *hnor, uint32_t BlockAddress, uint32_t Address);
Kojto 110:165afa46840b 196 HAL_StatusTypeDef HAL_NOR_Erase_Chip(NOR_HandleTypeDef *hnor, uint32_t Address);
Kojto 110:165afa46840b 197 HAL_StatusTypeDef HAL_NOR_Read_CFI(NOR_HandleTypeDef *hnor, NOR_CFITypeDef *pNOR_CFI);
Kojto 110:165afa46840b 198 /**
Kojto 110:165afa46840b 199 * @}
Kojto 110:165afa46840b 200 */
Kojto 110:165afa46840b 201
Kojto 110:165afa46840b 202 /** @addtogroup NOR_Exported_Functions_Group3
Kojto 110:165afa46840b 203 * @{
Kojto 110:165afa46840b 204 */
Kojto 110:165afa46840b 205 /* NOR Control functions *****************************************************/
Kojto 110:165afa46840b 206 HAL_StatusTypeDef HAL_NOR_WriteOperation_Enable(NOR_HandleTypeDef *hnor);
Kojto 110:165afa46840b 207 HAL_StatusTypeDef HAL_NOR_WriteOperation_Disable(NOR_HandleTypeDef *hnor);
Kojto 110:165afa46840b 208 /**
Kojto 110:165afa46840b 209 * @}
Kojto 110:165afa46840b 210 */
Kojto 110:165afa46840b 211
Kojto 110:165afa46840b 212 /** @addtogroup NOR_Exported_Functions_Group4
Kojto 110:165afa46840b 213 * @{
Kojto 110:165afa46840b 214 */
Kojto 110:165afa46840b 215 /* NOR State functions ********************************************************/
Kojto 110:165afa46840b 216 HAL_NOR_StateTypeDef HAL_NOR_GetState(NOR_HandleTypeDef *hnor);
Kojto 110:165afa46840b 217 HAL_NOR_StatusTypeDef HAL_NOR_GetStatus(NOR_HandleTypeDef *hnor, uint32_t Address, uint32_t Timeout);
Kojto 110:165afa46840b 218 /**
Kojto 110:165afa46840b 219 * @}
Kojto 110:165afa46840b 220 */
Kojto 110:165afa46840b 221
Kojto 110:165afa46840b 222 /**
Kojto 110:165afa46840b 223 * @}
Kojto 110:165afa46840b 224 */
Kojto 110:165afa46840b 225
Kojto 110:165afa46840b 226 /* Private types -------------------------------------------------------------*/
Kojto 110:165afa46840b 227 /* Private variables ---------------------------------------------------------*/
Kojto 110:165afa46840b 228 /* Private constants ---------------------------------------------------------*/
Kojto 110:165afa46840b 229 /** @defgroup NOR_Private_Constants NOR Private Constants
Kojto 110:165afa46840b 230 * @{
Kojto 110:165afa46840b 231 */
Kojto 110:165afa46840b 232 /* NOR device IDs addresses */
Kojto 110:165afa46840b 233 #define MC_ADDRESS ((uint16_t)0x0000)
Kojto 110:165afa46840b 234 #define DEVICE_CODE1_ADDR ((uint16_t)0x0001)
Kojto 110:165afa46840b 235 #define DEVICE_CODE2_ADDR ((uint16_t)0x000E)
Kojto 110:165afa46840b 236 #define DEVICE_CODE3_ADDR ((uint16_t)0x000F)
Kojto 110:165afa46840b 237
Kojto 110:165afa46840b 238 /* NOR CFI IDs addresses */
Kojto 110:165afa46840b 239 #define CFI1_ADDRESS ((uint16_t)0x61)
Kojto 110:165afa46840b 240 #define CFI2_ADDRESS ((uint16_t)0x62)
Kojto 110:165afa46840b 241 #define CFI3_ADDRESS ((uint16_t)0x63)
Kojto 110:165afa46840b 242 #define CFI4_ADDRESS ((uint16_t)0x64)
Kojto 110:165afa46840b 243
Kojto 110:165afa46840b 244 /* NOR operation wait timeout */
Kojto 110:165afa46840b 245 #define NOR_TMEOUT ((uint16_t)0xFFFF)
Kojto 110:165afa46840b 246
Kojto 110:165afa46840b 247 /* NOR memory data width */
Kojto 110:165afa46840b 248 #define NOR_MEMORY_8B ((uint8_t)0x0)
Kojto 110:165afa46840b 249 #define NOR_MEMORY_16B ((uint8_t)0x1)
Kojto 110:165afa46840b 250
Kojto 110:165afa46840b 251 /* NOR memory device read/write start address */
Kojto 110:165afa46840b 252 #define NOR_MEMORY_ADRESS1 ((uint32_t)0x60000000)
Kojto 110:165afa46840b 253 #define NOR_MEMORY_ADRESS2 ((uint32_t)0x64000000)
Kojto 110:165afa46840b 254 #define NOR_MEMORY_ADRESS3 ((uint32_t)0x68000000)
Kojto 110:165afa46840b 255 #define NOR_MEMORY_ADRESS4 ((uint32_t)0x6C000000)
Kojto 110:165afa46840b 256 /**
Kojto 110:165afa46840b 257 * @}
Kojto 110:165afa46840b 258 */
Kojto 110:165afa46840b 259
Kojto 110:165afa46840b 260 /* Private macros ------------------------------------------------------------*/
Kojto 110:165afa46840b 261 /** @defgroup NOR_Private_Macros NOR Private Macros
Kojto 110:165afa46840b 262 * @{
Kojto 110:165afa46840b 263 */
Kojto 110:165afa46840b 264 /**
Kojto 110:165afa46840b 265 * @brief NOR memory address shifting.
Kojto 110:165afa46840b 266 * @param __NOR_ADDRESS__: NOR base address
Kojto 110:165afa46840b 267 * @param NOR_MEMORY_WIDTH: NOR memory width
Kojto 110:165afa46840b 268 * @param ADDRESS: NOR memory address
Kojto 110:165afa46840b 269 * @retval NOR shifted address value
Kojto 110:165afa46840b 270 */
Kojto 110:165afa46840b 271 #define NOR_ADDR_SHIFT(__NOR_ADDRESS__, NOR_MEMORY_WIDTH, ADDRESS) (uint32_t)(((NOR_MEMORY_WIDTH) == NOR_MEMORY_8B)? ((uint32_t)((__NOR_ADDRESS__) + (2 * (ADDRESS)))):\
Kojto 110:165afa46840b 272 ((uint32_t)((__NOR_ADDRESS__) + (ADDRESS))))
Kojto 110:165afa46840b 273
Kojto 110:165afa46840b 274 /**
Kojto 110:165afa46840b 275 * @brief NOR memory write data to specified address.
Kojto 110:165afa46840b 276 * @param ADDRESS: NOR memory address
Kojto 110:165afa46840b 277 * @param DATA: Data to write
Kojto 110:165afa46840b 278 * @retval None
Kojto 110:165afa46840b 279 */
Kojto 110:165afa46840b 280 #define NOR_WRITE(ADDRESS, DATA) (*(__IO uint16_t *)((uint32_t)(ADDRESS)) = (DATA))
Kojto 110:165afa46840b 281
Kojto 110:165afa46840b 282 /**
Kojto 110:165afa46840b 283 * @}
Kojto 110:165afa46840b 284 */
Kojto 110:165afa46840b 285 #endif /* STM32F405xx || STM32F415xx || STM32F407xx || STM32F417xx ||\
Kojto 110:165afa46840b 286 STM32F427xx || STM32F437xx || STM32F429xx || STM32F439xx ||\
Kojto 110:165afa46840b 287 STM32F446xx || STM32F469xx || STM32F479xx */
Kojto 110:165afa46840b 288 /**
Kojto 110:165afa46840b 289 * @}
Kojto 110:165afa46840b 290 */
Kojto 110:165afa46840b 291
Kojto 110:165afa46840b 292 /**
Kojto 110:165afa46840b 293 * @}
Kojto 110:165afa46840b 294 */
Kojto 110:165afa46840b 295
Kojto 110:165afa46840b 296 #ifdef __cplusplus
Kojto 110:165afa46840b 297 }
Kojto 110:165afa46840b 298 #endif
Kojto 110:165afa46840b 299
Kojto 110:165afa46840b 300 #endif /* __STM32F4xx_HAL_NOR_H */
Kojto 110:165afa46840b 301
Kojto 110:165afa46840b 302 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/