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