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 */
240 #define IH_COMP_NONE 0 /* No Compression Used */
241 #define IH_COMP_GZIP 1 /* gzip Compression Used */
242 #define IH_COMP_BZIP2 2 /* bzip2 Compression Used */
243 #define IH_COMP_LZMA 3 /* lzma Compression Used */
244 #define IH_COMP_LZO 4 /* lzo Compression Used */
246 #define IH_MAGIC 0x27051956 /* Image Magic Number */
247 #define IH_NMLEN 32 /* Image Name Length */
249 /* Reused from common.h */
250 #define ROUND(a, b) (((a) + (b) - 1) & ~((b) - 1))
253 * Legacy format image header,
254 * all data in network byte order (aka natural aka bigendian).
256 typedef struct image_header {
257 __be32 ih_magic; /* Image Header Magic Number */
258 __be32 ih_hcrc; /* Image Header CRC Checksum */
259 __be32 ih_time; /* Image Creation Timestamp */
260 __be32 ih_size; /* Image Data Size */
261 __be32 ih_load; /* Data Load Address */
262 __be32 ih_ep; /* Entry Point Address */
263 __be32 ih_dcrc; /* Image Data CRC Checksum */
264 uint8_t ih_os; /* Operating System */
265 uint8_t ih_arch; /* CPU architecture */
266 uint8_t ih_type; /* Image Type */
267 uint8_t ih_comp; /* Compression Type */
268 uint8_t ih_name[IH_NMLEN]; /* Image Name */
271 typedef struct image_info {
272 ulong start, end; /* start/end of blob */
273 ulong image_start, image_len; /* start of image within blob, len of image */
274 ulong load; /* load addr for the image */
275 uint8_t comp, type, os; /* compression, type of image, os type */
279 * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
282 typedef struct bootm_headers {
284 * Legacy os image header, if it is a multi component image
285 * then boot_get_ramdisk() and get_fdt() will attempt to get
286 * data from second and third component accordingly.
288 image_header_t *legacy_hdr_os; /* image header pointer */
289 image_header_t legacy_hdr_os_copy; /* header copy */
290 ulong legacy_hdr_valid;
292 #if defined(CONFIG_FIT)
293 const char *fit_uname_cfg; /* configuration node unit name */
295 void *fit_hdr_os; /* os FIT image header */
296 const char *fit_uname_os; /* os subimage node unit name */
297 int fit_noffset_os; /* os subimage node offset */
299 void *fit_hdr_rd; /* init ramdisk FIT image header */
300 const char *fit_uname_rd; /* init ramdisk subimage node unit name */
301 int fit_noffset_rd; /* init ramdisk subimage node offset */
303 void *fit_hdr_fdt; /* FDT blob FIT image header */
304 const char *fit_uname_fdt; /* FDT blob subimage node unit name */
305 int fit_noffset_fdt;/* FDT blob subimage node offset */
309 image_info_t os; /* os image info */
310 ulong ep; /* entry point of OS */
312 ulong rd_start, rd_end;/* ramdisk start/end */
314 char *ft_addr; /* flat dev tree address */
315 ulong ft_len; /* length of flat device tree */
324 int verify; /* getenv("verify")[0] != 'n' */
326 #define BOOTM_STATE_START (0x00000001)
327 #define BOOTM_STATE_FINDOS (0x00000002)
328 #define BOOTM_STATE_FINDOTHER (0x00000004)
329 #define BOOTM_STATE_LOADOS (0x00000008)
330 #define BOOTM_STATE_RAMDISK (0x00000010)
331 #define BOOTM_STATE_FDT (0x00000020)
332 #define BOOTM_STATE_OS_CMDLINE (0x00000040)
333 #define BOOTM_STATE_OS_BD_T (0x00000080)
334 #define BOOTM_STATE_OS_PREP (0x00000100)
335 #define BOOTM_STATE_OS_FAKE_GO (0x00000200) /* 'Almost' run the OS */
336 #define BOOTM_STATE_OS_GO (0x00000400)
340 struct lmb lmb; /* for memory mgmt */
344 extern bootm_headers_t images;
347 * Some systems (for example LWMON) have very short watchdog periods;
348 * we must make sure to split long operations like memmove() or
349 * checksum calculations into reasonable chunks.
352 #define CHUNKSZ (64 * 1024)
355 #ifndef CHUNKSZ_CRC32
356 #define CHUNKSZ_CRC32 (64 * 1024)
360 #define CHUNKSZ_MD5 (64 * 1024)
364 #define CHUNKSZ_SHA1 (64 * 1024)
367 #define uimage_to_cpu(x) be32_to_cpu(x)
368 #define cpu_to_uimage(x) cpu_to_be32(x)
371 * Translation table for entries of a specific type; used by
372 * get_table_entry_id() and get_table_entry_name().
374 typedef struct table_entry {
376 char *sname; /* short (input) name to find table entry */
377 char *lname; /* long (output) name to print for messages */
381 * get_table_entry_id() scans the translation table trying to find an
382 * entry that matches the given short name. If a matching entry is
383 * found, it's id is returned to the caller.
385 int get_table_entry_id(const table_entry_t *table,
386 const char *table_name, const char *name);
388 * get_table_entry_name() scans the translation table trying to find
389 * an entry that matches the given id. If a matching entry is found,
390 * its long name is returned to the caller.
392 char *get_table_entry_name(const table_entry_t *table, char *msg, int id);
394 const char *genimg_get_os_name(uint8_t os);
395 const char *genimg_get_arch_name(uint8_t arch);
396 const char *genimg_get_type_name(uint8_t type);
397 const char *genimg_get_comp_name(uint8_t comp);
398 int genimg_get_os_id(const char *name);
399 int genimg_get_arch_id(const char *name);
400 int genimg_get_type_id(const char *name);
401 int genimg_get_comp_id(const char *name);
402 void genimg_print_size(uint32_t size);
404 #if defined(CONFIG_TIMESTAMP) || defined(CONFIG_CMD_DATE) || \
406 #define IMAGE_ENABLE_TIMESTAMP 1
408 #define IMAGE_ENABLE_TIMESTAMP 0
410 void genimg_print_time(time_t timestamp);
412 /* What to do with a image load address ('load = <> 'in the FIT) */
414 FIT_LOAD_IGNORED, /* Ignore load address */
415 FIT_LOAD_OPTIONAL, /* Can be provided, but optional */
416 FIT_LOAD_OPTIONAL_NON_ZERO, /* Optional, a value of 0 is ignored */
417 FIT_LOAD_REQUIRED, /* Must be provided */
421 /* Image format types, returned by _get_format() routine */
422 #define IMAGE_FORMAT_INVALID 0x00
423 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
424 #define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */
426 #define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */
427 #define IMAGE_FORMAT_ANDROID 0x03 /* Android boot image */
429 ulong genimg_get_kernel_addr_fit(char * const img_addr,
430 const char **fit_uname_config,
431 const char **fit_uname_kernel);
432 ulong genimg_get_kernel_addr(char * const img_addr);
433 int genimg_get_format(const void *img_addr);
434 int genimg_has_config(bootm_headers_t *images);
435 ulong genimg_get_image(ulong img_addr);
437 int boot_get_ramdisk(int argc, char * const argv[], bootm_headers_t *images,
438 uint8_t arch, ulong *rd_start, ulong *rd_end);
442 * fit_image_load() - load an image from a FIT
444 * This deals with all aspects of loading an image from a FIT, including
445 * selecting the right image based on configuration, verifying it, printing
446 * out progress messages, checking the type/arch/os and optionally copying it
447 * to the right load address.
449 * The property to look up is defined by image_type.
451 * @param images Boot images structure
452 * @param addr Address of FIT in memory
453 * @param fit_unamep On entry this is the requested image name
454 * (e.g. "kernel@1") or NULL to use the default. On exit
455 * points to the selected image name
456 * @param fit_uname_configp On entry this is the requested configuration
457 * name (e.g. "conf@1") or NULL to use the default. On
458 * exit points to the selected configuration name.
459 * @param arch Expected architecture (IH_ARCH_...)
460 * @param image_type Required image type (IH_TYPE_...). If this is
461 * IH_TYPE_KERNEL then we allow IH_TYPE_KERNEL_NOLOAD
463 * @param bootstage_id ID of starting bootstage to use for progress updates.
464 * This will be added to the BOOTSTAGE_SUB values when
465 * calling bootstage_mark()
466 * @param load_op Decribes what to do with the load address
467 * @param datap Returns address of loaded image
468 * @param lenp Returns length of loaded image
469 * @return node offset of image, or -ve error code on error
471 int fit_image_load(bootm_headers_t *images, ulong addr,
472 const char **fit_unamep, const char **fit_uname_configp,
473 int arch, int image_type, int bootstage_id,
474 enum fit_load_op load_op, ulong *datap, ulong *lenp);
478 * fit_get_node_from_config() - Look up an image a FIT by type
480 * This looks in the selected conf@ node (images->fit_uname_cfg) for a
481 * particular image type (e.g. "kernel") and then finds the image that is
484 * For example, for something like:
493 * kernel = "kernel@1";
497 * the function will return the node offset of the kernel@1 node, assuming
498 * that conf@1 is the chosen configuration.
500 * @param images Boot images structure
501 * @param prop_name Property name to look up (FIT_..._PROP)
502 * @param addr Address of FIT in memory
504 int fit_get_node_from_config(bootm_headers_t *images, const char *prop_name,
507 int boot_get_fdt(int flag, int argc, char * const argv[], uint8_t arch,
508 bootm_headers_t *images,
509 char **of_flat_tree, ulong *of_size);
510 void boot_fdt_add_mem_rsv_regions(struct lmb *lmb, void *fdt_blob);
511 int boot_relocate_fdt(struct lmb *lmb, char **of_flat_tree, ulong *of_size);
513 int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len,
514 ulong *initrd_start, ulong *initrd_end);
515 int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end);
516 #ifdef CONFIG_SYS_BOOT_GET_KBD
517 int boot_get_kbd(struct lmb *lmb, bd_t **kbd);
518 #endif /* CONFIG_SYS_BOOT_GET_KBD */
519 #endif /* !USE_HOSTCC */
521 /*******************************************************************/
522 /* Legacy format specific code (prefixed with image_) */
523 /*******************************************************************/
524 static inline uint32_t image_get_header_size(void)
526 return (sizeof(image_header_t));
529 #define image_get_hdr_l(f) \
530 static inline uint32_t image_get_##f(const image_header_t *hdr) \
532 return uimage_to_cpu(hdr->ih_##f); \
534 image_get_hdr_l(magic) /* image_get_magic */
535 image_get_hdr_l(hcrc) /* image_get_hcrc */
536 image_get_hdr_l(time) /* image_get_time */
537 image_get_hdr_l(size) /* image_get_size */
538 image_get_hdr_l(load) /* image_get_load */
539 image_get_hdr_l(ep) /* image_get_ep */
540 image_get_hdr_l(dcrc) /* image_get_dcrc */
542 #define image_get_hdr_b(f) \
543 static inline uint8_t image_get_##f(const image_header_t *hdr) \
545 return hdr->ih_##f; \
547 image_get_hdr_b(os) /* image_get_os */
548 image_get_hdr_b(arch) /* image_get_arch */
549 image_get_hdr_b(type) /* image_get_type */
550 image_get_hdr_b(comp) /* image_get_comp */
552 static inline char *image_get_name(const image_header_t *hdr)
554 return (char *)hdr->ih_name;
557 static inline uint32_t image_get_data_size(const image_header_t *hdr)
559 return image_get_size(hdr);
563 * image_get_data - get image payload start address
566 * image_get_data() returns address of the image payload. For single
567 * component images it is image data start. For multi component
568 * images it points to the null terminated table of sub-images sizes.
571 * image payload data start address
573 static inline ulong image_get_data(const image_header_t *hdr)
575 return ((ulong)hdr + image_get_header_size());
578 static inline uint32_t image_get_image_size(const image_header_t *hdr)
580 return (image_get_size(hdr) + image_get_header_size());
582 static inline ulong image_get_image_end(const image_header_t *hdr)
584 return ((ulong)hdr + image_get_image_size(hdr));
587 #define image_set_hdr_l(f) \
588 static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
590 hdr->ih_##f = cpu_to_uimage(val); \
592 image_set_hdr_l(magic) /* image_set_magic */
593 image_set_hdr_l(hcrc) /* image_set_hcrc */
594 image_set_hdr_l(time) /* image_set_time */
595 image_set_hdr_l(size) /* image_set_size */
596 image_set_hdr_l(load) /* image_set_load */
597 image_set_hdr_l(ep) /* image_set_ep */
598 image_set_hdr_l(dcrc) /* image_set_dcrc */
600 #define image_set_hdr_b(f) \
601 static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
605 image_set_hdr_b(os) /* image_set_os */
606 image_set_hdr_b(arch) /* image_set_arch */
607 image_set_hdr_b(type) /* image_set_type */
608 image_set_hdr_b(comp) /* image_set_comp */
610 static inline void image_set_name(image_header_t *hdr, const char *name)
612 strncpy(image_get_name(hdr), name, IH_NMLEN);
615 int image_check_hcrc(const image_header_t *hdr);
616 int image_check_dcrc(const image_header_t *hdr);
618 ulong getenv_bootm_low(void);
619 phys_size_t getenv_bootm_size(void);
620 phys_size_t getenv_bootm_mapsize(void);
622 void memmove_wd(void *to, void *from, size_t len, ulong chunksz);
624 static inline int image_check_magic(const image_header_t *hdr)
626 return (image_get_magic(hdr) == IH_MAGIC);
628 static inline int image_check_type(const image_header_t *hdr, uint8_t type)
630 return (image_get_type(hdr) == type);
632 static inline int image_check_arch(const image_header_t *hdr, uint8_t arch)
634 return (image_get_arch(hdr) == arch);
636 static inline int image_check_os(const image_header_t *hdr, uint8_t os)
638 return (image_get_os(hdr) == os);
641 ulong image_multi_count(const image_header_t *hdr);
642 void image_multi_getimg(const image_header_t *hdr, ulong idx,
643 ulong *data, ulong *len);
645 void image_print_contents(const void *hdr);
648 static inline int image_check_target_arch(const image_header_t *hdr)
650 #ifndef IH_ARCH_DEFAULT
651 # error "please define IH_ARCH_DEFAULT in your arch asm/u-boot.h"
653 return image_check_arch(hdr, IH_ARCH_DEFAULT);
655 #endif /* USE_HOSTCC */
658 * Set up properties in the FDT
660 * This sets up properties in the FDT that is to be passed to linux.
662 * @images: Images information
663 * @blob: FDT to update
664 * @of_size: Size of the FDT
665 * @lmb: Points to logical memory block structure
666 * @return 0 if ok, <0 on failure
668 int image_setup_libfdt(bootm_headers_t *images, void *blob,
669 int of_size, struct lmb *lmb);
672 * Set up the FDT to use for booting a kernel
674 * This performs ramdisk setup, sets up the FDT if required, and adds
675 * paramters to the FDT if libfdt is available.
677 * @param images Images information
678 * @return 0 if ok, <0 on failure
680 int image_setup_linux(bootm_headers_t *images);
683 * bootz_setup() - Extract stat and size of a Linux xImage
685 * @image: Address of image
686 * @start: Returns start address of image
687 * @end : Returns end address of image
688 * @return 0 if OK, 1 if the image was not recognised
690 int bootz_setup(ulong image, ulong *start, ulong *end);
693 /*******************************************************************/
694 /* New uImage format specific code (prefixed with fit_) */
695 /*******************************************************************/
696 #if defined(CONFIG_FIT)
698 #define FIT_IMAGES_PATH "/images"
699 #define FIT_CONFS_PATH "/configurations"
701 /* hash/signature node */
702 #define FIT_HASH_NODENAME "hash"
703 #define FIT_ALGO_PROP "algo"
704 #define FIT_VALUE_PROP "value"
705 #define FIT_IGNORE_PROP "uboot-ignore"
706 #define FIT_SIG_NODENAME "signature"
709 #define FIT_DATA_PROP "data"
710 #define FIT_TIMESTAMP_PROP "timestamp"
711 #define FIT_DESC_PROP "description"
712 #define FIT_ARCH_PROP "arch"
713 #define FIT_TYPE_PROP "type"
714 #define FIT_OS_PROP "os"
715 #define FIT_COMP_PROP "compression"
716 #define FIT_ENTRY_PROP "entry"
717 #define FIT_LOAD_PROP "load"
719 /* configuration node */
720 #define FIT_KERNEL_PROP "kernel"
721 #define FIT_RAMDISK_PROP "ramdisk"
722 #define FIT_FDT_PROP "fdt"
723 #define FIT_DEFAULT_PROP "default"
725 #define FIT_MAX_HASH_LEN HASH_MAX_DIGEST_SIZE
727 /* cmdline argument format parsing */
728 int fit_parse_conf(const char *spec, ulong addr_curr,
729 ulong *addr, const char **conf_name);
730 int fit_parse_subimage(const char *spec, ulong addr_curr,
731 ulong *addr, const char **image_name);
733 void fit_print_contents(const void *fit);
734 void fit_image_print(const void *fit, int noffset, const char *p);
737 * fit_get_end - get FIT image size
738 * @fit: pointer to the FIT format image header
741 * size of the FIT image (blob) in memory
743 static inline ulong fit_get_size(const void *fit)
745 return fdt_totalsize(fit);
749 * fit_get_end - get FIT image end
750 * @fit: pointer to the FIT format image header
753 * end address of the FIT image (blob) in memory
755 static inline ulong fit_get_end(const void *fit)
757 return (ulong)fit + fdt_totalsize(fit);
761 * fit_get_name - get FIT node name
762 * @fit: pointer to the FIT format image header
766 * pointer to node name, on success
768 static inline const char *fit_get_name(const void *fit_hdr,
769 int noffset, int *len)
771 return fdt_get_name(fit_hdr, noffset, len);
774 int fit_get_desc(const void *fit, int noffset, char **desc);
775 int fit_get_timestamp(const void *fit, int noffset, time_t *timestamp);
777 int fit_image_get_node(const void *fit, const char *image_uname);
778 int fit_image_get_os(const void *fit, int noffset, uint8_t *os);
779 int fit_image_get_arch(const void *fit, int noffset, uint8_t *arch);
780 int fit_image_get_type(const void *fit, int noffset, uint8_t *type);
781 int fit_image_get_comp(const void *fit, int noffset, uint8_t *comp);
782 int fit_image_get_load(const void *fit, int noffset, ulong *load);
783 int fit_image_get_entry(const void *fit, int noffset, ulong *entry);
784 int fit_image_get_data(const void *fit, int noffset,
785 const void **data, size_t *size);
787 int fit_image_hash_get_algo(const void *fit, int noffset, char **algo);
788 int fit_image_hash_get_value(const void *fit, int noffset, uint8_t **value,
791 int fit_set_timestamp(void *fit, int noffset, time_t timestamp);
794 * fit_add_verification_data() - add verification data to FIT image nodes
796 * @keydir: Directory containing keys
797 * @kwydest: FDT blob to write public key information to
798 * @fit: Pointer to the FIT format image header
799 * @comment: Comment to add to signature nodes
800 * @require_keys: Mark all keys as 'required'
802 * Adds hash values for all component images in the FIT blob.
803 * Hashes are calculated for all component images which have hash subnodes
804 * with algorithm property set to one of the supported hash algorithms.
806 * Also add signatures if signature nodes are present.
810 * libfdt error code, on failure
812 int fit_add_verification_data(const char *keydir, void *keydest, void *fit,
813 const char *comment, int require_keys);
815 int fit_image_verify(const void *fit, int noffset);
816 int fit_config_verify(const void *fit, int conf_noffset);
817 int fit_all_image_verify(const void *fit);
818 int fit_image_check_os(const void *fit, int noffset, uint8_t os);
819 int fit_image_check_arch(const void *fit, int noffset, uint8_t arch);
820 int fit_image_check_type(const void *fit, int noffset, uint8_t type);
821 int fit_image_check_comp(const void *fit, int noffset, uint8_t comp);
822 int fit_check_format(const void *fit);
824 int fit_conf_find_compat(const void *fit, const void *fdt);
825 int fit_conf_get_node(const void *fit, const char *conf_uname);
828 * fit_conf_get_prop_node() - Get node refered to by a configuration
830 * @noffset: Offset of conf@xxx node to check
831 * @prop_name: Property to read from the conf node
833 * The conf@ nodes contain references to other nodes, using properties
834 * like 'kernel = "kernel@1"'. Given such a property name (e.g. "kernel"),
835 * return the offset of the node referred to (e.g. offset of node
836 * "/images/kernel@1".
838 int fit_conf_get_prop_node(const void *fit, int noffset,
839 const char *prop_name);
841 void fit_conf_print(const void *fit, int noffset, const char *p);
843 int fit_check_ramdisk(const void *fit, int os_noffset,
844 uint8_t arch, int verify);
846 int calculate_hash(const void *data, int data_len, const char *algo,
847 uint8_t *value, int *value_len);
850 * At present we only support signing on the host, and verification on the
853 #if defined(CONFIG_FIT_SIGNATURE)
855 # define IMAGE_ENABLE_SIGN 1
856 # define IMAGE_ENABLE_VERIFY 1
857 # include <openssl/evp.h>
859 # define IMAGE_ENABLE_SIGN 0
860 # define IMAGE_ENABLE_VERIFY 1
863 # define IMAGE_ENABLE_SIGN 0
864 # define IMAGE_ENABLE_VERIFY 0
868 void *image_get_host_blob(void);
869 void image_set_host_blob(void *host_blob);
870 # define gd_fdt_blob() image_get_host_blob()
872 # define gd_fdt_blob() (gd->fdt_blob)
875 #ifdef CONFIG_FIT_BEST_MATCH
876 #define IMAGE_ENABLE_BEST_MATCH 1
878 #define IMAGE_ENABLE_BEST_MATCH 0
881 /* Information passed to the signing routines */
882 struct image_sign_info {
883 const char *keydir; /* Directory conaining keys */
884 const char *keyname; /* Name of key to use */
885 void *fit; /* Pointer to FIT blob */
886 int node_offset; /* Offset of signature node */
887 struct image_sig_algo *algo; /* Algorithm information */
888 const void *fdt_blob; /* FDT containing public keys */
889 int required_keynode; /* Node offset of key to use: -1=any */
890 const char *require_keys; /* Value for 'required' property */
893 /* A part of an image, used for hashing */
894 struct image_region {
899 #if IMAGE_ENABLE_VERIFY
900 # include <u-boot/rsa-checksum.h>
902 struct checksum_algo {
904 const int checksum_len;
906 #if IMAGE_ENABLE_SIGN
907 const EVP_MD *(*calculate_sign)(void);
909 void (*calculate)(const struct image_region region[],
910 int region_count, uint8_t *checksum);
911 const uint8_t *rsa_padding;
914 struct image_sig_algo {
915 const char *name; /* Name of algorithm */
918 * sign() - calculate and return signature for given input data
920 * @info: Specifies key and FIT information
921 * @data: Pointer to the input data
922 * @data_len: Data length
923 * @sigp: Set to an allocated buffer holding the signature
924 * @sig_len: Set to length of the calculated hash
926 * This computes input data signature according to selected algorithm.
927 * Resulting signature value is placed in an allocated buffer, the
928 * pointer is returned as *sigp. The length of the calculated
929 * signature is returned via the sig_len pointer argument. The caller
932 * @return: 0, on success, -ve on error
934 int (*sign)(struct image_sign_info *info,
935 const struct image_region region[],
936 int region_count, uint8_t **sigp, uint *sig_len);
939 * add_verify_data() - Add verification information to FDT
941 * Add public key information to the FDT node, suitable for
942 * verification at run-time. The information added depends on the
943 * algorithm being used.
945 * @info: Specifies key and FIT information
946 * @keydest: Destination FDT blob for public key data
947 * @return: 0, on success, -ve on error
949 int (*add_verify_data)(struct image_sign_info *info, void *keydest);
952 * verify() - Verify a signature against some data
954 * @info: Specifies key and FIT information
955 * @data: Pointer to the input data
956 * @data_len: Data length
958 * @sig_len: Number of bytes in signature
959 * @return 0 if verified, -ve on error
961 int (*verify)(struct image_sign_info *info,
962 const struct image_region region[], int region_count,
963 uint8_t *sig, uint sig_len);
965 /* pointer to checksum algorithm */
966 struct checksum_algo *checksum;
970 * image_get_sig_algo() - Look up a signature algortihm
972 * @param name Name of algorithm
973 * @return pointer to algorithm information, or NULL if not found
975 struct image_sig_algo *image_get_sig_algo(const char *name);
978 * fit_image_verify_required_sigs() - Verify signatures marked as 'required'
981 * @image_noffset: Offset of image node to check
982 * @data: Image data to check
983 * @size: Size of image data
984 * @sig_blob: FDT containing public keys
985 * @no_sigsp: Returns 1 if no signatures were required, and
986 * therefore nothing was checked. The caller may wish
987 * to fall back to other mechanisms, or refuse to
989 * @return 0 if all verified ok, <0 on error
991 int fit_image_verify_required_sigs(const void *fit, int image_noffset,
992 const char *data, size_t size, const void *sig_blob,
996 * fit_image_check_sig() - Check a single image signature node
999 * @noffset: Offset of signature node to check
1000 * @data: Image data to check
1001 * @size: Size of image data
1002 * @required_keynode: Offset in the control FDT of the required key node,
1003 * if any. If this is given, then the image wil not
1004 * pass verification unless that key is used. If this is
1005 * -1 then any signature will do.
1006 * @err_msgp: In the event of an error, this will be pointed to a
1007 * help error string to display to the user.
1008 * @return 0 if all verified ok, <0 on error
1010 int fit_image_check_sig(const void *fit, int noffset, const void *data,
1011 size_t size, int required_keynode, char **err_msgp);
1014 * fit_region_make_list() - Make a list of regions to hash
1016 * Given a list of FIT regions (offset, size) provided by libfdt, create
1017 * a list of regions (void *, size) for use by the signature creationg
1018 * and verification code.
1020 * @fit: FIT image to process
1021 * @fdt_regions: Regions as returned by libfdt
1022 * @count: Number of regions returned by libfdt
1023 * @region: Place to put list of regions (NULL to allocate it)
1024 * @return pointer to list of regions, or NULL if out of memory
1026 struct image_region *fit_region_make_list(const void *fit,
1027 struct fdt_region *fdt_regions, int count,
1028 struct image_region *region);
1030 static inline int fit_image_check_target_arch(const void *fdt, int node)
1033 return fit_image_check_arch(fdt, node, IH_ARCH_DEFAULT);
1039 #ifdef CONFIG_FIT_VERBOSE
1040 #define fit_unsupported(msg) printf("! %s:%d " \
1041 "FIT images not supported for '%s'\n", \
1042 __FILE__, __LINE__, (msg))
1044 #define fit_unsupported_reset(msg) printf("! %s:%d " \
1045 "FIT images not supported for '%s' " \
1046 "- must reset board to recover!\n", \
1047 __FILE__, __LINE__, (msg))
1049 #define fit_unsupported(msg)
1050 #define fit_unsupported_reset(msg)
1051 #endif /* CONFIG_FIT_VERBOSE */
1052 #endif /* CONFIG_FIT */
1054 #if defined(CONFIG_ANDROID_BOOT_IMAGE)
1055 struct andr_img_hdr;
1056 int android_image_check_header(const struct andr_img_hdr *hdr);
1057 int android_image_get_kernel(const struct andr_img_hdr *hdr, int verify,
1058 ulong *os_data, ulong *os_len);
1059 int android_image_get_ramdisk(const struct andr_img_hdr *hdr,
1060 ulong *rd_data, ulong *rd_len);
1061 ulong android_image_get_end(const struct andr_img_hdr *hdr);
1062 ulong android_image_get_kload(const struct andr_img_hdr *hdr);
1064 #endif /* CONFIG_ANDROID_BOOT_IMAGE */
1066 #endif /* __IMAGE_H__ */