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