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