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