一:什么是设备树

设备树(Device Tree)是一种描述硬件的数据结构,是结构化的语言,有点像C语言的结构体。在操作系统引导启动阶段进行设备初始化的时候,设备树中描述硬件的信息被检测到并传递给操作系统。

二:设备树起源与意义

设备树在2011年被引入到ARM Linux内核中,也就是在Linux内核3.x以后引入的,在内核3.x之前都是没有设备树的概念的,都是使用平台文件来描述硬件的。它的引入主要是想解决ARM Linux内核代码冗余的问题。

三:内核中与设备树相关的文件

dts文件,Device Tree Source,是以ASCII文本形式来描述设备树内容。

dtb文件是二进制格式,是编译后最终生成的二进制文件。

dtsi文件,类似于C语言头文件。

四:基本语法

android 源码设备树 安卓设备树_子节点

1. 节点

节点名

语法: [@]

名字的命名是由字符、数字、“-”等组成,最长是31个字符,一般是设备类型命名,unit-address一般的是设备地址。

比如:

android 源码设备树 安卓设备树_子节点_02

对于节点来说,有节点引用、合并节点内容、替换节点内容。

节点引用另一个节点:

android 源码设备树 安卓设备树_设备节点_03

demo节点的属性item引用了节点的node的属性值。

节点内容引用

有时候在一个节点中会引用到其他节点的属性值,会使用到节点内容引用。

android 源码设备树 安卓设备树_设备树_04

节点内容合并

有时候一个硬件设备的部分信息内容可能会有变化,这里可能会出现节点内容合并的概念。

android 源码设备树 安卓设备树_android 源码设备树_05

移植者在根节点中添加一个node节点,节点中的内容与上面的节点内容是不同,此时需要合并,合并完成结果如下:

android 源码设备树 安卓设备树_设备节点_06

节点内容替换

在根节点中有相同名字的子节点,此时会出现替换内容的概念。

android 源码设备树 安卓设备树_子节点_07

内容替换完成后的结果如下:

android 源码设备树 安卓设备树_子节点_08

节点查找

通过节点的compatible属性值查找指定节点

通过节点名查找指定节点

通过节点路径查找指定节点

2. 节点属性分析

设备树中常见的属性有compatible、地址address、中断interrupt、MAC地址、GPIO口、clock、power、regulator、等等。

android 源码设备树 安卓设备树_android 源码设备树_09

compatible属性

该属性是用于匹配设备节点和设备驱动的。

在设备树中compatible="davicom,dm9000";需要与驱动代码中的.compatible匹配。

android 源码设备树 安卓设备树_设备树_10

address属性

#address-cells:描述子节点reg属性值的地址表中首地址cell数量

#size-cells:描述子节点reg属性值的地址表中地址长度cell数量

reg:描述地址表,I/O地址。

父节点#address-cells值为1,#size-cells值为1,则子节点中reg的值就是一个首地址加一个地址长度为一个单元。

ranges:有些设备是有片选的,所以需要描述片选和片选的偏移量,在地址说明的时候还要说明地址映射范围。

android 源码设备树 安卓设备树_设备节点_11

举例说明,

android 源码设备树 安卓设备树_设备树_12

片选0,偏移0,被映射到CPU地址空间的0x10100000~0x10110000中,地址长度为0x10000。

interrupt属性

interrupt-parent 标识此设备节点属于哪一个中断控制器,如果没有设置这个属性,会自动依附父节点的;

interrupts 一个中断标识符列表,表示每一个中断输出信号,引用中断号及中断触发类型

#interrupt-cells 这是中断控制器节点的属性,用来标识这个控制器需要几个单位做中断描述符;

interrupt-controller 一个空属性用来声明这个node接收中断信号;

比如:父节点的#interrupt-cells的值是3,则子节点的interrupts一个cell有三个32bits整型值,<中断域 中断 触发方式>

android 源码设备树 安卓设备树_设备树_13

gpio属性

gpio-controller:说明该节点描述的是一个gpio控制器

#gpio-cells:描述gpio使用节点的属性一个cell的内容

属性名=<&引用GPIO节点别名 GPIO标号 工作模式>;

android 源码设备树 安卓设备树_android 源码设备树_14

Linux设备树语法详解

概念

Linux内核从3.x开始引入设备树的概念,用于实现驱动代码与设备信息相分离。在设备树出现以前,所有关于设备的具体信息都要写在驱动里,一旦外围设备变化,驱动代码就要重写。引入了设备树之后,驱动代码只负责处理驱动的逻辑,而关于设备的具体信息存放到设备树文件中,这样,如果只是硬件接口信息的变化而没有驱动逻辑的变化,驱动开发者只需要修改设备树文件信息,不需要改写驱动代码。比如在ARM Linux内,一个.dts(device tree source)文件对应一个ARM的machine,一般放置在内核的"arch/arm/boot/dts/"目录内,比如exynos4412参考板的板级设备树文件就是"arch/arm/boot/dts/exynos4412-origen.dts"。这个文件可以通过$make dtbs命令编译成二进制的.dtb文件供内核驱动使用。

基于同样的软件分层设计的思想,由于一个SoC可能对应多个machine,如果每个machine的设备树都写成一个完全独立的.dts文件,那么势必相当一些.dts文件有重复的部分,为了解决这个问题,Linux设备树目录把一个SoC公用的部分或者多个machine共同的部分提炼为相应的.dtsi文件。这样每个.dts就只有自己差异的部分,公有的部分只需要"include"相应的.dtsi文件, 这样就是整个设备树的管理更加有序。我这里用`Linux4.8.5源码自带的dm9000网卡为例来分析设备树的使用和移植。这个网卡的设备树节点信息在"Documentation/devicetree/bindings/net/davicom-dm9000.txt"有详细说明,其网卡驱动源码是"drivers/net/ethernet/davicom/dm9000.c"

android 源码设备树 安卓设备树_android 源码设备树_15

设备树框架

设备树用树状结构描述设备信息,它有以下几种特性

  1. 每个设备树文件都有一个根节点,每个设备都是一个节点。
  2. 节点间可以嵌套,形成父子关系,这样就可以方便的描述设备间的关系。
  3. 每个设备的属性都用一组key-value对(键值对)来描述。
  4. 每个属性的描述用;结束

所以,一个设备树的基本框架可以写成下面这个样子,一般来说,/表示板子,它的子节点node1表示SoC上的某个控制器,控制器中的子节点node2表示挂接在这个控制器上的设备(们)

  1. /{                                  //根节点
  2.     node1{                          //node1是节点名,是/的子节点
  3.         key=value;                  //node1的属性
  4.         ...
  5.         node2{                      //node2是node1的子节点
  6.             key=value;              //node2的属性
  7.             ...
  8.         }
  9.     }                               //node1的描述到此为止
  10.     node3{
  11.         key=value;
  12.         ...
  13.     }
  14. }

节点名

理论个节点名只要是长度不超过31个字符的ASCII字符串即可,此外
Linux内核还约定设备名应写成形如<name>[@<unit_address>]的形式,其中name就是设备名,最长可以是31个字符长度。unit_address一般是设备地址,用来唯一标识一个节点,下面就是典型节点名的写法

android 源码设备树 安卓设备树_android 源码设备树_16

上面的节点名是firmware,节点路径是/firmware@0203f000,这点要注意,因为根据节点名查找节点的API的参数是不能有"@xxx"这部分的。

Linux中的设备树还包括几个特殊的节点,比如chosen,chosen节点不描述一个真实设备,而是用于firmware传递一些数据给OS,比如bootloader传递内核启动参数给内核

android 源码设备树 安卓设备树_设备节点_17

引用

当我们找一个节点的时候,我们必须书写完整的节点路径,这样当一个节点嵌套比较深的时候就不是很方便,所以,设备树允许我们用下面的形式为节点标注引用(起别名),借以省去冗长的路径。这样就可以实现类似函数调用的效果。编译设备树的时候,相同的节点的不同属性信息都会被合并,相同节点的相同的属性会被重写,使用引用可以避免移植者四处找节点,直接在板级.dts增改即可。

android 源码设备树 安卓设备树_设备树_18

下面的例子中就是直接引用了dtsi中的一个节点,并向其中添加/修改新的属性信息

android 源码设备树 安卓设备树_设备树_19

KEY

在设备树中,键值对是描述属性的方式,比如,Linux驱动中可以通过设备节点中的"compatible"这个属性查找设备节点。
Linux设备树语法中定义了一些具有规范意义的属性,包括:compatibleaddressinterrupt等,这些信息能够在内核初始化找到节点的时候,自动解析生成相应的设备信息。此外,还有一些Linux内核定义好的,一类设备通用的有默认意义的属性,这些属性一般不能被内核自动解析生成相应的设备信息,但是内核已经编写的相应的解析提取函数,常见的有 "mac_addr""gpio""clock""power""regulator" 等等。

compatible

设备节点中对应的节点信息已经被内核构造成struct platform_device。驱动可以通过相应的函数从中提取信息。compatible属性是用来查找节点的方法之一,另外还可以通过节点名或节点路径查找指定节点。dm9000驱动中就是使用下面这个函数通过设备节点中的"compatible"属性提取相应的信息,所以二者的字符串需要严格匹配。

在下面的这个dm9000的例子中,我们在相应的板级dts中找到了这样的代码块:

android 源码设备树 安卓设备树_android 源码设备树_20


然后我们取内核源码中找到dm9000的网卡驱动,从中可以发现这个驱动是使用的设备树描述的设备信息(这不废话么,显然用设备树好处多多)。我们可以找到它用来描述设备信息的结构体,可以看出,驱动中用于匹配的结构使用的compatible和设备树中一模一样,否则就可能无法匹配,这里另外的一点是struct of_device_id数组的最后一个成员一定是空,因为相关的操作API会读取这个数组直到遇到一个

android 源码设备树 安卓设备树_设备树_21

address

(几乎)所有的设备都需要与CPU的IO口相连,所以其IO端口信息就需要在设备节点节点中说明。常用的属性有

  • #address-cells,用来描述子节点"reg"属性的地址表中用来描述首地址的cell的数量
  • #size-cells,用来描述子节点"reg"属性的地址表中用来描述地址长度的cell的数量

有了这两个属性,子节点中的"reg"就可以描述一块连续的地址区域。下例中,父节点中指定了#address-cells = <2>;#size-cells = <1>,则子节点dev-bootscs0中的reg中的前两个数表示一个地址,即MBUS_ID(0xf0, 0x01)0x1045C,最后一个数的表示地址跨度,即是0x4

android 源码设备树 安卓设备树_设备树_22

interrupts

一个计算机系统中大量设备都是通过中断请求CPU服务的,所以设备节点中就需要在指定中断号。常用的属性有

  • interrupt-controller 一个空属性用来声明这个node接收中断信号,即这个node是一个中断控制器。
  • #interrupt-cells,是中断控制器节点的属性,用来标识这个控制器需要几个单位做中断描述符,用来描述子节点中"interrupts"属性使用了父节点中的interrupts属性的具体的哪个值。一般,如果父节点的该属性的值是3,则子节点的interrupts一个cell的三个32bits整数值分别为:<中断域 中断 触发方式>,如果父节点的该属性是2,则是<中断 触发方式>
  • interrupt-parent,标识此设备节点属于哪一个中断控制器,如果没有设置这个属性,会自动依附父节点的
  • interrupts,一个中断标识符列表,表示每一个中断输出信号

        - 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

设备树中中断的部分涉及的部分比较多,interrupt-controller表示这个节点是一个中断控制器,需要注意的是,一个SoC中可能有不止一个中断控制器,这就会涉及到设备树中断组织的很多概念,下面是在文件"arch/arm/boot/dts/exynos4.dtsi"中对exynos4412的中断控制器(GIC)节点描述:

android 源码设备树 安卓设备树_设备节点_23

要说interrupt-parent,就得首先讲讲Linux设备管理中对中断的设计思路演变。随着linux kernel的发展,在内核中将interrupt controller抽象成irqchip这个概念越来越流行,甚至GPIO controller也可以被看出一个interrupt controller chip,这样,系统中至少有两个中断控制器了,另外,在硬件上,随着系统复杂度加大,外设中断数据增加,实际上系统可以需要多个中断控制器进行级联,形成事实上的硬件中断处理结构:

android 源码设备树 安卓设备树_设备树_24

在这种趋势下,内核中原本的中断源直接到中断号的方式已经很难继续发展了,为了解决这些问题,linux kernel的大牛们就创造了irq domain(中断域)这个概念。domain在内核中有很多,除了irqdomain,还有power domain,clock domain等等,所谓domain,就是领域,范围的意思,也就是说,任何的定义出了这个范围就没有意义了。如上所述,系统中所有的interrupt controller会形成树状结构,对于每个interrupt controller都可以连接若干个外设的中断请求(interrupt source,中断源),interrupt controller会对连接其上的interrupt source(根据其在Interrupt controller中物理特性)进行编号(也就是HW interrupt ID了)。有了irq domain这个概念之后,这个编号仅仅限制在本interrupt controller范围内,有了这样的设计,CPU(Linux 内核)就可以根据级联的规则一级一级的找到想要访问的中断。当然,通常我们关心的只是内核中的中断号,具体这个中断号是怎么找到相应的中断源的,我们作为程序员往往不需要关心,除了在写设备树的时候,设备树就是要描述嵌入式软件开发中涉及的所有硬件信息,所以,设备树就需要准确的描述硬件上处理中断的这种树状结构,如此,就有了我们的interrupt-parant这样的概念:用来连接这样的树状结构的上下级,用于表示这个中断归属于哪个interrupt controller,比如,一个接在GPIO上的按键,它的组织形式就是:

中断源--interrupt parent-->GPIO--interrupt parent-->GIC1--interrupt parent-->GIC2--...-->CPU

有了parant,我们就可以使用一级一级的偏移量来最终获得当前中断的绝对编号,这里,可以看出,在我板子上的dm9000的的设备节点中,它的"interrupt-parent"引用了"exynos4x12-pinctrl.dtsi"(被板级设备树的exynos4412.dtsi包含)中的gpx0节点:

android 源码设备树 安卓设备树_android 源码设备树_25

而在gpx0节点中,指定了"#interrupt-cells = <2>;",所以在dm9000中的属性"interrupts = <6 4>;"表示dm9000的的中断在作为irq parant的gpx0中的中断偏移量,即gpx0中的属性"interrupts"中的"<0 22 0>",通过查阅exynos4412的手册知道,对应的中断号是EINT[6]。

android 源码设备树 安卓设备树_设备树_26

gpio

gpio也是最常见的IO口,常用的属性有

  • "gpio-controller",用来说明该节点描述的是一个gpio控制器
  • "#gpio-cells",用来描述gpio使用节点的属性一个cell的内容,即 `属性 = <&引用GPIO节点别名 GPIO标号 工作模式>

此处工作模式,以zynq7z020为例,在system_level寄存器中,有管理GPIO管脚功能,定义不同

00: Level 3 Mux
01: SRAM/NOR OE_B, Output
10: NAND Flash CLE_B, Output
11: SDIO 1 Power Control, Output,选择值不用则功能不一(猜测)。

GPIO的设置同样采用了上述偏移量的思想,比如下面的这个led的设备书,表示使用GPX2组的第7个引脚:

android 源码设备树 安卓设备树_android 源码设备树_27

驱动自定义key

针对具体的设备,有部分属性很难做到通用,需要驱动自己定义好,通过内核的属性提取解析函数进行值的获取,比如dm9000节点中的下面这句就是自定义的节点属性,用以表示配置EEPROM不可用。

android 源码设备树 安卓设备树_设备树_28

VALUE

dts描述一个键的值有多种方式,当然,一个键也可以没有值

字符串信息

android 源码设备树 安卓设备树_设备树_29

32bit无符号整型数组信息

android 源码设备树 安卓设备树_android 源码设备树_30

二进制数数组

android 源码设备树 安卓设备树_设备节点_31

字符串哈希表

android 源码设备树 安卓设备树_子节点_32

混合形式

上述几种的混合形式

设备树/驱动移植实例

设备树就是为驱动服务的,配置好设备树之后还需要配置相应的驱动才能检测配置是否正确。比如dm9000网卡,就需要首先将示例信息挂接到我们的板级设备树上,并根据芯片手册和电路原理图将相应的属性进行配置,再配置相应的驱动。需要注意的是,dm9000的地址线一般是接在片选线上的,所以设备树中就应该归属与相应片选线节点,我这里用的exynos4412,接在了bank1,所以是"<0x50000000 0x2 0x50000004 0x2>"
最终的配置结果是:

android 源码设备树 安卓设备树_设备节点_33

勾选相应的选项将dm9000的驱动编译进内核。

  1. make menuconfig
  2. [*] Networking support  --->
  3.     Networking options  --->
  4.         <*> Packet socket
  5.         <*>Unix domain sockets
  6.         [*] TCP/IP networking
  7.         [*]   IP: kernel level autoconfiguration
  8. Device Drivers  --->
  9.     [*] Network device support  --->
  10.         [*]   Ethernet driver support (NEW)  --->
  11.             <*>   DM9000 support
  12. File systems  --->
  13.     [*] Network File Systems (NEW)  --->
  14.         <*>   NFS client support
  15.         [*]     NFS client support for NFS version 3
  16.         [*]       NFS client support for the NFSv3 ACL protocol extension
  17.         [*]   Root file system on NFS
  18.  

执行make uImage;make dtbs,tftp下载,成功加载nfs根文件系统并进入系统,表示网卡移植成功

android 源码设备树 安卓设备树_android 源码设备树_34