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>
29 /* new uImage format support enabled on host */
30 #define IMAGE_ENABLE_FIT 1
31 #define IMAGE_ENABLE_OF_LIBFDT 1
32 #define CONFIG_FIT_VERBOSE 1 /* enable fit_format_{error,warning}() */
33 #define CONFIG_FIT_RSASSA_PSS 1
35 #define IMAGE_ENABLE_IGNORE 0
36 #define IMAGE_INDENT_STRING ""
41 #include <asm/u-boot.h>
43 #include <linker_lists.h>
45 /* Take notice of the 'ignore' property for hashes */
46 #define IMAGE_ENABLE_IGNORE 1
47 #define IMAGE_INDENT_STRING " "
49 #define IMAGE_ENABLE_FIT CONFIG_IS_ENABLED(FIT)
50 #define IMAGE_ENABLE_OF_LIBFDT CONFIG_IS_ENABLED(OF_LIBFDT)
52 #endif /* USE_HOSTCC */
56 #include <linux/libfdt.h>
57 #include <fdt_support.h>
58 #endif /* IMAGE_ENABLE_FIT */
60 #ifdef CONFIG_SYS_BOOT_GET_CMDLINE
61 # define IMAGE_BOOT_GET_CMDLINE 1
63 # define IMAGE_BOOT_GET_CMDLINE 0
66 #ifdef CONFIG_OF_BOARD_SETUP
67 # define IMAGE_OF_BOARD_SETUP 1
69 # define IMAGE_OF_BOARD_SETUP 0
72 #ifdef CONFIG_OF_SYSTEM_SETUP
73 # define IMAGE_OF_SYSTEM_SETUP 1
75 # define IMAGE_OF_SYSTEM_SETUP 0
78 extern ulong image_load_addr; /* Default Load Address */
79 extern ulong image_save_addr; /* Default Save Address */
80 extern ulong image_save_size; /* Default Save Size */
82 /* An invalid size, meaning that the image size is not known */
83 #define IMAGE_SIZE_INVAL (-1UL)
95 * Operating System Codes
97 * The following are exposed to uImage header.
98 * New IDs *MUST* be appended at the end of the list and *NEVER*
99 * inserted for backward compatibility.
102 IH_OS_INVALID = 0, /* Invalid OS */
103 IH_OS_OPENBSD, /* OpenBSD */
104 IH_OS_NETBSD, /* NetBSD */
105 IH_OS_FREEBSD, /* FreeBSD */
106 IH_OS_4_4BSD, /* 4.4BSD */
107 IH_OS_LINUX, /* Linux */
108 IH_OS_SVR4, /* SVR4 */
109 IH_OS_ESIX, /* Esix */
110 IH_OS_SOLARIS, /* Solaris */
111 IH_OS_IRIX, /* Irix */
113 IH_OS_DELL, /* Dell */
115 IH_OS_LYNXOS, /* LynxOS */
116 IH_OS_VXWORKS, /* VxWorks */
117 IH_OS_PSOS, /* pSOS */
119 IH_OS_U_BOOT, /* Firmware */
120 IH_OS_RTEMS, /* RTEMS */
121 IH_OS_ARTOS, /* ARTOS */
122 IH_OS_UNITY, /* Unity OS */
123 IH_OS_INTEGRITY, /* INTEGRITY */
125 IH_OS_PLAN9, /* Plan 9 */
126 IH_OS_OPENRTOS, /* OpenRTOS */
127 IH_OS_ARM_TRUSTED_FIRMWARE, /* ARM Trusted Firmware */
128 IH_OS_TEE, /* Trusted Execution Environment */
129 IH_OS_OPENSBI, /* RISC-V OpenSBI */
130 IH_OS_EFI, /* EFI Firmware (e.g. GRUB2) */
136 * CPU Architecture Codes (supported by Linux)
138 * The following are exposed to uImage header.
139 * New IDs *MUST* be appended at the end of the list and *NEVER*
140 * inserted for backward compatibility.
143 IH_ARCH_INVALID = 0, /* Invalid CPU */
144 IH_ARCH_ALPHA, /* Alpha */
145 IH_ARCH_ARM, /* ARM */
146 IH_ARCH_I386, /* Intel x86 */
147 IH_ARCH_IA64, /* IA64 */
148 IH_ARCH_MIPS, /* MIPS */
149 IH_ARCH_MIPS64, /* MIPS 64 Bit */
150 IH_ARCH_PPC, /* PowerPC */
151 IH_ARCH_S390, /* IBM S390 */
152 IH_ARCH_SH, /* SuperH */
153 IH_ARCH_SPARC, /* Sparc */
154 IH_ARCH_SPARC64, /* Sparc 64 Bit */
155 IH_ARCH_M68K, /* M68K */
156 IH_ARCH_NIOS, /* Nios-32 */
157 IH_ARCH_MICROBLAZE, /* MicroBlaze */
158 IH_ARCH_NIOS2, /* Nios-II */
159 IH_ARCH_BLACKFIN, /* Blackfin */
160 IH_ARCH_AVR32, /* AVR32 */
161 IH_ARCH_ST200, /* STMicroelectronics ST200 */
162 IH_ARCH_SANDBOX, /* Sandbox architecture (test only) */
163 IH_ARCH_NDS32, /* ANDES Technology - NDS32 */
164 IH_ARCH_OPENRISC, /* OpenRISC 1000 */
165 IH_ARCH_ARM64, /* ARM64 */
166 IH_ARCH_ARC, /* Synopsys DesignWare ARC */
167 IH_ARCH_X86_64, /* AMD x86_64, Intel and Via */
168 IH_ARCH_XTENSA, /* Xtensa */
169 IH_ARCH_RISCV, /* RISC-V */
177 * "Standalone Programs" are directly runnable in the environment
178 * provided by U-Boot; it is expected that (if they behave
179 * well) you can continue to work in U-Boot after return from
180 * the Standalone Program.
181 * "OS Kernel Images" are usually images of some Embedded OS which
182 * will take over control completely. Usually these programs
183 * will install their own set of exception handlers, device
184 * drivers, set up the MMU, etc. - this means, that you cannot
185 * expect to re-enter U-Boot except by resetting the CPU.
186 * "RAMDisk Images" are more or less just data blocks, and their
187 * parameters (address, size) are passed to an OS kernel that is
189 * "Multi-File Images" contain several images, typically an OS
190 * (Linux) kernel image and one or more data images like
191 * RAMDisks. This construct is useful for instance when you want
192 * to boot over the network using BOOTP etc., where the boot
193 * server provides just a single image file, but you want to get
194 * for instance an OS kernel and a RAMDisk image.
196 * "Multi-File Images" start with a list of image sizes, each
197 * image size (in bytes) specified by an "uint32_t" in network
198 * byte order. This list is terminated by an "(uint32_t)0".
199 * Immediately after the terminating 0 follow the images, one by
200 * one, all aligned on "uint32_t" boundaries (size rounded up to
201 * a multiple of 4 bytes - except for the last file).
203 * "Firmware Images" are binary images containing firmware (like
204 * U-Boot or FPGA images) which usually will be programmed to
207 * "Script files" are command sequences that will be executed by
208 * U-Boot's command interpreter; this feature is especially
209 * useful when you configure U-Boot to use a real shell (hush)
210 * as command interpreter (=> Shell Scripts).
212 * The following are exposed to uImage header.
213 * New IDs *MUST* be appended at the end of the list and *NEVER*
214 * inserted for backward compatibility.
218 IH_TYPE_INVALID = 0, /* Invalid Image */
219 IH_TYPE_STANDALONE, /* Standalone Program */
220 IH_TYPE_KERNEL, /* OS Kernel Image */
221 IH_TYPE_RAMDISK, /* RAMDisk Image */
222 IH_TYPE_MULTI, /* Multi-File Image */
223 IH_TYPE_FIRMWARE, /* Firmware Image */
224 IH_TYPE_SCRIPT, /* Script file */
225 IH_TYPE_FILESYSTEM, /* Filesystem Image (any type) */
226 IH_TYPE_FLATDT, /* Binary Flat Device Tree Blob */
227 IH_TYPE_KWBIMAGE, /* Kirkwood Boot Image */
228 IH_TYPE_IMXIMAGE, /* Freescale IMXBoot Image */
229 IH_TYPE_UBLIMAGE, /* Davinci UBL Image */
230 IH_TYPE_OMAPIMAGE, /* TI OMAP Config Header Image */
231 IH_TYPE_AISIMAGE, /* TI Davinci AIS Image */
232 /* OS Kernel Image, can run from any load address */
233 IH_TYPE_KERNEL_NOLOAD,
234 IH_TYPE_PBLIMAGE, /* Freescale PBL Boot Image */
235 IH_TYPE_MXSIMAGE, /* Freescale MXSBoot Image */
236 IH_TYPE_GPIMAGE, /* TI Keystone GPHeader Image */
237 IH_TYPE_ATMELIMAGE, /* ATMEL ROM bootable Image */
238 IH_TYPE_SOCFPGAIMAGE, /* Altera SOCFPGA CV/AV Preloader */
239 IH_TYPE_X86_SETUP, /* x86 setup.bin Image */
240 IH_TYPE_LPC32XXIMAGE, /* x86 setup.bin Image */
241 IH_TYPE_LOADABLE, /* A list of typeless images */
242 IH_TYPE_RKIMAGE, /* Rockchip Boot Image */
243 IH_TYPE_RKSD, /* Rockchip SD card */
244 IH_TYPE_RKSPI, /* Rockchip SPI image */
245 IH_TYPE_ZYNQIMAGE, /* Xilinx Zynq Boot Image */
246 IH_TYPE_ZYNQMPIMAGE, /* Xilinx ZynqMP Boot Image */
247 IH_TYPE_ZYNQMPBIF, /* Xilinx ZynqMP Boot Image (bif) */
248 IH_TYPE_FPGA, /* FPGA Image */
249 IH_TYPE_VYBRIDIMAGE, /* VYBRID .vyb Image */
250 IH_TYPE_TEE, /* Trusted Execution Environment OS Image */
251 IH_TYPE_FIRMWARE_IVT, /* Firmware Image with HABv4 IVT */
252 IH_TYPE_PMMC, /* TI Power Management Micro-Controller Firmware */
253 IH_TYPE_STM32IMAGE, /* STMicroelectronics STM32 Image */
254 IH_TYPE_SOCFPGAIMAGE_V1, /* Altera SOCFPGA A10 Preloader */
255 IH_TYPE_MTKIMAGE, /* MediaTek BootROM loadable Image */
256 IH_TYPE_IMX8MIMAGE, /* Freescale IMX8MBoot Image */
257 IH_TYPE_IMX8IMAGE, /* Freescale IMX8Boot Image */
258 IH_TYPE_COPRO, /* Coprocessor Image for remoteproc*/
259 IH_TYPE_SUNXI_EGON, /* Allwinner eGON Boot Image */
261 IH_TYPE_COUNT, /* Number of image types */
267 * The following are exposed to uImage header.
268 * New IDs *MUST* be appended at the end of the list and *NEVER*
269 * inserted for backward compatibility.
272 IH_COMP_NONE = 0, /* No Compression Used */
273 IH_COMP_GZIP, /* gzip Compression Used */
274 IH_COMP_BZIP2, /* bzip2 Compression Used */
275 IH_COMP_LZMA, /* lzma Compression Used */
276 IH_COMP_LZO, /* lzo Compression Used */
277 IH_COMP_LZ4, /* lz4 Compression Used */
278 IH_COMP_ZSTD, /* zstd Compression Used */
283 #define LZ4F_MAGIC 0x184D2204 /* LZ4 Magic Number */
284 #define IH_MAGIC 0x27051956 /* Image Magic Number */
285 #define IH_NMLEN 32 /* Image Name Length */
287 /* Reused from common.h */
288 #define ROUND(a, b) (((a) + (b) - 1) & ~((b) - 1))
291 * Legacy format image header,
292 * all data in network byte order (aka natural aka bigendian).
294 typedef struct image_header {
295 uint32_t ih_magic; /* Image Header Magic Number */
296 uint32_t ih_hcrc; /* Image Header CRC Checksum */
297 uint32_t ih_time; /* Image Creation Timestamp */
298 uint32_t ih_size; /* Image Data Size */
299 uint32_t ih_load; /* Data Load Address */
300 uint32_t ih_ep; /* Entry Point Address */
301 uint32_t ih_dcrc; /* Image Data CRC Checksum */
302 uint8_t ih_os; /* Operating System */
303 uint8_t ih_arch; /* CPU architecture */
304 uint8_t ih_type; /* Image Type */
305 uint8_t ih_comp; /* Compression Type */
306 uint8_t ih_name[IH_NMLEN]; /* Image Name */
309 typedef struct image_info {
310 ulong start, end; /* start/end of blob */
311 ulong image_start, image_len; /* start of image within blob, len of image */
312 ulong load; /* load addr for the image */
313 uint8_t comp, type, os; /* compression, type of image, os type */
314 uint8_t arch; /* CPU architecture */
318 * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
321 typedef struct bootm_headers {
323 * Legacy os image header, if it is a multi component image
324 * then boot_get_ramdisk() and get_fdt() will attempt to get
325 * data from second and third component accordingly.
327 image_header_t *legacy_hdr_os; /* image header pointer */
328 image_header_t legacy_hdr_os_copy; /* header copy */
329 ulong legacy_hdr_valid;
332 const char *fit_uname_cfg; /* configuration node unit name */
334 void *fit_hdr_os; /* os FIT image header */
335 const char *fit_uname_os; /* os subimage node unit name */
336 int fit_noffset_os; /* os subimage node offset */
338 void *fit_hdr_rd; /* init ramdisk FIT image header */
339 const char *fit_uname_rd; /* init ramdisk subimage node unit name */
340 int fit_noffset_rd; /* init ramdisk subimage node offset */
342 void *fit_hdr_fdt; /* FDT blob FIT image header */
343 const char *fit_uname_fdt; /* FDT blob subimage node unit name */
344 int fit_noffset_fdt;/* FDT blob subimage node offset */
346 void *fit_hdr_setup; /* x86 setup FIT image header */
347 const char *fit_uname_setup; /* x86 setup subimage node name */
348 int fit_noffset_setup;/* x86 setup subimage node offset */
352 image_info_t os; /* os image info */
353 ulong ep; /* entry point of OS */
355 ulong rd_start, rd_end;/* ramdisk start/end */
357 char *ft_addr; /* flat dev tree address */
358 ulong ft_len; /* length of flat device tree */
367 int verify; /* env_get("verify")[0] != 'n' */
369 #define BOOTM_STATE_START (0x00000001)
370 #define BOOTM_STATE_FINDOS (0x00000002)
371 #define BOOTM_STATE_FINDOTHER (0x00000004)
372 #define BOOTM_STATE_LOADOS (0x00000008)
373 #define BOOTM_STATE_RAMDISK (0x00000010)
374 #define BOOTM_STATE_FDT (0x00000020)
375 #define BOOTM_STATE_OS_CMDLINE (0x00000040)
376 #define BOOTM_STATE_OS_BD_T (0x00000080)
377 #define BOOTM_STATE_OS_PREP (0x00000100)
378 #define BOOTM_STATE_OS_FAKE_GO (0x00000200) /* 'Almost' run the OS */
379 #define BOOTM_STATE_OS_GO (0x00000400)
382 #if defined(CONFIG_LMB) && !defined(USE_HOSTCC)
383 struct lmb lmb; /* for memory mgmt */
387 extern bootm_headers_t images;
390 * Some systems (for example LWMON) have very short watchdog periods;
391 * we must make sure to split long operations like memmove() or
392 * checksum calculations into reasonable chunks.
395 #define CHUNKSZ (64 * 1024)
398 #ifndef CHUNKSZ_CRC32
399 #define CHUNKSZ_CRC32 (64 * 1024)
403 #define CHUNKSZ_MD5 (64 * 1024)
407 #define CHUNKSZ_SHA1 (64 * 1024)
410 #define uimage_to_cpu(x) be32_to_cpu(x)
411 #define cpu_to_uimage(x) cpu_to_be32(x)
414 * Translation table for entries of a specific type; used by
415 * get_table_entry_id() and get_table_entry_name().
417 typedef struct table_entry {
419 char *sname; /* short (input) name to find table entry */
420 char *lname; /* long (output) name to print for messages */
424 * Compression type and magic number mapping table.
426 struct comp_magic_map {
429 unsigned char magic[2];
433 * get_table_entry_id() scans the translation table trying to find an
434 * entry that matches the given short name. If a matching entry is
435 * found, it's id is returned to the caller.
437 int get_table_entry_id(const table_entry_t *table,
438 const char *table_name, const char *name);
440 * get_table_entry_name() scans the translation table trying to find
441 * an entry that matches the given id. If a matching entry is found,
442 * its long name is returned to the caller.
444 char *get_table_entry_name(const table_entry_t *table, char *msg, int id);
446 const char *genimg_get_os_name(uint8_t os);
449 * genimg_get_os_short_name() - get the short name for an OS
451 * @param os OS (IH_OS_...)
452 * @return OS short name, or "unknown" if unknown
454 const char *genimg_get_os_short_name(uint8_t comp);
456 const char *genimg_get_arch_name(uint8_t arch);
459 * genimg_get_arch_short_name() - get the short name for an architecture
461 * @param arch Architecture type (IH_ARCH_...)
462 * @return architecture short name, or "unknown" if unknown
464 const char *genimg_get_arch_short_name(uint8_t arch);
466 const char *genimg_get_type_name(uint8_t type);
469 * genimg_get_type_short_name() - get the short name for an image type
471 * @param type Image type (IH_TYPE_...)
472 * @return image short name, or "unknown" if unknown
474 const char *genimg_get_type_short_name(uint8_t type);
476 const char *genimg_get_comp_name(uint8_t comp);
479 * genimg_get_comp_short_name() - get the short name for a compression method
481 * @param comp compression method (IH_COMP_...)
482 * @return compression method short name, or "unknown" if unknown
484 const char *genimg_get_comp_short_name(uint8_t comp);
487 * genimg_get_cat_name() - Get the name of an item in a category
489 * @category: Category of item
491 * @return name of item, or "Unknown ..." if unknown
493 const char *genimg_get_cat_name(enum ih_category category, uint id);
496 * genimg_get_cat_short_name() - Get the short name of an item in a category
498 * @category: Category of item
500 * @return short name of item, or "Unknown ..." if unknown
502 const char *genimg_get_cat_short_name(enum ih_category category, uint id);
505 * genimg_get_cat_count() - Get the number of items in a category
507 * @category: Category to check
508 * @return the number of items in the category (IH_xxx_COUNT)
510 int genimg_get_cat_count(enum ih_category category);
513 * genimg_get_cat_desc() - Get the description of a category
515 * @category: Category to check
516 * @return the description of a category, e.g. "architecture". This
517 * effectively converts the enum to a string.
519 const char *genimg_get_cat_desc(enum ih_category category);
522 * genimg_cat_has_id() - Check whether a category has an item
524 * @category: Category to check
526 * @return true or false as to whether a category has an item
528 bool genimg_cat_has_id(enum ih_category category, uint id);
530 int genimg_get_os_id(const char *name);
531 int genimg_get_arch_id(const char *name);
532 int genimg_get_type_id(const char *name);
533 int genimg_get_comp_id(const char *name);
534 void genimg_print_size(uint32_t size);
536 #if defined(CONFIG_TIMESTAMP) || defined(CONFIG_CMD_DATE) || \
538 #define IMAGE_ENABLE_TIMESTAMP 1
540 #define IMAGE_ENABLE_TIMESTAMP 0
542 void genimg_print_time(time_t timestamp);
544 /* What to do with a image load address ('load = <> 'in the FIT) */
546 FIT_LOAD_IGNORED, /* Ignore load address */
547 FIT_LOAD_OPTIONAL, /* Can be provided, but optional */
548 FIT_LOAD_OPTIONAL_NON_ZERO, /* Optional, a value of 0 is ignored */
549 FIT_LOAD_REQUIRED, /* Must be provided */
552 int boot_get_setup(bootm_headers_t *images, uint8_t arch, ulong *setup_start,
556 /* Image format types, returned by _get_format() routine */
557 #define IMAGE_FORMAT_INVALID 0x00
558 #if defined(CONFIG_LEGACY_IMAGE_FORMAT)
559 #define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */
561 #define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */
562 #define IMAGE_FORMAT_ANDROID 0x03 /* Android boot image */
564 ulong genimg_get_kernel_addr_fit(char * const img_addr,
565 const char **fit_uname_config,
566 const char **fit_uname_kernel);
567 ulong genimg_get_kernel_addr(char * const img_addr);
568 int genimg_get_format(const void *img_addr);
569 int genimg_has_config(bootm_headers_t *images);
571 int boot_get_fpga(int argc, char *const argv[], bootm_headers_t *images,
572 uint8_t arch, const ulong *ld_start, ulong * const ld_len);
573 int boot_get_ramdisk(int argc, char *const argv[], bootm_headers_t *images,
574 uint8_t arch, ulong *rd_start, ulong *rd_end);
577 * boot_get_loadable - routine to load a list of binaries to memory
578 * @argc: Ignored Argument
579 * @argv: Ignored Argument
580 * @images: pointer to the bootm images structure
581 * @arch: expected architecture for the image
582 * @ld_start: Ignored Argument
583 * @ld_len: Ignored Argument
585 * boot_get_loadable() will take the given FIT configuration, and look
586 * for a field named "loadables". Loadables, is a list of elements in
587 * the FIT given as strings. exe:
588 * loadables = "linux_kernel", "fdt-2";
589 * this function will attempt to parse each string, and load the
590 * corresponding element from the FIT into memory. Once placed,
591 * no aditional actions are taken.
594 * 0, if only valid images or no images are found
595 * error code, if an error occurs during fit_image_load
597 int boot_get_loadable(int argc, char *const argv[], bootm_headers_t *images,
598 uint8_t arch, const ulong *ld_start, ulong *const ld_len);
599 #endif /* !USE_HOSTCC */
601 int boot_get_setup_fit(bootm_headers_t *images, uint8_t arch,
602 ulong *setup_start, ulong *setup_len);
605 * boot_get_fdt_fit() - load a DTB from a FIT file (applying overlays)
607 * This deals with all aspects of loading an DTB from a FIT.
608 * The correct base image based on configuration will be selected, and
609 * then any overlays specified will be applied (as present in fit_uname_configp).
611 * @param images Boot images structure
612 * @param addr Address of FIT in memory
613 * @param fit_unamep On entry this is the requested image name
614 * (e.g. "kernel") or NULL to use the default. On exit
615 * points to the selected image name
616 * @param fit_uname_configp On entry this is the requested configuration
617 * name (e.g. "conf-1") or NULL to use the default. On
618 * exit points to the selected configuration name.
619 * @param arch Expected architecture (IH_ARCH_...)
620 * @param datap Returns address of loaded image
621 * @param lenp Returns length of loaded image
623 * @return node offset of base image, or -ve error code on error
625 int boot_get_fdt_fit(bootm_headers_t *images, ulong addr,
626 const char **fit_unamep, const char **fit_uname_configp,
627 int arch, ulong *datap, ulong *lenp);
630 * fit_image_load() - load an image from a FIT
632 * This deals with all aspects of loading an image from a FIT, including
633 * selecting the right image based on configuration, verifying it, printing
634 * out progress messages, checking the type/arch/os and optionally copying it
635 * to the right load address.
637 * The property to look up is defined by image_type.
639 * @param images Boot images structure
640 * @param addr Address of FIT in memory
641 * @param fit_unamep On entry this is the requested image name
642 * (e.g. "kernel") or NULL to use the default. On exit
643 * points to the selected image name
644 * @param fit_uname_configp On entry this is the requested configuration
645 * name (e.g. "conf-1") or NULL to use the default. On
646 * exit points to the selected configuration name.
647 * @param arch Expected architecture (IH_ARCH_...)
648 * @param image_type Required image type (IH_TYPE_...). If this is
649 * IH_TYPE_KERNEL then we allow IH_TYPE_KERNEL_NOLOAD
651 * @param bootstage_id ID of starting bootstage to use for progress updates.
652 * This will be added to the BOOTSTAGE_SUB values when
653 * calling bootstage_mark()
654 * @param load_op Decribes what to do with the load address
655 * @param datap Returns address of loaded image
656 * @param lenp Returns length of loaded image
657 * @return node offset of image, or -ve error code on error
659 int fit_image_load(bootm_headers_t *images, ulong addr,
660 const char **fit_unamep, const char **fit_uname_configp,
661 int arch, int image_type, int bootstage_id,
662 enum fit_load_op load_op, ulong *datap, ulong *lenp);
665 * image_source_script() - Execute a script
667 * Executes a U-Boot script at a particular address in memory. The script should
668 * have a header (FIT or legacy) with the script type (IH_TYPE_SCRIPT).
670 * @addr: Address of script
671 * @fit_uname: FIT subimage name
672 * @return result code (enum command_ret_t)
674 int image_source_script(ulong addr, const char *fit_uname);
678 * fit_get_node_from_config() - Look up an image a FIT by type
680 * This looks in the selected conf- node (images->fit_uname_cfg) for a
681 * particular image type (e.g. "kernel") and then finds the image that is
684 * For example, for something like:
697 * the function will return the node offset of the kernel@1 node, assuming
698 * that conf-1 is the chosen configuration.
700 * @param images Boot images structure
701 * @param prop_name Property name to look up (FIT_..._PROP)
702 * @param addr Address of FIT in memory
704 int fit_get_node_from_config(bootm_headers_t *images, const char *prop_name,
707 int boot_get_fdt(int flag, int argc, char *const argv[], uint8_t arch,
708 bootm_headers_t *images,
709 char **of_flat_tree, ulong *of_size);
710 void boot_fdt_add_mem_rsv_regions(struct lmb *lmb, void *fdt_blob);
711 int boot_relocate_fdt(struct lmb *lmb, char **of_flat_tree, ulong *of_size);
713 int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len,
714 ulong *initrd_start, ulong *initrd_end);
715 int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end);
716 #ifdef CONFIG_SYS_BOOT_GET_KBD
717 int boot_get_kbd(struct lmb *lmb, struct bd_info **kbd);
718 #endif /* CONFIG_SYS_BOOT_GET_KBD */
719 #endif /* !USE_HOSTCC */
721 /*******************************************************************/
722 /* Legacy format specific code (prefixed with image_) */
723 /*******************************************************************/
724 static inline uint32_t image_get_header_size(void)
726 return (sizeof(image_header_t));
729 #define image_get_hdr_l(f) \
730 static inline uint32_t image_get_##f(const image_header_t *hdr) \
732 return uimage_to_cpu(hdr->ih_##f); \
734 image_get_hdr_l(magic) /* image_get_magic */
735 image_get_hdr_l(hcrc) /* image_get_hcrc */
736 image_get_hdr_l(time) /* image_get_time */
737 image_get_hdr_l(size) /* image_get_size */
738 image_get_hdr_l(load) /* image_get_load */
739 image_get_hdr_l(ep) /* image_get_ep */
740 image_get_hdr_l(dcrc) /* image_get_dcrc */
742 #define image_get_hdr_b(f) \
743 static inline uint8_t image_get_##f(const image_header_t *hdr) \
745 return hdr->ih_##f; \
747 image_get_hdr_b(os) /* image_get_os */
748 image_get_hdr_b(arch) /* image_get_arch */
749 image_get_hdr_b(type) /* image_get_type */
750 image_get_hdr_b(comp) /* image_get_comp */
752 static inline char *image_get_name(const image_header_t *hdr)
754 return (char *)hdr->ih_name;
757 static inline uint32_t image_get_data_size(const image_header_t *hdr)
759 return image_get_size(hdr);
763 * image_get_data - get image payload start address
766 * image_get_data() returns address of the image payload. For single
767 * component images it is image data start. For multi component
768 * images it points to the null terminated table of sub-images sizes.
771 * image payload data start address
773 static inline ulong image_get_data(const image_header_t *hdr)
775 return ((ulong)hdr + image_get_header_size());
778 static inline uint32_t image_get_image_size(const image_header_t *hdr)
780 return (image_get_size(hdr) + image_get_header_size());
782 static inline ulong image_get_image_end(const image_header_t *hdr)
784 return ((ulong)hdr + image_get_image_size(hdr));
787 #define image_set_hdr_l(f) \
788 static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
790 hdr->ih_##f = cpu_to_uimage(val); \
792 image_set_hdr_l(magic) /* image_set_magic */
793 image_set_hdr_l(hcrc) /* image_set_hcrc */
794 image_set_hdr_l(time) /* image_set_time */
795 image_set_hdr_l(size) /* image_set_size */
796 image_set_hdr_l(load) /* image_set_load */
797 image_set_hdr_l(ep) /* image_set_ep */
798 image_set_hdr_l(dcrc) /* image_set_dcrc */
800 #define image_set_hdr_b(f) \
801 static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
805 image_set_hdr_b(os) /* image_set_os */
806 image_set_hdr_b(arch) /* image_set_arch */
807 image_set_hdr_b(type) /* image_set_type */
808 image_set_hdr_b(comp) /* image_set_comp */
810 static inline void image_set_name(image_header_t *hdr, const char *name)
812 strncpy(image_get_name(hdr), name, IH_NMLEN);
815 int image_check_hcrc(const image_header_t *hdr);
816 int image_check_dcrc(const image_header_t *hdr);
818 ulong env_get_bootm_low(void);
819 phys_size_t env_get_bootm_size(void);
820 phys_size_t env_get_bootm_mapsize(void);
822 void memmove_wd(void *to, void *from, size_t len, ulong chunksz);
824 static inline int image_check_magic(const image_header_t *hdr)
826 return (image_get_magic(hdr) == IH_MAGIC);
828 static inline int image_check_type(const image_header_t *hdr, uint8_t type)
830 return (image_get_type(hdr) == type);
832 static inline int image_check_arch(const image_header_t *hdr, uint8_t arch)
835 /* Let's assume that sandbox can load any architecture */
836 if (IS_ENABLED(CONFIG_SANDBOX))
839 return (image_get_arch(hdr) == arch) ||
840 (image_get_arch(hdr) == IH_ARCH_ARM && arch == IH_ARCH_ARM64);
842 static inline int image_check_os(const image_header_t *hdr, uint8_t os)
844 return (image_get_os(hdr) == os);
847 ulong image_multi_count(const image_header_t *hdr);
848 void image_multi_getimg(const image_header_t *hdr, ulong idx,
849 ulong *data, ulong *len);
851 void image_print_contents(const void *hdr);
854 static inline int image_check_target_arch(const image_header_t *hdr)
856 #ifndef IH_ARCH_DEFAULT
857 # error "please define IH_ARCH_DEFAULT in your arch asm/u-boot.h"
859 return image_check_arch(hdr, IH_ARCH_DEFAULT);
861 #endif /* USE_HOSTCC */
864 * image_decomp_type() - Find out compression type of an image
866 * @buf: Address in U-Boot memory where image is loaded.
867 * @len: Length of the compressed image.
868 * @return compression type or IH_COMP_NONE if not compressed.
870 * Note: Only following compression types are supported now.
871 * lzo, lzma, gzip, bzip2
873 int image_decomp_type(const unsigned char *buf, ulong len);
876 * image_decomp() - decompress an image
878 * @comp: Compression algorithm that is used (IH_COMP_...)
879 * @load: Destination load address in U-Boot memory
880 * @image_start Image start address (where we are decompressing from)
881 * @type: OS type (IH_OS_...)
882 * @load_bug: Place to decompress to
883 * @image_buf: Address to decompress from
884 * @image_len: Number of bytes in @image_buf to decompress
885 * @unc_len: Available space for decompression
886 * @return 0 if OK, -ve on error (BOOTM_ERR_...)
888 int image_decomp(int comp, ulong load, ulong image_start, int type,
889 void *load_buf, void *image_buf, ulong image_len,
890 uint unc_len, ulong *load_end);
893 * Set up properties in the FDT
895 * This sets up properties in the FDT that is to be passed to linux.
897 * @images: Images information
898 * @blob: FDT to update
899 * @of_size: Size of the FDT
900 * @lmb: Points to logical memory block structure
901 * @return 0 if ok, <0 on failure
903 int image_setup_libfdt(bootm_headers_t *images, void *blob,
904 int of_size, struct lmb *lmb);
907 * Set up the FDT to use for booting a kernel
909 * This performs ramdisk setup, sets up the FDT if required, and adds
910 * paramters to the FDT if libfdt is available.
912 * @param images Images information
913 * @return 0 if ok, <0 on failure
915 int image_setup_linux(bootm_headers_t *images);
918 * bootz_setup() - Extract stat and size of a Linux xImage
920 * @image: Address of image
921 * @start: Returns start address of image
922 * @end : Returns end address of image
923 * @return 0 if OK, 1 if the image was not recognised
925 int bootz_setup(ulong image, ulong *start, ulong *end);
928 * Return the correct start address and size of a Linux aarch64 Image.
930 * @image: Address of image
931 * @start: Returns start address of image
932 * @size : Returns size image
933 * @force_reloc: Ignore image->ep field, always place image to RAM start
934 * @return 0 if OK, 1 if the image was not recognised
936 int booti_setup(ulong image, ulong *relocated_addr, ulong *size,
939 /*******************************************************************/
940 /* New uImage format specific code (prefixed with fit_) */
941 /*******************************************************************/
943 #define FIT_IMAGES_PATH "/images"
944 #define FIT_CONFS_PATH "/configurations"
946 /* hash/signature/key node */
947 #define FIT_HASH_NODENAME "hash"
948 #define FIT_ALGO_PROP "algo"
949 #define FIT_VALUE_PROP "value"
950 #define FIT_IGNORE_PROP "uboot-ignore"
951 #define FIT_SIG_NODENAME "signature"
952 #define FIT_KEY_REQUIRED "required"
953 #define FIT_KEY_HINT "key-name-hint"
956 #define FIT_CIPHER_NODENAME "cipher"
957 #define FIT_ALGO_PROP "algo"
960 #define FIT_DATA_PROP "data"
961 #define FIT_DATA_POSITION_PROP "data-position"
962 #define FIT_DATA_OFFSET_PROP "data-offset"
963 #define FIT_DATA_SIZE_PROP "data-size"
964 #define FIT_TIMESTAMP_PROP "timestamp"
965 #define FIT_DESC_PROP "description"
966 #define FIT_ARCH_PROP "arch"
967 #define FIT_TYPE_PROP "type"
968 #define FIT_OS_PROP "os"
969 #define FIT_COMP_PROP "compression"
970 #define FIT_ENTRY_PROP "entry"
971 #define FIT_LOAD_PROP "load"
973 /* configuration node */
974 #define FIT_KERNEL_PROP "kernel"
975 #define FIT_RAMDISK_PROP "ramdisk"
976 #define FIT_FDT_PROP "fdt"
977 #define FIT_LOADABLE_PROP "loadables"
978 #define FIT_DEFAULT_PROP "default"
979 #define FIT_SETUP_PROP "setup"
980 #define FIT_FPGA_PROP "fpga"
981 #define FIT_FIRMWARE_PROP "firmware"
982 #define FIT_STANDALONE_PROP "standalone"
984 #define FIT_MAX_HASH_LEN HASH_MAX_DIGEST_SIZE
987 /* cmdline argument format parsing */
988 int fit_parse_conf(const char *spec, ulong addr_curr,
989 ulong *addr, const char **conf_name);
990 int fit_parse_subimage(const char *spec, ulong addr_curr,
991 ulong *addr, const char **image_name);
993 int fit_get_subimage_count(const void *fit, int images_noffset);
994 void fit_print_contents(const void *fit);
995 void fit_image_print(const void *fit, int noffset, const char *p);
998 * fit_get_end - get FIT image size
999 * @fit: pointer to the FIT format image header
1002 * size of the FIT image (blob) in memory
1004 static inline ulong fit_get_size(const void *fit)
1006 return fdt_totalsize(fit);
1010 * fit_get_end - get FIT image end
1011 * @fit: pointer to the FIT format image header
1014 * end address of the FIT image (blob) in memory
1016 ulong fit_get_end(const void *fit);
1019 * fit_get_name - get FIT node name
1020 * @fit: pointer to the FIT format image header
1024 * pointer to node name, on success
1026 static inline const char *fit_get_name(const void *fit_hdr,
1027 int noffset, int *len)
1029 return fdt_get_name(fit_hdr, noffset, len);
1032 int fit_get_desc(const void *fit, int noffset, char **desc);
1033 int fit_get_timestamp(const void *fit, int noffset, time_t *timestamp);
1035 int fit_image_get_node(const void *fit, const char *image_uname);
1036 int fit_image_get_os(const void *fit, int noffset, uint8_t *os);
1037 int fit_image_get_arch(const void *fit, int noffset, uint8_t *arch);
1038 int fit_image_get_type(const void *fit, int noffset, uint8_t *type);
1039 int fit_image_get_comp(const void *fit, int noffset, uint8_t *comp);
1040 int fit_image_get_load(const void *fit, int noffset, ulong *load);
1041 int fit_image_get_entry(const void *fit, int noffset, ulong *entry);
1042 int fit_image_get_data(const void *fit, int noffset,
1043 const void **data, size_t *size);
1044 int fit_image_get_data_offset(const void *fit, int noffset, int *data_offset);
1045 int fit_image_get_data_position(const void *fit, int noffset,
1046 int *data_position);
1047 int fit_image_get_data_size(const void *fit, int noffset, int *data_size);
1048 int fit_image_get_data_size_unciphered(const void *fit, int noffset,
1050 int fit_image_get_data_and_size(const void *fit, int noffset,
1051 const void **data, size_t *size);
1053 int fit_image_hash_get_algo(const void *fit, int noffset, char **algo);
1054 int fit_image_hash_get_value(const void *fit, int noffset, uint8_t **value,
1057 int fit_set_timestamp(void *fit, int noffset, time_t timestamp);
1059 int fit_cipher_data(const char *keydir, void *keydest, void *fit,
1060 const char *comment, int require_keys,
1061 const char *engine_id, const char *cmdname);
1064 * fit_add_verification_data() - add verification data to FIT image nodes
1066 * @keydir: Directory containing keys
1067 * @kwydest: FDT blob to write public key information to
1068 * @fit: Pointer to the FIT format image header
1069 * @comment: Comment to add to signature nodes
1070 * @require_keys: Mark all keys as 'required'
1071 * @engine_id: Engine to use for signing
1072 * @cmdname: Command name used when reporting errors
1074 * Adds hash values for all component images in the FIT blob.
1075 * Hashes are calculated for all component images which have hash subnodes
1076 * with algorithm property set to one of the supported hash algorithms.
1078 * Also add signatures if signature nodes are present.
1082 * libfdt error code, on failure
1084 int fit_add_verification_data(const char *keydir, const char *keyfile,
1085 void *keydest, void *fit, const char *comment,
1086 int require_keys, const char *engine_id,
1087 const char *cmdname);
1089 int fit_image_verify_with_data(const void *fit, int image_noffset,
1090 const void *data, size_t size);
1091 int fit_image_verify(const void *fit, int noffset);
1092 int fit_config_verify(const void *fit, int conf_noffset);
1093 int fit_all_image_verify(const void *fit);
1094 int fit_config_decrypt(const void *fit, int conf_noffset);
1095 int fit_image_check_os(const void *fit, int noffset, uint8_t os);
1096 int fit_image_check_arch(const void *fit, int noffset, uint8_t arch);
1097 int fit_image_check_type(const void *fit, int noffset, uint8_t type);
1098 int fit_image_check_comp(const void *fit, int noffset, uint8_t comp);
1101 * fit_check_format() - Check that the FIT is valid
1103 * This performs various checks on the FIT to make sure it is suitable for
1104 * use, looking for mandatory properties, nodes, etc.
1106 * If FIT_FULL_CHECK is enabled, it also runs it through libfdt to make
1107 * sure that there are no strange tags or broken nodes in the FIT.
1109 * @fit: pointer to the FIT format image header
1110 * @return 0 if OK, -ENOEXEC if not an FDT file, -EINVAL if the full FDT check
1111 * failed (e.g. due to bad structure), -ENOMSG if the description is
1112 * missing, -EBADMSG if the timestamp is missing, -ENOENT if the /images
1115 int fit_check_format(const void *fit, ulong size);
1117 int fit_conf_find_compat(const void *fit, const void *fdt);
1120 * fit_conf_get_node - get node offset for configuration of a given unit name
1121 * @fit: pointer to the FIT format image header
1122 * @conf_uname: configuration node unit name (NULL to use default)
1124 * fit_conf_get_node() finds a configuration (within the '/configurations'
1125 * parent node) of a provided unit name. If configuration is found its node
1126 * offset is returned to the caller.
1128 * When NULL is provided in second argument fit_conf_get_node() will search
1129 * for a default configuration node instead. Default configuration node unit
1130 * name is retrieved from FIT_DEFAULT_PROP property of the '/configurations'
1134 * configuration node offset when found (>=0)
1135 * negative number on failure (FDT_ERR_* code)
1137 int fit_conf_get_node(const void *fit, const char *conf_uname);
1139 int fit_conf_get_prop_node_count(const void *fit, int noffset,
1140 const char *prop_name);
1141 int fit_conf_get_prop_node_index(const void *fit, int noffset,
1142 const char *prop_name, int index);
1145 * fit_conf_get_prop_node() - Get node refered to by a configuration
1146 * @fit: FIT to check
1147 * @noffset: Offset of conf@xxx node to check
1148 * @prop_name: Property to read from the conf node
1150 * The conf- nodes contain references to other nodes, using properties
1151 * like 'kernel = "kernel"'. Given such a property name (e.g. "kernel"),
1152 * return the offset of the node referred to (e.g. offset of node
1155 int fit_conf_get_prop_node(const void *fit, int noffset,
1156 const char *prop_name);
1158 int fit_check_ramdisk(const void *fit, int os_noffset,
1159 uint8_t arch, int verify);
1160 #endif /* IMAGE_ENABLE_FIT */
1162 int calculate_hash(const void *data, int data_len, const char *algo,
1163 uint8_t *value, int *value_len);
1166 * At present we only support signing on the host, and verification on the
1169 #if defined(USE_HOSTCC)
1170 # if defined(CONFIG_FIT_SIGNATURE)
1171 # define IMAGE_ENABLE_SIGN 1
1172 # define FIT_IMAGE_ENABLE_VERIFY 1
1173 # include <openssl/evp.h>
1175 # define IMAGE_ENABLE_SIGN 0
1176 # define FIT_IMAGE_ENABLE_VERIFY 0
1179 # define IMAGE_ENABLE_SIGN 0
1180 # define FIT_IMAGE_ENABLE_VERIFY CONFIG_IS_ENABLED(FIT_SIGNATURE)
1183 #if IMAGE_ENABLE_FIT
1185 void *image_get_host_blob(void);
1186 void image_set_host_blob(void *host_blob);
1187 # define gd_fdt_blob() image_get_host_blob()
1189 # define gd_fdt_blob() (gd->fdt_blob)
1192 #endif /* IMAGE_ENABLE_FIT */
1195 * Information passed to the signing routines
1197 * Either 'keydir', 'keyname', or 'keyfile' can be NULL. However, either
1198 * 'keyfile', or both 'keydir' and 'keyname' should have valid values. If
1199 * neither are valid, some operations might fail with EINVAL.
1201 struct image_sign_info {
1202 const char *keydir; /* Directory conaining keys */
1203 const char *keyname; /* Name of key to use */
1204 const char *keyfile; /* Filename of private or public key */
1205 void *fit; /* Pointer to FIT blob */
1206 int node_offset; /* Offset of signature node */
1207 const char *name; /* Algorithm name */
1208 struct checksum_algo *checksum; /* Checksum algorithm information */
1209 struct padding_algo *padding; /* Padding algorithm information */
1210 struct crypto_algo *crypto; /* Crypto algorithm information */
1211 const void *fdt_blob; /* FDT containing public keys */
1212 int required_keynode; /* Node offset of key to use: -1=any */
1213 const char *require_keys; /* Value for 'required' property */
1214 const char *engine_id; /* Engine to use for signing */
1216 * Note: the following two fields are always valid even w/o
1217 * RSA_VERIFY_WITH_PKEY in order to make sure this structure is
1218 * the same on target and host. Otherwise, vboot test may fail.
1220 const void *key; /* Pointer to public key in DER */
1221 int keylen; /* Length of public key */
1224 /* A part of an image, used for hashing */
1225 struct image_region {
1230 #if FIT_IMAGE_ENABLE_VERIFY
1231 # include <u-boot/hash-checksum.h>
1233 struct checksum_algo {
1235 const int checksum_len;
1237 const uint8_t *der_prefix;
1238 #if IMAGE_ENABLE_SIGN
1239 const EVP_MD *(*calculate_sign)(void);
1241 int (*calculate)(const char *name,
1242 const struct image_region region[],
1243 int region_count, uint8_t *checksum);
1246 struct crypto_algo {
1247 const char *name; /* Name of algorithm */
1251 * sign() - calculate and return signature for given input data
1253 * @info: Specifies key and FIT information
1254 * @data: Pointer to the input data
1255 * @data_len: Data length
1256 * @sigp: Set to an allocated buffer holding the signature
1257 * @sig_len: Set to length of the calculated hash
1259 * This computes input data signature according to selected algorithm.
1260 * Resulting signature value is placed in an allocated buffer, the
1261 * pointer is returned as *sigp. The length of the calculated
1262 * signature is returned via the sig_len pointer argument. The caller
1263 * should free *sigp.
1265 * @return: 0, on success, -ve on error
1267 int (*sign)(struct image_sign_info *info,
1268 const struct image_region region[],
1269 int region_count, uint8_t **sigp, uint *sig_len);
1272 * add_verify_data() - Add verification information to FDT
1274 * Add public key information to the FDT node, suitable for
1275 * verification at run-time. The information added depends on the
1276 * algorithm being used.
1278 * @info: Specifies key and FIT information
1279 * @keydest: Destination FDT blob for public key data
1280 * @return: 0, on success, -ve on error
1282 int (*add_verify_data)(struct image_sign_info *info, void *keydest);
1285 * verify() - Verify a signature against some data
1287 * @info: Specifies key and FIT information
1288 * @data: Pointer to the input data
1289 * @data_len: Data length
1291 * @sig_len: Number of bytes in signature
1292 * @return 0 if verified, -ve on error
1294 int (*verify)(struct image_sign_info *info,
1295 const struct image_region region[], int region_count,
1296 uint8_t *sig, uint sig_len);
1299 /* Declare a new U-Boot crypto algorithm handler */
1300 #define U_BOOT_CRYPTO_ALGO(__name) \
1301 ll_entry_declare(struct crypto_algo, __name, cryptos)
1303 struct padding_algo {
1305 int (*verify)(struct image_sign_info *info,
1306 uint8_t *pad, int pad_len,
1307 const uint8_t *hash, int hash_len);
1310 /* Declare a new U-Boot padding algorithm handler */
1311 #define U_BOOT_PADDING_ALGO(__name) \
1312 ll_entry_declare(struct padding_algo, __name, paddings)
1315 * image_get_checksum_algo() - Look up a checksum algorithm
1317 * @param full_name Name of algorithm in the form "checksum,crypto"
1318 * @return pointer to algorithm information, or NULL if not found
1320 struct checksum_algo *image_get_checksum_algo(const char *full_name);
1323 * image_get_crypto_algo() - Look up a cryptosystem algorithm
1325 * @param full_name Name of algorithm in the form "checksum,crypto"
1326 * @return pointer to algorithm information, or NULL if not found
1328 struct crypto_algo *image_get_crypto_algo(const char *full_name);
1331 * image_get_padding_algo() - Look up a padding algorithm
1333 * @param name Name of padding algorithm
1334 * @return pointer to algorithm information, or NULL if not found
1336 struct padding_algo *image_get_padding_algo(const char *name);
1338 #if IMAGE_ENABLE_FIT
1341 * fit_image_verify_required_sigs() - Verify signatures marked as 'required'
1343 * @fit: FIT to check
1344 * @image_noffset: Offset of image node to check
1345 * @data: Image data to check
1346 * @size: Size of image data
1347 * @sig_blob: FDT containing public keys
1348 * @no_sigsp: Returns 1 if no signatures were required, and
1349 * therefore nothing was checked. The caller may wish
1350 * to fall back to other mechanisms, or refuse to
1352 * @return 0 if all verified ok, <0 on error
1354 int fit_image_verify_required_sigs(const void *fit, int image_noffset,
1355 const char *data, size_t size, const void *sig_blob,
1359 * fit_image_check_sig() - Check a single image signature node
1361 * @fit: FIT to check
1362 * @noffset: Offset of signature node to check
1363 * @data: Image data to check
1364 * @size: Size of image data
1365 * @required_keynode: Offset in the control FDT of the required key node,
1366 * if any. If this is given, then the image wil not
1367 * pass verification unless that key is used. If this is
1368 * -1 then any signature will do.
1369 * @err_msgp: In the event of an error, this will be pointed to a
1370 * help error string to display to the user.
1371 * @return 0 if all verified ok, <0 on error
1373 int fit_image_check_sig(const void *fit, int noffset, const void *data,
1374 size_t size, int required_keynode, char **err_msgp);
1376 int fit_image_decrypt_data(const void *fit,
1377 int image_noffset, int cipher_noffset,
1378 const void *data, size_t size,
1379 void **data_unciphered, size_t *size_unciphered);
1382 * fit_region_make_list() - Make a list of regions to hash
1384 * Given a list of FIT regions (offset, size) provided by libfdt, create
1385 * a list of regions (void *, size) for use by the signature creationg
1386 * and verification code.
1388 * @fit: FIT image to process
1389 * @fdt_regions: Regions as returned by libfdt
1390 * @count: Number of regions returned by libfdt
1391 * @region: Place to put list of regions (NULL to allocate it)
1392 * @return pointer to list of regions, or NULL if out of memory
1394 struct image_region *fit_region_make_list(const void *fit,
1395 struct fdt_region *fdt_regions, int count,
1396 struct image_region *region);
1398 static inline int fit_image_check_target_arch(const void *fdt, int node)
1401 return fit_image_check_arch(fdt, node, IH_ARCH_DEFAULT);
1408 * At present we only support ciphering on the host, and unciphering on the
1411 #if defined(USE_HOSTCC)
1412 # if defined(CONFIG_FIT_CIPHER)
1413 # define IMAGE_ENABLE_ENCRYPT 1
1414 # define IMAGE_ENABLE_DECRYPT 1
1415 # include <openssl/evp.h>
1417 # define IMAGE_ENABLE_ENCRYPT 0
1418 # define IMAGE_ENABLE_DECRYPT 0
1421 # define IMAGE_ENABLE_ENCRYPT 0
1422 # define IMAGE_ENABLE_DECRYPT CONFIG_IS_ENABLED(FIT_CIPHER)
1425 /* Information passed to the ciphering routines */
1426 struct image_cipher_info {
1427 const char *keydir; /* Directory containing keys */
1428 const char *keyname; /* Name of key to use */
1429 const char *ivname; /* Name of IV to use */
1430 const void *fit; /* Pointer to FIT blob */
1431 int node_noffset; /* Offset of the cipher node */
1432 const char *name; /* Algorithm name */
1433 struct cipher_algo *cipher; /* Cipher algorithm information */
1434 const void *fdt_blob; /* FDT containing key and IV */
1435 const void *key; /* Value of the key */
1436 const void *iv; /* Value of the IV */
1437 size_t size_unciphered; /* Size of the unciphered data */
1440 struct cipher_algo {
1441 const char *name; /* Name of algorithm */
1442 int key_len; /* Length of the key */
1443 int iv_len; /* Length of the IV */
1445 #if IMAGE_ENABLE_ENCRYPT
1446 const EVP_CIPHER * (*calculate_type)(void);
1449 int (*encrypt)(struct image_cipher_info *info,
1450 const unsigned char *data, int data_len,
1451 unsigned char **cipher, int *cipher_len);
1453 int (*add_cipher_data)(struct image_cipher_info *info,
1454 void *keydest, void *fit, int node_noffset);
1456 int (*decrypt)(struct image_cipher_info *info,
1457 const void *cipher, size_t cipher_len,
1458 void **data, size_t *data_len);
1461 int fit_image_cipher_get_algo(const void *fit, int noffset, char **algo);
1463 struct cipher_algo *image_get_cipher_algo(const char *full_name);
1465 #ifdef CONFIG_FIT_VERBOSE
1466 #define fit_unsupported(msg) printf("! %s:%d " \
1467 "FIT images not supported for '%s'\n", \
1468 __FILE__, __LINE__, (msg))
1470 #define fit_unsupported_reset(msg) printf("! %s:%d " \
1471 "FIT images not supported for '%s' " \
1472 "- must reset board to recover!\n", \
1473 __FILE__, __LINE__, (msg))
1475 #define fit_unsupported(msg)
1476 #define fit_unsupported_reset(msg)
1477 #endif /* CONFIG_FIT_VERBOSE */
1478 #endif /* CONFIG_FIT */
1480 #if !defined(USE_HOSTCC)
1481 #if defined(CONFIG_ANDROID_BOOT_IMAGE)
1482 struct andr_img_hdr;
1483 int android_image_check_header(const struct andr_img_hdr *hdr);
1484 int android_image_get_kernel(const struct andr_img_hdr *hdr, int verify,
1485 ulong *os_data, ulong *os_len);
1486 int android_image_get_ramdisk(const struct andr_img_hdr *hdr,
1487 ulong *rd_data, ulong *rd_len);
1488 int android_image_get_second(const struct andr_img_hdr *hdr,
1489 ulong *second_data, ulong *second_len);
1490 bool android_image_get_dtbo(ulong hdr_addr, ulong *addr, u32 *size);
1491 bool android_image_get_dtb_by_index(ulong hdr_addr, u32 index, ulong *addr,
1493 ulong android_image_get_end(const struct andr_img_hdr *hdr);
1494 ulong android_image_get_kload(const struct andr_img_hdr *hdr);
1495 ulong android_image_get_kcomp(const struct andr_img_hdr *hdr);
1496 void android_print_contents(const struct andr_img_hdr *hdr);
1497 #if !defined(CONFIG_SPL_BUILD)
1498 bool android_image_print_dtb_contents(ulong hdr_addr);
1501 #endif /* CONFIG_ANDROID_BOOT_IMAGE */
1502 #endif /* !USE_HOSTCC */
1505 * board_fit_config_name_match() - Check for a matching board name
1507 * This is used when SPL loads a FIT containing multiple device tree files
1508 * and wants to work out which one to use. The description of each one is
1509 * passed to this function. The description comes from the 'description' field
1510 * in each (FDT) image node.
1512 * @name: Device tree description
1513 * @return 0 if this device tree should be used, non-zero to try the next
1515 int board_fit_config_name_match(const char *name);
1518 * board_fit_image_post_process() - Do any post-process on FIT binary data
1520 * This is used to do any sort of image manipulation, verification, decryption
1521 * etc. in a platform or board specific way. Obviously, anything done here would
1522 * need to be comprehended in how the images were prepared before being injected
1523 * into the FIT creation (i.e. the binary blobs would have been pre-processed
1524 * before being added to the FIT image).
1526 * @fit: pointer to fit image
1527 * @node: offset of image node
1528 * @image: pointer to the image start pointer
1529 * @size: pointer to the image size
1530 * @return no return value (failure should be handled internally)
1532 void board_fit_image_post_process(const void *fit, int node, void **p_image,
1535 #define FDT_ERROR ((ulong)(-1))
1537 ulong fdt_getprop_u32(const void *fdt, int node, const char *prop);
1540 * fit_find_config_node() - Find the node for the best DTB in a FIT image
1542 * A FIT image contains one or more DTBs. This function parses the
1543 * configurations described in the FIT images and returns the node of
1544 * the first matching DTB. To check if a DTB matches a board, this function
1545 * calls board_fit_config_name_match(). If no matching DTB is found, it returns
1546 * the node described by the default configuration if it exists.
1548 * @fdt: pointer to flat device tree
1549 * @return the node if found, -ve otherwise
1551 int fit_find_config_node(const void *fdt);
1554 * Mapping of image types to function handlers to be invoked on the associated
1557 * @type: Type of image, I.E. IH_TYPE_*
1558 * @handler: Function to call on loaded image
1560 struct fit_loadable_tbl {
1563 * handler() - Process a loaded image
1565 * @data: Pointer to start of loaded image data
1566 * @size: Size of loaded image data
1568 void (*handler)(ulong data, size_t size);
1572 * Define a FIT loadable image type handler
1574 * _type is a valid uimage_type ID as defined in the "Image Type" enum above
1575 * _handler is the handler function to call after this image type is loaded
1577 #define U_BOOT_FIT_LOADABLE_HANDLER(_type, _handler) \
1578 ll_entry_declare(struct fit_loadable_tbl, _function, fit_loadable) = { \
1580 .handler = _handler, \
1584 * fit_update - update storage with FIT image
1585 * @fit: Pointer to FIT image
1587 * Update firmware on storage using FIT image as input.
1588 * The storage area to be update will be identified by the name
1589 * in FIT and matching it to "dfu_alt_info" variable.
1591 * Return: 0 on success, non-zero otherwise
1593 int fit_update(const void *fit);
1595 #endif /* __IMAGE_H__ */