2 * (C) Copyright 2008 Semihalf
4 * (C) Copyright 2000-2005
5 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
7 * SPDX-License-Identifier: GPL-2.0+
8 ********************************************************************
9 * NOTE: This header file defines an interface to U-Boot. Including
10 * this (unmodified) header file in another file is considered normal
11 * use of U-Boot, and does *not* fall under the heading of "derived
13 ********************************************************************
20 #include <asm/byteorder.h>
22 /* Define this to avoid #ifdefs later on */
26 #include <sys/types.h>
28 /* new uImage format support enabled on host */
29 #define IMAGE_ENABLE_FIT 1
30 #define IMAGE_ENABLE_OF_LIBFDT 1
31 #define CONFIG_FIT_VERBOSE 1 /* enable fit_format_{error,warning}() */
32 #define CONFIG_FIT_ENABLE_SHA256_SUPPORT
36 #define IMAGE_ENABLE_IGNORE 0
37 #define IMAGE_INDENT_STRING ""
42 #include <asm/u-boot.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 # ifdef CONFIG_SPL_BUILD
59 # ifdef CONFIG_SPL_CRC32_SUPPORT
60 # define IMAGE_ENABLE_CRC32 1
62 # ifdef CONFIG_SPL_MD5_SUPPORT
63 # define IMAGE_ENABLE_MD5 1
65 # ifdef CONFIG_SPL_SHA1_SUPPORT
66 # define IMAGE_ENABLE_SHA1 1
69 # define CONFIG_CRC32 /* FIT images need CRC32 support */
70 # define IMAGE_ENABLE_CRC32 1
71 # define IMAGE_ENABLE_MD5 1
72 # define IMAGE_ENABLE_SHA1 1
75 #ifndef IMAGE_ENABLE_CRC32
76 #define IMAGE_ENABLE_CRC32 0
79 #ifndef IMAGE_ENABLE_MD5
80 #define IMAGE_ENABLE_MD5 0
83 #ifndef IMAGE_ENABLE_SHA1
84 #define IMAGE_ENABLE_SHA1 0
87 #if defined(CONFIG_FIT_ENABLE_SHA256_SUPPORT) || \
88 defined(CONFIG_SPL_SHA256_SUPPORT)
89 #define IMAGE_ENABLE_SHA256 1
91 #define IMAGE_ENABLE_SHA256 0
94 #endif /* IMAGE_ENABLE_FIT */
96 #ifdef CONFIG_SYS_BOOT_GET_CMDLINE
97 # define IMAGE_BOOT_GET_CMDLINE 1
99 # define IMAGE_BOOT_GET_CMDLINE 0
102 #ifdef CONFIG_OF_BOARD_SETUP
103 # define IMAGE_OF_BOARD_SETUP 1
105 # define IMAGE_OF_BOARD_SETUP 0
108 #ifdef CONFIG_OF_SYSTEM_SETUP
109 # define IMAGE_OF_SYSTEM_SETUP 1
111 # define IMAGE_OF_SYSTEM_SETUP 0
124 * Operating System Codes
126 * The following are exposed to uImage header.
127 * Do not change values for backward compatibility.
130 IH_OS_INVALID = 0, /* Invalid OS */
131 IH_OS_OPENBSD, /* OpenBSD */
132 IH_OS_NETBSD, /* NetBSD */
133 IH_OS_FREEBSD, /* FreeBSD */
134 IH_OS_4_4BSD, /* 4.4BSD */
135 IH_OS_LINUX, /* Linux */
136 IH_OS_SVR4, /* SVR4 */
137 IH_OS_ESIX, /* Esix */
138 IH_OS_SOLARIS, /* Solaris */
139 IH_OS_IRIX, /* Irix */
141 IH_OS_DELL, /* Dell */
143 IH_OS_LYNXOS, /* LynxOS */
144 IH_OS_VXWORKS, /* VxWorks */
145 IH_OS_PSOS, /* pSOS */
147 IH_OS_U_BOOT, /* Firmware */
148 IH_OS_RTEMS, /* RTEMS */
149 IH_OS_ARTOS, /* ARTOS */
150 IH_OS_UNITY, /* Unity OS */
151 IH_OS_INTEGRITY, /* INTEGRITY */
153 IH_OS_PLAN9, /* Plan 9 */
154 IH_OS_OPENRTOS, /* OpenRTOS */
155 IH_OS_ARM_TRUSTED_FIRMWARE, /* ARM Trusted Firmware */
156 IH_OS_TEE, /* Trusted Execution Environment */
162 * CPU Architecture Codes (supported by Linux)
164 * The following are exposed to uImage header.
165 * Do not change values for backward compatibility.
168 IH_ARCH_INVALID = 0, /* Invalid CPU */
169 IH_ARCH_ALPHA, /* Alpha */
170 IH_ARCH_ARM, /* ARM */
171 IH_ARCH_I386, /* Intel x86 */
172 IH_ARCH_IA64, /* IA64 */
173 IH_ARCH_MIPS, /* MIPS */
174 IH_ARCH_MIPS64, /* MIPS 64 Bit */
175 IH_ARCH_PPC, /* PowerPC */
176 IH_ARCH_S390, /* IBM S390 */
177 IH_ARCH_SH, /* SuperH */
178 IH_ARCH_SPARC, /* Sparc */
179 IH_ARCH_SPARC64, /* Sparc 64 Bit */
180 IH_ARCH_M68K, /* M68K */
181 IH_ARCH_NIOS, /* Nios-32 */
182 IH_ARCH_MICROBLAZE, /* MicroBlaze */
183 IH_ARCH_NIOS2, /* Nios-II */
184 IH_ARCH_BLACKFIN, /* Blackfin */
185 IH_ARCH_AVR32, /* AVR32 */
186 IH_ARCH_ST200, /* STMicroelectronics ST200 */
187 IH_ARCH_SANDBOX, /* Sandbox architecture (test only) */
188 IH_ARCH_NDS32, /* ANDES Technology - NDS32 */
189 IH_ARCH_OPENRISC, /* OpenRISC 1000 */
190 IH_ARCH_ARM64, /* ARM64 */
191 IH_ARCH_ARC, /* Synopsys DesignWare ARC */
192 IH_ARCH_X86_64, /* AMD x86_64, Intel and Via */
193 IH_ARCH_XTENSA, /* Xtensa */
194 IH_ARCH_RISCV, /* RISC-V */
202 * "Standalone Programs" are directly runnable in the environment
203 * provided by U-Boot; it is expected that (if they behave
204 * well) you can continue to work in U-Boot after return from
205 * the Standalone Program.
206 * "OS Kernel Images" are usually images of some Embedded OS which
207 * will take over control completely. Usually these programs
208 * will install their own set of exception handlers, device
209 * drivers, set up the MMU, etc. - this means, that you cannot
210 * expect to re-enter U-Boot except by resetting the CPU.
211 * "RAMDisk Images" are more or less just data blocks, and their
212 * parameters (address, size) are passed to an OS kernel that is
214 * "Multi-File Images" contain several images, typically an OS
215 * (Linux) kernel image and one or more data images like
216 * RAMDisks. This construct is useful for instance when you want
217 * to boot over the network using BOOTP etc., where the boot
218 * server provides just a single image file, but you want to get
219 * for instance an OS kernel and a RAMDisk image.
221 * "Multi-File Images" start with a list of image sizes, each
222 * image size (in bytes) specified by an "uint32_t" in network
223 * byte order. This list is terminated by an "(uint32_t)0".
224 * Immediately after the terminating 0 follow the images, one by
225 * one, all aligned on "uint32_t" boundaries (size rounded up to
226 * a multiple of 4 bytes - except for the last file).
228 * "Firmware Images" are binary images containing firmware (like
229 * U-Boot or FPGA images) which usually will be programmed to
232 * "Script files" are command sequences that will be executed by
233 * U-Boot's command interpreter; this feature is especially
234 * useful when you configure U-Boot to use a real shell (hush)
235 * as command interpreter (=> Shell Scripts).
237 * The following are exposed to uImage header.
238 * Do not change values for backward compatibility.
242 IH_TYPE_INVALID = 0, /* Invalid Image */
243 IH_TYPE_STANDALONE, /* Standalone Program */
244 IH_TYPE_KERNEL, /* OS Kernel Image */
245 IH_TYPE_RAMDISK, /* RAMDisk Image */
246 IH_TYPE_MULTI, /* Multi-File Image */
247 IH_TYPE_FIRMWARE, /* Firmware Image */
248 IH_TYPE_SCRIPT, /* Script file */
249 IH_TYPE_FILESYSTEM, /* Filesystem Image (any type) */
250 IH_TYPE_FLATDT, /* Binary Flat Device Tree Blob */
251 IH_TYPE_KWBIMAGE, /* Kirkwood Boot Image */
252 IH_TYPE_IMXIMAGE, /* Freescale IMXBoot Image */
253 IH_TYPE_UBLIMAGE, /* Davinci UBL Image */
254 IH_TYPE_OMAPIMAGE, /* TI OMAP Config Header Image */
255 IH_TYPE_AISIMAGE, /* TI Davinci AIS Image */
256 /* OS Kernel Image, can run from any load address */
257 IH_TYPE_KERNEL_NOLOAD,
258 IH_TYPE_PBLIMAGE, /* Freescale PBL Boot Image */
259 IH_TYPE_MXSIMAGE, /* Freescale MXSBoot Image */
260 IH_TYPE_GPIMAGE, /* TI Keystone GPHeader Image */
261 IH_TYPE_ATMELIMAGE, /* ATMEL ROM bootable Image */
262 IH_TYPE_SOCFPGAIMAGE, /* Altera SOCFPGA Preloader */
263 IH_TYPE_X86_SETUP, /* x86 setup.bin Image */
264 IH_TYPE_LPC32XXIMAGE, /* x86 setup.bin Image */
265 IH_TYPE_LOADABLE, /* A list of typeless images */
266 IH_TYPE_RKIMAGE, /* Rockchip Boot Image */
267 IH_TYPE_RKSD, /* Rockchip SD card */
268 IH_TYPE_RKSPI, /* Rockchip SPI image */
269 IH_TYPE_ZYNQIMAGE, /* Xilinx Zynq Boot Image */
270 IH_TYPE_ZYNQMPIMAGE, /* Xilinx ZynqMP Boot Image */
271 IH_TYPE_FPGA, /* FPGA Image */
272 IH_TYPE_VYBRIDIMAGE, /* VYBRID .vyb Image */
273 IH_TYPE_TEE, /* Trusted Execution Environment OS Image */
274 IH_TYPE_FIRMWARE_IVT, /* Firmware Image with HABv4 IVT */
275 IH_TYPE_PMMC, /* TI Power Management Micro-Controller Firmware */
276 IH_TYPE_STM32IMAGE, /* STMicroelectronics STM32 Image */
278 IH_TYPE_COUNT, /* Number of image types */
284 * The following are exposed to uImage header.
285 * Do not change values for backward compatibility.
288 IH_COMP_NONE = 0, /* No Compression Used */
289 IH_COMP_GZIP, /* gzip Compression Used */
290 IH_COMP_BZIP2, /* bzip2 Compression Used */
291 IH_COMP_LZMA, /* lzma Compression Used */
292 IH_COMP_LZO, /* lzo Compression Used */
293 IH_COMP_LZ4, /* lz4 Compression Used */
298 #define IH_MAGIC 0x27051956 /* Image Magic Number */
299 #define IH_NMLEN 32 /* Image Name Length */
301 /* Reused from common.h */
302 #define ROUND(a, b) (((a) + (b) - 1) & ~((b) - 1))
305 * Legacy format image header,
306 * all data in network byte order (aka natural aka bigendian).
308 typedef struct image_header {
309 __be32 ih_magic; /* Image Header Magic Number */
310 __be32 ih_hcrc; /* Image Header CRC Checksum */
311 __be32 ih_time; /* Image Creation Timestamp */
312 __be32 ih_size; /* Image Data Size */
313 __be32 ih_load; /* Data Load Address */
314 __be32 ih_ep; /* Entry Point Address */
315 __be32 ih_dcrc; /* Image Data CRC Checksum */
316 uint8_t ih_os; /* Operating System */
317 uint8_t ih_arch; /* CPU architecture */
318 uint8_t ih_type; /* Image Type */
319 uint8_t ih_comp; /* Compression Type */
320 uint8_t ih_name[IH_NMLEN]; /* Image Name */
323 typedef struct image_info {
324 ulong start, end; /* start/end of blob */
325 ulong image_start, image_len; /* start of image within blob, len of image */
326 ulong load; /* load addr for the image */
327 uint8_t comp, type, os; /* compression, type of image, os type */
328 uint8_t arch; /* CPU architecture */
332 * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
335 typedef struct bootm_headers {
337 * Legacy os image header, if it is a multi component image
338 * then boot_get_ramdisk() and get_fdt() will attempt to get
339 * data from second and third component accordingly.
341 image_header_t *legacy_hdr_os; /* image header pointer */
342 image_header_t legacy_hdr_os_copy; /* header copy */
343 ulong legacy_hdr_valid;
346 const char *fit_uname_cfg; /* configuration node unit name */
348 void *fit_hdr_os; /* os FIT image header */
349 const char *fit_uname_os; /* os subimage node unit name */
350 int fit_noffset_os; /* os subimage node offset */
352 void *fit_hdr_rd; /* init ramdisk FIT image header */
353 const char *fit_uname_rd; /* init ramdisk subimage node unit name */
354 int fit_noffset_rd; /* init ramdisk subimage node offset */
356 void *fit_hdr_fdt; /* FDT blob FIT image header */
357 const char *fit_uname_fdt; /* FDT blob subimage node unit name */
358 int fit_noffset_fdt;/* FDT blob subimage node offset */
360 void *fit_hdr_setup; /* x86 setup FIT image header */
361 const char *fit_uname_setup; /* x86 setup subimage node name */
362 int fit_noffset_setup;/* x86 setup subimage node offset */
366 image_info_t os; /* os image info */
367 ulong ep; /* entry point of OS */
369 ulong rd_start, rd_end;/* ramdisk start/end */
371 char *ft_addr; /* flat dev tree address */
372 ulong ft_len; /* length of flat device tree */
381 int verify; /* env_get("verify")[0] != 'n' */
383 #define BOOTM_STATE_START (0x00000001)
384 #define BOOTM_STATE_FINDOS (0x00000002)
385 #define BOOTM_STATE_FINDOTHER (0x00000004)
386 #define BOOTM_STATE_LOADOS (0x00000008)
387 #define BOOTM_STATE_RAMDISK (0x00000010)
388 #define BOOTM_STATE_FDT (0x00000020)
389 #define BOOTM_STATE_OS_CMDLINE (0x00000040)
390 #define BOOTM_STATE_OS_BD_T (0x00000080)
391 #define BOOTM_STATE_OS_PREP (0x00000100)
392 #define BOOTM_STATE_OS_FAKE_GO (0x00000200) /* 'Almost' run the OS */
393 #define BOOTM_STATE_OS_GO (0x00000400)
397 struct lmb lmb; /* for memory mgmt */
401 extern bootm_headers_t images;
404 * Some systems (for example LWMON) have very short watchdog periods;
405 * we must make sure to split long operations like memmove() or
406 * checksum calculations into reasonable chunks.
409 #define CHUNKSZ (64 * 1024)
412 #ifndef CHUNKSZ_CRC32
413 #define CHUNKSZ_CRC32 (64 * 1024)
417 #define CHUNKSZ_MD5 (64 * 1024)
421 #define CHUNKSZ_SHA1 (64 * 1024)
424 #define uimage_to_cpu(x) be32_to_cpu(x)
425 #define cpu_to_uimage(x) cpu_to_be32(x)
428 * Translation table for entries of a specific type; used by
429 * get_table_entry_id() and get_table_entry_name().
431 typedef struct table_entry {
433 char *sname; /* short (input) name to find table entry */
434 char *lname; /* long (output) name to print for messages */
438 * get_table_entry_id() scans the translation table trying to find an
439 * entry that matches the given short name. If a matching entry is
440 * found, it's id is returned to the caller.
442 int get_table_entry_id(const table_entry_t *table,
443 const char *table_name, const char *name);
445 * get_table_entry_name() scans the translation table trying to find
446 * an entry that matches the given id. If a matching entry is found,
447 * its long name is returned to the caller.
449 char *get_table_entry_name(const table_entry_t *table, char *msg, int id);
451 const char *genimg_get_os_name(uint8_t os);
454 * genimg_get_os_short_name() - get the short name for an OS
456 * @param os OS (IH_OS_...)
457 * @return OS short name, or "unknown" if unknown
459 const char *genimg_get_os_short_name(uint8_t comp);
461 const char *genimg_get_arch_name(uint8_t arch);
464 * genimg_get_arch_short_name() - get the short name for an architecture
466 * @param arch Architecture type (IH_ARCH_...)
467 * @return architecture short name, or "unknown" if unknown
469 const char *genimg_get_arch_short_name(uint8_t arch);
471 const char *genimg_get_type_name(uint8_t type);
474 * genimg_get_type_short_name() - get the short name for an image type
476 * @param type Image type (IH_TYPE_...)
477 * @return image short name, or "unknown" if unknown
479 const char *genimg_get_type_short_name(uint8_t type);
481 const char *genimg_get_comp_name(uint8_t comp);
484 * genimg_get_comp_short_name() - get the short name for a compression method
486 * @param comp compression method (IH_COMP_...)
487 * @return compression method short name, or "unknown" if unknown
489 const char *genimg_get_comp_short_name(uint8_t comp);
492 * genimg_get_cat_name() - Get the name of an item in a category
494 * @category: Category of item
496 * @return name of item, or "Unknown ..." if unknown
498 const char *genimg_get_cat_name(enum ih_category category, uint id);
501 * genimg_get_cat_short_name() - Get the short name of an item in a category
503 * @category: Category of item
505 * @return short name of item, or "Unknown ..." if unknown
507 const char *genimg_get_cat_short_name(enum ih_category category, uint id);
510 * genimg_get_cat_count() - Get the number of items in a category
512 * @category: Category to check
513 * @return the number of items in the category (IH_xxx_COUNT)
515 int genimg_get_cat_count(enum ih_category category);
518 * genimg_get_cat_desc() - Get the description of a category
520 * @return the description of a category, e.g. "architecture". This
521 * effectively converts the enum to a string.
523 const char *genimg_get_cat_desc(enum ih_category category);
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_IMAGE_FORMAT_LEGACY)
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);
661 * fit_get_node_from_config() - Look up an image a FIT by type
663 * This looks in the selected conf- node (images->fit_uname_cfg) for a
664 * particular image type (e.g. "kernel") and then finds the image that is
667 * For example, for something like:
680 * the function will return the node offset of the kernel@1 node, assuming
681 * that conf-1 is the chosen configuration.
683 * @param images Boot images structure
684 * @param prop_name Property name to look up (FIT_..._PROP)
685 * @param addr Address of FIT in memory
687 int fit_get_node_from_config(bootm_headers_t *images, const char *prop_name,
690 int boot_get_fdt(int flag, int argc, char * const argv[], uint8_t arch,
691 bootm_headers_t *images,
692 char **of_flat_tree, ulong *of_size);
693 void boot_fdt_add_mem_rsv_regions(struct lmb *lmb, void *fdt_blob);
694 int boot_relocate_fdt(struct lmb *lmb, char **of_flat_tree, ulong *of_size);
696 int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len,
697 ulong *initrd_start, ulong *initrd_end);
698 int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end);
699 #ifdef CONFIG_SYS_BOOT_GET_KBD
700 int boot_get_kbd(struct lmb *lmb, bd_t **kbd);
701 #endif /* CONFIG_SYS_BOOT_GET_KBD */
702 #endif /* !USE_HOSTCC */
704 /*******************************************************************/
705 /* Legacy format specific code (prefixed with image_) */
706 /*******************************************************************/
707 static inline uint32_t image_get_header_size(void)
709 return (sizeof(image_header_t));
712 #define image_get_hdr_l(f) \
713 static inline uint32_t image_get_##f(const image_header_t *hdr) \
715 return uimage_to_cpu(hdr->ih_##f); \
717 image_get_hdr_l(magic) /* image_get_magic */
718 image_get_hdr_l(hcrc) /* image_get_hcrc */
719 image_get_hdr_l(time) /* image_get_time */
720 image_get_hdr_l(size) /* image_get_size */
721 image_get_hdr_l(load) /* image_get_load */
722 image_get_hdr_l(ep) /* image_get_ep */
723 image_get_hdr_l(dcrc) /* image_get_dcrc */
725 #define image_get_hdr_b(f) \
726 static inline uint8_t image_get_##f(const image_header_t *hdr) \
728 return hdr->ih_##f; \
730 image_get_hdr_b(os) /* image_get_os */
731 image_get_hdr_b(arch) /* image_get_arch */
732 image_get_hdr_b(type) /* image_get_type */
733 image_get_hdr_b(comp) /* image_get_comp */
735 static inline char *image_get_name(const image_header_t *hdr)
737 return (char *)hdr->ih_name;
740 static inline uint32_t image_get_data_size(const image_header_t *hdr)
742 return image_get_size(hdr);
746 * image_get_data - get image payload start address
749 * image_get_data() returns address of the image payload. For single
750 * component images it is image data start. For multi component
751 * images it points to the null terminated table of sub-images sizes.
754 * image payload data start address
756 static inline ulong image_get_data(const image_header_t *hdr)
758 return ((ulong)hdr + image_get_header_size());
761 static inline uint32_t image_get_image_size(const image_header_t *hdr)
763 return (image_get_size(hdr) + image_get_header_size());
765 static inline ulong image_get_image_end(const image_header_t *hdr)
767 return ((ulong)hdr + image_get_image_size(hdr));
770 #define image_set_hdr_l(f) \
771 static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
773 hdr->ih_##f = cpu_to_uimage(val); \
775 image_set_hdr_l(magic) /* image_set_magic */
776 image_set_hdr_l(hcrc) /* image_set_hcrc */
777 image_set_hdr_l(time) /* image_set_time */
778 image_set_hdr_l(size) /* image_set_size */
779 image_set_hdr_l(load) /* image_set_load */
780 image_set_hdr_l(ep) /* image_set_ep */
781 image_set_hdr_l(dcrc) /* image_set_dcrc */
783 #define image_set_hdr_b(f) \
784 static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
788 image_set_hdr_b(os) /* image_set_os */
789 image_set_hdr_b(arch) /* image_set_arch */
790 image_set_hdr_b(type) /* image_set_type */
791 image_set_hdr_b(comp) /* image_set_comp */
793 static inline void image_set_name(image_header_t *hdr, const char *name)
795 strncpy(image_get_name(hdr), name, IH_NMLEN);
798 int image_check_hcrc(const image_header_t *hdr);
799 int image_check_dcrc(const image_header_t *hdr);
801 ulong env_get_bootm_low(void);
802 phys_size_t env_get_bootm_size(void);
803 phys_size_t env_get_bootm_mapsize(void);
805 void memmove_wd(void *to, void *from, size_t len, ulong chunksz);
807 static inline int image_check_magic(const image_header_t *hdr)
809 return (image_get_magic(hdr) == IH_MAGIC);
811 static inline int image_check_type(const image_header_t *hdr, uint8_t type)
813 return (image_get_type(hdr) == type);
815 static inline int image_check_arch(const image_header_t *hdr, uint8_t arch)
817 return (image_get_arch(hdr) == arch) ||
818 (image_get_arch(hdr) == IH_ARCH_ARM && arch == IH_ARCH_ARM64);
820 static inline int image_check_os(const image_header_t *hdr, uint8_t os)
822 return (image_get_os(hdr) == os);
825 ulong image_multi_count(const image_header_t *hdr);
826 void image_multi_getimg(const image_header_t *hdr, ulong idx,
827 ulong *data, ulong *len);
829 void image_print_contents(const void *hdr);
832 static inline int image_check_target_arch(const image_header_t *hdr)
834 #ifndef IH_ARCH_DEFAULT
835 # error "please define IH_ARCH_DEFAULT in your arch asm/u-boot.h"
837 return image_check_arch(hdr, IH_ARCH_DEFAULT);
839 #endif /* USE_HOSTCC */
842 * Set up properties in the FDT
844 * This sets up properties in the FDT that is to be passed to linux.
846 * @images: Images information
847 * @blob: FDT to update
848 * @of_size: Size of the FDT
849 * @lmb: Points to logical memory block structure
850 * @return 0 if ok, <0 on failure
852 int image_setup_libfdt(bootm_headers_t *images, void *blob,
853 int of_size, struct lmb *lmb);
856 * Set up the FDT to use for booting a kernel
858 * This performs ramdisk setup, sets up the FDT if required, and adds
859 * paramters to the FDT if libfdt is available.
861 * @param images Images information
862 * @return 0 if ok, <0 on failure
864 int image_setup_linux(bootm_headers_t *images);
867 * bootz_setup() - Extract stat and size of a Linux xImage
869 * @image: Address of image
870 * @start: Returns start address of image
871 * @end : Returns end address of image
872 * @return 0 if OK, 1 if the image was not recognised
874 int bootz_setup(ulong image, ulong *start, ulong *end);
877 * Return the correct start address and size of a Linux aarch64 Image.
879 * @image: Address of image
880 * @start: Returns start address of image
881 * @size : Returns size image
882 * @return 0 if OK, 1 if the image was not recognised
884 int booti_setup(ulong image, ulong *relocated_addr, ulong *size);
886 /*******************************************************************/
887 /* New uImage format specific code (prefixed with fit_) */
888 /*******************************************************************/
890 #define FIT_IMAGES_PATH "/images"
891 #define FIT_CONFS_PATH "/configurations"
893 /* hash/signature node */
894 #define FIT_HASH_NODENAME "hash"
895 #define FIT_ALGO_PROP "algo"
896 #define FIT_VALUE_PROP "value"
897 #define FIT_IGNORE_PROP "uboot-ignore"
898 #define FIT_SIG_NODENAME "signature"
901 #define FIT_DATA_PROP "data"
902 #define FIT_DATA_POSITION_PROP "data-position"
903 #define FIT_DATA_OFFSET_PROP "data-offset"
904 #define FIT_DATA_SIZE_PROP "data-size"
905 #define FIT_TIMESTAMP_PROP "timestamp"
906 #define FIT_DESC_PROP "description"
907 #define FIT_ARCH_PROP "arch"
908 #define FIT_TYPE_PROP "type"
909 #define FIT_OS_PROP "os"
910 #define FIT_COMP_PROP "compression"
911 #define FIT_ENTRY_PROP "entry"
912 #define FIT_LOAD_PROP "load"
914 /* configuration node */
915 #define FIT_KERNEL_PROP "kernel"
916 #define FIT_RAMDISK_PROP "ramdisk"
917 #define FIT_FDT_PROP "fdt"
918 #define FIT_LOADABLE_PROP "loadables"
919 #define FIT_DEFAULT_PROP "default"
920 #define FIT_SETUP_PROP "setup"
921 #define FIT_FPGA_PROP "fpga"
923 #define FIT_MAX_HASH_LEN HASH_MAX_DIGEST_SIZE
926 /* cmdline argument format parsing */
927 int fit_parse_conf(const char *spec, ulong addr_curr,
928 ulong *addr, const char **conf_name);
929 int fit_parse_subimage(const char *spec, ulong addr_curr,
930 ulong *addr, const char **image_name);
932 int fit_get_subimage_count(const void *fit, int images_noffset);
933 void fit_print_contents(const void *fit);
934 void fit_image_print(const void *fit, int noffset, const char *p);
937 * fit_get_end - get FIT image size
938 * @fit: pointer to the FIT format image header
941 * size of the FIT image (blob) in memory
943 static inline ulong fit_get_size(const void *fit)
945 return fdt_totalsize(fit);
949 * fit_get_end - get FIT image end
950 * @fit: pointer to the FIT format image header
953 * end address of the FIT image (blob) in memory
955 ulong fit_get_end(const void *fit);
958 * fit_get_name - get FIT node name
959 * @fit: pointer to the FIT format image header
963 * pointer to node name, on success
965 static inline const char *fit_get_name(const void *fit_hdr,
966 int noffset, int *len)
968 return fdt_get_name(fit_hdr, noffset, len);
971 int fit_get_desc(const void *fit, int noffset, char **desc);
972 int fit_get_timestamp(const void *fit, int noffset, time_t *timestamp);
974 int fit_image_get_node(const void *fit, const char *image_uname);
975 int fit_image_get_os(const void *fit, int noffset, uint8_t *os);
976 int fit_image_get_arch(const void *fit, int noffset, uint8_t *arch);
977 int fit_image_get_type(const void *fit, int noffset, uint8_t *type);
978 int fit_image_get_comp(const void *fit, int noffset, uint8_t *comp);
979 int fit_image_get_load(const void *fit, int noffset, ulong *load);
980 int fit_image_get_entry(const void *fit, int noffset, ulong *entry);
981 int fit_image_get_data(const void *fit, int noffset,
982 const void **data, size_t *size);
983 int fit_image_get_data_offset(const void *fit, int noffset, int *data_offset);
984 int fit_image_get_data_position(const void *fit, int noffset,
986 int fit_image_get_data_size(const void *fit, int noffset, int *data_size);
988 int fit_image_hash_get_algo(const void *fit, int noffset, char **algo);
989 int fit_image_hash_get_value(const void *fit, int noffset, uint8_t **value,
992 int fit_set_timestamp(void *fit, int noffset, time_t timestamp);
995 * fit_add_verification_data() - add verification data to FIT image nodes
997 * @keydir: Directory containing keys
998 * @kwydest: FDT blob to write public key information to
999 * @fit: Pointer to the FIT format image header
1000 * @comment: Comment to add to signature nodes
1001 * @require_keys: Mark all keys as 'required'
1002 * @engine_id: Engine to use for signing
1004 * Adds hash values for all component images in the FIT blob.
1005 * Hashes are calculated for all component images which have hash subnodes
1006 * with algorithm property set to one of the supported hash algorithms.
1008 * Also add signatures if signature nodes are present.
1012 * libfdt error code, on failure
1014 int fit_add_verification_data(const char *keydir, void *keydest, void *fit,
1015 const char *comment, int require_keys,
1016 const char *engine_id);
1018 int fit_image_verify_with_data(const void *fit, int image_noffset,
1019 const void *data, size_t size);
1020 int fit_image_verify(const void *fit, int noffset);
1021 int fit_config_verify(const void *fit, int conf_noffset);
1022 int fit_all_image_verify(const void *fit);
1023 int fit_image_check_os(const void *fit, int noffset, uint8_t os);
1024 int fit_image_check_arch(const void *fit, int noffset, uint8_t arch);
1025 int fit_image_check_type(const void *fit, int noffset, uint8_t type);
1026 int fit_image_check_comp(const void *fit, int noffset, uint8_t comp);
1027 int fit_check_format(const void *fit);
1029 int fit_conf_find_compat(const void *fit, const void *fdt);
1030 int fit_conf_get_node(const void *fit, const char *conf_uname);
1033 * fit_conf_get_prop_node() - Get node refered to by a configuration
1034 * @fit: FIT to check
1035 * @noffset: Offset of conf@xxx node to check
1036 * @prop_name: Property to read from the conf node
1038 * The conf- nodes contain references to other nodes, using properties
1039 * like 'kernel = "kernel"'. Given such a property name (e.g. "kernel"),
1040 * return the offset of the node referred to (e.g. offset of node
1043 int fit_conf_get_prop_node(const void *fit, int noffset,
1044 const char *prop_name);
1046 void fit_conf_print(const void *fit, int noffset, const char *p);
1048 int fit_check_ramdisk(const void *fit, int os_noffset,
1049 uint8_t arch, int verify);
1051 int calculate_hash(const void *data, int data_len, const char *algo,
1052 uint8_t *value, int *value_len);
1055 * At present we only support signing on the host, and verification on the
1058 #if defined(CONFIG_FIT_SIGNATURE)
1060 # define IMAGE_ENABLE_SIGN 1
1061 # define IMAGE_ENABLE_VERIFY 1
1062 # include <openssl/evp.h>
1064 # define IMAGE_ENABLE_SIGN 0
1065 # define IMAGE_ENABLE_VERIFY 1
1068 # define IMAGE_ENABLE_SIGN 0
1069 # define IMAGE_ENABLE_VERIFY 0
1073 void *image_get_host_blob(void);
1074 void image_set_host_blob(void *host_blob);
1075 # define gd_fdt_blob() image_get_host_blob()
1077 # define gd_fdt_blob() (gd->fdt_blob)
1080 #ifdef CONFIG_FIT_BEST_MATCH
1081 #define IMAGE_ENABLE_BEST_MATCH 1
1083 #define IMAGE_ENABLE_BEST_MATCH 0
1086 /* Information passed to the signing routines */
1087 struct image_sign_info {
1088 const char *keydir; /* Directory conaining keys */
1089 const char *keyname; /* Name of key to use */
1090 void *fit; /* Pointer to FIT blob */
1091 int node_offset; /* Offset of signature node */
1092 const char *name; /* Algorithm name */
1093 struct checksum_algo *checksum; /* Checksum algorithm information */
1094 struct crypto_algo *crypto; /* Crypto algorithm information */
1095 const void *fdt_blob; /* FDT containing public keys */
1096 int required_keynode; /* Node offset of key to use: -1=any */
1097 const char *require_keys; /* Value for 'required' property */
1098 const char *engine_id; /* Engine to use for signing */
1100 #endif /* Allow struct image_region to always be defined for rsa.h */
1102 /* A part of an image, used for hashing */
1103 struct image_region {
1108 #if IMAGE_ENABLE_FIT
1110 #if IMAGE_ENABLE_VERIFY
1111 # include <u-boot/rsa-checksum.h>
1113 struct checksum_algo {
1115 const int checksum_len;
1117 const uint8_t *der_prefix;
1118 #if IMAGE_ENABLE_SIGN
1119 const EVP_MD *(*calculate_sign)(void);
1121 int (*calculate)(const char *name,
1122 const struct image_region region[],
1123 int region_count, uint8_t *checksum);
1126 struct crypto_algo {
1127 const char *name; /* Name of algorithm */
1131 * sign() - calculate and return signature for given input data
1133 * @info: Specifies key and FIT information
1134 * @data: Pointer to the input data
1135 * @data_len: Data length
1136 * @sigp: Set to an allocated buffer holding the signature
1137 * @sig_len: Set to length of the calculated hash
1139 * This computes input data signature according to selected algorithm.
1140 * Resulting signature value is placed in an allocated buffer, the
1141 * pointer is returned as *sigp. The length of the calculated
1142 * signature is returned via the sig_len pointer argument. The caller
1143 * should free *sigp.
1145 * @return: 0, on success, -ve on error
1147 int (*sign)(struct image_sign_info *info,
1148 const struct image_region region[],
1149 int region_count, uint8_t **sigp, uint *sig_len);
1152 * add_verify_data() - Add verification information to FDT
1154 * Add public key information to the FDT node, suitable for
1155 * verification at run-time. The information added depends on the
1156 * algorithm being used.
1158 * @info: Specifies key and FIT information
1159 * @keydest: Destination FDT blob for public key data
1160 * @return: 0, on success, -ve on error
1162 int (*add_verify_data)(struct image_sign_info *info, void *keydest);
1165 * verify() - Verify a signature against some data
1167 * @info: Specifies key and FIT information
1168 * @data: Pointer to the input data
1169 * @data_len: Data length
1171 * @sig_len: Number of bytes in signature
1172 * @return 0 if verified, -ve on error
1174 int (*verify)(struct image_sign_info *info,
1175 const struct image_region region[], int region_count,
1176 uint8_t *sig, uint sig_len);
1180 * image_get_checksum_algo() - Look up a checksum algorithm
1182 * @param full_name Name of algorithm in the form "checksum,crypto"
1183 * @return pointer to algorithm information, or NULL if not found
1185 struct checksum_algo *image_get_checksum_algo(const char *full_name);
1188 * image_get_crypto_algo() - Look up a cryptosystem algorithm
1190 * @param full_name Name of algorithm in the form "checksum,crypto"
1191 * @return pointer to algorithm information, or NULL if not found
1193 struct crypto_algo *image_get_crypto_algo(const char *full_name);
1196 * fit_image_verify_required_sigs() - Verify signatures marked as 'required'
1198 * @fit: FIT to check
1199 * @image_noffset: Offset of image node to check
1200 * @data: Image data to check
1201 * @size: Size of image data
1202 * @sig_blob: FDT containing public keys
1203 * @no_sigsp: Returns 1 if no signatures were required, and
1204 * therefore nothing was checked. The caller may wish
1205 * to fall back to other mechanisms, or refuse to
1207 * @return 0 if all verified ok, <0 on error
1209 int fit_image_verify_required_sigs(const void *fit, int image_noffset,
1210 const char *data, size_t size, const void *sig_blob,
1214 * fit_image_check_sig() - Check a single image signature node
1216 * @fit: FIT to check
1217 * @noffset: Offset of signature node to check
1218 * @data: Image data to check
1219 * @size: Size of image data
1220 * @required_keynode: Offset in the control FDT of the required key node,
1221 * if any. If this is given, then the image wil not
1222 * pass verification unless that key is used. If this is
1223 * -1 then any signature will do.
1224 * @err_msgp: In the event of an error, this will be pointed to a
1225 * help error string to display to the user.
1226 * @return 0 if all verified ok, <0 on error
1228 int fit_image_check_sig(const void *fit, int noffset, const void *data,
1229 size_t size, int required_keynode, char **err_msgp);
1232 * fit_region_make_list() - Make a list of regions to hash
1234 * Given a list of FIT regions (offset, size) provided by libfdt, create
1235 * a list of regions (void *, size) for use by the signature creationg
1236 * and verification code.
1238 * @fit: FIT image to process
1239 * @fdt_regions: Regions as returned by libfdt
1240 * @count: Number of regions returned by libfdt
1241 * @region: Place to put list of regions (NULL to allocate it)
1242 * @return pointer to list of regions, or NULL if out of memory
1244 struct image_region *fit_region_make_list(const void *fit,
1245 struct fdt_region *fdt_regions, int count,
1246 struct image_region *region);
1248 static inline int fit_image_check_target_arch(const void *fdt, int node)
1251 return fit_image_check_arch(fdt, node, IH_ARCH_DEFAULT);
1257 #ifdef CONFIG_FIT_VERBOSE
1258 #define fit_unsupported(msg) printf("! %s:%d " \
1259 "FIT images not supported for '%s'\n", \
1260 __FILE__, __LINE__, (msg))
1262 #define fit_unsupported_reset(msg) printf("! %s:%d " \
1263 "FIT images not supported for '%s' " \
1264 "- must reset board to recover!\n", \
1265 __FILE__, __LINE__, (msg))
1267 #define fit_unsupported(msg)
1268 #define fit_unsupported_reset(msg)
1269 #endif /* CONFIG_FIT_VERBOSE */
1270 #endif /* CONFIG_FIT */
1272 #if defined(CONFIG_ANDROID_BOOT_IMAGE)
1273 struct andr_img_hdr;
1274 int android_image_check_header(const struct andr_img_hdr *hdr);
1275 int android_image_get_kernel(const struct andr_img_hdr *hdr, int verify,
1276 ulong *os_data, ulong *os_len);
1277 int android_image_get_ramdisk(const struct andr_img_hdr *hdr,
1278 ulong *rd_data, ulong *rd_len);
1279 int android_image_get_second(const struct andr_img_hdr *hdr,
1280 ulong *second_data, ulong *second_len);
1281 ulong android_image_get_end(const struct andr_img_hdr *hdr);
1282 ulong android_image_get_kload(const struct andr_img_hdr *hdr);
1283 void android_print_contents(const struct andr_img_hdr *hdr);
1285 #endif /* CONFIG_ANDROID_BOOT_IMAGE */
1288 * board_fit_config_name_match() - Check for a matching board name
1290 * This is used when SPL loads a FIT containing multiple device tree files
1291 * and wants to work out which one to use. The description of each one is
1292 * passed to this function. The description comes from the 'description' field
1293 * in each (FDT) image node.
1295 * @name: Device tree description
1296 * @return 0 if this device tree should be used, non-zero to try the next
1298 int board_fit_config_name_match(const char *name);
1300 #if defined(CONFIG_SPL_FIT_IMAGE_POST_PROCESS) || \
1301 defined(CONFIG_FIT_IMAGE_POST_PROCESS)
1303 * board_fit_image_post_process() - Do any post-process on FIT binary data
1305 * This is used to do any sort of image manipulation, verification, decryption
1306 * etc. in a platform or board specific way. Obviously, anything done here would
1307 * need to be comprehended in how the images were prepared before being injected
1308 * into the FIT creation (i.e. the binary blobs would have been pre-processed
1309 * before being added to the FIT image).
1311 * @image: pointer to the image start pointer
1312 * @size: pointer to the image size
1313 * @return no return value (failure should be handled internally)
1315 void board_fit_image_post_process(void **p_image, size_t *p_size);
1316 #endif /* CONFIG_SPL_FIT_IMAGE_POST_PROCESS */
1318 #define FDT_ERROR ((ulong)(-1))
1320 ulong fdt_getprop_u32(const void *fdt, int node, const char *prop);
1323 * fit_find_config_node() - Find the node for the best DTB in a FIT image
1325 * A FIT image contains one or more DTBs. This function parses the
1326 * configurations described in the FIT images and returns the node of
1327 * the first matching DTB. To check if a DTB matches a board, this function
1328 * calls board_fit_config_name_match(). If no matching DTB is found, it returns
1329 * the node described by the default configuration if it exists.
1331 * @fdt: pointer to flat device tree
1332 * @return the node if found, -ve otherwise
1334 int fit_find_config_node(const void *fdt);
1337 * Mapping of image types to function handlers to be invoked on the associated
1340 * @type: Type of image, I.E. IH_TYPE_*
1341 * @handler: Function to call on loaded image
1343 struct fit_loadable_tbl {
1346 * handler() - Process a loaded image
1348 * @data: Pointer to start of loaded image data
1349 * @size: Size of loaded image data
1351 void (*handler)(ulong data, size_t size);
1355 * Define a FIT loadable image type handler
1357 * _type is a valid uimage_type ID as defined in the "Image Type" enum above
1358 * _handler is the handler function to call after this image type is loaded
1360 #define U_BOOT_FIT_LOADABLE_HANDLER(_type, _handler) \
1361 ll_entry_declare(struct fit_loadable_tbl, _function, fit_loadable) = { \
1363 .handler = _handler, \
1366 #endif /* __IMAGE_H__ */