mbed official / mbed-src

mbed library sources

Dependents:   Encrypted my_mbed lklk CyaSSL_DTLS_Cellular ... more

Superseded

This library was superseded by mbed-dev - https://os.mbed.com/users/mbed_official/code/mbed-dev/.

Development branch of the mbed library sources. This library is kept in synch with the latest changes from the mbed SDK and it is not guaranteed to work.

If you are looking for a stable and tested release, please import one of the official mbed library releases:

Import librarymbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Last commit 20 Feb 2019 by mbed official

targets/cmsis/TARGET_STM/TARGET_NUCLEO_F401RE/stm32f4xx_hal_nor.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
Child:
226:b062af740e40
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_nor.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 NOR 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_NOR_H
mbed_official 87:085cde657901 40 #define __STM32F4xx_HAL_NOR_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 NOR
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 /**
mbed_official 87:085cde657901 67 * @brief HAL SRAM State structures definition
mbed_official 87:085cde657901 68 */
mbed_official 87:085cde657901 69 typedef enum
mbed_official 87:085cde657901 70 {
mbed_official 87:085cde657901 71 HAL_NOR_STATE_RESET = 0x00, /*!< NOR not yet initialized or disabled */
mbed_official 87:085cde657901 72 HAL_NOR_STATE_READY = 0x01, /*!< NOR initialized and ready for use */
mbed_official 87:085cde657901 73 HAL_NOR_STATE_BUSY = 0x02, /*!< NOR internal processing is ongoing */
mbed_official 87:085cde657901 74 HAL_NOR_STATE_ERROR = 0x03, /*!< NOR error state */
mbed_official 87:085cde657901 75 HAL_NOR_STATE_PROTECTED = 0x04 /*!< NOR NORSRAM device write protected */
mbed_official 87:085cde657901 76
mbed_official 87:085cde657901 77 }HAL_NOR_StateTypeDef;
mbed_official 87:085cde657901 78
mbed_official 87:085cde657901 79 /**
mbed_official 87:085cde657901 80 * @brief FMC NOR Status typedef
mbed_official 87:085cde657901 81 */
mbed_official 87:085cde657901 82 typedef enum
mbed_official 87:085cde657901 83 {
mbed_official 87:085cde657901 84 NOR_SUCCESS = 0,
mbed_official 87:085cde657901 85 NOR_ONGOING,
mbed_official 87:085cde657901 86 NOR_ERROR,
mbed_official 87:085cde657901 87 NOR_TIMEOUT
mbed_official 87:085cde657901 88
mbed_official 87:085cde657901 89 }NOR_StatusTypedef;
mbed_official 87:085cde657901 90
mbed_official 87:085cde657901 91 /**
mbed_official 87:085cde657901 92 * @brief FMC NOR ID typedef
mbed_official 87:085cde657901 93 */
mbed_official 87:085cde657901 94 typedef struct
mbed_official 87:085cde657901 95 {
mbed_official 87:085cde657901 96 uint16_t Manufacturer_Code; /*!< Defines the device's manufacturer code used to identify the memory */
mbed_official 87:085cde657901 97
mbed_official 87:085cde657901 98 uint16_t Device_Code1;
mbed_official 87:085cde657901 99
mbed_official 87:085cde657901 100 uint16_t Device_Code2;
mbed_official 87:085cde657901 101
mbed_official 87:085cde657901 102 uint16_t Device_Code3; /*!< Defines the device's codes used to identify the memory.
mbed_official 87:085cde657901 103 These codes can be accessed by performing read operations with specific
mbed_official 87:085cde657901 104 control signals and addresses set.They can also be accessed by issuing
mbed_official 87:085cde657901 105 an Auto Select command */
mbed_official 87:085cde657901 106
mbed_official 87:085cde657901 107 }NOR_IDTypeDef;
mbed_official 87:085cde657901 108
mbed_official 87:085cde657901 109
mbed_official 87:085cde657901 110 /**
mbed_official 87:085cde657901 111 * @brief FMC NOR CFI typedef
mbed_official 87:085cde657901 112 */
mbed_official 87:085cde657901 113 typedef struct
mbed_official 87:085cde657901 114 {
mbed_official 87:085cde657901 115 /*!< Defines the information stored in the memory's Common flash interface
mbed_official 87:085cde657901 116 which contains a description of various electrical and timing parameters,
mbed_official 87:085cde657901 117 density information and functions supported by the memory */
mbed_official 87:085cde657901 118
mbed_official 87:085cde657901 119 uint16_t CFI_1;
mbed_official 87:085cde657901 120
mbed_official 87:085cde657901 121 uint16_t CFI_2;
mbed_official 87:085cde657901 122
mbed_official 87:085cde657901 123 uint16_t CFI_3;
mbed_official 87:085cde657901 124
mbed_official 87:085cde657901 125 uint16_t CFI_4;
mbed_official 87:085cde657901 126
mbed_official 87:085cde657901 127 }NOR_CFITypeDef;
mbed_official 87:085cde657901 128
mbed_official 87:085cde657901 129 /**
mbed_official 87:085cde657901 130 * @brief NOR handle Structure definition
mbed_official 87:085cde657901 131 */
mbed_official 87:085cde657901 132 typedef struct
mbed_official 87:085cde657901 133 {
mbed_official 87:085cde657901 134 FMC_NORSRAM_TypeDef *Instance; /*!< Register base address */
mbed_official 87:085cde657901 135
mbed_official 87:085cde657901 136 FMC_NORSRAM_EXTENDED_TypeDef *Extended; /*!< Extended mode register base address */
mbed_official 87:085cde657901 137
mbed_official 87:085cde657901 138 FMC_NORSRAM_InitTypeDef Init; /*!< NOR device control configuration parameters */
mbed_official 87:085cde657901 139
mbed_official 87:085cde657901 140 HAL_LockTypeDef Lock; /*!< NOR locking object */
mbed_official 87:085cde657901 141
mbed_official 87:085cde657901 142 __IO HAL_NOR_StateTypeDef State; /*!< NOR device access state */
mbed_official 87:085cde657901 143
mbed_official 87:085cde657901 144 }NOR_HandleTypeDef;
mbed_official 87:085cde657901 145
mbed_official 87:085cde657901 146 /* Exported constants --------------------------------------------------------*/
mbed_official 87:085cde657901 147 /** @defgroup NOR_Exported_Constants
mbed_official 87:085cde657901 148 * @{
mbed_official 87:085cde657901 149 */
mbed_official 87:085cde657901 150 /* NOR device IDs addresses */
mbed_official 87:085cde657901 151 #define MC_ADDRESS ((uint16_t)0x0000)
mbed_official 87:085cde657901 152 #define DEVICE_CODE1_ADDR ((uint16_t)0x0001)
mbed_official 87:085cde657901 153 #define DEVICE_CODE2_ADDR ((uint16_t)0x000E)
mbed_official 87:085cde657901 154 #define DEVICE_CODE3_ADDR ((uint16_t)0x000F)
mbed_official 87:085cde657901 155
mbed_official 87:085cde657901 156 /* NOR CFI IDs addresses */
mbed_official 87:085cde657901 157 #define CFI1_ADDRESS ((uint16_t)0x61)
mbed_official 87:085cde657901 158 #define CFI2_ADDRESS ((uint16_t)0x62)
mbed_official 87:085cde657901 159 #define CFI3_ADDRESS ((uint16_t)0x63)
mbed_official 87:085cde657901 160 #define CFI4_ADDRESS ((uint16_t)0x64)
mbed_official 87:085cde657901 161
mbed_official 87:085cde657901 162 /* NOR operation wait timeout */
mbed_official 87:085cde657901 163 #define NOR_TMEOUT ((uint16_t)0xFFFF)
mbed_official 87:085cde657901 164
mbed_official 87:085cde657901 165 /* #define NOR_MEMORY_16B */
mbed_official 87:085cde657901 166 #define NOR_MEMORY_8B
mbed_official 87:085cde657901 167
mbed_official 87:085cde657901 168 /* NOR memory device read/write start address */
mbed_official 87:085cde657901 169 #define NOR_MEMORY_ADRESS ((uint32_t)0x60000000)
mbed_official 87:085cde657901 170
mbed_official 87:085cde657901 171 /**
mbed_official 87:085cde657901 172 * @}
mbed_official 87:085cde657901 173 */
mbed_official 87:085cde657901 174
mbed_official 87:085cde657901 175 /* Exported macro ------------------------------------------------------------*/
mbed_official 87:085cde657901 176 /**
mbed_official 87:085cde657901 177 * @brief NOR memory address shifting.
mbed_official 87:085cde657901 178 * @param __ADDRESS__: NOR memory address
mbed_official 87:085cde657901 179 * @retval NOR shifted address value
mbed_official 87:085cde657901 180 */
mbed_official 87:085cde657901 181 #ifdef NOR_MEMORY_8B
mbed_official 87:085cde657901 182 #define __NOR_ADDR_SHIFT(__ADDRESS__) (uint32_t)(NOR_MEMORY_ADRESS + (2 * (__ADDRESS__)))
mbed_official 87:085cde657901 183 #else /* NOR_MEMORY_16B */
mbed_official 87:085cde657901 184 #define __NOR_ADDR_SHIFT(__ADDRESS__) (uint32_t)(NOR_MEMORY_ADRESS + (__ADDRESS__))
mbed_official 87:085cde657901 185 #endif /* NOR_MEMORY_8B */
mbed_official 87:085cde657901 186
mbed_official 87:085cde657901 187 /**
mbed_official 87:085cde657901 188 * @brief NOR memory write data to specified address.
mbed_official 87:085cde657901 189 * @param __ADDRESS__: NOR memory address
mbed_official 87:085cde657901 190 * @param __DATA__: Data to write
mbed_official 87:085cde657901 191 * @retval None
mbed_official 87:085cde657901 192 */
mbed_official 106:ced8cbb51063 193 #define __NOR_WRITE(__ADDRESS__, __DATA__) (*(__IO uint16_t *)((uint32_t)(__ADDRESS__)) = (__DATA__))
mbed_official 87:085cde657901 194
mbed_official 87:085cde657901 195 /* Exported functions --------------------------------------------------------*/
mbed_official 87:085cde657901 196
mbed_official 87:085cde657901 197 /* Initialization/de-initialization functions **********************************/
mbed_official 87:085cde657901 198 HAL_StatusTypeDef HAL_NOR_Init(NOR_HandleTypeDef *hnor, FMC_NORSRAM_TimingTypeDef *Timing, FMC_NORSRAM_TimingTypeDef *ExtTiming);
mbed_official 87:085cde657901 199 HAL_StatusTypeDef HAL_NOR_DeInit(NOR_HandleTypeDef *hnor);
mbed_official 106:ced8cbb51063 200 void HAL_NOR_MspInit(NOR_HandleTypeDef *hnor);
mbed_official 106:ced8cbb51063 201 void HAL_NOR_MspDeInit(NOR_HandleTypeDef *hnor);
mbed_official 106:ced8cbb51063 202 void HAL_NOR_MspWait(NOR_HandleTypeDef *hnor, uint32_t Timeout);
mbed_official 87:085cde657901 203
mbed_official 87:085cde657901 204 /* I/O operation functions *****************************************************/
mbed_official 87:085cde657901 205 HAL_StatusTypeDef HAL_NOR_Read_ID(NOR_HandleTypeDef *hnor, NOR_IDTypeDef *pNOR_ID);
mbed_official 87:085cde657901 206 HAL_StatusTypeDef HAL_NOR_ReturnToReadMode(NOR_HandleTypeDef *hnor);
mbed_official 87:085cde657901 207 HAL_StatusTypeDef HAL_NOR_Read(NOR_HandleTypeDef *hnor, uint32_t *pAddress, uint16_t *pData);
mbed_official 87:085cde657901 208 HAL_StatusTypeDef HAL_NOR_Program(NOR_HandleTypeDef *hnor, uint32_t *pAddress, uint16_t *pData);
mbed_official 87:085cde657901 209
mbed_official 87:085cde657901 210 HAL_StatusTypeDef HAL_NOR_ReadBuffer(NOR_HandleTypeDef *hnor, uint32_t uwAddress, uint16_t *pData, uint32_t uwBufferSize);
mbed_official 87:085cde657901 211 HAL_StatusTypeDef HAL_NOR_ProgramBuffer(NOR_HandleTypeDef *hnor, uint32_t uwAddress, uint16_t *pData, uint32_t uwBufferSize);
mbed_official 87:085cde657901 212
mbed_official 87:085cde657901 213 HAL_StatusTypeDef HAL_NOR_Erase_Block(NOR_HandleTypeDef *hnor, uint32_t BlockAddress, uint32_t Address);
mbed_official 87:085cde657901 214 HAL_StatusTypeDef HAL_NOR_Erase_Chip(NOR_HandleTypeDef *hnor, uint32_t Address);
mbed_official 87:085cde657901 215 HAL_StatusTypeDef HAL_NOR_Read_CFI(NOR_HandleTypeDef *hnor, NOR_CFITypeDef *pNOR_CFI);
mbed_official 87:085cde657901 216
mbed_official 87:085cde657901 217 /* NOR Control functions *******************************************************/
mbed_official 87:085cde657901 218 HAL_StatusTypeDef HAL_NOR_WriteOperation_Enable(NOR_HandleTypeDef *hnor);
mbed_official 87:085cde657901 219 HAL_StatusTypeDef HAL_NOR_WriteOperation_Disable(NOR_HandleTypeDef *hnor);
mbed_official 87:085cde657901 220
mbed_official 87:085cde657901 221 /* NOR State functions **********************************************************/
mbed_official 87:085cde657901 222 HAL_NOR_StateTypeDef HAL_NOR_GetState(NOR_HandleTypeDef *hnor);
mbed_official 87:085cde657901 223 NOR_StatusTypedef HAL_NOR_GetStatus(NOR_HandleTypeDef *hnor, uint32_t Address, uint32_t Timeout);
mbed_official 87:085cde657901 224
mbed_official 87:085cde657901 225 #endif /* STM32F405xx || STM32F415xx || STM32F407xx || STM32F417xx || STM32F427xx || STM32F437xx || STM32F429xx || STM32F439xx */
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 /**
mbed_official 87:085cde657901 231 * @}
mbed_official 87:085cde657901 232 */
mbed_official 87:085cde657901 233
mbed_official 87:085cde657901 234 #ifdef __cplusplus
mbed_official 87:085cde657901 235 }
mbed_official 87:085cde657901 236 #endif
mbed_official 87:085cde657901 237
mbed_official 87:085cde657901 238 #endif /* __STM32F4xx_HAL_NOR_H */
mbed_official 87:085cde657901 239
mbed_official 87:085cde657901 240 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/