1 Binman Entry Documentation
2 ===========================
4 This file describes the entry types supported by binman. These entry types can
5 be placed in an image one by one to build up a final firmware image. It is
6 fairly easy to create new entry types. Just add a new file to the 'etype'
7 directory. You can use the existing entries as examples.
9 Note that some entries are subclasses of others, using and extending their
10 features to produce new behaviours.
14 Entry: blob: Entry containing an arbitrary binary blob
15 ------------------------------------------------------
17 Note: This should not be used by itself. It is normally used as a parent
18 class by other entry types.
20 Properties / Entry arguments:
21 - filename: Filename of file to read into entry
22 - compress: Compression algorithm to use:
24 lz4: Use lz4 compression (via 'lz4' command-line utility)
26 This entry reads data from a file and places it in the entry. The
27 default filename is often specified specified by the subclass. See for
28 example the 'u_boot' entry which provides the filename 'u-boot.bin'.
30 If compression is enabled, an extra 'uncomp-size' property is written to
31 the node (if enabled with -u) which provides the uncompressed size of the
36 Entry: blob-dtb: A blob that holds a device tree
37 ------------------------------------------------
39 This is a blob containing a device tree. The contents of the blob are
40 obtained from the list of available device-tree files, managed by the
45 Entry: blob-named-by-arg: A blob entry which gets its filename property from its subclass
46 -----------------------------------------------------------------------------------------
48 Properties / Entry arguments:
49 - <xxx>-path: Filename containing the contents of this entry (optional,
52 where <xxx> is the blob_fname argument to the constructor.
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
57 property is in turn used to set the actual filename.
59 See cros_ec_rw for an example of this.
63 Entry: cbfs: Entry containing a Coreboot Filesystem (CBFS)
64 ----------------------------------------------------------
66 A CBFS provides a way to group files into a group. It has a simple directory
67 structure and allows the position of individual files to be set, since it is
68 designed to support execute-in-place in an x86 SPI-flash device. Where XIP
69 is not used, it supports compression and storing ELF files.
71 CBFS is used by coreboot as its way of orgnanising SPI-flash contents.
73 The contents of the CBFS are defined by subnodes of the cbfs entry, e.g.:
85 This creates a CBFS 1MB in size two files in it: u-boot.bin and u-boot.dtb.
86 Note that the size is required since binman does not support calculating it.
87 The contents of each entry is just what binman would normally provide if it
88 were not a CBFS node. A blob type can be used to import arbitrary files as
89 with the second subnode below:
100 filename = "u-boot.dtb";
102 cbfs-compress = "lz4";
103 cbfs-offset = <0x100000>;
107 This creates a CBFS 1MB in size with u-boot.bin (named "BOOT") and
108 u-boot.dtb (named "dtb") and compressed with the lz4 algorithm.
111 Properties supported in the top-level CBFS node:
114 Defaults to "x86", but you can specify the architecture if needed.
117 Properties supported in the CBFS entry subnodes:
120 This is the name of the file created in CBFS. It defaults to the entry
121 name (which is the node name), but you can override it with this
125 This is the CBFS file type. The following are supported:
128 This is a 'raw' file, although compression is supported. It can be
129 used to store any file in CBFS.
132 This is an ELF file that has been loaded (i.e. mapped to memory), so
133 appears in the CBFS as a flat binary. The input file must be an ELF
134 image, for example this puts "u-boot" (the ELF image) into a 'stage'
145 You can use your own ELF file with something like:
151 filename = "cbfs-stage.elf";
156 As mentioned, the file is converted to a flat binary, so it is
157 equivalent to adding "u-boot.bin", for example, but with the load and
158 start addresses specified by the ELF. At present there is no option
159 to add a flat binary with a load/start address, similar to the
160 'add-flat-binary' option in cbfstool.
163 This is the offset of the file's data within the CBFS. It is used to
164 specify where the file should be placed in cases where a fixed position
165 is needed. Typical uses are for code which is not relocatable and must
166 execute in-place from a particular address. This works because SPI flash
167 is generally mapped into memory on x86 devices. The file header is
168 placed before this offset so that the data start lines up exactly with
169 the chosen offset. If this property is not provided, then the file is
170 placed in the next available spot.
172 The current implementation supports only a subset of CBFS features. It does
173 not support other file types (e.g. payload), adding multiple files (like the
174 'files' entry with a pattern supported by binman), putting files at a
175 particular offset in the CBFS and a few other things.
177 Of course binman can create images containing multiple CBFSs, simply by
178 defining these in the binman config:
205 filename = "image.jpg";
210 This creates an 8MB image with two CBFSs, one at offset 1MB, one at 7MB,
215 Entry: cros-ec-rw: A blob entry which contains a Chromium OS read-write EC image
216 --------------------------------------------------------------------------------
218 Properties / Entry arguments:
219 - cros-ec-rw-path: Filename containing the EC image
221 This entry holds a Chromium OS EC (embedded controller) image, for use in
222 updating the EC on startup via software sync.
226 Entry: fdtmap: An entry which contains an FDT map
227 -------------------------------------------------
229 Properties / Entry arguments:
232 An FDT map is just a header followed by an FDT containing a list of all the
233 entries in the image. The root node corresponds to the image node in the
234 original FDT, and an image-name property indicates the image name in that
237 The header is the string _FDTMAP_ followed by 8 unused bytes.
239 When used, this entry will be populated with an FDT map which reflects the
240 entries in the current image. Hierarchy is preserved, and all offsets and
243 Note that the -u option must be provided to ensure that binman updates the
244 FDT with the position of each entry.
246 Example output for a simple image with U-Boot and an FDT map:
249 image-name = "binman";
251 image-pos = <0x00000000>;
252 offset = <0x00000000>;
255 image-pos = <0x00000000>;
256 offset = <0x00000000>;
260 image-pos = <0x00000004>;
261 offset = <0x00000004>;
265 If allow-repack is used then 'orig-offset' and 'orig-size' properties are
266 added as necessary. See the binman README.
270 Entry: files: Entry containing a set of files
271 ---------------------------------------------
273 Properties / Entry arguments:
274 - pattern: Filename pattern to match the files to include
275 - compress: Compression algorithm to use:
277 lz4: Use lz4 compression (via 'lz4' command-line utility)
279 This entry reads a number of files and places each in a separate sub-entry
280 within this entry. To access these you need to enable device-tree updates
281 at run-time so you can obtain the file positions.
285 Entry: fill: An entry which is filled to a particular byte value
286 ----------------------------------------------------------------
288 Properties / Entry arguments:
289 - fill-byte: Byte to use to fill the entry
291 Note that the size property must be set since otherwise this entry does not
292 know how large it should be.
294 You can often achieve the same effect using the pad-byte property of the
295 overall image, in that the space between entries will then be padded with
296 that byte. But this entry is sometimes useful for explicitly setting the
297 byte value of a region.
301 Entry: fmap: An entry which contains an Fmap section
302 ----------------------------------------------------
304 Properties / Entry arguments:
307 FMAP is a simple format used by flashrom, an open-source utility for
308 reading and writing the SPI flash, typically on x86 CPUs. The format
309 provides flashrom with a list of areas, so it knows what it in the flash.
310 It can then read or write just a single area, instead of the whole flash.
312 The format is defined by the flashrom project, in the file lib/fmap.h -
313 see www.flashrom.org/Flashrom for more information.
315 When used, this entry will be populated with an FMAP which reflects the
316 entries in the current image. Note that any hierarchy is squashed, since
317 FMAP does not support this. Also, CBFS entries appear as a single entry -
318 the sub-entries are ignored.
322 Entry: gbb: An entry which contains a Chromium OS Google Binary Block
323 ---------------------------------------------------------------------
325 Properties / Entry arguments:
326 - hardware-id: Hardware ID to use for this build (a string)
327 - keydir: Directory containing the public keys to use
328 - bmpblk: Filename containing images used by recovery
330 Chromium OS uses a GBB to store various pieces of information, in particular
331 the root and recovery keys that are used to verify the boot process. Some
332 more details are here:
334 https://www.chromium.org/chromium-os/firmware-porting-guide/2-concepts
336 but note that the page dates from 2013 so is quite out of date. See
337 README.chromium for how to obtain the required keys and tools.
341 Entry: image-header: An entry which contains a pointer to the FDT map
342 ---------------------------------------------------------------------
344 Properties / Entry arguments:
345 location: Location of header ("start" or "end" of image). This is
346 optional. If omitted then the entry must have an offset property.
348 This adds an 8-byte entry to the start or end of the image, pointing to the
349 location of the FDT map. The format is a magic number followed by an offset
350 from the start or end of the image, in twos-compliment format.
352 This entry must be in the top-level part of the image.
354 NOTE: If the location is at the start/end, you will probably need to specify
355 sort-by-offset for the image, unless you actually put the image header
356 first/last in the entry list.
360 Entry: intel-cmc: Entry containing an Intel Chipset Micro Code (CMC) file
361 -------------------------------------------------------------------------
363 Properties / Entry arguments:
364 - filename: Filename of file to read into entry
366 This file contains microcode for some devices in a special format. An
367 example filename is 'Microcode/C0_22211.BIN'.
369 See README.x86 for information about x86 binary blobs.
373 Entry: intel-descriptor: Intel flash descriptor block (4KB)
374 -----------------------------------------------------------
376 Properties / Entry arguments:
377 filename: Filename of file containing the descriptor. This is typically
378 a 4KB binary file, sometimes called 'descriptor.bin'
380 This entry is placed at the start of flash and provides information about
381 the SPI flash regions. In particular it provides the base address and
382 size of the ME (Management Engine) region, allowing us to place the ME
383 binary in the right place.
385 With this entry in your image, the position of the 'intel-me' entry will be
386 fixed in the image, which avoids you needed to specify an offset for that
387 region. This is useful, because it is not possible to change the position
388 of the ME region without updating the descriptor.
390 See README.x86 for information about x86 binary blobs.
394 Entry: intel-fit: Intel Firmware Image Table (FIT)
395 --------------------------------------------------
397 This entry contains a dummy FIT as required by recent Intel CPUs. The FIT
398 contains information about the firmware and microcode available in the
401 At present binman only supports a basic FIT with no microcode.
405 Entry: intel-fit-ptr: Intel Firmware Image Table (FIT) pointer
406 --------------------------------------------------------------
408 This entry contains a pointer to the FIT. It is required to be at address
409 0xffffffc0 in the image.
413 Entry: intel-fsp: Entry containing an Intel Firmware Support Package (FSP) file
414 -------------------------------------------------------------------------------
416 Properties / Entry arguments:
417 - filename: Filename of file to read into entry
419 This file contains binary blobs which are used on some devices to make the
420 platform work. U-Boot executes this code since it is not possible to set up
421 the hardware using U-Boot open-source code. Documentation is typically not
422 available in sufficient detail to allow this.
424 An example filename is 'FSP/QUEENSBAY_FSP_GOLD_001_20-DECEMBER-2013.fd'
426 See README.x86 for information about x86 binary blobs.
430 Entry: intel-fsp-m: Entry containing Intel Firmware Support Package (FSP) memory init
431 -------------------------------------------------------------------------------------
433 Properties / Entry arguments:
434 - filename: Filename of file to read into entry
436 This file contains a binary blob which is used on some devices to set up
437 SDRAM. U-Boot executes this code in SPL so that it can make full use of
438 memory. Documentation is typically not available in sufficient detail to
439 allow U-Boot do this this itself..
441 An example filename is 'fsp_m.bin'
443 See README.x86 for information about x86 binary blobs.
447 Entry: intel-fsp-s: Entry containing Intel Firmware Support Package (FSP) silicon init
448 --------------------------------------------------------------------------------------
450 Properties / Entry arguments:
451 - filename: Filename of file to read into entry
453 This file contains a binary blob which is used on some devices to set up
454 the silicon. U-Boot executes this code in U-Boot proper after SDRAM is
455 running, so that it can make full use of memory. Documentation is typically
456 not available in sufficient detail to allow U-Boot do this this itself.
458 An example filename is 'fsp_s.bin'
460 See README.x86 for information about x86 binary blobs.
464 Entry: intel-fsp-t: Entry containing Intel Firmware Support Package (FSP) temp ram init
465 ---------------------------------------------------------------------------------------
467 Properties / Entry arguments:
468 - filename: Filename of file to read into entry
470 This file contains a binary blob which is used on some devices to set up
471 temporary memory (Cache-as-RAM or CAR). U-Boot executes this code in TPL so
472 that it has access to memory for its stack and initial storage.
474 An example filename is 'fsp_t.bin'
476 See README.x86 for information about x86 binary blobs.
480 Entry: intel-ifwi: Entry containing an Intel Integrated Firmware Image (IFWI) file
481 ----------------------------------------------------------------------------------
483 Properties / Entry arguments:
484 - filename: Filename of file to read into entry. This is either the
485 IFWI file itself, or a file that can be converted into one using a
487 - convert-fit: If present this indicates that the ifwitool should be
488 used to convert the provided file into a IFWI.
490 This file contains code and data used by the SoC that is required to make
491 it work. It includes U-Boot TPL, microcode, things related to the CSE
492 (Converged Security Engine, the microcontroller that loads all the firmware)
493 and other items beyond the wit of man.
495 A typical filename is 'ifwi.bin' for an IFWI file, or 'fitimage.bin' for a
496 file that will be converted to an IFWI.
498 The position of this entry is generally set by the intel-descriptor entry.
500 The contents of the IFWI are specified by the subnodes of the IFWI node.
501 Each subnode describes an entry which is placed into the IFWFI with a given
502 sub-partition (and optional entry name).
504 Properties for subnodes:
505 ifwi-subpart - sub-parition to put this entry into, e.g. "IBBP"
506 ifwi-entry - entry name t use, e.g. "IBBL"
507 ifwi-replace - if present, indicates that the item should be replaced
508 in the IFWI. Otherwise it is added.
510 See README.x86 for information about x86 binary blobs.
514 Entry: intel-me: Entry containing an Intel Management Engine (ME) file
515 ----------------------------------------------------------------------
517 Properties / Entry arguments:
518 - filename: Filename of file to read into entry
520 This file contains code used by the SoC that is required to make it work.
521 The Management Engine is like a background task that runs things that are
522 not clearly documented, but may include keyboard, display and network
523 access. For platform that use ME it is not possible to disable it. U-Boot
524 does not directly execute code in the ME binary.
526 A typical filename is 'me.bin'.
528 The position of this entry is generally set by the intel-descriptor entry.
530 See README.x86 for information about x86 binary blobs.
534 Entry: intel-mrc: Entry containing an Intel Memory Reference Code (MRC) file
535 ----------------------------------------------------------------------------
537 Properties / Entry arguments:
538 - filename: Filename of file to read into entry
540 This file contains code for setting up the SDRAM on some Intel systems. This
541 is executed by U-Boot when needed early during startup. A typical filename
544 See README.x86 for information about x86 binary blobs.
548 Entry: intel-refcode: Entry containing an Intel Reference Code file
549 -------------------------------------------------------------------
551 Properties / Entry arguments:
552 - filename: Filename of file to read into entry
554 This file contains code for setting up the platform on some Intel systems.
555 This is executed by U-Boot when needed early during startup. A typical
556 filename is 'refcode.bin'.
558 See README.x86 for information about x86 binary blobs.
562 Entry: intel-vbt: Entry containing an Intel Video BIOS Table (VBT) file
563 -----------------------------------------------------------------------
565 Properties / Entry arguments:
566 - filename: Filename of file to read into entry
568 This file contains code that sets up the integrated graphics subsystem on
569 some Intel SoCs. U-Boot executes this when the display is started up.
571 See README.x86 for information about Intel binary blobs.
575 Entry: intel-vga: Entry containing an Intel Video Graphics Adaptor (VGA) file
576 -----------------------------------------------------------------------------
578 Properties / Entry arguments:
579 - filename: Filename of file to read into entry
581 This file contains code that sets up the integrated graphics subsystem on
582 some Intel SoCs. U-Boot executes this when the display is started up.
584 This is similar to the VBT file but in a different format.
586 See README.x86 for information about Intel binary blobs.
590 Entry: powerpc-mpc85xx-bootpg-resetvec: PowerPC mpc85xx bootpg + resetvec code for U-Boot
591 -----------------------------------------------------------------------------------------
593 Properties / Entry arguments:
594 - filename: Filename of u-boot-br.bin (default 'u-boot-br.bin')
596 This entry is valid for PowerPC mpc85xx cpus. This entry holds
597 'bootpg + resetvec' code for PowerPC mpc85xx CPUs which needs to be
598 placed at offset 'RESET_VECTOR_ADDRESS - 0xffc'.
602 Entry: section: Entry that contains other entries
603 -------------------------------------------------
605 Properties / Entry arguments: (see binman README for more information)
606 pad-byte: Pad byte to use when padding
607 sort-by-offset: True if entries should be sorted by offset, False if
608 they must be in-order in the device tree description
609 end-at-4gb: Used to build an x86 ROM which ends at 4GB (2^32)
610 skip-at-start: Number of bytes before the first entry starts. These
611 effectively adjust the starting offset of entries. For example,
612 if this is 16, then the first entry would start at 16. An entry
613 with offset = 20 would in fact be written at offset 4 in the image
614 file, since the first 16 bytes are skipped when writing.
615 name-prefix: Adds a prefix to the name of every entry in the section
616 when writing out the map
618 Since a section is also an entry, it inherits all the properies of entries
621 A section is an entry which can contain other entries, thus allowing
622 hierarchical images to be created. See 'Sections and hierarchical images'
623 in the binman README for more information.
627 Entry: text: An entry which contains text
628 -----------------------------------------
630 The text can be provided either in the node itself or by a command-line
631 argument. There is a level of indirection to allow multiple text strings
634 Properties / Entry arguments:
635 text-label: The value of this string indicates the property / entry-arg
636 that contains the string to place in the entry
637 <xxx> (actual name is the value of text-label): contains the string to
639 <text>: The text to place in the entry (overrides the above mechanism).
640 This is useful when the text is constant.
646 text-label = "message";
651 binman -amessage="this is my message"
653 and binman will insert that string into the entry.
655 It is also possible to put the string directly in the node:
659 text-label = "message";
660 message = "a message directly in the node"
667 text = "some text directly in the node"
670 The text is not itself nul-terminated. This can be achieved, if required,
671 by setting the size of the entry to something larger than the text.
675 Entry: u-boot: U-Boot flat binary
676 ---------------------------------
678 Properties / Entry arguments:
679 - filename: Filename of u-boot.bin (default 'u-boot.bin')
681 This is the U-Boot binary, containing relocation information to allow it
682 to relocate itself at runtime. The binary typically includes a device tree
683 blob at the end of it. Use u_boot_nodtb if you want to package the device
686 U-Boot can access binman symbols at runtime. See:
688 'Access to binman entry offsets at run time (fdt)'
690 in the binman README for more information.
694 Entry: u-boot-dtb: U-Boot device tree
695 -------------------------------------
697 Properties / Entry arguments:
698 - filename: Filename of u-boot.dtb (default 'u-boot.dtb')
700 This is the U-Boot device tree, containing configuration information for
701 U-Boot. U-Boot needs this to know what devices are present and which drivers
704 Note: This is mostly an internal entry type, used by others. This allows
705 binman to know which entries contain a device tree.
709 Entry: u-boot-dtb-with-ucode: A U-Boot device tree file, with the microcode removed
710 -----------------------------------------------------------------------------------
712 Properties / Entry arguments:
713 - filename: Filename of u-boot.dtb (default 'u-boot.dtb')
715 See Entry_u_boot_ucode for full details of the three entries involved in
716 this process. This entry provides the U-Boot device-tree file, which
717 contains the microcode. If the microcode is not being collated into one
718 place then the offset and size of the microcode is recorded by this entry,
719 for use by u_boot_with_ucode_ptr. If it is being collated, then this
720 entry deletes the microcode from the device tree (to save space) and makes
721 it available to u_boot_ucode.
725 Entry: u-boot-elf: U-Boot ELF image
726 -----------------------------------
728 Properties / Entry arguments:
729 - filename: Filename of u-boot (default 'u-boot')
731 This is the U-Boot ELF image. It does not include a device tree but can be
732 relocated to any address for execution.
736 Entry: u-boot-img: U-Boot legacy image
737 --------------------------------------
739 Properties / Entry arguments:
740 - filename: Filename of u-boot.img (default 'u-boot.img')
742 This is the U-Boot binary as a packaged image, in legacy format. It has a
743 header which allows it to be loaded at the correct address for execution.
745 You should use FIT (Flat Image Tree) instead of the legacy image for new
750 Entry: u-boot-nodtb: U-Boot flat binary without device tree appended
751 --------------------------------------------------------------------
753 Properties / Entry arguments:
754 - filename: Filename of u-boot.bin (default 'u-boot-nodtb.bin')
756 This is the U-Boot binary, containing relocation information to allow it
757 to relocate itself at runtime. It does not include a device tree blob at
758 the end of it so normally cannot work without it. You can add a u_boot_dtb
759 entry after this one, or use a u_boot entry instead (which contains both
760 U-Boot and the device tree).
764 Entry: u-boot-spl: U-Boot SPL binary
765 ------------------------------------
767 Properties / Entry arguments:
768 - filename: Filename of u-boot-spl.bin (default 'spl/u-boot-spl.bin')
770 This is the U-Boot SPL (Secondary Program Loader) binary. This is a small
771 binary which loads before U-Boot proper, typically into on-chip SRAM. It is
772 responsible for locating, loading and jumping to U-Boot. Note that SPL is
773 not relocatable so must be loaded to the correct address in SRAM, or written
774 to run from the correct address if direct flash execution is possible (e.g.
777 SPL can access binman symbols at runtime. See:
779 'Access to binman entry offsets at run time (symbols)'
781 in the binman README for more information.
783 The ELF file 'spl/u-boot-spl' must also be available for this to work, since
784 binman uses that to look up symbols to write into the SPL binary.
788 Entry: u-boot-spl-bss-pad: U-Boot SPL binary padded with a BSS region
789 ---------------------------------------------------------------------
791 Properties / Entry arguments:
794 This is similar to u_boot_spl except that padding is added after the SPL
795 binary to cover the BSS (Block Started by Symbol) region. This region holds
796 the various used by SPL. It is set to 0 by SPL when it starts up. If you
797 want to append data to the SPL image (such as a device tree file), you must
798 pad out the BSS region to avoid the data overlapping with U-Boot variables.
799 This entry is useful in that case. It automatically pads out the entry size
800 to cover both the code, data and BSS.
802 The ELF file 'spl/u-boot-spl' must also be available for this to work, since
803 binman uses that to look up the BSS address.
807 Entry: u-boot-spl-dtb: U-Boot SPL device tree
808 ---------------------------------------------
810 Properties / Entry arguments:
811 - filename: Filename of u-boot.dtb (default 'spl/u-boot-spl.dtb')
813 This is the SPL device tree, containing configuration information for
814 SPL. SPL needs this to know what devices are present and which drivers
819 Entry: u-boot-spl-elf: U-Boot SPL ELF image
820 -------------------------------------------
822 Properties / Entry arguments:
823 - filename: Filename of SPL u-boot (default 'spl/u-boot-spl')
825 This is the U-Boot SPL ELF image. It does not include a device tree but can
826 be relocated to any address for execution.
830 Entry: u-boot-spl-nodtb: SPL binary without device tree appended
831 ----------------------------------------------------------------
833 Properties / Entry arguments:
834 - filename: Filename of spl/u-boot-spl-nodtb.bin (default
835 'spl/u-boot-spl-nodtb.bin')
837 This is the U-Boot SPL binary, It does not include a device tree blob at
838 the end of it so may not be able to work without it, assuming SPL needs
839 a device tree to operation on your platform. You can add a u_boot_spl_dtb
840 entry after this one, or use a u_boot_spl entry instead (which contains
841 both SPL and the device tree).
845 Entry: u-boot-spl-with-ucode-ptr: U-Boot SPL with embedded microcode pointer
846 ----------------------------------------------------------------------------
848 This is used when SPL must set up the microcode for U-Boot.
850 See Entry_u_boot_ucode for full details of the entries involved in this
855 Entry: u-boot-tpl: U-Boot TPL binary
856 ------------------------------------
858 Properties / Entry arguments:
859 - filename: Filename of u-boot-tpl.bin (default 'tpl/u-boot-tpl.bin')
861 This is the U-Boot TPL (Tertiary Program Loader) binary. This is a small
862 binary which loads before SPL, typically into on-chip SRAM. It is
863 responsible for locating, loading and jumping to SPL, the next-stage
864 loader. Note that SPL is not relocatable so must be loaded to the correct
865 address in SRAM, or written to run from the correct address if direct
866 flash execution is possible (e.g. on x86 devices).
868 SPL can access binman symbols at runtime. See:
870 'Access to binman entry offsets at run time (symbols)'
872 in the binman README for more information.
874 The ELF file 'tpl/u-boot-tpl' must also be available for this to work, since
875 binman uses that to look up symbols to write into the TPL binary.
879 Entry: u-boot-tpl-dtb: U-Boot TPL device tree
880 ---------------------------------------------
882 Properties / Entry arguments:
883 - filename: Filename of u-boot.dtb (default 'tpl/u-boot-tpl.dtb')
885 This is the TPL device tree, containing configuration information for
886 TPL. TPL needs this to know what devices are present and which drivers
891 Entry: u-boot-tpl-dtb-with-ucode: U-Boot TPL with embedded microcode pointer
892 ----------------------------------------------------------------------------
894 This is used when TPL must set up the microcode for U-Boot.
896 See Entry_u_boot_ucode for full details of the entries involved in this
901 Entry: u-boot-tpl-elf: U-Boot TPL ELF image
902 -------------------------------------------
904 Properties / Entry arguments:
905 - filename: Filename of TPL u-boot (default 'tpl/u-boot-tpl')
907 This is the U-Boot TPL ELF image. It does not include a device tree but can
908 be relocated to any address for execution.
912 Entry: u-boot-tpl-with-ucode-ptr: U-Boot TPL with embedded microcode pointer
913 ----------------------------------------------------------------------------
915 See Entry_u_boot_ucode for full details of the entries involved in this
920 Entry: u-boot-ucode: U-Boot microcode block
921 -------------------------------------------
923 Properties / Entry arguments:
926 The contents of this entry are filled in automatically by other entries
927 which must also be in the image.
929 U-Boot on x86 needs a single block of microcode. This is collected from
930 the various microcode update nodes in the device tree. It is also unable
931 to read the microcode from the device tree on platforms that use FSP
932 (Firmware Support Package) binaries, because the API requires that the
933 microcode is supplied before there is any SRAM available to use (i.e.
934 the FSP sets up the SRAM / cache-as-RAM but does so in the call that
935 requires the microcode!). To keep things simple, all x86 platforms handle
936 microcode the same way in U-Boot (even non-FSP platforms). This is that
937 a table is placed at _dt_ucode_base_size containing the base address and
938 size of the microcode. This is either passed to the FSP (for FSP
939 platforms), or used to set up the microcode (for non-FSP platforms).
940 This all happens in the build system since it is the only way to get
941 the microcode into a single blob and accessible without SRAM.
943 There are two cases to handle. If there is only one microcode blob in
944 the device tree, then the ucode pointer it set to point to that. This
945 entry (u-boot-ucode) is empty. If there is more than one update, then
946 this entry holds the concatenation of all updates, and the device tree
947 entry (u-boot-dtb-with-ucode) is updated to remove the microcode. This
948 last step ensures that that the microcode appears in one contiguous
949 block in the image and is not unnecessarily duplicated in the device
950 tree. It is referred to as 'collation' here.
952 Entry types that have a part to play in handling microcode:
954 Entry_u_boot_with_ucode_ptr:
955 Contains u-boot-nodtb.bin (i.e. U-Boot without the device tree).
956 It updates it with the address and size of the microcode so that
957 U-Boot can find it early on start-up.
958 Entry_u_boot_dtb_with_ucode:
959 Contains u-boot.dtb. It stores the microcode in a
960 'self.ucode_data' property, which is then read by this class to
961 obtain the microcode if needed. If collation is performed, it
962 removes the microcode from the device tree.
964 This class. If collation is enabled it reads the microcode from
965 the Entry_u_boot_dtb_with_ucode entry, and uses it as the
966 contents of this entry.
970 Entry: u-boot-with-ucode-ptr: U-Boot with embedded microcode pointer
971 --------------------------------------------------------------------
973 Properties / Entry arguments:
974 - filename: Filename of u-boot-nodtb.bin (default 'u-boot-nodtb.bin')
975 - optional-ucode: boolean property to make microcode optional. If the
976 u-boot.bin image does not include microcode, no error will
979 See Entry_u_boot_ucode for full details of the three entries involved in
980 this process. This entry updates U-Boot with the offset and size of the
981 microcode, to allow early x86 boot code to find it without doing anything
982 complicated. Otherwise it is the same as the u_boot entry.
986 Entry: vblock: An entry which contains a Chromium OS verified boot block
987 ------------------------------------------------------------------------
989 Properties / Entry arguments:
990 - content: List of phandles to entries to sign
991 - keydir: Directory containing the public keys to use
992 - keyblock: Name of the key file to use (inside keydir)
993 - signprivate: Name of provide key file to use (inside keydir)
994 - version: Version number of the vblock (typically 1)
995 - kernelkey: Name of the kernel key to use (inside keydir)
996 - preamble-flags: Value of the vboot preamble flags (typically 0)
999 - input.<unique_name> - input file passed to futility
1000 - vblock.<unique_name> - output file generated by futility (which is
1001 used as the entry contents)
1003 Chromium OS signs the read-write firmware and kernel, writing the signature
1004 in this block. This allows U-Boot to verify that the next firmware stage
1005 and kernel are genuine.
1009 Entry: x86-reset16: x86 16-bit reset code for U-Boot
1010 ----------------------------------------------------
1012 Properties / Entry arguments:
1013 - filename: Filename of u-boot-x86-reset16.bin (default
1014 'u-boot-x86-reset16.bin')
1016 x86 CPUs start up in 16-bit mode, even if they are 32-bit CPUs. This code
1017 must be placed at a particular address. This entry holds that code. It is
1018 typically placed at offset CONFIG_RESET_VEC_LOC. The code is responsible
1019 for jumping to the x86-start16 code, which continues execution.
1021 For 64-bit U-Boot, the 'x86_reset16_spl' entry type is used instead.
1025 Entry: x86-reset16-spl: x86 16-bit reset code for U-Boot
1026 --------------------------------------------------------
1028 Properties / Entry arguments:
1029 - filename: Filename of u-boot-x86-reset16.bin (default
1030 'u-boot-x86-reset16.bin')
1032 x86 CPUs start up in 16-bit mode, even if they are 32-bit CPUs. This code
1033 must be placed at a particular address. This entry holds that code. It is
1034 typically placed at offset CONFIG_RESET_VEC_LOC. The code is responsible
1035 for jumping to the x86-start16 code, which continues execution.
1037 For 32-bit U-Boot, the 'x86_reset_spl' entry type is used instead.
1041 Entry: x86-reset16-tpl: x86 16-bit reset code for U-Boot
1042 --------------------------------------------------------
1044 Properties / Entry arguments:
1045 - filename: Filename of u-boot-x86-reset16.bin (default
1046 'u-boot-x86-reset16.bin')
1048 x86 CPUs start up in 16-bit mode, even if they are 32-bit CPUs. This code
1049 must be placed at a particular address. This entry holds that code. It is
1050 typically placed at offset CONFIG_RESET_VEC_LOC. The code is responsible
1051 for jumping to the x86-start16 code, which continues execution.
1053 For 32-bit U-Boot, the 'x86_reset_tpl' entry type is used instead.
1057 Entry: x86-start16: x86 16-bit start-up code for U-Boot
1058 -------------------------------------------------------
1060 Properties / Entry arguments:
1061 - filename: Filename of u-boot-x86-start16.bin (default
1062 'u-boot-x86-start16.bin')
1064 x86 CPUs start up in 16-bit mode, even if they are 32-bit CPUs. This code
1065 must be placed in the top 64KB of the ROM. The reset code jumps to it. This
1066 entry holds that code. It is typically placed at offset
1067 CONFIG_SYS_X86_START16. The code is responsible for changing to 32-bit mode
1068 and jumping to U-Boot's entry point, which requires 32-bit mode (for 32-bit
1071 For 64-bit U-Boot, the 'x86_start16_spl' entry type is used instead.
1075 Entry: x86-start16-spl: x86 16-bit start-up code for SPL
1076 --------------------------------------------------------
1078 Properties / Entry arguments:
1079 - filename: Filename of spl/u-boot-x86-start16-spl.bin (default
1080 'spl/u-boot-x86-start16-spl.bin')
1082 x86 CPUs start up in 16-bit mode, even if they are 32-bit CPUs. This code
1083 must be placed in the top 64KB of the ROM. The reset code jumps to it. This
1084 entry holds that code. It is typically placed at offset
1085 CONFIG_SYS_X86_START16. The code is responsible for changing to 32-bit mode
1086 and jumping to U-Boot's entry point, which requires 32-bit mode (for 32-bit
1089 For 32-bit U-Boot, the 'x86-start16' entry type is used instead.
1093 Entry: x86-start16-tpl: x86 16-bit start-up code for TPL
1094 --------------------------------------------------------
1096 Properties / Entry arguments:
1097 - filename: Filename of tpl/u-boot-x86-start16-tpl.bin (default
1098 'tpl/u-boot-x86-start16-tpl.bin')
1100 x86 CPUs start up in 16-bit mode, even if they are 32-bit CPUs. This code
1101 must be placed in the top 64KB of the ROM. The reset code jumps to it. This
1102 entry holds that code. It is typically placed at offset
1103 CONFIG_SYS_X86_START16. The code is responsible for changing to 32-bit mode
1104 and jumping to U-Boot's entry point, which requires 32-bit mode (for 32-bit
1107 If TPL is not being used, the 'x86-start16-spl or 'x86-start16' entry types
1108 may be used instead.