tmk_core/tool/mbed/mbed-sdk/libraries/mbed/targets/cmsis/TARGET_STM/TARGET_STM32L0/stm32l0xx_hal_flash.h

   1 /**
   2   ******************************************************************************
   3   * @file    stm32l0xx_hal_flash.h
   4   * @author  MCD Application Team
   5   * @version V1.2.0
   6   * @date    06-February-2015
   7   * @brief   Header file of Flash HAL module.
   8   ******************************************************************************
   9   * @attention
  10   *
  11   * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
  12   *
  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.
  23   *
  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.
  34   *
  35   ******************************************************************************
  36   */
  37
  38 /* Define to prevent recursive inclusion -------------------------------------*/
  39 #ifndef __STM32L0XX_HAL_FLASH_H
  40 #define __STM32L0XX_HAL_FLASH_H
  41
  42 #ifdef __cplusplus
  43  extern "C" {
  44 #endif
  45
  46 /* Includes ------------------------------------------------------------------*/
  47 #include "stm32l0xx_hal_def.h"
  48
  49 /** @addtogroup STM32L0xx_HAL_Driver
  50   * @{
  51   */
  52
  53 /** @defgroup FLASH FLASH
  54   * @{
  55   */
  56
  57 /** @defgroup FLASH_Exported_Types FLASH Exported Types
  58   * @{
  59   */
  60
  61 /**
  62   * @brief  FLASH Procedure structure definition
  63   */
  64 typedef enum
  65 {
  66   FLASH_PROC_NONE = 0,
  67   FLASH_PROC_PAGEERASE,
  68   FLASH_PROC_PROGRAM
  69 } FLASH_ProcedureTypeDef;
  70
  71 /**
  72  * @brief FLASH Erase structure definition
  73  */
  74  typedef struct
  75  {
  76     uint32_t TypeErase;    /*!< TypeErase: Page Erase only.
  77                              This parameter can be a value of @ref FLASHEx_Type_Erase */
  78
  79     uint32_t PageAddress ; /*!< PageAddress : Initial FLASH address to be erased
  80                              This parameter must be a value belonging to FLASH Programm address (depending on the devices) */
  81
  82     uint32_t NbPages;      /*!< NbPages: Number of pages to be erased.
  83                              This parameter must be a value between 1 and (max number of pages - value of Initial page)*/
  84
  85  } FLASH_EraseInitTypeDef;
  86 /**
  87   * @}
  88   */
  89
  90
  91 /** @defgroup FLASH_Private_Types FLASH Private Types
  92   * @{
  93   */
  94
  95 /**
  96   * @brief  FLASH handle Structure definition
  97   */
  98 typedef struct
  99 {
 100   __IO FLASH_ProcedureTypeDef ProcedureOnGoing;  /* Internal variable to indicate which procedure is ongoing or not in IT context */
 101
 102   __IO uint32_t               NbPagesToErase;    /* Internal variable to save the remaining sectors to erase in IT context */
 103
 104   __IO uint32_t               Page;              /* Internal variable to define the current sector which is erasing */
 105
 106   __IO uint32_t               Address;           /* Internal variable to save address selected for program */
 107
 108   HAL_LockTypeDef             Lock;              /* FLASH locking object */
 109
 110   __IO uint32_t               ErrorCode;         /* FLASH error code */
 111
 112 }FLASH_ProcessTypeDef;
 113 /**
 114   * @}
 115   */
 116
 117 /** @defgroup FLASH_Private_Variables FLASH Private Variables
 118   * @{
 119   */
 120
 121 /**
 122   * @brief  Variable used for Program/Erase sectors under interruption.
 123   *     Put as extern as used also in flash_ex.c.
 124   */
 125 extern FLASH_ProcessTypeDef ProcFlash;
 126 /**
 127   * @}
 128   */
 129
 130 /** @defgroup FLASH_Private_Constants FLASH Private Constants
 131   * @{
 132   */
 133 #define FLASH_TIMEOUT_VALUE        ((uint32_t)50000) /* 50 s */
 134 #define FLASH_SIZE_DATA_REGISTER   ((uint32_t)0x1FF8007C)
 135 /**
 136   * @}
 137   */
 138
 139
 140 /** @defgroup FLASH_Exported_Constants FLASH Public Constants
 141   * @{
 142   */
 143
 144   /**
 145   * @brief  FLASH size information
 146   */
 147 #define FLASH_SIZE                 (uint32_t)(*((uint16_t *)FLASH_SIZE_DATA_REGISTER) * 1024)
 148 #define FLASH_PAGE_SIZE            ((uint32_t)128)
 149
 150 /** @defgroup FLASH_Type_Program
 151   * @{
 152   */
 153 #define FLASH_TYPEPROGRAM_WORD     ((uint32_t)0x02)  /*!<Program a word (32-bit) at a specified address.*/
 154 /**
 155   * @}
 156   */
 157
 158 /** @defgroup FLASH_Latency FLASH Latency
 159   * @{
 160   */
 161 #define FLASH_LATENCY_0            ((uint8_t)0x00)    /*!< FLASH Zero Latency cycle */
 162 #define FLASH_LATENCY_1            ((uint8_t)0x01)    /*!< FLASH One Latency cycle */
 163 /**
 164   * @}
 165   */
 166
 167 /** @defgroup FLASH_Interrupts FLASH Interrupts
 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 #define FLASH_FLAG_BSY             FLASH_SR_BSY             /*!< FLASH Busy flag */
 180 #define FLASH_FLAG_EOP             FLASH_SR_EOP             /*!< FLASH End of Programming flag */
 181 #define FLASH_FLAG_ENDHV           FLASH_SR_HVOFF           /*!< FLASH End of High Voltage flag */
 182 #define FLASH_FLAG_READY           FLASH_SR_READY           /*!< FLASH Ready flag after low power mode */
 183 #define FLASH_FLAG_WRPERR          FLASH_SR_WRPERR          /*!< FLASH Write protected error flag */
 184 #define FLASH_FLAG_PGAERR          FLASH_SR_PGAERR          /*!< FLASH Programming Alignment error flag */
 185 #define FLASH_FLAG_SIZERR          FLASH_SR_SIZERR          /*!< FLASH Size error flag  */
 186 #define FLASH_FLAG_OPTVERR         FLASH_SR_OPTVERR         /*!< FLASH Option Validity error flag  */
 187 #define FLASH_FLAG_RDERR           FLASH_SR_RDERR           /*!< FLASH Read protected error flag */
 188 #define FLASH_FLAG_FWWERR          FLASH_SR_FWWERR          /*!< FLASH Write or Errase operation aborted */
 189 #define FLASH_FLAG_NOTZEROERR      FLASH_SR_NOTZEROERR      /*!< FLASH Read protected error flag */
 190 /**
 191   * @}
 192   */
 193
 194 /** @defgroup FLASH_Error_Code Flash Error Code
 195   * @{
 196   */
 197 #define HAL_FLASH_ERROR_NONE    0x00
 198 #define HAL_FLASH_ERROR_RD      0x01
 199 #define HAL_FLASH_ERROR_SIZE    0x02
 200 #define HAL_FLASH_ERROR_PGA     0x04
 201 #define HAL_FLASH_ERROR_WRP     0x08
 202 #define HAL_FLASH_ERROR_OPTV    0x10
 203 #define HAL_FLASH_ERROR_FWWERR  0x20
 204 #define HAL_FLASH_ERROR_NOTZERO 0x40
 205 /**
 206   * @}
 207   */
 208
 209 /** @defgroup FLASH_Keys FLASH Keys
 210   * @{
 211   */
 212 #define FLASH_PDKEY1               ((uint32_t)0x04152637) /*!< Flash power down key1 */
 213 #define FLASH_PDKEY2               ((uint32_t)0xFAFBFCFD) /*!< Flash power down key2: used with FLASH_PDKEY1
 214                                                                to unlock the RUN_PD bit in FLASH_ACR */
 215
 216 #define FLASH_PEKEY1               ((uint32_t)0x89ABCDEF) /*!< Flash program erase key1 */
 217 #define FLASH_PEKEY2               ((uint32_t)0x02030405) /*!< Flash program erase key: used with FLASH_PEKEY2
 218                                                                to unlock the write access to the FLASH_PECR register and
 219                                                                data EEPROM */
 220
 221 #define FLASH_PRGKEY1              ((uint32_t)0x8C9DAEBF) /*!< Flash program memory key1 */
 222 #define FLASH_PRGKEY2              ((uint32_t)0x13141516) /*!< Flash program memory key2: used with FLASH_PRGKEY2
 223                                                                to unlock the program memory */
 224
 225 #define FLASH_OPTKEY1              ((uint32_t)0xFBEAD9C8) /*!< Flash option key1 */
 226 #define FLASH_OPTKEY2              ((uint32_t)0x24252627) /*!< Flash option key2: used with FLASH_OPTKEY1 to
 227                                                                unlock the write access to the option byte block */
 228 /**
 229   * @}
 230   */
 231
 232 /* CMSIS_Legacy */
 233
 234 #if defined ( __ICCARM__ )
 235 #define InterruptType_ACTLR_DISMCYCINT_Msk         IntType_ACTLR_DISMCYCINT_Msk
 236 #endif
 237
 238 /**
 239   * @}
 240   */
 241
 242 /** @defgroup FLASH_Exported_Macros FLASH Exported Macros
 243   * @{
 244   */
 245
 246 /** @defgroup FLASH_Interrupt macros to handle FLASH interrupts
 247   * @{
 248   */
 249 /**
 250   * @brief  Enable/Disable 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
 255   * @retval none
 256   */
 257 #define __HAL_FLASH_ENABLE_IT(__INTERRUPT__)   ((FLASH->PECR) |= (__INTERRUPT__))
 258 #define __HAL_FLASH_DISABLE_IT(__INTERRUPT__)  ((FLASH->PECR) &= ~(uint32_t)(__INTERRUPT__))
 259
 260 /**
 261   * @brief  Get the specified FLASH flag status.
 262   * @param  __FLAG__: specifies the FLASH flag to check.
 263   *   This parameter can be one of the following values:
 264   *            @arg FLASH_FLAG_BSY   :              FLASH Busy flag
 265   *     @arg FLASH_FLAG_EOP:         FLASH End of Operation flag
 266   *     @arg FLASH_FLAG_READY:       FLASH Ready flag after low power mode
 267   *     @arg FLASH_FLAG_ENDHV:       FLASH End of high voltage flag
 268   *     @arg FLASH_FLAG_WRPERR:      FLASH Write protected error flag
 269   *     @arg FLASH_FLAG_PGAERR:      FLASH Programming Alignment error flag
 270   *     @arg FLASH_FLAG_SIZERR:      FLASH Size error flag
 271   *     @arg FLASH_FLAG_OPTVERR:     FLASH Option validity error flag
 272   *     @arg FLASH_FLAG_RDERR:       FLASH Read protected error flag
 273   *     @arg FLASH_FLAG_FWWERR:      FLASH Fetch While Write Error flag
 274   *     @arg FLASH_FLAG_NOTZEROERR:  Not Zero area error flag
 275   * @retval The new state of __FLAG__ (SET or RESET).
 276   */
 277 #define __HAL_FLASH_GET_FLAG(__FLAG__)   (((FLASH->SR) & (__FLAG__)) == (__FLAG__))
 278
 279 /**
 280   * @brief  Clear the specified FLASH flag.
 281   * @param  __FLAG__: specifies the FLASH flags to clear.
 282   *   This parameter can be any combination of the following values:
 283   *     @arg FLASH_FLAG_EOP:          FLASH End of Operation flag
 284   *     @arg FLASH_FLAG_WRPERR:       FLASH Write protected error flag
 285   *     @arg FLASH_FLAG_PGAERR:       FLASH Programming Alignment error flag
 286   *     @arg FLASH_FLAG_SIZERR:       FLASH size error flag
 287   *     @arg FLASH_FLAG_OPTVERR:      FLASH Option validity error flag
 288   *     @arg FLASH_FLAG_RDERR:        FLASH Read protected error flag
 289   *     @arg FLASH_FLAG_FWWERR:       FLASH Fetch While Write Error flag
 290   *     @arg FLASH_FLAG_NOTZEROERR:   Not Zero area error flag
 291   * @retval None
 292   */
 293 #define __HAL_FLASH_CLEAR_FLAG(__FLAG__)   (FLASH->SR = (__FLAG__))
 294
 295 /**
 296   * @}
 297   */
 298
 299 /**
 300   * @}
 301   */
 302
 303 /* Include FLASH HAL Extension module */
 304 #include "stm32l0xx_hal_flash_ex.h"
 305 #include "stm32l0xx_hal_flash_ramfunc.h"
 306
 307 /* Exported functions ------------------------------------------------------- */
 308
 309 /** @defgroup FLASH_Exported_Functions  FLASH Exported functions
 310   * @{
 311   */
 312
 313 /** @defgroup FLASH_Exported_Functions_Group1 Programming operation functions
 314   * @{
 315   */
 316
 317 /**
 318   * @brief  FLASH memory functions that can be executed from FLASH.
 319   */
 320 /* Program operation functions  ***********************************************/
 321 HAL_StatusTypeDef HAL_FLASH_Program(uint32_t TypeProgram, uint32_t Address, uint32_t Data);
 322 HAL_StatusTypeDef HAL_FLASH_Program_IT(uint32_t TypeProgram, uint32_t Address, uint32_t Data);
 323
 324 /* FLASH IRQ handler function   ***********************************************/
 325 void HAL_FLASH_IRQHandler(void);
 326
 327 /* Callbacks in non blocking modes   ******************************************/
 328 void HAL_FLASH_EndOfOperationCallback(uint32_t ReturnValue);
 329 void HAL_FLASH_OperationErrorCallback(uint32_t ReturnValue);
 330
 331 /**
 332   * @}
 333   */
 334
 335 /** @defgroup FLASH_Exported_Functions_Group2 Peripheral Control functions
 336   * @{
 337   */
 338
 339 /* FLASH Memory Programming functions *****************************************/
 340 HAL_StatusTypeDef HAL_FLASH_Unlock(void);
 341 HAL_StatusTypeDef HAL_FLASH_Lock(void);
 342
 343 /* Option Bytes Programming functions *****************************************/
 344 HAL_StatusTypeDef HAL_FLASH_OB_Unlock(void);
 345 HAL_StatusTypeDef HAL_FLASH_OB_Lock(void);
 346 HAL_StatusTypeDef HAL_FLASH_OB_Launch(void);
 347
 348 /**
 349   * @}
 350   */
 351
 352 /** @defgroup FLASH_Exported_Functions_Group3 Peripheral State and Errors functions
 353   * @{
 354   */
 355 /* Peripheral State methods  **************************************************/
 356 uint32_t HAL_FLASH_GetError(void);
 357
 358 /**
 359   * @}
 360   */
 361
 362 /**
 363   * @}
 364   */
 365
 366 /** @defgroup FLASH_Private_Macros FLASH Private Macros
 367   * @{
 368   */
 369
 370 #define IS_FLASH_TYPEPROGRAM(VALUE) ((VALUE) == FLASH_TYPEPROGRAM_WORD)
 371
 372 #define IS_FLASH_LATENCY(__LATENCY__) (((__LATENCY__) == FLASH_LATENCY_0) || \
 373                                    ((__LATENCY__) == FLASH_LATENCY_1))
 374 /**
 375   * @}
 376   */
 377
 378
 379 /** @defgroup FLASH_Private_Functions FLASH Private functions
 380   * @{
 381   */
 382
 383 /**
 384   * @brief  Function used internally by HAL FLASH driver.
 385   */
 386 HAL_StatusTypeDef FLASH_WaitForLastOperation(uint32_t Timeout);
 387 void              FLASH_ErasePage(uint32_t Page_Address);
 388 /**
 389   * @}
 390   */
 391
 392 /**
 393   * @}
 394   */
 395
 396 /**
 397   * @}
 398   */
 399
 400 #ifdef __cplusplus
 401 }
 402 #endif
 403
 404 #endif /* __STM32L0XX_HAL_FLASH_H */
 405
 406 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
 407