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 */
233 IH_TYPE_COUNT, /* Number of image types */
239 * The following are exposed to uImage header.
240 * New IDs *MUST* be appended at the end of the list and *NEVER*
241 * inserted for backward compatibility.
244 IH_COMP_NONE = 0, /* No Compression Used */
245 IH_COMP_GZIP, /* gzip Compression Used */
246 IH_COMP_BZIP2, /* bzip2 Compression Used */
247 IH_COMP_LZMA, /* lzma Compression Used */
248 IH_COMP_LZO, /* lzo Compression Used */
249 IH_COMP_LZ4, /* lz4 Compression Used */
250 IH_COMP_ZSTD, /* zstd Compression Used */
256 * Phases - images intended for particular U-Boot phases (SPL, etc.)
258 * @IH_PHASE_NONE: No phase information, can be loaded by any phase
259 * @IH_PHASE_U_BOOT: Only for U-Boot proper
260 * @IH_PHASE_SPL: Only for SPL
270 #define IMAGE_PHASE_SHIFT 8
271 #define IMAGE_PHASE_MASK (0xff << IMAGE_PHASE_SHIFT)
272 #define IMAGE_TYPE_MASK 0xff
275 * image_ph() - build a composite value combining and type
277 * @phase: Image phase value
278 * @type: Image type value
279 * Returns: Composite value containing both
281 static inline int image_ph(enum image_phase_t phase, enum image_type_t type)
283 return type | (phase << IMAGE_PHASE_SHIFT);
287 * image_ph_phase() - obtain the phase from a composite phase/type value
289 * @image_ph_type: Composite value to convert
290 * Returns: Phase value taken from the composite value
292 static inline int image_ph_phase(int image_ph_type)
294 return (image_ph_type & IMAGE_PHASE_MASK) >> IMAGE_PHASE_SHIFT;
298 * image_ph_type() - obtain the type from a composite phase/type value
300 * @image_ph_type: Composite value to convert
301 * Returns: Type value taken from the composite value
303 static inline int image_ph_type(int image_ph_type)
305 return image_ph_type & IMAGE_TYPE_MASK;
308 #define LZ4F_MAGIC 0x184D2204 /* LZ4 Magic Number */
309 #define IH_MAGIC 0x27051956 /* Image Magic Number */
310 #define IH_NMLEN 32 /* Image Name Length */
312 /* Reused from common.h */
313 #define ROUND(a, b) (((a) + (b) - 1) & ~((b) - 1))
316 * Legacy format image header,
317 * all data in network byte order (aka natural aka bigendian).
319 struct legacy_img_hdr {
320 uint32_t ih_magic; /* Image Header Magic Number */
321 uint32_t ih_hcrc; /* Image Header CRC Checksum */
322 uint32_t ih_time; /* Image Creation Timestamp */
323 uint32_t ih_size; /* Image Data Size */
324 uint32_t ih_load; /* Data Load Address */
325 uint32_t ih_ep; /* Entry Point Address */
326 uint32_t ih_dcrc; /* Image Data CRC Checksum */
327 uint8_t ih_os; /* Operating System */
328 uint8_t ih_arch; /* CPU architecture */
329 uint8_t ih_type; /* Image Type */
330 uint8_t ih_comp; /* Compression Type */
331 uint8_t ih_name[IH_NMLEN]; /* Image Name */
335 ulong start, end; /* start/end of blob */
336 ulong image_start, image_len; /* start of image within blob, len of image */
337 ulong load; /* load addr for the image */
338 uint8_t comp, type, os; /* compression, type of image, os type */
339 uint8_t arch; /* CPU architecture */
343 * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
346 struct bootm_headers {
348 * Legacy os image header, if it is a multi component image
349 * then boot_get_ramdisk() and get_fdt() will attempt to get
350 * data from second and third component accordingly.
352 struct legacy_img_hdr *legacy_hdr_os; /* image header pointer */
353 struct legacy_img_hdr legacy_hdr_os_copy; /* header copy */
354 ulong legacy_hdr_valid;
357 * The fit_ members are only used with FIT, but it involves a lot of
358 * #ifdefs to avoid compiling that code. Since FIT is the standard
359 * format, even for SPL, this extra data size seems worth it.
361 const char *fit_uname_cfg; /* configuration node unit name */
363 void *fit_hdr_os; /* os FIT image header */
364 const char *fit_uname_os; /* os subimage node unit name */
365 int fit_noffset_os; /* os subimage node offset */
367 void *fit_hdr_rd; /* init ramdisk FIT image header */
368 const char *fit_uname_rd; /* init ramdisk subimage node unit name */
369 int fit_noffset_rd; /* init ramdisk subimage node offset */
371 void *fit_hdr_fdt; /* FDT blob FIT image header */
372 const char *fit_uname_fdt; /* FDT blob subimage node unit name */
373 int fit_noffset_fdt;/* FDT blob subimage node offset */
375 void *fit_hdr_setup; /* x86 setup FIT image header */
376 const char *fit_uname_setup; /* x86 setup subimage node name */
377 int fit_noffset_setup;/* x86 setup subimage node offset */
380 struct image_info os; /* os image info */
381 ulong ep; /* entry point of OS */
383 ulong rd_start, rd_end;/* ramdisk start/end */
385 char *ft_addr; /* flat dev tree address */
386 ulong ft_len; /* length of flat device tree */
395 int verify; /* env_get("verify")[0] != 'n' */
397 #define BOOTM_STATE_START 0x00000001
398 #define BOOTM_STATE_FINDOS 0x00000002
399 #define BOOTM_STATE_FINDOTHER 0x00000004
400 #define BOOTM_STATE_LOADOS 0x00000008
401 #define BOOTM_STATE_RAMDISK 0x00000010
402 #define BOOTM_STATE_FDT 0x00000020
403 #define BOOTM_STATE_OS_CMDLINE 0x00000040
404 #define BOOTM_STATE_OS_BD_T 0x00000080
405 #define BOOTM_STATE_OS_PREP 0x00000100
406 #define BOOTM_STATE_OS_FAKE_GO 0x00000200 /* 'Almost' run the OS */
407 #define BOOTM_STATE_OS_GO 0x00000400
408 #define BOOTM_STATE_PRE_LOAD 0x00000800
411 #if defined(CONFIG_LMB) && !defined(USE_HOSTCC)
412 struct lmb lmb; /* for memory mgmt */
417 #define images_lmb(_images) (&(_images)->lmb)
419 #define images_lmb(_images) NULL
422 extern struct bootm_headers images;
425 * Some systems (for example LWMON) have very short watchdog periods;
426 * we must make sure to split long operations like memmove() or
427 * checksum calculations into reasonable chunks.
430 #define CHUNKSZ (64 * 1024)
433 #ifndef CHUNKSZ_CRC32
434 #define CHUNKSZ_CRC32 (64 * 1024)
438 #define CHUNKSZ_MD5 (64 * 1024)
442 #define CHUNKSZ_SHA1 (64 * 1024)
445 #define uimage_to_cpu(x) be32_to_cpu(x)
446 #define cpu_to_uimage(x) cpu_to_be32(x)
449 * Translation table for entries of a specific type; used by
450 * get_table_entry_id() and get_table_entry_name().
452 typedef struct table_entry {
454 char *sname; /* short (input) name to find table entry */
455 char *lname; /* long (output) name to print for messages */
459 * Compression type and magic number mapping table.
461 struct comp_magic_map {
464 unsigned char magic[2];
468 * get_table_entry_id() scans the translation table trying to find an
469 * entry that matches the given short name. If a matching entry is
470 * found, it's id is returned to the caller.
472 int get_table_entry_id(const table_entry_t *table,
473 const char *table_name, const char *name);
475 * get_table_entry_name() scans the translation table trying to find
476 * an entry that matches the given id. If a matching entry is found,
477 * its long name is returned to the caller.
479 char *get_table_entry_name(const table_entry_t *table, char *msg, int id);
481 const char *genimg_get_os_name(uint8_t os);
484 * genimg_get_os_short_name() - get the short name for an OS
486 * @param os OS (IH_OS_...)
487 * Return: OS short name, or "unknown" if unknown
489 const char *genimg_get_os_short_name(uint8_t comp);
491 const char *genimg_get_arch_name(uint8_t arch);
494 * genimg_get_phase_name() - Get the friendly name for a phase
496 * @phase: Phase value to look up
497 * Returns: Friendly name for the phase (e.g. "U-Boot phase")
499 const char *genimg_get_phase_name(enum image_phase_t phase);
502 * genimg_get_phase_id() - Convert a phase name to an ID
504 * @name: Name to convert (e.g. "u-boot")
505 * Returns: ID for that phase (e.g. IH_PHASE_U_BOOT)
507 int genimg_get_phase_id(const char *name);
510 * genimg_get_arch_short_name() - get the short name for an architecture
512 * @param arch Architecture type (IH_ARCH_...)
513 * Return: architecture short name, or "unknown" if unknown
515 const char *genimg_get_arch_short_name(uint8_t arch);
517 const char *genimg_get_type_name(uint8_t type);
520 * genimg_get_type_short_name() - get the short name for an image type
522 * @param type Image type (IH_TYPE_...)
523 * Return: image short name, or "unknown" if unknown
525 const char *genimg_get_type_short_name(uint8_t type);
527 const char *genimg_get_comp_name(uint8_t comp);
530 * genimg_get_comp_short_name() - get the short name for a compression method
532 * @param comp compression method (IH_COMP_...)
533 * Return: compression method short name, or "unknown" if unknown
535 const char *genimg_get_comp_short_name(uint8_t comp);
538 * genimg_get_cat_name() - Get the name of an item in a category
540 * @category: Category of item
542 * Return: name of item, or "Unknown ..." if unknown
544 const char *genimg_get_cat_name(enum ih_category category, uint id);
547 * genimg_get_cat_short_name() - Get the short name of an item in a category
549 * @category: Category of item
551 * Return: short name of item, or "Unknown ..." if unknown
553 const char *genimg_get_cat_short_name(enum ih_category category, uint id);
556 * genimg_get_cat_count() - Get the number of items in a category
558 * @category: Category to check
559 * Return: the number of items in the category (IH_xxx_COUNT)
561 int genimg_get_cat_count(enum ih_category category);
564 * genimg_get_cat_desc() - Get the description of a category
566 * @category: Category to check
567 * Return: the description of a category, e.g. "architecture". This
568 * effectively converts the enum to a string.
570 const char *genimg_get_cat_desc(enum ih_category category);
573 * genimg_cat_has_id() - Check whether a category has an item
575 * @category: Category to check
577 * Return: true or false as to whether a category has an item
579 bool genimg_cat_has_id(enum ih_category category, uint id);
581 int genimg_get_os_id(const char *name);
582 int genimg_get_arch_id(const char *name);
583 int genimg_get_type_id(const char *name);
584 int genimg_get_comp_id(const char *name);
585 void genimg_print_size(uint32_t size);
587 #if defined(CONFIG_TIMESTAMP) || defined(CONFIG_CMD_DATE) || defined(USE_HOSTCC)
588 #define IMAGE_ENABLE_TIMESTAMP 1
590 #define IMAGE_ENABLE_TIMESTAMP 0
592 void genimg_print_time(time_t timestamp);
594 /* What to do with a image load address ('load = <> 'in the FIT) */
596 FIT_LOAD_IGNORED, /* Ignore load address */
597 FIT_LOAD_OPTIONAL, /* Can be provided, but optional */
598 FIT_LOAD_OPTIONAL_NON_ZERO, /* Optional, a value of 0 is ignored */
599 FIT_LOAD_REQUIRED, /* Must be provided */
602 int boot_get_setup(struct bootm_headers *images, uint8_t arch, ulong *setup_start,
605 /* Image format types, returned by _get_format() routine */
606 #define IMAGE_FORMAT_INVALID 0x00
607 #define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */
608 #define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */
609 #define IMAGE_FORMAT_ANDROID 0x03 /* Android boot image */
611 ulong genimg_get_kernel_addr_fit(char * const img_addr,
612 const char **fit_uname_config,
613 const char **fit_uname_kernel);
614 ulong genimg_get_kernel_addr(char * const img_addr);
615 int genimg_get_format(const void *img_addr);
616 int genimg_has_config(struct bootm_headers *images);
618 int boot_get_fpga(int argc, char *const argv[], struct bootm_headers *images,
619 uint8_t arch, const ulong *ld_start, ulong * const ld_len);
620 int boot_get_ramdisk(int argc, char *const argv[], struct bootm_headers *images,
621 uint8_t arch, ulong *rd_start, ulong *rd_end);
624 * boot_get_loadable - routine to load a list of binaries to memory
625 * @argc: Ignored Argument
626 * @argv: Ignored Argument
627 * @images: pointer to the bootm images structure
628 * @arch: expected architecture for the image
629 * @ld_start: Ignored Argument
630 * @ld_len: Ignored Argument
632 * boot_get_loadable() will take the given FIT configuration, and look
633 * for a field named "loadables". Loadables, is a list of elements in
634 * the FIT given as strings. exe:
635 * loadables = "linux_kernel", "fdt-2";
636 * this function will attempt to parse each string, and load the
637 * corresponding element from the FIT into memory. Once placed,
638 * no aditional actions are taken.
641 * 0, if only valid images or no images are found
642 * error code, if an error occurs during fit_image_load
644 int boot_get_loadable(int argc, char *const argv[], struct bootm_headers *images,
645 uint8_t arch, const ulong *ld_start, ulong *const ld_len);
647 int boot_get_setup_fit(struct bootm_headers *images, uint8_t arch,
648 ulong *setup_start, ulong *setup_len);
651 * boot_get_fdt_fit() - load a DTB from a FIT file (applying overlays)
653 * This deals with all aspects of loading an DTB from a FIT.
654 * The correct base image based on configuration will be selected, and
655 * then any overlays specified will be applied (as present in fit_uname_configp).
657 * @param images Boot images structure
658 * @param addr Address of FIT in memory
659 * @param fit_unamep On entry this is the requested image name
660 * (e.g. "kernel") or NULL to use the default. On exit
661 * points to the selected image name
662 * @param fit_uname_configp On entry this is the requested configuration
663 * name (e.g. "conf-1") or NULL to use the default. On
664 * exit points to the selected configuration name.
665 * @param arch Expected architecture (IH_ARCH_...)
666 * @param datap Returns address of loaded image
667 * @param lenp Returns length of loaded image
669 * Return: node offset of base image, or -ve error code on error
671 int boot_get_fdt_fit(struct bootm_headers *images, ulong addr,
672 const char **fit_unamep, const char **fit_uname_configp,
673 int arch, ulong *datap, ulong *lenp);
676 * fit_image_load() - load an image from a FIT
678 * This deals with all aspects of loading an image from a FIT, including
679 * selecting the right image based on configuration, verifying it, printing
680 * out progress messages, checking the type/arch/os and optionally copying it
681 * to the right load address.
683 * The property to look up is defined by image_type.
685 * @param images Boot images structure
686 * @param addr Address of FIT in memory
687 * @param fit_unamep On entry this is the requested image name
688 * (e.g. "kernel") or NULL to use the default. On exit
689 * points to the selected image name
690 * @param fit_uname_configp On entry this is the requested configuration
691 * name (e.g. "conf-1") or NULL to use the default. On
692 * exit points to the selected configuration name.
693 * @param arch Expected architecture (IH_ARCH_...)
694 * @param image_ph_type Required image type (IH_TYPE_...). If this is
695 * IH_TYPE_KERNEL then we allow IH_TYPE_KERNEL_NOLOAD
696 * also. If a phase is required, this is included also,
697 * see image_phase_and_type()
698 * @param bootstage_id ID of starting bootstage to use for progress updates.
699 * This will be added to the BOOTSTAGE_SUB values when
700 * calling bootstage_mark()
701 * @param load_op Decribes what to do with the load address
702 * @param datap Returns address of loaded image
703 * @param lenp Returns length of loaded image
704 * Return: node offset of image, or -ve error code on error
706 int fit_image_load(struct bootm_headers *images, ulong addr,
707 const char **fit_unamep, const char **fit_uname_configp,
708 int arch, int image_ph_type, int bootstage_id,
709 enum fit_load_op load_op, ulong *datap, ulong *lenp);
712 * image_source_script() - Execute a script
714 * Executes a U-Boot script at a particular address in memory. The script should
715 * have a header (FIT or legacy) with the script type (IH_TYPE_SCRIPT).
717 * @addr: Address of script
718 * @fit_uname: FIT subimage name
719 * Return: result code (enum command_ret_t)
721 int image_source_script(ulong addr, const char *fit_uname);
724 * fit_get_node_from_config() - Look up an image a FIT by type
726 * This looks in the selected conf- node (images->fit_uname_cfg) for a
727 * particular image type (e.g. "kernel") and then finds the image that is
730 * For example, for something like:
743 * the function will return the node offset of the kernel@1 node, assuming
744 * that conf-1 is the chosen configuration.
746 * @param images Boot images structure
747 * @param prop_name Property name to look up (FIT_..._PROP)
748 * @param addr Address of FIT in memory
750 int fit_get_node_from_config(struct bootm_headers *images,
751 const char *prop_name, ulong addr);
753 int boot_get_fdt(int flag, int argc, char *const argv[], uint8_t arch,
754 struct bootm_headers *images,
755 char **of_flat_tree, ulong *of_size);
756 void boot_fdt_add_mem_rsv_regions(struct lmb *lmb, void *fdt_blob);
757 int boot_relocate_fdt(struct lmb *lmb, char **of_flat_tree, ulong *of_size);
759 int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len,
760 ulong *initrd_start, ulong *initrd_end);
761 int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end);
762 int boot_get_kbd(struct lmb *lmb, struct bd_info **kbd);
764 /*******************************************************************/
765 /* Legacy format specific code (prefixed with image_) */
766 /*******************************************************************/
767 static inline uint32_t image_get_header_size(void)
769 return sizeof(struct legacy_img_hdr);
772 #define image_get_hdr_l(f) \
773 static inline uint32_t image_get_##f(const struct legacy_img_hdr *hdr) \
775 return uimage_to_cpu(hdr->ih_##f); \
777 image_get_hdr_l(magic) /* image_get_magic */
778 image_get_hdr_l(hcrc) /* image_get_hcrc */
779 image_get_hdr_l(time) /* image_get_time */
780 image_get_hdr_l(size) /* image_get_size */
781 image_get_hdr_l(load) /* image_get_load */
782 image_get_hdr_l(ep) /* image_get_ep */
783 image_get_hdr_l(dcrc) /* image_get_dcrc */
785 #define image_get_hdr_b(f) \
786 static inline uint8_t image_get_##f(const struct legacy_img_hdr *hdr) \
788 return hdr->ih_##f; \
790 image_get_hdr_b(os) /* image_get_os */
791 image_get_hdr_b(arch) /* image_get_arch */
792 image_get_hdr_b(type) /* image_get_type */
793 image_get_hdr_b(comp) /* image_get_comp */
795 static inline char *image_get_name(const struct legacy_img_hdr *hdr)
797 return (char *)hdr->ih_name;
800 static inline uint32_t image_get_data_size(const struct legacy_img_hdr *hdr)
802 return image_get_size(hdr);
806 * image_get_data - get image payload start address
809 * image_get_data() returns address of the image payload. For single
810 * component images it is image data start. For multi component
811 * images it points to the null terminated table of sub-images sizes.
814 * image payload data start address
816 static inline ulong image_get_data(const struct legacy_img_hdr *hdr)
818 return ((ulong)hdr + image_get_header_size());
821 static inline uint32_t image_get_image_size(const struct legacy_img_hdr *hdr)
823 return (image_get_size(hdr) + image_get_header_size());
826 static inline ulong image_get_image_end(const struct legacy_img_hdr *hdr)
828 return ((ulong)hdr + image_get_image_size(hdr));
831 #define image_set_hdr_l(f) \
832 static inline void image_set_##f(struct legacy_img_hdr *hdr, uint32_t val) \
834 hdr->ih_##f = cpu_to_uimage(val); \
836 image_set_hdr_l(magic) /* image_set_magic */
837 image_set_hdr_l(hcrc) /* image_set_hcrc */
838 image_set_hdr_l(time) /* image_set_time */
839 image_set_hdr_l(size) /* image_set_size */
840 image_set_hdr_l(load) /* image_set_load */
841 image_set_hdr_l(ep) /* image_set_ep */
842 image_set_hdr_l(dcrc) /* image_set_dcrc */
844 #define image_set_hdr_b(f) \
845 static inline void image_set_##f(struct legacy_img_hdr *hdr, uint8_t val) \
849 image_set_hdr_b(os) /* image_set_os */
850 image_set_hdr_b(arch) /* image_set_arch */
851 image_set_hdr_b(type) /* image_set_type */
852 image_set_hdr_b(comp) /* image_set_comp */
854 static inline void image_set_name(struct legacy_img_hdr *hdr, const char *name)
856 strncpy(image_get_name(hdr), name, IH_NMLEN);
859 int image_check_hcrc(const struct legacy_img_hdr *hdr);
860 int image_check_dcrc(const struct legacy_img_hdr *hdr);
862 ulong env_get_bootm_low(void);
863 phys_size_t env_get_bootm_size(void);
864 phys_size_t env_get_bootm_mapsize(void);
866 void memmove_wd(void *to, void *from, size_t len, ulong chunksz);
868 static inline int image_check_magic(const struct legacy_img_hdr *hdr)
870 return (image_get_magic(hdr) == IH_MAGIC);
873 static inline int image_check_type(const struct legacy_img_hdr *hdr, uint8_t type)
875 return (image_get_type(hdr) == type);
878 static inline int image_check_arch(const struct legacy_img_hdr *hdr, uint8_t arch)
880 /* Let's assume that sandbox can load any architecture */
881 if (!tools_build() && IS_ENABLED(CONFIG_SANDBOX))
883 return (image_get_arch(hdr) == arch) ||
884 (image_get_arch(hdr) == IH_ARCH_ARM && arch == IH_ARCH_ARM64);
887 static inline int image_check_os(const struct legacy_img_hdr *hdr, uint8_t os)
889 return (image_get_os(hdr) == os);
892 ulong image_multi_count(const struct legacy_img_hdr *hdr);
893 void image_multi_getimg(const struct legacy_img_hdr *hdr, ulong idx,
894 ulong *data, ulong *len);
896 void image_print_contents(const void *hdr);
899 static inline int image_check_target_arch(const struct legacy_img_hdr *hdr)
901 #ifndef IH_ARCH_DEFAULT
902 # error "please define IH_ARCH_DEFAULT in your arch asm/u-boot.h"
904 return image_check_arch(hdr, IH_ARCH_DEFAULT);
906 #endif /* USE_HOSTCC */
909 * image_decomp_type() - Find out compression type of an image
911 * @buf: Address in U-Boot memory where image is loaded.
912 * @len: Length of the compressed image.
913 * Return: compression type or IH_COMP_NONE if not compressed.
915 * Note: Only following compression types are supported now.
916 * lzo, lzma, gzip, bzip2
918 int image_decomp_type(const unsigned char *buf, ulong len);
921 * image_decomp() - decompress an image
923 * @comp: Compression algorithm that is used (IH_COMP_...)
924 * @load: Destination load address in U-Boot memory
925 * @image_start Image start address (where we are decompressing from)
926 * @type: OS type (IH_OS_...)
927 * @load_bug: Place to decompress to
928 * @image_buf: Address to decompress from
929 * @image_len: Number of bytes in @image_buf to decompress
930 * @unc_len: Available space for decompression
931 * Return: 0 if OK, -ve on error (BOOTM_ERR_...)
933 int image_decomp(int comp, ulong load, ulong image_start, int type,
934 void *load_buf, void *image_buf, ulong image_len,
935 uint unc_len, ulong *load_end);
938 * Set up properties in the FDT
940 * This sets up properties in the FDT that is to be passed to linux.
942 * @images: Images information
943 * @blob: FDT to update
944 * @of_size: Size of the FDT
945 * @lmb: Points to logical memory block structure
946 * Return: 0 if ok, <0 on failure
948 int image_setup_libfdt(struct bootm_headers *images, void *blob,
949 int of_size, struct lmb *lmb);
952 * Set up the FDT to use for booting a kernel
954 * This performs ramdisk setup, sets up the FDT if required, and adds
955 * paramters to the FDT if libfdt is available.
957 * @param images Images information
958 * Return: 0 if ok, <0 on failure
960 int image_setup_linux(struct bootm_headers *images);
963 * bootz_setup() - Extract stat and size of a Linux xImage
965 * @image: Address of image
966 * @start: Returns start address of image
967 * @end : Returns end address of image
968 * Return: 0 if OK, 1 if the image was not recognised
970 int bootz_setup(ulong image, ulong *start, ulong *end);
973 * Return the correct start address and size of a Linux aarch64 Image.
975 * @image: Address of image
976 * @start: Returns start address of image
977 * @size : Returns size image
978 * @force_reloc: Ignore image->ep field, always place image to RAM start
979 * Return: 0 if OK, 1 if the image was not recognised
981 int booti_setup(ulong image, ulong *relocated_addr, ulong *size,
984 /*******************************************************************/
985 /* New uImage format specific code (prefixed with fit_) */
986 /*******************************************************************/
988 #define FIT_IMAGES_PATH "/images"
989 #define FIT_CONFS_PATH "/configurations"
991 /* hash/signature/key node */
992 #define FIT_HASH_NODENAME "hash"
993 #define FIT_ALGO_PROP "algo"
994 #define FIT_VALUE_PROP "value"
995 #define FIT_IGNORE_PROP "uboot-ignore"
996 #define FIT_SIG_NODENAME "signature"
997 #define FIT_KEY_REQUIRED "required"
998 #define FIT_KEY_HINT "key-name-hint"
1001 #define FIT_CIPHER_NODENAME "cipher"
1002 #define FIT_ALGO_PROP "algo"
1005 #define FIT_DATA_PROP "data"
1006 #define FIT_DATA_POSITION_PROP "data-position"
1007 #define FIT_DATA_OFFSET_PROP "data-offset"
1008 #define FIT_DATA_SIZE_PROP "data-size"
1009 #define FIT_TIMESTAMP_PROP "timestamp"
1010 #define FIT_DESC_PROP "description"
1011 #define FIT_ARCH_PROP "arch"
1012 #define FIT_TYPE_PROP "type"
1013 #define FIT_OS_PROP "os"
1014 #define FIT_COMP_PROP "compression"
1015 #define FIT_ENTRY_PROP "entry"
1016 #define FIT_LOAD_PROP "load"
1018 /* configuration node */
1019 #define FIT_KERNEL_PROP "kernel"
1020 #define FIT_RAMDISK_PROP "ramdisk"
1021 #define FIT_FDT_PROP "fdt"
1022 #define FIT_LOADABLE_PROP "loadables"
1023 #define FIT_DEFAULT_PROP "default"
1024 #define FIT_SETUP_PROP "setup"
1025 #define FIT_FPGA_PROP "fpga"
1026 #define FIT_FIRMWARE_PROP "firmware"
1027 #define FIT_STANDALONE_PROP "standalone"
1028 #define FIT_PHASE_PROP "phase"
1030 #define FIT_MAX_HASH_LEN HASH_MAX_DIGEST_SIZE
1032 /* cmdline argument format parsing */
1033 int fit_parse_conf(const char *spec, ulong addr_curr,
1034 ulong *addr, const char **conf_name);
1035 int fit_parse_subimage(const char *spec, ulong addr_curr,
1036 ulong *addr, const char **image_name);
1038 int fit_get_subimage_count(const void *fit, int images_noffset);
1039 void fit_print_contents(const void *fit);
1040 void fit_image_print(const void *fit, int noffset, const char *p);
1043 * fit_get_end - get FIT image size
1044 * @fit: pointer to the FIT format image header
1047 * size of the FIT image (blob) in memory
1049 static inline ulong fit_get_size(const void *fit)
1051 return fdt_totalsize(fit);
1055 * fit_get_end - get FIT image end
1056 * @fit: pointer to the FIT format image header
1059 * end address of the FIT image (blob) in memory
1061 ulong fit_get_end(const void *fit);
1064 * fit_get_name - get FIT node name
1065 * @fit: pointer to the FIT format image header
1069 * pointer to node name, on success
1071 static inline const char *fit_get_name(const void *fit_hdr,
1072 int noffset, int *len)
1074 return fdt_get_name(fit_hdr, noffset, len);
1077 int fit_get_desc(const void *fit, int noffset, char **desc);
1078 int fit_get_timestamp(const void *fit, int noffset, time_t *timestamp);
1080 int fit_image_get_node(const void *fit, const char *image_uname);
1081 int fit_image_get_os(const void *fit, int noffset, uint8_t *os);
1082 int fit_image_get_arch(const void *fit, int noffset, uint8_t *arch);
1083 int fit_image_get_type(const void *fit, int noffset, uint8_t *type);
1084 int fit_image_get_comp(const void *fit, int noffset, uint8_t *comp);
1085 int fit_image_get_load(const void *fit, int noffset, ulong *load);
1086 int fit_image_get_entry(const void *fit, int noffset, ulong *entry);
1087 int fit_image_get_data(const void *fit, int noffset,
1088 const void **data, size_t *size);
1089 int fit_image_get_data_offset(const void *fit, int noffset, int *data_offset);
1090 int fit_image_get_data_position(const void *fit, int noffset,
1091 int *data_position);
1092 int fit_image_get_data_size(const void *fit, int noffset, int *data_size);
1093 int fit_image_get_data_size_unciphered(const void *fit, int noffset,
1095 int fit_image_get_data_and_size(const void *fit, int noffset,
1096 const void **data, size_t *size);
1099 * fit_get_data_node() - Get verified image data for an image
1100 * @fit: Pointer to the FIT format image header
1101 * @image_uname: The name of the image node
1102 * @data: A pointer which will be filled with the location of the image data
1103 * @size: A pointer which will be filled with the size of the image data
1105 * This function looks up the location and size of an image specified by its
1106 * name. For example, if you had a FIT like::
1114 * Then you could look up the data location and size of the my-firmware image
1115 * by calling this function with @image_uname set to "my-firmware". This
1116 * function also verifies the image data (if enabled) before returning. The
1117 * image description is printed out on success. @data and @size will not be
1118 * modified on faulure.
1122 * * -EINVAL if the image could not be verified
1123 * * -ENOENT if there was a problem getting the data/size
1124 * * Another negative error if there was a problem looking up the image node.
1126 int fit_get_data_node(const void *fit, const char *image_uname,
1127 const void **data, size_t *size);
1130 * fit_get_data_conf_prop() - Get verified image data for a property in /conf
1131 * @fit: Pointer to the FIT format image header
1132 * @prop_name: The name of the property in /conf referencing the image
1133 * @data: A pointer which will be filled with the location of the image data
1134 * @size: A pointer which will be filled with the size of the image data
1136 * This function looks up the location and size of an image specified by a
1137 * property in /conf. For example, if you had a FIT like::
1146 * default = "conf-1";
1148 * some-firmware = "my-firmware";
1152 * Then you could look up the data location and size of the my-firmware image
1153 * by calling this function with @prop_name set to "some-firmware". This
1154 * function also verifies the image data (if enabled) before returning. The
1155 * image description is printed out on success. @data and @size will not be
1156 * modified on faulure.
1160 * * -EINVAL if the image could not be verified
1161 * * -ENOENT if there was a problem getting the data/size
1162 * * Another negative error if there was a problem looking up the configuration
1165 int fit_get_data_conf_prop(const void *fit, const char *prop_name,
1166 const void **data, size_t *size);
1168 int fit_image_hash_get_algo(const void *fit, int noffset, const char **algo);
1169 int fit_image_hash_get_value(const void *fit, int noffset, uint8_t **value,
1172 int fit_set_timestamp(void *fit, int noffset, time_t timestamp);
1175 * fit_pre_load_data() - add public key to fdt blob
1177 * Adds public key to the node pre load.
1179 * @keydir: Directory containing keys
1180 * @keydest: FDT blob to write public key
1181 * @fit: Pointer to the FIT format image header
1187 int fit_pre_load_data(const char *keydir, void *keydest, void *fit);
1189 int fit_cipher_data(const char *keydir, void *keydest, void *fit,
1190 const char *comment, int require_keys,
1191 const char *engine_id, const char *cmdname);
1193 #define NODE_MAX_NAME_LEN 80
1196 * struct image_summary - Provides information about signing info added
1198 * @sig_offset: Offset of the node in the blob devicetree where the signature
1200 * @sig_path: Path to @sig_offset
1201 * @keydest_offset: Offset of the node in the keydest devicetree where the
1202 * public key was written (-1 if none)
1203 * @keydest_path: Path to @keydest_offset
1205 struct image_summary {
1207 char sig_path[NODE_MAX_NAME_LEN];
1209 char keydest_path[NODE_MAX_NAME_LEN];
1213 * fit_add_verification_data() - add verification data to FIT image nodes
1215 * @keydir: Directory containing keys
1216 * @kwydest: FDT blob to write public key information to (NULL if none)
1217 * @fit: Pointer to the FIT format image header
1218 * @comment: Comment to add to signature nodes
1219 * @require_keys: Mark all keys as 'required'
1220 * @engine_id: Engine to use for signing
1221 * @cmdname: Command name used when reporting errors
1222 * @algo_name: Algorithm name, or NULL if to be read from FIT
1223 * @summary: Returns information about what data was written
1225 * Adds hash values for all component images in the FIT blob.
1226 * Hashes are calculated for all component images which have hash subnodes
1227 * with algorithm property set to one of the supported hash algorithms.
1229 * Also add signatures if signature nodes are present.
1233 * libfdt error code, on failure
1235 int fit_add_verification_data(const char *keydir, const char *keyfile,
1236 void *keydest, void *fit, const char *comment,
1237 int require_keys, const char *engine_id,
1238 const char *cmdname, const char *algo_name,
1239 struct image_summary *summary);
1242 * fit_image_verify_with_data() - Verify an image with given data
1244 * @fit: Pointer to the FIT format image header
1245 * @image_offset: Offset in @fit of image to verify
1246 * @key_blob: FDT containing public keys
1247 * @data: Image data to verify
1248 * @size: Size of image data
1250 int fit_image_verify_with_data(const void *fit, int image_noffset,
1251 const void *key_blob, const void *data,
1254 int fit_image_verify(const void *fit, int noffset);
1255 int fit_config_verify(const void *fit, int conf_noffset);
1256 int fit_all_image_verify(const void *fit);
1257 int fit_config_decrypt(const void *fit, int conf_noffset);
1258 int fit_image_check_os(const void *fit, int noffset, uint8_t os);
1259 int fit_image_check_arch(const void *fit, int noffset, uint8_t arch);
1260 int fit_image_check_type(const void *fit, int noffset, uint8_t type);
1261 int fit_image_check_comp(const void *fit, int noffset, uint8_t comp);
1264 * fit_check_format() - Check that the FIT is valid
1266 * This performs various checks on the FIT to make sure it is suitable for
1267 * use, looking for mandatory properties, nodes, etc.
1269 * If FIT_FULL_CHECK is enabled, it also runs it through libfdt to make
1270 * sure that there are no strange tags or broken nodes in the FIT.
1272 * @fit: pointer to the FIT format image header
1273 * Return: 0 if OK, -ENOEXEC if not an FDT file, -EINVAL if the full FDT check
1274 * failed (e.g. due to bad structure), -ENOMSG if the description is
1275 * missing, -EBADMSG if the timestamp is missing, -ENOENT if the /images
1278 int fit_check_format(const void *fit, ulong size);
1281 * fit_conf_find_compat() - find most compatible configuration
1282 * @fit: pointer to the FIT format image header
1283 * @fdt: pointer to the device tree to compare against
1285 * Attempts to find the configuration whose fdt is the most compatible with the
1286 * passed in device tree
1295 * |-o configurations
1303 * |-compatible = "foo,bar", "bim,bam"
1306 * |-compatible = "foo,bar",
1309 * |-compatible = "bim,bam", "baz,biz"
1311 * Configuration 1 would be picked because the first string in U-Boot's
1312 * compatible list, "foo,bar", matches a compatible string in the root of fdt1.
1313 * "bim,bam" in fdt2 matches the second string which isn't as good as fdt1.
1315 * As an optimization, the compatible property from the FDT's root node can be
1316 * copied into the configuration node in the FIT image. This is required to
1317 * match configurations with compressed FDTs.
1319 * Returns: offset to the configuration to use if one was found, -1 otherwise
1321 int fit_conf_find_compat(const void *fit, const void *fdt);
1324 * fit_conf_get_node - get node offset for configuration of a given unit name
1325 * @fit: pointer to the FIT format image header
1326 * @conf_uname: configuration node unit name (NULL to use default)
1328 * fit_conf_get_node() finds a configuration (within the '/configurations'
1329 * parent node) of a provided unit name. If configuration is found its node
1330 * offset is returned to the caller.
1332 * When NULL is provided in second argument fit_conf_get_node() will search
1333 * for a default configuration node instead. Default configuration node unit
1334 * name is retrieved from FIT_DEFAULT_PROP property of the '/configurations'
1338 * configuration node offset when found (>=0)
1339 * negative number on failure (FDT_ERR_* code)
1341 int fit_conf_get_node(const void *fit, const char *conf_uname);
1343 int fit_conf_get_prop_node_count(const void *fit, int noffset,
1344 const char *prop_name);
1345 int fit_conf_get_prop_node_index(const void *fit, int noffset,
1346 const char *prop_name, int index);
1349 * fit_conf_get_prop_node() - Get node refered to by a configuration
1350 * @fit: FIT to check
1351 * @noffset: Offset of conf@xxx node to check
1352 * @prop_name: Property to read from the conf node
1353 * @phase: Image phase to use, IH_PHASE_NONE for any
1355 * The conf- nodes contain references to other nodes, using properties
1356 * like 'kernel = "kernel"'. Given such a property name (e.g. "kernel"),
1357 * return the offset of the node referred to (e.g. offset of node
1360 int fit_conf_get_prop_node(const void *fit, int noffset, const char *prop_name,
1361 enum image_phase_t phase);
1363 int fit_check_ramdisk(const void *fit, int os_noffset,
1364 uint8_t arch, int verify);
1366 int calculate_hash(const void *data, int data_len, const char *algo,
1367 uint8_t *value, int *value_len);
1370 * At present we only support signing on the host, and verification on the
1373 #if defined(USE_HOSTCC)
1374 # if defined(CONFIG_FIT_SIGNATURE)
1375 # define IMAGE_ENABLE_SIGN 1
1376 # define FIT_IMAGE_ENABLE_VERIFY 1
1377 # include <openssl/evp.h>
1379 # define IMAGE_ENABLE_SIGN 0
1380 # define FIT_IMAGE_ENABLE_VERIFY 0
1383 # define IMAGE_ENABLE_SIGN 0
1384 # define FIT_IMAGE_ENABLE_VERIFY CONFIG_IS_ENABLED(FIT_SIGNATURE)
1388 void *image_get_host_blob(void);
1389 void image_set_host_blob(void *host_blob);
1390 # define gd_fdt_blob() image_get_host_blob()
1392 # define gd_fdt_blob() (gd->fdt_blob)
1396 * Information passed to the signing routines
1398 * Either 'keydir', 'keyname', or 'keyfile' can be NULL. However, either
1399 * 'keyfile', or both 'keydir' and 'keyname' should have valid values. If
1400 * neither are valid, some operations might fail with EINVAL.
1402 struct image_sign_info {
1403 const char *keydir; /* Directory conaining keys */
1404 const char *keyname; /* Name of key to use */
1405 const char *keyfile; /* Filename of private or public key */
1406 const void *fit; /* Pointer to FIT blob */
1407 int node_offset; /* Offset of signature node */
1408 const char *name; /* Algorithm name */
1409 struct checksum_algo *checksum; /* Checksum algorithm information */
1410 struct padding_algo *padding; /* Padding algorithm information */
1411 struct crypto_algo *crypto; /* Crypto algorithm information */
1412 const void *fdt_blob; /* FDT containing public keys */
1413 int required_keynode; /* Node offset of key to use: -1=any */
1414 const char *require_keys; /* Value for 'required' property */
1415 const char *engine_id; /* Engine to use for signing */
1417 * Note: the following two fields are always valid even w/o
1418 * RSA_VERIFY_WITH_PKEY in order to make sure this structure is
1419 * the same on target and host. Otherwise, vboot test may fail.
1421 const void *key; /* Pointer to public key in DER */
1422 int keylen; /* Length of public key */
1425 /* A part of an image, used for hashing */
1426 struct image_region {
1431 struct checksum_algo {
1433 const int checksum_len;
1435 const uint8_t *der_prefix;
1436 #if IMAGE_ENABLE_SIGN
1437 const EVP_MD *(*calculate_sign)(void);
1439 int (*calculate)(const char *name,
1440 const struct image_region *region,
1441 int region_count, uint8_t *checksum);
1444 struct crypto_algo {
1445 const char *name; /* Name of algorithm */
1449 * sign() - calculate and return signature for given input data
1451 * @info: Specifies key and FIT information
1452 * @data: Pointer to the input data
1453 * @data_len: Data length
1454 * @sigp: Set to an allocated buffer holding the signature
1455 * @sig_len: Set to length of the calculated hash
1457 * This computes input data signature according to selected algorithm.
1458 * Resulting signature value is placed in an allocated buffer, the
1459 * pointer is returned as *sigp. The length of the calculated
1460 * signature is returned via the sig_len pointer argument. The caller
1461 * should free *sigp.
1463 * @return: 0, on success, -ve on error
1465 int (*sign)(struct image_sign_info *info,
1466 const struct image_region region[],
1467 int region_count, uint8_t **sigp, uint *sig_len);
1470 * add_verify_data() - Add verification information to FDT
1472 * Add public key information to the FDT node, suitable for
1473 * verification at run-time. The information added depends on the
1474 * algorithm being used.
1476 * @info: Specifies key and FIT information
1477 * @keydest: Destination FDT blob for public key data
1478 * @return: node offset within the FDT blob where the data was written,
1481 int (*add_verify_data)(struct image_sign_info *info, void *keydest);
1484 * verify() - Verify a signature against some data
1486 * @info: Specifies key and FIT information
1487 * @data: Pointer to the input data
1488 * @data_len: Data length
1490 * @sig_len: Number of bytes in signature
1491 * @return 0 if verified, -ve on error
1493 int (*verify)(struct image_sign_info *info,
1494 const struct image_region region[], int region_count,
1495 uint8_t *sig, uint sig_len);
1498 /* Declare a new U-Boot crypto algorithm handler */
1499 #define U_BOOT_CRYPTO_ALGO(__name) \
1500 ll_entry_declare(struct crypto_algo, __name, cryptos)
1502 struct padding_algo {
1504 int (*verify)(struct image_sign_info *info,
1505 const uint8_t *pad, int pad_len,
1506 const uint8_t *hash, int hash_len);
1509 /* Declare a new U-Boot padding algorithm handler */
1510 #define U_BOOT_PADDING_ALGO(__name) \
1511 ll_entry_declare(struct padding_algo, __name, paddings)
1514 * image_get_checksum_algo() - Look up a checksum algorithm
1516 * @param full_name Name of algorithm in the form "checksum,crypto"
1517 * Return: pointer to algorithm information, or NULL if not found
1519 struct checksum_algo *image_get_checksum_algo(const char *full_name);
1522 * image_get_crypto_algo() - Look up a cryptosystem algorithm
1524 * @param full_name Name of algorithm in the form "checksum,crypto"
1525 * Return: pointer to algorithm information, or NULL if not found
1527 struct crypto_algo *image_get_crypto_algo(const char *full_name);
1530 * image_get_padding_algo() - Look up a padding algorithm
1532 * @param name Name of padding algorithm
1533 * Return: pointer to algorithm information, or NULL if not found
1535 struct padding_algo *image_get_padding_algo(const char *name);
1537 #define IMAGE_PRE_LOAD_SIG_MAGIC 0x55425348
1538 #define IMAGE_PRE_LOAD_SIG_OFFSET_MAGIC 0
1539 #define IMAGE_PRE_LOAD_SIG_OFFSET_IMG_LEN 4
1540 #define IMAGE_PRE_LOAD_SIG_OFFSET_SIG 8
1542 #define IMAGE_PRE_LOAD_PATH "/image/pre-load/sig"
1543 #define IMAGE_PRE_LOAD_PROP_ALGO_NAME "algo-name"
1544 #define IMAGE_PRE_LOAD_PROP_PADDING_NAME "padding-name"
1545 #define IMAGE_PRE_LOAD_PROP_SIG_SIZE "signature-size"
1546 #define IMAGE_PRE_LOAD_PROP_PUBLIC_KEY "public-key"
1547 #define IMAGE_PRE_LOAD_PROP_MANDATORY "mandatory"
1550 * Information in the device-tree about the signature in the header
1552 struct image_sig_info {
1553 char *algo_name; /* Name of the algo (eg: sha256,rsa2048) */
1554 char *padding_name; /* Name of the padding */
1555 uint8_t *key; /* Public signature key */
1556 int key_len; /* Length of the public key */
1557 uint32_t sig_size; /* size of the signature (in the header) */
1558 int mandatory; /* Set if the signature is mandatory */
1560 struct image_sign_info sig_info; /* Signature info */
1564 * Header of the signature header
1566 struct sig_header_s {
1569 uint32_t header_size;
1570 uint32_t image_size;
1571 uint32_t offset_img_sig;
1575 uint8_t sha256_img_sig[SHA256_SUM_LEN];
1578 #define SIG_HEADER_LEN (sizeof(struct sig_header_s))
1581 * image_pre_load() - Manage pre load header
1583 * Manage the pre-load header before launching the image.
1584 * It checks the signature of the image. It also set the
1585 * variable image_load_offset to skip this header before
1586 * launching the image.
1588 * @param addr Address of the image
1589 * @return: 0 on success, -ve on error
1591 int image_pre_load(ulong addr);
1594 * fit_image_verify_required_sigs() - Verify signatures marked as 'required'
1596 * @fit: FIT to check
1597 * @image_noffset: Offset of image node to check
1598 * @data: Image data to check
1599 * @size: Size of image data
1600 * @key_blob: FDT containing public keys
1601 * @no_sigsp: Returns 1 if no signatures were required, and
1602 * therefore nothing was checked. The caller may wish
1603 * to fall back to other mechanisms, or refuse to
1605 * Return: 0 if all verified ok, <0 on error
1607 int fit_image_verify_required_sigs(const void *fit, int image_noffset,
1608 const char *data, size_t size, const void *key_blob,
1612 * fit_image_check_sig() - Check a single image signature node
1614 * @fit: FIT to check
1615 * @noffset: Offset of signature node to check
1616 * @data: Image data to check
1617 * @size: Size of image data
1618 * @keyblob: Key blob to check (typically the control FDT)
1619 * @required_keynode: Offset in the keyblob of the required key node,
1620 * if any. If this is given, then the image wil not
1621 * pass verification unless that key is used. If this is
1622 * -1 then any signature will do.
1623 * @err_msgp: In the event of an error, this will be pointed to a
1624 * help error string to display to the user.
1625 * Return: 0 if all verified ok, <0 on error
1627 int fit_image_check_sig(const void *fit, int noffset, const void *data,
1628 size_t size, const void *key_blob, int required_keynode,
1631 int fit_image_decrypt_data(const void *fit,
1632 int image_noffset, int cipher_noffset,
1633 const void *data, size_t size,
1634 void **data_unciphered, size_t *size_unciphered);
1637 * fit_region_make_list() - Make a list of regions to hash
1639 * Given a list of FIT regions (offset, size) provided by libfdt, create
1640 * a list of regions (void *, size) for use by the signature creationg
1641 * and verification code.
1643 * @fit: FIT image to process
1644 * @fdt_regions: Regions as returned by libfdt
1645 * @count: Number of regions returned by libfdt
1646 * @region: Place to put list of regions (NULL to allocate it)
1647 * Return: pointer to list of regions, or NULL if out of memory
1649 struct image_region *fit_region_make_list(const void *fit,
1650 struct fdt_region *fdt_regions, int count,
1651 struct image_region *region);
1653 static inline int fit_image_check_target_arch(const void *fdt, int node)
1656 return fit_image_check_arch(fdt, node, IH_ARCH_DEFAULT);
1663 * At present we only support ciphering on the host, and unciphering on the
1666 #if defined(USE_HOSTCC)
1667 # if defined(CONFIG_FIT_CIPHER)
1668 # define IMAGE_ENABLE_ENCRYPT 1
1669 # define IMAGE_ENABLE_DECRYPT 1
1670 # include <openssl/evp.h>
1672 # define IMAGE_ENABLE_ENCRYPT 0
1673 # define IMAGE_ENABLE_DECRYPT 0
1676 # define IMAGE_ENABLE_ENCRYPT 0
1677 # define IMAGE_ENABLE_DECRYPT CONFIG_IS_ENABLED(FIT_CIPHER)
1680 /* Information passed to the ciphering routines */
1681 struct image_cipher_info {
1682 const char *keydir; /* Directory containing keys */
1683 const char *keyname; /* Name of key to use */
1684 const char *ivname; /* Name of IV to use */
1685 const void *fit; /* Pointer to FIT blob */
1686 int node_noffset; /* Offset of the cipher node */
1687 const char *name; /* Algorithm name */
1688 struct cipher_algo *cipher; /* Cipher algorithm information */
1689 const void *fdt_blob; /* FDT containing key and IV */
1690 const void *key; /* Value of the key */
1691 const void *iv; /* Value of the IV */
1692 size_t size_unciphered; /* Size of the unciphered data */
1695 struct cipher_algo {
1696 const char *name; /* Name of algorithm */
1697 int key_len; /* Length of the key */
1698 int iv_len; /* Length of the IV */
1700 #if IMAGE_ENABLE_ENCRYPT
1701 const EVP_CIPHER * (*calculate_type)(void);
1704 int (*encrypt)(struct image_cipher_info *info,
1705 const unsigned char *data, int data_len,
1706 unsigned char **cipher, int *cipher_len);
1708 int (*add_cipher_data)(struct image_cipher_info *info,
1709 void *keydest, void *fit, int node_noffset);
1711 int (*decrypt)(struct image_cipher_info *info,
1712 const void *cipher, size_t cipher_len,
1713 void **data, size_t *data_len);
1716 int fit_image_cipher_get_algo(const void *fit, int noffset, char **algo);
1718 struct cipher_algo *image_get_cipher_algo(const char *full_name);
1720 struct andr_img_hdr;
1721 int android_image_check_header(const struct andr_img_hdr *hdr);
1722 int android_image_get_kernel(const struct andr_img_hdr *hdr, int verify,
1723 ulong *os_data, ulong *os_len);
1724 int android_image_get_ramdisk(const struct andr_img_hdr *hdr,
1725 ulong *rd_data, ulong *rd_len);
1726 int android_image_get_second(const struct andr_img_hdr *hdr,
1727 ulong *second_data, ulong *second_len);
1728 bool android_image_get_dtbo(ulong hdr_addr, ulong *addr, u32 *size);
1729 bool android_image_get_dtb_by_index(ulong hdr_addr, u32 index, ulong *addr,
1731 ulong android_image_get_end(const struct andr_img_hdr *hdr);
1732 ulong android_image_get_kload(const struct andr_img_hdr *hdr);
1733 ulong android_image_get_kcomp(const struct andr_img_hdr *hdr);
1734 void android_print_contents(const struct andr_img_hdr *hdr);
1735 bool android_image_print_dtb_contents(ulong hdr_addr);
1738 * board_fit_config_name_match() - Check for a matching board name
1740 * This is used when SPL loads a FIT containing multiple device tree files
1741 * and wants to work out which one to use. The description of each one is
1742 * passed to this function. The description comes from the 'description' field
1743 * in each (FDT) image node.
1745 * @name: Device tree description
1746 * Return: 0 if this device tree should be used, non-zero to try the next
1748 int board_fit_config_name_match(const char *name);
1751 * board_fit_image_post_process() - Do any post-process on FIT binary data
1753 * This is used to do any sort of image manipulation, verification, decryption
1754 * etc. in a platform or board specific way. Obviously, anything done here would
1755 * need to be comprehended in how the images were prepared before being injected
1756 * into the FIT creation (i.e. the binary blobs would have been pre-processed
1757 * before being added to the FIT image).
1759 * @fit: pointer to fit image
1760 * @node: offset of image node
1761 * @image: pointer to the image start pointer
1762 * @size: pointer to the image size
1763 * Return: no return value (failure should be handled internally)
1765 void board_fit_image_post_process(const void *fit, int node, void **p_image,
1768 #define FDT_ERROR ((ulong)(-1))
1770 ulong fdt_getprop_u32(const void *fdt, int node, const char *prop);
1773 * fit_find_config_node() - Find the node for the best DTB in a FIT image
1775 * A FIT image contains one or more DTBs. This function parses the
1776 * configurations described in the FIT images and returns the node of
1777 * the first matching DTB. To check if a DTB matches a board, this function
1778 * calls board_fit_config_name_match(). If no matching DTB is found, it returns
1779 * the node described by the default configuration if it exists.
1781 * @fdt: pointer to flat device tree
1782 * Return: the node if found, -ve otherwise
1784 int fit_find_config_node(const void *fdt);
1787 * Mapping of image types to function handlers to be invoked on the associated
1790 * @type: Type of image, I.E. IH_TYPE_*
1791 * @handler: Function to call on loaded image
1793 struct fit_loadable_tbl {
1796 * handler() - Process a loaded image
1798 * @data: Pointer to start of loaded image data
1799 * @size: Size of loaded image data
1801 void (*handler)(ulong data, size_t size);
1805 * Define a FIT loadable image type handler
1807 * _type is a valid uimage_type ID as defined in the "Image Type" enum above
1808 * _handler is the handler function to call after this image type is loaded
1810 #define U_BOOT_FIT_LOADABLE_HANDLER(_type, _handler) \
1811 ll_entry_declare(struct fit_loadable_tbl, _function, fit_loadable) = { \
1813 .handler = _handler, \
1817 * fit_update - update storage with FIT image
1818 * @fit: Pointer to FIT image
1820 * Update firmware on storage using FIT image as input.
1821 * The storage area to be update will be identified by the name
1822 * in FIT and matching it to "dfu_alt_info" variable.
1824 * Return: 0 on success, non-zero otherwise
1826 int fit_update(const void *fit);
1828 #endif /* __IMAGE_H__ */