6. 设备树插件修改方法指导¶

在Linux系统中，绝大多数硬件设备都有非常成熟的驱动框架，驱动工程师使用这些框架添加与板子相关的硬件支持，建立硬件与Linux内核的联系。修改设备树则是建立与驱动之间的联系。

6.1. LED子系统设备树插件编写¶

下面以LED子系统设备为例，想要根据LED子系统编写相对应的设备树，可参考的资料有以下

stm-fire-led-overlay.dts 野火提供的设备树插件源文件，这部分是最简单最快速的参考资料，只要依葫芦画瓢即可写出自己的设备树插件。
Documentation/devicetree/bindings/leds/leds-gpio.txt 简单介绍了led子系统的相关节点，提供了led子系统设备树编写的参考例子。
Documentation/devicetree/bindings/leds/common.txt 提供了led子系统设备通用的设备树节点说明。

下面将以leds-gpio.txt和common.txt文档为指导，以stm-fire-led-overlay.dts为参考，整理编写基于LED子系统设备树插件思路。

6.1.1. 设备树插件编写框架¶

在前一篇基础知识中，已经介绍设备树插件的编写框架，直接拿过来使用即可。

设备树插件语法¶

/dts-v1/;
/plugin/;

/{
        fragment@0 {
            target-path = "/";
            __overlay__ {
                /*在此添加要插入的节点*/
            };
        };
};

6.1.2. 配置GPIO引脚功能¶

查看野火stm32mp157底板原理图，可知LED_R对应引脚PA13，LED_G对应引脚PG2，LED_B对应引脚PB5。

一款强大的MCU/MPU引脚都能够配置为各种不同的引脚功能，因此我们需要在设备树插件中将上面引脚设置为IO引脚模式。为节省篇幅，此处仅配置LED_B引脚功能。

设置引脚¶

/dts-v1/;
/plugin/;

#include <dt-bindings/pinctrl/stm32-pinfunc.h>
#include <dt-bindings/input/input.h>
#include <dt-bindings/mfd/st,stpmic1.h>
#include <dt-bindings/gpio/gpio.h>

/{
    fragment@0 {
        target-path = "/";
        __overlay__ {

            normal_led{

                    led_blue{
                        pinctrl-names = "default";
                        pinctrl-0 = <&pinctrl_blue>;
                    };
            };
        };
    };

    fragment@1 {
        target= <&pinctrl>;
        __overlay__ {
            pinctrl_blue:bluegrp{
                pinmux = <STM32_PINMUX('B',5,GPIO) >;
            };
        };
    };

};

引用的头文件中包含了各种定义函数及宏定义，如 “STM32_PINMUX” 、“GPIO” 等。
向“/{……}”根节点中追加了添加normal_led节点，其中包括led_blue{……}子节点，并将使用pinctrl_blue节点的GPIO引脚。
向pinctrl节点中追加pinctrl_blue:bluegrp{……}节点，将PB5引脚设置为GPIO模式。

6.1.3. 添加led子系统相关节点信息¶

想要添加与LED子系统相关的节点信息，查看 Documentation/devicetree/bindings/leds/ 目录下的 leds-gpio.txt 与 common.txt 文档必不可少。添加代码如下

LED子系统设备树插件¶

/dts-v1/;
/plugin/;

#include <dt-bindings/pinctrl/stm32-pinfunc.h>
#include <dt-bindings/input/input.h>
#include <dt-bindings/mfd/st,stpmic1.h>
#include <dt-bindings/gpio/gpio.h>

/ {
        fragment@0 {
            target-path = "/";
            __overlay__ {

                normal_led{
                    compatible = "gpio-leds";
                    status = "okay";

                    led_blue{
                        pinctrl-names = "default";
                        pinctrl-0 = <&pinctrl_blue>;

                        label = "my_blue_led";
                        gpios = <&gpiob 5 GPIO_ACTIVE_LOW>;
                        default-state = "off" ;
                        linux,default-trigger = "none" ;

                    };
                };
            };
        };

        fragment@1 {
            target= <&pinctrl>;
            __overlay__ {
                pinctrl_blue:bluegrp{
                    pinmux = <STM32_PINMUX('B',5,GPIO) >;
                };
            };
        };
};

compatible、label、default-state、linux,default-trigger、gpios 在 leds-gpio.txt 与 common.txt 文件中均有介绍。部分文档如下所示

leds-gpio.txt¶

Required properties:
- compatible : should be "gpio-leds".

Each LED is represented as a sub-node of the gpio-leds device.  Each
node's name represents the name of the corresponding LED.

LED sub-node properties:
- gpios :  Should specify the LED's GPIO, see "gpios property" in
Documentation/devicetree/bindings/gpio/gpio.txt.  Active low LEDs should be
indicated using flags in the GPIO specifier.
- label :  (optional)
see Documentation/devicetree/bindings/leds/common.txt
- linux,default-trigger :  (optional)
see Documentation/devicetree/bindings/leds/common.txt
- default-state:  (optional) The initial state of the LED.
see Documentation/devicetree/bindings/leds/common.txt

提示

Documentation/devicetree 目录下的文档是编写设备树插件必看文档。

以上即是参考官方文档编写设备树插件的的基本步骤。

6.2. 基于野火提供的设备树插件修改¶

有了章节前面的基础再根据自己的需求修改设备树插件那就容易多了。野火提供了大量的设备树插件可供参考，用户只需要根据相关相对应的设备树插件修改即可。

野火设备树插件GitHub

为了减少文章篇幅，以下只列出stm-fire-led-overlay.dts源码中对RGB中的红灯设备树部分。

stm-fire-led-overlay.dts部分内容¶

 /dts-v1/;
 /plugin/;

 #include <dt-bindings/pinctrl/stm32-pinfunc.h>
 #include <dt-bindings/input/input.h>
 #include <dt-bindings/mfd/st,stpmic1.h>
 #include <dt-bindings/gpio/gpio.h>

 /{
     fragment@0{
         target-path = "/";
         __overlay__ {
             normal_led{
                 compatible = "gpio-leds";
                 status = "okay";
                 red {
                     label = "red";
                     gpios = <&gpioa 13 GPIO_ACTIVE_LOW>;
                     default-state = "off";
                     linux,default-trigger = "none";
                 };
             };

         };
     };

 };

如果用户想要添加一个LED子系统相关的设备，核心基本上只需要修改以上引脚即可(在STM32MP157的pinctr子系统中引脚默认为GPIO模式)，节点名与标签可根据自己设备情况灵活修改。同理其他设备树插件的修改也是类似。

6.3. 参考资料¶

对于LED设备，Linux提供了LED子系统驱动框架，在Linux内核源码中的“Documentation/leds/leds-class.txt”有相关的描述。