RISCVLinuxkernel启动代码分析之十一:设备树介绍(2)

中断和中断映射

这是非常重要的部分

中断逻辑上构成一个树形结构

比如有中断产生的源头(设备产生中断)

interrupt specifier  描述中断号,中断电平

interrupt domain    中断产生设备

interrupt-controller  中断控制器

Interrupt Nexus  中断连接器,将子中断连接到父中断中去，一般用于PCI。

中断树结构示意

中断发生设备的属性

interrupts

属性名: interrupts

值类型: 编码为任意数量的中断说明符

定义了设备生成的一个或多个中断。中断属性的值由任意数量的中断说明符组成。中断说明符的格式由绑定的interrupt domain root.定义。

interrupts被interrupts-extended 覆盖,二者只使用其一.

示例:

如下open PIC–compatible interrupt domain

0x0A表示中断号,8表示中断电平的编码

interrupts = <0xA 8>;

interrupt-parent

属性名: interrupt-parent

值类型:

因为中断树中节点的层次结构可能与设备树不匹配，所以中断父属性可用于显式定义中断父属性。该值是中断父级的phandle。如果设备缺少此属性，则假定其中断父级是其设备树父级。

interrupts-extended

属性名: interrupts-extended

值类型:  

列出了设备生成的中断。当一个设备连接到多个中断控制器时，应该使用interrupts-extended来代替interrupts，因为其每个中断说明符都有对应的phandle。

中断控制器的属性

#interrupt-cells

属性名: #interrupt-cells

值类型:

定义对interrupt domain的中断说明符 进行编码所需的单元数.

interrupt-controller

属性名: interrupt-controller

值类型:

表示该节点是中断控制器节点

中断连接点Nexus属性

中断连接节点必须要有#interrupt cell属性。

interrupt-map

属性名: interrupt-map

值类型: 编码为任意数量的中断映射条目interrupt mapping entries.

该属性用于将一个中断域interrupt domain与一组父中断域连接起来，并指定如何将子域中的中断说明符映射到它们各自的父域。

中断映射interrupt map 是一个表，其中每一行都是一个映射条目mapping entry，由五个部分组成： child unit

address子单元地址, child interrupt specifier子中断说明符, 父中断interrupt-parent, parent unit address父单元地址，,parent interrupt specifier父中断说明符。

child unit address:

映射的子节点的单元地址。表示该属性值需要的32位单元数由子节点所在的总线节点的#address-cells指定。

child interrupt specifier:

映射的子节点中断说明符。表示该属性值需要的32位单元数由本连接节点即interrupt-map属性所在节点的#interrupt-cells 决定。

interrupt-parent:

一个单 值用于执行子节点需要映射的父中断.

parent unit address:

父中断的节点地址,表示该属性值需要的32位单元数由 interrupt-parent指向的节点的 #address-cells属性指定。

parent interrupt specifier:

父节点中断说明符,表示该属性值需要的32位单元数由 interrupt-parent指向的节点的 #interrupt-cells属性指定。

搜寻interrupt mapping 表，匹配子组件的unit-address/interrupt specifier 对，由于一些interrupt specifier 位是无关的，可以通过interrupt-map-mask进行and位掩码来忽略掉不匹配。

子节点和父节点都需要#address-cells 和 #interruptcells 属性。如果unit address不需要，则必须显示的配置#address-cells 为0.

interrupt-map-mask

属性名: interrupt-map-mask

值类型: 编码为位掩码bit mask

中断树中的连接Nexus节点，其 interrupt-map-mask属性指定了一个掩码，该掩码与在interrupt-map属性中指定的表中查找的传入单元中断说明符interrupt specifier 进行AND运算

#interrupt-cells

属性名: #interrupt-cells

值类型:

定义了对中断域interrupt domain的中断说明符interrupt specifier进行编码所需的单元数。

Interrupt Mapping示例

soc {compatible = "simple-bus";#address-cells = <1>;#size-cells = <1>;
open-pic {clock-frequency = <0>;interrupt-controller;#address-cells = <0>;#interrupt-cells = <2>;};
pci {#interrupt-cells = <1>;#size-cells = <2>;#address-cells = <3>;interrupt-map-mask = <0xf800 0 0 7>;
interrupt-map = </* IDSEL 0x11 - PCI slot 1 */0x8800 0 0 1 &open-pic 2 1 /* INTA */0x8800 0 0 2 &open-pic 3 1 /* INTB */0x8800 0 0 3 &open-pic 4 1 /* INTC */0x8800 0 0 4 &open-pic 1 1 /* INTD *//* IDSEL 0x12 - PCI slot 2 */0x9000 0 0 1 &open-pic 3 1 /* INTA */0x9000 0 0 2 &open-pic 4 1 /* INTB */0x9000 0 0 3 &open-pic 1 1 /* INTC */0x9000 0 0 4 &open-pic 2 1 /* INTD */>;};}

open-pic的interrupt-controller属性说明该节点是中断控制器

以0x8800 0 0 1 &open-pic 2 1 /* INTA */为例子

对应五元组

child unit address=0x8800 0 0

子节点是INTA所在的总显示pci，而pci的#address-cells = <3>;，所以child unit address占用3个32位单元。

该PCI地址0x8800 0 0解析为

bus number (0x0 << 16), device number (0x11 << 11), function number(0x0 << 8).

对应的0x9000 0 0解析为

bus number (0x0 << 16), device number (0x12 << 11),  function number(0x0 << 8).

child interrupt specifier = 1

interrupt-map所在节点即pci节点的#interrupt-cells = <1>;，所以child interrupt specifier占用1个32位单元。

interrupt-parent = &open-pic

表示映射到父中断open-pic

parent unit address= empty

interrupt-parent = &open-pic指向的节点，即open-pic的#address-cells = <0>;

所以parent unit address位empty

parent interrupt specifier=2 1

interrupt-parent = &open-pic指向的节点，即open-pic的#interrupt-cells = <2>;

所以parent interrupt specifier占用两个32位单元。

值<2 1>由Open PIC中断控制器定义。值<2>指定INTA连接到的中断控制器上的中断源号。值<1>指定电平编码。

这样中断控制器的中断号2就代表了INTA。

interrupt-map-mask = <0xf800 0 0 7> 表示

在中断映射表中执行查找之前，将此掩码应用于子单元中断说明符。

如果要查找IDSEL 0x12（插槽2），功能号0x3的INTB(interrupt specifier=2)的open pic中断源号，将执行以下步骤

child unit address 和 interrupt specifier组成值<0x9300 0 0 2>

其中

child unit address = bus number (0x0 << 16), device number (0x12 << 11), and function

number (0x3 << 8).

interrupt specifier-2，表示INTB

<0xf800 0 0 7>和<0x9300 0 0 2> and得到<0x9000 0 0 2>

在中断映射表中查找该结果，该表映射到父中断说明符<4 1>。

即对应

0x9000 0 0 2 &open-pic 4 1 /* INTB */

这一行。

Nexus节点和规范映射

Nexus节点属性

nexus节点应具有#-cells 属性，其中是一些说明符空间，如‘gpio’, ‘clock’, ‘reset’ 等。

-map

属性名: -map

属性值: 编码为任意数量的说明符映射条目

该属性将一个说明符域与一组父说明符域连接起来，并描述子域中的说明符如何映射到各自的父域。

映射是一个表，其中每一行都是一个映射条目，由三个组件组成：child specifier子说明符, specifier parent说明符父, parent specifier父说明符。

child specifier:

映射的子节点的说明符，其值需要多少个32位单元，由-map 所在连接节点的#-cells属性指定。

specifier parent:

说明符的父，一个值，指向子域映射到的说明符父级。

parent specifier:

父域中的说明符。

其值需要多少个32位单元，由specifier parent的#-cells属性决定。

通过将说明符与映射中的子说明符进行匹配，在映射表上执行查找。由于说明符中的某些字段可能不相关或需要修改，因此在执行查找之前会应用掩码。此掩码在-map-mask属性中定义。

同样，当映射说明符时，单元说明符中的某些字段可能需要保持不变，并从子节点传递到父节点。此时可以指定 -map-pass-thru 属性。可以指定将掩码应用于子说明符，并复制与父单元说明符匹配的任何位。

-map-mask

属性值: -map-mask

值类型: 编码为位掩码bit mask

可以在nexus节点中指定。此属性指定了一个掩码，该掩码与在-map 属性中指定的表中查找的子单元说明符进行AND运算。如果未指定此属性，则假定掩码是设置了所有位的掩码。

-map-pass-thru

属性名: -map-pass-thru

值类型: 编码为位掩码 bit mask

可以在nexus节点中指定。

此属性指定了一个掩码，该掩码应用于在-map属性中指定的表中查找的子单元说明符。子单位说明符中的任何匹配位都会复制到父说明符。如果未指定此属性，则假定掩码为未设置位的掩码。

#-cells

属性名: #-cells

值类型:

#-cells属性定义了对域的说明符进行编码所需的单元数。

specifier映射示例

下面显示了具有两个GPIO控制器的设备树片段的表示，以及一个specifier map 示例，用于描述两个控制器上的几个gpios通过板上的连接器到设备的GPIO路由。扩展设备节点位于连接器节点的一侧，带有两个GPIO控制器的SoC位于连接器的另一侧。

soc {soc_gpio1: gpio-controller1 {#gpio-cells = <2>;};
soc_gpio2: gpio-controller2 {#gpio-cells = <2>;};};
connector: connector {#gpio-cells = <2>;gpio-map = <0 0 &soc_gpio1 1 0>,<1 0 &soc_gpio2 4 0>,<2 0 &soc_gpio1 3 0>,<3 0 &soc_gpio2 2 0>;gpio-map-mask = <0xf 0x0>;gpio-map-pass-thru = <0x0 0x1>;};
expansion_device {reset-gpios = <&connector 2 GPIO_ACTIVE_LOW>;};

gpio-map每一行由3元组组成

以<0 0 &soc_gpio1 1 0>,为例

child specifier: 0 0

-map 所在连接节点connector的#gpio-cells = <2>;

所以child specifier占用2个32位单元

specifier parent: &soc_gpio1

指向soc_gpio1

parent specifier: 1 0

specifier parent指向的节点soc_gpio1的#gpio-cells = <2>;

所以parent specifier占用2个32位单元

值<1 0>的含义由GPIO控制器决定，比如1可以表示引脚号，0表示高有效还是低有效。

其中

gpio-map-mask = <0xf 0x0>;

假设要从expansion_device的reset-gpios ,查找对应connector的GPIO2的specifier源号，

子specifier的值为<2 GPIO_ACTIVE_LOW>即<2 0>

gpio-map-mask = <0xf 0x0>和<2 0> AND

得到<2 0>

查找

gpio-map，找到<2 0 &soc_gpio1 3 0>,

即parent 是&soc_gpio1 phandle，parent specifier= <3 0>

gpio-map-pass-thru = parent specifier<0x0 0x1>取反，和<3 0> AND得到<3 0>  (即将对应的位清零)

gpio-map-pass-thru 和child specifier<2 0>与 得到<0 0>

然后<3 0> 和<0 0>或， 得到<3 0>给&soc_gpio1得到 <&soc_gpio1

3 GPIO_ACTIVE_LOW>.

DTB数据格式

.dtb格式文件对应如下

其中free space可能没有，主要是用于填充对齐

头信息

对应如下,所有数据都是大端,32位

struct fdt_header {uint32_t magic;uint32_t totalsize;uint32_t off_dt_struct;uint32_t off_dt_strings;uint32_t off_mem_rsvmap;uint32_t version;uint32_t last_comp_version;uint32_t boot_cpuid_phys;uint32_t size_dt_strings;uint32_t size_dt_struct;};

magic:

固定为0xd00dfeed

totalsize:

此字段应包含设备树数据结构的总大小（以字节为单位）。该大小应包括结构的所有部分：标头、内存保留块、结构块和字符串块，以及块之间或最终块之后的任何自由空间间隙.

off_dt_struct:

表示structure block位于从最开始的偏移字节数。

off_dt_strings:

表示strings block位于从最开始的偏移字节数。

off_mem_rsvmap:

表示memory reservation block位于从最开始的偏移字节数。

Version:

此字段应包含设备树数据结构的版本。比如17

last_comp_version:

此字段应包含设备树数据结构的最低版本，所使用的版本与该版本向后兼容。

17版本最早只能支持16，所以Version为17时这里只能是16.

boot_cpuid_phys:

此字段应包含系统引导CPU的物理ID。它应与设备树中该CPU节点的reg属性中给出的物理ID相同

size_dt_strings

表示strings block section 的有效字节数。

size_dt_struct

表示 structure block 的有效字节数。

Memory Reservation Block

内存保留块向客户端程序提供物理内存中保留的区域列表；也就是说，它不应用于一般的内存分配。它用于保护重要数据结构不被客户端程序覆盖。例如，在某些具有IOMMU的系统上，需要以这种方式保护由DTSpec引导程序初始化的TCE（转换控制条目）表。同样，在客户端程序运行时使用的任何引导程序代码或数据都需要保留（例如，Open Firmware平台上的RTAS）。DTSpec不要求引导程序提供任何此类运行时组件，但它并不禁止实现作为扩展这样做

更具体地说，客户端程序不应访问保留区域中的内存，除非引导程序提供的其他信息明确指示它应该这样做。然后，客户端程序可以以指示的方式访问保留内存的指示部分。引导程序可以向客户端程序指示保留内存的特定用途的方法可能出现在本文档、其可选扩展或特定于平台的文档中。

引导程序提供的保留区域可能（但并非必须）包含设备树blob本身。客户端程序应确保在使用之前不会覆盖此数据结构，无论它是否在保留区域。

必须保留在内存节点中声明的任何内存，这些内存由引导程序访问，或者在客户端进入后被引导程序访问。这种类型的访问的示例包括（例如，通过非保护的虚拟页面进行推测性内存读取）。

这一要求是必要的，因为任何未保留的内存都可能被具有任意存储属性的客户端程序访问。

由引导程序或由引导程序引起的对保留内存的任何访问都必须按照不禁止缓存和不要求内存一致性的方式进行（即WIMG=0bx01x），此外，对于Book III-S实现，也不要求直写（即WIMG=0b001x）。此外，如果支持VLE存储属性，则对保留内存的所有访问都必须在VLE=0时完成

此要求是必要的，因为允许客户端程序映射具有存储属性的内存，这些存储属性指定为不需要直写、不禁止缓存、需要内存一致性（即WIMG=0b001x），在支持的情况下VLE=0。客户端程序可以使用包含保留内存的大型虚拟页面。但是，客户端程序可能不会修改保留内存，因此引导程序可能会在架构上允许此存储属性的冲突值的情况下，以“需要直写”的方式执行对保留内存的访问。

内存预留块由一对64位大端序整数组成，每对整数由以下C结构表示

struct fdt_reserve_entry {

uint64_t address;

uint64_t size;

}

每对都给出了保留内存区域的物理地址和字节大小。这些给定区域不得相互重叠。保留块列表应以地址和大小均等于0的条目终止。请注意，地址和大小值始终为64位。在32位CPU上，值的前32位将被忽略。

内存预留块中的每个uint64_t，以及整个内存预留块，应位于设备树blob开头的8字节对齐偏移处。

与/reserved-memory 节点（一样，当通过[UEFI]启动时，内存保留块中的条目也必须列在通过GetMemoryMap获得的系统内存映射中，以防止UEFI应用程序的分配。内存保留块条目应按EfiReservedMemoryType类型列出。

Structure Block

结构块描述了设备树本身的结构和内容。它由一系列带有数据的令牌组成，如下所述。这些被组织成线性树结构，

结构块中的每个令牌，以及结构块本身，应位于与设备树blob开头对齐的4字节偏移处。

词汇结构Lexical structure

结构块由一系列片段组成，每个片段都以一个标记开始，即一个大端32位整数。一些令牌后面是额外的数据，其格式由令牌值决定。所有令牌应在32位边界上对齐，这可能需要在前一个令牌的数据后插入填充字节（值为0x0）。

五种令牌类型如下：

FDT_BEGIN_NODE (0x00000001):

标记节点的开始。它后面应跟节点的单元名称作为额外数据。名称存储为以空结尾的字符串，如果有，应包括单元地址。如果对齐需要，节点名称后面是零填充字节，然后是下一个令牌，可以是除FDT_END之外的任何令牌。

FDT_END_NODE (0x00000002):

标志节点的结束。此令牌没有额外数据；因此，紧随其后的是下一个令牌，它可以是除FDT_PROP之外的任何令牌。

FDT_PROP (0x00000003)

标记设备树中一个属性的开始。随后应提供描述该属性的额外数据。此数据首先由属性的长度和名称组成，表示为以下C结构：

struct {

uint32_t len;

uint32_t nameoff;

}

此结构中的两个字段都是32位大端序整数。

len以字节为单位给出属性值的长度（可能为零，表示属性为空）。

nameoff在字符串块中给出了一个偏移量，在该块中，属性的名称被存储为以null结尾的字符串。在此结构之后，属性的值以长度为len的字节字符串给出。此值后面是零填充字节（如果需要），以对齐下一个32位边界，然后是下一个令牌，可以是除FDT_END之外的任何令牌。

FDT_NOP (0x00000004)

解析设备树的任何程序都将忽略FDT_NO令牌。此令牌没有额外数据；因此，紧随其后的是下一个令牌，可以是任何有效的令牌。树中的属性或节点定义可以用FDT_NOP标记覆盖，以将其从树中删除，而无需在设备树blob中移动树表示的其他部分.

FDT_END (0x00000009)

标记结构块的结束。应该只有一个FDT_END令牌，并且它应该是结构块中的最后一个令牌。它没有额外的数据；因此，紧随FDT_END令牌之后的字节从结构块的开头偏移，等于设备树blob标头中size_dt_struct字段的值。

Tree structure

设备树结构表示为线性树：每个节点的表示以FDT_BEGIN_node令牌开始，以FDT_END_node令牌结束。节点的属性和子节点（如果有的话）在FDT_END_node之前表示，因此这些子节点的FDT_BEGIN_node和FDT_END_node令牌嵌套在父节点的令牌中。

结构块作为一个整体由根节点的表示（包含所有其他节点的表示）组成，后面是一个FDT_END令牌，用于标记整个结构块的结束。

更确切地说，每个节点的表示由以下组件组成：

l（可选）任意数量的FDT_NO令牌

lFDT_BEGIN_NODE

以null结尾的字符串表示的节点名称

[零填充字节以对齐4字节边界]

l对于节点的每个属性：

（可选）任意数量的FDT_NO令牌

FDT_PROP

属性信息

[零填充字节以对齐4字节边界]

l此格式中所有子节点的表示

l（可选）任意数量的FDT_NO令牌

lFDT_END_NODE

注意，此过程要求特定节点的所有属性定义都位于该节点的任何子节点定义之前。虽然如果属性和子节点混合在一起，结构就不会含糊不清，但处理扁平树所需的代码通过这一要求得到了简化

Strings Block

字符串块包含表示树中使用的所有属性名称的字符串。这些以空结尾的字符串在本节中简单地连接在一起，并通过偏移量从Structure Block引用到Strings Block中。

Strings Block没有对齐约束，可能出现在设备树blob开头的任何偏移处。

对齐要求

设备树blob应位于8位对齐的地址。为了保持32位机器的向后兼容性，一些软件支持4字节对齐，但这不符合DTSpec标准

对于在没有未对齐内存访问的情况下使用的内存预留和结构块中的数据，它们应位于适当对齐的内存地址。具体来说，Memory Reservation Block应与8字节边界对齐，Structure Block应与4字节边界对齐。

此外，设备树blob作为一个整体可以重新定位，而不会破坏子块的对齐

Structure Block和String Block应与设备树blob的开头对齐偏移。为了确保块在内存中的对齐，只需确保设备树作为一个整体被加载到与任何子块的最大对齐对齐的地址，即8字节边界对齐即可。符合DTSpec的引导程序应在将设备树blob传递给客户端程序之前，在对齐的地址加载设备树blob。如果DTSpec客户端程序在内存中重新定位设备树blob，它应该只将其重新定位到另一个8字节对齐的地址.

DTS文件

设备树源（DTS）格式是设备树的文本表示形式，dtc可以将其处理为内核所需形式的二进制设备树。以下描述不是DTS的正式语法定义，但描述了用于表示设备树的基本构造。

DTS文件的名称应以“.DTS”结尾。

编译指令

DTS文件中可以包含其他源文件。包含文件的名称应以“.dtsi”结尾。包含的文件可以反过来包含其他文件。

/include/ "FILE"

标签

源格式允许将标签附加到设备树中的任何节点或属性值。Phandle和路径引用可以通过引用标签自动生成，而不是显式指定Phandle值或节点的完整路径。标签仅用于设备树源格式，不编码为DTB二进制文件

标签的长度应在1到31个字符之间，仅由下表中的字符组成，不得以数字开头。

标签是通过在标签名称后附加冒号（“：”）创建的。通过在标签名称前加上与号（“&”）来创建引用。

节点和属性定义

设备树节点由节点名称和单元地址定义，大括号标记节点定义的开始和结束。它们前面可能有一个标签。

[label:] node-name[@unit-address] {

[properties definitions]

[child nodes]

};

节点可能包含属性定义和/或子节点定义。如果两者都存在，则属性应位于子节点之前。

可以删除以前定义的节点

/delete-node/ node-name;

/delete-node/ &label;

属性定义是以下形式的名称-值对：

[label:] property-name = value;

除了具有空（零长度）值的属性，其形式如下：

[label:] property-name;

可以删除以前定义的属性。

/delete-property/ property-name; 

属性值可以定义为32位整数单元的数组、以空结尾的字符串、字节串或它们的组合。

单元格数组由尖括号表示，尖括号围绕着一个空格分隔的C风格整数列表。例子：

interrupts = <17 0xc>; 

值可以表示为括号内的算术、位或逻辑表达式。

Arithmetic operators

+ add

- subtract

* multiply

/ divide

% modulo 

Bitwise operators

& and

| or

^ exclusive or

~ not

<< left shift

>> right shift

Logical operators

&& and

|| or

! Not

Relational operators

< less than

> greater than

<= less than or equal

>= greater than or equal

== equal

!= not equal

Ternary operators

?: (condition ? value_if_true : value_if_false)

64位值由两个32位单元表示。例子：

clock-frequency = <0x00000001 0x00000000>; 

以空结尾的字符串值使用双引号表示（属性值被认为包含终止的null字符）。例子：

compatible = "simple-bus"; 

字节串被括在方括号[]中，每个字节由两个十六进制数字表示。每个字节之间的空格是可选的。例子：

local-mac-address = [00 00 12 34 56 78]; 

等效于

local-mac-address = [000012345678]; 

值可能有几个逗号分隔的组件，这些组件连接在一起。例子：

compatible = "ns16550", "ns8250";

example = <0xf00f0000 19>, "a strange property format"; 

在单元数组中，对另一个节点的引用将扩展到该节点的phandle。引用后面可能跟有节点的标签。例子：

interrupt-parent = < &mpic >; 

或者，它们后面可能是大括号中节点的完整路径。例子：

interrupt-parent = < &{/soc/interrupt-controller@40000} >; 

在单元数组外部，对另一个节点的引用将扩展到该节点的完整路径。例子：

ethernet0 = &EMAC0; 

标签也可能出现在属性值的任何组成部分之前或之后，或者出现在单元格数组的单元格之间，或者在字节串的字节之间。示例

reg = reglabel: <0 sizelabel: 0x1000000>;

prop = [ab cd ef byte4: 00 ff fe];

str = start: "string value" end: ;

文件布局

dts-v1/;[memory reservations]/ {[property definitions][child nodes]};

/dts-v1/；应存在以将文件标识为版本1 DTS（没有此标签的DTS文件将被dtc视为过时的版本0，除了其他小但不兼容的更改外，该版本对整数使用不同的格式）。

内存预留由以下表格中的线条表示：

/memreserve/