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
127 * Operating System Codes
129 #define IH_OS_INVALID 0 /* Invalid OS */
130 #define IH_OS_OPENBSD 1 /* OpenBSD */
131 #define IH_OS_NETBSD 2 /* NetBSD */
132 #define IH_OS_FREEBSD 3 /* FreeBSD */
133 #define IH_OS_4_4BSD 4 /* 4.4BSD */
134 #define IH_OS_LINUX 5 /* Linux */
135 #define IH_OS_SVR4 6 /* SVR4 */
136 #define IH_OS_ESIX 7 /* Esix */
137 #define IH_OS_SOLARIS 8 /* Solaris */
138 #define IH_OS_IRIX 9 /* Irix */
139 #define IH_OS_SCO 10 /* SCO */
140 #define IH_OS_DELL 11 /* Dell */
141 #define IH_OS_NCR 12 /* NCR */
142 #define IH_OS_LYNXOS 13 /* LynxOS */
143 #define IH_OS_VXWORKS 14 /* VxWorks */
144 #define IH_OS_PSOS 15 /* pSOS */
145 #define IH_OS_QNX 16 /* QNX */
146 #define IH_OS_U_BOOT 17 /* Firmware */
147 #define IH_OS_RTEMS 18 /* RTEMS */
148 #define IH_OS_ARTOS 19 /* ARTOS */
149 #define IH_OS_UNITY 20 /* Unity OS */
150 #define IH_OS_INTEGRITY 21 /* INTEGRITY */
151 #define IH_OS_OSE 22 /* OSE */
152 #define IH_OS_PLAN9 23 /* Plan 9 */
153 #define IH_OS_OPENRTOS 24 /* OpenRTOS */
156 * CPU Architecture Codes (supported by Linux)
158 #define IH_ARCH_INVALID 0 /* Invalid CPU */
159 #define IH_ARCH_ALPHA 1 /* Alpha */
160 #define IH_ARCH_ARM 2 /* ARM */
161 #define IH_ARCH_I386 3 /* Intel x86 */
162 #define IH_ARCH_IA64 4 /* IA64 */
163 #define IH_ARCH_MIPS 5 /* MIPS */
164 #define IH_ARCH_MIPS64 6 /* MIPS 64 Bit */
165 #define IH_ARCH_PPC 7 /* PowerPC */
166 #define IH_ARCH_S390 8 /* IBM S390 */
167 #define IH_ARCH_SH 9 /* SuperH */
168 #define IH_ARCH_SPARC 10 /* Sparc */
169 #define IH_ARCH_SPARC64 11 /* Sparc 64 Bit */
170 #define IH_ARCH_M68K 12 /* M68K */
171 #define IH_ARCH_MICROBLAZE 14 /* MicroBlaze */
172 #define IH_ARCH_NIOS2 15 /* Nios-II */
173 #define IH_ARCH_BLACKFIN 16 /* Blackfin */
174 #define IH_ARCH_AVR32 17 /* AVR32 */
175 #define IH_ARCH_ST200 18 /* STMicroelectronics ST200 */
176 #define IH_ARCH_SANDBOX 19 /* Sandbox architecture (test only) */
177 #define IH_ARCH_NDS32 20 /* ANDES Technology - NDS32 */
178 #define IH_ARCH_OPENRISC 21 /* OpenRISC 1000 */
179 #define IH_ARCH_ARM64 22 /* ARM64 */
180 #define IH_ARCH_ARC 23 /* Synopsys DesignWare ARC */
181 #define IH_ARCH_X86_64 24 /* AMD x86_64, Intel and Via */
186 * "Standalone Programs" are directly runnable in the environment
187 * provided by U-Boot; it is expected that (if they behave
188 * well) you can continue to work in U-Boot after return from
189 * the Standalone Program.
190 * "OS Kernel Images" are usually images of some Embedded OS which
191 * will take over control completely. Usually these programs
192 * will install their own set of exception handlers, device
193 * drivers, set up the MMU, etc. - this means, that you cannot
194 * expect to re-enter U-Boot except by resetting the CPU.
195 * "RAMDisk Images" are more or less just data blocks, and their
196 * parameters (address, size) are passed to an OS kernel that is
198 * "Multi-File Images" contain several images, typically an OS
199 * (Linux) kernel image and one or more data images like
200 * RAMDisks. This construct is useful for instance when you want
201 * to boot over the network using BOOTP etc., where the boot
202 * server provides just a single image file, but you want to get
203 * for instance an OS kernel and a RAMDisk image.
205 * "Multi-File Images" start with a list of image sizes, each
206 * image size (in bytes) specified by an "uint32_t" in network
207 * byte order. This list is terminated by an "(uint32_t)0".
208 * Immediately after the terminating 0 follow the images, one by
209 * one, all aligned on "uint32_t" boundaries (size rounded up to
210 * a multiple of 4 bytes - except for the last file).
212 * "Firmware Images" are binary images containing firmware (like
213 * U-Boot or FPGA images) which usually will be programmed to
216 * "Script files" are command sequences that will be executed by
217 * U-Boot's command interpreter; this feature is especially
218 * useful when you configure U-Boot to use a real shell (hush)
219 * as command interpreter (=> Shell Scripts).
222 #define IH_TYPE_INVALID 0 /* Invalid Image */
223 #define IH_TYPE_STANDALONE 1 /* Standalone Program */
224 #define IH_TYPE_KERNEL 2 /* OS Kernel Image */
225 #define IH_TYPE_RAMDISK 3 /* RAMDisk Image */
226 #define IH_TYPE_MULTI 4 /* Multi-File Image */
227 #define IH_TYPE_FIRMWARE 5 /* Firmware Image */
228 #define IH_TYPE_SCRIPT 6 /* Script file */
229 #define IH_TYPE_FILESYSTEM 7 /* Filesystem Image (any type) */
230 #define IH_TYPE_FLATDT 8 /* Binary Flat Device Tree Blob */
231 #define IH_TYPE_KWBIMAGE 9 /* Kirkwood Boot Image */
232 #define IH_TYPE_IMXIMAGE 10 /* Freescale IMXBoot Image */
233 #define IH_TYPE_UBLIMAGE 11 /* Davinci UBL Image */
234 #define IH_TYPE_OMAPIMAGE 12 /* TI OMAP Config Header Image */
235 #define IH_TYPE_AISIMAGE 13 /* TI Davinci AIS Image */
236 #define IH_TYPE_KERNEL_NOLOAD 14 /* OS Kernel Image, can run from any load address */
237 #define IH_TYPE_PBLIMAGE 15 /* Freescale PBL Boot Image */
238 #define IH_TYPE_MXSIMAGE 16 /* Freescale MXSBoot Image */
239 #define IH_TYPE_GPIMAGE 17 /* TI Keystone GPHeader Image */
240 #define IH_TYPE_ATMELIMAGE 18 /* ATMEL ROM bootable Image */
241 #define IH_TYPE_SOCFPGAIMAGE 19 /* Altera SOCFPGA Preloader */
242 #define IH_TYPE_X86_SETUP 20 /* x86 setup.bin Image */
243 #define IH_TYPE_LPC32XXIMAGE 21 /* x86 setup.bin Image */
244 #define IH_TYPE_LOADABLE 22 /* A list of typeless images */
245 #define IH_TYPE_RKIMAGE 23 /* Rockchip Boot Image */
246 #define IH_TYPE_RKSD 24 /* Rockchip SD card */
247 #define IH_TYPE_RKSPI 25 /* Rockchip SPI image */
248 #define IH_TYPE_ZYNQIMAGE 26 /* Xilinx Zynq Boot Image */
250 #define IH_TYPE_COUNT 27 /* Number of image types */
255 #define IH_COMP_NONE 0 /* No Compression Used */
256 #define IH_COMP_GZIP 1 /* gzip Compression Used */
257 #define IH_COMP_BZIP2 2 /* bzip2 Compression Used */
258 #define IH_COMP_LZMA 3 /* lzma Compression Used */
259 #define IH_COMP_LZO 4 /* lzo Compression Used */
260 #define IH_COMP_LZ4 5 /* lz4 Compression Used */
262 #define IH_MAGIC 0x27051956 /* Image Magic Number */
263 #define IH_NMLEN 32 /* Image Name Length */
265 /* Reused from common.h */
266 #define ROUND(a, b) (((a) + (b) - 1) & ~((b) - 1))
269 * Legacy format image header,
270 * all data in network byte order (aka natural aka bigendian).
272 typedef struct image_header
{
273 __be32 ih_magic
; /* Image Header Magic Number */
274 __be32 ih_hcrc
; /* Image Header CRC Checksum */
275 __be32 ih_time
; /* Image Creation Timestamp */
276 __be32 ih_size
; /* Image Data Size */
277 __be32 ih_load
; /* Data Load Address */
278 __be32 ih_ep
; /* Entry Point Address */
279 __be32 ih_dcrc
; /* Image Data CRC Checksum */
280 uint8_t ih_os
; /* Operating System */
281 uint8_t ih_arch
; /* CPU architecture */
282 uint8_t ih_type
; /* Image Type */
283 uint8_t ih_comp
; /* Compression Type */
284 uint8_t ih_name
[IH_NMLEN
]; /* Image Name */
287 typedef struct image_info
{
288 ulong start
, end
; /* start/end of blob */
289 ulong image_start
, image_len
; /* start of image within blob, len of image */
290 ulong load
; /* load addr for the image */
291 uint8_t comp
, type
, os
; /* compression, type of image, os type */
292 uint8_t arch
; /* CPU architecture */
296 * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
299 typedef struct bootm_headers
{
301 * Legacy os image header, if it is a multi component image
302 * then boot_get_ramdisk() and get_fdt() will attempt to get
303 * data from second and third component accordingly.
305 image_header_t
*legacy_hdr_os
; /* image header pointer */
306 image_header_t legacy_hdr_os_copy
; /* header copy */
307 ulong legacy_hdr_valid
;
310 const char *fit_uname_cfg
; /* configuration node unit name */
312 void *fit_hdr_os
; /* os FIT image header */
313 const char *fit_uname_os
; /* os subimage node unit name */
314 int fit_noffset_os
; /* os subimage node offset */
316 void *fit_hdr_rd
; /* init ramdisk FIT image header */
317 const char *fit_uname_rd
; /* init ramdisk subimage node unit name */
318 int fit_noffset_rd
; /* init ramdisk subimage node offset */
320 void *fit_hdr_fdt
; /* FDT blob FIT image header */
321 const char *fit_uname_fdt
; /* FDT blob subimage node unit name */
322 int fit_noffset_fdt
;/* FDT blob subimage node offset */
324 void *fit_hdr_setup
; /* x86 setup FIT image header */
325 const char *fit_uname_setup
; /* x86 setup subimage node name */
326 int fit_noffset_setup
;/* x86 setup subimage node offset */
330 image_info_t os
; /* os image info */
331 ulong ep
; /* entry point of OS */
333 ulong rd_start
, rd_end
;/* ramdisk start/end */
335 char *ft_addr
; /* flat dev tree address */
336 ulong ft_len
; /* length of flat device tree */
345 int verify
; /* getenv("verify")[0] != 'n' */
347 #define BOOTM_STATE_START (0x00000001)
348 #define BOOTM_STATE_FINDOS (0x00000002)
349 #define BOOTM_STATE_FINDOTHER (0x00000004)
350 #define BOOTM_STATE_LOADOS (0x00000008)
351 #define BOOTM_STATE_RAMDISK (0x00000010)
352 #define BOOTM_STATE_FDT (0x00000020)
353 #define BOOTM_STATE_OS_CMDLINE (0x00000040)
354 #define BOOTM_STATE_OS_BD_T (0x00000080)
355 #define BOOTM_STATE_OS_PREP (0x00000100)
356 #define BOOTM_STATE_OS_FAKE_GO (0x00000200) /* 'Almost' run the OS */
357 #define BOOTM_STATE_OS_GO (0x00000400)
361 struct lmb lmb
; /* for memory mgmt */
365 extern bootm_headers_t images
;
368 * Some systems (for example LWMON) have very short watchdog periods;
369 * we must make sure to split long operations like memmove() or
370 * checksum calculations into reasonable chunks.
373 #define CHUNKSZ (64 * 1024)
376 #ifndef CHUNKSZ_CRC32
377 #define CHUNKSZ_CRC32 (64 * 1024)
381 #define CHUNKSZ_MD5 (64 * 1024)
385 #define CHUNKSZ_SHA1 (64 * 1024)
388 #define uimage_to_cpu(x) be32_to_cpu(x)
389 #define cpu_to_uimage(x) cpu_to_be32(x)
392 * Translation table for entries of a specific type; used by
393 * get_table_entry_id() and get_table_entry_name().
395 typedef struct table_entry
{
397 char *sname
; /* short (input) name to find table entry */
398 char *lname
; /* long (output) name to print for messages */
402 * get_table_entry_id() scans the translation table trying to find an
403 * entry that matches the given short name. If a matching entry is
404 * found, it's id is returned to the caller.
406 int get_table_entry_id(const table_entry_t
*table
,
407 const char *table_name
, const char *name
);
409 * get_table_entry_name() scans the translation table trying to find
410 * an entry that matches the given id. If a matching entry is found,
411 * its long name is returned to the caller.
413 char *get_table_entry_name(const table_entry_t
*table
, char *msg
, int id
);
415 const char *genimg_get_os_name(uint8_t os
);
416 const char *genimg_get_arch_name(uint8_t arch
);
417 const char *genimg_get_type_name(uint8_t type
);
420 * genimg_get_type_short_name() - get the short name for an image type
422 * @param type Image type (IH_TYPE_...)
423 * @return image short name, or "unknown" if unknown
425 const char *genimg_get_type_short_name(uint8_t type
);
427 const char *genimg_get_comp_name(uint8_t comp
);
428 int genimg_get_os_id(const char *name
);
429 int genimg_get_arch_id(const char *name
);
430 int genimg_get_type_id(const char *name
);
431 int genimg_get_comp_id(const char *name
);
432 void genimg_print_size(uint32_t size
);
434 #if defined(CONFIG_TIMESTAMP) || defined(CONFIG_CMD_DATE) || \
436 #define IMAGE_ENABLE_TIMESTAMP 1
438 #define IMAGE_ENABLE_TIMESTAMP 0
440 void genimg_print_time(time_t timestamp
);
442 /* What to do with a image load address ('load = <> 'in the FIT) */
444 FIT_LOAD_IGNORED
, /* Ignore load address */
445 FIT_LOAD_OPTIONAL
, /* Can be provided, but optional */
446 FIT_LOAD_OPTIONAL_NON_ZERO
, /* Optional, a value of 0 is ignored */
447 FIT_LOAD_REQUIRED
, /* Must be provided */
450 int boot_get_setup(bootm_headers_t
*images
, uint8_t arch
, ulong
*setup_start
,
454 /* Image format types, returned by _get_format() routine */
455 #define IMAGE_FORMAT_INVALID 0x00
456 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
457 #define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */
459 #define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */
460 #define IMAGE_FORMAT_ANDROID 0x03 /* Android boot image */
462 ulong
genimg_get_kernel_addr_fit(char * const img_addr
,
463 const char **fit_uname_config
,
464 const char **fit_uname_kernel
);
465 ulong
genimg_get_kernel_addr(char * const img_addr
);
466 int genimg_get_format(const void *img_addr
);
467 int genimg_has_config(bootm_headers_t
*images
);
468 ulong
genimg_get_image(ulong img_addr
);
470 int boot_get_ramdisk(int argc
, char * const argv
[], bootm_headers_t
*images
,
471 uint8_t arch
, ulong
*rd_start
, ulong
*rd_end
);
474 * boot_get_loadable - routine to load a list of binaries to memory
475 * @argc: Ignored Argument
476 * @argv: Ignored Argument
477 * @images: pointer to the bootm images structure
478 * @arch: expected architecture for the image
479 * @ld_start: Ignored Argument
480 * @ld_len: Ignored Argument
482 * boot_get_loadable() will take the given FIT configuration, and look
483 * for a field named "loadables". Loadables, is a list of elements in
484 * the FIT given as strings. exe:
485 * loadables = "linux_kernel@1", "fdt@2";
486 * this function will attempt to parse each string, and load the
487 * corresponding element from the FIT into memory. Once placed,
488 * no aditional actions are taken.
491 * 0, if only valid images or no images are found
492 * error code, if an error occurs during fit_image_load
494 int boot_get_loadable(int argc
, char * const argv
[], bootm_headers_t
*images
,
495 uint8_t arch
, const ulong
*ld_start
, ulong
* const ld_len
);
496 #endif /* !USE_HOSTCC */
498 int boot_get_setup_fit(bootm_headers_t
*images
, uint8_t arch
,
499 ulong
*setup_start
, ulong
*setup_len
);
502 * fit_image_load() - load an image from a FIT
504 * This deals with all aspects of loading an image from a FIT, including
505 * selecting the right image based on configuration, verifying it, printing
506 * out progress messages, checking the type/arch/os and optionally copying it
507 * to the right load address.
509 * The property to look up is defined by image_type.
511 * @param images Boot images structure
512 * @param addr Address of FIT in memory
513 * @param fit_unamep On entry this is the requested image name
514 * (e.g. "kernel@1") or NULL to use the default. On exit
515 * points to the selected image name
516 * @param fit_uname_configp On entry this is the requested configuration
517 * name (e.g. "conf@1") or NULL to use the default. On
518 * exit points to the selected configuration name.
519 * @param arch Expected architecture (IH_ARCH_...)
520 * @param image_type Required image type (IH_TYPE_...). If this is
521 * IH_TYPE_KERNEL then we allow IH_TYPE_KERNEL_NOLOAD
523 * @param bootstage_id ID of starting bootstage to use for progress updates.
524 * This will be added to the BOOTSTAGE_SUB values when
525 * calling bootstage_mark()
526 * @param load_op Decribes what to do with the load address
527 * @param datap Returns address of loaded image
528 * @param lenp Returns length of loaded image
529 * @return node offset of image, or -ve error code on error
531 int fit_image_load(bootm_headers_t
*images
, ulong addr
,
532 const char **fit_unamep
, const char **fit_uname_configp
,
533 int arch
, int image_type
, int bootstage_id
,
534 enum fit_load_op load_op
, ulong
*datap
, ulong
*lenp
);
538 * fit_get_node_from_config() - Look up an image a FIT by type
540 * This looks in the selected conf@ node (images->fit_uname_cfg) for a
541 * particular image type (e.g. "kernel") and then finds the image that is
544 * For example, for something like:
553 * kernel = "kernel@1";
557 * the function will return the node offset of the kernel@1 node, assuming
558 * that conf@1 is the chosen configuration.
560 * @param images Boot images structure
561 * @param prop_name Property name to look up (FIT_..._PROP)
562 * @param addr Address of FIT in memory
564 int fit_get_node_from_config(bootm_headers_t
*images
, const char *prop_name
,
567 int boot_get_fdt(int flag
, int argc
, char * const argv
[], uint8_t arch
,
568 bootm_headers_t
*images
,
569 char **of_flat_tree
, ulong
*of_size
);
570 void boot_fdt_add_mem_rsv_regions(struct lmb
*lmb
, void *fdt_blob
);
571 int boot_relocate_fdt(struct lmb
*lmb
, char **of_flat_tree
, ulong
*of_size
);
573 int boot_ramdisk_high(struct lmb
*lmb
, ulong rd_data
, ulong rd_len
,
574 ulong
*initrd_start
, ulong
*initrd_end
);
575 int boot_get_cmdline(struct lmb
*lmb
, ulong
*cmd_start
, ulong
*cmd_end
);
576 #ifdef CONFIG_SYS_BOOT_GET_KBD
577 int boot_get_kbd(struct lmb
*lmb
, bd_t
**kbd
);
578 #endif /* CONFIG_SYS_BOOT_GET_KBD */
579 #endif /* !USE_HOSTCC */
581 /*******************************************************************/
582 /* Legacy format specific code (prefixed with image_) */
583 /*******************************************************************/
584 static inline uint32_t image_get_header_size(void)
586 return (sizeof(image_header_t
));
589 #define image_get_hdr_l(f) \
590 static inline uint32_t image_get_##f(const image_header_t *hdr) \
592 return uimage_to_cpu(hdr->ih_##f); \
594 image_get_hdr_l(magic
) /* image_get_magic */
595 image_get_hdr_l(hcrc
) /* image_get_hcrc */
596 image_get_hdr_l(time
) /* image_get_time */
597 image_get_hdr_l(size
) /* image_get_size */
598 image_get_hdr_l(load
) /* image_get_load */
599 image_get_hdr_l(ep
) /* image_get_ep */
600 image_get_hdr_l(dcrc
) /* image_get_dcrc */
602 #define image_get_hdr_b(f) \
603 static inline uint8_t image_get_##f(const image_header_t *hdr) \
605 return hdr->ih_##f; \
607 image_get_hdr_b(os
) /* image_get_os */
608 image_get_hdr_b(arch
) /* image_get_arch */
609 image_get_hdr_b(type
) /* image_get_type */
610 image_get_hdr_b(comp
) /* image_get_comp */
612 static inline char *image_get_name(const image_header_t
*hdr
)
614 return (char *)hdr
->ih_name
;
617 static inline uint32_t image_get_data_size(const image_header_t
*hdr
)
619 return image_get_size(hdr
);
623 * image_get_data - get image payload start address
626 * image_get_data() returns address of the image payload. For single
627 * component images it is image data start. For multi component
628 * images it points to the null terminated table of sub-images sizes.
631 * image payload data start address
633 static inline ulong
image_get_data(const image_header_t
*hdr
)
635 return ((ulong
)hdr
+ image_get_header_size());
638 static inline uint32_t image_get_image_size(const image_header_t
*hdr
)
640 return (image_get_size(hdr
) + image_get_header_size());
642 static inline ulong
image_get_image_end(const image_header_t
*hdr
)
644 return ((ulong
)hdr
+ image_get_image_size(hdr
));
647 #define image_set_hdr_l(f) \
648 static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
650 hdr->ih_##f = cpu_to_uimage(val); \
652 image_set_hdr_l(magic
) /* image_set_magic */
653 image_set_hdr_l(hcrc
) /* image_set_hcrc */
654 image_set_hdr_l(time
) /* image_set_time */
655 image_set_hdr_l(size
) /* image_set_size */
656 image_set_hdr_l(load
) /* image_set_load */
657 image_set_hdr_l(ep
) /* image_set_ep */
658 image_set_hdr_l(dcrc
) /* image_set_dcrc */
660 #define image_set_hdr_b(f) \
661 static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
665 image_set_hdr_b(os
) /* image_set_os */
666 image_set_hdr_b(arch
) /* image_set_arch */
667 image_set_hdr_b(type
) /* image_set_type */
668 image_set_hdr_b(comp
) /* image_set_comp */
670 static inline void image_set_name(image_header_t
*hdr
, const char *name
)
672 strncpy(image_get_name(hdr
), name
, IH_NMLEN
);
675 int image_check_hcrc(const image_header_t
*hdr
);
676 int image_check_dcrc(const image_header_t
*hdr
);
678 ulong
getenv_bootm_low(void);
679 phys_size_t
getenv_bootm_size(void);
680 phys_size_t
getenv_bootm_mapsize(void);
682 void memmove_wd(void *to
, void *from
, size_t len
, ulong chunksz
);
684 static inline int image_check_magic(const image_header_t
*hdr
)
686 return (image_get_magic(hdr
) == IH_MAGIC
);
688 static inline int image_check_type(const image_header_t
*hdr
, uint8_t type
)
690 return (image_get_type(hdr
) == type
);
692 static inline int image_check_arch(const image_header_t
*hdr
, uint8_t arch
)
694 return (image_get_arch(hdr
) == arch
);
696 static inline int image_check_os(const image_header_t
*hdr
, uint8_t os
)
698 return (image_get_os(hdr
) == os
);
701 ulong
image_multi_count(const image_header_t
*hdr
);
702 void image_multi_getimg(const image_header_t
*hdr
, ulong idx
,
703 ulong
*data
, ulong
*len
);
705 void image_print_contents(const void *hdr
);
708 static inline int image_check_target_arch(const image_header_t
*hdr
)
710 #ifndef IH_ARCH_DEFAULT
711 # error "please define IH_ARCH_DEFAULT in your arch asm/u-boot.h"
713 return image_check_arch(hdr
, IH_ARCH_DEFAULT
);
715 #endif /* USE_HOSTCC */
718 * Set up properties in the FDT
720 * This sets up properties in the FDT that is to be passed to linux.
722 * @images: Images information
723 * @blob: FDT to update
724 * @of_size: Size of the FDT
725 * @lmb: Points to logical memory block structure
726 * @return 0 if ok, <0 on failure
728 int image_setup_libfdt(bootm_headers_t
*images
, void *blob
,
729 int of_size
, struct lmb
*lmb
);
732 * Set up the FDT to use for booting a kernel
734 * This performs ramdisk setup, sets up the FDT if required, and adds
735 * paramters to the FDT if libfdt is available.
737 * @param images Images information
738 * @return 0 if ok, <0 on failure
740 int image_setup_linux(bootm_headers_t
*images
);
743 * bootz_setup() - Extract stat and size of a Linux xImage
745 * @image: Address of image
746 * @start: Returns start address of image
747 * @end : Returns end address of image
748 * @return 0 if OK, 1 if the image was not recognised
750 int bootz_setup(ulong image
, ulong
*start
, ulong
*end
);
753 /*******************************************************************/
754 /* New uImage format specific code (prefixed with fit_) */
755 /*******************************************************************/
758 #define FIT_IMAGES_PATH "/images"
759 #define FIT_CONFS_PATH "/configurations"
761 /* hash/signature node */
762 #define FIT_HASH_NODENAME "hash"
763 #define FIT_ALGO_PROP "algo"
764 #define FIT_VALUE_PROP "value"
765 #define FIT_IGNORE_PROP "uboot-ignore"
766 #define FIT_SIG_NODENAME "signature"
769 #define FIT_DATA_PROP "data"
770 #define FIT_TIMESTAMP_PROP "timestamp"
771 #define FIT_DESC_PROP "description"
772 #define FIT_ARCH_PROP "arch"
773 #define FIT_TYPE_PROP "type"
774 #define FIT_OS_PROP "os"
775 #define FIT_COMP_PROP "compression"
776 #define FIT_ENTRY_PROP "entry"
777 #define FIT_LOAD_PROP "load"
779 /* configuration node */
780 #define FIT_KERNEL_PROP "kernel"
781 #define FIT_RAMDISK_PROP "ramdisk"
782 #define FIT_FDT_PROP "fdt"
783 #define FIT_LOADABLE_PROP "loadables"
784 #define FIT_DEFAULT_PROP "default"
785 #define FIT_SETUP_PROP "setup"
787 #define FIT_MAX_HASH_LEN HASH_MAX_DIGEST_SIZE
789 /* cmdline argument format parsing */
790 int fit_parse_conf(const char *spec
, ulong addr_curr
,
791 ulong
*addr
, const char **conf_name
);
792 int fit_parse_subimage(const char *spec
, ulong addr_curr
,
793 ulong
*addr
, const char **image_name
);
795 int fit_get_subimage_count(const void *fit
, int images_noffset
);
796 void fit_print_contents(const void *fit
);
797 void fit_image_print(const void *fit
, int noffset
, const char *p
);
800 * fit_get_end - get FIT image size
801 * @fit: pointer to the FIT format image header
804 * size of the FIT image (blob) in memory
806 static inline ulong
fit_get_size(const void *fit
)
808 return fdt_totalsize(fit
);
812 * fit_get_end - get FIT image end
813 * @fit: pointer to the FIT format image header
816 * end address of the FIT image (blob) in memory
818 ulong
fit_get_end(const void *fit
);
821 * fit_get_name - get FIT node name
822 * @fit: pointer to the FIT format image header
826 * pointer to node name, on success
828 static inline const char *fit_get_name(const void *fit_hdr
,
829 int noffset
, int *len
)
831 return fdt_get_name(fit_hdr
, noffset
, len
);
834 int fit_get_desc(const void *fit
, int noffset
, char **desc
);
835 int fit_get_timestamp(const void *fit
, int noffset
, time_t *timestamp
);
837 int fit_image_get_node(const void *fit
, const char *image_uname
);
838 int fit_image_get_os(const void *fit
, int noffset
, uint8_t *os
);
839 int fit_image_get_arch(const void *fit
, int noffset
, uint8_t *arch
);
840 int fit_image_get_type(const void *fit
, int noffset
, uint8_t *type
);
841 int fit_image_get_comp(const void *fit
, int noffset
, uint8_t *comp
);
842 int fit_image_get_load(const void *fit
, int noffset
, ulong
*load
);
843 int fit_image_get_entry(const void *fit
, int noffset
, ulong
*entry
);
844 int fit_image_get_data(const void *fit
, int noffset
,
845 const void **data
, size_t *size
);
847 int fit_image_hash_get_algo(const void *fit
, int noffset
, char **algo
);
848 int fit_image_hash_get_value(const void *fit
, int noffset
, uint8_t **value
,
851 int fit_set_timestamp(void *fit
, int noffset
, time_t timestamp
);
854 * fit_add_verification_data() - add verification data to FIT image nodes
856 * @keydir: Directory containing keys
857 * @kwydest: FDT blob to write public key information to
858 * @fit: Pointer to the FIT format image header
859 * @comment: Comment to add to signature nodes
860 * @require_keys: Mark all keys as 'required'
862 * Adds hash values for all component images in the FIT blob.
863 * Hashes are calculated for all component images which have hash subnodes
864 * with algorithm property set to one of the supported hash algorithms.
866 * Also add signatures if signature nodes are present.
870 * libfdt error code, on failure
872 int fit_add_verification_data(const char *keydir
, void *keydest
, void *fit
,
873 const char *comment
, int require_keys
);
875 int fit_image_verify(const void *fit
, int noffset
);
876 int fit_config_verify(const void *fit
, int conf_noffset
);
877 int fit_all_image_verify(const void *fit
);
878 int fit_image_check_os(const void *fit
, int noffset
, uint8_t os
);
879 int fit_image_check_arch(const void *fit
, int noffset
, uint8_t arch
);
880 int fit_image_check_type(const void *fit
, int noffset
, uint8_t type
);
881 int fit_image_check_comp(const void *fit
, int noffset
, uint8_t comp
);
882 int fit_check_format(const void *fit
);
884 int fit_conf_find_compat(const void *fit
, const void *fdt
);
885 int fit_conf_get_node(const void *fit
, const char *conf_uname
);
888 * fit_conf_get_prop_node() - Get node refered to by a configuration
890 * @noffset: Offset of conf@xxx node to check
891 * @prop_name: Property to read from the conf node
893 * The conf@ nodes contain references to other nodes, using properties
894 * like 'kernel = "kernel@1"'. Given such a property name (e.g. "kernel"),
895 * return the offset of the node referred to (e.g. offset of node
896 * "/images/kernel@1".
898 int fit_conf_get_prop_node(const void *fit
, int noffset
,
899 const char *prop_name
);
901 void fit_conf_print(const void *fit
, int noffset
, const char *p
);
903 int fit_check_ramdisk(const void *fit
, int os_noffset
,
904 uint8_t arch
, int verify
);
906 int calculate_hash(const void *data
, int data_len
, const char *algo
,
907 uint8_t *value
, int *value_len
);
910 * At present we only support signing on the host, and verification on the
913 #if defined(CONFIG_FIT_SIGNATURE)
915 # define IMAGE_ENABLE_SIGN 1
916 # define IMAGE_ENABLE_VERIFY 1
917 # include <openssl/evp.h>
919 # define IMAGE_ENABLE_SIGN 0
920 # define IMAGE_ENABLE_VERIFY 1
923 # define IMAGE_ENABLE_SIGN 0
924 # define IMAGE_ENABLE_VERIFY 0
928 void *image_get_host_blob(void);
929 void image_set_host_blob(void *host_blob
);
930 # define gd_fdt_blob() image_get_host_blob()
932 # define gd_fdt_blob() (gd->fdt_blob)
935 #ifdef CONFIG_FIT_BEST_MATCH
936 #define IMAGE_ENABLE_BEST_MATCH 1
938 #define IMAGE_ENABLE_BEST_MATCH 0
941 /* Information passed to the signing routines */
942 struct image_sign_info
{
943 const char *keydir
; /* Directory conaining keys */
944 const char *keyname
; /* Name of key to use */
945 void *fit
; /* Pointer to FIT blob */
946 int node_offset
; /* Offset of signature node */
947 struct image_sig_algo
*algo
; /* Algorithm information */
948 const void *fdt_blob
; /* FDT containing public keys */
949 int required_keynode
; /* Node offset of key to use: -1=any */
950 const char *require_keys
; /* Value for 'required' property */
952 #endif /* Allow struct image_region to always be defined for rsa.h */
954 /* A part of an image, used for hashing */
955 struct image_region
{
962 #if IMAGE_ENABLE_VERIFY
963 # include <u-boot/rsa-checksum.h>
965 struct checksum_algo
{
967 const int checksum_len
;
969 #if IMAGE_ENABLE_SIGN
970 const EVP_MD
*(*calculate_sign
)(void);
972 int (*calculate
)(const char *name
,
973 const struct image_region region
[],
974 int region_count
, uint8_t *checksum
);
975 const uint8_t *rsa_padding
;
978 struct image_sig_algo
{
979 const char *name
; /* Name of algorithm */
982 * sign() - calculate and return signature for given input data
984 * @info: Specifies key and FIT information
985 * @data: Pointer to the input data
986 * @data_len: Data length
987 * @sigp: Set to an allocated buffer holding the signature
988 * @sig_len: Set to length of the calculated hash
990 * This computes input data signature according to selected algorithm.
991 * Resulting signature value is placed in an allocated buffer, the
992 * pointer is returned as *sigp. The length of the calculated
993 * signature is returned via the sig_len pointer argument. The caller
996 * @return: 0, on success, -ve on error
998 int (*sign
)(struct image_sign_info
*info
,
999 const struct image_region region
[],
1000 int region_count
, uint8_t **sigp
, uint
*sig_len
);
1003 * add_verify_data() - Add verification information to FDT
1005 * Add public key information to the FDT node, suitable for
1006 * verification at run-time. The information added depends on the
1007 * algorithm being used.
1009 * @info: Specifies key and FIT information
1010 * @keydest: Destination FDT blob for public key data
1011 * @return: 0, on success, -ve on error
1013 int (*add_verify_data
)(struct image_sign_info
*info
, void *keydest
);
1016 * verify() - Verify a signature against some data
1018 * @info: Specifies key and FIT information
1019 * @data: Pointer to the input data
1020 * @data_len: Data length
1022 * @sig_len: Number of bytes in signature
1023 * @return 0 if verified, -ve on error
1025 int (*verify
)(struct image_sign_info
*info
,
1026 const struct image_region region
[], int region_count
,
1027 uint8_t *sig
, uint sig_len
);
1029 /* pointer to checksum algorithm */
1030 struct checksum_algo
*checksum
;
1034 * image_get_sig_algo() - Look up a signature algortihm
1036 * @param name Name of algorithm
1037 * @return pointer to algorithm information, or NULL if not found
1039 struct image_sig_algo
*image_get_sig_algo(const char *name
);
1042 * fit_image_verify_required_sigs() - Verify signatures marked as 'required'
1044 * @fit: FIT to check
1045 * @image_noffset: Offset of image node to check
1046 * @data: Image data to check
1047 * @size: Size of image data
1048 * @sig_blob: FDT containing public keys
1049 * @no_sigsp: Returns 1 if no signatures were required, and
1050 * therefore nothing was checked. The caller may wish
1051 * to fall back to other mechanisms, or refuse to
1053 * @return 0 if all verified ok, <0 on error
1055 int fit_image_verify_required_sigs(const void *fit
, int image_noffset
,
1056 const char *data
, size_t size
, const void *sig_blob
,
1060 * fit_image_check_sig() - Check a single image signature node
1062 * @fit: FIT to check
1063 * @noffset: Offset of signature node to check
1064 * @data: Image data to check
1065 * @size: Size of image data
1066 * @required_keynode: Offset in the control FDT of the required key node,
1067 * if any. If this is given, then the image wil not
1068 * pass verification unless that key is used. If this is
1069 * -1 then any signature will do.
1070 * @err_msgp: In the event of an error, this will be pointed to a
1071 * help error string to display to the user.
1072 * @return 0 if all verified ok, <0 on error
1074 int fit_image_check_sig(const void *fit
, int noffset
, const void *data
,
1075 size_t size
, int required_keynode
, char **err_msgp
);
1078 * fit_region_make_list() - Make a list of regions to hash
1080 * Given a list of FIT regions (offset, size) provided by libfdt, create
1081 * a list of regions (void *, size) for use by the signature creationg
1082 * and verification code.
1084 * @fit: FIT image to process
1085 * @fdt_regions: Regions as returned by libfdt
1086 * @count: Number of regions returned by libfdt
1087 * @region: Place to put list of regions (NULL to allocate it)
1088 * @return pointer to list of regions, or NULL if out of memory
1090 struct image_region
*fit_region_make_list(const void *fit
,
1091 struct fdt_region
*fdt_regions
, int count
,
1092 struct image_region
*region
);
1094 static inline int fit_image_check_target_arch(const void *fdt
, int node
)
1097 return fit_image_check_arch(fdt
, node
, IH_ARCH_DEFAULT
);
1103 #ifdef CONFIG_FIT_VERBOSE
1104 #define fit_unsupported(msg) printf("! %s:%d " \
1105 "FIT images not supported for '%s'\n", \
1106 __FILE__, __LINE__, (msg))
1108 #define fit_unsupported_reset(msg) printf("! %s:%d " \
1109 "FIT images not supported for '%s' " \
1110 "- must reset board to recover!\n", \
1111 __FILE__, __LINE__, (msg))
1113 #define fit_unsupported(msg)
1114 #define fit_unsupported_reset(msg)
1115 #endif /* CONFIG_FIT_VERBOSE */
1116 #endif /* CONFIG_FIT */
1118 #if defined(CONFIG_ANDROID_BOOT_IMAGE)
1119 struct andr_img_hdr
;
1120 int android_image_check_header(const struct andr_img_hdr
*hdr
);
1121 int android_image_get_kernel(const struct andr_img_hdr
*hdr
, int verify
,
1122 ulong
*os_data
, ulong
*os_len
);
1123 int android_image_get_ramdisk(const struct andr_img_hdr
*hdr
,
1124 ulong
*rd_data
, ulong
*rd_len
);
1125 ulong
android_image_get_end(const struct andr_img_hdr
*hdr
);
1126 ulong
android_image_get_kload(const struct andr_img_hdr
*hdr
);
1128 #endif /* CONFIG_ANDROID_BOOT_IMAGE */
1130 #endif /* __IMAGE_H__ */