Ricardo Benitez / mbed

meh

Fork of mbed by mbed official

TARGET_NUCLEO_F401RE/stm32f4xx_hal_nor.h@77:869cf507173a, 2014-02-14 (annotated)

Committer:
emilmont
Date:
Fri Feb 14 14:36:43 2014 +0000
Revision:
77:869cf507173a
Child:
81:7d30d6019079
Release 77 of the mbed library



Main changes:

* Add target NUCLEO_F030R8

* Add target NUCLEO_F401RE

* Add target NUCLEO_F103RB

* Add target NUCLEO_L152RE

Who changed what in which revision?

UserRevisionLine numberNew contents of line
emilmont 77:869cf507173a 1 /**
emilmont 77:869cf507173a 2 ******************************************************************************
emilmont 77:869cf507173a 3 * @file stm32f4xx_hal_nor.h
emilmont 77:869cf507173a 4 * @author MCD Application Team
emilmont 77:869cf507173a 5 * @version V1.0.0RC2
emilmont 77:869cf507173a 6 * @date 04-February-2014
emilmont 77:869cf507173a 7 * @brief Header file of NOR HAL module.
emilmont 77:869cf507173a 8 ******************************************************************************
emilmont 77:869cf507173a 9 * @attention
emilmont 77:869cf507173a 10 *
emilmont 77:869cf507173a 11 * <h2><center>&copy; COPYRIGHT(c) 2014 STMicroelectronics</center></h2>
emilmont 77:869cf507173a 12 *
emilmont 77:869cf507173a 13 * Redistribution and use in source and binary forms, with or without modification,
emilmont 77:869cf507173a 14 * are permitted provided that the following conditions are met:
emilmont 77:869cf507173a 15 * 1. Redistributions of source code must retain the above copyright notice,
emilmont 77:869cf507173a 16 * this list of conditions and the following disclaimer.
emilmont 77:869cf507173a 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
emilmont 77:869cf507173a 18 * this list of conditions and the following disclaimer in the documentation
emilmont 77:869cf507173a 19 * and/or other materials provided with the distribution.
emilmont 77:869cf507173a 20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
emilmont 77:869cf507173a 21 * may be used to endorse or promote products derived from this software
emilmont 77:869cf507173a 22 * without specific prior written permission.
emilmont 77:869cf507173a 23 *
emilmont 77:869cf507173a 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
emilmont 77:869cf507173a 25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
emilmont 77:869cf507173a 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
emilmont 77:869cf507173a 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
emilmont 77:869cf507173a 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
emilmont 77:869cf507173a 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
emilmont 77:869cf507173a 30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
emilmont 77:869cf507173a 31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
emilmont 77:869cf507173a 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
emilmont 77:869cf507173a 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
emilmont 77:869cf507173a 34 *
emilmont 77:869cf507173a 35 ******************************************************************************
emilmont 77:869cf507173a 36 */
emilmont 77:869cf507173a 37
emilmont 77:869cf507173a 38 /* Define to prevent recursive inclusion -------------------------------------*/
emilmont 77:869cf507173a 39 #ifndef __STM32F4xx_HAL_NOR_H
emilmont 77:869cf507173a 40 #define __STM32F4xx_HAL_NOR_H
emilmont 77:869cf507173a 41
emilmont 77:869cf507173a 42 #ifdef __cplusplus
emilmont 77:869cf507173a 43 extern "C" {
emilmont 77:869cf507173a 44 #endif
emilmont 77:869cf507173a 45
emilmont 77:869cf507173a 46 /* Includes ------------------------------------------------------------------*/
emilmont 77:869cf507173a 47 #if defined(STM32F405xx) || defined(STM32F415xx) || defined(STM32F407xx)|| defined(STM32F417xx)
emilmont 77:869cf507173a 48 #include "stm32f4xx_ll_fsmc.h"
emilmont 77:869cf507173a 49 #endif /* STM32F405xx || STM32F415xx || STM32F407xx || STM32F417xx */
emilmont 77:869cf507173a 50
emilmont 77:869cf507173a 51 #if defined(STM32F427xx) || defined(STM32F437xx) || defined(STM32F429xx)|| defined(STM32F439xx)
emilmont 77:869cf507173a 52 #include "stm32f4xx_ll_fmc.h"
emilmont 77:869cf507173a 53 #endif /* STM32F427xx || STM32F437xx || STM32F429xx || STM32F439xx */
emilmont 77:869cf507173a 54
emilmont 77:869cf507173a 55 /** @addtogroup STM32F4xx_HAL_Driver
emilmont 77:869cf507173a 56 * @{
emilmont 77:869cf507173a 57 */
emilmont 77:869cf507173a 58
emilmont 77:869cf507173a 59 /** @addtogroup NOR
emilmont 77:869cf507173a 60 * @{
emilmont 77:869cf507173a 61 */
emilmont 77:869cf507173a 62
emilmont 77:869cf507173a 63 #if defined(STM32F405xx) || defined(STM32F415xx) || defined(STM32F407xx) || defined(STM32F417xx) || defined(STM32F427xx) || defined(STM32F437xx) || defined(STM32F429xx) || defined(STM32F439xx)
emilmont 77:869cf507173a 64
emilmont 77:869cf507173a 65 /* Exported typedef ----------------------------------------------------------*/
emilmont 77:869cf507173a 66 /**
emilmont 77:869cf507173a 67 * @brief HAL SRAM State structures definition
emilmont 77:869cf507173a 68 */
emilmont 77:869cf507173a 69 typedef enum
emilmont 77:869cf507173a 70 {
emilmont 77:869cf507173a 71 HAL_NOR_STATE_RESET = 0x00, /*!< NOR not yet initialized or disabled */
emilmont 77:869cf507173a 72 HAL_NOR_STATE_READY = 0x01, /*!< NOR initialized and ready for use */
emilmont 77:869cf507173a 73 HAL_NOR_STATE_BUSY = 0x02, /*!< NOR internal processing is ongoing */
emilmont 77:869cf507173a 74 HAL_NOR_STATE_ERROR = 0x03, /*!< NOR error state */
emilmont 77:869cf507173a 75 HAL_NOR_STATE_PROTECTED = 0x04 /*!< NOR NORSRAM device write protected */
emilmont 77:869cf507173a 76
emilmont 77:869cf507173a 77 }HAL_NOR_StateTypeDef;
emilmont 77:869cf507173a 78
emilmont 77:869cf507173a 79 /**
emilmont 77:869cf507173a 80 * @brief FMC NOR Status typedef
emilmont 77:869cf507173a 81 */
emilmont 77:869cf507173a 82 typedef enum
emilmont 77:869cf507173a 83 {
emilmont 77:869cf507173a 84 NOR_SUCCESS = 0,
emilmont 77:869cf507173a 85 NOR_ONGOING,
emilmont 77:869cf507173a 86 NOR_ERROR,
emilmont 77:869cf507173a 87 NOR_TIMEOUT
emilmont 77:869cf507173a 88
emilmont 77:869cf507173a 89 }NOR_StatusTypedef;
emilmont 77:869cf507173a 90
emilmont 77:869cf507173a 91 /**
emilmont 77:869cf507173a 92 * @brief FMC NOR ID typedef
emilmont 77:869cf507173a 93 */
emilmont 77:869cf507173a 94 typedef struct
emilmont 77:869cf507173a 95 {
emilmont 77:869cf507173a 96 uint16_t Manufacturer_Code; /*!< Defines the device's manufacturer code used to identify the memory */
emilmont 77:869cf507173a 97
emilmont 77:869cf507173a 98 uint16_t Device_Code1;
emilmont 77:869cf507173a 99
emilmont 77:869cf507173a 100 uint16_t Device_Code2;
emilmont 77:869cf507173a 101
emilmont 77:869cf507173a 102 uint16_t Device_Code3; /*!< Defines the device's codes used to identify the memory.
emilmont 77:869cf507173a 103 These codes can be accessed by performing read operations with specific
emilmont 77:869cf507173a 104 control signals and addresses set.They can also be accessed by issuing
emilmont 77:869cf507173a 105 an Auto Select command */
emilmont 77:869cf507173a 106
emilmont 77:869cf507173a 107 }NOR_IDTypeDef;
emilmont 77:869cf507173a 108
emilmont 77:869cf507173a 109
emilmont 77:869cf507173a 110 /**
emilmont 77:869cf507173a 111 * @brief FMC NOR CFI typedef
emilmont 77:869cf507173a 112 */
emilmont 77:869cf507173a 113 typedef struct
emilmont 77:869cf507173a 114 {
emilmont 77:869cf507173a 115 /*!< Defines the information stored in the memory's Common flash interface
emilmont 77:869cf507173a 116 which contains a description of various electrical and timing parameters,
emilmont 77:869cf507173a 117 density information and functions supported by the memory */
emilmont 77:869cf507173a 118
emilmont 77:869cf507173a 119 uint16_t CFI_1;
emilmont 77:869cf507173a 120
emilmont 77:869cf507173a 121 uint16_t CFI_2;
emilmont 77:869cf507173a 122
emilmont 77:869cf507173a 123 uint16_t CFI_3;
emilmont 77:869cf507173a 124
emilmont 77:869cf507173a 125 uint16_t CFI_4;
emilmont 77:869cf507173a 126
emilmont 77:869cf507173a 127 }NOR_CFITypeDef;
emilmont 77:869cf507173a 128
emilmont 77:869cf507173a 129 /**
emilmont 77:869cf507173a 130 * @brief NOR handle Structure definition
emilmont 77:869cf507173a 131 */
emilmont 77:869cf507173a 132 typedef struct
emilmont 77:869cf507173a 133 {
emilmont 77:869cf507173a 134 FMC_NORSRAM_TypeDef *Instance; /*!< Register base address */
emilmont 77:869cf507173a 135
emilmont 77:869cf507173a 136 FMC_NORSRAM_EXTENDED_TypeDef *Extended; /*!< Extended mode register base address */
emilmont 77:869cf507173a 137
emilmont 77:869cf507173a 138 FMC_NORSRAM_InitTypeDef Init; /*!< NOR device control configuration parameters */
emilmont 77:869cf507173a 139
emilmont 77:869cf507173a 140 HAL_LockTypeDef Lock; /*!< NOR locking object */
emilmont 77:869cf507173a 141
emilmont 77:869cf507173a 142 __IO HAL_NOR_StateTypeDef State; /*!< NOR device access state */
emilmont 77:869cf507173a 143
emilmont 77:869cf507173a 144 }NOR_HandleTypeDef;
emilmont 77:869cf507173a 145
emilmont 77:869cf507173a 146 /* Exported constants --------------------------------------------------------*/
emilmont 77:869cf507173a 147 /** @defgroup NOR_Exported_Constants
emilmont 77:869cf507173a 148 * @{
emilmont 77:869cf507173a 149 */
emilmont 77:869cf507173a 150 /* NOR device IDs addresses */
emilmont 77:869cf507173a 151 #define MC_ADDRESS ((uint16_t)0x0000)
emilmont 77:869cf507173a 152 #define DEVICE_CODE1_ADDR ((uint16_t)0x0001)
emilmont 77:869cf507173a 153 #define DEVICE_CODE2_ADDR ((uint16_t)0x000E)
emilmont 77:869cf507173a 154 #define DEVICE_CODE3_ADDR ((uint16_t)0x000F)
emilmont 77:869cf507173a 155
emilmont 77:869cf507173a 156 /* NOR CFI IDs addresses */
emilmont 77:869cf507173a 157 #define CFI1_ADDRESS ((uint16_t)0x61)
emilmont 77:869cf507173a 158 #define CFI2_ADDRESS ((uint16_t)0x62)
emilmont 77:869cf507173a 159 #define CFI3_ADDRESS ((uint16_t)0x63)
emilmont 77:869cf507173a 160 #define CFI4_ADDRESS ((uint16_t)0x64)
emilmont 77:869cf507173a 161
emilmont 77:869cf507173a 162 /* NOR operation wait timeout */
emilmont 77:869cf507173a 163 #define NOR_TMEOUT ((uint16_t)0xFFFF)
emilmont 77:869cf507173a 164
emilmont 77:869cf507173a 165 /* #define NOR_MEMORY_16B */
emilmont 77:869cf507173a 166 #define NOR_MEMORY_8B
emilmont 77:869cf507173a 167
emilmont 77:869cf507173a 168 /* NOR memory device read/write start address */
emilmont 77:869cf507173a 169 #define NOR_MEMORY_ADRESS ((uint32_t)0x60000000)
emilmont 77:869cf507173a 170
emilmont 77:869cf507173a 171 /**
emilmont 77:869cf507173a 172 * @}
emilmont 77:869cf507173a 173 */
emilmont 77:869cf507173a 174
emilmont 77:869cf507173a 175 /* Exported macro ------------------------------------------------------------*/
emilmont 77:869cf507173a 176 /**
emilmont 77:869cf507173a 177 * @brief NOR memory address shifting.
emilmont 77:869cf507173a 178 * @param __ADDRESS__: NOR memory address
emilmont 77:869cf507173a 179 * @retval NOR shifted address value
emilmont 77:869cf507173a 180 */
emilmont 77:869cf507173a 181 #ifdef NOR_MEMORY_8B
emilmont 77:869cf507173a 182 #define __NOR_ADDR_SHIFT(__ADDRESS__) (uint32_t)(NOR_MEMORY_ADRESS + (2 * (__ADDRESS__)))
emilmont 77:869cf507173a 183 #else /* NOR_MEMORY_16B */
emilmont 77:869cf507173a 184 #define __NOR_ADDR_SHIFT(__ADDRESS__) (uint32_t)(NOR_MEMORY_ADRESS + (__ADDRESS__))
emilmont 77:869cf507173a 185 #endif /* NOR_MEMORY_8B */
emilmont 77:869cf507173a 186
emilmont 77:869cf507173a 187 /**
emilmont 77:869cf507173a 188 * @brief NOR memory write data to specified address.
emilmont 77:869cf507173a 189 * @param __ADDRESS__: NOR memory address
emilmont 77:869cf507173a 190 * @param __DATA__: Data to write
emilmont 77:869cf507173a 191 * @retval None
emilmont 77:869cf507173a 192 */
emilmont 77:869cf507173a 193 #define __NOR_WRITE(__ADDRESS__, __DATA__) (*(__IO uint32_t *)(__ADDRESS__) = (__DATA__))
emilmont 77:869cf507173a 194
emilmont 77:869cf507173a 195 /* Exported functions --------------------------------------------------------*/
emilmont 77:869cf507173a 196
emilmont 77:869cf507173a 197 /* Initialization/de-initialization functions **********************************/
emilmont 77:869cf507173a 198 HAL_StatusTypeDef HAL_NOR_Init(NOR_HandleTypeDef *hnor, FMC_NORSRAM_TimingTypeDef *Timing, FMC_NORSRAM_TimingTypeDef *ExtTiming);
emilmont 77:869cf507173a 199 HAL_StatusTypeDef HAL_NOR_DeInit(NOR_HandleTypeDef *hnor);
emilmont 77:869cf507173a 200 __weak void HAL_NOR_MspInit(NOR_HandleTypeDef *hnor);
emilmont 77:869cf507173a 201 __weak void HAL_NOR_MspDeInit(NOR_HandleTypeDef *hnor);
emilmont 77:869cf507173a 202 __weak void HAL_NOR_MspWait(NOR_HandleTypeDef *hnor, uint32_t Timeout);
emilmont 77:869cf507173a 203
emilmont 77:869cf507173a 204 /* I/O operation functions *****************************************************/
emilmont 77:869cf507173a 205 HAL_StatusTypeDef HAL_NOR_Read_ID(NOR_HandleTypeDef *hnor, NOR_IDTypeDef *pNOR_ID);
emilmont 77:869cf507173a 206 HAL_StatusTypeDef HAL_NOR_ReturnToReadMode(NOR_HandleTypeDef *hnor);
emilmont 77:869cf507173a 207 HAL_StatusTypeDef HAL_NOR_Read(NOR_HandleTypeDef *hnor, uint32_t *pAddress, uint16_t *pData);
emilmont 77:869cf507173a 208 HAL_StatusTypeDef HAL_NOR_Program(NOR_HandleTypeDef *hnor, uint32_t *pAddress, uint16_t *pData);
emilmont 77:869cf507173a 209
emilmont 77:869cf507173a 210 HAL_StatusTypeDef HAL_NOR_ReadBuffer(NOR_HandleTypeDef *hnor, uint32_t uwAddress, uint16_t *pData, uint32_t uwBufferSize);
emilmont 77:869cf507173a 211 HAL_StatusTypeDef HAL_NOR_ProgramBuffer(NOR_HandleTypeDef *hnor, uint32_t uwAddress, uint16_t *pData, uint32_t uwBufferSize);
emilmont 77:869cf507173a 212
emilmont 77:869cf507173a 213 HAL_StatusTypeDef HAL_NOR_Erase_Block(NOR_HandleTypeDef *hnor, uint32_t BlockAddress, uint32_t Address);
emilmont 77:869cf507173a 214 HAL_StatusTypeDef HAL_NOR_Erase_Chip(NOR_HandleTypeDef *hnor, uint32_t Address);
emilmont 77:869cf507173a 215 HAL_StatusTypeDef HAL_NOR_Read_CFI(NOR_HandleTypeDef *hnor, NOR_CFITypeDef *pNOR_CFI);
emilmont 77:869cf507173a 216
emilmont 77:869cf507173a 217 /* NOR Control functions *******************************************************/
emilmont 77:869cf507173a 218 HAL_StatusTypeDef HAL_NOR_WriteOperation_Enable(NOR_HandleTypeDef *hnor);
emilmont 77:869cf507173a 219 HAL_StatusTypeDef HAL_NOR_WriteOperation_Disable(NOR_HandleTypeDef *hnor);
emilmont 77:869cf507173a 220
emilmont 77:869cf507173a 221 /* NOR State functions **********************************************************/
emilmont 77:869cf507173a 222 HAL_NOR_StateTypeDef HAL_NOR_GetState(NOR_HandleTypeDef *hnor);
emilmont 77:869cf507173a 223 NOR_StatusTypedef HAL_NOR_GetStatus(NOR_HandleTypeDef *hnor, uint32_t Address, uint32_t Timeout);
emilmont 77:869cf507173a 224
emilmont 77:869cf507173a 225 #endif /* STM32F405xx || STM32F415xx || STM32F407xx || STM32F417xx || STM32F427xx || STM32F437xx || STM32F429xx || STM32F439xx */
emilmont 77:869cf507173a 226 /**
emilmont 77:869cf507173a 227 * @}
emilmont 77:869cf507173a 228 */
emilmont 77:869cf507173a 229
emilmont 77:869cf507173a 230 /**
emilmont 77:869cf507173a 231 * @}
emilmont 77:869cf507173a 232 */
emilmont 77:869cf507173a 233
emilmont 77:869cf507173a 234 #ifdef __cplusplus
emilmont 77:869cf507173a 235 }
emilmont 77:869cf507173a 236 #endif
emilmont 77:869cf507173a 237
emilmont 77:869cf507173a 238 #endif /* __STM32F4xx_HAL_NOR_H */
emilmont 77:869cf507173a 239
emilmont 77:869cf507173a 240 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/