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_nand.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_nand.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 NAND 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_NAND_H
mbed_official 235:685d5f11838f 40 #define __STM32F4xx_HAL_NAND_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 NAND
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 /* Exported types ------------------------------------------------------------*/
mbed_official 235:685d5f11838f 67
mbed_official 235:685d5f11838f 68 /**
mbed_official 235:685d5f11838f 69 * @brief HAL NAND State structures definition
mbed_official 235:685d5f11838f 70 */
mbed_official 235:685d5f11838f 71 typedef enum
mbed_official 235:685d5f11838f 72 {
mbed_official 235:685d5f11838f 73 HAL_NAND_STATE_RESET = 0x00, /*!< NAND not yet initialized or disabled */
mbed_official 235:685d5f11838f 74 HAL_NAND_STATE_READY = 0x01, /*!< NAND initialized and ready for use */
mbed_official 235:685d5f11838f 75 HAL_NAND_STATE_BUSY = 0x02, /*!< NAND internal process is ongoing */
mbed_official 235:685d5f11838f 76 HAL_NAND_STATE_ERROR = 0x03 /*!< NAND error state */
mbed_official 235:685d5f11838f 77 }HAL_NAND_StateTypeDef;
mbed_official 235:685d5f11838f 78
mbed_official 235:685d5f11838f 79 /**
mbed_official 235:685d5f11838f 80 * @brief NAND Memory electronic signature Structure definition
mbed_official 235:685d5f11838f 81 */
mbed_official 235:685d5f11838f 82 typedef struct
mbed_official 235:685d5f11838f 83 {
mbed_official 235:685d5f11838f 84 /*<! NAND memory electronic signature maker and device IDs */
mbed_official 235:685d5f11838f 85
mbed_official 235:685d5f11838f 86 uint8_t Maker_Id;
mbed_official 235:685d5f11838f 87
mbed_official 235:685d5f11838f 88 uint8_t Device_Id;
mbed_official 235:685d5f11838f 89
mbed_official 235:685d5f11838f 90 uint8_t Third_Id;
mbed_official 235:685d5f11838f 91
mbed_official 235:685d5f11838f 92 uint8_t Fourth_Id;
mbed_official 235:685d5f11838f 93 }NAND_IDTypeDef;
mbed_official 235:685d5f11838f 94
mbed_official 235:685d5f11838f 95 /**
mbed_official 235:685d5f11838f 96 * @brief NAND Memory address Structure definition
mbed_official 235:685d5f11838f 97 */
mbed_official 235:685d5f11838f 98 typedef struct
mbed_official 235:685d5f11838f 99 {
mbed_official 235:685d5f11838f 100 uint16_t Page; /*!< NAND memory Page address */
mbed_official 235:685d5f11838f 101
mbed_official 235:685d5f11838f 102 uint16_t Zone; /*!< NAND memory Zone address */
mbed_official 235:685d5f11838f 103
mbed_official 235:685d5f11838f 104 uint16_t Block; /*!< NAND memory Block address */
mbed_official 235:685d5f11838f 105
mbed_official 235:685d5f11838f 106 }NAND_AddressTypedef;
mbed_official 235:685d5f11838f 107
mbed_official 235:685d5f11838f 108 /**
mbed_official 235:685d5f11838f 109 * @brief NAND Memory info Structure definition
mbed_official 235:685d5f11838f 110 */
mbed_official 235:685d5f11838f 111 typedef struct
mbed_official 235:685d5f11838f 112 {
mbed_official 235:685d5f11838f 113 uint32_t PageSize; /*!< NAND memory page (without spare area) size measured in K. bytes */
mbed_official 235:685d5f11838f 114
mbed_official 235:685d5f11838f 115 uint32_t SpareAreaSize; /*!< NAND memory spare area size measured in K. bytes */
mbed_official 235:685d5f11838f 116
mbed_official 235:685d5f11838f 117 uint32_t BlockSize; /*!< NAND memory block size number of pages */
mbed_official 235:685d5f11838f 118
mbed_official 235:685d5f11838f 119 uint32_t BlockNbr; /*!< NAND memory number of blocks */
mbed_official 235:685d5f11838f 120
mbed_official 235:685d5f11838f 121 uint32_t ZoneSize; /*!< NAND memory zone size measured in number of blocks */
mbed_official 235:685d5f11838f 122 }NAND_InfoTypeDef;
mbed_official 235:685d5f11838f 123
mbed_official 235:685d5f11838f 124 /**
mbed_official 235:685d5f11838f 125 * @brief NAND 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_NAND_TypeDef *Instance; /*!< Register base address */
mbed_official 235:685d5f11838f 130
mbed_official 235:685d5f11838f 131 FMC_NAND_InitTypeDef Init; /*!< NAND device control configuration parameters */
mbed_official 235:685d5f11838f 132
mbed_official 235:685d5f11838f 133 HAL_LockTypeDef Lock; /*!< NAND locking object */
mbed_official 235:685d5f11838f 134
mbed_official 235:685d5f11838f 135 __IO HAL_NAND_StateTypeDef State; /*!< NAND device access state */
mbed_official 235:685d5f11838f 136
mbed_official 235:685d5f11838f 137 NAND_InfoTypeDef Info; /*!< NAND characteristic information structure */
mbed_official 235:685d5f11838f 138 }NAND_HandleTypeDef;
mbed_official 235:685d5f11838f 139
mbed_official 235:685d5f11838f 140
mbed_official 235:685d5f11838f 141 /* Exported constants --------------------------------------------------------*/
mbed_official 235:685d5f11838f 142 /** @defgroup NAND_Exported_Constants
mbed_official 235:685d5f11838f 143 * @{
mbed_official 235:685d5f11838f 144 */
mbed_official 235:685d5f11838f 145 #define NAND_DEVICE1 ((uint32_t)0x70000000)
mbed_official 235:685d5f11838f 146 #define NAND_DEVICE2 ((uint32_t)0x80000000)
mbed_official 235:685d5f11838f 147 #define NAND_WRITE_TIMEOUT ((uint32_t)0x01000000)
mbed_official 235:685d5f11838f 148
mbed_official 235:685d5f11838f 149 #define CMD_AREA ((uint32_t)(1<<16)) /* A16 = CLE high */
mbed_official 235:685d5f11838f 150 #define ADDR_AREA ((uint32_t)(1<<17)) /* A17 = ALE high */
mbed_official 235:685d5f11838f 151
mbed_official 235:685d5f11838f 152 #define NAND_CMD_AREA_A ((uint8_t)0x00)
mbed_official 235:685d5f11838f 153 #define NAND_CMD_AREA_B ((uint8_t)0x01)
mbed_official 235:685d5f11838f 154 #define NAND_CMD_AREA_C ((uint8_t)0x50)
mbed_official 235:685d5f11838f 155 #define NAND_CMD_AREA_TRUE1 ((uint8_t)0x30)
mbed_official 235:685d5f11838f 156
mbed_official 235:685d5f11838f 157 #define NAND_CMD_WRITE0 ((uint8_t)0x80)
mbed_official 235:685d5f11838f 158 #define NAND_CMD_WRITE_TRUE1 ((uint8_t)0x10)
mbed_official 235:685d5f11838f 159 #define NAND_CMD_ERASE0 ((uint8_t)0x60)
mbed_official 235:685d5f11838f 160 #define NAND_CMD_ERASE1 ((uint8_t)0xD0)
mbed_official 235:685d5f11838f 161 #define NAND_CMD_READID ((uint8_t)0x90)
mbed_official 235:685d5f11838f 162 #define NAND_CMD_STATUS ((uint8_t)0x70)
mbed_official 235:685d5f11838f 163 #define NAND_CMD_LOCK_STATUS ((uint8_t)0x7A)
mbed_official 235:685d5f11838f 164 #define NAND_CMD_RESET ((uint8_t)0xFF)
mbed_official 235:685d5f11838f 165
mbed_official 235:685d5f11838f 166 /* NAND memory status */
mbed_official 235:685d5f11838f 167 #define NAND_VALID_ADDRESS ((uint32_t)0x00000100)
mbed_official 235:685d5f11838f 168 #define NAND_INVALID_ADDRESS ((uint32_t)0x00000200)
mbed_official 235:685d5f11838f 169 #define NAND_TIMEOUT_ERROR ((uint32_t)0x00000400)
mbed_official 235:685d5f11838f 170 #define NAND_BUSY ((uint32_t)0x00000000)
mbed_official 235:685d5f11838f 171 #define NAND_ERROR ((uint32_t)0x00000001)
mbed_official 235:685d5f11838f 172 #define NAND_READY ((uint32_t)0x00000040)
mbed_official 235:685d5f11838f 173
mbed_official 235:685d5f11838f 174 /**
mbed_official 235:685d5f11838f 175 * @}
mbed_official 235:685d5f11838f 176 */
mbed_official 235:685d5f11838f 177
mbed_official 235:685d5f11838f 178 /* Exported macro ------------------------------------------------------------*/
mbed_official 235:685d5f11838f 179
mbed_official 235:685d5f11838f 180 /** @brief Reset NAND handle state
mbed_official 235:685d5f11838f 181 * @param __HANDLE__: specifies the NAND handle.
mbed_official 235:685d5f11838f 182 * @retval None
mbed_official 235:685d5f11838f 183 */
mbed_official 235:685d5f11838f 184 #define __HAL_NAND_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_NAND_STATE_RESET)
mbed_official 235:685d5f11838f 185
mbed_official 235:685d5f11838f 186 /**
mbed_official 235:685d5f11838f 187 * @brief NAND memory address computation.
mbed_official 235:685d5f11838f 188 * @param __ADDRESS__: NAND memory address.
mbed_official 235:685d5f11838f 189 * @param __HANDLE__ : NAND handle.
mbed_official 235:685d5f11838f 190 * @retval NAND Raw address value
mbed_official 235:685d5f11838f 191 */
mbed_official 235:685d5f11838f 192 #define __ARRAY_ADDRESS(__ADDRESS__ , __HANDLE__) ((__ADDRESS__)->Page + \
mbed_official 235:685d5f11838f 193 (((__ADDRESS__)->Block + (((__ADDRESS__)->Zone) * ((__HANDLE__)->Info.ZoneSize)))* ((__HANDLE__)->Info.BlockSize)))
mbed_official 235:685d5f11838f 194
mbed_official 235:685d5f11838f 195 /**
mbed_official 235:685d5f11838f 196 * @brief NAND memory address cycling.
mbed_official 235:685d5f11838f 197 * @param __ADDRESS__: NAND memory address.
mbed_official 235:685d5f11838f 198 * @retval NAND address cycling value.
mbed_official 235:685d5f11838f 199 */
mbed_official 235:685d5f11838f 200 #define __ADDR_1st_CYCLE(__ADDRESS__) (uint8_t)(__ADDRESS__) /* 1st addressing cycle */
mbed_official 235:685d5f11838f 201 #define __ADDR_2nd_CYCLE(__ADDRESS__) (uint8_t)((__ADDRESS__) >> 8) /* 2nd addressing cycle */
mbed_official 235:685d5f11838f 202 #define __ADDR_3rd_CYCLE(__ADDRESS__) (uint8_t)((__ADDRESS__) >> 16) /* 3rd addressing cycle */
mbed_official 235:685d5f11838f 203 #define __ADDR_4th_CYCLE(__ADDRESS__) (uint8_t)((__ADDRESS__) >> 24) /* 4th addressing cycle */
mbed_official 235:685d5f11838f 204
mbed_official 235:685d5f11838f 205 /* Exported functions --------------------------------------------------------*/
mbed_official 235:685d5f11838f 206
mbed_official 235:685d5f11838f 207 /* Initialization/de-initialization functions ********************************/
mbed_official 235:685d5f11838f 208 HAL_StatusTypeDef HAL_NAND_Init(NAND_HandleTypeDef *hnand, FMC_NAND_PCC_TimingTypeDef *ComSpace_Timing, FMC_NAND_PCC_TimingTypeDef *AttSpace_Timing);
mbed_official 235:685d5f11838f 209 HAL_StatusTypeDef HAL_NAND_DeInit(NAND_HandleTypeDef *hnand);
mbed_official 235:685d5f11838f 210 void HAL_NAND_MspInit(NAND_HandleTypeDef *hnand);
mbed_official 235:685d5f11838f 211 void HAL_NAND_MspDeInit(NAND_HandleTypeDef *hnand);
mbed_official 235:685d5f11838f 212 void HAL_NAND_IRQHandler(NAND_HandleTypeDef *hnand);
mbed_official 235:685d5f11838f 213 void HAL_NAND_ITCallback(NAND_HandleTypeDef *hnand);
mbed_official 235:685d5f11838f 214
mbed_official 235:685d5f11838f 215 /* IO operation functions ****************************************************/
mbed_official 235:685d5f11838f 216 HAL_StatusTypeDef HAL_NAND_Read_ID(NAND_HandleTypeDef *hnand, NAND_IDTypeDef *pNAND_ID);
mbed_official 235:685d5f11838f 217 HAL_StatusTypeDef HAL_NAND_Reset(NAND_HandleTypeDef *hnand);
mbed_official 235:685d5f11838f 218 HAL_StatusTypeDef HAL_NAND_Read_Page(NAND_HandleTypeDef *hnand, NAND_AddressTypedef *pAddress, uint8_t *pBuffer, uint32_t NumPageToRead);
mbed_official 235:685d5f11838f 219 HAL_StatusTypeDef HAL_NAND_Write_Page(NAND_HandleTypeDef *hnand, NAND_AddressTypedef *pAddress, uint8_t *pBuffer, uint32_t NumPageToWrite);
mbed_official 235:685d5f11838f 220 HAL_StatusTypeDef HAL_NAND_Read_SpareArea(NAND_HandleTypeDef *hnand, NAND_AddressTypedef *pAddress, uint8_t *pBuffer, uint32_t NumSpareAreaToRead);
mbed_official 235:685d5f11838f 221 HAL_StatusTypeDef HAL_NAND_Write_SpareArea(NAND_HandleTypeDef *hnand, NAND_AddressTypedef *pAddress, uint8_t *pBuffer, uint32_t NumSpareAreaTowrite);
mbed_official 235:685d5f11838f 222 HAL_StatusTypeDef HAL_NAND_Erase_Block(NAND_HandleTypeDef *hnand, NAND_AddressTypedef *pAddress);
mbed_official 235:685d5f11838f 223 uint32_t HAL_NAND_Read_Status(NAND_HandleTypeDef *hnand);
mbed_official 235:685d5f11838f 224 uint32_t HAL_NAND_Address_Inc(NAND_HandleTypeDef *hnand, NAND_AddressTypedef *pAddress);
mbed_official 235:685d5f11838f 225
mbed_official 235:685d5f11838f 226 /* NAND Control functions ****************************************************/
mbed_official 235:685d5f11838f 227 HAL_StatusTypeDef HAL_NAND_ECC_Enable(NAND_HandleTypeDef *hnand);
mbed_official 235:685d5f11838f 228 HAL_StatusTypeDef HAL_NAND_ECC_Disable(NAND_HandleTypeDef *hnand);
mbed_official 235:685d5f11838f 229 HAL_StatusTypeDef HAL_NAND_GetECC(NAND_HandleTypeDef *hnand, uint32_t *ECCval, uint32_t Timeout);
mbed_official 235:685d5f11838f 230
mbed_official 235:685d5f11838f 231 /* NAND State functions *******************************************************/
mbed_official 235:685d5f11838f 232 HAL_NAND_StateTypeDef HAL_NAND_GetState(NAND_HandleTypeDef *hnand);
mbed_official 235:685d5f11838f 233 uint32_t HAL_NAND_Read_Status(NAND_HandleTypeDef *hnand);
mbed_official 235:685d5f11838f 234
mbed_official 235:685d5f11838f 235 #endif /* STM32F405xx || STM32F415xx || STM32F407xx || STM32F417xx || STM32F427xx || STM32F437xx || STM32F429xx || STM32F439xx */
mbed_official 235:685d5f11838f 236 /**
mbed_official 235:685d5f11838f 237 * @}
mbed_official 235:685d5f11838f 238 */
mbed_official 235:685d5f11838f 239
mbed_official 235:685d5f11838f 240 /**
mbed_official 235:685d5f11838f 241 * @}
mbed_official 235:685d5f11838f 242 */
mbed_official 235:685d5f11838f 243
mbed_official 235:685d5f11838f 244 #ifdef __cplusplus
mbed_official 235:685d5f11838f 245 }
mbed_official 235:685d5f11838f 246 #endif
mbed_official 235:685d5f11838f 247
mbed_official 235:685d5f11838f 248 #endif /* __STM32F4xx_HAL_NAND_H */
mbed_official 235:685d5f11838f 249
mbed_official 235:685d5f11838f 250 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/