正点原子嵌入式linux驱动开发——platform设备驱动

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

Linux驱动的分离与分层

驱动的分隔与分离

对于Linux这样一个成熟、庞大、复杂的操作系统，代码的重用性非常重要，否则的话就会在Linux内核中存在大量无意义的重复代码。尤其是驱动程序，因为驱动程序占用了Linux内核代码量的大头，如果不对驱动程序加以管理，任由重复的代码肆意增加，那么用不了多久Linux内核的文件数量就庞大到无法接受的地步。

假如现在有三个平台A、B和C，这三个平台(这里的平台说的是SOC)上都有MPU6050这个I2C接口的六轴传感器，按照写裸机I2C驱动的时候的思路，每个平台都有一个MPU6050的驱动，因此编写出来的最简单的驱动框架如下图所示：

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

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

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

当向系统注册一个驱动的时候，总线就会在右侧的设备中查找，看看有没有与之匹配的设备，如果有的话就将两者联系起来。同样的，当向系统中注册一个设备的时候，总线就会在左侧的驱动中查找看有没有与之匹配的设备，有的话也联系起来。Linux内核中大量的驱动程序都采用总线、驱动和设备模式，platform驱动就是这一思想下的产物。

驱动的分层

上一小节讲了驱动的分隔与分离，本节来简单看一下驱动的分层。Linux下的驱动往往也是分层的，分层的目的也是为了在不同的层处理不同的内容。以其他书籍或者资料常常使用到的input(输入子系统，后面会有专门的章节详细的讲解)为例，简单介绍一下驱动的分层。input子系统负责管理所有跟输入有关的驱动，包括键盘、鼠标、触摸等，最底层的就是设备原始驱动，负责获取输入设备的原始值 ，获取到的输入事件上报给input核心层。input核心层会处理各种IO模型，并且提供file_operations操作集合。在编写输入设备驱动的时候只需要处理好输入事件的上报即可。可以看出借助分层模型可以极大的简化驱动编写，对于驱动编写来说非常的友好。

platform平台驱动模型简介

前面讲了设备驱动的分离，并且引出了总线(bus)、驱动(driver)和设备(device)模型，比如I2C、SPI、USB等总线。在SOC中有些外设是没有总线这个概念的，但是又要使用总线、驱动和设备模型该怎么办呢？为了解决此问题，Linux提出了platform这个虚拟总线，相应的就有platform_driver和platform_device。

platform总线

Linux系统内核使用bus_type结构体表示总线，此结构体定义在文件include/linux/device.h，bus_type结构体内容如下：

第8行，match函数，此函数很重要，就是完成设备和驱动之间匹配的，总线就是使用match函数来根据注册的设备来查找对应的驱动，或者根据注册的驱动来查找相应的设备，因此每一条总线都必须实现此函数。match函数有两个参数：dev和drv，这两个参数分别为device和device_driver类型，也就是设备和驱动。

platform总线是bus_type的一个具体实例，定义在文件drivers/base/platform.c，platform总线定义如下：

platform_bus_type就是platform平台总线，其中platform_match就是匹配函数。来看一下驱动和设备是如何匹配的，platform_match函数定义在文件drivers/base/platform.c中，函数内容如下所示：

驱动和设备的匹配有四种方法，依次来看一下：

第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信息存放着这个platformd驱动所支持的驱动类型。

第23行，第四种匹配方式，如果第三种匹配方式的id_table不存在的话就直接比较驱动和设备的name字段，看看是不是相等，如果相等的话就匹配成功。

对于支持设备树的Linux版本号，一般设备驱动为了兼容性都支持设备树和无设备树两种匹配方式。也就是第一种匹配方式一般都会存在，第三种和第四种只要存在一种就可以，一般用的最多的还是第四种，也就是直接比较驱动和设备的name字段。

platform驱动

platform_driver结构体表示platform驱动，此结构体定义在文件include/linux/platform_device.h中，内容如下：

第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结构体内容如下：

device_driver结构体定义在include/linux/device.h，device_driver结构体内容如下：

第8行，of_match_table就是采用设备树的时候驱动使用的匹配表，同样是数组，每个匹配项都为of_device_id结构体类型，此结构体定义在文件include/linux/mod_devicetable.h中，内容如下：

第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驱动框架如下所示：

示例代码34.2.2.5 platform驱动框架 
/* 设备结构体 */ 
1  struct xxx_dev{ 
2      struct cdev cdev; 
3      /* 设备结构体其他具体内容 */ 
4  }; 
5 
6  struct xxx_dev xxxdev; /* 定义个设备结构体变量 */ 
7
8  static int xxx_open(struct inode *inode, struct file *filp) 
9  { 
10     /* 函数具体内容 */ 
11     return 0; 
12 } 
13 
14 static ssize_t xxx_write(struct file *filp, const char __user *buf, size_t cnt, loff_t *offt) 
15 { 
16     /* 函数具体内容 */ 
17     return 0; 
18 } 
19 
20 /* 
21 * 字符设备驱动操作集 
22 */ 
23 static struct 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 static int xxx_probe(struct platform_device *dev) 
34 { 
35     ...... 
36     cdev_init(&xxxdev.cdev, &xxx_fops); /* 注册字符设备驱动 */ 
37     /* 函数具体内容 */ 
38     return 0; 
39 } 
40 
41 static int xxx_remove(struct platform_device *dev) 
42 { 
43     ...... 
44     cdev_del(&xxxdev.cdev);/* 删除cdev */ 
45     /* 函数具体内容 */ 
46     return 0; 
47 } 
48 
49 /* 匹配列表 */
50 static const struct of_device_id xxx_of_match[] = { 
51     { .compatible = "xxx-gpio" }, 
52     { /* Sentinel */ } 
53 }; 
54 
55 /* 
56 * platform平台驱动结构体 
57 */ 
58 static struct 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 static int __init xxxdriver_init(void) 
69 { 
70     return platform_driver_register(&xxx_driver); 
71 } 
72 
73 /* 驱动模块卸载 */ 
74 static void __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”的皮，目的是为了使用总线、驱动和设备这个驱动模型来实现驱动的分离与分层。

platform设备

platform驱动已经准备好了，还需要platform设备，否则的话单单一个驱动也做不了什么。platform_device这个结构体表示platform设备，这里要注意，如果内核支持设备树的话就不要再使用platform_device来描述设备了，因为改用设备树去描述了。当然了，如果一定要用platform_device来描述设备信息的话也是可以的。platform_device结构体定义在文件include/linux/platform_device.h中，结构体内容如下：

第2行，name表示设备名字，要和所使用的platform驱动的name字段相同，否则的话设备就无法匹配到对应的驱动。比如对应的platform驱动的name字段为“xxx-gpio”，那么此name字段也要设置为“xxx-gpio”。

第7行，num_resources表示资源数量，一般为第8行resource资源的大小。

第8行，resource表示资源，也就是设备信息，比如外设寄存器等。Linux内核使用resource结构体表示资源，resource结构体定义在include/linux/ioport.h文件里面，内容为：

start和end分别表示资源的起始和终止信息，对于内存类的资源，就表示内存起始和终止地址，name表示资源名字，flags表示资源类型，可选的资源类型都定义在了文件include/linux/ioport.h里面，如下所示：

在以前不支持设备树的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  /* 资源 */ 
7  static struct 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设备结构体 */ 
21 static struct platform_device xxxdevice = { 
22     .name = "xxx-gpio", 
23     .id = -1, 
24     .num_resources = ARRAY_SIZE(xxx_resources), 
25     .resource = xxx_resources, 
26 }; 
27 
28 /* 设备模块加载 */ 
29 static int __init xxxdevice_init(void) 
30 { 
31     return platform_device_register(&xxxdevice); 
32 } 
33 
34 /* 设备模块注销 */ 
35 static void __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设备。

示例代码34.2.3.4主要是在不支持设备树的Linux版本中使用的，当Linux内核支持了设备树以后就不需要用户手动去注册platform设备了。因为设备信息都放到了设备树中去描述，Linux内核启动的时候会从设备树中读取设备信息，然后将其组织成platform_device形式，至于设备树到platform_device的具体过程就不去详细的追究了。

关于platform下的总线、驱动和设备就讲解到这里，接下来就使用platform驱动框架来编写一个LED灯驱动，本章不使用设备树来描述设备信息，我们采用自定义platform_device这种“古老”方式来编写LED的设备信息。下一章来编写设备树下的platform驱动，这样就掌握了无设备树和有设备树这两种platform驱动的开发方式。

硬件原理图分析

这里使用的就是LED灯，之前已经有过分析。

实验程序编写

本章实验需要编写一个驱动模块和一个设备模块，其中驱动模块是platform驱动程序，设备模块是platform的设备信息。当这两个模块都加载成功以后就会匹配成功，然后platform驱动模块中的probe函数就会执行，probe函数中就是传统的字符设备驱动。

platform设备与驱动程序编写

如果采用platform设备，就需要自行先查询寄存器地址，然后进行编写。

这些设备信息，都写在resource类型的led_resources[]数组中，对于LED灯来说，所有的flag都是内存，一共有6个寄存器需要编写；然后需要写一个platform_device类型的leddevice设备结构体，其中.dev的.release函数需要自行实现，这里就在函数中直接printk就可以，而.resource就是刚编写的led_resources。

之后的驱动入口函数leddevice_init中，调用platform_device_register加载leddevice；而驱动出口函数leddevice_exit中，调用platform_device_unregister(&leddevice)来卸载。

以上就是leddevice.c，完成了设备文件，接下来编写leddriver这个platform驱动文件。

同样的，需要先__iomem来定义寄存器映射后的虚拟地址指针；然后定义设备结构体leddev_dev然后具象化为leddev；led_switch就是之前笔记中的直接操作寄存器来控制LED；同样还要实现led_unmap来取消映射，里面就是iounmap刚定义的6个虚拟地址。

led_write中，就跟之前的寄存器版本的一样，copy_from_user之后，直接把这个写入的数据获取到，然后通过状态来操作led_switch控制LED。file_operations操作集主要就是open和write以及最开始的owner这三个。

最后要实现platform的probe函数led_probe，首先for循环来获取资源，把platform_get_resource获取的喜欢存到自定义的ledsource数组中，然后把resource_size的结果存到ressize数组中；之后初始化LED，通过ioremap获取寄存器映射地址；之后就是寄存器操作版本的GPIO初始化操作。

完成GPIO初始化之后，完成字符设备的一系列注册，先alloc_chrdev_region申请设备号，然后cdev_init初始化cdev；之后cdev_add添加一个cdev；class_create创建类；之后device_create创建设备。

之后实现led_remove，完成platform的remove函数，其中需要led_unmap取消映射，之后cdev_del删除cdev，unregister_chedev_region注销设备号；注销设备device_destroy，并注销类class_destroy。

实现platform的驱动结构体platform_driver类型的led_driver，其中实现.driver里面写驱动名字，保持和设备的一致，然后就是.probe和.remove。

驱动的加载和卸载与之前的platform设备是一样的，分别在里面调用platform_driver_register和platform_driver_unregister。

测试APP编写

这里与最开始编写的字符设备驱动的测试APP就是一样的，直接open设备之后，通过atoi(argv[2])读取到要执行的操作，然后调用write来执行，最后close关闭文件。

运行测试

编译驱动模块

这里还是只要修改一下Makefile的obj-m，不过这里有两个.o文件，一个是leddevice.o，一个是leddriver.o文件；完成后“make”一下就可以了。

编译测试APP

输入如下命令编译：

arm-none-linux-gnueabihf-gcc ledApp.c -o ledApp

运行测试

将上一小节编译出来leddevice.ko、leddriver.ko和ledApp这两个文件拷贝到rootfs/lib/modules/5.4.31目录中，重启开发板，进入到目录lib/modules/5.4.31中，输入如下命令加载leddevice.ko设备模块和leddriver.ko这个驱动模块。

depmod //第一次加载驱动的时候需要运行此命令 modprobe leddevice.ko //加载设备模块 modprobe leddriver.ko //加载驱动模块

根文件系统中/sys/bus/platform/目录下保存着当前板子platform总线下的设备和驱动，其中devices子目录为platform设备，drivers子目录为plartofm驱动。进入/sys/bus/platform/devices/目录，查看设备是否存在，在leddevice.c中设置设备的name字段为“stm32mp1-led”，因此肯定在/sys/bus/platform/devices/目录下存在一个名字“stm32mp1-led”的文件，否则说明设备模块加载失败；同理，同理，查看/sys/bus/platform/drivers/目录，看一下驱动是否存在，在leddriver.c中设置name字段为“stm32mp1-led”，因此会在/sys/bus/platform/drivers/目录下存在名为“stm32mp1-led”这个文件。

驱动模块和设备模块加载成功以后platform总线就会进行匹配，当驱动和设备匹配成功以后就会输出如下图所示一行语句：

驱动和设备匹配成功以后就可以测试LED灯驱动了，输入如下命令打开和关闭LED灯：

./ledApp /dev/platled 1 //打开LED灯 ./ledApp /dev/platled 0 //关闭LED灯

如果要卸载驱动的话输入如下命令即可：

rmmod leddevice.ko rmmod leddriver.ko

总结

platform设备驱动的方法，可以帮助我们对Linux的驱动进行分离，把相似的统一接口抽象出来。

使用platform驱动，需要编写platform设备以及platform驱动两个.c文件。

platform设备的文件中，需要自行查询寄存器物理地址并设置，然后通过resource结构体led_resources[]存储这些寄存器信息，然后添加platform_device类型的设备结构体，填入.name，.id，.dev(实现.release，release里面直接printk就可以)，.num_resources和.resource，就是刚才写好的led_resources；最后驱动的加载和注销函数写一下，就是直接platform_device_register和platform_device_unregister。

platform驱动的文件中，需要先__iomem设置映射的虚拟地址指针，然后实现设备结构体；之后的led_switch就是操作寄存器，led_unmap就是调用iounmap取消这些寄存器的映射；led_write跟之前也是一样，copy_to_user获得指令之后，直接led_switch控制LED；file_operations也是跟之前一样，最重要的是实现probe函数，这里面要先platform_get_resource获取资源以及resource_size获取每个大小；然后就是寄存器方法来初始化LED，先全部ioremap获取映射，然后各种初始化IO口；最后就是字符设备的操作来进行初始化；之后实现一个驱动的remove函数，就是字符设备的出口函数的编写；最后实现platform_driver的驱动结构体，添加.driver(里面添加与设备一样的.name)，然后.probe和.remove函数；然后是驱动的加载和卸载，分别在里面调用platform_driver_register和platform_driver_unregister就可以了。