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