本文参考如下两篇文章,整合为一篇。
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、总线、设备组成的树,Bootloader会将这棵树传递给内核,而后内核能够识别这棵树,并根据它展开出Linux内核中的platform_device、i2c_client、spi_device等设备,而这些设备用到的内存、IRQ等资源,也被传递给了内核,内核会将这些资源绑定给展开的相应的设备。express
整个Device Tree牵涉面比较广,即增长了新的用于描述设备硬件信息的文本格式,又增长了编译这一文本的工具,同时Bootloader也须要支持将编译后的Device Tree传递给Linux内核。数组
设备树包含DTC(device tree compiler),DTS(device tree source和DTB(device tree blob)。其对应关系以下,数据结构
.dts文件是一种ASCII 文本格式的Device Tree描述,此文本格式很是人性化,适合人类的阅读习惯。基本上,在ARM Linux在,一个.dts文件对应一个ARM的machine,通常放置在内核的arch/arm/boot/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
因为一个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 主要用来描述由系统指定的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用来定义别名,相似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,device_type必须为memory。
memory { device_type = "memory"; reg = <0x00000000 0x20000000>; /* 512 MB */ };
上述描述代表该memory node是以0x00000000为起始地址,以0x20000000为结束地址的512MB的空间。通常而言,在.dts中不对memory进行描述,而是经过bootargs中相似521M@0x00000000的方式传递给内核。
下面以一个最简单的machine为例来看如何写一个.dts文件。假设此machine的配置以下:
其对应的.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保持了寄存器兼容。
在设备匹配驱动过程当中,优先级为从左向右。本例中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标准给出告终点命名的规范。
可寻址的设备使用以下信息来在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地址。
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个项目的含义能够类推。
Device Tree中还能够中断链接信息,对于中断控制器而言,它提供以下属性:
在整个Device Tree中,与中断相关的属性还包括:
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目录,其下又分为不少子目录。
将.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项目。
.dtb是.dts被DTC编译后的二进制格式的Device Tree描述,可由Linux内核解析。一般在咱们为电路板制做NAND、SD启动image时,会为.dtb文件单独留下一个很小的区域以存放之,以后bootloader在引导kernel的过程当中,会先读取该.dtb到内存。
DTB由三部分组成:头(Header)、结构块(device-tree structure)、字符串块(device-tree string),它的布局结构以下,
在kernelincludelinuxof_fdt.h文件中有相关定义,
设备树结构块是一个线性化的结构体,是设备树的主体,以节点的形式保存了主板上的设备信息。
在结构块中,以宏OF_DT_BEGIN_NODE标志一个节点的开始,以宏OF_DT_END_NODE标识一个节点的结束,整个结构块以宏OF_DT_END (0x00000009)结束。在kernelincludelinuxof_fdt.h中有相关定义,咱们把这些宏称之为token。
一个节点的结构以下:
经过节点的定义知道节点都有若干属性,而不一样的节点的属性又有大量相同的属性名称,所以将这些属性名称提取出一张表,当节点须要应用某个属性名称时,直接在属性名字段保存该属性名称在字符串块中的偏移量。
这个区域包括了若干的reserve memory描述符。每一个reserve memory描述符是由address和size组成。其中address和size都是用U64来描述。
有些系统,咱们也许会保留一些memory有特殊用途(例如DTB或者initrd image),或者在有些DSP+ARM的SOC platform上,有些memory被保留用于ARM和DSP进行信息交互。这些保留内存不会进入内存管理系统。
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后,大量的板级信息都再也不须要,譬如过去常常在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 }
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用于记录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的接口和定义的具体描述。有兴趣的读者能够看下,所包含的代码量很少。
先从uboot里的do_bootm
出发,根据以前描述,DTB在内存中的地址经过bootm命令进行传递。在bootm中,它会根据所传进来的DTB地址,对DTB所在内存作一系列操做,为内核解析DTB提供保证。上图为对应的函数调用关系图。
在do_bootm中,主要调用函数为do_bootm_states
,第四个参数为bootm所要处理的阶段和状态。
在do_bootm_states中,bootm_start
会对lmb进行初始化操做,lmb所管理的物理内存块有三种方式获取。起始地址,优先级从上往下:
大小:
通过初始化以后,这块内存就归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所管理:
boot_fdt_add_mem_rsv_regions
会将原先的内存DTB镜像所在的内存置为reserve,保证该段内存不会被其余非法使用,保证接下来的reload数据是正确的;boot_relocate_fdt
会在bootmap区域中申请一块未被使用的内存,接着将DTB镜像内容复制到这块区域(即归lmb所管理的区域)注:若环境变量中,指定“fdt_high”参数,则会根据该值,调用lmb_alloc_base函数来分配DTB镜像reload的地址空间。若分配失败,则会中止bootm操做。于是,不建议设置fdt_high参数。
接下来,do_bootm会根据内核的类型调用对应的启动函数。与linux对应的是do_bootm_linux
。
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
。
如图,是setup_machine_fdt
中的解析过程。
boot_command_line
进行初始化。dt_root_size_cells
,dt_root_addr_cells
进行初始化。为以后解析memory等其余节点提供依据。解析设备树在函数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); } }
总的概括为:
在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中定义的设备结点进行匹配。