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