tools/binman/README.entries

1 Binman Entry Documentation
4 This file describes the entry types supported by binman. These entry types can
6 fairly easy to create new entry types. Just add a new file to the 'etype'
14 Entry: blob: Entry containing an arbitrary binary blob
18 class by other entry types.
20 Properties / Entry arguments:
21     - filename: Filename of file to read into entry
26 This entry reads data from a file and places it in the entry. The
28 example the 'u_boot' entry which provides the filename 'u-boot.bin'.
36 Entry: blob-dtb: A blob that holds a device tree
45 Entry: blob-named-by-arg: A blob entry which gets its filename property from its subclass
48 Properties / Entry arguments:
49     - <xxx>-path: Filename containing the contents of this entry (optional,
54 This entry cannot be used directly. Instead, it is used as a parent class
55 for another entry, which defined blob_fname. This parameter is used to
56 set the entry-arg or property containing the filename. The entry-arg or
63 Entry: cros-ec-rw: A blob entry which contains a Chromium OS read-write EC image
66 Properties / Entry arguments:
69 This entry holds a Chromium OS EC (embedded controller) image, for use in
74 Entry: files: Entry containing a set of files
77 Properties / Entry arguments:
83 This entry reads a number of files and places each in a separate sub-entry
84 within this entry. To access these you need to enable device-tree updates
89 Entry: fill: An entry which is filled to a particular byte value
92 Properties / Entry arguments:
93     - fill-byte: Byte to use to fill the entry
95 Note that the size property must be set since otherwise this entry does not
100 that byte. But this entry is sometimes useful for explicitly setting the
105 Entry: fmap: An entry which contains an Fmap section
108 Properties / Entry arguments:
119 When used, this entry will be populated with an FMAP which reflects the
125 Entry: gbb: An entry which contains a Chromium OS Google Binary Block
128 Properties / Entry arguments:
144 Entry: intel-cmc: Entry containing an Intel Chipset Micro Code (CMC) file
147 Properties / Entry arguments:
148     - filename: Filename of file to read into entry
157 Entry: intel-descriptor: Intel flash descriptor block (4KB)
160 Properties / Entry arguments:
164 This entry is placed at the start of flash and provides information about
169 With this entry in your image, the position of the 'intel-me' entry will be
178 Entry: intel-fsp: Entry containing an Intel Firmware Support Package (FSP) file
181 Properties / Entry arguments:
182     - filename: Filename of file to read into entry
195 Entry: intel-me: Entry containing an Intel Management Engine (ME) file
198 Properties / Entry arguments:
199     - filename: Filename of file to read into entry
213 Entry: intel-mrc: Entry containing an Intel Memory Reference Code (MRC) file
216 Properties / Entry arguments:
217     - filename: Filename of file to read into entry
227 Entry: intel-vbt: Entry containing an Intel Video BIOS Table (VBT) file
230 Properties / Entry arguments:
231     - filename: Filename of file to read into entry
240 Entry: intel-vga: Entry containing an Intel Video Graphics Adaptor (VGA) file
243 Properties / Entry arguments:
244     - filename: Filename of file to read into entry
255 Entry: powerpc-mpc85xx-bootpg-resetvec: PowerPC mpc85xx bootpg + resetvec code for U-Boot
258 Properties / Entry arguments:
261 This enrty is valid for PowerPC mpc85xx cpus. This entry holds
267 Entry: section: Entry that contains other entries
270 Properties / Entry arguments: (see binman README for more information)
273     - pad-before: Add padding before the entry
274     - pad-after: Add padding after the entry
278     - name-prefix: Adds a prefix to the name of every entry in the section
281 A section is an entry which can contain other entries, thus allowing
287 Entry: text: An entry which contains text
294 Properties / Entry arguments:
295     text-label: The value of this string indicates the property / entry-arg
296         that contains the string to place in the entry
298         place in the entry.
311 and binman will insert that string into the entry.
322 by setting the size of the entry to something larger than the text.
326 Entry: u-boot: U-Boot flat binary
329 Properties / Entry arguments:
339     'Access to binman entry offsets at run time (fdt)'
345 Entry: u-boot-dtb: U-Boot device tree
348 Properties / Entry arguments:
355 Note: This is mostly an internal entry type, used by others. This allows
360 Entry: u-boot-dtb-with-ucode: A U-Boot device tree file, with the microcode removed
363 Properties / Entry arguments:
367 this process. This entry provides the U-Boot device-tree file, which
369 place then the offset and size of the microcode is recorded by this entry,
371 entry deletes the microcode from the device tree (to save space) and makes
376 Entry: u-boot-elf: U-Boot ELF image
379 Properties / Entry arguments:
387 Entry: u-boot-img: U-Boot legacy image
390 Properties / Entry arguments:
401 Entry: u-boot-nodtb: U-Boot flat binary without device tree appended
404 Properties / Entry arguments:
410 entry after this one, or use a u_boot entry instead (which contains both
415 Entry: u-boot-spl: U-Boot SPL binary
418 Properties / Entry arguments:
430     'Access to binman entry offsets at run time (symbols)'
439 Entry: u-boot-spl-bss-pad: U-Boot SPL binary padded with a BSS region
442 Properties / Entry arguments:
450 This entry is useful in that case. It automatically pads out the entry size
458 Entry: u-boot-spl-dtb: U-Boot SPL device tree
461 Properties / Entry arguments:
470 Entry: u-boot-spl-elf: U-Boot SPL ELF image
473 Properties / Entry arguments:
481 Entry: u-boot-spl-nodtb: SPL binary without device tree appended
484 Properties / Entry arguments:
491 entry after this one, or use a u_boot_spl entry instead (which contains
496 Entry: u-boot-spl-with-ucode-ptr: U-Boot SPL with embedded microcode pointer
506 Entry: u-boot-tpl: U-Boot TPL binary
509 Properties / Entry arguments:
521     'Access to binman entry offsets at run time (symbols)'
530 Entry: u-boot-tpl-dtb: U-Boot TPL device tree
533 Properties / Entry arguments:
542 Entry: u-boot-tpl-dtb-with-ucode: U-Boot TPL with embedded microcode pointer
552 Entry: u-boot-tpl-with-ucode-ptr: U-Boot TPL with embedded microcode pointer
560 Entry: u-boot-ucode: U-Boot microcode block
563 Properties / Entry arguments:
566 The contents of this entry are filled in automatically by other entries
585 entry (u-boot-ucode) is empty. If there is more than one update, then
586 this entry holds the concatenation of all updates, and the device tree
587 entry (u-boot-dtb-with-ucode) is updated to remove the microcode. This
592 Entry types that have a part to play in handling microcode:
605         the Entry_u_boot_dtb_with_ucode entry, and uses it as the
606         contents of this entry.
610 Entry: u-boot-with-ucode-ptr: U-Boot with embedded microcode pointer
613 Properties / Entry arguments:
620 this process. This entry updates U-Boot with the offset and size of the
622 complicated. Otherwise it is the same as the u_boot entry.
626 Entry: vblock: An entry which contains a Chromium OS verified boot block
629 Properties / Entry arguments:
640         used as the entry contents)
648 Entry: x86-start16: x86 16-bit start-up code for U-Boot
651 Properties / Entry arguments:
656 must be placed at a particular address. This entry holds that code. It is
658 for changing to 32-bit mode and jumping to U-Boot's entry point, which
661 For 64-bit U-Boot, the 'x86_start16_spl' entry type is used instead.
665 Entry: x86-start16-spl: x86 16-bit start-up code for SPL
668 Properties / Entry arguments:
673 must be placed at a particular address. This entry holds that code. It is
678 For 32-bit U-Boot, the 'x86_start16' entry type is used instead.
682 Entry: x86-start16-tpl: x86 16-bit start-up code for TPL
685 Properties / Entry arguments:
690 must be placed at a particular address. This entry holds that code. It is
694 If TPL is not being used, the 'x86_start16_spl or 'x86_start16' entry types