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