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