《STM32MP157嵌入式Linux驱动开发指南》第三十七章 Linux MISC驱动实验

正点原子运营 · 发表于 2021-6-29 18:11:42

1）实验平台：正点原子STM32MP157开发板
2) 章节摘自【正点原子】《STM32MP157嵌入式Linux驱动开发指南》
3）购买链接:https://item.taobao.com/item.htm?&id=629270721801
4）全套实验源码+手册+视频下载地址：http://www.openedv.com/docs/boards/arm-linux/zdyzmp157.html
5）正点原子官方B站：https://space.bilibili.com/394620890
6）正点原子STM32MP157技术交流群：691905614

第三十七章 Linux MISC驱动实验

misc的意思是混合、杂项的，因此MISC驱动也叫做杂项驱动，也就是当我们板子上的某些外设无法进行分类的时候就可以使用MISC驱动。MISC驱动其实就是最简单的字符设备驱动，通常嵌套在platform总线驱动中，实现复杂的驱动，本章我们就来学习一下MISC驱动的编写。

37.1 MISC设备驱动简介
所有的MISC设备驱动的主设备号都为10，不同的设备使用不同的从设备号。随着Linux字符设备驱动的不断增加，设备号变得越来越紧张，尤其是主设备号，MISC设备驱动就用于解决此问题。MISC设备会自动创建cdev，不需要像我们以前那样手动创建，因此采用MISC设备驱动可以简化字符设备驱动的编写。我们需要向Linux注册一个miscdevice设备，miscdevice是一个结构体，定义在文件include/linux/miscdevice.h中，内容如下：
示例代码37.1.1 miscdevice结构体代码

66 struct miscdevice {
67 int minor; /* 子设备号 */
68 const char *name; /* 设备名字 */
69 const struct file_operations *fops; /* 设备操作集 */
70 struct list_head list;
71 struct device *parent;
72 struct device *this_device;
73 const struct attribute_group **groups;
74 const char *nodename;
75 umode_t mode;
76 };

复制代码

定义一个MISC设备(miscdevice类型)以后我们需要设置minor、name和fops这三个成员变量。minor表示子设备号，MISC设备的主设备号为10，这个是固定的，需要用户指定子设备号，Linux系统已经预定义了一些MISC设备的子设备号，这些预定义的子设备号定义在include/linux/miscdevice.h文件中，如下所示：
示例代码37.1.2 预定义的MISC设备子设备号

15 #define PSMOUSE_MINOR 1
16 #define MS_BUSMOUSE_MINOR 2 /* unused */
17 #define ATIXL_BUSMOUSE_MINOR 3 /* unused */
18 /*#define AMIGAMOUSE_MINOR 4 FIXME OBSOLETE */
19 #define ATARIMOUSE_MINOR 5 /* unused */
20 #define SUN_MOUSE_MINOR 6 /* unused */
......
61 #define MISC_DYNAMIC_MINOR 255

复制代码

      我们在使用的时候可以从这些预定义的子设备号中挑选一个，当然也可以自己定义，只要这个子设备号没有被其他设备使用接口。
name就是此MISC设备名字，当此设备注册成功以后就会在/dev目录下生成一个名为name的设备文件。fops就是字符设备的操作集合，MISC设备驱动最终是需要使用用户提供的fops操作集合。
      当设置好miscdevice以后就需要使用misc_register函数向系统中注册一个MISC设备，此函数原型如下：
int misc_register(struct miscdevice * misc)
函数参数和返回值含义如下：
      misc：要注册的MISC设备。
      返回值：负数，失败；0，成功。
      以前我们需要自己调用一堆的函数去创建设备，比如在以前的字符设备驱动中我们会使用如下几个函数完成设备创建过程：
示例代码37.1.3 传统的创建设备过程

1 alloc_chrdev_region(); /* 申请设备号 */
2 cdev_init(); /* 初始化cdev */
3 cdev_add(); /* 添加cdev */
4 class_create(); /* 创建类 */
5 device_create(); /* 创建设备 */

复制代码

      现在我们可以直接使用misc_register一个函数来完成示例代码37.1.3中的这些步骤。当我们卸载设备驱动模块的时候需要调用misc_deregister函数来注销掉MISC设备，函数原型如下：
int misc_deregister(struct miscdevice *misc)
函数参数和返回值含义如下：
      misc：要注销的MISC设备。
      返回值：负数，失败；0，成功。
      以前注销设备驱动的时候，我们需要调用一堆的函数去删除此前创建的cdev、设备等等内容，如下所示：
示例代码37.1.4 传统的删除设备的过程

1 cdev_del(); /* 删除cdev */
2 unregister_chrdev_region(); /* 注销设备号 */
3 device_destroy(); /* 删除设备 */
4 class_destroy(); /* 删除类 */

复制代码

      现在我们只需要一个misc_deregister函数即可完成示例代码37.1.4中的这些工作。关于MISC设备驱动就讲解到这里，接下来我们就使用platform加MISC驱动框架来编写beep蜂鸣器驱动。
37.2 硬件原理图分析
本章实验我们只使用到正点原子的STM32MP1开发板上的BEEP蜂鸣器，因此实验硬件原理图参考26.2小节即可。
37.3 实验程序编写
本实验对应的例程路径为：开发板光盘1、程序源码2、Linux驱动例程19_miscbeep。
本章实验我们采用platform加misc的方式编写beep驱动，这也是实际的Linux驱动中很常用的方法。采用platform来实现总线、设备和驱动，misc主要负责完成字符设备的创建。
37.3.1 修改设备树
      本章实验我们需要用到蜂鸣器，因此需要在stm32mp157d-atk.dts文件中创建蜂鸣器设备节点。
      1、添加pinctrl节点
      在STM32MP157开发板上的蜂鸣器使用了PC7这个引脚，打开stm32mp15-pinctrl.dtsi文件，在pinctrl节点下添加一个‘beep_pins_a’子节点，这个节点就是蜂鸣器的pinctrl配置。
示例代码37.3.1.1 蜂鸣器的pinctrl节点

1 beep_pins_a: beep_pins {
2 pins {
3 pinmux = <STM32_PINMUX('C', 7, GPIO)>; /* BEEP */
4 drive-push-pull;
5 bias-pull-up;
6 output-high;
7 slew-rate = <0>;
8 };
9 };

复制代码

2、添加beep设备节点
在26.3.1小节我们创建了一个名为“beep”的子节点，本章我们就在这个子节点里面稍微修改即可，修改完成以后的beep子节点内容如下：
示例代码37.3.1.2 蜂鸣器节点

1 beep {
2 compatible = "alientek,beep";
3 status = "okay";
4 pinctrl-names = "default";
5 pinctrl-0 = <&beep_pins_a>;
6 beep-gpio = <&gpioc 7 GPIO_ACTIVE_HIGH>;
7 };

复制代码

相比26.3.1小节里面的beep节点，这里仅仅添加了第4~5行，这两行指定BEEP所使用的引脚pinctrl子节点。
37.3.2 beep驱动程序编写
新建名为“19_miscbeep”的文件夹，然后在19_miscbeep文件夹里面创建vscode工程，工作区命名为“miscbeep。新建名为miscbeep.c的驱动文件，在miscbeep.c中输入如下所示内容：
示例代码37.3.2.1 miscbeep.c文件代码段

1 #include <linux/types.h>
2 #include <linux/kernel.h>
3 #include <linux/delay.h>
4 #include <linux/ide.h>
5 #include <linux/init.h>
6 #include <linux/module.h>
7 #include <linux/errno.h>
8 #include <linux/gpio.h>
9 #include <linux/cdev.h>
10 #include <linux/device.h>
11 #include <linux/of.h>
12 #include <linux/of_address.h>
13 #include <linux/of_gpio.h>
14 #include <linux/platform_device.h>
15 #include <linux/miscdevice.h>
16 #include <asm/mach/map.h>
17 #include <asm/uaccess.h>
18 #include <asm/io.h>
19
20 #define MISCBEEP_NAME "miscbeep" /* 名字 */
21 #define MISCBEEP_MINOR 144 /* 子设备号 */
22 #define BEEPOFF 0 /* 关蜂鸣器 */
23 #define BEEPON 1 /* 开蜂鸣器 */
24
25 /* miscbeep设备结构体 */
26 struct miscbeep_dev{
27 dev_t devid; /* 设备号 */
28 struct cdev cdev; /* cdev */
29 struct class *class; /* 类 */
30 struct device *device; /* 设备 */
31 int beep_gpio; /* beep所使用的GPIO编号 */
32 };
33
34 struct miscbeep_dev miscbeep; /* beep设备 */
35
36 /*
37 * @description : beep相关初始化操作
38 * [url=home.php?mod=space&uid=271674]@param[/url] – pdev : struct platform_device指针，也就是platform设备指针
39 * @return : 成功返回0，失败返回负数
40 */
41 static int beep_gpio_init(struct device_node *nd)
42 {
43 int ret;
44
45 /* 从设备树中获取GPIO */
46 miscbeep.beep_gpio = of_get_named_gpio(nd, "beep-gpio", 0);
47 if(!gpio_is_valid(miscbeep.beep_gpio)) {
48 printk("miscbeep：Failed to get beep-gpio\n");
49 return -EINVAL;
50 }
51
52 /* 申请使用GPIO */
53 ret = gpio_request(miscbeep.beep_gpio, "beep");
54 if(ret) {
55 printk("beep: Failed to request beep-gpio\n");
56 return ret;
57 }
58
59 /* 将GPIO设置为输出模式并设置GPIO初始化电平状态 */
60 gpio_direction_output(miscbeep.beep_gpio, 1);
61
62 return 0;
63 }
64
65 /*
66 * @description : 打开设备
67 * @param – inode : 传递给驱动的inode
68 * @param - filp : 设备文件，file结构体有个叫做private_data的成员变量
69 * 一般在open的时候将private_data指向设备结构体。
70 * @return : 0 成功;其他失败
71 */
72 static int miscbeep_open(struct inode *inode, struct file *filp)
73 {
74 return 0;
75 }
76
77 /*
78 * @description : 向设备写数据
79 * @param – filp : 设备文件，表示打开的文件描述符
80 * @param - buf : 要写给设备写入的数据
81 * @param - cnt : 要写入的数据长度
82 * @param - offt : 相对于文件首地址的偏移
83 * @return : 写入的字节数，如果为负值，表示写入失败
84 */
85 static ssize_t miscbeep_write(struct file *filp,
const char __user *buf, size_t cnt, loff_t *offt)
86 {
87 int retvalue;
88 unsigned char databuf[1];
89 unsigned char beepstat;
90
91 retvalue = copy_from_user(databuf, buf, cnt);
92 if(retvalue < 0) {
93 printk("kernel write failed!\r\n");
94 return -EFAULT;
95 }
96
97 beepstat = databuf[0]; /* 获取状态值 */
98 if(beepstat == BEEPON) {
99 gpio_set_value(miscbeep.beep_gpio, 0); /* 打开蜂鸣器 */
100 } else if(beepstat == BEEPOFF) {
101 gpio_set_value(miscbeep.beep_gpio, 1); /* 关闭蜂鸣器 */
102 }
103 return 0;
104 }
105
106 /* 设备操作函数 */
107 static struct file_operations miscbeep_fops = {
108 .owner = THIS_MODULE,
109 .open = miscbeep_open,
110 .write = miscbeep_write,
111 };
112
113 /* MISC设备结构体 */
114 static struct miscdevice beep_miscdev = {
115 .minor = MISCBEEP_MINOR,
116 .name = MISCBEEP_NAME,
117 .fops = &miscbeep_fops,
118 };
119
120 /*
121 * @description : flatform驱动的probe函数，当驱动与
122 * 设备匹配以后此函数就会执行
123 * @param – dev : platform设备
124 * @return : 0，成功;其他负值,失败
125 */
126 static int miscbeep_probe(struct platform_device *pdev)
127 {
128 int ret = 0;
129
130 printk("beep driver and device was matched!\r\n");
131
132 /* 初始化BEEP */
133 ret = beep_gpio_init(pdev->dev.of_node);
134 if(ret < 0)
135 return ret;
136
137 /* 一般情况下会注册对应的字符设备，但是这里我们使用MISC设备
138 * 所以我们不需要自己注册字符设备驱动，只需要注册misc设备驱动即可
139 */
140 ret = misc_register(&beep_miscdev);
141 if(ret < 0){
142 printk("misc device register failed!\r\n");
143 goto free_gpio;
144 }
145
146 return 0;
147
148 free_gpio:
149 gpio_free(miscbeep.beep_gpio);
150 return -EINVAL;
151 }
152
153 /*
154 * @description : platform驱动的remove函数
155 * @param - dev : platform设备
156 * @return : 0，成功;其他负值,失败
157 */
158 static int miscbeep_remove(struct platform_device *dev)
159 {
160 /* 注销设备的时候关闭LED灯 */
161 gpio_set_value(miscbeep.beep_gpio, 1);
162
163 /* 释放BEEP */
164 gpio_free(miscbeep.beep_gpio);
165
166 /* 注销misc设备 */
167 misc_deregister(&beep_miscdev);
168 return 0;
169 }
170
171 /* 匹配列表 */
172 static const struct of_device_id beep_of_match[] = {
173 { .compatible = "alientek,beep" },
174 { /* Sentinel */ }
175 };
176
177 /* platform驱动结构体 */
178 static struct platform_driver beep_driver = {
179 .driver = {
180 .name = "stm32mp1-beep", /* 驱动名字，用于和设备匹配 */
181 .of_match_table = beep_of_match, /* 设备树匹配表 */
182 },
183 .probe = miscbeep_probe,
184 .remove = miscbeep_remove,
185 };
186
187 /*
188 * @description : 驱动出口函数
189 * @param : 无
190 * @return : 无
191 */
192 static int __init miscbeep_init(void)
193 {
194 return platform_driver_register(&beep_driver);
195 }
196
197 /*
198 * @description : 驱动出口函数
199 * @param : 无
200 * @return : 无
201 */
202 static void __exit miscbeep_exit(void)
203 {
204 platform_driver_unregister(&beep_driver);
205 }
206
207 module_init(miscbeep_init);
208 module_exit(miscbeep_exit);
209 MODULE_LICENSE("GPL");
210 MODULE_AUTHOR("ALIENTEK");
211 MODULE_INFO(intree, "Y");

复制代码

第72~111行，标准的字符设备驱动。
第114~118行，MISC设备beep_miscdev，第115行设置子设备号为144，第116行设置设备名字为“miscbeep”，这样当系统启动以后就会在/dev/目录下存在一个名为“miscbeep”的设备文件。第117行，设置MISC设备的操作函数集合，为file_operations类型。
第126~151行，platform框架的probe函数，当驱动与设备匹配以后此函数就会执行，首先在此函数中初始化BEEP所使用的IO。最后在140行通过misc_register函数向Linux内核注册MISC设备，也就是前面定义的beep_miscdev。
      第158~168行，platform框架的remove函数，在此函数中调用misc_deregister函数来注销MISC设备。
      第192~205，标准的platform驱动。
37.3.3 编写测试APP
      新建miscbeepApp.c文件，然后在里面输入如下所示内容：
示例代码37.3.2.2 miscbeepApp.c文件代码段

1 #include <stdio.h>
2 #include <unistd.h>
3 #include <sys/types.h>
4 #include <sys/stat.h>
5 #include <fcntl.h>
6 #include <stdlib.h>
7 #include <string.h>
8
9 #define BEEPOFF 0
10 #define BEEPON 1
11
12 /*
13 * @description : main主程序
14 * @param - argc : argv数组元素个数
15 * @param - argv : 具体参数
16 * @return : 0 成功;其他失败
17 */
18 int main(int argc, char *argv[])
19 {
20 int fd, retvalue;
21 char *filename;
22 unsigned char databuf[1];
23
24 if(argc != 3){
25 printf("Error Usage!\r\n");
26 return -1;
27 }
28
29 filename = argv[1];
30 fd = open(filename, O_RDWR); /* 打开beep驱动 */
31 if(fd < 0){
32 printf("file %s open failed!\r\n", argv[1]);
33 return -1;
34 }
35
36 databuf[0] = atoi(argv[2]); /* 要执行的操作：打开或关闭 */
37 retvalue = write(fd, databuf, sizeof(databuf));
38 if(retvalue < 0){
39 printf("BEEP Control Failed!\r\n");
40 close(fd);
41 return -1;
42 }
43
44 retvalue = close(fd); /* 关闭文件 */
45 if(retvalue < 0){
46 printf("file %s close failed!\r\n", argv[1]);
47 return -1;
48 }
49 return 0;
50 }

复制代码

miscbeepApp.c文件内容和其他例程的测试APP基本一致，很简单，这里就不讲解了。
37.4 运行测试
37.4.1 编译驱动程序和测试APP
1、编译驱动程序
编写Makefile文件，本章实验的Makefile文件和第四十章实验基本一样，只是将obj-m变量的值改为“miscbeep.o”，Makefile内容如下所示：
示例代码37.4.1.1 Makefile文件

1 KERNELDIR := /home/zuozhongkai/linux/my_linux/linux-5.4.31
......
4 obj-m := miscbeep.o
......
11 clean:
12 $(MAKE) -C $(KERNELDIR) M=$(CURRENT_PATH) clean

复制代码

第4行，设置obj-m变量的值为“miscbeep.o”。
输入如下命令编译出驱动模块文件：

make -j32

复制代码

      编译成功以后就会生成一个名为“miscbeep.ko”的驱动模块文件。
      2、编译测试APP
      输入如下命令编译测试miscbeepApp.c这个测试程序：

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

复制代码

编译成功以后就会生成miscbeepApp这个应用程序。
37.4.2 运行测试
将上一小节编译出来miscbeep.ko和miscbeepApp这两个文件拷贝到rootfs/lib/modules/5.4.31目录中，重启开发板，进入到目录lib/modules/5.4.31中，输入如下命令加载miscbeep.ko这个驱动模块。