ARM Linux 3.x的設備樹(Device Tree)
1. ARM Device Tree起源
Linus Torvalds在2011年3月17日的ARM Linux郵件列表宣稱「this whole ARM thing is a f*cking pain in the ass」,引起ARM Linux社區的地震,隨後ARM社區進行了一系列的重大修正.在過去的ARM Linux中,arch/arm/plat-xxx和arch/arm/mach-xxx中充斥着大量的垃圾代碼,至關多數的代碼只是在描述板級細節,而 這些板級細節對於內核來說,不過是垃圾,如板上的platform設備、resource、i2c_board_info、spi_board_info 以及各類硬件的platform_data.讀者有興趣能夠統計下常見的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中):express
- CPU的數量和類別
- 內存基地址和大小
- 總線和橋
- 外設鏈接
- 中斷控制器和中斷使用狀況
- GPIO控制器和GPIO使用狀況
- Clock控制器和Clock使用狀況
它基本上就是畫一棵電路板上CPU、總線、設備組成的樹,Bootloader會將這棵樹傳遞給內核,而後內核能夠識別這棵樹,並根據它展開出Linux內 核中的platform_device、i2c_client、spi_device等設備,而這些設備用到的內存、IRQ等資源,也被傳遞給了內核,內 核會將這些資源綁定給展開的相應的設備.數組
2. Device Tree組成和結構
整個Device Tree牽涉面比較廣,即增長了新的用於描述設備硬件信息的文本格式,又增長了編譯這一文本的工具,同時Bootloader也須要支持將編譯後的Device Tree傳遞給Linux內核.數據結構
DTS (device tree source)架構
.dts 文件是一種ASCII 文本格式的Device Tree描述,此文本格式很是人性化,適合人類的閱讀習慣.基本上,在ARM Linux在,一個.dts文件對應一個ARM的machine,通常放置在內核的arch/arm/boot/dts/目錄.因爲一個SoC可能對應多個machine(一個SoC能夠對應多個產品和電路板),勢必這些.dts文件需包含許多共同的部分,Linux內核爲了簡化,把SoC公用的部分或者多個machine共同的部分通常提煉爲.dtsi,相似於C語言的頭文件.其餘的machine對應的.dts就include這個.dtsi.譬如,對於VEXPRESS而言,vexpress-v2m.dtsi就被vexpress-v2p-ca9.dts所引用,vexpress-v2p-ca9.dts有以下一行:函數
/include/ "vexpress-v2m.dtsi"
固然,和C語言的頭文件相似,.dtsi也能夠include其餘的.dtsi,譬如幾乎全部的ARM SoC的.dtsi都引用了skeleton.dtsi.工具
.dts(或者其include的.dtsi)基本元素即爲前文所述的結點和屬性:ui
/ { 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源文件的結構:this
- 1個root結點"/";
- root結點下面含一系列子結點,本例中爲"node1" 和 "node2";
- 結點"node1"下又含有一系列子結點,本例中爲"child-node1" 和 "child-node2";
- 各結點都有一系列屬性.屬性都是簡單的key-value對,其中value能夠是空的或包含任意的byte流.
1. 屬性爲空,如node2的an-empty-property;
2. 爲雙引號包含的字符串,如a-string-property = "A string";
3. 爲字符串數組,如a-string-list-property = "first string", "second string";
4. 爲Cells(32位無符號整數),如second-child-property = <1>;
5. 爲二進制數,如a-byte-data-property = [0x01 0x23 0x34 0x56];
6. 爲混合數據(不一樣類型數據用逗號隔開),如mixed-property = "a string", [0x01 0x02 0x03 0x04], <0xFF01 412 0x12341283>;
下面以一個最簡單的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>; }; }; };
上述.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保持了寄存器兼容.
接下來root結點"/"的cpus子結點下面又包含2個cpu子結點,描述了此machine上的2個CPU,而且兩者的compatible 屬性爲"arm,cortex-a9".
注意cpus和cpus的2個cpu子結點的命名,節點的命名應該取類型名,而不是IC名.它們遵循的組織形式爲:<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標準給出告終點命名的規範.
可尋址的設備使用以下信息來在Device Tree中編碼地址信息:
reg #address-cells #size-cells
其中reg的組織形式爲reg = <address1 length1 [address2 length2] [address3 length3] ... >,其中的每一組address length代表了設備使用的一個地址範圍.address爲1個或多個32位的整型(即cell),而length則爲cell的列表或者爲空 (若#size-cells = 0).address 和 length 字段是可變長的,父結點的#address-cells和#size-cells分別決定了子結點的reg屬性的address和length字段的長度.在本例中,root結點的#address-cells = <1>;和#size-cells = <1>;決定了serial、gpio、spi等結點的address和length字段的長度分別爲1.cpus 結點的#address-cells = <1>;和#size-cells = <0>;決定了2個cpu子結點的address爲1,而length爲空,因而造成了2個cpu的reg = <0>;和reg = <1>.還有,那些藥經過外部芯片片選激活的模塊.例如,掛載在外部總線上,須要經過片選線工做的一些模塊.如external-bus結點的#address-cells = <2>和#size-cells = <1>;決定了其下的ethernet、i2c、flash的reg字段形如reg = <0 0 0x1000>;reg = <1 0 0x1000>;和reg = <2 0 0x4000000>;其中address字段長度爲2個cell,第一個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地址.由於I2C設備只是被分配在一個地址上,不須要其餘任何空間,因此只須要一個address的cell就能夠描述完整,不須要size-cells.
root結點的子結點描述的是CPU的視圖,所以root子結點的address區域就直接位於CPU的memory區域.可是,要描述通過總線橋後的非本地設備的話,就不得不須要描述一下從設備地址空間到CPU地址空間的映射關係,此時就須要用到ranges屬性. 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 – 這個屬性爲空,用來聲明這個node接收中斷信號;
#interrupt-cells – 與#address-cells 和 #size-cells類似,這是中斷控制器節點的屬性,用來標識這個控制器須要幾個單位作中斷描述符;
在整個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就有以下文字說明:
The 1st cell is the interrupt type; 0 for SPI interrupts, 1 for PPI interrupts. The 2nd cell contains the interrupt number for the interrupt type. SPI interrupts are in the range [0-987]. PPI interrupts are in the range [0-15]. The 3rd cell is the flags, encoded as follows: bits[3:0] trigger type and level flags. 1 = low-to-high edge triggered 2 = high-to-low edge triggered 4 = active high level-sensitive 8 = active low level-sensitive bits[15:8] PPI interrupt cpu mask. Each bit corresponds to each of the 8 possible cpus attached to the GIC. A bit set to '1' indicated the interrupt is wired to that CPU. Only valid for PPI interrupts.
另 外,值得注意的是,一個設備還可能用到多箇中斷號.對於ARM GIC而言,若某設備使用了SPI的16八、169號2箇中斷,而言都是高電平觸發,則該設備結點的interrupts屬性可定義 爲:interrupts = <0 168 4>, <0 169 4>;
除了中斷之外,在ARM Linux中clock、GPIO、pinmux均可以透過.dts中的結點和屬性進行描述.
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到內存.
Binding
對於Device Tree中的結點和屬性具體是如何來描述設備的硬件細節的,通常須要文檔來進行講解,文檔的後綴名通常爲.txt.這些文檔位於內核的Documentation/devicetree/bindings目錄,其下又分爲不少子目錄.
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,能夠用 -代替.
3. Device Tree引起的BSP和驅動變動
有了Device Tree後,大量的板級信息都再也不須要,譬如過去常常在arch/arm/plat-xxx和arch/arm/mach-xxx實施的以下事情:
註冊platform_device,綁定resource,即內存、IRQ等板級信息
透過Device Tree後,形如
static struct resource xxx_resources[] = { [0] = { .start = …, .end = …, .flags = IORESOURCE_MEM, }, [1] = { .start = …, .end = …, .flags = IORESOURCE_IRQ, }, }; static struct platform_device xxx_device = { .name = "xxx", .id = -1, .dev = { .platform_data = &xxx_data, }, .resource = xxx_resources, .num_resources = ARRAY_SIZE(xxx_resources), };
之類的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:
static struct of_device_id xxx_of_bus_ids[] __initdata = { { .compatible = "simple-bus", }, {}, }; void __init xxx_mach_init(void) { of_platform_bus_probe(NULL, xxx_of_bus_ids, NULL); } #ifdef CONFIG_ARCH_XXX DT_MACHINE_START(XXX_DT, "Generic XXX (Flattened Device Tree)") … .init_machine = xxx_mach_init, … MACHINE_END #endif
註冊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代碼,目前再也不須要出現,如今只須要把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等板級信息
形如
static struct spi_board_info afeb9260_spi_devices[] = { { /* DataFlash chip */ .modalias = "mtd_dataflash", .chip_select = 1, .max_speed_hz = 15 * 1000 * 1000, .bus_num = 0, }, };
之類的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,譬如:
MACHINE_START(VEXPRESS, "ARM-Versatile Express") .atag_offset = 0x100, .smp = smp_ops(vexpress_smp_ops), .map_io = v2m_map_io, .init_early = v2m_init_early, .init_irq = v2m_init_irq, .timer = &v2m_timer, .handle_irq = gic_handle_irq, .init_machine = v2m_init, .restart = vexpress_restart, 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的一系列初始化函數被執行.
static const char * const v2m_dt_match[] __initconst = { "arm,vexpress", "xen,xenvm", NULL, }; DT_MACHINE_START(VEXPRESS_DT, "ARM-Versatile Express") .dt_compat = v2m_dt_match, .smp = smp_ops(vexpress_smp_ops), .map_io = v2m_dt_map_io, .init_early = v2m_dt_init_early, .init_irq = v2m_dt_init_irq, .timer = &v2m_dt_timer, .init_machine = v2m_dt_init, .handle_irq = gic_handle_irq, .restart = vexpress_restart, 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":
static char const *exynos5_dt_compat[] __initdata = { "samsung,exynos5250", "samsung,exynos5440", NULL }; DT_MACHINE_START(EXYNOS5_DT, "SAMSUNG EXYNOS5 (Flattened Device Tree)") /* Maintainer: Kukjin Kim <kgene.kim@samsung.com> */ .init_irq = exynos5_init_irq, .smp = smp_ops(exynos_smp_ops), .map_io = exynos5_dt_map_io, .handle_irq = gic_handle_irq, .init_machine = exynos5_dt_machine_init, .init_late = exynos_init_late, .timer = &exynos4_timer, .dt_compat = exynos5_dt_compat, .restart = exynos5_restart, .reserve = exynos5_reserve, MACHINE_END
它的.init_machine成員函數就針對不一樣的machine進行了不一樣的分支處理:
static void __init exynos5_dt_machine_init(void) { … if (of_machine_is_compatible("samsung,exynos5250")) of_platform_populate(NULL, of_default_bus_match_table, exynos5250_auxdata_lookup, NULL); else if (of_machine_is_compatible("samsung,exynos5440")) of_platform_populate(NULL, of_default_bus_match_table, exynos5440_auxdata_lookup, NULL); }
使用Device Tree後,驅動須要與.dts中描述的設備結點進行匹配,從而引起驅動的probe()函數執行.對於platform_driver而言,須要添加一 個OF匹配表,如前文的.dts文件的"acme,a1234-i2c-bus"兼容I2C控制器結點的OF匹配表能夠是:
static const struct of_device_id a1234_i2c_of_match[] = { { .compatible = "acme,a1234-i2c-bus ", }, {}, }; MODULE_DEVICE_TABLE(of, a1234_i2c_of_match); static struct platform_driver i2c_a1234_driver = { .driver = { .name = "a1234-i2c-bus ", .owner = THIS_MODULE, .of_match_table = a1234_i2c_of_match, }, .probe = i2c_a1234_probe, .remove = i2c_a1234_remove, }; module_platform_driver(i2c_a1234_driver);
對於I2C和SPI從設備而言,一樣也能夠透過of_match_table添加匹配的.dts中的相關結點的compatible屬性,如sound/soc/codecs/wm8753.c中的:
static const struct of_device_id wm8753_of_match[] = { { .compatible = "wlf,wm8753", }, { } }; MODULE_DEVICE_TABLE(of, wm8753_of_match); static struct spi_driver wm8753_spi_driver = { .driver = { .name = "wm8753", .owner = THIS_MODULE, .of_match_table = wm8753_of_match, }, .probe = wm8753_spi_probe, .remove = wm8753_spi_remove, }; static struct i2c_driver wm8753_i2c_driver = { .driver = { .name = "wm8753", .owner = THIS_MODULE, .of_match_table = wm8753_of_match, }, .probe = wm8753_i2c_probe, .remove = wm8753_i2c_remove, .id_table = wm8753_i2c_id, };
不過這邊有一點須要提醒的是,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設備和驅動均可以匹配上:
static int spi_match_device(struct device *dev, struct device_driver *drv) { const struct spi_device *spi = to_spi_device(dev); const struct spi_driver *sdrv = to_spi_driver(drv); /* Attempt an OF style match */ if (of_driver_match_device(dev, drv)) return 1; /* Then try ACPI */ if (acpi_driver_match_device(dev, drv)) return 1; if (sdrv->id_table) return !!spi_match_id(sdrv->id_table, spi); return strcmp(spi->modalias, drv->name) == 0; } static const struct spi_device_id *spi_match_id(const struct spi_device_id *id, const struct spi_device *sdev) { while (id->name[0]) { if (!strcmp(sdev->modalias, id->name)) return id; id++; } return NULL; }
4. 經常使用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",在驅動中就有相應分支處理:
if (of_device_is_compatible(np, "sirf,marco-pinctrl")) 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"屬性:
of_property_read_u32_array(np, "arm,data-latency", data, ARRAY_SIZE(data));
在arch/arm/boot/dts/vexpress-v2p-ca9.dts中,含有"arm,data-latency"屬性的L2 cache結點以下:
L2: cache-controller@1e00a000 { compatible = "arm,pl310-cache"; reg = <0x1e00a000 0x1000>; interrupts = <0 43 4>; cache-level = <2>; arm,data-latency = <1 1 1>; arm,tag-latency = <1 1 1>; }
有些狀況下,整形屬性的長度可能爲1,因而內核爲了方便調用者,又在上述API的基礎上封裝出了更加簡單 的讀單一整形屬性的API,它們爲int of_property_read_u8()、of_property_read_u16()等,實現於include/linux/of.h:
static inline int of_property_read_u8(const struct device_node *np, const char *propname, u8 *out_value) { return of_property_read_u8_array(np, propname, out_value, 1); } static inline int of_property_read_u16(const struct device_node *np, const char *propname, u16 *out_value) { return of_property_read_u16_array(np, propname, out_value, 1); } static inline int of_property_read_u32(const struct device_node *np, const char *propname, u32 *out_value) { return of_property_read_u32_array(np, propname, out_value, 1); } 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"字符串數組屬性.
const char *of_clk_get_parent_name(struct device_node *np, int index) { struct of_phandle_args clkspec; const char *clk_name; int rc; if (index < 0) return NULL; rc = of_parse_phandle_with_args(np, "clocks", "#clock-cells", index, &clkspec); if (rc) return NULL; if (of_property_read_string_index(clkspec.np, "clock-output-names", clkspec.args_count ? clkspec.args[0] : 0, &clk_name) < 0) clk_name = clkspec.np->name; of_node_put(clkspec.np); return clk_name; } 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頭文件.
5. 總結
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中定義的設備結點進行匹配.
- 1. ARM Linux 3.x的設備樹（Device Tree）
- 2. ARM Linux&設備樹（Device Tree）
- 3. Linux設備樹（Device Tree)
- 4. Linux 設備樹（Device Tree）(轉載)
- 5. 【轉載】Linux設備樹(Device Tree)機制
- 6. [RK3399][Android7.1]設備樹系列 - 設備樹（device Tree）的由來
- 7. 設備樹（device tree）學習筆記
- 8. [dts]Device Tree機制（設備樹）
- 9. ARM設備樹
- 10. ARM 設備樹
- 更多相關文章...
- • 移動設備 統計 - 瀏覽器信息
- • XML 樹結構 - XML 教程
- • IntelliJ IDEA代碼格式化設置
- • Docker容器實戰(七) - 容器眼光下的文件系統
-
每一个你不满意的现在，都有一个你没有努力的曾经。