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