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