common/cmd_bootm.c

   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
   9 /*
  10  * Boot support
  11  */
  12 #include <common.h>
  13 #include <watchdog.h>
  14 #include <command.h>
  15 #include <image.h>
  16 #include <malloc.h>
  17 #include <u-boot/zlib.h>
  18 #include <bzlib.h>
  19 #include <environment.h>
  20 #include <lmb.h>
  21 #include <linux/ctype.h>
  22 #include <asm/byteorder.h>
  23 #include <asm/io.h>
  24 #include <linux/compiler.h>
  25
  26 #if defined(CONFIG_CMD_USB)
  27 #include <usb.h>
  28 #endif
  29
  30 #ifdef CONFIG_SYS_HUSH_PARSER
  31 #include <hush.h>
  32 #endif
  33
  34 #if defined(CONFIG_OF_LIBFDT)
  35 #include <libfdt.h>
  36 #include <fdt_support.h>
  37 #endif
  38
  39 #ifdef CONFIG_LZMA
  40 #include <lzma/LzmaTypes.h>
  41 #include <lzma/LzmaDec.h>
  42 #include <lzma/LzmaTools.h>
  43 #endif /* CONFIG_LZMA */
  44
  45 #ifdef CONFIG_LZO
  46 #include <linux/lzo.h>
  47 #endif /* CONFIG_LZO */
  48
  49 DECLARE_GLOBAL_DATA_PTR;
  50
  51 #ifndef CONFIG_SYS_BOOTM_LEN
  52 #define CONFIG_SYS_BOOTM_LEN    0x800000        /* use 8MByte as default max gunzip size */
  53 #endif
  54
  55 #ifdef CONFIG_BZIP2
  56 extern void bz_internal_error(int);
  57 #endif
  58
  59 #if defined(CONFIG_CMD_IMI)
  60 static int image_info(unsigned long addr);
  61 #endif
  62
  63 #if defined(CONFIG_CMD_IMLS)
  64 #include <flash.h>
  65 #include <mtd/cfi_flash.h>
  66 extern flash_info_t flash_info[]; /* info for FLASH chips */
  67 #endif
  68
  69 #if defined(CONFIG_CMD_IMLS) || defined(CONFIG_CMD_IMLS_NAND)
  70 static int do_imls(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
  71 #endif
  72
  73 #include <linux/err.h>
  74 #include <nand.h>
  75
  76 #if defined(CONFIG_SILENT_CONSOLE) && !defined(CONFIG_SILENT_U_BOOT_ONLY)
  77 static void fixup_silent_linux(void);
  78 #endif
  79
  80 static const void *boot_get_kernel(cmd_tbl_t *cmdtp, int flag, int argc,
  81                                 char * const argv[], bootm_headers_t *images,
  82                                 ulong *os_data, ulong *os_len);
  83
  84 /*
  85  *  Continue booting an OS image; caller already has:
  86  *  - copied image header to global variable `header'
  87  *  - checked header magic number, checksums (both header & image),
  88  *  - verified image architecture (PPC) and type (KERNEL or MULTI),
  89  *  - loaded (first part of) image to header load address,
  90  *  - disabled interrupts.
  91  *
  92  * @flag: Flags indicating what to do (BOOTM_STATE_...)
  93  * @argc: Number of arguments. Note that the arguments are shifted down
  94  *       so that 0 is the first argument not processed by U-Boot, and
  95  *       argc is adjusted accordingly. This avoids confusion as to how
  96  *       many arguments are available for the OS.
  97  * @images: Pointers to os/initrd/fdt
  98  * @return 1 on error. On success the OS boots so this function does
  99  * not return.
 100  */
 101 typedef int boot_os_fn(int flag, int argc, char * const argv[],
 102                         bootm_headers_t *images);
 103
 104 #ifdef CONFIG_BOOTM_LINUX
 105 extern boot_os_fn do_bootm_linux;
 106 #endif
 107 #ifdef CONFIG_BOOTM_NETBSD
 108 static boot_os_fn do_bootm_netbsd;
 109 #endif
 110 #if defined(CONFIG_LYNXKDI)
 111 static boot_os_fn do_bootm_lynxkdi;
 112 extern void lynxkdi_boot(image_header_t *);
 113 #endif
 114 #ifdef CONFIG_BOOTM_RTEMS
 115 static boot_os_fn do_bootm_rtems;
 116 #endif
 117 #if defined(CONFIG_BOOTM_OSE)
 118 static boot_os_fn do_bootm_ose;
 119 #endif
 120 #if defined(CONFIG_BOOTM_PLAN9)
 121 static boot_os_fn do_bootm_plan9;
 122 #endif
 123 #if defined(CONFIG_CMD_ELF)
 124 static boot_os_fn do_bootm_vxworks;
 125 static boot_os_fn do_bootm_qnxelf;
 126 int do_bootvx(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
 127 int do_bootelf(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
 128 #endif
 129 #if defined(CONFIG_INTEGRITY)
 130 static boot_os_fn do_bootm_integrity;
 131 #endif
 132
 133 static boot_os_fn *boot_os[] = {
 134 #ifdef CONFIG_BOOTM_LINUX
 135         [IH_OS_LINUX] = do_bootm_linux,
 136 #endif
 137 #ifdef CONFIG_BOOTM_NETBSD
 138         [IH_OS_NETBSD] = do_bootm_netbsd,
 139 #endif
 140 #ifdef CONFIG_LYNXKDI
 141         [IH_OS_LYNXOS] = do_bootm_lynxkdi,
 142 #endif
 143 #ifdef CONFIG_BOOTM_RTEMS
 144         [IH_OS_RTEMS] = do_bootm_rtems,
 145 #endif
 146 #if defined(CONFIG_BOOTM_OSE)
 147         [IH_OS_OSE] = do_bootm_ose,
 148 #endif
 149 #if defined(CONFIG_BOOTM_PLAN9)
 150         [IH_OS_PLAN9] = do_bootm_plan9,
 151 #endif
 152 #if defined(CONFIG_CMD_ELF)
 153         [IH_OS_VXWORKS] = do_bootm_vxworks,
 154         [IH_OS_QNX] = do_bootm_qnxelf,
 155 #endif
 156 #ifdef CONFIG_INTEGRITY
 157         [IH_OS_INTEGRITY] = do_bootm_integrity,
 158 #endif
 159 };
 160
 161 bootm_headers_t images;         /* pointers to os/initrd/fdt images */
 162
 163 /* Allow for arch specific config before we boot */
 164 static void __arch_preboot_os(void)
 165 {
 166         /* please define platform specific arch_preboot_os() */
 167 }
 168 void arch_preboot_os(void) __attribute__((weak, alias("__arch_preboot_os")));
 169
 170 #define IH_INITRD_ARCH IH_ARCH_DEFAULT
 171
 172 #ifdef CONFIG_LMB
 173 static void boot_start_lmb(bootm_headers_t *images)
 174 {
 175         ulong           mem_start;
 176         phys_size_t     mem_size;
 177
 178         lmb_init(&images->lmb);
 179
 180         mem_start = getenv_bootm_low();
 181         mem_size = getenv_bootm_size();
 182
 183         lmb_add(&images->lmb, (phys_addr_t)mem_start, mem_size);
 184
 185         arch_lmb_reserve(&images->lmb);
 186         board_lmb_reserve(&images->lmb);
 187 }
 188 #else
 189 #define lmb_reserve(lmb, base, size)
 190 static inline void boot_start_lmb(bootm_headers_t *images) { }
 191 #endif
 192
 193 static int bootm_start(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
 194 {
 195         memset((void *)&images, 0, sizeof(images));
 196         images.verify = getenv_yesno("verify");
 197
 198         boot_start_lmb(&images);
 199
 200         bootstage_mark_name(BOOTSTAGE_ID_BOOTM_START, "bootm_start");
 201         images.state = BOOTM_STATE_START;
 202
 203         return 0;
 204 }
 205
 206 static int bootm_find_os(cmd_tbl_t *cmdtp, int flag, int argc,
 207                          char * const argv[])
 208 {
 209         const void *os_hdr;
 210
 211         /* get kernel image header, start address and length */
 212         os_hdr = boot_get_kernel(cmdtp, flag, argc, argv,
 213                         &images, &images.os.image_start, &images.os.image_len);
 214         if (images.os.image_len == 0) {
 215                 puts("ERROR: can't get kernel image!\n");
 216                 return 1;
 217         }
 218
 219         /* get image parameters */
 220         switch (genimg_get_format(os_hdr)) {
 221         case IMAGE_FORMAT_LEGACY:
 222                 images.os.type = image_get_type(os_hdr);
 223                 images.os.comp = image_get_comp(os_hdr);
 224                 images.os.os = image_get_os(os_hdr);
 225
 226                 images.os.end = image_get_image_end(os_hdr);
 227                 images.os.load = image_get_load(os_hdr);
 228                 break;
 229 #if defined(CONFIG_FIT)
 230         case IMAGE_FORMAT_FIT:
 231                 if (fit_image_get_type(images.fit_hdr_os,
 232                                         images.fit_noffset_os, &images.os.type)) {
 233                         puts("Can't get image type!\n");
 234                         bootstage_error(BOOTSTAGE_ID_FIT_TYPE);
 235                         return 1;
 236                 }
 237
 238                 if (fit_image_get_comp(images.fit_hdr_os,
 239                                         images.fit_noffset_os, &images.os.comp)) {
 240                         puts("Can't get image compression!\n");
 241                         bootstage_error(BOOTSTAGE_ID_FIT_COMPRESSION);
 242                         return 1;
 243                 }
 244
 245                 if (fit_image_get_os(images.fit_hdr_os,
 246                                         images.fit_noffset_os, &images.os.os)) {
 247                         puts("Can't get image OS!\n");
 248                         bootstage_error(BOOTSTAGE_ID_FIT_OS);
 249                         return 1;
 250                 }
 251
 252                 images.os.end = fit_get_end(images.fit_hdr_os);
 253
 254                 if (fit_image_get_load(images.fit_hdr_os, images.fit_noffset_os,
 255                                         &images.os.load)) {
 256                         puts("Can't get image load address!\n");
 257                         bootstage_error(BOOTSTAGE_ID_FIT_LOADADDR);
 258                         return 1;
 259                 }
 260                 break;
 261 #endif
 262         default:
 263                 puts("ERROR: unknown image format type!\n");
 264                 return 1;
 265         }
 266
 267         /* find kernel entry point */
 268         if (images.legacy_hdr_valid) {
 269                 images.ep = image_get_ep(&images.legacy_hdr_os_copy);
 270 #if defined(CONFIG_FIT)
 271         } else if (images.fit_uname_os) {
 272                 int ret;
 273
 274                 ret = fit_image_get_entry(images.fit_hdr_os,
 275                                           images.fit_noffset_os, &images.ep);
 276                 if (ret) {
 277                         puts("Can't get entry point property!\n");
 278                         return 1;
 279                 }
 280 #endif
 281         } else {
 282                 puts("Could not find kernel entry point!\n");
 283                 return 1;
 284         }
 285
 286         if (images.os.type == IH_TYPE_KERNEL_NOLOAD) {
 287                 images.os.load = images.os.image_start;
 288                 images.ep += images.os.load;
 289         }
 290
 291         images.os.start = (ulong)os_hdr;
 292
 293         return 0;
 294 }
 295
 296 static int bootm_find_ramdisk(int flag, int argc, char * const argv[])
 297 {
 298         int ret;
 299
 300         /* find ramdisk */
 301         ret = boot_get_ramdisk(argc, argv, &images, IH_INITRD_ARCH,
 302                                &images.rd_start, &images.rd_end);
 303         if (ret) {
 304                 puts("Ramdisk image is corrupt or invalid\n");
 305                 return 1;
 306         }
 307
 308         return 0;
 309 }
 310
 311 #if defined(CONFIG_OF_LIBFDT)
 312 static int bootm_find_fdt(int flag, int argc, char * const argv[])
 313 {
 314         int ret;
 315
 316         /* find flattened device tree */
 317         ret = boot_get_fdt(flag, argc, argv, IH_ARCH_DEFAULT, &images,
 318                            &images.ft_addr, &images.ft_len);
 319         if (ret) {
 320                 puts("Could not find a valid device tree\n");
 321                 return 1;
 322         }
 323
 324         set_working_fdt_addr(images.ft_addr);
 325
 326         return 0;
 327 }
 328 #endif
 329
 330 static int bootm_find_other(cmd_tbl_t *cmdtp, int flag, int argc,
 331                             char * const argv[])
 332 {
 333         if (((images.os.type == IH_TYPE_KERNEL) ||
 334              (images.os.type == IH_TYPE_KERNEL_NOLOAD) ||
 335              (images.os.type == IH_TYPE_MULTI)) &&
 336             (images.os.os == IH_OS_LINUX)) {
 337                 if (bootm_find_ramdisk(flag, argc, argv))
 338                         return 1;
 339
 340 #if defined(CONFIG_OF_LIBFDT)
 341                 if (bootm_find_fdt(flag, argc, argv))
 342                         return 1;
 343 #endif
 344         }
 345
 346         return 0;
 347 }
 348
 349 #define BOOTM_ERR_RESET         -1
 350 #define BOOTM_ERR_OVERLAP       -2
 351 #define BOOTM_ERR_UNIMPLEMENTED -3
 352 static int bootm_load_os(bootm_headers_t *images, unsigned long *load_end,
 353                 int boot_progress)
 354 {
 355         image_info_t os = images->os;
 356         uint8_t comp = os.comp;
 357         ulong load = os.load;
 358         ulong blob_start = os.start;
 359         ulong blob_end = os.end;
 360         ulong image_start = os.image_start;
 361         ulong image_len = os.image_len;
 362         __maybe_unused uint unc_len = CONFIG_SYS_BOOTM_LEN;
 363         int no_overlap = 0;
 364         void *load_buf, *image_buf;
 365 #if defined(CONFIG_LZMA) || defined(CONFIG_LZO)
 366         int ret;
 367 #endif /* defined(CONFIG_LZMA) || defined(CONFIG_LZO) */
 368
 369         const char *type_name = genimg_get_type_name(os.type);
 370
 371         load_buf = map_sysmem(load, unc_len);
 372         image_buf = map_sysmem(image_start, image_len);
 373         switch (comp) {
 374         case IH_COMP_NONE:
 375                 if (load == blob_start || load == image_start) {
 376                         printf("   XIP %s ... ", type_name);
 377                         no_overlap = 1;
 378                 } else {
 379                         printf("   Loading %s ... ", type_name);
 380                         memmove_wd(load_buf, image_buf, image_len, CHUNKSZ);
 381                 }
 382                 *load_end = load + image_len;
 383                 break;
 384 #ifdef CONFIG_GZIP
 385         case IH_COMP_GZIP:
 386                 printf("   Uncompressing %s ... ", type_name);
 387                 if (gunzip(load_buf, unc_len, image_buf, &image_len) != 0) {
 388                         puts("GUNZIP: uncompress, out-of-mem or overwrite "
 389                                 "error - must RESET board to recover\n");
 390                         if (boot_progress)
 391                                 bootstage_error(BOOTSTAGE_ID_DECOMP_IMAGE);
 392                         return BOOTM_ERR_RESET;
 393                 }
 394
 395                 *load_end = load + image_len;
 396                 break;
 397 #endif /* CONFIG_GZIP */
 398 #ifdef CONFIG_BZIP2
 399         case IH_COMP_BZIP2:
 400                 printf("   Uncompressing %s ... ", type_name);
 401                 /*
 402                  * If we've got less than 4 MB of malloc() space,
 403                  * use slower decompression algorithm which requires
 404                  * at most 2300 KB of memory.
 405                  */
 406                 int i = BZ2_bzBuffToBuffDecompress(load_buf, &unc_len,
 407                         image_buf, image_len,
 408                         CONFIG_SYS_MALLOC_LEN < (4096 * 1024), 0);
 409                 if (i != BZ_OK) {
 410                         printf("BUNZIP2: uncompress or overwrite error %d "
 411                                 "- must RESET board to recover\n", i);
 412                         if (boot_progress)
 413                                 bootstage_error(BOOTSTAGE_ID_DECOMP_IMAGE);
 414                         return BOOTM_ERR_RESET;
 415                 }
 416
 417                 *load_end = load + unc_len;
 418                 break;
 419 #endif /* CONFIG_BZIP2 */
 420 #ifdef CONFIG_LZMA
 421         case IH_COMP_LZMA: {
 422                 SizeT lzma_len = unc_len;
 423                 printf("   Uncompressing %s ... ", type_name);
 424
 425                 ret = lzmaBuffToBuffDecompress(load_buf, &lzma_len,
 426                                                image_buf, image_len);
 427                 unc_len = lzma_len;
 428                 if (ret != SZ_OK) {
 429                         printf("LZMA: uncompress or overwrite error %d "
 430                                 "- must RESET board to recover\n", ret);
 431                         bootstage_error(BOOTSTAGE_ID_DECOMP_IMAGE);
 432                         return BOOTM_ERR_RESET;
 433                 }
 434                 *load_end = load + unc_len;
 435                 break;
 436         }
 437 #endif /* CONFIG_LZMA */
 438 #ifdef CONFIG_LZO
 439         case IH_COMP_LZO: {
 440                 size_t size;
 441
 442                 printf("   Uncompressing %s ... ", type_name);
 443
 444                 ret = lzop_decompress(image_buf, image_len, load_buf, &size);
 445                 if (ret != LZO_E_OK) {
 446                         printf("LZO: uncompress or overwrite error %d "
 447                               "- must RESET board to recover\n", ret);
 448                         if (boot_progress)
 449                                 bootstage_error(BOOTSTAGE_ID_DECOMP_IMAGE);
 450                         return BOOTM_ERR_RESET;
 451                 }
 452
 453                 *load_end = load + size;
 454                 break;
 455         }
 456 #endif /* CONFIG_LZO */
 457         default:
 458                 printf("Unimplemented compression type %d\n", comp);
 459                 return BOOTM_ERR_UNIMPLEMENTED;
 460         }
 461
 462         flush_cache(load, (*load_end - load) * sizeof(ulong));
 463
 464         puts("OK\n");
 465         debug("   kernel loaded at 0x%08lx, end = 0x%08lx\n", load, *load_end);
 466         bootstage_mark(BOOTSTAGE_ID_KERNEL_LOADED);
 467
 468         if (!no_overlap && (load < blob_end) && (*load_end > blob_start)) {
 469                 debug("images.os.start = 0x%lX, images.os.end = 0x%lx\n",
 470                         blob_start, blob_end);
 471                 debug("images.os.load = 0x%lx, load_end = 0x%lx\n", load,
 472                         *load_end);
 473
 474                 /* Check what type of image this is. */
 475                 if (images->legacy_hdr_valid) {
 476                         if (image_get_type(&images->legacy_hdr_os_copy)
 477                                         == IH_TYPE_MULTI)
 478                                 puts("WARNING: legacy format multi component image overwritten\n");
 479                         return BOOTM_ERR_OVERLAP;
 480                 } else {
 481                         puts("ERROR: new format image overwritten - must RESET the board to recover\n");
 482                         bootstage_error(BOOTSTAGE_ID_OVERWRITTEN);
 483                         return BOOTM_ERR_RESET;
 484                 }
 485         }
 486
 487         return 0;
 488 }
 489
 490 static int bootm_start_standalone(int argc, char * const argv[])
 491 {
 492         char  *s;
 493         int   (*appl)(int, char * const []);
 494
 495         /* Don't start if "autostart" is set to "no" */
 496         if (((s = getenv("autostart")) != NULL) && (strcmp(s, "no") == 0)) {
 497                 setenv_hex("filesize", images.os.image_len);
 498                 return 0;
 499         }
 500         appl = (int (*)(int, char * const []))(ulong)ntohl(images.ep);
 501         (*appl)(argc, argv);
 502         return 0;
 503 }
 504
 505 /* we overload the cmd field with our state machine info instead of a
 506  * function pointer */
 507 static cmd_tbl_t cmd_bootm_sub[] = {
 508         U_BOOT_CMD_MKENT(start, 0, 1, (void *)BOOTM_STATE_START, "", ""),
 509         U_BOOT_CMD_MKENT(loados, 0, 1, (void *)BOOTM_STATE_LOADOS, "", ""),
 510 #ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH
 511         U_BOOT_CMD_MKENT(ramdisk, 0, 1, (void *)BOOTM_STATE_RAMDISK, "", ""),
 512 #endif
 513 #ifdef CONFIG_OF_LIBFDT
 514         U_BOOT_CMD_MKENT(fdt, 0, 1, (void *)BOOTM_STATE_FDT, "", ""),
 515 #endif
 516         U_BOOT_CMD_MKENT(cmdline, 0, 1, (void *)BOOTM_STATE_OS_CMDLINE, "", ""),
 517         U_BOOT_CMD_MKENT(bdt, 0, 1, (void *)BOOTM_STATE_OS_BD_T, "", ""),
 518         U_BOOT_CMD_MKENT(prep, 0, 1, (void *)BOOTM_STATE_OS_PREP, "", ""),
 519         U_BOOT_CMD_MKENT(fake, 0, 1, (void *)BOOTM_STATE_OS_FAKE_GO, "", ""),
 520         U_BOOT_CMD_MKENT(go, 0, 1, (void *)BOOTM_STATE_OS_GO, "", ""),
 521 };
 522
 523 static int boot_selected_os(int argc, char * const argv[], int state,
 524                 bootm_headers_t *images, boot_os_fn *boot_fn)
 525 {
 526         if (images->os.type == IH_TYPE_STANDALONE) {
 527                 /* This may return when 'autostart' is 'no' */
 528                 bootm_start_standalone(argc, argv);
 529                 return 0;
 530         }
 531         arch_preboot_os();
 532         boot_fn(state, argc, argv, images);
 533         if (state == BOOTM_STATE_OS_FAKE_GO) /* We expect to return */
 534                 return 0;
 535         bootstage_error(BOOTSTAGE_ID_BOOT_OS_RETURNED);
 536 #ifdef DEBUG
 537         puts("\n## Control returned to monitor - resetting...\n");
 538 #endif
 539         return BOOTM_ERR_RESET;
 540 }
 541
 542 /**
 543  * bootm_disable_interrupts() - Disable interrupts in preparation for load/boot
 544  *
 545  * @return interrupt flag (0 if interrupts were disabled, non-zero if they were
 546  *      enabled)
 547  */
 548 static ulong bootm_disable_interrupts(void)
 549 {
 550         ulong iflag;
 551
 552         /*
 553          * We have reached the point of no return: we are going to
 554          * overwrite all exception vector code, so we cannot easily
 555          * recover from any failures any more...
 556          */
 557         iflag = disable_interrupts();
 558 #ifdef CONFIG_NETCONSOLE
 559         /* Stop the ethernet stack if NetConsole could have left it up */
 560         eth_halt();
 561 #endif
 562
 563 #if defined(CONFIG_CMD_USB)
 564         /*
 565          * turn off USB to prevent the host controller from writing to the
 566          * SDRAM while Linux is booting. This could happen (at least for OHCI
 567          * controller), because the HCCA (Host Controller Communication Area)
 568          * lies within the SDRAM and the host controller writes continously to
 569          * this area (as busmaster!). The HccaFrameNumber is for example
 570          * updated every 1 ms within the HCCA structure in SDRAM! For more
 571          * details see the OpenHCI specification.
 572          */
 573         usb_stop();
 574 #endif
 575         return iflag;
 576 }
 577
 578 /**
 579  * Execute selected states of the bootm command.
 580  *
 581  * Note the arguments to this state must be the first argument, Any 'bootm'
 582  * or sub-command arguments must have already been taken.
 583  *
 584  * Note that if states contains more than one flag it MUST contain
 585  * BOOTM_STATE_START, since this handles and consumes the command line args.
 586  *
 587  * Also note that aside from boot_os_fn functions and bootm_load_os no other
 588  * functions we store the return value of in 'ret' may use a negative return
 589  * value, without special handling.
 590  *
 591  * @param cmdtp         Pointer to bootm command table entry
 592  * @param flag          Command flags (CMD_FLAG_...)
 593  * @param argc          Number of subcommand arguments (0 = no arguments)
 594  * @param argv          Arguments
 595  * @param states        Mask containing states to run (BOOTM_STATE_...)
 596  * @param images        Image header information
 597  * @param boot_progress 1 to show boot progress, 0 to not do this
 598  * @return 0 if ok, something else on error. Some errors will cause this
 599  *      function to perform a reboot! If states contains BOOTM_STATE_OS_GO
 600  *      then the intent is to boot an OS, so this function will not return
 601  *      unless the image type is standalone.
 602  */
 603 static int do_bootm_states(cmd_tbl_t *cmdtp, int flag, int argc,
 604                 char * const argv[], int states, bootm_headers_t *images,
 605                 int boot_progress)
 606 {
 607         boot_os_fn *boot_fn;
 608         ulong iflag = 0;
 609         int ret = 0, need_boot_fn;
 610
 611         images->state |= states;
 612
 613         /*
 614          * Work through the states and see how far we get. We stop on
 615          * any error.
 616          */
 617         if (states & BOOTM_STATE_START)
 618                 ret = bootm_start(cmdtp, flag, argc, argv);
 619
 620         if (!ret && (states & BOOTM_STATE_FINDOS))
 621                 ret = bootm_find_os(cmdtp, flag, argc, argv);
 622
 623         if (!ret && (states & BOOTM_STATE_FINDOTHER)) {
 624                 ret = bootm_find_other(cmdtp, flag, argc, argv);
 625                 argc = 0;       /* consume the args */
 626         }
 627
 628         /* Load the OS */
 629         if (!ret && (states & BOOTM_STATE_LOADOS)) {
 630                 ulong load_end;
 631
 632                 iflag = bootm_disable_interrupts();
 633                 ret = bootm_load_os(images, &load_end, 0);
 634                 if (ret == 0)
 635                         lmb_reserve(&images->lmb, images->os.load,
 636                                     (load_end - images->os.load));
 637                 else if (ret && ret != BOOTM_ERR_OVERLAP)
 638                         goto err;
 639                 else if (ret == BOOTM_ERR_OVERLAP)
 640                         ret = 0;
 641 #if defined(CONFIG_SILENT_CONSOLE) && !defined(CONFIG_SILENT_U_BOOT_ONLY)
 642                 if (images->os.os == IH_OS_LINUX)
 643                         fixup_silent_linux();
 644 #endif
 645         }
 646
 647         /* Relocate the ramdisk */
 648 #ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH
 649         if (!ret && (states & BOOTM_STATE_RAMDISK)) {
 650                 ulong rd_len = images->rd_end - images->rd_start;
 651
 652                 ret = boot_ramdisk_high(&images->lmb, images->rd_start,
 653                         rd_len, &images->initrd_start, &images->initrd_end);
 654                 if (!ret) {
 655                         setenv_hex("initrd_start", images->initrd_start);
 656                         setenv_hex("initrd_end", images->initrd_end);
 657                 }
 658         }
 659 #endif
 660 #if defined(CONFIG_OF_LIBFDT) && defined(CONFIG_LMB)
 661         if (!ret && (states & BOOTM_STATE_FDT)) {
 662                 boot_fdt_add_mem_rsv_regions(&images->lmb, images->ft_addr);
 663                 ret = boot_relocate_fdt(&images->lmb, &images->ft_addr,
 664                                         &images->ft_len);
 665         }
 666 #endif
 667
 668         /* From now on, we need the OS boot function */
 669         if (ret)
 670                 return ret;
 671         boot_fn = boot_os[images->os.os];
 672         need_boot_fn = states & (BOOTM_STATE_OS_CMDLINE |
 673                         BOOTM_STATE_OS_BD_T | BOOTM_STATE_OS_PREP |
 674                         BOOTM_STATE_OS_FAKE_GO | BOOTM_STATE_OS_GO);
 675         if (boot_fn == NULL && need_boot_fn) {
 676                 if (iflag)
 677                         enable_interrupts();
 678                 printf("ERROR: booting os '%s' (%d) is not supported\n",
 679                        genimg_get_os_name(images->os.os), images->os.os);
 680                 bootstage_error(BOOTSTAGE_ID_CHECK_BOOT_OS);
 681                 return 1;
 682         }
 683
 684         /* Call various other states that are not generally used */
 685         if (!ret && (states & BOOTM_STATE_OS_CMDLINE))
 686                 ret = boot_fn(BOOTM_STATE_OS_CMDLINE, argc, argv, images);
 687         if (!ret && (states & BOOTM_STATE_OS_BD_T))
 688                 ret = boot_fn(BOOTM_STATE_OS_BD_T, argc, argv, images);
 689         if (!ret && (states & BOOTM_STATE_OS_PREP))
 690                 ret = boot_fn(BOOTM_STATE_OS_PREP, argc, argv, images);
 691
 692 #ifdef CONFIG_TRACE
 693         /* Pretend to run the OS, then run a user command */
 694         if (!ret && (states & BOOTM_STATE_OS_FAKE_GO)) {
 695                 char *cmd_list = getenv("fakegocmd");
 696
 697                 ret = boot_selected_os(argc, argv, BOOTM_STATE_OS_FAKE_GO,
 698                                 images, boot_fn);
 699                 if (!ret && cmd_list)
 700                         ret = run_command_list(cmd_list, -1, flag);
 701         }
 702 #endif
 703
 704         /* Check for unsupported subcommand. */
 705         if (ret) {
 706                 puts("subcommand not supported\n");
 707                 return ret;
 708         }
 709
 710         /* Now run the OS! We hope this doesn't return */
 711         if (!ret && (states & BOOTM_STATE_OS_GO))
 712                 ret = boot_selected_os(argc, argv, BOOTM_STATE_OS_GO,
 713                                 images, boot_fn);
 714
 715         /* Deal with any fallout */
 716 err:
 717         if (iflag)
 718                 enable_interrupts();
 719
 720         if (ret == BOOTM_ERR_UNIMPLEMENTED)
 721                 bootstage_error(BOOTSTAGE_ID_DECOMP_UNIMPL);
 722         else if (ret == BOOTM_ERR_RESET)
 723                 do_reset(cmdtp, flag, argc, argv);
 724
 725         return ret;
 726 }
 727
 728 static int do_bootm_subcommand(cmd_tbl_t *cmdtp, int flag, int argc,
 729                         char * const argv[])
 730 {
 731         int ret = 0;
 732         long state;
 733         cmd_tbl_t *c;
 734
 735         c = find_cmd_tbl(argv[0], &cmd_bootm_sub[0], ARRAY_SIZE(cmd_bootm_sub));
 736         argc--; argv++;
 737
 738         if (c) {
 739                 state = (long)c->cmd;
 740                 if (state == BOOTM_STATE_START)
 741                         state |= BOOTM_STATE_FINDOS | BOOTM_STATE_FINDOTHER;
 742         } else {
 743                 /* Unrecognized command */
 744                 return CMD_RET_USAGE;
 745         }
 746
 747         if (state != BOOTM_STATE_START && images.state >= state) {
 748                 printf("Trying to execute a command out of order\n");
 749                 return CMD_RET_USAGE;
 750         }
 751
 752         ret = do_bootm_states(cmdtp, flag, argc, argv, state, &images, 0);
 753
 754         return ret;
 755 }
 756
 757 /*******************************************************************/
 758 /* bootm - boot application image from image in memory */
 759 /*******************************************************************/
 760
 761 int do_bootm(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
 762 {
 763 #ifdef CONFIG_NEEDS_MANUAL_RELOC
 764         static int relocated = 0;
 765
 766         if (!relocated) {
 767                 int i;
 768
 769                 /* relocate boot function table */
 770                 for (i = 0; i < ARRAY_SIZE(boot_os); i++)
 771                         if (boot_os[i] != NULL)
 772                                 boot_os[i] += gd->reloc_off;
 773
 774                 /* relocate names of sub-command table */
 775                 for (i = 0; i < ARRAY_SIZE(cmd_bootm_sub); i++)
 776                         cmd_bootm_sub[i].name += gd->reloc_off;
 777
 778                 relocated = 1;
 779         }
 780 #endif
 781
 782         /* determine if we have a sub command */
 783         argc--; argv++;
 784         if (argc > 0) {
 785                 char *endp;
 786
 787                 simple_strtoul(argv[0], &endp, 16);
 788                 /* endp pointing to NULL means that argv[0] was just a
 789                  * valid number, pass it along to the normal bootm processing
 790                  *
 791                  * If endp is ':' or '#' assume a FIT identifier so pass
 792                  * along for normal processing.
 793                  *
 794                  * Right now we assume the first arg should never be '-'
 795                  */
 796                 if ((*endp != 0) && (*endp != ':') && (*endp != '#'))
 797                         return do_bootm_subcommand(cmdtp, flag, argc, argv);
 798         }
 799
 800         return do_bootm_states(cmdtp, flag, argc, argv, BOOTM_STATE_START |
 801                 BOOTM_STATE_FINDOS | BOOTM_STATE_FINDOTHER |
 802                 BOOTM_STATE_LOADOS | BOOTM_STATE_OS_PREP |
 803                 BOOTM_STATE_OS_FAKE_GO | BOOTM_STATE_OS_GO, &images, 1);
 804 }
 805
 806 int bootm_maybe_autostart(cmd_tbl_t *cmdtp, const char *cmd)
 807 {
 808         const char *ep = getenv("autostart");
 809
 810         if (ep && !strcmp(ep, "yes")) {
 811                 char *local_args[2];
 812                 local_args[0] = (char *)cmd;
 813                 local_args[1] = NULL;
 814                 printf("Automatic boot of image at addr 0x%08lX ...\n", load_addr);
 815                 return do_bootm(cmdtp, 0, 1, local_args);
 816         }
 817
 818         return 0;
 819 }
 820
 821 /**
 822  * image_get_kernel - verify legacy format kernel image
 823  * @img_addr: in RAM address of the legacy format image to be verified
 824  * @verify: data CRC verification flag
 825  *
 826  * image_get_kernel() verifies legacy image integrity and returns pointer to
 827  * legacy image header if image verification was completed successfully.
 828  *
 829  * returns:
 830  *     pointer to a legacy image header if valid image was found
 831  *     otherwise return NULL
 832  */
 833 static image_header_t *image_get_kernel(ulong img_addr, int verify)
 834 {
 835         image_header_t *hdr = (image_header_t *)img_addr;
 836
 837         if (!image_check_magic(hdr)) {
 838                 puts("Bad Magic Number\n");
 839                 bootstage_error(BOOTSTAGE_ID_CHECK_MAGIC);
 840                 return NULL;
 841         }
 842         bootstage_mark(BOOTSTAGE_ID_CHECK_HEADER);
 843
 844         if (!image_check_hcrc(hdr)) {
 845                 puts("Bad Header Checksum\n");
 846                 bootstage_error(BOOTSTAGE_ID_CHECK_HEADER);
 847                 return NULL;
 848         }
 849
 850         bootstage_mark(BOOTSTAGE_ID_CHECK_CHECKSUM);
 851         image_print_contents(hdr);
 852
 853         if (verify) {
 854                 puts("   Verifying Checksum ... ");
 855                 if (!image_check_dcrc(hdr)) {
 856                         printf("Bad Data CRC\n");
 857                         bootstage_error(BOOTSTAGE_ID_CHECK_CHECKSUM);
 858                         return NULL;
 859                 }
 860                 puts("OK\n");
 861         }
 862         bootstage_mark(BOOTSTAGE_ID_CHECK_ARCH);
 863
 864         if (!image_check_target_arch(hdr)) {
 865                 printf("Unsupported Architecture 0x%x\n", image_get_arch(hdr));
 866                 bootstage_error(BOOTSTAGE_ID_CHECK_ARCH);
 867                 return NULL;
 868         }
 869         return hdr;
 870 }
 871
 872 /**
 873  * boot_get_kernel - find kernel image
 874  * @os_data: pointer to a ulong variable, will hold os data start address
 875  * @os_len: pointer to a ulong variable, will hold os data length
 876  *
 877  * boot_get_kernel() tries to find a kernel image, verifies its integrity
 878  * and locates kernel data.
 879  *
 880  * returns:
 881  *     pointer to image header if valid image was found, plus kernel start
 882  *     address and length, otherwise NULL
 883  */
 884 static const void *boot_get_kernel(cmd_tbl_t *cmdtp, int flag, int argc,
 885                 char * const argv[], bootm_headers_t *images, ulong *os_data,
 886                 ulong *os_len)
 887 {
 888         image_header_t  *hdr;
 889         ulong           img_addr;
 890         const void *buf;
 891 #if defined(CONFIG_FIT)
 892         const char      *fit_uname_config = NULL;
 893         const char      *fit_uname_kernel = NULL;
 894         int             os_noffset;
 895 #endif
 896
 897         /* find out kernel image address */
 898         if (argc < 1) {
 899                 img_addr = load_addr;
 900                 debug("*  kernel: default image load address = 0x%08lx\n",
 901                                 load_addr);
 902 #if defined(CONFIG_FIT)
 903         } else if (fit_parse_conf(argv[0], load_addr, &img_addr,
 904                                                         &fit_uname_config)) {
 905                 debug("*  kernel: config '%s' from image at 0x%08lx\n",
 906                                 fit_uname_config, img_addr);
 907         } else if (fit_parse_subimage(argv[0], load_addr, &img_addr,
 908                                                         &fit_uname_kernel)) {
 909                 debug("*  kernel: subimage '%s' from image at 0x%08lx\n",
 910                                 fit_uname_kernel, img_addr);
 911 #endif
 912         } else {
 913                 img_addr = simple_strtoul(argv[0], NULL, 16);
 914                 debug("*  kernel: cmdline image address = 0x%08lx\n", img_addr);
 915         }
 916
 917         bootstage_mark(BOOTSTAGE_ID_CHECK_MAGIC);
 918
 919         /* copy from dataflash if needed */
 920         img_addr = genimg_get_image(img_addr);
 921
 922         /* check image type, for FIT images get FIT kernel node */
 923         *os_data = *os_len = 0;
 924         buf = map_sysmem(img_addr, 0);
 925         switch (genimg_get_format(buf)) {
 926         case IMAGE_FORMAT_LEGACY:
 927                 printf("## Booting kernel from Legacy Image at %08lx ...\n",
 928                                 img_addr);
 929                 hdr = image_get_kernel(img_addr, images->verify);
 930                 if (!hdr)
 931                         return NULL;
 932                 bootstage_mark(BOOTSTAGE_ID_CHECK_IMAGETYPE);
 933
 934                 /* get os_data and os_len */
 935                 switch (image_get_type(hdr)) {
 936                 case IH_TYPE_KERNEL:
 937                 case IH_TYPE_KERNEL_NOLOAD:
 938                         *os_data = image_get_data(hdr);
 939                         *os_len = image_get_data_size(hdr);
 940                         break;
 941                 case IH_TYPE_MULTI:
 942                         image_multi_getimg(hdr, 0, os_data, os_len);
 943                         break;
 944                 case IH_TYPE_STANDALONE:
 945                         *os_data = image_get_data(hdr);
 946                         *os_len = image_get_data_size(hdr);
 947                         break;
 948                 default:
 949                         printf("Wrong Image Type for %s command\n",
 950                                 cmdtp->name);
 951                         bootstage_error(BOOTSTAGE_ID_CHECK_IMAGETYPE);
 952                         return NULL;
 953                 }
 954
 955                 /*
 956                  * copy image header to allow for image overwrites during
 957                  * kernel decompression.
 958                  */
 959                 memmove(&images->legacy_hdr_os_copy, hdr,
 960                         sizeof(image_header_t));
 961
 962                 /* save pointer to image header */
 963                 images->legacy_hdr_os = hdr;
 964
 965                 images->legacy_hdr_valid = 1;
 966                 bootstage_mark(BOOTSTAGE_ID_DECOMP_IMAGE);
 967                 break;
 968 #if defined(CONFIG_FIT)
 969         case IMAGE_FORMAT_FIT:
 970                 os_noffset = fit_image_load(images, FIT_KERNEL_PROP,
 971                                 img_addr,
 972                                 &fit_uname_kernel, &fit_uname_config,
 973                                 IH_ARCH_DEFAULT, IH_TYPE_KERNEL,
 974                                 BOOTSTAGE_ID_FIT_KERNEL_START,
 975                                 FIT_LOAD_IGNORED, os_data, os_len);
 976                 if (os_noffset < 0)
 977                         return NULL;
 978
 979                 images->fit_hdr_os = map_sysmem(img_addr, 0);
 980                 images->fit_uname_os = fit_uname_kernel;
 981                 images->fit_uname_cfg = fit_uname_config;
 982                 images->fit_noffset_os = os_noffset;
 983                 break;
 984 #endif
 985         default:
 986                 printf("Wrong Image Format for %s command\n", cmdtp->name);
 987                 bootstage_error(BOOTSTAGE_ID_FIT_KERNEL_INFO);
 988                 return NULL;
 989         }
 990
 991         debug("   kernel data at 0x%08lx, len = 0x%08lx (%ld)\n",
 992                         *os_data, *os_len, *os_len);
 993
 994         return buf;
 995 }
 996
 997 #ifdef CONFIG_SYS_LONGHELP
 998 static char bootm_help_text[] =
 999         "[addr [arg ...]]\n    - boot application image stored in memory\n"
1000         "\tpassing arguments 'arg ...'; when booting a Linux kernel,\n"
1001         "\t'arg' can be the address of an initrd image\n"
1002 #if defined(CONFIG_OF_LIBFDT)
1003         "\tWhen booting a Linux kernel which requires a flat device-tree\n"
1004         "\ta third argument is required which is the address of the\n"
1005         "\tdevice-tree blob. To boot that kernel without an initrd image,\n"
1006         "\tuse a '-' for the second argument. If you do not pass a third\n"
1007         "\ta bd_info struct will be passed instead\n"
1008 #endif
1009 #if defined(CONFIG_FIT)
1010         "\t\nFor the new multi component uImage format (FIT) addresses\n"
1011         "\tmust be extened to include component or configuration unit name:\n"
1012         "\taddr:<subimg_uname> - direct component image specification\n"
1013         "\taddr#<conf_uname>   - configuration specification\n"
1014         "\tUse iminfo command to get the list of existing component\n"
1015         "\timages and configurations.\n"
1016 #endif
1017         "\nSub-commands to do part of the bootm sequence.  The sub-commands "
1018         "must be\n"
1019         "issued in the order below (it's ok to not issue all sub-commands):\n"
1020         "\tstart [addr [arg ...]]\n"
1021         "\tloados  - load OS image\n"
1022 #if defined(CONFIG_SYS_BOOT_RAMDISK_HIGH)
1023         "\tramdisk - relocate initrd, set env initrd_start/initrd_end\n"
1024 #endif
1025 #if defined(CONFIG_OF_LIBFDT)
1026         "\tfdt     - relocate flat device tree\n"
1027 #endif
1028         "\tcmdline - OS specific command line processing/setup\n"
1029         "\tbdt     - OS specific bd_t processing\n"
1030         "\tprep    - OS specific prep before relocation or go\n"
1031         "\tgo      - start OS";
1032 #endif
1033
1034 U_BOOT_CMD(
1035         bootm,  CONFIG_SYS_MAXARGS,     1,      do_bootm,
1036         "boot application image from memory", bootm_help_text
1037 );
1038
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[])
1044 {
1045         int rcode = 0;
1046
1047         if (run_command(getenv("bootcmd"), flag) < 0)
1048                 rcode = 1;
1049         return rcode;
1050 }
1051
1052 U_BOOT_CMD(
1053         boot,   1,      1,      do_bootd,
1054         "boot default, i.e., run 'bootcmd'",
1055         ""
1056 );
1057
1058 /* keep old command name "bootd" for backward compatibility */
1059 U_BOOT_CMD(
1060         bootd, 1,       1,      do_bootd,
1061         "boot default, i.e., run 'bootcmd'",
1062         ""
1063 );
1064
1065 #endif
1066
1067
1068 /*******************************************************************/
1069 /* iminfo - print header info for a requested image */
1070 /*******************************************************************/
1071 #if defined(CONFIG_CMD_IMI)
1072 static int do_iminfo(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
1073 {
1074         int     arg;
1075         ulong   addr;
1076         int     rcode = 0;
1077
1078         if (argc < 2) {
1079                 return image_info(load_addr);
1080         }
1081
1082         for (arg = 1; arg < argc; ++arg) {
1083                 addr = simple_strtoul(argv[arg], NULL, 16);
1084                 if (image_info(addr) != 0)
1085                         rcode = 1;
1086         }
1087         return rcode;
1088 }
1089
1090 static int image_info(ulong addr)
1091 {
1092         void *hdr = (void *)addr;
1093
1094         printf("\n## Checking Image at %08lx ...\n", addr);
1095
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");
1101                         return 1;
1102                 }
1103
1104                 if (!image_check_hcrc(hdr)) {
1105                         puts("   Bad Header Checksum\n");
1106                         return 1;
1107                 }
1108
1109                 image_print_contents(hdr);
1110
1111                 puts("   Verifying Checksum ... ");
1112                 if (!image_check_dcrc(hdr)) {
1113                         puts("   Bad Data CRC\n");
1114                         return 1;
1115                 }
1116                 puts("OK\n");
1117                 return 0;
1118 #if defined(CONFIG_FIT)
1119         case IMAGE_FORMAT_FIT:
1120                 puts("   FIT image found\n");
1121
1122                 if (!fit_check_format(hdr)) {
1123                         puts("Bad FIT image format!\n");
1124                         return 1;
1125                 }
1126
1127                 fit_print_contents(hdr);
1128
1129                 if (!fit_all_image_verify(hdr)) {
1130                         puts("Bad hash in FIT image!\n");
1131                         return 1;
1132                 }
1133
1134                 return 0;
1135 #endif
1136         default:
1137                 puts("Unknown image format!\n");
1138                 break;
1139         }
1140
1141         return 1;
1142 }
1143
1144 U_BOOT_CMD(
1145         iminfo, CONFIG_SYS_MAXARGS,     1,      do_iminfo,
1146         "print header information for application image",
1147         "addr [addr ...]\n"
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)"
1151 );
1152 #endif
1153
1154
1155 /*******************************************************************/
1156 /* imls - list all images found in flash */
1157 /*******************************************************************/
1158 #if defined(CONFIG_CMD_IMLS)
1159 static int do_imls_nor(void)
1160 {
1161         flash_info_t *info;
1162         int i, j;
1163         void *hdr;
1164
1165         for (i = 0, info = &flash_info[0];
1166                 i < CONFIG_SYS_MAX_FLASH_BANKS; ++i, ++info) {
1167
1168                 if (info->flash_id == FLASH_UNKNOWN)
1169                         goto next_bank;
1170                 for (j = 0; j < info->sector_count; ++j) {
1171
1172                         hdr = (void *)info->start[j];
1173                         if (!hdr)
1174                                 goto next_sector;
1175
1176                         switch (genimg_get_format(hdr)) {
1177                         case IMAGE_FORMAT_LEGACY:
1178                                 if (!image_check_hcrc(hdr))
1179                                         goto next_sector;
1180
1181                                 printf("Legacy Image at %08lX:\n", (ulong)hdr);
1182                                 image_print_contents(hdr);
1183
1184                                 puts("   Verifying Checksum ... ");
1185                                 if (!image_check_dcrc(hdr)) {
1186                                         puts("Bad Data CRC\n");
1187                                 } else {
1188                                         puts("OK\n");
1189                                 }
1190                                 break;
1191 #if defined(CONFIG_FIT)
1192                         case IMAGE_FORMAT_FIT:
1193                                 if (!fit_check_format(hdr))
1194                                         goto next_sector;
1195
1196                                 printf("FIT Image at %08lX:\n", (ulong)hdr);
1197                                 fit_print_contents(hdr);
1198                                 break;
1199 #endif
1200                         default:
1201                                 goto next_sector;
1202                         }
1203
1204 next_sector:            ;
1205                 }
1206 next_bank:      ;
1207         }
1208         return 0;
1209 }
1210 #endif
1211
1212 #if defined(CONFIG_CMD_IMLS_NAND)
1213 static int nand_imls_legacyimage(nand_info_t *nand, int nand_dev, loff_t off,
1214                 size_t len)
1215 {
1216         void *imgdata;
1217         int ret;
1218
1219         imgdata = malloc(len);
1220         if (!imgdata) {
1221                 printf("May be a Legacy Image at NAND device %d offset %08llX:\n",
1222                                 nand_dev, off);
1223                 printf("   Low memory(cannot allocate memory for image)\n");
1224                 return -ENOMEM;
1225         }
1226
1227         ret = nand_read_skip_bad(nand, off, &len,
1228                         imgdata);
1229         if (ret < 0 && ret != -EUCLEAN) {
1230                 free(imgdata);
1231                 return ret;
1232         }
1233
1234         if (!image_check_hcrc(imgdata)) {
1235                 free(imgdata);
1236                 return 0;
1237         }
1238
1239         printf("Legacy Image at NAND device %d offset %08llX:\n",
1240                         nand_dev, off);
1241         image_print_contents(imgdata);
1242
1243         puts("   Verifying Checksum ... ");
1244         if (!image_check_dcrc(imgdata))
1245                 puts("Bad Data CRC\n");
1246         else
1247                 puts("OK\n");
1248
1249         free(imgdata);
1250
1251         return 0;
1252 }
1253
1254 static int nand_imls_fitimage(nand_info_t *nand, int nand_dev, loff_t off,
1255                 size_t len)
1256 {
1257         void *imgdata;
1258         int ret;
1259
1260         imgdata = malloc(len);
1261         if (!imgdata) {
1262                 printf("May be a FIT Image at NAND device %d offset %08llX:\n",
1263                                 nand_dev, off);
1264                 printf("   Low memory(cannot allocate memory for image)\n");
1265                 return -ENOMEM;
1266         }
1267
1268         ret = nand_read_skip_bad(nand, off, &len,
1269                         imgdata);
1270         if (ret < 0 && ret != -EUCLEAN) {
1271                 free(imgdata);
1272                 return ret;
1273         }
1274
1275         if (!fit_check_format(imgdata)) {
1276                 free(imgdata);
1277                 return 0;
1278         }
1279
1280         printf("FIT Image at NAND device %d offset %08llX:\n", nand_dev, off);
1281
1282         fit_print_contents(imgdata);
1283         free(imgdata);
1284
1285         return 0;
1286 }
1287
1288 static int do_imls_nand(void)
1289 {
1290         nand_info_t *nand;
1291         int nand_dev = nand_curr_device;
1292         size_t len;
1293         loff_t off;
1294         u32 buffer[16];
1295
1296         if (nand_dev < 0 || nand_dev >= CONFIG_SYS_MAX_NAND_DEVICE) {
1297                 puts("\nNo NAND devices available\n");
1298                 return -ENODEV;
1299         }
1300
1301         printf("\n");
1302
1303         for (nand_dev = 0; nand_dev < CONFIG_SYS_MAX_NAND_DEVICE; nand_dev++) {
1304                 nand = &nand_info[nand_dev];
1305                 if (!nand->name || !nand->size)
1306                         continue;
1307
1308                 for (off = 0; off < nand->size; off += nand->erasesize) {
1309                         const image_header_t *header;
1310                         int ret;
1311
1312                         if (nand_block_isbad(nand, off))
1313                                 continue;
1314
1315                         len = sizeof(buffer);
1316
1317                         ret = nand_read(nand, off, &len, (u8 *)buffer);
1318                         if (ret < 0 && ret != -EUCLEAN) {
1319                                 printf("NAND read error %d at offset %08llX\n",
1320                                                 ret, off);
1321                                 continue;
1322                         }
1323
1324                         switch (genimg_get_format(buffer)) {
1325                         case IMAGE_FORMAT_LEGACY:
1326                                 header = (const image_header_t *)buffer;
1327
1328                                 len = image_get_image_size(header);
1329                                 nand_imls_legacyimage(nand, nand_dev, off, len);
1330                                 break;
1331 #if defined(CONFIG_FIT)
1332                         case IMAGE_FORMAT_FIT:
1333                                 len = fit_get_size(buffer);
1334                                 nand_imls_fitimage(nand, nand_dev, off, len);
1335                                 break;
1336 #endif
1337                         }
1338                 }
1339         }
1340
1341         return 0;
1342 }
1343 #endif
1344
1345 #if defined(CONFIG_CMD_IMLS) || defined(CONFIG_CMD_IMLS_NAND)
1346 static int do_imls(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
1347 {
1348         int ret_nor = 0, ret_nand = 0;
1349
1350 #if defined(CONFIG_CMD_IMLS)
1351         ret_nor = do_imls_nor();
1352 #endif
1353
1354 #if defined(CONFIG_CMD_IMLS_NAND)
1355         ret_nand = do_imls_nand();
1356 #endif
1357
1358         if (ret_nor)
1359                 return ret_nor;
1360
1361         if (ret_nand)
1362                 return ret_nand;
1363
1364         return (0);
1365 }
1366
1367 U_BOOT_CMD(
1368         imls,   1,              1,      do_imls,
1369         "list all images found in flash",
1370         "\n"
1371         "    - Prints information about all images found at sector/block\n"
1372         "      boundaries in nor/nand flash."
1373 );
1374 #endif
1375
1376 /*******************************************************************/
1377 /* helper routines */
1378 /*******************************************************************/
1379 #if defined(CONFIG_SILENT_CONSOLE) && !defined(CONFIG_SILENT_U_BOOT_ONLY)
1380
1381 #define CONSOLE_ARG     "console="
1382 #define CONSOLE_ARG_LEN (sizeof(CONSOLE_ARG) - 1)
1383
1384 static void fixup_silent_linux(void)
1385 {
1386         char *buf;
1387         const char *env_val;
1388         char *cmdline = getenv("bootargs");
1389         int want_silent;
1390
1391         /*
1392          * Only fix cmdline when requested. The environment variable can be:
1393          *
1394          *      no - we never fixup
1395          *      yes - we always fixup
1396          *      unset - we rely on the console silent flag
1397          */
1398         want_silent = getenv_yesno("silent_linux");
1399         if (want_silent == 0)
1400                 return;
1401         else if (want_silent == -1 && !(gd->flags & GD_FLG_SILENT))
1402                 return;
1403
1404         debug("before silent fix-up: %s\n", cmdline);
1405         if (cmdline && (cmdline[0] != '\0')) {
1406                 char *start = strstr(cmdline, CONSOLE_ARG);
1407
1408                 /* Allocate space for maximum possible new command line */
1409                 buf = malloc(strlen(cmdline) + 1 + CONSOLE_ARG_LEN + 1);
1410                 if (!buf) {
1411                         debug("%s: out of memory\n", __func__);
1412                         return;
1413                 }
1414
1415                 if (start) {
1416                         char *end = strchr(start, ' ');
1417                         int num_start_bytes = start - cmdline + CONSOLE_ARG_LEN;
1418
1419                         strncpy(buf, cmdline, num_start_bytes);
1420                         if (end)
1421                                 strcpy(buf + num_start_bytes, end);
1422                         else
1423                                 buf[num_start_bytes] = '\0';
1424                 } else {
1425                         sprintf(buf, "%s %s", cmdline, CONSOLE_ARG);
1426                 }
1427                 env_val = buf;
1428         } else {
1429                 buf = NULL;
1430                 env_val = CONSOLE_ARG;
1431         }
1432
1433         setenv("bootargs", env_val);
1434         debug("after silent fix-up: %s\n", env_val);
1435         free(buf);
1436 }
1437 #endif /* CONFIG_SILENT_CONSOLE */
1438
1439 #if defined(CONFIG_BOOTM_NETBSD) || defined(CONFIG_BOOTM_PLAN9)
1440 static void copy_args(char *dest, int argc, char * const argv[], char delim)
1441 {
1442         int i;
1443
1444         for (i = 0; i < argc; i++) {
1445                 if (i > 0)
1446                         *dest++ = delim;
1447                 strcpy(dest, argv[i]);
1448                 dest += strlen(argv[i]);
1449         }
1450 }
1451 #endif
1452
1453 /*******************************************************************/
1454 /* OS booting routines */
1455 /*******************************************************************/
1456
1457 #ifdef CONFIG_BOOTM_NETBSD
1458 static int do_bootm_netbsd(int flag, int argc, char * const argv[],
1459                             bootm_headers_t *images)
1460 {
1461         void (*loader)(bd_t *, image_header_t *, char *, char *);
1462         image_header_t *os_hdr, *hdr;
1463         ulong kernel_data, kernel_len;
1464         char *consdev;
1465         char *cmdline;
1466
1467         if (flag & BOOTM_STATE_OS_PREP)
1468                 return 0;
1469         if ((flag != 0) && (flag != BOOTM_STATE_OS_GO))
1470                 return 1;
1471
1472 #if defined(CONFIG_FIT)
1473         if (!images->legacy_hdr_valid) {
1474                 fit_unsupported_reset("NetBSD");
1475                 return 1;
1476         }
1477 #endif
1478         hdr = images->legacy_hdr_os;
1479
1480         /*
1481          * Booting a (NetBSD) kernel image
1482          *
1483          * This process is pretty similar to a standalone application:
1484          * The (first part of an multi-) image must be a stage-2 loader,
1485          * which in turn is responsible for loading & invoking the actual
1486          * kernel.  The only differences are the parameters being passed:
1487          * besides the board info strucure, the loader expects a command
1488          * line, the name of the console device, and (optionally) the
1489          * address of the original image header.
1490          */
1491         os_hdr = NULL;
1492         if (image_check_type(&images->legacy_hdr_os_copy, IH_TYPE_MULTI)) {
1493                 image_multi_getimg(hdr, 1, &kernel_data, &kernel_len);
1494                 if (kernel_len)
1495                         os_hdr = hdr;
1496         }
1497
1498         consdev = "";
1499 #if   defined(CONFIG_8xx_CONS_SMC1)
1500         consdev = "smc1";
1501 #elif defined(CONFIG_8xx_CONS_SMC2)
1502         consdev = "smc2";
1503 #elif defined(CONFIG_8xx_CONS_SCC2)
1504         consdev = "scc2";
1505 #elif defined(CONFIG_8xx_CONS_SCC3)
1506         consdev = "scc3";
1507 #endif
1508
1509         if (argc > 0) {
1510                 ulong len;
1511                 int   i;
1512
1513                 for (i = 0, len = 0; i < argc; i += 1)
1514                         len += strlen(argv[i]) + 1;
1515                 cmdline = malloc(len);
1516                 copy_args(cmdline, argc, argv, ' ');
1517         } else if ((cmdline = getenv("bootargs")) == NULL) {
1518                 cmdline = "";
1519         }
1520
1521         loader = (void (*)(bd_t *, image_header_t *, char *, char *))images->ep;
1522
1523         printf("## Transferring control to NetBSD stage-2 loader "
1524                 "(at address %08lx) ...\n",
1525                 (ulong)loader);
1526
1527         bootstage_mark(BOOTSTAGE_ID_RUN_OS);
1528
1529         /*
1530          * NetBSD Stage-2 Loader Parameters:
1531          *   r3: ptr to board info data
1532          *   r4: image address
1533          *   r5: console device
1534          *   r6: boot args string
1535          */
1536         (*loader)(gd->bd, os_hdr, consdev, cmdline);
1537
1538         return 1;
1539 }
1540 #endif /* CONFIG_BOOTM_NETBSD*/
1541
1542 #ifdef CONFIG_LYNXKDI
1543 static int do_bootm_lynxkdi(int flag, int argc, char * const argv[],
1544                              bootm_headers_t *images)
1545 {
1546         image_header_t *hdr = &images->legacy_hdr_os_copy;
1547
1548         if (flag & BOOTM_STATE_OS_PREP)
1549                 return 0;
1550         if ((flag != 0) && (flag != BOOTM_STATE_OS_GO))
1551                 return 1;
1552
1553 #if defined(CONFIG_FIT)
1554         if (!images->legacy_hdr_valid) {
1555                 fit_unsupported_reset("Lynx");
1556                 return 1;
1557         }
1558 #endif
1559
1560         lynxkdi_boot((image_header_t *)hdr);
1561
1562         return 1;
1563 }
1564 #endif /* CONFIG_LYNXKDI */
1565
1566 #ifdef CONFIG_BOOTM_RTEMS
1567 static int do_bootm_rtems(int flag, int argc, char * const argv[],
1568                            bootm_headers_t *images)
1569 {
1570         void (*entry_point)(bd_t *);
1571
1572         if (flag & BOOTM_STATE_OS_PREP)
1573                 return 0;
1574         if ((flag != 0) && (flag != BOOTM_STATE_OS_GO))
1575                 return 1;
1576
1577 #if defined(CONFIG_FIT)
1578         if (!images->legacy_hdr_valid) {
1579                 fit_unsupported_reset("RTEMS");
1580                 return 1;
1581         }
1582 #endif
1583
1584         entry_point = (void (*)(bd_t *))images->ep;
1585
1586         printf("## Transferring control to RTEMS (at address %08lx) ...\n",
1587                 (ulong)entry_point);
1588
1589         bootstage_mark(BOOTSTAGE_ID_RUN_OS);
1590
1591         /*
1592          * RTEMS Parameters:
1593          *   r3: ptr to board info data
1594          */
1595         (*entry_point)(gd->bd);
1596
1597         return 1;
1598 }
1599 #endif /* CONFIG_BOOTM_RTEMS */
1600
1601 #if defined(CONFIG_BOOTM_OSE)
1602 static int do_bootm_ose(int flag, int argc, char * const argv[],
1603                            bootm_headers_t *images)
1604 {
1605         void (*entry_point)(void);
1606
1607         if (flag & BOOTM_STATE_OS_PREP)
1608                 return 0;
1609         if ((flag != 0) && (flag != BOOTM_STATE_OS_GO))
1610                 return 1;
1611
1612 #if defined(CONFIG_FIT)
1613         if (!images->legacy_hdr_valid) {
1614                 fit_unsupported_reset("OSE");
1615                 return 1;
1616         }
1617 #endif
1618
1619         entry_point = (void (*)(void))images->ep;
1620
1621         printf("## Transferring control to OSE (at address %08lx) ...\n",
1622                 (ulong)entry_point);
1623
1624         bootstage_mark(BOOTSTAGE_ID_RUN_OS);
1625
1626         /*
1627          * OSE Parameters:
1628          *   None
1629          */
1630         (*entry_point)();
1631
1632         return 1;
1633 }
1634 #endif /* CONFIG_BOOTM_OSE */
1635
1636 #if defined(CONFIG_BOOTM_PLAN9)
1637 static int do_bootm_plan9(int flag, int argc, char * const argv[],
1638                            bootm_headers_t *images)
1639 {
1640         void (*entry_point)(void);
1641         char *s;
1642
1643         if (flag & BOOTM_STATE_OS_PREP)
1644                 return 0;
1645         if ((flag != 0) && (flag != BOOTM_STATE_OS_GO))
1646                 return 1;
1647
1648 #if defined(CONFIG_FIT)
1649         if (!images->legacy_hdr_valid) {
1650                 fit_unsupported_reset("Plan 9");
1651                 return 1;
1652         }
1653 #endif
1654
1655         /* See README.plan9 */
1656         s = getenv("confaddr");
1657         if (s != NULL) {
1658                 char *confaddr = (char *)simple_strtoul(s, NULL, 16);
1659
1660                 if (argc > 0) {
1661                         copy_args(confaddr, argc, argv, '\n');
1662                 } else {
1663                         s = getenv("bootargs");
1664                         if (s != NULL)
1665                                 strcpy(confaddr, s);
1666                 }
1667         }
1668
1669         entry_point = (void (*)(void))images->ep;
1670
1671         printf("## Transferring control to Plan 9 (at address %08lx) ...\n",
1672                 (ulong)entry_point);
1673
1674         bootstage_mark(BOOTSTAGE_ID_RUN_OS);
1675
1676         /*
1677          * Plan 9 Parameters:
1678          *   None
1679          */
1680         (*entry_point)();
1681
1682         return 1;
1683 }
1684 #endif /* CONFIG_BOOTM_PLAN9 */
1685
1686 #if defined(CONFIG_CMD_ELF)
1687 static int do_bootm_vxworks(int flag, int argc, char * const argv[],
1688                              bootm_headers_t *images)
1689 {
1690         char str[80];
1691
1692         if (flag & BOOTM_STATE_OS_PREP)
1693                 return 0;
1694         if ((flag != 0) && (flag != BOOTM_STATE_OS_GO))
1695                 return 1;
1696
1697 #if defined(CONFIG_FIT)
1698         if (!images->legacy_hdr_valid) {
1699                 fit_unsupported_reset("VxWorks");
1700                 return 1;
1701         }
1702 #endif
1703
1704         sprintf(str, "%lx", images->ep); /* write entry-point into string */
1705         setenv("loadaddr", str);
1706         do_bootvx(NULL, 0, 0, NULL);
1707
1708         return 1;
1709 }
1710
1711 static int do_bootm_qnxelf(int flag, int argc, char * const argv[],
1712                             bootm_headers_t *images)
1713 {
1714         char *local_args[2];
1715         char str[16];
1716
1717         if (flag & BOOTM_STATE_OS_PREP)
1718                 return 0;
1719         if ((flag != 0) && (flag != BOOTM_STATE_OS_GO))
1720                 return 1;
1721
1722 #if defined(CONFIG_FIT)
1723         if (!images->legacy_hdr_valid) {
1724                 fit_unsupported_reset("QNX");
1725                 return 1;
1726         }
1727 #endif
1728
1729         sprintf(str, "%lx", images->ep); /* write entry-point into string */
1730         local_args[0] = argv[0];
1731         local_args[1] = str;    /* and provide it via the arguments */
1732         do_bootelf(NULL, 0, 2, local_args);
1733
1734         return 1;
1735 }
1736 #endif
1737
1738 #ifdef CONFIG_INTEGRITY
1739 static int do_bootm_integrity(int flag, int argc, char * const argv[],
1740                            bootm_headers_t *images)
1741 {
1742         void (*entry_point)(void);
1743
1744         if (flag & BOOTM_STATE_OS_PREP)
1745                 return 0;
1746         if ((flag != 0) && (flag != BOOTM_STATE_OS_GO))
1747                 return 1;
1748
1749 #if defined(CONFIG_FIT)
1750         if (!images->legacy_hdr_valid) {
1751                 fit_unsupported_reset("INTEGRITY");
1752                 return 1;
1753         }
1754 #endif
1755
1756         entry_point = (void (*)(void))images->ep;
1757
1758         printf("## Transferring control to INTEGRITY (at address %08lx) ...\n",
1759                 (ulong)entry_point);
1760
1761         bootstage_mark(BOOTSTAGE_ID_RUN_OS);
1762
1763         /*
1764          * INTEGRITY Parameters:
1765          *   None
1766          */
1767         (*entry_point)();
1768
1769         return 1;
1770 }
1771 #endif
1772
1773 #ifdef CONFIG_CMD_BOOTZ
1774
1775 int __weak bootz_setup(ulong image, ulong *start, ulong *end)
1776 {
1777         /* Please define bootz_setup() for your platform */
1778
1779         puts("Your platform's zImage format isn't supported yet!\n");
1780         return -1;
1781 }
1782
1783 /*
1784  * zImage booting support
1785  */
1786 static int bootz_start(cmd_tbl_t *cmdtp, int flag, int argc,
1787                         char * const argv[], bootm_headers_t *images)
1788 {
1789         int ret;
1790         ulong zi_start, zi_end;
1791
1792         ret = do_bootm_states(cmdtp, flag, argc, argv, BOOTM_STATE_START,
1793                               images, 1);
1794
1795         /* Setup Linux kernel zImage entry point */
1796         if (!argc) {
1797                 images->ep = load_addr;
1798                 debug("*  kernel: default image load address = 0x%08lx\n",
1799                                 load_addr);
1800         } else {
1801                 images->ep = simple_strtoul(argv[0], NULL, 16);
1802                 debug("*  kernel: cmdline image address = 0x%08lx\n",
1803                         images->ep);
1804         }
1805
1806         ret = bootz_setup(images->ep, &zi_start, &zi_end);
1807         if (ret != 0)
1808                 return 1;
1809
1810         lmb_reserve(&images->lmb, images->ep, zi_end - zi_start);
1811
1812         /*
1813          * Handle the BOOTM_STATE_FINDOTHER state ourselves as we do not
1814          * have a header that provide this informaiton.
1815          */
1816         if (bootm_find_ramdisk(flag, argc, argv))
1817                 return 1;
1818
1819 #if defined(CONFIG_OF_LIBFDT)
1820         if (bootm_find_fdt(flag, argc, argv))
1821                 return 1;
1822 #endif
1823
1824         return 0;
1825 }
1826
1827 int do_bootz(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
1828 {
1829         int ret;
1830
1831         /* Consume 'bootz' */
1832         argc--; argv++;
1833
1834         if (bootz_start(cmdtp, flag, argc, argv, &images))
1835                 return 1;
1836
1837         /*
1838          * We are doing the BOOTM_STATE_LOADOS state ourselves, so must
1839          * disable interrupts ourselves
1840          */
1841         bootm_disable_interrupts();
1842
1843         images.os.os = IH_OS_LINUX;
1844         ret = do_bootm_states(cmdtp, flag, argc, argv,
1845                               BOOTM_STATE_OS_PREP | BOOTM_STATE_OS_FAKE_GO |
1846                               BOOTM_STATE_OS_GO,
1847                               &images, 1);
1848
1849         return ret;
1850 }
1851
1852 #ifdef CONFIG_SYS_LONGHELP
1853 static char bootz_help_text[] =
1854         "[addr [initrd[:size]] [fdt]]\n"
1855         "    - boot Linux zImage stored in memory\n"
1856         "\tThe argument 'initrd' is optional and specifies the address\n"
1857         "\tof the initrd in memory. The optional argument ':size' allows\n"
1858         "\tspecifying the size of RAW initrd.\n"
1859 #if defined(CONFIG_OF_LIBFDT)
1860         "\tWhen booting a Linux kernel which requires a flat device-tree\n"
1861         "\ta third argument is required which is the address of the\n"
1862         "\tdevice-tree blob. To boot that kernel without an initrd image,\n"
1863         "\tuse a '-' for the second argument. If you do not pass a third\n"
1864         "\ta bd_info struct will be passed instead\n"
1865 #endif
1866         "";
1867 #endif
1868
1869 U_BOOT_CMD(
1870         bootz,  CONFIG_SYS_MAXARGS,     1,      do_bootz,
1871         "boot Linux zImage image from memory", bootz_help_text
1872 );
1873 #endif  /* CONFIG_CMD_BOOTZ */