【正点原子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

第三十三章 异步通知实验

在前面使用阻塞或者非阻塞的方式来读取驱动中按键值都是应用程序主动读取的，对于非阻塞方式来说还需要应用程序通过poll函数不断的轮询。最好的方式就是驱动程序能主动向应用程序发出通知，报告自己可以访问，然后应用程序再从驱动程序中读取或写入数据，类似于中断。Linux提供了异步通知这个机制来完成此功能，本章我们就来学习一下异步通知以及如何在驱动中添加异步通知相关处理代码。

33.1 异步通知
33.1.1 异步通知简介
我们首先来回顾一下“中断”，中断是处理器提供的一种异步机制，我们配置好中断以后就可以让处理器去处理其他的事情了，当中断发生以后会触发我们事先设置好的中断服务函数，在中断服务函数中做具体的处理。比如我们以前学习单片机的时候用到的GPIO按键中断，我们通过按键去开关蜂鸣器，采用中断以后处理器就不需要时刻的去查看按键有没有被按下，因为按键按下以后会自动触发中断。同样的，Linux应用程序可以通过阻塞或者非阻塞这两种方式来访问驱动设备，通过阻塞方式访问的话应用程序会处于休眠态，等待驱动设备可以使用。非阻塞方式的话会通过poll函数来不断的轮询，查看驱动设备文件是否可以使用。这两种方式都需要应用程序主动的去查询设备的使用情况，如果能提供一种类似中断的机制，当驱动程序可以访问的时候主动告诉应用程序那就最好了。
“信号”为此应运而生，信号类似于我们硬件上使用的“中断”，只不过信号是软件层次上的。算是在软件层次上对中断的一种模拟，驱动可以通过主动向应用程序发送信号的方式来报告自己可以访问了，应用程序获取到信号以后就可以从驱动设备中读取或者写入数据了。整个过程就相当于应用程序收到了驱动发送过来了的一个中断，然后应用程序去响应这个中断，在整个处理过程中应用程序并没有去查询驱动设备是否可以访问，一切都是由驱动设备自己告诉给应用程序的。
阻塞、非阻塞、异步通知，这三种是针对不同的场合提出来的不同的解决方法，没有优劣之分，在实际的工作和学习中，根据自己的实际需求选择合适的处理方法即可。
异步通知的核心就是信号，在arch/xtensa/include/uapi/asm/signal.h文件中定义了Linux所支持的所有信号，这些信号如下所示：

示例代码33.1.1.1 Linux信号
18 #define SIGHUP    		1  		/* 终端挂起或控制进程终止  			*/
19 #define SIGINT        	2  		/* 终端中断(Ctrl+C组合键)    		*/
20 #define SIGQUIT       	3  		/* 终端退出(Ctrl+\组合键)    		*/
21 #define SIGILL        	4  		/* 非法指令                 			*/
22 #define SIGTRAP       	5  		/* debug使用，有断点指令产生		*/
23 #define SIGABRT       	6  		/* 由abort(3)发出的退出指令 		*/
24 #define SIGIOT        	6  		/* IOT指令                    		*/
25 #define SIGBUS        	7  		/* 总线错误                 			*/
26 #define SIGFPE        	8  		/* 浮点运算错误           			*/
27 #define SIGKILL       	9  		/* 杀死、终止进程            		*/
28 #define SIGUSR1      	10  	/* 用户自定义信号1           		*/
30 #define SIGSEGV      	11  	/* 段违例(无效的内存段)    			*/
31 #define SIGUSR2      	12  	/* 用户自定义信号2           		*/
32 #define SIGPIPE      	13  	/* 向非读管道写入数据      			*/
33 #define SIGALRM      	14  	/* 闹钟                   			*/
34 #define SIGTERM      	15 	 	/* 软件终止                 			*/
35 #define SIGSTKFLT    	16  	/* 栈异常                    		*/
36 #define SIGCHLD      	17  	/* 子进程结束              			*/
37 #define SIGCONT      	18  	/* 进程继续                 			*/
38 #define SIGSTOP      	19  	/* 停止进程的执行，只是暂停 			*/
39 #define SIGTSTP      	20  	/* 停止进程的运行(Ctrl+Z组合键) 	*/
40 #define SIGTTIN      	21  	/* 后台进程需要从终端读取数据		*/
41 #define SIGTTOU      	22  	/* 后台进程需要向终端写数据 		*/
42 #define SIGURG       	23  	/* 有"紧急"数据            		*/
43 #define SIGXCPU      	24  	/* 超过CPU资源限制            	*/
44 #define SIGXFSZ      	25  	/* 文件大小超额           		*/
45 #define SIGVTALRM    	26  	/* 虚拟时钟信号           		*/
46 #define SIGPROF      	27 	 	/* 时钟信号描述           		*/
47 #define SIGWINCH     	28		/* 窗口大小改变           		*/
48 #define SIGIO        	29 		/* 可以进行输入/输出操作  		*/
49 #define SIGPOLL      	SIGIO   
50 /* #define SIGLOS    29 */
51 #define SIGPWR       	30 		/* 断点重启                 		*/
52 #define SIGSYS       	31  	/* 非法的系统调用            	*/
53 #define  SIGUNUSED   	31  	/* 未使用信号              		*/

在示例代码33.1.1.1中的这些信号中，除了SIGKILL(9)和SIGSTOP(19)这两个信号不能被忽略外，其他的信号都可以忽略。这些信号就相当于中断号，不同的中断号代表了不同的中断，不同的中断所做的处理不同，因此，驱动程序可以通过向应用程序发送不同的信号来实现不同的功能。
我们使用中断的时候需要设置中断处理函数，同样的，如果要在应用程序中使用信号，那么就必须设置信号所使用的信号处理函数，在应用程序中使用signal函数来设置指定信号的处理函数，signal函数原型如下所示：
sighandler_t signal(int signum, sighandler_t handler)
函数参数和返回值含义如下：
signum：要设置处理函数的信号。
handler：信号的处理函数。
返回值：设置成功的话返回信号的前一个处理函数，设置失败的话返回SIG_ERR。
信号处理函数原型如下所示：
typedef void (*sighandler_t)(int)
我们前面讲解的使用“kill -9 PID”杀死指定进程的方法就是向指定的进程(PID)发送SIGKILL这个信号。当按下键盘上的CTRL+C组合键以后会向当前正在占用终端的应用程序发出SIGINT信号，SIGINT信号默认的动作是关闭当前应用程序。这里我们修改一下SIGINT信号的默认处理函数，当按下CTRL+C组合键以后先在终端上打印出“SIGINT signal！”这行字符串，然后再关闭当前应用程序。新建signaltest.c文件，然后输入如下所示内容：

示例代码33.1.1.2 信号测试
1  #include <stdlib.h>
2  #include <stdio.h>
3  #include <signal.h>
4  
5  void sigint_handler(int num)
6  {
7      printf("\r\nSIGINT signal!\r\n");
8      exit(0);
9  }
10 
11 int main(void)
12 {
13     signal(SIGINT, sigint_handler);
14     while(1);
15     return 0;
16 }

在示例代码33.1.1.2中我们设置SIGINT信号的处理函数为sigint_handler，当按下CTRL+C向signaltest发送SIGINT信号以后sigint_handler函数就会执行，此函数先输出一行“SIGINT signal!”字符串，然后调用exit函数关闭signaltest应用程序。
使用如下命令编译signaltest.c：
gcc signaltest.c -o signaltest
然后输入“./signaltest”命令打开signaltest这个应用程序，然后按下键盘上的CTRL+C组合键，结果如图33.1.1.1所示：

图33.1.1.1 signaltest软件运行结果
从图33.1.1.1可以看出，当按下CTRL+C组合键以后sigint_handler这个SIGINT信号处理函数执行了，并且输出了“SIGINT signal！”这行字符串。
33.1.2 驱动中的信号处理
1、fasync_struct结构体
首先我们需要在驱动程序中定义一个fasync_struct结构体指针变量，fasync_struct结构体内容如下：

示例代码33.1.2.1 fasync_struct发结构体
struct fasync_struct {
    spinlock_t      		fa_lock;
    int         				magic;
    int         				fa_fd;
    struct fasync_struct	*fa_next; 
    struct file     		*fa_file;
    struct rcu_head     	fa_rcu;
};

一般将fasync_struct结构体指针变量定义到设备结构体中，比如在上一章节的key_dev结构体中添加一个fasync_struct结构体指针变量，结果如下所示：

示例代码33.1.2.2 在设备结构体中添加fasync_struct类型变量指针
1  struct key_dev{
2  		dev_t 			devid;          
3   	struct cdev 	cdev;     
4   	struct class 	*class;   
......
12  	struct fasync_struct *async_queue;  /* fasync_struct结构体 */
13 };

第12行就是在imx6uirq_dev中添加了一个fasync_struct结构体指针变量。
2、fasync函数
如果要使用异步通知，需要在设备驱动中实现file_operations操作集中的fasync函数，此函数格式如下所示：
int (*fasync) (int fd, struct file *filp, int on)
fasync函数里面一般通过调用fasync_helper函数来初始化前面定义的fasync_struct结构体指针，fasync_helper函数原型如下：
int fasync_helper(int fd, struct file * filp, int on, struct fasync_struct **fapp)
fasync_helper函数的前三个参数就是fasync函数的那三个参数，第四个参数就是要初始化的fasync_struct结构体指针变量。当应用程序通过“fcntl(fd, F_SETFL, flags | FASYNC)”改变fasync标记的时候，驱动程序file_operations操作集中的fasync函数就会执行。
驱动程序中的fasync函数参考示例如下：

示例代码33.1.2.3 驱动中fasync函数参考示例
1  struct xxx_dev { 
2   	......
3   	struct fasync_struct *async_queue;  /* 异步相关结构体 */ 
4  };
5 
6  static int xxx_fasync(int fd, struct file *filp, int on)
7  {
8   	struct xxx_dev *dev = (xxx_dev)filp->private_data;
9  
10  	if (fasync_helper(fd, filp, on, &dev->async_queue) < 0)
11      	return -EIO;
12  	return 0;
13 }
14
15 static struct file_operations xxx_ops = {
16  	......
17  	.fasync = xxx_fasync,
18 	 	......
19 };

在关闭驱动文件的时候需要在file_operations操作集中的release函数中释放fasync_struct，fasync_struct的释放函数同样为fasync_helper，release函数参数参考实例如下：

示例代码33.1.2.4 释放fasync_struct参考示例
1 static int xxx_release(struct inode *inode, struct file *filp)
2 {
3   	return xxx_fasync(-1, filp, 0); /* 删除异步通知 */
4 }
5 
6 static struct file_operations xxx_ops = {
7  	 ......
8   	.release = xxx_release,
9 };

第3行通过调用示例代码33.1.2.3中的xxx_fasync函数来完成fasync_struct的释放工作，但是，其最终还是通过fasync_helper函数完成释放工作。

1、kill_fasync函数
当设备可以访问的时候，驱动程序需要向应用程序发出信号，相当于产生“中断”。kill_fasync函数负责发送指定的信号，kill_fasync函数原型如下所示：
void kill_fasync(struct fasync_struct *fp, int sig, int band)
函数参数和返回值含义如下：
fp：要操作的fasync_struct。
sig：要发送的信号。
band：可读时设置为POLL_IN，可写时设置为POLL_OUT。
返回值：无。
33.1.3 应用程序对异步通知的处理
应用程序对异步通知的处理包括以下三步：
1、注册信号处理函数
应用程序根据驱动程序所使用的信号来设置信号的处理函数，应用程序使用signal函数来设置信号的处理函数。前面已经详细的讲过了，这里就不细讲了。
2、将本应用程序的进程号告诉给内核
使用fcntl(fd, F_SETOWN, getpid())将本应用程序的进程号告诉给内核。
3、开启异步通知
使用如下两行程序开启异步通知：
flags = fcntl(fd, F_GETFL); / 获取当前的进程状态 /
fcntl(fd, F_SETFL, flags | FASYNC); / 开启当前进程异步通知功能 */
重点就是通过fcntl函数设置进程状态为FASYNC，经过这一步，驱动程序中的fasync函数就会执行。
33.2 硬件原理图分析
本章实验硬件原理图参考29.2小节即可。
33.3 实验程序编写
本实验对应的例程路径为：开发板光盘-> 2、Linux驱动例程-> 16_asyncnoti。
本章实验我们在上一章实验“15_noblockio”的基础上完成，在其中加入异步通知相关内容即可，当按键按下以后驱动程序向应用程序发送SIGIO信号，应用程序获取到SIGIO信号以后读取并且打印出按键值。
33.3.1 修改设备树文件
因为是在实验“15_noblockio”的基础上完成的，因此不需要修改设备树。
33.3.2 程序编写
新建名为“16_asyncnoti”的文件夹，然后在16_asyncnoti文件夹里面创建vscode工程，工作区命名为“asyncnoti”。将“15_noblockio”实验中的noblockio.c复制到16_asyncnoti文件夹中，并重命名为asyncnoti.c。接下来我们就修改asyncnoti.c这个文件，在其中添加异步通知关的代码，完成以后的asyncnoti.c内容如下所示(因为是在上一章实验的noblockio.c文件的基础上修改的，因为了减少篇幅，下面的代码有省略)：

示例代码33.3.2.1 asyncnoti.c文件代码段
32  #include <linux/fcntl.h>
33 
34  #define KEY_CNT         1       	/* 设备号个数  	*/
35  #define KEY_NAME        "key"   	/* 名字       	*/
36 
37  /* 定义按键状态 */
38  enum key_status {
39      KEY_PRESS = 0,      			/* 按键按下 		*/ 
40      KEY_RELEASE,        			/* 按键松开  	*/ 
41      KEY_KEEP,           			/* 按键状态保持	*/ 
42  };
43 
44  /* key设备结构体 */
45  struct key_dev{
46      dev_t devid;            		/* 设备号     	*/
47      struct cdev cdev;       		/* cdev     	*/
48      struct class *class;    		/* 类      		*/
49      struct device *device;  		/* 设备    		*/
50      struct device_node  *nd; 	/* 设备节点 		*/
51      int key_gpio;           		/* key所使用的GPIO编号 */
52      struct timer_list timer;    	/* 按键值     	*/
53      int irq_num;            		/* 中断号      	*/  
54      atomic_t status;        		/* 按键状态 		*/
55      wait_queue_head_t r_wait;   	/* 读等待队列头	*/
56      struct fasync_struct *async_queue;  /* fasync_struct结构体 */
57  };
......
153 static void key_timer_function(struct timer_list *arg)
154 {
155     static int last_val = 1;
156     int current_val;
157
158     /* 读取按键值并判断按键当前状态 */
159     current_val = gpio_get_value(key.key_gpio);
160     if (0 == current_val && last_val){
161         atomic_set(&key.status, KEY_PRESS); 		/* 按下 */ 
162         wake_up_interruptible(&key.r_wait); 		/* 唤醒 */ 
163         if(key.async_queue)
164             kill_fasync(&key.async_queue, SIGIO, POLL_IN);
165     }
166     else if (1 == current_val && !last_val) {
167         atomic_set(&key.status, KEY_RELEASE);   	/* 松开 */ 
168         wake_up_interruptible(&key.r_wait); 		/* 唤醒 */ 
169         if(key.async_queue)
170             kill_fasync(&key.async_queue, SIGIO, POLL_IN);
171     }
172     else
173         atomic_set(&key.status, KEY_KEEP);        	/* 状态保持 */ 
174
175     last_val = current_val;
176 }
......
221  /*
222  * @description 	: fasync函数，用于处理异步通知
223  * @param – fd  	: 文件描述符
224  * @param – filp 	: 要打开的设备文件(文件描述符)
225  * @param – on   	: 模式
226  * @return       	: 负数表示函数执行失败
227  */
228 static int key_fasync(int fd, struct file *filp, int on)
229 {
230     return fasync_helper(fd, filp, on, &key.async_queue);
231 }
......
246 /*
247  * @description  	: 关闭/释放设备
248  * @param - filp 	: 要关闭的设备文件(文件描述符)
249  * @return        	: 0 成功;其他 失败
250  */
251 static int key_release(struct inode *inode, struct file *filp)
252 {
253     return key_fasync(-1, filp, 0);
254 }
......
274 /* 设备操作函数 */
275 static struct file_operations key_fops = {
276     .owner = THIS_MODULE,
277     .open = key_open,
278     .read = key_read,
279     .write = key_write,
280     .release =  key_release,
281     .poll = key_poll,
282     .fasync = key_fasync,
283 };
......
373 module_init(mykey_init);
374 module_exit(mykey_exit);
375 MODULE_LICENSE("GPL");
376 MODULE_AUTHOR("ALIENTEK");

377 MODULE_INFO(intree, “Y”);
第32行，添加fcntl.h头文件，因为要用到相关的API函数。
第56行，在设备结构体key_dev中添加fasync_struct指针变量。
第153~176行，在key_timer_function函数中，当按键按下或松开动作发生时调用kill_fasync函数向应用程序发送SIGIO信号，通知应用程序按键数据可以进行读取了。
第228~231行，设备操作函数集file_operations结构体中的fasync函数key_fasync，该函数中直接调用fasync_helper函数进行相关处理。
第253行，在key_release函数中也调用key_fasync函数释放fasync_struct指针变量。
第282行，将key_fasync函数绑定到key_fops变量的fasync函数指针中。
33.3.3 编写测试APP
测试APP要实现的内容很简单，设置SIGIO信号的处理函数为sigio_signal_func，当驱动程序向应用程序发送SIGIO信号以后sigio_signal_func函数就会执行。sigio_signal_func函数内容很简单，就是通过read函数读取按键值。新建名为asyncnotiApp.c的文件，然后输入如下所示内容：

示例代码33.3.3.2 asyncnotiApp.c文件代码段
13  #include <stdio.h>
14  #include <unistd.h>
15  #include <sys/types.h>
16  #include <sys/stat.h>
17  #include <fcntl.h>
18  #include <stdlib.h>
19  #include <string.h>
20  #include <signal.h>
21
22  static int fd;
23
24  /*
25   * SIGIO信号处理函数
26   * @param – signum  	: 信号值
27   * @return            	: 无
28   */
29  static void sigio_signal_func(int signum)
30  {
31      unsigned int key_val = 0;
32
33      read(fd, &key_val, sizeof(unsigned int));
34      if (0 == key_val)
35          printf("Key Press\n");
36      else if (1 == key_val)
37          printf("Key Release\n");
38  }
39
40
41  /*
42   * @description 	: main主程序
43   * @param – argc 	: argv数组元素个数
44   * @param – argv 	: 具体参数
45   * @return       	: 0 成功;其他 失败
46   */
47  int main(int argc, char *argv[])
48  {
49      int flags = 0;
50
51      /* 判断传参个数是否正确 */
52      if(2 != argc) {
53          printf("Usage:\n"
54                 "\t./asyncKeyApp /dev/key\n"
55                );
56          return -1;
57      }
58
59      /* 打开设备 */
60      fd = open(argv[1], O_RDONLY | O_NONBLOCK);
61      if(0 > fd) {
62          printf("ERROR: %s file open failed!\n", argv[1]);
63          return -1;
64      }
65
66      /* 设置信号SIGIO的处理函数 */
67      signal(SIGIO, sigio_signal_func);
68      fcntl(fd, F_SETOWN, getpid()); 		/* 将当前进程的进程号告诉给内核 */ 
69      flags = fcntl(fd, F_GETFD);        	/*获取当前的进程状态  */ 
70      fcntl(fd, F_SETFL, flags | FASYNC);/* 设置进程启用异步通知功能 */ 
71
72
73      /* 循环轮询读取按键数据 */
74      for ( ; ; ) {
75
76          sleep(2);
77      }
78
79      /* 关闭设备 */
80      close(fd);
81      return 0;
82  }

第29~38行，sigio_signal_func函数，SIGIO信号的处理函数，当驱动程序有效按键按下以后就会发送SIGIO信号，此函数就会执行。此函数通过read函数读取按键状态数据，然后通过printf函数打印在终端上。
第67行，通过signal函数设置SIGIO信号的处理函数为sigio_signal_func。
第68~70行，设置当前进程的状态，开启异步通知的功能。
第74~77行，for循环，等待信号产生。
33.4 运行测试
33.4.1 编译驱动程序和测试APP
1、编译驱动程序
编写Makefile文件，本章实验的Makefile文件和第四十章实验基本一样，只是将obj-m变量的值改为asyncnoti.o，Makefile内容如下所示：

示例代码33.4.1.1 Makefile文件
1  KERNELDIR := /home/zuozhongkai/linux/my_linux/linux-5.4.31
...... 
4  obj-m := asyncnoti.o
......
11 clean:
12  $(MAKE) -C $(KERNELDIR) M=$(CURRENT_PATH) clean

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

make -j32
编译成功以后就会生成一个名为“asyncnoti.ko”的驱动模块文件。
2、编译测试APP
输入如下命令编译测试asyncnotiApp.c这个测试程序：
arm-none-linux-gnueabihf-gcc asyncnotiApp.c -o asyncnotiApp
编译成功以后就会生成asyncnotiApp这个应用程序。
33.4.2 运行测试
将上一小节编译出来asyncnoti.ko和asyncnotiApp这两个文件拷贝到rootfs/lib/modules/5.4.31目录中，重启开发板，进入到目录lib/modules/5.4.31中，输入如下命令加载asyncnoti.ko驱动模块：
depmod //第一次加载驱动的时候需要运行此命令
modprobe asyncnoti.ko //加载驱动
驱动加载成功以后使用如下命令来测试中断：
./asyncnotiApp /dev/key
按下开发板上的KEY0键，终端就会输出按键值，如图33.4.2.1所示：

图33.4.2.1 读取到的按键值
从图33.4.2.1可以看出，捕获到SIGIO信号，并且按键值获取成功，大家可以自行以后台模式运行asyncnotiApp，查看一下这个应用程序的CPU使用率。如果要卸载驱动的话输入如下命令即可：
rmmod asyncnoti.ko