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