stm32g4xx_hal_qspi.c

跳转到此文件的文档。

/**
  ******************************************************************************
  * @file    stm32g4xx_hal_qspi.c
  * @author  MCD Application Team
  * @brief   QSPI HAL模块驱动。
  *          本文件提供了用于管理QuadSPI接口（QSPI）以下功能的固件函数：
  *           + 初始化和反初始化函数
  *           + 间接功能模式管理
  *           + 内存映射功能模式管理
  *           + 自动轮询功能模式管理
  *           + 中断和标志管理
  *           + 间接功能模式的DMA通道配置
  *           + 错误管理和中止功能
  *
  *
  ******************************************************************************
  * @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.
  *
  ******************************************************************************
  @verbatim
 ===============================================================================
                        ##### 如何使用此驱动 #####
 ===============================================================================
  [..]
    *** 初始化 ***
    ======================
    [..]
      (#) 作为先决条件，填写HAL_QSPI_MspInit()：
        (++) 使用__HAL_RCC_QSPI_CLK_ENABLE()启用QuadSPI时钟接口。
        (++) 使用__HAL_RCC_QSPI_FORCE_RESET()和__HAL_RCC_QSPI_RELEASE_RESET()复位QuadSPI外设。
        (++) 使用__HAL_RCC_GPIOx_CLK_ENABLE()为QuadSPI GPIO启用时钟。
        (++) 使用HAL_GPIO_Init()将这些QuadSPI引脚配置为复用模式。
        (++) 如果使用中断模式，使用HAL_NVIC_SetPriority()和HAL_NVIC_EnableIRQ()启用并配置QuadSPI全局中断。
        (++) 如果使用DMA模式，使用__HAL_RCC_DMAx_CLK_ENABLE()为QuadSPI DMA通道启用时钟，
            使用HAL_DMA_Init()配置DMA，使用__HAL_LINKDMA()将其与QuadSPI句柄链接，
            使用HAL_NVIC_SetPriority()和HAL_NVIC_EnableIRQ()启用并配置DMA通道全局中断。
      (#) 使用HAL_QSPI_Init()函数配置闪存大小、时钟预分频器、FIFO阈值、
          时钟模式、采样偏移和CS高电平时间。

    *** 间接功能模式 ***
    ================================
    [..]
      (#) 使用HAL_QSPI_Command()或HAL_QSPI_Command_IT()函数配置命令序列：
         (++) 指令阶段：使用的模式以及指令操作码（如果有）。
         (++) 地址阶段：使用的模式以及地址大小和地址值（如果有）。
         (++) 交替字节阶段：使用的模式以及交替字节大小和值（如果有）。
         (++) 虚拟周期阶段：虚拟周期数量（使用的模式与数据阶段相同）。
         (++) 数据阶段：使用的模式以及字节数量（如果有）。
         (++) 双倍数据速率（DDR）模式：该模式的激活（或不激活）以及激活时的延迟。
         (++) 指令仅发送一次（SIOO）模式：该模式的激活（或不激活）。
      (#) 如果命令不需要数据，则直接发送到内存：
         (++) 在轮询模式下，函数输出在传输完成后进行。
         (++) 在中断模式下，当传输完成时将调用HAL_QSPI_CmdCpltCallback()。
      (#) 对于间接写模式，在命令配置后使用HAL_QSPI_Transmit()、HAL_QSPI_Transmit_DMA()或
          HAL_QSPI_Transmit_IT()：
         (++) 在轮询模式下，函数输出在传输完成后进行。
         (++) 在中断模式下，当达到FIFO阈值时将调用HAL_QSPI_FifoThresholdCallback()，
             当传输完成时将调用HAL_QSPI_TxCpltCallback()。
         (++) 在DMA模式下，半传输时将调用HAL_QSPI_TxHalfCpltCallback()，
             当传输完成时将调用HAL_QSPI_TxCpltCallback()。
      (#) 对于间接读模式，在命令配置后使用HAL_QSPI_Receive()、HAL_QSPI_Receive_DMA()或
          HAL_QSPI_Receive_IT()：
         (++) 在轮询模式下，函数输出在传输完成后进行。
         (++) 在中断模式下，当达到FIFO阈值时将调用HAL_QSPI_FifoThresholdCallback()，
             当传输完成时将调用HAL_QSPI_RxCpltCallback()。
         (++) 在DMA模式下，半传输时将调用HAL_QSPI_RxHalfCpltCallback()，
             当传输完成时将调用HAL_QSPI_RxCpltCallback()。

    *** 自动轮询功能模式 ***
    ====================================
    [..]
      (#) 使用HAL_QSPI_AutoPolling()或HAL_QSPI_AutoPolling_IT()函数配置命令序列和自动轮询功能模式：
         (++) 指令阶段：使用的模式以及指令操作码（如果有）。
         (++) 地址阶段：使用的模式以及地址大小和地址值（如果有）。
         (++) 交替字节阶段：使用的模式以及交替字节大小和值（如果有）。
         (++) 虚拟周期阶段：虚拟周期数量（使用的模式与数据阶段相同）。
         (++) 数据阶段：使用的模式。
         (++) 双倍数据速率（DDR）模式：该模式的激活（或不激活）以及激活时的延迟。
         (++) 指令仅发送一次（SIOO）模式：该模式的激活（或不激活）。
         (++) 状态字节大小、匹配值、使用的掩码、匹配模式（OR/AND）、
             轮询间隔和自动停止激活。
      (#) 配置之后：
         (++) 在轮询模式下，当达到状态匹配时函数输出。自动停止被激活以避免无限循环。
         (++) 在中断模式下，每次达到状态匹配时都会调用HAL_QSPI_StatusMatchCallback()。

    *** 内存映射功能模式 ***
    =====================================
    [..]
      (#) 使用HAL_QSPI_MemoryMapped()函数配置命令序列和内存映射功能模式：
         (++) 指令阶段：使用的模式以及指令操作码（如果有）。
         (++) 地址阶段：使用的模式和地址大小。
         (++) 交替字节阶段：使用的模式以及交替字节大小和值（如果有）。
         (++) 虚拟周期阶段：虚拟周期数量（使用的模式与数据阶段相同）。
         (++) 数据阶段：使用的模式。
         (++) 双倍数据速率（DDR）模式：该模式的激活（或不激活）以及激活时的延迟。
         (++) 指令仅发送一次（SIOO）模式：该模式的激活（或不激活）。
         (++) 超时激活和超时周期。
      (#) 配置后，一旦在AHB上对地址范围进行访问，QuadSPI将被使用。
          当超时到期时将调用HAL_QSPI_TimeOutCallback()。

    *** 错误管理和中止功能 ***
    =================================================
    [..]
      (#) HAL_QSPI_GetError()函数给出上次操作期间发生的错误。
      (#) HAL_QSPI_Abort()和HAL_QSPI_Abort_IT()函数中止任何正在进行的操作并
          清空FIFO：
         (++) 在轮询模式下，当传输完成位被设置且忙位被清除时函数输出。
         (++) 在中断模式下，当传输完成位被设置时将调用HAL_QSPI_AbortCpltCallback()。

    *** 控制函数 ***
    =========================
    [..]
      (#) HAL_QSPI_GetState()函数给出HAL QuadSPI驱动的当前状态。
      (#) HAL_QSPI_SetTimeout()函数配置驱动中使用的超时值。
      (#) HAL_QSPI_SetFifoThreshold()函数配置QSPI IP的FIFO阈值。
      (#) HAL_QSPI_GetFifoThreshold()函数获取FIFO阈值的当前值。
      (#) HAL_QSPI_SetFlashID()函数配置要访问的闪存存储器的索引。

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

      使用函数HAL_QSPI_RegisterCallback()注册用户回调，
      它允许注册以下回调：
        (+) ErrorCallback：发生错误时的回调。
        (+) AbortCpltCallback：中止完成时的回调。
        (+) FifoThresholdCallback：达到FIFO阈值时的回调。
        (+) CmdCpltCallback：无数据命令完成时的回调。
        (+) RxCpltCallback：接收传输完成时的回调。
        (+) TxCpltCallback：发送传输完成时的回调。
        (+) RxHalfCpltCallback：接收传输完成一半时的回调。
        (+) TxHalfCpltCallback：发送传输完成一半时的回调。
        (+) StatusMatchCallback：发生状态匹配时的回调。
        (+) TimeOutCallback：超时到期时的回调。
        (+) MspInitCallback：QSPI MspInit。
        (+) MspDeInitCallback：QSPI MspDeInit。
      此函数接受HAL外设句柄、回调ID和用户回调函数指针作为参数。

      使用函数HAL_QSPI_UnRegisterCallback()将回调重置为默认
      弱（覆盖）函数。它允许重置以下回调：
        (+) ErrorCallback：发生错误时的回调。
        (+) AbortCpltCallback：中止完成时的回调。
        (+) FifoThresholdCallback：达到FIFO阈值时的回调。
        (+) CmdCpltCallback：无数据命令完成时的回调。
        (+) RxCpltCallback：接收传输完成时的回调。
        (+) TxCpltCallback：发送传输完成时的回调。
        (+) RxHalfCpltCallback：接收传输完成一半时的回调。
        (+) TxHalfCpltCallback：发送传输完成一半时的回调。
        (+) StatusMatchCallback：发生状态匹配时的回调。
        (+) TimeOutCallback：超时到期时的回调。
        (+) MspInitCallback：QSPI MspInit。
        (+) MspDeInitCallback：QSPI MspDeInit。
      此函数接受HAL外设句柄和回调ID作为参数。

      默认情况下，在HAL_QSPI_Init之后，如果状态为HAL_QSPI_STATE_RESET，
      所有回调都重置为相应的传统弱（覆盖）函数。
      例外情况是MspInit和MspDeInit回调，它们分别
      在HAL_QSPI_Init和HAL_QSPI_DeInit中重置为传统弱（覆盖）函数，
      但仅在这些回调为空（未预先注册）时。
      否则，如果MspInit或MspDeInit不为空，HAL_QSPI_Init和HAL_QSPI_DeInit
      保留并使用用户的MspInit/MspDeInit回调（预先注册）。

      回调只能在就绪状态下注册/注销。
      例外情况是MspInit/MspDeInit回调，它们可以在就绪或复位状态下注册/注销，
      因此注册的（用户）MspInit/DeInit回调可以在Init/DeInit期间使用。
      在这种情况下，首先使用HAL_QSPI_RegisterCallback注册MspInit/MspDeInit用户回调，
      然后再调用HAL_QSPI_DeInit或HAL_QSPI_Init函数。

      当编译定义USE_HAL_QSPI_REGISTER_CALLBACKS设置为0或
      未定义时，回调注册功能不可用，
      将使用弱（覆盖）回调。

    *** 与硅限制相关的工作around ***
    ====================================================
    [..]
      (#) HAL驱动内部实现的工作around
         (++) 读传输结束时写入FIFO的额外数据

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

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

#if defined(QUADSPI)

/** @addtogroup STM32G4xx_HAL_Driver
  * @{
  */

/** @defgroup QSPI QSPI
  * @brief QSPI HAL模块驱动
  * @{
  */
#ifdef HAL_QSPI_MODULE_ENABLED

/* Private typedef -----------------------------------------------------------*/

/* Private define ------------------------------------------------------------*/
/** @defgroup QSPI_Private_Constants QSPI私有常量
  * @{
  */
00227 #define QSPI_FUNCTIONAL_MODE_INDIRECT_WRITE 0x00000000U                     /*!<间接写模式*/
#define QSPI_FUNCTIONAL_MODE_INDIRECT_READ  ((uint32_t)QUADSPI_CCR_FMODE_0) /*!<间接读模式*/
#define QSPI_FUNCTIONAL_MODE_AUTO_POLLING   ((uint32_t)QUADSPI_CCR_FMODE_1) /*!<自动轮询模式*/
#define QSPI_FUNCTIONAL_MODE_MEMORY_MAPPED  ((uint32_t)QUADSPI_CCR_FMODE)   /*!<内存映射模式*/
/**