int/com/lib/STM32F7xx_HAL_Driver/Inc/stm32f7xx_hal_flash.h

   1 /**
   2   ******************************************************************************
   3   * @file    stm32f7xx_hal_flash.h
   4   * @author  MCD Application Team
   5   * @version V1.1.0
   6   * @date    22-April-2016
   7   * @brief   Header file of FLASH HAL module.
   8   ******************************************************************************
   9   * @attention
  10   *
  11   * <h2><center>&copy; COPYRIGHT(c) 2016 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 __STM32F7xx_HAL_FLASH_H
  40 #define __STM32F7xx_HAL_FLASH_H
  41
  42 #ifdef __cplusplus
  43  extern "C" {
  44 #endif
  45
  46 /* Includes ------------------------------------------------------------------*/
  47 #include "stm32f7xx_hal_def.h"
  48
  49 /** @addtogroup STM32F7xx_HAL_Driver
  50   * @{
  51   */
  52
  53 /** @addtogroup FLASH
  54   * @{
  55   */
  56
  57 /* Exported types ------------------------------------------------------------*/
  58 /** @defgroup FLASH_Exported_Types FLASH Exported Types
  59   * @{
  60   */
  61
  62 /**
  63   * @brief  FLASH Procedure structure definition
  64   */
  65 typedef enum
  66 {
  67   FLASH_PROC_NONE = 0U,
  68   FLASH_PROC_SECTERASE,
  69   FLASH_PROC_MASSERASE,
  70   FLASH_PROC_PROGRAM
  71 } FLASH_ProcedureTypeDef;
  72
  73
  74 /**
  75   * @brief  FLASH handle Structure definition
  76   */
  77 typedef struct
  78 {
  79   __IO FLASH_ProcedureTypeDef ProcedureOnGoing;   /* Internal variable to indicate which procedure is ongoing or not in IT context */
  80
  81   __IO uint32_t               NbSectorsToErase;   /* Internal variable to save the remaining sectors to erase in IT context        */
  82
  83   __IO uint8_t                VoltageForErase;    /* Internal variable to provide voltage range selected by user in IT context     */
  84
  85   __IO uint32_t               Sector;             /* Internal variable to define the current sector which is erasing               */
  86
  87   __IO uint32_t               Address;            /* Internal variable to save address selected for program                        */
  88
  89   HAL_LockTypeDef             Lock;               /* FLASH locking object                                                          */
  90
  91   __IO uint32_t               ErrorCode;          /* FLASH error code                                                              */
  92
  93 }FLASH_ProcessTypeDef;
  94
  95 /**
  96   * @}
  97   */
  98
  99 /* Exported constants --------------------------------------------------------*/
 100 /** @defgroup FLASH_Exported_Constants FLASH Exported Constants
 101   * @{
 102   */
 103
 104 /** @defgroup FLASH_Error_Code FLASH Error Code
 105   * @brief    FLASH Error Code
 106   * @{
 107   */
 108 #define HAL_FLASH_ERROR_NONE         ((uint32_t)0x00000000U)    /*!< No error                      */
 109 #define HAL_FLASH_ERROR_ERS          ((uint32_t)0x00000002U)    /*!< Programming Sequence error    */
 110 #define HAL_FLASH_ERROR_PGP          ((uint32_t)0x00000004U)    /*!< Programming Parallelism error */
 111 #define HAL_FLASH_ERROR_PGA          ((uint32_t)0x00000008U)    /*!< Programming Alignment error   */
 112 #define HAL_FLASH_ERROR_WRP          ((uint32_t)0x00000010U)    /*!< Write protection error        */
 113 #define HAL_FLASH_ERROR_OPERATION    ((uint32_t)0x00000020U)    /*!< Operation Error               */
 114 /**
 115   * @}
 116   */
 117
 118 /** @defgroup FLASH_Type_Program FLASH Type Program
 119   * @{
 120   */
 121 #define FLASH_TYPEPROGRAM_BYTE        ((uint32_t)0x00U)  /*!< Program byte (8-bit) at a specified address           */
 122 #define FLASH_TYPEPROGRAM_HALFWORD    ((uint32_t)0x01U)  /*!< Program a half-word (16-bit) at a specified address   */
 123 #define FLASH_TYPEPROGRAM_WORD        ((uint32_t)0x02U)  /*!< Program a word (32-bit) at a specified address        */
 124 #define FLASH_TYPEPROGRAM_DOUBLEWORD  ((uint32_t)0x03U)  /*!< Program a double word (64-bit) at a specified address */
 125 /**
 126   * @}
 127   */
 128
 129 /** @defgroup FLASH_Flag_definition FLASH Flag definition
 130   * @brief Flag definition
 131   * @{
 132   */
 133 #define FLASH_FLAG_EOP                 FLASH_SR_EOP            /*!< FLASH End of Operation flag               */
 134 #define FLASH_FLAG_OPERR               FLASH_SR_OPERR          /*!< FLASH operation Error flag                */
 135 #define FLASH_FLAG_WRPERR              FLASH_SR_WRPERR         /*!< FLASH Write protected error flag          */
 136 #define FLASH_FLAG_PGAERR              FLASH_SR_PGAERR         /*!< FLASH Programming Alignment error flag    */
 137 #define FLASH_FLAG_PGPERR              FLASH_SR_PGPERR         /*!< FLASH Programming Parallelism error flag  */
 138 #define FLASH_FLAG_ERSERR              FLASH_SR_ERSERR         /*!< FLASH Erasing Sequence error flag         */
 139 #define FLASH_FLAG_BSY                 FLASH_SR_BSY            /*!< FLASH Busy flag                           */
 140 /**
 141   * @}
 142   */
 143
 144 /** @defgroup FLASH_Interrupt_definition FLASH Interrupt definition
 145   * @brief FLASH Interrupt definition
 146   * @{
 147   */
 148 #define FLASH_IT_EOP                   FLASH_CR_EOPIE          /*!< End of FLASH Operation Interrupt source */
 149 #define FLASH_IT_ERR                   ((uint32_t)0x02000000U)  /*!< Error Interrupt source                  */
 150 /**
 151   * @}
 152   */
 153
 154 /** @defgroup FLASH_Program_Parallelism FLASH Program Parallelism
 155   * @{
 156   */
 157 #define FLASH_PSIZE_BYTE           ((uint32_t)0x00000000U)
 158 #define FLASH_PSIZE_HALF_WORD      ((uint32_t)FLASH_CR_PSIZE_0)
 159 #define FLASH_PSIZE_WORD           ((uint32_t)FLASH_CR_PSIZE_1)
 160 #define FLASH_PSIZE_DOUBLE_WORD    ((uint32_t)FLASH_CR_PSIZE)
 161 #define CR_PSIZE_MASK              ((uint32_t)0xFFFFFCFFU)
 162 /**
 163   * @}
 164   */
 165
 166 /** @defgroup FLASH_Keys FLASH Keys
 167   * @{
 168   */
 169 #define FLASH_KEY1               ((uint32_t)0x45670123U)
 170 #define FLASH_KEY2               ((uint32_t)0xCDEF89ABU)
 171 #define FLASH_OPT_KEY1           ((uint32_t)0x08192A3BU)
 172 #define FLASH_OPT_KEY2           ((uint32_t)0x4C5D6E7FU)
 173 /**
 174   * @}
 175   */
 176
 177 /** @defgroup FLASH_Sectors FLASH Sectors
 178   * @{
 179   */
 180 #define FLASH_SECTOR_0           ((uint32_t)0U) /*!< Sector Number 0   */
 181 #define FLASH_SECTOR_1           ((uint32_t)1U) /*!< Sector Number 1   */
 182 #define FLASH_SECTOR_2           ((uint32_t)2U) /*!< Sector Number 2   */
 183 #define FLASH_SECTOR_3           ((uint32_t)3U) /*!< Sector Number 3   */
 184 #define FLASH_SECTOR_4           ((uint32_t)4U) /*!< Sector Number 4   */
 185 #define FLASH_SECTOR_5           ((uint32_t)5U) /*!< Sector Number 5   */
 186 #define FLASH_SECTOR_6           ((uint32_t)6U) /*!< Sector Number 6   */
 187 #define FLASH_SECTOR_7           ((uint32_t)7U) /*!< Sector Number 7   */
 188 /**
 189   * @}
 190   */
 191
 192 /**
 193   * @}
 194   */
 195
 196 /* Exported macro ------------------------------------------------------------*/
 197 /** @defgroup FLASH_Exported_Macros FLASH Exported Macros
 198   * @{
 199   */
 200 /**
 201   * @brief  Set the FLASH Latency.
 202   * @param  __LATENCY__: FLASH Latency
 203   *         The value of this parameter depend on device used within the same series
 204   * @retval none
 205   */
 206 #define __HAL_FLASH_SET_LATENCY(__LATENCY__) \
 207                   MODIFY_REG(FLASH->ACR, FLASH_ACR_LATENCY, (uint32_t)(__LATENCY__))
 208
 209 /**
 210   * @brief  Get the FLASH Latency.
 211   * @retval FLASH Latency
 212   *          The value of this parameter depend on device used within the same series
 213   */
 214 #define __HAL_FLASH_GET_LATENCY()     (READ_BIT((FLASH->ACR), FLASH_ACR_LATENCY))
 215
 216 /**
 217   * @brief  Enable the FLASH prefetch buffer.
 218   * @retval none
 219   */
 220 #define __HAL_FLASH_PREFETCH_BUFFER_ENABLE()  (FLASH->ACR |= FLASH_ACR_PRFTEN)
 221
 222 /**
 223   * @brief  Disable the FLASH prefetch buffer.
 224   * @retval none
 225   */
 226 #define __HAL_FLASH_PREFETCH_BUFFER_DISABLE()   (FLASH->ACR &= (~FLASH_ACR_PRFTEN))
 227
 228 /**
 229   * @brief  Enable the FLASH Adaptive Real-Time memory accelerator.
 230   * @note   The ART accelerator is available only for flash access on ITCM interface.
 231   * @retval none
 232   */
 233 #define __HAL_FLASH_ART_ENABLE()  SET_BIT(FLASH->ACR, FLASH_ACR_ARTEN)
 234
 235 /**
 236   * @brief  Disable the FLASH Adaptive Real-Time memory accelerator.
 237   * @retval none
 238   */
 239 #define __HAL_FLASH_ART_DISABLE()   CLEAR_BIT(FLASH->ACR, FLASH_ACR_ARTEN)
 240
 241 /**
 242   * @brief  Resets the FLASH Adaptive Real-Time memory accelerator.
 243   * @note   This function must be used only when the Adaptive Real-Time memory accelerator
 244   *         is disabled.
 245   * @retval None
 246   */
 247 #define __HAL_FLASH_ART_RESET()  (FLASH->ACR |= FLASH_ACR_ARTRST)
 248
 249 /**
 250   * @brief  Enable 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->CR |= (__INTERRUPT__))
 258
 259 /**
 260   * @brief  Disable the specified FLASH interrupt.
 261   * @param  __INTERRUPT__ : FLASH interrupt
 262   *         This parameter can be any combination of the following values:
 263   *     @arg FLASH_IT_EOP: End of FLASH Operation Interrupt
 264   *     @arg FLASH_IT_ERR: Error Interrupt
 265   * @retval none
 266   */
 267 #define __HAL_FLASH_DISABLE_IT(__INTERRUPT__)  (FLASH->CR &= ~(uint32_t)(__INTERRUPT__))
 268
 269 /**
 270   * @brief  Get the specified FLASH flag status.
 271   * @param  __FLAG__: specifies the FLASH flag to check.
 272   *          This parameter can be one of the following values:
 273   *            @arg FLASH_FLAG_EOP   : FLASH End of Operation flag
 274   *            @arg FLASH_FLAG_OPERR : FLASH operation Error flag
 275   *            @arg FLASH_FLAG_WRPERR: FLASH Write protected error flag
 276   *            @arg FLASH_FLAG_PGAERR: FLASH Programming Alignment error flag
 277   *            @arg FLASH_FLAG_PGPERR: FLASH Programming Parallelism error flag
 278   *            @arg FLASH_FLAG_ERSERR : FLASH Erasing Sequence error flag
 279   *            @arg FLASH_FLAG_BSY   : FLASH Busy flag
 280   * @retval The new state of __FLAG__ (SET or RESET).
 281   */
 282 #define __HAL_FLASH_GET_FLAG(__FLAG__)   ((FLASH->SR & (__FLAG__)))
 283
 284 /**
 285   * @brief  Clear the specified FLASH flag.
 286   * @param  __FLAG__: specifies the FLASH flags to clear.
 287   *          This parameter can be any combination of the following values:
 288   *            @arg FLASH_FLAG_EOP   : FLASH End of Operation flag
 289   *            @arg FLASH_FLAG_OPERR : FLASH operation Error flag
 290   *            @arg FLASH_FLAG_WRPERR: FLASH Write protected error flag
 291   *            @arg FLASH_FLAG_PGAERR: FLASH Programming Alignment error flag
 292   *            @arg FLASH_FLAG_PGPERR: FLASH Programming Parallelism error flag
 293   *            @arg FLASH_FLAG_ERSERR : FLASH Erasing Sequence error flag
 294   * @retval none
 295   */
 296 #define __HAL_FLASH_CLEAR_FLAG(__FLAG__)   (FLASH->SR = (__FLAG__))
 297 /**
 298   * @}
 299   */
 300
 301 /* Include FLASH HAL Extension module */
 302 #include "stm32f7xx_hal_flash_ex.h"
 303
 304 /* Exported functions --------------------------------------------------------*/
 305 /** @addtogroup FLASH_Exported_Functions
 306   * @{
 307   */
 308 /** @addtogroup FLASH_Exported_Functions_Group1
 309   * @{
 310   */
 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);
 314 /* FLASH IRQ handler method */
 315 void HAL_FLASH_IRQHandler(void);
 316 /* Callbacks in non blocking modes */
 317 void HAL_FLASH_EndOfOperationCallback(uint32_t ReturnValue);
 318 void HAL_FLASH_OperationErrorCallback(uint32_t ReturnValue);
 319 /**
 320   * @}
 321   */
 322
 323 /** @addtogroup FLASH_Exported_Functions_Group2
 324   * @{
 325   */
 326 /* Peripheral Control functions  **********************************************/
 327 HAL_StatusTypeDef HAL_FLASH_Unlock(void);
 328 HAL_StatusTypeDef HAL_FLASH_Lock(void);
 329 HAL_StatusTypeDef HAL_FLASH_OB_Unlock(void);
 330 HAL_StatusTypeDef HAL_FLASH_OB_Lock(void);
 331 /* Option bytes control */
 332 HAL_StatusTypeDef HAL_FLASH_OB_Launch(void);
 333 /**
 334   * @}
 335   */
 336
 337 /** @addtogroup FLASH_Exported_Functions_Group3
 338   * @{
 339   */
 340 /* Peripheral State functions  ************************************************/
 341 uint32_t HAL_FLASH_GetError(void);
 342 HAL_StatusTypeDef FLASH_WaitForLastOperation(uint32_t Timeout);
 343 /**
 344   * @}
 345   */
 346
 347 /**
 348   * @}
 349   */
 350 /* Private types -------------------------------------------------------------*/
 351 /* Private variables ---------------------------------------------------------*/
 352 /** @defgroup FLASH_Private_Variables FLASH Private Variables
 353   * @{
 354   */
 355
 356 /**
 357   * @}
 358   */
 359 /* Private constants ---------------------------------------------------------*/
 360 /** @defgroup FLASH_Private_Constants FLASH Private Constants
 361   * @{
 362   */
 363
 364 /**
 365   * @brief   OPTCR register byte 1 (Bits[15:8]) base address
 366   */
 367 #define OPTCR_BYTE1_ADDRESS         ((uint32_t)0x40023C15)
 368
 369 /**
 370   * @}
 371   */
 372
 373 /* Private macros ------------------------------------------------------------*/
 374 /** @defgroup FLASH_Private_Macros FLASH Private Macros
 375   * @{
 376   */
 377
 378 /** @defgroup FLASH_IS_FLASH_Definitions FLASH Private macros to check input parameters
 379   * @{
 380   */
 381 #define IS_FLASH_TYPEPROGRAM(VALUE)(((VALUE) == FLASH_TYPEPROGRAM_BYTE) || \
 382                                     ((VALUE) == FLASH_TYPEPROGRAM_HALFWORD) || \
 383                                     ((VALUE) == FLASH_TYPEPROGRAM_WORD) || \
 384                                     ((VALUE) == FLASH_TYPEPROGRAM_DOUBLEWORD))
 385 /**
 386   * @}
 387   */
 388
 389 /**
 390   * @}
 391   */
 392
 393 /* Private functions ---------------------------------------------------------*/
 394 /** @defgroup FLASH_Private_Functions FLASH Private Functions
 395   * @{
 396   */
 397
 398 /**
 399   * @}
 400   */
 401
 402 /**
 403   * @}
 404   */
 405
 406 /**
 407   * @}
 408   */
 409
 410 #ifdef __cplusplus
 411 }
 412 #endif
 413
 414 #endif /* __STM32F7xx_HAL_FLASH_H */
 415
 416 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/