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 内核定时器实验
定时器是我们最常用到的功能,一般用来完成定时功能,本章我们就来学习一下Linux内核提供的定时器API函数,通过这些定时器API函数我们可以完成很多要求定时的应用。Linux内核也提供了短延时函数,比如微秒、纳秒、毫秒延时函数,本章我们就来学习一下这些和时间有关的功能。
30.1 Linux时间管理和内核定时器简介
30.1.1 内核时间管理简介
学习过UCOS或FreeRTOS的同学应该知道,UCOS或FreeRTOS是需要一个硬件定时器提供系统时钟,一般使用Systick作为系统时钟源。同理,Linux要运行,也是需要一个系统时钟的,至于这个系统时钟是由哪个定时器提供的,笔者没有去研究过Linux内核,但是在Cortex-A7内核中有个通用定时器,在《Cortex-A7 Technical ReferenceManua.pdf》的“9:Generic Timer”章节有简单的讲解,关于这个通用定时器的详细内容,可以参考《ARM ArchitectureReference Manual ARMv7-A and ARMv7-R edition.pdf》的“chapter B8 The Generic Timer”章节。这个通用定时器是可选的,按照笔者学习FreeRTOS和STM32的经验,猜测Linux会将这个通用定时器作为Linux系统时钟源(前提是SOC得选配这个通用定时器)。具体是怎么做的笔者没有深入研究过,这里仅仅是猜测!不过对于我们Linux驱动编写者来说,不需要深入研究这些具体的实现,只需要掌握相应的API函数即可,除非你是内核编写者或者内核爱好者。
Linux内核中有大量的函数需要时间管理,比如周期性的调度程序、延时程序、对于我们驱动编写者来说最常用的定时器。硬件定时器提供时钟源,时钟源的频率可以设置, 设置好以后就周期性的产生定时中断,系统使用定时中断来计时。中断周期性产生的频率就是系统频率,也叫做节拍率(tick rate)(有的资料也叫系统频率),比如100Hz、1000Hz等等说的就是系统节拍率。系统节拍率是可以设置的,单位是Hz,我们在编译Linux内核的时候可以通过图形化界面设置系统节拍率,按照如下路径打开配置界面:
-> Kernel Features
-> Timer frequency ( [=y])
选中“Timer frequency”,打开以后如图30.1.1.1所示:
图30.1.1.1 系统节拍率设置
从图30.1.1.1可以看出,可选的系统节拍率为100Hz、200Hz、250Hz、300Hz、500Hz和1000Hz,默认情况下选择100Hz。设置好以后打开Linux内核源码根目录下的.config文件,在此文件中有如图30.1.1.2所示定义:
图30.1.1.2系统节拍率
图30.1.1.2中的CONFIG_HZ为100,Linux内核会使用CONFIG_HZ来设置自己的系统时钟。打开文件include/asm-generic/param.h,有如下内容:
示例代码30.1.1.1 include/asm-generic/param.h文件代码段
6 # undef HZ
7 # define HZ CONFIG_HZ
8 # define USER_HZ 100
9 # define CLOCKS_PER_SEC (USER_HZ)
第7行定义了一个宏HZ,宏HZ就是CONFIG_HZ,因此HZ=100,我们后面编写Linux驱动的时候会常常用到HZ,因为HZ表示一秒的节拍数,也就是频率。
大多数初学者看到系统节拍率默认为100Hz的时候都会有疑问,怎么这么小?100Hz是可选的节拍率里面最小的。为什么不选择大一点的呢?这里就引出了一个问题:高节拍率和低节拍率的优缺点:
①、高节拍率会提高系统时间精度,如果采用100Hz的节拍率,时间精度就是10ms,采用1000Hz的话时间精度就是1ms,精度提高了10倍。高精度时钟的好处有很多,对于那些对时间要求严格的函数来说,能够以更高的精度运行,时间测量也更加准确。
②、高节拍率会导致中断的产生更加频繁,频繁的中断会加剧系统的负担,1000Hz和100Hz的系统节拍率相比,系统要花费10倍的“精力”去处理中断。中断服务函数占用处理器的时间增加,但是现在的处理器性能都很强大,所以采用1000Hz的系统节拍率并不会增加太大的负载压力。根据自己的实际情况,选择合适的系统节拍率,本教程我们全部采用默认的100Hz系统节拍率。
Linux内核使用全局变量jiffies来记录系统从启动以来的系统节拍数,系统启动的时候会将jiffies初始化为0,jiffies定义在文件include/linux/jiffies.h中,定义如下:
示例代码30.1.1.2 include/jiffies.h文件代码段
80 extern u64 __cacheline_aligned_in_smp jiffies_64;
81 extern unsigned long volatile __cacheline_aligned_in_smp __jiffy_arch_data jiffies;
第80行,定义了一个64位的jiffies_64。
第81行,定义了一个unsigned long类型的32位的jiffies。
jiffies_64和jiffies其实是同一个东西,jiffies_64用于64位系统,而jiffies用于32位系统。为了兼容不同的硬件,jiffies其实就是jiffies_64的低32位,jiffies_64和jiffies的结构如图30.1.1.3所示:
图30.1.1.3 jiffies_64和jiffies结构图
当我们访问jiffies的时候其实访问的是jiffies_64的低32位,使用get_jiffies_64这个函数可以获取jiffies_64的值。在32位的系统上读取的是jiffies,在64位的系统上jiffes和jiffies_64表示同一个变量,因此也可以直接读取jiffies的值。所以不管是32位的系统还是64位系统,都可以使用jiffies。
前面说了HZ表示每秒的节拍数,jiffies表示系统运行的jiffies节拍数,所以jiffies/HZ就是系统运行时间,单位为秒。不管是32位还是64位的jiffies,都有溢出的风险,溢出以后会重新从0开始计数,相当于绕回来了,因此有些资料也将这个现象也叫做绕回。假如HZ为最大值1000的时候,32位的jiffies只需要49.7天就发生了绕回,对于64位的jiffies来说大概需要5.8亿年才能绕回,因此jiffies_64的绕回忽略不计。处理32位jiffies的绕回显得尤为重要,Linux内核提供了如表30.1.1.1所示的几个API函数来处理绕回。
表30.1.1.1 处理绕回的API函数
如果unkown超过known的话,time_after函数返回真,否则返回假。如果unkown没有超过known的话time_before函数返回真,否则返回假。time_after_eq函数和time_after函数类似,只是多了判断等于这个条件。同理,time_before_eq函数和time_before函数也类似。比如我们要判断某段代码执行时间有没有超时,此时就可以使用如下所示代码:
示例代码30.1.1.3 使用jiffies判断超时
1 unsigned long timeout;
2 timeout = jiffies + (2 * HZ); /* 超时的时间点 */
3
4 /*************************************
5 具体的代码
6 ************************************/
7
8 /* 判断有没有超时 */
9 if(time_before(jiffies, timeout)) {
10 /* 超时未发生 */
11 } else {
12 /* 超时发生 */
13 }
timeout就是超时时间点,比如我们要判断代码执行时间是不是超过了2秒,那么超时时间点就是jiffies+(2*HZ),如果jiffies大于timeout那就表示超时了,否则就是没有超时。第4~6行就是具体的代码段。第9行通过函数time_before来判断jiffies是否小于timeout,如果小于的话就表示没有超时。
为了方便开发,Linux内核提供了几个jiffies和ms、us、ns之间的转换函数,如表50.1.1.2所示:
函
表30.1.1.2 jiffies和ms、us、ns之间的转换函数
30.1.2 内核定时器简介
定时器是一个很常用的功能,需要周期性处理的工作都要用到定时器。Linux内核定时器采用系统时钟来实现,并不是我们在裸机篇中讲解的PIT等硬件定时器。Linux内核定时器使用很简单,只需要提供超时时间(相当于定时值)和定时处理函数即可,当超时时间到了以后设置的定时处理函数就会执行,和我们使用硬件定时器的套路一样,只是使用内核定时器不需要做一大堆的寄存器初始化工作。在使用内核定时器的时候要注意一点,内核定时器并不是周期性运行的,超时以后就会自动关闭,因此如果想要实现周期性定时,那么就需要在定时处理函数中重新开启定时器。Linux内核使用timer_list结构体表示内核定时器,timer_list定义在文件include/linux/timer.h中,定义如下:
示例代码30.1.2.1 timer_list结构体
11 struct timer_list {
12 /*
13 * All fields that change during normal runtime grouped to the
14 * same cacheline
15 */
16 struct hlist_node entry;
17 unsigned long expires; /* 定时器超时时间,单位是节拍数 */
18 void (*function)(struct timer_list *);/* 定时处理函数*/
19 u32 flags; /* 标志位 */
20
21 #ifdef CONFIG_LOCKDEP
22 struct lockdep_map lockdep_map;
23 #endif
24 };
要使用内核定时器首先要先定义一个timer_list变量,表示定时器,tiemr_list结构体的expires成员变量表示超时时间,单位为节拍数。比如我们现在需要定义一个周期为2秒的定时器,那么这个定时器的超时时间就是jiffies+(2*HZ),因此expires=jiffies+(2*HZ)。function就是定时器超时以后的定时处理函数,我们要做的工作就放到这个函数里面,需要我们编写这个定时处理函数,function函数的形参就是我们定义的timer_list变量。
定义好定时器以后还需要通过一系列的API函数来初始化此定时器,这些函数如下:
1、timer_setup函数
timer_setup函数负责初始化timer_list类型变量,当我们定义了一个timer_list变量以后一定要先用timer_setup初始化一下。timer_setup函数原型如下:
void timer_setup(struct timer_list *timer, void (*func)(struct timer_list *), unsigned int flags)
函数参数和返回值含义如下:
timer:要初始化定时器。
func:定时器的回调函数,此函数的形参是当前定时器的变量。
flags: 标志位,直接给0就行。
返回值:没有返回值。
2、add_timer函数
add_timer函数用于向Linux内核注册定时器,使用add_timer函数向内核注册定时器以后,定时器就会开始运行,函数原型如下:
void add_timer(struct timer_list *timer)
函数参数和返回值含义如下:
timer:要注册的定时器。
返回值:没有返回值。
3、del_timer函数
del_timer函数用于删除一个定时器,不管定时器有没有被激活,都可以使用此函数删除。在多处理器系统上,定时器可能会在其他的处理器上运行,因此在调用del_timer函数删除定时器之前要先等待其他处理器的定时处理器函数退出。del_timer函数原型如下:
int del_timer(struct timer_list * timer)
函数参数和返回值含义如下:
timer:要删除的定时器。
返回值:0,定时器还没被激活;1,定时器已经激活。
4、del_timer_sync函数
del_timer_sync函数是del_timer函数的同步版,会等待其他处理器使用完定时器再删除,del_timer_sync不能使用在中断上下文中。del_timer_sync函数原型如下所示:
int del_timer_sync(struct timer_list *timer)
函数参数和返回值含义如下:
timer:要删除的定时器。
返回值:0,定时器还没被激活;1,定时器已经激活。
5、mod_timer函数
mod_timer函数用于修改定时值,如果定时器还没有激活的话,mod_timer函数会激活定时器!函数原型如下:
int mod_timer(struct timer_list *timer, unsigned long expires)
函数参数和返回值含义如下:
timer:要修改超时时间(定时值)的定时器。
expires:修改后的超时时间。
返回值:0,调用mod_timer函数前定时器未被激活;1,调用mod_timer函数前定时器已被激活。
关于内核定时器常用的API函数就讲这些,内核定时器一般的使用流程如下所示:
示例代码30.1.2.2 内核定时器使用方法演示
1 struct timer_list timer; /* 定义定时器 */
2
3 /* 定时器回调函数 */
4 void function(struct timer_list *arg)
5 {
6 /*
7 * 定时器处理代码
8 */
9
10 /* 如果需要定时器周期性运行的话就使用mod_timer
11 * 函数重新设置超时值并且启动定时器。
12 */
13 mod_timer(&dev->timertest, jiffies + msecs_to_jiffies(2000));
14 }
15
16 /* 初始化函数 */
17 void init(void)
18 {
19 timer_setup(&timerdev.timer, timer_function, 0); /* 初始化定时器 */
20 timer.expires=jffies + msecs_to_jiffies(2000);/* 超时时间2秒 */
21 add_timer(&timer); /* 启动定时器 */
22 }
23
24 /* 退出函数 */
25 void exit(void)
26 {
27 del_timer(&timer); /* 删除定时器 */
28 /* 或者使用 */
29 del_timer_sync(&timer);
30 }
30.1.3 Linux内核短延时函数
有时候我们需要在内核中实现短延时,尤其是在Linux驱动中。Linux内核提供了毫秒、微秒和纳秒延时函数,这三个函数如表30.1.3.1所示:
函数 描述
void ndelay(unsigned long nsecs) 纳秒、微秒和毫秒延时函数。
void udelay(unsigned long usecs)
void mdelay(unsigned long mseces)
表30.1.3.1 内核短延时函数
30.2 硬件原理图分析
本章使用通过设置一个定时器来实现周期性的闪烁LED灯,因此本章例程就使用到了一个LED灯,本实验的硬件原理参考21.2小节即可。
30.3 实验程序编写
本实验对应的例程路径为:开发板光盘1、程序源码2、Linux驱动例程12_timer
本章实验我们使用内核定时器周期性的点亮和熄灭开发板上的LED灯,LED灯的闪烁周期由内核定时器来设置,测试应用程序可以控制内核定时器周期。
30.3.1 修改设备树文件
本章实验使用到了LED灯,LED灯的设备树节点信息使用25.4.1小节创建的即可。
30.3.2 定时器驱动程序编写
新建名为“12_timer”的文件夹,然后在12_timer文件夹里面创建vscode工程,工作区命名为“timer”。工程创建好以后新建timer.c文件,在timer.c里面输入如下内容:
示例代码30.3.2.1 timer.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/semaphore.h>
15 #include <linux/timer.h>
16 #include <asm/mach/map.h>
17 #include <asm/uaccess.h>
18 #include <asm/io.h>
19 /***************************************************************
20 Copyright © ALIENTEK Co., Ltd. 1998-2029. All rights reserved.
21 文件名 : timer.c
22 作者 : 正点原子Linux团队
23 版本 : V1.0
24 描述 : Linux内核定时器实验
25 其他 : 无
26 论坛 : www.openedv.com
27 日志 : 初版V1.0 2021/01/5 正点原子Linux团队创建
28 ***************************************************************/
29 #define TIMER_CNT 1 /* 设备号个数 */
30 #define TIMER_NAME "timer" /* 名字 */
31 #define CLOSE_CMD (_IO(0XEF, 0x1)) /* 关闭定时器 */
32 #define OPEN_CMD (_IO(0XEF, 0x2)) /* 打开定时器 */
33 #define SETPERIOD_CMD (_IO(0XEF, 0x3)) /* 设置定时器周期命令*/
34 #define LEDON 1 /* 开灯 */
35 #define LEDOFF 0 /* 关灯 */
36
37 /* timer设备结构体 */
38 struct timer_dev{
39 dev_t devid; /* 设备号 */
40 struct cdev cdev; /* cdev */
41 struct class *class; /* 类 */
42 struct device *device; /* 设备 */
43 int major; /* 主设备号 */
44 int minor; /* 次设备号 */
45 struct device_node *nd; /* 设备节点 */
46 int led_gpio; /* key所使用的GPIO编号 */
47 int timeperiod; /* 定时周期,单位为ms */
48 struct timer_list timer; /* 定义一个定时器 */
49 spinlock_t lock; /* 定义自旋锁 */
50 };
51
52 struct timer_dev timerdev; /* timer设备 */
53
54 /*
55 * @description : 初始化LED灯IO,open函数打开驱动的时候
56 * 初始化LED灯所使用的GPIO引脚。
57 * @param : 无
58 * @return : 无
59 */
60 static int led_init(void)
61 {
62 int ret;
63 const char *str;
64
65 /* 设置LED所使用的GPIO */
66 /* 1、获取设备节点:timerdev */
67 timerdev.nd = of_find_node_by_path("/gpioled");
68 if(timerdev.nd == NULL) {
69 printk("timerdev node not find!\r\n");
70 return -EINVAL;
71 }
72
73 /* 2.读取status属性 */
74 ret = of_property_read_string(timerdev.nd, "status", &str);
75 if(ret < 0)
76 return -EINVAL;
77
78 if (strcmp(str, "okay"))
79 return -EINVAL;
80
81 /* 3、获取compatible属性值并进行匹配 */
82 ret = of_property_read_string(timerdev.nd, "compatible", &str);
83 if(ret < 0) {
84 printk("timerdev: Failed to get compatible property\n");
85 return -EINVAL;
86 }
87
88 if (strcmp(str, "alientek,led")) {
89 printk("timerdev: Compatible match failed\n");
90 return -EINVAL;
91 }
92
93 /* 4、 获取设备树中的gpio属性,得到led-gpio所使用的led编号 */
94 timerdev.led_gpio = of_get_named_gpio(timerdev.nd,
"led-gpio", 0);
95 if(timerdev.led_gpio < 0) {
96 printk("can't get led-gpio");
97 return -EINVAL;
98 }
99 printk("led-gpio num = %d\r\n", timerdev.led_gpio);
100
101 /* 5.向gpio子系统申请使用GPIO */
102 ret = gpio_request(timerdev.led_gpio, "led");
103 if (ret) {
104 printk(KERN_ERR "timerdev: Failed to request led-gpio\n");
105 return ret;
106 }
107
108 /* 6、设置PI0为输出,并且输出高电平,默认关闭LED灯 */
109 ret = gpio_direction_output(timerdev.led_gpio, 1);
110 if(ret < 0) {
111 printk("can't set gpio!\r\n");
112 return ret;
113 }
114 return 0;
115 }
116
117 /*
118 * @description : 打开设备
119 * @param – inode : 传递给驱动的inode
120 * @param - filp : 设备文件,file结构体有个叫做private_data的成员变量
121 * 一般在open的时候将private_data指向设备结构体。
122 * @return : 0 成功;其他 失败
123 */
124 static int timer_open(struct inode *inode, struct file *filp)
125 {
126 int ret = 0;
127 filp->private_data = &timerdev; /* 设置私有数据 */
128
129 timerdev.timeperiod = 1000; /* 默认周期为1s */
130 ret = led_init(); /* 初始化LED IO */
131 if (ret < 0) {
132 return ret;
133 }
134
135 return 0;
136 }
137
138 /*
139 * @description : ioctl函数,
140 * @param - filp : 要打开的设备文件(文件描述符)
141 * @param - cmd : 应用程序发送过来的命令
142 * @param - arg : 参数
143 * @return : 0 成功;其他 失败
144 */
145 static long timer_unlocked_ioctl(struct file *filp,
unsigned int cmd, unsigned long arg)
146 {
147 struct timer_dev *dev = (struct timer_dev *)filp->private_data;
148 int timerperiod;
149 unsigned long flags;
150
151 switch (cmd) {
152 case CLOSE_CMD: /* 关闭定时器 */
153 del_timer_sync(&dev->timer);
154 break;
155 case OPEN_CMD: /* 打开定时器 */
156 spin_lock_irqsave(&dev->lock, flags);
157 timerperiod = dev->timeperiod;
158 spin_unlock_irqrestore(&dev->lock, flags);
159 mod_timer(&dev->timer, jiffies +
msecs_to_jiffies(timerperiod));
160 break;
161 case SETPERIOD_CMD: /* 设置定时器周期 */
162 spin_lock_irqsave(&dev->lock, flags);
163 dev->timeperiod = arg;
164 spin_unlock_irqrestore(&dev->lock, flags);
165 mod_timer(&dev->timer, jiffies + msecs_to_jiffies(arg));
166 break;
167 default:
168 break;
169 }
170 return 0;
171 }
172
173 /*
174 * @description : 关闭/释放设备
175 * @param - filp : 要关闭的设备文件(文件描述符)
176 * @return : 0 成功;其他 失败
177 */
178 static int led_release(struct inode *inode, struct file *filp)
179 {
180 struct timer_dev *dev = filp->private_data;
181 gpio_set_value(dev->led_gpio, 1); /* APP结束的时候关闭LED */
182 gpio_free(dev->led_gpio); /* 释放LED */
183 del_timer_sync(&dev->timer); /* 关闭定时器 */
184
185 return 0;
186 }
187
188 /* 设备操作函数 */
189 static struct file_operations timer_fops = {
190 .owner = THIS_MODULE,
191 .open = timer_open,
192 .unlocked_ioctl = timer_unlocked_ioctl,
193 .release = led_release,
194 };
195
196 /* 定时器回调函数 */
197 void timer_function(struct timer_list *arg)
198 {
199 /* from_timer是个宏,可以根据结构体的成员地址,获取到这个结构体的首地址。
200 第一个参数表示结构体,第二个参数表示第一个参数里的一个成员,第三个参数表
示第二个参数的类型,得到第一个参数的首地址。
201 */
202 struct timer_dev *dev = from_timer(dev, arg, timer);
203 static int sta = 1;
204 int timerperiod;
205 unsigned long flags;
206
207 sta = !sta; /* 每次都取反,实现LED灯反转 */
208 gpio_set_value(dev->led_gpio, sta);
209
210 /* 重启定时器 */
211 spin_lock_irqsave(&dev->lock, flags);
212 timerperiod = dev->timeperiod;
213 spin_unlock_irqrestore(&dev->lock, flags);
214 mod_timer(&dev->timer, jiffies +
msecs_to_jiffies(dev->timeperiod));
215 }
216
217 /*
218 * @description : 驱动入口函数
219 * @param : 无
220 * @return : 无
221 */
222 static int __init timer_init(void)
223 {
224 int ret;
225
226 /* 初始化自旋锁 */
227 spin_lock_init(&timerdev.lock);
228
229 /* 注册字符设备驱动 */
230 /* 1、创建设备号 */
231 if (timerdev.major) { /* 定义了设备号 */
232 timerdev.devid = MKDEV(timerdev.major, 0);
233 ret = register_chrdev_region(timerdev.devid, TIMER_CNT,
TIMER_NAME);
234 if(ret < 0) {
235 pr_err("cannot register %s char driver [ret=%d]\n",
TIMER_NAME, TIMER_CNT);
236 return -EIO;
237 }
238 } else { /* 没有定义设备号 */
239 ret = alloc_chrdev_region(&timerdev.devid, 0, TIMER_CNT,
TIMER_NAME); /* 申请设备号 */
240 if(ret < 0) {
241 pr_err("%s Couldn't alloc_chrdev_region, ret=%d\r\n",
TIMER_NAME, ret);
242 return -EIO;
243 }
244 timerdev.major = MAJOR(timerdev.devid); /* 获取主设备号 */
245 timerdev.minor = MINOR(timerdev.devid); /* 获取次设备号 */
246 }
247 printk("timerdev major=%d,minor=%d\r\n",timerdev.major,
timerdev.minor);
248
249 /* 2、初始化cdev */
250 timerdev.cdev.owner = THIS_MODULE;
251 cdev_init(&timerdev.cdev, &timer_fops);
252
253 /* 3、添加一个cdev */
254 cdev_add(&timerdev.cdev, timerdev.devid, TIMER_CNT);
255 if(ret < 0)
256 goto del_unregister;
257
258 /* 4、创建类 */
259 timerdev.class = class_create(THIS_MODULE, TIMER_NAME);
260 if (IS_ERR(timerdev.class)) {
261 goto del_cdev;
262 }
263
264 /* 5、创建设备 */
265 timerdev.device = device_create(timerdev.class, NULL,
timerdev.devid, NULL, TIMER_NAME);
266 if (IS_ERR(timerdev.device)) {
267 goto destroy_class;
268 }
269
270 /* 6、初始化timer,设置定时器处理函数,还未设置周期,所有不会激活定时器 */
271 timer_setup(&timerdev.timer, timer_function, 0);
272
273 return 0;
274
275 destroy_class:
276 device_destroy(timerdev.class, timerdev.devid);
277 del_cdev:
278 cdev_del(&timerdev.cdev);
279 del_unregister:
280 unregister_chrdev_region(timerdev.devid, TIMER_CNT);
281 return -EIO;
282 }
283
284 /*
285 * @description : 驱动出口函数
286 * @param : 无
287 * @return : 无
288 */
289 static void __exit timer_exit(void)
290 {
291 del_timer_sync(&timerdev.timer); /* 删除timer */
292 #if 0
293 del_timer(&timerdev.tiemr);
294 #endif
295
296 /* 注销字符设备驱动 */
297 cdev_del(&timerdev.cdev); /* 删除cdev */
298 unregister_chrdev_region(timerdev.devid, TIMER_CNT);
299
300 device_destroy(timerdev.class, timerdev.devid);
301 class_destroy(timerdev.class);
302 }
303
304 module_init(timer_init);
305 module_exit(timer_exit);
306 MODULE_LICENSE("GPL");
307 MODULE_AUTHOR("ALIENTEK");
308 MODULE_INFO(intree, "Y");
第38~50行,定时器设备结构体,在48行定义了一个定时器成员变量timer。
第60~115行,LED灯初始化函数,从设备树中获取LED灯信息,然后初始化相应的IO。
第124~136行,函数timer_open,对应应用程序的open函数,应用程序调用open函数打开/dev/timer驱动文件的时候此函数就会执行。此函数设置文件私有数据为timerdev,并且初始化定时周期默认为1秒,最后调用led_init函数初始化LED所使用的IO。
第145~171行,函数timer_unlocked_ioctl,对应应用程序的ioctl函数,应用程序调用ioctl函数向驱动发送控制信息,此函数响应并执行。此函数有三个参数:filp,cmd和arg,其中filp是对应的设备文件,cmd是应用程序发送过来的命令信息,arg是应用程序发送过来的参数,在本章例程中arg参数表示定时周期。
一共有三种命令CLOSE_CMD,OPEN_CMD和SETPERIOD_CMD,这三个命令分别为关闭定时器、打开定时器、设置定时周期。这三个命令的左右如下:
CLOSE_CMD:关闭定时器命令,调用del_timer_sync函数关闭定时器。
OPEN_CMD:打开定时器命令,调用mod_timer函数打开定时器,定时周期为timerdev的timeperiod成员变量,定时周期默认是1秒。
SETPERIOD_CMD:设置定时器周期命令,参数arg就是新的定时周期,设置timerdev的timeperiod成员变量为arg所表示定时周期指。并且使用mod_timer重新打开定时器,使定时器以新的周期运行。
第178~186行,函数timer_release,对应应用程序的close函数。退出的时候,关闭LED和关闭定时器。
第189~194行,定时器驱动操作函数集timer_fops。
第197~215行,函数timer_function,定时器服务函数。重点来看一下第202行,这一行需要得到第52行定义的timerdev变量。这里使用from_timer函数来根据arg参数反推出timerdev变量地址,from_timer函数其实是一个宏,是对container_of函数的一个简单封装。container_of函数的作用就是:给定结构体中的某个成员变量的地址、该结构体类型和该成员的名字来得到这个成员所在结构体变量的首地址。比如timerdev这个结构体变量,类型为timer_dev,而timer_dev中有个成员变量timer,timer是timer_list类型。因此当我们知道了timer这个成员变量的具体地址以后,就可以根据container_of函数来反推出timer这个成员变量所属的timer_dev结构体变量首地址,在这里就是得到timerdev地址。最后在timer_function函数中将LED灯的状态取反,实现LED灯闪烁的效果。因为内核定时器不是循环的定时器,执行一次以后就结束了,因此在214行又调用了mod_timer函数重新开启定时器。
第222~282行,函数timer_init,驱动入口函数。在第271行初始化定时器,设置定时器的定时处理函数为timer_function,标志位为0。在此函数中并没有调用timer_add函数来开启定时器,因此定时器默认是关闭的,除非应用程序发送打开命令。
第289~302行,驱动出口函数。第291行调用del_timer_sync函数删除定时器,也可以使用del_timer函数。
30.3.3 编写测试APP
测试APP我们要实现的内容如下:
①、运行APP以后提示我们输入要测试的命令,输入1表示关闭定时器、输入2表示打开定时器,输入3设置定时器周期。
②、如果要设置定时器周期的话,需要让用户输入要设置的周期值,单位为毫秒。
新建名为timerApp.c的文件,然后输入如下所示内容:
示例代码50.3.2.2 timerApp.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 #include <sys/ioctl.h>
9 /***************************************************************
10 Copyright © ALIENTEK Co., Ltd. 1998-2029. All rights reserved.
11 文件名 : timerApp.c
12 作者 : 正点原子Linux团队
13 版本 : V1.0
14 描述 : 定时器测试应用程序
15 其他 : 无
16 使用方法 :./timertest /dev/timer 打开测试App
17 论坛 : www.openedv.com
18 日志 : 初版V1.0 2021/01/5 正点原子Linux团队创建
19 ***************************************************************/
20
21 /* 命令值 */
22 #define CLOSE_CMD (_IO(0XEF, 0x1)) /* 关闭定时器 */
23 #define OPEN_CMD (_IO(0XEF, 0x2)) /* 打开定时器 */
24 #define SETPERIOD_CMD (_IO(0XEF, 0x3)) /* 设置定时器周期命令 */
25
26 /*
27 * @description : main主程序
28 * @param - argc : argv数组元素个数
29 * @param - argv : 具体参数
30 * @return : 0 成功;其他 失败
31 */
32 int main(int argc, char *argv[])
33 {
34 int fd, ret;
35 char *filename;
36 unsigned int cmd;
37 unsigned int arg;
38 unsigned char str[100];
39
40 if (argc != 2) {
41 printf("Error Usage!\r\n");
42 return -1;
43 }
44
45 filename = argv[1];
46
47 fd = open(filename, O_RDWR);
48 if (fd < 0) {
49 printf("Can't open file %s\r\n", filename);
50 return -1;
51 }
52
53 while (1) {
54 printf("Input CMD:");
55 ret = scanf("%d", &cmd);
56 if (ret != 1) { /* 参数输入错误 */
57 fgets(str, sizeof(str), stdin); /* 防止卡死 */
58 }
59 if(4 == cmd) /* 退出APP */
60 goto out;
61 if(cmd == 1) /* 关闭LED灯 */
62 cmd = CLOSE_CMD;
63 else if(cmd == 2) /* 打开LED灯 */
64 cmd = OPEN_CMD;
65 else if(cmd == 3) {
66 cmd = SETPERIOD_CMD; /* 设置周期值 */
67 printf("Input Timer Period:");
68 ret = scanf("%d", &arg);
69 if (ret != 1) { /* 参数输入错误 */
70 fgets(str, sizeof(str), stdin); /* 防止卡死 */
71 }
72 }
73 ioctl(fd, cmd, arg); /* 控制定时器的打开和关闭 */
74 }
75
76 out:
77 close(fd);
78 }
第22~24行,命令值。
第53~73行,while(1)循环,让用户输入要测试的命令,然后通过第73行的ioctl函数发送给驱动程序。如果是设置定时器周期命令SETPERIOD_CMD,那么ioctl函数的arg参数就是用户输入的周期值。
第59~60行,输入4就能退出APP。
30.4 运行测试
30.4.1 编译驱动程序和测试APP
1、编译驱动程序
编写Makefile文件,本章实验的Makefile文件和第四十章实验基本一样,只是将obj-m变量的值改为timer.o,Makefile内容如下所示:
```c
示例代码30.4.1.1 Makefile文件
1 KERNELDIR := /home/zuozhongkai/linux/my_linux/linux-5.4.31
......
4 obj-m := timer.o
......
11 clean:
12 $(MAKE) -C $(KERNELDIR) M=$(CURRENT_PATH) clean
第4行,设置obj-m变量的值为timer.o。
输入如下命令编译出驱动模块文件:
make -j32
编译成功以后就会生成一个名为“timer.ko”的驱动模块文件。
2、编译测试APP
输入如下命令编译测试timerApp.c这个测试程序:
arm-linux-gnueabihf-gcc timerApp.c -o timerApp
编译成功以后就会生成timerApp这个应用程序。
30.4.2 运行测试
将上一小节编译出来的timer.ko和timerApp这两个文件拷贝到rootfs/lib/modules/5.4.31目录中,重启开发板,进入到目录lib/modules/5.4.31中,输入如下命令加载timer.ko驱动模块:
```c
depmod //第一次加载驱动的时候需要运行此命令
modprobe timer.ko //加载驱动
驱动加载成功以后如下命令来测试:
./timerApp /dev/timer
输入上述命令以后终端提示输入命令,如图30.4.2.1所示:
图30.4.2.1输入命令
输入“2”,打开定时器,此时LED0就会以默认的1秒周期开始闪烁。在输入“3”来设置定时周期,根据提示输入要设置的周期值,如图30.4.2.2所示:
图30.4.2.2 设置周期值
输入“500”,表示设置定时器周期值为500ms,设置好以后LED灯就会以500ms为间隔,开始闪烁。最后可以通过输入“1”来关闭定时器,如果要卸载驱动的话输入如下命令即可:
rmmod timer.ko