Blame view

mbed/TARGET_NUCLEO_F401RE/stm32f4xx_hal_flash.h 15.5 KB
f7c9a8e1   jdenecha   Feat : Firt dump
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
  /**
    ******************************************************************************
    * @file    stm32f4xx_hal_flash.h
    * @author  MCD Application Team
    * @version V1.4.1
    * @date    09-October-2015
    * @brief   Header file of FLASH HAL module.
    ******************************************************************************
    * @attention
    *
    * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
    *
    * Redistribution and use in source and binary forms, with or without modification,
    * are permitted provided that the following conditions are met:
    *   1. Redistributions of source code must retain the above copyright notice,
    *      this list of conditions and the following disclaimer.
    *   2. Redistributions in binary form must reproduce the above copyright notice,
    *      this list of conditions and the following disclaimer in the documentation
    *      and/or other materials provided with the distribution.
    *   3. Neither the name of STMicroelectronics nor the names of its contributors
    *      may be used to endorse or promote products derived from this software
    *      without specific prior written permission.
    *
    * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
    * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
    * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
    * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
    * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
    * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
    * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
    * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
    * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    *
    ******************************************************************************
    */ 
  
  /* Define to prevent recursive inclusion -------------------------------------*/
  #ifndef __STM32F4xx_HAL_FLASH_H
  #define __STM32F4xx_HAL_FLASH_H
  
  #ifdef __cplusplus
   extern "C" {
  #endif
  
  /* Includes ------------------------------------------------------------------*/
  #include "stm32f4xx_hal_def.h"
  
  /** @addtogroup STM32F4xx_HAL_Driver
    * @{
    */
  
  /** @addtogroup FLASH
    * @{
    */ 
  
  /* Exported types ------------------------------------------------------------*/
  /** @defgroup FLASH_Exported_Types FLASH Exported Types
    * @{
    */
   
  /**
    * @brief  FLASH Procedure structure definition
    */
  typedef enum 
  {
    FLASH_PROC_NONE = 0, 
    FLASH_PROC_SECTERASE,
    FLASH_PROC_MASSERASE,
    FLASH_PROC_PROGRAM
  } FLASH_ProcedureTypeDef;
  
  /** 
    * @brief  FLASH handle Structure definition  
    */
  typedef struct
  {
    __IO FLASH_ProcedureTypeDef ProcedureOnGoing;   /*Internal variable to indicate which procedure is ongoing or not in IT context*/
    
    __IO uint32_t               NbSectorsToErase;   /*Internal variable to save the remaining sectors to erase in IT context*/
    
    __IO uint8_t                VoltageForErase;    /*Internal variable to provide voltage range selected by user in IT context*/
    
    __IO uint32_t               Sector;             /*Internal variable to define the current sector which is erasing*/
    
    __IO uint32_t               Bank;               /*Internal variable to save current bank selected during mass erase*/
    
    __IO uint32_t               Address;            /*Internal variable to save address selected for program*/
    
    HAL_LockTypeDef             Lock;               /* FLASH locking object                */
  
    __IO uint32_t               ErrorCode;          /* FLASH error code                    */
  
  }FLASH_ProcessTypeDef;
  
  /**
    * @}
    */
  
  /* Exported constants --------------------------------------------------------*/
  /** @defgroup FLASH_Exported_Constants FLASH Exported Constants
    * @{
    */  
  /** @defgroup FLASH_Error_Code FLASH Error Code
    * @brief    FLASH Error Code 
    * @{
    */ 
  #define HAL_FLASH_ERROR_NONE         ((uint32_t)0x00000000)    /*!< No error                      */
  #define HAL_FLASH_ERROR_RD           ((uint32_t)0x00000001)    /*!< Read Protection error         */
  #define HAL_FLASH_ERROR_PGS          ((uint32_t)0x00000002)    /*!< Programming Sequence error    */
  #define HAL_FLASH_ERROR_PGP          ((uint32_t)0x00000004)    /*!< Programming Parallelism error */
  #define HAL_FLASH_ERROR_PGA          ((uint32_t)0x00000008)    /*!< Programming Alignment error   */
  #define HAL_FLASH_ERROR_WRP          ((uint32_t)0x00000010)    /*!< Write protection error        */
  #define HAL_FLASH_ERROR_OPERATION    ((uint32_t)0x00000020)    /*!< Operation Error               */
  /**
    * @}
    */
    
  /** @defgroup FLASH_Type_Program FLASH Type Program
    * @{
    */ 
  #define FLASH_TYPEPROGRAM_BYTE        ((uint32_t)0x00)  /*!< Program byte (8-bit) at a specified address           */
  #define FLASH_TYPEPROGRAM_HALFWORD    ((uint32_t)0x01)  /*!< Program a half-word (16-bit) at a specified address   */
  #define FLASH_TYPEPROGRAM_WORD        ((uint32_t)0x02)  /*!< Program a word (32-bit) at a specified address        */
  #define FLASH_TYPEPROGRAM_DOUBLEWORD  ((uint32_t)0x03)  /*!< Program a double word (64-bit) at a specified address */
  /**
    * @}
    */
  
  /** @defgroup FLASH_Flag_definition FLASH Flag definition
    * @brief Flag definition
    * @{
    */ 
  #define FLASH_FLAG_EOP                 FLASH_SR_EOP            /*!< FLASH End of Operation flag               */
  #define FLASH_FLAG_OPERR               FLASH_SR_SOP            /*!< FLASH operation Error flag                */
  #define FLASH_FLAG_WRPERR              FLASH_SR_WRPERR         /*!< FLASH Write protected error flag          */
  #define FLASH_FLAG_PGAERR              FLASH_SR_PGAERR         /*!< FLASH Programming Alignment error flag    */
  #define FLASH_FLAG_PGPERR              FLASH_SR_PGPERR         /*!< FLASH Programming Parallelism error flag  */
  #define FLASH_FLAG_PGSERR              FLASH_SR_PGSERR         /*!< FLASH Programming Sequence error flag     */
  #define FLASH_FLAG_RDERR               ((uint32_t)0x00000100)  /*!< Read Protection error flag (PCROP)        */
  #define FLASH_FLAG_BSY                 FLASH_SR_BSY            /*!< FLASH Busy flag                           */ 
  /**
    * @}
    */
    
  /** @defgroup FLASH_Interrupt_definition FLASH Interrupt definition
    * @brief FLASH Interrupt definition
    * @{
    */ 
  #define FLASH_IT_EOP                   FLASH_CR_EOPIE          /*!< End of FLASH Operation Interrupt source */
  #define FLASH_IT_ERR                   ((uint32_t)0x02000000)  /*!< Error Interrupt source                  */
  /**
    * @}
    */  
  
  /** @defgroup FLASH_Program_Parallelism FLASH Program Parallelism
    * @{
    */
  #define FLASH_PSIZE_BYTE           ((uint32_t)0x00000000)
  #define FLASH_PSIZE_HALF_WORD      ((uint32_t)0x00000100)
  #define FLASH_PSIZE_WORD           ((uint32_t)0x00000200)
  #define FLASH_PSIZE_DOUBLE_WORD    ((uint32_t)0x00000300)
  #define CR_PSIZE_MASK              ((uint32_t)0xFFFFFCFF)
  /**
    * @}
    */ 
  
  /** @defgroup FLASH_Keys FLASH Keys
    * @{
    */ 
  #define RDP_KEY                  ((uint16_t)0x00A5)
  #define FLASH_KEY1               ((uint32_t)0x45670123)
  #define FLASH_KEY2               ((uint32_t)0xCDEF89AB)
  #define FLASH_OPT_KEY1           ((uint32_t)0x08192A3B)
  #define FLASH_OPT_KEY2           ((uint32_t)0x4C5D6E7F)
  /**
    * @}
    */ 
  
  /**
    * @}
    */ 
    
  /* Exported macro ------------------------------------------------------------*/
  /** @defgroup FLASH_Exported_Macros FLASH Exported Macros
    * @{
    */
  /**
    * @brief  Set the FLASH Latency.
    * @param  __LATENCY__: FLASH Latency
    *         The value of this parameter depend on device used within the same series
    * @retval none
    */ 
  #define __HAL_FLASH_SET_LATENCY(__LATENCY__) (*(__IO uint8_t *)ACR_BYTE0_ADDRESS = (uint8_t)(__LATENCY__))
  
  /**
    * @brief  Get the FLASH Latency.
    * @retval FLASH Latency
    *          The value of this parameter depend on device used within the same series
    */ 
  #define __HAL_FLASH_GET_LATENCY()     (READ_BIT((FLASH->ACR), FLASH_ACR_LATENCY))
  
  /**
    * @brief  Enable the FLASH prefetch buffer.
    * @retval none
    */ 
  #define __HAL_FLASH_PREFETCH_BUFFER_ENABLE()  (FLASH->ACR |= FLASH_ACR_PRFTEN)
  
  /**
    * @brief  Disable the FLASH prefetch buffer.
    * @retval none
    */ 
  #define __HAL_FLASH_PREFETCH_BUFFER_DISABLE()   (FLASH->ACR &= (~FLASH_ACR_PRFTEN))
  
  /**
    * @brief  Enable the FLASH instruction cache.
    * @retval none
    */ 
  #define __HAL_FLASH_INSTRUCTION_CACHE_ENABLE()  (FLASH->ACR |= FLASH_ACR_ICEN)
  
  /**
    * @brief  Disable the FLASH instruction cache.
    * @retval none
    */ 
  #define __HAL_FLASH_INSTRUCTION_CACHE_DISABLE()   (FLASH->ACR &= (~FLASH_ACR_ICEN))
  
  /**
    * @brief  Enable the FLASH data cache.
    * @retval none
    */ 
  #define __HAL_FLASH_DATA_CACHE_ENABLE()  (FLASH->ACR |= FLASH_ACR_DCEN)
  
  /**
    * @brief  Disable the FLASH data cache.
    * @retval none
    */ 
  #define __HAL_FLASH_DATA_CACHE_DISABLE()   (FLASH->ACR &= (~FLASH_ACR_DCEN))
  
  /**
    * @brief  Resets the FLASH instruction Cache.
    * @note   This function must be used only when the Instruction Cache is disabled.  
    * @retval None
    */
  #define __HAL_FLASH_INSTRUCTION_CACHE_RESET() do {FLASH->ACR |= FLASH_ACR_ICRST;  \
                                                    FLASH->ACR &= ~FLASH_ACR_ICRST; \
                                                   }while(0)
  
  /**
    * @brief  Resets the FLASH data Cache.
    * @note   This function must be used only when the data Cache is disabled.  
    * @retval None
    */
  #define __HAL_FLASH_DATA_CACHE_RESET() do {FLASH->ACR |= FLASH_ACR_DCRST;  \
                                             FLASH->ACR &= ~FLASH_ACR_DCRST; \
                                            }while(0)
  /**
    * @brief  Enable the specified FLASH interrupt.
    * @param  __INTERRUPT__ : FLASH interrupt 
    *         This parameter can be any combination of the following values:
    *     @arg FLASH_IT_EOP: End of FLASH Operation Interrupt
    *     @arg FLASH_IT_ERR: Error Interrupt    
    * @retval none
    */  
  #define __HAL_FLASH_ENABLE_IT(__INTERRUPT__)  (FLASH->CR |= (__INTERRUPT__))
  
  /**
    * @brief  Disable the specified FLASH interrupt.
    * @param  __INTERRUPT__ : FLASH interrupt 
    *         This parameter can be any combination of the following values:
    *     @arg FLASH_IT_EOP: End of FLASH Operation Interrupt
    *     @arg FLASH_IT_ERR: Error Interrupt    
    * @retval none
    */  
  #define __HAL_FLASH_DISABLE_IT(__INTERRUPT__)  (FLASH->CR &= ~(uint32_t)(__INTERRUPT__))
  
  /**
    * @brief  Get the specified FLASH flag status. 
    * @param  __FLAG__: specifies the FLASH flag to check.
    *          This parameter can be one of the following values:
    *            @arg FLASH_FLAG_EOP   : FLASH End of Operation flag 
    *            @arg FLASH_FLAG_OPERR : FLASH operation Error flag 
    *            @arg FLASH_FLAG_WRPERR: FLASH Write protected error flag 
    *            @arg FLASH_FLAG_PGAERR: FLASH Programming Alignment error flag
    *            @arg FLASH_FLAG_PGPERR: FLASH Programming Parallelism error flag
    *            @arg FLASH_FLAG_PGSERR: FLASH Programming Sequence error flag
    *            @arg FLASH_FLAG_RDERR : FLASH Read Protection error flag (PCROP) 
    *            @arg FLASH_FLAG_BSY   : FLASH Busy flag
    * @retval The new state of __FLAG__ (SET or RESET).
    */
  #define __HAL_FLASH_GET_FLAG(__FLAG__)   ((FLASH->SR & (__FLAG__)))
  
  /**
    * @brief  Clear the specified FLASH flag.
    * @param  __FLAG__: specifies the FLASH flags to clear.
    *          This parameter can be any combination of the following values:
    *            @arg FLASH_FLAG_EOP   : FLASH End of Operation flag 
    *            @arg FLASH_FLAG_OPERR : FLASH operation Error flag 
    *            @arg FLASH_FLAG_WRPERR: FLASH Write protected error flag 
    *            @arg FLASH_FLAG_PGAERR: FLASH Programming Alignment error flag 
    *            @arg FLASH_FLAG_PGPERR: FLASH Programming Parallelism error flag
    *            @arg FLASH_FLAG_PGSERR: FLASH Programming Sequence error flag
    *            @arg FLASH_FLAG_RDERR : FLASH Read Protection error flag (PCROP)   
    * @retval none
    */
  #define __HAL_FLASH_CLEAR_FLAG(__FLAG__)   (FLASH->SR = (__FLAG__))
  /**
    * @}
    */
  
  /* Include FLASH HAL Extension module */
  #include "stm32f4xx_hal_flash_ex.h"
  #include "stm32f4xx_hal_flash_ramfunc.h"
  
  /* Exported functions --------------------------------------------------------*/
  /** @addtogroup FLASH_Exported_Functions
    * @{
    */
  /** @addtogroup FLASH_Exported_Functions_Group1
    * @{
    */
  /* Program operation functions  ***********************************************/
  HAL_StatusTypeDef HAL_FLASH_Program(uint32_t TypeProgram, uint32_t Address, uint64_t Data);
  HAL_StatusTypeDef HAL_FLASH_Program_IT(uint32_t TypeProgram, uint32_t Address, uint64_t Data);
  /* FLASH IRQ handler method */
  void HAL_FLASH_IRQHandler(void);
  /* Callbacks in non blocking modes */ 
  void HAL_FLASH_EndOfOperationCallback(uint32_t ReturnValue);
  void HAL_FLASH_OperationErrorCallback(uint32_t ReturnValue);
  /**
    * @}
    */
  
  /** @addtogroup FLASH_Exported_Functions_Group2
    * @{
    */
  /* Peripheral Control functions  **********************************************/
  HAL_StatusTypeDef HAL_FLASH_Unlock(void);
  HAL_StatusTypeDef HAL_FLASH_Lock(void);
  HAL_StatusTypeDef HAL_FLASH_OB_Unlock(void);
  HAL_StatusTypeDef HAL_FLASH_OB_Lock(void);
  /* Option bytes control */
  HAL_StatusTypeDef HAL_FLASH_OB_Launch(void);
  /**
    * @}
    */
  
  /** @addtogroup FLASH_Exported_Functions_Group3
    * @{
    */
  /* Peripheral State functions  ************************************************/
  uint32_t HAL_FLASH_GetError(void);
  HAL_StatusTypeDef FLASH_WaitForLastOperation(uint32_t Timeout);
  /**
    * @}
    */
  
  /**
    * @}
    */ 
  /* Private types -------------------------------------------------------------*/
  /* Private variables ---------------------------------------------------------*/
  /** @defgroup FLASH_Private_Variables FLASH Private Variables
    * @{
    */
  
  /**
    * @}
    */
  /* Private constants ---------------------------------------------------------*/
  /** @defgroup FLASH_Private_Constants FLASH Private Constants
    * @{
    */
  
  /** 
    * @brief   ACR register byte 0 (Bits[7:0]) base address  
    */ 
  #define ACR_BYTE0_ADDRESS           ((uint32_t)0x40023C00) 
  /** 
    * @brief   OPTCR register byte 0 (Bits[7:0]) base address  
    */ 
  #define OPTCR_BYTE0_ADDRESS         ((uint32_t)0x40023C14)
  /** 
    * @brief   OPTCR register byte 1 (Bits[15:8]) base address  
    */ 
  #define OPTCR_BYTE1_ADDRESS         ((uint32_t)0x40023C15)
  /** 
    * @brief   OPTCR register byte 2 (Bits[23:16]) base address  
    */ 
  #define OPTCR_BYTE2_ADDRESS         ((uint32_t)0x40023C16)
  /** 
    * @brief   OPTCR register byte 3 (Bits[31:24]) base address  
    */ 
  #define OPTCR_BYTE3_ADDRESS         ((uint32_t)0x40023C17)
  
  /**
    * @}
    */
  
  /* Private macros ------------------------------------------------------------*/
  /** @defgroup FLASH_Private_Macros FLASH Private Macros
    * @{
    */
  
  /** @defgroup FLASH_IS_FLASH_Definitions FLASH Private macros to check input parameters
    * @{
    */
  #define IS_FLASH_TYPEPROGRAM(VALUE)(((VALUE) == FLASH_TYPEPROGRAM_BYTE) || \
                                      ((VALUE) == FLASH_TYPEPROGRAM_HALFWORD) || \
                                      ((VALUE) == FLASH_TYPEPROGRAM_WORD) || \
                                      ((VALUE) == FLASH_TYPEPROGRAM_DOUBLEWORD))  
  /**
    * @}
    */
  
  /**
    * @}
    */
  
  /* Private functions ---------------------------------------------------------*/
  /** @defgroup FLASH_Private_Functions FLASH Private Functions
    * @{
    */
  
  /**
    * @}
    */
  
  /**
    * @}
    */ 
  
  /**
    * @}
    */
  
  #ifdef __cplusplus
  }
  #endif
  
  #endif /* __STM32F4xx_HAL_FLASH_H */
  
  /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/