xref: /rk3399_rockchip-uboot/include/image.h (revision 476af299b04ef07117bbc3cdef07885e1089967e)
15b1d7137Swdenk /*
2b97a2a0aSMarian Balakowicz  * (C) Copyright 2008 Semihalf
3b97a2a0aSMarian Balakowicz  *
4f08abe31SWolfgang Denk  * (C) Copyright 2000-2005
55b1d7137Swdenk  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
65b1d7137Swdenk  *
75b1d7137Swdenk  * See file CREDITS for list of people who contributed to this
85b1d7137Swdenk  * project.
95b1d7137Swdenk  *
105b1d7137Swdenk  * This program is free software; you can redistribute it and/or
115b1d7137Swdenk  * modify it under the terms of the GNU General Public License as
125b1d7137Swdenk  * published by the Free Software Foundation; either version 2 of
135b1d7137Swdenk  * the License, or (at your option) any later version.
145b1d7137Swdenk  *
155b1d7137Swdenk  * This program is distributed in the hope that it will be useful,
165b1d7137Swdenk  * but WITHOUT ANY WARRANTY; without even the implied warranty of
175b1d7137Swdenk  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	 See the
185b1d7137Swdenk  * GNU General Public License for more details.
195b1d7137Swdenk  *
205b1d7137Swdenk  * You should have received a copy of the GNU General Public License
215b1d7137Swdenk  * along with this program; if not, write to the Free Software
225b1d7137Swdenk  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
235b1d7137Swdenk  * MA 02111-1307 USA
24f08abe31SWolfgang Denk  *
25f08abe31SWolfgang Denk  ********************************************************************
26f08abe31SWolfgang Denk  * NOTE: This header file defines an interface to U-Boot. Including
27f08abe31SWolfgang Denk  * this (unmodified) header file in another file is considered normal
28f08abe31SWolfgang Denk  * use of U-Boot, and does *not* fall under the heading of "derived
29f08abe31SWolfgang Denk  * work".
30f08abe31SWolfgang Denk  ********************************************************************
315b1d7137Swdenk  */
325b1d7137Swdenk 
335b1d7137Swdenk #ifndef __IMAGE_H__
345b1d7137Swdenk #define __IMAGE_H__
355b1d7137Swdenk 
3637566090SMike Frysinger #include "compiler.h"
3737566090SMike Frysinger 
3837566090SMike Frysinger #ifdef USE_HOSTCC
399d25438fSBartlomiej Sieka 
409d25438fSBartlomiej Sieka /* new uImage format support enabled on host */
419d25438fSBartlomiej Sieka #define CONFIG_FIT		1
429d25438fSBartlomiej Sieka #define CONFIG_OF_LIBFDT	1
439d25438fSBartlomiej Sieka #define CONFIG_FIT_VERBOSE	1 /* enable fit_format_{error,warning}() */
449d25438fSBartlomiej Sieka 
45def0819eSWolfgang Denk #else
46def0819eSWolfgang Denk 
47def0819eSWolfgang Denk #include <lmb.h>
48def0819eSWolfgang Denk #include <asm/u-boot.h>
495daa1c18SMike Frysinger #include <command.h>
50def0819eSWolfgang Denk 
519d25438fSBartlomiej Sieka #endif /* USE_HOSTCC */
52d5934ad7SMarian Balakowicz 
535dfb5213SMarian Balakowicz #if defined(CONFIG_FIT)
545dfb5213SMarian Balakowicz #include <fdt.h>
555dfb5213SMarian Balakowicz #include <libfdt.h>
565dfb5213SMarian Balakowicz #include <fdt_support.h>
57766529fcSBartlomiej Sieka #define CONFIG_MD5		/* FIT images need MD5 support */
58dac4d7e8SMike Frysinger #define CONFIG_SHA1		/* and SHA1 */
595dfb5213SMarian Balakowicz #endif
60b97a2a0aSMarian Balakowicz 
615b1d7137Swdenk /*
625b1d7137Swdenk  * Operating System Codes
635b1d7137Swdenk  */
645b1d7137Swdenk #define IH_OS_INVALID		0	/* Invalid OS	*/
655b1d7137Swdenk #define IH_OS_OPENBSD		1	/* OpenBSD	*/
665b1d7137Swdenk #define IH_OS_NETBSD		2	/* NetBSD	*/
675b1d7137Swdenk #define IH_OS_FREEBSD		3	/* FreeBSD	*/
685b1d7137Swdenk #define IH_OS_4_4BSD		4	/* 4.4BSD	*/
695b1d7137Swdenk #define IH_OS_LINUX		5	/* Linux	*/
705b1d7137Swdenk #define IH_OS_SVR4		6	/* SVR4		*/
715b1d7137Swdenk #define IH_OS_ESIX		7	/* Esix		*/
725b1d7137Swdenk #define IH_OS_SOLARIS		8	/* Solaris	*/
735b1d7137Swdenk #define IH_OS_IRIX		9	/* Irix		*/
745b1d7137Swdenk #define IH_OS_SCO		10	/* SCO		*/
755b1d7137Swdenk #define IH_OS_DELL		11	/* Dell		*/
765b1d7137Swdenk #define IH_OS_NCR		12	/* NCR		*/
775b1d7137Swdenk #define IH_OS_LYNXOS		13	/* LynxOS	*/
785b1d7137Swdenk #define IH_OS_VXWORKS		14	/* VxWorks	*/
795b1d7137Swdenk #define IH_OS_PSOS		15	/* pSOS		*/
805b1d7137Swdenk #define IH_OS_QNX		16	/* QNX		*/
815b1d7137Swdenk #define IH_OS_U_BOOT		17	/* Firmware	*/
82d791b1dcSwdenk #define IH_OS_RTEMS		18	/* RTEMS	*/
837f70e853Swdenk #define IH_OS_ARTOS		19	/* ARTOS	*/
8427b207fdSwdenk #define IH_OS_UNITY		20	/* Unity OS	*/
85f5ed9e39SPeter Tyser #define IH_OS_INTEGRITY		21	/* INTEGRITY	*/
863df61957STorkel Lundgren #define IH_OS_OSE		22	/* OSE		*/
875b1d7137Swdenk 
885b1d7137Swdenk /*
895b1d7137Swdenk  * CPU Architecture Codes (supported by Linux)
905b1d7137Swdenk  */
91b97a2a0aSMarian Balakowicz #define IH_ARCH_INVALID		0	/* Invalid CPU	*/
92b97a2a0aSMarian Balakowicz #define IH_ARCH_ALPHA		1	/* Alpha	*/
93b97a2a0aSMarian Balakowicz #define IH_ARCH_ARM		2	/* ARM		*/
94b97a2a0aSMarian Balakowicz #define IH_ARCH_I386		3	/* Intel x86	*/
95b97a2a0aSMarian Balakowicz #define IH_ARCH_IA64		4	/* IA64		*/
96b97a2a0aSMarian Balakowicz #define IH_ARCH_MIPS		5	/* MIPS		*/
97b97a2a0aSMarian Balakowicz #define IH_ARCH_MIPS64		6	/* MIPS	 64 Bit */
98b97a2a0aSMarian Balakowicz #define IH_ARCH_PPC		7	/* PowerPC	*/
99b97a2a0aSMarian Balakowicz #define IH_ARCH_S390		8	/* IBM S390	*/
100b97a2a0aSMarian Balakowicz #define IH_ARCH_SH		9	/* SuperH	*/
101b97a2a0aSMarian Balakowicz #define IH_ARCH_SPARC		10	/* Sparc	*/
102b97a2a0aSMarian Balakowicz #define IH_ARCH_SPARC64		11	/* Sparc 64 Bit */
103b97a2a0aSMarian Balakowicz #define IH_ARCH_M68K		12	/* M68K		*/
104b97a2a0aSMarian Balakowicz #define IH_ARCH_MICROBLAZE	14	/* MicroBlaze   */
105b97a2a0aSMarian Balakowicz #define IH_ARCH_NIOS2		15	/* Nios-II	*/
106b97a2a0aSMarian Balakowicz #define IH_ARCH_BLACKFIN	16	/* Blackfin	*/
107b97a2a0aSMarian Balakowicz #define IH_ARCH_AVR32		17	/* AVR32	*/
108b97a2a0aSMarian Balakowicz #define IH_ARCH_ST200	        18	/* STMicroelectronics ST200  */
1095b1d7137Swdenk 
1105b1d7137Swdenk /*
1115b1d7137Swdenk  * Image Types
1125b1d7137Swdenk  *
1135b1d7137Swdenk  * "Standalone Programs" are directly runnable in the environment
1145b1d7137Swdenk  *	provided by U-Boot; it is expected that (if they behave
1155b1d7137Swdenk  *	well) you can continue to work in U-Boot after return from
1165b1d7137Swdenk  *	the Standalone Program.
1175b1d7137Swdenk  * "OS Kernel Images" are usually images of some Embedded OS which
1185b1d7137Swdenk  *	will take over control completely. Usually these programs
1195b1d7137Swdenk  *	will install their own set of exception handlers, device
1205b1d7137Swdenk  *	drivers, set up the MMU, etc. - this means, that you cannot
1215b1d7137Swdenk  *	expect to re-enter U-Boot except by resetting the CPU.
1225b1d7137Swdenk  * "RAMDisk Images" are more or less just data blocks, and their
1235b1d7137Swdenk  *	parameters (address, size) are passed to an OS kernel that is
1245b1d7137Swdenk  *	being started.
1255b1d7137Swdenk  * "Multi-File Images" contain several images, typically an OS
1265b1d7137Swdenk  *	(Linux) kernel image and one or more data images like
1275b1d7137Swdenk  *	RAMDisks. This construct is useful for instance when you want
1285b1d7137Swdenk  *	to boot over the network using BOOTP etc., where the boot
1295b1d7137Swdenk  *	server provides just a single image file, but you want to get
1305b1d7137Swdenk  *	for instance an OS kernel and a RAMDisk image.
1315b1d7137Swdenk  *
1325b1d7137Swdenk  *	"Multi-File Images" start with a list of image sizes, each
1335b1d7137Swdenk  *	image size (in bytes) specified by an "uint32_t" in network
1345b1d7137Swdenk  *	byte order. This list is terminated by an "(uint32_t)0".
1355b1d7137Swdenk  *	Immediately after the terminating 0 follow the images, one by
1365b1d7137Swdenk  *	one, all aligned on "uint32_t" boundaries (size rounded up to
137e1599e83Swdenk  *	a multiple of 4 bytes - except for the last file).
1385b1d7137Swdenk  *
1395b1d7137Swdenk  * "Firmware Images" are binary images containing firmware (like
1405b1d7137Swdenk  *	U-Boot or FPGA images) which usually will be programmed to
1415b1d7137Swdenk  *	flash memory.
1425b1d7137Swdenk  *
1435b1d7137Swdenk  * "Script files" are command sequences that will be executed by
1445b1d7137Swdenk  *	U-Boot's command interpreter; this feature is especially
1455b1d7137Swdenk  *	useful when you configure U-Boot to use a real shell (hush)
14627b207fdSwdenk  *	as command interpreter (=> Shell Scripts).
1475b1d7137Swdenk  */
1485b1d7137Swdenk 
1495b1d7137Swdenk #define IH_TYPE_INVALID		0	/* Invalid Image		*/
1505b1d7137Swdenk #define IH_TYPE_STANDALONE	1	/* Standalone Program		*/
1515b1d7137Swdenk #define IH_TYPE_KERNEL		2	/* OS Kernel Image		*/
1525b1d7137Swdenk #define IH_TYPE_RAMDISK		3	/* RAMDisk Image		*/
1535b1d7137Swdenk #define IH_TYPE_MULTI		4	/* Multi-File Image		*/
1545b1d7137Swdenk #define IH_TYPE_FIRMWARE	5	/* Firmware Image		*/
1555b1d7137Swdenk #define IH_TYPE_SCRIPT		6	/* Script file			*/
156fbe4b5cbSwdenk #define IH_TYPE_FILESYSTEM	7	/* Filesystem Image (any type)	*/
15725c751e9SMatthew McClintock #define IH_TYPE_FLATDT		8	/* Binary Flat Device Tree Blob	*/
158aa0c7a86SPrafulla Wadaskar #define IH_TYPE_KWBIMAGE	9	/* Kirkwood Boot Image		*/
1598edcde5eSStefano Babic #define IH_TYPE_IMXIMAGE	10	/* Freescale IMXBoot Image	*/
1607816f2cfSHeiko Schocher #define IH_TYPE_UBLIMAGE	11	/* Davinci UBL Image		*/
1613decb14aSJohn Rigby #define IH_TYPE_OMAPIMAGE	12	/* TI OMAP Config Header Image	*/
1625b1d7137Swdenk 
1635b1d7137Swdenk /*
1645b1d7137Swdenk  * Compression Types
1655b1d7137Swdenk  */
1665b1d7137Swdenk #define IH_COMP_NONE		0	/*  No	 Compression Used	*/
1675b1d7137Swdenk #define IH_COMP_GZIP		1	/* gzip	 Compression Used	*/
1685b1d7137Swdenk #define IH_COMP_BZIP2		2	/* bzip2 Compression Used	*/
169fc9c1727SLuigi 'Comio' Mantellini #define IH_COMP_LZMA		3	/* lzma  Compression Used	*/
17020dde48bSPeter Korsgaard #define IH_COMP_LZO		4	/* lzo   Compression Used	*/
1715b1d7137Swdenk 
1725b1d7137Swdenk #define IH_MAGIC	0x27051956	/* Image Magic Number		*/
1735b1d7137Swdenk #define IH_NMLEN		32	/* Image Name Length		*/
1745b1d7137Swdenk 
1755b1d7137Swdenk /*
1769a4daad0SMarian Balakowicz  * Legacy format image header,
1779a4daad0SMarian Balakowicz  * all data in network byte order (aka natural aka bigendian).
1785b1d7137Swdenk  */
1795b1d7137Swdenk typedef struct image_header {
1805b1d7137Swdenk 	uint32_t	ih_magic;	/* Image Header Magic Number	*/
1815b1d7137Swdenk 	uint32_t	ih_hcrc;	/* Image Header CRC Checksum	*/
1825b1d7137Swdenk 	uint32_t	ih_time;	/* Image Creation Timestamp	*/
1835b1d7137Swdenk 	uint32_t	ih_size;	/* Image Data Size		*/
1845b1d7137Swdenk 	uint32_t	ih_load;	/* Data	 Load  Address		*/
1855b1d7137Swdenk 	uint32_t	ih_ep;		/* Entry Point Address		*/
1865b1d7137Swdenk 	uint32_t	ih_dcrc;	/* Image Data CRC Checksum	*/
1875b1d7137Swdenk 	uint8_t		ih_os;		/* Operating System		*/
1885b1d7137Swdenk 	uint8_t		ih_arch;	/* CPU architecture		*/
1895b1d7137Swdenk 	uint8_t		ih_type;	/* Image Type			*/
1905b1d7137Swdenk 	uint8_t		ih_comp;	/* Compression Type		*/
1915b1d7137Swdenk 	uint8_t		ih_name[IH_NMLEN];	/* Image Name		*/
1925b1d7137Swdenk } image_header_t;
1935b1d7137Swdenk 
194396f635bSKumar Gala typedef struct image_info {
195396f635bSKumar Gala 	ulong		start, end;		/* start/end of blob */
196396f635bSKumar Gala 	ulong		image_start, image_len; /* start of image within blob, len of image */
197396f635bSKumar Gala 	ulong		load;			/* load addr for the image */
198396f635bSKumar Gala 	uint8_t		comp, type, os;		/* compression, type of image, os type */
199396f635bSKumar Gala } image_info_t;
200396f635bSKumar Gala 
201559316faSMarian Balakowicz /*
202d5934ad7SMarian Balakowicz  * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
203d5934ad7SMarian Balakowicz  * routines.
204d5934ad7SMarian Balakowicz  */
205d5934ad7SMarian Balakowicz typedef struct bootm_headers {
206d5934ad7SMarian Balakowicz 	/*
207d5934ad7SMarian Balakowicz 	 * Legacy os image header, if it is a multi component image
2089a4daad0SMarian Balakowicz 	 * then boot_get_ramdisk() and get_fdt() will attempt to get
209d5934ad7SMarian Balakowicz 	 * data from second and third component accordingly.
210d5934ad7SMarian Balakowicz 	 */
211cb1c4896SMarian Balakowicz 	image_header_t	*legacy_hdr_os;		/* image header pointer */
212cb1c4896SMarian Balakowicz 	image_header_t	legacy_hdr_os_copy;	/* header copy */
213d5934ad7SMarian Balakowicz 	ulong		legacy_hdr_valid;
214d5934ad7SMarian Balakowicz 
215d5934ad7SMarian Balakowicz #if defined(CONFIG_FIT)
216f773bea8SMarian Balakowicz 	const char	*fit_uname_cfg;	/* configuration node unit name */
217f773bea8SMarian Balakowicz 
218d5934ad7SMarian Balakowicz 	void		*fit_hdr_os;	/* os FIT image header */
219eb6175edSMarian Balakowicz 	const char	*fit_uname_os;	/* os subimage node unit name */
2203dfe1101SMarian Balakowicz 	int		fit_noffset_os;	/* os subimage node offset */
221d5934ad7SMarian Balakowicz 
222d5934ad7SMarian Balakowicz 	void		*fit_hdr_rd;	/* init ramdisk FIT image header */
2233dfe1101SMarian Balakowicz 	const char	*fit_uname_rd;	/* init ramdisk subimage node unit name */
2243dfe1101SMarian Balakowicz 	int		fit_noffset_rd;	/* init ramdisk subimage node offset */
225d5934ad7SMarian Balakowicz 
226d5934ad7SMarian Balakowicz 	void		*fit_hdr_fdt;	/* FDT blob FIT image header */
2273dfe1101SMarian Balakowicz 	const char	*fit_uname_fdt;	/* FDT blob subimage node unit name */
2283dfe1101SMarian Balakowicz 	int		fit_noffset_fdt;/* FDT blob subimage node offset */
229d5934ad7SMarian Balakowicz #endif
2301ec73761SMarian Balakowicz 
23149c3a861SKumar Gala #ifndef USE_HOSTCC
232396f635bSKumar Gala 	image_info_t	os;		/* os image info */
233c160a954SKumar Gala 	ulong		ep;		/* entry point of OS */
234c160a954SKumar Gala 
235c4f9419cSKumar Gala 	ulong		rd_start, rd_end;/* ramdisk start/end */
236c4f9419cSKumar Gala 
23706a09918SKumar Gala #ifdef CONFIG_OF_LIBFDT
23806a09918SKumar Gala 	char		*ft_addr;	/* flat dev tree address */
23906a09918SKumar Gala #endif
24006a09918SKumar Gala 	ulong		ft_len;		/* length of flat device tree */
24106a09918SKumar Gala 
24249c3a861SKumar Gala 	ulong		initrd_start;
24349c3a861SKumar Gala 	ulong		initrd_end;
24449c3a861SKumar Gala 	ulong		cmdline_start;
24549c3a861SKumar Gala 	ulong		cmdline_end;
24649c3a861SKumar Gala 	bd_t		*kbd;
24749c3a861SKumar Gala #endif
24849c3a861SKumar Gala 
2498a5ea3e6SMarian Balakowicz 	int		verify;		/* getenv("verify")[0] != 'n' */
25049c3a861SKumar Gala 
25149c3a861SKumar Gala #define	BOOTM_STATE_START	(0x00000001)
25249c3a861SKumar Gala #define	BOOTM_STATE_LOADOS	(0x00000002)
25349c3a861SKumar Gala #define	BOOTM_STATE_RAMDISK	(0x00000004)
25449c3a861SKumar Gala #define	BOOTM_STATE_FDT		(0x00000008)
25549c3a861SKumar Gala #define	BOOTM_STATE_OS_CMDLINE	(0x00000010)
25649c3a861SKumar Gala #define	BOOTM_STATE_OS_BD_T	(0x00000020)
25749c3a861SKumar Gala #define	BOOTM_STATE_OS_PREP	(0x00000040)
25849c3a861SKumar Gala #define	BOOTM_STATE_OS_GO	(0x00000080)
25949c3a861SKumar Gala 	int		state;
26049c3a861SKumar Gala 
261a16028daSMike Frysinger #ifdef CONFIG_LMB
262e906cfaeSKumar Gala 	struct lmb	lmb;		/* for memory mgmt */
263e906cfaeSKumar Gala #endif
264d5934ad7SMarian Balakowicz } bootm_headers_t;
265d5934ad7SMarian Balakowicz 
266d5934ad7SMarian Balakowicz /*
267559316faSMarian Balakowicz  * Some systems (for example LWMON) have very short watchdog periods;
268559316faSMarian Balakowicz  * we must make sure to split long operations like memmove() or
2697590378fSBartlomiej Sieka  * checksum calculations into reasonable chunks.
270559316faSMarian Balakowicz  */
2717590378fSBartlomiej Sieka #ifndef CHUNKSZ
272559316faSMarian Balakowicz #define CHUNKSZ (64 * 1024)
2737590378fSBartlomiej Sieka #endif
2747590378fSBartlomiej Sieka 
2757590378fSBartlomiej Sieka #ifndef CHUNKSZ_CRC32
2767590378fSBartlomiej Sieka #define CHUNKSZ_CRC32 (64 * 1024)
2777590378fSBartlomiej Sieka #endif
2787590378fSBartlomiej Sieka 
2797590378fSBartlomiej Sieka #ifndef CHUNKSZ_MD5
2807590378fSBartlomiej Sieka #define CHUNKSZ_MD5 (64 * 1024)
2817590378fSBartlomiej Sieka #endif
2827590378fSBartlomiej Sieka 
2837590378fSBartlomiej Sieka #ifndef CHUNKSZ_SHA1
2847590378fSBartlomiej Sieka #define CHUNKSZ_SHA1 (64 * 1024)
2857590378fSBartlomiej Sieka #endif
286559316faSMarian Balakowicz 
28737566090SMike Frysinger #define uimage_to_cpu(x)		be32_to_cpu(x)
28837566090SMike Frysinger #define cpu_to_uimage(x)		cpu_to_be32(x)
289b97a2a0aSMarian Balakowicz 
290b029dddcSPrafulla Wadaskar /*
291b029dddcSPrafulla Wadaskar  * Translation table for entries of a specific type; used by
292b029dddcSPrafulla Wadaskar  * get_table_entry_id() and get_table_entry_name().
293b029dddcSPrafulla Wadaskar  */
294b029dddcSPrafulla Wadaskar typedef struct table_entry {
295b029dddcSPrafulla Wadaskar 	int	id;
296b029dddcSPrafulla Wadaskar 	char	*sname;		/* short (input) name to find table entry */
297b029dddcSPrafulla Wadaskar 	char	*lname;		/* long (output) name to print for messages */
298b029dddcSPrafulla Wadaskar } table_entry_t;
299b029dddcSPrafulla Wadaskar 
300b029dddcSPrafulla Wadaskar /*
301b029dddcSPrafulla Wadaskar  * get_table_entry_id() scans the translation table trying to find an
302b029dddcSPrafulla Wadaskar  * entry that matches the given short name. If a matching entry is
303b029dddcSPrafulla Wadaskar  * found, it's id is returned to the caller.
304b029dddcSPrafulla Wadaskar  */
3057edb186fSMike Frysinger int get_table_entry_id(const table_entry_t *table,
306b029dddcSPrafulla Wadaskar 		const char *table_name, const char *name);
307b029dddcSPrafulla Wadaskar /*
308b029dddcSPrafulla Wadaskar  * get_table_entry_name() scans the translation table trying to find
309b029dddcSPrafulla Wadaskar  * an entry that matches the given id. If a matching entry is found,
310b029dddcSPrafulla Wadaskar  * its long name is returned to the caller.
311b029dddcSPrafulla Wadaskar  */
3127edb186fSMike Frysinger char *get_table_entry_name(const table_entry_t *table, char *msg, int id);
313b029dddcSPrafulla Wadaskar 
314570abb0aSMarian Balakowicz const char *genimg_get_os_name (uint8_t os);
315570abb0aSMarian Balakowicz const char *genimg_get_arch_name (uint8_t arch);
316570abb0aSMarian Balakowicz const char *genimg_get_type_name (uint8_t type);
317570abb0aSMarian Balakowicz const char *genimg_get_comp_name (uint8_t comp);
318570abb0aSMarian Balakowicz int genimg_get_os_id (const char *name);
319570abb0aSMarian Balakowicz int genimg_get_arch_id (const char *name);
320570abb0aSMarian Balakowicz int genimg_get_type_id (const char *name);
321570abb0aSMarian Balakowicz int genimg_get_comp_id (const char *name);
322f666dea8SPrafulla Wadaskar void genimg_print_size (uint32_t size);
323570abb0aSMarian Balakowicz 
3249a4daad0SMarian Balakowicz #ifndef USE_HOSTCC
3259a4daad0SMarian Balakowicz /* Image format types, returned by _get_format() routine */
3269a4daad0SMarian Balakowicz #define IMAGE_FORMAT_INVALID	0x00
3279a4daad0SMarian Balakowicz #define IMAGE_FORMAT_LEGACY	0x01	/* legacy image_header based format */
3289a4daad0SMarian Balakowicz #define IMAGE_FORMAT_FIT	0x02	/* new, libfdt based format */
3299a4daad0SMarian Balakowicz 
3309a4daad0SMarian Balakowicz int genimg_get_format (void *img_addr);
331f773bea8SMarian Balakowicz int genimg_has_config (bootm_headers_t *images);
3329a4daad0SMarian Balakowicz ulong genimg_get_image (ulong img_addr);
3339a4daad0SMarian Balakowicz 
33454841ab5SWolfgang Denk int boot_get_ramdisk (int argc, char * const argv[], bootm_headers_t *images,
335d985c849SMarian Balakowicz 		uint8_t arch, ulong *rd_start, ulong *rd_end);
3369a4daad0SMarian Balakowicz 
33706a09918SKumar Gala 
33806a09918SKumar Gala #ifdef CONFIG_OF_LIBFDT
33954841ab5SWolfgang Denk int boot_get_fdt (int flag, int argc, char * const argv[], bootm_headers_t *images,
34006a09918SKumar Gala 		char **of_flat_tree, ulong *of_size);
34155b0a393SGrant Likely void boot_fdt_add_mem_rsv_regions(struct lmb *lmb, void *fdt_blob);
342590d3cacSGrant Likely int boot_relocate_fdt (struct lmb *lmb, char **of_flat_tree, ulong *of_size);
34306a09918SKumar Gala #endif
34406a09918SKumar Gala 
345fca43cc8SJohn Rigby #ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH
3469a4daad0SMarian Balakowicz int boot_ramdisk_high (struct lmb *lmb, ulong rd_data, ulong rd_len,
3479a4daad0SMarian Balakowicz 		  ulong *initrd_start, ulong *initrd_end);
348fca43cc8SJohn Rigby #endif /* CONFIG_SYS_BOOT_RAMDISK_HIGH */
349fca43cc8SJohn Rigby #ifdef CONFIG_SYS_BOOT_GET_CMDLINE
350590d3cacSGrant Likely int boot_get_cmdline (struct lmb *lmb, ulong *cmd_start, ulong *cmd_end);
351fca43cc8SJohn Rigby #endif /* CONFIG_SYS_BOOT_GET_CMDLINE */
352fca43cc8SJohn Rigby #ifdef CONFIG_SYS_BOOT_GET_KBD
353590d3cacSGrant Likely int boot_get_kbd (struct lmb *lmb, bd_t **kbd);
354fca43cc8SJohn Rigby #endif /* CONFIG_SYS_BOOT_GET_KBD */
355570abb0aSMarian Balakowicz #endif /* !USE_HOSTCC */
3569a4daad0SMarian Balakowicz 
3579a4daad0SMarian Balakowicz /*******************************************************************/
3589a4daad0SMarian Balakowicz /* Legacy format specific code (prefixed with image_) */
3599a4daad0SMarian Balakowicz /*******************************************************************/
360b97a2a0aSMarian Balakowicz static inline uint32_t image_get_header_size (void)
361b97a2a0aSMarian Balakowicz {
362b97a2a0aSMarian Balakowicz 	return (sizeof (image_header_t));
363b97a2a0aSMarian Balakowicz }
364b97a2a0aSMarian Balakowicz 
365b97a2a0aSMarian Balakowicz #define image_get_hdr_l(f) \
3663a2003f6SWolfgang Denk 	static inline uint32_t image_get_##f(const image_header_t *hdr) \
367b97a2a0aSMarian Balakowicz 	{ \
3689a4daad0SMarian Balakowicz 		return uimage_to_cpu (hdr->ih_##f); \
369b97a2a0aSMarian Balakowicz 	}
370178e26d7SWolfgang Denk image_get_hdr_l (magic)		/* image_get_magic */
371178e26d7SWolfgang Denk image_get_hdr_l (hcrc)		/* image_get_hcrc */
372178e26d7SWolfgang Denk image_get_hdr_l (time)		/* image_get_time */
373178e26d7SWolfgang Denk image_get_hdr_l (size)		/* image_get_size */
374178e26d7SWolfgang Denk image_get_hdr_l (load)		/* image_get_load */
375178e26d7SWolfgang Denk image_get_hdr_l (ep)		/* image_get_ep */
376178e26d7SWolfgang Denk image_get_hdr_l (dcrc)		/* image_get_dcrc */
377b97a2a0aSMarian Balakowicz 
378b97a2a0aSMarian Balakowicz #define image_get_hdr_b(f) \
3793a2003f6SWolfgang Denk 	static inline uint8_t image_get_##f(const image_header_t *hdr) \
380b97a2a0aSMarian Balakowicz 	{ \
381b97a2a0aSMarian Balakowicz 		return hdr->ih_##f; \
382b97a2a0aSMarian Balakowicz 	}
383178e26d7SWolfgang Denk image_get_hdr_b (os)		/* image_get_os */
384178e26d7SWolfgang Denk image_get_hdr_b (arch)		/* image_get_arch */
385178e26d7SWolfgang Denk image_get_hdr_b (type)		/* image_get_type */
386178e26d7SWolfgang Denk image_get_hdr_b (comp)		/* image_get_comp */
387b97a2a0aSMarian Balakowicz 
3883a2003f6SWolfgang Denk static inline char *image_get_name (const image_header_t *hdr)
389b97a2a0aSMarian Balakowicz {
390b97a2a0aSMarian Balakowicz 	return (char *)hdr->ih_name;
391b97a2a0aSMarian Balakowicz }
392b97a2a0aSMarian Balakowicz 
3933a2003f6SWolfgang Denk static inline uint32_t image_get_data_size (const image_header_t *hdr)
394b97a2a0aSMarian Balakowicz {
395b97a2a0aSMarian Balakowicz 	return image_get_size (hdr);
396b97a2a0aSMarian Balakowicz }
397f13e7b2eSMarian Balakowicz 
398f13e7b2eSMarian Balakowicz /**
399f13e7b2eSMarian Balakowicz  * image_get_data - get image payload start address
400f13e7b2eSMarian Balakowicz  * @hdr: image header
401f13e7b2eSMarian Balakowicz  *
402f13e7b2eSMarian Balakowicz  * image_get_data() returns address of the image payload. For single
403f13e7b2eSMarian Balakowicz  * component images it is image data start. For multi component
404f13e7b2eSMarian Balakowicz  * images it points to the null terminated table of sub-images sizes.
405f13e7b2eSMarian Balakowicz  *
406f13e7b2eSMarian Balakowicz  * returns:
407f13e7b2eSMarian Balakowicz  *     image payload data start address
408f13e7b2eSMarian Balakowicz  */
4093a2003f6SWolfgang Denk static inline ulong image_get_data (const image_header_t *hdr)
410f13e7b2eSMarian Balakowicz {
411f13e7b2eSMarian Balakowicz 	return ((ulong)hdr + image_get_header_size ());
412f13e7b2eSMarian Balakowicz }
413f13e7b2eSMarian Balakowicz 
4143a2003f6SWolfgang Denk static inline uint32_t image_get_image_size (const image_header_t *hdr)
415b97a2a0aSMarian Balakowicz {
416b97a2a0aSMarian Balakowicz 	return (image_get_size (hdr) + image_get_header_size ());
417b97a2a0aSMarian Balakowicz }
4183a2003f6SWolfgang Denk static inline ulong image_get_image_end (const image_header_t *hdr)
419b97a2a0aSMarian Balakowicz {
420f13e7b2eSMarian Balakowicz 	return ((ulong)hdr + image_get_image_size (hdr));
421b97a2a0aSMarian Balakowicz }
422b97a2a0aSMarian Balakowicz 
423b97a2a0aSMarian Balakowicz #define image_set_hdr_l(f) \
424b97a2a0aSMarian Balakowicz 	static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
425b97a2a0aSMarian Balakowicz 	{ \
4269a4daad0SMarian Balakowicz 		hdr->ih_##f = cpu_to_uimage (val); \
427b97a2a0aSMarian Balakowicz 	}
428178e26d7SWolfgang Denk image_set_hdr_l (magic)		/* image_set_magic */
429178e26d7SWolfgang Denk image_set_hdr_l (hcrc)		/* image_set_hcrc */
430178e26d7SWolfgang Denk image_set_hdr_l (time)		/* image_set_time */
431178e26d7SWolfgang Denk image_set_hdr_l (size)		/* image_set_size */
432178e26d7SWolfgang Denk image_set_hdr_l (load)		/* image_set_load */
433178e26d7SWolfgang Denk image_set_hdr_l (ep)		/* image_set_ep */
434178e26d7SWolfgang Denk image_set_hdr_l (dcrc)		/* image_set_dcrc */
435b97a2a0aSMarian Balakowicz 
436b97a2a0aSMarian Balakowicz #define image_set_hdr_b(f) \
437b97a2a0aSMarian Balakowicz 	static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
438b97a2a0aSMarian Balakowicz 	{ \
439b97a2a0aSMarian Balakowicz 		hdr->ih_##f = val; \
440b97a2a0aSMarian Balakowicz 	}
441178e26d7SWolfgang Denk image_set_hdr_b (os)		/* image_set_os */
442178e26d7SWolfgang Denk image_set_hdr_b (arch)		/* image_set_arch */
443178e26d7SWolfgang Denk image_set_hdr_b (type)		/* image_set_type */
444178e26d7SWolfgang Denk image_set_hdr_b (comp)		/* image_set_comp */
445b97a2a0aSMarian Balakowicz 
446b97a2a0aSMarian Balakowicz static inline void image_set_name (image_header_t *hdr, const char *name)
447b97a2a0aSMarian Balakowicz {
448b97a2a0aSMarian Balakowicz 	strncpy (image_get_name (hdr), name, IH_NMLEN);
449b97a2a0aSMarian Balakowicz }
450b97a2a0aSMarian Balakowicz 
4513a2003f6SWolfgang Denk int image_check_hcrc (const image_header_t *hdr);
4523a2003f6SWolfgang Denk int image_check_dcrc (const image_header_t *hdr);
453af13cdbcSMarian Balakowicz #ifndef USE_HOSTCC
454edbed247SBartlomiej Sieka int getenv_yesno (char *var);
455d3f2fa0dSKumar Gala ulong getenv_bootm_low(void);
456391fd93aSBecky Bruce phys_size_t getenv_bootm_size(void);
457c3624e6eSGrant Likely phys_size_t getenv_bootm_mapsize(void);
458af13cdbcSMarian Balakowicz void memmove_wd (void *to, void *from, size_t len, ulong chunksz);
459af13cdbcSMarian Balakowicz #endif
460b97a2a0aSMarian Balakowicz 
4613a2003f6SWolfgang Denk static inline int image_check_magic (const image_header_t *hdr)
462b97a2a0aSMarian Balakowicz {
463b97a2a0aSMarian Balakowicz 	return (image_get_magic (hdr) == IH_MAGIC);
464b97a2a0aSMarian Balakowicz }
4653a2003f6SWolfgang Denk static inline int image_check_type (const image_header_t *hdr, uint8_t type)
466b97a2a0aSMarian Balakowicz {
467b97a2a0aSMarian Balakowicz 	return (image_get_type (hdr) == type);
468b97a2a0aSMarian Balakowicz }
4693a2003f6SWolfgang Denk static inline int image_check_arch (const image_header_t *hdr, uint8_t arch)
470b97a2a0aSMarian Balakowicz {
471b97a2a0aSMarian Balakowicz 	return (image_get_arch (hdr) == arch);
472b97a2a0aSMarian Balakowicz }
4733a2003f6SWolfgang Denk static inline int image_check_os (const image_header_t *hdr, uint8_t os)
474b97a2a0aSMarian Balakowicz {
475b97a2a0aSMarian Balakowicz 	return (image_get_os (hdr) == os);
476b97a2a0aSMarian Balakowicz }
477b97a2a0aSMarian Balakowicz 
4783a2003f6SWolfgang Denk ulong image_multi_count (const image_header_t *hdr);
4793a2003f6SWolfgang Denk void image_multi_getimg (const image_header_t *hdr, ulong idx,
48042b73e8eSMarian Balakowicz 			ulong *data, ulong *len);
48142b73e8eSMarian Balakowicz 
4823a2003f6SWolfgang Denk void image_print_contents (const void *hdr);
483570abb0aSMarian Balakowicz 
484b97a2a0aSMarian Balakowicz #ifndef USE_HOSTCC
4853a2003f6SWolfgang Denk static inline int image_check_target_arch (const image_header_t *hdr)
486b97a2a0aSMarian Balakowicz {
487*476af299SMike Frysinger #ifndef IH_ARCH_DEFAULT
488*476af299SMike Frysinger # error "please define IH_ARCH_DEFAULT in your arch asm/u-boot.h"
489b97a2a0aSMarian Balakowicz #endif
490*476af299SMike Frysinger 	return image_check_arch(hdr, IH_ARCH_DEFAULT);
491b97a2a0aSMarian Balakowicz }
4925dfb5213SMarian Balakowicz #endif /* USE_HOSTCC */
4935b1d7137Swdenk 
494d5934ad7SMarian Balakowicz /*******************************************************************/
4959a4daad0SMarian Balakowicz /* New uImage format specific code (prefixed with fit_) */
496d5934ad7SMarian Balakowicz /*******************************************************************/
497f50433d6SMarian Balakowicz #if defined(CONFIG_FIT)
4985dfb5213SMarian Balakowicz 
4995dfb5213SMarian Balakowicz #define FIT_IMAGES_PATH		"/images"
5005dfb5213SMarian Balakowicz #define FIT_CONFS_PATH		"/configurations"
5015dfb5213SMarian Balakowicz 
5025dfb5213SMarian Balakowicz /* hash node */
5035dfb5213SMarian Balakowicz #define FIT_HASH_NODENAME	"hash"
5045dfb5213SMarian Balakowicz #define FIT_ALGO_PROP		"algo"
5055dfb5213SMarian Balakowicz #define FIT_VALUE_PROP		"value"
5065dfb5213SMarian Balakowicz 
5075dfb5213SMarian Balakowicz /* image node */
5085dfb5213SMarian Balakowicz #define FIT_DATA_PROP		"data"
5095dfb5213SMarian Balakowicz #define FIT_TIMESTAMP_PROP	"timestamp"
5105dfb5213SMarian Balakowicz #define FIT_DESC_PROP		"description"
5115dfb5213SMarian Balakowicz #define FIT_ARCH_PROP		"arch"
5125dfb5213SMarian Balakowicz #define FIT_TYPE_PROP		"type"
5135dfb5213SMarian Balakowicz #define FIT_OS_PROP		"os"
5145dfb5213SMarian Balakowicz #define FIT_COMP_PROP		"compression"
5155dfb5213SMarian Balakowicz #define FIT_ENTRY_PROP		"entry"
5165dfb5213SMarian Balakowicz #define FIT_LOAD_PROP		"load"
5175dfb5213SMarian Balakowicz 
5185dfb5213SMarian Balakowicz /* configuration node */
5195dfb5213SMarian Balakowicz #define FIT_KERNEL_PROP		"kernel"
5205dfb5213SMarian Balakowicz #define FIT_RAMDISK_PROP	"ramdisk"
5215dfb5213SMarian Balakowicz #define FIT_FDT_PROP		"fdt"
5225dfb5213SMarian Balakowicz #define FIT_DEFAULT_PROP	"default"
5235dfb5213SMarian Balakowicz 
5245dfb5213SMarian Balakowicz #define FIT_MAX_HASH_LEN	20	/* max(crc32_len(4), sha1_len(20)) */
5255dfb5213SMarian Balakowicz 
5265dfb5213SMarian Balakowicz /* cmdline argument format parsing */
527f50433d6SMarian Balakowicz inline int fit_parse_conf (const char *spec, ulong addr_curr,
528f50433d6SMarian Balakowicz 		ulong *addr, const char **conf_name);
529f50433d6SMarian Balakowicz inline int fit_parse_subimage (const char *spec, ulong addr_curr,
530f50433d6SMarian Balakowicz 		ulong *addr, const char **image_name);
531d5934ad7SMarian Balakowicz 
532edbed247SBartlomiej Sieka void fit_print_contents (const void *fit);
5335dfb5213SMarian Balakowicz void fit_image_print (const void *fit, int noffset, const char *p);
5345dfb5213SMarian Balakowicz void fit_image_print_hash (const void *fit, int noffset, const char *p);
5355dfb5213SMarian Balakowicz 
5365dfb5213SMarian Balakowicz /**
5375dfb5213SMarian Balakowicz  * fit_get_end - get FIT image size
5385dfb5213SMarian Balakowicz  * @fit: pointer to the FIT format image header
5395dfb5213SMarian Balakowicz  *
5405dfb5213SMarian Balakowicz  * returns:
5415dfb5213SMarian Balakowicz  *     size of the FIT image (blob) in memory
5425dfb5213SMarian Balakowicz  */
5435dfb5213SMarian Balakowicz static inline ulong fit_get_size (const void *fit)
5445dfb5213SMarian Balakowicz {
5455dfb5213SMarian Balakowicz 	return fdt_totalsize (fit);
5465dfb5213SMarian Balakowicz }
5475dfb5213SMarian Balakowicz 
5485dfb5213SMarian Balakowicz /**
5495dfb5213SMarian Balakowicz  * fit_get_end - get FIT image end
5505dfb5213SMarian Balakowicz  * @fit: pointer to the FIT format image header
5515dfb5213SMarian Balakowicz  *
5525dfb5213SMarian Balakowicz  * returns:
5535dfb5213SMarian Balakowicz  *     end address of the FIT image (blob) in memory
5545dfb5213SMarian Balakowicz  */
5555dfb5213SMarian Balakowicz static inline ulong fit_get_end (const void *fit)
5565dfb5213SMarian Balakowicz {
5575dfb5213SMarian Balakowicz 	return (ulong)fit + fdt_totalsize (fit);
5585dfb5213SMarian Balakowicz }
5595dfb5213SMarian Balakowicz 
5605dfb5213SMarian Balakowicz /**
5615dfb5213SMarian Balakowicz  * fit_get_name - get FIT node name
5625dfb5213SMarian Balakowicz  * @fit: pointer to the FIT format image header
5635dfb5213SMarian Balakowicz  *
5645dfb5213SMarian Balakowicz  * returns:
5655dfb5213SMarian Balakowicz  *     NULL, on error
5665dfb5213SMarian Balakowicz  *     pointer to node name, on success
5675dfb5213SMarian Balakowicz  */
5685dfb5213SMarian Balakowicz static inline const char *fit_get_name (const void *fit_hdr,
5695dfb5213SMarian Balakowicz 		int noffset, int *len)
5705dfb5213SMarian Balakowicz {
5715dfb5213SMarian Balakowicz 	return fdt_get_name (fit_hdr, noffset, len);
5725dfb5213SMarian Balakowicz }
5735dfb5213SMarian Balakowicz 
5745dfb5213SMarian Balakowicz int fit_get_desc (const void *fit, int noffset, char **desc);
5755dfb5213SMarian Balakowicz int fit_get_timestamp (const void *fit, int noffset, time_t *timestamp);
5765dfb5213SMarian Balakowicz 
5775dfb5213SMarian Balakowicz int fit_image_get_node (const void *fit, const char *image_uname);
5785dfb5213SMarian Balakowicz int fit_image_get_os (const void *fit, int noffset, uint8_t *os);
5795dfb5213SMarian Balakowicz int fit_image_get_arch (const void *fit, int noffset, uint8_t *arch);
5805dfb5213SMarian Balakowicz int fit_image_get_type (const void *fit, int noffset, uint8_t *type);
5815dfb5213SMarian Balakowicz int fit_image_get_comp (const void *fit, int noffset, uint8_t *comp);
5825dfb5213SMarian Balakowicz int fit_image_get_load (const void *fit, int noffset, ulong *load);
5835dfb5213SMarian Balakowicz int fit_image_get_entry (const void *fit, int noffset, ulong *entry);
5845dfb5213SMarian Balakowicz int fit_image_get_data (const void *fit, int noffset,
5855dfb5213SMarian Balakowicz 				const void **data, size_t *size);
5865dfb5213SMarian Balakowicz 
5875dfb5213SMarian Balakowicz int fit_image_hash_get_algo (const void *fit, int noffset, char **algo);
5885dfb5213SMarian Balakowicz int fit_image_hash_get_value (const void *fit, int noffset, uint8_t **value,
5895dfb5213SMarian Balakowicz 				int *value_len);
5905dfb5213SMarian Balakowicz 
5915dfb5213SMarian Balakowicz int fit_set_timestamp (void *fit, int noffset, time_t timestamp);
5925dfb5213SMarian Balakowicz int fit_set_hashes (void *fit);
5935dfb5213SMarian Balakowicz int fit_image_set_hashes (void *fit, int image_noffset);
5945dfb5213SMarian Balakowicz int fit_image_hash_set_value (void *fit, int noffset, uint8_t *value,
5955dfb5213SMarian Balakowicz 				int value_len);
5965dfb5213SMarian Balakowicz 
5975dfb5213SMarian Balakowicz int fit_image_check_hashes (const void *fit, int noffset);
598919f550dSBartlomiej Sieka int fit_all_image_check_hashes (const void *fit);
5995dfb5213SMarian Balakowicz int fit_image_check_os (const void *fit, int noffset, uint8_t os);
6005dfb5213SMarian Balakowicz int fit_image_check_arch (const void *fit, int noffset, uint8_t arch);
6015dfb5213SMarian Balakowicz int fit_image_check_type (const void *fit, int noffset, uint8_t type);
6025dfb5213SMarian Balakowicz int fit_image_check_comp (const void *fit, int noffset, uint8_t comp);
6035dfb5213SMarian Balakowicz int fit_check_format (const void *fit);
6045dfb5213SMarian Balakowicz 
6055dfb5213SMarian Balakowicz int fit_conf_get_node (const void *fit, const char *conf_uname);
6065dfb5213SMarian Balakowicz int fit_conf_get_kernel_node (const void *fit, int noffset);
6075dfb5213SMarian Balakowicz int fit_conf_get_ramdisk_node (const void *fit, int noffset);
6085dfb5213SMarian Balakowicz int fit_conf_get_fdt_node (const void *fit, int noffset);
6095dfb5213SMarian Balakowicz 
6105dfb5213SMarian Balakowicz void fit_conf_print (const void *fit, int noffset, const char *p);
6115dfb5213SMarian Balakowicz 
6125dfb5213SMarian Balakowicz #ifndef USE_HOSTCC
6135dfb5213SMarian Balakowicz static inline int fit_image_check_target_arch (const void *fdt, int node)
6145dfb5213SMarian Balakowicz {
615*476af299SMike Frysinger 	return !fit_image_check_arch(fdt, node, IH_ARCH_DEFAULT);
6165dfb5213SMarian Balakowicz }
6175dfb5213SMarian Balakowicz #endif /* USE_HOSTCC */
6185dfb5213SMarian Balakowicz 
619d5934ad7SMarian Balakowicz #ifdef CONFIG_FIT_VERBOSE
620d5934ad7SMarian Balakowicz #define fit_unsupported(msg)	printf ("! %s:%d " \
621d5934ad7SMarian Balakowicz 				"FIT images not supported for '%s'\n", \
622d5934ad7SMarian Balakowicz 				__FILE__, __LINE__, (msg))
623d5934ad7SMarian Balakowicz 
624d5934ad7SMarian Balakowicz #define fit_unsupported_reset(msg)	printf ("! %s:%d " \
625d5934ad7SMarian Balakowicz 				"FIT images not supported for '%s' " \
626d5934ad7SMarian Balakowicz 				"- must reset board to recover!\n", \
627d5934ad7SMarian Balakowicz 				__FILE__, __LINE__, (msg))
628d5934ad7SMarian Balakowicz #else
629d5934ad7SMarian Balakowicz #define fit_unsupported(msg)
630d5934ad7SMarian Balakowicz #define fit_unsupported_reset(msg)
631d5934ad7SMarian Balakowicz #endif /* CONFIG_FIT_VERBOSE */
632f50433d6SMarian Balakowicz #endif /* CONFIG_FIT */
6335ad03eb3SMarian Balakowicz 
6345b1d7137Swdenk #endif	/* __IMAGE_H__ */
635