image.h 32.3 KB
Newer Older
wdenk's avatar
wdenk committed
1
/*
2 3
 * (C) Copyright 2008 Semihalf
 *
4
 * (C) Copyright 2000-2005
wdenk's avatar
wdenk committed
5 6
 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
 *
7
 * SPDX-License-Identifier:	GPL-2.0+
8 9 10 11 12 13
 ********************************************************************
 * NOTE: This header file defines an interface to U-Boot. Including
 * this (unmodified) header file in another file is considered normal
 * use of U-Boot, and does *not* fall under the heading of "derived
 * work".
 ********************************************************************
wdenk's avatar
wdenk committed
14 15 16 17 18
 */

#ifndef __IMAGE_H__
#define __IMAGE_H__

19
#include "compiler.h"
Kim Phillips's avatar
Kim Phillips committed
20
#include <asm/byteorder.h>
21

22 23 24
/* Define this to avoid #ifdefs later on */
struct lmb;

25
#ifdef USE_HOSTCC
26 27

/* new uImage format support enabled on host */
28 29
#define CONFIG_FIT		1
#define CONFIG_OF_LIBFDT	1
30
#define CONFIG_FIT_VERBOSE	1 /* enable fit_format_{error,warning}() */
31

32
#define IMAGE_ENABLE_IGNORE	0
33
#define IMAGE_INDENT_STRING	""
34

35 36 37 38
#else

#include <lmb.h>
#include <asm/u-boot.h>
39
#include <command.h>
40

41 42
/* Take notice of the 'ignore' property for hashes */
#define IMAGE_ENABLE_IGNORE	1
43
#define IMAGE_INDENT_STRING	"   "
44

45
#endif /* USE_HOSTCC */
46

47 48 49
#if defined(CONFIG_FIT)
#include <libfdt.h>
#include <fdt_support.h>
50 51 52 53 54 55 56 57 58 59
# ifdef CONFIG_SPL_BUILD
#  ifdef CONFIG_SPL_CRC32_SUPPORT
#   define IMAGE_ENABLE_CRC32	1
#  endif
#  ifdef CONFIG_SPL_MD5_SUPPORT
#   define IMAGE_ENABLE_MD5	1
#  endif
#  ifdef CONFIG_SPL_SHA1_SUPPORT
#   define IMAGE_ENABLE_SHA1	1
#  endif
Heiko Schocher's avatar
Heiko Schocher committed
60 61 62
#  ifdef CONFIG_SPL_SHA256_SUPPORT
#   define IMAGE_ENABLE_SHA256	1
#  endif
63 64 65 66
# else
#  define CONFIG_CRC32		/* FIT images need CRC32 support */
#  define CONFIG_MD5		/* and MD5 */
#  define CONFIG_SHA1		/* and SHA1 */
Heiko Schocher's avatar
Heiko Schocher committed
67
#  define CONFIG_SHA256		/* and SHA256 */
68 69 70
#  define IMAGE_ENABLE_CRC32	1
#  define IMAGE_ENABLE_MD5	1
#  define IMAGE_ENABLE_SHA1	1
Heiko Schocher's avatar
Heiko Schocher committed
71
#  define IMAGE_ENABLE_SHA256	1
72 73 74 75 76 77 78 79 80 81 82 83 84 85
# endif

#ifndef IMAGE_ENABLE_CRC32
#define IMAGE_ENABLE_CRC32	0
#endif

#ifndef IMAGE_ENABLE_MD5
#define IMAGE_ENABLE_MD5	0
#endif

#ifndef IMAGE_ENABLE_SHA1
#define IMAGE_ENABLE_SHA1	0
#endif

Heiko Schocher's avatar
Heiko Schocher committed
86 87 88 89
#ifndef IMAGE_ENABLE_SHA256
#define IMAGE_ENABLE_SHA256	0
#endif

90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110
#endif /* CONFIG_FIT */

#ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH
# define IMAGE_ENABLE_RAMDISK_HIGH	1
#else
# define IMAGE_ENABLE_RAMDISK_HIGH	0
#endif

#ifdef CONFIG_OF_LIBFDT
# define IMAGE_ENABLE_OF_LIBFDT	1
#else
# define IMAGE_ENABLE_OF_LIBFDT	0
#endif

#ifdef CONFIG_SYS_BOOT_GET_CMDLINE
# define IMAGE_BOOT_GET_CMDLINE		1
#else
# define IMAGE_BOOT_GET_CMDLINE		0
#endif

#ifdef CONFIG_OF_BOARD_SETUP
111
# define IMAGE_OF_BOARD_SETUP		1
112
#else
113
# define IMAGE_OF_BOARD_SETUP		0
114
#endif
115

wdenk's avatar
wdenk committed
116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136
/*
 * Operating System Codes
 */
#define IH_OS_INVALID		0	/* Invalid OS	*/
#define IH_OS_OPENBSD		1	/* OpenBSD	*/
#define IH_OS_NETBSD		2	/* NetBSD	*/
#define IH_OS_FREEBSD		3	/* FreeBSD	*/
#define IH_OS_4_4BSD		4	/* 4.4BSD	*/
#define IH_OS_LINUX		5	/* Linux	*/
#define IH_OS_SVR4		6	/* SVR4		*/
#define IH_OS_ESIX		7	/* Esix		*/
#define IH_OS_SOLARIS		8	/* Solaris	*/
#define IH_OS_IRIX		9	/* Irix		*/
#define IH_OS_SCO		10	/* SCO		*/
#define IH_OS_DELL		11	/* Dell		*/
#define IH_OS_NCR		12	/* NCR		*/
#define IH_OS_LYNXOS		13	/* LynxOS	*/
#define IH_OS_VXWORKS		14	/* VxWorks	*/
#define IH_OS_PSOS		15	/* pSOS		*/
#define IH_OS_QNX		16	/* QNX		*/
#define IH_OS_U_BOOT		17	/* Firmware	*/
137
#define IH_OS_RTEMS		18	/* RTEMS	*/
138
#define IH_OS_ARTOS		19	/* ARTOS	*/
139
#define IH_OS_UNITY		20	/* Unity OS	*/
140
#define IH_OS_INTEGRITY		21	/* INTEGRITY	*/
141
#define IH_OS_OSE		22	/* OSE		*/
142
#define IH_OS_PLAN9		23	/* Plan 9	*/
wdenk's avatar
wdenk committed
143 144 145 146

/*
 * CPU Architecture Codes (supported by Linux)
 */
147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164
#define IH_ARCH_INVALID		0	/* Invalid CPU	*/
#define IH_ARCH_ALPHA		1	/* Alpha	*/
#define IH_ARCH_ARM		2	/* ARM		*/
#define IH_ARCH_I386		3	/* Intel x86	*/
#define IH_ARCH_IA64		4	/* IA64		*/
#define IH_ARCH_MIPS		5	/* MIPS		*/
#define IH_ARCH_MIPS64		6	/* MIPS	 64 Bit */
#define IH_ARCH_PPC		7	/* PowerPC	*/
#define IH_ARCH_S390		8	/* IBM S390	*/
#define IH_ARCH_SH		9	/* SuperH	*/
#define IH_ARCH_SPARC		10	/* Sparc	*/
#define IH_ARCH_SPARC64		11	/* Sparc 64 Bit */
#define IH_ARCH_M68K		12	/* M68K		*/
#define IH_ARCH_MICROBLAZE	14	/* MicroBlaze   */
#define IH_ARCH_NIOS2		15	/* Nios-II	*/
#define IH_ARCH_BLACKFIN	16	/* Blackfin	*/
#define IH_ARCH_AVR32		17	/* AVR32	*/
#define IH_ARCH_ST200	        18	/* STMicroelectronics ST200  */
165
#define IH_ARCH_SANDBOX		19	/* Sandbox architecture (test only) */
166
#define IH_ARCH_NDS32	        20	/* ANDES Technology - NDS32  */
167
#define IH_ARCH_OPENRISC        21	/* OpenRISC 1000  */
David Feng's avatar
David Feng committed
168
#define IH_ARCH_ARM64		22	/* ARM64	*/
169
#define IH_ARCH_ARC		23	/* Synopsys DesignWare ARC */
wdenk's avatar
wdenk committed
170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197

/*
 * Image Types
 *
 * "Standalone Programs" are directly runnable in the environment
 *	provided by U-Boot; it is expected that (if they behave
 *	well) you can continue to work in U-Boot after return from
 *	the Standalone Program.
 * "OS Kernel Images" are usually images of some Embedded OS which
 *	will take over control completely. Usually these programs
 *	will install their own set of exception handlers, device
 *	drivers, set up the MMU, etc. - this means, that you cannot
 *	expect to re-enter U-Boot except by resetting the CPU.
 * "RAMDisk Images" are more or less just data blocks, and their
 *	parameters (address, size) are passed to an OS kernel that is
 *	being started.
 * "Multi-File Images" contain several images, typically an OS
 *	(Linux) kernel image and one or more data images like
 *	RAMDisks. This construct is useful for instance when you want
 *	to boot over the network using BOOTP etc., where the boot
 *	server provides just a single image file, but you want to get
 *	for instance an OS kernel and a RAMDisk image.
 *
 *	"Multi-File Images" start with a list of image sizes, each
 *	image size (in bytes) specified by an "uint32_t" in network
 *	byte order. This list is terminated by an "(uint32_t)0".
 *	Immediately after the terminating 0 follow the images, one by
 *	one, all aligned on "uint32_t" boundaries (size rounded up to
198
 *	a multiple of 4 bytes - except for the last file).
wdenk's avatar
wdenk committed
199 200 201 202 203 204 205 206
 *
 * "Firmware Images" are binary images containing firmware (like
 *	U-Boot or FPGA images) which usually will be programmed to
 *	flash memory.
 *
 * "Script files" are command sequences that will be executed by
 *	U-Boot's command interpreter; this feature is especially
 *	useful when you configure U-Boot to use a real shell (hush)
207
 *	as command interpreter (=> Shell Scripts).
wdenk's avatar
wdenk committed
208 209 210 211 212 213 214 215 216
 */

#define IH_TYPE_INVALID		0	/* Invalid Image		*/
#define IH_TYPE_STANDALONE	1	/* Standalone Program		*/
#define IH_TYPE_KERNEL		2	/* OS Kernel Image		*/
#define IH_TYPE_RAMDISK		3	/* RAMDisk Image		*/
#define IH_TYPE_MULTI		4	/* Multi-File Image		*/
#define IH_TYPE_FIRMWARE	5	/* Firmware Image		*/
#define IH_TYPE_SCRIPT		6	/* Script file			*/
wdenk's avatar
wdenk committed
217
#define IH_TYPE_FILESYSTEM	7	/* Filesystem Image (any type)	*/
218
#define IH_TYPE_FLATDT		8	/* Binary Flat Device Tree Blob	*/
219
#define IH_TYPE_KWBIMAGE	9	/* Kirkwood Boot Image		*/
220
#define IH_TYPE_IMXIMAGE	10	/* Freescale IMXBoot Image	*/
221
#define IH_TYPE_UBLIMAGE	11	/* Davinci UBL Image		*/
222
#define IH_TYPE_OMAPIMAGE	12	/* TI OMAP Config Header Image	*/
223
#define IH_TYPE_AISIMAGE	13	/* TI Davinci AIS Image		*/
224
#define IH_TYPE_KERNEL_NOLOAD	14	/* OS Kernel Image, can run from any load address */
225
#define IH_TYPE_PBLIMAGE	15	/* Freescale PBL Boot Image	*/
226
#define IH_TYPE_MXSIMAGE	16	/* Freescale MXSBoot Image	*/
wdenk's avatar
wdenk committed
227 228 229 230 231 232 233

/*
 * Compression Types
 */
#define IH_COMP_NONE		0	/*  No	 Compression Used	*/
#define IH_COMP_GZIP		1	/* gzip	 Compression Used	*/
#define IH_COMP_BZIP2		2	/* bzip2 Compression Used	*/
234
#define IH_COMP_LZMA		3	/* lzma  Compression Used	*/
235
#define IH_COMP_LZO		4	/* lzo   Compression Used	*/
wdenk's avatar
wdenk committed
236 237 238 239

#define IH_MAGIC	0x27051956	/* Image Magic Number		*/
#define IH_NMLEN		32	/* Image Name Length		*/

240 241 242
/* Reused from common.h */
#define ROUND(a, b)		(((a) + (b) - 1) & ~((b) - 1))

wdenk's avatar
wdenk committed
243
/*
244 245
 * Legacy format image header,
 * all data in network byte order (aka natural aka bigendian).
wdenk's avatar
wdenk committed
246 247
 */
typedef struct image_header {
Kim Phillips's avatar
Kim Phillips committed
248 249 250 251 252 253 254
	__be32		ih_magic;	/* Image Header Magic Number	*/
	__be32		ih_hcrc;	/* Image Header CRC Checksum	*/
	__be32		ih_time;	/* Image Creation Timestamp	*/
	__be32		ih_size;	/* Image Data Size		*/
	__be32		ih_load;	/* Data	 Load  Address		*/
	__be32		ih_ep;		/* Entry Point Address		*/
	__be32		ih_dcrc;	/* Image Data CRC Checksum	*/
wdenk's avatar
wdenk committed
255 256 257 258 259 260 261
	uint8_t		ih_os;		/* Operating System		*/
	uint8_t		ih_arch;	/* CPU architecture		*/
	uint8_t		ih_type;	/* Image Type			*/
	uint8_t		ih_comp;	/* Compression Type		*/
	uint8_t		ih_name[IH_NMLEN];	/* Image Name		*/
} image_header_t;

262 263 264 265 266 267 268
typedef struct image_info {
	ulong		start, end;		/* start/end of blob */
	ulong		image_start, image_len; /* start of image within blob, len of image */
	ulong		load;			/* load addr for the image */
	uint8_t		comp, type, os;		/* compression, type of image, os type */
} image_info_t;

269 270 271 272 273 274 275
/*
 * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
 * routines.
 */
typedef struct bootm_headers {
	/*
	 * Legacy os image header, if it is a multi component image
276
	 * then boot_get_ramdisk() and get_fdt() will attempt to get
277 278
	 * data from second and third component accordingly.
	 */
279 280
	image_header_t	*legacy_hdr_os;		/* image header pointer */
	image_header_t	legacy_hdr_os_copy;	/* header copy */
281 282 283
	ulong		legacy_hdr_valid;

#if defined(CONFIG_FIT)
284 285
	const char	*fit_uname_cfg;	/* configuration node unit name */

286
	void		*fit_hdr_os;	/* os FIT image header */
287
	const char	*fit_uname_os;	/* os subimage node unit name */
288
	int		fit_noffset_os;	/* os subimage node offset */
289 290

	void		*fit_hdr_rd;	/* init ramdisk FIT image header */
291 292
	const char	*fit_uname_rd;	/* init ramdisk subimage node unit name */
	int		fit_noffset_rd;	/* init ramdisk subimage node offset */
293 294

	void		*fit_hdr_fdt;	/* FDT blob FIT image header */
295 296
	const char	*fit_uname_fdt;	/* FDT blob subimage node unit name */
	int		fit_noffset_fdt;/* FDT blob subimage node offset */
297
#endif
298

Kumar Gala's avatar
Kumar Gala committed
299
#ifndef USE_HOSTCC
300
	image_info_t	os;		/* os image info */
Kumar Gala's avatar
Kumar Gala committed
301 302
	ulong		ep;		/* entry point of OS */

303 304
	ulong		rd_start, rd_end;/* ramdisk start/end */

305 306 307
	char		*ft_addr;	/* flat dev tree address */
	ulong		ft_len;		/* length of flat device tree */

Kumar Gala's avatar
Kumar Gala committed
308 309 310 311 312 313 314
	ulong		initrd_start;
	ulong		initrd_end;
	ulong		cmdline_start;
	ulong		cmdline_end;
	bd_t		*kbd;
#endif

315
	int		verify;		/* getenv("verify")[0] != 'n' */
Kumar Gala's avatar
Kumar Gala committed
316 317

#define	BOOTM_STATE_START	(0x00000001)
318 319 320 321 322 323 324 325
#define	BOOTM_STATE_FINDOS	(0x00000002)
#define	BOOTM_STATE_FINDOTHER	(0x00000004)
#define	BOOTM_STATE_LOADOS	(0x00000008)
#define	BOOTM_STATE_RAMDISK	(0x00000010)
#define	BOOTM_STATE_FDT		(0x00000020)
#define	BOOTM_STATE_OS_CMDLINE	(0x00000040)
#define	BOOTM_STATE_OS_BD_T	(0x00000080)
#define	BOOTM_STATE_OS_PREP	(0x00000100)
326 327
#define	BOOTM_STATE_OS_FAKE_GO	(0x00000200)	/* 'Almost' run the OS */
#define	BOOTM_STATE_OS_GO	(0x00000400)
Kumar Gala's avatar
Kumar Gala committed
328 329
	int		state;

330
#ifdef CONFIG_LMB
331 332
	struct lmb	lmb;		/* for memory mgmt */
#endif
333 334
} bootm_headers_t;

Simon Schwarz's avatar
Simon Schwarz committed
335 336
extern bootm_headers_t images;

337 338 339
/*
 * Some systems (for example LWMON) have very short watchdog periods;
 * we must make sure to split long operations like memmove() or
340
 * checksum calculations into reasonable chunks.
341
 */
342
#ifndef CHUNKSZ
343
#define CHUNKSZ (64 * 1024)
344 345 346 347 348 349 350 351 352 353 354 355 356
#endif

#ifndef CHUNKSZ_CRC32
#define CHUNKSZ_CRC32 (64 * 1024)
#endif

#ifndef CHUNKSZ_MD5
#define CHUNKSZ_MD5 (64 * 1024)
#endif

#ifndef CHUNKSZ_SHA1
#define CHUNKSZ_SHA1 (64 * 1024)
#endif
357

358 359
#define uimage_to_cpu(x)		be32_to_cpu(x)
#define cpu_to_uimage(x)		cpu_to_be32(x)
360

361 362 363 364 365 366 367 368 369 370 371 372 373 374 375
/*
 * Translation table for entries of a specific type; used by
 * get_table_entry_id() and get_table_entry_name().
 */
typedef struct table_entry {
	int	id;
	char	*sname;		/* short (input) name to find table entry */
	char	*lname;		/* long (output) name to print for messages */
} table_entry_t;

/*
 * get_table_entry_id() scans the translation table trying to find an
 * entry that matches the given short name. If a matching entry is
 * found, it's id is returned to the caller.
 */
Mike Frysinger's avatar
Mike Frysinger committed
376
int get_table_entry_id(const table_entry_t *table,
377 378 379 380 381 382
		const char *table_name, const char *name);
/*
 * get_table_entry_name() scans the translation table trying to find
 * an entry that matches the given id. If a matching entry is found,
 * its long name is returned to the caller.
 */
Mike Frysinger's avatar
Mike Frysinger committed
383
char *get_table_entry_name(const table_entry_t *table, char *msg, int id);
384

385 386 387 388 389 390 391 392 393
const char *genimg_get_os_name(uint8_t os);
const char *genimg_get_arch_name(uint8_t arch);
const char *genimg_get_type_name(uint8_t type);
const char *genimg_get_comp_name(uint8_t comp);
int genimg_get_os_id(const char *name);
int genimg_get_arch_id(const char *name);
int genimg_get_type_id(const char *name);
int genimg_get_comp_id(const char *name);
void genimg_print_size(uint32_t size);
394

395 396 397 398 399 400 401 402
#if defined(CONFIG_TIMESTAMP) || defined(CONFIG_CMD_DATE) || \
	defined(USE_HOSTCC)
#define IMAGE_ENABLE_TIMESTAMP 1
#else
#define IMAGE_ENABLE_TIMESTAMP 0
#endif
void genimg_print_time(time_t timestamp);

403 404 405 406 407 408 409
/* What to do with a image load address ('load = <> 'in the FIT) */
enum fit_load_op {
	FIT_LOAD_IGNORED,	/* Ignore load address */
	FIT_LOAD_OPTIONAL,	/* Can be provided, but optional */
	FIT_LOAD_REQUIRED,	/* Must be provided */
};

410 411 412 413 414 415
#ifndef USE_HOSTCC
/* Image format types, returned by _get_format() routine */
#define IMAGE_FORMAT_INVALID	0x00
#define IMAGE_FORMAT_LEGACY	0x01	/* legacy image_header based format */
#define IMAGE_FORMAT_FIT	0x02	/* new, libfdt based format */

416
int genimg_get_format(const void *img_addr);
417 418
int genimg_has_config(bootm_headers_t *images);
ulong genimg_get_image(ulong img_addr);
419

420
int boot_get_ramdisk(int argc, char * const argv[], bootm_headers_t *images,
421
		uint8_t arch, ulong *rd_start, ulong *rd_end);
422

423 424 425 426 427 428 429 430 431 432 433 434 435 436
/**
 * fit_image_load() - load an image from a FIT
 *
 * This deals with all aspects of loading an image from a FIT, including
 * selecting the right image based on configuration, verifying it, printing
 * out progress messages, checking the type/arch/os and optionally copying it
 * to the right load address.
 *
 * @param images	Boot images structure
 * @param prop_name	Property name to look up (FIT_..._PROP)
 * @param addr		Address of FIT in memory
 * @param fit_unamep	On entry this is the requested image name
 *			(e.g. "kernel@1") or NULL to use the default. On exit
 *			points to the selected image name
437 438 439
 * @param fit_uname_configp	On entry this is the requested configuration
 *			name (e.g. "conf@1") or NULL to use the default. On
 *			exit points to the selected configuration name.
440 441 442 443 444 445 446 447 448 449 450 451
 * @param arch		Expected architecture (IH_ARCH_...)
 * @param image_type	Required image type (IH_TYPE_...). If this is
 *			IH_TYPE_KERNEL then we allow IH_TYPE_KERNEL_NOLOAD
 *			also.
 * @param bootstage_id	ID of starting bootstage to use for progress updates.
 *			This will be added to the BOOTSTAGE_SUB values when
 *			calling bootstage_mark()
 * @param load_op	Decribes what to do with the load address
 * @param datap		Returns address of loaded image
 * @param lenp		Returns length of loaded image
 */
int fit_image_load(bootm_headers_t *images, const char *prop_name, ulong addr,
452
		   const char **fit_unamep, const char **fit_uname_configp,
453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485
		   int arch, int image_type, int bootstage_id,
		   enum fit_load_op load_op, ulong *datap, ulong *lenp);

/**
 * fit_get_node_from_config() - Look up an image a FIT by type
 *
 * This looks in the selected conf@ node (images->fit_uname_cfg) for a
 * particular image type (e.g. "kernel") and then finds the image that is
 * referred to.
 *
 * For example, for something like:
 *
 * images {
 *	kernel@1 {
 *		...
 *	};
 * };
 * configurations {
 *	conf@1 {
 *		kernel = "kernel@1";
 *	};
 * };
 *
 * the function will return the node offset of the kernel@1 node, assuming
 * that conf@1 is the chosen configuration.
 *
 * @param images	Boot images structure
 * @param prop_name	Property name to look up (FIT_..._PROP)
 * @param addr		Address of FIT in memory
 */
int fit_get_node_from_config(bootm_headers_t *images, const char *prop_name,
			ulong addr);

486 487 488
int boot_get_fdt(int flag, int argc, char * const argv[], uint8_t arch,
		 bootm_headers_t *images,
		 char **of_flat_tree, ulong *of_size);
489
void boot_fdt_add_mem_rsv_regions(struct lmb *lmb, void *fdt_blob);
490
int boot_relocate_fdt(struct lmb *lmb, char **of_flat_tree, ulong *of_size);
491

492
int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len,
493
		  ulong *initrd_start, ulong *initrd_end);
494
int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end);
495
#ifdef CONFIG_SYS_BOOT_GET_KBD
496
int boot_get_kbd(struct lmb *lmb, bd_t **kbd);
497
#endif /* CONFIG_SYS_BOOT_GET_KBD */
498
#endif /* !USE_HOSTCC */
499

500 501 502
/*******************************************************************/
/* Legacy format specific code (prefixed with image_) */
/*******************************************************************/
503
static inline uint32_t image_get_header_size(void)
504
{
505
	return (sizeof(image_header_t));
506 507 508
}

#define image_get_hdr_l(f) \
509
	static inline uint32_t image_get_##f(const image_header_t *hdr) \
510
	{ \
511
		return uimage_to_cpu(hdr->ih_##f); \
512
	}
513 514 515 516 517 518 519
image_get_hdr_l(magic)		/* image_get_magic */
image_get_hdr_l(hcrc)		/* image_get_hcrc */
image_get_hdr_l(time)		/* image_get_time */
image_get_hdr_l(size)		/* image_get_size */
image_get_hdr_l(load)		/* image_get_load */
image_get_hdr_l(ep)		/* image_get_ep */
image_get_hdr_l(dcrc)		/* image_get_dcrc */
520 521

#define image_get_hdr_b(f) \
522
	static inline uint8_t image_get_##f(const image_header_t *hdr) \
523 524 525
	{ \
		return hdr->ih_##f; \
	}
526 527 528 529
image_get_hdr_b(os)		/* image_get_os */
image_get_hdr_b(arch)		/* image_get_arch */
image_get_hdr_b(type)		/* image_get_type */
image_get_hdr_b(comp)		/* image_get_comp */
530

531
static inline char *image_get_name(const image_header_t *hdr)
532 533 534 535
{
	return (char *)hdr->ih_name;
}

536
static inline uint32_t image_get_data_size(const image_header_t *hdr)
537
{
538
	return image_get_size(hdr);
539
}
540 541 542 543 544 545 546 547 548 549 550 551

/**
 * image_get_data - get image payload start address
 * @hdr: image header
 *
 * image_get_data() returns address of the image payload. For single
 * component images it is image data start. For multi component
 * images it points to the null terminated table of sub-images sizes.
 *
 * returns:
 *     image payload data start address
 */
552
static inline ulong image_get_data(const image_header_t *hdr)
553
{
554
	return ((ulong)hdr + image_get_header_size());
555 556
}

557
static inline uint32_t image_get_image_size(const image_header_t *hdr)
558
{
559
	return (image_get_size(hdr) + image_get_header_size());
560
}
561
static inline ulong image_get_image_end(const image_header_t *hdr)
562
{
563
	return ((ulong)hdr + image_get_image_size(hdr));
564 565 566 567 568
}

#define image_set_hdr_l(f) \
	static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
	{ \
569
		hdr->ih_##f = cpu_to_uimage(val); \
570
	}
571 572 573 574 575 576 577
image_set_hdr_l(magic)		/* image_set_magic */
image_set_hdr_l(hcrc)		/* image_set_hcrc */
image_set_hdr_l(time)		/* image_set_time */
image_set_hdr_l(size)		/* image_set_size */
image_set_hdr_l(load)		/* image_set_load */
image_set_hdr_l(ep)		/* image_set_ep */
image_set_hdr_l(dcrc)		/* image_set_dcrc */
578 579 580 581 582 583

#define image_set_hdr_b(f) \
	static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
	{ \
		hdr->ih_##f = val; \
	}
584 585 586 587
image_set_hdr_b(os)		/* image_set_os */
image_set_hdr_b(arch)		/* image_set_arch */
image_set_hdr_b(type)		/* image_set_type */
image_set_hdr_b(comp)		/* image_set_comp */
588

589
static inline void image_set_name(image_header_t *hdr, const char *name)
590
{
591
	strncpy(image_get_name(hdr), name, IH_NMLEN);
592 593
}

594 595
int image_check_hcrc(const image_header_t *hdr);
int image_check_dcrc(const image_header_t *hdr);
596
#ifndef USE_HOSTCC
597
ulong getenv_bootm_low(void);
598
phys_size_t getenv_bootm_size(void);
599
phys_size_t getenv_bootm_mapsize(void);
600
void memmove_wd(void *to, void *from, size_t len, ulong chunksz);
601
#endif
602

603
static inline int image_check_magic(const image_header_t *hdr)
604
{
605
	return (image_get_magic(hdr) == IH_MAGIC);
606
}
607
static inline int image_check_type(const image_header_t *hdr, uint8_t type)
608
{
609
	return (image_get_type(hdr) == type);
610
}
611
static inline int image_check_arch(const image_header_t *hdr, uint8_t arch)
612
{
613
	return (image_get_arch(hdr) == arch);
614
}
615
static inline int image_check_os(const image_header_t *hdr, uint8_t os)
616
{
617
	return (image_get_os(hdr) == os);
618 619
}

620 621
ulong image_multi_count(const image_header_t *hdr);
void image_multi_getimg(const image_header_t *hdr, ulong idx,
622 623
			ulong *data, ulong *len);

624
void image_print_contents(const void *hdr);
625

626
#ifndef USE_HOSTCC
627
static inline int image_check_target_arch(const image_header_t *hdr)
628
{
629 630
#ifndef IH_ARCH_DEFAULT
# error "please define IH_ARCH_DEFAULT in your arch asm/u-boot.h"
631
#endif
632
	return image_check_arch(hdr, IH_ARCH_DEFAULT);
633
}
634
#endif /* USE_HOSTCC */
wdenk's avatar
wdenk committed
635

636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660
/**
 * Set up properties in the FDT
 *
 * This sets up properties in the FDT that is to be passed to linux.
 *
 * @images:	Images information
 * @blob:	FDT to update
 * @of_size:	Size of the FDT
 * @lmb:	Points to logical memory block structure
 * @return 0 if ok, <0 on failure
 */
int image_setup_libfdt(bootm_headers_t *images, void *blob,
		       int of_size, struct lmb *lmb);

/**
 * Set up the FDT to use for booting a kernel
 *
 * This performs ramdisk setup, sets up the FDT if required, and adds
 * paramters to the FDT if libfdt is available.
 *
 * @param images	Images information
 * @return 0 if ok, <0 on failure
 */
int image_setup_linux(bootm_headers_t *images);

661 662 663 664 665 666 667 668 669 670 671
/**
 * bootz_setup() - Extract stat and size of a Linux xImage
 *
 * @image: Address of image
 * @start: Returns start address of image
 * @end : Returns end address of image
 * @return 0 if OK, 1 if the image was not recognised
 */
int bootz_setup(ulong image, ulong *start, ulong *end);


672
/*******************************************************************/
673
/* New uImage format specific code (prefixed with fit_) */
674
/*******************************************************************/
675
#if defined(CONFIG_FIT)
676 677 678 679

#define FIT_IMAGES_PATH		"/images"
#define FIT_CONFS_PATH		"/configurations"

680
/* hash/signature node */
681 682 683
#define FIT_HASH_NODENAME	"hash"
#define FIT_ALGO_PROP		"algo"
#define FIT_VALUE_PROP		"value"
684
#define FIT_IGNORE_PROP		"uboot-ignore"
685
#define FIT_SIG_NODENAME	"signature"
686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706

/* image node */
#define FIT_DATA_PROP		"data"
#define FIT_TIMESTAMP_PROP	"timestamp"
#define FIT_DESC_PROP		"description"
#define FIT_ARCH_PROP		"arch"
#define FIT_TYPE_PROP		"type"
#define FIT_OS_PROP		"os"
#define FIT_COMP_PROP		"compression"
#define FIT_ENTRY_PROP		"entry"
#define FIT_LOAD_PROP		"load"

/* configuration node */
#define FIT_KERNEL_PROP		"kernel"
#define FIT_RAMDISK_PROP	"ramdisk"
#define FIT_FDT_PROP		"fdt"
#define FIT_DEFAULT_PROP	"default"

#define FIT_MAX_HASH_LEN	20	/* max(crc32_len(4), sha1_len(20)) */

/* cmdline argument format parsing */
707
int fit_parse_conf(const char *spec, ulong addr_curr,
708
		ulong *addr, const char **conf_name);
709
int fit_parse_subimage(const char *spec, ulong addr_curr,
710
		ulong *addr, const char **image_name);
711

712 713
void fit_print_contents(const void *fit);
void fit_image_print(const void *fit, int noffset, const char *p);
714 715 716 717 718 719 720 721

/**
 * fit_get_end - get FIT image size
 * @fit: pointer to the FIT format image header
 *
 * returns:
 *     size of the FIT image (blob) in memory
 */
722
static inline ulong fit_get_size(const void *fit)
723
{
724
	return fdt_totalsize(fit);
725 726 727 728 729 730 731 732 733
}

/**
 * fit_get_end - get FIT image end
 * @fit: pointer to the FIT format image header
 *
 * returns:
 *     end address of the FIT image (blob) in memory
 */
734
static inline ulong fit_get_end(const void *fit)
735
{
736
	return (ulong)fit + fdt_totalsize(fit);
737 738 739 740 741 742 743 744 745 746
}

/**
 * fit_get_name - get FIT node name
 * @fit: pointer to the FIT format image header
 *
 * returns:
 *     NULL, on error
 *     pointer to node name, on success
 */
747
static inline const char *fit_get_name(const void *fit_hdr,
748 749
		int noffset, int *len)
{
750
	return fdt_get_name(fit_hdr, noffset, len);
751 752
}

753 754 755 756 757 758 759 760 761 762 763
int fit_get_desc(const void *fit, int noffset, char **desc);
int fit_get_timestamp(const void *fit, int noffset, time_t *timestamp);

int fit_image_get_node(const void *fit, const char *image_uname);
int fit_image_get_os(const void *fit, int noffset, uint8_t *os);
int fit_image_get_arch(const void *fit, int noffset, uint8_t *arch);
int fit_image_get_type(const void *fit, int noffset, uint8_t *type);
int fit_image_get_comp(const void *fit, int noffset, uint8_t *comp);
int fit_image_get_load(const void *fit, int noffset, ulong *load);
int fit_image_get_entry(const void *fit, int noffset, ulong *entry);
int fit_image_get_data(const void *fit, int noffset,
764 765
				const void **data, size_t *size);

766 767
int fit_image_hash_get_algo(const void *fit, int noffset, char **algo);
int fit_image_hash_get_value(const void *fit, int noffset, uint8_t **value,
768 769
				int *value_len);

770
int fit_set_timestamp(void *fit, int noffset, time_t timestamp);
771 772

/**
Simon Glass's avatar
Simon Glass committed
773
 * fit_add_verification_data() - add verification data to FIT image nodes
774
 *
Simon Glass's avatar
Simon Glass committed
775 776 777 778 779 780 781 782 783 784 785 786 787 788 789
 * @keydir:	Directory containing keys
 * @kwydest:	FDT blob to write public key information to
 * @fit:	Pointer to the FIT format image header
 * @comment:	Comment to add to signature nodes
 * @require_keys: Mark all keys as 'required'
 *
 * Adds hash values for all component images in the FIT blob.
 * Hashes are calculated for all component images which have hash subnodes
 * with algorithm property set to one of the supported hash algorithms.
 *
 * Also add signatures if signature nodes are present.
 *
 * returns
 *     0, on success
 *     libfdt error code, on failure
790
 */
Simon Glass's avatar
Simon Glass committed
791 792
int fit_add_verification_data(const char *keydir, void *keydest, void *fit,
			      const char *comment, int require_keys);
793

794
int fit_image_verify(const void *fit, int noffset);
795
int fit_config_verify(const void *fit, int conf_noffset);
796
int fit_all_image_verify(const void *fit);
797 798 799 800 801
int fit_image_check_os(const void *fit, int noffset, uint8_t os);
int fit_image_check_arch(const void *fit, int noffset, uint8_t arch);
int fit_image_check_type(const void *fit, int noffset, uint8_t type);
int fit_image_check_comp(const void *fit, int noffset, uint8_t comp);
int fit_check_format(const void *fit);
802

803
int fit_conf_find_compat(const void *fit, const void *fdt);
804
int fit_conf_get_node(const void *fit, const char *conf_uname);
805

806 807 808 809 810 811 812 813 814 815 816 817 818 819
/**
 * fit_conf_get_prop_node() - Get node refered to by a configuration
 * @fit:	FIT to check
 * @noffset:	Offset of conf@xxx node to check
 * @prop_name:	Property to read from the conf node
 *
 * The conf@ nodes contain references to other nodes, using properties
 * like 'kernel = "kernel@1"'. Given such a property name (e.g. "kernel"),
 * return the offset of the node referred to (e.g. offset of node
 * "/images/kernel@1".
 */
int fit_conf_get_prop_node(const void *fit, int noffset,
		const char *prop_name);

820
void fit_conf_print(const void *fit, int noffset, const char *p);
821

822 823 824
int fit_check_ramdisk(const void *fit, int os_noffset,
		uint8_t arch, int verify);

825 826 827
int calculate_hash(const void *data, int data_len, const char *algo,
			uint8_t *value, int *value_len);

828
/*
829 830
 * At present we only support signing on the host, and verification on the
 * device
831 832 833
 */
#if defined(CONFIG_FIT_SIGNATURE)
# ifdef USE_HOSTCC
834
#  define IMAGE_ENABLE_SIGN	1
835
#  define IMAGE_ENABLE_VERIFY	1
836
# include  <openssl/evp.h>
837
#else
838
#  define IMAGE_ENABLE_SIGN	0
839 840 841
#  define IMAGE_ENABLE_VERIFY	1
# endif
#else
842
# define IMAGE_ENABLE_SIGN	0
843 844 845 846
# define IMAGE_ENABLE_VERIFY	0
#endif

#ifdef USE_HOSTCC
847 848 849
void *image_get_host_blob(void);
void image_set_host_blob(void *host_blob);
# define gd_fdt_blob()		image_get_host_blob()
850 851 852 853 854 855 856 857 858 859
#else
# define gd_fdt_blob()		(gd->fdt_blob)
#endif

#ifdef CONFIG_FIT_BEST_MATCH
#define IMAGE_ENABLE_BEST_MATCH	1
#else
#define IMAGE_ENABLE_BEST_MATCH	0
#endif

860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877
/* Information passed to the signing routines */
struct image_sign_info {
	const char *keydir;		/* Directory conaining keys */
	const char *keyname;		/* Name of key to use */
	void *fit;			/* Pointer to FIT blob */
	int node_offset;		/* Offset of signature node */
	struct image_sig_algo *algo;	/* Algorithm information */
	const void *fdt_blob;		/* FDT containing public keys */
	int required_keynode;		/* Node offset of key to use: -1=any */
	const char *require_keys;	/* Value for 'required' property */
};

/* A part of an image, used for hashing */
struct image_region {
	const void *data;
	int size;
};

878 879 880 881 882 883
#if IMAGE_ENABLE_VERIFY
# include <rsa-checksum.h>
#endif
struct checksum_algo {
	const char *name;
	const int checksum_len;
884
	const int pad_len;
885
#if IMAGE_ENABLE_SIGN
886 887
	const EVP_MD *(*calculate_sign)(void);
#endif
888 889 890 891 892
	void (*calculate)(const struct image_region region[],
			  int region_count, uint8_t *checksum);
	const uint8_t *rsa_padding;
};

893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942
struct image_sig_algo {
	const char *name;		/* Name of algorithm */

	/**
	 * sign() - calculate and return signature for given input data
	 *
	 * @info:	Specifies key and FIT information
	 * @data:	Pointer to the input data
	 * @data_len:	Data length
	 * @sigp:	Set to an allocated buffer holding the signature
	 * @sig_len:	Set to length of the calculated hash
	 *
	 * This computes input data signature according to selected algorithm.
	 * Resulting signature value is placed in an allocated buffer, the
	 * pointer is returned as *sigp. The length of the calculated
	 * signature is returned via the sig_len pointer argument. The caller
	 * should free *sigp.
	 *
	 * @return: 0, on success, -ve on error
	 */
	int (*sign)(struct image_sign_info *info,
		    const struct image_region region[],
		    int region_count, uint8_t **sigp, uint *sig_len);

	/**
	 * add_verify_data() - Add verification information to FDT
	 *
	 * Add public key information to the FDT node, suitable for
	 * verification at run-time. The information added depends on the
	 * algorithm being used.
	 *
	 * @info:	Specifies key and FIT information
	 * @keydest:	Destination FDT blob for public key data
	 * @return: 0, on success, -ve on error
	 */
	int (*add_verify_data)(struct image_sign_info *info, void *keydest);

	/**
	 * verify() - Verify a signature against some data
	 *
	 * @info:	Specifies key and FIT information
	 * @data:	Pointer to the input data
	 * @data_len:	Data length
	 * @sig:	Signature
	 * @sig_len:	Number of bytes in signature
	 * @return 0 if verified, -ve on error
	 */
	int (*verify)(struct image_sign_info *info,
		      const struct image_region region[], int region_count,
		      uint8_t *sig, uint sig_len);
943 944 945

	/* pointer to checksum algorithm */
	struct checksum_algo *checksum;
946 947 948 949 950 951 952 953 954 955
};

/**
 * image_get_sig_algo() - Look up a signature algortihm
 *
 * @param name		Name of algorithm
 * @return pointer to algorithm information, or NULL if not found
 */
struct image_sig_algo *image_get_sig_algo(const char *name);

Simon Glass's avatar
Simon Glass committed
956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991
/**
 * fit_image_verify_required_sigs() - Verify signatures marked as 'required'
 *
 * @fit:		FIT to check
 * @image_noffset:	Offset of image node to check
 * @data:		Image data to check
 * @size:		Size of image data
 * @sig_blob:		FDT containing public keys
 * @no_sigsp:		Returns 1 if no signatures were required, and
 *			therefore nothing was checked. The caller may wish
 *			to fall back to other mechanisms, or refuse to
 *			boot.
 * @return 0 if all verified ok, <0 on error
 */
int fit_image_verify_required_sigs(const void *fit, int image_noffset,
		const char *data, size_t size, const void *sig_blob,
		int *no_sigsp);

/**
 * fit_image_check_sig() - Check a single image signature node
 *
 * @fit:		FIT to check
 * @noffset:		Offset of signature node to check
 * @data:		Image data to check
 * @size:		Size of image data
 * @required_keynode:	Offset in the control FDT of the required key node,
 *			if any. If this is given, then the image wil not
 *			pass verification unless that key is used. If this is
 *			-1 then any signature will do.
 * @err_msgp:		In the event of an error, this will be pointed to a
 *			help error string to display to the user.
 * @return 0 if all verified ok, <0 on error
 */
int fit_image_check_sig(const void *fit, int noffset, const void *data,
		size_t size, int required_keynode, char **err_msgp);

992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007
/**
 * fit_region_make_list() - Make a list of regions to hash
 *
 * Given a list of FIT regions (offset, size) provided by libfdt, create
 * a list of regions (void *, size) for use by the signature creationg
 * and verification code.
 *
 * @fit:		FIT image to process
 * @fdt_regions:	Regions as returned by libfdt
 * @count:		Number of regions returned by libfdt
 * @region:		Place to put list of regions (NULL to allocate it)
 * @return pointer to list of regions, or NULL if out of memory
 */
struct image_region *fit_region_make_list(const void *fit,
		struct fdt_region *fdt_regions, int count,
		struct image_region *region);
Simon Glass's avatar
Simon Glass committed
1008

1009
static inline int fit_image_check_target_arch(const void *fdt, int node)
1010
{
1011
#ifndef USE_HOSTCC
1012
	return fit_image_check_arch(fdt, node, IH_ARCH_DEFAULT);
1013 1014 1015
#else
	return 0;
#endif
1016 1017
}

1018
#ifdef CONFIG_FIT_VERBOSE
1019
#define fit_unsupported(msg)	printf("! %s:%d " \
1020 1021 1022
				"FIT images not supported for '%s'\n", \
				__FILE__, __LINE__, (msg))

1023
#define fit_unsupported_reset(msg)	printf("! %s:%d " \
1024 1025 1026 1027 1028 1029 1030
				"FIT images not supported for '%s' " \
				"- must reset board to recover!\n", \
				__FILE__, __LINE__, (msg))
#else
#define fit_unsupported(msg)
#define fit_unsupported_reset(msg)
#endif /* CONFIG_FIT_VERBOSE */
1031
#endif /* CONFIG_FIT */
1032

1033
#endif	/* __IMAGE_H__ */