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         image_entry();
 171 }
 172
 173 int spl_init(void)
 174 {
 175         int ret;
 176
 177         debug("spl_init()\n");
 178 /*
 179  * with CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN we set malloc_base and
 180  * malloc_limit in spl_relocate_stack_gd
 181  */
 182 #if defined(CONFIG_SYS_MALLOC_F_LEN) && \
 183         !defined(CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN)
 184 #ifdef CONFIG_MALLOC_F_ADDR
 185         gd->malloc_base = CONFIG_MALLOC_F_ADDR;
 186 #endif
 187         gd->malloc_limit = CONFIG_SYS_MALLOC_F_LEN;
 188         gd->malloc_ptr = 0;
 189 #endif
 190         if (CONFIG_IS_ENABLED(OF_CONTROL) && !CONFIG_IS_ENABLED(OF_PLATDATA)) {
 191                 ret = fdtdec_setup();
 192                 if (ret) {
 193                         debug("fdtdec_setup() returned error %d\n", ret);
 194                         return ret;
 195                 }
 196         }
 197         if (IS_ENABLED(CONFIG_SPL_DM)) {
 198                 /* With CONFIG_SPL_OF_PLATDATA, bring in all devices */
 199                 ret = dm_init_and_scan(!CONFIG_IS_ENABLED(OF_PLATDATA));
 200                 if (ret) {
 201                         debug("dm_init_and_scan() returned error %d\n", ret);
 202                         return ret;
 203                 }
 204         }
 205         gd->flags |= GD_FLG_SPL_INIT;
 206
 207         return 0;
 208 }
 209
 210 #ifndef BOOT_DEVICE_NONE
 211 #define BOOT_DEVICE_NONE 0xdeadbeef
 212 #endif
 213
 214 __weak void board_boot_order(u32 *spl_boot_list)
 215 {
 216         spl_boot_list[0] = spl_boot_device();
 217 }
 218
 219 static struct spl_image_loader *spl_ll_find_loader(uint boot_device)
 220 {
 221         struct spl_image_loader *drv =
 222                 ll_entry_start(struct spl_image_loader, spl_image_loader);
 223         const int n_ents =
 224                 ll_entry_count(struct spl_image_loader, spl_image_loader);
 225         struct spl_image_loader *entry;
 226
 227         for (entry = drv; entry != drv + n_ents; entry++) {
 228                 if (boot_device == entry->boot_device)
 229                         return entry;
 230         }
 231
 232         /* Not found */
 233         return NULL;
 234 }
 235
 236 static int spl_load_image(struct spl_image_info *spl_image,
 237                           struct spl_image_loader *loader)
 238 {
 239         struct spl_boot_device bootdev;
 240
 241         bootdev.boot_device = loader->boot_device;
 242         bootdev.boot_device_name = NULL;
 243
 244         return loader->load_image(spl_image, &bootdev);
 245 }
 246
 247 /**
 248  * boot_from_devices() - Try loading an booting U-Boot from a list of devices
 249  *
 250  * @spl_image: Place to put the image details if successful
 251  * @spl_boot_list: List of boot devices to try
 252  * @count: Number of elements in spl_boot_list
 253  * @return 0 if OK, -ve on error
 254  */
 255 static int boot_from_devices(struct spl_image_info *spl_image,
 256                              u32 spl_boot_list[], int count)
 257 {
 258         int i;
 259
 260         for (i = 0; i < count && spl_boot_list[i] != BOOT_DEVICE_NONE; i++) {
 261                 struct spl_image_loader *loader;
 262
 263                 loader = spl_ll_find_loader(spl_boot_list[i]);
 264 #if defined(CONFIG_SPL_SERIAL_SUPPORT) && defined(CONFIG_SPL_LIBCOMMON_SUPPORT)
 265                 if (loader)
 266                         printf("Trying to boot from %s\n", loader->name);
 267                 else
 268                         puts("SPL: Unsupported Boot Device!\n");
 269 #endif
 270                 if (loader && !spl_load_image(spl_image, loader))
 271                         return 0;
 272         }
 273
 274         return -ENODEV;
 275 }
 276
 277 void board_init_r(gd_t *dummy1, ulong dummy2)
 278 {
 279         u32 spl_boot_list[] = {
 280                 BOOT_DEVICE_NONE,
 281                 BOOT_DEVICE_NONE,
 282                 BOOT_DEVICE_NONE,
 283                 BOOT_DEVICE_NONE,
 284                 BOOT_DEVICE_NONE,
 285         };
 286         struct spl_image_info spl_image;
 287
 288         debug(">>spl:board_init_r()\n");
 289
 290 #if defined(CONFIG_SYS_SPL_MALLOC_START)
 291         mem_malloc_init(CONFIG_SYS_SPL_MALLOC_START,
 292                         CONFIG_SYS_SPL_MALLOC_SIZE);
 293         gd->flags |= GD_FLG_FULL_MALLOC_INIT;
 294 #endif
 295         if (!(gd->flags & GD_FLG_SPL_INIT)) {
 296                 if (spl_init())
 297                         hang();
 298         }
 299 #ifndef CONFIG_PPC
 300         /*
 301          * timer_init() does not exist on PPC systems. The timer is initialized
 302          * and enabled (decrementer) in interrupt_init() here.
 303          */
 304         timer_init();
 305 #endif
 306
 307 #ifdef CONFIG_SPL_BOARD_INIT
 308         spl_board_init();
 309 #endif
 310
 311         memset(&spl_image, '\0', sizeof(spl_image));
 312         board_boot_order(spl_boot_list);
 313
 314         if (boot_from_devices(&spl_image, spl_boot_list,
 315                               ARRAY_SIZE(spl_boot_list))) {
 316                 puts("SPL: failed to boot from all boot devices\n");
 317                 hang();
 318         }
 319
 320         switch (spl_image.os) {
 321         case IH_OS_U_BOOT:
 322                 debug("Jumping to U-Boot\n");
 323                 break;
 324 #ifdef CONFIG_SPL_OS_BOOT
 325         case IH_OS_LINUX:
 326                 debug("Jumping to Linux\n");
 327                 spl_board_prepare_for_linux();
 328                 jump_to_image_linux(&spl_image,
 329                                     (void *)CONFIG_SYS_SPL_ARGS_ADDR);
 330 #endif
 331         default:
 332                 debug("Unsupported OS image.. Jumping nevertheless..\n");
 333         }
 334 #if defined(CONFIG_SYS_MALLOC_F_LEN) && !defined(CONFIG_SYS_SPL_MALLOC_SIZE)
 335         debug("SPL malloc() used %#lx bytes (%ld KB)\n", gd->malloc_ptr,
 336               gd->malloc_ptr / 1024);
 337 #endif
 338
 339         debug("loaded - jumping to U-Boot...\n");
 340         spl_board_prepare_for_boot();
 341         jump_to_image_no_args(&spl_image);
 342 }
 343
 344 /*
 345  * This requires UART clocks to be enabled.  In order for this to work the
 346  * caller must ensure that the gd pointer is valid.
 347  */
 348 void preloader_console_init(void)
 349 {
 350         gd->bd = &bdata;
 351         gd->baudrate = CONFIG_BAUDRATE;
 352
 353         serial_init();          /* serial communications setup */
 354
 355         gd->have_console = 1;
 356
 357         puts("\nU-Boot SPL " PLAIN_VERSION " (" U_BOOT_DATE " - " \
 358                         U_BOOT_TIME ")\n");
 359 #ifdef CONFIG_SPL_DISPLAY_PRINT
 360         spl_display_print();
 361 #endif
 362 }
 363
 364 /**
 365  * spl_relocate_stack_gd() - Relocate stack ready for board_init_r() execution
 366  *
 367  * Sometimes board_init_f() runs with a stack in SRAM but we want to use SDRAM
 368  * for the main board_init_r() execution. This is typically because we need
 369  * more stack space for things like the MMC sub-system.
 370  *
 371  * This function calculates the stack position, copies the global_data into
 372  * place, sets the new gd (except for ARM, for which setting GD within a C
 373  * function may not always work) and returns the new stack position. The
 374  * caller is responsible for setting up the sp register and, in the case
 375  * of ARM, setting up gd.
 376  *
 377  * All of this is done using the same layout and alignments as done in
 378  * board_init_f_init_reserve() / board_init_f_alloc_reserve().
 379  *
 380  * @return new stack location, or 0 to use the same stack
 381  */
 382 ulong spl_relocate_stack_gd(void)
 383 {
 384 #ifdef CONFIG_SPL_STACK_R
 385         gd_t *new_gd;
 386         ulong ptr = CONFIG_SPL_STACK_R_ADDR;
 387
 388 #ifdef CONFIG_SPL_SYS_MALLOC_SIMPLE
 389         if (CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN) {
 390                 ptr -= CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN;
 391                 gd->malloc_base = ptr;
 392                 gd->malloc_limit = CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN;
 393                 gd->malloc_ptr = 0;
 394         }
 395 #endif
 396         /* Get stack position: use 8-byte alignment for ABI compliance */
 397         ptr = CONFIG_SPL_STACK_R_ADDR - roundup(sizeof(gd_t),16);
 398         new_gd = (gd_t *)ptr;
 399         memcpy(new_gd, (void *)gd, sizeof(gd_t));
 400 #if CONFIG_IS_ENABLED(DM)
 401         dm_fixup_for_gd_move(new_gd);
 402 #endif
 403 #if !defined(CONFIG_ARM)
 404         gd = new_gd;
 405 #endif
 406         return ptr;
 407 #else
 408         return 0;
 409 #endif
 410 }