2 ******************************************************************************
3 * @file stm32l1xx_hal_flash.h
4 * @author MCD Application Team
6 * @date 5-September-2014
7 * @brief Header file of Flash HAL module.
8 ******************************************************************************
11 * <h2><center>© COPYRIGHT(c) 2014 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 __STM32L1xx_HAL_FLASH_H
40 #define __STM32L1xx_HAL_FLASH_H
46 /* Includes ------------------------------------------------------------------*/
47 #include "stm32l1xx_hal_def.h"
49 /** @addtogroup STM32L1xx_HAL_Driver
57 /* Exported types ------------------------------------------------------------*/
59 /** @defgroup FLASH_Exported_Types FLASH Exported Types
64 * @brief FLASH Error structure definition
68 FLASH_ERROR_SIZE = 0x01,
69 FLASH_ERROR_OPTV = 0x02,
70 FLASH_ERROR_OPTVUSR = 0x04,
71 FLASH_ERROR_PGA = 0x08,
72 FLASH_ERROR_WRP = 0x10,
73 FLASH_ERROR_RD = 0x20,
74 FLASH_ERROR_OPERATION = 0x40
79 * @brief FLASH Procedure structure definition
86 } FLASH_ProcedureTypeDef;
89 * @brief FLASH handle Structure definition
93 __IO FLASH_ProcedureTypeDef ProcedureOnGoing; /*Internal variable to indicate which procedure is ongoing or not in IT context*/
95 __IO uint32_t NbPagesToErase; /*Internal variable to save the remaining sectors to erase in IT context*/
97 __IO uint32_t Page; /*Internal variable to define the current sector which is erasing*/
99 __IO uint32_t Address; /*Internal variable to save address selected for program*/
101 HAL_LockTypeDef Lock; /* FLASH locking object */
103 __IO FLASH_ErrorTypeDef ErrorCode; /* FLASH error code */
105 }FLASH_ProcessTypeDef;
111 /** @addtogroup FLASH_Internal_Variables
116 * @brief Variable used for Program/Erase sectors under interruption.
117 * Put as extern as used also in flash_ex.c.
119 extern FLASH_ProcessTypeDef ProcFlash;
125 /* Exported constants --------------------------------------------------------*/
127 /** @defgroup FLASH_Exported_Constants FLASH Exported Constants
131 #define HAL_FLASH_TIMEOUT_VALUE ((uint32_t)50000) /* 50 s */
133 #define FLASH_PAGE_SIZE ((uint32_t)256)
135 /** @defgroup FLASH_Type_Program FLASH Type Program
138 #define TYPEPROGRAM_WORD ((uint32_t)0x02) /*!< Program a word (32-bit) at a specified address */
140 #define IS_TYPEPROGRAMFLASH(_VALUE_) (((_VALUE_) == TYPEPROGRAM_WORD))
146 /** @defgroup FLASH_Latency FLASH Latency
149 #define FLASH_LATENCY_0 ((uint8_t)0x00) /*!< FLASH Zero Latency cycle */
150 #define FLASH_LATENCY_1 ((uint8_t)0x01) /*!< FLASH One Latency cycle */
152 #define IS_FLASH_LATENCY(__LATENCY__) (((__LATENCY__) == FLASH_LATENCY_0) || \
153 ((__LATENCY__) == FLASH_LATENCY_1))
158 /** @defgroup FLASH_Interrupts FLASH Interrupts
162 #define FLASH_IT_EOP FLASH_PECR_EOPIE /*!< End of programming interrupt source */
163 #define FLASH_IT_ERR FLASH_PECR_ERRIE /*!< Error interrupt source */
168 /** @defgroup FLASH_Flags FLASH Flags
172 #define FLASH_FLAG_BSY FLASH_SR_BSY /*!< FLASH Busy flag */
173 #define FLASH_FLAG_EOP FLASH_SR_EOP /*!< FLASH End of Programming flag */
174 #define FLASH_FLAG_ENDHV FLASH_SR_ENDHV /*!< FLASH End of High Voltage flag */
175 #define FLASH_FLAG_READY FLASH_SR_READY /*!< FLASH Ready flag after low power mode */
176 #define FLASH_FLAG_WRPERR FLASH_SR_WRPERR /*!< FLASH Write protected error flag */
177 #define FLASH_FLAG_PGAERR FLASH_SR_PGAERR /*!< FLASH Programming Alignment error flag */
178 #define FLASH_FLAG_SIZERR FLASH_SR_SIZERR /*!< FLASH Size error flag */
179 #define FLASH_FLAG_OPTVERR FLASH_SR_OPTVERR /*!< FLASH Option Validity error flag */
185 /** @defgroup FLASH_Keys FLASH Keys
189 #define FLASH_PDKEY1 ((uint32_t)0x04152637) /*!< Flash power down key1 */
190 #define FLASH_PDKEY2 ((uint32_t)0xFAFBFCFD) /*!< Flash power down key2: used with FLASH_PDKEY1
191 to unlock the RUN_PD bit in FLASH_ACR */
193 #define FLASH_PEKEY1 ((uint32_t)0x89ABCDEF) /*!< Flash program erase key1 */
194 #define FLASH_PEKEY2 ((uint32_t)0x02030405) /*!< Flash program erase key: used with FLASH_PEKEY2
195 to unlock the write access to the FLASH_PECR register and
198 #define FLASH_PRGKEY1 ((uint32_t)0x8C9DAEBF) /*!< Flash program memory key1 */
199 #define FLASH_PRGKEY2 ((uint32_t)0x13141516) /*!< Flash program memory key2: used with FLASH_PRGKEY2
200 to unlock the program memory */
202 #define FLASH_OPTKEY1 ((uint32_t)0xFBEAD9C8) /*!< Flash option key1 */
203 #define FLASH_OPTKEY2 ((uint32_t)0x24252627) /*!< Flash option key2: used with FLASH_OPTKEY1 to
204 unlock the write access to the option byte block */
211 #if defined ( __ICCARM__ )
212 #define InterruptType_ACTLR_DISMCYCINT_Msk IntType_ACTLR_DISMCYCINT_Msk
219 /* Exported macro ------------------------------------------------------------*/
221 /** @defgroup FLASH_Exported_Macros FLASH Exported Macros
225 /** @defgroup FLASH_Interrupt FLASH Interrupts
226 * @brief macros to handle FLASH interrupts
231 * @brief Enable the specified FLASH interrupt.
232 * @param __INTERRUPT__ : FLASH interrupt
233 * This parameter can be any combination of the following values:
234 * @arg FLASH_IT_EOP: End of FLASH Operation Interrupt
235 * @arg FLASH_IT_ERR: Error Interrupt
238 #define __HAL_FLASH_ENABLE_IT(__INTERRUPT__) ((FLASH->PECR) |= (__INTERRUPT__))
241 * @brief Disable the specified FLASH interrupt.
242 * @param __INTERRUPT__ : FLASH interrupt
243 * This parameter can be any combination of the following values:
244 * @arg FLASH_IT_EOP: End of FLASH Operation Interrupt
245 * @arg FLASH_IT_ERR: Error Interrupt
248 #define __HAL_FLASH_DISABLE_IT(__INTERRUPT__) ((FLASH->PECR) &= ~(uint32_t)(__INTERRUPT__))
251 * @brief Get the specified FLASH flag status.
252 * @param __FLAG__: specifies the FLASH flag to check.
253 * This parameter can be one of the following values:
254 * @arg FLASH_FLAG_BSY : FLASH Busy flag
255 * @arg FLASH_FLAG_EOP : FLASH End of Operation flag
256 * @arg FLASH_FLAG_ENDHV : FLASH End of High Voltage flag
257 * @arg FLASH_FLAG_READY: FLASH Ready flag after low power mode
258 * @arg FLASH_FLAG_WRPERR: FLASH Write protected error flag
259 * @arg FLASH_FLAG_PGAERR: FLASH Programming Alignment error flag
260 * @arg FLASH_FLAG_SIZERR: FLASH Size error flag
261 * @arg FLASH_FLAG_OPTVERR: FLASH Option validity error error flag
262 * @arg FLASH_FLAG_OPTVERRUSR : FLASH Option UserValidity (available only Cat.3, Cat.4 and Cat.5 devices)
263 * @arg FLASH_FLAG_RDERR : FLASH Read Protection error flag (PCROP) (available only Cat.2 and Cat.3 devices)
264 * @retval The new state of __FLAG__ (SET or RESET).
266 #define __HAL_FLASH_GET_FLAG(__FLAG__) (((FLASH->SR) & (__FLAG__)) == (__FLAG__))
269 * @brief Clear the specified FLASH flag.
270 * @param __FLAG__: specifies the FLASH flags to clear.
271 * This parameter can be any combination of the following values:
272 * @arg FLASH_FLAG_BSY : FLASH Busy flag
273 * @arg FLASH_FLAG_EOP : FLASH End of Operation flag
274 * @arg FLASH_FLAG_ENDHV : FLASH End of High Voltage flag
275 * @arg FLASH_FLAG_READY: FLASH Ready flag after low power mode
276 * @arg FLASH_FLAG_WRPERR: FLASH Write protected error flag
277 * @arg FLASH_FLAG_PGAERR: FLASH Programming Alignment error flag
278 * @arg FLASH_FLAG_SIZERR: FLASH Size error flag
279 * @arg FLASH_FLAG_OPTVERR: FLASH Option validity error error flag
280 * @arg FLASH_FLAG_OPTVERRUSR : FLASH Option UserValidity (available only Cat.3, Cat.4 and Cat.5 devices)
281 * @arg FLASH_FLAG_RDERR : FLASH Read Protection error flag (PCROP) (available only Cat.2 and Cat.3 devices)
284 #define __HAL_FLASH_CLEAR_FLAG(__FLAG__) ((FLASH->SR) = (__FLAG__))
294 /* Include FLASH HAL Extension module */
295 #include "stm32l1xx_hal_flash_ex.h"
296 #include "stm32l1xx_hal_flash_ramfunc.h"
298 /* Exported functions ------------------------------------------------------- */
300 /** @addtogroup FLASH_Exported_Functions
304 /** @addtogroup FLASH_Exported_Functions_Group1
309 * @brief FLASH memory functions that can be executed from FLASH.
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);
315 /* FLASH IRQ handler function */
316 void HAL_FLASH_IRQHandler(void);
318 /* Callbacks in non blocking modes */
319 void HAL_FLASH_EndOfOperationCallback(uint32_t ReturnValue);
320 void HAL_FLASH_OperationErrorCallback(uint32_t ReturnValue);
326 /** @addtogroup FLASH_Exported_Functions_Group2
330 /* FLASH Memory Programming functions *****************************************/
331 HAL_StatusTypeDef HAL_FLASH_Unlock(void);
332 HAL_StatusTypeDef HAL_FLASH_Lock(void);
334 /* Option Bytes Programming functions *****************************************/
335 HAL_StatusTypeDef HAL_FLASH_OB_Unlock(void);
336 HAL_StatusTypeDef HAL_FLASH_OB_Lock(void);
337 HAL_StatusTypeDef HAL_FLASH_OB_Launch(void);
343 /** @addtogroup FLASH_Exported_Functions_Group3
347 /* Peripheral State methods **************************************************/
348 FLASH_ErrorTypeDef HAL_FLASH_GetError(void);
358 /** @addtogroup FLASH_Internal_Functions
363 * @brief Function used internally by HAL FLASH driver.
365 HAL_StatusTypeDef FLASH_WaitForLastOperation(uint32_t Timeout);
383 #endif /* __STM32L1xx_HAL_FLASH_H */
385 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/