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
  21 DECLARE_GLOBAL_DATA_PTR;
  22
  23 #ifndef CONFIG_SYS_UBOOT_START
  24 #define CONFIG_SYS_UBOOT_START  CONFIG_SYS_TEXT_BASE
  25 #endif
  26 #ifndef CONFIG_SYS_MONITOR_LEN
  27 /* Unknown U-Boot size, let's assume it will not be more than 200 KB */
  28 #define CONFIG_SYS_MONITOR_LEN  (200 * 1024)
  29 #endif
  30
  31 u32 *boot_params_ptr = NULL;
  32 struct spl_image_info spl_image;
  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 /*
  61  * Weak default function for arch specific zImage check. Return zero
  62  * and fill start and end address if image is recognized.
  63  */
  64 int __weak bootz_setup(ulong image, ulong *start, ulong *end)
  65 {
  66          return 1;
  67 }
  68 #endif
  69
  70 /*
  71  * Weak default function for board specific cleanup/preparation before
  72  * Linux boot. Some boards/platforms might not need it, so just provide
  73  * an empty stub here.
  74  */
  75 __weak void spl_board_prepare_for_linux(void)
  76 {
  77         /* Nothing to do! */
  78 }
  79
  80 __weak void spl_board_prepare_for_boot(void)
  81 {
  82         /* Nothing to do! */
  83 }
  84
  85 void spl_set_header_raw_uboot(struct spl_image_info *spl_image)
  86 {
  87         spl_image->size = CONFIG_SYS_MONITOR_LEN;
  88         spl_image->entry_point = CONFIG_SYS_UBOOT_START;
  89         spl_image->load_addr = CONFIG_SYS_TEXT_BASE;
  90         spl_image->os = IH_OS_U_BOOT;
  91         spl_image->name = "U-Boot";
  92 }
  93
  94 int spl_parse_image_header(struct spl_image_info *spl_image,
  95                            const struct image_header *header)
  96 {
  97         u32 header_size = sizeof(struct image_header);
  98
  99         if (image_get_magic(header) == IH_MAGIC) {
 100                 if (spl_image->flags & SPL_COPY_PAYLOAD_ONLY) {
 101                         /*
 102                          * On some system (e.g. powerpc), the load-address and
 103                          * entry-point is located at address 0. We can't load
 104                          * to 0-0x40. So skip header in this case.
 105                          */
 106                         spl_image->load_addr = image_get_load(header);
 107                         spl_image->entry_point = image_get_ep(header);
 108                         spl_image->size = image_get_data_size(header);
 109                 } else {
 110                         spl_image->entry_point = image_get_load(header);
 111                         /* Load including the header */
 112                         spl_image->load_addr = spl_image->entry_point -
 113                                 header_size;
 114                         spl_image->size = image_get_data_size(header) +
 115                                 header_size;
 116                 }
 117                 spl_image->os = image_get_os(header);
 118                 spl_image->name = image_get_name(header);
 119                 debug("spl: payload image: %.*s load addr: 0x%x size: %d\n",
 120                         (int)sizeof(spl_image->name), spl_image->name,
 121                         spl_image->load_addr, spl_image->size);
 122         } else {
 123 #ifdef CONFIG_SPL_PANIC_ON_RAW_IMAGE
 124                 /*
 125                  * CONFIG_SPL_PANIC_ON_RAW_IMAGE is defined when the
 126                  * code which loads images in SPL cannot guarantee that
 127                  * absolutely all read errors will be reported.
 128                  * An example is the LPC32XX MLC NAND driver, which
 129                  * will consider that a completely unreadable NAND block
 130                  * is bad, and thus should be skipped silently.
 131                  */
 132                 panic("** no mkimage signature but raw image not supported");
 133 #endif
 134
 135 #ifdef CONFIG_SPL_OS_BOOT
 136                 ulong start, end;
 137
 138                 if (!bootz_setup((ulong)header, &start, &end)) {
 139                         spl_image->name = "Linux";
 140                         spl_image->os = IH_OS_LINUX;
 141                         spl_image->load_addr = CONFIG_SYS_LOAD_ADDR;
 142                         spl_image->entry_point = CONFIG_SYS_LOAD_ADDR;
 143                         spl_image->size = end - start;
 144                         debug("spl: payload zImage, load addr: 0x%x size: %d\n",
 145                               spl_image->load_addr, spl_image->size);
 146                         return 0;
 147                 }
 148 #endif
 149
 150 #ifdef CONFIG_SPL_ABORT_ON_RAW_IMAGE
 151                 /* Signature not found, proceed to other boot methods. */
 152                 return -EINVAL;
 153 #else
 154                 /* Signature not found - assume u-boot.bin */
 155                 debug("mkimage signature not found - ih_magic = %x\n",
 156                         header->ih_magic);
 157                 spl_set_header_raw_uboot(spl_image);
 158 #endif
 159         }
 160         return 0;
 161 }
 162
 163 __weak void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image)
 164 {
 165         typedef void __noreturn (*image_entry_noargs_t)(void);
 166
 167         image_entry_noargs_t image_entry =
 168                 (image_entry_noargs_t)(unsigned long)spl_image->entry_point;
 169
 170         debug("image entry point: 0x%X\n", spl_image->entry_point);
 171         image_entry();
 172 }
 173
 174 #ifndef CONFIG_SPL_LOAD_FIT_ADDRESS
 175 # define CONFIG_SPL_LOAD_FIT_ADDRESS    0
 176 #endif
 177
 178 #if defined(CONFIG_SPL_RAM_DEVICE) || defined(CONFIG_SPL_DFU_SUPPORT)
 179 static ulong spl_ram_load_read(struct spl_load_info *load, ulong sector,
 180                                ulong count, void *buf)
 181 {
 182         debug("%s: sector %lx, count %lx, buf %lx\n",
 183               __func__, sector, count, (ulong)buf);
 184         memcpy(buf, (void *)(CONFIG_SPL_LOAD_FIT_ADDRESS + sector), count);
 185         return count;
 186 }
 187
 188 static int spl_ram_load_image(struct spl_image_info *spl_image,
 189                               struct spl_boot_device *bootdev)
 190 {
 191         struct image_header *header;
 192
 193         header = (struct image_header *)CONFIG_SPL_LOAD_FIT_ADDRESS;
 194
 195 #if defined(CONFIG_SPL_DFU_SUPPORT)
 196         if (bootdev->boot_device == BOOT_DEVICE_DFU)
 197                 spl_dfu_cmd(0, "dfu_alt_info_ram", "ram", "0");
 198 #endif
 199
 200         if (IS_ENABLED(CONFIG_SPL_LOAD_FIT) &&
 201             image_get_magic(header) == FDT_MAGIC) {
 202                 struct spl_load_info load;
 203
 204                 debug("Found FIT\n");
 205                 load.bl_len = 1;
 206                 load.read = spl_ram_load_read;
 207                 spl_load_simple_fit(&load, 0, header);
 208         } else {
 209                 debug("Legacy image\n");
 210                 /*
 211                  * Get the header.  It will point to an address defined by
 212                  * handoff which will tell where the image located inside
 213                  * the flash. For now, it will temporary fixed to address
 214                  * pointed by U-Boot.
 215                  */
 216                 header = (struct image_header *)
 217                         (CONFIG_SYS_TEXT_BASE - sizeof(struct image_header));
 218
 219                 spl_parse_image_header(spl_image, header);
 220         }
 221
 222         return 0;
 223 }
 224 SPL_LOAD_IMAGE_METHOD(0, BOOT_DEVICE_RAM, spl_ram_load_image);
 225 #if defined(CONFIG_SPL_DFU_SUPPORT)
 226 SPL_LOAD_IMAGE_METHOD(0, BOOT_DEVICE_DFU, spl_ram_load_image);
 227 #endif
 228 #endif
 229
 230 int spl_init(void)
 231 {
 232         int ret;
 233
 234         debug("spl_init()\n");
 235 #if defined(CONFIG_SYS_MALLOC_F_LEN)
 236 #ifdef CONFIG_MALLOC_F_ADDR
 237         gd->malloc_base = CONFIG_MALLOC_F_ADDR;
 238 #endif
 239         gd->malloc_limit = CONFIG_SYS_MALLOC_F_LEN;
 240         gd->malloc_ptr = 0;
 241 #endif
 242         if (CONFIG_IS_ENABLED(OF_CONTROL) && !CONFIG_IS_ENABLED(OF_PLATDATA)) {
 243                 ret = fdtdec_setup();
 244                 if (ret) {
 245                         debug("fdtdec_setup() returned error %d\n", ret);
 246                         return ret;
 247                 }
 248         }
 249         if (IS_ENABLED(CONFIG_SPL_DM)) {
 250                 /* With CONFIG_OF_PLATDATA, bring in all devices */
 251                 ret = dm_init_and_scan(!CONFIG_IS_ENABLED(OF_PLATDATA));
 252                 if (ret) {
 253                         debug("dm_init_and_scan() returned error %d\n", ret);
 254                         return ret;
 255                 }
 256         }
 257         gd->flags |= GD_FLG_SPL_INIT;
 258
 259         return 0;
 260 }
 261
 262 #ifndef BOOT_DEVICE_NONE
 263 #define BOOT_DEVICE_NONE 0xdeadbeef
 264 #endif
 265
 266 static u32 spl_boot_list[] = {
 267         BOOT_DEVICE_NONE,
 268         BOOT_DEVICE_NONE,
 269         BOOT_DEVICE_NONE,
 270         BOOT_DEVICE_NONE,
 271         BOOT_DEVICE_NONE,
 272 };
 273
 274 __weak void board_boot_order(u32 *spl_boot_list)
 275 {
 276         spl_boot_list[0] = spl_boot_device();
 277 }
 278
 279 #ifdef CONFIG_SPL_BOARD_LOAD_IMAGE
 280 __weak void spl_board_announce_boot_device(void) { }
 281 #endif
 282
 283 #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
 284 struct boot_device_name {
 285         u32 boot_dev;
 286         const char *name;
 287 };
 288
 289 struct boot_device_name boot_name_table[] = {
 290 #ifdef CONFIG_SPL_RAM_DEVICE
 291         { BOOT_DEVICE_RAM, "RAM" },
 292 #endif
 293 #ifdef CONFIG_SPL_MMC_SUPPORT
 294         { BOOT_DEVICE_MMC1, "MMC1" },
 295         { BOOT_DEVICE_MMC2, "MMC2" },
 296         { BOOT_DEVICE_MMC2_2, "MMC2_2" },
 297 #endif
 298 #ifdef CONFIG_SPL_NAND_SUPPORT
 299         { BOOT_DEVICE_NAND, "NAND" },
 300 #endif
 301 #ifdef CONFIG_SPL_ONENAND_SUPPORT
 302         { BOOT_DEVICE_ONENAND, "OneNAND" },
 303 #endif
 304 #ifdef CONFIG_SPL_NOR_SUPPORT
 305         { BOOT_DEVICE_NOR, "NOR" },
 306 #endif
 307 #ifdef CONFIG_SPL_YMODEM_SUPPORT
 308         { BOOT_DEVICE_UART, "UART" },
 309 #endif
 310 #if defined(CONFIG_SPL_SPI_SUPPORT) || defined(CONFIG_SPL_SPI_FLASH_SUPPORT)
 311         { BOOT_DEVICE_SPI, "SPI" },
 312 #endif
 313 #ifdef CONFIG_SPL_ETH_SUPPORT
 314 #ifdef CONFIG_SPL_ETH_DEVICE
 315         { BOOT_DEVICE_CPGMAC, "eth device" },
 316 #else
 317         { BOOT_DEVICE_CPGMAC, "net" },
 318 #endif
 319 #endif
 320 #ifdef CONFIG_SPL_USBETH_SUPPORT
 321         { BOOT_DEVICE_USBETH, "USB eth" },
 322 #endif
 323 #ifdef CONFIG_SPL_USB_SUPPORT
 324         { BOOT_DEVICE_USB, "USB" },
 325 #endif
 326 #ifdef CONFIG_SPL_DFU_SUPPORT
 327         { BOOT_DEVICE_DFU, "USB DFU" },
 328 #endif
 329 #ifdef CONFIG_SPL_SATA_SUPPORT
 330         { BOOT_DEVICE_SATA, "SATA" },
 331 #endif
 332         /* Keep this entry last */
 333         { BOOT_DEVICE_NONE, "unknown boot device" },
 334 };
 335
 336 static void announce_boot_device(u32 boot_device)
 337 {
 338         int i;
 339
 340         puts("Trying to boot from ");
 341
 342 #ifdef CONFIG_SPL_BOARD_LOAD_IMAGE
 343         if (boot_device == BOOT_DEVICE_BOARD) {
 344                 spl_board_announce_boot_device();
 345                 puts("\n");
 346                 return;
 347         }
 348 #endif
 349         for (i = 0; i < ARRAY_SIZE(boot_name_table) - 1; i++) {
 350                 if (boot_name_table[i].boot_dev == boot_device)
 351                         break;
 352         }
 353
 354         printf("%s\n", boot_name_table[i].name);
 355 }
 356 #else
 357 static inline void announce_boot_device(u32 boot_device) { }
 358 #endif
 359
 360 static struct spl_image_loader *spl_ll_find_loader(uint boot_device)
 361 {
 362         struct spl_image_loader *drv =
 363                 ll_entry_start(struct spl_image_loader, spl_image_loader);
 364         const int n_ents =
 365                 ll_entry_count(struct spl_image_loader, spl_image_loader);
 366         struct spl_image_loader *entry;
 367
 368         for (entry = drv; entry != drv + n_ents; entry++) {
 369                 if (boot_device == entry->boot_device)
 370                         return entry;
 371         }
 372
 373         /* Not found */
 374         return NULL;
 375 }
 376
 377 static int spl_load_image(u32 boot_device)
 378 {
 379         struct spl_boot_device bootdev;
 380         struct spl_image_loader *loader = spl_ll_find_loader(boot_device);
 381
 382         bootdev.boot_device = boot_device;
 383         bootdev.boot_device_name = NULL;
 384         if (loader)
 385                 return loader->load_image(&spl_image, &bootdev);
 386
 387 #if defined(CONFIG_SPL_SERIAL_SUPPORT) && defined(CONFIG_SPL_LIBCOMMON_SUPPORT)
 388         puts("SPL: Unsupported Boot Device!\n");
 389 #endif
 390         return -ENODEV;
 391 }
 392
 393 void board_init_r(gd_t *dummy1, ulong dummy2)
 394 {
 395         int i;
 396
 397         debug(">>spl:board_init_r()\n");
 398
 399 #if defined(CONFIG_SYS_SPL_MALLOC_START)
 400         mem_malloc_init(CONFIG_SYS_SPL_MALLOC_START,
 401                         CONFIG_SYS_SPL_MALLOC_SIZE);
 402         gd->flags |= GD_FLG_FULL_MALLOC_INIT;
 403 #endif
 404         if (!(gd->flags & GD_FLG_SPL_INIT)) {
 405                 if (spl_init())
 406                         hang();
 407         }
 408 #ifndef CONFIG_PPC
 409         /*
 410          * timer_init() does not exist on PPC systems. The timer is initialized
 411          * and enabled (decrementer) in interrupt_init() here.
 412          */
 413         timer_init();
 414 #endif
 415
 416 #ifdef CONFIG_SPL_BOARD_INIT
 417         spl_board_init();
 418 #endif
 419
 420         board_boot_order(spl_boot_list);
 421         for (i = 0; i < ARRAY_SIZE(spl_boot_list) &&
 422                         spl_boot_list[i] != BOOT_DEVICE_NONE; i++) {
 423                 announce_boot_device(spl_boot_list[i]);
 424                 if (!spl_load_image(spl_boot_list[i]))
 425                         break;
 426         }
 427
 428         if (i == ARRAY_SIZE(spl_boot_list) ||
 429             spl_boot_list[i] == BOOT_DEVICE_NONE) {
 430                 puts("SPL: failed to boot from all boot devices\n");
 431                 hang();
 432         }
 433
 434         switch (spl_image.os) {
 435         case IH_OS_U_BOOT:
 436                 debug("Jumping to U-Boot\n");
 437                 break;
 438 #ifdef CONFIG_SPL_OS_BOOT
 439         case IH_OS_LINUX:
 440                 debug("Jumping to Linux\n");
 441                 spl_board_prepare_for_linux();
 442                 jump_to_image_linux(&spl_image,
 443                                     (void *)CONFIG_SYS_SPL_ARGS_ADDR);
 444 #endif
 445         default:
 446                 debug("Unsupported OS image.. Jumping nevertheless..\n");
 447         }
 448 #if defined(CONFIG_SYS_MALLOC_F_LEN) && !defined(CONFIG_SYS_SPL_MALLOC_SIZE)
 449         debug("SPL malloc() used %#lx bytes (%ld KB)\n", gd->malloc_ptr,
 450               gd->malloc_ptr / 1024);
 451 #endif
 452
 453         debug("loaded - jumping to U-Boot...");
 454         spl_board_prepare_for_boot();
 455         jump_to_image_no_args(&spl_image);
 456 }
 457
 458 /*
 459  * This requires UART clocks to be enabled.  In order for this to work the
 460  * caller must ensure that the gd pointer is valid.
 461  */
 462 void preloader_console_init(void)
 463 {
 464         gd->bd = &bdata;
 465         gd->baudrate = CONFIG_BAUDRATE;
 466
 467         serial_init();          /* serial communications setup */
 468
 469         gd->have_console = 1;
 470
 471         puts("\nU-Boot SPL " PLAIN_VERSION " (" U_BOOT_DATE " - " \
 472                         U_BOOT_TIME ")\n");
 473 #ifdef CONFIG_SPL_DISPLAY_PRINT
 474         spl_display_print();
 475 #endif
 476 }
 477
 478 /**
 479  * spl_relocate_stack_gd() - Relocate stack ready for board_init_r() execution
 480  *
 481  * Sometimes board_init_f() runs with a stack in SRAM but we want to use SDRAM
 482  * for the main board_init_r() execution. This is typically because we need
 483  * more stack space for things like the MMC sub-system.
 484  *
 485  * This function calculates the stack position, copies the global_data into
 486  * place, sets the new gd (except for ARM, for which setting GD within a C
 487  * function may not always work) and returns the new stack position. The
 488  * caller is responsible for setting up the sp register and, in the case
 489  * of ARM, setting up gd.
 490  *
 491  * All of this is done using the same layout and alignments as done in
 492  * board_init_f_init_reserve() / board_init_f_alloc_reserve().
 493  *
 494  * @return new stack location, or 0 to use the same stack
 495  */
 496 ulong spl_relocate_stack_gd(void)
 497 {
 498 #ifdef CONFIG_SPL_STACK_R
 499         gd_t *new_gd;
 500         ulong ptr = CONFIG_SPL_STACK_R_ADDR;
 501
 502 #ifdef CONFIG_SPL_SYS_MALLOC_SIMPLE
 503         if (CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN) {
 504                 ptr -= CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN;
 505                 gd->malloc_base = ptr;
 506                 gd->malloc_limit = CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN;
 507                 gd->malloc_ptr = 0;
 508         }
 509 #endif
 510         /* Get stack position: use 8-byte alignment for ABI compliance */
 511         ptr = CONFIG_SPL_STACK_R_ADDR - roundup(sizeof(gd_t),16);
 512         new_gd = (gd_t *)ptr;
 513         memcpy(new_gd, (void *)gd, sizeof(gd_t));
 514 #if !defined(CONFIG_ARM)
 515         gd = new_gd;
 516 #endif
 517         return ptr;
 518 #else
 519         return 0;
 520 #endif
 521 }