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 <binman_sym.h>
  11 #include <dm.h>
  12 #include <spl.h>
  13 #include <asm/u-boot.h>
  14 #include <nand.h>
  15 #include <fat.h>
  16 #include <version.h>
  17 #include <image.h>
  18 #include <malloc.h>
  19 #include <dm/root.h>
  20 #include <linux/compiler.h>
  21 #include <fdt_support.h>
  22 #include <bootcount.h>
  23
  24 DECLARE_GLOBAL_DATA_PTR;
  25
  26 #ifndef CONFIG_SYS_UBOOT_START
  27 #define CONFIG_SYS_UBOOT_START  CONFIG_SYS_TEXT_BASE
  28 #endif
  29 #ifndef CONFIG_SYS_MONITOR_LEN
  30 /* Unknown U-Boot size, let's assume it will not be more than 200 KB */
  31 #define CONFIG_SYS_MONITOR_LEN  (200 * 1024)
  32 #endif
  33
  34 u32 *boot_params_ptr = NULL;
  35
  36 /* See spl.h for information about this */
  37 binman_sym_declare(ulong, u_boot_any, pos);
  38
  39 /* Define board data structure */
  40 static bd_t bdata __attribute__ ((section(".data")));
  41
  42 /*
  43  * Board-specific Platform code can reimplement show_boot_progress () if needed
  44  */
  45 __weak void show_boot_progress(int val) {}
  46
  47 /*
  48  * Default function to determine if u-boot or the OS should
  49  * be started. This implementation always returns 1.
  50  *
  51  * Please implement your own board specific funcion to do this.
  52  *
  53  * RETURN
  54  * 0 to not start u-boot
  55  * positive if u-boot should start
  56  */
  57 #ifdef CONFIG_SPL_OS_BOOT
  58 __weak int spl_start_uboot(void)
  59 {
  60         puts("SPL: Please implement spl_start_uboot() for your board\n");
  61         puts("SPL: Direct Linux boot not active!\n");
  62         return 1;
  63 }
  64
  65 /* weak default platform specific function to initialize
  66  * dram banks
  67  */
  68 __weak int dram_init_banksize(void)
  69 {
  70         return 0;
  71 }
  72
  73 /*
  74  * Weak default function for arch specific zImage check. Return zero
  75  * and fill start and end address if image is recognized.
  76  */
  77 int __weak bootz_setup(ulong image, ulong *start, ulong *end)
  78 {
  79          return 1;
  80 }
  81 #endif
  82
  83 /* Weak default function for arch/board-specific fixups to the spl_image_info */
  84 void __weak spl_perform_fixups(struct spl_image_info *spl_image)
  85 {
  86 }
  87
  88 void spl_fixup_fdt(void)
  89 {
  90 #if defined(CONFIG_SPL_OF_LIBFDT) && defined(CONFIG_SYS_SPL_ARGS_ADDR)
  91         void *fdt_blob = (void *)CONFIG_SYS_SPL_ARGS_ADDR;
  92         int err;
  93
  94         err = fdt_check_header(fdt_blob);
  95         if (err < 0) {
  96                 printf("fdt_root: %s\n", fdt_strerror(err));
  97                 return;
  98         }
  99
 100         /* fixup the memory dt node */
 101         err = fdt_shrink_to_minimum(fdt_blob, 0);
 102         if (err == 0) {
 103                 printf("spl: fdt_shrink_to_minimum err - %d\n", err);
 104                 return;
 105         }
 106
 107         err = arch_fixup_fdt(fdt_blob);
 108         if (err) {
 109                 printf("spl: arch_fixup_fdt err - %d\n", err);
 110                 return;
 111         }
 112 #endif
 113 }
 114
 115 /*
 116  * Weak default function for board specific cleanup/preparation before
 117  * Linux boot. Some boards/platforms might not need it, so just provide
 118  * an empty stub here.
 119  */
 120 __weak void spl_board_prepare_for_linux(void)
 121 {
 122         /* Nothing to do! */
 123 }
 124
 125 __weak void spl_board_prepare_for_boot(void)
 126 {
 127         /* Nothing to do! */
 128 }
 129
 130 void spl_set_header_raw_uboot(struct spl_image_info *spl_image)
 131 {
 132         ulong u_boot_pos = binman_sym(ulong, u_boot_any, pos);
 133
 134         spl_image->size = CONFIG_SYS_MONITOR_LEN;
 135
 136         /*
 137          * Binman error cases: address of the end of the previous region or the
 138          * start of the image's entry area (usually 0) if there is no previous
 139          * region.
 140          */
 141         if (u_boot_pos && u_boot_pos != BINMAN_SYM_MISSING) {
 142                 /* Binman does not support separated entry addresses */
 143                 spl_image->entry_point = u_boot_pos;
 144                 spl_image->load_addr = u_boot_pos;
 145         } else {
 146                 spl_image->entry_point = CONFIG_SYS_UBOOT_START;
 147                 spl_image->load_addr = CONFIG_SYS_TEXT_BASE;
 148         }
 149         spl_image->os = IH_OS_U_BOOT;
 150         spl_image->name = "U-Boot";
 151 }
 152
 153 #ifdef CONFIG_SPL_LOAD_FIT_FULL
 154 /* Parse and load full fitImage in SPL */
 155 static int spl_load_fit_image(struct spl_image_info *spl_image,
 156                               const struct image_header *header)
 157 {
 158         bootm_headers_t images;
 159         const char *fit_uname_config = NULL;
 160         const char *fit_uname_fdt = FIT_FDT_PROP;
 161         const char *uname;
 162         ulong fw_data = 0, dt_data = 0, img_data = 0;
 163         ulong fw_len = 0, dt_len = 0, img_len = 0;
 164         int idx, conf_noffset;
 165         int ret;
 166
 167 #ifdef CONFIG_SPL_FIT_SIGNATURE
 168         images.verify = 1;
 169 #endif
 170         ret = fit_image_load(&images, (ulong)header,
 171                              NULL, &fit_uname_config,
 172                              IH_ARCH_DEFAULT, IH_TYPE_STANDALONE, -1,
 173                              FIT_LOAD_REQUIRED, &fw_data, &fw_len);
 174         if (ret < 0)
 175                 return ret;
 176
 177         spl_image->size = fw_len;
 178         spl_image->entry_point = fw_data;
 179         spl_image->load_addr = fw_data;
 180         spl_image->os = IH_OS_U_BOOT;
 181         spl_image->name = "U-Boot";
 182
 183         debug("spl: payload image: %.*s load addr: 0x%lx size: %d\n",
 184               (int)sizeof(spl_image->name), spl_image->name,
 185                 spl_image->load_addr, spl_image->size);
 186
 187 #ifdef CONFIG_SPL_FIT_SIGNATURE
 188         images.verify = 1;
 189 #endif
 190         fit_image_load(&images, (ulong)header,
 191                        &fit_uname_fdt, &fit_uname_config,
 192                        IH_ARCH_DEFAULT, IH_TYPE_FLATDT, -1,
 193                        FIT_LOAD_OPTIONAL, &dt_data, &dt_len);
 194
 195         conf_noffset = fit_conf_get_node((const void *)header,
 196                                          fit_uname_config);
 197         if (conf_noffset <= 0)
 198                 return 0;
 199
 200         for (idx = 0;
 201              uname = fdt_stringlist_get((const void *)header, conf_noffset,
 202                                         FIT_LOADABLE_PROP, idx,
 203                                 NULL), uname;
 204              idx++)
 205         {
 206 #ifdef CONFIG_SPL_FIT_SIGNATURE
 207                 images.verify = 1;
 208 #endif
 209                 ret = fit_image_load(&images, (ulong)header,
 210                                      &uname, &fit_uname_config,
 211                                      IH_ARCH_DEFAULT, IH_TYPE_LOADABLE, -1,
 212                                      FIT_LOAD_OPTIONAL_NON_ZERO,
 213                                      &img_data, &img_len);
 214                 if (ret < 0)
 215                         return ret;
 216         }
 217
 218         return 0;
 219 }
 220 #endif
 221
 222 int spl_parse_image_header(struct spl_image_info *spl_image,
 223                            const struct image_header *header)
 224 {
 225 #ifdef CONFIG_SPL_LOAD_FIT_FULL
 226         int ret = spl_load_fit_image(spl_image, header);
 227
 228         if (!ret)
 229                 return ret;
 230 #endif
 231         if (image_get_magic(header) == IH_MAGIC) {
 232 #ifdef CONFIG_SPL_LEGACY_IMAGE_SUPPORT
 233                 u32 header_size = sizeof(struct image_header);
 234
 235                 if (spl_image->flags & SPL_COPY_PAYLOAD_ONLY) {
 236                         /*
 237                          * On some system (e.g. powerpc), the load-address and
 238                          * entry-point is located at address 0. We can't load
 239                          * to 0-0x40. So skip header in this case.
 240                          */
 241                         spl_image->load_addr = image_get_load(header);
 242                         spl_image->entry_point = image_get_ep(header);
 243                         spl_image->size = image_get_data_size(header);
 244                 } else {
 245                         spl_image->entry_point = image_get_load(header);
 246                         /* Load including the header */
 247                         spl_image->load_addr = spl_image->entry_point -
 248                                 header_size;
 249                         spl_image->size = image_get_data_size(header) +
 250                                 header_size;
 251                 }
 252                 spl_image->os = image_get_os(header);
 253                 spl_image->name = image_get_name(header);
 254                 debug("spl: payload image: %.*s load addr: 0x%lx size: %d\n",
 255                         IH_NMLEN, spl_image->name,
 256                         spl_image->load_addr, spl_image->size);
 257 #else
 258                 /* LEGACY image not supported */
 259                 debug("Legacy boot image support not enabled, proceeding to other boot methods\n");
 260                 return -EINVAL;
 261 #endif
 262         } else {
 263 #ifdef CONFIG_SPL_PANIC_ON_RAW_IMAGE
 264                 /*
 265                  * CONFIG_SPL_PANIC_ON_RAW_IMAGE is defined when the
 266                  * code which loads images in SPL cannot guarantee that
 267                  * absolutely all read errors will be reported.
 268                  * An example is the LPC32XX MLC NAND driver, which
 269                  * will consider that a completely unreadable NAND block
 270                  * is bad, and thus should be skipped silently.
 271                  */
 272                 panic("** no mkimage signature but raw image not supported");
 273 #endif
 274
 275 #ifdef CONFIG_SPL_OS_BOOT
 276                 ulong start, end;
 277
 278                 if (!bootz_setup((ulong)header, &start, &end)) {
 279                         spl_image->name = "Linux";
 280                         spl_image->os = IH_OS_LINUX;
 281                         spl_image->load_addr = CONFIG_SYS_LOAD_ADDR;
 282                         spl_image->entry_point = CONFIG_SYS_LOAD_ADDR;
 283                         spl_image->size = end - start;
 284                         debug("spl: payload zImage, load addr: 0x%lx size: %d\n",
 285                               spl_image->load_addr, spl_image->size);
 286                         return 0;
 287                 }
 288 #endif
 289
 290 #ifdef CONFIG_SPL_RAW_IMAGE_SUPPORT
 291                 /* Signature not found - assume u-boot.bin */
 292                 debug("mkimage signature not found - ih_magic = %x\n",
 293                         header->ih_magic);
 294                 spl_set_header_raw_uboot(spl_image);
 295 #else
 296                 /* RAW image not supported, proceed to other boot methods. */
 297                 debug("Raw boot image support not enabled, proceeding to other boot methods\n");
 298                 return -EINVAL;
 299 #endif
 300         }
 301
 302         return 0;
 303 }
 304
 305 __weak void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image)
 306 {
 307         typedef void __noreturn (*image_entry_noargs_t)(void);
 308
 309         image_entry_noargs_t image_entry =
 310                 (image_entry_noargs_t)spl_image->entry_point;
 311
 312         debug("image entry point: 0x%lX\n", spl_image->entry_point);
 313         image_entry();
 314 }
 315
 316 static int spl_common_init(bool setup_malloc)
 317 {
 318         int ret;
 319
 320         debug("spl_early_init()\n");
 321
 322 #if CONFIG_VAL(SYS_MALLOC_F_LEN)
 323         if (setup_malloc) {
 324 #ifdef CONFIG_MALLOC_F_ADDR
 325                 gd->malloc_base = CONFIG_MALLOC_F_ADDR;
 326 #endif
 327                 gd->malloc_limit = CONFIG_VAL(SYS_MALLOC_F_LEN);
 328                 gd->malloc_ptr = 0;
 329         }
 330 #endif
 331         ret = bootstage_init(true);
 332         if (ret) {
 333                 debug("%s: Failed to set up bootstage: ret=%d\n", __func__,
 334                       ret);
 335                 return ret;
 336         }
 337         bootstage_mark_name(BOOTSTAGE_ID_START_SPL, "spl");
 338         if (CONFIG_IS_ENABLED(OF_CONTROL) && !CONFIG_IS_ENABLED(OF_PLATDATA)) {
 339                 ret = fdtdec_setup();
 340                 if (ret) {
 341                         debug("fdtdec_setup() returned error %d\n", ret);
 342                         return ret;
 343                 }
 344         }
 345         if (CONFIG_IS_ENABLED(DM)) {
 346                 bootstage_start(BOOTSTATE_ID_ACCUM_DM_SPL, "dm_spl");
 347                 /* With CONFIG_SPL_OF_PLATDATA, bring in all devices */
 348                 ret = dm_init_and_scan(!CONFIG_IS_ENABLED(OF_PLATDATA));
 349                 bootstage_accum(BOOTSTATE_ID_ACCUM_DM_SPL);
 350                 if (ret) {
 351                         debug("dm_init_and_scan() returned error %d\n", ret);
 352                         return ret;
 353                 }
 354         }
 355
 356         return 0;
 357 }
 358
 359 void spl_set_bd(void)
 360 {
 361         if (!gd->bd)
 362                 gd->bd = &bdata;
 363 }
 364
 365 int spl_early_init(void)
 366 {
 367         int ret;
 368
 369         ret = spl_common_init(true);
 370         if (ret)
 371                 return ret;
 372         gd->flags |= GD_FLG_SPL_EARLY_INIT;
 373
 374         return 0;
 375 }
 376
 377 int spl_init(void)
 378 {
 379         int ret;
 380         bool setup_malloc = !(IS_ENABLED(CONFIG_SPL_STACK_R) &&
 381                         IS_ENABLED(CONFIG_SPL_SYS_MALLOC_SIMPLE));
 382
 383         if (!(gd->flags & GD_FLG_SPL_EARLY_INIT)) {
 384                 ret = spl_common_init(setup_malloc);
 385                 if (ret)
 386                         return ret;
 387         }
 388         gd->flags |= GD_FLG_SPL_INIT;
 389
 390         return 0;
 391 }
 392
 393 #ifndef BOOT_DEVICE_NONE
 394 #define BOOT_DEVICE_NONE 0xdeadbeef
 395 #endif
 396
 397 __weak void board_boot_order(u32 *spl_boot_list)
 398 {
 399         spl_boot_list[0] = spl_boot_device();
 400 }
 401
 402 static struct spl_image_loader *spl_ll_find_loader(uint boot_device)
 403 {
 404         struct spl_image_loader *drv =
 405                 ll_entry_start(struct spl_image_loader, spl_image_loader);
 406         const int n_ents =
 407                 ll_entry_count(struct spl_image_loader, spl_image_loader);
 408         struct spl_image_loader *entry;
 409
 410         for (entry = drv; entry != drv + n_ents; entry++) {
 411                 if (boot_device == entry->boot_device)
 412                         return entry;
 413         }
 414
 415         /* Not found */
 416         return NULL;
 417 }
 418
 419 static int spl_load_image(struct spl_image_info *spl_image,
 420                           struct spl_image_loader *loader)
 421 {
 422         struct spl_boot_device bootdev;
 423
 424         bootdev.boot_device = loader->boot_device;
 425         bootdev.boot_device_name = NULL;
 426
 427         return loader->load_image(spl_image, &bootdev);
 428 }
 429
 430 /**
 431  * boot_from_devices() - Try loading an booting U-Boot from a list of devices
 432  *
 433  * @spl_image: Place to put the image details if successful
 434  * @spl_boot_list: List of boot devices to try
 435  * @count: Number of elements in spl_boot_list
 436  * @return 0 if OK, -ve on error
 437  */
 438 static int boot_from_devices(struct spl_image_info *spl_image,
 439                              u32 spl_boot_list[], int count)
 440 {
 441         int i;
 442
 443         for (i = 0; i < count && spl_boot_list[i] != BOOT_DEVICE_NONE; i++) {
 444                 struct spl_image_loader *loader;
 445
 446                 loader = spl_ll_find_loader(spl_boot_list[i]);
 447 #if defined(CONFIG_SPL_SERIAL_SUPPORT) && defined(CONFIG_SPL_LIBCOMMON_SUPPORT)
 448                 if (loader)
 449                         printf("Trying to boot from %s\n", loader->name);
 450                 else
 451                         puts("SPL: Unsupported Boot Device!\n");
 452 #endif
 453                 if (loader && !spl_load_image(spl_image, loader)) {
 454                         spl_image->boot_device = spl_boot_list[i];
 455                         return 0;
 456                 }
 457         }
 458
 459         return -ENODEV;
 460 }
 461
 462 void board_init_r(gd_t *dummy1, ulong dummy2)
 463 {
 464         u32 spl_boot_list[] = {
 465                 BOOT_DEVICE_NONE,
 466                 BOOT_DEVICE_NONE,
 467                 BOOT_DEVICE_NONE,
 468                 BOOT_DEVICE_NONE,
 469                 BOOT_DEVICE_NONE,
 470         };
 471         struct spl_image_info spl_image;
 472
 473         debug(">>spl:board_init_r()\n");
 474
 475         spl_set_bd();
 476
 477 #ifdef CONFIG_SPL_OS_BOOT
 478         dram_init_banksize();
 479 #endif
 480
 481 #if defined(CONFIG_SYS_SPL_MALLOC_START)
 482         mem_malloc_init(CONFIG_SYS_SPL_MALLOC_START,
 483                         CONFIG_SYS_SPL_MALLOC_SIZE);
 484         gd->flags |= GD_FLG_FULL_MALLOC_INIT;
 485 #endif
 486         if (!(gd->flags & GD_FLG_SPL_INIT)) {
 487                 if (spl_init())
 488                         hang();
 489         }
 490 #if !defined(CONFIG_PPC) && !defined(CONFIG_ARCH_MX6)
 491         /*
 492          * timer_init() does not exist on PPC systems. The timer is initialized
 493          * and enabled (decrementer) in interrupt_init() here.
 494          */
 495         timer_init();
 496 #endif
 497
 498 #if CONFIG_IS_ENABLED(BOARD_INIT)
 499         spl_board_init();
 500 #endif
 501
 502         bootcount_inc();
 503
 504         memset(&spl_image, '\0', sizeof(spl_image));
 505 #ifdef CONFIG_SYS_SPL_ARGS_ADDR
 506         spl_image.arg = (void *)CONFIG_SYS_SPL_ARGS_ADDR;
 507 #endif
 508         spl_image.boot_device = BOOT_DEVICE_NONE;
 509         board_boot_order(spl_boot_list);
 510
 511         if (boot_from_devices(&spl_image, spl_boot_list,
 512                               ARRAY_SIZE(spl_boot_list))) {
 513                 puts("SPL: failed to boot from all boot devices\n");
 514                 hang();
 515         }
 516
 517         spl_perform_fixups(&spl_image);
 518
 519 #ifdef CONFIG_CPU_V7M
 520         spl_image.entry_point |= 0x1;
 521 #endif
 522         switch (spl_image.os) {
 523         case IH_OS_U_BOOT:
 524                 debug("Jumping to U-Boot\n");
 525                 break;
 526 #if CONFIG_IS_ENABLED(ATF)
 527         case IH_OS_ARM_TRUSTED_FIRMWARE:
 528                 debug("Jumping to U-Boot via ARM Trusted Firmware\n");
 529                 spl_invoke_atf(&spl_image);
 530                 break;
 531 #endif
 532 #ifdef CONFIG_SPL_OS_BOOT
 533         case IH_OS_LINUX:
 534                 debug("Jumping to Linux\n");
 535                 spl_fixup_fdt();
 536                 spl_board_prepare_for_linux();
 537                 jump_to_image_linux(&spl_image);
 538 #endif
 539         default:
 540                 debug("Unsupported OS image.. Jumping nevertheless..\n");
 541         }
 542 #if CONFIG_VAL(SYS_MALLOC_F_LEN) && !defined(CONFIG_SYS_SPL_MALLOC_SIZE)
 543         debug("SPL malloc() used %#lx bytes (%ld KB)\n", gd->malloc_ptr,
 544               gd->malloc_ptr / 1024);
 545 #endif
 546 #ifdef CONFIG_BOOTSTAGE_STASH
 547         int ret;
 548
 549         bootstage_mark_name(BOOTSTAGE_ID_END_SPL, "end_spl");
 550         ret = bootstage_stash((void *)CONFIG_BOOTSTAGE_STASH_ADDR,
 551                               CONFIG_BOOTSTAGE_STASH_SIZE);
 552         if (ret)
 553                 debug("Failed to stash bootstage: err=%d\n", ret);
 554 #endif
 555
 556         debug("loaded - jumping to U-Boot...\n");
 557         spl_board_prepare_for_boot();
 558         jump_to_image_no_args(&spl_image);
 559 }
 560
 561 #ifdef CONFIG_SPL_SERIAL_SUPPORT
 562 /*
 563  * This requires UART clocks to be enabled.  In order for this to work the
 564  * caller must ensure that the gd pointer is valid.
 565  */
 566 void preloader_console_init(void)
 567 {
 568         gd->baudrate = CONFIG_BAUDRATE;
 569
 570         serial_init();          /* serial communications setup */
 571
 572         gd->have_console = 1;
 573
 574 #ifndef CONFIG_SPL_DISABLE_BANNER_PRINT
 575         puts("\nU-Boot SPL " PLAIN_VERSION " (" U_BOOT_DATE " - " \
 576                         U_BOOT_TIME " " U_BOOT_TZ ")\n");
 577 #endif
 578 #ifdef CONFIG_SPL_DISPLAY_PRINT
 579         spl_display_print();
 580 #endif
 581 }
 582 #endif
 583
 584 /**
 585  * spl_relocate_stack_gd() - Relocate stack ready for board_init_r() execution
 586  *
 587  * Sometimes board_init_f() runs with a stack in SRAM but we want to use SDRAM
 588  * for the main board_init_r() execution. This is typically because we need
 589  * more stack space for things like the MMC sub-system.
 590  *
 591  * This function calculates the stack position, copies the global_data into
 592  * place, sets the new gd (except for ARM, for which setting GD within a C
 593  * function may not always work) and returns the new stack position. The
 594  * caller is responsible for setting up the sp register and, in the case
 595  * of ARM, setting up gd.
 596  *
 597  * All of this is done using the same layout and alignments as done in
 598  * board_init_f_init_reserve() / board_init_f_alloc_reserve().
 599  *
 600  * @return new stack location, or 0 to use the same stack
 601  */
 602 ulong spl_relocate_stack_gd(void)
 603 {
 604 #ifdef CONFIG_SPL_STACK_R
 605         gd_t *new_gd;
 606         ulong ptr = CONFIG_SPL_STACK_R_ADDR;
 607
 608 #if defined(CONFIG_SPL_SYS_MALLOC_SIMPLE) && CONFIG_VAL(SYS_MALLOC_F_LEN)
 609         if (CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN) {
 610                 ptr -= CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN;
 611                 gd->malloc_base = ptr;
 612                 gd->malloc_limit = CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN;
 613                 gd->malloc_ptr = 0;
 614         }
 615 #endif
 616         /* Get stack position: use 8-byte alignment for ABI compliance */
 617         ptr = CONFIG_SPL_STACK_R_ADDR - roundup(sizeof(gd_t),16);
 618         new_gd = (gd_t *)ptr;
 619         memcpy(new_gd, (void *)gd, sizeof(gd_t));
 620 #if CONFIG_IS_ENABLED(DM)
 621         dm_fixup_for_gd_move(new_gd);
 622 #endif
 623 #if !defined(CONFIG_ARM)
 624         gd = new_gd;
 625 #endif
 626         return ptr;
 627 #else
 628         return 0;
 629 #endif
 630 }