3 * Texas Instruments, <www.ti.com>
5 * Aneesh V <aneesh@ti.com>
7 * SPDX-License-Identifier: GPL-2.0+
11 #include <binman_sym.h>
14 #include <asm/u-boot.h>
21 #include <linux/compiler.h>
22 #include <fdt_support.h>
24 DECLARE_GLOBAL_DATA_PTR;
26 #ifndef CONFIG_SYS_UBOOT_START
27 #define CONFIG_SYS_UBOOT_START CONFIG_SYS_TEXT_BASE
29 #ifndef CONFIG_SYS_MONITOR_LEN
30 /* Unknown U-Boot size, let's assume it will not be more than 200 KB */
31 #define CONFIG_SYS_MONITOR_LEN (200 * 1024)
34 u32 *boot_params_ptr = NULL;
36 /* See spl.h for information about this */
37 binman_sym_declare(ulong, u_boot_any, pos);
39 /* Define board data structure */
40 static bd_t bdata __attribute__ ((section(".data")));
43 * Board-specific Platform code can reimplement show_boot_progress () if needed
45 __weak void show_boot_progress(int val) {}
48 * Default function to determine if u-boot or the OS should
49 * be started. This implementation always returns 1.
51 * Please implement your own board specific funcion to do this.
54 * 0 to not start u-boot
55 * positive if u-boot should start
57 #ifdef CONFIG_SPL_OS_BOOT
58 __weak int spl_start_uboot(void)
60 puts("SPL: Please implement spl_start_uboot() for your board\n");
61 puts("SPL: Direct Linux boot not active!\n");
65 /* weak default platform specific function to initialize
68 __weak int dram_init_banksize(void)
74 * Weak default function for arch specific zImage check. Return zero
75 * and fill start and end address if image is recognized.
77 int __weak bootz_setup(ulong image, ulong *start, ulong *end)
83 void spl_fixup_fdt(void)
85 #if defined(CONFIG_SPL_OF_LIBFDT) && defined(CONFIG_SYS_SPL_ARGS_ADDR)
86 void *fdt_blob = (void *)CONFIG_SYS_SPL_ARGS_ADDR;
89 err = fdt_check_header(fdt_blob);
91 printf("fdt_root: %s\n", fdt_strerror(err));
95 /* fixup the memory dt node */
96 err = fdt_shrink_to_minimum(fdt_blob, 0);
98 printf("spl: fdt_shrink_to_minimum err - %d\n", err);
102 err = arch_fixup_fdt(fdt_blob);
104 printf("spl: arch_fixup_fdt err - %d\n", err);
111 * Weak default function for board specific cleanup/preparation before
112 * Linux boot. Some boards/platforms might not need it, so just provide
113 * an empty stub here.
115 __weak void spl_board_prepare_for_linux(void)
120 __weak void spl_board_prepare_for_boot(void)
125 void spl_set_header_raw_uboot(struct spl_image_info *spl_image)
127 ulong u_boot_pos = binman_sym(ulong, u_boot_any, pos);
129 spl_image->size = CONFIG_SYS_MONITOR_LEN;
132 * Binman error cases: address of the end of the previous region or the
133 * start of the image's entry area (usually 0) if there is no previous
136 if (u_boot_pos && u_boot_pos != BINMAN_SYM_MISSING) {
137 /* Binman does not support separated entry addresses */
138 spl_image->entry_point = u_boot_pos;
139 spl_image->load_addr = u_boot_pos;
141 spl_image->entry_point = CONFIG_SYS_UBOOT_START;
142 spl_image->load_addr = CONFIG_SYS_TEXT_BASE;
144 spl_image->os = IH_OS_U_BOOT;
145 spl_image->name = "U-Boot";
148 int spl_parse_image_header(struct spl_image_info *spl_image,
149 const struct image_header *header)
151 if (image_get_magic(header) == IH_MAGIC) {
152 #ifdef CONFIG_SPL_LEGACY_IMAGE_SUPPORT
153 u32 header_size = sizeof(struct image_header);
155 if (spl_image->flags & SPL_COPY_PAYLOAD_ONLY) {
157 * On some system (e.g. powerpc), the load-address and
158 * entry-point is located at address 0. We can't load
159 * to 0-0x40. So skip header in this case.
161 spl_image->load_addr = image_get_load(header);
162 spl_image->entry_point = image_get_ep(header);
163 spl_image->size = image_get_data_size(header);
165 spl_image->entry_point = image_get_load(header);
166 /* Load including the header */
167 spl_image->load_addr = spl_image->entry_point -
169 spl_image->size = image_get_data_size(header) +
172 spl_image->os = image_get_os(header);
173 spl_image->name = image_get_name(header);
174 debug("spl: payload image: %.*s load addr: 0x%lx size: %d\n",
175 IH_NMLEN, spl_image->name,
176 spl_image->load_addr, spl_image->size);
178 /* LEGACY image not supported */
179 debug("Legacy boot image support not enabled, proceeding to other boot methods\n");
183 #ifdef CONFIG_SPL_PANIC_ON_RAW_IMAGE
185 * CONFIG_SPL_PANIC_ON_RAW_IMAGE is defined when the
186 * code which loads images in SPL cannot guarantee that
187 * absolutely all read errors will be reported.
188 * An example is the LPC32XX MLC NAND driver, which
189 * will consider that a completely unreadable NAND block
190 * is bad, and thus should be skipped silently.
192 panic("** no mkimage signature but raw image not supported");
195 #ifdef CONFIG_SPL_OS_BOOT
198 if (!bootz_setup((ulong)header, &start, &end)) {
199 spl_image->name = "Linux";
200 spl_image->os = IH_OS_LINUX;
201 spl_image->load_addr = CONFIG_SYS_LOAD_ADDR;
202 spl_image->entry_point = CONFIG_SYS_LOAD_ADDR;
203 spl_image->size = end - start;
204 debug("spl: payload zImage, load addr: 0x%lx size: %d\n",
205 spl_image->load_addr, spl_image->size);
210 #ifdef CONFIG_SPL_RAW_IMAGE_SUPPORT
211 /* Signature not found - assume u-boot.bin */
212 debug("mkimage signature not found - ih_magic = %x\n",
214 spl_set_header_raw_uboot(spl_image);
216 /* RAW image not supported, proceed to other boot methods. */
217 debug("Raw boot image support not enabled, proceeding to other boot methods\n");
225 __weak void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image)
227 typedef void __noreturn (*image_entry_noargs_t)(void);
229 image_entry_noargs_t image_entry =
230 (image_entry_noargs_t)spl_image->entry_point;
232 debug("image entry point: 0x%lX\n", spl_image->entry_point);
236 static int spl_common_init(bool setup_malloc)
240 debug("spl_early_init()\n");
242 #if CONFIG_VAL(SYS_MALLOC_F_LEN)
244 #ifdef CONFIG_MALLOC_F_ADDR
245 gd->malloc_base = CONFIG_MALLOC_F_ADDR;
247 gd->malloc_limit = CONFIG_VAL(SYS_MALLOC_F_LEN);
251 ret = bootstage_init(true);
253 debug("%s: Failed to set up bootstage: ret=%d\n", __func__,
257 bootstage_mark_name(BOOTSTAGE_ID_START_SPL, "spl");
258 if (CONFIG_IS_ENABLED(OF_CONTROL) && !CONFIG_IS_ENABLED(OF_PLATDATA)) {
259 ret = fdtdec_setup();
261 debug("fdtdec_setup() returned error %d\n", ret);
265 if (CONFIG_IS_ENABLED(DM)) {
266 bootstage_start(BOOTSTATE_ID_ACCUM_DM_SPL, "dm_spl");
267 /* With CONFIG_SPL_OF_PLATDATA, bring in all devices */
268 ret = dm_init_and_scan(!CONFIG_IS_ENABLED(OF_PLATDATA));
269 bootstage_accum(BOOTSTATE_ID_ACCUM_DM_SPL);
271 debug("dm_init_and_scan() returned error %d\n", ret);
279 void spl_set_bd(void)
285 int spl_early_init(void)
289 ret = spl_common_init(true);
292 gd->flags |= GD_FLG_SPL_EARLY_INIT;
300 bool setup_malloc = !(IS_ENABLED(CONFIG_SPL_STACK_R) &&
301 IS_ENABLED(CONFIG_SPL_SYS_MALLOC_SIMPLE));
303 if (!(gd->flags & GD_FLG_SPL_EARLY_INIT)) {
304 ret = spl_common_init(setup_malloc);
308 gd->flags |= GD_FLG_SPL_INIT;
313 #ifndef BOOT_DEVICE_NONE
314 #define BOOT_DEVICE_NONE 0xdeadbeef
317 __weak void board_boot_order(u32 *spl_boot_list)
319 spl_boot_list[0] = spl_boot_device();
322 static struct spl_image_loader *spl_ll_find_loader(uint boot_device)
324 struct spl_image_loader *drv =
325 ll_entry_start(struct spl_image_loader, spl_image_loader);
327 ll_entry_count(struct spl_image_loader, spl_image_loader);
328 struct spl_image_loader *entry;
330 for (entry = drv; entry != drv + n_ents; entry++) {
331 if (boot_device == entry->boot_device)
339 static int spl_load_image(struct spl_image_info *spl_image,
340 struct spl_image_loader *loader)
342 struct spl_boot_device bootdev;
344 bootdev.boot_device = loader->boot_device;
345 bootdev.boot_device_name = NULL;
347 return loader->load_image(spl_image, &bootdev);
351 * boot_from_devices() - Try loading an booting U-Boot from a list of devices
353 * @spl_image: Place to put the image details if successful
354 * @spl_boot_list: List of boot devices to try
355 * @count: Number of elements in spl_boot_list
356 * @return 0 if OK, -ve on error
358 static int boot_from_devices(struct spl_image_info *spl_image,
359 u32 spl_boot_list[], int count)
363 for (i = 0; i < count && spl_boot_list[i] != BOOT_DEVICE_NONE; i++) {
364 struct spl_image_loader *loader;
366 loader = spl_ll_find_loader(spl_boot_list[i]);
367 #if defined(CONFIG_SPL_SERIAL_SUPPORT) && defined(CONFIG_SPL_LIBCOMMON_SUPPORT)
369 printf("Trying to boot from %s\n", loader->name);
371 puts("SPL: Unsupported Boot Device!\n");
373 if (loader && !spl_load_image(spl_image, loader))
380 void board_init_r(gd_t *dummy1, ulong dummy2)
382 u32 spl_boot_list[] = {
389 struct spl_image_info spl_image;
391 debug(">>spl:board_init_r()\n");
395 #ifdef CONFIG_SPL_OS_BOOT
396 dram_init_banksize();
399 #if defined(CONFIG_SYS_SPL_MALLOC_START)
400 mem_malloc_init(CONFIG_SYS_SPL_MALLOC_START,
401 CONFIG_SYS_SPL_MALLOC_SIZE);
402 gd->flags |= GD_FLG_FULL_MALLOC_INIT;
404 if (!(gd->flags & GD_FLG_SPL_INIT)) {
408 #if !defined(CONFIG_PPC) && !defined(CONFIG_ARCH_MX6)
410 * timer_init() does not exist on PPC systems. The timer is initialized
411 * and enabled (decrementer) in interrupt_init() here.
416 #if CONFIG_IS_ENABLED(BOARD_INIT)
420 memset(&spl_image, '\0', sizeof(spl_image));
421 #ifdef CONFIG_SYS_SPL_ARGS_ADDR
422 spl_image.arg = (void *)CONFIG_SYS_SPL_ARGS_ADDR;
424 board_boot_order(spl_boot_list);
426 if (boot_from_devices(&spl_image, spl_boot_list,
427 ARRAY_SIZE(spl_boot_list))) {
428 puts("SPL: failed to boot from all boot devices\n");
432 #ifdef CONFIG_CPU_V7M
433 spl_image.entry_point |= 0x1;
435 switch (spl_image.os) {
437 debug("Jumping to U-Boot\n");
439 #if CONFIG_IS_ENABLED(ATF)
440 case IH_OS_ARM_TRUSTED_FIRMWARE:
441 debug("Jumping to U-Boot via ARM Trusted Firmware\n");
442 spl_invoke_atf(&spl_image);
445 #ifdef CONFIG_SPL_OS_BOOT
447 debug("Jumping to Linux\n");
449 spl_board_prepare_for_linux();
450 jump_to_image_linux(&spl_image);
453 debug("Unsupported OS image.. Jumping nevertheless..\n");
455 #if CONFIG_VAL(SYS_MALLOC_F_LEN) && !defined(CONFIG_SYS_SPL_MALLOC_SIZE)
456 debug("SPL malloc() used %#lx bytes (%ld KB)\n", gd->malloc_ptr,
457 gd->malloc_ptr / 1024);
459 #ifdef CONFIG_BOOTSTAGE_STASH
462 bootstage_mark_name(BOOTSTAGE_ID_END_SPL, "end_spl");
463 ret = bootstage_stash((void *)CONFIG_BOOTSTAGE_STASH_ADDR,
464 CONFIG_BOOTSTAGE_STASH_SIZE);
466 debug("Failed to stash bootstage: err=%d\n", ret);
469 debug("loaded - jumping to U-Boot...\n");
470 spl_board_prepare_for_boot();
471 jump_to_image_no_args(&spl_image);
475 * This requires UART clocks to be enabled. In order for this to work the
476 * caller must ensure that the gd pointer is valid.
478 void preloader_console_init(void)
480 gd->baudrate = CONFIG_BAUDRATE;
482 serial_init(); /* serial communications setup */
484 gd->have_console = 1;
486 #ifndef CONFIG_SPL_DISABLE_BANNER_PRINT
487 puts("\nU-Boot SPL " PLAIN_VERSION " (" U_BOOT_DATE " - " \
488 U_BOOT_TIME " " U_BOOT_TZ ")\n");
490 #ifdef CONFIG_SPL_DISPLAY_PRINT
496 * spl_relocate_stack_gd() - Relocate stack ready for board_init_r() execution
498 * Sometimes board_init_f() runs with a stack in SRAM but we want to use SDRAM
499 * for the main board_init_r() execution. This is typically because we need
500 * more stack space for things like the MMC sub-system.
502 * This function calculates the stack position, copies the global_data into
503 * place, sets the new gd (except for ARM, for which setting GD within a C
504 * function may not always work) and returns the new stack position. The
505 * caller is responsible for setting up the sp register and, in the case
506 * of ARM, setting up gd.
508 * All of this is done using the same layout and alignments as done in
509 * board_init_f_init_reserve() / board_init_f_alloc_reserve().
511 * @return new stack location, or 0 to use the same stack
513 ulong spl_relocate_stack_gd(void)
515 #ifdef CONFIG_SPL_STACK_R
517 ulong ptr = CONFIG_SPL_STACK_R_ADDR;
519 #if defined(CONFIG_SPL_SYS_MALLOC_SIMPLE) && CONFIG_VAL(SYS_MALLOC_F_LEN)
520 if (CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN) {
521 ptr -= CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN;
522 gd->malloc_base = ptr;
523 gd->malloc_limit = CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN;
527 /* Get stack position: use 8-byte alignment for ABI compliance */
528 ptr = CONFIG_SPL_STACK_R_ADDR - roundup(sizeof(gd_t),16);
529 new_gd = (gd_t *)ptr;
530 memcpy(new_gd, (void *)gd, sizeof(gd_t));
531 #if CONFIG_IS_ENABLED(DM)
532 dm_fixup_for_gd_move(new_gd);
534 #if !defined(CONFIG_ARM)