2.1设备树的规范（dts和dtb）——DTS格式

本节学习设备树的规范。

使用设备树时，需要编写dts文件，然后使用dtc编译dts文件，生成dtb文件。

所以本节分为两部分，第一部分讲解dts格式，第二部分讲解dtb格式。

首先看一下dts文件的布局。

DTS文件布局（layout）:
/dts-v1/;                         // 表示DTS文件的版本
[memory reservations]             // 保存的内存区域 格式为： /memreserve/ <address> <length>;
/ {
    [property definitions]
    [child nodes]
};

第一行 /dts-v1/; 表示的是DTS文件的版本。

第二行 [memory reservations] 表示保留的内存区域，假设有64MB内存，如果希望保留4MB内存，只提供60MB内存供内核使用，那么就可以设置这个选项，如果不设置则认为内核使用全部的内存。

接下来是 / { ... };，其中 / 是根，是设备树的起点。

对于每一个设备树，我们需要一些属性来描述这颗树，就是 [property definitions]；同样，一颗树有很多树干，很多分支，一颗设备树同样也有很多子节点，子节点中又可以包含子节点，就是 [child nodes]。

那么属性和设备节点是如何定义的呢？

属性

首先来看属性。

属性的格式有两种，一种是没有值的空属性，一种是有值的属性。

Property格式1:
[label:] property-name = value;

Property格式2(没有值):
[label:] property-name;

下面就是有值的属性，除了特殊规定的属性，比如bootargs是用来设置启动指令，其他没有特殊规定的属性，属性名是可以自由定义的，比如pin，就是我们自己定义的属性。

属性值的写法有三种：

1. 用尖括号括起来 <xx xx xx ...>，例如<1 0x3 0x123>，每个成员都是32bit数据，称为arrays of cells；
2. 用双引号括起来的字符串 "..."，例如上面bootargs的字符串；
3. 用中括号括起来的字节序列（byte string）[xx xx xx ...]，使用16进制表示1个/多个byte，需要注意的是，byte string中，一个byte必须用2位16进制数来表示，例如[00 11 22]，其中00不能简写为0，但是byte之间的空格可以省略，也就是[00 11 22]和[001122]是一样的；

value的取值类型只有上述三种，但是这三种取值类型可以叠加，不过一般不会这么做。

示例: 
a. Arrays of cells : cell就是一个32位的数据
interrupts = <17 0xc>;

b. 64bit数据使用2个cell来表示:
clock-frequency = <0x00000001 0x00000000>;

c. A null-terminated string (有结束符的字符串):
compatible = "simple-bus";

d. A bytestring(字节序列) :
local-mac-address = [00 00 12 34 56 78];  // 每个byte使用2个16进制数来表示
local-mac-address = [000012345678];       // 每个byte使用2个16进制数来表示

e. 可以是各种值的组合, 用逗号隔开:
compatible = "ns16550", "ns8250";
example = <0xf00f0000 19>, "a strange property format";

设备节点

下图就是设备树中节点的格式。

第一行的 label 可加可不加，node-name是节点名字；@unit-address是地址，可以用来区分内存节点，比如memory@30000000和memory@0，分别表示起始地址为0x3000 0000和0的两块内存；

led {
    compatible = "jz2440_led";
	pin = <S3C2410_GPF(5)>;
};

以之前写的led为例，其中led就是node-name。

memory@30000000 {  /* /memory/memory@30000000 */
	device_type = "memory";
	reg =  <0x30000000 0x4000000>;		
};

memory@0 {  /* /memory/memory@0 */
	device_type = "memory";
	reg =  <0 4096>;		
};

memory@30000000和memory@0就是两块不同起始地址的内存空间。

注意事项

dts文件中有一些默认的属性名字，比如model，compatible，#address-cells，#size-cells，这些是根节点必须有的属性，它们代表的含义都是默认的，是事先约定好的。

它们的定义如下。

 

 举例

override

设备树文件可以将一些公共的部分写为dtsi文件，dts文件可以包含dtsi文件，就像C文件包含h文件一样，语法格式也同C文件包含h文件一样。

下面是一个dtsi文件。

// SPDX-License-Identifier: GPL-2.0
/*
 * SAMSUNG SMDK2440 board device tree source
 *
 * Copyright (c) 2018 weidongshan@qq.com
 * dtc -I dtb -O dts -o jz2440.dts jz2440.dtb
 */
 
#define S3C2410_GPA(_nr)	((0<<16) + (_nr))
#define S3C2410_GPB(_nr)	((1<<16) + (_nr))
#define S3C2410_GPC(_nr)	((2<<16) + (_nr))
#define S3C2410_GPD(_nr)	((3<<16) + (_nr))
#define S3C2410_GPE(_nr)	((4<<16) + (_nr))
#define S3C2410_GPF(_nr)	((5<<16) + (_nr))
#define S3C2410_GPG(_nr)	((6<<16) + (_nr))
#define S3C2410_GPH(_nr)	((7<<16) + (_nr))
#define S3C2410_GPJ(_nr)	((8<<16) + (_nr))
#define S3C2410_GPK(_nr)	((9<<16) + (_nr))
#define S3C2410_GPL(_nr)	((10<<16) + (_nr))
#define S3C2410_GPM(_nr)	((11<<16) + (_nr))

/dts-v1/;

/ {
	model = "SMDK24440";
	compatible = "samsung,smdk2440";

	#address-cells = <1>;
	#size-cells = <1>;
		
	memory {  /* /memory */
		device_type = "memory";
		reg =  <0x30000000 0x4000000 0 4096>;		
	};

	
/*
	cpus {
		cpu {
			compatible = "arm,arm926ej-s";
		};
	};
*/	
	chosen {
		bootargs = "noinitrd root=/dev/mtdblock4 rw init=/linuxrc console=ttySAC0,115200";
	};

	
	led {
		compatible = "jz2440_led";
		pin = <S3C2410_GPF(5)>;
	};
};

然后在dts文件中包含这个dtsi文件， 只要添加一个#include "jz2440.dtsi"即可。

// SPDX-License-Identifier: GPL-2.0
/*
 * SAMSUNG SMDK2440 board device tree source
 *
 * Copyright (c) 2018 weidongshan@qq.com
 * dtc -I dtb -O dts -o jz2440.dts jz2440.dtb
 */
 
/dts-v1/;

#include "jz2440.dtsi"

在dtsi文件中led节点的pin属性为<S3C2410_GPF(5)>，如果要修改为<S3C2410_GPF(6)>但是不想改变dtsi文件，那么只需要在dts文件中重新定义led节点的pin属性即可。

增加led节点pin属性的设置，设置如下。也就是说，设置以最终的设置值为准。

// SPDX-License-Identifier: GPL-2.0
/*
 * SAMSUNG SMDK2440 board device tree source
 *
 * Copyright (c) 2018 weidongshan@qq.com
 * dtc -I dtb -O dts -o jz2440.dts jz2440.dtb
 */
 
/dts-v1/;

#include "jz2440.dtsi"

/ {
    led {
		pin = <S3C2410_GPF(6)>;
	};
};

将dts和dtsi文件复制到arch\arm\boot\dts目录下，设置编译工具链。

export PATH=/home/book/code/gcc-linaro-4.9.4-2017.01-x86_64_arm-linux-gnueabi/bin/:$PATH

然后在根目录下执行make dtbs指令，编译dts文件，得到dtb文件。

想要看编译后的dtb文件是否和我们设置的相同，可以使用dtc工具将dtb文件反编译成dts文件，看看反编译的dts文件是否符合上面的设置。

 执行下面指令，将jz2440.dtb反编译得到一个tmp.dts文件。

./scripts/dtc/dtc -I dtb -O dts -o tmp.dts arch/arm/boot/dts/jz2440.dtb

dtc的说明如下。

 然后查看tmp.dts文件，可以看到led节点的pin属性被设置为了<S3C2410_GPF(6)>而不是<S3C2410_GPF(5)>。

LABEL

在之前，想要修改dtsi文件中的led节点，需要将led的整个路径写出，除了这个方法之外，还可以增加一个led节点的label，在dts文件中通过label来引用led节点。

如下所示，其他部分不变，将led节点的label设置为LED。

LED: led {
	compatible = "jz2440_led";
	pin = <S3C2410_GPF(5)>;
};

修改dts文件，引用led节点的标签LED，将pin属性设置为7。

// SPDX-License-Identifier: GPL-2.0
/*
 * SAMSUNG SMDK2440 board device tree source
 *
 * Copyright (c) 2018 weidongshan@qq.com
 * dtc -I dtb -O dts -o jz2440.dts jz2440.dtb
 */
 
/dts-v1/;

#include "jz2440.dtsi"
&LED {
   pin = <S3C2410_GPF(7)>;
};

重新编译dtb文件，然后反编译，得到新的tmp.dts文件。

可以看到，led节点的pin属性被覆盖为了7。

最后，本节内容来自设备树的官方文档，可以从https://www.devicetree.org/specifications/下载到关于设备树知识的官方文档。