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         eth_unregister(eth_get_dev());
 562 #endif
 563
 564 #if defined(CONFIG_CMD_USB)
 565         /*
 566          * turn off USB to prevent the host controller from writing to the
 567          * SDRAM while Linux is booting. This could happen (at least for OHCI
 568          * controller), because the HCCA (Host Controller Communication Area)
 569          * lies within the SDRAM and the host controller writes continously to
 570          * this area (as busmaster!). The HccaFrameNumber is for example
 571          * updated every 1 ms within the HCCA structure in SDRAM! For more
 572          * details see the OpenHCI specification.
 573          */
 574         usb_stop();
 575 #endif
 576         return iflag;
 577 }
 578
 579 /**
 580  * Execute selected states of the bootm command.
 581  *
 582  * Note the arguments to this state must be the first argument, Any 'bootm'
 583  * or sub-command arguments must have already been taken.
 584  *
 585  * Note that if states contains more than one flag it MUST contain
 586  * BOOTM_STATE_START, since this handles and consumes the command line args.
 587  *
 588  * Also note that aside from boot_os_fn functions and bootm_load_os no other
 589  * functions we store the return value of in 'ret' may use a negative return
 590  * value, without special handling.
 591  *
 592  * @param cmdtp         Pointer to bootm command table entry
 593  * @param flag          Command flags (CMD_FLAG_...)
 594  * @param argc          Number of subcommand arguments (0 = no arguments)
 595  * @param argv          Arguments
 596  * @param states        Mask containing states to run (BOOTM_STATE_...)
 597  * @param images        Image header information
 598  * @param boot_progress 1 to show boot progress, 0 to not do this
 599  * @return 0 if ok, something else on error. Some errors will cause this
 600  *      function to perform a reboot! If states contains BOOTM_STATE_OS_GO
 601  *      then the intent is to boot an OS, so this function will not return
 602  *      unless the image type is standalone.
 603  */
 604 static int do_bootm_states(cmd_tbl_t *cmdtp, int flag, int argc,
 605                 char * const argv[], int states, bootm_headers_t *images,
 606                 int boot_progress)
 607 {
 608         boot_os_fn *boot_fn;
 609         ulong iflag = 0;
 610         int ret = 0, need_boot_fn;
 611
 612         images->state |= states;
 613
 614         /*
 615          * Work through the states and see how far we get. We stop on
 616          * any error.
 617          */
 618         if (states & BOOTM_STATE_START)
 619                 ret = bootm_start(cmdtp, flag, argc, argv);
 620
 621         if (!ret && (states & BOOTM_STATE_FINDOS))
 622                 ret = bootm_find_os(cmdtp, flag, argc, argv);
 623
 624         if (!ret && (states & BOOTM_STATE_FINDOTHER)) {
 625                 ret = bootm_find_other(cmdtp, flag, argc, argv);
 626                 argc = 0;       /* consume the args */
 627         }
 628
 629         /* Load the OS */
 630         if (!ret && (states & BOOTM_STATE_LOADOS)) {
 631                 ulong load_end;
 632
 633                 iflag = bootm_disable_interrupts();
 634                 ret = bootm_load_os(images, &load_end, 0);
 635                 if (ret == 0)
 636                         lmb_reserve(&images->lmb, images->os.load,
 637                                     (load_end - images->os.load));
 638                 else if (ret && ret != BOOTM_ERR_OVERLAP)
 639                         goto err;
 640                 else if (ret == BOOTM_ERR_OVERLAP)
 641                         ret = 0;
 642 #if defined(CONFIG_SILENT_CONSOLE) && !defined(CONFIG_SILENT_U_BOOT_ONLY)
 643                 if (images->os.os == IH_OS_LINUX)
 644                         fixup_silent_linux();
 645 #endif
 646         }
 647
 648         /* Relocate the ramdisk */
 649 #ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH
 650         if (!ret && (states & BOOTM_STATE_RAMDISK)) {
 651                 ulong rd_len = images->rd_end - images->rd_start;
 652
 653                 ret = boot_ramdisk_high(&images->lmb, images->rd_start,
 654                         rd_len, &images->initrd_start, &images->initrd_end);
 655                 if (!ret) {
 656                         setenv_hex("initrd_start", images->initrd_start);
 657                         setenv_hex("initrd_end", images->initrd_end);
 658                 }
 659         }
 660 #endif
 661 #if defined(CONFIG_OF_LIBFDT) && defined(CONFIG_LMB)
 662         if (!ret && (states & BOOTM_STATE_FDT)) {
 663                 boot_fdt_add_mem_rsv_regions(&images->lmb, images->ft_addr);
 664                 ret = boot_relocate_fdt(&images->lmb, &images->ft_addr,
 665                                         &images->ft_len);
 666         }
 667 #endif
 668
 669         /* From now on, we need the OS boot function */
 670         if (ret)
 671                 return ret;
 672         boot_fn = boot_os[images->os.os];
 673         need_boot_fn = states & (BOOTM_STATE_OS_CMDLINE |
 674                         BOOTM_STATE_OS_BD_T | BOOTM_STATE_OS_PREP |
 675                         BOOTM_STATE_OS_FAKE_GO | BOOTM_STATE_OS_GO);
 676         if (boot_fn == NULL && need_boot_fn) {
 677                 if (iflag)
 678                         enable_interrupts();
 679                 printf("ERROR: booting os '%s' (%d) is not supported\n",
 680                        genimg_get_os_name(images->os.os), images->os.os);
 681                 bootstage_error(BOOTSTAGE_ID_CHECK_BOOT_OS);
 682                 return 1;
 683         }
 684
 685         /* Call various other states that are not generally used */
 686         if (!ret && (states & BOOTM_STATE_OS_CMDLINE))
 687                 ret = boot_fn(BOOTM_STATE_OS_CMDLINE, argc, argv, images);
 688         if (!ret && (states & BOOTM_STATE_OS_BD_T))
 689                 ret = boot_fn(BOOTM_STATE_OS_BD_T, argc, argv, images);
 690         if (!ret && (states & BOOTM_STATE_OS_PREP))
 691                 ret = boot_fn(BOOTM_STATE_OS_PREP, argc, argv, images);
 692
 693 #ifdef CONFIG_TRACE
 694         /* Pretend to run the OS, then run a user command */
 695         if (!ret && (states & BOOTM_STATE_OS_FAKE_GO)) {
 696                 char *cmd_list = getenv("fakegocmd");
 697
 698                 ret = boot_selected_os(argc, argv, BOOTM_STATE_OS_FAKE_GO,
 699                                 images, boot_fn);
 700                 if (!ret && cmd_list)
 701                         ret = run_command_list(cmd_list, -1, flag);
 702         }
 703 #endif
 704
 705         /* Check for unsupported subcommand. */
 706         if (ret) {
 707                 puts("subcommand not supported\n");
 708                 return ret;
 709         }
 710
 711         /* Now run the OS! We hope this doesn't return */
 712         if (!ret && (states & BOOTM_STATE_OS_GO))
 713                 ret = boot_selected_os(argc, argv, BOOTM_STATE_OS_GO,
 714                                 images, boot_fn);
 715
 716         /* Deal with any fallout */
 717 err:
 718         if (iflag)
 719                 enable_interrupts();
 720
 721         if (ret == BOOTM_ERR_UNIMPLEMENTED)
 722                 bootstage_error(BOOTSTAGE_ID_DECOMP_UNIMPL);
 723         else if (ret == BOOTM_ERR_RESET)
 724                 do_reset(cmdtp, flag, argc, argv);
 725
 726         return ret;
 727 }
 728
 729 static int do_bootm_subcommand(cmd_tbl_t *cmdtp, int flag, int argc,
 730                         char * const argv[])
 731 {
 732         int ret = 0;
 733         long state;
 734         cmd_tbl_t *c;
 735
 736         c = find_cmd_tbl(argv[0], &cmd_bootm_sub[0], ARRAY_SIZE(cmd_bootm_sub));
 737         argc--; argv++;
 738
 739         if (c) {
 740                 state = (long)c->cmd;
 741                 if (state == BOOTM_STATE_START)
 742                         state |= BOOTM_STATE_FINDOS | BOOTM_STATE_FINDOTHER;
 743         } else {
 744                 /* Unrecognized command */
 745                 return CMD_RET_USAGE;
 746         }
 747
 748         if (state != BOOTM_STATE_START && images.state >= state) {
 749                 printf("Trying to execute a command out of order\n");
 750                 return CMD_RET_USAGE;
 751         }
 752
 753         ret = do_bootm_states(cmdtp, flag, argc, argv, state, &images, 0);
 754
 755         return ret;
 756 }
 757
 758 /*******************************************************************/
 759 /* bootm - boot application image from image in memory */
 760 /*******************************************************************/
 761
 762 int do_bootm(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
 763 {
 764 #ifdef CONFIG_NEEDS_MANUAL_RELOC
 765         static int relocated = 0;
 766
 767         if (!relocated) {
 768                 int i;
 769
 770                 /* relocate boot function table */
 771                 for (i = 0; i < ARRAY_SIZE(boot_os); i++)
 772                         if (boot_os[i] != NULL)
 773                                 boot_os[i] += gd->reloc_off;
 774
 775                 /* relocate names of sub-command table */
 776                 for (i = 0; i < ARRAY_SIZE(cmd_bootm_sub); i++)
 777                         cmd_bootm_sub[i].name += gd->reloc_off;
 778
 779                 relocated = 1;
 780         }
 781 #endif
 782
 783         /* determine if we have a sub command */
 784         argc--; argv++;
 785         if (argc > 0) {
 786                 char *endp;
 787
 788                 simple_strtoul(argv[0], &endp, 16);
 789                 /* endp pointing to NULL means that argv[0] was just a
 790                  * valid number, pass it along to the normal bootm processing
 791                  *
 792                  * If endp is ':' or '#' assume a FIT identifier so pass
 793                  * along for normal processing.
 794                  *
 795                  * Right now we assume the first arg should never be '-'
 796                  */
 797                 if ((*endp != 0) && (*endp != ':') && (*endp != '#'))
 798                         return do_bootm_subcommand(cmdtp, flag, argc, argv);
 799         }
 800
 801         return do_bootm_states(cmdtp, flag, argc, argv, BOOTM_STATE_START |
 802                 BOOTM_STATE_FINDOS | BOOTM_STATE_FINDOTHER |
 803                 BOOTM_STATE_LOADOS | BOOTM_STATE_OS_CMDLINE |
 804                 BOOTM_STATE_OS_PREP | BOOTM_STATE_OS_FAKE_GO |
 805                 BOOTM_STATE_OS_GO, &images, 1);
 806 }
 807
 808 int bootm_maybe_autostart(cmd_tbl_t *cmdtp, const char *cmd)
 809 {
 810         const char *ep = getenv("autostart");
 811
 812         if (ep && !strcmp(ep, "yes")) {
 813                 char *local_args[2];
 814                 local_args[0] = (char *)cmd;
 815                 local_args[1] = NULL;
 816                 printf("Automatic boot of image at addr 0x%08lX ...\n", load_addr);
 817                 return do_bootm(cmdtp, 0, 1, local_args);
 818         }
 819
 820         return 0;
 821 }
 822
 823 /**
 824  * image_get_kernel - verify legacy format kernel image
 825  * @img_addr: in RAM address of the legacy format image to be verified
 826  * @verify: data CRC verification flag
 827  *
 828  * image_get_kernel() verifies legacy image integrity and returns pointer to
 829  * legacy image header if image verification was completed successfully.
 830  *
 831  * returns:
 832  *     pointer to a legacy image header if valid image was found
 833  *     otherwise return NULL
 834  */
 835 static image_header_t *image_get_kernel(ulong img_addr, int verify)
 836 {
 837         image_header_t *hdr = (image_header_t *)img_addr;
 838
 839         if (!image_check_magic(hdr)) {
 840                 puts("Bad Magic Number\n");
 841                 bootstage_error(BOOTSTAGE_ID_CHECK_MAGIC);
 842                 return NULL;
 843         }
 844         bootstage_mark(BOOTSTAGE_ID_CHECK_HEADER);
 845
 846         if (!image_check_hcrc(hdr)) {
 847                 puts("Bad Header Checksum\n");
 848                 bootstage_error(BOOTSTAGE_ID_CHECK_HEADER);
 849                 return NULL;
 850         }
 851
 852         bootstage_mark(BOOTSTAGE_ID_CHECK_CHECKSUM);
 853         image_print_contents(hdr);
 854
 855         if (verify) {
 856                 puts("   Verifying Checksum ... ");
 857                 if (!image_check_dcrc(hdr)) {
 858                         printf("Bad Data CRC\n");
 859                         bootstage_error(BOOTSTAGE_ID_CHECK_CHECKSUM);
 860                         return NULL;
 861                 }
 862                 puts("OK\n");
 863         }
 864         bootstage_mark(BOOTSTAGE_ID_CHECK_ARCH);
 865
 866         if (!image_check_target_arch(hdr)) {
 867                 printf("Unsupported Architecture 0x%x\n", image_get_arch(hdr));
 868                 bootstage_error(BOOTSTAGE_ID_CHECK_ARCH);
 869                 return NULL;
 870         }
 871         return hdr;
 872 }
 873
 874 /**
 875  * boot_get_kernel - find kernel image
 876  * @os_data: pointer to a ulong variable, will hold os data start address
 877  * @os_len: pointer to a ulong variable, will hold os data length
 878  *
 879  * boot_get_kernel() tries to find a kernel image, verifies its integrity
 880  * and locates kernel data.
 881  *
 882  * returns:
 883  *     pointer to image header if valid image was found, plus kernel start
 884  *     address and length, otherwise NULL
 885  */
 886 static const void *boot_get_kernel(cmd_tbl_t *cmdtp, int flag, int argc,
 887                 char * const argv[], bootm_headers_t *images, ulong *os_data,
 888                 ulong *os_len)
 889 {
 890         image_header_t  *hdr;
 891         ulong           img_addr;
 892         const void *buf;
 893 #if defined(CONFIG_FIT)
 894         const char      *fit_uname_config = NULL;
 895         const char      *fit_uname_kernel = NULL;
 896         int             os_noffset;
 897 #endif
 898
 899         /* find out kernel image address */
 900         if (argc < 1) {
 901                 img_addr = load_addr;
 902                 debug("*  kernel: default image load address = 0x%08lx\n",
 903                                 load_addr);
 904 #if defined(CONFIG_FIT)
 905         } else if (fit_parse_conf(argv[0], load_addr, &img_addr,
 906                                                         &fit_uname_config)) {
 907                 debug("*  kernel: config '%s' from image at 0x%08lx\n",
 908                                 fit_uname_config, img_addr);
 909         } else if (fit_parse_subimage(argv[0], load_addr, &img_addr,
 910                                                         &fit_uname_kernel)) {
 911                 debug("*  kernel: subimage '%s' from image at 0x%08lx\n",
 912                                 fit_uname_kernel, img_addr);
 913 #endif
 914         } else {
 915                 img_addr = simple_strtoul(argv[0], NULL, 16);
 916                 debug("*  kernel: cmdline image address = 0x%08lx\n", img_addr);
 917         }
 918
 919         bootstage_mark(BOOTSTAGE_ID_CHECK_MAGIC);
 920
 921         /* copy from dataflash if needed */
 922         img_addr = genimg_get_image(img_addr);
 923
 924         /* check image type, for FIT images get FIT kernel node */
 925         *os_data = *os_len = 0;
 926         buf = map_sysmem(img_addr, 0);
 927         switch (genimg_get_format(buf)) {
 928         case IMAGE_FORMAT_LEGACY:
 929                 printf("## Booting kernel from Legacy Image at %08lx ...\n",
 930                                 img_addr);
 931                 hdr = image_get_kernel(img_addr, images->verify);
 932                 if (!hdr)
 933                         return NULL;
 934                 bootstage_mark(BOOTSTAGE_ID_CHECK_IMAGETYPE);
 935
 936                 /* get os_data and os_len */
 937                 switch (image_get_type(hdr)) {
 938                 case IH_TYPE_KERNEL:
 939                 case IH_TYPE_KERNEL_NOLOAD:
 940                         *os_data = image_get_data(hdr);
 941                         *os_len = image_get_data_size(hdr);
 942                         break;
 943                 case IH_TYPE_MULTI:
 944                         image_multi_getimg(hdr, 0, os_data, os_len);
 945                         break;
 946                 case IH_TYPE_STANDALONE:
 947                         *os_data = image_get_data(hdr);
 948                         *os_len = image_get_data_size(hdr);
 949                         break;
 950                 default:
 951                         printf("Wrong Image Type for %s command\n",
 952                                 cmdtp->name);
 953                         bootstage_error(BOOTSTAGE_ID_CHECK_IMAGETYPE);
 954                         return NULL;
 955                 }
 956
 957                 /*
 958                  * copy image header to allow for image overwrites during
 959                  * kernel decompression.
 960                  */
 961                 memmove(&images->legacy_hdr_os_copy, hdr,
 962                         sizeof(image_header_t));
 963
 964                 /* save pointer to image header */
 965                 images->legacy_hdr_os = hdr;
 966
 967                 images->legacy_hdr_valid = 1;
 968                 bootstage_mark(BOOTSTAGE_ID_DECOMP_IMAGE);
 969                 break;
 970 #if defined(CONFIG_FIT)
 971         case IMAGE_FORMAT_FIT:
 972                 os_noffset = fit_image_load(images, FIT_KERNEL_PROP,
 973                                 img_addr,
 974                                 &fit_uname_kernel, &fit_uname_config,
 975                                 IH_ARCH_DEFAULT, IH_TYPE_KERNEL,
 976                                 BOOTSTAGE_ID_FIT_KERNEL_START,
 977                                 FIT_LOAD_IGNORED, os_data, os_len);
 978                 if (os_noffset < 0)
 979                         return NULL;
 980
 981                 images->fit_hdr_os = map_sysmem(img_addr, 0);
 982                 images->fit_uname_os = fit_uname_kernel;
 983                 images->fit_uname_cfg = fit_uname_config;
 984                 images->fit_noffset_os = os_noffset;
 985                 break;
 986 #endif
 987         default:
 988                 printf("Wrong Image Format for %s command\n", cmdtp->name);
 989                 bootstage_error(BOOTSTAGE_ID_FIT_KERNEL_INFO);
 990                 return NULL;
 991         }
 992
 993         debug("   kernel data at 0x%08lx, len = 0x%08lx (%ld)\n",
 994                         *os_data, *os_len, *os_len);
 995
 996         return buf;
 997 }
 998
 999 #ifdef CONFIG_SYS_LONGHELP
1000 static char bootm_help_text[] =
1001         "[addr [arg ...]]\n    - boot application image stored in memory\n"
1002         "\tpassing arguments 'arg ...'; when booting a Linux kernel,\n"
1003         "\t'arg' can be the address of an initrd image\n"
1004 #if defined(CONFIG_OF_LIBFDT)
1005         "\tWhen booting a Linux kernel which requires a flat device-tree\n"
1006         "\ta third argument is required which is the address of the\n"
1007         "\tdevice-tree blob. To boot that kernel without an initrd image,\n"
1008         "\tuse a '-' for the second argument. If you do not pass a third\n"
1009         "\ta bd_info struct will be passed instead\n"
1010 #endif
1011 #if defined(CONFIG_FIT)
1012         "\t\nFor the new multi component uImage format (FIT) addresses\n"
1013         "\tmust be extened to include component or configuration unit name:\n"
1014         "\taddr:<subimg_uname> - direct component image specification\n"
1015         "\taddr#<conf_uname>   - configuration specification\n"
1016         "\tUse iminfo command to get the list of existing component\n"
1017         "\timages and configurations.\n"
1018 #endif
1019         "\nSub-commands to do part of the bootm sequence.  The sub-commands "
1020         "must be\n"
1021         "issued in the order below (it's ok to not issue all sub-commands):\n"
1022         "\tstart [addr [arg ...]]\n"
1023         "\tloados  - load OS image\n"
1024 #if defined(CONFIG_SYS_BOOT_RAMDISK_HIGH)
1025         "\tramdisk - relocate initrd, set env initrd_start/initrd_end\n"
1026 #endif
1027 #if defined(CONFIG_OF_LIBFDT)
1028         "\tfdt     - relocate flat device tree\n"
1029 #endif
1030         "\tcmdline - OS specific command line processing/setup\n"
1031         "\tbdt     - OS specific bd_t processing\n"
1032         "\tprep    - OS specific prep before relocation or go\n"
1033         "\tgo      - start OS";
1034 #endif
1035
1036 U_BOOT_CMD(
1037         bootm,  CONFIG_SYS_MAXARGS,     1,      do_bootm,
1038         "boot application image from memory", bootm_help_text
1039 );
1040
1041 /*******************************************************************/
1042 /* bootd - boot default image */
1043 /*******************************************************************/
1044 #if defined(CONFIG_CMD_BOOTD)
1045 int do_bootd(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
1046 {
1047         int rcode = 0;
1048
1049         if (run_command(getenv("bootcmd"), flag) < 0)
1050                 rcode = 1;
1051         return rcode;
1052 }
1053
1054 U_BOOT_CMD(
1055         boot,   1,      1,      do_bootd,
1056         "boot default, i.e., run 'bootcmd'",
1057         ""
1058 );
1059
1060 /* keep old command name "bootd" for backward compatibility */
1061 U_BOOT_CMD(
1062         bootd, 1,       1,      do_bootd,
1063         "boot default, i.e., run 'bootcmd'",
1064         ""
1065 );
1066
1067 #endif
1068
1069
1070 /*******************************************************************/
1071 /* iminfo - print header info for a requested image */
1072 /*******************************************************************/
1073 #if defined(CONFIG_CMD_IMI)
1074 static int do_iminfo(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
1075 {
1076         int     arg;
1077         ulong   addr;
1078         int     rcode = 0;
1079
1080         if (argc < 2) {
1081                 return image_info(load_addr);
1082         }
1083
1084         for (arg = 1; arg < argc; ++arg) {
1085                 addr = simple_strtoul(argv[arg], NULL, 16);
1086                 if (image_info(addr) != 0)
1087                         rcode = 1;
1088         }
1089         return rcode;
1090 }
1091
1092 static int image_info(ulong addr)
1093 {
1094         void *hdr = (void *)addr;
1095
1096         printf("\n## Checking Image at %08lx ...\n", addr);
1097
1098         switch (genimg_get_format(hdr)) {
1099         case IMAGE_FORMAT_LEGACY:
1100                 puts("   Legacy image found\n");
1101                 if (!image_check_magic(hdr)) {
1102                         puts("   Bad Magic Number\n");
1103                         return 1;
1104                 }
1105
1106                 if (!image_check_hcrc(hdr)) {
1107                         puts("   Bad Header Checksum\n");
1108                         return 1;
1109                 }
1110
1111                 image_print_contents(hdr);
1112
1113                 puts("   Verifying Checksum ... ");
1114                 if (!image_check_dcrc(hdr)) {
1115                         puts("   Bad Data CRC\n");
1116                         return 1;
1117                 }
1118                 puts("OK\n");
1119                 return 0;
1120 #if defined(CONFIG_FIT)
1121         case IMAGE_FORMAT_FIT:
1122                 puts("   FIT image found\n");
1123
1124                 if (!fit_check_format(hdr)) {
1125                         puts("Bad FIT image format!\n");
1126                         return 1;
1127                 }
1128
1129                 fit_print_contents(hdr);
1130
1131                 if (!fit_all_image_verify(hdr)) {
1132                         puts("Bad hash in FIT image!\n");
1133                         return 1;
1134                 }
1135
1136                 return 0;
1137 #endif
1138         default:
1139                 puts("Unknown image format!\n");
1140                 break;
1141         }
1142
1143         return 1;
1144 }
1145
1146 U_BOOT_CMD(
1147         iminfo, CONFIG_SYS_MAXARGS,     1,      do_iminfo,
1148         "print header information for application image",
1149         "addr [addr ...]\n"
1150         "    - print header information for application image starting at\n"
1151         "      address 'addr' in memory; this includes verification of the\n"
1152         "      image contents (magic number, header and payload checksums)"
1153 );
1154 #endif
1155
1156
1157 /*******************************************************************/
1158 /* imls - list all images found in flash */
1159 /*******************************************************************/
1160 #if defined(CONFIG_CMD_IMLS)
1161 static int do_imls_nor(void)
1162 {
1163         flash_info_t *info;
1164         int i, j;
1165         void *hdr;
1166
1167         for (i = 0, info = &flash_info[0];
1168                 i < CONFIG_SYS_MAX_FLASH_BANKS; ++i, ++info) {
1169
1170                 if (info->flash_id == FLASH_UNKNOWN)
1171                         goto next_bank;
1172                 for (j = 0; j < info->sector_count; ++j) {
1173
1174                         hdr = (void *)info->start[j];
1175                         if (!hdr)
1176                                 goto next_sector;
1177
1178                         switch (genimg_get_format(hdr)) {
1179                         case IMAGE_FORMAT_LEGACY:
1180                                 if (!image_check_hcrc(hdr))
1181                                         goto next_sector;
1182
1183                                 printf("Legacy Image at %08lX:\n", (ulong)hdr);
1184                                 image_print_contents(hdr);
1185
1186                                 puts("   Verifying Checksum ... ");
1187                                 if (!image_check_dcrc(hdr)) {
1188                                         puts("Bad Data CRC\n");
1189                                 } else {
1190                                         puts("OK\n");
1191                                 }
1192                                 break;
1193 #if defined(CONFIG_FIT)
1194                         case IMAGE_FORMAT_FIT:
1195                                 if (!fit_check_format(hdr))
1196                                         goto next_sector;
1197
1198                                 printf("FIT Image at %08lX:\n", (ulong)hdr);
1199                                 fit_print_contents(hdr);
1200                                 break;
1201 #endif
1202                         default:
1203                                 goto next_sector;
1204                         }
1205
1206 next_sector:            ;
1207                 }
1208 next_bank:      ;
1209         }
1210         return 0;
1211 }
1212 #endif
1213
1214 #if defined(CONFIG_CMD_IMLS_NAND)
1215 static int nand_imls_legacyimage(nand_info_t *nand, int nand_dev, loff_t off,
1216                 size_t len)
1217 {
1218         void *imgdata;
1219         int ret;
1220
1221         imgdata = malloc(len);
1222         if (!imgdata) {
1223                 printf("May be a Legacy Image at NAND device %d offset %08llX:\n",
1224                                 nand_dev, off);
1225                 printf("   Low memory(cannot allocate memory for image)\n");
1226                 return -ENOMEM;
1227         }
1228
1229         ret = nand_read_skip_bad(nand, off, &len,
1230                         imgdata);
1231         if (ret < 0 && ret != -EUCLEAN) {
1232                 free(imgdata);
1233                 return ret;
1234         }
1235
1236         if (!image_check_hcrc(imgdata)) {
1237                 free(imgdata);
1238                 return 0;
1239         }
1240
1241         printf("Legacy Image at NAND device %d offset %08llX:\n",
1242                         nand_dev, off);
1243         image_print_contents(imgdata);
1244
1245         puts("   Verifying Checksum ... ");
1246         if (!image_check_dcrc(imgdata))
1247                 puts("Bad Data CRC\n");
1248         else
1249                 puts("OK\n");
1250
1251         free(imgdata);
1252
1253         return 0;
1254 }
1255
1256 static int nand_imls_fitimage(nand_info_t *nand, int nand_dev, loff_t off,
1257                 size_t len)
1258 {
1259         void *imgdata;
1260         int ret;
1261
1262         imgdata = malloc(len);
1263         if (!imgdata) {
1264                 printf("May be a FIT Image at NAND device %d offset %08llX:\n",
1265                                 nand_dev, off);
1266                 printf("   Low memory(cannot allocate memory for image)\n");
1267                 return -ENOMEM;
1268         }
1269
1270         ret = nand_read_skip_bad(nand, off, &len,
1271                         imgdata);
1272         if (ret < 0 && ret != -EUCLEAN) {
1273                 free(imgdata);
1274                 return ret;
1275         }
1276
1277         if (!fit_check_format(imgdata)) {
1278                 free(imgdata);
1279                 return 0;
1280         }
1281
1282         printf("FIT Image at NAND device %d offset %08llX:\n", nand_dev, off);
1283
1284         fit_print_contents(imgdata);
1285         free(imgdata);
1286
1287         return 0;
1288 }
1289
1290 static int do_imls_nand(void)
1291 {
1292         nand_info_t *nand;
1293         int nand_dev = nand_curr_device;
1294         size_t len;
1295         loff_t off;
1296         u32 buffer[16];
1297
1298         if (nand_dev < 0 || nand_dev >= CONFIG_SYS_MAX_NAND_DEVICE) {
1299                 puts("\nNo NAND devices available\n");
1300                 return -ENODEV;
1301         }
1302
1303         printf("\n");
1304
1305         for (nand_dev = 0; nand_dev < CONFIG_SYS_MAX_NAND_DEVICE; nand_dev++) {
1306                 nand = &nand_info[nand_dev];
1307                 if (!nand->name || !nand->size)
1308                         continue;
1309
1310                 for (off = 0; off < nand->size; off += nand->erasesize) {
1311                         const image_header_t *header;
1312                         int ret;
1313
1314                         if (nand_block_isbad(nand, off))
1315                                 continue;
1316
1317                         len = sizeof(buffer);
1318
1319                         ret = nand_read(nand, off, &len, (u8 *)buffer);
1320                         if (ret < 0 && ret != -EUCLEAN) {
1321                                 printf("NAND read error %d at offset %08llX\n",
1322                                                 ret, off);
1323                                 continue;
1324                         }
1325
1326                         switch (genimg_get_format(buffer)) {
1327                         case IMAGE_FORMAT_LEGACY:
1328                                 header = (const image_header_t *)buffer;
1329
1330                                 len = image_get_image_size(header);
1331                                 nand_imls_legacyimage(nand, nand_dev, off, len);
1332                                 break;
1333 #if defined(CONFIG_FIT)
1334                         case IMAGE_FORMAT_FIT:
1335                                 len = fit_get_size(buffer);
1336                                 nand_imls_fitimage(nand, nand_dev, off, len);
1337                                 break;
1338 #endif
1339                         }
1340                 }
1341         }
1342
1343         return 0;
1344 }
1345 #endif
1346
1347 #if defined(CONFIG_CMD_IMLS) || defined(CONFIG_CMD_IMLS_NAND)
1348 static int do_imls(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
1349 {
1350         int ret_nor = 0, ret_nand = 0;
1351
1352 #if defined(CONFIG_CMD_IMLS)
1353         ret_nor = do_imls_nor();
1354 #endif
1355
1356 #if defined(CONFIG_CMD_IMLS_NAND)
1357         ret_nand = do_imls_nand();
1358 #endif
1359
1360         if (ret_nor)
1361                 return ret_nor;
1362
1363         if (ret_nand)
1364                 return ret_nand;
1365
1366         return (0);
1367 }
1368
1369 U_BOOT_CMD(
1370         imls,   1,              1,      do_imls,
1371         "list all images found in flash",
1372         "\n"
1373         "    - Prints information about all images found at sector/block\n"
1374         "      boundaries in nor/nand flash."
1375 );
1376 #endif
1377
1378 /*******************************************************************/
1379 /* helper routines */
1380 /*******************************************************************/
1381 #if defined(CONFIG_SILENT_CONSOLE) && !defined(CONFIG_SILENT_U_BOOT_ONLY)
1382
1383 #define CONSOLE_ARG     "console="
1384 #define CONSOLE_ARG_LEN (sizeof(CONSOLE_ARG) - 1)
1385
1386 static void fixup_silent_linux(void)
1387 {
1388         char *buf;
1389         const char *env_val;
1390         char *cmdline = getenv("bootargs");
1391         int want_silent;
1392
1393         /*
1394          * Only fix cmdline when requested. The environment variable can be:
1395          *
1396          *      no - we never fixup
1397          *      yes - we always fixup
1398          *      unset - we rely on the console silent flag
1399          */
1400         want_silent = getenv_yesno("silent_linux");
1401         if (want_silent == 0)
1402                 return;
1403         else if (want_silent == -1 && !(gd->flags & GD_FLG_SILENT))
1404                 return;
1405
1406         debug("before silent fix-up: %s\n", cmdline);
1407         if (cmdline && (cmdline[0] != '\0')) {
1408                 char *start = strstr(cmdline, CONSOLE_ARG);
1409
1410                 /* Allocate space for maximum possible new command line */
1411                 buf = malloc(strlen(cmdline) + 1 + CONSOLE_ARG_LEN + 1);
1412                 if (!buf) {
1413                         debug("%s: out of memory\n", __func__);
1414                         return;
1415                 }
1416
1417                 if (start) {
1418                         char *end = strchr(start, ' ');
1419                         int num_start_bytes = start - cmdline + CONSOLE_ARG_LEN;
1420
1421                         strncpy(buf, cmdline, num_start_bytes);
1422                         if (end)
1423                                 strcpy(buf + num_start_bytes, end);
1424                         else
1425                                 buf[num_start_bytes] = '\0';
1426                 } else {
1427                         sprintf(buf, "%s %s", cmdline, CONSOLE_ARG);
1428                 }
1429                 env_val = buf;
1430         } else {
1431                 buf = NULL;
1432                 env_val = CONSOLE_ARG;
1433         }
1434
1435         setenv("bootargs", env_val);
1436         debug("after silent fix-up: %s\n", env_val);
1437         free(buf);
1438 }
1439 #endif /* CONFIG_SILENT_CONSOLE */
1440
1441 #if defined(CONFIG_BOOTM_NETBSD) || defined(CONFIG_BOOTM_PLAN9)
1442 static void copy_args(char *dest, int argc, char * const argv[], char delim)
1443 {
1444         int i;
1445
1446         for (i = 0; i < argc; i++) {
1447                 if (i > 0)
1448                         *dest++ = delim;
1449                 strcpy(dest, argv[i]);
1450                 dest += strlen(argv[i]);
1451         }
1452 }
1453 #endif
1454
1455 /*******************************************************************/
1456 /* OS booting routines */
1457 /*******************************************************************/
1458
1459 #ifdef CONFIG_BOOTM_NETBSD
1460 static int do_bootm_netbsd(int flag, int argc, char * const argv[],
1461                             bootm_headers_t *images)
1462 {
1463         void (*loader)(bd_t *, image_header_t *, char *, char *);
1464         image_header_t *os_hdr, *hdr;
1465         ulong kernel_data, kernel_len;
1466         char *consdev;
1467         char *cmdline;
1468
1469         if (flag & BOOTM_STATE_OS_PREP)
1470                 return 0;
1471         if ((flag != 0) && (flag != BOOTM_STATE_OS_GO))
1472                 return 1;
1473
1474 #if defined(CONFIG_FIT)
1475         if (!images->legacy_hdr_valid) {
1476                 fit_unsupported_reset("NetBSD");
1477                 return 1;
1478         }
1479 #endif
1480         hdr = images->legacy_hdr_os;
1481
1482         /*
1483          * Booting a (NetBSD) kernel image
1484          *
1485          * This process is pretty similar to a standalone application:
1486          * The (first part of an multi-) image must be a stage-2 loader,
1487          * which in turn is responsible for loading & invoking the actual
1488          * kernel.  The only differences are the parameters being passed:
1489          * besides the board info strucure, the loader expects a command
1490          * line, the name of the console device, and (optionally) the
1491          * address of the original image header.
1492          */
1493         os_hdr = NULL;
1494         if (image_check_type(&images->legacy_hdr_os_copy, IH_TYPE_MULTI)) {
1495                 image_multi_getimg(hdr, 1, &kernel_data, &kernel_len);
1496                 if (kernel_len)
1497                         os_hdr = hdr;
1498         }
1499
1500         consdev = "";
1501 #if   defined(CONFIG_8xx_CONS_SMC1)
1502         consdev = "smc1";
1503 #elif defined(CONFIG_8xx_CONS_SMC2)
1504         consdev = "smc2";
1505 #elif defined(CONFIG_8xx_CONS_SCC2)
1506         consdev = "scc2";
1507 #elif defined(CONFIG_8xx_CONS_SCC3)
1508         consdev = "scc3";
1509 #endif
1510
1511         if (argc > 0) {
1512                 ulong len;
1513                 int   i;
1514
1515                 for (i = 0, len = 0; i < argc; i += 1)
1516                         len += strlen(argv[i]) + 1;
1517                 cmdline = malloc(len);
1518                 copy_args(cmdline, argc, argv, ' ');
1519         } else if ((cmdline = getenv("bootargs")) == NULL) {
1520                 cmdline = "";
1521         }
1522
1523         loader = (void (*)(bd_t *, image_header_t *, char *, char *))images->ep;
1524
1525         printf("## Transferring control to NetBSD stage-2 loader "
1526                 "(at address %08lx) ...\n",
1527                 (ulong)loader);
1528
1529         bootstage_mark(BOOTSTAGE_ID_RUN_OS);
1530
1531         /*
1532          * NetBSD Stage-2 Loader Parameters:
1533          *   r3: ptr to board info data
1534          *   r4: image address
1535          *   r5: console device
1536          *   r6: boot args string
1537          */
1538         (*loader)(gd->bd, os_hdr, consdev, cmdline);
1539
1540         return 1;
1541 }
1542 #endif /* CONFIG_BOOTM_NETBSD*/
1543
1544 #ifdef CONFIG_LYNXKDI
1545 static int do_bootm_lynxkdi(int flag, int argc, char * const argv[],
1546                              bootm_headers_t *images)
1547 {
1548         image_header_t *hdr = &images->legacy_hdr_os_copy;
1549
1550         if (flag & BOOTM_STATE_OS_PREP)
1551                 return 0;
1552         if ((flag != 0) && (flag != BOOTM_STATE_OS_GO))
1553                 return 1;
1554
1555 #if defined(CONFIG_FIT)
1556         if (!images->legacy_hdr_valid) {
1557                 fit_unsupported_reset("Lynx");
1558                 return 1;
1559         }
1560 #endif
1561
1562         lynxkdi_boot((image_header_t *)hdr);
1563
1564         return 1;
1565 }
1566 #endif /* CONFIG_LYNXKDI */
1567
1568 #ifdef CONFIG_BOOTM_RTEMS
1569 static int do_bootm_rtems(int flag, int argc, char * const argv[],
1570                            bootm_headers_t *images)
1571 {
1572         void (*entry_point)(bd_t *);
1573
1574         if (flag & BOOTM_STATE_OS_PREP)
1575                 return 0;
1576         if ((flag != 0) && (flag != BOOTM_STATE_OS_GO))
1577                 return 1;
1578
1579 #if defined(CONFIG_FIT)
1580         if (!images->legacy_hdr_valid) {
1581                 fit_unsupported_reset("RTEMS");
1582                 return 1;
1583         }
1584 #endif
1585
1586         entry_point = (void (*)(bd_t *))images->ep;
1587
1588         printf("## Transferring control to RTEMS (at address %08lx) ...\n",
1589                 (ulong)entry_point);
1590
1591         bootstage_mark(BOOTSTAGE_ID_RUN_OS);
1592
1593         /*
1594          * RTEMS Parameters:
1595          *   r3: ptr to board info data
1596          */
1597         (*entry_point)(gd->bd);
1598
1599         return 1;
1600 }
1601 #endif /* CONFIG_BOOTM_RTEMS */
1602
1603 #if defined(CONFIG_BOOTM_OSE)
1604 static int do_bootm_ose(int flag, int argc, char * const argv[],
1605                            bootm_headers_t *images)
1606 {
1607         void (*entry_point)(void);
1608
1609         if (flag & BOOTM_STATE_OS_PREP)
1610                 return 0;
1611         if ((flag != 0) && (flag != BOOTM_STATE_OS_GO))
1612                 return 1;
1613
1614 #if defined(CONFIG_FIT)
1615         if (!images->legacy_hdr_valid) {
1616                 fit_unsupported_reset("OSE");
1617                 return 1;
1618         }
1619 #endif
1620
1621         entry_point = (void (*)(void))images->ep;
1622
1623         printf("## Transferring control to OSE (at address %08lx) ...\n",
1624                 (ulong)entry_point);
1625
1626         bootstage_mark(BOOTSTAGE_ID_RUN_OS);
1627
1628         /*
1629          * OSE Parameters:
1630          *   None
1631          */
1632         (*entry_point)();
1633
1634         return 1;
1635 }
1636 #endif /* CONFIG_BOOTM_OSE */
1637
1638 #if defined(CONFIG_BOOTM_PLAN9)
1639 static int do_bootm_plan9(int flag, int argc, char * const argv[],
1640                            bootm_headers_t *images)
1641 {
1642         void (*entry_point)(void);
1643         char *s;
1644
1645         if (flag & BOOTM_STATE_OS_PREP)
1646                 return 0;
1647         if ((flag != 0) && (flag != BOOTM_STATE_OS_GO))
1648                 return 1;
1649
1650 #if defined(CONFIG_FIT)
1651         if (!images->legacy_hdr_valid) {
1652                 fit_unsupported_reset("Plan 9");
1653                 return 1;
1654         }
1655 #endif
1656
1657         /* See README.plan9 */
1658         s = getenv("confaddr");
1659         if (s != NULL) {
1660                 char *confaddr = (char *)simple_strtoul(s, NULL, 16);
1661
1662                 if (argc > 0) {
1663                         copy_args(confaddr, argc, argv, '\n');
1664                 } else {
1665                         s = getenv("bootargs");
1666                         if (s != NULL)
1667                                 strcpy(confaddr, s);
1668                 }
1669         }
1670
1671         entry_point = (void (*)(void))images->ep;
1672
1673         printf("## Transferring control to Plan 9 (at address %08lx) ...\n",
1674                 (ulong)entry_point);
1675
1676         bootstage_mark(BOOTSTAGE_ID_RUN_OS);
1677
1678         /*
1679          * Plan 9 Parameters:
1680          *   None
1681          */
1682         (*entry_point)();
1683
1684         return 1;
1685 }
1686 #endif /* CONFIG_BOOTM_PLAN9 */
1687
1688 #if defined(CONFIG_CMD_ELF)
1689 static int do_bootm_vxworks(int flag, int argc, char * const argv[],
1690                              bootm_headers_t *images)
1691 {
1692         char str[80];
1693
1694         if (flag & BOOTM_STATE_OS_PREP)
1695                 return 0;
1696         if ((flag != 0) && (flag != BOOTM_STATE_OS_GO))
1697                 return 1;
1698
1699 #if defined(CONFIG_FIT)
1700         if (!images->legacy_hdr_valid) {
1701                 fit_unsupported_reset("VxWorks");
1702                 return 1;
1703         }
1704 #endif
1705
1706         sprintf(str, "%lx", images->ep); /* write entry-point into string */
1707         setenv("loadaddr", str);
1708         do_bootvx(NULL, 0, 0, NULL);
1709
1710         return 1;
1711 }
1712
1713 static int do_bootm_qnxelf(int flag, int argc, char * const argv[],
1714                             bootm_headers_t *images)
1715 {
1716         char *local_args[2];
1717         char str[16];
1718
1719         if (flag & BOOTM_STATE_OS_PREP)
1720                 return 0;
1721         if ((flag != 0) && (flag != BOOTM_STATE_OS_GO))
1722                 return 1;
1723
1724 #if defined(CONFIG_FIT)
1725         if (!images->legacy_hdr_valid) {
1726                 fit_unsupported_reset("QNX");
1727                 return 1;
1728         }
1729 #endif
1730
1731         sprintf(str, "%lx", images->ep); /* write entry-point into string */
1732         local_args[0] = argv[0];
1733         local_args[1] = str;    /* and provide it via the arguments */
1734         do_bootelf(NULL, 0, 2, local_args);
1735
1736         return 1;
1737 }
1738 #endif
1739
1740 #ifdef CONFIG_INTEGRITY
1741 static int do_bootm_integrity(int flag, int argc, char * const argv[],
1742                            bootm_headers_t *images)
1743 {
1744         void (*entry_point)(void);
1745
1746         if (flag & BOOTM_STATE_OS_PREP)
1747                 return 0;
1748         if ((flag != 0) && (flag != BOOTM_STATE_OS_GO))
1749                 return 1;
1750
1751 #if defined(CONFIG_FIT)
1752         if (!images->legacy_hdr_valid) {
1753                 fit_unsupported_reset("INTEGRITY");
1754                 return 1;
1755         }
1756 #endif
1757
1758         entry_point = (void (*)(void))images->ep;
1759
1760         printf("## Transferring control to INTEGRITY (at address %08lx) ...\n",
1761                 (ulong)entry_point);
1762
1763         bootstage_mark(BOOTSTAGE_ID_RUN_OS);
1764
1765         /*
1766          * INTEGRITY Parameters:
1767          *   None
1768          */
1769         (*entry_point)();
1770
1771         return 1;
1772 }
1773 #endif
1774
1775 #ifdef CONFIG_CMD_BOOTZ
1776
1777 int __weak bootz_setup(ulong image, ulong *start, ulong *end)
1778 {
1779         /* Please define bootz_setup() for your platform */
1780
1781         puts("Your platform's zImage format isn't supported yet!\n");
1782         return -1;
1783 }
1784
1785 /*
1786  * zImage booting support
1787  */
1788 static int bootz_start(cmd_tbl_t *cmdtp, int flag, int argc,
1789                         char * const argv[], bootm_headers_t *images)
1790 {
1791         int ret;
1792         ulong zi_start, zi_end;
1793
1794         ret = do_bootm_states(cmdtp, flag, argc, argv, BOOTM_STATE_START,
1795                               images, 1);
1796
1797         /* Setup Linux kernel zImage entry point */
1798         if (!argc) {
1799                 images->ep = load_addr;
1800                 debug("*  kernel: default image load address = 0x%08lx\n",
1801                                 load_addr);
1802         } else {
1803                 images->ep = simple_strtoul(argv[0], NULL, 16);
1804                 debug("*  kernel: cmdline image address = 0x%08lx\n",
1805                         images->ep);
1806         }
1807
1808         ret = bootz_setup(images->ep, &zi_start, &zi_end);
1809         if (ret != 0)
1810                 return 1;
1811
1812         lmb_reserve(&images->lmb, images->ep, zi_end - zi_start);
1813
1814         /*
1815          * Handle the BOOTM_STATE_FINDOTHER state ourselves as we do not
1816          * have a header that provide this informaiton.
1817          */
1818         if (bootm_find_ramdisk(flag, argc, argv))
1819                 return 1;
1820
1821 #if defined(CONFIG_OF_LIBFDT)
1822         if (bootm_find_fdt(flag, argc, argv))
1823                 return 1;
1824 #endif
1825
1826         return 0;
1827 }
1828
1829 int do_bootz(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
1830 {
1831         int ret;
1832
1833         /* Consume 'bootz' */
1834         argc--; argv++;
1835
1836         if (bootz_start(cmdtp, flag, argc, argv, &images))
1837                 return 1;
1838
1839         /*
1840          * We are doing the BOOTM_STATE_LOADOS state ourselves, so must
1841          * disable interrupts ourselves
1842          */
1843         bootm_disable_interrupts();
1844
1845         images.os.os = IH_OS_LINUX;
1846         ret = do_bootm_states(cmdtp, flag, argc, argv,
1847                               BOOTM_STATE_OS_PREP | BOOTM_STATE_OS_FAKE_GO |
1848                               BOOTM_STATE_OS_GO,
1849                               &images, 1);
1850
1851         return ret;
1852 }
1853
1854 #ifdef CONFIG_SYS_LONGHELP
1855 static char bootz_help_text[] =
1856         "[addr [initrd[:size]] [fdt]]\n"
1857         "    - boot Linux zImage stored in memory\n"
1858         "\tThe argument 'initrd' is optional and specifies the address\n"
1859         "\tof the initrd in memory. The optional argument ':size' allows\n"
1860         "\tspecifying the size of RAW initrd.\n"
1861 #if defined(CONFIG_OF_LIBFDT)
1862         "\tWhen booting a Linux kernel which requires a flat device-tree\n"
1863         "\ta third argument is required which is the address of the\n"
1864         "\tdevice-tree blob. To boot that kernel without an initrd image,\n"
1865         "\tuse a '-' for the second argument. If you do not pass a third\n"
1866         "\ta bd_info struct will be passed instead\n"
1867 #endif
1868         "";
1869 #endif
1870
1871 U_BOOT_CMD(
1872         bootz,  CONFIG_SYS_MAXARGS,     1,      do_bootz,
1873         "boot Linux zImage image from memory", bootz_help_text
1874 );
1875 #endif  /* CONFIG_CMD_BOOTZ */