Rev 2 | Details | Compare with Previous | Last modification | View Log | RSS feed
Rev | Author | Line No. | Line |
---|---|---|---|
2 | mjames | 1 | /** |
2 | ****************************************************************************** |
||
3 | * @file stm32f1xx_hal_nand.h |
||
4 | * @author MCD Application Team |
||
5 | * @brief Header file of NAND HAL module. |
||
6 | ****************************************************************************** |
||
7 | * @attention |
||
8 | * |
||
9 | mjames | 9 | * <h2><center>© Copyright (c) 2016 STMicroelectronics. |
10 | * All rights reserved.</center></h2> |
||
2 | mjames | 11 | * |
9 | mjames | 12 | * This software component is licensed by ST under BSD 3-Clause license, |
13 | * the "License"; You may not use this file except in compliance with the |
||
14 | * License. You may obtain a copy of the License at: |
||
15 | * opensource.org/licenses/BSD-3-Clause |
||
2 | mjames | 16 | * |
17 | ****************************************************************************** |
||
18 | */ |
||
19 | |||
20 | /* Define to prevent recursive inclusion -------------------------------------*/ |
||
9 | mjames | 21 | #ifndef STM32F1xx_HAL_NAND_H |
22 | #define STM32F1xx_HAL_NAND_H |
||
2 | mjames | 23 | |
24 | #ifdef __cplusplus |
||
9 | mjames | 25 | extern "C" { |
2 | mjames | 26 | #endif |
27 | |||
9 | mjames | 28 | #if defined(FSMC_BANK3) |
29 | |||
2 | mjames | 30 | /* Includes ------------------------------------------------------------------*/ |
31 | #include "stm32f1xx_ll_fsmc.h" |
||
32 | |||
33 | /** @addtogroup STM32F1xx_HAL_Driver |
||
34 | * @{ |
||
35 | */ |
||
36 | |||
37 | /** @addtogroup NAND |
||
38 | * @{ |
||
9 | mjames | 39 | */ |
2 | mjames | 40 | |
41 | /* Exported typedef ----------------------------------------------------------*/ |
||
42 | /* Exported types ------------------------------------------------------------*/ |
||
43 | /** @defgroup NAND_Exported_Types NAND Exported Types |
||
44 | * @{ |
||
45 | */ |
||
46 | |||
9 | mjames | 47 | /** |
2 | mjames | 48 | * @brief HAL NAND State structures definition |
49 | */ |
||
50 | typedef enum |
||
51 | { |
||
52 | HAL_NAND_STATE_RESET = 0x00U, /*!< NAND not yet initialized or disabled */ |
||
53 | HAL_NAND_STATE_READY = 0x01U, /*!< NAND initialized and ready for use */ |
||
54 | HAL_NAND_STATE_BUSY = 0x02U, /*!< NAND internal process is ongoing */ |
||
55 | HAL_NAND_STATE_ERROR = 0x03U /*!< NAND error state */ |
||
9 | mjames | 56 | } HAL_NAND_StateTypeDef; |
57 | |||
58 | /** |
||
2 | mjames | 59 | * @brief NAND Memory electronic signature Structure definition |
60 | */ |
||
61 | typedef struct |
||
62 | { |
||
63 | /*<! NAND memory electronic signature maker and device IDs */ |
||
64 | |||
9 | mjames | 65 | uint8_t Maker_Id; |
2 | mjames | 66 | |
67 | uint8_t Device_Id; |
||
68 | |||
69 | uint8_t Third_Id; |
||
70 | |||
71 | uint8_t Fourth_Id; |
||
9 | mjames | 72 | } NAND_IDTypeDef; |
2 | mjames | 73 | |
9 | mjames | 74 | /** |
2 | mjames | 75 | * @brief NAND Memory address Structure definition |
76 | */ |
||
9 | mjames | 77 | typedef struct |
2 | mjames | 78 | { |
9 | mjames | 79 | uint16_t Page; /*!< NAND memory Page address */ |
2 | mjames | 80 | |
9 | mjames | 81 | uint16_t Plane; /*!< NAND memory Zone address */ |
2 | mjames | 82 | |
9 | mjames | 83 | uint16_t Block; /*!< NAND memory Block address */ |
2 | mjames | 84 | |
9 | mjames | 85 | } NAND_AddressTypeDef; |
2 | mjames | 86 | |
9 | mjames | 87 | /** |
2 | mjames | 88 | * @brief NAND Memory info Structure definition |
9 | mjames | 89 | */ |
2 | mjames | 90 | typedef struct |
91 | { |
||
9 | mjames | 92 | uint32_t PageSize; /*!< NAND memory page (without spare area) size measured in bytes |
93 | for 8 bits addressing or words for 16 bits addressing */ |
||
2 | mjames | 94 | |
9 | mjames | 95 | uint32_t SpareAreaSize; /*!< NAND memory spare area size measured in bytes |
96 | for 8 bits addressing or words for 16 bits addressing */ |
||
97 | |||
2 | mjames | 98 | uint32_t BlockSize; /*!< NAND memory block size measured in number of pages */ |
99 | |||
100 | uint32_t BlockNbr; /*!< NAND memory number of total blocks */ |
||
9 | mjames | 101 | |
2 | mjames | 102 | uint32_t PlaneNbr; /*!< NAND memory number of planes */ |
103 | |||
9 | mjames | 104 | uint32_t PlaneSize; /*!< NAND memory zone size measured in number of blocks */ |
2 | mjames | 105 | |
9 | mjames | 106 | FunctionalState ExtraCommandEnable; /*!< NAND extra command needed for Page reading mode. This |
107 | parameter is mandatory for some NAND parts after the read |
||
108 | command (NAND_CMD_AREA_TRUE1) and before DATA reading sequence. |
||
2 | mjames | 109 | Example: Toshiba THTH58BYG3S0HBAI6. |
110 | This parameter could be ENABLE or DISABLE |
||
111 | Please check the Read Mode sequnece in the NAND device datasheet */ |
||
9 | mjames | 112 | } NAND_DeviceConfigTypeDef; |
2 | mjames | 113 | |
9 | mjames | 114 | /** |
2 | mjames | 115 | * @brief NAND handle Structure definition |
9 | mjames | 116 | */ |
117 | #if (USE_HAL_NAND_REGISTER_CALLBACKS == 1) |
||
118 | typedef struct __NAND_HandleTypeDef |
||
119 | #else |
||
2 | mjames | 120 | typedef struct |
9 | mjames | 121 | #endif /* USE_HAL_NAND_REGISTER_CALLBACKS */ |
2 | mjames | 122 | { |
9 | mjames | 123 | FSMC_NAND_TypeDef *Instance; /*!< Register base address */ |
2 | mjames | 124 | |
9 | mjames | 125 | FSMC_NAND_InitTypeDef Init; /*!< NAND device control configuration parameters */ |
126 | |||
2 | mjames | 127 | HAL_LockTypeDef Lock; /*!< NAND locking object */ |
128 | |||
129 | __IO HAL_NAND_StateTypeDef State; /*!< NAND device access state */ |
||
130 | |||
131 | NAND_DeviceConfigTypeDef Config; /*!< NAND phusical characteristic information structure */ |
||
132 | |||
9 | mjames | 133 | #if (USE_HAL_NAND_REGISTER_CALLBACKS == 1) |
134 | void (* MspInitCallback)(struct __NAND_HandleTypeDef *hnand); /*!< NAND Msp Init callback */ |
||
135 | void (* MspDeInitCallback)(struct __NAND_HandleTypeDef *hnand); /*!< NAND Msp DeInit callback */ |
||
136 | void (* ItCallback)(struct __NAND_HandleTypeDef *hnand); /*!< NAND IT callback */ |
||
137 | #endif |
||
138 | } NAND_HandleTypeDef; |
||
2 | mjames | 139 | |
9 | mjames | 140 | #if (USE_HAL_NAND_REGISTER_CALLBACKS == 1) |
2 | mjames | 141 | /** |
9 | mjames | 142 | * @brief HAL NAND Callback ID enumeration definition |
143 | */ |
||
144 | typedef enum |
||
145 | { |
||
146 | HAL_NAND_MSP_INIT_CB_ID = 0x00U, /*!< NAND MspInit Callback ID */ |
||
147 | HAL_NAND_MSP_DEINIT_CB_ID = 0x01U, /*!< NAND MspDeInit Callback ID */ |
||
148 | HAL_NAND_IT_CB_ID = 0x02U /*!< NAND IT Callback ID */ |
||
149 | } HAL_NAND_CallbackIDTypeDef; |
||
150 | |||
151 | /** |
||
152 | * @brief HAL NAND Callback pointer definition |
||
153 | */ |
||
154 | typedef void (*pNAND_CallbackTypeDef)(NAND_HandleTypeDef *hnand); |
||
155 | #endif |
||
156 | |||
157 | /** |
||
2 | mjames | 158 | * @} |
159 | */ |
||
160 | |||
161 | /* Exported constants --------------------------------------------------------*/ |
||
9 | mjames | 162 | /* Exported macro ------------------------------------------------------------*/ |
2 | mjames | 163 | /** @defgroup NAND_Exported_Macros NAND Exported Macros |
164 | * @{ |
||
9 | mjames | 165 | */ |
2 | mjames | 166 | |
167 | /** @brief Reset NAND handle state |
||
9 | mjames | 168 | * @param __HANDLE__ specifies the NAND handle. |
2 | mjames | 169 | * @retval None |
170 | */ |
||
9 | mjames | 171 | #if (USE_HAL_NAND_REGISTER_CALLBACKS == 1) |
172 | #define __HAL_NAND_RESET_HANDLE_STATE(__HANDLE__) do { \ |
||
173 | (__HANDLE__)->State = HAL_NAND_STATE_RESET; \ |
||
174 | (__HANDLE__)->MspInitCallback = NULL; \ |
||
175 | (__HANDLE__)->MspDeInitCallback = NULL; \ |
||
176 | } while(0) |
||
177 | #else |
||
2 | mjames | 178 | #define __HAL_NAND_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_NAND_STATE_RESET) |
9 | mjames | 179 | #endif |
2 | mjames | 180 | |
181 | /** |
||
182 | * @} |
||
183 | */ |
||
184 | |||
185 | /* Exported functions --------------------------------------------------------*/ |
||
186 | /** @addtogroup NAND_Exported_Functions NAND Exported Functions |
||
187 | * @{ |
||
188 | */ |
||
9 | mjames | 189 | |
190 | /** @addtogroup NAND_Exported_Functions_Group1 Initialization and de-initialization functions |
||
2 | mjames | 191 | * @{ |
192 | */ |
||
193 | |||
194 | /* Initialization/de-initialization functions ********************************/ |
||
9 | mjames | 195 | HAL_StatusTypeDef HAL_NAND_Init(NAND_HandleTypeDef *hnand, FSMC_NAND_PCC_TimingTypeDef *ComSpace_Timing, |
196 | FSMC_NAND_PCC_TimingTypeDef *AttSpace_Timing); |
||
197 | HAL_StatusTypeDef HAL_NAND_DeInit(NAND_HandleTypeDef *hnand); |
||
2 | mjames | 198 | |
199 | HAL_StatusTypeDef HAL_NAND_ConfigDevice(NAND_HandleTypeDef *hnand, NAND_DeviceConfigTypeDef *pDeviceConfig); |
||
200 | |||
201 | HAL_StatusTypeDef HAL_NAND_Read_ID(NAND_HandleTypeDef *hnand, NAND_IDTypeDef *pNAND_ID); |
||
202 | |||
203 | void HAL_NAND_MspInit(NAND_HandleTypeDef *hnand); |
||
204 | void HAL_NAND_MspDeInit(NAND_HandleTypeDef *hnand); |
||
205 | void HAL_NAND_IRQHandler(NAND_HandleTypeDef *hnand); |
||
206 | void HAL_NAND_ITCallback(NAND_HandleTypeDef *hnand); |
||
207 | |||
208 | /** |
||
209 | * @} |
||
210 | */ |
||
9 | mjames | 211 | |
212 | /** @addtogroup NAND_Exported_Functions_Group2 Input and Output functions |
||
2 | mjames | 213 | * @{ |
214 | */ |
||
215 | |||
216 | /* IO operation functions ****************************************************/ |
||
217 | HAL_StatusTypeDef HAL_NAND_Reset(NAND_HandleTypeDef *hnand); |
||
218 | |||
9 | mjames | 219 | HAL_StatusTypeDef HAL_NAND_Read_Page_8b(NAND_HandleTypeDef *hnand, NAND_AddressTypeDef *pAddress, uint8_t *pBuffer, |
220 | uint32_t NumPageToRead); |
||
221 | HAL_StatusTypeDef HAL_NAND_Write_Page_8b(NAND_HandleTypeDef *hnand, NAND_AddressTypeDef *pAddress, uint8_t *pBuffer, |
||
222 | uint32_t NumPageToWrite); |
||
223 | HAL_StatusTypeDef HAL_NAND_Read_SpareArea_8b(NAND_HandleTypeDef *hnand, NAND_AddressTypeDef *pAddress, |
||
224 | uint8_t *pBuffer, uint32_t NumSpareAreaToRead); |
||
225 | HAL_StatusTypeDef HAL_NAND_Write_SpareArea_8b(NAND_HandleTypeDef *hnand, NAND_AddressTypeDef *pAddress, |
||
226 | uint8_t *pBuffer, uint32_t NumSpareAreaTowrite); |
||
2 | mjames | 227 | |
9 | mjames | 228 | HAL_StatusTypeDef HAL_NAND_Read_Page_16b(NAND_HandleTypeDef *hnand, NAND_AddressTypeDef *pAddress, uint16_t *pBuffer, |
229 | uint32_t NumPageToRead); |
||
230 | HAL_StatusTypeDef HAL_NAND_Write_Page_16b(NAND_HandleTypeDef *hnand, NAND_AddressTypeDef *pAddress, uint16_t *pBuffer, |
||
231 | uint32_t NumPageToWrite); |
||
232 | HAL_StatusTypeDef HAL_NAND_Read_SpareArea_16b(NAND_HandleTypeDef *hnand, NAND_AddressTypeDef *pAddress, |
||
233 | uint16_t *pBuffer, uint32_t NumSpareAreaToRead); |
||
234 | HAL_StatusTypeDef HAL_NAND_Write_SpareArea_16b(NAND_HandleTypeDef *hnand, NAND_AddressTypeDef *pAddress, |
||
235 | uint16_t *pBuffer, uint32_t NumSpareAreaTowrite); |
||
2 | mjames | 236 | |
237 | HAL_StatusTypeDef HAL_NAND_Erase_Block(NAND_HandleTypeDef *hnand, NAND_AddressTypeDef *pAddress); |
||
9 | mjames | 238 | |
2 | mjames | 239 | uint32_t HAL_NAND_Address_Inc(NAND_HandleTypeDef *hnand, NAND_AddressTypeDef *pAddress); |
240 | |||
9 | mjames | 241 | #if (USE_HAL_NAND_REGISTER_CALLBACKS == 1) |
242 | /* NAND callback registering/unregistering */ |
||
243 | HAL_StatusTypeDef HAL_NAND_RegisterCallback(NAND_HandleTypeDef *hnand, HAL_NAND_CallbackIDTypeDef CallbackId, |
||
244 | pNAND_CallbackTypeDef pCallback); |
||
245 | HAL_StatusTypeDef HAL_NAND_UnRegisterCallback(NAND_HandleTypeDef *hnand, HAL_NAND_CallbackIDTypeDef CallbackId); |
||
246 | #endif |
||
247 | |||
2 | mjames | 248 | /** |
249 | * @} |
||
250 | */ |
||
251 | |||
9 | mjames | 252 | /** @addtogroup NAND_Exported_Functions_Group3 Peripheral Control functions |
2 | mjames | 253 | * @{ |
254 | */ |
||
255 | |||
256 | /* NAND Control functions ****************************************************/ |
||
257 | HAL_StatusTypeDef HAL_NAND_ECC_Enable(NAND_HandleTypeDef *hnand); |
||
258 | HAL_StatusTypeDef HAL_NAND_ECC_Disable(NAND_HandleTypeDef *hnand); |
||
259 | HAL_StatusTypeDef HAL_NAND_GetECC(NAND_HandleTypeDef *hnand, uint32_t *ECCval, uint32_t Timeout); |
||
260 | |||
261 | /** |
||
262 | * @} |
||
263 | */ |
||
9 | mjames | 264 | |
265 | /** @addtogroup NAND_Exported_Functions_Group4 Peripheral State functions |
||
2 | mjames | 266 | * @{ |
267 | */ |
||
268 | /* NAND State functions *******************************************************/ |
||
269 | HAL_NAND_StateTypeDef HAL_NAND_GetState(NAND_HandleTypeDef *hnand); |
||
270 | uint32_t HAL_NAND_Read_Status(NAND_HandleTypeDef *hnand); |
||
271 | /** |
||
272 | * @} |
||
273 | */ |
||
9 | mjames | 274 | |
2 | mjames | 275 | /** |
276 | * @} |
||
277 | */ |
||
9 | mjames | 278 | |
2 | mjames | 279 | /* Private types -------------------------------------------------------------*/ |
280 | /* Private variables ---------------------------------------------------------*/ |
||
281 | /* Private constants ---------------------------------------------------------*/ |
||
9 | mjames | 282 | /** @defgroup NAND_Private_Constants NAND Private Constants |
2 | mjames | 283 | * @{ |
284 | */ |
||
9 | mjames | 285 | #define NAND_DEVICE1 0x70000000UL |
286 | #define NAND_DEVICE2 0x80000000UL |
||
287 | #define NAND_WRITE_TIMEOUT 0x01000000UL |
||
2 | mjames | 288 | |
9 | mjames | 289 | #define CMD_AREA (1UL<<16U) /* A16 = CLE high */ |
290 | #define ADDR_AREA (1UL<<17U) /* A17 = ALE high */ |
||
2 | mjames | 291 | |
292 | #define NAND_CMD_AREA_A ((uint8_t)0x00) |
||
293 | #define NAND_CMD_AREA_B ((uint8_t)0x01) |
||
294 | #define NAND_CMD_AREA_C ((uint8_t)0x50) |
||
295 | #define NAND_CMD_AREA_TRUE1 ((uint8_t)0x30) |
||
296 | |||
297 | #define NAND_CMD_WRITE0 ((uint8_t)0x80) |
||
9 | mjames | 298 | #define NAND_CMD_WRITE_TRUE1 ((uint8_t)0x10) |
2 | mjames | 299 | #define NAND_CMD_ERASE0 ((uint8_t)0x60) |
9 | mjames | 300 | #define NAND_CMD_ERASE1 ((uint8_t)0xD0) |
301 | #define NAND_CMD_READID ((uint8_t)0x90) |
||
2 | mjames | 302 | #define NAND_CMD_STATUS ((uint8_t)0x70) |
303 | #define NAND_CMD_LOCK_STATUS ((uint8_t)0x7A) |
||
304 | #define NAND_CMD_RESET ((uint8_t)0xFF) |
||
305 | |||
306 | /* NAND memory status */ |
||
9 | mjames | 307 | #define NAND_VALID_ADDRESS 0x00000100UL |
308 | #define NAND_INVALID_ADDRESS 0x00000200UL |
||
309 | #define NAND_TIMEOUT_ERROR 0x00000400UL |
||
310 | #define NAND_BUSY 0x00000000UL |
||
311 | #define NAND_ERROR 0x00000001UL |
||
312 | #define NAND_READY 0x00000040UL |
||
2 | mjames | 313 | /** |
314 | * @} |
||
315 | */ |
||
316 | |||
317 | /* Private macros ------------------------------------------------------------*/ |
||
9 | mjames | 318 | /** @defgroup NAND_Private_Macros NAND Private Macros |
2 | mjames | 319 | * @{ |
320 | */ |
||
321 | |||
322 | /** |
||
323 | * @brief NAND memory address computation. |
||
9 | mjames | 324 | * @param __ADDRESS__ NAND memory address. |
325 | * @param __HANDLE__ NAND handle. |
||
2 | mjames | 326 | * @retval NAND Raw address value |
327 | */ |
||
328 | #define ARRAY_ADDRESS(__ADDRESS__ , __HANDLE__) ((__ADDRESS__)->Page + \ |
||
9 | mjames | 329 | (((__ADDRESS__)->Block + (((__ADDRESS__)->Plane) * ((__HANDLE__)->Config.PlaneSize)))* ((__HANDLE__)->Config.BlockSize))) |
2 | mjames | 330 | |
331 | /** |
||
332 | * @brief NAND memory Column address computation. |
||
9 | mjames | 333 | * @param __HANDLE__ NAND handle. |
2 | mjames | 334 | * @retval NAND Raw address value |
335 | */ |
||
336 | #define COLUMN_ADDRESS( __HANDLE__) ((__HANDLE__)->Config.PageSize) |
||
9 | mjames | 337 | |
2 | mjames | 338 | /** |
339 | * @brief NAND memory address cycling. |
||
9 | mjames | 340 | * @param __ADDRESS__ NAND memory address. |
2 | mjames | 341 | * @retval NAND address cycling value. |
342 | */ |
||
9 | mjames | 343 | #define ADDR_1ST_CYCLE(__ADDRESS__) (uint8_t)(__ADDRESS__) /* 1st addressing cycle */ |
344 | #define ADDR_2ND_CYCLE(__ADDRESS__) (uint8_t)((__ADDRESS__) >> 8) /* 2nd addressing cycle */ |
||
345 | #define ADDR_3RD_CYCLE(__ADDRESS__) (uint8_t)((__ADDRESS__) >> 16) /* 3rd addressing cycle */ |
||
346 | #define ADDR_4TH_CYCLE(__ADDRESS__) (uint8_t)((__ADDRESS__) >> 24) /* 4th addressing cycle */ |
||
2 | mjames | 347 | |
348 | /** |
||
349 | * @brief NAND memory Columns cycling. |
||
9 | mjames | 350 | * @param __ADDRESS__ NAND memory address. |
2 | mjames | 351 | * @retval NAND Column address cycling value. |
352 | */ |
||
9 | mjames | 353 | #define COLUMN_1ST_CYCLE(__ADDRESS__) (uint8_t)((__ADDRESS__) & 0xFFU) /* 1st Column addressing cycle */ |
354 | #define COLUMN_2ND_CYCLE(__ADDRESS__) (uint8_t)((__ADDRESS__) >> 8) /* 2nd Column addressing cycle */ |
||
2 | mjames | 355 | |
356 | /** |
||
357 | * @} |
||
358 | */ |
||
9 | mjames | 359 | |
2 | mjames | 360 | /** |
361 | * @} |
||
9 | mjames | 362 | */ |
2 | mjames | 363 | |
364 | /** |
||
365 | * @} |
||
9 | mjames | 366 | */ |
2 | mjames | 367 | |
9 | mjames | 368 | /** |
369 | * @} |
||
370 | */ |
||
371 | |||
372 | #endif /* FSMC_BANK3 */ |
||
373 | |||
2 | mjames | 374 | #ifdef __cplusplus |
375 | } |
||
376 | #endif |
||
377 | |||
9 | mjames | 378 | #endif /* STM32F1xx_HAL_NAND_H */ |
2 | mjames | 379 | |
380 | /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/ |