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