3 * Texas Instruments, <www.ti.com>
5 * Aneesh V <aneesh@ti.com>
7 * SPDX-License-Identifier: GPL-2.0+
12 #include <asm/u-boot.h>
19 #include <linux/compiler.h>
20 #include <fdt_support.h>
22 DECLARE_GLOBAL_DATA_PTR;
24 #ifndef CONFIG_SYS_UBOOT_START
25 #define CONFIG_SYS_UBOOT_START CONFIG_SYS_TEXT_BASE
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)
32 u32 *boot_params_ptr = NULL;
34 /* Define board data structure */
35 static bd_t bdata __attribute__ ((section(".data")));
38 * Board-specific Platform code can reimplement show_boot_progress () if needed
40 __weak void show_boot_progress(int val) {}
43 * Default function to determine if u-boot or the OS should
44 * be started. This implementation always returns 1.
46 * Please implement your own board specific funcion to do this.
49 * 0 to not start u-boot
50 * positive if u-boot should start
52 #ifdef CONFIG_SPL_OS_BOOT
53 __weak int spl_start_uboot(void)
55 puts("SPL: Please implement spl_start_uboot() for your board\n");
56 puts("SPL: Direct Linux boot not active!\n");
60 /* weak default platform specific function to initialize
63 __weak int dram_init_banksize(void)
69 * Weak default function for arch specific zImage check. Return zero
70 * and fill start and end address if image is recognized.
72 int __weak bootz_setup(ulong image, ulong *start, ulong *end)
78 void spl_fixup_fdt(void)
80 #if defined(CONFIG_SPL_OF_LIBFDT) && defined(CONFIG_SYS_SPL_ARGS_ADDR)
81 void *fdt_blob = (void *)CONFIG_SYS_SPL_ARGS_ADDR;
84 err = fdt_check_header(fdt_blob);
86 printf("fdt_root: %s\n", fdt_strerror(err));
90 /* fixup the memory dt node */
91 err = fdt_shrink_to_minimum(fdt_blob, 0);
93 printf("spl: fdt_shrink_to_minimum err - %d\n", err);
97 err = arch_fixup_fdt(fdt_blob);
99 printf("spl: arch_fixup_fdt err - %d\n", err);
106 * Weak default function for board specific cleanup/preparation before
107 * Linux boot. Some boards/platforms might not need it, so just provide
108 * an empty stub here.
110 __weak void spl_board_prepare_for_linux(void)
115 __weak void spl_board_prepare_for_boot(void)
120 void spl_set_header_raw_uboot(struct spl_image_info *spl_image)
122 spl_image->size = CONFIG_SYS_MONITOR_LEN;
123 spl_image->entry_point = CONFIG_SYS_UBOOT_START;
124 spl_image->load_addr = CONFIG_SYS_TEXT_BASE;
125 spl_image->os = IH_OS_U_BOOT;
126 spl_image->name = "U-Boot";
129 int spl_parse_image_header(struct spl_image_info *spl_image,
130 const struct image_header *header)
132 if (image_get_magic(header) == IH_MAGIC) {
133 #ifdef CONFIG_SPL_LEGACY_IMAGE_SUPPORT
134 u32 header_size = sizeof(struct image_header);
136 if (spl_image->flags & SPL_COPY_PAYLOAD_ONLY) {
138 * On some system (e.g. powerpc), the load-address and
139 * entry-point is located at address 0. We can't load
140 * to 0-0x40. So skip header in this case.
142 spl_image->load_addr = image_get_load(header);
143 spl_image->entry_point = image_get_ep(header);
144 spl_image->size = image_get_data_size(header);
146 spl_image->entry_point = image_get_load(header);
147 /* Load including the header */
148 spl_image->load_addr = spl_image->entry_point -
150 spl_image->size = image_get_data_size(header) +
153 spl_image->os = image_get_os(header);
154 spl_image->name = image_get_name(header);
155 debug("spl: payload image: %.*s load addr: 0x%lx size: %d\n",
156 (int)sizeof(spl_image->name), spl_image->name,
157 spl_image->load_addr, spl_image->size);
159 /* LEGACY image not supported */
160 debug("Legacy boot image support not enabled, proceeding to other boot methods");
164 #ifdef CONFIG_SPL_PANIC_ON_RAW_IMAGE
166 * CONFIG_SPL_PANIC_ON_RAW_IMAGE is defined when the
167 * code which loads images in SPL cannot guarantee that
168 * absolutely all read errors will be reported.
169 * An example is the LPC32XX MLC NAND driver, which
170 * will consider that a completely unreadable NAND block
171 * is bad, and thus should be skipped silently.
173 panic("** no mkimage signature but raw image not supported");
176 #ifdef CONFIG_SPL_OS_BOOT
179 if (!bootz_setup((ulong)header, &start, &end)) {
180 spl_image->name = "Linux";
181 spl_image->os = IH_OS_LINUX;
182 spl_image->load_addr = CONFIG_SYS_LOAD_ADDR;
183 spl_image->entry_point = CONFIG_SYS_LOAD_ADDR;
184 spl_image->size = end - start;
185 debug("spl: payload zImage, load addr: 0x%lx size: %d\n",
186 spl_image->load_addr, spl_image->size);
191 #ifdef CONFIG_SPL_RAW_IMAGE_SUPPORT
192 /* Signature not found - assume u-boot.bin */
193 debug("mkimage signature not found - ih_magic = %x\n",
195 spl_set_header_raw_uboot(spl_image);
197 /* RAW image not supported, proceed to other boot methods. */
198 debug("Raw boot image support not enabled, proceeding to other boot methods");
206 __weak void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image)
208 typedef void __noreturn (*image_entry_noargs_t)(void);
210 image_entry_noargs_t image_entry =
211 (image_entry_noargs_t)spl_image->entry_point;
213 debug("image entry point: 0x%lX\n", spl_image->entry_point);
217 static int spl_common_init(bool setup_malloc)
221 debug("spl_early_init()\n");
223 #if CONFIG_VAL(SYS_MALLOC_F_LEN)
225 #ifdef CONFIG_MALLOC_F_ADDR
226 gd->malloc_base = CONFIG_MALLOC_F_ADDR;
228 gd->malloc_limit = CONFIG_VAL(SYS_MALLOC_F_LEN);
232 ret = bootstage_init(true);
234 debug("%s: Failed to set up bootstage: ret=%d\n", __func__,
238 bootstage_mark_name(BOOTSTAGE_ID_START_SPL, "spl");
239 if (CONFIG_IS_ENABLED(OF_CONTROL) && !CONFIG_IS_ENABLED(OF_PLATDATA)) {
240 ret = fdtdec_setup();
242 debug("fdtdec_setup() returned error %d\n", ret);
246 if (IS_ENABLED(CONFIG_SPL_DM)) {
247 bootstage_start(BOOTSTATE_ID_ACCUM_DM_SPL, "dm_spl");
248 /* With CONFIG_SPL_OF_PLATDATA, bring in all devices */
249 ret = dm_init_and_scan(!CONFIG_IS_ENABLED(OF_PLATDATA));
250 bootstage_accum(BOOTSTATE_ID_ACCUM_DM_SPL);
252 debug("dm_init_and_scan() returned error %d\n", ret);
260 int spl_early_init(void)
264 ret = spl_common_init(true);
267 gd->flags |= GD_FLG_SPL_EARLY_INIT;
275 bool setup_malloc = !(IS_ENABLED(CONFIG_SPL_STACK_R) &&
276 IS_ENABLED(CONFIG_SPL_SYS_MALLOC_SIMPLE));
278 if (!(gd->flags & GD_FLG_SPL_EARLY_INIT)) {
279 ret = spl_common_init(setup_malloc);
283 gd->flags |= GD_FLG_SPL_INIT;
288 #ifndef BOOT_DEVICE_NONE
289 #define BOOT_DEVICE_NONE 0xdeadbeef
292 __weak void board_boot_order(u32 *spl_boot_list)
294 spl_boot_list[0] = spl_boot_device();
297 static struct spl_image_loader *spl_ll_find_loader(uint boot_device)
299 struct spl_image_loader *drv =
300 ll_entry_start(struct spl_image_loader, spl_image_loader);
302 ll_entry_count(struct spl_image_loader, spl_image_loader);
303 struct spl_image_loader *entry;
305 for (entry = drv; entry != drv + n_ents; entry++) {
306 if (boot_device == entry->boot_device)
314 static int spl_load_image(struct spl_image_info *spl_image,
315 struct spl_image_loader *loader)
317 struct spl_boot_device bootdev;
319 bootdev.boot_device = loader->boot_device;
320 bootdev.boot_device_name = NULL;
322 return loader->load_image(spl_image, &bootdev);
326 * boot_from_devices() - Try loading an booting U-Boot from a list of devices
328 * @spl_image: Place to put the image details if successful
329 * @spl_boot_list: List of boot devices to try
330 * @count: Number of elements in spl_boot_list
331 * @return 0 if OK, -ve on error
333 static int boot_from_devices(struct spl_image_info *spl_image,
334 u32 spl_boot_list[], int count)
338 for (i = 0; i < count && spl_boot_list[i] != BOOT_DEVICE_NONE; i++) {
339 struct spl_image_loader *loader;
341 loader = spl_ll_find_loader(spl_boot_list[i]);
342 #if defined(CONFIG_SPL_SERIAL_SUPPORT) && defined(CONFIG_SPL_LIBCOMMON_SUPPORT)
344 printf("Trying to boot from %s\n", loader->name);
346 puts("SPL: Unsupported Boot Device!\n");
348 if (loader && !spl_load_image(spl_image, loader))
355 void board_init_r(gd_t *dummy1, ulong dummy2)
357 u32 spl_boot_list[] = {
364 struct spl_image_info spl_image;
366 debug(">>spl:board_init_r()\n");
368 #ifdef CONFIG_SPL_OS_BOOT
369 dram_init_banksize();
372 #if defined(CONFIG_SYS_SPL_MALLOC_START)
373 mem_malloc_init(CONFIG_SYS_SPL_MALLOC_START,
374 CONFIG_SYS_SPL_MALLOC_SIZE);
375 gd->flags |= GD_FLG_FULL_MALLOC_INIT;
377 if (!(gd->flags & GD_FLG_SPL_INIT)) {
383 * timer_init() does not exist on PPC systems. The timer is initialized
384 * and enabled (decrementer) in interrupt_init() here.
389 #ifdef CONFIG_SPL_BOARD_INIT
393 memset(&spl_image, '\0', sizeof(spl_image));
394 #ifdef CONFIG_SYS_SPL_ARGS_ADDR
395 spl_image.arg = (void *)CONFIG_SYS_SPL_ARGS_ADDR;
397 board_boot_order(spl_boot_list);
399 if (boot_from_devices(&spl_image, spl_boot_list,
400 ARRAY_SIZE(spl_boot_list))) {
401 puts("SPL: failed to boot from all boot devices\n");
405 #ifdef CONFIG_CPU_V7M
406 spl_image.entry_point |= 0x1;
408 switch (spl_image.os) {
410 debug("Jumping to U-Boot\n");
412 #ifdef CONFIG_SPL_OS_BOOT
414 debug("Jumping to Linux\n");
416 spl_board_prepare_for_linux();
417 jump_to_image_linux(&spl_image);
420 debug("Unsupported OS image.. Jumping nevertheless..\n");
422 #if CONFIG_VAL(SYS_MALLOC_F_LEN) && !defined(CONFIG_SYS_SPL_MALLOC_SIZE)
423 debug("SPL malloc() used %#lx bytes (%ld KB)\n", gd->malloc_ptr,
424 gd->malloc_ptr / 1024);
427 if (IS_ENABLED(CONFIG_SPL_ATF_SUPPORT)) {
428 debug("loaded - jumping to U-Boot via ATF BL31.\n");
432 debug("loaded - jumping to U-Boot...\n");
433 #ifdef CONFIG_BOOTSTAGE_STASH
436 bootstage_mark_name(BOOTSTAGE_ID_END_SPL, "end_spl");
437 ret = bootstage_stash((void *)CONFIG_BOOTSTAGE_STASH_ADDR,
438 CONFIG_BOOTSTAGE_STASH_SIZE);
440 debug("Failed to stash bootstage: err=%d\n", ret);
442 spl_board_prepare_for_boot();
443 jump_to_image_no_args(&spl_image);
447 * This requires UART clocks to be enabled. In order for this to work the
448 * caller must ensure that the gd pointer is valid.
450 void preloader_console_init(void)
452 gd->baudrate = CONFIG_BAUDRATE;
454 serial_init(); /* serial communications setup */
456 gd->have_console = 1;
458 puts("\nU-Boot SPL " PLAIN_VERSION " (" U_BOOT_DATE " - " \
460 #ifdef CONFIG_SPL_DISPLAY_PRINT
466 * spl_relocate_stack_gd() - Relocate stack ready for board_init_r() execution
468 * Sometimes board_init_f() runs with a stack in SRAM but we want to use SDRAM
469 * for the main board_init_r() execution. This is typically because we need
470 * more stack space for things like the MMC sub-system.
472 * This function calculates the stack position, copies the global_data into
473 * place, sets the new gd (except for ARM, for which setting GD within a C
474 * function may not always work) and returns the new stack position. The
475 * caller is responsible for setting up the sp register and, in the case
476 * of ARM, setting up gd.
478 * All of this is done using the same layout and alignments as done in
479 * board_init_f_init_reserve() / board_init_f_alloc_reserve().
481 * @return new stack location, or 0 to use the same stack
483 ulong spl_relocate_stack_gd(void)
485 #ifdef CONFIG_SPL_STACK_R
487 ulong ptr = CONFIG_SPL_STACK_R_ADDR;
489 #if defined(CONFIG_SPL_SYS_MALLOC_SIMPLE) && CONFIG_SPL_SYS_MALLOC_F_LEN
490 if (CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN) {
491 ptr -= CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN;
492 gd->malloc_base = ptr;
493 gd->malloc_limit = CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN;
497 /* Get stack position: use 8-byte alignment for ABI compliance */
498 ptr = CONFIG_SPL_STACK_R_ADDR - roundup(sizeof(gd_t),16);
499 new_gd = (gd_t *)ptr;
500 memcpy(new_gd, (void *)gd, sizeof(gd_t));
501 #if CONFIG_IS_ENABLED(DM)
502 dm_fixup_for_gd_move(new_gd);
504 #if !defined(CONFIG_ARM)