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-ext: Entry containing an externally built binary blob
46 -----------------------------------------------------------------
48 Note: This should not be used by itself. It is normally used as a parent
49 class by other entry types.
51 If the file providing this blob is missing, binman can optionally ignore it
52 and produce a broken image with a warning.
54 See 'blob' for Properties / Entry arguments.
58 Entry: blob-named-by-arg: A blob entry which gets its filename property from its subclass
59 -----------------------------------------------------------------------------------------
61 Properties / Entry arguments:
62 - <xxx>-path: Filename containing the contents of this entry (optional,
65 where <xxx> is the blob_fname argument to the constructor.
67 This entry cannot be used directly. Instead, it is used as a parent class
68 for another entry, which defined blob_fname. This parameter is used to
69 set the entry-arg or property containing the filename. The entry-arg or
70 property is in turn used to set the actual filename.
72 See cros_ec_rw for an example of this.
76 Entry: cbfs: Entry containing a Coreboot Filesystem (CBFS)
77 ----------------------------------------------------------
79 A CBFS provides a way to group files into a group. It has a simple directory
80 structure and allows the position of individual files to be set, since it is
81 designed to support execute-in-place in an x86 SPI-flash device. Where XIP
82 is not used, it supports compression and storing ELF files.
84 CBFS is used by coreboot as its way of orgnanising SPI-flash contents.
86 The contents of the CBFS are defined by subnodes of the cbfs entry, e.g.:
98 This creates a CBFS 1MB in size two files in it: u-boot.bin and u-boot.dtb.
99 Note that the size is required since binman does not support calculating it.
100 The contents of each entry is just what binman would normally provide if it
101 were not a CBFS node. A blob type can be used to import arbitrary files as
102 with the second subnode below:
113 filename = "u-boot.dtb";
115 cbfs-compress = "lz4";
116 cbfs-offset = <0x100000>;
120 This creates a CBFS 1MB in size with u-boot.bin (named "BOOT") and
121 u-boot.dtb (named "dtb") and compressed with the lz4 algorithm.
124 Properties supported in the top-level CBFS node:
127 Defaults to "x86", but you can specify the architecture if needed.
130 Properties supported in the CBFS entry subnodes:
133 This is the name of the file created in CBFS. It defaults to the entry
134 name (which is the node name), but you can override it with this
138 This is the CBFS file type. The following are supported:
141 This is a 'raw' file, although compression is supported. It can be
142 used to store any file in CBFS.
145 This is an ELF file that has been loaded (i.e. mapped to memory), so
146 appears in the CBFS as a flat binary. The input file must be an ELF
147 image, for example this puts "u-boot" (the ELF image) into a 'stage'
158 You can use your own ELF file with something like:
164 filename = "cbfs-stage.elf";
169 As mentioned, the file is converted to a flat binary, so it is
170 equivalent to adding "u-boot.bin", for example, but with the load and
171 start addresses specified by the ELF. At present there is no option
172 to add a flat binary with a load/start address, similar to the
173 'add-flat-binary' option in cbfstool.
176 This is the offset of the file's data within the CBFS. It is used to
177 specify where the file should be placed in cases where a fixed position
178 is needed. Typical uses are for code which is not relocatable and must
179 execute in-place from a particular address. This works because SPI flash
180 is generally mapped into memory on x86 devices. The file header is
181 placed before this offset so that the data start lines up exactly with
182 the chosen offset. If this property is not provided, then the file is
183 placed in the next available spot.
185 The current implementation supports only a subset of CBFS features. It does
186 not support other file types (e.g. payload), adding multiple files (like the
187 'files' entry with a pattern supported by binman), putting files at a
188 particular offset in the CBFS and a few other things.
190 Of course binman can create images containing multiple CBFSs, simply by
191 defining these in the binman config:
218 filename = "image.jpg";
223 This creates an 8MB image with two CBFSs, one at offset 1MB, one at 7MB,
228 Entry: cros-ec-rw: A blob entry which contains a Chromium OS read-write EC image
229 --------------------------------------------------------------------------------
231 Properties / Entry arguments:
232 - cros-ec-rw-path: Filename containing the EC image
234 This entry holds a Chromium OS EC (embedded controller) image, for use in
235 updating the EC on startup via software sync.
239 Entry: fdtmap: An entry which contains an FDT map
240 -------------------------------------------------
242 Properties / Entry arguments:
245 An FDT map is just a header followed by an FDT containing a list of all the
246 entries in the image. The root node corresponds to the image node in the
247 original FDT, and an image-name property indicates the image name in that
250 The header is the string _FDTMAP_ followed by 8 unused bytes.
252 When used, this entry will be populated with an FDT map which reflects the
253 entries in the current image. Hierarchy is preserved, and all offsets and
256 Note that the -u option must be provided to ensure that binman updates the
257 FDT with the position of each entry.
259 Example output for a simple image with U-Boot and an FDT map:
262 image-name = "binman";
264 image-pos = <0x00000000>;
265 offset = <0x00000000>;
268 image-pos = <0x00000000>;
269 offset = <0x00000000>;
273 image-pos = <0x00000004>;
274 offset = <0x00000004>;
278 If allow-repack is used then 'orig-offset' and 'orig-size' properties are
279 added as necessary. See the binman README.
283 Entry: files: Entry containing a set of files
284 ---------------------------------------------
286 Properties / Entry arguments:
287 - pattern: Filename pattern to match the files to include
288 - compress: Compression algorithm to use:
290 lz4: Use lz4 compression (via 'lz4' command-line utility)
292 This entry reads a number of files and places each in a separate sub-entry
293 within this entry. To access these you need to enable device-tree updates
294 at run-time so you can obtain the file positions.
298 Entry: fill: An entry which is filled to a particular byte value
299 ----------------------------------------------------------------
301 Properties / Entry arguments:
302 - fill-byte: Byte to use to fill the entry
304 Note that the size property must be set since otherwise this entry does not
305 know how large it should be.
307 You can often achieve the same effect using the pad-byte property of the
308 overall image, in that the space between entries will then be padded with
309 that byte. But this entry is sometimes useful for explicitly setting the
310 byte value of a region.
314 Entry: fit: Entry containing a FIT
315 ----------------------------------
317 This calls mkimage to create a FIT (U-Boot Flat Image Tree) based on the
320 Nodes for the FIT should be written out in the binman configuration just as
321 they would be in a file passed to mkimage.
323 For example, this creates an image containing a FIT with U-Boot SPL:
327 description = "Test FIT";
335 compression = "none";
347 fit,external-offset: Indicates that the contents of the FIT are external
348 and provides the external offset. This is passsed to mkimage via
354 Entry: fmap: An entry which contains an Fmap section
355 ----------------------------------------------------
357 Properties / Entry arguments:
360 FMAP is a simple format used by flashrom, an open-source utility for
361 reading and writing the SPI flash, typically on x86 CPUs. The format
362 provides flashrom with a list of areas, so it knows what it in the flash.
363 It can then read or write just a single area, instead of the whole flash.
365 The format is defined by the flashrom project, in the file lib/fmap.h -
366 see www.flashrom.org/Flashrom for more information.
368 When used, this entry will be populated with an FMAP which reflects the
369 entries in the current image. Note that any hierarchy is squashed, since
370 FMAP does not support this. Also, CBFS entries appear as a single entry -
371 the sub-entries are ignored.
375 Entry: gbb: An entry which contains a Chromium OS Google Binary Block
376 ---------------------------------------------------------------------
378 Properties / Entry arguments:
379 - hardware-id: Hardware ID to use for this build (a string)
380 - keydir: Directory containing the public keys to use
381 - bmpblk: Filename containing images used by recovery
383 Chromium OS uses a GBB to store various pieces of information, in particular
384 the root and recovery keys that are used to verify the boot process. Some
385 more details are here:
387 https://www.chromium.org/chromium-os/firmware-porting-guide/2-concepts
389 but note that the page dates from 2013 so is quite out of date. See
390 README.chromium for how to obtain the required keys and tools.
394 Entry: image-header: An entry which contains a pointer to the FDT map
395 ---------------------------------------------------------------------
397 Properties / Entry arguments:
398 location: Location of header ("start" or "end" of image). This is
399 optional. If omitted then the entry must have an offset property.
401 This adds an 8-byte entry to the start or end of the image, pointing to the
402 location of the FDT map. The format is a magic number followed by an offset
403 from the start or end of the image, in twos-compliment format.
405 This entry must be in the top-level part of the image.
407 NOTE: If the location is at the start/end, you will probably need to specify
408 sort-by-offset for the image, unless you actually put the image header
409 first/last in the entry list.
413 Entry: intel-cmc: Entry containing an Intel Chipset Micro Code (CMC) file
414 -------------------------------------------------------------------------
416 Properties / Entry arguments:
417 - filename: Filename of file to read into entry
419 This file contains microcode for some devices in a special format. An
420 example filename is 'Microcode/C0_22211.BIN'.
422 See README.x86 for information about x86 binary blobs.
426 Entry: intel-descriptor: Intel flash descriptor block (4KB)
427 -----------------------------------------------------------
429 Properties / Entry arguments:
430 filename: Filename of file containing the descriptor. This is typically
431 a 4KB binary file, sometimes called 'descriptor.bin'
433 This entry is placed at the start of flash and provides information about
434 the SPI flash regions. In particular it provides the base address and
435 size of the ME (Management Engine) region, allowing us to place the ME
436 binary in the right place.
438 With this entry in your image, the position of the 'intel-me' entry will be
439 fixed in the image, which avoids you needed to specify an offset for that
440 region. This is useful, because it is not possible to change the position
441 of the ME region without updating the descriptor.
443 See README.x86 for information about x86 binary blobs.
447 Entry: intel-fit: Intel Firmware Image Table (FIT)
448 --------------------------------------------------
450 This entry contains a dummy FIT as required by recent Intel CPUs. The FIT
451 contains information about the firmware and microcode available in the
454 At present binman only supports a basic FIT with no microcode.
458 Entry: intel-fit-ptr: Intel Firmware Image Table (FIT) pointer
459 --------------------------------------------------------------
461 This entry contains a pointer to the FIT. It is required to be at address
462 0xffffffc0 in the image.
466 Entry: intel-fsp: Entry containing an Intel Firmware Support Package (FSP) file
467 -------------------------------------------------------------------------------
469 Properties / Entry arguments:
470 - filename: Filename of file to read into entry
472 This file contains binary blobs which are used on some devices to make the
473 platform work. U-Boot executes this code since it is not possible to set up
474 the hardware using U-Boot open-source code. Documentation is typically not
475 available in sufficient detail to allow this.
477 An example filename is 'FSP/QUEENSBAY_FSP_GOLD_001_20-DECEMBER-2013.fd'
479 See README.x86 for information about x86 binary blobs.
483 Entry: intel-fsp-m: Entry containing Intel Firmware Support Package (FSP) memory init
484 -------------------------------------------------------------------------------------
486 Properties / Entry arguments:
487 - filename: Filename of file to read into entry
489 This file contains a binary blob which is used on some devices to set up
490 SDRAM. U-Boot executes this code in SPL so that it can make full use of
491 memory. Documentation is typically not available in sufficient detail to
492 allow U-Boot do this this itself..
494 An example filename is 'fsp_m.bin'
496 See README.x86 for information about x86 binary blobs.
500 Entry: intel-fsp-s: Entry containing Intel Firmware Support Package (FSP) silicon init
501 --------------------------------------------------------------------------------------
503 Properties / Entry arguments:
504 - filename: Filename of file to read into entry
506 This file contains a binary blob which is used on some devices to set up
507 the silicon. U-Boot executes this code in U-Boot proper after SDRAM is
508 running, so that it can make full use of memory. Documentation is typically
509 not available in sufficient detail to allow U-Boot do this this itself.
511 An example filename is 'fsp_s.bin'
513 See README.x86 for information about x86 binary blobs.
517 Entry: intel-fsp-t: Entry containing Intel Firmware Support Package (FSP) temp ram init
518 ---------------------------------------------------------------------------------------
520 Properties / Entry arguments:
521 - filename: Filename of file to read into entry
523 This file contains a binary blob which is used on some devices to set up
524 temporary memory (Cache-as-RAM or CAR). U-Boot executes this code in TPL so
525 that it has access to memory for its stack and initial storage.
527 An example filename is 'fsp_t.bin'
529 See README.x86 for information about x86 binary blobs.
533 Entry: intel-ifwi: Entry containing an Intel Integrated Firmware Image (IFWI) file
534 ----------------------------------------------------------------------------------
536 Properties / Entry arguments:
537 - filename: Filename of file to read into entry. This is either the
538 IFWI file itself, or a file that can be converted into one using a
540 - convert-fit: If present this indicates that the ifwitool should be
541 used to convert the provided file into a IFWI.
543 This file contains code and data used by the SoC that is required to make
544 it work. It includes U-Boot TPL, microcode, things related to the CSE
545 (Converged Security Engine, the microcontroller that loads all the firmware)
546 and other items beyond the wit of man.
548 A typical filename is 'ifwi.bin' for an IFWI file, or 'fitimage.bin' for a
549 file that will be converted to an IFWI.
551 The position of this entry is generally set by the intel-descriptor entry.
553 The contents of the IFWI are specified by the subnodes of the IFWI node.
554 Each subnode describes an entry which is placed into the IFWFI with a given
555 sub-partition (and optional entry name).
557 Properties for subnodes:
558 ifwi-subpart - sub-parition to put this entry into, e.g. "IBBP"
559 ifwi-entry - entry name t use, e.g. "IBBL"
560 ifwi-replace - if present, indicates that the item should be replaced
561 in the IFWI. Otherwise it is added.
563 See README.x86 for information about x86 binary blobs.
567 Entry: intel-me: Entry containing an Intel Management Engine (ME) file
568 ----------------------------------------------------------------------
570 Properties / Entry arguments:
571 - filename: Filename of file to read into entry
573 This file contains code used by the SoC that is required to make it work.
574 The Management Engine is like a background task that runs things that are
575 not clearly documented, but may include keyboard, display and network
576 access. For platform that use ME it is not possible to disable it. U-Boot
577 does not directly execute code in the ME binary.
579 A typical filename is 'me.bin'.
581 The position of this entry is generally set by the intel-descriptor entry.
583 See README.x86 for information about x86 binary blobs.
587 Entry: intel-mrc: Entry containing an Intel Memory Reference Code (MRC) file
588 ----------------------------------------------------------------------------
590 Properties / Entry arguments:
591 - filename: Filename of file to read into entry
593 This file contains code for setting up the SDRAM on some Intel systems. This
594 is executed by U-Boot when needed early during startup. A typical filename
597 See README.x86 for information about x86 binary blobs.
601 Entry: intel-refcode: Entry containing an Intel Reference Code file
602 -------------------------------------------------------------------
604 Properties / Entry arguments:
605 - filename: Filename of file to read into entry
607 This file contains code for setting up the platform on some Intel systems.
608 This is executed by U-Boot when needed early during startup. A typical
609 filename is 'refcode.bin'.
611 See README.x86 for information about x86 binary blobs.
615 Entry: intel-vbt: Entry containing an Intel Video BIOS Table (VBT) file
616 -----------------------------------------------------------------------
618 Properties / Entry arguments:
619 - filename: Filename of file to read into entry
621 This file contains code that sets up the integrated graphics subsystem on
622 some Intel SoCs. U-Boot executes this when the display is started up.
624 See README.x86 for information about Intel binary blobs.
628 Entry: intel-vga: Entry containing an Intel Video Graphics Adaptor (VGA) file
629 -----------------------------------------------------------------------------
631 Properties / Entry arguments:
632 - filename: Filename of file to read into entry
634 This file contains code that sets up the integrated graphics subsystem on
635 some Intel SoCs. U-Boot executes this when the display is started up.
637 This is similar to the VBT file but in a different format.
639 See README.x86 for information about Intel binary blobs.
643 Entry: mkimage: Entry containing a binary produced by mkimage
644 -------------------------------------------------------------
646 Properties / Entry arguments:
647 - datafile: Filename for -d argument
648 - args: Other arguments to pass
650 The data passed to mkimage is collected from subnodes of the mkimage node,
654 args = "-n test -T imximage";
660 This calls mkimage to create an imximage with u-boot-spl.bin as the input
661 file. The output from mkimage then becomes part of the image produced by
666 Entry: powerpc-mpc85xx-bootpg-resetvec: PowerPC mpc85xx bootpg + resetvec code for U-Boot
667 -----------------------------------------------------------------------------------------
669 Properties / Entry arguments:
670 - filename: Filename of u-boot-br.bin (default 'u-boot-br.bin')
672 This entry is valid for PowerPC mpc85xx cpus. This entry holds
673 'bootpg + resetvec' code for PowerPC mpc85xx CPUs which needs to be
674 placed at offset 'RESET_VECTOR_ADDRESS - 0xffc'.
678 Entry: section: Entry that contains other entries
679 -------------------------------------------------
681 Properties / Entry arguments: (see binman README for more information)
682 pad-byte: Pad byte to use when padding
683 sort-by-offset: True if entries should be sorted by offset, False if
684 they must be in-order in the device tree description
685 end-at-4gb: Used to build an x86 ROM which ends at 4GB (2^32)
686 skip-at-start: Number of bytes before the first entry starts. These
687 effectively adjust the starting offset of entries. For example,
688 if this is 16, then the first entry would start at 16. An entry
689 with offset = 20 would in fact be written at offset 4 in the image
690 file, since the first 16 bytes are skipped when writing.
691 name-prefix: Adds a prefix to the name of every entry in the section
692 when writing out the map
694 Since a section is also an entry, it inherits all the properies of entries
697 A section is an entry which can contain other entries, thus allowing
698 hierarchical images to be created. See 'Sections and hierarchical images'
699 in the binman README for more information.
703 Entry: text: An entry which contains text
704 -----------------------------------------
706 The text can be provided either in the node itself or by a command-line
707 argument. There is a level of indirection to allow multiple text strings
710 Properties / Entry arguments:
711 text-label: The value of this string indicates the property / entry-arg
712 that contains the string to place in the entry
713 <xxx> (actual name is the value of text-label): contains the string to
715 <text>: The text to place in the entry (overrides the above mechanism).
716 This is useful when the text is constant.
722 text-label = "message";
727 binman -amessage="this is my message"
729 and binman will insert that string into the entry.
731 It is also possible to put the string directly in the node:
735 text-label = "message";
736 message = "a message directly in the node"
743 text = "some text directly in the node"
746 The text is not itself nul-terminated. This can be achieved, if required,
747 by setting the size of the entry to something larger than the text.
751 Entry: u-boot: U-Boot flat binary
752 ---------------------------------
754 Properties / Entry arguments:
755 - filename: Filename of u-boot.bin (default 'u-boot.bin')
757 This is the U-Boot binary, containing relocation information to allow it
758 to relocate itself at runtime. The binary typically includes a device tree
759 blob at the end of it. Use u_boot_nodtb if you want to package the device
762 U-Boot can access binman symbols at runtime. See:
764 'Access to binman entry offsets at run time (fdt)'
766 in the binman README for more information.
770 Entry: u-boot-dtb: U-Boot device tree
771 -------------------------------------
773 Properties / Entry arguments:
774 - filename: Filename of u-boot.dtb (default 'u-boot.dtb')
776 This is the U-Boot device tree, containing configuration information for
777 U-Boot. U-Boot needs this to know what devices are present and which drivers
780 Note: This is mostly an internal entry type, used by others. This allows
781 binman to know which entries contain a device tree.
785 Entry: u-boot-dtb-with-ucode: A U-Boot device tree file, with the microcode removed
786 -----------------------------------------------------------------------------------
788 Properties / Entry arguments:
789 - filename: Filename of u-boot.dtb (default 'u-boot.dtb')
791 See Entry_u_boot_ucode for full details of the three entries involved in
792 this process. This entry provides the U-Boot device-tree file, which
793 contains the microcode. If the microcode is not being collated into one
794 place then the offset and size of the microcode is recorded by this entry,
795 for use by u_boot_with_ucode_ptr. If it is being collated, then this
796 entry deletes the microcode from the device tree (to save space) and makes
797 it available to u_boot_ucode.
801 Entry: u-boot-elf: U-Boot ELF image
802 -----------------------------------
804 Properties / Entry arguments:
805 - filename: Filename of u-boot (default 'u-boot')
807 This is the U-Boot ELF image. It does not include a device tree but can be
808 relocated to any address for execution.
812 Entry: u-boot-img: U-Boot legacy image
813 --------------------------------------
815 Properties / Entry arguments:
816 - filename: Filename of u-boot.img (default 'u-boot.img')
818 This is the U-Boot binary as a packaged image, in legacy format. It has a
819 header which allows it to be loaded at the correct address for execution.
821 You should use FIT (Flat Image Tree) instead of the legacy image for new
826 Entry: u-boot-nodtb: U-Boot flat binary without device tree appended
827 --------------------------------------------------------------------
829 Properties / Entry arguments:
830 - filename: Filename of u-boot.bin (default 'u-boot-nodtb.bin')
832 This is the U-Boot binary, containing relocation information to allow it
833 to relocate itself at runtime. It does not include a device tree blob at
834 the end of it so normally cannot work without it. You can add a u_boot_dtb
835 entry after this one, or use a u_boot entry instead (which contains both
836 U-Boot and the device tree).
840 Entry: u-boot-spl: U-Boot SPL binary
841 ------------------------------------
843 Properties / Entry arguments:
844 - filename: Filename of u-boot-spl.bin (default 'spl/u-boot-spl.bin')
846 This is the U-Boot SPL (Secondary Program Loader) binary. This is a small
847 binary which loads before U-Boot proper, typically into on-chip SRAM. It is
848 responsible for locating, loading and jumping to U-Boot. Note that SPL is
849 not relocatable so must be loaded to the correct address in SRAM, or written
850 to run from the correct address if direct flash execution is possible (e.g.
853 SPL can access binman symbols at runtime. See:
855 'Access to binman entry offsets at run time (symbols)'
857 in the binman README for more information.
859 The ELF file 'spl/u-boot-spl' must also be available for this to work, since
860 binman uses that to look up symbols to write into the SPL binary.
864 Entry: u-boot-spl-bss-pad: U-Boot SPL binary padded with a BSS region
865 ---------------------------------------------------------------------
867 Properties / Entry arguments:
870 This is similar to u_boot_spl except that padding is added after the SPL
871 binary to cover the BSS (Block Started by Symbol) region. This region holds
872 the various used by SPL. It is set to 0 by SPL when it starts up. If you
873 want to append data to the SPL image (such as a device tree file), you must
874 pad out the BSS region to avoid the data overlapping with U-Boot variables.
875 This entry is useful in that case. It automatically pads out the entry size
876 to cover both the code, data and BSS.
878 The ELF file 'spl/u-boot-spl' must also be available for this to work, since
879 binman uses that to look up the BSS address.
883 Entry: u-boot-spl-dtb: U-Boot SPL device tree
884 ---------------------------------------------
886 Properties / Entry arguments:
887 - filename: Filename of u-boot.dtb (default 'spl/u-boot-spl.dtb')
889 This is the SPL device tree, containing configuration information for
890 SPL. SPL needs this to know what devices are present and which drivers
895 Entry: u-boot-spl-elf: U-Boot SPL ELF image
896 -------------------------------------------
898 Properties / Entry arguments:
899 - filename: Filename of SPL u-boot (default 'spl/u-boot-spl')
901 This is the U-Boot SPL ELF image. It does not include a device tree but can
902 be relocated to any address for execution.
906 Entry: u-boot-spl-nodtb: SPL binary without device tree appended
907 ----------------------------------------------------------------
909 Properties / Entry arguments:
910 - filename: Filename of spl/u-boot-spl-nodtb.bin (default
911 'spl/u-boot-spl-nodtb.bin')
913 This is the U-Boot SPL binary, It does not include a device tree blob at
914 the end of it so may not be able to work without it, assuming SPL needs
915 a device tree to operation on your platform. You can add a u_boot_spl_dtb
916 entry after this one, or use a u_boot_spl entry instead (which contains
917 both SPL and the device tree).
921 Entry: u-boot-spl-with-ucode-ptr: U-Boot SPL with embedded microcode pointer
922 ----------------------------------------------------------------------------
924 This is used when SPL must set up the microcode for U-Boot.
926 See Entry_u_boot_ucode for full details of the entries involved in this
931 Entry: u-boot-tpl: U-Boot TPL binary
932 ------------------------------------
934 Properties / Entry arguments:
935 - filename: Filename of u-boot-tpl.bin (default 'tpl/u-boot-tpl.bin')
937 This is the U-Boot TPL (Tertiary Program Loader) binary. This is a small
938 binary which loads before SPL, typically into on-chip SRAM. It is
939 responsible for locating, loading and jumping to SPL, the next-stage
940 loader. Note that SPL is not relocatable so must be loaded to the correct
941 address in SRAM, or written to run from the correct address if direct
942 flash execution is possible (e.g. on x86 devices).
944 SPL can access binman symbols at runtime. See:
946 'Access to binman entry offsets at run time (symbols)'
948 in the binman README for more information.
950 The ELF file 'tpl/u-boot-tpl' must also be available for this to work, since
951 binman uses that to look up symbols to write into the TPL binary.
955 Entry: u-boot-tpl-dtb: U-Boot TPL device tree
956 ---------------------------------------------
958 Properties / Entry arguments:
959 - filename: Filename of u-boot.dtb (default 'tpl/u-boot-tpl.dtb')
961 This is the TPL device tree, containing configuration information for
962 TPL. TPL needs this to know what devices are present and which drivers
967 Entry: u-boot-tpl-dtb-with-ucode: U-Boot TPL with embedded microcode pointer
968 ----------------------------------------------------------------------------
970 This is used when TPL must set up the microcode for U-Boot.
972 See Entry_u_boot_ucode for full details of the entries involved in this
977 Entry: u-boot-tpl-elf: U-Boot TPL ELF image
978 -------------------------------------------
980 Properties / Entry arguments:
981 - filename: Filename of TPL u-boot (default 'tpl/u-boot-tpl')
983 This is the U-Boot TPL ELF image. It does not include a device tree but can
984 be relocated to any address for execution.
988 Entry: u-boot-tpl-with-ucode-ptr: U-Boot TPL with embedded microcode pointer
989 ----------------------------------------------------------------------------
991 See Entry_u_boot_ucode for full details of the entries involved in this
996 Entry: u-boot-ucode: U-Boot microcode block
997 -------------------------------------------
999 Properties / Entry arguments:
1002 The contents of this entry are filled in automatically by other entries
1003 which must also be in the image.
1005 U-Boot on x86 needs a single block of microcode. This is collected from
1006 the various microcode update nodes in the device tree. It is also unable
1007 to read the microcode from the device tree on platforms that use FSP
1008 (Firmware Support Package) binaries, because the API requires that the
1009 microcode is supplied before there is any SRAM available to use (i.e.
1010 the FSP sets up the SRAM / cache-as-RAM but does so in the call that
1011 requires the microcode!). To keep things simple, all x86 platforms handle
1012 microcode the same way in U-Boot (even non-FSP platforms). This is that
1013 a table is placed at _dt_ucode_base_size containing the base address and
1014 size of the microcode. This is either passed to the FSP (for FSP
1015 platforms), or used to set up the microcode (for non-FSP platforms).
1016 This all happens in the build system since it is the only way to get
1017 the microcode into a single blob and accessible without SRAM.
1019 There are two cases to handle. If there is only one microcode blob in
1020 the device tree, then the ucode pointer it set to point to that. This
1021 entry (u-boot-ucode) is empty. If there is more than one update, then
1022 this entry holds the concatenation of all updates, and the device tree
1023 entry (u-boot-dtb-with-ucode) is updated to remove the microcode. This
1024 last step ensures that that the microcode appears in one contiguous
1025 block in the image and is not unnecessarily duplicated in the device
1026 tree. It is referred to as 'collation' here.
1028 Entry types that have a part to play in handling microcode:
1030 Entry_u_boot_with_ucode_ptr:
1031 Contains u-boot-nodtb.bin (i.e. U-Boot without the device tree).
1032 It updates it with the address and size of the microcode so that
1033 U-Boot can find it early on start-up.
1034 Entry_u_boot_dtb_with_ucode:
1035 Contains u-boot.dtb. It stores the microcode in a
1036 'self.ucode_data' property, which is then read by this class to
1037 obtain the microcode if needed. If collation is performed, it
1038 removes the microcode from the device tree.
1040 This class. If collation is enabled it reads the microcode from
1041 the Entry_u_boot_dtb_with_ucode entry, and uses it as the
1042 contents of this entry.
1046 Entry: u-boot-with-ucode-ptr: U-Boot with embedded microcode pointer
1047 --------------------------------------------------------------------
1049 Properties / Entry arguments:
1050 - filename: Filename of u-boot-nodtb.bin (default 'u-boot-nodtb.bin')
1051 - optional-ucode: boolean property to make microcode optional. If the
1052 u-boot.bin image does not include microcode, no error will
1055 See Entry_u_boot_ucode for full details of the three entries involved in
1056 this process. This entry updates U-Boot with the offset and size of the
1057 microcode, to allow early x86 boot code to find it without doing anything
1058 complicated. Otherwise it is the same as the u_boot entry.
1062 Entry: vblock: An entry which contains a Chromium OS verified boot block
1063 ------------------------------------------------------------------------
1065 Properties / Entry arguments:
1066 - content: List of phandles to entries to sign
1067 - keydir: Directory containing the public keys to use
1068 - keyblock: Name of the key file to use (inside keydir)
1069 - signprivate: Name of provide key file to use (inside keydir)
1070 - version: Version number of the vblock (typically 1)
1071 - kernelkey: Name of the kernel key to use (inside keydir)
1072 - preamble-flags: Value of the vboot preamble flags (typically 0)
1075 - input.<unique_name> - input file passed to futility
1076 - vblock.<unique_name> - output file generated by futility (which is
1077 used as the entry contents)
1079 Chromium OS signs the read-write firmware and kernel, writing the signature
1080 in this block. This allows U-Boot to verify that the next firmware stage
1081 and kernel are genuine.
1085 Entry: x86-reset16: x86 16-bit reset code for U-Boot
1086 ----------------------------------------------------
1088 Properties / Entry arguments:
1089 - filename: Filename of u-boot-x86-reset16.bin (default
1090 'u-boot-x86-reset16.bin')
1092 x86 CPUs start up in 16-bit mode, even if they are 32-bit CPUs. This code
1093 must be placed at a particular address. This entry holds that code. It is
1094 typically placed at offset CONFIG_RESET_VEC_LOC. The code is responsible
1095 for jumping to the x86-start16 code, which continues execution.
1097 For 64-bit U-Boot, the 'x86_reset16_spl' entry type is used instead.
1101 Entry: x86-reset16-spl: x86 16-bit reset code for U-Boot
1102 --------------------------------------------------------
1104 Properties / Entry arguments:
1105 - filename: Filename of u-boot-x86-reset16.bin (default
1106 'u-boot-x86-reset16.bin')
1108 x86 CPUs start up in 16-bit mode, even if they are 32-bit CPUs. This code
1109 must be placed at a particular address. This entry holds that code. It is
1110 typically placed at offset CONFIG_RESET_VEC_LOC. The code is responsible
1111 for jumping to the x86-start16 code, which continues execution.
1113 For 32-bit U-Boot, the 'x86_reset_spl' entry type is used instead.
1117 Entry: x86-reset16-tpl: x86 16-bit reset code for U-Boot
1118 --------------------------------------------------------
1120 Properties / Entry arguments:
1121 - filename: Filename of u-boot-x86-reset16.bin (default
1122 'u-boot-x86-reset16.bin')
1124 x86 CPUs start up in 16-bit mode, even if they are 32-bit CPUs. This code
1125 must be placed at a particular address. This entry holds that code. It is
1126 typically placed at offset CONFIG_RESET_VEC_LOC. The code is responsible
1127 for jumping to the x86-start16 code, which continues execution.
1129 For 32-bit U-Boot, the 'x86_reset_tpl' entry type is used instead.
1133 Entry: x86-start16: x86 16-bit start-up code for U-Boot
1134 -------------------------------------------------------
1136 Properties / Entry arguments:
1137 - filename: Filename of u-boot-x86-start16.bin (default
1138 'u-boot-x86-start16.bin')
1140 x86 CPUs start up in 16-bit mode, even if they are 32-bit CPUs. This code
1141 must be placed in the top 64KB of the ROM. The reset code jumps to it. This
1142 entry holds that code. It is typically placed at offset
1143 CONFIG_SYS_X86_START16. The code is responsible for changing to 32-bit mode
1144 and jumping to U-Boot's entry point, which requires 32-bit mode (for 32-bit
1147 For 64-bit U-Boot, the 'x86_start16_spl' entry type is used instead.
1151 Entry: x86-start16-spl: x86 16-bit start-up code for SPL
1152 --------------------------------------------------------
1154 Properties / Entry arguments:
1155 - filename: Filename of spl/u-boot-x86-start16-spl.bin (default
1156 'spl/u-boot-x86-start16-spl.bin')
1158 x86 CPUs start up in 16-bit mode, even if they are 32-bit CPUs. This code
1159 must be placed in the top 64KB of the ROM. The reset code jumps to it. This
1160 entry holds that code. It is typically placed at offset
1161 CONFIG_SYS_X86_START16. The code is responsible for changing to 32-bit mode
1162 and jumping to U-Boot's entry point, which requires 32-bit mode (for 32-bit
1165 For 32-bit U-Boot, the 'x86-start16' entry type is used instead.
1169 Entry: x86-start16-tpl: x86 16-bit start-up code for TPL
1170 --------------------------------------------------------
1172 Properties / Entry arguments:
1173 - filename: Filename of tpl/u-boot-x86-start16-tpl.bin (default
1174 'tpl/u-boot-x86-start16-tpl.bin')
1176 x86 CPUs start up in 16-bit mode, even if they are 32-bit CPUs. This code
1177 must be placed in the top 64KB of the ROM. The reset code jumps to it. This
1178 entry holds that code. It is typically placed at offset
1179 CONFIG_SYS_X86_START16. The code is responsible for changing to 32-bit mode
1180 and jumping to U-Boot's entry point, which requires 32-bit mode (for 32-bit
1183 If TPL is not being used, the 'x86-start16-spl or 'x86-start16' entry types
1184 may be used instead.