shao ziyang / mbed-src-kl05

mbed library sources

Dependents:   frdm_kl05z_gpio_test

Fork of mbed-src by mbed official

targets/cmsis/TARGET_STM/TARGET_NUCLEO_F411RE/stm32f4xx_hal_nor.h@323:9e901b0a5aa1, 2014-09-13 (annotated)

Committer:
shaoziyang
Date:
Sat Sep 13 14:25:46 2014 +0000
Revision:
323:9e901b0a5aa1
Parent:
235:685d5f11838f 
test with CLOCK_SETUP = 0

Who changed what in which revision?

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