1 /* SPDX-License-Identifier: GPL-2.0+ */
3 * (C) Copyright 2008 Semihalf
5 * (C) Copyright 2000-2005
6 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
7 ********************************************************************
8 * NOTE: This header file defines an interface to U-Boot. Including
9 * this (unmodified) header file in another file is considered normal
10 * use of U-Boot, and does *not* fall under the heading of "derived
12 ********************************************************************
19 #include <asm/byteorder.h>
22 /* Define this to avoid #ifdefs later on */
27 #include <sys/types.h>
28 #include <linux/kconfig.h>
30 #define IMAGE_ENABLE_IGNORE 0
31 #define IMAGE_INDENT_STRING ""
36 #include <asm/u-boot.h>
38 #include <linker_lists.h>
40 /* Take notice of the 'ignore' property for hashes */
41 #define IMAGE_ENABLE_IGNORE 1
42 #define IMAGE_INDENT_STRING " "
44 #endif /* USE_HOSTCC */
46 #if CONFIG_IS_ENABLED(FIT)
48 #include <linux/libfdt.h>
49 #include <fdt_support.h>
52 extern ulong image_load_addr; /* Default Load Address */
53 extern ulong image_save_addr; /* Default Save Address */
54 extern ulong image_save_size; /* Default Save Size */
56 /* An invalid size, meaning that the image size is not known */
57 #define IMAGE_SIZE_INVAL (-1UL)
69 * Operating System Codes
71 * The following are exposed to uImage header.
72 * New IDs *MUST* be appended at the end of the list and *NEVER*
73 * inserted for backward compatibility.
76 IH_OS_INVALID = 0, /* Invalid OS */
77 IH_OS_OPENBSD, /* OpenBSD */
78 IH_OS_NETBSD, /* NetBSD */
79 IH_OS_FREEBSD, /* FreeBSD */
80 IH_OS_4_4BSD, /* 4.4BSD */
81 IH_OS_LINUX, /* Linux */
82 IH_OS_SVR4, /* SVR4 */
83 IH_OS_ESIX, /* Esix */
84 IH_OS_SOLARIS, /* Solaris */
85 IH_OS_IRIX, /* Irix */
87 IH_OS_DELL, /* Dell */
89 IH_OS_LYNXOS, /* LynxOS */
90 IH_OS_VXWORKS, /* VxWorks */
91 IH_OS_PSOS, /* pSOS */
93 IH_OS_U_BOOT, /* Firmware */
94 IH_OS_RTEMS, /* RTEMS */
95 IH_OS_ARTOS, /* ARTOS */
96 IH_OS_UNITY, /* Unity OS */
97 IH_OS_INTEGRITY, /* INTEGRITY */
99 IH_OS_PLAN9, /* Plan 9 */
100 IH_OS_OPENRTOS, /* OpenRTOS */
101 IH_OS_ARM_TRUSTED_FIRMWARE, /* ARM Trusted Firmware */
102 IH_OS_TEE, /* Trusted Execution Environment */
103 IH_OS_OPENSBI, /* RISC-V OpenSBI */
104 IH_OS_EFI, /* EFI Firmware (e.g. GRUB2) */
110 * CPU Architecture Codes (supported by Linux)
112 * The following are exposed to uImage header.
113 * New IDs *MUST* be appended at the end of the list and *NEVER*
114 * inserted for backward compatibility.
117 IH_ARCH_INVALID = 0, /* Invalid CPU */
118 IH_ARCH_ALPHA, /* Alpha */
119 IH_ARCH_ARM, /* ARM */
120 IH_ARCH_I386, /* Intel x86 */
121 IH_ARCH_IA64, /* IA64 */
122 IH_ARCH_MIPS, /* MIPS */
123 IH_ARCH_MIPS64, /* MIPS 64 Bit */
124 IH_ARCH_PPC, /* PowerPC */
125 IH_ARCH_S390, /* IBM S390 */
126 IH_ARCH_SH, /* SuperH */
127 IH_ARCH_SPARC, /* Sparc */
128 IH_ARCH_SPARC64, /* Sparc 64 Bit */
129 IH_ARCH_M68K, /* M68K */
130 IH_ARCH_NIOS, /* Nios-32 */
131 IH_ARCH_MICROBLAZE, /* MicroBlaze */
132 IH_ARCH_NIOS2, /* Nios-II */
133 IH_ARCH_BLACKFIN, /* Blackfin */
134 IH_ARCH_AVR32, /* AVR32 */
135 IH_ARCH_ST200, /* STMicroelectronics ST200 */
136 IH_ARCH_SANDBOX, /* Sandbox architecture (test only) */
137 IH_ARCH_NDS32, /* ANDES Technology - NDS32 */
138 IH_ARCH_OPENRISC, /* OpenRISC 1000 */
139 IH_ARCH_ARM64, /* ARM64 */
140 IH_ARCH_ARC, /* Synopsys DesignWare ARC */
141 IH_ARCH_X86_64, /* AMD x86_64, Intel and Via */
142 IH_ARCH_XTENSA, /* Xtensa */
143 IH_ARCH_RISCV, /* RISC-V */
151 * "Standalone Programs" are directly runnable in the environment
152 * provided by U-Boot; it is expected that (if they behave
153 * well) you can continue to work in U-Boot after return from
154 * the Standalone Program.
155 * "OS Kernel Images" are usually images of some Embedded OS which
156 * will take over control completely. Usually these programs
157 * will install their own set of exception handlers, device
158 * drivers, set up the MMU, etc. - this means, that you cannot
159 * expect to re-enter U-Boot except by resetting the CPU.
160 * "RAMDisk Images" are more or less just data blocks, and their
161 * parameters (address, size) are passed to an OS kernel that is
163 * "Multi-File Images" contain several images, typically an OS
164 * (Linux) kernel image and one or more data images like
165 * RAMDisks. This construct is useful for instance when you want
166 * to boot over the network using BOOTP etc., where the boot
167 * server provides just a single image file, but you want to get
168 * for instance an OS kernel and a RAMDisk image.
170 * "Multi-File Images" start with a list of image sizes, each
171 * image size (in bytes) specified by an "uint32_t" in network
172 * byte order. This list is terminated by an "(uint32_t)0".
173 * Immediately after the terminating 0 follow the images, one by
174 * one, all aligned on "uint32_t" boundaries (size rounded up to
175 * a multiple of 4 bytes - except for the last file).
177 * "Firmware Images" are binary images containing firmware (like
178 * U-Boot or FPGA images) which usually will be programmed to
181 * "Script files" are command sequences that will be executed by
182 * U-Boot's command interpreter; this feature is especially
183 * useful when you configure U-Boot to use a real shell (hush)
184 * as command interpreter (=> Shell Scripts).
186 * The following are exposed to uImage header.
187 * New IDs *MUST* be appended at the end of the list and *NEVER*
188 * inserted for backward compatibility.
192 IH_TYPE_INVALID = 0, /* Invalid Image */
193 IH_TYPE_STANDALONE, /* Standalone Program */
194 IH_TYPE_KERNEL, /* OS Kernel Image */
195 IH_TYPE_RAMDISK, /* RAMDisk Image */
196 IH_TYPE_MULTI, /* Multi-File Image */
197 IH_TYPE_FIRMWARE, /* Firmware Image */
198 IH_TYPE_SCRIPT, /* Script file */
199 IH_TYPE_FILESYSTEM, /* Filesystem Image (any type) */
200 IH_TYPE_FLATDT, /* Binary Flat Device Tree Blob */
201 IH_TYPE_KWBIMAGE, /* Kirkwood Boot Image */
202 IH_TYPE_IMXIMAGE, /* Freescale IMXBoot Image */
203 IH_TYPE_UBLIMAGE, /* Davinci UBL Image */
204 IH_TYPE_OMAPIMAGE, /* TI OMAP Config Header Image */
205 IH_TYPE_AISIMAGE, /* TI Davinci AIS Image */
206 /* OS Kernel Image, can run from any load address */
207 IH_TYPE_KERNEL_NOLOAD,
208 IH_TYPE_PBLIMAGE, /* Freescale PBL Boot Image */
209 IH_TYPE_MXSIMAGE, /* Freescale MXSBoot Image */
210 IH_TYPE_GPIMAGE, /* TI Keystone GPHeader Image */
211 IH_TYPE_ATMELIMAGE, /* ATMEL ROM bootable Image */
212 IH_TYPE_SOCFPGAIMAGE, /* Altera SOCFPGA CV/AV Preloader */
213 IH_TYPE_X86_SETUP, /* x86 setup.bin Image */
214 IH_TYPE_LPC32XXIMAGE, /* x86 setup.bin Image */
215 IH_TYPE_LOADABLE, /* A list of typeless images */
216 IH_TYPE_RKIMAGE, /* Rockchip Boot Image */
217 IH_TYPE_RKSD, /* Rockchip SD card */
218 IH_TYPE_RKSPI, /* Rockchip SPI image */
219 IH_TYPE_ZYNQIMAGE, /* Xilinx Zynq Boot Image */
220 IH_TYPE_ZYNQMPIMAGE, /* Xilinx ZynqMP Boot Image */
221 IH_TYPE_ZYNQMPBIF, /* Xilinx ZynqMP Boot Image (bif) */
222 IH_TYPE_FPGA, /* FPGA Image */
223 IH_TYPE_VYBRIDIMAGE, /* VYBRID .vyb Image */
224 IH_TYPE_TEE, /* Trusted Execution Environment OS Image */
225 IH_TYPE_FIRMWARE_IVT, /* Firmware Image with HABv4 IVT */
226 IH_TYPE_PMMC, /* TI Power Management Micro-Controller Firmware */
227 IH_TYPE_STM32IMAGE, /* STMicroelectronics STM32 Image */
228 IH_TYPE_SOCFPGAIMAGE_V1, /* Altera SOCFPGA A10 Preloader */
229 IH_TYPE_MTKIMAGE, /* MediaTek BootROM loadable Image */
230 IH_TYPE_IMX8MIMAGE, /* Freescale IMX8MBoot Image */
231 IH_TYPE_IMX8IMAGE, /* Freescale IMX8Boot Image */
232 IH_TYPE_COPRO, /* Coprocessor Image for remoteproc*/
233 IH_TYPE_SUNXI_EGON, /* Allwinner eGON Boot Image */
235 IH_TYPE_COUNT, /* Number of image types */
241 * The following are exposed to uImage header.
242 * New IDs *MUST* be appended at the end of the list and *NEVER*
243 * inserted for backward compatibility.
246 IH_COMP_NONE = 0, /* No Compression Used */
247 IH_COMP_GZIP, /* gzip Compression Used */
248 IH_COMP_BZIP2, /* bzip2 Compression Used */
249 IH_COMP_LZMA, /* lzma Compression Used */
250 IH_COMP_LZO, /* lzo Compression Used */
251 IH_COMP_LZ4, /* lz4 Compression Used */
252 IH_COMP_ZSTD, /* zstd Compression Used */
257 #define LZ4F_MAGIC 0x184D2204 /* LZ4 Magic Number */
258 #define IH_MAGIC 0x27051956 /* Image Magic Number */
259 #define IH_NMLEN 32 /* Image Name Length */
261 /* Reused from common.h */
262 #define ROUND(a, b) (((a) + (b) - 1) & ~((b) - 1))
265 * Legacy format image header,
266 * all data in network byte order (aka natural aka bigendian).
268 typedef struct image_header {
269 uint32_t ih_magic; /* Image Header Magic Number */
270 uint32_t ih_hcrc; /* Image Header CRC Checksum */
271 uint32_t ih_time; /* Image Creation Timestamp */
272 uint32_t ih_size; /* Image Data Size */
273 uint32_t ih_load; /* Data Load Address */
274 uint32_t ih_ep; /* Entry Point Address */
275 uint32_t ih_dcrc; /* Image Data CRC Checksum */
276 uint8_t ih_os; /* Operating System */
277 uint8_t ih_arch; /* CPU architecture */
278 uint8_t ih_type; /* Image Type */
279 uint8_t ih_comp; /* Compression Type */
280 uint8_t ih_name[IH_NMLEN]; /* Image Name */
283 typedef struct image_info {
284 ulong start, end; /* start/end of blob */
285 ulong image_start, image_len; /* start of image within blob, len of image */
286 ulong load; /* load addr for the image */
287 uint8_t comp, type, os; /* compression, type of image, os type */
288 uint8_t arch; /* CPU architecture */
292 * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
295 typedef struct bootm_headers {
297 * Legacy os image header, if it is a multi component image
298 * then boot_get_ramdisk() and get_fdt() will attempt to get
299 * data from second and third component accordingly.
301 image_header_t *legacy_hdr_os; /* image header pointer */
302 image_header_t legacy_hdr_os_copy; /* header copy */
303 ulong legacy_hdr_valid;
305 #if CONFIG_IS_ENABLED(FIT)
306 const char *fit_uname_cfg; /* configuration node unit name */
308 void *fit_hdr_os; /* os FIT image header */
309 const char *fit_uname_os; /* os subimage node unit name */
310 int fit_noffset_os; /* os subimage node offset */
312 void *fit_hdr_rd; /* init ramdisk FIT image header */
313 const char *fit_uname_rd; /* init ramdisk subimage node unit name */
314 int fit_noffset_rd; /* init ramdisk subimage node offset */
316 void *fit_hdr_fdt; /* FDT blob FIT image header */
317 const char *fit_uname_fdt; /* FDT blob subimage node unit name */
318 int fit_noffset_fdt;/* FDT blob subimage node offset */
320 void *fit_hdr_setup; /* x86 setup FIT image header */
321 const char *fit_uname_setup; /* x86 setup subimage node name */
322 int fit_noffset_setup;/* x86 setup subimage node offset */
326 image_info_t os; /* os image info */
327 ulong ep; /* entry point of OS */
329 ulong rd_start, rd_end;/* ramdisk start/end */
331 char *ft_addr; /* flat dev tree address */
332 ulong ft_len; /* length of flat device tree */
341 int verify; /* env_get("verify")[0] != 'n' */
343 #define BOOTM_STATE_START (0x00000001)
344 #define BOOTM_STATE_FINDOS (0x00000002)
345 #define BOOTM_STATE_FINDOTHER (0x00000004)
346 #define BOOTM_STATE_LOADOS (0x00000008)
347 #define BOOTM_STATE_RAMDISK (0x00000010)
348 #define BOOTM_STATE_FDT (0x00000020)
349 #define BOOTM_STATE_OS_CMDLINE (0x00000040)
350 #define BOOTM_STATE_OS_BD_T (0x00000080)
351 #define BOOTM_STATE_OS_PREP (0x00000100)
352 #define BOOTM_STATE_OS_FAKE_GO (0x00000200) /* 'Almost' run the OS */
353 #define BOOTM_STATE_OS_GO (0x00000400)
356 #if defined(CONFIG_LMB) && !defined(USE_HOSTCC)
357 struct lmb lmb; /* for memory mgmt */
361 extern bootm_headers_t images;
364 * Some systems (for example LWMON) have very short watchdog periods;
365 * we must make sure to split long operations like memmove() or
366 * checksum calculations into reasonable chunks.
369 #define CHUNKSZ (64 * 1024)
372 #ifndef CHUNKSZ_CRC32
373 #define CHUNKSZ_CRC32 (64 * 1024)
377 #define CHUNKSZ_MD5 (64 * 1024)
381 #define CHUNKSZ_SHA1 (64 * 1024)
384 #define uimage_to_cpu(x) be32_to_cpu(x)
385 #define cpu_to_uimage(x) cpu_to_be32(x)
388 * Translation table for entries of a specific type; used by
389 * get_table_entry_id() and get_table_entry_name().
391 typedef struct table_entry {
393 char *sname; /* short (input) name to find table entry */
394 char *lname; /* long (output) name to print for messages */
398 * Compression type and magic number mapping table.
400 struct comp_magic_map {
403 unsigned char magic[2];
407 * get_table_entry_id() scans the translation table trying to find an
408 * entry that matches the given short name. If a matching entry is
409 * found, it's id is returned to the caller.
411 int get_table_entry_id(const table_entry_t *table,
412 const char *table_name, const char *name);
414 * get_table_entry_name() scans the translation table trying to find
415 * an entry that matches the given id. If a matching entry is found,
416 * its long name is returned to the caller.
418 char *get_table_entry_name(const table_entry_t *table, char *msg, int id);
420 const char *genimg_get_os_name(uint8_t os);
423 * genimg_get_os_short_name() - get the short name for an OS
425 * @param os OS (IH_OS_...)
426 * @return OS short name, or "unknown" if unknown
428 const char *genimg_get_os_short_name(uint8_t comp);
430 const char *genimg_get_arch_name(uint8_t arch);
433 * genimg_get_arch_short_name() - get the short name for an architecture
435 * @param arch Architecture type (IH_ARCH_...)
436 * @return architecture short name, or "unknown" if unknown
438 const char *genimg_get_arch_short_name(uint8_t arch);
440 const char *genimg_get_type_name(uint8_t type);
443 * genimg_get_type_short_name() - get the short name for an image type
445 * @param type Image type (IH_TYPE_...)
446 * @return image short name, or "unknown" if unknown
448 const char *genimg_get_type_short_name(uint8_t type);
450 const char *genimg_get_comp_name(uint8_t comp);
453 * genimg_get_comp_short_name() - get the short name for a compression method
455 * @param comp compression method (IH_COMP_...)
456 * @return compression method short name, or "unknown" if unknown
458 const char *genimg_get_comp_short_name(uint8_t comp);
461 * genimg_get_cat_name() - Get the name of an item in a category
463 * @category: Category of item
465 * @return name of item, or "Unknown ..." if unknown
467 const char *genimg_get_cat_name(enum ih_category category, uint id);
470 * genimg_get_cat_short_name() - Get the short name of an item in a category
472 * @category: Category of item
474 * @return short name of item, or "Unknown ..." if unknown
476 const char *genimg_get_cat_short_name(enum ih_category category, uint id);
479 * genimg_get_cat_count() - Get the number of items in a category
481 * @category: Category to check
482 * @return the number of items in the category (IH_xxx_COUNT)
484 int genimg_get_cat_count(enum ih_category category);
487 * genimg_get_cat_desc() - Get the description of a category
489 * @category: Category to check
490 * @return the description of a category, e.g. "architecture". This
491 * effectively converts the enum to a string.
493 const char *genimg_get_cat_desc(enum ih_category category);
496 * genimg_cat_has_id() - Check whether a category has an item
498 * @category: Category to check
500 * @return true or false as to whether a category has an item
502 bool genimg_cat_has_id(enum ih_category category, uint id);
504 int genimg_get_os_id(const char *name);
505 int genimg_get_arch_id(const char *name);
506 int genimg_get_type_id(const char *name);
507 int genimg_get_comp_id(const char *name);
508 void genimg_print_size(uint32_t size);
510 #if defined(CONFIG_TIMESTAMP) || defined(CONFIG_CMD_DATE) || \
512 #define IMAGE_ENABLE_TIMESTAMP 1
514 #define IMAGE_ENABLE_TIMESTAMP 0
516 void genimg_print_time(time_t timestamp);
518 /* What to do with a image load address ('load = <> 'in the FIT) */
520 FIT_LOAD_IGNORED, /* Ignore load address */
521 FIT_LOAD_OPTIONAL, /* Can be provided, but optional */
522 FIT_LOAD_OPTIONAL_NON_ZERO, /* Optional, a value of 0 is ignored */
523 FIT_LOAD_REQUIRED, /* Must be provided */
526 int boot_get_setup(bootm_headers_t *images, uint8_t arch, ulong *setup_start,
530 /* Image format types, returned by _get_format() routine */
531 #define IMAGE_FORMAT_INVALID 0x00
532 #if defined(CONFIG_LEGACY_IMAGE_FORMAT)
533 #define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */
535 #define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */
536 #define IMAGE_FORMAT_ANDROID 0x03 /* Android boot image */
538 ulong genimg_get_kernel_addr_fit(char * const img_addr,
539 const char **fit_uname_config,
540 const char **fit_uname_kernel);
541 ulong genimg_get_kernel_addr(char * const img_addr);
542 int genimg_get_format(const void *img_addr);
543 int genimg_has_config(bootm_headers_t *images);
545 int boot_get_fpga(int argc, char *const argv[], bootm_headers_t *images,
546 uint8_t arch, const ulong *ld_start, ulong * const ld_len);
547 int boot_get_ramdisk(int argc, char *const argv[], bootm_headers_t *images,
548 uint8_t arch, ulong *rd_start, ulong *rd_end);
551 * boot_get_loadable - routine to load a list of binaries to memory
552 * @argc: Ignored Argument
553 * @argv: Ignored Argument
554 * @images: pointer to the bootm images structure
555 * @arch: expected architecture for the image
556 * @ld_start: Ignored Argument
557 * @ld_len: Ignored Argument
559 * boot_get_loadable() will take the given FIT configuration, and look
560 * for a field named "loadables". Loadables, is a list of elements in
561 * the FIT given as strings. exe:
562 * loadables = "linux_kernel", "fdt-2";
563 * this function will attempt to parse each string, and load the
564 * corresponding element from the FIT into memory. Once placed,
565 * no aditional actions are taken.
568 * 0, if only valid images or no images are found
569 * error code, if an error occurs during fit_image_load
571 int boot_get_loadable(int argc, char *const argv[], bootm_headers_t *images,
572 uint8_t arch, const ulong *ld_start, ulong *const ld_len);
573 #endif /* !USE_HOSTCC */
575 int boot_get_setup_fit(bootm_headers_t *images, uint8_t arch,
576 ulong *setup_start, ulong *setup_len);
579 * boot_get_fdt_fit() - load a DTB from a FIT file (applying overlays)
581 * This deals with all aspects of loading an DTB from a FIT.
582 * The correct base image based on configuration will be selected, and
583 * then any overlays specified will be applied (as present in fit_uname_configp).
585 * @param images Boot images structure
586 * @param addr Address of FIT in memory
587 * @param fit_unamep On entry this is the requested image name
588 * (e.g. "kernel") or NULL to use the default. On exit
589 * points to the selected image name
590 * @param fit_uname_configp On entry this is the requested configuration
591 * name (e.g. "conf-1") or NULL to use the default. On
592 * exit points to the selected configuration name.
593 * @param arch Expected architecture (IH_ARCH_...)
594 * @param datap Returns address of loaded image
595 * @param lenp Returns length of loaded image
597 * @return node offset of base image, or -ve error code on error
599 int boot_get_fdt_fit(bootm_headers_t *images, ulong addr,
600 const char **fit_unamep, const char **fit_uname_configp,
601 int arch, ulong *datap, ulong *lenp);
604 * fit_image_load() - load an image from a FIT
606 * This deals with all aspects of loading an image from a FIT, including
607 * selecting the right image based on configuration, verifying it, printing
608 * out progress messages, checking the type/arch/os and optionally copying it
609 * to the right load address.
611 * The property to look up is defined by image_type.
613 * @param images Boot images structure
614 * @param addr Address of FIT in memory
615 * @param fit_unamep On entry this is the requested image name
616 * (e.g. "kernel") or NULL to use the default. On exit
617 * points to the selected image name
618 * @param fit_uname_configp On entry this is the requested configuration
619 * name (e.g. "conf-1") or NULL to use the default. On
620 * exit points to the selected configuration name.
621 * @param arch Expected architecture (IH_ARCH_...)
622 * @param image_type Required image type (IH_TYPE_...). If this is
623 * IH_TYPE_KERNEL then we allow IH_TYPE_KERNEL_NOLOAD
625 * @param bootstage_id ID of starting bootstage to use for progress updates.
626 * This will be added to the BOOTSTAGE_SUB values when
627 * calling bootstage_mark()
628 * @param load_op Decribes what to do with the load address
629 * @param datap Returns address of loaded image
630 * @param lenp Returns length of loaded image
631 * @return node offset of image, or -ve error code on error
633 int fit_image_load(bootm_headers_t *images, ulong addr,
634 const char **fit_unamep, const char **fit_uname_configp,
635 int arch, int image_type, int bootstage_id,
636 enum fit_load_op load_op, ulong *datap, ulong *lenp);
639 * image_source_script() - Execute a script
641 * Executes a U-Boot script at a particular address in memory. The script should
642 * have a header (FIT or legacy) with the script type (IH_TYPE_SCRIPT).
644 * @addr: Address of script
645 * @fit_uname: FIT subimage name
646 * @return result code (enum command_ret_t)
648 int image_source_script(ulong addr, const char *fit_uname);
652 * fit_get_node_from_config() - Look up an image a FIT by type
654 * This looks in the selected conf- node (images->fit_uname_cfg) for a
655 * particular image type (e.g. "kernel") and then finds the image that is
658 * For example, for something like:
671 * the function will return the node offset of the kernel@1 node, assuming
672 * that conf-1 is the chosen configuration.
674 * @param images Boot images structure
675 * @param prop_name Property name to look up (FIT_..._PROP)
676 * @param addr Address of FIT in memory
678 int fit_get_node_from_config(bootm_headers_t *images, const char *prop_name,
681 int boot_get_fdt(int flag, int argc, char *const argv[], uint8_t arch,
682 bootm_headers_t *images,
683 char **of_flat_tree, ulong *of_size);
684 void boot_fdt_add_mem_rsv_regions(struct lmb *lmb, void *fdt_blob);
685 int boot_relocate_fdt(struct lmb *lmb, char **of_flat_tree, ulong *of_size);
687 int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len,
688 ulong *initrd_start, ulong *initrd_end);
689 int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end);
690 #ifdef CONFIG_SYS_BOOT_GET_KBD
691 int boot_get_kbd(struct lmb *lmb, struct bd_info **kbd);
692 #endif /* CONFIG_SYS_BOOT_GET_KBD */
693 #endif /* !USE_HOSTCC */
695 /*******************************************************************/
696 /* Legacy format specific code (prefixed with image_) */
697 /*******************************************************************/
698 static inline uint32_t image_get_header_size(void)
700 return (sizeof(image_header_t));
703 #define image_get_hdr_l(f) \
704 static inline uint32_t image_get_##f(const image_header_t *hdr) \
706 return uimage_to_cpu(hdr->ih_##f); \
708 image_get_hdr_l(magic) /* image_get_magic */
709 image_get_hdr_l(hcrc) /* image_get_hcrc */
710 image_get_hdr_l(time) /* image_get_time */
711 image_get_hdr_l(size) /* image_get_size */
712 image_get_hdr_l(load) /* image_get_load */
713 image_get_hdr_l(ep) /* image_get_ep */
714 image_get_hdr_l(dcrc) /* image_get_dcrc */
716 #define image_get_hdr_b(f) \
717 static inline uint8_t image_get_##f(const image_header_t *hdr) \
719 return hdr->ih_##f; \
721 image_get_hdr_b(os) /* image_get_os */
722 image_get_hdr_b(arch) /* image_get_arch */
723 image_get_hdr_b(type) /* image_get_type */
724 image_get_hdr_b(comp) /* image_get_comp */
726 static inline char *image_get_name(const image_header_t *hdr)
728 return (char *)hdr->ih_name;
731 static inline uint32_t image_get_data_size(const image_header_t *hdr)
733 return image_get_size(hdr);
737 * image_get_data - get image payload start address
740 * image_get_data() returns address of the image payload. For single
741 * component images it is image data start. For multi component
742 * images it points to the null terminated table of sub-images sizes.
745 * image payload data start address
747 static inline ulong image_get_data(const image_header_t *hdr)
749 return ((ulong)hdr + image_get_header_size());
752 static inline uint32_t image_get_image_size(const image_header_t *hdr)
754 return (image_get_size(hdr) + image_get_header_size());
756 static inline ulong image_get_image_end(const image_header_t *hdr)
758 return ((ulong)hdr + image_get_image_size(hdr));
761 #define image_set_hdr_l(f) \
762 static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
764 hdr->ih_##f = cpu_to_uimage(val); \
766 image_set_hdr_l(magic) /* image_set_magic */
767 image_set_hdr_l(hcrc) /* image_set_hcrc */
768 image_set_hdr_l(time) /* image_set_time */
769 image_set_hdr_l(size) /* image_set_size */
770 image_set_hdr_l(load) /* image_set_load */
771 image_set_hdr_l(ep) /* image_set_ep */
772 image_set_hdr_l(dcrc) /* image_set_dcrc */
774 #define image_set_hdr_b(f) \
775 static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
779 image_set_hdr_b(os) /* image_set_os */
780 image_set_hdr_b(arch) /* image_set_arch */
781 image_set_hdr_b(type) /* image_set_type */
782 image_set_hdr_b(comp) /* image_set_comp */
784 static inline void image_set_name(image_header_t *hdr, const char *name)
786 strncpy(image_get_name(hdr), name, IH_NMLEN);
789 int image_check_hcrc(const image_header_t *hdr);
790 int image_check_dcrc(const image_header_t *hdr);
792 ulong env_get_bootm_low(void);
793 phys_size_t env_get_bootm_size(void);
794 phys_size_t env_get_bootm_mapsize(void);
796 void memmove_wd(void *to, void *from, size_t len, ulong chunksz);
798 static inline int image_check_magic(const image_header_t *hdr)
800 return (image_get_magic(hdr) == IH_MAGIC);
802 static inline int image_check_type(const image_header_t *hdr, uint8_t type)
804 return (image_get_type(hdr) == type);
806 static inline int image_check_arch(const image_header_t *hdr, uint8_t arch)
809 /* Let's assume that sandbox can load any architecture */
810 if (IS_ENABLED(CONFIG_SANDBOX))
813 return (image_get_arch(hdr) == arch) ||
814 (image_get_arch(hdr) == IH_ARCH_ARM && arch == IH_ARCH_ARM64);
816 static inline int image_check_os(const image_header_t *hdr, uint8_t os)
818 return (image_get_os(hdr) == os);
821 ulong image_multi_count(const image_header_t *hdr);
822 void image_multi_getimg(const image_header_t *hdr, ulong idx,
823 ulong *data, ulong *len);
825 void image_print_contents(const void *hdr);
828 static inline int image_check_target_arch(const image_header_t *hdr)
830 #ifndef IH_ARCH_DEFAULT
831 # error "please define IH_ARCH_DEFAULT in your arch asm/u-boot.h"
833 return image_check_arch(hdr, IH_ARCH_DEFAULT);
835 #endif /* USE_HOSTCC */
838 * image_decomp_type() - Find out compression type of an image
840 * @buf: Address in U-Boot memory where image is loaded.
841 * @len: Length of the compressed image.
842 * @return compression type or IH_COMP_NONE if not compressed.
844 * Note: Only following compression types are supported now.
845 * lzo, lzma, gzip, bzip2
847 int image_decomp_type(const unsigned char *buf, ulong len);
850 * image_decomp() - decompress an image
852 * @comp: Compression algorithm that is used (IH_COMP_...)
853 * @load: Destination load address in U-Boot memory
854 * @image_start Image start address (where we are decompressing from)
855 * @type: OS type (IH_OS_...)
856 * @load_bug: Place to decompress to
857 * @image_buf: Address to decompress from
858 * @image_len: Number of bytes in @image_buf to decompress
859 * @unc_len: Available space for decompression
860 * @return 0 if OK, -ve on error (BOOTM_ERR_...)
862 int image_decomp(int comp, ulong load, ulong image_start, int type,
863 void *load_buf, void *image_buf, ulong image_len,
864 uint unc_len, ulong *load_end);
867 * Set up properties in the FDT
869 * This sets up properties in the FDT that is to be passed to linux.
871 * @images: Images information
872 * @blob: FDT to update
873 * @of_size: Size of the FDT
874 * @lmb: Points to logical memory block structure
875 * @return 0 if ok, <0 on failure
877 int image_setup_libfdt(bootm_headers_t *images, void *blob,
878 int of_size, struct lmb *lmb);
881 * Set up the FDT to use for booting a kernel
883 * This performs ramdisk setup, sets up the FDT if required, and adds
884 * paramters to the FDT if libfdt is available.
886 * @param images Images information
887 * @return 0 if ok, <0 on failure
889 int image_setup_linux(bootm_headers_t *images);
892 * bootz_setup() - Extract stat and size of a Linux xImage
894 * @image: Address of image
895 * @start: Returns start address of image
896 * @end : Returns end address of image
897 * @return 0 if OK, 1 if the image was not recognised
899 int bootz_setup(ulong image, ulong *start, ulong *end);
902 * Return the correct start address and size of a Linux aarch64 Image.
904 * @image: Address of image
905 * @start: Returns start address of image
906 * @size : Returns size image
907 * @force_reloc: Ignore image->ep field, always place image to RAM start
908 * @return 0 if OK, 1 if the image was not recognised
910 int booti_setup(ulong image, ulong *relocated_addr, ulong *size,
913 /*******************************************************************/
914 /* New uImage format specific code (prefixed with fit_) */
915 /*******************************************************************/
917 #define FIT_IMAGES_PATH "/images"
918 #define FIT_CONFS_PATH "/configurations"
920 /* hash/signature/key node */
921 #define FIT_HASH_NODENAME "hash"
922 #define FIT_ALGO_PROP "algo"
923 #define FIT_VALUE_PROP "value"
924 #define FIT_IGNORE_PROP "uboot-ignore"
925 #define FIT_SIG_NODENAME "signature"
926 #define FIT_KEY_REQUIRED "required"
927 #define FIT_KEY_HINT "key-name-hint"
930 #define FIT_CIPHER_NODENAME "cipher"
931 #define FIT_ALGO_PROP "algo"
934 #define FIT_DATA_PROP "data"
935 #define FIT_DATA_POSITION_PROP "data-position"
936 #define FIT_DATA_OFFSET_PROP "data-offset"
937 #define FIT_DATA_SIZE_PROP "data-size"
938 #define FIT_TIMESTAMP_PROP "timestamp"
939 #define FIT_DESC_PROP "description"
940 #define FIT_ARCH_PROP "arch"
941 #define FIT_TYPE_PROP "type"
942 #define FIT_OS_PROP "os"
943 #define FIT_COMP_PROP "compression"
944 #define FIT_ENTRY_PROP "entry"
945 #define FIT_LOAD_PROP "load"
947 /* configuration node */
948 #define FIT_KERNEL_PROP "kernel"
949 #define FIT_RAMDISK_PROP "ramdisk"
950 #define FIT_FDT_PROP "fdt"
951 #define FIT_LOADABLE_PROP "loadables"
952 #define FIT_DEFAULT_PROP "default"
953 #define FIT_SETUP_PROP "setup"
954 #define FIT_FPGA_PROP "fpga"
955 #define FIT_FIRMWARE_PROP "firmware"
956 #define FIT_STANDALONE_PROP "standalone"
958 #define FIT_MAX_HASH_LEN HASH_MAX_DIGEST_SIZE
960 #if CONFIG_IS_ENABLED(FIT)
961 /* cmdline argument format parsing */
962 int fit_parse_conf(const char *spec, ulong addr_curr,
963 ulong *addr, const char **conf_name);
964 int fit_parse_subimage(const char *spec, ulong addr_curr,
965 ulong *addr, const char **image_name);
967 int fit_get_subimage_count(const void *fit, int images_noffset);
968 void fit_print_contents(const void *fit);
969 void fit_image_print(const void *fit, int noffset, const char *p);
972 * fit_get_end - get FIT image size
973 * @fit: pointer to the FIT format image header
976 * size of the FIT image (blob) in memory
978 static inline ulong fit_get_size(const void *fit)
980 return fdt_totalsize(fit);
984 * fit_get_end - get FIT image end
985 * @fit: pointer to the FIT format image header
988 * end address of the FIT image (blob) in memory
990 ulong fit_get_end(const void *fit);
993 * fit_get_name - get FIT node name
994 * @fit: pointer to the FIT format image header
998 * pointer to node name, on success
1000 static inline const char *fit_get_name(const void *fit_hdr,
1001 int noffset, int *len)
1003 return fdt_get_name(fit_hdr, noffset, len);
1006 int fit_get_desc(const void *fit, int noffset, char **desc);
1007 int fit_get_timestamp(const void *fit, int noffset, time_t *timestamp);
1009 int fit_image_get_node(const void *fit, const char *image_uname);
1010 int fit_image_get_os(const void *fit, int noffset, uint8_t *os);
1011 int fit_image_get_arch(const void *fit, int noffset, uint8_t *arch);
1012 int fit_image_get_type(const void *fit, int noffset, uint8_t *type);
1013 int fit_image_get_comp(const void *fit, int noffset, uint8_t *comp);
1014 int fit_image_get_load(const void *fit, int noffset, ulong *load);
1015 int fit_image_get_entry(const void *fit, int noffset, ulong *entry);
1016 int fit_image_get_data(const void *fit, int noffset,
1017 const void **data, size_t *size);
1018 int fit_image_get_data_offset(const void *fit, int noffset, int *data_offset);
1019 int fit_image_get_data_position(const void *fit, int noffset,
1020 int *data_position);
1021 int fit_image_get_data_size(const void *fit, int noffset, int *data_size);
1022 int fit_image_get_data_size_unciphered(const void *fit, int noffset,
1024 int fit_image_get_data_and_size(const void *fit, int noffset,
1025 const void **data, size_t *size);
1027 int fit_image_hash_get_algo(const void *fit, int noffset, char **algo);
1028 int fit_image_hash_get_value(const void *fit, int noffset, uint8_t **value,
1031 int fit_set_timestamp(void *fit, int noffset, time_t timestamp);
1033 int fit_cipher_data(const char *keydir, void *keydest, void *fit,
1034 const char *comment, int require_keys,
1035 const char *engine_id, const char *cmdname);
1038 * fit_add_verification_data() - add verification data to FIT image nodes
1040 * @keydir: Directory containing keys
1041 * @kwydest: FDT blob to write public key information to
1042 * @fit: Pointer to the FIT format image header
1043 * @comment: Comment to add to signature nodes
1044 * @require_keys: Mark all keys as 'required'
1045 * @engine_id: Engine to use for signing
1046 * @cmdname: Command name used when reporting errors
1048 * Adds hash values for all component images in the FIT blob.
1049 * Hashes are calculated for all component images which have hash subnodes
1050 * with algorithm property set to one of the supported hash algorithms.
1052 * Also add signatures if signature nodes are present.
1056 * libfdt error code, on failure
1058 int fit_add_verification_data(const char *keydir, const char *keyfile,
1059 void *keydest, void *fit, const char *comment,
1060 int require_keys, const char *engine_id,
1061 const char *cmdname);
1063 int fit_image_verify_with_data(const void *fit, int image_noffset,
1064 const void *data, size_t size);
1065 int fit_image_verify(const void *fit, int noffset);
1066 int fit_config_verify(const void *fit, int conf_noffset);
1067 int fit_all_image_verify(const void *fit);
1068 int fit_config_decrypt(const void *fit, int conf_noffset);
1069 int fit_image_check_os(const void *fit, int noffset, uint8_t os);
1070 int fit_image_check_arch(const void *fit, int noffset, uint8_t arch);
1071 int fit_image_check_type(const void *fit, int noffset, uint8_t type);
1072 int fit_image_check_comp(const void *fit, int noffset, uint8_t comp);
1075 * fit_check_format() - Check that the FIT is valid
1077 * This performs various checks on the FIT to make sure it is suitable for
1078 * use, looking for mandatory properties, nodes, etc.
1080 * If FIT_FULL_CHECK is enabled, it also runs it through libfdt to make
1081 * sure that there are no strange tags or broken nodes in the FIT.
1083 * @fit: pointer to the FIT format image header
1084 * @return 0 if OK, -ENOEXEC if not an FDT file, -EINVAL if the full FDT check
1085 * failed (e.g. due to bad structure), -ENOMSG if the description is
1086 * missing, -EBADMSG if the timestamp is missing, -ENOENT if the /images
1089 int fit_check_format(const void *fit, ulong size);
1091 int fit_conf_find_compat(const void *fit, const void *fdt);
1094 * fit_conf_get_node - get node offset for configuration of a given unit name
1095 * @fit: pointer to the FIT format image header
1096 * @conf_uname: configuration node unit name (NULL to use default)
1098 * fit_conf_get_node() finds a configuration (within the '/configurations'
1099 * parent node) of a provided unit name. If configuration is found its node
1100 * offset is returned to the caller.
1102 * When NULL is provided in second argument fit_conf_get_node() will search
1103 * for a default configuration node instead. Default configuration node unit
1104 * name is retrieved from FIT_DEFAULT_PROP property of the '/configurations'
1108 * configuration node offset when found (>=0)
1109 * negative number on failure (FDT_ERR_* code)
1111 int fit_conf_get_node(const void *fit, const char *conf_uname);
1113 int fit_conf_get_prop_node_count(const void *fit, int noffset,
1114 const char *prop_name);
1115 int fit_conf_get_prop_node_index(const void *fit, int noffset,
1116 const char *prop_name, int index);
1119 * fit_conf_get_prop_node() - Get node refered to by a configuration
1120 * @fit: FIT to check
1121 * @noffset: Offset of conf@xxx node to check
1122 * @prop_name: Property to read from the conf node
1124 * The conf- nodes contain references to other nodes, using properties
1125 * like 'kernel = "kernel"'. Given such a property name (e.g. "kernel"),
1126 * return the offset of the node referred to (e.g. offset of node
1129 int fit_conf_get_prop_node(const void *fit, int noffset,
1130 const char *prop_name);
1132 int fit_check_ramdisk(const void *fit, int os_noffset,
1133 uint8_t arch, int verify);
1136 int calculate_hash(const void *data, int data_len, const char *algo,
1137 uint8_t *value, int *value_len);
1140 * At present we only support signing on the host, and verification on the
1143 #if defined(USE_HOSTCC)
1144 # if defined(CONFIG_FIT_SIGNATURE)
1145 # define IMAGE_ENABLE_SIGN 1
1146 # define FIT_IMAGE_ENABLE_VERIFY 1
1147 # include <openssl/evp.h>
1149 # define IMAGE_ENABLE_SIGN 0
1150 # define FIT_IMAGE_ENABLE_VERIFY 0
1153 # define IMAGE_ENABLE_SIGN 0
1154 # define FIT_IMAGE_ENABLE_VERIFY CONFIG_IS_ENABLED(FIT_SIGNATURE)
1157 #if CONFIG_IS_ENABLED(FIT)
1159 void *image_get_host_blob(void);
1160 void image_set_host_blob(void *host_blob);
1161 # define gd_fdt_blob() image_get_host_blob()
1163 # define gd_fdt_blob() (gd->fdt_blob)
1166 #endif /* IMAGE_ENABLE_FIT */
1169 * Information passed to the signing routines
1171 * Either 'keydir', 'keyname', or 'keyfile' can be NULL. However, either
1172 * 'keyfile', or both 'keydir' and 'keyname' should have valid values. If
1173 * neither are valid, some operations might fail with EINVAL.
1175 struct image_sign_info {
1176 const char *keydir; /* Directory conaining keys */
1177 const char *keyname; /* Name of key to use */
1178 const char *keyfile; /* Filename of private or public key */
1179 void *fit; /* Pointer to FIT blob */
1180 int node_offset; /* Offset of signature node */
1181 const char *name; /* Algorithm name */
1182 struct checksum_algo *checksum; /* Checksum algorithm information */
1183 struct padding_algo *padding; /* Padding algorithm information */
1184 struct crypto_algo *crypto; /* Crypto algorithm information */
1185 const void *fdt_blob; /* FDT containing public keys */
1186 int required_keynode; /* Node offset of key to use: -1=any */
1187 const char *require_keys; /* Value for 'required' property */
1188 const char *engine_id; /* Engine to use for signing */
1190 * Note: the following two fields are always valid even w/o
1191 * RSA_VERIFY_WITH_PKEY in order to make sure this structure is
1192 * the same on target and host. Otherwise, vboot test may fail.
1194 const void *key; /* Pointer to public key in DER */
1195 int keylen; /* Length of public key */
1198 /* A part of an image, used for hashing */
1199 struct image_region {
1204 #if FIT_IMAGE_ENABLE_VERIFY
1205 # include <u-boot/hash-checksum.h>
1207 struct checksum_algo {
1209 const int checksum_len;
1211 const uint8_t *der_prefix;
1212 #if IMAGE_ENABLE_SIGN
1213 const EVP_MD *(*calculate_sign)(void);
1215 int (*calculate)(const char *name,
1216 const struct image_region region[],
1217 int region_count, uint8_t *checksum);
1220 struct crypto_algo {
1221 const char *name; /* Name of algorithm */
1225 * sign() - calculate and return signature for given input data
1227 * @info: Specifies key and FIT information
1228 * @data: Pointer to the input data
1229 * @data_len: Data length
1230 * @sigp: Set to an allocated buffer holding the signature
1231 * @sig_len: Set to length of the calculated hash
1233 * This computes input data signature according to selected algorithm.
1234 * Resulting signature value is placed in an allocated buffer, the
1235 * pointer is returned as *sigp. The length of the calculated
1236 * signature is returned via the sig_len pointer argument. The caller
1237 * should free *sigp.
1239 * @return: 0, on success, -ve on error
1241 int (*sign)(struct image_sign_info *info,
1242 const struct image_region region[],
1243 int region_count, uint8_t **sigp, uint *sig_len);
1246 * add_verify_data() - Add verification information to FDT
1248 * Add public key information to the FDT node, suitable for
1249 * verification at run-time. The information added depends on the
1250 * algorithm being used.
1252 * @info: Specifies key and FIT information
1253 * @keydest: Destination FDT blob for public key data
1254 * @return: 0, on success, -ve on error
1256 int (*add_verify_data)(struct image_sign_info *info, void *keydest);
1259 * verify() - Verify a signature against some data
1261 * @info: Specifies key and FIT information
1262 * @data: Pointer to the input data
1263 * @data_len: Data length
1265 * @sig_len: Number of bytes in signature
1266 * @return 0 if verified, -ve on error
1268 int (*verify)(struct image_sign_info *info,
1269 const struct image_region region[], int region_count,
1270 uint8_t *sig, uint sig_len);
1273 /* Declare a new U-Boot crypto algorithm handler */
1274 #define U_BOOT_CRYPTO_ALGO(__name) \
1275 ll_entry_declare(struct crypto_algo, __name, cryptos)
1277 struct padding_algo {
1279 int (*verify)(struct image_sign_info *info,
1280 uint8_t *pad, int pad_len,
1281 const uint8_t *hash, int hash_len);
1284 /* Declare a new U-Boot padding algorithm handler */
1285 #define U_BOOT_PADDING_ALGO(__name) \
1286 ll_entry_declare(struct padding_algo, __name, paddings)
1289 * image_get_checksum_algo() - Look up a checksum algorithm
1291 * @param full_name Name of algorithm in the form "checksum,crypto"
1292 * @return pointer to algorithm information, or NULL if not found
1294 struct checksum_algo *image_get_checksum_algo(const char *full_name);
1297 * image_get_crypto_algo() - Look up a cryptosystem algorithm
1299 * @param full_name Name of algorithm in the form "checksum,crypto"
1300 * @return pointer to algorithm information, or NULL if not found
1302 struct crypto_algo *image_get_crypto_algo(const char *full_name);
1305 * image_get_padding_algo() - Look up a padding algorithm
1307 * @param name Name of padding algorithm
1308 * @return pointer to algorithm information, or NULL if not found
1310 struct padding_algo *image_get_padding_algo(const char *name);
1312 #if CONFIG_IS_ENABLED(FIT)
1315 * fit_image_verify_required_sigs() - Verify signatures marked as 'required'
1317 * @fit: FIT to check
1318 * @image_noffset: Offset of image node to check
1319 * @data: Image data to check
1320 * @size: Size of image data
1321 * @sig_blob: FDT containing public keys
1322 * @no_sigsp: Returns 1 if no signatures were required, and
1323 * therefore nothing was checked. The caller may wish
1324 * to fall back to other mechanisms, or refuse to
1326 * @return 0 if all verified ok, <0 on error
1328 int fit_image_verify_required_sigs(const void *fit, int image_noffset,
1329 const char *data, size_t size, const void *sig_blob,
1333 * fit_image_check_sig() - Check a single image signature node
1335 * @fit: FIT to check
1336 * @noffset: Offset of signature node to check
1337 * @data: Image data to check
1338 * @size: Size of image data
1339 * @required_keynode: Offset in the control FDT of the required key node,
1340 * if any. If this is given, then the image wil not
1341 * pass verification unless that key is used. If this is
1342 * -1 then any signature will do.
1343 * @err_msgp: In the event of an error, this will be pointed to a
1344 * help error string to display to the user.
1345 * @return 0 if all verified ok, <0 on error
1347 int fit_image_check_sig(const void *fit, int noffset, const void *data,
1348 size_t size, int required_keynode, char **err_msgp);
1350 int fit_image_decrypt_data(const void *fit,
1351 int image_noffset, int cipher_noffset,
1352 const void *data, size_t size,
1353 void **data_unciphered, size_t *size_unciphered);
1356 * fit_region_make_list() - Make a list of regions to hash
1358 * Given a list of FIT regions (offset, size) provided by libfdt, create
1359 * a list of regions (void *, size) for use by the signature creationg
1360 * and verification code.
1362 * @fit: FIT image to process
1363 * @fdt_regions: Regions as returned by libfdt
1364 * @count: Number of regions returned by libfdt
1365 * @region: Place to put list of regions (NULL to allocate it)
1366 * @return pointer to list of regions, or NULL if out of memory
1368 struct image_region *fit_region_make_list(const void *fit,
1369 struct fdt_region *fdt_regions, int count,
1370 struct image_region *region);
1372 static inline int fit_image_check_target_arch(const void *fdt, int node)
1375 return fit_image_check_arch(fdt, node, IH_ARCH_DEFAULT);
1382 * At present we only support ciphering on the host, and unciphering on the
1385 #if defined(USE_HOSTCC)
1386 # if defined(CONFIG_FIT_CIPHER)
1387 # define IMAGE_ENABLE_ENCRYPT 1
1388 # define IMAGE_ENABLE_DECRYPT 1
1389 # include <openssl/evp.h>
1391 # define IMAGE_ENABLE_ENCRYPT 0
1392 # define IMAGE_ENABLE_DECRYPT 0
1395 # define IMAGE_ENABLE_ENCRYPT 0
1396 # define IMAGE_ENABLE_DECRYPT CONFIG_IS_ENABLED(FIT_CIPHER)
1399 /* Information passed to the ciphering routines */
1400 struct image_cipher_info {
1401 const char *keydir; /* Directory containing keys */
1402 const char *keyname; /* Name of key to use */
1403 const char *ivname; /* Name of IV to use */
1404 const void *fit; /* Pointer to FIT blob */
1405 int node_noffset; /* Offset of the cipher node */
1406 const char *name; /* Algorithm name */
1407 struct cipher_algo *cipher; /* Cipher algorithm information */
1408 const void *fdt_blob; /* FDT containing key and IV */
1409 const void *key; /* Value of the key */
1410 const void *iv; /* Value of the IV */
1411 size_t size_unciphered; /* Size of the unciphered data */
1414 struct cipher_algo {
1415 const char *name; /* Name of algorithm */
1416 int key_len; /* Length of the key */
1417 int iv_len; /* Length of the IV */
1419 #if IMAGE_ENABLE_ENCRYPT
1420 const EVP_CIPHER * (*calculate_type)(void);
1423 int (*encrypt)(struct image_cipher_info *info,
1424 const unsigned char *data, int data_len,
1425 unsigned char **cipher, int *cipher_len);
1427 int (*add_cipher_data)(struct image_cipher_info *info,
1428 void *keydest, void *fit, int node_noffset);
1430 int (*decrypt)(struct image_cipher_info *info,
1431 const void *cipher, size_t cipher_len,
1432 void **data, size_t *data_len);
1435 int fit_image_cipher_get_algo(const void *fit, int noffset, char **algo);
1437 struct cipher_algo *image_get_cipher_algo(const char *full_name);
1439 #if CONFIG_IS_ENABLED(FIT_VERBOSE)
1440 #define fit_unsupported(msg) printf("! %s:%d " \
1441 "FIT images not supported for '%s'\n", \
1442 __FILE__, __LINE__, (msg))
1444 #define fit_unsupported_reset(msg) printf("! %s:%d " \
1445 "FIT images not supported for '%s' " \
1446 "- must reset board to recover!\n", \
1447 __FILE__, __LINE__, (msg))
1449 #define fit_unsupported(msg)
1450 #define fit_unsupported_reset(msg)
1451 #endif /* FIT_VERBOSE */
1452 #endif /* CONFIG_FIT */
1454 #if !defined(USE_HOSTCC)
1455 #if defined(CONFIG_ANDROID_BOOT_IMAGE)
1456 struct andr_img_hdr;
1457 int android_image_check_header(const struct andr_img_hdr *hdr);
1458 int android_image_get_kernel(const struct andr_img_hdr *hdr, int verify,
1459 ulong *os_data, ulong *os_len);
1460 int android_image_get_ramdisk(const struct andr_img_hdr *hdr,
1461 ulong *rd_data, ulong *rd_len);
1462 int android_image_get_second(const struct andr_img_hdr *hdr,
1463 ulong *second_data, ulong *second_len);
1464 bool android_image_get_dtbo(ulong hdr_addr, ulong *addr, u32 *size);
1465 bool android_image_get_dtb_by_index(ulong hdr_addr, u32 index, ulong *addr,
1467 ulong android_image_get_end(const struct andr_img_hdr *hdr);
1468 ulong android_image_get_kload(const struct andr_img_hdr *hdr);
1469 ulong android_image_get_kcomp(const struct andr_img_hdr *hdr);
1470 void android_print_contents(const struct andr_img_hdr *hdr);
1471 #if !defined(CONFIG_SPL_BUILD)
1472 bool android_image_print_dtb_contents(ulong hdr_addr);
1475 #endif /* CONFIG_ANDROID_BOOT_IMAGE */
1476 #endif /* !USE_HOSTCC */
1479 * board_fit_config_name_match() - Check for a matching board name
1481 * This is used when SPL loads a FIT containing multiple device tree files
1482 * and wants to work out which one to use. The description of each one is
1483 * passed to this function. The description comes from the 'description' field
1484 * in each (FDT) image node.
1486 * @name: Device tree description
1487 * @return 0 if this device tree should be used, non-zero to try the next
1489 int board_fit_config_name_match(const char *name);
1492 * board_fit_image_post_process() - Do any post-process on FIT binary data
1494 * This is used to do any sort of image manipulation, verification, decryption
1495 * etc. in a platform or board specific way. Obviously, anything done here would
1496 * need to be comprehended in how the images were prepared before being injected
1497 * into the FIT creation (i.e. the binary blobs would have been pre-processed
1498 * before being added to the FIT image).
1500 * @fit: pointer to fit image
1501 * @node: offset of image node
1502 * @image: pointer to the image start pointer
1503 * @size: pointer to the image size
1504 * @return no return value (failure should be handled internally)
1506 void board_fit_image_post_process(const void *fit, int node, void **p_image,
1509 #define FDT_ERROR ((ulong)(-1))
1511 ulong fdt_getprop_u32(const void *fdt, int node, const char *prop);
1514 * fit_find_config_node() - Find the node for the best DTB in a FIT image
1516 * A FIT image contains one or more DTBs. This function parses the
1517 * configurations described in the FIT images and returns the node of
1518 * the first matching DTB. To check if a DTB matches a board, this function
1519 * calls board_fit_config_name_match(). If no matching DTB is found, it returns
1520 * the node described by the default configuration if it exists.
1522 * @fdt: pointer to flat device tree
1523 * @return the node if found, -ve otherwise
1525 int fit_find_config_node(const void *fdt);
1528 * Mapping of image types to function handlers to be invoked on the associated
1531 * @type: Type of image, I.E. IH_TYPE_*
1532 * @handler: Function to call on loaded image
1534 struct fit_loadable_tbl {
1537 * handler() - Process a loaded image
1539 * @data: Pointer to start of loaded image data
1540 * @size: Size of loaded image data
1542 void (*handler)(ulong data, size_t size);
1546 * Define a FIT loadable image type handler
1548 * _type is a valid uimage_type ID as defined in the "Image Type" enum above
1549 * _handler is the handler function to call after this image type is loaded
1551 #define U_BOOT_FIT_LOADABLE_HANDLER(_type, _handler) \
1552 ll_entry_declare(struct fit_loadable_tbl, _function, fit_loadable) = { \
1554 .handler = _handler, \
1558 * fit_update - update storage with FIT image
1559 * @fit: Pointer to FIT image
1561 * Update firmware on storage using FIT image as input.
1562 * The storage area to be update will be identified by the name
1563 * in FIT and matching it to "dfu_alt_info" variable.
1565 * Return: 0 on success, non-zero otherwise
1567 int fit_update(const void *fit);
1569 #endif /* __IMAGE_H__ */