2 * (C) Copyright 2008 Semihalf
4 * (C) Copyright 2000-2005
5 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
7 * SPDX-License-Identifier: GPL-2.0+
8 ********************************************************************
9 * NOTE: This header file defines an interface to U-Boot. Including
10 * this (unmodified) header file in another file is considered normal
11 * use of U-Boot, and does *not* fall under the heading of "derived
13 ********************************************************************
20 #include <asm/byteorder.h>
22 /* Define this to avoid #ifdefs later on */
26 #include <sys/types.h>
28 /* new uImage format support enabled on host */
29 #define IMAGE_ENABLE_FIT 1
30 #define IMAGE_ENABLE_OF_LIBFDT 1
31 #define CONFIG_FIT_VERBOSE 1 /* enable fit_format_{error,warning}() */
32 #define CONFIG_FIT_ENABLE_SHA256_SUPPORT
34 #define IMAGE_ENABLE_IGNORE 0
35 #define IMAGE_INDENT_STRING ""
40 #include <asm/u-boot.h>
43 /* Take notice of the 'ignore' property for hashes */
44 #define IMAGE_ENABLE_IGNORE 1
45 #define IMAGE_INDENT_STRING " "
47 #define IMAGE_ENABLE_FIT CONFIG_IS_ENABLED(FIT)
48 #define IMAGE_ENABLE_OF_LIBFDT CONFIG_IS_ENABLED(OF_LIBFDT)
50 #endif /* USE_HOSTCC */
55 #include <fdt_support.h>
56 # ifdef CONFIG_SPL_BUILD
57 # ifdef CONFIG_SPL_CRC32_SUPPORT
58 # define IMAGE_ENABLE_CRC32 1
60 # ifdef CONFIG_SPL_MD5_SUPPORT
61 # define IMAGE_ENABLE_MD5 1
63 # ifdef CONFIG_SPL_SHA1_SUPPORT
64 # define IMAGE_ENABLE_SHA1 1
67 # define CONFIG_CRC32 /* FIT images need CRC32 support */
68 # define CONFIG_SHA1 /* and SHA1 */
69 # define CONFIG_SHA256 /* and SHA256 */
70 # define IMAGE_ENABLE_CRC32 1
71 # define IMAGE_ENABLE_MD5 1
72 # define IMAGE_ENABLE_SHA1 1
75 #ifndef IMAGE_ENABLE_CRC32
76 #define IMAGE_ENABLE_CRC32 0
79 #ifndef IMAGE_ENABLE_MD5
80 #define IMAGE_ENABLE_MD5 0
83 #ifndef IMAGE_ENABLE_SHA1
84 #define IMAGE_ENABLE_SHA1 0
87 #if defined(CONFIG_FIT_ENABLE_SHA256_SUPPORT) || \
88 defined(CONFIG_SPL_SHA256_SUPPORT)
90 #define IMAGE_ENABLE_SHA256 1
92 #define IMAGE_ENABLE_SHA256 0
95 #endif /* IMAGE_ENABLE_FIT */
97 #ifdef CONFIG_SYS_BOOT_GET_CMDLINE
98 # define IMAGE_BOOT_GET_CMDLINE 1
100 # define IMAGE_BOOT_GET_CMDLINE 0
103 #ifdef CONFIG_OF_BOARD_SETUP
104 # define IMAGE_OF_BOARD_SETUP 1
106 # define IMAGE_OF_BOARD_SETUP 0
109 #ifdef CONFIG_OF_SYSTEM_SETUP
110 # define IMAGE_OF_SYSTEM_SETUP 1
112 # define IMAGE_OF_SYSTEM_SETUP 0
125 * Operating System Codes
127 * The following are exposed to uImage header.
128 * Do not change values for backward compatibility.
131 IH_OS_INVALID
= 0, /* Invalid OS */
132 IH_OS_OPENBSD
, /* OpenBSD */
133 IH_OS_NETBSD
, /* NetBSD */
134 IH_OS_FREEBSD
, /* FreeBSD */
135 IH_OS_4_4BSD
, /* 4.4BSD */
136 IH_OS_LINUX
, /* Linux */
137 IH_OS_SVR4
, /* SVR4 */
138 IH_OS_ESIX
, /* Esix */
139 IH_OS_SOLARIS
, /* Solaris */
140 IH_OS_IRIX
, /* Irix */
142 IH_OS_DELL
, /* Dell */
144 IH_OS_LYNXOS
, /* LynxOS */
145 IH_OS_VXWORKS
, /* VxWorks */
146 IH_OS_PSOS
, /* pSOS */
148 IH_OS_U_BOOT
, /* Firmware */
149 IH_OS_RTEMS
, /* RTEMS */
150 IH_OS_ARTOS
, /* ARTOS */
151 IH_OS_UNITY
, /* Unity OS */
152 IH_OS_INTEGRITY
, /* INTEGRITY */
154 IH_OS_PLAN9
, /* Plan 9 */
155 IH_OS_OPENRTOS
, /* OpenRTOS */
161 * CPU Architecture Codes (supported by Linux)
163 * The following are exposed to uImage header.
164 * Do not change values for backward compatibility.
167 IH_ARCH_INVALID
= 0, /* Invalid CPU */
168 IH_ARCH_ALPHA
, /* Alpha */
169 IH_ARCH_ARM
, /* ARM */
170 IH_ARCH_I386
, /* Intel x86 */
171 IH_ARCH_IA64
, /* IA64 */
172 IH_ARCH_MIPS
, /* MIPS */
173 IH_ARCH_MIPS64
, /* MIPS 64 Bit */
174 IH_ARCH_PPC
, /* PowerPC */
175 IH_ARCH_S390
, /* IBM S390 */
176 IH_ARCH_SH
, /* SuperH */
177 IH_ARCH_SPARC
, /* Sparc */
178 IH_ARCH_SPARC64
, /* Sparc 64 Bit */
179 IH_ARCH_M68K
, /* M68K */
180 IH_ARCH_NIOS
, /* Nios-32 */
181 IH_ARCH_MICROBLAZE
, /* MicroBlaze */
182 IH_ARCH_NIOS2
, /* Nios-II */
183 IH_ARCH_BLACKFIN
, /* Blackfin */
184 IH_ARCH_AVR32
, /* AVR32 */
185 IH_ARCH_ST200
, /* STMicroelectronics ST200 */
186 IH_ARCH_SANDBOX
, /* Sandbox architecture (test only) */
187 IH_ARCH_NDS32
, /* ANDES Technology - NDS32 */
188 IH_ARCH_OPENRISC
, /* OpenRISC 1000 */
189 IH_ARCH_ARM64
, /* ARM64 */
190 IH_ARCH_ARC
, /* Synopsys DesignWare ARC */
191 IH_ARCH_X86_64
, /* AMD x86_64, Intel and Via */
192 IH_ARCH_XTENSA
, /* Xtensa */
200 * "Standalone Programs" are directly runnable in the environment
201 * provided by U-Boot; it is expected that (if they behave
202 * well) you can continue to work in U-Boot after return from
203 * the Standalone Program.
204 * "OS Kernel Images" are usually images of some Embedded OS which
205 * will take over control completely. Usually these programs
206 * will install their own set of exception handlers, device
207 * drivers, set up the MMU, etc. - this means, that you cannot
208 * expect to re-enter U-Boot except by resetting the CPU.
209 * "RAMDisk Images" are more or less just data blocks, and their
210 * parameters (address, size) are passed to an OS kernel that is
212 * "Multi-File Images" contain several images, typically an OS
213 * (Linux) kernel image and one or more data images like
214 * RAMDisks. This construct is useful for instance when you want
215 * to boot over the network using BOOTP etc., where the boot
216 * server provides just a single image file, but you want to get
217 * for instance an OS kernel and a RAMDisk image.
219 * "Multi-File Images" start with a list of image sizes, each
220 * image size (in bytes) specified by an "uint32_t" in network
221 * byte order. This list is terminated by an "(uint32_t)0".
222 * Immediately after the terminating 0 follow the images, one by
223 * one, all aligned on "uint32_t" boundaries (size rounded up to
224 * a multiple of 4 bytes - except for the last file).
226 * "Firmware Images" are binary images containing firmware (like
227 * U-Boot or FPGA images) which usually will be programmed to
230 * "Script files" are command sequences that will be executed by
231 * U-Boot's command interpreter; this feature is especially
232 * useful when you configure U-Boot to use a real shell (hush)
233 * as command interpreter (=> Shell Scripts).
235 * The following are exposed to uImage header.
236 * Do not change values for backward compatibility.
240 IH_TYPE_INVALID
= 0, /* Invalid Image */
241 IH_TYPE_STANDALONE
, /* Standalone Program */
242 IH_TYPE_KERNEL
, /* OS Kernel Image */
243 IH_TYPE_RAMDISK
, /* RAMDisk Image */
244 IH_TYPE_MULTI
, /* Multi-File Image */
245 IH_TYPE_FIRMWARE
, /* Firmware Image */
246 IH_TYPE_SCRIPT
, /* Script file */
247 IH_TYPE_FILESYSTEM
, /* Filesystem Image (any type) */
248 IH_TYPE_FLATDT
, /* Binary Flat Device Tree Blob */
249 IH_TYPE_KWBIMAGE
, /* Kirkwood Boot Image */
250 IH_TYPE_IMXIMAGE
, /* Freescale IMXBoot Image */
251 IH_TYPE_UBLIMAGE
, /* Davinci UBL Image */
252 IH_TYPE_OMAPIMAGE
, /* TI OMAP Config Header Image */
253 IH_TYPE_AISIMAGE
, /* TI Davinci AIS Image */
254 /* OS Kernel Image, can run from any load address */
255 IH_TYPE_KERNEL_NOLOAD
,
256 IH_TYPE_PBLIMAGE
, /* Freescale PBL Boot Image */
257 IH_TYPE_MXSIMAGE
, /* Freescale MXSBoot Image */
258 IH_TYPE_GPIMAGE
, /* TI Keystone GPHeader Image */
259 IH_TYPE_ATMELIMAGE
, /* ATMEL ROM bootable Image */
260 IH_TYPE_SOCFPGAIMAGE
, /* Altera SOCFPGA Preloader */
261 IH_TYPE_X86_SETUP
, /* x86 setup.bin Image */
262 IH_TYPE_LPC32XXIMAGE
, /* x86 setup.bin Image */
263 IH_TYPE_LOADABLE
, /* A list of typeless images */
264 IH_TYPE_RKIMAGE
, /* Rockchip Boot Image */
265 IH_TYPE_RKSD
, /* Rockchip SD card */
266 IH_TYPE_RKSPI
, /* Rockchip SPI image */
267 IH_TYPE_ZYNQIMAGE
, /* Xilinx Zynq Boot Image */
268 IH_TYPE_ZYNQMPIMAGE
, /* Xilinx ZynqMP Boot Image */
269 IH_TYPE_FPGA
, /* FPGA Image */
270 IH_TYPE_VYBRIDIMAGE
, /* VYBRID .vyb Image */
271 IH_TYPE_TEE
, /* Trusted Execution Environment OS Image */
272 IH_TYPE_FIRMWARE_IVT
, /* Firmware Image with HABv4 IVT */
274 IH_TYPE_COUNT
, /* Number of image types */
280 * The following are exposed to uImage header.
281 * Do not change values for backward compatibility.
284 IH_COMP_NONE
= 0, /* No Compression Used */
285 IH_COMP_GZIP
, /* gzip Compression Used */
286 IH_COMP_BZIP2
, /* bzip2 Compression Used */
287 IH_COMP_LZMA
, /* lzma Compression Used */
288 IH_COMP_LZO
, /* lzo Compression Used */
289 IH_COMP_LZ4
, /* lz4 Compression Used */
294 #define IH_MAGIC 0x27051956 /* Image Magic Number */
295 #define IH_NMLEN 32 /* Image Name Length */
297 /* Reused from common.h */
298 #define ROUND(a, b) (((a) + (b) - 1) & ~((b) - 1))
301 * Legacy format image header,
302 * all data in network byte order (aka natural aka bigendian).
304 typedef struct image_header
{
305 __be32 ih_magic
; /* Image Header Magic Number */
306 __be32 ih_hcrc
; /* Image Header CRC Checksum */
307 __be32 ih_time
; /* Image Creation Timestamp */
308 __be32 ih_size
; /* Image Data Size */
309 __be32 ih_load
; /* Data Load Address */
310 __be32 ih_ep
; /* Entry Point Address */
311 __be32 ih_dcrc
; /* Image Data CRC Checksum */
312 uint8_t ih_os
; /* Operating System */
313 uint8_t ih_arch
; /* CPU architecture */
314 uint8_t ih_type
; /* Image Type */
315 uint8_t ih_comp
; /* Compression Type */
316 uint8_t ih_name
[IH_NMLEN
]; /* Image Name */
319 typedef struct image_info
{
320 ulong start
, end
; /* start/end of blob */
321 ulong image_start
, image_len
; /* start of image within blob, len of image */
322 ulong load
; /* load addr for the image */
323 uint8_t comp
, type
, os
; /* compression, type of image, os type */
324 uint8_t arch
; /* CPU architecture */
328 * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
331 typedef struct bootm_headers
{
333 * Legacy os image header, if it is a multi component image
334 * then boot_get_ramdisk() and get_fdt() will attempt to get
335 * data from second and third component accordingly.
337 image_header_t
*legacy_hdr_os
; /* image header pointer */
338 image_header_t legacy_hdr_os_copy
; /* header copy */
339 ulong legacy_hdr_valid
;
342 const char *fit_uname_cfg
; /* configuration node unit name */
344 void *fit_hdr_os
; /* os FIT image header */
345 const char *fit_uname_os
; /* os subimage node unit name */
346 int fit_noffset_os
; /* os subimage node offset */
348 void *fit_hdr_rd
; /* init ramdisk FIT image header */
349 const char *fit_uname_rd
; /* init ramdisk subimage node unit name */
350 int fit_noffset_rd
; /* init ramdisk subimage node offset */
352 void *fit_hdr_fdt
; /* FDT blob FIT image header */
353 const char *fit_uname_fdt
; /* FDT blob subimage node unit name */
354 int fit_noffset_fdt
;/* FDT blob subimage node offset */
356 void *fit_hdr_setup
; /* x86 setup FIT image header */
357 const char *fit_uname_setup
; /* x86 setup subimage node name */
358 int fit_noffset_setup
;/* x86 setup subimage node offset */
362 image_info_t os
; /* os image info */
363 ulong ep
; /* entry point of OS */
365 ulong rd_start
, rd_end
;/* ramdisk start/end */
367 char *ft_addr
; /* flat dev tree address */
368 ulong ft_len
; /* length of flat device tree */
377 int verify
; /* getenv("verify")[0] != 'n' */
379 #define BOOTM_STATE_START (0x00000001)
380 #define BOOTM_STATE_FINDOS (0x00000002)
381 #define BOOTM_STATE_FINDOTHER (0x00000004)
382 #define BOOTM_STATE_LOADOS (0x00000008)
383 #define BOOTM_STATE_RAMDISK (0x00000010)
384 #define BOOTM_STATE_FDT (0x00000020)
385 #define BOOTM_STATE_OS_CMDLINE (0x00000040)
386 #define BOOTM_STATE_OS_BD_T (0x00000080)
387 #define BOOTM_STATE_OS_PREP (0x00000100)
388 #define BOOTM_STATE_OS_FAKE_GO (0x00000200) /* 'Almost' run the OS */
389 #define BOOTM_STATE_OS_GO (0x00000400)
393 struct lmb lmb
; /* for memory mgmt */
397 extern bootm_headers_t images
;
400 * Some systems (for example LWMON) have very short watchdog periods;
401 * we must make sure to split long operations like memmove() or
402 * checksum calculations into reasonable chunks.
405 #define CHUNKSZ (64 * 1024)
408 #ifndef CHUNKSZ_CRC32
409 #define CHUNKSZ_CRC32 (64 * 1024)
413 #define CHUNKSZ_MD5 (64 * 1024)
417 #define CHUNKSZ_SHA1 (64 * 1024)
420 #define uimage_to_cpu(x) be32_to_cpu(x)
421 #define cpu_to_uimage(x) cpu_to_be32(x)
424 * Translation table for entries of a specific type; used by
425 * get_table_entry_id() and get_table_entry_name().
427 typedef struct table_entry
{
429 char *sname
; /* short (input) name to find table entry */
430 char *lname
; /* long (output) name to print for messages */
434 * get_table_entry_id() scans the translation table trying to find an
435 * entry that matches the given short name. If a matching entry is
436 * found, it's id is returned to the caller.
438 int get_table_entry_id(const table_entry_t
*table
,
439 const char *table_name
, const char *name
);
441 * get_table_entry_name() scans the translation table trying to find
442 * an entry that matches the given id. If a matching entry is found,
443 * its long name is returned to the caller.
445 char *get_table_entry_name(const table_entry_t
*table
, char *msg
, int id
);
447 const char *genimg_get_os_name(uint8_t os
);
450 * genimg_get_os_short_name() - get the short name for an OS
452 * @param os OS (IH_OS_...)
453 * @return OS short name, or "unknown" if unknown
455 const char *genimg_get_os_short_name(uint8_t comp
);
457 const char *genimg_get_arch_name(uint8_t arch
);
460 * genimg_get_arch_short_name() - get the short name for an architecture
462 * @param arch Architecture type (IH_ARCH_...)
463 * @return architecture short name, or "unknown" if unknown
465 const char *genimg_get_arch_short_name(uint8_t arch
);
467 const char *genimg_get_type_name(uint8_t type
);
470 * genimg_get_type_short_name() - get the short name for an image type
472 * @param type Image type (IH_TYPE_...)
473 * @return image short name, or "unknown" if unknown
475 const char *genimg_get_type_short_name(uint8_t type
);
477 const char *genimg_get_comp_name(uint8_t comp
);
480 * genimg_get_comp_short_name() - get the short name for a compression method
482 * @param comp compression method (IH_COMP_...)
483 * @return compression method short name, or "unknown" if unknown
485 const char *genimg_get_comp_short_name(uint8_t comp
);
488 * genimg_get_cat_name() - Get the name of an item in a category
490 * @category: Category of item
492 * @return name of item, or "Unknown ..." if unknown
494 const char *genimg_get_cat_name(enum ih_category category
, uint id
);
497 * genimg_get_cat_short_name() - Get the short name of an item in a category
499 * @category: Category of item
501 * @return short name of item, or "Unknown ..." if unknown
503 const char *genimg_get_cat_short_name(enum ih_category category
, uint id
);
506 * genimg_get_cat_count() - Get the number of items in a category
508 * @category: Category to check
509 * @return the number of items in the category (IH_xxx_COUNT)
511 int genimg_get_cat_count(enum ih_category category
);
514 * genimg_get_cat_desc() - Get the description of a category
516 * @return the description of a category, e.g. "architecture". This
517 * effectively converts the enum to a string.
519 const char *genimg_get_cat_desc(enum ih_category category
);
521 int genimg_get_os_id(const char *name
);
522 int genimg_get_arch_id(const char *name
);
523 int genimg_get_type_id(const char *name
);
524 int genimg_get_comp_id(const char *name
);
525 void genimg_print_size(uint32_t size
);
527 #if defined(CONFIG_TIMESTAMP) || defined(CONFIG_CMD_DATE) || \
529 #define IMAGE_ENABLE_TIMESTAMP 1
531 #define IMAGE_ENABLE_TIMESTAMP 0
533 void genimg_print_time(time_t timestamp
);
535 /* What to do with a image load address ('load = <> 'in the FIT) */
537 FIT_LOAD_IGNORED
, /* Ignore load address */
538 FIT_LOAD_OPTIONAL
, /* Can be provided, but optional */
539 FIT_LOAD_OPTIONAL_NON_ZERO
, /* Optional, a value of 0 is ignored */
540 FIT_LOAD_REQUIRED
, /* Must be provided */
543 int boot_get_setup(bootm_headers_t
*images
, uint8_t arch
, ulong
*setup_start
,
547 /* Image format types, returned by _get_format() routine */
548 #define IMAGE_FORMAT_INVALID 0x00
549 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
550 #define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */
552 #define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */
553 #define IMAGE_FORMAT_ANDROID 0x03 /* Android boot image */
555 ulong
genimg_get_kernel_addr_fit(char * const img_addr
,
556 const char **fit_uname_config
,
557 const char **fit_uname_kernel
);
558 ulong
genimg_get_kernel_addr(char * const img_addr
);
559 int genimg_get_format(const void *img_addr
);
560 int genimg_has_config(bootm_headers_t
*images
);
561 ulong
genimg_get_image(ulong img_addr
);
563 int boot_get_fpga(int argc
, char * const argv
[], bootm_headers_t
*images
,
564 uint8_t arch
, const ulong
*ld_start
, ulong
* const ld_len
);
565 int boot_get_ramdisk(int argc
, char * const argv
[], bootm_headers_t
*images
,
566 uint8_t arch
, ulong
*rd_start
, ulong
*rd_end
);
569 * boot_get_loadable - routine to load a list of binaries to memory
570 * @argc: Ignored Argument
571 * @argv: Ignored Argument
572 * @images: pointer to the bootm images structure
573 * @arch: expected architecture for the image
574 * @ld_start: Ignored Argument
575 * @ld_len: Ignored Argument
577 * boot_get_loadable() will take the given FIT configuration, and look
578 * for a field named "loadables". Loadables, is a list of elements in
579 * the FIT given as strings. exe:
580 * loadables = "linux_kernel@1", "fdt@2";
581 * this function will attempt to parse each string, and load the
582 * corresponding element from the FIT into memory. Once placed,
583 * no aditional actions are taken.
586 * 0, if only valid images or no images are found
587 * error code, if an error occurs during fit_image_load
589 int boot_get_loadable(int argc
, char * const argv
[], bootm_headers_t
*images
,
590 uint8_t arch
, const ulong
*ld_start
, ulong
* const ld_len
);
591 #endif /* !USE_HOSTCC */
593 int boot_get_setup_fit(bootm_headers_t
*images
, uint8_t arch
,
594 ulong
*setup_start
, ulong
*setup_len
);
597 * fit_image_load() - load an image from a FIT
599 * This deals with all aspects of loading an image from a FIT, including
600 * selecting the right image based on configuration, verifying it, printing
601 * out progress messages, checking the type/arch/os and optionally copying it
602 * to the right load address.
604 * The property to look up is defined by image_type.
606 * @param images Boot images structure
607 * @param addr Address of FIT in memory
608 * @param fit_unamep On entry this is the requested image name
609 * (e.g. "kernel@1") or NULL to use the default. On exit
610 * points to the selected image name
611 * @param fit_uname_configp On entry this is the requested configuration
612 * name (e.g. "conf@1") or NULL to use the default. On
613 * exit points to the selected configuration name.
614 * @param arch Expected architecture (IH_ARCH_...)
615 * @param image_type Required image type (IH_TYPE_...). If this is
616 * IH_TYPE_KERNEL then we allow IH_TYPE_KERNEL_NOLOAD
618 * @param bootstage_id ID of starting bootstage to use for progress updates.
619 * This will be added to the BOOTSTAGE_SUB values when
620 * calling bootstage_mark()
621 * @param load_op Decribes what to do with the load address
622 * @param datap Returns address of loaded image
623 * @param lenp Returns length of loaded image
624 * @return node offset of image, or -ve error code on error
626 int fit_image_load(bootm_headers_t
*images
, ulong addr
,
627 const char **fit_unamep
, const char **fit_uname_configp
,
628 int arch
, int image_type
, int bootstage_id
,
629 enum fit_load_op load_op
, ulong
*datap
, ulong
*lenp
);
633 * fit_get_node_from_config() - Look up an image a FIT by type
635 * This looks in the selected conf@ node (images->fit_uname_cfg) for a
636 * particular image type (e.g. "kernel") and then finds the image that is
639 * For example, for something like:
648 * kernel = "kernel@1";
652 * the function will return the node offset of the kernel@1 node, assuming
653 * that conf@1 is the chosen configuration.
655 * @param images Boot images structure
656 * @param prop_name Property name to look up (FIT_..._PROP)
657 * @param addr Address of FIT in memory
659 int fit_get_node_from_config(bootm_headers_t
*images
, const char *prop_name
,
662 int boot_get_fdt(int flag
, int argc
, char * const argv
[], uint8_t arch
,
663 bootm_headers_t
*images
,
664 char **of_flat_tree
, ulong
*of_size
);
665 void boot_fdt_add_mem_rsv_regions(struct lmb
*lmb
, void *fdt_blob
);
666 int boot_relocate_fdt(struct lmb
*lmb
, char **of_flat_tree
, ulong
*of_size
);
668 int boot_ramdisk_high(struct lmb
*lmb
, ulong rd_data
, ulong rd_len
,
669 ulong
*initrd_start
, ulong
*initrd_end
);
670 int boot_get_cmdline(struct lmb
*lmb
, ulong
*cmd_start
, ulong
*cmd_end
);
671 #ifdef CONFIG_SYS_BOOT_GET_KBD
672 int boot_get_kbd(struct lmb
*lmb
, bd_t
**kbd
);
673 #endif /* CONFIG_SYS_BOOT_GET_KBD */
674 #endif /* !USE_HOSTCC */
676 /*******************************************************************/
677 /* Legacy format specific code (prefixed with image_) */
678 /*******************************************************************/
679 static inline uint32_t image_get_header_size(void)
681 return (sizeof(image_header_t
));
684 #define image_get_hdr_l(f) \
685 static inline uint32_t image_get_##f(const image_header_t *hdr) \
687 return uimage_to_cpu(hdr->ih_##f); \
689 image_get_hdr_l(magic
) /* image_get_magic */
690 image_get_hdr_l(hcrc
) /* image_get_hcrc */
691 image_get_hdr_l(time
) /* image_get_time */
692 image_get_hdr_l(size
) /* image_get_size */
693 image_get_hdr_l(load
) /* image_get_load */
694 image_get_hdr_l(ep
) /* image_get_ep */
695 image_get_hdr_l(dcrc
) /* image_get_dcrc */
697 #define image_get_hdr_b(f) \
698 static inline uint8_t image_get_##f(const image_header_t *hdr) \
700 return hdr->ih_##f; \
702 image_get_hdr_b(os
) /* image_get_os */
703 image_get_hdr_b(arch
) /* image_get_arch */
704 image_get_hdr_b(type
) /* image_get_type */
705 image_get_hdr_b(comp
) /* image_get_comp */
707 static inline char *image_get_name(const image_header_t
*hdr
)
709 return (char *)hdr
->ih_name
;
712 static inline uint32_t image_get_data_size(const image_header_t
*hdr
)
714 return image_get_size(hdr
);
718 * image_get_data - get image payload start address
721 * image_get_data() returns address of the image payload. For single
722 * component images it is image data start. For multi component
723 * images it points to the null terminated table of sub-images sizes.
726 * image payload data start address
728 static inline ulong
image_get_data(const image_header_t
*hdr
)
730 return ((ulong
)hdr
+ image_get_header_size());
733 static inline uint32_t image_get_image_size(const image_header_t
*hdr
)
735 return (image_get_size(hdr
) + image_get_header_size());
737 static inline ulong
image_get_image_end(const image_header_t
*hdr
)
739 return ((ulong
)hdr
+ image_get_image_size(hdr
));
742 #define image_set_hdr_l(f) \
743 static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
745 hdr->ih_##f = cpu_to_uimage(val); \
747 image_set_hdr_l(magic
) /* image_set_magic */
748 image_set_hdr_l(hcrc
) /* image_set_hcrc */
749 image_set_hdr_l(time
) /* image_set_time */
750 image_set_hdr_l(size
) /* image_set_size */
751 image_set_hdr_l(load
) /* image_set_load */
752 image_set_hdr_l(ep
) /* image_set_ep */
753 image_set_hdr_l(dcrc
) /* image_set_dcrc */
755 #define image_set_hdr_b(f) \
756 static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
760 image_set_hdr_b(os
) /* image_set_os */
761 image_set_hdr_b(arch
) /* image_set_arch */
762 image_set_hdr_b(type
) /* image_set_type */
763 image_set_hdr_b(comp
) /* image_set_comp */
765 static inline void image_set_name(image_header_t
*hdr
, const char *name
)
767 strncpy(image_get_name(hdr
), name
, IH_NMLEN
);
770 int image_check_hcrc(const image_header_t
*hdr
);
771 int image_check_dcrc(const image_header_t
*hdr
);
773 ulong
getenv_bootm_low(void);
774 phys_size_t
getenv_bootm_size(void);
775 phys_size_t
getenv_bootm_mapsize(void);
777 void memmove_wd(void *to
, void *from
, size_t len
, ulong chunksz
);
779 static inline int image_check_magic(const image_header_t
*hdr
)
781 return (image_get_magic(hdr
) == IH_MAGIC
);
783 static inline int image_check_type(const image_header_t
*hdr
, uint8_t type
)
785 return (image_get_type(hdr
) == type
);
787 static inline int image_check_arch(const image_header_t
*hdr
, uint8_t arch
)
789 return (image_get_arch(hdr
) == arch
);
791 static inline int image_check_os(const image_header_t
*hdr
, uint8_t os
)
793 return (image_get_os(hdr
) == os
);
796 ulong
image_multi_count(const image_header_t
*hdr
);
797 void image_multi_getimg(const image_header_t
*hdr
, ulong idx
,
798 ulong
*data
, ulong
*len
);
800 void image_print_contents(const void *hdr
);
803 static inline int image_check_target_arch(const image_header_t
*hdr
)
805 #ifndef IH_ARCH_DEFAULT
806 # error "please define IH_ARCH_DEFAULT in your arch asm/u-boot.h"
808 return image_check_arch(hdr
, IH_ARCH_DEFAULT
);
810 #endif /* USE_HOSTCC */
813 * Set up properties in the FDT
815 * This sets up properties in the FDT that is to be passed to linux.
817 * @images: Images information
818 * @blob: FDT to update
819 * @of_size: Size of the FDT
820 * @lmb: Points to logical memory block structure
821 * @return 0 if ok, <0 on failure
823 int image_setup_libfdt(bootm_headers_t
*images
, void *blob
,
824 int of_size
, struct lmb
*lmb
);
827 * Set up the FDT to use for booting a kernel
829 * This performs ramdisk setup, sets up the FDT if required, and adds
830 * paramters to the FDT if libfdt is available.
832 * @param images Images information
833 * @return 0 if ok, <0 on failure
835 int image_setup_linux(bootm_headers_t
*images
);
838 * bootz_setup() - Extract stat and size of a Linux xImage
840 * @image: Address of image
841 * @start: Returns start address of image
842 * @end : Returns end address of image
843 * @return 0 if OK, 1 if the image was not recognised
845 int bootz_setup(ulong image
, ulong
*start
, ulong
*end
);
848 /*******************************************************************/
849 /* New uImage format specific code (prefixed with fit_) */
850 /*******************************************************************/
852 #define FIT_IMAGES_PATH "/images"
853 #define FIT_CONFS_PATH "/configurations"
855 /* hash/signature node */
856 #define FIT_HASH_NODENAME "hash"
857 #define FIT_ALGO_PROP "algo"
858 #define FIT_VALUE_PROP "value"
859 #define FIT_IGNORE_PROP "uboot-ignore"
860 #define FIT_SIG_NODENAME "signature"
863 #define FIT_DATA_PROP "data"
864 #define FIT_DATA_OFFSET_PROP "data-offset"
865 #define FIT_DATA_SIZE_PROP "data-size"
866 #define FIT_TIMESTAMP_PROP "timestamp"
867 #define FIT_DESC_PROP "description"
868 #define FIT_ARCH_PROP "arch"
869 #define FIT_TYPE_PROP "type"
870 #define FIT_OS_PROP "os"
871 #define FIT_COMP_PROP "compression"
872 #define FIT_ENTRY_PROP "entry"
873 #define FIT_LOAD_PROP "load"
875 /* configuration node */
876 #define FIT_KERNEL_PROP "kernel"
877 #define FIT_RAMDISK_PROP "ramdisk"
878 #define FIT_FDT_PROP "fdt"
879 #define FIT_LOADABLE_PROP "loadables"
880 #define FIT_DEFAULT_PROP "default"
881 #define FIT_SETUP_PROP "setup"
882 #define FIT_FPGA_PROP "fpga"
884 #define FIT_MAX_HASH_LEN HASH_MAX_DIGEST_SIZE
887 /* cmdline argument format parsing */
888 int fit_parse_conf(const char *spec
, ulong addr_curr
,
889 ulong
*addr
, const char **conf_name
);
890 int fit_parse_subimage(const char *spec
, ulong addr_curr
,
891 ulong
*addr
, const char **image_name
);
893 int fit_get_subimage_count(const void *fit
, int images_noffset
);
894 void fit_print_contents(const void *fit
);
895 void fit_image_print(const void *fit
, int noffset
, const char *p
);
898 * fit_get_end - get FIT image size
899 * @fit: pointer to the FIT format image header
902 * size of the FIT image (blob) in memory
904 static inline ulong
fit_get_size(const void *fit
)
906 return fdt_totalsize(fit
);
910 * fit_get_end - get FIT image end
911 * @fit: pointer to the FIT format image header
914 * end address of the FIT image (blob) in memory
916 ulong
fit_get_end(const void *fit
);
919 * fit_get_name - get FIT node name
920 * @fit: pointer to the FIT format image header
924 * pointer to node name, on success
926 static inline const char *fit_get_name(const void *fit_hdr
,
927 int noffset
, int *len
)
929 return fdt_get_name(fit_hdr
, noffset
, len
);
932 int fit_get_desc(const void *fit
, int noffset
, char **desc
);
933 int fit_get_timestamp(const void *fit
, int noffset
, time_t *timestamp
);
935 int fit_image_get_node(const void *fit
, const char *image_uname
);
936 int fit_image_get_os(const void *fit
, int noffset
, uint8_t *os
);
937 int fit_image_get_arch(const void *fit
, int noffset
, uint8_t *arch
);
938 int fit_image_get_type(const void *fit
, int noffset
, uint8_t *type
);
939 int fit_image_get_comp(const void *fit
, int noffset
, uint8_t *comp
);
940 int fit_image_get_load(const void *fit
, int noffset
, ulong
*load
);
941 int fit_image_get_entry(const void *fit
, int noffset
, ulong
*entry
);
942 int fit_image_get_data(const void *fit
, int noffset
,
943 const void **data
, size_t *size
);
944 int fit_image_get_data_offset(const void *fit
, int noffset
, int *data_offset
);
945 int fit_image_get_data_size(const void *fit
, int noffset
, int *data_size
);
947 int fit_image_hash_get_algo(const void *fit
, int noffset
, char **algo
);
948 int fit_image_hash_get_value(const void *fit
, int noffset
, uint8_t **value
,
951 int fit_set_timestamp(void *fit
, int noffset
, time_t timestamp
);
954 * fit_add_verification_data() - add verification data to FIT image nodes
956 * @keydir: Directory containing keys
957 * @kwydest: FDT blob to write public key information to
958 * @fit: Pointer to the FIT format image header
959 * @comment: Comment to add to signature nodes
960 * @require_keys: Mark all keys as 'required'
961 * @engine_id: Engine to use for signing
963 * Adds hash values for all component images in the FIT blob.
964 * Hashes are calculated for all component images which have hash subnodes
965 * with algorithm property set to one of the supported hash algorithms.
967 * Also add signatures if signature nodes are present.
971 * libfdt error code, on failure
973 int fit_add_verification_data(const char *keydir
, void *keydest
, void *fit
,
974 const char *comment
, int require_keys
,
975 const char *engine_id
);
977 int fit_image_verify(const void *fit
, int noffset
);
978 int fit_config_verify(const void *fit
, int conf_noffset
);
979 int fit_all_image_verify(const void *fit
);
980 int fit_image_check_os(const void *fit
, int noffset
, uint8_t os
);
981 int fit_image_check_arch(const void *fit
, int noffset
, uint8_t arch
);
982 int fit_image_check_type(const void *fit
, int noffset
, uint8_t type
);
983 int fit_image_check_comp(const void *fit
, int noffset
, uint8_t comp
);
984 int fit_check_format(const void *fit
);
986 int fit_conf_find_compat(const void *fit
, const void *fdt
);
987 int fit_conf_get_node(const void *fit
, const char *conf_uname
);
990 * fit_conf_get_prop_node() - Get node refered to by a configuration
992 * @noffset: Offset of conf@xxx node to check
993 * @prop_name: Property to read from the conf node
995 * The conf@ nodes contain references to other nodes, using properties
996 * like 'kernel = "kernel@1"'. Given such a property name (e.g. "kernel"),
997 * return the offset of the node referred to (e.g. offset of node
998 * "/images/kernel@1".
1000 int fit_conf_get_prop_node(const void *fit
, int noffset
,
1001 const char *prop_name
);
1003 void fit_conf_print(const void *fit
, int noffset
, const char *p
);
1005 int fit_check_ramdisk(const void *fit
, int os_noffset
,
1006 uint8_t arch
, int verify
);
1008 int calculate_hash(const void *data
, int data_len
, const char *algo
,
1009 uint8_t *value
, int *value_len
);
1012 * At present we only support signing on the host, and verification on the
1015 #if defined(CONFIG_FIT_SIGNATURE)
1017 # define IMAGE_ENABLE_SIGN 1
1018 # define IMAGE_ENABLE_VERIFY 1
1019 # include <openssl/evp.h>
1021 # define IMAGE_ENABLE_SIGN 0
1022 # define IMAGE_ENABLE_VERIFY 1
1025 # define IMAGE_ENABLE_SIGN 0
1026 # define IMAGE_ENABLE_VERIFY 0
1030 void *image_get_host_blob(void);
1031 void image_set_host_blob(void *host_blob
);
1032 # define gd_fdt_blob() image_get_host_blob()
1034 # define gd_fdt_blob() (gd->fdt_blob)
1037 #ifdef CONFIG_FIT_BEST_MATCH
1038 #define IMAGE_ENABLE_BEST_MATCH 1
1040 #define IMAGE_ENABLE_BEST_MATCH 0
1043 /* Information passed to the signing routines */
1044 struct image_sign_info
{
1045 const char *keydir
; /* Directory conaining keys */
1046 const char *keyname
; /* Name of key to use */
1047 void *fit
; /* Pointer to FIT blob */
1048 int node_offset
; /* Offset of signature node */
1049 const char *name
; /* Algorithm name */
1050 struct checksum_algo
*checksum
; /* Checksum algorithm information */
1051 struct crypto_algo
*crypto
; /* Crypto algorithm information */
1052 const void *fdt_blob
; /* FDT containing public keys */
1053 int required_keynode
; /* Node offset of key to use: -1=any */
1054 const char *require_keys
; /* Value for 'required' property */
1055 const char *engine_id
; /* Engine to use for signing */
1057 #endif /* Allow struct image_region to always be defined for rsa.h */
1059 /* A part of an image, used for hashing */
1060 struct image_region
{
1065 #if IMAGE_ENABLE_FIT
1067 #if IMAGE_ENABLE_VERIFY
1068 # include <u-boot/rsa-checksum.h>
1070 struct checksum_algo
{
1072 const int checksum_len
;
1074 const uint8_t *der_prefix
;
1075 #if IMAGE_ENABLE_SIGN
1076 const EVP_MD
*(*calculate_sign
)(void);
1078 int (*calculate
)(const char *name
,
1079 const struct image_region region
[],
1080 int region_count
, uint8_t *checksum
);
1083 struct crypto_algo
{
1084 const char *name
; /* Name of algorithm */
1088 * sign() - calculate and return signature for given input data
1090 * @info: Specifies key and FIT information
1091 * @data: Pointer to the input data
1092 * @data_len: Data length
1093 * @sigp: Set to an allocated buffer holding the signature
1094 * @sig_len: Set to length of the calculated hash
1096 * This computes input data signature according to selected algorithm.
1097 * Resulting signature value is placed in an allocated buffer, the
1098 * pointer is returned as *sigp. The length of the calculated
1099 * signature is returned via the sig_len pointer argument. The caller
1100 * should free *sigp.
1102 * @return: 0, on success, -ve on error
1104 int (*sign
)(struct image_sign_info
*info
,
1105 const struct image_region region
[],
1106 int region_count
, uint8_t **sigp
, uint
*sig_len
);
1109 * add_verify_data() - Add verification information to FDT
1111 * Add public key information to the FDT node, suitable for
1112 * verification at run-time. The information added depends on the
1113 * algorithm being used.
1115 * @info: Specifies key and FIT information
1116 * @keydest: Destination FDT blob for public key data
1117 * @return: 0, on success, -ve on error
1119 int (*add_verify_data
)(struct image_sign_info
*info
, void *keydest
);
1122 * verify() - Verify a signature against some data
1124 * @info: Specifies key and FIT information
1125 * @data: Pointer to the input data
1126 * @data_len: Data length
1128 * @sig_len: Number of bytes in signature
1129 * @return 0 if verified, -ve on error
1131 int (*verify
)(struct image_sign_info
*info
,
1132 const struct image_region region
[], int region_count
,
1133 uint8_t *sig
, uint sig_len
);
1137 * image_get_checksum_algo() - Look up a checksum algorithm
1139 * @param full_name Name of algorithm in the form "checksum,crypto"
1140 * @return pointer to algorithm information, or NULL if not found
1142 struct checksum_algo
*image_get_checksum_algo(const char *full_name
);
1145 * image_get_crypto_algo() - Look up a cryptosystem algorithm
1147 * @param full_name Name of algorithm in the form "checksum,crypto"
1148 * @return pointer to algorithm information, or NULL if not found
1150 struct crypto_algo
*image_get_crypto_algo(const char *full_name
);
1153 * fit_image_verify_required_sigs() - Verify signatures marked as 'required'
1155 * @fit: FIT to check
1156 * @image_noffset: Offset of image node to check
1157 * @data: Image data to check
1158 * @size: Size of image data
1159 * @sig_blob: FDT containing public keys
1160 * @no_sigsp: Returns 1 if no signatures were required, and
1161 * therefore nothing was checked. The caller may wish
1162 * to fall back to other mechanisms, or refuse to
1164 * @return 0 if all verified ok, <0 on error
1166 int fit_image_verify_required_sigs(const void *fit
, int image_noffset
,
1167 const char *data
, size_t size
, const void *sig_blob
,
1171 * fit_image_check_sig() - Check a single image signature node
1173 * @fit: FIT to check
1174 * @noffset: Offset of signature node to check
1175 * @data: Image data to check
1176 * @size: Size of image data
1177 * @required_keynode: Offset in the control FDT of the required key node,
1178 * if any. If this is given, then the image wil not
1179 * pass verification unless that key is used. If this is
1180 * -1 then any signature will do.
1181 * @err_msgp: In the event of an error, this will be pointed to a
1182 * help error string to display to the user.
1183 * @return 0 if all verified ok, <0 on error
1185 int fit_image_check_sig(const void *fit
, int noffset
, const void *data
,
1186 size_t size
, int required_keynode
, char **err_msgp
);
1189 * fit_region_make_list() - Make a list of regions to hash
1191 * Given a list of FIT regions (offset, size) provided by libfdt, create
1192 * a list of regions (void *, size) for use by the signature creationg
1193 * and verification code.
1195 * @fit: FIT image to process
1196 * @fdt_regions: Regions as returned by libfdt
1197 * @count: Number of regions returned by libfdt
1198 * @region: Place to put list of regions (NULL to allocate it)
1199 * @return pointer to list of regions, or NULL if out of memory
1201 struct image_region
*fit_region_make_list(const void *fit
,
1202 struct fdt_region
*fdt_regions
, int count
,
1203 struct image_region
*region
);
1205 static inline int fit_image_check_target_arch(const void *fdt
, int node
)
1208 return fit_image_check_arch(fdt
, node
, IH_ARCH_DEFAULT
);
1214 #ifdef CONFIG_FIT_VERBOSE
1215 #define fit_unsupported(msg) printf("! %s:%d " \
1216 "FIT images not supported for '%s'\n", \
1217 __FILE__, __LINE__, (msg))
1219 #define fit_unsupported_reset(msg) printf("! %s:%d " \
1220 "FIT images not supported for '%s' " \
1221 "- must reset board to recover!\n", \
1222 __FILE__, __LINE__, (msg))
1224 #define fit_unsupported(msg)
1225 #define fit_unsupported_reset(msg)
1226 #endif /* CONFIG_FIT_VERBOSE */
1227 #endif /* CONFIG_FIT */
1229 #if defined(CONFIG_ANDROID_BOOT_IMAGE)
1230 struct andr_img_hdr
;
1231 int android_image_check_header(const struct andr_img_hdr
*hdr
);
1232 int android_image_get_kernel(const struct andr_img_hdr
*hdr
, int verify
,
1233 ulong
*os_data
, ulong
*os_len
);
1234 int android_image_get_ramdisk(const struct andr_img_hdr
*hdr
,
1235 ulong
*rd_data
, ulong
*rd_len
);
1236 ulong
android_image_get_end(const struct andr_img_hdr
*hdr
);
1237 ulong
android_image_get_kload(const struct andr_img_hdr
*hdr
);
1238 void android_print_contents(const struct andr_img_hdr
*hdr
);
1240 #endif /* CONFIG_ANDROID_BOOT_IMAGE */
1243 * board_fit_config_name_match() - Check for a matching board name
1245 * This is used when SPL loads a FIT containing multiple device tree files
1246 * and wants to work out which one to use. The description of each one is
1247 * passed to this function. The description comes from the 'description' field
1248 * in each (FDT) image node.
1250 * @name: Device tree description
1251 * @return 0 if this device tree should be used, non-zero to try the next
1253 int board_fit_config_name_match(const char *name
);
1255 #if defined(CONFIG_SPL_FIT_IMAGE_POST_PROCESS) || \
1256 defined(CONFIG_FIT_IMAGE_POST_PROCESS)
1258 * board_fit_image_post_process() - Do any post-process on FIT binary data
1260 * This is used to do any sort of image manipulation, verification, decryption
1261 * etc. in a platform or board specific way. Obviously, anything done here would
1262 * need to be comprehended in how the images were prepared before being injected
1263 * into the FIT creation (i.e. the binary blobs would have been pre-processed
1264 * before being added to the FIT image).
1266 * @image: pointer to the image start pointer
1267 * @size: pointer to the image size
1268 * @return no return value (failure should be handled internally)
1270 void board_fit_image_post_process(void **p_image
, size_t *p_size
);
1271 #endif /* CONFIG_SPL_FIT_IMAGE_POST_PROCESS */
1274 * Mapping of image types to function handlers to be invoked on the associated
1277 * @type: Type of image, I.E. IH_TYPE_*
1278 * @handler: Function to call on loaded image
1280 struct fit_loadable_tbl
{
1283 * handler() - Process a loaded image
1285 * @data: Pointer to start of loaded image data
1286 * @size: Size of loaded image data
1288 void (*handler
)(ulong data
, size_t size
);
1292 * Define a FIT loadable image type handler
1294 * _type is a valid uimage_type ID as defined in the "Image Type" enum above
1295 * _handler is the handler function to call after this image type is loaded
1297 #define U_BOOT_FIT_LOADABLE_HANDLER(_type, _handler) \
1298 ll_entry_declare(struct fit_loadable_tbl, _function, fit_loadable) = { \
1300 .handler = _handler, \
1303 #endif /* __IMAGE_H__ */