努力自学的小夏

正点原子嵌入式linux驱动开发——Linux自带LED驱动

前面都是自己编写LED灯驱动，其实像LED灯这样非常基础的设备驱动，Linux内核已经集成了。Linux内核的LED灯驱动采用platform框架，因此只需要按照要求在设备树文件中添加相应的LED节点即可，本章就来学习如何使用Linux内核自带的LED驱动来驱动正点原子的STM32MP1开发板上的LED0和LED1这两个LED灯。

Linux内核自带LED驱动使能

在上一篇笔记的学习中编写基于设备树的platform LED灯驱动，其实Linux内核已经自带了LED灯驱动，要使用Linux内核自带的LED灯驱动首先得先配置Linux内核，使能自带的LED灯驱动，通过“make menuconfig”打开Linux配置菜单，然后按照如下路径打开配置项：

-> Device Drivers
-> LED Support (NEW_LEDS [=y])
-> LED Support for GPIO connected LEDs

按照上述路径，选择“LED Support for GPIO connected LEDs”，将其编译进Linux内核，就是在此选项上按下“Y”键，使此选项前面变为“<*>”，如下图所示：

在“LED Support for GPIO connected LEDs”上按下“?”健可以打开此选项的帮助信息，如下图所示：

从上图可以看出，把Linux内部自带的LED灯驱动编译进内核以后，CONFIG_LEDS_GPIO就会等于‘y’，Linux会根据CONFIG_LEDS_GPIO的值来选择如何编译LED灯驱动，如果为‘y’就将其编译进Linux内核。

配置好Linux内核以后退出配置界面，打开.config文件，会找到“CONFIG_LEDS_GPIO=y”这一行。

重新编译Linux内核，然后使用新编译出来的uImage镜像启动开发板。

Linux内核自带LED驱动简介

LED灯驱动框架分析

LED灯驱动文件为/drivers/leds/leds-gpio.c，可以打开/drivers/leds/Makefile这个文件，找到如下所示内容：

第33行，如果定义了CONFIG_LEDS_GPIO的话就会编译leds-gpio.c这个文件，在上一小节选择将LED驱动编译进Linux内核，在.config文件中就会有“CONFIG_LEDS_GPIO=y”这一行，因此leds-gpio.c驱动文件就会被编译。

接下来看一下leds-gpio.c这个驱动文件，找到如下所示内容：

第203-206行，LED驱动的匹配表，此表只有一个匹配项 compatible内容为“gpio-leds”，因此设备树中的LED灯设备节点的compatible属性值也要为“gpio-leds”，否则设备和驱动匹配不成功，驱动就没法工作。

第316-323行，platform_driver驱动结构体变量，可以看出，Linux内核自带的LED驱动采用了platform框架。第317行可以看出probe函数为gpio_led_probe，因此当驱动和设备匹配成功以后gpio_led_probe函数就会执行。从320行可以看出，驱动名字为“leds-gpio”，因此会在/sys/bus/platform/drivers目录下存在一个名为“leds-gpio”的文件，如下图所示：

第326行通过module_platform_driver函数向Linux内核注册gpio_led_driver这个platform驱动。

module_platform_driver函数解析

在上一小节中知道LED驱动会采用module_platform_driver函数向Linux内核注册platform驱动，其实在Linux内核中会大量采用module_platform_driver来完成向Linux内核注册platform驱动的操作。module_platform_driver定义在include/linux/platform_device.h文件中，为一个宏，定义如下：

可以看出，module_platform_driver依赖module_driver，module_driver也是一个宏，定义在include/linux/device.h文件中，内容如下：

示例代码36.2.2.2 module_driver函数 
1898 #define module_driver(__driver, __register, __unregister, ...) \ 
1899 static int __init __driver##_init(void) \ 
1900 { \ 
1901     return __register(&(__driver) , ##__VA_ARGS__); \ 
1902 } \
1903 module_init(__driver##_init); \ 
1904 static void __exit __driver##_exit(void) \ 
1905 { \ 
1906     __unregister(&(__driver) , ##__VA_ARGS__); \ 
1907 } \ 
1908 module_exit(__driver##_exit);

借助示例代码36.2.2.1和示例代码36.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驱动的注册和删除。

gpio_led_probe函数解析

当驱动和设备匹配以后gpio_led_probe函数就会执行，此函数主要是从设备树中获取LED灯的GPIO信息，缩减后的函数内容如下所示：

示例代码36.2.3.1 gpio_led_probe函数 
256 static int gpio_led_probe(struct platform_device *pdev) 
257 { 
258     struct gpio_led_platform_data *pdata = dev_get_platdata(&pdev->dev); 
259     struct gpio_leds_priv *priv; 
260     int i, ret = 0; 
261 
262     if (pdata && pdata->num_leds) { /* 非设备树方式 */ /* 获取platform_device信息 */ 
..... 
292     } else { /* 采用设备树 */ 
293         priv = gpio_leds_create(pdev); 
294         if (IS_ERR(priv)) 
295             return PTR_ERR(priv); 
296     } 
297
298     platform_set_drvdata(pdev, priv); 
299 
300     return 0; 
301 }

第293-295行，如果使用设备树的话，使用gpio_leds_create函数从设备树中提取设备信息，
获取到的LED灯GPIO信息保存在返回值中，gpio_leds_create函数内容如下：

示例代码36.2.3.2 gpio_leds_create函数 
134 static struct gpio_leds_priv *gpio_leds_create(struct platform_device *pdev) 
135 { 
136     struct device *dev = &pdev->dev; 
137     struct fwnode_handle *child; 
138     struct gpio_leds_priv *priv; 
139     int count, ret; 
140 
141     count = device_get_child_node_count(dev); 
142     if (!count) 
143         return ERR_PTR(-ENODEV); 
144 
145     priv = devm_kzalloc(dev, sizeof_gpio_leds_priv(count), GFP_KERNEL); 
146 if (!priv) 
147         return ERR_PTR(-ENOMEM); 
148 
149     device_for_each_child_node(dev, child) { 
150         struct gpio_led_data *led_dat = &priv->leds[priv->num_leds]; 
151         struct gpio_led led = {}; 
152         const char *state = NULL; 
153 
154         /* 
155          * Acquire gpiod from DT with uninitialized label, which 
156          * will be updated after LED class device is registered, 
157          * Only then the final LED name is known. 
158          */ 
159         led.gpiod = devm_fwnode_get_gpiod_from_child(dev, NULL, child, 
160                              GPIOD_ASIS, 
161                              NULL); 
162         if (IS_ERR(led.gpiod)) { 
163             fwnode_handle_put(child); 
164             return ERR_CAST(led.gpiod); 
165         } 
166
167         led_dat->gpiod = led.gpiod; 
168 
169         fwnode_property_read_string(child, "linux,default-trigger", 
170                                     &led.default_trigger); 
171 
172         if (!fwnode_property_read_string(child, "default-state", 
173             &state)) { 
174             if (!strcmp(state, "keep")) 
175                 led.default_state = LEDS_GPIO_DEFSTATE_KEEP; 
176             else if (!strcmp(state, "on")) 
177                 led.default_state = LEDS_GPIO_DEFSTATE_ON; 
178             else 
179                 led.default_state = LEDS_GPIO_DEFSTATE_OFF; 
180         } 
181 
182         if (fwnode_property_present(child, "retain-state-suspended")) 
183             led.retain_state_suspended = 1; 
184         if (fwnode_property_present(child, "retain-state-shutdown")) 
185             led.retain_state_shutdown = 1; 
186         if (fwnode_property_present(child, "panic-indicator")) 
187             led.panic_indicator = 1; 
188 
189         ret = create_gpio_led(&led, led_dat, dev, child, NULL); 
190         if (ret < 0) { 
191             fwnode_handle_put(child); 
192             return ERR_PTR(ret); 
193         } 
194         /* Set gpiod label to match the corresponding LED name. */ 
195         gpiod_set_consumer_name(led_dat->gpiod, 
196                                 led_dat->cdev.dev->kobj.name); 
197         priv->num_leds++; 
198     } 
199 
200     return priv; 
201 }

第141行，调用device_get_child_node_count函数统计子节点数量，一般在设备树中创建一个节点表示LED灯，然后在这个节点下面为每个LED灯创建一个子节点。因此子节点数量也是LED灯的数量。

第149行，遍历每个子节点，获取每个子节点的信息。

第159行，获取LED灯所使用的GPIO信息。

第169-170行，获取“linux,default-trigger”属性值，可以通过此属性设置某个LED灯在Linux系统中的默认功能，比如作为系统心跳指示灯等等。

第172-173行，获取“default-state”属性值，也就是LED灯的默认状态属性。

第189行，调用create_gpio_led函数创建LED相关的io，其实就是设置LED所使用的io为输出之类的。create_gpio_led函数主要是初始化led_dat这个gpio_led_data结构体类型变量，led_dat保存了LED的操作函数等内容。

第195-196行，使用label属性作为LED的名字，led_dat->cdev.dev->kobj.name指向设备树里的LED灯节点下的label属性。

关于gpio_led_probe函数就分析到这里， gpio_led_probe函数主要功能就是获取LED灯的设备信息，然后根据这些信息来初始化对应的IO，设置为输出等。

设备树节点编写

打开文档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里面有详细的讲解，可以自行查阅。

本节实验把STM32MP1开发板上的2个 LED灯都用上，其中LED0(红色)连接到PI0引脚上，LED1(绿色)连接到PF3。首先是创建这两个LED灯对应的pinctrl节点：

示例代码36.3.1 pinctrl子节点 
1 led_pins_a: gpioled-0 { 
2         pins { 
3             pinmux = <STM32_PINMUX('I', 0, GPIO)>, /* LED0 */ 
4                      <STM32_PINMUX('F', 3, GPIO)>; /* LED1 */ 
5     drive-push-pull; 
6     bias-pull-up; 
7     output-high; 
8     slew-rate = <0>; 
9     }; 
10 };

最后，根据前面的绑定文档要求添加LED设备子节点，打开stm32mp157d-atk.dts，在根节点下添加如下所示LED灯设备子节点：

示例代码36.3.2 dtsleds设备节点 
1  dtsleds { 
2      compatible = "gpio-leds"; 
3      pinctrl-0 = <&led_pins_a>; 
4 
5      led0 { 
6          label = "red"; 
7          gpios = <&gpioi 0 GPIO_ACTIVE_LOW>; 
8          default-state = "off"; 
9      }; 
10 
11     led1 { 
12         label = "green"; 
13         gpios = <&gpiof 3 GPIO_ACTIVE_LOW>; 
14         default-state = "off"; 
15     }; 
16 };

第 3行，设置LED的 pinctrl节点为led_pins_a，也就是示例代码36.3.1。第4-8行是开发板上的LED0，第10-13行是开发板上的LED1。修改完成以后保存并重新编译设备树，然后用新的设备树启动开发板。

运行测试

用新的uImage和stm32mp157d-atk.dtb启动开发板，启动以后查看/sys/bus/platform/devices/dtsleds这个目录是否存在，如下图所示：

进入到dtsleds/leds目录中，此目录中的内容如下图所示：

从上图可以看出，在leds目录下有两个子目录，分别为：green和red，其中green就是LED1，red就是LED0，这两个子目录的名字就是在示例代码36.3.2中第5行和第11行设置的label属性值。

设置究竟有没有用，最终是要通过测试才能知道的，首先查看一下系统中有没有“sys/class/leds/red/brightness”和“sys/class/leds/green/brightness”这两个文件，这两个文件分别对应LED0和LED1，通过操作这两个文件即可实现LED0和LED1的打开和关闭。

如果有可以输入如下命令来打开两个LED灯：

echo 1 > /sys/class/leds/red/brightness //打开LED0
echo 1 > /sys/class/leds/green/brightness //打开LED1

关闭命令如下：

echo 0 > /sys/class/leds/red/brightness //关闭LED0
echo 0 > /sys/class/leds/green/brightness //关闭LED1

如果能正常的打开和关闭两个LED灯话就说明Linux内核自带的LED灯驱动工作正常。一般会将一个LED灯作为系统指示灯，系统运行正常的话这个LED指示灯就会一闪一闪的。这里设置LED0作为系统指示灯，在dtsleds/led0这个设备节点中加入“linux,default-trigger”属性信息即可，属性值为“heartbeat”，修改完以后的dtsleds节点内容如下：

示例代码36.4.1 dtsleds设备节点 
1  dtsleds { 
2      compatible = "gpio-leds"; 
3      pinctrl-0 = <&led_pins_a>; 
4 
5      led0 { 
6          label = "red"; 
7          gpios = <&gpioi 0 GPIO_ACTIVE_LOW>; 
8          linux,default-trigger = "heartbeat"; 
9          default-state = "on"; 
10     }; 
11 
12     led1 { 
13         label = "green"; 
14         gpios = <&gpiof 3 GPIO_ACTIVE_LOW>; 
15         default-state = "off"; 
16     }; 
17 };

第8行，设置LED0为heartbeat。

第9行，默认打开LED0。

重新编译设备树并且使用新的设备树启动Linux系统，启动以后LED0就会闪烁，作为系统心跳指示灯，表示系统正在运行。

总结

这一章，直接使用Linux内核自带的LED驱动，不需要自行编写驱动程序，直接配置设备树就可以了。

首先要先在以下路径使能LED驱动：