Linux DTS(Device Tree Source)设备树详解

Linux DTS(Device Tree Source)设备树详解之一(背景基础知识篇)

Linux DTS(Device Tree Source)设备树详解之二

Linux DTS(Device Tree Source)设备树详解之三(高通MSM8953实例分析篇)

一.什么是DTS？为什么要引入DTS？

 

DTS即Device Tree Source 设备树源码, Device Tree是一种描述硬件的数据结构，它起源于 OpenFirmware (OF)。

在Linux 2.6中，ARM架构的板极硬件细节过多地被硬编码在arch/arm/plat-xxx和arch/arm/mach-xxx，比如板上的platform设备、resource、i2c_board_info、spi_board_info以及各种硬件的platform_data，这些板级细节代码对内核来讲只不过是垃圾代码。而采用Device Tree后，许多硬件的细节可以直接透过它传递给Linux，而不再需要在kernel中进行大量的冗余编码。

每次正式的linux kernel release之后都会有两周的merge window，在这个窗口期间，kernel各个部分的维护者都会提交各自的patch，将自己测试稳定的代码请求并入kernel main line。每到这个时候，Linus就会比较繁忙，他需要从各个内核维护者的分支上取得最新代码并merge到自己的kernel source tree中。Tony Lindgren，内核OMAP development tree的维护者，发送了一个邮件给Linus，请求提交OMAP平台代码修改，并给出了一些细节描述：

       1)简单介绍本次改动

       2)关于如何解决merge conficts。有些git mergetool就可以处理，不能处理的，给出了详细介绍和解决方案

       一切都很平常，也给出了足够的信息，然而，正是这个pull request引发了一场针对ARM linux的内核代码的争论。我相信Linus一定是对ARM相关的代码早就不爽了，ARM的merge工作量较大倒在其次，主要是他认为ARM很多的代码都是垃圾，代码里面有若干愚蠢的table，而多个人在维护这个table，从而导致了冲突。因此，在处理完OMAP的pull request之后（Linus并非针对OMAP平台，只是Tony Lindgren撞在枪口上了），他发出了怒吼：

     Gaah.Guys, this whole ARM thing is a f*cking pain in the ass.

 

之后经过一些讨论，对ARM平台的相关code做出如下相关规范调整，这个也正是引入DTS的原因。

1、ARM的核心代码仍然保存在arch/arm目录下

2、ARM SoC core architecture code保存在arch/arm目录下

3、ARM SOC的周边外设模块的驱动保存在drivers目录下

4、ARM SOC的特定代码在arch/arm/mach-xxx目录下

5、ARM SOC board specific的代码被移除，由DeviceTree机制来负责传递硬件拓扑和硬件资源信息。

本质上，Device Tree改变了原来用hardcode方式将HW 配置信息嵌入到内核代码的方法，改用bootloader传递一个DB的形式。

如果我们认为kernel是一个black box，那么其输入参数应该包括：

a.识别platform的信息  b.runtime的配置参数  c.设备的拓扑结构以及特性

对于嵌入式系统，在系统启动阶段，bootloader会加载内核并将控制权转交给内核，此外，还需要把上述的三个参数信息传递给kernel，以便kernel可以有较大的灵活性。在linux kernel中，Device Tree的设计目标就是如此。

 

二.DTS基本知识

1.DTS的加载过程

如果要使用Device Tree，首先用户要了解自己的硬件配置和系统运行参数，并把这些信息组织成Device Tree source file。通过DTC（Device Tree Compiler），可以将这些适合人类阅读的Device Tree source file变成适合机器处理的Device Tree binary file（有一个更好听的名字，DTB，device tree blob）。在系统启动的时候，boot program（例如：firmware、bootloader）可以将保存在flash中的DTB copy到内存（当然也可以通过其他方式，例如可以通过bootloader的交互式命令加载DTB，或者firmware可以探测到device的信息，组织成DTB保存在内存中），并把DTB的起始地址传递给client program（例如OS kernel，bootloader或者其他特殊功能的程序）。对于计算机系统（computer system），一般是firmware->bootloader->OS，对于嵌入式系统，一般是bootloader->OS。

 

2.DTS的描述信息

Device Tree由一系列被命名的结点（node）和属性（property）组成，而结点本身可包含子结点。所谓属性，其实就是成对出现的name和value。在Device Tree中，可描述的信息包括（原先这些信息大多被hard code到kernel中）：

CPU的数量和类别

内存基地址和大小

总线和桥

外设连接

中断控制器和中断使用情况

GPIO控制器和GPIO使用情况

Clock控制器和Clock使用情况

       它基本上就是画一棵电路板上CPU、总线、设备组成的树，Bootloader会将这棵树传递给内核，然后内核可以识别这棵树，并根据它展开出Linux内核中的platform_device、i2c_client、spi_device等设备，而这些设备用到的内存、IRQ等资源，也被传递给了内核，内核会将这些资源绑定给展开的相应的设备。

是否Device Tree要描述系统中的所有硬件信息？答案是否定的。基本上，那些可以动态探测到的设备是不需要描述的，例如USB device。不过对于SOC上的usb hostcontroller，它是无法动态识别的，需要在device tree中描述。同样的道理，在computersystem中，PCI device可以被动态探测到，不需要在device tree中描述，但是PCI bridge如果不能被探测，那么就需要描述之。

.dts文件是一种ASCII 文本格式的Device Tree描述，此文本格式非常人性化，适合人类的阅读习惯。基本上，在ARM Linux在，一个.dts文件对应一个ARM的machine，一般放置在内核的arch/arm/boot/dts/目录。由于一个SoC可能对应多个machine（一个SoC可以对应多个产品和电路板），势必这些.dts文件需包含许多共同的部分，Linux内核为了简化，把SoC公用的部分或者多个machine共同的部分一般提炼为.dtsi，类似于C语言的头文件。其他的machine对应的.dts就include这个.dtsi。譬如，对于RK3288而言， rk3288.dtsi就被rk3288-chrome.dts所引用，rk3288-chrome.dts有如下一行：#include“rk3288.dtsi”

对于rtd1195,在 rtd-119x-nas.dts中就包含了/include/ "rtd-119x.dtsi"
当然，和C语言的头文件类似，.dtsi也可以include其他的.dtsi，譬如几乎所有的ARM SoC的.dtsi都引用了skeleton.dtsi，即#include"skeleton.dtsi“

或者 /include/ "skeleton.dtsi"

 

正常情况下所有的dts文件以及dtsi文件都含有一个根节点”/”,这样include之后就会造成有很多个根节点? 按理说 device tree既然是一个树，那么其只能有一个根节点，所有其他的节点都是派生于根节点的child node.

其实Device Tree Compiler会对DTS的node进行合并，最终生成的DTB中只有一个 root  node.  

   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是确定的，必须是“/”。

在一个树状结构的device tree中，如何引用一个node呢？要想唯一指定一个node必须使用full path，例如/node-name-1/node-name-2/node-name-N。 

3.DTS的组成结构

 

1. / {

2. node1 {

3. a-string-property = "A string";

4. a-string-list-property = "first string", "second string";

5. a-byte-data-property = [0x01 0x23 0x34 0x56];

6. child-node1 {

7. first-child-property;

8. second-child-property = <1>;

9. a-string-property = "Hello, world";

10. };

11. child-node2 {

12. };

13. };

14. node2 {

15. an-empty-property;

16. a-cell-property = <1 2 3 4>; /* each number (cell) is a uint32 */

17. child-node1 {

18. };

19. };

20. };

 

上述.dts文件并没有什么真实的用途，但它基本表征了一个Device Tree源文件的结构：
1个root结点"/"；
root结点下面含一系列子结点，本例中为"node1"和 "node2"；
结点"node1"下又含有一系列子结点，本例中为"child-node1"和 "child-node2"；
各结点都有一系列属性。这些属性可能为空，如"an-empty-property"；可能为字符串，如"a-string-property"；可能为字符串数组，如"a-string-list-property"；可能为Cells（由u32整数组成），如"second-child-property"，可能为二进制数，如"a-byte-data-property"。

下面以一个最简单的machine为例来看如何写一个.dts文件。假设此machine的配置如下：
1个双核ARM Cortex-A9 32位处理器；
ARM的local bus上的内存映射区域分布了2个串口（分别位于0x101F1000 和 0x101F2000）、GPIO控制器（位于0x101F3000）、SPI控制器（位于0x10115000）、中断控制器（位于0x10140000）和一个external bus桥；
External bus桥上又连接了SMC SMC91111 Ethernet（位于0x10100000）、I2C控制器（位于0x10160000）、64MB NOR Flash（位于0x30000000）；
External bus桥上连接的I2C控制器所对应的I2C总线上又连接了Maxim DS1338实时钟（I2C地址为0x58）。
其对应的.dts文件为：

 

 

1. / {

2. compatible = "acme,coyotes-revenge";

3. #address-cells = <1>;

4. #size-cells = <1>;

5. interrupt-parent = <&intc>;

6.  

7. cpus {

8. #address-cells = <1>;

9. #size-cells = <0>;

10. cpu@0 {

11. compatible = "arm,cortex-a9";

12. reg = <0>;

13. };

14. cpu@1 {

15. compatible = "arm,cortex-a9";

16. reg = <1>;

17. };

18. };

19.  

20. serial@101f0000 {

21. compatible = "arm,pl011";

22. reg = <0x101f0000 0x1000 >;

23. interrupts = < 1 0 >;

24. };

25.  

26. serial@101f2000 {

27. compatible = "arm,pl011";

28. reg = <0x101f2000 0x1000 >;

29. interrupts = < 2 0 >;

30. };

31.  
32.  
33.  

34. gpio@101f3000 {

35. compatible = "arm,pl061";

36. reg = <0x101f3000 0x1000

37. 0x101f4000 0x0010>;

38. interrupts = < 3 0 >;

39. };

40.  

41. intc: interrupt-controller@10140000 {

42. compatible = "arm,pl190";

43. reg = <0x10140000 0x1000 >;

44. interrupt-controller;

45. #interrupt-cells = <2>;

46. };

47.  

48. spi@10115000 {

49. compatible = "arm,pl022";

50. reg = <0x10115000 0x1000 >;

51. interrupts = < 4 0 >;

52. };

53.  
54.  
55.  

56. external-bus {

57. #address-cells = <2>

58. #size-cells = <1>;

59. ranges = <0 0 0x10100000 0x10000 // Chipselect 1, Ethernet

60. 1 0 0x10160000 0x10000 // Chipselect 2, i2c controller

61. 2 0 0x30000000 0x1000000>; // Chipselect 3, NOR Flash

62.  

63. ethernet@0,0 {

64. compatible = "smc,smc91c111";

65. reg = <0 0 0x1000>;

66. interrupts = < 5 2 >;

67. };

68.  

69. i2c@1,0 {

70. compatible = "acme,a1234-i2c-bus";

71. #address-cells = <1>;

72. #size-cells = <0>;

73. reg = <1 0 0x1000>;

74. rtc@58 {

75. compatible = "maxim,ds1338";

76. reg = <58>;

77. interrupts = < 7 3 >;

78. };

79. };

80.  

81. flash@2,0 {

82. compatible = "samsung,k8f1315ebm", "cfi-flash";

83. reg = <2 0 0x4000000>;

84. };

85. };

86. };

上述.dts文件中,root结点"/"的compatible 属性compatible = "acme,coyotes-revenge";定义了系统的名称，它的组织形式为：<manufacturer>,<model>。Linux内核透过root结点"/"的compatible 属性即可判断它启动的是什么machine。

 

在.dts文件的每个设备，都有一个compatible属性，compatible属性用户驱动和设备的绑定。compatible 属性是一个字符串的列表，列表中的第一个字符串表征了结点代表的确切设备，形式为"<manufacturer>,<model>"，其后的字符串表征可兼容的其他设备。可以说前面的是特指，后面的则涵盖更广的范围。

如在arch/arm/boot/dts/vexpress-v2m.dtsi中的Flash结点：

 

 

1. flash@0,00000000 {

2. compatible = "arm,vexpress-flash", "cfi-flash";

3. reg = <0 0x00000000 0x04000000>,

4. <1 0x00000000 0x04000000>;

5. bank-width = <4>;

6. };

compatible属性的第2个字符串"cfi-flash"明显比第1个字符串"arm,vexpress-flash"涵盖的范围更广。

 

接下来root结点"/"的cpus子结点下面又包含2个cpu子结点，描述了此machine上的2个CPU，并且二者的compatible 属性为"arm,cortex-a9"。
注意cpus和cpus的2个cpu子结点的命名，它们遵循的组织形式为：<name>[@<unit-address>]，<>中的内容是必选项，[]中的则为可选项。name是一个ASCII字符串，用于描述结点对应的设备类型，如3com Ethernet适配器对应的结点name宜为ethernet，而不是3com509。如果一个结点描述的设备有地址，则应该给出@unit-address。多个相同类型设备结点的name可以一样，只要unit-address不同即可，如本例中含有cpu@0、cpu@1以及serial@101f0000与serial@101f2000这样的同名结点。设备的unit-address地址也经常在其对应结点的reg属性中给出。

reg的组织形式为reg = <address1 length1 [address2 length2][address3 length3] ... >，其中的每一组addresslength表明了设备使用的一个地址范围。address为1个或多个32位的整型（即cell），而length则为cell的列表或者为空（若#size-cells = 0）。address和length字段是可变长的，父结点的#address-cells和#size-cells分别决定了子结点的reg属性的address和length字段的长度。

 

在本例中，root结点的#address-cells = <1>;和#size-cells =<1>;决定了serial、gpio、spi等结点的address和length字段的长度分别为1。cpus 结点的#address-cells= <1>;和#size-cells =<0>;决定了2个cpu子结点的address为1，而length为空，于是形成了2个cpu的reg =<0>;和reg =<1>;。external-bus结点的#address-cells= <2>和#size-cells =<1>;决定了其下的ethernet、i2c、flash的reg字段形如reg = <0 00x1000>;、reg = <1 00x1000>;和reg = <2 00x4000000>;。其中，address字段长度为0，开始的第一个cell（0、1、2）是对应的片选，第2个cell（0，0，0）是相对该片选的基地址，第3个cell（0x1000、0x1000、0x4000000）为length。特别要留意的是i2c结点中定义的 #address-cells = <1>;和#size-cells =<0>;又作用到了I2C总线上连接的RTC，它的address字段为0x58，是设备的I2C地址。

root结点的子结点描述的是CPU的视图，因此root子结点的address区域就直接位于CPU的memory区域。但是，经过总线桥后的address往往需要经过转换才能对应的CPU的memory映射。external-bus的ranges属性定义了经过external-bus桥后的地址范围如何映射到CPU的memory区域。

1. ranges = <0 0 0x10100000 0x10000 // Chipselect 1, Ethernet

2. 1 0 0x10160000 0x10000 // Chipselect 2, i2c controller

3. 2 0 0x30000000 0x1000000>; // Chipselect 3, NOR Flash

ranges是地址转换表，其中的每个项目是一个子地址、父地址以及在子地址空间的大小的映射。映射表中的子地址、父地址分别采用子地址空间的#address-cells和父地址空间的#address-cells大小。对于本例而言，子地址空间的#address-cells为2，父地址空间的#address-cells值为1，因此0 0  0x10100000   0x10000的前2个cell为external-bus后片选0上偏移0，第3个cell表示external-bus后片选0上偏移0的地址空间被映射到CPU的0x10100000位置，第4个cell表示映射的大小为0x10000。ranges的后面2个项目的含义可以类推。

Device Tree中还可以中断连接信息，对于中断控制器而言，它提供如下属性：
interrupt-controller– 这个属性为空，中断控制器应该加上此属性表明自己的身份；
#interrupt-cells– 与#address-cells 和 #size-cells相似，它表明连接此中断控制器的设备的interrupts属性的cell大小。
在整个Device Tree中，与中断相关的属性还包括：
interrupt-parent– 设备结点透过它来指定它所依附的中断控制器的phandle，当结点没有指定interrupt-parent时，则从父级结点继承。对于本例而言，root结点指定了interrupt-parent= <&intc>;其对应于intc: interrupt-controller@10140000，而root结点的子结点并未指定interrupt-parent，因此它们都继承了intc，即位于0x10140000的中断控制器。

        interrupts – 用到了中断的设备结点透过它指定中断号、触发方法等，具体这个属性含有多少个cell，由它依附的中断控制器结点的#interrupt-cells属性决定。而具体每个cell又是什么含义，一般由驱动的实现决定，而且也会在Device Tree的binding文档中说明。

譬如，对于ARM GIC中断控制器而言，#interrupt-cells为3，它3个cell的具体含义kernel/Documentation/devicetree/bindings/arm/gic.txt就有如下文字说明：

PPI(Private peripheral interrupt)    SPI(Shared peripheral interrupt)

一个设备还可能用到多个中断号。对于ARM GIC而言，若某设备使用了SPI的168、169号2个中断，而言都是高电平触发，则该设备结点的interrupts属性可定义为：interrupts =<0 168 4>, <0 169 4>; 

4.dts引起BSP和driver的变更  

没有使用dts之前的BSP和driver 

 

使用dts之后的driver

 

 

 

针对上面的dts，注意一下几点：

1).rtk_gpio_ctl_mlk这个是node的名字，自己可以随便定义，当然最好是见名知意，可以通过驱动程序打印当前使用的设备树节点

        printk(“now dts node name is %s\n",pdev->dev.of_node->name);

2). compatible选项是用来和驱动程序中的of_match_table指针所指向的of_device_id结构里的compatible字段匹配的，只有dts里的compatible字段的名字和驱动程序中of_device_id里的compatible字段的名字一样，驱动程序才能进入probe函数

3).对于gpios这个字段，首先&rtk_iso_gpio指明了这个gpio是连接到的是rtk_iso_gpio,接着那个8是gpio number偏移量，它是以rtk_iso_gpiobase为基准的,紧接着那个0说明目前配置的gpio number 是设置成输入input,如果是1就是设置成输出output.最后一个字段1是指定这个gpio 默认为高电平，如果是0则是指定这个gpio默认为低电平

4).如果驱动里面只是利用compatible字段进行匹配进入probe函数，那么gpios 可以不需要，但是如果驱动程序里面是采用设备树相关的方法进行操作获取gpio  number,那么gpios这个字段必须使用。 gpios这个字段是由of_get_gpio_flags函数

默认指定的name.

获取gpio number的函数如下：

of_get_named_gpio_flags()

of_get_gpio_flags()    

注册i2c_board_info，指定IRQ等板级信息。

形如

1. static struct i2c_board_info __initdata afeb9260_i2c_devices[] = {

2. {

3. I2C_BOARD_INFO("tlv320aic23", 0x1a),

4. }, {

5. I2C_BOARD_INFO("fm3130", 0x68),

6. }, {

7. I2C_BOARD_INFO("24c64", 0x50),

8. }

9. }；

 

 之类的i2c_board_info代码，目前不再需要出现，现在只需要把tlv320aic23、fm3130、24c64这些设备结点填充作为相应的I2C controller结点的子结点即可，类似于前面的

 

1. i2c@1,0 {

2. compatible = "acme,a1234-i2c-bus";

3. …

4. rtc@58 {

5. compatible = "maxim,ds1338";

6. reg = <58>;

7. interrupts = < 7 3 >;

8. };

9. };

 

Device Tree中的I2C client会透过I2C host驱动的probe()函数中调用of_i2c_register_devices(&i2c_dev->adapter);被自动展开。

 

5.常见的DTS 函数

Linux内核中目前DTS相关的函数都是以of_前缀开头的，它们的实现位于内核源码的drivers/of下面

 void __iomem*of_iomap(struct device_node *node, int index)

 通过设备结点直接进行设备内存区间的 ioremap()，index是内存段的索引。若设备结点的reg属性有多段，可通过index标示要ioremap的是哪一段，只有1段的情况，index为0。采用Device Tree后，大量的设备驱动通过of_iomap()进行映射，而不再通过传统的ioremap。

1. int of_get_named_gpio_flags(struct device_node *np,const char *propname,

2. int index, enum of_gpio_flags *flags)

3.  

4. static inline int of_get_gpio_flags(structdevice_node *np, int index,

5. enum of_gpio_flags *flags)

6. {

7. return of_get_named_gpio_flags(np, "gpios", index,flags);

8. }

 

从设备树中读取相关GPIO的配置编号和标志,返回值为 gpio number

6.DTC (device tree compiler)

     将.dts编译为.dtb的工具。DTC的源代码位于内核的scripts/dtc目录，在Linux内核使能了Device Tree的情况下，编译内核的时候主机工具dtc会被编译出来，对应scripts/dtc/Makefile中的“hostprogs-y := dtc”这一hostprogs编译target。
在Linux内核的arch/arm/boot/dts/Makefile中，描述了当某种SoC被选中后，哪些.dtb文件会被编译出来，如与VEXPRESS对应的.dtb包括：
 

1. dtb-$(CONFIG_ARCH_VEXPRESS) += vexpress-v2p-ca5s.dtb \

2. vexpress-v2p-ca9.dtb \

3. vexpress-v2p-ca15-tc1.dtb \

4. vexpress-v2p-ca15_a7.dtb \

5. xenvm-4.2.dtb

 

在Linux下，我们可以单独编译Device Tree文件。当我们在Linux内核下运行make dtbs时，若我们之前选择了ARCH_VEXPRESS，上述.dtb都会由对应的.dts编译出来。因为arch/arm/Makefile中含有一个dtbs编译target项目。

DTS设备树的匹配过程

一个dts文件确定一个项目，多个项目可以包含同一个dtsi文件。找到该项目对应的dts文件即找到了该设备树的根节点。

 

kernel\arch\arm\boot\dts\qcom\sdm630-mtp.dts

1. /* Copyright (c) 2017, The Linux Foundation. All rights reserved.

2. *

3. * This program is free software; you can redistribute it and/or modify

4. * it under the terms of the GNU General Public License version 2 and

5. * only version 2 as published by the Free Software Foundation.

6. *

7. * This program is distributed in the hope that it will be useful,

8. * but WITHOUT ANY WARRANTY; without even the implied warranty of

9. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

10. * GNU General Public License for more details.

11. */

12.  
13.  

14. /dts-v1/;

15.  

16. #include "sdm630.dtsi"

17. #include "sdm630-mtp.dtsi"

18. //#include "sdm660-external-codec.dtsi"

19. #include "sdm660-internal-codec.dtsi"

20. #include "synaptics-dsx-i2c.dtsi"

21.  
22.  

23. / {

24. model = "Qualcomm Technologies, Inc. SDM 630 PM660 + PM660L MTP";

25. compatible = "qcom,sdm630-mtp", "qcom,sdm630", "qcom,mtp";

26. qcom,board-id = <8 0>;

27. qcom,pmic-id = <0x0001001b 0x0101011a 0x0 0x0>,

28. <0x0001001b 0x0201011a 0x0 0x0>;

29. };

30.  

31. &tavil_snd {

32. qcom,msm-mbhc-moist-cfg = <0>, <0>, <3>;

33. };

当然devicetree的根节点也是需要和板子进行匹配的，这个匹配信息存放在sbl（second boot loader）中，对应dts文件中描述的board-id（上面代码中的qcom,board-id属性），通过共享内存传递给bootloader，由bootloader将此board-id匹配dts文件（devicetree的根节点文件），将由dtc编译后的dts文件（dtb文件）加载到内存，然后在kernel中展开dts树，并且挂载dts树上的所有设备。

（ps：cat /proc/cmdline 查看cmdline）

 

Dts中相关符号的含义

/        根节点

@     如果设备有地址，则由此符号指定

&     引用节点

:        冒号前的label是为了方便引用给节点起的别名，此label一般使用为&label

,        属性名称中可以包含逗号。如compatible属性的名字 组成方式为"[manufacturer], [model]"，加入厂商名是为了避免重名。自定义属性名中通常也要有厂商名，并以逗号分隔。

# #并不表示注释。如 #address-cells ，#size-cells 用来决定reg属性的格式。

        空属性并不一定表示没有赋值。如 interrupt-controller 一个空属性用来声明这个node接收中断信号

数据类型

“”     引号中的为字符串，字符串数组：”strint1”,”string2”,”string3”

< >    尖括号中的为32位整形数字，整形数组<12 3 4>

[ ]      方括号中的为32位十六进制数，十六机制数据[0x11 0x12 0x13]  其中0x可省略

 

构成节点名的有效字符：

 

0-9

a-z

A-Z

,

.

_

+

-

构成属性名的有效字符：

 

0-9

a-z

A-Z

,

.

_

+

?

#

DTS中几个难理解的属性的解释

 

a. 地址

设备的地址特性根据一下几个属性来控制：

 

1. reg

2. #address-cells

3. #size-cells

 

reg意为region，区域。格式为：

 

reg = <address1length1 [address2 length2] [address3 length3]>;

父类的address-cells和size-cells决定了子类的相关属性要包含多少个cell，如果子节点有特殊需求的话，可以自己再定义，这样就可以摆脱父节点的控制。

 

address-cells决定了address1/2/3包含几个cell，size-cells决定了length1/2/3包含了几个cell。本地模块例如：

 

1. spi@10115000{

2. compatible = "arm,pl022";

3. reg = <0x10115000 0x1000 >;

4. };

 

位于0x10115000的SPI设备申请地址空间，起始地址为0x10115000，长度为0x1000，即属于这个SPI设备的地址范围是0x10115000~0x10116000。

实际应用中，有另外一种情况，就是通过外部芯片片选激活模块。例如，挂载在外部总线上，需要通过片选线工作的一些模块：

 

1. external-bus{

2. #address-cells = <2>

3. #size-cells = <1>;

4.  

5. ethernet@0,0 {

6. compatible = "smc,smc91c111";

7. reg = <0 0 0x1000>;

8. };

9.  

10. i2c@1,0 {

11. compatible ="acme,a1234-i2c-bus";

12. #address-cells = <1>;

13. #size-cells = <0>;

14. reg = <1 0 0x1000>;

15. rtc@58 {

16. compatible ="maxim,ds1338";

17. reg = <58>;

18. };

19. };

20.  

21. flash@2,0 {

22. compatible ="samsung,k8f1315ebm", "cfi-flash";

23. reg = <2 0 0x4000000>;

24. };

25. };

 

external-bus使用两个cell来描述地址，一个是片选序号，另一个是片选序号上的偏移量。而地址空间长度依然用一个cell来描述。所以以上的子设备们都需要3个cell来描述地址空间属性——片选、偏移量、地址长度。在上个例子中，有一个例外，就是i2c控制器模块下的rtc模块。因为I2C设备只是被分配在一个地址上，不需要其他任何空间，所以只需要一个address的cell就可以描述完整，不需要size-cells。

当需要描述的设备不是本地设备时，就需要描述一个从设备地址空间到CPU地址空间的映射关系，这里就需要用到ranges属性。还是以上边的external-bus举例：

 

1. #address-cells= <1>;

2. #size-cells= <1>;

3. ...

4. external-bus{

5. #address-cells = <2>

6. #size-cells = <1>;

7. ranges = <0 0 0x10100000 0x10000 // Chipselect 1,Ethernet

8. 1 0 0x10160000 0x10000 // Chipselect 2, i2c controller

9. 2 0 0x30000000 0x1000000>; // Chipselect 3, NOR Flash

10. };

 

ranges属性为一个地址转换表。表中的每一行都包含了子地址、父地址、在自地址空间内的区域大小。他们的大小（包含的cell）分别由子节点的address-cells的值、父节点的address-cells的值和子节点的size-cells来决定。以第一行为例：

·        0 0 两个cell，由子节点external-bus的address-cells=<2>决定；

·        0x10100000 一个cell，由父节点的address-cells=<1>决定；

·        0x10000 一个cell，由子节点external-bus的size-cells=<1>决定。
最终第一行说明的意思就是：片选0，偏移0（选中了网卡），被映射到CPU地址空间的0x10100000~0x10110000中，地址长度为0x10000。

b. 中断

描述中断连接需要四个属性：
1. interrupt-controller 一个空属性用来声明这个node接收中断信号；
2. #interrupt-cells 这是中断控制器节点的属性，用来标识这个控制器需要几个单位做中断描述符；
3. interrupt-parent 标识此设备节点属于哪一个中断控制器，如果没有设置这个属性，会自动依附父节点的；
4. interrupts 一个中断标识符列表，表示每一个中断输出信号。

如果有两个，第一个是中断号，第二个是中断类型，如高电平、低电平、边缘触发等触发特性。对于给定的中断控制器，应该仔细阅读相关文档来确定其中断标识该如何解析。一般如下：

 

二个cell的情况

第一个值： 该中断位于他的中断控制器的索引；

第二个值：触发的type

固定的取值如下：

        1 = low-to-high edge triggered
        2 = high-to-low edge triggered
        4 = active high level-sensitive
        8 = active low level-sensitive

 

三个cell的情况

第一个值：中断号

第二个值：触发的类型

第三个值：优先级，0级是最高的，7级是最低的；其中0级的中断系统当做 FIQ处理。

 

c. 其他

除了以上规则外，也可以自己加一些自定义的属性和子节点，但是一定要符合以下的几个规则：

1.    新的设备属性一定要以厂家名字做前缀，这样就可以避免他们会和当前的标准属性存在命名冲突问题；

2.    新加的属性具体含义以及子节点必须加以文档描述，这样设备驱动开发者就知道怎么解释这些数据了。描述文档中必须特别说明compatible的value的意义，应该有什么属性，可以有哪个（些）子节点，以及这代表了什么设备。每个独立的compatible都应该由单独的解释。

新添加的这些要发送到devicetree-discuss@lists.ozlabs.org邮件列表中进行review，并且检查是否会在将来引发其他的问题。
 

 

DTS设备树描述文件中什么代表总线，什么代表设备

一个含有compatible属性的节点就是一个设备。包含一组设备节点的父节点即为总线。

 

由DTS到device_register的过程

dts描述的设备树是如何通过register_device进行设备挂载的呢？我们来进行一下代码分析

 在arch/arm/mach-******/******.c找到DT_MACHINE_START 和 MACHINE_END 宏, 如下:

1. DT_MACHINE_START(******_DT, "************* SoC (Flattened DeviceTree)")

2. .atag_offset = 0x100,

3. .dt_compat =******_dt_compat, // 匹配dts

4. .map_io =******_map_io, // 板级地址内存映射, linux mmu

5. .init_irq =irqchip_init, // 板级中断初始化.

6. .init_time =******_timer_and_clk_init, // 板级时钟初始化,如ahb,apb等

7. .init_machine = ******_dt_init, // 这里是解析dts文件入口.

8. .restart =******_restart, // 重启, 看门狗寄存器相关可以在这里设置

9. MACHINE_END

其中.dt_compat    = ******_dt_compat 这个结构体是匹配是哪个dts文件, 如:

1. static const char * const ******_dt_compat[] = {

2. "******,******-soc",

3. NULL

4. };

这个"******,******-soc" 字符串可以在我们的dts的根节点下可以找到.

好了, 我们来看看init_machine   = ******_dt_init 这个回调函数.
1. arch/arm/mach-******/******.c : void __init ******_dt_init(void)
    ******_dt_init(void) --> of_platform_populate(NULL,of_default_bus_match_table, NULL, NULL);
    of_default_bus_match_table 这个是structof_device_id的全局变量.

1. const struct of_device_id of_default_bus_match_table[] = {

2. { .compatible = "simple-bus",},

3. #ifdef CONFIG_ARM_AMBA

4. { .compatible = "arm,amba-bus",},

5. #endif /* CONFIG_ARM_AMBA */

6. {} /* Empty terminated list */

7. };

 我们设计dts时, 把一些需要指定寄存器基地址的设备放到以compatible = "simple-bus"为匹配项的设备节点下. 下面会有介绍为什么.

2. drivers/of/platform.c : int of_platform_populate(...)
    of_platform_populate(...) --> of_platform_bus_create(...)
    // 在这之前, 会有of_get_property(bus,"compatible", NULL) 
    // 检查是否有compatible, 如果没有, 返回, 继续下一个, 也就是说没有compatible, 这个设备不会被注册

1. for_each_child_of_node(root, child) {

2. printk("[%s %s %d]child->name = %s, child->full_name = %s\n", __FILE__, __func__,__LINE__, child->name, child->full_name);

3. rc = of_platform_bus_create(child,matches, lookup, parent, true);

4. if (rc)

5. break;

6. }

    论询dts根节点下的子设备, 每个子设备都要of_platform_bus_create(...);
    全部完成后, 通过 of_node_put(root);释放根节点, 因为已经处理完毕;

3. drivers/of/platform.c : of_platform_bus_create(bus, ...)
  

1. dev = of_platform_device_create_pdata(bus, bus_id,platform_data, parent); // 我们跳到 3-1步去运行

2. if (!dev || !of_match_node(matches, bus)) // 就是匹配

3. // dt_compat = ******_dt_compat, 也就是 compatible = "simple-bus",

4. // 如果匹配成功, 以本节点为父节点, 继续轮询本节点下的所有子节点

5. return 0;

6.  

7. for_each_child_of_node(bus, child) {

8. pr_debug(" create child:%s\n", child->full_name);

9. rc = of_platform_bus_create(child,matches, lookup, &dev->dev, strict); // dev->dev以本节点为父节点, 我们跳到 3-2-1步去运行

10. if (rc) {

11. of_node_put(child);

12. break;

13. }

14. }

3-1. drivers/of/platform.c : of_platform_device_create_pdata(...)

1. if (!of_device_is_available(np)) // 查看节点是否有效, 如果节点有'status'属性, 必须是okay或者是ok, 才是有效, 没有'status'属性, 也有效

2. return NULL;

3.  

4. dev = of_device_alloc(np, bus_id, parent); // alloc设备, 设备初始化. 返回dev, 所有的设备都可认为是platform_device, 跳到3-1-1看看函数做了什么事情

5. if (!dev)

6. return NULL;

7.  

8. #if defined(CONFIG_MICROBLAZE)

9. dev->archdata.dma_mask = 0xffffffffUL;

10. #endif

11. dev->dev.coherent_dma_mask =DMA_BIT_MASK(32); // dev->dev 是 struct device. 继续初始化

12. dev->dev.bus =&platform_bus_type; //

13. dev->dev.platform_data =platform_data;

14.  

15. printk("[%s %s %d] of_device_add(device register)np->name = %s\n", __FILE__, __func__, __LINE__, np->name);

16. if (of_device_add(dev) != 0){ // 注册device,of_device_add(...) --> device_add(...) // This is part 2 ofdevice_register()

17. platform_device_put(dev);

18. return NULL;

19. }

3-1-1. drivers/of/platform.c : of_device_alloc(...)
    1) alloc platform_device *dev
    2) 如果有reg和interrupts的相关属性, 运行of_address_to_resource 和of_irq_to_resource_table, 加入到dev->resource

1. dev->num_resources = num_reg +num_irq;

2. dev->resource = res;

3. for (i = 0; i < num_reg; i++, res++) {

4. rc = of_address_to_resource(np,i, res);

5. /*printk("[%s %s %d] res->name = %s, res->start = 0x%X, res->end =0x%X\n", __FILE__, __func__, __LINE__, res->name, res->start,res->end); */

6. WARN_ON(rc);

7. }

8. WARN_ON(of_irq_to_resource_table(np, res,num_irq) != num_irq);

    3) dev->dev.of_node = of_node_get(np);  
        // 这个node属性里有compatible属性, 这个属性从dts来, 后续driver匹配device时, 就是通过这一属性进匹配 
        // 我们可以通过添加下面一句话来查看compatible.
        // printk("[%s %s %d]bus->name = %s, of_get_property(...) = %s\n", __FILE__, __func__,__LINE__, np->name, (char*)of_get_property(np, "compatible",NULL));
        // node 再给dev, 后续给驱动注册使用.
    4) 运行 of_device_make_bus_id 设定device的名字, 如: soc.2 或 ac000000.serial 等

3-2. drivers/of/platform.c : 
    以 compatible = "simple-bus"的节点的子节点都会以这个节点作为父节点在这步注册设备.

    至此从dts文件的解析到最终调用of_device_add进行设备注册的过程就比较清晰了。

 

查看挂载上的所有设备

cd /sys/devices/ 查看注册成功的设备  对应devicetree中的设备描述节点^-^

在前两篇中我们了解了DTS的背景基础知识以及发挥作用的流程，这篇文章我们以高通的MSM8953平台为例来添加一个基础的i2c设备（包含一个gpio中断）。

1，首先我们在该i2c设备的驱动中找到了匹配设备与驱动程序的compatible

 

1. static const struct of_device_id iqs263_of_match[] = {

2. { .compatible = "azopteq,iqs263", },

3. { },

4. };

2，由此compatible可以找到dts中对应的设备

 

kernel\arch\arm64\boot\dts\qcom\msm8953-mtp.dts

 

1. &i2c_8 { /* BLSP2 QUP4 */

2. iqs263@44 { //Capacitive Touch Controller Driver

3. compatible = "azopteq,iqs263";

4. reg = <0x44>;

5.  

6. pinctrl-names = "default";

7. pinctrl-0 = <&iqs263_irq_config>;

8.  

9. vdd-supply = <&pm8953_l5>;

10. vio-supply = <&pm8953_l5>;

11. interrupt-parent = <&tlmm>;

12. interrupts = <48 0x2>;

13. azopteq,irq-gpio =<&tlmm 48 0x2>;

14. };

15. };

 

2.1，其中compatible属性标识的名字是与驱动程序中名字相匹配的

2.2，其中reg属性及@符号后的十六进制数字标识了该设备iqs263的i2c地址为0x44

2.3，&i2c_8前的&表明此处仅仅是对i2c_8节点的补充，我们可以找到该节点定义的地方

kernel\arch\arm64\boot\dts\qcom\msm8953.dtsi

 

1. &soc {

2. i2c_8: i2c@7af8000 { /* BLSP2 QUP4 */

3. compatible = "qcom,i2c-msm-v2";

4. #address-cells = <1>;

5. #size-cells = <0>;

6. reg-names = "qup_phys_addr";

7. reg = <0x7af8000 0x600>;

8. interrupt-names = "qup_irq";

9. interrupts = <0 302 0>;

10. qcom,clk-freq-out = <400000>;

11. qcom,clk-freq-in = <19200000>;

12. clock-names = "iface_clk", "core_clk";

13. clocks = <&clock_gcc clk_gcc_blsp2_ahb_clk>,

14. <&clock_gcc clk_gcc_blsp2_qup4_i2c_apps_clk>;

15.  

16. pinctrl-names = "i2c_active", "i2c_sleep";

17. pinctrl-0 = <&i2c_8_active>;

18. pinctrl-1 = <&i2c_8_sleep>;

19. qcom,noise-rjct-scl = <0>;

20. qcom,noise-rjct-sda = <0>;

21. qcom,master-id = <84>;

22. dmas = <&dma_blsp2 10 64 0x20000020 0x20>,

23. <&dma_blsp2 11 32 0x20000020 0x20>;

24. dma-names = "tx", "rx";

25. };

26. rpm_bus: qcom,rpm-smd {

27. compatible = "qcom,rpm-smd";

28. rpm-channel-name = "rpm_requests";

29. rpm-channel-type = <15>; /* SMD_APPS_RPM */

30. };

这当中的大部分属性都与平台相关了，可以看到定义了该i2c接口的时钟源、中断格式等。这部分一般由平台提供，作为驱动工程师了解即可。

 

2.3.1，i2c_8节点中的pinctrl-0指向了定义其io口的节点i2c_8_active和i2c_8_sleep，代码如下可见该i2c的IO口为Gpio98和Gpio99

kernel\arch\arm64\boot\dts\qcom\msm8953-pinctrl.dtsi

 

1. &soc {

2. tlmm: pinctrl@1000000 {

3. i2c_8 {

4. i2c_8_active: i2c_8_active {

5. /* active state */

6. mux {

7. pins = "gpio98", "gpio99";

8. function = "blsp_i2c8";

9. };

10.  

11. config {

12. pins = "gpio98", "gpio99";

13. drive-strength = <2>;

14. bias-disable;

15. };

16. };

17.  

18. i2c_8_sleep: i2c_8_sleep {

19. /* suspended state */

20. mux {

21. pins = "gpio98", "gpio99";

22. function = "gpio";

23. };

24.  

25. config {

26. pins = "gpio98", "gpio99";

27. drive-strength = <2>;

28. bias-disable;

29. };

30. };

31. };

32.  

33. iqs263_irq_config: iqs263_irq_config {

34. mux {

35. pins = "gpio48";

36. function = "gpio";

37. };

38.  

39. config {

40. pins = "gpio48";

41. drive-strength = <2>;

42. bias-pull-up;

43. };

44. };

 

 

2.4，iqs263节点中的pinctrl-0 属性指向了表明其io口属性的节点为iqs263_irq_config，相关代码也在2.3.1指示的msm8953-pinctrl.dtsi文件中。

其中定义了iqs263的中断IO脚为Gpio48

 

2.5，iqs263节点中的vdd-supply，vio-supply属性指示了表明iqs263芯片供电的引脚的节点pm8953_l5，代码如下

kernel\arch\arm64\boot\dts\qcom\msm8953-regulator.dtsi

 

1. &rpm_bus {

2. rpm-regulator-ldoa5 {

3. status = "okay";

4. pm8953_l5: regulator-l5 {

5. regulator-min-microvolt = <1800000>;

6. regulator-max-microvolt = <1800000>;

7. qcom,init-voltage = <1800000>;

8. status = "okay";

9. };

10. };

2.6，iqs263的interrupts = <48 0x2>属性表明中断号为48,2代表下降沿触发。相关知识可以参考：Linux DTS(Device Tree Source)设备树详解之二(dts匹配及发挥作用的流程篇)