DTB 和 DTBO 分區

如果您的裝置樹狀結構 blob (DTB) 或裝置樹狀結構 blob (DTBO) 是同一個分區, 例如,dtbdtbo 分區,請使用以下的資料表結構 和標頭格式:

圖 1. DTB 和 DTBO 分區版面配置範例。

資料結構

dt_table_header 用於 dtb/dtbo 個分區;您「無法」附加這種格式 在 image.gz 結束之後。如果您使用單一 DTB 或 DTBO,您必須 仍使用此格式 (而 dt_entry_count dt_table_header 為 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_sizedt_entry_countdt_entries_offset。例子:

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

idrevcustom dt_table_entry 是裝置的硬體識別資訊 (選用) 。如果 系統啟動載入程式需要額外資訊,請放在 DTB 或 DTBO 的 系統啟動載入程式可透過剖析 DTB 或 DTBO 來讀取 (請參閱下方的程式碼範例)。

程式碼範例

下列程式碼範例會檢查系統啟動載入程式中的硬體識別資訊。

  • check_dtbo() 函式會檢查硬體識別。 其會先檢查結構 dt_table_entry 中的資料 (idrev 等)。如果資料還不夠,就會載入 dtb 將資料傳入記憶體,然後檢查 dtb 中的值。
  • my_hw_informationsoc_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 張) (資料來源 程式碼system/libufdt)。「mkdtimg」支援 包括 createcfg_createdump

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) 或 16 進位數字 (例如 0x6800)。您也可以使用以下格式指定路徑:

<full_node_path>:<property_name>

例如:/board/:idmkdtimg 會讀取值 從 DTB 或 DTBO 檔案內的路徑擷取出該值,並將值 (32 位元) 指派給相對 dt_table_entry中的屬性。或者,您也可以將 以 global_option 做為所有項目的預設選項。預設 dt_table_headerpage_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) id0x00010000custom[0]0x00000abc
  • 第二個id0x00006800custom[0]0x00000abc
  • 第三個id0x00006801custom[0]0x00000123
  • 其他 API 則使用預設值 (0)。

cfg_create

cfg_create 指令會建立含有設定檔的映像檔 格式如下:

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

選項 global_optionentryX_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_offsetdt_size 的圖片。這是 在使用不同硬體和相同 DT 時很實用。

轉儲

如果是 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
...