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-generic/gpio.h>
  24 #include <asm/u-boot.h>
  25 #include <nand.h>
  26 #include <fat.h>
  27 #include <u-boot/crc.h>
  28 #if CONFIG_IS_ENABLED(BANNER_PRINT)
  29 #include <timestamp.h>
  30 #endif
  31 #include <version.h>
  32 #include <image.h>
  33 #include <malloc.h>
  34 #include <mapmem.h>
  35 #include <dm/root.h>
  36 #include <linux/compiler.h>
  37 #include <fdt_support.h>
  38 #include <bootcount.h>
  39 #include <wdt.h>
  40
  41 DECLARE_GLOBAL_DATA_PTR;
  42
  43 #ifndef CONFIG_SYS_UBOOT_START
  44 #define CONFIG_SYS_UBOOT_START  CONFIG_SYS_TEXT_BASE
  45 #endif
  46 #ifndef CONFIG_SYS_MONITOR_LEN
  47 /* Unknown U-Boot size, let's assume it will not be more than 200 KB */
  48 #define CONFIG_SYS_MONITOR_LEN  (200 * 1024)
  49 #endif
  50
  51 u32 *boot_params_ptr = NULL;
  52
  53 #if CONFIG_IS_ENABLED(BINMAN_SYMBOLS)
  54 /* See spl.h for information about this */
  55 binman_sym_declare(ulong, u_boot_any, image_pos);
  56 binman_sym_declare(ulong, u_boot_any, size);
  57 #endif
  58
  59 #ifdef CONFIG_TPL
  60 binman_sym_declare(ulong, u_boot_spl, image_pos);
  61 binman_sym_declare(ulong, u_boot_spl, size);
  62 #endif
  63
  64 #ifdef CONFIG_VPL
  65 binman_sym_declare(ulong, u_boot_vpl, image_pos);
  66 binman_sym_declare(ulong, u_boot_vpl, size);
  67 #endif
  68
  69 /* Define board data structure */
  70 static struct bd_info bdata __attribute__ ((section(".data")));
  71
  72 #if CONFIG_IS_ENABLED(SHOW_BOOT_PROGRESS)
  73 /*
  74  * Board-specific Platform code can reimplement show_boot_progress () if needed
  75  */
  76 __weak void show_boot_progress(int val) {}
  77 #endif
  78
  79 #if defined(CONFIG_SPL_OS_BOOT) || CONFIG_IS_ENABLED(HANDOFF) || \
  80         defined(CONFIG_SPL_ATF)
  81 /* weak, default platform-specific function to initialize dram banks */
  82 __weak int dram_init_banksize(void)
  83 {
  84         return 0;
  85 }
  86 #endif
  87
  88 /*
  89  * Default function to determine if u-boot or the OS should
  90  * be started. This implementation always returns 1.
  91  *
  92  * Please implement your own board specific funcion to do this.
  93  *
  94  * RETURN
  95  * 0 to not start u-boot
  96  * positive if u-boot should start
  97  */
  98 #if CONFIG_IS_ENABLED(OS_BOOT)
  99 __weak int spl_start_uboot(void)
 100 {
 101         puts(SPL_TPL_PROMPT
 102              "Please implement spl_start_uboot() for your board\n");
 103         puts(SPL_TPL_PROMPT "Direct Linux boot not active!\n");
 104         return 1;
 105 }
 106
 107 /*
 108  * Weak default function for arch specific zImage check. Return zero
 109  * and fill start and end address if image is recognized.
 110  */
 111 int __weak bootz_setup(ulong image, ulong *start, ulong *end)
 112 {
 113          return 1;
 114 }
 115 #endif
 116
 117 /* Weak default function for arch/board-specific fixups to the spl_image_info */
 118 void __weak spl_perform_fixups(struct spl_image_info *spl_image)
 119 {
 120 }
 121
 122 void spl_fixup_fdt(void *fdt_blob)
 123 {
 124 #if defined(CONFIG_SPL_OF_LIBFDT)
 125         int err;
 126
 127         if (!fdt_blob)
 128                 return;
 129
 130         err = fdt_check_header(fdt_blob);
 131         if (err < 0) {
 132                 printf("fdt_root: %s\n", fdt_strerror(err));
 133                 return;
 134         }
 135
 136         /* fixup the memory dt node */
 137         err = fdt_shrink_to_minimum(fdt_blob, 0);
 138         if (err == 0) {
 139                 printf(SPL_TPL_PROMPT "fdt_shrink_to_minimum err - %d\n", err);
 140                 return;
 141         }
 142
 143         err = arch_fixup_fdt(fdt_blob);
 144         if (err) {
 145                 printf(SPL_TPL_PROMPT "arch_fixup_fdt err - %d\n", err);
 146                 return;
 147         }
 148 #endif
 149 }
 150
 151 #if CONFIG_IS_ENABLED(BINMAN_SYMBOLS)
 152 ulong spl_get_image_pos(void)
 153 {
 154 #ifdef CONFIG_VPL
 155         if (spl_next_phase() == PHASE_VPL)
 156                 return binman_sym(ulong, u_boot_vpl, image_pos);
 157 #endif
 158         return spl_next_phase() == PHASE_SPL ?
 159                 binman_sym(ulong, u_boot_spl, image_pos) :
 160                 binman_sym(ulong, u_boot_any, image_pos);
 161 }
 162
 163 ulong spl_get_image_size(void)
 164 {
 165 #ifdef CONFIG_VPL
 166         if (spl_next_phase() == PHASE_VPL)
 167                 return binman_sym(ulong, u_boot_vpl, size);
 168 #endif
 169         return spl_next_phase() == PHASE_SPL ?
 170                 binman_sym(ulong, u_boot_spl, size) :
 171                 binman_sym(ulong, u_boot_any, size);
 172 }
 173 #endif /* BINMAN_SYMBOLS */
 174
 175 ulong spl_get_image_text_base(void)
 176 {
 177 #ifdef CONFIG_VPL
 178         if (spl_next_phase() == PHASE_VPL)
 179                 return CONFIG_VPL_TEXT_BASE;
 180 #endif
 181         return spl_next_phase() == PHASE_SPL ? CONFIG_SPL_TEXT_BASE :
 182                 CONFIG_SYS_TEXT_BASE;
 183 }
 184
 185 /*
 186  * Weak default function for board specific cleanup/preparation before
 187  * Linux boot. Some boards/platforms might not need it, so just provide
 188  * an empty stub here.
 189  */
 190 __weak void spl_board_prepare_for_linux(void)
 191 {
 192         /* Nothing to do! */
 193 }
 194
 195 __weak void spl_board_prepare_for_optee(void *fdt)
 196 {
 197 }
 198
 199 __weak const char *spl_board_loader_name(u32 boot_device)
 200 {
 201         return NULL;
 202 }
 203
 204 #if CONFIG_IS_ENABLED(OPTEE_IMAGE)
 205 __weak void __noreturn jump_to_image_optee(struct spl_image_info *spl_image)
 206 {
 207         spl_optee_entry(NULL, NULL, spl_image->fdt_addr,
 208                         (void *)spl_image->entry_point);
 209 }
 210 #endif
 211
 212 __weak void spl_board_prepare_for_boot(void)
 213 {
 214         /* Nothing to do! */
 215 }
 216
 217 __weak struct image_header *spl_get_load_buffer(ssize_t offset, size_t size)
 218 {
 219         return map_sysmem(CONFIG_SYS_TEXT_BASE + offset, 0);
 220 }
 221
 222 void spl_set_header_raw_uboot(struct spl_image_info *spl_image)
 223 {
 224         ulong u_boot_pos = binman_sym(ulong, u_boot_any, image_pos);
 225
 226         spl_image->size = CONFIG_SYS_MONITOR_LEN;
 227
 228         /*
 229          * Binman error cases: address of the end of the previous region or the
 230          * start of the image's entry area (usually 0) if there is no previous
 231          * region.
 232          */
 233         if (u_boot_pos && u_boot_pos != BINMAN_SYM_MISSING) {
 234                 /* Binman does not support separated entry addresses */
 235                 spl_image->entry_point = u_boot_pos;
 236                 spl_image->load_addr = u_boot_pos;
 237         } else {
 238                 spl_image->entry_point = CONFIG_SYS_UBOOT_START;
 239                 spl_image->load_addr = CONFIG_SYS_TEXT_BASE;
 240         }
 241         spl_image->os = IH_OS_U_BOOT;
 242         spl_image->name = "U-Boot";
 243 }
 244
 245 #if CONFIG_IS_ENABLED(LOAD_FIT_FULL)
 246 /* Parse and load full fitImage in SPL */
 247 static int spl_load_fit_image(struct spl_image_info *spl_image,
 248                               const struct image_header *header)
 249 {
 250         bootm_headers_t images;
 251         const char *fit_uname_config = NULL;
 252         uintptr_t fdt_hack;
 253         const char *uname;
 254         ulong fw_data = 0, dt_data = 0, img_data = 0;
 255         ulong fw_len = 0, dt_len = 0, img_len = 0;
 256         int idx, conf_noffset;
 257         int ret;
 258
 259 #ifdef CONFIG_SPL_FIT_SIGNATURE
 260         images.verify = 1;
 261 #endif
 262         ret = fit_image_load(&images, (ulong)header,
 263                              NULL, &fit_uname_config,
 264                              IH_ARCH_DEFAULT, IH_TYPE_STANDALONE, -1,
 265                              FIT_LOAD_OPTIONAL, &fw_data, &fw_len);
 266         if (ret >= 0) {
 267                 printf("DEPRECATED: 'standalone = ' property.");
 268                 printf("Please use either 'firmware =' or 'kernel ='\n");
 269         } else {
 270                 ret = fit_image_load(&images, (ulong)header, NULL,
 271                                      &fit_uname_config, IH_ARCH_DEFAULT,
 272                                      IH_TYPE_FIRMWARE, -1, FIT_LOAD_OPTIONAL,
 273                                      &fw_data, &fw_len);
 274         }
 275
 276         if (ret < 0) {
 277                 ret = fit_image_load(&images, (ulong)header, NULL,
 278                                      &fit_uname_config, IH_ARCH_DEFAULT,
 279                                      IH_TYPE_KERNEL, -1, FIT_LOAD_OPTIONAL,
 280                                      &fw_data, &fw_len);
 281         }
 282
 283         if (ret < 0)
 284                 return ret;
 285
 286         spl_image->size = fw_len;
 287         spl_image->entry_point = fw_data;
 288         spl_image->load_addr = fw_data;
 289         if (fit_image_get_os(header, ret, &spl_image->os))
 290                 spl_image->os = IH_OS_INVALID;
 291         spl_image->name = genimg_get_os_name(spl_image->os);
 292
 293         debug(SPL_TPL_PROMPT "payload image: %32s load addr: 0x%lx size: %d\n",
 294               spl_image->name, spl_image->load_addr, spl_image->size);
 295
 296 #ifdef CONFIG_SPL_FIT_SIGNATURE
 297         images.verify = 1;
 298 #endif
 299         ret = fit_image_load(&images, (ulong)header, NULL, &fit_uname_config,
 300                        IH_ARCH_DEFAULT, IH_TYPE_FLATDT, -1,
 301                        FIT_LOAD_OPTIONAL, &dt_data, &dt_len);
 302         if (ret >= 0) {
 303                 spl_image->fdt_addr = (void *)dt_data;
 304
 305                 if (spl_image->os == IH_OS_U_BOOT) {
 306                         /* HACK: U-boot expects FDT at a specific address */
 307                         fdt_hack = spl_image->load_addr + spl_image->size;
 308                         fdt_hack = (fdt_hack + 3) & ~3;
 309                         debug("Relocating FDT to %p\n", spl_image->fdt_addr);
 310                         memcpy((void *)fdt_hack, spl_image->fdt_addr, dt_len);
 311                 }
 312         }
 313
 314         conf_noffset = fit_conf_get_node((const void *)header,
 315                                          fit_uname_config);
 316         if (conf_noffset <= 0)
 317                 return 0;
 318
 319         for (idx = 0;
 320              uname = fdt_stringlist_get((const void *)header, conf_noffset,
 321                                         FIT_LOADABLE_PROP, idx,
 322                                 NULL), uname;
 323              idx++)
 324         {
 325 #ifdef CONFIG_SPL_FIT_SIGNATURE
 326                 images.verify = 1;
 327 #endif
 328                 ret = fit_image_load(&images, (ulong)header,
 329                                      &uname, &fit_uname_config,
 330                                      IH_ARCH_DEFAULT, IH_TYPE_LOADABLE, -1,
 331                                      FIT_LOAD_OPTIONAL_NON_ZERO,
 332                                      &img_data, &img_len);
 333                 if (ret < 0)
 334                         return ret;
 335         }
 336
 337         return 0;
 338 }
 339 #endif
 340
 341 __weak int spl_parse_board_header(struct spl_image_info *spl_image,
 342                                   const struct spl_boot_device *bootdev,
 343                                   const void *image_header, size_t size)
 344 {
 345         return -EINVAL;
 346 }
 347
 348 __weak int spl_parse_legacy_header(struct spl_image_info *spl_image,
 349                                    const struct image_header *header)
 350 {
 351         /* LEGACY image not supported */
 352         debug("Legacy boot image support not enabled, proceeding to other boot methods\n");
 353         return -EINVAL;
 354 }
 355
 356 int spl_parse_image_header(struct spl_image_info *spl_image,
 357                            const struct spl_boot_device *bootdev,
 358                            const struct image_header *header)
 359 {
 360 #if CONFIG_IS_ENABLED(LOAD_FIT_FULL)
 361         int ret = spl_load_fit_image(spl_image, header);
 362
 363         if (!ret)
 364                 return ret;
 365 #endif
 366         if (image_get_magic(header) == IH_MAGIC) {
 367                 int ret;
 368
 369                 ret = spl_parse_legacy_header(spl_image, header);
 370                 if (ret)
 371                         return ret;
 372         } else {
 373 #ifdef CONFIG_SPL_PANIC_ON_RAW_IMAGE
 374                 /*
 375                  * CONFIG_SPL_PANIC_ON_RAW_IMAGE is defined when the
 376                  * code which loads images in SPL cannot guarantee that
 377                  * absolutely all read errors will be reported.
 378                  * An example is the LPC32XX MLC NAND driver, which
 379                  * will consider that a completely unreadable NAND block
 380                  * is bad, and thus should be skipped silently.
 381                  */
 382                 panic("** no mkimage signature but raw image not supported");
 383 #endif
 384
 385 #if CONFIG_IS_ENABLED(OS_BOOT)
 386                 ulong start, end;
 387
 388                 if (!bootz_setup((ulong)header, &start, &end)) {
 389                         spl_image->name = "Linux";
 390                         spl_image->os = IH_OS_LINUX;
 391                         spl_image->load_addr = CONFIG_SYS_LOAD_ADDR;
 392                         spl_image->entry_point = CONFIG_SYS_LOAD_ADDR;
 393                         spl_image->size = end - start;
 394                         debug(SPL_TPL_PROMPT
 395                               "payload zImage, load addr: 0x%lx size: %d\n",
 396                               spl_image->load_addr, spl_image->size);
 397                         return 0;
 398                 }
 399 #endif
 400
 401                 if (!spl_parse_board_header(spl_image, bootdev, (const void *)header, sizeof(*header)))
 402                         return 0;
 403
 404 #ifdef CONFIG_SPL_RAW_IMAGE_SUPPORT
 405                 /* Signature not found - assume u-boot.bin */
 406                 debug("mkimage signature not found - ih_magic = %x\n",
 407                         header->ih_magic);
 408                 spl_set_header_raw_uboot(spl_image);
 409 #else
 410                 /* RAW image not supported, proceed to other boot methods. */
 411                 debug("Raw boot image support not enabled, proceeding to other boot methods\n");
 412                 return -EINVAL;
 413 #endif
 414         }
 415
 416         return 0;
 417 }
 418
 419 __weak void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image)
 420 {
 421         typedef void __noreturn (*image_entry_noargs_t)(void);
 422
 423         image_entry_noargs_t image_entry =
 424                 (image_entry_noargs_t)spl_image->entry_point;
 425
 426         debug("image entry point: 0x%lx\n", spl_image->entry_point);
 427         image_entry();
 428 }
 429
 430 #if CONFIG_IS_ENABLED(HANDOFF)
 431 /**
 432  * Set up the SPL hand-off information
 433  *
 434  * This is initially empty (zero) but can be written by
 435  */
 436 static int setup_spl_handoff(void)
 437 {
 438         struct spl_handoff *ho;
 439
 440         ho = bloblist_ensure(BLOBLISTT_U_BOOT_SPL_HANDOFF, sizeof(struct spl_handoff));
 441         if (!ho)
 442                 return -ENOENT;
 443
 444         return 0;
 445 }
 446
 447 __weak int handoff_arch_save(struct spl_handoff *ho)
 448 {
 449         return 0;
 450 }
 451
 452 static int write_spl_handoff(void)
 453 {
 454         struct spl_handoff *ho;
 455         int ret;
 456
 457         ho = bloblist_find(BLOBLISTT_U_BOOT_SPL_HANDOFF, sizeof(struct spl_handoff));
 458         if (!ho)
 459                 return -ENOENT;
 460         handoff_save_dram(ho);
 461         ret = handoff_arch_save(ho);
 462         if (ret)
 463                 return ret;
 464         debug(SPL_TPL_PROMPT "Wrote SPL handoff\n");
 465
 466         return 0;
 467 }
 468 #else
 469 static inline int setup_spl_handoff(void) { return 0; }
 470 static inline int write_spl_handoff(void) { return 0; }
 471
 472 #endif /* HANDOFF */
 473
 474 /**
 475  * get_bootstage_id() - Get the bootstage ID to emit
 476  *
 477  * @start: true if this is for starting SPL, false for ending it
 478  * Return: bootstage ID to use
 479  */
 480 static enum bootstage_id get_bootstage_id(bool start)
 481 {
 482         enum u_boot_phase phase = spl_phase();
 483
 484         if (IS_ENABLED(CONFIG_TPL_BUILD) && phase == PHASE_TPL)
 485                 return start ? BOOTSTAGE_ID_START_TPL : BOOTSTAGE_ID_END_TPL;
 486         else if (IS_ENABLED(CONFIG_VPL_BUILD) && phase == PHASE_VPL)
 487                 return start ? BOOTSTAGE_ID_START_VPL : BOOTSTAGE_ID_END_VPL;
 488         else
 489                 return start ? BOOTSTAGE_ID_START_SPL : BOOTSTAGE_ID_END_SPL;
 490 }
 491
 492 static int spl_common_init(bool setup_malloc)
 493 {
 494         int ret;
 495
 496 #if CONFIG_VAL(SYS_MALLOC_F_LEN)
 497         if (setup_malloc) {
 498 #ifdef CONFIG_MALLOC_F_ADDR
 499                 gd->malloc_base = CONFIG_MALLOC_F_ADDR;
 500 #endif
 501                 gd->malloc_limit = CONFIG_VAL(SYS_MALLOC_F_LEN);
 502                 gd->malloc_ptr = 0;
 503         }
 504 #endif
 505         ret = bootstage_init(u_boot_first_phase());
 506         if (ret) {
 507                 debug("%s: Failed to set up bootstage: ret=%d\n", __func__,
 508                       ret);
 509                 return ret;
 510         }
 511 #ifdef CONFIG_BOOTSTAGE_STASH
 512         if (!u_boot_first_phase()) {
 513                 const void *stash = map_sysmem(CONFIG_BOOTSTAGE_STASH_ADDR,
 514                                                CONFIG_BOOTSTAGE_STASH_SIZE);
 515
 516                 ret = bootstage_unstash(stash, CONFIG_BOOTSTAGE_STASH_SIZE);
 517                 if (ret)
 518                         debug("%s: Failed to unstash bootstage: ret=%d\n",
 519                               __func__, ret);
 520         }
 521 #endif /* CONFIG_BOOTSTAGE_STASH */
 522         bootstage_mark_name(get_bootstage_id(true),
 523                             spl_phase_name(spl_phase()));
 524 #if CONFIG_IS_ENABLED(LOG)
 525         ret = log_init();
 526         if (ret) {
 527                 debug("%s: Failed to set up logging\n", __func__);
 528                 return ret;
 529         }
 530 #endif
 531         if (CONFIG_IS_ENABLED(OF_REAL)) {
 532                 ret = fdtdec_setup();
 533                 if (ret) {
 534                         debug("fdtdec_setup() returned error %d\n", ret);
 535                         return ret;
 536                 }
 537         }
 538         if (CONFIG_IS_ENABLED(DM)) {
 539                 bootstage_start(BOOTSTAGE_ID_ACCUM_DM_SPL,
 540                                 spl_phase() == PHASE_TPL ? "dm tpl" : "dm_spl");
 541                 /* With CONFIG_SPL_OF_PLATDATA, bring in all devices */
 542                 ret = dm_init_and_scan(!CONFIG_IS_ENABLED(OF_PLATDATA));
 543                 bootstage_accum(BOOTSTAGE_ID_ACCUM_DM_SPL);
 544                 if (ret) {
 545                         debug("dm_init_and_scan() returned error %d\n", ret);
 546                         return ret;
 547                 }
 548         }
 549
 550         return 0;
 551 }
 552
 553 void spl_set_bd(void)
 554 {
 555         /*
 556          * NOTE: On some platforms (e.g. x86) bdata may be in flash and not
 557          * writeable.
 558          */
 559         if (!gd->bd)
 560                 gd->bd = &bdata;
 561 }
 562
 563 int spl_early_init(void)
 564 {
 565         int ret;
 566
 567         debug("%s\n", __func__);
 568
 569         ret = spl_common_init(true);
 570         if (ret)
 571                 return ret;
 572         gd->flags |= GD_FLG_SPL_EARLY_INIT;
 573
 574         return 0;
 575 }
 576
 577 int spl_init(void)
 578 {
 579         int ret;
 580         bool setup_malloc = !(IS_ENABLED(CONFIG_SPL_STACK_R) &&
 581                         IS_ENABLED(CONFIG_SPL_SYS_MALLOC_SIMPLE));
 582
 583         debug("%s\n", __func__);
 584
 585         if (!(gd->flags & GD_FLG_SPL_EARLY_INIT)) {
 586                 ret = spl_common_init(setup_malloc);
 587                 if (ret)
 588                         return ret;
 589         }
 590         gd->flags |= GD_FLG_SPL_INIT;
 591
 592         return 0;
 593 }
 594
 595 #ifndef BOOT_DEVICE_NONE
 596 #define BOOT_DEVICE_NONE 0xdeadbeef
 597 #endif
 598
 599 __weak void board_boot_order(u32 *spl_boot_list)
 600 {
 601         spl_boot_list[0] = spl_boot_device();
 602 }
 603
 604 static struct spl_image_loader *spl_ll_find_loader(uint boot_device)
 605 {
 606         struct spl_image_loader *drv =
 607                 ll_entry_start(struct spl_image_loader, spl_image_loader);
 608         const int n_ents =
 609                 ll_entry_count(struct spl_image_loader, spl_image_loader);
 610         struct spl_image_loader *entry;
 611
 612         for (entry = drv; entry != drv + n_ents; entry++) {
 613                 if (boot_device == entry->boot_device)
 614                         return entry;
 615         }
 616
 617         /* Not found */
 618         return NULL;
 619 }
 620
 621 __weak int spl_check_board_image(struct spl_image_info *spl_image,
 622                                  const struct spl_boot_device *bootdev)
 623 {
 624         return 0;
 625 }
 626
 627 static int spl_load_image(struct spl_image_info *spl_image,
 628                           struct spl_image_loader *loader)
 629 {
 630         int ret;
 631         struct spl_boot_device bootdev;
 632
 633         bootdev.boot_device = loader->boot_device;
 634         bootdev.boot_device_name = NULL;
 635
 636         ret = loader->load_image(spl_image, &bootdev);
 637 #ifdef CONFIG_SPL_LEGACY_IMAGE_CRC_CHECK
 638         if (!ret && spl_image->dcrc_length) {
 639                 /* check data crc */
 640                 ulong dcrc = crc32_wd(0, (unsigned char *)spl_image->dcrc_data,
 641                                       spl_image->dcrc_length, CHUNKSZ_CRC32);
 642                 if (dcrc != spl_image->dcrc) {
 643                         puts("SPL: Image data CRC check failed!\n");
 644                         ret = -EINVAL;
 645                 }
 646         }
 647 #endif
 648         if (!ret)
 649                 ret = spl_check_board_image(spl_image, &bootdev);
 650
 651         return ret;
 652 }
 653
 654 /**
 655  * boot_from_devices() - Try loading a booting U-Boot from a list of devices
 656  *
 657  * @spl_image: Place to put the image details if successful
 658  * @spl_boot_list: List of boot devices to try
 659  * @count: Number of elements in spl_boot_list
 660  * Return: 0 if OK, -ENODEV if there were no boot devices
 661  *      if CONFIG_SHOW_ERRORS is enabled, returns -ENXIO if there were
 662  *      devices but none worked
 663  */
 664 static int boot_from_devices(struct spl_image_info *spl_image,
 665                              u32 spl_boot_list[], int count)
 666 {
 667         int ret = -ENODEV;
 668         int i;
 669
 670         for (i = 0; i < count && spl_boot_list[i] != BOOT_DEVICE_NONE; i++) {
 671                 struct spl_image_loader *loader;
 672                 int bootdev = spl_boot_list[i];
 673
 674                 if (CONFIG_IS_ENABLED(SHOW_ERRORS))
 675                         ret = -ENXIO;
 676                 loader = spl_ll_find_loader(bootdev);
 677                 if (CONFIG_IS_ENABLED(SERIAL) &&
 678                     CONFIG_IS_ENABLED(LIBCOMMON_SUPPORT) &&
 679                     !IS_ENABLED(CONFIG_SILENT_CONSOLE)) {
 680                         if (loader)
 681                                 printf("Trying to boot from %s\n",
 682                                        spl_loader_name(loader));
 683                         else if (CONFIG_IS_ENABLED(SHOW_ERRORS))
 684                                 printf(SPL_TPL_PROMPT
 685                                        "Unsupported Boot Device %d\n", bootdev);
 686                         else
 687                                 puts(SPL_TPL_PROMPT "Unsupported Boot Device!\n");
 688                 }
 689                 if (loader && !spl_load_image(spl_image, loader)) {
 690                         spl_image->boot_device = bootdev;
 691                         return 0;
 692                 }
 693         }
 694
 695         return ret;
 696 }
 697
 698 #if defined(CONFIG_SPL_FRAMEWORK_BOARD_INIT_F)
 699 void board_init_f(ulong dummy)
 700 {
 701         if (CONFIG_IS_ENABLED(OF_CONTROL)) {
 702                 int ret;
 703
 704                 ret = spl_early_init();
 705                 if (ret) {
 706                         debug("spl_early_init() failed: %d\n", ret);
 707                         hang();
 708                 }
 709         }
 710
 711         preloader_console_init();
 712 }
 713 #endif
 714
 715 void board_init_r(gd_t *dummy1, ulong dummy2)
 716 {
 717         u32 spl_boot_list[] = {
 718                 BOOT_DEVICE_NONE,
 719                 BOOT_DEVICE_NONE,
 720                 BOOT_DEVICE_NONE,
 721                 BOOT_DEVICE_NONE,
 722                 BOOT_DEVICE_NONE,
 723         };
 724         struct spl_image_info spl_image;
 725         int ret;
 726
 727         debug(">>" SPL_TPL_PROMPT "board_init_r()\n");
 728
 729         spl_set_bd();
 730
 731 #if defined(CONFIG_SYS_SPL_MALLOC_START)
 732         mem_malloc_init(CONFIG_SYS_SPL_MALLOC_START,
 733                         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