Linux 設備樹(Device Tree)(轉載)

本文參考如下兩篇文章,整合爲一篇。

ARM Linux 3.x的設備樹(Device Tree)
Linux設備樹(Device Tree)機制java

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。讀者有興趣能夠統計下常見的s3c24十、s3c6410等板級目錄,代碼量在數萬行。node

社區必須改變這種局面,因而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中進行大量的冗餘編碼。linux

Device Tree由一系列被命名的結點(node)和屬性(property)組成,而結點自己可包含子結點。所謂屬性,其實就是成對出現的name和value。在Device Tree中,可描述的信息包括(原先這些信息大多被hard code到kernel中):git

  • CPU的數量和類別
  • 內存基地址和大小
  • 總線和橋
  • 外設鏈接
  • 中斷控制器和中斷使用狀況
  • GPIO控制器和GPIO使用狀況
  • Clock控制器和Clock使用狀況

它基本上就是畫一棵電路板上CPU、總線、設備組成的樹,Bootloader會將這棵樹傳遞給內核,而後內核能夠識別這棵樹,並根據它展開出Linux內核中的platform_device、i2c_client、spi_device等設備,而這些設備用到的內存、IRQ等資源,也被傳遞給了內核,內核會將這些資源綁定給展開的相應的設備。express

Device Tree組成和結構

整個Device Tree牽涉面比較廣,即增長了新的用於描述設備硬件信息的文本格式,又增長了編譯這一文本的工具,同時Bootloader也須要支持將編譯後的Device Tree傳遞給Linux內核。數組

設備樹包含DTC(device tree compiler),DTS(device tree source和DTB(device tree blob)。其對應關係以下,數據結構

devtree-1.jpg

DTS (device tree source)

.dts文件是一種ASCII 文本格式的Device Tree描述,此文本格式很是人性化,適合人類的閱讀習慣。基本上,在ARM Linux在,一個.dts文件對應一個ARM的machine,通常放置在內核的arch/arm/boot/dts/目錄。架構

DTS 基本結構

.dts(或者其include的.dtsi)基本元素即爲前文所述的結點和屬性:app

/ {
    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源文件的結構:ide

  • 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"。

DTSI

因爲一個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。skeleton.dtsi的內容以下,

/ {
    #address-cells = <1>;
    #size-cells = <1>;
    chosen { };
    aliases { };
    memory { device_type = "memory"; reg = <0 0>; };
};

上述內容代表,以「/」根節點爲parent的子節點中,reg屬性address和length字段的長度分別爲1。具體節點的描述以下。

chosen node

chosen node 主要用來描述由系統指定的runtime parameter,它並無描述任何硬件設備節點信息。原先經過tag list傳遞的一些linux kernel運行的參數,能夠經過chosen節點來傳遞。如command line能夠經過bootargs這個property來傳遞。若是存在chosen node,它的parent節點必須爲「/」根節點。

chosen {
    bootargs = "tegraid=40.0.0.00.00 vmalloc=256M video=tegrafb console=ttyS0,115200n8 earlyprintk";
};
aliases node

aliases node用來定義別名,相似C++中引用。

aliases {
    i2c6 = &pca9546_i2c0;
    i2c7 = &pca9546_i2c1;
    i2c8 = &pca9546_i2c2;
    i2c9 = &pca9546_i2c3;
};

上面是一個在.dtsi中的典型應用,當使用i2c6時,也即便用pca9546_i2c0,使得引用節點變得簡單方便。例:當.dts include 該.dtsi時,將i2c6的status屬性賦值爲okay,則代表該主板上的pca9546_i2c0處於enable狀態;反之,status賦值爲disabled,則代表該主板上的pca9546_i2c0處於disenable狀態。

memory node

對於memory node,device_type必須爲memory。

memory {
    device_type = "memory";
    reg = <0x00000000 0x20000000>; /* 512 MB */
};

上述描述代表該memory node是以0x00000000爲起始地址,以0x20000000爲結束地址的512MB的空間。通常而言,在.dts中不對memory進行描述,而是經過bootargs中相似521M@0x00000000的方式傳遞給內核。

DTS 基本描述

下面以一個最簡單的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>;
        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>;
            interrupts = < 6 2 >;
            rtc@58 {
                compatible = "maxim,ds1338";
                reg = <58>;
                interrupts = < 7 3 >;
            };
        };
    
        flash@2,0 {
            compatible = "samsung,k8f1315ebm", "cfi-flash";
            reg = <2 0 0x4000000>;
        };
    };
};
compatible

上述.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"涵蓋的範圍更廣。再好比,Freescale MPC8349 SoC含一個串口設備,它實現了國家半導體(National Semiconductor)的ns16550 寄存器接口。則MPC8349串口設備的compatible屬性爲compatible = "fsl,mpc8349-uart", "ns16550"。其中,fsl,mpc8349-uart指代了確切的設備, ns16550表明該設備與National Semiconductor 的16550 UART保持了寄存器兼容。

在設備匹配驅動過程當中,優先級爲從左向右。本例中flash的驅動優先尋找「arm,vexpress-flash」驅動,若沒有找到,則經過「cfi-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屬性中給出。ePAPR標準給出告終點命名的規範。

reg

可尋址的設備使用以下信息來在Device Tree中編碼地址信息:

reg
        #address-cells
        #size-cells

reg描述了memory-mapped IO register的address和length。address 和 length 字段是可變長的,父結點的#address-cells和#size-cells分別決定了子結點的reg屬性的address和length字段的長度。reg的組織形式爲

reg = <address1 length1 [address2 length2] [address3 length3] ... >

其中的每一組address length代表了設備使用的一個地址範圍。address爲1個或多個32位的整型(即cell),而length則爲cell的列表或者爲空(若#size-cells = 0)。

在本例中,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、一、2)是對應的片選,第2個cell(0,0,0)是相對該片選的基地址,第3個cell(0x1000、0x1000、0x4000000)爲length。特別要留意的是i2c結點中定義的 #address-cells = <1>;和#size-cells = <0>;又做用到了I2C總線上鏈接的RTC,它的address字段爲0x58,是設備的I2C地址。

ranges

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個項目的含義能夠類推。

interrupt

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的具體含義

Documentation/devicetree/bindings/arm/gic.txt就有以下文字說明:

01   The 1st cell is the interrupt type; 0 for SPI interrupts, 1 for PPI
02   interrupts.
03
04   The 2nd cell contains the interrupt number for the interrupt type.
05   SPI interrupts are in the range [0-987].  PPI interrupts are in the
06   range [0-15].
07
08   The 3rd cell is the flags, encoded as follows:
09         bits[3:0] trigger type and level flags.
10                 1 = low-to-high edge triggered
11                 2 = high-to-low edge triggered
12                 4 = active high level-sensitive
13                 8 = active low level-sensitive
14         bits[15:8] PPI interrupt cpu mask.  Each bit corresponds to each of
15         the 8 possible cpus attached to the GIC.  A bit set to '1' indicated
16         the interrupt is wired to that CPU.  Only valid for PPI interrupts.

另外,值得注意的是,一個設備還可能用到多箇中斷號。對於ARM GIC而言,若某設備使用了SPI的16八、169號2箇中斷,而言都是高電平觸發,則該設備結點的interrupts屬性可定義爲:interrupts = <0 168 4>, <0 169 4>;

除了中斷之外,在ARM Linux中clock、GPIO、pinmux均可以透過.dts中的結點和屬性進行描述。對於Device Tree中的結點和屬性具體是如何來描述設備的硬件細節的,通常須要文檔來進行講解,文檔的後綴名通常爲.txt。這些文檔位於內核的Documentation/devicetree/bindings目錄,其下又分爲不少子目錄。

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

Device Tree Blob (.dtb)

.dtb是.dts被DTC編譯後的二進制格式的Device Tree描述,可由Linux內核解析。一般在咱們爲電路板製做NAND、SD啓動image時,會爲.dtb文件單獨留下一個很小的區域以存放之,以後bootloader在引導kernel的過程當中,會先讀取該.dtb到內存。

DTB由三部分組成:頭(Header)、結構塊(device-tree structure)、字符串塊(device-tree string),它的佈局結構以下,

devtree-2.png

Header

在kernelincludelinuxof_fdt.h文件中有相關定義,

devtree-3.png

device-tree structure

設備樹結構塊是一個線性化的結構體,是設備樹的主體,以節點的形式保存了主板上的設備信息。

在結構塊中,以宏OF_DT_BEGIN_NODE標誌一個節點的開始,以宏OF_DT_END_NODE標識一個節點的結束,整個結構塊以宏OF_DT_END (0x00000009)結束。在kernelincludelinuxof_fdt.h中有相關定義,咱們把這些宏稱之爲token。

  • FDT_BEGIN_NODE (0x00000001)。該token描述了一個node的開始位置,緊挨着該token的就是node name(包括unit address)
  • FDT_END_NODE (0x00000002)。該token描述了一個node的結束位置。
  • FDT_PROP (0x00000003)。該token描述了一個property的開始位置,該token以後是兩個u32的數據,分別是length和name offset。length表示該property value data的size。name offset表示該屬性字符串在device tree strings block的偏移值。length和name offset以後就是長度爲length具體的屬性值數據。
  • FDT_NOP (0x00000004)。
  • FDT_END (0x00000009)。該token標識了一個DTB的結束位置。

一個節點的結構以下:

  1. 節點開始標誌:通常爲OF_DT_BEGIN_NODE(0x00000001)。
  2. 節點路徑或者節點的單元名(version<3以節點路徑表示,version>=0x10以節點單元名錶示)
  3. 填充字段(對齊到四字節)
  4. 節點屬性。每一個屬性以宏OF_DT_PROP(0x00000003)開始,後面依次爲屬性值的字節長度(4字節)、屬性名稱在字符串塊中的偏移量(4字節)、屬性值和填充(對齊到四字節)。
  5. 若是存在子節點,則定義子節點。
  6. 節點結束標誌OF_DT_END_NODE(0x00000002)。

device-tree string

經過節點的定義知道節點都有若干屬性,而不一樣的節點的屬性又有大量相同的屬性名稱,所以將這些屬性名稱提取出一張表,當節點須要應用某個屬性名稱時,直接在屬性名字段保存該屬性名稱在字符串塊中的偏移量。

memory reserve map

這個區域包括了若干的reserve memory描述符。每一個reserve memory描述符是由address和size組成。其中address和size都是用U64來描述。

有些系統,咱們也許會保留一些memory有特殊用途(例如DTB或者initrd image),或者在有些DSP+ARM的SOC platform上,有些memory被保留用於ARM和DSP進行信息交互。這些保留內存不會進入內存管理系統。

Bootloader

Uboot mainline 從 v1.1.3開始支持Device Tree,其對ARM的支持則是和ARM內核支持Device Tree同期完成。爲了使能Device Tree,須要編譯Uboot的時候在config文件中加入

#define CONFIG_OF_LIBFDT

在Uboot中,能夠從NAND、SD或者TFTP等任意介質將.dtb讀入內存,假設.dtb放入的內存地址爲0x71000000,以後可在Uboot運行命令fdt addr命令設置.dtb的地址,如:

U-Boot> fdt addr 0x71000000

fdt的其餘命令就變的可使用,如fdt resize、fdt print等。

對於ARM來說,能夠透過bootz kernel_addr initrd_address dtb_address的命令來啓動內核,即dtb_address做爲bootz或者bootm的最後一次參數,第一個參數爲內核映像的地址,第二個參數爲initrd的地址,若不存在initrd,能夠用 -代替。

Device Tree引起的BSP和驅動變動

有了Device Tree後,大量的板級信息都再也不須要,譬如過去常常在arch/arm/plat-xxx和arch/arm/mach-xxx實施的事情,均可以經過Device Tree轉化爲統一的標準處理。

註冊platform_device,綁定resource,即內存、IRQ等板級信息。

透過Device Tree後,形如

90 static struct resource xxx_resources[] = {
    91         [0] = {
    92                 .start  = …,
    93                 .end    = …,
    94                 .flags  = IORESOURCE_MEM,
    95         },
    96         [1] = {
    97                 .start  = …,
    98                 .end    = …,
    99                 .flags  = IORESOURCE_IRQ,
    100         },
    101 };
    102
    103 static struct platform_device xxx_device = {
    104         .name           = "xxx",
    105         .id             = -1,
    106         .dev            = {
    107                                 .platform_data          = &xxx_data,
    108         },
    109         .resource       = xxx_resources,
    110         .num_resources  = ARRAY_SIZE(xxx_resources),
    111 };

之類的platform_device代碼都再也不須要,其中platform_device會由kernel自動展開。而這些resource實際來源於.dts中設備結點的reg、interrupts屬性。典型地,大多數總線都與「simple_bus」兼容,而在SoC對應的machine的.init_machine成員函數中,調用of_platform_bus_probe(NULL, xxx_of_bus_ids, NULL); 便可自動展開全部的platform_device。譬如,假設咱們有個XXX SoC,則可在arch/arm/mach-xxx/的板文件中透過以下方式展開.dts中的設備結點對應的platform_device:

18 static struct of_device_id xxx_of_bus_ids[] __initdata = {
    19         { .compatible = "simple-bus", },
    20         {},
    21 };
    22
    23 void __init xxx_mach_init(void)
    24 {
    25         of_platform_bus_probe(NULL, xxx_of_bus_ids, NULL);
    26 }
    32
    33 #ifdef CONFIG_ARCH_XXX
    38
    39 DT_MACHINE_START(XXX_DT, "Generic XXX (Flattened Device Tree)")
    41         …
    45         .init_machine   = xxx_mach_init,
    46         …
    49 MACHINE_END
    50 #endif

註冊i2c_board_info,指定IRQ等板級信息。

形如

145 static struct i2c_board_info __initdata afeb9260_i2c_devices[] = {
    146         {
    147                 I2C_BOARD_INFO("tlv320aic23", 0x1a),
    148         }, {
    149                 I2C_BOARD_INFO("fm3130", 0x68),
    150         }, {
    151                 I2C_BOARD_INFO("24c64", 0x50),
    152         },
    153 };

之類的i2c_board_info代碼,目前再也不須要出現,如今只須要把tlv320aic2三、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); 被自動展開。

註冊spi_board_info,指定IRQ等板級信息。

形如

79 static struct spi_board_info afeb9260_spi_devices[] = {
    80         {       /* DataFlash chip */
    81                 .modalias       = "mtd_dataflash",
    82                 .chip_select    = 1,
    83                 .max_speed_hz   = 15 * 1000 * 1000,
    84                 .bus_num        = 0,
    85         },
    86 };

之類的spi_board_info代碼,目前再也不須要出現,與I2C相似,如今只須要把mtd_dataflash之類的結點,做爲SPI控制器的子結點便可,SPI host驅動的probe函數透過spi_register_master()註冊master的時候,會自動展開依附於它的slave。

多個針對不一樣電路板的machine,以及相關的callback。

過去,ARM Linux針對不一樣的電路板會創建由MACHINE_START和MACHINE_END包圍起來的針對這個machine的一系列callback,譬如:

373 MACHINE_START(VEXPRESS, "ARM-Versatile Express")
    374         .atag_offset    = 0x100,
    375         .smp            = smp_ops(vexpress_smp_ops),
    376         .map_io         = v2m_map_io,
    377         .init_early     = v2m_init_early,
    378         .init_irq       = v2m_init_irq,
    379         .timer          = &v2m_timer,
    380         .handle_irq     = gic_handle_irq,
    381         .init_machine   = v2m_init,
    382         .restart        = vexpress_restart,
    383 MACHINE_END

這些不一樣的machine會有不一樣的MACHINE ID,Uboot在啓動Linux內核時會將MACHINE ID存放在r1寄存器,Linux啓動時會匹配Bootloader傳遞的MACHINE ID和MACHINE_START聲明的MACHINE ID,而後執行相應machine的一系列初始化函數。

引入Device Tree以後,MACHINE_START變動爲DT_MACHINE_START,其中含有一個.dt_compat成員,用於代表相關的machine與.dts中root結點的compatible屬性兼容關係。若是Bootloader傳遞給內核的Device Tree中root結點的compatible屬性出如今某machine的.dt_compat表中,相關的machine就與對應的Device Tree匹配,從而引起這一machine的一系列初始化函數被執行。

489 static const char * const v2m_dt_match[] __initconst = {
    490         "arm,vexpress",
    491         "xen,xenvm",
    492         NULL,
    493 };
    495 DT_MACHINE_START(VEXPRESS_DT, "ARM-Versatile Express")
    496         .dt_compat      = v2m_dt_match,
    497         .smp            = smp_ops(vexpress_smp_ops),
    498         .map_io         = v2m_dt_map_io,
    499         .init_early     = v2m_dt_init_early,
    500         .init_irq       = v2m_dt_init_irq,
    501         .timer          = &v2m_dt_timer,
    502         .init_machine   = v2m_dt_init,
    503         .handle_irq     = gic_handle_irq,
    504         .restart        = vexpress_restart,
    505 MACHINE_END

Linux倡導針對多個SoC、多個電路板的通用DT machine,即一個DT machine的.dt_compat表含多個電路板.dts文件的root結點compatible屬性字符串。以後,若是的電路板的初始化序列不同,能夠透過int of_machine_is_compatible(const char *compat) API判斷具體的電路板是什麼。

譬如arch/arm/mach-exynos/mach-exynos5-dt.c的EXYNOS5_DT machine同時兼容 "samsung,exynos5250"和"samsung,exynos5440":

158 static char const *exynos5_dt_compat[] __initdata = {
    159         "samsung,exynos5250",
    160         "samsung,exynos5440",
    161         NULL
    162 };
    163
    177 DT_MACHINE_START(EXYNOS5_DT, "SAMSUNG EXYNOS5 (Flattened Device Tree)")
    178         /* Maintainer: Kukjin Kim <kgene.kim@samsung.com> */
    179         .init_irq       = exynos5_init_irq,
    180         .smp            = smp_ops(exynos_smp_ops),
    181         .map_io         = exynos5_dt_map_io,
    182         .handle_irq     = gic_handle_irq,
    183         .init_machine   = exynos5_dt_machine_init,
    184         .init_late      = exynos_init_late,
    185         .timer          = &exynos4_timer,
    186         .dt_compat      = exynos5_dt_compat,
    187         .restart        = exynos5_restart,
    188         .reserve        = exynos5_reserve,
    189 MACHINE_END

它的.init_machine成員函數就針對不一樣的machine進行了不一樣的分支處理:

126 static void __init exynos5_dt_machine_init(void)
    127 {
    128         …
    149
    150         if (of_machine_is_compatible("samsung,exynos5250"))
    151                 of_platform_populate(NULL, of_default_bus_match_table,
    152                                      exynos5250_auxdata_lookup, NULL);
    153         else if (of_machine_is_compatible("samsung,exynos5440"))
    154                 of_platform_populate(NULL, of_default_bus_match_table,
    155                                      exynos5440_auxdata_lookup, NULL);
    156 }

使用Device Tree後,驅動須要與.dts中描述的設備結點進行匹配,從而引起驅動的probe()函數執行。對於platform_driver而言,須要添加一個OF匹配表,如前文的.dts文件的"acme,a1234-i2c-bus"兼容I2C控制器結點的OF匹配表能夠是:

436 static const struct of_device_id a1234_i2c_of_match[] = {
    437         { .compatible = "acme,a1234-i2c-bus ", },
    438         {},
    439 };
    440 MODULE_DEVICE_TABLE(of, a1234_i2c_of_match);
    441
    442 static struct platform_driver i2c_a1234_driver = {
    443         .driver = {
    444                 .name = "a1234-i2c-bus ",
    445                 .owner = THIS_MODULE,
    449                 .of_match_table = a1234_i2c_of_match,
    450         },
    451         .probe = i2c_a1234_probe,
    452         .remove = i2c_a1234_remove,
    453 };
    454 module_platform_driver(i2c_a1234_driver);

對於I2C和SPI從設備而言,一樣也能夠透過of_match_table添加匹配的.dts中的相關結點的compatible屬性,如sound/soc/codecs/wm8753.c中的:

1533 static const struct of_device_id wm8753_of_match[] = {
    1534         { .compatible = "wlf,wm8753", },
    1535         { }
    1536 };
    1537 MODULE_DEVICE_TABLE(of, wm8753_of_match);
    1587 static struct spi_driver wm8753_spi_driver = {
    1588         .driver = {
    1589                 .name   = "wm8753",
    1590                 .owner  = THIS_MODULE,
    1591                 .of_match_table = wm8753_of_match,
    1592         },
    1593         .probe          = wm8753_spi_probe,
    1594         .remove         = wm8753_spi_remove,
    1595 };
    1640 static struct i2c_driver wm8753_i2c_driver = {
    1641         .driver = {
    1642                 .name = "wm8753",
    1643                 .owner = THIS_MODULE,
    1644                 .of_match_table = wm8753_of_match,
    1645         },
    1646         .probe =    wm8753_i2c_probe,
    1647         .remove =   wm8753_i2c_remove,
    1648         .id_table = wm8753_i2c_id,
    1649 };

不過這邊有一點須要提醒的是,I2C和SPI外設驅動和Device Tree中設備結點的compatible 屬性還有一種弱式匹配方法,就是別名匹配。compatible 屬性的組織形式爲<manufacturer>,<model>,別名其實就是去掉compatible 屬性中逗號前的manufacturer前綴。關於這一點,可查看drivers/spi/spi.c的源代碼,函數spi_match_device()暴露了更多的細節,若是別名出如今設備spi_driver的id_table裏面,或者別名與spi_driver的name字段相同,SPI設備和驅動均可以匹配上:

90 static int spi_match_device(struct device *dev, struct device_driver *drv)
    91 {
    92         const struct spi_device *spi = to_spi_device(dev);
    93         const struct spi_driver *sdrv = to_spi_driver(drv);
    94
    95         /* Attempt an OF style match */
    96         if (of_driver_match_device(dev, drv))
    97                 return 1;
    98
    99         /* Then try ACPI */
    100         if (acpi_driver_match_device(dev, drv))
    101                 return 1;
    102
    103         if (sdrv->id_table)
    104                 return !!spi_match_id(sdrv->id_table, spi);
    105
    106         return strcmp(spi->modalias, drv->name) == 0;
    107 }
    71 static const struct spi_device_id *spi_match_id(const struct spi_device_id *id,
    72                                                 const struct spi_device *sdev)
    73 {
    74         while (id->name[0]) {
    75                 if (!strcmp(sdev->modalias, id->name))
    76                         return id;
    77                 id++;
    78         }
    79         return NULL;
    80 }

解析DTB的函數及相關數據結構

machine_desc結構

struct machine_desc {
    unsigned int        nr;     /* architecture number  */
    const char      *name;      /* architecture name    */
    unsigned long       atag_offset;    /* tagged list (relative) */
    const char *const   *dt_compat; /* array of device tree
                         * 'compatible' strings */

    unsigned int        nr_irqs;    /* number of IRQs */

#ifdef CONFIG_ZONE_DMA
    phys_addr_t     dma_zone_size;  /* size of DMA-able area */
#endif

    unsigned int        video_start;    /* start of video RAM   */
    unsigned int        video_end;  /* end of video RAM */

    unsigned char       reserve_lp0 :1; /* never has lp0    */
    unsigned char       reserve_lp1 :1; /* never has lp1    */
    unsigned char       reserve_lp2 :1; /* never has lp2    */
    enum reboot_mode    reboot_mode;    /* default restart mode */
    struct smp_operations   *smp;       /* SMP operations   */
    bool            (*smp_init)(void);
    void            (*fixup)(struct tag *, char **,
                     struct meminfo *);
    void            (*init_meminfo)(void);
    void            (*reserve)(void);/* reserve mem blocks  */
    void            (*map_io)(void);/* IO mapping function  */
    void            (*init_early)(void);
    void            (*init_irq)(void);
    void            (*init_time)(void);
    void            (*init_machine)(void);
    void            (*init_late)(void);
#ifdef CONFIG_MULTI_IRQ_HANDLER
    void            (*handle_irq)(struct pt_regs *);
#endif
    void            (*restart)(enum reboot_mode, const char *);
};

內核將機器信息記錄爲machine_desc結構體(該定義在/arch/arm/include/asm/mach/arch.h),並保存在_arch_info_begin_arch_info_end之間(_arch_info_begin_arch_info_end爲虛擬地址,是編譯內核時指定的,此時mmu還未進行初始化。它其實經過彙編完成地址偏移操做)

machine_desc結構體用宏MACHINE_START進行定義,通常在/arch/arm/子目錄,與板級相關的文件中進行成員函數及變量的賦值。由linker將machine_desc彙集在.arch.info.init節區造成列表。

bootloader引導內核時,ARM寄存器r2會將.dtb的首地址傳給內核,內核根據該地址,解析.dtb中根節點的compatible屬性,將該屬性與內核中預先定義machine_desc結構體的dt_compat成員作匹配,獲得最匹配的一個machine_desc

在代碼中,內核經過在start_kernel->setup_arch中調用setup_machine_fdt來實現上述功能,該函數的具體實現可參見/arch/arm/kernel/devtree.c

設備節點結構體

struct device_node {
    const char *name; // 設備名稱
    const char *type; // 設備類型
    phandle phandle;
    const char *full_name; // 設備全稱,包括父設備名

    struct  property *properties; // 設備屬性鏈表
    struct  property *deadprops;    /* removed properties */
    struct  device_node *parent; // 指向父節點
    struct  device_node *child; // 指向子節點
    struct  device_node *sibling; // 指向兄弟節點
    struct  device_node *next;  /* next device of same type */
    struct  device_node *allnext;   /* next in list of all nodes */
    struct  proc_dir_entry *pde;    /* this node's proc directory */
    struct  kref kref;
    unsigned long _flags;
    void    *data;
#if defined(CONFIG_SPARC)
    const char *path_component_name;
    unsigned int unique_id;
    struct of_irq_controller *irq_trans;
#endif
};

記錄節點信息的結構體。.dtb通過解析以後將以device_node列表的形式存儲節點信息。

屬性結構體

struct property {
    char    *name; // 屬性名
    int length; // 屬性值長度
    void    *value; // 屬性值
    struct property *next; // 指向下一個屬性
    unsigned long _flags; // 標誌
    unsigned int unique_id;
};

device_node結構體中的成員結構體,用於描述節點屬性信息。

uboot下的相關結構體

首先咱們看下uboot用於記錄os、initrd、fdt信息的數據結構bootm_headers,其定義在/include/image.h中,這邊截取了其中與dtb相關的一小部分。

typedef struct bootm_headers {
    ......
#if defined(CONFIG_FIT)
    ......
    void        *fit_hdr_fdt;   /* FDT blob FIT image header */
    const char  *fit_uname_fdt; /* FDT blob subimage node unit name */
    int     fit_noffset_fdt;/* FDT blob subimage node offset */
    ......
#endif
    ......
#ifdef CONFIG_LMB
    struct lmb  lmb;        /* for memory mgmt */
#endif
} bootm_headers_t;

fit_hdr_fdt指向DTB設備樹鏡像的頭。

lmb爲uboot下的一種內存管理機制,全稱爲logical memory blocks。用於管理鏡像的內存。lmb所記錄的內存信息最終會傳遞給kernel。這裏對lmb不作展開描述。在/include/lmb.h和/lib/lmb.c中有對lmb的接口和定義的具體描述。有興趣的讀者能夠看下,所包含的代碼量很少。

DTB加載及解析過程

UBoot處理

devtree-4.png

先從uboot裏的do_bootm出發,根據以前描述,DTB在內存中的地址經過bootm命令進行傳遞。在bootm中,它會根據所傳進來的DTB地址,對DTB所在內存作一系列操做,爲內核解析DTB提供保證。上圖爲對應的函數調用關係圖。

在do_bootm中,主要調用函數爲do_bootm_states,第四個參數爲bootm所要處理的階段和狀態。

在do_bootm_states中,bootm_start會對lmb進行初始化操做,lmb所管理的物理內存塊有三種方式獲取。起始地址,優先級從上往下:

  1. 環境變量「bootm_low」
  2. 宏CONFIG_SYS_SDRAM_BASE(在tegra124中爲0x80000000)
  3. gd->bd->bi_dram[0].start

大小:

  1. 環境變量「bootm_size」
  2. gd->bd->bi_dram[0].size

通過初始化以後,這塊內存就歸lmb所管轄。接着,調用bootm_find_os進行kernel鏡像的相關操做,這裏不具體闡述。

還記得以前講過bootm的三個參數麼,第一個參數內核地址已經被bootm_find_os處理,而接下來的兩個參數會在bootm_find_other中執行操做。

  • 首先,bootm_find_other根據第二個參數找到ramdisk的地址,獲得ramdisk的鏡像;而後根據第三個參數獲得DTB鏡像,同檢查kernel和ramdisk鏡像同樣,檢查DTB鏡像也會進行一系列的校驗工做,若是校驗錯誤,將沒法正常啓動內核。另外,uboot在確認DTB鏡像無誤以後,會將該地址保存在環境變量「fdtaddr」中。
  • 接着,uboot會把DTB鏡像reload一次,使得DTB鏡像所在的物理內存歸lmb所管理:

    1. boot_fdt_add_mem_rsv_regions會將原先的內存DTB鏡像所在的內存置爲reserve,保證該段內存不會被其餘非法使用,保證接下來的reload數據是正確的;
    2. boot_relocate_fdt會在bootmap區域中申請一塊未被使用的內存,接着將DTB鏡像內容複製到這塊區域(即歸lmb所管理的區域)
注:若環境變量中,指定「fdt_high」參數,則會根據該值,調用lmb_alloc_base函數來分配DTB鏡像reload的地址空間。若分配失敗,則會中止bootm操做。於是,不建議設置fdt_high參數。

接下來,do_bootm會根據內核的類型調用對應的啓動函數。與linux對應的是do_bootm_linux

  1. boot_prep_linux:爲啓動後的kernel準備參數
  2. boot_jump_linux:

    ......
        if (IMAGE_ENABLE_OF_LIBFDT && images->ft_len)
            r2 = (unsigned long)images->ft_addr;
        else
            r2 = gd->bd->bi_boot_params;
    
        if (!fake) {
            ......
                kernel_entry(0, machid, r2);
        }

    以上是boot_jump_linux的片斷代碼,能夠看出:若使用DTB,則原先用來存儲ATAG的寄存器R2,將會用來存儲.dtb鏡像地址。boot_jump_linux最後將調用kernel_entry,將.dtb鏡像地址傳給內核。

內核處理

arch/arm/kernel/head.S中,有這樣一段:

/*
     * r1 = machine no, r2 = atags or dtb,
     * r8 = phys_offset, r9 = cpuid, r10 = procinfo
     */
    bl  __vet_atags

_vet_atags定義在/arch/arm/kernel/head-common.S中,它主要對DTB鏡像作了一個簡單的校驗。

__vet_atags:
    tst r2, #0x3            @ aligned?
    bne 1f

    ldr r5, [r2, #0] 
#ifdef CONFIG_OF_FLATTREE
    ldr r6, =OF_DT_MAGIC        @ is it a DTB?
    cmp r5, r6
    beq 2f
#endif
    cmp r5, #ATAG_CORE_SIZE     @ is first tag ATAG_CORE?
    cmpne   r5, #ATAG_CORE_SIZE_EMPTY
    bne 1f
    ldr r5, [r2, #4] 
    ldr r6, =ATAG_CORE
    cmp r5, r6
    bne 1f

2:  mov pc, lr              @ atag/dtb pointer is ok

1:  mov r2, #0
    mov pc, lr
ENDPROC(__vet_atags)

真正解析處理dbt的開始部分,是setup_arch->setup_machine_fdt

devtree-5.png

如圖,是setup_machine_fdt中的解析過程。

  1. 解析chosen節點將對boot_command_line進行初始化。
  2. 解析根節點的{size,address}將對dt_root_size_cellsdt_root_addr_cells進行初始化。爲以後解析memory等其餘節點提供依據。
  3. 解析memory節點,將會把節點中描述的內存,加入memory的bank。爲以後的內存初始化提供條件。

解析設備樹在函數unflatten_device_tree中完成,它將.dtb解析成device_node結構,並構成單項鍊表,以供OF的API接口使用。

下面主要結合代碼分析:/drivers/of/fdt.c

void __init unflatten_device_tree(void)
{
    /* 解析設備樹,將全部的設備節點鏈如全局鏈表 of_allnodes 中 */
    __unflatten_device_tree(initial_boot_params, &of_allnodes,
                early_init_dt_alloc_memory_arch);

    /* 設置內核輸出終端,以及遍歷「aliases」節點下的全部屬性,加入相應鏈表 */
    /* Get pointer to "/chosen" and "/aliases" nodes for use everywhere */
    of_alias_scan(early_init_dt_alloc_memory_arch);
}
static void __unflatten_device_tree(struct boot_param_header *blob,
                 struct device_node **mynodes,
                 void * (*dt_alloc)(u64 size, u64 align))
{
    unsigned long size;
    int start;
    void *mem;
    struct device_node **allnextp = mynodes;
    ......

    /* 檢查設備樹 magic */
    if (be32_to_cpu(blob->magic) != OF_DT_HEADER) {
        pr_err("Invalid device tree blob header\n");
        return;
    }

    /* 找到設備樹的設備節點起始地址 *//
    start = 0;
    /* 第一次調用mem傳0,allnextpp傳NULL,其實是爲了計算整個設備樹所要的空間 */
    size = (unsigned long)unflatten_dt_node(blob, 0, &start, NULL, NULL, 0);
    size = ALIGN(size, 4);

    pr_debug("  size is %lx, allocating...\n", size);

    /* 調用early_init_dt_alloc_memory_arch函數,爲設備樹分配內存空間 */
    mem = dt_alloc(size + 4, __alignof__(struct device_node));
    memset(mem, 0, size);

    /* 設備樹結束處賦值0xdeadbeef,爲了後面檢查是否有數據溢出 */
    *(__be32 *)(mem + size) = cpu_to_be32(0xdeadbeef);

    pr_debug("  unflattening %p...\n", mem);

    /* 再次獲取設備樹的設備節點起始地址 */
    start = 0;
    /* mem爲設備樹分配的內存空間,allnextp指向全局變量of_allnodes,生成整個設備樹 */
    unflatten_dt_node(blob, mem, &start, NULL, &allnextp, 0);
    if (be32_to_cpup(mem + size) != 0xdeadbeef)
        pr_warning("End of tree marker overwritten: %08x\n",
               be32_to_cpup(mem + size));
    *allnextp = NULL;

    pr_debug(" <- unflatten_device_tree()\n");
}
static void * unflatten_dt_node(struct boot_param_header *blob,
                void *mem,
                int *poffset,
                struct device_node *dad,
                struct device_node ***allnextpp,
                unsigned long fpsize)
{
    ......
    /* 得到節點名或節點路徑名 */
    pathp = fdt_get_name(blob, *poffset, &l);
    if (!pathp)
        return mem;
    
    allocl = l++; // 節點名稱的長度

    /* 若是是節點名則進入,如果節點路徑名則(*pathp) == '/' */
    if ((*pathp) != '/') {
        new_format = 1;
        if (fpsize == 0) {
            ......
        } else {
            fpsize += l; // 待分配的長度=本節點名稱長度+父親節點絕對路徑的長度
            allocl = fpsize;
        }
    }

    /* 分配一個設備節點結構device_node,mem記錄了分配空間大小,最終會累加,計算出該設備樹總共分配的空間 */
    np = unflatten_dt_alloc(&mem, sizeof(struct device_node) + allocl,
                __alignof__(struct device_node));
    /* 第一次調用unflatten_dt_alloc時,allnextpp=NULL。第二次時, allnextpp指向全局變量of_allnodes */
    if (allnextpp) {
        char *fn;
        np->full_name = fn = ((char *)np) + sizeof(*np); // full_name保存完整節點名,包括各級父節點
        /* 若new_format=1,表示pathp保存的是節點名,不是路徑名,因此須要加上父節點名稱 */
        if (new_format) {
            if (dad && dad->parent) {
                strcpy(fn, dad->full_name); // 拷貝父節點絕對路徑
                fn += strlen(fn);
            }
            *(fn++) = '/';
        }
        memcpy(fn, pathp, l); // 拷貝本節點名稱

        prev_pp = &np->properties; // prev_pp指向節點的屬性鏈表
        **allnextpp = np;
        *allnextpp = &np->allnext;
        /* 若父節點不爲空,則設置該節點的parent */
        if (dad != NULL) {
            np->parent = dad; // 指向父節點
            if (dad->next == NULL)
                dad->child = np; // child指向第一個孩子
            else
                dad->next->sibling = np; // 把np插入next,這樣子節點造成鏈表
            dad->next = np;
        }
        kref_init(&np->kref);
    }
    /* 處理該節點的屬性 */
    for (offset = fdt_first_property_offset(blob, *poffset);
         (offset >= 0);
         (offset = fdt_next_property_offset(blob, offset))) {
        ......
        /* 獲取屬性名稱 */
        if (!(p = fdt_getprop_by_offset(blob, offset, &pname, &sz))) {
            offset = -FDT_ERR_INTERNAL;
            break;
        }
        ......
        /* 是否有名稱爲name的屬性 */
        if (strcmp(pname, "name") == 0)
            has_name = 1;
        /* 爲該屬性分配一個屬性結構,即struct property */
        pp = unflatten_dt_alloc(&mem, sizeof(struct property),
                    __alignof__(struct property));
        if (allnextpp) {
            ......
            pp->name = (char *)pname; // 屬性名
            pp->length = sz; // 屬性值長度
            pp->value = (__be32 *)p; // 屬性值
            *prev_pp = pp; // 將屬性插入該節點的屬性鏈表
            prev_pp = &pp->next;
        }
    }
    /* 若是該節點沒有「name」的屬性,則生成一個name屬性,插入到該節點的屬性鏈表 */
    if (!has_name) {
        ......
    }
    /* allnextpp被設置時,構建np */
    if (allnextpp) {
        ......
    }

    old_depth = depth;
    *poffset = fdt_next_node(blob, *poffset, &depth);
    if (depth < 0)
        depth = 0;
    /* 遍歷子節點 */
    while (*poffset > 0 && depth > old_depth)
        mem = unflatten_dt_node(blob, mem, poffset, np, allnextpp,
                    fpsize);
    ......
    return mem;
}
void of_alias_scan(void * (*dt_alloc)(u64 size, u64 align))
{
    struct property *pp;

    /* 根據全局鏈表of_allnodes,查找"/chosen"或"/chosen@0"節點,賦值給全局變量of_chosen */
    of_chosen = of_find_node_by_path("/chosen");
    if (of_chosen == NULL)
        of_chosen = of_find_node_by_path("/chosen@0");

    /* 若是of_chosen存在,則查找"linux,stdout-path",該屬性爲標準終端設備節點路徑名,內核以此作爲默認終端 */
    if (of_chosen) {
        const char *name;

        name = of_get_property(of_chosen, "linux,stdout-path", NULL);
        if (name)
            of_stdout = of_find_node_by_path(name);
    }

    /* 查找"/aliases"節點,賦值給全局變量of_aliases */
    of_aliases = of_find_node_by_path("/aliases");
    if (!of_aliases)
        return;

    /* 遍歷of_aliases下的全部屬性 */
    for_each_property_of_node(of_aliases, pp) {
        ......
        /* 跳過一些屬性 */
        if (!strcmp(pp->name, "name") ||
            !strcmp(pp->name, "phandle") ||
            !strcmp(pp->name, "linux,phandle"))
            continue;

        /* 根據屬性找到對應的設備節點 */
        np = of_find_node_by_path(pp->value);
        if (!np)
            continue;

        /* 去除屬性名中尾部的數字,即設備id */
        while (isdigit(*(end-1)) && end > start)
            end--;
        len = end - start;

        /* 將屬性名中尾部的數字轉化爲十進制數,作爲設備id號 */
        if (kstrtoint(end, 10, &id) < 0)
            continue;

        /* 分配alias_prop結構 */
        ap = dt_alloc(sizeof(*ap) + len + 1, 4);
        if (!ap)
            continue;
        memset(ap, 0, sizeof(*ap) + len + 1);
        ap->alias = start;
        /* 將該設備的alias指向對應的device_node,而且鏈入aliases_lookup鏈表中 */
        of_alias_add(ap, np, id, start, len);
    }
}

總的概括爲

  1. kernel入口處獲取到uboot傳過來的.dtb鏡像的基地址
  2. 經過early_init_dt_scan()函數來獲取kernel初始化時須要的bootargs和cmd_line等系統引導參數。
  3. 調用unflatten_device_tree函數來解析dtb文件,構建一個由device_node結構鏈接而成的單向鏈表,並使用全局變量of_allnodes保存這個鏈表的頭指針。
  4. 內核調用OF的API接口,獲取of_allnodes鏈表信息來初始化內核其餘子系統、設備等。

經常使用OF API

在Linux的BSP和驅動代碼中,還常常會使用到Linux中一組Device Tree的API,這些API一般被冠以of_前綴,它們的實現代碼位於內核的drivers/of目錄。這些經常使用的API包括:

int of_device_is_compatible(const struct device_node device,const char compat);

​ 判斷設備結點的compatible 屬性是否包含compat指定的字符串。當一個驅動支持2個或多個設備的時候,這些不一樣.dts文件中設備的compatible 屬性都會進入驅動 OF匹配表。所以驅動能夠透過Bootloader傳遞給內核的Device Tree中的真正結點的compatible 屬性以肯定到底是哪種設備,從而根據不一樣的設備類型進行不一樣的處理。如drivers/pinctrl/pinctrl-sirf.c即兼容於"sirf,prima2-pinctrl",又兼容於"sirf,prima2-pinctrl",在驅動中就有相應分支處理:

1682 if (of_device_is_compatible(np, "sirf,marco-pinctrl"))
    1683      is_marco = 1;

struct device_node of_find_compatible_node(struct device_node from, const char type, const char compatible);

​ 根據compatible屬性,得到設備結點。遍歷Device Tree中全部的設備結點,看看哪一個結點的類型、compatible屬性與本函數的輸入參數匹配,大多數狀況下,from、type爲NULL。

int of_property_read_u8_array(const struct device_node np, const char propname, u8 *out_values, size_t sz);

int of_property_read_u16_array(const struct device_node np, const char propname, u16 *out_values, size_t sz);

int of_property_read_u32_array(const struct device_node np, const char propname, u32 *out_values, size_t sz);

int of_property_read_u64(const struct device_node np, const char propname, u64 *out_value);

​ 讀取設備結點np的屬性名爲propname,類型爲八、1六、3二、64位整型數組的屬性。對於32位處理器來說,最經常使用的是of_property_read_u32_array()。如在arch/arm/mm/cache-l2x0.c中,透過以下語句讀取L2 cache的"arm,data-latency"屬性:

534         of_property_read_u32_array(np, "arm,data-latency",
    535                                    data, ARRAY_SIZE(data));

​ 在arch/arm/boot/dts/vexpress-v2p-ca9.dts中,含有"arm,data-latency"屬性的L2 cache結點以下:

137         L2: cache-controller@1e00a000 {
    138                 compatible = "arm,pl310-cache";
    139                 reg = <0x1e00a000 0x1000>;
    140                 interrupts = <0 43 4>;
    141                 cache-level = <2>;
    142                 arm,data-latency = <1 1 1>;
    143                 arm,tag-latency = <1 1 1>;
    144         }

​ 有些狀況下,整形屬性的長度可能爲1,因而內核爲了方便調用者,又在上述API的基礎上封裝出了更加簡單的讀單一整形屬性的API,它們爲int of_property_read_u8()、of_property_read_u16()等,實現於include/linux/of.h:

513 static inline int of_property_read_u8(const struct device_node *np,
    514                                        const char *propname,
    515                                        u8 *out_value)
    516 {
    517         return of_property_read_u8_array(np, propname, out_value, 1);
    518 }
    519
    520 static inline int of_property_read_u16(const struct device_node *np,
    521                                        const char *propname,
    522                                        u16 *out_value)
    523 {
    524         return of_property_read_u16_array(np, propname, out_value, 1);
    525 }
    526
    527 static inline int of_property_read_u32(const struct device_node *np,
    528                                        const char *propname,
    529                                        u32 *out_value)
    530 {
    531         return of_property_read_u32_array(np, propname, out_value, 1);
    532 }

int of_property_read_string(struct device_node np, const char propname, const char out_string);**

int of_property_read_string_index(struct device_node np, const char propname, int index, const char output);**

​ 前者讀取字符串屬性,後者讀取字符串數組屬性中的第index個字符串。如drivers/clk/clk.c中的of_clk_get_parent_name()透過of_property_read_string_index()遍歷clkspec結點的全部"clock-output-names"字符串數組屬性。

1759 const char *of_clk_get_parent_name(struct device_node *np, int index)
    1760 {
    1761         struct of_phandle_args clkspec;
    1762         const char *clk_name;
    1763         int rc;
    1764
    1765         if (index < 0)
    1766                 return NULL;
    1767
    1768         rc = of_parse_phandle_with_args(np, "clocks", "#clock-cells", index,
    1769                                         &clkspec);
    1770         if (rc)
    1771                 return NULL;
    1772
    1773         if (of_property_read_string_index(clkspec.np, "clock-output-names",
    1774                                   clkspec.args_count ? clkspec.args[0] : 0,
    1775                                           &clk_name) < 0)
    1776                 clk_name = clkspec.np->name;
    1777
    1778         of_node_put(clkspec.np);
    1779         return clk_name;
    1780 }
    1781 EXPORT_SYMBOL_GPL(of_clk_get_parent_name);

static inline bool of_property_read_bool(const struct device_node np, const char propname);

​ 若是設備結點np含有propname屬性,則返回true,不然返回false。通常用於檢查空屬性是否存在。

void __iomem of_iomap(struct device_node node, int index);

​ 經過設備結點直接進行設備內存區間的 ioremap(),index是內存段的索引。若設備結點的reg屬性有多段,可經過index標示要ioremap的是哪一段,只有1段的狀況,index爲0。採用Device Tree後,大量的設備驅動經過of_iomap()進行映射,而再也不經過傳統的ioremap。

unsigned int irq_of_parse_and_map(struct device_node *dev, int index);

​ 透過Device Tree或者設備的中斷號,其實是從.dts中的interrupts屬性解析出中斷號。若設備使用了多箇中斷,index指定中斷的索引號。

還有一些OF API,這裏不一一列舉,具體可參考include/linux/of.h頭文件。

總結

ARM社區一向充斥的大量垃圾代碼致使Linus盛怒,所以社區在2011年到2012年進行了大量的工做。ARM Linux開始圍繞Device Tree展開,Device Tree有本身的獨立的語法,它的源文件爲.dts,編譯後獲得.dtb,Bootloader在引導Linux內核的時候會將.dtb地址告知內核。以後內核會展開Device Tree並建立和註冊相關的設備,所以arch/arm/mach-xxx和arch/arm/plat-xxx中大量的用於註冊platform、I2C、SPI板級信息的代碼被刪除,而驅動也以新的方式和.dts中定義的設備結點進行匹配。

相關文章
相關標籤/搜索