设计说明

源码说明

模块架构

RT-Thread 透过其定义的 QSPI/SPI 驱动框架，向上提供了 QSPI/SPI 接口，并且通过这一层接口支持各种应用，包括 SPI NAND, SPI NOR。

ArtInChip 提供了 QSPI HAL 层，并且实现了对接 RT-Thread 的驱动层。由于 QSPI 传输需要使用 DMA，因此 DMA HAL 是一个相关模块。

HAL 与 DRV

ArtInChip 的 QSPI 驱动按照 HAL 层 + Driver 层的结构进行设计，其中 HAL 层为硬件抽象层，提供系统无关的硬件驱动实现； 在 HAL 层之上，可根据不同 RTOS 的驱动框架，实现对应的 QSPI DRV 层进行对接。

QSPI HAL 的特点:

1. 无状态

2. 支持 sync、async(irq) 模式

3. 支持 DMA、非 DMA 模式

QSPI HAL 相关的设备操作都需要通过 Handle 的方式进行。 由于 HAL 其内部无状态，不会进行空间分配，因此 Handle 的空间需要外部申请并且传入， 由 HAL 层进行使用。

关键流程设计

• 添加 QSPI 总线

  在 RT-Thread 板级初始化过程中，会调用 rt_hw_qspi_bus_init() 函数，将板子支持的 QSPI 控制器(总线) 添加到系统中。

  INIT_BOARD_EXPORT(rt_hw_qspi_bus_init); // bsp/artinchip/drv/qspi/drv_qspi.c
  |-> rt_qspi_bus_register(); // kernel/rt-thread/components/drivers/spi/qspi_core.c
      |-> rt_spi_bus_register(); kernel/rt-thread/components/drivers/spi/spi_core.c
          |-> rt_spi_bus_device_init(); // kernel/rt-thread/components/drivers/spi/spi_dev.c
              |-> rt_device_register(device, name, RT_DEVICE_FLAG_RDWR);

• 添加 QSPI 设备

  将 QSPI 设备挂载到总线上。

  aic_qspi_bus_attach_device("qspi0", "GD25B127D", 0, 4, RT_NULL, RT_NULL); // bsp/artinchip/drv/qspi/drv_qspi.c
  |-> rt_spi_bus_attach_device(); // kernel/rt-thread/components/drivers/spi/spi_core.c
      |-> rt_spidev_device_init(device, name); // kernel/rt-thread/components/drivers/spi/spi_dev.c
          |-> rt_device_register(device, name, RT_DEVICE_FLAG_RDWR);

• 初始化流程

  当 QSPI 设备需要使用之前，必须进行初始化配置。

  rt_sfud_flash_probe_ex();
  |-> rt_qspi_configure(qspi_dev, qspi_cfg); // kernel/rt-thread/components/drivers/spi/qspi_core.c
      |-> rt_spi_configure(&device->parent, &cfg->parent); // kernel/rt-thread/components/drivers/spi/spi_core.c
          |-> device->bus->ops->configure(device, &device->config);
              qspi_configure(device, &device->config); // bsp/artinchip/drv/qspi/drv_qspi.c
              |-> hal_qspi_master_init(&qspi->handle, &cfg);

• 中断处理流程

  QSPI HAL 层提供了中断处理函数，但是是否使用中断模式由 DRV 层决定。 Luban-Lite SDK 中对接 RT-Thread 时，使能了中断处理模式。

  首先在初始化时，注册了对应的中断处理函数。

  qspi_configure(); // bsp/artinchip/drv/qspi/drv_qspi.c
  |-> aicos_request_irq(qspi->irq_num, qspi_irq_handler, 0, NULL, (void *)&qspi->handle);

  中断发生时，QSPI DRV 层的中断处理函数，调用 HAL 层的中断处理函数进行处理。

  qspi_irq_handler(); p/artinchip/drv/qspi/drv_qspi.c
  |-> hal_qspi_master_irq_handler(h);

数据结构

struct qspi_master_config {
    uint32_t idx;
    uint32_t clk_in_hz;
    uint32_t clk_id;
    bool bit_mode;
    bool wire3_en;
    bool lsb_en;
    bool cs_auto;
    uint8_t cs_polarity;
    uint8_t cpol;
    uint8_t cpha;
};

struct qspi_master_dma_config {
    uint32_t port_id;
    uint32_t tx_bus_width;
    uint32_t tx_max_burst;
    uint32_t rx_bus_width;
    uint32_t rx_max_burst;
};

struct qspi_transfer {
    uint8_t *tx_data;
    uint8_t *rx_data;
    uint32_t data_len;
};

struct qspi_master_state {
    uint32_t idx;
    qspi_master_async_cb cb;
    void *cb_priv;
    uint32_t status;
    uint32_t clk_id;
    uint32_t bus_hz;
    uint32_t bus_width;
    struct qspi_master_dma_config dma_cfg;
    void *dma_tx;
    void *dma_rx;
    uint8_t *async_tx; /* Used in Async Non-DMA mode */
    uint8_t *async_rx; /* Used in Async Non-DMA mode */
    uint32_t async_tx_remain; /* Used in Async Non-DMA mode */
    uint32_t async_rx_remain; /* Used in Async Non-DMA mode */
    uint32_t work_mode;
    uint32_t done_mask;
};

接口设计

RT-Thread 中的 QSPI 接口设计，在 RT-Thread 的文档中已经有详细说明。 此处介绍 QSPI HAL 层的接口设计。