2 ******************************************************************************
3 * @file stm32f7xx_hal_flash.h
4 * @author MCD Application Team
7 * @brief Header file of FLASH HAL module.
8 ******************************************************************************
11 * <h2><center>© COPYRIGHT(c) 2016 STMicroelectronics</center></h2>
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.
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.
35 ******************************************************************************
38 /* Define to prevent recursive inclusion -------------------------------------*/
39 #ifndef __STM32F7xx_HAL_FLASH_H
40 #define __STM32F7xx_HAL_FLASH_H
46 /* Includes ------------------------------------------------------------------*/
47 #include "stm32f7xx_hal_def.h"
49 /** @addtogroup STM32F7xx_HAL_Driver
57 /* Exported types ------------------------------------------------------------*/
58 /** @defgroup FLASH_Exported_Types FLASH Exported Types
63 * @brief FLASH Procedure structure definition
71 } FLASH_ProcedureTypeDef
;
75 * @brief FLASH handle Structure definition
79 __IO FLASH_ProcedureTypeDef ProcedureOnGoing
; /* Internal variable to indicate which procedure is ongoing or not in IT context */
81 __IO
uint32_t NbSectorsToErase
; /* Internal variable to save the remaining sectors to erase in IT context */
83 __IO
uint8_t VoltageForErase
; /* Internal variable to provide voltage range selected by user in IT context */
85 __IO
uint32_t Sector
; /* Internal variable to define the current sector which is erasing */
87 __IO
uint32_t Address
; /* Internal variable to save address selected for program */
89 HAL_LockTypeDef Lock
; /* FLASH locking object */
91 __IO
uint32_t ErrorCode
; /* FLASH error code */
93 }FLASH_ProcessTypeDef
;
99 /* Exported constants --------------------------------------------------------*/
100 /** @defgroup FLASH_Exported_Constants FLASH Exported Constants
104 /** @defgroup FLASH_Error_Code FLASH Error Code
105 * @brief FLASH Error Code
108 #define HAL_FLASH_ERROR_NONE ((uint32_t)0x00000000U) /*!< No error */
109 #define HAL_FLASH_ERROR_ERS ((uint32_t)0x00000002U) /*!< Programming Sequence error */
110 #define HAL_FLASH_ERROR_PGP ((uint32_t)0x00000004U) /*!< Programming Parallelism error */
111 #define HAL_FLASH_ERROR_PGA ((uint32_t)0x00000008U) /*!< Programming Alignment error */
112 #define HAL_FLASH_ERROR_WRP ((uint32_t)0x00000010U) /*!< Write protection error */
113 #define HAL_FLASH_ERROR_OPERATION ((uint32_t)0x00000020U) /*!< Operation Error */
118 /** @defgroup FLASH_Type_Program FLASH Type Program
121 #define FLASH_TYPEPROGRAM_BYTE ((uint32_t)0x00U) /*!< Program byte (8-bit) at a specified address */
122 #define FLASH_TYPEPROGRAM_HALFWORD ((uint32_t)0x01U) /*!< Program a half-word (16-bit) at a specified address */
123 #define FLASH_TYPEPROGRAM_WORD ((uint32_t)0x02U) /*!< Program a word (32-bit) at a specified address */
124 #define FLASH_TYPEPROGRAM_DOUBLEWORD ((uint32_t)0x03U) /*!< Program a double word (64-bit) at a specified address */
129 /** @defgroup FLASH_Flag_definition FLASH Flag definition
130 * @brief Flag definition
133 #define FLASH_FLAG_EOP FLASH_SR_EOP /*!< FLASH End of Operation flag */
134 #define FLASH_FLAG_OPERR FLASH_SR_OPERR /*!< FLASH operation Error flag */
135 #define FLASH_FLAG_WRPERR FLASH_SR_WRPERR /*!< FLASH Write protected error flag */
136 #define FLASH_FLAG_PGAERR FLASH_SR_PGAERR /*!< FLASH Programming Alignment error flag */
137 #define FLASH_FLAG_PGPERR FLASH_SR_PGPERR /*!< FLASH Programming Parallelism error flag */
138 #define FLASH_FLAG_ERSERR FLASH_SR_ERSERR /*!< FLASH Erasing Sequence error flag */
139 #define FLASH_FLAG_BSY FLASH_SR_BSY /*!< FLASH Busy flag */
144 /** @defgroup FLASH_Interrupt_definition FLASH Interrupt definition
145 * @brief FLASH Interrupt definition
148 #define FLASH_IT_EOP FLASH_CR_EOPIE /*!< End of FLASH Operation Interrupt source */
149 #define FLASH_IT_ERR ((uint32_t)0x02000000U) /*!< Error Interrupt source */
154 /** @defgroup FLASH_Program_Parallelism FLASH Program Parallelism
157 #define FLASH_PSIZE_BYTE ((uint32_t)0x00000000U)
158 #define FLASH_PSIZE_HALF_WORD ((uint32_t)FLASH_CR_PSIZE_0)
159 #define FLASH_PSIZE_WORD ((uint32_t)FLASH_CR_PSIZE_1)
160 #define FLASH_PSIZE_DOUBLE_WORD ((uint32_t)FLASH_CR_PSIZE)
161 #define CR_PSIZE_MASK ((uint32_t)0xFFFFFCFFU)
166 /** @defgroup FLASH_Keys FLASH Keys
169 #define FLASH_KEY1 ((uint32_t)0x45670123U)
170 #define FLASH_KEY2 ((uint32_t)0xCDEF89ABU)
171 #define FLASH_OPT_KEY1 ((uint32_t)0x08192A3BU)
172 #define FLASH_OPT_KEY2 ((uint32_t)0x4C5D6E7FU)
177 /** @defgroup FLASH_Sectors FLASH Sectors
180 #define FLASH_SECTOR_0 ((uint32_t)0U) /*!< Sector Number 0 */
181 #define FLASH_SECTOR_1 ((uint32_t)1U) /*!< Sector Number 1 */
182 #define FLASH_SECTOR_2 ((uint32_t)2U) /*!< Sector Number 2 */
183 #define FLASH_SECTOR_3 ((uint32_t)3U) /*!< Sector Number 3 */
184 #define FLASH_SECTOR_4 ((uint32_t)4U) /*!< Sector Number 4 */
185 #define FLASH_SECTOR_5 ((uint32_t)5U) /*!< Sector Number 5 */
186 #define FLASH_SECTOR_6 ((uint32_t)6U) /*!< Sector Number 6 */
187 #define FLASH_SECTOR_7 ((uint32_t)7U) /*!< Sector Number 7 */
196 /* Exported macro ------------------------------------------------------------*/
197 /** @defgroup FLASH_Exported_Macros FLASH Exported Macros
201 * @brief Set the FLASH Latency.
202 * @param __LATENCY__: FLASH Latency
203 * The value of this parameter depend on device used within the same series
206 #define __HAL_FLASH_SET_LATENCY(__LATENCY__) \
207 MODIFY_REG(FLASH->ACR, FLASH_ACR_LATENCY, (uint32_t)(__LATENCY__))
210 * @brief Get the FLASH Latency.
211 * @retval FLASH Latency
212 * The value of this parameter depend on device used within the same series
214 #define __HAL_FLASH_GET_LATENCY() (READ_BIT((FLASH->ACR), FLASH_ACR_LATENCY))
217 * @brief Enable the FLASH prefetch buffer.
220 #define __HAL_FLASH_PREFETCH_BUFFER_ENABLE() (FLASH->ACR |= FLASH_ACR_PRFTEN)
223 * @brief Disable the FLASH prefetch buffer.
226 #define __HAL_FLASH_PREFETCH_BUFFER_DISABLE() (FLASH->ACR &= (~FLASH_ACR_PRFTEN))
229 * @brief Enable the FLASH Adaptive Real-Time memory accelerator.
230 * @note The ART accelerator is available only for flash access on ITCM interface.
233 #define __HAL_FLASH_ART_ENABLE() SET_BIT(FLASH->ACR, FLASH_ACR_ARTEN)
236 * @brief Disable the FLASH Adaptive Real-Time memory accelerator.
239 #define __HAL_FLASH_ART_DISABLE() CLEAR_BIT(FLASH->ACR, FLASH_ACR_ARTEN)
242 * @brief Resets the FLASH Adaptive Real-Time memory accelerator.
243 * @note This function must be used only when the Adaptive Real-Time memory accelerator
247 #define __HAL_FLASH_ART_RESET() (FLASH->ACR |= FLASH_ACR_ARTRST)
250 * @brief Enable the specified FLASH interrupt.
251 * @param __INTERRUPT__ : FLASH interrupt
252 * This parameter can be any combination of the following values:
253 * @arg FLASH_IT_EOP: End of FLASH Operation Interrupt
254 * @arg FLASH_IT_ERR: Error Interrupt
257 #define __HAL_FLASH_ENABLE_IT(__INTERRUPT__) (FLASH->CR |= (__INTERRUPT__))
260 * @brief Disable the specified FLASH interrupt.
261 * @param __INTERRUPT__ : FLASH interrupt
262 * This parameter can be any combination of the following values:
263 * @arg FLASH_IT_EOP: End of FLASH Operation Interrupt
264 * @arg FLASH_IT_ERR: Error Interrupt
267 #define __HAL_FLASH_DISABLE_IT(__INTERRUPT__) (FLASH->CR &= ~(uint32_t)(__INTERRUPT__))
270 * @brief Get the specified FLASH flag status.
271 * @param __FLAG__: specifies the FLASH flag to check.
272 * This parameter can be one of the following values:
273 * @arg FLASH_FLAG_EOP : FLASH End of Operation flag
274 * @arg FLASH_FLAG_OPERR : FLASH operation Error flag
275 * @arg FLASH_FLAG_WRPERR: FLASH Write protected error flag
276 * @arg FLASH_FLAG_PGAERR: FLASH Programming Alignment error flag
277 * @arg FLASH_FLAG_PGPERR: FLASH Programming Parallelism error flag
278 * @arg FLASH_FLAG_ERSERR : FLASH Erasing Sequence error flag
279 * @arg FLASH_FLAG_BSY : FLASH Busy flag
280 * @retval The new state of __FLAG__ (SET or RESET).
282 #define __HAL_FLASH_GET_FLAG(__FLAG__) ((FLASH->SR & (__FLAG__)))
285 * @brief Clear the specified FLASH flag.
286 * @param __FLAG__: specifies the FLASH flags to clear.
287 * This parameter can be any combination of the following values:
288 * @arg FLASH_FLAG_EOP : FLASH End of Operation flag
289 * @arg FLASH_FLAG_OPERR : FLASH operation Error flag
290 * @arg FLASH_FLAG_WRPERR: FLASH Write protected error flag
291 * @arg FLASH_FLAG_PGAERR: FLASH Programming Alignment error flag
292 * @arg FLASH_FLAG_PGPERR: FLASH Programming Parallelism error flag
293 * @arg FLASH_FLAG_ERSERR : FLASH Erasing Sequence error flag
296 #define __HAL_FLASH_CLEAR_FLAG(__FLAG__) (FLASH->SR = (__FLAG__))
301 /* Include FLASH HAL Extension module */
302 #include "stm32f7xx_hal_flash_ex.h"
304 /* Exported functions --------------------------------------------------------*/
305 /** @addtogroup FLASH_Exported_Functions
308 /** @addtogroup FLASH_Exported_Functions_Group1
311 /* Program operation functions ***********************************************/
312 HAL_StatusTypeDef
HAL_FLASH_Program(uint32_t TypeProgram
, uint32_t Address
, uint64_t Data
);
313 HAL_StatusTypeDef
HAL_FLASH_Program_IT(uint32_t TypeProgram
, uint32_t Address
, uint64_t Data
);
314 /* FLASH IRQ handler method */
315 void HAL_FLASH_IRQHandler(void);
316 /* Callbacks in non blocking modes */
317 void HAL_FLASH_EndOfOperationCallback(uint32_t ReturnValue
);
318 void HAL_FLASH_OperationErrorCallback(uint32_t ReturnValue
);
323 /** @addtogroup FLASH_Exported_Functions_Group2
326 /* Peripheral Control functions **********************************************/
327 HAL_StatusTypeDef
HAL_FLASH_Unlock(void);
328 HAL_StatusTypeDef
HAL_FLASH_Lock(void);
329 HAL_StatusTypeDef
HAL_FLASH_OB_Unlock(void);
330 HAL_StatusTypeDef
HAL_FLASH_OB_Lock(void);
331 /* Option bytes control */
332 HAL_StatusTypeDef
HAL_FLASH_OB_Launch(void);
337 /** @addtogroup FLASH_Exported_Functions_Group3
340 /* Peripheral State functions ************************************************/
341 uint32_t HAL_FLASH_GetError(void);
342 HAL_StatusTypeDef
FLASH_WaitForLastOperation(uint32_t Timeout
);
350 /* Private types -------------------------------------------------------------*/
351 /* Private variables ---------------------------------------------------------*/
352 /** @defgroup FLASH_Private_Variables FLASH Private Variables
359 /* Private constants ---------------------------------------------------------*/
360 /** @defgroup FLASH_Private_Constants FLASH Private Constants
365 * @brief OPTCR register byte 1 (Bits[15:8]) base address
367 #define OPTCR_BYTE1_ADDRESS ((uint32_t)0x40023C15)
373 /* Private macros ------------------------------------------------------------*/
374 /** @defgroup FLASH_Private_Macros FLASH Private Macros
378 /** @defgroup FLASH_IS_FLASH_Definitions FLASH Private macros to check input parameters
381 #define IS_FLASH_TYPEPROGRAM(VALUE)(((VALUE) == FLASH_TYPEPROGRAM_BYTE) || \
382 ((VALUE) == FLASH_TYPEPROGRAM_HALFWORD) || \
383 ((VALUE) == FLASH_TYPEPROGRAM_WORD) || \
384 ((VALUE) == FLASH_TYPEPROGRAM_DOUBLEWORD))
393 /* Private functions ---------------------------------------------------------*/
394 /** @defgroup FLASH_Private_Functions FLASH Private Functions
414 #endif /* __STM32F7xx_HAL_FLASH_H */
416 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/