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