【正点原子Linux连载】第四十九章 Linux按键输入实验 -摘自【正点原子】I.MX6U嵌入式Linux驱动开发指南V1.0
1）实验平台：正点原子阿尔法Linux开发板
2）平台购买地址：https://item.taobao.com/item.htm?id=603672744434
2）全套实验源码+手册+视频下载地址：http://www.openedv.com/thread-300792-1-1.html
3）对正点原子Linux感兴趣的同学可以加群讨论：935446741
4）关注正点原子公众号，获取最新资料更新
第四十九章 Linux按键输入实验
在前几章我们都是使用的GPIO输出功能，还没有用过GPIO输入功能，本章我们就来学习一下如果在Linux下编写GPIO输入驱动程序。I.MX6U-ALPHA开发板上有一个按键，我们就使用此按键来完成GPIO输入驱动程序，同时利用第四十七章讲的原子操作来对按键值进行保护。
49.1 Linux下按键驱动原理
按键驱动和LED驱动原理上来讲基本都是一样的，都是操作GPIO，只不过一个是读取GPIO的高低电平，一个是从GPIO输出高低电平。本章我们实现按键输入，在驱动程序中使用一个整形变量来表示按键值，应用程序通过read函数来读取按键值，判断按键有没有按下。在这里，这个保存按键值的变量就是个共享资源，驱动程序要向其写入按键值，应用程序要读取按键值。所以我们要对其进行保护，对于整形变量而言我们首选的就是原子操作，使用原子操作对变量进行赋值以及读取。Linux下的按键驱动原理很简单，接下来开始编写驱动。
注意，本章例程只是为了演示Linux下GPIO输入驱动的编写，实际中的按键驱动并不会采用本章中所讲解的方法，Linux下的input子系统专门用于输入设备！
49.2 硬件原理图分析
本章实验硬件原理图参考15.2小节即可。
49.3 实验程序编写
本实验对应的例程路径为：开发板光盘-> 2、Linux驱动例程-> 11_key。
49.3.1 修改设备树文件
1、添加pinctrl节点
I.MX6U-ALPHA开发板上的KEY使用了UART1_CTS_B这个PIN，打开imx6ull-alientek-emmc.dts，在iomuxc节点的imx6ul-evk子节点下创建一个名为“pinctrl_key”的子节点，节点内容如下所示：
示例代码49.3.1.1 按键pinctrl节点
1 pinctrl_key: keygrp {
2 fsl,pins = <
3 MX6UL_PAD_UART1_CTS_B__GPIO1_IO18 0xF080 /* KEY0 */
4 >;
5 };
第3行，将GPIO_IO18这个PIN复用为GPIO1_IO18。
2、添加KEY设备节点
在根节点“/”下创建KEY节点，节点名为“key”，节点内容如下：
示例代码49.3.1.2 创建KEY节点
1 key {
2 #address-cells = <1>;
3 #size-cells = <1>;
4 compatible = "atkalpha-key";
5 pinctrl-names = "default";
6 pinctrl-0 = <&pinctrl_key>;
7 key-gpio = <&gpio1 18 GPIO_ACTIVE_LOW>; /* KEY0 */
8 status = "okay";
9 };
第6行，pinctrl-0属性设置KEY所使用的PIN对应的pinctrl节点。
第7行，key-gpio属性指定了KEY所使用的GPIO。
3、检查PIN是否被其他外设使用
在本章实验中蜂鸣器使用的PIN为UART1_CTS_B，因此先检查PIN为UART1_CTS_B这个PIN有没有被其他的pinctrl节点使用，如果有使用的话就要屏蔽掉，然后再检查GPIO1_IO18这个GPIO有没有被其他外设使用，如果有的话也要屏蔽掉。
设备树编写完成以后使用“make dtbs”命令重新编译设备树，然后使用新编译出来的imx6ull-alientek-emmc.dtb文件启动Linux系统。启动成功以后进入“/proc/device-tree”目录中查看“key”节点是否存在，如果存在的话就说明设备树基本修改成功(具体还要驱动验证)，结果如图49.3.1.1所示：
图46.3.1.1 key子节点
49.3.2 按键驱动程序编写
设备树准备好以后就可以编写驱动程序了，新建名为“11_key”的文件夹，然后在11_key文件夹里面创建vscode工程，工作区命名为“key”。工程创建好以后新建key.c文件，在key.c里面输入如下内容：
示例代码49.3.2.1 key.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 <asm/mach/map.h>
16 #include <asm/uaccess.h>
17 #include <asm/io.h>
18 /***************************************************************
19 Copyright © ALIENTEK Co., Ltd. 1998-2029. All rights reserved.
20 文件名 : key.c
21 作者 : 左忠凯
22 版本 : V1.0
23 描述 : Linux按键输入驱动实验
24 其他 : 无
25 论坛 : www.openedv.com
26 日志 : 初版V1.0 2019/7/18 左忠凯创建
27 ***************************************************************/
28 #define KEY_CNT 1 /* 设备号个数 */
29 #define KEY_NAME "key" /* 名字 */
30
31 /* 定义按键值 */
32 #define KEY0VALUE 0XF0 /* 按键值 */
33 #define INVAKEY 0X00 /* 无效的按键值 */
34
35 /* key设备结构体 */
36 struct key_dev{
37 dev_t devid; /* 设备号 */
38 struct cdev cdev; /* cdev */
39 struct class *class; /* 类 */
40 struct device *device; /* 设备 */
41 int major; /* 主设备号 */
42 int minor; /* 次设备号 */
43 struct device_node *nd; /* 设备节点 */
44 int key_gpio; /* key所使用的GPIO编号 */
45 atomic_t keyvalue; /* 按键值 */
46 };
47
48 struct key_dev keydev; /* key设备 */
49
50 /*
51 * @description : 初始化按键IO，open函数打开驱动的时候
52 * 初始化按键所使用的GPIO引脚。
53 * @param : 无
54 * @return : 无
55 */
56 static int keyio_init(void)
57 {
58 keydev.nd = of_find_node_by_path("/key");
59 if (keydev.nd== NULL) {
60 return -EINVAL;
61 }
62
63 keydev.key_gpio = of_get_named_gpio(keydev.nd ,"key-gpio", 0);
64 if (keydev.key_gpio < 0) {
65 printk("can't get key0\r\n");
66 return -EINVAL;
67 }
68 printk("key_gpio=%d\r\n", keydev.key_gpio);
69
70 /* 初始化key所使用的IO */
71 gpio_request(keydev.key_gpio, "key0"); /* 请求IO */
72 gpio_direction_input(keydev.key_gpio); /* 设置为输入 */
73 return 0;
74 }
75
76 /*
77 * @description : 打开设备
78 * @param – inode : 传递给驱动的inode
79 * @param - filp : 设备文件，file结构体有个叫做private_data的成员变量
80 * 一般在open的时候将private_data指向设备结构体。
81 * @return : 0 成功;其他 失败
82 */
83 static int key_open(struct inode *inode, struct file *filp)
84 {
85 int ret = 0;
86 filp->private_data = &keydev; /* 设置私有数据 */
87
88 ret = keyio_init(); /* 初始化按键IO */
89 if (ret < 0) {
90 return ret;
91 }
92
93 return 0;
94 }
95
96 /*
97 * @description : 从设备读取数据
98 * @param - filp : 要打开的设备文件(文件描述符)
99 * @param - buf : 返回给用户空间的数据缓冲区
100 * @param - cnt : 要读取的数据长度
101 * @param - offt : 相对于文件首地址的偏移
102 * @return : 读取的字节数，如果为负值，表示读取失败
103 */
104 static ssize_t key_read(struct file *filp, char __user *buf,
size_t cnt, loff_t *offt)
105 {
106 int ret = 0;
107 unsigned char value;
108 struct key_dev *dev = filp->private_data;
109
110 if (gpio_get_value(dev->key_gpio) == 0) { /* key0按下 */
111 while(!gpio_get_value(dev->key_gpio)); /* 等待按键释放 */
112 atomic_set(&dev->keyvalue, KEY0VALUE);
113 } else { /* 无效的按键值 */
114 atomic_set(&dev->keyvalue, INVAKEY);
115 }
116
117 value = atomic_read(&dev->keyvalue); /* 保存按键值 */
118 ret = copy_to_user(buf, &value, sizeof(value));
119 return ret;
120 }
121
122
123 /* 设备操作函数 */
124 static struct file_operations key_fops = {
125 .owner = THIS_MODULE,
126 .open = key_open,
127 .read = key_read,
128 };
129
130 /*
131 * @description : 驱动入口函数
132 * @param : 无
133 * @return : 无
134 */
135 static int __init mykey_init(void)
136 {
137 /* 初始化原子变量 */
138 atomic_set(&keydev.keyvalue, INVAKEY);
139
140 /* 注册字符设备驱动 */
141 /* 1、创建设备号 */
142 if (keydev.major) { /* 定义了设备号 */
143 keydev.devid = MKDEV(keydev.major, 0);
144 register_chrdev_region(keydev.devid, KEY_CNT, KEY_NAME);
145 } else { /* 没有定义设备号 */
146 alloc_chrdev_region(&keydev.devid, 0, KEY_CNT, KEY_NAME);
147 keydev.major = MAJOR(keydev.devid); /* 获取分配号的主设备号 */
148 keydev.minor = MINOR(keydev.devid); /* 获取分配号的次设备号 */
149 }
150
151 /* 2、初始化cdev */
152 keydev.cdev.owner = THIS_MODULE;
153 cdev_init(&keydev.cdev, &key_fops);
154
155 /* 3、添加一个cdev */
156 cdev_add(&keydev.cdev, keydev.devid, KEY_CNT);
157
158 /* 4、创建类 */
159 keydev.class = class_create(THIS_MODULE, KEY_NAME);
160 if (IS_ERR(keydev.class)) {
161 return PTR_ERR(keydev.class);
162 }
163
164 /* 5、创建设备 */
165 keydev.device = device_create(keydev.class, NULL, keydev.devid,
NULL, KEY_NAME);
166 if (IS_ERR(keydev.device)) {
167 return PTR_ERR(keydev.device);
168 }
169
170 return 0;
171 }
172
173 /*
174 * @description : 驱动出口函数
175 * @param : 无
176 * @return : 无
177 */
178 static void __exit mykey_exit(void)
179 {
180 /* 注销字符设备驱动 */
181 cdev_del(&keydev.cdev); /* 删除cdev */
182 unregister_chrdev_region(keydev.devid, KEY_CNT); /* 注销设备号 */
183
184 device_destroy(keydev.class, keydev.devid);
185 class_destroy(keydev.class);
186 }
187
188 module_init(mykey_init);
189 module_exit(mykey_exit);
190 MODULE_LICENSE("GPL");
191 MODULE_AUTHOR("zuozhongkai");
第36~46行，结构体key_dev为按键的设备结构体，第45行的原子变量keyvalue用于记录按键值。
第56~74行，函数keyio_init用于初始化按键，从设备树中获取按键的gpio信息，然后设置为输入。将按键的初始化代码提取出来，将其作为独立的一个函数有利于提高程序的模块化设计。
第83~94行，key_open函数通过调用keyio_init函数来始化按键所使用的IO，应用程序每次打开按键驱动文件的时候都会初始化一次按键IO。
第104~120行，key_read函数，应用程序通过read函数读取按键值的时候此函数就会执行。第110行读取按键IO的电平，如果为0的话就表示按键按下了，如果按键按下的话第111行就等待按键释放。按键释放以后标记按键值为KEY0VALUE。
第135~171 行，驱动入口函数，第138行调用atomic_set函数初始化原子变量默认为无效值。
第178~186行，驱动出口函数。
key.c文件代码很简单，重点就是key_read函数读取按键值，要对keyvalue进行保护。
49.3.3 编写测试APP
新建名为keyApp.c的文件，然后输入如下所示内容：
示例代码49.3.2.2 keyApp.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 Copyright © ALIENTEK Co., Ltd. 1998-2029. All rights reserved.
10 文件名 : keyApp.c
11 作者 : 左忠凯
12 版本 : V1.0
13 描述 : 按键输入测试应用程序
14 其他 : 无
15 使用方法 ：./keyApp /dev/key
16 论坛 : www.openedv.com
17 日志 : 初版V1.0 2019/1/30 左忠凯创建
18 ***************************************************************/
19
20 /* 定义按键值 */
21 #define KEY0VALUE 0XF0
22 #define INVAKEY 0X00
23
24 /*
25 * @description : main主程序
26 * @param - argc : argv数组元素个数
27 * @param - argv : 具体参数
28 * @return : 0 成功;其他 失败
29 */
30 int main(int argc, char *argv[])
31 {
32 int fd, ret;
33 char *filename;
34 unsigned char keyvalue;
35
36 if(argc != 2){
37 printf("Error Usage!\r\n");
38 return -1;
39 }
40
41 filename = argv[1];
42
43 /* 打开key驱动 */
44 fd = open(filename, O_RDWR);
45 if(fd < 0){
46 printf("file %s open failed!\r\n", argv[1]);
47 return -1;
48 }
49
50 /* 循环读取按键值数据！ */
51 while(1) {
52 read(fd, &keyvalue, sizeof(keyvalue));
53 if (keyvalue == KEY0VALUE) { /* KEY0 */
54 printf("KEY0 Press, value = %#X\r\n", keyvalue);/* 按下 */
55 }
56 }
57
58 ret= close(fd); /* 关闭文件 */
59 if(ret < 0){
60 printf("file %s close failed!\r\n", argv[1]);
61 return -1;
62 }
63 return 0;
64 }
第51~56行，循环读取/dev/key文件，也就是循环读取按键值，并且将按键值打印出来。
49.4 运行测试
49.4.1 编译驱动程序和测试APP
1、编译驱动程序
编写Makefile文件，本章实验的Makefile文件和第四十章实验基本一样，只是将obj-m变量的值改为key.o，Makefile内容如下所示：
示例代码49.4.1.1 Makefile文件
1 KERNELDIR := /home/zuozhongkai/linux/IMX6ULL/linux/temp/linux-imx-rel_imx_4.1.15_2.1.0_ga_alientek
......
4 obj-m := key.o
......
11 clean:
12 $(MAKE) -C $(KERNELDIR) M=$(CURRENT_PATH) clean
第4行，设置obj-m变量的值为key.o。
输入如下命令编译出驱动模块文件：
make -j32
编译成功以后就会生成一个名为“key.ko”的驱动模块文件。
2、编译测试APP
输入如下命令编译测试keyApp.c这个测试程序：
arm-linux-gnueabihf-gcc keyApp.c -o keyApp
编译成功以后就会生成keyApp这个应用程序。
49.4.2 运行测试
将上一小节编译出来的key.ko和keyApp这两个文件拷贝到rootfs/lib/modules/4.1.15目录中，重启开发板，进入到目录lib/modules/4.1.15中，输入如下命令加载key.ko驱动模块：
depmod //第一次加载驱动的时候需要运行此命令
modprobe key.ko //加载驱动
驱动加载成功以后如下命令来测试：
./keyApp /dev/key
输入上述命令以后终端显示如图49.4.2.1所示：
图49.4.2.1测试APP运行界面
按下开发板上的KEY0按键，keyApp就会获取并且输出按键信息，如图49.4.2.2所示：
图49.4.2.2 按键运行结果
从图49.4.2.2可以看出，当我们按下KEY0以后就会打印出“KEY0 Press, value = 0XF0”，表示按键按下。但是大家可能会发现，有时候按下一次KEY0但是会输出好几行“KEY0 Press, value = 0XF0”，这是因为我们的代码没有做按键消抖处理。
如果要卸载驱动的话输入如下命令即可：
rmmod key.ko