common/cmd_bootm.c

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