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