第十五节 输入子系统–按键输入实验

计算机的输入设备繁多，有按键、鼠标、键盘、触摸屏、游戏手柄等等，Linux 内核为了能够将所有的输入设备进行统一的管理，设计了输入子系统。为上层应用提供了统一的抽象层，各个输入设备的驱动程序只需上报产生的输入事件即可。

输入子系统简介

linux 为了统一各个输入设备，将输入子系统分为了Drivers（驱动层）、Input Core（输入子系统核心层）、handlers（事件处理层）三部分。

• Drivers 主要实现对硬件设备的读写访问，设置中断，并将硬件产生的事件转为Input Core定义的规范提交给Handlers;
• Input Core 起到承上启下的作用，为Drivers 提供了规范及接口，并通知Handlers 对事件进行处理;
• Handlers 并不涉及硬件方面的具体操作，是一个纯软件层，包含了不同的解决方案，如按键、键盘、鼠标、游戏手柄等。

最终所有输入设备的输入信息将被抽象成以下结构体：

列表1: struct input_event 结构体(内核源码includeuapilinuxinput.h)

//输入事件
struct input_event{
	struct timeval time; //事件产生的时间
	__u16 type; //输入设备的类型，鼠标、键盘、触摸屏
	__u16 code;
	__s16 value;
}

• time ：事件产生的时间。
• type ：输入设备的类型。
• code ：根据设备类型的不同而含义不同，如果设备类型是按键，code 表示为按键值(如第几个按键等)。
• value：根据设备类型的不同而含义不同。如果设备类型是按键，value 表示的是松开或者按下。

本章目的是编写一个基于输入子系统和中断的按键驱动程序，重点在于了解Input Core 为我们提供了哪些接口，并了解如何将按键信息以事件上报。

input 子系统Input Core 实现代码是“~/drivers/input/input.c ”以及“ ~/include/linux/input.h ”两个文件为我们提供了注册输入子系统的API，通过操作这些API 就可以实现输入事件的注册、初始化、上报、注销等等工作。下面我们介绍输入子系统常用的API 接口及数据结构。

input_dev 结构体

在输入子系统中input_dev 代表一个具体的输入设备，后面将会根据具体的设备来初始化这个结构体，结构体成员介绍如下：(input_dev 参数很多，有些不需要我们手动配置，所以这里只列出和介绍常用的参数，完整内容位于input.h 文件)。

列表2: input_dev 结构体(内核源码/drivers/input/input.h)

struct input_dev {
	const char *name; //提供给用户的输入设备的名称
	const char *phys; //提供给编程者的设备节点的名称
	const char *uniq; //指定唯一的ID 号
	struct input_id id; //输入设备标识ID

	unsigned long propbit[BITS_TO_LONGS(INPUT_PROP_CNT)];

	unsigned long evbit[BITS_TO_LONGS(EV_CNT)]; //指定设备支持的事件类型
	unsigned long keybit[BITS_TO_LONGS(KEY_CNT)]; //记录支持的键值
	unsigned long relbit[BITS_TO_LONGS(REL_CNT)]; //记录支持的相对坐标位图
	unsigned long absbit[BITS_TO_LONGS(ABS_CNT)]; //记录支持的绝对坐标位图

	/*----------以下结构体成员省略----------------*/
};

结构体成员中最重要的是evbit、keybit、relbit 等数组，这些数组设置了设备输入事件的类型和键值。

• evbit: 用于指定支持的事件类型，这要根据实际输入设备能够产生的事件来选择，可选选项如下所示。

列表3: 输入子系统事件类型(内核源码\include\uapi\linux\input-event-codes.h)

#define EV_SYN 0x00 //同步事件
#define EV_KEY 0x01 //用于描述键盘、按钮或其他类似按键的设备。
#define EV_REL 0x02 //用于描述相对位置变化，例如鼠标移动
#define EV_ABS 0x03 //用于描述绝对位置变化，例如触摸屏的触点坐标
#define EV_MSC 0x04 //其他事件类型
#define EV_SW 0x05 //用于描述二进制开关类型的设备，例如拨码开关。
#define EV_LED 0x11
#define EV_SND 0x12
#define EV_REP 0x14
#define EV_FF 0x15
#define EV_PWR 0x16
#define EV_FF_STATUS 0x17
#define EV_MAX 0x1f
#define EV_CNT (EV_MAX+1)

上面代码中前几个宏定义较为常用的输入事件类型，介绍如代码后面所示。完整的介绍可以参考内核源码目录下的“~/ Documentation/input/ event-codes.txt ”内核文档。很明显，我们这章节要使用的按键的事件类型应该使用EV_KEY 。

• keybit：记录支持的键值，“键值”在程序中用于区分不同的按键，可选“键值”如下所示。

列表4: 输入子系统— 按键键值(内核源码\include\uapi\linux\input-event-codes.h)

#define KEY_RESERVED 0
#define KEY_ESC 1
#define KEY_1 2
#define KEY_2 3
#define KEY_3 4
#define KEY_4 5
/*-----------以下内容省略-------------*/

可以看出“键值”就是一些数字。只要实际设备与按键对应即可。例如本章的按键可以使用KEY_1、也可以使用KEY_4 等。

• relbit、absbit：这两个参数和上面的keybit 都和参数evbit 有关，如果evbit 中只选择了
  EV_KEY，那么我们就不需要设置relbit（相对坐标）和absbit（绝对坐标）以及后面省略成员的内容。这些内容使用到时再具体介绍。使用不同的输入事件类型需要设备不同的

总之，input_dev 结构体成员很多，但是对应到一个具体的输入设备，只需要设置自己用到的其中一两个属性。

input_dev 结构体的申请和释放

一个input_dev 结构体代表了一个输入设备，它实际会占输入子系统的一个次设备号。input 子系统为我们提供了申请和释放input_dev 结构体的函数。由于input_dev 结构体的成员很多，初始化过程也相对麻烦，一般都使用input 子系统为我们提供的接口函数来申请和释放input_dev 结构体，如下所示。

列表5: input_dev 申请函数(内核源码\drivers\input\input.c)

struct input_dev *input_allocate_device(void)
{
	static atomic_t input_no = ATOMIC_INIT(-1);
	struct input_dev *dev;

	dev = kzalloc(sizeof(*dev), GFP_KERNEL); //动态内存申请
	if (dev) {
		dev->dev.type = &input_dev_type;
		dev->dev.class = &input_class; //dev->dev 为struct device 类型结构体
		device_initialize(&dev->dev); //初始化dev->dev结构体内部成员
		mutex_init(&dev->mutex); //初始化互斥锁
		spin_lock_init(&dev->event_lock); //初始化自旋锁
		timer_setup(&dev->timer, NULL, 0); //初始化定时器
		INIT_LIST_HEAD(&dev->h_list); //初始化handle链表节点
		INIT_LIST_HEAD(&dev->node); //初始化输入设备链表节点

		dev_set_name(&dev->dev, "input%lu",
				(unsigned long)atomic_inc_return(&input_no)); //设置设备名称

		__module_get(THIS_MODULE);
	}

	return dev;
}
EXPORT_SYMBOL(input_allocate_device);

参数：无

返回值：

• 成功： struct input_dev 类型指针
• 失败： NULL

我们只需要知道如何调用这个函数来申请input_dev 即可，想要更深入学习的同学们可以尝试去分析整个输入子系统的实现源码，对于输入子系统的源码分析就可以写一篇很长的文章了，这里并不展开详细的源码分析。

列表6: input_dev 释放函数(内核源码\drivers\input\input.c)

void input_free_device(struct input_dev *dev)

参数： dev：struct input_dev 类型指针

返回值：无

申请和释放函数接口比较简单。申请函数input_allocate_device 执行成功后会返回申请得到的input_dev 结构体的地址，如果失败，返回NULL。释放函数input_free_device 只有一个参数dev，用于指定要释放的input_dev 结构体。

注册和注销input_dev 结构体

input_dev 申请成功后，我们需要根据自己的实际输入设备配置input_dev 结构体，具体配置在实验代码编写部分会详细说明，配置完成后还要使用注册和注销函数将input_dev 注册到输入子系统。注册和注销函数如下：

列表7: input_dev 注册函数(内核源码\drivers\input\input.c)

int input_register_device(struct input_dev *dev)

参数： dev：struct input_dev 类型指针

返回值：

• 成功： 0
• 失败：返回非0 值

input_register_device 函数将输入设备（input_dev）注册到输入子系统的核心层。该函数使用需要注意以下几点

• 使用该函数注册的input_dev 必须是使用input_allocate_device 函数申请得到的。
• 注册之前需要根据实际输入设备配置好input_dev 结构体。
• 如果注册失败必须调用input_free_device 函数释放input_dev 结构体。
• 如果注册成功，在函数退出时只需要使用input_unregister_device 函数注销input_dev 结构体不需要再调用input_free_device 函数释放input_dev 结构体。

列表8: input_dev 注销函数(内核源码\drivers\input\input.c)

void input_unregister_device(struct input_dev *dev)

参数： dev：struct input_dev 类型指针

返回值：无

input_unregister_device 是注销函数，输入子系统的资源是有限的，不使用是应当注销。调用input_unregister_device 注销函数之后就不必调用input_free_device 函数释放input_dev。

上报事件函数和上报结束函数

以按键为例，按键按下后需要使用上报函数向输入子系统核心层上报按键事件，并且上报后还要发送上报结束信息。函数定义如下所示。

列表9: 通用的上报事件函数(内核源码\drivers\input\input.h)

void input_event(struct input_dev *dev, unsigned int type, unsigned int code, int value);

input_event 函数用于上报事件，共有4 个参数介绍如下。

参数：

• dev，指定输设备（input_dev 结构体）。
• type，事件类型。我们在根据实际输入设备配置input_dev 结构体时会设置input_dev-> evbit参数，用于设置输入设备能够产生的事件类型（可能是多个）。上报事件时要从“能够产生”的这些事件类型中选择。
• code，编码。以按键为例，按键的编码就是我们设置的按键键值。
• value，指定事件的值。

返回值：无

列表10: 上报按键事件及发送上报结束事件(内核源码\drivers\input\input.h)

static inline void input_sync(struct input_dev *dev)
{
	input_event(dev, EV_SYN, SYN_REPORT, 0);
}

static inline void input_report_key(struct input_dev *dev, unsigned int code, int value)
{
	input_event(dev, EV_KEY, code, !!value);
}

input 子系统为不同的输入事件函数提供了不同的函数接口，这些函数接口只是对input_event 函数进行简单的封装，具体的参数参照input_event 函数。input_report_key 用于上报按键事件，input_sync用于发送同步信号，表示上报结束。

输入子系统实验

本小节以按键为例介绍输入子系统的具体使用方法。本实验在上一章“中断实验”基础上完成。结合源码介绍如下。

设备树插件实现

设备树插件与上一章的“中断实验”使用的设备树插件几乎相同，我们只需要将中断类型修改为“上升和下降沿触发”。修改部分如下所示。

列表11: 设备树插件修改

// SPDX-License-Identifier: (GPL-2.0+ OR BSD-3-Clause)
/*
* Copyright (C) STMicroelectronics 2018 - All Rights Reserved
* Author: Alexandre Torgue <alexandre.torgue@st.com>.
*/

/dts-v1/;
/plugin/;
//#include "../stm32mp157c.dtsi"
#include <dt-bindings/pinctrl/stm32-pinfunc.h>
#include <dt-bindings/input/input.h>
#include <dt-bindings/mfd/st,stpmic1.h>
#include <dt-bindings/gpio/gpio.h>
#include <dt-bindings/interrupt-controller/irq.h>

/ {
	fragment@0 {
		target-path = "/";
		__overlay__ {
			button_interrupt {
			compatible = "button_interrupt";
			pinctrl-names = "default";
			pinctrl-0 = <&pinctrl_button>;
			button_gpio = <&gpiob 13 GPIO_ACTIVE_LOW>; //默认低电平，按键按下高电平
			status = "okay";
			interrupts-extended = <&gpiob 13 IRQ_TYPE_EDGE_BOTH>;
			interrupt-names = "button_interrupt";
			//interrupt-parent = <&gpiob>;
			//interrupts = <13 IRQ_TYPE_EDGE_BOTH>; // 指定中断，触发方式为双沿触发。
			};
		};
	};

	fragment@1 {
		target = <&pinctrl>;
		__overlay__ {
		pinctrl_button: buttongrp {
				pins {
					pinmux = <STM32_PINMUX('B', 13, GPIO)>;
					drive-push-pull;
				};
			};
		};
	};
};

修改内容很简单只是将原来中断的触发方式修改为双边沿触发，其他的设备树内容不变。

驱动程序实现

驱动入口函数

驱动入口函数如下所示。

列表12: 驱动入口函数

static int __init button_driver_init(void)
{

	int error;
	printk(KERN_ERR "button_driver_init \n");

	/*-----------第一部分-------------*/
	/* 获取按键设备树节点*/
	button_device_node = of_find_node_by_path("/button_interrupt");
	if (NULL == button_device_node)
	{
		printk(KERN_ERR "of_find_node_by_path error!");
		return -1;
	}

	/* 获取按键使用的GPIO*/
	button_GPIO_number = of_get_named_gpio(button_device_node, "button_gpio", 0);
	if (0 == button_GPIO_number)
	{
		printk(KERN_ERR"of_get_named_gpio error");
		return -1;
	}

	/* 申请GPIO , 记得释放*/
	error = gpio_request(button_GPIO_number, "button_gpio");
	if (error < 0)
	{
		printk(KERN_ERR "gpio_request error");
		gpio_free(button_GPIO_number);
		return -1;
	}

	error = gpio_direction_input(button_GPIO_number); //设置引脚为输入模式


	/* 获取中断号*/
	interrupt_number = irq_of_parse_and_map(button_device_node, 0);
	printk(KERN_ERR "\n interrupt_number = %d \n", interrupt_number);

	/* 申请中断, 记得释放*/
	error = request_irq(interrupt_number, button_irq_hander, IRQF_TRIGGER_RISING | 		IRQF_TRIGGER_FALLING, "button_interrupt", NULL);
	if (error != 0)
	{
		printk(KERN_ERR "request_irq error");
		gpio_free(button_GPIO_number);
		free_irq(interrupt_number, NULL);
		return -1;
	}
	
	/*-----------第二部分-------------*/
	/* 申请输入子系统结构体*/
	button_input_dev = input_allocate_device();
	if (NULL == button_input_dev)
	{
		printk(KERN_ERR "input_allocate_device error");
		return -1;
	}
	button_input_dev->name = BUTTON_NAME;

	/*-----------第三部分-------------*/
	/* 设置要使用的输入事件类型*/
	button_input_dev->evbit[0] = BIT_MASK(EV_KEY);
	input_set_capability(button_input_dev, EV_KEY, KEY_1); //标记设备能够触发的事件

	/*-----------第四部分-------------*/
	/* 注册输入设备*/
	error = input_register_device(button_input_dev);
	if (0 != error)
	{
		printk(KERN_ERR "input_register_device error");
		gpio_free(button_GPIO_number);
		free_irq(interrupt_number, NULL);
		input_unregister_device(button_input_dev);
		return -1;
	}
	return 0;
}

驱动入口函数完成基本的初始化工作，结合代码各部分介绍如下：

• 第9-49 行：这部分和“中断实验”相同，依次执行获取设备树节点、获取GPIO、申请GPIO、获取中断号、申请中断，需要注意的是这里中断类型为“上升和下降沿触发”。
• 第50-58 行：申请输入子系统结构体，申请得到的input_dev 结构体代表了一个输入设备，下面要根据实际的输入设备设置这个结构体。
• 第62 行：设置输入事件类型。input_dev 参数很多，其中最主要的是事件类型和事件对应的code。evbit 每一位代表了一种事件类型，为1 则表示支持，0 表示不支持。例如我们这里要支持“按键”事件，那么就要将EV_KEY（等于0x01）位置1。内核提供了帮助宏BIT_MASK帮助我们开启某一“事件”。
• 第63 行：设置支持的事件类型之后还要设置与之对应的“事件值”，内核文档中称为code。以按键为例，就是为按键选择键值(在程序中通过键值区分不同的按键)，input_dev->keybit参数用于选择键值，例如在驱动中有6 个按键，那么就要使能6 个键值，同样input_dev->keybit 每一位代表一个键值，我们可以直接设置某一位使能对应的键值，不过内核提供了很多帮助宏或函数帮助我们设置键值（也可用于设置其他类型事件的code），我们在程序中使用的是input_set_capability 函数。
• 第67-75 行：注册输入设备。注册成功后，输入设备被添加到输入子系统内核层，系统能够接受来自该设备的输入事件。需要注意的是如果注册失败需要注销之前申请的资源然后退出

input_set_capability 函数，原型如下：

列表13: input_set_capability 函数(内核源码\drivers\input\input.c)

void input_set_capability(struct input_dev *dev, unsigned int type, unsigned int code)
{
	switch (type) {
	case EV_KEY:
			__set_bit(code, dev->keybit);
			break;

	case EV_REL:
			__set_bit(code, dev->relbit);
			break;

	case EV_ABS:
			input_alloc_absinfo(dev);
			if (!dev->absinfo)
				return;

			__set_bit(code, dev->absbit);
			break;

	case EV_MSC:
			__set_bit(code, dev->mscbit);
			break;

	case EV_SW:
			__set_bit(code, dev->swbit);
			break;

	case EV_LED:
			__set_bit(code, dev->ledbit);
			break;

	case EV_SND:
			__set_bit(code, dev->sndbit);
			break;

	case EV_FF:
			__set_bit(code, dev->ffbit);
			break;

	case EV_PWR:
			/* do nothing */
			break;

	default:
			pr_err("input_set_capability: unknown type %u (code %u)\n",
					type, code);
			dump_stack();
			return;
	}

	__set_bit(type, dev->evbit);
}

参数：

• dev：指定要设置的input_dev 结构体，也就是要设置的输入设备，
• type：设置输入类型，可以看到，函数实现中根据type 设置不同的input_dev 结构体参数。
  例如type =EV_KEY，那么设置的是input_dev->keybit，也就是键值。
• code：不同类型的输入信号含义不同，如果是按键，则表示的是要设置的按键的键值。

返回值：无

驱动出口函数

出口函数主要完成驱动退出前的清理工作，很简单，代码如下：

列表14: 驱动出口函数

static void __exit button_driver_exit(void)
{
	pr_info("button_driver_exit\n");

	/* 释放申请的引脚, 和中断*/
	gpio_free(button_GPIO_number);
	free_irq(interrupt_number, NULL);

	/* 释放输入子系统相关内容*/
	input_unregister_device(button_input_dev);
}

• 第6-7 行：释放申请的引脚和中断
• 第10 行：释放申请的输入子系统

中断服务函数

中断服务函数中我们读取按键输入引脚的状态判断按键是按下还是松开。代码如下所示。

列表15: 按键中断处理函数

static irqreturn_t button_irq_hander(int irq, void *dev_id)
2 {
3 int button_satus = 0;
4
5
6 /* 读取按键引脚的电平，根据读取得到的结果输入按键状态*/
7 button_satus = gpio_get_value(button_GPIO_number);
8 if(0 == button_satus)
9 {
10
11 input_report_key(button_input_dev, KEY_1, 0);
12 input_sync(button_input_dev);
13 }
14 else
15 {
16 input_report_key(button_input_dev, KEY_1, 1);
17 input_sync(button_input_dev);
}
19
20 return IRQ_HANDLED;
21 }

• 第7 行：读取按键对应引脚的电平。
• 第8-18 行：根据按键引脚状态向系统上报按键事件。

测试应用程序实现

测试应用程序中读取按键键值，打印按键状态。具体代码如下所示。

列表16: 测试应用程序实现

struct input_event button_input_event;

int main(int argc, char *argv[])
{
	int error = -20;

	/* 打开文件*/
	int fd = open("/dev/input/event1", O_RDONLY);
	if (fd < 0)
	{
		printf("open file : /dev/input/event1 error!\n");
		return -1;
	}

	printf("wait button down... \n");

	do
	{
		/* 读取按键状态*/
		error = read(fd, &button_input_event, sizeof(button_input_event));
		if (error < 0)
		{
			printf("read file error! \n");
		}
		/* 判断并打印按键状态*/
		if((button_input_event.type == 1) && (button_input_event.code == 2))
		{
			if(button_input_event.value == 0)
			{
				printf("button up\n");
			}
			else if(button_input_event.value == 1)
			{
				printf("button down\n");
			}
		}
	} while (1);

	printf("button Down !\n");

	/* 关闭文件*/
	error = close(fd);
	if (error < 0)
	{
		printf("close file error! \n");
	}
	return 0;
}

• 第1 行：申请一个input_event 类型的结构体变量，如我们在本章开头前所说的所有的输入设备传递的信息都会以事件的形式上报。
• 第8 行：这里的打开的文件* /dev/input/event1* 是输入子系统为我们生成的输入设备设备，即我们使用的按键。
• 第21 行：读取按键信息，read 函数没有读取到上报输入事件则将一直等待。
• 第27-37 行：根据获取读取到的信息判断按键的状态。

测试应用程序的内容很简单，基本是按照打开文件、读取状态、判断状态并打印状态。

实验准备

取消KEY 设备树插件，以释放系统对应KEY 资源，并添加输入子系统实验的设备树插件，操作如下：

dtoverlay=/usr/lib/linux-image-4.19.94-stm-r1/overlays/stm-fire-button-interrupt-input.dtbo

如若运行代码时出现“Device or resource busy”或者运行代码卡死等等现象，请按上述情况检查并按上述步骤操作。

如出现Permission denied 或类似字样，请注意用户权限，大部分操作硬件外设的功能，几乎都需要root 用户权限，简单的解决方案是在执行语句前加入sudo 或以root 用户运行程序。

通过内核工具编译设备树插件

设备树插件与设备树一样都是使用DTC 工具编译，只不过设备树编译为.dtb。而设备树插件需要编译为.dtbo。我们可以使用DTC 编译命令编译生成.dtbo，但是这样比较繁琐、容易出错。

我们可以修改内核目录/arch/arm/boot/dts/overlays 下的Makefile 文件，添加我们编辑好的设备树插件。并把设备树插件文件放在和Makefile 文件同级目录下。以进行设备树插件的编译。

在内核的根目录下执行如下命令即可：

make ARCH=arm CROSS_COMPILE=arm-linux-gnueabihf- stm32mp157_ebf_defconfig

make ARCH=arm -j4 CROSS_COMPILE=arm-linux-gnueabihf- dtbs

生成的.dtbo 位于内核根目录下的“/arch/arm/boot/dts/overlays”目录下。

本章的输入子系统的设备树插件为“stm-fire-button-interrupt-input-overlay.dts”，编译之后就会在/arch/arm/boot/dts/overlays 目录下生成同名的stm-fire-button-interrupt-input.dtbo 文件。得到.dtbo后，下一步就是将其加载到系统中。

添加设备树插件文件

将上小节中编译出的设备树插件stm-fire-button-interrupt-input.dtbo 添加到开发板目录/usr/lib/linux-image-4.19.94-stm-r1/overlays/ 中重启开发板即可。

编译驱动程序及测试程序

本节实验使用的Makefile 如下所示：

列表17: Makefile(位于…/linux_driver/button_interrupt/interrupt)

KERNEL_DIR=../ebf_linux_kernel/build_image/build

ARCH=arm
CROSS_COMPILE=arm-linux-gnueabihf-
export ARCH CROSS_COMPILE

obj-m := input_sub_system.o
out = test_app

all:
	$(MAKE) -C $(KERNEL_DIR) M=$(CURDIR) modules
	$(CROSS_COMPILE)gcc -o $(out) test_app.c

.PHONY:clean
clean:
	$(MAKE) -C $(KERNEL_DIR) M=$(CURDIR) clean
	rm test_app

将配套的驱动代码如：input_sub_system 放置在与内核同级目录下，并在驱动目录中输入如下命令来编译驱动模块及测试程序：

make

下载验证

将编译好的驱动、应用程序、设备树插件并拷贝到开发板，这里就不再赘述这一部分内容了，前面的章节中都有详细介绍。

在加载模块之前，先查看/boot/uEnv.txt 文件是否加载了板子上原有的与KEY 相关设备树插件。并添加输入子系统的设备树插件。

添加输入子系统的设备树插件。如KEY 相关设备树插件开启，则添加’#’以注销掉与KEY 相关的设备树插件，并重启开发板。

重启后使用insmod 命令加载驱动，如下所示：

此时会在“/dev/input”目录下生成设备节点文件。

驱动加载成功后直接运行测试应用程序命令“./test_app”. 测试程序运行后等待按键按下，此时按下开发板的“KEY1”按键，终端会输出按键状态，如下所示。

---

参考资料：嵌入式Linux 驱动开发实战指南-基于STM32MP1 系列