ARM Linux 3.x的設備樹(Device Tree)
加入技術交流群
Linus Torvalds在2011年3月17日的ARM Linux郵件列表宣稱“this whole ARM thing is a f*cking pain in the ass”，引發(fā)ARM Linux社區(qū)的地震，隨后ARM社區(qū)進行了一系列的重大修正。在過去的ARM Linux中，arch/arm/plat-xxx和arch/arm/mach-xxx中充斥著大量的垃圾代碼，相當多數(shù)的代碼只是在描述板級細節(jié)，而這些板級細節(jié)對于內核來講，不過是垃圾，如板上的platform設備、resource、i2c_board_info、spi_board_info以及各種硬件的platform_data。讀者有興趣可以統(tǒng)計下常見的s3c2410、s3c6410等板級目錄，代碼量在數(shù)萬行。
社區(qū)必須改變這種局面，于是PowerPC等其他體系架構下已經(jīng)使用的Flattened Device Tree（FDT）進入ARM社區(qū)的視野。Device Tree是一種描述硬件的數(shù)據(jù)結構，它起源于 OpenFirmware (OF)。在Linux 2.6中，ARM架構的板極硬件細節(jié)過多地被硬編碼在arch/arm/plat-xxx和arch/arm/mach-xxx，采用Device Tree后，許多硬件的細節(jié)可以直接透過它傳遞給Linux，而不再需要在kernel中進行大量的冗余編碼。Device Tree由一系列被命名的結點（node）和屬性（property）組成，而結點本身可包含子結點。所謂屬性，其實就是成對出現(xiàn)的name和value。在Device Tree中，可描述的信息包括（原先這些信息大多被hard code到kernel中）：
社區(qū)必須改變這種局面，于是PowerPC等其他體系架構下已經(jīng)使用的Flattened Device Tree（FDT）進入ARM社區(qū)的視野。Device Tree是一種描述硬件的數(shù)據(jù)結構，它起源于 OpenFirmware (OF)。在Linux 2.6中，ARM架構的板極硬件細節(jié)過多地被硬編碼在arch/arm/plat-xxx和arch/arm/mach-xxx，采用Device Tree后，許多硬件的細節(jié)可以直接透過它傳遞給Linux，而不再需要在kernel中進行大量的冗余編碼。Device Tree由一系列被命名的結點（node）和屬性（property）組成，而結點本身可包含子結點。所謂屬性，其實就是成對出現(xiàn)的name和value。在Device Tree中，可描述的信息包括（原先這些信息大多被hard code到kernel中）：
- CPU的數(shù)量和類別
- 內存基地址和大小
- 總線和橋
- 外設連接
- 中斷控制器和中斷使用情況
- GPIO控制器和GPIO使用情況
- Clock控制器和Clock使用情況
view plaincopy
本文引用地址：http://cafeforensic.com/article/201611/317984.htm- /{
- node1{
- a-string-property="Astring";
- a-string-list-property="firststring","secondstring";
- a-byte-data-property=[0x010x230x340x56];
- child-node1{
- first-child-property;
- second-child-property=<1>;
- a-string-property="Hello,world";
- };
- child-node2{
- };
- };
- node2{
- an-empty-property;
- a-cell-property=<1234>;/*eachnumber(cell)isauint32*/
- child-node1{
- };
- };
- };
root結點下面含一系列子結點，本例中為"node1" 和 "node2"；結點"node1"下又含有一系列子結點，本例中為"child-node1" 和 "child-node2"；各結點都有一系列屬性。這些屬性可能為空，如" an-empty-property"；可能為字符串，如"a-string-property"；可能為字符串數(shù)組，如"a-string-list-property"；可能為Cells（由u32整數(shù)組成），如"second-child-property"，可能為二進制數(shù)，如"a-byte-data-property"。下面以一個最簡單的machine為例來看如何寫一個.dts文件。假設此machine的配置如下：
1個雙核ARM Cortex-A9 32位處理器；ARM的local bus上的內存映射區(qū)域分布了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文件為：[plain]view plaincopy
- /{
- 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=<0x101f00000x1000>;
- interrupts=<10>;
- };
- serial@101f2000{
- compatible="arm,pl011";
- reg=<0x101f20000x1000>;
- interrupts=<20>;
- };
- gpio@101f3000{
- compatible="arm,pl061";
- reg=<0x101f30000x1000
- 0x101f40000x0010>;
- interrupts=<30>;
- };
- intc:interrupt-controller@10140000{
- compatible="arm,pl190";
- reg=<0x101400000x1000>;
- interrupt-controller;
- #interrupt-cells=<2>;
- };
- spi@10115000{
- compatible="arm,pl022";
- reg=<0x101150000x1000>;
- interrupts=<40>;
- };
- external-bus{
- #address-cells=<2>
- #size-cells=<1>;
- ranges=<000x101000000x10000//Chipselect1,Ethernet
- 100x101600000x10000//Chipselect2,i2ccontroller
- 200x300000000x1000000>;//Chipselect3,NORFlash
- ethernet@0,0{
- compatible="smc,smc91c111";
- reg=<000x1000>;
- interrupts=<52>;
- };
- i2c@1,0{
- compatible="acme,a1234-i2c-bus";
- #address-cells=<1>;
- #size-cells=<0>;
- reg=<100x1000>;
- interrupts=<62>;
- rtc@58{
- compatible="maxim,ds1338";
- reg=<58>;
- interrupts=<73>;
- };
- };
- flash@2,0{
- compatible="samsung,k8f1315ebm","cfi-flash";
- reg=<200x4000000>;
- };
- };
- };
在.dts文件的每個設備，都有一個compatible 屬性，compatible屬性用戶驅動和設備的綁定。compatible 屬性是一個字符串的列表，列表中的第一個字符串表征了結點代表的確切設備，形式為"
[plain]view plaincopy
- flash@0,00000000{
- compatible="arm,vexpress-flash","cfi-flash";
- reg=<00x000000000x04000000>,
- <10x000000000x04000000>;
- bank-width=<4>;
- };
接下來root結點"/"的cpus子結點下面又包含2個cpu子結點，描述了此machine上的2個CPU，并且二者的compatible 屬性為"arm,cortex-a9"。
注意cpus和cpus的2個cpu子結點的命名，它們遵循的組織形式為：
可尋址的設備使用如下信息來在Device Tree中編碼地址信息：
- reg
- #address-cells
- #size-cells
root結點的子結點描述的是CPU的視圖，因此root子結點的address區(qū)域就直接位于CPU的memory區(qū)域。但是，經(jīng)過總線橋后的address往往需要經(jīng)過轉換才能對應的CPU的memory映射。external-bus的ranges屬性定義了經(jīng)過external-bus橋后的地址范圍如何映射到CPU的memory區(qū)域。
[plain]view plaincopy
- ranges=<000x101000000x10000//Chipselect1,Ethernet
- 100x101600000x10000//Chipselect2,i2ccontroller
- 200x300000000x1000000>;//Chipselect3,NORFlash
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 – 用到了中斷的設備結點透過它指定中斷號、觸發(fā)方法等，具體這個屬性含有多少個cell，由它依附的中斷控制器結點的#interrupt-cells屬性決定。而具體每個cell又是什么含義，一般由驅動的實現(xiàn)決定，而且也會在Device Tree的binding文檔中說明。譬如，對于ARM GIC中斷控制器而言，#interrupt-cells為3，它3個cell的具體含義Documentation/devicetree/bindings/arm/gic.txt就有如下文字說明：
[plain]view plaincopy
- 01The1stcellistheinterrupttype;0forSPIinterrupts,1forPPI
- 02interrupts.
- 03
- 04The2ndcellcontainstheinterruptnumberfortheinterrupttype.
- 05SPIinterruptsareintherange[0-987].PPIinterruptsareinthe
- 06range[0-15].
- 07
- 08The3rdcellistheflags,encodedasfollows:
- 09bits[3:0]triggertypeandlevelflags.
- 101=low-to-highedgetriggered
- 112=high-to-lowedgetriggered
- 124=activehighlevel-sensitive
- 138=activelowlevel-sensitive
- 14bits[15:8]PPIinterruptcpumask.Eachbitcorrespondstoeachof
- 15the8possiblecpusattachedtotheGIC.Abitsetto1indicated
- 16theinterruptiswiredtothatCPU.OnlyvalidforPPIinterrupts.
除了中斷以外，在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包括：
[plain]view plaincopy
- 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
Device Tree Blob (.dtb)
.dtb是.dts被DTC編譯后的二進制格式的Device Tree描述，可由Linux內核解析。通常在我們?yōu)殡娐钒逯谱鱊AND、SD啟動image時，會為.dtb文件單獨留下一個很小的區(qū)域以存放之，之后bootloader在引導kernel的過程中，會先讀取該.dtb到內存。Binding
對于Device Tree中的結點和屬性具體是如何來描述設備的硬件細節(jié)的，一般需要文檔來進行講解，文檔的后綴名一般為.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的最后一次參數(shù)，第一個參數(shù)為內核映像的地址，第二個參數(shù)為initrd的地址，若不存在initrd，可以用 -代替。
3. Device Tree引發(fā)的BSP和驅動變更
有了Device Tree后，大量的板級信息都不再需要，譬如過去經(jīng)常在arch/arm/plat-xxx和arch/arm/mach-xxx實施的如下事情：1. 注冊platform_device，綁定resource，即內存、IRQ等板級信息。
透過Device Tree后，形如
[cpp]view plaincopy
- 90staticstructresourcexxx_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
- 103staticstructplatform_devicexxx_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};
[cpp]view plaincopy
- 18staticstructof_device_idxxx_of_bus_ids[]__initdata={
- 19{.compatible="simple-bus",},
- 20{},
- 21};
- 22
- 23void__initxxx_mach_init(void)
- 24{
- 25of_platform_bus_probe(NULL,xxx_of_bus_ids,NULL);
- 26}
- 32
- 33#ifdefCONFIG_ARCH_XXX
- 38
- 39DT_MACHINE_START(XXX_DT,"GenericXXX(FlattenedDeviceTree)")
- 41…
- 45.init_machine=xxx_mach_init,
- 46…
- 49MACHINE_END
- 50#endif
2.注冊i2c_board_info，指定IRQ等板級信息。
形如
[cpp]view plaincopy
- 145staticstructi2c_board_info__initdataafeb9260_i2c_devices[]={
- 146{
- 147I2C_BOARD_INFO("tlv320aic23",0x1a),
- 148},{
- 149I2C_BOARD_INFO("fm3130",0x68),
- 150},{
- 151I2C_BOARD_INFO("24c64",0x50),
- 152},
- 153};
[cpp]view plaincopy
- i2c@1,0{
- compatible="acme,a1234-i2c-bus";
- …
- rtc@58{
- compatible="maxim,ds1338";
- reg=<58>;
- interrupts=<73>;
- };
- };
3. 注冊spi_board_info，指定IRQ等板級信息。
形如
[cpp]view plaincopy
- 79staticstructspi_board_infoafeb9260_spi_devices[]={
- 80{/*DataFlashchip*/
- 81.modalias="mtd_dataflash",
- 82.chip_select=1,
- 83.max_speed_hz=15*1000*1000,
- 84.bus_num=0,
- 85},
- 86};
4.多個針對不同電路板的machine，以及相關的callback。
過去，ARM Linux針對不同的電路板會建立由MACHINE_START和MACHINE_END包圍起來的針對這個machine的一系列callback，譬如：
[cpp]view plaincopy
- 373MACHINE_START(VEXPRESS,"ARM-VersatileExpress")
- 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,
- 383MACHINE_END
引入Device Tree之后，MACHINE_START變更為DT_MACHINE_START，其中含有一個.dt_compat成員，用于表明相關的machine與.dts中root結點的compatible屬性兼容關系。如果Bootloader傳遞給內核的Device Tree中root結點的compatible屬性出現(xiàn)在某machine的.dt_compat表中，相關的machine就與對應的Device Tree匹配，從而引發(fā)這一machine的一系列初始化函數(shù)被執(zhí)行。
[cpp]view plaincopy
- 489staticconstchar*constv2m_dt_match[]__initconst={
- 490"arm,vexpress",
- 491"xen,xenvm",
- 492NULL,
- 493};
- 495DT_MACHINE_START(VEXPRESS_DT,"ARM-VersatileExpress")
- 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,
- 505MACHINE_END
譬如arch/arm/mach-exynos/mach-exynos5-dt.c的EXYNOS5_DT machine同時兼容"samsung,exynos5250"和"samsung,exynos5440"：
[cpp]view plaincopy
- 158staticcharconst*exynos5_dt_compat[]__initdata={
- 159"samsung,exynos5250",
- 160"samsung,exynos5440",
- 161NULL
- 162};
- 163
- 177DT_MACHINE_START(EXYNOS5_DT,"SAMSUNGEXYNOS5(FlattenedDeviceTree)")
- 178/*Maintainer:KukjinKim
- 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,
- 189MACHINE_END
它的.init_machine成員函數(shù)就針對不同的machine進行了不同的分支處理：
[cpp]view plaincopy
- 126staticvoid__initexynos5_dt_machine_init(void)
- 127{
- 128…
- 149
- 150if(of_machine_is_compatible("samsung,exynos5250"))
- 151of_platform_populate(NULL,of_default_bus_match_table,
- 152exynos5250_auxdata_lookup,NULL);
- 153elseif(of_machine_is_compatible("samsung,exynos5440"))
- 154of_platform_populate(NULL,of_default_bus_match_table,
- 155exynos5440_auxdata_lookup,NULL);
- 156}
使用Device Tree后，驅動需要與.dts中描述的設備結點進行匹配，從而引發(fā)驅動的probe()函數(shù)執(zhí)行。對于platform_driver而言，需要添加一個OF匹配表，如前文的.dts文件的"acme,a1234-i2c-bus"兼容I2C控制器結點的OF匹配表可以是：
[cpp]view plaincopy
- 436staticconststructof_device_ida1234_i2c_of_match[]={
- 437{.compatible="acme,a1234-i2c-bus",},
- 438{},
- 439};
- 440MODULE_DEVICE_TABLE(of,a1234_i2c_of_match);
- 441
- 442staticstructplatform_driveri2c_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};
- 454module_platform_driver(i2c_a1234_driver);
對于I2C和SPI從設備而言，同樣也可以透過of_match_table添加匹配的.dts中的相關結點的compatible屬性，如sound/soc/codecs/wm8753.c中的：
[cpp]view plaincopy
- 1533staticconststructof_device_idwm8753_of_match[]={
- 1534{.compatible="wlf,wm8753",},
- 1535{}
- 1536};
- 1537MODULE_DEVICE_TABLE(of,wm8753_of_match);
- 1587staticstructspi_driverwm8753_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};
- 1640staticstructi2c_driverwm8753_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};
[cpp]view plaincopy
- 90staticintspi_match_device(structdevice*dev,structdevice_driver*drv)
- 91{
- 92conststructspi_device*spi=to_spi_device(dev);
- 93conststructspi_driver*sdrv=to_spi_driver(drv);
- 94
- 95/*AttemptanOFstylematch*/
- 96if(of_driver_match_device(dev,drv))
- 97return1;
- 98
- 99/*ThentryACPI*/
- 100if(acpi_driver_match_device(dev,drv))
- 101return1;
- 102
- 103if(sdrv->id_table)
- 104return!!spi_match_id(sdrv->id_table,spi);
- 105
- 106returnstrcmp(spi->modalias,drv->name)==0;
- 107}
- 71staticconststructspi_device_id*spi_match_id(conststructspi_device_id*id,
- 72conststructspi_device*sdev)
- 73{
- 74while(id->name[0]){
- 75if(!strcmp(sdev->modalias,id->name))
- 76returnid;
- 77id++;
- 78}
- 79returnNULL;
- 80}
評論