stm32g4xx_hal_sram.c

跳转到本文档的文件说明。

/**
  ******************************************************************************
  * @file    stm32g4xx_hal_sram.c
  * @author  MCD 应用团队
  * @brief   SRAM HAL 模块驱动程序。
  *          此文件提供了驱动用作外部设备的 SRAM 存储器的通用固件。
  *
  ******************************************************************************
  * @attention
  *
  * 版权所有 (c) 2019 STMicroelectronics。
  * 保留所有权利。
  *
  * 本软件根据可在本软件组件根目录的 LICENSE 文件中找到的条款进行许可。
  * 如果没有随附此软件的 LICENSE 文件，则按“原样”提供。
  *
  ******************************************************************************
  @verbatim
  ==============================================================================
                          ##### 如何使用此驱动程序 #####
  ==============================================================================
  [..]
    此驱动程序是一个通用的分层驱动程序，包含一组用于控制 SRAM 存储器的 API。
    它使用 FMC 层函数与 SRAM 设备进行接口。
    配置 FMC 以与 SRAM/PSRAM 存储器接口，应遵循以下顺序：

   (#) 声明一个 SRAM_HandleTypeDef 句柄结构，例如：
          SRAM_HandleTypeDef  hsram; 并且：

       (++) 使用结构成员允许的值填充 SRAM_HandleTypeDef 句柄的 "Init" 字段。

       (++) 使用 NOR 或 SRAM 设备的预定义基址寄存器实例填充 SRAM_HandleTypeDef 句柄的 "Instance" 字段。

       (++) 使用 NOR 或 SRAM 扩展模式的预定义基址寄存器实例填充 SRAM_HandleTypeDef 句柄的 "Extended" 字段。

   (#) 声明两个 FMC_NORSRAM_TimingTypeDef 结构，分别用于普通模式和扩展模式时序；例如：
          FMC_NORSRAM_TimingTypeDef  Timing 和 FMC_NORSRAM_TimingTypeDef  ExTiming；
      并使用结构成员允许的值填充其字段。

   (#) 通过调用函数 HAL_SRAM_Init() 初始化 SRAM 控制器。此函数
      执行以下顺序：

       (##) 使用函数 HAL_SRAM_MspInit() 进行 MSP 硬件层配置
       (##) 使用 FMC NORSRAM 接口函数 FMC_NORSRAM_Init() 进行控制寄存器配置
       (##) 使用 FMC NORSRAM 接口函数 FMC_NORSRAM_Timing_Init() 进行时序寄存器配置
       (##) 使用 FMC NORSRAM 接口函数 FMC_NORSRAM_Extended_Timing_Init() 进行扩展模式时序寄存器配置
       (##) 使用宏 __FMC_NORSRAM_ENABLE() 使能 SRAM 设备

   (#) 在此阶段，您可以对连接到 NOR/SRAM 存储体的存储器执行读/写访问。
      您可以使用以下 API 进行轮询或 DMA 传输：
       (++) HAL_SRAM_Read()/HAL_SRAM_Write() 用于轮询读/写访问
       (++) HAL_SRAM_Read_DMA()/HAL_SRAM_Write_DMA() 用于 DMA 读/写传输

   (#) 您还可以通过调用控制 API HAL_SRAM_WriteOperation_Enable()/
      HAL_SRAM_WriteOperation_Disable() 来控制 SRAM 设备，以分别使能/禁止 SRAM 写操作。

   (#) 您可以通过调用函数 HAL_SRAM_GetState() 持续监控 SRAM 设备的 HAL 状态。

       *** 回调注册 ***
    =============================================
    [..]
      编译定义 USE_HAL_SRAM_REGISTER_CALLBACKS 在设置为 1 时，允许用户动态配置驱动程序回调。

      使用函数 HAL_SRAM_RegisterCallback() 注册用户回调，
      它允许注册以下回调：
        (+) MspInitCallback    : SRAM MspInit。
        (+) MspDeInitCallback  : SRAM MspDeInit。
      此函数将 HAL 外设句柄、回调 ID 和指向用户回调函数的指针作为参数。

      使用函数 HAL_SRAM_UnRegisterCallback() 将回调重置为默认的弱（可重写）函数。
      它允许重置以下回调：
        (+) MspInitCallback    : SRAM MspInit。
        (+) MspDeInitCallback  : SRAM MspDeInit。
      此函数将 HAL 外设句柄和回调 ID 作为参数。

      默认情况下，在 HAL_SRAM_Init 之后，如果状态为 HAL_SRAM_STATE_RESET，
      所有回调都会重置为相应的传统弱（可重写）函数。
      但 MspInit 和 MspDeInit 回调例外，它们分别在 HAL_SRAM_Init
      和 HAL_SRAM_DeInit 中重置为传统的弱（可重写）函数，前提是这些回调为空（未预先注册）。
      如果不是，MspInit 或 MspDeInit 不为空，则 HAL_SRAM_Init 和 HAL_SRAM_DeInit
      将保留并使用用户预先注册的 MspInit/MspDeInit 回调。

      回调只能在 READY 状态下注册/注销。
      但 MspInit/MspDeInit 回调例外，它们可以在 READY 或 RESET 状态下注册/注销，
      因此已注册的（用户）MspInit/DeInit 回调可以在 Init/DeInit 期间使用。
      在这种情况下，在调用 HAL_SRAM_DeInit 或 HAL_SRAM_Init 函数之前，
      请先使用 HAL_SRAM_RegisterCallback 注册 MspInit/MspDeInit 用户回调。

      当编译定义 USE_HAL_SRAM_REGISTER_CALLBACKS 设置为 0 或未定义时，
      回调注册功能不可用，并使用弱（可重写）回调。

  @endverbatim
  ******************************************************************************
  */

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

#if defined(FMC_BANK1)

/** @addtogroup STM32G4xx_HAL_Driver
  * @{
  */

#ifdef HAL_SRAM_MODULE_ENABLED

/** @defgroup SRAM SRAM
  * @brief SRAM 驱动程序模块
  * @{
  */

/* Private typedef -----------------------------------------------------------*/
/* Private define ------------------------------------------------------------*/
/* Private macro -------------------------------------------------------------*/
/* Private variables ---------------------------------------------------------*/
/* Private function prototypes -----------------------------------------------*/
/** @addtogroup SRAM_Private_Functions SRAM 私有函数
  * @{
  */
static void SRAM_DMACplt(DMA_HandleTypeDef *hdma);
static void SRAM_DMACpltProt(DMA_HandleTypeDef *hdma);
static void SRAM_DMAError(DMA_HandleTypeDef *hdma);
/**
  * @}
  */

/* Exported functions --------------------------------------------------------*/

/** @defgroup SRAM_Exported_Functions SRAM 导出函数
  * @{
  */

/** @defgroup SRAM_Exported_Functions_Group1 初始化和反初始化函数
  * @brief    初始化和配置函数。
  *
  @verbatim
  ==============================================================================
           ##### SRAM 初始化和反初始化函数 #####
  ==============================================================================
    [..]  本节提供用于初始化/反初始化 SRAM 存储器的函数。

@endverbatim
  * @{
  */

/**
  * @brief  执行 SRAM 设备初始化序列
  * @param  hsram 指向包含 SRAM 模块配置信息的 SRAM_HandleTypeDef 结构的指针。
  * @param  Timing 指向 SRAM 控制时序结构的指针
  * @param  ExtTiming 指向 SRAM 扩展模式时序结构的指针
  * @retval HAL 状态
  */
HAL_StatusTypeDef HAL_SRAM_Init(SRAM_HandleTypeDef *hsram, FMC_NORSRAM_TimingTypeDef *Timing,
                                FMC_NORSRAM_TimingTypeDef *ExtTiming)
{
  /* 检查 SRAM 句柄参数 */
  if (hsram == NULL)
  {
    return HAL_ERROR;
  }

  if (hsram->State == HAL_SRAM_STATE_RESET)
  {
    /* 分配锁资源并初始化 */
    hsram->Lock = HAL_UNLOCKED;

#if (USE_HAL_SRAM_REGISTER_CALLBACKS == 1)
    if (hsram->MspInitCallback == NULL)
    {
      hsram->MspInitCallback = HAL_SRAM_MspInit;
    }
    hsram->DmaXferCpltCallback = HAL_SRAM_DMA_XferCpltCallback;
    hsram->DmaXferErrorCallback = HAL_SRAM_DMA_XferErrorCallback;

    /* 初始化底层硬件 */
    hsram->MspInitCallback(hsram);
#else
    /* 初始化底层硬件（MSP） */
    HAL_SRAM_MspInit(hsram);
#endif /* USE_HAL_SRAM_REGISTER_CALLBACKS */
  }

  /* 初始化 SRAM 控制接口 */
  (void)FMC_NORSRAM_Init(hsram->Instance, &(hsram->Init));

  /* 初始化 SRAM 时序接口 */
  (void)FMC_NORSRAM_Timing_Init(hsram->Instance, Timing, hsram->Init.NSBank);

  /* 初始化 SRAM 扩展模式时序接口 */
  (void)FMC_NORSRAM_Extended_Timing_Init(hsram->Extended, ExtTiming, hsram->Init.NSBank,
                                         hsram->Init.ExtendedMode);

  /* 使能 NORSRAM 设备 */
  __FMC_NORSRAM_ENABLE(hsram->Instance, hsram->Init.NSBank);

  /* 初始化 SRAM 控制器状态 */
  hsram->State = HAL_SRAM_STATE_READY;

  return HAL_OK;
}

/**
  * @brief  执行 SRAM 设备反初始化序列。
  * @param  hsram 指向包含 SRAM 模块配置信息的 SRAM_HandleTypeDef 结构的指针。
  * @retval HAL 状态
  */
HAL_StatusTypeDef HAL_SRAM_DeInit(SRAM_HandleTypeDef *hsram)
{
#if (USE_HAL_SRAM_REGISTER_CALLBACKS == 1)
  if (hsram->MspDeInitCallback == NULL)
  {
    hsram->MspDeInitCallback = HAL_SRAM_MspDeInit;
  }

  /* 反初始化底层硬件 */
  hsram->MspDeInitCallback(hsram);
#else