SPI设备用户开发

基础BSP配置--以STM32为例

建立工程文件

以正点原子探索者STM32F407为例，用SPI接口操作板载flash W25Q128。

STM32CubeMX配置

1. 打开 oneos\projects\stm32f407-atk-explorer\board\CubeMX_Config下 的 CubeMX 工程文件，若无则请参照操作指南生成相应工程；
2. 在 CubeMX 工程中进行 SPI 配置,如下图所示，配置SPI1，点击 Clock Configuration 检查时钟配置，然后点击 GENARATE CODE 生成代码；

使用 Menuconfig 配置工程选项

1. 在对应的 oneos\projects\stm32f407-atk-explorer目录下打开 OneOS-Cube 工具，在命令行输入 menuconfig 打开可视化配置界面；
2. 在配置界面中选择Drivers；
3. 在新的配置界面中选择SPI；
4. 在Drivers->SPI下选中Using W25QXX NorFlash，此时会自动关联SFUD和FAL;

  -*- Using SPI Bus/Device device drivers
  [ ]     Enable QSPI mode
  [ ]     SPI MSD
  -*-     Using Serial Flash Universal Driver
  [*]         Using auto probe flash JEDEC SFDP parameter
  [*]         Using defined supported flash chip information table
  [ ]         Show more SFUD debug information
  [*]         Using SPI mode support  --->
  [ ]         Using QSPI mode support  ----
  [*]         Extern flash sfud port cfg  --->
  [*]     Using W25QXX NorFlash
  [ ] Using enc28j60 spi net module  ----
  [ ] Enable SDCARD (SPI)  ----
  [ ] Enable NRF24L01

1. 在Using SPI mode support下进行如下设置;

  (spi1) spi flash bus name
  (30) spi flash cs pin

1. 在Extern flash sfud port cfg下进行如下设置;

(W25Q128) Extern flash dev name
(spi10) Extern flash bus name
((nor_flash) Extern flash name
(16777216) Extern flash size
(4096) Extern flash block size
(4096) Extern flash page size

使用 Scons 构建工程

保存当前配置，在上一步打开的 OneOS-Cube 工具命令行输入 scons --ide=mdk5 构建工程；

工程编译及实现

1. 打开对应的 oneos\projects\stm32f407-atk-explorer目录下的 project.uvprojx 工程文件；
2. 在fal_cfg.h文件中进行外部flash分区表的实现；
3. 编译并下载工程，运行程序；
4. 打开串口工具如xshell等，通信成功后，即可通过fal或sfud指令进行flash的测试；

SPI API介绍

API 列表

os_spi_bus_attach_device

该函数用于挂载 SPI 设备到已注册的 SPI 总线上，函数原型如下：

os_err_t os_spi_bus_attach_device(struct os_spi_device *device,
                                  const char           *name,
                                  const char           *bus_name,
                                  void                 *user_data);

os_spi_configure

该函数用于配置 SPI 设备的传输参数，函数原型如下：

os_err_t os_spi_configure(struct os_spi_device *device, struct os_spi_configuration *cfg);

os_qspi_configure

该函数用于配置 QSPI 设备的传输参数，函数原型如下：

os_err_t os_qspi_configure(struct os_qspi_device *device, struct os_qspi_configuration *cfg);

访问 SPI 设备

os_device_find

该函数用于根据 SPI 设备名称查找设备，函数原型如下：

os_device_t *os_device_find(const char *name);

os_spi_transfer_message

该函数用于 SPI 数据收发，函数原型如下：

struct os_spi_message *os_spi_transfer_message(struct os_spi_device *device, struct os_spi_message *message);

os_spi_transfer

该函数用于传输一次 SPI 数据，函数原型如下：

os_size_t os_spi_transfer(struct os_spi_device *device, const void *send_buf, void *recv_buf, os_size_t length);

os_spi_send

该函数用于发送一次 SPI 数据，忽略接收到的数据，函数原型如下：

OS_INLINE os_size_t os_spi_send(struct os_spi_device *device, const void *send_buf, os_size_t length);

os_spi_recv

该函数用于接收一次 SPI 数据，函数原型如下：

OS_INLINE os_size_t os_spi_recv(struct os_spi_device *device, void *recv_buf, os_size_t length);

os_spi_send_then_send

该函数用于连续发送 2 个缓冲区的数据，并且中间片选不释放，函数原型如下：

os_err_t os_spi_send_then_send(struct os_spi_device *device,
                               const void           *send_buf1,
                               os_size_t             send_length1,
                               const void           *send_buf2,
                               os_size_t             send_length2);

os_spi_send_then_recv

该函数用于先发送数据，然后接收从设备发送的数据，并且中间片选不释放，函数原型如下：

os_err_t os_spi_send_then_recv(struct os_spi_device *device,
                               const void           *send_buf,
                               os_size_t             send_length,
                               void                 *recv_buf,
                               os_size_t             recv_length);

访问 QSPI 设备

os_qspi_transfer_message

该函数用于传输 QSPI 消息，函数原型如下：

os_size_t os_qspi_transfer_message(struct os_qspi_device *device, struct os_qspi_message *message);

os_qspi_send_then_recv

该函数用于 QSPI 先发送命令，然后接收从设备的消息 ，函数原型如下：

os_err_t os_qspi_send_then_recv(struct os_qspi_device *device,
                                const void            *send_buf,
                                os_size_t              send_length,
                                void                  *recv_buf,
                                os_size_t              recv_length);

send_buf 参数包含了将要发送的命令序列。

os_qspi_send

该函数用于发送 QSPI 消息序列、数据，函数原型如下：

os_err_t os_qspi_send(struct os_qspi_device *device, const void *send_buf, os_size_t length);

send_buf 参数包含了将要发送的命令序列和数据。

os_spi_take_bus

该函数用于占有 SPI 总线，函数原型如下：

os_err_t os_spi_take_bus(struct os_spi_device *device);

os_spi_take

该函数用于拉低 SPI 片选信号，函数原型如下：

os_err_t os_spi_take(struct os_spi_device *device);

os_spi_message_append

该函数用于往 SPI 消息链表里增加一条新的待传输消息，函数原型如下：

OS_INLINE void os_spi_message_append(struct os_spi_message *list, struct os_spi_message *message);

os_spi_release

该函数用于释放 SPI 片选信号，函数原型如下：

os_err_t os_spi_release(struct os_spi_device *device);

os_spi_release_bus

该函数用于释放总线，函数原型如下：

os_err_t os_spi_release_bus(struct os_spi_device *device);

使用示例

本例程演示通过SPI设备读取w25q的ID数据：

#include <os_task.h>
#include <drv_cfg.h>
#include <shell.h>
#include <string.h>

#define W25Q_SPI_DEVICE_NAME     "qspi10"

static int spi_w25q_test(int argc, char *argv[])
{
    struct os_qspi_device *spi_dev_w25q;
    char name[OS_NAME_MAX];
    os_uint8_t w25x_read_id = 0x90;
    os_uint8_t id[5] = {0};

    if (argc == 2)
    {
        strncpy(name, argv[1], OS_NAME_MAX);
    }
    else
    {
        strncpy(name, W25Q_SPI_DEVICE_NAME, OS_NAME_MAX);
    }

    /* find spi device */
    spi_dev_w25q = (struct os_qspi_device *)os_device_find(name);
    if (!spi_dev_w25q)
    {
        os_kprintf("spi sample run failed! can't find %s device!\n", name);
    }
    else
    {
        /* read flash ID */
        os_qspi_send_then_recv(spi_dev_w25q, &w25x_read_id, 1, id, 5);
        os_kprintf("read w25q ID is:%x%x\n", id[3], id[4]);
    }
    return 0;
}
SH_CMD_EXPORT(spi_w25q_test, spi_w25q_test, "spi w25q sample");

运行结果如下：

sh>spi_w25q_test qspi10
read w25q ID is:ef17