1 /* SPDX-License-Identifier: GPL-2.0+ */
3 * (C) Copyright 2008 Semihalf
5 * (C) Copyright 2000-2005
6 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
7 ********************************************************************
8 * NOTE: This header file defines an interface to U-Boot. Including
9 * this (unmodified) header file in another file is considered normal
10 * use of U-Boot, and does *not* fall under the heading of "derived
12 ********************************************************************
19 #include <asm/byteorder.h>
22 /* Define this to avoid #ifdefs later on */
27 #include <sys/types.h>
28 #include <linux/kconfig.h>
30 #define IMAGE_INDENT_STRING ""
35 #include <asm/u-boot.h>
37 #include <linker_lists.h>
39 #define IMAGE_INDENT_STRING " "
41 #endif /* USE_HOSTCC */
44 #include <linux/libfdt.h>
45 #include <fdt_support.h>
46 #include <u-boot/hash-checksum.h>
48 extern ulong image_load_addr; /* Default Load Address */
49 extern ulong image_save_addr; /* Default Save Address */
50 extern ulong image_save_size; /* Default Save Size */
51 extern ulong image_load_offset; /* Default Load Address Offset */
53 /* An invalid size, meaning that the image size is not known */
54 #define IMAGE_SIZE_INVAL (-1UL)
67 * Operating System Codes
69 * The following are exposed to uImage header.
70 * New IDs *MUST* be appended at the end of the list and *NEVER*
71 * inserted for backward compatibility.
74 IH_OS_INVALID = 0, /* Invalid OS */
75 IH_OS_OPENBSD, /* OpenBSD */
76 IH_OS_NETBSD, /* NetBSD */
77 IH_OS_FREEBSD, /* FreeBSD */
78 IH_OS_4_4BSD, /* 4.4BSD */
79 IH_OS_LINUX, /* Linux */
80 IH_OS_SVR4, /* SVR4 */
81 IH_OS_ESIX, /* Esix */
82 IH_OS_SOLARIS, /* Solaris */
83 IH_OS_IRIX, /* Irix */
85 IH_OS_DELL, /* Dell */
87 IH_OS_LYNXOS, /* LynxOS */
88 IH_OS_VXWORKS, /* VxWorks */
89 IH_OS_PSOS, /* pSOS */
91 IH_OS_U_BOOT, /* Firmware */
92 IH_OS_RTEMS, /* RTEMS */
93 IH_OS_ARTOS, /* ARTOS */
94 IH_OS_UNITY, /* Unity OS */
95 IH_OS_INTEGRITY, /* INTEGRITY */
97 IH_OS_PLAN9, /* Plan 9 */
98 IH_OS_OPENRTOS, /* OpenRTOS */
99 IH_OS_ARM_TRUSTED_FIRMWARE, /* ARM Trusted Firmware */
100 IH_OS_TEE, /* Trusted Execution Environment */
101 IH_OS_OPENSBI, /* RISC-V OpenSBI */
102 IH_OS_EFI, /* EFI Firmware (e.g. GRUB2) */
108 * CPU Architecture Codes (supported by Linux)
110 * The following are exposed to uImage header.
111 * New IDs *MUST* be appended at the end of the list and *NEVER*
112 * inserted for backward compatibility.
115 IH_ARCH_INVALID = 0, /* Invalid CPU */
116 IH_ARCH_ALPHA, /* Alpha */
117 IH_ARCH_ARM, /* ARM */
118 IH_ARCH_I386, /* Intel x86 */
119 IH_ARCH_IA64, /* IA64 */
120 IH_ARCH_MIPS, /* MIPS */
121 IH_ARCH_MIPS64, /* MIPS 64 Bit */
122 IH_ARCH_PPC, /* PowerPC */
123 IH_ARCH_S390, /* IBM S390 */
124 IH_ARCH_SH, /* SuperH */
125 IH_ARCH_SPARC, /* Sparc */
126 IH_ARCH_SPARC64, /* Sparc 64 Bit */
127 IH_ARCH_M68K, /* M68K */
128 IH_ARCH_NIOS, /* Nios-32 */
129 IH_ARCH_MICROBLAZE, /* MicroBlaze */
130 IH_ARCH_NIOS2, /* Nios-II */
131 IH_ARCH_BLACKFIN, /* Blackfin */
132 IH_ARCH_AVR32, /* AVR32 */
133 IH_ARCH_ST200, /* STMicroelectronics ST200 */
134 IH_ARCH_SANDBOX, /* Sandbox architecture (test only) */
135 IH_ARCH_NDS32, /* ANDES Technology - NDS32 */
136 IH_ARCH_OPENRISC, /* OpenRISC 1000 */
137 IH_ARCH_ARM64, /* ARM64 */
138 IH_ARCH_ARC, /* Synopsys DesignWare ARC */
139 IH_ARCH_X86_64, /* AMD x86_64, Intel and Via */
140 IH_ARCH_XTENSA, /* Xtensa */
141 IH_ARCH_RISCV, /* RISC-V */
149 * "Standalone Programs" are directly runnable in the environment
150 * provided by U-Boot; it is expected that (if they behave
151 * well) you can continue to work in U-Boot after return from
152 * the Standalone Program.
153 * "OS Kernel Images" are usually images of some Embedded OS which
154 * will take over control completely. Usually these programs
155 * will install their own set of exception handlers, device
156 * drivers, set up the MMU, etc. - this means, that you cannot
157 * expect to re-enter U-Boot except by resetting the CPU.
158 * "RAMDisk Images" are more or less just data blocks, and their
159 * parameters (address, size) are passed to an OS kernel that is
161 * "Multi-File Images" contain several images, typically an OS
162 * (Linux) kernel image and one or more data images like
163 * RAMDisks. This construct is useful for instance when you want
164 * to boot over the network using BOOTP etc., where the boot
165 * server provides just a single image file, but you want to get
166 * for instance an OS kernel and a RAMDisk image.
168 * "Multi-File Images" start with a list of image sizes, each
169 * image size (in bytes) specified by an "uint32_t" in network
170 * byte order. This list is terminated by an "(uint32_t)0".
171 * Immediately after the terminating 0 follow the images, one by
172 * one, all aligned on "uint32_t" boundaries (size rounded up to
173 * a multiple of 4 bytes - except for the last file).
175 * "Firmware Images" are binary images containing firmware (like
176 * U-Boot or FPGA images) which usually will be programmed to
179 * "Script files" are command sequences that will be executed by
180 * U-Boot's command interpreter; this feature is especially
181 * useful when you configure U-Boot to use a real shell (hush)
182 * as command interpreter (=> Shell Scripts).
184 * The following are exposed to uImage header.
185 * New IDs *MUST* be appended at the end of the list and *NEVER*
186 * inserted for backward compatibility.
189 IH_TYPE_INVALID = 0, /* Invalid Image */
190 IH_TYPE_STANDALONE, /* Standalone Program */
191 IH_TYPE_KERNEL, /* OS Kernel Image */
192 IH_TYPE_RAMDISK, /* RAMDisk Image */
193 IH_TYPE_MULTI, /* Multi-File Image */
194 IH_TYPE_FIRMWARE, /* Firmware Image */
195 IH_TYPE_SCRIPT, /* Script file */
196 IH_TYPE_FILESYSTEM, /* Filesystem Image (any type) */
197 IH_TYPE_FLATDT, /* Binary Flat Device Tree Blob */
198 IH_TYPE_KWBIMAGE, /* Kirkwood Boot Image */
199 IH_TYPE_IMXIMAGE, /* Freescale IMXBoot Image */
200 IH_TYPE_UBLIMAGE, /* Davinci UBL Image */
201 IH_TYPE_OMAPIMAGE, /* TI OMAP Config Header Image */
202 IH_TYPE_AISIMAGE, /* TI Davinci AIS Image */
203 /* OS Kernel Image, can run from any load address */
204 IH_TYPE_KERNEL_NOLOAD,
205 IH_TYPE_PBLIMAGE, /* Freescale PBL Boot Image */
206 IH_TYPE_MXSIMAGE, /* Freescale MXSBoot Image */
207 IH_TYPE_GPIMAGE, /* TI Keystone GPHeader Image */
208 IH_TYPE_ATMELIMAGE, /* ATMEL ROM bootable Image */
209 IH_TYPE_SOCFPGAIMAGE, /* Altera SOCFPGA CV/AV Preloader */
210 IH_TYPE_X86_SETUP, /* x86 setup.bin Image */
211 IH_TYPE_LPC32XXIMAGE, /* x86 setup.bin Image */
212 IH_TYPE_LOADABLE, /* A list of typeless images */
213 IH_TYPE_RKIMAGE, /* Rockchip Boot Image */
214 IH_TYPE_RKSD, /* Rockchip SD card */
215 IH_TYPE_RKSPI, /* Rockchip SPI image */
216 IH_TYPE_ZYNQIMAGE, /* Xilinx Zynq Boot Image */
217 IH_TYPE_ZYNQMPIMAGE, /* Xilinx ZynqMP Boot Image */
218 IH_TYPE_ZYNQMPBIF, /* Xilinx ZynqMP Boot Image (bif) */
219 IH_TYPE_FPGA, /* FPGA Image */
220 IH_TYPE_VYBRIDIMAGE, /* VYBRID .vyb Image */
221 IH_TYPE_TEE, /* Trusted Execution Environment OS Image */
222 IH_TYPE_FIRMWARE_IVT, /* Firmware Image with HABv4 IVT */
223 IH_TYPE_PMMC, /* TI Power Management Micro-Controller Firmware */
224 IH_TYPE_STM32IMAGE, /* STMicroelectronics STM32 Image */
225 IH_TYPE_SOCFPGAIMAGE_V1, /* Altera SOCFPGA A10 Preloader */
226 IH_TYPE_MTKIMAGE, /* MediaTek BootROM loadable Image */
227 IH_TYPE_IMX8MIMAGE, /* Freescale IMX8MBoot Image */
228 IH_TYPE_IMX8IMAGE, /* Freescale IMX8Boot Image */
229 IH_TYPE_COPRO, /* Coprocessor Image for remoteproc*/
230 IH_TYPE_SUNXI_EGON, /* Allwinner eGON Boot Image */
231 IH_TYPE_SUNXI_TOC0, /* Allwinner TOC0 Boot Image */
232 IH_TYPE_FDT_LEGACY, /* Binary Flat Device Tree Blob in a Legacy Image */
233 IH_TYPE_RENESAS_SPKG, /* Renesas SPKG image */
235 IH_TYPE_COUNT, /* Number of image types */
241 * The following are exposed to uImage header.
242 * New IDs *MUST* be appended at the end of the list and *NEVER*
243 * inserted for backward compatibility.
246 IH_COMP_NONE = 0, /* No Compression Used */
247 IH_COMP_GZIP, /* gzip Compression Used */
248 IH_COMP_BZIP2, /* bzip2 Compression Used */
249 IH_COMP_LZMA, /* lzma Compression Used */
250 IH_COMP_LZO, /* lzo Compression Used */
251 IH_COMP_LZ4, /* lz4 Compression Used */
252 IH_COMP_ZSTD, /* zstd Compression Used */
258 * Phases - images intended for particular U-Boot phases (SPL, etc.)
260 * @IH_PHASE_NONE: No phase information, can be loaded by any phase
261 * @IH_PHASE_U_BOOT: Only for U-Boot proper
262 * @IH_PHASE_SPL: Only for SPL
272 #define IMAGE_PHASE_SHIFT 8
273 #define IMAGE_PHASE_MASK (0xff << IMAGE_PHASE_SHIFT)
274 #define IMAGE_TYPE_MASK 0xff
277 * image_ph() - build a composite value combining and type
279 * @phase: Image phase value
280 * @type: Image type value
281 * Returns: Composite value containing both
283 static inline int image_ph(enum image_phase_t phase, enum image_type_t type)
285 return type | (phase << IMAGE_PHASE_SHIFT);
289 * image_ph_phase() - obtain the phase from a composite phase/type value
291 * @image_ph_type: Composite value to convert
292 * Returns: Phase value taken from the composite value
294 static inline int image_ph_phase(int image_ph_type)
296 return (image_ph_type & IMAGE_PHASE_MASK) >> IMAGE_PHASE_SHIFT;
300 * image_ph_type() - obtain the type from a composite phase/type value
302 * @image_ph_type: Composite value to convert
303 * Returns: Type value taken from the composite value
305 static inline int image_ph_type(int image_ph_type)
307 return image_ph_type & IMAGE_TYPE_MASK;
310 #define LZ4F_MAGIC 0x184D2204 /* LZ4 Magic Number */
311 #define IH_MAGIC 0x27051956 /* Image Magic Number */
312 #define IH_NMLEN 32 /* Image Name Length */
314 /* Reused from common.h */
315 #define ROUND(a, b) (((a) + (b) - 1) & ~((b) - 1))
318 * Legacy format image header,
319 * all data in network byte order (aka natural aka bigendian).
321 struct legacy_img_hdr {
322 uint32_t ih_magic; /* Image Header Magic Number */
323 uint32_t ih_hcrc; /* Image Header CRC Checksum */
324 uint32_t ih_time; /* Image Creation Timestamp */
325 uint32_t ih_size; /* Image Data Size */
326 uint32_t ih_load; /* Data Load Address */
327 uint32_t ih_ep; /* Entry Point Address */
328 uint32_t ih_dcrc; /* Image Data CRC Checksum */
329 uint8_t ih_os; /* Operating System */
330 uint8_t ih_arch; /* CPU architecture */
331 uint8_t ih_type; /* Image Type */
332 uint8_t ih_comp; /* Compression Type */
333 uint8_t ih_name[IH_NMLEN]; /* Image Name */
337 ulong start, end; /* start/end of blob */
338 ulong image_start, image_len; /* start of image within blob, len of image */
339 ulong load; /* load addr for the image */
340 uint8_t comp, type, os; /* compression, type of image, os type */
341 uint8_t arch; /* CPU architecture */
345 * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
348 struct bootm_headers {
350 * Legacy os image header, if it is a multi component image
351 * then boot_get_ramdisk() and get_fdt() will attempt to get
352 * data from second and third component accordingly.
354 struct legacy_img_hdr *legacy_hdr_os; /* image header pointer */
355 struct legacy_img_hdr legacy_hdr_os_copy; /* header copy */
356 ulong legacy_hdr_valid;
359 * The fit_ members are only used with FIT, but it involves a lot of
360 * #ifdefs to avoid compiling that code. Since FIT is the standard
361 * format, even for SPL, this extra data size seems worth it.
363 const char *fit_uname_cfg; /* configuration node unit name */
365 void *fit_hdr_os; /* os FIT image header */
366 const char *fit_uname_os; /* os subimage node unit name */
367 int fit_noffset_os; /* os subimage node offset */
369 void *fit_hdr_rd; /* init ramdisk FIT image header */
370 const char *fit_uname_rd; /* init ramdisk subimage node unit name */
371 int fit_noffset_rd; /* init ramdisk subimage node offset */
373 void *fit_hdr_fdt; /* FDT blob FIT image header */
374 const char *fit_uname_fdt; /* FDT blob subimage node unit name */
375 int fit_noffset_fdt;/* FDT blob subimage node offset */
377 void *fit_hdr_setup; /* x86 setup FIT image header */
378 const char *fit_uname_setup; /* x86 setup subimage node name */
379 int fit_noffset_setup;/* x86 setup subimage node offset */
382 struct image_info os; /* os image info */
383 ulong ep; /* entry point of OS */
385 ulong rd_start, rd_end;/* ramdisk start/end */
387 char *ft_addr; /* flat dev tree address */
388 ulong ft_len; /* length of flat device tree */
397 int verify; /* env_get("verify")[0] != 'n' */
399 #define BOOTM_STATE_START 0x00000001
400 #define BOOTM_STATE_FINDOS 0x00000002
401 #define BOOTM_STATE_FINDOTHER 0x00000004
402 #define BOOTM_STATE_LOADOS 0x00000008
403 #define BOOTM_STATE_RAMDISK 0x00000010
404 #define BOOTM_STATE_FDT 0x00000020
405 #define BOOTM_STATE_OS_CMDLINE 0x00000040
406 #define BOOTM_STATE_OS_BD_T 0x00000080
407 #define BOOTM_STATE_OS_PREP 0x00000100
408 #define BOOTM_STATE_OS_FAKE_GO 0x00000200 /* 'Almost' run the OS */
409 #define BOOTM_STATE_OS_GO 0x00000400
410 #define BOOTM_STATE_PRE_LOAD 0x00000800
413 #if defined(CONFIG_LMB) && !defined(USE_HOSTCC)
414 struct lmb lmb; /* for memory mgmt */
419 #define images_lmb(_images) (&(_images)->lmb)
421 #define images_lmb(_images) NULL
424 extern struct bootm_headers images;
427 * Some systems (for example LWMON) have very short watchdog periods;
428 * we must make sure to split long operations like memmove() or
429 * checksum calculations into reasonable chunks.
432 #define CHUNKSZ (64 * 1024)
435 #ifndef CHUNKSZ_CRC32
436 #define CHUNKSZ_CRC32 (64 * 1024)
440 #define CHUNKSZ_MD5 (64 * 1024)
444 #define CHUNKSZ_SHA1 (64 * 1024)
447 #define uimage_to_cpu(x) be32_to_cpu(x)
448 #define cpu_to_uimage(x) cpu_to_be32(x)
451 * Translation table for entries of a specific type; used by
452 * get_table_entry_id() and get_table_entry_name().
454 typedef struct table_entry {
456 char *sname; /* short (input) name to find table entry */
457 char *lname; /* long (output) name to print for messages */
461 * Compression type and magic number mapping table.
463 struct comp_magic_map {
466 unsigned char magic[2];
470 * get_table_entry_id() scans the translation table trying to find an
471 * entry that matches the given short name. If a matching entry is
472 * found, it's id is returned to the caller.
474 int get_table_entry_id(const table_entry_t *table,
475 const char *table_name, const char *name);
477 * get_table_entry_name() scans the translation table trying to find
478 * an entry that matches the given id. If a matching entry is found,
479 * its long name is returned to the caller.
481 char *get_table_entry_name(const table_entry_t *table, char *msg, int id);
483 const char *genimg_get_os_name(uint8_t os);
486 * genimg_get_os_short_name() - get the short name for an OS
488 * @param os OS (IH_OS_...)
489 * Return: OS short name, or "unknown" if unknown
491 const char *genimg_get_os_short_name(uint8_t comp);
493 const char *genimg_get_arch_name(uint8_t arch);
496 * genimg_get_phase_name() - Get the friendly name for a phase
498 * @phase: Phase value to look up
499 * Returns: Friendly name for the phase (e.g. "U-Boot phase")
501 const char *genimg_get_phase_name(enum image_phase_t phase);
504 * genimg_get_phase_id() - Convert a phase name to an ID
506 * @name: Name to convert (e.g. "u-boot")
507 * Returns: ID for that phase (e.g. IH_PHASE_U_BOOT)
509 int genimg_get_phase_id(const char *name);
512 * genimg_get_arch_short_name() - get the short name for an architecture
514 * @param arch Architecture type (IH_ARCH_...)
515 * Return: architecture short name, or "unknown" if unknown
517 const char *genimg_get_arch_short_name(uint8_t arch);
519 const char *genimg_get_type_name(uint8_t type);
522 * genimg_get_type_short_name() - get the short name for an image type
524 * @param type Image type (IH_TYPE_...)
525 * Return: image short name, or "unknown" if unknown
527 const char *genimg_get_type_short_name(uint8_t type);
529 const char *genimg_get_comp_name(uint8_t comp);
532 * genimg_get_comp_short_name() - get the short name for a compression method
534 * @param comp compression method (IH_COMP_...)
535 * Return: compression method short name, or "unknown" if unknown
537 const char *genimg_get_comp_short_name(uint8_t comp);
540 * genimg_get_cat_name() - Get the name of an item in a category
542 * @category: Category of item
544 * Return: name of item, or "Unknown ..." if unknown
546 const char *genimg_get_cat_name(enum ih_category category, uint id);
549 * genimg_get_cat_short_name() - Get the short name of an item in a category
551 * @category: Category of item
553 * Return: short name of item, or "Unknown ..." if unknown
555 const char *genimg_get_cat_short_name(enum ih_category category, uint id);
558 * genimg_get_cat_count() - Get the number of items in a category
560 * @category: Category to check
561 * Return: the number of items in the category (IH_xxx_COUNT)
563 int genimg_get_cat_count(enum ih_category category);
566 * genimg_get_cat_desc() - Get the description of a category
568 * @category: Category to check
569 * Return: the description of a category, e.g. "architecture". This
570 * effectively converts the enum to a string.
572 const char *genimg_get_cat_desc(enum ih_category category);
575 * genimg_cat_has_id() - Check whether a category has an item
577 * @category: Category to check
579 * Return: true or false as to whether a category has an item
581 bool genimg_cat_has_id(enum ih_category category, uint id);
583 int genimg_get_os_id(const char *name);
584 int genimg_get_arch_id(const char *name);
585 int genimg_get_type_id(const char *name);
586 int genimg_get_comp_id(const char *name);
587 void genimg_print_size(uint32_t size);
589 #if defined(CONFIG_TIMESTAMP) || defined(CONFIG_CMD_DATE) || defined(USE_HOSTCC)
590 #define IMAGE_ENABLE_TIMESTAMP 1
592 #define IMAGE_ENABLE_TIMESTAMP 0
594 void genimg_print_time(time_t timestamp);
596 /* What to do with a image load address ('load = <> 'in the FIT) */
598 FIT_LOAD_IGNORED, /* Ignore load address */
599 FIT_LOAD_OPTIONAL, /* Can be provided, but optional */
600 FIT_LOAD_OPTIONAL_NON_ZERO, /* Optional, a value of 0 is ignored */
601 FIT_LOAD_REQUIRED, /* Must be provided */
604 int boot_get_setup(struct bootm_headers *images, uint8_t arch, ulong *setup_start,
607 /* Image format types, returned by _get_format() routine */
608 #define IMAGE_FORMAT_INVALID 0x00
609 #define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */
610 #define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */
611 #define IMAGE_FORMAT_ANDROID 0x03 /* Android boot image */
613 ulong genimg_get_kernel_addr_fit(char * const img_addr,
614 const char **fit_uname_config,
615 const char **fit_uname_kernel);
616 ulong genimg_get_kernel_addr(char * const img_addr);
617 int genimg_get_format(const void *img_addr);
618 int genimg_has_config(struct bootm_headers *images);
620 int boot_get_fpga(int argc, char *const argv[], struct bootm_headers *images,
621 uint8_t arch, const ulong *ld_start, ulong * const ld_len);
622 int boot_get_ramdisk(int argc, char *const argv[], struct bootm_headers *images,
623 uint8_t arch, ulong *rd_start, ulong *rd_end);
626 * boot_get_loadable - routine to load a list of binaries to memory
627 * @argc: Ignored Argument
628 * @argv: Ignored Argument
629 * @images: pointer to the bootm images structure
630 * @arch: expected architecture for the image
631 * @ld_start: Ignored Argument
632 * @ld_len: Ignored Argument
634 * boot_get_loadable() will take the given FIT configuration, and look
635 * for a field named "loadables". Loadables, is a list of elements in
636 * the FIT given as strings. exe:
637 * loadables = "linux_kernel", "fdt-2";
638 * this function will attempt to parse each string, and load the
639 * corresponding element from the FIT into memory. Once placed,
640 * no aditional actions are taken.
643 * 0, if only valid images or no images are found
644 * error code, if an error occurs during fit_image_load
646 int boot_get_loadable(int argc, char *const argv[], struct bootm_headers *images,
647 uint8_t arch, const ulong *ld_start, ulong *const ld_len);
649 int boot_get_setup_fit(struct bootm_headers *images, uint8_t arch,
650 ulong *setup_start, ulong *setup_len);
653 * boot_get_fdt_fit() - load a DTB from a FIT file (applying overlays)
655 * This deals with all aspects of loading an DTB from a FIT.
656 * The correct base image based on configuration will be selected, and
657 * then any overlays specified will be applied (as present in fit_uname_configp).
659 * @param images Boot images structure
660 * @param addr Address of FIT in memory
661 * @param fit_unamep On entry this is the requested image name
662 * (e.g. "kernel") or NULL to use the default. On exit
663 * points to the selected image name
664 * @param fit_uname_configp On entry this is the requested configuration
665 * name (e.g. "conf-1") or NULL to use the default. On
666 * exit points to the selected configuration name.
667 * @param arch Expected architecture (IH_ARCH_...)
668 * @param datap Returns address of loaded image
669 * @param lenp Returns length of loaded image
671 * Return: node offset of base image, or -ve error code on error
673 int boot_get_fdt_fit(struct bootm_headers *images, ulong addr,
674 const char **fit_unamep, const char **fit_uname_configp,
675 int arch, ulong *datap, ulong *lenp);
678 * fit_image_load() - load an image from a FIT
680 * This deals with all aspects of loading an image from a FIT, including
681 * selecting the right image based on configuration, verifying it, printing
682 * out progress messages, checking the type/arch/os and optionally copying it
683 * to the right load address.
685 * The property to look up is defined by image_type.
687 * @param images Boot images structure
688 * @param addr Address of FIT in memory
689 * @param fit_unamep On entry this is the requested image name
690 * (e.g. "kernel") or NULL to use the default. On exit
691 * points to the selected image name
692 * @param fit_uname_configp On entry this is the requested configuration
693 * name (e.g. "conf-1") or NULL to use the default. On
694 * exit points to the selected configuration name.
695 * @param arch Expected architecture (IH_ARCH_...)
696 * @param image_ph_type Required image type (IH_TYPE_...). If this is
697 * IH_TYPE_KERNEL then we allow IH_TYPE_KERNEL_NOLOAD
698 * also. If a phase is required, this is included also,
699 * see image_phase_and_type()
700 * @param bootstage_id ID of starting bootstage to use for progress updates.
701 * This will be added to the BOOTSTAGE_SUB values when
702 * calling bootstage_mark()
703 * @param load_op Decribes what to do with the load address
704 * @param datap Returns address of loaded image
705 * @param lenp Returns length of loaded image
706 * Return: node offset of image, or -ve error code on error
708 int fit_image_load(struct bootm_headers *images, ulong addr,
709 const char **fit_unamep, const char **fit_uname_configp,
710 int arch, int image_ph_type, int bootstage_id,
711 enum fit_load_op load_op, ulong *datap, ulong *lenp);
714 * image_locate_script() - Locate the raw script in an image
716 * @buf: Address of image
717 * @size: Size of image in bytes
718 * @fit_uname: Node name of FIT image to read
719 * @confname: Node name of FIT config to read
720 * @datap: Returns pointer to raw script on success
721 * @lenp: Returns size of raw script on success
722 * @return 0 if OK, non-zero on error
724 int image_locate_script(void *buf, int size, const char *fit_uname,
725 const char *confname, char **datap, uint *lenp);
728 * fit_get_node_from_config() - Look up an image a FIT by type
730 * This looks in the selected conf- node (images->fit_uname_cfg) for a
731 * particular image type (e.g. "kernel") and then finds the image that is
734 * For example, for something like:
747 * the function will return the node offset of the kernel@1 node, assuming
748 * that conf-1 is the chosen configuration.
750 * @param images Boot images structure
751 * @param prop_name Property name to look up (FIT_..._PROP)
752 * @param addr Address of FIT in memory
754 int fit_get_node_from_config(struct bootm_headers *images,
755 const char *prop_name, ulong addr);
757 int boot_get_fdt(int flag, int argc, char *const argv[], uint8_t arch,
758 struct bootm_headers *images,
759 char **of_flat_tree, ulong *of_size);
760 void boot_fdt_add_mem_rsv_regions(struct lmb *lmb, void *fdt_blob);
761 int boot_relocate_fdt(struct lmb *lmb, char **of_flat_tree, ulong *of_size);
763 int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len,
764 ulong *initrd_start, ulong *initrd_end);
765 int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end);
766 int boot_get_kbd(struct lmb *lmb, struct bd_info **kbd);
768 /*******************************************************************/
769 /* Legacy format specific code (prefixed with image_) */
770 /*******************************************************************/
771 static inline uint32_t image_get_header_size(void)
773 return sizeof(struct legacy_img_hdr);
776 #define image_get_hdr_l(f) \
777 static inline uint32_t image_get_##f(const struct legacy_img_hdr *hdr) \
779 return uimage_to_cpu(hdr->ih_##f); \
781 image_get_hdr_l(magic) /* image_get_magic */
782 image_get_hdr_l(hcrc) /* image_get_hcrc */
783 image_get_hdr_l(time) /* image_get_time */
784 image_get_hdr_l(size) /* image_get_size */
785 image_get_hdr_l(load) /* image_get_load */
786 image_get_hdr_l(ep) /* image_get_ep */
787 image_get_hdr_l(dcrc) /* image_get_dcrc */
789 #define image_get_hdr_b(f) \
790 static inline uint8_t image_get_##f(const struct legacy_img_hdr *hdr) \
792 return hdr->ih_##f; \
794 image_get_hdr_b(os) /* image_get_os */
795 image_get_hdr_b(arch) /* image_get_arch */
796 image_get_hdr_b(type) /* image_get_type */
797 image_get_hdr_b(comp) /* image_get_comp */
799 static inline char *image_get_name(const struct legacy_img_hdr *hdr)
801 return (char *)hdr->ih_name;
804 static inline uint32_t image_get_data_size(const struct legacy_img_hdr *hdr)
806 return image_get_size(hdr);
810 * image_get_data - get image payload start address
813 * image_get_data() returns address of the image payload. For single
814 * component images it is image data start. For multi component
815 * images it points to the null terminated table of sub-images sizes.
818 * image payload data start address
820 static inline ulong image_get_data(const struct legacy_img_hdr *hdr)
822 return ((ulong)hdr + image_get_header_size());
825 static inline uint32_t image_get_image_size(const struct legacy_img_hdr *hdr)
827 return (image_get_size(hdr) + image_get_header_size());
830 static inline ulong image_get_image_end(const struct legacy_img_hdr *hdr)
832 return ((ulong)hdr + image_get_image_size(hdr));
835 #define image_set_hdr_l(f) \
836 static inline void image_set_##f(struct legacy_img_hdr *hdr, uint32_t val) \
838 hdr->ih_##f = cpu_to_uimage(val); \
840 image_set_hdr_l(magic) /* image_set_magic */
841 image_set_hdr_l(hcrc) /* image_set_hcrc */
842 image_set_hdr_l(time) /* image_set_time */
843 image_set_hdr_l(size) /* image_set_size */
844 image_set_hdr_l(load) /* image_set_load */
845 image_set_hdr_l(ep) /* image_set_ep */
846 image_set_hdr_l(dcrc) /* image_set_dcrc */
848 #define image_set_hdr_b(f) \
849 static inline void image_set_##f(struct legacy_img_hdr *hdr, uint8_t val) \
853 image_set_hdr_b(os) /* image_set_os */
854 image_set_hdr_b(arch) /* image_set_arch */
855 image_set_hdr_b(type) /* image_set_type */
856 image_set_hdr_b(comp) /* image_set_comp */
858 static inline void image_set_name(struct legacy_img_hdr *hdr, const char *name)
861 * This is equivalent to: strncpy(image_get_name(hdr), name, IH_NMLEN);
863 * Use the tortured code below to avoid a warning with gcc 12. We do not
864 * want to include a nul terminator if the name is of length IH_NMLEN
866 memcpy(image_get_name(hdr), name, strnlen(name, IH_NMLEN));
869 int image_check_hcrc(const struct legacy_img_hdr *hdr);
870 int image_check_dcrc(const struct legacy_img_hdr *hdr);
872 ulong env_get_bootm_low(void);
873 phys_size_t env_get_bootm_size(void);
874 phys_size_t env_get_bootm_mapsize(void);
876 void memmove_wd(void *to, void *from, size_t len, ulong chunksz);
878 static inline int image_check_magic(const struct legacy_img_hdr *hdr)
880 return (image_get_magic(hdr) == IH_MAGIC);
883 static inline int image_check_type(const struct legacy_img_hdr *hdr, uint8_t type)
885 return (image_get_type(hdr) == type);
888 static inline int image_check_arch(const struct legacy_img_hdr *hdr, uint8_t arch)
890 /* Let's assume that sandbox can load any architecture */
891 if (!tools_build() && IS_ENABLED(CONFIG_SANDBOX))
893 return (image_get_arch(hdr) == arch) ||
894 (image_get_arch(hdr) == IH_ARCH_ARM && arch == IH_ARCH_ARM64);
897 static inline int image_check_os(const struct legacy_img_hdr *hdr, uint8_t os)
899 return (image_get_os(hdr) == os);
902 ulong image_multi_count(const struct legacy_img_hdr *hdr);
903 void image_multi_getimg(const struct legacy_img_hdr *hdr, ulong idx,
904 ulong *data, ulong *len);
906 void image_print_contents(const void *hdr);
909 static inline int image_check_target_arch(const struct legacy_img_hdr *hdr)
911 #ifndef IH_ARCH_DEFAULT
912 # error "please define IH_ARCH_DEFAULT in your arch asm/u-boot.h"
914 return image_check_arch(hdr, IH_ARCH_DEFAULT);
916 #endif /* USE_HOSTCC */
919 * image_decomp_type() - Find out compression type of an image
921 * @buf: Address in U-Boot memory where image is loaded.
922 * @len: Length of the compressed image.
923 * Return: compression type or IH_COMP_NONE if not compressed.
925 * Note: Only following compression types are supported now.
926 * lzo, lzma, gzip, bzip2
928 int image_decomp_type(const unsigned char *buf, ulong len);
931 * image_decomp() - decompress an image
933 * @comp: Compression algorithm that is used (IH_COMP_...)
934 * @load: Destination load address in U-Boot memory
935 * @image_start Image start address (where we are decompressing from)
936 * @type: OS type (IH_OS_...)
937 * @load_bug: Place to decompress to
938 * @image_buf: Address to decompress from
939 * @image_len: Number of bytes in @image_buf to decompress
940 * @unc_len: Available space for decompression
941 * Return: 0 if OK, -ve on error (BOOTM_ERR_...)
943 int image_decomp(int comp, ulong load, ulong image_start, int type,
944 void *load_buf, void *image_buf, ulong image_len,
945 uint unc_len, ulong *load_end);
948 * Set up properties in the FDT
950 * This sets up properties in the FDT that is to be passed to linux.
952 * @images: Images information
953 * @blob: FDT to update
954 * @of_size: Size of the FDT
955 * @lmb: Points to logical memory block structure
956 * Return: 0 if ok, <0 on failure
958 int image_setup_libfdt(struct bootm_headers *images, void *blob,
959 int of_size, struct lmb *lmb);
962 * Set up the FDT to use for booting a kernel
964 * This performs ramdisk setup, sets up the FDT if required, and adds
965 * paramters to the FDT if libfdt is available.
967 * @param images Images information
968 * Return: 0 if ok, <0 on failure
970 int image_setup_linux(struct bootm_headers *images);
973 * bootz_setup() - Extract stat and size of a Linux xImage
975 * @image: Address of image
976 * @start: Returns start address of image
977 * @end : Returns end address of image
978 * Return: 0 if OK, 1 if the image was not recognised
980 int bootz_setup(ulong image, ulong *start, ulong *end);
983 * Return the correct start address and size of a Linux aarch64 Image.
985 * @image: Address of image
986 * @start: Returns start address of image
987 * @size : Returns size image
988 * @force_reloc: Ignore image->ep field, always place image to RAM start
989 * Return: 0 if OK, 1 if the image was not recognised
991 int booti_setup(ulong image, ulong *relocated_addr, ulong *size,
994 /*******************************************************************/
995 /* New uImage format specific code (prefixed with fit_) */
996 /*******************************************************************/
998 #define FIT_IMAGES_PATH "/images"
999 #define FIT_CONFS_PATH "/configurations"
1001 /* hash/signature/key node */
1002 #define FIT_HASH_NODENAME "hash"
1003 #define FIT_ALGO_PROP "algo"
1004 #define FIT_VALUE_PROP "value"
1005 #define FIT_IGNORE_PROP "uboot-ignore"
1006 #define FIT_SIG_NODENAME "signature"
1007 #define FIT_KEY_REQUIRED "required"
1008 #define FIT_KEY_HINT "key-name-hint"
1011 #define FIT_CIPHER_NODENAME "cipher"
1012 #define FIT_ALGO_PROP "algo"
1015 #define FIT_DATA_PROP "data"
1016 #define FIT_DATA_POSITION_PROP "data-position"
1017 #define FIT_DATA_OFFSET_PROP "data-offset"
1018 #define FIT_DATA_SIZE_PROP "data-size"
1019 #define FIT_TIMESTAMP_PROP "timestamp"
1020 #define FIT_DESC_PROP "description"
1021 #define FIT_ARCH_PROP "arch"
1022 #define FIT_TYPE_PROP "type"
1023 #define FIT_OS_PROP "os"
1024 #define FIT_COMP_PROP "compression"
1025 #define FIT_ENTRY_PROP "entry"
1026 #define FIT_LOAD_PROP "load"
1028 /* configuration node */
1029 #define FIT_KERNEL_PROP "kernel"
1030 #define FIT_RAMDISK_PROP "ramdisk"
1031 #define FIT_FDT_PROP "fdt"
1032 #define FIT_LOADABLE_PROP "loadables"
1033 #define FIT_DEFAULT_PROP "default"
1034 #define FIT_SETUP_PROP "setup"
1035 #define FIT_FPGA_PROP "fpga"
1036 #define FIT_FIRMWARE_PROP "firmware"
1037 #define FIT_STANDALONE_PROP "standalone"
1038 #define FIT_SCRIPT_PROP "script"
1039 #define FIT_PHASE_PROP "phase"
1041 #define FIT_MAX_HASH_LEN HASH_MAX_DIGEST_SIZE
1043 /* cmdline argument format parsing */
1044 int fit_parse_conf(const char *spec, ulong addr_curr,
1045 ulong *addr, const char **conf_name);
1046 int fit_parse_subimage(const char *spec, ulong addr_curr,
1047 ulong *addr, const char **image_name);
1049 int fit_get_subimage_count(const void *fit, int images_noffset);
1050 void fit_print_contents(const void *fit);
1051 void fit_image_print(const void *fit, int noffset, const char *p);
1054 * fit_get_end - get FIT image size
1055 * @fit: pointer to the FIT format image header
1058 * size of the FIT image (blob) in memory
1060 static inline ulong fit_get_size(const void *fit)
1062 return fdt_totalsize(fit);
1066 * fit_get_end - get FIT image end
1067 * @fit: pointer to the FIT format image header
1070 * end address of the FIT image (blob) in memory
1072 ulong fit_get_end(const void *fit);
1075 * fit_get_name - get FIT node name
1076 * @fit: pointer to the FIT format image header
1080 * pointer to node name, on success
1082 static inline const char *fit_get_name(const void *fit_hdr,
1083 int noffset, int *len)
1085 return fdt_get_name(fit_hdr, noffset, len);
1088 int fit_get_desc(const void *fit, int noffset, char **desc);
1089 int fit_get_timestamp(const void *fit, int noffset, time_t *timestamp);
1091 int fit_image_get_node(const void *fit, const char *image_uname);
1092 int fit_image_get_os(const void *fit, int noffset, uint8_t *os);
1093 int fit_image_get_arch(const void *fit, int noffset, uint8_t *arch);
1094 int fit_image_get_type(const void *fit, int noffset, uint8_t *type);
1095 int fit_image_get_comp(const void *fit, int noffset, uint8_t *comp);
1096 int fit_image_get_load(const void *fit, int noffset, ulong *load);
1097 int fit_image_get_entry(const void *fit, int noffset, ulong *entry);
1098 int fit_image_get_data(const void *fit, int noffset,
1099 const void **data, size_t *size);
1100 int fit_image_get_data_offset(const void *fit, int noffset, int *data_offset);
1101 int fit_image_get_data_position(const void *fit, int noffset,
1102 int *data_position);
1103 int fit_image_get_data_size(const void *fit, int noffset, int *data_size);
1104 int fit_image_get_data_size_unciphered(const void *fit, int noffset,
1106 int fit_image_get_data_and_size(const void *fit, int noffset,
1107 const void **data, size_t *size);
1110 * fit_get_data_node() - Get verified image data for an image
1111 * @fit: Pointer to the FIT format image header
1112 * @image_uname: The name of the image node
1113 * @data: A pointer which will be filled with the location of the image data
1114 * @size: A pointer which will be filled with the size of the image data
1116 * This function looks up the location and size of an image specified by its
1117 * name. For example, if you had a FIT like::
1125 * Then you could look up the data location and size of the my-firmware image
1126 * by calling this function with @image_uname set to "my-firmware". This
1127 * function also verifies the image data (if enabled) before returning. The
1128 * image description is printed out on success. @data and @size will not be
1129 * modified on faulure.
1133 * * -EINVAL if the image could not be verified
1134 * * -ENOENT if there was a problem getting the data/size
1135 * * Another negative error if there was a problem looking up the image node.
1137 int fit_get_data_node(const void *fit, const char *image_uname,
1138 const void **data, size_t *size);
1141 * fit_get_data_conf_prop() - Get verified image data for a property in /conf
1142 * @fit: Pointer to the FIT format image header
1143 * @prop_name: The name of the property in /conf referencing the image
1144 * @data: A pointer which will be filled with the location of the image data
1145 * @size: A pointer which will be filled with the size of the image data
1147 * This function looks up the location and size of an image specified by a
1148 * property in /conf. For example, if you had a FIT like::
1157 * default = "conf-1";
1159 * some-firmware = "my-firmware";
1163 * Then you could look up the data location and size of the my-firmware image
1164 * by calling this function with @prop_name set to "some-firmware". This
1165 * function also verifies the image data (if enabled) before returning. The
1166 * image description is printed out on success. @data and @size will not be
1167 * modified on faulure.
1171 * * -EINVAL if the image could not be verified
1172 * * -ENOENT if there was a problem getting the data/size
1173 * * Another negative error if there was a problem looking up the configuration
1176 int fit_get_data_conf_prop(const void *fit, const char *prop_name,
1177 const void **data, size_t *size);
1179 int fit_image_hash_get_algo(const void *fit, int noffset, const char **algo);
1180 int fit_image_hash_get_value(const void *fit, int noffset, uint8_t **value,
1183 int fit_set_timestamp(void *fit, int noffset, time_t timestamp);
1186 * fit_pre_load_data() - add public key to fdt blob
1188 * Adds public key to the node pre load.
1190 * @keydir: Directory containing keys
1191 * @keydest: FDT blob to write public key
1192 * @fit: Pointer to the FIT format image header
1198 int fit_pre_load_data(const char *keydir, void *keydest, void *fit);
1200 int fit_cipher_data(const char *keydir, void *keydest, void *fit,
1201 const char *comment, int require_keys,
1202 const char *engine_id, const char *cmdname);
1204 #define NODE_MAX_NAME_LEN 80
1207 * struct image_summary - Provides information about signing info added
1209 * @sig_offset: Offset of the node in the blob devicetree where the signature
1211 * @sig_path: Path to @sig_offset
1212 * @keydest_offset: Offset of the node in the keydest devicetree where the
1213 * public key was written (-1 if none)
1214 * @keydest_path: Path to @keydest_offset
1216 struct image_summary {
1218 char sig_path[NODE_MAX_NAME_LEN];
1220 char keydest_path[NODE_MAX_NAME_LEN];
1224 * fit_add_verification_data() - add verification data to FIT image nodes
1226 * @keydir: Directory containing keys
1227 * @kwydest: FDT blob to write public key information to (NULL if none)
1228 * @fit: Pointer to the FIT format image header
1229 * @comment: Comment to add to signature nodes
1230 * @require_keys: Mark all keys as 'required'
1231 * @engine_id: Engine to use for signing
1232 * @cmdname: Command name used when reporting errors
1233 * @algo_name: Algorithm name, or NULL if to be read from FIT
1234 * @summary: Returns information about what data was written
1236 * Adds hash values for all component images in the FIT blob.
1237 * Hashes are calculated for all component images which have hash subnodes
1238 * with algorithm property set to one of the supported hash algorithms.
1240 * Also add signatures if signature nodes are present.
1244 * libfdt error code, on failure
1246 int fit_add_verification_data(const char *keydir, const char *keyfile,
1247 void *keydest, void *fit, const char *comment,
1248 int require_keys, const char *engine_id,
1249 const char *cmdname, const char *algo_name,
1250 struct image_summary *summary);
1253 * fit_image_verify_with_data() - Verify an image with given data
1255 * @fit: Pointer to the FIT format image header
1256 * @image_offset: Offset in @fit of image to verify
1257 * @key_blob: FDT containing public keys
1258 * @data: Image data to verify
1259 * @size: Size of image data
1261 int fit_image_verify_with_data(const void *fit, int image_noffset,
1262 const void *key_blob, const void *data,
1265 int fit_image_verify(const void *fit, int noffset);
1266 #if CONFIG_IS_ENABLED(FIT_SIGNATURE)
1267 int fit_config_verify(const void *fit, int conf_noffset);
1269 static inline int fit_config_verify(const void *fit, int conf_noffset)
1274 int fit_all_image_verify(const void *fit);
1275 int fit_config_decrypt(const void *fit, int conf_noffset);
1276 int fit_image_check_os(const void *fit, int noffset, uint8_t os);
1277 int fit_image_check_arch(const void *fit, int noffset, uint8_t arch);
1278 int fit_image_check_type(const void *fit, int noffset, uint8_t type);
1279 int fit_image_check_comp(const void *fit, int noffset, uint8_t comp);
1282 * fit_check_format() - Check that the FIT is valid
1284 * This performs various checks on the FIT to make sure it is suitable for
1285 * use, looking for mandatory properties, nodes, etc.
1287 * If FIT_FULL_CHECK is enabled, it also runs it through libfdt to make
1288 * sure that there are no strange tags or broken nodes in the FIT.
1290 * @fit: pointer to the FIT format image header
1291 * Return: 0 if OK, -ENOEXEC if not an FDT file, -EINVAL if the full FDT check
1292 * failed (e.g. due to bad structure), -ENOMSG if the description is
1293 * missing, -EBADMSG if the timestamp is missing, -ENOENT if the /images
1296 int fit_check_format(const void *fit, ulong size);
1299 * fit_conf_find_compat() - find most compatible configuration
1300 * @fit: pointer to the FIT format image header
1301 * @fdt: pointer to the device tree to compare against
1303 * Attempts to find the configuration whose fdt is the most compatible with the
1304 * passed in device tree
1313 * |-o configurations
1321 * |-compatible = "foo,bar", "bim,bam"
1324 * |-compatible = "foo,bar",
1327 * |-compatible = "bim,bam", "baz,biz"
1329 * Configuration 1 would be picked because the first string in U-Boot's
1330 * compatible list, "foo,bar", matches a compatible string in the root of fdt1.
1331 * "bim,bam" in fdt2 matches the second string which isn't as good as fdt1.
1333 * As an optimization, the compatible property from the FDT's root node can be
1334 * copied into the configuration node in the FIT image. This is required to
1335 * match configurations with compressed FDTs.
1337 * Returns: offset to the configuration to use if one was found, -1 otherwise
1339 int fit_conf_find_compat(const void *fit, const void *fdt);
1342 * fit_conf_get_node - get node offset for configuration of a given unit name
1343 * @fit: pointer to the FIT format image header
1344 * @conf_uname: configuration node unit name (NULL to use default)
1346 * fit_conf_get_node() finds a configuration (within the '/configurations'
1347 * parent node) of a provided unit name. If configuration is found its node
1348 * offset is returned to the caller.
1350 * When NULL is provided in second argument fit_conf_get_node() will search
1351 * for a default configuration node instead. Default configuration node unit
1352 * name is retrieved from FIT_DEFAULT_PROP property of the '/configurations'
1356 * configuration node offset when found (>=0)
1357 * negative number on failure (FDT_ERR_* code)
1359 int fit_conf_get_node(const void *fit, const char *conf_uname);
1361 int fit_conf_get_prop_node_count(const void *fit, int noffset,
1362 const char *prop_name);
1363 int fit_conf_get_prop_node_index(const void *fit, int noffset,
1364 const char *prop_name, int index);
1367 * fit_conf_get_prop_node() - Get node refered to by a configuration
1368 * @fit: FIT to check
1369 * @noffset: Offset of conf@xxx node to check
1370 * @prop_name: Property to read from the conf node
1371 * @phase: Image phase to use, IH_PHASE_NONE for any
1373 * The conf- nodes contain references to other nodes, using properties
1374 * like 'kernel = "kernel"'. Given such a property name (e.g. "kernel"),
1375 * return the offset of the node referred to (e.g. offset of node
1378 int fit_conf_get_prop_node(const void *fit, int noffset, const char *prop_name,
1379 enum image_phase_t phase);
1381 int fit_check_ramdisk(const void *fit, int os_noffset,
1382 uint8_t arch, int verify);
1384 int calculate_hash(const void *data, int data_len, const char *algo,
1385 uint8_t *value, int *value_len);
1388 * At present we only support signing on the host, and verification on the
1391 #if defined(USE_HOSTCC)
1392 # if defined(CONFIG_FIT_SIGNATURE)
1393 # define IMAGE_ENABLE_SIGN 1
1394 # define FIT_IMAGE_ENABLE_VERIFY 1
1395 # include <openssl/evp.h>
1397 # define IMAGE_ENABLE_SIGN 0
1398 # define FIT_IMAGE_ENABLE_VERIFY 0
1401 # define IMAGE_ENABLE_SIGN 0
1402 # define FIT_IMAGE_ENABLE_VERIFY CONFIG_IS_ENABLED(FIT_SIGNATURE)
1406 void *image_get_host_blob(void);
1407 void image_set_host_blob(void *host_blob);
1408 # define gd_fdt_blob() image_get_host_blob()
1410 # define gd_fdt_blob() (gd->fdt_blob)
1414 * Information passed to the signing routines
1416 * Either 'keydir', 'keyname', or 'keyfile' can be NULL. However, either
1417 * 'keyfile', or both 'keydir' and 'keyname' should have valid values. If
1418 * neither are valid, some operations might fail with EINVAL.
1420 struct image_sign_info {
1421 const char *keydir; /* Directory conaining keys */
1422 const char *keyname; /* Name of key to use */
1423 const char *keyfile; /* Filename of private or public key */
1424 const void *fit; /* Pointer to FIT blob */
1425 int node_offset; /* Offset of signature node */
1426 const char *name; /* Algorithm name */
1427 struct checksum_algo *checksum; /* Checksum algorithm information */
1428 struct padding_algo *padding; /* Padding algorithm information */
1429 struct crypto_algo *crypto; /* Crypto algorithm information */
1430 const void *fdt_blob; /* FDT containing public keys */
1431 int required_keynode; /* Node offset of key to use: -1=any */
1432 const char *require_keys; /* Value for 'required' property */
1433 const char *engine_id; /* Engine to use for signing */
1435 * Note: the following two fields are always valid even w/o
1436 * RSA_VERIFY_WITH_PKEY in order to make sure this structure is
1437 * the same on target and host. Otherwise, vboot test may fail.
1439 const void *key; /* Pointer to public key in DER */
1440 int keylen; /* Length of public key */
1443 /* A part of an image, used for hashing */
1444 struct image_region {
1449 struct checksum_algo {
1451 const int checksum_len;
1453 const uint8_t *der_prefix;
1454 #if IMAGE_ENABLE_SIGN
1455 const EVP_MD *(*calculate_sign)(void);
1457 int (*calculate)(const char *name,
1458 const struct image_region *region,
1459 int region_count, uint8_t *checksum);
1462 struct crypto_algo {
1463 const char *name; /* Name of algorithm */
1467 * sign() - calculate and return signature for given input data
1469 * @info: Specifies key and FIT information
1470 * @data: Pointer to the input data
1471 * @data_len: Data length
1472 * @sigp: Set to an allocated buffer holding the signature
1473 * @sig_len: Set to length of the calculated hash
1475 * This computes input data signature according to selected algorithm.
1476 * Resulting signature value is placed in an allocated buffer, the
1477 * pointer is returned as *sigp. The length of the calculated
1478 * signature is returned via the sig_len pointer argument. The caller
1479 * should free *sigp.
1481 * @return: 0, on success, -ve on error
1483 int (*sign)(struct image_sign_info *info,
1484 const struct image_region region[],
1485 int region_count, uint8_t **sigp, uint *sig_len);
1488 * add_verify_data() - Add verification information to FDT
1490 * Add public key information to the FDT node, suitable for
1491 * verification at run-time. The information added depends on the
1492 * algorithm being used.
1494 * @info: Specifies key and FIT information
1495 * @keydest: Destination FDT blob for public key data
1496 * @return: node offset within the FDT blob where the data was written,
1499 int (*add_verify_data)(struct image_sign_info *info, void *keydest);
1502 * verify() - Verify a signature against some data
1504 * @info: Specifies key and FIT information
1505 * @data: Pointer to the input data
1506 * @data_len: Data length
1508 * @sig_len: Number of bytes in signature
1509 * @return 0 if verified, -ve on error
1511 int (*verify)(struct image_sign_info *info,
1512 const struct image_region region[], int region_count,
1513 uint8_t *sig, uint sig_len);
1516 /* Declare a new U-Boot crypto algorithm handler */
1517 #define U_BOOT_CRYPTO_ALGO(__name) \
1518 ll_entry_declare(struct crypto_algo, __name, cryptos)
1520 struct padding_algo {
1522 int (*verify)(struct image_sign_info *info,
1523 const uint8_t *pad, int pad_len,
1524 const uint8_t *hash, int hash_len);
1527 /* Declare a new U-Boot padding algorithm handler */
1528 #define U_BOOT_PADDING_ALGO(__name) \
1529 ll_entry_declare(struct padding_algo, __name, paddings)
1532 * image_get_checksum_algo() - Look up a checksum algorithm
1534 * @param full_name Name of algorithm in the form "checksum,crypto"
1535 * Return: pointer to algorithm information, or NULL if not found
1537 struct checksum_algo *image_get_checksum_algo(const char *full_name);
1540 * image_get_crypto_algo() - Look up a cryptosystem algorithm
1542 * @param full_name Name of algorithm in the form "checksum,crypto"
1543 * Return: pointer to algorithm information, or NULL if not found
1545 struct crypto_algo *image_get_crypto_algo(const char *full_name);
1548 * image_get_padding_algo() - Look up a padding algorithm
1550 * @param name Name of padding algorithm
1551 * Return: pointer to algorithm information, or NULL if not found
1553 struct padding_algo *image_get_padding_algo(const char *name);
1555 #define IMAGE_PRE_LOAD_SIG_MAGIC 0x55425348
1556 #define IMAGE_PRE_LOAD_SIG_OFFSET_MAGIC 0
1557 #define IMAGE_PRE_LOAD_SIG_OFFSET_IMG_LEN 4
1558 #define IMAGE_PRE_LOAD_SIG_OFFSET_SIG 8
1560 #define IMAGE_PRE_LOAD_PATH "/image/pre-load/sig"
1561 #define IMAGE_PRE_LOAD_PROP_ALGO_NAME "algo-name"
1562 #define IMAGE_PRE_LOAD_PROP_PADDING_NAME "padding-name"
1563 #define IMAGE_PRE_LOAD_PROP_SIG_SIZE "signature-size"
1564 #define IMAGE_PRE_LOAD_PROP_PUBLIC_KEY "public-key"
1565 #define IMAGE_PRE_LOAD_PROP_MANDATORY "mandatory"
1568 * Information in the device-tree about the signature in the header
1570 struct image_sig_info {
1571 char *algo_name; /* Name of the algo (eg: sha256,rsa2048) */
1572 char *padding_name; /* Name of the padding */
1573 uint8_t *key; /* Public signature key */
1574 int key_len; /* Length of the public key */
1575 uint32_t sig_size; /* size of the signature (in the header) */
1576 int mandatory; /* Set if the signature is mandatory */
1578 struct image_sign_info sig_info; /* Signature info */
1582 * Header of the signature header
1584 struct sig_header_s {
1587 uint32_t header_size;
1588 uint32_t image_size;
1589 uint32_t offset_img_sig;
1593 uint8_t sha256_img_sig[SHA256_SUM_LEN];
1596 #define SIG_HEADER_LEN (sizeof(struct sig_header_s))
1599 * image_pre_load() - Manage pre load header
1601 * Manage the pre-load header before launching the image.
1602 * It checks the signature of the image. It also set the
1603 * variable image_load_offset to skip this header before
1604 * launching the image.
1606 * @param addr Address of the image
1607 * @return: 0 on success, -ve on error
1609 int image_pre_load(ulong addr);
1612 * fit_image_verify_required_sigs() - Verify signatures marked as 'required'
1614 * @fit: FIT to check
1615 * @image_noffset: Offset of image node to check
1616 * @data: Image data to check
1617 * @size: Size of image data
1618 * @key_blob: FDT containing public keys
1619 * @no_sigsp: Returns 1 if no signatures were required, and
1620 * therefore nothing was checked. The caller may wish
1621 * to fall back to other mechanisms, or refuse to
1623 * Return: 0 if all verified ok, <0 on error
1625 int fit_image_verify_required_sigs(const void *fit, int image_noffset,
1626 const char *data, size_t size, const void *key_blob,
1630 * fit_image_check_sig() - Check a single image signature node
1632 * @fit: FIT to check
1633 * @noffset: Offset of signature node to check
1634 * @data: Image data to check
1635 * @size: Size of image data
1636 * @keyblob: Key blob to check (typically the control FDT)
1637 * @required_keynode: Offset in the keyblob of the required key node,
1638 * if any. If this is given, then the image wil not
1639 * pass verification unless that key is used. If this is
1640 * -1 then any signature will do.
1641 * @err_msgp: In the event of an error, this will be pointed to a
1642 * help error string to display to the user.
1643 * Return: 0 if all verified ok, <0 on error
1645 int fit_image_check_sig(const void *fit, int noffset, const void *data,
1646 size_t size, const void *key_blob, int required_keynode,
1649 int fit_image_decrypt_data(const void *fit,
1650 int image_noffset, int cipher_noffset,
1651 const void *data, size_t size,
1652 void **data_unciphered, size_t *size_unciphered);
1655 * fit_region_make_list() - Make a list of regions to hash
1657 * Given a list of FIT regions (offset, size) provided by libfdt, create
1658 * a list of regions (void *, size) for use by the signature creationg
1659 * and verification code.
1661 * @fit: FIT image to process
1662 * @fdt_regions: Regions as returned by libfdt
1663 * @count: Number of regions returned by libfdt
1664 * @region: Place to put list of regions (NULL to allocate it)
1665 * Return: pointer to list of regions, or NULL if out of memory
1667 struct image_region *fit_region_make_list(const void *fit,
1668 struct fdt_region *fdt_regions, int count,
1669 struct image_region *region);
1671 static inline int fit_image_check_target_arch(const void *fdt, int node)
1674 return fit_image_check_arch(fdt, node, IH_ARCH_DEFAULT);
1681 * At present we only support ciphering on the host, and unciphering on the
1684 #if defined(USE_HOSTCC)
1685 # if defined(CONFIG_FIT_CIPHER)
1686 # define IMAGE_ENABLE_ENCRYPT 1
1687 # define IMAGE_ENABLE_DECRYPT 1
1688 # include <openssl/evp.h>
1690 # define IMAGE_ENABLE_ENCRYPT 0
1691 # define IMAGE_ENABLE_DECRYPT 0
1694 # define IMAGE_ENABLE_ENCRYPT 0
1695 # define IMAGE_ENABLE_DECRYPT CONFIG_IS_ENABLED(FIT_CIPHER)
1698 /* Information passed to the ciphering routines */
1699 struct image_cipher_info {
1700 const char *keydir; /* Directory containing keys */
1701 const char *keyname; /* Name of key to use */
1702 const char *ivname; /* Name of IV to use */
1703 const void *fit; /* Pointer to FIT blob */
1704 int node_noffset; /* Offset of the cipher node */
1705 const char *name; /* Algorithm name */
1706 struct cipher_algo *cipher; /* Cipher algorithm information */
1707 const void *fdt_blob; /* FDT containing key and IV */
1708 const void *key; /* Value of the key */
1709 const void *iv; /* Value of the IV */
1710 size_t size_unciphered; /* Size of the unciphered data */
1713 struct cipher_algo {
1714 const char *name; /* Name of algorithm */
1715 int key_len; /* Length of the key */
1716 int iv_len; /* Length of the IV */
1718 #if IMAGE_ENABLE_ENCRYPT
1719 const EVP_CIPHER * (*calculate_type)(void);
1722 int (*encrypt)(struct image_cipher_info *info,
1723 const unsigned char *data, int data_len,
1724 unsigned char **cipher, int *cipher_len);
1726 int (*add_cipher_data)(struct image_cipher_info *info,
1727 void *keydest, void *fit, int node_noffset);
1729 int (*decrypt)(struct image_cipher_info *info,
1730 const void *cipher, size_t cipher_len,
1731 void **data, size_t *data_len);
1734 int fit_image_cipher_get_algo(const void *fit, int noffset, char **algo);
1736 struct cipher_algo *image_get_cipher_algo(const char *full_name);
1737 struct andr_image_data;
1740 * android_image_get_data() - Parse Android boot images
1742 * This is used to parse boot and vendor-boot header into
1743 * andr_image_data generic structure.
1745 * @boot_hdr: Pointer to boot image header
1746 * @vendor_boot_hdr: Pointer to vendor boot image header
1747 * @data: Pointer to generic boot format structure
1748 * Return: true if succeeded, false otherwise
1750 bool android_image_get_data(const void *boot_hdr, const void *vendor_boot_hdr,
1751 struct andr_image_data *data);
1753 struct andr_boot_img_hdr_v0;
1756 * android_image_get_kernel() - Processes kernel part of Android boot images
1758 * This function returns the os image's start address and length. Also,
1759 * it appends the kernel command line to the bootargs env variable.
1761 * @hdr: Pointer to image header, which is at the start
1763 * @vendor_boot_img : Pointer to vendor boot image header
1764 * @verify: Checksum verification flag. Currently unimplemented.
1765 * @os_data: Pointer to a ulong variable, will hold os data start
1767 * @os_len: Pointer to a ulong variable, will hold os data length.
1768 * Return: Zero, os start address and length on success,
1769 * otherwise on failure.
1771 int android_image_get_kernel(const void *hdr,
1772 const void *vendor_boot_img, int verify,
1773 ulong *os_data, ulong *os_len);
1776 * android_image_get_ramdisk() - Extracts the ramdisk load address and its size
1778 * This extracts the load address of the ramdisk and its size
1780 * @hdr: Pointer to image header
1781 * @vendor_boot_img : Pointer to vendor boot image header
1782 * @rd_data: Pointer to a ulong variable, will hold ramdisk address
1783 * @rd_len: Pointer to a ulong variable, will hold ramdisk length
1784 * Return: 0 if succeeded, -1 if ramdisk size is 0
1786 int android_image_get_ramdisk(const void *hdr, const void *vendor_boot_img,
1787 ulong *rd_data, ulong *rd_len);
1790 * android_image_get_second() - Extracts the secondary bootloader address
1793 * This extracts the address of the secondary bootloader and its size
1795 * @hdr: Pointer to image header
1796 * @second_data: Pointer to a ulong variable, will hold secondary bootloader address
1797 * @second_len : Pointer to a ulong variable, will hold secondary bootloader length
1798 * Return: 0 if succeeded, -1 if secondary bootloader size is 0
1800 int android_image_get_second(const void *hdr, ulong *second_data, ulong *second_len);
1801 bool android_image_get_dtbo(ulong hdr_addr, ulong *addr, u32 *size);
1804 * android_image_get_dtb_by_index() - Get address and size of blob in DTB area.
1805 * @hdr_addr: Boot image header address
1806 * @vendor_boot_img: Pointer to vendor boot image header, which is at the start of the image.
1807 * @index: Index of desired DTB in DTB area (starting from 0)
1808 * @addr: If not NULL, will contain address to specified DTB
1809 * @size: If not NULL, will contain size of specified DTB
1811 * Get the address and size of DTB blob by its index in DTB area of Android
1812 * Boot Image in RAM.
1814 * Return: true on success or false on error.
1816 bool android_image_get_dtb_by_index(ulong hdr_addr, ulong vendor_boot_img,
1817 u32 index, ulong *addr, u32 *size);
1820 * android_image_get_end() - Get the end of Android boot image
1822 * This returns the end address of Android boot image address
1824 * @hdr: Pointer to image header
1825 * @vendor_boot_img : Pointer to vendor boot image header
1826 * Return: The end address of Android boot image
1828 ulong android_image_get_end(const struct andr_boot_img_hdr_v0 *hdr,
1829 const void *vendor_boot_img);
1832 * android_image_get_kload() - Get the kernel load address
1834 * This returns the kernel load address. The load address is extracted
1835 * from the boot image header or the "kernel_addr_r" environment variable
1837 * @hdr: Pointer to image header
1838 * @vendor_boot_img : Pointer to vendor boot image header
1839 * Return: The kernel load address
1841 ulong android_image_get_kload(const void *hdr,
1842 const void *vendor_boot_img);
1845 * android_image_get_kcomp() - Get kernel compression type
1847 * This gets the kernel compression type from the boot image header
1849 * @hdr: Pointer to image header
1850 * @vendor_boot_img : Pointer to vendor boot image header
1851 * Return: Kernel compression type
1853 ulong android_image_get_kcomp(const void *hdr,
1854 const void *vendor_boot_img);
1857 * android_print_contents() - Prints out the contents of the Android format image
1859 * This formats a multi line Android image contents description.
1860 * The routine prints out Android image properties
1862 * @hdr: Pointer to the Android format image header
1863 * Return: no returned results
1865 void android_print_contents(const struct andr_boot_img_hdr_v0 *hdr);
1866 bool android_image_print_dtb_contents(ulong hdr_addr);
1869 * is_android_boot_image_header() - Check the magic of boot image
1871 * This checks the header of Android boot image and verifies the
1872 * magic is "ANDROID!"
1874 * @hdr: Pointer to boot image
1875 * Return: non-zero if the magic is correct, zero otherwise
1877 bool is_android_boot_image_header(const void *hdr);
1880 * is_android_vendor_boot_image_header() - Check the magic of vendor boot image
1882 * This checks the header of Android vendor boot image and verifies the magic
1885 * @vendor_boot_img: Pointer to boot image
1886 * Return: non-zero if the magic is correct, zero otherwise
1888 bool is_android_vendor_boot_image_header(const void *vendor_boot_img);
1891 * get_abootimg_addr() - Get Android boot image address
1893 * Return: Android boot image address
1895 ulong get_abootimg_addr(void);
1898 * get_avendor_bootimg_addr() - Get Android vendor boot image address
1900 * Return: Android vendor boot image address
1902 ulong get_avendor_bootimg_addr(void);
1905 * board_fit_config_name_match() - Check for a matching board name
1907 * This is used when SPL loads a FIT containing multiple device tree files
1908 * and wants to work out which one to use. The description of each one is
1909 * passed to this function. The description comes from the 'description' field
1910 * in each (FDT) image node.
1912 * @name: Device tree description
1913 * Return: 0 if this device tree should be used, non-zero to try the next
1915 int board_fit_config_name_match(const char *name);
1918 * board_fit_image_post_process() - Do any post-process on FIT binary data
1920 * This is used to do any sort of image manipulation, verification, decryption
1921 * etc. in a platform or board specific way. Obviously, anything done here would
1922 * need to be comprehended in how the images were prepared before being injected
1923 * into the FIT creation (i.e. the binary blobs would have been pre-processed
1924 * before being added to the FIT image).
1926 * @fit: pointer to fit image
1927 * @node: offset of image node
1928 * @image: pointer to the image start pointer
1929 * @size: pointer to the image size
1930 * Return: no return value (failure should be handled internally)
1932 void board_fit_image_post_process(const void *fit, int node, void **p_image,
1935 #define FDT_ERROR ((ulong)(-1))
1937 ulong fdt_getprop_u32(const void *fdt, int node, const char *prop);
1940 * fit_find_config_node() - Find the node for the best DTB in a FIT image
1942 * A FIT image contains one or more DTBs. This function parses the
1943 * configurations described in the FIT images and returns the node of
1944 * the first matching DTB. To check if a DTB matches a board, this function
1945 * calls board_fit_config_name_match(). If no matching DTB is found, it returns
1946 * the node described by the default configuration if it exists.
1948 * @fdt: pointer to flat device tree
1949 * Return: the node if found, -ve otherwise
1951 int fit_find_config_node(const void *fdt);
1954 * Mapping of image types to function handlers to be invoked on the associated
1957 * @type: Type of image, I.E. IH_TYPE_*
1958 * @handler: Function to call on loaded image
1960 struct fit_loadable_tbl {
1963 * handler() - Process a loaded image
1965 * @data: Pointer to start of loaded image data
1966 * @size: Size of loaded image data
1968 void (*handler)(ulong data, size_t size);
1972 * Define a FIT loadable image type handler
1974 * _type is a valid uimage_type ID as defined in the "Image Type" enum above
1975 * _handler is the handler function to call after this image type is loaded
1977 #define U_BOOT_FIT_LOADABLE_HANDLER(_type, _handler) \
1978 ll_entry_declare(struct fit_loadable_tbl, _function, fit_loadable) = { \
1980 .handler = _handler, \
1984 * fit_update - update storage with FIT image
1985 * @fit: Pointer to FIT image
1987 * Update firmware on storage using FIT image as input.
1988 * The storage area to be update will be identified by the name
1989 * in FIT and matching it to "dfu_alt_info" variable.
1991 * Return: 0 on success, non-zero otherwise
1993 int fit_update(const void *fit);
1995 #endif /* __IMAGE_H__ */