一.什么是DTS?為什么要引入DTS?DTS即Device Tree Source 設(shè)備樹源碼, Device Tree是一種描述硬件的數(shù)據(jù)結(jié)構(gòu),它起源于 OpenFirmware (OF)。在Linux 2.6中,ARM架構(gòu)的板極硬件細(xì)節(jié)過多地被硬編碼在arch/arm/plat-xxx和arch/arm/mach-xxx,比如板上的platform設(shè)備、resource、i2c_board_info、spi_board_info以及各種硬件的platform_data,這些板級細(xì)節(jié)代碼對內(nèi)核來講只不過是垃圾代碼。而采用Device Tree后,許多硬件的細(xì)節(jié)可以直接透過它傳遞給Linux,而不再需要在kernel中進(jìn)行大量的冗余編碼。每次正式的linux kernel release之后都會有兩周的merge window,在這個窗口期間,kernel各個部分的維護(hù)者都會提交各自的patch,將自己測試穩(wěn)定的代碼請求并入kernel main line。每到這個時候,Linus就會比較繁忙,他需要從各個內(nèi)核維護(hù)者的分支上取得最新代碼并merge到自己的kernel source tree中。Tony Lindgren,內(nèi)核OMAP
development tree的維護(hù)者,發(fā)送了一個郵件給Linus,請求提交OMAP平臺代碼修改,并給出了一些細(xì)節(jié)描述: 1)簡單介紹本次改動 2)關(guān)于如何解決merge conficts。有些git mergetool就可以處理,不能處理的,給出了詳細(xì)介紹和解決方案 一切都很平常,也給出了足夠的信息,然而,正是這個pull request引發(fā)了一場針對ARM linux的內(nèi)核代碼的爭論。我相信Linus一定是對ARM相關(guān)的代碼早就不爽了,ARM的merge工作量較大倒在其次,主要是他認(rèn)為ARM很多的代碼都是垃圾,代碼里面有若干愚蠢的table,而多個人在維護(hù)這個table,從而導(dǎo)致了沖突。因此,在處理完OMAP的pull request之后(Linus并非針對OMAP平臺,只是Tony
Lindgren撞在槍口上了),他發(fā)出了怒吼: Gaah.Guys, this whole ARM thing is a f*cking pain in the ass. 之后經(jīng)過一些討論,對ARM平臺的相關(guān)code做出如下相關(guān)規(guī)范調(diào)整,這個也正是引入DTS的原因。1、ARM的核心代碼仍然保存在arch/arm目錄下2、ARM SoC core architecture code保存在arch/arm目錄下3、ARM SOC的周邊外設(shè)模塊的驅(qū)動保存在drivers目錄下4、ARM SOC的特定代碼在arch/arm/mach-xxx目錄下5、ARM SOC board specific的代碼被移除,由DeviceTree機(jī)制來負(fù)責(zé)傳遞硬件拓?fù)浜陀布Y源信息。本質(zhì)上,Device Tree改變了原來用hardcode方式將HW 配置信息嵌入到內(nèi)核代碼的方法,改用bootloader傳遞一個DB的形式。如果我們認(rèn)為kernel是一個black box,那么其輸入?yún)?shù)應(yīng)該包括:a.識別platform的信息 b.runtime的配置參數(shù) c.設(shè)備的拓?fù)浣Y(jié)構(gòu)以及特性對于嵌入式系統(tǒng),在系統(tǒng)啟動階段,bootloader會加載內(nèi)核并將控制權(quán)轉(zhuǎn)交給內(nèi)核,此外,還需要把上述的三個參數(shù)信息傳遞給kernel,以便kernel可以有較大的靈活性。在linux kernel中,Device Tree的設(shè)計目標(biāo)就是如此。二.DTS基本知識1.DTS的加載過程如果要使用Device Tree,首先用戶要了解自己的硬件配置和系統(tǒng)運行參數(shù),并把這些信息組織成Device Tree source file。通過DTC(Device Tree Compiler),可以將這些適合人類閱讀的Device Tree source file變成適合機(jī)器處理的Device Tree binary file(有一個更好聽的名字,DTB,device tree blob)。在系統(tǒng)啟動的時候,boot program(例如:firmware、bootloader)可以將保存在flash中的DTB
copy到內(nèi)存(當(dāng)然也可以通過其他方式,例如可以通過bootloader的交互式命令加載DTB,或者firmware可以探測到device的信息,組織成DTB保存在內(nèi)存中),并把DTB的起始地址傳遞給client program(例如OS kernel,bootloader或者其他特殊功能的程序)。對于計算機(jī)系統(tǒng)(computer system),一般是firmware->bootloader->OS,對于嵌入式系統(tǒng),一般是bootloader->OS。
2.DTS的描述信息Device Tree由一系列被命名的結(jié)點(node)和屬性(property)組成,而結(jié)點本身可包含子結(jié)點。所謂屬性,其實就是成對出現(xiàn)的name和value。在Device Tree中,可描述的信息包括(原先這些信息大多被hard code到kernel中):CPU的數(shù)量和類別內(nèi)存基地址和大小總線和橋外設(shè)連接中斷控制器和中斷使用情況GPIO控制器和GPIO使用情況Clock控制器和Clock使用情況 它基本上就是畫一棵電路板上CPU、總線、設(shè)備組成的樹,Bootloader會將這棵樹傳遞給內(nèi)核,然后內(nèi)核可以識別這棵樹,并根據(jù)它展開出Linux內(nèi)核中的platform_device、i2c_client、spi_device等設(shè)備,而這些設(shè)備用到的內(nèi)存、IRQ等資源,也被傳遞給了內(nèi)核,內(nèi)核會將這些資源綁定給展開的相應(yīng)的設(shè)備。是否Device Tree要描述系統(tǒng)中的所有硬件信息?答案是否定的?;旧希切┛梢詣討B(tài)探測到的設(shè)備是不需要描述的,例如USB device。不過對于SOC上的usb hostcontroller,它是無法動態(tài)識別的,需要在device tree中描述。同樣的道理,在computersystem中,PCI device可以被動態(tài)探測到,不需要在device tree中描述,但是PCI
bridge如果不能被探測,那么就需要描述之。.dts文件是一種ASCII 文本格式的Device Tree描述,此文本格式非常人性化,適合人類的閱讀習(xí)慣?;旧?,在ARM Linux在,一個.dts文件對應(yīng)一個ARM的machine,一般放置在內(nèi)核的arch/arm/boot/dts/目錄。由于一個SoC可能對應(yīng)多個machine(一個SoC可以對應(yīng)多個產(chǎn)品和電路板),勢必這些.dts文件需包含許多共同的部分,Linux內(nèi)核為了簡化,把SoC公用的部分或者多個machine共同的部分一般提煉為.dtsi,類似于C語言的頭文件。其他的machine對應(yīng)的.dts就include這個.dtsi。譬如,對于RK3288而言,
rk3288.dtsi就被rk3288-chrome.dts所引用,rk3288-chrome.dts有如下一行:#include“rk3288.dtsi”對于rtd1195,在 rtd-119x-nas.dts中就包含了/include/ "rtd-119x.dtsi" 當(dāng)然,和C語言的頭文件類似,.dtsi也可以include其他的.dtsi,譬如幾乎所有的ARM SoC的.dtsi都引用了skeleton.dtsi,即#include"skeleton.dtsi“或者 /include/ "skeleton.dtsi"正常情況下所有的dts文件以及dtsi文件都含有一個根節(jié)點”/”,這樣include之后就會造成有很多個根節(jié)點? 按理說 device tree既然是一個樹,那么其只能有一個根節(jié)點,所有其他的節(jié)點都是派生于根節(jié)點的child node.其實Device Tree Compiler會對DTS的node進(jìn)行合并,最終生成的DTB中只有一個 root node. device tree的基本單元是node。這些node被組織成樹狀結(jié)構(gòu),除了root node,每個node都只有一個parent。一個device tree文件中只能有一個root node。每個node中包含了若干的property/value來描述該node的一些特性。每個node用節(jié)點名字(node name)標(biāo)識,節(jié)點名字的格式是node-name@unit-address。如果該node沒有reg屬性(后面會描述這個property),那么該節(jié)點名字中必須不能包括@和unit-address。unit-address的具體格式是和設(shè)備掛在那個bus上相關(guān)。例如對于cpu,其unit-address就是從0開始編址,以此加一。而具體的設(shè)備,例如以太網(wǎng)控制器,其unit-address就是寄存器地址。root
node的node name是確定的,必須是“/”。在一個樹狀結(jié)構(gòu)的device tree中,如何引用一個node呢?要想唯一指定一個node必須使用full path,例如/node-name-1/node-name-2/node-name-N。 3.DTS的組成結(jié)構(gòu)
/ { 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源文件的結(jié)構(gòu): 1個root結(jié)點"/"; root結(jié)點下面含一系列子結(jié)點,本例中為"node1"和 "node2"; 結(jié)點"node1"下又含有一系列子結(jié)點,本例中為"child-node1"和 "child-node2"; 各結(jié)點都有一系列屬性。這些屬性可能為空,如"an-empty-property";可能為字符串,如"a-string-property";可能為字符串?dāng)?shù)組,如"a-string-list-property";可能為Cells(由u32整數(shù)組成),如"second-child-property",可能為二進(jìn)制數(shù),如"a-byte-data-property"。下面以一個最簡單的machine為例來看如何寫一個.dts文件。假設(shè)此machine的配置如下: 1個雙核ARM Cortex-A9 32位處理器; ARM的local bus上的內(nèi)存映射區(qū)域分布了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控制器所對應(yīng)的I2C總線上又連接了Maxim DS1338實時鐘(I2C地址為0x58)。 其對應(yīng)的.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結(jié)點"/"的compatible 屬性compatible = "acme,coyotes-revenge";定義了系統(tǒng)的名稱,它的組織形式為:<manufacturer>,<model>。Linux內(nèi)核透過root結(jié)點"/"的compatible 屬性即可判斷它啟動的是什么machine。在.dts文件的每個設(shè)備,都有一個compatible屬性,compatible屬性用戶驅(qū)動和設(shè)備的綁定。compatible
屬性是一個字符串的列表,列表中的第一個字符串表征了結(jié)點代表的確切設(shè)備,形式為"<manufacturer>,<model>",其后的字符串表征可兼容的其他設(shè)備。可以說前面的是特指,后面的則涵蓋更廣的范圍。如在arch/arm/boot/dts/vexpress-v2m.dtsi中的Flash結(jié)點: 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結(jié)點"/"的cpus子結(jié)點下面又包含2個cpu子結(jié)點,描述了此machine上的2個CPU,并且二者的compatible 屬性為"arm,cortex-a9"。 注意cpus和cpus的2個cpu子結(jié)點的命名,它們遵循的組織形式為:<name>[@<unit-address>],<>中的內(nèi)容是必選項,[]中的則為可選項。name是一個ASCII字符串,用于描述結(jié)點對應(yīng)的設(shè)備類型,如3com Ethernet適配器對應(yīng)的結(jié)點name宜為ethernet,而不是3com509。如果一個結(jié)點描述的設(shè)備有地址,則應(yīng)該給出@unit-address。多個相同類型設(shè)備結(jié)點的name可以一樣,只要unit-address不同即可,如本例中含有cpu@0、cpu@1以及serial@101f0000與serial@101f2000這樣的同名結(jié)點。設(shè)備的unit-address地址也經(jīng)常在其對應(yīng)結(jié)點的reg屬性中給出。reg的組織形式為reg = <address1 length1 [address2 length2][address3 length3] ... >,其中的每一組addresslength表明了設(shè)備使用的一個地址范圍。address為1個或多個32位的整型(即cell),而length則為cell的列表或者為空(若#size-cells
= 0)。address和length字段是可變長的,父結(jié)點的#address-cells和#size-cells分別決定了子結(jié)點的reg屬性的address和length字段的長度。在本例中,root結(jié)點的#address-cells = <1>;和#size-cells =<1>;決定了serial、gpio、spi等結(jié)點的address和length字段的長度分別為1。cpus 結(jié)點的#address-cells= <1>;和#size-cells =<0>;決定了2個cpu子結(jié)點的address為1,而length為空,于是形成了2個cpu的reg =<0>;和reg
=<1>;。external-bus結(jié)點的#address-cells= <2>和#size-cells =<1>;地址值使用了兩個 cell,一個用于片選號;另一個則用于片選基址的偏移量。而長度字段則還是單個 cell,這是因為只有地址的偏移部分才需要一個范圍量。所以,在這個例子中,每個 reg 項都有三個 cell:片選號、偏移量和長度。 決定了其下的ethernet、i2c、flash的reg字段形如reg = <0 0 0x1000>;、reg = <1 0 0x1000>;和reg = <2 0 0x4000000>;。其中,address字段長度為0,開始的第一個cell(0、1、2)是對應(yīng)的片選,第2個cell(0,0,0)是相對該片選的基地址,第3個cell(0x1000、0x1000、0x4000000)為length。特別要留意的是i2c結(jié)點中定義的
#address-cells = <1>;和#size-cells =<0>;又作用到了I2C總線上連接的RTC,它的address字段為0x58,是設(shè)備的I2C地址。根節(jié)點始終描述的是 CPU 視角的地址空間。根節(jié)點的子節(jié)點已經(jīng)使用的是 CPU 的地址域,所以它們不需要任何直接映射。例如,serial@101f0000 設(shè)備就是直接分配的 0x101f0000 地址。那些非根節(jié)點直接子節(jié)點的節(jié)點就沒有使用 CPU 地址域。為了得到一個內(nèi)存映射地址,設(shè)備樹必須指定從一個域到另一個域地址轉(zhuǎn)換地方法,而 ranges 屬性就為此而生。 external-bus的ranges屬性定義了經(jīng)過external-bus橋后的地址范圍如何映射到CPU的memory區(qū)域。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 是一個地址轉(zhuǎn)換列表。ranges 表中的每一項都是一個包含子地址、父地址和在子地址空間中區(qū)域大小的元組。每個字段的值都取決于子節(jié)點的 #address-cells 、父節(jié)點的 #address-cells 和子節(jié)點的 #size-cells。 以本例中的外部總線來說,子地址是 2 cell、父地址是 1 cell、區(qū)域大小也是 1 cell。那么三個 ranges 被翻譯為: 從片選 0 開始的偏移量 0 被映射為地址范圍: 0x10100000..0x1010ffff 從片選 0 開始的偏移量 1 被映射為地址范圍: 0x10160000..0x1016ffff 從片選 0 開始的偏移量 2 被映射為地址范圍: 0x30000000..0x10000000 另外,如果父地址空間和子地址空間是相同的,那么該節(jié)點可以添加一個空的 range 屬性。一個空的 range 屬性意味著子地址將被 1:1 映射到父地址空間。 Device Tree中還可以中斷連接信息,對于中斷控制器而言,它提供如下屬性: interrupt-controller– 這個屬性為空,中斷控制器應(yīng)該加上此屬性表明自己的身份; #interrupt-cells– 與#address-cells 和 #size-cells相似,它表明連接此中斷控制器的設(shè)備的interrupts屬性的cell大小。 在整個Device Tree中,與中斷相關(guān)的屬性還包括: interrupt-parent– 設(shè)備結(jié)點透過它來指定它所依附的中斷控制器的phandle,當(dāng)結(jié)點沒有指定interrupt-parent時,則從父級結(jié)點繼承。對于本例而言,root結(jié)點指定了interrupt-parent= <&intc>;其對應(yīng)于intc: interrupt-controller@10140000,而root結(jié)點的子結(jié)點并未指定interrupt-parent,因此它們都繼承了intc,即位于0x10140000的中斷控制器。 interrupts – 用到了中斷的設(shè)備結(jié)點透過它指定中斷號、觸發(fā)方法等,具體這個屬性含有多少個cell,由它依附的中斷控制器結(jié)點的#interrupt-cells屬性決定。而具體每個cell又是什么含義,一般由驅(qū)動的實現(xiàn)決定,而且也會在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)一個設(shè)備還可能用到多個中斷號。對于ARM GIC而言,若某設(shè)備使用了SPI的168、169號2個中斷,而言都是高電平觸發(fā),則該設(shè)備結(jié)點的interrupts屬性可定義為:interrupts =<0 168 4>, <0 169 4>; 4.dts引起B(yǎng)SP和driver的變更 沒有使用dts之前的BSP和driver
使用dts之后的driver
針對上面的dts,注意一下幾點:1).rtk_gpio_ctl_mlk這個是node的名字,自己可以隨便定義,當(dāng)然最好是見名知意,可以通過驅(qū)動程序打印當(dāng)前使用的設(shè)備樹節(jié)點 printk(“now dts node name is %s\n",pdev->dev.of_node->name);2). compatible選項是用來和驅(qū)動程序中的of_match_table指針?biāo)赶虻膐f_device_id結(jié)構(gòu)里的compatible字段匹配的,只有dts里的compatible字段的名字和驅(qū)動程序中of_device_id里的compatible字段的名字一樣,驅(qū)動程序才能進(jìn)入probe函數(shù)3).對于gpios這個字段,首先&rtk_iso_gpio指明了這個gpio是連接到的是rtk_iso_gpio,接著那個8是gpio number偏移量,它是以rtk_iso_gpiobase為基準(zhǔn)的,緊接著那個0說明目前配置的gpio number 是設(shè)置成輸入input,如果是1就是設(shè)置成輸出output.最后一個字段1是指定這個gpio 默認(rèn)為高電平,如果是0則是指定這個gpio默認(rèn)為低電平4).如果驅(qū)動里面只是利用compatible字段進(jìn)行匹配進(jìn)入probe函數(shù),那么gpios 可以不需要,但是如果驅(qū)動程序里面是采用設(shè)備樹相關(guān)的方法進(jìn)行操作獲取gpio number,那么gpios這個字段必須使用。 gpios這個字段是由of_get_gpio_flags函數(shù)默認(rèn)指定的name.獲取gpio number的函數(shù)如下: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代碼,目前不再需要出現(xiàn),現(xiàn)在只需要把tlv320aic23、fm3130、24c64這些設(shè)備結(jié)點填充作為相應(yīng)的I2C controller結(jié)點的子結(jié)點即可,類似于前面的 i2c@1,0 { compatible = "acme,a1234-i2c-bus"; … rtc@58 { compatible = "maxim,ds1338"; reg = <58>; interrupts = < 7 3 >; }; };
Device Tree中的I2C client會透過I2C host驅(qū)動的probe()函數(shù)中調(diào)用of_i2c_register_devices(&i2c_dev->adapter);被自動展開。5.常見的DTS 函數(shù)Linux內(nèi)核中目前DTS相關(guān)的函數(shù)都是以of_前綴開頭的,它們的實現(xiàn)位于內(nèi)核源碼的drivers/of下面 void __iomem*of_iomap(struct device_node *node, int index) 通過設(shè)備結(jié)點直接進(jìn)行設(shè)備內(nèi)存區(qū)間的 ioremap(),index是內(nèi)存段的索引。若設(shè)備結(jié)點的reg屬性有多段,可通過index標(biāo)示要ioremap的是哪一段,只有1段的情況,index為0。采用Device Tree后,大量的設(shè)備驅(qū)動通過of_iomap()進(jìn)行映射,而不再通過傳統(tǒng)的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); } 從設(shè)備樹中讀取相關(guān)GPIO的配置編號和標(biāo)志,返回值為 gpio number6.DTC (device tree compiler) 將.dts編譯為.dtb的工具。DTC的源代碼位于內(nèi)核的scripts/dtc目錄,在Linux內(nèi)核使能了Device Tree的情況下,編譯內(nèi)核的時候主機(jī)工具dtc會被編譯出來,對應(yīng)scripts/dtc/Makefile中的“hostprogs-y := dtc”這一hostprogs編譯target。 在Linux內(nèi)核的arch/arm/boot/dts/Makefile中,描述了當(dāng)某種SoC被選中后,哪些.dtb文件會被編譯出來,如與VEXPRESS對應(yīng)的.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文件。當(dāng)我們在Linux內(nèi)核下運行make dtbs時,若我們之前選擇了ARCH_VEXPRESS,上述.dtb都會由對應(yīng)的.dts編譯出來。因為arch/arm/Makefile中含有一個dtbs編譯target項目。DTS設(shè)備樹的匹配過程 一個dts文件確定一個項目,多個項目可以包含同一個dtsi文件。找到該項目對應(yīng)的dts文件即找到了該設(shè)備樹的根節(jié)點。 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>; }; 當(dāng)然devicetree的根節(jié)點也是需要和板子進(jìn)行匹配的,這個匹配信息存放在sbl(second boot loader)中,對應(yīng)dts文件中描述的board-id(上面代碼中的qcom,board-id屬性),通過共享內(nèi)存?zhèn)鬟f給bootloader,由bootloader將此board-id匹配dts文件(devicetree的根節(jié)點文件),將由dtc編譯后的dts文件(dtb文件)加載到內(nèi)存,然后在kernel中展開dts樹,并且掛載dts樹上的所有設(shè)備。 (ps:cat /proc/cmdline 查看cmdline) Dts中相關(guān)符號的含義 / 根節(jié)點 @ 如果設(shè)備有地址,則由此符號指定 & 引用節(jié)點 : 冒號前的label是為了方便引用給節(jié)點起的別名,此label一般使用為&label , 屬性名稱中可以包含逗號。如compatible屬性的名字 組成方式為"[manufacturer], [model]",加入廠商名是為了避免重名。自定義屬性名中通常也要有廠商名,并以逗號分隔。 # #并不表示注釋。如 #address-cells ,#size-cells 用來決定reg屬性的格式。 空屬性并不一定表示沒有賦值。如 interrupt-controller 一個空屬性用來聲明這個node接收中斷信號 數(shù)據(jù)類型 “” 引號中的為字符串,字符串?dāng)?shù)組:”strint1”,”string2”,”string3” < > 尖括號中的為32位整形數(shù)字,整形數(shù)組<12 3 4> [ ] 方括號中的為32位十六進(jìn)制數(shù),十六機(jī)制數(shù)據(jù)[0x11 0x12 0x13] 其中0x可省略 構(gòu)成節(jié)點名的有效字符: 構(gòu)成屬性名的有效字符: DTS中幾個難理解的屬性的解釋 a. 地址 設(shè)備的地址特性根據(jù)一下幾個屬性來控制: reg #address-cells #size-cells reg意為region,區(qū)域。格式為: reg = <address1length1 [address2 length2] [address3 length3]>; 父類的address-cells和size-cells決定了子類的相關(guān)屬性要包含多少個cell,如果子節(jié)點有特殊需求的話,可以自己再定義,這樣就可以擺脫父節(jié)點的控制。address-cells決定了address1/2/3包含幾個cell,size-cells決定了length1/2/3包含了幾個cell。本地模塊例如: spi@10115000{ compatible = "arm,pl022"; reg = <0x10115000 0x1000 >; }; 位于0x10115000的SPI設(shè)備申請地址空間,起始地址為0x10115000,長度為0x1000,即屬于這個SPI設(shè)備的地址范圍是0x10115000~0x10116000。 實際應(yīng)用中,有另外一種情況,就是通過外部芯片片選激活模塊。例如,掛載在外部總線上,需要通過片選線工作的一些模塊: 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來描述。所以以上的子設(shè)備們都需要3個cell來描述地址空間屬性——片選、偏移量、地址長度。在上個例子中,有一個例外,就是i2c控制器模塊下的rtc模塊。因為I2C設(shè)備只是被分配在一個地址上,不需要其他任何空間,所以只需要一個address的cell就可以描述完整,不需要size-cells。 當(dāng)需要描述的設(shè)備不是本地設(shè)備時,就需要描述一個從設(shè)備地址空間到CPU地址空間的映射關(guān)系,這里就需要用到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屬性為一個地址轉(zhuǎn)換表。表中的每一行都包含了子地址、父地址、在自地址空間內(nèi)的區(qū)域大小。他們的大?。ò腸ell)分別由子節(jié)點的address-cells的值、父節(jié)點的address-cells的值和子節(jié)點的size-cells來決定。以第一行為例: · 0 0 兩個cell,由子節(jié)點external-bus的address-cells=<2>決定; · 0x10100000 一個cell,由父節(jié)點的address-cells=<1>決定; · 0x10000 一個cell,由子節(jié)點external-bus的size-cells=<1>決定。 最終第一行說明的意思就是:片選0,偏移0(選中了網(wǎng)卡),被映射到CPU地址空間的0x10100000~0x10110000中,地址長度為0x10000。 b. 中斷 描述中斷連接需要四個屬性: 1. interrupt-controller 一個空屬性用來聲明這個node接收中斷信號; 2. #interrupt-cells 這是中斷控制器節(jié)點的屬性,用來標(biāo)識這個控制器需要幾個單位做中斷描述符; 3. interrupt-parent 標(biāo)識此設(shè)備節(jié)點屬于哪一個中斷控制器,如果沒有設(shè)置這個屬性,會自動依附父節(jié)點的; 4. interrupts 一個中斷標(biāo)識符列表,表示每一個中斷輸出信號。 如果有兩個,第一個是中斷號,第二個是中斷類型,如高電平、低電平、邊緣觸發(fā)等觸發(fā)特性。對于給定的中斷控制器,應(yīng)該仔細(xì)閱讀相關(guān)文檔來確定其中斷標(biāo)識該如何解析。一般如下: 二個cell的情況 第一個值: 該中斷位于他的中斷控制器的索引; 第二個值:觸發(fā)的type 固定的取值如下: 1 = low-to-high edge triggered 2 = high-to-low edge triggered 4 = active high level-sensitive 8 = active low level-sensitive
三個cell的情況 第一個值:中斷號 第二個值:觸發(fā)的類型 第三個值:優(yōu)先級,0級是最高的,7級是最低的;其中0級的中斷系統(tǒng)當(dāng)做 FIQ處理。
c. 其他 除了以上規(guī)則外,也可以自己加一些自定義的屬性和子節(jié)點,但是一定要符合以下的幾個規(guī)則: 1. 新的設(shè)備屬性一定要以廠家名字做前綴,這樣就可以避免他們會和當(dāng)前的標(biāo)準(zhǔn)屬性存在命名沖突問題; 2. 新加的屬性具體含義以及子節(jié)點必須加以文檔描述,這樣設(shè)備驅(qū)動開發(fā)者就知道怎么解釋這些數(shù)據(jù)了。描述文檔中必須特別說明compatible的value的意義,應(yīng)該有什么屬性,可以有哪個(些)子節(jié)點,以及這代表了什么設(shè)備。每個獨立的compatible都應(yīng)該由單獨的解釋。 新添加的這些要發(fā)送到devicetree-discuss@lists.ozlabs.org郵件列表中進(jìn)行review,并且檢查是否會在將來引發(fā)其他的問題。
DTS設(shè)備樹描述文件中什么代表總線,什么代表設(shè)備 一個含有compatible屬性的節(jié)點就是一個設(shè)備。包含一組設(shè)備節(jié)點的父節(jié)點即為總線。 由DTS到device_register的過程 dts描述的設(shè)備樹是如何通過register_device進(jìn)行設(shè)備掛載的呢?我們來進(jìn)行一下代碼分析 在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, // 板級地址內(nèi)存映射, linux mmu .init_irq =irqchip_init, // 板級中斷初始化. .init_time =******_timer_and_clk_init, // 板級時鐘初始化,如ahb,apb等 .init_machine = ******_dt_init, // 這里是解析dts文件入口. .restart =******_restart, // 重啟, 看門狗寄存器相關(guān)可以在這里設(shè)置 MACHINE_END 其中.dt_compat = ******_dt_compat 這個結(jié)構(gòu)體是匹配是哪個dts文件, 如:
static const char * const ******_dt_compat[] = { "******,******-soc", NULL }; 這個"******,******-soc" 字符串可以在我們的dts的根節(jié)點下可以找到.
好了, 我們來看看init_machine = ******_dt_init 這個回調(diào)函數(shù). 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 */ }; 我們設(shè)計dts時, 把一些需要指定寄存器基地址的設(shè)備放到以compatible = "simple-bus"為匹配項的設(shè)備節(jié)點下. 下面會有介紹為什么.
2. drivers/of/platform.c : int of_platform_populate(...) of_platform_populate(...) --> of_platform_bus_create(...) // 在這之前, 會有of_get_property(bus,"compatible", NULL) // 檢查是否有compatible, 如果沒有, 返回, 繼續(xù)下一個, 也就是說沒有compatible, 這個設(shè)備不會被注冊
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; } 論詢dts根節(jié)點下的子設(shè)備, 每個子設(shè)備都要of_platform_bus_create(...); 全部完成后, 通過 of_node_put(root);釋放根節(jié)點, 因為已經(jīng)處理完畢;
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", // 如果匹配成功, 以本節(jié)點為父節(jié)點, 繼續(xù)輪詢本節(jié)點下的所有子節(jié)點 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以本節(jié)點為父節(jié)點, 我們跳到 3-2-1步去運行 if (rc) { of_node_put(child); break; } } 3-1. drivers/of/platform.c : of_platform_device_create_pdata(...)
if (!of_device_is_available(np)) // 查看節(jié)點是否有效, 如果節(jié)點有'status'屬性, 必須是okay或者是ok, 才是有效, 沒有'status'屬性, 也有效 return NULL; dev = of_device_alloc(np, bus_id, parent); // alloc設(shè)備, 設(shè)備初始化. 返回dev, 所有的設(shè)備都可認(rèn)為是platform_device, 跳到3-1-1看看函數(shù)做了什么事情 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. 繼續(xù)初始化 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; } 3-1-1. drivers/of/platform.c : of_device_alloc(...) 1) alloc platform_device *dev 2) 如果有reg和interrupts的相關(guān)屬性, 運行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); 3) dev->dev.of_node = of_node_get(np); // 這個node屬性里有compatible屬性, 這個屬性從dts來, 后續(xù)driver匹配device時, 就是通過這一屬性進(jìn)匹配 // 我們可以通過添加下面一句話來查看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, 后續(xù)給驅(qū)動注冊使用. 4) 運行 of_device_make_bus_id 設(shè)定device的名字, 如: soc.2 或 ac000000.serial 等
3-2. drivers/of/platform.c : 以 compatible = "simple-bus"的節(jié)點的子節(jié)點都會以這個節(jié)點作為父節(jié)點在這步注冊設(shè)備.
至此從dts文件的解析到最終調(diào)用of_device_add進(jìn)行設(shè)備注冊的過程就比較清晰了。 查看掛載上的所有設(shè)備 cd /sys/devices/ 查看注冊成功的設(shè)備 對應(yīng)devicetree中的設(shè)備描述節(jié)點^-^ 聲明:本文中部分內(nèi)容參考 http:///Device_Tree_Usage
https://www./specifications/
http://blog.csdn.NET/eastonwoo/article/details/51498647 http://blog.csdn.net/airk000/article/details/21345159 http:///Device_Tree_Usage
高通MSM8953實例分析篇我們以高通的MSM8953平臺為例來添加一個基礎(chǔ)的i2c設(shè)備(包含一個gpio中斷)。 1,首先我們在該i2c設(shè)備的驅(qū)動中找到了匹配設(shè)備與驅(qū)動程序的compatible static const struct of_device_id iqs263_of_match[] = { { .compatible = "azopteq,iqs263", }, { }, }; 2,由此compatible可以找到dts中對應(yīng)的設(shè)備 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屬性標(biāo)識的名字是與驅(qū)動程序中名字相匹配的 2.2,其中reg屬性及@符號后的十六進(jìn)制數(shù)字標(biāo)識了該設(shè)備iqs263的i2c地址為0x44 2.3,&i2c_8前的&表明此處僅僅是對i2c_8節(jié)點的補充,我們可以找到該節(jié)點定義的地方 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 */ };
這當(dāng)中的大部分屬性都與平臺相關(guān)了,可以看到定義了該i2c接口的時鐘源、中斷格式等。這部分一般由平臺提供,作為驅(qū)動工程師了解即可。 2.3.1,i2c_8節(jié)點中的pinctrl-0指向了定義其io口的節(jié)點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節(jié)點中的pinctrl-0 屬性指向了表明其io口屬性的節(jié)點為iqs263_irq_config,相關(guān)代碼也在2.3.1指示的msm8953-pinctrl.dtsi文件中。 其中定義了iqs263的中斷IO腳為Gpio48 2.5,iqs263節(jié)點中的vdd-supply,vio-supply屬性指示了表明iqs263芯片供電的引腳的節(jié)點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代表下降沿觸發(fā)。
|