「正点原子Linux连载」第五十四章 platform设备驱动实验（一）

1）实验平台：正点原子Linux开发板
2）摘自《正点原子I.MX6U嵌入式Linux驱动开发指南》
关注官方微信号公众号，获取更多资料：正点原子



第五十四章 platform设备驱动实验
我们在前面几章编写的设备驱动都非常的简单，都是对IO进行最简单的读写操作。像I2C、SPI、LCD等这些复杂外设的驱动就不能这么去写了，Linux系统要考虑到驱动的可重用性，因此提出了驱动的分离与分层这样的软件思路，在这个思路下诞生了我们将来最常打交道的platform设备驱动，也叫做平台设备驱动。本章我们就来学习一下Linux下的驱动分离与分层，以及plartorm框架下的设备驱动该如何不编写。

54.1 Linux驱动的分离与分层54.1.1 驱动的分隔与分离对于Linux这样一个成熟、庞大、复杂的操作系统，代码的重用性非常重要，否则的话就会在Linux内核中存在大量无意义的重复代码。尤其是驱动程序，因为驱动程序占用了Linux内核代码量的大头，如果不对驱动程序加以管理，任由重复的代码肆意增加，那么用不了多久Linux内核的文件数量就庞大到无法接受的地步。
假如现在有三个平台A、B和C，这三个平台(这里的平台说的是SOC)上都有MPU6050这个I2C接口的六轴传感器，按照我们写裸机I2C驱动的时候的思路，每个平台都有一个MPU6050的驱动，因此编写出来的最简单的驱动框架如图54.1.1所示：



图54.1.1 传统的I2C设备驱动
从图54.1.1可以看出，每种平台下都有一个主机驱动和设备驱动，主机驱动肯定是必须要的，毕竟不同的平台其I2C控制器不同。但是右侧的设备驱动就没必要每个平台都写一个，因为不管对于那个SOC来说，MPU6050都是一样，通过I2C接口读取数据就行了，只需要一个MPU6050的驱动程序即可。如果在来几个I2C设备，比如AT24C02、FT5206(电容触摸屏)等，如果按照图54.1.1中的写法，那么设备端的驱动将会重复的编写好几次。显然在Linux驱动程序中这种写法是不推荐的，最好的做法就是每个平台的I2C控制器都提供一个统一的接口(也叫做主机驱动)，每个设备的话也只提供一个驱动程序(设备驱动)，每个设备通过统一的I2C接口驱动来访问，这样就可以大大简化驱动文件，比如54.1.1中三种平台下的MPU6050驱动框架就可以简化为图54.1.2所示：



图54.1.2 改进后的设备驱动
实际的I2C驱动设备肯定有很多种，不止MPU6050这一个，那么实际的驱动架构如图54.1.3所示：



图54.1.3 分隔后的驱动框架
这个就是驱动的分隔，也就是将主机驱动和设备驱动分隔开来，比如I2C、SPI等等都会采用驱动分隔的方式来简化驱动的开发。在实际的驱动开发中，一般I2C主机控制器驱动已经由半导体厂家编写好了，而设备驱动一般也有设备器件的厂家编写好了，我们只需要提供设备信息即可，比如I2C设备的话提供设备连接到了哪个I2C接口上，I2C的速度是多少等等。相当于将设备信息从设备驱动中剥离开来，驱动使用标准方法去获取到设备信息(比如从设备树中获取到设备信息)，然后根据获取到的设备信息来初始化设备。这样就相当于驱动只需要负责驱动，设备只需要设备，想办法将两者进行匹配即可。这个就是Linux中的总线(bus)、驱动(driver)和设备(device)模型，也就是常说的驱动分离。总线就是驱动和设备信息的月老，负责给两者牵线搭桥，如图54.1.4所示：


图54.1.4 Linux总线、驱动和设备模式
当我们向系统注册一个驱动的时候，总线就会在右侧的设备中查找，看看有没有与之匹配的设备，如果有的话就将两者联系起来。同样的，当向系统中注册一个设备的时候，总线就会在左侧的驱动中查找看有没有与之匹配的设备，有的话也联系起来。Linux内核中大量的驱动程序都采用总线、驱动和设备模式，我们一会要重点讲解的platform驱动就是这一思想下的产物。
54.1.2 驱动的分层上一小节讲了驱动的分隔与分离，本节我们来简单看一下驱动的分层，大家应该听说过网络的7层模型，不同的层负责不同的内容。同样的，Linux下的驱动往往也是分层的，分层的目的也是为了在不同的层处理不同的内容。以其他书籍或者资料常常使用到的input(输入子系统，后面会有专门的章节详细的讲解)为例，简单介绍一下驱动的分层。input子系统负责管理所有跟输入有关的驱动，包括键盘、鼠标、触摸等，最底层的就是设备原始驱动，负责获取输入设备的原始值，获取到的输入事件上报给input核心层。input核心层会处理各种IO模型，并且提供file_operations操作集合。我们在编写输入设备驱动的时候只需要处理好输入事件的上报即可，至于如何处理这些上报的输入事件那是上层去考虑的，我们不用管。可以看出借助分层模型可以极大的简化我们的驱动编写，对于驱动编写来说非常的友好。
54.2 platform平台驱动模型简介前面我们讲了设备驱动的分离，并且引出了总线(bus)、驱动(driver)和设备(device)模型，比如I2C、SPI、USB等总线。但是在SOC中有些外设是没有总线这个概念的，但是又要使用总线、驱动和设备模型该怎么办呢？为了解决此问题，Linux提出了platform这个虚拟总线，相应的就有platform_driver和platform_device。
54.2.1platform总线Linux系统内核使用bus_type结构体表示总线，此结构体定义在文件include/linux/device.h，bus_type结构体内容如下：
示例代码54.2.1.1 bus_type结构体代码段
1struct bus_type {
2 constchar*name; /* 总线名字 */
3 constchar*dev_name;
4 struct device *dev_root;
5 struct device_attribute *dev_attrs;
6 conststruct attribute_group **bus_groups; /* 总线属性 */
7 conststruct attribute_group **dev_groups; /* 设备属性 */
8 conststruct attribute_group **drv_groups; /* 驱动属性 */
9
10 int(*match)(struct device *dev,struct device_driver *drv);
11 int(*uevent)(struct device *dev,struct kobj_uevent_env *env);
12 int(*probe)(struct device *dev);
13 int(*remove)(struct device *dev);
14 void(*shutdown)(struct device *dev);
15
16 int(*online)(struct device *dev);
17 int(*offline)(struct device *dev);
18 int(*suspend)(struct device *dev, pm_message_t state);
19 int(*resume)(struct device *dev);
20 conststruct dev_pm_ops *pm;
21 conststruct iommu_ops *iommu_ops;
22 struct subsys_private *p;
23 struct lock_class_key lock_key;
24};
第10行，match函数，此函数很重要，单词match的意思就是“匹配、相配”，因此此函数就是完成设备和驱动之间匹配的，总线就是使用match函数来根据注册的设备来查找对应的驱动，或者根据注册的驱动来查找相应的设备，因此每一条总线都必须实现此函数。match函数有两个参数：dev和drv，这两个参数分别为device和device_driver类型，也就是设备和驱动。
platform总线是bus_type的一个具体实例，定义在文件drivers/base/platform.c，platform总线定义如下：
示例代码54.2.1.2 platform总线实例
1struct bus_type platform_bus_type ={
2 .name ="platform",
3 .dev_groups = platform_dev_groups,
4 .match = platform_match,
5 .uevent = platform_uevent,
6 .pm =&platform_dev_pm_ops,
7};
platform_bus_type就是platform平台总线，其中platform_match就是匹配函数。我们来看一下驱动和设备是如何匹配的，platform_match函数定义在文件drivers/base/platform.c中，函数内容如下所示：
示例代码54.2.1.3 platform总线实例
1staticint platform_match(struct device *dev,
struct device_driver *drv)
2{
3 struct platform_device *pdev = to_platform_device(dev);
4 struct platform_driver *pdrv = to_platform_driver(drv);
5
6 /*When driver_override is set,only bind to the matching driver*/
7 if(pdev->driver_override)
8return!strcmp(pdev->driver_override, drv->name);
9
10 /* Attempt an OF style match first */
11 if(of_driver_match_device(dev, drv))
12 return1;
13
14 /* Then try ACPI style match */
15 if(acpi_driver_match_device(dev, drv))
16 return1;
17
18 /* Then try to match against the id table */
19 if(pdrv->id_table)
20 return platform_match_id(pdrv->id_table, pdev)!=NULL;
21
22 /* fall-back to driver name match */
23 return(strcmp(pdev->name, drv->name)==0);
24}
驱动和设备的匹配有四种方法，我们依次来看一下：
第11~12行，第一种匹配方式， OF类型的匹配，也就是设备树采用的匹配方式，of_driver_match_device函数定义在文件include/linux/of_device.h中。device_driver结构体(表示设备驱动)中有个名为of_match_table的成员变量，此成员变量保存着驱动的compatible匹配表，设备树中的每个设备节点的compatible属性会和of_match_table表中的所有成员比较，查看是否有相同的条目，如果有的话就表示设备和此驱动匹配，设备和驱动匹配成功以后probe函数就会执行。
第15~16行，第二种匹配方式，ACPI匹配方式。
第19~20行，第三种匹配方式，id_table匹配，每个platform_driver结构体有一个id_table成员变量，顾名思义，保存了很多id信息。这些id信息存放着这个platformd驱动所只是的驱动类型。
第23行，第四种匹配方式，如果第三种匹配方式的id_table不存在的话就直接比较驱动和设备的name字段，看看是不是相等，如果相等的话就匹配成功。
对于支持设备树的Linux版本号，一般设备驱动为了兼容性都支持设备树和无设备树两种匹配方式。也就是第一种匹配方式一般都会存在，第三种和第四种只要存在一种就可以，一般用的最多的还是第四种，也就是直接比较驱动和设备的name字段，毕竟这种方式最简单了。
54.2.2 platform驱动platform_driver结构体表示platform驱动，此结构体定义在文件include/linux/platform_device.h中，内容如下：
示例代码54.2.2.1 platform_driver结构体
1struct platform_driver {
2 int(*probe)(struct platform_device *);
3 int(*remove)(struct platform_device *);
4 void(*shutdown)(struct platform_device *);
5 int(*suspend)(struct platform_device *, pm_message_t state);
6 int(*resume)(struct platform_device *);
7 struct device_driver driver;
8 conststruct platform_device_id *id_table;
9 bool prevent_deferred_probe;
10};
第2行，probe函数，当驱动与设备匹配成功以后probe函数就会执行，非常重要的函数！！一般驱动的提供者会编写，如果自己要编写一个全新的驱动，那么probe就需要自行事项。
第7行，driver成员，为device_driver结构体变量，Linux内核里面大量使用到了面向对象的思维，device_driver相当于基类，提供了最基础的驱动框架。plaform_driver继承了这个基类，然后在此基础上又添加了一些特有的成员变量。
第8行，id_table表，也就是我们上一小节讲解platform总线匹配驱动和设备的时候采用的第三种方法，id_table是个表(也就是数组)，每个元素的类型为platform_device_id，platform_device_id结构体内容如下：
示例代码54.2.2.2 platform_device_id结构体
1struct platform_device_id {
2 char name[PLATFORM_NAME_SIZE];
3 kernel_ulong_t driver_data;
4};
device_driver结构体定义在include/linux/device.h，device_driver结构体内容如下：
示例代码54.2.2.3 device_driver结构体
1struct device_driver {
2constchar *name;
3struct bus_type *bus;
4
5struct module *owner;
6constchar *mod_name;/* used for built-in modules */
7
8bool suppress_bind_attrs;/* disables bind/unbind via sysfs */
9
10conststruct of_device_id *of_match_table;
11conststruct acpi_device_id *acpi_match_table;
12
13int(*probe)(struct device *dev);
14int(*remove)(struct device *dev);
15void(*shutdown)(struct device *dev);
16int(*suspend)(struct device *dev, pm_message_t state);
17int(*resume)(struct device *dev);
18conststruct attribute_group **groups;
19
20conststruct dev_pm_ops *pm;
21
22struct driver_private *p;
23};
第10行，of_match_table就是采用设备树的时候驱动使用的匹配表，同样是数组，每个匹配项都为of_device_id结构体类型，此结构体定义在文件include/linux/mod_devicetable.h中，内容如下：
示例代码54.2.2.4 of_device_id结构体
1struct of_device_id {
2char name[32];
3char type[32];
4char compatible[128];
5constvoid *data;
6};
第4行的compatible非常重要，因为对于设备树而言，就是通过设备节点的compatible属性值和of_match_table中每个项目的compatible成员变量进行比较，如果有相等的就表示设备和此驱动匹配成功。
在编写platform驱动的时候，首先定义一个platform_driver结构体变量，然后实现结构体中的各个成员变量，重点是实现匹配方法以及probe函数。当驱动和设备匹配成功以后probe函数就会执行，具体的驱动程序在probe函数里面编写，比如字符设备驱动等等。
当我们定义并初始化好platform_driver结构体变量以后，需要在驱动入口函数里面调用platform_driver_register函数向Linux内核注册一个platform驱动，platform_driver_register函数原型如下所示：
int platform_driver_register (struct platform_driver *driver)
函数参数和返回值含义如下：
driver：要注册的platform驱动。
返回值：负数，失败；0，成功。
还需要在驱动卸载函数中通过platform_driver_unregister函数卸载platform驱动，platform_driver_unregister函数原型如下：
void platform_driver_unregister(struct platform_driver *drv)
函数参数和返回值含义如下：
drv：要卸载的platform驱动。
返回值：无。
platform驱动框架如下所示：
示例代码54.2.2.5 platform驱动框架
/* 设备结构体 */
1 struct xxx_dev{
2 struct cdev cdev;
3 /* 设备结构体其他具体内容 */
4 };
5
6 struct xxx_dev xxxdev;/* 定义个设备结构体变量 */
7
8 staticint xxx_open(struct inode *inode,struct file *filp)
9 {
10 /* 函数具体内容 */
11 return0;
12 }
13
14static ssize_t xxx_write(struct file *filp,constchar __user *buf,
size_t cnt, loff_t *offt)
15 {
16 /* 函数具体内容 */
17 return0;
18 }
19
20/*
21 * 字符设备驱动操作集
22 */
23 staticstruct file_operations xxx_fops ={
24 .owner = THIS_MODULE,
25 .open = xxx_open,
26 .write = xxx_write,
27 };
28
29/*
30 * platform驱动的probe函数
31 * 驱动与设备匹配成功以后此函数就会执行
32 */
33 staticint xxx_probe(struct platform_device *dev)
34 {
35 ......
36 cdev_init(&xxxdev.cdev,&xxx_fops);/* 注册字符设备驱动 */
37 /* 函数具体内容 */
38 return0;
39 }
40
41 staticintxxx_remove(struct platform_device *dev)
42 {
43 ......
44 cdev_del(&xxxdev.cdev);/* 删除cdev */
45 /* 函数具体内容 */
46 return0;
47 }
48
49/* 匹配列表 */
50staticconststruct of_device_id xxx_of_match[]={
51 {.compatible ="xxx-gpio"},
52 {/* Sentinel */}
53};
54
55/*
56 * platform平台驱动结构体
57 */
58 staticstruct platform_driver xxx_driver ={
59 .driver ={
60 .name ="xxx",
61 .of_match_table = xxx_of_match,
62 },
63 .probe = xxx_probe,
64 .remove = xxx_remove,
65 };
66
67 /* 驱动模块加载 */
68 staticint __init xxxdriver_init(void)
69 {
70 return platform_driver_register(&xxx_driver);
71}
72
73 /* 驱动模块卸载 */
74 staticvoid __exit xxxdriver_exit(void)
75 {
76 platform_driver_unregister(&xxx_driver);
77 }
78
79 module_init(xxxdriver_init);
80 module_exit(xxxdriver_exit);
81 MODULE_LICENSE("GPL");
82 MODULE_AUTHOR("zuozhongkai");
第1~27行，传统的字符设备驱动，所谓的platform驱动并不是独立于字符设备驱动、块设备驱动和网络设备驱动之外的其他种类的驱动。platform只是为了驱动的分离与分层而提出来的一种框架，其驱动的具体实现还是需要字符设备驱动、块设备驱动或网络设备驱动。
第33~39行，xxx_probe函数，当驱动和设备匹配成功以后此函数就会执行，以前在驱动入口init函数里面编写的字符设备驱动程序就全部放到此probe函数里面。比如注册字符设备驱动、添加cdev、创建类等等。
第41~47行，xxx_remove函数，platform_driver结构体中的remove成员变量，当关闭platfor备驱动的时候此函数就会执行，以前在驱动卸载exit函数里面要做的事情就放到此函数中来。比如，使用iounmap释放内存、删除cdev，注销设备号等等。
第50~53行，xxx_of_match匹配表，如果使用设备树的话将通过此匹配表进行驱动和设备的匹配。第51行设置了一个匹配项，此匹配项的compatible值为“xxx-gpio”，因此当设备树中设备节点的compatible属性值为“xxx-gpio”的时候此设备就会与此驱动匹配。第52行是一个标记，of_device_id表最后一个匹配项必须是空的。
第58~65行，定义一个platform_driver结构体变量xxx_driver，表示platform驱动，第59~62行设置paltform_driver中的device_driver成员变量的name和of_match_table这两个属性。其中name属性用于传统的驱动与设备匹配，也就是检查驱动和设备的name字段是不是相同。of_match_table属性就是用于设备树下的驱动与设备检查。对于一个完整的驱动程序，必须提供有设备树和无设备树两种匹配方法。最后63和64这两行设置probe和remove这两成员变量。
第68~71行，驱动入口函数，调用platform_driver_register函数向Linux内核注册一个platform驱动，也就是上面定义的xxx_driver结构体变量。
第74~77行，驱动出口函数，调用platform_driver_unregister函数卸载前面注册的platform驱动。
总体来说，platform驱动还是传统的字符设备驱动、块设备驱动或网络设备驱动，只是套上了一张“platform”这张皮皮，目的是为了使用总线、驱动和设备这个驱动模型来实现驱动的分离与分层。
54.2.3 platform设备platform驱动已经准备好了，我们还需要platform设备，否则的话单单一个驱动也做不了什么。platform_device这个结构体表示platform设备，这里我们要注意，如果内核支持设备树的话就不要在使用platform_device来描述设备了，因为改用设备树去描述了。当然了，你如果一定要用platform_device来描述设备信息的话也是可以的。platform_device结构体定义在文件include/linux/platform_device.h中，结构体内容如下：
示例代码54.2.3.1 platform_device结构体代码段
22struct platform_device {
23 constchar*name;
24 int id;
25 bool id_auto;
26 struct device dev;
27 u32 num_resources;
28 struct resource *resource;
29
30 conststruct platform_device_id *id_entry;
31 char*driver_override;/* Driver name to force a match */
32
33 /* MFD cell pointer */
34 struct mfd_cell *mfd_cell;
35
36 /* arch specific additions */
37 struct pdev_archdata archdata;
38};
第23行，name表示设备名字，要和所使用的platform驱动的name字段相同，否则的话设备就无法匹配到对应的驱动。比如对应的platform驱动的name字段为“xxx-gpio”，那么此name字段也要设置为“xxx-gpio”。
第27行，num_resources表示资源数量，一般为第28行resource资源的大小。
第28行，resource表示资源，也就是设备信息，比如外设寄存器等。Linux内核使用resource结构体表示资源，resource结构体内容如下：
示例代码54.2.3.2 resource结构体代码段
18struct resource {
19 resource_size_t start;
20 resource_size_t end;
21 constchar *name;
22 unsignedlong flags;
23 struct resource *parent,*sibling,*child;
24};
start和end分别表示资源的起始和终止信息，对于内存类的资源，就表示内存起始和终止地址，name表示资源名字，flags表示资源类型，可选的资源类型都定义在了文件include/linux/ioport.h里面，如下所示：
示例代码54.2.3.3 资源类型
29 #define IORESOURCE_BITS 0x000000ff/* Bus-specific bits */
30
31 #define IORESOURCE_TYPE_BITS 0x00001f00/* Resource type */
32 #define IORESOURCE_IO 0x00000100/* PCI/ISA I/O ports */
33 #define IORESOURCE_MEM 0x00000200
34 #define IORESOURCE_REG 0x00000300/* Register offsets */
35 #define IORESOURCE_IRQ 0x00000400
36 #define IORESOURCE_DMA 0x00000800
37 #define IORESOURCE_BUS 0x00001000
......
104/* PCI control bits. Shares IORESOURCE_BITS with above PCI ROM. */
105 #define IORESOURCE_PCI_FIXED (1<<4)/* Do not move resource */
在以前不支持设备树的Linux版本中，用户需要编写platform_device变量来描述设备信息，然后使用platform_device_register函数将设备信息注册到Linux内核中，此函数原型如下所示：
int platform_device_register(struct platform_device *pdev)
函数参数和返回值含义如下：
pdev：要注册的platform设备。
返回值：负数，失败；0，成功。
如果不再使用platform的话可以通过platform_device_unregister函数注销掉相应的platform设备，platform_device_unregister函数原型如下：
void platform_device_unregister(struct platform_device *pdev)
函数参数和返回值含义如下：
pdev：要注销的platform设备。
返回值：无。
platform设备信息框架如下所示：
示例代码54.2.3.4 platform设备框架
1/* 寄存器地址定义*/
2 #define PERIPH1_REGISTER_BASE (0X20000000)/* 外设1寄存器首地址 */
3 #define PERIPH2_REGISTER_BASE (0X020E0068)/* 外设2寄存器首地址 */
4 #define REGISTER_LENGTH 4
5
6/* 资源 */
7staticstruct resource xxx_resources[]={
8 [0]={
9 .start = PERIPH1_REGISTER_BASE,
10 .end =(PERIPH1_REGISTER_BASE + REGISTER_LENGTH -1),
11 .flags = IORESOURCE_MEM,
12 },
13 [1]={
14 .start = PERIPH2_REGISTER_BASE,
15 .end =(PERIPH2_REGISTER_BASE + REGISTER_LENGTH -1),
16 .flags = IORESOURCE_MEM,
17 },
18};
19
20/* platform设备结构体 */
21staticstruct platform_device xxxdevice ={
22 .name ="xxx-gpio",
23 .id =-1,
24 .num_resources = ARRAY_SIZE(xxx_resources),
25 .resource = xxx_resources,
26};
27
28/* 设备模块加载 */
29staticint __init xxxdevice_init(void)
30{
31 return platform_device_register(&xxxdevice);
32}
33
34/* 设备模块注销 */
35staticvoid __exit xxx_resourcesdevice_exit(void)
36{
37 platform_device_unregister(&xxxdevice);
38}
39
40 module_init(xxxdevice_init);
41 module_exit(xxxdevice_exit);
42 MODULE_LICENSE("GPL");
43 MODULE_AUTHOR("zuozhongkai");
第7~18行，数组xxx_resources表示设备资源，一共有两个资源，分别为设备外设1和外设2的寄存器信息。因此flags都为IORESOURCE_MEM，表示资源为内存类型的。
第21~26行，platform设备结构体变量，注意name字段要和所使用的驱动中的name字段一致，否则驱动和设备无法匹配成功。num_resources表示资源大小，其实就是数组xxx_resources的元素数量，这里用ARRAY_SIZE来测量一个数组的元素个数。
第29~32行，设备模块加载函数，在此函数中调用platform_device_register向Linux内核注册platform设备。
第35~38行，设备模块卸载函数，在此函数中调用platform_device_unregister从Linux内核中卸载platform设备。
示例代码54.2.3.4主要是在不支持设备树的Linux版本中使用的，当Linux内核支持了设备树以后就不需要用户手动去注册platform设备了。因为设备信息都放到了设备树中去描述，Linux内核启动的时候会从设备树中读取设备信息，然后将其组织成platform_device形式，至于设备树到platform_device的具体过程就不去详细的追究了，感兴趣的可以去看一下，网上也有很多博客详细的讲解了整个过程。
关于platform下的总线、驱动和设备就讲解到这里，我们接下来就使用platform驱动框架来编写一个LED灯驱动，本章我们不使用设备树来描述设备信息，我们采用自定义platform_device这种“古老”方式来编写LED的设备信息。下一章我们来编写设备树下的platform驱动，这样我们就掌握了无设备树和有设备树这两种platform驱动的开发方式。