1 /** 2 ****************************************************************************** 3 * @file stm32l0xx_hal_flash.h 4 * @author MCD Application Team 5 * @brief Header file of Flash HAL module. 6 ****************************************************************************** 7 * @attention 8 * 9 * <h2><center>© COPYRIGHT(c) 2016 STMicroelectronics</center></h2> 10 * 11 * Redistribution and use in source and binary forms, with or without modification, 12 * are permitted provided that the following conditions are met: 13 * 1. Redistributions of source code must retain the above copyright notice, 14 * this list of conditions and the following disclaimer. 15 * 2. Redistributions in binary form must reproduce the above copyright notice, 16 * this list of conditions and the following disclaimer in the documentation 17 * and/or other materials provided with the distribution. 18 * 3. Neither the name of STMicroelectronics nor the names of its contributors 19 * may be used to endorse or promote products derived from this software 20 * without specific prior written permission. 21 * 22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 23 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 25 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE 26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 28 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 29 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 30 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 32 * 33 ****************************************************************************** 34 */ 35 36 /* Define to prevent recursive inclusion -------------------------------------*/ 37 #ifndef __STM32L0xx_HAL_FLASH_H 38 #define __STM32L0xx_HAL_FLASH_H 39 40 #ifdef __cplusplus 41 extern "C" { 42 #endif 43 44 /* Includes ------------------------------------------------------------------*/ 45 #include "stm32l0xx_hal_def.h" 46 47 /** @addtogroup STM32L0xx_HAL_Driver 48 * @{ 49 */ 50 51 /** @addtogroup FLASH 52 * @{ 53 */ 54 55 /** @addtogroup FLASH_Private_Constants 56 * @{ 57 */ 58 #define FLASH_TIMEOUT_VALUE (50000U) /* 50 s */ 59 #define FLASH_SIZE_DATA_REGISTER FLASHSIZE_BASE 60 /** 61 * @} 62 */ 63 64 /** @addtogroup FLASH_Private_Macros 65 * @{ 66 */ 67 68 #define IS_FLASH_TYPEPROGRAM(_VALUE_) ((_VALUE_) == FLASH_TYPEPROGRAM_WORD) 69 70 #define IS_FLASH_LATENCY(__LATENCY__) (((__LATENCY__) == FLASH_LATENCY_0) || \ 71 ((__LATENCY__) == FLASH_LATENCY_1)) 72 73 /** 74 * @} 75 */ 76 77 /* Exported types ------------------------------------------------------------*/ 78 /** @defgroup FLASH_Exported_Types FLASH Exported Types 79 * @{ 80 */ 81 82 /** 83 * @brief FLASH Procedure structure definition 84 */ 85 typedef enum 86 { 87 FLASH_PROC_NONE = 0, 88 FLASH_PROC_PAGEERASE = 1, 89 FLASH_PROC_PROGRAM = 2, 90 } FLASH_ProcedureTypeDef; 91 92 /** 93 * @brief FLASH handle Structure definition 94 */ 95 typedef struct 96 { 97 __IO FLASH_ProcedureTypeDef ProcedureOnGoing; /*!< Internal variable to indicate which procedure is ongoing or not in IT context */ 98 99 __IO uint32_t NbPagesToErase; /*!< Internal variable to save the remaining sectors to erase in IT context*/ 100 101 __IO uint32_t Address; /*!< Internal variable to save address selected for program or erase */ 102 103 __IO uint32_t Page; /*!< Internal variable to define the current page which is erasing */ 104 105 HAL_LockTypeDef Lock; /*!< FLASH locking object */ 106 107 __IO uint32_t ErrorCode; /*!< FLASH error code 108 This parameter can be a value of @ref FLASH_Error_Codes */ 109 } FLASH_ProcessTypeDef; 110 111 /** 112 * @} 113 */ 114 115 /* Exported constants --------------------------------------------------------*/ 116 /** @defgroup FLASH_Exported_Constants FLASH Exported Constants 117 * @{ 118 */ 119 120 /** @defgroup FLASH_Error_Codes FLASH Error Codes 121 * @{ 122 */ 123 124 #define HAL_FLASH_ERROR_NONE 0x00U /*!< No error */ 125 #define HAL_FLASH_ERROR_PGA 0x01U /*!< Programming alignment error */ 126 #define HAL_FLASH_ERROR_WRP 0x02U /*!< Write protection error */ 127 #define HAL_FLASH_ERROR_OPTV 0x04U /*!< Option validity error */ 128 #define HAL_FLASH_ERROR_SIZE 0x08U /*!< */ 129 #define HAL_FLASH_ERROR_RD 0x10U /*!< Read protected error */ 130 #define HAL_FLASH_ERROR_FWWERR 0x20U /*!< FLASH Write or Erase operation aborted */ 131 #define HAL_FLASH_ERROR_NOTZERO 0x40U /*!< FLASH Write operation is done in a not-erased region */ 132 133 /** 134 * @} 135 */ 136 137 /** @defgroup FLASH_Page_Size FLASH size information 138 * @{ 139 */ 140 141 #define FLASH_SIZE (uint32_t)((*((uint32_t *)FLASHSIZE_BASE)&0xFFFF) * 1024U) 142 #define FLASH_PAGE_SIZE ((uint32_t)128U) /*!< FLASH Page Size in bytes */ 143 144 /** 145 * @} 146 */ 147 148 /** @defgroup FLASH_Type_Program FLASH Type Program 149 * @{ 150 */ 151 #define FLASH_TYPEPROGRAM_WORD ((uint32_t)0x02U) /*!<Program a word (32-bit) at a specified address.*/ 152 153 /** 154 * @} 155 */ 156 157 /** @defgroup FLASH_Latency FLASH Latency 158 * @{ 159 */ 160 #define FLASH_LATENCY_0 ((uint32_t)0x00000000U) /*!< FLASH Zero Latency cycle */ 161 #define FLASH_LATENCY_1 FLASH_ACR_LATENCY /*!< FLASH One Latency cycle */ 162 163 /** 164 * @} 165 */ 166 167 /** @defgroup FLASH_Interrupts FLASH Interrupts 168 * @{ 169 */ 170 171 #define FLASH_IT_EOP FLASH_PECR_EOPIE /*!< End of programming interrupt source */ 172 #define FLASH_IT_ERR FLASH_PECR_ERRIE /*!< Error interrupt source */ 173 /** 174 * @} 175 */ 176 177 /** @defgroup FLASH_Flags FLASH Flags 178 * @{ 179 */ 180 181 #define FLASH_FLAG_BSY FLASH_SR_BSY /*!< FLASH Busy flag */ 182 #define FLASH_FLAG_EOP FLASH_SR_EOP /*!< FLASH End of Programming flag */ 183 #define FLASH_FLAG_ENDHV FLASH_SR_HVOFF /*!< FLASH End of High Voltage flag */ 184 #define FLASH_FLAG_READY FLASH_SR_READY /*!< FLASH Ready flag after low power mode */ 185 #define FLASH_FLAG_WRPERR FLASH_SR_WRPERR /*!< FLASH Write protected error flag */ 186 #define FLASH_FLAG_PGAERR FLASH_SR_PGAERR /*!< FLASH Programming Alignment error flag */ 187 #define FLASH_FLAG_SIZERR FLASH_SR_SIZERR /*!< FLASH Size error flag */ 188 #define FLASH_FLAG_OPTVERR FLASH_SR_OPTVERR /*!< FLASH Option Validity error flag */ 189 #define FLASH_FLAG_RDERR FLASH_SR_RDERR /*!< FLASH Read protected error flag */ 190 #define FLASH_FLAG_FWWERR FLASH_SR_FWWERR /*!< FLASH Write or Errase operation aborted */ 191 #define FLASH_FLAG_NOTZEROERR FLASH_SR_NOTZEROERR /*!< FLASH Read protected error flag */ 192 193 /** 194 * @} 195 */ 196 197 /** @defgroup FLASH_Keys FLASH Keys 198 * @{ 199 */ 200 201 #define FLASH_PDKEY1 ((uint32_t)0x04152637U) /*!< Flash power down key1 */ 202 #define FLASH_PDKEY2 ((uint32_t)0xFAFBFCFDU) /*!< Flash power down key2: used with FLASH_PDKEY1 203 to unlock the RUN_PD bit in FLASH_ACR */ 204 205 #define FLASH_PEKEY1 ((uint32_t)0x89ABCDEFU) /*!< Flash program erase key1 */ 206 #define FLASH_PEKEY2 ((uint32_t)0x02030405U) /*!< Flash program erase key: used with FLASH_PEKEY2 207 to unlock the write access to the FLASH_PECR register and 208 data EEPROM */ 209 210 #define FLASH_PRGKEY1 ((uint32_t)0x8C9DAEBFU) /*!< Flash program memory key1 */ 211 #define FLASH_PRGKEY2 ((uint32_t)0x13141516U) /*!< Flash program memory key2: used with FLASH_PRGKEY2 212 to unlock the program memory */ 213 214 #define FLASH_OPTKEY1 ((uint32_t)0xFBEAD9C8U) /*!< Flash option key1 */ 215 #define FLASH_OPTKEY2 ((uint32_t)0x24252627U) /*!< Flash option key2: used with FLASH_OPTKEY1 to 216 unlock the write access to the option byte block */ 217 /** 218 * @} 219 */ 220 221 /* CMSIS_Legacy */ 222 223 #if defined ( __ICCARM__ ) 224 #define InterruptType_ACTLR_DISMCYCINT_Msk IntType_ACTLR_DISMCYCINT_Msk 225 #endif 226 227 /** 228 * @} 229 */ 230 231 /* Exported macro ------------------------------------------------------------*/ 232 233 /** @defgroup FLASH_Exported_Macros FLASH Exported Macros 234 * @brief macros to control FLASH features 235 * @{ 236 */ 237 238 239 /** @defgroup FLASH_Interrupt FLASH Interrupts 240 * @brief macros to handle FLASH interrupts 241 * @{ 242 */ 243 244 /** 245 * @brief Enable the specified FLASH interrupt. 246 * @param __INTERRUPT__ FLASH interrupt 247 * This parameter can be any combination of the following values: 248 * @arg @ref FLASH_IT_EOP End of FLASH Operation Interrupt 249 * @arg @ref FLASH_IT_ERR Error Interrupt 250 * @retval none 251 */ 252 #define __HAL_FLASH_ENABLE_IT(__INTERRUPT__) SET_BIT((FLASH->PECR), (__INTERRUPT__)) 253 254 /** 255 * @brief Disable the specified FLASH interrupt. 256 * @param __INTERRUPT__ FLASH interrupt 257 * This parameter can be any combination of the following values: 258 * @arg @ref FLASH_IT_EOP End of FLASH Operation Interrupt 259 * @arg @ref FLASH_IT_ERR Error Interrupt 260 * @retval none 261 */ 262 #define __HAL_FLASH_DISABLE_IT(__INTERRUPT__) CLEAR_BIT((FLASH->PECR), (uint32_t)(__INTERRUPT__)) 263 264 /** 265 * @brief Get the specified FLASH flag status. 266 * @param __FLAG__ specifies the FLASH flag to check. 267 * This parameter can be one of the following values: 268 * @arg @ref FLASH_FLAG_BSY FLASH Busy flag 269 * @arg @ref FLASH_FLAG_EOP FLASH End of Operation flag 270 * @arg @ref FLASH_FLAG_ENDHV FLASH End of High Voltage flag 271 * @arg @ref FLASH_FLAG_READY FLASH Ready flag after low power mode 272 * @arg @ref FLASH_FLAG_PGAERR FLASH Programming Alignment error flag 273 * @arg @ref FLASH_FLAG_SIZERR FLASH Size error flag 274 * @arg @ref FLASH_FLAG_OPTVERR FLASH Option validity error flag (not valid with STM32L031xx/STM32L041xx) 275 * @arg @ref FLASH_FLAG_RDERR FLASH Read protected error flag 276 * @arg @ref FLASH_FLAG_WRPERR FLASH Write protected error flag 277 * @arg @ref FLASH_FLAG_FWWERR FLASH Fetch While Write Error flag 278 * @arg @ref FLASH_FLAG_NOTZEROERR Not Zero area error flag 279 * @retval The new state of __FLAG__ (SET or RESET). 280 */ 281 #define __HAL_FLASH_GET_FLAG(__FLAG__) (((FLASH->SR) & (__FLAG__)) == (__FLAG__)) 282 283 /** 284 * @brief Clear the specified FLASH flag. 285 * @param __FLAG__ specifies the FLASH flags to clear. 286 * This parameter can be any combination of the following values: 287 * @arg @ref FLASH_FLAG_EOP FLASH End of Operation flag 288 * @arg @ref FLASH_FLAG_PGAERR FLASH Programming Alignment error flag 289 * @arg @ref FLASH_FLAG_SIZERR FLASH Size error flag 290 * @arg @ref FLASH_FLAG_OPTVERR FLASH Option validity error flag (not valid with STM32L031xx/STM32L041xx) 291 * @arg @ref FLASH_FLAG_RDERR FLASH Read protected error flag 292 * @arg @ref FLASH_FLAG_WRPERR FLASH Write protected error flag 293 * @arg @ref FLASH_FLAG_FWWERR FLASH Fetch While Write Error flag 294 * @arg @ref FLASH_FLAG_NOTZEROERR Not Zero area error flag 295 * @retval none 296 */ 297 #define __HAL_FLASH_CLEAR_FLAG(__FLAG__) ((FLASH->SR) = (__FLAG__)) 298 299 /** 300 * @} 301 */ 302 303 /** 304 * @} 305 */ 306 307 /* Include FLASH HAL Extended module */ 308 #include "stm32l0xx_hal_flash_ex.h" 309 #include "stm32l0xx_hal_flash_ramfunc.h" 310 311 /* Exported functions --------------------------------------------------------*/ 312 /** @addtogroup FLASH_Exported_Functions 313 * @{ 314 */ 315 316 /** @addtogroup FLASH_Exported_Functions_Group1 317 * @{ 318 */ 319 /* IO operation functions *****************************************************/ 320 HAL_StatusTypeDef HAL_FLASH_Program(uint32_t TypeProgram, uint32_t Address, uint32_t Data); 321 HAL_StatusTypeDef HAL_FLASH_Program_IT(uint32_t TypeProgram, uint32_t Address, uint32_t Data); 322 323 /* FLASH IRQ handler function */ 324 void HAL_FLASH_IRQHandler(void); 325 /* Callbacks in non blocking modes */ 326 void HAL_FLASH_EndOfOperationCallback(uint32_t ReturnValue); 327 void HAL_FLASH_OperationErrorCallback(uint32_t ReturnValue); 328 329 /** 330 * @} 331 */ 332 333 /** @addtogroup FLASH_Exported_Functions_Group2 334 * @{ 335 */ 336 /* Peripheral Control functions ***********************************************/ 337 HAL_StatusTypeDef HAL_FLASH_Unlock(void); 338 HAL_StatusTypeDef HAL_FLASH_Lock(void); 339 HAL_StatusTypeDef HAL_FLASH_OB_Unlock(void); 340 HAL_StatusTypeDef HAL_FLASH_OB_Lock(void); 341 HAL_StatusTypeDef HAL_FLASH_OB_Launch(void); 342 343 /** 344 * @} 345 */ 346 347 /** @addtogroup FLASH_Exported_Functions_Group3 348 * @{ 349 */ 350 /* Peripheral State and Error functions ***************************************/ 351 uint32_t HAL_FLASH_GetError(void); 352 353 /** 354 * @} 355 */ 356 357 /** 358 * @} 359 */ 360 361 /* Private function -------------------------------------------------*/ 362 /** @addtogroup FLASH_Private_Functions 363 * @{ 364 */ 365 HAL_StatusTypeDef FLASH_WaitForLastOperation(uint32_t Timeout); 366 367 /** 368 * @} 369 */ 370 371 /** 372 * @} 373 */ 374 375 /** 376 * @} 377 */ 378 379 #ifdef __cplusplus 380 } 381 #endif 382 383 #endif /* __STM32L0xx_HAL_FLASH_H */ 384 385 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/ 386 387
