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
139 IH_OS_INVALID = 0, /* Invalid OS */
140 IH_OS_OPENBSD, /* OpenBSD */
141 IH_OS_NETBSD, /* NetBSD */
142 IH_OS_FREEBSD, /* FreeBSD */
143 IH_OS_4_4BSD, /* 4.4BSD */
144 IH_OS_LINUX, /* Linux */
145 IH_OS_SVR4, /* SVR4 */
146 IH_OS_ESIX, /* Esix */
147 IH_OS_SOLARIS, /* Solaris */
148 IH_OS_IRIX, /* Irix */
150 IH_OS_DELL, /* Dell */
152 IH_OS_LYNXOS, /* LynxOS */
153 IH_OS_VXWORKS, /* VxWorks */
154 IH_OS_PSOS, /* pSOS */
156 IH_OS_U_BOOT, /* Firmware */
157 IH_OS_RTEMS, /* RTEMS */
158 IH_OS_ARTOS, /* ARTOS */
159 IH_OS_UNITY, /* Unity OS */
160 IH_OS_INTEGRITY, /* INTEGRITY */
162 IH_OS_PLAN9, /* Plan 9 */
163 IH_OS_OPENRTOS, /* OpenRTOS */
169 * CPU Architecture Codes (supported by Linux)
172 IH_ARCH_INVALID = 0, /* Invalid CPU */
173 IH_ARCH_ALPHA, /* Alpha */
174 IH_ARCH_ARM, /* ARM */
175 IH_ARCH_I386, /* Intel x86 */
176 IH_ARCH_IA64, /* IA64 */
177 IH_ARCH_MIPS, /* MIPS */
178 IH_ARCH_MIPS64, /* MIPS 64 Bit */
179 IH_ARCH_PPC, /* PowerPC */
180 IH_ARCH_S390, /* IBM S390 */
181 IH_ARCH_SH, /* SuperH */
182 IH_ARCH_SPARC, /* Sparc */
183 IH_ARCH_SPARC64, /* Sparc 64 Bit */
184 IH_ARCH_M68K, /* M68K */
185 IH_ARCH_MICROBLAZE, /* MicroBlaze */
186 IH_ARCH_NIOS2, /* Nios-II */
187 IH_ARCH_BLACKFIN, /* Blackfin */
188 IH_ARCH_AVR32, /* AVR32 */
189 IH_ARCH_ST200, /* STMicroelectronics ST200 */
190 IH_ARCH_SANDBOX, /* Sandbox architecture (test only) */
191 IH_ARCH_NDS32, /* ANDES Technology - NDS32 */
192 IH_ARCH_OPENRISC, /* OpenRISC 1000 */
193 IH_ARCH_ARM64, /* ARM64 */
194 IH_ARCH_ARC, /* Synopsys DesignWare ARC */
195 IH_ARCH_X86_64, /* AMD x86_64, Intel and Via */
203 * "Standalone Programs" are directly runnable in the environment
204 * provided by U-Boot; it is expected that (if they behave
205 * well) you can continue to work in U-Boot after return from
206 * the Standalone Program.
207 * "OS Kernel Images" are usually images of some Embedded OS which
208 * will take over control completely. Usually these programs
209 * will install their own set of exception handlers, device
210 * drivers, set up the MMU, etc. - this means, that you cannot
211 * expect to re-enter U-Boot except by resetting the CPU.
212 * "RAMDisk Images" are more or less just data blocks, and their
213 * parameters (address, size) are passed to an OS kernel that is
215 * "Multi-File Images" contain several images, typically an OS
216 * (Linux) kernel image and one or more data images like
217 * RAMDisks. This construct is useful for instance when you want
218 * to boot over the network using BOOTP etc., where the boot
219 * server provides just a single image file, but you want to get
220 * for instance an OS kernel and a RAMDisk image.
222 * "Multi-File Images" start with a list of image sizes, each
223 * image size (in bytes) specified by an "uint32_t" in network
224 * byte order. This list is terminated by an "(uint32_t)0".
225 * Immediately after the terminating 0 follow the images, one by
226 * one, all aligned on "uint32_t" boundaries (size rounded up to
227 * a multiple of 4 bytes - except for the last file).
229 * "Firmware Images" are binary images containing firmware (like
230 * U-Boot or FPGA images) which usually will be programmed to
233 * "Script files" are command sequences that will be executed by
234 * U-Boot's command interpreter; this feature is especially
235 * useful when you configure U-Boot to use a real shell (hush)
236 * as command interpreter (=> Shell Scripts).
240 IH_TYPE_INVALID = 0, /* Invalid Image */
241 IH_TYPE_STANDALONE, /* Standalone Program */
242 IH_TYPE_KERNEL, /* OS Kernel Image */
243 IH_TYPE_RAMDISK, /* RAMDisk Image */
244 IH_TYPE_MULTI, /* Multi-File Image */
245 IH_TYPE_FIRMWARE, /* Firmware Image */
246 IH_TYPE_SCRIPT, /* Script file */
247 IH_TYPE_FILESYSTEM, /* Filesystem Image (any type) */
248 IH_TYPE_FLATDT, /* Binary Flat Device Tree Blob */
249 IH_TYPE_KWBIMAGE, /* Kirkwood Boot Image */
250 IH_TYPE_IMXIMAGE, /* Freescale IMXBoot Image */
251 IH_TYPE_UBLIMAGE, /* Davinci UBL Image */
252 IH_TYPE_OMAPIMAGE, /* TI OMAP Config Header Image */
253 IH_TYPE_AISIMAGE, /* TI Davinci AIS Image */
254 /* OS Kernel Image, can run from any load address */
255 IH_TYPE_KERNEL_NOLOAD,
256 IH_TYPE_PBLIMAGE, /* Freescale PBL Boot Image */
257 IH_TYPE_MXSIMAGE, /* Freescale MXSBoot Image */
258 IH_TYPE_GPIMAGE, /* TI Keystone GPHeader Image */
259 IH_TYPE_ATMELIMAGE, /* ATMEL ROM bootable Image */
260 IH_TYPE_SOCFPGAIMAGE, /* Altera SOCFPGA Preloader */
261 IH_TYPE_X86_SETUP, /* x86 setup.bin Image */
262 IH_TYPE_LPC32XXIMAGE, /* x86 setup.bin Image */
263 IH_TYPE_LOADABLE, /* A list of typeless images */
264 IH_TYPE_RKIMAGE, /* Rockchip Boot Image */
265 IH_TYPE_RKSD, /* Rockchip SD card */
266 IH_TYPE_RKSPI, /* Rockchip SPI image */
267 IH_TYPE_ZYNQIMAGE, /* Xilinx Zynq Boot Image */
268 IH_TYPE_ZYNQMPIMAGE, /* Xilinx ZynqMP Boot Image */
269 IH_TYPE_FPGA, /* FPGA Image */
271 IH_TYPE_COUNT, /* Number of image types */
278 IH_COMP_NONE = 0, /* No Compression Used */
279 IH_COMP_GZIP, /* gzip Compression Used */
280 IH_COMP_BZIP2, /* bzip2 Compression Used */
281 IH_COMP_LZMA, /* lzma Compression Used */
282 IH_COMP_LZO, /* lzo Compression Used */
283 IH_COMP_LZ4, /* lz4 Compression Used */
288 #define IH_MAGIC 0x27051956 /* Image Magic Number */
289 #define IH_NMLEN 32 /* Image Name Length */
291 /* Reused from common.h */
292 #define ROUND(a, b) (((a) + (b) - 1) & ~((b) - 1))
295 * Legacy format image header,
296 * all data in network byte order (aka natural aka bigendian).
298 typedef struct image_header {
299 __be32 ih_magic; /* Image Header Magic Number */
300 __be32 ih_hcrc; /* Image Header CRC Checksum */
301 __be32 ih_time; /* Image Creation Timestamp */
302 __be32 ih_size; /* Image Data Size */
303 __be32 ih_load; /* Data Load Address */
304 __be32 ih_ep; /* Entry Point Address */
305 __be32 ih_dcrc; /* Image Data CRC Checksum */
306 uint8_t ih_os; /* Operating System */
307 uint8_t ih_arch; /* CPU architecture */
308 uint8_t ih_type; /* Image Type */
309 uint8_t ih_comp; /* Compression Type */
310 uint8_t ih_name[IH_NMLEN]; /* Image Name */
313 typedef struct image_info {
314 ulong start, end; /* start/end of blob */
315 ulong image_start, image_len; /* start of image within blob, len of image */
316 ulong load; /* load addr for the image */
317 uint8_t comp, type, os; /* compression, type of image, os type */
318 uint8_t arch; /* CPU architecture */
322 * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
325 typedef struct bootm_headers {
327 * Legacy os image header, if it is a multi component image
328 * then boot_get_ramdisk() and get_fdt() will attempt to get
329 * data from second and third component accordingly.
331 image_header_t *legacy_hdr_os; /* image header pointer */
332 image_header_t legacy_hdr_os_copy; /* header copy */
333 ulong legacy_hdr_valid;
336 const char *fit_uname_cfg; /* configuration node unit name */
338 void *fit_hdr_os; /* os FIT image header */
339 const char *fit_uname_os; /* os subimage node unit name */
340 int fit_noffset_os; /* os subimage node offset */
342 void *fit_hdr_rd; /* init ramdisk FIT image header */
343 const char *fit_uname_rd; /* init ramdisk subimage node unit name */
344 int fit_noffset_rd; /* init ramdisk subimage node offset */
346 void *fit_hdr_fdt; /* FDT blob FIT image header */
347 const char *fit_uname_fdt; /* FDT blob subimage node unit name */
348 int fit_noffset_fdt;/* FDT blob subimage node offset */
350 void *fit_hdr_setup; /* x86 setup FIT image header */
351 const char *fit_uname_setup; /* x86 setup subimage node name */
352 int fit_noffset_setup;/* x86 setup subimage node offset */
356 image_info_t os; /* os image info */
357 ulong ep; /* entry point of OS */
359 ulong rd_start, rd_end;/* ramdisk start/end */
361 char *ft_addr; /* flat dev tree address */
362 ulong ft_len; /* length of flat device tree */
371 int verify; /* getenv("verify")[0] != 'n' */
373 #define BOOTM_STATE_START (0x00000001)
374 #define BOOTM_STATE_FINDOS (0x00000002)
375 #define BOOTM_STATE_FINDOTHER (0x00000004)
376 #define BOOTM_STATE_LOADOS (0x00000008)
377 #define BOOTM_STATE_RAMDISK (0x00000010)
378 #define BOOTM_STATE_FDT (0x00000020)
379 #define BOOTM_STATE_OS_CMDLINE (0x00000040)
380 #define BOOTM_STATE_OS_BD_T (0x00000080)
381 #define BOOTM_STATE_OS_PREP (0x00000100)
382 #define BOOTM_STATE_OS_FAKE_GO (0x00000200) /* 'Almost' run the OS */
383 #define BOOTM_STATE_OS_GO (0x00000400)
387 struct lmb lmb; /* for memory mgmt */
391 extern bootm_headers_t images;
394 * Some systems (for example LWMON) have very short watchdog periods;
395 * we must make sure to split long operations like memmove() or
396 * checksum calculations into reasonable chunks.
399 #define CHUNKSZ (64 * 1024)
402 #ifndef CHUNKSZ_CRC32
403 #define CHUNKSZ_CRC32 (64 * 1024)
407 #define CHUNKSZ_MD5 (64 * 1024)
411 #define CHUNKSZ_SHA1 (64 * 1024)
414 #define uimage_to_cpu(x) be32_to_cpu(x)
415 #define cpu_to_uimage(x) cpu_to_be32(x)
418 * Translation table for entries of a specific type; used by
419 * get_table_entry_id() and get_table_entry_name().
421 typedef struct table_entry {
423 char *sname; /* short (input) name to find table entry */
424 char *lname; /* long (output) name to print for messages */
428 * get_table_entry_id() scans the translation table trying to find an
429 * entry that matches the given short name. If a matching entry is
430 * found, it's id is returned to the caller.
432 int get_table_entry_id(const table_entry_t *table,
433 const char *table_name, const char *name);
435 * get_table_entry_name() scans the translation table trying to find
436 * an entry that matches the given id. If a matching entry is found,
437 * its long name is returned to the caller.
439 char *get_table_entry_name(const table_entry_t *table, char *msg, int id);
441 const char *genimg_get_os_name(uint8_t os);
444 * genimg_get_os_short_name() - get the short name for an OS
446 * @param os OS (IH_OS_...)
447 * @return OS short name, or "unknown" if unknown
449 const char *genimg_get_os_short_name(uint8_t comp);
451 const char *genimg_get_arch_name(uint8_t arch);
454 * genimg_get_arch_short_name() - get the short name for an architecture
456 * @param arch Architecture type (IH_ARCH_...)
457 * @return architecture short name, or "unknown" if unknown
459 const char *genimg_get_arch_short_name(uint8_t arch);
461 const char *genimg_get_type_name(uint8_t type);
464 * genimg_get_type_short_name() - get the short name for an image type
466 * @param type Image type (IH_TYPE_...)
467 * @return image short name, or "unknown" if unknown
469 const char *genimg_get_type_short_name(uint8_t type);
471 const char *genimg_get_comp_name(uint8_t comp);
474 * genimg_get_comp_short_name() - get the short name for a compression method
476 * @param comp compression method (IH_COMP_...)
477 * @return compression method short name, or "unknown" if unknown
479 const char *genimg_get_comp_short_name(uint8_t comp);
481 int genimg_get_os_id(const char *name);
482 int genimg_get_arch_id(const char *name);
483 int genimg_get_type_id(const char *name);
484 int genimg_get_comp_id(const char *name);
485 void genimg_print_size(uint32_t size);
487 #if defined(CONFIG_TIMESTAMP) || defined(CONFIG_CMD_DATE) || \
489 #define IMAGE_ENABLE_TIMESTAMP 1
491 #define IMAGE_ENABLE_TIMESTAMP 0
493 void genimg_print_time(time_t timestamp);
495 /* What to do with a image load address ('load = <> 'in the FIT) */
497 FIT_LOAD_IGNORED, /* Ignore load address */
498 FIT_LOAD_OPTIONAL, /* Can be provided, but optional */
499 FIT_LOAD_OPTIONAL_NON_ZERO, /* Optional, a value of 0 is ignored */
500 FIT_LOAD_REQUIRED, /* Must be provided */
503 int boot_get_setup(bootm_headers_t *images, uint8_t arch, ulong *setup_start,
507 /* Image format types, returned by _get_format() routine */
508 #define IMAGE_FORMAT_INVALID 0x00
509 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
510 #define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */
512 #define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */
513 #define IMAGE_FORMAT_ANDROID 0x03 /* Android boot image */
515 ulong genimg_get_kernel_addr_fit(char * const img_addr,
516 const char **fit_uname_config,
517 const char **fit_uname_kernel);
518 ulong genimg_get_kernel_addr(char * const img_addr);
519 int genimg_get_format(const void *img_addr);
520 int genimg_has_config(bootm_headers_t *images);
521 ulong genimg_get_image(ulong img_addr);
523 int boot_get_fpga(int argc, char * const argv[], bootm_headers_t *images,
524 uint8_t arch, const ulong *ld_start, ulong * const ld_len);
525 int boot_get_ramdisk(int argc, char * const argv[], bootm_headers_t *images,
526 uint8_t arch, ulong *rd_start, ulong *rd_end);
529 * boot_get_loadable - routine to load a list of binaries to memory
530 * @argc: Ignored Argument
531 * @argv: Ignored Argument
532 * @images: pointer to the bootm images structure
533 * @arch: expected architecture for the image
534 * @ld_start: Ignored Argument
535 * @ld_len: Ignored Argument
537 * boot_get_loadable() will take the given FIT configuration, and look
538 * for a field named "loadables". Loadables, is a list of elements in
539 * the FIT given as strings. exe:
540 * loadables = "linux_kernel@1", "fdt@2";
541 * this function will attempt to parse each string, and load the
542 * corresponding element from the FIT into memory. Once placed,
543 * no aditional actions are taken.
546 * 0, if only valid images or no images are found
547 * error code, if an error occurs during fit_image_load
549 int boot_get_loadable(int argc, char * const argv[], bootm_headers_t *images,
550 uint8_t arch, const ulong *ld_start, ulong * const ld_len);
551 #endif /* !USE_HOSTCC */
553 int boot_get_setup_fit(bootm_headers_t *images, uint8_t arch,
554 ulong *setup_start, ulong *setup_len);
557 * fit_image_load() - load an image from a FIT
559 * This deals with all aspects of loading an image from a FIT, including
560 * selecting the right image based on configuration, verifying it, printing
561 * out progress messages, checking the type/arch/os and optionally copying it
562 * to the right load address.
564 * The property to look up is defined by image_type.
566 * @param images Boot images structure
567 * @param addr Address of FIT in memory
568 * @param fit_unamep On entry this is the requested image name
569 * (e.g. "kernel@1") or NULL to use the default. On exit
570 * points to the selected image name
571 * @param fit_uname_configp On entry this is the requested configuration
572 * name (e.g. "conf@1") or NULL to use the default. On
573 * exit points to the selected configuration name.
574 * @param arch Expected architecture (IH_ARCH_...)
575 * @param image_type Required image type (IH_TYPE_...). If this is
576 * IH_TYPE_KERNEL then we allow IH_TYPE_KERNEL_NOLOAD
578 * @param bootstage_id ID of starting bootstage to use for progress updates.
579 * This will be added to the BOOTSTAGE_SUB values when
580 * calling bootstage_mark()
581 * @param load_op Decribes what to do with the load address
582 * @param datap Returns address of loaded image
583 * @param lenp Returns length of loaded image
584 * @return node offset of image, or -ve error code on error
586 int fit_image_load(bootm_headers_t *images, ulong addr,
587 const char **fit_unamep, const char **fit_uname_configp,
588 int arch, int image_type, int bootstage_id,
589 enum fit_load_op load_op, ulong *datap, ulong *lenp);
593 * fit_get_node_from_config() - Look up an image a FIT by type
595 * This looks in the selected conf@ node (images->fit_uname_cfg) for a
596 * particular image type (e.g. "kernel") and then finds the image that is
599 * For example, for something like:
608 * kernel = "kernel@1";
612 * the function will return the node offset of the kernel@1 node, assuming
613 * that conf@1 is the chosen configuration.
615 * @param images Boot images structure
616 * @param prop_name Property name to look up (FIT_..._PROP)
617 * @param addr Address of FIT in memory
619 int fit_get_node_from_config(bootm_headers_t *images, const char *prop_name,
622 int boot_get_fdt(int flag, int argc, char * const argv[], uint8_t arch,
623 bootm_headers_t *images,
624 char **of_flat_tree, ulong *of_size);
625 void boot_fdt_add_mem_rsv_regions(struct lmb *lmb, void *fdt_blob);
626 int boot_relocate_fdt(struct lmb *lmb, char **of_flat_tree, ulong *of_size);
628 int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len,
629 ulong *initrd_start, ulong *initrd_end);
630 int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end);
631 #ifdef CONFIG_SYS_BOOT_GET_KBD
632 int boot_get_kbd(struct lmb *lmb, bd_t **kbd);
633 #endif /* CONFIG_SYS_BOOT_GET_KBD */
634 #endif /* !USE_HOSTCC */
636 /*******************************************************************/
637 /* Legacy format specific code (prefixed with image_) */
638 /*******************************************************************/
639 static inline uint32_t image_get_header_size(void)
641 return (sizeof(image_header_t));
644 #define image_get_hdr_l(f) \
645 static inline uint32_t image_get_##f(const image_header_t *hdr) \
647 return uimage_to_cpu(hdr->ih_##f); \
649 image_get_hdr_l(magic) /* image_get_magic */
650 image_get_hdr_l(hcrc) /* image_get_hcrc */
651 image_get_hdr_l(time) /* image_get_time */
652 image_get_hdr_l(size) /* image_get_size */
653 image_get_hdr_l(load) /* image_get_load */
654 image_get_hdr_l(ep) /* image_get_ep */
655 image_get_hdr_l(dcrc) /* image_get_dcrc */
657 #define image_get_hdr_b(f) \
658 static inline uint8_t image_get_##f(const image_header_t *hdr) \
660 return hdr->ih_##f; \
662 image_get_hdr_b(os) /* image_get_os */
663 image_get_hdr_b(arch) /* image_get_arch */
664 image_get_hdr_b(type) /* image_get_type */
665 image_get_hdr_b(comp) /* image_get_comp */
667 static inline char *image_get_name(const image_header_t *hdr)
669 return (char *)hdr->ih_name;
672 static inline uint32_t image_get_data_size(const image_header_t *hdr)
674 return image_get_size(hdr);
678 * image_get_data - get image payload start address
681 * image_get_data() returns address of the image payload. For single
682 * component images it is image data start. For multi component
683 * images it points to the null terminated table of sub-images sizes.
686 * image payload data start address
688 static inline ulong image_get_data(const image_header_t *hdr)
690 return ((ulong)hdr + image_get_header_size());
693 static inline uint32_t image_get_image_size(const image_header_t *hdr)
695 return (image_get_size(hdr) + image_get_header_size());
697 static inline ulong image_get_image_end(const image_header_t *hdr)
699 return ((ulong)hdr + image_get_image_size(hdr));
702 #define image_set_hdr_l(f) \
703 static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
705 hdr->ih_##f = cpu_to_uimage(val); \
707 image_set_hdr_l(magic) /* image_set_magic */
708 image_set_hdr_l(hcrc) /* image_set_hcrc */
709 image_set_hdr_l(time) /* image_set_time */
710 image_set_hdr_l(size) /* image_set_size */
711 image_set_hdr_l(load) /* image_set_load */
712 image_set_hdr_l(ep) /* image_set_ep */
713 image_set_hdr_l(dcrc) /* image_set_dcrc */
715 #define image_set_hdr_b(f) \
716 static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
720 image_set_hdr_b(os) /* image_set_os */
721 image_set_hdr_b(arch) /* image_set_arch */
722 image_set_hdr_b(type) /* image_set_type */
723 image_set_hdr_b(comp) /* image_set_comp */
725 static inline void image_set_name(image_header_t *hdr, const char *name)
727 strncpy(image_get_name(hdr), name, IH_NMLEN);
730 int image_check_hcrc(const image_header_t *hdr);
731 int image_check_dcrc(const image_header_t *hdr);
733 ulong getenv_bootm_low(void);
734 phys_size_t getenv_bootm_size(void);
735 phys_size_t getenv_bootm_mapsize(void);
737 void memmove_wd(void *to, void *from, size_t len, ulong chunksz);
739 static inline int image_check_magic(const image_header_t *hdr)
741 return (image_get_magic(hdr) == IH_MAGIC);
743 static inline int image_check_type(const image_header_t *hdr, uint8_t type)
745 return (image_get_type(hdr) == type);
747 static inline int image_check_arch(const image_header_t *hdr, uint8_t arch)
749 return (image_get_arch(hdr) == arch);
751 static inline int image_check_os(const image_header_t *hdr, uint8_t os)
753 return (image_get_os(hdr) == os);
756 ulong image_multi_count(const image_header_t *hdr);
757 void image_multi_getimg(const image_header_t *hdr, ulong idx,
758 ulong *data, ulong *len);
760 void image_print_contents(const void *hdr);
763 static inline int image_check_target_arch(const image_header_t *hdr)
765 #ifndef IH_ARCH_DEFAULT
766 # error "please define IH_ARCH_DEFAULT in your arch asm/u-boot.h"
768 return image_check_arch(hdr, IH_ARCH_DEFAULT);
770 #endif /* USE_HOSTCC */
773 * Set up properties in the FDT
775 * This sets up properties in the FDT that is to be passed to linux.
777 * @images: Images information
778 * @blob: FDT to update
779 * @of_size: Size of the FDT
780 * @lmb: Points to logical memory block structure
781 * @return 0 if ok, <0 on failure
783 int image_setup_libfdt(bootm_headers_t *images, void *blob,
784 int of_size, struct lmb *lmb);
787 * Set up the FDT to use for booting a kernel
789 * This performs ramdisk setup, sets up the FDT if required, and adds
790 * paramters to the FDT if libfdt is available.
792 * @param images Images information
793 * @return 0 if ok, <0 on failure
795 int image_setup_linux(bootm_headers_t *images);
798 * bootz_setup() - Extract stat and size of a Linux xImage
800 * @image: Address of image
801 * @start: Returns start address of image
802 * @end : Returns end address of image
803 * @return 0 if OK, 1 if the image was not recognised
805 int bootz_setup(ulong image, ulong *start, ulong *end);
808 /*******************************************************************/
809 /* New uImage format specific code (prefixed with fit_) */
810 /*******************************************************************/
812 #define FIT_IMAGES_PATH "/images"
813 #define FIT_CONFS_PATH "/configurations"
815 /* hash/signature node */
816 #define FIT_HASH_NODENAME "hash"
817 #define FIT_ALGO_PROP "algo"
818 #define FIT_VALUE_PROP "value"
819 #define FIT_IGNORE_PROP "uboot-ignore"
820 #define FIT_SIG_NODENAME "signature"
823 #define FIT_DATA_PROP "data"
824 #define FIT_TIMESTAMP_PROP "timestamp"
825 #define FIT_DESC_PROP "description"
826 #define FIT_ARCH_PROP "arch"
827 #define FIT_TYPE_PROP "type"
828 #define FIT_OS_PROP "os"
829 #define FIT_COMP_PROP "compression"
830 #define FIT_ENTRY_PROP "entry"
831 #define FIT_LOAD_PROP "load"
833 /* configuration node */
834 #define FIT_KERNEL_PROP "kernel"
835 #define FIT_RAMDISK_PROP "ramdisk"
836 #define FIT_FDT_PROP "fdt"
837 #define FIT_LOADABLE_PROP "loadables"
838 #define FIT_DEFAULT_PROP "default"
839 #define FIT_SETUP_PROP "setup"
840 #define FIT_FPGA_PROP "fpga"
842 #define FIT_MAX_HASH_LEN HASH_MAX_DIGEST_SIZE
845 /* cmdline argument format parsing */
846 int fit_parse_conf(const char *spec, ulong addr_curr,
847 ulong *addr, const char **conf_name);
848 int fit_parse_subimage(const char *spec, ulong addr_curr,
849 ulong *addr, const char **image_name);
851 int fit_get_subimage_count(const void *fit, int images_noffset);
852 void fit_print_contents(const void *fit);
853 void fit_image_print(const void *fit, int noffset, const char *p);
856 * fit_get_end - get FIT image size
857 * @fit: pointer to the FIT format image header
860 * size of the FIT image (blob) in memory
862 static inline ulong fit_get_size(const void *fit)
864 return fdt_totalsize(fit);
868 * fit_get_end - get FIT image end
869 * @fit: pointer to the FIT format image header
872 * end address of the FIT image (blob) in memory
874 ulong fit_get_end(const void *fit);
877 * fit_get_name - get FIT node name
878 * @fit: pointer to the FIT format image header
882 * pointer to node name, on success
884 static inline const char *fit_get_name(const void *fit_hdr,
885 int noffset, int *len)
887 return fdt_get_name(fit_hdr, noffset, len);
890 int fit_get_desc(const void *fit, int noffset, char **desc);
891 int fit_get_timestamp(const void *fit, int noffset, time_t *timestamp);
893 int fit_image_get_node(const void *fit, const char *image_uname);
894 int fit_image_get_os(const void *fit, int noffset, uint8_t *os);
895 int fit_image_get_arch(const void *fit, int noffset, uint8_t *arch);
896 int fit_image_get_type(const void *fit, int noffset, uint8_t *type);
897 int fit_image_get_comp(const void *fit, int noffset, uint8_t *comp);
898 int fit_image_get_load(const void *fit, int noffset, ulong *load);
899 int fit_image_get_entry(const void *fit, int noffset, ulong *entry);
900 int fit_image_get_data(const void *fit, int noffset,
901 const void **data, size_t *size);
903 int fit_image_hash_get_algo(const void *fit, int noffset, char **algo);
904 int fit_image_hash_get_value(const void *fit, int noffset, uint8_t **value,
907 int fit_set_timestamp(void *fit, int noffset, time_t timestamp);
910 * fit_add_verification_data() - add verification data to FIT image nodes
912 * @keydir: Directory containing keys
913 * @kwydest: FDT blob to write public key information to
914 * @fit: Pointer to the FIT format image header
915 * @comment: Comment to add to signature nodes
916 * @require_keys: Mark all keys as 'required'
918 * Adds hash values for all component images in the FIT blob.
919 * Hashes are calculated for all component images which have hash subnodes
920 * with algorithm property set to one of the supported hash algorithms.
922 * Also add signatures if signature nodes are present.
926 * libfdt error code, on failure
928 int fit_add_verification_data(const char *keydir, void *keydest, void *fit,
929 const char *comment, int require_keys);
931 int fit_image_verify(const void *fit, int noffset);
932 int fit_config_verify(const void *fit, int conf_noffset);
933 int fit_all_image_verify(const void *fit);
934 int fit_image_check_os(const void *fit, int noffset, uint8_t os);
935 int fit_image_check_arch(const void *fit, int noffset, uint8_t arch);
936 int fit_image_check_type(const void *fit, int noffset, uint8_t type);
937 int fit_image_check_comp(const void *fit, int noffset, uint8_t comp);
938 int fit_check_format(const void *fit);
940 int fit_conf_find_compat(const void *fit, const void *fdt);
941 int fit_conf_get_node(const void *fit, const char *conf_uname);
944 * fit_conf_get_prop_node() - Get node refered to by a configuration
946 * @noffset: Offset of conf@xxx node to check
947 * @prop_name: Property to read from the conf node
949 * The conf@ nodes contain references to other nodes, using properties
950 * like 'kernel = "kernel@1"'. Given such a property name (e.g. "kernel"),
951 * return the offset of the node referred to (e.g. offset of node
952 * "/images/kernel@1".
954 int fit_conf_get_prop_node(const void *fit, int noffset,
955 const char *prop_name);
957 void fit_conf_print(const void *fit, int noffset, const char *p);
959 int fit_check_ramdisk(const void *fit, int os_noffset,
960 uint8_t arch, int verify);
962 int calculate_hash(const void *data, int data_len, const char *algo,
963 uint8_t *value, int *value_len);
966 * At present we only support signing on the host, and verification on the
969 #if defined(CONFIG_FIT_SIGNATURE)
971 # define IMAGE_ENABLE_SIGN 1
972 # define IMAGE_ENABLE_VERIFY 1
973 # include <openssl/evp.h>
975 # define IMAGE_ENABLE_SIGN 0
976 # define IMAGE_ENABLE_VERIFY 1
979 # define IMAGE_ENABLE_SIGN 0
980 # define IMAGE_ENABLE_VERIFY 0
984 void *image_get_host_blob(void);
985 void image_set_host_blob(void *host_blob);
986 # define gd_fdt_blob() image_get_host_blob()
988 # define gd_fdt_blob() (gd->fdt_blob)
991 #ifdef CONFIG_FIT_BEST_MATCH
992 #define IMAGE_ENABLE_BEST_MATCH 1
994 #define IMAGE_ENABLE_BEST_MATCH 0
997 /* Information passed to the signing routines */
998 struct image_sign_info {
999 const char *keydir; /* Directory conaining keys */
1000 const char *keyname; /* Name of key to use */
1001 void *fit; /* Pointer to FIT blob */
1002 int node_offset; /* Offset of signature node */
1003 struct image_sig_algo *algo; /* Algorithm information */
1004 const void *fdt_blob; /* FDT containing public keys */
1005 int required_keynode; /* Node offset of key to use: -1=any */
1006 const char *require_keys; /* Value for 'required' property */
1008 #endif /* Allow struct image_region to always be defined for rsa.h */
1010 /* A part of an image, used for hashing */
1011 struct image_region {
1016 #if IMAGE_ENABLE_FIT
1018 #if IMAGE_ENABLE_VERIFY
1019 # include <u-boot/rsa-checksum.h>
1021 struct checksum_algo {
1023 const int checksum_len;
1025 #if IMAGE_ENABLE_SIGN
1026 const EVP_MD *(*calculate_sign)(void);
1028 int (*calculate)(const char *name,
1029 const struct image_region region[],
1030 int region_count, uint8_t *checksum);
1031 const uint8_t *rsa_padding;
1034 struct image_sig_algo {
1035 const char *name; /* Name of algorithm */
1038 * sign() - calculate and return signature for given input data
1040 * @info: Specifies key and FIT information
1041 * @data: Pointer to the input data
1042 * @data_len: Data length
1043 * @sigp: Set to an allocated buffer holding the signature
1044 * @sig_len: Set to length of the calculated hash
1046 * This computes input data signature according to selected algorithm.
1047 * Resulting signature value is placed in an allocated buffer, the
1048 * pointer is returned as *sigp. The length of the calculated
1049 * signature is returned via the sig_len pointer argument. The caller
1050 * should free *sigp.
1052 * @return: 0, on success, -ve on error
1054 int (*sign)(struct image_sign_info *info,
1055 const struct image_region region[],
1056 int region_count, uint8_t **sigp, uint *sig_len);
1059 * add_verify_data() - Add verification information to FDT
1061 * Add public key information to the FDT node, suitable for
1062 * verification at run-time. The information added depends on the
1063 * algorithm being used.
1065 * @info: Specifies key and FIT information
1066 * @keydest: Destination FDT blob for public key data
1067 * @return: 0, on success, -ve on error
1069 int (*add_verify_data)(struct image_sign_info *info, void *keydest);
1072 * verify() - Verify a signature against some data
1074 * @info: Specifies key and FIT information
1075 * @data: Pointer to the input data
1076 * @data_len: Data length
1078 * @sig_len: Number of bytes in signature
1079 * @return 0 if verified, -ve on error
1081 int (*verify)(struct image_sign_info *info,
1082 const struct image_region region[], int region_count,
1083 uint8_t *sig, uint sig_len);
1085 /* pointer to checksum algorithm */
1086 struct checksum_algo *checksum;
1090 * image_get_sig_algo() - Look up a signature algortihm
1092 * @param name Name of algorithm
1093 * @return pointer to algorithm information, or NULL if not found
1095 struct image_sig_algo *image_get_sig_algo(const char *name);
1098 * fit_image_verify_required_sigs() - Verify signatures marked as 'required'
1100 * @fit: FIT to check
1101 * @image_noffset: Offset of image node to check
1102 * @data: Image data to check
1103 * @size: Size of image data
1104 * @sig_blob: FDT containing public keys
1105 * @no_sigsp: Returns 1 if no signatures were required, and
1106 * therefore nothing was checked. The caller may wish
1107 * to fall back to other mechanisms, or refuse to
1109 * @return 0 if all verified ok, <0 on error
1111 int fit_image_verify_required_sigs(const void *fit, int image_noffset,
1112 const char *data, size_t size, const void *sig_blob,
1116 * fit_image_check_sig() - Check a single image signature node
1118 * @fit: FIT to check
1119 * @noffset: Offset of signature node to check
1120 * @data: Image data to check
1121 * @size: Size of image data
1122 * @required_keynode: Offset in the control FDT of the required key node,
1123 * if any. If this is given, then the image wil not
1124 * pass verification unless that key is used. If this is
1125 * -1 then any signature will do.
1126 * @err_msgp: In the event of an error, this will be pointed to a
1127 * help error string to display to the user.
1128 * @return 0 if all verified ok, <0 on error
1130 int fit_image_check_sig(const void *fit, int noffset, const void *data,
1131 size_t size, int required_keynode, char **err_msgp);
1134 * fit_region_make_list() - Make a list of regions to hash
1136 * Given a list of FIT regions (offset, size) provided by libfdt, create
1137 * a list of regions (void *, size) for use by the signature creationg
1138 * and verification code.
1140 * @fit: FIT image to process
1141 * @fdt_regions: Regions as returned by libfdt
1142 * @count: Number of regions returned by libfdt
1143 * @region: Place to put list of regions (NULL to allocate it)
1144 * @return pointer to list of regions, or NULL if out of memory
1146 struct image_region *fit_region_make_list(const void *fit,
1147 struct fdt_region *fdt_regions, int count,
1148 struct image_region *region);
1150 static inline int fit_image_check_target_arch(const void *fdt, int node)
1153 return fit_image_check_arch(fdt, node, IH_ARCH_DEFAULT);
1159 #ifdef CONFIG_FIT_VERBOSE
1160 #define fit_unsupported(msg) printf("! %s:%d " \
1161 "FIT images not supported for '%s'\n", \
1162 __FILE__, __LINE__, (msg))
1164 #define fit_unsupported_reset(msg) printf("! %s:%d " \
1165 "FIT images not supported for '%s' " \
1166 "- must reset board to recover!\n", \
1167 __FILE__, __LINE__, (msg))
1169 #define fit_unsupported(msg)
1170 #define fit_unsupported_reset(msg)
1171 #endif /* CONFIG_FIT_VERBOSE */
1172 #endif /* CONFIG_FIT */
1174 #if defined(CONFIG_ANDROID_BOOT_IMAGE)
1175 struct andr_img_hdr;
1176 int android_image_check_header(const struct andr_img_hdr *hdr);
1177 int android_image_get_kernel(const struct andr_img_hdr *hdr, int verify,
1178 ulong *os_data, ulong *os_len);
1179 int android_image_get_ramdisk(const struct andr_img_hdr *hdr,
1180 ulong *rd_data, ulong *rd_len);
1181 ulong android_image_get_end(const struct andr_img_hdr *hdr);
1182 ulong android_image_get_kload(const struct andr_img_hdr *hdr);
1183 void android_print_contents(const struct andr_img_hdr *hdr);
1185 #endif /* CONFIG_ANDROID_BOOT_IMAGE */
1188 * board_fit_config_name_match() - Check for a matching board name
1190 * This is used when SPL loads a FIT containing multiple device tree files
1191 * and wants to work out which one to use. The description of each one is
1192 * passed to this function. The description comes from the 'description' field
1193 * in each (FDT) image node.
1195 * @name: Device tree description
1196 * @return 0 if this device tree should be used, non-zero to try the next
1198 int board_fit_config_name_match(const char *name);
1200 #ifdef CONFIG_SPL_FIT_IMAGE_POST_PROCESS
1202 * board_fit_image_post_process() - Do any post-process on FIT binary data
1204 * This is used to do any sort of image manipulation, verification, decryption
1205 * etc. in a platform or board specific way. Obviously, anything done here would
1206 * need to be comprehended in how the images were prepared before being injected
1207 * into the FIT creation (i.e. the binary blobs would have been pre-processed
1208 * before being added to the FIT image).
1210 * @image: pointer to the image start pointer
1211 * @size: pointer to the image size
1212 * @return no return value (failure should be handled internally)
1214 void board_fit_image_post_process(void **p_image, size_t *p_size);
1215 #endif /* CONFIG_SPL_FIT_IMAGE_POST_PROCESS */
1217 #endif /* __IMAGE_H__ */