Ricardo Benitez / mbed

meh

Fork of mbed by mbed official

TARGET_NUCLEO_F411RE/stm32f4xx_hal_nor.h@118:16969dd821af, 2016-04-05 (annotated)

Committer:
ricardobtez
Date:
Tue Apr 05 23:51:21 2016 +0000
Revision:
118:16969dd821af
Parent:
86:04dd9b1680ae
Child:
99:dbbf35b96557
dgdgr

Who changed what in which revision?

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