1）实验平台：正点原子ATK-DLRK3568开发板
2）平台购买地址：https://detail.tmall.com/item.htm?id=731866264428
3）全套实验源码+手册+视频下载地址： http://www.openedv.com/docs/boards/xiaoxitongban
第二十章 Linux自带的LED灯驱动实验
前面我们都是自己编写LED灯驱动，其实像LED灯这样非常基础的设备驱动，Linux内核已经集成了。Linux内核的LED灯驱动采用platform框架，因此我们只需要按照要求在设备树文件中添加相应的LED节点即可，本章我们就来学习如何使用Linux内核自带的LED驱动来驱动正点原子的RK3568开发板上的LED这个LED灯。
20.1 Linux内核自带LED驱动使能
上一章节我们编写基于设备树的platform LED灯驱动，其实Linux内核已经自带了LED灯驱动，要使用Linux内核自带的LED灯驱动首先得先配置Linux内核，使能自带的LED灯驱动，输入如下命令打开Linux配置菜单：
make ARCH=arm64 menuconfig
按照如下路径打开LED驱动配置项：
Device Drivers
LED Support
LED Support for GPIO connected LEDs
按照上述路径，选择“LED Support for GPIO connected LEDs”，将其编译进Linux内核，也即是在此选项上按下“Y”键，使此选项前面变为“<*>”，如图20.1.1所示：
图20.1.1 使能LED灯驱动
在“LED Support for GPIO connected LEDs”上按下“?”健可以打开此选项的帮助信息，如图20.1.2所示：
图20.1.2 内部LED灯驱动帮助信息
从图20.1.2可以看出，把Linux内部自带的LED灯驱动编译进内核以后，CONFIG_LEDS_GPIO就会等于‘y’，Linux会根据CONFIG_LEDS_GPIO的值来选择如何编译LED灯驱动，如果为‘y’就将其编译进Linux内核。
配置好Linux内核以后退出配置界面，打开.config文件，会找到“CONFIG_LEDS_GPIO=y”这一行，如图20.1.3所示：
图20.1.3 .config文件内容
正点原子RK3568开发板SDK里面的linux内核默认已经使能了此驱动。
20.2 Linux内核自带LED驱动简介
20.2.1 LED灯驱动框架分析
LED灯驱动文件为/drivers/leds/leds-gpio.c，大家可以打开/drivers/leds/Makefile这个文件，找到如下所示内容：
示例代码20.2.1.1 /drivers/leds/Makefile文件代码段
1 # SPDX-License-Identifier: GPL-2.0
2
3 # LED Core
4 obj-$(CONFIG_NEW_LEDS) += led-core.o
......
29 obj-$(CONFIG_LEDS_PCA9532) += leds-pca9532.o
30 obj-$(CONFIG_LEDS_GPIO_REGISTER) += leds-gpio-register.o
31 obj-$(CONFIG_LEDS_GPIO) += leds-gpio.o
32 obj-$(CONFIG_LEDS_LP3944) += leds-lp3944.o
......
第31行，如果定义了CONFIG_LEDS_GPIO的话就会编译leds-gpio.c这个文件，在上一小节我们选择将LED驱动编译进Linux内核，在.config文件中就会有“CONFIG_LEDS_GPIO=y”这一行，因此leds-gpio.c驱动文件就会被编译。
接下来我们看一下leds-gpio.c这个驱动文件，找到如下所示内容：
示例代码20.2.1.2 leds-gpio.c文件代码段
215 static const struct of_device_id of_gpio_leds_match[] = {
216 { .compatible = "gpio-leds", },
217 {},
218 };
219
220 MODULE_DEVICE_TABLE(of, of_gpio_leds_match);
......
267 static struct platform_driver gpio_led_driver = {
268 .probe = gpio_led_probe,
269 .shutdown = gpio_led_shutdown,
270 .driver = {
271 .name = "leds-gpio",
272 .of_match_table = of_gpio_leds_match,
273 },
274 };
275
276 module_platform_driver(gpio_led_driver);
第215~228行，LED驱动的匹配表，此表只有一个匹配项，compatible内容为“gpio-leds”，因此设备树中的LED灯设备节点的compatible属性值也要为“gpio-leds”，否则设备和驱动匹配不成功，驱动就没法工作。
第267~274行，platform_driver驱动结构体变量，可以看出，Linux内核自带的LED驱动采用了platform框架。第268行可以看出probe函数为gpio_led_probe，因此当驱动和设备匹配成功以后gpio_led_probe函数就会执行。从271行可以看出，驱动名字为“leds-gpio”，因此会在/sys/bus/platform/drivers目录下存在一个名为“leds-gpio”的文件，如图20.2.1.1所示：
图20.2.1.1 leds-gpio驱动文件
第276行通过module_platform_driver函数向Linux内核注册gpio_led_driver这个platform驱动。
20.2.2 module_platform_driver函数简析
在上一小节中我们知道LED驱动会采用module_platform_driver函数向Linux内核注册platform驱动，其实在Linux内核中会大量采用module_platform_driver来完成向Linux内核注册platform驱动的操作。module_platform_driver定义在include/linux/platform_device.h文件中，为一个宏，定义如下：
示例代码20.2.2.1 module_platform_driver函数
1 #define module_platform_driver(__platform_driver) \
2 module_driver(__platform_driver, platform_driver_register, \
3 platform_driver_unregister)
可以看出，module_platform_driver依赖module_driver，module_driver也是一个宏，定义在include/linux/device.h文件中，内容如下：
示例代码20.2.2.2 module_driver函数
1 #define module_driver(__driver, __register, __unregister, ...) \
2 static int __init __driver##_init(void) \
3 { \
4 return __register(&(__driver) , ##__VA_ARGS__); \
5 } \
6 module_init(__driver##_init); \
7 static void __exit __driver##_exit(void) \
8 { \
9 __unregister(&(__driver) , ##__VA_ARGS__); \
10 } \
11 module_exit(__driver##_exit);
借助示例代码20.2.2.1和示例代码20.2.2.2，将：
module_platform_driver(gpio_led_driver)
展开以后就是：
static int __init gpio_led_driver_init(void)
{
return platform_driver_register (&(gpio_led_driver));
}
module_init(gpio_led_driver_init);
static void __exit gpio_led_driver_exit(void)
{
platform_driver_unregister (&(gpio_led_driver) );
}
module_exit(gpio_led_driver_exit);
上面的代码不就是标准的注册和删除platform驱动吗？因此module_platform_driver函数的功能就是完成platform驱动的注册和删除。
20.2.3 gpio_led_probe函数简析
当驱动和设备匹配以后gpio_led_probe函数就会执行，此函数主要是从设备树中获取LED灯的GPIO信息，缩减后的函数内容如下所示：
示例代码20.2.3.1 gpio_led_probe函数
1 static int gpio_led_probe(struct platform_device *pdev)
2 {
3 struct gpio_led_platform_data *pdata = dev_get_platdata(&pdev->dev);
4 struct gpio_leds_priv *priv;
5 int i, ret = 0;
6
7 if (pdata && pdata->num_leds) { /* 非设备树方式 */
...... /* 获取platform_device信息 */
21 }
22 } else { /* 采用设备树 */
23 priv = gpio_leds_create(pdev);
24 if (IS_ERR(priv))
25 return PTR_ERR(priv);
26 }
27
28 platform_set_drvdata(pdev, priv);
29
30 return 0;
31 }
第23~25行，如果使用设备树的话，使用gpio_leds_create函数从设备树中提取设备信息，获取到的LED灯GPIO信息保存在返回值中，gpio_leds_create函数内容如下：
示例代码20.2.3.2 gpio_leds_create函数
1 static struct gpio_leds_priv *gpio_leds_create(struct platform_device *pdev)
2 {
3 struct device *dev = &pdev->dev;
4 struct fwnode_handle *child;
5 struct gpio_leds_priv *priv;
6 int count, ret;
7
8 count = device_get_child_node_count(dev);
9 if (!count)
10 return ERR_PTR(-ENODEV);
11
12 priv = devm_kzalloc(dev, sizeof_gpio_leds_priv(count), GFP_KERNEL);
13 if (!priv)
14 return ERR_PTR(-ENOMEM);
15
16 device_for_each_child_node(dev, child) {
17 struct gpio_led_data *led_dat = &priv->leds[priv->num_leds];
18 struct gpio_led led = {};
19 const char *state = NULL;
20 struct device_node *np = to_of_node(child);
21
22 ret = fwnode_property_read_string(child, "label", &led.name);
23 if (ret && IS_ENABLED(CONFIG_OF) && np)
24 led.name = np->name;
25 if (!led.name) {
26 fwnode_handle_put(child);
27 return ERR_PTR(-EINVAL);
28 }
29
30 led.gpiod = devm_fwnode_get_gpiod_from_child(dev, NULL, child,
31 GPIOD_ASIS,
32 led.name);
33 if (IS_ERR(led.gpiod)) {
34 fwnode_handle_put(child);
35 return ERR_CAST(led.gpiod);
36 }
37
38 fwnode_property_read_string(child, "linux,default-trigger",
39 &led.default_trigger);
40
41 if (!fwnode_property_read_string(child, "default-state",
42 &state)) {
43 if (!strcmp(state, "keep"))
44 led.default_state = LEDS_GPIO_DEFSTATE_KEEP;
45 else if (!strcmp(state, "on"))
46 led.default_state = LEDS_GPIO_DEFSTATE_ON;
47 else
48 led.default_state = LEDS_GPIO_DEFSTATE_OFF;
49 }
50
51 if (fwnode_property_present(child, "retain-state-suspended"))
52 led.retain_state_suspended = 1;
53 if (fwnode_property_present(child, "retain-state-shutdown"))
54 led.retain_state_shutdown = 1;
55 if (fwnode_property_present(child, "panic-indicator"))
56 led.panic_indicator = 1;
57
58 ret = create_gpio_led(&led, led_dat, dev, np, NULL);
59 if (ret < 0) {
60 fwnode_handle_put(child);
61 return ERR_PTR(ret);
62 }
63 led_dat->cdev.dev->of_node = np;
64 priv->num_leds++;
65 }
66
67 return priv;
68 }
第8行，调用device_get_child_node_count函数统计子节点数量，一般在设备树中创建一个节点表示LED灯，然后在这个节点下面为每个LED灯创建一个子节点。因此子节点数量也是LED灯的数量。
第16行，遍历每个子节点，获取每个子节点的信息。
第30行，获取LED灯所使用的GPIO信息。
第38~39行，获取“linux,default-trigger”属性值，可以通过此属性设置某个LED灯在Linux系统中的默认功能，比如作为系统心跳指示灯等等。
第41~42行，获取“default-state”属性值，也就是LED灯的默认状态属性。
第58行，调用create_gpio_led函数创建LED相关的io，其实就是设置LED所使用的io为输出之类的。create_gpio_led函数主要是初始化led_dat这个gpio_led_data结构体类型变量，led_dat保存了LED的操作函数等内容。
关于gpio_led_probe函数就分析到这里，gpio_led_probe函数主要功能就是获取LED灯的设备信息，然后根据这些信息来初始化对应的IO，设置为输出等。
20.3 设备树节点编写
打开文档Documentation/devicetree/bindings/leds/leds-gpio.txt，此文档详细的讲解了Linux自带驱动对应的设备树节点该如何编写，我们在编写设备节点的时候要注意以下几点：
①、创建一个节点表示LED灯设备，比如dtsleds，如果板子上有多个LED灯的话每个LED灯都作为dtsleds的子节点。
②、dtsleds节点的compatible属性值一定要为“gpio-leds”。
③、设置label属性，此属性为可选，每个子节点都有一个label属性，label属性一般表示LED灯的名字，比如以颜色区分的话就是red、green等等。
④、每个子节点必须要设置gpios属性值，表示此LED所使用的GPIO引脚！
⑤、可以设置“linux,default-trigger”属性值，也就是设置LED灯的默认功能，查阅Documentation/devicetree/bindings/leds/common.txt这个文档来查看可选功能，比如：
backlight：LED灯作为背光。
default-on：LED灯打开。
heartbeat：LED灯作为心跳指示灯，可以作为系统运行提示灯。
disk-activity：LED灯作为磁盘活动指示灯。
ide-disk：LED灯作为硬盘活动指示灯。
timer：LED灯周期性闪烁，由定时器驱动，闪烁频率可以修改。
⑥、可以设置“default-state”属性值，可以设置为on、off或keep，为on的时候LED灯默认打开，为off的话LED灯默认关闭，为keep的话LED灯保持当前模式。
另外还有一些其他的可选属性，比如led-sources、color、function等属性，这些属性的用法在Documentation/devicetree/bindings/leds/common.txt里面有详细的讲解，大家自行查阅。
默认我们把RK3568开发板上的1个LED灯作为了系统运行指示灯，LED连接到GPIO0_C0引脚上。LED用作系统指示灯，名字为“work”，。打开rk3568-evb.dtsi文件，找到如下内容：
示例代码20.3.1 leds设备节点
1 leds: leds {
2 compatible = "gpio-leds";
3 work_led: work {
4 gpios = <&gpio0 RK_PC0 GPIO_ACTIVE_HIGH>;
5 linux,default-trigger = "heartbeat";
6 status = "okay";
7 };
8 };
示例代码20.3.1就是正点原子出厂系统中已经编写好的LED灯节点，节点名字为“leds”。
第3~7行是开发板上的LED，这里将LED用作了“heartbeat”，也就是心跳灯，因此大家烧写出厂系统会发现绿色的LED灯会一直闪烁。
注意，第8行的status要为“okay”，我们前面做LED灯实验的时候让大家把这个改为了“disabled”，这里一定要确保为“okay”！
20.4 运行测试
启动开发板，启动以后查看/sys/bus/platform/devices/leds这个目录是否存在，如图20.4.1所示：
图20.4.1 leds目录
进入到leds/leds目录中，此目录中的内容如图20.4.2所示：
图20.4.2 leds目录内容
从图20.4.2可以看出，在leds目录下有一个子目录，work就是LED。这个子目录的名字就是我们在示例代码20.3.1中第3行设置的label属性值。
我们的设置究竟有没有用，最终是要通过测试才能知道的，我们以work灯为例，讲解一下怎么测试。首先查看一下系统中有没有“/sys/class/leds/user-led/brightness”这个文件，通过操作这两个文件即可实现LED的打开和关闭。
注意！由于将LED，也就是绿色LED灯作为了心跳灯，因此大家使用上述命令打开和关闭会看不出来效果，必须要先禁止掉LED的心跳灯功能，输入如下命令：
echo none > /sys/class/leds/work/trigger //关闭LED的心跳灯功能
关闭心跳灯功能后就可以使用前面命令来打开和关闭LED了。
如果有的话就输入如下命令打开user-led(LED1)：
echo 1 > /sys/class/leds/work/brightness //打开绿色LED
关闭LED1的命令如下：
echo 0 > /sys/class/leds/work/brightness //关闭绿色LED
如果能正常的打开和关闭LED1灯话就说明我们Linux内核自带的LED灯驱动工作正常。
243
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
