Linux学习第40天：Linux SPI 驱动实验（一）：乾坤大挪移

Linux版本号4.1.15 芯片I.MX6ULL 大叔学Linux 品人间百味思文短情长

主从工作方式完成数据交换，形象的说就是武侠中的乾坤大挪移。

本章实验的最终目的就是驱动 I.MX6UALPHA 开发板上的 ICM-20608 这个 SPI 接口的六轴传感器，可以在应用程序中读取 ICM-20608的原始传感器数据。

本章的思维导图如下：

一、Linux 下SPI驱动框架简介

重点在SPI 设备驱动编写。

1、SPI主机驱动

Linux 内核使用 spi_master 表示 SPI 主机驱动， spi_master 是个结构体:

315 struct spi_master {
316 struct device dev;
317
318 struct list_head list;
......
326 s16 bus_num;
327
328 /* chipselects will be integral to many controllers; some others
329 * might use board-specific GPIOs.
330 */
331 u16 num_chipselect;
332
333 /* some SPI controllers pose alignment requirements on DMAable
334 * buffers; let protocol drivers know about these requirements.
335 */
336 u16 dma_alignment;
337
338 /* spi_device.mode flags understood by this controller driver */
339 u16 mode_bits;
340
341 /* bitmask of supported bits_per_word for transfers */
342 u32 bits_per_word_mask;
......
347 /* limits on transfer speed */
348 u32 min_speed_hz;
349 u32 max_speed_hz;
350
351 /* other constraints relevant to this driver */
352 u16 flags;
359 /* lock and mutex for SPI bus locking */
360 spinlock_t bus_lock_spinlock;
361 struct mutex bus_lock_mutex;
362
363 /* flag indicating that the SPI bus is locked for exclusive use */
364 bool bus_lock_flag;
......
372 int (*setup)(struct spi_device *spi);
373
......
393 int (*transfer)(struct spi_device *spi,/*transfer 函数，和 i2c_algorithm 中的 master_xfer 函数一样，控制器数据传输函
数。*/
394 struct spi_message *mesg);/*transfer_one_message 函数，也用于 SPI 数据发送，用于发送一个 spi_message，
SPI 的数据会打包成 spi_message，然后以队列方式发送出去。*/
......
434 int (*transfer_one_message)(struct spi_master *master,
435 struct spi_message *mesg);
......
462 };

SPI 主机驱动的核心就是申请 spi_master，然后初始化 spi_master，最后向 Linux 内核注册spi_master。

1）、spi_master 申请与释放

struct spi_master *spi_alloc_master(struct device *dev,
unsigned size)

dev：设备，一般是 platform_device 中的 dev 成员变量。
size：私有数据大小，可以通过 spi_master_get_devdata 函数获取到这些私有数据。
返回值：申请到的 spi_master。
spi_master 的释放通过 spi_master_put 函数来完成，当我们删除一个 SPI 主机驱动的时候就
需要释放掉前面申请的 spi_master， spi_master_put 函数原型如下：

void spi_master_put(struct spi_master *master)

master：要释放的 spi_master。

2）、spi_master 的注册与注销

当 spi_master 初始化完成以后就需要将其注册到 Linux 内核， spi_master 注册函数为
spi_register_master，函数原型如下：

int spi_register_master(struct spi_master *master)

master：要注册的 spi_master。
返回值： 0，成功；负值，失败。
I.MX6U 的 SPI 主机驱动会采用 spi_bitbang_start 这个 API 函数来完成 spi_master 的注册，spi_bitbang_start 函数内部其实也是通过调用 spi_register_master 函数来完成 spi_master 的注册。
如果要注销 spi_master 的话可以使用 spi_unregister_master 函数，此函数原型为：

void spi_unregister_master(struct spi_master *master)

如果使用 spi_bitbang_start 注册 spi_master 的话就要使用 spi_bitbang_stop 来注销掉
spi_master。

2、SPI设备驱动

Linux 内核使用 spi_driver 结构体来表示 spi 设备驱动。

180 struct spi_driver {
181 const struct spi_device_id *id_table;
182 int (*probe)(struct spi_device *spi);
183 int (*remove)(struct spi_device *spi);
184 void (*shutdown)(struct spi_device *spi);
185 struct device_driver driver;
186 };

spi_driver 初始化完成以后需要向 Linux 内核注册， spi_driver 注册函数为
spi_register_driver，函数原型如下：

int spi_register_driver(struct spi_driver *sdrv)

注销 SPI 设备驱动以后也需要注销掉前面注册的 spi_driver，使用 spi_unregister_driver 函
数完成 spi_driver 的注销，函数原型如下：

void spi_unregister_driver(struct spi_driver *sdrv)

spi_driver 注册示例程序如下：

1 /* probe 函数 *//*第 1~36 行， spi_driver 结构体，需要 SPI 设备驱动人员编写，包括匹配表、 probe 函数等。
和 i2c_driver、 platform_driver 一样*/
2 static int xxx_probe(struct spi_device *spi)
3 {
4 /* 具体函数内容 */
5 return 0;
6 }
7 8
/* remove 函数 */
9 static int xxx_remove(struct spi_device *spi)
10 {
11 /* 具体函数内容 */
12 return 0;
13 }
14 /* 传统匹配方式 ID 列表 */
15 static const struct spi_device_id xxx_id[] = {
16 {"xxx", 0},
17 {}
18 };
19
20 /* 设备树匹配列表 */
21 static const struct of_device_id xxx_of_match[] = {
22 { .compatible = "xxx" },
23 { /* Sentinel */ }
24 };
25
26 /* SPI 驱动结构体 */
27 static struct spi_driver xxx_driver = {
28 .probe = xxx_probe,
29 .remove = xxx_remove,
30 .driver = {
31 .owner = THIS_MODULE,
32 .name = "xxx",
33 .of_match_table = xxx_of_match,
34 },
35 .id_table = xxx_id,
36 };
37
38 /* 驱动入口函数 */
39 static int __init xxx_init(void)/*第 39~42 行，在驱动入口函数中调用 spi_register_driver 来注册 spi_driver。*/
40 
41 return spi_register_driver(&xxx_driver);
42 }
43
44 /* 驱动出口函数 */
45 static void __exit xxx_exit(void)/*第 45~48 行，在驱动出口函数中调用 spi_unregister_driver 来注销 spi_driver。*/
46 {
47 spi_unregister_driver(&xxx_driver);
48 }
49
50 module_init(xxx_init);
51 module_exit(xxx_exit);

3、SPI设备和驱动匹配

SPI 设备和驱动的匹配过程是由 SPI 总线来完成的，SPI总线为 spi_bus_type，定义在 drivers/spi/spi.c 文件中，内容如下：

131 struct bus_type spi_bus_type = {
132 .name = "spi",
133 .dev_groups = spi_dev_groups,
134 .match = spi_match_device,
135 .uevent = spi_uevent,
136 };

SPI 设备和驱动的匹配函数为 spi_match_device，函数内容如下：

99 static int spi_match_device(struct device *dev,
struct device_driver *drv)
100 {
101 const struct spi_device *spi = to_spi_device(dev);
102 const struct spi_driver *sdrv = to_spi_driver(drv);
103
104 /* Attempt an OF style match */
105 if (of_driver_match_device(dev, drv))/*第 105 行， of_driver_match_device 函数用于完成设备树设备和驱动匹配。比较 SPI 设备节
点的 compatible 属性和 of_device_id 中的 compatible 属性是否相等，如果相当的话就表示 SPI 设
备和驱动匹配。*/
106 return 1;
107
108 /* Then try ACPI */
109 if (acpi_driver_match_device(dev, drv))/*acpi_driver_match_device 函数用于 ACPI 形式的匹配。*/
110 return 1;
111
112 if (sdrv->id_table)
113 return !!spi_match_id(sdrv->id_table, spi);/*spi_match_id 函数用于传统的、无设备树的 SPI 设备和驱动匹配过程。比较 SPI
设备名字和 spi_device_id 的 name 字段是否相等，相等的话就说明 SPI 设备和驱动匹配。*/
114
115 return strcmp(spi->modalias, drv->name) == 0;/*比较 spi_device 中 modalias 成员变量和 device_driver 中的 name 成员变量是否
相等*/
116 }

以下内容将在下一节学习：

二、I.MX6U SPI主机驱动分析

三、SPI设备驱动编写流程

1、SPI设备信息描述

2、SPI设备数据收发处理流程

四、硬件原理图分析

五、实验程序编写

1、修改设备树

2、编写ICM20608驱动

3、编写测试APP

六、运行测试

1、编译驱动程序和测试APP