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