Blame view

include/image.h 43.1 KB
5b1d71372   wdenk   Initial revision
1
  /*
b97a2a0a2   Marian Balakowicz   [new uImage] Defi...
2
3
   * (C) Copyright 2008 Semihalf
   *
f08abe311   Wolfgang Denk   Remove unnnecessa...
4
   * (C) Copyright 2000-2005
5b1d71372   wdenk   Initial revision
5
6
   * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
   *
1a4596601   Wolfgang Denk   Add GPL-2.0+ SPDX...
7
   * SPDX-License-Identifier:	GPL-2.0+
f08abe311   Wolfgang Denk   Remove unnnecessa...
8
9
10
11
12
13
   ********************************************************************
   * NOTE: This header file defines an interface to U-Boot. Including
   * this (unmodified) header file in another file is considered normal
   * use of U-Boot, and does *not* fall under the heading of "derived
   * work".
   ********************************************************************
5b1d71372   wdenk   Initial revision
14
15
16
17
   */
  
  #ifndef __IMAGE_H__
  #define __IMAGE_H__
375660907   Mike Frysinger   compiler.h: unify...
18
  #include "compiler.h"
2f220500a   Kim Phillips   include/image.h: ...
19
  #include <asm/byteorder.h>
375660907   Mike Frysinger   compiler.h: unify...
20

13d06981a   Simon Glass   image: Add device...
21
22
  /* Define this to avoid #ifdefs later on */
  struct lmb;
375660907   Mike Frysinger   compiler.h: unify...
23
  #ifdef USE_HOSTCC
26e355d13   Jörg Krause   Fix musl build
24
  #include <sys/types.h>
9d25438fe   Bartlomiej Sieka   [new uImage] Add ...
25
26
  
  /* new uImage format support enabled on host */
aa34fbc08   Simon Glass   fdt: Allow libfdt...
27
28
  #define IMAGE_ENABLE_FIT	1
  #define IMAGE_ENABLE_OF_LIBFDT	1
9d25438fe   Bartlomiej Sieka   [new uImage] Add ...
29
  #define CONFIG_FIT_VERBOSE	1 /* enable fit_format_{error,warning}() */
0db7f6859   Tom Rini   FIT: Rename FIT_D...
30
  #define CONFIG_FIT_ENABLE_SHA256_SUPPORT
089df18bf   Tom Rini   lib: move hash CO...
31
32
  #define CONFIG_SHA1
  #define CONFIG_SHA256
75d3e8fbd   Marian Balakowicz   [new uImage] Pull...
33

ab9efc665   Simon Glass   image: Move hash ...
34
  #define IMAGE_ENABLE_IGNORE	0
1fe7d9389   Simon Glass   image: Remove rem...
35
  #define IMAGE_INDENT_STRING	""
ab9efc665   Simon Glass   image: Move hash ...
36

def0819e9   Wolfgang Denk   FDT: don't use pr...
37
38
39
  #else
  
  #include <lmb.h>
def0819e9   Wolfgang Denk   FDT: don't use pr...
40
  #include <asm/u-boot.h>
5daa1c18b   Mike Frysinger   image.h: avoid co...
41
  #include <command.h>
def0819e9   Wolfgang Denk   FDT: don't use pr...
42

ab9efc665   Simon Glass   image: Move hash ...
43
44
  /* Take notice of the 'ignore' property for hashes */
  #define IMAGE_ENABLE_IGNORE	1
1fe7d9389   Simon Glass   image: Remove rem...
45
  #define IMAGE_INDENT_STRING	"   "
ab9efc665   Simon Glass   image: Move hash ...
46

aa34fbc08   Simon Glass   fdt: Allow libfdt...
47
48
  #define IMAGE_ENABLE_FIT	CONFIG_IS_ENABLED(FIT)
  #define IMAGE_ENABLE_OF_LIBFDT	CONFIG_IS_ENABLED(OF_LIBFDT)
73223f0e1   Simon Glass   Kconfig: Move CON...
49

9d25438fe   Bartlomiej Sieka   [new uImage] Add ...
50
  #endif /* USE_HOSTCC */
d5934ad77   Marian Balakowicz   [new uImage] Add ...
51

73223f0e1   Simon Glass   Kconfig: Move CON...
52
  #if IMAGE_ENABLE_FIT
1de7bb4f2   Michael van der Westhuizen   Prevent a buffer ...
53
  #include <hash.h>
b08c8c487   Masahiro Yamada   libfdt: move head...
54
  #include <linux/libfdt.h>
5dfb52138   Marian Balakowicz   [new uImage] New ...
55
  #include <fdt_support.h>
87ebee39e   Simon Glass   image: Add CONFIG...
56
  # ifdef CONFIG_SPL_BUILD
6f41751f4   Masahiro Yamada   Revert "image.h: ...
57
58
59
60
61
62
63
64
65
  #  ifdef CONFIG_SPL_CRC32_SUPPORT
  #   define IMAGE_ENABLE_CRC32	1
  #  endif
  #  ifdef CONFIG_SPL_MD5_SUPPORT
  #   define IMAGE_ENABLE_MD5	1
  #  endif
  #  ifdef CONFIG_SPL_SHA1_SUPPORT
  #   define IMAGE_ENABLE_SHA1	1
  #  endif
87ebee39e   Simon Glass   image: Add CONFIG...
66
67
  # else
  #  define CONFIG_CRC32		/* FIT images need CRC32 support */
87ebee39e   Simon Glass   image: Add CONFIG...
68
69
70
71
  #  define IMAGE_ENABLE_CRC32	1
  #  define IMAGE_ENABLE_MD5	1
  #  define IMAGE_ENABLE_SHA1	1
  # endif
6f41751f4   Masahiro Yamada   Revert "image.h: ...
72

6f41751f4   Masahiro Yamada   Revert "image.h: ...
73
74
75
76
77
78
79
80
81
82
83
  #ifndef IMAGE_ENABLE_CRC32
  #define IMAGE_ENABLE_CRC32	0
  #endif
  
  #ifndef IMAGE_ENABLE_MD5
  #define IMAGE_ENABLE_MD5	0
  #endif
  
  #ifndef IMAGE_ENABLE_SHA1
  #define IMAGE_ENABLE_SHA1	0
  #endif
0db7f6859   Tom Rini   FIT: Rename FIT_D...
84
85
  #if defined(CONFIG_FIT_ENABLE_SHA256_SUPPORT) || \
  	defined(CONFIG_SPL_SHA256_SUPPORT)
0db7f6859   Tom Rini   FIT: Rename FIT_D...
86
87
  #define IMAGE_ENABLE_SHA256	1
  #else
6f41751f4   Masahiro Yamada   Revert "image.h: ...
88
89
  #define IMAGE_ENABLE_SHA256	0
  #endif
73223f0e1   Simon Glass   Kconfig: Move CON...
90
  #endif /* IMAGE_ENABLE_FIT */
13d06981a   Simon Glass   image: Add device...
91

6f41751f4   Masahiro Yamada   Revert "image.h: ...
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
  #ifdef CONFIG_SYS_BOOT_GET_CMDLINE
  # define IMAGE_BOOT_GET_CMDLINE		1
  #else
  # define IMAGE_BOOT_GET_CMDLINE		0
  #endif
  
  #ifdef CONFIG_OF_BOARD_SETUP
  # define IMAGE_OF_BOARD_SETUP		1
  #else
  # define IMAGE_OF_BOARD_SETUP		0
  #endif
  
  #ifdef CONFIG_OF_SYSTEM_SETUP
  # define IMAGE_OF_SYSTEM_SETUP	1
  #else
  # define IMAGE_OF_SYSTEM_SETUP	0
  #endif
c654b5172   Simon Glass   fdt: Add ft_syste...
109

56d7ab747   Simon Glass   image: Create a t...
110
111
112
113
114
115
116
117
  enum ih_category {
  	IH_ARCH,
  	IH_COMP,
  	IH_OS,
  	IH_TYPE,
  
  	IH_COUNT,
  };
5b1d71372   wdenk   Initial revision
118
119
  /*
   * Operating System Codes
ff87b0810   Masahiro Yamada   image: fix IH_ARC...
120
121
122
   *
   * The following are exposed to uImage header.
   * Do not change values for backward compatibility.
5b1d71372   wdenk   Initial revision
123
   */
555f45d8f   Simon Glass   image: Convert th...
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
  enum {
  	IH_OS_INVALID		= 0,	/* Invalid OS	*/
  	IH_OS_OPENBSD,			/* OpenBSD	*/
  	IH_OS_NETBSD,			/* NetBSD	*/
  	IH_OS_FREEBSD,			/* FreeBSD	*/
  	IH_OS_4_4BSD,			/* 4.4BSD	*/
  	IH_OS_LINUX,			/* Linux	*/
  	IH_OS_SVR4,			/* SVR4		*/
  	IH_OS_ESIX,			/* Esix		*/
  	IH_OS_SOLARIS,			/* Solaris	*/
  	IH_OS_IRIX,			/* Irix		*/
  	IH_OS_SCO,			/* SCO		*/
  	IH_OS_DELL,			/* Dell		*/
  	IH_OS_NCR,			/* NCR		*/
  	IH_OS_LYNXOS,			/* LynxOS	*/
  	IH_OS_VXWORKS,			/* VxWorks	*/
  	IH_OS_PSOS,			/* pSOS		*/
  	IH_OS_QNX,			/* QNX		*/
  	IH_OS_U_BOOT,			/* Firmware	*/
  	IH_OS_RTEMS,			/* RTEMS	*/
  	IH_OS_ARTOS,			/* ARTOS	*/
  	IH_OS_UNITY,			/* Unity OS	*/
  	IH_OS_INTEGRITY,		/* INTEGRITY	*/
  	IH_OS_OSE,			/* OSE		*/
  	IH_OS_PLAN9,			/* Plan 9	*/
  	IH_OS_OPENRTOS,		/* OpenRTOS	*/
4914af128   Philipp Tomsich   image: add IH_OS_...
150
  	IH_OS_ARM_TRUSTED_FIRMWARE,     /* ARM Trusted Firmware */
555f45d8f   Simon Glass   image: Convert th...
151
152
153
  
  	IH_OS_COUNT,
  };
5b1d71372   wdenk   Initial revision
154
155
156
  
  /*
   * CPU Architecture Codes (supported by Linux)
ff87b0810   Masahiro Yamada   image: fix IH_ARC...
157
158
159
   *
   * The following are exposed to uImage header.
   * Do not change values for backward compatibility.
5b1d71372   wdenk   Initial revision
160
   */
555f45d8f   Simon Glass   image: Convert th...
161
162
163
164
165
166
167
168
169
170
171
172
173
174
  enum {
  	IH_ARCH_INVALID		= 0,	/* Invalid CPU	*/
  	IH_ARCH_ALPHA,			/* Alpha	*/
  	IH_ARCH_ARM,			/* ARM		*/
  	IH_ARCH_I386,			/* Intel x86	*/
  	IH_ARCH_IA64,			/* IA64		*/
  	IH_ARCH_MIPS,			/* MIPS		*/
  	IH_ARCH_MIPS64,			/* MIPS	 64 Bit */
  	IH_ARCH_PPC,			/* PowerPC	*/
  	IH_ARCH_S390,			/* IBM S390	*/
  	IH_ARCH_SH,			/* SuperH	*/
  	IH_ARCH_SPARC,			/* Sparc	*/
  	IH_ARCH_SPARC64,		/* Sparc 64 Bit */
  	IH_ARCH_M68K,			/* M68K		*/
ff87b0810   Masahiro Yamada   image: fix IH_ARC...
175
  	IH_ARCH_NIOS,			/* Nios-32	*/
555f45d8f   Simon Glass   image: Convert th...
176
177
178
179
180
181
182
183
184
185
186
  	IH_ARCH_MICROBLAZE,		/* MicroBlaze   */
  	IH_ARCH_NIOS2,			/* Nios-II	*/
  	IH_ARCH_BLACKFIN,		/* Blackfin	*/
  	IH_ARCH_AVR32,			/* AVR32	*/
  	IH_ARCH_ST200,			/* STMicroelectronics ST200  */
  	IH_ARCH_SANDBOX,		/* Sandbox architecture (test only) */
  	IH_ARCH_NDS32,			/* ANDES Technology - NDS32  */
  	IH_ARCH_OPENRISC,		/* OpenRISC 1000  */
  	IH_ARCH_ARM64,			/* ARM64	*/
  	IH_ARCH_ARC,			/* Synopsys DesignWare ARC */
  	IH_ARCH_X86_64,			/* AMD x86_64, Intel and Via */
de5e5cea0   Chris Zankel   xtensa: add suppo...
187
  	IH_ARCH_XTENSA,			/* Xtensa	*/
068feb9b8   Rick Chen   riscv: Modify gen...
188
  	IH_ARCH_RISCV,			/* RISC-V */
555f45d8f   Simon Glass   image: Convert th...
189
190
191
  
  	IH_ARCH_COUNT,
  };
5b1d71372   wdenk   Initial revision
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
  
  /*
   * Image Types
   *
   * "Standalone Programs" are directly runnable in the environment
   *	provided by U-Boot; it is expected that (if they behave
   *	well) you can continue to work in U-Boot after return from
   *	the Standalone Program.
   * "OS Kernel Images" are usually images of some Embedded OS which
   *	will take over control completely. Usually these programs
   *	will install their own set of exception handlers, device
   *	drivers, set up the MMU, etc. - this means, that you cannot
   *	expect to re-enter U-Boot except by resetting the CPU.
   * "RAMDisk Images" are more or less just data blocks, and their
   *	parameters (address, size) are passed to an OS kernel that is
   *	being started.
   * "Multi-File Images" contain several images, typically an OS
   *	(Linux) kernel image and one or more data images like
   *	RAMDisks. This construct is useful for instance when you want
   *	to boot over the network using BOOTP etc., where the boot
   *	server provides just a single image file, but you want to get
   *	for instance an OS kernel and a RAMDisk image.
   *
   *	"Multi-File Images" start with a list of image sizes, each
   *	image size (in bytes) specified by an "uint32_t" in network
   *	byte order. This list is terminated by an "(uint32_t)0".
   *	Immediately after the terminating 0 follow the images, one by
   *	one, all aligned on "uint32_t" boundaries (size rounded up to
e1599e83d   wdenk   * Patch by Gridis...
220
   *	a multiple of 4 bytes - except for the last file).
5b1d71372   wdenk   Initial revision
221
222
223
224
225
226
227
228
   *
   * "Firmware Images" are binary images containing firmware (like
   *	U-Boot or FPGA images) which usually will be programmed to
   *	flash memory.
   *
   * "Script files" are command sequences that will be executed by
   *	U-Boot's command interpreter; this feature is especially
   *	useful when you configure U-Boot to use a real shell (hush)
27b207fd0   wdenk   * Implement new m...
229
   *	as command interpreter (=> Shell Scripts).
ff87b0810   Masahiro Yamada   image: fix IH_ARC...
230
231
232
   *
   * The following are exposed to uImage header.
   * Do not change values for backward compatibility.
5b1d71372   wdenk   Initial revision
233
   */
555f45d8f   Simon Glass   image: Convert th...
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
  enum {
  	IH_TYPE_INVALID		= 0,	/* Invalid Image		*/
  	IH_TYPE_STANDALONE,		/* Standalone Program		*/
  	IH_TYPE_KERNEL,			/* OS Kernel Image		*/
  	IH_TYPE_RAMDISK,		/* RAMDisk Image		*/
  	IH_TYPE_MULTI,			/* Multi-File Image		*/
  	IH_TYPE_FIRMWARE,		/* Firmware Image		*/
  	IH_TYPE_SCRIPT,			/* Script file			*/
  	IH_TYPE_FILESYSTEM,		/* Filesystem Image (any type)	*/
  	IH_TYPE_FLATDT,			/* Binary Flat Device Tree Blob	*/
  	IH_TYPE_KWBIMAGE,		/* Kirkwood Boot Image		*/
  	IH_TYPE_IMXIMAGE,		/* Freescale IMXBoot Image	*/
  	IH_TYPE_UBLIMAGE,		/* Davinci UBL Image		*/
  	IH_TYPE_OMAPIMAGE,		/* TI OMAP Config Header Image	*/
  	IH_TYPE_AISIMAGE,		/* TI Davinci AIS Image		*/
  	/* OS Kernel Image, can run from any load address */
  	IH_TYPE_KERNEL_NOLOAD,
  	IH_TYPE_PBLIMAGE,		/* Freescale PBL Boot Image	*/
  	IH_TYPE_MXSIMAGE,		/* Freescale MXSBoot Image	*/
  	IH_TYPE_GPIMAGE,		/* TI Keystone GPHeader Image	*/
  	IH_TYPE_ATMELIMAGE,		/* ATMEL ROM bootable Image	*/
  	IH_TYPE_SOCFPGAIMAGE,		/* Altera SOCFPGA Preloader	*/
  	IH_TYPE_X86_SETUP,		/* x86 setup.bin Image		*/
  	IH_TYPE_LPC32XXIMAGE,		/* x86 setup.bin Image		*/
  	IH_TYPE_LOADABLE,		/* A list of typeless images	*/
  	IH_TYPE_RKIMAGE,		/* Rockchip Boot Image		*/
  	IH_TYPE_RKSD,			/* Rockchip SD card		*/
  	IH_TYPE_RKSPI,			/* Rockchip SPI image		*/
  	IH_TYPE_ZYNQIMAGE,		/* Xilinx Zynq Boot Image */
  	IH_TYPE_ZYNQMPIMAGE,		/* Xilinx ZynqMP Boot Image */
  	IH_TYPE_FPGA,			/* FPGA Image */
ed0c2c0a9   Albert ARIBAUD \(3ADEV\)   tools: mkimage: a...
265
  	IH_TYPE_VYBRIDIMAGE,	/* VYBRID .vyb Image */
7e719ee7d   Andrew F. Davis   image: Add Truste...
266
  	IH_TYPE_TEE,            /* Trusted Execution Environment OS Image */
d21bd69b6   Sven Ebenfeld   tools: mkimage: a...
267
  	IH_TYPE_FIRMWARE_IVT,		/* Firmware Image with HABv4 IVT */
6442c9643   Andrew F. Davis   image: Add TI PMM...
268
  	IH_TYPE_PMMC,            /* TI Power Management Micro-Controller Firmware */
555f45d8f   Simon Glass   image: Convert th...
269
270
271
  
  	IH_TYPE_COUNT,			/* Number of image types */
  };
5b9d44df2   Simon Glass   mkimage: Display ...
272

5b1d71372   wdenk   Initial revision
273
274
  /*
   * Compression Types
ff87b0810   Masahiro Yamada   image: fix IH_ARC...
275
276
277
   *
   * The following are exposed to uImage header.
   * Do not change values for backward compatibility.
5b1d71372   wdenk   Initial revision
278
   */
555f45d8f   Simon Glass   image: Convert th...
279
280
281
282
283
284
285
286
287
288
  enum {
  	IH_COMP_NONE		= 0,	/*  No	 Compression Used	*/
  	IH_COMP_GZIP,			/* gzip	 Compression Used	*/
  	IH_COMP_BZIP2,			/* bzip2 Compression Used	*/
  	IH_COMP_LZMA,			/* lzma  Compression Used	*/
  	IH_COMP_LZO,			/* lzo   Compression Used	*/
  	IH_COMP_LZ4,			/* lz4   Compression Used	*/
  
  	IH_COMP_COUNT,
  };
5b1d71372   wdenk   Initial revision
289
290
291
  
  #define IH_MAGIC	0x27051956	/* Image Magic Number		*/
  #define IH_NMLEN		32	/* Image Name Length		*/
1411fb37b   Fabio Estevam   tools: imximage: ...
292
293
  /* Reused from common.h */
  #define ROUND(a, b)		(((a) + (b) - 1) & ~((b) - 1))
5b1d71372   wdenk   Initial revision
294
  /*
9a4daad0a   Marian Balakowicz   [new uImage] Upda...
295
296
   * Legacy format image header,
   * all data in network byte order (aka natural aka bigendian).
5b1d71372   wdenk   Initial revision
297
   */
5b1d71372   wdenk   Initial revision
298
  typedef struct image_header {
2f220500a   Kim Phillips   include/image.h: ...
299
300
301
302
303
304
305
  	__be32		ih_magic;	/* Image Header Magic Number	*/
  	__be32		ih_hcrc;	/* Image Header CRC Checksum	*/
  	__be32		ih_time;	/* Image Creation Timestamp	*/
  	__be32		ih_size;	/* Image Data Size		*/
  	__be32		ih_load;	/* Data	 Load  Address		*/
  	__be32		ih_ep;		/* Entry Point Address		*/
  	__be32		ih_dcrc;	/* Image Data CRC Checksum	*/
5b1d71372   wdenk   Initial revision
306
307
308
309
310
311
  	uint8_t		ih_os;		/* Operating System		*/
  	uint8_t		ih_arch;	/* CPU architecture		*/
  	uint8_t		ih_type;	/* Image Type			*/
  	uint8_t		ih_comp;	/* Compression Type		*/
  	uint8_t		ih_name[IH_NMLEN];	/* Image Name		*/
  } image_header_t;
396f635b8   Kumar Gala   bootm: refactor i...
312
313
314
315
316
  typedef struct image_info {
  	ulong		start, end;		/* start/end of blob */
  	ulong		image_start, image_len; /* start of image within blob, len of image */
  	ulong		load;			/* load addr for the image */
  	uint8_t		comp, type, os;		/* compression, type of image, os type */
90268b878   Simon Glass   x86: Support load...
317
  	uint8_t		arch;			/* CPU architecture */
396f635b8   Kumar Gala   bootm: refactor i...
318
  } image_info_t;
559316faf   Marian Balakowicz   [new uImage] Move...
319
  /*
d5934ad77   Marian Balakowicz   [new uImage] Add ...
320
321
322
323
324
325
   * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
   * routines.
   */
  typedef struct bootm_headers {
  	/*
  	 * Legacy os image header, if it is a multi component image
9a4daad0a   Marian Balakowicz   [new uImage] Upda...
326
  	 * then boot_get_ramdisk() and get_fdt() will attempt to get
d5934ad77   Marian Balakowicz   [new uImage] Add ...
327
328
  	 * data from second and third component accordingly.
  	 */
cb1c48969   Marian Balakowicz   Restore the abili...
329
330
  	image_header_t	*legacy_hdr_os;		/* image header pointer */
  	image_header_t	legacy_hdr_os_copy;	/* header copy */
d5934ad77   Marian Balakowicz   [new uImage] Add ...
331
  	ulong		legacy_hdr_valid;
73223f0e1   Simon Glass   Kconfig: Move CON...
332
  #if IMAGE_ENABLE_FIT
f773bea8e   Marian Balakowicz   [new uImage] Add ...
333
  	const char	*fit_uname_cfg;	/* configuration node unit name */
d5934ad77   Marian Balakowicz   [new uImage] Add ...
334
  	void		*fit_hdr_os;	/* os FIT image header */
eb6175edd   Marian Balakowicz   [new uImage] Make...
335
  	const char	*fit_uname_os;	/* os subimage node unit name */
3dfe11014   Marian Balakowicz   [new uImage] Add ...
336
  	int		fit_noffset_os;	/* os subimage node offset */
d5934ad77   Marian Balakowicz   [new uImage] Add ...
337
338
  
  	void		*fit_hdr_rd;	/* init ramdisk FIT image header */
3dfe11014   Marian Balakowicz   [new uImage] Add ...
339
340
  	const char	*fit_uname_rd;	/* init ramdisk subimage node unit name */
  	int		fit_noffset_rd;	/* init ramdisk subimage node offset */
d5934ad77   Marian Balakowicz   [new uImage] Add ...
341

d5934ad77   Marian Balakowicz   [new uImage] Add ...
342
  	void		*fit_hdr_fdt;	/* FDT blob FIT image header */
3dfe11014   Marian Balakowicz   [new uImage] Add ...
343
344
  	const char	*fit_uname_fdt;	/* FDT blob subimage node unit name */
  	int		fit_noffset_fdt;/* FDT blob subimage node offset */
90268b878   Simon Glass   x86: Support load...
345
346
347
348
  
  	void		*fit_hdr_setup;	/* x86 setup FIT image header */
  	const char	*fit_uname_setup; /* x86 setup subimage node name */
  	int		fit_noffset_setup;/* x86 setup subimage node offset */
d5934ad77   Marian Balakowicz   [new uImage] Add ...
349
  #endif
1ec73761d   Marian Balakowicz   [new uImage] Fix ...
350

49c3a861d   Kumar Gala   bootm: Add subcom...
351
  #ifndef USE_HOSTCC
396f635b8   Kumar Gala   bootm: refactor i...
352
  	image_info_t	os;		/* os image info */
c160a9544   Kumar Gala   bootm: refactor e...
353
  	ulong		ep;		/* entry point of OS */
c4f9419c6   Kumar Gala   bootm: refactor r...
354
  	ulong		rd_start, rd_end;/* ramdisk start/end */
06a09918f   Kumar Gala   bootm: refactor f...
355
  	char		*ft_addr;	/* flat dev tree address */
06a09918f   Kumar Gala   bootm: refactor f...
356
  	ulong		ft_len;		/* length of flat device tree */
49c3a861d   Kumar Gala   bootm: Add subcom...
357
358
359
360
361
362
  	ulong		initrd_start;
  	ulong		initrd_end;
  	ulong		cmdline_start;
  	ulong		cmdline_end;
  	bd_t		*kbd;
  #endif
00caae6d4   Simon Glass   env: Rename geten...
363
  	int		verify;		/* env_get("verify")[0] != 'n' */
49c3a861d   Kumar Gala   bootm: Add subcom...
364
365
  
  #define	BOOTM_STATE_START	(0x00000001)
35fc84fa1   Simon Glass   Refactor the boot...
366
367
368
369
370
371
372
373
  #define	BOOTM_STATE_FINDOS	(0x00000002)
  #define	BOOTM_STATE_FINDOTHER	(0x00000004)
  #define	BOOTM_STATE_LOADOS	(0x00000008)
  #define	BOOTM_STATE_RAMDISK	(0x00000010)
  #define	BOOTM_STATE_FDT		(0x00000020)
  #define	BOOTM_STATE_OS_CMDLINE	(0x00000040)
  #define	BOOTM_STATE_OS_BD_T	(0x00000080)
  #define	BOOTM_STATE_OS_PREP	(0x00000100)
d0ae31eb0   Simon Glass   Add a 'fake' go c...
374
375
  #define	BOOTM_STATE_OS_FAKE_GO	(0x00000200)	/* 'Almost' run the OS */
  #define	BOOTM_STATE_OS_GO	(0x00000400)
49c3a861d   Kumar Gala   bootm: Add subcom...
376
  	int		state;
a16028da6   Mike Frysinger   lmb: only force o...
377
  #ifdef CONFIG_LMB
e906cfae0   Kumar Gala   bootm: move lmb i...
378
379
  	struct lmb	lmb;		/* for memory mgmt */
  #endif
d5934ad77   Marian Balakowicz   [new uImage] Add ...
380
  } bootm_headers_t;
1648a3750   Simon Schwarz   Add cmd_spl command
381
  extern bootm_headers_t images;
d5934ad77   Marian Balakowicz   [new uImage] Add ...
382
  /*
559316faf   Marian Balakowicz   [new uImage] Move...
383
384
   * Some systems (for example LWMON) have very short watchdog periods;
   * we must make sure to split long operations like memmove() or
7590378fb   Bartlomiej Sieka   Use watchdog-awar...
385
   * checksum calculations into reasonable chunks.
559316faf   Marian Balakowicz   [new uImage] Move...
386
   */
7590378fb   Bartlomiej Sieka   Use watchdog-awar...
387
  #ifndef CHUNKSZ
559316faf   Marian Balakowicz   [new uImage] Move...
388
  #define CHUNKSZ (64 * 1024)
7590378fb   Bartlomiej Sieka   Use watchdog-awar...
389
390
391
392
393
394
395
396
397
398
399
400
401
  #endif
  
  #ifndef CHUNKSZ_CRC32
  #define CHUNKSZ_CRC32 (64 * 1024)
  #endif
  
  #ifndef CHUNKSZ_MD5
  #define CHUNKSZ_MD5 (64 * 1024)
  #endif
  
  #ifndef CHUNKSZ_SHA1
  #define CHUNKSZ_SHA1 (64 * 1024)
  #endif
559316faf   Marian Balakowicz   [new uImage] Move...
402

375660907   Mike Frysinger   compiler.h: unify...
403
404
  #define uimage_to_cpu(x)		be32_to_cpu(x)
  #define cpu_to_uimage(x)		cpu_to_be32(x)
9a4daad0a   Marian Balakowicz   [new uImage] Upda...
405

b029dddc9   Prafulla Wadaskar   mkimage: Make tab...
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
  /*
   * Translation table for entries of a specific type; used by
   * get_table_entry_id() and get_table_entry_name().
   */
  typedef struct table_entry {
  	int	id;
  	char	*sname;		/* short (input) name to find table entry */
  	char	*lname;		/* long (output) name to print for messages */
  } table_entry_t;
  
  /*
   * get_table_entry_id() scans the translation table trying to find an
   * entry that matches the given short name. If a matching entry is
   * found, it's id is returned to the caller.
   */
7edb186fc   Mike Frysinger   image: constify l...
421
  int get_table_entry_id(const table_entry_t *table,
b029dddc9   Prafulla Wadaskar   mkimage: Make tab...
422
423
424
425
426
427
  		const char *table_name, const char *name);
  /*
   * get_table_entry_name() scans the translation table trying to find
   * an entry that matches the given id. If a matching entry is found,
   * its long name is returned to the caller.
   */
7edb186fc   Mike Frysinger   image: constify l...
428
  char *get_table_entry_name(const table_entry_t *table, char *msg, int id);
b029dddc9   Prafulla Wadaskar   mkimage: Make tab...
429

712fbcf38   Stephen Warren   checkpatch whites...
430
  const char *genimg_get_os_name(uint8_t os);
cef2e5148   Simon Glass   image: Add functi...
431
432
433
434
435
436
437
438
  
  /**
   * genimg_get_os_short_name() - get the short name for an OS
   *
   * @param os	OS (IH_OS_...)
   * @return OS short name, or "unknown" if unknown
   */
  const char *genimg_get_os_short_name(uint8_t comp);
712fbcf38   Stephen Warren   checkpatch whites...
439
  const char *genimg_get_arch_name(uint8_t arch);
cef2e5148   Simon Glass   image: Add functi...
440
441
442
443
444
445
446
447
  
  /**
   * genimg_get_arch_short_name() - get the short name for an architecture
   *
   * @param arch	Architecture type (IH_ARCH_...)
   * @return architecture short name, or "unknown" if unknown
   */
  const char *genimg_get_arch_short_name(uint8_t arch);
712fbcf38   Stephen Warren   checkpatch whites...
448
  const char *genimg_get_type_name(uint8_t type);
5b9d44df2   Simon Glass   mkimage: Display ...
449
450
451
452
453
454
455
456
  
  /**
   * genimg_get_type_short_name() - get the short name for an image type
   *
   * @param type	Image type (IH_TYPE_...)
   * @return image short name, or "unknown" if unknown
   */
  const char *genimg_get_type_short_name(uint8_t type);
712fbcf38   Stephen Warren   checkpatch whites...
457
  const char *genimg_get_comp_name(uint8_t comp);
cef2e5148   Simon Glass   image: Add functi...
458
459
460
461
462
463
464
465
  
  /**
   * genimg_get_comp_short_name() - get the short name for a compression method
   *
   * @param comp	compression method (IH_COMP_...)
   * @return compression method short name, or "unknown" if unknown
   */
  const char *genimg_get_comp_short_name(uint8_t comp);
1426220b0   Simon Glass   image: Add functi...
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
  /**
   * genimg_get_cat_name() - Get the name of an item in a category
   *
   * @category:	Category of item
   * @id:		Item ID
   * @return name of item, or "Unknown ..." if unknown
   */
  const char *genimg_get_cat_name(enum ih_category category, uint id);
  
  /**
   * genimg_get_cat_short_name() - Get the short name of an item in a category
   *
   * @category:	Category of item
   * @id:		Item ID
   * @return short name of item, or "Unknown ..." if unknown
   */
  const char *genimg_get_cat_short_name(enum ih_category category, uint id);
  
  /**
   * genimg_get_cat_count() - Get the number of items in a category
   *
   * @category:	Category to check
   * @return the number of items in the category (IH_xxx_COUNT)
   */
  int genimg_get_cat_count(enum ih_category category);
  
  /**
   * genimg_get_cat_desc() - Get the description of a category
   *
   * @return the description of a category, e.g. "architecture". This
   * effectively converts the enum to a string.
   */
  const char *genimg_get_cat_desc(enum ih_category category);
712fbcf38   Stephen Warren   checkpatch whites...
499
500
501
502
503
  int genimg_get_os_id(const char *name);
  int genimg_get_arch_id(const char *name);
  int genimg_get_type_id(const char *name);
  int genimg_get_comp_id(const char *name);
  void genimg_print_size(uint32_t size);
570abb0ad   Marian Balakowicz   [new uImage] Shar...
504

859e92b77   Simon Glass   image: Move times...
505
506
507
508
509
510
511
  #if defined(CONFIG_TIMESTAMP) || defined(CONFIG_CMD_DATE) || \
  	defined(USE_HOSTCC)
  #define IMAGE_ENABLE_TIMESTAMP 1
  #else
  #define IMAGE_ENABLE_TIMESTAMP 0
  #endif
  void genimg_print_time(time_t timestamp);
782cfbb25   Simon Glass   image: Introduce ...
512
513
514
515
  /* What to do with a image load address ('load = <> 'in the FIT) */
  enum fit_load_op {
  	FIT_LOAD_IGNORED,	/* Ignore load address */
  	FIT_LOAD_OPTIONAL,	/* Can be provided, but optional */
fe20a81a6   Simon Glass   Fix test failure ...
516
  	FIT_LOAD_OPTIONAL_NON_ZERO,	/* Optional, a value of 0 is ignored */
782cfbb25   Simon Glass   image: Introduce ...
517
518
  	FIT_LOAD_REQUIRED,	/* Must be provided */
  };
90268b878   Simon Glass   x86: Support load...
519
520
  int boot_get_setup(bootm_headers_t *images, uint8_t arch, ulong *setup_start,
  		   ulong *setup_len);
9a4daad0a   Marian Balakowicz   [new uImage] Upda...
521
522
523
  #ifndef USE_HOSTCC
  /* Image format types, returned by _get_format() routine */
  #define IMAGE_FORMAT_INVALID	0x00
21d29f7f9   Heiko Schocher   bootm: make use o...
524
  #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
9a4daad0a   Marian Balakowicz   [new uImage] Upda...
525
  #define IMAGE_FORMAT_LEGACY	0x01	/* legacy image_header based format */
21d29f7f9   Heiko Schocher   bootm: make use o...
526
  #endif
9a4daad0a   Marian Balakowicz   [new uImage] Upda...
527
  #define IMAGE_FORMAT_FIT	0x02	/* new, libfdt based format */
9ace3fc81   Sebastian Siewior   image: add suppor...
528
  #define IMAGE_FORMAT_ANDROID	0x03	/* Android boot image */
9a4daad0a   Marian Balakowicz   [new uImage] Upda...
529

6c454fedf   Bryan Wu   image: fix bootm ...
530
531
532
  ulong genimg_get_kernel_addr_fit(char * const img_addr,
  			         const char **fit_uname_config,
  			         const char **fit_uname_kernel);
0f64140b6   Bryan Wu   image: introduce ...
533
  ulong genimg_get_kernel_addr(char * const img_addr);
35e7b0f17   Simon Glass   sandbox: image: A...
534
  int genimg_get_format(const void *img_addr);
712fbcf38   Stephen Warren   checkpatch whites...
535
  int genimg_has_config(bootm_headers_t *images);
9a4daad0a   Marian Balakowicz   [new uImage] Upda...
536

62afc6018   Michal Simek   image: Add boot_g...
537
538
  int boot_get_fpga(int argc, char * const argv[], bootm_headers_t *images,
  		uint8_t arch, const ulong *ld_start, ulong * const ld_len);
712fbcf38   Stephen Warren   checkpatch whites...
539
  int boot_get_ramdisk(int argc, char * const argv[], bootm_headers_t *images,
d985c8498   Marian Balakowicz   [new uImage] Remo...
540
  		uint8_t arch, ulong *rd_start, ulong *rd_end);
84a07dbfd   Karl Apsite   add boot_get_load...
541
542
543
544
545
546
547
548
549
550
551
552
553
  
  /**
   * boot_get_loadable - routine to load a list of binaries to memory
   * @argc: Ignored Argument
   * @argv: Ignored Argument
   * @images: pointer to the bootm images structure
   * @arch: expected architecture for the image
   * @ld_start: Ignored Argument
   * @ld_len: Ignored Argument
   *
   * boot_get_loadable() will take the given FIT configuration, and look
   * for a field named "loadables".  Loadables, is a list of elements in
   * the FIT given as strings.  exe:
b2267e8a2   Andre Przywara   fix incorrect usa...
554
   *   loadables = "linux_kernel", "fdt-2";
84a07dbfd   Karl Apsite   add boot_get_load...
555
556
557
558
559
560
561
562
563
564
565
   * this function will attempt to parse each string, and load the
   * corresponding element from the FIT into memory.  Once placed,
   * no aditional actions are taken.
   *
   * @return:
   *     0, if only valid images or no images are found
   *     error code, if an error occurs during fit_image_load
   */
  int boot_get_loadable(int argc, char * const argv[], bootm_headers_t *images,
  		uint8_t arch, const ulong *ld_start, ulong * const ld_len);
  #endif /* !USE_HOSTCC */
9a4daad0a   Marian Balakowicz   [new uImage] Upda...
566

90268b878   Simon Glass   x86: Support load...
567
568
  int boot_get_setup_fit(bootm_headers_t *images, uint8_t arch,
  		       ulong *setup_start, ulong *setup_len);
782cfbb25   Simon Glass   image: Introduce ...
569
  /**
169043d82   Pantelis Antoniou   fit: Introduce me...
570
571
572
573
574
575
576
577
578
   * boot_get_fdt_fit() - load a DTB from a FIT file (applying overlays)
   *
   * This deals with all aspects of loading an DTB from a FIT.
   * The correct base image based on configuration will be selected, and
   * then any overlays specified will be applied (as present in fit_uname_configp).
   *
   * @param images	Boot images structure
   * @param addr		Address of FIT in memory
   * @param fit_unamep	On entry this is the requested image name
b2267e8a2   Andre Przywara   fix incorrect usa...
579
   *			(e.g. "kernel") or NULL to use the default. On exit
169043d82   Pantelis Antoniou   fit: Introduce me...
580
581
   *			points to the selected image name
   * @param fit_uname_configp	On entry this is the requested configuration
b2267e8a2   Andre Przywara   fix incorrect usa...
582
   *			name (e.g. "conf-1") or NULL to use the default. On
169043d82   Pantelis Antoniou   fit: Introduce me...
583
584
585
586
587
588
589
590
591
592
593
594
   *			exit points to the selected configuration name.
   * @param arch		Expected architecture (IH_ARCH_...)
   * @param datap		Returns address of loaded image
   * @param lenp		Returns length of loaded image
   *
   * @return node offset of base image, or -ve error code on error
   */
  int boot_get_fdt_fit(bootm_headers_t *images, ulong addr,
  		   const char **fit_unamep, const char **fit_uname_configp,
  		   int arch, ulong *datap, ulong *lenp);
  
  /**
782cfbb25   Simon Glass   image: Introduce ...
595
596
597
598
599
600
601
   * fit_image_load() - load an image from a FIT
   *
   * This deals with all aspects of loading an image from a FIT, including
   * selecting the right image based on configuration, verifying it, printing
   * out progress messages, checking the type/arch/os and optionally copying it
   * to the right load address.
   *
126cc8642   Simon Glass   image: Remove the...
602
603
   * The property to look up is defined by image_type.
   *
782cfbb25   Simon Glass   image: Introduce ...
604
   * @param images	Boot images structure
782cfbb25   Simon Glass   image: Introduce ...
605
606
   * @param addr		Address of FIT in memory
   * @param fit_unamep	On entry this is the requested image name
b2267e8a2   Andre Przywara   fix incorrect usa...
607
   *			(e.g. "kernel") or NULL to use the default. On exit
782cfbb25   Simon Glass   image: Introduce ...
608
   *			points to the selected image name
f320a4d84   Simon Glass   bootm: Use select...
609
   * @param fit_uname_configp	On entry this is the requested configuration
b2267e8a2   Andre Przywara   fix incorrect usa...
610
   *			name (e.g. "conf-1") or NULL to use the default. On
f320a4d84   Simon Glass   bootm: Use select...
611
   *			exit points to the selected configuration name.
782cfbb25   Simon Glass   image: Introduce ...
612
613
614
615
616
617
618
619
620
621
   * @param arch		Expected architecture (IH_ARCH_...)
   * @param image_type	Required image type (IH_TYPE_...). If this is
   *			IH_TYPE_KERNEL then we allow IH_TYPE_KERNEL_NOLOAD
   *			also.
   * @param bootstage_id	ID of starting bootstage to use for progress updates.
   *			This will be added to the BOOTSTAGE_SUB values when
   *			calling bootstage_mark()
   * @param load_op	Decribes what to do with the load address
   * @param datap		Returns address of loaded image
   * @param lenp		Returns length of loaded image
ce1400f69   Simon Glass   Enhance fit_check...
622
   * @return node offset of image, or -ve error code on error
782cfbb25   Simon Glass   image: Introduce ...
623
   */
126cc8642   Simon Glass   image: Remove the...
624
  int fit_image_load(bootm_headers_t *images, ulong addr,
f320a4d84   Simon Glass   bootm: Use select...
625
  		   const char **fit_unamep, const char **fit_uname_configp,
782cfbb25   Simon Glass   image: Introduce ...
626
627
  		   int arch, int image_type, int bootstage_id,
  		   enum fit_load_op load_op, ulong *datap, ulong *lenp);
ce1400f69   Simon Glass   Enhance fit_check...
628
  #ifndef USE_HOSTCC
782cfbb25   Simon Glass   image: Introduce ...
629
630
631
  /**
   * fit_get_node_from_config() - Look up an image a FIT by type
   *
b2267e8a2   Andre Przywara   fix incorrect usa...
632
   * This looks in the selected conf- node (images->fit_uname_cfg) for a
782cfbb25   Simon Glass   image: Introduce ...
633
634
635
636
637
638
   * particular image type (e.g. "kernel") and then finds the image that is
   * referred to.
   *
   * For example, for something like:
   *
   * images {
b2267e8a2   Andre Przywara   fix incorrect usa...
639
   *	kernel {
782cfbb25   Simon Glass   image: Introduce ...
640
641
642
643
   *		...
   *	};
   * };
   * configurations {
b2267e8a2   Andre Przywara   fix incorrect usa...
644
645
   *	conf-1 {
   *		kernel = "kernel";
782cfbb25   Simon Glass   image: Introduce ...
646
647
648
649
   *	};
   * };
   *
   * the function will return the node offset of the kernel@1 node, assuming
b2267e8a2   Andre Przywara   fix incorrect usa...
650
   * that conf-1 is the chosen configuration.
782cfbb25   Simon Glass   image: Introduce ...
651
652
653
654
655
656
657
   *
   * @param images	Boot images structure
   * @param prop_name	Property name to look up (FIT_..._PROP)
   * @param addr		Address of FIT in memory
   */
  int fit_get_node_from_config(bootm_headers_t *images, const char *prop_name,
  			ulong addr);
53f375fa8   Simon Glass   image: Use fit_im...
658
659
660
  int boot_get_fdt(int flag, int argc, char * const argv[], uint8_t arch,
  		 bootm_headers_t *images,
  		 char **of_flat_tree, ulong *of_size);
55b0a3931   Grant Likely   Respect memreserv...
661
  void boot_fdt_add_mem_rsv_regions(struct lmb *lmb, void *fdt_blob);
712fbcf38   Stephen Warren   checkpatch whites...
662
  int boot_relocate_fdt(struct lmb *lmb, char **of_flat_tree, ulong *of_size);
06a09918f   Kumar Gala   bootm: refactor f...
663

712fbcf38   Stephen Warren   checkpatch whites...
664
  int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len,
9a4daad0a   Marian Balakowicz   [new uImage] Upda...
665
  		  ulong *initrd_start, ulong *initrd_end);
712fbcf38   Stephen Warren   checkpatch whites...
666
  int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end);
fca43cc80   John Rigby   boot: change some...
667
  #ifdef CONFIG_SYS_BOOT_GET_KBD
712fbcf38   Stephen Warren   checkpatch whites...
668
  int boot_get_kbd(struct lmb *lmb, bd_t **kbd);
fca43cc80   John Rigby   boot: change some...
669
  #endif /* CONFIG_SYS_BOOT_GET_KBD */
570abb0ad   Marian Balakowicz   [new uImage] Shar...
670
  #endif /* !USE_HOSTCC */
b97a2a0a2   Marian Balakowicz   [new uImage] Defi...
671

9a4daad0a   Marian Balakowicz   [new uImage] Upda...
672
673
674
  /*******************************************************************/
  /* Legacy format specific code (prefixed with image_) */
  /*******************************************************************/
712fbcf38   Stephen Warren   checkpatch whites...
675
  static inline uint32_t image_get_header_size(void)
b97a2a0a2   Marian Balakowicz   [new uImage] Defi...
676
  {
712fbcf38   Stephen Warren   checkpatch whites...
677
  	return (sizeof(image_header_t));
b97a2a0a2   Marian Balakowicz   [new uImage] Defi...
678
679
680
  }
  
  #define image_get_hdr_l(f) \
3a2003f61   Wolfgang Denk   tools/mkimage: fi...
681
  	static inline uint32_t image_get_##f(const image_header_t *hdr) \
b97a2a0a2   Marian Balakowicz   [new uImage] Defi...
682
  	{ \
712fbcf38   Stephen Warren   checkpatch whites...
683
  		return uimage_to_cpu(hdr->ih_##f); \
b97a2a0a2   Marian Balakowicz   [new uImage] Defi...
684
  	}
712fbcf38   Stephen Warren   checkpatch whites...
685
686
687
688
689
690
691
  image_get_hdr_l(magic)		/* image_get_magic */
  image_get_hdr_l(hcrc)		/* image_get_hcrc */
  image_get_hdr_l(time)		/* image_get_time */
  image_get_hdr_l(size)		/* image_get_size */
  image_get_hdr_l(load)		/* image_get_load */
  image_get_hdr_l(ep)		/* image_get_ep */
  image_get_hdr_l(dcrc)		/* image_get_dcrc */
b97a2a0a2   Marian Balakowicz   [new uImage] Defi...
692
693
  
  #define image_get_hdr_b(f) \
3a2003f61   Wolfgang Denk   tools/mkimage: fi...
694
  	static inline uint8_t image_get_##f(const image_header_t *hdr) \
b97a2a0a2   Marian Balakowicz   [new uImage] Defi...
695
696
697
  	{ \
  		return hdr->ih_##f; \
  	}
712fbcf38   Stephen Warren   checkpatch whites...
698
699
700
701
  image_get_hdr_b(os)		/* image_get_os */
  image_get_hdr_b(arch)		/* image_get_arch */
  image_get_hdr_b(type)		/* image_get_type */
  image_get_hdr_b(comp)		/* image_get_comp */
b97a2a0a2   Marian Balakowicz   [new uImage] Defi...
702

712fbcf38   Stephen Warren   checkpatch whites...
703
  static inline char *image_get_name(const image_header_t *hdr)
b97a2a0a2   Marian Balakowicz   [new uImage] Defi...
704
705
706
  {
  	return (char *)hdr->ih_name;
  }
712fbcf38   Stephen Warren   checkpatch whites...
707
  static inline uint32_t image_get_data_size(const image_header_t *hdr)
b97a2a0a2   Marian Balakowicz   [new uImage] Defi...
708
  {
712fbcf38   Stephen Warren   checkpatch whites...
709
  	return image_get_size(hdr);
b97a2a0a2   Marian Balakowicz   [new uImage] Defi...
710
  }
f13e7b2e9   Marian Balakowicz   [new uImage] Clea...
711
712
713
714
715
716
717
718
719
720
721
722
  
  /**
   * image_get_data - get image payload start address
   * @hdr: image header
   *
   * image_get_data() returns address of the image payload. For single
   * component images it is image data start. For multi component
   * images it points to the null terminated table of sub-images sizes.
   *
   * returns:
   *     image payload data start address
   */
712fbcf38   Stephen Warren   checkpatch whites...
723
  static inline ulong image_get_data(const image_header_t *hdr)
f13e7b2e9   Marian Balakowicz   [new uImage] Clea...
724
  {
712fbcf38   Stephen Warren   checkpatch whites...
725
  	return ((ulong)hdr + image_get_header_size());
f13e7b2e9   Marian Balakowicz   [new uImage] Clea...
726
  }
712fbcf38   Stephen Warren   checkpatch whites...
727
  static inline uint32_t image_get_image_size(const image_header_t *hdr)
b97a2a0a2   Marian Balakowicz   [new uImage] Defi...
728
  {
712fbcf38   Stephen Warren   checkpatch whites...
729
  	return (image_get_size(hdr) + image_get_header_size());
b97a2a0a2   Marian Balakowicz   [new uImage] Defi...
730
  }
712fbcf38   Stephen Warren   checkpatch whites...
731
  static inline ulong image_get_image_end(const image_header_t *hdr)
b97a2a0a2   Marian Balakowicz   [new uImage] Defi...
732
  {
712fbcf38   Stephen Warren   checkpatch whites...
733
  	return ((ulong)hdr + image_get_image_size(hdr));
b97a2a0a2   Marian Balakowicz   [new uImage] Defi...
734
735
736
737
738
  }
  
  #define image_set_hdr_l(f) \
  	static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
  	{ \
712fbcf38   Stephen Warren   checkpatch whites...
739
  		hdr->ih_##f = cpu_to_uimage(val); \
b97a2a0a2   Marian Balakowicz   [new uImage] Defi...
740
  	}
712fbcf38   Stephen Warren   checkpatch whites...
741
742
743
744
745
746
747
  image_set_hdr_l(magic)		/* image_set_magic */
  image_set_hdr_l(hcrc)		/* image_set_hcrc */
  image_set_hdr_l(time)		/* image_set_time */
  image_set_hdr_l(size)		/* image_set_size */
  image_set_hdr_l(load)		/* image_set_load */
  image_set_hdr_l(ep)		/* image_set_ep */
  image_set_hdr_l(dcrc)		/* image_set_dcrc */
b97a2a0a2   Marian Balakowicz   [new uImage] Defi...
748
749
750
751
752
753
  
  #define image_set_hdr_b(f) \
  	static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
  	{ \
  		hdr->ih_##f = val; \
  	}
712fbcf38   Stephen Warren   checkpatch whites...
754
755
756
757
  image_set_hdr_b(os)		/* image_set_os */
  image_set_hdr_b(arch)		/* image_set_arch */
  image_set_hdr_b(type)		/* image_set_type */
  image_set_hdr_b(comp)		/* image_set_comp */
b97a2a0a2   Marian Balakowicz   [new uImage] Defi...
758

712fbcf38   Stephen Warren   checkpatch whites...
759
  static inline void image_set_name(image_header_t *hdr, const char *name)
b97a2a0a2   Marian Balakowicz   [new uImage] Defi...
760
  {
712fbcf38   Stephen Warren   checkpatch whites...
761
  	strncpy(image_get_name(hdr), name, IH_NMLEN);
b97a2a0a2   Marian Balakowicz   [new uImage] Defi...
762
  }
712fbcf38   Stephen Warren   checkpatch whites...
763
764
  int image_check_hcrc(const image_header_t *hdr);
  int image_check_dcrc(const image_header_t *hdr);
af13cdbc0   Marian Balakowicz   [new uImage] Add ...
765
  #ifndef USE_HOSTCC
723806cc5   Simon Glass   env: Rename some ...
766
767
768
  ulong env_get_bootm_low(void);
  phys_size_t env_get_bootm_size(void);
  phys_size_t env_get_bootm_mapsize(void);
af13cdbc0   Marian Balakowicz   [new uImage] Add ...
769
  #endif
ce1400f69   Simon Glass   Enhance fit_check...
770
  void memmove_wd(void *to, void *from, size_t len, ulong chunksz);
b97a2a0a2   Marian Balakowicz   [new uImage] Defi...
771

712fbcf38   Stephen Warren   checkpatch whites...
772
  static inline int image_check_magic(const image_header_t *hdr)
b97a2a0a2   Marian Balakowicz   [new uImage] Defi...
773
  {
712fbcf38   Stephen Warren   checkpatch whites...
774
  	return (image_get_magic(hdr) == IH_MAGIC);
b97a2a0a2   Marian Balakowicz   [new uImage] Defi...
775
  }
712fbcf38   Stephen Warren   checkpatch whites...
776
  static inline int image_check_type(const image_header_t *hdr, uint8_t type)
b97a2a0a2   Marian Balakowicz   [new uImage] Defi...
777
  {
712fbcf38   Stephen Warren   checkpatch whites...
778
  	return (image_get_type(hdr) == type);
b97a2a0a2   Marian Balakowicz   [new uImage] Defi...
779
  }
712fbcf38   Stephen Warren   checkpatch whites...
780
  static inline int image_check_arch(const image_header_t *hdr, uint8_t arch)
b97a2a0a2   Marian Balakowicz   [new uImage] Defi...
781
  {
4ac0a32e2   Alison Wang   armv8: Support lo...
782
783
  	return (image_get_arch(hdr) == arch) ||
  		(image_get_arch(hdr) == IH_ARCH_ARM && arch == IH_ARCH_ARM64);
b97a2a0a2   Marian Balakowicz   [new uImage] Defi...
784
  }
712fbcf38   Stephen Warren   checkpatch whites...
785
  static inline int image_check_os(const image_header_t *hdr, uint8_t os)
b97a2a0a2   Marian Balakowicz   [new uImage] Defi...
786
  {
712fbcf38   Stephen Warren   checkpatch whites...
787
  	return (image_get_os(hdr) == os);
b97a2a0a2   Marian Balakowicz   [new uImage] Defi...
788
  }
712fbcf38   Stephen Warren   checkpatch whites...
789
790
  ulong image_multi_count(const image_header_t *hdr);
  void image_multi_getimg(const image_header_t *hdr, ulong idx,
42b73e8ee   Marian Balakowicz   [new uImage] Fact...
791
  			ulong *data, ulong *len);
712fbcf38   Stephen Warren   checkpatch whites...
792
  void image_print_contents(const void *hdr);
570abb0ad   Marian Balakowicz   [new uImage] Shar...
793

b97a2a0a2   Marian Balakowicz   [new uImage] Defi...
794
  #ifndef USE_HOSTCC
712fbcf38   Stephen Warren   checkpatch whites...
795
  static inline int image_check_target_arch(const image_header_t *hdr)
b97a2a0a2   Marian Balakowicz   [new uImage] Defi...
796
  {
476af299b   Mike Frysinger   image: push defau...
797
798
  #ifndef IH_ARCH_DEFAULT
  # error "please define IH_ARCH_DEFAULT in your arch asm/u-boot.h"
b97a2a0a2   Marian Balakowicz   [new uImage] Defi...
799
  #endif
476af299b   Mike Frysinger   image: push defau...
800
  	return image_check_arch(hdr, IH_ARCH_DEFAULT);
b97a2a0a2   Marian Balakowicz   [new uImage] Defi...
801
  }
5dfb52138   Marian Balakowicz   [new uImage] New ...
802
  #endif /* USE_HOSTCC */
5b1d71372   wdenk   Initial revision
803

13d06981a   Simon Glass   image: Add device...
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
  /**
   * Set up properties in the FDT
   *
   * This sets up properties in the FDT that is to be passed to linux.
   *
   * @images:	Images information
   * @blob:	FDT to update
   * @of_size:	Size of the FDT
   * @lmb:	Points to logical memory block structure
   * @return 0 if ok, <0 on failure
   */
  int image_setup_libfdt(bootm_headers_t *images, void *blob,
  		       int of_size, struct lmb *lmb);
  
  /**
   * Set up the FDT to use for booting a kernel
   *
   * This performs ramdisk setup, sets up the FDT if required, and adds
   * paramters to the FDT if libfdt is available.
   *
   * @param images	Images information
   * @return 0 if ok, <0 on failure
   */
  int image_setup_linux(bootm_headers_t *images);
a5266d6b5   Simon Glass   bootm: Clean up b...
828
829
830
831
832
833
834
835
836
  /**
   * bootz_setup() - Extract stat and size of a Linux xImage
   *
   * @image: Address of image
   * @start: Returns start address of image
   * @end : Returns end address of image
   * @return 0 if OK, 1 if the image was not recognised
   */
  int bootz_setup(ulong image, ulong *start, ulong *end);
6808ef9ac   Bin Chen   move booti_setup ...
837
838
839
840
841
842
843
844
845
  /**
   * Return the correct start address and size of a Linux aarch64 Image.
   *
   * @image: Address of image
   * @start: Returns start address of image
   * @size : Returns size image
   * @return 0 if OK, 1 if the image was not recognised
   */
  int booti_setup(ulong image, ulong *relocated_addr, ulong *size);
a5266d6b5   Simon Glass   bootm: Clean up b...
846

d5934ad77   Marian Balakowicz   [new uImage] Add ...
847
  /*******************************************************************/
9a4daad0a   Marian Balakowicz   [new uImage] Upda...
848
  /* New uImage format specific code (prefixed with fit_) */
d5934ad77   Marian Balakowicz   [new uImage] Add ...
849
  /*******************************************************************/
5dfb52138   Marian Balakowicz   [new uImage] New ...
850
851
852
  
  #define FIT_IMAGES_PATH		"/images"
  #define FIT_CONFS_PATH		"/configurations"
3e569a6b1   Simon Glass   image: Add signin...
853
  /* hash/signature node */
5dfb52138   Marian Balakowicz   [new uImage] New ...
854
855
856
  #define FIT_HASH_NODENAME	"hash"
  #define FIT_ALGO_PROP		"algo"
  #define FIT_VALUE_PROP		"value"
8ac88f2d2   Joe Hershberger   fdt: Check for a ...
857
  #define FIT_IGNORE_PROP		"uboot-ignore"
3e569a6b1   Simon Glass   image: Add signin...
858
  #define FIT_SIG_NODENAME	"signature"
5dfb52138   Marian Balakowicz   [new uImage] New ...
859
860
861
  
  /* image node */
  #define FIT_DATA_PROP		"data"
a1be94b65   Peng Fan   SPL: Add FIT data...
862
  #define FIT_DATA_POSITION_PROP	"data-position"
db1b79b88   tomas.melin@vaisala.com   splash: add suppo...
863
864
  #define FIT_DATA_OFFSET_PROP	"data-offset"
  #define FIT_DATA_SIZE_PROP	"data-size"
5dfb52138   Marian Balakowicz   [new uImage] New ...
865
866
867
868
869
870
871
872
873
874
875
876
877
  #define FIT_TIMESTAMP_PROP	"timestamp"
  #define FIT_DESC_PROP		"description"
  #define FIT_ARCH_PROP		"arch"
  #define FIT_TYPE_PROP		"type"
  #define FIT_OS_PROP		"os"
  #define FIT_COMP_PROP		"compression"
  #define FIT_ENTRY_PROP		"entry"
  #define FIT_LOAD_PROP		"load"
  
  /* configuration node */
  #define FIT_KERNEL_PROP		"kernel"
  #define FIT_RAMDISK_PROP	"ramdisk"
  #define FIT_FDT_PROP		"fdt"
ecf8cd653   Karl Apsite   mkimage will now ...
878
  #define FIT_LOADABLE_PROP	"loadables"
5dfb52138   Marian Balakowicz   [new uImage] New ...
879
  #define FIT_DEFAULT_PROP	"default"
90268b878   Simon Glass   x86: Support load...
880
  #define FIT_SETUP_PROP		"setup"
ed0cea7c5   Michal Simek   mkimage: Report i...
881
  #define FIT_FPGA_PROP		"fpga"
5dfb52138   Marian Balakowicz   [new uImage] New ...
882

1de7bb4f2   Michael van der Westhuizen   Prevent a buffer ...
883
  #define FIT_MAX_HASH_LEN	HASH_MAX_DIGEST_SIZE
5dfb52138   Marian Balakowicz   [new uImage] New ...
884

f1dcee59a   Simon Glass   spl: Add an optio...
885
  #if IMAGE_ENABLE_FIT
5dfb52138   Marian Balakowicz   [new uImage] New ...
886
  /* cmdline argument format parsing */
314f634b4   Mike Frysinger   image/fit: drop i...
887
  int fit_parse_conf(const char *spec, ulong addr_curr,
f50433d67   Marian Balakowicz   [new uImage] Add ...
888
  		ulong *addr, const char **conf_name);
314f634b4   Mike Frysinger   image/fit: drop i...
889
  int fit_parse_subimage(const char *spec, ulong addr_curr,
f50433d67   Marian Balakowicz   [new uImage] Add ...
890
  		ulong *addr, const char **image_name);
d5934ad77   Marian Balakowicz   [new uImage] Add ...
891

39931f966   Guilherme Maciel Ferreira   dumpimage: fit: e...
892
  int fit_get_subimage_count(const void *fit, int images_noffset);
712fbcf38   Stephen Warren   checkpatch whites...
893
894
  void fit_print_contents(const void *fit);
  void fit_image_print(const void *fit, int noffset, const char *p);
5dfb52138   Marian Balakowicz   [new uImage] New ...
895
896
897
898
899
900
901
902
  
  /**
   * fit_get_end - get FIT image size
   * @fit: pointer to the FIT format image header
   *
   * returns:
   *     size of the FIT image (blob) in memory
   */
712fbcf38   Stephen Warren   checkpatch whites...
903
  static inline ulong fit_get_size(const void *fit)
5dfb52138   Marian Balakowicz   [new uImage] New ...
904
  {
712fbcf38   Stephen Warren   checkpatch whites...
905
  	return fdt_totalsize(fit);
5dfb52138   Marian Balakowicz   [new uImage] New ...
906
907
908
909
910
911
912
913
914
  }
  
  /**
   * fit_get_end - get FIT image end
   * @fit: pointer to the FIT format image header
   *
   * returns:
   *     end address of the FIT image (blob) in memory
   */
7a80de464   Simon Glass   image: Correct th...
915
  ulong fit_get_end(const void *fit);
5dfb52138   Marian Balakowicz   [new uImage] New ...
916
917
918
919
920
921
922
923
924
  
  /**
   * fit_get_name - get FIT node name
   * @fit: pointer to the FIT format image header
   *
   * returns:
   *     NULL, on error
   *     pointer to node name, on success
   */
712fbcf38   Stephen Warren   checkpatch whites...
925
  static inline const char *fit_get_name(const void *fit_hdr,
5dfb52138   Marian Balakowicz   [new uImage] New ...
926
927
  		int noffset, int *len)
  {
712fbcf38   Stephen Warren   checkpatch whites...
928
  	return fdt_get_name(fit_hdr, noffset, len);
5dfb52138   Marian Balakowicz   [new uImage] New ...
929
  }
712fbcf38   Stephen Warren   checkpatch whites...
930
931
932
933
934
935
936
937
938
939
940
  int fit_get_desc(const void *fit, int noffset, char **desc);
  int fit_get_timestamp(const void *fit, int noffset, time_t *timestamp);
  
  int fit_image_get_node(const void *fit, const char *image_uname);
  int fit_image_get_os(const void *fit, int noffset, uint8_t *os);
  int fit_image_get_arch(const void *fit, int noffset, uint8_t *arch);
  int fit_image_get_type(const void *fit, int noffset, uint8_t *type);
  int fit_image_get_comp(const void *fit, int noffset, uint8_t *comp);
  int fit_image_get_load(const void *fit, int noffset, ulong *load);
  int fit_image_get_entry(const void *fit, int noffset, ulong *entry);
  int fit_image_get_data(const void *fit, int noffset,
5dfb52138   Marian Balakowicz   [new uImage] New ...
941
  				const void **data, size_t *size);
db1b79b88   tomas.melin@vaisala.com   splash: add suppo...
942
  int fit_image_get_data_offset(const void *fit, int noffset, int *data_offset);
a1be94b65   Peng Fan   SPL: Add FIT data...
943
944
  int fit_image_get_data_position(const void *fit, int noffset,
  				int *data_position);
db1b79b88   tomas.melin@vaisala.com   splash: add suppo...
945
  int fit_image_get_data_size(const void *fit, int noffset, int *data_size);
5dfb52138   Marian Balakowicz   [new uImage] New ...
946

712fbcf38   Stephen Warren   checkpatch whites...
947
948
  int fit_image_hash_get_algo(const void *fit, int noffset, char **algo);
  int fit_image_hash_get_value(const void *fit, int noffset, uint8_t **value,
5dfb52138   Marian Balakowicz   [new uImage] New ...
949
  				int *value_len);
712fbcf38   Stephen Warren   checkpatch whites...
950
  int fit_set_timestamp(void *fit, int noffset, time_t timestamp);
bbb467dc3   Simon Glass   image: Rename fit...
951
952
  
  /**
56518e710   Simon Glass   image: Support si...
953
   * fit_add_verification_data() - add verification data to FIT image nodes
bbb467dc3   Simon Glass   image: Rename fit...
954
   *
56518e710   Simon Glass   image: Support si...
955
956
957
958
959
   * @keydir:	Directory containing keys
   * @kwydest:	FDT blob to write public key information to
   * @fit:	Pointer to the FIT format image header
   * @comment:	Comment to add to signature nodes
   * @require_keys: Mark all keys as 'required'
f1ca1fdeb   George McCollister   mkimage: Add supp...
960
   * @engine_id:	Engine to use for signing
56518e710   Simon Glass   image: Support si...
961
962
963
964
965
966
967
968
969
970
   *
   * Adds hash values for all component images in the FIT blob.
   * Hashes are calculated for all component images which have hash subnodes
   * with algorithm property set to one of the supported hash algorithms.
   *
   * Also add signatures if signature nodes are present.
   *
   * returns
   *     0, on success
   *     libfdt error code, on failure
bbb467dc3   Simon Glass   image: Rename fit...
971
   */
56518e710   Simon Glass   image: Support si...
972
  int fit_add_verification_data(const char *keydir, void *keydest, void *fit,
f1ca1fdeb   George McCollister   mkimage: Add supp...
973
974
  			      const char *comment, int require_keys,
  			      const char *engine_id);
5dfb52138   Marian Balakowicz   [new uImage] New ...
975

b8da83665   Simon Glass   image: Rename fit...
976
  int fit_image_verify(const void *fit, int noffset);
782cfbb25   Simon Glass   image: Introduce ...
977
  int fit_config_verify(const void *fit, int conf_noffset);
b8da83665   Simon Glass   image: Rename fit...
978
  int fit_all_image_verify(const void *fit);
712fbcf38   Stephen Warren   checkpatch whites...
979
980
981
982
983
  int fit_image_check_os(const void *fit, int noffset, uint8_t os);
  int fit_image_check_arch(const void *fit, int noffset, uint8_t arch);
  int fit_image_check_type(const void *fit, int noffset, uint8_t type);
  int fit_image_check_comp(const void *fit, int noffset, uint8_t comp);
  int fit_check_format(const void *fit);
5dfb52138   Marian Balakowicz   [new uImage] New ...
984

d95f6ec73   Gabe Black   fdt: Add option t...
985
  int fit_conf_find_compat(const void *fit, const void *fdt);
712fbcf38   Stephen Warren   checkpatch whites...
986
  int fit_conf_get_node(const void *fit, const char *conf_uname);
5dfb52138   Marian Balakowicz   [new uImage] New ...
987

003efd7da   Simon Glass   image: Export fit...
988
989
990
991
992
993
  /**
   * fit_conf_get_prop_node() - Get node refered to by a configuration
   * @fit:	FIT to check
   * @noffset:	Offset of conf@xxx node to check
   * @prop_name:	Property to read from the conf node
   *
b2267e8a2   Andre Przywara   fix incorrect usa...
994
995
   * The conf- nodes contain references to other nodes, using properties
   * like 'kernel = "kernel"'. Given such a property name (e.g. "kernel"),
003efd7da   Simon Glass   image: Export fit...
996
   * return the offset of the node referred to (e.g. offset of node
b2267e8a2   Andre Przywara   fix incorrect usa...
997
   * "/images/kernel".
003efd7da   Simon Glass   image: Export fit...
998
999
1000
   */
  int fit_conf_get_prop_node(const void *fit, int noffset,
  		const char *prop_name);
712fbcf38   Stephen Warren   checkpatch whites...
1001
  void fit_conf_print(const void *fit, int noffset, const char *p);
5dfb52138   Marian Balakowicz   [new uImage] New ...
1002

61a439a87   Simon Glass   image: Export fit...
1003
1004
  int fit_check_ramdisk(const void *fit, int os_noffset,
  		uint8_t arch, int verify);
604f23dde   Simon Glass   image: Move HOSTC...
1005
1006
  int calculate_hash(const void *data, int data_len, const char *algo,
  			uint8_t *value, int *value_len);
782cfbb25   Simon Glass   image: Introduce ...
1007
  /*
3e569a6b1   Simon Glass   image: Add signin...
1008
1009
   * At present we only support signing on the host, and verification on the
   * device
782cfbb25   Simon Glass   image: Introduce ...
1010
1011
1012
   */
  #if defined(CONFIG_FIT_SIGNATURE)
  # ifdef USE_HOSTCC
3e569a6b1   Simon Glass   image: Add signin...
1013
  #  define IMAGE_ENABLE_SIGN	1
29a23f9d6   Heiko Schocher   tools, fit_check_...
1014
  #  define IMAGE_ENABLE_VERIFY	1
646257d1f   Heiko Schocher   rsa: add sha256-r...
1015
  # include  <openssl/evp.h>
782cfbb25   Simon Glass   image: Introduce ...
1016
  #else
3e569a6b1   Simon Glass   image: Add signin...
1017
  #  define IMAGE_ENABLE_SIGN	0
782cfbb25   Simon Glass   image: Introduce ...
1018
1019
1020
  #  define IMAGE_ENABLE_VERIFY	1
  # endif
  #else
3e569a6b1   Simon Glass   image: Add signin...
1021
  # define IMAGE_ENABLE_SIGN	0
782cfbb25   Simon Glass   image: Introduce ...
1022
1023
1024
1025
  # define IMAGE_ENABLE_VERIFY	0
  #endif
  
  #ifdef USE_HOSTCC
29a23f9d6   Heiko Schocher   tools, fit_check_...
1026
1027
1028
  void *image_get_host_blob(void);
  void image_set_host_blob(void *host_blob);
  # define gd_fdt_blob()		image_get_host_blob()
782cfbb25   Simon Glass   image: Introduce ...
1029
1030
1031
1032
1033
1034
1035
1036
1037
  #else
  # define gd_fdt_blob()		(gd->fdt_blob)
  #endif
  
  #ifdef CONFIG_FIT_BEST_MATCH
  #define IMAGE_ENABLE_BEST_MATCH	1
  #else
  #define IMAGE_ENABLE_BEST_MATCH	0
  #endif
3e569a6b1   Simon Glass   image: Add signin...
1038
1039
1040
1041
1042
1043
  /* Information passed to the signing routines */
  struct image_sign_info {
  	const char *keydir;		/* Directory conaining keys */
  	const char *keyname;		/* Name of key to use */
  	void *fit;			/* Pointer to FIT blob */
  	int node_offset;		/* Offset of signature node */
83dd98e01   Andrew Duda   image: Combine im...
1044
1045
1046
  	const char *name;		/* Algorithm name */
  	struct checksum_algo *checksum;	/* Checksum algorithm information */
  	struct crypto_algo *crypto;	/* Crypto algorithm information */
3e569a6b1   Simon Glass   image: Add signin...
1047
1048
1049
  	const void *fdt_blob;		/* FDT containing public keys */
  	int required_keynode;		/* Node offset of key to use: -1=any */
  	const char *require_keys;	/* Value for 'required' property */
f1ca1fdeb   George McCollister   mkimage: Add supp...
1050
  	const char *engine_id;		/* Engine to use for signing */
3e569a6b1   Simon Glass   image: Add signin...
1051
  };
73223f0e1   Simon Glass   Kconfig: Move CON...
1052
  #endif /* Allow struct image_region to always be defined for rsa.h */
3e569a6b1   Simon Glass   image: Add signin...
1053
1054
1055
1056
1057
1058
  
  /* A part of an image, used for hashing */
  struct image_region {
  	const void *data;
  	int size;
  };
73223f0e1   Simon Glass   Kconfig: Move CON...
1059
  #if IMAGE_ENABLE_FIT
646257d1f   Heiko Schocher   rsa: add sha256-r...
1060
  #if IMAGE_ENABLE_VERIFY
2b9912e6a   Jeroen Hofstee   includes: move op...
1061
  # include <u-boot/rsa-checksum.h>
646257d1f   Heiko Schocher   rsa: add sha256-r...
1062
1063
1064
1065
  #endif
  struct checksum_algo {
  	const char *name;
  	const int checksum_len;
da29f2991   Andrew Duda   rsa: Verify RSA p...
1066
1067
  	const int der_len;
  	const uint8_t *der_prefix;
646257d1f   Heiko Schocher   rsa: add sha256-r...
1068
  #if IMAGE_ENABLE_SIGN
29a23f9d6   Heiko Schocher   tools, fit_check_...
1069
1070
  	const EVP_MD *(*calculate_sign)(void);
  #endif
b37b46f04   Ruchika Gupta   rsa: Use checksum...
1071
1072
1073
  	int (*calculate)(const char *name,
  			 const struct image_region region[],
  			 int region_count, uint8_t *checksum);
646257d1f   Heiko Schocher   rsa: add sha256-r...
1074
  };
0c1d74fda   Andrew Duda   image: Add crypto...
1075
  struct crypto_algo {
3e569a6b1   Simon Glass   image: Add signin...
1076
  	const char *name;		/* Name of algorithm */
0c1d74fda   Andrew Duda   image: Add crypto...
1077
  	const int key_len;
3e569a6b1   Simon Glass   image: Add signin...
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
  
  	/**
  	 * sign() - calculate and return signature for given input data
  	 *
  	 * @info:	Specifies key and FIT information
  	 * @data:	Pointer to the input data
  	 * @data_len:	Data length
  	 * @sigp:	Set to an allocated buffer holding the signature
  	 * @sig_len:	Set to length of the calculated hash
  	 *
  	 * This computes input data signature according to selected algorithm.
  	 * Resulting signature value is placed in an allocated buffer, the
  	 * pointer is returned as *sigp. The length of the calculated
  	 * signature is returned via the sig_len pointer argument. The caller
  	 * should free *sigp.
  	 *
  	 * @return: 0, on success, -ve on error
  	 */
  	int (*sign)(struct image_sign_info *info,
  		    const struct image_region region[],
  		    int region_count, uint8_t **sigp, uint *sig_len);
  
  	/**
  	 * add_verify_data() - Add verification information to FDT
  	 *
  	 * Add public key information to the FDT node, suitable for
  	 * verification at run-time. The information added depends on the
  	 * algorithm being used.
  	 *
  	 * @info:	Specifies key and FIT information
  	 * @keydest:	Destination FDT blob for public key data
  	 * @return: 0, on success, -ve on error
  	 */
  	int (*add_verify_data)(struct image_sign_info *info, void *keydest);
  
  	/**
  	 * verify() - Verify a signature against some data
  	 *
  	 * @info:	Specifies key and FIT information
  	 * @data:	Pointer to the input data
  	 * @data_len:	Data length
  	 * @sig:	Signature
  	 * @sig_len:	Number of bytes in signature
  	 * @return 0 if verified, -ve on error
  	 */
  	int (*verify)(struct image_sign_info *info,
  		      const struct image_region region[], int region_count,
  		      uint8_t *sig, uint sig_len);
0c1d74fda   Andrew Duda   image: Add crypto...
1126
  };
646257d1f   Heiko Schocher   rsa: add sha256-r...
1127

83dd98e01   Andrew Duda   image: Combine im...
1128
1129
1130
1131
1132
1133
1134
  /**
   * image_get_checksum_algo() - Look up a checksum algorithm
   *
   * @param full_name	Name of algorithm in the form "checksum,crypto"
   * @return pointer to algorithm information, or NULL if not found
   */
  struct checksum_algo *image_get_checksum_algo(const char *full_name);
3e569a6b1   Simon Glass   image: Add signin...
1135
1136
  
  /**
83dd98e01   Andrew Duda   image: Combine im...
1137
   * image_get_crypto_algo() - Look up a cryptosystem algorithm
3e569a6b1   Simon Glass   image: Add signin...
1138
   *
83dd98e01   Andrew Duda   image: Combine im...
1139
   * @param full_name	Name of algorithm in the form "checksum,crypto"
3e569a6b1   Simon Glass   image: Add signin...
1140
1141
   * @return pointer to algorithm information, or NULL if not found
   */
83dd98e01   Andrew Duda   image: Combine im...
1142
  struct crypto_algo *image_get_crypto_algo(const char *full_name);
3e569a6b1   Simon Glass   image: Add signin...
1143

56518e710   Simon Glass   image: Support si...
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
  /**
   * fit_image_verify_required_sigs() - Verify signatures marked as 'required'
   *
   * @fit:		FIT to check
   * @image_noffset:	Offset of image node to check
   * @data:		Image data to check
   * @size:		Size of image data
   * @sig_blob:		FDT containing public keys
   * @no_sigsp:		Returns 1 if no signatures were required, and
   *			therefore nothing was checked. The caller may wish
   *			to fall back to other mechanisms, or refuse to
   *			boot.
   * @return 0 if all verified ok, <0 on error
   */
  int fit_image_verify_required_sigs(const void *fit, int image_noffset,
  		const char *data, size_t size, const void *sig_blob,
  		int *no_sigsp);
  
  /**
   * fit_image_check_sig() - Check a single image signature node
   *
   * @fit:		FIT to check
   * @noffset:		Offset of signature node to check
   * @data:		Image data to check
   * @size:		Size of image data
   * @required_keynode:	Offset in the control FDT of the required key node,
   *			if any. If this is given, then the image wil not
   *			pass verification unless that key is used. If this is
   *			-1 then any signature will do.
   * @err_msgp:		In the event of an error, this will be pointed to a
   *			help error string to display to the user.
   * @return 0 if all verified ok, <0 on error
   */
  int fit_image_check_sig(const void *fit, int noffset, const void *data,
  		size_t size, int required_keynode, char **err_msgp);
4d0985295   Simon Glass   image: Add suppor...
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
  /**
   * fit_region_make_list() - Make a list of regions to hash
   *
   * Given a list of FIT regions (offset, size) provided by libfdt, create
   * a list of regions (void *, size) for use by the signature creationg
   * and verification code.
   *
   * @fit:		FIT image to process
   * @fdt_regions:	Regions as returned by libfdt
   * @count:		Number of regions returned by libfdt
   * @region:		Place to put list of regions (NULL to allocate it)
   * @return pointer to list of regions, or NULL if out of memory
   */
  struct image_region *fit_region_make_list(const void *fit,
  		struct fdt_region *fdt_regions, int count,
  		struct image_region *region);
56518e710   Simon Glass   image: Support si...
1195

712fbcf38   Stephen Warren   checkpatch whites...
1196
  static inline int fit_image_check_target_arch(const void *fdt, int node)
5dfb52138   Marian Balakowicz   [new uImage] New ...
1197
  {
29a23f9d6   Heiko Schocher   tools, fit_check_...
1198
  #ifndef USE_HOSTCC
7566832a8   Thierry Reding   image: Fix invert...
1199
  	return fit_image_check_arch(fdt, node, IH_ARCH_DEFAULT);
29a23f9d6   Heiko Schocher   tools, fit_check_...
1200
1201
1202
  #else
  	return 0;
  #endif
5dfb52138   Marian Balakowicz   [new uImage] New ...
1203
  }
5dfb52138   Marian Balakowicz   [new uImage] New ...
1204

d5934ad77   Marian Balakowicz   [new uImage] Add ...
1205
  #ifdef CONFIG_FIT_VERBOSE
712fbcf38   Stephen Warren   checkpatch whites...
1206
  #define fit_unsupported(msg)	printf("! %s:%d " \
d5934ad77   Marian Balakowicz   [new uImage] Add ...
1207
1208
1209
  				"FIT images not supported for '%s'
  ", \
  				__FILE__, __LINE__, (msg))
712fbcf38   Stephen Warren   checkpatch whites...
1210
  #define fit_unsupported_reset(msg)	printf("! %s:%d " \
d5934ad77   Marian Balakowicz   [new uImage] Add ...
1211
1212
1213
1214
1215
1216
1217
1218
  				"FIT images not supported for '%s' " \
  				"- must reset board to recover!
  ", \
  				__FILE__, __LINE__, (msg))
  #else
  #define fit_unsupported(msg)
  #define fit_unsupported_reset(msg)
  #endif /* CONFIG_FIT_VERBOSE */
f50433d67   Marian Balakowicz   [new uImage] Add ...
1219
  #endif /* CONFIG_FIT */
5ad03eb38   Marian Balakowicz   [new uImage] Fact...
1220

9ace3fc81   Sebastian Siewior   image: add suppor...
1221
1222
1223
1224
1225
1226
1227
  #if defined(CONFIG_ANDROID_BOOT_IMAGE)
  struct andr_img_hdr;
  int android_image_check_header(const struct andr_img_hdr *hdr);
  int android_image_get_kernel(const struct andr_img_hdr *hdr, int verify,
  			     ulong *os_data, ulong *os_len);
  int android_image_get_ramdisk(const struct andr_img_hdr *hdr,
  			      ulong *rd_data, ulong *rd_len);
104816142   Bin Chen   parse the second ...
1228
1229
  int android_image_get_second(const struct andr_img_hdr *hdr,
  			      ulong *second_data, ulong *second_len);
9ace3fc81   Sebastian Siewior   image: add suppor...
1230
1231
  ulong android_image_get_end(const struct andr_img_hdr *hdr);
  ulong android_image_get_kload(const struct andr_img_hdr *hdr);
4f1318b29   Michael Trimarchi   common: image: mi...
1232
  void android_print_contents(const struct andr_img_hdr *hdr);
2c840c82b   Ye Li   MLK-18591-3 andro...
1233
  bool image_arm64(void *images);
9ace3fc81   Sebastian Siewior   image: add suppor...
1234
1235
  
  #endif /* CONFIG_ANDROID_BOOT_IMAGE */
4b307f238   Simon Glass   spl: Add a way fo...
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
  /**
   * board_fit_config_name_match() - Check for a matching board name
   *
   * This is used when SPL loads a FIT containing multiple device tree files
   * and wants to work out which one to use. The description of each one is
   * passed to this function. The description comes from the 'description' field
   * in each (FDT) image node.
   *
   * @name: Device tree description
   * @return 0 if this device tree should be used, non-zero to try the next
   */
  int board_fit_config_name_match(const char *name);
a5c7e41be   Madan Srinivas   image: Fixes buil...
1248
1249
  #if defined(CONFIG_SPL_FIT_IMAGE_POST_PROCESS) || \
  	defined(CONFIG_FIT_IMAGE_POST_PROCESS)
da74d1f34   Daniel Allred   spl: fit: add sup...
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
  /**
   * board_fit_image_post_process() - Do any post-process on FIT binary data
   *
   * This is used to do any sort of image manipulation, verification, decryption
   * etc. in a platform or board specific way. Obviously, anything done here would
   * need to be comprehended in how the images were prepared before being injected
   * into the FIT creation (i.e. the binary blobs would have been pre-processed
   * before being added to the FIT image).
   *
   * @image: pointer to the image start pointer
   * @size: pointer to the image size
   * @return no return value (failure should be handled internally)
   */
  void board_fit_image_post_process(void **p_image, size_t *p_size);
  #endif /* CONFIG_SPL_FIT_IMAGE_POST_PROCESS */
3863f840f   Cooper Jr., Franklin   spl: fit: Break o...
1265
  #define FDT_ERROR	((ulong)(-1))
92926bc80   Cooper Jr., Franklin   boot_fit: Create ...
1266
  ulong fdt_getprop_u32(const void *fdt, int node, const char *prop);
02035d008   Jean-Jacques Hiblot   fit: If no matchi...
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
  
  /**
   * fit_find_config_node() - Find the node for the best DTB in a FIT image
   *
   * A FIT image contains one or more DTBs. This function parses the
   * configurations described in the FIT images and returns the node of
   * the first matching DTB. To check if a DTB matches a board, this function
   * calls board_fit_config_name_match(). If no matching DTB is found, it returns
   * the node described by the default configuration if it exists.
   *
   * @fdt: pointer to flat device tree
   * @return the node if found, -ve otherwise
   */
92926bc80   Cooper Jr., Franklin   boot_fit: Create ...
1280
  int fit_find_config_node(const void *fdt);
d7be50921   Andrew F. Davis   image: Add FIT im...
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
  /**
   * Mapping of image types to function handlers to be invoked on the associated
   * loaded images
   *
   * @type: Type of image, I.E. IH_TYPE_*
   * @handler: Function to call on loaded image
   */
  struct fit_loadable_tbl {
  	int type;
  	/**
  	 * handler() - Process a loaded image
  	 *
  	 * @data: Pointer to start of loaded image data
  	 * @size: Size of loaded image data
  	 */
  	void (*handler)(ulong data, size_t size);
  };
  
  /*
   * Define a FIT loadable image type handler
   *
   * _type is a valid uimage_type ID as defined in the "Image Type" enum above
   * _handler is the handler function to call after this image type is loaded
   */
  #define U_BOOT_FIT_LOADABLE_HANDLER(_type, _handler) \
  	ll_entry_declare(struct fit_loadable_tbl, _function, fit_loadable) = { \
  		.type = _type, \
  		.handler = _handler, \
  	}
f13e7b2e9   Marian Balakowicz   [new uImage] Clea...
1310
  #endif	/* __IMAGE_H__ */