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