stm32g4xx_hal_flash.h

转到该文件的文档。

/**
  ******************************************************************************
  * @file    stm32g4xx_hal_flash.h
  * @author  MCD Application Team
  * @brief   Header file of FLASH HAL module.
  ******************************************************************************
  * @attention
  *
  * Copyright (c) 2019 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 STM32G4xx_HAL_FLASH_H
#define STM32G4xx_HAL_FLASH_H

#ifdef __cplusplus
extern "C" {
#endif

/* Includes ------------------------------------------------------------------*/
#include "stm32g4xx_hal_def.h"

/** @addtogroup STM32G4xx_HAL_Driver
  * @{
  */

/** @addtogroup FLASH
  * @{
  */

/* Exported types ------------------------------------------------------------*/
/** @defgroup FLASH_Exported_Types FLASH导出的类型
  * @{
  */

/**
  * @brief  FLASH擦除结构定义
  */
typedef struct
{
  uint32_t TypeErase;   /*!< 批量擦除或页擦除。
                             该参数可以是@ref FLASH_Type_Erase的值 */
  uint32_t Banks;       /*!< 选择要擦除的bank。
                             该参数必须是@ref FLASH_Banks的值
                             （批量擦除只能使用FLASH_BANK_BOTH） */
  uint32_t Page;        /*!< 禁用页擦除时的初始Flash页。
                             该参数必须是0到(bank中的最大页数-1)之间的值
                             （例如：512KB双bank为127） */
  uint32_t NbPages;     /*!< 要擦除的页数。
                             该参数必须是1到(bank中的最大页数-初始页值)之间的值*/
} FLASH_EraseInitTypeDef;

/**
  * @brief  FLASH选项字节程序结构定义
  */
typedef struct
{
  uint32_t OptionType;     /*!< 要配置的选项字节。
                                该参数可以是@ref FLASH_OB_Type的值的组合 */
  uint32_t WRPArea;        /*!< 要编程的写保护区域（用于OPTIONBYTE_WRP）。
                                同一时间只能编程一个WRP区域。
                                该参数可以是@ref FLASH_OB_WRP_Area的值 */
  uint32_t WRPStartOffset; /*!< 写保护起始偏移量（用于OPTIONBYTE_WRP）。
                                该参数必须是0到(bank中的最大页数-1)之间的值 */
  uint32_t WRPEndOffset;   /*!< 写保护结束偏移量（用于OPTIONBYTE_WRP）。
                                该参数必须是WRRPStartOffset到(bank中的最大页数-1)之间的值 */
  uint32_t RDPLevel;       /*!< 设置读保护级别。（用于OPTIONBYTE_RDP）。
                                该参数可以是@ref FLASH_OB_Read_Protection的值 */
  uint32_t USERType;       /*!< 要配置的用户选项字节（用于OPTIONBYTE_USER）。
                                该参数可以是@ref FLASH_OB_USER_Type的组合 */
  uint32_t USERConfig;     /*!< 用户选项字节的值（用于OPTIONBYTE_USER）。
                                该参数可以是@ref FLASH_OB_USER_BOR_LEVEL,
                                @ref FLASH_OB_USER_nRST_STOP, @ref FLASH_OB_USER_nRST_STANDBY,
                                @ref FLASH_OB_USER_nRST_SHUTDOWN, @ref FLASH_OB_USER_IWDG_SW,
                                @ref FLASH_OB_USER_IWDG_STOP, @ref FLASH_OB_USER_IWDG_STANDBY,
                                @ref FLASH_OB_USER_WWDG_SW, @ref FLASH_OB_USER_BFB2 (*),
                                @ref FLASH_OB_USER_nBOOT1, @ref FLASH_OB_USER_SRAM_PE,
                                @ref FLASH_OB_USER_CCMSRAM_RST的组合
                                @note (*) 取决于设备 */
  uint32_t PCROPConfig;    /*!< PCROP的配置（用于OPTIONBYTE_PCROP）。
                                该参数必须是@ref FLASH_Banks（除了FLASH_BANK_BOTH）
                                和@ref FLASH_OB_PCROP_RDP的组合 */
  uint32_t PCROPStartAddr; /*!< PCROP起始地址（用于OPTIONBYTE_PCROP）。
                                该参数必须在bank的起始和结束之间
                                => 注意bank交换的地址 */
  uint32_t PCROPEndAddr;   /*!< PCROP结束地址（用于OPTIONBYTE_PCROP）。
                                该参数必须在PCROP起始地址和bank结束之间 */
  uint32_t BootEntryPoint; /*!< 设置启动锁（用于OPTIONBYTE_BOOT_LOCK）。
                                该参数可以是@ref FLASH_OB_Boot_Lock的值 */
  uint32_t SecBank;        /*!< 要编程的可保护内存区域的bank（用于OPTIONBYTE_SEC）。
                                同一时间只能编程一个可保护内存区域。
                                该参数可以是以下值之一：
                                FLASH_BANK_1：bank 1中要编程的可保护内存区域
                                FLASH_BANK_2：bank 2中要编程的可保护内存区域（*）
                                @note (*) 取决于设备 */
  uint32_t SecSize;        /*!< 要编程的可保护内存区域的大小（用于OPTIONBYTE_SEC），
                                以页数表示。可保护内存区域从bank的第一页开始。
                                同一时间只能编程一个可保护内存区域。
                                该参数必须是0到(bank中的最大页数-1)之间的值 */
} FLASH_OBProgramInitTypeDef;

/**
  * @brief  FLASH过程结构定义
  */
typedef enum
{
  FLASH_PROC_NONE = 0,
  FLASH_PROC_PAGE_ERASE,
  FLASH_PROC_MASS_ERASE,
  FLASH_PROC_PROGRAM,
  FLASH_PROC_PROGRAM_LAST
} FLASH_ProcedureTypeDef;

/**
  * @brief  FLASH缓存结构定义
  */
typedef enum
{
  FLASH_CACHE_DISABLED = 0,
  FLASH_CACHE_ICACHE_ENABLED,
  FLASH_CACHE_DCACHE_ENABLED,
  FLASH_CACHE_ICACHE_DCACHE_ENABLED
} FLASH_CacheTypeDef;

/**
  * @brief  FLASH句柄结构定义
  */
typedef struct
{
  HAL_LockTypeDef             Lock;              /* FLASH锁定对象 */
  __IO uint32_t               ErrorCode;         /* FLASH错误代码 */
  __IO FLASH_ProcedureTypeDef ProcedureOnGoing;  /* 内部变量，用于指示中断上下文中正在进行的操作 */
  __IO uint32_t               Address;           /* 内部变量，用于保存中断上下文中选择的编程地址 */
  __IO uint32_t               Bank;              /* 内部变量，用于保存中断上下文中擦除期间选择的当前bank */
  __IO uint32_t               Page;              /* 内部变量，用于定义中断上下文中正在擦除的当前页 */
  __IO uint32_t               NbPagesToErase;    /* 内部变量，用于保存中断上下文中剩余的要擦除的页数 */
  __IO FLASH_CacheTypeDef     CacheToReactivate; /* 内部变量，用于指示应重新激活的缓存 */
} FLASH_ProcessType