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>
29 /* new uImage format support enabled on host */
30 #define IMAGE_ENABLE_FIT 1
31 #define IMAGE_ENABLE_OF_LIBFDT 1
32 #define CONFIG_FIT_VERBOSE 1 /* enable fit_format_{error,warning}() */
33 #define CONFIG_FIT_ENABLE_RSASSA_PSS_SUPPORT 1
34 #define CONFIG_FIT_ENABLE_SHA256_SUPPORT
38 #define IMAGE_ENABLE_IGNORE 0
39 #define IMAGE_INDENT_STRING ""
44 #include <asm/u-boot.h>
47 /* Take notice of the 'ignore' property for hashes */
48 #define IMAGE_ENABLE_IGNORE 1
49 #define IMAGE_INDENT_STRING " "
51 #define IMAGE_ENABLE_FIT CONFIG_IS_ENABLED(FIT)
52 #define IMAGE_ENABLE_OF_LIBFDT CONFIG_IS_ENABLED(OF_LIBFDT)
54 #endif /* USE_HOSTCC */
58 #include <linux/libfdt.h>
59 #include <fdt_support.h>
60 # ifdef CONFIG_SPL_BUILD
61 # ifdef CONFIG_SPL_CRC32_SUPPORT
62 # define IMAGE_ENABLE_CRC32 1
64 # ifdef CONFIG_SPL_MD5_SUPPORT
65 # define IMAGE_ENABLE_MD5 1
67 # ifdef CONFIG_SPL_SHA1_SUPPORT
68 # define IMAGE_ENABLE_SHA1 1
71 # define IMAGE_ENABLE_CRC32 1
72 # define IMAGE_ENABLE_MD5 1
73 # define IMAGE_ENABLE_SHA1 1
76 #ifndef IMAGE_ENABLE_CRC32
77 #define IMAGE_ENABLE_CRC32 0
80 #ifndef IMAGE_ENABLE_MD5
81 #define IMAGE_ENABLE_MD5 0
84 #ifndef IMAGE_ENABLE_SHA1
85 #define IMAGE_ENABLE_SHA1 0
88 #if defined(CONFIG_FIT_ENABLE_SHA256_SUPPORT) || \
89 defined(CONFIG_SPL_SHA256_SUPPORT)
90 #define IMAGE_ENABLE_SHA256 1
92 #define IMAGE_ENABLE_SHA256 0
95 #endif /* IMAGE_ENABLE_FIT */
97 #ifdef CONFIG_SYS_BOOT_GET_CMDLINE
98 # define IMAGE_BOOT_GET_CMDLINE 1
100 # define IMAGE_BOOT_GET_CMDLINE 0
103 #ifdef CONFIG_OF_BOARD_SETUP
104 # define IMAGE_OF_BOARD_SETUP 1
106 # define IMAGE_OF_BOARD_SETUP 0
109 #ifdef CONFIG_OF_SYSTEM_SETUP
110 # define IMAGE_OF_SYSTEM_SETUP 1
112 # define IMAGE_OF_SYSTEM_SETUP 0
125 * Operating System Codes
127 * The following are exposed to uImage header.
128 * New IDs *MUST* be appended at the end of the list and *NEVER*
129 * inserted for backward compatibility.
132 IH_OS_INVALID = 0, /* Invalid OS */
133 IH_OS_OPENBSD, /* OpenBSD */
134 IH_OS_NETBSD, /* NetBSD */
135 IH_OS_FREEBSD, /* FreeBSD */
136 IH_OS_4_4BSD, /* 4.4BSD */
137 IH_OS_LINUX, /* Linux */
138 IH_OS_SVR4, /* SVR4 */
139 IH_OS_ESIX, /* Esix */
140 IH_OS_SOLARIS, /* Solaris */
141 IH_OS_IRIX, /* Irix */
143 IH_OS_DELL, /* Dell */
145 IH_OS_LYNXOS, /* LynxOS */
146 IH_OS_VXWORKS, /* VxWorks */
147 IH_OS_PSOS, /* pSOS */
149 IH_OS_U_BOOT, /* Firmware */
150 IH_OS_RTEMS, /* RTEMS */
151 IH_OS_ARTOS, /* ARTOS */
152 IH_OS_UNITY, /* Unity OS */
153 IH_OS_INTEGRITY, /* INTEGRITY */
155 IH_OS_PLAN9, /* Plan 9 */
156 IH_OS_OPENRTOS, /* OpenRTOS */
157 IH_OS_ARM_TRUSTED_FIRMWARE, /* ARM Trusted Firmware */
158 IH_OS_TEE, /* Trusted Execution Environment */
159 IH_OS_OPENSBI, /* RISC-V OpenSBI */
160 IH_OS_EFI, /* EFI Firmware (e.g. GRUB2) */
166 * CPU Architecture Codes (supported by Linux)
168 * The following are exposed to uImage header.
169 * New IDs *MUST* be appended at the end of the list and *NEVER*
170 * inserted for backward compatibility.
173 IH_ARCH_INVALID = 0, /* Invalid CPU */
174 IH_ARCH_ALPHA, /* Alpha */
175 IH_ARCH_ARM, /* ARM */
176 IH_ARCH_I386, /* Intel x86 */
177 IH_ARCH_IA64, /* IA64 */
178 IH_ARCH_MIPS, /* MIPS */
179 IH_ARCH_MIPS64, /* MIPS 64 Bit */
180 IH_ARCH_PPC, /* PowerPC */
181 IH_ARCH_S390, /* IBM S390 */
182 IH_ARCH_SH, /* SuperH */
183 IH_ARCH_SPARC, /* Sparc */
184 IH_ARCH_SPARC64, /* Sparc 64 Bit */
185 IH_ARCH_M68K, /* M68K */
186 IH_ARCH_NIOS, /* Nios-32 */
187 IH_ARCH_MICROBLAZE, /* MicroBlaze */
188 IH_ARCH_NIOS2, /* Nios-II */
189 IH_ARCH_BLACKFIN, /* Blackfin */
190 IH_ARCH_AVR32, /* AVR32 */
191 IH_ARCH_ST200, /* STMicroelectronics ST200 */
192 IH_ARCH_SANDBOX, /* Sandbox architecture (test only) */
193 IH_ARCH_NDS32, /* ANDES Technology - NDS32 */
194 IH_ARCH_OPENRISC, /* OpenRISC 1000 */
195 IH_ARCH_ARM64, /* ARM64 */
196 IH_ARCH_ARC, /* Synopsys DesignWare ARC */
197 IH_ARCH_X86_64, /* AMD x86_64, Intel and Via */
198 IH_ARCH_XTENSA, /* Xtensa */
199 IH_ARCH_RISCV, /* RISC-V */
207 * "Standalone Programs" are directly runnable in the environment
208 * provided by U-Boot; it is expected that (if they behave
209 * well) you can continue to work in U-Boot after return from
210 * the Standalone Program.
211 * "OS Kernel Images" are usually images of some Embedded OS which
212 * will take over control completely. Usually these programs
213 * will install their own set of exception handlers, device
214 * drivers, set up the MMU, etc. - this means, that you cannot
215 * expect to re-enter U-Boot except by resetting the CPU.
216 * "RAMDisk Images" are more or less just data blocks, and their
217 * parameters (address, size) are passed to an OS kernel that is
219 * "Multi-File Images" contain several images, typically an OS
220 * (Linux) kernel image and one or more data images like
221 * RAMDisks. This construct is useful for instance when you want
222 * to boot over the network using BOOTP etc., where the boot
223 * server provides just a single image file, but you want to get
224 * for instance an OS kernel and a RAMDisk image.
226 * "Multi-File Images" start with a list of image sizes, each
227 * image size (in bytes) specified by an "uint32_t" in network
228 * byte order. This list is terminated by an "(uint32_t)0".
229 * Immediately after the terminating 0 follow the images, one by
230 * one, all aligned on "uint32_t" boundaries (size rounded up to
231 * a multiple of 4 bytes - except for the last file).
233 * "Firmware Images" are binary images containing firmware (like
234 * U-Boot or FPGA images) which usually will be programmed to
237 * "Script files" are command sequences that will be executed by
238 * U-Boot's command interpreter; this feature is especially
239 * useful when you configure U-Boot to use a real shell (hush)
240 * as command interpreter (=> Shell Scripts).
242 * The following are exposed to uImage header.
243 * New IDs *MUST* be appended at the end of the list and *NEVER*
244 * inserted for backward compatibility.
248 IH_TYPE_INVALID = 0, /* Invalid Image */
249 IH_TYPE_STANDALONE, /* Standalone Program */
250 IH_TYPE_KERNEL, /* OS Kernel Image */
251 IH_TYPE_RAMDISK, /* RAMDisk Image */
252 IH_TYPE_MULTI, /* Multi-File Image */
253 IH_TYPE_FIRMWARE, /* Firmware Image */
254 IH_TYPE_SCRIPT, /* Script file */
255 IH_TYPE_FILESYSTEM, /* Filesystem Image (any type) */
256 IH_TYPE_FLATDT, /* Binary Flat Device Tree Blob */
257 IH_TYPE_KWBIMAGE, /* Kirkwood Boot Image */
258 IH_TYPE_IMXIMAGE, /* Freescale IMXBoot Image */
259 IH_TYPE_UBLIMAGE, /* Davinci UBL Image */
260 IH_TYPE_OMAPIMAGE, /* TI OMAP Config Header Image */
261 IH_TYPE_AISIMAGE, /* TI Davinci AIS Image */
262 /* OS Kernel Image, can run from any load address */
263 IH_TYPE_KERNEL_NOLOAD,
264 IH_TYPE_PBLIMAGE, /* Freescale PBL Boot Image */
265 IH_TYPE_MXSIMAGE, /* Freescale MXSBoot Image */
266 IH_TYPE_GPIMAGE, /* TI Keystone GPHeader Image */
267 IH_TYPE_ATMELIMAGE, /* ATMEL ROM bootable Image */
268 IH_TYPE_SOCFPGAIMAGE, /* Altera SOCFPGA CV/AV Preloader */
269 IH_TYPE_X86_SETUP, /* x86 setup.bin Image */
270 IH_TYPE_LPC32XXIMAGE, /* x86 setup.bin Image */
271 IH_TYPE_LOADABLE, /* A list of typeless images */
272 IH_TYPE_RKIMAGE, /* Rockchip Boot Image */
273 IH_TYPE_RKSD, /* Rockchip SD card */
274 IH_TYPE_RKSPI, /* Rockchip SPI image */
275 IH_TYPE_ZYNQIMAGE, /* Xilinx Zynq Boot Image */
276 IH_TYPE_ZYNQMPIMAGE, /* Xilinx ZynqMP Boot Image */
277 IH_TYPE_ZYNQMPBIF, /* Xilinx ZynqMP Boot Image (bif) */
278 IH_TYPE_FPGA, /* FPGA Image */
279 IH_TYPE_VYBRIDIMAGE, /* VYBRID .vyb Image */
280 IH_TYPE_TEE, /* Trusted Execution Environment OS Image */
281 IH_TYPE_FIRMWARE_IVT, /* Firmware Image with HABv4 IVT */
282 IH_TYPE_PMMC, /* TI Power Management Micro-Controller Firmware */
283 IH_TYPE_STM32IMAGE, /* STMicroelectronics STM32 Image */
284 IH_TYPE_SOCFPGAIMAGE_V1, /* Altera SOCFPGA A10 Preloader */
285 IH_TYPE_MTKIMAGE, /* MediaTek BootROM loadable Image */
286 IH_TYPE_IMX8MIMAGE, /* Freescale IMX8MBoot Image */
287 IH_TYPE_IMX8IMAGE, /* Freescale IMX8Boot Image */
288 IH_TYPE_COPRO, /* Coprocessor Image for remoteproc*/
290 IH_TYPE_COUNT, /* Number of image types */
296 * The following are exposed to uImage header.
297 * New IDs *MUST* be appended at the end of the list and *NEVER*
298 * inserted for backward compatibility.
301 IH_COMP_NONE = 0, /* No Compression Used */
302 IH_COMP_GZIP, /* gzip Compression Used */
303 IH_COMP_BZIP2, /* bzip2 Compression Used */
304 IH_COMP_LZMA, /* lzma Compression Used */
305 IH_COMP_LZO, /* lzo Compression Used */
306 IH_COMP_LZ4, /* lz4 Compression Used */
311 #define LZ4F_MAGIC 0x184D2204 /* LZ4 Magic Number */
312 #define IH_MAGIC 0x27051956 /* Image Magic Number */
313 #define IH_NMLEN 32 /* Image Name Length */
315 /* Reused from common.h */
316 #define ROUND(a, b) (((a) + (b) - 1) & ~((b) - 1))
319 * Legacy format image header,
320 * all data in network byte order (aka natural aka bigendian).
322 typedef struct image_header {
323 uint32_t ih_magic; /* Image Header Magic Number */
324 uint32_t ih_hcrc; /* Image Header CRC Checksum */
325 uint32_t ih_time; /* Image Creation Timestamp */
326 uint32_t ih_size; /* Image Data Size */
327 uint32_t ih_load; /* Data Load Address */
328 uint32_t ih_ep; /* Entry Point Address */
329 uint32_t ih_dcrc; /* Image Data CRC Checksum */
330 uint8_t ih_os; /* Operating System */
331 uint8_t ih_arch; /* CPU architecture */
332 uint8_t ih_type; /* Image Type */
333 uint8_t ih_comp; /* Compression Type */
334 uint8_t ih_name[IH_NMLEN]; /* Image Name */
337 typedef struct image_info {
338 ulong start, end; /* start/end of blob */
339 ulong image_start, image_len; /* start of image within blob, len of image */
340 ulong load; /* load addr for the image */
341 uint8_t comp, type, os; /* compression, type of image, os type */
342 uint8_t arch; /* CPU architecture */
346 * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
349 typedef struct bootm_headers {
351 * Legacy os image header, if it is a multi component image
352 * then boot_get_ramdisk() and get_fdt() will attempt to get
353 * data from second and third component accordingly.
355 image_header_t *legacy_hdr_os; /* image header pointer */
356 image_header_t legacy_hdr_os_copy; /* header copy */
357 ulong legacy_hdr_valid;
360 const char *fit_uname_cfg; /* configuration node unit name */
362 void *fit_hdr_os; /* os FIT image header */
363 const char *fit_uname_os; /* os subimage node unit name */
364 int fit_noffset_os; /* os subimage node offset */
366 void *fit_hdr_rd; /* init ramdisk FIT image header */
367 const char *fit_uname_rd; /* init ramdisk subimage node unit name */
368 int fit_noffset_rd; /* init ramdisk subimage node offset */
370 void *fit_hdr_fdt; /* FDT blob FIT image header */
371 const char *fit_uname_fdt; /* FDT blob subimage node unit name */
372 int fit_noffset_fdt;/* FDT blob subimage node offset */
374 void *fit_hdr_setup; /* x86 setup FIT image header */
375 const char *fit_uname_setup; /* x86 setup subimage node name */
376 int fit_noffset_setup;/* x86 setup subimage node offset */
380 image_info_t os; /* os image info */
381 ulong ep; /* entry point of OS */
383 ulong rd_start, rd_end;/* ramdisk start/end */
385 char *ft_addr; /* flat dev tree address */
386 ulong ft_len; /* length of flat device tree */
395 int verify; /* env_get("verify")[0] != 'n' */
397 #define BOOTM_STATE_START (0x00000001)
398 #define BOOTM_STATE_FINDOS (0x00000002)
399 #define BOOTM_STATE_FINDOTHER (0x00000004)
400 #define BOOTM_STATE_LOADOS (0x00000008)
401 #define BOOTM_STATE_RAMDISK (0x00000010)
402 #define BOOTM_STATE_FDT (0x00000020)
403 #define BOOTM_STATE_OS_CMDLINE (0x00000040)
404 #define BOOTM_STATE_OS_BD_T (0x00000080)
405 #define BOOTM_STATE_OS_PREP (0x00000100)
406 #define BOOTM_STATE_OS_FAKE_GO (0x00000200) /* 'Almost' run the OS */
407 #define BOOTM_STATE_OS_GO (0x00000400)
411 struct lmb lmb; /* for memory mgmt */
415 extern bootm_headers_t images;
418 * Some systems (for example LWMON) have very short watchdog periods;
419 * we must make sure to split long operations like memmove() or
420 * checksum calculations into reasonable chunks.
423 #define CHUNKSZ (64 * 1024)
426 #ifndef CHUNKSZ_CRC32
427 #define CHUNKSZ_CRC32 (64 * 1024)
431 #define CHUNKSZ_MD5 (64 * 1024)
435 #define CHUNKSZ_SHA1 (64 * 1024)
438 #define uimage_to_cpu(x) be32_to_cpu(x)
439 #define cpu_to_uimage(x) cpu_to_be32(x)
442 * Translation table for entries of a specific type; used by
443 * get_table_entry_id() and get_table_entry_name().
445 typedef struct table_entry {
447 char *sname; /* short (input) name to find table entry */
448 char *lname; /* long (output) name to print for messages */
452 * get_table_entry_id() scans the translation table trying to find an
453 * entry that matches the given short name. If a matching entry is
454 * found, it's id is returned to the caller.
456 int get_table_entry_id(const table_entry_t *table,
457 const char *table_name, const char *name);
459 * get_table_entry_name() scans the translation table trying to find
460 * an entry that matches the given id. If a matching entry is found,
461 * its long name is returned to the caller.
463 char *get_table_entry_name(const table_entry_t *table, char *msg, int id);
465 const char *genimg_get_os_name(uint8_t os);
468 * genimg_get_os_short_name() - get the short name for an OS
470 * @param os OS (IH_OS_...)
471 * @return OS short name, or "unknown" if unknown
473 const char *genimg_get_os_short_name(uint8_t comp);
475 const char *genimg_get_arch_name(uint8_t arch);
478 * genimg_get_arch_short_name() - get the short name for an architecture
480 * @param arch Architecture type (IH_ARCH_...)
481 * @return architecture short name, or "unknown" if unknown
483 const char *genimg_get_arch_short_name(uint8_t arch);
485 const char *genimg_get_type_name(uint8_t type);
488 * genimg_get_type_short_name() - get the short name for an image type
490 * @param type Image type (IH_TYPE_...)
491 * @return image short name, or "unknown" if unknown
493 const char *genimg_get_type_short_name(uint8_t type);
495 const char *genimg_get_comp_name(uint8_t comp);
498 * genimg_get_comp_short_name() - get the short name for a compression method
500 * @param comp compression method (IH_COMP_...)
501 * @return compression method short name, or "unknown" if unknown
503 const char *genimg_get_comp_short_name(uint8_t comp);
506 * genimg_get_cat_name() - Get the name of an item in a category
508 * @category: Category of item
510 * @return name of item, or "Unknown ..." if unknown
512 const char *genimg_get_cat_name(enum ih_category category, uint id);
515 * genimg_get_cat_short_name() - Get the short name of an item in a category
517 * @category: Category of item
519 * @return short name of item, or "Unknown ..." if unknown
521 const char *genimg_get_cat_short_name(enum ih_category category, uint id);
524 * genimg_get_cat_count() - Get the number of items in a category
526 * @category: Category to check
527 * @return the number of items in the category (IH_xxx_COUNT)
529 int genimg_get_cat_count(enum ih_category category);
532 * genimg_get_cat_desc() - Get the description of a category
534 * @return the description of a category, e.g. "architecture". This
535 * effectively converts the enum to a string.
537 const char *genimg_get_cat_desc(enum ih_category category);
539 int genimg_get_os_id(const char *name);
540 int genimg_get_arch_id(const char *name);
541 int genimg_get_type_id(const char *name);
542 int genimg_get_comp_id(const char *name);
543 void genimg_print_size(uint32_t size);
545 #if defined(CONFIG_TIMESTAMP) || defined(CONFIG_CMD_DATE) || \
547 #define IMAGE_ENABLE_TIMESTAMP 1
549 #define IMAGE_ENABLE_TIMESTAMP 0
551 void genimg_print_time(time_t timestamp);
553 /* What to do with a image load address ('load = <> 'in the FIT) */
555 FIT_LOAD_IGNORED, /* Ignore load address */
556 FIT_LOAD_OPTIONAL, /* Can be provided, but optional */
557 FIT_LOAD_OPTIONAL_NON_ZERO, /* Optional, a value of 0 is ignored */
558 FIT_LOAD_REQUIRED, /* Must be provided */
561 int boot_get_setup(bootm_headers_t *images, uint8_t arch, ulong *setup_start,
565 /* Image format types, returned by _get_format() routine */
566 #define IMAGE_FORMAT_INVALID 0x00
567 #if defined(CONFIG_LEGACY_IMAGE_FORMAT)
568 #define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */
570 #define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */
571 #define IMAGE_FORMAT_ANDROID 0x03 /* Android boot image */
573 ulong genimg_get_kernel_addr_fit(char * const img_addr,
574 const char **fit_uname_config,
575 const char **fit_uname_kernel);
576 ulong genimg_get_kernel_addr(char * const img_addr);
577 int genimg_get_format(const void *img_addr);
578 int genimg_has_config(bootm_headers_t *images);
580 int boot_get_fpga(int argc, char * const argv[], bootm_headers_t *images,
581 uint8_t arch, const ulong *ld_start, ulong * const ld_len);
582 int boot_get_ramdisk(int argc, char * const argv[], bootm_headers_t *images,
583 uint8_t arch, ulong *rd_start, ulong *rd_end);
586 * boot_get_loadable - routine to load a list of binaries to memory
587 * @argc: Ignored Argument
588 * @argv: Ignored Argument
589 * @images: pointer to the bootm images structure
590 * @arch: expected architecture for the image
591 * @ld_start: Ignored Argument
592 * @ld_len: Ignored Argument
594 * boot_get_loadable() will take the given FIT configuration, and look
595 * for a field named "loadables". Loadables, is a list of elements in
596 * the FIT given as strings. exe:
597 * loadables = "linux_kernel", "fdt-2";
598 * this function will attempt to parse each string, and load the
599 * corresponding element from the FIT into memory. Once placed,
600 * no aditional actions are taken.
603 * 0, if only valid images or no images are found
604 * error code, if an error occurs during fit_image_load
606 int boot_get_loadable(int argc, char * const argv[], bootm_headers_t *images,
607 uint8_t arch, const ulong *ld_start, ulong * const ld_len);
608 #endif /* !USE_HOSTCC */
610 int boot_get_setup_fit(bootm_headers_t *images, uint8_t arch,
611 ulong *setup_start, ulong *setup_len);
614 * boot_get_fdt_fit() - load a DTB from a FIT file (applying overlays)
616 * This deals with all aspects of loading an DTB from a FIT.
617 * The correct base image based on configuration will be selected, and
618 * then any overlays specified will be applied (as present in fit_uname_configp).
620 * @param images Boot images structure
621 * @param addr Address of FIT in memory
622 * @param fit_unamep On entry this is the requested image name
623 * (e.g. "kernel") or NULL to use the default. On exit
624 * points to the selected image name
625 * @param fit_uname_configp On entry this is the requested configuration
626 * name (e.g. "conf-1") or NULL to use the default. On
627 * exit points to the selected configuration name.
628 * @param arch Expected architecture (IH_ARCH_...)
629 * @param datap Returns address of loaded image
630 * @param lenp Returns length of loaded image
632 * @return node offset of base image, or -ve error code on error
634 int boot_get_fdt_fit(bootm_headers_t *images, ulong addr,
635 const char **fit_unamep, const char **fit_uname_configp,
636 int arch, ulong *datap, ulong *lenp);
639 * fit_image_load() - load an image from a FIT
641 * This deals with all aspects of loading an image from a FIT, including
642 * selecting the right image based on configuration, verifying it, printing
643 * out progress messages, checking the type/arch/os and optionally copying it
644 * to the right load address.
646 * The property to look up is defined by image_type.
648 * @param images Boot images structure
649 * @param addr Address of FIT in memory
650 * @param fit_unamep On entry this is the requested image name
651 * (e.g. "kernel") or NULL to use the default. On exit
652 * points to the selected image name
653 * @param fit_uname_configp On entry this is the requested configuration
654 * name (e.g. "conf-1") or NULL to use the default. On
655 * exit points to the selected configuration name.
656 * @param arch Expected architecture (IH_ARCH_...)
657 * @param image_type Required image type (IH_TYPE_...). If this is
658 * IH_TYPE_KERNEL then we allow IH_TYPE_KERNEL_NOLOAD
660 * @param bootstage_id ID of starting bootstage to use for progress updates.
661 * This will be added to the BOOTSTAGE_SUB values when
662 * calling bootstage_mark()
663 * @param load_op Decribes what to do with the load address
664 * @param datap Returns address of loaded image
665 * @param lenp Returns length of loaded image
666 * @return node offset of image, or -ve error code on error
668 int fit_image_load(bootm_headers_t *images, ulong addr,
669 const char **fit_unamep, const char **fit_uname_configp,
670 int arch, int image_type, int bootstage_id,
671 enum fit_load_op load_op, ulong *datap, ulong *lenp);
675 * fit_get_node_from_config() - Look up an image a FIT by type
677 * This looks in the selected conf- node (images->fit_uname_cfg) for a
678 * particular image type (e.g. "kernel") and then finds the image that is
681 * For example, for something like:
694 * the function will return the node offset of the kernel@1 node, assuming
695 * that conf-1 is the chosen configuration.
697 * @param images Boot images structure
698 * @param prop_name Property name to look up (FIT_..._PROP)
699 * @param addr Address of FIT in memory
701 int fit_get_node_from_config(bootm_headers_t *images, const char *prop_name,
704 int boot_get_fdt(int flag, int argc, char * const argv[], uint8_t arch,
705 bootm_headers_t *images,
706 char **of_flat_tree, ulong *of_size);
707 void boot_fdt_add_mem_rsv_regions(struct lmb *lmb, void *fdt_blob);
708 int boot_relocate_fdt(struct lmb *lmb, char **of_flat_tree, ulong *of_size);
710 int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len,
711 ulong *initrd_start, ulong *initrd_end);
712 int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end);
713 #ifdef CONFIG_SYS_BOOT_GET_KBD
714 int boot_get_kbd(struct lmb *lmb, bd_t **kbd);
715 #endif /* CONFIG_SYS_BOOT_GET_KBD */
716 #endif /* !USE_HOSTCC */
718 /*******************************************************************/
719 /* Legacy format specific code (prefixed with image_) */
720 /*******************************************************************/
721 static inline uint32_t image_get_header_size(void)
723 return (sizeof(image_header_t));
726 #define image_get_hdr_l(f) \
727 static inline uint32_t image_get_##f(const image_header_t *hdr) \
729 return uimage_to_cpu(hdr->ih_##f); \
731 image_get_hdr_l(magic) /* image_get_magic */
732 image_get_hdr_l(hcrc) /* image_get_hcrc */
733 image_get_hdr_l(time) /* image_get_time */
734 image_get_hdr_l(size) /* image_get_size */
735 image_get_hdr_l(load) /* image_get_load */
736 image_get_hdr_l(ep) /* image_get_ep */
737 image_get_hdr_l(dcrc) /* image_get_dcrc */
739 #define image_get_hdr_b(f) \
740 static inline uint8_t image_get_##f(const image_header_t *hdr) \
742 return hdr->ih_##f; \
744 image_get_hdr_b(os) /* image_get_os */
745 image_get_hdr_b(arch) /* image_get_arch */
746 image_get_hdr_b(type) /* image_get_type */
747 image_get_hdr_b(comp) /* image_get_comp */
749 static inline char *image_get_name(const image_header_t *hdr)
751 return (char *)hdr->ih_name;
754 static inline uint32_t image_get_data_size(const image_header_t *hdr)
756 return image_get_size(hdr);
760 * image_get_data - get image payload start address
763 * image_get_data() returns address of the image payload. For single
764 * component images it is image data start. For multi component
765 * images it points to the null terminated table of sub-images sizes.
768 * image payload data start address
770 static inline ulong image_get_data(const image_header_t *hdr)
772 return ((ulong)hdr + image_get_header_size());
775 static inline uint32_t image_get_image_size(const image_header_t *hdr)
777 return (image_get_size(hdr) + image_get_header_size());
779 static inline ulong image_get_image_end(const image_header_t *hdr)
781 return ((ulong)hdr + image_get_image_size(hdr));
784 #define image_set_hdr_l(f) \
785 static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
787 hdr->ih_##f = cpu_to_uimage(val); \
789 image_set_hdr_l(magic) /* image_set_magic */
790 image_set_hdr_l(hcrc) /* image_set_hcrc */
791 image_set_hdr_l(time) /* image_set_time */
792 image_set_hdr_l(size) /* image_set_size */
793 image_set_hdr_l(load) /* image_set_load */
794 image_set_hdr_l(ep) /* image_set_ep */
795 image_set_hdr_l(dcrc) /* image_set_dcrc */
797 #define image_set_hdr_b(f) \
798 static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
802 image_set_hdr_b(os) /* image_set_os */
803 image_set_hdr_b(arch) /* image_set_arch */
804 image_set_hdr_b(type) /* image_set_type */
805 image_set_hdr_b(comp) /* image_set_comp */
807 static inline void image_set_name(image_header_t *hdr, const char *name)
809 strncpy(image_get_name(hdr), name, IH_NMLEN);
812 int image_check_hcrc(const image_header_t *hdr);
813 int image_check_dcrc(const image_header_t *hdr);
815 ulong env_get_bootm_low(void);
816 phys_size_t env_get_bootm_size(void);
817 phys_size_t env_get_bootm_mapsize(void);
819 void memmove_wd(void *to, void *from, size_t len, ulong chunksz);
821 static inline int image_check_magic(const image_header_t *hdr)
823 return (image_get_magic(hdr) == IH_MAGIC);
825 static inline int image_check_type(const image_header_t *hdr, uint8_t type)
827 return (image_get_type(hdr) == type);
829 static inline int image_check_arch(const image_header_t *hdr, uint8_t arch)
831 return (image_get_arch(hdr) == arch) ||
832 (image_get_arch(hdr) == IH_ARCH_ARM && arch == IH_ARCH_ARM64);
834 static inline int image_check_os(const image_header_t *hdr, uint8_t os)
836 return (image_get_os(hdr) == os);
839 ulong image_multi_count(const image_header_t *hdr);
840 void image_multi_getimg(const image_header_t *hdr, ulong idx,
841 ulong *data, ulong *len);
843 void image_print_contents(const void *hdr);
846 static inline int image_check_target_arch(const image_header_t *hdr)
848 #ifndef IH_ARCH_DEFAULT
849 # error "please define IH_ARCH_DEFAULT in your arch asm/u-boot.h"
851 return image_check_arch(hdr, IH_ARCH_DEFAULT);
853 #endif /* USE_HOSTCC */
856 * image_decomp() - decompress an image
858 * @comp: Compression algorithm that is used (IH_COMP_...)
859 * @load: Destination load address in U-Boot memory
860 * @image_start Image start address (where we are decompressing from)
861 * @type: OS type (IH_OS_...)
862 * @load_bug: Place to decompress to
863 * @image_buf: Address to decompress from
864 * @image_len: Number of bytes in @image_buf to decompress
865 * @unc_len: Available space for decompression
866 * @return 0 if OK, -ve on error (BOOTM_ERR_...)
868 int image_decomp(int comp, ulong load, ulong image_start, int type,
869 void *load_buf, void *image_buf, ulong image_len,
870 uint unc_len, ulong *load_end);
873 * Set up properties in the FDT
875 * This sets up properties in the FDT that is to be passed to linux.
877 * @images: Images information
878 * @blob: FDT to update
879 * @of_size: Size of the FDT
880 * @lmb: Points to logical memory block structure
881 * @return 0 if ok, <0 on failure
883 int image_setup_libfdt(bootm_headers_t *images, void *blob,
884 int of_size, struct lmb *lmb);
887 * Set up the FDT to use for booting a kernel
889 * This performs ramdisk setup, sets up the FDT if required, and adds
890 * paramters to the FDT if libfdt is available.
892 * @param images Images information
893 * @return 0 if ok, <0 on failure
895 int image_setup_linux(bootm_headers_t *images);
898 * bootz_setup() - Extract stat and size of a Linux xImage
900 * @image: Address of image
901 * @start: Returns start address of image
902 * @end : Returns end address of image
903 * @return 0 if OK, 1 if the image was not recognised
905 int bootz_setup(ulong image, ulong *start, ulong *end);
908 * Return the correct start address and size of a Linux aarch64 Image.
910 * @image: Address of image
911 * @start: Returns start address of image
912 * @size : Returns size image
913 * @force_reloc: Ignore image->ep field, always place image to RAM start
914 * @return 0 if OK, 1 if the image was not recognised
916 int booti_setup(ulong image, ulong *relocated_addr, ulong *size,
919 /*******************************************************************/
920 /* New uImage format specific code (prefixed with fit_) */
921 /*******************************************************************/
923 #define FIT_IMAGES_PATH "/images"
924 #define FIT_CONFS_PATH "/configurations"
926 /* hash/signature node */
927 #define FIT_HASH_NODENAME "hash"
928 #define FIT_ALGO_PROP "algo"
929 #define FIT_VALUE_PROP "value"
930 #define FIT_IGNORE_PROP "uboot-ignore"
931 #define FIT_SIG_NODENAME "signature"
934 #define FIT_DATA_PROP "data"
935 #define FIT_DATA_POSITION_PROP "data-position"
936 #define FIT_DATA_OFFSET_PROP "data-offset"
937 #define FIT_DATA_SIZE_PROP "data-size"
938 #define FIT_TIMESTAMP_PROP "timestamp"
939 #define FIT_DESC_PROP "description"
940 #define FIT_ARCH_PROP "arch"
941 #define FIT_TYPE_PROP "type"
942 #define FIT_OS_PROP "os"
943 #define FIT_COMP_PROP "compression"
944 #define FIT_ENTRY_PROP "entry"
945 #define FIT_LOAD_PROP "load"
947 /* configuration node */
948 #define FIT_KERNEL_PROP "kernel"
949 #define FIT_RAMDISK_PROP "ramdisk"
950 #define FIT_FDT_PROP "fdt"
951 #define FIT_LOADABLE_PROP "loadables"
952 #define FIT_DEFAULT_PROP "default"
953 #define FIT_SETUP_PROP "setup"
954 #define FIT_FPGA_PROP "fpga"
955 #define FIT_FIRMWARE_PROP "firmware"
956 #define FIT_STANDALONE_PROP "standalone"
958 #define FIT_MAX_HASH_LEN HASH_MAX_DIGEST_SIZE
961 /* cmdline argument format parsing */
962 int fit_parse_conf(const char *spec, ulong addr_curr,
963 ulong *addr, const char **conf_name);
964 int fit_parse_subimage(const char *spec, ulong addr_curr,
965 ulong *addr, const char **image_name);
967 int fit_get_subimage_count(const void *fit, int images_noffset);
968 void fit_print_contents(const void *fit);
969 void fit_image_print(const void *fit, int noffset, const char *p);
972 * fit_get_end - get FIT image size
973 * @fit: pointer to the FIT format image header
976 * size of the FIT image (blob) in memory
978 static inline ulong fit_get_size(const void *fit)
980 return fdt_totalsize(fit);
984 * fit_get_end - get FIT image end
985 * @fit: pointer to the FIT format image header
988 * end address of the FIT image (blob) in memory
990 ulong fit_get_end(const void *fit);
993 * fit_get_name - get FIT node name
994 * @fit: pointer to the FIT format image header
998 * pointer to node name, on success
1000 static inline const char *fit_get_name(const void *fit_hdr,
1001 int noffset, int *len)
1003 return fdt_get_name(fit_hdr, noffset, len);
1006 int fit_get_desc(const void *fit, int noffset, char **desc);
1007 int fit_get_timestamp(const void *fit, int noffset, time_t *timestamp);
1009 int fit_image_get_node(const void *fit, const char *image_uname);
1010 int fit_image_get_os(const void *fit, int noffset, uint8_t *os);
1011 int fit_image_get_arch(const void *fit, int noffset, uint8_t *arch);
1012 int fit_image_get_type(const void *fit, int noffset, uint8_t *type);
1013 int fit_image_get_comp(const void *fit, int noffset, uint8_t *comp);
1014 int fit_image_get_load(const void *fit, int noffset, ulong *load);
1015 int fit_image_get_entry(const void *fit, int noffset, ulong *entry);
1016 int fit_image_get_data(const void *fit, int noffset,
1017 const void **data, size_t *size);
1018 int fit_image_get_data_offset(const void *fit, int noffset, int *data_offset);
1019 int fit_image_get_data_position(const void *fit, int noffset,
1020 int *data_position);
1021 int fit_image_get_data_size(const void *fit, int noffset, int *data_size);
1022 int fit_image_get_data_and_size(const void *fit, int noffset,
1023 const void **data, size_t *size);
1025 int fit_image_hash_get_algo(const void *fit, int noffset, char **algo);
1026 int fit_image_hash_get_value(const void *fit, int noffset, uint8_t **value,
1029 int fit_set_timestamp(void *fit, int noffset, time_t timestamp);
1032 * fit_add_verification_data() - add verification data to FIT image nodes
1034 * @keydir: Directory containing keys
1035 * @kwydest: FDT blob to write public key information to
1036 * @fit: Pointer to the FIT format image header
1037 * @comment: Comment to add to signature nodes
1038 * @require_keys: Mark all keys as 'required'
1039 * @engine_id: Engine to use for signing
1040 * @cmdname: Command name used when reporting errors
1042 * Adds hash values for all component images in the FIT blob.
1043 * Hashes are calculated for all component images which have hash subnodes
1044 * with algorithm property set to one of the supported hash algorithms.
1046 * Also add signatures if signature nodes are present.
1050 * libfdt error code, on failure
1052 int fit_add_verification_data(const char *keydir, void *keydest, void *fit,
1053 const char *comment, int require_keys,
1054 const char *engine_id, const char *cmdname);
1056 int fit_image_verify_with_data(const void *fit, int image_noffset,
1057 const void *data, size_t size);
1058 int fit_image_verify(const void *fit, int noffset);
1059 int fit_config_verify(const void *fit, int conf_noffset);
1060 int fit_all_image_verify(const void *fit);
1061 int fit_image_check_os(const void *fit, int noffset, uint8_t os);
1062 int fit_image_check_arch(const void *fit, int noffset, uint8_t arch);
1063 int fit_image_check_type(const void *fit, int noffset, uint8_t type);
1064 int fit_image_check_comp(const void *fit, int noffset, uint8_t comp);
1065 int fit_check_format(const void *fit);
1067 int fit_conf_find_compat(const void *fit, const void *fdt);
1068 int fit_conf_get_node(const void *fit, const char *conf_uname);
1069 int fit_conf_get_prop_node_count(const void *fit, int noffset,
1070 const char *prop_name);
1071 int fit_conf_get_prop_node_index(const void *fit, int noffset,
1072 const char *prop_name, int index);
1075 * fit_conf_get_prop_node() - Get node refered to by a configuration
1076 * @fit: FIT to check
1077 * @noffset: Offset of conf@xxx node to check
1078 * @prop_name: Property to read from the conf node
1080 * The conf- nodes contain references to other nodes, using properties
1081 * like 'kernel = "kernel"'. Given such a property name (e.g. "kernel"),
1082 * return the offset of the node referred to (e.g. offset of node
1085 int fit_conf_get_prop_node(const void *fit, int noffset,
1086 const char *prop_name);
1088 int fit_check_ramdisk(const void *fit, int os_noffset,
1089 uint8_t arch, int verify);
1091 int calculate_hash(const void *data, int data_len, const char *algo,
1092 uint8_t *value, int *value_len);
1095 * At present we only support signing on the host, and verification on the
1098 #if defined(USE_HOSTCC)
1099 # if defined(CONFIG_FIT_SIGNATURE)
1100 # define IMAGE_ENABLE_SIGN 1
1101 # define IMAGE_ENABLE_VERIFY 1
1102 # include <openssl/evp.h>
1104 # define IMAGE_ENABLE_SIGN 0
1105 # define IMAGE_ENABLE_VERIFY 0
1108 # define IMAGE_ENABLE_SIGN 0
1109 # define IMAGE_ENABLE_VERIFY CONFIG_IS_ENABLED(FIT_SIGNATURE)
1113 void *image_get_host_blob(void);
1114 void image_set_host_blob(void *host_blob);
1115 # define gd_fdt_blob() image_get_host_blob()
1117 # define gd_fdt_blob() (gd->fdt_blob)
1120 #ifdef CONFIG_FIT_BEST_MATCH
1121 #define IMAGE_ENABLE_BEST_MATCH 1
1123 #define IMAGE_ENABLE_BEST_MATCH 0
1126 /* Information passed to the signing routines */
1127 struct image_sign_info {
1128 const char *keydir; /* Directory conaining keys */
1129 const char *keyname; /* Name of key to use */
1130 void *fit; /* Pointer to FIT blob */
1131 int node_offset; /* Offset of signature node */
1132 const char *name; /* Algorithm name */
1133 struct checksum_algo *checksum; /* Checksum algorithm information */
1134 struct padding_algo *padding; /* Padding algorithm information */
1135 struct crypto_algo *crypto; /* Crypto algorithm information */
1136 const void *fdt_blob; /* FDT containing public keys */
1137 int required_keynode; /* Node offset of key to use: -1=any */
1138 const char *require_keys; /* Value for 'required' property */
1139 const char *engine_id; /* Engine to use for signing */
1141 #endif /* Allow struct image_region to always be defined for rsa.h */
1143 /* A part of an image, used for hashing */
1144 struct image_region {
1149 #if IMAGE_ENABLE_FIT
1151 #if IMAGE_ENABLE_VERIFY
1152 # include <u-boot/rsa-checksum.h>
1154 struct checksum_algo {
1156 const int checksum_len;
1158 const uint8_t *der_prefix;
1159 #if IMAGE_ENABLE_SIGN
1160 const EVP_MD *(*calculate_sign)(void);
1162 int (*calculate)(const char *name,
1163 const struct image_region region[],
1164 int region_count, uint8_t *checksum);
1167 struct crypto_algo {
1168 const char *name; /* Name of algorithm */
1172 * sign() - calculate and return signature for given input data
1174 * @info: Specifies key and FIT information
1175 * @data: Pointer to the input data
1176 * @data_len: Data length
1177 * @sigp: Set to an allocated buffer holding the signature
1178 * @sig_len: Set to length of the calculated hash
1180 * This computes input data signature according to selected algorithm.
1181 * Resulting signature value is placed in an allocated buffer, the
1182 * pointer is returned as *sigp. The length of the calculated
1183 * signature is returned via the sig_len pointer argument. The caller
1184 * should free *sigp.
1186 * @return: 0, on success, -ve on error
1188 int (*sign)(struct image_sign_info *info,
1189 const struct image_region region[],
1190 int region_count, uint8_t **sigp, uint *sig_len);
1193 * add_verify_data() - Add verification information to FDT
1195 * Add public key information to the FDT node, suitable for
1196 * verification at run-time. The information added depends on the
1197 * algorithm being used.
1199 * @info: Specifies key and FIT information
1200 * @keydest: Destination FDT blob for public key data
1201 * @return: 0, on success, -ve on error
1203 int (*add_verify_data)(struct image_sign_info *info, void *keydest);
1206 * verify() - Verify a signature against some data
1208 * @info: Specifies key and FIT information
1209 * @data: Pointer to the input data
1210 * @data_len: Data length
1212 * @sig_len: Number of bytes in signature
1213 * @return 0 if verified, -ve on error
1215 int (*verify)(struct image_sign_info *info,
1216 const struct image_region region[], int region_count,
1217 uint8_t *sig, uint sig_len);
1220 struct padding_algo {
1222 int (*verify)(struct image_sign_info *info,
1223 uint8_t *pad, int pad_len,
1224 const uint8_t *hash, int hash_len);
1228 * image_get_checksum_algo() - Look up a checksum algorithm
1230 * @param full_name Name of algorithm in the form "checksum,crypto"
1231 * @return pointer to algorithm information, or NULL if not found
1233 struct checksum_algo *image_get_checksum_algo(const char *full_name);
1236 * image_get_crypto_algo() - Look up a cryptosystem algorithm
1238 * @param full_name Name of algorithm in the form "checksum,crypto"
1239 * @return pointer to algorithm information, or NULL if not found
1241 struct crypto_algo *image_get_crypto_algo(const char *full_name);
1244 * image_get_padding_algo() - Look up a padding algorithm
1246 * @param name Name of padding algorithm
1247 * @return pointer to algorithm information, or NULL if not found
1249 struct padding_algo *image_get_padding_algo(const char *name);
1252 * fit_image_verify_required_sigs() - Verify signatures marked as 'required'
1254 * @fit: FIT to check
1255 * @image_noffset: Offset of image node to check
1256 * @data: Image data to check
1257 * @size: Size of image data
1258 * @sig_blob: FDT containing public keys
1259 * @no_sigsp: Returns 1 if no signatures were required, and
1260 * therefore nothing was checked. The caller may wish
1261 * to fall back to other mechanisms, or refuse to
1263 * @return 0 if all verified ok, <0 on error
1265 int fit_image_verify_required_sigs(const void *fit, int image_noffset,
1266 const char *data, size_t size, const void *sig_blob,
1270 * fit_image_check_sig() - Check a single image signature node
1272 * @fit: FIT to check
1273 * @noffset: Offset of signature node to check
1274 * @data: Image data to check
1275 * @size: Size of image data
1276 * @required_keynode: Offset in the control FDT of the required key node,
1277 * if any. If this is given, then the image wil not
1278 * pass verification unless that key is used. If this is
1279 * -1 then any signature will do.
1280 * @err_msgp: In the event of an error, this will be pointed to a
1281 * help error string to display to the user.
1282 * @return 0 if all verified ok, <0 on error
1284 int fit_image_check_sig(const void *fit, int noffset, const void *data,
1285 size_t size, int required_keynode, char **err_msgp);
1288 * fit_region_make_list() - Make a list of regions to hash
1290 * Given a list of FIT regions (offset, size) provided by libfdt, create
1291 * a list of regions (void *, size) for use by the signature creationg
1292 * and verification code.
1294 * @fit: FIT image to process
1295 * @fdt_regions: Regions as returned by libfdt
1296 * @count: Number of regions returned by libfdt
1297 * @region: Place to put list of regions (NULL to allocate it)
1298 * @return pointer to list of regions, or NULL if out of memory
1300 struct image_region *fit_region_make_list(const void *fit,
1301 struct fdt_region *fdt_regions, int count,
1302 struct image_region *region);
1304 static inline int fit_image_check_target_arch(const void *fdt, int node)
1307 return fit_image_check_arch(fdt, node, IH_ARCH_DEFAULT);
1313 #ifdef CONFIG_FIT_VERBOSE
1314 #define fit_unsupported(msg) printf("! %s:%d " \
1315 "FIT images not supported for '%s'\n", \
1316 __FILE__, __LINE__, (msg))
1318 #define fit_unsupported_reset(msg) printf("! %s:%d " \
1319 "FIT images not supported for '%s' " \
1320 "- must reset board to recover!\n", \
1321 __FILE__, __LINE__, (msg))
1323 #define fit_unsupported(msg)
1324 #define fit_unsupported_reset(msg)
1325 #endif /* CONFIG_FIT_VERBOSE */
1326 #endif /* CONFIG_FIT */
1328 #if defined(CONFIG_ANDROID_BOOT_IMAGE)
1329 struct andr_img_hdr;
1330 int android_image_check_header(const struct andr_img_hdr *hdr);
1331 int android_image_get_kernel(const struct andr_img_hdr *hdr, int verify,
1332 ulong *os_data, ulong *os_len);
1333 int android_image_get_ramdisk(const struct andr_img_hdr *hdr,
1334 ulong *rd_data, ulong *rd_len);
1335 int android_image_get_second(const struct andr_img_hdr *hdr,
1336 ulong *second_data, ulong *second_len);
1337 ulong android_image_get_end(const struct andr_img_hdr *hdr);
1338 ulong android_image_get_kload(const struct andr_img_hdr *hdr);
1339 ulong android_image_get_kcomp(const struct andr_img_hdr *hdr);
1340 void android_print_contents(const struct andr_img_hdr *hdr);
1342 #endif /* CONFIG_ANDROID_BOOT_IMAGE */
1345 * board_fit_config_name_match() - Check for a matching board name
1347 * This is used when SPL loads a FIT containing multiple device tree files
1348 * and wants to work out which one to use. The description of each one is
1349 * passed to this function. The description comes from the 'description' field
1350 * in each (FDT) image node.
1352 * @name: Device tree description
1353 * @return 0 if this device tree should be used, non-zero to try the next
1355 int board_fit_config_name_match(const char *name);
1357 #if defined(CONFIG_SPL_FIT_IMAGE_POST_PROCESS) || \
1358 defined(CONFIG_FIT_IMAGE_POST_PROCESS)
1360 * board_fit_image_post_process() - Do any post-process on FIT binary data
1362 * This is used to do any sort of image manipulation, verification, decryption
1363 * etc. in a platform or board specific way. Obviously, anything done here would
1364 * need to be comprehended in how the images were prepared before being injected
1365 * into the FIT creation (i.e. the binary blobs would have been pre-processed
1366 * before being added to the FIT image).
1368 * @image: pointer to the image start pointer
1369 * @size: pointer to the image size
1370 * @return no return value (failure should be handled internally)
1372 void board_fit_image_post_process(void **p_image, size_t *p_size);
1373 #endif /* CONFIG_SPL_FIT_IMAGE_POST_PROCESS */
1375 #define FDT_ERROR ((ulong)(-1))
1377 ulong fdt_getprop_u32(const void *fdt, int node, const char *prop);
1380 * fit_find_config_node() - Find the node for the best DTB in a FIT image
1382 * A FIT image contains one or more DTBs. This function parses the
1383 * configurations described in the FIT images and returns the node of
1384 * the first matching DTB. To check if a DTB matches a board, this function
1385 * calls board_fit_config_name_match(). If no matching DTB is found, it returns
1386 * the node described by the default configuration if it exists.
1388 * @fdt: pointer to flat device tree
1389 * @return the node if found, -ve otherwise
1391 int fit_find_config_node(const void *fdt);
1394 * Mapping of image types to function handlers to be invoked on the associated
1397 * @type: Type of image, I.E. IH_TYPE_*
1398 * @handler: Function to call on loaded image
1400 struct fit_loadable_tbl {
1403 * handler() - Process a loaded image
1405 * @data: Pointer to start of loaded image data
1406 * @size: Size of loaded image data
1408 void (*handler)(ulong data, size_t size);
1412 * Define a FIT loadable image type handler
1414 * _type is a valid uimage_type ID as defined in the "Image Type" enum above
1415 * _handler is the handler function to call after this image type is loaded
1417 #define U_BOOT_FIT_LOADABLE_HANDLER(_type, _handler) \
1418 ll_entry_declare(struct fit_loadable_tbl, _function, fit_loadable) = { \
1420 .handler = _handler, \
1423 #endif /* __IMAGE_H__ */