stm32g4xx_hal_nor.h

转到此文件的文档。

/**
  ******************************************************************************
  * @file    stm32g4xx_hal_nor.h
  * @author  MCD Application Team
  * @brief   NOR HAL 模块的头文件。
  ******************************************************************************
  * @attention
  *
  * Copyright (c) 2019 STMicroelectronics.
  * 保留所有权利。
  *
  * 本软件的许可条款可在本软件组件根目录下的 LICENSE 文件中找到。
  * 如果本软件未附带 LICENSE 文件，则按原样提供。
  *
  ******************************************************************************
  */
  */

/* 定义以防止递归包含 -------------------------------------*/
#ifndef STM32G4xx_HAL_NOR_H
#define STM32G4xx_HAL_NOR_H

#ifdef __cplusplus
extern "C" {
#endif

#if defined(FMC_BANK1)

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

/** @addtogroup STM32G4xx_HAL_Driver
  * @{
  */

/** @addtogroup NOR
  * @{
  */

/* 导出的类型定义 ----------------------------------------------------------*/
/** @defgroup NOR_Exported_Types NOR 导出的类型
  * @{
  */

/**
  * @brief  HAL SRAM 状态结构定义
  */
typedef enum
{
  HAL_NOR_STATE_RESET             = 0x00U,  /*!< NOR 尚未初始化或已禁用  */
  HAL_NOR_STATE_READY             = 0x01U,  /*!< NOR 已初始化并准备就绪    */
  HAL_NOR_STATE_BUSY              = 0x02U,  /*!< NOR 内部处理正在进行中   */
  HAL_NOR_STATE_ERROR             = 0x03U,  /*!< NOR 错误状态                      */
  HAL_NOR_STATE_PROTECTED         = 0x04U   /*!< NOR NORSRAM 设备写保护   */
} HAL_NOR_StateTypeDef;

/**
  * @brief  FMC NOR 状态类型定义
  */
typedef enum
{
  HAL_NOR_STATUS_SUCCESS  = 0U,
  HAL_NOR_STATUS_ONGOING,
  HAL_NOR_STATUS_ERROR,
  HAL_NOR_STATUS_TIMEOUT
} HAL_NOR_StatusTypeDef;

/**
  * @brief  FMC NOR ID 类型定义
  */
typedef struct
{
  uint16_t Manufacturer_Code;  /*!< 定义用于识别存储器的设备制造商代码       */

  uint16_t Device_Code1;

  uint16_t Device_Code2;

  uint16_t Device_Code3;       /*!< 定义用于识别存储器的设备代码。
                                    这些代码可以通过设置特定的控制信号和地址进行读取操作来访问。
                                    也可以通过发出自动选择命令来访问                                                   */
                                    */
} NOR_IDTypeDef;

/**
  * @brief  FMC NOR CFI 类型定义
  */
typedef struct
{
  /*!< 定义存储在存储器通用闪存接口中的信息，
       其中包含各种电气和时序参数的描述、
       密度信息以及存储器支持的功能                   */

  uint16_t CFI_1;

  uint16_t CFI_2;

  uint16_t CFI_3;

  uint16_t CFI_4;
} NOR_CFITypeDef;

/**
  * @brief  NOR 句柄结构定义
  */
#if (USE_HAL_NOR_REGISTER_CALLBACKS == 1)
typedef struct __NOR_HandleTypeDef
#else
typedef struct
#endif /* USE_HAL_NOR_REGISTER_CALLBACKS  */

{
  FMC_NORSRAM_TypeDef           *Instance;    /*!< 寄存器基地址                        */

  FMC_NORSRAM_EXTENDED_TypeDef  *Extended;    /*!< 扩展模式寄存器基地址          */

  FMC_NORSRAM_InitTypeDef       Init;         /*!< NOR 设备控制配置参数  */

  HAL_LockTypeDef               Lock;         /*!< NOR 锁定对象                           */

  __IO HAL_NOR_StateTypeDef     State;        /*!< NOR 设备访问状态                      */

  uint32_t                      CommandSet;   /*!< NOR 算法命令集和控制        */

#if (USE_HAL_NOR_REGISTER_CALLBACKS == 1)
  void (* MspInitCallback)(struct __NOR_HandleTypeDef *hnor);               /*!< NOR Msp 初始化回调              */
  void (* MspDeInitCallback)(struct __NOR_HandleTypeDef *hnor);             /*!< NOR Msp 反初始化回调            */
#endif /* USE_HAL_NOR_REGISTER_CALLBACKS */
} NOR_HandleTypeDef;

#if (USE_HAL_NOR_REGISTER_CALLBACKS == 1)
/**
  * @brief  HAL NOR 回调 ID 枚举定义
  */
typedef enum
{
  HAL_NOR_MSP_INIT_CB_ID       = 0x00U,  /*!< NOR MspInit 回调 ID          */
  HAL_NOR_MSP_DEINIT_CB_ID     = 0x01U   /*!< NOR MspDeInit 回调 ID        */
} HAL_NOR_CallbackIDTypeDef;

/**
  * @brief  HAL NOR 回调指针定义
  */
typedef void (*pNOR_CallbackTypeDef)(NOR_HandleTypeDef *hnor);
#endif /* USE_HAL_NOR_REGISTER_CALLBACKS */
/**
  * @}
  */

/* 导出的常量 --------------------------------------------------------*/
/* 导出的宏 ------------------------------------------------------------*/
/** @defgroup NOR_Exported_Macros NOR 导出的宏
  * @{
  */
/** @brief 重置 NOR 句柄状态
  * @param  __HANDLE__ 指定 NOR 句柄。
  * @retval 无
  */
#if (USE_HAL_NOR_REGISTER_CALLBACKS == 1)
#define __HAL_NOR_RESET_HANDLE_STATE(__HANDLE__)          do {                                             \
                                                               (__HANDLE__)->State = HAL_NOR_STATE_RESET;  \
                                                               (__HANDLE__)->MspInitCallback = NULL;       \
                                                               (__HANDLE__)->MspDeInitCallback = NULL;     \
                                                             } while(0)
#else
#define __HAL_NOR_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_NOR_STATE_RESET)
#endif /* USE_HAL_NOR_REGISTER_CALLBACKS */
/**
  * @}
  */

/* 导出的函数 --------------------------------------------------------*/
/** @addtogroup NOR_Exported_Functions NOR 导出的函数
  * @{
  */

/** @addtogroup NOR_Exported_Functions_Group1 初始化和反初始化函数
  * @{
  */

/* 初始化/反初始化函数  ********************************/
HAL_StatusTypeDef HAL_NOR_Init(NOR_HandleTypeDef *hnor, FMC_NORSRAM_TimingTypeDef *Timing,
                               FMC_NORSRAM_TimingTypeDef *ExtTiming);
HAL_StatusTypeDef HAL_NOR_DeInit(NOR_HandleTypeDef *hnor);
void HAL_NOR_MspInit(NOR_HandleTypeDef *hnor);
void HAL_NOR_MspDeInit(NOR_HandleTypeDef *hnor);
void HAL_NOR_MspWait(NOR_HandleTypeDef *hnor, uint32_t Timeout);
/**
  * @}
  */

/** @addtogroup NOR_Exported_Functions_Group2 输入和输出函数
  * @{
  */

/* I/O 操作函数  ***************************************************/
HAL_StatusTypeDef HAL_NOR_Read_ID(NOR_HandleTypeDef *hnor, NOR_IDTypeDef *pNOR_ID);
HAL_StatusTypeDef HAL_NOR_ReturnToReadMode(NOR_HandleTypeDef *hnor);
HAL_StatusTypeDef HAL_NOR_Read(NOR_HandleTypeDef *hnor, uint32_t *pAddress, uint16_t *pData);
HAL_StatusTypeDef <