1. ARM Device Tree来源
社区有必要改动这种局势,所以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中进行许多的冗余编码。Device Tree由一系列被命名的结点(node)和特点(property)组成,而结点自身可包含子结点。所谓特点,其实便是成对呈现的name和value。在Device Tree中,可描绘的信息包含(原先这些信息大多被hard code到kernel中):
- CPU的数量和类别
- 内存基地址和巨细
- 总线和桥
- 外设衔接
- 中止控制器和中止运用情况
- GPIO控制器和GPIO运用情况
- Clock控制器和Clock运用情况
它根本上便是画一棵电路板上CPU、总线、设备组成的树,Bootloader会将这棵树传递给内核,然后内核能够辨认这棵树,并依据它打开出Linux内核中的platform_device、i2c_client、spi_device等设备,而这些设备用到的内存、IRQ等资源,也被传递给了内核,内核会将这些资源绑定给打开的相应的设备。
view plaincopy
- /{
- 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{
- };
- };
- };
上述.dts文件并没有什么实在的用处,但它根本表征了一个Device Tree源文件的结构:1个root结点”/”;
root结点下面含一系列子结点,本例中为”node1″ 和 “node2″;结点”node1″下又含有一系列子结点,本例中为”child-node1” 和 “child-node2″;各结点都有一系列特点。这些特点可能为空,如” an-empty-property”;可能为字符串,如”a-string-property”;可能为字符串数组,如”a-string-list-property”;可能为Cells(由u32整数组成),如”second-child-property”,可能为二进制数,如”a-byte-data-property”。下面以一个最简略的machine为例来看怎么写一个.dts文件。假定此machine的装备如下:
1个双核ARM Cortex-A9 32位处理器;ARM的local bus上的内存映射区域散布了2个串口(别离坐落0x101F1000 和 0x101F2000)、GPIO控制器(坐落0x101F3000)、SPI控制器(坐落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=<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文件中,root结点”/”的compatible 特点compatible = “acme,coyotes-revenge”;界说了体系的称号,它的组织办法为:
在.dts文件的每个设备,都有一个compatible 特点,compatible特点用户驱动和设备的绑定。compatible 特点是一个字符串的列表,列表中的第一个字符串表征了结点代表的切当设备,办法为”
- flash@0,00000000{
- compatible=”arm,vexpress-flash”,”cfi-flash”;
- reg=<00x000000000x04000000>,
- <10x000000000x04000000>;
- 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子结点的命名,它们遵从的组织办法为:
可寻址的设备运用如下信息来在Device Tree中编码地址信息:
- reg
- #address-cells
- #size-cells
其间reg的组织办法为reg = ,其间的每一组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字段长度为0,开端的第一个cell(0、1、2)是对应的片选,第2个cell(0,0,0)是相对该片选的基地址,第3个cell(0x1000、0x1000、0x4000000)为length。特别要留心的是i2c结点中界说的 #address-cells = <1>;和#size-cells = <0>;又效果到了I2C总线上衔接的RTC,它的address字段为0x58,是设备的I2C地址。
root结点的子结点描绘的是CPU的视图,因而root子结点的address区域就直接坐落CPU的memory区域。可是,通过总线桥后的address往往需求通过转化才干对应的CPU的memory映射。external-bus的ranges特点界说了通过external-bus桥后的地址规模怎么映射到CPU的memory区域。
- ranges=<000x101000000x10000//Chipselect1,Ethernet
- 100x101600000x10000//Chipselect2,i2ccontroller
- 200x300000000x1000000>;//Chipselect3,NORFlash
ranges是地址转化表,其间的每个项目是一个子地址、父地址以及在子地址空间的巨细的映射。映射表中的子地址、父地址别离选用子地址空间的#address-cells和父地址空间的#address-cells巨细。关于本例而言,子地址空间的#address-cells为2,父地址空间的#address-cells值为1,因而0 0 0x10100000 0x10000的前2个cell为external-bus后片选0上偏移0,第3个cell标明external-bus后片选0上偏移0的地址空间被映射到CPU的0x10100000方位,第4个cell标明映射的巨细为0x10000。ranges的后边2个项目的意义能够类推。
Device Tree中还能够中止衔接信息,关于中止控制器而言,它供给如下特点:
interrupt-controller – 这个特点为空,中止控制器应该加上此特点标明自己的身份;
#interrupt-cells – 与#address-cells 和 #size-cells相似,它标明衔接此中止控制器的设备的interrupts特点的cell巨细;
在整个Device Tree中,与中止相关的特点还包含:
interrupt-parent – 设备结点透过它来指定它所依靠的中止控制器的phandle,当结点没有指定interrupt-parent 时,则从父级结点承继。关于本例而言,root结点指定了interrupt-parent = <&intc>;其对应于intc:interrupt-controller@10140000,而root结点的子结点并未指定interrupt-parent,因而它们都承继了intc,即坐落0x10140000的中止控制器。
interrupts – 用到了中止的设备结点透过它指定中止号、触发办法等,详细这个特点含有多少个cell,由它依靠的中止控制器结点的#interrupt-cells特点决议。而详细每个cell又是什么意义,一般由驱动的完结决议,并且也会在Device Tree的binding文档中阐明。比如,关于ARM GIC中止控制器而言,#interrupt-cells为3,它3个cell的详细意义Documentation/devicetree/bindings/arm/gic.txt就有如下文字阐明:
- 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 GIC而言,若某设备运用了SPI的168、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施行的如下工作:
1. 注册platform_device,绑定resource,即内存、IRQ等板级信息。
透过Device Tree后,形如
- 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};
之类的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:
- 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等板级信息。
形如
- 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};
之类的i2c_board_info代码,现在不再需求呈现,现在只需求把tlv320aic23、fm3130、24c64这些设备结点填充作为相应的I2C controller结点的子结点即可,相似于前面的
- i2c@1,0{
- compatible=”acme,a1234-i2c-bus”;
- …
- rtc@58{
- compatible=”maxim,ds1338″;
- reg=<58>;
- interrupts=<73>;
- };
- };
Device Tree中的I2C client会透过I2C host驱动的probe()函数中调用of_i2c_register_devices(&i2c_dev->adapter);被主动打开。
3. 注册spi_board_info,指定IRQ等板级信息。
形如
- 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};
之类的spi_board_info代码,现在不再需求呈现,与I2C相似,现在只需求把mtd_dataflash之类的结点,作为SPI控制器的子结点即可,SPI host驱动的probe函数透过spi_register_master()注册master的时分,会主动打开依靠于它的slave。
4.多个针对不同电路板的machine,以及相关的callback。
曩昔,ARM Linux针对不同的电路板会树立由MACHINE_START和MACHINE_END包围起来的针对这个machine的一系列callback,比如:
- 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
这些不同的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的一系列初始化函数被履行。
- 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
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″:
- 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成员函数就针对不同的machine进行了不同的分支处理:
- 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中描绘的设备结点进行匹配,然后引发驱动的probe()函数履行。关于platform_driver而言,需求增加一个OF匹配表,如前文的.dts文件的”acme,a1234-i2c-bus”兼容I2C控制器结点的OF匹配表能够是:
- 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中的:
- 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};
不过这边有一点需求提示的是,I2C和SPI外设驱动和Device Tree中设备结点的compatible 特点还有一种弱式匹配办法,便是别号匹配。compatible 特点的组织办法为
- 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}