xref: /openbmc/u-boot/include/image.h (revision 699c4e59)
1 /*
2  * (C) Copyright 2008 Semihalf
3  *
4  * (C) Copyright 2000-2005
5  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
6  *
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
12  * work".
13  ********************************************************************
14  */
15 
16 #ifndef __IMAGE_H__
17 #define __IMAGE_H__
18 
19 #include "compiler.h"
20 #include <asm/byteorder.h>
21 
22 /* Define this to avoid #ifdefs later on */
23 struct lmb;
24 
25 #ifdef USE_HOSTCC
26 #include <sys/types.h>
27 
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 
33 #define IMAGE_ENABLE_IGNORE	0
34 #define IMAGE_INDENT_STRING	""
35 
36 #else
37 
38 #include <lmb.h>
39 #include <asm/u-boot.h>
40 #include <command.h>
41 
42 /* Take notice of the 'ignore' property for hashes */
43 #define IMAGE_ENABLE_IGNORE	1
44 #define IMAGE_INDENT_STRING	"   "
45 
46 #define IMAGE_ENABLE_FIT	CONFIG_IS_ENABLED(FIT)
47 #define IMAGE_ENABLE_OF_LIBFDT	CONFIG_IS_ENABLED(OF_LIBFDT)
48 
49 #endif /* USE_HOSTCC */
50 
51 #if IMAGE_ENABLE_FIT
52 #include <hash.h>
53 #include <libfdt.h>
54 #include <fdt_support.h>
55 # ifdef CONFIG_SPL_BUILD
56 #  ifdef CONFIG_SPL_CRC32_SUPPORT
57 #   define IMAGE_ENABLE_CRC32	1
58 #  endif
59 #  ifdef CONFIG_SPL_MD5_SUPPORT
60 #   define IMAGE_ENABLE_MD5	1
61 #  endif
62 #  ifdef CONFIG_SPL_SHA1_SUPPORT
63 #   define IMAGE_ENABLE_SHA1	1
64 #  endif
65 #  ifdef CONFIG_SPL_SHA256_SUPPORT
66 #   define IMAGE_ENABLE_SHA256	1
67 #  endif
68 # else
69 #  define CONFIG_CRC32		/* FIT images need CRC32 support */
70 #  define CONFIG_MD5		/* and MD5 */
71 #  define CONFIG_SHA1		/* and SHA1 */
72 #  define CONFIG_SHA256		/* and SHA256 */
73 #  define IMAGE_ENABLE_CRC32	1
74 #  define IMAGE_ENABLE_MD5	1
75 #  define IMAGE_ENABLE_SHA1	1
76 #  define IMAGE_ENABLE_SHA256	1
77 # endif
78 
79 #ifdef CONFIG_FIT_DISABLE_SHA256
80 #undef CONFIG_SHA256
81 #undef IMAGE_ENABLE_SHA256
82 #endif
83 
84 #ifndef IMAGE_ENABLE_CRC32
85 #define IMAGE_ENABLE_CRC32	0
86 #endif
87 
88 #ifndef IMAGE_ENABLE_MD5
89 #define IMAGE_ENABLE_MD5	0
90 #endif
91 
92 #ifndef IMAGE_ENABLE_SHA1
93 #define IMAGE_ENABLE_SHA1	0
94 #endif
95 
96 #ifndef IMAGE_ENABLE_SHA256
97 #define IMAGE_ENABLE_SHA256	0
98 #endif
99 
100 #endif /* IMAGE_ENABLE_FIT */
101 
102 #ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH
103 # define IMAGE_ENABLE_RAMDISK_HIGH	1
104 #else
105 # define IMAGE_ENABLE_RAMDISK_HIGH	0
106 #endif
107 
108 #ifdef CONFIG_SYS_BOOT_GET_CMDLINE
109 # define IMAGE_BOOT_GET_CMDLINE		1
110 #else
111 # define IMAGE_BOOT_GET_CMDLINE		0
112 #endif
113 
114 #ifdef CONFIG_OF_BOARD_SETUP
115 # define IMAGE_OF_BOARD_SETUP		1
116 #else
117 # define IMAGE_OF_BOARD_SETUP		0
118 #endif
119 
120 #ifdef CONFIG_OF_SYSTEM_SETUP
121 # define IMAGE_OF_SYSTEM_SETUP	1
122 #else
123 # define IMAGE_OF_SYSTEM_SETUP	0
124 #endif
125 
126 enum ih_category {
127 	IH_ARCH,
128 	IH_COMP,
129 	IH_OS,
130 	IH_TYPE,
131 
132 	IH_COUNT,
133 };
134 
135 /*
136  * Operating System Codes
137  *
138  * The following are exposed to uImage header.
139  * Do not change values for backward compatibility.
140  */
141 enum {
142 	IH_OS_INVALID		= 0,	/* Invalid OS	*/
143 	IH_OS_OPENBSD,			/* OpenBSD	*/
144 	IH_OS_NETBSD,			/* NetBSD	*/
145 	IH_OS_FREEBSD,			/* FreeBSD	*/
146 	IH_OS_4_4BSD,			/* 4.4BSD	*/
147 	IH_OS_LINUX,			/* Linux	*/
148 	IH_OS_SVR4,			/* SVR4		*/
149 	IH_OS_ESIX,			/* Esix		*/
150 	IH_OS_SOLARIS,			/* Solaris	*/
151 	IH_OS_IRIX,			/* Irix		*/
152 	IH_OS_SCO,			/* SCO		*/
153 	IH_OS_DELL,			/* Dell		*/
154 	IH_OS_NCR,			/* NCR		*/
155 	IH_OS_LYNXOS,			/* LynxOS	*/
156 	IH_OS_VXWORKS,			/* VxWorks	*/
157 	IH_OS_PSOS,			/* pSOS		*/
158 	IH_OS_QNX,			/* QNX		*/
159 	IH_OS_U_BOOT,			/* Firmware	*/
160 	IH_OS_RTEMS,			/* RTEMS	*/
161 	IH_OS_ARTOS,			/* ARTOS	*/
162 	IH_OS_UNITY,			/* Unity OS	*/
163 	IH_OS_INTEGRITY,		/* INTEGRITY	*/
164 	IH_OS_OSE,			/* OSE		*/
165 	IH_OS_PLAN9,			/* Plan 9	*/
166 	IH_OS_OPENRTOS,		/* OpenRTOS	*/
167 
168 	IH_OS_COUNT,
169 };
170 
171 /*
172  * CPU Architecture Codes (supported by Linux)
173  *
174  * The following are exposed to uImage header.
175  * Do not change values for backward compatibility.
176  */
177 enum {
178 	IH_ARCH_INVALID		= 0,	/* Invalid CPU	*/
179 	IH_ARCH_ALPHA,			/* Alpha	*/
180 	IH_ARCH_ARM,			/* ARM		*/
181 	IH_ARCH_I386,			/* Intel x86	*/
182 	IH_ARCH_IA64,			/* IA64		*/
183 	IH_ARCH_MIPS,			/* MIPS		*/
184 	IH_ARCH_MIPS64,			/* MIPS	 64 Bit */
185 	IH_ARCH_PPC,			/* PowerPC	*/
186 	IH_ARCH_S390,			/* IBM S390	*/
187 	IH_ARCH_SH,			/* SuperH	*/
188 	IH_ARCH_SPARC,			/* Sparc	*/
189 	IH_ARCH_SPARC64,		/* Sparc 64 Bit */
190 	IH_ARCH_M68K,			/* M68K		*/
191 	IH_ARCH_NIOS,			/* Nios-32	*/
192 	IH_ARCH_MICROBLAZE,		/* MicroBlaze   */
193 	IH_ARCH_NIOS2,			/* Nios-II	*/
194 	IH_ARCH_BLACKFIN,		/* Blackfin	*/
195 	IH_ARCH_AVR32,			/* AVR32	*/
196 	IH_ARCH_ST200,			/* STMicroelectronics ST200  */
197 	IH_ARCH_SANDBOX,		/* Sandbox architecture (test only) */
198 	IH_ARCH_NDS32,			/* ANDES Technology - NDS32  */
199 	IH_ARCH_OPENRISC,		/* OpenRISC 1000  */
200 	IH_ARCH_ARM64,			/* ARM64	*/
201 	IH_ARCH_ARC,			/* Synopsys DesignWare ARC */
202 	IH_ARCH_X86_64,			/* AMD x86_64, Intel and Via */
203 
204 	IH_ARCH_COUNT,
205 };
206 
207 /*
208  * Image Types
209  *
210  * "Standalone Programs" are directly runnable in the environment
211  *	provided by U-Boot; it is expected that (if they behave
212  *	well) you can continue to work in U-Boot after return from
213  *	the Standalone Program.
214  * "OS Kernel Images" are usually images of some Embedded OS which
215  *	will take over control completely. Usually these programs
216  *	will install their own set of exception handlers, device
217  *	drivers, set up the MMU, etc. - this means, that you cannot
218  *	expect to re-enter U-Boot except by resetting the CPU.
219  * "RAMDisk Images" are more or less just data blocks, and their
220  *	parameters (address, size) are passed to an OS kernel that is
221  *	being started.
222  * "Multi-File Images" contain several images, typically an OS
223  *	(Linux) kernel image and one or more data images like
224  *	RAMDisks. This construct is useful for instance when you want
225  *	to boot over the network using BOOTP etc., where the boot
226  *	server provides just a single image file, but you want to get
227  *	for instance an OS kernel and a RAMDisk image.
228  *
229  *	"Multi-File Images" start with a list of image sizes, each
230  *	image size (in bytes) specified by an "uint32_t" in network
231  *	byte order. This list is terminated by an "(uint32_t)0".
232  *	Immediately after the terminating 0 follow the images, one by
233  *	one, all aligned on "uint32_t" boundaries (size rounded up to
234  *	a multiple of 4 bytes - except for the last file).
235  *
236  * "Firmware Images" are binary images containing firmware (like
237  *	U-Boot or FPGA images) which usually will be programmed to
238  *	flash memory.
239  *
240  * "Script files" are command sequences that will be executed by
241  *	U-Boot's command interpreter; this feature is especially
242  *	useful when you configure U-Boot to use a real shell (hush)
243  *	as command interpreter (=> Shell Scripts).
244  *
245  * The following are exposed to uImage header.
246  * Do not change values for backward compatibility.
247  */
248 
249 enum {
250 	IH_TYPE_INVALID		= 0,	/* Invalid Image		*/
251 	IH_TYPE_STANDALONE,		/* Standalone Program		*/
252 	IH_TYPE_KERNEL,			/* OS Kernel Image		*/
253 	IH_TYPE_RAMDISK,		/* RAMDisk Image		*/
254 	IH_TYPE_MULTI,			/* Multi-File Image		*/
255 	IH_TYPE_FIRMWARE,		/* Firmware Image		*/
256 	IH_TYPE_SCRIPT,			/* Script file			*/
257 	IH_TYPE_FILESYSTEM,		/* Filesystem Image (any type)	*/
258 	IH_TYPE_FLATDT,			/* Binary Flat Device Tree Blob	*/
259 	IH_TYPE_KWBIMAGE,		/* Kirkwood Boot Image		*/
260 	IH_TYPE_IMXIMAGE,		/* Freescale IMXBoot Image	*/
261 	IH_TYPE_UBLIMAGE,		/* Davinci UBL Image		*/
262 	IH_TYPE_OMAPIMAGE,		/* TI OMAP Config Header Image	*/
263 	IH_TYPE_AISIMAGE,		/* TI Davinci AIS Image		*/
264 	/* OS Kernel Image, can run from any load address */
265 	IH_TYPE_KERNEL_NOLOAD,
266 	IH_TYPE_PBLIMAGE,		/* Freescale PBL Boot Image	*/
267 	IH_TYPE_MXSIMAGE,		/* Freescale MXSBoot Image	*/
268 	IH_TYPE_GPIMAGE,		/* TI Keystone GPHeader Image	*/
269 	IH_TYPE_ATMELIMAGE,		/* ATMEL ROM bootable Image	*/
270 	IH_TYPE_SOCFPGAIMAGE,		/* Altera SOCFPGA Preloader	*/
271 	IH_TYPE_X86_SETUP,		/* x86 setup.bin Image		*/
272 	IH_TYPE_LPC32XXIMAGE,		/* x86 setup.bin Image		*/
273 	IH_TYPE_LOADABLE,		/* A list of typeless images	*/
274 	IH_TYPE_RKIMAGE,		/* Rockchip Boot Image		*/
275 	IH_TYPE_RKSD,			/* Rockchip SD card		*/
276 	IH_TYPE_RKSPI,			/* Rockchip SPI image		*/
277 	IH_TYPE_ZYNQIMAGE,		/* Xilinx Zynq Boot Image */
278 	IH_TYPE_ZYNQMPIMAGE,		/* Xilinx ZynqMP Boot Image */
279 	IH_TYPE_FPGA,			/* FPGA Image */
280 
281 	IH_TYPE_COUNT,			/* Number of image types */
282 };
283 
284 /*
285  * Compression Types
286  *
287  * The following are exposed to uImage header.
288  * Do not change values for backward compatibility.
289  */
290 enum {
291 	IH_COMP_NONE		= 0,	/*  No	 Compression Used	*/
292 	IH_COMP_GZIP,			/* gzip	 Compression Used	*/
293 	IH_COMP_BZIP2,			/* bzip2 Compression Used	*/
294 	IH_COMP_LZMA,			/* lzma  Compression Used	*/
295 	IH_COMP_LZO,			/* lzo   Compression Used	*/
296 	IH_COMP_LZ4,			/* lz4   Compression Used	*/
297 
298 	IH_COMP_COUNT,
299 };
300 
301 #define IH_MAGIC	0x27051956	/* Image Magic Number		*/
302 #define IH_NMLEN		32	/* Image Name Length		*/
303 
304 /* Reused from common.h */
305 #define ROUND(a, b)		(((a) + (b) - 1) & ~((b) - 1))
306 
307 /*
308  * Legacy format image header,
309  * all data in network byte order (aka natural aka bigendian).
310  */
311 typedef struct image_header {
312 	__be32		ih_magic;	/* Image Header Magic Number	*/
313 	__be32		ih_hcrc;	/* Image Header CRC Checksum	*/
314 	__be32		ih_time;	/* Image Creation Timestamp	*/
315 	__be32		ih_size;	/* Image Data Size		*/
316 	__be32		ih_load;	/* Data	 Load  Address		*/
317 	__be32		ih_ep;		/* Entry Point Address		*/
318 	__be32		ih_dcrc;	/* Image Data CRC Checksum	*/
319 	uint8_t		ih_os;		/* Operating System		*/
320 	uint8_t		ih_arch;	/* CPU architecture		*/
321 	uint8_t		ih_type;	/* Image Type			*/
322 	uint8_t		ih_comp;	/* Compression Type		*/
323 	uint8_t		ih_name[IH_NMLEN];	/* Image Name		*/
324 } image_header_t;
325 
326 typedef struct image_info {
327 	ulong		start, end;		/* start/end of blob */
328 	ulong		image_start, image_len; /* start of image within blob, len of image */
329 	ulong		load;			/* load addr for the image */
330 	uint8_t		comp, type, os;		/* compression, type of image, os type */
331 	uint8_t		arch;			/* CPU architecture */
332 } image_info_t;
333 
334 /*
335  * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
336  * routines.
337  */
338 typedef struct bootm_headers {
339 	/*
340 	 * Legacy os image header, if it is a multi component image
341 	 * then boot_get_ramdisk() and get_fdt() will attempt to get
342 	 * data from second and third component accordingly.
343 	 */
344 	image_header_t	*legacy_hdr_os;		/* image header pointer */
345 	image_header_t	legacy_hdr_os_copy;	/* header copy */
346 	ulong		legacy_hdr_valid;
347 
348 #if IMAGE_ENABLE_FIT
349 	const char	*fit_uname_cfg;	/* configuration node unit name */
350 
351 	void		*fit_hdr_os;	/* os FIT image header */
352 	const char	*fit_uname_os;	/* os subimage node unit name */
353 	int		fit_noffset_os;	/* os subimage node offset */
354 
355 	void		*fit_hdr_rd;	/* init ramdisk FIT image header */
356 	const char	*fit_uname_rd;	/* init ramdisk subimage node unit name */
357 	int		fit_noffset_rd;	/* init ramdisk subimage node offset */
358 
359 	void		*fit_hdr_fdt;	/* FDT blob FIT image header */
360 	const char	*fit_uname_fdt;	/* FDT blob subimage node unit name */
361 	int		fit_noffset_fdt;/* FDT blob subimage node offset */
362 
363 	void		*fit_hdr_setup;	/* x86 setup FIT image header */
364 	const char	*fit_uname_setup; /* x86 setup subimage node name */
365 	int		fit_noffset_setup;/* x86 setup subimage node offset */
366 #endif
367 
368 #ifndef USE_HOSTCC
369 	image_info_t	os;		/* os image info */
370 	ulong		ep;		/* entry point of OS */
371 
372 	ulong		rd_start, rd_end;/* ramdisk start/end */
373 
374 	char		*ft_addr;	/* flat dev tree address */
375 	ulong		ft_len;		/* length of flat device tree */
376 
377 	ulong		initrd_start;
378 	ulong		initrd_end;
379 	ulong		cmdline_start;
380 	ulong		cmdline_end;
381 	bd_t		*kbd;
382 #endif
383 
384 	int		verify;		/* getenv("verify")[0] != 'n' */
385 
386 #define	BOOTM_STATE_START	(0x00000001)
387 #define	BOOTM_STATE_FINDOS	(0x00000002)
388 #define	BOOTM_STATE_FINDOTHER	(0x00000004)
389 #define	BOOTM_STATE_LOADOS	(0x00000008)
390 #define	BOOTM_STATE_RAMDISK	(0x00000010)
391 #define	BOOTM_STATE_FDT		(0x00000020)
392 #define	BOOTM_STATE_OS_CMDLINE	(0x00000040)
393 #define	BOOTM_STATE_OS_BD_T	(0x00000080)
394 #define	BOOTM_STATE_OS_PREP	(0x00000100)
395 #define	BOOTM_STATE_OS_FAKE_GO	(0x00000200)	/* 'Almost' run the OS */
396 #define	BOOTM_STATE_OS_GO	(0x00000400)
397 	int		state;
398 
399 #ifdef CONFIG_LMB
400 	struct lmb	lmb;		/* for memory mgmt */
401 #endif
402 } bootm_headers_t;
403 
404 extern bootm_headers_t images;
405 
406 /*
407  * Some systems (for example LWMON) have very short watchdog periods;
408  * we must make sure to split long operations like memmove() or
409  * checksum calculations into reasonable chunks.
410  */
411 #ifndef CHUNKSZ
412 #define CHUNKSZ (64 * 1024)
413 #endif
414 
415 #ifndef CHUNKSZ_CRC32
416 #define CHUNKSZ_CRC32 (64 * 1024)
417 #endif
418 
419 #ifndef CHUNKSZ_MD5
420 #define CHUNKSZ_MD5 (64 * 1024)
421 #endif
422 
423 #ifndef CHUNKSZ_SHA1
424 #define CHUNKSZ_SHA1 (64 * 1024)
425 #endif
426 
427 #define uimage_to_cpu(x)		be32_to_cpu(x)
428 #define cpu_to_uimage(x)		cpu_to_be32(x)
429 
430 /*
431  * Translation table for entries of a specific type; used by
432  * get_table_entry_id() and get_table_entry_name().
433  */
434 typedef struct table_entry {
435 	int	id;
436 	char	*sname;		/* short (input) name to find table entry */
437 	char	*lname;		/* long (output) name to print for messages */
438 } table_entry_t;
439 
440 /*
441  * get_table_entry_id() scans the translation table trying to find an
442  * entry that matches the given short name. If a matching entry is
443  * found, it's id is returned to the caller.
444  */
445 int get_table_entry_id(const table_entry_t *table,
446 		const char *table_name, const char *name);
447 /*
448  * get_table_entry_name() scans the translation table trying to find
449  * an entry that matches the given id. If a matching entry is found,
450  * its long name is returned to the caller.
451  */
452 char *get_table_entry_name(const table_entry_t *table, char *msg, int id);
453 
454 const char *genimg_get_os_name(uint8_t os);
455 
456 /**
457  * genimg_get_os_short_name() - get the short name for an OS
458  *
459  * @param os	OS (IH_OS_...)
460  * @return OS short name, or "unknown" if unknown
461  */
462 const char *genimg_get_os_short_name(uint8_t comp);
463 
464 const char *genimg_get_arch_name(uint8_t arch);
465 
466 /**
467  * genimg_get_arch_short_name() - get the short name for an architecture
468  *
469  * @param arch	Architecture type (IH_ARCH_...)
470  * @return architecture short name, or "unknown" if unknown
471  */
472 const char *genimg_get_arch_short_name(uint8_t arch);
473 
474 const char *genimg_get_type_name(uint8_t type);
475 
476 /**
477  * genimg_get_type_short_name() - get the short name for an image type
478  *
479  * @param type	Image type (IH_TYPE_...)
480  * @return image short name, or "unknown" if unknown
481  */
482 const char *genimg_get_type_short_name(uint8_t type);
483 
484 const char *genimg_get_comp_name(uint8_t comp);
485 
486 /**
487  * genimg_get_comp_short_name() - get the short name for a compression method
488  *
489  * @param comp	compression method (IH_COMP_...)
490  * @return compression method short name, or "unknown" if unknown
491  */
492 const char *genimg_get_comp_short_name(uint8_t comp);
493 
494 /**
495  * genimg_get_cat_name() - Get the name of an item in a category
496  *
497  * @category:	Category of item
498  * @id:		Item ID
499  * @return name of item, or "Unknown ..." if unknown
500  */
501 const char *genimg_get_cat_name(enum ih_category category, uint id);
502 
503 /**
504  * genimg_get_cat_short_name() - Get the short name of an item in a category
505  *
506  * @category:	Category of item
507  * @id:		Item ID
508  * @return short name of item, or "Unknown ..." if unknown
509  */
510 const char *genimg_get_cat_short_name(enum ih_category category, uint id);
511 
512 /**
513  * genimg_get_cat_count() - Get the number of items in a category
514  *
515  * @category:	Category to check
516  * @return the number of items in the category (IH_xxx_COUNT)
517  */
518 int genimg_get_cat_count(enum ih_category category);
519 
520 /**
521  * genimg_get_cat_desc() - Get the description of a category
522  *
523  * @return the description of a category, e.g. "architecture". This
524  * effectively converts the enum to a string.
525  */
526 const char *genimg_get_cat_desc(enum ih_category category);
527 
528 int genimg_get_os_id(const char *name);
529 int genimg_get_arch_id(const char *name);
530 int genimg_get_type_id(const char *name);
531 int genimg_get_comp_id(const char *name);
532 void genimg_print_size(uint32_t size);
533 
534 #if defined(CONFIG_TIMESTAMP) || defined(CONFIG_CMD_DATE) || \
535 	defined(USE_HOSTCC)
536 #define IMAGE_ENABLE_TIMESTAMP 1
537 #else
538 #define IMAGE_ENABLE_TIMESTAMP 0
539 #endif
540 void genimg_print_time(time_t timestamp);
541 
542 /* What to do with a image load address ('load = <> 'in the FIT) */
543 enum fit_load_op {
544 	FIT_LOAD_IGNORED,	/* Ignore load address */
545 	FIT_LOAD_OPTIONAL,	/* Can be provided, but optional */
546 	FIT_LOAD_OPTIONAL_NON_ZERO,	/* Optional, a value of 0 is ignored */
547 	FIT_LOAD_REQUIRED,	/* Must be provided */
548 };
549 
550 int boot_get_setup(bootm_headers_t *images, uint8_t arch, ulong *setup_start,
551 		   ulong *setup_len);
552 
553 #ifndef USE_HOSTCC
554 /* Image format types, returned by _get_format() routine */
555 #define IMAGE_FORMAT_INVALID	0x00
556 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
557 #define IMAGE_FORMAT_LEGACY	0x01	/* legacy image_header based format */
558 #endif
559 #define IMAGE_FORMAT_FIT	0x02	/* new, libfdt based format */
560 #define IMAGE_FORMAT_ANDROID	0x03	/* Android boot image */
561 
562 ulong genimg_get_kernel_addr_fit(char * const img_addr,
563 			         const char **fit_uname_config,
564 			         const char **fit_uname_kernel);
565 ulong genimg_get_kernel_addr(char * const img_addr);
566 int genimg_get_format(const void *img_addr);
567 int genimg_has_config(bootm_headers_t *images);
568 ulong genimg_get_image(ulong img_addr);
569 
570 int boot_get_fpga(int argc, char * const argv[], bootm_headers_t *images,
571 		uint8_t arch, const ulong *ld_start, ulong * const ld_len);
572 int boot_get_ramdisk(int argc, char * const argv[], bootm_headers_t *images,
573 		uint8_t arch, ulong *rd_start, ulong *rd_end);
574 
575 /**
576  * boot_get_loadable - routine to load a list of binaries to memory
577  * @argc: Ignored Argument
578  * @argv: Ignored Argument
579  * @images: pointer to the bootm images structure
580  * @arch: expected architecture for the image
581  * @ld_start: Ignored Argument
582  * @ld_len: Ignored Argument
583  *
584  * boot_get_loadable() will take the given FIT configuration, and look
585  * for a field named "loadables".  Loadables, is a list of elements in
586  * the FIT given as strings.  exe:
587  *   loadables = "linux_kernel@1", "fdt@2";
588  * this function will attempt to parse each string, and load the
589  * corresponding element from the FIT into memory.  Once placed,
590  * no aditional actions are taken.
591  *
592  * @return:
593  *     0, if only valid images or no images are found
594  *     error code, if an error occurs during fit_image_load
595  */
596 int boot_get_loadable(int argc, char * const argv[], bootm_headers_t *images,
597 		uint8_t arch, const ulong *ld_start, ulong * const ld_len);
598 #endif /* !USE_HOSTCC */
599 
600 int boot_get_setup_fit(bootm_headers_t *images, uint8_t arch,
601 		       ulong *setup_start, ulong *setup_len);
602 
603 /**
604  * fit_image_load() - load an image from a FIT
605  *
606  * This deals with all aspects of loading an image from a FIT, including
607  * selecting the right image based on configuration, verifying it, printing
608  * out progress messages, checking the type/arch/os and optionally copying it
609  * to the right load address.
610  *
611  * The property to look up is defined by image_type.
612  *
613  * @param images	Boot images structure
614  * @param addr		Address of FIT in memory
615  * @param fit_unamep	On entry this is the requested image name
616  *			(e.g. "kernel@1") or NULL to use the default. On exit
617  *			points to the selected image name
618  * @param fit_uname_configp	On entry this is the requested configuration
619  *			name (e.g. "conf@1") or NULL to use the default. On
620  *			exit points to the selected configuration name.
621  * @param arch		Expected architecture (IH_ARCH_...)
622  * @param image_type	Required image type (IH_TYPE_...). If this is
623  *			IH_TYPE_KERNEL then we allow IH_TYPE_KERNEL_NOLOAD
624  *			also.
625  * @param bootstage_id	ID of starting bootstage to use for progress updates.
626  *			This will be added to the BOOTSTAGE_SUB values when
627  *			calling bootstage_mark()
628  * @param load_op	Decribes what to do with the load address
629  * @param datap		Returns address of loaded image
630  * @param lenp		Returns length of loaded image
631  * @return node offset of image, or -ve error code on error
632  */
633 int fit_image_load(bootm_headers_t *images, ulong addr,
634 		   const char **fit_unamep, const char **fit_uname_configp,
635 		   int arch, int image_type, int bootstage_id,
636 		   enum fit_load_op load_op, ulong *datap, ulong *lenp);
637 
638 #ifndef USE_HOSTCC
639 /**
640  * fit_get_node_from_config() - Look up an image a FIT by type
641  *
642  * This looks in the selected conf@ node (images->fit_uname_cfg) for a
643  * particular image type (e.g. "kernel") and then finds the image that is
644  * referred to.
645  *
646  * For example, for something like:
647  *
648  * images {
649  *	kernel@1 {
650  *		...
651  *	};
652  * };
653  * configurations {
654  *	conf@1 {
655  *		kernel = "kernel@1";
656  *	};
657  * };
658  *
659  * the function will return the node offset of the kernel@1 node, assuming
660  * that conf@1 is the chosen configuration.
661  *
662  * @param images	Boot images structure
663  * @param prop_name	Property name to look up (FIT_..._PROP)
664  * @param addr		Address of FIT in memory
665  */
666 int fit_get_node_from_config(bootm_headers_t *images, const char *prop_name,
667 			ulong addr);
668 
669 int boot_get_fdt(int flag, int argc, char * const argv[], uint8_t arch,
670 		 bootm_headers_t *images,
671 		 char **of_flat_tree, ulong *of_size);
672 void boot_fdt_add_mem_rsv_regions(struct lmb *lmb, void *fdt_blob);
673 int boot_relocate_fdt(struct lmb *lmb, char **of_flat_tree, ulong *of_size);
674 
675 int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len,
676 		  ulong *initrd_start, ulong *initrd_end);
677 int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end);
678 #ifdef CONFIG_SYS_BOOT_GET_KBD
679 int boot_get_kbd(struct lmb *lmb, bd_t **kbd);
680 #endif /* CONFIG_SYS_BOOT_GET_KBD */
681 #endif /* !USE_HOSTCC */
682 
683 /*******************************************************************/
684 /* Legacy format specific code (prefixed with image_) */
685 /*******************************************************************/
686 static inline uint32_t image_get_header_size(void)
687 {
688 	return (sizeof(image_header_t));
689 }
690 
691 #define image_get_hdr_l(f) \
692 	static inline uint32_t image_get_##f(const image_header_t *hdr) \
693 	{ \
694 		return uimage_to_cpu(hdr->ih_##f); \
695 	}
696 image_get_hdr_l(magic)		/* image_get_magic */
697 image_get_hdr_l(hcrc)		/* image_get_hcrc */
698 image_get_hdr_l(time)		/* image_get_time */
699 image_get_hdr_l(size)		/* image_get_size */
700 image_get_hdr_l(load)		/* image_get_load */
701 image_get_hdr_l(ep)		/* image_get_ep */
702 image_get_hdr_l(dcrc)		/* image_get_dcrc */
703 
704 #define image_get_hdr_b(f) \
705 	static inline uint8_t image_get_##f(const image_header_t *hdr) \
706 	{ \
707 		return hdr->ih_##f; \
708 	}
709 image_get_hdr_b(os)		/* image_get_os */
710 image_get_hdr_b(arch)		/* image_get_arch */
711 image_get_hdr_b(type)		/* image_get_type */
712 image_get_hdr_b(comp)		/* image_get_comp */
713 
714 static inline char *image_get_name(const image_header_t *hdr)
715 {
716 	return (char *)hdr->ih_name;
717 }
718 
719 static inline uint32_t image_get_data_size(const image_header_t *hdr)
720 {
721 	return image_get_size(hdr);
722 }
723 
724 /**
725  * image_get_data - get image payload start address
726  * @hdr: image header
727  *
728  * image_get_data() returns address of the image payload. For single
729  * component images it is image data start. For multi component
730  * images it points to the null terminated table of sub-images sizes.
731  *
732  * returns:
733  *     image payload data start address
734  */
735 static inline ulong image_get_data(const image_header_t *hdr)
736 {
737 	return ((ulong)hdr + image_get_header_size());
738 }
739 
740 static inline uint32_t image_get_image_size(const image_header_t *hdr)
741 {
742 	return (image_get_size(hdr) + image_get_header_size());
743 }
744 static inline ulong image_get_image_end(const image_header_t *hdr)
745 {
746 	return ((ulong)hdr + image_get_image_size(hdr));
747 }
748 
749 #define image_set_hdr_l(f) \
750 	static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
751 	{ \
752 		hdr->ih_##f = cpu_to_uimage(val); \
753 	}
754 image_set_hdr_l(magic)		/* image_set_magic */
755 image_set_hdr_l(hcrc)		/* image_set_hcrc */
756 image_set_hdr_l(time)		/* image_set_time */
757 image_set_hdr_l(size)		/* image_set_size */
758 image_set_hdr_l(load)		/* image_set_load */
759 image_set_hdr_l(ep)		/* image_set_ep */
760 image_set_hdr_l(dcrc)		/* image_set_dcrc */
761 
762 #define image_set_hdr_b(f) \
763 	static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
764 	{ \
765 		hdr->ih_##f = val; \
766 	}
767 image_set_hdr_b(os)		/* image_set_os */
768 image_set_hdr_b(arch)		/* image_set_arch */
769 image_set_hdr_b(type)		/* image_set_type */
770 image_set_hdr_b(comp)		/* image_set_comp */
771 
772 static inline void image_set_name(image_header_t *hdr, const char *name)
773 {
774 	strncpy(image_get_name(hdr), name, IH_NMLEN);
775 }
776 
777 int image_check_hcrc(const image_header_t *hdr);
778 int image_check_dcrc(const image_header_t *hdr);
779 #ifndef USE_HOSTCC
780 ulong getenv_bootm_low(void);
781 phys_size_t getenv_bootm_size(void);
782 phys_size_t getenv_bootm_mapsize(void);
783 #endif
784 void memmove_wd(void *to, void *from, size_t len, ulong chunksz);
785 
786 static inline int image_check_magic(const image_header_t *hdr)
787 {
788 	return (image_get_magic(hdr) == IH_MAGIC);
789 }
790 static inline int image_check_type(const image_header_t *hdr, uint8_t type)
791 {
792 	return (image_get_type(hdr) == type);
793 }
794 static inline int image_check_arch(const image_header_t *hdr, uint8_t arch)
795 {
796 	return (image_get_arch(hdr) == arch);
797 }
798 static inline int image_check_os(const image_header_t *hdr, uint8_t os)
799 {
800 	return (image_get_os(hdr) == os);
801 }
802 
803 ulong image_multi_count(const image_header_t *hdr);
804 void image_multi_getimg(const image_header_t *hdr, ulong idx,
805 			ulong *data, ulong *len);
806 
807 void image_print_contents(const void *hdr);
808 
809 #ifndef USE_HOSTCC
810 static inline int image_check_target_arch(const image_header_t *hdr)
811 {
812 #ifndef IH_ARCH_DEFAULT
813 # error "please define IH_ARCH_DEFAULT in your arch asm/u-boot.h"
814 #endif
815 	return image_check_arch(hdr, IH_ARCH_DEFAULT);
816 }
817 #endif /* USE_HOSTCC */
818 
819 /**
820  * Set up properties in the FDT
821  *
822  * This sets up properties in the FDT that is to be passed to linux.
823  *
824  * @images:	Images information
825  * @blob:	FDT to update
826  * @of_size:	Size of the FDT
827  * @lmb:	Points to logical memory block structure
828  * @return 0 if ok, <0 on failure
829  */
830 int image_setup_libfdt(bootm_headers_t *images, void *blob,
831 		       int of_size, struct lmb *lmb);
832 
833 /**
834  * Set up the FDT to use for booting a kernel
835  *
836  * This performs ramdisk setup, sets up the FDT if required, and adds
837  * paramters to the FDT if libfdt is available.
838  *
839  * @param images	Images information
840  * @return 0 if ok, <0 on failure
841  */
842 int image_setup_linux(bootm_headers_t *images);
843 
844 /**
845  * bootz_setup() - Extract stat and size of a Linux xImage
846  *
847  * @image: Address of image
848  * @start: Returns start address of image
849  * @end : Returns end address of image
850  * @return 0 if OK, 1 if the image was not recognised
851  */
852 int bootz_setup(ulong image, ulong *start, ulong *end);
853 
854 
855 /*******************************************************************/
856 /* New uImage format specific code (prefixed with fit_) */
857 /*******************************************************************/
858 
859 #define FIT_IMAGES_PATH		"/images"
860 #define FIT_CONFS_PATH		"/configurations"
861 
862 /* hash/signature node */
863 #define FIT_HASH_NODENAME	"hash"
864 #define FIT_ALGO_PROP		"algo"
865 #define FIT_VALUE_PROP		"value"
866 #define FIT_IGNORE_PROP		"uboot-ignore"
867 #define FIT_SIG_NODENAME	"signature"
868 
869 /* image node */
870 #define FIT_DATA_PROP		"data"
871 #define FIT_TIMESTAMP_PROP	"timestamp"
872 #define FIT_DESC_PROP		"description"
873 #define FIT_ARCH_PROP		"arch"
874 #define FIT_TYPE_PROP		"type"
875 #define FIT_OS_PROP		"os"
876 #define FIT_COMP_PROP		"compression"
877 #define FIT_ENTRY_PROP		"entry"
878 #define FIT_LOAD_PROP		"load"
879 
880 /* configuration node */
881 #define FIT_KERNEL_PROP		"kernel"
882 #define FIT_RAMDISK_PROP	"ramdisk"
883 #define FIT_FDT_PROP		"fdt"
884 #define FIT_LOADABLE_PROP	"loadables"
885 #define FIT_DEFAULT_PROP	"default"
886 #define FIT_SETUP_PROP		"setup"
887 #define FIT_FPGA_PROP		"fpga"
888 
889 #define FIT_MAX_HASH_LEN	HASH_MAX_DIGEST_SIZE
890 
891 #if IMAGE_ENABLE_FIT
892 /* cmdline argument format parsing */
893 int fit_parse_conf(const char *spec, ulong addr_curr,
894 		ulong *addr, const char **conf_name);
895 int fit_parse_subimage(const char *spec, ulong addr_curr,
896 		ulong *addr, const char **image_name);
897 
898 int fit_get_subimage_count(const void *fit, int images_noffset);
899 void fit_print_contents(const void *fit);
900 void fit_image_print(const void *fit, int noffset, const char *p);
901 
902 /**
903  * fit_get_end - get FIT image size
904  * @fit: pointer to the FIT format image header
905  *
906  * returns:
907  *     size of the FIT image (blob) in memory
908  */
909 static inline ulong fit_get_size(const void *fit)
910 {
911 	return fdt_totalsize(fit);
912 }
913 
914 /**
915  * fit_get_end - get FIT image end
916  * @fit: pointer to the FIT format image header
917  *
918  * returns:
919  *     end address of the FIT image (blob) in memory
920  */
921 ulong fit_get_end(const void *fit);
922 
923 /**
924  * fit_get_name - get FIT node name
925  * @fit: pointer to the FIT format image header
926  *
927  * returns:
928  *     NULL, on error
929  *     pointer to node name, on success
930  */
931 static inline const char *fit_get_name(const void *fit_hdr,
932 		int noffset, int *len)
933 {
934 	return fdt_get_name(fit_hdr, noffset, len);
935 }
936 
937 int fit_get_desc(const void *fit, int noffset, char **desc);
938 int fit_get_timestamp(const void *fit, int noffset, time_t *timestamp);
939 
940 int fit_image_get_node(const void *fit, const char *image_uname);
941 int fit_image_get_os(const void *fit, int noffset, uint8_t *os);
942 int fit_image_get_arch(const void *fit, int noffset, uint8_t *arch);
943 int fit_image_get_type(const void *fit, int noffset, uint8_t *type);
944 int fit_image_get_comp(const void *fit, int noffset, uint8_t *comp);
945 int fit_image_get_load(const void *fit, int noffset, ulong *load);
946 int fit_image_get_entry(const void *fit, int noffset, ulong *entry);
947 int fit_image_get_data(const void *fit, int noffset,
948 				const void **data, size_t *size);
949 
950 int fit_image_hash_get_algo(const void *fit, int noffset, char **algo);
951 int fit_image_hash_get_value(const void *fit, int noffset, uint8_t **value,
952 				int *value_len);
953 
954 int fit_set_timestamp(void *fit, int noffset, time_t timestamp);
955 
956 /**
957  * fit_add_verification_data() - add verification data to FIT image nodes
958  *
959  * @keydir:	Directory containing keys
960  * @kwydest:	FDT blob to write public key information to
961  * @fit:	Pointer to the FIT format image header
962  * @comment:	Comment to add to signature nodes
963  * @require_keys: Mark all keys as 'required'
964  *
965  * Adds hash values for all component images in the FIT blob.
966  * Hashes are calculated for all component images which have hash subnodes
967  * with algorithm property set to one of the supported hash algorithms.
968  *
969  * Also add signatures if signature nodes are present.
970  *
971  * returns
972  *     0, on success
973  *     libfdt error code, on failure
974  */
975 int fit_add_verification_data(const char *keydir, void *keydest, void *fit,
976 			      const char *comment, int require_keys);
977 
978 int fit_image_verify(const void *fit, int noffset);
979 int fit_config_verify(const void *fit, int conf_noffset);
980 int fit_all_image_verify(const void *fit);
981 int fit_image_check_os(const void *fit, int noffset, uint8_t os);
982 int fit_image_check_arch(const void *fit, int noffset, uint8_t arch);
983 int fit_image_check_type(const void *fit, int noffset, uint8_t type);
984 int fit_image_check_comp(const void *fit, int noffset, uint8_t comp);
985 int fit_check_format(const void *fit);
986 
987 int fit_conf_find_compat(const void *fit, const void *fdt);
988 int fit_conf_get_node(const void *fit, const char *conf_uname);
989 
990 /**
991  * fit_conf_get_prop_node() - Get node refered to by a configuration
992  * @fit:	FIT to check
993  * @noffset:	Offset of conf@xxx node to check
994  * @prop_name:	Property to read from the conf node
995  *
996  * The conf@ nodes contain references to other nodes, using properties
997  * like 'kernel = "kernel@1"'. Given such a property name (e.g. "kernel"),
998  * return the offset of the node referred to (e.g. offset of node
999  * "/images/kernel@1".
1000  */
1001 int fit_conf_get_prop_node(const void *fit, int noffset,
1002 		const char *prop_name);
1003 
1004 void fit_conf_print(const void *fit, int noffset, const char *p);
1005 
1006 int fit_check_ramdisk(const void *fit, int os_noffset,
1007 		uint8_t arch, int verify);
1008 
1009 int calculate_hash(const void *data, int data_len, const char *algo,
1010 			uint8_t *value, int *value_len);
1011 
1012 /*
1013  * At present we only support signing on the host, and verification on the
1014  * device
1015  */
1016 #if defined(CONFIG_FIT_SIGNATURE)
1017 # ifdef USE_HOSTCC
1018 #  define IMAGE_ENABLE_SIGN	1
1019 #  define IMAGE_ENABLE_VERIFY	1
1020 # include  <openssl/evp.h>
1021 #else
1022 #  define IMAGE_ENABLE_SIGN	0
1023 #  define IMAGE_ENABLE_VERIFY	1
1024 # endif
1025 #else
1026 # define IMAGE_ENABLE_SIGN	0
1027 # define IMAGE_ENABLE_VERIFY	0
1028 #endif
1029 
1030 #ifdef USE_HOSTCC
1031 void *image_get_host_blob(void);
1032 void image_set_host_blob(void *host_blob);
1033 # define gd_fdt_blob()		image_get_host_blob()
1034 #else
1035 # define gd_fdt_blob()		(gd->fdt_blob)
1036 #endif
1037 
1038 #ifdef CONFIG_FIT_BEST_MATCH
1039 #define IMAGE_ENABLE_BEST_MATCH	1
1040 #else
1041 #define IMAGE_ENABLE_BEST_MATCH	0
1042 #endif
1043 
1044 /* Information passed to the signing routines */
1045 struct image_sign_info {
1046 	const char *keydir;		/* Directory conaining keys */
1047 	const char *keyname;		/* Name of key to use */
1048 	void *fit;			/* Pointer to FIT blob */
1049 	int node_offset;		/* Offset of signature node */
1050 	struct image_sig_algo *algo;	/* Algorithm information */
1051 	const void *fdt_blob;		/* FDT containing public keys */
1052 	int required_keynode;		/* Node offset of key to use: -1=any */
1053 	const char *require_keys;	/* Value for 'required' property */
1054 };
1055 #endif /* Allow struct image_region to always be defined for rsa.h */
1056 
1057 /* A part of an image, used for hashing */
1058 struct image_region {
1059 	const void *data;
1060 	int size;
1061 };
1062 
1063 #if IMAGE_ENABLE_FIT
1064 
1065 #if IMAGE_ENABLE_VERIFY
1066 # include <u-boot/rsa-checksum.h>
1067 #endif
1068 struct checksum_algo {
1069 	const char *name;
1070 	const int checksum_len;
1071 	const int pad_len;
1072 #if IMAGE_ENABLE_SIGN
1073 	const EVP_MD *(*calculate_sign)(void);
1074 #endif
1075 	int (*calculate)(const char *name,
1076 			 const struct image_region region[],
1077 			 int region_count, uint8_t *checksum);
1078 	const uint8_t *rsa_padding;
1079 };
1080 
1081 struct image_sig_algo {
1082 	const char *name;		/* Name of algorithm */
1083 
1084 	/**
1085 	 * sign() - calculate and return signature for given input data
1086 	 *
1087 	 * @info:	Specifies key and FIT information
1088 	 * @data:	Pointer to the input data
1089 	 * @data_len:	Data length
1090 	 * @sigp:	Set to an allocated buffer holding the signature
1091 	 * @sig_len:	Set to length of the calculated hash
1092 	 *
1093 	 * This computes input data signature according to selected algorithm.
1094 	 * Resulting signature value is placed in an allocated buffer, the
1095 	 * pointer is returned as *sigp. The length of the calculated
1096 	 * signature is returned via the sig_len pointer argument. The caller
1097 	 * should free *sigp.
1098 	 *
1099 	 * @return: 0, on success, -ve on error
1100 	 */
1101 	int (*sign)(struct image_sign_info *info,
1102 		    const struct image_region region[],
1103 		    int region_count, uint8_t **sigp, uint *sig_len);
1104 
1105 	/**
1106 	 * add_verify_data() - Add verification information to FDT
1107 	 *
1108 	 * Add public key information to the FDT node, suitable for
1109 	 * verification at run-time. The information added depends on the
1110 	 * algorithm being used.
1111 	 *
1112 	 * @info:	Specifies key and FIT information
1113 	 * @keydest:	Destination FDT blob for public key data
1114 	 * @return: 0, on success, -ve on error
1115 	 */
1116 	int (*add_verify_data)(struct image_sign_info *info, void *keydest);
1117 
1118 	/**
1119 	 * verify() - Verify a signature against some data
1120 	 *
1121 	 * @info:	Specifies key and FIT information
1122 	 * @data:	Pointer to the input data
1123 	 * @data_len:	Data length
1124 	 * @sig:	Signature
1125 	 * @sig_len:	Number of bytes in signature
1126 	 * @return 0 if verified, -ve on error
1127 	 */
1128 	int (*verify)(struct image_sign_info *info,
1129 		      const struct image_region region[], int region_count,
1130 		      uint8_t *sig, uint sig_len);
1131 
1132 	/* pointer to checksum algorithm */
1133 	struct checksum_algo *checksum;
1134 };
1135 
1136 /**
1137  * image_get_sig_algo() - Look up a signature algortihm
1138  *
1139  * @param name		Name of algorithm
1140  * @return pointer to algorithm information, or NULL if not found
1141  */
1142 struct image_sig_algo *image_get_sig_algo(const char *name);
1143 
1144 /**
1145  * fit_image_verify_required_sigs() - Verify signatures marked as 'required'
1146  *
1147  * @fit:		FIT to check
1148  * @image_noffset:	Offset of image node to check
1149  * @data:		Image data to check
1150  * @size:		Size of image data
1151  * @sig_blob:		FDT containing public keys
1152  * @no_sigsp:		Returns 1 if no signatures were required, and
1153  *			therefore nothing was checked. The caller may wish
1154  *			to fall back to other mechanisms, or refuse to
1155  *			boot.
1156  * @return 0 if all verified ok, <0 on error
1157  */
1158 int fit_image_verify_required_sigs(const void *fit, int image_noffset,
1159 		const char *data, size_t size, const void *sig_blob,
1160 		int *no_sigsp);
1161 
1162 /**
1163  * fit_image_check_sig() - Check a single image signature node
1164  *
1165  * @fit:		FIT to check
1166  * @noffset:		Offset of signature node to check
1167  * @data:		Image data to check
1168  * @size:		Size of image data
1169  * @required_keynode:	Offset in the control FDT of the required key node,
1170  *			if any. If this is given, then the image wil not
1171  *			pass verification unless that key is used. If this is
1172  *			-1 then any signature will do.
1173  * @err_msgp:		In the event of an error, this will be pointed to a
1174  *			help error string to display to the user.
1175  * @return 0 if all verified ok, <0 on error
1176  */
1177 int fit_image_check_sig(const void *fit, int noffset, const void *data,
1178 		size_t size, int required_keynode, char **err_msgp);
1179 
1180 /**
1181  * fit_region_make_list() - Make a list of regions to hash
1182  *
1183  * Given a list of FIT regions (offset, size) provided by libfdt, create
1184  * a list of regions (void *, size) for use by the signature creationg
1185  * and verification code.
1186  *
1187  * @fit:		FIT image to process
1188  * @fdt_regions:	Regions as returned by libfdt
1189  * @count:		Number of regions returned by libfdt
1190  * @region:		Place to put list of regions (NULL to allocate it)
1191  * @return pointer to list of regions, or NULL if out of memory
1192  */
1193 struct image_region *fit_region_make_list(const void *fit,
1194 		struct fdt_region *fdt_regions, int count,
1195 		struct image_region *region);
1196 
1197 static inline int fit_image_check_target_arch(const void *fdt, int node)
1198 {
1199 #ifndef USE_HOSTCC
1200 	return fit_image_check_arch(fdt, node, IH_ARCH_DEFAULT);
1201 #else
1202 	return 0;
1203 #endif
1204 }
1205 
1206 #ifdef CONFIG_FIT_VERBOSE
1207 #define fit_unsupported(msg)	printf("! %s:%d " \
1208 				"FIT images not supported for '%s'\n", \
1209 				__FILE__, __LINE__, (msg))
1210 
1211 #define fit_unsupported_reset(msg)	printf("! %s:%d " \
1212 				"FIT images not supported for '%s' " \
1213 				"- must reset board to recover!\n", \
1214 				__FILE__, __LINE__, (msg))
1215 #else
1216 #define fit_unsupported(msg)
1217 #define fit_unsupported_reset(msg)
1218 #endif /* CONFIG_FIT_VERBOSE */
1219 #endif /* CONFIG_FIT */
1220 
1221 #if defined(CONFIG_ANDROID_BOOT_IMAGE)
1222 struct andr_img_hdr;
1223 int android_image_check_header(const struct andr_img_hdr *hdr);
1224 int android_image_get_kernel(const struct andr_img_hdr *hdr, int verify,
1225 			     ulong *os_data, ulong *os_len);
1226 int android_image_get_ramdisk(const struct andr_img_hdr *hdr,
1227 			      ulong *rd_data, ulong *rd_len);
1228 ulong android_image_get_end(const struct andr_img_hdr *hdr);
1229 ulong android_image_get_kload(const struct andr_img_hdr *hdr);
1230 void android_print_contents(const struct andr_img_hdr *hdr);
1231 
1232 #endif /* CONFIG_ANDROID_BOOT_IMAGE */
1233 
1234 /**
1235  * board_fit_config_name_match() - Check for a matching board name
1236  *
1237  * This is used when SPL loads a FIT containing multiple device tree files
1238  * and wants to work out which one to use. The description of each one is
1239  * passed to this function. The description comes from the 'description' field
1240  * in each (FDT) image node.
1241  *
1242  * @name: Device tree description
1243  * @return 0 if this device tree should be used, non-zero to try the next
1244  */
1245 int board_fit_config_name_match(const char *name);
1246 
1247 #ifdef CONFIG_SPL_FIT_IMAGE_POST_PROCESS
1248 /**
1249  * board_fit_image_post_process() - Do any post-process on FIT binary data
1250  *
1251  * This is used to do any sort of image manipulation, verification, decryption
1252  * etc. in a platform or board specific way. Obviously, anything done here would
1253  * need to be comprehended in how the images were prepared before being injected
1254  * into the FIT creation (i.e. the binary blobs would have been pre-processed
1255  * before being added to the FIT image).
1256  *
1257  * @image: pointer to the image start pointer
1258  * @size: pointer to the image size
1259  * @return no return value (failure should be handled internally)
1260  */
1261 void board_fit_image_post_process(void **p_image, size_t *p_size);
1262 #endif /* CONFIG_SPL_FIT_IMAGE_POST_PROCESS */
1263 
1264 #endif	/* __IMAGE_H__ */
1265