xref: /openbmc/u-boot/common/bootm.c (revision 9ee16897)
1 /*
2  * (C) Copyright 2000-2009
3  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4  *
5  * SPDX-License-Identifier:	GPL-2.0+
6  */
7 
8 #ifndef USE_HOSTCC
9 #include <common.h>
10 #include <bootstage.h>
11 #include <bzlib.h>
12 #include <errno.h>
13 #include <fdt_support.h>
14 #include <lmb.h>
15 #include <malloc.h>
16 #include <mapmem.h>
17 #include <asm/io.h>
18 #include <linux/lzo.h>
19 #include <lzma/LzmaTypes.h>
20 #include <lzma/LzmaDec.h>
21 #include <lzma/LzmaTools.h>
22 #if defined(CONFIG_CMD_USB)
23 #include <usb.h>
24 #endif
25 #else
26 #include "mkimage.h"
27 #endif
28 
29 #include <command.h>
30 #include <bootm.h>
31 #include <image.h>
32 
33 #ifndef CONFIG_SYS_BOOTM_LEN
34 /* use 8MByte as default max gunzip size */
35 #define CONFIG_SYS_BOOTM_LEN	0x800000
36 #endif
37 
38 #define IH_INITRD_ARCH IH_ARCH_DEFAULT
39 
40 #ifndef USE_HOSTCC
41 
42 DECLARE_GLOBAL_DATA_PTR;
43 
44 static const void *boot_get_kernel(cmd_tbl_t *cmdtp, int flag, int argc,
45 				   char * const argv[], bootm_headers_t *images,
46 				   ulong *os_data, ulong *os_len);
47 
48 #ifdef CONFIG_LMB
49 static void boot_start_lmb(bootm_headers_t *images)
50 {
51 	ulong		mem_start;
52 	phys_size_t	mem_size;
53 
54 	lmb_init(&images->lmb);
55 
56 	mem_start = getenv_bootm_low();
57 	mem_size = getenv_bootm_size();
58 
59 	lmb_add(&images->lmb, (phys_addr_t)mem_start, mem_size);
60 
61 	arch_lmb_reserve(&images->lmb);
62 	board_lmb_reserve(&images->lmb);
63 }
64 #else
65 #define lmb_reserve(lmb, base, size)
66 static inline void boot_start_lmb(bootm_headers_t *images) { }
67 #endif
68 
69 static int bootm_start(cmd_tbl_t *cmdtp, int flag, int argc,
70 		       char * const argv[])
71 {
72 	memset((void *)&images, 0, sizeof(images));
73 	images.verify = getenv_yesno("verify");
74 
75 	boot_start_lmb(&images);
76 
77 	bootstage_mark_name(BOOTSTAGE_ID_BOOTM_START, "bootm_start");
78 	images.state = BOOTM_STATE_START;
79 
80 	return 0;
81 }
82 
83 static int bootm_find_os(cmd_tbl_t *cmdtp, int flag, int argc,
84 			 char * const argv[])
85 {
86 	const void *os_hdr;
87 	bool ep_found = false;
88 	int ret;
89 
90 	/* get kernel image header, start address and length */
91 	os_hdr = boot_get_kernel(cmdtp, flag, argc, argv,
92 			&images, &images.os.image_start, &images.os.image_len);
93 	if (images.os.image_len == 0) {
94 		puts("ERROR: can't get kernel image!\n");
95 		return 1;
96 	}
97 
98 	/* get image parameters */
99 	switch (genimg_get_format(os_hdr)) {
100 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
101 	case IMAGE_FORMAT_LEGACY:
102 		images.os.type = image_get_type(os_hdr);
103 		images.os.comp = image_get_comp(os_hdr);
104 		images.os.os = image_get_os(os_hdr);
105 
106 		images.os.end = image_get_image_end(os_hdr);
107 		images.os.load = image_get_load(os_hdr);
108 		images.os.arch = image_get_arch(os_hdr);
109 		break;
110 #endif
111 #if defined(CONFIG_FIT)
112 	case IMAGE_FORMAT_FIT:
113 		if (fit_image_get_type(images.fit_hdr_os,
114 				       images.fit_noffset_os,
115 				       &images.os.type)) {
116 			puts("Can't get image type!\n");
117 			bootstage_error(BOOTSTAGE_ID_FIT_TYPE);
118 			return 1;
119 		}
120 
121 		if (fit_image_get_comp(images.fit_hdr_os,
122 				       images.fit_noffset_os,
123 				       &images.os.comp)) {
124 			puts("Can't get image compression!\n");
125 			bootstage_error(BOOTSTAGE_ID_FIT_COMPRESSION);
126 			return 1;
127 		}
128 
129 		if (fit_image_get_os(images.fit_hdr_os, images.fit_noffset_os,
130 				     &images.os.os)) {
131 			puts("Can't get image OS!\n");
132 			bootstage_error(BOOTSTAGE_ID_FIT_OS);
133 			return 1;
134 		}
135 
136 		if (fit_image_get_arch(images.fit_hdr_os,
137 				       images.fit_noffset_os,
138 				       &images.os.arch)) {
139 			puts("Can't get image ARCH!\n");
140 			return 1;
141 		}
142 
143 		images.os.end = fit_get_end(images.fit_hdr_os);
144 
145 		if (fit_image_get_load(images.fit_hdr_os, images.fit_noffset_os,
146 				       &images.os.load)) {
147 			puts("Can't get image load address!\n");
148 			bootstage_error(BOOTSTAGE_ID_FIT_LOADADDR);
149 			return 1;
150 		}
151 		break;
152 #endif
153 #ifdef CONFIG_ANDROID_BOOT_IMAGE
154 	case IMAGE_FORMAT_ANDROID:
155 		images.os.type = IH_TYPE_KERNEL;
156 		images.os.comp = IH_COMP_NONE;
157 		images.os.os = IH_OS_LINUX;
158 
159 		images.os.end = android_image_get_end(os_hdr);
160 		images.os.load = android_image_get_kload(os_hdr);
161 		images.ep = images.os.load;
162 		ep_found = true;
163 		break;
164 #endif
165 	default:
166 		puts("ERROR: unknown image format type!\n");
167 		return 1;
168 	}
169 
170 	/* If we have a valid setup.bin, we will use that for entry (x86) */
171 	if (images.os.arch == IH_ARCH_I386 ||
172 	    images.os.arch == IH_ARCH_X86_64) {
173 		ulong len;
174 
175 		ret = boot_get_setup(&images, IH_ARCH_I386, &images.ep, &len);
176 		if (ret < 0 && ret != -ENOENT) {
177 			puts("Could not find a valid setup.bin for x86\n");
178 			return 1;
179 		}
180 		/* Kernel entry point is the setup.bin */
181 	} else if (images.legacy_hdr_valid) {
182 		images.ep = image_get_ep(&images.legacy_hdr_os_copy);
183 #if defined(CONFIG_FIT)
184 	} else if (images.fit_uname_os) {
185 		int ret;
186 
187 		ret = fit_image_get_entry(images.fit_hdr_os,
188 					  images.fit_noffset_os, &images.ep);
189 		if (ret) {
190 			puts("Can't get entry point property!\n");
191 			return 1;
192 		}
193 #endif
194 	} else if (!ep_found) {
195 		puts("Could not find kernel entry point!\n");
196 		return 1;
197 	}
198 
199 	if (images.os.type == IH_TYPE_KERNEL_NOLOAD) {
200 		images.os.load = images.os.image_start;
201 		images.ep += images.os.load;
202 	}
203 
204 	images.os.start = (ulong)os_hdr;
205 
206 	return 0;
207 }
208 
209 /**
210  * bootm_find_images - wrapper to find and locate various images
211  * @flag: Ignored Argument
212  * @argc: command argument count
213  * @argv: command argument list
214  *
215  * boot_find_images() will attempt to load an available ramdisk,
216  * flattened device tree, as well as specifically marked
217  * "loadable" images (loadables are FIT only)
218  *
219  * Note: bootm_find_images will skip an image if it is not found
220  *
221  * @return:
222  *     0, if all existing images were loaded correctly
223  *     1, if an image is found but corrupted, or invalid
224  */
225 int bootm_find_images(int flag, int argc, char * const argv[])
226 {
227 	int ret;
228 
229 	/* find ramdisk */
230 	ret = boot_get_ramdisk(argc, argv, &images, IH_INITRD_ARCH,
231 			       &images.rd_start, &images.rd_end);
232 	if (ret) {
233 		puts("Ramdisk image is corrupt or invalid\n");
234 		return 1;
235 	}
236 
237 #if defined(CONFIG_OF_LIBFDT)
238 	/* find flattened device tree */
239 	ret = boot_get_fdt(flag, argc, argv, IH_ARCH_DEFAULT, &images,
240 			   &images.ft_addr, &images.ft_len);
241 	if (ret) {
242 		puts("Could not find a valid device tree\n");
243 		return 1;
244 	}
245 	set_working_fdt_addr((ulong)images.ft_addr);
246 #endif
247 
248 #if defined(CONFIG_FIT)
249 	/* find all of the loadables */
250 	ret = boot_get_loadable(argc, argv, &images, IH_ARCH_DEFAULT,
251 			       NULL, NULL);
252 	if (ret) {
253 		printf("Loadable(s) is corrupt or invalid\n");
254 		return 1;
255 	}
256 #endif
257 
258 	return 0;
259 }
260 
261 static int bootm_find_other(cmd_tbl_t *cmdtp, int flag, int argc,
262 			    char * const argv[])
263 {
264 	if (((images.os.type == IH_TYPE_KERNEL) ||
265 	     (images.os.type == IH_TYPE_KERNEL_NOLOAD) ||
266 	     (images.os.type == IH_TYPE_MULTI)) &&
267 	    (images.os.os == IH_OS_LINUX ||
268 		 images.os.os == IH_OS_VXWORKS))
269 		return bootm_find_images(flag, argc, argv);
270 
271 	return 0;
272 }
273 #endif /* USE_HOSTC */
274 
275 /**
276  * print_decomp_msg() - Print a suitable decompression/loading message
277  *
278  * @type:	OS type (IH_OS_...)
279  * @comp_type:	Compression type being used (IH_COMP_...)
280  * @is_xip:	true if the load address matches the image start
281  */
282 static void print_decomp_msg(int comp_type, int type, bool is_xip)
283 {
284 	const char *name = genimg_get_type_name(type);
285 
286 	if (comp_type == IH_COMP_NONE)
287 		printf("   %s %s ... ", is_xip ? "XIP" : "Loading", name);
288 	else
289 		printf("   Uncompressing %s ... ", name);
290 }
291 
292 /**
293  * handle_decomp_error() - display a decompression error
294  *
295  * This function tries to produce a useful message. In the case where the
296  * uncompressed size is the same as the available space, we can assume that
297  * the image is too large for the buffer.
298  *
299  * @comp_type:		Compression type being used (IH_COMP_...)
300  * @uncomp_size:	Number of bytes uncompressed
301  * @unc_len:		Amount of space available for decompression
302  * @ret:		Error code to report
303  * @return BOOTM_ERR_RESET, indicating that the board must be reset
304  */
305 static int handle_decomp_error(int comp_type, size_t uncomp_size,
306 			       size_t unc_len, int ret)
307 {
308 	const char *name = genimg_get_comp_name(comp_type);
309 
310 	if (uncomp_size >= unc_len)
311 		printf("Image too large: increase CONFIG_SYS_BOOTM_LEN\n");
312 	else
313 		printf("%s: uncompress error %d\n", name, ret);
314 
315 	/*
316 	 * The decompression routines are now safe, so will not write beyond
317 	 * their bounds. Probably it is not necessary to reset, but maintain
318 	 * the current behaviour for now.
319 	 */
320 	printf("Must RESET board to recover\n");
321 #ifndef USE_HOSTCC
322 	bootstage_error(BOOTSTAGE_ID_DECOMP_IMAGE);
323 #endif
324 
325 	return BOOTM_ERR_RESET;
326 }
327 
328 int bootm_decomp_image(int comp, ulong load, ulong image_start, int type,
329 		       void *load_buf, void *image_buf, ulong image_len,
330 		       uint unc_len, ulong *load_end)
331 {
332 	int ret = 0;
333 
334 	*load_end = load;
335 	print_decomp_msg(comp, type, load == image_start);
336 
337 	/*
338 	 * Load the image to the right place, decompressing if needed. After
339 	 * this, image_len will be set to the number of uncompressed bytes
340 	 * loaded, ret will be non-zero on error.
341 	 */
342 	switch (comp) {
343 	case IH_COMP_NONE:
344 		if (load == image_start)
345 			break;
346 		if (image_len <= unc_len)
347 			memmove_wd(load_buf, image_buf, image_len, CHUNKSZ);
348 		else
349 			ret = 1;
350 		break;
351 #ifdef CONFIG_GZIP
352 	case IH_COMP_GZIP: {
353 		ret = gunzip(load_buf, unc_len, image_buf, &image_len);
354 		break;
355 	}
356 #endif /* CONFIG_GZIP */
357 #ifdef CONFIG_BZIP2
358 	case IH_COMP_BZIP2: {
359 		uint size = unc_len;
360 
361 		/*
362 		 * If we've got less than 4 MB of malloc() space,
363 		 * use slower decompression algorithm which requires
364 		 * at most 2300 KB of memory.
365 		 */
366 		ret = BZ2_bzBuffToBuffDecompress(load_buf, &size,
367 			image_buf, image_len,
368 			CONFIG_SYS_MALLOC_LEN < (4096 * 1024), 0);
369 		image_len = size;
370 		break;
371 	}
372 #endif /* CONFIG_BZIP2 */
373 #ifdef CONFIG_LZMA
374 	case IH_COMP_LZMA: {
375 		SizeT lzma_len = unc_len;
376 
377 		ret = lzmaBuffToBuffDecompress(load_buf, &lzma_len,
378 					       image_buf, image_len);
379 		image_len = lzma_len;
380 		break;
381 	}
382 #endif /* CONFIG_LZMA */
383 #ifdef CONFIG_LZO
384 	case IH_COMP_LZO: {
385 		size_t size = unc_len;
386 
387 		ret = lzop_decompress(image_buf, image_len, load_buf, &size);
388 		image_len = size;
389 		break;
390 	}
391 #endif /* CONFIG_LZO */
392 	default:
393 		printf("Unimplemented compression type %d\n", comp);
394 		return BOOTM_ERR_UNIMPLEMENTED;
395 	}
396 
397 	if (ret)
398 		return handle_decomp_error(comp, image_len, unc_len, ret);
399 	*load_end = load + image_len;
400 
401 	puts("OK\n");
402 
403 	return 0;
404 }
405 
406 #ifndef USE_HOSTCC
407 static int bootm_load_os(bootm_headers_t *images, unsigned long *load_end,
408 			 int boot_progress)
409 {
410 	image_info_t os = images->os;
411 	ulong load = os.load;
412 	ulong blob_start = os.start;
413 	ulong blob_end = os.end;
414 	ulong image_start = os.image_start;
415 	ulong image_len = os.image_len;
416 	bool no_overlap;
417 	void *load_buf, *image_buf;
418 	int err;
419 
420 	load_buf = map_sysmem(load, 0);
421 	image_buf = map_sysmem(os.image_start, image_len);
422 	err = bootm_decomp_image(os.comp, load, os.image_start, os.type,
423 				 load_buf, image_buf, image_len,
424 				 CONFIG_SYS_BOOTM_LEN, load_end);
425 	if (err) {
426 		bootstage_error(BOOTSTAGE_ID_DECOMP_IMAGE);
427 		return err;
428 	}
429 	flush_cache(load, (*load_end - load) * sizeof(ulong));
430 
431 	debug("   kernel loaded at 0x%08lx, end = 0x%08lx\n", load, *load_end);
432 	bootstage_mark(BOOTSTAGE_ID_KERNEL_LOADED);
433 
434 	no_overlap = (os.comp == IH_COMP_NONE && load == image_start);
435 
436 	if (!no_overlap && (load < blob_end) && (*load_end > blob_start)) {
437 		debug("images.os.start = 0x%lX, images.os.end = 0x%lx\n",
438 		      blob_start, blob_end);
439 		debug("images.os.load = 0x%lx, load_end = 0x%lx\n", load,
440 		      *load_end);
441 
442 		/* Check what type of image this is. */
443 		if (images->legacy_hdr_valid) {
444 			if (image_get_type(&images->legacy_hdr_os_copy)
445 					== IH_TYPE_MULTI)
446 				puts("WARNING: legacy format multi component image overwritten\n");
447 			return BOOTM_ERR_OVERLAP;
448 		} else {
449 			puts("ERROR: new format image overwritten - must RESET the board to recover\n");
450 			bootstage_error(BOOTSTAGE_ID_OVERWRITTEN);
451 			return BOOTM_ERR_RESET;
452 		}
453 	}
454 
455 	return 0;
456 }
457 
458 /**
459  * bootm_disable_interrupts() - Disable interrupts in preparation for load/boot
460  *
461  * @return interrupt flag (0 if interrupts were disabled, non-zero if they were
462  *	enabled)
463  */
464 ulong bootm_disable_interrupts(void)
465 {
466 	ulong iflag;
467 
468 	/*
469 	 * We have reached the point of no return: we are going to
470 	 * overwrite all exception vector code, so we cannot easily
471 	 * recover from any failures any more...
472 	 */
473 	iflag = disable_interrupts();
474 #ifdef CONFIG_NETCONSOLE
475 	/* Stop the ethernet stack if NetConsole could have left it up */
476 	eth_halt();
477 	eth_unregister(eth_get_dev());
478 #endif
479 
480 #if defined(CONFIG_CMD_USB)
481 	/*
482 	 * turn off USB to prevent the host controller from writing to the
483 	 * SDRAM while Linux is booting. This could happen (at least for OHCI
484 	 * controller), because the HCCA (Host Controller Communication Area)
485 	 * lies within the SDRAM and the host controller writes continously to
486 	 * this area (as busmaster!). The HccaFrameNumber is for example
487 	 * updated every 1 ms within the HCCA structure in SDRAM! For more
488 	 * details see the OpenHCI specification.
489 	 */
490 	usb_stop();
491 #endif
492 	return iflag;
493 }
494 
495 #if defined(CONFIG_SILENT_CONSOLE) && !defined(CONFIG_SILENT_U_BOOT_ONLY)
496 
497 #define CONSOLE_ARG     "console="
498 #define CONSOLE_ARG_LEN (sizeof(CONSOLE_ARG) - 1)
499 
500 static void fixup_silent_linux(void)
501 {
502 	char *buf;
503 	const char *env_val;
504 	char *cmdline = getenv("bootargs");
505 	int want_silent;
506 
507 	/*
508 	 * Only fix cmdline when requested. The environment variable can be:
509 	 *
510 	 *	no - we never fixup
511 	 *	yes - we always fixup
512 	 *	unset - we rely on the console silent flag
513 	 */
514 	want_silent = getenv_yesno("silent_linux");
515 	if (want_silent == 0)
516 		return;
517 	else if (want_silent == -1 && !(gd->flags & GD_FLG_SILENT))
518 		return;
519 
520 	debug("before silent fix-up: %s\n", cmdline);
521 	if (cmdline && (cmdline[0] != '\0')) {
522 		char *start = strstr(cmdline, CONSOLE_ARG);
523 
524 		/* Allocate space for maximum possible new command line */
525 		buf = malloc(strlen(cmdline) + 1 + CONSOLE_ARG_LEN + 1);
526 		if (!buf) {
527 			debug("%s: out of memory\n", __func__);
528 			return;
529 		}
530 
531 		if (start) {
532 			char *end = strchr(start, ' ');
533 			int num_start_bytes = start - cmdline + CONSOLE_ARG_LEN;
534 
535 			strncpy(buf, cmdline, num_start_bytes);
536 			if (end)
537 				strcpy(buf + num_start_bytes, end);
538 			else
539 				buf[num_start_bytes] = '\0';
540 		} else {
541 			sprintf(buf, "%s %s", cmdline, CONSOLE_ARG);
542 		}
543 		env_val = buf;
544 	} else {
545 		buf = NULL;
546 		env_val = CONSOLE_ARG;
547 	}
548 
549 	setenv("bootargs", env_val);
550 	debug("after silent fix-up: %s\n", env_val);
551 	free(buf);
552 }
553 #endif /* CONFIG_SILENT_CONSOLE */
554 
555 /**
556  * Execute selected states of the bootm command.
557  *
558  * Note the arguments to this state must be the first argument, Any 'bootm'
559  * or sub-command arguments must have already been taken.
560  *
561  * Note that if states contains more than one flag it MUST contain
562  * BOOTM_STATE_START, since this handles and consumes the command line args.
563  *
564  * Also note that aside from boot_os_fn functions and bootm_load_os no other
565  * functions we store the return value of in 'ret' may use a negative return
566  * value, without special handling.
567  *
568  * @param cmdtp		Pointer to bootm command table entry
569  * @param flag		Command flags (CMD_FLAG_...)
570  * @param argc		Number of subcommand arguments (0 = no arguments)
571  * @param argv		Arguments
572  * @param states	Mask containing states to run (BOOTM_STATE_...)
573  * @param images	Image header information
574  * @param boot_progress 1 to show boot progress, 0 to not do this
575  * @return 0 if ok, something else on error. Some errors will cause this
576  *	function to perform a reboot! If states contains BOOTM_STATE_OS_GO
577  *	then the intent is to boot an OS, so this function will not return
578  *	unless the image type is standalone.
579  */
580 int do_bootm_states(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[],
581 		    int states, bootm_headers_t *images, int boot_progress)
582 {
583 	boot_os_fn *boot_fn;
584 	ulong iflag = 0;
585 	int ret = 0, need_boot_fn;
586 
587 	images->state |= states;
588 
589 	/*
590 	 * Work through the states and see how far we get. We stop on
591 	 * any error.
592 	 */
593 	if (states & BOOTM_STATE_START)
594 		ret = bootm_start(cmdtp, flag, argc, argv);
595 
596 	if (!ret && (states & BOOTM_STATE_FINDOS))
597 		ret = bootm_find_os(cmdtp, flag, argc, argv);
598 
599 	if (!ret && (states & BOOTM_STATE_FINDOTHER)) {
600 		ret = bootm_find_other(cmdtp, flag, argc, argv);
601 		argc = 0;	/* consume the args */
602 	}
603 
604 	/* Load the OS */
605 	if (!ret && (states & BOOTM_STATE_LOADOS)) {
606 		ulong load_end;
607 
608 		iflag = bootm_disable_interrupts();
609 		ret = bootm_load_os(images, &load_end, 0);
610 		if (ret == 0)
611 			lmb_reserve(&images->lmb, images->os.load,
612 				    (load_end - images->os.load));
613 		else if (ret && ret != BOOTM_ERR_OVERLAP)
614 			goto err;
615 		else if (ret == BOOTM_ERR_OVERLAP)
616 			ret = 0;
617 #if defined(CONFIG_SILENT_CONSOLE) && !defined(CONFIG_SILENT_U_BOOT_ONLY)
618 		if (images->os.os == IH_OS_LINUX)
619 			fixup_silent_linux();
620 #endif
621 	}
622 
623 	/* Relocate the ramdisk */
624 #ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH
625 	if (!ret && (states & BOOTM_STATE_RAMDISK)) {
626 		ulong rd_len = images->rd_end - images->rd_start;
627 
628 		ret = boot_ramdisk_high(&images->lmb, images->rd_start,
629 			rd_len, &images->initrd_start, &images->initrd_end);
630 		if (!ret) {
631 			setenv_hex("initrd_start", images->initrd_start);
632 			setenv_hex("initrd_end", images->initrd_end);
633 		}
634 	}
635 #endif
636 #if defined(CONFIG_OF_LIBFDT) && defined(CONFIG_LMB)
637 	if (!ret && (states & BOOTM_STATE_FDT)) {
638 		boot_fdt_add_mem_rsv_regions(&images->lmb, images->ft_addr);
639 		ret = boot_relocate_fdt(&images->lmb, &images->ft_addr,
640 					&images->ft_len);
641 	}
642 #endif
643 
644 	/* From now on, we need the OS boot function */
645 	if (ret)
646 		return ret;
647 	boot_fn = bootm_os_get_boot_func(images->os.os);
648 	need_boot_fn = states & (BOOTM_STATE_OS_CMDLINE |
649 			BOOTM_STATE_OS_BD_T | BOOTM_STATE_OS_PREP |
650 			BOOTM_STATE_OS_FAKE_GO | BOOTM_STATE_OS_GO);
651 	if (boot_fn == NULL && need_boot_fn) {
652 		if (iflag)
653 			enable_interrupts();
654 		printf("ERROR: booting os '%s' (%d) is not supported\n",
655 		       genimg_get_os_name(images->os.os), images->os.os);
656 		bootstage_error(BOOTSTAGE_ID_CHECK_BOOT_OS);
657 		return 1;
658 	}
659 
660 	/* Call various other states that are not generally used */
661 	if (!ret && (states & BOOTM_STATE_OS_CMDLINE))
662 		ret = boot_fn(BOOTM_STATE_OS_CMDLINE, argc, argv, images);
663 	if (!ret && (states & BOOTM_STATE_OS_BD_T))
664 		ret = boot_fn(BOOTM_STATE_OS_BD_T, argc, argv, images);
665 	if (!ret && (states & BOOTM_STATE_OS_PREP))
666 		ret = boot_fn(BOOTM_STATE_OS_PREP, argc, argv, images);
667 
668 #ifdef CONFIG_TRACE
669 	/* Pretend to run the OS, then run a user command */
670 	if (!ret && (states & BOOTM_STATE_OS_FAKE_GO)) {
671 		char *cmd_list = getenv("fakegocmd");
672 
673 		ret = boot_selected_os(argc, argv, BOOTM_STATE_OS_FAKE_GO,
674 				images, boot_fn);
675 		if (!ret && cmd_list)
676 			ret = run_command_list(cmd_list, -1, flag);
677 	}
678 #endif
679 
680 	/* Check for unsupported subcommand. */
681 	if (ret) {
682 		puts("subcommand not supported\n");
683 		return ret;
684 	}
685 
686 	/* Now run the OS! We hope this doesn't return */
687 	if (!ret && (states & BOOTM_STATE_OS_GO))
688 		ret = boot_selected_os(argc, argv, BOOTM_STATE_OS_GO,
689 				images, boot_fn);
690 
691 	/* Deal with any fallout */
692 err:
693 	if (iflag)
694 		enable_interrupts();
695 
696 	if (ret == BOOTM_ERR_UNIMPLEMENTED)
697 		bootstage_error(BOOTSTAGE_ID_DECOMP_UNIMPL);
698 	else if (ret == BOOTM_ERR_RESET)
699 		do_reset(cmdtp, flag, argc, argv);
700 
701 	return ret;
702 }
703 
704 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
705 /**
706  * image_get_kernel - verify legacy format kernel image
707  * @img_addr: in RAM address of the legacy format image to be verified
708  * @verify: data CRC verification flag
709  *
710  * image_get_kernel() verifies legacy image integrity and returns pointer to
711  * legacy image header if image verification was completed successfully.
712  *
713  * returns:
714  *     pointer to a legacy image header if valid image was found
715  *     otherwise return NULL
716  */
717 static image_header_t *image_get_kernel(ulong img_addr, int verify)
718 {
719 	image_header_t *hdr = (image_header_t *)img_addr;
720 
721 	if (!image_check_magic(hdr)) {
722 		puts("Bad Magic Number\n");
723 		bootstage_error(BOOTSTAGE_ID_CHECK_MAGIC);
724 		return NULL;
725 	}
726 	bootstage_mark(BOOTSTAGE_ID_CHECK_HEADER);
727 
728 	if (!image_check_hcrc(hdr)) {
729 		puts("Bad Header Checksum\n");
730 		bootstage_error(BOOTSTAGE_ID_CHECK_HEADER);
731 		return NULL;
732 	}
733 
734 	bootstage_mark(BOOTSTAGE_ID_CHECK_CHECKSUM);
735 	image_print_contents(hdr);
736 
737 	if (verify) {
738 		puts("   Verifying Checksum ... ");
739 		if (!image_check_dcrc(hdr)) {
740 			printf("Bad Data CRC\n");
741 			bootstage_error(BOOTSTAGE_ID_CHECK_CHECKSUM);
742 			return NULL;
743 		}
744 		puts("OK\n");
745 	}
746 	bootstage_mark(BOOTSTAGE_ID_CHECK_ARCH);
747 
748 	if (!image_check_target_arch(hdr)) {
749 		printf("Unsupported Architecture 0x%x\n", image_get_arch(hdr));
750 		bootstage_error(BOOTSTAGE_ID_CHECK_ARCH);
751 		return NULL;
752 	}
753 	return hdr;
754 }
755 #endif
756 
757 /**
758  * boot_get_kernel - find kernel image
759  * @os_data: pointer to a ulong variable, will hold os data start address
760  * @os_len: pointer to a ulong variable, will hold os data length
761  *
762  * boot_get_kernel() tries to find a kernel image, verifies its integrity
763  * and locates kernel data.
764  *
765  * returns:
766  *     pointer to image header if valid image was found, plus kernel start
767  *     address and length, otherwise NULL
768  */
769 static const void *boot_get_kernel(cmd_tbl_t *cmdtp, int flag, int argc,
770 				   char * const argv[], bootm_headers_t *images,
771 				   ulong *os_data, ulong *os_len)
772 {
773 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
774 	image_header_t	*hdr;
775 #endif
776 	ulong		img_addr;
777 	const void *buf;
778 	const char	*fit_uname_config = NULL;
779 	const char	*fit_uname_kernel = NULL;
780 #if defined(CONFIG_FIT)
781 	int		os_noffset;
782 #endif
783 
784 	img_addr = genimg_get_kernel_addr_fit(argc < 1 ? NULL : argv[0],
785 					      &fit_uname_config,
786 					      &fit_uname_kernel);
787 
788 	bootstage_mark(BOOTSTAGE_ID_CHECK_MAGIC);
789 
790 	/* copy from dataflash if needed */
791 	img_addr = genimg_get_image(img_addr);
792 
793 	/* check image type, for FIT images get FIT kernel node */
794 	*os_data = *os_len = 0;
795 	buf = map_sysmem(img_addr, 0);
796 	switch (genimg_get_format(buf)) {
797 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
798 	case IMAGE_FORMAT_LEGACY:
799 		printf("## Booting kernel from Legacy Image at %08lx ...\n",
800 		       img_addr);
801 		hdr = image_get_kernel(img_addr, images->verify);
802 		if (!hdr)
803 			return NULL;
804 		bootstage_mark(BOOTSTAGE_ID_CHECK_IMAGETYPE);
805 
806 		/* get os_data and os_len */
807 		switch (image_get_type(hdr)) {
808 		case IH_TYPE_KERNEL:
809 		case IH_TYPE_KERNEL_NOLOAD:
810 			*os_data = image_get_data(hdr);
811 			*os_len = image_get_data_size(hdr);
812 			break;
813 		case IH_TYPE_MULTI:
814 			image_multi_getimg(hdr, 0, os_data, os_len);
815 			break;
816 		case IH_TYPE_STANDALONE:
817 			*os_data = image_get_data(hdr);
818 			*os_len = image_get_data_size(hdr);
819 			break;
820 		default:
821 			printf("Wrong Image Type for %s command\n",
822 			       cmdtp->name);
823 			bootstage_error(BOOTSTAGE_ID_CHECK_IMAGETYPE);
824 			return NULL;
825 		}
826 
827 		/*
828 		 * copy image header to allow for image overwrites during
829 		 * kernel decompression.
830 		 */
831 		memmove(&images->legacy_hdr_os_copy, hdr,
832 			sizeof(image_header_t));
833 
834 		/* save pointer to image header */
835 		images->legacy_hdr_os = hdr;
836 
837 		images->legacy_hdr_valid = 1;
838 		bootstage_mark(BOOTSTAGE_ID_DECOMP_IMAGE);
839 		break;
840 #endif
841 #if defined(CONFIG_FIT)
842 	case IMAGE_FORMAT_FIT:
843 		os_noffset = fit_image_load(images, img_addr,
844 				&fit_uname_kernel, &fit_uname_config,
845 				IH_ARCH_DEFAULT, IH_TYPE_KERNEL,
846 				BOOTSTAGE_ID_FIT_KERNEL_START,
847 				FIT_LOAD_IGNORED, os_data, os_len);
848 		if (os_noffset < 0)
849 			return NULL;
850 
851 		images->fit_hdr_os = map_sysmem(img_addr, 0);
852 		images->fit_uname_os = fit_uname_kernel;
853 		images->fit_uname_cfg = fit_uname_config;
854 		images->fit_noffset_os = os_noffset;
855 		break;
856 #endif
857 #ifdef CONFIG_ANDROID_BOOT_IMAGE
858 	case IMAGE_FORMAT_ANDROID:
859 		printf("## Booting Android Image at 0x%08lx ...\n", img_addr);
860 		if (android_image_get_kernel(buf, images->verify,
861 					     os_data, os_len))
862 			return NULL;
863 		break;
864 #endif
865 	default:
866 		printf("Wrong Image Format for %s command\n", cmdtp->name);
867 		bootstage_error(BOOTSTAGE_ID_FIT_KERNEL_INFO);
868 		return NULL;
869 	}
870 
871 	debug("   kernel data at 0x%08lx, len = 0x%08lx (%ld)\n",
872 	      *os_data, *os_len, *os_len);
873 
874 	return buf;
875 }
876 #else /* USE_HOSTCC */
877 
878 void memmove_wd(void *to, void *from, size_t len, ulong chunksz)
879 {
880 	memmove(to, from, len);
881 }
882 
883 static int bootm_host_load_image(const void *fit, int req_image_type)
884 {
885 	const char *fit_uname_config = NULL;
886 	ulong data, len;
887 	bootm_headers_t images;
888 	int noffset;
889 	ulong load_end;
890 	uint8_t image_type;
891 	uint8_t imape_comp;
892 	void *load_buf;
893 	int ret;
894 
895 	memset(&images, '\0', sizeof(images));
896 	images.verify = 1;
897 	noffset = fit_image_load(&images, (ulong)fit,
898 		NULL, &fit_uname_config,
899 		IH_ARCH_DEFAULT, req_image_type, -1,
900 		FIT_LOAD_IGNORED, &data, &len);
901 	if (noffset < 0)
902 		return noffset;
903 	if (fit_image_get_type(fit, noffset, &image_type)) {
904 		puts("Can't get image type!\n");
905 		return -EINVAL;
906 	}
907 
908 	if (fit_image_get_comp(fit, noffset, &imape_comp)) {
909 		puts("Can't get image compression!\n");
910 		return -EINVAL;
911 	}
912 
913 	/* Allow the image to expand by a factor of 4, should be safe */
914 	load_buf = malloc((1 << 20) + len * 4);
915 	ret = bootm_decomp_image(imape_comp, 0, data, image_type, load_buf,
916 				 (void *)data, len, CONFIG_SYS_BOOTM_LEN,
917 				 &load_end);
918 	free(load_buf);
919 
920 	if (ret && ret != BOOTM_ERR_UNIMPLEMENTED)
921 		return ret;
922 
923 	return 0;
924 }
925 
926 int bootm_host_load_images(const void *fit, int cfg_noffset)
927 {
928 	static uint8_t image_types[] = {
929 		IH_TYPE_KERNEL,
930 		IH_TYPE_FLATDT,
931 		IH_TYPE_RAMDISK,
932 	};
933 	int err = 0;
934 	int i;
935 
936 	for (i = 0; i < ARRAY_SIZE(image_types); i++) {
937 		int ret;
938 
939 		ret = bootm_host_load_image(fit, image_types[i]);
940 		if (!err && ret && ret != -ENOENT)
941 			err = ret;
942 	}
943 
944 	/* Return the first error we found */
945 	return err;
946 }
947 
948 #endif /* ndef USE_HOSTCC */
949