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 */
30 #define CONFIG_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 #endif /* USE_HOSTCC */
48 #if defined(CONFIG_FIT)
51 #include <fdt_support.h>
52 # ifdef CONFIG_SPL_BUILD
53 # ifdef CONFIG_SPL_CRC32_SUPPORT
54 # define IMAGE_ENABLE_CRC32 1
56 # ifdef CONFIG_SPL_MD5_SUPPORT
57 # define IMAGE_ENABLE_MD5 1
59 # ifdef CONFIG_SPL_SHA1_SUPPORT
60 # define IMAGE_ENABLE_SHA1 1
62 # ifdef CONFIG_SPL_SHA256_SUPPORT
63 # define IMAGE_ENABLE_SHA256 1
66 # define CONFIG_CRC32 /* FIT images need CRC32 support */
67 # define CONFIG_MD5 /* and MD5 */
68 # define CONFIG_SHA1 /* and SHA1 */
69 # define CONFIG_SHA256 /* and SHA256 */
70 # define IMAGE_ENABLE_CRC32 1
71 # define IMAGE_ENABLE_MD5 1
72 # define IMAGE_ENABLE_SHA1 1
73 # define IMAGE_ENABLE_SHA256 1
76 #ifdef CONFIG_FIT_DISABLE_SHA256
78 #undef IMAGE_ENABLE_SHA256
81 #ifndef IMAGE_ENABLE_CRC32
82 #define IMAGE_ENABLE_CRC32 0
85 #ifndef IMAGE_ENABLE_MD5
86 #define IMAGE_ENABLE_MD5 0
89 #ifndef IMAGE_ENABLE_SHA1
90 #define IMAGE_ENABLE_SHA1 0
93 #ifndef IMAGE_ENABLE_SHA256
94 #define IMAGE_ENABLE_SHA256 0
97 #endif /* CONFIG_FIT */
99 #ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH
100 # define IMAGE_ENABLE_RAMDISK_HIGH 1
102 # define IMAGE_ENABLE_RAMDISK_HIGH 0
105 #ifdef CONFIG_OF_LIBFDT
106 # define IMAGE_ENABLE_OF_LIBFDT 1
108 # define IMAGE_ENABLE_OF_LIBFDT 0
111 #ifdef CONFIG_SYS_BOOT_GET_CMDLINE
112 # define IMAGE_BOOT_GET_CMDLINE 1
114 # define IMAGE_BOOT_GET_CMDLINE 0
117 #ifdef CONFIG_OF_BOARD_SETUP
118 # define IMAGE_OF_BOARD_SETUP 1
120 # define IMAGE_OF_BOARD_SETUP 0
123 #ifdef CONFIG_OF_SYSTEM_SETUP
124 # define IMAGE_OF_SYSTEM_SETUP 1
126 # define IMAGE_OF_SYSTEM_SETUP 0
130 * Operating System Codes
132 #define IH_OS_INVALID 0 /* Invalid OS */
133 #define IH_OS_OPENBSD 1 /* OpenBSD */
134 #define IH_OS_NETBSD 2 /* NetBSD */
135 #define IH_OS_FREEBSD 3 /* FreeBSD */
136 #define IH_OS_4_4BSD 4 /* 4.4BSD */
137 #define IH_OS_LINUX 5 /* Linux */
138 #define IH_OS_SVR4 6 /* SVR4 */
139 #define IH_OS_ESIX 7 /* Esix */
140 #define IH_OS_SOLARIS 8 /* Solaris */
141 #define IH_OS_IRIX 9 /* Irix */
142 #define IH_OS_SCO 10 /* SCO */
143 #define IH_OS_DELL 11 /* Dell */
144 #define IH_OS_NCR 12 /* NCR */
145 #define IH_OS_LYNXOS 13 /* LynxOS */
146 #define IH_OS_VXWORKS 14 /* VxWorks */
147 #define IH_OS_PSOS 15 /* pSOS */
148 #define IH_OS_QNX 16 /* QNX */
149 #define IH_OS_U_BOOT 17 /* Firmware */
150 #define IH_OS_RTEMS 18 /* RTEMS */
151 #define IH_OS_ARTOS 19 /* ARTOS */
152 #define IH_OS_UNITY 20 /* Unity OS */
153 #define IH_OS_INTEGRITY 21 /* INTEGRITY */
154 #define IH_OS_OSE 22 /* OSE */
155 #define IH_OS_PLAN9 23 /* Plan 9 */
156 #define IH_OS_OPENRTOS 24 /* OpenRTOS */
159 * CPU Architecture Codes (supported by Linux)
161 #define IH_ARCH_INVALID 0 /* Invalid CPU */
162 #define IH_ARCH_ALPHA 1 /* Alpha */
163 #define IH_ARCH_ARM 2 /* ARM */
164 #define IH_ARCH_I386 3 /* Intel x86 */
165 #define IH_ARCH_IA64 4 /* IA64 */
166 #define IH_ARCH_MIPS 5 /* MIPS */
167 #define IH_ARCH_MIPS64 6 /* MIPS 64 Bit */
168 #define IH_ARCH_PPC 7 /* PowerPC */
169 #define IH_ARCH_S390 8 /* IBM S390 */
170 #define IH_ARCH_SH 9 /* SuperH */
171 #define IH_ARCH_SPARC 10 /* Sparc */
172 #define IH_ARCH_SPARC64 11 /* Sparc 64 Bit */
173 #define IH_ARCH_M68K 12 /* M68K */
174 #define IH_ARCH_MICROBLAZE 14 /* MicroBlaze */
175 #define IH_ARCH_NIOS2 15 /* Nios-II */
176 #define IH_ARCH_BLACKFIN 16 /* Blackfin */
177 #define IH_ARCH_AVR32 17 /* AVR32 */
178 #define IH_ARCH_ST200 18 /* STMicroelectronics ST200 */
179 #define IH_ARCH_SANDBOX 19 /* Sandbox architecture (test only) */
180 #define IH_ARCH_NDS32 20 /* ANDES Technology - NDS32 */
181 #define IH_ARCH_OPENRISC 21 /* OpenRISC 1000 */
182 #define IH_ARCH_ARM64 22 /* ARM64 */
183 #define IH_ARCH_ARC 23 /* Synopsys DesignWare ARC */
184 #define IH_ARCH_X86_64 24 /* AMD x86_64, Intel and Via */
189 * "Standalone Programs" are directly runnable in the environment
190 * provided by U-Boot; it is expected that (if they behave
191 * well) you can continue to work in U-Boot after return from
192 * the Standalone Program.
193 * "OS Kernel Images" are usually images of some Embedded OS which
194 * will take over control completely. Usually these programs
195 * will install their own set of exception handlers, device
196 * drivers, set up the MMU, etc. - this means, that you cannot
197 * expect to re-enter U-Boot except by resetting the CPU.
198 * "RAMDisk Images" are more or less just data blocks, and their
199 * parameters (address, size) are passed to an OS kernel that is
201 * "Multi-File Images" contain several images, typically an OS
202 * (Linux) kernel image and one or more data images like
203 * RAMDisks. This construct is useful for instance when you want
204 * to boot over the network using BOOTP etc., where the boot
205 * server provides just a single image file, but you want to get
206 * for instance an OS kernel and a RAMDisk image.
208 * "Multi-File Images" start with a list of image sizes, each
209 * image size (in bytes) specified by an "uint32_t" in network
210 * byte order. This list is terminated by an "(uint32_t)0".
211 * Immediately after the terminating 0 follow the images, one by
212 * one, all aligned on "uint32_t" boundaries (size rounded up to
213 * a multiple of 4 bytes - except for the last file).
215 * "Firmware Images" are binary images containing firmware (like
216 * U-Boot or FPGA images) which usually will be programmed to
219 * "Script files" are command sequences that will be executed by
220 * U-Boot's command interpreter; this feature is especially
221 * useful when you configure U-Boot to use a real shell (hush)
222 * as command interpreter (=> Shell Scripts).
225 #define IH_TYPE_INVALID 0 /* Invalid Image */
226 #define IH_TYPE_STANDALONE 1 /* Standalone Program */
227 #define IH_TYPE_KERNEL 2 /* OS Kernel Image */
228 #define IH_TYPE_RAMDISK 3 /* RAMDisk Image */
229 #define IH_TYPE_MULTI 4 /* Multi-File Image */
230 #define IH_TYPE_FIRMWARE 5 /* Firmware Image */
231 #define IH_TYPE_SCRIPT 6 /* Script file */
232 #define IH_TYPE_FILESYSTEM 7 /* Filesystem Image (any type) */
233 #define IH_TYPE_FLATDT 8 /* Binary Flat Device Tree Blob */
234 #define IH_TYPE_KWBIMAGE 9 /* Kirkwood Boot Image */
235 #define IH_TYPE_IMXIMAGE 10 /* Freescale IMXBoot Image */
236 #define IH_TYPE_UBLIMAGE 11 /* Davinci UBL Image */
237 #define IH_TYPE_OMAPIMAGE 12 /* TI OMAP Config Header Image */
238 #define IH_TYPE_AISIMAGE 13 /* TI Davinci AIS Image */
239 #define IH_TYPE_KERNEL_NOLOAD 14 /* OS Kernel Image, can run from any load address */
240 #define IH_TYPE_PBLIMAGE 15 /* Freescale PBL Boot Image */
241 #define IH_TYPE_MXSIMAGE 16 /* Freescale MXSBoot Image */
242 #define IH_TYPE_GPIMAGE 17 /* TI Keystone GPHeader Image */
243 #define IH_TYPE_ATMELIMAGE 18 /* ATMEL ROM bootable Image */
244 #define IH_TYPE_SOCFPGAIMAGE 19 /* Altera SOCFPGA Preloader */
245 #define IH_TYPE_X86_SETUP 20 /* x86 setup.bin Image */
246 #define IH_TYPE_LPC32XXIMAGE 21 /* x86 setup.bin Image */
247 #define IH_TYPE_LOADABLE 22 /* A list of typeless images */
248 #define IH_TYPE_RKIMAGE 23 /* Rockchip Boot Image */
249 #define IH_TYPE_RKSD 24 /* Rockchip SD card */
250 #define IH_TYPE_RKSPI 25 /* Rockchip SPI image */
252 #define IH_TYPE_COUNT 26 /* Number of image types */
257 #define IH_COMP_NONE 0 /* No Compression Used */
258 #define IH_COMP_GZIP 1 /* gzip Compression Used */
259 #define IH_COMP_BZIP2 2 /* bzip2 Compression Used */
260 #define IH_COMP_LZMA 3 /* lzma Compression Used */
261 #define IH_COMP_LZO 4 /* lzo Compression Used */
262 #define IH_COMP_LZ4 5 /* lz4 Compression Used */
264 #define IH_MAGIC 0x27051956 /* Image Magic Number */
265 #define IH_NMLEN 32 /* Image Name Length */
267 /* Reused from common.h */
268 #define ROUND(a, b) (((a) + (b) - 1) & ~((b) - 1))
271 * Legacy format image header,
272 * all data in network byte order (aka natural aka bigendian).
274 typedef struct image_header {
275 __be32 ih_magic; /* Image Header Magic Number */
276 __be32 ih_hcrc; /* Image Header CRC Checksum */
277 __be32 ih_time; /* Image Creation Timestamp */
278 __be32 ih_size; /* Image Data Size */
279 __be32 ih_load; /* Data Load Address */
280 __be32 ih_ep; /* Entry Point Address */
281 __be32 ih_dcrc; /* Image Data CRC Checksum */
282 uint8_t ih_os; /* Operating System */
283 uint8_t ih_arch; /* CPU architecture */
284 uint8_t ih_type; /* Image Type */
285 uint8_t ih_comp; /* Compression Type */
286 uint8_t ih_name[IH_NMLEN]; /* Image Name */
289 typedef struct image_info {
290 ulong start, end; /* start/end of blob */
291 ulong image_start, image_len; /* start of image within blob, len of image */
292 ulong load; /* load addr for the image */
293 uint8_t comp, type, os; /* compression, type of image, os type */
294 uint8_t arch; /* CPU architecture */
298 * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
301 typedef struct bootm_headers {
303 * Legacy os image header, if it is a multi component image
304 * then boot_get_ramdisk() and get_fdt() will attempt to get
305 * data from second and third component accordingly.
307 image_header_t *legacy_hdr_os; /* image header pointer */
308 image_header_t legacy_hdr_os_copy; /* header copy */
309 ulong legacy_hdr_valid;
311 #if defined(CONFIG_FIT)
312 const char *fit_uname_cfg; /* configuration node unit name */
314 void *fit_hdr_os; /* os FIT image header */
315 const char *fit_uname_os; /* os subimage node unit name */
316 int fit_noffset_os; /* os subimage node offset */
318 void *fit_hdr_rd; /* init ramdisk FIT image header */
319 const char *fit_uname_rd; /* init ramdisk subimage node unit name */
320 int fit_noffset_rd; /* init ramdisk subimage node offset */
322 void *fit_hdr_fdt; /* FDT blob FIT image header */
323 const char *fit_uname_fdt; /* FDT blob subimage node unit name */
324 int fit_noffset_fdt;/* FDT blob subimage node offset */
326 void *fit_hdr_setup; /* x86 setup FIT image header */
327 const char *fit_uname_setup; /* x86 setup subimage node name */
328 int fit_noffset_setup;/* x86 setup subimage node offset */
332 image_info_t os; /* os image info */
333 ulong ep; /* entry point of OS */
335 ulong rd_start, rd_end;/* ramdisk start/end */
337 char *ft_addr; /* flat dev tree address */
338 ulong ft_len; /* length of flat device tree */
347 int verify; /* getenv("verify")[0] != 'n' */
349 #define BOOTM_STATE_START (0x00000001)
350 #define BOOTM_STATE_FINDOS (0x00000002)
351 #define BOOTM_STATE_FINDOTHER (0x00000004)
352 #define BOOTM_STATE_LOADOS (0x00000008)
353 #define BOOTM_STATE_RAMDISK (0x00000010)
354 #define BOOTM_STATE_FDT (0x00000020)
355 #define BOOTM_STATE_OS_CMDLINE (0x00000040)
356 #define BOOTM_STATE_OS_BD_T (0x00000080)
357 #define BOOTM_STATE_OS_PREP (0x00000100)
358 #define BOOTM_STATE_OS_FAKE_GO (0x00000200) /* 'Almost' run the OS */
359 #define BOOTM_STATE_OS_GO (0x00000400)
363 struct lmb lmb; /* for memory mgmt */
367 extern bootm_headers_t images;
370 * Some systems (for example LWMON) have very short watchdog periods;
371 * we must make sure to split long operations like memmove() or
372 * checksum calculations into reasonable chunks.
375 #define CHUNKSZ (64 * 1024)
378 #ifndef CHUNKSZ_CRC32
379 #define CHUNKSZ_CRC32 (64 * 1024)
383 #define CHUNKSZ_MD5 (64 * 1024)
387 #define CHUNKSZ_SHA1 (64 * 1024)
390 #define uimage_to_cpu(x) be32_to_cpu(x)
391 #define cpu_to_uimage(x) cpu_to_be32(x)
394 * Translation table for entries of a specific type; used by
395 * get_table_entry_id() and get_table_entry_name().
397 typedef struct table_entry {
399 char *sname; /* short (input) name to find table entry */
400 char *lname; /* long (output) name to print for messages */
404 * get_table_entry_id() scans the translation table trying to find an
405 * entry that matches the given short name. If a matching entry is
406 * found, it's id is returned to the caller.
408 int get_table_entry_id(const table_entry_t *table,
409 const char *table_name, const char *name);
411 * get_table_entry_name() scans the translation table trying to find
412 * an entry that matches the given id. If a matching entry is found,
413 * its long name is returned to the caller.
415 char *get_table_entry_name(const table_entry_t *table, char *msg, int id);
417 const char *genimg_get_os_name(uint8_t os);
418 const char *genimg_get_arch_name(uint8_t arch);
419 const char *genimg_get_type_name(uint8_t type);
422 * genimg_get_type_short_name() - get the short name for an image type
424 * @param type Image type (IH_TYPE_...)
425 * @return image short name, or "unknown" if unknown
427 const char *genimg_get_type_short_name(uint8_t type);
429 const char *genimg_get_comp_name(uint8_t comp);
430 int genimg_get_os_id(const char *name);
431 int genimg_get_arch_id(const char *name);
432 int genimg_get_type_id(const char *name);
433 int genimg_get_comp_id(const char *name);
434 void genimg_print_size(uint32_t size);
436 #if defined(CONFIG_TIMESTAMP) || defined(CONFIG_CMD_DATE) || \
438 #define IMAGE_ENABLE_TIMESTAMP 1
440 #define IMAGE_ENABLE_TIMESTAMP 0
442 void genimg_print_time(time_t timestamp);
444 /* What to do with a image load address ('load = <> 'in the FIT) */
446 FIT_LOAD_IGNORED, /* Ignore load address */
447 FIT_LOAD_OPTIONAL, /* Can be provided, but optional */
448 FIT_LOAD_OPTIONAL_NON_ZERO, /* Optional, a value of 0 is ignored */
449 FIT_LOAD_REQUIRED, /* Must be provided */
452 int boot_get_setup(bootm_headers_t *images, uint8_t arch, ulong *setup_start,
456 /* Image format types, returned by _get_format() routine */
457 #define IMAGE_FORMAT_INVALID 0x00
458 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
459 #define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */
461 #define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */
462 #define IMAGE_FORMAT_ANDROID 0x03 /* Android boot image */
464 ulong genimg_get_kernel_addr_fit(char * const img_addr,
465 const char **fit_uname_config,
466 const char **fit_uname_kernel);
467 ulong genimg_get_kernel_addr(char * const img_addr);
468 int genimg_get_format(const void *img_addr);
469 int genimg_has_config(bootm_headers_t *images);
470 ulong genimg_get_image(ulong img_addr);
472 int boot_get_ramdisk(int argc, char * const argv[], bootm_headers_t *images,
473 uint8_t arch, ulong *rd_start, ulong *rd_end);
476 * boot_get_loadable - routine to load a list of binaries to memory
477 * @argc: Ignored Argument
478 * @argv: Ignored Argument
479 * @images: pointer to the bootm images structure
480 * @arch: expected architecture for the image
481 * @ld_start: Ignored Argument
482 * @ld_len: Ignored Argument
484 * boot_get_loadable() will take the given FIT configuration, and look
485 * for a field named "loadables". Loadables, is a list of elements in
486 * the FIT given as strings. exe:
487 * loadables = "linux_kernel@1", "fdt@2";
488 * this function will attempt to parse each string, and load the
489 * corresponding element from the FIT into memory. Once placed,
490 * no aditional actions are taken.
493 * 0, if only valid images or no images are found
494 * error code, if an error occurs during fit_image_load
496 int boot_get_loadable(int argc, char * const argv[], bootm_headers_t *images,
497 uint8_t arch, const ulong *ld_start, ulong * const ld_len);
498 #endif /* !USE_HOSTCC */
500 int boot_get_setup_fit(bootm_headers_t *images, uint8_t arch,
501 ulong *setup_start, ulong *setup_len);
504 * fit_image_load() - load an image from a FIT
506 * This deals with all aspects of loading an image from a FIT, including
507 * selecting the right image based on configuration, verifying it, printing
508 * out progress messages, checking the type/arch/os and optionally copying it
509 * to the right load address.
511 * The property to look up is defined by image_type.
513 * @param images Boot images structure
514 * @param addr Address of FIT in memory
515 * @param fit_unamep On entry this is the requested image name
516 * (e.g. "kernel@1") or NULL to use the default. On exit
517 * points to the selected image name
518 * @param fit_uname_configp On entry this is the requested configuration
519 * name (e.g. "conf@1") or NULL to use the default. On
520 * exit points to the selected configuration name.
521 * @param arch Expected architecture (IH_ARCH_...)
522 * @param image_type Required image type (IH_TYPE_...). If this is
523 * IH_TYPE_KERNEL then we allow IH_TYPE_KERNEL_NOLOAD
525 * @param bootstage_id ID of starting bootstage to use for progress updates.
526 * This will be added to the BOOTSTAGE_SUB values when
527 * calling bootstage_mark()
528 * @param load_op Decribes what to do with the load address
529 * @param datap Returns address of loaded image
530 * @param lenp Returns length of loaded image
531 * @return node offset of image, or -ve error code on error
533 int fit_image_load(bootm_headers_t *images, ulong addr,
534 const char **fit_unamep, const char **fit_uname_configp,
535 int arch, int image_type, int bootstage_id,
536 enum fit_load_op load_op, ulong *datap, ulong *lenp);
540 * fit_get_node_from_config() - Look up an image a FIT by type
542 * This looks in the selected conf@ node (images->fit_uname_cfg) for a
543 * particular image type (e.g. "kernel") and then finds the image that is
546 * For example, for something like:
555 * kernel = "kernel@1";
559 * the function will return the node offset of the kernel@1 node, assuming
560 * that conf@1 is the chosen configuration.
562 * @param images Boot images structure
563 * @param prop_name Property name to look up (FIT_..._PROP)
564 * @param addr Address of FIT in memory
566 int fit_get_node_from_config(bootm_headers_t *images, const char *prop_name,
569 int boot_get_fdt(int flag, int argc, char * const argv[], uint8_t arch,
570 bootm_headers_t *images,
571 char **of_flat_tree, ulong *of_size);
572 void boot_fdt_add_mem_rsv_regions(struct lmb *lmb, void *fdt_blob);
573 int boot_relocate_fdt(struct lmb *lmb, char **of_flat_tree, ulong *of_size);
575 int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len,
576 ulong *initrd_start, ulong *initrd_end);
577 int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end);
578 #ifdef CONFIG_SYS_BOOT_GET_KBD
579 int boot_get_kbd(struct lmb *lmb, bd_t **kbd);
580 #endif /* CONFIG_SYS_BOOT_GET_KBD */
581 #endif /* !USE_HOSTCC */
583 /*******************************************************************/
584 /* Legacy format specific code (prefixed with image_) */
585 /*******************************************************************/
586 static inline uint32_t image_get_header_size(void)
588 return (sizeof(image_header_t));
591 #define image_get_hdr_l(f) \
592 static inline uint32_t image_get_##f(const image_header_t *hdr) \
594 return uimage_to_cpu(hdr->ih_##f); \
596 image_get_hdr_l(magic) /* image_get_magic */
597 image_get_hdr_l(hcrc) /* image_get_hcrc */
598 image_get_hdr_l(time) /* image_get_time */
599 image_get_hdr_l(size) /* image_get_size */
600 image_get_hdr_l(load) /* image_get_load */
601 image_get_hdr_l(ep) /* image_get_ep */
602 image_get_hdr_l(dcrc) /* image_get_dcrc */
604 #define image_get_hdr_b(f) \
605 static inline uint8_t image_get_##f(const image_header_t *hdr) \
607 return hdr->ih_##f; \
609 image_get_hdr_b(os) /* image_get_os */
610 image_get_hdr_b(arch) /* image_get_arch */
611 image_get_hdr_b(type) /* image_get_type */
612 image_get_hdr_b(comp) /* image_get_comp */
614 static inline char *image_get_name(const image_header_t *hdr)
616 return (char *)hdr->ih_name;
619 static inline uint32_t image_get_data_size(const image_header_t *hdr)
621 return image_get_size(hdr);
625 * image_get_data - get image payload start address
628 * image_get_data() returns address of the image payload. For single
629 * component images it is image data start. For multi component
630 * images it points to the null terminated table of sub-images sizes.
633 * image payload data start address
635 static inline ulong image_get_data(const image_header_t *hdr)
637 return ((ulong)hdr + image_get_header_size());
640 static inline uint32_t image_get_image_size(const image_header_t *hdr)
642 return (image_get_size(hdr) + image_get_header_size());
644 static inline ulong image_get_image_end(const image_header_t *hdr)
646 return ((ulong)hdr + image_get_image_size(hdr));
649 #define image_set_hdr_l(f) \
650 static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
652 hdr->ih_##f = cpu_to_uimage(val); \
654 image_set_hdr_l(magic) /* image_set_magic */
655 image_set_hdr_l(hcrc) /* image_set_hcrc */
656 image_set_hdr_l(time) /* image_set_time */
657 image_set_hdr_l(size) /* image_set_size */
658 image_set_hdr_l(load) /* image_set_load */
659 image_set_hdr_l(ep) /* image_set_ep */
660 image_set_hdr_l(dcrc) /* image_set_dcrc */
662 #define image_set_hdr_b(f) \
663 static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
667 image_set_hdr_b(os) /* image_set_os */
668 image_set_hdr_b(arch) /* image_set_arch */
669 image_set_hdr_b(type) /* image_set_type */
670 image_set_hdr_b(comp) /* image_set_comp */
672 static inline void image_set_name(image_header_t *hdr, const char *name)
674 strncpy(image_get_name(hdr), name, IH_NMLEN);
677 int image_check_hcrc(const image_header_t *hdr);
678 int image_check_dcrc(const image_header_t *hdr);
680 ulong getenv_bootm_low(void);
681 phys_size_t getenv_bootm_size(void);
682 phys_size_t getenv_bootm_mapsize(void);
684 void memmove_wd(void *to, void *from, size_t len, ulong chunksz);
686 static inline int image_check_magic(const image_header_t *hdr)
688 return (image_get_magic(hdr) == IH_MAGIC);
690 static inline int image_check_type(const image_header_t *hdr, uint8_t type)
692 return (image_get_type(hdr) == type);
694 static inline int image_check_arch(const image_header_t *hdr, uint8_t arch)
696 return (image_get_arch(hdr) == arch);
698 static inline int image_check_os(const image_header_t *hdr, uint8_t os)
700 return (image_get_os(hdr) == os);
703 ulong image_multi_count(const image_header_t *hdr);
704 void image_multi_getimg(const image_header_t *hdr, ulong idx,
705 ulong *data, ulong *len);
707 void image_print_contents(const void *hdr);
710 static inline int image_check_target_arch(const image_header_t *hdr)
712 #ifndef IH_ARCH_DEFAULT
713 # error "please define IH_ARCH_DEFAULT in your arch asm/u-boot.h"
715 return image_check_arch(hdr, IH_ARCH_DEFAULT);
717 #endif /* USE_HOSTCC */
720 * Set up properties in the FDT
722 * This sets up properties in the FDT that is to be passed to linux.
724 * @images: Images information
725 * @blob: FDT to update
726 * @of_size: Size of the FDT
727 * @lmb: Points to logical memory block structure
728 * @return 0 if ok, <0 on failure
730 int image_setup_libfdt(bootm_headers_t *images, void *blob,
731 int of_size, struct lmb *lmb);
734 * Set up the FDT to use for booting a kernel
736 * This performs ramdisk setup, sets up the FDT if required, and adds
737 * paramters to the FDT if libfdt is available.
739 * @param images Images information
740 * @return 0 if ok, <0 on failure
742 int image_setup_linux(bootm_headers_t *images);
745 * bootz_setup() - Extract stat and size of a Linux xImage
747 * @image: Address of image
748 * @start: Returns start address of image
749 * @end : Returns end address of image
750 * @return 0 if OK, 1 if the image was not recognised
752 int bootz_setup(ulong image, ulong *start, ulong *end);
755 /*******************************************************************/
756 /* New uImage format specific code (prefixed with fit_) */
757 /*******************************************************************/
758 #if defined(CONFIG_FIT)
760 #define FIT_IMAGES_PATH "/images"
761 #define FIT_CONFS_PATH "/configurations"
763 /* hash/signature node */
764 #define FIT_HASH_NODENAME "hash"
765 #define FIT_ALGO_PROP "algo"
766 #define FIT_VALUE_PROP "value"
767 #define FIT_IGNORE_PROP "uboot-ignore"
768 #define FIT_SIG_NODENAME "signature"
771 #define FIT_DATA_PROP "data"
772 #define FIT_TIMESTAMP_PROP "timestamp"
773 #define FIT_DESC_PROP "description"
774 #define FIT_ARCH_PROP "arch"
775 #define FIT_TYPE_PROP "type"
776 #define FIT_OS_PROP "os"
777 #define FIT_COMP_PROP "compression"
778 #define FIT_ENTRY_PROP "entry"
779 #define FIT_LOAD_PROP "load"
781 /* configuration node */
782 #define FIT_KERNEL_PROP "kernel"
783 #define FIT_RAMDISK_PROP "ramdisk"
784 #define FIT_FDT_PROP "fdt"
785 #define FIT_LOADABLE_PROP "loadables"
786 #define FIT_DEFAULT_PROP "default"
787 #define FIT_SETUP_PROP "setup"
789 #define FIT_MAX_HASH_LEN HASH_MAX_DIGEST_SIZE
791 /* cmdline argument format parsing */
792 int fit_parse_conf(const char *spec, ulong addr_curr,
793 ulong *addr, const char **conf_name);
794 int fit_parse_subimage(const char *spec, ulong addr_curr,
795 ulong *addr, const char **image_name);
797 int fit_get_subimage_count(const void *fit, int images_noffset);
798 void fit_print_contents(const void *fit);
799 void fit_image_print(const void *fit, int noffset, const char *p);
802 * fit_get_end - get FIT image size
803 * @fit: pointer to the FIT format image header
806 * size of the FIT image (blob) in memory
808 static inline ulong fit_get_size(const void *fit)
810 return fdt_totalsize(fit);
814 * fit_get_end - get FIT image end
815 * @fit: pointer to the FIT format image header
818 * end address of the FIT image (blob) in memory
820 static inline ulong fit_get_end(const void *fit)
822 return (ulong)fit + fdt_totalsize(fit);
826 * fit_get_name - get FIT node name
827 * @fit: pointer to the FIT format image header
831 * pointer to node name, on success
833 static inline const char *fit_get_name(const void *fit_hdr,
834 int noffset, int *len)
836 return fdt_get_name(fit_hdr, noffset, len);
839 int fit_get_desc(const void *fit, int noffset, char **desc);
840 int fit_get_timestamp(const void *fit, int noffset, time_t *timestamp);
842 int fit_image_get_node(const void *fit, const char *image_uname);
843 int fit_image_get_os(const void *fit, int noffset, uint8_t *os);
844 int fit_image_get_arch(const void *fit, int noffset, uint8_t *arch);
845 int fit_image_get_type(const void *fit, int noffset, uint8_t *type);
846 int fit_image_get_comp(const void *fit, int noffset, uint8_t *comp);
847 int fit_image_get_load(const void *fit, int noffset, ulong *load);
848 int fit_image_get_entry(const void *fit, int noffset, ulong *entry);
849 int fit_image_get_data(const void *fit, int noffset,
850 const void **data, size_t *size);
852 int fit_image_hash_get_algo(const void *fit, int noffset, char **algo);
853 int fit_image_hash_get_value(const void *fit, int noffset, uint8_t **value,
856 int fit_set_timestamp(void *fit, int noffset, time_t timestamp);
859 * fit_add_verification_data() - add verification data to FIT image nodes
861 * @keydir: Directory containing keys
862 * @kwydest: FDT blob to write public key information to
863 * @fit: Pointer to the FIT format image header
864 * @comment: Comment to add to signature nodes
865 * @require_keys: Mark all keys as 'required'
867 * Adds hash values for all component images in the FIT blob.
868 * Hashes are calculated for all component images which have hash subnodes
869 * with algorithm property set to one of the supported hash algorithms.
871 * Also add signatures if signature nodes are present.
875 * libfdt error code, on failure
877 int fit_add_verification_data(const char *keydir, void *keydest, void *fit,
878 const char *comment, int require_keys);
880 int fit_image_verify(const void *fit, int noffset);
881 int fit_config_verify(const void *fit, int conf_noffset);
882 int fit_all_image_verify(const void *fit);
883 int fit_image_check_os(const void *fit, int noffset, uint8_t os);
884 int fit_image_check_arch(const void *fit, int noffset, uint8_t arch);
885 int fit_image_check_type(const void *fit, int noffset, uint8_t type);
886 int fit_image_check_comp(const void *fit, int noffset, uint8_t comp);
887 int fit_check_format(const void *fit);
889 int fit_conf_find_compat(const void *fit, const void *fdt);
890 int fit_conf_get_node(const void *fit, const char *conf_uname);
893 * fit_conf_get_prop_node() - Get node refered to by a configuration
895 * @noffset: Offset of conf@xxx node to check
896 * @prop_name: Property to read from the conf node
898 * The conf@ nodes contain references to other nodes, using properties
899 * like 'kernel = "kernel@1"'. Given such a property name (e.g. "kernel"),
900 * return the offset of the node referred to (e.g. offset of node
901 * "/images/kernel@1".
903 int fit_conf_get_prop_node(const void *fit, int noffset,
904 const char *prop_name);
906 void fit_conf_print(const void *fit, int noffset, const char *p);
908 int fit_check_ramdisk(const void *fit, int os_noffset,
909 uint8_t arch, int verify);
911 int calculate_hash(const void *data, int data_len, const char *algo,
912 uint8_t *value, int *value_len);
915 * At present we only support signing on the host, and verification on the
918 #if defined(CONFIG_FIT_SIGNATURE)
920 # define IMAGE_ENABLE_SIGN 1
921 # define IMAGE_ENABLE_VERIFY 1
922 # include <openssl/evp.h>
924 # define IMAGE_ENABLE_SIGN 0
925 # define IMAGE_ENABLE_VERIFY 1
928 # define IMAGE_ENABLE_SIGN 0
929 # define IMAGE_ENABLE_VERIFY 0
933 void *image_get_host_blob(void);
934 void image_set_host_blob(void *host_blob);
935 # define gd_fdt_blob() image_get_host_blob()
937 # define gd_fdt_blob() (gd->fdt_blob)
940 #ifdef CONFIG_FIT_BEST_MATCH
941 #define IMAGE_ENABLE_BEST_MATCH 1
943 #define IMAGE_ENABLE_BEST_MATCH 0
946 /* Information passed to the signing routines */
947 struct image_sign_info {
948 const char *keydir; /* Directory conaining keys */
949 const char *keyname; /* Name of key to use */
950 void *fit; /* Pointer to FIT blob */
951 int node_offset; /* Offset of signature node */
952 struct image_sig_algo *algo; /* Algorithm information */
953 const void *fdt_blob; /* FDT containing public keys */
954 int required_keynode; /* Node offset of key to use: -1=any */
955 const char *require_keys; /* Value for 'required' property */
958 /* A part of an image, used for hashing */
959 struct image_region {
964 #if IMAGE_ENABLE_VERIFY
965 # include <u-boot/rsa-checksum.h>
967 struct checksum_algo {
969 const int checksum_len;
971 #if IMAGE_ENABLE_SIGN
972 const EVP_MD *(*calculate_sign)(void);
974 int (*calculate)(const char *name,
975 const struct image_region region[],
976 int region_count, uint8_t *checksum);
977 const uint8_t *rsa_padding;
980 struct image_sig_algo {
981 const char *name; /* Name of algorithm */
984 * sign() - calculate and return signature for given input data
986 * @info: Specifies key and FIT information
987 * @data: Pointer to the input data
988 * @data_len: Data length
989 * @sigp: Set to an allocated buffer holding the signature
990 * @sig_len: Set to length of the calculated hash
992 * This computes input data signature according to selected algorithm.
993 * Resulting signature value is placed in an allocated buffer, the
994 * pointer is returned as *sigp. The length of the calculated
995 * signature is returned via the sig_len pointer argument. The caller
998 * @return: 0, on success, -ve on error
1000 int (*sign)(struct image_sign_info *info,
1001 const struct image_region region[],
1002 int region_count, uint8_t **sigp, uint *sig_len);
1005 * add_verify_data() - Add verification information to FDT
1007 * Add public key information to the FDT node, suitable for
1008 * verification at run-time. The information added depends on the
1009 * algorithm being used.
1011 * @info: Specifies key and FIT information
1012 * @keydest: Destination FDT blob for public key data
1013 * @return: 0, on success, -ve on error
1015 int (*add_verify_data)(struct image_sign_info *info, void *keydest);
1018 * verify() - Verify a signature against some data
1020 * @info: Specifies key and FIT information
1021 * @data: Pointer to the input data
1022 * @data_len: Data length
1024 * @sig_len: Number of bytes in signature
1025 * @return 0 if verified, -ve on error
1027 int (*verify)(struct image_sign_info *info,
1028 const struct image_region region[], int region_count,
1029 uint8_t *sig, uint sig_len);
1031 /* pointer to checksum algorithm */
1032 struct checksum_algo *checksum;
1036 * image_get_sig_algo() - Look up a signature algortihm
1038 * @param name Name of algorithm
1039 * @return pointer to algorithm information, or NULL if not found
1041 struct image_sig_algo *image_get_sig_algo(const char *name);
1044 * fit_image_verify_required_sigs() - Verify signatures marked as 'required'
1046 * @fit: FIT to check
1047 * @image_noffset: Offset of image node to check
1048 * @data: Image data to check
1049 * @size: Size of image data
1050 * @sig_blob: FDT containing public keys
1051 * @no_sigsp: Returns 1 if no signatures were required, and
1052 * therefore nothing was checked. The caller may wish
1053 * to fall back to other mechanisms, or refuse to
1055 * @return 0 if all verified ok, <0 on error
1057 int fit_image_verify_required_sigs(const void *fit, int image_noffset,
1058 const char *data, size_t size, const void *sig_blob,
1062 * fit_image_check_sig() - Check a single image signature node
1064 * @fit: FIT to check
1065 * @noffset: Offset of signature node to check
1066 * @data: Image data to check
1067 * @size: Size of image data
1068 * @required_keynode: Offset in the control FDT of the required key node,
1069 * if any. If this is given, then the image wil not
1070 * pass verification unless that key is used. If this is
1071 * -1 then any signature will do.
1072 * @err_msgp: In the event of an error, this will be pointed to a
1073 * help error string to display to the user.
1074 * @return 0 if all verified ok, <0 on error
1076 int fit_image_check_sig(const void *fit, int noffset, const void *data,
1077 size_t size, int required_keynode, char **err_msgp);
1080 * fit_region_make_list() - Make a list of regions to hash
1082 * Given a list of FIT regions (offset, size) provided by libfdt, create
1083 * a list of regions (void *, size) for use by the signature creationg
1084 * and verification code.
1086 * @fit: FIT image to process
1087 * @fdt_regions: Regions as returned by libfdt
1088 * @count: Number of regions returned by libfdt
1089 * @region: Place to put list of regions (NULL to allocate it)
1090 * @return pointer to list of regions, or NULL if out of memory
1092 struct image_region *fit_region_make_list(const void *fit,
1093 struct fdt_region *fdt_regions, int count,
1094 struct image_region *region);
1096 static inline int fit_image_check_target_arch(const void *fdt, int node)
1099 return fit_image_check_arch(fdt, node, IH_ARCH_DEFAULT);
1105 #ifdef CONFIG_FIT_VERBOSE
1106 #define fit_unsupported(msg) printf("! %s:%d " \
1107 "FIT images not supported for '%s'\n", \
1108 __FILE__, __LINE__, (msg))
1110 #define fit_unsupported_reset(msg) printf("! %s:%d " \
1111 "FIT images not supported for '%s' " \
1112 "- must reset board to recover!\n", \
1113 __FILE__, __LINE__, (msg))
1115 #define fit_unsupported(msg)
1116 #define fit_unsupported_reset(msg)
1117 #endif /* CONFIG_FIT_VERBOSE */
1118 #endif /* CONFIG_FIT */
1120 #if defined(CONFIG_ANDROID_BOOT_IMAGE)
1121 struct andr_img_hdr;
1122 int android_image_check_header(const struct andr_img_hdr *hdr);
1123 int android_image_get_kernel(const struct andr_img_hdr *hdr, int verify,
1124 ulong *os_data, ulong *os_len);
1125 int android_image_get_ramdisk(const struct andr_img_hdr *hdr,
1126 ulong *rd_data, ulong *rd_len);
1127 ulong android_image_get_end(const struct andr_img_hdr *hdr);
1128 ulong android_image_get_kload(const struct andr_img_hdr *hdr);
1130 #endif /* CONFIG_ANDROID_BOOT_IMAGE */
1132 #endif /* __IMAGE_H__ */