xref: /openbmc/u-boot/include/image.h (revision 867da0d4)
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 <fdt.h>
56 #include <libfdt.h>
57 #include <fdt_support.h>
58 #define CONFIG_MD5		/* FIT images need MD5 support */
59 #define CONFIG_SHA1		/* and SHA1 */
60 #endif
61 
62 /*
63  * Operating System Codes
64  */
65 #define IH_OS_INVALID		0	/* Invalid OS	*/
66 #define IH_OS_OPENBSD		1	/* OpenBSD	*/
67 #define IH_OS_NETBSD		2	/* NetBSD	*/
68 #define IH_OS_FREEBSD		3	/* FreeBSD	*/
69 #define IH_OS_4_4BSD		4	/* 4.4BSD	*/
70 #define IH_OS_LINUX		5	/* Linux	*/
71 #define IH_OS_SVR4		6	/* SVR4		*/
72 #define IH_OS_ESIX		7	/* Esix		*/
73 #define IH_OS_SOLARIS		8	/* Solaris	*/
74 #define IH_OS_IRIX		9	/* Irix		*/
75 #define IH_OS_SCO		10	/* SCO		*/
76 #define IH_OS_DELL		11	/* Dell		*/
77 #define IH_OS_NCR		12	/* NCR		*/
78 #define IH_OS_LYNXOS		13	/* LynxOS	*/
79 #define IH_OS_VXWORKS		14	/* VxWorks	*/
80 #define IH_OS_PSOS		15	/* pSOS		*/
81 #define IH_OS_QNX		16	/* QNX		*/
82 #define IH_OS_U_BOOT		17	/* Firmware	*/
83 #define IH_OS_RTEMS		18	/* RTEMS	*/
84 #define IH_OS_ARTOS		19	/* ARTOS	*/
85 #define IH_OS_UNITY		20	/* Unity OS	*/
86 #define IH_OS_INTEGRITY		21	/* INTEGRITY	*/
87 #define IH_OS_OSE		22	/* OSE		*/
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 /*
183  * Legacy format image header,
184  * all data in network byte order (aka natural aka bigendian).
185  */
186 typedef struct image_header {
187 	__be32		ih_magic;	/* Image Header Magic Number	*/
188 	__be32		ih_hcrc;	/* Image Header CRC Checksum	*/
189 	__be32		ih_time;	/* Image Creation Timestamp	*/
190 	__be32		ih_size;	/* Image Data Size		*/
191 	__be32		ih_load;	/* Data	 Load  Address		*/
192 	__be32		ih_ep;		/* Entry Point Address		*/
193 	__be32		ih_dcrc;	/* Image Data CRC Checksum	*/
194 	uint8_t		ih_os;		/* Operating System		*/
195 	uint8_t		ih_arch;	/* CPU architecture		*/
196 	uint8_t		ih_type;	/* Image Type			*/
197 	uint8_t		ih_comp;	/* Compression Type		*/
198 	uint8_t		ih_name[IH_NMLEN];	/* Image Name		*/
199 } image_header_t;
200 
201 typedef struct image_info {
202 	ulong		start, end;		/* start/end of blob */
203 	ulong		image_start, image_len; /* start of image within blob, len of image */
204 	ulong		load;			/* load addr for the image */
205 	uint8_t		comp, type, os;		/* compression, type of image, os type */
206 } image_info_t;
207 
208 /*
209  * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
210  * routines.
211  */
212 typedef struct bootm_headers {
213 	/*
214 	 * Legacy os image header, if it is a multi component image
215 	 * then boot_get_ramdisk() and get_fdt() will attempt to get
216 	 * data from second and third component accordingly.
217 	 */
218 	image_header_t	*legacy_hdr_os;		/* image header pointer */
219 	image_header_t	legacy_hdr_os_copy;	/* header copy */
220 	ulong		legacy_hdr_valid;
221 
222 #if defined(CONFIG_FIT)
223 	const char	*fit_uname_cfg;	/* configuration node unit name */
224 
225 	void		*fit_hdr_os;	/* os FIT image header */
226 	const char	*fit_uname_os;	/* os subimage node unit name */
227 	int		fit_noffset_os;	/* os subimage node offset */
228 
229 	void		*fit_hdr_rd;	/* init ramdisk FIT image header */
230 	const char	*fit_uname_rd;	/* init ramdisk subimage node unit name */
231 	int		fit_noffset_rd;	/* init ramdisk subimage node offset */
232 
233 	void		*fit_hdr_fdt;	/* FDT blob FIT image header */
234 	const char	*fit_uname_fdt;	/* FDT blob subimage node unit name */
235 	int		fit_noffset_fdt;/* FDT blob subimage node offset */
236 #endif
237 
238 #ifndef USE_HOSTCC
239 	image_info_t	os;		/* os image info */
240 	ulong		ep;		/* entry point of OS */
241 
242 	ulong		rd_start, rd_end;/* ramdisk start/end */
243 
244 #ifdef CONFIG_OF_LIBFDT
245 	char		*ft_addr;	/* flat dev tree address */
246 #endif
247 	ulong		ft_len;		/* length of flat device tree */
248 
249 	ulong		initrd_start;
250 	ulong		initrd_end;
251 	ulong		cmdline_start;
252 	ulong		cmdline_end;
253 	bd_t		*kbd;
254 #endif
255 
256 	int		verify;		/* getenv("verify")[0] != 'n' */
257 
258 #define	BOOTM_STATE_START	(0x00000001)
259 #define	BOOTM_STATE_LOADOS	(0x00000002)
260 #define	BOOTM_STATE_RAMDISK	(0x00000004)
261 #define	BOOTM_STATE_FDT		(0x00000008)
262 #define	BOOTM_STATE_OS_CMDLINE	(0x00000010)
263 #define	BOOTM_STATE_OS_BD_T	(0x00000020)
264 #define	BOOTM_STATE_OS_PREP	(0x00000040)
265 #define	BOOTM_STATE_OS_GO	(0x00000080)
266 	int		state;
267 
268 #ifdef CONFIG_LMB
269 	struct lmb	lmb;		/* for memory mgmt */
270 #endif
271 } bootm_headers_t;
272 
273 extern bootm_headers_t images;
274 
275 /*
276  * Some systems (for example LWMON) have very short watchdog periods;
277  * we must make sure to split long operations like memmove() or
278  * checksum calculations into reasonable chunks.
279  */
280 #ifndef CHUNKSZ
281 #define CHUNKSZ (64 * 1024)
282 #endif
283 
284 #ifndef CHUNKSZ_CRC32
285 #define CHUNKSZ_CRC32 (64 * 1024)
286 #endif
287 
288 #ifndef CHUNKSZ_MD5
289 #define CHUNKSZ_MD5 (64 * 1024)
290 #endif
291 
292 #ifndef CHUNKSZ_SHA1
293 #define CHUNKSZ_SHA1 (64 * 1024)
294 #endif
295 
296 #define uimage_to_cpu(x)		be32_to_cpu(x)
297 #define cpu_to_uimage(x)		cpu_to_be32(x)
298 
299 /*
300  * Translation table for entries of a specific type; used by
301  * get_table_entry_id() and get_table_entry_name().
302  */
303 typedef struct table_entry {
304 	int	id;
305 	char	*sname;		/* short (input) name to find table entry */
306 	char	*lname;		/* long (output) name to print for messages */
307 } table_entry_t;
308 
309 /*
310  * get_table_entry_id() scans the translation table trying to find an
311  * entry that matches the given short name. If a matching entry is
312  * found, it's id is returned to the caller.
313  */
314 int get_table_entry_id(const table_entry_t *table,
315 		const char *table_name, const char *name);
316 /*
317  * get_table_entry_name() scans the translation table trying to find
318  * an entry that matches the given id. If a matching entry is found,
319  * its long name is returned to the caller.
320  */
321 char *get_table_entry_name(const table_entry_t *table, char *msg, int id);
322 
323 const char *genimg_get_os_name(uint8_t os);
324 const char *genimg_get_arch_name(uint8_t arch);
325 const char *genimg_get_type_name(uint8_t type);
326 const char *genimg_get_comp_name(uint8_t comp);
327 int genimg_get_os_id(const char *name);
328 int genimg_get_arch_id(const char *name);
329 int genimg_get_type_id(const char *name);
330 int genimg_get_comp_id(const char *name);
331 void genimg_print_size(uint32_t size);
332 
333 #ifndef USE_HOSTCC
334 /* Image format types, returned by _get_format() routine */
335 #define IMAGE_FORMAT_INVALID	0x00
336 #define IMAGE_FORMAT_LEGACY	0x01	/* legacy image_header based format */
337 #define IMAGE_FORMAT_FIT	0x02	/* new, libfdt based format */
338 
339 int genimg_get_format(void *img_addr);
340 int genimg_has_config(bootm_headers_t *images);
341 ulong genimg_get_image(ulong img_addr);
342 
343 int boot_get_ramdisk(int argc, char * const argv[], bootm_headers_t *images,
344 		uint8_t arch, ulong *rd_start, ulong *rd_end);
345 
346 
347 #ifdef CONFIG_OF_LIBFDT
348 int boot_get_fdt(int flag, int argc, char * const argv[],
349 		bootm_headers_t *images, char **of_flat_tree, ulong *of_size);
350 void boot_fdt_add_mem_rsv_regions(struct lmb *lmb, void *fdt_blob);
351 int boot_relocate_fdt(struct lmb *lmb, char **of_flat_tree, ulong *of_size);
352 #endif
353 
354 #ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH
355 int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len,
356 		  ulong *initrd_start, ulong *initrd_end);
357 #endif /* CONFIG_SYS_BOOT_RAMDISK_HIGH */
358 #ifdef CONFIG_SYS_BOOT_GET_CMDLINE
359 int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end);
360 #endif /* CONFIG_SYS_BOOT_GET_CMDLINE */
361 #ifdef CONFIG_SYS_BOOT_GET_KBD
362 int boot_get_kbd(struct lmb *lmb, bd_t **kbd);
363 #endif /* CONFIG_SYS_BOOT_GET_KBD */
364 #endif /* !USE_HOSTCC */
365 
366 /*******************************************************************/
367 /* Legacy format specific code (prefixed with image_) */
368 /*******************************************************************/
369 static inline uint32_t image_get_header_size(void)
370 {
371 	return (sizeof(image_header_t));
372 }
373 
374 #define image_get_hdr_l(f) \
375 	static inline uint32_t image_get_##f(const image_header_t *hdr) \
376 	{ \
377 		return uimage_to_cpu(hdr->ih_##f); \
378 	}
379 image_get_hdr_l(magic)		/* image_get_magic */
380 image_get_hdr_l(hcrc)		/* image_get_hcrc */
381 image_get_hdr_l(time)		/* image_get_time */
382 image_get_hdr_l(size)		/* image_get_size */
383 image_get_hdr_l(load)		/* image_get_load */
384 image_get_hdr_l(ep)		/* image_get_ep */
385 image_get_hdr_l(dcrc)		/* image_get_dcrc */
386 
387 #define image_get_hdr_b(f) \
388 	static inline uint8_t image_get_##f(const image_header_t *hdr) \
389 	{ \
390 		return hdr->ih_##f; \
391 	}
392 image_get_hdr_b(os)		/* image_get_os */
393 image_get_hdr_b(arch)		/* image_get_arch */
394 image_get_hdr_b(type)		/* image_get_type */
395 image_get_hdr_b(comp)		/* image_get_comp */
396 
397 static inline char *image_get_name(const image_header_t *hdr)
398 {
399 	return (char *)hdr->ih_name;
400 }
401 
402 static inline uint32_t image_get_data_size(const image_header_t *hdr)
403 {
404 	return image_get_size(hdr);
405 }
406 
407 /**
408  * image_get_data - get image payload start address
409  * @hdr: image header
410  *
411  * image_get_data() returns address of the image payload. For single
412  * component images it is image data start. For multi component
413  * images it points to the null terminated table of sub-images sizes.
414  *
415  * returns:
416  *     image payload data start address
417  */
418 static inline ulong image_get_data(const image_header_t *hdr)
419 {
420 	return ((ulong)hdr + image_get_header_size());
421 }
422 
423 static inline uint32_t image_get_image_size(const image_header_t *hdr)
424 {
425 	return (image_get_size(hdr) + image_get_header_size());
426 }
427 static inline ulong image_get_image_end(const image_header_t *hdr)
428 {
429 	return ((ulong)hdr + image_get_image_size(hdr));
430 }
431 
432 #define image_set_hdr_l(f) \
433 	static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
434 	{ \
435 		hdr->ih_##f = cpu_to_uimage(val); \
436 	}
437 image_set_hdr_l(magic)		/* image_set_magic */
438 image_set_hdr_l(hcrc)		/* image_set_hcrc */
439 image_set_hdr_l(time)		/* image_set_time */
440 image_set_hdr_l(size)		/* image_set_size */
441 image_set_hdr_l(load)		/* image_set_load */
442 image_set_hdr_l(ep)		/* image_set_ep */
443 image_set_hdr_l(dcrc)		/* image_set_dcrc */
444 
445 #define image_set_hdr_b(f) \
446 	static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
447 	{ \
448 		hdr->ih_##f = val; \
449 	}
450 image_set_hdr_b(os)		/* image_set_os */
451 image_set_hdr_b(arch)		/* image_set_arch */
452 image_set_hdr_b(type)		/* image_set_type */
453 image_set_hdr_b(comp)		/* image_set_comp */
454 
455 static inline void image_set_name(image_header_t *hdr, const char *name)
456 {
457 	strncpy(image_get_name(hdr), name, IH_NMLEN);
458 }
459 
460 int image_check_hcrc(const image_header_t *hdr);
461 int image_check_dcrc(const image_header_t *hdr);
462 #ifndef USE_HOSTCC
463 int getenv_yesno(char *var);
464 ulong getenv_bootm_low(void);
465 phys_size_t getenv_bootm_size(void);
466 phys_size_t getenv_bootm_mapsize(void);
467 void memmove_wd(void *to, void *from, size_t len, ulong chunksz);
468 #endif
469 
470 static inline int image_check_magic(const image_header_t *hdr)
471 {
472 	return (image_get_magic(hdr) == IH_MAGIC);
473 }
474 static inline int image_check_type(const image_header_t *hdr, uint8_t type)
475 {
476 	return (image_get_type(hdr) == type);
477 }
478 static inline int image_check_arch(const image_header_t *hdr, uint8_t arch)
479 {
480 	return (image_get_arch(hdr) == arch);
481 }
482 static inline int image_check_os(const image_header_t *hdr, uint8_t os)
483 {
484 	return (image_get_os(hdr) == os);
485 }
486 
487 ulong image_multi_count(const image_header_t *hdr);
488 void image_multi_getimg(const image_header_t *hdr, ulong idx,
489 			ulong *data, ulong *len);
490 
491 void image_print_contents(const void *hdr);
492 
493 #ifndef USE_HOSTCC
494 static inline int image_check_target_arch(const image_header_t *hdr)
495 {
496 #ifndef IH_ARCH_DEFAULT
497 # error "please define IH_ARCH_DEFAULT in your arch asm/u-boot.h"
498 #endif
499 	return image_check_arch(hdr, IH_ARCH_DEFAULT);
500 }
501 #endif /* USE_HOSTCC */
502 
503 /*******************************************************************/
504 /* New uImage format specific code (prefixed with fit_) */
505 /*******************************************************************/
506 #if defined(CONFIG_FIT)
507 
508 #define FIT_IMAGES_PATH		"/images"
509 #define FIT_CONFS_PATH		"/configurations"
510 
511 /* hash node */
512 #define FIT_HASH_NODENAME	"hash"
513 #define FIT_ALGO_PROP		"algo"
514 #define FIT_VALUE_PROP		"value"
515 #define FIT_IGNORE_PROP		"uboot-ignore"
516 
517 /* image node */
518 #define FIT_DATA_PROP		"data"
519 #define FIT_TIMESTAMP_PROP	"timestamp"
520 #define FIT_DESC_PROP		"description"
521 #define FIT_ARCH_PROP		"arch"
522 #define FIT_TYPE_PROP		"type"
523 #define FIT_OS_PROP		"os"
524 #define FIT_COMP_PROP		"compression"
525 #define FIT_ENTRY_PROP		"entry"
526 #define FIT_LOAD_PROP		"load"
527 
528 /* configuration node */
529 #define FIT_KERNEL_PROP		"kernel"
530 #define FIT_RAMDISK_PROP	"ramdisk"
531 #define FIT_FDT_PROP		"fdt"
532 #define FIT_DEFAULT_PROP	"default"
533 
534 #define FIT_MAX_HASH_LEN	20	/* max(crc32_len(4), sha1_len(20)) */
535 
536 /* cmdline argument format parsing */
537 int fit_parse_conf(const char *spec, ulong addr_curr,
538 		ulong *addr, const char **conf_name);
539 int fit_parse_subimage(const char *spec, ulong addr_curr,
540 		ulong *addr, const char **image_name);
541 
542 void fit_print_contents(const void *fit);
543 void fit_image_print(const void *fit, int noffset, const char *p);
544 void fit_image_print_hash(const void *fit, int noffset, const char *p);
545 
546 /**
547  * fit_get_end - get FIT image size
548  * @fit: pointer to the FIT format image header
549  *
550  * returns:
551  *     size of the FIT image (blob) in memory
552  */
553 static inline ulong fit_get_size(const void *fit)
554 {
555 	return fdt_totalsize(fit);
556 }
557 
558 /**
559  * fit_get_end - get FIT image end
560  * @fit: pointer to the FIT format image header
561  *
562  * returns:
563  *     end address of the FIT image (blob) in memory
564  */
565 static inline ulong fit_get_end(const void *fit)
566 {
567 	return (ulong)fit + fdt_totalsize(fit);
568 }
569 
570 /**
571  * fit_get_name - get FIT node name
572  * @fit: pointer to the FIT format image header
573  *
574  * returns:
575  *     NULL, on error
576  *     pointer to node name, on success
577  */
578 static inline const char *fit_get_name(const void *fit_hdr,
579 		int noffset, int *len)
580 {
581 	return fdt_get_name(fit_hdr, noffset, len);
582 }
583 
584 int fit_get_desc(const void *fit, int noffset, char **desc);
585 int fit_get_timestamp(const void *fit, int noffset, time_t *timestamp);
586 
587 int fit_image_get_node(const void *fit, const char *image_uname);
588 int fit_image_get_os(const void *fit, int noffset, uint8_t *os);
589 int fit_image_get_arch(const void *fit, int noffset, uint8_t *arch);
590 int fit_image_get_type(const void *fit, int noffset, uint8_t *type);
591 int fit_image_get_comp(const void *fit, int noffset, uint8_t *comp);
592 int fit_image_get_load(const void *fit, int noffset, ulong *load);
593 int fit_image_get_entry(const void *fit, int noffset, ulong *entry);
594 int fit_image_get_data(const void *fit, int noffset,
595 				const void **data, size_t *size);
596 
597 int fit_image_hash_get_algo(const void *fit, int noffset, char **algo);
598 int fit_image_hash_get_value(const void *fit, int noffset, uint8_t **value,
599 				int *value_len);
600 #ifndef USE_HOSTCC
601 int fit_image_hash_get_ignore(const void *fit, int noffset, int *ignore);
602 #endif
603 
604 int fit_set_timestamp(void *fit, int noffset, time_t timestamp);
605 int fit_set_hashes(void *fit);
606 int fit_image_set_hashes(void *fit, int image_noffset);
607 int fit_image_hash_set_value(void *fit, int noffset, uint8_t *value,
608 				int value_len);
609 
610 int fit_image_check_hashes(const void *fit, int noffset);
611 int fit_all_image_check_hashes(const void *fit);
612 int fit_image_check_os(const void *fit, int noffset, uint8_t os);
613 int fit_image_check_arch(const void *fit, int noffset, uint8_t arch);
614 int fit_image_check_type(const void *fit, int noffset, uint8_t type);
615 int fit_image_check_comp(const void *fit, int noffset, uint8_t comp);
616 int fit_check_format(const void *fit);
617 
618 int fit_conf_find_compat(const void *fit, const void *fdt);
619 int fit_conf_get_node(const void *fit, const char *conf_uname);
620 int fit_conf_get_kernel_node(const void *fit, int noffset);
621 int fit_conf_get_ramdisk_node(const void *fit, int noffset);
622 int fit_conf_get_fdt_node(const void *fit, int noffset);
623 
624 void fit_conf_print(const void *fit, int noffset, const char *p);
625 
626 #ifndef USE_HOSTCC
627 static inline int fit_image_check_target_arch(const void *fdt, int node)
628 {
629 	return fit_image_check_arch(fdt, node, IH_ARCH_DEFAULT);
630 }
631 #endif /* USE_HOSTCC */
632 
633 #ifdef CONFIG_FIT_VERBOSE
634 #define fit_unsupported(msg)	printf("! %s:%d " \
635 				"FIT images not supported for '%s'\n", \
636 				__FILE__, __LINE__, (msg))
637 
638 #define fit_unsupported_reset(msg)	printf("! %s:%d " \
639 				"FIT images not supported for '%s' " \
640 				"- must reset board to recover!\n", \
641 				__FILE__, __LINE__, (msg))
642 #else
643 #define fit_unsupported(msg)
644 #define fit_unsupported_reset(msg)
645 #endif /* CONFIG_FIT_VERBOSE */
646 #endif /* CONFIG_FIT */
647 
648 #endif	/* __IMAGE_H__ */
649