demos/stm32f429_disco/stm/stm32f4_spl/inc/stm32f4xx_hal_nand.h

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