stm32g4xx_hal_qspi.h

转到此文件的文档。

/**
  ******************************************************************************
  * @file    stm32g4xx_hal_qspi.h
  * @author  MCD Application Team
  * @brief   QSPI HAL模块的头文件。
  ******************************************************************************
  * @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_QSPI_H
#define STM32G4xx_HAL_QSPI_H

#ifdef __cplusplus
 extern "C" {
#endif

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

#if defined(QUADSPI)

/** @addtogroup STM32G4xx_HAL_Driver
  * @{
  */

/** @addtogroup QSPI
  * @{
  */

/* Exported types ------------------------------------------------------------*/
/** @defgroup QSPI_Exported_Types QSPI导出的类型
  * @{
  */

/**
  * @brief  QSPI初始化结构体定义
  */
typedef struct
  uint32_t ClockPrescaler;     /* 指定用于根据AHB时钟生成时钟的分频系数。
                                  此参数可以是0到255之间的数值 */
  uint32_t FifoThreshold;      /* 指定FIFO中的字节数阈值（仅在间接模式下使用）
                                  此参数可以是1到16之间的值 */
  uint32_t SampleShifting;     /* 指定采样移位。数据延迟1/2时钟周期采样以
                                  补偿外部信号延迟。（在DDR模式下应为QSPI_SAMPLE_SHIFTING_NONE）
                                  此参数可以是@ref QSPI_SampleShifting的值 */
  uint32_t FlashSize;          /* 指定Flash大小。FlashSize+1实际上是用于寻址闪存的地址位数。
                                  闪存容量在间接模式下最高可达4GB
                                  （使用32位寻址），但在
                                  内存映射模式下可寻址空间限制为256MB
                                  此参数可以是0到31之间的数值 */
  uint32_t ChipSelectHighTime; /* 指定片选高电平时间。ChipSelectHighTime+1定义了命令之间片选必须保持高电平的
                                  最小时钟周期数。
                                  此参数可以是@ref QSPI_ChipSelectHighTime的值 */
  uint32_t ClockMode;          /* 指定时钟模式。它指示命令之间时钟的电平。
                                  此参数可以是@ref QSPI_ClockMode的值 */
  uint32_t FlashID;            /* 指定要使用的Flash，
                                  此参数可以是@ref QSPI_Flash_Select的值 */
  uint32_t DualFlash;          /* 指定双Flash模式状态
                                  此参数可以是@ref QSPI_DualFlash_Mode的值 */
}QSPI_InitTypeDef;

/**
  * @brief HAL QSPI状态结构体定义
  */
typedef enum
{
  HAL_QSPI_STATE_RESET             = 0x00U,    /*!< 外设未初始化                            */
  HAL_QSPI_STATE_READY             = 0x01U,    /*!< 外设已初始化并可使用              */
  HAL_QSPI_STATE_BUSY              = 0x02U,    /*!< 外设处于间接模式且忙碌                  */
  HAL_QSPI_STATE_BUSY_INDIRECT_TX  = 0x12U,    /*!< 外设处于间接模式且正在发送 */
  HAL_QSPI_STATE_BUSY_INDIRECT_RX  = 0x22U,    /*!< 外设处于间接模式且正在接收    */
  HAL_QSPI_STATE_BUSY_AUTO_POLLING = 0x42U,    /*!< 外设处于自动轮询模式                   */
  HAL_QSPI_STATE_BUSY_MEM_MAPPED   = 0x82U,    /*!< 外设处于内存映射模式                   */
  HAL_QSPI_STATE_ABORT             = 0x08U,    /*!< 外设正在处理中止请求                 */
  HAL_QSPI_STATE_ERROR             = 0x04U     /*!< 外设处于错误状态                                   */
}HAL_QSPI_StateTypeDef;

/**
  * @brief  QSPI句柄结构体定义
  */
#if (USE_HAL_QSPI_REGISTER_CALLBACKS == 1)
typedef struct __QSPI_HandleTypeDef
#else
typedef struct
#endif
{
  QUADSPI_TypeDef            *Instance;        /* QSPI寄存器基地址        */
  QSPI_InitTypeDef           Init;             /* QSPI通信参数      */
  uint8_t                    *pTxBuffPtr;      /* 指向QSPI发送传输缓冲区的指针 */
  __IO uint32_t              TxXferSize;       /* QSPI发送传输大小              */
  __IO uint32_t              TxXferCount;      /* QSPI发送传输计数器           */
  uint8_t                    *pRxBuffPtr;      /* 指向QSPI接收传输缓冲区的指针 */
  __IO uint32_t              RxXferSize;       /* QSPI接收传输大小              */
  __IO uint32_t              RxXferCount;      /* QSPI接收传输计数器           */
  DMA_HandleTypeDef          *hdma;            /* QSPI接收/发送DMA句柄参数   */
  __IO HAL_LockTypeDef       Lock;             /* 锁定对象                     */
  __IO HAL_QSPI_StateTypeDef State;            /* QSPI通信状态           */
  __IO uint32_t              ErrorCode;        /* QSPI错误代码                    */
  uint32_t                   Timeout;          /* QSPI存储器访问超时时间 */
#if (USE_HAL_QSPI_REGISTER_CALLBACKS == 1)
  void (* ErrorCallback)        (struct __QSPI_HandleTypeDef *hqspi);
  void (*