DTB 和 DTBO 分区

如果您的设备树 Blob (DTB) 或设备树 Blob 叠加层 (DTBO) 位于专属分区（例如 dtb 和 dtbo 分区）中，请使用以下表格结构和头文件格式：

图 1. DTB 和 DTBO 分区布局示例。

数据结构

dt_table_header 仅适用于 dtb/dtbo 分区；您不能在 image.gz 末尾处附加此格式。如果您有一个 DTB/DTBO，则仍必须使用此格式（并且，dt_table_header 中的 dt_entry_count 为 1）。

#define DT_TABLE_MAGIC 0xd7b7ab1e

struct dt_table_header {
  uint32_t magic;             // DT_TABLE_MAGIC
  uint32_t total_size;        // includes dt_table_header + all dt_table_entry
                              // and all dtb/dtbo
  uint32_t header_size;       // sizeof(dt_table_header)

  uint32_t dt_entry_size;     // sizeof(dt_table_entry)
  uint32_t dt_entry_count;    // number of dt_table_entry
  uint32_t dt_entries_offset; // offset to the first dt_table_entry
                              // from head of dt_table_header

  uint32_t page_size;         // flash page size we assume
  uint32_t version;       // DTBO image version, the current version is 0.
                          // The version is incremented when the
                          // dt_table_header struct is updated.
};

struct dt_table_entry {
  uint32_t dt_size;
  uint32_t dt_offset;         // offset from head of dt_table_header

  uint32_t id;                // optional, must be zero if unused
  uint32_t rev;               // optional, must be zero if unused
  uint32_t custom[4];         // optional, must be zero if unused
};

如需读取所有 dt_table_entry，请使用 dt_entry_size、dt_entry_count 和 dt_entries_offset。示例：

my_read(entries_buf,
        header_addr + header->dt_entries_offset,
        header->dt_entry_size * header->dt_entry_count);

dt_table_entry 中的 id、rev、custom 是设备树的可选硬件标识，引导加载程序可以使用这些标识有效地识别要加载的 DTB/DTBO。如果引导加载程序需要获取更多信息，请将其放在 DTB/DTBO 中，引导加载程序可在这里解析 DTB/DTBO，从而读取这些信息（参见下面的示例代码）。

示例代码

以下示例代码可检查引导加载程序中的硬件标识。

check_dtbo() 函数用于检查硬件标识。首先它会检查结构 dt_table_entry 中的数据（id、rev 等）。如果这些数据未能提供充足的信息，它会将 dtb 数据加载到内存中，并检查 dtb 中的值。

my_hw_information 和 soc_id 属性的值会在根节点中进行解析（请参见 my_dtbo_1.dts 中的示例）。

[my_dtbo_1.dts]
/dts-v1/;
/plugin/;

/ {
  /* As DTS design, these properties only for loader, won't overlay */
  compatible = "board_manufacturer,board_model";

  /* These properties are examples */
  board_id = <0x00010000>;
  board_rev = <0x00010001>;
  another_hw_information = "some_data";
  soc_id = <0x68000000>;
  ...
};

&device@0 {
  value = <0x1>;
  status = "okay";
};


[my_bootloader.c]
int check_dtbo(const dt_table_entry *entry, uint32_t header_addr) {
  ...
  if (entry->id != ... || entry->rev != ...) {
    ...
  }
  ...
  void * fdt_buf = my_load_dtb(header_addr + entry->dt_offset, entry->dt_size);
  int root_node_off = fdt_path_offset(fdt_buf, "/");
  ...
  const char *my_hw_information =
    (const char *)fdt_getprop(fdt_buf, root_node_off, "my_hw_information", NULL);
  if (my_hw_information != NULL && strcmp(my_hw_information, ...) != 0) {
    ...
  }
  const fdt32_t *soc_id = fdt_getprop(fdt_buf, root_node_off, "soc_id", NULL);
  if (soc_id != NULL && *soc_id != ...) {
    ...
  }
  ...
}

mkdtimg

mkdtimg 是用于创建 dtb/dtbo 映像的工具（源代码位于 AOSP 中的 system/libufdt 下）。mkdtimg 支持多个命令，包括 create、cfg_create 和 dump。

create

使用 create 命令创建 dtb/dtbo 映像：

mkdtimg create <image_filename> (<global-option>...) \
    <ftb1_filename> (<entry1_option>...) \
    <ftb2_filename> (<entry2_option>...) \
    ...

ftbX_filename 会在映像中生成一个 dt_table_entry。entryX_option 是分配给 dt_table_entry 的值。这些值可以是以下任一值：

--id=<number|path>
--rev=<number|path>
--custom0=<number|path>
--custom1=<number|path>
--custom2=<number|path>
--custom3=<number|path>

数字值可以是 32 位数字（如 68000）或十六进制数字（如 0x6800）。或者，您也可以使用以下格式指定路径：

<full_node_path>:<property_name>

例如，/board/:id。mkdtimg 从 DTB/DTBO 文件中的路径读取值，并将值（32 位）分配给 dt_table_entry 中的相对属性。或者，您也可以将 global_option 作为所有条目的默认选项。dt_table_header 中 page_size 的默认值为 2048；可使用 global_option --page_size=<number> 分配其他值。

示例：

[board1.dts]
/dts-v1/;
/plugin/;

/ {
  compatible = "board_manufacturer,board_model";
  board_id = <0x00010000>;
  board_rev = <0x00010001>;
  another_hw_information = "some_data";
  ...
};

&device@0 {
  value = <0x1>;
  status = "okay";
};


mkdtimg create dtbo.img --id=/:board_id --custom0=0xabc \
  board1.dtbo \
  board2.dtbo --id=0x6800 \
  board3.dtbo --id=0x6801 --custom0=0x123

第一个 dt_table_entry (board1.dtbo) id 为 0x00010000，custom[0] 为 0x00000abc。
第二个 id 为 0x00006800，custom[0] 为 0x00000abc。
第三个 id 为 0x00006801，custom[0] 为 0x00000123。
所有其他项均使用默认值 (0)。

cfg_create

cfg_create 命令使用以下格式的配置文件创建映像：

# global options
  <global_option>
  ...
# entries
<ftb1_filename>     # comment
  <entry1_option>   # comment
  ...
<ftb2_filename>
  <entry2_option>
  ...
...

选项 global_option 和 entryX_option 必须以一个或多个空格字符开头（这些选项与 create 选项相同，不带 -- 前缀）。空行或者以 # 开头的行将被忽略。

示例：

[dtboimg.cfg]
# global options
  id=/:board_id
  rev=/:board_rev
  custom0=0xabc

board1.dtbo

board2.dtbo
  id=0x6800       # override the value of id in global options

board2.dtbo
  id=0x6801       # override the value of id in global options
  custom0=0x123   # override the value of custom0 in global options


mkdtimg cfg_create dtbo.img dtboimg.cfg

mkdtimg 不会处理 .dtb/.dtbo 文件的对齐方式，而是将它们附加到映像上。使用 dtc 将 .dts 编译为 .dtb/.dtbo 时，必须添加选项 -a。例如，添加选项 -a 4 会增加内边距，使得 .dtb/.dtbo 的大小调整为 4 个字节。

多个 DT 表格条目可以共享一个 .dtb/.dtbo。如果您为不同的条目使用同一个文件名，则系统只会在具有相同 dt_offset 和 dt_size 的映像中存储一份内容。使用具有相同 DT 的不同硬件时，这种方式非常有用。

dump

对于 dtb/dtbo 映像，请使用 dump 命令打印映像中的信息。示例：

mkdtimg dump dtbo.img
dt_table_header:
               magic = d7b7ab1e
          total_size = 1300
         header_size = 32
       dt_entry_size = 32
      dt_entry_count = 3
   dt_entries_offset = 32
           page_size = 2048
             version = 0
dt_table_entry[0]:
             dt_size = 380
           dt_offset = 128
                  id = 00010000
                 rev = 00010001
           custom[0] = 00000abc
           custom[1] = 00000000
           custom[2] = 00000000
           custom[3] = 00000000
           (FDT)size = 380
     (FDT)compatible = board_manufacturer,board_model
...