| /** |
| ****************************************************************************** |
| * @file stm32l0xx_hal_flash.h |
| * @author MCD Application Team |
| * @brief Header file of Flash HAL module. |
| ****************************************************************************** |
| * @attention |
| * |
| * Copyright (c) 2016 STMicroelectronics. |
| * All rights reserved. |
| * |
| * This software is licensed under terms that can be found in the LICENSE file |
| * in the root directory of this software component. |
| * If no LICENSE file comes with this software, it is provided AS-IS. |
| * |
| ****************************************************************************** |
| */ |
| |
| /* Define to prevent recursive inclusion -------------------------------------*/ |
| #ifndef __STM32L0xx_HAL_FLASH_H |
| #define __STM32L0xx_HAL_FLASH_H |
| |
| #ifdef __cplusplus |
| extern "C" { |
| #endif |
| |
| /* Includes ------------------------------------------------------------------*/ |
| #include "stm32l0xx_hal_def.h" |
| |
| /** @addtogroup STM32L0xx_HAL_Driver |
| * @{ |
| */ |
| |
| /** @addtogroup FLASH |
| * @{ |
| */ |
| |
| /** @addtogroup FLASH_Private_Constants |
| * @{ |
| */ |
| #define FLASH_TIMEOUT_VALUE (50000U) /* 50 s */ |
| #define FLASH_SIZE_DATA_REGISTER FLASHSIZE_BASE |
| /** |
| * @} |
| */ |
| |
| /** @addtogroup FLASH_Private_Macros |
| * @{ |
| */ |
| |
| #define IS_FLASH_TYPEPROGRAM(_VALUE_) ((_VALUE_) == FLASH_TYPEPROGRAM_WORD) |
| |
| #define IS_FLASH_LATENCY(__LATENCY__) (((__LATENCY__) == FLASH_LATENCY_0) || \ |
| ((__LATENCY__) == FLASH_LATENCY_1)) |
| |
| /** |
| * @} |
| */ |
| |
| /* Exported types ------------------------------------------------------------*/ |
| /** @defgroup FLASH_Exported_Types FLASH Exported Types |
| * @{ |
| */ |
| |
| /** |
| * @brief FLASH Procedure structure definition |
| */ |
| typedef enum |
| { |
| FLASH_PROC_NONE = 0, |
| FLASH_PROC_PAGEERASE = 1, |
| FLASH_PROC_PROGRAM = 2, |
| } 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 NbPagesToErase; /*!< Internal variable to save the remaining sectors to erase in IT context*/ |
| |
| __IO uint32_t Address; /*!< Internal variable to save address selected for program or erase */ |
| |
| __IO uint32_t Page; /*!< Internal variable to define the current page which is erasing */ |
| |
| HAL_LockTypeDef Lock; /*!< FLASH locking object */ |
| |
| __IO uint32_t ErrorCode; /*!< FLASH error code |
| This parameter can be a value of @ref FLASH_Error_Codes */ |
| } FLASH_ProcessTypeDef; |
| |
| /** |
| * @} |
| */ |
| |
| /* Exported constants --------------------------------------------------------*/ |
| /** @defgroup FLASH_Exported_Constants FLASH Exported Constants |
| * @{ |
| */ |
| |
| /** @defgroup FLASH_Error_Codes FLASH Error Codes |
| * @{ |
| */ |
| |
| #define HAL_FLASH_ERROR_NONE 0x00U /*!< No error */ |
| #define HAL_FLASH_ERROR_PGA 0x01U /*!< Programming alignment error */ |
| #define HAL_FLASH_ERROR_WRP 0x02U /*!< Write protection error */ |
| #define HAL_FLASH_ERROR_OPTV 0x04U /*!< Option validity error */ |
| #define HAL_FLASH_ERROR_SIZE 0x08U /*!< */ |
| #define HAL_FLASH_ERROR_RD 0x10U /*!< Read protected error */ |
| #define HAL_FLASH_ERROR_FWWERR 0x20U /*!< FLASH Write or Erase operation aborted */ |
| #define HAL_FLASH_ERROR_NOTZERO 0x40U /*!< FLASH Write operation is done in a not-erased region */ |
| |
| /** |
| * @} |
| */ |
| |
| /** @defgroup FLASH_Page_Size FLASH size information |
| * @{ |
| */ |
| |
| #define FLASH_SIZE (uint32_t)((*((uint32_t *)FLASHSIZE_BASE)&0xFFFF) * 1024U) |
| #define FLASH_PAGE_SIZE (128U) /*!< FLASH Page Size in bytes */ |
| |
| #define FLASH_END (FLASH_BASE + FLASH_SIZE - 1) /*!< FLASH end address in the alias region */ |
| |
| #if defined (STM32L071xx) || defined (STM32L072xx) || defined (STM32L073xx) || defined (STM32L081xx) || defined (STM32L082xx) || defined (STM32L083xx) |
| #define FLASH_BANK2_BASE (FLASH_BASE + (FLASH_SIZE >> 1)) /*!< FLASH BANK2 base address in the alias region */ |
| #define FLASH_BANK1_END (FLASH_BANK2_BASE - 1) /*!< Program end FLASH BANK1 address */ |
| #define FLASH_BANK2_END (FLASH_END) /*!< Program end FLASH BANK2 address */ |
| #endif |
| |
| /** |
| * @} |
| */ |
| |
| /** @defgroup FLASH_Type_Program FLASH Type Program |
| * @{ |
| */ |
| #define FLASH_TYPEPROGRAM_WORD (0x02U) /*!<Program a word (32-bit) at a specified address.*/ |
| |
| /** |
| * @} |
| */ |
| |
| /** @defgroup FLASH_Latency FLASH Latency |
| * @{ |
| */ |
| #define FLASH_LATENCY_0 (0x00000000U) /*!< FLASH Zero Latency cycle */ |
| #define FLASH_LATENCY_1 FLASH_ACR_LATENCY /*!< FLASH One Latency cycle */ |
| |
| /** |
| * @} |
| */ |
| |
| /** @defgroup FLASH_Interrupts FLASH Interrupts |
| * @{ |
| */ |
| |
| #define FLASH_IT_EOP FLASH_PECR_EOPIE /*!< End of programming interrupt source */ |
| #define FLASH_IT_ERR FLASH_PECR_ERRIE /*!< Error interrupt source */ |
| /** |
| * @} |
| */ |
| |
| /** @defgroup FLASH_Flags FLASH Flags |
| * @{ |
| */ |
| |
| #define FLASH_FLAG_BSY FLASH_SR_BSY /*!< FLASH Busy flag */ |
| #define FLASH_FLAG_EOP FLASH_SR_EOP /*!< FLASH End of Programming flag */ |
| #define FLASH_FLAG_ENDHV FLASH_SR_HVOFF /*!< FLASH End of High Voltage flag */ |
| #define FLASH_FLAG_READY FLASH_SR_READY /*!< FLASH Ready flag after low power mode */ |
| #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_SIZERR FLASH_SR_SIZERR /*!< FLASH Size error flag */ |
| #define FLASH_FLAG_OPTVERR FLASH_SR_OPTVERR /*!< FLASH Option Validity error flag */ |
| #define FLASH_FLAG_RDERR FLASH_SR_RDERR /*!< FLASH Read protected error flag */ |
| #define FLASH_FLAG_FWWERR FLASH_SR_FWWERR /*!< FLASH Write or Errase operation aborted */ |
| #define FLASH_FLAG_NOTZEROERR FLASH_SR_NOTZEROERR /*!< FLASH Read protected error flag */ |
| |
| /** |
| * @} |
| */ |
| |
| /** @defgroup FLASH_Keys FLASH Keys |
| * @{ |
| */ |
| |
| #define FLASH_PDKEY1 (0x04152637U) /*!< Flash power down key1 */ |
| #define FLASH_PDKEY2 (0xFAFBFCFDU) /*!< Flash power down key2: used with FLASH_PDKEY1 |
| to unlock the RUN_PD bit in FLASH_ACR */ |
| |
| #define FLASH_PEKEY1 (0x89ABCDEFU) /*!< Flash program erase key1 */ |
| #define FLASH_PEKEY2 (0x02030405U) /*!< Flash program erase key: used with FLASH_PEKEY2 |
| to unlock the write access to the FLASH_PECR register and |
| data EEPROM */ |
| |
| #define FLASH_PRGKEY1 (0x8C9DAEBFU) /*!< Flash program memory key1 */ |
| #define FLASH_PRGKEY2 (0x13141516U) /*!< Flash program memory key2: used with FLASH_PRGKEY2 |
| to unlock the program memory */ |
| |
| #define FLASH_OPTKEY1 (0xFBEAD9C8U) /*!< Flash option key1 */ |
| #define FLASH_OPTKEY2 (0x24252627U) /*!< Flash option key2: used with FLASH_OPTKEY1 to |
| unlock the write access to the option byte block */ |
| /** |
| * @} |
| */ |
| |
| /* CMSIS_Legacy */ |
| |
| #if defined ( __ICCARM__ ) |
| #define InterruptType_ACTLR_DISMCYCINT_Msk IntType_ACTLR_DISMCYCINT_Msk |
| #endif |
| |
| /** |
| * @} |
| */ |
| |
| /* Exported macro ------------------------------------------------------------*/ |
| |
| /** @defgroup FLASH_Exported_Macros FLASH Exported Macros |
| * @brief macros to control FLASH features |
| * @{ |
| */ |
| |
| |
| /** @defgroup FLASH_Interrupt FLASH Interrupts |
| * @brief macros to handle FLASH interrupts |
| * @{ |
| */ |
| |
| /** |
| * @brief Enable the specified FLASH interrupt. |
| * @param __INTERRUPT__ FLASH interrupt |
| * This parameter can be any combination of the following values: |
| * @arg @ref FLASH_IT_EOP End of FLASH Operation Interrupt |
| * @arg @ref FLASH_IT_ERR Error Interrupt |
| * @retval none |
| */ |
| #define __HAL_FLASH_ENABLE_IT(__INTERRUPT__) SET_BIT((FLASH->PECR), (__INTERRUPT__)) |
| |
| /** |
| * @brief Disable the specified FLASH interrupt. |
| * @param __INTERRUPT__ FLASH interrupt |
| * This parameter can be any combination of the following values: |
| * @arg @ref FLASH_IT_EOP End of FLASH Operation Interrupt |
| * @arg @ref FLASH_IT_ERR Error Interrupt |
| * @retval none |
| */ |
| #define __HAL_FLASH_DISABLE_IT(__INTERRUPT__) CLEAR_BIT((FLASH->PECR), (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 @ref FLASH_FLAG_BSY FLASH Busy flag |
| * @arg @ref FLASH_FLAG_EOP FLASH End of Operation flag |
| * @arg @ref FLASH_FLAG_ENDHV FLASH End of High Voltage flag |
| * @arg @ref FLASH_FLAG_READY FLASH Ready flag after low power mode |
| * @arg @ref FLASH_FLAG_PGAERR FLASH Programming Alignment error flag |
| * @arg @ref FLASH_FLAG_SIZERR FLASH Size error flag |
| * @arg @ref FLASH_FLAG_OPTVERR FLASH Option validity error flag (not valid with STM32L031xx/STM32L041xx) |
| * @arg @ref FLASH_FLAG_RDERR FLASH Read protected error flag |
| * @arg @ref FLASH_FLAG_WRPERR FLASH Write protected error flag |
| * @arg @ref FLASH_FLAG_FWWERR FLASH Fetch While Write Error flag |
| * @arg @ref FLASH_FLAG_NOTZEROERR Not Zero area error flag |
| * @retval The new state of __FLAG__ (SET or RESET). |
| */ |
| #define __HAL_FLASH_GET_FLAG(__FLAG__) (((FLASH->SR) & (__FLAG__)) == (__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 @ref FLASH_FLAG_EOP FLASH End of Operation flag |
| * @arg @ref FLASH_FLAG_PGAERR FLASH Programming Alignment error flag |
| * @arg @ref FLASH_FLAG_SIZERR FLASH Size error flag |
| * @arg @ref FLASH_FLAG_OPTVERR FLASH Option validity error flag (not valid with STM32L031xx/STM32L041xx) |
| * @arg @ref FLASH_FLAG_RDERR FLASH Read protected error flag |
| * @arg @ref FLASH_FLAG_WRPERR FLASH Write protected error flag |
| * @arg @ref FLASH_FLAG_FWWERR FLASH Fetch While Write Error flag |
| * @arg @ref FLASH_FLAG_NOTZEROERR Not Zero area error flag |
| * @retval none |
| */ |
| #define __HAL_FLASH_CLEAR_FLAG(__FLAG__) ((FLASH->SR) = (__FLAG__)) |
| |
| /** |
| * @} |
| */ |
| |
| /** |
| * @} |
| */ |
| |
| /* Include FLASH HAL Extended module */ |
| #include "stm32l0xx_hal_flash_ex.h" |
| #include "stm32l0xx_hal_flash_ramfunc.h" |
| |
| /* Exported functions --------------------------------------------------------*/ |
| /** @addtogroup FLASH_Exported_Functions |
| * @{ |
| */ |
| |
| /** @addtogroup FLASH_Exported_Functions_Group1 |
| * @{ |
| */ |
| /* IO operation functions *****************************************************/ |
| HAL_StatusTypeDef HAL_FLASH_Program(uint32_t TypeProgram, uint32_t Address, uint32_t Data); |
| HAL_StatusTypeDef HAL_FLASH_Program_IT(uint32_t TypeProgram, uint32_t Address, uint32_t Data); |
| |
| /* FLASH IRQ handler function */ |
| 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); |
| HAL_StatusTypeDef HAL_FLASH_OB_Launch(void); |
| |
| /** |
| * @} |
| */ |
| |
| /** @addtogroup FLASH_Exported_Functions_Group3 |
| * @{ |
| */ |
| /* Peripheral State and Error functions ***************************************/ |
| uint32_t HAL_FLASH_GetError(void); |
| |
| /** |
| * @} |
| */ |
| |
| /** |
| * @} |
| */ |
| |
| /* Private function -------------------------------------------------*/ |
| /** @addtogroup FLASH_Private_Functions |
| * @{ |
| */ |
| HAL_StatusTypeDef FLASH_WaitForLastOperation(uint32_t Timeout); |
| |
| /** |
| * @} |
| */ |
| |
| /** |
| * @} |
| */ |
| |
| /** |
| * @} |
| */ |
| |
| #ifdef __cplusplus |
| } |
| #endif |
| |
| #endif /* __STM32L0xx_HAL_FLASH_H */ |
