common/spl/spl.c

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