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