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