2020-10-06

Linux设备树语法

1. 基本概念
   1.1 什么是dts？
   ARM Device Tree起源于OpenFirmware (OF)，在过去的Linux中，arch/arm/plat-xxx和arch/arm/mach-xxx中充斥着大量的垃圾代码，相当多数的代码只是在描述板级细节，而这些板级细节对于内核来讲，不过是垃圾，如板上的platform设备、resource、i2c_board_info、spi_board_info以及各种硬件的platform_data。为了改变这种局面，Linux社区的大牛们参考了PowerPC等体系架构中使用的Flattened Device Tree（FDT），也采用了Device Tree结构，许多硬件的细节可以直接透过它传递给Linux，而不再需要在kernel中进行大量的冗余编码。导致ARM的merge工作量较大，其次ARM很多的代码都是垃圾，代码里面有若干愚蠢的table，而多个人在维护这个table，从而导致了冲突。最后linux发出Gaah.Guys, this whole ARM thing is a f*cking pain in the ass.之后经过一些讨论，对ARM平台的相关code做出如下相关规范调整，这个也正是引入DTS的原因。
   本质上，Device Tree改变了原来用code方式将HW配置信息嵌入到内核代码的方法，改用bootloader传递一个DB的形式。对于嵌入式系统，在系统启动阶段，bootloader会加载内核并将控制权转交给内核，此外，还需要把上述的三个参数信息传递给kernel，以便kernel可以有较大的灵活性。在linux kernel中，Device Tree的设计目标就是如此。
   在devie tree中，可描述的信息包括：
   CPU的数量和类别
   内存基地址和大小
   总线和桥
   外设连接
   中断控制器和中断的使用情况
   GPIO控制器和GPIO使用情况
   clock控制器和clock使用情况
   它基本就是一棵电路板上的CPU、总线、设备组成的树，Bootloader会将这棵树传递给内核，然后内核来识别这棵树，并根据它展开出Linux内核中的platform_device、i2c_client、spi_device等设备，而这些设备用到的内存、IRQ等资源，也被传递给内核，内核会将这些资源绑定给展开的相应设备。
   1.2设备树的组成和使用
   设备树包含DTC（device tree compiler），DTS（device tree source和DTB（device tree blob）。
   1.2.1 dts、dtsi
   .dts文件是一种ASCII文本对Device Tree的描述，放置在内核的/arch/arm/boot/dts目录。一般而言，一个.dts文件对应一个ARM的machine。
   .dtsi文件作用：由于一个SOC可能有多个不同的电路板，而每个电路板拥有一个 .dts。这些dts势必会存在许多共同部分，为了减少代码的冗余，设备树将这些共同部分提炼保存在.dtsi文件中，供不同的dts共同使用。.dtsi的使用方法，类似于C语言的头文件，在dts文件中需要进行include *.dtsi文件。当然，dtsi本身也支持include 另一个dtsi文件。
   1.2.2 dtc
   dtc是编译dts的工具，可以在Ubuntu系统上通过指令apt-get install device-tree-compiler安装dtc工具，不过在内核源码scripts/dtc路径下已经包含了dtc工具；

1.2.3 dtb
dtb(Device Tree Blob)，dts经过dtc编译之后会得到dtb文件，dtb通过Bootloader引导程序加载到内核。所以Bootloader需要支持设备树才行；Kernel也需要加入设备树的支持；

1.3 devie tree的编译
Device Tree文件的格式为dts，包含的头文件格式为dtsi，dts文件是一种人可以看懂的编码格式。但是uboot和linux不能直接识别，他们只能识别二进制文件，所以需要把dts文件编译成dtb文件。dtb文件是一种可以被kernel和uboot识别的二进制文件。把dts编译成dtb文件的工具是dtc。Linux源码目录下scripts/dtc目录包含dtc工具的源码。在Linux的scripts/dtc目录下除了提供dtc工具外，也可以自己安装dtc工具，linux下执行：sudo apt-get install device-tree-compiler安装dtc工具。其中还提供了一个fdtdump的工具，可以反编译dtb文件
dtc工具的使用方法是：

dtc –I dts –O dtb –oxxx.dtb xxx.dts

dts和dtb文件的转换如下图所示：

1.4 设备树存储格式
简单的说，设备树是一种描述硬件配置的树形数据结构，有且仅有一个根节点。它包含了有关CPU、物理内存、总线、串口、PHY以及其他外围设备信息等。该树继承了Open Firmware IEEE 1275设备树的定义。操作系统能够在启动时对此结构进行语法分析，以此配置内核，加载相应的驱动。
　
2. 设备树的语法
2.1 基本数据格式
设备树是一个包含节点和属性的简单树状结构。属性就是键－值对，而节点可以同时包含属性和子节点。例如，以下就是一个 .dts 格式的简单树：

/ {
   
    node1 {
   
        a-string-property = "A string";
        a-string-list-property = "first string", "second string";
        a-byte-data-property = [0x01 0x23 0x34 0x56];
        child-node1 {
   
            first-child-property;
            second-child-property = <1>;
            a-string-property = "Hello, world";
        };
        child-node2 {
   
        };
    };
    node2 {
   
     an-empty-property;
     a-cell-property = <1 2 3 4>; /* each number (cell) is a uint32 */
        child-node1 {
   
        };
    };
};

device tree的基本单元是node。这些node被组织成树状结构，除了root node，每个node都只有一个parent。一个device tree文件中只能有一个root node。每个node中包含了若干的property/value来描述该node的一些特性。每个node用节点名字（node name）标识，节点名字的格式是node-name@unit-address。如果该node没有reg属性（后面会描述这个property），那么该节点名字中必须不能包括@和unit-address。unit-address的具体格式是和设备挂在那个bus上相关。例如对于cpu，其unit-address就是从0开始编址，以此加一。而具体的设备，例如以太网控制器，其unit-address就是寄存器地址。
这棵树显然是没什么用的，因为它并没有描述任何东西，但它确实体现了节点的一些属性。root node的node name是确定的，必须是“/”。 也就是说设备树源文件的结构为：
1个root节点”/”;
root节点下面含一系列子节点，“node1” and “node2”
节点node1和下又含有一系列子节点，“child-node1” and “child-node2”
各个节点都有一系列属性
这些属性可能为空，如an-empty-property
可能为字符串，如a-string-property
可能为字符串树组，如a-string-list-property
可能为Cells（由u32整数组成），如second-child-property
2.2 dts的语法
在linux kernel中，扩展名是dts的文件就是描述硬件信息的device tree source file，在dts文件中，一个node被定义成：

[label:] node-name[@unit-address] {
   
       [properties definitions]
       [child nodes]
}

“[]”表示option，因此可以定义一个只有node name的空节点，label方便在dts文件中引用。
属性是一些简单的键值对（key-value pairs）：value可以为空也可以包含任意的字节流。而数据类型并没有编码成数据结构，有一些基本数据表示可以在device tree源文件中表示。
文本字符串（null 终止）用双引号来表示：string-property = “a string”
“Cells”是由尖括号分隔的32位无符号整数：cell-property = <0xbeef 123 0xabcd1234>
二进制数据是用方括号分隔：binary-property = [0x01 0x23 0x45 0x67];
不同格式的数据可以用逗号连接在一起：mixed-property = “a string”, [0x01 0x23 0x45 0x67], <0x12345678>;
逗号也可以用来创建字符串列表：string-list = “red fish”, “blue fish”;
2.3． dts的组成
2.3.1 标准属性
2.3.1.1 compatible
每一个dts文件都是由一个root的根节点组成，内核通过根节点“/”的兼容性即可判断它启动的是什么设备，其代码结构如下

/ {
   
	model = "Spreadtrum SC9830A-5 V1.0.0 Smartphone Board";

	compatible = "sprd,sp9830a-5h10-ga1", "sprd,sc9830";

	chosen {
   
	bootargs = "earlycon=sprd_serial,0x70100000,115200n8 loglevel=8 console=ttyS1,115200n8 init=/init root=/dev/ram0 rw androidboot.hardware=sc9830";
		linux,initrd-start = <0x85500000>;
		linux,initrd-end = <0x855a3212>;
	};
};

model属性值是，它指定制造商的设备型号。推荐的格式是：“manufacturer，model”，其中manufacturer是一个字符串描述制造商的名称，而型号指定型号。
compatible属性值是,指定了系统的名称，是一个字符串列表，它包含了一个“<制造商>,<型号>”形式的字符串。重要的是要指定一个确切的设备，并且包括制造商的名字，以避免命名空间冲突。
chosen 节点不代表一个真正的设备，但功能与在固件和操作系统间传递数据的地点一样，如根参数，取代以前bootloader的启动参数，控制台的输入输出参数等
2.3.1.2 #address-cells和#size-cells
· #address-cells = <1>: 基地址、片选号等绝对起始地址所占字长，单位uint32
· #size-cells = <1>: 长度所占字长，单位uint32

soc {
   
	#address-cells = <1>;
	#size-cells = <1>;
	serial {
   
		compatible = "ns16550";
		reg = <0x4600 0x100>;
		clock-frequency = <0>;
		interrupts =<