stm32g4xx_ hal_flash_ex.c

转到此文件的文档。

/**
  ******************************************************************************
  * @file    stm32g4xx_ hal_flash_ex.c
  * @author  MCD应用团队
  * @brief   扩展FLASH HAL模块驱动。
  *          本文件提供固件函数，用于管理FLASH扩展外设的以下功能：
  *           + 扩展编程操作函数
  *
  @endverbatim
  ==============================================================================
                   ##### Flash扩展功能 #####
  ==============================================================================

  [..] 与其他旧设备相比，STM32G4xx设备的FLASH接口包含以下附加功能

       (+) 容量高达512 Kbytes，采用双bank架构，支持读-while-写
           能力(RWW)
       (+) 双bank 64位存储器组织，可配置为单bank 128位
       (+) 保护区包括WRP、PCROP和安全存储器

                        ##### 如何使用此驱动 #####
  ==============================================================================
  [..] 本驱动提供函数用于配置和编程所有STM32G4xx设备的FLASH存储器。包含以下功能：
      (#) Flash存储器擦除函数：
           (++) 使用HAL_ FLASH_ Unlock()和
                HAL_ FLASH_ Lock()函数锁定和解锁FLASH接口
           (++) 擦除函数：擦除页面或整片擦除bank
           (++) 有两种擦除模式：
             (+++) 轮询模式使用HAL_ FLASHEx_ Erase()
             (+++) 中断模式使用HAL_ FLASHEx_ Erase_ IT()

      (#) 选项字节编程函数：使用HAL_ FLASHEx_ OBProgram()来：
        (++) 配置写保护区(WRP)
        (++) 设置读保护级别(RDP)
        (++) 编程用户选项字节
        (++) 配置专有代码读出保护区(PCROP)
        (++) 配置安全存储器区
        (++) 配置启动锁

      (#) 获取选项字节配置函数：使用HAL_ FLASHEx_ OBGetConfig()来：
        (++) 获取写保护区(WRP)的配置
        (++) 获取读保护级别(RDP)
        (++) 获取用户选项字节的值
        (++) 获取专有代码读出保护区(PCROP)的配置
        (++) 获取安全存储器区的配置
        (++) 获取启动锁的状态

      (#) 安全存储器区激活：使用HAL_ FLASHEx_ EnableSecMemProtection()
        (++) 拒绝访问安全存储器区

      (#) 启用或禁用调试器：使用HAL_ FLASHEx_ EnableDebugger()或
          HAL_ FLASHEx_ DisableDebugger()

  @endverbatim
  ******************************************************************************
  * @attention
  *
  * 版权所有(c) 2019 STMicroelectronics.
  * 保留所有权利。
  *
  * 本软件按照可在LICENSE文件中找到的条款授权，您可以在我
  * 的软件组件的根目录中找到该文件。
  * 如果本软件未附带LICENSE文件，则按原样提供。
  ******************************************************************************
  */

/* 头文件包含 ------------------------------------------------------------------*/
#include "stm32g4xx_hal.h"

/** @addtogroup STM32G4xx_ HAL_驱动
  * @{
  */

/** @defgroup FLASHEx FLASHEx
  * @brief FLASH扩展HAL模块驱动
  * @{
  */

#ifdef HAL_ FLASH_ MODULE_ ENABLED

/* 私有类型定义 -----------------------------------------------------------*/
/* 私有常量定义 ------------------------------------------------------------*/
/* 私有宏定义 -------------------------------------------------------------*/
/* 私有变量定义 ---------------------------------------------------------*/
/* 私有函数原型 -----------------------------------------------*/
/** @defgroup FLASHEx_私有函数 FLASHEx私有函数
  * @{
  */
static void              FLASH_ MassErase(uint32_t Banks);
static HAL_StatusTypeDef FLASH_ OB_ WRPConfig(uint32_t WRPArea, uint32_t WRPStartOffset, uint32_t WRDPEndOffset);
static HAL_StatusTypeDef FLASH_ OB_ RDPConfig(uint32_t RDPLevel);
static HAL_StatusTypeDef FLASH_ OB_ UserConfig(uint32_t UserType, uint32_t UserConfig);
static HAL_StatusTypeDef FLASH_ OB_ PCROPConfig(uint32_t PCROPConfig, uint32_t PCROPStartAddr, uint32_t PCROPEndAddr);
static void              FLASH_ OB_ GetWRP(uint32_t WRPArea, uint32_t *WRPStartOffset, uint32_t *WRDPEndOffset);
static uint32_t          FLASH_ OB_ GetRDP(void);
static uint32_t          FLASH_ OB_ GetUser(void);
static void              FLASH_ OB_ GetPCROP(uint32_t *PCROPConfig, uint32_t *PCROPStartAddr, uint32_t *PCROPEndAddr);
static HAL_StatusTypeDef FLASH_ OB_ SecMemConfig(uint32_t SecMemBank, uint32_t SecMemSize);
static void              FLASH_ OB_ GetSecMem(uint32_t SecMemBank, uint32_t *SecMemSize);
static HAL_StatusTypeDef FLASH_ OB_ BootLockConfig(uint32_t BootLockConfig);
static uint32_t          FLASH_ OB_ GetBootLock(void);

/**
  * @}
  */

/* 导出的函数 -------------------------------------------------------*/
/** @defgroup FLASHEx_导出的函数 FLASHEx导出的函数
  * @{
  */

/** @defgroup FLASHEx_导出的函数_组1 扩展IO操作函数
  * @brief   扩展IO操作函数
  *
@verbatim
 ===============================================================================
                ##### 扩展编程操作函数 #####
 ===============================================================================
    [..]
    本节提供一组函数用于管理扩展FLASH编程操作。

@endverbatim
  * @{
  */
/**
  * @brief  执行整片擦除或擦除指定的FLASH存储器页面。
  * @param[in]  pEraseInit 指向FLASH_ EraseInitTypeDef结构的指针，包含
  *         用于擦除的配置信息。
  * @param[out]  PageError 指向变量的指针，在发生错误时包含
  *         错误页面的配置信息(0xFFFFFFFF表示所有
  *         页面都已正确擦除)。
  * @retval HAL_状态
  */
HAL_StatusTypeDef HAL_ FLASHEx_ Erase(FLASH_ EraseInitTypeDef *pEraseInit, uint32_t *PageError)
{
  HAL_StatusTypeDef status;
  uint32_t page_ index;

  /* 检查参数 */
  assert_ param(IS_ FLASH_ TYPEERASE(pEraseInit->TypeErase));

  /* 处理锁定 */
  __HAL_ LOCK(&pFlash);

  /* 等待上一个操作完成 */
  status = FLASH_ WaitForLastOperation((uint32_t)FLASH_ TIMEOUT_ VALUE);

  if (status == HAL_ OK)
  {
    pFlash.ErrorCode = HAL_ FLASH_ ERROR_ NONE;

    /* 如果缓存已激活则停用它以避免数据行为异常 */
    if (READ_ BIT(FLASH->ACR, FLASH_ ACR_ ICEN) != 0U)
    {
      if (READ_ BIT(FLASH->ACR, FLASH_ ACR_ DCEN) != 0U)
      {
        /* 禁用数据缓存  */
        __HAL_ FLASH_ DATA_ CACHE_ DISABLE();
        pFlash.CacheToReactivate = FLASH_ CACHE_ ICACHE_ DCACHE_ ENABLED;
      }
      else
      {
        pFlash.CacheToReactivate = FLASH_ CACHE_ ICACHE_ ENABLED;
      }
    }
    else if (READ_ BIT(FLASH->ACR, FLASH_ ACR_ DCEN) != 0U)
    {
      /* 禁用数据缓存  */
      __HAL_ FLASH_ DATA_ CACHE_ DISABLE();
      pFlash.CacheToReactivate = FLASH_ CACHE_ DCACHE_ ENABLED;
    }
    else
    {
      pFlash.CacheToReactivate = FLASH_ CACHE_ DISABLED;
    }

    if (pEraseInit->TypeErase == FLASH_ TYPEERASE_ MASSERASE)
    {
      /* 执行整片擦除 */
      FLASH_ MassErase(pEraseInit->