Linux DTS(Device Tree Source)設備樹詳解之一(背景基礎知識篇)

一.什么是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的組成結構

[objc] view plain copy

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文件為：

[objc] view plain copy

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";定義了系統的名稱，它的組織形式 為：,。Linux內核透過root結點"/"的compatible 屬性即可判斷它啟動的是什么machine。

在.dts文件的每個設備，都有一個compatible屬性，compatible屬性用戶驅動和設備的綁定。compatible 屬性是一個字符串的列表，列表中的第一個字符串表征了結點代表的確切設備，形式為","，其后的字符串表征可兼容的其他設備。可以說前面的是特指，后面的則涵蓋更廣的范圍。

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

[objc] view plain copy

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是一個ASCII字符串，用於描述結點對應的設備類型，如 3com Ethernet適配器對應的結點name宜為ethernet，而不是3com509。如果一個結點描述的設備有地址，則應該給出@unit-address。多個相同類型設備結點的name可以一樣，只要unit-address不同即可，如本例中含有cpu@0、cpu@1以及serial@101f0000與serial@101f2000這樣的同名結點。設備的unit-address地址也經常在其對應結點的reg屬性中給出。

reg的組織形式為reg = ，其中的每一組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區域。

[objc] view plain copy

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等板級信息。

形如

[objc] view plain copy

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結點的子結點即可，類似於前面的

[objc] view plain copy

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。

[objc] view plain copy

1. int of_get_named_gpio_flags(struct device_node *np,const charchar *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包括：
 

[objc] view plain copy

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項目。