stm32f411/stm32f411e-disco/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_nor.h
Go to the documentation of this file.
1 
20 /* Define to prevent recursive inclusion -------------------------------------*/
21 #ifndef __STM32F4xx_HAL_NOR_H
22 #define __STM32F4xx_HAL_NOR_H
23 
24 #ifdef __cplusplus
25  extern "C" {
26 #endif
27 
28 /* Includes ------------------------------------------------------------------*/
29 #if defined(STM32F405xx) || defined(STM32F415xx) || defined(STM32F407xx) || defined(STM32F417xx) || defined(STM32F412Zx) ||\
30  defined(STM32F412Vx) || defined(STM32F412Rx) || defined(STM32F413xx) || defined(STM32F423xx)
31  #include "stm32f4xx_ll_fsmc.h"
32 #endif /* STM32F405xx || STM32F415xx || STM32F407xx || STM32F417xx || STM32F412Zx || STM32F412Vx || STM32F412Rx || STM32F413xx || STM32F423xx */
33 
34 #if defined(STM32F427xx) || defined(STM32F437xx) || defined(STM32F429xx) || defined(STM32F439xx) ||\
35  defined(STM32F446xx) || defined(STM32F469xx) || defined(STM32F479xx)
36  #include "stm32f4xx_ll_fmc.h"
37 #endif /* STM32F427xx || STM32F437xx || STM32F429xx || STM32F439xx || STM32F446xx || STM32F469xx || STM32F479xx */
38 
47 #if defined(STM32F405xx) || defined(STM32F415xx) || defined(STM32F407xx) || defined(STM32F417xx) ||\
48  defined(STM32F427xx) || defined(STM32F437xx) || defined(STM32F429xx) || defined(STM32F439xx) ||\
49  defined(STM32F446xx) || defined(STM32F469xx) || defined(STM32F479xx) || defined(STM32F412Zx) ||\
50  defined(STM32F412Vx) || defined(STM32F412Rx) || defined(STM32F413xx) || defined(STM32F423xx)
51 
52 /* Exported typedef ----------------------------------------------------------*/
60 typedef enum
61 {
62  HAL_NOR_STATE_RESET = 0x00U,
63  HAL_NOR_STATE_READY = 0x01U,
64  HAL_NOR_STATE_BUSY = 0x02U,
65  HAL_NOR_STATE_ERROR = 0x03U,
66  HAL_NOR_STATE_PROTECTED = 0x04U
67 }HAL_NOR_StateTypeDef;
68 
72 typedef enum
73 {
74  HAL_NOR_STATUS_SUCCESS = 0U,
75  HAL_NOR_STATUS_ONGOING,
76  HAL_NOR_STATUS_ERROR,
77  HAL_NOR_STATUS_TIMEOUT
78 }HAL_NOR_StatusTypeDef;
79 
83 typedef struct
84 {
85  uint16_t Manufacturer_Code;
87  uint16_t Device_Code1;
88 
89  uint16_t Device_Code2;
90 
91  uint16_t Device_Code3;
95 }NOR_IDTypeDef;
96 
100 typedef struct
101 {
106  uint16_t CFI_1;
107 
108  uint16_t CFI_2;
109 
110  uint16_t CFI_3;
111 
112  uint16_t CFI_4;
113 }NOR_CFITypeDef;
114 
118 #if (USE_HAL_NOR_REGISTER_CALLBACKS == 1)
119 typedef struct __NOR_HandleTypeDef
120 #else
121 typedef struct
122 #endif /* USE_HAL_NOR_REGISTER_CALLBACKS */
123 
124 {
125  FMC_NORSRAM_TypeDef *Instance;
127  FMC_NORSRAM_EXTENDED_TypeDef *Extended;
129  FMC_NORSRAM_InitTypeDef Init;
131  HAL_LockTypeDef Lock;
133  __IO HAL_NOR_StateTypeDef State;
135 #if (USE_HAL_NOR_REGISTER_CALLBACKS == 1)
136  void (* MspInitCallback) ( struct __NOR_HandleTypeDef * hnor);
137  void (* MspDeInitCallback) ( struct __NOR_HandleTypeDef * hnor);
138 #endif
139 } NOR_HandleTypeDef;
140 
141 #if (USE_HAL_NOR_REGISTER_CALLBACKS == 1)
142 
145 typedef enum
146 {
147  HAL_NOR_MSP_INIT_CB_ID = 0x00U,
148  HAL_NOR_MSP_DEINIT_CB_ID = 0x01U
149 }HAL_NOR_CallbackIDTypeDef;
150 
154 typedef void (*pNOR_CallbackTypeDef)(NOR_HandleTypeDef *hnor);
155 #endif
156 
160 /* Exported constants --------------------------------------------------------*/
161 /* Exported macros ------------------------------------------------------------*/
169 #if (USE_HAL_NOR_REGISTER_CALLBACKS == 1)
170 #define __HAL_NOR_RESET_HANDLE_STATE(__HANDLE__) do { \
171  (__HANDLE__)->State = HAL_NOR_STATE_RESET; \
172  (__HANDLE__)->MspInitCallback = NULL; \
173  (__HANDLE__)->MspDeInitCallback = NULL; \
174  } while(0)
175 #else
176 #define __HAL_NOR_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_NOR_STATE_RESET)
177 #endif
178 
182 /* Exported functions --------------------------------------------------------*/
190 /* Initialization/de-initialization functions ********************************/
191 HAL_StatusTypeDef HAL_NOR_Init(NOR_HandleTypeDef *hnor, FMC_NORSRAM_TimingTypeDef *Timing, FMC_NORSRAM_TimingTypeDef *ExtTiming);
192 HAL_StatusTypeDef HAL_NOR_DeInit(NOR_HandleTypeDef *hnor);
193 void HAL_NOR_MspInit(NOR_HandleTypeDef *hnor);
194 void HAL_NOR_MspDeInit(NOR_HandleTypeDef *hnor);
195 void HAL_NOR_MspWait(NOR_HandleTypeDef *hnor, uint32_t Timeout);
203 /* I/O operation functions ***************************************************/
204 HAL_StatusTypeDef HAL_NOR_Read_ID(NOR_HandleTypeDef *hnor, NOR_IDTypeDef *pNOR_ID);
205 HAL_StatusTypeDef HAL_NOR_ReturnToReadMode(NOR_HandleTypeDef *hnor);
206 HAL_StatusTypeDef HAL_NOR_Read(NOR_HandleTypeDef *hnor, uint32_t *pAddress, uint16_t *pData);
207 HAL_StatusTypeDef HAL_NOR_Program(NOR_HandleTypeDef *hnor, uint32_t *pAddress, uint16_t *pData);
208 
209 HAL_StatusTypeDef HAL_NOR_ReadBuffer(NOR_HandleTypeDef *hnor, uint32_t uwAddress, uint16_t *pData, uint32_t uwBufferSize);
210 HAL_StatusTypeDef HAL_NOR_ProgramBuffer(NOR_HandleTypeDef *hnor, uint32_t uwAddress, uint16_t *pData, uint32_t uwBufferSize);
211 
212 HAL_StatusTypeDef HAL_NOR_Erase_Block(NOR_HandleTypeDef *hnor, uint32_t BlockAddress, uint32_t Address);
213 HAL_StatusTypeDef HAL_NOR_Erase_Chip(NOR_HandleTypeDef *hnor, uint32_t Address);
214 HAL_StatusTypeDef HAL_NOR_Read_CFI(NOR_HandleTypeDef *hnor, NOR_CFITypeDef *pNOR_CFI);
215 
216 #if (USE_HAL_NOR_REGISTER_CALLBACKS == 1)
217 /* NOR callback registering/unregistering */
218 HAL_StatusTypeDef HAL_NOR_RegisterCallback(NOR_HandleTypeDef *hnor, HAL_NOR_CallbackIDTypeDef CallbackId, pNOR_CallbackTypeDef pCallback);
219 HAL_StatusTypeDef HAL_NOR_UnRegisterCallback(NOR_HandleTypeDef *hnor, HAL_NOR_CallbackIDTypeDef CallbackId);
220 #endif
221 
228 /* NOR Control functions *****************************************************/
229 HAL_StatusTypeDef HAL_NOR_WriteOperation_Enable(NOR_HandleTypeDef *hnor);
230 HAL_StatusTypeDef HAL_NOR_WriteOperation_Disable(NOR_HandleTypeDef *hnor);
238 /* NOR State functions ********************************************************/
239 HAL_NOR_StateTypeDef HAL_NOR_GetState(NOR_HandleTypeDef *hnor);
240 HAL_NOR_StatusTypeDef HAL_NOR_GetStatus(NOR_HandleTypeDef *hnor, uint32_t Address, uint32_t Timeout);
249 /* Private types -------------------------------------------------------------*/
250 /* Private variables ---------------------------------------------------------*/
251 /* Private constants ---------------------------------------------------------*/
255 /* NOR device IDs addresses */
256 #define MC_ADDRESS ((uint16_t)0x0000)
257 #define DEVICE_CODE1_ADDR ((uint16_t)0x0001)
258 #define DEVICE_CODE2_ADDR ((uint16_t)0x000E)
259 #define DEVICE_CODE3_ADDR ((uint16_t)0x000F)
260 
261 /* NOR CFI IDs addresses */
262 #define CFI1_ADDRESS ((uint16_t)0x0061)
263 #define CFI2_ADDRESS ((uint16_t)0x0062)
264 #define CFI3_ADDRESS ((uint16_t)0x0063)
265 #define CFI4_ADDRESS ((uint16_t)0x0064)
266 
267 /* NOR operation wait timeout */
268 #define NOR_TMEOUT ((uint16_t)0xFFFF)
269 
270 /* NOR memory data width */
271 #define NOR_MEMORY_8B ((uint8_t)0x00)
272 #define NOR_MEMORY_16B ((uint8_t)0x01)
273 
274 /* NOR memory device read/write start address */
275 #define NOR_MEMORY_ADRESS1 0x60000000U
276 #define NOR_MEMORY_ADRESS2 0x64000000U
277 #define NOR_MEMORY_ADRESS3 0x68000000U
278 #define NOR_MEMORY_ADRESS4 0x6C000000U
279 
283 /* Private macros ------------------------------------------------------------*/
294 #define NOR_ADDR_SHIFT(__NOR_ADDRESS__, NOR_MEMORY_WIDTH, ADDRESS) (uint32_t)(((NOR_MEMORY_WIDTH) == NOR_MEMORY_16B)? ((uint32_t)((__NOR_ADDRESS__) + (2U * (ADDRESS)))):\
295  ((uint32_t)((__NOR_ADDRESS__) + (ADDRESS))))
296 
303 #define NOR_WRITE(ADDRESS, DATA) (*(__IO uint16_t *)((uint32_t)(ADDRESS)) = (DATA))
304 
308 #endif /* STM32F405xx || STM32F415xx || STM32F407xx || STM32F417xx ||\
309  STM32F427xx || STM32F437xx || STM32F429xx || STM32F439xx ||\
310  STM32F446xx || STM32F469xx || STM32F479xx || STM32F412Zx ||\
311  STM32F412Vx || STM32F412Rx || STM32F413xx || STM32F423xx */
312 
320 #ifdef __cplusplus
321 }
322 #endif
323 
324 #endif /* __STM32F4xx_HAL_NOR_H */
325 
326 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
__IO
#define __IO
Definition: imxrt1050/imxrt1050-evkb/CMSIS/core_cm7.h:237
Init
napi_value Init(napi_env env, napi_value exports)
Definition: porcupine/demo/c/pvrecorder/node/pv_recorder_napi.c:197
NOR_HandleTypeDef
NOR handle Structure definition.
Definition: stm32f7xx_hal_nor.h:109
HAL_StatusTypeDef
HAL_StatusTypeDef
HAL Status structures definition
Definition: stm32f407/stm32f407g-disc1/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_def.h:40
Timing
static FMC_SDRAM_TimingTypeDef Timing
Definition: stm32f769i_discovery_sdram.c:124
HAL_NOR_Erase_Block
HAL_StatusTypeDef HAL_NOR_Erase_Block(NOR_HandleTypeDef *hnor, uint32_t BlockAddress, uint32_t Address)
HAL_NOR_STATE_PROTECTED
@ HAL_NOR_STATE_PROTECTED
Definition: stm32f7xx_hal_nor.h:54
HAL_NOR_DeInit
HAL_StatusTypeDef HAL_NOR_DeInit(NOR_HandleTypeDef *hnor)
HAL_LockTypeDef
HAL_LockTypeDef
HAL Lock structures definition
Definition: stm32f407/stm32f407g-disc1/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_def.h:51
FMC_NORSRAM_TypeDef
#define FMC_NORSRAM_TypeDef
Definition: stm32f7xx_ll_fmc.h:383
FMC_NORSRAM_TimingTypeDef
FMC NORSRAM Timing parameters structure definition
Definition: stm32f7xx_ll_fmc.h:460
HAL_NOR_Read_ID
HAL_StatusTypeDef HAL_NOR_Read_ID(NOR_HandleTypeDef *hnor, NOR_IDTypeDef *pNOR_ID)
NOR_CFITypeDef
FMC NOR CFI typedef.
Definition: stm32f7xx_hal_nor.h:88
HAL_NOR_ReadBuffer
HAL_StatusTypeDef HAL_NOR_ReadBuffer(NOR_HandleTypeDef *hnor, uint32_t uwAddress, uint16_t *pData, uint32_t uwBufferSize)
HAL_NOR_StateTypeDef
HAL_NOR_StateTypeDef
HAL SRAM State structures definition
Definition: stm32f7xx_hal_nor.h:48
NOR_IDTypeDef
FMC NOR ID typedef.
Definition: stm32f7xx_hal_nor.h:71
HAL_NOR_GetStatus
HAL_NOR_StatusTypeDef HAL_NOR_GetStatus(NOR_HandleTypeDef *hnor, uint32_t Address, uint32_t Timeout)
HAL_NOR_Erase_Chip
HAL_StatusTypeDef HAL_NOR_Erase_Chip(NOR_HandleTypeDef *hnor, uint32_t Address)
HAL_NOR_STATE_ERROR
@ HAL_NOR_STATE_ERROR
Definition: stm32f7xx_hal_nor.h:53
HAL_NOR_ProgramBuffer
HAL_StatusTypeDef HAL_NOR_ProgramBuffer(NOR_HandleTypeDef *hnor, uint32_t uwAddress, uint16_t *pData, uint32_t uwBufferSize)
HAL_NOR_Init
HAL_StatusTypeDef HAL_NOR_Init(NOR_HandleTypeDef *hnor, FMC_NORSRAM_TimingTypeDef *Timing, FMC_NORSRAM_TimingTypeDef *ExtTiming)
HAL_NOR_STATUS_ONGOING
@ HAL_NOR_STATUS_ONGOING
Definition: stm32f7xx_hal_nor.h:63
HAL_NOR_STATUS_TIMEOUT
@ HAL_NOR_STATUS_TIMEOUT
Definition: stm32f7xx_hal_nor.h:65
HAL_NOR_Program
HAL_StatusTypeDef HAL_NOR_Program(NOR_HandleTypeDef *hnor, uint32_t *pAddress, uint16_t *pData)
HAL_NOR_STATE_READY
@ HAL_NOR_STATE_READY
Definition: stm32f7xx_hal_nor.h:51
HAL_NOR_StatusTypeDef
HAL_NOR_StatusTypeDef
FMC NOR Status typedef.
Definition: stm32f7xx_hal_nor.h:60
HAL_NOR_WriteOperation_Enable
HAL_StatusTypeDef HAL_NOR_WriteOperation_Enable(NOR_HandleTypeDef *hnor)
HAL_NOR_MspInit
void HAL_NOR_MspInit(NOR_HandleTypeDef *hnor)
HAL_NOR_ReturnToReadMode
HAL_StatusTypeDef HAL_NOR_ReturnToReadMode(NOR_HandleTypeDef *hnor)
HAL_NOR_WriteOperation_Disable
HAL_StatusTypeDef HAL_NOR_WriteOperation_Disable(NOR_HandleTypeDef *hnor)
HAL_NOR_Read_CFI
HAL_StatusTypeDef HAL_NOR_Read_CFI(NOR_HandleTypeDef *hnor, NOR_CFITypeDef *pNOR_CFI)
FMC_NORSRAM_InitTypeDef
FMC NORSRAM Configuration Structure definition.
Definition: stm32f7xx_ll_fmc.h:396
HAL_NOR_STATUS_SUCCESS
@ HAL_NOR_STATUS_SUCCESS
Definition: stm32f7xx_hal_nor.h:62
FMC_NORSRAM_EXTENDED_TypeDef
#define FMC_NORSRAM_EXTENDED_TypeDef
Definition: stm32f7xx_ll_fmc.h:384
HAL_NOR_Read
HAL_StatusTypeDef HAL_NOR_Read(NOR_HandleTypeDef *hnor, uint32_t *pAddress, uint16_t *pData)
HAL_NOR_STATUS_ERROR
@ HAL_NOR_STATUS_ERROR
Definition: stm32f7xx_hal_nor.h:64
HAL_NOR_MspWait
void HAL_NOR_MspWait(NOR_HandleTypeDef *hnor, uint32_t Timeout)
HAL_NOR_GetState
HAL_NOR_StateTypeDef HAL_NOR_GetState(NOR_HandleTypeDef *hnor)
HAL_NOR_MspDeInit
void HAL_NOR_MspDeInit(NOR_HandleTypeDef *hnor)
HAL_NOR_STATE_RESET
@ HAL_NOR_STATE_RESET
Definition: stm32f7xx_hal_nor.h:50
HAL_NOR_STATE_BUSY
@ HAL_NOR_STATE_BUSY
Definition: stm32f7xx_hal_nor.h:52

picovoice_driver
Author(s):
autogenerated on Fri Apr 1 2022 02:14:52