Linux内核的GPIO子系统驱动框架详解以及基于pinctrl和gpio子系统的LED驱动程序_gpio驱动代码流程

目录

1 引入

2 GPIO子系统的层次

3 gpio子系统驱动程序流程

4 gpio子系统的重要数据结构

5 gpio子系统函数调用的详细细节

6 GPIO子系统的sysfs接口

6.1有哪些gpio控制器

6.2每个gpio控制器的详细信息

6.3查看gpio使用情况

6.4通过SYSFS使用GPIO

6.4.1 确定GPIO编号

6.4.2 导出、设置方向、读写值

7 费曼学习法：于是我录制了一个讲解gpio子系统的学习视频

8 基于pinctrl子系统和gpio子系统的LED驱动程序

8.1 查看原理图确定引脚

8.2 修改设备树文件

8.2.1 设备树中增加pinctrl信息

8.2.2 设备中增加led节点信息

8.3 编写代码

8.3.1驱动程序leddrv.c

8.3.2 测试程序ledtest.c

8.3.3 Makefile

8.4 实验

8.4.1 编译设备树文件

8.4.2 编译驱动和测试程序

8.4.3 替换设备树、驱动以及测试程序

---

1 引入

当我们想用某个引脚控制LED灯的亮灭时，一般来说我们需要使能时钟，然后将引脚配置为GPIO功能，然后配置电气属性，然后配置GPIO为输出，最后根据原理图控制GPIO的输出电平，其中配置GPIO的方向以及电平是由GPIO子系统来做的。

2 GPIO子系统的层次

上图就是gpio子系统的层次结构图，在其他的驱动程序里面，我们可以直接用gpiod_set_value这种函数来设置引脚的值，这个函数是在gpio库里面定义的，gpio库起到一个承上启下的作用，然后这个gpiod_set_value函数最终调用的是chip->set(chip, gpio_chip_hwgpio(desc), value)函数，这里的chip就是在gpio驱动程序里面注册的结构体，这个结构体体里面就包含了一些对gpio的操作函数。

3 gpio子系统驱动程序流程

上图是我根据Linux内核源码画的一个GPIO驱动程序流程图，我们在设备树中的gpio控制器节点里面的compatible为fsl,imx35-gpio,然后我们在内核源码中搜索，可以找到匹配的驱动为mxc_gpio_driver,然后当device和driver相匹配之后，会调用驱动程序里面的probe函数，在这里也就是mxc_gpio_probe函数，然后在这个mxc_gpio_probe函数里面其实就是做了下面三个工作

• 分配结构体
• 设置结构体
• 注册结构体

mxc_gpio_probe函数具体做的工作：首先调用了mxc_gpio_get_hw函数，这个函数是获取了gpio寄存器组的偏移地址，然后还一个platform_get_resource函数，这个platform_get_resource函数是得到了gpio的寄存器的基地址，然后调用了devm_kzalloc分配了一个mxc_gpio_port结构体，

struct mxc_gpio_port {
    struct list_head node;
    struct clk *clk;
    void __iomem *base;
    int irq;
    int irq_high;
    struct irq_domain *domain;
    struct gpio_chip gc;
    u32 both_edges;
    int saved_reg[6];
    bool gpio_ranges;
};

然后这个mxc_gpio_port结构体里面有一个重要的gpio_chip结构体成员。

struct gpio_chip {
    const char      *label;
    struct gpio_device  *gpiodev;
    struct device       *parent;
    struct module       *owner;
    ...省略一些...
    int         (*direction_input)(struct gpio_chip *chip,
                        unsigned offset);
    int         (*direction_output)(struct gpio_chip *chip,
                        unsigned offset, int value);
    int         (*get)(struct gpio_chip *chip,
                        unsigned offset);
    void            (*set)(struct gpio_chip *chip,
                        unsigned offset, int value);
     ...省略一些...
                        enum single_ended_mode mode);
    int         (*to_irq)(struct gpio_chip *chip,
                        unsigned offset);
    void            (*dbg_show)(struct seq_file *s,
                        struct gpio_chip *chip);
     ...省略一些...
};

这个gpio_chip里面就是各种操作函数。

然后probe函数里面又调用了下面这个函数

    err = bgpio_init(&port->gc, &pdev->dev, 4,
             port->base + GPIO_PSR,
             port->base + GPIO_DR, NULL,
             port->base + GPIO_GDIR, NULL,
             BGPIOF_READ_OUTPUT_REG_SET);
这里的参数    
port->base + GPIO_PSR,
port->base + GPIO_DR, 
port->base + GPIO_GDIR, 
就是寄存器地址
设置完结构体之后，这个结构体里面有寄存器值也有操作函数。

在这个bgpio_init函数里面主要调用了下面三个函数

bgpio_setup_io(gc, dat, set, clr, flags);
bgpio_setup_accessors(dev, gc, flags & BGPIOF_BIG_ENDIAN,
                    flags & BGPIOF_BIG_ENDIAN_BYTE_ORDER);
bgpio_setup_direction(gc, dirout, dirin, flags);

然后这三个函数里面就是gpio的各种操作函数。然后调用了err = devm_gpiochip_add_data(&pdev->dev, &port->gc, port);函数，这个函数里面是分配了gpio_device结构体，然后gpio_device结构体里面的chip成员就是前面分配设置的gpio_chip结构体。

4 gpio子系统的重要数据结构

我们前面说过，我们要分配设置注册一个gpio_chip结构体，然后我们用gpiochip_add_data(chip, data);函数注册了一个gpio_device结构体，然后这个gpio_device结构体里面就包含gpio_chip结构体，然后这个gpio_device结构体里面除了chip成员外，还有descs成员，这个是用来表示引脚的，每一个引脚都有一个descs结构体，然后descs结构体里面有一个gdev成员，我们可以根据这个gdev成员找到这个引脚属于哪一个gpio控制器。

5 gpio子系统函数调用的详细细节

上图是gpio子系统的函数调用具体细节，我们一个gpio控制器就对应一个gpio_device结构体，然后这个结构体里面有

• base成员，base成员是这个gpio控制器里面引脚的起始标号，
• ngpio是引脚的个数，
• descs成员是一个结构体数组，里面每一项都是一个gpio_desc结构体，都表示一个引脚。

然后加入我们设备树里面有一个

myled{
        compatible = "cumtchw"
        led-gpios = <&gpio1  10  GPIO_ACTIVE_LOW>        
};

那么当我们调用led_gpio = gpiod_get(&pdev->dev, "led", 0);函数时，那么就是根据led-gpios = <&gpio1 10 GPIO_ACTIVE_LOW> 可以得到是gpio1控制器里面的第10项，那么led_gpio就指向descs数组里面的第10项，然后我们这个desc其实就可找到这个引脚对应的控制器，然后那么当我们用gpiod_set_value(led_gpio, status);这个函数去设置引脚的时候就会找到控制器里面的chip->set(chip, gpio_chip_hwgpio(desc), value);然后这个函数的第二个参数是指设置这个控制器的第几个引脚，这里的第二个参数是这么得到的

static int __maybe_unused gpio_chip_hwgpio(const struct gpio_desc *desc)
{
    return desc - &desc->gdev->descs[0];
}  这里就是10

6 GPIO子系统的sysfs接口

驱动程序为`drivers\gpio\gpiolib-sysfs.c`，

6.1有哪些gpio控制器

/sys/bus/gpio/devices`目录下，列出了所有的GPIO控制器：

6.2每个gpio控制器的详细信息

 /sys/class/gpio/gpiochipXXX`下，有这些信息：

 base     // 这个GPIO控制器的GPIO编号
device
label    // 名字
ngpio    // 引脚个数
power
subsystem
uevent

6.3查看gpio使用情况

 cat /sys/kernel/debug/gpio

6.4通过SYSFS使用GPIO

如果只是简单的引脚控制(比如输出、查询输入值)，可以不编写驱动程序。

但是涉及中断的话，就需要编写驱动程序了。

6.4.1 确定GPIO编号

查看每个`/sys/class/gpio/gpiochipXXX`目录下的label，确定是你要用的GPIO控制器，也称为GPIO Bank。

这里的20a8000就是gpio控制器的寄存器地址，然后可以去设备树中搜索是哪一个gpio控制器的地址，

			gpio4: gpio@020a8000 {
				compatible = "fsl,imx6q-gpio", "fsl,imx35-gpio";
				reg = <0x020a8000 0x4000>;
				interrupts = <0 72 IRQ_TYPE_LEVEL_HIGH>,
					     <0 73 IRQ_TYPE_LEVEL_HIGH>;
				gpio-controller;
				#gpio-cells = <2>;
				interrupt-controller;
				#interrupt-cells = <2>;
			};

根据它名字gpiochipXXX，就可以知道基值是XXX。那么96就对应gpio4里的pin0，

基值加上引脚offset，就是这个引脚的编号。那么如果gpio4里面的20就是96+20=116.

6.4.2 导出、设置方向、读写值

echo 509 > /sys/class/gpio/export
echo out > /sys/class/gpio/gpio509/direction
echo 1 > /sys/class/gpio/gpio509/value
echo 509 > /sys/class/gpio/unexport

echo 509 > /sys/class/gpio/export
echo in > /sys/class/gpio/gpio509/direction
cat /sys/class/gpio/gpio509/value
echo 509 > /sys/class/gpio/unexport

7 费曼学习法：于是我录制了一个讲解gpio子系统的学习视频

10分钟讲解Linux内核中的GPIO子系统驱动框架_哔哩哔哩_bilibili

8 基于pinctrl子系统和gpio子系统的LED驱动程序

8.1 查看原理图确定引脚

通过原理图可以看到，LED是连接到了GPIO5_3上面，并且引脚输出低电平时，LED点亮。

8.2 修改设备树文件

8.2.1 设备树中增加pinctrl信息

这里使用imx6ull提供的Pins_Tool_for_i.MX_Processors_v6_x64.exe工具配置引脚，生成pinctrl节点信息。安装Pins_Tool_for_i.MX_Processors_v6_x64.exe然后打开IMX6ULL的配置文件“MCIMX6Y2xxx08.mex”，然后在里面找到gpio5_3，然后工具就会自动给我们生成配置信息。

            fsl,pins = <
                MX6ULL_PAD_SNVS_TAMPER3__GPIO5_IO03        0x000110A0
            >;

把这个配置信息放到设备树文件中，

        pinctrl_leds: ledgrp {
            fsl,pins = <
                  MX6ULL_PAD_SNVS_TAMPER3__GPIO5_IO03        0x000110A0
            >;
        };

8.2.2 设备中增加led节点信息

    myled {
        compatible = "cumtchw,leddrv";
        pinctrl-names = "default";
        pinctrl-0 = <&pinctrl_leds>;
        led-gpios = <&gpio5 3 GPIO_ACTIVE_LOW>;
    };

在设备树的根节点下添加上面的节点信息，其中cumtchw是我的名字。

8.3 编写代码

8.3.1驱动程序leddrv.c

#include <linux/module.h>
#include <linux/platform_device.h>
 
#include <linux/fs.h>
#include <linux/errno.h>
#include <linux/miscdevice.h>
#include <linux/kernel.h>
#include <linux/major.h>
#include <linux/mutex.h>
#include <linux/proc_fs.h>
#include <linux/seq_file.h>
#include <linux/stat.h>
#include <linux/init.h>
#include <linux/device.h>
#include <linux/tty.h>
#include <linux/kmod.h>
#include <linux/gfp.h>
#include <linux/gpio/consumer.h>
#include <linux/of.h>
 
 
/* 1. 确定主设备号                                                                 */
static int major = 0;
static struct class *led_class;
static struct gpio_desc *led_gpio;
 
 
/* 3. 实现对应的open/read/write等函数，填入file_operations结构体                   */
static ssize_t led_drv_read (struct file *file, char __user *buf, size_t size, loff_t *offset)
{
	printk("%s %s line %d\n", __FILE__, __FUNCTION__, __LINE__);
	return 0;
}
 
/* write(fd, &val, 1); */
static ssize_t led_drv_write (struct file *file, const char __user *buf, size_t size, loff_t *offset)
{
	int err;
	char status;
	
	printk("%s %s line %d\n", __FILE__, __FUNCTION__, __LINE__);
	err = copy_from_user(&status, buf, 1);
 
	/* 根据次设备号和status控制LED */
	gpiod_set_value(led_gpio, status);
	
	return 1;
}
 
static int led_drv_open (struct inode *node, struct file *file)
{	
	printk("%s %s line %d\n", __FILE__, __FUNCTION__, __LINE__);
	/* 根据次设备号初始化LED */
	gpiod_direction_output(led_gpio, 0);
	
	return 0;
}
 
static int led_drv_close (struct inode *node, struct file *file)
{
	printk("%s %s line %d\n", __FILE__, __FUNCTION__, __LINE__);
	return 0;
}
 
/* 定义自己的file_operations结构体                                              */
static struct file_operations led_drv = {
	.owner	 = THIS_MODULE,
	.open    = led_drv_open,
	.read    = led_drv_read,
	.write   = led_drv_write,
	.release = led_drv_close,
};
 
/* 4. 从platform_device获得GPIO
 *    把file_operations结构体告诉内核：注册驱动程序
 */
static int chip_demo_gpio_probe(struct platform_device *pdev)
{
	printk("%s %s line %d\n", __FILE__, __FUNCTION__, __LINE__);
 
	/* 4.1 设备树中定义有: led-gpios=<...>;	*/
    led_gpio = gpiod_get(&pdev->dev, "led", 0);
	if (IS_ERR(led_gpio)) {
		dev_err(&pdev->dev, "Failed to get GPIO for led\n");
		return PTR_ERR(led_gpio);
	}
    
	/* 4.2 注册file_operations 	*/
	major = register_chrdev(0, "cumtchw_led", &led_drv);  /* /dev/led */
 
	led_class = class_create(THIS_MODULE, "cumtchw_led_class");
	if (IS_ERR(led_class)) {
		printk("%s %s line %d\n", __FILE__, __FUNCTION__, __LINE__);
		unregister_chrdev(major, "led");
		gpiod_put(led_gpio);
		return PTR_ERR(led_class);
	}
 
	device_create(led_class, NULL, MKDEV(major, 0), NULL, "cumtchw_led%d", 0); /* /dev/cumtchw_led0 */
        
    return 0;
    
}
 
static int chip_demo_gpio_remove(struct platform_device *pdev)
{
	device_destroy(led_class, MKDEV(major, 0));
	class_destroy(led_class);
	unregister_chrdev(major, "cumtchw_led");
	gpiod_put(led_gpio);
    
    return 0;
}
 
 
static const struct of_device_id ask100_leds[] = {
    { .compatible = "cumtchw,leddrv" },
    { },
};
 
/* 1. 定义platform_driver */
static struct platform_driver chip_demo_gpio_driver = {
    .probe      = chip_demo_gpio_probe,
    .remove     = chip_demo_gpio_remove,
    .driver     = {
        .name   = "cumtchw_led",
        .of_match_table = ask100_leds,
    },
};
 
/* 2. 在入口函数注册platform_driver */
static int __init led_init(void)
{
    int err;
    
	printk("%s %s line %d\n", __FILE__, __FUNCTION__, __LINE__);
	
    err = platform_driver_register(&chip_demo_gpio_driver); 
	
	return err;
}
 
/* 3. 有入口函数就应该有出口函数：卸载驱动程序时，就会去调用这个出口函数
 *     卸载platform_driver
 */
static void __exit led_exit(void)
{
	printk("%s %s line %d\n", __FILE__, __FUNCTION__, __LINE__);
 
    platform_driver_unregister(&chip_demo_gpio_driver);
}
 
 
/* 7. 其他完善：提供设备信息，自动创建设备节点                                     */
 
module_init(led_init);
module_exit(led_exit);
 
MODULE_LICENSE("GPL");
 
 

8.3.2 测试程序ledtest.c

 
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <unistd.h>
#include <stdio.h>
#include <string.h>
 
/*
 * ./ledtest /dev/100ask_led0 on
 * ./ledtest /dev/100ask_led0 off
 */
int main(int argc, char **argv)
{
	int fd;
	char status;
	
	/* 1. 判断参数 */
	if (argc != 3) 
	{
		printf("Usage: %s <dev> <on | off>\n", argv[0]);
		return -1;
	}
 
	/* 2. 打开文件 */
	fd = open(argv[1], O_RDWR);
	if (fd == -1)
	{
		printf("can not open file %s\n", argv[1]);
		return -1;
	}
 
	/* 3. 写文件 */
	if (0 == strcmp(argv[2], "on"))
	{
		status = 1;
		write(fd, &status, 1);
	}
	else
	{
		status = 0;
		write(fd, &status, 1);
	}
	
	close(fd);
	
	return 0;
}
 
 

8.3.3 Makefile

 
# 1. 使用不同的开发板内核时, 一定要修改KERN_DIR
# 2. KERN_DIR中的内核要事先配置、编译, 为了能编译内核, 要先设置下列环境变量:
# 2.1 ARCH,          比如: export ARCH=arm64
# 2.2 CROSS_COMPILE, 比如: export CROSS_COMPILE=aarch64-linux-gnu-
# 2.3 PATH,          比如: export PATH=$PATH:/home/book/100ask_roc-rk3399-pc/ToolChain-6.3.1/gcc-linaro-6.3.1-2017.05-x86_64_aarch64-linux-gnu/bin 
# 注意: 不同的开发板不同的编译器上述3个环境变量不一定相同,
#       请参考各开发板的高级用户使用手册
 
KERN_DIR = /data/chw/imx6ull_20230512/bsp/100ask_imx6ull-sdk/Linux-4.9.88 # 板子所用内核源码的目录
 
all:
	make -C $(KERN_DIR) M=`pwd` modules 
	$(CROSS_COMPILE)gcc -o ledtest ledtest.c 
 
clean:
	make -C $(KERN_DIR) M=`pwd` modules clean
	rm -rf modules.order
	rm -f ledtest
 
# 参考内核源码drivers/char/ipmi/Makefile
# 要想把a.c, b.c编译成ab.ko, 可以这样指定:
# ab-y := a.o b.o
# obj-m += ab.o
 
 
 
obj-m += leddrv.o
 

8.4 实验

8.4.1 编译设备树文件

到内核目录下执行 

make dtbs

8.4.2 编译驱动和测试程序

make all

8.4.3 替换设备树、驱动以及测试程序

cp arch/arm/boot/dts/100ask_imx6ull-14x14.dtb /data/chw/imx6ull_20230512/nfs_rootfs/
cp leddrv.ko  ledtest /data/chw/imx6ull_20230512/nfs_rootfs/

然后替换dtb文件

注意在cp之后，要执行sync命令，要不然后面会出错，

sync命令在Linux系统中用于将数据从内存缓冲区同步到硬盘。当你执行cp /mnt/100ask_imx6ull-14x14.dtb /boot命令时，系统会先将数据复制到内存缓冲区，然后在适当的时候再将数据写入硬盘。这是因为直接写入硬盘的速度比内存慢得多，使用内存缓冲区可以提高系统的效率。

但是，如果在数据还没有被写入硬盘的时候系统突然断电或者崩溃，那么这些数据就会丢失。为了防止这种情况，你可以在复制文件后立即执行sync命令。这样，sync命令会强制系统立即将所有待写入的数据从内存缓冲区写入硬盘，确保数据的安全。

所以，在执行cp /mnt/100ask_imx6ull-14x14.dtb /boot命令之后执行sync命令，是为了确保设备树文件已经被安全地写入到/boot目录。

 然后重启开发板，使用的就是新的设备树文件了。

 然后挂载驱动就可以看到设备节点了