xref: /rk3399_rockchip-uboot/include/image.h (revision 76e2a5a6c67043440fb0ea4942cde9b08e260a9d)
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  *
71a459660SWolfgang Denk  * SPDX-License-Identifier:	GPL-2.0+
8f08abe31SWolfgang Denk  ********************************************************************
9f08abe31SWolfgang Denk  * NOTE: This header file defines an interface to U-Boot. Including
10f08abe31SWolfgang Denk  * this (unmodified) header file in another file is considered normal
11f08abe31SWolfgang Denk  * use of U-Boot, and does *not* fall under the heading of "derived
12f08abe31SWolfgang Denk  * work".
13f08abe31SWolfgang Denk  ********************************************************************
145b1d7137Swdenk  */
155b1d7137Swdenk 
165b1d7137Swdenk #ifndef __IMAGE_H__
175b1d7137Swdenk #define __IMAGE_H__
185b1d7137Swdenk 
1937566090SMike Frysinger #include "compiler.h"
202f220500SKim Phillips #include <asm/byteorder.h>
2137566090SMike Frysinger 
2213d06981SSimon Glass /* Define this to avoid #ifdefs later on */
2313d06981SSimon Glass struct lmb;
2413d06981SSimon Glass 
2537566090SMike Frysinger #ifdef USE_HOSTCC
2626e355d1SJörg Krause #include <sys/types.h>
279d25438fSBartlomiej Sieka 
289d25438fSBartlomiej Sieka /* new uImage format support enabled on host */
2973223f0eSSimon Glass #define IMAGE_ENABLE_FIT	1
30aa34fbc0SSimon Glass #define IMAGE_ENABLE_OF_LIBFDT	1
319d25438fSBartlomiej Sieka #define CONFIG_FIT_VERBOSE	1 /* enable fit_format_{error,warning}() */
320db7f685STom Rini #define CONFIG_FIT_ENABLE_SHA256_SUPPORT
33089df18bSTom Rini #define CONFIG_SHA1
34089df18bSTom Rini #define CONFIG_SHA256
359d25438fSBartlomiej Sieka 
36ab9efc66SSimon Glass #define IMAGE_ENABLE_IGNORE	0
371fe7d938SSimon Glass #define IMAGE_INDENT_STRING	""
38ab9efc66SSimon Glass 
39def0819eSWolfgang Denk #else
40def0819eSWolfgang Denk 
41def0819eSWolfgang Denk #include <lmb.h>
42def0819eSWolfgang Denk #include <asm/u-boot.h>
435daa1c18SMike Frysinger #include <command.h>
44def0819eSWolfgang Denk 
45ab9efc66SSimon Glass /* Take notice of the 'ignore' property for hashes */
46ab9efc66SSimon Glass #define IMAGE_ENABLE_IGNORE	1
471fe7d938SSimon Glass #define IMAGE_INDENT_STRING	"   "
48ab9efc66SSimon Glass 
4973223f0eSSimon Glass #define IMAGE_ENABLE_FIT	CONFIG_IS_ENABLED(FIT)
50aa34fbc0SSimon Glass #define IMAGE_ENABLE_OF_LIBFDT	CONFIG_IS_ENABLED(OF_LIBFDT)
5173223f0eSSimon Glass 
529d25438fSBartlomiej Sieka #endif /* USE_HOSTCC */
53d5934ad7SMarian Balakowicz 
5473223f0eSSimon Glass #if IMAGE_ENABLE_FIT
551de7bb4fSMichael van der Westhuizen #include <hash.h>
565dfb5213SMarian Balakowicz #include <libfdt.h>
575dfb5213SMarian Balakowicz #include <fdt_support.h>
5887ebee39SSimon Glass # ifdef CONFIG_SPL_BUILD
596f41751fSMasahiro Yamada #  ifdef CONFIG_SPL_CRC32_SUPPORT
606f41751fSMasahiro Yamada #   define IMAGE_ENABLE_CRC32	1
616f41751fSMasahiro Yamada #  endif
626f41751fSMasahiro Yamada #  ifdef CONFIG_SPL_MD5_SUPPORT
636f41751fSMasahiro Yamada #   define IMAGE_ENABLE_MD5	1
646f41751fSMasahiro Yamada #  endif
656f41751fSMasahiro Yamada #  ifdef CONFIG_SPL_SHA1_SUPPORT
666f41751fSMasahiro Yamada #   define IMAGE_ENABLE_SHA1	1
676f41751fSMasahiro Yamada #  endif
6887ebee39SSimon Glass # else
6987ebee39SSimon Glass #  define CONFIG_CRC32		/* FIT images need CRC32 support */
7087ebee39SSimon Glass #  define IMAGE_ENABLE_CRC32	1
7187ebee39SSimon Glass #  define IMAGE_ENABLE_MD5	1
7287ebee39SSimon Glass #  define IMAGE_ENABLE_SHA1	1
736f41751fSMasahiro Yamada # endif
746f41751fSMasahiro Yamada 
756f41751fSMasahiro Yamada #ifndef IMAGE_ENABLE_CRC32
766f41751fSMasahiro Yamada #define IMAGE_ENABLE_CRC32	0
776f41751fSMasahiro Yamada #endif
786f41751fSMasahiro Yamada 
796f41751fSMasahiro Yamada #ifndef IMAGE_ENABLE_MD5
806f41751fSMasahiro Yamada #define IMAGE_ENABLE_MD5	0
816f41751fSMasahiro Yamada #endif
826f41751fSMasahiro Yamada 
836f41751fSMasahiro Yamada #ifndef IMAGE_ENABLE_SHA1
846f41751fSMasahiro Yamada #define IMAGE_ENABLE_SHA1	0
856f41751fSMasahiro Yamada #endif
866f41751fSMasahiro Yamada 
870db7f685STom Rini #if defined(CONFIG_FIT_ENABLE_SHA256_SUPPORT) || \
880db7f685STom Rini 	defined(CONFIG_SPL_SHA256_SUPPORT)
890db7f685STom Rini #define IMAGE_ENABLE_SHA256	1
900db7f685STom Rini #else
916f41751fSMasahiro Yamada #define IMAGE_ENABLE_SHA256	0
926f41751fSMasahiro Yamada #endif
936f41751fSMasahiro Yamada 
9473223f0eSSimon Glass #endif /* IMAGE_ENABLE_FIT */
9513d06981SSimon Glass 
966f41751fSMasahiro Yamada #ifdef CONFIG_SYS_BOOT_GET_CMDLINE
976f41751fSMasahiro Yamada # define IMAGE_BOOT_GET_CMDLINE		1
986f41751fSMasahiro Yamada #else
996f41751fSMasahiro Yamada # define IMAGE_BOOT_GET_CMDLINE		0
1006f41751fSMasahiro Yamada #endif
1016f41751fSMasahiro Yamada 
1026f41751fSMasahiro Yamada #ifdef CONFIG_OF_BOARD_SETUP
1036f41751fSMasahiro Yamada # define IMAGE_OF_BOARD_SETUP		1
1046f41751fSMasahiro Yamada #else
1056f41751fSMasahiro Yamada # define IMAGE_OF_BOARD_SETUP		0
1066f41751fSMasahiro Yamada #endif
1076f41751fSMasahiro Yamada 
1086f41751fSMasahiro Yamada #ifdef CONFIG_OF_SYSTEM_SETUP
1096f41751fSMasahiro Yamada # define IMAGE_OF_SYSTEM_SETUP	1
1106f41751fSMasahiro Yamada #else
1116f41751fSMasahiro Yamada # define IMAGE_OF_SYSTEM_SETUP	0
1126f41751fSMasahiro Yamada #endif
113c654b517SSimon Glass 
11456d7ab74SSimon Glass enum ih_category {
11556d7ab74SSimon Glass 	IH_ARCH,
11656d7ab74SSimon Glass 	IH_COMP,
11756d7ab74SSimon Glass 	IH_OS,
11856d7ab74SSimon Glass 	IH_TYPE,
11956d7ab74SSimon Glass 
12056d7ab74SSimon Glass 	IH_COUNT,
12156d7ab74SSimon Glass };
12256d7ab74SSimon Glass 
1235b1d7137Swdenk /*
1245b1d7137Swdenk  * Operating System Codes
125ff87b081SMasahiro Yamada  *
126ff87b081SMasahiro Yamada  * The following are exposed to uImage header.
127ff87b081SMasahiro Yamada  * Do not change values for backward compatibility.
1285b1d7137Swdenk  */
129555f45d8SSimon Glass enum {
130555f45d8SSimon Glass 	IH_OS_INVALID		= 0,	/* Invalid OS	*/
131555f45d8SSimon Glass 	IH_OS_OPENBSD,			/* OpenBSD	*/
132555f45d8SSimon Glass 	IH_OS_NETBSD,			/* NetBSD	*/
133555f45d8SSimon Glass 	IH_OS_FREEBSD,			/* FreeBSD	*/
134555f45d8SSimon Glass 	IH_OS_4_4BSD,			/* 4.4BSD	*/
135555f45d8SSimon Glass 	IH_OS_LINUX,			/* Linux	*/
136555f45d8SSimon Glass 	IH_OS_SVR4,			/* SVR4		*/
137555f45d8SSimon Glass 	IH_OS_ESIX,			/* Esix		*/
138555f45d8SSimon Glass 	IH_OS_SOLARIS,			/* Solaris	*/
139555f45d8SSimon Glass 	IH_OS_IRIX,			/* Irix		*/
140555f45d8SSimon Glass 	IH_OS_SCO,			/* SCO		*/
141555f45d8SSimon Glass 	IH_OS_DELL,			/* Dell		*/
142555f45d8SSimon Glass 	IH_OS_NCR,			/* NCR		*/
143555f45d8SSimon Glass 	IH_OS_LYNXOS,			/* LynxOS	*/
144555f45d8SSimon Glass 	IH_OS_VXWORKS,			/* VxWorks	*/
145555f45d8SSimon Glass 	IH_OS_PSOS,			/* pSOS		*/
146555f45d8SSimon Glass 	IH_OS_QNX,			/* QNX		*/
147555f45d8SSimon Glass 	IH_OS_U_BOOT,			/* Firmware	*/
148555f45d8SSimon Glass 	IH_OS_RTEMS,			/* RTEMS	*/
149555f45d8SSimon Glass 	IH_OS_ARTOS,			/* ARTOS	*/
150555f45d8SSimon Glass 	IH_OS_UNITY,			/* Unity OS	*/
151555f45d8SSimon Glass 	IH_OS_INTEGRITY,		/* INTEGRITY	*/
152555f45d8SSimon Glass 	IH_OS_OSE,			/* OSE		*/
153555f45d8SSimon Glass 	IH_OS_PLAN9,			/* Plan 9	*/
154555f45d8SSimon Glass 	IH_OS_OPENRTOS,		/* OpenRTOS	*/
155555f45d8SSimon Glass 
156555f45d8SSimon Glass 	IH_OS_COUNT,
157555f45d8SSimon Glass };
1585b1d7137Swdenk 
1595b1d7137Swdenk /*
1605b1d7137Swdenk  * CPU Architecture Codes (supported by Linux)
161ff87b081SMasahiro Yamada  *
162ff87b081SMasahiro Yamada  * The following are exposed to uImage header.
163ff87b081SMasahiro Yamada  * Do not change values for backward compatibility.
1645b1d7137Swdenk  */
165555f45d8SSimon Glass enum {
166555f45d8SSimon Glass 	IH_ARCH_INVALID		= 0,	/* Invalid CPU	*/
167555f45d8SSimon Glass 	IH_ARCH_ALPHA,			/* Alpha	*/
168555f45d8SSimon Glass 	IH_ARCH_ARM,			/* ARM		*/
169555f45d8SSimon Glass 	IH_ARCH_I386,			/* Intel x86	*/
170555f45d8SSimon Glass 	IH_ARCH_IA64,			/* IA64		*/
171555f45d8SSimon Glass 	IH_ARCH_MIPS,			/* MIPS		*/
172555f45d8SSimon Glass 	IH_ARCH_MIPS64,			/* MIPS	 64 Bit */
173555f45d8SSimon Glass 	IH_ARCH_PPC,			/* PowerPC	*/
174555f45d8SSimon Glass 	IH_ARCH_S390,			/* IBM S390	*/
175555f45d8SSimon Glass 	IH_ARCH_SH,			/* SuperH	*/
176555f45d8SSimon Glass 	IH_ARCH_SPARC,			/* Sparc	*/
177555f45d8SSimon Glass 	IH_ARCH_SPARC64,		/* Sparc 64 Bit */
178555f45d8SSimon Glass 	IH_ARCH_M68K,			/* M68K		*/
179ff87b081SMasahiro Yamada 	IH_ARCH_NIOS,			/* Nios-32	*/
180555f45d8SSimon Glass 	IH_ARCH_MICROBLAZE,		/* MicroBlaze   */
181555f45d8SSimon Glass 	IH_ARCH_NIOS2,			/* Nios-II	*/
182555f45d8SSimon Glass 	IH_ARCH_BLACKFIN,		/* Blackfin	*/
183555f45d8SSimon Glass 	IH_ARCH_AVR32,			/* AVR32	*/
184555f45d8SSimon Glass 	IH_ARCH_ST200,			/* STMicroelectronics ST200  */
185555f45d8SSimon Glass 	IH_ARCH_SANDBOX,		/* Sandbox architecture (test only) */
186555f45d8SSimon Glass 	IH_ARCH_NDS32,			/* ANDES Technology - NDS32  */
187555f45d8SSimon Glass 	IH_ARCH_OPENRISC,		/* OpenRISC 1000  */
188555f45d8SSimon Glass 	IH_ARCH_ARM64,			/* ARM64	*/
189555f45d8SSimon Glass 	IH_ARCH_ARC,			/* Synopsys DesignWare ARC */
190555f45d8SSimon Glass 	IH_ARCH_X86_64,			/* AMD x86_64, Intel and Via */
191de5e5ceaSChris Zankel 	IH_ARCH_XTENSA,			/* Xtensa	*/
192555f45d8SSimon Glass 
193555f45d8SSimon Glass 	IH_ARCH_COUNT,
194555f45d8SSimon Glass };
1955b1d7137Swdenk 
1965b1d7137Swdenk /*
1975b1d7137Swdenk  * Image Types
1985b1d7137Swdenk  *
1995b1d7137Swdenk  * "Standalone Programs" are directly runnable in the environment
2005b1d7137Swdenk  *	provided by U-Boot; it is expected that (if they behave
2015b1d7137Swdenk  *	well) you can continue to work in U-Boot after return from
2025b1d7137Swdenk  *	the Standalone Program.
2035b1d7137Swdenk  * "OS Kernel Images" are usually images of some Embedded OS which
2045b1d7137Swdenk  *	will take over control completely. Usually these programs
2055b1d7137Swdenk  *	will install their own set of exception handlers, device
2065b1d7137Swdenk  *	drivers, set up the MMU, etc. - this means, that you cannot
2075b1d7137Swdenk  *	expect to re-enter U-Boot except by resetting the CPU.
2085b1d7137Swdenk  * "RAMDisk Images" are more or less just data blocks, and their
2095b1d7137Swdenk  *	parameters (address, size) are passed to an OS kernel that is
2105b1d7137Swdenk  *	being started.
2115b1d7137Swdenk  * "Multi-File Images" contain several images, typically an OS
2125b1d7137Swdenk  *	(Linux) kernel image and one or more data images like
2135b1d7137Swdenk  *	RAMDisks. This construct is useful for instance when you want
2145b1d7137Swdenk  *	to boot over the network using BOOTP etc., where the boot
2155b1d7137Swdenk  *	server provides just a single image file, but you want to get
2165b1d7137Swdenk  *	for instance an OS kernel and a RAMDisk image.
2175b1d7137Swdenk  *
2185b1d7137Swdenk  *	"Multi-File Images" start with a list of image sizes, each
2195b1d7137Swdenk  *	image size (in bytes) specified by an "uint32_t" in network
2205b1d7137Swdenk  *	byte order. This list is terminated by an "(uint32_t)0".
2215b1d7137Swdenk  *	Immediately after the terminating 0 follow the images, one by
2225b1d7137Swdenk  *	one, all aligned on "uint32_t" boundaries (size rounded up to
223e1599e83Swdenk  *	a multiple of 4 bytes - except for the last file).
2245b1d7137Swdenk  *
2255b1d7137Swdenk  * "Firmware Images" are binary images containing firmware (like
2265b1d7137Swdenk  *	U-Boot or FPGA images) which usually will be programmed to
2275b1d7137Swdenk  *	flash memory.
2285b1d7137Swdenk  *
2295b1d7137Swdenk  * "Script files" are command sequences that will be executed by
2305b1d7137Swdenk  *	U-Boot's command interpreter; this feature is especially
2315b1d7137Swdenk  *	useful when you configure U-Boot to use a real shell (hush)
23227b207fdSwdenk  *	as command interpreter (=> Shell Scripts).
233ff87b081SMasahiro Yamada  *
234ff87b081SMasahiro Yamada  * The following are exposed to uImage header.
235ff87b081SMasahiro Yamada  * Do not change values for backward compatibility.
2365b1d7137Swdenk  */
2375b1d7137Swdenk 
238555f45d8SSimon Glass enum {
239555f45d8SSimon Glass 	IH_TYPE_INVALID		= 0,	/* Invalid Image		*/
240555f45d8SSimon Glass 	IH_TYPE_STANDALONE,		/* Standalone Program		*/
241555f45d8SSimon Glass 	IH_TYPE_KERNEL,			/* OS Kernel Image		*/
242555f45d8SSimon Glass 	IH_TYPE_RAMDISK,		/* RAMDisk Image		*/
243555f45d8SSimon Glass 	IH_TYPE_MULTI,			/* Multi-File Image		*/
244555f45d8SSimon Glass 	IH_TYPE_FIRMWARE,		/* Firmware Image		*/
245555f45d8SSimon Glass 	IH_TYPE_SCRIPT,			/* Script file			*/
246555f45d8SSimon Glass 	IH_TYPE_FILESYSTEM,		/* Filesystem Image (any type)	*/
247555f45d8SSimon Glass 	IH_TYPE_FLATDT,			/* Binary Flat Device Tree Blob	*/
248555f45d8SSimon Glass 	IH_TYPE_KWBIMAGE,		/* Kirkwood Boot Image		*/
249555f45d8SSimon Glass 	IH_TYPE_IMXIMAGE,		/* Freescale IMXBoot Image	*/
250555f45d8SSimon Glass 	IH_TYPE_UBLIMAGE,		/* Davinci UBL Image		*/
251555f45d8SSimon Glass 	IH_TYPE_OMAPIMAGE,		/* TI OMAP Config Header Image	*/
252555f45d8SSimon Glass 	IH_TYPE_AISIMAGE,		/* TI Davinci AIS Image		*/
253555f45d8SSimon Glass 	/* OS Kernel Image, can run from any load address */
254555f45d8SSimon Glass 	IH_TYPE_KERNEL_NOLOAD,
255555f45d8SSimon Glass 	IH_TYPE_PBLIMAGE,		/* Freescale PBL Boot Image	*/
256555f45d8SSimon Glass 	IH_TYPE_MXSIMAGE,		/* Freescale MXSBoot Image	*/
257555f45d8SSimon Glass 	IH_TYPE_GPIMAGE,		/* TI Keystone GPHeader Image	*/
258555f45d8SSimon Glass 	IH_TYPE_ATMELIMAGE,		/* ATMEL ROM bootable Image	*/
259555f45d8SSimon Glass 	IH_TYPE_SOCFPGAIMAGE,		/* Altera SOCFPGA Preloader	*/
260555f45d8SSimon Glass 	IH_TYPE_X86_SETUP,		/* x86 setup.bin Image		*/
261555f45d8SSimon Glass 	IH_TYPE_LPC32XXIMAGE,		/* x86 setup.bin Image		*/
262555f45d8SSimon Glass 	IH_TYPE_LOADABLE,		/* A list of typeless images	*/
263555f45d8SSimon Glass 	IH_TYPE_RKIMAGE,		/* Rockchip Boot Image		*/
264555f45d8SSimon Glass 	IH_TYPE_RKSD,			/* Rockchip SD card		*/
265555f45d8SSimon Glass 	IH_TYPE_RKSPI,			/* Rockchip SPI image		*/
266555f45d8SSimon Glass 	IH_TYPE_ZYNQIMAGE,		/* Xilinx Zynq Boot Image */
267555f45d8SSimon Glass 	IH_TYPE_ZYNQMPIMAGE,		/* Xilinx ZynqMP Boot Image */
268555f45d8SSimon Glass 	IH_TYPE_FPGA,			/* FPGA Image */
269ed0c2c0aSAlbert ARIBAUD \(3ADEV\) 	IH_TYPE_VYBRIDIMAGE,	/* VYBRID .vyb Image */
2707e719ee7SAndrew F. Davis 	IH_TYPE_TEE,            /* Trusted Execution Environment OS Image */
271d21bd69bSSven Ebenfeld 	IH_TYPE_FIRMWARE_IVT,		/* Firmware Image with HABv4 IVT */
2726f14746bSPaweł Jarosz 	IH_TYPE_RKNAND,			/* Rockchip NAND Boot Image	*/
2735b1d7137Swdenk 
274555f45d8SSimon Glass 	IH_TYPE_COUNT,			/* Number of image types */
275555f45d8SSimon Glass };
2765b9d44dfSSimon Glass 
2775b1d7137Swdenk /*
2785b1d7137Swdenk  * Compression Types
279ff87b081SMasahiro Yamada  *
280ff87b081SMasahiro Yamada  * The following are exposed to uImage header.
281ff87b081SMasahiro Yamada  * Do not change values for backward compatibility.
2825b1d7137Swdenk  */
283555f45d8SSimon Glass enum {
284555f45d8SSimon Glass 	IH_COMP_NONE		= 0,	/*  No	 Compression Used	*/
285555f45d8SSimon Glass 	IH_COMP_GZIP,			/* gzip	 Compression Used	*/
286555f45d8SSimon Glass 	IH_COMP_BZIP2,			/* bzip2 Compression Used	*/
287555f45d8SSimon Glass 	IH_COMP_LZMA,			/* lzma  Compression Used	*/
288555f45d8SSimon Glass 	IH_COMP_LZO,			/* lzo   Compression Used	*/
289555f45d8SSimon Glass 	IH_COMP_LZ4,			/* lz4   Compression Used	*/
290555f45d8SSimon Glass 
291555f45d8SSimon Glass 	IH_COMP_COUNT,
292555f45d8SSimon Glass };
2935b1d7137Swdenk 
2945b1d7137Swdenk #define IH_MAGIC	0x27051956	/* Image Magic Number		*/
2955b1d7137Swdenk #define IH_NMLEN		32	/* Image Name Length		*/
2965b1d7137Swdenk 
2971411fb37SFabio Estevam /* Reused from common.h */
2981411fb37SFabio Estevam #define ROUND(a, b)		(((a) + (b) - 1) & ~((b) - 1))
2991411fb37SFabio Estevam 
3005b1d7137Swdenk /*
3019a4daad0SMarian Balakowicz  * Legacy format image header,
3029a4daad0SMarian Balakowicz  * all data in network byte order (aka natural aka bigendian).
3035b1d7137Swdenk  */
3045b1d7137Swdenk typedef struct image_header {
3052f220500SKim Phillips 	__be32		ih_magic;	/* Image Header Magic Number	*/
3062f220500SKim Phillips 	__be32		ih_hcrc;	/* Image Header CRC Checksum	*/
3072f220500SKim Phillips 	__be32		ih_time;	/* Image Creation Timestamp	*/
3082f220500SKim Phillips 	__be32		ih_size;	/* Image Data Size		*/
3092f220500SKim Phillips 	__be32		ih_load;	/* Data	 Load  Address		*/
3102f220500SKim Phillips 	__be32		ih_ep;		/* Entry Point Address		*/
3112f220500SKim Phillips 	__be32		ih_dcrc;	/* Image Data CRC Checksum	*/
3125b1d7137Swdenk 	uint8_t		ih_os;		/* Operating System		*/
3135b1d7137Swdenk 	uint8_t		ih_arch;	/* CPU architecture		*/
3145b1d7137Swdenk 	uint8_t		ih_type;	/* Image Type			*/
3155b1d7137Swdenk 	uint8_t		ih_comp;	/* Compression Type		*/
3165b1d7137Swdenk 	uint8_t		ih_name[IH_NMLEN];	/* Image Name		*/
3175b1d7137Swdenk } image_header_t;
3185b1d7137Swdenk 
319396f635bSKumar Gala typedef struct image_info {
320396f635bSKumar Gala 	ulong		start, end;		/* start/end of blob */
321396f635bSKumar Gala 	ulong		image_start, image_len; /* start of image within blob, len of image */
322396f635bSKumar Gala 	ulong		load;			/* load addr for the image */
323396f635bSKumar Gala 	uint8_t		comp, type, os;		/* compression, type of image, os type */
32490268b87SSimon Glass 	uint8_t		arch;			/* CPU architecture */
325396f635bSKumar Gala } image_info_t;
326396f635bSKumar Gala 
327559316faSMarian Balakowicz /*
328d5934ad7SMarian Balakowicz  * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
329d5934ad7SMarian Balakowicz  * routines.
330d5934ad7SMarian Balakowicz  */
331d5934ad7SMarian Balakowicz typedef struct bootm_headers {
332d5934ad7SMarian Balakowicz 	/*
333d5934ad7SMarian Balakowicz 	 * Legacy os image header, if it is a multi component image
3349a4daad0SMarian Balakowicz 	 * then boot_get_ramdisk() and get_fdt() will attempt to get
335d5934ad7SMarian Balakowicz 	 * data from second and third component accordingly.
336d5934ad7SMarian Balakowicz 	 */
337cb1c4896SMarian Balakowicz 	image_header_t	*legacy_hdr_os;		/* image header pointer */
338cb1c4896SMarian Balakowicz 	image_header_t	legacy_hdr_os_copy;	/* header copy */
339d5934ad7SMarian Balakowicz 	ulong		legacy_hdr_valid;
340d5934ad7SMarian Balakowicz 
34173223f0eSSimon Glass #if IMAGE_ENABLE_FIT
342f773bea8SMarian Balakowicz 	const char	*fit_uname_cfg;	/* configuration node unit name */
343f773bea8SMarian Balakowicz 
344d5934ad7SMarian Balakowicz 	void		*fit_hdr_os;	/* os FIT image header */
345eb6175edSMarian Balakowicz 	const char	*fit_uname_os;	/* os subimage node unit name */
3463dfe1101SMarian Balakowicz 	int		fit_noffset_os;	/* os subimage node offset */
347d5934ad7SMarian Balakowicz 
348d5934ad7SMarian Balakowicz 	void		*fit_hdr_rd;	/* init ramdisk FIT image header */
3493dfe1101SMarian Balakowicz 	const char	*fit_uname_rd;	/* init ramdisk subimage node unit name */
3503dfe1101SMarian Balakowicz 	int		fit_noffset_rd;	/* init ramdisk subimage node offset */
351d5934ad7SMarian Balakowicz 
352d5934ad7SMarian Balakowicz 	void		*fit_hdr_fdt;	/* FDT blob FIT image header */
3533dfe1101SMarian Balakowicz 	const char	*fit_uname_fdt;	/* FDT blob subimage node unit name */
3543dfe1101SMarian Balakowicz 	int		fit_noffset_fdt;/* FDT blob subimage node offset */
35590268b87SSimon Glass 
35690268b87SSimon Glass 	void		*fit_hdr_setup;	/* x86 setup FIT image header */
35790268b87SSimon Glass 	const char	*fit_uname_setup; /* x86 setup subimage node name */
35890268b87SSimon Glass 	int		fit_noffset_setup;/* x86 setup subimage node offset */
359d5934ad7SMarian Balakowicz #endif
3601ec73761SMarian Balakowicz 
36149c3a861SKumar Gala #ifndef USE_HOSTCC
362396f635bSKumar Gala 	image_info_t	os;		/* os image info */
363c160a954SKumar Gala 	ulong		ep;		/* entry point of OS */
364c160a954SKumar Gala 
365c4f9419cSKumar Gala 	ulong		rd_start, rd_end;/* ramdisk start/end */
366c4f9419cSKumar Gala 
36706a09918SKumar Gala 	char		*ft_addr;	/* flat dev tree address */
36806a09918SKumar Gala 	ulong		ft_len;		/* length of flat device tree */
36906a09918SKumar Gala 
37049c3a861SKumar Gala 	ulong		initrd_start;
37149c3a861SKumar Gala 	ulong		initrd_end;
37249c3a861SKumar Gala 	ulong		cmdline_start;
37349c3a861SKumar Gala 	ulong		cmdline_end;
37449c3a861SKumar Gala 	bd_t		*kbd;
37549c3a861SKumar Gala #endif
37649c3a861SKumar Gala 
37700caae6dSSimon Glass 	int		verify;		/* env_get("verify")[0] != 'n' */
37849c3a861SKumar Gala 
37949c3a861SKumar Gala #define	BOOTM_STATE_START	(0x00000001)
38035fc84faSSimon Glass #define	BOOTM_STATE_FINDOS	(0x00000002)
38135fc84faSSimon Glass #define	BOOTM_STATE_FINDOTHER	(0x00000004)
38235fc84faSSimon Glass #define	BOOTM_STATE_LOADOS	(0x00000008)
38335fc84faSSimon Glass #define	BOOTM_STATE_RAMDISK	(0x00000010)
38435fc84faSSimon Glass #define	BOOTM_STATE_FDT		(0x00000020)
38535fc84faSSimon Glass #define	BOOTM_STATE_OS_CMDLINE	(0x00000040)
38635fc84faSSimon Glass #define	BOOTM_STATE_OS_BD_T	(0x00000080)
38735fc84faSSimon Glass #define	BOOTM_STATE_OS_PREP	(0x00000100)
388d0ae31ebSSimon Glass #define	BOOTM_STATE_OS_FAKE_GO	(0x00000200)	/* 'Almost' run the OS */
389d0ae31ebSSimon Glass #define	BOOTM_STATE_OS_GO	(0x00000400)
39049c3a861SKumar Gala 	int		state;
39149c3a861SKumar Gala 
392a16028daSMike Frysinger #ifdef CONFIG_LMB
393e906cfaeSKumar Gala 	struct lmb	lmb;		/* for memory mgmt */
394e906cfaeSKumar Gala #endif
395d5934ad7SMarian Balakowicz } bootm_headers_t;
396d5934ad7SMarian Balakowicz 
3971648a375SSimon Schwarz extern bootm_headers_t images;
3981648a375SSimon Schwarz 
399d5934ad7SMarian Balakowicz /*
400559316faSMarian Balakowicz  * Some systems (for example LWMON) have very short watchdog periods;
401559316faSMarian Balakowicz  * we must make sure to split long operations like memmove() or
4027590378fSBartlomiej Sieka  * checksum calculations into reasonable chunks.
403559316faSMarian Balakowicz  */
4047590378fSBartlomiej Sieka #ifndef CHUNKSZ
405559316faSMarian Balakowicz #define CHUNKSZ (64 * 1024)
4067590378fSBartlomiej Sieka #endif
4077590378fSBartlomiej Sieka 
4087590378fSBartlomiej Sieka #ifndef CHUNKSZ_CRC32
4097590378fSBartlomiej Sieka #define CHUNKSZ_CRC32 (64 * 1024)
4107590378fSBartlomiej Sieka #endif
4117590378fSBartlomiej Sieka 
4127590378fSBartlomiej Sieka #ifndef CHUNKSZ_MD5
4137590378fSBartlomiej Sieka #define CHUNKSZ_MD5 (64 * 1024)
4147590378fSBartlomiej Sieka #endif
4157590378fSBartlomiej Sieka 
4167590378fSBartlomiej Sieka #ifndef CHUNKSZ_SHA1
4177590378fSBartlomiej Sieka #define CHUNKSZ_SHA1 (64 * 1024)
4187590378fSBartlomiej Sieka #endif
419559316faSMarian Balakowicz 
42037566090SMike Frysinger #define uimage_to_cpu(x)		be32_to_cpu(x)
42137566090SMike Frysinger #define cpu_to_uimage(x)		cpu_to_be32(x)
422b97a2a0aSMarian Balakowicz 
423b029dddcSPrafulla Wadaskar /*
424b029dddcSPrafulla Wadaskar  * Translation table for entries of a specific type; used by
425b029dddcSPrafulla Wadaskar  * get_table_entry_id() and get_table_entry_name().
426b029dddcSPrafulla Wadaskar  */
427b029dddcSPrafulla Wadaskar typedef struct table_entry {
428b029dddcSPrafulla Wadaskar 	int	id;
429b029dddcSPrafulla Wadaskar 	char	*sname;		/* short (input) name to find table entry */
430b029dddcSPrafulla Wadaskar 	char	*lname;		/* long (output) name to print for messages */
431b029dddcSPrafulla Wadaskar } table_entry_t;
432b029dddcSPrafulla Wadaskar 
433b029dddcSPrafulla Wadaskar /*
434b029dddcSPrafulla Wadaskar  * get_table_entry_id() scans the translation table trying to find an
435b029dddcSPrafulla Wadaskar  * entry that matches the given short name. If a matching entry is
436b029dddcSPrafulla Wadaskar  * found, it's id is returned to the caller.
437b029dddcSPrafulla Wadaskar  */
4387edb186fSMike Frysinger int get_table_entry_id(const table_entry_t *table,
439b029dddcSPrafulla Wadaskar 		const char *table_name, const char *name);
440b029dddcSPrafulla Wadaskar /*
441b029dddcSPrafulla Wadaskar  * get_table_entry_name() scans the translation table trying to find
442b029dddcSPrafulla Wadaskar  * an entry that matches the given id. If a matching entry is found,
443b029dddcSPrafulla Wadaskar  * its long name is returned to the caller.
444b029dddcSPrafulla Wadaskar  */
4457edb186fSMike Frysinger char *get_table_entry_name(const table_entry_t *table, char *msg, int id);
446b029dddcSPrafulla Wadaskar 
447570abb0aSMarian Balakowicz const char *genimg_get_os_name(uint8_t os);
448cef2e514SSimon Glass 
449cef2e514SSimon Glass /**
450cef2e514SSimon Glass  * genimg_get_os_short_name() - get the short name for an OS
451cef2e514SSimon Glass  *
452cef2e514SSimon Glass  * @param os	OS (IH_OS_...)
453cef2e514SSimon Glass  * @return OS short name, or "unknown" if unknown
454cef2e514SSimon Glass  */
455cef2e514SSimon Glass const char *genimg_get_os_short_name(uint8_t comp);
456cef2e514SSimon Glass 
457570abb0aSMarian Balakowicz const char *genimg_get_arch_name(uint8_t arch);
458cef2e514SSimon Glass 
459cef2e514SSimon Glass /**
460cef2e514SSimon Glass  * genimg_get_arch_short_name() - get the short name for an architecture
461cef2e514SSimon Glass  *
462cef2e514SSimon Glass  * @param arch	Architecture type (IH_ARCH_...)
463cef2e514SSimon Glass  * @return architecture short name, or "unknown" if unknown
464cef2e514SSimon Glass  */
465cef2e514SSimon Glass const char *genimg_get_arch_short_name(uint8_t arch);
466cef2e514SSimon Glass 
467570abb0aSMarian Balakowicz const char *genimg_get_type_name(uint8_t type);
4685b9d44dfSSimon Glass 
4695b9d44dfSSimon Glass /**
4705b9d44dfSSimon Glass  * genimg_get_type_short_name() - get the short name for an image type
4715b9d44dfSSimon Glass  *
4725b9d44dfSSimon Glass  * @param type	Image type (IH_TYPE_...)
4735b9d44dfSSimon Glass  * @return image short name, or "unknown" if unknown
4745b9d44dfSSimon Glass  */
4755b9d44dfSSimon Glass const char *genimg_get_type_short_name(uint8_t type);
4765b9d44dfSSimon Glass 
477570abb0aSMarian Balakowicz const char *genimg_get_comp_name(uint8_t comp);
478cef2e514SSimon Glass 
479cef2e514SSimon Glass /**
480cef2e514SSimon Glass  * genimg_get_comp_short_name() - get the short name for a compression method
481cef2e514SSimon Glass  *
482cef2e514SSimon Glass  * @param comp	compression method (IH_COMP_...)
483cef2e514SSimon Glass  * @return compression method short name, or "unknown" if unknown
484cef2e514SSimon Glass  */
485cef2e514SSimon Glass const char *genimg_get_comp_short_name(uint8_t comp);
486cef2e514SSimon Glass 
4871426220bSSimon Glass /**
4881426220bSSimon Glass  * genimg_get_cat_name() - Get the name of an item in a category
4891426220bSSimon Glass  *
4901426220bSSimon Glass  * @category:	Category of item
4911426220bSSimon Glass  * @id:		Item ID
4921426220bSSimon Glass  * @return name of item, or "Unknown ..." if unknown
4931426220bSSimon Glass  */
4941426220bSSimon Glass const char *genimg_get_cat_name(enum ih_category category, uint id);
4951426220bSSimon Glass 
4961426220bSSimon Glass /**
4971426220bSSimon Glass  * genimg_get_cat_short_name() - Get the short name of an item in a category
4981426220bSSimon Glass  *
4991426220bSSimon Glass  * @category:	Category of item
5001426220bSSimon Glass  * @id:		Item ID
5011426220bSSimon Glass  * @return short name of item, or "Unknown ..." if unknown
5021426220bSSimon Glass  */
5031426220bSSimon Glass const char *genimg_get_cat_short_name(enum ih_category category, uint id);
5041426220bSSimon Glass 
5051426220bSSimon Glass /**
5061426220bSSimon Glass  * genimg_get_cat_count() - Get the number of items in a category
5071426220bSSimon Glass  *
5081426220bSSimon Glass  * @category:	Category to check
5091426220bSSimon Glass  * @return the number of items in the category (IH_xxx_COUNT)
5101426220bSSimon Glass  */
5111426220bSSimon Glass int genimg_get_cat_count(enum ih_category category);
5121426220bSSimon Glass 
5131426220bSSimon Glass /**
5141426220bSSimon Glass  * genimg_get_cat_desc() - Get the description of a category
5151426220bSSimon Glass  *
5161426220bSSimon Glass  * @return the description of a category, e.g. "architecture". This
5171426220bSSimon Glass  * effectively converts the enum to a string.
5181426220bSSimon Glass  */
5191426220bSSimon Glass const char *genimg_get_cat_desc(enum ih_category category);
5201426220bSSimon Glass 
521570abb0aSMarian Balakowicz int genimg_get_os_id(const char *name);
522570abb0aSMarian Balakowicz int genimg_get_arch_id(const char *name);
523570abb0aSMarian Balakowicz int genimg_get_type_id(const char *name);
524570abb0aSMarian Balakowicz int genimg_get_comp_id(const char *name);
525f666dea8SPrafulla Wadaskar void genimg_print_size(uint32_t size);
526570abb0aSMarian Balakowicz 
527859e92b7SSimon Glass #if defined(CONFIG_TIMESTAMP) || defined(CONFIG_CMD_DATE) || \
528859e92b7SSimon Glass 	defined(USE_HOSTCC)
529859e92b7SSimon Glass #define IMAGE_ENABLE_TIMESTAMP 1
530859e92b7SSimon Glass #else
531859e92b7SSimon Glass #define IMAGE_ENABLE_TIMESTAMP 0
532859e92b7SSimon Glass #endif
533859e92b7SSimon Glass void genimg_print_time(time_t timestamp);
534859e92b7SSimon Glass 
535782cfbb2SSimon Glass /* What to do with a image load address ('load = <> 'in the FIT) */
536782cfbb2SSimon Glass enum fit_load_op {
537782cfbb2SSimon Glass 	FIT_LOAD_IGNORED,	/* Ignore load address */
538782cfbb2SSimon Glass 	FIT_LOAD_OPTIONAL,	/* Can be provided, but optional */
539fe20a81aSSimon Glass 	FIT_LOAD_OPTIONAL_NON_ZERO,	/* Optional, a value of 0 is ignored */
540782cfbb2SSimon Glass 	FIT_LOAD_REQUIRED,	/* Must be provided */
541782cfbb2SSimon Glass };
542782cfbb2SSimon Glass 
54390268b87SSimon Glass int boot_get_setup(bootm_headers_t *images, uint8_t arch, ulong *setup_start,
54490268b87SSimon Glass 		   ulong *setup_len);
54590268b87SSimon Glass 
5469a4daad0SMarian Balakowicz #ifndef USE_HOSTCC
5479a4daad0SMarian Balakowicz /* Image format types, returned by _get_format() routine */
5489a4daad0SMarian Balakowicz #define IMAGE_FORMAT_INVALID	0x00
54921d29f7fSHeiko Schocher #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
5509a4daad0SMarian Balakowicz #define IMAGE_FORMAT_LEGACY	0x01	/* legacy image_header based format */
55121d29f7fSHeiko Schocher #endif
5529a4daad0SMarian Balakowicz #define IMAGE_FORMAT_FIT	0x02	/* new, libfdt based format */
5539ace3fc8SSebastian Siewior #define IMAGE_FORMAT_ANDROID	0x03	/* Android boot image */
5549a4daad0SMarian Balakowicz 
5556c454fedSBryan Wu ulong genimg_get_kernel_addr_fit(char * const img_addr,
5566c454fedSBryan Wu 			         const char **fit_uname_config,
5576c454fedSBryan Wu 			         const char **fit_uname_kernel);
5580f64140bSBryan Wu ulong genimg_get_kernel_addr(char * const img_addr);
55935e7b0f1SSimon Glass int genimg_get_format(const void *img_addr);
560f773bea8SMarian Balakowicz int genimg_has_config(bootm_headers_t *images);
5619a4daad0SMarian Balakowicz ulong genimg_get_image(ulong img_addr);
5629a4daad0SMarian Balakowicz 
56362afc601SMichal Simek int boot_get_fpga(int argc, char * const argv[], bootm_headers_t *images,
56462afc601SMichal Simek 		uint8_t arch, const ulong *ld_start, ulong * const ld_len);
56554841ab5SWolfgang Denk int boot_get_ramdisk(int argc, char * const argv[], bootm_headers_t *images,
566d985c849SMarian Balakowicz 		uint8_t arch, ulong *rd_start, ulong *rd_end);
56784a07dbfSKarl Apsite 
56884a07dbfSKarl Apsite /**
56984a07dbfSKarl Apsite  * boot_get_loadable - routine to load a list of binaries to memory
57084a07dbfSKarl Apsite  * @argc: Ignored Argument
57184a07dbfSKarl Apsite  * @argv: Ignored Argument
57284a07dbfSKarl Apsite  * @images: pointer to the bootm images structure
57384a07dbfSKarl Apsite  * @arch: expected architecture for the image
57484a07dbfSKarl Apsite  * @ld_start: Ignored Argument
57584a07dbfSKarl Apsite  * @ld_len: Ignored Argument
57684a07dbfSKarl Apsite  *
57784a07dbfSKarl Apsite  * boot_get_loadable() will take the given FIT configuration, and look
57884a07dbfSKarl Apsite  * for a field named "loadables".  Loadables, is a list of elements in
57984a07dbfSKarl Apsite  * the FIT given as strings.  exe:
58084a07dbfSKarl Apsite  *   loadables = "linux_kernel@1", "fdt@2";
58184a07dbfSKarl Apsite  * this function will attempt to parse each string, and load the
58284a07dbfSKarl Apsite  * corresponding element from the FIT into memory.  Once placed,
58384a07dbfSKarl Apsite  * no aditional actions are taken.
58484a07dbfSKarl Apsite  *
58584a07dbfSKarl Apsite  * @return:
58684a07dbfSKarl Apsite  *     0, if only valid images or no images are found
58784a07dbfSKarl Apsite  *     error code, if an error occurs during fit_image_load
58884a07dbfSKarl Apsite  */
58984a07dbfSKarl Apsite int boot_get_loadable(int argc, char * const argv[], bootm_headers_t *images,
59084a07dbfSKarl Apsite 		uint8_t arch, const ulong *ld_start, ulong * const ld_len);
59184a07dbfSKarl Apsite #endif /* !USE_HOSTCC */
5929a4daad0SMarian Balakowicz 
59390268b87SSimon Glass int boot_get_setup_fit(bootm_headers_t *images, uint8_t arch,
59490268b87SSimon Glass 		       ulong *setup_start, ulong *setup_len);
59590268b87SSimon Glass 
596782cfbb2SSimon Glass /**
597782cfbb2SSimon Glass  * fit_image_load() - load an image from a FIT
598782cfbb2SSimon Glass  *
599782cfbb2SSimon Glass  * This deals with all aspects of loading an image from a FIT, including
600782cfbb2SSimon Glass  * selecting the right image based on configuration, verifying it, printing
601782cfbb2SSimon Glass  * out progress messages, checking the type/arch/os and optionally copying it
602782cfbb2SSimon Glass  * to the right load address.
603782cfbb2SSimon Glass  *
604126cc864SSimon Glass  * The property to look up is defined by image_type.
605126cc864SSimon Glass  *
606782cfbb2SSimon Glass  * @param images	Boot images structure
607782cfbb2SSimon Glass  * @param addr		Address of FIT in memory
608782cfbb2SSimon Glass  * @param fit_unamep	On entry this is the requested image name
609782cfbb2SSimon Glass  *			(e.g. "kernel@1") or NULL to use the default. On exit
610782cfbb2SSimon Glass  *			points to the selected image name
611f320a4d8SSimon Glass  * @param fit_uname_configp	On entry this is the requested configuration
612f320a4d8SSimon Glass  *			name (e.g. "conf@1") or NULL to use the default. On
613f320a4d8SSimon Glass  *			exit points to the selected configuration name.
614782cfbb2SSimon Glass  * @param arch		Expected architecture (IH_ARCH_...)
615782cfbb2SSimon Glass  * @param image_type	Required image type (IH_TYPE_...). If this is
616782cfbb2SSimon Glass  *			IH_TYPE_KERNEL then we allow IH_TYPE_KERNEL_NOLOAD
617782cfbb2SSimon Glass  *			also.
618782cfbb2SSimon Glass  * @param bootstage_id	ID of starting bootstage to use for progress updates.
619782cfbb2SSimon Glass  *			This will be added to the BOOTSTAGE_SUB values when
620782cfbb2SSimon Glass  *			calling bootstage_mark()
621782cfbb2SSimon Glass  * @param load_op	Decribes what to do with the load address
622782cfbb2SSimon Glass  * @param datap		Returns address of loaded image
623782cfbb2SSimon Glass  * @param lenp		Returns length of loaded image
624ce1400f6SSimon Glass  * @return node offset of image, or -ve error code on error
625782cfbb2SSimon Glass  */
626126cc864SSimon Glass int fit_image_load(bootm_headers_t *images, ulong addr,
627f320a4d8SSimon Glass 		   const char **fit_unamep, const char **fit_uname_configp,
628782cfbb2SSimon Glass 		   int arch, int image_type, int bootstage_id,
629782cfbb2SSimon Glass 		   enum fit_load_op load_op, ulong *datap, ulong *lenp);
630782cfbb2SSimon Glass 
631ce1400f6SSimon Glass #ifndef USE_HOSTCC
632782cfbb2SSimon Glass /**
633782cfbb2SSimon Glass  * fit_get_node_from_config() - Look up an image a FIT by type
634782cfbb2SSimon Glass  *
635782cfbb2SSimon Glass  * This looks in the selected conf@ node (images->fit_uname_cfg) for a
636782cfbb2SSimon Glass  * particular image type (e.g. "kernel") and then finds the image that is
637782cfbb2SSimon Glass  * referred to.
638782cfbb2SSimon Glass  *
639782cfbb2SSimon Glass  * For example, for something like:
640782cfbb2SSimon Glass  *
641782cfbb2SSimon Glass  * images {
642782cfbb2SSimon Glass  *	kernel@1 {
643782cfbb2SSimon Glass  *		...
644782cfbb2SSimon Glass  *	};
645782cfbb2SSimon Glass  * };
646782cfbb2SSimon Glass  * configurations {
647782cfbb2SSimon Glass  *	conf@1 {
648782cfbb2SSimon Glass  *		kernel = "kernel@1";
649782cfbb2SSimon Glass  *	};
650782cfbb2SSimon Glass  * };
651782cfbb2SSimon Glass  *
652782cfbb2SSimon Glass  * the function will return the node offset of the kernel@1 node, assuming
653782cfbb2SSimon Glass  * that conf@1 is the chosen configuration.
654782cfbb2SSimon Glass  *
655782cfbb2SSimon Glass  * @param images	Boot images structure
656782cfbb2SSimon Glass  * @param prop_name	Property name to look up (FIT_..._PROP)
657782cfbb2SSimon Glass  * @param addr		Address of FIT in memory
658782cfbb2SSimon Glass  */
659782cfbb2SSimon Glass int fit_get_node_from_config(bootm_headers_t *images, const char *prop_name,
660782cfbb2SSimon Glass 			ulong addr);
661782cfbb2SSimon Glass 
66253f375faSSimon Glass int boot_get_fdt(int flag, int argc, char * const argv[], uint8_t arch,
66353f375faSSimon Glass 		 bootm_headers_t *images,
66453f375faSSimon Glass 		 char **of_flat_tree, ulong *of_size);
66555b0a393SGrant Likely void boot_fdt_add_mem_rsv_regions(struct lmb *lmb, void *fdt_blob);
666590d3cacSGrant Likely int boot_relocate_fdt(struct lmb *lmb, char **of_flat_tree, ulong *of_size);
66706a09918SKumar Gala 
6689a4daad0SMarian Balakowicz int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len,
6699a4daad0SMarian Balakowicz 		  ulong *initrd_start, ulong *initrd_end);
670590d3cacSGrant Likely int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end);
671fca43cc8SJohn Rigby #ifdef CONFIG_SYS_BOOT_GET_KBD
672590d3cacSGrant Likely int boot_get_kbd(struct lmb *lmb, bd_t **kbd);
673fca43cc8SJohn Rigby #endif /* CONFIG_SYS_BOOT_GET_KBD */
674570abb0aSMarian Balakowicz #endif /* !USE_HOSTCC */
6759a4daad0SMarian Balakowicz 
6769a4daad0SMarian Balakowicz /*******************************************************************/
6779a4daad0SMarian Balakowicz /* Legacy format specific code (prefixed with image_) */
6789a4daad0SMarian Balakowicz /*******************************************************************/
679b97a2a0aSMarian Balakowicz static inline uint32_t image_get_header_size(void)
680b97a2a0aSMarian Balakowicz {
681b97a2a0aSMarian Balakowicz 	return (sizeof(image_header_t));
682b97a2a0aSMarian Balakowicz }
683b97a2a0aSMarian Balakowicz 
684b97a2a0aSMarian Balakowicz #define image_get_hdr_l(f) \
6853a2003f6SWolfgang Denk 	static inline uint32_t image_get_##f(const image_header_t *hdr) \
686b97a2a0aSMarian Balakowicz 	{ \
6879a4daad0SMarian Balakowicz 		return uimage_to_cpu(hdr->ih_##f); \
688b97a2a0aSMarian Balakowicz 	}
689178e26d7SWolfgang Denk image_get_hdr_l(magic)		/* image_get_magic */
690178e26d7SWolfgang Denk image_get_hdr_l(hcrc)		/* image_get_hcrc */
691178e26d7SWolfgang Denk image_get_hdr_l(time)		/* image_get_time */
692178e26d7SWolfgang Denk image_get_hdr_l(size)		/* image_get_size */
693178e26d7SWolfgang Denk image_get_hdr_l(load)		/* image_get_load */
694178e26d7SWolfgang Denk image_get_hdr_l(ep)		/* image_get_ep */
695178e26d7SWolfgang Denk image_get_hdr_l(dcrc)		/* image_get_dcrc */
696b97a2a0aSMarian Balakowicz 
697b97a2a0aSMarian Balakowicz #define image_get_hdr_b(f) \
6983a2003f6SWolfgang Denk 	static inline uint8_t image_get_##f(const image_header_t *hdr) \
699b97a2a0aSMarian Balakowicz 	{ \
700b97a2a0aSMarian Balakowicz 		return hdr->ih_##f; \
701b97a2a0aSMarian Balakowicz 	}
702178e26d7SWolfgang Denk image_get_hdr_b(os)		/* image_get_os */
703178e26d7SWolfgang Denk image_get_hdr_b(arch)		/* image_get_arch */
704178e26d7SWolfgang Denk image_get_hdr_b(type)		/* image_get_type */
705178e26d7SWolfgang Denk image_get_hdr_b(comp)		/* image_get_comp */
706b97a2a0aSMarian Balakowicz 
7073a2003f6SWolfgang Denk static inline char *image_get_name(const image_header_t *hdr)
708b97a2a0aSMarian Balakowicz {
709b97a2a0aSMarian Balakowicz 	return (char *)hdr->ih_name;
710b97a2a0aSMarian Balakowicz }
711b97a2a0aSMarian Balakowicz 
7123a2003f6SWolfgang Denk static inline uint32_t image_get_data_size(const image_header_t *hdr)
713b97a2a0aSMarian Balakowicz {
714b97a2a0aSMarian Balakowicz 	return image_get_size(hdr);
715b97a2a0aSMarian Balakowicz }
716f13e7b2eSMarian Balakowicz 
717f13e7b2eSMarian Balakowicz /**
718f13e7b2eSMarian Balakowicz  * image_get_data - get image payload start address
719f13e7b2eSMarian Balakowicz  * @hdr: image header
720f13e7b2eSMarian Balakowicz  *
721f13e7b2eSMarian Balakowicz  * image_get_data() returns address of the image payload. For single
722f13e7b2eSMarian Balakowicz  * component images it is image data start. For multi component
723f13e7b2eSMarian Balakowicz  * images it points to the null terminated table of sub-images sizes.
724f13e7b2eSMarian Balakowicz  *
725f13e7b2eSMarian Balakowicz  * returns:
726f13e7b2eSMarian Balakowicz  *     image payload data start address
727f13e7b2eSMarian Balakowicz  */
7283a2003f6SWolfgang Denk static inline ulong image_get_data(const image_header_t *hdr)
729f13e7b2eSMarian Balakowicz {
730f13e7b2eSMarian Balakowicz 	return ((ulong)hdr + image_get_header_size());
731f13e7b2eSMarian Balakowicz }
732f13e7b2eSMarian Balakowicz 
7333a2003f6SWolfgang Denk static inline uint32_t image_get_image_size(const image_header_t *hdr)
734b97a2a0aSMarian Balakowicz {
735b97a2a0aSMarian Balakowicz 	return (image_get_size(hdr) + image_get_header_size());
736b97a2a0aSMarian Balakowicz }
7373a2003f6SWolfgang Denk static inline ulong image_get_image_end(const image_header_t *hdr)
738b97a2a0aSMarian Balakowicz {
739f13e7b2eSMarian Balakowicz 	return ((ulong)hdr + image_get_image_size(hdr));
740b97a2a0aSMarian Balakowicz }
741b97a2a0aSMarian Balakowicz 
742b97a2a0aSMarian Balakowicz #define image_set_hdr_l(f) \
743b97a2a0aSMarian Balakowicz 	static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
744b97a2a0aSMarian Balakowicz 	{ \
7459a4daad0SMarian Balakowicz 		hdr->ih_##f = cpu_to_uimage(val); \
746b97a2a0aSMarian Balakowicz 	}
747178e26d7SWolfgang Denk image_set_hdr_l(magic)		/* image_set_magic */
748178e26d7SWolfgang Denk image_set_hdr_l(hcrc)		/* image_set_hcrc */
749178e26d7SWolfgang Denk image_set_hdr_l(time)		/* image_set_time */
750178e26d7SWolfgang Denk image_set_hdr_l(size)		/* image_set_size */
751178e26d7SWolfgang Denk image_set_hdr_l(load)		/* image_set_load */
752178e26d7SWolfgang Denk image_set_hdr_l(ep)		/* image_set_ep */
753178e26d7SWolfgang Denk image_set_hdr_l(dcrc)		/* image_set_dcrc */
754b97a2a0aSMarian Balakowicz 
755b97a2a0aSMarian Balakowicz #define image_set_hdr_b(f) \
756b97a2a0aSMarian Balakowicz 	static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
757b97a2a0aSMarian Balakowicz 	{ \
758b97a2a0aSMarian Balakowicz 		hdr->ih_##f = val; \
759b97a2a0aSMarian Balakowicz 	}
760178e26d7SWolfgang Denk image_set_hdr_b(os)		/* image_set_os */
761178e26d7SWolfgang Denk image_set_hdr_b(arch)		/* image_set_arch */
762178e26d7SWolfgang Denk image_set_hdr_b(type)		/* image_set_type */
763178e26d7SWolfgang Denk image_set_hdr_b(comp)		/* image_set_comp */
764b97a2a0aSMarian Balakowicz 
765b97a2a0aSMarian Balakowicz static inline void image_set_name(image_header_t *hdr, const char *name)
766b97a2a0aSMarian Balakowicz {
767b97a2a0aSMarian Balakowicz 	strncpy(image_get_name(hdr), name, IH_NMLEN);
768b97a2a0aSMarian Balakowicz }
769b97a2a0aSMarian Balakowicz 
7703a2003f6SWolfgang Denk int image_check_hcrc(const image_header_t *hdr);
7713a2003f6SWolfgang Denk int image_check_dcrc(const image_header_t *hdr);
772af13cdbcSMarian Balakowicz #ifndef USE_HOSTCC
773723806ccSSimon Glass ulong env_get_bootm_low(void);
774723806ccSSimon Glass phys_size_t env_get_bootm_size(void);
775723806ccSSimon Glass phys_size_t env_get_bootm_mapsize(void);
776af13cdbcSMarian Balakowicz #endif
777ce1400f6SSimon Glass void memmove_wd(void *to, void *from, size_t len, ulong chunksz);
778b97a2a0aSMarian Balakowicz 
7793a2003f6SWolfgang Denk static inline int image_check_magic(const image_header_t *hdr)
780b97a2a0aSMarian Balakowicz {
781b97a2a0aSMarian Balakowicz 	return (image_get_magic(hdr) == IH_MAGIC);
782b97a2a0aSMarian Balakowicz }
7833a2003f6SWolfgang Denk static inline int image_check_type(const image_header_t *hdr, uint8_t type)
784b97a2a0aSMarian Balakowicz {
785b97a2a0aSMarian Balakowicz 	return (image_get_type(hdr) == type);
786b97a2a0aSMarian Balakowicz }
7873a2003f6SWolfgang Denk static inline int image_check_arch(const image_header_t *hdr, uint8_t arch)
788b97a2a0aSMarian Balakowicz {
7894ac0a32eSAlison Wang 	return (image_get_arch(hdr) == arch) ||
7904ac0a32eSAlison Wang 		(image_get_arch(hdr) == IH_ARCH_ARM && arch == IH_ARCH_ARM64);
791b97a2a0aSMarian Balakowicz }
7923a2003f6SWolfgang Denk static inline int image_check_os(const image_header_t *hdr, uint8_t os)
793b97a2a0aSMarian Balakowicz {
794b97a2a0aSMarian Balakowicz 	return (image_get_os(hdr) == os);
795b97a2a0aSMarian Balakowicz }
796b97a2a0aSMarian Balakowicz 
7973a2003f6SWolfgang Denk ulong image_multi_count(const image_header_t *hdr);
7983a2003f6SWolfgang Denk void image_multi_getimg(const image_header_t *hdr, ulong idx,
79942b73e8eSMarian Balakowicz 			ulong *data, ulong *len);
80042b73e8eSMarian Balakowicz 
8013a2003f6SWolfgang Denk void image_print_contents(const void *hdr);
802570abb0aSMarian Balakowicz 
803b97a2a0aSMarian Balakowicz #ifndef USE_HOSTCC
8043a2003f6SWolfgang Denk static inline int image_check_target_arch(const image_header_t *hdr)
805b97a2a0aSMarian Balakowicz {
806476af299SMike Frysinger #ifndef IH_ARCH_DEFAULT
807476af299SMike Frysinger # error "please define IH_ARCH_DEFAULT in your arch asm/u-boot.h"
808b97a2a0aSMarian Balakowicz #endif
809476af299SMike Frysinger 	return image_check_arch(hdr, IH_ARCH_DEFAULT);
810b97a2a0aSMarian Balakowicz }
8115dfb5213SMarian Balakowicz #endif /* USE_HOSTCC */
8125b1d7137Swdenk 
81313d06981SSimon Glass /**
81413d06981SSimon Glass  * Set up properties in the FDT
81513d06981SSimon Glass  *
81613d06981SSimon Glass  * This sets up properties in the FDT that is to be passed to linux.
81713d06981SSimon Glass  *
81813d06981SSimon Glass  * @images:	Images information
81913d06981SSimon Glass  * @blob:	FDT to update
82013d06981SSimon Glass  * @of_size:	Size of the FDT
82113d06981SSimon Glass  * @lmb:	Points to logical memory block structure
82213d06981SSimon Glass  * @return 0 if ok, <0 on failure
82313d06981SSimon Glass  */
82413d06981SSimon Glass int image_setup_libfdt(bootm_headers_t *images, void *blob,
82513d06981SSimon Glass 		       int of_size, struct lmb *lmb);
82613d06981SSimon Glass 
82713d06981SSimon Glass /**
82813d06981SSimon Glass  * Set up the FDT to use for booting a kernel
82913d06981SSimon Glass  *
83013d06981SSimon Glass  * This performs ramdisk setup, sets up the FDT if required, and adds
83113d06981SSimon Glass  * paramters to the FDT if libfdt is available.
83213d06981SSimon Glass  *
83313d06981SSimon Glass  * @param images	Images information
83413d06981SSimon Glass  * @return 0 if ok, <0 on failure
83513d06981SSimon Glass  */
83613d06981SSimon Glass int image_setup_linux(bootm_headers_t *images);
83713d06981SSimon Glass 
838a5266d6bSSimon Glass /**
839a5266d6bSSimon Glass  * bootz_setup() - Extract stat and size of a Linux xImage
840a5266d6bSSimon Glass  *
841a5266d6bSSimon Glass  * @image: Address of image
842a5266d6bSSimon Glass  * @start: Returns start address of image
843a5266d6bSSimon Glass  * @end : Returns end address of image
844a5266d6bSSimon Glass  * @return 0 if OK, 1 if the image was not recognised
845a5266d6bSSimon Glass  */
846a5266d6bSSimon Glass int bootz_setup(ulong image, ulong *start, ulong *end);
847a5266d6bSSimon Glass 
848a5266d6bSSimon Glass 
849d5934ad7SMarian Balakowicz /*******************************************************************/
8509a4daad0SMarian Balakowicz /* New uImage format specific code (prefixed with fit_) */
851d5934ad7SMarian Balakowicz /*******************************************************************/
8525dfb5213SMarian Balakowicz 
8535dfb5213SMarian Balakowicz #define FIT_IMAGES_PATH		"/images"
8545dfb5213SMarian Balakowicz #define FIT_CONFS_PATH		"/configurations"
8555dfb5213SMarian Balakowicz 
8563e569a6bSSimon Glass /* hash/signature node */
8575dfb5213SMarian Balakowicz #define FIT_HASH_NODENAME	"hash"
8585dfb5213SMarian Balakowicz #define FIT_ALGO_PROP		"algo"
8595dfb5213SMarian Balakowicz #define FIT_VALUE_PROP		"value"
8608ac88f2dSJoe Hershberger #define FIT_IGNORE_PROP		"uboot-ignore"
8613e569a6bSSimon Glass #define FIT_SIG_NODENAME	"signature"
8625dfb5213SMarian Balakowicz 
8635dfb5213SMarian Balakowicz /* image node */
8645dfb5213SMarian Balakowicz #define FIT_DATA_PROP		"data"
865db1b79b8Stomas.melin@vaisala.com #define FIT_DATA_OFFSET_PROP	"data-offset"
866db1b79b8Stomas.melin@vaisala.com #define FIT_DATA_SIZE_PROP	"data-size"
8675dfb5213SMarian Balakowicz #define FIT_TIMESTAMP_PROP	"timestamp"
8685dfb5213SMarian Balakowicz #define FIT_DESC_PROP		"description"
8695dfb5213SMarian Balakowicz #define FIT_ARCH_PROP		"arch"
8705dfb5213SMarian Balakowicz #define FIT_TYPE_PROP		"type"
8715dfb5213SMarian Balakowicz #define FIT_OS_PROP		"os"
8725dfb5213SMarian Balakowicz #define FIT_COMP_PROP		"compression"
8735dfb5213SMarian Balakowicz #define FIT_ENTRY_PROP		"entry"
8745dfb5213SMarian Balakowicz #define FIT_LOAD_PROP		"load"
8755dfb5213SMarian Balakowicz 
8765dfb5213SMarian Balakowicz /* configuration node */
8775dfb5213SMarian Balakowicz #define FIT_KERNEL_PROP		"kernel"
8785dfb5213SMarian Balakowicz #define FIT_RAMDISK_PROP	"ramdisk"
8795dfb5213SMarian Balakowicz #define FIT_FDT_PROP		"fdt"
880ecf8cd65SKarl Apsite #define FIT_LOADABLE_PROP	"loadables"
8815dfb5213SMarian Balakowicz #define FIT_DEFAULT_PROP	"default"
88290268b87SSimon Glass #define FIT_SETUP_PROP		"setup"
883ed0cea7cSMichal Simek #define FIT_FPGA_PROP		"fpga"
8845dfb5213SMarian Balakowicz 
8851de7bb4fSMichael van der Westhuizen #define FIT_MAX_HASH_LEN	HASH_MAX_DIGEST_SIZE
8865dfb5213SMarian Balakowicz 
887f1dcee59SSimon Glass #if IMAGE_ENABLE_FIT
8885dfb5213SMarian Balakowicz /* cmdline argument format parsing */
889314f634bSMike Frysinger int fit_parse_conf(const char *spec, ulong addr_curr,
890f50433d6SMarian Balakowicz 		ulong *addr, const char **conf_name);
891314f634bSMike Frysinger int fit_parse_subimage(const char *spec, ulong addr_curr,
892f50433d6SMarian Balakowicz 		ulong *addr, const char **image_name);
893d5934ad7SMarian Balakowicz 
89439931f96SGuilherme Maciel Ferreira int fit_get_subimage_count(const void *fit, int images_noffset);
895edbed247SBartlomiej Sieka void fit_print_contents(const void *fit);
8965dfb5213SMarian Balakowicz void fit_image_print(const void *fit, int noffset, const char *p);
8975dfb5213SMarian Balakowicz 
8985dfb5213SMarian Balakowicz /**
8995dfb5213SMarian Balakowicz  * fit_get_end - get FIT image size
9005dfb5213SMarian Balakowicz  * @fit: pointer to the FIT format image header
9015dfb5213SMarian Balakowicz  *
9025dfb5213SMarian Balakowicz  * returns:
9035dfb5213SMarian Balakowicz  *     size of the FIT image (blob) in memory
9045dfb5213SMarian Balakowicz  */
9055dfb5213SMarian Balakowicz static inline ulong fit_get_size(const void *fit)
9065dfb5213SMarian Balakowicz {
9075dfb5213SMarian Balakowicz 	return fdt_totalsize(fit);
9085dfb5213SMarian Balakowicz }
9095dfb5213SMarian Balakowicz 
9105dfb5213SMarian Balakowicz /**
9115dfb5213SMarian Balakowicz  * fit_get_end - get FIT image end
9125dfb5213SMarian Balakowicz  * @fit: pointer to the FIT format image header
9135dfb5213SMarian Balakowicz  *
9145dfb5213SMarian Balakowicz  * returns:
9155dfb5213SMarian Balakowicz  *     end address of the FIT image (blob) in memory
9165dfb5213SMarian Balakowicz  */
9177a80de46SSimon Glass ulong fit_get_end(const void *fit);
9185dfb5213SMarian Balakowicz 
9195dfb5213SMarian Balakowicz /**
9205dfb5213SMarian Balakowicz  * fit_get_name - get FIT node name
9215dfb5213SMarian Balakowicz  * @fit: pointer to the FIT format image header
9225dfb5213SMarian Balakowicz  *
9235dfb5213SMarian Balakowicz  * returns:
9245dfb5213SMarian Balakowicz  *     NULL, on error
9255dfb5213SMarian Balakowicz  *     pointer to node name, on success
9265dfb5213SMarian Balakowicz  */
9275dfb5213SMarian Balakowicz static inline const char *fit_get_name(const void *fit_hdr,
9285dfb5213SMarian Balakowicz 		int noffset, int *len)
9295dfb5213SMarian Balakowicz {
9305dfb5213SMarian Balakowicz 	return fdt_get_name(fit_hdr, noffset, len);
9315dfb5213SMarian Balakowicz }
9325dfb5213SMarian Balakowicz 
9335dfb5213SMarian Balakowicz int fit_get_desc(const void *fit, int noffset, char **desc);
9345dfb5213SMarian Balakowicz int fit_get_timestamp(const void *fit, int noffset, time_t *timestamp);
9355dfb5213SMarian Balakowicz 
9365dfb5213SMarian Balakowicz int fit_image_get_node(const void *fit, const char *image_uname);
9375dfb5213SMarian Balakowicz int fit_image_get_os(const void *fit, int noffset, uint8_t *os);
9385dfb5213SMarian Balakowicz int fit_image_get_arch(const void *fit, int noffset, uint8_t *arch);
9395dfb5213SMarian Balakowicz int fit_image_get_type(const void *fit, int noffset, uint8_t *type);
9405dfb5213SMarian Balakowicz int fit_image_get_comp(const void *fit, int noffset, uint8_t *comp);
9415dfb5213SMarian Balakowicz int fit_image_get_load(const void *fit, int noffset, ulong *load);
9425dfb5213SMarian Balakowicz int fit_image_get_entry(const void *fit, int noffset, ulong *entry);
9435dfb5213SMarian Balakowicz int fit_image_get_data(const void *fit, int noffset,
9445dfb5213SMarian Balakowicz 				const void **data, size_t *size);
945db1b79b8Stomas.melin@vaisala.com int fit_image_get_data_offset(const void *fit, int noffset, int *data_offset);
946db1b79b8Stomas.melin@vaisala.com int fit_image_get_data_size(const void *fit, int noffset, int *data_size);
9475dfb5213SMarian Balakowicz 
9485dfb5213SMarian Balakowicz int fit_image_hash_get_algo(const void *fit, int noffset, char **algo);
9495dfb5213SMarian Balakowicz int fit_image_hash_get_value(const void *fit, int noffset, uint8_t **value,
9505dfb5213SMarian Balakowicz 				int *value_len);
9515dfb5213SMarian Balakowicz 
9525dfb5213SMarian Balakowicz int fit_set_timestamp(void *fit, int noffset, time_t timestamp);
953bbb467dcSSimon Glass 
954bbb467dcSSimon Glass /**
95556518e71SSimon Glass  * fit_add_verification_data() - add verification data to FIT image nodes
956bbb467dcSSimon Glass  *
95756518e71SSimon Glass  * @keydir:	Directory containing keys
95856518e71SSimon Glass  * @kwydest:	FDT blob to write public key information to
95956518e71SSimon Glass  * @fit:	Pointer to the FIT format image header
96056518e71SSimon Glass  * @comment:	Comment to add to signature nodes
96156518e71SSimon Glass  * @require_keys: Mark all keys as 'required'
962f1ca1fdeSGeorge McCollister  * @engine_id:	Engine to use for signing
96356518e71SSimon Glass  *
96456518e71SSimon Glass  * Adds hash values for all component images in the FIT blob.
96556518e71SSimon Glass  * Hashes are calculated for all component images which have hash subnodes
96656518e71SSimon Glass  * with algorithm property set to one of the supported hash algorithms.
96756518e71SSimon Glass  *
96856518e71SSimon Glass  * Also add signatures if signature nodes are present.
96956518e71SSimon Glass  *
97056518e71SSimon Glass  * returns
97156518e71SSimon Glass  *     0, on success
97256518e71SSimon Glass  *     libfdt error code, on failure
973bbb467dcSSimon Glass  */
97456518e71SSimon Glass int fit_add_verification_data(const char *keydir, void *keydest, void *fit,
975f1ca1fdeSGeorge McCollister 			      const char *comment, int require_keys,
976f1ca1fdeSGeorge McCollister 			      const char *engine_id);
9775dfb5213SMarian Balakowicz 
978b8da8366SSimon Glass int fit_image_verify(const void *fit, int noffset);
979782cfbb2SSimon Glass int fit_config_verify(const void *fit, int conf_noffset);
980b8da8366SSimon Glass int fit_all_image_verify(const void *fit);
9815dfb5213SMarian Balakowicz int fit_image_check_os(const void *fit, int noffset, uint8_t os);
9825dfb5213SMarian Balakowicz int fit_image_check_arch(const void *fit, int noffset, uint8_t arch);
9835dfb5213SMarian Balakowicz int fit_image_check_type(const void *fit, int noffset, uint8_t type);
9845dfb5213SMarian Balakowicz int fit_image_check_comp(const void *fit, int noffset, uint8_t comp);
9855dfb5213SMarian Balakowicz int fit_check_format(const void *fit);
9865dfb5213SMarian Balakowicz 
987d95f6ec7SGabe Black int fit_conf_find_compat(const void *fit, const void *fdt);
9885dfb5213SMarian Balakowicz int fit_conf_get_node(const void *fit, const char *conf_uname);
9895dfb5213SMarian Balakowicz 
990003efd7dSSimon Glass /**
991003efd7dSSimon Glass  * fit_conf_get_prop_node() - Get node refered to by a configuration
992003efd7dSSimon Glass  * @fit:	FIT to check
993003efd7dSSimon Glass  * @noffset:	Offset of conf@xxx node to check
994003efd7dSSimon Glass  * @prop_name:	Property to read from the conf node
995003efd7dSSimon Glass  *
996003efd7dSSimon Glass  * The conf@ nodes contain references to other nodes, using properties
997003efd7dSSimon Glass  * like 'kernel = "kernel@1"'. Given such a property name (e.g. "kernel"),
998003efd7dSSimon Glass  * return the offset of the node referred to (e.g. offset of node
999003efd7dSSimon Glass  * "/images/kernel@1".
1000003efd7dSSimon Glass  */
1001003efd7dSSimon Glass int fit_conf_get_prop_node(const void *fit, int noffset,
1002003efd7dSSimon Glass 		const char *prop_name);
1003003efd7dSSimon Glass 
10045dfb5213SMarian Balakowicz void fit_conf_print(const void *fit, int noffset, const char *p);
10055dfb5213SMarian Balakowicz 
100661a439a8SSimon Glass int fit_check_ramdisk(const void *fit, int os_noffset,
100761a439a8SSimon Glass 		uint8_t arch, int verify);
100861a439a8SSimon Glass 
1009604f23ddSSimon Glass int calculate_hash(const void *data, int data_len, const char *algo,
1010604f23ddSSimon Glass 			uint8_t *value, int *value_len);
1011604f23ddSSimon Glass 
1012782cfbb2SSimon Glass /*
10133e569a6bSSimon Glass  * At present we only support signing on the host, and verification on the
10143e569a6bSSimon Glass  * device
1015782cfbb2SSimon Glass  */
1016782cfbb2SSimon Glass #if defined(CONFIG_FIT_SIGNATURE)
1017782cfbb2SSimon Glass # ifdef USE_HOSTCC
10183e569a6bSSimon Glass #  define IMAGE_ENABLE_SIGN	1
101929a23f9dSHeiko Schocher #  define IMAGE_ENABLE_VERIFY	1
1020646257d1SHeiko Schocher # include  <openssl/evp.h>
1021782cfbb2SSimon Glass #else
10223e569a6bSSimon Glass #  define IMAGE_ENABLE_SIGN	0
1023782cfbb2SSimon Glass #  define IMAGE_ENABLE_VERIFY	1
1024782cfbb2SSimon Glass # endif
1025782cfbb2SSimon Glass #else
10263e569a6bSSimon Glass # define IMAGE_ENABLE_SIGN	0
1027782cfbb2SSimon Glass # define IMAGE_ENABLE_VERIFY	0
1028782cfbb2SSimon Glass #endif
1029782cfbb2SSimon Glass 
1030782cfbb2SSimon Glass #ifdef USE_HOSTCC
103129a23f9dSHeiko Schocher void *image_get_host_blob(void);
103229a23f9dSHeiko Schocher void image_set_host_blob(void *host_blob);
103329a23f9dSHeiko Schocher # define gd_fdt_blob()		image_get_host_blob()
1034782cfbb2SSimon Glass #else
1035782cfbb2SSimon Glass # define gd_fdt_blob()		(gd->fdt_blob)
1036782cfbb2SSimon Glass #endif
1037782cfbb2SSimon Glass 
1038782cfbb2SSimon Glass #ifdef CONFIG_FIT_BEST_MATCH
1039782cfbb2SSimon Glass #define IMAGE_ENABLE_BEST_MATCH	1
1040782cfbb2SSimon Glass #else
1041782cfbb2SSimon Glass #define IMAGE_ENABLE_BEST_MATCH	0
1042782cfbb2SSimon Glass #endif
1043782cfbb2SSimon Glass 
10443e569a6bSSimon Glass /* Information passed to the signing routines */
10453e569a6bSSimon Glass struct image_sign_info {
10463e569a6bSSimon Glass 	const char *keydir;		/* Directory conaining keys */
10473e569a6bSSimon Glass 	const char *keyname;		/* Name of key to use */
10483e569a6bSSimon Glass 	void *fit;			/* Pointer to FIT blob */
10493e569a6bSSimon Glass 	int node_offset;		/* Offset of signature node */
105083dd98e0SAndrew Duda 	const char *name;		/* Algorithm name */
105183dd98e0SAndrew Duda 	struct checksum_algo *checksum;	/* Checksum algorithm information */
105283dd98e0SAndrew Duda 	struct crypto_algo *crypto;	/* Crypto algorithm information */
10533e569a6bSSimon Glass 	const void *fdt_blob;		/* FDT containing public keys */
10543e569a6bSSimon Glass 	int required_keynode;		/* Node offset of key to use: -1=any */
10553e569a6bSSimon Glass 	const char *require_keys;	/* Value for 'required' property */
1056f1ca1fdeSGeorge McCollister 	const char *engine_id;		/* Engine to use for signing */
10573e569a6bSSimon Glass };
105873223f0eSSimon Glass #endif /* Allow struct image_region to always be defined for rsa.h */
10593e569a6bSSimon Glass 
10603e569a6bSSimon Glass /* A part of an image, used for hashing */
10613e569a6bSSimon Glass struct image_region {
10623e569a6bSSimon Glass 	const void *data;
10633e569a6bSSimon Glass 	int size;
10643e569a6bSSimon Glass };
10653e569a6bSSimon Glass 
106673223f0eSSimon Glass #if IMAGE_ENABLE_FIT
106773223f0eSSimon Glass 
1068646257d1SHeiko Schocher #if IMAGE_ENABLE_VERIFY
10692b9912e6SJeroen Hofstee # include <u-boot/rsa-checksum.h>
1070646257d1SHeiko Schocher #endif
1071646257d1SHeiko Schocher struct checksum_algo {
1072646257d1SHeiko Schocher 	const char *name;
1073646257d1SHeiko Schocher 	const int checksum_len;
1074da29f299SAndrew Duda 	const int der_len;
1075da29f299SAndrew Duda 	const uint8_t *der_prefix;
1076646257d1SHeiko Schocher #if IMAGE_ENABLE_SIGN
107729a23f9dSHeiko Schocher 	const EVP_MD *(*calculate_sign)(void);
107829a23f9dSHeiko Schocher #endif
1079b37b46f0SRuchika Gupta 	int (*calculate)(const char *name,
1080b37b46f0SRuchika Gupta 			 const struct image_region region[],
1081646257d1SHeiko Schocher 			 int region_count, uint8_t *checksum);
1082646257d1SHeiko Schocher };
1083646257d1SHeiko Schocher 
10840c1d74fdSAndrew Duda struct crypto_algo {
10853e569a6bSSimon Glass 	const char *name;		/* Name of algorithm */
10860c1d74fdSAndrew Duda 	const int key_len;
10873e569a6bSSimon Glass 
10883e569a6bSSimon Glass 	/**
10893e569a6bSSimon Glass 	 * sign() - calculate and return signature for given input data
10903e569a6bSSimon Glass 	 *
10913e569a6bSSimon Glass 	 * @info:	Specifies key and FIT information
10923e569a6bSSimon Glass 	 * @data:	Pointer to the input data
10933e569a6bSSimon Glass 	 * @data_len:	Data length
10943e569a6bSSimon Glass 	 * @sigp:	Set to an allocated buffer holding the signature
10953e569a6bSSimon Glass 	 * @sig_len:	Set to length of the calculated hash
10963e569a6bSSimon Glass 	 *
10973e569a6bSSimon Glass 	 * This computes input data signature according to selected algorithm.
10983e569a6bSSimon Glass 	 * Resulting signature value is placed in an allocated buffer, the
10993e569a6bSSimon Glass 	 * pointer is returned as *sigp. The length of the calculated
11003e569a6bSSimon Glass 	 * signature is returned via the sig_len pointer argument. The caller
11013e569a6bSSimon Glass 	 * should free *sigp.
11023e569a6bSSimon Glass 	 *
11033e569a6bSSimon Glass 	 * @return: 0, on success, -ve on error
11043e569a6bSSimon Glass 	 */
11053e569a6bSSimon Glass 	int (*sign)(struct image_sign_info *info,
11063e569a6bSSimon Glass 		    const struct image_region region[],
11073e569a6bSSimon Glass 		    int region_count, uint8_t **sigp, uint *sig_len);
11083e569a6bSSimon Glass 
11093e569a6bSSimon Glass 	/**
11103e569a6bSSimon Glass 	 * add_verify_data() - Add verification information to FDT
11113e569a6bSSimon Glass 	 *
11123e569a6bSSimon Glass 	 * Add public key information to the FDT node, suitable for
11133e569a6bSSimon Glass 	 * verification at run-time. The information added depends on the
11143e569a6bSSimon Glass 	 * algorithm being used.
11153e569a6bSSimon Glass 	 *
11163e569a6bSSimon Glass 	 * @info:	Specifies key and FIT information
11173e569a6bSSimon Glass 	 * @keydest:	Destination FDT blob for public key data
11183e569a6bSSimon Glass 	 * @return: 0, on success, -ve on error
11193e569a6bSSimon Glass 	 */
11203e569a6bSSimon Glass 	int (*add_verify_data)(struct image_sign_info *info, void *keydest);
11213e569a6bSSimon Glass 
11223e569a6bSSimon Glass 	/**
11233e569a6bSSimon Glass 	 * verify() - Verify a signature against some data
11243e569a6bSSimon Glass 	 *
11253e569a6bSSimon Glass 	 * @info:	Specifies key and FIT information
11263e569a6bSSimon Glass 	 * @data:	Pointer to the input data
11273e569a6bSSimon Glass 	 * @data_len:	Data length
11283e569a6bSSimon Glass 	 * @sig:	Signature
11293e569a6bSSimon Glass 	 * @sig_len:	Number of bytes in signature
11303e569a6bSSimon Glass 	 * @return 0 if verified, -ve on error
11313e569a6bSSimon Glass 	 */
11323e569a6bSSimon Glass 	int (*verify)(struct image_sign_info *info,
11333e569a6bSSimon Glass 		      const struct image_region region[], int region_count,
11343e569a6bSSimon Glass 		      uint8_t *sig, uint sig_len);
11350c1d74fdSAndrew Duda };
1136646257d1SHeiko Schocher 
11373e569a6bSSimon Glass /**
113883dd98e0SAndrew Duda  * image_get_checksum_algo() - Look up a checksum algorithm
11393e569a6bSSimon Glass  *
114083dd98e0SAndrew Duda  * @param full_name	Name of algorithm in the form "checksum,crypto"
11413e569a6bSSimon Glass  * @return pointer to algorithm information, or NULL if not found
11423e569a6bSSimon Glass  */
114383dd98e0SAndrew Duda struct checksum_algo *image_get_checksum_algo(const char *full_name);
114483dd98e0SAndrew Duda 
114583dd98e0SAndrew Duda /**
114683dd98e0SAndrew Duda  * image_get_crypto_algo() - Look up a cryptosystem algorithm
114783dd98e0SAndrew Duda  *
114883dd98e0SAndrew Duda  * @param full_name	Name of algorithm in the form "checksum,crypto"
114983dd98e0SAndrew Duda  * @return pointer to algorithm information, or NULL if not found
115083dd98e0SAndrew Duda  */
115183dd98e0SAndrew Duda struct crypto_algo *image_get_crypto_algo(const char *full_name);
11523e569a6bSSimon Glass 
115356518e71SSimon Glass /**
115456518e71SSimon Glass  * fit_image_verify_required_sigs() - Verify signatures marked as 'required'
115556518e71SSimon Glass  *
115656518e71SSimon Glass  * @fit:		FIT to check
115756518e71SSimon Glass  * @image_noffset:	Offset of image node to check
115856518e71SSimon Glass  * @data:		Image data to check
115956518e71SSimon Glass  * @size:		Size of image data
116056518e71SSimon Glass  * @sig_blob:		FDT containing public keys
116156518e71SSimon Glass  * @no_sigsp:		Returns 1 if no signatures were required, and
116256518e71SSimon Glass  *			therefore nothing was checked. The caller may wish
116356518e71SSimon Glass  *			to fall back to other mechanisms, or refuse to
116456518e71SSimon Glass  *			boot.
116556518e71SSimon Glass  * @return 0 if all verified ok, <0 on error
116656518e71SSimon Glass  */
116756518e71SSimon Glass int fit_image_verify_required_sigs(const void *fit, int image_noffset,
116856518e71SSimon Glass 		const char *data, size_t size, const void *sig_blob,
116956518e71SSimon Glass 		int *no_sigsp);
117056518e71SSimon Glass 
117156518e71SSimon Glass /**
117256518e71SSimon Glass  * fit_image_check_sig() - Check a single image signature node
117356518e71SSimon Glass  *
117456518e71SSimon Glass  * @fit:		FIT to check
117556518e71SSimon Glass  * @noffset:		Offset of signature node to check
117656518e71SSimon Glass  * @data:		Image data to check
117756518e71SSimon Glass  * @size:		Size of image data
117856518e71SSimon Glass  * @required_keynode:	Offset in the control FDT of the required key node,
117956518e71SSimon Glass  *			if any. If this is given, then the image wil not
118056518e71SSimon Glass  *			pass verification unless that key is used. If this is
118156518e71SSimon Glass  *			-1 then any signature will do.
118256518e71SSimon Glass  * @err_msgp:		In the event of an error, this will be pointed to a
118356518e71SSimon Glass  *			help error string to display to the user.
118456518e71SSimon Glass  * @return 0 if all verified ok, <0 on error
118556518e71SSimon Glass  */
118656518e71SSimon Glass int fit_image_check_sig(const void *fit, int noffset, const void *data,
118756518e71SSimon Glass 		size_t size, int required_keynode, char **err_msgp);
118856518e71SSimon Glass 
11894d098529SSimon Glass /**
11904d098529SSimon Glass  * fit_region_make_list() - Make a list of regions to hash
11914d098529SSimon Glass  *
11924d098529SSimon Glass  * Given a list of FIT regions (offset, size) provided by libfdt, create
11934d098529SSimon Glass  * a list of regions (void *, size) for use by the signature creationg
11944d098529SSimon Glass  * and verification code.
11954d098529SSimon Glass  *
11964d098529SSimon Glass  * @fit:		FIT image to process
11974d098529SSimon Glass  * @fdt_regions:	Regions as returned by libfdt
11984d098529SSimon Glass  * @count:		Number of regions returned by libfdt
11994d098529SSimon Glass  * @region:		Place to put list of regions (NULL to allocate it)
12004d098529SSimon Glass  * @return pointer to list of regions, or NULL if out of memory
12014d098529SSimon Glass  */
12024d098529SSimon Glass struct image_region *fit_region_make_list(const void *fit,
12034d098529SSimon Glass 		struct fdt_region *fdt_regions, int count,
12044d098529SSimon Glass 		struct image_region *region);
120556518e71SSimon Glass 
12065dfb5213SMarian Balakowicz static inline int fit_image_check_target_arch(const void *fdt, int node)
12075dfb5213SMarian Balakowicz {
120829a23f9dSHeiko Schocher #ifndef USE_HOSTCC
12097566832aSThierry Reding 	return fit_image_check_arch(fdt, node, IH_ARCH_DEFAULT);
121029a23f9dSHeiko Schocher #else
121129a23f9dSHeiko Schocher 	return 0;
121229a23f9dSHeiko Schocher #endif
12135dfb5213SMarian Balakowicz }
12145dfb5213SMarian Balakowicz 
1215d5934ad7SMarian Balakowicz #ifdef CONFIG_FIT_VERBOSE
1216d5934ad7SMarian Balakowicz #define fit_unsupported(msg)	printf("! %s:%d " \
1217d5934ad7SMarian Balakowicz 				"FIT images not supported for '%s'\n", \
1218d5934ad7SMarian Balakowicz 				__FILE__, __LINE__, (msg))
1219d5934ad7SMarian Balakowicz 
1220d5934ad7SMarian Balakowicz #define fit_unsupported_reset(msg)	printf("! %s:%d " \
1221d5934ad7SMarian Balakowicz 				"FIT images not supported for '%s' " \
1222d5934ad7SMarian Balakowicz 				"- must reset board to recover!\n", \
1223d5934ad7SMarian Balakowicz 				__FILE__, __LINE__, (msg))
1224d5934ad7SMarian Balakowicz #else
1225d5934ad7SMarian Balakowicz #define fit_unsupported(msg)
1226d5934ad7SMarian Balakowicz #define fit_unsupported_reset(msg)
1227d5934ad7SMarian Balakowicz #endif /* CONFIG_FIT_VERBOSE */
1228f50433d6SMarian Balakowicz #endif /* CONFIG_FIT */
12295ad03eb3SMarian Balakowicz 
12309ace3fc8SSebastian Siewior #if defined(CONFIG_ANDROID_BOOT_IMAGE)
12319ace3fc8SSebastian Siewior struct andr_img_hdr;
12329ace3fc8SSebastian Siewior int android_image_check_header(const struct andr_img_hdr *hdr);
12339ace3fc8SSebastian Siewior int android_image_get_kernel(const struct andr_img_hdr *hdr, int verify,
12349ace3fc8SSebastian Siewior 			     ulong *os_data, ulong *os_len);
12359ace3fc8SSebastian Siewior int android_image_get_ramdisk(const struct andr_img_hdr *hdr,
12369ace3fc8SSebastian Siewior 			      ulong *rd_data, ulong *rd_len);
12379ace3fc8SSebastian Siewior ulong android_image_get_end(const struct andr_img_hdr *hdr);
12389ace3fc8SSebastian Siewior ulong android_image_get_kload(const struct andr_img_hdr *hdr);
12394f1318b2SMichael Trimarchi void android_print_contents(const struct andr_img_hdr *hdr);
12409ace3fc8SSebastian Siewior 
1241*76e2a5a6SAlex Deymo /** android_image_load - Load an Android Image from storage.
1242*76e2a5a6SAlex Deymo  *
1243*76e2a5a6SAlex Deymo  * Load an Android Image based on the header size in the storage. Return the
1244*76e2a5a6SAlex Deymo  * number of bytes read from storage, which could be bigger than the actual
1245*76e2a5a6SAlex Deymo  * Android Image as described in the header size. In case of error reading the
1246*76e2a5a6SAlex Deymo  * image or if the image size needed to be read from disk is bigger than the
1247*76e2a5a6SAlex Deymo  * the passed |max_size| a negative number is returned.
1248*76e2a5a6SAlex Deymo  *
1249*76e2a5a6SAlex Deymo  * @dev_desc:		The device where to read the image from
1250*76e2a5a6SAlex Deymo  * @part_info:		The partition in |dev_desc| where to read the image from
1251*76e2a5a6SAlex Deymo  * @load_address:	The address where the image will be loaded
1252*76e2a5a6SAlex Deymo  * @max_size:		The maximum loaded size, in bytes
1253*76e2a5a6SAlex Deymo  * @return the number of bytes read or a negative number in case of error.
1254*76e2a5a6SAlex Deymo  */
1255*76e2a5a6SAlex Deymo long android_image_load(struct blk_desc *dev_desc,
1256*76e2a5a6SAlex Deymo 			const disk_partition_t *part_info,
1257*76e2a5a6SAlex Deymo 			unsigned long load_address,
1258*76e2a5a6SAlex Deymo 			unsigned long max_size);
1259*76e2a5a6SAlex Deymo 
12609ace3fc8SSebastian Siewior #endif /* CONFIG_ANDROID_BOOT_IMAGE */
12619ace3fc8SSebastian Siewior 
12624b307f23SSimon Glass /**
12634b307f23SSimon Glass  * board_fit_config_name_match() - Check for a matching board name
12644b307f23SSimon Glass  *
12654b307f23SSimon Glass  * This is used when SPL loads a FIT containing multiple device tree files
12664b307f23SSimon Glass  * and wants to work out which one to use. The description of each one is
12674b307f23SSimon Glass  * passed to this function. The description comes from the 'description' field
12684b307f23SSimon Glass  * in each (FDT) image node.
12694b307f23SSimon Glass  *
12704b307f23SSimon Glass  * @name: Device tree description
12714b307f23SSimon Glass  * @return 0 if this device tree should be used, non-zero to try the next
12724b307f23SSimon Glass  */
12734b307f23SSimon Glass int board_fit_config_name_match(const char *name);
12744b307f23SSimon Glass 
1275a5c7e41bSMadan Srinivas #if defined(CONFIG_SPL_FIT_IMAGE_POST_PROCESS) || \
1276a5c7e41bSMadan Srinivas 	defined(CONFIG_FIT_IMAGE_POST_PROCESS)
1277da74d1f3SDaniel Allred /**
1278da74d1f3SDaniel Allred  * board_fit_image_post_process() - Do any post-process on FIT binary data
1279da74d1f3SDaniel Allred  *
1280da74d1f3SDaniel Allred  * This is used to do any sort of image manipulation, verification, decryption
1281da74d1f3SDaniel Allred  * etc. in a platform or board specific way. Obviously, anything done here would
1282da74d1f3SDaniel Allred  * need to be comprehended in how the images were prepared before being injected
1283da74d1f3SDaniel Allred  * into the FIT creation (i.e. the binary blobs would have been pre-processed
1284da74d1f3SDaniel Allred  * before being added to the FIT image).
1285da74d1f3SDaniel Allred  *
1286da74d1f3SDaniel Allred  * @image: pointer to the image start pointer
1287da74d1f3SDaniel Allred  * @size: pointer to the image size
1288da74d1f3SDaniel Allred  * @return no return value (failure should be handled internally)
1289da74d1f3SDaniel Allred  */
1290da74d1f3SDaniel Allred void board_fit_image_post_process(void **p_image, size_t *p_size);
1291da74d1f3SDaniel Allred #endif /* CONFIG_SPL_FIT_IMAGE_POST_PROCESS */
1292da74d1f3SDaniel Allred 
12933863f840SCooper Jr., Franklin #define FDT_ERROR	((ulong)(-1))
12943863f840SCooper Jr., Franklin 
129592926bc8SCooper Jr., Franklin ulong fdt_getprop_u32(const void *fdt, int node, const char *prop);
129692926bc8SCooper Jr., Franklin int fit_find_config_node(const void *fdt);
129792926bc8SCooper Jr., Franklin 
1298d7be5092SAndrew F. Davis /**
1299d7be5092SAndrew F. Davis  * Mapping of image types to function handlers to be invoked on the associated
1300d7be5092SAndrew F. Davis  * loaded images
1301d7be5092SAndrew F. Davis  *
1302d7be5092SAndrew F. Davis  * @type: Type of image, I.E. IH_TYPE_*
1303d7be5092SAndrew F. Davis  * @handler: Function to call on loaded image
1304d7be5092SAndrew F. Davis  */
1305d7be5092SAndrew F. Davis struct fit_loadable_tbl {
1306d7be5092SAndrew F. Davis 	int type;
1307d7be5092SAndrew F. Davis 	/**
1308d7be5092SAndrew F. Davis 	 * handler() - Process a loaded image
1309d7be5092SAndrew F. Davis 	 *
1310d7be5092SAndrew F. Davis 	 * @data: Pointer to start of loaded image data
1311d7be5092SAndrew F. Davis 	 * @size: Size of loaded image data
1312d7be5092SAndrew F. Davis 	 */
1313d7be5092SAndrew F. Davis 	void (*handler)(ulong data, size_t size);
1314d7be5092SAndrew F. Davis };
1315d7be5092SAndrew F. Davis 
1316d7be5092SAndrew F. Davis /*
1317d7be5092SAndrew F. Davis  * Define a FIT loadable image type handler
1318d7be5092SAndrew F. Davis  *
1319d7be5092SAndrew F. Davis  * _type is a valid uimage_type ID as defined in the "Image Type" enum above
1320d7be5092SAndrew F. Davis  * _handler is the handler function to call after this image type is loaded
1321d7be5092SAndrew F. Davis  */
1322d7be5092SAndrew F. Davis #define U_BOOT_FIT_LOADABLE_HANDLER(_type, _handler) \
1323d7be5092SAndrew F. Davis 	ll_entry_declare(struct fit_loadable_tbl, _function, fit_loadable) = { \
1324d7be5092SAndrew F. Davis 		.type = _type, \
1325d7be5092SAndrew F. Davis 		.handler = _handler, \
1326d7be5092SAndrew F. Davis 	}
1327d7be5092SAndrew F. Davis 
13285b1d7137Swdenk #endif	/* __IMAGE_H__ */
1329