common/spl/spl.c

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