ESP-IDF 外设SPI驱动

本文只是对ESP32S3的SPI使用进行简单的介绍，主要讲解基于ESP-IDF的四线标准SPI的简单使用。并不涉及非固定长度结构体、dummy位的使用、高速SPI以及其它类型的SPI工作模式。

更加专业的内容可以参考：SPI 主机驱动程序

SPI简介

SPI（serial peripheral interface）是串行外设接口的简称，是一种高速全双工同步的通信总线。

ESP32S3一共有4个spi外设。

• SPI0，供 ESP32-S3 的 GDMA 控制器与 Cache 访问封装内或封装外 flash/PSRAM
• SPI1，供 CPU 访问封装内或封装外 flash/PSRAM
• SPI2，通用 SPI 控制器，通过 GDMA 分配 DMA 通道进行访问
• SPI3，通用 SPI 控制器，通过 GDMA 分配 DMA 通道进行访问

具体相关内容可以访问ESP32S3数据手册查看。

下面我们主要介绍四线SPI及其使用。

四线标准SPI

四线标准SPI接口一般使用4条线用于通信

1. SCLK：时钟信号，由主设备产生
2. CS：从设备片选信号，由主设备控制
3. MOSI（master output slave input）：主设备输出从设备输入
4. MISO（master input slave output）：主设备输入从设备输出

根据时钟极性CPOL和时钟相位CPHA的不同，SPI的工作模式共有4种。

其中CPOL和CPHA的含义分别为：

• CPOL: SCLK的有效电平。0：高电平有效；1：低电平有效。
• CPHA: 数据采样、输出方式。0：表示时钟第一个跳变沿开始采样（输入），第二个跳变沿输出。1表示第一个跳变沿输出，第二个跳变沿开始采样。

四种工作模式根据（CPOL，CPHA）的不同，分别如下：

• mode 0 (0,0): 上升沿采样，下降沿输出，第一个跳变沿为上升沿
• mode 1 (0,1): 上升沿输出，下降沿采样，第一个跳变沿为上升沿
• mode 2 (1,0): 上升沿输出，下降沿采样，第一个跳变为下降沿
• mode 3 (1,1): 上升沿采样，下降沿输出，第一个跳变沿为下降沿

其中mode0和mode3比较常用，都是在上升沿采样，下降沿输出，唯一不同的是，spi空闲时，mode 0的sclk电平为低，mode 3的sclk电平为高。

SPI通讯过程

SPI 总线传输事务由五个阶段构成，详见下表（任意阶段均可跳过）

阶段名称	描述
命令阶段 (Command)	在此阶段，主机向总线发送命令字段，长度为 0-16 位。
地址阶段 (Address)	在此阶段，主机向总线发送地址字段，长度为 0-64 位。
Dummy 阶段	此阶段可自行配置，用于适配时序要求。
写入阶段 (Write)	此阶段主机向设备传输数据，这些数据在紧随命令阶段（可选）和地址阶段（可选）之后。从电平的角度来看，数据与命令没有区别。
读取阶段 (Read)	此阶段主机读取设备数据。

实际SPI设备读写时，主机发送一字节数据，其MISO就会收到一字节的数据，若数据没有用，应将数据读取忽略。而主机若想读取数据，应发一个空字节数据，才能收到一字节数据。

配置SPI

总线初始化

首先配置“spi_bus_config_t”结构体。

    spi_bus_config_t buscfg={    //总线配置结构体
		.miso_io_num = GPIO_NUM_12,    //gpio12->miso
		.mosi_io_num = GPIO_NUM_13,    //gpio13->mosi
		.sclk_io_num = GPIO_NUM_14    //gpio14-> sclk
	};
	buscfg.max_transfer_sz = 40 * sizeof(uint8_t); 
	//设置传输数据的最大值。非DMA最大64bytes,DMA最大4096bytes
	//buscfg.intr_flags = 0;  //这个用于设置SPI通讯中相关的中断函数的中断优先级，0是默认。
	//这组中断函数包括SPI通讯前中断和SPI通讯后中断两个函数。

之后调用函数对SPI总线进行初始化。

esp_err_t spi_bus_initialize(spi_host_device_t host_id, const spi_bus_config_t *bus_config, spi_dma_chan_t dma_chan);

各形参的含义：

• host_id：选择使用的SPI
• bus_config：spi_bus_config_t结构体
• dma_chan：选择DMA通道。“SPI_DMA_DISABLED”、“SPI_DMA_CH_AUTO”。

spi_bus_initialize(SPI2_HOST, &buscfg, SPI_DMA_CH_AUTO);

设备初始化

初始化SPI完成后，就可以进行设备初始化了。

首先需要配置 设备配置结构体。

     spi_device_interface_config_t interface_config={ //设备配置结构体
	    .address_bits = 0,
	    .command_bits = 0,
	    .clock_speed_hz = 3 *1000 * 1000,
	    .mode = 0, //设置SPI通讯的相位特性和采样边沿。包括了mode0-3四种。要看从设备能够使用哪种模式
	    // interface_config.spics_io_num = 25; //配置片选线
        .duty_cycle_pos = 0,
	    .queue_size = 6 //传输队列的长度，表示可以在通讯的时候挂起多少个spi通讯。在中断通讯模式的时候会把当前spi通讯进程挂起到队列中
    };

之后调用函数进行设备初始化。

esp_err_t spi_bus_add_device(spi_host_device_t host_id, const spi_device_interface_config_t *dev_config, spi_device_handle_t *handle);

各形参的含义：

• host_id：选择使用的SPI
• dev_config：设备初始化结构体的指针
• handle：是获取驱动设备的句柄，后面用于指定通过哪个设备发送数据、设备使用哪个中断函数、向中断函数内传递数据都有用途。

spi_device_handle_t spi2_handle;

spi_bus_add_device(SPI2_HOST, &interface_config, &spi2_handle);

固定长度数据收发

在上文的interface_config结构体中，我们已经定义了命令位、地址位和dummy位的长度，下面我们就来进行数据的收发。

定义spi_transaction_t结构体

    uint8_t data_buff[4];  //定义要发送的数据缓存
    
    spi_transaction_t transaction_config; //定义数据结构体
	memset(&transaction_config, 0, sizeof(transaction_config));  //为数据结构体分配内存
	//transaction_config.cmd = 0x9F; //因为是固定内存地址，使用的是nterface_config的配置，也就是8bit cmd，0bit address
	transaction_config.length = 4 * 8;  //要发送或者接收的数据的长度，不算前面的cmd/address/dummy的长度
	transaction_config.tx_buffer = data_buff;  //发送没有指定内部空间，使用的是外部区域，因此要自己指定
	transaction_config.rx_buffer = NULL; //接收定义了SPI_TRANS_USE_RXDATA，使用的是内部空间。
	transaction_config.flags = SPI_TRANS_USE_RXDATA;

其中“SPI_TRANS_USE_RXDATA”说明使用结构体内部的“rx_data”，因此就不用在外部额外定义rx_buffer。

发送数据

数据发送有两种方式：分别为中断方式发送、轮询方式发送。

• 以中断方式发送

esp_err_t spi_device_transmit(spi_device_handle_t handle, spi_transaction_t *trans_desc);

中断传输事务将阻塞传输事务程序，直至传输事务完成，以使 CPU 运行其他任务程序。

应用任务中可以将多个传输事务加入到队列中，驱动程序将在中断服务程序 (ISR) 中自动逐一发送队列中的数据。在所有传输事务完成以前，任务可切换到其他程序中。

• 以轮询方式发送

esp_err_t spi_device_polling_transmit(spi_device_handle_t handle, spi_transaction_t *trans_desc);

轮询传输事务不依赖于中断，程序将不断轮询 SPI 主机的状态位，直到传输事务完成。

所有执行中断传输事务的任务都可能被队列阻塞。在此情况下，用户需要等待 ISR 和传输事务传输完成。轮询传输事务节省了原本用于队列处理和上下文切换的时间，减少了传输事务持续时间。传输事务类型的缺点是在这些事务进行期间，CPU 将被占用而处于忙碌状态。

接收数据

待补充