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 */
27 /* new uImage format support enabled on host */
29 #define CONFIG_OF_LIBFDT 1
30 #define CONFIG_FIT_VERBOSE 1 /* enable fit_format_{error,warning}() */
32 #define IMAGE_ENABLE_IGNORE 0
33 #define IMAGE_INDENT_STRING ""
38 #include <asm/u-boot.h>
41 /* Take notice of the 'ignore' property for hashes */
42 #define IMAGE_ENABLE_IGNORE 1
43 #define IMAGE_INDENT_STRING " "
45 #endif /* USE_HOSTCC */
47 #if defined(CONFIG_FIT)
50 #include <fdt_support.h>
51 # ifdef CONFIG_SPL_BUILD
52 # ifdef CONFIG_SPL_CRC32_SUPPORT
53 # define IMAGE_ENABLE_CRC32 1
55 # ifdef CONFIG_SPL_MD5_SUPPORT
56 # define IMAGE_ENABLE_MD5 1
58 # ifdef CONFIG_SPL_SHA1_SUPPORT
59 # define IMAGE_ENABLE_SHA1 1
61 # ifdef CONFIG_SPL_SHA256_SUPPORT
62 # define IMAGE_ENABLE_SHA256 1
65 # define CONFIG_CRC32 /* FIT images need CRC32 support */
66 # define CONFIG_MD5 /* and MD5 */
67 # define CONFIG_SHA1 /* and SHA1 */
68 # define CONFIG_SHA256 /* and SHA256 */
69 # define IMAGE_ENABLE_CRC32 1
70 # define IMAGE_ENABLE_MD5 1
71 # define IMAGE_ENABLE_SHA1 1
72 # define IMAGE_ENABLE_SHA256 1
75 #ifdef CONFIG_FIT_DISABLE_SHA256
77 #undef IMAGE_ENABLE_SHA256
80 #ifndef IMAGE_ENABLE_CRC32
81 #define IMAGE_ENABLE_CRC32 0
84 #ifndef IMAGE_ENABLE_MD5
85 #define IMAGE_ENABLE_MD5 0
88 #ifndef IMAGE_ENABLE_SHA1
89 #define IMAGE_ENABLE_SHA1 0
92 #ifndef IMAGE_ENABLE_SHA256
93 #define IMAGE_ENABLE_SHA256 0
96 #endif /* CONFIG_FIT */
98 #ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH
99 # define IMAGE_ENABLE_RAMDISK_HIGH 1
101 # define IMAGE_ENABLE_RAMDISK_HIGH 0
104 #ifdef CONFIG_OF_LIBFDT
105 # define IMAGE_ENABLE_OF_LIBFDT 1
107 # define IMAGE_ENABLE_OF_LIBFDT 0
110 #ifdef CONFIG_SYS_BOOT_GET_CMDLINE
111 # define IMAGE_BOOT_GET_CMDLINE 1
113 # define IMAGE_BOOT_GET_CMDLINE 0
116 #ifdef CONFIG_OF_BOARD_SETUP
117 # define IMAGE_OF_BOARD_SETUP 1
119 # define IMAGE_OF_BOARD_SETUP 0
123 * Operating System Codes
125 #define IH_OS_INVALID 0 /* Invalid OS */
126 #define IH_OS_OPENBSD 1 /* OpenBSD */
127 #define IH_OS_NETBSD 2 /* NetBSD */
128 #define IH_OS_FREEBSD 3 /* FreeBSD */
129 #define IH_OS_4_4BSD 4 /* 4.4BSD */
130 #define IH_OS_LINUX 5 /* Linux */
131 #define IH_OS_SVR4 6 /* SVR4 */
132 #define IH_OS_ESIX 7 /* Esix */
133 #define IH_OS_SOLARIS 8 /* Solaris */
134 #define IH_OS_IRIX 9 /* Irix */
135 #define IH_OS_SCO 10 /* SCO */
136 #define IH_OS_DELL 11 /* Dell */
137 #define IH_OS_NCR 12 /* NCR */
138 #define IH_OS_LYNXOS 13 /* LynxOS */
139 #define IH_OS_VXWORKS 14 /* VxWorks */
140 #define IH_OS_PSOS 15 /* pSOS */
141 #define IH_OS_QNX 16 /* QNX */
142 #define IH_OS_U_BOOT 17 /* Firmware */
143 #define IH_OS_RTEMS 18 /* RTEMS */
144 #define IH_OS_ARTOS 19 /* ARTOS */
145 #define IH_OS_UNITY 20 /* Unity OS */
146 #define IH_OS_INTEGRITY 21 /* INTEGRITY */
147 #define IH_OS_OSE 22 /* OSE */
148 #define IH_OS_PLAN9 23 /* Plan 9 */
151 * CPU Architecture Codes (supported by Linux)
153 #define IH_ARCH_INVALID 0 /* Invalid CPU */
154 #define IH_ARCH_ALPHA 1 /* Alpha */
155 #define IH_ARCH_ARM 2 /* ARM */
156 #define IH_ARCH_I386 3 /* Intel x86 */
157 #define IH_ARCH_IA64 4 /* IA64 */
158 #define IH_ARCH_MIPS 5 /* MIPS */
159 #define IH_ARCH_MIPS64 6 /* MIPS 64 Bit */
160 #define IH_ARCH_PPC 7 /* PowerPC */
161 #define IH_ARCH_S390 8 /* IBM S390 */
162 #define IH_ARCH_SH 9 /* SuperH */
163 #define IH_ARCH_SPARC 10 /* Sparc */
164 #define IH_ARCH_SPARC64 11 /* Sparc 64 Bit */
165 #define IH_ARCH_M68K 12 /* M68K */
166 #define IH_ARCH_MICROBLAZE 14 /* MicroBlaze */
167 #define IH_ARCH_NIOS2 15 /* Nios-II */
168 #define IH_ARCH_BLACKFIN 16 /* Blackfin */
169 #define IH_ARCH_AVR32 17 /* AVR32 */
170 #define IH_ARCH_ST200 18 /* STMicroelectronics ST200 */
171 #define IH_ARCH_SANDBOX 19 /* Sandbox architecture (test only) */
172 #define IH_ARCH_NDS32 20 /* ANDES Technology - NDS32 */
173 #define IH_ARCH_OPENRISC 21 /* OpenRISC 1000 */
174 #define IH_ARCH_ARM64 22 /* ARM64 */
175 #define IH_ARCH_ARC 23 /* Synopsys DesignWare ARC */
180 * "Standalone Programs" are directly runnable in the environment
181 * provided by U-Boot; it is expected that (if they behave
182 * well) you can continue to work in U-Boot after return from
183 * the Standalone Program.
184 * "OS Kernel Images" are usually images of some Embedded OS which
185 * will take over control completely. Usually these programs
186 * will install their own set of exception handlers, device
187 * drivers, set up the MMU, etc. - this means, that you cannot
188 * expect to re-enter U-Boot except by resetting the CPU.
189 * "RAMDisk Images" are more or less just data blocks, and their
190 * parameters (address, size) are passed to an OS kernel that is
192 * "Multi-File Images" contain several images, typically an OS
193 * (Linux) kernel image and one or more data images like
194 * RAMDisks. This construct is useful for instance when you want
195 * to boot over the network using BOOTP etc., where the boot
196 * server provides just a single image file, but you want to get
197 * for instance an OS kernel and a RAMDisk image.
199 * "Multi-File Images" start with a list of image sizes, each
200 * image size (in bytes) specified by an "uint32_t" in network
201 * byte order. This list is terminated by an "(uint32_t)0".
202 * Immediately after the terminating 0 follow the images, one by
203 * one, all aligned on "uint32_t" boundaries (size rounded up to
204 * a multiple of 4 bytes - except for the last file).
206 * "Firmware Images" are binary images containing firmware (like
207 * U-Boot or FPGA images) which usually will be programmed to
210 * "Script files" are command sequences that will be executed by
211 * U-Boot's command interpreter; this feature is especially
212 * useful when you configure U-Boot to use a real shell (hush)
213 * as command interpreter (=> Shell Scripts).
216 #define IH_TYPE_INVALID 0 /* Invalid Image */
217 #define IH_TYPE_STANDALONE 1 /* Standalone Program */
218 #define IH_TYPE_KERNEL 2 /* OS Kernel Image */
219 #define IH_TYPE_RAMDISK 3 /* RAMDisk Image */
220 #define IH_TYPE_MULTI 4 /* Multi-File Image */
221 #define IH_TYPE_FIRMWARE 5 /* Firmware Image */
222 #define IH_TYPE_SCRIPT 6 /* Script file */
223 #define IH_TYPE_FILESYSTEM 7 /* Filesystem Image (any type) */
224 #define IH_TYPE_FLATDT 8 /* Binary Flat Device Tree Blob */
225 #define IH_TYPE_KWBIMAGE 9 /* Kirkwood Boot Image */
226 #define IH_TYPE_IMXIMAGE 10 /* Freescale IMXBoot Image */
227 #define IH_TYPE_UBLIMAGE 11 /* Davinci UBL Image */
228 #define IH_TYPE_OMAPIMAGE 12 /* TI OMAP Config Header Image */
229 #define IH_TYPE_AISIMAGE 13 /* TI Davinci AIS Image */
230 #define IH_TYPE_KERNEL_NOLOAD 14 /* OS Kernel Image, can run from any load address */
231 #define IH_TYPE_PBLIMAGE 15 /* Freescale PBL Boot Image */
232 #define IH_TYPE_MXSIMAGE 16 /* Freescale MXSBoot Image */
233 #define IH_TYPE_GPIMAGE 17 /* TI Keystone GPHeader Image */
234 #define IH_TYPE_ATMELIMAGE 18 /* ATMEL ROM bootable Image */
235 #define IH_TYPE_SOCFPGAIMAGE 19 /* Altera SOCFPGA Preloader */
236 #define IH_TYPE_X86_SETUP 20 /* x86 setup.bin Image */
241 #define IH_COMP_NONE 0 /* No Compression Used */
242 #define IH_COMP_GZIP 1 /* gzip Compression Used */
243 #define IH_COMP_BZIP2 2 /* bzip2 Compression Used */
244 #define IH_COMP_LZMA 3 /* lzma Compression Used */
245 #define IH_COMP_LZO 4 /* lzo Compression Used */
247 #define IH_MAGIC 0x27051956 /* Image Magic Number */
248 #define IH_NMLEN 32 /* Image Name Length */
250 /* Reused from common.h */
251 #define ROUND(a, b) (((a) + (b) - 1) & ~((b) - 1))
254 * Legacy format image header,
255 * all data in network byte order (aka natural aka bigendian).
257 typedef struct image_header
{
258 __be32 ih_magic
; /* Image Header Magic Number */
259 __be32 ih_hcrc
; /* Image Header CRC Checksum */
260 __be32 ih_time
; /* Image Creation Timestamp */
261 __be32 ih_size
; /* Image Data Size */
262 __be32 ih_load
; /* Data Load Address */
263 __be32 ih_ep
; /* Entry Point Address */
264 __be32 ih_dcrc
; /* Image Data CRC Checksum */
265 uint8_t ih_os
; /* Operating System */
266 uint8_t ih_arch
; /* CPU architecture */
267 uint8_t ih_type
; /* Image Type */
268 uint8_t ih_comp
; /* Compression Type */
269 uint8_t ih_name
[IH_NMLEN
]; /* Image Name */
272 typedef struct image_info
{
273 ulong start
, end
; /* start/end of blob */
274 ulong image_start
, image_len
; /* start of image within blob, len of image */
275 ulong load
; /* load addr for the image */
276 uint8_t comp
, type
, os
; /* compression, type of image, os type */
277 uint8_t arch
; /* CPU architecture */
281 * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
284 typedef struct bootm_headers
{
286 * Legacy os image header, if it is a multi component image
287 * then boot_get_ramdisk() and get_fdt() will attempt to get
288 * data from second and third component accordingly.
290 image_header_t
*legacy_hdr_os
; /* image header pointer */
291 image_header_t legacy_hdr_os_copy
; /* header copy */
292 ulong legacy_hdr_valid
;
294 #if defined(CONFIG_FIT)
295 const char *fit_uname_cfg
; /* configuration node unit name */
297 void *fit_hdr_os
; /* os FIT image header */
298 const char *fit_uname_os
; /* os subimage node unit name */
299 int fit_noffset_os
; /* os subimage node offset */
301 void *fit_hdr_rd
; /* init ramdisk FIT image header */
302 const char *fit_uname_rd
; /* init ramdisk subimage node unit name */
303 int fit_noffset_rd
; /* init ramdisk subimage node offset */
305 void *fit_hdr_fdt
; /* FDT blob FIT image header */
306 const char *fit_uname_fdt
; /* FDT blob subimage node unit name */
307 int fit_noffset_fdt
;/* FDT blob subimage node offset */
309 void *fit_hdr_setup
; /* x86 setup FIT image header */
310 const char *fit_uname_setup
; /* x86 setup subimage node name */
311 int fit_noffset_setup
;/* x86 setup subimage node offset */
315 image_info_t os
; /* os image info */
316 ulong ep
; /* entry point of OS */
318 ulong rd_start
, rd_end
;/* ramdisk start/end */
320 char *ft_addr
; /* flat dev tree address */
321 ulong ft_len
; /* length of flat device tree */
330 int verify
; /* getenv("verify")[0] != 'n' */
332 #define BOOTM_STATE_START (0x00000001)
333 #define BOOTM_STATE_FINDOS (0x00000002)
334 #define BOOTM_STATE_FINDOTHER (0x00000004)
335 #define BOOTM_STATE_LOADOS (0x00000008)
336 #define BOOTM_STATE_RAMDISK (0x00000010)
337 #define BOOTM_STATE_FDT (0x00000020)
338 #define BOOTM_STATE_OS_CMDLINE (0x00000040)
339 #define BOOTM_STATE_OS_BD_T (0x00000080)
340 #define BOOTM_STATE_OS_PREP (0x00000100)
341 #define BOOTM_STATE_OS_FAKE_GO (0x00000200) /* 'Almost' run the OS */
342 #define BOOTM_STATE_OS_GO (0x00000400)
346 struct lmb lmb
; /* for memory mgmt */
350 extern bootm_headers_t images
;
353 * Some systems (for example LWMON) have very short watchdog periods;
354 * we must make sure to split long operations like memmove() or
355 * checksum calculations into reasonable chunks.
358 #define CHUNKSZ (64 * 1024)
361 #ifndef CHUNKSZ_CRC32
362 #define CHUNKSZ_CRC32 (64 * 1024)
366 #define CHUNKSZ_MD5 (64 * 1024)
370 #define CHUNKSZ_SHA1 (64 * 1024)
373 #define uimage_to_cpu(x) be32_to_cpu(x)
374 #define cpu_to_uimage(x) cpu_to_be32(x)
377 * Translation table for entries of a specific type; used by
378 * get_table_entry_id() and get_table_entry_name().
380 typedef struct table_entry
{
382 char *sname
; /* short (input) name to find table entry */
383 char *lname
; /* long (output) name to print for messages */
387 * get_table_entry_id() scans the translation table trying to find an
388 * entry that matches the given short name. If a matching entry is
389 * found, it's id is returned to the caller.
391 int get_table_entry_id(const table_entry_t
*table
,
392 const char *table_name
, const char *name
);
394 * get_table_entry_name() scans the translation table trying to find
395 * an entry that matches the given id. If a matching entry is found,
396 * its long name is returned to the caller.
398 char *get_table_entry_name(const table_entry_t
*table
, char *msg
, int id
);
400 const char *genimg_get_os_name(uint8_t os
);
401 const char *genimg_get_arch_name(uint8_t arch
);
402 const char *genimg_get_type_name(uint8_t type
);
403 const char *genimg_get_comp_name(uint8_t comp
);
404 int genimg_get_os_id(const char *name
);
405 int genimg_get_arch_id(const char *name
);
406 int genimg_get_type_id(const char *name
);
407 int genimg_get_comp_id(const char *name
);
408 void genimg_print_size(uint32_t size
);
410 #if defined(CONFIG_TIMESTAMP) || defined(CONFIG_CMD_DATE) || \
412 #define IMAGE_ENABLE_TIMESTAMP 1
414 #define IMAGE_ENABLE_TIMESTAMP 0
416 void genimg_print_time(time_t timestamp
);
418 /* What to do with a image load address ('load = <> 'in the FIT) */
420 FIT_LOAD_IGNORED
, /* Ignore load address */
421 FIT_LOAD_OPTIONAL
, /* Can be provided, but optional */
422 FIT_LOAD_OPTIONAL_NON_ZERO
, /* Optional, a value of 0 is ignored */
423 FIT_LOAD_REQUIRED
, /* Must be provided */
426 int boot_get_setup(bootm_headers_t
*images
, uint8_t arch
, ulong
*setup_start
,
430 /* Image format types, returned by _get_format() routine */
431 #define IMAGE_FORMAT_INVALID 0x00
432 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
433 #define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */
435 #define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */
436 #define IMAGE_FORMAT_ANDROID 0x03 /* Android boot image */
438 ulong
genimg_get_kernel_addr_fit(char * const img_addr
,
439 const char **fit_uname_config
,
440 const char **fit_uname_kernel
);
441 ulong
genimg_get_kernel_addr(char * const img_addr
);
442 int genimg_get_format(const void *img_addr
);
443 int genimg_has_config(bootm_headers_t
*images
);
444 ulong
genimg_get_image(ulong img_addr
);
446 int boot_get_ramdisk(int argc
, char * const argv
[], bootm_headers_t
*images
,
447 uint8_t arch
, ulong
*rd_start
, ulong
*rd_end
);
450 int boot_get_setup_fit(bootm_headers_t
*images
, uint8_t arch
,
451 ulong
*setup_start
, ulong
*setup_len
);
454 * fit_image_load() - load an image from a FIT
456 * This deals with all aspects of loading an image from a FIT, including
457 * selecting the right image based on configuration, verifying it, printing
458 * out progress messages, checking the type/arch/os and optionally copying it
459 * to the right load address.
461 * The property to look up is defined by image_type.
463 * @param images Boot images structure
464 * @param addr Address of FIT in memory
465 * @param fit_unamep On entry this is the requested image name
466 * (e.g. "kernel@1") or NULL to use the default. On exit
467 * points to the selected image name
468 * @param fit_uname_configp On entry this is the requested configuration
469 * name (e.g. "conf@1") or NULL to use the default. On
470 * exit points to the selected configuration name.
471 * @param arch Expected architecture (IH_ARCH_...)
472 * @param image_type Required image type (IH_TYPE_...). If this is
473 * IH_TYPE_KERNEL then we allow IH_TYPE_KERNEL_NOLOAD
475 * @param bootstage_id ID of starting bootstage to use for progress updates.
476 * This will be added to the BOOTSTAGE_SUB values when
477 * calling bootstage_mark()
478 * @param load_op Decribes what to do with the load address
479 * @param datap Returns address of loaded image
480 * @param lenp Returns length of loaded image
481 * @return node offset of image, or -ve error code on error
483 int fit_image_load(bootm_headers_t
*images
, ulong addr
,
484 const char **fit_unamep
, const char **fit_uname_configp
,
485 int arch
, int image_type
, int bootstage_id
,
486 enum fit_load_op load_op
, ulong
*datap
, ulong
*lenp
);
490 * fit_get_node_from_config() - Look up an image a FIT by type
492 * This looks in the selected conf@ node (images->fit_uname_cfg) for a
493 * particular image type (e.g. "kernel") and then finds the image that is
496 * For example, for something like:
505 * kernel = "kernel@1";
509 * the function will return the node offset of the kernel@1 node, assuming
510 * that conf@1 is the chosen configuration.
512 * @param images Boot images structure
513 * @param prop_name Property name to look up (FIT_..._PROP)
514 * @param addr Address of FIT in memory
516 int fit_get_node_from_config(bootm_headers_t
*images
, const char *prop_name
,
519 int boot_get_fdt(int flag
, int argc
, char * const argv
[], uint8_t arch
,
520 bootm_headers_t
*images
,
521 char **of_flat_tree
, ulong
*of_size
);
522 void boot_fdt_add_mem_rsv_regions(struct lmb
*lmb
, void *fdt_blob
);
523 int boot_relocate_fdt(struct lmb
*lmb
, char **of_flat_tree
, ulong
*of_size
);
525 int boot_ramdisk_high(struct lmb
*lmb
, ulong rd_data
, ulong rd_len
,
526 ulong
*initrd_start
, ulong
*initrd_end
);
527 int boot_get_cmdline(struct lmb
*lmb
, ulong
*cmd_start
, ulong
*cmd_end
);
528 #ifdef CONFIG_SYS_BOOT_GET_KBD
529 int boot_get_kbd(struct lmb
*lmb
, bd_t
**kbd
);
530 #endif /* CONFIG_SYS_BOOT_GET_KBD */
531 #endif /* !USE_HOSTCC */
533 /*******************************************************************/
534 /* Legacy format specific code (prefixed with image_) */
535 /*******************************************************************/
536 static inline uint32_t image_get_header_size(void)
538 return (sizeof(image_header_t
));
541 #define image_get_hdr_l(f) \
542 static inline uint32_t image_get_##f(const image_header_t *hdr) \
544 return uimage_to_cpu(hdr->ih_##f); \
546 image_get_hdr_l(magic
) /* image_get_magic */
547 image_get_hdr_l(hcrc
) /* image_get_hcrc */
548 image_get_hdr_l(time
) /* image_get_time */
549 image_get_hdr_l(size
) /* image_get_size */
550 image_get_hdr_l(load
) /* image_get_load */
551 image_get_hdr_l(ep
) /* image_get_ep */
552 image_get_hdr_l(dcrc
) /* image_get_dcrc */
554 #define image_get_hdr_b(f) \
555 static inline uint8_t image_get_##f(const image_header_t *hdr) \
557 return hdr->ih_##f; \
559 image_get_hdr_b(os
) /* image_get_os */
560 image_get_hdr_b(arch
) /* image_get_arch */
561 image_get_hdr_b(type
) /* image_get_type */
562 image_get_hdr_b(comp
) /* image_get_comp */
564 static inline char *image_get_name(const image_header_t
*hdr
)
566 return (char *)hdr
->ih_name
;
569 static inline uint32_t image_get_data_size(const image_header_t
*hdr
)
571 return image_get_size(hdr
);
575 * image_get_data - get image payload start address
578 * image_get_data() returns address of the image payload. For single
579 * component images it is image data start. For multi component
580 * images it points to the null terminated table of sub-images sizes.
583 * image payload data start address
585 static inline ulong
image_get_data(const image_header_t
*hdr
)
587 return ((ulong
)hdr
+ image_get_header_size());
590 static inline uint32_t image_get_image_size(const image_header_t
*hdr
)
592 return (image_get_size(hdr
) + image_get_header_size());
594 static inline ulong
image_get_image_end(const image_header_t
*hdr
)
596 return ((ulong
)hdr
+ image_get_image_size(hdr
));
599 #define image_set_hdr_l(f) \
600 static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
602 hdr->ih_##f = cpu_to_uimage(val); \
604 image_set_hdr_l(magic
) /* image_set_magic */
605 image_set_hdr_l(hcrc
) /* image_set_hcrc */
606 image_set_hdr_l(time
) /* image_set_time */
607 image_set_hdr_l(size
) /* image_set_size */
608 image_set_hdr_l(load
) /* image_set_load */
609 image_set_hdr_l(ep
) /* image_set_ep */
610 image_set_hdr_l(dcrc
) /* image_set_dcrc */
612 #define image_set_hdr_b(f) \
613 static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
617 image_set_hdr_b(os
) /* image_set_os */
618 image_set_hdr_b(arch
) /* image_set_arch */
619 image_set_hdr_b(type
) /* image_set_type */
620 image_set_hdr_b(comp
) /* image_set_comp */
622 static inline void image_set_name(image_header_t
*hdr
, const char *name
)
624 strncpy(image_get_name(hdr
), name
, IH_NMLEN
);
627 int image_check_hcrc(const image_header_t
*hdr
);
628 int image_check_dcrc(const image_header_t
*hdr
);
630 ulong
getenv_bootm_low(void);
631 phys_size_t
getenv_bootm_size(void);
632 phys_size_t
getenv_bootm_mapsize(void);
634 void memmove_wd(void *to
, void *from
, size_t len
, ulong chunksz
);
636 static inline int image_check_magic(const image_header_t
*hdr
)
638 return (image_get_magic(hdr
) == IH_MAGIC
);
640 static inline int image_check_type(const image_header_t
*hdr
, uint8_t type
)
642 return (image_get_type(hdr
) == type
);
644 static inline int image_check_arch(const image_header_t
*hdr
, uint8_t arch
)
646 return (image_get_arch(hdr
) == arch
);
648 static inline int image_check_os(const image_header_t
*hdr
, uint8_t os
)
650 return (image_get_os(hdr
) == os
);
653 ulong
image_multi_count(const image_header_t
*hdr
);
654 void image_multi_getimg(const image_header_t
*hdr
, ulong idx
,
655 ulong
*data
, ulong
*len
);
657 void image_print_contents(const void *hdr
);
660 static inline int image_check_target_arch(const image_header_t
*hdr
)
662 #ifndef IH_ARCH_DEFAULT
663 # error "please define IH_ARCH_DEFAULT in your arch asm/u-boot.h"
665 return image_check_arch(hdr
, IH_ARCH_DEFAULT
);
667 #endif /* USE_HOSTCC */
670 * Set up properties in the FDT
672 * This sets up properties in the FDT that is to be passed to linux.
674 * @images: Images information
675 * @blob: FDT to update
676 * @of_size: Size of the FDT
677 * @lmb: Points to logical memory block structure
678 * @return 0 if ok, <0 on failure
680 int image_setup_libfdt(bootm_headers_t
*images
, void *blob
,
681 int of_size
, struct lmb
*lmb
);
684 * Set up the FDT to use for booting a kernel
686 * This performs ramdisk setup, sets up the FDT if required, and adds
687 * paramters to the FDT if libfdt is available.
689 * @param images Images information
690 * @return 0 if ok, <0 on failure
692 int image_setup_linux(bootm_headers_t
*images
);
695 * bootz_setup() - Extract stat and size of a Linux xImage
697 * @image: Address of image
698 * @start: Returns start address of image
699 * @end : Returns end address of image
700 * @return 0 if OK, 1 if the image was not recognised
702 int bootz_setup(ulong image
, ulong
*start
, ulong
*end
);
705 /*******************************************************************/
706 /* New uImage format specific code (prefixed with fit_) */
707 /*******************************************************************/
708 #if defined(CONFIG_FIT)
710 #define FIT_IMAGES_PATH "/images"
711 #define FIT_CONFS_PATH "/configurations"
713 /* hash/signature node */
714 #define FIT_HASH_NODENAME "hash"
715 #define FIT_ALGO_PROP "algo"
716 #define FIT_VALUE_PROP "value"
717 #define FIT_IGNORE_PROP "uboot-ignore"
718 #define FIT_SIG_NODENAME "signature"
721 #define FIT_DATA_PROP "data"
722 #define FIT_TIMESTAMP_PROP "timestamp"
723 #define FIT_DESC_PROP "description"
724 #define FIT_ARCH_PROP "arch"
725 #define FIT_TYPE_PROP "type"
726 #define FIT_OS_PROP "os"
727 #define FIT_COMP_PROP "compression"
728 #define FIT_ENTRY_PROP "entry"
729 #define FIT_LOAD_PROP "load"
731 /* configuration node */
732 #define FIT_KERNEL_PROP "kernel"
733 #define FIT_RAMDISK_PROP "ramdisk"
734 #define FIT_FDT_PROP "fdt"
735 #define FIT_DEFAULT_PROP "default"
736 #define FIT_SETUP_PROP "setup"
738 #define FIT_MAX_HASH_LEN HASH_MAX_DIGEST_SIZE
740 /* cmdline argument format parsing */
741 int fit_parse_conf(const char *spec
, ulong addr_curr
,
742 ulong
*addr
, const char **conf_name
);
743 int fit_parse_subimage(const char *spec
, ulong addr_curr
,
744 ulong
*addr
, const char **image_name
);
746 void fit_print_contents(const void *fit
);
747 void fit_image_print(const void *fit
, int noffset
, const char *p
);
750 * fit_get_end - get FIT image size
751 * @fit: pointer to the FIT format image header
754 * size of the FIT image (blob) in memory
756 static inline ulong
fit_get_size(const void *fit
)
758 return fdt_totalsize(fit
);
762 * fit_get_end - get FIT image end
763 * @fit: pointer to the FIT format image header
766 * end address of the FIT image (blob) in memory
768 static inline ulong
fit_get_end(const void *fit
)
770 return (ulong
)fit
+ fdt_totalsize(fit
);
774 * fit_get_name - get FIT node name
775 * @fit: pointer to the FIT format image header
779 * pointer to node name, on success
781 static inline const char *fit_get_name(const void *fit_hdr
,
782 int noffset
, int *len
)
784 return fdt_get_name(fit_hdr
, noffset
, len
);
787 int fit_get_desc(const void *fit
, int noffset
, char **desc
);
788 int fit_get_timestamp(const void *fit
, int noffset
, time_t *timestamp
);
790 int fit_image_get_node(const void *fit
, const char *image_uname
);
791 int fit_image_get_os(const void *fit
, int noffset
, uint8_t *os
);
792 int fit_image_get_arch(const void *fit
, int noffset
, uint8_t *arch
);
793 int fit_image_get_type(const void *fit
, int noffset
, uint8_t *type
);
794 int fit_image_get_comp(const void *fit
, int noffset
, uint8_t *comp
);
795 int fit_image_get_load(const void *fit
, int noffset
, ulong
*load
);
796 int fit_image_get_entry(const void *fit
, int noffset
, ulong
*entry
);
797 int fit_image_get_data(const void *fit
, int noffset
,
798 const void **data
, size_t *size
);
800 int fit_image_hash_get_algo(const void *fit
, int noffset
, char **algo
);
801 int fit_image_hash_get_value(const void *fit
, int noffset
, uint8_t **value
,
804 int fit_set_timestamp(void *fit
, int noffset
, time_t timestamp
);
807 * fit_add_verification_data() - add verification data to FIT image nodes
809 * @keydir: Directory containing keys
810 * @kwydest: FDT blob to write public key information to
811 * @fit: Pointer to the FIT format image header
812 * @comment: Comment to add to signature nodes
813 * @require_keys: Mark all keys as 'required'
815 * Adds hash values for all component images in the FIT blob.
816 * Hashes are calculated for all component images which have hash subnodes
817 * with algorithm property set to one of the supported hash algorithms.
819 * Also add signatures if signature nodes are present.
823 * libfdt error code, on failure
825 int fit_add_verification_data(const char *keydir
, void *keydest
, void *fit
,
826 const char *comment
, int require_keys
);
828 int fit_image_verify(const void *fit
, int noffset
);
829 int fit_config_verify(const void *fit
, int conf_noffset
);
830 int fit_all_image_verify(const void *fit
);
831 int fit_image_check_os(const void *fit
, int noffset
, uint8_t os
);
832 int fit_image_check_arch(const void *fit
, int noffset
, uint8_t arch
);
833 int fit_image_check_type(const void *fit
, int noffset
, uint8_t type
);
834 int fit_image_check_comp(const void *fit
, int noffset
, uint8_t comp
);
835 int fit_check_format(const void *fit
);
837 int fit_conf_find_compat(const void *fit
, const void *fdt
);
838 int fit_conf_get_node(const void *fit
, const char *conf_uname
);
841 * fit_conf_get_prop_node() - Get node refered to by a configuration
843 * @noffset: Offset of conf@xxx node to check
844 * @prop_name: Property to read from the conf node
846 * The conf@ nodes contain references to other nodes, using properties
847 * like 'kernel = "kernel@1"'. Given such a property name (e.g. "kernel"),
848 * return the offset of the node referred to (e.g. offset of node
849 * "/images/kernel@1".
851 int fit_conf_get_prop_node(const void *fit
, int noffset
,
852 const char *prop_name
);
854 void fit_conf_print(const void *fit
, int noffset
, const char *p
);
856 int fit_check_ramdisk(const void *fit
, int os_noffset
,
857 uint8_t arch
, int verify
);
859 int calculate_hash(const void *data
, int data_len
, const char *algo
,
860 uint8_t *value
, int *value_len
);
863 * At present we only support signing on the host, and verification on the
866 #if defined(CONFIG_FIT_SIGNATURE)
868 # define IMAGE_ENABLE_SIGN 1
869 # define IMAGE_ENABLE_VERIFY 1
870 # include <openssl/evp.h>
872 # define IMAGE_ENABLE_SIGN 0
873 # define IMAGE_ENABLE_VERIFY 1
876 # define IMAGE_ENABLE_SIGN 0
877 # define IMAGE_ENABLE_VERIFY 0
881 void *image_get_host_blob(void);
882 void image_set_host_blob(void *host_blob
);
883 # define gd_fdt_blob() image_get_host_blob()
885 # define gd_fdt_blob() (gd->fdt_blob)
888 #ifdef CONFIG_FIT_BEST_MATCH
889 #define IMAGE_ENABLE_BEST_MATCH 1
891 #define IMAGE_ENABLE_BEST_MATCH 0
894 /* Information passed to the signing routines */
895 struct image_sign_info
{
896 const char *keydir
; /* Directory conaining keys */
897 const char *keyname
; /* Name of key to use */
898 void *fit
; /* Pointer to FIT blob */
899 int node_offset
; /* Offset of signature node */
900 struct image_sig_algo
*algo
; /* Algorithm information */
901 const void *fdt_blob
; /* FDT containing public keys */
902 int required_keynode
; /* Node offset of key to use: -1=any */
903 const char *require_keys
; /* Value for 'required' property */
906 /* A part of an image, used for hashing */
907 struct image_region
{
912 #if IMAGE_ENABLE_VERIFY
913 # include <u-boot/rsa-checksum.h>
915 struct checksum_algo
{
917 const int checksum_len
;
919 #if IMAGE_ENABLE_SIGN
920 const EVP_MD
*(*calculate_sign
)(void);
922 void (*calculate
)(const struct image_region region
[],
923 int region_count
, uint8_t *checksum
);
924 const uint8_t *rsa_padding
;
927 struct image_sig_algo
{
928 const char *name
; /* Name of algorithm */
931 * sign() - calculate and return signature for given input data
933 * @info: Specifies key and FIT information
934 * @data: Pointer to the input data
935 * @data_len: Data length
936 * @sigp: Set to an allocated buffer holding the signature
937 * @sig_len: Set to length of the calculated hash
939 * This computes input data signature according to selected algorithm.
940 * Resulting signature value is placed in an allocated buffer, the
941 * pointer is returned as *sigp. The length of the calculated
942 * signature is returned via the sig_len pointer argument. The caller
945 * @return: 0, on success, -ve on error
947 int (*sign
)(struct image_sign_info
*info
,
948 const struct image_region region
[],
949 int region_count
, uint8_t **sigp
, uint
*sig_len
);
952 * add_verify_data() - Add verification information to FDT
954 * Add public key information to the FDT node, suitable for
955 * verification at run-time. The information added depends on the
956 * algorithm being used.
958 * @info: Specifies key and FIT information
959 * @keydest: Destination FDT blob for public key data
960 * @return: 0, on success, -ve on error
962 int (*add_verify_data
)(struct image_sign_info
*info
, void *keydest
);
965 * verify() - Verify a signature against some data
967 * @info: Specifies key and FIT information
968 * @data: Pointer to the input data
969 * @data_len: Data length
971 * @sig_len: Number of bytes in signature
972 * @return 0 if verified, -ve on error
974 int (*verify
)(struct image_sign_info
*info
,
975 const struct image_region region
[], int region_count
,
976 uint8_t *sig
, uint sig_len
);
978 /* pointer to checksum algorithm */
979 struct checksum_algo
*checksum
;
983 * image_get_sig_algo() - Look up a signature algortihm
985 * @param name Name of algorithm
986 * @return pointer to algorithm information, or NULL if not found
988 struct image_sig_algo
*image_get_sig_algo(const char *name
);
991 * fit_image_verify_required_sigs() - Verify signatures marked as 'required'
994 * @image_noffset: Offset of image node to check
995 * @data: Image data to check
996 * @size: Size of image data
997 * @sig_blob: FDT containing public keys
998 * @no_sigsp: Returns 1 if no signatures were required, and
999 * therefore nothing was checked. The caller may wish
1000 * to fall back to other mechanisms, or refuse to
1002 * @return 0 if all verified ok, <0 on error
1004 int fit_image_verify_required_sigs(const void *fit
, int image_noffset
,
1005 const char *data
, size_t size
, const void *sig_blob
,
1009 * fit_image_check_sig() - Check a single image signature node
1011 * @fit: FIT to check
1012 * @noffset: Offset of signature node to check
1013 * @data: Image data to check
1014 * @size: Size of image data
1015 * @required_keynode: Offset in the control FDT of the required key node,
1016 * if any. If this is given, then the image wil not
1017 * pass verification unless that key is used. If this is
1018 * -1 then any signature will do.
1019 * @err_msgp: In the event of an error, this will be pointed to a
1020 * help error string to display to the user.
1021 * @return 0 if all verified ok, <0 on error
1023 int fit_image_check_sig(const void *fit
, int noffset
, const void *data
,
1024 size_t size
, int required_keynode
, char **err_msgp
);
1027 * fit_region_make_list() - Make a list of regions to hash
1029 * Given a list of FIT regions (offset, size) provided by libfdt, create
1030 * a list of regions (void *, size) for use by the signature creationg
1031 * and verification code.
1033 * @fit: FIT image to process
1034 * @fdt_regions: Regions as returned by libfdt
1035 * @count: Number of regions returned by libfdt
1036 * @region: Place to put list of regions (NULL to allocate it)
1037 * @return pointer to list of regions, or NULL if out of memory
1039 struct image_region
*fit_region_make_list(const void *fit
,
1040 struct fdt_region
*fdt_regions
, int count
,
1041 struct image_region
*region
);
1043 static inline int fit_image_check_target_arch(const void *fdt
, int node
)
1046 return fit_image_check_arch(fdt
, node
, IH_ARCH_DEFAULT
);
1052 #ifdef CONFIG_FIT_VERBOSE
1053 #define fit_unsupported(msg) printf("! %s:%d " \
1054 "FIT images not supported for '%s'\n", \
1055 __FILE__, __LINE__, (msg))
1057 #define fit_unsupported_reset(msg) printf("! %s:%d " \
1058 "FIT images not supported for '%s' " \
1059 "- must reset board to recover!\n", \
1060 __FILE__, __LINE__, (msg))
1062 #define fit_unsupported(msg)
1063 #define fit_unsupported_reset(msg)
1064 #endif /* CONFIG_FIT_VERBOSE */
1065 #endif /* CONFIG_FIT */
1067 #if defined(CONFIG_ANDROID_BOOT_IMAGE)
1068 struct andr_img_hdr
;
1069 int android_image_check_header(const struct andr_img_hdr
*hdr
);
1070 int android_image_get_kernel(const struct andr_img_hdr
*hdr
, int verify
,
1071 ulong
*os_data
, ulong
*os_len
);
1072 int android_image_get_ramdisk(const struct andr_img_hdr
*hdr
,
1073 ulong
*rd_data
, ulong
*rd_len
);
1074 ulong
android_image_get_end(const struct andr_img_hdr
*hdr
);
1075 ulong
android_image_get_kload(const struct andr_img_hdr
*hdr
);
1077 #endif /* CONFIG_ANDROID_BOOT_IMAGE */
1079 #endif /* __IMAGE_H__ */