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