source: asp3_wo_tecs/trunk/arch/arm_m_gcc/stm32f4xx_stm32cube/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_flash.h@ 303

Last change on this file since 303 was 303, checked in by ertl-honda, 7 years ago

nucleo_f401re依存部の追加

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