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)
49 #include <fdt_support.h>
50 # ifdef CONFIG_SPL_BUILD
51 # ifdef CONFIG_SPL_CRC32_SUPPORT
52 # define IMAGE_ENABLE_CRC32 1
54 # ifdef CONFIG_SPL_MD5_SUPPORT
55 # define IMAGE_ENABLE_MD5 1
57 # ifdef CONFIG_SPL_SHA1_SUPPORT
58 # define IMAGE_ENABLE_SHA1 1
60 # ifdef CONFIG_SPL_SHA256_SUPPORT
61 # define IMAGE_ENABLE_SHA256 1
64 # define CONFIG_CRC32 /* FIT images need CRC32 support */
65 # define CONFIG_MD5 /* and MD5 */
66 # define CONFIG_SHA1 /* and SHA1 */
67 # define CONFIG_SHA256 /* and SHA256 */
68 # define IMAGE_ENABLE_CRC32 1
69 # define IMAGE_ENABLE_MD5 1
70 # define IMAGE_ENABLE_SHA1 1
71 # define IMAGE_ENABLE_SHA256 1
74 #ifndef IMAGE_ENABLE_CRC32
75 #define IMAGE_ENABLE_CRC32 0
78 #ifndef IMAGE_ENABLE_MD5
79 #define IMAGE_ENABLE_MD5 0
82 #ifndef IMAGE_ENABLE_SHA1
83 #define IMAGE_ENABLE_SHA1 0
86 #ifndef IMAGE_ENABLE_SHA256
87 #define IMAGE_ENABLE_SHA256 0
90 #endif /* CONFIG_FIT */
92 #ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH
93 # define IMAGE_ENABLE_RAMDISK_HIGH 1
95 # define IMAGE_ENABLE_RAMDISK_HIGH 0
98 #ifdef CONFIG_OF_LIBFDT
99 # define IMAGE_ENABLE_OF_LIBFDT 1
101 # define IMAGE_ENABLE_OF_LIBFDT 0
104 #ifdef CONFIG_SYS_BOOT_GET_CMDLINE
105 # define IMAGE_BOOT_GET_CMDLINE 1
107 # define IMAGE_BOOT_GET_CMDLINE 0
110 #ifdef CONFIG_OF_BOARD_SETUP
111 # define IMAGE_OF_BOARD_SETUP 1
113 # define IMAGE_OF_BOARD_SETUP 0
117 * Operating System Codes
119 #define IH_OS_INVALID 0 /* Invalid OS */
120 #define IH_OS_OPENBSD 1 /* OpenBSD */
121 #define IH_OS_NETBSD 2 /* NetBSD */
122 #define IH_OS_FREEBSD 3 /* FreeBSD */
123 #define IH_OS_4_4BSD 4 /* 4.4BSD */
124 #define IH_OS_LINUX 5 /* Linux */
125 #define IH_OS_SVR4 6 /* SVR4 */
126 #define IH_OS_ESIX 7 /* Esix */
127 #define IH_OS_SOLARIS 8 /* Solaris */
128 #define IH_OS_IRIX 9 /* Irix */
129 #define IH_OS_SCO 10 /* SCO */
130 #define IH_OS_DELL 11 /* Dell */
131 #define IH_OS_NCR 12 /* NCR */
132 #define IH_OS_LYNXOS 13 /* LynxOS */
133 #define IH_OS_VXWORKS 14 /* VxWorks */
134 #define IH_OS_PSOS 15 /* pSOS */
135 #define IH_OS_QNX 16 /* QNX */
136 #define IH_OS_U_BOOT 17 /* Firmware */
137 #define IH_OS_RTEMS 18 /* RTEMS */
138 #define IH_OS_ARTOS 19 /* ARTOS */
139 #define IH_OS_UNITY 20 /* Unity OS */
140 #define IH_OS_INTEGRITY 21 /* INTEGRITY */
141 #define IH_OS_OSE 22 /* OSE */
142 #define IH_OS_PLAN9 23 /* Plan 9 */
145 * CPU Architecture Codes (supported by Linux)
147 #define IH_ARCH_INVALID 0 /* Invalid CPU */
148 #define IH_ARCH_ALPHA 1 /* Alpha */
149 #define IH_ARCH_ARM 2 /* ARM */
150 #define IH_ARCH_I386 3 /* Intel x86 */
151 #define IH_ARCH_IA64 4 /* IA64 */
152 #define IH_ARCH_MIPS 5 /* MIPS */
153 #define IH_ARCH_MIPS64 6 /* MIPS 64 Bit */
154 #define IH_ARCH_PPC 7 /* PowerPC */
155 #define IH_ARCH_S390 8 /* IBM S390 */
156 #define IH_ARCH_SH 9 /* SuperH */
157 #define IH_ARCH_SPARC 10 /* Sparc */
158 #define IH_ARCH_SPARC64 11 /* Sparc 64 Bit */
159 #define IH_ARCH_M68K 12 /* M68K */
160 #define IH_ARCH_MICROBLAZE 14 /* MicroBlaze */
161 #define IH_ARCH_NIOS2 15 /* Nios-II */
162 #define IH_ARCH_BLACKFIN 16 /* Blackfin */
163 #define IH_ARCH_AVR32 17 /* AVR32 */
164 #define IH_ARCH_ST200 18 /* STMicroelectronics ST200 */
165 #define IH_ARCH_SANDBOX 19 /* Sandbox architecture (test only) */
166 #define IH_ARCH_NDS32 20 /* ANDES Technology - NDS32 */
167 #define IH_ARCH_OPENRISC 21 /* OpenRISC 1000 */
168 #define IH_ARCH_ARM64 22 /* ARM64 */
169 #define IH_ARCH_ARC 23 /* Synopsys DesignWare ARC */
174 * "Standalone Programs" are directly runnable in the environment
175 * provided by U-Boot; it is expected that (if they behave
176 * well) you can continue to work in U-Boot after return from
177 * the Standalone Program.
178 * "OS Kernel Images" are usually images of some Embedded OS which
179 * will take over control completely. Usually these programs
180 * will install their own set of exception handlers, device
181 * drivers, set up the MMU, etc. - this means, that you cannot
182 * expect to re-enter U-Boot except by resetting the CPU.
183 * "RAMDisk Images" are more or less just data blocks, and their
184 * parameters (address, size) are passed to an OS kernel that is
186 * "Multi-File Images" contain several images, typically an OS
187 * (Linux) kernel image and one or more data images like
188 * RAMDisks. This construct is useful for instance when you want
189 * to boot over the network using BOOTP etc., where the boot
190 * server provides just a single image file, but you want to get
191 * for instance an OS kernel and a RAMDisk image.
193 * "Multi-File Images" start with a list of image sizes, each
194 * image size (in bytes) specified by an "uint32_t" in network
195 * byte order. This list is terminated by an "(uint32_t)0".
196 * Immediately after the terminating 0 follow the images, one by
197 * one, all aligned on "uint32_t" boundaries (size rounded up to
198 * a multiple of 4 bytes - except for the last file).
200 * "Firmware Images" are binary images containing firmware (like
201 * U-Boot or FPGA images) which usually will be programmed to
204 * "Script files" are command sequences that will be executed by
205 * U-Boot's command interpreter; this feature is especially
206 * useful when you configure U-Boot to use a real shell (hush)
207 * as command interpreter (=> Shell Scripts).
210 #define IH_TYPE_INVALID 0 /* Invalid Image */
211 #define IH_TYPE_STANDALONE 1 /* Standalone Program */
212 #define IH_TYPE_KERNEL 2 /* OS Kernel Image */
213 #define IH_TYPE_RAMDISK 3 /* RAMDisk Image */
214 #define IH_TYPE_MULTI 4 /* Multi-File Image */
215 #define IH_TYPE_FIRMWARE 5 /* Firmware Image */
216 #define IH_TYPE_SCRIPT 6 /* Script file */
217 #define IH_TYPE_FILESYSTEM 7 /* Filesystem Image (any type) */
218 #define IH_TYPE_FLATDT 8 /* Binary Flat Device Tree Blob */
219 #define IH_TYPE_KWBIMAGE 9 /* Kirkwood Boot Image */
220 #define IH_TYPE_IMXIMAGE 10 /* Freescale IMXBoot Image */
221 #define IH_TYPE_UBLIMAGE 11 /* Davinci UBL Image */
222 #define IH_TYPE_OMAPIMAGE 12 /* TI OMAP Config Header Image */
223 #define IH_TYPE_AISIMAGE 13 /* TI Davinci AIS Image */
224 #define IH_TYPE_KERNEL_NOLOAD 14 /* OS Kernel Image, can run from any load address */
225 #define IH_TYPE_PBLIMAGE 15 /* Freescale PBL Boot Image */
226 #define IH_TYPE_MXSIMAGE 16 /* Freescale MXSBoot Image */
227 #define IH_TYPE_GPIMAGE 17 /* TI Keystone GPHeader Image */
232 #define IH_COMP_NONE 0 /* No Compression Used */
233 #define IH_COMP_GZIP 1 /* gzip Compression Used */
234 #define IH_COMP_BZIP2 2 /* bzip2 Compression Used */
235 #define IH_COMP_LZMA 3 /* lzma Compression Used */
236 #define IH_COMP_LZO 4 /* lzo Compression Used */
238 #define IH_MAGIC 0x27051956 /* Image Magic Number */
239 #define IH_NMLEN 32 /* Image Name Length */
241 /* Reused from common.h */
242 #define ROUND(a, b) (((a) + (b) - 1) & ~((b) - 1))
245 * Legacy format image header,
246 * all data in network byte order (aka natural aka bigendian).
248 typedef struct image_header
{
249 __be32 ih_magic
; /* Image Header Magic Number */
250 __be32 ih_hcrc
; /* Image Header CRC Checksum */
251 __be32 ih_time
; /* Image Creation Timestamp */
252 __be32 ih_size
; /* Image Data Size */
253 __be32 ih_load
; /* Data Load Address */
254 __be32 ih_ep
; /* Entry Point Address */
255 __be32 ih_dcrc
; /* Image Data CRC Checksum */
256 uint8_t ih_os
; /* Operating System */
257 uint8_t ih_arch
; /* CPU architecture */
258 uint8_t ih_type
; /* Image Type */
259 uint8_t ih_comp
; /* Compression Type */
260 uint8_t ih_name
[IH_NMLEN
]; /* Image Name */
263 typedef struct image_info
{
264 ulong start
, end
; /* start/end of blob */
265 ulong image_start
, image_len
; /* start of image within blob, len of image */
266 ulong load
; /* load addr for the image */
267 uint8_t comp
, type
, os
; /* compression, type of image, os type */
271 * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
274 typedef struct bootm_headers
{
276 * Legacy os image header, if it is a multi component image
277 * then boot_get_ramdisk() and get_fdt() will attempt to get
278 * data from second and third component accordingly.
280 image_header_t
*legacy_hdr_os
; /* image header pointer */
281 image_header_t legacy_hdr_os_copy
; /* header copy */
282 ulong legacy_hdr_valid
;
284 #if defined(CONFIG_FIT)
285 const char *fit_uname_cfg
; /* configuration node unit name */
287 void *fit_hdr_os
; /* os FIT image header */
288 const char *fit_uname_os
; /* os subimage node unit name */
289 int fit_noffset_os
; /* os subimage node offset */
291 void *fit_hdr_rd
; /* init ramdisk FIT image header */
292 const char *fit_uname_rd
; /* init ramdisk subimage node unit name */
293 int fit_noffset_rd
; /* init ramdisk subimage node offset */
295 void *fit_hdr_fdt
; /* FDT blob FIT image header */
296 const char *fit_uname_fdt
; /* FDT blob subimage node unit name */
297 int fit_noffset_fdt
;/* FDT blob subimage node offset */
301 image_info_t os
; /* os image info */
302 ulong ep
; /* entry point of OS */
304 ulong rd_start
, rd_end
;/* ramdisk start/end */
306 char *ft_addr
; /* flat dev tree address */
307 ulong ft_len
; /* length of flat device tree */
316 int verify
; /* getenv("verify")[0] != 'n' */
318 #define BOOTM_STATE_START (0x00000001)
319 #define BOOTM_STATE_FINDOS (0x00000002)
320 #define BOOTM_STATE_FINDOTHER (0x00000004)
321 #define BOOTM_STATE_LOADOS (0x00000008)
322 #define BOOTM_STATE_RAMDISK (0x00000010)
323 #define BOOTM_STATE_FDT (0x00000020)
324 #define BOOTM_STATE_OS_CMDLINE (0x00000040)
325 #define BOOTM_STATE_OS_BD_T (0x00000080)
326 #define BOOTM_STATE_OS_PREP (0x00000100)
327 #define BOOTM_STATE_OS_FAKE_GO (0x00000200) /* 'Almost' run the OS */
328 #define BOOTM_STATE_OS_GO (0x00000400)
332 struct lmb lmb
; /* for memory mgmt */
336 extern bootm_headers_t images
;
339 * Some systems (for example LWMON) have very short watchdog periods;
340 * we must make sure to split long operations like memmove() or
341 * checksum calculations into reasonable chunks.
344 #define CHUNKSZ (64 * 1024)
347 #ifndef CHUNKSZ_CRC32
348 #define CHUNKSZ_CRC32 (64 * 1024)
352 #define CHUNKSZ_MD5 (64 * 1024)
356 #define CHUNKSZ_SHA1 (64 * 1024)
359 #define uimage_to_cpu(x) be32_to_cpu(x)
360 #define cpu_to_uimage(x) cpu_to_be32(x)
363 * Translation table for entries of a specific type; used by
364 * get_table_entry_id() and get_table_entry_name().
366 typedef struct table_entry
{
368 char *sname
; /* short (input) name to find table entry */
369 char *lname
; /* long (output) name to print for messages */
373 * get_table_entry_id() scans the translation table trying to find an
374 * entry that matches the given short name. If a matching entry is
375 * found, it's id is returned to the caller.
377 int get_table_entry_id(const table_entry_t
*table
,
378 const char *table_name
, const char *name
);
380 * get_table_entry_name() scans the translation table trying to find
381 * an entry that matches the given id. If a matching entry is found,
382 * its long name is returned to the caller.
384 char *get_table_entry_name(const table_entry_t
*table
, char *msg
, int id
);
386 const char *genimg_get_os_name(uint8_t os
);
387 const char *genimg_get_arch_name(uint8_t arch
);
388 const char *genimg_get_type_name(uint8_t type
);
389 const char *genimg_get_comp_name(uint8_t comp
);
390 int genimg_get_os_id(const char *name
);
391 int genimg_get_arch_id(const char *name
);
392 int genimg_get_type_id(const char *name
);
393 int genimg_get_comp_id(const char *name
);
394 void genimg_print_size(uint32_t size
);
396 #if defined(CONFIG_TIMESTAMP) || defined(CONFIG_CMD_DATE) || \
398 #define IMAGE_ENABLE_TIMESTAMP 1
400 #define IMAGE_ENABLE_TIMESTAMP 0
402 void genimg_print_time(time_t timestamp
);
404 /* What to do with a image load address ('load = <> 'in the FIT) */
406 FIT_LOAD_IGNORED
, /* Ignore load address */
407 FIT_LOAD_OPTIONAL
, /* Can be provided, but optional */
408 FIT_LOAD_REQUIRED
, /* Must be provided */
412 /* Image format types, returned by _get_format() routine */
413 #define IMAGE_FORMAT_INVALID 0x00
414 #define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */
415 #define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */
416 #define IMAGE_FORMAT_ANDROID 0x03 /* Android boot image */
418 int genimg_get_format(const void *img_addr
);
419 int genimg_has_config(bootm_headers_t
*images
);
420 ulong
genimg_get_image(ulong img_addr
);
422 int boot_get_ramdisk(int argc
, char * const argv
[], bootm_headers_t
*images
,
423 uint8_t arch
, ulong
*rd_start
, ulong
*rd_end
);
426 * fit_image_load() - load an image from a FIT
428 * This deals with all aspects of loading an image from a FIT, including
429 * selecting the right image based on configuration, verifying it, printing
430 * out progress messages, checking the type/arch/os and optionally copying it
431 * to the right load address.
433 * @param images Boot images structure
434 * @param prop_name Property name to look up (FIT_..._PROP)
435 * @param addr Address of FIT in memory
436 * @param fit_unamep On entry this is the requested image name
437 * (e.g. "kernel@1") or NULL to use the default. On exit
438 * points to the selected image name
439 * @param fit_uname_configp On entry this is the requested configuration
440 * name (e.g. "conf@1") or NULL to use the default. On
441 * exit points to the selected configuration name.
442 * @param arch Expected architecture (IH_ARCH_...)
443 * @param image_type Required image type (IH_TYPE_...). If this is
444 * IH_TYPE_KERNEL then we allow IH_TYPE_KERNEL_NOLOAD
446 * @param bootstage_id ID of starting bootstage to use for progress updates.
447 * This will be added to the BOOTSTAGE_SUB values when
448 * calling bootstage_mark()
449 * @param load_op Decribes what to do with the load address
450 * @param datap Returns address of loaded image
451 * @param lenp Returns length of loaded image
453 int fit_image_load(bootm_headers_t
*images
, const char *prop_name
, ulong addr
,
454 const char **fit_unamep
, const char **fit_uname_configp
,
455 int arch
, int image_type
, int bootstage_id
,
456 enum fit_load_op load_op
, ulong
*datap
, ulong
*lenp
);
459 * fit_get_node_from_config() - Look up an image a FIT by type
461 * This looks in the selected conf@ node (images->fit_uname_cfg) for a
462 * particular image type (e.g. "kernel") and then finds the image that is
465 * For example, for something like:
474 * kernel = "kernel@1";
478 * the function will return the node offset of the kernel@1 node, assuming
479 * that conf@1 is the chosen configuration.
481 * @param images Boot images structure
482 * @param prop_name Property name to look up (FIT_..._PROP)
483 * @param addr Address of FIT in memory
485 int fit_get_node_from_config(bootm_headers_t
*images
, const char *prop_name
,
488 int boot_get_fdt(int flag
, int argc
, char * const argv
[], uint8_t arch
,
489 bootm_headers_t
*images
,
490 char **of_flat_tree
, ulong
*of_size
);
491 void boot_fdt_add_mem_rsv_regions(struct lmb
*lmb
, void *fdt_blob
);
492 int boot_relocate_fdt(struct lmb
*lmb
, char **of_flat_tree
, ulong
*of_size
);
494 int boot_ramdisk_high(struct lmb
*lmb
, ulong rd_data
, ulong rd_len
,
495 ulong
*initrd_start
, ulong
*initrd_end
);
496 int boot_get_cmdline(struct lmb
*lmb
, ulong
*cmd_start
, ulong
*cmd_end
);
497 #ifdef CONFIG_SYS_BOOT_GET_KBD
498 int boot_get_kbd(struct lmb
*lmb
, bd_t
**kbd
);
499 #endif /* CONFIG_SYS_BOOT_GET_KBD */
500 #endif /* !USE_HOSTCC */
502 /*******************************************************************/
503 /* Legacy format specific code (prefixed with image_) */
504 /*******************************************************************/
505 static inline uint32_t image_get_header_size(void)
507 return (sizeof(image_header_t
));
510 #define image_get_hdr_l(f) \
511 static inline uint32_t image_get_##f(const image_header_t *hdr) \
513 return uimage_to_cpu(hdr->ih_##f); \
515 image_get_hdr_l(magic
) /* image_get_magic */
516 image_get_hdr_l(hcrc
) /* image_get_hcrc */
517 image_get_hdr_l(time
) /* image_get_time */
518 image_get_hdr_l(size
) /* image_get_size */
519 image_get_hdr_l(load
) /* image_get_load */
520 image_get_hdr_l(ep
) /* image_get_ep */
521 image_get_hdr_l(dcrc
) /* image_get_dcrc */
523 #define image_get_hdr_b(f) \
524 static inline uint8_t image_get_##f(const image_header_t *hdr) \
526 return hdr->ih_##f; \
528 image_get_hdr_b(os
) /* image_get_os */
529 image_get_hdr_b(arch
) /* image_get_arch */
530 image_get_hdr_b(type
) /* image_get_type */
531 image_get_hdr_b(comp
) /* image_get_comp */
533 static inline char *image_get_name(const image_header_t
*hdr
)
535 return (char *)hdr
->ih_name
;
538 static inline uint32_t image_get_data_size(const image_header_t
*hdr
)
540 return image_get_size(hdr
);
544 * image_get_data - get image payload start address
547 * image_get_data() returns address of the image payload. For single
548 * component images it is image data start. For multi component
549 * images it points to the null terminated table of sub-images sizes.
552 * image payload data start address
554 static inline ulong
image_get_data(const image_header_t
*hdr
)
556 return ((ulong
)hdr
+ image_get_header_size());
559 static inline uint32_t image_get_image_size(const image_header_t
*hdr
)
561 return (image_get_size(hdr
) + image_get_header_size());
563 static inline ulong
image_get_image_end(const image_header_t
*hdr
)
565 return ((ulong
)hdr
+ image_get_image_size(hdr
));
568 #define image_set_hdr_l(f) \
569 static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
571 hdr->ih_##f = cpu_to_uimage(val); \
573 image_set_hdr_l(magic
) /* image_set_magic */
574 image_set_hdr_l(hcrc
) /* image_set_hcrc */
575 image_set_hdr_l(time
) /* image_set_time */
576 image_set_hdr_l(size
) /* image_set_size */
577 image_set_hdr_l(load
) /* image_set_load */
578 image_set_hdr_l(ep
) /* image_set_ep */
579 image_set_hdr_l(dcrc
) /* image_set_dcrc */
581 #define image_set_hdr_b(f) \
582 static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
586 image_set_hdr_b(os
) /* image_set_os */
587 image_set_hdr_b(arch
) /* image_set_arch */
588 image_set_hdr_b(type
) /* image_set_type */
589 image_set_hdr_b(comp
) /* image_set_comp */
591 static inline void image_set_name(image_header_t
*hdr
, const char *name
)
593 strncpy(image_get_name(hdr
), name
, IH_NMLEN
);
596 int image_check_hcrc(const image_header_t
*hdr
);
597 int image_check_dcrc(const image_header_t
*hdr
);
599 ulong
getenv_bootm_low(void);
600 phys_size_t
getenv_bootm_size(void);
601 phys_size_t
getenv_bootm_mapsize(void);
602 void memmove_wd(void *to
, void *from
, size_t len
, ulong chunksz
);
605 static inline int image_check_magic(const image_header_t
*hdr
)
607 return (image_get_magic(hdr
) == IH_MAGIC
);
609 static inline int image_check_type(const image_header_t
*hdr
, uint8_t type
)
611 return (image_get_type(hdr
) == type
);
613 static inline int image_check_arch(const image_header_t
*hdr
, uint8_t arch
)
615 return (image_get_arch(hdr
) == arch
);
617 static inline int image_check_os(const image_header_t
*hdr
, uint8_t os
)
619 return (image_get_os(hdr
) == os
);
622 ulong
image_multi_count(const image_header_t
*hdr
);
623 void image_multi_getimg(const image_header_t
*hdr
, ulong idx
,
624 ulong
*data
, ulong
*len
);
626 void image_print_contents(const void *hdr
);
629 static inline int image_check_target_arch(const image_header_t
*hdr
)
631 #ifndef IH_ARCH_DEFAULT
632 # error "please define IH_ARCH_DEFAULT in your arch asm/u-boot.h"
634 return image_check_arch(hdr
, IH_ARCH_DEFAULT
);
636 #endif /* USE_HOSTCC */
639 * Set up properties in the FDT
641 * This sets up properties in the FDT that is to be passed to linux.
643 * @images: Images information
644 * @blob: FDT to update
645 * @of_size: Size of the FDT
646 * @lmb: Points to logical memory block structure
647 * @return 0 if ok, <0 on failure
649 int image_setup_libfdt(bootm_headers_t
*images
, void *blob
,
650 int of_size
, struct lmb
*lmb
);
653 * Set up the FDT to use for booting a kernel
655 * This performs ramdisk setup, sets up the FDT if required, and adds
656 * paramters to the FDT if libfdt is available.
658 * @param images Images information
659 * @return 0 if ok, <0 on failure
661 int image_setup_linux(bootm_headers_t
*images
);
664 * bootz_setup() - Extract stat and size of a Linux xImage
666 * @image: Address of image
667 * @start: Returns start address of image
668 * @end : Returns end address of image
669 * @return 0 if OK, 1 if the image was not recognised
671 int bootz_setup(ulong image
, ulong
*start
, ulong
*end
);
674 /*******************************************************************/
675 /* New uImage format specific code (prefixed with fit_) */
676 /*******************************************************************/
677 #if defined(CONFIG_FIT)
679 #define FIT_IMAGES_PATH "/images"
680 #define FIT_CONFS_PATH "/configurations"
682 /* hash/signature node */
683 #define FIT_HASH_NODENAME "hash"
684 #define FIT_ALGO_PROP "algo"
685 #define FIT_VALUE_PROP "value"
686 #define FIT_IGNORE_PROP "uboot-ignore"
687 #define FIT_SIG_NODENAME "signature"
690 #define FIT_DATA_PROP "data"
691 #define FIT_TIMESTAMP_PROP "timestamp"
692 #define FIT_DESC_PROP "description"
693 #define FIT_ARCH_PROP "arch"
694 #define FIT_TYPE_PROP "type"
695 #define FIT_OS_PROP "os"
696 #define FIT_COMP_PROP "compression"
697 #define FIT_ENTRY_PROP "entry"
698 #define FIT_LOAD_PROP "load"
700 /* configuration node */
701 #define FIT_KERNEL_PROP "kernel"
702 #define FIT_RAMDISK_PROP "ramdisk"
703 #define FIT_FDT_PROP "fdt"
704 #define FIT_DEFAULT_PROP "default"
706 #define FIT_MAX_HASH_LEN 20 /* max(crc32_len(4), sha1_len(20)) */
708 /* cmdline argument format parsing */
709 int fit_parse_conf(const char *spec
, ulong addr_curr
,
710 ulong
*addr
, const char **conf_name
);
711 int fit_parse_subimage(const char *spec
, ulong addr_curr
,
712 ulong
*addr
, const char **image_name
);
714 void fit_print_contents(const void *fit
);
715 void fit_image_print(const void *fit
, int noffset
, const char *p
);
718 * fit_get_end - get FIT image size
719 * @fit: pointer to the FIT format image header
722 * size of the FIT image (blob) in memory
724 static inline ulong
fit_get_size(const void *fit
)
726 return fdt_totalsize(fit
);
730 * fit_get_end - get FIT image end
731 * @fit: pointer to the FIT format image header
734 * end address of the FIT image (blob) in memory
736 static inline ulong
fit_get_end(const void *fit
)
738 return (ulong
)fit
+ fdt_totalsize(fit
);
742 * fit_get_name - get FIT node name
743 * @fit: pointer to the FIT format image header
747 * pointer to node name, on success
749 static inline const char *fit_get_name(const void *fit_hdr
,
750 int noffset
, int *len
)
752 return fdt_get_name(fit_hdr
, noffset
, len
);
755 int fit_get_desc(const void *fit
, int noffset
, char **desc
);
756 int fit_get_timestamp(const void *fit
, int noffset
, time_t *timestamp
);
758 int fit_image_get_node(const void *fit
, const char *image_uname
);
759 int fit_image_get_os(const void *fit
, int noffset
, uint8_t *os
);
760 int fit_image_get_arch(const void *fit
, int noffset
, uint8_t *arch
);
761 int fit_image_get_type(const void *fit
, int noffset
, uint8_t *type
);
762 int fit_image_get_comp(const void *fit
, int noffset
, uint8_t *comp
);
763 int fit_image_get_load(const void *fit
, int noffset
, ulong
*load
);
764 int fit_image_get_entry(const void *fit
, int noffset
, ulong
*entry
);
765 int fit_image_get_data(const void *fit
, int noffset
,
766 const void **data
, size_t *size
);
768 int fit_image_hash_get_algo(const void *fit
, int noffset
, char **algo
);
769 int fit_image_hash_get_value(const void *fit
, int noffset
, uint8_t **value
,
772 int fit_set_timestamp(void *fit
, int noffset
, time_t timestamp
);
775 * fit_add_verification_data() - add verification data to FIT image nodes
777 * @keydir: Directory containing keys
778 * @kwydest: FDT blob to write public key information to
779 * @fit: Pointer to the FIT format image header
780 * @comment: Comment to add to signature nodes
781 * @require_keys: Mark all keys as 'required'
783 * Adds hash values for all component images in the FIT blob.
784 * Hashes are calculated for all component images which have hash subnodes
785 * with algorithm property set to one of the supported hash algorithms.
787 * Also add signatures if signature nodes are present.
791 * libfdt error code, on failure
793 int fit_add_verification_data(const char *keydir
, void *keydest
, void *fit
,
794 const char *comment
, int require_keys
);
796 int fit_image_verify(const void *fit
, int noffset
);
797 int fit_config_verify(const void *fit
, int conf_noffset
);
798 int fit_all_image_verify(const void *fit
);
799 int fit_image_check_os(const void *fit
, int noffset
, uint8_t os
);
800 int fit_image_check_arch(const void *fit
, int noffset
, uint8_t arch
);
801 int fit_image_check_type(const void *fit
, int noffset
, uint8_t type
);
802 int fit_image_check_comp(const void *fit
, int noffset
, uint8_t comp
);
803 int fit_check_format(const void *fit
);
805 int fit_conf_find_compat(const void *fit
, const void *fdt
);
806 int fit_conf_get_node(const void *fit
, const char *conf_uname
);
809 * fit_conf_get_prop_node() - Get node refered to by a configuration
811 * @noffset: Offset of conf@xxx node to check
812 * @prop_name: Property to read from the conf node
814 * The conf@ nodes contain references to other nodes, using properties
815 * like 'kernel = "kernel@1"'. Given such a property name (e.g. "kernel"),
816 * return the offset of the node referred to (e.g. offset of node
817 * "/images/kernel@1".
819 int fit_conf_get_prop_node(const void *fit
, int noffset
,
820 const char *prop_name
);
822 void fit_conf_print(const void *fit
, int noffset
, const char *p
);
824 int fit_check_ramdisk(const void *fit
, int os_noffset
,
825 uint8_t arch
, int verify
);
827 int calculate_hash(const void *data
, int data_len
, const char *algo
,
828 uint8_t *value
, int *value_len
);
831 * At present we only support signing on the host, and verification on the
834 #if defined(CONFIG_FIT_SIGNATURE)
836 # define IMAGE_ENABLE_SIGN 1
837 # define IMAGE_ENABLE_VERIFY 1
838 # include <openssl/evp.h>
840 # define IMAGE_ENABLE_SIGN 0
841 # define IMAGE_ENABLE_VERIFY 1
844 # define IMAGE_ENABLE_SIGN 0
845 # define IMAGE_ENABLE_VERIFY 0
849 void *image_get_host_blob(void);
850 void image_set_host_blob(void *host_blob
);
851 # define gd_fdt_blob() image_get_host_blob()
853 # define gd_fdt_blob() (gd->fdt_blob)
856 #ifdef CONFIG_FIT_BEST_MATCH
857 #define IMAGE_ENABLE_BEST_MATCH 1
859 #define IMAGE_ENABLE_BEST_MATCH 0
862 /* Information passed to the signing routines */
863 struct image_sign_info
{
864 const char *keydir
; /* Directory conaining keys */
865 const char *keyname
; /* Name of key to use */
866 void *fit
; /* Pointer to FIT blob */
867 int node_offset
; /* Offset of signature node */
868 struct image_sig_algo
*algo
; /* Algorithm information */
869 const void *fdt_blob
; /* FDT containing public keys */
870 int required_keynode
; /* Node offset of key to use: -1=any */
871 const char *require_keys
; /* Value for 'required' property */
874 /* A part of an image, used for hashing */
875 struct image_region
{
880 #if IMAGE_ENABLE_VERIFY
881 # include <rsa-checksum.h>
883 struct checksum_algo
{
885 const int checksum_len
;
887 #if IMAGE_ENABLE_SIGN
888 const EVP_MD
*(*calculate_sign
)(void);
890 void (*calculate
)(const struct image_region region
[],
891 int region_count
, uint8_t *checksum
);
892 const uint8_t *rsa_padding
;
895 struct image_sig_algo
{
896 const char *name
; /* Name of algorithm */
899 * sign() - calculate and return signature for given input data
901 * @info: Specifies key and FIT information
902 * @data: Pointer to the input data
903 * @data_len: Data length
904 * @sigp: Set to an allocated buffer holding the signature
905 * @sig_len: Set to length of the calculated hash
907 * This computes input data signature according to selected algorithm.
908 * Resulting signature value is placed in an allocated buffer, the
909 * pointer is returned as *sigp. The length of the calculated
910 * signature is returned via the sig_len pointer argument. The caller
913 * @return: 0, on success, -ve on error
915 int (*sign
)(struct image_sign_info
*info
,
916 const struct image_region region
[],
917 int region_count
, uint8_t **sigp
, uint
*sig_len
);
920 * add_verify_data() - Add verification information to FDT
922 * Add public key information to the FDT node, suitable for
923 * verification at run-time. The information added depends on the
924 * algorithm being used.
926 * @info: Specifies key and FIT information
927 * @keydest: Destination FDT blob for public key data
928 * @return: 0, on success, -ve on error
930 int (*add_verify_data
)(struct image_sign_info
*info
, void *keydest
);
933 * verify() - Verify a signature against some data
935 * @info: Specifies key and FIT information
936 * @data: Pointer to the input data
937 * @data_len: Data length
939 * @sig_len: Number of bytes in signature
940 * @return 0 if verified, -ve on error
942 int (*verify
)(struct image_sign_info
*info
,
943 const struct image_region region
[], int region_count
,
944 uint8_t *sig
, uint sig_len
);
946 /* pointer to checksum algorithm */
947 struct checksum_algo
*checksum
;
951 * image_get_sig_algo() - Look up a signature algortihm
953 * @param name Name of algorithm
954 * @return pointer to algorithm information, or NULL if not found
956 struct image_sig_algo
*image_get_sig_algo(const char *name
);
959 * fit_image_verify_required_sigs() - Verify signatures marked as 'required'
962 * @image_noffset: Offset of image node to check
963 * @data: Image data to check
964 * @size: Size of image data
965 * @sig_blob: FDT containing public keys
966 * @no_sigsp: Returns 1 if no signatures were required, and
967 * therefore nothing was checked. The caller may wish
968 * to fall back to other mechanisms, or refuse to
970 * @return 0 if all verified ok, <0 on error
972 int fit_image_verify_required_sigs(const void *fit
, int image_noffset
,
973 const char *data
, size_t size
, const void *sig_blob
,
977 * fit_image_check_sig() - Check a single image signature node
980 * @noffset: Offset of signature node to check
981 * @data: Image data to check
982 * @size: Size of image data
983 * @required_keynode: Offset in the control FDT of the required key node,
984 * if any. If this is given, then the image wil not
985 * pass verification unless that key is used. If this is
986 * -1 then any signature will do.
987 * @err_msgp: In the event of an error, this will be pointed to a
988 * help error string to display to the user.
989 * @return 0 if all verified ok, <0 on error
991 int fit_image_check_sig(const void *fit
, int noffset
, const void *data
,
992 size_t size
, int required_keynode
, char **err_msgp
);
995 * fit_region_make_list() - Make a list of regions to hash
997 * Given a list of FIT regions (offset, size) provided by libfdt, create
998 * a list of regions (void *, size) for use by the signature creationg
999 * and verification code.
1001 * @fit: FIT image to process
1002 * @fdt_regions: Regions as returned by libfdt
1003 * @count: Number of regions returned by libfdt
1004 * @region: Place to put list of regions (NULL to allocate it)
1005 * @return pointer to list of regions, or NULL if out of memory
1007 struct image_region
*fit_region_make_list(const void *fit
,
1008 struct fdt_region
*fdt_regions
, int count
,
1009 struct image_region
*region
);
1011 static inline int fit_image_check_target_arch(const void *fdt
, int node
)
1014 return fit_image_check_arch(fdt
, node
, IH_ARCH_DEFAULT
);
1020 #ifdef CONFIG_FIT_VERBOSE
1021 #define fit_unsupported(msg) printf("! %s:%d " \
1022 "FIT images not supported for '%s'\n", \
1023 __FILE__, __LINE__, (msg))
1025 #define fit_unsupported_reset(msg) printf("! %s:%d " \
1026 "FIT images not supported for '%s' " \
1027 "- must reset board to recover!\n", \
1028 __FILE__, __LINE__, (msg))
1030 #define fit_unsupported(msg)
1031 #define fit_unsupported_reset(msg)
1032 #endif /* CONFIG_FIT_VERBOSE */
1033 #endif /* CONFIG_FIT */
1035 #if defined(CONFIG_ANDROID_BOOT_IMAGE)
1036 struct andr_img_hdr
;
1037 int android_image_check_header(const struct andr_img_hdr
*hdr
);
1038 int android_image_get_kernel(const struct andr_img_hdr
*hdr
, int verify
,
1039 ulong
*os_data
, ulong
*os_len
);
1040 int android_image_get_ramdisk(const struct andr_img_hdr
*hdr
,
1041 ulong
*rd_data
, ulong
*rd_len
);
1042 ulong
android_image_get_end(const struct andr_img_hdr
*hdr
);
1043 ulong
android_image_get_kload(const struct andr_img_hdr
*hdr
);
1045 #endif /* CONFIG_ANDROID_BOOT_IMAGE */
1047 #endif /* __IMAGE_H__ */