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 /* new uImage format support enabled on host */
31 #define CONFIG_FIT_RSASSA_PSS 1
33 #define IMAGE_ENABLE_IGNORE 0
34 #define IMAGE_INDENT_STRING ""
39 #include <asm/u-boot.h>
41 #include <linker_lists.h>
43 /* Take notice of the 'ignore' property for hashes */
44 #define IMAGE_ENABLE_IGNORE 1
45 #define IMAGE_INDENT_STRING " "
47 #endif /* USE_HOSTCC */
49 #if CONFIG_IS_ENABLED(FIT)
51 #include <linux/libfdt.h>
52 #include <fdt_support.h>
55 #ifdef CONFIG_SYS_BOOT_GET_CMDLINE
56 # define IMAGE_BOOT_GET_CMDLINE 1
58 # define IMAGE_BOOT_GET_CMDLINE 0
61 #ifdef CONFIG_OF_BOARD_SETUP
62 # define IMAGE_OF_BOARD_SETUP 1
64 # define IMAGE_OF_BOARD_SETUP 0
67 #ifdef CONFIG_OF_SYSTEM_SETUP
68 # define IMAGE_OF_SYSTEM_SETUP 1
70 # define IMAGE_OF_SYSTEM_SETUP 0
73 extern ulong image_load_addr; /* Default Load Address */
74 extern ulong image_save_addr; /* Default Save Address */
75 extern ulong image_save_size; /* Default Save Size */
77 /* An invalid size, meaning that the image size is not known */
78 #define IMAGE_SIZE_INVAL (-1UL)
90 * Operating System Codes
92 * The following are exposed to uImage header.
93 * New IDs *MUST* be appended at the end of the list and *NEVER*
94 * inserted for backward compatibility.
97 IH_OS_INVALID = 0, /* Invalid OS */
98 IH_OS_OPENBSD, /* OpenBSD */
99 IH_OS_NETBSD, /* NetBSD */
100 IH_OS_FREEBSD, /* FreeBSD */
101 IH_OS_4_4BSD, /* 4.4BSD */
102 IH_OS_LINUX, /* Linux */
103 IH_OS_SVR4, /* SVR4 */
104 IH_OS_ESIX, /* Esix */
105 IH_OS_SOLARIS, /* Solaris */
106 IH_OS_IRIX, /* Irix */
108 IH_OS_DELL, /* Dell */
110 IH_OS_LYNXOS, /* LynxOS */
111 IH_OS_VXWORKS, /* VxWorks */
112 IH_OS_PSOS, /* pSOS */
114 IH_OS_U_BOOT, /* Firmware */
115 IH_OS_RTEMS, /* RTEMS */
116 IH_OS_ARTOS, /* ARTOS */
117 IH_OS_UNITY, /* Unity OS */
118 IH_OS_INTEGRITY, /* INTEGRITY */
120 IH_OS_PLAN9, /* Plan 9 */
121 IH_OS_OPENRTOS, /* OpenRTOS */
122 IH_OS_ARM_TRUSTED_FIRMWARE, /* ARM Trusted Firmware */
123 IH_OS_TEE, /* Trusted Execution Environment */
124 IH_OS_OPENSBI, /* RISC-V OpenSBI */
125 IH_OS_EFI, /* EFI Firmware (e.g. GRUB2) */
131 * CPU Architecture Codes (supported by Linux)
133 * The following are exposed to uImage header.
134 * New IDs *MUST* be appended at the end of the list and *NEVER*
135 * inserted for backward compatibility.
138 IH_ARCH_INVALID = 0, /* Invalid CPU */
139 IH_ARCH_ALPHA, /* Alpha */
140 IH_ARCH_ARM, /* ARM */
141 IH_ARCH_I386, /* Intel x86 */
142 IH_ARCH_IA64, /* IA64 */
143 IH_ARCH_MIPS, /* MIPS */
144 IH_ARCH_MIPS64, /* MIPS 64 Bit */
145 IH_ARCH_PPC, /* PowerPC */
146 IH_ARCH_S390, /* IBM S390 */
147 IH_ARCH_SH, /* SuperH */
148 IH_ARCH_SPARC, /* Sparc */
149 IH_ARCH_SPARC64, /* Sparc 64 Bit */
150 IH_ARCH_M68K, /* M68K */
151 IH_ARCH_NIOS, /* Nios-32 */
152 IH_ARCH_MICROBLAZE, /* MicroBlaze */
153 IH_ARCH_NIOS2, /* Nios-II */
154 IH_ARCH_BLACKFIN, /* Blackfin */
155 IH_ARCH_AVR32, /* AVR32 */
156 IH_ARCH_ST200, /* STMicroelectronics ST200 */
157 IH_ARCH_SANDBOX, /* Sandbox architecture (test only) */
158 IH_ARCH_NDS32, /* ANDES Technology - NDS32 */
159 IH_ARCH_OPENRISC, /* OpenRISC 1000 */
160 IH_ARCH_ARM64, /* ARM64 */
161 IH_ARCH_ARC, /* Synopsys DesignWare ARC */
162 IH_ARCH_X86_64, /* AMD x86_64, Intel and Via */
163 IH_ARCH_XTENSA, /* Xtensa */
164 IH_ARCH_RISCV, /* RISC-V */
172 * "Standalone Programs" are directly runnable in the environment
173 * provided by U-Boot; it is expected that (if they behave
174 * well) you can continue to work in U-Boot after return from
175 * the Standalone Program.
176 * "OS Kernel Images" are usually images of some Embedded OS which
177 * will take over control completely. Usually these programs
178 * will install their own set of exception handlers, device
179 * drivers, set up the MMU, etc. - this means, that you cannot
180 * expect to re-enter U-Boot except by resetting the CPU.
181 * "RAMDisk Images" are more or less just data blocks, and their
182 * parameters (address, size) are passed to an OS kernel that is
184 * "Multi-File Images" contain several images, typically an OS
185 * (Linux) kernel image and one or more data images like
186 * RAMDisks. This construct is useful for instance when you want
187 * to boot over the network using BOOTP etc., where the boot
188 * server provides just a single image file, but you want to get
189 * for instance an OS kernel and a RAMDisk image.
191 * "Multi-File Images" start with a list of image sizes, each
192 * image size (in bytes) specified by an "uint32_t" in network
193 * byte order. This list is terminated by an "(uint32_t)0".
194 * Immediately after the terminating 0 follow the images, one by
195 * one, all aligned on "uint32_t" boundaries (size rounded up to
196 * a multiple of 4 bytes - except for the last file).
198 * "Firmware Images" are binary images containing firmware (like
199 * U-Boot or FPGA images) which usually will be programmed to
202 * "Script files" are command sequences that will be executed by
203 * U-Boot's command interpreter; this feature is especially
204 * useful when you configure U-Boot to use a real shell (hush)
205 * as command interpreter (=> Shell Scripts).
207 * The following are exposed to uImage header.
208 * New IDs *MUST* be appended at the end of the list and *NEVER*
209 * inserted for backward compatibility.
213 IH_TYPE_INVALID = 0, /* Invalid Image */
214 IH_TYPE_STANDALONE, /* Standalone Program */
215 IH_TYPE_KERNEL, /* OS Kernel Image */
216 IH_TYPE_RAMDISK, /* RAMDisk Image */
217 IH_TYPE_MULTI, /* Multi-File Image */
218 IH_TYPE_FIRMWARE, /* Firmware Image */
219 IH_TYPE_SCRIPT, /* Script file */
220 IH_TYPE_FILESYSTEM, /* Filesystem Image (any type) */
221 IH_TYPE_FLATDT, /* Binary Flat Device Tree Blob */
222 IH_TYPE_KWBIMAGE, /* Kirkwood Boot Image */
223 IH_TYPE_IMXIMAGE, /* Freescale IMXBoot Image */
224 IH_TYPE_UBLIMAGE, /* Davinci UBL Image */
225 IH_TYPE_OMAPIMAGE, /* TI OMAP Config Header Image */
226 IH_TYPE_AISIMAGE, /* TI Davinci AIS Image */
227 /* OS Kernel Image, can run from any load address */
228 IH_TYPE_KERNEL_NOLOAD,
229 IH_TYPE_PBLIMAGE, /* Freescale PBL Boot Image */
230 IH_TYPE_MXSIMAGE, /* Freescale MXSBoot Image */
231 IH_TYPE_GPIMAGE, /* TI Keystone GPHeader Image */
232 IH_TYPE_ATMELIMAGE, /* ATMEL ROM bootable Image */
233 IH_TYPE_SOCFPGAIMAGE, /* Altera SOCFPGA CV/AV Preloader */
234 IH_TYPE_X86_SETUP, /* x86 setup.bin Image */
235 IH_TYPE_LPC32XXIMAGE, /* x86 setup.bin Image */
236 IH_TYPE_LOADABLE, /* A list of typeless images */
237 IH_TYPE_RKIMAGE, /* Rockchip Boot Image */
238 IH_TYPE_RKSD, /* Rockchip SD card */
239 IH_TYPE_RKSPI, /* Rockchip SPI image */
240 IH_TYPE_ZYNQIMAGE, /* Xilinx Zynq Boot Image */
241 IH_TYPE_ZYNQMPIMAGE, /* Xilinx ZynqMP Boot Image */
242 IH_TYPE_ZYNQMPBIF, /* Xilinx ZynqMP Boot Image (bif) */
243 IH_TYPE_FPGA, /* FPGA Image */
244 IH_TYPE_VYBRIDIMAGE, /* VYBRID .vyb Image */
245 IH_TYPE_TEE, /* Trusted Execution Environment OS Image */
246 IH_TYPE_FIRMWARE_IVT, /* Firmware Image with HABv4 IVT */
247 IH_TYPE_PMMC, /* TI Power Management Micro-Controller Firmware */
248 IH_TYPE_STM32IMAGE, /* STMicroelectronics STM32 Image */
249 IH_TYPE_SOCFPGAIMAGE_V1, /* Altera SOCFPGA A10 Preloader */
250 IH_TYPE_MTKIMAGE, /* MediaTek BootROM loadable Image */
251 IH_TYPE_IMX8MIMAGE, /* Freescale IMX8MBoot Image */
252 IH_TYPE_IMX8IMAGE, /* Freescale IMX8Boot Image */
253 IH_TYPE_COPRO, /* Coprocessor Image for remoteproc*/
254 IH_TYPE_SUNXI_EGON, /* Allwinner eGON Boot Image */
256 IH_TYPE_COUNT, /* Number of image types */
262 * The following are exposed to uImage header.
263 * New IDs *MUST* be appended at the end of the list and *NEVER*
264 * inserted for backward compatibility.
267 IH_COMP_NONE = 0, /* No Compression Used */
268 IH_COMP_GZIP, /* gzip Compression Used */
269 IH_COMP_BZIP2, /* bzip2 Compression Used */
270 IH_COMP_LZMA, /* lzma Compression Used */
271 IH_COMP_LZO, /* lzo Compression Used */
272 IH_COMP_LZ4, /* lz4 Compression Used */
273 IH_COMP_ZSTD, /* zstd Compression Used */
278 #define LZ4F_MAGIC 0x184D2204 /* LZ4 Magic Number */
279 #define IH_MAGIC 0x27051956 /* Image Magic Number */
280 #define IH_NMLEN 32 /* Image Name Length */
282 /* Reused from common.h */
283 #define ROUND(a, b) (((a) + (b) - 1) & ~((b) - 1))
286 * Legacy format image header,
287 * all data in network byte order (aka natural aka bigendian).
289 typedef struct image_header {
290 uint32_t ih_magic; /* Image Header Magic Number */
291 uint32_t ih_hcrc; /* Image Header CRC Checksum */
292 uint32_t ih_time; /* Image Creation Timestamp */
293 uint32_t ih_size; /* Image Data Size */
294 uint32_t ih_load; /* Data Load Address */
295 uint32_t ih_ep; /* Entry Point Address */
296 uint32_t ih_dcrc; /* Image Data CRC Checksum */
297 uint8_t ih_os; /* Operating System */
298 uint8_t ih_arch; /* CPU architecture */
299 uint8_t ih_type; /* Image Type */
300 uint8_t ih_comp; /* Compression Type */
301 uint8_t ih_name[IH_NMLEN]; /* Image Name */
304 typedef struct image_info {
305 ulong start, end; /* start/end of blob */
306 ulong image_start, image_len; /* start of image within blob, len of image */
307 ulong load; /* load addr for the image */
308 uint8_t comp, type, os; /* compression, type of image, os type */
309 uint8_t arch; /* CPU architecture */
313 * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
316 typedef struct bootm_headers {
318 * Legacy os image header, if it is a multi component image
319 * then boot_get_ramdisk() and get_fdt() will attempt to get
320 * data from second and third component accordingly.
322 image_header_t *legacy_hdr_os; /* image header pointer */
323 image_header_t legacy_hdr_os_copy; /* header copy */
324 ulong legacy_hdr_valid;
326 #if CONFIG_IS_ENABLED(FIT)
327 const char *fit_uname_cfg; /* configuration node unit name */
329 void *fit_hdr_os; /* os FIT image header */
330 const char *fit_uname_os; /* os subimage node unit name */
331 int fit_noffset_os; /* os subimage node offset */
333 void *fit_hdr_rd; /* init ramdisk FIT image header */
334 const char *fit_uname_rd; /* init ramdisk subimage node unit name */
335 int fit_noffset_rd; /* init ramdisk subimage node offset */
337 void *fit_hdr_fdt; /* FDT blob FIT image header */
338 const char *fit_uname_fdt; /* FDT blob subimage node unit name */
339 int fit_noffset_fdt;/* FDT blob subimage node offset */
341 void *fit_hdr_setup; /* x86 setup FIT image header */
342 const char *fit_uname_setup; /* x86 setup subimage node name */
343 int fit_noffset_setup;/* x86 setup subimage node offset */
347 image_info_t os; /* os image info */
348 ulong ep; /* entry point of OS */
350 ulong rd_start, rd_end;/* ramdisk start/end */
352 char *ft_addr; /* flat dev tree address */
353 ulong ft_len; /* length of flat device tree */
362 int verify; /* env_get("verify")[0] != 'n' */
364 #define BOOTM_STATE_START (0x00000001)
365 #define BOOTM_STATE_FINDOS (0x00000002)
366 #define BOOTM_STATE_FINDOTHER (0x00000004)
367 #define BOOTM_STATE_LOADOS (0x00000008)
368 #define BOOTM_STATE_RAMDISK (0x00000010)
369 #define BOOTM_STATE_FDT (0x00000020)
370 #define BOOTM_STATE_OS_CMDLINE (0x00000040)
371 #define BOOTM_STATE_OS_BD_T (0x00000080)
372 #define BOOTM_STATE_OS_PREP (0x00000100)
373 #define BOOTM_STATE_OS_FAKE_GO (0x00000200) /* 'Almost' run the OS */
374 #define BOOTM_STATE_OS_GO (0x00000400)
377 #if defined(CONFIG_LMB) && !defined(USE_HOSTCC)
378 struct lmb lmb; /* for memory mgmt */
382 extern bootm_headers_t images;
385 * Some systems (for example LWMON) have very short watchdog periods;
386 * we must make sure to split long operations like memmove() or
387 * checksum calculations into reasonable chunks.
390 #define CHUNKSZ (64 * 1024)
393 #ifndef CHUNKSZ_CRC32
394 #define CHUNKSZ_CRC32 (64 * 1024)
398 #define CHUNKSZ_MD5 (64 * 1024)
402 #define CHUNKSZ_SHA1 (64 * 1024)
405 #define uimage_to_cpu(x) be32_to_cpu(x)
406 #define cpu_to_uimage(x) cpu_to_be32(x)
409 * Translation table for entries of a specific type; used by
410 * get_table_entry_id() and get_table_entry_name().
412 typedef struct table_entry {
414 char *sname; /* short (input) name to find table entry */
415 char *lname; /* long (output) name to print for messages */
419 * Compression type and magic number mapping table.
421 struct comp_magic_map {
424 unsigned char magic[2];
428 * get_table_entry_id() scans the translation table trying to find an
429 * entry that matches the given short name. If a matching entry is
430 * found, it's id is returned to the caller.
432 int get_table_entry_id(const table_entry_t *table,
433 const char *table_name, const char *name);
435 * get_table_entry_name() scans the translation table trying to find
436 * an entry that matches the given id. If a matching entry is found,
437 * its long name is returned to the caller.
439 char *get_table_entry_name(const table_entry_t *table, char *msg, int id);
441 const char *genimg_get_os_name(uint8_t os);
444 * genimg_get_os_short_name() - get the short name for an OS
446 * @param os OS (IH_OS_...)
447 * @return OS short name, or "unknown" if unknown
449 const char *genimg_get_os_short_name(uint8_t comp);
451 const char *genimg_get_arch_name(uint8_t arch);
454 * genimg_get_arch_short_name() - get the short name for an architecture
456 * @param arch Architecture type (IH_ARCH_...)
457 * @return architecture short name, or "unknown" if unknown
459 const char *genimg_get_arch_short_name(uint8_t arch);
461 const char *genimg_get_type_name(uint8_t type);
464 * genimg_get_type_short_name() - get the short name for an image type
466 * @param type Image type (IH_TYPE_...)
467 * @return image short name, or "unknown" if unknown
469 const char *genimg_get_type_short_name(uint8_t type);
471 const char *genimg_get_comp_name(uint8_t comp);
474 * genimg_get_comp_short_name() - get the short name for a compression method
476 * @param comp compression method (IH_COMP_...)
477 * @return compression method short name, or "unknown" if unknown
479 const char *genimg_get_comp_short_name(uint8_t comp);
482 * genimg_get_cat_name() - Get the name of an item in a category
484 * @category: Category of item
486 * @return name of item, or "Unknown ..." if unknown
488 const char *genimg_get_cat_name(enum ih_category category, uint id);
491 * genimg_get_cat_short_name() - Get the short name of an item in a category
493 * @category: Category of item
495 * @return short name of item, or "Unknown ..." if unknown
497 const char *genimg_get_cat_short_name(enum ih_category category, uint id);
500 * genimg_get_cat_count() - Get the number of items in a category
502 * @category: Category to check
503 * @return the number of items in the category (IH_xxx_COUNT)
505 int genimg_get_cat_count(enum ih_category category);
508 * genimg_get_cat_desc() - Get the description of a category
510 * @category: Category to check
511 * @return the description of a category, e.g. "architecture". This
512 * effectively converts the enum to a string.
514 const char *genimg_get_cat_desc(enum ih_category category);
517 * genimg_cat_has_id() - Check whether a category has an item
519 * @category: Category to check
521 * @return true or false as to whether a category has an item
523 bool genimg_cat_has_id(enum ih_category category, uint id);
525 int genimg_get_os_id(const char *name);
526 int genimg_get_arch_id(const char *name);
527 int genimg_get_type_id(const char *name);
528 int genimg_get_comp_id(const char *name);
529 void genimg_print_size(uint32_t size);
531 #if defined(CONFIG_TIMESTAMP) || defined(CONFIG_CMD_DATE) || \
533 #define IMAGE_ENABLE_TIMESTAMP 1
535 #define IMAGE_ENABLE_TIMESTAMP 0
537 void genimg_print_time(time_t timestamp);
539 /* What to do with a image load address ('load = <> 'in the FIT) */
541 FIT_LOAD_IGNORED, /* Ignore load address */
542 FIT_LOAD_OPTIONAL, /* Can be provided, but optional */
543 FIT_LOAD_OPTIONAL_NON_ZERO, /* Optional, a value of 0 is ignored */
544 FIT_LOAD_REQUIRED, /* Must be provided */
547 int boot_get_setup(bootm_headers_t *images, uint8_t arch, ulong *setup_start,
551 /* Image format types, returned by _get_format() routine */
552 #define IMAGE_FORMAT_INVALID 0x00
553 #if defined(CONFIG_LEGACY_IMAGE_FORMAT)
554 #define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */
556 #define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */
557 #define IMAGE_FORMAT_ANDROID 0x03 /* Android boot image */
559 ulong genimg_get_kernel_addr_fit(char * const img_addr,
560 const char **fit_uname_config,
561 const char **fit_uname_kernel);
562 ulong genimg_get_kernel_addr(char * const img_addr);
563 int genimg_get_format(const void *img_addr);
564 int genimg_has_config(bootm_headers_t *images);
566 int boot_get_fpga(int argc, char *const argv[], bootm_headers_t *images,
567 uint8_t arch, const ulong *ld_start, ulong * const ld_len);
568 int boot_get_ramdisk(int argc, char *const argv[], bootm_headers_t *images,
569 uint8_t arch, ulong *rd_start, ulong *rd_end);
572 * boot_get_loadable - routine to load a list of binaries to memory
573 * @argc: Ignored Argument
574 * @argv: Ignored Argument
575 * @images: pointer to the bootm images structure
576 * @arch: expected architecture for the image
577 * @ld_start: Ignored Argument
578 * @ld_len: Ignored Argument
580 * boot_get_loadable() will take the given FIT configuration, and look
581 * for a field named "loadables". Loadables, is a list of elements in
582 * the FIT given as strings. exe:
583 * loadables = "linux_kernel", "fdt-2";
584 * this function will attempt to parse each string, and load the
585 * corresponding element from the FIT into memory. Once placed,
586 * no aditional actions are taken.
589 * 0, if only valid images or no images are found
590 * error code, if an error occurs during fit_image_load
592 int boot_get_loadable(int argc, char *const argv[], bootm_headers_t *images,
593 uint8_t arch, const ulong *ld_start, ulong *const ld_len);
594 #endif /* !USE_HOSTCC */
596 int boot_get_setup_fit(bootm_headers_t *images, uint8_t arch,
597 ulong *setup_start, ulong *setup_len);
600 * boot_get_fdt_fit() - load a DTB from a FIT file (applying overlays)
602 * This deals with all aspects of loading an DTB from a FIT.
603 * The correct base image based on configuration will be selected, and
604 * then any overlays specified will be applied (as present in fit_uname_configp).
606 * @param images Boot images structure
607 * @param addr Address of FIT in memory
608 * @param fit_unamep On entry this is the requested image name
609 * (e.g. "kernel") or NULL to use the default. On exit
610 * points to the selected image name
611 * @param fit_uname_configp On entry this is the requested configuration
612 * name (e.g. "conf-1") or NULL to use the default. On
613 * exit points to the selected configuration name.
614 * @param arch Expected architecture (IH_ARCH_...)
615 * @param datap Returns address of loaded image
616 * @param lenp Returns length of loaded image
618 * @return node offset of base image, or -ve error code on error
620 int boot_get_fdt_fit(bootm_headers_t *images, ulong addr,
621 const char **fit_unamep, const char **fit_uname_configp,
622 int arch, ulong *datap, ulong *lenp);
625 * fit_image_load() - load an image from a FIT
627 * This deals with all aspects of loading an image from a FIT, including
628 * selecting the right image based on configuration, verifying it, printing
629 * out progress messages, checking the type/arch/os and optionally copying it
630 * to the right load address.
632 * The property to look up is defined by image_type.
634 * @param images Boot images structure
635 * @param addr Address of FIT in memory
636 * @param fit_unamep On entry this is the requested image name
637 * (e.g. "kernel") or NULL to use the default. On exit
638 * points to the selected image name
639 * @param fit_uname_configp On entry this is the requested configuration
640 * name (e.g. "conf-1") or NULL to use the default. On
641 * exit points to the selected configuration name.
642 * @param arch Expected architecture (IH_ARCH_...)
643 * @param image_type Required image type (IH_TYPE_...). If this is
644 * IH_TYPE_KERNEL then we allow IH_TYPE_KERNEL_NOLOAD
646 * @param bootstage_id ID of starting bootstage to use for progress updates.
647 * This will be added to the BOOTSTAGE_SUB values when
648 * calling bootstage_mark()
649 * @param load_op Decribes what to do with the load address
650 * @param datap Returns address of loaded image
651 * @param lenp Returns length of loaded image
652 * @return node offset of image, or -ve error code on error
654 int fit_image_load(bootm_headers_t *images, ulong addr,
655 const char **fit_unamep, const char **fit_uname_configp,
656 int arch, int image_type, int bootstage_id,
657 enum fit_load_op load_op, ulong *datap, ulong *lenp);
660 * image_source_script() - Execute a script
662 * Executes a U-Boot script at a particular address in memory. The script should
663 * have a header (FIT or legacy) with the script type (IH_TYPE_SCRIPT).
665 * @addr: Address of script
666 * @fit_uname: FIT subimage name
667 * @return result code (enum command_ret_t)
669 int image_source_script(ulong addr, const char *fit_uname);
673 * fit_get_node_from_config() - Look up an image a FIT by type
675 * This looks in the selected conf- node (images->fit_uname_cfg) for a
676 * particular image type (e.g. "kernel") and then finds the image that is
679 * For example, for something like:
692 * the function will return the node offset of the kernel@1 node, assuming
693 * that conf-1 is the chosen configuration.
695 * @param images Boot images structure
696 * @param prop_name Property name to look up (FIT_..._PROP)
697 * @param addr Address of FIT in memory
699 int fit_get_node_from_config(bootm_headers_t *images, const char *prop_name,
702 int boot_get_fdt(int flag, int argc, char *const argv[], uint8_t arch,
703 bootm_headers_t *images,
704 char **of_flat_tree, ulong *of_size);
705 void boot_fdt_add_mem_rsv_regions(struct lmb *lmb, void *fdt_blob);
706 int boot_relocate_fdt(struct lmb *lmb, char **of_flat_tree, ulong *of_size);
708 int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len,
709 ulong *initrd_start, ulong *initrd_end);
710 int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end);
711 #ifdef CONFIG_SYS_BOOT_GET_KBD
712 int boot_get_kbd(struct lmb *lmb, struct bd_info **kbd);
713 #endif /* CONFIG_SYS_BOOT_GET_KBD */
714 #endif /* !USE_HOSTCC */
716 /*******************************************************************/
717 /* Legacy format specific code (prefixed with image_) */
718 /*******************************************************************/
719 static inline uint32_t image_get_header_size(void)
721 return (sizeof(image_header_t));
724 #define image_get_hdr_l(f) \
725 static inline uint32_t image_get_##f(const image_header_t *hdr) \
727 return uimage_to_cpu(hdr->ih_##f); \
729 image_get_hdr_l(magic) /* image_get_magic */
730 image_get_hdr_l(hcrc) /* image_get_hcrc */
731 image_get_hdr_l(time) /* image_get_time */
732 image_get_hdr_l(size) /* image_get_size */
733 image_get_hdr_l(load) /* image_get_load */
734 image_get_hdr_l(ep) /* image_get_ep */
735 image_get_hdr_l(dcrc) /* image_get_dcrc */
737 #define image_get_hdr_b(f) \
738 static inline uint8_t image_get_##f(const image_header_t *hdr) \
740 return hdr->ih_##f; \
742 image_get_hdr_b(os) /* image_get_os */
743 image_get_hdr_b(arch) /* image_get_arch */
744 image_get_hdr_b(type) /* image_get_type */
745 image_get_hdr_b(comp) /* image_get_comp */
747 static inline char *image_get_name(const image_header_t *hdr)
749 return (char *)hdr->ih_name;
752 static inline uint32_t image_get_data_size(const image_header_t *hdr)
754 return image_get_size(hdr);
758 * image_get_data - get image payload start address
761 * image_get_data() returns address of the image payload. For single
762 * component images it is image data start. For multi component
763 * images it points to the null terminated table of sub-images sizes.
766 * image payload data start address
768 static inline ulong image_get_data(const image_header_t *hdr)
770 return ((ulong)hdr + image_get_header_size());
773 static inline uint32_t image_get_image_size(const image_header_t *hdr)
775 return (image_get_size(hdr) + image_get_header_size());
777 static inline ulong image_get_image_end(const image_header_t *hdr)
779 return ((ulong)hdr + image_get_image_size(hdr));
782 #define image_set_hdr_l(f) \
783 static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
785 hdr->ih_##f = cpu_to_uimage(val); \
787 image_set_hdr_l(magic) /* image_set_magic */
788 image_set_hdr_l(hcrc) /* image_set_hcrc */
789 image_set_hdr_l(time) /* image_set_time */
790 image_set_hdr_l(size) /* image_set_size */
791 image_set_hdr_l(load) /* image_set_load */
792 image_set_hdr_l(ep) /* image_set_ep */
793 image_set_hdr_l(dcrc) /* image_set_dcrc */
795 #define image_set_hdr_b(f) \
796 static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
800 image_set_hdr_b(os) /* image_set_os */
801 image_set_hdr_b(arch) /* image_set_arch */
802 image_set_hdr_b(type) /* image_set_type */
803 image_set_hdr_b(comp) /* image_set_comp */
805 static inline void image_set_name(image_header_t *hdr, const char *name)
807 strncpy(image_get_name(hdr), name, IH_NMLEN);
810 int image_check_hcrc(const image_header_t *hdr);
811 int image_check_dcrc(const image_header_t *hdr);
813 ulong env_get_bootm_low(void);
814 phys_size_t env_get_bootm_size(void);
815 phys_size_t env_get_bootm_mapsize(void);
817 void memmove_wd(void *to, void *from, size_t len, ulong chunksz);
819 static inline int image_check_magic(const image_header_t *hdr)
821 return (image_get_magic(hdr) == IH_MAGIC);
823 static inline int image_check_type(const image_header_t *hdr, uint8_t type)
825 return (image_get_type(hdr) == type);
827 static inline int image_check_arch(const image_header_t *hdr, uint8_t arch)
830 /* Let's assume that sandbox can load any architecture */
831 if (IS_ENABLED(CONFIG_SANDBOX))
834 return (image_get_arch(hdr) == arch) ||
835 (image_get_arch(hdr) == IH_ARCH_ARM && arch == IH_ARCH_ARM64);
837 static inline int image_check_os(const image_header_t *hdr, uint8_t os)
839 return (image_get_os(hdr) == os);
842 ulong image_multi_count(const image_header_t *hdr);
843 void image_multi_getimg(const image_header_t *hdr, ulong idx,
844 ulong *data, ulong *len);
846 void image_print_contents(const void *hdr);
849 static inline int image_check_target_arch(const image_header_t *hdr)
851 #ifndef IH_ARCH_DEFAULT
852 # error "please define IH_ARCH_DEFAULT in your arch asm/u-boot.h"
854 return image_check_arch(hdr, IH_ARCH_DEFAULT);
856 #endif /* USE_HOSTCC */
859 * image_decomp_type() - Find out compression type of an image
861 * @buf: Address in U-Boot memory where image is loaded.
862 * @len: Length of the compressed image.
863 * @return compression type or IH_COMP_NONE if not compressed.
865 * Note: Only following compression types are supported now.
866 * lzo, lzma, gzip, bzip2
868 int image_decomp_type(const unsigned char *buf, ulong len);
871 * image_decomp() - decompress an image
873 * @comp: Compression algorithm that is used (IH_COMP_...)
874 * @load: Destination load address in U-Boot memory
875 * @image_start Image start address (where we are decompressing from)
876 * @type: OS type (IH_OS_...)
877 * @load_bug: Place to decompress to
878 * @image_buf: Address to decompress from
879 * @image_len: Number of bytes in @image_buf to decompress
880 * @unc_len: Available space for decompression
881 * @return 0 if OK, -ve on error (BOOTM_ERR_...)
883 int image_decomp(int comp, ulong load, ulong image_start, int type,
884 void *load_buf, void *image_buf, ulong image_len,
885 uint unc_len, ulong *load_end);
888 * Set up properties in the FDT
890 * This sets up properties in the FDT that is to be passed to linux.
892 * @images: Images information
893 * @blob: FDT to update
894 * @of_size: Size of the FDT
895 * @lmb: Points to logical memory block structure
896 * @return 0 if ok, <0 on failure
898 int image_setup_libfdt(bootm_headers_t *images, void *blob,
899 int of_size, struct lmb *lmb);
902 * Set up the FDT to use for booting a kernel
904 * This performs ramdisk setup, sets up the FDT if required, and adds
905 * paramters to the FDT if libfdt is available.
907 * @param images Images information
908 * @return 0 if ok, <0 on failure
910 int image_setup_linux(bootm_headers_t *images);
913 * bootz_setup() - Extract stat and size of a Linux xImage
915 * @image: Address of image
916 * @start: Returns start address of image
917 * @end : Returns end address of image
918 * @return 0 if OK, 1 if the image was not recognised
920 int bootz_setup(ulong image, ulong *start, ulong *end);
923 * Return the correct start address and size of a Linux aarch64 Image.
925 * @image: Address of image
926 * @start: Returns start address of image
927 * @size : Returns size image
928 * @force_reloc: Ignore image->ep field, always place image to RAM start
929 * @return 0 if OK, 1 if the image was not recognised
931 int booti_setup(ulong image, ulong *relocated_addr, ulong *size,
934 /*******************************************************************/
935 /* New uImage format specific code (prefixed with fit_) */
936 /*******************************************************************/
938 #define FIT_IMAGES_PATH "/images"
939 #define FIT_CONFS_PATH "/configurations"
941 /* hash/signature/key node */
942 #define FIT_HASH_NODENAME "hash"
943 #define FIT_ALGO_PROP "algo"
944 #define FIT_VALUE_PROP "value"
945 #define FIT_IGNORE_PROP "uboot-ignore"
946 #define FIT_SIG_NODENAME "signature"
947 #define FIT_KEY_REQUIRED "required"
948 #define FIT_KEY_HINT "key-name-hint"
951 #define FIT_CIPHER_NODENAME "cipher"
952 #define FIT_ALGO_PROP "algo"
955 #define FIT_DATA_PROP "data"
956 #define FIT_DATA_POSITION_PROP "data-position"
957 #define FIT_DATA_OFFSET_PROP "data-offset"
958 #define FIT_DATA_SIZE_PROP "data-size"
959 #define FIT_TIMESTAMP_PROP "timestamp"
960 #define FIT_DESC_PROP "description"
961 #define FIT_ARCH_PROP "arch"
962 #define FIT_TYPE_PROP "type"
963 #define FIT_OS_PROP "os"
964 #define FIT_COMP_PROP "compression"
965 #define FIT_ENTRY_PROP "entry"
966 #define FIT_LOAD_PROP "load"
968 /* configuration node */
969 #define FIT_KERNEL_PROP "kernel"
970 #define FIT_RAMDISK_PROP "ramdisk"
971 #define FIT_FDT_PROP "fdt"
972 #define FIT_LOADABLE_PROP "loadables"
973 #define FIT_DEFAULT_PROP "default"
974 #define FIT_SETUP_PROP "setup"
975 #define FIT_FPGA_PROP "fpga"
976 #define FIT_FIRMWARE_PROP "firmware"
977 #define FIT_STANDALONE_PROP "standalone"
979 #define FIT_MAX_HASH_LEN HASH_MAX_DIGEST_SIZE
981 #if CONFIG_IS_ENABLED(FIT)
982 /* cmdline argument format parsing */
983 int fit_parse_conf(const char *spec, ulong addr_curr,
984 ulong *addr, const char **conf_name);
985 int fit_parse_subimage(const char *spec, ulong addr_curr,
986 ulong *addr, const char **image_name);
988 int fit_get_subimage_count(const void *fit, int images_noffset);
989 void fit_print_contents(const void *fit);
990 void fit_image_print(const void *fit, int noffset, const char *p);
993 * fit_get_end - get FIT image size
994 * @fit: pointer to the FIT format image header
997 * size of the FIT image (blob) in memory
999 static inline ulong fit_get_size(const void *fit)
1001 return fdt_totalsize(fit);
1005 * fit_get_end - get FIT image end
1006 * @fit: pointer to the FIT format image header
1009 * end address of the FIT image (blob) in memory
1011 ulong fit_get_end(const void *fit);
1014 * fit_get_name - get FIT node name
1015 * @fit: pointer to the FIT format image header
1019 * pointer to node name, on success
1021 static inline const char *fit_get_name(const void *fit_hdr,
1022 int noffset, int *len)
1024 return fdt_get_name(fit_hdr, noffset, len);
1027 int fit_get_desc(const void *fit, int noffset, char **desc);
1028 int fit_get_timestamp(const void *fit, int noffset, time_t *timestamp);
1030 int fit_image_get_node(const void *fit, const char *image_uname);
1031 int fit_image_get_os(const void *fit, int noffset, uint8_t *os);
1032 int fit_image_get_arch(const void *fit, int noffset, uint8_t *arch);
1033 int fit_image_get_type(const void *fit, int noffset, uint8_t *type);
1034 int fit_image_get_comp(const void *fit, int noffset, uint8_t *comp);
1035 int fit_image_get_load(const void *fit, int noffset, ulong *load);
1036 int fit_image_get_entry(const void *fit, int noffset, ulong *entry);
1037 int fit_image_get_data(const void *fit, int noffset,
1038 const void **data, size_t *size);
1039 int fit_image_get_data_offset(const void *fit, int noffset, int *data_offset);
1040 int fit_image_get_data_position(const void *fit, int noffset,
1041 int *data_position);
1042 int fit_image_get_data_size(const void *fit, int noffset, int *data_size);
1043 int fit_image_get_data_size_unciphered(const void *fit, int noffset,
1045 int fit_image_get_data_and_size(const void *fit, int noffset,
1046 const void **data, size_t *size);
1048 int fit_image_hash_get_algo(const void *fit, int noffset, char **algo);
1049 int fit_image_hash_get_value(const void *fit, int noffset, uint8_t **value,
1052 int fit_set_timestamp(void *fit, int noffset, time_t timestamp);
1054 int fit_cipher_data(const char *keydir, void *keydest, void *fit,
1055 const char *comment, int require_keys,
1056 const char *engine_id, const char *cmdname);
1059 * fit_add_verification_data() - add verification data to FIT image nodes
1061 * @keydir: Directory containing keys
1062 * @kwydest: FDT blob to write public key information to
1063 * @fit: Pointer to the FIT format image header
1064 * @comment: Comment to add to signature nodes
1065 * @require_keys: Mark all keys as 'required'
1066 * @engine_id: Engine to use for signing
1067 * @cmdname: Command name used when reporting errors
1069 * Adds hash values for all component images in the FIT blob.
1070 * Hashes are calculated for all component images which have hash subnodes
1071 * with algorithm property set to one of the supported hash algorithms.
1073 * Also add signatures if signature nodes are present.
1077 * libfdt error code, on failure
1079 int fit_add_verification_data(const char *keydir, const char *keyfile,
1080 void *keydest, void *fit, const char *comment,
1081 int require_keys, const char *engine_id,
1082 const char *cmdname);
1084 int fit_image_verify_with_data(const void *fit, int image_noffset,
1085 const void *data, size_t size);
1086 int fit_image_verify(const void *fit, int noffset);
1087 int fit_config_verify(const void *fit, int conf_noffset);
1088 int fit_all_image_verify(const void *fit);
1089 int fit_config_decrypt(const void *fit, int conf_noffset);
1090 int fit_image_check_os(const void *fit, int noffset, uint8_t os);
1091 int fit_image_check_arch(const void *fit, int noffset, uint8_t arch);
1092 int fit_image_check_type(const void *fit, int noffset, uint8_t type);
1093 int fit_image_check_comp(const void *fit, int noffset, uint8_t comp);
1096 * fit_check_format() - Check that the FIT is valid
1098 * This performs various checks on the FIT to make sure it is suitable for
1099 * use, looking for mandatory properties, nodes, etc.
1101 * If FIT_FULL_CHECK is enabled, it also runs it through libfdt to make
1102 * sure that there are no strange tags or broken nodes in the FIT.
1104 * @fit: pointer to the FIT format image header
1105 * @return 0 if OK, -ENOEXEC if not an FDT file, -EINVAL if the full FDT check
1106 * failed (e.g. due to bad structure), -ENOMSG if the description is
1107 * missing, -EBADMSG if the timestamp is missing, -ENOENT if the /images
1110 int fit_check_format(const void *fit, ulong size);
1112 int fit_conf_find_compat(const void *fit, const void *fdt);
1115 * fit_conf_get_node - get node offset for configuration of a given unit name
1116 * @fit: pointer to the FIT format image header
1117 * @conf_uname: configuration node unit name (NULL to use default)
1119 * fit_conf_get_node() finds a configuration (within the '/configurations'
1120 * parent node) of a provided unit name. If configuration is found its node
1121 * offset is returned to the caller.
1123 * When NULL is provided in second argument fit_conf_get_node() will search
1124 * for a default configuration node instead. Default configuration node unit
1125 * name is retrieved from FIT_DEFAULT_PROP property of the '/configurations'
1129 * configuration node offset when found (>=0)
1130 * negative number on failure (FDT_ERR_* code)
1132 int fit_conf_get_node(const void *fit, const char *conf_uname);
1134 int fit_conf_get_prop_node_count(const void *fit, int noffset,
1135 const char *prop_name);
1136 int fit_conf_get_prop_node_index(const void *fit, int noffset,
1137 const char *prop_name, int index);
1140 * fit_conf_get_prop_node() - Get node refered to by a configuration
1141 * @fit: FIT to check
1142 * @noffset: Offset of conf@xxx node to check
1143 * @prop_name: Property to read from the conf node
1145 * The conf- nodes contain references to other nodes, using properties
1146 * like 'kernel = "kernel"'. Given such a property name (e.g. "kernel"),
1147 * return the offset of the node referred to (e.g. offset of node
1150 int fit_conf_get_prop_node(const void *fit, int noffset,
1151 const char *prop_name);
1153 int fit_check_ramdisk(const void *fit, int os_noffset,
1154 uint8_t arch, int verify);
1157 int calculate_hash(const void *data, int data_len, const char *algo,
1158 uint8_t *value, int *value_len);
1161 * At present we only support signing on the host, and verification on the
1164 #if defined(USE_HOSTCC)
1165 # if defined(CONFIG_FIT_SIGNATURE)
1166 # define IMAGE_ENABLE_SIGN 1
1167 # define FIT_IMAGE_ENABLE_VERIFY 1
1168 # include <openssl/evp.h>
1170 # define IMAGE_ENABLE_SIGN 0
1171 # define FIT_IMAGE_ENABLE_VERIFY 0
1174 # define IMAGE_ENABLE_SIGN 0
1175 # define FIT_IMAGE_ENABLE_VERIFY CONFIG_IS_ENABLED(FIT_SIGNATURE)
1178 #if CONFIG_IS_ENABLED(FIT)
1180 void *image_get_host_blob(void);
1181 void image_set_host_blob(void *host_blob);
1182 # define gd_fdt_blob() image_get_host_blob()
1184 # define gd_fdt_blob() (gd->fdt_blob)
1187 #endif /* IMAGE_ENABLE_FIT */
1190 * Information passed to the signing routines
1192 * Either 'keydir', 'keyname', or 'keyfile' can be NULL. However, either
1193 * 'keyfile', or both 'keydir' and 'keyname' should have valid values. If
1194 * neither are valid, some operations might fail with EINVAL.
1196 struct image_sign_info {
1197 const char *keydir; /* Directory conaining keys */
1198 const char *keyname; /* Name of key to use */
1199 const char *keyfile; /* Filename of private or public key */
1200 void *fit; /* Pointer to FIT blob */
1201 int node_offset; /* Offset of signature node */
1202 const char *name; /* Algorithm name */
1203 struct checksum_algo *checksum; /* Checksum algorithm information */
1204 struct padding_algo *padding; /* Padding algorithm information */
1205 struct crypto_algo *crypto; /* Crypto algorithm information */
1206 const void *fdt_blob; /* FDT containing public keys */
1207 int required_keynode; /* Node offset of key to use: -1=any */
1208 const char *require_keys; /* Value for 'required' property */
1209 const char *engine_id; /* Engine to use for signing */
1211 * Note: the following two fields are always valid even w/o
1212 * RSA_VERIFY_WITH_PKEY in order to make sure this structure is
1213 * the same on target and host. Otherwise, vboot test may fail.
1215 const void *key; /* Pointer to public key in DER */
1216 int keylen; /* Length of public key */
1219 /* A part of an image, used for hashing */
1220 struct image_region {
1225 #if FIT_IMAGE_ENABLE_VERIFY
1226 # include <u-boot/hash-checksum.h>
1228 struct checksum_algo {
1230 const int checksum_len;
1232 const uint8_t *der_prefix;
1233 #if IMAGE_ENABLE_SIGN
1234 const EVP_MD *(*calculate_sign)(void);
1236 int (*calculate)(const char *name,
1237 const struct image_region region[],
1238 int region_count, uint8_t *checksum);
1241 struct crypto_algo {
1242 const char *name; /* Name of algorithm */
1246 * sign() - calculate and return signature for given input data
1248 * @info: Specifies key and FIT information
1249 * @data: Pointer to the input data
1250 * @data_len: Data length
1251 * @sigp: Set to an allocated buffer holding the signature
1252 * @sig_len: Set to length of the calculated hash
1254 * This computes input data signature according to selected algorithm.
1255 * Resulting signature value is placed in an allocated buffer, the
1256 * pointer is returned as *sigp. The length of the calculated
1257 * signature is returned via the sig_len pointer argument. The caller
1258 * should free *sigp.
1260 * @return: 0, on success, -ve on error
1262 int (*sign)(struct image_sign_info *info,
1263 const struct image_region region[],
1264 int region_count, uint8_t **sigp, uint *sig_len);
1267 * add_verify_data() - Add verification information to FDT
1269 * Add public key information to the FDT node, suitable for
1270 * verification at run-time. The information added depends on the
1271 * algorithm being used.
1273 * @info: Specifies key and FIT information
1274 * @keydest: Destination FDT blob for public key data
1275 * @return: 0, on success, -ve on error
1277 int (*add_verify_data)(struct image_sign_info *info, void *keydest);
1280 * verify() - Verify a signature against some data
1282 * @info: Specifies key and FIT information
1283 * @data: Pointer to the input data
1284 * @data_len: Data length
1286 * @sig_len: Number of bytes in signature
1287 * @return 0 if verified, -ve on error
1289 int (*verify)(struct image_sign_info *info,
1290 const struct image_region region[], int region_count,
1291 uint8_t *sig, uint sig_len);
1294 /* Declare a new U-Boot crypto algorithm handler */
1295 #define U_BOOT_CRYPTO_ALGO(__name) \
1296 ll_entry_declare(struct crypto_algo, __name, cryptos)
1298 struct padding_algo {
1300 int (*verify)(struct image_sign_info *info,
1301 uint8_t *pad, int pad_len,
1302 const uint8_t *hash, int hash_len);
1305 /* Declare a new U-Boot padding algorithm handler */
1306 #define U_BOOT_PADDING_ALGO(__name) \
1307 ll_entry_declare(struct padding_algo, __name, paddings)
1310 * image_get_checksum_algo() - Look up a checksum algorithm
1312 * @param full_name Name of algorithm in the form "checksum,crypto"
1313 * @return pointer to algorithm information, or NULL if not found
1315 struct checksum_algo *image_get_checksum_algo(const char *full_name);
1318 * image_get_crypto_algo() - Look up a cryptosystem algorithm
1320 * @param full_name Name of algorithm in the form "checksum,crypto"
1321 * @return pointer to algorithm information, or NULL if not found
1323 struct crypto_algo *image_get_crypto_algo(const char *full_name);
1326 * image_get_padding_algo() - Look up a padding algorithm
1328 * @param name Name of padding algorithm
1329 * @return pointer to algorithm information, or NULL if not found
1331 struct padding_algo *image_get_padding_algo(const char *name);
1333 #if CONFIG_IS_ENABLED(FIT)
1336 * fit_image_verify_required_sigs() - Verify signatures marked as 'required'
1338 * @fit: FIT to check
1339 * @image_noffset: Offset of image node to check
1340 * @data: Image data to check
1341 * @size: Size of image data
1342 * @sig_blob: FDT containing public keys
1343 * @no_sigsp: Returns 1 if no signatures were required, and
1344 * therefore nothing was checked. The caller may wish
1345 * to fall back to other mechanisms, or refuse to
1347 * @return 0 if all verified ok, <0 on error
1349 int fit_image_verify_required_sigs(const void *fit, int image_noffset,
1350 const char *data, size_t size, const void *sig_blob,
1354 * fit_image_check_sig() - Check a single image signature node
1356 * @fit: FIT to check
1357 * @noffset: Offset of signature node to check
1358 * @data: Image data to check
1359 * @size: Size of image data
1360 * @required_keynode: Offset in the control FDT of the required key node,
1361 * if any. If this is given, then the image wil not
1362 * pass verification unless that key is used. If this is
1363 * -1 then any signature will do.
1364 * @err_msgp: In the event of an error, this will be pointed to a
1365 * help error string to display to the user.
1366 * @return 0 if all verified ok, <0 on error
1368 int fit_image_check_sig(const void *fit, int noffset, const void *data,
1369 size_t size, int required_keynode, char **err_msgp);
1371 int fit_image_decrypt_data(const void *fit,
1372 int image_noffset, int cipher_noffset,
1373 const void *data, size_t size,
1374 void **data_unciphered, size_t *size_unciphered);
1377 * fit_region_make_list() - Make a list of regions to hash
1379 * Given a list of FIT regions (offset, size) provided by libfdt, create
1380 * a list of regions (void *, size) for use by the signature creationg
1381 * and verification code.
1383 * @fit: FIT image to process
1384 * @fdt_regions: Regions as returned by libfdt
1385 * @count: Number of regions returned by libfdt
1386 * @region: Place to put list of regions (NULL to allocate it)
1387 * @return pointer to list of regions, or NULL if out of memory
1389 struct image_region *fit_region_make_list(const void *fit,
1390 struct fdt_region *fdt_regions, int count,
1391 struct image_region *region);
1393 static inline int fit_image_check_target_arch(const void *fdt, int node)
1396 return fit_image_check_arch(fdt, node, IH_ARCH_DEFAULT);
1403 * At present we only support ciphering on the host, and unciphering on the
1406 #if defined(USE_HOSTCC)
1407 # if defined(CONFIG_FIT_CIPHER)
1408 # define IMAGE_ENABLE_ENCRYPT 1
1409 # define IMAGE_ENABLE_DECRYPT 1
1410 # include <openssl/evp.h>
1412 # define IMAGE_ENABLE_ENCRYPT 0
1413 # define IMAGE_ENABLE_DECRYPT 0
1416 # define IMAGE_ENABLE_ENCRYPT 0
1417 # define IMAGE_ENABLE_DECRYPT CONFIG_IS_ENABLED(FIT_CIPHER)
1420 /* Information passed to the ciphering routines */
1421 struct image_cipher_info {
1422 const char *keydir; /* Directory containing keys */
1423 const char *keyname; /* Name of key to use */
1424 const char *ivname; /* Name of IV to use */
1425 const void *fit; /* Pointer to FIT blob */
1426 int node_noffset; /* Offset of the cipher node */
1427 const char *name; /* Algorithm name */
1428 struct cipher_algo *cipher; /* Cipher algorithm information */
1429 const void *fdt_blob; /* FDT containing key and IV */
1430 const void *key; /* Value of the key */
1431 const void *iv; /* Value of the IV */
1432 size_t size_unciphered; /* Size of the unciphered data */
1435 struct cipher_algo {
1436 const char *name; /* Name of algorithm */
1437 int key_len; /* Length of the key */
1438 int iv_len; /* Length of the IV */
1440 #if IMAGE_ENABLE_ENCRYPT
1441 const EVP_CIPHER * (*calculate_type)(void);
1444 int (*encrypt)(struct image_cipher_info *info,
1445 const unsigned char *data, int data_len,
1446 unsigned char **cipher, int *cipher_len);
1448 int (*add_cipher_data)(struct image_cipher_info *info,
1449 void *keydest, void *fit, int node_noffset);
1451 int (*decrypt)(struct image_cipher_info *info,
1452 const void *cipher, size_t cipher_len,
1453 void **data, size_t *data_len);
1456 int fit_image_cipher_get_algo(const void *fit, int noffset, char **algo);
1458 struct cipher_algo *image_get_cipher_algo(const char *full_name);
1460 #if CONFIG_IS_ENABLED(FIT_VERBOSE)
1461 #define fit_unsupported(msg) printf("! %s:%d " \
1462 "FIT images not supported for '%s'\n", \
1463 __FILE__, __LINE__, (msg))
1465 #define fit_unsupported_reset(msg) printf("! %s:%d " \
1466 "FIT images not supported for '%s' " \
1467 "- must reset board to recover!\n", \
1468 __FILE__, __LINE__, (msg))
1470 #define fit_unsupported(msg)
1471 #define fit_unsupported_reset(msg)
1472 #endif /* FIT_VERBOSE */
1473 #endif /* CONFIG_FIT */
1475 #if !defined(USE_HOSTCC)
1476 #if defined(CONFIG_ANDROID_BOOT_IMAGE)
1477 struct andr_img_hdr;
1478 int android_image_check_header(const struct andr_img_hdr *hdr);
1479 int android_image_get_kernel(const struct andr_img_hdr *hdr, int verify,
1480 ulong *os_data, ulong *os_len);
1481 int android_image_get_ramdisk(const struct andr_img_hdr *hdr,
1482 ulong *rd_data, ulong *rd_len);
1483 int android_image_get_second(const struct andr_img_hdr *hdr,
1484 ulong *second_data, ulong *second_len);
1485 bool android_image_get_dtbo(ulong hdr_addr, ulong *addr, u32 *size);
1486 bool android_image_get_dtb_by_index(ulong hdr_addr, u32 index, ulong *addr,
1488 ulong android_image_get_end(const struct andr_img_hdr *hdr);
1489 ulong android_image_get_kload(const struct andr_img_hdr *hdr);
1490 ulong android_image_get_kcomp(const struct andr_img_hdr *hdr);
1491 void android_print_contents(const struct andr_img_hdr *hdr);
1492 #if !defined(CONFIG_SPL_BUILD)
1493 bool android_image_print_dtb_contents(ulong hdr_addr);
1496 #endif /* CONFIG_ANDROID_BOOT_IMAGE */
1497 #endif /* !USE_HOSTCC */
1500 * board_fit_config_name_match() - Check for a matching board name
1502 * This is used when SPL loads a FIT containing multiple device tree files
1503 * and wants to work out which one to use. The description of each one is
1504 * passed to this function. The description comes from the 'description' field
1505 * in each (FDT) image node.
1507 * @name: Device tree description
1508 * @return 0 if this device tree should be used, non-zero to try the next
1510 int board_fit_config_name_match(const char *name);
1513 * board_fit_image_post_process() - Do any post-process on FIT binary data
1515 * This is used to do any sort of image manipulation, verification, decryption
1516 * etc. in a platform or board specific way. Obviously, anything done here would
1517 * need to be comprehended in how the images were prepared before being injected
1518 * into the FIT creation (i.e. the binary blobs would have been pre-processed
1519 * before being added to the FIT image).
1521 * @fit: pointer to fit image
1522 * @node: offset of image node
1523 * @image: pointer to the image start pointer
1524 * @size: pointer to the image size
1525 * @return no return value (failure should be handled internally)
1527 void board_fit_image_post_process(const void *fit, int node, void **p_image,
1530 #define FDT_ERROR ((ulong)(-1))
1532 ulong fdt_getprop_u32(const void *fdt, int node, const char *prop);
1535 * fit_find_config_node() - Find the node for the best DTB in a FIT image
1537 * A FIT image contains one or more DTBs. This function parses the
1538 * configurations described in the FIT images and returns the node of
1539 * the first matching DTB. To check if a DTB matches a board, this function
1540 * calls board_fit_config_name_match(). If no matching DTB is found, it returns
1541 * the node described by the default configuration if it exists.
1543 * @fdt: pointer to flat device tree
1544 * @return the node if found, -ve otherwise
1546 int fit_find_config_node(const void *fdt);
1549 * Mapping of image types to function handlers to be invoked on the associated
1552 * @type: Type of image, I.E. IH_TYPE_*
1553 * @handler: Function to call on loaded image
1555 struct fit_loadable_tbl {
1558 * handler() - Process a loaded image
1560 * @data: Pointer to start of loaded image data
1561 * @size: Size of loaded image data
1563 void (*handler)(ulong data, size_t size);
1567 * Define a FIT loadable image type handler
1569 * _type is a valid uimage_type ID as defined in the "Image Type" enum above
1570 * _handler is the handler function to call after this image type is loaded
1572 #define U_BOOT_FIT_LOADABLE_HANDLER(_type, _handler) \
1573 ll_entry_declare(struct fit_loadable_tbl, _function, fit_loadable) = { \
1575 .handler = _handler, \
1579 * fit_update - update storage with FIT image
1580 * @fit: Pointer to FIT image
1582 * Update firmware on storage using FIT image as input.
1583 * The storage area to be update will be identified by the name
1584 * in FIT and matching it to "dfu_alt_info" variable.
1586 * Return: 0 on success, non-zero otherwise
1588 int fit_update(const void *fit);
1590 #endif /* __IMAGE_H__ */