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