מחיצות DTB ו-DTBO

אם ה-blob של עץ המכשיר (DTB) או blob של עץ מכשיר עבור שכבת-על (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

יצירה

משתמשים בפקודה 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) או מספר הקסדצימלי (כמו 0x6,800). לחלופין, אפשר לציין נתיב באמצעות הפורמט:

<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 בייטים.

יש כמה רשומות בטבלת DT יכולות לשתף .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
...