boot/bootm.c

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