2 * (C) Copyright 2000-2009
3 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
5 * See file CREDITS for list of people who contributed to this
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License as
10 * published by the Free Software Foundation; either version 2 of
11 * the License, or (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
33 #include <u-boot/zlib.h>
35 #include <environment.h>
37 #include <linux/ctype.h>
38 #include <asm/byteorder.h>
39 #include <linux/compiler.h>
41 #if defined(CONFIG_CMD_USB)
45 #ifdef CONFIG_SYS_HUSH_PARSER
49 #if defined(CONFIG_OF_LIBFDT)
52 #include <fdt_support.h>
56 #include <lzma/LzmaTypes.h>
57 #include <lzma/LzmaDec.h>
58 #include <lzma/LzmaTools.h>
59 #endif /* CONFIG_LZMA */
62 #include <linux/lzo.h>
63 #endif /* CONFIG_LZO */
65 DECLARE_GLOBAL_DATA_PTR;
67 #ifndef CONFIG_SYS_BOOTM_LEN
68 #define CONFIG_SYS_BOOTM_LEN 0x800000 /* use 8MByte as default max gunzip size */
72 extern void bz_internal_error(int);
75 #if defined(CONFIG_CMD_IMI)
76 static int image_info(unsigned long addr);
79 #if defined(CONFIG_CMD_IMLS)
81 #include <mtd/cfi_flash.h>
82 extern flash_info_t flash_info[]; /* info for FLASH chips */
83 static int do_imls(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
86 #ifdef CONFIG_SILENT_CONSOLE
87 static void fixup_silent_linux(void);
90 static image_header_t *image_get_kernel(ulong img_addr, int verify);
91 #if defined(CONFIG_FIT)
92 static int fit_check_kernel(const void *fit, int os_noffset, int verify);
95 static void *boot_get_kernel(cmd_tbl_t *cmdtp, int flag, int argc,
96 char * const argv[], bootm_headers_t *images,
97 ulong *os_data, ulong *os_len);
100 * Continue booting an OS image; caller already has:
101 * - copied image header to global variable `header'
102 * - checked header magic number, checksums (both header & image),
103 * - verified image architecture (PPC) and type (KERNEL or MULTI),
104 * - loaded (first part of) image to header load address,
105 * - disabled interrupts.
107 typedef int boot_os_fn(int flag, int argc, char * const argv[],
108 bootm_headers_t *images); /* pointers to os/initrd/fdt */
110 #ifdef CONFIG_BOOTM_LINUX
111 extern boot_os_fn do_bootm_linux;
113 #ifdef CONFIG_BOOTM_NETBSD
114 static boot_os_fn do_bootm_netbsd;
116 #if defined(CONFIG_LYNXKDI)
117 static boot_os_fn do_bootm_lynxkdi;
118 extern void lynxkdi_boot(image_header_t *);
120 #ifdef CONFIG_BOOTM_RTEMS
121 static boot_os_fn do_bootm_rtems;
123 #if defined(CONFIG_BOOTM_OSE)
124 static boot_os_fn do_bootm_ose;
126 #if defined(CONFIG_CMD_ELF)
127 static boot_os_fn do_bootm_vxworks;
128 static boot_os_fn do_bootm_qnxelf;
129 int do_bootvx(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
130 int do_bootelf(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
132 #if defined(CONFIG_INTEGRITY)
133 static boot_os_fn do_bootm_integrity;
136 static boot_os_fn *boot_os[] = {
137 #ifdef CONFIG_BOOTM_LINUX
138 [IH_OS_LINUX] = do_bootm_linux,
140 #ifdef CONFIG_BOOTM_NETBSD
141 [IH_OS_NETBSD] = do_bootm_netbsd,
143 #ifdef CONFIG_LYNXKDI
144 [IH_OS_LYNXOS] = do_bootm_lynxkdi,
146 #ifdef CONFIG_BOOTM_RTEMS
147 [IH_OS_RTEMS] = do_bootm_rtems,
149 #if defined(CONFIG_BOOTM_OSE)
150 [IH_OS_OSE] = do_bootm_ose,
152 #if defined(CONFIG_CMD_ELF)
153 [IH_OS_VXWORKS] = do_bootm_vxworks,
154 [IH_OS_QNX] = do_bootm_qnxelf,
156 #ifdef CONFIG_INTEGRITY
157 [IH_OS_INTEGRITY] = do_bootm_integrity,
161 bootm_headers_t images; /* pointers to os/initrd/fdt images */
163 /* Allow for arch specific config before we boot */
164 void __arch_preboot_os(void)
166 /* please define platform specific arch_preboot_os() */
168 void arch_preboot_os(void) __attribute__((weak, alias("__arch_preboot_os")));
170 #define IH_INITRD_ARCH IH_ARCH_DEFAULT
172 static void bootm_start_lmb(void)
176 phys_size_t mem_size;
178 lmb_init(&images.lmb);
180 mem_start = getenv_bootm_low();
181 mem_size = getenv_bootm_size();
183 lmb_add(&images.lmb, (phys_addr_t)mem_start, mem_size);
185 arch_lmb_reserve(&images.lmb);
186 board_lmb_reserve(&images.lmb);
188 # define lmb_reserve(lmb, base, size)
192 static int bootm_start(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
197 memset((void *)&images, 0, sizeof(images));
198 images.verify = getenv_yesno("verify");
202 /* get kernel image header, start address and length */
203 os_hdr = boot_get_kernel(cmdtp, flag, argc, argv,
204 &images, &images.os.image_start, &images.os.image_len);
205 if (images.os.image_len == 0) {
206 puts("ERROR: can't get kernel image!\n");
210 /* get image parameters */
211 switch (genimg_get_format(os_hdr)) {
212 case IMAGE_FORMAT_LEGACY:
213 images.os.type = image_get_type(os_hdr);
214 images.os.comp = image_get_comp(os_hdr);
215 images.os.os = image_get_os(os_hdr);
217 images.os.end = image_get_image_end(os_hdr);
218 images.os.load = image_get_load(os_hdr);
220 #if defined(CONFIG_FIT)
221 case IMAGE_FORMAT_FIT:
222 if (fit_image_get_type(images.fit_hdr_os,
223 images.fit_noffset_os, &images.os.type)) {
224 puts("Can't get image type!\n");
225 show_boot_error(BOOTSTAGE_ID_FIT_TYPE);
229 if (fit_image_get_comp(images.fit_hdr_os,
230 images.fit_noffset_os, &images.os.comp)) {
231 puts("Can't get image compression!\n");
232 show_boot_error(BOOTSTAGE_ID_FIT_COMPRESSION);
236 if (fit_image_get_os(images.fit_hdr_os,
237 images.fit_noffset_os, &images.os.os)) {
238 puts("Can't get image OS!\n");
239 show_boot_error(BOOTSTAGE_ID_FIT_OS);
243 images.os.end = fit_get_end(images.fit_hdr_os);
245 if (fit_image_get_load(images.fit_hdr_os, images.fit_noffset_os,
247 puts("Can't get image load address!\n");
248 show_boot_error(BOOTSTAGE_ID_FIT_LOADADDR);
254 puts("ERROR: unknown image format type!\n");
258 /* find kernel entry point */
259 if (images.legacy_hdr_valid) {
260 images.ep = image_get_ep(&images.legacy_hdr_os_copy);
261 #if defined(CONFIG_FIT)
262 } else if (images.fit_uname_os) {
263 ret = fit_image_get_entry(images.fit_hdr_os,
264 images.fit_noffset_os, &images.ep);
266 puts("Can't get entry point property!\n");
271 puts("Could not find kernel entry point!\n");
275 if (images.os.type == IH_TYPE_KERNEL_NOLOAD) {
276 images.os.load = images.os.image_start;
277 images.ep += images.os.load;
280 if (((images.os.type == IH_TYPE_KERNEL) ||
281 (images.os.type == IH_TYPE_KERNEL_NOLOAD) ||
282 (images.os.type == IH_TYPE_MULTI)) &&
283 (images.os.os == IH_OS_LINUX)) {
285 ret = boot_get_ramdisk(argc, argv, &images, IH_INITRD_ARCH,
286 &images.rd_start, &images.rd_end);
288 puts("Ramdisk image is corrupt or invalid\n");
292 #if defined(CONFIG_OF_LIBFDT)
293 /* find flattened device tree */
294 ret = boot_get_fdt(flag, argc, argv, &images,
295 &images.ft_addr, &images.ft_len);
297 puts("Could not find a valid device tree\n");
301 set_working_fdt_addr(images.ft_addr);
305 images.os.start = (ulong)os_hdr;
306 images.state = BOOTM_STATE_START;
311 #define BOOTM_ERR_RESET -1
312 #define BOOTM_ERR_OVERLAP -2
313 #define BOOTM_ERR_UNIMPLEMENTED -3
314 static int bootm_load_os(image_info_t os, ulong *load_end, int boot_progress)
316 uint8_t comp = os.comp;
317 ulong load = os.load;
318 ulong blob_start = os.start;
319 ulong blob_end = os.end;
320 ulong image_start = os.image_start;
321 ulong image_len = os.image_len;
322 __maybe_unused uint unc_len = CONFIG_SYS_BOOTM_LEN;
324 #if defined(CONFIG_LZMA) || defined(CONFIG_LZO)
326 #endif /* defined(CONFIG_LZMA) || defined(CONFIG_LZO) */
328 const char *type_name = genimg_get_type_name(os.type);
332 if (load == blob_start || load == image_start) {
333 printf(" XIP %s ... ", type_name);
336 printf(" Loading %s ... ", type_name);
337 memmove_wd((void *)load, (void *)image_start,
340 *load_end = load + image_len;
345 printf(" Uncompressing %s ... ", type_name);
346 if (gunzip((void *)load, unc_len,
347 (uchar *)image_start, &image_len) != 0) {
348 puts("GUNZIP: uncompress, out-of-mem or overwrite "
349 "error - must RESET board to recover\n");
351 show_boot_error(BOOTSTAGE_ID_DECOMP_IMAGE);
352 return BOOTM_ERR_RESET;
355 *load_end = load + image_len;
357 #endif /* CONFIG_GZIP */
360 printf(" Uncompressing %s ... ", type_name);
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.
366 int i = BZ2_bzBuffToBuffDecompress((char *)load,
367 &unc_len, (char *)image_start, image_len,
368 CONFIG_SYS_MALLOC_LEN < (4096 * 1024), 0);
370 printf("BUNZIP2: uncompress or overwrite error %d "
371 "- must RESET board to recover\n", i);
373 show_boot_error(BOOTSTAGE_ID_DECOMP_IMAGE);
374 return BOOTM_ERR_RESET;
377 *load_end = load + unc_len;
379 #endif /* CONFIG_BZIP2 */
382 SizeT lzma_len = unc_len;
383 printf(" Uncompressing %s ... ", type_name);
385 ret = lzmaBuffToBuffDecompress(
386 (unsigned char *)load, &lzma_len,
387 (unsigned char *)image_start, image_len);
390 printf("LZMA: uncompress or overwrite error %d "
391 "- must RESET board to recover\n", ret);
392 show_boot_error(BOOTSTAGE_ID_DECOMP_IMAGE);
393 return BOOTM_ERR_RESET;
395 *load_end = load + unc_len;
398 #endif /* CONFIG_LZMA */
401 printf(" Uncompressing %s ... ", type_name);
403 ret = lzop_decompress((const unsigned char *)image_start,
404 image_len, (unsigned char *)load,
406 if (ret != LZO_E_OK) {
407 printf("LZO: uncompress or overwrite error %d "
408 "- must RESET board to recover\n", ret);
410 show_boot_error(BOOTSTAGE_ID_DECOMP_IMAGE);
411 return BOOTM_ERR_RESET;
414 *load_end = load + unc_len;
416 #endif /* CONFIG_LZO */
418 printf("Unimplemented compression type %d\n", comp);
419 return BOOTM_ERR_UNIMPLEMENTED;
422 flush_cache(load, (*load_end - load) * sizeof(ulong));
425 debug(" kernel loaded at 0x%08lx, end = 0x%08lx\n", load, *load_end);
426 show_boot_progress(BOOTSTAGE_ID_KERNEL_LOADED);
428 if (!no_overlap && (load < blob_end) && (*load_end > blob_start)) {
429 debug("images.os.start = 0x%lX, images.os.end = 0x%lx\n",
430 blob_start, blob_end);
431 debug("images.os.load = 0x%lx, load_end = 0x%lx\n", load,
434 return BOOTM_ERR_OVERLAP;
440 static int bootm_start_standalone(ulong iflag, int argc, char * const argv[])
443 int (*appl)(int, char * const []);
445 /* Don't start if "autostart" is set to "no" */
446 if (((s = getenv("autostart")) != NULL) && (strcmp(s, "no") == 0)) {
448 sprintf(buf, "%lX", images.os.image_len);
449 setenv("filesize", buf);
452 appl = (int (*)(int, char * const []))(ulong)ntohl(images.ep);
453 (*appl)(argc-1, &argv[1]);
457 /* we overload the cmd field with our state machine info instead of a
458 * function pointer */
459 static cmd_tbl_t cmd_bootm_sub[] = {
460 U_BOOT_CMD_MKENT(start, 0, 1, (void *)BOOTM_STATE_START, "", ""),
461 U_BOOT_CMD_MKENT(loados, 0, 1, (void *)BOOTM_STATE_LOADOS, "", ""),
462 #ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH
463 U_BOOT_CMD_MKENT(ramdisk, 0, 1, (void *)BOOTM_STATE_RAMDISK, "", ""),
465 #ifdef CONFIG_OF_LIBFDT
466 U_BOOT_CMD_MKENT(fdt, 0, 1, (void *)BOOTM_STATE_FDT, "", ""),
468 U_BOOT_CMD_MKENT(cmdline, 0, 1, (void *)BOOTM_STATE_OS_CMDLINE, "", ""),
469 U_BOOT_CMD_MKENT(bdt, 0, 1, (void *)BOOTM_STATE_OS_BD_T, "", ""),
470 U_BOOT_CMD_MKENT(prep, 0, 1, (void *)BOOTM_STATE_OS_PREP, "", ""),
471 U_BOOT_CMD_MKENT(go, 0, 1, (void *)BOOTM_STATE_OS_GO, "", ""),
474 int do_bootm_subcommand(cmd_tbl_t *cmdtp, int flag, int argc,
482 c = find_cmd_tbl(argv[1], &cmd_bootm_sub[0], ARRAY_SIZE(cmd_bootm_sub));
485 state = (long)c->cmd;
487 /* treat start special since it resets the state machine */
488 if (state == BOOTM_STATE_START) {
491 return bootm_start(cmdtp, flag, argc, argv);
494 /* Unrecognized command */
495 return CMD_RET_USAGE;
498 if (images.state >= state) {
499 printf("Trying to execute a command out of order\n");
500 return CMD_RET_USAGE;
503 images.state |= state;
504 boot_fn = boot_os[images.os.os];
508 case BOOTM_STATE_START:
509 /* should never occur */
511 case BOOTM_STATE_LOADOS:
512 ret = bootm_load_os(images.os, &load_end, 0);
516 lmb_reserve(&images.lmb, images.os.load,
517 (load_end - images.os.load));
519 #ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH
520 case BOOTM_STATE_RAMDISK:
522 ulong rd_len = images.rd_end - images.rd_start;
525 ret = boot_ramdisk_high(&images.lmb, images.rd_start,
526 rd_len, &images.initrd_start, &images.initrd_end);
530 sprintf(str, "%lx", images.initrd_start);
531 setenv("initrd_start", str);
532 sprintf(str, "%lx", images.initrd_end);
533 setenv("initrd_end", str);
537 #if defined(CONFIG_OF_LIBFDT)
538 case BOOTM_STATE_FDT:
540 boot_fdt_add_mem_rsv_regions(&images.lmb,
542 ret = boot_relocate_fdt(&images.lmb,
543 &images.ft_addr, &images.ft_len);
547 case BOOTM_STATE_OS_CMDLINE:
548 ret = boot_fn(BOOTM_STATE_OS_CMDLINE, argc, argv, &images);
550 printf("cmdline subcommand not supported\n");
552 case BOOTM_STATE_OS_BD_T:
553 ret = boot_fn(BOOTM_STATE_OS_BD_T, argc, argv, &images);
555 printf("bdt subcommand not supported\n");
557 case BOOTM_STATE_OS_PREP:
558 ret = boot_fn(BOOTM_STATE_OS_PREP, argc, argv, &images);
560 printf("prep subcommand not supported\n");
562 case BOOTM_STATE_OS_GO:
563 disable_interrupts();
565 boot_fn(BOOTM_STATE_OS_GO, argc, argv, &images);
572 /*******************************************************************/
573 /* bootm - boot application image from image in memory */
574 /*******************************************************************/
576 int do_bootm(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
582 #ifdef CONFIG_NEEDS_MANUAL_RELOC
583 static int relocated = 0;
585 /* relocate boot function table */
588 for (i = 0; i < ARRAY_SIZE(boot_os); i++)
589 if (boot_os[i] != NULL)
590 boot_os[i] += gd->reloc_off;
595 /* determine if we have a sub command */
599 simple_strtoul(argv[1], &endp, 16);
600 /* endp pointing to NULL means that argv[1] was just a
601 * valid number, pass it along to the normal bootm processing
603 * If endp is ':' or '#' assume a FIT identifier so pass
604 * along for normal processing.
606 * Right now we assume the first arg should never be '-'
608 if ((*endp != 0) && (*endp != ':') && (*endp != '#'))
609 return do_bootm_subcommand(cmdtp, flag, argc, argv);
612 if (bootm_start(cmdtp, flag, argc, argv))
616 * We have reached the point of no return: we are going to
617 * overwrite all exception vector code, so we cannot easily
618 * recover from any failures any more...
620 iflag = disable_interrupts();
622 #if defined(CONFIG_CMD_USB)
624 * turn off USB to prevent the host controller from writing to the
625 * SDRAM while Linux is booting. This could happen (at least for OHCI
626 * controller), because the HCCA (Host Controller Communication Area)
627 * lies within the SDRAM and the host controller writes continously to
628 * this area (as busmaster!). The HccaFrameNumber is for example
629 * updated every 1 ms within the HCCA structure in SDRAM! For more
630 * details see the OpenHCI specification.
635 ret = bootm_load_os(images.os, &load_end, 1);
638 if (ret == BOOTM_ERR_RESET)
639 do_reset(cmdtp, flag, argc, argv);
640 if (ret == BOOTM_ERR_OVERLAP) {
641 if (images.legacy_hdr_valid) {
643 hdr = &images.legacy_hdr_os_copy;
644 if (image_get_type(hdr) == IH_TYPE_MULTI)
645 puts("WARNING: legacy format multi "
649 puts("ERROR: new format image overwritten - "
650 "must RESET the board to recover\n");
651 show_boot_error(BOOTSTAGE_ID_OVERWRITTEN);
652 do_reset(cmdtp, flag, argc, argv);
655 if (ret == BOOTM_ERR_UNIMPLEMENTED) {
658 show_boot_error(BOOTSTAGE_ID_DECOMP_UNIMPL);
663 lmb_reserve(&images.lmb, images.os.load, (load_end - images.os.load));
665 if (images.os.type == IH_TYPE_STANDALONE) {
668 /* This may return when 'autostart' is 'no' */
669 bootm_start_standalone(iflag, argc, argv);
673 show_boot_progress(BOOTSTAGE_ID_CHECK_BOOT_OS);
675 #ifdef CONFIG_SILENT_CONSOLE
676 if (images.os.os == IH_OS_LINUX)
677 fixup_silent_linux();
680 boot_fn = boot_os[images.os.os];
682 if (boot_fn == NULL) {
685 printf("ERROR: booting os '%s' (%d) is not supported\n",
686 genimg_get_os_name(images.os.os), images.os.os);
687 show_boot_error(BOOTSTAGE_ID_CHECK_BOOT_OS);
693 boot_fn(0, argc, argv, &images);
695 show_boot_error(BOOTSTAGE_ID_BOOT_OS_RETURNED);
697 puts("\n## Control returned to monitor - resetting...\n");
699 do_reset(cmdtp, flag, argc, argv);
704 int bootm_maybe_autostart(cmd_tbl_t *cmdtp, const char *cmd)
706 const char *ep = getenv("autostart");
708 if (ep && !strcmp(ep, "yes")) {
710 local_args[0] = (char *)cmd;
711 local_args[1] = NULL;
712 printf("Automatic boot of image at addr 0x%08lX ...\n", load_addr);
713 return do_bootm(cmdtp, 0, 1, local_args);
720 * image_get_kernel - verify legacy format kernel image
721 * @img_addr: in RAM address of the legacy format image to be verified
722 * @verify: data CRC verification flag
724 * image_get_kernel() verifies legacy image integrity and returns pointer to
725 * legacy image header if image verification was completed successfully.
728 * pointer to a legacy image header if valid image was found
729 * otherwise return NULL
731 static image_header_t *image_get_kernel(ulong img_addr, int verify)
733 image_header_t *hdr = (image_header_t *)img_addr;
735 if (!image_check_magic(hdr)) {
736 puts("Bad Magic Number\n");
737 show_boot_error(BOOTSTAGE_ID_CHECK_MAGIC);
740 show_boot_progress(BOOTSTAGE_ID_CHECK_HEADER);
742 if (!image_check_hcrc(hdr)) {
743 puts("Bad Header Checksum\n");
744 show_boot_error(BOOTSTAGE_ID_CHECK_HEADER);
748 show_boot_progress(BOOTSTAGE_ID_CHECK_CHECKSUM);
749 image_print_contents(hdr);
752 puts(" Verifying Checksum ... ");
753 if (!image_check_dcrc(hdr)) {
754 printf("Bad Data CRC\n");
755 show_boot_error(BOOTSTAGE_ID_CHECK_CHECKSUM);
760 show_boot_progress(BOOTSTAGE_ID_CHECK_ARCH);
762 if (!image_check_target_arch(hdr)) {
763 printf("Unsupported Architecture 0x%x\n", image_get_arch(hdr));
764 show_boot_error(BOOTSTAGE_ID_CHECK_ARCH);
771 * fit_check_kernel - verify FIT format kernel subimage
772 * @fit_hdr: pointer to the FIT image header
773 * os_noffset: kernel subimage node offset within FIT image
774 * @verify: data CRC verification flag
776 * fit_check_kernel() verifies integrity of the kernel subimage and from
777 * specified FIT image.
783 #if defined(CONFIG_FIT)
784 static int fit_check_kernel(const void *fit, int os_noffset, int verify)
786 fit_image_print(fit, os_noffset, " ");
789 puts(" Verifying Hash Integrity ... ");
790 if (!fit_image_check_hashes(fit, os_noffset)) {
791 puts("Bad Data Hash\n");
792 show_boot_error(BOOTSTAGE_ID_FIT_CHECK_HASH);
797 show_boot_progress(BOOTSTAGE_ID_FIT_CHECK_ARCH);
799 if (!fit_image_check_target_arch(fit, os_noffset)) {
800 puts("Unsupported Architecture\n");
801 show_boot_error(BOOTSTAGE_ID_FIT_CHECK_ARCH);
805 show_boot_progress(BOOTSTAGE_ID_FIT_CHECK_KERNEL);
806 if (!fit_image_check_type(fit, os_noffset, IH_TYPE_KERNEL) &&
807 !fit_image_check_type(fit, os_noffset, IH_TYPE_KERNEL_NOLOAD)) {
808 puts("Not a kernel image\n");
809 show_boot_error(BOOTSTAGE_ID_FIT_CHECK_KERNEL);
813 show_boot_progress(BOOTSTAGE_ID_FIT_CHECKED);
816 #endif /* CONFIG_FIT */
819 * boot_get_kernel - find kernel image
820 * @os_data: pointer to a ulong variable, will hold os data start address
821 * @os_len: pointer to a ulong variable, will hold os data length
823 * boot_get_kernel() tries to find a kernel image, verifies its integrity
824 * and locates kernel data.
827 * pointer to image header if valid image was found, plus kernel start
828 * address and length, otherwise NULL
830 static void *boot_get_kernel(cmd_tbl_t *cmdtp, int flag, int argc,
831 char * const argv[], bootm_headers_t *images, ulong *os_data,
836 #if defined(CONFIG_FIT)
838 const char *fit_uname_config = NULL;
839 const char *fit_uname_kernel = NULL;
846 /* find out kernel image address */
848 img_addr = load_addr;
849 debug("* kernel: default image load address = 0x%08lx\n",
851 #if defined(CONFIG_FIT)
852 } else if (fit_parse_conf(argv[1], load_addr, &img_addr,
853 &fit_uname_config)) {
854 debug("* kernel: config '%s' from image at 0x%08lx\n",
855 fit_uname_config, img_addr);
856 } else if (fit_parse_subimage(argv[1], load_addr, &img_addr,
857 &fit_uname_kernel)) {
858 debug("* kernel: subimage '%s' from image at 0x%08lx\n",
859 fit_uname_kernel, img_addr);
862 img_addr = simple_strtoul(argv[1], NULL, 16);
863 debug("* kernel: cmdline image address = 0x%08lx\n", img_addr);
866 show_boot_progress(BOOTSTAGE_ID_CHECK_MAGIC);
868 /* copy from dataflash if needed */
869 img_addr = genimg_get_image(img_addr);
871 /* check image type, for FIT images get FIT kernel node */
872 *os_data = *os_len = 0;
873 switch (genimg_get_format((void *)img_addr)) {
874 case IMAGE_FORMAT_LEGACY:
875 printf("## Booting kernel from Legacy Image at %08lx ...\n",
877 hdr = image_get_kernel(img_addr, images->verify);
880 show_boot_progress(BOOTSTAGE_ID_CHECK_IMAGETYPE);
882 /* get os_data and os_len */
883 switch (image_get_type(hdr)) {
885 case IH_TYPE_KERNEL_NOLOAD:
886 *os_data = image_get_data(hdr);
887 *os_len = image_get_data_size(hdr);
890 image_multi_getimg(hdr, 0, os_data, os_len);
892 case IH_TYPE_STANDALONE:
893 *os_data = image_get_data(hdr);
894 *os_len = image_get_data_size(hdr);
897 printf("Wrong Image Type for %s command\n",
899 show_boot_error(BOOTSTAGE_ID_CHECK_IMAGETYPE);
904 * copy image header to allow for image overwrites during
905 * kernel decompression.
907 memmove(&images->legacy_hdr_os_copy, hdr,
908 sizeof(image_header_t));
910 /* save pointer to image header */
911 images->legacy_hdr_os = hdr;
913 images->legacy_hdr_valid = 1;
914 show_boot_progress(BOOTSTAGE_ID_DECOMP_IMAGE);
916 #if defined(CONFIG_FIT)
917 case IMAGE_FORMAT_FIT:
918 fit_hdr = (void *)img_addr;
919 printf("## Booting kernel from FIT Image at %08lx ...\n",
922 if (!fit_check_format(fit_hdr)) {
923 puts("Bad FIT kernel image format!\n");
924 show_boot_error(BOOTSTAGE_ID_FIT_FORMAT);
927 show_boot_progress(BOOTSTAGE_ID_FIT_FORMAT);
929 if (!fit_uname_kernel) {
931 * no kernel image node unit name, try to get config
932 * node first. If config unit node name is NULL
933 * fit_conf_get_node() will try to find default config
936 show_boot_progress(BOOTSTAGE_ID_FIT_NO_UNIT_NAME);
937 cfg_noffset = fit_conf_get_node(fit_hdr,
939 if (cfg_noffset < 0) {
940 show_boot_error(BOOTSTAGE_ID_FIT_NO_UNIT_NAME);
943 /* save configuration uname provided in the first
946 images->fit_uname_cfg = fdt_get_name(fit_hdr,
949 printf(" Using '%s' configuration\n",
950 images->fit_uname_cfg);
951 show_boot_progress(BOOTSTAGE_ID_FIT_CONFIG);
953 os_noffset = fit_conf_get_kernel_node(fit_hdr,
955 fit_uname_kernel = fit_get_name(fit_hdr, os_noffset,
958 /* get kernel component image node offset */
959 show_boot_progress(BOOTSTAGE_ID_FIT_UNIT_NAME);
960 os_noffset = fit_image_get_node(fit_hdr,
963 if (os_noffset < 0) {
964 show_boot_error(BOOTSTAGE_ID_FIT_CONFIG);
968 printf(" Trying '%s' kernel subimage\n", fit_uname_kernel);
970 show_boot_progress(BOOTSTAGE_ID_FIT_CHECK_SUBIMAGE);
971 if (!fit_check_kernel(fit_hdr, os_noffset, images->verify))
974 /* get kernel image data address and length */
975 if (fit_image_get_data(fit_hdr, os_noffset, &data, &len)) {
976 puts("Could not find kernel subimage data!\n");
977 show_boot_error(BOOTSTAGE_ID_FIT_KERNEL_INFO_ERR);
980 show_boot_progress(BOOTSTAGE_ID_FIT_KERNEL_INFO);
983 *os_data = (ulong)data;
984 images->fit_hdr_os = fit_hdr;
985 images->fit_uname_os = fit_uname_kernel;
986 images->fit_noffset_os = os_noffset;
990 printf("Wrong Image Format for %s command\n", cmdtp->name);
991 show_boot_error(BOOTSTAGE_ID_FIT_KERNEL_INFO);
995 debug(" kernel data at 0x%08lx, len = 0x%08lx (%ld)\n",
996 *os_data, *os_len, *os_len);
998 return (void *)img_addr;
1002 bootm, CONFIG_SYS_MAXARGS, 1, do_bootm,
1003 "boot application image from memory",
1004 "[addr [arg ...]]\n - boot application image stored in memory\n"
1005 "\tpassing arguments 'arg ...'; when booting a Linux kernel,\n"
1006 "\t'arg' can be the address of an initrd image\n"
1007 #if defined(CONFIG_OF_LIBFDT)
1008 "\tWhen booting a Linux kernel which requires a flat device-tree\n"
1009 "\ta third argument is required which is the address of the\n"
1010 "\tdevice-tree blob. To boot that kernel without an initrd image,\n"
1011 "\tuse a '-' for the second argument. If you do not pass a third\n"
1012 "\ta bd_info struct will be passed instead\n"
1014 #if defined(CONFIG_FIT)
1015 "\t\nFor the new multi component uImage format (FIT) addresses\n"
1016 "\tmust be extened to include component or configuration unit name:\n"
1017 "\taddr:<subimg_uname> - direct component image specification\n"
1018 "\taddr#<conf_uname> - configuration specification\n"
1019 "\tUse iminfo command to get the list of existing component\n"
1020 "\timages and configurations.\n"
1022 "\nSub-commands to do part of the bootm sequence. The sub-commands "
1024 "issued in the order below (it's ok to not issue all sub-commands):\n"
1025 "\tstart [addr [arg ...]]\n"
1026 "\tloados - load OS image\n"
1027 #if defined(CONFIG_PPC) || defined(CONFIG_M68K) || defined(CONFIG_SPARC)
1028 "\tramdisk - relocate initrd, set env initrd_start/initrd_end\n"
1030 #if defined(CONFIG_OF_LIBFDT)
1031 "\tfdt - relocate flat device tree\n"
1033 "\tcmdline - OS specific command line processing/setup\n"
1034 "\tbdt - OS specific bd_t processing\n"
1035 "\tprep - OS specific prep before relocation or go\n"
1039 /*******************************************************************/
1040 /* bootd - boot default image */
1041 /*******************************************************************/
1042 #if defined(CONFIG_CMD_BOOTD)
1043 int do_bootd(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
1047 if (run_command(getenv("bootcmd"), flag) < 0)
1053 boot, 1, 1, do_bootd,
1054 "boot default, i.e., run 'bootcmd'",
1058 /* keep old command name "bootd" for backward compatibility */
1060 bootd, 1, 1, do_bootd,
1061 "boot default, i.e., run 'bootcmd'",
1068 /*******************************************************************/
1069 /* iminfo - print header info for a requested image */
1070 /*******************************************************************/
1071 #if defined(CONFIG_CMD_IMI)
1072 int do_iminfo(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
1079 return image_info(load_addr);
1082 for (arg = 1; arg < argc; ++arg) {
1083 addr = simple_strtoul(argv[arg], NULL, 16);
1084 if (image_info(addr) != 0)
1090 static int image_info(ulong addr)
1092 void *hdr = (void *)addr;
1094 printf("\n## Checking Image at %08lx ...\n", addr);
1096 switch (genimg_get_format(hdr)) {
1097 case IMAGE_FORMAT_LEGACY:
1098 puts(" Legacy image found\n");
1099 if (!image_check_magic(hdr)) {
1100 puts(" Bad Magic Number\n");
1104 if (!image_check_hcrc(hdr)) {
1105 puts(" Bad Header Checksum\n");
1109 image_print_contents(hdr);
1111 puts(" Verifying Checksum ... ");
1112 if (!image_check_dcrc(hdr)) {
1113 puts(" Bad Data CRC\n");
1118 #if defined(CONFIG_FIT)
1119 case IMAGE_FORMAT_FIT:
1120 puts(" FIT image found\n");
1122 if (!fit_check_format(hdr)) {
1123 puts("Bad FIT image format!\n");
1127 fit_print_contents(hdr);
1129 if (!fit_all_image_check_hashes(hdr)) {
1130 puts("Bad hash in FIT image!\n");
1137 puts("Unknown image format!\n");
1145 iminfo, CONFIG_SYS_MAXARGS, 1, do_iminfo,
1146 "print header information for application image",
1148 " - print header information for application image starting at\n"
1149 " address 'addr' in memory; this includes verification of the\n"
1150 " image contents (magic number, header and payload checksums)"
1155 /*******************************************************************/
1156 /* imls - list all images found in flash */
1157 /*******************************************************************/
1158 #if defined(CONFIG_CMD_IMLS)
1159 int do_imls(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
1165 for (i = 0, info = &flash_info[0];
1166 i < CONFIG_SYS_MAX_FLASH_BANKS; ++i, ++info) {
1168 if (info->flash_id == FLASH_UNKNOWN)
1170 for (j = 0; j < info->sector_count; ++j) {
1172 hdr = (void *)info->start[j];
1176 switch (genimg_get_format(hdr)) {
1177 case IMAGE_FORMAT_LEGACY:
1178 if (!image_check_hcrc(hdr))
1181 printf("Legacy Image at %08lX:\n", (ulong)hdr);
1182 image_print_contents(hdr);
1184 puts(" Verifying Checksum ... ");
1185 if (!image_check_dcrc(hdr)) {
1186 puts("Bad Data CRC\n");
1191 #if defined(CONFIG_FIT)
1192 case IMAGE_FORMAT_FIT:
1193 if (!fit_check_format(hdr))
1196 printf("FIT Image at %08lX:\n", (ulong)hdr);
1197 fit_print_contents(hdr);
1213 imls, 1, 1, do_imls,
1214 "list all images found in flash",
1216 " - Prints information about all images found at sector\n"
1217 " boundaries in flash."
1221 /*******************************************************************/
1222 /* helper routines */
1223 /*******************************************************************/
1224 #ifdef CONFIG_SILENT_CONSOLE
1225 static void fixup_silent_linux(void)
1227 char buf[256], *start, *end;
1228 char *cmdline = getenv("bootargs");
1230 /* Only fix cmdline when requested */
1231 if (!(gd->flags & GD_FLG_SILENT))
1234 debug("before silent fix-up: %s\n", cmdline);
1236 start = strstr(cmdline, "console=");
1238 end = strchr(start, ' ');
1239 strncpy(buf, cmdline, (start - cmdline + 8));
1241 strcpy(buf + (start - cmdline + 8), end);
1243 buf[start - cmdline + 8] = '\0';
1245 strcpy(buf, cmdline);
1246 strcat(buf, " console=");
1249 strcpy(buf, "console=");
1252 setenv("bootargs", buf);
1253 debug("after silent fix-up: %s\n", buf);
1255 #endif /* CONFIG_SILENT_CONSOLE */
1258 /*******************************************************************/
1259 /* OS booting routines */
1260 /*******************************************************************/
1262 #ifdef CONFIG_BOOTM_NETBSD
1263 static int do_bootm_netbsd(int flag, int argc, char * const argv[],
1264 bootm_headers_t *images)
1266 void (*loader)(bd_t *, image_header_t *, char *, char *);
1267 image_header_t *os_hdr, *hdr;
1268 ulong kernel_data, kernel_len;
1272 if ((flag != 0) && (flag != BOOTM_STATE_OS_GO))
1275 #if defined(CONFIG_FIT)
1276 if (!images->legacy_hdr_valid) {
1277 fit_unsupported_reset("NetBSD");
1281 hdr = images->legacy_hdr_os;
1284 * Booting a (NetBSD) kernel image
1286 * This process is pretty similar to a standalone application:
1287 * The (first part of an multi-) image must be a stage-2 loader,
1288 * which in turn is responsible for loading & invoking the actual
1289 * kernel. The only differences are the parameters being passed:
1290 * besides the board info strucure, the loader expects a command
1291 * line, the name of the console device, and (optionally) the
1292 * address of the original image header.
1295 if (image_check_type(&images->legacy_hdr_os_copy, IH_TYPE_MULTI)) {
1296 image_multi_getimg(hdr, 1, &kernel_data, &kernel_len);
1302 #if defined(CONFIG_8xx_CONS_SMC1)
1304 #elif defined(CONFIG_8xx_CONS_SMC2)
1306 #elif defined(CONFIG_8xx_CONS_SCC2)
1308 #elif defined(CONFIG_8xx_CONS_SCC3)
1316 for (i = 2, len = 0; i < argc; i += 1)
1317 len += strlen(argv[i]) + 1;
1318 cmdline = malloc(len);
1320 for (i = 2, len = 0; i < argc; i += 1) {
1322 cmdline[len++] = ' ';
1323 strcpy(&cmdline[len], argv[i]);
1324 len += strlen(argv[i]);
1326 } else if ((cmdline = getenv("bootargs")) == NULL) {
1330 loader = (void (*)(bd_t *, image_header_t *, char *, char *))images->ep;
1332 printf("## Transferring control to NetBSD stage-2 loader "
1333 "(at address %08lx) ...\n",
1336 show_boot_progress(BOOTSTAGE_ID_RUN_OS);
1339 * NetBSD Stage-2 Loader Parameters:
1340 * r3: ptr to board info data
1342 * r5: console device
1343 * r6: boot args string
1345 (*loader)(gd->bd, os_hdr, consdev, cmdline);
1349 #endif /* CONFIG_BOOTM_NETBSD*/
1351 #ifdef CONFIG_LYNXKDI
1352 static int do_bootm_lynxkdi(int flag, int argc, char * const argv[],
1353 bootm_headers_t *images)
1355 image_header_t *hdr = &images->legacy_hdr_os_copy;
1357 if ((flag != 0) && (flag != BOOTM_STATE_OS_GO))
1360 #if defined(CONFIG_FIT)
1361 if (!images->legacy_hdr_valid) {
1362 fit_unsupported_reset("Lynx");
1367 lynxkdi_boot((image_header_t *)hdr);
1371 #endif /* CONFIG_LYNXKDI */
1373 #ifdef CONFIG_BOOTM_RTEMS
1374 static int do_bootm_rtems(int flag, int argc, char * const argv[],
1375 bootm_headers_t *images)
1377 void (*entry_point)(bd_t *);
1379 if ((flag != 0) && (flag != BOOTM_STATE_OS_GO))
1382 #if defined(CONFIG_FIT)
1383 if (!images->legacy_hdr_valid) {
1384 fit_unsupported_reset("RTEMS");
1389 entry_point = (void (*)(bd_t *))images->ep;
1391 printf("## Transferring control to RTEMS (at address %08lx) ...\n",
1392 (ulong)entry_point);
1394 show_boot_progress(BOOTSTAGE_ID_RUN_OS);
1398 * r3: ptr to board info data
1400 (*entry_point)(gd->bd);
1404 #endif /* CONFIG_BOOTM_RTEMS */
1406 #if defined(CONFIG_BOOTM_OSE)
1407 static int do_bootm_ose(int flag, int argc, char * const argv[],
1408 bootm_headers_t *images)
1410 void (*entry_point)(void);
1412 if ((flag != 0) && (flag != BOOTM_STATE_OS_GO))
1415 #if defined(CONFIG_FIT)
1416 if (!images->legacy_hdr_valid) {
1417 fit_unsupported_reset("OSE");
1422 entry_point = (void (*)(void))images->ep;
1424 printf("## Transferring control to OSE (at address %08lx) ...\n",
1425 (ulong)entry_point);
1427 show_boot_progress(BOOTSTAGE_ID_RUN_OS);
1437 #endif /* CONFIG_BOOTM_OSE */
1439 #if defined(CONFIG_CMD_ELF)
1440 static int do_bootm_vxworks(int flag, int argc, char * const argv[],
1441 bootm_headers_t *images)
1445 if ((flag != 0) && (flag != BOOTM_STATE_OS_GO))
1448 #if defined(CONFIG_FIT)
1449 if (!images->legacy_hdr_valid) {
1450 fit_unsupported_reset("VxWorks");
1455 sprintf(str, "%lx", images->ep); /* write entry-point into string */
1456 setenv("loadaddr", str);
1457 do_bootvx(NULL, 0, 0, NULL);
1462 static int do_bootm_qnxelf(int flag, int argc, char * const argv[],
1463 bootm_headers_t *images)
1465 char *local_args[2];
1468 if ((flag != 0) && (flag != BOOTM_STATE_OS_GO))
1471 #if defined(CONFIG_FIT)
1472 if (!images->legacy_hdr_valid) {
1473 fit_unsupported_reset("QNX");
1478 sprintf(str, "%lx", images->ep); /* write entry-point into string */
1479 local_args[0] = argv[0];
1480 local_args[1] = str; /* and provide it via the arguments */
1481 do_bootelf(NULL, 0, 2, local_args);
1487 #ifdef CONFIG_INTEGRITY
1488 static int do_bootm_integrity(int flag, int argc, char * const argv[],
1489 bootm_headers_t *images)
1491 void (*entry_point)(void);
1493 if ((flag != 0) && (flag != BOOTM_STATE_OS_GO))
1496 #if defined(CONFIG_FIT)
1497 if (!images->legacy_hdr_valid) {
1498 fit_unsupported_reset("INTEGRITY");
1503 entry_point = (void (*)(void))images->ep;
1505 printf("## Transferring control to INTEGRITY (at address %08lx) ...\n",
1506 (ulong)entry_point);
1508 show_boot_progress(BOOTSTAGE_ID_RUN_OS);
1511 * INTEGRITY Parameters: