Device Tree Survey and Summary

LTM

Posted by Max on October 2, 2018

本文采用知识共享 署名-非商业性使用-禁止演绎 4.0 国际协议授权(CC BY-NC-ND 4.0),转载请注明出处.

I. Preface

本文主要介绍嵌入式系统Bootloader中的设备树(Device Tree),援引Wikipedia对其定义如下, 简单归纳,DT文件是由一系列Node构成的树形结构,其中每个Node都对应硬件系统中的一个device,如CPU, I2C controller. 目前,Device Tree (DT)尚无行业标准,仍在发展中,内容上还不算庞杂,短时间内可掌握,其对参与嵌入式开源项目,特别是RISC-V还是有一定价值的.

本文不会简单综合文档资源进行内容罗列,而是简明概括文档中值得注意的点,所以,在内容完整性和连贯性上可能欠佳,如果要了解全部语法和参数定义,可参考文末的文档列表.

In computing, a device tree (also written devicetree) is a data structure describing the physical hardware components of a particular computer so that the operating system’s kernel can use and manage those components, including the CPU or CPUs, the memory, the buses and the peripherals.

The device tree was derived from SPARC-based workstations and servers via the Open Firmware project. The current Devicetree specification is targeted at smaller systems, but is still used with some server-class systems (for instance, those described by the Power Architecture Platform Reference including some Apple Macintoshes).

II. How to work

Xilinxzynq系统为例,简单了解DT在系统启动阶段如何工作,UG1165中介绍了Linux Boot Process on the Target Platform,如Fig-1. 简单的说,DT对目标系统中的物理器件进行静态描述,kernel通过查找DT(.dtb)完成设备检测和驱动配置. 这种设备描述与设备配置过程的解耦,可以在不改变kernel的情况下,直接应用于不同的硬件系统(DT).

Fig-1

III. File classification and relationship

DT通常由一系列描述文件构成,而非单一文件,不同文件描述了目标硬件系统的不同组成部分,相关文件类型包括以下三种:

  • .dts"device tree souce", .dts, .dtsi都是对目标系统硬件的描述,区别在于.dts是板级描述文件;
  • .dtsi"device tree source include", 是SoC级或Module级 (板上硬件模块,非RTL module)描述文件,如Fig-2~Fig-3;
  • .dtb"device tree blob"DTB文件只是DT compiler(DTC).dts源文件的编译结果,是能够被kernel识别读取的压缩格式.

三种源文件的关联与处理流程如Fig-4所示,从图中可以看到,DTC无法直接识别.dtsi描述文件,需要/include/.dts中. 需要注意的是, 源文件间的/include/顺序会影响Node属性或其本身的参数覆盖,即如果要对overlay.dtsi中的node 1的属性值进行“重载”或“添加”,那么相应的编码应该添加到/include/ overlay.dtsi的描述文件中.

Fig-2 [1] Fig-3 [2] Fig-4

IV. Basic elements within a dts(i)

1.Tree structure. 前述,每个.dts(i)都描述了目标系统的部分硬件模块,且文件内部组织形式皆为树形结构,如Fig-5所示,即每个文件内部都有一个或多个root node ("/"),其他每个Node都描述了一个device或module. 每个Node的基本结构如Code-1代码段所示,由三部分构成,名称+描述域控制("{ };")+属性/子节点定义,需要说明的是:

  • normal node相比,root node没有label_name: node_name@unit_address,而是使用“/”作为节点名称, 同时,除了根节点,每个normal node都有一个父节点;
  • 所有normal node必须在root node的控制域内做“初次声明”,如Code-2代码段,有一个例外是在文件中对已声明节点做“属性重载或添加”或“节点重载”时,需要将重载描述写在根节点控制域范围以外. 但作者不确定是否所有manufacturer都如此,毕竟没有统一标准,至少作者看见的案例均遵照此规则,如xilinx要求在重载描述的文件中,新添加的(“初次声明”)节点在根节点控制域内描述,重载描述则在根节点控制域以外添加(本文档是long-term maintenance,会持续添加新东西.);
  • 一个文件中的根节点数目并不是唯一的,可以同时存在多个根节点,即一个.dts(i)内部可以是树或森林;从Fig-4可以看到,所有的.dts(i)最后会组成一个“top”文件,所以,不同文件中即使存在多个根节点最后都会融合在一起. 实际上,所谓的“描述控制域”是作者自定义的说法,其主要意义在于将“brother nodes”和“parent-child nodes”圈定,但不同根节点控制域之间的关系,作者尚不知晓,若有同道了解其中原理还请告知.
Fig-5 [3]
//Code-1:normal node definition
[label:] node_name [@unit_addrss] {
                                    [properties definition;]
                                    [child nodes]
};
//Code-2:DT example
/ {
    compatible = "acme,coyotes-revenge";
    #address-cells = <1>;
    #size-cells = <1>;
    interrupt-parent = <&intc>;

    cpus {
           #address-cells = <1>;
           #size-cells = <0>;

           cpu@0 {
                   compatible = "arm,cortex-a9";
                   reg = <0>;
           };

           cpu@1 {
                   compatible = "arm,cortex-a9";
                   reg = <1>;
     ......

};

2.Node structure. Fig-6~Fig-7描述了node结构中的组成元素,需要说明的是:

  • unit-address: 对于访问DT的程序而言,unit-address是访问node的主要入口地址,其值需与node内部的reg=<address,length>属性中的address匹配,若某nodereg属性,那么节点名称需去掉@unit-address部分;
  • cell: 节点内部大多数非字符串属性值,以cell 为单位,32-bit,如在32-bit系统中某节点属性reg=<0x0 0x10>,表示该节点对应的device占用一块起始地址为0x00000000,大小为16 bit的存储空间,而若在64-bit系统中描述该节点,则要改写为reg=<0x0 0x0 0x0 0x10>,即分别使用两个cell表示起始地址和空间大小;
  • label: 节点前的label是可选的,另外,label不仅可以放在节点名称前,还可以放在节点内部的属性前,即label-name: property=property-value;
  • property value: 属性值类型随属性的不同而不同,可参考文档,需要说明的是,有些属性的值可以为”空”,即只保留属性名,如ranges;,而”空”所代表的意义依赖于其所依附的”属性”,请参考文档定义;
  • phandle: 类似于windows编程里的“指针句柄”,只不过在那里指向窗口控件,而这里是指向一个node,有两种基本用法,即

    • 直接在node内部为phandle属性赋值,且该值不能与其他节点的phandle属性值重复,即在整个DT中唯一标识该node,以便其他节点能够引用该节点,如Code-3;
    • 无需在node内部为phandle赋值,而是直接在其他节点中引用该nodelabel,如Code-4.

    实际上,一般在DT的节点中很少显示声明phandle属性,除了显示使用labelDTC会自动在节点中插入phandle.

//Code-3: phandle example 1
referenced-node {
                    phandle = <1>;
                    ......
};

another-device-node {
                        interrupt-parent = <1>; //reference the above "referenced-node"
                        ......
};
//Code-4: phandle example 2
label: referenced-node {
                          ......
};

another-device-node {
                        interrupt-parent = <&label>; //reference the above "referenced-node"
                        ......
};
Fig-6 [1] Fig-7 [2]

V. Some useful tips

本节会介绍一些在自定义或修改DT时,需要注意的一些内容,对比查证后,会逐步添加.

1.Overwriting node’s properties

节点属性重载应该是使用最多的操作之一,因为不管是自动还是手动生成的DT文件,在后续系统使用过程中,我们可能需要对其进行重置,如修改某些硬件模块的可用状态status = "disabled"—>status = "okay",即from "everything on" to "everything off unless requested by the DTB"原则. 但很奇怪,大多文档中并没交代相关语法,且不同manufacturer的复写方式不同,

  • Xilinx与NXP版本[4] (已验证):直接引用已声明节点的标签,并在控制域内对指定属性重新赋值,如
//Code-5: Xilinx/NXP overwriting and appending properties
//child.dtsi
existed-node-label: existed-node {
                                    compatible = "nxp, imx6";
                                    ......
};

//parent.dtsi
@existed-node-label{
                       compatible = "nxp, imx7", "nxp, imx6";
                       new_property = new_property_value;
}
  • Raspberry PI版本[5] (未验证):树莓派不是使用&+label-name,而是/+node-name对已存在节点属性进行覆盖和追加,如Code-6,需要注意的是,例子中虽然将原始节点定义和重载节点定义写在了相同文件中,但遵从的原则都是later values override earlier ones.
//Code-6:Raspberry PI overwriting and appending properties
/dts-v1/;
/include/ "common.dtsi";

/ {
    ......
    
    node2 {
        an-empty-property;
        a-cell-property = <1 2 3 4>; /* each number (cell) is a uint32 */
        child-node1 {
                        my-cousin = <&cousin>;
        };
    };
};

/node2 {
            another-property-for-node2;  //appending
            a-cell-property = <6 6 6 6>; //overwirting
};

2.Overwriting node

与节点内属性重载类似的,还有node重载,但作者个人觉得这个操作没什么必要,因为节点重载的目的无非是对已有节点属性的”增、删、改”,而这些都不难完成. 不知节点重载的意义是什么,作者也只在NXP[4]文档中看到了相关内容,留此以作完整性记录.

//Code-7: Overwriting node
&iomuxc {
    vf610-colibri {
        //pinctrl_uart2 is overwritten node.
        pinctrl_uart2: uart2grp {     
            fsl,pins = <
                VF610_PAD_PTD0__UART2_TX   0x21a2
                VF610_PAD_PTD1__UART2_RX   0x21a1
            >;
        };
    ...
    };
};

3.Interrupts

中断是DT里很重要的组成部分,而且工作结构上也自成体系,并非与DT的树形结构保持一致. 此外,不同处理器的中断协议和DT书写格式也稍有差异,下面就共性与个性分别简述.

General

1). 工作结构:如前所述,DT是一个树形结构,访问DT的程序在该树形结构中通过寻址(@unit-address)来查找node,提取设备信息;而设备中断的工作方式与数据结构中的”链表”相似,是通过phandelnode间建立”link”来实现,如Fig-8,可以看到,上半部分是DT的树形结构,而下半部分是根据DT中节点的interrupts属性设置生成的interrupt tree(介绍”常用属性”后,说明如何生成的中断树),显然二者并不一致.

Fig-8 [3]

2). 常用属性:常见中断相关属性包括以下4个,按照中断源和中断控制器划分两类(interrupt source—>interrupt controller—>CPU).

  • interrupt-controller: “空”属性值,表明拥有该属性的node是中断控制器;
  • interrupt-cells: 定义中断控制器参数域的尺寸——cell数量,归属于中断控制器节点;
  • interrupt-parent: “指向”中断控制器,需要注意的是,该属性具有继承性,归属中断源节点;
  • interrupts: 中断输出信号说明列表,归属于中断源节点.

根据上述属性,简单分析Fig-8中断树的生成过程,i)open-pic是DT节点中唯一具有interrupt-controller属性的节点,所以作为中断树的根节点;ii)device1, gpioctrl, pci-host的interrupt-parent的属性值皆为&open-pic,所以这三个节点为中断树的二级节点;同理,device2,device3,slot0和slot1为叶子节点.

我们可以进一步查看下面Code-8所示的例子,i)根节点(“/”)包含interrupt-parent属性,那么其所有子节点都继承该属性,不必二次声明,label为intc,gpio的节点显然为controller节点;ii)节点i2c@7000c000直接定义interrupts属性即可,而另一DT中的节点wm8903则还需要定义interrupt-parent属性;iii)intc和gpio的#address-cells属性分别为3,2,所以i2c@7000c000和wm8903的interrupts属性值分别使用3个cells、2个cells表示中断输出项.

//Code-8:interrupts exmaple
/ { 
    interrupt-parent = <&intc>; 

    intc: interrupt-controller { 
                                   compatible = "arm,cortex-a9-gic"; 
                                   reg = <0x50041000 0x1000 0x50040100 0x0100>; 
                                   interrupt-controller; 
                                   #interrupt-cells = <3>; 
    }; 

    i2c@7000c000 { 
                    compatible = "nvidia,tegra20-i2c"; 
                    reg = <0x7000c000 0x100>; 
                    interrupts = <GIC_SPI 38 IRQ_TYPE_LEVEL_HIGH>; 
                    #address-cells = <1>; 
                    #size-cells = <0>;
                    ...
    }; 

    gpio: gpio { 
                  compatible = "nvidia,tegra20-gpio"; 
                  reg = <0x6000d000 0x1000>; 
                  interrupts = <GIC_SPI 32 IRQ_TYPE_LEVEL_HIGH>, <GIC_SPI 33 IRQ_TYPE_LEVEL_HIGH>, ...; 
                  #gpio-cells = <2>; 
                  gpio-controller; 
                  #interrupt-cells = <2>; 
                  interrupt-controller; 
    }; 
};

/ {
    ...

    i2c@7000c000 { 
                   status = "okay"; 
                   clock-frequency = <400000>; 
                                    
                   wm8903: wm8903@1a { 
                                       compatible = "wlf,wm8903"; 
                                       reg = <0x1a>; 
                                       interrupt-parent = <&gpio>; 
                                       interrupts = <tegra_gpio(x,3) IRQ_TYPE_LEVEL_HIGH>; 
                                       ...
                   };
    };
};

Specificinterrupts属性值所表示的意义依赖于不同厂家的CPU,看到有差异的主要是NXP和ARM两家,即

1). NXP [4]: NXP处理器DTnode#interrupt-cells属性值通常是4或2,如QorIQ P1010 “interrupts = <42 2 0 0>;”

  • 1st cell: 指示xIVPR寄存器index值,<=16表示SoC外部中断源,其余为内部中断源,42-16=26对应”DUART”中断;
  • 2nd cell:电平敏感信息
    • 0 = low-to-high edge sensitive type enabled
    • 1 = active-low level sensitive type enabled
    • 2 = active-high level sensitive type enabled
    • 3 = high-to-low edge sensitive type enabled
  • 3rd cell:中断类型——”interrupt-type”, 如MPIC
    • 0 = normal
    • 1 = error interrupt
    • 2 = MPIC inter-processor interrupt
    • 3 = MPIC timer interrupt
  • 4th cell:中断类型信息——”type-info”, 主要用于指示”error interrupt number”.

2). ARM:ARM处理器DTnode#interrupt-cells属性值通常是3,如”interrupts = <0 89 4>;”

  • 1st cell:指示GIC中断类型,private peripheral interrupts (PPI)或shared peripheral interrupts (SPI);
    • 0 = SPI interrupts
    • 1 = PPI interrupts
  • 2nd cell:GIC interrupt number,SPI interrupts number 0-987,PPI interrupts number 0-15(需要注意的是,在linux系统中查看interrupt ID时,会与这里的定义的值不同,即kernel interrupt ID=GIC NO. + 32, 源于kernel定义32~255为user-defined interrupts,所以user-space的中断会+32);
  • 3rd cell:
    • 1 = low-to-high edge sensitive
    • 2 = high-to-low edge sensitive
    • 4 = active-high level sensitive
    • 8 = active-low level-sensitive

4.Comment:DT源文件支持单行注释//和多行注释/* */.

5…..

====说明====

1). 由于设备树尚未标准化,所以文中内容并不具备普适性,仅作为参考,各位看官还是要依据手上硬件找对应设备商的文档; 

2). 文中内容来源杂乱,作者难免有疏漏,如果文中内容描述有误或不恰当,请路过的小伙伴指正;

3). 本文将长期维护,会不断添加新内容,并对原文作必要修改,也欢迎有推荐内容的小伙伴,mail作者.

Reference

[1] T. Petazzoni. Device Tree for Dummies. [Online]: https://events.static.linuxfound.org/sites/events/files/slides/petazzoni-device-tree-dummies.pdf

[2] Toradex AG. Device Tree Customization. [Online]: https://developer.toradex.com/device-tree-customization

[3] Devicetree.org. Devicetree Specification (rev0.2). [Online]: https://www.devicetree.org/specifications/

[4] NXP. Introduction to Device Trees. [Online]: https://www.nxp.com/docs/en/application-note/AN5125.pdf

[5] Raspberry PI Foudation. DEVICE TREES, OVERLAYS, AND PARAMETERS. [Online]: https://www.raspberrypi.org/documentation/configuration/device-tree.md

[6] Power.org. Embedded Power Architecture™ Platform Requirements(ePAPR).[Online]: https://elinux.org/images/c/cf/Power_ePAPR_APPROVED_v1.1.pdf

[7] eLinux.org. Device Tree Usage. [Online]: https://elinux.org/Device_Tree_Usage