QSPI

简要说明

QSPI 是 Quad SPI 的简写，是 Motorola 公司推出的 SPI 接口的扩展，比 SPI 应用更加广泛。在 SPI 协议的基础上，Motorola 公司对其功能进行了增强，增加了队列传输机制，推出了队列串行外围接口协议（即 QSPI 协议）。使用该接口，用户可以一次性传输包含多达 16 个 8 位或 16 位数据的传输队列。一旦传输启动，直到传输结束，都不需要 CPU 干预，极大的提高了传输效率。与 SPI 相比，QSPI 的最大结构特点是以 80 字节的 RAM 代替了 SPI 的发送和接收数据寄存器。

接口列表

QSPI的CSI接口说明如下所示：

QSPI的CSI接口在用户对接时是否必须适配的说明如下所示：

接口详细说明

csi_qspi_init

csi_error_t csi_qspi_init(csi_qspi_t *qspi, uint32_t idx)

• 功能描述:

  通过设备ID初始化对应的QSPI实例，返回结果值。

• 参数:

  • qspi: 设备句柄（需要用户申请句柄空间）。
  • idx : 设备ID。

• 返回值:

  • 错误码csi_error_t

csi_qspi_t

csi_qspi_uninit

void csi_qspi_uninit(csi_qspi_t *qspi)

• 功能描述:

• QSPI实例反初始化, 并且释放相关的软硬件资源。

• 参数:

  • qspi: 实例句柄。

• 返回值

  • 无

csi_qspi_attach_callback

csi_error_t csi_qspi_attach_callback(csi_qspi_t *qspi, void *callback, void *arg)

• 功能描述:

  • 注册回调函数到指定QSPI控制器。

• 参数:

  • qspi: 实例句柄。
  • callback: 回调函数。
  • arg: 回调函数的参数。

• 参数:

  • 错误码csi_error_t

csi_qspi_detach_callback

void csi_qspi_detach_callback(csi_qspi_t *qspi)

• 功能描述:

  • 注销回调函数。

• 参数:

  • qspi: 实例句柄。

csi_qspi_frequence

uint32_t csi_qspi_frequence(csi_qspi_t *qspi, uint32_t hz)

• 功能描述:

• 设置QSPI频率。

• 参数:

  • qspi: 实例句柄。
  • hz: 工作频率。

• 返回值

  • 实际设置频率

csi_qspi_mode

csi_error_t csi_qspi_mode(csi_qspi_t *qspi, csi_qspi_mode_t mode)

• 功能描述:

• 设置QSPI时钟模式。

• 参数:

  • qspi: 实例句柄。
  • mode: 时钟模式。

• 返回值

  • 错误码csi_error_t

csi_qspi_clock_mode_t

csi_qspi_send

int32_t csi_qspi_send(csi_qspi_t *qspi, csi_qspi_command_t *cmd, const void *data, uint32_t size, uint32_t timeout)

• 功能描述:

• 以轮询模式进行数据发送。

• 参数:

  • qspi : 实例句柄。
  • cmd : 指向command配置信息。
  • data : 指向发送数据缓存。
  • size : 指定需要发送的数据长度。
  • timeout : 发送超时时间，单位ms。

• 返回值

  • 发送成功，返回实际发送长度。 发送失败，返回错误码。

• 错误码

csi_qspi_command_t

csi_qspi_alt_size_t

csi_qspi_bus_width_t

csi_qspi_address_size_t

csi_qspi_receive

uint32_t csi_qspi_receive(csi_qspi_t *qspi, csi_qspi_command_t *cmd, void *data, uint32_t size, uint32_t timeout)

• 功能描述:

• 以轮询模式进行数据接收。

• 参数:

  • qspi : 实例句柄。
  • cmd : 指向command配置信息。
  • data : 指向接收数据缓存。
  • size : 指定需要接收的数据长度。
  • timeout : 数据接收超时时间，单位ms。

• 返回值

  • 错误码csi_error_t

csi_qspi_send_receive

uint32_t csi_qspi_send_receive(csi_qspi_t *qspi, csi_qspi_command_t *cmd, const void *tx_data, void *rx_data, uint32_t size, uint32_t timeout)

• 功能描述:

• 以轮询模式进行数据发送/接收。

• 参数:

  • qspi : 实例句柄。
  • cmd : 指向command配置信息。
  • tx_data : 指向发送数据缓存。
  • rx_data : 指向接收数据缓存。
  • size : 指定发送/接收的数据长度。
  • timeout : 数据接收超时时间，单位ms。

• 返回值

  • 错误码csi_error_t

csi_qspi_send_async

csi_error_t csi_qspi_send_async(csi_qspi_t *qspi, csi_qspi_command_t *cmd, const void *data, uint32_t size)

• 功能描述:

• 以异步模式进行数据发送。

• 参数:

  • qspi : 实例句柄。
  • cmd : 指向command配置信息。
  • data : 指向发送数据缓存。
  • size : 指定需要发送的数据长度。

• 返回值

  • 错误码csi_error_t

csi_qspi_receive_async

csi_error_t csi_qspi_receive_async(csi_qspi_t *qspi, csi_qspi_command_t *cmd, void *data, uint32_t size)

• 功能描述:

• 以异步模式进行数据接收。

• 参数:

  • qspi : 实例句柄。
  • cmd : 指向command配置信息。
  • data : 指向数据数据缓存。
  • size : 指定需要接收的数据长度。

• 返回值

  • 错误码csi_error_t

csi_qspi_send_receive_async

csi_error_t csi_qspi_send_receive_async(csi_qspi_t *qspi, csi_qspi_command_t *cmd, const void *tx_data, void *rx_data, uint32_t size)

• 功能描述:

• 以异步模式进行数据发送/接收。

• 参数:

  • qspi : 实例句柄。
  • cmd : 指向command配置信息。
  • tx_data : 指向发送数据缓存。
  • rx_data : 指向接收数据缓存。
  • size : 指定发送接收的数据长度。

• 返回值

  • 错误码csi_error_t

csi_qspi_link_dma

csi_error_t csi_qspi_link_dma(csi_qspi_t *qspi, csi_dma_ch_t *tx_dma, csi_dma_ch_t *rx_dma)

• 功能描述:

• 绑定/注销DMA通道。当传入参数为NULL时注销通道，当参数不为NULL时绑定通道。

• 参数:

  • qspi : 实例句柄。
  • tx_dma : 指向发送dma通道。
  • rx_dma : 指向接收dma通道。

• 返回值:

  • 错误码csi_error_t

csi_qspi_get_state

csi_error_t csi_qspi_get_state(csi_qspi_t *qspi, csi_state_t *state)

• 功能描述:

• 获取QSPI状态。

• 参数:

  • qspi : 实例句柄。
  • state : 指向接收的状态值。

• 返回值:

  • 错误码csi_error_t

csi_state_t

csi_qspi_memory_mapped

csi_error_t csi_qspi_memory_mapped(csi_qspi_t *qspi, csi_qspi_command_t *cmd)

• 功能描述:

• 设置QSPI内存映射模式。

• 参数:

  • qspi : 实例句柄。
  • cmd : 指向command配置信息。

• 返回值:

  • 错误码csi_error_t

使用示例

示例展示了如何使用QSPI读取SPIFLASH的JEDEC ID

#include <stdio.h>
#include <string.h>

#include <soc.h>
#include <drv/qspi.h>
#include <drv/tick.h>
#include <csi_config.h>
#include <board_config.h>
#include <board_init.h>

#define W25Q64FV_READ_JEDEC_ID            0x9F

static csi_qspi_t     qspi_handle; 
static csi_qspi_command_t  command; 
int main(void)
{
    int ret;
    uint8_t device_id[3];

    board_init();

    ret = csi_qspi_init(&qspi_handle, 0);

    if (ret != CSI_OK) {
        return -1;
    }

    /* Read device id operations */
    command.instruction.value     = W25Q64FV_READ_DEVICE_ID;
    command.instruction.bus_width = QSPI_CFG_BUS_SINGLE;
    command.instruction.disabled  = false;
    command.alt.disabled          = true;
    command.address.disabled      = true;
    command.address.value         = 0;
    command.address.size          = 0;
    command.address.bus_width     = QSPI_CFG_BUS_SINGLE;
    command.data.bus_width        = QSPI_CFG_BUS_SINGLE;
    ret = csi_qspi_receive(&qspi_handle, &command, device_id, 3, 1000);
    if (ret != 3) {
        return -1;
    }

    printf("device id: %x%x%x", device_id[0], device_id[1], device_id[2]);
    return 0;
}