Ricardo Benitez / mbed

meh

Fork of mbed by mbed official

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