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
122 #ifdef CONFIG_OF_SYSTEM_SETUP
123 # define IMAGE_OF_SYSTEM_SETUP 1
125 # define IMAGE_OF_SYSTEM_SETUP 0
129 * Operating System Codes
131 #define IH_OS_INVALID 0 /* Invalid OS */
132 #define IH_OS_OPENBSD 1 /* OpenBSD */
133 #define IH_OS_NETBSD 2 /* NetBSD */
134 #define IH_OS_FREEBSD 3 /* FreeBSD */
135 #define IH_OS_4_4BSD 4 /* 4.4BSD */
136 #define IH_OS_LINUX 5 /* Linux */
137 #define IH_OS_SVR4 6 /* SVR4 */
138 #define IH_OS_ESIX 7 /* Esix */
139 #define IH_OS_SOLARIS 8 /* Solaris */
140 #define IH_OS_IRIX 9 /* Irix */
141 #define IH_OS_SCO 10 /* SCO */
142 #define IH_OS_DELL 11 /* Dell */
143 #define IH_OS_NCR 12 /* NCR */
144 #define IH_OS_LYNXOS 13 /* LynxOS */
145 #define IH_OS_VXWORKS 14 /* VxWorks */
146 #define IH_OS_PSOS 15 /* pSOS */
147 #define IH_OS_QNX 16 /* QNX */
148 #define IH_OS_U_BOOT 17 /* Firmware */
149 #define IH_OS_RTEMS 18 /* RTEMS */
150 #define IH_OS_ARTOS 19 /* ARTOS */
151 #define IH_OS_UNITY 20 /* Unity OS */
152 #define IH_OS_INTEGRITY 21 /* INTEGRITY */
153 #define IH_OS_OSE 22 /* OSE */
154 #define IH_OS_PLAN9 23 /* Plan 9 */
155 #define IH_OS_OPENRTOS 24 /* OpenRTOS */
158 * CPU Architecture Codes (supported by Linux)
160 #define IH_ARCH_INVALID 0 /* Invalid CPU */
161 #define IH_ARCH_ALPHA 1 /* Alpha */
162 #define IH_ARCH_ARM 2 /* ARM */
163 #define IH_ARCH_I386 3 /* Intel x86 */
164 #define IH_ARCH_IA64 4 /* IA64 */
165 #define IH_ARCH_MIPS 5 /* MIPS */
166 #define IH_ARCH_MIPS64 6 /* MIPS 64 Bit */
167 #define IH_ARCH_PPC 7 /* PowerPC */
168 #define IH_ARCH_S390 8 /* IBM S390 */
169 #define IH_ARCH_SH 9 /* SuperH */
170 #define IH_ARCH_SPARC 10 /* Sparc */
171 #define IH_ARCH_SPARC64 11 /* Sparc 64 Bit */
172 #define IH_ARCH_M68K 12 /* M68K */
173 #define IH_ARCH_MICROBLAZE 14 /* MicroBlaze */
174 #define IH_ARCH_NIOS2 15 /* Nios-II */
175 #define IH_ARCH_BLACKFIN 16 /* Blackfin */
176 #define IH_ARCH_AVR32 17 /* AVR32 */
177 #define IH_ARCH_ST200 18 /* STMicroelectronics ST200 */
178 #define IH_ARCH_SANDBOX 19 /* Sandbox architecture (test only) */
179 #define IH_ARCH_NDS32 20 /* ANDES Technology - NDS32 */
180 #define IH_ARCH_OPENRISC 21 /* OpenRISC 1000 */
181 #define IH_ARCH_ARM64 22 /* ARM64 */
182 #define IH_ARCH_ARC 23 /* Synopsys DesignWare ARC */
183 #define IH_ARCH_X86_64 24 /* AMD x86_64, Intel and Via */
188 * "Standalone Programs" are directly runnable in the environment
189 * provided by U-Boot; it is expected that (if they behave
190 * well) you can continue to work in U-Boot after return from
191 * the Standalone Program.
192 * "OS Kernel Images" are usually images of some Embedded OS which
193 * will take over control completely. Usually these programs
194 * will install their own set of exception handlers, device
195 * drivers, set up the MMU, etc. - this means, that you cannot
196 * expect to re-enter U-Boot except by resetting the CPU.
197 * "RAMDisk Images" are more or less just data blocks, and their
198 * parameters (address, size) are passed to an OS kernel that is
200 * "Multi-File Images" contain several images, typically an OS
201 * (Linux) kernel image and one or more data images like
202 * RAMDisks. This construct is useful for instance when you want
203 * to boot over the network using BOOTP etc., where the boot
204 * server provides just a single image file, but you want to get
205 * for instance an OS kernel and a RAMDisk image.
207 * "Multi-File Images" start with a list of image sizes, each
208 * image size (in bytes) specified by an "uint32_t" in network
209 * byte order. This list is terminated by an "(uint32_t)0".
210 * Immediately after the terminating 0 follow the images, one by
211 * one, all aligned on "uint32_t" boundaries (size rounded up to
212 * a multiple of 4 bytes - except for the last file).
214 * "Firmware Images" are binary images containing firmware (like
215 * U-Boot or FPGA images) which usually will be programmed to
218 * "Script files" are command sequences that will be executed by
219 * U-Boot's command interpreter; this feature is especially
220 * useful when you configure U-Boot to use a real shell (hush)
221 * as command interpreter (=> Shell Scripts).
224 #define IH_TYPE_INVALID 0 /* Invalid Image */
225 #define IH_TYPE_STANDALONE 1 /* Standalone Program */
226 #define IH_TYPE_KERNEL 2 /* OS Kernel Image */
227 #define IH_TYPE_RAMDISK 3 /* RAMDisk Image */
228 #define IH_TYPE_MULTI 4 /* Multi-File Image */
229 #define IH_TYPE_FIRMWARE 5 /* Firmware Image */
230 #define IH_TYPE_SCRIPT 6 /* Script file */
231 #define IH_TYPE_FILESYSTEM 7 /* Filesystem Image (any type) */
232 #define IH_TYPE_FLATDT 8 /* Binary Flat Device Tree Blob */
233 #define IH_TYPE_KWBIMAGE 9 /* Kirkwood Boot Image */
234 #define IH_TYPE_IMXIMAGE 10 /* Freescale IMXBoot Image */
235 #define IH_TYPE_UBLIMAGE 11 /* Davinci UBL Image */
236 #define IH_TYPE_OMAPIMAGE 12 /* TI OMAP Config Header Image */
237 #define IH_TYPE_AISIMAGE 13 /* TI Davinci AIS Image */
238 #define IH_TYPE_KERNEL_NOLOAD 14 /* OS Kernel Image, can run from any load address */
239 #define IH_TYPE_PBLIMAGE 15 /* Freescale PBL Boot Image */
240 #define IH_TYPE_MXSIMAGE 16 /* Freescale MXSBoot Image */
241 #define IH_TYPE_GPIMAGE 17 /* TI Keystone GPHeader Image */
242 #define IH_TYPE_ATMELIMAGE 18 /* ATMEL ROM bootable Image */
243 #define IH_TYPE_SOCFPGAIMAGE 19 /* Altera SOCFPGA Preloader */
244 #define IH_TYPE_X86_SETUP 20 /* x86 setup.bin Image */
249 #define IH_COMP_NONE 0 /* No Compression Used */
250 #define IH_COMP_GZIP 1 /* gzip Compression Used */
251 #define IH_COMP_BZIP2 2 /* bzip2 Compression Used */
252 #define IH_COMP_LZMA 3 /* lzma Compression Used */
253 #define IH_COMP_LZO 4 /* lzo Compression Used */
255 #define IH_MAGIC 0x27051956 /* Image Magic Number */
256 #define IH_NMLEN 32 /* Image Name Length */
258 /* Reused from common.h */
259 #define ROUND(a, b) (((a) + (b) - 1) & ~((b) - 1))
262 * Legacy format image header,
263 * all data in network byte order (aka natural aka bigendian).
265 typedef struct image_header
{
266 __be32 ih_magic
; /* Image Header Magic Number */
267 __be32 ih_hcrc
; /* Image Header CRC Checksum */
268 __be32 ih_time
; /* Image Creation Timestamp */
269 __be32 ih_size
; /* Image Data Size */
270 __be32 ih_load
; /* Data Load Address */
271 __be32 ih_ep
; /* Entry Point Address */
272 __be32 ih_dcrc
; /* Image Data CRC Checksum */
273 uint8_t ih_os
; /* Operating System */
274 uint8_t ih_arch
; /* CPU architecture */
275 uint8_t ih_type
; /* Image Type */
276 uint8_t ih_comp
; /* Compression Type */
277 uint8_t ih_name
[IH_NMLEN
]; /* Image Name */
280 typedef struct image_info
{
281 ulong start
, end
; /* start/end of blob */
282 ulong image_start
, image_len
; /* start of image within blob, len of image */
283 ulong load
; /* load addr for the image */
284 uint8_t comp
, type
, os
; /* compression, type of image, os type */
285 uint8_t arch
; /* CPU architecture */
289 * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
292 typedef struct bootm_headers
{
294 * Legacy os image header, if it is a multi component image
295 * then boot_get_ramdisk() and get_fdt() will attempt to get
296 * data from second and third component accordingly.
298 image_header_t
*legacy_hdr_os
; /* image header pointer */
299 image_header_t legacy_hdr_os_copy
; /* header copy */
300 ulong legacy_hdr_valid
;
302 #if defined(CONFIG_FIT)
303 const char *fit_uname_cfg
; /* configuration node unit name */
305 void *fit_hdr_os
; /* os FIT image header */
306 const char *fit_uname_os
; /* os subimage node unit name */
307 int fit_noffset_os
; /* os subimage node offset */
309 void *fit_hdr_rd
; /* init ramdisk FIT image header */
310 const char *fit_uname_rd
; /* init ramdisk subimage node unit name */
311 int fit_noffset_rd
; /* init ramdisk subimage node offset */
313 void *fit_hdr_fdt
; /* FDT blob FIT image header */
314 const char *fit_uname_fdt
; /* FDT blob subimage node unit name */
315 int fit_noffset_fdt
;/* FDT blob subimage node offset */
317 void *fit_hdr_setup
; /* x86 setup FIT image header */
318 const char *fit_uname_setup
; /* x86 setup subimage node name */
319 int fit_noffset_setup
;/* x86 setup subimage node offset */
323 image_info_t os
; /* os image info */
324 ulong ep
; /* entry point of OS */
326 ulong rd_start
, rd_end
;/* ramdisk start/end */
328 char *ft_addr
; /* flat dev tree address */
329 ulong ft_len
; /* length of flat device tree */
338 int verify
; /* getenv("verify")[0] != 'n' */
340 #define BOOTM_STATE_START (0x00000001)
341 #define BOOTM_STATE_FINDOS (0x00000002)
342 #define BOOTM_STATE_FINDOTHER (0x00000004)
343 #define BOOTM_STATE_LOADOS (0x00000008)
344 #define BOOTM_STATE_RAMDISK (0x00000010)
345 #define BOOTM_STATE_FDT (0x00000020)
346 #define BOOTM_STATE_OS_CMDLINE (0x00000040)
347 #define BOOTM_STATE_OS_BD_T (0x00000080)
348 #define BOOTM_STATE_OS_PREP (0x00000100)
349 #define BOOTM_STATE_OS_FAKE_GO (0x00000200) /* 'Almost' run the OS */
350 #define BOOTM_STATE_OS_GO (0x00000400)
354 struct lmb lmb
; /* for memory mgmt */
358 extern bootm_headers_t images
;
361 * Some systems (for example LWMON) have very short watchdog periods;
362 * we must make sure to split long operations like memmove() or
363 * checksum calculations into reasonable chunks.
366 #define CHUNKSZ (64 * 1024)
369 #ifndef CHUNKSZ_CRC32
370 #define CHUNKSZ_CRC32 (64 * 1024)
374 #define CHUNKSZ_MD5 (64 * 1024)
378 #define CHUNKSZ_SHA1 (64 * 1024)
381 #define uimage_to_cpu(x) be32_to_cpu(x)
382 #define cpu_to_uimage(x) cpu_to_be32(x)
385 * Translation table for entries of a specific type; used by
386 * get_table_entry_id() and get_table_entry_name().
388 typedef struct table_entry
{
390 char *sname
; /* short (input) name to find table entry */
391 char *lname
; /* long (output) name to print for messages */
395 * get_table_entry_id() scans the translation table trying to find an
396 * entry that matches the given short name. If a matching entry is
397 * found, it's id is returned to the caller.
399 int get_table_entry_id(const table_entry_t
*table
,
400 const char *table_name
, const char *name
);
402 * get_table_entry_name() scans the translation table trying to find
403 * an entry that matches the given id. If a matching entry is found,
404 * its long name is returned to the caller.
406 char *get_table_entry_name(const table_entry_t
*table
, char *msg
, int id
);
408 const char *genimg_get_os_name(uint8_t os
);
409 const char *genimg_get_arch_name(uint8_t arch
);
410 const char *genimg_get_type_name(uint8_t type
);
411 const char *genimg_get_comp_name(uint8_t comp
);
412 int genimg_get_os_id(const char *name
);
413 int genimg_get_arch_id(const char *name
);
414 int genimg_get_type_id(const char *name
);
415 int genimg_get_comp_id(const char *name
);
416 void genimg_print_size(uint32_t size
);
418 #if defined(CONFIG_TIMESTAMP) || defined(CONFIG_CMD_DATE) || \
420 #define IMAGE_ENABLE_TIMESTAMP 1
422 #define IMAGE_ENABLE_TIMESTAMP 0
424 void genimg_print_time(time_t timestamp
);
426 /* What to do with a image load address ('load = <> 'in the FIT) */
428 FIT_LOAD_IGNORED
, /* Ignore load address */
429 FIT_LOAD_OPTIONAL
, /* Can be provided, but optional */
430 FIT_LOAD_OPTIONAL_NON_ZERO
, /* Optional, a value of 0 is ignored */
431 FIT_LOAD_REQUIRED
, /* Must be provided */
434 int boot_get_setup(bootm_headers_t
*images
, uint8_t arch
, ulong
*setup_start
,
438 /* Image format types, returned by _get_format() routine */
439 #define IMAGE_FORMAT_INVALID 0x00
440 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
441 #define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */
443 #define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */
444 #define IMAGE_FORMAT_ANDROID 0x03 /* Android boot image */
446 ulong
genimg_get_kernel_addr_fit(char * const img_addr
,
447 const char **fit_uname_config
,
448 const char **fit_uname_kernel
);
449 ulong
genimg_get_kernel_addr(char * const img_addr
);
450 int genimg_get_format(const void *img_addr
);
451 int genimg_has_config(bootm_headers_t
*images
);
452 ulong
genimg_get_image(ulong img_addr
);
454 int boot_get_ramdisk(int argc
, char * const argv
[], bootm_headers_t
*images
,
455 uint8_t arch
, ulong
*rd_start
, ulong
*rd_end
);
458 int boot_get_setup_fit(bootm_headers_t
*images
, uint8_t arch
,
459 ulong
*setup_start
, ulong
*setup_len
);
462 * fit_image_load() - load an image from a FIT
464 * This deals with all aspects of loading an image from a FIT, including
465 * selecting the right image based on configuration, verifying it, printing
466 * out progress messages, checking the type/arch/os and optionally copying it
467 * to the right load address.
469 * The property to look up is defined by image_type.
471 * @param images Boot images structure
472 * @param addr Address of FIT in memory
473 * @param fit_unamep On entry this is the requested image name
474 * (e.g. "kernel@1") or NULL to use the default. On exit
475 * points to the selected image name
476 * @param fit_uname_configp On entry this is the requested configuration
477 * name (e.g. "conf@1") or NULL to use the default. On
478 * exit points to the selected configuration name.
479 * @param arch Expected architecture (IH_ARCH_...)
480 * @param image_type Required image type (IH_TYPE_...). If this is
481 * IH_TYPE_KERNEL then we allow IH_TYPE_KERNEL_NOLOAD
483 * @param bootstage_id ID of starting bootstage to use for progress updates.
484 * This will be added to the BOOTSTAGE_SUB values when
485 * calling bootstage_mark()
486 * @param load_op Decribes what to do with the load address
487 * @param datap Returns address of loaded image
488 * @param lenp Returns length of loaded image
489 * @return node offset of image, or -ve error code on error
491 int fit_image_load(bootm_headers_t
*images
, ulong addr
,
492 const char **fit_unamep
, const char **fit_uname_configp
,
493 int arch
, int image_type
, int bootstage_id
,
494 enum fit_load_op load_op
, ulong
*datap
, ulong
*lenp
);
498 * fit_get_node_from_config() - Look up an image a FIT by type
500 * This looks in the selected conf@ node (images->fit_uname_cfg) for a
501 * particular image type (e.g. "kernel") and then finds the image that is
504 * For example, for something like:
513 * kernel = "kernel@1";
517 * the function will return the node offset of the kernel@1 node, assuming
518 * that conf@1 is the chosen configuration.
520 * @param images Boot images structure
521 * @param prop_name Property name to look up (FIT_..._PROP)
522 * @param addr Address of FIT in memory
524 int fit_get_node_from_config(bootm_headers_t
*images
, const char *prop_name
,
527 int boot_get_fdt(int flag
, int argc
, char * const argv
[], uint8_t arch
,
528 bootm_headers_t
*images
,
529 char **of_flat_tree
, ulong
*of_size
);
530 void boot_fdt_add_mem_rsv_regions(struct lmb
*lmb
, void *fdt_blob
);
531 int boot_relocate_fdt(struct lmb
*lmb
, char **of_flat_tree
, ulong
*of_size
);
533 int boot_ramdisk_high(struct lmb
*lmb
, ulong rd_data
, ulong rd_len
,
534 ulong
*initrd_start
, ulong
*initrd_end
);
535 int boot_get_cmdline(struct lmb
*lmb
, ulong
*cmd_start
, ulong
*cmd_end
);
536 #ifdef CONFIG_SYS_BOOT_GET_KBD
537 int boot_get_kbd(struct lmb
*lmb
, bd_t
**kbd
);
538 #endif /* CONFIG_SYS_BOOT_GET_KBD */
539 #endif /* !USE_HOSTCC */
541 /*******************************************************************/
542 /* Legacy format specific code (prefixed with image_) */
543 /*******************************************************************/
544 static inline uint32_t image_get_header_size(void)
546 return (sizeof(image_header_t
));
549 #define image_get_hdr_l(f) \
550 static inline uint32_t image_get_##f(const image_header_t *hdr) \
552 return uimage_to_cpu(hdr->ih_##f); \
554 image_get_hdr_l(magic
) /* image_get_magic */
555 image_get_hdr_l(hcrc
) /* image_get_hcrc */
556 image_get_hdr_l(time
) /* image_get_time */
557 image_get_hdr_l(size
) /* image_get_size */
558 image_get_hdr_l(load
) /* image_get_load */
559 image_get_hdr_l(ep
) /* image_get_ep */
560 image_get_hdr_l(dcrc
) /* image_get_dcrc */
562 #define image_get_hdr_b(f) \
563 static inline uint8_t image_get_##f(const image_header_t *hdr) \
565 return hdr->ih_##f; \
567 image_get_hdr_b(os
) /* image_get_os */
568 image_get_hdr_b(arch
) /* image_get_arch */
569 image_get_hdr_b(type
) /* image_get_type */
570 image_get_hdr_b(comp
) /* image_get_comp */
572 static inline char *image_get_name(const image_header_t
*hdr
)
574 return (char *)hdr
->ih_name
;
577 static inline uint32_t image_get_data_size(const image_header_t
*hdr
)
579 return image_get_size(hdr
);
583 * image_get_data - get image payload start address
586 * image_get_data() returns address of the image payload. For single
587 * component images it is image data start. For multi component
588 * images it points to the null terminated table of sub-images sizes.
591 * image payload data start address
593 static inline ulong
image_get_data(const image_header_t
*hdr
)
595 return ((ulong
)hdr
+ image_get_header_size());
598 static inline uint32_t image_get_image_size(const image_header_t
*hdr
)
600 return (image_get_size(hdr
) + image_get_header_size());
602 static inline ulong
image_get_image_end(const image_header_t
*hdr
)
604 return ((ulong
)hdr
+ image_get_image_size(hdr
));
607 #define image_set_hdr_l(f) \
608 static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
610 hdr->ih_##f = cpu_to_uimage(val); \
612 image_set_hdr_l(magic
) /* image_set_magic */
613 image_set_hdr_l(hcrc
) /* image_set_hcrc */
614 image_set_hdr_l(time
) /* image_set_time */
615 image_set_hdr_l(size
) /* image_set_size */
616 image_set_hdr_l(load
) /* image_set_load */
617 image_set_hdr_l(ep
) /* image_set_ep */
618 image_set_hdr_l(dcrc
) /* image_set_dcrc */
620 #define image_set_hdr_b(f) \
621 static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
625 image_set_hdr_b(os
) /* image_set_os */
626 image_set_hdr_b(arch
) /* image_set_arch */
627 image_set_hdr_b(type
) /* image_set_type */
628 image_set_hdr_b(comp
) /* image_set_comp */
630 static inline void image_set_name(image_header_t
*hdr
, const char *name
)
632 strncpy(image_get_name(hdr
), name
, IH_NMLEN
);
635 int image_check_hcrc(const image_header_t
*hdr
);
636 int image_check_dcrc(const image_header_t
*hdr
);
638 ulong
getenv_bootm_low(void);
639 phys_size_t
getenv_bootm_size(void);
640 phys_size_t
getenv_bootm_mapsize(void);
642 void memmove_wd(void *to
, void *from
, size_t len
, ulong chunksz
);
644 static inline int image_check_magic(const image_header_t
*hdr
)
646 return (image_get_magic(hdr
) == IH_MAGIC
);
648 static inline int image_check_type(const image_header_t
*hdr
, uint8_t type
)
650 return (image_get_type(hdr
) == type
);
652 static inline int image_check_arch(const image_header_t
*hdr
, uint8_t arch
)
654 return (image_get_arch(hdr
) == arch
);
656 static inline int image_check_os(const image_header_t
*hdr
, uint8_t os
)
658 return (image_get_os(hdr
) == os
);
661 ulong
image_multi_count(const image_header_t
*hdr
);
662 void image_multi_getimg(const image_header_t
*hdr
, ulong idx
,
663 ulong
*data
, ulong
*len
);
665 void image_print_contents(const void *hdr
);
668 static inline int image_check_target_arch(const image_header_t
*hdr
)
670 #ifndef IH_ARCH_DEFAULT
671 # error "please define IH_ARCH_DEFAULT in your arch asm/u-boot.h"
673 return image_check_arch(hdr
, IH_ARCH_DEFAULT
);
675 #endif /* USE_HOSTCC */
678 * Set up properties in the FDT
680 * This sets up properties in the FDT that is to be passed to linux.
682 * @images: Images information
683 * @blob: FDT to update
684 * @of_size: Size of the FDT
685 * @lmb: Points to logical memory block structure
686 * @return 0 if ok, <0 on failure
688 int image_setup_libfdt(bootm_headers_t
*images
, void *blob
,
689 int of_size
, struct lmb
*lmb
);
692 * Set up the FDT to use for booting a kernel
694 * This performs ramdisk setup, sets up the FDT if required, and adds
695 * paramters to the FDT if libfdt is available.
697 * @param images Images information
698 * @return 0 if ok, <0 on failure
700 int image_setup_linux(bootm_headers_t
*images
);
703 * bootz_setup() - Extract stat and size of a Linux xImage
705 * @image: Address of image
706 * @start: Returns start address of image
707 * @end : Returns end address of image
708 * @return 0 if OK, 1 if the image was not recognised
710 int bootz_setup(ulong image
, ulong
*start
, ulong
*end
);
713 /*******************************************************************/
714 /* New uImage format specific code (prefixed with fit_) */
715 /*******************************************************************/
716 #if defined(CONFIG_FIT)
718 #define FIT_IMAGES_PATH "/images"
719 #define FIT_CONFS_PATH "/configurations"
721 /* hash/signature node */
722 #define FIT_HASH_NODENAME "hash"
723 #define FIT_ALGO_PROP "algo"
724 #define FIT_VALUE_PROP "value"
725 #define FIT_IGNORE_PROP "uboot-ignore"
726 #define FIT_SIG_NODENAME "signature"
729 #define FIT_DATA_PROP "data"
730 #define FIT_TIMESTAMP_PROP "timestamp"
731 #define FIT_DESC_PROP "description"
732 #define FIT_ARCH_PROP "arch"
733 #define FIT_TYPE_PROP "type"
734 #define FIT_OS_PROP "os"
735 #define FIT_COMP_PROP "compression"
736 #define FIT_ENTRY_PROP "entry"
737 #define FIT_LOAD_PROP "load"
739 /* configuration node */
740 #define FIT_KERNEL_PROP "kernel"
741 #define FIT_RAMDISK_PROP "ramdisk"
742 #define FIT_FDT_PROP "fdt"
743 #define FIT_DEFAULT_PROP "default"
744 #define FIT_SETUP_PROP "setup"
746 #define FIT_MAX_HASH_LEN HASH_MAX_DIGEST_SIZE
748 /* cmdline argument format parsing */
749 int fit_parse_conf(const char *spec
, ulong addr_curr
,
750 ulong
*addr
, const char **conf_name
);
751 int fit_parse_subimage(const char *spec
, ulong addr_curr
,
752 ulong
*addr
, const char **image_name
);
754 int fit_get_subimage_count(const void *fit
, int images_noffset
);
755 void fit_print_contents(const void *fit
);
756 void fit_image_print(const void *fit
, int noffset
, const char *p
);
759 * fit_get_end - get FIT image size
760 * @fit: pointer to the FIT format image header
763 * size of the FIT image (blob) in memory
765 static inline ulong
fit_get_size(const void *fit
)
767 return fdt_totalsize(fit
);
771 * fit_get_end - get FIT image end
772 * @fit: pointer to the FIT format image header
775 * end address of the FIT image (blob) in memory
777 static inline ulong
fit_get_end(const void *fit
)
779 return (ulong
)fit
+ fdt_totalsize(fit
);
783 * fit_get_name - get FIT node name
784 * @fit: pointer to the FIT format image header
788 * pointer to node name, on success
790 static inline const char *fit_get_name(const void *fit_hdr
,
791 int noffset
, int *len
)
793 return fdt_get_name(fit_hdr
, noffset
, len
);
796 int fit_get_desc(const void *fit
, int noffset
, char **desc
);
797 int fit_get_timestamp(const void *fit
, int noffset
, time_t *timestamp
);
799 int fit_image_get_node(const void *fit
, const char *image_uname
);
800 int fit_image_get_os(const void *fit
, int noffset
, uint8_t *os
);
801 int fit_image_get_arch(const void *fit
, int noffset
, uint8_t *arch
);
802 int fit_image_get_type(const void *fit
, int noffset
, uint8_t *type
);
803 int fit_image_get_comp(const void *fit
, int noffset
, uint8_t *comp
);
804 int fit_image_get_load(const void *fit
, int noffset
, ulong
*load
);
805 int fit_image_get_entry(const void *fit
, int noffset
, ulong
*entry
);
806 int fit_image_get_data(const void *fit
, int noffset
,
807 const void **data
, size_t *size
);
809 int fit_image_hash_get_algo(const void *fit
, int noffset
, char **algo
);
810 int fit_image_hash_get_value(const void *fit
, int noffset
, uint8_t **value
,
813 int fit_set_timestamp(void *fit
, int noffset
, time_t timestamp
);
816 * fit_add_verification_data() - add verification data to FIT image nodes
818 * @keydir: Directory containing keys
819 * @kwydest: FDT blob to write public key information to
820 * @fit: Pointer to the FIT format image header
821 * @comment: Comment to add to signature nodes
822 * @require_keys: Mark all keys as 'required'
824 * Adds hash values for all component images in the FIT blob.
825 * Hashes are calculated for all component images which have hash subnodes
826 * with algorithm property set to one of the supported hash algorithms.
828 * Also add signatures if signature nodes are present.
832 * libfdt error code, on failure
834 int fit_add_verification_data(const char *keydir
, void *keydest
, void *fit
,
835 const char *comment
, int require_keys
);
837 int fit_image_verify(const void *fit
, int noffset
);
838 int fit_config_verify(const void *fit
, int conf_noffset
);
839 int fit_all_image_verify(const void *fit
);
840 int fit_image_check_os(const void *fit
, int noffset
, uint8_t os
);
841 int fit_image_check_arch(const void *fit
, int noffset
, uint8_t arch
);
842 int fit_image_check_type(const void *fit
, int noffset
, uint8_t type
);
843 int fit_image_check_comp(const void *fit
, int noffset
, uint8_t comp
);
844 int fit_check_format(const void *fit
);
846 int fit_conf_find_compat(const void *fit
, const void *fdt
);
847 int fit_conf_get_node(const void *fit
, const char *conf_uname
);
850 * fit_conf_get_prop_node() - Get node refered to by a configuration
852 * @noffset: Offset of conf@xxx node to check
853 * @prop_name: Property to read from the conf node
855 * The conf@ nodes contain references to other nodes, using properties
856 * like 'kernel = "kernel@1"'. Given such a property name (e.g. "kernel"),
857 * return the offset of the node referred to (e.g. offset of node
858 * "/images/kernel@1".
860 int fit_conf_get_prop_node(const void *fit
, int noffset
,
861 const char *prop_name
);
863 void fit_conf_print(const void *fit
, int noffset
, const char *p
);
865 int fit_check_ramdisk(const void *fit
, int os_noffset
,
866 uint8_t arch
, int verify
);
868 int calculate_hash(const void *data
, int data_len
, const char *algo
,
869 uint8_t *value
, int *value_len
);
872 * At present we only support signing on the host, and verification on the
875 #if defined(CONFIG_FIT_SIGNATURE)
877 # define IMAGE_ENABLE_SIGN 1
878 # define IMAGE_ENABLE_VERIFY 1
879 # include <openssl/evp.h>
881 # define IMAGE_ENABLE_SIGN 0
882 # define IMAGE_ENABLE_VERIFY 1
885 # define IMAGE_ENABLE_SIGN 0
886 # define IMAGE_ENABLE_VERIFY 0
890 void *image_get_host_blob(void);
891 void image_set_host_blob(void *host_blob
);
892 # define gd_fdt_blob() image_get_host_blob()
894 # define gd_fdt_blob() (gd->fdt_blob)
897 #ifdef CONFIG_FIT_BEST_MATCH
898 #define IMAGE_ENABLE_BEST_MATCH 1
900 #define IMAGE_ENABLE_BEST_MATCH 0
903 /* Information passed to the signing routines */
904 struct image_sign_info
{
905 const char *keydir
; /* Directory conaining keys */
906 const char *keyname
; /* Name of key to use */
907 void *fit
; /* Pointer to FIT blob */
908 int node_offset
; /* Offset of signature node */
909 struct image_sig_algo
*algo
; /* Algorithm information */
910 const void *fdt_blob
; /* FDT containing public keys */
911 int required_keynode
; /* Node offset of key to use: -1=any */
912 const char *require_keys
; /* Value for 'required' property */
915 /* A part of an image, used for hashing */
916 struct image_region
{
921 #if IMAGE_ENABLE_VERIFY
922 # include <u-boot/rsa-checksum.h>
924 struct checksum_algo
{
926 const int checksum_len
;
928 #if IMAGE_ENABLE_SIGN
929 const EVP_MD
*(*calculate_sign
)(void);
931 int (*calculate
)(const char *name
,
932 const struct image_region region
[],
933 int region_count
, uint8_t *checksum
);
934 const uint8_t *rsa_padding
;
937 struct image_sig_algo
{
938 const char *name
; /* Name of algorithm */
941 * sign() - calculate and return signature for given input data
943 * @info: Specifies key and FIT information
944 * @data: Pointer to the input data
945 * @data_len: Data length
946 * @sigp: Set to an allocated buffer holding the signature
947 * @sig_len: Set to length of the calculated hash
949 * This computes input data signature according to selected algorithm.
950 * Resulting signature value is placed in an allocated buffer, the
951 * pointer is returned as *sigp. The length of the calculated
952 * signature is returned via the sig_len pointer argument. The caller
955 * @return: 0, on success, -ve on error
957 int (*sign
)(struct image_sign_info
*info
,
958 const struct image_region region
[],
959 int region_count
, uint8_t **sigp
, uint
*sig_len
);
962 * add_verify_data() - Add verification information to FDT
964 * Add public key information to the FDT node, suitable for
965 * verification at run-time. The information added depends on the
966 * algorithm being used.
968 * @info: Specifies key and FIT information
969 * @keydest: Destination FDT blob for public key data
970 * @return: 0, on success, -ve on error
972 int (*add_verify_data
)(struct image_sign_info
*info
, void *keydest
);
975 * verify() - Verify a signature against some data
977 * @info: Specifies key and FIT information
978 * @data: Pointer to the input data
979 * @data_len: Data length
981 * @sig_len: Number of bytes in signature
982 * @return 0 if verified, -ve on error
984 int (*verify
)(struct image_sign_info
*info
,
985 const struct image_region region
[], int region_count
,
986 uint8_t *sig
, uint sig_len
);
988 /* pointer to checksum algorithm */
989 struct checksum_algo
*checksum
;
993 * image_get_sig_algo() - Look up a signature algortihm
995 * @param name Name of algorithm
996 * @return pointer to algorithm information, or NULL if not found
998 struct image_sig_algo
*image_get_sig_algo(const char *name
);
1001 * fit_image_verify_required_sigs() - Verify signatures marked as 'required'
1003 * @fit: FIT to check
1004 * @image_noffset: Offset of image node to check
1005 * @data: Image data to check
1006 * @size: Size of image data
1007 * @sig_blob: FDT containing public keys
1008 * @no_sigsp: Returns 1 if no signatures were required, and
1009 * therefore nothing was checked. The caller may wish
1010 * to fall back to other mechanisms, or refuse to
1012 * @return 0 if all verified ok, <0 on error
1014 int fit_image_verify_required_sigs(const void *fit
, int image_noffset
,
1015 const char *data
, size_t size
, const void *sig_blob
,
1019 * fit_image_check_sig() - Check a single image signature node
1021 * @fit: FIT to check
1022 * @noffset: Offset of signature node to check
1023 * @data: Image data to check
1024 * @size: Size of image data
1025 * @required_keynode: Offset in the control FDT of the required key node,
1026 * if any. If this is given, then the image wil not
1027 * pass verification unless that key is used. If this is
1028 * -1 then any signature will do.
1029 * @err_msgp: In the event of an error, this will be pointed to a
1030 * help error string to display to the user.
1031 * @return 0 if all verified ok, <0 on error
1033 int fit_image_check_sig(const void *fit
, int noffset
, const void *data
,
1034 size_t size
, int required_keynode
, char **err_msgp
);
1037 * fit_region_make_list() - Make a list of regions to hash
1039 * Given a list of FIT regions (offset, size) provided by libfdt, create
1040 * a list of regions (void *, size) for use by the signature creationg
1041 * and verification code.
1043 * @fit: FIT image to process
1044 * @fdt_regions: Regions as returned by libfdt
1045 * @count: Number of regions returned by libfdt
1046 * @region: Place to put list of regions (NULL to allocate it)
1047 * @return pointer to list of regions, or NULL if out of memory
1049 struct image_region
*fit_region_make_list(const void *fit
,
1050 struct fdt_region
*fdt_regions
, int count
,
1051 struct image_region
*region
);
1053 static inline int fit_image_check_target_arch(const void *fdt
, int node
)
1056 return fit_image_check_arch(fdt
, node
, IH_ARCH_DEFAULT
);
1062 #ifdef CONFIG_FIT_VERBOSE
1063 #define fit_unsupported(msg) printf("! %s:%d " \
1064 "FIT images not supported for '%s'\n", \
1065 __FILE__, __LINE__, (msg))
1067 #define fit_unsupported_reset(msg) printf("! %s:%d " \
1068 "FIT images not supported for '%s' " \
1069 "- must reset board to recover!\n", \
1070 __FILE__, __LINE__, (msg))
1072 #define fit_unsupported(msg)
1073 #define fit_unsupported_reset(msg)
1074 #endif /* CONFIG_FIT_VERBOSE */
1075 #endif /* CONFIG_FIT */
1077 #if defined(CONFIG_ANDROID_BOOT_IMAGE)
1078 struct andr_img_hdr
;
1079 int android_image_check_header(const struct andr_img_hdr
*hdr
);
1080 int android_image_get_kernel(const struct andr_img_hdr
*hdr
, int verify
,
1081 ulong
*os_data
, ulong
*os_len
);
1082 int android_image_get_ramdisk(const struct andr_img_hdr
*hdr
,
1083 ulong
*rd_data
, ulong
*rd_len
);
1084 ulong
android_image_get_end(const struct andr_img_hdr
*hdr
);
1085 ulong
android_image_get_kload(const struct andr_img_hdr
*hdr
);
1087 #endif /* CONFIG_ANDROID_BOOT_IMAGE */
1089 #endif /* __IMAGE_H__ */