linux裝置樹中的dts與dtsi
1. ARM Device Tree起源
Linus Torvalds在2011年3月17日的ARM Linux郵件列表宣稱“this whole ARM thing is a f*cking pain in the ass”，引發ARM Linux社群的地震，隨後ARM社群進行了一系列的重大修正。在過去的ARM Linux中，arch/arm/plat-xxx和arch/arm/mach-xxx中充斥著大量的垃圾程式碼，相當多數的程式碼只是在描述板級細節，而這些板級細節對於核心來講，不過是垃圾，如板上的platform裝置、resource、i2c_board_info、spi_board_info以及各種硬體的platform_data。讀者有興趣可以統計下常見的s3c2410、s3c6410等板級目錄，程式碼量在數萬行。
社群必須改變這種局面，於是PowerPC等其他體系架構下已經使用的Flattened Device Tree（FDT）進入ARM社群的視野。Device Tree是一種描述硬體的資料結構，它起源於 OpenFirmware (OF)。在Linux 2.6中，ARM架構的板極硬體細節過多地被硬編碼在arch/arm/plat-xxx和arch/arm/mach-xxx，採用Device Tree後，許多硬體的細節可以直接透過它傳遞給Linux，而不再需要在kernel中進行大量的冗餘編碼。
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等資源，也被傳遞給了核心，核心會將這些資源繫結給展開的相應的裝置。
2. Device Tree組成和結構
整個Device Tree牽涉面比較廣，即增加了新的用於描述裝置硬體資訊的文字格式，又增加了編譯這一文字的工具，同時Bootloader也需要支援將編譯後的Device Tree傳遞給Linux核心。
DTS (device tree source)
.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。譬如，對於VEXPRESS而言，vexpress-v2m.dtsi就被vexpress-v2p-ca9.dts所引用， vexpress-v2p-ca9.dts有如下一行：
/include/ "vexpress-v2m.dtsi"
當然，和C語言的標頭檔案類似，.dtsi也可以include其他的.dtsi，譬如幾乎所有的ARM SoC的.dtsi都引用了skeleton.dtsi。
.dts（或者其include的.dtsi）基本元素即為前文所述的結點和屬性：
/ {
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 {
};
};
}; 上述.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控制器（位於0x10170000）、中斷控制器（位於0x10140000）和一個external bus橋；
External bus橋上又連線了SMC SMC91111 Ethernet（位於0x10100000）、I2C控制器（位於0x10160000）、64MB NOR Flash（位於0x30000000）；
External bus橋上連線的I2C控制器所對應的I2C總線上又連線了Maxim DS1338實時鐘（I2C地址為0x58）。
其對應的.dts檔案為：
/ {
compatible = "acme,coyotes-revenge";
#address-cells = <1>;
#size-cells = <1>;
interrupt-parent = <&intc>;
cpus {
#address-cells = <1>;
#size-cells = <0>;
[email protected] {
compatible = "arm,cortex-a9";
reg = <0>;
};
[email protected] {
compatible = "arm,cortex-a9";
reg = <1>;
};
};
[email protected] {
compatible = "arm,pl011";
reg = <0x101f0000 0x1000 >;
interrupts = < 1 0 >;
};
[email protected] {
compatible = "arm,pl011";
reg = <0x101f2000 0x1000 >;
interrupts = < 2 0 >;
};
[email protected] {
compatible = "arm,pl061";
reg = <0x101f3000 0x1000
0x101f4000 0x0010>;
interrupts = < 3 0 >;
};
intc: [email protected] {
compatible = "arm,pl190";
reg = <0x10140000 0x1000 >;
interrupt-controller;
#interrupt-cells = <2>;
};
[email protected] {
compatible = "arm,pl022";
reg = <0x10115000 0x1000 >;
interrupts = < 4 0 >;
};
external-bus {
#address-cells = <2>
#size-cells = <1>;
ranges = <0 0 0x10100000 0x10000 // Chipselect 1, Ethernet
1 0 0x10160000 0x10000 // Chipselect 2, i2c controller
2 0 0x30000000 0x1000000>; // Chipselect 3, NOR Flash
[email protected],0 {
compatible = "smc,smc91c111";
reg = <0 0 0x1000>;
interrupts = < 5 2 >;
};
[email protected],0 {
compatible = "acme,a1234-i2c-bus";
#address-cells = <1>;
#size-cells = <0>;
reg = <1 0 0x1000>;
interrupts = < 6 2 >;
[email protected] {
compatible = "maxim,ds1338";
reg = <58>;
interrupts = < 7 3 >;
};
};
[email protected],0 {
compatible = "samsung,k8f1315ebm", "cfi-flash";
reg = <2 0 0x4000000>;
};
};
}; 上述.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結點：
[email protected],00000000 {
compatible = "arm,vexpress-flash", "cfi-flash";
reg = <0 0x00000000 0x04000000>,
<1 0x00000000 0x04000000>;
bank-width = <4>;
}; compatible屬性的第2個字串"cfi-flash"明顯比第1個字串"arm,vexpress-flash"涵蓋的範圍更廣。
再比如，Freescale MPC8349 SoC含一個串列埠裝置，它實現了國家半導體（National Semiconductor）的ns16550 暫存器介面。則MPC8349串列埠裝置的compatible屬性為compatible = "fsl,mpc8349-uart", "ns16550"。其中，fsl,mpc8349-uart指代了確切的裝置， ns16550代表該裝置與National Semiconductor 的16550 UART保持了暫存器相容。
接下來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不同即可，如本例中含有[email protected]、[email protected]以及[email protected]與[email protected]這樣的同名結點。裝置的unit-address地址也經常在其對應結點的reg屬性中給出。ePAPR標準給出了結點命名的規範。
可定址的裝置使用如下資訊來在Device Tree中編碼地址資訊：
reg
#address-cells
#size-cells其中reg的組織形式為reg = <address1 length1 [address2 length2] [address3 length3] ... >，其中的每一組address length表明了裝置使用的一個地址範圍。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 0 0x1000>;、reg = <1 0 0x1000>;和reg = <2 0 0x4000000>;。其中，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區域。
ranges = <0 0 0x10100000 0x10000 // Chipselect 1, Ethernet
1 0 0x10160000 0x10000 // Chipselect 2, i2c controller
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: [email protected]，而root結點的子結點並未指定interrupt-parent，因此它們都繼承了intc，即位於0x10140000的中斷控制器。
interrupts – 用到了中斷的裝置結點透過它指定中斷號、觸發方法等，具體這個屬性含有多少個cell，由它依附的中斷控制器結點的#interrupt-cells屬性決定。而具體每個cell又是什麼含義，一般由驅動的實現決定，而且也會在Device Tree的binding文件中說明。譬如，對於ARM GIC中斷控制器而言，#interrupt-cells為3，它3個cell的具體含義Documentation/devicetree/bindings/arm/gic.txt就有如下文字說明：
The 1st cell is the interrupt type; 0 for SPI interrupts, 1 for PPI
interrupts.
The 2nd cell contains the interrupt number for the interrupt type.
SPI interrupts are in the range [0-987]. PPI interrupts are in the
range [0-15].
The 3rd cell is the flags, encoded as follows:
bits[3:0] trigger type and level flags.
1 = low-to-high edge triggered
2 = high-to-low edge triggered
4 = active high level-sensitive
8 = active low level-sensitive
bits[15:8] PPI interrupt cpu mask. Each bit corresponds to each of
the 8 possible cpus attached to the GIC. A bit set to '1' indicated
the interrupt is wired to that CPU. Only valid for PPI interrupts. 另外，值得注意的是，一個裝置還可能用到多箇中斷號。對於ARM GIC而言，若某裝置使用了SPI的168、169號2箇中斷，而言都是高電平觸發，則該裝置結點的interrupts屬性可定義為：interrupts = <0 168 4>, <0 169 4>;
除了中斷以外，在ARM Linux中clock、GPIO、pinmux都可以透過.dts中的結點和屬性進行描述。
文章內容來源於：