1 /* SPDX-License-Identifier: GPL-2.0+ */
3 * (C) Copyright 2008 Semihalf
5 * (C) Copyright 2000-2005
6 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
7 ********************************************************************
8 * NOTE: This header file defines an interface to U-Boot. Including
9 * this (unmodified) header file in another file is considered normal
10 * use of U-Boot, and does *not* fall under the heading of "derived
12 ********************************************************************
19 #include <asm/byteorder.h>
22 /* Define this to avoid #ifdefs later on */
27 #include <sys/types.h>
28 #include <linux/kconfig.h>
30 #define IMAGE_INDENT_STRING ""
35 #include <asm/u-boot.h>
37 #include <linker_lists.h>
39 #define IMAGE_INDENT_STRING " "
41 #endif /* USE_HOSTCC */
44 #include <linux/libfdt.h>
45 #include <fdt_support.h>
46 #include <u-boot/hash-checksum.h>
48 extern ulong image_load_addr; /* Default Load Address */
49 extern ulong image_save_addr; /* Default Save Address */
50 extern ulong image_save_size; /* Default Save Size */
51 extern ulong image_load_offset; /* Default Load Address Offset */
53 /* An invalid size, meaning that the image size is not known */
54 #define IMAGE_SIZE_INVAL (-1UL)
66 * Operating System Codes
68 * The following are exposed to uImage header.
69 * New IDs *MUST* be appended at the end of the list and *NEVER*
70 * inserted for backward compatibility.
73 IH_OS_INVALID = 0, /* Invalid OS */
74 IH_OS_OPENBSD, /* OpenBSD */
75 IH_OS_NETBSD, /* NetBSD */
76 IH_OS_FREEBSD, /* FreeBSD */
77 IH_OS_4_4BSD, /* 4.4BSD */
78 IH_OS_LINUX, /* Linux */
79 IH_OS_SVR4, /* SVR4 */
80 IH_OS_ESIX, /* Esix */
81 IH_OS_SOLARIS, /* Solaris */
82 IH_OS_IRIX, /* Irix */
84 IH_OS_DELL, /* Dell */
86 IH_OS_LYNXOS, /* LynxOS */
87 IH_OS_VXWORKS, /* VxWorks */
88 IH_OS_PSOS, /* pSOS */
90 IH_OS_U_BOOT, /* Firmware */
91 IH_OS_RTEMS, /* RTEMS */
92 IH_OS_ARTOS, /* ARTOS */
93 IH_OS_UNITY, /* Unity OS */
94 IH_OS_INTEGRITY, /* INTEGRITY */
96 IH_OS_PLAN9, /* Plan 9 */
97 IH_OS_OPENRTOS, /* OpenRTOS */
98 IH_OS_ARM_TRUSTED_FIRMWARE, /* ARM Trusted Firmware */
99 IH_OS_TEE, /* Trusted Execution Environment */
100 IH_OS_OPENSBI, /* RISC-V OpenSBI */
101 IH_OS_EFI, /* EFI Firmware (e.g. GRUB2) */
107 * CPU Architecture Codes (supported by Linux)
109 * The following are exposed to uImage header.
110 * New IDs *MUST* be appended at the end of the list and *NEVER*
111 * inserted for backward compatibility.
114 IH_ARCH_INVALID = 0, /* Invalid CPU */
115 IH_ARCH_ALPHA, /* Alpha */
116 IH_ARCH_ARM, /* ARM */
117 IH_ARCH_I386, /* Intel x86 */
118 IH_ARCH_IA64, /* IA64 */
119 IH_ARCH_MIPS, /* MIPS */
120 IH_ARCH_MIPS64, /* MIPS 64 Bit */
121 IH_ARCH_PPC, /* PowerPC */
122 IH_ARCH_S390, /* IBM S390 */
123 IH_ARCH_SH, /* SuperH */
124 IH_ARCH_SPARC, /* Sparc */
125 IH_ARCH_SPARC64, /* Sparc 64 Bit */
126 IH_ARCH_M68K, /* M68K */
127 IH_ARCH_NIOS, /* Nios-32 */
128 IH_ARCH_MICROBLAZE, /* MicroBlaze */
129 IH_ARCH_NIOS2, /* Nios-II */
130 IH_ARCH_BLACKFIN, /* Blackfin */
131 IH_ARCH_AVR32, /* AVR32 */
132 IH_ARCH_ST200, /* STMicroelectronics ST200 */
133 IH_ARCH_SANDBOX, /* Sandbox architecture (test only) */
134 IH_ARCH_NDS32, /* ANDES Technology - NDS32 */
135 IH_ARCH_OPENRISC, /* OpenRISC 1000 */
136 IH_ARCH_ARM64, /* ARM64 */
137 IH_ARCH_ARC, /* Synopsys DesignWare ARC */
138 IH_ARCH_X86_64, /* AMD x86_64, Intel and Via */
139 IH_ARCH_XTENSA, /* Xtensa */
140 IH_ARCH_RISCV, /* RISC-V */
148 * "Standalone Programs" are directly runnable in the environment
149 * provided by U-Boot; it is expected that (if they behave
150 * well) you can continue to work in U-Boot after return from
151 * the Standalone Program.
152 * "OS Kernel Images" are usually images of some Embedded OS which
153 * will take over control completely. Usually these programs
154 * will install their own set of exception handlers, device
155 * drivers, set up the MMU, etc. - this means, that you cannot
156 * expect to re-enter U-Boot except by resetting the CPU.
157 * "RAMDisk Images" are more or less just data blocks, and their
158 * parameters (address, size) are passed to an OS kernel that is
160 * "Multi-File Images" contain several images, typically an OS
161 * (Linux) kernel image and one or more data images like
162 * RAMDisks. This construct is useful for instance when you want
163 * to boot over the network using BOOTP etc., where the boot
164 * server provides just a single image file, but you want to get
165 * for instance an OS kernel and a RAMDisk image.
167 * "Multi-File Images" start with a list of image sizes, each
168 * image size (in bytes) specified by an "uint32_t" in network
169 * byte order. This list is terminated by an "(uint32_t)0".
170 * Immediately after the terminating 0 follow the images, one by
171 * one, all aligned on "uint32_t" boundaries (size rounded up to
172 * a multiple of 4 bytes - except for the last file).
174 * "Firmware Images" are binary images containing firmware (like
175 * U-Boot or FPGA images) which usually will be programmed to
178 * "Script files" are command sequences that will be executed by
179 * U-Boot's command interpreter; this feature is especially
180 * useful when you configure U-Boot to use a real shell (hush)
181 * as command interpreter (=> Shell Scripts).
183 * The following are exposed to uImage header.
184 * New IDs *MUST* be appended at the end of the list and *NEVER*
185 * inserted for backward compatibility.
189 IH_TYPE_INVALID = 0, /* Invalid Image */
190 IH_TYPE_STANDALONE, /* Standalone Program */
191 IH_TYPE_KERNEL, /* OS Kernel Image */
192 IH_TYPE_RAMDISK, /* RAMDisk Image */
193 IH_TYPE_MULTI, /* Multi-File Image */
194 IH_TYPE_FIRMWARE, /* Firmware Image */
195 IH_TYPE_SCRIPT, /* Script file */
196 IH_TYPE_FILESYSTEM, /* Filesystem Image (any type) */
197 IH_TYPE_FLATDT, /* Binary Flat Device Tree Blob */
198 IH_TYPE_KWBIMAGE, /* Kirkwood Boot Image */
199 IH_TYPE_IMXIMAGE, /* Freescale IMXBoot Image */
200 IH_TYPE_UBLIMAGE, /* Davinci UBL Image */
201 IH_TYPE_OMAPIMAGE, /* TI OMAP Config Header Image */
202 IH_TYPE_AISIMAGE, /* TI Davinci AIS Image */
203 /* OS Kernel Image, can run from any load address */
204 IH_TYPE_KERNEL_NOLOAD,
205 IH_TYPE_PBLIMAGE, /* Freescale PBL Boot Image */
206 IH_TYPE_MXSIMAGE, /* Freescale MXSBoot Image */
207 IH_TYPE_GPIMAGE, /* TI Keystone GPHeader Image */
208 IH_TYPE_ATMELIMAGE, /* ATMEL ROM bootable Image */
209 IH_TYPE_SOCFPGAIMAGE, /* Altera SOCFPGA CV/AV Preloader */
210 IH_TYPE_X86_SETUP, /* x86 setup.bin Image */
211 IH_TYPE_LPC32XXIMAGE, /* x86 setup.bin Image */
212 IH_TYPE_LOADABLE, /* A list of typeless images */
213 IH_TYPE_RKIMAGE, /* Rockchip Boot Image */
214 IH_TYPE_RKSD, /* Rockchip SD card */
215 IH_TYPE_RKSPI, /* Rockchip SPI image */
216 IH_TYPE_ZYNQIMAGE, /* Xilinx Zynq Boot Image */
217 IH_TYPE_ZYNQMPIMAGE, /* Xilinx ZynqMP Boot Image */
218 IH_TYPE_ZYNQMPBIF, /* Xilinx ZynqMP Boot Image (bif) */
219 IH_TYPE_FPGA, /* FPGA Image */
220 IH_TYPE_VYBRIDIMAGE, /* VYBRID .vyb Image */
221 IH_TYPE_TEE, /* Trusted Execution Environment OS Image */
222 IH_TYPE_FIRMWARE_IVT, /* Firmware Image with HABv4 IVT */
223 IH_TYPE_PMMC, /* TI Power Management Micro-Controller Firmware */
224 IH_TYPE_STM32IMAGE, /* STMicroelectronics STM32 Image */
225 IH_TYPE_SOCFPGAIMAGE_V1, /* Altera SOCFPGA A10 Preloader */
226 IH_TYPE_MTKIMAGE, /* MediaTek BootROM loadable Image */
227 IH_TYPE_IMX8MIMAGE, /* Freescale IMX8MBoot Image */
228 IH_TYPE_IMX8IMAGE, /* Freescale IMX8Boot Image */
229 IH_TYPE_COPRO, /* Coprocessor Image for remoteproc*/
230 IH_TYPE_SUNXI_EGON, /* Allwinner eGON Boot Image */
232 IH_TYPE_COUNT, /* Number of image types */
238 * The following are exposed to uImage header.
239 * New IDs *MUST* be appended at the end of the list and *NEVER*
240 * inserted for backward compatibility.
243 IH_COMP_NONE = 0, /* No Compression Used */
244 IH_COMP_GZIP, /* gzip Compression Used */
245 IH_COMP_BZIP2, /* bzip2 Compression Used */
246 IH_COMP_LZMA, /* lzma Compression Used */
247 IH_COMP_LZO, /* lzo Compression Used */
248 IH_COMP_LZ4, /* lz4 Compression Used */
249 IH_COMP_ZSTD, /* zstd Compression Used */
254 #define LZ4F_MAGIC 0x184D2204 /* LZ4 Magic Number */
255 #define IH_MAGIC 0x27051956 /* Image Magic Number */
256 #define IH_NMLEN 32 /* Image Name Length */
258 /* Reused from common.h */
259 #define ROUND(a, b) (((a) + (b) - 1) & ~((b) - 1))
262 * Legacy format image header,
263 * all data in network byte order (aka natural aka bigendian).
265 typedef struct image_header {
266 uint32_t ih_magic; /* Image Header Magic Number */
267 uint32_t ih_hcrc; /* Image Header CRC Checksum */
268 uint32_t ih_time; /* Image Creation Timestamp */
269 uint32_t ih_size; /* Image Data Size */
270 uint32_t ih_load; /* Data Load Address */
271 uint32_t ih_ep; /* Entry Point Address */
272 uint32_t ih_dcrc; /* Image Data CRC Checksum */
273 uint8_t ih_os; /* Operating System */
274 uint8_t ih_arch; /* CPU architecture */
275 uint8_t ih_type; /* Image Type */
276 uint8_t ih_comp; /* Compression Type */
277 uint8_t ih_name[IH_NMLEN]; /* Image Name */
280 typedef struct image_info {
281 ulong start, end; /* start/end of blob */
282 ulong image_start, image_len; /* start of image within blob, len of image */
283 ulong load; /* load addr for the image */
284 uint8_t comp, type, os; /* compression, type of image, os type */
285 uint8_t arch; /* CPU architecture */
289 * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
292 typedef struct bootm_headers {
294 * Legacy os image header, if it is a multi component image
295 * then boot_get_ramdisk() and get_fdt() will attempt to get
296 * data from second and third component accordingly.
298 image_header_t *legacy_hdr_os; /* image header pointer */
299 image_header_t legacy_hdr_os_copy; /* header copy */
300 ulong legacy_hdr_valid;
303 * The fit_ members are only used with FIT, but it involves a lot of
304 * #ifdefs to avoid compiling that code. Since FIT is the standard
305 * format, even for SPL, this extra data size seems worth it.
307 const char *fit_uname_cfg; /* configuration node unit name */
309 void *fit_hdr_os; /* os FIT image header */
310 const char *fit_uname_os; /* os subimage node unit name */
311 int fit_noffset_os; /* os subimage node offset */
313 void *fit_hdr_rd; /* init ramdisk FIT image header */
314 const char *fit_uname_rd; /* init ramdisk subimage node unit name */
315 int fit_noffset_rd; /* init ramdisk subimage node offset */
317 void *fit_hdr_fdt; /* FDT blob FIT image header */
318 const char *fit_uname_fdt; /* FDT blob subimage node unit name */
319 int fit_noffset_fdt;/* FDT blob subimage node offset */
321 void *fit_hdr_setup; /* x86 setup FIT image header */
322 const char *fit_uname_setup; /* x86 setup subimage node name */
323 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)
354 #define BOOTM_STATE_PRE_LOAD 0x00000800
357 #if defined(CONFIG_LMB) && !defined(USE_HOSTCC)
358 struct lmb lmb; /* for memory mgmt */
362 extern bootm_headers_t images;
365 * Some systems (for example LWMON) have very short watchdog periods;
366 * we must make sure to split long operations like memmove() or
367 * checksum calculations into reasonable chunks.
370 #define CHUNKSZ (64 * 1024)
373 #ifndef CHUNKSZ_CRC32
374 #define CHUNKSZ_CRC32 (64 * 1024)
378 #define CHUNKSZ_MD5 (64 * 1024)
382 #define CHUNKSZ_SHA1 (64 * 1024)
385 #define uimage_to_cpu(x) be32_to_cpu(x)
386 #define cpu_to_uimage(x) cpu_to_be32(x)
389 * Translation table for entries of a specific type; used by
390 * get_table_entry_id() and get_table_entry_name().
392 typedef struct table_entry {
394 char *sname; /* short (input) name to find table entry */
395 char *lname; /* long (output) name to print for messages */
399 * Compression type and magic number mapping table.
401 struct comp_magic_map {
404 unsigned char magic[2];
408 * get_table_entry_id() scans the translation table trying to find an
409 * entry that matches the given short name. If a matching entry is
410 * found, it's id is returned to the caller.
412 int get_table_entry_id(const table_entry_t *table,
413 const char *table_name, const char *name);
415 * get_table_entry_name() scans the translation table trying to find
416 * an entry that matches the given id. If a matching entry is found,
417 * its long name is returned to the caller.
419 char *get_table_entry_name(const table_entry_t *table, char *msg, int id);
421 const char *genimg_get_os_name(uint8_t os);
424 * genimg_get_os_short_name() - get the short name for an OS
426 * @param os OS (IH_OS_...)
427 * Return: OS short name, or "unknown" if unknown
429 const char *genimg_get_os_short_name(uint8_t comp);
431 const char *genimg_get_arch_name(uint8_t arch);
434 * genimg_get_arch_short_name() - get the short name for an architecture
436 * @param arch Architecture type (IH_ARCH_...)
437 * Return: architecture short name, or "unknown" if unknown
439 const char *genimg_get_arch_short_name(uint8_t arch);
441 const char *genimg_get_type_name(uint8_t type);
444 * genimg_get_type_short_name() - get the short name for an image type
446 * @param type Image type (IH_TYPE_...)
447 * Return: image short name, or "unknown" if unknown
449 const char *genimg_get_type_short_name(uint8_t type);
451 const char *genimg_get_comp_name(uint8_t comp);
454 * genimg_get_comp_short_name() - get the short name for a compression method
456 * @param comp compression method (IH_COMP_...)
457 * Return: compression method short name, or "unknown" if unknown
459 const char *genimg_get_comp_short_name(uint8_t comp);
462 * genimg_get_cat_name() - Get the name of an item in a category
464 * @category: Category of item
466 * Return: name of item, or "Unknown ..." if unknown
468 const char *genimg_get_cat_name(enum ih_category category, uint id);
471 * genimg_get_cat_short_name() - Get the short name of an item in a category
473 * @category: Category of item
475 * Return: short name of item, or "Unknown ..." if unknown
477 const char *genimg_get_cat_short_name(enum ih_category category, uint id);
480 * genimg_get_cat_count() - Get the number of items in a category
482 * @category: Category to check
483 * Return: the number of items in the category (IH_xxx_COUNT)
485 int genimg_get_cat_count(enum ih_category category);
488 * genimg_get_cat_desc() - Get the description of a category
490 * @category: Category to check
491 * Return: the description of a category, e.g. "architecture". This
492 * effectively converts the enum to a string.
494 const char *genimg_get_cat_desc(enum ih_category category);
497 * genimg_cat_has_id() - Check whether a category has an item
499 * @category: Category to check
501 * Return: true or false as to whether a category has an item
503 bool genimg_cat_has_id(enum ih_category category, uint id);
505 int genimg_get_os_id(const char *name);
506 int genimg_get_arch_id(const char *name);
507 int genimg_get_type_id(const char *name);
508 int genimg_get_comp_id(const char *name);
509 void genimg_print_size(uint32_t size);
511 #if defined(CONFIG_TIMESTAMP) || defined(CONFIG_CMD_DATE) || defined(USE_HOSTCC)
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,
529 /* Image format types, returned by _get_format() routine */
530 #define IMAGE_FORMAT_INVALID 0x00
531 #define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */
532 #define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */
533 #define IMAGE_FORMAT_ANDROID 0x03 /* Android boot image */
535 ulong genimg_get_kernel_addr_fit(char * const img_addr,
536 const char **fit_uname_config,
537 const char **fit_uname_kernel);
538 ulong genimg_get_kernel_addr(char * const img_addr);
539 int genimg_get_format(const void *img_addr);
540 int genimg_has_config(bootm_headers_t *images);
542 int boot_get_fpga(int argc, char *const argv[], bootm_headers_t *images,
543 uint8_t arch, const ulong *ld_start, ulong * const ld_len);
544 int boot_get_ramdisk(int argc, char *const argv[], bootm_headers_t *images,
545 uint8_t arch, ulong *rd_start, ulong *rd_end);
548 * boot_get_loadable - routine to load a list of binaries to memory
549 * @argc: Ignored Argument
550 * @argv: Ignored Argument
551 * @images: pointer to the bootm images structure
552 * @arch: expected architecture for the image
553 * @ld_start: Ignored Argument
554 * @ld_len: Ignored Argument
556 * boot_get_loadable() will take the given FIT configuration, and look
557 * for a field named "loadables". Loadables, is a list of elements in
558 * the FIT given as strings. exe:
559 * loadables = "linux_kernel", "fdt-2";
560 * this function will attempt to parse each string, and load the
561 * corresponding element from the FIT into memory. Once placed,
562 * no aditional actions are taken.
565 * 0, if only valid images or no images are found
566 * error code, if an error occurs during fit_image_load
568 int boot_get_loadable(int argc, char *const argv[], bootm_headers_t *images,
569 uint8_t arch, const ulong *ld_start, ulong *const ld_len);
571 int boot_get_setup_fit(bootm_headers_t *images, uint8_t arch,
572 ulong *setup_start, ulong *setup_len);
575 * boot_get_fdt_fit() - load a DTB from a FIT file (applying overlays)
577 * This deals with all aspects of loading an DTB from a FIT.
578 * The correct base image based on configuration will be selected, and
579 * then any overlays specified will be applied (as present in fit_uname_configp).
581 * @param images Boot images structure
582 * @param addr Address of FIT in memory
583 * @param fit_unamep On entry this is the requested image name
584 * (e.g. "kernel") or NULL to use the default. On exit
585 * points to the selected image name
586 * @param fit_uname_configp On entry this is the requested configuration
587 * name (e.g. "conf-1") or NULL to use the default. On
588 * exit points to the selected configuration name.
589 * @param arch Expected architecture (IH_ARCH_...)
590 * @param datap Returns address of loaded image
591 * @param lenp Returns length of loaded image
593 * Return: node offset of base image, or -ve error code on error
595 int boot_get_fdt_fit(bootm_headers_t *images, ulong addr,
596 const char **fit_unamep, const char **fit_uname_configp,
597 int arch, ulong *datap, ulong *lenp);
600 * fit_image_load() - load an image from a FIT
602 * This deals with all aspects of loading an image from a FIT, including
603 * selecting the right image based on configuration, verifying it, printing
604 * out progress messages, checking the type/arch/os and optionally copying it
605 * to the right load address.
607 * The property to look up is defined by image_type.
609 * @param images Boot images structure
610 * @param addr Address of FIT in memory
611 * @param fit_unamep On entry this is the requested image name
612 * (e.g. "kernel") or NULL to use the default. On exit
613 * points to the selected image name
614 * @param fit_uname_configp On entry this is the requested configuration
615 * name (e.g. "conf-1") or NULL to use the default. On
616 * exit points to the selected configuration name.
617 * @param arch Expected architecture (IH_ARCH_...)
618 * @param image_type Required image type (IH_TYPE_...). If this is
619 * IH_TYPE_KERNEL then we allow IH_TYPE_KERNEL_NOLOAD
621 * @param bootstage_id ID of starting bootstage to use for progress updates.
622 * This will be added to the BOOTSTAGE_SUB values when
623 * calling bootstage_mark()
624 * @param load_op Decribes what to do with the load address
625 * @param datap Returns address of loaded image
626 * @param lenp Returns length of loaded image
627 * Return: node offset of image, or -ve error code on error
629 int fit_image_load(bootm_headers_t *images, ulong addr,
630 const char **fit_unamep, const char **fit_uname_configp,
631 int arch, int image_type, int bootstage_id,
632 enum fit_load_op load_op, ulong *datap, ulong *lenp);
635 * image_source_script() - Execute a script
637 * Executes a U-Boot script at a particular address in memory. The script should
638 * have a header (FIT or legacy) with the script type (IH_TYPE_SCRIPT).
640 * @addr: Address of script
641 * @fit_uname: FIT subimage name
642 * Return: result code (enum command_ret_t)
644 int image_source_script(ulong addr, const char *fit_uname);
647 * fit_get_node_from_config() - Look up an image a FIT by type
649 * This looks in the selected conf- node (images->fit_uname_cfg) for a
650 * particular image type (e.g. "kernel") and then finds the image that is
653 * For example, for something like:
666 * the function will return the node offset of the kernel@1 node, assuming
667 * that conf-1 is the chosen configuration.
669 * @param images Boot images structure
670 * @param prop_name Property name to look up (FIT_..._PROP)
671 * @param addr Address of FIT in memory
673 int fit_get_node_from_config(bootm_headers_t *images, const char *prop_name,
676 int boot_get_fdt(int flag, int argc, char *const argv[], uint8_t arch,
677 bootm_headers_t *images,
678 char **of_flat_tree, ulong *of_size);
679 void boot_fdt_add_mem_rsv_regions(struct lmb *lmb, void *fdt_blob);
680 int boot_relocate_fdt(struct lmb *lmb, char **of_flat_tree, ulong *of_size);
682 int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len,
683 ulong *initrd_start, ulong *initrd_end);
684 int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end);
685 int boot_get_kbd(struct lmb *lmb, struct bd_info **kbd);
687 /*******************************************************************/
688 /* Legacy format specific code (prefixed with image_) */
689 /*******************************************************************/
690 static inline uint32_t image_get_header_size(void)
692 return (sizeof(image_header_t));
695 #define image_get_hdr_l(f) \
696 static inline uint32_t image_get_##f(const image_header_t *hdr) \
698 return uimage_to_cpu(hdr->ih_##f); \
700 image_get_hdr_l(magic) /* image_get_magic */
701 image_get_hdr_l(hcrc) /* image_get_hcrc */
702 image_get_hdr_l(time) /* image_get_time */
703 image_get_hdr_l(size) /* image_get_size */
704 image_get_hdr_l(load) /* image_get_load */
705 image_get_hdr_l(ep) /* image_get_ep */
706 image_get_hdr_l(dcrc) /* image_get_dcrc */
708 #define image_get_hdr_b(f) \
709 static inline uint8_t image_get_##f(const image_header_t *hdr) \
711 return hdr->ih_##f; \
713 image_get_hdr_b(os) /* image_get_os */
714 image_get_hdr_b(arch) /* image_get_arch */
715 image_get_hdr_b(type) /* image_get_type */
716 image_get_hdr_b(comp) /* image_get_comp */
718 static inline char *image_get_name(const image_header_t *hdr)
720 return (char *)hdr->ih_name;
723 static inline uint32_t image_get_data_size(const image_header_t *hdr)
725 return image_get_size(hdr);
729 * image_get_data - get image payload start address
732 * image_get_data() returns address of the image payload. For single
733 * component images it is image data start. For multi component
734 * images it points to the null terminated table of sub-images sizes.
737 * image payload data start address
739 static inline ulong image_get_data(const image_header_t *hdr)
741 return ((ulong)hdr + image_get_header_size());
744 static inline uint32_t image_get_image_size(const image_header_t *hdr)
746 return (image_get_size(hdr) + image_get_header_size());
748 static inline ulong image_get_image_end(const image_header_t *hdr)
750 return ((ulong)hdr + image_get_image_size(hdr));
753 #define image_set_hdr_l(f) \
754 static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
756 hdr->ih_##f = cpu_to_uimage(val); \
758 image_set_hdr_l(magic) /* image_set_magic */
759 image_set_hdr_l(hcrc) /* image_set_hcrc */
760 image_set_hdr_l(time) /* image_set_time */
761 image_set_hdr_l(size) /* image_set_size */
762 image_set_hdr_l(load) /* image_set_load */
763 image_set_hdr_l(ep) /* image_set_ep */
764 image_set_hdr_l(dcrc) /* image_set_dcrc */
766 #define image_set_hdr_b(f) \
767 static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
771 image_set_hdr_b(os) /* image_set_os */
772 image_set_hdr_b(arch) /* image_set_arch */
773 image_set_hdr_b(type) /* image_set_type */
774 image_set_hdr_b(comp) /* image_set_comp */
776 static inline void image_set_name(image_header_t *hdr, const char *name)
778 strncpy(image_get_name(hdr), name, IH_NMLEN);
781 int image_check_hcrc(const image_header_t *hdr);
782 int image_check_dcrc(const image_header_t *hdr);
784 ulong env_get_bootm_low(void);
785 phys_size_t env_get_bootm_size(void);
786 phys_size_t env_get_bootm_mapsize(void);
788 void memmove_wd(void *to, void *from, size_t len, ulong chunksz);
790 static inline int image_check_magic(const image_header_t *hdr)
792 return (image_get_magic(hdr) == IH_MAGIC);
794 static inline int image_check_type(const image_header_t *hdr, uint8_t type)
796 return (image_get_type(hdr) == type);
798 static inline int image_check_arch(const image_header_t *hdr, uint8_t arch)
800 /* Let's assume that sandbox can load any architecture */
801 if (!tools_build() && IS_ENABLED(CONFIG_SANDBOX))
803 return (image_get_arch(hdr) == arch) ||
804 (image_get_arch(hdr) == IH_ARCH_ARM && arch == IH_ARCH_ARM64);
806 static inline int image_check_os(const image_header_t *hdr, uint8_t os)
808 return (image_get_os(hdr) == os);
811 ulong image_multi_count(const image_header_t *hdr);
812 void image_multi_getimg(const image_header_t *hdr, ulong idx,
813 ulong *data, ulong *len);
815 void image_print_contents(const void *hdr);
818 static inline int image_check_target_arch(const image_header_t *hdr)
820 #ifndef IH_ARCH_DEFAULT
821 # error "please define IH_ARCH_DEFAULT in your arch asm/u-boot.h"
823 return image_check_arch(hdr, IH_ARCH_DEFAULT);
825 #endif /* USE_HOSTCC */
828 * image_decomp_type() - Find out compression type of an image
830 * @buf: Address in U-Boot memory where image is loaded.
831 * @len: Length of the compressed image.
832 * Return: compression type or IH_COMP_NONE if not compressed.
834 * Note: Only following compression types are supported now.
835 * lzo, lzma, gzip, bzip2
837 int image_decomp_type(const unsigned char *buf, ulong len);
840 * image_decomp() - decompress an image
842 * @comp: Compression algorithm that is used (IH_COMP_...)
843 * @load: Destination load address in U-Boot memory
844 * @image_start Image start address (where we are decompressing from)
845 * @type: OS type (IH_OS_...)
846 * @load_bug: Place to decompress to
847 * @image_buf: Address to decompress from
848 * @image_len: Number of bytes in @image_buf to decompress
849 * @unc_len: Available space for decompression
850 * Return: 0 if OK, -ve on error (BOOTM_ERR_...)
852 int image_decomp(int comp, ulong load, ulong image_start, int type,
853 void *load_buf, void *image_buf, ulong image_len,
854 uint unc_len, ulong *load_end);
857 * Set up properties in the FDT
859 * This sets up properties in the FDT that is to be passed to linux.
861 * @images: Images information
862 * @blob: FDT to update
863 * @of_size: Size of the FDT
864 * @lmb: Points to logical memory block structure
865 * Return: 0 if ok, <0 on failure
867 int image_setup_libfdt(bootm_headers_t *images, void *blob,
868 int of_size, struct lmb *lmb);
871 * Set up the FDT to use for booting a kernel
873 * This performs ramdisk setup, sets up the FDT if required, and adds
874 * paramters to the FDT if libfdt is available.
876 * @param images Images information
877 * Return: 0 if ok, <0 on failure
879 int image_setup_linux(bootm_headers_t *images);
882 * bootz_setup() - Extract stat and size of a Linux xImage
884 * @image: Address of image
885 * @start: Returns start address of image
886 * @end : Returns end address of image
887 * Return: 0 if OK, 1 if the image was not recognised
889 int bootz_setup(ulong image, ulong *start, ulong *end);
892 * Return the correct start address and size of a Linux aarch64 Image.
894 * @image: Address of image
895 * @start: Returns start address of image
896 * @size : Returns size image
897 * @force_reloc: Ignore image->ep field, always place image to RAM start
898 * Return: 0 if OK, 1 if the image was not recognised
900 int booti_setup(ulong image, ulong *relocated_addr, ulong *size,
903 /*******************************************************************/
904 /* New uImage format specific code (prefixed with fit_) */
905 /*******************************************************************/
907 #define FIT_IMAGES_PATH "/images"
908 #define FIT_CONFS_PATH "/configurations"
910 /* hash/signature/key node */
911 #define FIT_HASH_NODENAME "hash"
912 #define FIT_ALGO_PROP "algo"
913 #define FIT_VALUE_PROP "value"
914 #define FIT_IGNORE_PROP "uboot-ignore"
915 #define FIT_SIG_NODENAME "signature"
916 #define FIT_KEY_REQUIRED "required"
917 #define FIT_KEY_HINT "key-name-hint"
920 #define FIT_CIPHER_NODENAME "cipher"
921 #define FIT_ALGO_PROP "algo"
924 #define FIT_DATA_PROP "data"
925 #define FIT_DATA_POSITION_PROP "data-position"
926 #define FIT_DATA_OFFSET_PROP "data-offset"
927 #define FIT_DATA_SIZE_PROP "data-size"
928 #define FIT_TIMESTAMP_PROP "timestamp"
929 #define FIT_DESC_PROP "description"
930 #define FIT_ARCH_PROP "arch"
931 #define FIT_TYPE_PROP "type"
932 #define FIT_OS_PROP "os"
933 #define FIT_COMP_PROP "compression"
934 #define FIT_ENTRY_PROP "entry"
935 #define FIT_LOAD_PROP "load"
937 /* configuration node */
938 #define FIT_KERNEL_PROP "kernel"
939 #define FIT_RAMDISK_PROP "ramdisk"
940 #define FIT_FDT_PROP "fdt"
941 #define FIT_LOADABLE_PROP "loadables"
942 #define FIT_DEFAULT_PROP "default"
943 #define FIT_SETUP_PROP "setup"
944 #define FIT_FPGA_PROP "fpga"
945 #define FIT_FIRMWARE_PROP "firmware"
946 #define FIT_STANDALONE_PROP "standalone"
948 #define FIT_MAX_HASH_LEN HASH_MAX_DIGEST_SIZE
950 /* cmdline argument format parsing */
951 int fit_parse_conf(const char *spec, ulong addr_curr,
952 ulong *addr, const char **conf_name);
953 int fit_parse_subimage(const char *spec, ulong addr_curr,
954 ulong *addr, const char **image_name);
956 int fit_get_subimage_count(const void *fit, int images_noffset);
957 void fit_print_contents(const void *fit);
958 void fit_image_print(const void *fit, int noffset, const char *p);
961 * fit_get_end - get FIT image size
962 * @fit: pointer to the FIT format image header
965 * size of the FIT image (blob) in memory
967 static inline ulong fit_get_size(const void *fit)
969 return fdt_totalsize(fit);
973 * fit_get_end - get FIT image end
974 * @fit: pointer to the FIT format image header
977 * end address of the FIT image (blob) in memory
979 ulong fit_get_end(const void *fit);
982 * fit_get_name - get FIT node name
983 * @fit: pointer to the FIT format image header
987 * pointer to node name, on success
989 static inline const char *fit_get_name(const void *fit_hdr,
990 int noffset, int *len)
992 return fdt_get_name(fit_hdr, noffset, len);
995 int fit_get_desc(const void *fit, int noffset, char **desc);
996 int fit_get_timestamp(const void *fit, int noffset, time_t *timestamp);
998 int fit_image_get_node(const void *fit, const char *image_uname);
999 int fit_image_get_os(const void *fit, int noffset, uint8_t *os);
1000 int fit_image_get_arch(const void *fit, int noffset, uint8_t *arch);
1001 int fit_image_get_type(const void *fit, int noffset, uint8_t *type);
1002 int fit_image_get_comp(const void *fit, int noffset, uint8_t *comp);
1003 int fit_image_get_load(const void *fit, int noffset, ulong *load);
1004 int fit_image_get_entry(const void *fit, int noffset, ulong *entry);
1005 int fit_image_get_data(const void *fit, int noffset,
1006 const void **data, size_t *size);
1007 int fit_image_get_data_offset(const void *fit, int noffset, int *data_offset);
1008 int fit_image_get_data_position(const void *fit, int noffset,
1009 int *data_position);
1010 int fit_image_get_data_size(const void *fit, int noffset, int *data_size);
1011 int fit_image_get_data_size_unciphered(const void *fit, int noffset,
1013 int fit_image_get_data_and_size(const void *fit, int noffset,
1014 const void **data, size_t *size);
1016 int fit_image_hash_get_algo(const void *fit, int noffset, const char **algo);
1017 int fit_image_hash_get_value(const void *fit, int noffset, uint8_t **value,
1020 int fit_set_timestamp(void *fit, int noffset, time_t timestamp);
1022 int fit_cipher_data(const char *keydir, void *keydest, void *fit,
1023 const char *comment, int require_keys,
1024 const char *engine_id, const char *cmdname);
1026 #define NODE_MAX_NAME_LEN 80
1029 * struct image_summary - Provides information about signing info added
1031 * @sig_offset: Offset of the node in the blob devicetree where the signature
1033 * @sig_path: Path to @sig_offset
1034 * @keydest_offset: Offset of the node in the keydest devicetree where the
1035 * public key was written (-1 if none)
1036 * @keydest_path: Path to @keydest_offset
1038 struct image_summary {
1040 char sig_path[NODE_MAX_NAME_LEN];
1042 char keydest_path[NODE_MAX_NAME_LEN];
1046 * fit_add_verification_data() - add verification data to FIT image nodes
1048 * @keydir: Directory containing keys
1049 * @kwydest: FDT blob to write public key information to (NULL if none)
1050 * @fit: Pointer to the FIT format image header
1051 * @comment: Comment to add to signature nodes
1052 * @require_keys: Mark all keys as 'required'
1053 * @engine_id: Engine to use for signing
1054 * @cmdname: Command name used when reporting errors
1055 * @algo_name: Algorithm name, or NULL if to be read from FIT
1056 * @summary: Returns information about what data was written
1058 * Adds hash values for all component images in the FIT blob.
1059 * Hashes are calculated for all component images which have hash subnodes
1060 * with algorithm property set to one of the supported hash algorithms.
1062 * Also add signatures if signature nodes are present.
1066 * libfdt error code, on failure
1068 int fit_add_verification_data(const char *keydir, const char *keyfile,
1069 void *keydest, void *fit, const char *comment,
1070 int require_keys, const char *engine_id,
1071 const char *cmdname, const char *algo_name,
1072 struct image_summary *summary);
1075 * fit_image_verify_with_data() - Verify an image with given data
1077 * @fit: Pointer to the FIT format image header
1078 * @image_offset: Offset in @fit of image to verify
1079 * @key_blob: FDT containing public keys
1080 * @data: Image data to verify
1081 * @size: Size of image data
1083 int fit_image_verify_with_data(const void *fit, int image_noffset,
1084 const void *key_blob, const void *data,
1087 int fit_image_verify(const void *fit, int noffset);
1088 int fit_config_verify(const void *fit, int conf_noffset);
1089 int fit_all_image_verify(const void *fit);
1090 int fit_config_decrypt(const void *fit, int conf_noffset);
1091 int fit_image_check_os(const void *fit, int noffset, uint8_t os);
1092 int fit_image_check_arch(const void *fit, int noffset, uint8_t arch);
1093 int fit_image_check_type(const void *fit, int noffset, uint8_t type);
1094 int fit_image_check_comp(const void *fit, int noffset, uint8_t comp);
1097 * fit_check_format() - Check that the FIT is valid
1099 * This performs various checks on the FIT to make sure it is suitable for
1100 * use, looking for mandatory properties, nodes, etc.
1102 * If FIT_FULL_CHECK is enabled, it also runs it through libfdt to make
1103 * sure that there are no strange tags or broken nodes in the FIT.
1105 * @fit: pointer to the FIT format image header
1106 * Return: 0 if OK, -ENOEXEC if not an FDT file, -EINVAL if the full FDT check
1107 * failed (e.g. due to bad structure), -ENOMSG if the description is
1108 * missing, -EBADMSG if the timestamp is missing, -ENOENT if the /images
1111 int fit_check_format(const void *fit, ulong size);
1113 int fit_conf_find_compat(const void *fit, const void *fdt);
1116 * fit_conf_get_node - get node offset for configuration of a given unit name
1117 * @fit: pointer to the FIT format image header
1118 * @conf_uname: configuration node unit name (NULL to use default)
1120 * fit_conf_get_node() finds a configuration (within the '/configurations'
1121 * parent node) of a provided unit name. If configuration is found its node
1122 * offset is returned to the caller.
1124 * When NULL is provided in second argument fit_conf_get_node() will search
1125 * for a default configuration node instead. Default configuration node unit
1126 * name is retrieved from FIT_DEFAULT_PROP property of the '/configurations'
1130 * configuration node offset when found (>=0)
1131 * negative number on failure (FDT_ERR_* code)
1133 int fit_conf_get_node(const void *fit, const char *conf_uname);
1135 int fit_conf_get_prop_node_count(const void *fit, int noffset,
1136 const char *prop_name);
1137 int fit_conf_get_prop_node_index(const void *fit, int noffset,
1138 const char *prop_name, int index);
1141 * fit_conf_get_prop_node() - Get node refered to by a configuration
1142 * @fit: FIT to check
1143 * @noffset: Offset of conf@xxx node to check
1144 * @prop_name: Property to read from the conf node
1146 * The conf- nodes contain references to other nodes, using properties
1147 * like 'kernel = "kernel"'. Given such a property name (e.g. "kernel"),
1148 * return the offset of the node referred to (e.g. offset of node
1151 int fit_conf_get_prop_node(const void *fit, int noffset,
1152 const char *prop_name);
1154 int fit_check_ramdisk(const void *fit, int os_noffset,
1155 uint8_t arch, int verify);
1157 int calculate_hash(const void *data, int data_len, const char *algo,
1158 uint8_t *value, int *value_len);
1161 * At present we only support signing on the host, and verification on the
1164 #if defined(USE_HOSTCC)
1165 # if defined(CONFIG_FIT_SIGNATURE)
1166 # define IMAGE_ENABLE_SIGN 1
1167 # define FIT_IMAGE_ENABLE_VERIFY 1
1168 # include <openssl/evp.h>
1170 # define IMAGE_ENABLE_SIGN 0
1171 # define FIT_IMAGE_ENABLE_VERIFY 0
1174 # define IMAGE_ENABLE_SIGN 0
1175 # define FIT_IMAGE_ENABLE_VERIFY CONFIG_IS_ENABLED(FIT_SIGNATURE)
1179 void *image_get_host_blob(void);
1180 void image_set_host_blob(void *host_blob);
1181 # define gd_fdt_blob() image_get_host_blob()
1183 # define gd_fdt_blob() (gd->fdt_blob)
1187 * Information passed to the signing routines
1189 * Either 'keydir', 'keyname', or 'keyfile' can be NULL. However, either
1190 * 'keyfile', or both 'keydir' and 'keyname' should have valid values. If
1191 * neither are valid, some operations might fail with EINVAL.
1193 struct image_sign_info {
1194 const char *keydir; /* Directory conaining keys */
1195 const char *keyname; /* Name of key to use */
1196 const char *keyfile; /* Filename of private or public key */
1197 const void *fit; /* Pointer to FIT blob */
1198 int node_offset; /* Offset of signature node */
1199 const char *name; /* Algorithm name */
1200 struct checksum_algo *checksum; /* Checksum algorithm information */
1201 struct padding_algo *padding; /* Padding algorithm information */
1202 struct crypto_algo *crypto; /* Crypto algorithm information */
1203 const void *fdt_blob; /* FDT containing public keys */
1204 int required_keynode; /* Node offset of key to use: -1=any */
1205 const char *require_keys; /* Value for 'required' property */
1206 const char *engine_id; /* Engine to use for signing */
1208 * Note: the following two fields are always valid even w/o
1209 * RSA_VERIFY_WITH_PKEY in order to make sure this structure is
1210 * the same on target and host. Otherwise, vboot test may fail.
1212 const void *key; /* Pointer to public key in DER */
1213 int keylen; /* Length of public key */
1216 /* A part of an image, used for hashing */
1217 struct image_region {
1222 struct checksum_algo {
1224 const int checksum_len;
1226 const uint8_t *der_prefix;
1227 #if IMAGE_ENABLE_SIGN
1228 const EVP_MD *(*calculate_sign)(void);
1230 int (*calculate)(const char *name,
1231 const struct image_region *region,
1232 int region_count, uint8_t *checksum);
1235 struct crypto_algo {
1236 const char *name; /* Name of algorithm */
1240 * sign() - calculate and return signature for given input data
1242 * @info: Specifies key and FIT information
1243 * @data: Pointer to the input data
1244 * @data_len: Data length
1245 * @sigp: Set to an allocated buffer holding the signature
1246 * @sig_len: Set to length of the calculated hash
1248 * This computes input data signature according to selected algorithm.
1249 * Resulting signature value is placed in an allocated buffer, the
1250 * pointer is returned as *sigp. The length of the calculated
1251 * signature is returned via the sig_len pointer argument. The caller
1252 * should free *sigp.
1254 * @return: 0, on success, -ve on error
1256 int (*sign)(struct image_sign_info *info,
1257 const struct image_region region[],
1258 int region_count, uint8_t **sigp, uint *sig_len);
1261 * add_verify_data() - Add verification information to FDT
1263 * Add public key information to the FDT node, suitable for
1264 * verification at run-time. The information added depends on the
1265 * algorithm being used.
1267 * @info: Specifies key and FIT information
1268 * @keydest: Destination FDT blob for public key data
1269 * @return: node offset within the FDT blob where the data was written,
1272 int (*add_verify_data)(struct image_sign_info *info, void *keydest);
1275 * verify() - Verify a signature against some data
1277 * @info: Specifies key and FIT information
1278 * @data: Pointer to the input data
1279 * @data_len: Data length
1281 * @sig_len: Number of bytes in signature
1282 * @return 0 if verified, -ve on error
1284 int (*verify)(struct image_sign_info *info,
1285 const struct image_region region[], int region_count,
1286 uint8_t *sig, uint sig_len);
1289 /* Declare a new U-Boot crypto algorithm handler */
1290 #define U_BOOT_CRYPTO_ALGO(__name) \
1291 ll_entry_declare(struct crypto_algo, __name, cryptos)
1293 struct padding_algo {
1295 int (*verify)(struct image_sign_info *info,
1296 uint8_t *pad, int pad_len,
1297 const uint8_t *hash, int hash_len);
1300 /* Declare a new U-Boot padding algorithm handler */
1301 #define U_BOOT_PADDING_ALGO(__name) \
1302 ll_entry_declare(struct padding_algo, __name, paddings)
1305 * image_get_checksum_algo() - Look up a checksum algorithm
1307 * @param full_name Name of algorithm in the form "checksum,crypto"
1308 * Return: pointer to algorithm information, or NULL if not found
1310 struct checksum_algo *image_get_checksum_algo(const char *full_name);
1313 * image_get_crypto_algo() - Look up a cryptosystem algorithm
1315 * @param full_name Name of algorithm in the form "checksum,crypto"
1316 * Return: pointer to algorithm information, or NULL if not found
1318 struct crypto_algo *image_get_crypto_algo(const char *full_name);
1321 * image_get_padding_algo() - Look up a padding algorithm
1323 * @param name Name of padding algorithm
1324 * Return: pointer to algorithm information, or NULL if not found
1326 struct padding_algo *image_get_padding_algo(const char *name);
1329 * image_pre_load() - Manage pre load header
1331 * Manage the pre-load header before launching the image.
1332 * It checks the signature of the image. It also set the
1333 * variable image_load_offset to skip this header before
1334 * launching the image.
1336 * @param addr Address of the image
1337 * @return: 0 on success, -ve on error
1339 int image_pre_load(ulong addr);
1342 * fit_image_verify_required_sigs() - Verify signatures marked as 'required'
1344 * @fit: FIT to check
1345 * @image_noffset: Offset of image node to check
1346 * @data: Image data to check
1347 * @size: Size of image data
1348 * @key_blob: FDT containing public keys
1349 * @no_sigsp: Returns 1 if no signatures were required, and
1350 * therefore nothing was checked. The caller may wish
1351 * to fall back to other mechanisms, or refuse to
1353 * Return: 0 if all verified ok, <0 on error
1355 int fit_image_verify_required_sigs(const void *fit, int image_noffset,
1356 const char *data, size_t size, const void *key_blob,
1360 * fit_image_check_sig() - Check a single image signature node
1362 * @fit: FIT to check
1363 * @noffset: Offset of signature node to check
1364 * @data: Image data to check
1365 * @size: Size of image data
1366 * @keyblob: Key blob to check (typically the control FDT)
1367 * @required_keynode: Offset in the keyblob of the required key node,
1368 * if any. If this is given, then the image wil not
1369 * pass verification unless that key is used. If this is
1370 * -1 then any signature will do.
1371 * @err_msgp: In the event of an error, this will be pointed to a
1372 * help error string to display to the user.
1373 * Return: 0 if all verified ok, <0 on error
1375 int fit_image_check_sig(const void *fit, int noffset, const void *data,
1376 size_t size, const void *key_blob, int required_keynode,
1379 int fit_image_decrypt_data(const void *fit,
1380 int image_noffset, int cipher_noffset,
1381 const void *data, size_t size,
1382 void **data_unciphered, size_t *size_unciphered);
1385 * fit_region_make_list() - Make a list of regions to hash
1387 * Given a list of FIT regions (offset, size) provided by libfdt, create
1388 * a list of regions (void *, size) for use by the signature creationg
1389 * and verification code.
1391 * @fit: FIT image to process
1392 * @fdt_regions: Regions as returned by libfdt
1393 * @count: Number of regions returned by libfdt
1394 * @region: Place to put list of regions (NULL to allocate it)
1395 * Return: pointer to list of regions, or NULL if out of memory
1397 struct image_region *fit_region_make_list(const void *fit,
1398 struct fdt_region *fdt_regions, int count,
1399 struct image_region *region);
1401 static inline int fit_image_check_target_arch(const void *fdt, int node)
1404 return fit_image_check_arch(fdt, node, IH_ARCH_DEFAULT);
1411 * At present we only support ciphering on the host, and unciphering on the
1414 #if defined(USE_HOSTCC)
1415 # if defined(CONFIG_FIT_CIPHER)
1416 # define IMAGE_ENABLE_ENCRYPT 1
1417 # define IMAGE_ENABLE_DECRYPT 1
1418 # include <openssl/evp.h>
1420 # define IMAGE_ENABLE_ENCRYPT 0
1421 # define IMAGE_ENABLE_DECRYPT 0
1424 # define IMAGE_ENABLE_ENCRYPT 0
1425 # define IMAGE_ENABLE_DECRYPT CONFIG_IS_ENABLED(FIT_CIPHER)
1428 /* Information passed to the ciphering routines */
1429 struct image_cipher_info {
1430 const char *keydir; /* Directory containing keys */
1431 const char *keyname; /* Name of key to use */
1432 const char *ivname; /* Name of IV to use */
1433 const void *fit; /* Pointer to FIT blob */
1434 int node_noffset; /* Offset of the cipher node */
1435 const char *name; /* Algorithm name */
1436 struct cipher_algo *cipher; /* Cipher algorithm information */
1437 const void *fdt_blob; /* FDT containing key and IV */
1438 const void *key; /* Value of the key */
1439 const void *iv; /* Value of the IV */
1440 size_t size_unciphered; /* Size of the unciphered data */
1443 struct cipher_algo {
1444 const char *name; /* Name of algorithm */
1445 int key_len; /* Length of the key */
1446 int iv_len; /* Length of the IV */
1448 #if IMAGE_ENABLE_ENCRYPT
1449 const EVP_CIPHER * (*calculate_type)(void);
1452 int (*encrypt)(struct image_cipher_info *info,
1453 const unsigned char *data, int data_len,
1454 unsigned char **cipher, int *cipher_len);
1456 int (*add_cipher_data)(struct image_cipher_info *info,
1457 void *keydest, void *fit, int node_noffset);
1459 int (*decrypt)(struct image_cipher_info *info,
1460 const void *cipher, size_t cipher_len,
1461 void **data, size_t *data_len);
1464 int fit_image_cipher_get_algo(const void *fit, int noffset, char **algo);
1466 struct cipher_algo *image_get_cipher_algo(const char *full_name);
1468 struct andr_img_hdr;
1469 int android_image_check_header(const struct andr_img_hdr *hdr);
1470 int android_image_get_kernel(const struct andr_img_hdr *hdr, int verify,
1471 ulong *os_data, ulong *os_len);
1472 int android_image_get_ramdisk(const struct andr_img_hdr *hdr,
1473 ulong *rd_data, ulong *rd_len);
1474 int android_image_get_second(const struct andr_img_hdr *hdr,
1475 ulong *second_data, ulong *second_len);
1476 bool android_image_get_dtbo(ulong hdr_addr, ulong *addr, u32 *size);
1477 bool android_image_get_dtb_by_index(ulong hdr_addr, u32 index, ulong *addr,
1479 ulong android_image_get_end(const struct andr_img_hdr *hdr);
1480 ulong android_image_get_kload(const struct andr_img_hdr *hdr);
1481 ulong android_image_get_kcomp(const struct andr_img_hdr *hdr);
1482 void android_print_contents(const struct andr_img_hdr *hdr);
1483 bool android_image_print_dtb_contents(ulong hdr_addr);
1486 * board_fit_config_name_match() - Check for a matching board name
1488 * This is used when SPL loads a FIT containing multiple device tree files
1489 * and wants to work out which one to use. The description of each one is
1490 * passed to this function. The description comes from the 'description' field
1491 * in each (FDT) image node.
1493 * @name: Device tree description
1494 * Return: 0 if this device tree should be used, non-zero to try the next
1496 int board_fit_config_name_match(const char *name);
1499 * board_fit_image_post_process() - Do any post-process on FIT binary data
1501 * This is used to do any sort of image manipulation, verification, decryption
1502 * etc. in a platform or board specific way. Obviously, anything done here would
1503 * need to be comprehended in how the images were prepared before being injected
1504 * into the FIT creation (i.e. the binary blobs would have been pre-processed
1505 * before being added to the FIT image).
1507 * @fit: pointer to fit image
1508 * @node: offset of image node
1509 * @image: pointer to the image start pointer
1510 * @size: pointer to the image size
1511 * Return: no return value (failure should be handled internally)
1513 void board_fit_image_post_process(const void *fit, int node, void **p_image,
1516 #define FDT_ERROR ((ulong)(-1))
1518 ulong fdt_getprop_u32(const void *fdt, int node, const char *prop);
1521 * fit_find_config_node() - Find the node for the best DTB in a FIT image
1523 * A FIT image contains one or more DTBs. This function parses the
1524 * configurations described in the FIT images and returns the node of
1525 * the first matching DTB. To check if a DTB matches a board, this function
1526 * calls board_fit_config_name_match(). If no matching DTB is found, it returns
1527 * the node described by the default configuration if it exists.
1529 * @fdt: pointer to flat device tree
1530 * Return: the node if found, -ve otherwise
1532 int fit_find_config_node(const void *fdt);
1535 * Mapping of image types to function handlers to be invoked on the associated
1538 * @type: Type of image, I.E. IH_TYPE_*
1539 * @handler: Function to call on loaded image
1541 struct fit_loadable_tbl {
1544 * handler() - Process a loaded image
1546 * @data: Pointer to start of loaded image data
1547 * @size: Size of loaded image data
1549 void (*handler)(ulong data, size_t size);
1553 * Define a FIT loadable image type handler
1555 * _type is a valid uimage_type ID as defined in the "Image Type" enum above
1556 * _handler is the handler function to call after this image type is loaded
1558 #define U_BOOT_FIT_LOADABLE_HANDLER(_type, _handler) \
1559 ll_entry_declare(struct fit_loadable_tbl, _function, fit_loadable) = { \
1561 .handler = _handler, \
1565 * fit_update - update storage with FIT image
1566 * @fit: Pointer to FIT image
1568 * Update firmware on storage using FIT image as input.
1569 * The storage area to be update will be identified by the name
1570 * in FIT and matching it to "dfu_alt_info" variable.
1572 * Return: 0 on success, non-zero otherwise
1574 int fit_update(const void *fit);
1576 #endif /* __IMAGE_H__ */