SPI 使用

SPI是一種高速的，全雙工，同步串行通信接口，用于連接微控制器、傳感器、存儲設備等。 由于AIO-3399J SPI沒有引出來，而且已經被用到其他功能上，所以這章以firefly-rk3399作為例子。 Firefly-RK3399 開發板提供了 SPI1 （單片選）接口，具體位置如下圖：

SPI工作方式

SPI以主從方式工作，這種模式通常有一個主設備和一個或多個從設備，需要至少4根線，分別是：

CS 片選信號 SCLK 時鐘信號 MOSI 主設備數據輸出、從設備數據輸入 MISO 主設備數據輸入，從設備數據輸出

Linux內核用CPOL和CPHA的組合來表示當前SPI的四種工作模式：

CPOL＝0，CPHA＝0 SPI_MODE_0 CPOL＝0，CPHA＝1 SPI_MODE_1 CPOL＝1，CPHA＝0 SPI_MODE_2 CPOL＝1，CPHA＝1 SPI_MODE_3

CPOL：表示時鐘信號的初始電平的狀態，０為低電平，１為高電平。CPHA：表示在哪個時鐘沿采樣，０為第一個時鐘沿采樣，１為第二個時鐘沿采樣。SPI的四種工作模式波形圖如下：

驅動編寫

下面以 W25Q128FV Flash模塊為例簡單介紹SPI驅動的編寫。

硬件連接

Firefly-RK3399 與 W25Q128FV 硬件連接如下表：

編寫Makefile/Kconfig

在kernel/drivers/spi/Kconfig中添加對應的驅動文件配置：

config SPI_FIREFLY tristate "Firefly SPI demo support " default y help Select this option if your Firefly board needs to run SPI demo.

在kernel/drivers/spi/Makefile中添加對應的驅動文件名：

obj-$(CONFIG_SPI_FIREFLY) += spi-firefly-demo.o

config中選中所添加的驅動文件，如：

│ Symbol: SPI_FIREFLY [=y] │ Type : tristate │ Prompt: Firefly SPI demo support │ Location: │ -> Device Drivers │ -> SPI support (SPI [=y]) │ Defined at drivers/spi/Kconfig:704 │ Depends on: SPI [=y] && SPI_MASTER [=y]

配置DTS節點

在kernel/arch/arm64/boot/dts/rockchip/rk3399-firefly-demo.dtsi中添加SPI驅動結點描述，如下所示：

/* Firefly SPI demo */ &spi1 { spi_demo: spi-demo@00{ status = "okay"; compatible = "firefly,rk3399-spi"; reg = <0x00>; spi-max-frequency = <48000000>; /* rk3399 driver support SPI_CPOL | SPI_CPHA | SPI_CS_HIGH */ //spi-cpha; /* SPI mode: CPHA=1 */ //spi-cpol; /* SPI mode: CPOL=1 */ //spi-cs-high; }; }; &spidev0 { status = "disabled"; };

status:如果要啟用SPI，則設為okay，如不啟用，設為disable。

spi-demo@00:由于本例子使用CS0，故此處設為00，如果使用CS1，則設為01。

compatible:這里的屬性必須與驅動中的結構體：of_device_id 中的成員compatible 保持一致。

reg:此處與spi-demo@00保持一致，本例設為：0x00。

spi-max-frequency：此處設置spi使用的最高頻率。Firefly-RK3399最高支持48000000。

spi-cpha，spi-cpol：SPI的工作模式在此設置，本例所用的模塊SPI工作模式為SPI_MODE_0或者SPI_MODE_3，這里我們選用SPI_MODE_0，如果使用SPI_MODE_3，spi_demo中打開spi-cpha和spi-cpol即可。

spidev0: 由于spi_demo與spidev0使用一樣的硬件資源，需要把spidev0關掉才能打開spi_demo

定義SPI驅動

在內核源碼目錄kernel/drivers/spi/中創建新的驅動文件，如：spi-firefly-demo.c 在定義 SPI 驅動之前，用戶首先要定義變量 of_device_id 。 of_device_id 用于在驅動中調用dts文件中定義的設備信息，其定義如下所示：

static struct of_device_id firefly_match_table[] = {{ .compatible = "firefly,rk3399-spi",},{},};

此處的compatible與DTS文件中的保持一致。

spi_driver定義如下所示：

static struct spi_driver firefly_spi_driver = { .driver = { .name = "firefly-spi", .owner = THIS_MODULE, .of_match_table = firefly_match_table,}, .probe = firefly_spi_probe, };

注冊SPI設備

在初始化函數static int __init spidev_init(void)中向內核注冊SPI驅動： spi_register_driver(&firefly_spi_driver);

如果內核啟動時匹配成功，則SPI核心會配置SPI的參數（mode、speed等），并調用firefly_spi_probe。

讀寫 SPI 數據

firefly_spi_probe中使用了兩種接口操作讀取W25Q128FV的ID: firefly_spi_read_w25x_id_0接口直接使用了spi_transfer和spi_message來傳送數據。 firefly_spi_read_w25x_id_1接口則使用SPI接口spi_write_then_read來讀寫數據。

成功后會打印：

root@rk3399_firefly_box:/ # dmesg | grep firefly-spi [ 1.006235] firefly-spi spi0.0: Firefly SPI demo program [ 1.006246] firefly-spi spi0.0: firefly_spi_probe: setup mode 0, 8 bits/w, 48000000 Hz max [ 1.006298] firefly-spi spi0.0: firefly_spi_read_w25x_id_0: ID = ef 40 18 00 00 [ 1.006361] firefly-spi spi0.0: firefly_spi_read_w25x_id_1: ID = ef 40 18 00 00

打開SPI demo

spi-firefly-demo默認沒有打開，如果需要的話可以使用以下補丁打開demo驅動：

--- a/kernel/arch/arm64/boot/dts/rockchip/rk3399-firefly-demo.dtsi +++ b/kernel/arch/arm64/boot/dts/rockchip/rk3399-firefly-demo.dtsi @@ -64,7 +64,7 @@ /* Firefly SPI demo */ &spi1 {spi_demo: spi-demo@00{ - status = "disabled"; + status = "okay"; compatible = "firefly,rk3399-spi"; reg = <0x00>; spi-max-frequency = <48000000>; @@ -76,6 +76,6 @@ }; &spidev0 { - status = "okay"; + status = "disabled"; };

常用SPI接口

下面是常用的 SPI API 定義：

void spi_message_init(struct spi_message *m); void spi_message_add_tail(struct spi_transfer *t, struct spi_message *m); int spi_sync(struct spi_device *spi, struct spi_message *message) ; int spi_write(struct spi_device *spi, const void *buf, size_t len); int spi_read(struct spi_device *spi, void *buf, size_t len); ssize_t spi_w8r8(struct spi_device *spi, u8 cmd); ssize_t spi_w8r16(struct spi_device *spi, u8 cmd); ssize_t spi_w8r16be(struct spi_device *spi, u8 cmd); int spi_write_then_read(struct spi_device *spi, const void *txbuf, unsigned n_tx, void *rxbuf, unsigned n_rx);

接口使用

Linux提供了一個功能有限的SPI用戶接口，如果不需要用到IRQ或者其他內核驅動接口，可以考慮使用接口spidev編寫用戶層程序控制SPI設備。 在 Firefly-RK3399 開發板中對應的路徑為： /dev/spidev0.0

spidev對應的驅動代碼： kernel/drivers/spi/spidev.c

內核config需要選上SPI_SPIDEV：

│ Symbol: SPI_SPIDEV [=y] │ Type : tristate │ Prompt: User mode SPI device driver support │ Location: │ -> Device Drivers │ -> SPI support (SPI [=y]) │ Defined at drivers/spi/Kconfig:684 │ Depends on: SPI [=y] && SPI_MASTER [=y]

DTS配置如下：

&spi1 { status = "okay"; max-freq = <48000000>; spidev@00 { compatible = "linux,spidev"; reg = <0x00>; spi-max-frequency = <48000000>; }; };

詳細使用說明請參考文檔 spidev 。

FAQs

Q1: SPI數據傳送異常

A1: 確保 SPI 4個引腳的 IOMUX 配置正確， 確認 TX 送數據時，TX 引腳有正常的波形，CLK 頻率正確，CS 信號有拉低，mode 與設備匹配。