[thirdparty/u-boot.git] / include / image.h

/*
 * (C) Copyright 2008 Semihalf
 *
 * (C) Copyright 2000-2005
 * 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
 *
 ********************************************************************
 * 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".
 ********************************************************************
 */

#ifndef __IMAGE_H__
#define __IMAGE_H__

#include <asm/byteorder.h>
#include <command.h>

#ifndef USE_HOSTCC
#include <lmb.h>
#include <linux/string.h>
#include <asm/u-boot.h>

/* new uImage format support enabled by default */
#define CONFIG_FIT		1
#define CONFIG_OF_LIBFDT	1

/* enable fit_format_error(), fit_format_warning() */
#define CONFIG_FIT_VERBOSE	1

#if defined(CONFIG_FIT) && !defined(CONFIG_OF_LIBFDT)
#error "CONFIG_OF_LIBFDT not enabled, required by CONFIG_FIT!"
#endif
#endif /* USE_HOSTCC */

/*
 * 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	*/
#define IH_OS_RTEMS		18	/* RTEMS	*/
#define IH_OS_ARTOS		19	/* ARTOS	*/
#define IH_OS_UNITY		20	/* Unity OS	*/

/*
 * CPU Architecture Codes (supported by Linux)
 */
#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_NIOS		13	/* Nios-32	*/
#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  */

/*
 * 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
 *	a multiple of 4 bytes - except for the last file).
 *
 * "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)
 *	as command interpreter (=> Shell Scripts).
 */

#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			*/
#define IH_TYPE_FILESYSTEM	7	/* Filesystem Image (any type)	*/
#define IH_TYPE_FLATDT		8	/* Binary Flat Device Tree Blob	*/

/*
 * 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	*/

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

/*
 * Legacy format image header,
 * all data in network byte order (aka natural aka bigendian).
 */
typedef struct image_header {
	uint32_t	ih_magic;	/* Image Header Magic Number	*/
	uint32_t	ih_hcrc;	/* Image Header CRC Checksum	*/
	uint32_t	ih_time;	/* Image Creation Timestamp	*/
	uint32_t	ih_size;	/* Image Data Size		*/
	uint32_t	ih_load;	/* Data	 Load  Address		*/
	uint32_t	ih_ep;		/* Entry Point Address		*/
	uint32_t	ih_dcrc;	/* Image Data CRC Checksum	*/
	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;

/*
 * 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
	 * then boot_get_ramdisk() and get_fdt() will attempt to get
	 * data from second and third component accordingly.
	 */
	image_header_t	*legacy_hdr_os;
	ulong		legacy_hdr_valid;

#if defined(CONFIG_FIT)
	void		*fit_hdr_os;	/* os FIT image header */
	char		*fit_uname_os;	/* os subimage node unit name */

	void		*fit_hdr_rd;	/* init ramdisk FIT image header */
	char		*fit_uname_rd;	/* init ramdisk node unit name */

#if defined(CONFIG_PPC)
	void		*fit_hdr_fdt;	/* FDT blob FIT image header */
	char		*fit_uname_fdt;	/* FDT blob node unit name */
#endif
	int		verify;		/* getenv("verify")[0] != 'n' */
	int		autostart;	/* getenv("autostart")[0] != 'n' */
	struct lmb	*lmb;		/* for memory mgmt */
#endif
} bootm_headers_t;

/*
 * Some systems (for example LWMON) have very short watchdog periods;
 * we must make sure to split long operations like memmove() or
 * crc32() into reasonable chunks.
 */
#define CHUNKSZ (64 * 1024)

#define uimage_to_cpu(x)		ntohl(x)
#define cpu_to_uimage(x)		htonl(x)

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);

#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 */

int genimg_get_format (void *img_addr);
ulong genimg_get_image (ulong img_addr);

int boot_get_ramdisk (cmd_tbl_t *cmdtp, int flag, int argc, char *argv[],
		bootm_headers_t *images, uint8_t arch,
		ulong *rd_start, ulong *rd_end);

#if defined(CONFIG_PPC) || defined(CONFIG_M68K)
int boot_ramdisk_high (struct lmb *lmb, ulong rd_data, ulong rd_len,
		  ulong *initrd_start, ulong *initrd_end);

int boot_get_cmdline (struct lmb *lmb, ulong *cmd_start, ulong *cmd_end,
			ulong bootmap_base);
int boot_get_kbd (struct lmb *lmb, bd_t **kbd, ulong bootmap_base);
#endif /* CONFIG_PPC || CONFIG_M68K */
#endif /* !USE_HOSTCC */

/*******************************************************************/
/* Legacy format specific code (prefixed with image_) */
/*******************************************************************/
static inline uint32_t image_get_header_size (void)
{
	return (sizeof (image_header_t));
}

#define image_get_hdr_l(f) \
	static inline uint32_t image_get_##f(image_header_t *hdr) \
	{ \
		return uimage_to_cpu (hdr->ih_##f); \
	}
image_get_hdr_l (magic);
image_get_hdr_l (hcrc);
image_get_hdr_l (time);
image_get_hdr_l (size);
image_get_hdr_l (load);
image_get_hdr_l (ep);
image_get_hdr_l (dcrc);

#define image_get_hdr_b(f) \
	static inline uint8_t image_get_##f(image_header_t *hdr) \
	{ \
		return hdr->ih_##f; \
	}
image_get_hdr_b (os);
image_get_hdr_b (arch);
image_get_hdr_b (type);
image_get_hdr_b (comp);

static inline char *image_get_name (image_header_t *hdr)
{
	return (char *)hdr->ih_name;
}

static inline uint32_t image_get_data_size (image_header_t *hdr)
{
	return image_get_size (hdr);
}

/**
 * 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
 */
static inline ulong image_get_data (image_header_t *hdr)
{
	return ((ulong)hdr + image_get_header_size ());
}

static inline uint32_t image_get_image_size (image_header_t *hdr)
{
	return (image_get_size (hdr) + image_get_header_size ());
}
static inline ulong image_get_image_end (image_header_t *hdr)
{
	return ((ulong)hdr + image_get_image_size (hdr));
}

#define image_set_hdr_l(f) \
	static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
	{ \
		hdr->ih_##f = cpu_to_uimage (val); \
	}
image_set_hdr_l (magic);
image_set_hdr_l (hcrc);
image_set_hdr_l (time);
image_set_hdr_l (size);
image_set_hdr_l (load);
image_set_hdr_l (ep);
image_set_hdr_l (dcrc);

#define image_set_hdr_b(f) \
	static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
	{ \
		hdr->ih_##f = val; \
	}
image_set_hdr_b (os);
image_set_hdr_b (arch);
image_set_hdr_b (type);
image_set_hdr_b (comp);

static inline void image_set_name (image_header_t *hdr, const char *name)
{
	strncpy (image_get_name (hdr), name, IH_NMLEN);
}

int image_check_hcrc (image_header_t *hdr);
int image_check_dcrc (image_header_t *hdr);
#ifndef USE_HOSTCC
int image_check_dcrc_wd (image_header_t *hdr, ulong chunksize);
int getenv_verify (void);
int getenv_autostart (void);
ulong getenv_bootm_low(void);
ulong getenv_bootm_size(void);
void memmove_wd (void *to, void *from, size_t len, ulong chunksz);
#endif

static inline int image_check_magic (image_header_t *hdr)
{
	return (image_get_magic (hdr) == IH_MAGIC);
}
static inline int image_check_type (image_header_t *hdr, uint8_t type)
{
	return (image_get_type (hdr) == type);
}
static inline int image_check_arch (image_header_t *hdr, uint8_t arch)
{
	return (image_get_arch (hdr) == arch);
}
static inline int image_check_os (image_header_t *hdr, uint8_t os)
{
	return (image_get_os (hdr) == os);
}

ulong image_multi_count (image_header_t *hdr);
void image_multi_getimg (image_header_t *hdr, ulong idx,
			ulong *data, ulong *len);

inline void image_print_contents (image_header_t *hdr);
inline void image_print_contents_noindent (image_header_t *hdr);

#ifndef USE_HOSTCC
static inline int image_check_target_arch (image_header_t *hdr)
{
#if defined(__ARM__)
	if (!image_check_arch (hdr, IH_ARCH_ARM))
#elif defined(__avr32__)
	if (!image_check_arch (hdr, IH_ARCH_AVR32))
#elif defined(__bfin__)
	if (!image_check_arch (hdr, IH_ARCH_BLACKFIN))
#elif defined(__I386__)
	if (!image_check_arch (hdr, IH_ARCH_I386))
#elif defined(__M68K__)
	if (!image_check_arch (hdr, IH_ARCH_M68K))
#elif defined(__microblaze__)
	if (!image_check_arch (hdr, IH_ARCH_MICROBLAZE))
#elif defined(__mips__)
	if (!image_check_arch (hdr, IH_ARCH_MIPS))
#elif defined(__nios__)
	if (!image_check_arch (hdr, IH_ARCH_NIOS))
#elif defined(__nios2__)
	if (!image_check_arch (hdr, IH_ARCH_NIOS2))
#elif defined(__PPC__)
	if (!image_check_arch (hdr, IH_ARCH_PPC))
#elif defined(__sh__)
	if (!image_check_arch (hdr, IH_ARCH_SH))
#else
# error Unknown CPU type
#endif
		return 0;

	return 1;
}

/*******************************************************************/
/* New uImage format specific code (prefixed with fit_) */
/*******************************************************************/
#if defined(CONFIG_FIT)
inline int fit_parse_conf (const char *spec, ulong addr_curr,
		ulong *addr, const char **conf_name);
inline int fit_parse_subimage (const char *spec, ulong addr_curr,
		ulong *addr, const char **image_name);

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

#define fit_unsupported_reset(msg)	printf ("! %s:%d " \
				"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 */
#endif /* CONFIG_FIT */
#endif /* USE_HOSTCC */

#endif	/* __IMAGE_H__ */
Commit	Line	Data
5b1d7137	1	/*
b97a2a0a MB	2	* (C) Copyright 2008 Semihalf
b97a2a0a MB	3	*
f08abe31	4	* (C) Copyright 2000-2005
5b1d7137 WD	5	* Wolfgang Denk, DENX Software Engineering, wd@denx.de.
	6	*
	7	* See file CREDITS for list of people who contributed to this
	8	* project.
	9	*
	10	* This program is free software; you can redistribute it and/or
	11	* modify it under the terms of the GNU General Public License as
	12	* published by the Free Software Foundation; either version 2 of
	13	* the License, or (at your option) any later version.
	14	*
	15	* This program is distributed in the hope that it will be useful,
	16	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	17	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	18	* GNU General Public License for more details.
	19	*
	20	* You should have received a copy of the GNU General Public License
	21	* along with this program; if not, write to the Free Software
	22	* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
	23	* MA 02111-1307 USA
f08abe31 WD	24	*
	25	********************************************************************
	26	* NOTE: This header file defines an interface to U-Boot. Including
	27	* this (unmodified) header file in another file is considered normal
	28	* use of U-Boot, and does not fall under the heading of "derived
	29	* work".
	30	********************************************************************
5b1d7137 WD	31	*/
	32
	33	#ifndef __IMAGE_H__
	34	#define __IMAGE_H__
	35
b97a2a0a	36	#include <asm/byteorder.h>
5ad03eb3	37	#include <command.h>
75d3e8fb	38
b97a2a0a	39	#ifndef USE_HOSTCC
4ed6552f	40	#include <lmb.h>
b97a2a0a	41	#include <linux/string.h>
ceaed2b1	42	#include <asm/u-boot.h>
75d3e8fb MB	43
	44	/* new uImage format support enabled by default */
	45	#define CONFIG_FIT 1
	46	#define CONFIG_OF_LIBFDT 1
	47
d5934ad7 MB	48	/* enable fit_format_error(), fit_format_warning() */
	49	#define CONFIG_FIT_VERBOSE 1
	50
75d3e8fb MB	51	#if defined(CONFIG_FIT) && !defined(CONFIG_OF_LIBFDT)
75d3e8fb MB	52	#error "CONFIG_OF_LIBFDT not enabled, required by CONFIG_FIT!"
b97a2a0a	53	#endif
75d3e8fb	54	#endif /* USE_HOSTCC */
b97a2a0a	55
5b1d7137 WD	56	/*
	57	* Operating System Codes
	58	*/
	59	#define IH_OS_INVALID 0 /* Invalid OS */
	60	#define IH_OS_OPENBSD 1 /* OpenBSD */
	61	#define IH_OS_NETBSD 2 /* NetBSD */
	62	#define IH_OS_FREEBSD 3 /* FreeBSD */
	63	#define IH_OS_4_4BSD 4 /* 4.4BSD */
	64	#define IH_OS_LINUX 5 /* Linux */
	65	#define IH_OS_SVR4 6 /* SVR4 */
	66	#define IH_OS_ESIX 7 /* Esix */
	67	#define IH_OS_SOLARIS 8 /* Solaris */
	68	#define IH_OS_IRIX 9 /* Irix */
	69	#define IH_OS_SCO 10 /* SCO */
	70	#define IH_OS_DELL 11 /* Dell */
	71	#define IH_OS_NCR 12 /* NCR */
	72	#define IH_OS_LYNXOS 13 /* LynxOS */
	73	#define IH_OS_VXWORKS 14 /* VxWorks */
	74	#define IH_OS_PSOS 15 /* pSOS */
	75	#define IH_OS_QNX 16 /* QNX */
	76	#define IH_OS_U_BOOT 17 /* Firmware */
d791b1dc	77	#define IH_OS_RTEMS 18 /* RTEMS */
7f70e853	78	#define IH_OS_ARTOS 19 /* ARTOS */
27b207fd	79	#define IH_OS_UNITY 20 /* Unity OS */
5b1d7137 WD	80
	81	/*
	82	* CPU Architecture Codes (supported by Linux)
	83	*/
b97a2a0a MB	84	#define IH_ARCH_INVALID 0 /* Invalid CPU */
	85	#define IH_ARCH_ALPHA 1 /* Alpha */
	86	#define IH_ARCH_ARM 2 /* ARM */
	87	#define IH_ARCH_I386 3 /* Intel x86 */
	88	#define IH_ARCH_IA64 4 /* IA64 */
	89	#define IH_ARCH_MIPS 5 /* MIPS */
	90	#define IH_ARCH_MIPS64 6 /* MIPS 64 Bit */
	91	#define IH_ARCH_PPC 7 /* PowerPC */
	92	#define IH_ARCH_S390 8 /* IBM S390 */
	93	#define IH_ARCH_SH 9 /* SuperH */
	94	#define IH_ARCH_SPARC 10 /* Sparc */
	95	#define IH_ARCH_SPARC64 11 /* Sparc 64 Bit */
	96	#define IH_ARCH_M68K 12 /* M68K */
	97	#define IH_ARCH_NIOS 13 /* Nios-32 */
	98	#define IH_ARCH_MICROBLAZE 14 /* MicroBlaze */
	99	#define IH_ARCH_NIOS2 15 /* Nios-II */
	100	#define IH_ARCH_BLACKFIN 16 /* Blackfin */
	101	#define IH_ARCH_AVR32 17 /* AVR32 */
	102	#define IH_ARCH_ST200 18 /* STMicroelectronics ST200 */
5b1d7137 WD	103
	104	/*
	105	* Image Types
	106	*
	107	* "Standalone Programs" are directly runnable in the environment
	108	* provided by U-Boot; it is expected that (if they behave
	109	* well) you can continue to work in U-Boot after return from
	110	* the Standalone Program.
	111	* "OS Kernel Images" are usually images of some Embedded OS which
	112	* will take over control completely. Usually these programs
	113	* will install their own set of exception handlers, device
	114	* drivers, set up the MMU, etc. - this means, that you cannot
	115	* expect to re-enter U-Boot except by resetting the CPU.
	116	* "RAMDisk Images" are more or less just data blocks, and their
	117	* parameters (address, size) are passed to an OS kernel that is
	118	* being started.
	119	* "Multi-File Images" contain several images, typically an OS
	120	* (Linux) kernel image and one or more data images like
	121	* RAMDisks. This construct is useful for instance when you want
	122	* to boot over the network using BOOTP etc., where the boot
	123	* server provides just a single image file, but you want to get
	124	* for instance an OS kernel and a RAMDisk image.
	125	*
	126	* "Multi-File Images" start with a list of image sizes, each
	127	* image size (in bytes) specified by an "uint32_t" in network
	128	* byte order. This list is terminated by an "(uint32_t)0".
	129	* Immediately after the terminating 0 follow the images, one by
	130	* one, all aligned on "uint32_t" boundaries (size rounded up to
e1599e83	131	* a multiple of 4 bytes - except for the last file).
5b1d7137 WD	132	*
	133	* "Firmware Images" are binary images containing firmware (like
	134	* U-Boot or FPGA images) which usually will be programmed to
	135	* flash memory.
	136	*
	137	* "Script files" are command sequences that will be executed by
	138	* U-Boot's command interpreter; this feature is especially
	139	* useful when you configure U-Boot to use a real shell (hush)
27b207fd	140	* as command interpreter (=> Shell Scripts).
5b1d7137 WD	141	*/
	142
	143	#define IH_TYPE_INVALID 0 /* Invalid Image */
	144	#define IH_TYPE_STANDALONE 1 /* Standalone Program */
	145	#define IH_TYPE_KERNEL 2 /* OS Kernel Image */
	146	#define IH_TYPE_RAMDISK 3 /* RAMDisk Image */
	147	#define IH_TYPE_MULTI 4 /* Multi-File Image */
	148	#define IH_TYPE_FIRMWARE 5 /* Firmware Image */
	149	#define IH_TYPE_SCRIPT 6 /* Script file */
fbe4b5cb	150	#define IH_TYPE_FILESYSTEM 7 /* Filesystem Image (any type) */
25c751e9	151	#define IH_TYPE_FLATDT 8 /* Binary Flat Device Tree Blob */
5b1d7137 WD	152
	153	/*
	154	* Compression Types
	155	*/
	156	#define IH_COMP_NONE 0 /* No Compression Used */
	157	#define IH_COMP_GZIP 1 /* gzip Compression Used */
	158	#define IH_COMP_BZIP2 2 /* bzip2 Compression Used */
	159
	160	#define IH_MAGIC 0x27051956 /* Image Magic Number */
	161	#define IH_NMLEN 32 /* Image Name Length */
	162
5b1d7137	163	/*
9a4daad0 MB	164	* Legacy format image header,
9a4daad0 MB	165	* all data in network byte order (aka natural aka bigendian).
5b1d7137	166	*/
5b1d7137 WD	167	typedef struct image_header {
	168	uint32_t ih_magic; /* Image Header Magic Number */
	169	uint32_t ih_hcrc; /* Image Header CRC Checksum */
	170	uint32_t ih_time; /* Image Creation Timestamp */
	171	uint32_t ih_size; /* Image Data Size */
	172	uint32_t ih_load; /* Data Load Address */
	173	uint32_t ih_ep; /* Entry Point Address */
	174	uint32_t ih_dcrc; /* Image Data CRC Checksum */
	175	uint8_t ih_os; /* Operating System */
	176	uint8_t ih_arch; /* CPU architecture */
	177	uint8_t ih_type; /* Image Type */
	178	uint8_t ih_comp; /* Compression Type */
	179	uint8_t ih_name[IH_NMLEN]; /* Image Name */
	180	} image_header_t;
	181
d5934ad7 MB	182	/*
	183	* Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
	184	* routines.
	185	*/
	186	typedef struct bootm_headers {
	187	/*
	188	* Legacy os image header, if it is a multi component image
9a4daad0	189	* then boot_get_ramdisk() and get_fdt() will attempt to get
d5934ad7 MB	190	* data from second and third component accordingly.
	191	*/
	192	image_header_t *legacy_hdr_os;
	193	ulong legacy_hdr_valid;
	194
	195	#if defined(CONFIG_FIT)
	196	void fit_hdr_os; / os FIT image header */
	197	char fit_uname_os; / os subimage node unit name */
	198
	199	void fit_hdr_rd; / init ramdisk FIT image header */
	200	char fit_uname_rd; / init ramdisk node unit name */
	201
	202	#if defined(CONFIG_PPC)
	203	void fit_hdr_fdt; / FDT blob FIT image header */
	204	char fit_uname_fdt; / FDT blob node unit name */
	205	#endif
8a5ea3e6	206	int verify; /* getenv("verify")[0] != 'n' */
f5614e79	207	int autostart; /* getenv("autostart")[0] != 'n' */
4ed6552f	208	struct lmb lmb; / for memory mgmt */
d5934ad7 MB	209	#endif
	210	} bootm_headers_t;
	211
559316fa MB	212	/*
	213	* Some systems (for example LWMON) have very short watchdog periods;
	214	* we must make sure to split long operations like memmove() or
	215	* crc32() into reasonable chunks.
	216	*/
	217	#define CHUNKSZ (64 * 1024)
	218
9a4daad0 MB	219	#define uimage_to_cpu(x) ntohl(x)
	220	#define cpu_to_uimage(x) htonl(x)
	221
570abb0a MB	222	const char *genimg_get_os_name (uint8_t os);
	223	const char *genimg_get_arch_name (uint8_t arch);
	224	const char *genimg_get_type_name (uint8_t type);
	225	const char *genimg_get_comp_name (uint8_t comp);
	226	int genimg_get_os_id (const char *name);
	227	int genimg_get_arch_id (const char *name);
	228	int genimg_get_type_id (const char *name);
	229	int genimg_get_comp_id (const char *name);
	230
9a4daad0 MB	231	#ifndef USE_HOSTCC
	232	/* Image format types, returned by _get_format() routine */
	233	#define IMAGE_FORMAT_INVALID 0x00
	234	#define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */
	235	#define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */
	236
	237	int genimg_get_format (void *img_addr);
	238	ulong genimg_get_image (ulong img_addr);
	239
9a4daad0 MB	240	int boot_get_ramdisk (cmd_tbl_t cmdtp, int flag, int argc, char argv[],
	241	bootm_headers_t *images, uint8_t arch,
	242	ulong rd_start, ulong rd_end);
	243
	244	#if defined(CONFIG_PPC) \|\| defined(CONFIG_M68K)
	245	int boot_ramdisk_high (struct lmb *lmb, ulong rd_data, ulong rd_len,
	246	ulong initrd_start, ulong initrd_end);
	247
	248	int boot_get_cmdline (struct lmb lmb, ulong cmd_start, ulong *cmd_end,
	249	ulong bootmap_base);
	250	int boot_get_kbd (struct lmb lmb, bd_t *kbd, ulong bootmap_base);
	251	#endif /* CONFIG_PPC \|\| CONFIG_M68K */
570abb0a	252	#endif /* !USE_HOSTCC */
b97a2a0a	253
9a4daad0 MB	254	/*******************************************************************/
	255	/* Legacy format specific code (prefixed with image_) */
	256	/*******************************************************************/
b97a2a0a MB	257	static inline uint32_t image_get_header_size (void)
	258	{
	259	return (sizeof (image_header_t));
	260	}
	261
	262	#define image_get_hdr_l(f) \
	263	static inline uint32_t image_get_##f(image_header_t *hdr) \
	264	{ \
9a4daad0	265	return uimage_to_cpu (hdr->ih_##f); \
b97a2a0a MB	266	}
	267	image_get_hdr_l (magic);
	268	image_get_hdr_l (hcrc);
	269	image_get_hdr_l (time);
	270	image_get_hdr_l (size);
	271	image_get_hdr_l (load);
	272	image_get_hdr_l (ep);
	273	image_get_hdr_l (dcrc);
	274
	275	#define image_get_hdr_b(f) \
	276	static inline uint8_t image_get_##f(image_header_t *hdr) \
	277	{ \
	278	return hdr->ih_##f; \
	279	}
	280	image_get_hdr_b (os);
	281	image_get_hdr_b (arch);
	282	image_get_hdr_b (type);
	283	image_get_hdr_b (comp);
	284
	285	static inline char image_get_name (image_header_t hdr)
	286	{
	287	return (char *)hdr->ih_name;
	288	}
	289
	290	static inline uint32_t image_get_data_size (image_header_t *hdr)
	291	{
	292	return image_get_size (hdr);
	293	}
f13e7b2e MB	294
	295	/**
	296	* image_get_data - get image payload start address
	297	* @hdr: image header
	298	*
	299	* image_get_data() returns address of the image payload. For single
	300	* component images it is image data start. For multi component
	301	* images it points to the null terminated table of sub-images sizes.
	302	*
	303	* returns:
	304	* image payload data start address
	305	*/
	306	static inline ulong image_get_data (image_header_t *hdr)
	307	{
	308	return ((ulong)hdr + image_get_header_size ());
	309	}
	310
b97a2a0a MB	311	static inline uint32_t image_get_image_size (image_header_t *hdr)
	312	{
	313	return (image_get_size (hdr) + image_get_header_size ());
	314	}
f13e7b2e	315	static inline ulong image_get_image_end (image_header_t *hdr)
b97a2a0a	316	{
f13e7b2e	317	return ((ulong)hdr + image_get_image_size (hdr));
b97a2a0a MB	318	}
	319
	320	#define image_set_hdr_l(f) \
	321	static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
	322	{ \
9a4daad0	323	hdr->ih_##f = cpu_to_uimage (val); \
b97a2a0a MB	324	}
	325	image_set_hdr_l (magic);
	326	image_set_hdr_l (hcrc);
	327	image_set_hdr_l (time);
	328	image_set_hdr_l (size);
	329	image_set_hdr_l (load);
	330	image_set_hdr_l (ep);
	331	image_set_hdr_l (dcrc);
	332
	333	#define image_set_hdr_b(f) \
	334	static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
	335	{ \
	336	hdr->ih_##f = val; \
	337	}
	338	image_set_hdr_b (os);
	339	image_set_hdr_b (arch);
	340	image_set_hdr_b (type);
	341	image_set_hdr_b (comp);
	342
	343	static inline void image_set_name (image_header_t hdr, const char name)
	344	{
	345	strncpy (image_get_name (hdr), name, IH_NMLEN);
	346	}
	347
	348	int image_check_hcrc (image_header_t *hdr);
	349	int image_check_dcrc (image_header_t *hdr);
af13cdbc	350	#ifndef USE_HOSTCC
b97a2a0a MB	351	int image_check_dcrc_wd (image_header_t *hdr, ulong chunksize);
b97a2a0a MB	352	int getenv_verify (void);
f5614e79	353	int getenv_autostart (void);
d3f2fa0d KG	354	ulong getenv_bootm_low(void);
d3f2fa0d KG	355	ulong getenv_bootm_size(void);
af13cdbc MB	356	void memmove_wd (void to, void from, size_t len, ulong chunksz);
af13cdbc MB	357	#endif
b97a2a0a MB	358
	359	static inline int image_check_magic (image_header_t *hdr)
	360	{
	361	return (image_get_magic (hdr) == IH_MAGIC);
	362	}
	363	static inline int image_check_type (image_header_t *hdr, uint8_t type)
	364	{
	365	return (image_get_type (hdr) == type);
	366	}
	367	static inline int image_check_arch (image_header_t *hdr, uint8_t arch)
	368	{
	369	return (image_get_arch (hdr) == arch);
	370	}
	371	static inline int image_check_os (image_header_t *hdr, uint8_t os)
	372	{
	373	return (image_get_os (hdr) == os);
	374	}
	375
42b73e8e MB	376	ulong image_multi_count (image_header_t *hdr);
	377	void image_multi_getimg (image_header_t *hdr, ulong idx,
	378	ulong data, ulong len);
	379
570abb0a MB	380	inline void image_print_contents (image_header_t *hdr);
	381	inline void image_print_contents_noindent (image_header_t *hdr);
	382
b97a2a0a MB	383	#ifndef USE_HOSTCC
	384	static inline int image_check_target_arch (image_header_t *hdr)
	385	{
	386	#if defined(__ARM__)
	387	if (!image_check_arch (hdr, IH_ARCH_ARM))
	388	#elif defined(__avr32__)
	389	if (!image_check_arch (hdr, IH_ARCH_AVR32))
	390	#elif defined(__bfin__)
	391	if (!image_check_arch (hdr, IH_ARCH_BLACKFIN))
	392	#elif defined(__I386__)
	393	if (!image_check_arch (hdr, IH_ARCH_I386))
	394	#elif defined(__M68K__)
	395	if (!image_check_arch (hdr, IH_ARCH_M68K))
	396	#elif defined(__microblaze__)
	397	if (!image_check_arch (hdr, IH_ARCH_MICROBLAZE))
	398	#elif defined(__mips__)
	399	if (!image_check_arch (hdr, IH_ARCH_MIPS))
	400	#elif defined(__nios__)
	401	if (!image_check_arch (hdr, IH_ARCH_NIOS))
	402	#elif defined(__nios2__)
	403	if (!image_check_arch (hdr, IH_ARCH_NIOS2))
	404	#elif defined(__PPC__)
	405	if (!image_check_arch (hdr, IH_ARCH_PPC))
	406	#elif defined(__sh__)
	407	if (!image_check_arch (hdr, IH_ARCH_SH))
	408	#else
	409	# error Unknown CPU type
	410	#endif
	411	return 0;
	412
	413	return 1;
	414	}
5b1d7137	415
d5934ad7	416	/*******************************************************************/
9a4daad0	417	/* New uImage format specific code (prefixed with fit_) */
d5934ad7	418	/*******************************************************************/
f50433d6	419	#if defined(CONFIG_FIT)
f50433d6 MB	420	inline int fit_parse_conf (const char *spec, ulong addr_curr,
	421	ulong addr, const char *conf_name);
	422	inline int fit_parse_subimage (const char *spec, ulong addr_curr,
	423	ulong addr, const char *image_name);
d5934ad7 MB	424
	425	#ifdef CONFIG_FIT_VERBOSE
	426	#define fit_unsupported(msg) printf ("! %s:%d " \
	427	"FIT images not supported for '%s'\n", \
	428	__FILE__, __LINE__, (msg))
	429
	430	#define fit_unsupported_reset(msg) printf ("! %s:%d " \
	431	"FIT images not supported for '%s' " \
	432	"- must reset board to recover!\n", \
	433	__FILE__, __LINE__, (msg))
	434	#else
	435	#define fit_unsupported(msg)
	436	#define fit_unsupported_reset(msg)
	437	#endif /* CONFIG_FIT_VERBOSE */
f50433d6	438	#endif /* CONFIG_FIT */
ceaed2b1	439	#endif /* USE_HOSTCC */
5ad03eb3	440
f13e7b2e	441	#endif /* __IMAGE_H__ */