Peter Drescher / mbed-F401

mbed library with additional peripherals for ST F401 board

Fork of mbed-src by mbed official

This mbed LIB has additional peripherals for ST F401 board

  • UART2 : PA_3 rx, PA_2 tx
  • UART3 : PC_7 rx, PC_6 tx
  • I2C2 : PB_3 SDA, PB_10 SCL
  • I2C3 : PB_4 SDA, PA_8 SCL

targets/cmsis/TARGET_STM/TARGET_NUCLEO_F401RE/stm32f4xx_hal_nand.h@106:ced8cbb51063, 2014-02-26 (annotated)

Committer:
mbed_official
Date:
Wed Feb 26 09:45:12 2014 +0000
Revision:
106:ced8cbb51063
Parent:
87:085cde657901 
Synchronized with git revision 4222735eff5868389433f0e9271976b39c8115cd



Full URL: https://github.com/mbedmicro/mbed/commit/4222735eff5868389433f0e9271976b39c8115cd/



[NUCLEO_xxx] Update STM32CubeF4 driver V1.0.0 + update license

Who changed what in which revision?

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