Linux驱动之设备树添加按键驱动

目录

一、Linux 下按键驱动原理

二、硬件原理图分析

三、开发环境

四、修改设备树文件

        1、添加 pinctrl 节点

        2、添加 KEY 设备节点

        3、检查 PIN 是否被其他外设使用

五、按键驱动程序编写

六、编写测试 APP

七、运行验证

扫描二维码关注公众号，回复： 17365023 查看本文章

---

一、Linux 下按键驱动原理

        按键驱动和 LED 驱动原理上来讲基本都是一样的，都是操作 GPIO，只不过一个是读取GPIO 的高低电平，一个是从 GPIO 输出高低电平。本次实现按键输入，在驱动程序中使用一个整形变量来表示按键值，应用程序通过 read 函数来读取按键值，判断按键有没有按下。

        在这里，这个保存按键值的变量就是个共享资源，驱动程序要向其写入按键值，应用程序要读取按键值。所以我们要对其进行保护，对于整形变量而言我们首选的就是原子操作，使用原子操作对变量进行赋值以及读取。 Linux 下的按键驱动原理很简单，接下来开始编写驱动。

        注意，本章例程只是为了演示 Linux 下 GPIO 输入驱动的编写，实际中的按键驱动并不会采用本章中所讲解的方法， Linux 下的 input 子系统专门用于输入设备！

二、硬件原理图分析

        从上图中可以看出，按键 KEY0 是连接到 I.MX6U 的 UART1_CTS 这个 IO 上的， KEY0接了一个 10K 的上拉电阻，因此 KEY0 没有按下的时候 UART1_CTS 应该是高电平，当 KEY0按下以后 UART1_CTS 就是低电平。

三、开发环境

• CPU：IMX6ULL

• 内核版本：Linux-5.19

四、修改设备树文件

1、添加 pinctrl 节点

        I.MX6U-ALPHA开发板上的 KEY 使用了 UART1_CTS_B这个 PIN，打开 imx6ul-14x14-evk.dtsi ，在 iomuxc 节点的 imx6ul-evk 子节点下创建一个名为“pinctrl_key”的子节点，节点内容如下所示：

pinctrl_key: keygrp {
    fsl,pins = <
        MX6UL_PAD_UART1_CTS_B__GPIO1_IO18 0xF080 /* key0 */
    >;
};

第 3 行，将 GPIO_IO18 这个 PIN 复用为 GPIO1_IO18。

2、添加 KEY 设备节点

在根节点“/”下创建 KEY 节点，节点名为“key”，节点内容如下：

key {
    #address-cells = <1>;
    #size-cells = <1>;
    compatible = "imx6ull-key";
    pinctrl-names = "default";
    pinctrl-0 = <&pinctrl_key>;
    key-gpio = <&gpio1 18 GPIO_ACTIVE_LOW>;
    status = "okay";
};

• 第 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-toto.dtb 文件启动 Linux 系统。启动成功以后进入“/proc/device-tree”目录中查看“key”节点是否存在，如果存在的话就说明设备树基本修改成功(具体还要驱动验证)，结果如下所示：

/ # ls /proc/device-tree/
#address-cells      clock-osc           pmu
#size-cells         compatible          regulator-can-3v3
aliases             cpus                regulator-peri-3v3
backlight-display   dts_led             regulator-sd1-vmmc
beep                key                 soc
chosen              memory@80000000     sound-wm8960
clock-cli           model               spi4
clock-di0           name                timer
clock-di1           panel

五、按键驱动程序编写

设备树准备好以后就可以编写驱动程序了，在 key.c 里面输入如下内容：

/************************************************************
 * Copyright © toto Co., Ltd. 1998-2029. All rights reserved.
 * Description: 
 * Version: 1.0
 * Autor: toto
 * Date: Do not edit
 * LastEditors: Seven
 * LastEditTime: Do not edit
************************************************************/

#include <linux/fs.h>
#include <linux/kernel.h>
#include <linux/delay.h>
#include <linux/init.h>
#include <linux/module.h>
#include <linux/io.h>
#include <linux/cdev.h>
#include <linux/uaccess.h>
#include <linux/device.h>
#include <linux/of.h>
#include <linux/of_address.h>
#include <linux/gpio.h>
#include <linux/of_gpio.h>

#define KEY_CNT         1       /* 设备号数量 */
#define KEY_NAME        "key"   /* 设备名字 */

/*定义按键值*/
#define KEY0_VALUE      0xF0    /* 按键值 */
#define INVAKEY         0x00    /* 无效按键值 */

/* key 设备结构体 */
struct key_dev
{
    dev_t devid;            /* 设备号 */
    struct cdev cdev;       /* cdev */
    struct class *class;    /* 类 */
    struct device *device;  /* 设备 */
    int major;              /* 主设备号 */
    int minor;              /* 次设备号 */
    struct device_node *nd; /* 设备节点 */
    int key_gpio;           /* key 所使用的GPIO编号 */
    atomic_t keyvalue;      /* 按键值 */
};

struct key_dev keydev;      /* key 设备 */

/*
 * @Brief   初始化按键使用的GPIO管脚
 * @Call    Internal or External
 * @Param   
 * @Note    NOne
 * @RetVal  无
 */
int keyio_init(void)
{
    keydev.nd = of_find_node_by_path("/key");
    if(keydev.nd == NULL)
    {
        return -EINVAL;
    }

    keydev.key_gpio = of_get_named_gpio(keydev.nd, "key-gpio", 0);
    if(keydev.key_gpio < 0)
    {
        printk("can't get key-gpio\n");
        return -EINVAL;
    }
    printk("key_gpio:%d\n", keydev.key_gpio);

    /* c初始化 key 使用的IO */
    gpio_request(keydev.key_gpio, "key0");  /* 请求IO */
    gpio_direction_input(keydev.key_gpio);  /* 设置为输入 */

    return 0;
}

/*
 * @Brief   打开设备
 * @Call    Internal or External
 * @Param   inode:
 * @Param   filp:设备文件
 * @Note    NOne
 * @RetVal  0:成功 其他值:失败
 */
static int beep_open(struct inode *inode, struct file *filp)
{
    int ret = 0;

    /* 设置私有数据 */
    filp->private_data = &keydev;

    /* 初始化按键IO */
    ret = keyio_init();
    if(ret < 0)
    {
        return ret;
    }

    return 0;
}

/*
 * @Brief   从设备读数据
 * @Call    Internal or External
 * @Param   filp:要打开的设备文件描述符
 * @Param   buf:返回给用户空间的数据地址
 * @Param   cnt:要读取的数据长度
 * @Param   offt:相对于文件首地址的偏移
 * @Note    NOne
 * @RetVal  读取的字节数，若为负值，表示读失败
 */
static ssize_t beep_read(struct file *filp, char __user *buf,
                        size_t cnt, loff_t *offt)
{
    int ret = 0;
    unsigned char value;
    struct key_dev *dev = filp->private_data;

    /* key0 按下 */
    if(gpio_get_value(dev->key_gpio) == 0)
    {
        /* 等待按键释放 */
        while(!gpio_get_value(dev->key_gpio));
        atomic_set(&dev->keyvalue, KEY0_VALUE);
    }
    else
    {
        /* 无效的按键值 */
        atomic_set(&dev->keyvalue, INVAKEY);
    }

    /* 保存按键值 */
    value = atomic_read(&dev->keyvalue);
    ret = copy_to_user(buf, &value, sizeof(value));
    
    return ret;
}

/*
 * @Brief   写数据到设备
 * @Call    Internal or External
 * @Param   filp:要打开的设备文件描述符
 * @Param   buf:要写入设备的数据地址
 * @Param   cnt:要写入的数据长度
 * @Param   offt:相对于文件首地址的偏移
 * @Note    NOne
 * @RetVal  写入的字节数，若为负值，表示写失败
 */
static ssize_t beep_write(struct file *filp, const char __user *buf,
                        size_t cnt, loff_t *offt)
{
    return 0;
}


/*
 * @Brief   关闭/释放设备
 * @Call    Internal or External
 * @Param   inode:
 * @Param   filp:要关闭的设备文件描述符
 * @Note    NOne
 * @RetVal  NOne
 */
static int beep_release(struct inode *inode, struct file *filp)
{
    return 0;
}

/* 设备操作函数 */
static struct file_operations key_fops = {
    .owner = THIS_MODULE,
    .open  = beep_open,
    .read  = beep_read,
    .write = beep_write,
    .release = beep_release,
};

/*
 * @Brief   驱动入口函数
 * @Call    Internal or External
 * @Param   None
 * @Note    NOne
 * @RetVal  NOne
 */
static int __init mykey_init(void)
{
    /* 初始化原子变量 */
    atomic_set(&keydev.keyvalue, INVAKEY);

    /* 注册字符设备驱动 */
    /* 创建设备号 */
    if(keydev.major) /* 定义了设备号 */
    {
        keydev.devid = MKDEV(keydev.major, 0);
        register_chrdev_region(keydev.devid, KEY_CNT, KEY_NAME);
    }
    else
    {
        /* 申请设备号 */
        alloc_chrdev_region(&keydev.devid, 0, KEY_CNT, KEY_NAME);
        /* 获取主设备号 */
        keydev.major = MAJOR(keydev.devid);
        /* 获取次设备号 */
        keydev.minor = MINOR(keydev.devid);
    }
    printk("%s new_chrdev major:%d minor:%d\n", __func__,
            keydev.major, keydev.minor);

    /* 初始化cdev */
    keydev.cdev.owner = THIS_MODULE;
    cdev_init(&keydev.cdev, &key_fops);

    /* 添加一个cdev */
    cdev_add(&keydev.cdev, keydev.devid, KEY_CNT);

    /* 创建类 */
    keydev.class = class_create(THIS_MODULE, KEY_NAME);
    if(IS_ERR(keydev.class))
    {
        return PTR_ERR(keydev.class);
    }

    /* 创建设备 */
    keydev.device = device_create(keydev.class, NULL,
                        keydev.devid, NULL, KEY_NAME);
    if(IS_ERR(keydev.device))
    {
        return PTR_ERR(keydev.device);
    }

    return 0;
}

/*
 * @Brief   驱动出口函数
 * @Call    Internal or External
 * @Param   None
 * @Note    NOne
 * @RetVal  NOne
 */
static void __exit mykey_exit(void)
{
    /* 注销字符设备驱动 */
    gpio_free(keydev.key_gpio);
    /* 注销字符设备 */
    /* 删除cdev */
    cdev_del(&keydev.cdev);
    /* 释放分配的设备号 */
    unregister_chrdev_region(keydev.devid, KEY_CNT);

    device_destroy(keydev.class, keydev.devid);
    class_destroy(keydev.class);
}

module_init(mykey_init);
module_exit(mykey_exit);
MODULE_LICENSE("GPL");
MODULE_AUTHOR("toto");

六、编写测试 APP

key_app.c 测试程序具体代码如下：

/********************************************
 *Description: 
 *Version: 1.0
 *Autor: toto
 *Date: Do not edit
 *LastEditors: Seven
 *LastEditTime: Do not edit
********************************************/
#include <stdio.h>
#include <unistd.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <stdlib.h>
#include <string.h>

#define KEY0VALUE   0xF0
#define INVAKEY     0x00

/*
 * @Brief   main 主程序
 * @Call    Internal or External
 * @Param   argc:
 * @Param   argv:
 * @Note    NOne
 * @RetVal  0-成功;其他-失败
 */
int main(int argc, char *argv[])
{
    int fd, retval;
    char *filename;
    unsigned char keyvalue;

    if(argc != 2)
    {
        printf("argc != 2\n");
        return -1;
    }

    filename = argv[1];

    /*打开驱动文件*/
    fd = open(filename, O_RDWR);
    if(fd < 0)
    {
        printf("open filename:%d failed\n", filename);
        return -1;
    }

    /* 要执行的操作：打开或关闭 */
    while(1)
    {
        read(fd, &keyvalue, sizeof(keyvalue));
        if(keyvalue == KEY0VALUE)
        {
            /* 按下 */
            printf("KEY0 down, value:0x%x\n", keyvalue);
        }
    }

    /*关闭文件*/
    close(fd);

    return 0;
}

七、运行验证

开发板上电，将key.ko 和 key_app 这两个文件拷贝到 /lib/modules/5.19.0-g794a2f7be62d-dirty/ 目录中，输入如下命令加载 key.ko 驱动模块：

/ # insmod /lib/modules/5.19.0-g794a2f7be62d-dirty/key.ko 
[  108.608375] key_driver: loading out-of-tree module taints kernel.
[  108.619185] mykey_init new_chrdev major:242 minor:0

驱动加载成功以后就可以使用如下命令来测试：

# ./key_app /dev/key 

按下开发板上的 KEY0 按键， key_app 就会获取并且输出按键信息，如下所示：

/home/app # ./key_app /dev/key 
[  155.043576] key_gpio:18
KEY0 down, value:0xf0
KEY0 down, value:0xf0
KEY0 down, value:0xf0
KEY0 down, value:0xf0
KEY0 down, value:0xf0
KEY0 down, value:0xf0

从上面可以看出，当我们按下 KEY0 以后就会打印出“KEY0 down, value = 0XF0”，表示按键按下。会发现，有时候按下一次 KEY0 但是会输出好几行“KEY0 down,value = 0XF0”，这是因为我们的代码没有做按键消抖处理。 如果要卸载驱动的话输入如下命令即可：

rmmod key.ko

---

        关于更多嵌入式C语言、FreeRTOS、RT-Thread、Linux应用编程、linux驱动等相关知识，关注公众号【嵌入式Linux知识共享】，后续精彩内容及时收看了解。