xref: /openbmc/u-boot/common/image.c (revision 0b304a24)
1 /*
2  * (C) Copyright 2008 Semihalf
3  *
4  * (C) Copyright 2000-2006
5  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
6  *
7  * SPDX-License-Identifier:	GPL-2.0+
8  */
9 
10 #ifndef USE_HOSTCC
11 #include <common.h>
12 #include <watchdog.h>
13 
14 #ifdef CONFIG_SHOW_BOOT_PROGRESS
15 #include <status_led.h>
16 #endif
17 
18 #ifdef CONFIG_HAS_DATAFLASH
19 #include <dataflash.h>
20 #endif
21 
22 #ifdef CONFIG_LOGBUFFER
23 #include <logbuff.h>
24 #endif
25 
26 #include <rtc.h>
27 
28 #include <environment.h>
29 #include <image.h>
30 
31 #if defined(CONFIG_FIT) || defined(CONFIG_OF_LIBFDT)
32 #include <libfdt.h>
33 #include <fdt_support.h>
34 #endif
35 
36 #include <u-boot/md5.h>
37 #include <u-boot/sha1.h>
38 #include <asm/errno.h>
39 #include <asm/io.h>
40 
41 #ifdef CONFIG_CMD_BDI
42 extern int do_bdinfo(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
43 #endif
44 
45 DECLARE_GLOBAL_DATA_PTR;
46 
47 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
48 static const image_header_t *image_get_ramdisk(ulong rd_addr, uint8_t arch,
49 						int verify);
50 #endif
51 #else
52 #include "mkimage.h"
53 #include <u-boot/md5.h>
54 #include <time.h>
55 #include <image.h>
56 #endif /* !USE_HOSTCC*/
57 
58 #include <u-boot/crc.h>
59 
60 #ifndef CONFIG_SYS_BARGSIZE
61 #define CONFIG_SYS_BARGSIZE 512
62 #endif
63 
64 static const table_entry_t uimage_arch[] = {
65 	{	IH_ARCH_INVALID,	NULL,		"Invalid ARCH",	},
66 	{	IH_ARCH_ALPHA,		"alpha",	"Alpha",	},
67 	{	IH_ARCH_ARM,		"arm",		"ARM",		},
68 	{	IH_ARCH_I386,		"x86",		"Intel x86",	},
69 	{	IH_ARCH_IA64,		"ia64",		"IA64",		},
70 	{	IH_ARCH_M68K,		"m68k",		"M68K",		},
71 	{	IH_ARCH_MICROBLAZE,	"microblaze",	"MicroBlaze",	},
72 	{	IH_ARCH_MIPS,		"mips",		"MIPS",		},
73 	{	IH_ARCH_MIPS64,		"mips64",	"MIPS 64 Bit",	},
74 	{	IH_ARCH_NIOS2,		"nios2",	"NIOS II",	},
75 	{	IH_ARCH_PPC,		"powerpc",	"PowerPC",	},
76 	{	IH_ARCH_PPC,		"ppc",		"PowerPC",	},
77 	{	IH_ARCH_S390,		"s390",		"IBM S390",	},
78 	{	IH_ARCH_SH,		"sh",		"SuperH",	},
79 	{	IH_ARCH_SPARC,		"sparc",	"SPARC",	},
80 	{	IH_ARCH_SPARC64,	"sparc64",	"SPARC 64 Bit",	},
81 	{	IH_ARCH_BLACKFIN,	"blackfin",	"Blackfin",	},
82 	{	IH_ARCH_AVR32,		"avr32",	"AVR32",	},
83 	{	IH_ARCH_NDS32,		"nds32",	"NDS32",	},
84 	{	IH_ARCH_OPENRISC,	"or1k",		"OpenRISC 1000",},
85 	{	IH_ARCH_SANDBOX,	"sandbox",	"Sandbox",	},
86 	{	IH_ARCH_ARM64,		"arm64",	"AArch64",	},
87 	{	IH_ARCH_ARC,		"arc",		"ARC",		},
88 	{	-1,			"",		"",		},
89 };
90 
91 static const table_entry_t uimage_os[] = {
92 	{	IH_OS_INVALID,	NULL,		"Invalid OS",		},
93 	{	IH_OS_LINUX,	"linux",	"Linux",		},
94 #if defined(CONFIG_LYNXKDI) || defined(USE_HOSTCC)
95 	{	IH_OS_LYNXOS,	"lynxos",	"LynxOS",		},
96 #endif
97 	{	IH_OS_NETBSD,	"netbsd",	"NetBSD",		},
98 	{	IH_OS_OSE,	"ose",		"Enea OSE",		},
99 	{	IH_OS_PLAN9,	"plan9",	"Plan 9",		},
100 	{	IH_OS_RTEMS,	"rtems",	"RTEMS",		},
101 	{	IH_OS_U_BOOT,	"u-boot",	"U-Boot",		},
102 	{	IH_OS_VXWORKS,	"vxworks",	"VxWorks",		},
103 #if defined(CONFIG_CMD_ELF) || defined(USE_HOSTCC)
104 	{	IH_OS_QNX,	"qnx",		"QNX",			},
105 #endif
106 #if defined(CONFIG_INTEGRITY) || defined(USE_HOSTCC)
107 	{	IH_OS_INTEGRITY,"integrity",	"INTEGRITY",		},
108 #endif
109 #ifdef USE_HOSTCC
110 	{	IH_OS_4_4BSD,	"4_4bsd",	"4_4BSD",		},
111 	{	IH_OS_DELL,	"dell",		"Dell",			},
112 	{	IH_OS_ESIX,	"esix",		"Esix",			},
113 	{	IH_OS_FREEBSD,	"freebsd",	"FreeBSD",		},
114 	{	IH_OS_IRIX,	"irix",		"Irix",			},
115 	{	IH_OS_NCR,	"ncr",		"NCR",			},
116 	{	IH_OS_OPENBSD,	"openbsd",	"OpenBSD",		},
117 	{	IH_OS_PSOS,	"psos",		"pSOS",			},
118 	{	IH_OS_SCO,	"sco",		"SCO",			},
119 	{	IH_OS_SOLARIS,	"solaris",	"Solaris",		},
120 	{	IH_OS_SVR4,	"svr4",		"SVR4",			},
121 #endif
122 	{	-1,		"",		"",			},
123 };
124 
125 static const table_entry_t uimage_type[] = {
126 	{	IH_TYPE_AISIMAGE,   "aisimage",   "Davinci AIS image",},
127 	{	IH_TYPE_FILESYSTEM, "filesystem", "Filesystem Image",	},
128 	{	IH_TYPE_FIRMWARE,   "firmware",	  "Firmware",		},
129 	{	IH_TYPE_FLATDT,     "flat_dt",    "Flat Device Tree",	},
130 	{	IH_TYPE_GPIMAGE,    "gpimage",    "TI Keystone SPL Image",},
131 	{	IH_TYPE_KERNEL,	    "kernel",	  "Kernel Image",	},
132 	{	IH_TYPE_KERNEL_NOLOAD, "kernel_noload",  "Kernel Image (no loading done)", },
133 	{	IH_TYPE_KWBIMAGE,   "kwbimage",   "Kirkwood Boot Image",},
134 	{	IH_TYPE_IMXIMAGE,   "imximage",   "Freescale i.MX Boot Image",},
135 	{	IH_TYPE_INVALID,    NULL,	  "Invalid Image",	},
136 	{	IH_TYPE_MULTI,	    "multi",	  "Multi-File Image",	},
137 	{	IH_TYPE_OMAPIMAGE,  "omapimage",  "TI OMAP SPL With GP CH",},
138 	{	IH_TYPE_PBLIMAGE,   "pblimage",   "Freescale PBL Boot Image",},
139 	{	IH_TYPE_RAMDISK,    "ramdisk",	  "RAMDisk Image",	},
140 	{	IH_TYPE_SCRIPT,     "script",	  "Script",		},
141 	{	IH_TYPE_SOCFPGAIMAGE, "socfpgaimage", "Altera SOCFPGA preloader",},
142 	{	IH_TYPE_STANDALONE, "standalone", "Standalone Program", },
143 	{	IH_TYPE_UBLIMAGE,   "ublimage",   "Davinci UBL image",},
144 	{	IH_TYPE_MXSIMAGE,   "mxsimage",   "Freescale MXS Boot Image",},
145 	{	IH_TYPE_ATMELIMAGE, "atmelimage", "ATMEL ROM-Boot Image",},
146 	{	-1,		    "",		  "",			},
147 };
148 
149 static const table_entry_t uimage_comp[] = {
150 	{	IH_COMP_NONE,	"none",		"uncompressed",		},
151 	{	IH_COMP_BZIP2,	"bzip2",	"bzip2 compressed",	},
152 	{	IH_COMP_GZIP,	"gzip",		"gzip compressed",	},
153 	{	IH_COMP_LZMA,	"lzma",		"lzma compressed",	},
154 	{	IH_COMP_LZO,	"lzo",		"lzo compressed",	},
155 	{	-1,		"",		"",			},
156 };
157 
158 /*****************************************************************************/
159 /* Legacy format routines */
160 /*****************************************************************************/
161 int image_check_hcrc(const image_header_t *hdr)
162 {
163 	ulong hcrc;
164 	ulong len = image_get_header_size();
165 	image_header_t header;
166 
167 	/* Copy header so we can blank CRC field for re-calculation */
168 	memmove(&header, (char *)hdr, image_get_header_size());
169 	image_set_hcrc(&header, 0);
170 
171 	hcrc = crc32(0, (unsigned char *)&header, len);
172 
173 	return (hcrc == image_get_hcrc(hdr));
174 }
175 
176 int image_check_dcrc(const image_header_t *hdr)
177 {
178 	ulong data = image_get_data(hdr);
179 	ulong len = image_get_data_size(hdr);
180 	ulong dcrc = crc32_wd(0, (unsigned char *)data, len, CHUNKSZ_CRC32);
181 
182 	return (dcrc == image_get_dcrc(hdr));
183 }
184 
185 /**
186  * image_multi_count - get component (sub-image) count
187  * @hdr: pointer to the header of the multi component image
188  *
189  * image_multi_count() returns number of components in a multi
190  * component image.
191  *
192  * Note: no checking of the image type is done, caller must pass
193  * a valid multi component image.
194  *
195  * returns:
196  *     number of components
197  */
198 ulong image_multi_count(const image_header_t *hdr)
199 {
200 	ulong i, count = 0;
201 	uint32_t *size;
202 
203 	/* get start of the image payload, which in case of multi
204 	 * component images that points to a table of component sizes */
205 	size = (uint32_t *)image_get_data(hdr);
206 
207 	/* count non empty slots */
208 	for (i = 0; size[i]; ++i)
209 		count++;
210 
211 	return count;
212 }
213 
214 /**
215  * image_multi_getimg - get component data address and size
216  * @hdr: pointer to the header of the multi component image
217  * @idx: index of the requested component
218  * @data: pointer to a ulong variable, will hold component data address
219  * @len: pointer to a ulong variable, will hold component size
220  *
221  * image_multi_getimg() returns size and data address for the requested
222  * component in a multi component image.
223  *
224  * Note: no checking of the image type is done, caller must pass
225  * a valid multi component image.
226  *
227  * returns:
228  *     data address and size of the component, if idx is valid
229  *     0 in data and len, if idx is out of range
230  */
231 void image_multi_getimg(const image_header_t *hdr, ulong idx,
232 			ulong *data, ulong *len)
233 {
234 	int i;
235 	uint32_t *size;
236 	ulong offset, count, img_data;
237 
238 	/* get number of component */
239 	count = image_multi_count(hdr);
240 
241 	/* get start of the image payload, which in case of multi
242 	 * component images that points to a table of component sizes */
243 	size = (uint32_t *)image_get_data(hdr);
244 
245 	/* get address of the proper component data start, which means
246 	 * skipping sizes table (add 1 for last, null entry) */
247 	img_data = image_get_data(hdr) + (count + 1) * sizeof(uint32_t);
248 
249 	if (idx < count) {
250 		*len = uimage_to_cpu(size[idx]);
251 		offset = 0;
252 
253 		/* go over all indices preceding requested component idx */
254 		for (i = 0; i < idx; i++) {
255 			/* add up i-th component size, rounding up to 4 bytes */
256 			offset += (uimage_to_cpu(size[i]) + 3) & ~3 ;
257 		}
258 
259 		/* calculate idx-th component data address */
260 		*data = img_data + offset;
261 	} else {
262 		*len = 0;
263 		*data = 0;
264 	}
265 }
266 
267 static void image_print_type(const image_header_t *hdr)
268 {
269 	const char *os, *arch, *type, *comp;
270 
271 	os = genimg_get_os_name(image_get_os(hdr));
272 	arch = genimg_get_arch_name(image_get_arch(hdr));
273 	type = genimg_get_type_name(image_get_type(hdr));
274 	comp = genimg_get_comp_name(image_get_comp(hdr));
275 
276 	printf("%s %s %s (%s)\n", arch, os, type, comp);
277 }
278 
279 /**
280  * image_print_contents - prints out the contents of the legacy format image
281  * @ptr: pointer to the legacy format image header
282  * @p: pointer to prefix string
283  *
284  * image_print_contents() formats a multi line legacy image contents description.
285  * The routine prints out all header fields followed by the size/offset data
286  * for MULTI/SCRIPT images.
287  *
288  * returns:
289  *     no returned results
290  */
291 void image_print_contents(const void *ptr)
292 {
293 	const image_header_t *hdr = (const image_header_t *)ptr;
294 	const char *p;
295 
296 	p = IMAGE_INDENT_STRING;
297 	printf("%sImage Name:   %.*s\n", p, IH_NMLEN, image_get_name(hdr));
298 	if (IMAGE_ENABLE_TIMESTAMP) {
299 		printf("%sCreated:      ", p);
300 		genimg_print_time((time_t)image_get_time(hdr));
301 	}
302 	printf("%sImage Type:   ", p);
303 	image_print_type(hdr);
304 	printf("%sData Size:    ", p);
305 	genimg_print_size(image_get_data_size(hdr));
306 	printf("%sLoad Address: %08x\n", p, image_get_load(hdr));
307 	printf("%sEntry Point:  %08x\n", p, image_get_ep(hdr));
308 
309 	if (image_check_type(hdr, IH_TYPE_MULTI) ||
310 			image_check_type(hdr, IH_TYPE_SCRIPT)) {
311 		int i;
312 		ulong data, len;
313 		ulong count = image_multi_count(hdr);
314 
315 		printf("%sContents:\n", p);
316 		for (i = 0; i < count; i++) {
317 			image_multi_getimg(hdr, i, &data, &len);
318 
319 			printf("%s   Image %d: ", p, i);
320 			genimg_print_size(len);
321 
322 			if (image_check_type(hdr, IH_TYPE_SCRIPT) && i > 0) {
323 				/*
324 				 * the user may need to know offsets
325 				 * if planning to do something with
326 				 * multiple files
327 				 */
328 				printf("%s    Offset = 0x%08lx\n", p, data);
329 			}
330 		}
331 	}
332 }
333 
334 
335 #ifndef USE_HOSTCC
336 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
337 /**
338  * image_get_ramdisk - get and verify ramdisk image
339  * @rd_addr: ramdisk image start address
340  * @arch: expected ramdisk architecture
341  * @verify: checksum verification flag
342  *
343  * image_get_ramdisk() returns a pointer to the verified ramdisk image
344  * header. Routine receives image start address and expected architecture
345  * flag. Verification done covers data and header integrity and os/type/arch
346  * fields checking.
347  *
348  * If dataflash support is enabled routine checks for dataflash addresses
349  * and handles required dataflash reads.
350  *
351  * returns:
352  *     pointer to a ramdisk image header, if image was found and valid
353  *     otherwise, return NULL
354  */
355 static const image_header_t *image_get_ramdisk(ulong rd_addr, uint8_t arch,
356 						int verify)
357 {
358 	const image_header_t *rd_hdr = (const image_header_t *)rd_addr;
359 
360 	if (!image_check_magic(rd_hdr)) {
361 		puts("Bad Magic Number\n");
362 		bootstage_error(BOOTSTAGE_ID_RD_MAGIC);
363 		return NULL;
364 	}
365 
366 	if (!image_check_hcrc(rd_hdr)) {
367 		puts("Bad Header Checksum\n");
368 		bootstage_error(BOOTSTAGE_ID_RD_HDR_CHECKSUM);
369 		return NULL;
370 	}
371 
372 	bootstage_mark(BOOTSTAGE_ID_RD_MAGIC);
373 	image_print_contents(rd_hdr);
374 
375 	if (verify) {
376 		puts("   Verifying Checksum ... ");
377 		if (!image_check_dcrc(rd_hdr)) {
378 			puts("Bad Data CRC\n");
379 			bootstage_error(BOOTSTAGE_ID_RD_CHECKSUM);
380 			return NULL;
381 		}
382 		puts("OK\n");
383 	}
384 
385 	bootstage_mark(BOOTSTAGE_ID_RD_HDR_CHECKSUM);
386 
387 	if (!image_check_os(rd_hdr, IH_OS_LINUX) ||
388 	    !image_check_arch(rd_hdr, arch) ||
389 	    !image_check_type(rd_hdr, IH_TYPE_RAMDISK)) {
390 		printf("No Linux %s Ramdisk Image\n",
391 				genimg_get_arch_name(arch));
392 		bootstage_error(BOOTSTAGE_ID_RAMDISK);
393 		return NULL;
394 	}
395 
396 	return rd_hdr;
397 }
398 #endif
399 #endif /* !USE_HOSTCC */
400 
401 /*****************************************************************************/
402 /* Shared dual-format routines */
403 /*****************************************************************************/
404 #ifndef USE_HOSTCC
405 ulong load_addr = CONFIG_SYS_LOAD_ADDR;	/* Default Load Address */
406 ulong save_addr;			/* Default Save Address */
407 ulong save_size;			/* Default Save Size (in bytes) */
408 
409 static int on_loadaddr(const char *name, const char *value, enum env_op op,
410 	int flags)
411 {
412 	switch (op) {
413 	case env_op_create:
414 	case env_op_overwrite:
415 		load_addr = simple_strtoul(value, NULL, 16);
416 		break;
417 	default:
418 		break;
419 	}
420 
421 	return 0;
422 }
423 U_BOOT_ENV_CALLBACK(loadaddr, on_loadaddr);
424 
425 ulong getenv_bootm_low(void)
426 {
427 	char *s = getenv("bootm_low");
428 	if (s) {
429 		ulong tmp = simple_strtoul(s, NULL, 16);
430 		return tmp;
431 	}
432 
433 #if defined(CONFIG_SYS_SDRAM_BASE)
434 	return CONFIG_SYS_SDRAM_BASE;
435 #elif defined(CONFIG_ARM)
436 	return gd->bd->bi_dram[0].start;
437 #else
438 	return 0;
439 #endif
440 }
441 
442 phys_size_t getenv_bootm_size(void)
443 {
444 	phys_size_t tmp;
445 	char *s = getenv("bootm_size");
446 	if (s) {
447 		tmp = (phys_size_t)simple_strtoull(s, NULL, 16);
448 		return tmp;
449 	}
450 	s = getenv("bootm_low");
451 	if (s)
452 		tmp = (phys_size_t)simple_strtoull(s, NULL, 16);
453 	else
454 		tmp = 0;
455 
456 
457 #if defined(CONFIG_ARM)
458 	return gd->bd->bi_dram[0].size - tmp;
459 #else
460 	return gd->bd->bi_memsize - tmp;
461 #endif
462 }
463 
464 phys_size_t getenv_bootm_mapsize(void)
465 {
466 	phys_size_t tmp;
467 	char *s = getenv("bootm_mapsize");
468 	if (s) {
469 		tmp = (phys_size_t)simple_strtoull(s, NULL, 16);
470 		return tmp;
471 	}
472 
473 #if defined(CONFIG_SYS_BOOTMAPSZ)
474 	return CONFIG_SYS_BOOTMAPSZ;
475 #else
476 	return getenv_bootm_size();
477 #endif
478 }
479 
480 void memmove_wd(void *to, void *from, size_t len, ulong chunksz)
481 {
482 	if (to == from)
483 		return;
484 
485 #if defined(CONFIG_HW_WATCHDOG) || defined(CONFIG_WATCHDOG)
486 	while (len > 0) {
487 		size_t tail = (len > chunksz) ? chunksz : len;
488 		WATCHDOG_RESET();
489 		memmove(to, from, tail);
490 		to += tail;
491 		from += tail;
492 		len -= tail;
493 	}
494 #else	/* !(CONFIG_HW_WATCHDOG || CONFIG_WATCHDOG) */
495 	memmove(to, from, len);
496 #endif	/* CONFIG_HW_WATCHDOG || CONFIG_WATCHDOG */
497 }
498 #endif /* !USE_HOSTCC */
499 
500 void genimg_print_size(uint32_t size)
501 {
502 #ifndef USE_HOSTCC
503 	printf("%d Bytes = ", size);
504 	print_size(size, "\n");
505 #else
506 	printf("%d Bytes = %.2f kB = %.2f MB\n",
507 			size, (double)size / 1.024e3,
508 			(double)size / 1.048576e6);
509 #endif
510 }
511 
512 #if IMAGE_ENABLE_TIMESTAMP
513 void genimg_print_time(time_t timestamp)
514 {
515 #ifndef USE_HOSTCC
516 	struct rtc_time tm;
517 
518 	to_tm(timestamp, &tm);
519 	printf("%4d-%02d-%02d  %2d:%02d:%02d UTC\n",
520 			tm.tm_year, tm.tm_mon, tm.tm_mday,
521 			tm.tm_hour, tm.tm_min, tm.tm_sec);
522 #else
523 	printf("%s", ctime(&timestamp));
524 #endif
525 }
526 #endif
527 
528 /**
529  * get_table_entry_name - translate entry id to long name
530  * @table: pointer to a translation table for entries of a specific type
531  * @msg: message to be returned when translation fails
532  * @id: entry id to be translated
533  *
534  * get_table_entry_name() will go over translation table trying to find
535  * entry that matches given id. If matching entry is found, its long
536  * name is returned to the caller.
537  *
538  * returns:
539  *     long entry name if translation succeeds
540  *     msg otherwise
541  */
542 char *get_table_entry_name(const table_entry_t *table, char *msg, int id)
543 {
544 	for (; table->id >= 0; ++table) {
545 		if (table->id == id)
546 #if defined(USE_HOSTCC) || !defined(CONFIG_NEEDS_MANUAL_RELOC)
547 			return table->lname;
548 #else
549 			return table->lname + gd->reloc_off;
550 #endif
551 	}
552 	return (msg);
553 }
554 
555 const char *genimg_get_os_name(uint8_t os)
556 {
557 	return (get_table_entry_name(uimage_os, "Unknown OS", os));
558 }
559 
560 const char *genimg_get_arch_name(uint8_t arch)
561 {
562 	return (get_table_entry_name(uimage_arch, "Unknown Architecture",
563 					arch));
564 }
565 
566 const char *genimg_get_type_name(uint8_t type)
567 {
568 	return (get_table_entry_name(uimage_type, "Unknown Image", type));
569 }
570 
571 const char *genimg_get_comp_name(uint8_t comp)
572 {
573 	return (get_table_entry_name(uimage_comp, "Unknown Compression",
574 					comp));
575 }
576 
577 /**
578  * get_table_entry_id - translate short entry name to id
579  * @table: pointer to a translation table for entries of a specific type
580  * @table_name: to be used in case of error
581  * @name: entry short name to be translated
582  *
583  * get_table_entry_id() will go over translation table trying to find
584  * entry that matches given short name. If matching entry is found,
585  * its id returned to the caller.
586  *
587  * returns:
588  *     entry id if translation succeeds
589  *     -1 otherwise
590  */
591 int get_table_entry_id(const table_entry_t *table,
592 		const char *table_name, const char *name)
593 {
594 	const table_entry_t *t;
595 #ifdef USE_HOSTCC
596 	int first = 1;
597 
598 	for (t = table; t->id >= 0; ++t) {
599 		if (t->sname && strcasecmp(t->sname, name) == 0)
600 			return(t->id);
601 	}
602 
603 	fprintf(stderr, "\nInvalid %s Type - valid names are", table_name);
604 	for (t = table; t->id >= 0; ++t) {
605 		if (t->sname == NULL)
606 			continue;
607 		fprintf(stderr, "%c %s", (first) ? ':' : ',', t->sname);
608 		first = 0;
609 	}
610 	fprintf(stderr, "\n");
611 #else
612 	for (t = table; t->id >= 0; ++t) {
613 #ifdef CONFIG_NEEDS_MANUAL_RELOC
614 		if (t->sname && strcmp(t->sname + gd->reloc_off, name) == 0)
615 #else
616 		if (t->sname && strcmp(t->sname, name) == 0)
617 #endif
618 			return (t->id);
619 	}
620 	debug("Invalid %s Type: %s\n", table_name, name);
621 #endif /* USE_HOSTCC */
622 	return (-1);
623 }
624 
625 int genimg_get_os_id(const char *name)
626 {
627 	return (get_table_entry_id(uimage_os, "OS", name));
628 }
629 
630 int genimg_get_arch_id(const char *name)
631 {
632 	return (get_table_entry_id(uimage_arch, "CPU", name));
633 }
634 
635 int genimg_get_type_id(const char *name)
636 {
637 	return (get_table_entry_id(uimage_type, "Image", name));
638 }
639 
640 int genimg_get_comp_id(const char *name)
641 {
642 	return (get_table_entry_id(uimage_comp, "Compression", name));
643 }
644 
645 #ifndef USE_HOSTCC
646 /**
647  * genimg_get_kernel_addr_fit - get the real kernel address and return 2
648  *                              FIT strings
649  * @img_addr: a string might contain real image address
650  * @fit_uname_config: double pointer to a char, will hold pointer to a
651  *                    configuration unit name
652  * @fit_uname_kernel: double pointer to a char, will hold pointer to a subimage
653  *                    name
654  *
655  * genimg_get_kernel_addr_fit get the real kernel start address from a string
656  * which is normally the first argv of bootm/bootz
657  *
658  * returns:
659  *     kernel start address
660  */
661 ulong genimg_get_kernel_addr_fit(char * const img_addr,
662 			     const char **fit_uname_config,
663 			     const char **fit_uname_kernel)
664 {
665 	ulong kernel_addr;
666 
667 	/* find out kernel image address */
668 	if (!img_addr) {
669 		kernel_addr = load_addr;
670 		debug("*  kernel: default image load address = 0x%08lx\n",
671 		      load_addr);
672 #if defined(CONFIG_FIT)
673 	} else if (fit_parse_conf(img_addr, load_addr, &kernel_addr,
674 				  fit_uname_config)) {
675 		debug("*  kernel: config '%s' from image at 0x%08lx\n",
676 		      *fit_uname_config, kernel_addr);
677 	} else if (fit_parse_subimage(img_addr, load_addr, &kernel_addr,
678 				     fit_uname_kernel)) {
679 		debug("*  kernel: subimage '%s' from image at 0x%08lx\n",
680 		      *fit_uname_kernel, kernel_addr);
681 #endif
682 	} else {
683 		kernel_addr = simple_strtoul(img_addr, NULL, 16);
684 		debug("*  kernel: cmdline image address = 0x%08lx\n",
685 		      kernel_addr);
686 	}
687 
688 	return kernel_addr;
689 }
690 
691 /**
692  * genimg_get_kernel_addr() is the simple version of
693  * genimg_get_kernel_addr_fit(). It ignores those return FIT strings
694  */
695 ulong genimg_get_kernel_addr(char * const img_addr)
696 {
697 	const char *fit_uname_config = NULL;
698 	const char *fit_uname_kernel = NULL;
699 
700 	return genimg_get_kernel_addr_fit(img_addr, &fit_uname_config,
701 					  &fit_uname_kernel);
702 }
703 
704 /**
705  * genimg_get_format - get image format type
706  * @img_addr: image start address
707  *
708  * genimg_get_format() checks whether provided address points to a valid
709  * legacy or FIT image.
710  *
711  * New uImage format and FDT blob are based on a libfdt. FDT blob
712  * may be passed directly or embedded in a FIT image. In both situations
713  * genimg_get_format() must be able to dectect libfdt header.
714  *
715  * returns:
716  *     image format type or IMAGE_FORMAT_INVALID if no image is present
717  */
718 int genimg_get_format(const void *img_addr)
719 {
720 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
721 	const image_header_t *hdr;
722 
723 	hdr = (const image_header_t *)img_addr;
724 	if (image_check_magic(hdr))
725 		return IMAGE_FORMAT_LEGACY;
726 #endif
727 #if defined(CONFIG_FIT) || defined(CONFIG_OF_LIBFDT)
728 	if (fdt_check_header(img_addr) == 0)
729 		return IMAGE_FORMAT_FIT;
730 #endif
731 #ifdef CONFIG_ANDROID_BOOT_IMAGE
732 	if (android_image_check_header(img_addr) == 0)
733 		return IMAGE_FORMAT_ANDROID;
734 #endif
735 
736 	return IMAGE_FORMAT_INVALID;
737 }
738 
739 /**
740  * genimg_get_image - get image from special storage (if necessary)
741  * @img_addr: image start address
742  *
743  * genimg_get_image() checks if provided image start adddress is located
744  * in a dataflash storage. If so, image is moved to a system RAM memory.
745  *
746  * returns:
747  *     image start address after possible relocation from special storage
748  */
749 ulong genimg_get_image(ulong img_addr)
750 {
751 	ulong ram_addr = img_addr;
752 
753 #ifdef CONFIG_HAS_DATAFLASH
754 	ulong h_size, d_size;
755 
756 	if (addr_dataflash(img_addr)) {
757 		void *buf;
758 
759 		/* ger RAM address */
760 		ram_addr = CONFIG_SYS_LOAD_ADDR;
761 
762 		/* get header size */
763 		h_size = image_get_header_size();
764 #if defined(CONFIG_FIT)
765 		if (sizeof(struct fdt_header) > h_size)
766 			h_size = sizeof(struct fdt_header);
767 #endif
768 
769 		/* read in header */
770 		debug("   Reading image header from dataflash address "
771 			"%08lx to RAM address %08lx\n", img_addr, ram_addr);
772 
773 		buf = map_sysmem(ram_addr, 0);
774 		read_dataflash(img_addr, h_size, buf);
775 
776 		/* get data size */
777 		switch (genimg_get_format(buf)) {
778 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
779 		case IMAGE_FORMAT_LEGACY:
780 			d_size = image_get_data_size(buf);
781 			debug("   Legacy format image found at 0x%08lx, "
782 					"size 0x%08lx\n",
783 					ram_addr, d_size);
784 			break;
785 #endif
786 #if defined(CONFIG_FIT)
787 		case IMAGE_FORMAT_FIT:
788 			d_size = fit_get_size(buf) - h_size;
789 			debug("   FIT/FDT format image found at 0x%08lx, "
790 					"size 0x%08lx\n",
791 					ram_addr, d_size);
792 			break;
793 #endif
794 		default:
795 			printf("   No valid image found at 0x%08lx\n",
796 				img_addr);
797 			return ram_addr;
798 		}
799 
800 		/* read in image data */
801 		debug("   Reading image remaining data from dataflash address "
802 			"%08lx to RAM address %08lx\n", img_addr + h_size,
803 			ram_addr + h_size);
804 
805 		read_dataflash(img_addr + h_size, d_size,
806 				(char *)(buf + h_size));
807 
808 	}
809 #endif /* CONFIG_HAS_DATAFLASH */
810 
811 	return ram_addr;
812 }
813 
814 /**
815  * fit_has_config - check if there is a valid FIT configuration
816  * @images: pointer to the bootm command headers structure
817  *
818  * fit_has_config() checks if there is a FIT configuration in use
819  * (if FTI support is present).
820  *
821  * returns:
822  *     0, no FIT support or no configuration found
823  *     1, configuration found
824  */
825 int genimg_has_config(bootm_headers_t *images)
826 {
827 #if defined(CONFIG_FIT)
828 	if (images->fit_uname_cfg)
829 		return 1;
830 #endif
831 	return 0;
832 }
833 
834 /**
835  * boot_get_ramdisk - main ramdisk handling routine
836  * @argc: command argument count
837  * @argv: command argument list
838  * @images: pointer to the bootm images structure
839  * @arch: expected ramdisk architecture
840  * @rd_start: pointer to a ulong variable, will hold ramdisk start address
841  * @rd_end: pointer to a ulong variable, will hold ramdisk end
842  *
843  * boot_get_ramdisk() is responsible for finding a valid ramdisk image.
844  * Curently supported are the following ramdisk sources:
845  *      - multicomponent kernel/ramdisk image,
846  *      - commandline provided address of decicated ramdisk image.
847  *
848  * returns:
849  *     0, if ramdisk image was found and valid, or skiped
850  *     rd_start and rd_end are set to ramdisk start/end addresses if
851  *     ramdisk image is found and valid
852  *
853  *     1, if ramdisk image is found but corrupted, or invalid
854  *     rd_start and rd_end are set to 0 if no ramdisk exists
855  */
856 int boot_get_ramdisk(int argc, char * const argv[], bootm_headers_t *images,
857 		uint8_t arch, ulong *rd_start, ulong *rd_end)
858 {
859 	ulong rd_addr, rd_load;
860 	ulong rd_data, rd_len;
861 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
862 	const image_header_t *rd_hdr;
863 #endif
864 	void *buf;
865 #ifdef CONFIG_SUPPORT_RAW_INITRD
866 	char *end;
867 #endif
868 #if defined(CONFIG_FIT)
869 	const char	*fit_uname_config = images->fit_uname_cfg;
870 	const char	*fit_uname_ramdisk = NULL;
871 	ulong		default_addr;
872 	int		rd_noffset;
873 #endif
874 	const char *select = NULL;
875 
876 	*rd_start = 0;
877 	*rd_end = 0;
878 
879 	if (argc >= 2)
880 		select = argv[1];
881 	/*
882 	 * Look for a '-' which indicates to ignore the
883 	 * ramdisk argument
884 	 */
885 	if (select && strcmp(select, "-") ==  0) {
886 		debug("## Skipping init Ramdisk\n");
887 		rd_len = rd_data = 0;
888 	} else if (select || genimg_has_config(images)) {
889 #if defined(CONFIG_FIT)
890 		if (select) {
891 			/*
892 			 * If the init ramdisk comes from the FIT image and
893 			 * the FIT image address is omitted in the command
894 			 * line argument, try to use os FIT image address or
895 			 * default load address.
896 			 */
897 			if (images->fit_uname_os)
898 				default_addr = (ulong)images->fit_hdr_os;
899 			else
900 				default_addr = load_addr;
901 
902 			if (fit_parse_conf(select, default_addr,
903 					   &rd_addr, &fit_uname_config)) {
904 				debug("*  ramdisk: config '%s' from image at "
905 						"0x%08lx\n",
906 						fit_uname_config, rd_addr);
907 			} else if (fit_parse_subimage(select, default_addr,
908 						&rd_addr, &fit_uname_ramdisk)) {
909 				debug("*  ramdisk: subimage '%s' from image at "
910 						"0x%08lx\n",
911 						fit_uname_ramdisk, rd_addr);
912 			} else
913 #endif
914 			{
915 				rd_addr = simple_strtoul(select, NULL, 16);
916 				debug("*  ramdisk: cmdline image address = "
917 						"0x%08lx\n",
918 						rd_addr);
919 			}
920 #if defined(CONFIG_FIT)
921 		} else {
922 			/* use FIT configuration provided in first bootm
923 			 * command argument. If the property is not defined,
924 			 * quit silently.
925 			 */
926 			rd_addr = map_to_sysmem(images->fit_hdr_os);
927 			rd_noffset = fit_get_node_from_config(images,
928 					FIT_RAMDISK_PROP, rd_addr);
929 			if (rd_noffset == -ENOLINK)
930 				return 0;
931 			else if (rd_noffset < 0)
932 				return 1;
933 		}
934 #endif
935 
936 		/* copy from dataflash if needed */
937 		rd_addr = genimg_get_image(rd_addr);
938 
939 		/*
940 		 * Check if there is an initrd image at the
941 		 * address provided in the second bootm argument
942 		 * check image type, for FIT images get FIT node.
943 		 */
944 		buf = map_sysmem(rd_addr, 0);
945 		switch (genimg_get_format(buf)) {
946 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
947 		case IMAGE_FORMAT_LEGACY:
948 			printf("## Loading init Ramdisk from Legacy "
949 					"Image at %08lx ...\n", rd_addr);
950 
951 			bootstage_mark(BOOTSTAGE_ID_CHECK_RAMDISK);
952 			rd_hdr = image_get_ramdisk(rd_addr, arch,
953 							images->verify);
954 
955 			if (rd_hdr == NULL)
956 				return 1;
957 
958 			rd_data = image_get_data(rd_hdr);
959 			rd_len = image_get_data_size(rd_hdr);
960 			rd_load = image_get_load(rd_hdr);
961 			break;
962 #endif
963 #if defined(CONFIG_FIT)
964 		case IMAGE_FORMAT_FIT:
965 			rd_noffset = fit_image_load(images,
966 					rd_addr, &fit_uname_ramdisk,
967 					&fit_uname_config, arch,
968 					IH_TYPE_RAMDISK,
969 					BOOTSTAGE_ID_FIT_RD_START,
970 					FIT_LOAD_OPTIONAL_NON_ZERO,
971 					&rd_data, &rd_len);
972 			if (rd_noffset < 0)
973 				return 1;
974 
975 			images->fit_hdr_rd = map_sysmem(rd_addr, 0);
976 			images->fit_uname_rd = fit_uname_ramdisk;
977 			images->fit_noffset_rd = rd_noffset;
978 			break;
979 #endif
980 		default:
981 #ifdef CONFIG_SUPPORT_RAW_INITRD
982 			end = NULL;
983 			if (select)
984 				end = strchr(select, ':');
985 			if (end) {
986 				rd_len = simple_strtoul(++end, NULL, 16);
987 				rd_data = rd_addr;
988 			} else
989 #endif
990 			{
991 				puts("Wrong Ramdisk Image Format\n");
992 				rd_data = rd_len = rd_load = 0;
993 				return 1;
994 			}
995 		}
996 	} else if (images->legacy_hdr_valid &&
997 			image_check_type(&images->legacy_hdr_os_copy,
998 						IH_TYPE_MULTI)) {
999 
1000 		/*
1001 		 * Now check if we have a legacy mult-component image,
1002 		 * get second entry data start address and len.
1003 		 */
1004 		bootstage_mark(BOOTSTAGE_ID_RAMDISK);
1005 		printf("## Loading init Ramdisk from multi component "
1006 				"Legacy Image at %08lx ...\n",
1007 				(ulong)images->legacy_hdr_os);
1008 
1009 		image_multi_getimg(images->legacy_hdr_os, 1, &rd_data, &rd_len);
1010 	}
1011 #ifdef CONFIG_ANDROID_BOOT_IMAGE
1012 	else if ((genimg_get_format(images) == IMAGE_FORMAT_ANDROID) &&
1013 		 (!android_image_get_ramdisk((void *)images->os.start,
1014 		 &rd_data, &rd_len))) {
1015 		/* empty */
1016 	}
1017 #endif
1018 	else {
1019 		/*
1020 		 * no initrd image
1021 		 */
1022 		bootstage_mark(BOOTSTAGE_ID_NO_RAMDISK);
1023 		rd_len = rd_data = 0;
1024 	}
1025 
1026 	if (!rd_data) {
1027 		debug("## No init Ramdisk\n");
1028 	} else {
1029 		*rd_start = rd_data;
1030 		*rd_end = rd_data + rd_len;
1031 	}
1032 	debug("   ramdisk start = 0x%08lx, ramdisk end = 0x%08lx\n",
1033 			*rd_start, *rd_end);
1034 
1035 	return 0;
1036 }
1037 
1038 #ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH
1039 /**
1040  * boot_ramdisk_high - relocate init ramdisk
1041  * @lmb: pointer to lmb handle, will be used for memory mgmt
1042  * @rd_data: ramdisk data start address
1043  * @rd_len: ramdisk data length
1044  * @initrd_start: pointer to a ulong variable, will hold final init ramdisk
1045  *      start address (after possible relocation)
1046  * @initrd_end: pointer to a ulong variable, will hold final init ramdisk
1047  *      end address (after possible relocation)
1048  *
1049  * boot_ramdisk_high() takes a relocation hint from "initrd_high" environment
1050  * variable and if requested ramdisk data is moved to a specified location.
1051  *
1052  * Initrd_start and initrd_end are set to final (after relocation) ramdisk
1053  * start/end addresses if ramdisk image start and len were provided,
1054  * otherwise set initrd_start and initrd_end set to zeros.
1055  *
1056  * returns:
1057  *      0 - success
1058  *     -1 - failure
1059  */
1060 int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len,
1061 		  ulong *initrd_start, ulong *initrd_end)
1062 {
1063 	char	*s;
1064 	ulong	initrd_high;
1065 	int	initrd_copy_to_ram = 1;
1066 
1067 	if ((s = getenv("initrd_high")) != NULL) {
1068 		/* a value of "no" or a similar string will act like 0,
1069 		 * turning the "load high" feature off. This is intentional.
1070 		 */
1071 		initrd_high = simple_strtoul(s, NULL, 16);
1072 		if (initrd_high == ~0)
1073 			initrd_copy_to_ram = 0;
1074 	} else {
1075 		/* not set, no restrictions to load high */
1076 		initrd_high = ~0;
1077 	}
1078 
1079 
1080 #ifdef CONFIG_LOGBUFFER
1081 	/* Prevent initrd from overwriting logbuffer */
1082 	lmb_reserve(lmb, logbuffer_base() - LOGBUFF_OVERHEAD, LOGBUFF_RESERVE);
1083 #endif
1084 
1085 	debug("## initrd_high = 0x%08lx, copy_to_ram = %d\n",
1086 			initrd_high, initrd_copy_to_ram);
1087 
1088 	if (rd_data) {
1089 		if (!initrd_copy_to_ram) {	/* zero-copy ramdisk support */
1090 			debug("   in-place initrd\n");
1091 			*initrd_start = rd_data;
1092 			*initrd_end = rd_data + rd_len;
1093 			lmb_reserve(lmb, rd_data, rd_len);
1094 		} else {
1095 			if (initrd_high)
1096 				*initrd_start = (ulong)lmb_alloc_base(lmb,
1097 						rd_len, 0x1000, initrd_high);
1098 			else
1099 				*initrd_start = (ulong)lmb_alloc(lmb, rd_len,
1100 								 0x1000);
1101 
1102 			if (*initrd_start == 0) {
1103 				puts("ramdisk - allocation error\n");
1104 				goto error;
1105 			}
1106 			bootstage_mark(BOOTSTAGE_ID_COPY_RAMDISK);
1107 
1108 			*initrd_end = *initrd_start + rd_len;
1109 			printf("   Loading Ramdisk to %08lx, end %08lx ... ",
1110 					*initrd_start, *initrd_end);
1111 
1112 			memmove_wd((void *)*initrd_start,
1113 					(void *)rd_data, rd_len, CHUNKSZ);
1114 
1115 #ifdef CONFIG_MP
1116 			/*
1117 			 * Ensure the image is flushed to memory to handle
1118 			 * AMP boot scenarios in which we might not be
1119 			 * HW cache coherent
1120 			 */
1121 			flush_cache((unsigned long)*initrd_start, rd_len);
1122 #endif
1123 			puts("OK\n");
1124 		}
1125 	} else {
1126 		*initrd_start = 0;
1127 		*initrd_end = 0;
1128 	}
1129 	debug("   ramdisk load start = 0x%08lx, ramdisk load end = 0x%08lx\n",
1130 			*initrd_start, *initrd_end);
1131 
1132 	return 0;
1133 
1134 error:
1135 	return -1;
1136 }
1137 #endif /* CONFIG_SYS_BOOT_RAMDISK_HIGH */
1138 
1139 #ifdef CONFIG_SYS_BOOT_GET_CMDLINE
1140 /**
1141  * boot_get_cmdline - allocate and initialize kernel cmdline
1142  * @lmb: pointer to lmb handle, will be used for memory mgmt
1143  * @cmd_start: pointer to a ulong variable, will hold cmdline start
1144  * @cmd_end: pointer to a ulong variable, will hold cmdline end
1145  *
1146  * boot_get_cmdline() allocates space for kernel command line below
1147  * BOOTMAPSZ + getenv_bootm_low() address. If "bootargs" U-boot environemnt
1148  * variable is present its contents is copied to allocated kernel
1149  * command line.
1150  *
1151  * returns:
1152  *      0 - success
1153  *     -1 - failure
1154  */
1155 int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end)
1156 {
1157 	char *cmdline;
1158 	char *s;
1159 
1160 	cmdline = (char *)(ulong)lmb_alloc_base(lmb, CONFIG_SYS_BARGSIZE, 0xf,
1161 				getenv_bootm_mapsize() + getenv_bootm_low());
1162 
1163 	if (cmdline == NULL)
1164 		return -1;
1165 
1166 	if ((s = getenv("bootargs")) == NULL)
1167 		s = "";
1168 
1169 	strcpy(cmdline, s);
1170 
1171 	*cmd_start = (ulong) & cmdline[0];
1172 	*cmd_end = *cmd_start + strlen(cmdline);
1173 
1174 	debug("## cmdline at 0x%08lx ... 0x%08lx\n", *cmd_start, *cmd_end);
1175 
1176 	return 0;
1177 }
1178 #endif /* CONFIG_SYS_BOOT_GET_CMDLINE */
1179 
1180 #ifdef CONFIG_SYS_BOOT_GET_KBD
1181 /**
1182  * boot_get_kbd - allocate and initialize kernel copy of board info
1183  * @lmb: pointer to lmb handle, will be used for memory mgmt
1184  * @kbd: double pointer to board info data
1185  *
1186  * boot_get_kbd() allocates space for kernel copy of board info data below
1187  * BOOTMAPSZ + getenv_bootm_low() address and kernel board info is initialized
1188  * with the current u-boot board info data.
1189  *
1190  * returns:
1191  *      0 - success
1192  *     -1 - failure
1193  */
1194 int boot_get_kbd(struct lmb *lmb, bd_t **kbd)
1195 {
1196 	*kbd = (bd_t *)(ulong)lmb_alloc_base(lmb, sizeof(bd_t), 0xf,
1197 				getenv_bootm_mapsize() + getenv_bootm_low());
1198 	if (*kbd == NULL)
1199 		return -1;
1200 
1201 	**kbd = *(gd->bd);
1202 
1203 	debug("## kernel board info at 0x%08lx\n", (ulong)*kbd);
1204 
1205 #if defined(DEBUG) && defined(CONFIG_CMD_BDI)
1206 	do_bdinfo(NULL, 0, 0, NULL);
1207 #endif
1208 
1209 	return 0;
1210 }
1211 #endif /* CONFIG_SYS_BOOT_GET_KBD */
1212 
1213 #ifdef CONFIG_LMB
1214 int image_setup_linux(bootm_headers_t *images)
1215 {
1216 	ulong of_size = images->ft_len;
1217 	char **of_flat_tree = &images->ft_addr;
1218 	ulong *initrd_start = &images->initrd_start;
1219 	ulong *initrd_end = &images->initrd_end;
1220 	struct lmb *lmb = &images->lmb;
1221 	ulong rd_len;
1222 	int ret;
1223 
1224 	if (IMAGE_ENABLE_OF_LIBFDT)
1225 		boot_fdt_add_mem_rsv_regions(lmb, *of_flat_tree);
1226 
1227 	if (IMAGE_BOOT_GET_CMDLINE) {
1228 		ret = boot_get_cmdline(lmb, &images->cmdline_start,
1229 				&images->cmdline_end);
1230 		if (ret) {
1231 			puts("ERROR with allocation of cmdline\n");
1232 			return ret;
1233 		}
1234 	}
1235 	if (IMAGE_ENABLE_RAMDISK_HIGH) {
1236 		rd_len = images->rd_end - images->rd_start;
1237 		ret = boot_ramdisk_high(lmb, images->rd_start, rd_len,
1238 				initrd_start, initrd_end);
1239 		if (ret)
1240 			return ret;
1241 	}
1242 
1243 	if (IMAGE_ENABLE_OF_LIBFDT) {
1244 		ret = boot_relocate_fdt(lmb, of_flat_tree, &of_size);
1245 		if (ret)
1246 			return ret;
1247 	}
1248 
1249 	if (IMAGE_ENABLE_OF_LIBFDT && of_size) {
1250 		ret = image_setup_libfdt(images, *of_flat_tree, of_size, lmb);
1251 		if (ret)
1252 			return ret;
1253 	}
1254 
1255 	return 0;
1256 }
1257 #endif /* CONFIG_LMB */
1258 #endif /* !USE_HOSTCC */
1259