2 * (C) Copyright 2008 Semihalf
4 * (C) Copyright 2000-2005
5 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
7 * SPDX-License-Identifier: GPL-2.0+
8 ********************************************************************
9 * NOTE: This header file defines an interface to U-Boot. Including
10 * this (unmodified) header file in another file is considered normal
11 * use of U-Boot, and does *not* fall under the heading of "derived
13 ********************************************************************
20 #include <asm/byteorder.h>
22 /* Define this to avoid #ifdefs later on */
26 #include <sys/types.h>
28 /* new uImage format support enabled on host */
29 #define IMAGE_ENABLE_FIT 1
30 #define IMAGE_ENABLE_OF_LIBFDT 1
31 #define CONFIG_FIT_VERBOSE 1 /* enable fit_format_{error,warning}() */
33 #define IMAGE_ENABLE_IGNORE 0
34 #define IMAGE_INDENT_STRING ""
39 #include <asm/u-boot.h>
42 /* Take notice of the 'ignore' property for hashes */
43 #define IMAGE_ENABLE_IGNORE 1
44 #define IMAGE_INDENT_STRING " "
46 #define IMAGE_ENABLE_FIT CONFIG_IS_ENABLED(FIT)
47 #define IMAGE_ENABLE_OF_LIBFDT CONFIG_IS_ENABLED(OF_LIBFDT)
49 #endif /* USE_HOSTCC */
54 #include <fdt_support.h>
55 # ifdef CONFIG_SPL_BUILD
56 # ifdef CONFIG_SPL_CRC32_SUPPORT
57 # define IMAGE_ENABLE_CRC32 1
59 # ifdef CONFIG_SPL_MD5_SUPPORT
60 # define IMAGE_ENABLE_MD5 1
62 # ifdef CONFIG_SPL_SHA1_SUPPORT
63 # define IMAGE_ENABLE_SHA1 1
65 # ifdef CONFIG_SPL_SHA256_SUPPORT
66 # define IMAGE_ENABLE_SHA256 1
69 # define CONFIG_CRC32 /* FIT images need CRC32 support */
70 # define CONFIG_MD5 /* and MD5 */
71 # define CONFIG_SHA1 /* and SHA1 */
72 # define CONFIG_SHA256 /* and SHA256 */
73 # define IMAGE_ENABLE_CRC32 1
74 # define IMAGE_ENABLE_MD5 1
75 # define IMAGE_ENABLE_SHA1 1
76 # define IMAGE_ENABLE_SHA256 1
79 #ifdef CONFIG_FIT_DISABLE_SHA256
81 #undef IMAGE_ENABLE_SHA256
84 #ifndef IMAGE_ENABLE_CRC32
85 #define IMAGE_ENABLE_CRC32 0
88 #ifndef IMAGE_ENABLE_MD5
89 #define IMAGE_ENABLE_MD5 0
92 #ifndef IMAGE_ENABLE_SHA1
93 #define IMAGE_ENABLE_SHA1 0
96 #ifndef IMAGE_ENABLE_SHA256
97 #define IMAGE_ENABLE_SHA256 0
100 #endif /* IMAGE_ENABLE_FIT */
102 #ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH
103 # define IMAGE_ENABLE_RAMDISK_HIGH 1
105 # define IMAGE_ENABLE_RAMDISK_HIGH 0
108 #ifdef CONFIG_SYS_BOOT_GET_CMDLINE
109 # define IMAGE_BOOT_GET_CMDLINE 1
111 # define IMAGE_BOOT_GET_CMDLINE 0
114 #ifdef CONFIG_OF_BOARD_SETUP
115 # define IMAGE_OF_BOARD_SETUP 1
117 # define IMAGE_OF_BOARD_SETUP 0
120 #ifdef CONFIG_OF_SYSTEM_SETUP
121 # define IMAGE_OF_SYSTEM_SETUP 1
123 # define IMAGE_OF_SYSTEM_SETUP 0
136 * Operating System Codes
138 * The following are exposed to uImage header.
139 * Do not change values for backward compatibility.
142 IH_OS_INVALID = 0, /* Invalid OS */
143 IH_OS_OPENBSD, /* OpenBSD */
144 IH_OS_NETBSD, /* NetBSD */
145 IH_OS_FREEBSD, /* FreeBSD */
146 IH_OS_4_4BSD, /* 4.4BSD */
147 IH_OS_LINUX, /* Linux */
148 IH_OS_SVR4, /* SVR4 */
149 IH_OS_ESIX, /* Esix */
150 IH_OS_SOLARIS, /* Solaris */
151 IH_OS_IRIX, /* Irix */
153 IH_OS_DELL, /* Dell */
155 IH_OS_LYNXOS, /* LynxOS */
156 IH_OS_VXWORKS, /* VxWorks */
157 IH_OS_PSOS, /* pSOS */
159 IH_OS_U_BOOT, /* Firmware */
160 IH_OS_RTEMS, /* RTEMS */
161 IH_OS_ARTOS, /* ARTOS */
162 IH_OS_UNITY, /* Unity OS */
163 IH_OS_INTEGRITY, /* INTEGRITY */
165 IH_OS_PLAN9, /* Plan 9 */
166 IH_OS_OPENRTOS, /* OpenRTOS */
172 * CPU Architecture Codes (supported by Linux)
174 * The following are exposed to uImage header.
175 * Do not change values for backward compatibility.
178 IH_ARCH_INVALID = 0, /* Invalid CPU */
179 IH_ARCH_ALPHA, /* Alpha */
180 IH_ARCH_ARM, /* ARM */
181 IH_ARCH_I386, /* Intel x86 */
182 IH_ARCH_IA64, /* IA64 */
183 IH_ARCH_MIPS, /* MIPS */
184 IH_ARCH_MIPS64, /* MIPS 64 Bit */
185 IH_ARCH_PPC, /* PowerPC */
186 IH_ARCH_S390, /* IBM S390 */
187 IH_ARCH_SH, /* SuperH */
188 IH_ARCH_SPARC, /* Sparc */
189 IH_ARCH_SPARC64, /* Sparc 64 Bit */
190 IH_ARCH_M68K, /* M68K */
191 IH_ARCH_NIOS, /* Nios-32 */
192 IH_ARCH_MICROBLAZE, /* MicroBlaze */
193 IH_ARCH_NIOS2, /* Nios-II */
194 IH_ARCH_BLACKFIN, /* Blackfin */
195 IH_ARCH_AVR32, /* AVR32 */
196 IH_ARCH_ST200, /* STMicroelectronics ST200 */
197 IH_ARCH_SANDBOX, /* Sandbox architecture (test only) */
198 IH_ARCH_NDS32, /* ANDES Technology - NDS32 */
199 IH_ARCH_OPENRISC, /* OpenRISC 1000 */
200 IH_ARCH_ARM64, /* ARM64 */
201 IH_ARCH_ARC, /* Synopsys DesignWare ARC */
202 IH_ARCH_X86_64, /* AMD x86_64, Intel and Via */
203 IH_ARCH_XTENSA, /* Xtensa */
211 * "Standalone Programs" are directly runnable in the environment
212 * provided by U-Boot; it is expected that (if they behave
213 * well) you can continue to work in U-Boot after return from
214 * the Standalone Program.
215 * "OS Kernel Images" are usually images of some Embedded OS which
216 * will take over control completely. Usually these programs
217 * will install their own set of exception handlers, device
218 * drivers, set up the MMU, etc. - this means, that you cannot
219 * expect to re-enter U-Boot except by resetting the CPU.
220 * "RAMDisk Images" are more or less just data blocks, and their
221 * parameters (address, size) are passed to an OS kernel that is
223 * "Multi-File Images" contain several images, typically an OS
224 * (Linux) kernel image and one or more data images like
225 * RAMDisks. This construct is useful for instance when you want
226 * to boot over the network using BOOTP etc., where the boot
227 * server provides just a single image file, but you want to get
228 * for instance an OS kernel and a RAMDisk image.
230 * "Multi-File Images" start with a list of image sizes, each
231 * image size (in bytes) specified by an "uint32_t" in network
232 * byte order. This list is terminated by an "(uint32_t)0".
233 * Immediately after the terminating 0 follow the images, one by
234 * one, all aligned on "uint32_t" boundaries (size rounded up to
235 * a multiple of 4 bytes - except for the last file).
237 * "Firmware Images" are binary images containing firmware (like
238 * U-Boot or FPGA images) which usually will be programmed to
241 * "Script files" are command sequences that will be executed by
242 * U-Boot's command interpreter; this feature is especially
243 * useful when you configure U-Boot to use a real shell (hush)
244 * as command interpreter (=> Shell Scripts).
246 * The following are exposed to uImage header.
247 * Do not change values for backward compatibility.
251 IH_TYPE_INVALID = 0, /* Invalid Image */
252 IH_TYPE_STANDALONE, /* Standalone Program */
253 IH_TYPE_KERNEL, /* OS Kernel Image */
254 IH_TYPE_RAMDISK, /* RAMDisk Image */
255 IH_TYPE_MULTI, /* Multi-File Image */
256 IH_TYPE_FIRMWARE, /* Firmware Image */
257 IH_TYPE_SCRIPT, /* Script file */
258 IH_TYPE_FILESYSTEM, /* Filesystem Image (any type) */
259 IH_TYPE_FLATDT, /* Binary Flat Device Tree Blob */
260 IH_TYPE_KWBIMAGE, /* Kirkwood Boot Image */
261 IH_TYPE_IMXIMAGE, /* Freescale IMXBoot Image */
262 IH_TYPE_UBLIMAGE, /* Davinci UBL Image */
263 IH_TYPE_OMAPIMAGE, /* TI OMAP Config Header Image */
264 IH_TYPE_AISIMAGE, /* TI Davinci AIS Image */
265 /* OS Kernel Image, can run from any load address */
266 IH_TYPE_KERNEL_NOLOAD,
267 IH_TYPE_PBLIMAGE, /* Freescale PBL Boot Image */
268 IH_TYPE_MXSIMAGE, /* Freescale MXSBoot Image */
269 IH_TYPE_GPIMAGE, /* TI Keystone GPHeader Image */
270 IH_TYPE_ATMELIMAGE, /* ATMEL ROM bootable Image */
271 IH_TYPE_SOCFPGAIMAGE, /* Altera SOCFPGA Preloader */
272 IH_TYPE_X86_SETUP, /* x86 setup.bin Image */
273 IH_TYPE_LPC32XXIMAGE, /* x86 setup.bin Image */
274 IH_TYPE_LOADABLE, /* A list of typeless images */
275 IH_TYPE_RKIMAGE, /* Rockchip Boot Image */
276 IH_TYPE_RKSD, /* Rockchip SD card */
277 IH_TYPE_RKSPI, /* Rockchip SPI image */
278 IH_TYPE_ZYNQIMAGE, /* Xilinx Zynq Boot Image */
279 IH_TYPE_ZYNQMPIMAGE, /* Xilinx ZynqMP Boot Image */
280 IH_TYPE_FPGA, /* FPGA Image */
282 IH_TYPE_COUNT, /* Number of image types */
288 * The following are exposed to uImage header.
289 * Do not change values for backward compatibility.
292 IH_COMP_NONE = 0, /* No Compression Used */
293 IH_COMP_GZIP, /* gzip Compression Used */
294 IH_COMP_BZIP2, /* bzip2 Compression Used */
295 IH_COMP_LZMA, /* lzma Compression Used */
296 IH_COMP_LZO, /* lzo Compression Used */
297 IH_COMP_LZ4, /* lz4 Compression Used */
302 #define IH_MAGIC 0x27051956 /* Image Magic Number */
303 #define IH_NMLEN 32 /* Image Name Length */
305 /* Reused from common.h */
306 #define ROUND(a, b) (((a) + (b) - 1) & ~((b) - 1))
309 * Legacy format image header,
310 * all data in network byte order (aka natural aka bigendian).
312 typedef struct image_header {
313 __be32 ih_magic; /* Image Header Magic Number */
314 __be32 ih_hcrc; /* Image Header CRC Checksum */
315 __be32 ih_time; /* Image Creation Timestamp */
316 __be32 ih_size; /* Image Data Size */
317 __be32 ih_load; /* Data Load Address */
318 __be32 ih_ep; /* Entry Point Address */
319 __be32 ih_dcrc; /* Image Data CRC Checksum */
320 uint8_t ih_os; /* Operating System */
321 uint8_t ih_arch; /* CPU architecture */
322 uint8_t ih_type; /* Image Type */
323 uint8_t ih_comp; /* Compression Type */
324 uint8_t ih_name[IH_NMLEN]; /* Image Name */
327 typedef struct image_info {
328 ulong start, end; /* start/end of blob */
329 ulong image_start, image_len; /* start of image within blob, len of image */
330 ulong load; /* load addr for the image */
331 uint8_t comp, type, os; /* compression, type of image, os type */
332 uint8_t arch; /* CPU architecture */
336 * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
339 typedef struct bootm_headers {
341 * Legacy os image header, if it is a multi component image
342 * then boot_get_ramdisk() and get_fdt() will attempt to get
343 * data from second and third component accordingly.
345 image_header_t *legacy_hdr_os; /* image header pointer */
346 image_header_t legacy_hdr_os_copy; /* header copy */
347 ulong legacy_hdr_valid;
350 const char *fit_uname_cfg; /* configuration node unit name */
352 void *fit_hdr_os; /* os FIT image header */
353 const char *fit_uname_os; /* os subimage node unit name */
354 int fit_noffset_os; /* os subimage node offset */
356 void *fit_hdr_rd; /* init ramdisk FIT image header */
357 const char *fit_uname_rd; /* init ramdisk subimage node unit name */
358 int fit_noffset_rd; /* init ramdisk subimage node offset */
360 void *fit_hdr_fdt; /* FDT blob FIT image header */
361 const char *fit_uname_fdt; /* FDT blob subimage node unit name */
362 int fit_noffset_fdt;/* FDT blob subimage node offset */
364 void *fit_hdr_setup; /* x86 setup FIT image header */
365 const char *fit_uname_setup; /* x86 setup subimage node name */
366 int fit_noffset_setup;/* x86 setup subimage node offset */
370 image_info_t os; /* os image info */
371 ulong ep; /* entry point of OS */
373 ulong rd_start, rd_end;/* ramdisk start/end */
375 char *ft_addr; /* flat dev tree address */
376 ulong ft_len; /* length of flat device tree */
385 int verify; /* getenv("verify")[0] != 'n' */
387 #define BOOTM_STATE_START (0x00000001)
388 #define BOOTM_STATE_FINDOS (0x00000002)
389 #define BOOTM_STATE_FINDOTHER (0x00000004)
390 #define BOOTM_STATE_LOADOS (0x00000008)
391 #define BOOTM_STATE_RAMDISK (0x00000010)
392 #define BOOTM_STATE_FDT (0x00000020)
393 #define BOOTM_STATE_OS_CMDLINE (0x00000040)
394 #define BOOTM_STATE_OS_BD_T (0x00000080)
395 #define BOOTM_STATE_OS_PREP (0x00000100)
396 #define BOOTM_STATE_OS_FAKE_GO (0x00000200) /* 'Almost' run the OS */
397 #define BOOTM_STATE_OS_GO (0x00000400)
401 struct lmb lmb; /* for memory mgmt */
405 extern bootm_headers_t images;
408 * Some systems (for example LWMON) have very short watchdog periods;
409 * we must make sure to split long operations like memmove() or
410 * checksum calculations into reasonable chunks.
413 #define CHUNKSZ (64 * 1024)
416 #ifndef CHUNKSZ_CRC32
417 #define CHUNKSZ_CRC32 (64 * 1024)
421 #define CHUNKSZ_MD5 (64 * 1024)
425 #define CHUNKSZ_SHA1 (64 * 1024)
428 #define uimage_to_cpu(x) be32_to_cpu(x)
429 #define cpu_to_uimage(x) cpu_to_be32(x)
432 * Translation table for entries of a specific type; used by
433 * get_table_entry_id() and get_table_entry_name().
435 typedef struct table_entry {
437 char *sname; /* short (input) name to find table entry */
438 char *lname; /* long (output) name to print for messages */
442 * get_table_entry_id() scans the translation table trying to find an
443 * entry that matches the given short name. If a matching entry is
444 * found, it's id is returned to the caller.
446 int get_table_entry_id(const table_entry_t *table,
447 const char *table_name, const char *name);
449 * get_table_entry_name() scans the translation table trying to find
450 * an entry that matches the given id. If a matching entry is found,
451 * its long name is returned to the caller.
453 char *get_table_entry_name(const table_entry_t *table, char *msg, int id);
455 const char *genimg_get_os_name(uint8_t os);
458 * genimg_get_os_short_name() - get the short name for an OS
460 * @param os OS (IH_OS_...)
461 * @return OS short name, or "unknown" if unknown
463 const char *genimg_get_os_short_name(uint8_t comp);
465 const char *genimg_get_arch_name(uint8_t arch);
468 * genimg_get_arch_short_name() - get the short name for an architecture
470 * @param arch Architecture type (IH_ARCH_...)
471 * @return architecture short name, or "unknown" if unknown
473 const char *genimg_get_arch_short_name(uint8_t arch);
475 const char *genimg_get_type_name(uint8_t type);
478 * genimg_get_type_short_name() - get the short name for an image type
480 * @param type Image type (IH_TYPE_...)
481 * @return image short name, or "unknown" if unknown
483 const char *genimg_get_type_short_name(uint8_t type);
485 const char *genimg_get_comp_name(uint8_t comp);
488 * genimg_get_comp_short_name() - get the short name for a compression method
490 * @param comp compression method (IH_COMP_...)
491 * @return compression method short name, or "unknown" if unknown
493 const char *genimg_get_comp_short_name(uint8_t comp);
496 * genimg_get_cat_name() - Get the name of an item in a category
498 * @category: Category of item
500 * @return name of item, or "Unknown ..." if unknown
502 const char *genimg_get_cat_name(enum ih_category category, uint id);
505 * genimg_get_cat_short_name() - Get the short name of an item in a category
507 * @category: Category of item
509 * @return short name of item, or "Unknown ..." if unknown
511 const char *genimg_get_cat_short_name(enum ih_category category, uint id);
514 * genimg_get_cat_count() - Get the number of items in a category
516 * @category: Category to check
517 * @return the number of items in the category (IH_xxx_COUNT)
519 int genimg_get_cat_count(enum ih_category category);
522 * genimg_get_cat_desc() - Get the description of a category
524 * @return the description of a category, e.g. "architecture". This
525 * effectively converts the enum to a string.
527 const char *genimg_get_cat_desc(enum ih_category category);
529 int genimg_get_os_id(const char *name);
530 int genimg_get_arch_id(const char *name);
531 int genimg_get_type_id(const char *name);
532 int genimg_get_comp_id(const char *name);
533 void genimg_print_size(uint32_t size);
535 #if defined(CONFIG_TIMESTAMP) || defined(CONFIG_CMD_DATE) || \
537 #define IMAGE_ENABLE_TIMESTAMP 1
539 #define IMAGE_ENABLE_TIMESTAMP 0
541 void genimg_print_time(time_t timestamp);
543 /* What to do with a image load address ('load = <> 'in the FIT) */
545 FIT_LOAD_IGNORED, /* Ignore load address */
546 FIT_LOAD_OPTIONAL, /* Can be provided, but optional */
547 FIT_LOAD_OPTIONAL_NON_ZERO, /* Optional, a value of 0 is ignored */
548 FIT_LOAD_REQUIRED, /* Must be provided */
551 int boot_get_setup(bootm_headers_t *images, uint8_t arch, ulong *setup_start,
555 /* Image format types, returned by _get_format() routine */
556 #define IMAGE_FORMAT_INVALID 0x00
557 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
558 #define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */
560 #define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */
561 #define IMAGE_FORMAT_ANDROID 0x03 /* Android boot image */
563 ulong genimg_get_kernel_addr_fit(char * const img_addr,
564 const char **fit_uname_config,
565 const char **fit_uname_kernel);
566 ulong genimg_get_kernel_addr(char * const img_addr);
567 int genimg_get_format(const void *img_addr);
568 int genimg_has_config(bootm_headers_t *images);
569 ulong genimg_get_image(ulong img_addr);
571 int boot_get_fpga(int argc, char * const argv[], bootm_headers_t *images,
572 uint8_t arch, const ulong *ld_start, ulong * const ld_len);
573 int boot_get_ramdisk(int argc, char * const argv[], bootm_headers_t *images,
574 uint8_t arch, ulong *rd_start, ulong *rd_end);
577 * boot_get_loadable - routine to load a list of binaries to memory
578 * @argc: Ignored Argument
579 * @argv: Ignored Argument
580 * @images: pointer to the bootm images structure
581 * @arch: expected architecture for the image
582 * @ld_start: Ignored Argument
583 * @ld_len: Ignored Argument
585 * boot_get_loadable() will take the given FIT configuration, and look
586 * for a field named "loadables". Loadables, is a list of elements in
587 * the FIT given as strings. exe:
588 * loadables = "linux_kernel@1", "fdt@2";
589 * this function will attempt to parse each string, and load the
590 * corresponding element from the FIT into memory. Once placed,
591 * no aditional actions are taken.
594 * 0, if only valid images or no images are found
595 * error code, if an error occurs during fit_image_load
597 int boot_get_loadable(int argc, char * const argv[], bootm_headers_t *images,
598 uint8_t arch, const ulong *ld_start, ulong * const ld_len);
599 #endif /* !USE_HOSTCC */
601 int boot_get_setup_fit(bootm_headers_t *images, uint8_t arch,
602 ulong *setup_start, ulong *setup_len);
605 * fit_image_load() - load an image from a FIT
607 * This deals with all aspects of loading an image from a FIT, including
608 * selecting the right image based on configuration, verifying it, printing
609 * out progress messages, checking the type/arch/os and optionally copying it
610 * to the right load address.
612 * The property to look up is defined by image_type.
614 * @param images Boot images structure
615 * @param addr Address of FIT in memory
616 * @param fit_unamep On entry this is the requested image name
617 * (e.g. "kernel@1") or NULL to use the default. On exit
618 * points to the selected image name
619 * @param fit_uname_configp On entry this is the requested configuration
620 * name (e.g. "conf@1") or NULL to use the default. On
621 * exit points to the selected configuration name.
622 * @param arch Expected architecture (IH_ARCH_...)
623 * @param image_type Required image type (IH_TYPE_...). If this is
624 * IH_TYPE_KERNEL then we allow IH_TYPE_KERNEL_NOLOAD
626 * @param bootstage_id ID of starting bootstage to use for progress updates.
627 * This will be added to the BOOTSTAGE_SUB values when
628 * calling bootstage_mark()
629 * @param load_op Decribes what to do with the load address
630 * @param datap Returns address of loaded image
631 * @param lenp Returns length of loaded image
632 * @return node offset of image, or -ve error code on error
634 int fit_image_load(bootm_headers_t *images, ulong addr,
635 const char **fit_unamep, const char **fit_uname_configp,
636 int arch, int image_type, int bootstage_id,
637 enum fit_load_op load_op, ulong *datap, ulong *lenp);
641 * fit_get_node_from_config() - Look up an image a FIT by type
643 * This looks in the selected conf@ node (images->fit_uname_cfg) for a
644 * particular image type (e.g. "kernel") and then finds the image that is
647 * For example, for something like:
656 * kernel = "kernel@1";
660 * the function will return the node offset of the kernel@1 node, assuming
661 * that conf@1 is the chosen configuration.
663 * @param images Boot images structure
664 * @param prop_name Property name to look up (FIT_..._PROP)
665 * @param addr Address of FIT in memory
667 int fit_get_node_from_config(bootm_headers_t *images, const char *prop_name,
670 int boot_get_fdt(int flag, int argc, char * const argv[], uint8_t arch,
671 bootm_headers_t *images,
672 char **of_flat_tree, ulong *of_size);
673 void boot_fdt_add_mem_rsv_regions(struct lmb *lmb, void *fdt_blob);
674 int boot_relocate_fdt(struct lmb *lmb, char **of_flat_tree, ulong *of_size);
676 int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len,
677 ulong *initrd_start, ulong *initrd_end);
678 int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end);
679 #ifdef CONFIG_SYS_BOOT_GET_KBD
680 int boot_get_kbd(struct lmb *lmb, bd_t **kbd);
681 #endif /* CONFIG_SYS_BOOT_GET_KBD */
682 #endif /* !USE_HOSTCC */
684 /*******************************************************************/
685 /* Legacy format specific code (prefixed with image_) */
686 /*******************************************************************/
687 static inline uint32_t image_get_header_size(void)
689 return (sizeof(image_header_t));
692 #define image_get_hdr_l(f) \
693 static inline uint32_t image_get_##f(const image_header_t *hdr) \
695 return uimage_to_cpu(hdr->ih_##f); \
697 image_get_hdr_l(magic) /* image_get_magic */
698 image_get_hdr_l(hcrc) /* image_get_hcrc */
699 image_get_hdr_l(time) /* image_get_time */
700 image_get_hdr_l(size) /* image_get_size */
701 image_get_hdr_l(load) /* image_get_load */
702 image_get_hdr_l(ep) /* image_get_ep */
703 image_get_hdr_l(dcrc) /* image_get_dcrc */
705 #define image_get_hdr_b(f) \
706 static inline uint8_t image_get_##f(const image_header_t *hdr) \
708 return hdr->ih_##f; \
710 image_get_hdr_b(os) /* image_get_os */
711 image_get_hdr_b(arch) /* image_get_arch */
712 image_get_hdr_b(type) /* image_get_type */
713 image_get_hdr_b(comp) /* image_get_comp */
715 static inline char *image_get_name(const image_header_t *hdr)
717 return (char *)hdr->ih_name;
720 static inline uint32_t image_get_data_size(const image_header_t *hdr)
722 return image_get_size(hdr);
726 * image_get_data - get image payload start address
729 * image_get_data() returns address of the image payload. For single
730 * component images it is image data start. For multi component
731 * images it points to the null terminated table of sub-images sizes.
734 * image payload data start address
736 static inline ulong image_get_data(const image_header_t *hdr)
738 return ((ulong)hdr + image_get_header_size());
741 static inline uint32_t image_get_image_size(const image_header_t *hdr)
743 return (image_get_size(hdr) + image_get_header_size());
745 static inline ulong image_get_image_end(const image_header_t *hdr)
747 return ((ulong)hdr + image_get_image_size(hdr));
750 #define image_set_hdr_l(f) \
751 static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
753 hdr->ih_##f = cpu_to_uimage(val); \
755 image_set_hdr_l(magic) /* image_set_magic */
756 image_set_hdr_l(hcrc) /* image_set_hcrc */
757 image_set_hdr_l(time) /* image_set_time */
758 image_set_hdr_l(size) /* image_set_size */
759 image_set_hdr_l(load) /* image_set_load */
760 image_set_hdr_l(ep) /* image_set_ep */
761 image_set_hdr_l(dcrc) /* image_set_dcrc */
763 #define image_set_hdr_b(f) \
764 static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
768 image_set_hdr_b(os) /* image_set_os */
769 image_set_hdr_b(arch) /* image_set_arch */
770 image_set_hdr_b(type) /* image_set_type */
771 image_set_hdr_b(comp) /* image_set_comp */
773 static inline void image_set_name(image_header_t *hdr, const char *name)
775 strncpy(image_get_name(hdr), name, IH_NMLEN);
778 int image_check_hcrc(const image_header_t *hdr);
779 int image_check_dcrc(const image_header_t *hdr);
781 ulong getenv_bootm_low(void);
782 phys_size_t getenv_bootm_size(void);
783 phys_size_t getenv_bootm_mapsize(void);
785 void memmove_wd(void *to, void *from, size_t len, ulong chunksz);
787 static inline int image_check_magic(const image_header_t *hdr)
789 return (image_get_magic(hdr) == IH_MAGIC);
791 static inline int image_check_type(const image_header_t *hdr, uint8_t type)
793 return (image_get_type(hdr) == type);
795 static inline int image_check_arch(const image_header_t *hdr, uint8_t arch)
797 return (image_get_arch(hdr) == arch);
799 static inline int image_check_os(const image_header_t *hdr, uint8_t os)
801 return (image_get_os(hdr) == os);
804 ulong image_multi_count(const image_header_t *hdr);
805 void image_multi_getimg(const image_header_t *hdr, ulong idx,
806 ulong *data, ulong *len);
808 void image_print_contents(const void *hdr);
811 static inline int image_check_target_arch(const image_header_t *hdr)
813 #ifndef IH_ARCH_DEFAULT
814 # error "please define IH_ARCH_DEFAULT in your arch asm/u-boot.h"
816 return image_check_arch(hdr, IH_ARCH_DEFAULT);
818 #endif /* USE_HOSTCC */
821 * Set up properties in the FDT
823 * This sets up properties in the FDT that is to be passed to linux.
825 * @images: Images information
826 * @blob: FDT to update
827 * @of_size: Size of the FDT
828 * @lmb: Points to logical memory block structure
829 * @return 0 if ok, <0 on failure
831 int image_setup_libfdt(bootm_headers_t *images, void *blob,
832 int of_size, struct lmb *lmb);
835 * Set up the FDT to use for booting a kernel
837 * This performs ramdisk setup, sets up the FDT if required, and adds
838 * paramters to the FDT if libfdt is available.
840 * @param images Images information
841 * @return 0 if ok, <0 on failure
843 int image_setup_linux(bootm_headers_t *images);
846 * bootz_setup() - Extract stat and size of a Linux xImage
848 * @image: Address of image
849 * @start: Returns start address of image
850 * @end : Returns end address of image
851 * @return 0 if OK, 1 if the image was not recognised
853 int bootz_setup(ulong image, ulong *start, ulong *end);
856 /*******************************************************************/
857 /* New uImage format specific code (prefixed with fit_) */
858 /*******************************************************************/
860 #define FIT_IMAGES_PATH "/images"
861 #define FIT_CONFS_PATH "/configurations"
863 /* hash/signature node */
864 #define FIT_HASH_NODENAME "hash"
865 #define FIT_ALGO_PROP "algo"
866 #define FIT_VALUE_PROP "value"
867 #define FIT_IGNORE_PROP "uboot-ignore"
868 #define FIT_SIG_NODENAME "signature"
871 #define FIT_DATA_PROP "data"
872 #define FIT_TIMESTAMP_PROP "timestamp"
873 #define FIT_DESC_PROP "description"
874 #define FIT_ARCH_PROP "arch"
875 #define FIT_TYPE_PROP "type"
876 #define FIT_OS_PROP "os"
877 #define FIT_COMP_PROP "compression"
878 #define FIT_ENTRY_PROP "entry"
879 #define FIT_LOAD_PROP "load"
881 /* configuration node */
882 #define FIT_KERNEL_PROP "kernel"
883 #define FIT_RAMDISK_PROP "ramdisk"
884 #define FIT_FDT_PROP "fdt"
885 #define FIT_LOADABLE_PROP "loadables"
886 #define FIT_DEFAULT_PROP "default"
887 #define FIT_SETUP_PROP "setup"
888 #define FIT_FPGA_PROP "fpga"
890 #define FIT_MAX_HASH_LEN HASH_MAX_DIGEST_SIZE
893 /* cmdline argument format parsing */
894 int fit_parse_conf(const char *spec, ulong addr_curr,
895 ulong *addr, const char **conf_name);
896 int fit_parse_subimage(const char *spec, ulong addr_curr,
897 ulong *addr, const char **image_name);
899 int fit_get_subimage_count(const void *fit, int images_noffset);
900 void fit_print_contents(const void *fit);
901 void fit_image_print(const void *fit, int noffset, const char *p);
904 * fit_get_end - get FIT image size
905 * @fit: pointer to the FIT format image header
908 * size of the FIT image (blob) in memory
910 static inline ulong fit_get_size(const void *fit)
912 return fdt_totalsize(fit);
916 * fit_get_end - get FIT image end
917 * @fit: pointer to the FIT format image header
920 * end address of the FIT image (blob) in memory
922 ulong fit_get_end(const void *fit);
925 * fit_get_name - get FIT node name
926 * @fit: pointer to the FIT format image header
930 * pointer to node name, on success
932 static inline const char *fit_get_name(const void *fit_hdr,
933 int noffset, int *len)
935 return fdt_get_name(fit_hdr, noffset, len);
938 int fit_get_desc(const void *fit, int noffset, char **desc);
939 int fit_get_timestamp(const void *fit, int noffset, time_t *timestamp);
941 int fit_image_get_node(const void *fit, const char *image_uname);
942 int fit_image_get_os(const void *fit, int noffset, uint8_t *os);
943 int fit_image_get_arch(const void *fit, int noffset, uint8_t *arch);
944 int fit_image_get_type(const void *fit, int noffset, uint8_t *type);
945 int fit_image_get_comp(const void *fit, int noffset, uint8_t *comp);
946 int fit_image_get_load(const void *fit, int noffset, ulong *load);
947 int fit_image_get_entry(const void *fit, int noffset, ulong *entry);
948 int fit_image_get_data(const void *fit, int noffset,
949 const void **data, size_t *size);
951 int fit_image_hash_get_algo(const void *fit, int noffset, char **algo);
952 int fit_image_hash_get_value(const void *fit, int noffset, uint8_t **value,
955 int fit_set_timestamp(void *fit, int noffset, time_t timestamp);
958 * fit_add_verification_data() - add verification data to FIT image nodes
960 * @keydir: Directory containing keys
961 * @kwydest: FDT blob to write public key information to
962 * @fit: Pointer to the FIT format image header
963 * @comment: Comment to add to signature nodes
964 * @require_keys: Mark all keys as 'required'
966 * Adds hash values for all component images in the FIT blob.
967 * Hashes are calculated for all component images which have hash subnodes
968 * with algorithm property set to one of the supported hash algorithms.
970 * Also add signatures if signature nodes are present.
974 * libfdt error code, on failure
976 int fit_add_verification_data(const char *keydir, void *keydest, void *fit,
977 const char *comment, int require_keys);
979 int fit_image_verify(const void *fit, int noffset);
980 int fit_config_verify(const void *fit, int conf_noffset);
981 int fit_all_image_verify(const void *fit);
982 int fit_image_check_os(const void *fit, int noffset, uint8_t os);
983 int fit_image_check_arch(const void *fit, int noffset, uint8_t arch);
984 int fit_image_check_type(const void *fit, int noffset, uint8_t type);
985 int fit_image_check_comp(const void *fit, int noffset, uint8_t comp);
986 int fit_check_format(const void *fit);
988 int fit_conf_find_compat(const void *fit, const void *fdt);
989 int fit_conf_get_node(const void *fit, const char *conf_uname);
992 * fit_conf_get_prop_node() - Get node refered to by a configuration
994 * @noffset: Offset of conf@xxx node to check
995 * @prop_name: Property to read from the conf node
997 * The conf@ nodes contain references to other nodes, using properties
998 * like 'kernel = "kernel@1"'. Given such a property name (e.g. "kernel"),
999 * return the offset of the node referred to (e.g. offset of node
1000 * "/images/kernel@1".
1002 int fit_conf_get_prop_node(const void *fit, int noffset,
1003 const char *prop_name);
1005 void fit_conf_print(const void *fit, int noffset, const char *p);
1007 int fit_check_ramdisk(const void *fit, int os_noffset,
1008 uint8_t arch, int verify);
1010 int calculate_hash(const void *data, int data_len, const char *algo,
1011 uint8_t *value, int *value_len);
1014 * At present we only support signing on the host, and verification on the
1017 #if defined(CONFIG_FIT_SIGNATURE)
1019 # define IMAGE_ENABLE_SIGN 1
1020 # define IMAGE_ENABLE_VERIFY 1
1021 # include <openssl/evp.h>
1023 # define IMAGE_ENABLE_SIGN 0
1024 # define IMAGE_ENABLE_VERIFY 1
1027 # define IMAGE_ENABLE_SIGN 0
1028 # define IMAGE_ENABLE_VERIFY 0
1032 void *image_get_host_blob(void);
1033 void image_set_host_blob(void *host_blob);
1034 # define gd_fdt_blob() image_get_host_blob()
1036 # define gd_fdt_blob() (gd->fdt_blob)
1039 #ifdef CONFIG_FIT_BEST_MATCH
1040 #define IMAGE_ENABLE_BEST_MATCH 1
1042 #define IMAGE_ENABLE_BEST_MATCH 0
1045 /* Information passed to the signing routines */
1046 struct image_sign_info {
1047 const char *keydir; /* Directory conaining keys */
1048 const char *keyname; /* Name of key to use */
1049 void *fit; /* Pointer to FIT blob */
1050 int node_offset; /* Offset of signature node */
1051 struct image_sig_algo *algo; /* Algorithm information */
1052 const void *fdt_blob; /* FDT containing public keys */
1053 int required_keynode; /* Node offset of key to use: -1=any */
1054 const char *require_keys; /* Value for 'required' property */
1056 #endif /* Allow struct image_region to always be defined for rsa.h */
1058 /* A part of an image, used for hashing */
1059 struct image_region {
1064 #if IMAGE_ENABLE_FIT
1066 #if IMAGE_ENABLE_VERIFY
1067 # include <u-boot/rsa-checksum.h>
1069 struct checksum_algo {
1071 const int checksum_len;
1073 #if IMAGE_ENABLE_SIGN
1074 const EVP_MD *(*calculate_sign)(void);
1076 int (*calculate)(const char *name,
1077 const struct image_region region[],
1078 int region_count, uint8_t *checksum);
1079 const uint8_t *rsa_padding;
1082 struct image_sig_algo {
1083 const char *name; /* Name of algorithm */
1086 * sign() - calculate and return signature for given input data
1088 * @info: Specifies key and FIT information
1089 * @data: Pointer to the input data
1090 * @data_len: Data length
1091 * @sigp: Set to an allocated buffer holding the signature
1092 * @sig_len: Set to length of the calculated hash
1094 * This computes input data signature according to selected algorithm.
1095 * Resulting signature value is placed in an allocated buffer, the
1096 * pointer is returned as *sigp. The length of the calculated
1097 * signature is returned via the sig_len pointer argument. The caller
1098 * should free *sigp.
1100 * @return: 0, on success, -ve on error
1102 int (*sign)(struct image_sign_info *info,
1103 const struct image_region region[],
1104 int region_count, uint8_t **sigp, uint *sig_len);
1107 * add_verify_data() - Add verification information to FDT
1109 * Add public key information to the FDT node, suitable for
1110 * verification at run-time. The information added depends on the
1111 * algorithm being used.
1113 * @info: Specifies key and FIT information
1114 * @keydest: Destination FDT blob for public key data
1115 * @return: 0, on success, -ve on error
1117 int (*add_verify_data)(struct image_sign_info *info, void *keydest);
1120 * verify() - Verify a signature against some data
1122 * @info: Specifies key and FIT information
1123 * @data: Pointer to the input data
1124 * @data_len: Data length
1126 * @sig_len: Number of bytes in signature
1127 * @return 0 if verified, -ve on error
1129 int (*verify)(struct image_sign_info *info,
1130 const struct image_region region[], int region_count,
1131 uint8_t *sig, uint sig_len);
1133 /* pointer to checksum algorithm */
1134 struct checksum_algo *checksum;
1138 * image_get_sig_algo() - Look up a signature algortihm
1140 * @param name Name of algorithm
1141 * @return pointer to algorithm information, or NULL if not found
1143 struct image_sig_algo *image_get_sig_algo(const char *name);
1146 * fit_image_verify_required_sigs() - Verify signatures marked as 'required'
1148 * @fit: FIT to check
1149 * @image_noffset: Offset of image node to check
1150 * @data: Image data to check
1151 * @size: Size of image data
1152 * @sig_blob: FDT containing public keys
1153 * @no_sigsp: Returns 1 if no signatures were required, and
1154 * therefore nothing was checked. The caller may wish
1155 * to fall back to other mechanisms, or refuse to
1157 * @return 0 if all verified ok, <0 on error
1159 int fit_image_verify_required_sigs(const void *fit, int image_noffset,
1160 const char *data, size_t size, const void *sig_blob,
1164 * fit_image_check_sig() - Check a single image signature node
1166 * @fit: FIT to check
1167 * @noffset: Offset of signature node to check
1168 * @data: Image data to check
1169 * @size: Size of image data
1170 * @required_keynode: Offset in the control FDT of the required key node,
1171 * if any. If this is given, then the image wil not
1172 * pass verification unless that key is used. If this is
1173 * -1 then any signature will do.
1174 * @err_msgp: In the event of an error, this will be pointed to a
1175 * help error string to display to the user.
1176 * @return 0 if all verified ok, <0 on error
1178 int fit_image_check_sig(const void *fit, int noffset, const void *data,
1179 size_t size, int required_keynode, char **err_msgp);
1182 * fit_region_make_list() - Make a list of regions to hash
1184 * Given a list of FIT regions (offset, size) provided by libfdt, create
1185 * a list of regions (void *, size) for use by the signature creationg
1186 * and verification code.
1188 * @fit: FIT image to process
1189 * @fdt_regions: Regions as returned by libfdt
1190 * @count: Number of regions returned by libfdt
1191 * @region: Place to put list of regions (NULL to allocate it)
1192 * @return pointer to list of regions, or NULL if out of memory
1194 struct image_region *fit_region_make_list(const void *fit,
1195 struct fdt_region *fdt_regions, int count,
1196 struct image_region *region);
1198 static inline int fit_image_check_target_arch(const void *fdt, int node)
1201 return fit_image_check_arch(fdt, node, IH_ARCH_DEFAULT);
1207 #ifdef CONFIG_FIT_VERBOSE
1208 #define fit_unsupported(msg) printf("! %s:%d " \
1209 "FIT images not supported for '%s'\n", \
1210 __FILE__, __LINE__, (msg))
1212 #define fit_unsupported_reset(msg) printf("! %s:%d " \
1213 "FIT images not supported for '%s' " \
1214 "- must reset board to recover!\n", \
1215 __FILE__, __LINE__, (msg))
1217 #define fit_unsupported(msg)
1218 #define fit_unsupported_reset(msg)
1219 #endif /* CONFIG_FIT_VERBOSE */
1220 #endif /* CONFIG_FIT */
1222 #if defined(CONFIG_ANDROID_BOOT_IMAGE)
1223 struct andr_img_hdr;
1224 int android_image_check_header(const struct andr_img_hdr *hdr);
1225 int android_image_get_kernel(const struct andr_img_hdr *hdr, int verify,
1226 ulong *os_data, ulong *os_len);
1227 int android_image_get_ramdisk(const struct andr_img_hdr *hdr,
1228 ulong *rd_data, ulong *rd_len);
1229 ulong android_image_get_end(const struct andr_img_hdr *hdr);
1230 ulong android_image_get_kload(const struct andr_img_hdr *hdr);
1231 void android_print_contents(const struct andr_img_hdr *hdr);
1233 #endif /* CONFIG_ANDROID_BOOT_IMAGE */
1236 * board_fit_config_name_match() - Check for a matching board name
1238 * This is used when SPL loads a FIT containing multiple device tree files
1239 * and wants to work out which one to use. The description of each one is
1240 * passed to this function. The description comes from the 'description' field
1241 * in each (FDT) image node.
1243 * @name: Device tree description
1244 * @return 0 if this device tree should be used, non-zero to try the next
1246 int board_fit_config_name_match(const char *name);
1248 #ifdef CONFIG_SPL_FIT_IMAGE_POST_PROCESS
1250 * board_fit_image_post_process() - Do any post-process on FIT binary data
1252 * This is used to do any sort of image manipulation, verification, decryption
1253 * etc. in a platform or board specific way. Obviously, anything done here would
1254 * need to be comprehended in how the images were prepared before being injected
1255 * into the FIT creation (i.e. the binary blobs would have been pre-processed
1256 * before being added to the FIT image).
1258 * @image: pointer to the image start pointer
1259 * @size: pointer to the image size
1260 * @return no return value (failure should be handled internally)
1262 void board_fit_image_post_process(void **p_image, size_t *p_size);
1263 #endif /* CONFIG_SPL_FIT_IMAGE_POST_PROCESS */
1265 #endif /* __IMAGE_H__ */