轉自：https://blog.csdn.net/wdjjwb/article/details/77297372
一.什么是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的組成結構
- / {
- 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>;
- cpu@0 {
- compatible = "arm,cortex-a9";
- reg = <0>;
- };
- cpu@1 {
- compatible = "arm,cortex-a9";
- reg = <1>;
- };
- };
- serial@101f0000 {
- compatible = "arm,pl011";
- reg = <0x101f0000 0x1000 >;
- interrupts = < 1 0 >;
- };
- serial@101f2000 {
- compatible = "arm,pl011";
- reg = <0x101f2000 0x1000 >;
- interrupts = < 2 0 >;
- };
- gpio@101f3000 {
- compatible = "arm,pl061";
- reg = <0x101f3000 0x1000
- 0x101f4000 0x0010>;
- interrupts = < 3 0 >;
- };
- intc: interrupt-controller@10140000 {
- compatible = "arm,pl190";
- reg = <0x10140000 0x1000 >;
- interrupt-controller;
- #interrupt-cells = <2>;
- };
- spi@10115000 {
- 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
- ethernet@0,0 {
- compatible = "smc,smc91c111";
- reg = <0 0 0x1000>;
- interrupts = < 5 2 >;
- };
- i2c@1,0 {
- compatible = "acme,a1234-i2c-bus";
- #address-cells = <1>;
- #size-cells = <0>;
- reg = <1 0 0x1000>;
- rtc@58 {
- compatible = "maxim,ds1338";
- reg = <58>;
- interrupts = < 7 3 >;
- };
- };
- flash@2,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結點：
- flash@0,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不同即可，如本例中含有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區域。
- 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: 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等板級信息。
形如
- 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結點的子結點即可，類似於前面的
- i2c@1,0 {
- compatible = "acme,a1234-i2c-bus";
- …
- rtc@58 {
- 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 charchar *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
在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
- /* Copyright (c) 2017, The Linux Foundation. All rights reserved.
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License version 2 and
- * only version 2 as published by the Free Software Foundation.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- */
- /dts-v1/;
- #include "sdm630.dtsi"
- #include "sdm630-mtp.dtsi"
- //#include "sdm660-external-codec.dtsi"
- #include "sdm660-internal-codec.dtsi"
- #include "synaptics-dsx-i2c.dtsi"
- / {
- model = "Qualcomm Technologies, Inc. SDM 630 PM660 + PM660L MTP";
- compatible = "qcom,sdm630-mtp", "qcom,sdm630", "qcom,mtp";
- qcom,board-id = <8 0>;
- qcom,pmic-id = <0x0001001b 0x0101011a 0x0 0x0>,
- <0x0001001b 0x0201011a 0x0 0x0>;
- };
- &tavil_snd {
- qcom,msm-mbhc-moist-cfg = <0>, <0>, <3>;
- };
當然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. 地址
設備的地址特性根據一下幾個屬性來控制：
- reg
- #address-cells
- #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。本地模塊例如：
- spi@10115000{
- compatible = "arm,pl022";
- reg = <0x10115000 0x1000 >;
- };
位於0x10115000的SPI設備申請地址空間，起始地址為0x10115000，長度為0x1000，即屬於這個SPI設備的地址范圍是0x10115000~0x10116000。
實際應用中，有另外一種情況，就是通過外部芯片片選激活模塊。例如，掛載在外部總線上，需要通過片選線工作的一些模塊：
- external-bus{
- #address-cells = <2>
- #size-cells = <1>;
- ethernet@0,0 {
- compatible = "smc,smc91c111";
- reg = <0 0 0x1000>;
- };
- i2c@1,0 {
- compatible ="acme,a1234-i2c-bus";
- #address-cells = <1>;
- #size-cells = <0>;
- reg = <1 0 0x1000>;
- rtc@58 {
- compatible ="maxim,ds1338";
- reg = <58>;
- };
- };
- flash@2,0 {
- compatible ="samsung,k8f1315ebm", "cfi-flash";
- reg = <2 0 0x4000000>;
- };
- };
external-bus使用兩個cell來描述地址，一個是片選序號，另一個是片選序號上的偏移量。而地址空間長度依然用一個cell來描述。所以以上的子設備們都需要3個cell來描述地址空間屬性——片選、偏移量、地址長度。在上個例子中，有一個例外，就是i2c控制器模塊下的rtc模塊。因為I2C設備只是被分配在一個地址上，不需要其他任何空間，所以只需要一個address的cell就可以描述完整，不需要size-cells。
當需要描述的設備不是本地設備時，就需要描述一個從設備地址空間到CPU地址空間的映射關系，這里就需要用到ranges屬性。還是以上邊的external-bus舉例：
- #address-cells= <1>;
- #size-cells= <1>;
- ...
- 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
- };
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。
描述中斷連接需要四個屬性：
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處理。
除了以上規則外，也可以自己加一些自定義的屬性和子節點，但是一定要符合以下的幾個規則：
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 宏, 如下:
- DT_MACHINE_START(******_DT, "************* SoC (Flattened DeviceTree)")
- .atag_offset = 0x100,
- .dt_compat =******_dt_compat, // 匹配dts
- .map_io =******_map_io, // 板級地址內存映射, linux mmu
- .init_irq =irqchip_init, // 板級中斷初始化.
- .init_time =******_timer_and_clk_init, // 板級時鍾初始化,如ahb,apb等
- .init_machine = ******_dt_init, // 這里是解析dts文件入口.
- .restart =******_restart, // 重啟, 看門狗寄存器相關可以在這里設置
- MACHINE_END
- static const charchar * constconst ******_dt_compat[] = {
- "******,******-soc",
- NULL
- };
好了, 我們來看看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的全局變量.
- const struct of_device_id of_default_bus_match_table[] = {
- { .compatible = "simple-bus",},
- #ifdef CONFIG_ARM_AMBA
- { .compatible = "arm,amba-bus",},
- #endif /* CONFIG_ARM_AMBA */
- {} /* Empty terminated list */
- };
2. drivers/of/platform.c : int of_platform_populate(...)
of_platform_populate(...) --> of_platform_bus_create(...)
// 在這之前, 會有of_get_property(bus,"compatible", NULL)
// 檢查是否有compatible, 如果沒有, 返回, 繼續下一個, 也就是說沒有compatible, 這個設備不會被注冊
- for_each_child_of_node(root, child) {
- printk("[%s %s %d]child->name = %s, child->full_name = %s\n", __FILE__, __func__,__LINE__, child->name, child->full_name);
- rc = of_platform_bus_create(child,matches, lookup, parent, true);
- if (rc)
- break;
- }
全部完成后, 通過 of_node_put(root);釋放根節點, 因為已經處理完畢;
3. drivers/of/platform.c : of_platform_bus_create(bus, ...)
- dev = of_platform_device_create_pdata(bus, bus_id,platform_data, parent); // 我們跳到 3-1步去運行
- if (!dev || !of_match_node(matches, bus)) // 就是匹配
- // dt_compat = ******_dt_compat, 也就是 compatible = "simple-bus",
- // 如果匹配成功, 以本節點為父節點, 繼續輪詢本節點下的所有子節點
- return 0;
- for_each_child_of_node(bus, child) {
- pr_debug(" create child:%s\n", child->full_name);
- rc = of_platform_bus_create(child,matches, lookup, &dev->dev, strict); // dev->dev以本節點為父節點, 我們跳到 3-2-1步去運行
- if (rc) {
- of_node_put(child);
- break;
- }
- }
- if (!of_device_is_available(np)) // 查看節點是否有效, 如果節點有'status'屬性, 必須是okay或者是ok, 才是有效, 沒有'status'屬性, 也有效
- return NULL;
- dev = of_device_alloc(np, bus_id, parent); // alloc設備, 設備初始化. 返回dev, 所有的設備都可認為是platform_device, 跳到3-1-1看看函數做了什么事情
- if (!dev)
- return NULL;
- #if defined(CONFIG_MICROBLAZE)
- dev->archdata.dma_mask = 0xffffffffUL;
- #endif
- dev->dev.coherent_dma_mask =DMA_BIT_MASK(32); // dev->dev 是 struct device. 繼續初始化
- dev->dev.bus =&platform_bus_type; //
- dev->dev.platform_data =platform_data;
- printk("[%s %s %d] of_device_add(device register)np->name = %s\n", __FILE__, __func__, __LINE__, np->name);
- if (of_device_add(dev) != 0){ // 注冊device,of_device_add(...) --> device_add(...) // This is part 2 ofdevice_register()
- platform_device_put(dev);
- return NULL;
- }
1) alloc platform_device *dev
2) 如果有reg和interrupts的相關屬性, 運行of_address_to_resource 和of_irq_to_resource_table, 加入到dev->resource
- dev->num_resources = num_reg +num_irq;
- dev->resource = res;
- for (i = 0; i < num_reg; i++, res++) {
- rc = of_address_to_resource(np,i, res);
- /*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); */
- WARN_ON(rc);
- }
- WARN_ON(of_irq_to_resource_table(np, res,num_irq) != num_irq);
// 這個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設備樹的匹配過程
一個dts文件確定一個項目，多個項目可以包含同一個dtsi文件。找到該項目對應的dts文件即找到了該設備樹的根節點。
kernel\arch\arm\boot\dts\qcom\sdm630-mtp.dts
- /* Copyright (c) 2017, The Linux Foundation. All rights reserved.
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License version 2 and
- * only version 2 as published by the Free Software Foundation.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- */
- /dts-v1/;
- #include "sdm630.dtsi"
- #include "sdm630-mtp.dtsi"
- //#include "sdm660-external-codec.dtsi"
- #include "sdm660-internal-codec.dtsi"
- #include "synaptics-dsx-i2c.dtsi"
- / {
- model = "Qualcomm Technologies, Inc. SDM 630 PM660 + PM660L MTP";
- compatible = "qcom,sdm630-mtp", "qcom,sdm630", "qcom,mtp";
- qcom,board-id = <8 0>;
- qcom,pmic-id = <0x0001001b 0x0101011a 0x0 0x0>,
- <0x0001001b 0x0201011a 0x0 0x0>;
- };
- &tavil_snd {
- qcom,msm-mbhc-moist-cfg = <0>, <0>, <3>;
- };
當然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. 地址
設備的地址特性根據一下幾個屬性來控制：
- reg
- #address-cells
- #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。本地模塊例如：
- spi@10115000{
- compatible = "arm,pl022";
- reg = <0x10115000 0x1000 >;
- };
位於0x10115000的SPI設備申請地址空間，起始地址為0x10115000，長度為0x1000，即屬於這個SPI設備的地址范圍是0x10115000~0x10116000。
實際應用中，有另外一種情況，就是通過外部芯片片選激活模塊。例如，掛載在外部總線上，需要通過片選線工作的一些模塊：
- external-bus{
- #address-cells = <2>
- #size-cells = <1>;
- ethernet@0,0 {
- compatible = "smc,smc91c111";
- reg = <0 0 0x1000>;
- };
- i2c@1,0 {
- compatible ="acme,a1234-i2c-bus";
- #address-cells = <1>;
- #size-cells = <0>;
- reg = <1 0 0x1000>;
- rtc@58 {
- compatible ="maxim,ds1338";
- reg = <58>;
- };
- };
- flash@2,0 {
- compatible ="samsung,k8f1315ebm", "cfi-flash";
- reg = <2 0 0x4000000>;
- };
- };
external-bus使用兩個cell來描述地址，一個是片選序號，另一個是片選序號上的偏移量。而地址空間長度依然用一個cell來描述。所以以上的子設備們都需要3個cell來描述地址空間屬性——片選、偏移量、地址長度。在上個例子中，有一個例外，就是i2c控制器模塊下的rtc模塊。因為I2C設備只是被分配在一個地址上，不需要其他任何空間，所以只需要一個address的cell就可以描述完整，不需要size-cells。
當需要描述的設備不是本地設備時，就需要描述一個從設備地址空間到CPU地址空間的映射關系，這里就需要用到ranges屬性。還是以上邊的external-bus舉例：
- #address-cells= <1>;
- #size-cells= <1>;
- ...
- 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
- };
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。
描述中斷連接需要四個屬性：
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處理。
除了以上規則外，也可以自己加一些自定義的屬性和子節點，但是一定要符合以下的幾個規則：
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 宏, 如下:
- DT_MACHINE_START(******_DT, "************* SoC (Flattened DeviceTree)")
- .atag_offset = 0x100,
- .dt_compat =******_dt_compat, // 匹配dts
- .map_io =******_map_io, // 板級地址內存映射, linux mmu
- .init_irq =irqchip_init, // 板級中斷初始化.
- .init_time =******_timer_and_clk_init, // 板級時鍾初始化,如ahb,apb等
- .init_machine = ******_dt_init, // 這里是解析dts文件入口.
- .restart =******_restart, // 重啟, 看門狗寄存器相關可以在這里設置
- MACHINE_END
- static const charchar * constconst ******_dt_compat[] = {
- "******,******-soc",
- NULL
- };
好了, 我們來看看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的全局變量.
- const struct of_device_id of_default_bus_match_table[] = {
- { .compatible = "simple-bus",},
- #ifdef CONFIG_ARM_AMBA
- { .compatible = "arm,amba-bus",},
- #endif /* CONFIG_ARM_AMBA */
- {} /* Empty terminated list */
- };
2. drivers/of/platform.c : int of_platform_populate(...)
of_platform_populate(...) --> of_platform_bus_create(...)
// 在這之前, 會有of_get_property(bus,"compatible", NULL)
// 檢查是否有compatible, 如果沒有, 返回, 繼續下一個, 也就是說沒有compatible, 這個設備不會被注冊
- for_each_child_of_node(root, child) {
- printk("[%s %s %d]child->name = %s, child->full_name = %s\n", __FILE__, __func__,__LINE__, child->name, child->full_name);
- rc = of_platform_bus_create(child,matches, lookup, parent, true);
- if (rc)
- break;
- }
全部完成后, 通過 of_node_put(root);釋放根節點, 因為已經處理完畢;
3. drivers/of/platform.c : of_platform_bus_create(bus, ...)
- dev = of_platform_device_create_pdata(bus, bus_id,platform_data, parent); // 我們跳到 3-1步去運行
- if (!dev || !of_match_node(matches, bus)) // 就是匹配
- // dt_compat = ******_dt_compat, 也就是 compatible = "simple-bus",
- // 如果匹配成功, 以本節點為父節點, 繼續輪詢本節點下的所有子節點
- return 0;
- for_each_child_of_node(bus, child) {
- pr_debug(" create child:%s\n", child->full_name);
- rc = of_platform_bus_create(child,matches, lookup, &dev->dev, strict); // dev->dev以本節點為父節點, 我們跳到 3-2-1步去運行
- if (rc) {
- of_node_put(child);
- break;
- }
- }
- if (!of_device_is_available(np)) // 查看節點是否有效, 如果節點有'status'屬性, 必須是okay或者是ok, 才是有效, 沒有'status'屬性, 也有效
- return NULL;
- dev = of_device_alloc(np, bus_id, parent); // alloc設備, 設備初始化. 返回dev, 所有的設備都可認為是platform_device, 跳到3-1-1看看函數做了什么事情
- if (!dev)
- return NULL;
- #if defined(CONFIG_MICROBLAZE)
- dev->archdata.dma_mask = 0xffffffffUL;
- #endif
- dev->dev.coherent_dma_mask =DMA_BIT_MASK(32); // dev->dev 是 struct device. 繼續初始化
- dev->dev.bus =&platform_bus_type; //
- dev->dev.platform_data =platform_data;
- printk("[%s %s %d] of_device_add(device register)np->name = %s\n", __FILE__, __func__, __LINE__, np->name);
- if (of_device_add(dev) != 0){ // 注冊device,of_device_add(...) --> device_add(...) // This is part 2 ofdevice_register()
- platform_device_put(dev);
- return NULL;
- }
1) alloc platform_device *dev
2) 如果有reg和interrupts的相關屬性, 運行of_address_to_resource 和of_irq_to_resource_table, 加入到dev->resource
- dev->num_resources = num_reg +num_irq;
- dev->resource = res;
- for (i = 0; i < num_reg; i++, res++) {
- rc = of_address_to_resource(np,i, res);
- /*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); */
- WARN_ON(rc);
- }
- WARN_ON(of_irq_to_resource_table(np, res,num_irq) != num_irq);
// 這個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
- static const struct of_device_id iqs263_of_match[] = {
- { .compatible = "azopteq,iqs263", },
- { },
- };
kernel\arch\arm64\boot\dts\qcom\msm8953-mtp.dts
- &i2c_8 { /* BLSP2 QUP4 */
- iqs263@44 { //Capacitive Touch Controller Driver
- compatible = "azopteq,iqs263";
- reg = <0x44>;
- pinctrl-names = "default";
- pinctrl-0 = <&iqs263_irq_config>;
- vdd-supply = <&pm8953_l5>;
- vio-supply = <&pm8953_l5>;
- interrupt-parent = <&tlmm>;
- interrupts = <48 0x2>;
- azopteq,irq-gpio =<&tlmm 48 0x2>;
- };
- };
2.1，其中compatible屬性標識的名字是與驅動程序中名字相匹配的
2.2，其中reg屬性及@符號后的十六進制數字標識了該設備iqs263的i2c地址為0x442.3，&i2c_8前的&表明此處僅僅是對i2c_8節點的補充，我們可以找到該節點定義的地方
kernel\arch\arm64\boot\dts\qcom\msm8953.dtsi
- &soc {
- i2c_8: i2c@7af8000 { /* BLSP2 QUP4 */
- compatible = "qcom,i2c-msm-v2";
- #address-cells = <1>;
- #size-cells = <0>;
- reg-names = "qup_phys_addr";
- reg = <0x7af8000 0x600>;
- interrupt-names = "qup_irq";
- interrupts = <0 302 0>;
- qcom,clk-freq-out = <400000>;
- qcom,clk-freq-in = <19200000>;
- clock-names = "iface_clk", "core_clk";
- clocks = <&clock_gcc clk_gcc_blsp2_ahb_clk>,
- <&clock_gcc clk_gcc_blsp2_qup4_i2c_apps_clk>;
- pinctrl-names = "i2c_active", "i2c_sleep";
- pinctrl-0 = <&i2c_8_active>;
- pinctrl-1 = <&i2c_8_sleep>;
- qcom,noise-rjct-scl = <0>;
- qcom,noise-rjct-sda = <0>;
- qcom,master-id = <84>;
- dmas = <&dma_blsp2 10 64 0x20000020 0x20>,
- <&dma_blsp2 11 32 0x20000020 0x20>;
- dma-names = "tx", "rx";
- };
- rpm_bus: qcom,rpm-smd {
- compatible = "qcom,rpm-smd";
- rpm-channel-name = "rpm_requests";
- rpm-channel-type = <15>; /* SMD_APPS_RPM */
- };
這當中的大部分屬性都與平台相關了，可以看到定義了該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
- &soc {
- tlmm: pinctrl@1000000 {
- i2c_8 {
- i2c_8_active: i2c_8_active {
- /* active state */
- mux {
- pins = "gpio98", "gpio99";
- function = "blsp_i2c8";
- };
- config {
- pins = "gpio98", "gpio99";
- drive-strength = <2>;
- bias-disable;
- };
- };
- i2c_8_sleep: i2c_8_sleep {
- /* suspended state */
- mux {
- pins = "gpio98", "gpio99";
- function = "gpio";
- };
- config {
- pins = "gpio98", "gpio99";
- drive-strength = <2>;
- bias-disable;
- };
- };
- };
- iqs263_irq_config: iqs263_irq_config {
- mux {
- pins = "gpio48";
- function = "gpio";
- };
- config {
- pins = "gpio48";
- drive-strength = <2>;
- bias-pull-up;
- };
- };
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
- &rpm_bus {
- rpm-regulator-ldoa5 {
- status = "okay";
- pm8953_l5: regulator-l5 {
- regulator-min-microvolt = <1800000>;
- regulator-max-microvolt = <1800000>;
- qcom,init-voltage = <1800000>;
- status = "okay";
- };
- };
2.6，iqs263的interrupts = <48 0x2>屬性表明中斷號為48,2代表下降沿觸發。相關知識可以參考：Linux DTS(Device Tree Source)設備樹詳解之二(dts匹配及發揮作用的流程篇)
DTS設備樹的匹配過程
一個dts文件確定一個項目，多個項目可以包含同一個dtsi文件。找到該項目對應的dts文件即找到了該設備樹的根節點。
kernel\arch\arm\boot\dts\qcom\sdm630-mtp.dts
- /* Copyright (c) 2017, The Linux Foundation. All rights reserved.
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License version 2 and
- * only version 2 as published by the Free Software Foundation.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- */
- /dts-v1/;
- #include "sdm630.dtsi"
- #include "sdm630-mtp.dtsi"
- //#include "sdm660-external-codec.dtsi"
- #include "sdm660-internal-codec.dtsi"
- #include "synaptics-dsx-i2c.dtsi"
- / {
- model = "Qualcomm Technologies, Inc. SDM 630 PM660 + PM660L MTP";
- compatible = "qcom,sdm630-mtp", "qcom,sdm630", "qcom,mtp";
- qcom,board-id = <8 0>;
- qcom,pmic-id = <0x0001001b 0x0101011a 0x0 0x0>,
- <0x0001001b 0x0201011a 0x0 0x0>;
- };
- &tavil_snd {
- qcom,msm-mbhc-moist-cfg = <0>, <0>, <3>;
- };
當然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. 地址
設備的地址特性根據一下幾個屬性來控制：
- reg
- #address-cells
- #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。本地模塊例如：
- spi@10115000{
- compatible = "arm,pl022";
- reg = <0x10115000 0x1000 >;
- };
位於0x10115000的SPI設備申請地址空間，起始地址為0x10115000，長度為0x1000，即屬於這個SPI設備的地址范圍是0x10115000~0x10116000。
實際應用中，有另外一種情況，就是通過外部芯片片選激活模塊。例如，掛載在外部總線上，需要通過片選線工作的一些模塊：
- external-bus{
- #address-cells = <2>
- #size-cells = <1>;
- ethernet@0,0 {
- compatible = "smc,smc91c111";
- reg = <0 0 0x1000>;
- };
- i2c@1,0 {
- compatible ="acme,a1234-i2c-bus";
- #address-cells = <1>;
- #size-cells = <0>;
- reg = <1 0 0x1000>;
- rtc@58 {
- compatible ="maxim,ds1338";
- reg = <58>;
- };
- };
- flash@2,0 {
- compatible ="samsung,k8f1315ebm", "cfi-flash";
- reg = <2 0 0x4000000>;
- };
- };
external-bus使用兩個cell來描述地址，一個是片選序號，另一個是片選序號上的偏移量。而地址空間長度依然用一個cell來描述。所以以上的子設備們都需要3個cell來描述地址空間屬性——片選、偏移量、地址長度。在上個例子中，有一個例外，就是i2c控制器模塊下的rtc模塊。因為I2C設備只是被分配在一個地址上，不需要其他任何空間，所以只需要一個address的cell就可以描述完整，不需要size-cells。
當需要描述的設備不是本地設備時，就需要描述一個從設備地址空間到CPU地址空間的映射關系，這里就需要用到ranges屬性。還是以上邊的external-bus舉例：
- #address-cells= <1>;
- #size-cells= <1>;
- ...
- 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
- };
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。
描述中斷連接需要四個屬性：
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處理。
除了以上規則外，也可以自己加一些自定義的屬性和子節點，但是一定要符合以下的幾個規則：
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 宏, 如下:
- DT_MACHINE_START(******_DT, "************* SoC (Flattened DeviceTree)")
- .atag_offset = 0x100,
- .dt_compat =******_dt_compat, // 匹配dts
- .map_io =******_map_io, // 板級地址內存映射, linux mmu
- .init_irq =irqchip_init, // 板級中斷初始化.
- .init_time =******_timer_and_clk_init, // 板級時鍾初始化,如ahb,apb等
- .init_machine = ******_dt_init, // 這里是解析dts文件入口.
- .restart =******_restart, // 重啟, 看門狗寄存器相關可以在這里設置
- MACHINE_END
- static const charchar * constconst ******_dt_compat[] = {
- "******,******-soc",
- NULL
- };
好了, 我們來看看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的全局變量.
- const struct of_device_id of_default_bus_match_table[] = {
- { .compatible = "simple-bus",},
- #ifdef CONFIG_ARM_AMBA
- { .compatible = "arm,amba-bus",},
- #endif /* CONFIG_ARM_AMBA */
- {} /* Empty terminated list */
- };
2. drivers/of/platform.c : int of_platform_populate(...)
of_platform_populate(...) --> of_platform_bus_create(...)
// 在這之前, 會有of_get_property(bus,"compatible", NULL)
// 檢查是否有compatible, 如果沒有, 返回, 繼續下一個, 也就是說沒有compatible, 這個設備不會被注冊
- for_each_child_of_node(root, child) {
- printk("[%s %s %d]child->name = %s, child->full_name = %s\n", __FILE__, __func__,__LINE__, child->name, child->full_name);
- rc = of_platform_bus_create(child,matches, lookup, parent, true);
- if (rc)
- break;
- }
全部完成后, 通過 of_node_put(root);釋放根節點, 因為已經處理完畢;
3. drivers/of/platform.c : of_platform_bus_create(bus, ...)
- dev = of_platform_device_create_pdata(bus, bus_id,platform_data, parent); // 我們跳到 3-1步去運行
- if (!dev || !of_match_node(matches, bus)) // 就是匹配
- // dt_compat = ******_dt_compat, 也就是 compatible = "simple-bus",
- // 如果匹配成功, 以本節點為父節點, 繼續輪詢本節點下的所有子節點
- return 0;
- for_each_child_of_node(bus, child) {
- pr_debug(" create child:%s\n", child->full_name);
- rc = of_platform_bus_create(child,matches, lookup, &dev->dev, strict); // dev->dev以本節點為父節點, 我們跳到 3-2-1步去運行
- if (rc) {
- of_node_put(child);
- break;
- }
- }
- if (!of_device_is_available(np)) // 查看節點是否有效, 如果節點有'status'屬性, 必須是okay或者是ok, 才是有效, 沒有'status'屬性, 也有效
- return NULL;
- dev = of_device_alloc(np, bus_id, parent); // alloc設備, 設備初始化. 返回dev, 所有的設備都可認為是platform_device, 跳到3-1-1看看函數做了什么事情
- if (!dev)
- return NULL;
- #if defined(CONFIG_MICROBLAZE)
- dev->archdata.dma_mask = 0xffffffffUL;
- #endif
- dev->dev.coherent_dma_mask =DMA_BIT_MASK(32); // dev->dev 是 struct device. 繼續初始化
- dev->dev.bus =&platform_bus_type; //
- dev->dev.platform_data =platform_data;
- printk("[%s %s %d] of_device_add(device register)np->name = %s\n", __FILE__, __func__, __LINE__, np->name);
- if (of_device_add(dev) != 0){ // 注冊device,of_device_add(...) --> device_add(...) // This is part 2 ofdevice_register()
- platform_device_put(dev);
- return NULL;
- }
1) alloc platform_device *dev
2) 如果有reg和interrupts的相關屬性, 運行of_address_to_resource 和of_irq_to_resource_table, 加入到dev->resource
- dev->num_resources = num_reg +num_irq;
- dev->resource = res;
- for (i = 0; i < num_reg; i++, res++) {
- rc = of_address_to_resource(np,i, res);
- /*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); */
- WARN_ON(rc);
- }
- WARN_ON(of_irq_to_resource_table(np, res,num_irq) != num_irq);
// 這個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中的設備描述節點^-^