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