common/spl/spl.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * (C) Copyright 2010
   4  * Texas Instruments, <www.ti.com>
   5  *
   6  * Aneesh V <aneesh@ti.com>
   7  */
   8
   9 #include <common.h>
  10 #include <bloblist.h>
  11 #include <binman_sym.h>
  12 #include <bootstage.h>
  13 #include <dm.h>
  14 #include <handoff.h>
  15 #include <hang.h>
  16 #include <init.h>
  17 #include <irq_func.h>
  18 #include <log.h>
  19 #include <mapmem.h>
  20 #include <serial.h>
  21 #include <spl.h>
  22 #include <system-constants.h>
  23 #include <asm/global_data.h>
  24 #include <asm-generic/gpio.h>
  25 #include <asm/u-boot.h>
  26 #include <nand.h>
  27 #include <fat.h>
  28 #include <u-boot/crc.h>
  29 #if CONFIG_IS_ENABLED(BANNER_PRINT)
  30 #include <timestamp.h>
  31 #endif
  32 #include <version.h>
  33 #include <image.h>
  34 #include <malloc.h>
  35 #include <mapmem.h>
  36 #include <dm/root.h>
  37 #include <dm/util.h>
  38 #include <linux/compiler.h>
  39 #include <fdt_support.h>
  40 #include <bootcount.h>
  41 #include <wdt.h>
  42
  43 DECLARE_GLOBAL_DATA_PTR;
  44 DECLARE_BINMAN_MAGIC_SYM;
  45
  46 #ifndef CONFIG_SYS_UBOOT_START
  47 #define CONFIG_SYS_UBOOT_START  CONFIG_SYS_TEXT_BASE
  48 #endif
  49 #ifndef CONFIG_SYS_MONITOR_LEN
  50 /* Unknown U-Boot size, let's assume it will not be more than 200 KB */
  51 #define CONFIG_SYS_MONITOR_LEN  (200 * 1024)
  52 #endif
  53
  54 u32 *boot_params_ptr = NULL;
  55
  56 #if CONFIG_IS_ENABLED(BINMAN_UBOOT_SYMBOLS)
  57 /* See spl.h for information about this */
  58 binman_sym_declare(ulong, u_boot_any, image_pos);
  59 binman_sym_declare(ulong, u_boot_any, size);
  60
  61 #ifdef CONFIG_TPL
  62 binman_sym_declare(ulong, u_boot_spl, image_pos);
  63 binman_sym_declare(ulong, u_boot_spl, size);
  64 #endif
  65
  66 #ifdef CONFIG_VPL
  67 binman_sym_declare(ulong, u_boot_vpl, image_pos);
  68 binman_sym_declare(ulong, u_boot_vpl, size);
  69 #endif
  70
  71 #endif /* BINMAN_UBOOT_SYMBOLS */
  72
  73 /* Define board data structure */
  74 static struct bd_info bdata __attribute__ ((section(".data")));
  75
  76 #if CONFIG_IS_ENABLED(SHOW_BOOT_PROGRESS)
  77 /*
  78  * Board-specific Platform code can reimplement show_boot_progress () if needed
  79  */
  80 __weak void show_boot_progress(int val) {}
  81 #endif
  82
  83 #if defined(CONFIG_SPL_OS_BOOT) || CONFIG_IS_ENABLED(HANDOFF) || \
  84         defined(CONFIG_SPL_ATF)
  85 /* weak, default platform-specific function to initialize dram banks */
  86 __weak int dram_init_banksize(void)
  87 {
  88         return 0;
  89 }
  90 #endif
  91
  92 /*
  93  * Default function to determine if u-boot or the OS should
  94  * be started. This implementation always returns 1.
  95  *
  96  * Please implement your own board specific funcion to do this.
  97  *
  98  * RETURN
  99  * 0 to not start u-boot
 100  * positive if u-boot should start
 101  */
 102 #if CONFIG_IS_ENABLED(OS_BOOT)
 103 __weak int spl_start_uboot(void)
 104 {
 105         puts(SPL_TPL_PROMPT
 106              "Please implement spl_start_uboot() for your board\n");
 107         puts(SPL_TPL_PROMPT "Direct Linux boot not active!\n");
 108         return 1;
 109 }
 110
 111 /*
 112  * Weak default function for arch specific zImage check. Return zero
 113  * and fill start and end address if image is recognized.
 114  */
 115 int __weak bootz_setup(ulong image, ulong *start, ulong *end)
 116 {
 117          return 1;
 118 }
 119 #endif
 120
 121 /* Weak default function for arch/board-specific fixups to the spl_image_info */
 122 void __weak spl_perform_fixups(struct spl_image_info *spl_image)
 123 {
 124 }
 125
 126 void spl_fixup_fdt(void *fdt_blob)
 127 {
 128 #if defined(CONFIG_SPL_OF_LIBFDT)
 129         int err;
 130
 131         if (!fdt_blob)
 132                 return;
 133
 134         err = fdt_check_header(fdt_blob);
 135         if (err < 0) {
 136                 printf("fdt_root: %s\n", fdt_strerror(err));
 137                 return;
 138         }
 139
 140         /* fixup the memory dt node */
 141         err = fdt_shrink_to_minimum(fdt_blob, 0);
 142         if (err == 0) {
 143                 printf(SPL_TPL_PROMPT "fdt_shrink_to_minimum err - %d\n", err);
 144                 return;
 145         }
 146
 147         err = arch_fixup_fdt(fdt_blob);
 148         if (err) {
 149                 printf(SPL_TPL_PROMPT "arch_fixup_fdt err - %d\n", err);
 150                 return;
 151         }
 152 #endif
 153 }
 154
 155 ulong spl_get_image_pos(void)
 156 {
 157         if (!CONFIG_IS_ENABLED(BINMAN_UBOOT_SYMBOLS))
 158                 return BINMAN_SYM_MISSING;
 159
 160 #ifdef CONFIG_VPL
 161         if (spl_next_phase() == PHASE_VPL)
 162                 return binman_sym(ulong, u_boot_vpl, image_pos);
 163 #endif
 164         return spl_next_phase() == PHASE_SPL ?
 165                 binman_sym(ulong, u_boot_spl, image_pos) :
 166                 binman_sym(ulong, u_boot_any, image_pos);
 167 }
 168
 169 ulong spl_get_image_size(void)
 170 {
 171         if (!CONFIG_IS_ENABLED(BINMAN_UBOOT_SYMBOLS))
 172                 return BINMAN_SYM_MISSING;
 173
 174 #ifdef CONFIG_VPL
 175         if (spl_next_phase() == PHASE_VPL)
 176                 return binman_sym(ulong, u_boot_vpl, size);
 177 #endif
 178         return spl_next_phase() == PHASE_SPL ?
 179                 binman_sym(ulong, u_boot_spl, size) :
 180                 binman_sym(ulong, u_boot_any, size);
 181 }
 182
 183 ulong spl_get_image_text_base(void)
 184 {
 185 #ifdef CONFIG_VPL
 186         if (spl_next_phase() == PHASE_VPL)
 187                 return CONFIG_VPL_TEXT_BASE;
 188 #endif
 189         return spl_next_phase() == PHASE_SPL ? CONFIG_SPL_TEXT_BASE :
 190                 CONFIG_SYS_TEXT_BASE;
 191 }
 192
 193 /*
 194  * Weak default function for board specific cleanup/preparation before
 195  * Linux boot. Some boards/platforms might not need it, so just provide
 196  * an empty stub here.
 197  */
 198 __weak void spl_board_prepare_for_linux(void)
 199 {
 200         /* Nothing to do! */
 201 }
 202
 203 __weak void spl_board_prepare_for_optee(void *fdt)
 204 {
 205 }
 206
 207 __weak const char *spl_board_loader_name(u32 boot_device)
 208 {
 209         return NULL;
 210 }
 211
 212 #if CONFIG_IS_ENABLED(OPTEE_IMAGE)
 213 __weak void __noreturn jump_to_image_optee(struct spl_image_info *spl_image)
 214 {
 215         spl_optee_entry(NULL, NULL, spl_image->fdt_addr,
 216                         (void *)spl_image->entry_point);
 217 }
 218 #endif
 219
 220 __weak void spl_board_prepare_for_boot(void)
 221 {
 222         /* Nothing to do! */
 223 }
 224
 225 __weak struct image_header *spl_get_load_buffer(ssize_t offset, size_t size)
 226 {
 227         return map_sysmem(CONFIG_SYS_TEXT_BASE + offset, 0);
 228 }
 229
 230 void spl_set_header_raw_uboot(struct spl_image_info *spl_image)
 231 {
 232         ulong u_boot_pos = spl_get_image_pos();
 233
 234         spl_image->size = CONFIG_SYS_MONITOR_LEN;
 235
 236         /*
 237          * Binman error cases: address of the end of the previous region or the
 238          * start of the image's entry area (usually 0) if there is no previous
 239          * region.
 240          */
 241         if (u_boot_pos && u_boot_pos != BINMAN_SYM_MISSING) {
 242                 /* Binman does not support separated entry addresses */
 243                 spl_image->entry_point = u_boot_pos;
 244                 spl_image->load_addr = u_boot_pos;
 245         } else {
 246                 spl_image->entry_point = CONFIG_SYS_UBOOT_START;
 247                 spl_image->load_addr = CONFIG_SYS_TEXT_BASE;
 248         }
 249         spl_image->os = IH_OS_U_BOOT;
 250         spl_image->name = "U-Boot";
 251 }
 252
 253 #if CONFIG_IS_ENABLED(LOAD_FIT_FULL)
 254 /* Parse and load full fitImage in SPL */
 255 static int spl_load_fit_image(struct spl_image_info *spl_image,
 256                               const struct image_header *header)
 257 {
 258         bootm_headers_t images;
 259         const char *fit_uname_config = NULL;
 260         uintptr_t fdt_hack;
 261         const char *uname;
 262         ulong fw_data = 0, dt_data = 0, img_data = 0;
 263         ulong fw_len = 0, dt_len = 0, img_len = 0;
 264         int idx, conf_noffset;
 265         int ret;
 266
 267 #ifdef CONFIG_SPL_FIT_SIGNATURE
 268         images.verify = 1;
 269 #endif
 270         ret = fit_image_load(&images, (ulong)header,
 271                              NULL, &fit_uname_config,
 272                              IH_ARCH_DEFAULT, IH_TYPE_STANDALONE, -1,
 273                              FIT_LOAD_OPTIONAL, &fw_data, &fw_len);
 274         if (ret >= 0) {
 275                 printf("DEPRECATED: 'standalone = ' property.");
 276                 printf("Please use either 'firmware =' or 'kernel ='\n");
 277         } else {
 278                 ret = fit_image_load(&images, (ulong)header, NULL,
 279                                      &fit_uname_config, IH_ARCH_DEFAULT,
 280                                      IH_TYPE_FIRMWARE, -1, FIT_LOAD_OPTIONAL,
 281                                      &fw_data, &fw_len);
 282         }
 283
 284         if (ret < 0) {
 285                 ret = fit_image_load(&images, (ulong)header, NULL,
 286                                      &fit_uname_config, IH_ARCH_DEFAULT,
 287                                      IH_TYPE_KERNEL, -1, FIT_LOAD_OPTIONAL,
 288                                      &fw_data, &fw_len);
 289         }
 290
 291         if (ret < 0)
 292                 return ret;
 293
 294         spl_image->size = fw_len;
 295         spl_image->entry_point = fw_data;
 296         spl_image->load_addr = fw_data;
 297         if (fit_image_get_os(header, ret, &spl_image->os))
 298                 spl_image->os = IH_OS_INVALID;
 299         spl_image->name = genimg_get_os_name(spl_image->os);
 300
 301         debug(SPL_TPL_PROMPT "payload image: %32s load addr: 0x%lx size: %d\n",
 302               spl_image->name, spl_image->load_addr, spl_image->size);
 303
 304 #ifdef CONFIG_SPL_FIT_SIGNATURE
 305         images.verify = 1;
 306 #endif
 307         ret = fit_image_load(&images, (ulong)header, NULL, &fit_uname_config,
 308                        IH_ARCH_DEFAULT, IH_TYPE_FLATDT, -1,
 309                        FIT_LOAD_OPTIONAL, &dt_data, &dt_len);
 310         if (ret >= 0) {
 311                 spl_image->fdt_addr = (void *)dt_data;
 312
 313                 if (spl_image->os == IH_OS_U_BOOT) {
 314                         /* HACK: U-boot expects FDT at a specific address */
 315                         fdt_hack = spl_image->load_addr + spl_image->size;
 316                         fdt_hack = (fdt_hack + 3) & ~3;
 317                         debug("Relocating FDT to %p\n", spl_image->fdt_addr);
 318                         memcpy((void *)fdt_hack, spl_image->fdt_addr, dt_len);
 319                 }
 320         }
 321
 322         conf_noffset = fit_conf_get_node((const void *)header,
 323                                          fit_uname_config);
 324         if (conf_noffset <= 0)
 325                 return 0;
 326
 327         for (idx = 0;
 328              uname = fdt_stringlist_get((const void *)header, conf_noffset,
 329                                         FIT_LOADABLE_PROP, idx,
 330                                 NULL), uname;
 331              idx++)
 332         {
 333 #ifdef CONFIG_SPL_FIT_SIGNATURE
 334                 images.verify = 1;
 335 #endif
 336                 ret = fit_image_load(&images, (ulong)header,
 337                                      &uname, &fit_uname_config,
 338                                      IH_ARCH_DEFAULT, IH_TYPE_LOADABLE, -1,
 339                                      FIT_LOAD_OPTIONAL_NON_ZERO,
 340                                      &img_data, &img_len);
 341                 if (ret < 0)
 342                         return ret;
 343         }
 344
 345         return 0;
 346 }
 347 #endif
 348
 349 __weak int spl_parse_board_header(struct spl_image_info *spl_image,
 350                                   const struct spl_boot_device *bootdev,
 351                                   const void *image_header, size_t size)
 352 {
 353         return -EINVAL;
 354 }
 355
 356 __weak int spl_parse_legacy_header(struct spl_image_info *spl_image,
 357                                    const struct image_header *header)
 358 {
 359         /* LEGACY image not supported */
 360         debug("Legacy boot image support not enabled, proceeding to other boot methods\n");
 361         return -EINVAL;
 362 }
 363
 364 int spl_parse_image_header(struct spl_image_info *spl_image,
 365                            const struct spl_boot_device *bootdev,
 366                            const struct image_header *header)
 367 {
 368 #if CONFIG_IS_ENABLED(LOAD_FIT_FULL)
 369         int ret = spl_load_fit_image(spl_image, header);
 370
 371         if (!ret)
 372                 return ret;
 373 #endif
 374         if (image_get_magic(header) == IH_MAGIC) {
 375                 int ret;
 376
 377                 ret = spl_parse_legacy_header(spl_image, header);
 378                 if (ret)
 379                         return ret;
 380         } else {
 381 #ifdef CONFIG_SPL_PANIC_ON_RAW_IMAGE
 382                 /*
 383                  * CONFIG_SPL_PANIC_ON_RAW_IMAGE is defined when the
 384                  * code which loads images in SPL cannot guarantee that
 385                  * absolutely all read errors will be reported.
 386                  * An example is the LPC32XX MLC NAND driver, which
 387                  * will consider that a completely unreadable NAND block
 388                  * is bad, and thus should be skipped silently.
 389                  */
 390                 panic("** no mkimage signature but raw image not supported");
 391 #endif
 392
 393 #if CONFIG_IS_ENABLED(OS_BOOT)
 394                 ulong start, end;
 395
 396                 if (!bootz_setup((ulong)header, &start, &end)) {
 397                         spl_image->name = "Linux";
 398                         spl_image->os = IH_OS_LINUX;
 399                         spl_image->load_addr = CONFIG_SYS_LOAD_ADDR;
 400                         spl_image->entry_point = CONFIG_SYS_LOAD_ADDR;
 401                         spl_image->size = end - start;
 402                         debug(SPL_TPL_PROMPT
 403                               "payload zImage, load addr: 0x%lx size: %d\n",
 404                               spl_image->load_addr, spl_image->size);
 405                         return 0;
 406                 }
 407 #endif
 408
 409                 if (!spl_parse_board_header(spl_image, bootdev, (const void *)header, sizeof(*header)))
 410                         return 0;
 411
 412 #ifdef CONFIG_SPL_RAW_IMAGE_SUPPORT
 413                 /* Signature not found - assume u-boot.bin */
 414                 debug("mkimage signature not found - ih_magic = %x\n",
 415                         header->ih_magic);
 416                 spl_set_header_raw_uboot(spl_image);
 417 #else
 418                 /* RAW image not supported, proceed to other boot methods. */
 419                 debug("Raw boot image support not enabled, proceeding to other boot methods\n");
 420                 return -EINVAL;
 421 #endif
 422         }
 423
 424         return 0;
 425 }
 426
 427 __weak void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image)
 428 {
 429         typedef void __noreturn (*image_entry_noargs_t)(void);
 430
 431         image_entry_noargs_t image_entry =
 432                 (image_entry_noargs_t)spl_image->entry_point;
 433
 434         debug("image entry point: 0x%lx\n", spl_image->entry_point);
 435         image_entry();
 436 }
 437
 438 #if CONFIG_IS_ENABLED(HANDOFF)
 439 /**
 440  * Set up the SPL hand-off information
 441  *
 442  * This is initially empty (zero) but can be written by
 443  */
 444 static int setup_spl_handoff(void)
 445 {
 446         struct spl_handoff *ho;
 447
 448         ho = bloblist_ensure(BLOBLISTT_U_BOOT_SPL_HANDOFF, sizeof(struct spl_handoff));
 449         if (!ho)
 450                 return -ENOENT;
 451
 452         return 0;
 453 }
 454
 455 __weak int handoff_arch_save(struct spl_handoff *ho)
 456 {
 457         return 0;
 458 }
 459
 460 static int write_spl_handoff(void)
 461 {
 462         struct spl_handoff *ho;
 463         int ret;
 464
 465         ho = bloblist_find(BLOBLISTT_U_BOOT_SPL_HANDOFF, sizeof(struct spl_handoff));
 466         if (!ho)
 467                 return -ENOENT;
 468         handoff_save_dram(ho);
 469         ret = handoff_arch_save(ho);
 470         if (ret)
 471                 return ret;
 472         debug(SPL_TPL_PROMPT "Wrote SPL handoff\n");
 473
 474         return 0;
 475 }
 476 #else
 477 static inline int setup_spl_handoff(void) { return 0; }
 478 static inline int write_spl_handoff(void) { return 0; }
 479
 480 #endif /* HANDOFF */
 481
 482 /**
 483  * get_bootstage_id() - Get the bootstage ID to emit
 484  *
 485  * @start: true if this is for starting SPL, false for ending it
 486  * Return: bootstage ID to use
 487  */
 488 static enum bootstage_id get_bootstage_id(bool start)
 489 {
 490         enum u_boot_phase phase = spl_phase();
 491
 492         if (IS_ENABLED(CONFIG_TPL_BUILD) && phase == PHASE_TPL)
 493                 return start ? BOOTSTAGE_ID_START_TPL : BOOTSTAGE_ID_END_TPL;
 494         else if (IS_ENABLED(CONFIG_VPL_BUILD) && phase == PHASE_VPL)
 495                 return start ? BOOTSTAGE_ID_START_VPL : BOOTSTAGE_ID_END_VPL;
 496         else
 497                 return start ? BOOTSTAGE_ID_START_SPL : BOOTSTAGE_ID_END_SPL;
 498 }
 499
 500 static int spl_common_init(bool setup_malloc)
 501 {
 502         int ret;
 503
 504 #if CONFIG_VAL(SYS_MALLOC_F_LEN)
 505         if (setup_malloc) {
 506 #ifdef CONFIG_MALLOC_F_ADDR
 507                 gd->malloc_base = CONFIG_MALLOC_F_ADDR;
 508 #endif
 509                 gd->malloc_limit = CONFIG_VAL(SYS_MALLOC_F_LEN);
 510                 gd->malloc_ptr = 0;
 511         }
 512 #endif
 513         ret = bootstage_init(u_boot_first_phase());
 514         if (ret) {
 515                 debug("%s: Failed to set up bootstage: ret=%d\n", __func__,
 516                       ret);
 517                 return ret;
 518         }
 519 #ifdef CONFIG_BOOTSTAGE_STASH
 520         if (!u_boot_first_phase()) {
 521                 const void *stash = map_sysmem(CONFIG_BOOTSTAGE_STASH_ADDR,
 522                                                CONFIG_BOOTSTAGE_STASH_SIZE);
 523
 524                 ret = bootstage_unstash(stash, CONFIG_BOOTSTAGE_STASH_SIZE);
 525                 if (ret)
 526                         debug("%s: Failed to unstash bootstage: ret=%d\n",
 527                               __func__, ret);
 528         }
 529 #endif /* CONFIG_BOOTSTAGE_STASH */
 530         bootstage_mark_name(get_bootstage_id(true),
 531                             spl_phase_name(spl_phase()));
 532 #if CONFIG_IS_ENABLED(LOG)
 533         ret = log_init();
 534         if (ret) {
 535                 debug("%s: Failed to set up logging\n", __func__);
 536                 return ret;
 537         }
 538 #endif
 539         if (CONFIG_IS_ENABLED(OF_REAL)) {
 540                 ret = fdtdec_setup();
 541                 if (ret) {
 542                         debug("fdtdec_setup() returned error %d\n", ret);
 543                         return ret;
 544                 }
 545         }
 546         if (CONFIG_IS_ENABLED(DM)) {
 547                 bootstage_start(BOOTSTAGE_ID_ACCUM_DM_SPL,
 548                                 spl_phase() == PHASE_TPL ? "dm tpl" : "dm_spl");
 549                 /* With CONFIG_SPL_OF_PLATDATA, bring in all devices */
 550                 ret = dm_init_and_scan(!CONFIG_IS_ENABLED(OF_PLATDATA));
 551                 bootstage_accum(BOOTSTAGE_ID_ACCUM_DM_SPL);
 552                 if (ret) {
 553                         debug("dm_init_and_scan() returned error %d\n", ret);
 554                         return ret;
 555                 }
 556         }
 557
 558         return 0;
 559 }
 560
 561 void spl_set_bd(void)
 562 {
 563         /*
 564          * NOTE: On some platforms (e.g. x86) bdata may be in flash and not
 565          * writeable.
 566          */
 567         if (!gd->bd)
 568                 gd->bd = &bdata;
 569 }
 570
 571 int spl_early_init(void)
 572 {
 573         int ret;
 574
 575         debug("%s\n", __func__);
 576
 577         ret = spl_common_init(true);
 578         if (ret)
 579                 return ret;
 580         gd->flags |= GD_FLG_SPL_EARLY_INIT;
 581
 582         return 0;
 583 }
 584
 585 int spl_init(void)
 586 {
 587         int ret;
 588         bool setup_malloc = !(IS_ENABLED(CONFIG_SPL_STACK_R) &&
 589                         IS_ENABLED(CONFIG_SPL_SYS_MALLOC_SIMPLE));
 590
 591         debug("%s\n", __func__);
 592
 593         if (!(gd->flags & GD_FLG_SPL_EARLY_INIT)) {
 594                 ret = spl_common_init(setup_malloc);
 595                 if (ret)
 596                         return ret;
 597         }
 598         gd->flags |= GD_FLG_SPL_INIT;
 599
 600         return 0;
 601 }
 602
 603 #ifndef BOOT_DEVICE_NONE
 604 #define BOOT_DEVICE_NONE 0xdeadbeef
 605 #endif
 606
 607 __weak void board_boot_order(u32 *spl_boot_list)
 608 {
 609         spl_boot_list[0] = spl_boot_device();
 610 }
 611
 612 static struct spl_image_loader *spl_ll_find_loader(uint boot_device)
 613 {
 614         struct spl_image_loader *drv =
 615                 ll_entry_start(struct spl_image_loader, spl_image_loader);
 616         const int n_ents =
 617                 ll_entry_count(struct spl_image_loader, spl_image_loader);
 618         struct spl_image_loader *entry;
 619
 620         for (entry = drv; entry != drv + n_ents; entry++) {
 621                 if (boot_device == entry->boot_device)
 622                         return entry;
 623         }
 624
 625         /* Not found */
 626         return NULL;
 627 }
 628
 629 __weak int spl_check_board_image(struct spl_image_info *spl_image,
 630                                  const struct spl_boot_device *bootdev)
 631 {
 632         return 0;
 633 }
 634
 635 static int spl_load_image(struct spl_image_info *spl_image,
 636                           struct spl_image_loader *loader)
 637 {
 638         int ret;
 639         struct spl_boot_device bootdev;
 640
 641         bootdev.boot_device = loader->boot_device;
 642         bootdev.boot_device_name = NULL;
 643
 644         ret = loader->load_image(spl_image, &bootdev);
 645 #ifdef CONFIG_SPL_LEGACY_IMAGE_CRC_CHECK
 646         if (!ret && spl_image->dcrc_length) {
 647                 /* check data crc */
 648                 ulong dcrc = crc32_wd(0, (unsigned char *)spl_image->dcrc_data,
 649                                       spl_image->dcrc_length, CHUNKSZ_CRC32);
 650                 if (dcrc != spl_image->dcrc) {
 651                         puts("SPL: Image data CRC check failed!\n");
 652                         ret = -EINVAL;
 653                 }
 654         }
 655 #endif
 656         if (!ret)
 657                 ret = spl_check_board_image(spl_image, &bootdev);
 658
 659         return ret;
 660 }
 661
 662 /**
 663  * boot_from_devices() - Try loading a booting U-Boot from a list of devices
 664  *
 665  * @spl_image: Place to put the image details if successful
 666  * @spl_boot_list: List of boot devices to try
 667  * @count: Number of elements in spl_boot_list
 668  * Return: 0 if OK, -ENODEV if there were no boot devices
 669  *      if CONFIG_SHOW_ERRORS is enabled, returns -ENXIO if there were
 670  *      devices but none worked
 671  */
 672 static int boot_from_devices(struct spl_image_info *spl_image,
 673                              u32 spl_boot_list[], int count)
 674 {
 675         int ret = -ENODEV;
 676         int i;
 677
 678         for (i = 0; i < count && spl_boot_list[i] != BOOT_DEVICE_NONE; i++) {
 679                 struct spl_image_loader *loader;
 680                 int bootdev = spl_boot_list[i];
 681
 682                 if (CONFIG_IS_ENABLED(SHOW_ERRORS))
 683                         ret = -ENXIO;
 684                 loader = spl_ll_find_loader(bootdev);
 685                 if (CONFIG_IS_ENABLED(SERIAL) &&
 686                     CONFIG_IS_ENABLED(LIBCOMMON_SUPPORT) &&
 687                     !IS_ENABLED(CONFIG_SILENT_CONSOLE)) {
 688                         if (loader)
 689                                 printf("Trying to boot from %s\n",
 690                                        spl_loader_name(loader));
 691                         else if (CONFIG_IS_ENABLED(SHOW_ERRORS))
 692                                 printf(SPL_TPL_PROMPT
 693                                        "Unsupported Boot Device %d\n", bootdev);
 694                         else
 695                                 puts(SPL_TPL_PROMPT "Unsupported Boot Device!\n");
 696                 }
 697                 if (loader && !spl_load_image(spl_image, loader)) {
 698                         spl_image->boot_device = bootdev;
 699                         return 0;
 700                 }
 701         }
 702
 703         return ret;
 704 }
 705
 706 #if defined(CONFIG_SPL_FRAMEWORK_BOARD_INIT_F)
 707 void board_init_f(ulong dummy)
 708 {
 709         if (CONFIG_IS_ENABLED(OF_CONTROL)) {
 710                 int ret;
 711
 712                 ret = spl_early_init();
 713                 if (ret) {
 714                         debug("spl_early_init() failed: %d\n", ret);
 715                         hang();
 716                 }
 717         }
 718
 719         preloader_console_init();
 720 }
 721 #endif
 722
 723 void board_init_r(gd_t *dummy1, ulong dummy2)
 724 {
 725         u32 spl_boot_list[] = {
 726                 BOOT_DEVICE_NONE,
 727                 BOOT_DEVICE_NONE,
 728                 BOOT_DEVICE_NONE,
 729                 BOOT_DEVICE_NONE,
 730                 BOOT_DEVICE_NONE,
 731         };
 732         struct spl_image_info spl_image;
 733         int ret;
 734
 735         debug(">>" SPL_TPL_PROMPT "board_init_r()\n");
 736
 737         spl_set_bd();
 738
 739 #if defined(CONFIG_SYS_SPL_MALLOC)
 740         mem_malloc_init(SYS_SPL_MALLOC_START, CONFIG_SYS_SPL_MALLOC_SIZE);
 741         gd->flags |= GD_FLG_FULL_MALLOC_INIT;
 742 #endif
 743         if (!(gd->flags & GD_FLG_SPL_INIT)) {
 744                 if (spl_init())
 745                         hang();
 746         }
 747 #if !defined(CONFIG_PPC) && !defined(CONFIG_ARCH_MX6)
 748         /*
 749          * timer_init() does not exist on PPC systems. The timer is initialized
 750          * and enabled (decrementer) in interrupt_init() here.
 751          */
 752         timer_init();
 753 #endif
 754         if (CONFIG_IS_ENABLED(BLOBLIST)) {
 755                 ret = bloblist_init();
 756                 if (ret) {
 757                         debug("%s: Failed to set up bloblist: ret=%d\n",
 758                               __func__, ret);
 759                         puts(SPL_TPL_PROMPT "Cannot set up bloblist\n");
 760                         hang();
 761                 }
 762         }
 763         if (CONFIG_IS_ENABLED(HANDOFF)) {
 764                 int ret;
 765
 766                 ret = setup_spl_handoff();
 767                 if (ret) {
 768                         puts(SPL_TPL_PROMPT "Cannot set up SPL handoff\n");
 769                         hang();
 770                 }
 771         }
 772
 773         if (CONFIG_IS_ENABLED(GPIO_HOG))
 774                 gpio_hog_probe_all();
 775
 776 #if CONFIG_IS_ENABLED(BOARD_INIT)
 777         spl_board_init();
 778 #endif
 779
 780 #if defined(CONFIG_SPL_WATCHDOG) && CONFIG_IS_ENABLED(WDT)
 781         initr_watchdog();
 782 #endif
 783
 784         if (IS_ENABLED(CONFIG_SPL_OS_BOOT) || CONFIG_IS_ENABLED(HANDOFF) ||
 785             IS_ENABLED(CONFIG_SPL_ATF))
 786                 dram_init_banksize();
 787
 788         bootcount_inc();
 789
 790         /* Dump driver model states to aid analysis */
 791         if (CONFIG_IS_ENABLED(DM_STATS)) {
 792                 struct dm_stats mem;
 793
 794                 dm_get_mem(&mem);
 795                 dm_dump_mem(&mem);
 796         }
 797
 798         memset(&spl_image, '\0', sizeof(spl_image));
 799 #ifdef CONFIG_SYS_SPL_ARGS_ADDR
 800         spl_image.arg = (void *)CONFIG_SYS_SPL_ARGS_ADDR;
 801 #endif
 802         spl_image.boot_device = BOOT_DEVICE_NONE;
 803         board_boot_order(spl_boot_list);
 804
 805         ret = boot_from_devices(&spl_image, spl_boot_list,
 806                                 ARRAY_SIZE(spl_boot_list));
 807         if (ret) {
 808                 if (CONFIG_IS_ENABLED(SHOW_ERRORS) &&
 809                     CONFIG_IS_ENABLED(LIBCOMMON_SUPPORT))
 810                         printf(SPL_TPL_PROMPT "failed to boot from all boot devices (err=%d)\n",
 811                                ret);
 812                 else
 813                         puts(SPL_TPL_PROMPT "failed to boot from all boot devices\n");
 814                 hang();
 815         }
 816
 817         spl_perform_fixups(&spl_image);
 818         if (CONFIG_IS_ENABLED(HANDOFF)) {
 819                 ret = write_spl_handoff();
 820                 if (ret)
 821                         printf(SPL_TPL_PROMPT
 822                                "SPL hand-off write failed (err=%d)\n", ret);
 823         }
 824         if (CONFIG_IS_ENABLED(BLOBLIST)) {
 825                 ret = bloblist_finish();
 826                 if (ret)
 827                         printf("Warning: Failed to finish bloblist (ret=%d)\n",
 828                                ret);
 829         }
 830
 831         switch (spl_image.os) {
 832         case IH_OS_U_BOOT:
 833                 debug("Jumping to %s...\n", spl_phase_name(spl_next_phase()));
 834                 break;
 835 #if CONFIG_IS_ENABLED(ATF)
 836         case IH_OS_ARM_TRUSTED_FIRMWARE:
 837                 debug("Jumping to U-Boot via ARM Trusted Firmware\n");
 838                 spl_fixup_fdt(spl_image.fdt_addr);
 839                 spl_invoke_atf(&spl_image);
 840                 break;
 841 #endif
 842 #if CONFIG_IS_ENABLED(OPTEE_IMAGE)
 843         case IH_OS_TEE:
 844                 debug("Jumping to U-Boot via OP-TEE\n");
 845                 spl_board_prepare_for_optee(spl_image.fdt_addr);
 846                 jump_to_image_optee(&spl_image);
 847                 break;
 848 #endif
 849 #if CONFIG_IS_ENABLED(OPENSBI)
 850         case IH_OS_OPENSBI:
 851                 debug("Jumping to U-Boot via RISC-V OpenSBI\n");
 852                 spl_invoke_opensbi(&spl_image);
 853                 break;
 854 #endif
 855 #if CONFIG_IS_ENABLED(OS_BOOT)
 856         case IH_OS_LINUX:
 857                 debug("Jumping to Linux\n");
 858 #if defined(CONFIG_SYS_SPL_ARGS_ADDR)
 859                 spl_fixup_fdt((void *)CONFIG_SYS_SPL_ARGS_ADDR);
 860 #endif
 861                 spl_board_prepare_for_linux();
 862                 jump_to_image_linux(&spl_image);
 863 #endif
 864         default:
 865                 debug("Unsupported OS image.. Jumping nevertheless..\n");
 866         }
 867 #if CONFIG_VAL(SYS_MALLOC_F_LEN) && !defined(CONFIG_SYS_SPL_MALLOC_SIZE)
 868         debug("SPL malloc() used 0x%lx bytes (%ld KB)\n", gd->malloc_ptr,
 869               gd->malloc_ptr / 1024);
 870 #endif
 871         bootstage_mark_name(get_bootstage_id(false), "end phase");
 872 #ifdef CONFIG_BOOTSTAGE_STASH
 873         ret = bootstage_stash((void *)CONFIG_BOOTSTAGE_STASH_ADDR,
 874                               CONFIG_BOOTSTAGE_STASH_SIZE);
 875         if (ret)
 876                 debug("Failed to stash bootstage: err=%d\n", ret);
 877 #endif
 878
 879         spl_board_prepare_for_boot();
 880         jump_to_image_no_args(&spl_image);
 881 }
 882
 883 /*
 884  * This requires UART clocks to be enabled.  In order for this to work the
 885  * caller must ensure that the gd pointer is valid.
 886  */
 887 void preloader_console_init(void)
 888 {
 889 #ifdef CONFIG_SPL_SERIAL
 890         gd->baudrate = CONFIG_BAUDRATE;
 891
 892         serial_init();          /* serial communications setup */
 893
 894         gd->have_console = 1;
 895
 896 #if CONFIG_IS_ENABLED(BANNER_PRINT)
 897         puts("\nU-Boot " SPL_TPL_NAME " " PLAIN_VERSION " (" U_BOOT_DATE " - "
 898              U_BOOT_TIME " " U_BOOT_TZ ")\n");
 899 #endif
 900 #ifdef CONFIG_SPL_DISPLAY_PRINT
 901         spl_display_print();
 902 #endif
 903 #endif
 904 }
 905
 906 /**
 907  * This function is called before the stack is changed from initial stack to
 908  * relocated stack. It tries to dump the stack size used
 909  */
 910 __weak void spl_relocate_stack_check(void)
 911 {
 912 #if CONFIG_IS_ENABLED(SYS_REPORT_STACK_F_USAGE)
 913         ulong init_sp = gd->start_addr_sp;
 914         ulong stack_bottom = init_sp - CONFIG_VAL(SIZE_LIMIT_PROVIDE_STACK);
 915         u8 *ptr = (u8 *)stack_bottom;
 916         ulong i;
 917
 918         for (i = 0; i < CONFIG_VAL(SIZE_LIMIT_PROVIDE_STACK); i++) {
 919                 if (*ptr != CONFIG_VAL(SYS_STACK_F_CHECK_BYTE))
 920                         break;
 921                 ptr++;
 922         }
 923         printf("SPL initial stack usage: %lu bytes\n",
 924                CONFIG_VAL(SIZE_LIMIT_PROVIDE_STACK) - i);
 925 #endif
 926 }
 927
 928 /**
 929  * spl_relocate_stack_gd() - Relocate stack ready for board_init_r() execution
 930  *
 931  * Sometimes board_init_f() runs with a stack in SRAM but we want to use SDRAM
 932  * for the main board_init_r() execution. This is typically because we need
 933  * more stack space for things like the MMC sub-system.
 934  *
 935  * This function calculates the stack position, copies the global_data into
 936  * place, sets the new gd (except for ARM, for which setting GD within a C
 937  * function may not always work) and returns the new stack position. The
 938  * caller is responsible for setting up the sp register and, in the case
 939  * of ARM, setting up gd.
 940  *
 941  * All of this is done using the same layout and alignments as done in
 942  * board_init_f_init_reserve() / board_init_f_alloc_reserve().
 943  *
 944  * Return: new stack location, or 0 to use the same stack
 945  */
 946 ulong spl_relocate_stack_gd(void)
 947 {
 948 #ifdef CONFIG_SPL_STACK_R
 949         gd_t *new_gd;
 950         ulong ptr = CONFIG_SPL_STACK_R_ADDR;
 951
 952         if (CONFIG_IS_ENABLED(SYS_REPORT_STACK_F_USAGE))
 953                 spl_relocate_stack_check();
 954
 955 #if defined(CONFIG_SPL_SYS_MALLOC_SIMPLE) && CONFIG_VAL(SYS_MALLOC_F_LEN)
 956         if (CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN) {
 957                 debug("SPL malloc() before relocation used 0x%lx bytes (%ld KB)\n",
 958                       gd->malloc_ptr, gd->malloc_ptr / 1024);
 959                 ptr -= CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN;
 960                 gd->malloc_base = ptr;
 961                 gd->malloc_limit = CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN;
 962                 gd->malloc_ptr = 0;
 963         }
 964 #endif
 965         /* Get stack position: use 8-byte alignment for ABI compliance */
 966         ptr = CONFIG_SPL_STACK_R_ADDR - roundup(sizeof(gd_t),16);
 967         new_gd = (gd_t *)ptr;
 968         memcpy(new_gd, (void *)gd, sizeof(gd_t));
 969 #if CONFIG_IS_ENABLED(DM)
 970         dm_fixup_for_gd_move(new_gd);
 971 #endif
 972 #if !defined(CONFIG_ARM) && !defined(CONFIG_RISCV)
 973         gd = new_gd;
 974 #endif
 975         return ptr;
 976 #else
 977         return 0;
 978 #endif
 979 }
 980
 981 #if defined(CONFIG_BOOTCOUNT_LIMIT) && \
 982         ((!defined(CONFIG_TPL_BUILD) && !defined(CONFIG_SPL_BOOTCOUNT_LIMIT)) || \
 983          (defined(CONFIG_TPL_BUILD) && !defined(CONFIG_TPL_BOOTCOUNT_LIMIT)))
 984 void bootcount_store(ulong a)
 985 {
 986 }
 987
 988 ulong bootcount_load(void)
 989 {
 990         return 0;
 991 }
 992 #endif