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