Linux DTS(Device Tree Source)裝置樹詳解之一(背景基礎知識篇)
阿新 • • 發佈：2019-01-09
本系列導航：
一.什麼是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）標識，節點名字的格式是[email protected]。如果該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的組成結構
/ {
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控制器（位於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檔案為：
/ {
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>;
[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"涵蓋的範圍更廣。
接下來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屬性中給出。
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區域。
ranges = <0 0 0x10100000 0x10000 // Chipselect 1, Ethernet
1 0 0x10160000 0x10000 // Chipselect 2, i2c controller
2 0 0x30000000 0x1000000>; // Chipselect 3, NOR Flashranges是地址轉換表，其中的每個專案是一個子地址、父地址以及在子地址空間的大小的對映。對映表中的子地址、父地址分別採用子地址空間的#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的具體含義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等板級資訊。
形如
static struct i2c_board_info __initdata afeb9260_i2c_devices[] = {
{
I2C_BOARD_INFO("tlv320aic23", 0x1a),
}, {
I2C_BOARD_INFO("fm3130", 0x68),
}, {
I2C_BOARD_INFO("24c64", 0x50),
}
}；之類的i2c_board_info程式碼，目前不再需要出現，現在只需要把tlv320aic23、fm3130、24c64這些裝置結點填充作為相應的I2C controller結點的子結點即可，類似於前面的
[email protected],0 {
compatible = "acme,a1234-i2c-bus";
…
[email protected] {
compatible = "maxim,ds1338";
reg = <58>;
interrupts = < 7 3 >;
};
}; 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。
int of_get_named_gpio_flags(struct device_node *np,const char *propname,
int index, enum of_gpio_flags *flags)
static inline int of_get_gpio_flags(structdevice_node *np, int index,
enum of_gpio_flags *flags)
{
return of_get_named_gpio_flags(np, "gpios", index,flags);
}從裝置樹中讀取相關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包括：
dtb-$(CONFIG_ARCH_VEXPRESS) += vexpress-v2p-ca5s.dtb \
vexpress-v2p-ca9.dtb \
vexpress-v2p-ca15-tc1.dtb \
vexpress-v2p-ca15_a7.dtb \
xenvm-4.2.dtb