xref: /openbmc/u-boot/common/image.c (revision 699c4e59)
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 #include <mapmem.h>
31 
32 #if IMAGE_ENABLE_FIT || IMAGE_ENABLE_OF_LIBFDT
33 #include <libfdt.h>
34 #include <fdt_support.h>
35 #include <fpga.h>
36 #include <xilinx.h>
37 #endif
38 
39 #include <u-boot/md5.h>
40 #include <u-boot/sha1.h>
41 #include <asm/errno.h>
42 #include <asm/io.h>
43 
44 #ifdef CONFIG_CMD_BDI
45 extern int do_bdinfo(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
46 #endif
47 
48 DECLARE_GLOBAL_DATA_PTR;
49 
50 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
51 static const image_header_t *image_get_ramdisk(ulong rd_addr, uint8_t arch,
52 						int verify);
53 #endif
54 #else
55 #include "mkimage.h"
56 #include <u-boot/md5.h>
57 #include <time.h>
58 #include <image.h>
59 
60 #ifndef __maybe_unused
61 # define __maybe_unused		/* unimplemented */
62 #endif
63 #endif /* !USE_HOSTCC*/
64 
65 #include <u-boot/crc.h>
66 
67 #ifndef CONFIG_SYS_BARGSIZE
68 #define CONFIG_SYS_BARGSIZE 512
69 #endif
70 
71 static const table_entry_t uimage_arch[] = {
72 	{	IH_ARCH_INVALID,	"invalid",	"Invalid ARCH",	},
73 	{	IH_ARCH_ALPHA,		"alpha",	"Alpha",	},
74 	{	IH_ARCH_ARM,		"arm",		"ARM",		},
75 	{	IH_ARCH_I386,		"x86",		"Intel x86",	},
76 	{	IH_ARCH_IA64,		"ia64",		"IA64",		},
77 	{	IH_ARCH_M68K,		"m68k",		"M68K",		},
78 	{	IH_ARCH_MICROBLAZE,	"microblaze",	"MicroBlaze",	},
79 	{	IH_ARCH_MIPS,		"mips",		"MIPS",		},
80 	{	IH_ARCH_MIPS64,		"mips64",	"MIPS 64 Bit",	},
81 	{	IH_ARCH_NIOS2,		"nios2",	"NIOS II",	},
82 	{	IH_ARCH_PPC,		"powerpc",	"PowerPC",	},
83 	{	IH_ARCH_PPC,		"ppc",		"PowerPC",	},
84 	{	IH_ARCH_S390,		"s390",		"IBM S390",	},
85 	{	IH_ARCH_SH,		"sh",		"SuperH",	},
86 	{	IH_ARCH_SPARC,		"sparc",	"SPARC",	},
87 	{	IH_ARCH_SPARC64,	"sparc64",	"SPARC 64 Bit",	},
88 	{	IH_ARCH_BLACKFIN,	"blackfin",	"Blackfin",	},
89 	{	IH_ARCH_AVR32,		"avr32",	"AVR32",	},
90 	{	IH_ARCH_NDS32,		"nds32",	"NDS32",	},
91 	{	IH_ARCH_OPENRISC,	"or1k",		"OpenRISC 1000",},
92 	{	IH_ARCH_SANDBOX,	"sandbox",	"Sandbox",	},
93 	{	IH_ARCH_ARM64,		"arm64",	"AArch64",	},
94 	{	IH_ARCH_ARC,		"arc",		"ARC",		},
95 	{	IH_ARCH_X86_64,		"x86_64",	"AMD x86_64",	},
96 	{	-1,			"",		"",		},
97 };
98 
99 static const table_entry_t uimage_os[] = {
100 	{	IH_OS_INVALID,	"invalid",	"Invalid OS",		},
101 	{	IH_OS_LINUX,	"linux",	"Linux",		},
102 #if defined(CONFIG_LYNXKDI) || defined(USE_HOSTCC)
103 	{	IH_OS_LYNXOS,	"lynxos",	"LynxOS",		},
104 #endif
105 	{	IH_OS_NETBSD,	"netbsd",	"NetBSD",		},
106 	{	IH_OS_OSE,	"ose",		"Enea OSE",		},
107 	{	IH_OS_PLAN9,	"plan9",	"Plan 9",		},
108 	{	IH_OS_RTEMS,	"rtems",	"RTEMS",		},
109 	{	IH_OS_U_BOOT,	"u-boot",	"U-Boot",		},
110 	{	IH_OS_VXWORKS,	"vxworks",	"VxWorks",		},
111 #if defined(CONFIG_CMD_ELF) || defined(USE_HOSTCC)
112 	{	IH_OS_QNX,	"qnx",		"QNX",			},
113 #endif
114 #if defined(CONFIG_INTEGRITY) || defined(USE_HOSTCC)
115 	{	IH_OS_INTEGRITY,"integrity",	"INTEGRITY",		},
116 #endif
117 #ifdef USE_HOSTCC
118 	{	IH_OS_4_4BSD,	"4_4bsd",	"4_4BSD",		},
119 	{	IH_OS_DELL,	"dell",		"Dell",			},
120 	{	IH_OS_ESIX,	"esix",		"Esix",			},
121 	{	IH_OS_FREEBSD,	"freebsd",	"FreeBSD",		},
122 	{	IH_OS_IRIX,	"irix",		"Irix",			},
123 	{	IH_OS_NCR,	"ncr",		"NCR",			},
124 	{	IH_OS_OPENBSD,	"openbsd",	"OpenBSD",		},
125 	{	IH_OS_PSOS,	"psos",		"pSOS",			},
126 	{	IH_OS_SCO,	"sco",		"SCO",			},
127 	{	IH_OS_SOLARIS,	"solaris",	"Solaris",		},
128 	{	IH_OS_SVR4,	"svr4",		"SVR4",			},
129 #endif
130 #if defined(CONFIG_BOOTM_OPENRTOS) || defined(USE_HOSTCC)
131 	{	IH_OS_OPENRTOS,	"openrtos",	"OpenRTOS",		},
132 #endif
133 
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_GPIMAGE,    "gpimage",    "TI Keystone SPL Image",},
143 	{	IH_TYPE_KERNEL,	    "kernel",	  "Kernel Image",	},
144 	{	IH_TYPE_KERNEL_NOLOAD, "kernel_noload",  "Kernel Image (no loading done)", },
145 	{	IH_TYPE_KWBIMAGE,   "kwbimage",   "Kirkwood Boot Image",},
146 	{	IH_TYPE_IMXIMAGE,   "imximage",   "Freescale i.MX Boot Image",},
147 	{	IH_TYPE_INVALID,    "invalid",	  "Invalid Image",	},
148 	{	IH_TYPE_MULTI,	    "multi",	  "Multi-File Image",	},
149 	{	IH_TYPE_OMAPIMAGE,  "omapimage",  "TI OMAP SPL With GP CH",},
150 	{	IH_TYPE_PBLIMAGE,   "pblimage",   "Freescale PBL Boot Image",},
151 	{	IH_TYPE_RAMDISK,    "ramdisk",	  "RAMDisk Image",	},
152 	{	IH_TYPE_SCRIPT,     "script",	  "Script",		},
153 	{	IH_TYPE_SOCFPGAIMAGE, "socfpgaimage", "Altera SOCFPGA preloader",},
154 	{	IH_TYPE_STANDALONE, "standalone", "Standalone Program", },
155 	{	IH_TYPE_UBLIMAGE,   "ublimage",   "Davinci UBL image",},
156 	{	IH_TYPE_MXSIMAGE,   "mxsimage",   "Freescale MXS Boot Image",},
157 	{	IH_TYPE_ATMELIMAGE, "atmelimage", "ATMEL ROM-Boot Image",},
158 	{	IH_TYPE_X86_SETUP,  "x86_setup",  "x86 setup.bin",    },
159 	{	IH_TYPE_LPC32XXIMAGE, "lpc32xximage",  "LPC32XX Boot Image", },
160 	{	IH_TYPE_RKIMAGE,    "rkimage",    "Rockchip Boot Image" },
161 	{	IH_TYPE_RKSD,       "rksd",       "Rockchip SD Boot Image" },
162 	{	IH_TYPE_RKSPI,      "rkspi",      "Rockchip SPI Boot Image" },
163 	{	IH_TYPE_ZYNQIMAGE,  "zynqimage",  "Xilinx Zynq Boot Image" },
164 	{	IH_TYPE_ZYNQMPIMAGE, "zynqmpimage", "Xilinx ZynqMP Boot Image" },
165 	{	IH_TYPE_FPGA,       "fpga",       "FPGA Image" },
166 	{	-1,		    "",		  "",			},
167 };
168 
169 static const table_entry_t uimage_comp[] = {
170 	{	IH_COMP_NONE,	"none",		"uncompressed",		},
171 	{	IH_COMP_BZIP2,	"bzip2",	"bzip2 compressed",	},
172 	{	IH_COMP_GZIP,	"gzip",		"gzip compressed",	},
173 	{	IH_COMP_LZMA,	"lzma",		"lzma compressed",	},
174 	{	IH_COMP_LZO,	"lzo",		"lzo compressed",	},
175 	{	IH_COMP_LZ4,	"lz4",		"lz4 compressed",	},
176 	{	-1,		"",		"",			},
177 };
178 
179 struct table_info {
180 	const char *desc;
181 	int count;
182 	const table_entry_t *table;
183 };
184 
185 static const struct table_info table_info[IH_COUNT] = {
186 	{ "architecture", IH_ARCH_COUNT, uimage_arch },
187 	{ "compression", IH_COMP_COUNT, uimage_comp },
188 	{ "operating system", IH_OS_COUNT, uimage_os },
189 	{ "image type", IH_TYPE_COUNT, uimage_type },
190 };
191 
192 /*****************************************************************************/
193 /* Legacy format routines */
194 /*****************************************************************************/
195 int image_check_hcrc(const image_header_t *hdr)
196 {
197 	ulong hcrc;
198 	ulong len = image_get_header_size();
199 	image_header_t header;
200 
201 	/* Copy header so we can blank CRC field for re-calculation */
202 	memmove(&header, (char *)hdr, image_get_header_size());
203 	image_set_hcrc(&header, 0);
204 
205 	hcrc = crc32(0, (unsigned char *)&header, len);
206 
207 	return (hcrc == image_get_hcrc(hdr));
208 }
209 
210 int image_check_dcrc(const image_header_t *hdr)
211 {
212 	ulong data = image_get_data(hdr);
213 	ulong len = image_get_data_size(hdr);
214 	ulong dcrc = crc32_wd(0, (unsigned char *)data, len, CHUNKSZ_CRC32);
215 
216 	return (dcrc == image_get_dcrc(hdr));
217 }
218 
219 /**
220  * image_multi_count - get component (sub-image) count
221  * @hdr: pointer to the header of the multi component image
222  *
223  * image_multi_count() returns number of components in a multi
224  * component image.
225  *
226  * Note: no checking of the image type is done, caller must pass
227  * a valid multi component image.
228  *
229  * returns:
230  *     number of components
231  */
232 ulong image_multi_count(const image_header_t *hdr)
233 {
234 	ulong i, count = 0;
235 	uint32_t *size;
236 
237 	/* get start of the image payload, which in case of multi
238 	 * component images that points to a table of component sizes */
239 	size = (uint32_t *)image_get_data(hdr);
240 
241 	/* count non empty slots */
242 	for (i = 0; size[i]; ++i)
243 		count++;
244 
245 	return count;
246 }
247 
248 /**
249  * image_multi_getimg - get component data address and size
250  * @hdr: pointer to the header of the multi component image
251  * @idx: index of the requested component
252  * @data: pointer to a ulong variable, will hold component data address
253  * @len: pointer to a ulong variable, will hold component size
254  *
255  * image_multi_getimg() returns size and data address for the requested
256  * component in a multi component image.
257  *
258  * Note: no checking of the image type is done, caller must pass
259  * a valid multi component image.
260  *
261  * returns:
262  *     data address and size of the component, if idx is valid
263  *     0 in data and len, if idx is out of range
264  */
265 void image_multi_getimg(const image_header_t *hdr, ulong idx,
266 			ulong *data, ulong *len)
267 {
268 	int i;
269 	uint32_t *size;
270 	ulong offset, count, img_data;
271 
272 	/* get number of component */
273 	count = image_multi_count(hdr);
274 
275 	/* get start of the image payload, which in case of multi
276 	 * component images that points to a table of component sizes */
277 	size = (uint32_t *)image_get_data(hdr);
278 
279 	/* get address of the proper component data start, which means
280 	 * skipping sizes table (add 1 for last, null entry) */
281 	img_data = image_get_data(hdr) + (count + 1) * sizeof(uint32_t);
282 
283 	if (idx < count) {
284 		*len = uimage_to_cpu(size[idx]);
285 		offset = 0;
286 
287 		/* go over all indices preceding requested component idx */
288 		for (i = 0; i < idx; i++) {
289 			/* add up i-th component size, rounding up to 4 bytes */
290 			offset += (uimage_to_cpu(size[i]) + 3) & ~3 ;
291 		}
292 
293 		/* calculate idx-th component data address */
294 		*data = img_data + offset;
295 	} else {
296 		*len = 0;
297 		*data = 0;
298 	}
299 }
300 
301 static void image_print_type(const image_header_t *hdr)
302 {
303 	const char __maybe_unused *os, *arch, *type, *comp;
304 
305 	os = genimg_get_os_name(image_get_os(hdr));
306 	arch = genimg_get_arch_name(image_get_arch(hdr));
307 	type = genimg_get_type_name(image_get_type(hdr));
308 	comp = genimg_get_comp_name(image_get_comp(hdr));
309 
310 	printf("%s %s %s (%s)\n", arch, os, type, comp);
311 }
312 
313 /**
314  * image_print_contents - prints out the contents of the legacy format image
315  * @ptr: pointer to the legacy format image header
316  * @p: pointer to prefix string
317  *
318  * image_print_contents() formats a multi line legacy image contents description.
319  * The routine prints out all header fields followed by the size/offset data
320  * for MULTI/SCRIPT images.
321  *
322  * returns:
323  *     no returned results
324  */
325 void image_print_contents(const void *ptr)
326 {
327 	const image_header_t *hdr = (const image_header_t *)ptr;
328 	const char __maybe_unused *p;
329 
330 	p = IMAGE_INDENT_STRING;
331 	printf("%sImage Name:   %.*s\n", p, IH_NMLEN, image_get_name(hdr));
332 	if (IMAGE_ENABLE_TIMESTAMP) {
333 		printf("%sCreated:      ", p);
334 		genimg_print_time((time_t)image_get_time(hdr));
335 	}
336 	printf("%sImage Type:   ", p);
337 	image_print_type(hdr);
338 	printf("%sData Size:    ", p);
339 	genimg_print_size(image_get_data_size(hdr));
340 	printf("%sLoad Address: %08x\n", p, image_get_load(hdr));
341 	printf("%sEntry Point:  %08x\n", p, image_get_ep(hdr));
342 
343 	if (image_check_type(hdr, IH_TYPE_MULTI) ||
344 			image_check_type(hdr, IH_TYPE_SCRIPT)) {
345 		int i;
346 		ulong data, len;
347 		ulong count = image_multi_count(hdr);
348 
349 		printf("%sContents:\n", p);
350 		for (i = 0; i < count; i++) {
351 			image_multi_getimg(hdr, i, &data, &len);
352 
353 			printf("%s   Image %d: ", p, i);
354 			genimg_print_size(len);
355 
356 			if (image_check_type(hdr, IH_TYPE_SCRIPT) && i > 0) {
357 				/*
358 				 * the user may need to know offsets
359 				 * if planning to do something with
360 				 * multiple files
361 				 */
362 				printf("%s    Offset = 0x%08lx\n", p, data);
363 			}
364 		}
365 	}
366 }
367 
368 
369 #ifndef USE_HOSTCC
370 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
371 /**
372  * image_get_ramdisk - get and verify ramdisk image
373  * @rd_addr: ramdisk image start address
374  * @arch: expected ramdisk architecture
375  * @verify: checksum verification flag
376  *
377  * image_get_ramdisk() returns a pointer to the verified ramdisk image
378  * header. Routine receives image start address and expected architecture
379  * flag. Verification done covers data and header integrity and os/type/arch
380  * fields checking.
381  *
382  * If dataflash support is enabled routine checks for dataflash addresses
383  * and handles required dataflash reads.
384  *
385  * returns:
386  *     pointer to a ramdisk image header, if image was found and valid
387  *     otherwise, return NULL
388  */
389 static const image_header_t *image_get_ramdisk(ulong rd_addr, uint8_t arch,
390 						int verify)
391 {
392 	const image_header_t *rd_hdr = (const image_header_t *)rd_addr;
393 
394 	if (!image_check_magic(rd_hdr)) {
395 		puts("Bad Magic Number\n");
396 		bootstage_error(BOOTSTAGE_ID_RD_MAGIC);
397 		return NULL;
398 	}
399 
400 	if (!image_check_hcrc(rd_hdr)) {
401 		puts("Bad Header Checksum\n");
402 		bootstage_error(BOOTSTAGE_ID_RD_HDR_CHECKSUM);
403 		return NULL;
404 	}
405 
406 	bootstage_mark(BOOTSTAGE_ID_RD_MAGIC);
407 	image_print_contents(rd_hdr);
408 
409 	if (verify) {
410 		puts("   Verifying Checksum ... ");
411 		if (!image_check_dcrc(rd_hdr)) {
412 			puts("Bad Data CRC\n");
413 			bootstage_error(BOOTSTAGE_ID_RD_CHECKSUM);
414 			return NULL;
415 		}
416 		puts("OK\n");
417 	}
418 
419 	bootstage_mark(BOOTSTAGE_ID_RD_HDR_CHECKSUM);
420 
421 	if (!image_check_os(rd_hdr, IH_OS_LINUX) ||
422 	    !image_check_arch(rd_hdr, arch) ||
423 	    !image_check_type(rd_hdr, IH_TYPE_RAMDISK)) {
424 		printf("No Linux %s Ramdisk Image\n",
425 				genimg_get_arch_name(arch));
426 		bootstage_error(BOOTSTAGE_ID_RAMDISK);
427 		return NULL;
428 	}
429 
430 	return rd_hdr;
431 }
432 #endif
433 #endif /* !USE_HOSTCC */
434 
435 /*****************************************************************************/
436 /* Shared dual-format routines */
437 /*****************************************************************************/
438 #ifndef USE_HOSTCC
439 ulong load_addr = CONFIG_SYS_LOAD_ADDR;	/* Default Load Address */
440 ulong save_addr;			/* Default Save Address */
441 ulong save_size;			/* Default Save Size (in bytes) */
442 
443 static int on_loadaddr(const char *name, const char *value, enum env_op op,
444 	int flags)
445 {
446 	switch (op) {
447 	case env_op_create:
448 	case env_op_overwrite:
449 		load_addr = simple_strtoul(value, NULL, 16);
450 		break;
451 	default:
452 		break;
453 	}
454 
455 	return 0;
456 }
457 U_BOOT_ENV_CALLBACK(loadaddr, on_loadaddr);
458 
459 ulong getenv_bootm_low(void)
460 {
461 	char *s = getenv("bootm_low");
462 	if (s) {
463 		ulong tmp = simple_strtoul(s, NULL, 16);
464 		return tmp;
465 	}
466 
467 #if defined(CONFIG_SYS_SDRAM_BASE)
468 	return CONFIG_SYS_SDRAM_BASE;
469 #elif defined(CONFIG_ARM)
470 	return gd->bd->bi_dram[0].start;
471 #else
472 	return 0;
473 #endif
474 }
475 
476 phys_size_t getenv_bootm_size(void)
477 {
478 	phys_size_t tmp, size;
479 	phys_addr_t start;
480 	char *s = getenv("bootm_size");
481 	if (s) {
482 		tmp = (phys_size_t)simple_strtoull(s, NULL, 16);
483 		return tmp;
484 	}
485 
486 #if defined(CONFIG_ARM) && defined(CONFIG_NR_DRAM_BANKS)
487 	start = gd->bd->bi_dram[0].start;
488 	size = gd->bd->bi_dram[0].size;
489 #else
490 	start = gd->bd->bi_memstart;
491 	size = gd->bd->bi_memsize;
492 #endif
493 
494 	s = getenv("bootm_low");
495 	if (s)
496 		tmp = (phys_size_t)simple_strtoull(s, NULL, 16);
497 	else
498 		tmp = start;
499 
500 	return size - (tmp - start);
501 }
502 
503 phys_size_t getenv_bootm_mapsize(void)
504 {
505 	phys_size_t tmp;
506 	char *s = getenv("bootm_mapsize");
507 	if (s) {
508 		tmp = (phys_size_t)simple_strtoull(s, NULL, 16);
509 		return tmp;
510 	}
511 
512 #if defined(CONFIG_SYS_BOOTMAPSZ)
513 	return CONFIG_SYS_BOOTMAPSZ;
514 #else
515 	return getenv_bootm_size();
516 #endif
517 }
518 
519 void memmove_wd(void *to, void *from, size_t len, ulong chunksz)
520 {
521 	if (to == from)
522 		return;
523 
524 #if defined(CONFIG_HW_WATCHDOG) || defined(CONFIG_WATCHDOG)
525 	if (to > from) {
526 		from += len;
527 		to += len;
528 	}
529 	while (len > 0) {
530 		size_t tail = (len > chunksz) ? chunksz : len;
531 		WATCHDOG_RESET();
532 		if (to > from) {
533 			to -= tail;
534 			from -= tail;
535 		}
536 		memmove(to, from, tail);
537 		if (to < from) {
538 			to += tail;
539 			from += tail;
540 		}
541 		len -= tail;
542 	}
543 #else	/* !(CONFIG_HW_WATCHDOG || CONFIG_WATCHDOG) */
544 	memmove(to, from, len);
545 #endif	/* CONFIG_HW_WATCHDOG || CONFIG_WATCHDOG */
546 }
547 #endif /* !USE_HOSTCC */
548 
549 void genimg_print_size(uint32_t size)
550 {
551 #ifndef USE_HOSTCC
552 	printf("%d Bytes = ", size);
553 	print_size(size, "\n");
554 #else
555 	printf("%d Bytes = %.2f kB = %.2f MB\n",
556 			size, (double)size / 1.024e3,
557 			(double)size / 1.048576e6);
558 #endif
559 }
560 
561 #if IMAGE_ENABLE_TIMESTAMP
562 void genimg_print_time(time_t timestamp)
563 {
564 #ifndef USE_HOSTCC
565 	struct rtc_time tm;
566 
567 	rtc_to_tm(timestamp, &tm);
568 	printf("%4d-%02d-%02d  %2d:%02d:%02d UTC\n",
569 			tm.tm_year, tm.tm_mon, tm.tm_mday,
570 			tm.tm_hour, tm.tm_min, tm.tm_sec);
571 #else
572 	printf("%s", ctime(&timestamp));
573 #endif
574 }
575 #endif
576 
577 const table_entry_t *get_table_entry(const table_entry_t *table, int id)
578 {
579 	for (; table->id >= 0; ++table) {
580 		if (table->id == id)
581 			return table;
582 	}
583 	return NULL;
584 }
585 
586 static const char *unknown_msg(enum ih_category category)
587 {
588 	static char msg[30];
589 
590 	strcpy(msg, "Unknown ");
591 	strcat(msg, table_info[category].desc);
592 
593 	return msg;
594 }
595 
596 /**
597  * get_cat_table_entry_name - translate entry id to long name
598  * @category: category to look up (enum ih_category)
599  * @id: entry id to be translated
600  *
601  * This will scan the translation table trying to find the entry that matches
602  * the given id.
603  *
604  * @retur long entry name if translation succeeds; error string on failure
605  */
606 const char *genimg_get_cat_name(enum ih_category category, uint id)
607 {
608 	const table_entry_t *entry;
609 
610 	entry = get_table_entry(table_info[category].table, id);
611 	if (!entry)
612 		return unknown_msg(category);
613 #if defined(USE_HOSTCC) || !defined(CONFIG_NEEDS_MANUAL_RELOC)
614 	return entry->lname;
615 #else
616 	return entry->lname + gd->reloc_off;
617 #endif
618 }
619 
620 /**
621  * get_cat_table_entry_short_name - translate entry id to short name
622  * @category: category to look up (enum ih_category)
623  * @id: entry id to be translated
624  *
625  * This will scan the translation table trying to find the entry that matches
626  * the given id.
627  *
628  * @retur short entry name if translation succeeds; error string on failure
629  */
630 const char *genimg_get_cat_short_name(enum ih_category category, uint id)
631 {
632 	const table_entry_t *entry;
633 
634 	entry = get_table_entry(table_info[category].table, id);
635 	if (!entry)
636 		return unknown_msg(category);
637 #if defined(USE_HOSTCC) || !defined(CONFIG_NEEDS_MANUAL_RELOC)
638 	return entry->sname;
639 #else
640 	return entry->sname + gd->reloc_off;
641 #endif
642 }
643 
644 int genimg_get_cat_count(enum ih_category category)
645 {
646 	return table_info[category].count;
647 }
648 
649 const char *genimg_get_cat_desc(enum ih_category category)
650 {
651 	return table_info[category].desc;
652 }
653 
654 /**
655  * get_table_entry_name - translate entry id to long name
656  * @table: pointer to a translation table for entries of a specific type
657  * @msg: message to be returned when translation fails
658  * @id: entry id to be translated
659  *
660  * get_table_entry_name() will go over translation table trying to find
661  * entry that matches given id. If matching entry is found, its long
662  * name is returned to the caller.
663  *
664  * returns:
665  *     long entry name if translation succeeds
666  *     msg otherwise
667  */
668 char *get_table_entry_name(const table_entry_t *table, char *msg, int id)
669 {
670 	table = get_table_entry(table, id);
671 	if (!table)
672 		return msg;
673 #if defined(USE_HOSTCC) || !defined(CONFIG_NEEDS_MANUAL_RELOC)
674 	return table->lname;
675 #else
676 	return table->lname + gd->reloc_off;
677 #endif
678 }
679 
680 const char *genimg_get_os_name(uint8_t os)
681 {
682 	return (get_table_entry_name(uimage_os, "Unknown OS", os));
683 }
684 
685 const char *genimg_get_arch_name(uint8_t arch)
686 {
687 	return (get_table_entry_name(uimage_arch, "Unknown Architecture",
688 					arch));
689 }
690 
691 const char *genimg_get_type_name(uint8_t type)
692 {
693 	return (get_table_entry_name(uimage_type, "Unknown Image", type));
694 }
695 
696 static const char *genimg_get_short_name(const table_entry_t *table, int val)
697 {
698 	table = get_table_entry(table, val);
699 	if (!table)
700 		return "unknown";
701 #if defined(USE_HOSTCC) || !defined(CONFIG_NEEDS_MANUAL_RELOC)
702 	return table->sname;
703 #else
704 	return table->sname + gd->reloc_off;
705 #endif
706 }
707 
708 const char *genimg_get_type_short_name(uint8_t type)
709 {
710 	return genimg_get_short_name(uimage_type, type);
711 }
712 
713 const char *genimg_get_comp_name(uint8_t comp)
714 {
715 	return (get_table_entry_name(uimage_comp, "Unknown Compression",
716 					comp));
717 }
718 
719 const char *genimg_get_comp_short_name(uint8_t comp)
720 {
721 	return genimg_get_short_name(uimage_comp, comp);
722 }
723 
724 const char *genimg_get_os_short_name(uint8_t os)
725 {
726 	return genimg_get_short_name(uimage_os, os);
727 }
728 
729 const char *genimg_get_arch_short_name(uint8_t arch)
730 {
731 	return genimg_get_short_name(uimage_arch, arch);
732 }
733 
734 /**
735  * get_table_entry_id - translate short entry name to id
736  * @table: pointer to a translation table for entries of a specific type
737  * @table_name: to be used in case of error
738  * @name: entry short name to be translated
739  *
740  * get_table_entry_id() will go over translation table trying to find
741  * entry that matches given short name. If matching entry is found,
742  * its id returned to the caller.
743  *
744  * returns:
745  *     entry id if translation succeeds
746  *     -1 otherwise
747  */
748 int get_table_entry_id(const table_entry_t *table,
749 		const char *table_name, const char *name)
750 {
751 	const table_entry_t *t;
752 
753 	for (t = table; t->id >= 0; ++t) {
754 #ifdef CONFIG_NEEDS_MANUAL_RELOC
755 		if (t->sname && strcasecmp(t->sname + gd->reloc_off, name) == 0)
756 #else
757 		if (t->sname && strcasecmp(t->sname, name) == 0)
758 #endif
759 			return (t->id);
760 	}
761 	debug("Invalid %s Type: %s\n", table_name, name);
762 
763 	return -1;
764 }
765 
766 int genimg_get_os_id(const char *name)
767 {
768 	return (get_table_entry_id(uimage_os, "OS", name));
769 }
770 
771 int genimg_get_arch_id(const char *name)
772 {
773 	return (get_table_entry_id(uimage_arch, "CPU", name));
774 }
775 
776 int genimg_get_type_id(const char *name)
777 {
778 	return (get_table_entry_id(uimage_type, "Image", name));
779 }
780 
781 int genimg_get_comp_id(const char *name)
782 {
783 	return (get_table_entry_id(uimage_comp, "Compression", name));
784 }
785 
786 #ifndef USE_HOSTCC
787 /**
788  * genimg_get_kernel_addr_fit - get the real kernel address and return 2
789  *                              FIT strings
790  * @img_addr: a string might contain real image address
791  * @fit_uname_config: double pointer to a char, will hold pointer to a
792  *                    configuration unit name
793  * @fit_uname_kernel: double pointer to a char, will hold pointer to a subimage
794  *                    name
795  *
796  * genimg_get_kernel_addr_fit get the real kernel start address from a string
797  * which is normally the first argv of bootm/bootz
798  *
799  * returns:
800  *     kernel start address
801  */
802 ulong genimg_get_kernel_addr_fit(char * const img_addr,
803 			     const char **fit_uname_config,
804 			     const char **fit_uname_kernel)
805 {
806 	ulong kernel_addr;
807 
808 	/* find out kernel image address */
809 	if (!img_addr) {
810 		kernel_addr = load_addr;
811 		debug("*  kernel: default image load address = 0x%08lx\n",
812 		      load_addr);
813 #if CONFIG_IS_ENABLED(FIT)
814 	} else if (fit_parse_conf(img_addr, load_addr, &kernel_addr,
815 				  fit_uname_config)) {
816 		debug("*  kernel: config '%s' from image at 0x%08lx\n",
817 		      *fit_uname_config, kernel_addr);
818 	} else if (fit_parse_subimage(img_addr, load_addr, &kernel_addr,
819 				     fit_uname_kernel)) {
820 		debug("*  kernel: subimage '%s' from image at 0x%08lx\n",
821 		      *fit_uname_kernel, kernel_addr);
822 #endif
823 	} else {
824 		kernel_addr = simple_strtoul(img_addr, NULL, 16);
825 		debug("*  kernel: cmdline image address = 0x%08lx\n",
826 		      kernel_addr);
827 	}
828 
829 	return kernel_addr;
830 }
831 
832 /**
833  * genimg_get_kernel_addr() is the simple version of
834  * genimg_get_kernel_addr_fit(). It ignores those return FIT strings
835  */
836 ulong genimg_get_kernel_addr(char * const img_addr)
837 {
838 	const char *fit_uname_config = NULL;
839 	const char *fit_uname_kernel = NULL;
840 
841 	return genimg_get_kernel_addr_fit(img_addr, &fit_uname_config,
842 					  &fit_uname_kernel);
843 }
844 
845 /**
846  * genimg_get_format - get image format type
847  * @img_addr: image start address
848  *
849  * genimg_get_format() checks whether provided address points to a valid
850  * legacy or FIT image.
851  *
852  * New uImage format and FDT blob are based on a libfdt. FDT blob
853  * may be passed directly or embedded in a FIT image. In both situations
854  * genimg_get_format() must be able to dectect libfdt header.
855  *
856  * returns:
857  *     image format type or IMAGE_FORMAT_INVALID if no image is present
858  */
859 int genimg_get_format(const void *img_addr)
860 {
861 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
862 	const image_header_t *hdr;
863 
864 	hdr = (const image_header_t *)img_addr;
865 	if (image_check_magic(hdr))
866 		return IMAGE_FORMAT_LEGACY;
867 #endif
868 #if IMAGE_ENABLE_FIT || IMAGE_ENABLE_OF_LIBFDT
869 	if (fdt_check_header(img_addr) == 0)
870 		return IMAGE_FORMAT_FIT;
871 #endif
872 #ifdef CONFIG_ANDROID_BOOT_IMAGE
873 	if (android_image_check_header(img_addr) == 0)
874 		return IMAGE_FORMAT_ANDROID;
875 #endif
876 
877 	return IMAGE_FORMAT_INVALID;
878 }
879 
880 /**
881  * genimg_get_image - get image from special storage (if necessary)
882  * @img_addr: image start address
883  *
884  * genimg_get_image() checks if provided image start address is located
885  * in a dataflash storage. If so, image is moved to a system RAM memory.
886  *
887  * returns:
888  *     image start address after possible relocation from special storage
889  */
890 ulong genimg_get_image(ulong img_addr)
891 {
892 	ulong ram_addr = img_addr;
893 
894 #ifdef CONFIG_HAS_DATAFLASH
895 	ulong h_size, d_size;
896 
897 	if (addr_dataflash(img_addr)) {
898 		void *buf;
899 
900 		/* ger RAM address */
901 		ram_addr = CONFIG_SYS_LOAD_ADDR;
902 
903 		/* get header size */
904 		h_size = image_get_header_size();
905 #if IMAGE_ENABLE_FIT
906 		if (sizeof(struct fdt_header) > h_size)
907 			h_size = sizeof(struct fdt_header);
908 #endif
909 
910 		/* read in header */
911 		debug("   Reading image header from dataflash address "
912 			"%08lx to RAM address %08lx\n", img_addr, ram_addr);
913 
914 		buf = map_sysmem(ram_addr, 0);
915 		read_dataflash(img_addr, h_size, buf);
916 
917 		/* get data size */
918 		switch (genimg_get_format(buf)) {
919 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
920 		case IMAGE_FORMAT_LEGACY:
921 			d_size = image_get_data_size(buf);
922 			debug("   Legacy format image found at 0x%08lx, "
923 					"size 0x%08lx\n",
924 					ram_addr, d_size);
925 			break;
926 #endif
927 #if IMAGE_ENABLE_FIT
928 		case IMAGE_FORMAT_FIT:
929 			d_size = fit_get_size(buf) - h_size;
930 			debug("   FIT/FDT format image found at 0x%08lx, "
931 					"size 0x%08lx\n",
932 					ram_addr, d_size);
933 			break;
934 #endif
935 		default:
936 			printf("   No valid image found at 0x%08lx\n",
937 				img_addr);
938 			return ram_addr;
939 		}
940 
941 		/* read in image data */
942 		debug("   Reading image remaining data from dataflash address "
943 			"%08lx to RAM address %08lx\n", img_addr + h_size,
944 			ram_addr + h_size);
945 
946 		read_dataflash(img_addr + h_size, d_size,
947 				(char *)(buf + h_size));
948 
949 	}
950 #endif /* CONFIG_HAS_DATAFLASH */
951 
952 	return ram_addr;
953 }
954 
955 /**
956  * fit_has_config - check if there is a valid FIT configuration
957  * @images: pointer to the bootm command headers structure
958  *
959  * fit_has_config() checks if there is a FIT configuration in use
960  * (if FTI support is present).
961  *
962  * returns:
963  *     0, no FIT support or no configuration found
964  *     1, configuration found
965  */
966 int genimg_has_config(bootm_headers_t *images)
967 {
968 #if IMAGE_ENABLE_FIT
969 	if (images->fit_uname_cfg)
970 		return 1;
971 #endif
972 	return 0;
973 }
974 
975 /**
976  * boot_get_ramdisk - main ramdisk handling routine
977  * @argc: command argument count
978  * @argv: command argument list
979  * @images: pointer to the bootm images structure
980  * @arch: expected ramdisk architecture
981  * @rd_start: pointer to a ulong variable, will hold ramdisk start address
982  * @rd_end: pointer to a ulong variable, will hold ramdisk end
983  *
984  * boot_get_ramdisk() is responsible for finding a valid ramdisk image.
985  * Curently supported are the following ramdisk sources:
986  *      - multicomponent kernel/ramdisk image,
987  *      - commandline provided address of decicated ramdisk image.
988  *
989  * returns:
990  *     0, if ramdisk image was found and valid, or skiped
991  *     rd_start and rd_end are set to ramdisk start/end addresses if
992  *     ramdisk image is found and valid
993  *
994  *     1, if ramdisk image is found but corrupted, or invalid
995  *     rd_start and rd_end are set to 0 if no ramdisk exists
996  */
997 int boot_get_ramdisk(int argc, char * const argv[], bootm_headers_t *images,
998 		uint8_t arch, ulong *rd_start, ulong *rd_end)
999 {
1000 	ulong rd_addr, rd_load;
1001 	ulong rd_data, rd_len;
1002 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
1003 	const image_header_t *rd_hdr;
1004 #endif
1005 	void *buf;
1006 #ifdef CONFIG_SUPPORT_RAW_INITRD
1007 	char *end;
1008 #endif
1009 #if IMAGE_ENABLE_FIT
1010 	const char	*fit_uname_config = images->fit_uname_cfg;
1011 	const char	*fit_uname_ramdisk = NULL;
1012 	ulong		default_addr;
1013 	int		rd_noffset;
1014 #endif
1015 	const char *select = NULL;
1016 
1017 	*rd_start = 0;
1018 	*rd_end = 0;
1019 
1020 #ifdef CONFIG_ANDROID_BOOT_IMAGE
1021 	/*
1022 	 * Look for an Android boot image.
1023 	 */
1024 	buf = map_sysmem(images->os.start, 0);
1025 	if (buf && genimg_get_format(buf) == IMAGE_FORMAT_ANDROID)
1026 		select = argv[0];
1027 #endif
1028 
1029 	if (argc >= 2)
1030 		select = argv[1];
1031 
1032 	/*
1033 	 * Look for a '-' which indicates to ignore the
1034 	 * ramdisk argument
1035 	 */
1036 	if (select && strcmp(select, "-") ==  0) {
1037 		debug("## Skipping init Ramdisk\n");
1038 		rd_len = rd_data = 0;
1039 	} else if (select || genimg_has_config(images)) {
1040 #if IMAGE_ENABLE_FIT
1041 		if (select) {
1042 			/*
1043 			 * If the init ramdisk comes from the FIT image and
1044 			 * the FIT image address is omitted in the command
1045 			 * line argument, try to use os FIT image address or
1046 			 * default load address.
1047 			 */
1048 			if (images->fit_uname_os)
1049 				default_addr = (ulong)images->fit_hdr_os;
1050 			else
1051 				default_addr = load_addr;
1052 
1053 			if (fit_parse_conf(select, default_addr,
1054 					   &rd_addr, &fit_uname_config)) {
1055 				debug("*  ramdisk: config '%s' from image at "
1056 						"0x%08lx\n",
1057 						fit_uname_config, rd_addr);
1058 			} else if (fit_parse_subimage(select, default_addr,
1059 						&rd_addr, &fit_uname_ramdisk)) {
1060 				debug("*  ramdisk: subimage '%s' from image at "
1061 						"0x%08lx\n",
1062 						fit_uname_ramdisk, rd_addr);
1063 			} else
1064 #endif
1065 			{
1066 				rd_addr = simple_strtoul(select, NULL, 16);
1067 				debug("*  ramdisk: cmdline image address = "
1068 						"0x%08lx\n",
1069 						rd_addr);
1070 			}
1071 #if IMAGE_ENABLE_FIT
1072 		} else {
1073 			/* use FIT configuration provided in first bootm
1074 			 * command argument. If the property is not defined,
1075 			 * quit silently.
1076 			 */
1077 			rd_addr = map_to_sysmem(images->fit_hdr_os);
1078 			rd_noffset = fit_get_node_from_config(images,
1079 					FIT_RAMDISK_PROP, rd_addr);
1080 			if (rd_noffset == -ENOLINK)
1081 				return 0;
1082 			else if (rd_noffset < 0)
1083 				return 1;
1084 		}
1085 #endif
1086 
1087 		/* copy from dataflash if needed */
1088 		rd_addr = genimg_get_image(rd_addr);
1089 
1090 		/*
1091 		 * Check if there is an initrd image at the
1092 		 * address provided in the second bootm argument
1093 		 * check image type, for FIT images get FIT node.
1094 		 */
1095 		buf = map_sysmem(rd_addr, 0);
1096 		switch (genimg_get_format(buf)) {
1097 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
1098 		case IMAGE_FORMAT_LEGACY:
1099 			printf("## Loading init Ramdisk from Legacy "
1100 					"Image at %08lx ...\n", rd_addr);
1101 
1102 			bootstage_mark(BOOTSTAGE_ID_CHECK_RAMDISK);
1103 			rd_hdr = image_get_ramdisk(rd_addr, arch,
1104 							images->verify);
1105 
1106 			if (rd_hdr == NULL)
1107 				return 1;
1108 
1109 			rd_data = image_get_data(rd_hdr);
1110 			rd_len = image_get_data_size(rd_hdr);
1111 			rd_load = image_get_load(rd_hdr);
1112 			break;
1113 #endif
1114 #if IMAGE_ENABLE_FIT
1115 		case IMAGE_FORMAT_FIT:
1116 			rd_noffset = fit_image_load(images,
1117 					rd_addr, &fit_uname_ramdisk,
1118 					&fit_uname_config, arch,
1119 					IH_TYPE_RAMDISK,
1120 					BOOTSTAGE_ID_FIT_RD_START,
1121 					FIT_LOAD_OPTIONAL_NON_ZERO,
1122 					&rd_data, &rd_len);
1123 			if (rd_noffset < 0)
1124 				return 1;
1125 
1126 			images->fit_hdr_rd = map_sysmem(rd_addr, 0);
1127 			images->fit_uname_rd = fit_uname_ramdisk;
1128 			images->fit_noffset_rd = rd_noffset;
1129 			break;
1130 #endif
1131 #ifdef CONFIG_ANDROID_BOOT_IMAGE
1132 		case IMAGE_FORMAT_ANDROID:
1133 			android_image_get_ramdisk((void *)images->os.start,
1134 				&rd_data, &rd_len);
1135 			break;
1136 #endif
1137 		default:
1138 #ifdef CONFIG_SUPPORT_RAW_INITRD
1139 			end = NULL;
1140 			if (select)
1141 				end = strchr(select, ':');
1142 			if (end) {
1143 				rd_len = simple_strtoul(++end, NULL, 16);
1144 				rd_data = rd_addr;
1145 			} else
1146 #endif
1147 			{
1148 				puts("Wrong Ramdisk Image Format\n");
1149 				rd_data = rd_len = rd_load = 0;
1150 				return 1;
1151 			}
1152 		}
1153 	} else if (images->legacy_hdr_valid &&
1154 			image_check_type(&images->legacy_hdr_os_copy,
1155 						IH_TYPE_MULTI)) {
1156 
1157 		/*
1158 		 * Now check if we have a legacy mult-component image,
1159 		 * get second entry data start address and len.
1160 		 */
1161 		bootstage_mark(BOOTSTAGE_ID_RAMDISK);
1162 		printf("## Loading init Ramdisk from multi component "
1163 				"Legacy Image at %08lx ...\n",
1164 				(ulong)images->legacy_hdr_os);
1165 
1166 		image_multi_getimg(images->legacy_hdr_os, 1, &rd_data, &rd_len);
1167 	} else {
1168 		/*
1169 		 * no initrd image
1170 		 */
1171 		bootstage_mark(BOOTSTAGE_ID_NO_RAMDISK);
1172 		rd_len = rd_data = 0;
1173 	}
1174 
1175 	if (!rd_data) {
1176 		debug("## No init Ramdisk\n");
1177 	} else {
1178 		*rd_start = rd_data;
1179 		*rd_end = rd_data + rd_len;
1180 	}
1181 	debug("   ramdisk start = 0x%08lx, ramdisk end = 0x%08lx\n",
1182 			*rd_start, *rd_end);
1183 
1184 	return 0;
1185 }
1186 
1187 #ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH
1188 /**
1189  * boot_ramdisk_high - relocate init ramdisk
1190  * @lmb: pointer to lmb handle, will be used for memory mgmt
1191  * @rd_data: ramdisk data start address
1192  * @rd_len: ramdisk data length
1193  * @initrd_start: pointer to a ulong variable, will hold final init ramdisk
1194  *      start address (after possible relocation)
1195  * @initrd_end: pointer to a ulong variable, will hold final init ramdisk
1196  *      end address (after possible relocation)
1197  *
1198  * boot_ramdisk_high() takes a relocation hint from "initrd_high" environment
1199  * variable and if requested ramdisk data is moved to a specified location.
1200  *
1201  * Initrd_start and initrd_end are set to final (after relocation) ramdisk
1202  * start/end addresses if ramdisk image start and len were provided,
1203  * otherwise set initrd_start and initrd_end set to zeros.
1204  *
1205  * returns:
1206  *      0 - success
1207  *     -1 - failure
1208  */
1209 int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len,
1210 		  ulong *initrd_start, ulong *initrd_end)
1211 {
1212 	char	*s;
1213 	ulong	initrd_high;
1214 	int	initrd_copy_to_ram = 1;
1215 
1216 	if ((s = getenv("initrd_high")) != NULL) {
1217 		/* a value of "no" or a similar string will act like 0,
1218 		 * turning the "load high" feature off. This is intentional.
1219 		 */
1220 		initrd_high = simple_strtoul(s, NULL, 16);
1221 		if (initrd_high == ~0)
1222 			initrd_copy_to_ram = 0;
1223 	} else {
1224 		initrd_high = getenv_bootm_mapsize() + getenv_bootm_low();
1225 	}
1226 
1227 
1228 #ifdef CONFIG_LOGBUFFER
1229 	/* Prevent initrd from overwriting logbuffer */
1230 	lmb_reserve(lmb, logbuffer_base() - LOGBUFF_OVERHEAD, LOGBUFF_RESERVE);
1231 #endif
1232 
1233 	debug("## initrd_high = 0x%08lx, copy_to_ram = %d\n",
1234 			initrd_high, initrd_copy_to_ram);
1235 
1236 	if (rd_data) {
1237 		if (!initrd_copy_to_ram) {	/* zero-copy ramdisk support */
1238 			debug("   in-place initrd\n");
1239 			*initrd_start = rd_data;
1240 			*initrd_end = rd_data + rd_len;
1241 			lmb_reserve(lmb, rd_data, rd_len);
1242 		} else {
1243 			if (initrd_high)
1244 				*initrd_start = (ulong)lmb_alloc_base(lmb,
1245 						rd_len, 0x1000, initrd_high);
1246 			else
1247 				*initrd_start = (ulong)lmb_alloc(lmb, rd_len,
1248 								 0x1000);
1249 
1250 			if (*initrd_start == 0) {
1251 				puts("ramdisk - allocation error\n");
1252 				goto error;
1253 			}
1254 			bootstage_mark(BOOTSTAGE_ID_COPY_RAMDISK);
1255 
1256 			*initrd_end = *initrd_start + rd_len;
1257 			printf("   Loading Ramdisk to %08lx, end %08lx ... ",
1258 					*initrd_start, *initrd_end);
1259 
1260 			memmove_wd((void *)*initrd_start,
1261 					(void *)rd_data, rd_len, CHUNKSZ);
1262 
1263 #ifdef CONFIG_MP
1264 			/*
1265 			 * Ensure the image is flushed to memory to handle
1266 			 * AMP boot scenarios in which we might not be
1267 			 * HW cache coherent
1268 			 */
1269 			flush_cache((unsigned long)*initrd_start, rd_len);
1270 #endif
1271 			puts("OK\n");
1272 		}
1273 	} else {
1274 		*initrd_start = 0;
1275 		*initrd_end = 0;
1276 	}
1277 	debug("   ramdisk load start = 0x%08lx, ramdisk load end = 0x%08lx\n",
1278 			*initrd_start, *initrd_end);
1279 
1280 	return 0;
1281 
1282 error:
1283 	return -1;
1284 }
1285 #endif /* CONFIG_SYS_BOOT_RAMDISK_HIGH */
1286 
1287 int boot_get_setup(bootm_headers_t *images, uint8_t arch,
1288 		   ulong *setup_start, ulong *setup_len)
1289 {
1290 #if IMAGE_ENABLE_FIT
1291 	return boot_get_setup_fit(images, arch, setup_start, setup_len);
1292 #else
1293 	return -ENOENT;
1294 #endif
1295 }
1296 
1297 #if IMAGE_ENABLE_FIT
1298 #if defined(CONFIG_FPGA) && defined(CONFIG_FPGA_XILINX)
1299 int boot_get_fpga(int argc, char * const argv[], bootm_headers_t *images,
1300 		  uint8_t arch, const ulong *ld_start, ulong * const ld_len)
1301 {
1302 	ulong tmp_img_addr, img_data, img_len;
1303 	void *buf;
1304 	int conf_noffset;
1305 	int fit_img_result;
1306 	char *uname, *name;
1307 	int err;
1308 	int devnum = 0; /* TODO support multi fpga platforms */
1309 	const fpga_desc * const desc = fpga_get_desc(devnum);
1310 	xilinx_desc *desc_xilinx = desc->devdesc;
1311 
1312 	/* Check to see if the images struct has a FIT configuration */
1313 	if (!genimg_has_config(images)) {
1314 		debug("## FIT configuration was not specified\n");
1315 		return 0;
1316 	}
1317 
1318 	/*
1319 	 * Obtain the os FIT header from the images struct
1320 	 * copy from dataflash if needed
1321 	 */
1322 	tmp_img_addr = map_to_sysmem(images->fit_hdr_os);
1323 	tmp_img_addr = genimg_get_image(tmp_img_addr);
1324 	buf = map_sysmem(tmp_img_addr, 0);
1325 	/*
1326 	 * Check image type. For FIT images get FIT node
1327 	 * and attempt to locate a generic binary.
1328 	 */
1329 	switch (genimg_get_format(buf)) {
1330 	case IMAGE_FORMAT_FIT:
1331 		conf_noffset = fit_conf_get_node(buf, images->fit_uname_cfg);
1332 
1333 		err = fdt_get_string_index(buf, conf_noffset, FIT_FPGA_PROP, 0,
1334 					   (const char **)&uname);
1335 		if (err < 0) {
1336 			debug("## FPGA image is not specified\n");
1337 			return 0;
1338 		}
1339 		fit_img_result = fit_image_load(images,
1340 						tmp_img_addr,
1341 						(const char **)&uname,
1342 						&(images->fit_uname_cfg),
1343 						arch,
1344 						IH_TYPE_FPGA,
1345 						BOOTSTAGE_ID_FPGA_INIT,
1346 						FIT_LOAD_OPTIONAL_NON_ZERO,
1347 						&img_data, &img_len);
1348 
1349 		debug("FPGA image (%s) loaded to 0x%lx/size 0x%lx\n",
1350 		      uname, img_data, img_len);
1351 
1352 		if (fit_img_result < 0) {
1353 			/* Something went wrong! */
1354 			return fit_img_result;
1355 		}
1356 
1357 		if (img_len >= desc_xilinx->size) {
1358 			name = "full";
1359 			err = fpga_loadbitstream(devnum, (char *)img_data,
1360 						 img_len, BIT_FULL);
1361 			if (err)
1362 				err = fpga_load(devnum, (const void *)img_data,
1363 						img_len, BIT_FULL);
1364 		} else {
1365 			name = "partial";
1366 			err = fpga_loadbitstream(devnum, (char *)img_data,
1367 						 img_len, BIT_PARTIAL);
1368 			if (err)
1369 				err = fpga_load(devnum, (const void *)img_data,
1370 						img_len, BIT_PARTIAL);
1371 		}
1372 
1373 		printf("   Programming %s bitstream... ", name);
1374 		if (err)
1375 			printf("failed\n");
1376 		else
1377 			printf("OK\n");
1378 		break;
1379 	default:
1380 		printf("The given image format is not supported (corrupt?)\n");
1381 		return 1;
1382 	}
1383 
1384 	return 0;
1385 }
1386 #endif
1387 
1388 int boot_get_loadable(int argc, char * const argv[], bootm_headers_t *images,
1389 		uint8_t arch, const ulong *ld_start, ulong * const ld_len)
1390 {
1391 	/*
1392 	 * These variables are used to hold the current image location
1393 	 * in system memory.
1394 	 */
1395 	ulong tmp_img_addr;
1396 	/*
1397 	 * These two variables are requirements for fit_image_load, but
1398 	 * their values are not used
1399 	 */
1400 	ulong img_data, img_len;
1401 	void *buf;
1402 	int loadables_index;
1403 	int conf_noffset;
1404 	int fit_img_result;
1405 	char *uname;
1406 
1407 	/* Check to see if the images struct has a FIT configuration */
1408 	if (!genimg_has_config(images)) {
1409 		debug("## FIT configuration was not specified\n");
1410 		return 0;
1411 	}
1412 
1413 	/*
1414 	 * Obtain the os FIT header from the images struct
1415 	 * copy from dataflash if needed
1416 	 */
1417 	tmp_img_addr = map_to_sysmem(images->fit_hdr_os);
1418 	tmp_img_addr = genimg_get_image(tmp_img_addr);
1419 	buf = map_sysmem(tmp_img_addr, 0);
1420 	/*
1421 	 * Check image type. For FIT images get FIT node
1422 	 * and attempt to locate a generic binary.
1423 	 */
1424 	switch (genimg_get_format(buf)) {
1425 	case IMAGE_FORMAT_FIT:
1426 		conf_noffset = fit_conf_get_node(buf, images->fit_uname_cfg);
1427 
1428 		for (loadables_index = 0;
1429 		     fdt_get_string_index(buf, conf_noffset,
1430 				FIT_LOADABLE_PROP,
1431 				loadables_index,
1432 				(const char **)&uname) == 0;
1433 		     loadables_index++)
1434 		{
1435 			fit_img_result = fit_image_load(images,
1436 				tmp_img_addr,
1437 				(const char **)&uname,
1438 				&(images->fit_uname_cfg), arch,
1439 				IH_TYPE_LOADABLE,
1440 				BOOTSTAGE_ID_FIT_LOADABLE_START,
1441 				FIT_LOAD_OPTIONAL_NON_ZERO,
1442 				&img_data, &img_len);
1443 			if (fit_img_result < 0) {
1444 				/* Something went wrong! */
1445 				return fit_img_result;
1446 			}
1447 		}
1448 		break;
1449 	default:
1450 		printf("The given image format is not supported (corrupt?)\n");
1451 		return 1;
1452 	}
1453 
1454 	return 0;
1455 }
1456 #endif
1457 
1458 #ifdef CONFIG_SYS_BOOT_GET_CMDLINE
1459 /**
1460  * boot_get_cmdline - allocate and initialize kernel cmdline
1461  * @lmb: pointer to lmb handle, will be used for memory mgmt
1462  * @cmd_start: pointer to a ulong variable, will hold cmdline start
1463  * @cmd_end: pointer to a ulong variable, will hold cmdline end
1464  *
1465  * boot_get_cmdline() allocates space for kernel command line below
1466  * BOOTMAPSZ + getenv_bootm_low() address. If "bootargs" U-Boot environemnt
1467  * variable is present its contents is copied to allocated kernel
1468  * command line.
1469  *
1470  * returns:
1471  *      0 - success
1472  *     -1 - failure
1473  */
1474 int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end)
1475 {
1476 	char *cmdline;
1477 	char *s;
1478 
1479 	cmdline = (char *)(ulong)lmb_alloc_base(lmb, CONFIG_SYS_BARGSIZE, 0xf,
1480 				getenv_bootm_mapsize() + getenv_bootm_low());
1481 
1482 	if (cmdline == NULL)
1483 		return -1;
1484 
1485 	if ((s = getenv("bootargs")) == NULL)
1486 		s = "";
1487 
1488 	strcpy(cmdline, s);
1489 
1490 	*cmd_start = (ulong) & cmdline[0];
1491 	*cmd_end = *cmd_start + strlen(cmdline);
1492 
1493 	debug("## cmdline at 0x%08lx ... 0x%08lx\n", *cmd_start, *cmd_end);
1494 
1495 	return 0;
1496 }
1497 #endif /* CONFIG_SYS_BOOT_GET_CMDLINE */
1498 
1499 #ifdef CONFIG_SYS_BOOT_GET_KBD
1500 /**
1501  * boot_get_kbd - allocate and initialize kernel copy of board info
1502  * @lmb: pointer to lmb handle, will be used for memory mgmt
1503  * @kbd: double pointer to board info data
1504  *
1505  * boot_get_kbd() allocates space for kernel copy of board info data below
1506  * BOOTMAPSZ + getenv_bootm_low() address and kernel board info is initialized
1507  * with the current u-boot board info data.
1508  *
1509  * returns:
1510  *      0 - success
1511  *     -1 - failure
1512  */
1513 int boot_get_kbd(struct lmb *lmb, bd_t **kbd)
1514 {
1515 	*kbd = (bd_t *)(ulong)lmb_alloc_base(lmb, sizeof(bd_t), 0xf,
1516 				getenv_bootm_mapsize() + getenv_bootm_low());
1517 	if (*kbd == NULL)
1518 		return -1;
1519 
1520 	**kbd = *(gd->bd);
1521 
1522 	debug("## kernel board info at 0x%08lx\n", (ulong)*kbd);
1523 
1524 #if defined(DEBUG) && defined(CONFIG_CMD_BDI)
1525 	do_bdinfo(NULL, 0, 0, NULL);
1526 #endif
1527 
1528 	return 0;
1529 }
1530 #endif /* CONFIG_SYS_BOOT_GET_KBD */
1531 
1532 #ifdef CONFIG_LMB
1533 int image_setup_linux(bootm_headers_t *images)
1534 {
1535 	ulong of_size = images->ft_len;
1536 	char **of_flat_tree = &images->ft_addr;
1537 	ulong *initrd_start = &images->initrd_start;
1538 	ulong *initrd_end = &images->initrd_end;
1539 	struct lmb *lmb = &images->lmb;
1540 	ulong rd_len;
1541 	int ret;
1542 
1543 	if (IMAGE_ENABLE_OF_LIBFDT)
1544 		boot_fdt_add_mem_rsv_regions(lmb, *of_flat_tree);
1545 
1546 	if (IMAGE_BOOT_GET_CMDLINE) {
1547 		ret = boot_get_cmdline(lmb, &images->cmdline_start,
1548 				&images->cmdline_end);
1549 		if (ret) {
1550 			puts("ERROR with allocation of cmdline\n");
1551 			return ret;
1552 		}
1553 	}
1554 	if (IMAGE_ENABLE_RAMDISK_HIGH) {
1555 		rd_len = images->rd_end - images->rd_start;
1556 		ret = boot_ramdisk_high(lmb, images->rd_start, rd_len,
1557 				initrd_start, initrd_end);
1558 		if (ret)
1559 			return ret;
1560 	}
1561 
1562 	if (IMAGE_ENABLE_OF_LIBFDT) {
1563 		ret = boot_relocate_fdt(lmb, of_flat_tree, &of_size);
1564 		if (ret)
1565 			return ret;
1566 	}
1567 
1568 	if (IMAGE_ENABLE_OF_LIBFDT && of_size) {
1569 		ret = image_setup_libfdt(images, *of_flat_tree, of_size, lmb);
1570 		if (ret)
1571 			return ret;
1572 	}
1573 
1574 	return 0;
1575 }
1576 #endif /* CONFIG_LMB */
1577 #endif /* !USE_HOSTCC */
1578