image.h 21.6 KB
Newer Older
W
wdenk 已提交
1
/*
2 3
 * (C) Copyright 2008 Semihalf
 *
4
 * (C) Copyright 2000-2005
W
wdenk 已提交
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
 *
 * See file CREDITS for list of people who contributed to this
 * project.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 2 of
 * the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	 See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 * MA 02111-1307 USA
24 25 26 27 28 29 30
 *
 ********************************************************************
 * 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".
 ********************************************************************
W
wdenk 已提交
31 32 33 34 35
 */

#ifndef __IMAGE_H__
#define __IMAGE_H__

36
#include "compiler.h"
K
Kim Phillips 已提交
37
#include <asm/byteorder.h>
38 39

#ifdef USE_HOSTCC
40 41

/* new uImage format support enabled on host */
42 43
#define CONFIG_FIT		1
#define CONFIG_OF_LIBFDT	1
44
#define CONFIG_FIT_VERBOSE	1 /* enable fit_format_{error,warning}() */
45

46 47 48 49
#else

#include <lmb.h>
#include <asm/u-boot.h>
50
#include <command.h>
51

52
#endif /* USE_HOSTCC */
53

54 55 56
#if defined(CONFIG_FIT)
#include <libfdt.h>
#include <fdt_support.h>
57
#define CONFIG_MD5		/* FIT images need MD5 support */
58
#define CONFIG_SHA1		/* and SHA1 */
59
#endif
60

W
wdenk 已提交
61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81
/*
 * 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	*/
82
#define IH_OS_RTEMS		18	/* RTEMS	*/
W
wdenk 已提交
83
#define IH_OS_ARTOS		19	/* ARTOS	*/
84
#define IH_OS_UNITY		20	/* Unity OS	*/
85
#define IH_OS_INTEGRITY		21	/* INTEGRITY	*/
86
#define IH_OS_OSE		22	/* OSE		*/
S
Steven Stallion 已提交
87
#define IH_OS_PLAN9		23	/* Plan 9	*/
W
wdenk 已提交
88 89 90 91

/*
 * CPU Architecture Codes (supported by Linux)
 */
92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109
#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  */
110
#define IH_ARCH_SANDBOX		19	/* Sandbox architecture (test only) */
111
#define IH_ARCH_NDS32	        20	/* ANDES Technology - NDS32  */
112
#define IH_ARCH_OPENRISC        21	/* OpenRISC 1000  */
W
wdenk 已提交
113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140

/*
 * 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
W
wdenk 已提交
141
 *	a multiple of 4 bytes - except for the last file).
W
wdenk 已提交
142 143 144 145 146 147 148 149
 *
 * "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)
150
 *	as command interpreter (=> Shell Scripts).
W
wdenk 已提交
151 152 153 154 155 156 157 158 159
 */

#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			*/
W
wdenk 已提交
160
#define IH_TYPE_FILESYSTEM	7	/* Filesystem Image (any type)	*/
161
#define IH_TYPE_FLATDT		8	/* Binary Flat Device Tree Blob	*/
162
#define IH_TYPE_KWBIMAGE	9	/* Kirkwood Boot Image		*/
163
#define IH_TYPE_IMXIMAGE	10	/* Freescale IMXBoot Image	*/
164
#define IH_TYPE_UBLIMAGE	11	/* Davinci UBL Image		*/
165
#define IH_TYPE_OMAPIMAGE	12	/* TI OMAP Config Header Image	*/
166
#define IH_TYPE_AISIMAGE	13	/* TI Davinci AIS Image		*/
167
#define IH_TYPE_KERNEL_NOLOAD	14	/* OS Kernel Image, can run from any load address */
168
#define IH_TYPE_PBLIMAGE	15	/* Freescale PBL Boot Image	*/
W
wdenk 已提交
169 170 171 172 173 174 175

/*
 * 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	*/
176
#define IH_COMP_LZMA		3	/* lzma  Compression Used	*/
P
Peter Korsgaard 已提交
177
#define IH_COMP_LZO		4	/* lzo   Compression Used	*/
W
wdenk 已提交
178 179 180 181

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

182 183 184
/* Reused from common.h */
#define ROUND(a, b)		(((a) + (b) - 1) & ~((b) - 1))

W
wdenk 已提交
185
/*
186 187
 * Legacy format image header,
 * all data in network byte order (aka natural aka bigendian).
W
wdenk 已提交
188 189
 */
typedef struct image_header {
K
Kim Phillips 已提交
190 191 192 193 194 195 196
	__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	*/
W
wdenk 已提交
197 198 199 200 201 202 203
	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;

204 205 206 207 208 209 210
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;

211 212 213 214 215 216 217
/*
 * 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
218
	 * then boot_get_ramdisk() and get_fdt() will attempt to get
219 220
	 * data from second and third component accordingly.
	 */
221 222
	image_header_t	*legacy_hdr_os;		/* image header pointer */
	image_header_t	legacy_hdr_os_copy;	/* header copy */
223 224 225
	ulong		legacy_hdr_valid;

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

228
	void		*fit_hdr_os;	/* os FIT image header */
229
	const char	*fit_uname_os;	/* os subimage node unit name */
230
	int		fit_noffset_os;	/* os subimage node offset */
231 232

	void		*fit_hdr_rd;	/* init ramdisk FIT image header */
233 234
	const char	*fit_uname_rd;	/* init ramdisk subimage node unit name */
	int		fit_noffset_rd;	/* init ramdisk subimage node offset */
235 236

	void		*fit_hdr_fdt;	/* FDT blob FIT image header */
237 238
	const char	*fit_uname_fdt;	/* FDT blob subimage node unit name */
	int		fit_noffset_fdt;/* FDT blob subimage node offset */
239
#endif
240

K
Kumar Gala 已提交
241
#ifndef USE_HOSTCC
242
	image_info_t	os;		/* os image info */
K
Kumar Gala 已提交
243 244
	ulong		ep;		/* entry point of OS */

245 246
	ulong		rd_start, rd_end;/* ramdisk start/end */

247 248 249 250 251
#ifdef CONFIG_OF_LIBFDT
	char		*ft_addr;	/* flat dev tree address */
#endif
	ulong		ft_len;		/* length of flat device tree */

K
Kumar Gala 已提交
252 253 254 255 256 257 258
	ulong		initrd_start;
	ulong		initrd_end;
	ulong		cmdline_start;
	ulong		cmdline_end;
	bd_t		*kbd;
#endif

259
	int		verify;		/* getenv("verify")[0] != 'n' */
K
Kumar Gala 已提交
260 261 262 263 264 265 266 267 268 269 270

#define	BOOTM_STATE_START	(0x00000001)
#define	BOOTM_STATE_LOADOS	(0x00000002)
#define	BOOTM_STATE_RAMDISK	(0x00000004)
#define	BOOTM_STATE_FDT		(0x00000008)
#define	BOOTM_STATE_OS_CMDLINE	(0x00000010)
#define	BOOTM_STATE_OS_BD_T	(0x00000020)
#define	BOOTM_STATE_OS_PREP	(0x00000040)
#define	BOOTM_STATE_OS_GO	(0x00000080)
	int		state;

271
#ifdef CONFIG_LMB
272 273
	struct lmb	lmb;		/* for memory mgmt */
#endif
274 275
} bootm_headers_t;

S
Simon Schwarz 已提交
276 277
extern bootm_headers_t images;

278 279 280
/*
 * Some systems (for example LWMON) have very short watchdog periods;
 * we must make sure to split long operations like memmove() or
281
 * checksum calculations into reasonable chunks.
282
 */
283
#ifndef CHUNKSZ
284
#define CHUNKSZ (64 * 1024)
285 286 287 288 289 290 291 292 293 294 295 296 297
#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
298

299 300
#define uimage_to_cpu(x)		be32_to_cpu(x)
#define cpu_to_uimage(x)		cpu_to_be32(x)
301

302 303 304 305 306 307 308 309 310 311 312 313 314 315 316
/*
 * 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.
 */
M
Mike Frysinger 已提交
317
int get_table_entry_id(const table_entry_t *table,
318 319 320 321 322 323
		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.
 */
M
Mike Frysinger 已提交
324
char *get_table_entry_name(const table_entry_t *table, char *msg, int id);
325

S
Stephen Warren 已提交
326 327 328 329 330 331 332 333 334
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);
335

336 337 338 339 340 341 342 343
#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);

344 345 346 347 348 349
#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 */

S
Stephen Warren 已提交
350 351 352
int genimg_get_format(void *img_addr);
int genimg_has_config(bootm_headers_t *images);
ulong genimg_get_image(ulong img_addr);
353

S
Stephen Warren 已提交
354
int boot_get_ramdisk(int argc, char * const argv[], bootm_headers_t *images,
355
		uint8_t arch, ulong *rd_start, ulong *rd_end);
356

357 358

#ifdef CONFIG_OF_LIBFDT
S
Stephen Warren 已提交
359 360
int boot_get_fdt(int flag, int argc, char * const argv[],
		bootm_headers_t *images, char **of_flat_tree, ulong *of_size);
361
void boot_fdt_add_mem_rsv_regions(struct lmb *lmb, void *fdt_blob);
S
Stephen Warren 已提交
362
int boot_relocate_fdt(struct lmb *lmb, char **of_flat_tree, ulong *of_size);
363 364
#endif

365
#ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH
S
Stephen Warren 已提交
366
int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len,
367
		  ulong *initrd_start, ulong *initrd_end);
368 369
#endif /* CONFIG_SYS_BOOT_RAMDISK_HIGH */
#ifdef CONFIG_SYS_BOOT_GET_CMDLINE
S
Stephen Warren 已提交
370
int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end);
371 372
#endif /* CONFIG_SYS_BOOT_GET_CMDLINE */
#ifdef CONFIG_SYS_BOOT_GET_KBD
S
Stephen Warren 已提交
373
int boot_get_kbd(struct lmb *lmb, bd_t **kbd);
374
#endif /* CONFIG_SYS_BOOT_GET_KBD */
375
#endif /* !USE_HOSTCC */
376

377 378 379
/*******************************************************************/
/* Legacy format specific code (prefixed with image_) */
/*******************************************************************/
S
Stephen Warren 已提交
380
static inline uint32_t image_get_header_size(void)
381
{
S
Stephen Warren 已提交
382
	return (sizeof(image_header_t));
383 384 385
}

#define image_get_hdr_l(f) \
386
	static inline uint32_t image_get_##f(const image_header_t *hdr) \
387
	{ \
S
Stephen Warren 已提交
388
		return uimage_to_cpu(hdr->ih_##f); \
389
	}
S
Stephen Warren 已提交
390 391 392 393 394 395 396
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 */
397 398

#define image_get_hdr_b(f) \
399
	static inline uint8_t image_get_##f(const image_header_t *hdr) \
400 401 402
	{ \
		return hdr->ih_##f; \
	}
S
Stephen Warren 已提交
403 404 405 406
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 */
407

S
Stephen Warren 已提交
408
static inline char *image_get_name(const image_header_t *hdr)
409 410 411 412
{
	return (char *)hdr->ih_name;
}

S
Stephen Warren 已提交
413
static inline uint32_t image_get_data_size(const image_header_t *hdr)
414
{
S
Stephen Warren 已提交
415
	return image_get_size(hdr);
416
}
417 418 419 420 421 422 423 424 425 426 427 428

/**
 * 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
 */
S
Stephen Warren 已提交
429
static inline ulong image_get_data(const image_header_t *hdr)
430
{
S
Stephen Warren 已提交
431
	return ((ulong)hdr + image_get_header_size());
432 433
}

S
Stephen Warren 已提交
434
static inline uint32_t image_get_image_size(const image_header_t *hdr)
435
{
S
Stephen Warren 已提交
436
	return (image_get_size(hdr) + image_get_header_size());
437
}
S
Stephen Warren 已提交
438
static inline ulong image_get_image_end(const image_header_t *hdr)
439
{
S
Stephen Warren 已提交
440
	return ((ulong)hdr + image_get_image_size(hdr));
441 442 443 444 445
}

#define image_set_hdr_l(f) \
	static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
	{ \
S
Stephen Warren 已提交
446
		hdr->ih_##f = cpu_to_uimage(val); \
447
	}
S
Stephen Warren 已提交
448 449 450 451 452 453 454
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 */
455 456 457 458 459 460

#define image_set_hdr_b(f) \
	static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
	{ \
		hdr->ih_##f = val; \
	}
S
Stephen Warren 已提交
461 462 463 464
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 */
465

S
Stephen Warren 已提交
466
static inline void image_set_name(image_header_t *hdr, const char *name)
467
{
S
Stephen Warren 已提交
468
	strncpy(image_get_name(hdr), name, IH_NMLEN);
469 470
}

S
Stephen Warren 已提交
471 472
int image_check_hcrc(const image_header_t *hdr);
int image_check_dcrc(const image_header_t *hdr);
473
#ifndef USE_HOSTCC
474
ulong getenv_bootm_low(void);
475
phys_size_t getenv_bootm_size(void);
476
phys_size_t getenv_bootm_mapsize(void);
S
Stephen Warren 已提交
477
void memmove_wd(void *to, void *from, size_t len, ulong chunksz);
478
#endif
479

S
Stephen Warren 已提交
480
static inline int image_check_magic(const image_header_t *hdr)
481
{
S
Stephen Warren 已提交
482
	return (image_get_magic(hdr) == IH_MAGIC);
483
}
S
Stephen Warren 已提交
484
static inline int image_check_type(const image_header_t *hdr, uint8_t type)
485
{
S
Stephen Warren 已提交
486
	return (image_get_type(hdr) == type);
487
}
S
Stephen Warren 已提交
488
static inline int image_check_arch(const image_header_t *hdr, uint8_t arch)
489
{
S
Stephen Warren 已提交
490
	return (image_get_arch(hdr) == arch);
491
}
S
Stephen Warren 已提交
492
static inline int image_check_os(const image_header_t *hdr, uint8_t os)
493
{
S
Stephen Warren 已提交
494
	return (image_get_os(hdr) == os);
495 496
}

S
Stephen Warren 已提交
497 498
ulong image_multi_count(const image_header_t *hdr);
void image_multi_getimg(const image_header_t *hdr, ulong idx,
499 500
			ulong *data, ulong *len);

S
Stephen Warren 已提交
501
void image_print_contents(const void *hdr);
502

503
#ifndef USE_HOSTCC
S
Stephen Warren 已提交
504
static inline int image_check_target_arch(const image_header_t *hdr)
505
{
506 507
#ifndef IH_ARCH_DEFAULT
# error "please define IH_ARCH_DEFAULT in your arch asm/u-boot.h"
508
#endif
509
	return image_check_arch(hdr, IH_ARCH_DEFAULT);
510
}
511
#endif /* USE_HOSTCC */
W
wdenk 已提交
512

513
/*******************************************************************/
514
/* New uImage format specific code (prefixed with fit_) */
515
/*******************************************************************/
516
#if defined(CONFIG_FIT)
517 518 519 520 521 522 523 524

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

/* hash node */
#define FIT_HASH_NODENAME	"hash"
#define FIT_ALGO_PROP		"algo"
#define FIT_VALUE_PROP		"value"
525
#define FIT_IGNORE_PROP		"uboot-ignore"
526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546

/* 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 */
547
int fit_parse_conf(const char *spec, ulong addr_curr,
548
		ulong *addr, const char **conf_name);
549
int fit_parse_subimage(const char *spec, ulong addr_curr,
550
		ulong *addr, const char **image_name);
551

S
Stephen Warren 已提交
552 553 554
void fit_print_contents(const void *fit);
void fit_image_print(const void *fit, int noffset, const char *p);
void fit_image_print_hash(const void *fit, int noffset, const char *p);
555 556 557 558 559 560 561 562

/**
 * fit_get_end - get FIT image size
 * @fit: pointer to the FIT format image header
 *
 * returns:
 *     size of the FIT image (blob) in memory
 */
S
Stephen Warren 已提交
563
static inline ulong fit_get_size(const void *fit)
564
{
S
Stephen Warren 已提交
565
	return fdt_totalsize(fit);
566 567 568 569 570 571 572 573 574
}

/**
 * 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
 */
S
Stephen Warren 已提交
575
static inline ulong fit_get_end(const void *fit)
576
{
S
Stephen Warren 已提交
577
	return (ulong)fit + fdt_totalsize(fit);
578 579 580 581 582 583 584 585 586 587
}

/**
 * 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
 */
S
Stephen Warren 已提交
588
static inline const char *fit_get_name(const void *fit_hdr,
589 590
		int noffset, int *len)
{
S
Stephen Warren 已提交
591
	return fdt_get_name(fit_hdr, noffset, len);
592 593
}

S
Stephen Warren 已提交
594 595 596 597 598 599 600 601 602 603 604
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,
605 606
				const void **data, size_t *size);

S
Stephen Warren 已提交
607 608
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,
609
				int *value_len);
610 611 612
#ifndef USE_HOSTCC
int fit_image_hash_get_ignore(const void *fit, int noffset, int *ignore);
#endif
613

S
Stephen Warren 已提交
614 615 616
int fit_set_timestamp(void *fit, int noffset, time_t timestamp);
int fit_set_hashes(void *fit);
int fit_image_set_hashes(void *fit, int image_noffset);
617

S
Stephen Warren 已提交
618 619 620 621 622 623 624
int fit_image_check_hashes(const void *fit, int noffset);
int fit_all_image_check_hashes(const void *fit);
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);
625

626
int fit_conf_find_compat(const void *fit, const void *fdt);
S
Stephen Warren 已提交
627 628 629 630
int fit_conf_get_node(const void *fit, const char *conf_uname);
int fit_conf_get_kernel_node(const void *fit, int noffset);
int fit_conf_get_ramdisk_node(const void *fit, int noffset);
int fit_conf_get_fdt_node(const void *fit, int noffset);
631

S
Stephen Warren 已提交
632
void fit_conf_print(const void *fit, int noffset, const char *p);
633

S
Simon Glass 已提交
634 635 636
int fit_check_ramdisk(const void *fit, int os_noffset,
		uint8_t arch, int verify);

637 638 639
int calculate_hash(const void *data, int data_len, const char *algo,
			uint8_t *value, int *value_len);

640
#ifndef USE_HOSTCC
S
Stephen Warren 已提交
641
static inline int fit_image_check_target_arch(const void *fdt, int node)
642
{
643
	return fit_image_check_arch(fdt, node, IH_ARCH_DEFAULT);
644 645 646
}
#endif /* USE_HOSTCC */

647
#ifdef CONFIG_FIT_VERBOSE
S
Stephen Warren 已提交
648
#define fit_unsupported(msg)	printf("! %s:%d " \
649 650 651
				"FIT images not supported for '%s'\n", \
				__FILE__, __LINE__, (msg))

S
Stephen Warren 已提交
652
#define fit_unsupported_reset(msg)	printf("! %s:%d " \
653 654 655 656 657 658 659
				"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 */
660
#endif /* CONFIG_FIT */
661

662
#endif	/* __IMAGE_H__ */