|
38
|
1 /**
|
|
|
2 ******************************************************************************
|
|
|
3 * @file stm32f4xx_hal_nand.h
|
|
|
4 * @author MCD Application Team
|
|
|
5 * @version V1.2.0
|
|
|
6 * @date 26-December-2014
|
|
|
7 * @brief Header file of NAND HAL module.
|
|
|
8 ******************************************************************************
|
|
|
9 * @attention
|
|
|
10 *
|
|
|
11 * <h2><center>© COPYRIGHT(c) 2014 STMicroelectronics</center></h2>
|
|
|
12 *
|
|
|
13 * Redistribution and use in source and binary forms, with or without modification,
|
|
|
14 * are permitted provided that the following conditions are met:
|
|
|
15 * 1. Redistributions of source code must retain the above copyright notice,
|
|
|
16 * this list of conditions and the following disclaimer.
|
|
|
17 * 2. Redistributions in binary form must reproduce the above copyright notice,
|
|
|
18 * this list of conditions and the following disclaimer in the documentation
|
|
|
19 * and/or other materials provided with the distribution.
|
|
|
20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
|
|
|
21 * may be used to endorse or promote products derived from this software
|
|
|
22 * without specific prior written permission.
|
|
|
23 *
|
|
|
24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
|
25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
|
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
|
27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
|
|
28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
|
29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
|
|
30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
|
|
31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
|
|
32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
|
33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
|
34 *
|
|
|
35 ******************************************************************************
|
|
|
36 */
|
|
|
37
|
|
|
38 /* Define to prevent recursive inclusion -------------------------------------*/
|
|
|
39 #ifndef __STM32F4xx_HAL_NAND_H
|
|
|
40 #define __STM32F4xx_HAL_NAND_H
|
|
|
41
|
|
|
42 #ifdef __cplusplus
|
|
|
43 extern "C" {
|
|
|
44 #endif
|
|
|
45
|
|
|
46 /* Includes ------------------------------------------------------------------*/
|
|
|
47 #if defined(STM32F405xx) || defined(STM32F415xx) || defined(STM32F407xx)|| defined(STM32F417xx)
|
|
|
48 #include "stm32f4xx_ll_fsmc.h"
|
|
|
49 #endif /* STM32F405xx || STM32F415xx || STM32F407xx || STM32F417xx */
|
|
|
50
|
|
|
51 #if defined(STM32F427xx) || defined(STM32F437xx) || defined(STM32F429xx)|| defined(STM32F439xx)
|
|
|
52 #include "stm32f4xx_ll_fmc.h"
|
|
|
53 #endif /* STM32F427xx || STM32F437xx || STM32F429xx || STM32F439xx */
|
|
|
54
|
|
|
55 /** @addtogroup STM32F4xx_HAL_Driver
|
|
|
56 * @{
|
|
|
57 */
|
|
|
58
|
|
|
59 /** @addtogroup NAND
|
|
|
60 * @{
|
|
|
61 */
|
|
|
62
|
|
|
63 #if defined(STM32F405xx) || defined(STM32F415xx) || defined(STM32F407xx) || defined(STM32F417xx) || defined(STM32F427xx) || defined(STM32F437xx) || defined(STM32F429xx) || defined(STM32F439xx)
|
|
|
64 /* Exported typedef ----------------------------------------------------------*/
|
|
|
65 /* Exported types ------------------------------------------------------------*/
|
|
|
66 /** @defgroup NAND_Exported_Types NAND Exported Types
|
|
|
67 * @{
|
|
|
68 */
|
|
|
69
|
|
|
70 /**
|
|
|
71 * @brief HAL NAND State structures definition
|
|
|
72 */
|
|
|
73 typedef enum
|
|
|
74 {
|
|
|
75 HAL_NAND_STATE_RESET = 0x00, /*!< NAND not yet initialized or disabled */
|
|
|
76 HAL_NAND_STATE_READY = 0x01, /*!< NAND initialized and ready for use */
|
|
|
77 HAL_NAND_STATE_BUSY = 0x02, /*!< NAND internal process is ongoing */
|
|
|
78 HAL_NAND_STATE_ERROR = 0x03 /*!< NAND error state */
|
|
|
79 }HAL_NAND_StateTypeDef;
|
|
|
80
|
|
|
81 /**
|
|
|
82 * @brief NAND Memory electronic signature Structure definition
|
|
|
83 */
|
|
|
84 typedef struct
|
|
|
85 {
|
|
|
86 /*<! NAND memory electronic signature maker and device IDs */
|
|
|
87
|
|
|
88 uint8_t Maker_Id;
|
|
|
89
|
|
|
90 uint8_t Device_Id;
|
|
|
91
|
|
|
92 uint8_t Third_Id;
|
|
|
93
|
|
|
94 uint8_t Fourth_Id;
|
|
|
95 }NAND_IDTypeDef;
|
|
|
96
|
|
|
97 /**
|
|
|
98 * @brief NAND Memory address Structure definition
|
|
|
99 */
|
|
|
100 typedef struct
|
|
|
101 {
|
|
|
102 uint16_t Page; /*!< NAND memory Page address */
|
|
|
103
|
|
|
104 uint16_t Zone; /*!< NAND memory Zone address */
|
|
|
105
|
|
|
106 uint16_t Block; /*!< NAND memory Block address */
|
|
|
107
|
|
|
108 }NAND_AddressTypeDef;
|
|
|
109
|
|
|
110 /**
|
|
|
111 * @brief NAND Memory info Structure definition
|
|
|
112 */
|
|
|
113 typedef struct
|
|
|
114 {
|
|
|
115 uint32_t PageSize; /*!< NAND memory page (without spare area) size measured in K. bytes */
|
|
|
116
|
|
|
117 uint32_t SpareAreaSize; /*!< NAND memory spare area size measured in K. bytes */
|
|
|
118
|
|
|
119 uint32_t BlockSize; /*!< NAND memory block size number of pages */
|
|
|
120
|
|
|
121 uint32_t BlockNbr; /*!< NAND memory number of blocks */
|
|
|
122
|
|
|
123 uint32_t ZoneSize; /*!< NAND memory zone size measured in number of blocks */
|
|
|
124 }NAND_InfoTypeDef;
|
|
|
125
|
|
|
126 /**
|
|
|
127 * @brief NAND handle Structure definition
|
|
|
128 */
|
|
|
129 typedef struct
|
|
|
130 {
|
|
|
131 FMC_NAND_TypeDef *Instance; /*!< Register base address */
|
|
|
132
|
|
|
133 FMC_NAND_InitTypeDef Init; /*!< NAND device control configuration parameters */
|
|
|
134
|
|
|
135 HAL_LockTypeDef Lock; /*!< NAND locking object */
|
|
|
136
|
|
|
137 __IO HAL_NAND_StateTypeDef State; /*!< NAND device access state */
|
|
|
138
|
|
|
139 NAND_InfoTypeDef Info; /*!< NAND characteristic information structure */
|
|
|
140 }NAND_HandleTypeDef;
|
|
|
141 /**
|
|
|
142 * @}
|
|
|
143 */
|
|
|
144
|
|
|
145 /* Exported constants --------------------------------------------------------*/
|
|
|
146 /* Exported macro ------------------------------------------------------------*/
|
|
|
147 /** @defgroup NAND_Exported_Macros NAND Exported Macros
|
|
|
148 * @{
|
|
|
149 */
|
|
|
150
|
|
|
151 /** @brief Reset NAND handle state
|
|
|
152 * @param __HANDLE__: specifies the NAND handle.
|
|
|
153 * @retval None
|
|
|
154 */
|
|
|
155 #define __HAL_NAND_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_NAND_STATE_RESET)
|
|
|
156
|
|
|
157 /**
|
|
|
158 * @}
|
|
|
159 */
|
|
|
160
|
|
|
161 /* Exported functions --------------------------------------------------------*/
|
|
|
162 /** @addtogroup NAND_Exported_Functions NAND Exported Functions
|
|
|
163 * @{
|
|
|
164 */
|
|
|
165
|
|
|
166 /** @addtogroup NAND_Exported_Functions_Group1 Initialization and de-initialization functions
|
|
|
167 * @{
|
|
|
168 */
|
|
|
169
|
|
|
170 /* Initialization/de-initialization functions ********************************/
|
|
|
171 HAL_StatusTypeDef HAL_NAND_Init(NAND_HandleTypeDef *hnand, FMC_NAND_PCC_TimingTypeDef *ComSpace_Timing, FMC_NAND_PCC_TimingTypeDef *AttSpace_Timing);
|
|
|
172 HAL_StatusTypeDef HAL_NAND_DeInit(NAND_HandleTypeDef *hnand);
|
|
|
173 void HAL_NAND_MspInit(NAND_HandleTypeDef *hnand);
|
|
|
174 void HAL_NAND_MspDeInit(NAND_HandleTypeDef *hnand);
|
|
|
175 void HAL_NAND_IRQHandler(NAND_HandleTypeDef *hnand);
|
|
|
176 void HAL_NAND_ITCallback(NAND_HandleTypeDef *hnand);
|
|
|
177
|
|
|
178 /**
|
|
|
179 * @}
|
|
|
180 */
|
|
|
181
|
|
|
182 /** @addtogroup NAND_Exported_Functions_Group2 Input and Output functions
|
|
|
183 * @{
|
|
|
184 */
|
|
|
185
|
|
|
186 /* IO operation functions ****************************************************/
|
|
|
187 HAL_StatusTypeDef HAL_NAND_Read_ID(NAND_HandleTypeDef *hnand, NAND_IDTypeDef *pNAND_ID);
|
|
|
188 HAL_StatusTypeDef HAL_NAND_Reset(NAND_HandleTypeDef *hnand);
|
|
|
189 HAL_StatusTypeDef HAL_NAND_Read_Page(NAND_HandleTypeDef *hnand, NAND_AddressTypeDef *pAddress, uint8_t *pBuffer, uint32_t NumPageToRead);
|
|
|
190 HAL_StatusTypeDef HAL_NAND_Write_Page(NAND_HandleTypeDef *hnand, NAND_AddressTypeDef *pAddress, uint8_t *pBuffer, uint32_t NumPageToWrite);
|
|
|
191 HAL_StatusTypeDef HAL_NAND_Read_SpareArea(NAND_HandleTypeDef *hnand, NAND_AddressTypeDef *pAddress, uint8_t *pBuffer, uint32_t NumSpareAreaToRead);
|
|
|
192 HAL_StatusTypeDef HAL_NAND_Write_SpareArea(NAND_HandleTypeDef *hnand, NAND_AddressTypeDef *pAddress, uint8_t *pBuffer, uint32_t NumSpareAreaTowrite);
|
|
|
193 HAL_StatusTypeDef HAL_NAND_Erase_Block(NAND_HandleTypeDef *hnand, NAND_AddressTypeDef *pAddress);
|
|
|
194 uint32_t HAL_NAND_Read_Status(NAND_HandleTypeDef *hnand);
|
|
|
195 uint32_t HAL_NAND_Address_Inc(NAND_HandleTypeDef *hnand, NAND_AddressTypeDef *pAddress);
|
|
|
196
|
|
|
197 /**
|
|
|
198 * @}
|
|
|
199 */
|
|
|
200
|
|
|
201 /** @addtogroup NAND_Exported_Functions_Group3 Peripheral Control functions
|
|
|
202 * @{
|
|
|
203 */
|
|
|
204
|
|
|
205 /* NAND Control functions ****************************************************/
|
|
|
206 HAL_StatusTypeDef HAL_NAND_ECC_Enable(NAND_HandleTypeDef *hnand);
|
|
|
207 HAL_StatusTypeDef HAL_NAND_ECC_Disable(NAND_HandleTypeDef *hnand);
|
|
|
208 HAL_StatusTypeDef HAL_NAND_GetECC(NAND_HandleTypeDef *hnand, uint32_t *ECCval, uint32_t Timeout);
|
|
|
209
|
|
|
210 /**
|
|
|
211 * @}
|
|
|
212 */
|
|
|
213
|
|
|
214 /** @addtogroup NAND_Exported_Functions_Group4 Peripheral State functions
|
|
|
215 * @{
|
|
|
216 */
|
|
|
217 /* NAND State functions *******************************************************/
|
|
|
218 HAL_NAND_StateTypeDef HAL_NAND_GetState(NAND_HandleTypeDef *hnand);
|
|
|
219 uint32_t HAL_NAND_Read_Status(NAND_HandleTypeDef *hnand);
|
|
|
220 /**
|
|
|
221 * @}
|
|
|
222 */
|
|
|
223
|
|
|
224 /**
|
|
|
225 * @}
|
|
|
226 */
|
|
|
227
|
|
|
228 /* Private types -------------------------------------------------------------*/
|
|
|
229 /* Private variables ---------------------------------------------------------*/
|
|
|
230 /* Private constants ---------------------------------------------------------*/
|
|
|
231 /** @defgroup NAND_Private_Constants NAND Private Constants
|
|
|
232 * @{
|
|
|
233 */
|
|
|
234 #define NAND_DEVICE1 ((uint32_t)0x70000000)
|
|
|
235 #define NAND_DEVICE2 ((uint32_t)0x80000000)
|
|
|
236 #define NAND_WRITE_TIMEOUT ((uint32_t)0x01000000)
|
|
|
237
|
|
|
238 #define CMD_AREA ((uint32_t)(1<<16)) /* A16 = CLE high */
|
|
|
239 #define ADDR_AREA ((uint32_t)(1<<17)) /* A17 = ALE high */
|
|
|
240
|
|
|
241 #define NAND_CMD_AREA_A ((uint8_t)0x00)
|
|
|
242 #define NAND_CMD_AREA_B ((uint8_t)0x01)
|
|
|
243 #define NAND_CMD_AREA_C ((uint8_t)0x50)
|
|
|
244 #define NAND_CMD_AREA_TRUE1 ((uint8_t)0x30)
|
|
|
245
|
|
|
246 #define NAND_CMD_WRITE0 ((uint8_t)0x80)
|
|
|
247 #define NAND_CMD_WRITE_TRUE1 ((uint8_t)0x10)
|
|
|
248 #define NAND_CMD_ERASE0 ((uint8_t)0x60)
|
|
|
249 #define NAND_CMD_ERASE1 ((uint8_t)0xD0)
|
|
|
250 #define NAND_CMD_READID ((uint8_t)0x90)
|
|
|
251 #define NAND_CMD_STATUS ((uint8_t)0x70)
|
|
|
252 #define NAND_CMD_LOCK_STATUS ((uint8_t)0x7A)
|
|
|
253 #define NAND_CMD_RESET ((uint8_t)0xFF)
|
|
|
254
|
|
|
255 /* NAND memory status */
|
|
|
256 #define NAND_VALID_ADDRESS ((uint32_t)0x00000100)
|
|
|
257 #define NAND_INVALID_ADDRESS ((uint32_t)0x00000200)
|
|
|
258 #define NAND_TIMEOUT_ERROR ((uint32_t)0x00000400)
|
|
|
259 #define NAND_BUSY ((uint32_t)0x00000000)
|
|
|
260 #define NAND_ERROR ((uint32_t)0x00000001)
|
|
|
261 #define NAND_READY ((uint32_t)0x00000040)
|
|
|
262 /**
|
|
|
263 * @}
|
|
|
264 */
|
|
|
265
|
|
|
266 /* Private macros ------------------------------------------------------------*/
|
|
|
267 /** @defgroup NAND_Private_Macros NAND Private Macros
|
|
|
268 * @{
|
|
|
269 */
|
|
|
270
|
|
|
271 /**
|
|
|
272 * @brief NAND memory address computation.
|
|
|
273 * @param __ADDRESS__: NAND memory address.
|
|
|
274 * @param __HANDLE__ : NAND handle.
|
|
|
275 * @retval NAND Raw address value
|
|
|
276 */
|
|
|
277 #define ARRAY_ADDRESS(__ADDRESS__ , __HANDLE__) ((__ADDRESS__)->Page + \
|
|
|
278 (((__ADDRESS__)->Block + (((__ADDRESS__)->Zone) * ((__HANDLE__)->Info.ZoneSize)))* ((__HANDLE__)->Info.BlockSize)))
|
|
|
279
|
|
|
280 /**
|
|
|
281 * @brief NAND memory address cycling.
|
|
|
282 * @param __ADDRESS__: NAND memory address.
|
|
|
283 * @retval NAND address cycling value.
|
|
|
284 */
|
|
|
285 #define ADDR_1ST_CYCLE(__ADDRESS__) (uint8_t)(__ADDRESS__) /* 1st addressing cycle */
|
|
|
286 #define ADDR_2ND_CYCLE(__ADDRESS__) (uint8_t)((__ADDRESS__) >> 8) /* 2nd addressing cycle */
|
|
|
287 #define ADDR_3RD_CYCLE(__ADDRESS__) (uint8_t)((__ADDRESS__) >> 16) /* 3rd addressing cycle */
|
|
|
288 #define ADDR_4TH_CYCLE(__ADDRESS__) (uint8_t)((__ADDRESS__) >> 24) /* 4th addressing cycle */
|
|
|
289 /**
|
|
|
290 * @}
|
|
|
291 */
|
|
|
292 #endif /* STM32F405xx || STM32F415xx || STM32F407xx || STM32F417xx || STM32F427xx || STM32F437xx || STM32F429xx || STM32F439xx */
|
|
|
293
|
|
|
294 /**
|
|
|
295 * @}
|
|
|
296 */
|
|
|
297 /**
|
|
|
298 * @}
|
|
|
299 */
|
|
|
300
|
|
|
301 /**
|
|
|
302 * @}
|
|
|
303 */
|
|
|
304
|
|
|
305 #ifdef __cplusplus
|
|
|
306 }
|
|
|
307 #endif
|
|
|
308
|
|
|
309 #endif /* __STM32F4xx_HAL_NAND_H */
|
|
|
310
|
|
|
311 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
|
