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 */
231 IH_TYPE_SUNXI_TOC0
, /* Allwinner TOC0 Boot Image */
233 IH_TYPE_COUNT
, /* Number of image types */
239 * The following are exposed to uImage header.
240 * New IDs *MUST* be appended at the end of the list and *NEVER*
241 * inserted for backward compatibility.
244 IH_COMP_NONE
= 0, /* No Compression Used */
245 IH_COMP_GZIP
, /* gzip Compression Used */
246 IH_COMP_BZIP2
, /* bzip2 Compression Used */
247 IH_COMP_LZMA
, /* lzma Compression Used */
248 IH_COMP_LZO
, /* lzo Compression Used */
249 IH_COMP_LZ4
, /* lz4 Compression Used */
250 IH_COMP_ZSTD
, /* zstd Compression Used */
255 #define LZ4F_MAGIC 0x184D2204 /* LZ4 Magic Number */
256 #define IH_MAGIC 0x27051956 /* Image Magic Number */
257 #define IH_NMLEN 32 /* Image Name Length */
259 /* Reused from common.h */
260 #define ROUND(a, b) (((a) + (b) - 1) & ~((b) - 1))
263 * Legacy format image header,
264 * all data in network byte order (aka natural aka bigendian).
266 typedef struct image_header
{
267 uint32_t ih_magic
; /* Image Header Magic Number */
268 uint32_t ih_hcrc
; /* Image Header CRC Checksum */
269 uint32_t ih_time
; /* Image Creation Timestamp */
270 uint32_t ih_size
; /* Image Data Size */
271 uint32_t ih_load
; /* Data Load Address */
272 uint32_t ih_ep
; /* Entry Point Address */
273 uint32_t ih_dcrc
; /* Image Data CRC Checksum */
274 uint8_t ih_os
; /* Operating System */
275 uint8_t ih_arch
; /* CPU architecture */
276 uint8_t ih_type
; /* Image Type */
277 uint8_t ih_comp
; /* Compression Type */
278 uint8_t ih_name
[IH_NMLEN
]; /* Image Name */
282 ulong start
, end
; /* start/end of blob */
283 ulong image_start
, image_len
; /* start of image within blob, len of image */
284 ulong load
; /* load addr for the image */
285 uint8_t comp
, type
, os
; /* compression, type of image, os type */
286 uint8_t arch
; /* CPU architecture */
290 * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
293 struct bootm_headers
{
295 * Legacy os image header, if it is a multi component image
296 * then boot_get_ramdisk() and get_fdt() will attempt to get
297 * data from second and third component accordingly.
299 image_header_t
*legacy_hdr_os
; /* image header pointer */
300 image_header_t legacy_hdr_os_copy
; /* header copy */
301 ulong legacy_hdr_valid
;
304 * The fit_ members are only used with FIT, but it involves a lot of
305 * #ifdefs to avoid compiling that code. Since FIT is the standard
306 * format, even for SPL, this extra data size seems worth it.
308 const char *fit_uname_cfg
; /* configuration node unit name */
310 void *fit_hdr_os
; /* os FIT image header */
311 const char *fit_uname_os
; /* os subimage node unit name */
312 int fit_noffset_os
; /* os subimage node offset */
314 void *fit_hdr_rd
; /* init ramdisk FIT image header */
315 const char *fit_uname_rd
; /* init ramdisk subimage node unit name */
316 int fit_noffset_rd
; /* init ramdisk subimage node offset */
318 void *fit_hdr_fdt
; /* FDT blob FIT image header */
319 const char *fit_uname_fdt
; /* FDT blob subimage node unit name */
320 int fit_noffset_fdt
;/* FDT blob subimage node offset */
322 void *fit_hdr_setup
; /* x86 setup FIT image header */
323 const char *fit_uname_setup
; /* x86 setup subimage node name */
324 int fit_noffset_setup
;/* x86 setup subimage node offset */
327 struct image_info os
; /* os image info */
328 ulong ep
; /* entry point of OS */
330 ulong rd_start
, rd_end
;/* ramdisk start/end */
332 char *ft_addr
; /* flat dev tree address */
333 ulong ft_len
; /* length of flat device tree */
342 int verify
; /* env_get("verify")[0] != 'n' */
344 #define BOOTM_STATE_START 0x00000001
345 #define BOOTM_STATE_FINDOS 0x00000002
346 #define BOOTM_STATE_FINDOTHER 0x00000004
347 #define BOOTM_STATE_LOADOS 0x00000008
348 #define BOOTM_STATE_RAMDISK 0x00000010
349 #define BOOTM_STATE_FDT 0x00000020
350 #define BOOTM_STATE_OS_CMDLINE 0x00000040
351 #define BOOTM_STATE_OS_BD_T 0x00000080
352 #define BOOTM_STATE_OS_PREP 0x00000100
353 #define BOOTM_STATE_OS_FAKE_GO 0x00000200 /* 'Almost' run the OS */
354 #define BOOTM_STATE_OS_GO 0x00000400
355 #define BOOTM_STATE_PRE_LOAD 0x00000800
358 #if defined(CONFIG_LMB) && !defined(USE_HOSTCC)
359 struct lmb lmb
; /* for memory mgmt */
364 #define images_lmb(_images) (&(_images)->lmb)
366 #define images_lmb(_images) NULL
369 extern struct bootm_headers images
;
372 * Some systems (for example LWMON) have very short watchdog periods;
373 * we must make sure to split long operations like memmove() or
374 * checksum calculations into reasonable chunks.
377 #define CHUNKSZ (64 * 1024)
380 #ifndef CHUNKSZ_CRC32
381 #define CHUNKSZ_CRC32 (64 * 1024)
385 #define CHUNKSZ_MD5 (64 * 1024)
389 #define CHUNKSZ_SHA1 (64 * 1024)
392 #define uimage_to_cpu(x) be32_to_cpu(x)
393 #define cpu_to_uimage(x) cpu_to_be32(x)
396 * Translation table for entries of a specific type; used by
397 * get_table_entry_id() and get_table_entry_name().
399 typedef struct table_entry
{
401 char *sname
; /* short (input) name to find table entry */
402 char *lname
; /* long (output) name to print for messages */
406 * Compression type and magic number mapping table.
408 struct comp_magic_map
{
411 unsigned char magic
[2];
415 * get_table_entry_id() scans the translation table trying to find an
416 * entry that matches the given short name. If a matching entry is
417 * found, it's id is returned to the caller.
419 int get_table_entry_id(const table_entry_t
*table
,
420 const char *table_name
, const char *name
);
422 * get_table_entry_name() scans the translation table trying to find
423 * an entry that matches the given id. If a matching entry is found,
424 * its long name is returned to the caller.
426 char *get_table_entry_name(const table_entry_t
*table
, char *msg
, int id
);
428 const char *genimg_get_os_name(uint8_t os
);
431 * genimg_get_os_short_name() - get the short name for an OS
433 * @param os OS (IH_OS_...)
434 * Return: OS short name, or "unknown" if unknown
436 const char *genimg_get_os_short_name(uint8_t comp
);
438 const char *genimg_get_arch_name(uint8_t arch
);
441 * genimg_get_arch_short_name() - get the short name for an architecture
443 * @param arch Architecture type (IH_ARCH_...)
444 * Return: architecture short name, or "unknown" if unknown
446 const char *genimg_get_arch_short_name(uint8_t arch
);
448 const char *genimg_get_type_name(uint8_t type
);
451 * genimg_get_type_short_name() - get the short name for an image type
453 * @param type Image type (IH_TYPE_...)
454 * Return: image short name, or "unknown" if unknown
456 const char *genimg_get_type_short_name(uint8_t type
);
458 const char *genimg_get_comp_name(uint8_t comp
);
461 * genimg_get_comp_short_name() - get the short name for a compression method
463 * @param comp compression method (IH_COMP_...)
464 * Return: compression method short name, or "unknown" if unknown
466 const char *genimg_get_comp_short_name(uint8_t comp
);
469 * genimg_get_cat_name() - Get the name of an item in a category
471 * @category: Category of item
473 * Return: name of item, or "Unknown ..." if unknown
475 const char *genimg_get_cat_name(enum ih_category category
, uint id
);
478 * genimg_get_cat_short_name() - Get the short name of an item in a category
480 * @category: Category of item
482 * Return: short name of item, or "Unknown ..." if unknown
484 const char *genimg_get_cat_short_name(enum ih_category category
, uint id
);
487 * genimg_get_cat_count() - Get the number of items in a category
489 * @category: Category to check
490 * Return: the number of items in the category (IH_xxx_COUNT)
492 int genimg_get_cat_count(enum ih_category category
);
495 * genimg_get_cat_desc() - Get the description of a category
497 * @category: Category to check
498 * Return: the description of a category, e.g. "architecture". This
499 * effectively converts the enum to a string.
501 const char *genimg_get_cat_desc(enum ih_category category
);
504 * genimg_cat_has_id() - Check whether a category has an item
506 * @category: Category to check
508 * Return: true or false as to whether a category has an item
510 bool genimg_cat_has_id(enum ih_category category
, uint id
);
512 int genimg_get_os_id(const char *name
);
513 int genimg_get_arch_id(const char *name
);
514 int genimg_get_type_id(const char *name
);
515 int genimg_get_comp_id(const char *name
);
516 void genimg_print_size(uint32_t size
);
518 #if defined(CONFIG_TIMESTAMP) || defined(CONFIG_CMD_DATE) || defined(USE_HOSTCC)
519 #define IMAGE_ENABLE_TIMESTAMP 1
521 #define IMAGE_ENABLE_TIMESTAMP 0
523 void genimg_print_time(time_t timestamp
);
525 /* What to do with a image load address ('load = <> 'in the FIT) */
527 FIT_LOAD_IGNORED
, /* Ignore load address */
528 FIT_LOAD_OPTIONAL
, /* Can be provided, but optional */
529 FIT_LOAD_OPTIONAL_NON_ZERO
, /* Optional, a value of 0 is ignored */
530 FIT_LOAD_REQUIRED
, /* Must be provided */
533 int boot_get_setup(struct bootm_headers
*images
, uint8_t arch
, ulong
*setup_start
,
536 /* Image format types, returned by _get_format() routine */
537 #define IMAGE_FORMAT_INVALID 0x00
538 #define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */
539 #define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */
540 #define IMAGE_FORMAT_ANDROID 0x03 /* Android boot image */
542 ulong
genimg_get_kernel_addr_fit(char * const img_addr
,
543 const char **fit_uname_config
,
544 const char **fit_uname_kernel
);
545 ulong
genimg_get_kernel_addr(char * const img_addr
);
546 int genimg_get_format(const void *img_addr
);
547 int genimg_has_config(struct bootm_headers
*images
);
549 int boot_get_fpga(int argc
, char *const argv
[], struct bootm_headers
*images
,
550 uint8_t arch
, const ulong
*ld_start
, ulong
* const ld_len
);
551 int boot_get_ramdisk(int argc
, char *const argv
[], struct bootm_headers
*images
,
552 uint8_t arch
, ulong
*rd_start
, ulong
*rd_end
);
555 * boot_get_loadable - routine to load a list of binaries to memory
556 * @argc: Ignored Argument
557 * @argv: Ignored Argument
558 * @images: pointer to the bootm images structure
559 * @arch: expected architecture for the image
560 * @ld_start: Ignored Argument
561 * @ld_len: Ignored Argument
563 * boot_get_loadable() will take the given FIT configuration, and look
564 * for a field named "loadables". Loadables, is a list of elements in
565 * the FIT given as strings. exe:
566 * loadables = "linux_kernel", "fdt-2";
567 * this function will attempt to parse each string, and load the
568 * corresponding element from the FIT into memory. Once placed,
569 * no aditional actions are taken.
572 * 0, if only valid images or no images are found
573 * error code, if an error occurs during fit_image_load
575 int boot_get_loadable(int argc
, char *const argv
[], struct bootm_headers
*images
,
576 uint8_t arch
, const ulong
*ld_start
, ulong
*const ld_len
);
578 int boot_get_setup_fit(struct bootm_headers
*images
, uint8_t arch
,
579 ulong
*setup_start
, ulong
*setup_len
);
582 * boot_get_fdt_fit() - load a DTB from a FIT file (applying overlays)
584 * This deals with all aspects of loading an DTB from a FIT.
585 * The correct base image based on configuration will be selected, and
586 * then any overlays specified will be applied (as present in fit_uname_configp).
588 * @param images Boot images structure
589 * @param addr Address of FIT in memory
590 * @param fit_unamep On entry this is the requested image name
591 * (e.g. "kernel") or NULL to use the default. On exit
592 * points to the selected image name
593 * @param fit_uname_configp On entry this is the requested configuration
594 * name (e.g. "conf-1") or NULL to use the default. On
595 * exit points to the selected configuration name.
596 * @param arch Expected architecture (IH_ARCH_...)
597 * @param datap Returns address of loaded image
598 * @param lenp Returns length of loaded image
600 * Return: node offset of base image, or -ve error code on error
602 int boot_get_fdt_fit(struct bootm_headers
*images
, ulong addr
,
603 const char **fit_unamep
, const char **fit_uname_configp
,
604 int arch
, ulong
*datap
, ulong
*lenp
);
607 * fit_image_load() - load an image from a FIT
609 * This deals with all aspects of loading an image from a FIT, including
610 * selecting the right image based on configuration, verifying it, printing
611 * out progress messages, checking the type/arch/os and optionally copying it
612 * to the right load address.
614 * The property to look up is defined by image_type.
616 * @param images Boot images structure
617 * @param addr Address of FIT in memory
618 * @param fit_unamep On entry this is the requested image name
619 * (e.g. "kernel") or NULL to use the default. On exit
620 * points to the selected image name
621 * @param fit_uname_configp On entry this is the requested configuration
622 * name (e.g. "conf-1") or NULL to use the default. On
623 * exit points to the selected configuration name.
624 * @param arch Expected architecture (IH_ARCH_...)
625 * @param image_type Required image type (IH_TYPE_...). If this is
626 * IH_TYPE_KERNEL then we allow IH_TYPE_KERNEL_NOLOAD
628 * @param bootstage_id ID of starting bootstage to use for progress updates.
629 * This will be added to the BOOTSTAGE_SUB values when
630 * calling bootstage_mark()
631 * @param load_op Decribes what to do with the load address
632 * @param datap Returns address of loaded image
633 * @param lenp Returns length of loaded image
634 * Return: node offset of image, or -ve error code on error
636 int fit_image_load(struct bootm_headers
*images
, ulong addr
,
637 const char **fit_unamep
, const char **fit_uname_configp
,
638 int arch
, int image_type
, int bootstage_id
,
639 enum fit_load_op load_op
, ulong
*datap
, ulong
*lenp
);
642 * image_source_script() - Execute a script
644 * Executes a U-Boot script at a particular address in memory. The script should
645 * have a header (FIT or legacy) with the script type (IH_TYPE_SCRIPT).
647 * @addr: Address of script
648 * @fit_uname: FIT subimage name
649 * Return: result code (enum command_ret_t)
651 int image_source_script(ulong addr
, const char *fit_uname
);
654 * fit_get_node_from_config() - Look up an image a FIT by type
656 * This looks in the selected conf- node (images->fit_uname_cfg) for a
657 * particular image type (e.g. "kernel") and then finds the image that is
660 * For example, for something like:
673 * the function will return the node offset of the kernel@1 node, assuming
674 * that conf-1 is the chosen configuration.
676 * @param images Boot images structure
677 * @param prop_name Property name to look up (FIT_..._PROP)
678 * @param addr Address of FIT in memory
680 int fit_get_node_from_config(struct bootm_headers
*images
,
681 const char *prop_name
, ulong addr
);
683 int boot_get_fdt(int flag
, int argc
, char *const argv
[], uint8_t arch
,
684 struct bootm_headers
*images
,
685 char **of_flat_tree
, ulong
*of_size
);
686 void boot_fdt_add_mem_rsv_regions(struct lmb
*lmb
, void *fdt_blob
);
687 int boot_relocate_fdt(struct lmb
*lmb
, char **of_flat_tree
, ulong
*of_size
);
689 int boot_ramdisk_high(struct lmb
*lmb
, ulong rd_data
, ulong rd_len
,
690 ulong
*initrd_start
, ulong
*initrd_end
);
691 int boot_get_cmdline(struct lmb
*lmb
, ulong
*cmd_start
, ulong
*cmd_end
);
692 int boot_get_kbd(struct lmb
*lmb
, struct bd_info
**kbd
);
694 /*******************************************************************/
695 /* Legacy format specific code (prefixed with image_) */
696 /*******************************************************************/
697 static inline uint32_t image_get_header_size(void)
699 return (sizeof(image_header_t
));
702 #define image_get_hdr_l(f) \
703 static inline uint32_t image_get_##f(const image_header_t *hdr) \
705 return uimage_to_cpu(hdr->ih_##f); \
707 image_get_hdr_l(magic
) /* image_get_magic */
708 image_get_hdr_l(hcrc
) /* image_get_hcrc */
709 image_get_hdr_l(time
) /* image_get_time */
710 image_get_hdr_l(size
) /* image_get_size */
711 image_get_hdr_l(load
) /* image_get_load */
712 image_get_hdr_l(ep
) /* image_get_ep */
713 image_get_hdr_l(dcrc
) /* image_get_dcrc */
715 #define image_get_hdr_b(f) \
716 static inline uint8_t image_get_##f(const image_header_t *hdr) \
718 return hdr->ih_##f; \
720 image_get_hdr_b(os
) /* image_get_os */
721 image_get_hdr_b(arch
) /* image_get_arch */
722 image_get_hdr_b(type
) /* image_get_type */
723 image_get_hdr_b(comp
) /* image_get_comp */
725 static inline char *image_get_name(const image_header_t
*hdr
)
727 return (char *)hdr
->ih_name
;
730 static inline uint32_t image_get_data_size(const image_header_t
*hdr
)
732 return image_get_size(hdr
);
736 * image_get_data - get image payload start address
739 * image_get_data() returns address of the image payload. For single
740 * component images it is image data start. For multi component
741 * images it points to the null terminated table of sub-images sizes.
744 * image payload data start address
746 static inline ulong
image_get_data(const image_header_t
*hdr
)
748 return ((ulong
)hdr
+ image_get_header_size());
751 static inline uint32_t image_get_image_size(const image_header_t
*hdr
)
753 return (image_get_size(hdr
) + image_get_header_size());
755 static inline ulong
image_get_image_end(const image_header_t
*hdr
)
757 return ((ulong
)hdr
+ image_get_image_size(hdr
));
760 #define image_set_hdr_l(f) \
761 static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
763 hdr->ih_##f = cpu_to_uimage(val); \
765 image_set_hdr_l(magic
) /* image_set_magic */
766 image_set_hdr_l(hcrc
) /* image_set_hcrc */
767 image_set_hdr_l(time
) /* image_set_time */
768 image_set_hdr_l(size
) /* image_set_size */
769 image_set_hdr_l(load
) /* image_set_load */
770 image_set_hdr_l(ep
) /* image_set_ep */
771 image_set_hdr_l(dcrc
) /* image_set_dcrc */
773 #define image_set_hdr_b(f) \
774 static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
778 image_set_hdr_b(os
) /* image_set_os */
779 image_set_hdr_b(arch
) /* image_set_arch */
780 image_set_hdr_b(type
) /* image_set_type */
781 image_set_hdr_b(comp
) /* image_set_comp */
783 static inline void image_set_name(image_header_t
*hdr
, const char *name
)
785 strncpy(image_get_name(hdr
), name
, IH_NMLEN
);
788 int image_check_hcrc(const image_header_t
*hdr
);
789 int image_check_dcrc(const image_header_t
*hdr
);
791 ulong
env_get_bootm_low(void);
792 phys_size_t
env_get_bootm_size(void);
793 phys_size_t
env_get_bootm_mapsize(void);
795 void memmove_wd(void *to
, void *from
, size_t len
, ulong chunksz
);
797 static inline int image_check_magic(const image_header_t
*hdr
)
799 return (image_get_magic(hdr
) == IH_MAGIC
);
801 static inline int image_check_type(const image_header_t
*hdr
, uint8_t type
)
803 return (image_get_type(hdr
) == type
);
805 static inline int image_check_arch(const image_header_t
*hdr
, uint8_t arch
)
807 /* Let's assume that sandbox can load any architecture */
808 if (!tools_build() && IS_ENABLED(CONFIG_SANDBOX
))
810 return (image_get_arch(hdr
) == arch
) ||
811 (image_get_arch(hdr
) == IH_ARCH_ARM
&& arch
== IH_ARCH_ARM64
);
813 static inline int image_check_os(const image_header_t
*hdr
, uint8_t os
)
815 return (image_get_os(hdr
) == os
);
818 ulong
image_multi_count(const image_header_t
*hdr
);
819 void image_multi_getimg(const image_header_t
*hdr
, ulong idx
,
820 ulong
*data
, ulong
*len
);
822 void image_print_contents(const void *hdr
);
825 static inline int image_check_target_arch(const image_header_t
*hdr
)
827 #ifndef IH_ARCH_DEFAULT
828 # error "please define IH_ARCH_DEFAULT in your arch asm/u-boot.h"
830 return image_check_arch(hdr
, IH_ARCH_DEFAULT
);
832 #endif /* USE_HOSTCC */
835 * image_decomp_type() - Find out compression type of an image
837 * @buf: Address in U-Boot memory where image is loaded.
838 * @len: Length of the compressed image.
839 * Return: compression type or IH_COMP_NONE if not compressed.
841 * Note: Only following compression types are supported now.
842 * lzo, lzma, gzip, bzip2
844 int image_decomp_type(const unsigned char *buf
, ulong len
);
847 * image_decomp() - decompress an image
849 * @comp: Compression algorithm that is used (IH_COMP_...)
850 * @load: Destination load address in U-Boot memory
851 * @image_start Image start address (where we are decompressing from)
852 * @type: OS type (IH_OS_...)
853 * @load_bug: Place to decompress to
854 * @image_buf: Address to decompress from
855 * @image_len: Number of bytes in @image_buf to decompress
856 * @unc_len: Available space for decompression
857 * Return: 0 if OK, -ve on error (BOOTM_ERR_...)
859 int image_decomp(int comp
, ulong load
, ulong image_start
, int type
,
860 void *load_buf
, void *image_buf
, ulong image_len
,
861 uint unc_len
, ulong
*load_end
);
864 * Set up properties in the FDT
866 * This sets up properties in the FDT that is to be passed to linux.
868 * @images: Images information
869 * @blob: FDT to update
870 * @of_size: Size of the FDT
871 * @lmb: Points to logical memory block structure
872 * Return: 0 if ok, <0 on failure
874 int image_setup_libfdt(struct bootm_headers
*images
, void *blob
,
875 int of_size
, struct lmb
*lmb
);
878 * Set up the FDT to use for booting a kernel
880 * This performs ramdisk setup, sets up the FDT if required, and adds
881 * paramters to the FDT if libfdt is available.
883 * @param images Images information
884 * Return: 0 if ok, <0 on failure
886 int image_setup_linux(struct bootm_headers
*images
);
889 * bootz_setup() - Extract stat and size of a Linux xImage
891 * @image: Address of image
892 * @start: Returns start address of image
893 * @end : Returns end address of image
894 * Return: 0 if OK, 1 if the image was not recognised
896 int bootz_setup(ulong image
, ulong
*start
, ulong
*end
);
899 * Return the correct start address and size of a Linux aarch64 Image.
901 * @image: Address of image
902 * @start: Returns start address of image
903 * @size : Returns size image
904 * @force_reloc: Ignore image->ep field, always place image to RAM start
905 * Return: 0 if OK, 1 if the image was not recognised
907 int booti_setup(ulong image
, ulong
*relocated_addr
, ulong
*size
,
910 /*******************************************************************/
911 /* New uImage format specific code (prefixed with fit_) */
912 /*******************************************************************/
914 #define FIT_IMAGES_PATH "/images"
915 #define FIT_CONFS_PATH "/configurations"
917 /* hash/signature/key node */
918 #define FIT_HASH_NODENAME "hash"
919 #define FIT_ALGO_PROP "algo"
920 #define FIT_VALUE_PROP "value"
921 #define FIT_IGNORE_PROP "uboot-ignore"
922 #define FIT_SIG_NODENAME "signature"
923 #define FIT_KEY_REQUIRED "required"
924 #define FIT_KEY_HINT "key-name-hint"
927 #define FIT_CIPHER_NODENAME "cipher"
928 #define FIT_ALGO_PROP "algo"
931 #define FIT_DATA_PROP "data"
932 #define FIT_DATA_POSITION_PROP "data-position"
933 #define FIT_DATA_OFFSET_PROP "data-offset"
934 #define FIT_DATA_SIZE_PROP "data-size"
935 #define FIT_TIMESTAMP_PROP "timestamp"
936 #define FIT_DESC_PROP "description"
937 #define FIT_ARCH_PROP "arch"
938 #define FIT_TYPE_PROP "type"
939 #define FIT_OS_PROP "os"
940 #define FIT_COMP_PROP "compression"
941 #define FIT_ENTRY_PROP "entry"
942 #define FIT_LOAD_PROP "load"
944 /* configuration node */
945 #define FIT_KERNEL_PROP "kernel"
946 #define FIT_RAMDISK_PROP "ramdisk"
947 #define FIT_FDT_PROP "fdt"
948 #define FIT_LOADABLE_PROP "loadables"
949 #define FIT_DEFAULT_PROP "default"
950 #define FIT_SETUP_PROP "setup"
951 #define FIT_FPGA_PROP "fpga"
952 #define FIT_FIRMWARE_PROP "firmware"
953 #define FIT_STANDALONE_PROP "standalone"
955 #define FIT_MAX_HASH_LEN HASH_MAX_DIGEST_SIZE
957 /* cmdline argument format parsing */
958 int fit_parse_conf(const char *spec
, ulong addr_curr
,
959 ulong
*addr
, const char **conf_name
);
960 int fit_parse_subimage(const char *spec
, ulong addr_curr
,
961 ulong
*addr
, const char **image_name
);
963 int fit_get_subimage_count(const void *fit
, int images_noffset
);
964 void fit_print_contents(const void *fit
);
965 void fit_image_print(const void *fit
, int noffset
, const char *p
);
968 * fit_get_end - get FIT image size
969 * @fit: pointer to the FIT format image header
972 * size of the FIT image (blob) in memory
974 static inline ulong
fit_get_size(const void *fit
)
976 return fdt_totalsize(fit
);
980 * fit_get_end - get FIT image end
981 * @fit: pointer to the FIT format image header
984 * end address of the FIT image (blob) in memory
986 ulong
fit_get_end(const void *fit
);
989 * fit_get_name - get FIT node name
990 * @fit: pointer to the FIT format image header
994 * pointer to node name, on success
996 static inline const char *fit_get_name(const void *fit_hdr
,
997 int noffset
, int *len
)
999 return fdt_get_name(fit_hdr
, noffset
, len
);
1002 int fit_get_desc(const void *fit
, int noffset
, char **desc
);
1003 int fit_get_timestamp(const void *fit
, int noffset
, time_t *timestamp
);
1005 int fit_image_get_node(const void *fit
, const char *image_uname
);
1006 int fit_image_get_os(const void *fit
, int noffset
, uint8_t *os
);
1007 int fit_image_get_arch(const void *fit
, int noffset
, uint8_t *arch
);
1008 int fit_image_get_type(const void *fit
, int noffset
, uint8_t *type
);
1009 int fit_image_get_comp(const void *fit
, int noffset
, uint8_t *comp
);
1010 int fit_image_get_load(const void *fit
, int noffset
, ulong
*load
);
1011 int fit_image_get_entry(const void *fit
, int noffset
, ulong
*entry
);
1012 int fit_image_get_data(const void *fit
, int noffset
,
1013 const void **data
, size_t *size
);
1014 int fit_image_get_data_offset(const void *fit
, int noffset
, int *data_offset
);
1015 int fit_image_get_data_position(const void *fit
, int noffset
,
1016 int *data_position
);
1017 int fit_image_get_data_size(const void *fit
, int noffset
, int *data_size
);
1018 int fit_image_get_data_size_unciphered(const void *fit
, int noffset
,
1020 int fit_image_get_data_and_size(const void *fit
, int noffset
,
1021 const void **data
, size_t *size
);
1024 * fit_get_data_node() - Get verified image data for an image
1025 * @fit: Pointer to the FIT format image header
1026 * @image_uname: The name of the image node
1027 * @data: A pointer which will be filled with the location of the image data
1028 * @size: A pointer which will be filled with the size of the image data
1030 * This function looks up the location and size of an image specified by its
1031 * name. For example, if you had a FIT like::
1039 * Then you could look up the data location and size of the my-firmware image
1040 * by calling this function with @image_uname set to "my-firmware". This
1041 * function also verifies the image data (if enabled) before returning. The
1042 * image description is printed out on success. @data and @size will not be
1043 * modified on faulure.
1047 * * -EINVAL if the image could not be verified
1048 * * -ENOENT if there was a problem getting the data/size
1049 * * Another negative error if there was a problem looking up the image node.
1051 int fit_get_data_node(const void *fit
, const char *image_uname
,
1052 const void **data
, size_t *size
);
1055 * fit_get_data_conf_prop() - Get verified image data for a property in /conf
1056 * @fit: Pointer to the FIT format image header
1057 * @prop_name: The name of the property in /conf referencing the image
1058 * @data: A pointer which will be filled with the location of the image data
1059 * @size: A pointer which will be filled with the size of the image data
1061 * This function looks up the location and size of an image specified by a
1062 * property in /conf. For example, if you had a FIT like::
1071 * default = "conf-1";
1073 * some-firmware = "my-firmware";
1077 * Then you could look up the data location and size of the my-firmware image
1078 * by calling this function with @prop_name set to "some-firmware". This
1079 * function also verifies the image data (if enabled) before returning. The
1080 * image description is printed out on success. @data and @size will not be
1081 * modified on faulure.
1085 * * -EINVAL if the image could not be verified
1086 * * -ENOENT if there was a problem getting the data/size
1087 * * Another negative error if there was a problem looking up the configuration
1090 int fit_get_data_conf_prop(const void *fit
, const char *prop_name
,
1091 const void **data
, size_t *size
);
1093 int fit_image_hash_get_algo(const void *fit
, int noffset
, const char **algo
);
1094 int fit_image_hash_get_value(const void *fit
, int noffset
, uint8_t **value
,
1097 int fit_set_timestamp(void *fit
, int noffset
, time_t timestamp
);
1100 * fit_pre_load_data() - add public key to fdt blob
1102 * Adds public key to the node pre load.
1104 * @keydir: Directory containing keys
1105 * @keydest: FDT blob to write public key
1106 * @fit: Pointer to the FIT format image header
1112 int fit_pre_load_data(const char *keydir
, void *keydest
, void *fit
);
1114 int fit_cipher_data(const char *keydir
, void *keydest
, void *fit
,
1115 const char *comment
, int require_keys
,
1116 const char *engine_id
, const char *cmdname
);
1118 #define NODE_MAX_NAME_LEN 80
1121 * struct image_summary - Provides information about signing info added
1123 * @sig_offset: Offset of the node in the blob devicetree where the signature
1125 * @sig_path: Path to @sig_offset
1126 * @keydest_offset: Offset of the node in the keydest devicetree where the
1127 * public key was written (-1 if none)
1128 * @keydest_path: Path to @keydest_offset
1130 struct image_summary
{
1132 char sig_path
[NODE_MAX_NAME_LEN
];
1134 char keydest_path
[NODE_MAX_NAME_LEN
];
1138 * fit_add_verification_data() - add verification data to FIT image nodes
1140 * @keydir: Directory containing keys
1141 * @kwydest: FDT blob to write public key information to (NULL if none)
1142 * @fit: Pointer to the FIT format image header
1143 * @comment: Comment to add to signature nodes
1144 * @require_keys: Mark all keys as 'required'
1145 * @engine_id: Engine to use for signing
1146 * @cmdname: Command name used when reporting errors
1147 * @algo_name: Algorithm name, or NULL if to be read from FIT
1148 * @summary: Returns information about what data was written
1150 * Adds hash values for all component images in the FIT blob.
1151 * Hashes are calculated for all component images which have hash subnodes
1152 * with algorithm property set to one of the supported hash algorithms.
1154 * Also add signatures if signature nodes are present.
1158 * libfdt error code, on failure
1160 int fit_add_verification_data(const char *keydir
, const char *keyfile
,
1161 void *keydest
, void *fit
, const char *comment
,
1162 int require_keys
, const char *engine_id
,
1163 const char *cmdname
, const char *algo_name
,
1164 struct image_summary
*summary
);
1167 * fit_image_verify_with_data() - Verify an image with given data
1169 * @fit: Pointer to the FIT format image header
1170 * @image_offset: Offset in @fit of image to verify
1171 * @key_blob: FDT containing public keys
1172 * @data: Image data to verify
1173 * @size: Size of image data
1175 int fit_image_verify_with_data(const void *fit
, int image_noffset
,
1176 const void *key_blob
, const void *data
,
1179 int fit_image_verify(const void *fit
, int noffset
);
1180 int fit_config_verify(const void *fit
, int conf_noffset
);
1181 int fit_all_image_verify(const void *fit
);
1182 int fit_config_decrypt(const void *fit
, int conf_noffset
);
1183 int fit_image_check_os(const void *fit
, int noffset
, uint8_t os
);
1184 int fit_image_check_arch(const void *fit
, int noffset
, uint8_t arch
);
1185 int fit_image_check_type(const void *fit
, int noffset
, uint8_t type
);
1186 int fit_image_check_comp(const void *fit
, int noffset
, uint8_t comp
);
1189 * fit_check_format() - Check that the FIT is valid
1191 * This performs various checks on the FIT to make sure it is suitable for
1192 * use, looking for mandatory properties, nodes, etc.
1194 * If FIT_FULL_CHECK is enabled, it also runs it through libfdt to make
1195 * sure that there are no strange tags or broken nodes in the FIT.
1197 * @fit: pointer to the FIT format image header
1198 * Return: 0 if OK, -ENOEXEC if not an FDT file, -EINVAL if the full FDT check
1199 * failed (e.g. due to bad structure), -ENOMSG if the description is
1200 * missing, -EBADMSG if the timestamp is missing, -ENOENT if the /images
1203 int fit_check_format(const void *fit
, ulong size
);
1205 int fit_conf_find_compat(const void *fit
, const void *fdt
);
1208 * fit_conf_get_node - get node offset for configuration of a given unit name
1209 * @fit: pointer to the FIT format image header
1210 * @conf_uname: configuration node unit name (NULL to use default)
1212 * fit_conf_get_node() finds a configuration (within the '/configurations'
1213 * parent node) of a provided unit name. If configuration is found its node
1214 * offset is returned to the caller.
1216 * When NULL is provided in second argument fit_conf_get_node() will search
1217 * for a default configuration node instead. Default configuration node unit
1218 * name is retrieved from FIT_DEFAULT_PROP property of the '/configurations'
1222 * configuration node offset when found (>=0)
1223 * negative number on failure (FDT_ERR_* code)
1225 int fit_conf_get_node(const void *fit
, const char *conf_uname
);
1227 int fit_conf_get_prop_node_count(const void *fit
, int noffset
,
1228 const char *prop_name
);
1229 int fit_conf_get_prop_node_index(const void *fit
, int noffset
,
1230 const char *prop_name
, int index
);
1233 * fit_conf_get_prop_node() - Get node refered to by a configuration
1234 * @fit: FIT to check
1235 * @noffset: Offset of conf@xxx node to check
1236 * @prop_name: Property to read from the conf node
1238 * The conf- nodes contain references to other nodes, using properties
1239 * like 'kernel = "kernel"'. Given such a property name (e.g. "kernel"),
1240 * return the offset of the node referred to (e.g. offset of node
1243 int fit_conf_get_prop_node(const void *fit
, int noffset
,
1244 const char *prop_name
);
1246 int fit_check_ramdisk(const void *fit
, int os_noffset
,
1247 uint8_t arch
, int verify
);
1249 int calculate_hash(const void *data
, int data_len
, const char *algo
,
1250 uint8_t *value
, int *value_len
);
1253 * At present we only support signing on the host, and verification on the
1256 #if defined(USE_HOSTCC)
1257 # if defined(CONFIG_FIT_SIGNATURE)
1258 # define IMAGE_ENABLE_SIGN 1
1259 # define FIT_IMAGE_ENABLE_VERIFY 1
1260 # include <openssl/evp.h>
1262 # define IMAGE_ENABLE_SIGN 0
1263 # define FIT_IMAGE_ENABLE_VERIFY 0
1266 # define IMAGE_ENABLE_SIGN 0
1267 # define FIT_IMAGE_ENABLE_VERIFY CONFIG_IS_ENABLED(FIT_SIGNATURE)
1271 void *image_get_host_blob(void);
1272 void image_set_host_blob(void *host_blob
);
1273 # define gd_fdt_blob() image_get_host_blob()
1275 # define gd_fdt_blob() (gd->fdt_blob)
1279 * Information passed to the signing routines
1281 * Either 'keydir', 'keyname', or 'keyfile' can be NULL. However, either
1282 * 'keyfile', or both 'keydir' and 'keyname' should have valid values. If
1283 * neither are valid, some operations might fail with EINVAL.
1285 struct image_sign_info
{
1286 const char *keydir
; /* Directory conaining keys */
1287 const char *keyname
; /* Name of key to use */
1288 const char *keyfile
; /* Filename of private or public key */
1289 const void *fit
; /* Pointer to FIT blob */
1290 int node_offset
; /* Offset of signature node */
1291 const char *name
; /* Algorithm name */
1292 struct checksum_algo
*checksum
; /* Checksum algorithm information */
1293 struct padding_algo
*padding
; /* Padding algorithm information */
1294 struct crypto_algo
*crypto
; /* Crypto algorithm information */
1295 const void *fdt_blob
; /* FDT containing public keys */
1296 int required_keynode
; /* Node offset of key to use: -1=any */
1297 const char *require_keys
; /* Value for 'required' property */
1298 const char *engine_id
; /* Engine to use for signing */
1300 * Note: the following two fields are always valid even w/o
1301 * RSA_VERIFY_WITH_PKEY in order to make sure this structure is
1302 * the same on target and host. Otherwise, vboot test may fail.
1304 const void *key
; /* Pointer to public key in DER */
1305 int keylen
; /* Length of public key */
1308 /* A part of an image, used for hashing */
1309 struct image_region
{
1314 struct checksum_algo
{
1316 const int checksum_len
;
1318 const uint8_t *der_prefix
;
1319 #if IMAGE_ENABLE_SIGN
1320 const EVP_MD
*(*calculate_sign
)(void);
1322 int (*calculate
)(const char *name
,
1323 const struct image_region
*region
,
1324 int region_count
, uint8_t *checksum
);
1327 struct crypto_algo
{
1328 const char *name
; /* Name of algorithm */
1332 * sign() - calculate and return signature for given input data
1334 * @info: Specifies key and FIT information
1335 * @data: Pointer to the input data
1336 * @data_len: Data length
1337 * @sigp: Set to an allocated buffer holding the signature
1338 * @sig_len: Set to length of the calculated hash
1340 * This computes input data signature according to selected algorithm.
1341 * Resulting signature value is placed in an allocated buffer, the
1342 * pointer is returned as *sigp. The length of the calculated
1343 * signature is returned via the sig_len pointer argument. The caller
1344 * should free *sigp.
1346 * @return: 0, on success, -ve on error
1348 int (*sign
)(struct image_sign_info
*info
,
1349 const struct image_region region
[],
1350 int region_count
, uint8_t **sigp
, uint
*sig_len
);
1353 * add_verify_data() - Add verification information to FDT
1355 * Add public key information to the FDT node, suitable for
1356 * verification at run-time. The information added depends on the
1357 * algorithm being used.
1359 * @info: Specifies key and FIT information
1360 * @keydest: Destination FDT blob for public key data
1361 * @return: node offset within the FDT blob where the data was written,
1364 int (*add_verify_data
)(struct image_sign_info
*info
, void *keydest
);
1367 * verify() - Verify a signature against some data
1369 * @info: Specifies key and FIT information
1370 * @data: Pointer to the input data
1371 * @data_len: Data length
1373 * @sig_len: Number of bytes in signature
1374 * @return 0 if verified, -ve on error
1376 int (*verify
)(struct image_sign_info
*info
,
1377 const struct image_region region
[], int region_count
,
1378 uint8_t *sig
, uint sig_len
);
1381 /* Declare a new U-Boot crypto algorithm handler */
1382 #define U_BOOT_CRYPTO_ALGO(__name) \
1383 ll_entry_declare(struct crypto_algo, __name, cryptos)
1385 struct padding_algo
{
1387 int (*verify
)(struct image_sign_info
*info
,
1388 const uint8_t *pad
, int pad_len
,
1389 const uint8_t *hash
, int hash_len
);
1392 /* Declare a new U-Boot padding algorithm handler */
1393 #define U_BOOT_PADDING_ALGO(__name) \
1394 ll_entry_declare(struct padding_algo, __name, paddings)
1397 * image_get_checksum_algo() - Look up a checksum algorithm
1399 * @param full_name Name of algorithm in the form "checksum,crypto"
1400 * Return: pointer to algorithm information, or NULL if not found
1402 struct checksum_algo
*image_get_checksum_algo(const char *full_name
);
1405 * image_get_crypto_algo() - Look up a cryptosystem algorithm
1407 * @param full_name Name of algorithm in the form "checksum,crypto"
1408 * Return: pointer to algorithm information, or NULL if not found
1410 struct crypto_algo
*image_get_crypto_algo(const char *full_name
);
1413 * image_get_padding_algo() - Look up a padding algorithm
1415 * @param name Name of padding algorithm
1416 * Return: pointer to algorithm information, or NULL if not found
1418 struct padding_algo
*image_get_padding_algo(const char *name
);
1421 * image_pre_load() - Manage pre load header
1423 * Manage the pre-load header before launching the image.
1424 * It checks the signature of the image. It also set the
1425 * variable image_load_offset to skip this header before
1426 * launching the image.
1428 * @param addr Address of the image
1429 * @return: 0 on success, -ve on error
1431 int image_pre_load(ulong addr
);
1434 * fit_image_verify_required_sigs() - Verify signatures marked as 'required'
1436 * @fit: FIT to check
1437 * @image_noffset: Offset of image node to check
1438 * @data: Image data to check
1439 * @size: Size of image data
1440 * @key_blob: FDT containing public keys
1441 * @no_sigsp: Returns 1 if no signatures were required, and
1442 * therefore nothing was checked. The caller may wish
1443 * to fall back to other mechanisms, or refuse to
1445 * Return: 0 if all verified ok, <0 on error
1447 int fit_image_verify_required_sigs(const void *fit
, int image_noffset
,
1448 const char *data
, size_t size
, const void *key_blob
,
1452 * fit_image_check_sig() - Check a single image signature node
1454 * @fit: FIT to check
1455 * @noffset: Offset of signature node to check
1456 * @data: Image data to check
1457 * @size: Size of image data
1458 * @keyblob: Key blob to check (typically the control FDT)
1459 * @required_keynode: Offset in the keyblob of the required key node,
1460 * if any. If this is given, then the image wil not
1461 * pass verification unless that key is used. If this is
1462 * -1 then any signature will do.
1463 * @err_msgp: In the event of an error, this will be pointed to a
1464 * help error string to display to the user.
1465 * Return: 0 if all verified ok, <0 on error
1467 int fit_image_check_sig(const void *fit
, int noffset
, const void *data
,
1468 size_t size
, const void *key_blob
, int required_keynode
,
1471 int fit_image_decrypt_data(const void *fit
,
1472 int image_noffset
, int cipher_noffset
,
1473 const void *data
, size_t size
,
1474 void **data_unciphered
, size_t *size_unciphered
);
1477 * fit_region_make_list() - Make a list of regions to hash
1479 * Given a list of FIT regions (offset, size) provided by libfdt, create
1480 * a list of regions (void *, size) for use by the signature creationg
1481 * and verification code.
1483 * @fit: FIT image to process
1484 * @fdt_regions: Regions as returned by libfdt
1485 * @count: Number of regions returned by libfdt
1486 * @region: Place to put list of regions (NULL to allocate it)
1487 * Return: pointer to list of regions, or NULL if out of memory
1489 struct image_region
*fit_region_make_list(const void *fit
,
1490 struct fdt_region
*fdt_regions
, int count
,
1491 struct image_region
*region
);
1493 static inline int fit_image_check_target_arch(const void *fdt
, int node
)
1496 return fit_image_check_arch(fdt
, node
, IH_ARCH_DEFAULT
);
1503 * At present we only support ciphering on the host, and unciphering on the
1506 #if defined(USE_HOSTCC)
1507 # if defined(CONFIG_FIT_CIPHER)
1508 # define IMAGE_ENABLE_ENCRYPT 1
1509 # define IMAGE_ENABLE_DECRYPT 1
1510 # include <openssl/evp.h>
1512 # define IMAGE_ENABLE_ENCRYPT 0
1513 # define IMAGE_ENABLE_DECRYPT 0
1516 # define IMAGE_ENABLE_ENCRYPT 0
1517 # define IMAGE_ENABLE_DECRYPT CONFIG_IS_ENABLED(FIT_CIPHER)
1520 /* Information passed to the ciphering routines */
1521 struct image_cipher_info
{
1522 const char *keydir
; /* Directory containing keys */
1523 const char *keyname
; /* Name of key to use */
1524 const char *ivname
; /* Name of IV to use */
1525 const void *fit
; /* Pointer to FIT blob */
1526 int node_noffset
; /* Offset of the cipher node */
1527 const char *name
; /* Algorithm name */
1528 struct cipher_algo
*cipher
; /* Cipher algorithm information */
1529 const void *fdt_blob
; /* FDT containing key and IV */
1530 const void *key
; /* Value of the key */
1531 const void *iv
; /* Value of the IV */
1532 size_t size_unciphered
; /* Size of the unciphered data */
1535 struct cipher_algo
{
1536 const char *name
; /* Name of algorithm */
1537 int key_len
; /* Length of the key */
1538 int iv_len
; /* Length of the IV */
1540 #if IMAGE_ENABLE_ENCRYPT
1541 const EVP_CIPHER
* (*calculate_type
)(void);
1544 int (*encrypt
)(struct image_cipher_info
*info
,
1545 const unsigned char *data
, int data_len
,
1546 unsigned char **cipher
, int *cipher_len
);
1548 int (*add_cipher_data
)(struct image_cipher_info
*info
,
1549 void *keydest
, void *fit
, int node_noffset
);
1551 int (*decrypt
)(struct image_cipher_info
*info
,
1552 const void *cipher
, size_t cipher_len
,
1553 void **data
, size_t *data_len
);
1556 int fit_image_cipher_get_algo(const void *fit
, int noffset
, char **algo
);
1558 struct cipher_algo
*image_get_cipher_algo(const char *full_name
);
1560 struct andr_img_hdr
;
1561 int android_image_check_header(const struct andr_img_hdr
*hdr
);
1562 int android_image_get_kernel(const struct andr_img_hdr
*hdr
, int verify
,
1563 ulong
*os_data
, ulong
*os_len
);
1564 int android_image_get_ramdisk(const struct andr_img_hdr
*hdr
,
1565 ulong
*rd_data
, ulong
*rd_len
);
1566 int android_image_get_second(const struct andr_img_hdr
*hdr
,
1567 ulong
*second_data
, ulong
*second_len
);
1568 bool android_image_get_dtbo(ulong hdr_addr
, ulong
*addr
, u32
*size
);
1569 bool android_image_get_dtb_by_index(ulong hdr_addr
, u32 index
, ulong
*addr
,
1571 ulong
android_image_get_end(const struct andr_img_hdr
*hdr
);
1572 ulong
android_image_get_kload(const struct andr_img_hdr
*hdr
);
1573 ulong
android_image_get_kcomp(const struct andr_img_hdr
*hdr
);
1574 void android_print_contents(const struct andr_img_hdr
*hdr
);
1575 bool android_image_print_dtb_contents(ulong hdr_addr
);
1578 * board_fit_config_name_match() - Check for a matching board name
1580 * This is used when SPL loads a FIT containing multiple device tree files
1581 * and wants to work out which one to use. The description of each one is
1582 * passed to this function. The description comes from the 'description' field
1583 * in each (FDT) image node.
1585 * @name: Device tree description
1586 * Return: 0 if this device tree should be used, non-zero to try the next
1588 int board_fit_config_name_match(const char *name
);
1591 * board_fit_image_post_process() - Do any post-process on FIT binary data
1593 * This is used to do any sort of image manipulation, verification, decryption
1594 * etc. in a platform or board specific way. Obviously, anything done here would
1595 * need to be comprehended in how the images were prepared before being injected
1596 * into the FIT creation (i.e. the binary blobs would have been pre-processed
1597 * before being added to the FIT image).
1599 * @fit: pointer to fit image
1600 * @node: offset of image node
1601 * @image: pointer to the image start pointer
1602 * @size: pointer to the image size
1603 * Return: no return value (failure should be handled internally)
1605 void board_fit_image_post_process(const void *fit
, int node
, void **p_image
,
1608 #define FDT_ERROR ((ulong)(-1))
1610 ulong
fdt_getprop_u32(const void *fdt
, int node
, const char *prop
);
1613 * fit_find_config_node() - Find the node for the best DTB in a FIT image
1615 * A FIT image contains one or more DTBs. This function parses the
1616 * configurations described in the FIT images and returns the node of
1617 * the first matching DTB. To check if a DTB matches a board, this function
1618 * calls board_fit_config_name_match(). If no matching DTB is found, it returns
1619 * the node described by the default configuration if it exists.
1621 * @fdt: pointer to flat device tree
1622 * Return: the node if found, -ve otherwise
1624 int fit_find_config_node(const void *fdt
);
1627 * Mapping of image types to function handlers to be invoked on the associated
1630 * @type: Type of image, I.E. IH_TYPE_*
1631 * @handler: Function to call on loaded image
1633 struct fit_loadable_tbl
{
1636 * handler() - Process a loaded image
1638 * @data: Pointer to start of loaded image data
1639 * @size: Size of loaded image data
1641 void (*handler
)(ulong data
, size_t size
);
1645 * Define a FIT loadable image type handler
1647 * _type is a valid uimage_type ID as defined in the "Image Type" enum above
1648 * _handler is the handler function to call after this image type is loaded
1650 #define U_BOOT_FIT_LOADABLE_HANDLER(_type, _handler) \
1651 ll_entry_declare(struct fit_loadable_tbl, _function, fit_loadable) = { \
1653 .handler = _handler, \
1657 * fit_update - update storage with FIT image
1658 * @fit: Pointer to FIT image
1660 * Update firmware on storage using FIT image as input.
1661 * The storage area to be update will be identified by the name
1662 * in FIT and matching it to "dfu_alt_info" variable.
1664 * Return: 0 on success, non-zero otherwise
1666 int fit_update(const void *fit
);
1668 #endif /* __IMAGE_H__ */