《STM32MP157嵌入式Linux驱动开发指南》第三十六章 Linux自带LED实验

正点原子

1）实验平台：正点原子STM32MP157开发板
2)  章节摘自【正点原子】《STM32MP157嵌入式Linux驱动开发指南》
3）购买链接:https://item.taobao.com/item.htm?&id=629270721801
4）全套实验源码+手册+视频下载地址：http://www.openedv.com/docs/boards/arm-linux/zdyzmp157.html
5）正点原子官方B站：https://space.bilibili.com/394620890
6）正点原子STM32MP157技术交流群：691905614   

第三十六章 Linux自带的LED灯驱动实验

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


36.1 Linux内核自带LED驱动使能
        上一章节我们编写基于设备树的platform LED灯驱动，其实Linux内核已经自带了LED灯驱动，要使用Linux内核自带的LED灯驱动首先得先配置Linux内核，使能自带的LED灯驱动，输入如下命令打开Linux配置菜单：
make menuconfig
        按照如下路径打开LED驱动配置项：
Device Drivers                                                                                
         LED Support (NEW_LEDS [=y])
                        LED Support for GPIO connected LEDs
        按照上述路径，选择“LED Support for GPIO connected LEDs”，将其编译进Linux内核，也即是在此选项上按下“Y”键，使此选项前面变为“<*>”，如图36.1.1所示：

图36.1.1 使能LED灯驱动

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

图36.1.2 内部LED灯驱动帮助信息

        从图36.1.2可以看出，把Linux内部自带的LED灯驱动编译进内核以后，CONFIG_LEDS_GPIO就会等于‘y’，Linux会根据CONFIG_LEDS_GPIO的值来选择如何编译LED灯驱动，如果为‘y’就将其编译进Linux内核。
        配置好Linux内核以后退出配置界面，打开.config文件，会找到“CONFIG_LEDS_GPIO=y”这一行，如图36.1.3所示：

图36.1.3 .config文件内容

        重新编译Linux内核，然后使用新编译出来的zImage镜像启动开发板。
36.2 Linux内核自带LED驱动简介
36.2.1 LED灯驱动框架分析
        LED灯驱动文件为/drivers/leds/leds-gpio.c，大家可以打开/drivers/leds/Makefile这个文件，找到如下所示内容：
示例代码36.2.1.1 /drivers/leds/Makefile文件代码段

1. 1   # SPDX-License-Identifier: GPL-2.0
   
2. 2
   
3. 3   # LED Core
   
4. 4   obj-$(CONFIG_NEW_LEDS)                          += led-core.o
   
5. ......
   
6. 31  obj-$(CONFIG_LEDS_PCA9532)                      += leds-pca9532.o
   
7. 32  obj-$(CONFIG_LEDS_GPIO_REGISTER)          += leds-gpio-register.o
   
8. 33  obj-$(CONFIG_LEDS_GPIO)                         += leds-gpio.o
   
9. 34  obj-$(CONFIG_LEDS_LP3944)                       += leds-lp3944.o
   
10. ......

复制代码

        第33行，如果定义了CONFIG_LEDS_GPIO的话就会编译leds-gpio.c这个文件，在上一小节我们选择将LED驱动编译进Linux内核，在.config文件中就会有“CONFIG_LEDS_GPIO=y”这一行，因此leds-gpio.c驱动文件就会被编译。
        接下来我们看一下leds-gpio.c这个驱动文件，找到如下所示内容：
示例代码36.2.1.2 leds-gpio.c文件代码段

1. 203 static const struct of_device_id of_gpio_leds_match[] = {
   
2. 204     { .compatible = "gpio-leds", },
   
3. 205     {},
   
4. 206 };
   
5. 207
   
6. ......
   
7. 316 static struct platform_driver gpio_led_driver = {
   
8. 317     .probe           = gpio_led_probe,
   
9. 318     .shutdown        = gpio_led_shutdown,
   
10. 319     .driver          = {
    
11. 320         .name         = "leds-gpio",
    
12. 321         .of_match_table = of_gpio_leds_match,
    
13. 322     },
    
14. 323 };
    
15. 324
    
16. 325 module_platform_driver(gpio_led_driver);

复制代码

第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”的文件，如图36.2.1.1所示：

图36.2.1.1 leds-gpio驱动文件

        第326行通过module_platform_driver函数向Linux内核注册gpio_led_driver这个platform驱动。
36.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文件中，为一个宏，定义如下：
示例代码36.2.2.1 module_platform_driver函数

1. 237 #define module_platform_driver(__platform_driver) \
   
2. 238     module_driver(__platform_driver, platform_driver_register, \
   
3. 239             platform_driver_unregister)

复制代码

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

1. 1898 #define module_driver(__driver, __register, __unregister, ...) \
   
2. 1899 static int __init __driver##_init(void) \
   
3. 1900 { \
   
4. 1901    return __register(&(__driver) , ##__VA_ARGS__); \
   
5. 1902 } \
   
6. 1903 module_init(__driver##_init); \
   
7. 1904 static void __exit __driver##_exit(void) \
   
8. 1905 { \
   
9. 1906    __unregister(&(__driver) , ##__VA_ARGS__); \
   
10. 1907 } \
    
11. 1908 module_exit(__driver##_exit);

复制代码

        借助示例代码36.2.2.1和示例代码36.2.2.2，将：

1. module_platform_driver(gpio_led_driver)

复制代码

        展开以后就是：

1. static int __init gpio_led_driver_init(void)
   
2. {
   
3.         return platform_driver_register (&(gpio_led_driver));
   
4. }
   
5. module_init(gpio_led_driver_init);
   
6. 
   
7. static void __exit gpio_led_driver_exit(void)
   
8. {
   
9.         platform_driver_unregister (&(gpio_led_driver) );
   
10. }
    
11. module_exit(gpio_led_driver_exit);

复制代码

        上面的代码不就是标准的注册和删除platform驱动吗？因此module_platform_driver函数的功能就是完成platform驱动的注册和删除。
36.2.3 gpio_led_probe函数简析
        当驱动和设备匹配以后gpio_led_probe函数就会执行，此函数主要是从设备树中获取LED灯的GPIO信息，缩减后的函数内容如下所示：
示例代码36.2.3.1 gpio_led_probe函数

1. 256 static int gpio_led_probe(struct platform_device *pdev)
   
2. 257 {
   
3. 258     struct gpio_led_platform_data *pdata =
   
4. dev_get_platdata(&pdev->dev);
   
5. 259     struct gpio_leds_priv *priv;
   
6. 260     int i, ret = 0;
   
7. 261
   
8. 262     if (pdata && pdata->num_leds) {         /* 非设备树方式                 */
   
9.             /* 获取platform_device信息 */
   
10. .....
    
11. 292     } else {                                        /* 采用设备树              */
    
12. 293         priv = gpio_leds_create(pdev);
    
13. 294         if (IS_ERR(priv))
    
14. 295             return PTR_ERR(priv);
    
15. 296     }
    
16. 297
    
17. 298     platform_set_drvdata(pdev, priv);
    
18. 299
    
19. 300     return 0;
    
20. 301 }

复制代码

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

1. 134 static struct gpio_leds_priv *gpio_leds_create(struct        platform_device *pdev)
   
2. 135 {
   
3. 136     struct device *dev = &pdev->dev;
   
4. 137     struct fwnode_handle *child;
   
5. 138     struct gpio_leds_priv *priv;
   
6. 139     int count, ret;
   
7. 140
   
8. 141     count = device_get_child_node_count(dev);
   
9. 142     if (!count)
   
10. 143         return ERR_PTR(-ENODEV);
    
11. 144
    
12. 145     priv = devm_kzalloc(dev, sizeof_gpio_leds_priv(count),
    
13. GFP_KERNEL);
    
14. 146     if (!priv)
    
15. 147         return ERR_PTR(-ENOMEM);
    
16. 148
    
17. 149     device_for_each_child_node(dev, child) {
    
18. 150         struct gpio_led_data *led_dat = &priv->leds[priv->num_leds];
    
19. 151         struct gpio_led led = {};
    
20. 152         const char *state = NULL;
    
21. 153
    
22. 154         /*
    
23. 155          * Acquire gpiod from DT with uninitialized label, which
    
24. 156          * will be updated after LED class device is registered,
    
25. 157          * Only then the final LED name is known.
    
26. 158          */
    
27. 159         led.gpiod = devm_fwnode_get_gpiod_from_child(dev, NULL,
    
28. child,
    
29. 160                                  GPIOD_ASIS,
    
30. 161                                  NULL);
    
31. 162         if (IS_ERR(led.gpiod)) {
    
32. 163             fwnode_handle_put(child);
    
33. 164             return ERR_CAST(led.gpiod);
    
34. 165         }
    
35. 166
    
36. 167         led_dat->gpiod = led.gpiod;
    
37. 168
    
38. 169         fwnode_property_read_string(child, "linux,default-trigger",
    
39. 170                         &led.default_trigger);
    
40. 171
    
41. 172         if (!fwnode_property_read_string(child, "default-state",
    
42. 173                          &state)) {
    
43. 174             if (!strcmp(state, "keep"))
    
44. 175                 led.default_state = LEDS_GPIO_DEFSTATE_KEEP;
    
45. 176             else if (!strcmp(state, "on"))
    
46. 177                 led.default_state = LEDS_GPIO_DEFSTATE_ON;
    
47. 178             else
    
48. 179                 led.default_state = LEDS_GPIO_DEFSTATE_OFF;
    
49. 180         }
    
50. 181
    
51. 182         if (fwnode_property_present(child, "retain-state-suspended"))
    
52. 183             led.retain_state_suspended = 1;
    
53. 184         if (fwnode_property_present(child, "retain-state-shutdown"))
    
54. 185             led.retain_state_shutdown = 1;
    
55. 186         if (fwnode_property_present(child, "panic-indicator"))
    
56. 187             led.panic_indicator = 1;
    
57. 188
    
58. 189         ret = create_gpio_led(&led, led_dat, dev, child, NULL);
    
59. 190         if (ret < 0) {
    
60. 191             fwnode_handle_put(child);
    
61. 192             return ERR_PTR(ret);
    
62. 193         }
    
63. 194         /* Set gpiod label to match the corresponding LED name. */
    
64. 195         gpiod_set_consumer_name(led_dat->gpiod,
    
65. 196                     led_dat->cdev.dev->kobj.name);
    
66. 197         priv->num_leds++;
    
67. 198     }
    
68. 199
    
69. 200     return priv;
    
70. 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，设置为输出等。
36.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里面有详细的讲解，大家自行查阅。
        本节实验我们把STM32MP1开发板上的2个LED灯都用上，其中LED0(红色)连接到PI0引脚上，LED1(绿色)连接到PF3。首先是创建这两个LED灯对应的pinctrl节点，直接在示例代码35.1.2.1上修改即可，修改完成以后如下所示：
示例代码36.3.1 pinctrl子节点

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

复制代码

       上述代码仅仅只是在示例代码35.1.2.1只添加了第4行，也就是LED1对应的PF3引脚，其他的属性配置没变。
        最后，根据前面的绑定文档要求添加LED设备子节点，打开stm32mp157d-atk.dts，在“/”根节点下添加如下所示LED灯设备子节点：
示例代码36.3.2 dtsleds设备节点

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

复制代码

        第3行，设置LED的pinctrl节点为led_pins_a，也就是示例代码36.3.1。第4~8行是开发板上的LED0，第10~13行是开发板上的LED1。修改完成以后保存并重新编译设备树，然后用新的设备树启动开发板。
36.4 运行测试        
        用新的uImage和stm32mp157d-atk.dtb启动开发板，启动以后查看/sys/bus/platform/devices/dtsleds这个目录是否存在，如图36.4.1所示：

图36.4.1 dtsleds目录

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

图36.4.2 leds目录内容

        从图36.4.2可以看出，在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的打开和关闭。

果有的话就输入如下命令打开LED0(RED)和LED1(GREEN)这两个LED灯：

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

复制代码

关闭这两个LED灯的命令如下：

1. echo 0 > /sys/class/leds/red/brightness                //关闭LED0
   
2. 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. 1  dtsleds {
   
2. 2                  compatible = "gpio-leds";
   
3. 3                    pinctrl-0 = <&led_pins_a>;
   
4. 4
   
5. 5           led0 {
   
6. 6                       label = "red";
   
7. 7                       gpios = <&gpioi 0 GPIO_ACTIVE_LOW>;
   
8. 8                       linux,default-trigger = "heartbeat";
   
9. 9                       default-state = "on";
   
10. 10           };
    
11. 11  
    
12. 12          led1 {
    
13. 13              label = "green";
    
14. 14              gpios = <&gpiof 3 GPIO_ACTIVE_LOW>;
    
15. 15              default-state = "off";
    
16. 16          };
    
17. 17 };

复制代码

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