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: atf-bl31: ARM Trusted Firmware (ATF) BL31 blob
15 -----------------------------------------------------
17 Properties / Entry arguments:
18 - atf-bl31-path: Filename of file to read into entry. This is typically
19 called bl31.bin or bl31.elf
21 This entry holds the run-time firmware, typically started by U-Boot SPL.
22 See the U-Boot README for your architecture or board for how to use it. See
23 https://github.com/ARM-software/arm-trusted-firmware for more information
28 Entry: blob: Arbitrary binary blob
29 ----------------------------------
31 Note: This should not be used by itself. It is normally used as a parent
32 class by other entry types.
34 Properties / Entry arguments:
35 - filename: Filename of file to read into entry
36 - compress: Compression algorithm to use:
38 lz4: Use lz4 compression (via 'lz4' command-line utility)
40 This entry reads data from a file and places it in the entry. The
41 default filename is often specified specified by the subclass. See for
42 example the 'u-boot' entry which provides the filename 'u-boot.bin'.
44 If compression is enabled, an extra 'uncomp-size' property is written to
45 the node (if enabled with -u) which provides the uncompressed size of the
50 Entry: blob-dtb: A blob that holds a device tree
51 ------------------------------------------------
53 This is a blob containing a device tree. The contents of the blob are
54 obtained from the list of available device-tree files, managed by the
59 Entry: blob-ext: Externally built binary blob
60 ---------------------------------------------
62 Note: This should not be used by itself. It is normally used as a parent
63 class by other entry types.
65 If the file providing this blob is missing, binman can optionally ignore it
66 and produce a broken image with a warning.
68 See 'blob' for Properties / Entry arguments.
72 Entry: blob-named-by-arg: A blob entry which gets its filename property from its subclass
73 -----------------------------------------------------------------------------------------
75 Properties / Entry arguments:
76 - <xxx>-path: Filename containing the contents of this entry (optional,
79 where <xxx> is the blob_fname argument to the constructor.
81 This entry cannot be used directly. Instead, it is used as a parent class
82 for another entry, which defined blob_fname. This parameter is used to
83 set the entry-arg or property containing the filename. The entry-arg or
84 property is in turn used to set the actual filename.
86 See cros_ec_rw for an example of this.
90 Entry: blob-phase: Section that holds a phase binary
91 ----------------------------------------------------
93 This is a base class that should not normally be used directly. It is used
94 when converting a 'u-boot' entry automatically into a 'u-boot-expanded'
95 entry; similarly for SPL.
99 Entry: cbfs: Coreboot Filesystem (CBFS)
100 ---------------------------------------
102 A CBFS provides a way to group files into a group. It has a simple directory
103 structure and allows the position of individual files to be set, since it is
104 designed to support execute-in-place in an x86 SPI-flash device. Where XIP
105 is not used, it supports compression and storing ELF files.
107 CBFS is used by coreboot as its way of orgnanising SPI-flash contents.
109 The contents of the CBFS are defined by subnodes of the cbfs entry, e.g.::
121 This creates a CBFS 1MB in size two files in it: u-boot.bin and u-boot.dtb.
122 Note that the size is required since binman does not support calculating it.
123 The contents of each entry is just what binman would normally provide if it
124 were not a CBFS node. A blob type can be used to import arbitrary files as
125 with the second subnode below::
136 filename = "u-boot.dtb";
138 cbfs-compress = "lz4";
139 cbfs-offset = <0x100000>;
143 This creates a CBFS 1MB in size with u-boot.bin (named "BOOT") and
144 u-boot.dtb (named "dtb") and compressed with the lz4 algorithm.
147 Properties supported in the top-level CBFS node:
150 Defaults to "x86", but you can specify the architecture if needed.
153 Properties supported in the CBFS entry subnodes:
156 This is the name of the file created in CBFS. It defaults to the entry
157 name (which is the node name), but you can override it with this
161 This is the CBFS file type. The following are supported:
164 This is a 'raw' file, although compression is supported. It can be
165 used to store any file in CBFS.
168 This is an ELF file that has been loaded (i.e. mapped to memory), so
169 appears in the CBFS as a flat binary. The input file must be an ELF
170 image, for example this puts "u-boot" (the ELF image) into a 'stage'
181 You can use your own ELF file with something like::
187 filename = "cbfs-stage.elf";
192 As mentioned, the file is converted to a flat binary, so it is
193 equivalent to adding "u-boot.bin", for example, but with the load and
194 start addresses specified by the ELF. At present there is no option
195 to add a flat binary with a load/start address, similar to the
196 'add-flat-binary' option in cbfstool.
199 This is the offset of the file's data within the CBFS. It is used to
200 specify where the file should be placed in cases where a fixed position
201 is needed. Typical uses are for code which is not relocatable and must
202 execute in-place from a particular address. This works because SPI flash
203 is generally mapped into memory on x86 devices. The file header is
204 placed before this offset so that the data start lines up exactly with
205 the chosen offset. If this property is not provided, then the file is
206 placed in the next available spot.
208 The current implementation supports only a subset of CBFS features. It does
209 not support other file types (e.g. payload), adding multiple files (like the
210 'files' entry with a pattern supported by binman), putting files at a
211 particular offset in the CBFS and a few other things.
213 Of course binman can create images containing multiple CBFSs, simply by
214 defining these in the binman config::
241 filename = "image.jpg";
246 This creates an 8MB image with two CBFSs, one at offset 1MB, one at 7MB,
251 Entry: collection: An entry which contains a collection of other entries
252 ------------------------------------------------------------------------
254 Properties / Entry arguments:
255 - content: List of phandles to entries to include
257 This allows reusing the contents of other entries. The contents of the
258 listed entries are combined to form this entry. This serves as a useful
259 base class for entry types which need to process data from elsewhere in
260 the image, not necessarily child entries.
264 Entry: cros-ec-rw: A blob entry which contains a Chromium OS read-write EC image
265 --------------------------------------------------------------------------------
267 Properties / Entry arguments:
268 - cros-ec-rw-path: Filename containing the EC image
270 This entry holds a Chromium OS EC (embedded controller) image, for use in
271 updating the EC on startup via software sync.
275 Entry: fdtmap: An entry which contains an FDT map
276 -------------------------------------------------
278 Properties / Entry arguments:
281 An FDT map is just a header followed by an FDT containing a list of all the
282 entries in the image. The root node corresponds to the image node in the
283 original FDT, and an image-name property indicates the image name in that
286 The header is the string _FDTMAP_ followed by 8 unused bytes.
288 When used, this entry will be populated with an FDT map which reflects the
289 entries in the current image. Hierarchy is preserved, and all offsets and
292 Note that the -u option must be provided to ensure that binman updates the
293 FDT with the position of each entry.
295 Example output for a simple image with U-Boot and an FDT map::
298 image-name = "binman";
300 image-pos = <0x00000000>;
301 offset = <0x00000000>;
304 image-pos = <0x00000000>;
305 offset = <0x00000000>;
309 image-pos = <0x00000004>;
310 offset = <0x00000004>;
314 If allow-repack is used then 'orig-offset' and 'orig-size' properties are
315 added as necessary. See the binman README.
319 Entry: files: A set of files arranged in a section
320 --------------------------------------------------
322 Properties / Entry arguments:
323 - pattern: Filename pattern to match the files to include
324 - files-compress: Compression algorithm to use:
326 lz4: Use lz4 compression (via 'lz4' command-line utility)
327 - files-align: Align each file to the given alignment
329 This entry reads a number of files and places each in a separate sub-entry
330 within this entry. To access these you need to enable device-tree updates
331 at run-time so you can obtain the file positions.
335 Entry: fill: An entry which is filled to a particular byte value
336 ----------------------------------------------------------------
338 Properties / Entry arguments:
339 - fill-byte: Byte to use to fill the entry
341 Note that the size property must be set since otherwise this entry does not
342 know how large it should be.
344 You can often achieve the same effect using the pad-byte property of the
345 overall image, in that the space between entries will then be padded with
346 that byte. But this entry is sometimes useful for explicitly setting the
347 byte value of a region.
351 Entry: fit: Flat Image Tree (FIT)
352 ---------------------------------
354 This calls mkimage to create a FIT (U-Boot Flat Image Tree) based on the
357 Nodes for the FIT should be written out in the binman configuration just as
358 they would be in a file passed to mkimage.
360 For example, this creates an image containing a FIT with U-Boot SPL::
364 description = "Test FIT";
365 fit,fdt-list = "of-list";
373 compression = "none";
384 U-Boot supports creating fdt and config nodes automatically. To do this,
385 pass an of-list property (e.g. -a of-list=file1 file2). This tells binman
386 that you want to generates nodes for two files: file1.dtb and file2.dtb
387 The fit,fdt-list property (see above) indicates that of-list should be used.
388 If the property is missing you will get an error.
390 Then add a 'generator node', a node with a name starting with '@'::
394 description = "fdt-NAME";
396 compression = "none";
400 This tells binman to create nodes fdt-1 and fdt-2 for each of your two
401 files. All the properties you specify will be included in the node. This
402 node acts like a template to generate the nodes. The generator node itself
403 does not appear in the output - it is replaced with what binman generates.
405 You can create config nodes in a similar way::
408 default = "@config-DEFAULT-SEQ";
410 description = "NAME";
417 This tells binman to create nodes config-1 and config-2, i.e. a config for
418 each of your two files.
420 Available substitutions for '@' nodes are:
423 Sequence number of the generated fdt (1, 2, ...)
425 Name of the dtb as provided (i.e. without adding '.dtb')
427 Note that if no devicetree files are provided (with '-a of-list' as above)
428 then no nodes will be generated.
430 The 'default' property, if present, will be automatically set to the name
431 if of configuration whose devicetree matches the 'default-dt' entry
432 argument, e.g. with '-a default-dt=sun50i-a64-pine64-lts'.
434 Available substitutions for '@' property values are
437 Sequence number of the default fdt,as provided by the 'default-dt' entry
440 Properties (in the 'fit' node itself):
441 fit,external-offset: Indicates that the contents of the FIT are external
442 and provides the external offset. This is passsed to mkimage via
448 Entry: fmap: An entry which contains an Fmap section
449 ----------------------------------------------------
451 Properties / Entry arguments:
454 FMAP is a simple format used by flashrom, an open-source utility for
455 reading and writing the SPI flash, typically on x86 CPUs. The format
456 provides flashrom with a list of areas, so it knows what it in the flash.
457 It can then read or write just a single area, instead of the whole flash.
459 The format is defined by the flashrom project, in the file lib/fmap.h -
460 see www.flashrom.org/Flashrom for more information.
462 When used, this entry will be populated with an FMAP which reflects the
463 entries in the current image. Note that any hierarchy is squashed, since
464 FMAP does not support this. Also, CBFS entries appear as a single entry -
465 the sub-entries are ignored.
469 Entry: gbb: An entry which contains a Chromium OS Google Binary Block
470 ---------------------------------------------------------------------
472 Properties / Entry arguments:
473 - hardware-id: Hardware ID to use for this build (a string)
474 - keydir: Directory containing the public keys to use
475 - bmpblk: Filename containing images used by recovery
477 Chromium OS uses a GBB to store various pieces of information, in particular
478 the root and recovery keys that are used to verify the boot process. Some
479 more details are here:
481 https://www.chromium.org/chromium-os/firmware-porting-guide/2-concepts
483 but note that the page dates from 2013 so is quite out of date. See
484 README.chromium for how to obtain the required keys and tools.
488 Entry: image-header: An entry which contains a pointer to the FDT map
489 ---------------------------------------------------------------------
491 Properties / Entry arguments:
492 location: Location of header ("start" or "end" of image). This is
493 optional. If omitted then the entry must have an offset property.
495 This adds an 8-byte entry to the start or end of the image, pointing to the
496 location of the FDT map. The format is a magic number followed by an offset
497 from the start or end of the image, in twos-compliment format.
499 This entry must be in the top-level part of the image.
501 NOTE: If the location is at the start/end, you will probably need to specify
502 sort-by-offset for the image, unless you actually put the image header
503 first/last in the entry list.
507 Entry: intel-cmc: Intel Chipset Micro Code (CMC) file
508 -----------------------------------------------------
510 Properties / Entry arguments:
511 - filename: Filename of file to read into entry
513 This file contains microcode for some devices in a special format. An
514 example filename is 'Microcode/C0_22211.BIN'.
516 See README.x86 for information about x86 binary blobs.
520 Entry: intel-descriptor: Intel flash descriptor block (4KB)
521 -----------------------------------------------------------
523 Properties / Entry arguments:
524 filename: Filename of file containing the descriptor. This is typically
525 a 4KB binary file, sometimes called 'descriptor.bin'
527 This entry is placed at the start of flash and provides information about
528 the SPI flash regions. In particular it provides the base address and
529 size of the ME (Management Engine) region, allowing us to place the ME
530 binary in the right place.
532 With this entry in your image, the position of the 'intel-me' entry will be
533 fixed in the image, which avoids you needed to specify an offset for that
534 region. This is useful, because it is not possible to change the position
535 of the ME region without updating the descriptor.
537 See README.x86 for information about x86 binary blobs.
541 Entry: intel-fit: Intel Firmware Image Table (FIT)
542 --------------------------------------------------
544 This entry contains a dummy FIT as required by recent Intel CPUs. The FIT
545 contains information about the firmware and microcode available in the
548 At present binman only supports a basic FIT with no microcode.
552 Entry: intel-fit-ptr: Intel Firmware Image Table (FIT) pointer
553 --------------------------------------------------------------
555 This entry contains a pointer to the FIT. It is required to be at address
556 0xffffffc0 in the image.
560 Entry: intel-fsp: Intel Firmware Support Package (FSP) file
561 -----------------------------------------------------------
563 Properties / Entry arguments:
564 - filename: Filename of file to read into entry
566 This file contains binary blobs which are used on some devices to make the
567 platform work. U-Boot executes this code since it is not possible to set up
568 the hardware using U-Boot open-source code. Documentation is typically not
569 available in sufficient detail to allow this.
571 An example filename is 'FSP/QUEENSBAY_FSP_GOLD_001_20-DECEMBER-2013.fd'
573 See README.x86 for information about x86 binary blobs.
577 Entry: intel-fsp-m: Intel Firmware Support Package (FSP) memory init
578 --------------------------------------------------------------------
580 Properties / Entry arguments:
581 - filename: Filename of file to read into entry
583 This file contains a binary blob which is used on some devices to set up
584 SDRAM. U-Boot executes this code in SPL so that it can make full use of
585 memory. Documentation is typically not available in sufficient detail to
586 allow U-Boot do this this itself..
588 An example filename is 'fsp_m.bin'
590 See README.x86 for information about x86 binary blobs.
594 Entry: intel-fsp-s: Intel Firmware Support Package (FSP) silicon init
595 ---------------------------------------------------------------------
597 Properties / Entry arguments:
598 - filename: Filename of file to read into entry
600 This file contains a binary blob which is used on some devices to set up
601 the silicon. U-Boot executes this code in U-Boot proper after SDRAM is
602 running, so that it can make full use of memory. Documentation is typically
603 not available in sufficient detail to allow U-Boot do this this itself.
605 An example filename is 'fsp_s.bin'
607 See README.x86 for information about x86 binary blobs.
611 Entry: intel-fsp-t: Intel Firmware Support Package (FSP) temp ram init
612 ----------------------------------------------------------------------
614 Properties / Entry arguments:
615 - filename: Filename of file to read into entry
617 This file contains a binary blob which is used on some devices to set up
618 temporary memory (Cache-as-RAM or CAR). U-Boot executes this code in TPL so
619 that it has access to memory for its stack and initial storage.
621 An example filename is 'fsp_t.bin'
623 See README.x86 for information about x86 binary blobs.
627 Entry: intel-ifwi: Intel Integrated Firmware Image (IFWI) file
628 --------------------------------------------------------------
630 Properties / Entry arguments:
631 - filename: Filename of file to read into entry. This is either the
632 IFWI file itself, or a file that can be converted into one using a
634 - convert-fit: If present this indicates that the ifwitool should be
635 used to convert the provided file into a IFWI.
637 This file contains code and data used by the SoC that is required to make
638 it work. It includes U-Boot TPL, microcode, things related to the CSE
639 (Converged Security Engine, the microcontroller that loads all the firmware)
640 and other items beyond the wit of man.
642 A typical filename is 'ifwi.bin' for an IFWI file, or 'fitimage.bin' for a
643 file that will be converted to an IFWI.
645 The position of this entry is generally set by the intel-descriptor entry.
647 The contents of the IFWI are specified by the subnodes of the IFWI node.
648 Each subnode describes an entry which is placed into the IFWFI with a given
649 sub-partition (and optional entry name).
651 Properties for subnodes:
652 - ifwi-subpart: sub-parition to put this entry into, e.g. "IBBP"
653 - ifwi-entry: entry name t use, e.g. "IBBL"
654 - ifwi-replace: if present, indicates that the item should be replaced
655 in the IFWI. Otherwise it is added.
657 See README.x86 for information about x86 binary blobs.
661 Entry: intel-me: Intel Management Engine (ME) file
662 --------------------------------------------------
664 Properties / Entry arguments:
665 - filename: Filename of file to read into entry
667 This file contains code used by the SoC that is required to make it work.
668 The Management Engine is like a background task that runs things that are
669 not clearly documented, but may include keyboard, display and network
670 access. For platform that use ME it is not possible to disable it. U-Boot
671 does not directly execute code in the ME binary.
673 A typical filename is 'me.bin'.
675 The position of this entry is generally set by the intel-descriptor entry.
677 See README.x86 for information about x86 binary blobs.
681 Entry: intel-mrc: Intel Memory Reference Code (MRC) file
682 --------------------------------------------------------
684 Properties / Entry arguments:
685 - filename: Filename of file to read into entry
687 This file contains code for setting up the SDRAM on some Intel systems. This
688 is executed by U-Boot when needed early during startup. A typical filename
691 See README.x86 for information about x86 binary blobs.
695 Entry: intel-refcode: Intel Reference Code file
696 -----------------------------------------------
698 Properties / Entry arguments:
699 - filename: Filename of file to read into entry
701 This file contains code for setting up the platform on some Intel systems.
702 This is executed by U-Boot when needed early during startup. A typical
703 filename is 'refcode.bin'.
705 See README.x86 for information about x86 binary blobs.
709 Entry: intel-vbt: Intel Video BIOS Table (VBT) file
710 ---------------------------------------------------
712 Properties / Entry arguments:
713 - filename: Filename of file to read into entry
715 This file contains code that sets up the integrated graphics subsystem on
716 some Intel SoCs. U-Boot executes this when the display is started up.
718 See README.x86 for information about Intel binary blobs.
722 Entry: intel-vga: Intel Video Graphics Adaptor (VGA) file
723 ---------------------------------------------------------
725 Properties / Entry arguments:
726 - filename: Filename of file to read into entry
728 This file contains code that sets up the integrated graphics subsystem on
729 some Intel SoCs. U-Boot executes this when the display is started up.
731 This is similar to the VBT file but in a different format.
733 See README.x86 for information about Intel binary blobs.
737 Entry: mkimage: Binary produced by mkimage
738 ------------------------------------------
740 Properties / Entry arguments:
741 - datafile: Filename for -d argument
742 - args: Other arguments to pass
744 The data passed to mkimage is collected from subnodes of the mkimage node,
748 args = "-n test -T imximage";
754 This calls mkimage to create an imximage with u-boot-spl.bin as the input
755 file. The output from mkimage then becomes part of the image produced by
760 Entry: powerpc-mpc85xx-bootpg-resetvec: PowerPC mpc85xx bootpg + resetvec code for U-Boot
761 -----------------------------------------------------------------------------------------
763 Properties / Entry arguments:
764 - filename: Filename of u-boot-br.bin (default 'u-boot-br.bin')
766 This entry is valid for PowerPC mpc85xx cpus. This entry holds
767 'bootpg + resetvec' code for PowerPC mpc85xx CPUs which needs to be
768 placed at offset 'RESET_VECTOR_ADDRESS - 0xffc'.
772 Entry: scp: System Control Processor (SCP) firmware blob
773 --------------------------------------------------------
775 Properties / Entry arguments:
776 - scp-path: Filename of file to read into the entry, typically scp.bin
778 This entry holds firmware for an external platform-specific coprocessor.
782 Entry: section: Entry that contains other entries
783 -------------------------------------------------
785 Properties / Entry arguments: (see binman README for more information):
786 pad-byte: Pad byte to use when padding
787 sort-by-offset: True if entries should be sorted by offset, False if
788 they must be in-order in the device tree description
790 end-at-4gb: Used to build an x86 ROM which ends at 4GB (2^32)
792 skip-at-start: Number of bytes before the first entry starts. These
793 effectively adjust the starting offset of entries. For example,
794 if this is 16, then the first entry would start at 16. An entry
795 with offset = 20 would in fact be written at offset 4 in the image
796 file, since the first 16 bytes are skipped when writing.
797 name-prefix: Adds a prefix to the name of every entry in the section
798 when writing out the map
801 allow_missing: True if this section permits external blobs to be
802 missing their contents. The second will produce an image but of
803 course it will not work.
805 Since a section is also an entry, it inherits all the properies of entries
808 A section is an entry which can contain other entries, thus allowing
809 hierarchical images to be created. See 'Sections and hierarchical images'
810 in the binman README for more information.
814 Entry: text: An entry which contains text
815 -----------------------------------------
817 The text can be provided either in the node itself or by a command-line
818 argument. There is a level of indirection to allow multiple text strings
821 Properties / Entry arguments:
822 text-label: The value of this string indicates the property / entry-arg
823 that contains the string to place in the entry
824 <xxx> (actual name is the value of text-label): contains the string to
826 <text>: The text to place in the entry (overrides the above mechanism).
827 This is useful when the text is constant.
833 text-label = "message";
838 binman -amessage="this is my message"
840 and binman will insert that string into the entry.
842 It is also possible to put the string directly in the node::
846 text-label = "message";
847 message = "a message directly in the node"
854 text = "some text directly in the node"
857 The text is not itself nul-terminated. This can be achieved, if required,
858 by setting the size of the entry to something larger than the text.
862 Entry: u-boot: U-Boot flat binary
863 ---------------------------------
865 Properties / Entry arguments:
866 - filename: Filename of u-boot.bin (default 'u-boot.bin')
868 This is the U-Boot binary, containing relocation information to allow it
869 to relocate itself at runtime. The binary typically includes a device tree
870 blob at the end of it.
872 U-Boot can access binman symbols at runtime. See:
874 'Access to binman entry offsets at run time (fdt)'
876 in the binman README for more information.
878 Note that this entry is automatically replaced with u-boot-expanded unless
879 --no-expanded is used or the node has a 'no-expanded' property.
883 Entry: u-boot-dtb: U-Boot device tree
884 -------------------------------------
886 Properties / Entry arguments:
887 - filename: Filename of u-boot.dtb (default 'u-boot.dtb')
889 This is the U-Boot device tree, containing configuration information for
890 U-Boot. U-Boot needs this to know what devices are present and which drivers
893 Note: This is mostly an internal entry type, used by others. This allows
894 binman to know which entries contain a device tree.
898 Entry: u-boot-dtb-with-ucode: A U-Boot device tree file, with the microcode removed
899 -----------------------------------------------------------------------------------
901 Properties / Entry arguments:
902 - filename: Filename of u-boot.dtb (default 'u-boot.dtb')
904 See Entry_u_boot_ucode for full details of the three entries involved in
905 this process. This entry provides the U-Boot device-tree file, which
906 contains the microcode. If the microcode is not being collated into one
907 place then the offset and size of the microcode is recorded by this entry,
908 for use by u-boot-with-ucode_ptr. If it is being collated, then this
909 entry deletes the microcode from the device tree (to save space) and makes
910 it available to u-boot-ucode.
914 Entry: u-boot-elf: U-Boot ELF image
915 -----------------------------------
917 Properties / Entry arguments:
918 - filename: Filename of u-boot (default 'u-boot')
920 This is the U-Boot ELF image. It does not include a device tree but can be
921 relocated to any address for execution.
925 Entry: u-boot-env: An entry which contains a U-Boot environment
926 ---------------------------------------------------------------
928 Properties / Entry arguments:
929 - filename: File containing the environment text, with each line in the
934 Entry: u-boot-expanded: U-Boot flat binary broken out into its component parts
935 ------------------------------------------------------------------------------
937 This is a section containing the U-Boot binary and a devicetree. Using this
938 entry type automatically creates this section, with the following entries
944 Having the devicetree separate allows binman to update it in the final
945 image, so that the entries positions are provided to the running U-Boot.
949 Entry: u-boot-img: U-Boot legacy image
950 --------------------------------------
952 Properties / Entry arguments:
953 - filename: Filename of u-boot.img (default 'u-boot.img')
955 This is the U-Boot binary as a packaged image, in legacy format. It has a
956 header which allows it to be loaded at the correct address for execution.
958 You should use FIT (Flat Image Tree) instead of the legacy image for new
963 Entry: u-boot-nodtb: U-Boot flat binary without device tree appended
964 --------------------------------------------------------------------
966 Properties / Entry arguments:
967 - filename: Filename to include (default 'u-boot-nodtb.bin')
969 This is the U-Boot binary, containing relocation information to allow it
970 to relocate itself at runtime. It does not include a device tree blob at
971 the end of it so normally cannot work without it. You can add a u-boot-dtb
972 entry after this one, or use a u-boot entry instead, normally expands to a
973 section containing u-boot and u-boot-dtb
977 Entry: u-boot-spl: U-Boot SPL binary
978 ------------------------------------
980 Properties / Entry arguments:
981 - filename: Filename of u-boot-spl.bin (default 'spl/u-boot-spl.bin')
983 This is the U-Boot SPL (Secondary Program Loader) binary. This is a small
984 binary which loads before U-Boot proper, typically into on-chip SRAM. It is
985 responsible for locating, loading and jumping to U-Boot. Note that SPL is
986 not relocatable so must be loaded to the correct address in SRAM, or written
987 to run from the correct address if direct flash execution is possible (e.g.
990 SPL can access binman symbols at runtime. See:
992 'Access to binman entry offsets at run time (symbols)'
994 in the binman README for more information.
996 The ELF file 'spl/u-boot-spl' must also be available for this to work, since
997 binman uses that to look up symbols to write into the SPL binary.
999 Note that this entry is automatically replaced with u-boot-spl-expanded
1000 unless --no-expanded is used or the node has a 'no-expanded' property.
1004 Entry: u-boot-spl-bss-pad: U-Boot SPL binary padded with a BSS region
1005 ---------------------------------------------------------------------
1007 Properties / Entry arguments:
1010 This holds the padding added after the SPL binary to cover the BSS (Block
1011 Started by Symbol) region. This region holds the various variables used by
1012 SPL. It is set to 0 by SPL when it starts up. If you want to append data to
1013 the SPL image (such as a device tree file), you must pad out the BSS region
1014 to avoid the data overlapping with U-Boot variables. This entry is useful in
1015 that case. It automatically pads out the entry size to cover both the code,
1018 The contents of this entry will a certain number of zero bytes, determined
1021 The ELF file 'spl/u-boot-spl' must also be available for this to work, since
1022 binman uses that to look up the BSS address.
1026 Entry: u-boot-spl-dtb: U-Boot SPL device tree
1027 ---------------------------------------------
1029 Properties / Entry arguments:
1030 - filename: Filename of u-boot.dtb (default 'spl/u-boot-spl.dtb')
1032 This is the SPL device tree, containing configuration information for
1033 SPL. SPL needs this to know what devices are present and which drivers
1038 Entry: u-boot-spl-elf: U-Boot SPL ELF image
1039 -------------------------------------------
1041 Properties / Entry arguments:
1042 - filename: Filename of SPL u-boot (default 'spl/u-boot-spl')
1044 This is the U-Boot SPL ELF image. It does not include a device tree but can
1045 be relocated to any address for execution.
1049 Entry: u-boot-spl-expanded: U-Boot SPL flat binary broken out into its component parts
1050 --------------------------------------------------------------------------------------
1052 Properties / Entry arguments:
1053 - spl-dtb: Controls whether this entry is selected (set to 'y' or '1' to
1056 This is a section containing the U-Boot binary, BSS padding if needed and a
1057 devicetree. Using this entry type automatically creates this section, with
1058 the following entries in it:
1064 Having the devicetree separate allows binman to update it in the final
1065 image, so that the entries positions are provided to the running U-Boot.
1067 This entry is selected based on the value of the 'spl-dtb' entryarg. If
1068 this is non-empty (and not 'n' or '0') then this expanded entry is selected.
1072 Entry: u-boot-spl-nodtb: SPL binary without device tree appended
1073 ----------------------------------------------------------------
1075 Properties / Entry arguments:
1076 - filename: Filename to include (default 'spl/u-boot-spl-nodtb.bin')
1078 This is the U-Boot SPL binary, It does not include a device tree blob at
1079 the end of it so may not be able to work without it, assuming SPL needs
1080 a device tree to operate on your platform. You can add a u-boot-spl-dtb
1081 entry after this one, or use a u-boot-spl entry instead' which normally
1082 expands to a section containing u-boot-spl-dtb, u-boot-spl-bss-pad and
1085 SPL can access binman symbols at runtime. See:
1087 'Access to binman entry offsets at run time (symbols)'
1089 in the binman README for more information.
1091 The ELF file 'spl/u-boot-spl' must also be available for this to work, since
1092 binman uses that to look up symbols to write into the SPL binary.
1096 Entry: u-boot-spl-with-ucode-ptr: U-Boot SPL with embedded microcode pointer
1097 ----------------------------------------------------------------------------
1099 This is used when SPL must set up the microcode for U-Boot.
1101 See Entry_u_boot_ucode for full details of the entries involved in this
1106 Entry: u-boot-tpl: U-Boot TPL binary
1107 ------------------------------------
1109 Properties / Entry arguments:
1110 - filename: Filename of u-boot-tpl.bin (default 'tpl/u-boot-tpl.bin')
1112 This is the U-Boot TPL (Tertiary Program Loader) binary. This is a small
1113 binary which loads before SPL, typically into on-chip SRAM. It is
1114 responsible for locating, loading and jumping to SPL, the next-stage
1115 loader. Note that SPL is not relocatable so must be loaded to the correct
1116 address in SRAM, or written to run from the correct address if direct
1117 flash execution is possible (e.g. on x86 devices).
1119 SPL can access binman symbols at runtime. See:
1121 'Access to binman entry offsets at run time (symbols)'
1123 in the binman README for more information.
1125 The ELF file 'tpl/u-boot-tpl' must also be available for this to work, since
1126 binman uses that to look up symbols to write into the TPL binary.
1128 Note that this entry is automatically replaced with u-boot-tpl-expanded
1129 unless --no-expanded is used or the node has a 'no-expanded' property.
1133 Entry: u-boot-tpl-bss-pad: U-Boot TPL binary padded with a BSS region
1134 ---------------------------------------------------------------------
1136 Properties / Entry arguments:
1139 This holds the padding added after the TPL binary to cover the BSS (Block
1140 Started by Symbol) region. This region holds the various variables used by
1141 TPL. It is set to 0 by TPL when it starts up. If you want to append data to
1142 the TPL image (such as a device tree file), you must pad out the BSS region
1143 to avoid the data overlapping with U-Boot variables. This entry is useful in
1144 that case. It automatically pads out the entry size to cover both the code,
1147 The contents of this entry will a certain number of zero bytes, determined
1150 The ELF file 'tpl/u-boot-tpl' must also be available for this to work, since
1151 binman uses that to look up the BSS address.
1155 Entry: u-boot-tpl-dtb: U-Boot TPL device tree
1156 ---------------------------------------------
1158 Properties / Entry arguments:
1159 - filename: Filename of u-boot.dtb (default 'tpl/u-boot-tpl.dtb')
1161 This is the TPL device tree, containing configuration information for
1162 TPL. TPL needs this to know what devices are present and which drivers
1167 Entry: u-boot-tpl-dtb-with-ucode: U-Boot TPL with embedded microcode pointer
1168 ----------------------------------------------------------------------------
1170 This is used when TPL must set up the microcode for U-Boot.
1172 See Entry_u_boot_ucode for full details of the entries involved in this
1177 Entry: u-boot-tpl-elf: U-Boot TPL ELF image
1178 -------------------------------------------
1180 Properties / Entry arguments:
1181 - filename: Filename of TPL u-boot (default 'tpl/u-boot-tpl')
1183 This is the U-Boot TPL ELF image. It does not include a device tree but can
1184 be relocated to any address for execution.
1188 Entry: u-boot-tpl-expanded: U-Boot TPL flat binary broken out into its component parts
1189 --------------------------------------------------------------------------------------
1191 Properties / Entry arguments:
1192 - tpl-dtb: Controls whether this entry is selected (set to 'y' or '1' to
1195 This is a section containing the U-Boot binary, BSS padding if needed and a
1196 devicetree. Using this entry type automatically creates this section, with
1197 the following entries in it:
1203 Having the devicetree separate allows binman to update it in the final
1204 image, so that the entries positions are provided to the running U-Boot.
1206 This entry is selected based on the value of the 'tpl-dtb' entryarg. If
1207 this is non-empty (and not 'n' or '0') then this expanded entry is selected.
1211 Entry: u-boot-tpl-nodtb: TPL binary without device tree appended
1212 ----------------------------------------------------------------
1214 Properties / Entry arguments:
1215 - filename: Filename to include (default 'tpl/u-boot-tpl-nodtb.bin')
1217 This is the U-Boot TPL binary, It does not include a device tree blob at
1218 the end of it so may not be able to work without it, assuming TPL needs
1219 a device tree to operate on your platform. You can add a u-boot-tpl-dtb
1220 entry after this one, or use a u-boot-tpl entry instead, which normally
1221 expands to a section containing u-boot-tpl-dtb, u-boot-tpl-bss-pad and
1224 TPL can access binman symbols at runtime. See:
1226 'Access to binman entry offsets at run time (symbols)'
1228 in the binman README for more information.
1230 The ELF file 'tpl/u-boot-tpl' must also be available for this to work, since
1231 binman uses that to look up symbols to write into the TPL binary.
1235 Entry: u-boot-tpl-with-ucode-ptr: U-Boot TPL with embedded microcode pointer
1236 ----------------------------------------------------------------------------
1238 See Entry_u_boot_ucode for full details of the entries involved in this
1243 Entry: u-boot-ucode: U-Boot microcode block
1244 -------------------------------------------
1246 Properties / Entry arguments:
1249 The contents of this entry are filled in automatically by other entries
1250 which must also be in the image.
1252 U-Boot on x86 needs a single block of microcode. This is collected from
1253 the various microcode update nodes in the device tree. It is also unable
1254 to read the microcode from the device tree on platforms that use FSP
1255 (Firmware Support Package) binaries, because the API requires that the
1256 microcode is supplied before there is any SRAM available to use (i.e.
1257 the FSP sets up the SRAM / cache-as-RAM but does so in the call that
1258 requires the microcode!). To keep things simple, all x86 platforms handle
1259 microcode the same way in U-Boot (even non-FSP platforms). This is that
1260 a table is placed at _dt_ucode_base_size containing the base address and
1261 size of the microcode. This is either passed to the FSP (for FSP
1262 platforms), or used to set up the microcode (for non-FSP platforms).
1263 This all happens in the build system since it is the only way to get
1264 the microcode into a single blob and accessible without SRAM.
1266 There are two cases to handle. If there is only one microcode blob in
1267 the device tree, then the ucode pointer it set to point to that. This
1268 entry (u-boot-ucode) is empty. If there is more than one update, then
1269 this entry holds the concatenation of all updates, and the device tree
1270 entry (u-boot-dtb-with-ucode) is updated to remove the microcode. This
1271 last step ensures that that the microcode appears in one contiguous
1272 block in the image and is not unnecessarily duplicated in the device
1273 tree. It is referred to as 'collation' here.
1275 Entry types that have a part to play in handling microcode:
1277 Entry_u_boot_with_ucode_ptr:
1278 Contains u-boot-nodtb.bin (i.e. U-Boot without the device tree).
1279 It updates it with the address and size of the microcode so that
1280 U-Boot can find it early on start-up.
1281 Entry_u_boot_dtb_with_ucode:
1282 Contains u-boot.dtb. It stores the microcode in a
1283 'self.ucode_data' property, which is then read by this class to
1284 obtain the microcode if needed. If collation is performed, it
1285 removes the microcode from the device tree.
1287 This class. If collation is enabled it reads the microcode from
1288 the Entry_u_boot_dtb_with_ucode entry, and uses it as the
1289 contents of this entry.
1293 Entry: u-boot-with-ucode-ptr: U-Boot with embedded microcode pointer
1294 --------------------------------------------------------------------
1296 Properties / Entry arguments:
1297 - filename: Filename of u-boot-nodtb.bin (default 'u-boot-nodtb.bin')
1298 - optional-ucode: boolean property to make microcode optional. If the
1299 u-boot.bin image does not include microcode, no error will
1302 See Entry_u_boot_ucode for full details of the three entries involved in
1303 this process. This entry updates U-Boot with the offset and size of the
1304 microcode, to allow early x86 boot code to find it without doing anything
1305 complicated. Otherwise it is the same as the u-boot entry.
1309 Entry: vblock: An entry which contains a Chromium OS verified boot block
1310 ------------------------------------------------------------------------
1312 Properties / Entry arguments:
1313 - content: List of phandles to entries to sign
1314 - keydir: Directory containing the public keys to use
1315 - keyblock: Name of the key file to use (inside keydir)
1316 - signprivate: Name of provide key file to use (inside keydir)
1317 - version: Version number of the vblock (typically 1)
1318 - kernelkey: Name of the kernel key to use (inside keydir)
1319 - preamble-flags: Value of the vboot preamble flags (typically 0)
1322 - input.<unique_name> - input file passed to futility
1323 - vblock.<unique_name> - output file generated by futility (which is
1324 used as the entry contents)
1326 Chromium OS signs the read-write firmware and kernel, writing the signature
1327 in this block. This allows U-Boot to verify that the next firmware stage
1328 and kernel are genuine.
1332 Entry: x86-reset16: x86 16-bit reset code for U-Boot
1333 ----------------------------------------------------
1335 Properties / Entry arguments:
1336 - filename: Filename of u-boot-x86-reset16.bin (default
1337 'u-boot-x86-reset16.bin')
1339 x86 CPUs start up in 16-bit mode, even if they are 32-bit CPUs. This code
1340 must be placed at a particular address. This entry holds that code. It is
1341 typically placed at offset CONFIG_RESET_VEC_LOC. The code is responsible
1342 for jumping to the x86-start16 code, which continues execution.
1344 For 64-bit U-Boot, the 'x86_reset16_spl' entry type is used instead.
1348 Entry: x86-reset16-spl: x86 16-bit reset code for U-Boot
1349 --------------------------------------------------------
1351 Properties / Entry arguments:
1352 - filename: Filename of u-boot-x86-reset16.bin (default
1353 'u-boot-x86-reset16.bin')
1355 x86 CPUs start up in 16-bit mode, even if they are 32-bit CPUs. This code
1356 must be placed at a particular address. This entry holds that code. It is
1357 typically placed at offset CONFIG_RESET_VEC_LOC. The code is responsible
1358 for jumping to the x86-start16 code, which continues execution.
1360 For 32-bit U-Boot, the 'x86_reset_spl' entry type is used instead.
1364 Entry: x86-reset16-tpl: x86 16-bit reset code for U-Boot
1365 --------------------------------------------------------
1367 Properties / Entry arguments:
1368 - filename: Filename of u-boot-x86-reset16.bin (default
1369 'u-boot-x86-reset16.bin')
1371 x86 CPUs start up in 16-bit mode, even if they are 32-bit CPUs. This code
1372 must be placed at a particular address. This entry holds that code. It is
1373 typically placed at offset CONFIG_RESET_VEC_LOC. The code is responsible
1374 for jumping to the x86-start16 code, which continues execution.
1376 For 32-bit U-Boot, the 'x86_reset_tpl' entry type is used instead.
1380 Entry: x86-start16: x86 16-bit start-up code for U-Boot
1381 -------------------------------------------------------
1383 Properties / Entry arguments:
1384 - filename: Filename of u-boot-x86-start16.bin (default
1385 'u-boot-x86-start16.bin')
1387 x86 CPUs start up in 16-bit mode, even if they are 32-bit CPUs. This code
1388 must be placed in the top 64KB of the ROM. The reset code jumps to it. This
1389 entry holds that code. It is typically placed at offset
1390 CONFIG_SYS_X86_START16. The code is responsible for changing to 32-bit mode
1391 and jumping to U-Boot's entry point, which requires 32-bit mode (for 32-bit
1394 For 64-bit U-Boot, the 'x86_start16_spl' entry type is used instead.
1398 Entry: x86-start16-spl: x86 16-bit start-up code for SPL
1399 --------------------------------------------------------
1401 Properties / Entry arguments:
1402 - filename: Filename of spl/u-boot-x86-start16-spl.bin (default
1403 'spl/u-boot-x86-start16-spl.bin')
1405 x86 CPUs start up in 16-bit mode, even if they are 32-bit CPUs. This code
1406 must be placed in the top 64KB of the ROM. The reset code jumps to it. This
1407 entry holds that code. It is typically placed at offset
1408 CONFIG_SYS_X86_START16. The code is responsible for changing to 32-bit mode
1409 and jumping to U-Boot's entry point, which requires 32-bit mode (for 32-bit
1412 For 32-bit U-Boot, the 'x86-start16' entry type is used instead.
1416 Entry: x86-start16-tpl: x86 16-bit start-up code for TPL
1417 --------------------------------------------------------
1419 Properties / Entry arguments:
1420 - filename: Filename of tpl/u-boot-x86-start16-tpl.bin (default
1421 'tpl/u-boot-x86-start16-tpl.bin')
1423 x86 CPUs start up in 16-bit mode, even if they are 32-bit CPUs. This code
1424 must be placed in the top 64KB of the ROM. The reset code jumps to it. This
1425 entry holds that code. It is typically placed at offset
1426 CONFIG_SYS_X86_START16. The code is responsible for changing to 32-bit mode
1427 and jumping to U-Boot's entry point, which requires 32-bit mode (for 32-bit
1430 If TPL is not being used, the 'x86-start16-spl or 'x86-start16' entry types
1431 may be used instead.