Particiones de DTB y DTBO

Si tu BLOB del árbol de dispositivos (DTB) o el BLOB del árbol de dispositivos para la superposición (DTBO) se encuentra en una partición única, por ejemplo, la partición dtb y dtbo, usa la siguiente estructura de tabla y el formato de encabezado:

Figura 1: Ejemplo de diseño de partición de DTB y DTBO.

Estructuras de datos

dt_table_header es solo para la partición dtb/dtbo. NO PUEDES agregar este formato después del final de image.gz. Si tienes un solo DTB o DTBO, debes usar este formato (y el dt_entry_count en dt_table_header es 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
};

Para leer todos los dt_table_entry, usa dt_entry_size, dt_entry_count y dt_entries_offset. Ejemplo:

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

id, rev y custom en dt_table_entry son identificaciones de hardware opcionales del árbol de dispositivos que el bootloader puede usar para identificar de manera eficiente la DTB o DTBO que se cargará. Si el bootloader requiere información adicional, colócala en el DTB o DTBO, donde el bootloader puede leerla a través del análisis de DTB o DTBO (consulta el código de muestra a continuación).

Código de muestra

En el siguiente código de muestra, se verifica la identificación de hardware en el bootloader.

  • La función check_dtbo() verifica la identificación del hardware. Primero, verifica los datos en la estructura dt_table_entry (id, rev, etcétera). Si estos datos no son suficientes, carga los datos de dtb en la memoria y verifica el valor en dtb.
  • Los valores de las propiedades my_hw_information y soc_id se analizan en el nodo raíz (ejemplo en 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 es una herramienta para crear imágenes dtb/dtbo (código fuente en system/libufdt en AOSP). mkdtimg admite varios comandos, incluidos create, cfg_create y dump.

create

Usa el comando create para crear una imagen dtb/dtbo:

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

ftbX_filename genera un dt_table_entry en la imagen. Los entryX_option son los valores que se asignarán a dt_table_entry. Estos valores pueden ser cualquiera de los siguientes:

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

Los valores numéricos pueden ser un dígito de 32 bits (como 68000) o un número hexadecimal (como 0x6800). Como alternativa, puedes especificar una ruta de acceso con el siguiente formato:

<full_node_path>:<property_name>

Por ejemplo, /board/:id. mkdtimg lee el valor de la ruta de acceso en el archivo DTB o DTBO y asigna el valor (32 bits) a una propiedad relativa en dt_table_entry. Como alternativa, puedes proporcionar un global_option como opción predeterminada para todas las entradas. El valor predeterminado de page_size en dt_table_header es 2048. Usa global_option --page_size=<number> para asignar un valor diferente.

Ejemplo:

[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
  • En el primer dt_table_entry (board1.dtbo), id es 0x00010000 y custom[0] es 0x00000abc.
  • El segundo id es 0x00006800 y custom[0] es 0x00000abc.
  • En tercer lugar, id es 0x00006801 y custom[0] es 0x00000123.
  • Todos los demás usan el valor predeterminado (0).

cfg_create

El comando cfg_create crea una imagen con un archivo de configuración en el siguiente formato:

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

Las opciones global_option y entryX_option deben comenzar con uno o más caracteres de espacio (estas opciones son las mismas que las opciones create, sin el prefijo --). Se ignoran las líneas vacías o las líneas que comienzan con #.

Ejemplo:

[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 no controla la alineación de los archivos .dtb/.dtbo, sino que los adjunta a la imagen. Cuando usas dtc para compilar .dts en .dtb/.dtbo, debes agregar la opción -a. Por ejemplo, agregar la opción -a 4 agrega padding para que el tamaño de .dtb/.dtbo se alinee a 4 bytes.

Varias entradas de la tabla DT pueden compartir un .dtb/.dtbo. Si usas el mismo nombre de archivo para diferentes entradas, se almacenará solo un contenido en la imagen con el mismo dt_offset y dt_size. Esto es útil cuando se usa hardware diferente con DT idénticos.

volcado

Para imágenes dtb/dtbo, usa el comando dump para imprimir la información en la imagen. Ejemplo:

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
...