从零点亮 RK3568 的 LED：设备树，平台总线，现代gpio子系统全解析（附完整代码）

我的《Linux驱动开发》专栏基本已经把字符设备相关的内容讲的差不多了下面是时候上点硬件来点小小的视觉冲击了。本文虽然只是控制一个小小的 LED但是代码是完整的包含了字符设备设备树节点添加平台总线Linux 的总线-设备-驱动模型以及现代 gpio 子系统这是驱动开发的一整个框架今天的 LED 你学会了明天随便拿个传感器来代码框架不变实际要改的只是驱动程序的具体逻辑今天的平台总线学会了再换个 I2C 总线SPI 总线来来回回还是那些个操作只是 API 换了而已进行过实际操作的读者应该是深有体会的。0. 前言如果你和我一样学习过单片机然后是从学习openreadwrite的字符设备驱动开始接触到 Linux 内核那么你对下面的场景应该不陌生为了点亮一个 LED我们需要翻阅芯片手册找到控制 GPIO 的寄存器物理地址然后把它硬编码到驱动程序中最后使用ioremap重映射之后通过操作寄存器点灯。这种开发方式简单直接对于入门学习来说非常有效代码也很简便就是查手册有点烦。但是对于我手中的鲁班猫 2开发板其搭载着 RK3568 这颗复杂的 SoC 如果还采用这种方式就会有一个巨大的问题这颗芯片有数百个引脚功能复用极其复杂。如果每个驱动都像上面那样硬编码物理地址那么 Linux 内核如何维护这样一个混乱的代码库如果我的 LED 换了一个引脚难道唯一的办法就是修改驱动源码中的物理地址然后重新编译内核模块吗显然这是不可行的。Linux 内核为我们提供了一套软硬件解耦可移植的解决方案。本文将完整记录我如何在鲁班猫 2 上从零开始利用设备树、平台总线以及现代化的GPIO子系统实现一个功能完整的 LED 驱动。我们不会再触碰任何一个物理地址而是学习如何用设备树来描述硬件让平台总线自动为我们的硬件匹配驱动通过gpiod接口操作硬件引脚。本文最终达成的效果编写出完成的驱动程序实现 LED 亮灭状态转换的逻辑。在用户层编写测试程序通过系统调用打开并操作字符设备节点文件从而控制 LED 的状态。1. 核心概念解析1.1 设备树第一次接触到.dts文件时我被它那既像 C 语言又像 JSON 的语法搞得有些迷茫但是后来理解了它的核心目的之后一切都变得豁然开朗起来设备树就是一份用文本描述的硬件信息档案它可以告诉内核硬件的信息。设备树将硬件描述从 C 代码中抽取出来形成独立的.dts文件这样驱动代码本身就变得非常纯粹只关心逻辑相关的内容而不需要关心除此之外的部分。在编写设备树节点之前我们还有两件事情需要做第一是在你使用的板子上找一个你喜欢的引脚把 LED 接上去如下是我使用的鲁班猫 2 的引脚分布图图中我用蓝色的笔圈出来两个引脚我把 LED 正极接到GPIO0_B0上把负极接到GND上。接好之后的情况如下第二件事是看一下你的板子在启动阶段加载的是哪个设备树文件进入到板子的/boot目录下如下图在/boot目录下你可以找到一个以.dtb为后缀的软链接它指向的就是板子启动时会加载的设备树文件我们要做的是等会添加好设备树节点把它编译好生成.dtb文件然后用这个新的文件覆盖掉板子上旧的文件再重启板子到时候我们可以验证一下成功了没。现在我们已经知道了要修改的设备树文件是rk3568-lubancat-2-v3.dts可以在下载并编译好的的 SDK 中找到位置为/kernel/arch/arm64/boot/dts/rockchip/rk3568-lubancat-2-v3.dts然后在该文件的根节点/下添加下面节点myled_device{ compatible lubancat,myled; status okay; led-gpios gpio0 RK_PB0 GPIO_ACTIVE_HIGH; };myled_device是节点名称他声明了一个名为myled_device的设备。compatible是用来与驱动程序匹配的后面我们编写的驱动程序也会有一个这个字段并且内容完全相同保证设备和驱动能够匹配上。led-gpios描述了设备占用的gpio资源可以与上面的引脚图对比一下这正是描述了我们接了LED的那个引脚RK_PB0是头文件中定义好的宏直接用就可以。GPIO_ACTIVE_HIGH是引脚的电气特性表示高电平有效如果我的LED是低电平点亮的我只需要把这里改成GPIO_ACTIVE_LOW驱动代码完全不需要改动这就是设备树的强大之处。添加好节点之后我们在 SDK 的kernel目录下进行编译相关命令和编译结果如下到这儿设备树就编译成功了。下面我们把它拷贝到板子上在覆盖掉原先的dtb文件这样他就会覆盖掉原文件了。然后我们重启板子查看我们的设备树是否加载成功了使用下面命令ls-lh/proc/device-tree/myled_devicemyled_device是我们在设备树文件中添加的节点名称可以看到已经被成功加载了。1.2 平台总线平台总线是 Linux 内核中一种虚拟的、不存在的总线。它的唯一使命就是匹配设备和驱动。1.2.1 核心角色在平台总线中有两个核心的角色platform_device: 当内核启动并解析设备树时它一旦发现我们写的myled_device节点就会在内存中创建一个struct platform_device结构体来代表它。这个结构体里打包了从设备树节点中读取到的所有信息其中最重要的就是那个compatible lubancat,myled属性。然后内核将这个platform_device注册到平台总线上静待匹配。platform_driver: 这就是我们用 C 语言编写的驱动程序。我们需要定义一个struct platform_driver结构体并填充其中的关键信息然后通过module_platform_driver宏将它注册到内核。1.2.2 compatible介绍平台总线是如何判断两者是否匹配呢答案就在我们驱动代码里的一个关键数据结构of_device_id。下面是我们驱动程序的一部分staticconststructof_device_idmyled_of_match[]{{.compatiblelubancat,myled,},//看这里{}};MODULE_DEVICE_TABLE(of,myled_of_match);//告知内核//定义平台驱动结构体staticstructplatform_drivermyled_driver{.probemyled_probe,.removemyled_remove,.driver{.namemyled_driver,.of_match_tablemyled_of_match,//看这里},};整个流程如下当我insmod myled_drv.ko时myled_driver就被注册到了平台总线上。总线发现一个新的driver来了就查看它的.of_match_table知道了它想找compatible为lubancat,myled的设备。总线随即在已经注册的device列表中进行查找发现之前由设备树生成的myled_device的compatible属性正好也是lubancat,myled。匹配成功。1.2.3 probe函数一旦匹配成功平台总线会立刻调用我们驱动程序里指定的.probe函数也就是myled_probe。probe函数是整个驱动逻辑的真正入口。内核会把匹配到的platform_device作为参数传递给它。这意味着在probe函数里我们终于可以将硬件描述和软件逻辑结合起来了。所有初始化的工作比如申请GPIO资源、创建/dev/myled设备节点等等都在这里完成。与之对应当我们rmmod卸载驱动时.remove函数会被调用用于释放在probe中申请的资源资源。1.3 gpio子系统我们的驱动程序拿到了代表硬件的platform_device结构体下一步就是去真正地获取并操作硬件资源——那个在设备树里定义的GPIO0_B0引脚。在过去我们可能会使用一套叫做gpio_request和gpio_set_value的老旧接口。但现在内核开发者强烈推荐使用一套更现代化、更安全、更抽象的接口这就是GPIO Descriptor Subsystem简称为gpiod。1.3.1 为什么不用老的接口老接口通过一个全局的GPIO编号来操作引脚。这样任何驱动都可以尝试申请任意一个编号的GPIO容易产生冲突。此外看到代码里的gpio_set_value(122, 1)你完全不知道这个122号引脚是干嘛的高电平是亮还是灭这样对于代码的维护也不利。而新的接口不使用全局编号而是通过描述符来操作引脚获取GPIO的过程就像通过open获取文件描述符的过程一样。驱动只能向内核申请属于自己的GPIO而这些信息在设备树里已经绑定好了无法越权访问。并且它能自动处理高低电平有效的问题。在设备树里定义了GPIO_ACTIVE_HIGH那么调用gpiod_set_value(desc, 1)就代表点亮。如果设备树改成GPIO_ACTIVE_LOW同样的代码gpiod_set_value(desc, 1)就会自动输出低电平。实现代码逻辑与物理电平彻底解耦。1.3.2 驱动程序中的实现下面看看我的myled_probe函数中是如何获取GPIO资源的staticintmyled_probe(structplatform_device*pdev){structdevice*devpdev-dev;//其他代码//从设备树获取 GPIO,GPIOD_OUT_LOW 表示获取一个输出引脚并设置初始值为低电平my_led.led_gpiodevm_gpiod_get(dev,led,GPIOD_OUT_LOW);if(IS_ERR(my_led.led_gpio)){printk(KERN_INFOmyled: Get gpio failed!\n);returnPTR_ERR(my_led.led_gpio);}//申请字符设备号、创建设备节点等return0;}核心代码就是devm_gpiod_get(dev, led, GPIOD_OUT_LOW)。dev是指向当前设备的指针明确了谁在申请资源。led是暗号内核会自动去我们这个设备对应的设备树节点里查找名为led-gpios的属性。如果设备树中属性名是enable-gpios那这里的字符串就得是enable。GPIOD_OUT_LOW: 这是申请的标志OUT表示我需要一个输出引脚LOW表示我希望它的初始状态是低电平。1.3.3 操作led的逻辑一旦devm_gpiod_get成功返回my_led.led_gpio里就保存了这个描述符。之后在myled_write函数里操作LED就变得极其简单和直观部分代码如下staticssize_tmyled_write(structfile*file,constchar__user*buf,...){/* ... */if(kbuf[0]1){//亮gpiod_set_value(my_led.led_gpio,1);}elseif(kbuf[0]0){//灭gpiod_set_value(my_led.led_gpio,0);}/* ... */}代码里完全没有高低电平的概念语义非常清晰。2. 字符设备的基础支撑虽然我们花了大量篇幅来学习设备树、平台总线和gpiod但驱动的最终目的是为用户空间程序服务的。而这个服务的窗口依然是我们所熟悉的字符设备。但是不同的是字符设备的注册和初始化不在以前的module_init中了而是在设备与驱动匹配成功后立即执行的probe函数里面。同样在remove函数中我们需要按照相反的顺序依次执行device_destroy、class_destroy、cdev_del和unregister_chrdev_region完成资源的彻底清理。这样看起来平台驱动模型并没有颠覆字符设备框架而是将它作为自己的一部分包容了进来。probe负责初始化remove负责收拾烂摊子分工明确结构清晰。3. 完整代码3.1 驱动程序代码#includelinux/module.h#includelinux/gpio/consumer.h#includelinux/platform_device.h#includelinux/of.h#includelinux/cdev.h#includelinux/device.h#includelinux/uaccess.h#includelinux/fs.h#defineDEVICE_NAMEmyled#defineCLASS_NAMEmyled_class//自定义结构体structmyled_dev{dev_tdev_num;structcdevcdev;structclass*class;structdevice*device;structgpio_desc*led_gpio;};staticstructmyled_devmy_led;staticintmyled_open(structinode*inode,structfile*file){printk(KERN_INFOmyled: Open success!\n);return0;}staticintmyled_release(structinode*inode,structfile*file){printk(KERN_INFOmyled: Release success!\n);return0;}//读取LED当前状态staticssize_tmyled_read(structfile*file,char__user*buf,size_tcount,loff_t*offset){charkbuf[2];intstate;if(*offset0)return0;//也就是说偏移量只能是0stategpiod_get_value(my_led.led_gpio);kbuf[0]state?1:0;kbuf[1]\0;if(copy_to_user(buf,kbuf,1)){return-EFAULT;}*offset1;return1;}//控制LED状态staticssize_tmyled_write(structfile*file,constchar__user*buf,size_tcount,loff_t*offset){charkbuf[2];if(countsizeof(kbuf)-1){countsizeof(kbuf)-1;}if(copy_from_user(kbuf,buf,count)){return-EFAULT;}if(kbuf[0]1){gpiod_set_value(my_led.led_gpio,1);}elseif(kbuf[0]0){gpiod_set_value(my_led.led_gpio,0);}elseif(kbuf[0]x){intstategpiod_get_value(my_led.led_gpio);gpiod_set_value(my_led.led_gpio,!state);}returncount;}staticstructfile_operationsmyled_fops{.ownerTHIS_MODULE,.openmyled_open,.releasemyled_release,.readmyled_read,.writemyled_write,.llseekdefault_llseek,};//设备树匹配成功后执行probe函数staticintmyled_probe(structplatform_device*pdev){intret;structdevice*devpdev-dev;printk(KERN_INFOmyled: device tree matched!\n);//这里第二个参数传led内核会自动去设备树找led-gpios属性my_led.led_gpiodevm_gpiod_get(dev,led,GPIOD_OUT_LOW);if(IS_ERR(my_led.led_gpio)){retPTR_ERR(my_led.led_gpio);printk(KERN_INFOmyled: Get gpio failed!\n);returnret;}retalloc_chrdev_region(my_led.dev_num,0,1,DEVICE_NAME);if(ret0){printk(KERN_INFOmyled: Failed to alloc!\n);returnret;}cdev_init(my_led.cdev,myled_fops);my_led.cdev.ownerTHIS_MODULE;retcdev_add(my_led.cdev,my_led.dev_num,1);if(ret0){printk(KERN_INFOmyled: cdev add failed!\n);gotoerr_add;}my_led.classclass_create(THIS_MODULE,CLASS_NAME);if(IS_ERR(my_led.class)){retPTR_ERR(my_led.class);printk(KERN_INFOmyled: Class create failed!\n);gotoerr_class;}my_led.devicedevice_create(my_led.class,NULL,my_led.dev_num,NULL,DEVICE_NAME);if(IS_ERR(my_led.device)){retPTR_ERR(my_led.device);printk(KERN_INFOmyled: Device create failed!\n);gotoerr_device;}printk(KERN_INFOmyled: Init success!\n);return0;err_device:class_destroy(my_led.class);err_class:cdev_del(my_led.cdev);err_add:unregister_chrdev_region(my_led.dev_num,1);returnret;}//设备卸载时执行staticintmyled_remove(structplatform_device*pdev){gpiod_set_value(my_led.led_gpio,0);//退出之前先关灯device_destroy(my_led.class,my_led.dev_num);class_destroy(my_led.class);cdev_del(my_led.cdev);unregister_chrdev_region(my_led.dev_num,1);printk(KERN_INFOmyled: Resource freed!\n);return0;}staticconststructof_device_idmyled_of_match[]{{.compatiblelubancat,myled,},{}};MODULE_DEVICE_TABLE(of,myled_of_match);staticstructplatform_drivermyled_driver{.probemyled_probe,.removemyled_remove,.driver{.namemyled_driver,//驱动名称在/sys/bus/platform/drivers下显示.of_match_tablemyled_of_match,},};module_platform_driver(myled_driver);MODULE_LICENSE(GPL);3.2 测试程序代码#includestdio.h#includestdlib.h#includefcntl.h#includeunistd.h#includestring.h#defineDEVICE/dev/myledintmain(){intfd;charbuf[10];intchoice;fdopen(DEVICE,O_RDWR);if(fd0){perror(open);return-1;}while(1){printf(\nSelect operation:\n);printf( 1 - Turn LED ON\n);printf( 2 - Turn LED OFF\n);printf( 3 - Inverse LED\n);printf( 4 - Read LED status\n);printf( 0 - Exit\n);printf(Choice: );scanf(%d,choice);switch(choice){case1:write(fd,1,1);printf(LED ON\n);break;case2:write(fd,0,1);printf(LED OFF\n);break;case3:write(fd,x,1);printf(LED inverse\n);break;case4:lseek(fd,0,SEEK_SET);read(fd,buf,1);printf(LED status: %s\n,buf[0]1?ON:OFF);break;case0:write(fd,0,1);//关闭程序之前先关灯close(fd);printf(END!\n);return0;default:printf(Invalid choice\n);}}return0;}4. 实战演示加载模块之后内核日志如下表面已经完成了字符设备注册获取gpio等操作这时我们可以运行应用程序了然后我们可以输入对应的数字LED 就会变成相应的状态我们一一测试经过测试LED 状态和预期完全一样。最后输入 0 时程序会直接退出LED也会熄灭最后卸载模块整个流程的内核日志如下完成资源释放。现在你已经成功通关了现代LED驱动这个副本你完全有能力为一些简单的传感器编写驱动程序。是不是感觉收获满满但又有点意犹未尽如果可以的话随手点个**【收藏】**下次忘记代码框架的时候还能瞬间找到。再随手点个**【关注】** 后续还有中断处理、I2C 通信等内容。来吧我们一起加油向内核深处进发。