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
  33 /* Define board data structure */
  34 static bd_t bdata __attribute__ ((section(".data")));
  35
  36 /*
  37  * Board-specific Platform code can reimplement show_boot_progress () if needed
  38  */
  39 __weak void show_boot_progress(int val) {}
  40
  41 /*
  42  * Default function to determine if u-boot or the OS should
  43  * be started. This implementation always returns 1.
  44  *
  45  * Please implement your own board specific funcion to do this.
  46  *
  47  * RETURN
  48  * 0 to not start u-boot
  49  * positive if u-boot should start
  50  */
  51 #ifdef CONFIG_SPL_OS_BOOT
  52 __weak int spl_start_uboot(void)
  53 {
  54         puts("SPL: Please implement spl_start_uboot() for your board\n");
  55         puts("SPL: Direct Linux boot not active!\n");
  56         return 1;
  57 }
  58
  59 /*
  60  * Weak default function for arch specific zImage check. Return zero
  61  * and fill start and end address if image is recognized.
  62  */
  63 int __weak bootz_setup(ulong image, ulong *start, ulong *end)
  64 {
  65          return 1;
  66 }
  67 #endif
  68
  69 /*
  70  * Weak default function for board specific cleanup/preparation before
  71  * Linux boot. Some boards/platforms might not need it, so just provide
  72  * an empty stub here.
  73  */
  74 __weak void spl_board_prepare_for_linux(void)
  75 {
  76         /* Nothing to do! */
  77 }
  78
  79 __weak void spl_board_prepare_for_boot(void)
  80 {
  81         /* Nothing to do! */
  82 }
  83
  84 void spl_set_header_raw_uboot(struct spl_image_info *spl_image)
  85 {
  86         spl_image->size = CONFIG_SYS_MONITOR_LEN;
  87         spl_image->entry_point = CONFIG_SYS_UBOOT_START;
  88         spl_image->load_addr = CONFIG_SYS_TEXT_BASE;
  89         spl_image->os = IH_OS_U_BOOT;
  90         spl_image->name = "U-Boot";
  91 }
  92
  93 int spl_parse_image_header(struct spl_image_info *spl_image,
  94                            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%lx 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 #endif
 133
 134 #ifdef CONFIG_SPL_OS_BOOT
 135                 ulong start, end;
 136
 137                 if (!bootz_setup((ulong)header, &start, &end)) {
 138                         spl_image->name = "Linux";
 139                         spl_image->os = IH_OS_LINUX;
 140                         spl_image->load_addr = CONFIG_SYS_LOAD_ADDR;
 141                         spl_image->entry_point = CONFIG_SYS_LOAD_ADDR;
 142                         spl_image->size = end - start;
 143                         debug("spl: payload zImage, load addr: 0x%lx size: %d\n",
 144                               spl_image->load_addr, spl_image->size);
 145                         return 0;
 146                 }
 147 #endif
 148
 149 #ifdef CONFIG_SPL_ABORT_ON_RAW_IMAGE
 150                 /* Signature not found, proceed to other boot methods. */
 151                 return -EINVAL;
 152 #else
 153                 /* Signature not found - assume u-boot.bin */
 154                 debug("mkimage signature not found - ih_magic = %x\n",
 155                         header->ih_magic);
 156                 spl_set_header_raw_uboot(spl_image);
 157 #endif
 158         }
 159         return 0;
 160 }
 161
 162 __weak void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image)
 163 {
 164         typedef void __noreturn (*image_entry_noargs_t)(void);
 165
 166         image_entry_noargs_t image_entry =
 167                 (image_entry_noargs_t)spl_image->entry_point;
 168
 169         debug("image entry point: 0x%lX\n", spl_image->entry_point);
 170 #if defined(CONFIG_ARMV8_SPIN_TABLE) && defined(CONFIG_ARMV8_MULTIENTRY)
 171         /*
 172          * Release all slave cores from CPU_RELEASE_ADDR so they could
 173          * arrive to the spin-table code in start.S of the u-boot
 174          */
 175         *(ulong *)CPU_RELEASE_ADDR = (ulong)spl_image->entry_point;
 176 #endif
 177
 178         image_entry();
 179 }
 180
 181 int spl_init(void)
 182 {
 183         int ret;
 184
 185         debug("spl_init()\n");
 186 /*
 187  * with CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN we set malloc_base and
 188  * malloc_limit in spl_relocate_stack_gd
 189  */
 190 #if defined(CONFIG_SYS_MALLOC_F_LEN) && \
 191         !defined(CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN)
 192 #ifdef CONFIG_MALLOC_F_ADDR
 193         gd->malloc_base = CONFIG_MALLOC_F_ADDR;
 194 #endif
 195         gd->malloc_limit = CONFIG_SYS_MALLOC_F_LEN;
 196         gd->malloc_ptr = 0;
 197 #endif
 198         if (CONFIG_IS_ENABLED(OF_CONTROL) && !CONFIG_IS_ENABLED(OF_PLATDATA)) {
 199                 ret = fdtdec_setup();
 200                 if (ret) {
 201                         debug("fdtdec_setup() returned error %d\n", ret);
 202                         return ret;
 203                 }
 204         }
 205         if (IS_ENABLED(CONFIG_SPL_DM)) {
 206                 /* With CONFIG_SPL_OF_PLATDATA, bring in all devices */
 207                 ret = dm_init_and_scan(!CONFIG_IS_ENABLED(OF_PLATDATA));
 208                 if (ret) {
 209                         debug("dm_init_and_scan() returned error %d\n", ret);
 210                         return ret;
 211                 }
 212         }
 213         gd->flags |= GD_FLG_SPL_INIT;
 214
 215         return 0;
 216 }
 217
 218 #ifndef BOOT_DEVICE_NONE
 219 #define BOOT_DEVICE_NONE 0xdeadbeef
 220 #endif
 221
 222 __weak void board_boot_order(u32 *spl_boot_list)
 223 {
 224         spl_boot_list[0] = spl_boot_device();
 225 }
 226
 227 static struct spl_image_loader *spl_ll_find_loader(uint boot_device)
 228 {
 229         struct spl_image_loader *drv =
 230                 ll_entry_start(struct spl_image_loader, spl_image_loader);
 231         const int n_ents =
 232                 ll_entry_count(struct spl_image_loader, spl_image_loader);
 233         struct spl_image_loader *entry;
 234
 235         for (entry = drv; entry != drv + n_ents; entry++) {
 236                 if (boot_device == entry->boot_device)
 237                         return entry;
 238         }
 239
 240         /* Not found */
 241         return NULL;
 242 }
 243
 244 static int spl_load_image(struct spl_image_info *spl_image,
 245                           struct spl_image_loader *loader)
 246 {
 247         struct spl_boot_device bootdev;
 248
 249         bootdev.boot_device = loader->boot_device;
 250         bootdev.boot_device_name = NULL;
 251
 252         return loader->load_image(spl_image, &bootdev);
 253 }
 254
 255 /**
 256  * boot_from_devices() - Try loading an booting U-Boot from a list of devices
 257  *
 258  * @spl_image: Place to put the image details if successful
 259  * @spl_boot_list: List of boot devices to try
 260  * @count: Number of elements in spl_boot_list
 261  * @return 0 if OK, -ve on error
 262  */
 263 static int boot_from_devices(struct spl_image_info *spl_image,
 264                              u32 spl_boot_list[], int count)
 265 {
 266         int i;
 267
 268         for (i = 0; i < count && spl_boot_list[i] != BOOT_DEVICE_NONE; i++) {
 269                 struct spl_image_loader *loader;
 270
 271                 loader = spl_ll_find_loader(spl_boot_list[i]);
 272 #if defined(CONFIG_SPL_SERIAL_SUPPORT) && defined(CONFIG_SPL_LIBCOMMON_SUPPORT)
 273                 if (loader)
 274                         printf("Trying to boot from %s\n", loader->name);
 275                 else
 276                         puts("SPL: Unsupported Boot Device!\n");
 277 #endif
 278                 if (loader && !spl_load_image(spl_image, loader))
 279                         return 0;
 280         }
 281
 282         return -ENODEV;
 283 }
 284
 285 void board_init_r(gd_t *dummy1, ulong dummy2)
 286 {
 287         u32 spl_boot_list[] = {
 288                 BOOT_DEVICE_NONE,
 289                 BOOT_DEVICE_NONE,
 290                 BOOT_DEVICE_NONE,
 291                 BOOT_DEVICE_NONE,
 292                 BOOT_DEVICE_NONE,
 293         };
 294         struct spl_image_info spl_image;
 295
 296         debug(">>spl:board_init_r()\n");
 297
 298 #if defined(CONFIG_SYS_SPL_MALLOC_START)
 299         mem_malloc_init(CONFIG_SYS_SPL_MALLOC_START,
 300                         CONFIG_SYS_SPL_MALLOC_SIZE);
 301         gd->flags |= GD_FLG_FULL_MALLOC_INIT;
 302 #endif
 303         if (!(gd->flags & GD_FLG_SPL_INIT)) {
 304                 if (spl_init())
 305                         hang();
 306         }
 307 #ifndef CONFIG_PPC
 308         /*
 309          * timer_init() does not exist on PPC systems. The timer is initialized
 310          * and enabled (decrementer) in interrupt_init() here.
 311          */
 312         timer_init();
 313 #endif
 314
 315 #ifdef CONFIG_SPL_BOARD_INIT
 316         spl_board_init();
 317 #endif
 318
 319         memset(&spl_image, '\0', sizeof(spl_image));
 320         board_boot_order(spl_boot_list);
 321
 322         if (boot_from_devices(&spl_image, spl_boot_list,
 323                               ARRAY_SIZE(spl_boot_list))) {
 324                 puts("SPL: failed to boot from all boot devices\n");
 325                 hang();
 326         }
 327
 328         switch (spl_image.os) {
 329         case IH_OS_U_BOOT:
 330                 debug("Jumping to U-Boot\n");
 331                 break;
 332 #ifdef CONFIG_SPL_OS_BOOT
 333         case IH_OS_LINUX:
 334                 debug("Jumping to Linux\n");
 335                 spl_board_prepare_for_linux();
 336                 jump_to_image_linux(&spl_image,
 337                                     (void *)CONFIG_SYS_SPL_ARGS_ADDR);
 338 #endif
 339         default:
 340                 debug("Unsupported OS image.. Jumping nevertheless..\n");
 341         }
 342 #if defined(CONFIG_SYS_MALLOC_F_LEN) && !defined(CONFIG_SYS_SPL_MALLOC_SIZE)
 343         debug("SPL malloc() used %#lx bytes (%ld KB)\n", gd->malloc_ptr,
 344               gd->malloc_ptr / 1024);
 345 #endif
 346
 347         debug("loaded - jumping to U-Boot...\n");
 348         spl_board_prepare_for_boot();
 349         jump_to_image_no_args(&spl_image);
 350 }
 351
 352 /*
 353  * This requires UART clocks to be enabled.  In order for this to work the
 354  * caller must ensure that the gd pointer is valid.
 355  */
 356 void preloader_console_init(void)
 357 {
 358         gd->bd = &bdata;
 359         gd->baudrate = CONFIG_BAUDRATE;
 360
 361         serial_init();          /* serial communications setup */
 362
 363         gd->have_console = 1;
 364
 365         puts("\nU-Boot SPL " PLAIN_VERSION " (" U_BOOT_DATE " - " \
 366                         U_BOOT_TIME ")\n");
 367 #ifdef CONFIG_SPL_DISPLAY_PRINT
 368         spl_display_print();
 369 #endif
 370 }
 371
 372 /**
 373  * spl_relocate_stack_gd() - Relocate stack ready for board_init_r() execution
 374  *
 375  * Sometimes board_init_f() runs with a stack in SRAM but we want to use SDRAM
 376  * for the main board_init_r() execution. This is typically because we need
 377  * more stack space for things like the MMC sub-system.
 378  *
 379  * This function calculates the stack position, copies the global_data into
 380  * place, sets the new gd (except for ARM, for which setting GD within a C
 381  * function may not always work) and returns the new stack position. The
 382  * caller is responsible for setting up the sp register and, in the case
 383  * of ARM, setting up gd.
 384  *
 385  * All of this is done using the same layout and alignments as done in
 386  * board_init_f_init_reserve() / board_init_f_alloc_reserve().
 387  *
 388  * @return new stack location, or 0 to use the same stack
 389  */
 390 ulong spl_relocate_stack_gd(void)
 391 {
 392 #ifdef CONFIG_SPL_STACK_R
 393         gd_t *new_gd;
 394         ulong ptr = CONFIG_SPL_STACK_R_ADDR;
 395
 396 #ifdef CONFIG_SPL_SYS_MALLOC_SIMPLE
 397         if (CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN) {
 398                 ptr -= CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN;
 399                 gd->malloc_base = ptr;
 400                 gd->malloc_limit = CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN;
 401                 gd->malloc_ptr = 0;
 402         }
 403 #endif
 404         /* Get stack position: use 8-byte alignment for ABI compliance */
 405         ptr = CONFIG_SPL_STACK_R_ADDR - roundup(sizeof(gd_t),16);
 406         new_gd = (gd_t *)ptr;
 407         memcpy(new_gd, (void *)gd, sizeof(gd_t));
 408 #if CONFIG_IS_ENABLED(DM)
 409         dm_fixup_for_gd_move(new_gd);
 410 #endif
 411 #if !defined(CONFIG_ARM)
 412         gd = new_gd;
 413 #endif
 414         return ptr;
 415 #else
 416         return 0;
 417 #endif
 418 }