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