xref: /openbmc/u-boot/common/image.c (revision c346e466)
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 #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_format - get image format type
647  * @img_addr: image start address
648  *
649  * genimg_get_format() checks whether provided address points to a valid
650  * legacy or FIT image.
651  *
652  * New uImage format and FDT blob are based on a libfdt. FDT blob
653  * may be passed directly or embedded in a FIT image. In both situations
654  * genimg_get_format() must be able to dectect libfdt header.
655  *
656  * returns:
657  *     image format type or IMAGE_FORMAT_INVALID if no image is present
658  */
659 int genimg_get_format(const void *img_addr)
660 {
661 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
662 	const image_header_t *hdr;
663 
664 	hdr = (const image_header_t *)img_addr;
665 	if (image_check_magic(hdr))
666 		return IMAGE_FORMAT_LEGACY;
667 #endif
668 #if defined(CONFIG_FIT) || defined(CONFIG_OF_LIBFDT)
669 	if (fdt_check_header(img_addr) == 0)
670 		return IMAGE_FORMAT_FIT;
671 #endif
672 #ifdef CONFIG_ANDROID_BOOT_IMAGE
673 	if (android_image_check_header(img_addr) == 0)
674 		return IMAGE_FORMAT_ANDROID;
675 #endif
676 
677 	return IMAGE_FORMAT_INVALID;
678 }
679 
680 /**
681  * genimg_get_image - get image from special storage (if necessary)
682  * @img_addr: image start address
683  *
684  * genimg_get_image() checks if provided image start adddress is located
685  * in a dataflash storage. If so, image is moved to a system RAM memory.
686  *
687  * returns:
688  *     image start address after possible relocation from special storage
689  */
690 ulong genimg_get_image(ulong img_addr)
691 {
692 	ulong ram_addr = img_addr;
693 
694 #ifdef CONFIG_HAS_DATAFLASH
695 	ulong h_size, d_size;
696 
697 	if (addr_dataflash(img_addr)) {
698 		void *buf;
699 
700 		/* ger RAM address */
701 		ram_addr = CONFIG_SYS_LOAD_ADDR;
702 
703 		/* get header size */
704 		h_size = image_get_header_size();
705 #if defined(CONFIG_FIT)
706 		if (sizeof(struct fdt_header) > h_size)
707 			h_size = sizeof(struct fdt_header);
708 #endif
709 
710 		/* read in header */
711 		debug("   Reading image header from dataflash address "
712 			"%08lx to RAM address %08lx\n", img_addr, ram_addr);
713 
714 		buf = map_sysmem(ram_addr, 0);
715 		read_dataflash(img_addr, h_size, buf);
716 
717 		/* get data size */
718 		switch (genimg_get_format(buf)) {
719 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
720 		case IMAGE_FORMAT_LEGACY:
721 			d_size = image_get_data_size(buf);
722 			debug("   Legacy format image found at 0x%08lx, "
723 					"size 0x%08lx\n",
724 					ram_addr, d_size);
725 			break;
726 #endif
727 #if defined(CONFIG_FIT)
728 		case IMAGE_FORMAT_FIT:
729 			d_size = fit_get_size(buf) - h_size;
730 			debug("   FIT/FDT format image found at 0x%08lx, "
731 					"size 0x%08lx\n",
732 					ram_addr, d_size);
733 			break;
734 #endif
735 		default:
736 			printf("   No valid image found at 0x%08lx\n",
737 				img_addr);
738 			return ram_addr;
739 		}
740 
741 		/* read in image data */
742 		debug("   Reading image remaining data from dataflash address "
743 			"%08lx to RAM address %08lx\n", img_addr + h_size,
744 			ram_addr + h_size);
745 
746 		read_dataflash(img_addr + h_size, d_size,
747 				(char *)(buf + h_size));
748 
749 	}
750 #endif /* CONFIG_HAS_DATAFLASH */
751 
752 	return ram_addr;
753 }
754 
755 /**
756  * fit_has_config - check if there is a valid FIT configuration
757  * @images: pointer to the bootm command headers structure
758  *
759  * fit_has_config() checks if there is a FIT configuration in use
760  * (if FTI support is present).
761  *
762  * returns:
763  *     0, no FIT support or no configuration found
764  *     1, configuration found
765  */
766 int genimg_has_config(bootm_headers_t *images)
767 {
768 #if defined(CONFIG_FIT)
769 	if (images->fit_uname_cfg)
770 		return 1;
771 #endif
772 	return 0;
773 }
774 
775 /**
776  * boot_get_ramdisk - main ramdisk handling routine
777  * @argc: command argument count
778  * @argv: command argument list
779  * @images: pointer to the bootm images structure
780  * @arch: expected ramdisk architecture
781  * @rd_start: pointer to a ulong variable, will hold ramdisk start address
782  * @rd_end: pointer to a ulong variable, will hold ramdisk end
783  *
784  * boot_get_ramdisk() is responsible for finding a valid ramdisk image.
785  * Curently supported are the following ramdisk sources:
786  *      - multicomponent kernel/ramdisk image,
787  *      - commandline provided address of decicated ramdisk image.
788  *
789  * returns:
790  *     0, if ramdisk image was found and valid, or skiped
791  *     rd_start and rd_end are set to ramdisk start/end addresses if
792  *     ramdisk image is found and valid
793  *
794  *     1, if ramdisk image is found but corrupted, or invalid
795  *     rd_start and rd_end are set to 0 if no ramdisk exists
796  */
797 int boot_get_ramdisk(int argc, char * const argv[], bootm_headers_t *images,
798 		uint8_t arch, ulong *rd_start, ulong *rd_end)
799 {
800 	ulong rd_addr, rd_load;
801 	ulong rd_data, rd_len;
802 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
803 	const image_header_t *rd_hdr;
804 #endif
805 	void *buf;
806 #ifdef CONFIG_SUPPORT_RAW_INITRD
807 	char *end;
808 #endif
809 #if defined(CONFIG_FIT)
810 	const char	*fit_uname_config = images->fit_uname_cfg;
811 	const char	*fit_uname_ramdisk = NULL;
812 	ulong		default_addr;
813 	int		rd_noffset;
814 #endif
815 	const char *select = NULL;
816 
817 	*rd_start = 0;
818 	*rd_end = 0;
819 
820 	if (argc >= 2)
821 		select = argv[1];
822 	/*
823 	 * Look for a '-' which indicates to ignore the
824 	 * ramdisk argument
825 	 */
826 	if (select && strcmp(select, "-") ==  0) {
827 		debug("## Skipping init Ramdisk\n");
828 		rd_len = rd_data = 0;
829 	} else if (select || genimg_has_config(images)) {
830 #if defined(CONFIG_FIT)
831 		if (select) {
832 			/*
833 			 * If the init ramdisk comes from the FIT image and
834 			 * the FIT image address is omitted in the command
835 			 * line argument, try to use os FIT image address or
836 			 * default load address.
837 			 */
838 			if (images->fit_uname_os)
839 				default_addr = (ulong)images->fit_hdr_os;
840 			else
841 				default_addr = load_addr;
842 
843 			if (fit_parse_conf(select, default_addr,
844 					   &rd_addr, &fit_uname_config)) {
845 				debug("*  ramdisk: config '%s' from image at "
846 						"0x%08lx\n",
847 						fit_uname_config, rd_addr);
848 			} else if (fit_parse_subimage(select, default_addr,
849 						&rd_addr, &fit_uname_ramdisk)) {
850 				debug("*  ramdisk: subimage '%s' from image at "
851 						"0x%08lx\n",
852 						fit_uname_ramdisk, rd_addr);
853 			} else
854 #endif
855 			{
856 				rd_addr = simple_strtoul(select, NULL, 16);
857 				debug("*  ramdisk: cmdline image address = "
858 						"0x%08lx\n",
859 						rd_addr);
860 			}
861 #if defined(CONFIG_FIT)
862 		} else {
863 			/* use FIT configuration provided in first bootm
864 			 * command argument. If the property is not defined,
865 			 * quit silently.
866 			 */
867 			rd_addr = map_to_sysmem(images->fit_hdr_os);
868 			rd_noffset = fit_get_node_from_config(images,
869 					FIT_RAMDISK_PROP, rd_addr);
870 			if (rd_noffset == -ENOLINK)
871 				return 0;
872 			else if (rd_noffset < 0)
873 				return 1;
874 		}
875 #endif
876 
877 		/* copy from dataflash if needed */
878 		rd_addr = genimg_get_image(rd_addr);
879 
880 		/*
881 		 * Check if there is an initrd image at the
882 		 * address provided in the second bootm argument
883 		 * check image type, for FIT images get FIT node.
884 		 */
885 		buf = map_sysmem(rd_addr, 0);
886 		switch (genimg_get_format(buf)) {
887 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
888 		case IMAGE_FORMAT_LEGACY:
889 			printf("## Loading init Ramdisk from Legacy "
890 					"Image at %08lx ...\n", rd_addr);
891 
892 			bootstage_mark(BOOTSTAGE_ID_CHECK_RAMDISK);
893 			rd_hdr = image_get_ramdisk(rd_addr, arch,
894 							images->verify);
895 
896 			if (rd_hdr == NULL)
897 				return 1;
898 
899 			rd_data = image_get_data(rd_hdr);
900 			rd_len = image_get_data_size(rd_hdr);
901 			rd_load = image_get_load(rd_hdr);
902 			break;
903 #endif
904 #if defined(CONFIG_FIT)
905 		case IMAGE_FORMAT_FIT:
906 			rd_noffset = fit_image_load(images, FIT_RAMDISK_PROP,
907 					rd_addr, &fit_uname_ramdisk,
908 					&fit_uname_config, arch,
909 					IH_TYPE_RAMDISK,
910 					BOOTSTAGE_ID_FIT_RD_START,
911 					FIT_LOAD_IGNORED, &rd_data, &rd_len);
912 			if (rd_noffset < 0)
913 				return 1;
914 
915 			images->fit_hdr_rd = map_sysmem(rd_addr, 0);
916 			images->fit_uname_rd = fit_uname_ramdisk;
917 			images->fit_noffset_rd = rd_noffset;
918 			break;
919 #endif
920 		default:
921 #ifdef CONFIG_SUPPORT_RAW_INITRD
922 			end = NULL;
923 			if (select)
924 				end = strchr(select, ':');
925 			if (end) {
926 				rd_len = simple_strtoul(++end, NULL, 16);
927 				rd_data = rd_addr;
928 			} else
929 #endif
930 			{
931 				puts("Wrong Ramdisk Image Format\n");
932 				rd_data = rd_len = rd_load = 0;
933 				return 1;
934 			}
935 		}
936 	} else if (images->legacy_hdr_valid &&
937 			image_check_type(&images->legacy_hdr_os_copy,
938 						IH_TYPE_MULTI)) {
939 
940 		/*
941 		 * Now check if we have a legacy mult-component image,
942 		 * get second entry data start address and len.
943 		 */
944 		bootstage_mark(BOOTSTAGE_ID_RAMDISK);
945 		printf("## Loading init Ramdisk from multi component "
946 				"Legacy Image at %08lx ...\n",
947 				(ulong)images->legacy_hdr_os);
948 
949 		image_multi_getimg(images->legacy_hdr_os, 1, &rd_data, &rd_len);
950 	}
951 #ifdef CONFIG_ANDROID_BOOT_IMAGE
952 	else if ((genimg_get_format(images) == IMAGE_FORMAT_ANDROID) &&
953 		 (!android_image_get_ramdisk((void *)images->os.start,
954 		 &rd_data, &rd_len))) {
955 		/* empty */
956 	}
957 #endif
958 	else {
959 		/*
960 		 * no initrd image
961 		 */
962 		bootstage_mark(BOOTSTAGE_ID_NO_RAMDISK);
963 		rd_len = rd_data = 0;
964 	}
965 
966 	if (!rd_data) {
967 		debug("## No init Ramdisk\n");
968 	} else {
969 		*rd_start = rd_data;
970 		*rd_end = rd_data + rd_len;
971 	}
972 	debug("   ramdisk start = 0x%08lx, ramdisk end = 0x%08lx\n",
973 			*rd_start, *rd_end);
974 
975 	return 0;
976 }
977 
978 #ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH
979 /**
980  * boot_ramdisk_high - relocate init ramdisk
981  * @lmb: pointer to lmb handle, will be used for memory mgmt
982  * @rd_data: ramdisk data start address
983  * @rd_len: ramdisk data length
984  * @initrd_start: pointer to a ulong variable, will hold final init ramdisk
985  *      start address (after possible relocation)
986  * @initrd_end: pointer to a ulong variable, will hold final init ramdisk
987  *      end address (after possible relocation)
988  *
989  * boot_ramdisk_high() takes a relocation hint from "initrd_high" environment
990  * variable and if requested ramdisk data is moved to a specified location.
991  *
992  * Initrd_start and initrd_end are set to final (after relocation) ramdisk
993  * start/end addresses if ramdisk image start and len were provided,
994  * otherwise set initrd_start and initrd_end set to zeros.
995  *
996  * returns:
997  *      0 - success
998  *     -1 - failure
999  */
1000 int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len,
1001 		  ulong *initrd_start, ulong *initrd_end)
1002 {
1003 	char	*s;
1004 	ulong	initrd_high;
1005 	int	initrd_copy_to_ram = 1;
1006 
1007 	if ((s = getenv("initrd_high")) != NULL) {
1008 		/* a value of "no" or a similar string will act like 0,
1009 		 * turning the "load high" feature off. This is intentional.
1010 		 */
1011 		initrd_high = simple_strtoul(s, NULL, 16);
1012 		if (initrd_high == ~0)
1013 			initrd_copy_to_ram = 0;
1014 	} else {
1015 		/* not set, no restrictions to load high */
1016 		initrd_high = ~0;
1017 	}
1018 
1019 
1020 #ifdef CONFIG_LOGBUFFER
1021 	/* Prevent initrd from overwriting logbuffer */
1022 	lmb_reserve(lmb, logbuffer_base() - LOGBUFF_OVERHEAD, LOGBUFF_RESERVE);
1023 #endif
1024 
1025 	debug("## initrd_high = 0x%08lx, copy_to_ram = %d\n",
1026 			initrd_high, initrd_copy_to_ram);
1027 
1028 	if (rd_data) {
1029 		if (!initrd_copy_to_ram) {	/* zero-copy ramdisk support */
1030 			debug("   in-place initrd\n");
1031 			*initrd_start = rd_data;
1032 			*initrd_end = rd_data + rd_len;
1033 			lmb_reserve(lmb, rd_data, rd_len);
1034 		} else {
1035 			if (initrd_high)
1036 				*initrd_start = (ulong)lmb_alloc_base(lmb,
1037 						rd_len, 0x1000, initrd_high);
1038 			else
1039 				*initrd_start = (ulong)lmb_alloc(lmb, rd_len,
1040 								 0x1000);
1041 
1042 			if (*initrd_start == 0) {
1043 				puts("ramdisk - allocation error\n");
1044 				goto error;
1045 			}
1046 			bootstage_mark(BOOTSTAGE_ID_COPY_RAMDISK);
1047 
1048 			*initrd_end = *initrd_start + rd_len;
1049 			printf("   Loading Ramdisk to %08lx, end %08lx ... ",
1050 					*initrd_start, *initrd_end);
1051 
1052 			memmove_wd((void *)*initrd_start,
1053 					(void *)rd_data, rd_len, CHUNKSZ);
1054 
1055 #ifdef CONFIG_MP
1056 			/*
1057 			 * Ensure the image is flushed to memory to handle
1058 			 * AMP boot scenarios in which we might not be
1059 			 * HW cache coherent
1060 			 */
1061 			flush_cache((unsigned long)*initrd_start, rd_len);
1062 #endif
1063 			puts("OK\n");
1064 		}
1065 	} else {
1066 		*initrd_start = 0;
1067 		*initrd_end = 0;
1068 	}
1069 	debug("   ramdisk load start = 0x%08lx, ramdisk load end = 0x%08lx\n",
1070 			*initrd_start, *initrd_end);
1071 
1072 	return 0;
1073 
1074 error:
1075 	return -1;
1076 }
1077 #endif /* CONFIG_SYS_BOOT_RAMDISK_HIGH */
1078 
1079 #ifdef CONFIG_SYS_BOOT_GET_CMDLINE
1080 /**
1081  * boot_get_cmdline - allocate and initialize kernel cmdline
1082  * @lmb: pointer to lmb handle, will be used for memory mgmt
1083  * @cmd_start: pointer to a ulong variable, will hold cmdline start
1084  * @cmd_end: pointer to a ulong variable, will hold cmdline end
1085  *
1086  * boot_get_cmdline() allocates space for kernel command line below
1087  * BOOTMAPSZ + getenv_bootm_low() address. If "bootargs" U-boot environemnt
1088  * variable is present its contents is copied to allocated kernel
1089  * command line.
1090  *
1091  * returns:
1092  *      0 - success
1093  *     -1 - failure
1094  */
1095 int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end)
1096 {
1097 	char *cmdline;
1098 	char *s;
1099 
1100 	cmdline = (char *)(ulong)lmb_alloc_base(lmb, CONFIG_SYS_BARGSIZE, 0xf,
1101 				getenv_bootm_mapsize() + getenv_bootm_low());
1102 
1103 	if (cmdline == NULL)
1104 		return -1;
1105 
1106 	if ((s = getenv("bootargs")) == NULL)
1107 		s = "";
1108 
1109 	strcpy(cmdline, s);
1110 
1111 	*cmd_start = (ulong) & cmdline[0];
1112 	*cmd_end = *cmd_start + strlen(cmdline);
1113 
1114 	debug("## cmdline at 0x%08lx ... 0x%08lx\n", *cmd_start, *cmd_end);
1115 
1116 	return 0;
1117 }
1118 #endif /* CONFIG_SYS_BOOT_GET_CMDLINE */
1119 
1120 #ifdef CONFIG_SYS_BOOT_GET_KBD
1121 /**
1122  * boot_get_kbd - allocate and initialize kernel copy of board info
1123  * @lmb: pointer to lmb handle, will be used for memory mgmt
1124  * @kbd: double pointer to board info data
1125  *
1126  * boot_get_kbd() allocates space for kernel copy of board info data below
1127  * BOOTMAPSZ + getenv_bootm_low() address and kernel board info is initialized
1128  * with the current u-boot board info data.
1129  *
1130  * returns:
1131  *      0 - success
1132  *     -1 - failure
1133  */
1134 int boot_get_kbd(struct lmb *lmb, bd_t **kbd)
1135 {
1136 	*kbd = (bd_t *)(ulong)lmb_alloc_base(lmb, sizeof(bd_t), 0xf,
1137 				getenv_bootm_mapsize() + getenv_bootm_low());
1138 	if (*kbd == NULL)
1139 		return -1;
1140 
1141 	**kbd = *(gd->bd);
1142 
1143 	debug("## kernel board info at 0x%08lx\n", (ulong)*kbd);
1144 
1145 #if defined(DEBUG) && defined(CONFIG_CMD_BDI)
1146 	do_bdinfo(NULL, 0, 0, NULL);
1147 #endif
1148 
1149 	return 0;
1150 }
1151 #endif /* CONFIG_SYS_BOOT_GET_KBD */
1152 
1153 #ifdef CONFIG_LMB
1154 int image_setup_linux(bootm_headers_t *images)
1155 {
1156 	ulong of_size = images->ft_len;
1157 	char **of_flat_tree = &images->ft_addr;
1158 	ulong *initrd_start = &images->initrd_start;
1159 	ulong *initrd_end = &images->initrd_end;
1160 	struct lmb *lmb = &images->lmb;
1161 	ulong rd_len;
1162 	int ret;
1163 
1164 	if (IMAGE_ENABLE_OF_LIBFDT)
1165 		boot_fdt_add_mem_rsv_regions(lmb, *of_flat_tree);
1166 
1167 	if (IMAGE_BOOT_GET_CMDLINE) {
1168 		ret = boot_get_cmdline(lmb, &images->cmdline_start,
1169 				&images->cmdline_end);
1170 		if (ret) {
1171 			puts("ERROR with allocation of cmdline\n");
1172 			return ret;
1173 		}
1174 	}
1175 	if (IMAGE_ENABLE_RAMDISK_HIGH) {
1176 		rd_len = images->rd_end - images->rd_start;
1177 		ret = boot_ramdisk_high(lmb, images->rd_start, rd_len,
1178 				initrd_start, initrd_end);
1179 		if (ret)
1180 			return ret;
1181 	}
1182 
1183 	if (IMAGE_ENABLE_OF_LIBFDT) {
1184 		ret = boot_relocate_fdt(lmb, of_flat_tree, &of_size);
1185 		if (ret)
1186 			return ret;
1187 	}
1188 
1189 	if (IMAGE_ENABLE_OF_LIBFDT && of_size) {
1190 		ret = image_setup_libfdt(images, *of_flat_tree, of_size, lmb);
1191 		if (ret)
1192 			return ret;
1193 	}
1194 
1195 	return 0;
1196 }
1197 #endif /* CONFIG_LMB */
1198 #endif /* !USE_HOSTCC */
1199