common/bootm.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * (C) Copyright 2000-2009
   4  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
   5  */
   6
   7 #ifndef USE_HOSTCC
   8 #include <common.h>
   9 #include <bootstage.h>
  10 #include <cli.h>
  11 #include <cpu_func.h>
  12 #include <env.h>
  13 #include <errno.h>
  14 #include <fdt_support.h>
  15 #include <irq_func.h>
  16 #include <lmb.h>
  17 #include <log.h>
  18 #include <malloc.h>
  19 #include <mapmem.h>
  20 #include <net.h>
  21 #include <asm/cache.h>
  22 #include <asm/io.h>
  23 #include <linux/sizes.h>
  24 #if defined(CONFIG_CMD_USB)
  25 #include <usb.h>
  26 #endif
  27 #else
  28 #include "mkimage.h"
  29 #endif
  30
  31 #include <command.h>
  32 #include <bootm.h>
  33 #include <image.h>
  34
  35 #ifndef CONFIG_SYS_BOOTM_LEN
  36 /* use 8MByte as default max gunzip size */
  37 #define CONFIG_SYS_BOOTM_LEN    0x800000
  38 #endif
  39
  40 #define MAX_CMDLINE_SIZE        SZ_4K
  41
  42 #define IH_INITRD_ARCH IH_ARCH_DEFAULT
  43
  44 #ifndef USE_HOSTCC
  45
  46 DECLARE_GLOBAL_DATA_PTR;
  47
  48 bootm_headers_t images;         /* pointers to os/initrd/fdt images */
  49
  50 static const void *boot_get_kernel(struct cmd_tbl *cmdtp, int flag, int argc,
  51                                    char *const argv[], bootm_headers_t *images,
  52                                    ulong *os_data, ulong *os_len);
  53
  54 __weak void board_quiesce_devices(void)
  55 {
  56 }
  57
  58 #ifdef CONFIG_LMB
  59 static void boot_start_lmb(bootm_headers_t *images)
  60 {
  61         ulong           mem_start;
  62         phys_size_t     mem_size;
  63
  64         mem_start = env_get_bootm_low();
  65         mem_size = env_get_bootm_size();
  66
  67         lmb_init_and_reserve_range(&images->lmb, (phys_addr_t)mem_start,
  68                                    mem_size, NULL);
  69 }
  70 #else
  71 #define lmb_reserve(lmb, base, size)
  72 static inline void boot_start_lmb(bootm_headers_t *images) { }
  73 #endif
  74
  75 static int bootm_start(struct cmd_tbl *cmdtp, int flag, int argc,
  76                        char *const argv[])
  77 {
  78         memset((void *)&images, 0, sizeof(images));
  79         images.verify = env_get_yesno("verify");
  80
  81         boot_start_lmb(&images);
  82
  83         bootstage_mark_name(BOOTSTAGE_ID_BOOTM_START, "bootm_start");
  84         images.state = BOOTM_STATE_START;
  85
  86         return 0;
  87 }
  88
  89 static int bootm_find_os(struct cmd_tbl *cmdtp, int flag, int argc,
  90                          char *const argv[])
  91 {
  92         const void *os_hdr;
  93         bool ep_found = false;
  94         int ret;
  95
  96         /* get kernel image header, start address and length */
  97         os_hdr = boot_get_kernel(cmdtp, flag, argc, argv,
  98                         &images, &images.os.image_start, &images.os.image_len);
  99         if (images.os.image_len == 0) {
 100                 puts("ERROR: can't get kernel image!\n");
 101                 return 1;
 102         }
 103
 104         /* get image parameters */
 105         switch (genimg_get_format(os_hdr)) {
 106 #if CONFIG_IS_ENABLED(LEGACY_IMAGE_FORMAT)
 107         case IMAGE_FORMAT_LEGACY:
 108                 images.os.type = image_get_type(os_hdr);
 109                 images.os.comp = image_get_comp(os_hdr);
 110                 images.os.os = image_get_os(os_hdr);
 111
 112                 images.os.end = image_get_image_end(os_hdr);
 113                 images.os.load = image_get_load(os_hdr);
 114                 images.os.arch = image_get_arch(os_hdr);
 115                 break;
 116 #endif
 117 #if IMAGE_ENABLE_FIT
 118         case IMAGE_FORMAT_FIT:
 119                 if (fit_image_get_type(images.fit_hdr_os,
 120                                        images.fit_noffset_os,
 121                                        &images.os.type)) {
 122                         puts("Can't get image type!\n");
 123                         bootstage_error(BOOTSTAGE_ID_FIT_TYPE);
 124                         return 1;
 125                 }
 126
 127                 if (fit_image_get_comp(images.fit_hdr_os,
 128                                        images.fit_noffset_os,
 129                                        &images.os.comp)) {
 130                         puts("Can't get image compression!\n");
 131                         bootstage_error(BOOTSTAGE_ID_FIT_COMPRESSION);
 132                         return 1;
 133                 }
 134
 135                 if (fit_image_get_os(images.fit_hdr_os, images.fit_noffset_os,
 136                                      &images.os.os)) {
 137                         puts("Can't get image OS!\n");
 138                         bootstage_error(BOOTSTAGE_ID_FIT_OS);
 139                         return 1;
 140                 }
 141
 142                 if (fit_image_get_arch(images.fit_hdr_os,
 143                                        images.fit_noffset_os,
 144                                        &images.os.arch)) {
 145                         puts("Can't get image ARCH!\n");
 146                         return 1;
 147                 }
 148
 149                 images.os.end = fit_get_end(images.fit_hdr_os);
 150
 151                 if (fit_image_get_load(images.fit_hdr_os, images.fit_noffset_os,
 152                                        &images.os.load)) {
 153                         puts("Can't get image load address!\n");
 154                         bootstage_error(BOOTSTAGE_ID_FIT_LOADADDR);
 155                         return 1;
 156                 }
 157                 break;
 158 #endif
 159 #ifdef CONFIG_ANDROID_BOOT_IMAGE
 160         case IMAGE_FORMAT_ANDROID:
 161                 images.os.type = IH_TYPE_KERNEL;
 162                 images.os.comp = android_image_get_kcomp(os_hdr);
 163                 images.os.os = IH_OS_LINUX;
 164
 165                 images.os.end = android_image_get_end(os_hdr);
 166                 images.os.load = android_image_get_kload(os_hdr);
 167                 images.ep = images.os.load;
 168                 ep_found = true;
 169                 break;
 170 #endif
 171         default:
 172                 puts("ERROR: unknown image format type!\n");
 173                 return 1;
 174         }
 175
 176         /* If we have a valid setup.bin, we will use that for entry (x86) */
 177         if (images.os.arch == IH_ARCH_I386 ||
 178             images.os.arch == IH_ARCH_X86_64) {
 179                 ulong len;
 180
 181                 ret = boot_get_setup(&images, IH_ARCH_I386, &images.ep, &len);
 182                 if (ret < 0 && ret != -ENOENT) {
 183                         puts("Could not find a valid setup.bin for x86\n");
 184                         return 1;
 185                 }
 186                 /* Kernel entry point is the setup.bin */
 187         } else if (images.legacy_hdr_valid) {
 188                 images.ep = image_get_ep(&images.legacy_hdr_os_copy);
 189 #if IMAGE_ENABLE_FIT
 190         } else if (images.fit_uname_os) {
 191                 int ret;
 192
 193                 ret = fit_image_get_entry(images.fit_hdr_os,
 194                                           images.fit_noffset_os, &images.ep);
 195                 if (ret) {
 196                         puts("Can't get entry point property!\n");
 197                         return 1;
 198                 }
 199 #endif
 200         } else if (!ep_found) {
 201                 puts("Could not find kernel entry point!\n");
 202                 return 1;
 203         }
 204
 205         if (images.os.type == IH_TYPE_KERNEL_NOLOAD) {
 206                 if (CONFIG_IS_ENABLED(CMD_BOOTI) &&
 207                     images.os.arch == IH_ARCH_ARM64) {
 208                         ulong image_addr;
 209                         ulong image_size;
 210
 211                         ret = booti_setup(images.os.image_start, &image_addr,
 212                                           &image_size, true);
 213                         if (ret != 0)
 214                                 return 1;
 215
 216                         images.os.type = IH_TYPE_KERNEL;
 217                         images.os.load = image_addr;
 218                         images.ep = image_addr;
 219                 } else {
 220                         images.os.load = images.os.image_start;
 221                         images.ep += images.os.image_start;
 222                 }
 223         }
 224
 225         images.os.start = map_to_sysmem(os_hdr);
 226
 227         return 0;
 228 }
 229
 230 /**
 231  * bootm_find_images - wrapper to find and locate various images
 232  * @flag: Ignored Argument
 233  * @argc: command argument count
 234  * @argv: command argument list
 235  * @start: OS image start address
 236  * @size: OS image size
 237  *
 238  * boot_find_images() will attempt to load an available ramdisk,
 239  * flattened device tree, as well as specifically marked
 240  * "loadable" images (loadables are FIT only)
 241  *
 242  * Note: bootm_find_images will skip an image if it is not found
 243  *
 244  * @return:
 245  *     0, if all existing images were loaded correctly
 246  *     1, if an image is found but corrupted, or invalid
 247  */
 248 int bootm_find_images(int flag, int argc, char *const argv[], ulong start,
 249                       ulong size)
 250 {
 251         int ret;
 252
 253         /* find ramdisk */
 254         ret = boot_get_ramdisk(argc, argv, &images, IH_INITRD_ARCH,
 255                                &images.rd_start, &images.rd_end);
 256         if (ret) {
 257                 puts("Ramdisk image is corrupt or invalid\n");
 258                 return 1;
 259         }
 260
 261         /* check if ramdisk overlaps OS image */
 262         if (images.rd_start && (((ulong)images.rd_start >= start &&
 263                                  (ulong)images.rd_start < start + size) ||
 264                                 ((ulong)images.rd_end > start &&
 265                                  (ulong)images.rd_end <= start + size) ||
 266                                 ((ulong)images.rd_start < start &&
 267                                  (ulong)images.rd_end >= start + size))) {
 268                 printf("ERROR: RD image overlaps OS image (OS=0x%lx..0x%lx)\n",
 269                        start, start + size);
 270                 return 1;
 271         }
 272
 273 #if IMAGE_ENABLE_OF_LIBFDT
 274         /* find flattened device tree */
 275         ret = boot_get_fdt(flag, argc, argv, IH_ARCH_DEFAULT, &images,
 276                            &images.ft_addr, &images.ft_len);
 277         if (ret) {
 278                 puts("Could not find a valid device tree\n");
 279                 return 1;
 280         }
 281
 282         /* check if FDT overlaps OS image */
 283         if (images.ft_addr &&
 284             (((ulong)images.ft_addr >= start &&
 285               (ulong)images.ft_addr <= start + size) ||
 286              ((ulong)images.ft_addr + images.ft_len >= start &&
 287               (ulong)images.ft_addr + images.ft_len <= start + size))) {
 288                 printf("ERROR: FDT image overlaps OS image (OS=0x%lx..0x%lx)\n",
 289                        start, start + size);
 290                 return 1;
 291         }
 292
 293         if (CONFIG_IS_ENABLED(CMD_FDT))
 294                 set_working_fdt_addr(map_to_sysmem(images.ft_addr));
 295 #endif
 296
 297 #if IMAGE_ENABLE_FIT
 298 #if defined(CONFIG_FPGA)
 299         /* find bitstreams */
 300         ret = boot_get_fpga(argc, argv, &images, IH_ARCH_DEFAULT,
 301                             NULL, NULL);
 302         if (ret) {
 303                 printf("FPGA image is corrupted or invalid\n");
 304                 return 1;
 305         }
 306 #endif
 307
 308         /* find all of the loadables */
 309         ret = boot_get_loadable(argc, argv, &images, IH_ARCH_DEFAULT,
 310                                NULL, NULL);
 311         if (ret) {
 312                 printf("Loadable(s) is corrupt or invalid\n");
 313                 return 1;
 314         }
 315 #endif
 316
 317         return 0;
 318 }
 319
 320 static int bootm_find_other(struct cmd_tbl *cmdtp, int flag, int argc,
 321                             char *const argv[])
 322 {
 323         if (((images.os.type == IH_TYPE_KERNEL) ||
 324              (images.os.type == IH_TYPE_KERNEL_NOLOAD) ||
 325              (images.os.type == IH_TYPE_MULTI)) &&
 326             (images.os.os == IH_OS_LINUX ||
 327                  images.os.os == IH_OS_VXWORKS))
 328                 return bootm_find_images(flag, argc, argv, 0, 0);
 329
 330         return 0;
 331 }
 332 #endif /* USE_HOSTC */
 333
 334 #if !defined(USE_HOSTCC) || defined(CONFIG_FIT_SIGNATURE)
 335 /**
 336  * handle_decomp_error() - display a decompression error
 337  *
 338  * This function tries to produce a useful message. In the case where the
 339  * uncompressed size is the same as the available space, we can assume that
 340  * the image is too large for the buffer.
 341  *
 342  * @comp_type:          Compression type being used (IH_COMP_...)
 343  * @uncomp_size:        Number of bytes uncompressed
 344  * @ret:                errno error code received from compression library
 345  * @return Appropriate BOOTM_ERR_ error code
 346  */
 347 static int handle_decomp_error(int comp_type, size_t uncomp_size, int ret)
 348 {
 349         const char *name = genimg_get_comp_name(comp_type);
 350
 351         /* ENOSYS means unimplemented compression type, don't reset. */
 352         if (ret == -ENOSYS)
 353                 return BOOTM_ERR_UNIMPLEMENTED;
 354
 355         if (uncomp_size >= CONFIG_SYS_BOOTM_LEN)
 356                 printf("Image too large: increase CONFIG_SYS_BOOTM_LEN\n");
 357         else
 358                 printf("%s: uncompress error %d\n", name, ret);
 359
 360         /*
 361          * The decompression routines are now safe, so will not write beyond
 362          * their bounds. Probably it is not necessary to reset, but maintain
 363          * the current behaviour for now.
 364          */
 365         printf("Must RESET board to recover\n");
 366 #ifndef USE_HOSTCC
 367         bootstage_error(BOOTSTAGE_ID_DECOMP_IMAGE);
 368 #endif
 369
 370         return BOOTM_ERR_RESET;
 371 }
 372 #endif
 373
 374 #ifndef USE_HOSTCC
 375 static int bootm_load_os(bootm_headers_t *images, int boot_progress)
 376 {
 377         image_info_t os = images->os;
 378         ulong load = os.load;
 379         ulong load_end;
 380         ulong blob_start = os.start;
 381         ulong blob_end = os.end;
 382         ulong image_start = os.image_start;
 383         ulong image_len = os.image_len;
 384         ulong flush_start = ALIGN_DOWN(load, ARCH_DMA_MINALIGN);
 385         bool no_overlap;
 386         void *load_buf, *image_buf;
 387         int err;
 388
 389         load_buf = map_sysmem(load, 0);
 390         image_buf = map_sysmem(os.image_start, image_len);
 391         err = image_decomp(os.comp, load, os.image_start, os.type,
 392                            load_buf, image_buf, image_len,
 393                            CONFIG_SYS_BOOTM_LEN, &load_end);
 394         if (err) {
 395                 err = handle_decomp_error(os.comp, load_end - load, err);
 396                 bootstage_error(BOOTSTAGE_ID_DECOMP_IMAGE);
 397                 return err;
 398         }
 399         /* We need the decompressed image size in the next steps */
 400         images->os.image_len = load_end - load;
 401
 402         flush_cache(flush_start, ALIGN(load_end, ARCH_DMA_MINALIGN) - flush_start);
 403
 404         debug("   kernel loaded at 0x%08lx, end = 0x%08lx\n", load, load_end);
 405         bootstage_mark(BOOTSTAGE_ID_KERNEL_LOADED);
 406
 407         no_overlap = (os.comp == IH_COMP_NONE && load == image_start);
 408
 409         if (!no_overlap && load < blob_end && load_end > blob_start) {
 410                 debug("images.os.start = 0x%lX, images.os.end = 0x%lx\n",
 411                       blob_start, blob_end);
 412                 debug("images.os.load = 0x%lx, load_end = 0x%lx\n", load,
 413                       load_end);
 414
 415                 /* Check what type of image this is. */
 416                 if (images->legacy_hdr_valid) {
 417                         if (image_get_type(&images->legacy_hdr_os_copy)
 418                                         == IH_TYPE_MULTI)
 419                                 puts("WARNING: legacy format multi component image overwritten\n");
 420                         return BOOTM_ERR_OVERLAP;
 421                 } else {
 422                         puts("ERROR: new format image overwritten - must RESET the board to recover\n");
 423                         bootstage_error(BOOTSTAGE_ID_OVERWRITTEN);
 424                         return BOOTM_ERR_RESET;
 425                 }
 426         }
 427
 428         lmb_reserve(&images->lmb, images->os.load, (load_end -
 429                                                     images->os.load));
 430         return 0;
 431 }
 432
 433 /**
 434  * bootm_disable_interrupts() - Disable interrupts in preparation for load/boot
 435  *
 436  * @return interrupt flag (0 if interrupts were disabled, non-zero if they were
 437  *      enabled)
 438  */
 439 ulong bootm_disable_interrupts(void)
 440 {
 441         ulong iflag;
 442
 443         /*
 444          * We have reached the point of no return: we are going to
 445          * overwrite all exception vector code, so we cannot easily
 446          * recover from any failures any more...
 447          */
 448         iflag = disable_interrupts();
 449 #ifdef CONFIG_NETCONSOLE
 450         /* Stop the ethernet stack if NetConsole could have left it up */
 451         eth_halt();
 452 # ifndef CONFIG_DM_ETH
 453         eth_unregister(eth_get_dev());
 454 # endif
 455 #endif
 456
 457 #if defined(CONFIG_CMD_USB)
 458         /*
 459          * turn off USB to prevent the host controller from writing to the
 460          * SDRAM while Linux is booting. This could happen (at least for OHCI
 461          * controller), because the HCCA (Host Controller Communication Area)
 462          * lies within the SDRAM and the host controller writes continously to
 463          * this area (as busmaster!). The HccaFrameNumber is for example
 464          * updated every 1 ms within the HCCA structure in SDRAM! For more
 465          * details see the OpenHCI specification.
 466          */
 467         usb_stop();
 468 #endif
 469         return iflag;
 470 }
 471
 472 #define CONSOLE_ARG             "console="
 473 #define CONSOLE_ARG_SIZE        sizeof(CONSOLE_ARG)
 474
 475 /**
 476  * fixup_silent_linux() - Handle silencing the linux boot if required
 477  *
 478  * This uses the silent_linux envvar to control whether to add/set a "console="
 479  * parameter to the command line
 480  *
 481  * @buf: Buffer containing the string to process
 482  * @maxlen: Maximum length of buffer
 483  * @return 0 if OK, -ENOSPC if @maxlen is too small
 484  */
 485 static int fixup_silent_linux(char *buf, int maxlen)
 486 {
 487         int want_silent;
 488         char *cmdline;
 489         int size;
 490
 491         /*
 492          * Move the input string to the end of buffer. The output string will be
 493          * built up at the start.
 494          */
 495         size = strlen(buf) + 1;
 496         if (size * 2 > maxlen)
 497                 return -ENOSPC;
 498         cmdline = buf + maxlen - size;
 499         memmove(cmdline, buf, size);
 500         /*
 501          * Only fix cmdline when requested. The environment variable can be:
 502          *
 503          *      no - we never fixup
 504          *      yes - we always fixup
 505          *      unset - we rely on the console silent flag
 506          */
 507         want_silent = env_get_yesno("silent_linux");
 508         if (want_silent == 0)
 509                 return 0;
 510         else if (want_silent == -1 && !(gd->flags & GD_FLG_SILENT))
 511                 return 0;
 512
 513         debug("before silent fix-up: %s\n", cmdline);
 514         if (*cmdline) {
 515                 char *start = strstr(cmdline, CONSOLE_ARG);
 516
 517                 /* Check space for maximum possible new command line */
 518                 if (size + CONSOLE_ARG_SIZE > maxlen)
 519                         return -ENOSPC;
 520
 521                 if (start) {
 522                         char *end = strchr(start, ' ');
 523                         int start_bytes;
 524
 525                         start_bytes = start - cmdline + CONSOLE_ARG_SIZE - 1;
 526                         strncpy(buf, cmdline, start_bytes);
 527                         if (end)
 528                                 strcpy(buf + start_bytes, end);
 529                         else
 530                                 buf[start_bytes] = '\0';
 531                 } else {
 532                         sprintf(buf, "%s %s", cmdline, CONSOLE_ARG);
 533                 }
 534                 if (buf + strlen(buf) >= cmdline)
 535                         return -ENOSPC;
 536         } else {
 537                 if (maxlen < sizeof(CONSOLE_ARG))
 538                         return -ENOSPC;
 539                 strcpy(buf, CONSOLE_ARG);
 540         }
 541         debug("after silent fix-up: %s\n", buf);
 542
 543         return 0;
 544 }
 545
 546 /**
 547  * process_subst() - Handle substitution of ${...} fields in the environment
 548  *
 549  * Handle variable substitution in the provided buffer
 550  *
 551  * @buf: Buffer containing the string to process
 552  * @maxlen: Maximum length of buffer
 553  * @return 0 if OK, -ENOSPC if @maxlen is too small
 554  */
 555 static int process_subst(char *buf, int maxlen)
 556 {
 557         char *cmdline;
 558         int size;
 559         int ret;
 560
 561         /* Move to end of buffer */
 562         size = strlen(buf) + 1;
 563         cmdline = buf + maxlen - size;
 564         if (buf + size > cmdline)
 565                 return -ENOSPC;
 566         memmove(cmdline, buf, size);
 567
 568         ret = cli_simple_process_macros(cmdline, buf, cmdline - buf);
 569
 570         return ret;
 571 }
 572
 573 int bootm_process_cmdline(char *buf, int maxlen, int flags)
 574 {
 575         int ret;
 576
 577         /* Check config first to enable compiler to eliminate code */
 578         if (IS_ENABLED(CONFIG_SILENT_CONSOLE) &&
 579             !IS_ENABLED(CONFIG_SILENT_U_BOOT_ONLY) &&
 580             (flags & BOOTM_CL_SILENT)) {
 581                 ret = fixup_silent_linux(buf, maxlen);
 582                 if (ret)
 583                         return log_msg_ret("silent", ret);
 584         }
 585         if (IS_ENABLED(CONFIG_BOOTARGS_SUBST) && (flags & BOOTM_CL_SUBST)) {
 586                 ret = process_subst(buf, maxlen);
 587                 if (ret)
 588                         return log_msg_ret("silent", ret);
 589         }
 590
 591         return 0;
 592 }
 593
 594 int bootm_process_cmdline_env(int flags)
 595 {
 596         const int maxlen = MAX_CMDLINE_SIZE;
 597         bool do_silent;
 598         const char *env;
 599         char *buf;
 600         int ret;
 601
 602         /* First check if any action is needed */
 603         do_silent = IS_ENABLED(CONFIG_SILENT_CONSOLE) &&
 604             !IS_ENABLED(CONFIG_SILENT_U_BOOT_ONLY) && (flags & BOOTM_CL_SILENT);
 605         if (!do_silent && !IS_ENABLED(CONFIG_BOOTARGS_SUBST))
 606                 return 0;
 607
 608         env = env_get("bootargs");
 609         if (env && strlen(env) >= maxlen)
 610                 return -E2BIG;
 611         buf = malloc(maxlen);
 612         if (!buf)
 613                 return -ENOMEM;
 614         if (env)
 615                 strcpy(buf, env);
 616         else
 617                 *buf = '\0';
 618         ret = bootm_process_cmdline(buf, maxlen, flags);
 619         if (!ret) {
 620                 ret = env_set("bootargs", buf);
 621
 622                 /*
 623                  * If buf is "" and bootargs does not exist, this will produce
 624                  * an error trying to delete bootargs. Ignore it
 625                  */
 626                 if (ret == -ENOENT)
 627                         ret = 0;
 628         }
 629         free(buf);
 630         if (ret)
 631                 return log_msg_ret("env", ret);
 632
 633         return 0;
 634 }
 635
 636 /**
 637  * Execute selected states of the bootm command.
 638  *
 639  * Note the arguments to this state must be the first argument, Any 'bootm'
 640  * or sub-command arguments must have already been taken.
 641  *
 642  * Note that if states contains more than one flag it MUST contain
 643  * BOOTM_STATE_START, since this handles and consumes the command line args.
 644  *
 645  * Also note that aside from boot_os_fn functions and bootm_load_os no other
 646  * functions we store the return value of in 'ret' may use a negative return
 647  * value, without special handling.
 648  *
 649  * @param cmdtp         Pointer to bootm command table entry
 650  * @param flag          Command flags (CMD_FLAG_...)
 651  * @param argc          Number of subcommand arguments (0 = no arguments)
 652  * @param argv          Arguments
 653  * @param states        Mask containing states to run (BOOTM_STATE_...)
 654  * @param images        Image header information
 655  * @param boot_progress 1 to show boot progress, 0 to not do this
 656  * @return 0 if ok, something else on error. Some errors will cause this
 657  *      function to perform a reboot! If states contains BOOTM_STATE_OS_GO
 658  *      then the intent is to boot an OS, so this function will not return
 659  *      unless the image type is standalone.
 660  */
 661 int do_bootm_states(struct cmd_tbl *cmdtp, int flag, int argc,
 662                     char *const argv[], int states, bootm_headers_t *images,
 663                     int boot_progress)
 664 {
 665         boot_os_fn *boot_fn;
 666         ulong iflag = 0;
 667         int ret = 0, need_boot_fn;
 668
 669         images->state |= states;
 670
 671         /*
 672          * Work through the states and see how far we get. We stop on
 673          * any error.
 674          */
 675         if (states & BOOTM_STATE_START)
 676                 ret = bootm_start(cmdtp, flag, argc, argv);
 677
 678         if (!ret && (states & BOOTM_STATE_FINDOS))
 679                 ret = bootm_find_os(cmdtp, flag, argc, argv);
 680
 681         if (!ret && (states & BOOTM_STATE_FINDOTHER))
 682                 ret = bootm_find_other(cmdtp, flag, argc, argv);
 683
 684         /* Load the OS */
 685         if (!ret && (states & BOOTM_STATE_LOADOS)) {
 686                 iflag = bootm_disable_interrupts();
 687                 ret = bootm_load_os(images, 0);
 688                 if (ret && ret != BOOTM_ERR_OVERLAP)
 689                         goto err;
 690                 else if (ret == BOOTM_ERR_OVERLAP)
 691                         ret = 0;
 692         }
 693
 694         /* Relocate the ramdisk */
 695 #ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH
 696         if (!ret && (states & BOOTM_STATE_RAMDISK)) {
 697                 ulong rd_len = images->rd_end - images->rd_start;
 698
 699                 ret = boot_ramdisk_high(&images->lmb, images->rd_start,
 700                         rd_len, &images->initrd_start, &images->initrd_end);
 701                 if (!ret) {
 702                         env_set_hex("initrd_start", images->initrd_start);
 703                         env_set_hex("initrd_end", images->initrd_end);
 704                 }
 705         }
 706 #endif
 707 #if IMAGE_ENABLE_OF_LIBFDT && defined(CONFIG_LMB)
 708         if (!ret && (states & BOOTM_STATE_FDT)) {
 709                 boot_fdt_add_mem_rsv_regions(&images->lmb, images->ft_addr);
 710                 ret = boot_relocate_fdt(&images->lmb, &images->ft_addr,
 711                                         &images->ft_len);
 712         }
 713 #endif
 714
 715         /* From now on, we need the OS boot function */
 716         if (ret)
 717                 return ret;
 718         boot_fn = bootm_os_get_boot_func(images->os.os);
 719         need_boot_fn = states & (BOOTM_STATE_OS_CMDLINE |
 720                         BOOTM_STATE_OS_BD_T | BOOTM_STATE_OS_PREP |
 721                         BOOTM_STATE_OS_FAKE_GO | BOOTM_STATE_OS_GO);
 722         if (boot_fn == NULL && need_boot_fn) {
 723                 if (iflag)
 724                         enable_interrupts();
 725                 printf("ERROR: booting os '%s' (%d) is not supported\n",
 726                        genimg_get_os_name(images->os.os), images->os.os);
 727                 bootstage_error(BOOTSTAGE_ID_CHECK_BOOT_OS);
 728                 return 1;
 729         }
 730
 731
 732         /* Call various other states that are not generally used */
 733         if (!ret && (states & BOOTM_STATE_OS_CMDLINE))
 734                 ret = boot_fn(BOOTM_STATE_OS_CMDLINE, argc, argv, images);
 735         if (!ret && (states & BOOTM_STATE_OS_BD_T))
 736                 ret = boot_fn(BOOTM_STATE_OS_BD_T, argc, argv, images);
 737         if (!ret && (states & BOOTM_STATE_OS_PREP)) {
 738                 ret = bootm_process_cmdline_env(images->os.os == IH_OS_LINUX);
 739                 if (ret) {
 740                         printf("Cmdline setup failed (err=%d)\n", ret);
 741                         ret = CMD_RET_FAILURE;
 742                         goto err;
 743                 }
 744                 ret = boot_fn(BOOTM_STATE_OS_PREP, argc, argv, images);
 745         }
 746
 747 #ifdef CONFIG_TRACE
 748         /* Pretend to run the OS, then run a user command */
 749         if (!ret && (states & BOOTM_STATE_OS_FAKE_GO)) {
 750                 char *cmd_list = env_get("fakegocmd");
 751
 752                 ret = boot_selected_os(argc, argv, BOOTM_STATE_OS_FAKE_GO,
 753                                 images, boot_fn);
 754                 if (!ret && cmd_list)
 755                         ret = run_command_list(cmd_list, -1, flag);
 756         }
 757 #endif
 758
 759         /* Check for unsupported subcommand. */
 760         if (ret) {
 761                 puts("subcommand not supported\n");
 762                 return ret;
 763         }
 764
 765         /* Now run the OS! We hope this doesn't return */
 766         if (!ret && (states & BOOTM_STATE_OS_GO))
 767                 ret = boot_selected_os(argc, argv, BOOTM_STATE_OS_GO,
 768                                 images, boot_fn);
 769
 770         /* Deal with any fallout */
 771 err:
 772         if (iflag)
 773                 enable_interrupts();
 774
 775         if (ret == BOOTM_ERR_UNIMPLEMENTED)
 776                 bootstage_error(BOOTSTAGE_ID_DECOMP_UNIMPL);
 777         else if (ret == BOOTM_ERR_RESET)
 778                 do_reset(cmdtp, flag, argc, argv);
 779
 780         return ret;
 781 }
 782
 783 #if CONFIG_IS_ENABLED(LEGACY_IMAGE_FORMAT)
 784 /**
 785  * image_get_kernel - verify legacy format kernel image
 786  * @img_addr: in RAM address of the legacy format image to be verified
 787  * @verify: data CRC verification flag
 788  *
 789  * image_get_kernel() verifies legacy image integrity and returns pointer to
 790  * legacy image header if image verification was completed successfully.
 791  *
 792  * returns:
 793  *     pointer to a legacy image header if valid image was found
 794  *     otherwise return NULL
 795  */
 796 static image_header_t *image_get_kernel(ulong img_addr, int verify)
 797 {
 798         image_header_t *hdr = (image_header_t *)img_addr;
 799
 800         if (!image_check_magic(hdr)) {
 801                 puts("Bad Magic Number\n");
 802                 bootstage_error(BOOTSTAGE_ID_CHECK_MAGIC);
 803                 return NULL;
 804         }
 805         bootstage_mark(BOOTSTAGE_ID_CHECK_HEADER);
 806
 807         if (!image_check_hcrc(hdr)) {
 808                 puts("Bad Header Checksum\n");
 809                 bootstage_error(BOOTSTAGE_ID_CHECK_HEADER);
 810                 return NULL;
 811         }
 812
 813         bootstage_mark(BOOTSTAGE_ID_CHECK_CHECKSUM);
 814         image_print_contents(hdr);
 815
 816         if (verify) {
 817                 puts("   Verifying Checksum ... ");
 818                 if (!image_check_dcrc(hdr)) {
 819                         printf("Bad Data CRC\n");
 820                         bootstage_error(BOOTSTAGE_ID_CHECK_CHECKSUM);
 821                         return NULL;
 822                 }
 823                 puts("OK\n");
 824         }
 825         bootstage_mark(BOOTSTAGE_ID_CHECK_ARCH);
 826
 827         if (!image_check_target_arch(hdr)) {
 828                 printf("Unsupported Architecture 0x%x\n", image_get_arch(hdr));
 829                 bootstage_error(BOOTSTAGE_ID_CHECK_ARCH);
 830                 return NULL;
 831         }
 832         return hdr;
 833 }
 834 #endif
 835
 836 /**
 837  * boot_get_kernel - find kernel image
 838  * @os_data: pointer to a ulong variable, will hold os data start address
 839  * @os_len: pointer to a ulong variable, will hold os data length
 840  *
 841  * boot_get_kernel() tries to find a kernel image, verifies its integrity
 842  * and locates kernel data.
 843  *
 844  * returns:
 845  *     pointer to image header if valid image was found, plus kernel start
 846  *     address and length, otherwise NULL
 847  */
 848 static const void *boot_get_kernel(struct cmd_tbl *cmdtp, int flag, int argc,
 849                                    char *const argv[], bootm_headers_t *images,
 850                                    ulong *os_data, ulong *os_len)
 851 {
 852 #if CONFIG_IS_ENABLED(LEGACY_IMAGE_FORMAT)
 853         image_header_t  *hdr;
 854 #endif
 855         ulong           img_addr;
 856         const void *buf;
 857         const char      *fit_uname_config = NULL;
 858         const char      *fit_uname_kernel = NULL;
 859 #if IMAGE_ENABLE_FIT
 860         int             os_noffset;
 861 #endif
 862
 863         img_addr = genimg_get_kernel_addr_fit(argc < 1 ? NULL : argv[0],
 864                                               &fit_uname_config,
 865                                               &fit_uname_kernel);
 866
 867         bootstage_mark(BOOTSTAGE_ID_CHECK_MAGIC);
 868
 869         /* check image type, for FIT images get FIT kernel node */
 870         *os_data = *os_len = 0;
 871         buf = map_sysmem(img_addr, 0);
 872         switch (genimg_get_format(buf)) {
 873 #if CONFIG_IS_ENABLED(LEGACY_IMAGE_FORMAT)
 874         case IMAGE_FORMAT_LEGACY:
 875                 printf("## Booting kernel from Legacy Image at %08lx ...\n",
 876                        img_addr);
 877                 hdr = image_get_kernel(img_addr, images->verify);
 878                 if (!hdr)
 879                         return NULL;
 880                 bootstage_mark(BOOTSTAGE_ID_CHECK_IMAGETYPE);
 881
 882                 /* get os_data and os_len */
 883                 switch (image_get_type(hdr)) {
 884                 case IH_TYPE_KERNEL:
 885                 case IH_TYPE_KERNEL_NOLOAD:
 886                         *os_data = image_get_data(hdr);
 887                         *os_len = image_get_data_size(hdr);
 888                         break;
 889                 case IH_TYPE_MULTI:
 890                         image_multi_getimg(hdr, 0, os_data, os_len);
 891                         break;
 892                 case IH_TYPE_STANDALONE:
 893                         *os_data = image_get_data(hdr);
 894                         *os_len = image_get_data_size(hdr);
 895                         break;
 896                 default:
 897                         printf("Wrong Image Type for %s command\n",
 898                                cmdtp->name);
 899                         bootstage_error(BOOTSTAGE_ID_CHECK_IMAGETYPE);
 900                         return NULL;
 901                 }
 902
 903                 /*
 904                  * copy image header to allow for image overwrites during
 905                  * kernel decompression.
 906                  */
 907                 memmove(&images->legacy_hdr_os_copy, hdr,
 908                         sizeof(image_header_t));
 909
 910                 /* save pointer to image header */
 911                 images->legacy_hdr_os = hdr;
 912
 913                 images->legacy_hdr_valid = 1;
 914                 bootstage_mark(BOOTSTAGE_ID_DECOMP_IMAGE);
 915                 break;
 916 #endif
 917 #if IMAGE_ENABLE_FIT
 918         case IMAGE_FORMAT_FIT:
 919                 os_noffset = fit_image_load(images, img_addr,
 920                                 &fit_uname_kernel, &fit_uname_config,
 921                                 IH_ARCH_DEFAULT, IH_TYPE_KERNEL,
 922                                 BOOTSTAGE_ID_FIT_KERNEL_START,
 923                                 FIT_LOAD_IGNORED, os_data, os_len);
 924                 if (os_noffset < 0)
 925                         return NULL;
 926
 927                 images->fit_hdr_os = map_sysmem(img_addr, 0);
 928                 images->fit_uname_os = fit_uname_kernel;
 929                 images->fit_uname_cfg = fit_uname_config;
 930                 images->fit_noffset_os = os_noffset;
 931                 break;
 932 #endif
 933 #ifdef CONFIG_ANDROID_BOOT_IMAGE
 934         case IMAGE_FORMAT_ANDROID:
 935                 printf("## Booting Android Image at 0x%08lx ...\n", img_addr);
 936                 if (android_image_get_kernel(buf, images->verify,
 937                                              os_data, os_len))
 938                         return NULL;
 939                 break;
 940 #endif
 941         default:
 942                 printf("Wrong Image Format for %s command\n", cmdtp->name);
 943                 bootstage_error(BOOTSTAGE_ID_FIT_KERNEL_INFO);
 944                 return NULL;
 945         }
 946
 947         debug("   kernel data at 0x%08lx, len = 0x%08lx (%ld)\n",
 948               *os_data, *os_len, *os_len);
 949
 950         return buf;
 951 }
 952
 953 /**
 954  * switch_to_non_secure_mode() - switch to non-secure mode
 955  *
 956  * This routine is overridden by architectures requiring this feature.
 957  */
 958 void __weak switch_to_non_secure_mode(void)
 959 {
 960 }
 961
 962 #else /* USE_HOSTCC */
 963
 964 #if defined(CONFIG_FIT_SIGNATURE)
 965 static int bootm_host_load_image(const void *fit, int req_image_type,
 966                                  int cfg_noffset)
 967 {
 968         const char *fit_uname_config = NULL;
 969         ulong data, len;
 970         bootm_headers_t images;
 971         int noffset;
 972         ulong load_end;
 973         uint8_t image_type;
 974         uint8_t imape_comp;
 975         void *load_buf;
 976         int ret;
 977
 978         fit_uname_config = fdt_get_name(fit, cfg_noffset, NULL);
 979         memset(&images, '\0', sizeof(images));
 980         images.verify = 1;
 981         noffset = fit_image_load(&images, (ulong)fit,
 982                 NULL, &fit_uname_config,
 983                 IH_ARCH_DEFAULT, req_image_type, -1,
 984                 FIT_LOAD_IGNORED, &data, &len);
 985         if (noffset < 0)
 986                 return noffset;
 987         if (fit_image_get_type(fit, noffset, &image_type)) {
 988                 puts("Can't get image type!\n");
 989                 return -EINVAL;
 990         }
 991
 992         if (fit_image_get_comp(fit, noffset, &imape_comp)) {
 993                 puts("Can't get image compression!\n");
 994                 return -EINVAL;
 995         }
 996
 997         /* Allow the image to expand by a factor of 4, should be safe */
 998         load_buf = malloc((1 << 20) + len * 4);
 999         ret = image_decomp(imape_comp, 0, data, image_type, load_buf,
1000                            (void *)data, len, CONFIG_SYS_BOOTM_LEN,
1001                            &load_end);
1002         free(load_buf);
1003
1004         if (ret) {
1005                 ret = handle_decomp_error(imape_comp, load_end - 0, ret);
1006                 if (ret != BOOTM_ERR_UNIMPLEMENTED)
1007                         return ret;
1008         }
1009
1010         return 0;
1011 }
1012
1013 int bootm_host_load_images(const void *fit, int cfg_noffset)
1014 {
1015         static uint8_t image_types[] = {
1016                 IH_TYPE_KERNEL,
1017                 IH_TYPE_FLATDT,
1018                 IH_TYPE_RAMDISK,
1019         };
1020         int err = 0;
1021         int i;
1022
1023         for (i = 0; i < ARRAY_SIZE(image_types); i++) {
1024                 int ret;
1025
1026                 ret = bootm_host_load_image(fit, image_types[i], cfg_noffset);
1027                 if (!err && ret && ret != -ENOENT)
1028                         err = ret;
1029         }
1030
1031         /* Return the first error we found */
1032         return err;
1033 }
1034 #endif
1035
1036 #endif /* ndef USE_HOSTCC */