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 */
210 * "Standalone Programs" are directly runnable in the environment
211 * provided by U-Boot; it is expected that (if they behave
212 * well) you can continue to work in U-Boot after return from
213 * the Standalone Program.
214 * "OS Kernel Images" are usually images of some Embedded OS which
215 * will take over control completely. Usually these programs
216 * will install their own set of exception handlers, device
217 * drivers, set up the MMU, etc. - this means, that you cannot
218 * expect to re-enter U-Boot except by resetting the CPU.
219 * "RAMDisk Images" are more or less just data blocks, and their
220 * parameters (address, size) are passed to an OS kernel that is
222 * "Multi-File Images" contain several images, typically an OS
223 * (Linux) kernel image and one or more data images like
224 * RAMDisks. This construct is useful for instance when you want
225 * to boot over the network using BOOTP etc., where the boot
226 * server provides just a single image file, but you want to get
227 * for instance an OS kernel and a RAMDisk image.
229 * "Multi-File Images" start with a list of image sizes, each
230 * image size (in bytes) specified by an "uint32_t" in network
231 * byte order. This list is terminated by an "(uint32_t)0".
232 * Immediately after the terminating 0 follow the images, one by
233 * one, all aligned on "uint32_t" boundaries (size rounded up to
234 * a multiple of 4 bytes - except for the last file).
236 * "Firmware Images" are binary images containing firmware (like
237 * U-Boot or FPGA images) which usually will be programmed to
240 * "Script files" are command sequences that will be executed by
241 * U-Boot's command interpreter; this feature is especially
242 * useful when you configure U-Boot to use a real shell (hush)
243 * as command interpreter (=> Shell Scripts).
245 * The following are exposed to uImage header.
246 * Do not change values for backward compatibility.
250 IH_TYPE_INVALID = 0, /* Invalid Image */
251 IH_TYPE_STANDALONE, /* Standalone Program */
252 IH_TYPE_KERNEL, /* OS Kernel Image */
253 IH_TYPE_RAMDISK, /* RAMDisk Image */
254 IH_TYPE_MULTI, /* Multi-File Image */
255 IH_TYPE_FIRMWARE, /* Firmware Image */
256 IH_TYPE_SCRIPT, /* Script file */
257 IH_TYPE_FILESYSTEM, /* Filesystem Image (any type) */
258 IH_TYPE_FLATDT, /* Binary Flat Device Tree Blob */
259 IH_TYPE_KWBIMAGE, /* Kirkwood Boot Image */
260 IH_TYPE_IMXIMAGE, /* Freescale IMXBoot Image */
261 IH_TYPE_UBLIMAGE, /* Davinci UBL Image */
262 IH_TYPE_OMAPIMAGE, /* TI OMAP Config Header Image */
263 IH_TYPE_AISIMAGE, /* TI Davinci AIS Image */
264 /* OS Kernel Image, can run from any load address */
265 IH_TYPE_KERNEL_NOLOAD,
266 IH_TYPE_PBLIMAGE, /* Freescale PBL Boot Image */
267 IH_TYPE_MXSIMAGE, /* Freescale MXSBoot Image */
268 IH_TYPE_GPIMAGE, /* TI Keystone GPHeader Image */
269 IH_TYPE_ATMELIMAGE, /* ATMEL ROM bootable Image */
270 IH_TYPE_SOCFPGAIMAGE, /* Altera SOCFPGA Preloader */
271 IH_TYPE_X86_SETUP, /* x86 setup.bin Image */
272 IH_TYPE_LPC32XXIMAGE, /* x86 setup.bin Image */
273 IH_TYPE_LOADABLE, /* A list of typeless images */
274 IH_TYPE_RKIMAGE, /* Rockchip Boot Image */
275 IH_TYPE_RKSD, /* Rockchip SD card */
276 IH_TYPE_RKSPI, /* Rockchip SPI image */
277 IH_TYPE_ZYNQIMAGE, /* Xilinx Zynq Boot Image */
278 IH_TYPE_ZYNQMPIMAGE, /* Xilinx ZynqMP Boot Image */
279 IH_TYPE_FPGA, /* FPGA Image */
281 IH_TYPE_COUNT, /* Number of image types */
287 * The following are exposed to uImage header.
288 * Do not change values for backward compatibility.
291 IH_COMP_NONE = 0, /* No Compression Used */
292 IH_COMP_GZIP, /* gzip Compression Used */
293 IH_COMP_BZIP2, /* bzip2 Compression Used */
294 IH_COMP_LZMA, /* lzma Compression Used */
295 IH_COMP_LZO, /* lzo Compression Used */
296 IH_COMP_LZ4, /* lz4 Compression Used */
301 #define IH_MAGIC 0x27051956 /* Image Magic Number */
302 #define IH_NMLEN 32 /* Image Name Length */
304 /* Reused from common.h */
305 #define ROUND(a, b) (((a) + (b) - 1) & ~((b) - 1))
308 * Legacy format image header,
309 * all data in network byte order (aka natural aka bigendian).
311 typedef struct image_header {
312 __be32 ih_magic; /* Image Header Magic Number */
313 __be32 ih_hcrc; /* Image Header CRC Checksum */
314 __be32 ih_time; /* Image Creation Timestamp */
315 __be32 ih_size; /* Image Data Size */
316 __be32 ih_load; /* Data Load Address */
317 __be32 ih_ep; /* Entry Point Address */
318 __be32 ih_dcrc; /* Image Data CRC Checksum */
319 uint8_t ih_os; /* Operating System */
320 uint8_t ih_arch; /* CPU architecture */
321 uint8_t ih_type; /* Image Type */
322 uint8_t ih_comp; /* Compression Type */
323 uint8_t ih_name[IH_NMLEN]; /* Image Name */
326 typedef struct image_info {
327 ulong start, end; /* start/end of blob */
328 ulong image_start, image_len; /* start of image within blob, len of image */
329 ulong load; /* load addr for the image */
330 uint8_t comp, type, os; /* compression, type of image, os type */
331 uint8_t arch; /* CPU architecture */
335 * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
338 typedef struct bootm_headers {
340 * Legacy os image header, if it is a multi component image
341 * then boot_get_ramdisk() and get_fdt() will attempt to get
342 * data from second and third component accordingly.
344 image_header_t *legacy_hdr_os; /* image header pointer */
345 image_header_t legacy_hdr_os_copy; /* header copy */
346 ulong legacy_hdr_valid;
349 const char *fit_uname_cfg; /* configuration node unit name */
351 void *fit_hdr_os; /* os FIT image header */
352 const char *fit_uname_os; /* os subimage node unit name */
353 int fit_noffset_os; /* os subimage node offset */
355 void *fit_hdr_rd; /* init ramdisk FIT image header */
356 const char *fit_uname_rd; /* init ramdisk subimage node unit name */
357 int fit_noffset_rd; /* init ramdisk subimage node offset */
359 void *fit_hdr_fdt; /* FDT blob FIT image header */
360 const char *fit_uname_fdt; /* FDT blob subimage node unit name */
361 int fit_noffset_fdt;/* FDT blob subimage node offset */
363 void *fit_hdr_setup; /* x86 setup FIT image header */
364 const char *fit_uname_setup; /* x86 setup subimage node name */
365 int fit_noffset_setup;/* x86 setup subimage node offset */
369 image_info_t os; /* os image info */
370 ulong ep; /* entry point of OS */
372 ulong rd_start, rd_end;/* ramdisk start/end */
374 char *ft_addr; /* flat dev tree address */
375 ulong ft_len; /* length of flat device tree */
384 int verify; /* getenv("verify")[0] != 'n' */
386 #define BOOTM_STATE_START (0x00000001)
387 #define BOOTM_STATE_FINDOS (0x00000002)
388 #define BOOTM_STATE_FINDOTHER (0x00000004)
389 #define BOOTM_STATE_LOADOS (0x00000008)
390 #define BOOTM_STATE_RAMDISK (0x00000010)
391 #define BOOTM_STATE_FDT (0x00000020)
392 #define BOOTM_STATE_OS_CMDLINE (0x00000040)
393 #define BOOTM_STATE_OS_BD_T (0x00000080)
394 #define BOOTM_STATE_OS_PREP (0x00000100)
395 #define BOOTM_STATE_OS_FAKE_GO (0x00000200) /* 'Almost' run the OS */
396 #define BOOTM_STATE_OS_GO (0x00000400)
400 struct lmb lmb; /* for memory mgmt */
404 extern bootm_headers_t images;
407 * Some systems (for example LWMON) have very short watchdog periods;
408 * we must make sure to split long operations like memmove() or
409 * checksum calculations into reasonable chunks.
412 #define CHUNKSZ (64 * 1024)
415 #ifndef CHUNKSZ_CRC32
416 #define CHUNKSZ_CRC32 (64 * 1024)
420 #define CHUNKSZ_MD5 (64 * 1024)
424 #define CHUNKSZ_SHA1 (64 * 1024)
427 #define uimage_to_cpu(x) be32_to_cpu(x)
428 #define cpu_to_uimage(x) cpu_to_be32(x)
431 * Translation table for entries of a specific type; used by
432 * get_table_entry_id() and get_table_entry_name().
434 typedef struct table_entry {
436 char *sname; /* short (input) name to find table entry */
437 char *lname; /* long (output) name to print for messages */
441 * get_table_entry_id() scans the translation table trying to find an
442 * entry that matches the given short name. If a matching entry is
443 * found, it's id is returned to the caller.
445 int get_table_entry_id(const table_entry_t *table,
446 const char *table_name, const char *name);
448 * get_table_entry_name() scans the translation table trying to find
449 * an entry that matches the given id. If a matching entry is found,
450 * its long name is returned to the caller.
452 char *get_table_entry_name(const table_entry_t *table, char *msg, int id);
454 const char *genimg_get_os_name(uint8_t os);
457 * genimg_get_os_short_name() - get the short name for an OS
459 * @param os OS (IH_OS_...)
460 * @return OS short name, or "unknown" if unknown
462 const char *genimg_get_os_short_name(uint8_t comp);
464 const char *genimg_get_arch_name(uint8_t arch);
467 * genimg_get_arch_short_name() - get the short name for an architecture
469 * @param arch Architecture type (IH_ARCH_...)
470 * @return architecture short name, or "unknown" if unknown
472 const char *genimg_get_arch_short_name(uint8_t arch);
474 const char *genimg_get_type_name(uint8_t type);
477 * genimg_get_type_short_name() - get the short name for an image type
479 * @param type Image type (IH_TYPE_...)
480 * @return image short name, or "unknown" if unknown
482 const char *genimg_get_type_short_name(uint8_t type);
484 const char *genimg_get_comp_name(uint8_t comp);
487 * genimg_get_comp_short_name() - get the short name for a compression method
489 * @param comp compression method (IH_COMP_...)
490 * @return compression method short name, or "unknown" if unknown
492 const char *genimg_get_comp_short_name(uint8_t comp);
495 * genimg_get_cat_name() - Get the name of an item in a category
497 * @category: Category of item
499 * @return name of item, or "Unknown ..." if unknown
501 const char *genimg_get_cat_name(enum ih_category category, uint id);
504 * genimg_get_cat_short_name() - Get the short name of an item in a category
506 * @category: Category of item
508 * @return short name of item, or "Unknown ..." if unknown
510 const char *genimg_get_cat_short_name(enum ih_category category, uint id);
513 * genimg_get_cat_count() - Get the number of items in a category
515 * @category: Category to check
516 * @return the number of items in the category (IH_xxx_COUNT)
518 int genimg_get_cat_count(enum ih_category category);
521 * genimg_get_cat_desc() - Get the description of a category
523 * @return the description of a category, e.g. "architecture". This
524 * effectively converts the enum to a string.
526 const char *genimg_get_cat_desc(enum ih_category category);
528 int genimg_get_os_id(const char *name);
529 int genimg_get_arch_id(const char *name);
530 int genimg_get_type_id(const char *name);
531 int genimg_get_comp_id(const char *name);
532 void genimg_print_size(uint32_t size);
534 #if defined(CONFIG_TIMESTAMP) || defined(CONFIG_CMD_DATE) || \
536 #define IMAGE_ENABLE_TIMESTAMP 1
538 #define IMAGE_ENABLE_TIMESTAMP 0
540 void genimg_print_time(time_t timestamp);
542 /* What to do with a image load address ('load = <> 'in the FIT) */
544 FIT_LOAD_IGNORED, /* Ignore load address */
545 FIT_LOAD_OPTIONAL, /* Can be provided, but optional */
546 FIT_LOAD_OPTIONAL_NON_ZERO, /* Optional, a value of 0 is ignored */
547 FIT_LOAD_REQUIRED, /* Must be provided */
550 int boot_get_setup(bootm_headers_t *images, uint8_t arch, ulong *setup_start,
554 /* Image format types, returned by _get_format() routine */
555 #define IMAGE_FORMAT_INVALID 0x00
556 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
557 #define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */
559 #define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */
560 #define IMAGE_FORMAT_ANDROID 0x03 /* Android boot image */
562 ulong genimg_get_kernel_addr_fit(char * const img_addr,
563 const char **fit_uname_config,
564 const char **fit_uname_kernel);
565 ulong genimg_get_kernel_addr(char * const img_addr);
566 int genimg_get_format(const void *img_addr);
567 int genimg_has_config(bootm_headers_t *images);
568 ulong genimg_get_image(ulong img_addr);
570 int boot_get_fpga(int argc, char * const argv[], bootm_headers_t *images,
571 uint8_t arch, const ulong *ld_start, ulong * const ld_len);
572 int boot_get_ramdisk(int argc, char * const argv[], bootm_headers_t *images,
573 uint8_t arch, ulong *rd_start, ulong *rd_end);
576 * boot_get_loadable - routine to load a list of binaries to memory
577 * @argc: Ignored Argument
578 * @argv: Ignored Argument
579 * @images: pointer to the bootm images structure
580 * @arch: expected architecture for the image
581 * @ld_start: Ignored Argument
582 * @ld_len: Ignored Argument
584 * boot_get_loadable() will take the given FIT configuration, and look
585 * for a field named "loadables". Loadables, is a list of elements in
586 * the FIT given as strings. exe:
587 * loadables = "linux_kernel@1", "fdt@2";
588 * this function will attempt to parse each string, and load the
589 * corresponding element from the FIT into memory. Once placed,
590 * no aditional actions are taken.
593 * 0, if only valid images or no images are found
594 * error code, if an error occurs during fit_image_load
596 int boot_get_loadable(int argc, char * const argv[], bootm_headers_t *images,
597 uint8_t arch, const ulong *ld_start, ulong * const ld_len);
598 #endif /* !USE_HOSTCC */
600 int boot_get_setup_fit(bootm_headers_t *images, uint8_t arch,
601 ulong *setup_start, ulong *setup_len);
604 * fit_image_load() - load an image from a FIT
606 * This deals with all aspects of loading an image from a FIT, including
607 * selecting the right image based on configuration, verifying it, printing
608 * out progress messages, checking the type/arch/os and optionally copying it
609 * to the right load address.
611 * The property to look up is defined by image_type.
613 * @param images Boot images structure
614 * @param addr Address of FIT in memory
615 * @param fit_unamep On entry this is the requested image name
616 * (e.g. "kernel@1") or NULL to use the default. On exit
617 * points to the selected image name
618 * @param fit_uname_configp On entry this is the requested configuration
619 * name (e.g. "conf@1") or NULL to use the default. On
620 * exit points to the selected configuration name.
621 * @param arch Expected architecture (IH_ARCH_...)
622 * @param image_type Required image type (IH_TYPE_...). If this is
623 * IH_TYPE_KERNEL then we allow IH_TYPE_KERNEL_NOLOAD
625 * @param bootstage_id ID of starting bootstage to use for progress updates.
626 * This will be added to the BOOTSTAGE_SUB values when
627 * calling bootstage_mark()
628 * @param load_op Decribes what to do with the load address
629 * @param datap Returns address of loaded image
630 * @param lenp Returns length of loaded image
631 * @return node offset of image, or -ve error code on error
633 int fit_image_load(bootm_headers_t *images, ulong addr,
634 const char **fit_unamep, const char **fit_uname_configp,
635 int arch, int image_type, int bootstage_id,
636 enum fit_load_op load_op, ulong *datap, ulong *lenp);
640 * fit_get_node_from_config() - Look up an image a FIT by type
642 * This looks in the selected conf@ node (images->fit_uname_cfg) for a
643 * particular image type (e.g. "kernel") and then finds the image that is
646 * For example, for something like:
655 * kernel = "kernel@1";
659 * the function will return the node offset of the kernel@1 node, assuming
660 * that conf@1 is the chosen configuration.
662 * @param images Boot images structure
663 * @param prop_name Property name to look up (FIT_..._PROP)
664 * @param addr Address of FIT in memory
666 int fit_get_node_from_config(bootm_headers_t *images, const char *prop_name,
669 int boot_get_fdt(int flag, int argc, char * const argv[], uint8_t arch,
670 bootm_headers_t *images,
671 char **of_flat_tree, ulong *of_size);
672 void boot_fdt_add_mem_rsv_regions(struct lmb *lmb, void *fdt_blob);
673 int boot_relocate_fdt(struct lmb *lmb, char **of_flat_tree, ulong *of_size);
675 int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len,
676 ulong *initrd_start, ulong *initrd_end);
677 int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end);
678 #ifdef CONFIG_SYS_BOOT_GET_KBD
679 int boot_get_kbd(struct lmb *lmb, bd_t **kbd);
680 #endif /* CONFIG_SYS_BOOT_GET_KBD */
681 #endif /* !USE_HOSTCC */
683 /*******************************************************************/
684 /* Legacy format specific code (prefixed with image_) */
685 /*******************************************************************/
686 static inline uint32_t image_get_header_size(void)
688 return (sizeof(image_header_t));
691 #define image_get_hdr_l(f) \
692 static inline uint32_t image_get_##f(const image_header_t *hdr) \
694 return uimage_to_cpu(hdr->ih_##f); \
696 image_get_hdr_l(magic) /* image_get_magic */
697 image_get_hdr_l(hcrc) /* image_get_hcrc */
698 image_get_hdr_l(time) /* image_get_time */
699 image_get_hdr_l(size) /* image_get_size */
700 image_get_hdr_l(load) /* image_get_load */
701 image_get_hdr_l(ep) /* image_get_ep */
702 image_get_hdr_l(dcrc) /* image_get_dcrc */
704 #define image_get_hdr_b(f) \
705 static inline uint8_t image_get_##f(const image_header_t *hdr) \
707 return hdr->ih_##f; \
709 image_get_hdr_b(os) /* image_get_os */
710 image_get_hdr_b(arch) /* image_get_arch */
711 image_get_hdr_b(type) /* image_get_type */
712 image_get_hdr_b(comp) /* image_get_comp */
714 static inline char *image_get_name(const image_header_t *hdr)
716 return (char *)hdr->ih_name;
719 static inline uint32_t image_get_data_size(const image_header_t *hdr)
721 return image_get_size(hdr);
725 * image_get_data - get image payload start address
728 * image_get_data() returns address of the image payload. For single
729 * component images it is image data start. For multi component
730 * images it points to the null terminated table of sub-images sizes.
733 * image payload data start address
735 static inline ulong image_get_data(const image_header_t *hdr)
737 return ((ulong)hdr + image_get_header_size());
740 static inline uint32_t image_get_image_size(const image_header_t *hdr)
742 return (image_get_size(hdr) + image_get_header_size());
744 static inline ulong image_get_image_end(const image_header_t *hdr)
746 return ((ulong)hdr + image_get_image_size(hdr));
749 #define image_set_hdr_l(f) \
750 static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
752 hdr->ih_##f = cpu_to_uimage(val); \
754 image_set_hdr_l(magic) /* image_set_magic */
755 image_set_hdr_l(hcrc) /* image_set_hcrc */
756 image_set_hdr_l(time) /* image_set_time */
757 image_set_hdr_l(size) /* image_set_size */
758 image_set_hdr_l(load) /* image_set_load */
759 image_set_hdr_l(ep) /* image_set_ep */
760 image_set_hdr_l(dcrc) /* image_set_dcrc */
762 #define image_set_hdr_b(f) \
763 static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
767 image_set_hdr_b(os) /* image_set_os */
768 image_set_hdr_b(arch) /* image_set_arch */
769 image_set_hdr_b(type) /* image_set_type */
770 image_set_hdr_b(comp) /* image_set_comp */
772 static inline void image_set_name(image_header_t *hdr, const char *name)
774 strncpy(image_get_name(hdr), name, IH_NMLEN);
777 int image_check_hcrc(const image_header_t *hdr);
778 int image_check_dcrc(const image_header_t *hdr);
780 ulong getenv_bootm_low(void);
781 phys_size_t getenv_bootm_size(void);
782 phys_size_t getenv_bootm_mapsize(void);
784 void memmove_wd(void *to, void *from, size_t len, ulong chunksz);
786 static inline int image_check_magic(const image_header_t *hdr)
788 return (image_get_magic(hdr) == IH_MAGIC);
790 static inline int image_check_type(const image_header_t *hdr, uint8_t type)
792 return (image_get_type(hdr) == type);
794 static inline int image_check_arch(const image_header_t *hdr, uint8_t arch)
796 return (image_get_arch(hdr) == arch);
798 static inline int image_check_os(const image_header_t *hdr, uint8_t os)
800 return (image_get_os(hdr) == os);
803 ulong image_multi_count(const image_header_t *hdr);
804 void image_multi_getimg(const image_header_t *hdr, ulong idx,
805 ulong *data, ulong *len);
807 void image_print_contents(const void *hdr);
810 static inline int image_check_target_arch(const image_header_t *hdr)
812 #ifndef IH_ARCH_DEFAULT
813 # error "please define IH_ARCH_DEFAULT in your arch asm/u-boot.h"
815 return image_check_arch(hdr, IH_ARCH_DEFAULT);
817 #endif /* USE_HOSTCC */
820 * Set up properties in the FDT
822 * This sets up properties in the FDT that is to be passed to linux.
824 * @images: Images information
825 * @blob: FDT to update
826 * @of_size: Size of the FDT
827 * @lmb: Points to logical memory block structure
828 * @return 0 if ok, <0 on failure
830 int image_setup_libfdt(bootm_headers_t *images, void *blob,
831 int of_size, struct lmb *lmb);
834 * Set up the FDT to use for booting a kernel
836 * This performs ramdisk setup, sets up the FDT if required, and adds
837 * paramters to the FDT if libfdt is available.
839 * @param images Images information
840 * @return 0 if ok, <0 on failure
842 int image_setup_linux(bootm_headers_t *images);
845 * bootz_setup() - Extract stat and size of a Linux xImage
847 * @image: Address of image
848 * @start: Returns start address of image
849 * @end : Returns end address of image
850 * @return 0 if OK, 1 if the image was not recognised
852 int bootz_setup(ulong image, ulong *start, ulong *end);
855 /*******************************************************************/
856 /* New uImage format specific code (prefixed with fit_) */
857 /*******************************************************************/
859 #define FIT_IMAGES_PATH "/images"
860 #define FIT_CONFS_PATH "/configurations"
862 /* hash/signature node */
863 #define FIT_HASH_NODENAME "hash"
864 #define FIT_ALGO_PROP "algo"
865 #define FIT_VALUE_PROP "value"
866 #define FIT_IGNORE_PROP "uboot-ignore"
867 #define FIT_SIG_NODENAME "signature"
870 #define FIT_DATA_PROP "data"
871 #define FIT_TIMESTAMP_PROP "timestamp"
872 #define FIT_DESC_PROP "description"
873 #define FIT_ARCH_PROP "arch"
874 #define FIT_TYPE_PROP "type"
875 #define FIT_OS_PROP "os"
876 #define FIT_COMP_PROP "compression"
877 #define FIT_ENTRY_PROP "entry"
878 #define FIT_LOAD_PROP "load"
880 /* configuration node */
881 #define FIT_KERNEL_PROP "kernel"
882 #define FIT_RAMDISK_PROP "ramdisk"
883 #define FIT_FDT_PROP "fdt"
884 #define FIT_LOADABLE_PROP "loadables"
885 #define FIT_DEFAULT_PROP "default"
886 #define FIT_SETUP_PROP "setup"
887 #define FIT_FPGA_PROP "fpga"
889 #define FIT_MAX_HASH_LEN HASH_MAX_DIGEST_SIZE
892 /* cmdline argument format parsing */
893 int fit_parse_conf(const char *spec, ulong addr_curr,
894 ulong *addr, const char **conf_name);
895 int fit_parse_subimage(const char *spec, ulong addr_curr,
896 ulong *addr, const char **image_name);
898 int fit_get_subimage_count(const void *fit, int images_noffset);
899 void fit_print_contents(const void *fit);
900 void fit_image_print(const void *fit, int noffset, const char *p);
903 * fit_get_end - get FIT image size
904 * @fit: pointer to the FIT format image header
907 * size of the FIT image (blob) in memory
909 static inline ulong fit_get_size(const void *fit)
911 return fdt_totalsize(fit);
915 * fit_get_end - get FIT image end
916 * @fit: pointer to the FIT format image header
919 * end address of the FIT image (blob) in memory
921 ulong fit_get_end(const void *fit);
924 * fit_get_name - get FIT node name
925 * @fit: pointer to the FIT format image header
929 * pointer to node name, on success
931 static inline const char *fit_get_name(const void *fit_hdr,
932 int noffset, int *len)
934 return fdt_get_name(fit_hdr, noffset, len);
937 int fit_get_desc(const void *fit, int noffset, char **desc);
938 int fit_get_timestamp(const void *fit, int noffset, time_t *timestamp);
940 int fit_image_get_node(const void *fit, const char *image_uname);
941 int fit_image_get_os(const void *fit, int noffset, uint8_t *os);
942 int fit_image_get_arch(const void *fit, int noffset, uint8_t *arch);
943 int fit_image_get_type(const void *fit, int noffset, uint8_t *type);
944 int fit_image_get_comp(const void *fit, int noffset, uint8_t *comp);
945 int fit_image_get_load(const void *fit, int noffset, ulong *load);
946 int fit_image_get_entry(const void *fit, int noffset, ulong *entry);
947 int fit_image_get_data(const void *fit, int noffset,
948 const void **data, size_t *size);
950 int fit_image_hash_get_algo(const void *fit, int noffset, char **algo);
951 int fit_image_hash_get_value(const void *fit, int noffset, uint8_t **value,
954 int fit_set_timestamp(void *fit, int noffset, time_t timestamp);
957 * fit_add_verification_data() - add verification data to FIT image nodes
959 * @keydir: Directory containing keys
960 * @kwydest: FDT blob to write public key information to
961 * @fit: Pointer to the FIT format image header
962 * @comment: Comment to add to signature nodes
963 * @require_keys: Mark all keys as 'required'
965 * Adds hash values for all component images in the FIT blob.
966 * Hashes are calculated for all component images which have hash subnodes
967 * with algorithm property set to one of the supported hash algorithms.
969 * Also add signatures if signature nodes are present.
973 * libfdt error code, on failure
975 int fit_add_verification_data(const char *keydir, void *keydest, void *fit,
976 const char *comment, int require_keys);
978 int fit_image_verify(const void *fit, int noffset);
979 int fit_config_verify(const void *fit, int conf_noffset);
980 int fit_all_image_verify(const void *fit);
981 int fit_image_check_os(const void *fit, int noffset, uint8_t os);
982 int fit_image_check_arch(const void *fit, int noffset, uint8_t arch);
983 int fit_image_check_type(const void *fit, int noffset, uint8_t type);
984 int fit_image_check_comp(const void *fit, int noffset, uint8_t comp);
985 int fit_check_format(const void *fit);
987 int fit_conf_find_compat(const void *fit, const void *fdt);
988 int fit_conf_get_node(const void *fit, const char *conf_uname);
991 * fit_conf_get_prop_node() - Get node refered to by a configuration
993 * @noffset: Offset of conf@xxx node to check
994 * @prop_name: Property to read from the conf node
996 * The conf@ nodes contain references to other nodes, using properties
997 * like 'kernel = "kernel@1"'. Given such a property name (e.g. "kernel"),
998 * return the offset of the node referred to (e.g. offset of node
999 * "/images/kernel@1".
1001 int fit_conf_get_prop_node(const void *fit, int noffset,
1002 const char *prop_name);
1004 void fit_conf_print(const void *fit, int noffset, const char *p);
1006 int fit_check_ramdisk(const void *fit, int os_noffset,
1007 uint8_t arch, int verify);
1009 int calculate_hash(const void *data, int data_len, const char *algo,
1010 uint8_t *value, int *value_len);
1013 * At present we only support signing on the host, and verification on the
1016 #if defined(CONFIG_FIT_SIGNATURE)
1018 # define IMAGE_ENABLE_SIGN 1
1019 # define IMAGE_ENABLE_VERIFY 1
1020 # include <openssl/evp.h>
1022 # define IMAGE_ENABLE_SIGN 0
1023 # define IMAGE_ENABLE_VERIFY 1
1026 # define IMAGE_ENABLE_SIGN 0
1027 # define IMAGE_ENABLE_VERIFY 0
1031 void *image_get_host_blob(void);
1032 void image_set_host_blob(void *host_blob);
1033 # define gd_fdt_blob() image_get_host_blob()
1035 # define gd_fdt_blob() (gd->fdt_blob)
1038 #ifdef CONFIG_FIT_BEST_MATCH
1039 #define IMAGE_ENABLE_BEST_MATCH 1
1041 #define IMAGE_ENABLE_BEST_MATCH 0
1044 /* Information passed to the signing routines */
1045 struct image_sign_info {
1046 const char *keydir; /* Directory conaining keys */
1047 const char *keyname; /* Name of key to use */
1048 void *fit; /* Pointer to FIT blob */
1049 int node_offset; /* Offset of signature node */
1050 struct image_sig_algo *algo; /* Algorithm information */
1051 const void *fdt_blob; /* FDT containing public keys */
1052 int required_keynode; /* Node offset of key to use: -1=any */
1053 const char *require_keys; /* Value for 'required' property */
1055 #endif /* Allow struct image_region to always be defined for rsa.h */
1057 /* A part of an image, used for hashing */
1058 struct image_region {
1063 #if IMAGE_ENABLE_FIT
1065 #if IMAGE_ENABLE_VERIFY
1066 # include <u-boot/rsa-checksum.h>
1068 struct checksum_algo {
1070 const int checksum_len;
1072 #if IMAGE_ENABLE_SIGN
1073 const EVP_MD *(*calculate_sign)(void);
1075 int (*calculate)(const char *name,
1076 const struct image_region region[],
1077 int region_count, uint8_t *checksum);
1078 const uint8_t *rsa_padding;
1081 struct image_sig_algo {
1082 const char *name; /* Name of algorithm */
1085 * sign() - calculate and return signature for given input data
1087 * @info: Specifies key and FIT information
1088 * @data: Pointer to the input data
1089 * @data_len: Data length
1090 * @sigp: Set to an allocated buffer holding the signature
1091 * @sig_len: Set to length of the calculated hash
1093 * This computes input data signature according to selected algorithm.
1094 * Resulting signature value is placed in an allocated buffer, the
1095 * pointer is returned as *sigp. The length of the calculated
1096 * signature is returned via the sig_len pointer argument. The caller
1097 * should free *sigp.
1099 * @return: 0, on success, -ve on error
1101 int (*sign)(struct image_sign_info *info,
1102 const struct image_region region[],
1103 int region_count, uint8_t **sigp, uint *sig_len);
1106 * add_verify_data() - Add verification information to FDT
1108 * Add public key information to the FDT node, suitable for
1109 * verification at run-time. The information added depends on the
1110 * algorithm being used.
1112 * @info: Specifies key and FIT information
1113 * @keydest: Destination FDT blob for public key data
1114 * @return: 0, on success, -ve on error
1116 int (*add_verify_data)(struct image_sign_info *info, void *keydest);
1119 * verify() - Verify a signature against some data
1121 * @info: Specifies key and FIT information
1122 * @data: Pointer to the input data
1123 * @data_len: Data length
1125 * @sig_len: Number of bytes in signature
1126 * @return 0 if verified, -ve on error
1128 int (*verify)(struct image_sign_info *info,
1129 const struct image_region region[], int region_count,
1130 uint8_t *sig, uint sig_len);
1132 /* pointer to checksum algorithm */
1133 struct checksum_algo *checksum;
1137 * image_get_sig_algo() - Look up a signature algortihm
1139 * @param name Name of algorithm
1140 * @return pointer to algorithm information, or NULL if not found
1142 struct image_sig_algo *image_get_sig_algo(const char *name);
1145 * fit_image_verify_required_sigs() - Verify signatures marked as 'required'
1147 * @fit: FIT to check
1148 * @image_noffset: Offset of image node to check
1149 * @data: Image data to check
1150 * @size: Size of image data
1151 * @sig_blob: FDT containing public keys
1152 * @no_sigsp: Returns 1 if no signatures were required, and
1153 * therefore nothing was checked. The caller may wish
1154 * to fall back to other mechanisms, or refuse to
1156 * @return 0 if all verified ok, <0 on error
1158 int fit_image_verify_required_sigs(const void *fit, int image_noffset,
1159 const char *data, size_t size, const void *sig_blob,
1163 * fit_image_check_sig() - Check a single image signature node
1165 * @fit: FIT to check
1166 * @noffset: Offset of signature node to check
1167 * @data: Image data to check
1168 * @size: Size of image data
1169 * @required_keynode: Offset in the control FDT of the required key node,
1170 * if any. If this is given, then the image wil not
1171 * pass verification unless that key is used. If this is
1172 * -1 then any signature will do.
1173 * @err_msgp: In the event of an error, this will be pointed to a
1174 * help error string to display to the user.
1175 * @return 0 if all verified ok, <0 on error
1177 int fit_image_check_sig(const void *fit, int noffset, const void *data,
1178 size_t size, int required_keynode, char **err_msgp);
1181 * fit_region_make_list() - Make a list of regions to hash
1183 * Given a list of FIT regions (offset, size) provided by libfdt, create
1184 * a list of regions (void *, size) for use by the signature creationg
1185 * and verification code.
1187 * @fit: FIT image to process
1188 * @fdt_regions: Regions as returned by libfdt
1189 * @count: Number of regions returned by libfdt
1190 * @region: Place to put list of regions (NULL to allocate it)
1191 * @return pointer to list of regions, or NULL if out of memory
1193 struct image_region *fit_region_make_list(const void *fit,
1194 struct fdt_region *fdt_regions, int count,
1195 struct image_region *region);
1197 static inline int fit_image_check_target_arch(const void *fdt, int node)
1200 return fit_image_check_arch(fdt, node, IH_ARCH_DEFAULT);
1206 #ifdef CONFIG_FIT_VERBOSE
1207 #define fit_unsupported(msg) printf("! %s:%d " \
1208 "FIT images not supported for '%s'\n", \
1209 __FILE__, __LINE__, (msg))
1211 #define fit_unsupported_reset(msg) printf("! %s:%d " \
1212 "FIT images not supported for '%s' " \
1213 "- must reset board to recover!\n", \
1214 __FILE__, __LINE__, (msg))
1216 #define fit_unsupported(msg)
1217 #define fit_unsupported_reset(msg)
1218 #endif /* CONFIG_FIT_VERBOSE */
1219 #endif /* CONFIG_FIT */
1221 #if defined(CONFIG_ANDROID_BOOT_IMAGE)
1222 struct andr_img_hdr;
1223 int android_image_check_header(const struct andr_img_hdr *hdr);
1224 int android_image_get_kernel(const struct andr_img_hdr *hdr, int verify,
1225 ulong *os_data, ulong *os_len);
1226 int android_image_get_ramdisk(const struct andr_img_hdr *hdr,
1227 ulong *rd_data, ulong *rd_len);
1228 ulong android_image_get_end(const struct andr_img_hdr *hdr);
1229 ulong android_image_get_kload(const struct andr_img_hdr *hdr);
1230 void android_print_contents(const struct andr_img_hdr *hdr);
1232 #endif /* CONFIG_ANDROID_BOOT_IMAGE */
1235 * board_fit_config_name_match() - Check for a matching board name
1237 * This is used when SPL loads a FIT containing multiple device tree files
1238 * and wants to work out which one to use. The description of each one is
1239 * passed to this function. The description comes from the 'description' field
1240 * in each (FDT) image node.
1242 * @name: Device tree description
1243 * @return 0 if this device tree should be used, non-zero to try the next
1245 int board_fit_config_name_match(const char *name);
1247 #ifdef CONFIG_SPL_FIT_IMAGE_POST_PROCESS
1249 * board_fit_image_post_process() - Do any post-process on FIT binary data
1251 * This is used to do any sort of image manipulation, verification, decryption
1252 * etc. in a platform or board specific way. Obviously, anything done here would
1253 * need to be comprehended in how the images were prepared before being injected
1254 * into the FIT creation (i.e. the binary blobs would have been pre-processed
1255 * before being added to the FIT image).
1257 * @image: pointer to the image start pointer
1258 * @size: pointer to the image size
1259 * @return no return value (failure should be handled internally)
1261 void board_fit_image_post_process(void **p_image, size_t *p_size);
1262 #endif /* CONFIG_SPL_FIT_IMAGE_POST_PROCESS */
1264 #endif /* __IMAGE_H__ */