Разделы DTB и DTBO

Если объект DTB или DTBO находится в отдельном разделе, например dtb или dtbo, используйте следующую структуру таблицы и формат заголовка:

Рисунок 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_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);

Поля id, rev, custom в dt_table_entry – это необязательные идентификаторы оборудования устройства, которые загрузчик может использовать для эффективного определения 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 (исходный код находится в каталоге system/libufdt в AOSP). mkdtimg поддерживает несколько команд, в том числе create, cfg_create и dump.

создать

Чтобы создать изображение dtb/dtbo, используйте команду create:

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 в качестве варианта по умолчанию для всех записей. Значение по умолчанию для параметра page_size в dt_table_header – 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 байтам.

Несколько записей в таблице ДУ могут иметь одинаковые значения .dtb/.dtbo. Если вы используете одно и то же название файла для разных записей, в образе с одинаковыми значениями dt_offset и dt_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
...