xref: /openbmc/u-boot/include/image.h (revision fa6c7413)
1 /*
2  * (C) Copyright 2008 Semihalf
3  *
4  * (C) Copyright 2000-2005
5  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
6  *
7  * See file CREDITS for list of people who contributed to this
8  * project.
9  *
10  * This program is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU General Public License as
12  * published by the Free Software Foundation; either version 2 of
13  * the License, or (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	 See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
23  * MA 02111-1307 USA
24  *
25  ********************************************************************
26  * NOTE: This header file defines an interface to U-Boot. Including
27  * this (unmodified) header file in another file is considered normal
28  * use of U-Boot, and does *not* fall under the heading of "derived
29  * work".
30  ********************************************************************
31  */
32 
33 #ifndef __IMAGE_H__
34 #define __IMAGE_H__
35 
36 #include "compiler.h"
37 #include <asm/byteorder.h>
38 
39 /* Define this to avoid #ifdefs later on */
40 struct lmb;
41 
42 #ifdef USE_HOSTCC
43 
44 /* new uImage format support enabled on host */
45 #define CONFIG_FIT		1
46 #define CONFIG_OF_LIBFDT	1
47 #define CONFIG_FIT_VERBOSE	1 /* enable fit_format_{error,warning}() */
48 
49 #define IMAGE_ENABLE_IGNORE	0
50 #define IMAGE_INDENT_STRING	""
51 
52 #else
53 
54 #include <lmb.h>
55 #include <asm/u-boot.h>
56 #include <command.h>
57 
58 /* Take notice of the 'ignore' property for hashes */
59 #define IMAGE_ENABLE_IGNORE	1
60 #define IMAGE_INDENT_STRING	"   "
61 
62 #endif /* USE_HOSTCC */
63 
64 #if defined(CONFIG_FIT)
65 #include <libfdt.h>
66 #include <fdt_support.h>
67 # ifdef CONFIG_SPL_BUILD
68 #  ifdef CONFIG_SPL_CRC32_SUPPORT
69 #   define IMAGE_ENABLE_CRC32	1
70 #  endif
71 #  ifdef CONFIG_SPL_MD5_SUPPORT
72 #   define IMAGE_ENABLE_MD5	1
73 #  endif
74 #  ifdef CONFIG_SPL_SHA1_SUPPORT
75 #   define IMAGE_ENABLE_SHA1	1
76 #  endif
77 # else
78 #  define CONFIG_CRC32		/* FIT images need CRC32 support */
79 #  define CONFIG_MD5		/* and MD5 */
80 #  define CONFIG_SHA1		/* and SHA1 */
81 #  define IMAGE_ENABLE_CRC32	1
82 #  define IMAGE_ENABLE_MD5	1
83 #  define IMAGE_ENABLE_SHA1	1
84 # endif
85 
86 #ifndef IMAGE_ENABLE_CRC32
87 #define IMAGE_ENABLE_CRC32	0
88 #endif
89 
90 #ifndef IMAGE_ENABLE_MD5
91 #define IMAGE_ENABLE_MD5	0
92 #endif
93 
94 #ifndef IMAGE_ENABLE_SHA1
95 #define IMAGE_ENABLE_SHA1	0
96 #endif
97 
98 #endif /* CONFIG_FIT */
99 
100 #ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH
101 # define IMAGE_ENABLE_RAMDISK_HIGH	1
102 #else
103 # define IMAGE_ENABLE_RAMDISK_HIGH	0
104 #endif
105 
106 #ifdef CONFIG_OF_LIBFDT
107 # define IMAGE_ENABLE_OF_LIBFDT	1
108 #else
109 # define IMAGE_ENABLE_OF_LIBFDT	0
110 #endif
111 
112 #ifdef CONFIG_SYS_BOOT_GET_CMDLINE
113 # define IMAGE_BOOT_GET_CMDLINE		1
114 #else
115 # define IMAGE_BOOT_GET_CMDLINE		0
116 #endif
117 
118 #ifdef CONFIG_OF_BOARD_SETUP
119 # define IMAAGE_OF_BOARD_SETUP		1
120 #else
121 # define IMAAGE_OF_BOARD_SETUP		0
122 #endif
123 
124 /*
125  * Operating System Codes
126  */
127 #define IH_OS_INVALID		0	/* Invalid OS	*/
128 #define IH_OS_OPENBSD		1	/* OpenBSD	*/
129 #define IH_OS_NETBSD		2	/* NetBSD	*/
130 #define IH_OS_FREEBSD		3	/* FreeBSD	*/
131 #define IH_OS_4_4BSD		4	/* 4.4BSD	*/
132 #define IH_OS_LINUX		5	/* Linux	*/
133 #define IH_OS_SVR4		6	/* SVR4		*/
134 #define IH_OS_ESIX		7	/* Esix		*/
135 #define IH_OS_SOLARIS		8	/* Solaris	*/
136 #define IH_OS_IRIX		9	/* Irix		*/
137 #define IH_OS_SCO		10	/* SCO		*/
138 #define IH_OS_DELL		11	/* Dell		*/
139 #define IH_OS_NCR		12	/* NCR		*/
140 #define IH_OS_LYNXOS		13	/* LynxOS	*/
141 #define IH_OS_VXWORKS		14	/* VxWorks	*/
142 #define IH_OS_PSOS		15	/* pSOS		*/
143 #define IH_OS_QNX		16	/* QNX		*/
144 #define IH_OS_U_BOOT		17	/* Firmware	*/
145 #define IH_OS_RTEMS		18	/* RTEMS	*/
146 #define IH_OS_ARTOS		19	/* ARTOS	*/
147 #define IH_OS_UNITY		20	/* Unity OS	*/
148 #define IH_OS_INTEGRITY		21	/* INTEGRITY	*/
149 #define IH_OS_OSE		22	/* OSE		*/
150 #define IH_OS_PLAN9		23	/* Plan 9	*/
151 
152 /*
153  * CPU Architecture Codes (supported by Linux)
154  */
155 #define IH_ARCH_INVALID		0	/* Invalid CPU	*/
156 #define IH_ARCH_ALPHA		1	/* Alpha	*/
157 #define IH_ARCH_ARM		2	/* ARM		*/
158 #define IH_ARCH_I386		3	/* Intel x86	*/
159 #define IH_ARCH_IA64		4	/* IA64		*/
160 #define IH_ARCH_MIPS		5	/* MIPS		*/
161 #define IH_ARCH_MIPS64		6	/* MIPS	 64 Bit */
162 #define IH_ARCH_PPC		7	/* PowerPC	*/
163 #define IH_ARCH_S390		8	/* IBM S390	*/
164 #define IH_ARCH_SH		9	/* SuperH	*/
165 #define IH_ARCH_SPARC		10	/* Sparc	*/
166 #define IH_ARCH_SPARC64		11	/* Sparc 64 Bit */
167 #define IH_ARCH_M68K		12	/* M68K		*/
168 #define IH_ARCH_MICROBLAZE	14	/* MicroBlaze   */
169 #define IH_ARCH_NIOS2		15	/* Nios-II	*/
170 #define IH_ARCH_BLACKFIN	16	/* Blackfin	*/
171 #define IH_ARCH_AVR32		17	/* AVR32	*/
172 #define IH_ARCH_ST200	        18	/* STMicroelectronics ST200  */
173 #define IH_ARCH_SANDBOX		19	/* Sandbox architecture (test only) */
174 #define IH_ARCH_NDS32	        20	/* ANDES Technology - NDS32  */
175 #define IH_ARCH_OPENRISC        21	/* OpenRISC 1000  */
176 
177 /*
178  * Image Types
179  *
180  * "Standalone Programs" are directly runnable in the environment
181  *	provided by U-Boot; it is expected that (if they behave
182  *	well) you can continue to work in U-Boot after return from
183  *	the Standalone Program.
184  * "OS Kernel Images" are usually images of some Embedded OS which
185  *	will take over control completely. Usually these programs
186  *	will install their own set of exception handlers, device
187  *	drivers, set up the MMU, etc. - this means, that you cannot
188  *	expect to re-enter U-Boot except by resetting the CPU.
189  * "RAMDisk Images" are more or less just data blocks, and their
190  *	parameters (address, size) are passed to an OS kernel that is
191  *	being started.
192  * "Multi-File Images" contain several images, typically an OS
193  *	(Linux) kernel image and one or more data images like
194  *	RAMDisks. This construct is useful for instance when you want
195  *	to boot over the network using BOOTP etc., where the boot
196  *	server provides just a single image file, but you want to get
197  *	for instance an OS kernel and a RAMDisk image.
198  *
199  *	"Multi-File Images" start with a list of image sizes, each
200  *	image size (in bytes) specified by an "uint32_t" in network
201  *	byte order. This list is terminated by an "(uint32_t)0".
202  *	Immediately after the terminating 0 follow the images, one by
203  *	one, all aligned on "uint32_t" boundaries (size rounded up to
204  *	a multiple of 4 bytes - except for the last file).
205  *
206  * "Firmware Images" are binary images containing firmware (like
207  *	U-Boot or FPGA images) which usually will be programmed to
208  *	flash memory.
209  *
210  * "Script files" are command sequences that will be executed by
211  *	U-Boot's command interpreter; this feature is especially
212  *	useful when you configure U-Boot to use a real shell (hush)
213  *	as command interpreter (=> Shell Scripts).
214  */
215 
216 #define IH_TYPE_INVALID		0	/* Invalid Image		*/
217 #define IH_TYPE_STANDALONE	1	/* Standalone Program		*/
218 #define IH_TYPE_KERNEL		2	/* OS Kernel Image		*/
219 #define IH_TYPE_RAMDISK		3	/* RAMDisk Image		*/
220 #define IH_TYPE_MULTI		4	/* Multi-File Image		*/
221 #define IH_TYPE_FIRMWARE	5	/* Firmware Image		*/
222 #define IH_TYPE_SCRIPT		6	/* Script file			*/
223 #define IH_TYPE_FILESYSTEM	7	/* Filesystem Image (any type)	*/
224 #define IH_TYPE_FLATDT		8	/* Binary Flat Device Tree Blob	*/
225 #define IH_TYPE_KWBIMAGE	9	/* Kirkwood Boot Image		*/
226 #define IH_TYPE_IMXIMAGE	10	/* Freescale IMXBoot Image	*/
227 #define IH_TYPE_UBLIMAGE	11	/* Davinci UBL Image		*/
228 #define IH_TYPE_OMAPIMAGE	12	/* TI OMAP Config Header Image	*/
229 #define IH_TYPE_AISIMAGE	13	/* TI Davinci AIS Image		*/
230 #define IH_TYPE_KERNEL_NOLOAD	14	/* OS Kernel Image, can run from any load address */
231 #define IH_TYPE_PBLIMAGE	15	/* Freescale PBL Boot Image	*/
232 
233 /*
234  * Compression Types
235  */
236 #define IH_COMP_NONE		0	/*  No	 Compression Used	*/
237 #define IH_COMP_GZIP		1	/* gzip	 Compression Used	*/
238 #define IH_COMP_BZIP2		2	/* bzip2 Compression Used	*/
239 #define IH_COMP_LZMA		3	/* lzma  Compression Used	*/
240 #define IH_COMP_LZO		4	/* lzo   Compression Used	*/
241 
242 #define IH_MAGIC	0x27051956	/* Image Magic Number		*/
243 #define IH_NMLEN		32	/* Image Name Length		*/
244 
245 /* Reused from common.h */
246 #define ROUND(a, b)		(((a) + (b) - 1) & ~((b) - 1))
247 
248 /*
249  * Legacy format image header,
250  * all data in network byte order (aka natural aka bigendian).
251  */
252 typedef struct image_header {
253 	__be32		ih_magic;	/* Image Header Magic Number	*/
254 	__be32		ih_hcrc;	/* Image Header CRC Checksum	*/
255 	__be32		ih_time;	/* Image Creation Timestamp	*/
256 	__be32		ih_size;	/* Image Data Size		*/
257 	__be32		ih_load;	/* Data	 Load  Address		*/
258 	__be32		ih_ep;		/* Entry Point Address		*/
259 	__be32		ih_dcrc;	/* Image Data CRC Checksum	*/
260 	uint8_t		ih_os;		/* Operating System		*/
261 	uint8_t		ih_arch;	/* CPU architecture		*/
262 	uint8_t		ih_type;	/* Image Type			*/
263 	uint8_t		ih_comp;	/* Compression Type		*/
264 	uint8_t		ih_name[IH_NMLEN];	/* Image Name		*/
265 } image_header_t;
266 
267 typedef struct image_info {
268 	ulong		start, end;		/* start/end of blob */
269 	ulong		image_start, image_len; /* start of image within blob, len of image */
270 	ulong		load;			/* load addr for the image */
271 	uint8_t		comp, type, os;		/* compression, type of image, os type */
272 } image_info_t;
273 
274 /*
275  * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
276  * routines.
277  */
278 typedef struct bootm_headers {
279 	/*
280 	 * Legacy os image header, if it is a multi component image
281 	 * then boot_get_ramdisk() and get_fdt() will attempt to get
282 	 * data from second and third component accordingly.
283 	 */
284 	image_header_t	*legacy_hdr_os;		/* image header pointer */
285 	image_header_t	legacy_hdr_os_copy;	/* header copy */
286 	ulong		legacy_hdr_valid;
287 
288 #if defined(CONFIG_FIT)
289 	const char	*fit_uname_cfg;	/* configuration node unit name */
290 
291 	void		*fit_hdr_os;	/* os FIT image header */
292 	const char	*fit_uname_os;	/* os subimage node unit name */
293 	int		fit_noffset_os;	/* os subimage node offset */
294 
295 	void		*fit_hdr_rd;	/* init ramdisk FIT image header */
296 	const char	*fit_uname_rd;	/* init ramdisk subimage node unit name */
297 	int		fit_noffset_rd;	/* init ramdisk subimage node offset */
298 
299 	void		*fit_hdr_fdt;	/* FDT blob FIT image header */
300 	const char	*fit_uname_fdt;	/* FDT blob subimage node unit name */
301 	int		fit_noffset_fdt;/* FDT blob subimage node offset */
302 #endif
303 
304 #ifndef USE_HOSTCC
305 	image_info_t	os;		/* os image info */
306 	ulong		ep;		/* entry point of OS */
307 
308 	ulong		rd_start, rd_end;/* ramdisk start/end */
309 
310 	char		*ft_addr;	/* flat dev tree address */
311 	ulong		ft_len;		/* length of flat device tree */
312 
313 	ulong		initrd_start;
314 	ulong		initrd_end;
315 	ulong		cmdline_start;
316 	ulong		cmdline_end;
317 	bd_t		*kbd;
318 #endif
319 
320 	int		verify;		/* getenv("verify")[0] != 'n' */
321 
322 #define	BOOTM_STATE_START	(0x00000001)
323 #define	BOOTM_STATE_LOADOS	(0x00000002)
324 #define	BOOTM_STATE_RAMDISK	(0x00000004)
325 #define	BOOTM_STATE_FDT		(0x00000008)
326 #define	BOOTM_STATE_OS_CMDLINE	(0x00000010)
327 #define	BOOTM_STATE_OS_BD_T	(0x00000020)
328 #define	BOOTM_STATE_OS_PREP	(0x00000040)
329 #define	BOOTM_STATE_OS_GO	(0x00000080)
330 	int		state;
331 
332 #ifdef CONFIG_LMB
333 	struct lmb	lmb;		/* for memory mgmt */
334 #endif
335 } bootm_headers_t;
336 
337 extern bootm_headers_t images;
338 
339 /*
340  * Some systems (for example LWMON) have very short watchdog periods;
341  * we must make sure to split long operations like memmove() or
342  * checksum calculations into reasonable chunks.
343  */
344 #ifndef CHUNKSZ
345 #define CHUNKSZ (64 * 1024)
346 #endif
347 
348 #ifndef CHUNKSZ_CRC32
349 #define CHUNKSZ_CRC32 (64 * 1024)
350 #endif
351 
352 #ifndef CHUNKSZ_MD5
353 #define CHUNKSZ_MD5 (64 * 1024)
354 #endif
355 
356 #ifndef CHUNKSZ_SHA1
357 #define CHUNKSZ_SHA1 (64 * 1024)
358 #endif
359 
360 #define uimage_to_cpu(x)		be32_to_cpu(x)
361 #define cpu_to_uimage(x)		cpu_to_be32(x)
362 
363 /*
364  * Translation table for entries of a specific type; used by
365  * get_table_entry_id() and get_table_entry_name().
366  */
367 typedef struct table_entry {
368 	int	id;
369 	char	*sname;		/* short (input) name to find table entry */
370 	char	*lname;		/* long (output) name to print for messages */
371 } table_entry_t;
372 
373 /*
374  * get_table_entry_id() scans the translation table trying to find an
375  * entry that matches the given short name. If a matching entry is
376  * found, it's id is returned to the caller.
377  */
378 int get_table_entry_id(const table_entry_t *table,
379 		const char *table_name, const char *name);
380 /*
381  * get_table_entry_name() scans the translation table trying to find
382  * an entry that matches the given id. If a matching entry is found,
383  * its long name is returned to the caller.
384  */
385 char *get_table_entry_name(const table_entry_t *table, char *msg, int id);
386 
387 const char *genimg_get_os_name(uint8_t os);
388 const char *genimg_get_arch_name(uint8_t arch);
389 const char *genimg_get_type_name(uint8_t type);
390 const char *genimg_get_comp_name(uint8_t comp);
391 int genimg_get_os_id(const char *name);
392 int genimg_get_arch_id(const char *name);
393 int genimg_get_type_id(const char *name);
394 int genimg_get_comp_id(const char *name);
395 void genimg_print_size(uint32_t size);
396 
397 #if defined(CONFIG_TIMESTAMP) || defined(CONFIG_CMD_DATE) || \
398 	defined(USE_HOSTCC)
399 #define IMAGE_ENABLE_TIMESTAMP 1
400 #else
401 #define IMAGE_ENABLE_TIMESTAMP 0
402 #endif
403 void genimg_print_time(time_t timestamp);
404 
405 #ifndef USE_HOSTCC
406 /* Image format types, returned by _get_format() routine */
407 #define IMAGE_FORMAT_INVALID	0x00
408 #define IMAGE_FORMAT_LEGACY	0x01	/* legacy image_header based format */
409 #define IMAGE_FORMAT_FIT	0x02	/* new, libfdt based format */
410 
411 int genimg_get_format(const void *img_addr);
412 int genimg_has_config(bootm_headers_t *images);
413 ulong genimg_get_image(ulong img_addr);
414 
415 int boot_get_ramdisk(int argc, char * const argv[], bootm_headers_t *images,
416 		uint8_t arch, ulong *rd_start, ulong *rd_end);
417 
418 int boot_get_fdt(int flag, int argc, char * const argv[],
419 		bootm_headers_t *images, char **of_flat_tree, ulong *of_size);
420 void boot_fdt_add_mem_rsv_regions(struct lmb *lmb, void *fdt_blob);
421 int boot_relocate_fdt(struct lmb *lmb, char **of_flat_tree, ulong *of_size);
422 
423 int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len,
424 		  ulong *initrd_start, ulong *initrd_end);
425 int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end);
426 #ifdef CONFIG_SYS_BOOT_GET_KBD
427 int boot_get_kbd(struct lmb *lmb, bd_t **kbd);
428 #endif /* CONFIG_SYS_BOOT_GET_KBD */
429 #endif /* !USE_HOSTCC */
430 
431 /*******************************************************************/
432 /* Legacy format specific code (prefixed with image_) */
433 /*******************************************************************/
434 static inline uint32_t image_get_header_size(void)
435 {
436 	return (sizeof(image_header_t));
437 }
438 
439 #define image_get_hdr_l(f) \
440 	static inline uint32_t image_get_##f(const image_header_t *hdr) \
441 	{ \
442 		return uimage_to_cpu(hdr->ih_##f); \
443 	}
444 image_get_hdr_l(magic)		/* image_get_magic */
445 image_get_hdr_l(hcrc)		/* image_get_hcrc */
446 image_get_hdr_l(time)		/* image_get_time */
447 image_get_hdr_l(size)		/* image_get_size */
448 image_get_hdr_l(load)		/* image_get_load */
449 image_get_hdr_l(ep)		/* image_get_ep */
450 image_get_hdr_l(dcrc)		/* image_get_dcrc */
451 
452 #define image_get_hdr_b(f) \
453 	static inline uint8_t image_get_##f(const image_header_t *hdr) \
454 	{ \
455 		return hdr->ih_##f; \
456 	}
457 image_get_hdr_b(os)		/* image_get_os */
458 image_get_hdr_b(arch)		/* image_get_arch */
459 image_get_hdr_b(type)		/* image_get_type */
460 image_get_hdr_b(comp)		/* image_get_comp */
461 
462 static inline char *image_get_name(const image_header_t *hdr)
463 {
464 	return (char *)hdr->ih_name;
465 }
466 
467 static inline uint32_t image_get_data_size(const image_header_t *hdr)
468 {
469 	return image_get_size(hdr);
470 }
471 
472 /**
473  * image_get_data - get image payload start address
474  * @hdr: image header
475  *
476  * image_get_data() returns address of the image payload. For single
477  * component images it is image data start. For multi component
478  * images it points to the null terminated table of sub-images sizes.
479  *
480  * returns:
481  *     image payload data start address
482  */
483 static inline ulong image_get_data(const image_header_t *hdr)
484 {
485 	return ((ulong)hdr + image_get_header_size());
486 }
487 
488 static inline uint32_t image_get_image_size(const image_header_t *hdr)
489 {
490 	return (image_get_size(hdr) + image_get_header_size());
491 }
492 static inline ulong image_get_image_end(const image_header_t *hdr)
493 {
494 	return ((ulong)hdr + image_get_image_size(hdr));
495 }
496 
497 #define image_set_hdr_l(f) \
498 	static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
499 	{ \
500 		hdr->ih_##f = cpu_to_uimage(val); \
501 	}
502 image_set_hdr_l(magic)		/* image_set_magic */
503 image_set_hdr_l(hcrc)		/* image_set_hcrc */
504 image_set_hdr_l(time)		/* image_set_time */
505 image_set_hdr_l(size)		/* image_set_size */
506 image_set_hdr_l(load)		/* image_set_load */
507 image_set_hdr_l(ep)		/* image_set_ep */
508 image_set_hdr_l(dcrc)		/* image_set_dcrc */
509 
510 #define image_set_hdr_b(f) \
511 	static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
512 	{ \
513 		hdr->ih_##f = val; \
514 	}
515 image_set_hdr_b(os)		/* image_set_os */
516 image_set_hdr_b(arch)		/* image_set_arch */
517 image_set_hdr_b(type)		/* image_set_type */
518 image_set_hdr_b(comp)		/* image_set_comp */
519 
520 static inline void image_set_name(image_header_t *hdr, const char *name)
521 {
522 	strncpy(image_get_name(hdr), name, IH_NMLEN);
523 }
524 
525 int image_check_hcrc(const image_header_t *hdr);
526 int image_check_dcrc(const image_header_t *hdr);
527 #ifndef USE_HOSTCC
528 ulong getenv_bootm_low(void);
529 phys_size_t getenv_bootm_size(void);
530 phys_size_t getenv_bootm_mapsize(void);
531 void memmove_wd(void *to, void *from, size_t len, ulong chunksz);
532 #endif
533 
534 static inline int image_check_magic(const image_header_t *hdr)
535 {
536 	return (image_get_magic(hdr) == IH_MAGIC);
537 }
538 static inline int image_check_type(const image_header_t *hdr, uint8_t type)
539 {
540 	return (image_get_type(hdr) == type);
541 }
542 static inline int image_check_arch(const image_header_t *hdr, uint8_t arch)
543 {
544 	return (image_get_arch(hdr) == arch);
545 }
546 static inline int image_check_os(const image_header_t *hdr, uint8_t os)
547 {
548 	return (image_get_os(hdr) == os);
549 }
550 
551 ulong image_multi_count(const image_header_t *hdr);
552 void image_multi_getimg(const image_header_t *hdr, ulong idx,
553 			ulong *data, ulong *len);
554 
555 void image_print_contents(const void *hdr);
556 
557 #ifndef USE_HOSTCC
558 static inline int image_check_target_arch(const image_header_t *hdr)
559 {
560 #ifndef IH_ARCH_DEFAULT
561 # error "please define IH_ARCH_DEFAULT in your arch asm/u-boot.h"
562 #endif
563 	return image_check_arch(hdr, IH_ARCH_DEFAULT);
564 }
565 #endif /* USE_HOSTCC */
566 
567 /**
568  * Set up properties in the FDT
569  *
570  * This sets up properties in the FDT that is to be passed to linux.
571  *
572  * @images:	Images information
573  * @blob:	FDT to update
574  * @of_size:	Size of the FDT
575  * @lmb:	Points to logical memory block structure
576  * @return 0 if ok, <0 on failure
577  */
578 int image_setup_libfdt(bootm_headers_t *images, void *blob,
579 		       int of_size, struct lmb *lmb);
580 
581 /**
582  * Set up the FDT to use for booting a kernel
583  *
584  * This performs ramdisk setup, sets up the FDT if required, and adds
585  * paramters to the FDT if libfdt is available.
586  *
587  * @param images	Images information
588  * @return 0 if ok, <0 on failure
589  */
590 int image_setup_linux(bootm_headers_t *images);
591 
592 /*******************************************************************/
593 /* New uImage format specific code (prefixed with fit_) */
594 /*******************************************************************/
595 #if defined(CONFIG_FIT)
596 
597 #define FIT_IMAGES_PATH		"/images"
598 #define FIT_CONFS_PATH		"/configurations"
599 
600 /* hash node */
601 #define FIT_HASH_NODENAME	"hash"
602 #define FIT_ALGO_PROP		"algo"
603 #define FIT_VALUE_PROP		"value"
604 #define FIT_IGNORE_PROP		"uboot-ignore"
605 
606 /* image node */
607 #define FIT_DATA_PROP		"data"
608 #define FIT_TIMESTAMP_PROP	"timestamp"
609 #define FIT_DESC_PROP		"description"
610 #define FIT_ARCH_PROP		"arch"
611 #define FIT_TYPE_PROP		"type"
612 #define FIT_OS_PROP		"os"
613 #define FIT_COMP_PROP		"compression"
614 #define FIT_ENTRY_PROP		"entry"
615 #define FIT_LOAD_PROP		"load"
616 
617 /* configuration node */
618 #define FIT_KERNEL_PROP		"kernel"
619 #define FIT_RAMDISK_PROP	"ramdisk"
620 #define FIT_FDT_PROP		"fdt"
621 #define FIT_DEFAULT_PROP	"default"
622 
623 #define FIT_MAX_HASH_LEN	20	/* max(crc32_len(4), sha1_len(20)) */
624 
625 /* cmdline argument format parsing */
626 int fit_parse_conf(const char *spec, ulong addr_curr,
627 		ulong *addr, const char **conf_name);
628 int fit_parse_subimage(const char *spec, ulong addr_curr,
629 		ulong *addr, const char **image_name);
630 
631 void fit_print_contents(const void *fit);
632 void fit_image_print(const void *fit, int noffset, const char *p);
633 
634 /**
635  * fit_get_end - get FIT image size
636  * @fit: pointer to the FIT format image header
637  *
638  * returns:
639  *     size of the FIT image (blob) in memory
640  */
641 static inline ulong fit_get_size(const void *fit)
642 {
643 	return fdt_totalsize(fit);
644 }
645 
646 /**
647  * fit_get_end - get FIT image end
648  * @fit: pointer to the FIT format image header
649  *
650  * returns:
651  *     end address of the FIT image (blob) in memory
652  */
653 static inline ulong fit_get_end(const void *fit)
654 {
655 	return (ulong)fit + fdt_totalsize(fit);
656 }
657 
658 /**
659  * fit_get_name - get FIT node name
660  * @fit: pointer to the FIT format image header
661  *
662  * returns:
663  *     NULL, on error
664  *     pointer to node name, on success
665  */
666 static inline const char *fit_get_name(const void *fit_hdr,
667 		int noffset, int *len)
668 {
669 	return fdt_get_name(fit_hdr, noffset, len);
670 }
671 
672 int fit_get_desc(const void *fit, int noffset, char **desc);
673 int fit_get_timestamp(const void *fit, int noffset, time_t *timestamp);
674 
675 int fit_image_get_node(const void *fit, const char *image_uname);
676 int fit_image_get_os(const void *fit, int noffset, uint8_t *os);
677 int fit_image_get_arch(const void *fit, int noffset, uint8_t *arch);
678 int fit_image_get_type(const void *fit, int noffset, uint8_t *type);
679 int fit_image_get_comp(const void *fit, int noffset, uint8_t *comp);
680 int fit_image_get_load(const void *fit, int noffset, ulong *load);
681 int fit_image_get_entry(const void *fit, int noffset, ulong *entry);
682 int fit_image_get_data(const void *fit, int noffset,
683 				const void **data, size_t *size);
684 
685 int fit_image_hash_get_algo(const void *fit, int noffset, char **algo);
686 int fit_image_hash_get_value(const void *fit, int noffset, uint8_t **value,
687 				int *value_len);
688 
689 int fit_set_timestamp(void *fit, int noffset, time_t timestamp);
690 
691 /**
692  * fit_add_verification_data() - Calculate and add hashes to FIT
693  *
694  * @fit:	Fit image to process
695  * @return 0 if ok, <0 for error
696  */
697 int fit_add_verification_data(void *fit);
698 
699 int fit_image_verify(const void *fit, int noffset);
700 int fit_all_image_verify(const void *fit);
701 int fit_image_check_os(const void *fit, int noffset, uint8_t os);
702 int fit_image_check_arch(const void *fit, int noffset, uint8_t arch);
703 int fit_image_check_type(const void *fit, int noffset, uint8_t type);
704 int fit_image_check_comp(const void *fit, int noffset, uint8_t comp);
705 int fit_check_format(const void *fit);
706 
707 int fit_conf_find_compat(const void *fit, const void *fdt);
708 int fit_conf_get_node(const void *fit, const char *conf_uname);
709 int fit_conf_get_kernel_node(const void *fit, int noffset);
710 int fit_conf_get_ramdisk_node(const void *fit, int noffset);
711 int fit_conf_get_fdt_node(const void *fit, int noffset);
712 
713 /**
714  * fit_conf_get_prop_node() - Get node refered to by a configuration
715  * @fit:	FIT to check
716  * @noffset:	Offset of conf@xxx node to check
717  * @prop_name:	Property to read from the conf node
718  *
719  * The conf@ nodes contain references to other nodes, using properties
720  * like 'kernel = "kernel@1"'. Given such a property name (e.g. "kernel"),
721  * return the offset of the node referred to (e.g. offset of node
722  * "/images/kernel@1".
723  */
724 int fit_conf_get_prop_node(const void *fit, int noffset,
725 		const char *prop_name);
726 
727 void fit_conf_print(const void *fit, int noffset, const char *p);
728 
729 int fit_check_ramdisk(const void *fit, int os_noffset,
730 		uint8_t arch, int verify);
731 
732 int calculate_hash(const void *data, int data_len, const char *algo,
733 			uint8_t *value, int *value_len);
734 
735 #ifndef USE_HOSTCC
736 static inline int fit_image_check_target_arch(const void *fdt, int node)
737 {
738 	return fit_image_check_arch(fdt, node, IH_ARCH_DEFAULT);
739 }
740 #endif /* USE_HOSTCC */
741 
742 #ifdef CONFIG_FIT_VERBOSE
743 #define fit_unsupported(msg)	printf("! %s:%d " \
744 				"FIT images not supported for '%s'\n", \
745 				__FILE__, __LINE__, (msg))
746 
747 #define fit_unsupported_reset(msg)	printf("! %s:%d " \
748 				"FIT images not supported for '%s' " \
749 				"- must reset board to recover!\n", \
750 				__FILE__, __LINE__, (msg))
751 #else
752 #define fit_unsupported(msg)
753 #define fit_unsupported_reset(msg)
754 #endif /* CONFIG_FIT_VERBOSE */
755 #endif /* CONFIG_FIT */
756 
757 #endif	/* __IMAGE_H__ */
758