【正点原子MP157连载】第二十二章 新字符设备驱动实验-摘自【正点原子】STM32MP1嵌入式Linux驱动开发指南V1.7

1）实验平台：正点原子STM32MP157开发板 2）购买链接:https://item.taobao.com/item.htm?&id=629270721801 3）全套实验源码+手册+视频下载地址：http://www.openedv.com/thread-318813-1-1.html 4）正点原子官方B站：https://space.bilibili.com/394620890 5）正点原子STM32MP157技术交流群：691905614

第二十二章 新字符设备驱动实验

经过前两章实验的实战操作，我们已经掌握了Linux字符设备驱动开发的基本步骤，字符设备驱动开发重点是使用register_chrdev函数注册字符设备，当不再使用设备的时候就使用unregister_chrdev函数注销字符设备，驱动模块加载成功以后还需要手动使用mknod命令创建设备节点。register_chrdev和unregister_chrdev这两个函数是老版本驱动使用的函数，现在新的字符设备驱动已经不再使用这两个函数，而是使用Linux内核推荐的新字符设备驱动API函数。本节我们就来学习一下如何编写新字符设备驱动，并且在驱动模块加载的时候自动创建设备节点文件。

22.1 新字符设备驱动原理 22.1.1 分配和释放设备号 使用register_chrdev函数注册字符设备的时候只需要给定一个主设备号即可，但是这样会带来两个问题： ①、需要我们事先确定好哪些主设备号没有使用。 ②、会将一个主设备号下的所有次设备号都使用掉，比如现在设置LED这个主设备号为200，那么0~1048575(2^20-1)这个区间的次设备号就全部都被LED一个设备分走了。这样太浪费次设备号了！一个LED设备肯定只能有一个主设备号，一个次设备号。 解决这两个问题最好的方法就是在使用设备号的时候向Linux内核申请，需要几个就申请几个，由Linux内核分配设备可以使用的设备号。这个就是我们在20.3.2小节讲解的设备号的分配，如果没有指定设备号的话就使用如下函数来申请设备号： int alloc_chrdev_region(dev_t *dev, unsigned baseminor, unsigned count, const char *name) 如果给定了设备的主设备号和次设备号就使用如下所示函数来注册设备号即可： int register_chrdev_region(dev_t from, unsigned count, const char *name) 参数from是要申请的起始设备号，也就是给定的设备号；参数count是要申请的数量，一般都是一个；参数name是设备名字。 注销字符设备之后要释放掉设备号，不管是通过alloc_chrdev_region函数还是register_chrdev_region函数申请的设备号，统一使用如下释放函数： void unregister_chrdev_region(dev_t from, unsigned count) 新字符设备驱动下，设备号分配示例代码如下：

示例代码22.1.1.1 新字符设备驱动下设备号分配
1  int major;           					/* 主设备号 					*/
2  int minor;           					/* 次设备号 					*/
3  dev_t devid;     						/* 设备号 					*/
4  
5  if (major) {     						/* 定义了主设备号 			*/
6  		devid = MKDEV(major, 0);			/* 大部分驱动次设备号都选择0	*/
7   	register_chrdev_region(devid, 1, "test");
8  } else {                     			/* 没有定义设备号 			*/
9   	alloc_chrdev_region(&devid, 0, 1, "test");  /* 申请设备号	*/
10  	major = MAJOR(devid);   			/* 获取分配号的主设备号 		*/
11  	minor = MINOR(devid);   			/* 获取分配号的次设备号 		*/
12 }

第1~3行，定义了主/次设备号变量major和minor，以及设备号变量devid。
第5行，判断主设备号major是否有效，在Linux驱动中一般给出主设备号的话就表示这个设备的设备号已经确定了，因为次设备号基本上都选择0，这个算Linux驱动开发中约定俗成的一种规定了。
第6行，如果major有效的话就使用MKDEV来构建设备号，次设备号选择0。
第7行，使用register_chrdev_region函数来注册设备号。
第9~11行，如果major无效，那就表示没有给定设备号。此时就要使用alloc_chrdev_region函数来申请设备号。设备号申请成功以后使用MAJOR和MINOR来提取出主设备号和次设备号，当然了，第10和11行提取主设备号和次设备号的代码可以不要。
如果要注销设备号的话，使用如下代码即可：

示例代码22.1.1.2 cdev结构体
1 unregister_chrdev_region(devid, 1); 			/* 注销设备号 */

注销设备号的代码很简单。

22.1.2 新的字符设备注册方法 1、字符设备结构 在Linux中使用cdev结构体表示一个字符设备，cdev结构体在include/linux/cdev.h文件中的定义如下：

示例代码22.1.2.1 cdev结构体
1 struct cdev {
2   	struct kobject 	kobj;
3   	struct module 		*owner;
4   	const struct file_operations *ops;
5   	struct list_head 	list;
6   	dev_t 				dev;
7   	unsigned int 		count;
8 } __randomize_layout;

在cdev中有两个重要的成员变量：ops和dev，这两个就是字符设备文件操作函数集合file_operations以及设备号dev_t。编写字符设备驱动之前需要定义一个cdev结构体变量，这个变量就表示一个字符设备，如下所示：

struct cdev test_cdev; 2、cdev_init函数 定义好cdev变量以后就要使用cdev_init函数对其进行初始化，cdev_init函数原型如下： void cdev_init(struct cdev *cdev, const struct file_operations *fops) 参数cdev就是要初始化的cdev结构体变量，参数fops就是字符设备文件操作函数集合。使用cdev_init函数初始化cdev变量的示例代码如下：

示例代码22.1.2.2 cdev_init函数使用示例代码
1  struct cdev testcdev;
2  
3  /* 设备操作函数 */
4  static struct file_operations test_fops = {
5   	.owner = THIS_MODULE,
6   	/* 其他具体的初始项 */
7  };
8  
9  testcdev.owner = THIS_MODULE;
10 cdev_init(&testcdev, &test_fops); /* 初始化cdev结构体变量 */

3、cdev_add函数
cdev_add函数用于向Linux系统添加字符设备(cdev结构体变量)，首先使用cdev_init函数完成对cdev结构体变量的初始化，然后使用cdev_add函数向Linux系统添加这个字符设备。cdev_add函数原型如下：

int cdev_add(struct cdev *p, dev_t dev, unsigned count) 参数p指向要添加的字符设备(cdev结构体变量)，参数dev就是设备所使用的设备号，参数count是要添加的设备数量。完善示例代码22.1.2.2，加入cdev_add函数，内容如下所示：

示例代码22.1.2.2 cdev_add函数使用示例
1  struct cdev testcdev;
2  
3  /* 设备操作函数 */
4  static struct file_operations test_fops = {
5   	.owner = THIS_MODULE,
6   	/* 其他具体的初始项 */
7  };
8  
9  testcdev.owner = THIS_MODULE;
10 cdev_init(&testcdev, &test_fops);    	/* 初始化cdev结构体变量	*/
11 cdev_add(&testcdev, devid, 1);       	/* 添加字符设备   			*/

示例代码22.1.2.2就是新的注册字符设备代码段，Linux内核中大量的字符设备驱动都是采用这种方法向Linux内核添加字符设备。如果在加上示例代码22.1.1.1中分配设备号的程序，那么它们就一起实现的就是函数register_chrdev的功能。
3、cdev_del函数
卸载驱动的时候一定要使用cdev_del函数从Linux内核中删除相应的字符设备，cdev_del函数原型如下：

void cdev_del(struct cdev p) 参数p就是要删除的字符设备。如果要删除字符设备，参考如下代码： 示例代码22.1.2.3 cdev_del函数使用示例 1 cdev_del(&testcdev); / 删除cdev */ cdev_del和unregister_chrdev_region这两个函数合起来的功能相当于unregister_chrdev函数。 22.2 自动创建设备节点 在前面的Linux驱动实验中，当我们使用modprobe加载驱动程序以后还需要使用命令“mknod”手动创建设备节点。本节就来讲解一下如何实现自动创建设备节点，在驱动中实现自动创建设备节点的功能以后，使用modprobe加载驱动模块成功的话就会自动在/dev目录下创建对应的设备文件。 22.2.1 mdev机制 udev是一个用户程序，在Linux下通过udev来实现设备文件的创建与删除，udev可以检测系统中硬件设备状态，可以根据系统中硬件设备状态来创建或者删除设备文件。比如使用modprobe命令成功加载驱动模块以后就自动在/dev目录下创建对应的设备节点文件,使用rmmod命令卸载驱动模块以后就删除掉/dev目录下的设备节点文件。我们在使用buildroot构建根文件系统的时候选择了udev的简化版本—mdev，所以在嵌入式Linux中我们使用mdev来实现设备节点文件的自动创建与删除，Linux系统中的热插拔事件也由mdev管理，如果使用busybox构建根文件系统，会在/etc/init.d/rcS文件中如下语句： echo /sbin/mdev > /proc/sys/kernel/hotplug 上述命令设置热插拔事件由mdev来管理。buildroot构建的根文件系统已经帮我们全部处理好mdev了，不需要我们在修改什么文件。buildroot构建的根文件系统再启动的时候会执行/etc/init.d/S10mdev脚本来启动mdev，如图22.2.1.1所示：

图22.2.1.1 启动mdev 关于udev或mdev更加详细的工作原理这里就不详细探讨了，我们重点来学习一下如何通过mdev来实现设备文件节点的自动创建与删除。 22.2.1 创建和删除类 自动创建设备节点的工作是在驱动程序的入口函数中完成的，一般在cdev_add函数后面添加自动创建设备节点相关代码。首先要创建一个class类，class是个结构体，定义在文件include/linux/device.h里面。class_create是类创建函数，class_create是个宏定义，内容如下：

示例代码22.2.1.1 class_create函数
771 extern struct class * __must_check __class_create(struct module *owner,
772                           const char *name,
773                           struct lock_class_key *key);
774 extern void class_destroy(struct class *cls);
775 
776 /* This is a #define to keep the compiler from merging different
777  * instances of the __key variable */
778 #define class_create(owner, name)       \
779 ({                      \
780     static struct lock_class_key __key; \
781     __class_create(owner, name, &__key);    \
782 })

根据上述代码，将宏class_create展开以后内容如下：

struct class *class_create (struct module *owner, const char *name) class_create一共有两个参数，参数owner一般为THIS_MODULE，参数name是类名字。返回值是个指向结构体class的指针，也就是创建的类。 卸载驱动程序的时候需要删除掉类，类删除函数为class_destroy，函数原型如下： void class_destroy(struct class *cls); 参数cls就是要删除的类。 22.2.2 创建设备 上一小节创建好类以后还不能实现自动创建设备节点，我们还需要在这个类下创建一个设备。使用device_create函数在类下面创建设备，device_create函数原型如下： struct device *device_create(struct class *cls, struct device *parent, dev_t devt, void *drvdata, const char *fmt, …) device_create是个可变参数函数，参数cls就是设备要创建哪个类下面；参数parent是父设备，一般为NULL，也就是没有父设备；参数devt是设备号；参数drvdata是设备可能会使用的一些数据，一般为NULL；参数fmt是设备名字，如果设置fmt=xxx的话，就会生成/dev/xxx这个设备文件。返回值就是创建好的设备。 同样的，卸载驱动的时候需要删除掉创建的设备，设备删除函数为device_destroy，函数原型如下： void device_destroy(struct class *cls, dev_t devt) 参数classs是要删除的设备所处的类，参数devt是要删除的设备号。 22.2.3 参考示例 在驱动入口函数里面创建类和设备，在驱动出口函数里面删除类和设备，参考示例如下：

示例代码22.2.3.1  创建/删除类/设备参考代码
1  struct class *class; 		/* 类 		*/       
2  struct device *device;   	/* 设备 	*/
3  dev_t devid;         		/* 设备号 	*/         
4  
5  /* 驱动入口函数 */ 
6  static int __init xxx_init(void)
7  {
8   	/* 创建类 	*/
9   	class = class_create(THIS_MODULE, "xxx");
10 	 	/* 创建设备 */
11  	device = device_create(class, NULL, devid, NULL, "xxx");
12  	return 0;
13 }
14 
15 /* 驱动出口函数 */
16 static void __exit led_exit(void)
17 {
18  	/* 删除设备 */
19  	device_destroy(newchrled.class, newchrled.devid);
20  	/* 删除类   */
21  	class_destroy(newchrled.class);
22 }
23 
24 module_init(led_init);
25 module_exit(led_exit);
22.3 设置文件私有数据

每个硬件设备都有一些属性，比如主设备号(dev_t)，类(class)、设备(device)、开关状态(state)等等，在编写驱动的时候你可以将这些属性全部写成变量的形式，如下所示：

示例代码22.3.1  变量形式的设备属性
dev_t devid;            	/* 设备号   	*/
struct cdev cdev;       	/* cdev   	*/
struct class *class;    	/* 类      	*/
struct device *device;  	/* 设备    	*/
int major;              	/* 主设备号	*/
int minor;              	/* 次设备号 	*/

这样写肯定没有问题，但是这样写不专业！对于一个设备的所有属性信息我们最好将其做成一个结构体。编写驱动open函数的时候将设备结构体作为私有数据添加到设备文件中，如下所示：

示例代码22.3.2  设备结构体作为私有数据
/* 设备结构体 */
1  struct test_dev{
2   	dev_t devid;            	/* 设备号    	*/
3   	struct cdev cdev;       	/* cdev     	*/
4   	struct class *class;   	/* 类      		*/
5   	struct device *device;  	/* 设备    		*/
6   	int major;              	/* 主设备号   	*/
7   	int minor;              	/* 次设备号   	*/
8  };
9  
10 struct test_dev testdev;
11  
12 /* open函数 */
13 static int test_open(struct inode *inode, struct file *filp)
14 {
15  	filp->private_data = &testdev; /* 设置私有数据 */
16  	return 0;
17 }

在open函数里面设置好私有数据以后，在write、read、close等函数中直接读取private_data即可得到设备结构体。

22.4 硬件原理图分析 本实验的硬件原理参考21.2小节即可。 22.5 实验程序编写 本实验对应的例程路径为：开发板光盘-> 1、Linux驱动例程-> 3_newchrled。 本章实验在上一章实验的基础上完成，重点是使用了新的字符设备驱动、设置了文件私有数据、添加了自动创建设备节点相关内容。 22.5.1 LED灯驱动程序编写 新建名为“3_newchrled”文件夹，然后在3_newchrled文件夹里面创建vscode工程，工作区命名为“newchrled”。工程创建好以后新建newchrled.c文件，在newchrled.c里面输入如下内容：

示例代码22.5.1.1 newchrled.c文件
1   #include 
2   #include 
3   #include 
4   #include 
5   #include 
6   #include 
7   #include 
8   #include 
9   #include 
10  #include 
11  #include 
12  #include 
13  #include 
14  
15  /***************************************************************
16  Copyright © ALIENTEK Co., Ltd. 1998-2029. All rights reserved.
17  文件名  		: newchrled.c
18  作者      	: 正点原子
19  版本      	: V1.0
20  描述      	: LED驱动文件。
21  其他      	: 无
22  论坛      	: www.openedv.com
23  日志      	: 初版V1.0 2020/11/24 正点原子团队创建
24  ***************************************************************/
25  #define NEWCHRLED_CNT      	1           		/* 设备号个数 	*/
26  #define NEWCHRLED_NAME      	"newchrled" 	/* 名字 		*/
27  #define LEDOFF               	0           		/* 关灯 		*/
28  #define LEDON                 	1           		/* 开灯 		*/
29   
30  /* 寄存器物理地址 */
31  #define PERIPH_BASE            	(0x40000000)
32  #define MPU_AHB4_PERIPH_BASE  	(PERIPH_BASE + 0x10000000)
33  #define RCC_BASE                 	(MPU_AHB4_PERIPH_BASE + 0x0000) 
34  #define RCC_MP_AHB4ENSETR     	(RCC_BASE + 0XA28)
35  #define GPIOI_BASE              	(MPU_AHB4_PERIPH_BASE + 0xA000) 
36  #define GPIOI_MODER            	(GPIOI_BASE + 0x0000)   
37  #define GPIOI_OTYPER           	(GPIOI_BASE + 0x0004)   
38  #define GPIOI_OSPEEDR           	(GPIOI_BASE + 0x0008)   
39  #define GPIOI_PUPDR              	(GPIOI_BASE + 0x000C)   
40  #define GPIOI_BSRR             	(GPIOI_BASE + 0x0018)
41  
42  /* 映射后的寄存器虚拟地址指针 */
43  static void __iomem *MPU_AHB4_PERIPH_RCC_PI;
44  static void __iomem *GPIOI_MODER_PI;
45  static void __iomem *GPIOI_OTYPER_PI;
46  static void __iomem *GPIOI_OSPEEDR_PI;
47  static void __iomem *GPIOI_PUPDR_PI;
48  static void __iomem *GPIOI_BSRR_PI;
49  
50  /* newchrled设备结构体 */
51  struct newchrled_dev{
52      dev_t devid;            		/* 设备号     	*/
53      struct cdev cdev;       		/* cdev     	*/
54      struct class *class;        	/* 类      		*/
55      struct device *device;  		/* 设备    		*/
56      int major;              		/* 主设备号   	*/
57      int minor;              		/* 次设备号   	*/
58  };
59  
60  struct newchrled_dev newchrled; /* led设备 */
61  
62  /*
63   * @description  	: LED打开/关闭
64   * @param - sta 	: LEDON(0) 打开LED，LEDOFF(1) 关闭LED
65   * @return       	: 无
66   */
67  void led_switch(u8 sta)
68  {
69      u32 val = 0;
70      if(sta == LEDON) {
71          val = readl(GPIOI_BSRR_PI);
72          val |= (1