1 /** 2 ****************************************************************************** 3 * @file stm32l1xx_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) 2017 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 __STM32L1xx_HAL_FLASH_H 38 #define __STM32L1xx_HAL_FLASH_H 39 40 #ifdef __cplusplus 41 extern "C" { 42 #endif 43 44 /* Includes ------------------------------------------------------------------*/ 45 #include "stm32l1xx_hal_def.h" 46 47 /** @addtogroup STM32L1xx_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 /** 60 * @} 61 */ 62 63 /** @addtogroup FLASH_Private_Macros 64 * @{ 65 */ 66 67 #define IS_FLASH_TYPEPROGRAM(_VALUE_) ((_VALUE_) == FLASH_TYPEPROGRAM_WORD) 68 69 #define IS_FLASH_LATENCY(__LATENCY__) (((__LATENCY__) == FLASH_LATENCY_0) || \ 70 ((__LATENCY__) == FLASH_LATENCY_1)) 71 72 /** 73 * @} 74 */ 75 76 /* Exported types ------------------------------------------------------------*/ 77 /** @defgroup FLASH_Exported_Types FLASH Exported Types 78 * @{ 79 */ 80 81 /** 82 * @brief FLASH Procedure structure definition 83 */ 84 typedef enum 85 { 86 FLASH_PROC_NONE = 0U, 87 FLASH_PROC_PAGEERASE = 1U, 88 FLASH_PROC_PROGRAM = 2U, 89 } FLASH_ProcedureTypeDef; 90 91 /** 92 * @brief FLASH handle Structure definition 93 */ 94 typedef struct 95 { 96 __IO FLASH_ProcedureTypeDef ProcedureOnGoing; /*!< Internal variable to indicate which procedure is ongoing or not in IT context */ 97 98 __IO uint32_t NbPagesToErase; /*!< Internal variable to save the remaining sectors to erase in IT context*/ 99 100 __IO uint32_t Address; /*!< Internal variable to save address selected for program or erase */ 101 102 __IO uint32_t Page; /*!< Internal variable to define the current page which is erasing */ 103 104 HAL_LockTypeDef Lock; /*!< FLASH locking object */ 105 106 __IO uint32_t ErrorCode; /*!< FLASH error code 107 This parameter can be a value of @ref FLASH_Error_Codes */ 108 } FLASH_ProcessTypeDef; 109 110 /** 111 * @} 112 */ 113 114 /* Exported constants --------------------------------------------------------*/ 115 /** @defgroup FLASH_Exported_Constants FLASH Exported Constants 116 * @{ 117 */ 118 119 /** @defgroup FLASH_Error_Codes FLASH Error Codes 120 * @{ 121 */ 122 123 #define HAL_FLASH_ERROR_NONE 0x00U /*!< No error */ 124 #define HAL_FLASH_ERROR_PGA 0x01U /*!< Programming alignment error */ 125 #define HAL_FLASH_ERROR_WRP 0x02U /*!< Write protection error */ 126 #define HAL_FLASH_ERROR_OPTV 0x04U /*!< Option validity error */ 127 #define HAL_FLASH_ERROR_SIZE 0x08U /*!< */ 128 #define HAL_FLASH_ERROR_RD 0x10U /*!< Read protected error */ 129 #define HAL_FLASH_ERROR_OPTVUSR 0x20U /*!< Option UserValidity Error. */ 130 #define HAL_FLASH_ERROR_OPERATION 0x40U /*!< Not used */ 131 132 /** 133 * @} 134 */ 135 136 /** @defgroup FLASH_Page_Size FLASH size information 137 * @{ 138 */ 139 140 #define FLASH_SIZE (uint32_t)((*((uint32_t *)FLASHSIZE_BASE)&0xFFFFU) * 1024U) 141 #define FLASH_PAGE_SIZE (256U) /*!< FLASH Page Size in bytes */ 142 143 /** 144 * @} 145 */ 146 147 /** @defgroup FLASH_Type_Program FLASH Type Program 148 * @{ 149 */ 150 #define FLASH_TYPEPROGRAM_WORD (0x02U) /*!<Program a word (32-bit) at a specified address.*/ 151 152 /** 153 * @} 154 */ 155 156 /** @defgroup FLASH_Latency FLASH Latency 157 * @{ 158 */ 159 #define FLASH_LATENCY_0 (0x00000000U) /*!< FLASH Zero Latency cycle */ 160 #define FLASH_LATENCY_1 FLASH_ACR_LATENCY /*!< FLASH One Latency cycle */ 161 162 /** 163 * @} 164 */ 165 166 /** @defgroup FLASH_Interrupts FLASH Interrupts 167 * @{ 168 */ 169 170 #define FLASH_IT_EOP FLASH_PECR_EOPIE /*!< End of programming interrupt source */ 171 #define FLASH_IT_ERR FLASH_PECR_ERRIE /*!< Error interrupt source */ 172 /** 173 * @} 174 */ 175 176 /** @defgroup FLASH_Flags FLASH Flags 177 * @{ 178 */ 179 180 #define FLASH_FLAG_BSY FLASH_SR_BSY /*!< FLASH Busy flag */ 181 #define FLASH_FLAG_EOP FLASH_SR_EOP /*!< FLASH End of Programming flag */ 182 #define FLASH_FLAG_ENDHV FLASH_SR_ENDHV /*!< FLASH End of High Voltage flag */ 183 #define FLASH_FLAG_READY FLASH_SR_READY /*!< FLASH Ready flag after low power mode */ 184 #define FLASH_FLAG_WRPERR FLASH_SR_WRPERR /*!< FLASH Write protected error flag */ 185 #define FLASH_FLAG_PGAERR FLASH_SR_PGAERR /*!< FLASH Programming Alignment error flag */ 186 #define FLASH_FLAG_SIZERR FLASH_SR_SIZERR /*!< FLASH Size error flag */ 187 #define FLASH_FLAG_OPTVERR FLASH_SR_OPTVERR /*!< FLASH Option Validity error flag */ 188 /* Cat2 & Cat3*/ 189 #if defined(FLASH_SR_RDERR) 190 #define FLASH_FLAG_RDERR FLASH_SR_RDERR /*!< Read protected error flag */ 191 #endif /* FLASH_SR_RDERR */ 192 /* Cat3, Cat4 & Cat5*/ 193 #if defined(FLASH_SR_OPTVERRUSR) 194 #define FLASH_FLAG_OPTVERRUSR FLASH_SR_OPTVERRUSR /*!< FLASH Option User Validity error flag */ 195 #endif /* FLASH_SR_OPTVERRUSR */ 196 197 /** 198 * @} 199 */ 200 201 /** @defgroup FLASH_Keys FLASH Keys 202 * @{ 203 */ 204 205 #define FLASH_PDKEY1 (0x04152637U) /*!< Flash power down key1 */ 206 #define FLASH_PDKEY2 (0xFAFBFCFDU) /*!< Flash power down key2: used with FLASH_PDKEY1 207 to unlock the RUN_PD bit in FLASH_ACR */ 208 209 #define FLASH_PEKEY1 (0x89ABCDEFU) /*!< Flash program erase key1 */ 210 #define FLASH_PEKEY2 (0x02030405U) /*!< Flash program erase key: used with FLASH_PEKEY2 211 to unlock the write access to the FLASH_PECR register and 212 data EEPROM */ 213 214 #define FLASH_PRGKEY1 (0x8C9DAEBFU) /*!< Flash program memory key1 */ 215 #define FLASH_PRGKEY2 (0x13141516U) /*!< Flash program memory key2: used with FLASH_PRGKEY2 216 to unlock the program memory */ 217 218 #define FLASH_OPTKEY1 (0xFBEAD9C8U) /*!< Flash option key1 */ 219 #define FLASH_OPTKEY2 (0x24252627U) /*!< Flash option key2: used with FLASH_OPTKEY1 to 220 unlock the write access to the option byte block */ 221 /** 222 * @} 223 */ 224 /** 225 * @} 226 */ 227 228 /* Exported macro ------------------------------------------------------------*/ 229 230 /** @defgroup FLASH_Exported_Macros FLASH Exported Macros 231 * @brief macros to control FLASH features 232 * @{ 233 */ 234 235 236 /** @defgroup FLASH_Interrupt FLASH Interrupts 237 * @brief macros to handle FLASH interrupts 238 * @{ 239 */ 240 241 /** 242 * @brief Enable the specified FLASH interrupt. 243 * @param __INTERRUPT__ FLASH interrupt 244 * This parameter can be any combination of the following values: 245 * @arg @ref FLASH_IT_EOP End of FLASH Operation Interrupt 246 * @arg @ref FLASH_IT_ERR Error Interrupt 247 * @retval none 248 */ 249 #define __HAL_FLASH_ENABLE_IT(__INTERRUPT__) SET_BIT((FLASH->PECR), (__INTERRUPT__)) 250 251 /** 252 * @brief Disable the specified FLASH interrupt. 253 * @param __INTERRUPT__ FLASH interrupt 254 * This parameter can be any combination of the following values: 255 * @arg @ref FLASH_IT_EOP End of FLASH Operation Interrupt 256 * @arg @ref FLASH_IT_ERR Error Interrupt 257 * @retval none 258 */ 259 #define __HAL_FLASH_DISABLE_IT(__INTERRUPT__) CLEAR_BIT((FLASH->PECR), (uint32_t)(__INTERRUPT__)) 260 261 /** 262 * @brief Get the specified FLASH flag status. 263 * @param __FLAG__ specifies the FLASH flag to check. 264 * This parameter can be one of the following values: 265 * @arg @ref FLASH_FLAG_BSY FLASH Busy flag 266 * @arg @ref FLASH_FLAG_EOP FLASH End of Operation flag 267 * @arg @ref FLASH_FLAG_ENDHV FLASH End of High Voltage flag 268 * @arg @ref FLASH_FLAG_READY FLASH Ready flag after low power mode 269 * @arg @ref FLASH_FLAG_PGAERR FLASH Programming Alignment error flag 270 * @arg @ref FLASH_FLAG_SIZERR FLASH Size error flag 271 * @arg @ref FLASH_FLAG_OPTVERR FLASH Option validity error error flag 272 @if STM32L100xB 273 @elif STM32L100xBA 274 * @arg @ref FLASH_FLAG_RDERR FLASH Read Protection error flag (PCROP) 275 @elif STM32L151xB 276 @elif STM32L151xBA 277 * @arg @ref FLASH_FLAG_RDERR FLASH Read Protection error flag (PCROP) 278 @elif STM32L152xB 279 @elif STM32L152xBA 280 * @arg @ref FLASH_FLAG_RDERR FLASH Read Protection error flag (PCROP) 281 @elif STM32L100xC 282 * @arg @ref FLASH_FLAG_RDERR FLASH Read Protection error flag (PCROP) 283 * @arg @ref FLASH_FLAG_OPTVERRUSR FLASH Option User validity error 284 @elif STM32L151xC 285 * @arg @ref FLASH_FLAG_RDERR FLASH Read Protection error flag (PCROP) 286 * @arg @ref FLASH_FLAG_OPTVERRUSR FLASH Option User validity error 287 @elif STM32L152xC 288 * @arg @ref FLASH_FLAG_RDERR FLASH Read Protection error flag (PCROP) 289 * @arg @ref FLASH_FLAG_OPTVERRUSR FLASH Option User validity error 290 @elif STM32L162xC 291 * @arg @ref FLASH_FLAG_RDERR FLASH Read Protection error flag (PCROP) 292 * @arg @ref FLASH_FLAG_OPTVERRUSR FLASH Option User validity error 293 @else 294 * @arg @ref FLASH_FLAG_OPTVERRUSR FLASH Option User validity error 295 @endif 296 * @arg @ref FLASH_FLAG_WRPERR FLASH Write protected error flag 297 * @retval The new state of __FLAG__ (SET or RESET). 298 */ 299 #define __HAL_FLASH_GET_FLAG(__FLAG__) (((FLASH->SR) & (__FLAG__)) == (__FLAG__)) 300 301 /** 302 * @brief Clear the specified FLASH flag. 303 * @param __FLAG__ specifies the FLASH flags to clear. 304 * This parameter can be any combination of the following values: 305 * @arg @ref FLASH_FLAG_EOP FLASH End of Operation flag 306 * @arg @ref FLASH_FLAG_PGAERR FLASH Programming Alignment error flag 307 * @arg @ref FLASH_FLAG_SIZERR FLASH Size error flag 308 * @arg @ref FLASH_FLAG_OPTVERR FLASH Option validity error error flag 309 @if STM32L100xB 310 @elif STM32L100xBA 311 * @arg @ref FLASH_FLAG_RDERR FLASH Read Protection error flag (PCROP) 312 @elif STM32L151xB 313 @elif STM32L151xBA 314 * @arg @ref FLASH_FLAG_RDERR FLASH Read Protection error flag (PCROP) 315 @elif STM32L152xB 316 @elif STM32L152xBA 317 * @arg @ref FLASH_FLAG_RDERR FLASH Read Protection error flag (PCROP) 318 @elif STM32L100xC 319 * @arg @ref FLASH_FLAG_RDERR FLASH Read Protection error flag (PCROP) 320 * @arg @ref FLASH_FLAG_OPTVERRUSR FLASH Option User validity error 321 @elif STM32L151xC 322 * @arg @ref FLASH_FLAG_RDERR FLASH Read Protection error flag (PCROP) 323 * @arg @ref FLASH_FLAG_OPTVERRUSR FLASH Option User validity error 324 @elif STM32L152xC 325 * @arg @ref FLASH_FLAG_RDERR FLASH Read Protection error flag (PCROP) 326 * @arg @ref FLASH_FLAG_OPTVERRUSR FLASH Option User validity error 327 @elif STM32L162xC 328 * @arg @ref FLASH_FLAG_RDERR FLASH Read Protection error flag (PCROP) 329 * @arg @ref FLASH_FLAG_OPTVERRUSR FLASH Option User validity error 330 @else 331 * @arg @ref FLASH_FLAG_OPTVERRUSR FLASH Option User validity error 332 @endif 333 * @arg @ref FLASH_FLAG_WRPERR FLASH Write protected error flag 334 * @retval none 335 */ 336 #define __HAL_FLASH_CLEAR_FLAG(__FLAG__) ((FLASH->SR) = (__FLAG__)) 337 338 /** 339 * @} 340 */ 341 342 /** 343 * @} 344 */ 345 346 /* Include FLASH HAL Extended module */ 347 #include "stm32l1xx_hal_flash_ex.h" 348 #include "stm32l1xx_hal_flash_ramfunc.h" 349 350 /* Exported functions --------------------------------------------------------*/ 351 /** @addtogroup FLASH_Exported_Functions 352 * @{ 353 */ 354 355 /** @addtogroup FLASH_Exported_Functions_Group1 356 * @{ 357 */ 358 /* IO operation functions *****************************************************/ 359 HAL_StatusTypeDef HAL_FLASH_Program(uint32_t TypeProgram, uint32_t Address, uint32_t Data); 360 HAL_StatusTypeDef HAL_FLASH_Program_IT(uint32_t TypeProgram, uint32_t Address, uint32_t Data); 361 362 /* FLASH IRQ handler function */ 363 void HAL_FLASH_IRQHandler(void); 364 /* Callbacks in non blocking modes */ 365 void HAL_FLASH_EndOfOperationCallback(uint32_t ReturnValue); 366 void HAL_FLASH_OperationErrorCallback(uint32_t ReturnValue); 367 368 /** 369 * @} 370 */ 371 372 /** @addtogroup FLASH_Exported_Functions_Group2 373 * @{ 374 */ 375 /* Peripheral Control functions ***********************************************/ 376 HAL_StatusTypeDef HAL_FLASH_Unlock(void); 377 HAL_StatusTypeDef HAL_FLASH_Lock(void); 378 HAL_StatusTypeDef HAL_FLASH_OB_Unlock(void); 379 HAL_StatusTypeDef HAL_FLASH_OB_Lock(void); 380 HAL_StatusTypeDef HAL_FLASH_OB_Launch(void); 381 382 /** 383 * @} 384 */ 385 386 /** @addtogroup FLASH_Exported_Functions_Group3 387 * @{ 388 */ 389 /* Peripheral State and Error functions ***************************************/ 390 uint32_t HAL_FLASH_GetError(void); 391 392 /** 393 * @} 394 */ 395 396 /** 397 * @} 398 */ 399 400 /* Private function -------------------------------------------------*/ 401 /** @addtogroup FLASH_Private_Functions 402 * @{ 403 */ 404 HAL_StatusTypeDef FLASH_WaitForLastOperation(uint32_t Timeout); 405 406 /** 407 * @} 408 */ 409 410 /** 411 * @} 412 */ 413 414 /** 415 * @} 416 */ 417 418 #ifdef __cplusplus 419 } 420 #endif 421 422 #endif /* __STM32L1xx_HAL_FLASH_H */ 423 424 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/ 425 426
