3 * Texas Instruments, <www.ti.com>
5 * Aneesh V <aneesh@ti.com>
7 * SPDX-License-Identifier: GPL-2.0+
13 #include <asm/u-boot.h>
20 #include <linux/compiler.h>
21 #include <fdt_support.h>
23 DECLARE_GLOBAL_DATA_PTR;
25 #ifndef CONFIG_SYS_UBOOT_START
26 #define CONFIG_SYS_UBOOT_START CONFIG_SYS_TEXT_BASE
28 #ifndef CONFIG_SYS_MONITOR_LEN
29 /* Unknown U-Boot size, let's assume it will not be more than 200 KB */
30 #define CONFIG_SYS_MONITOR_LEN (200 * 1024)
33 u32 *boot_params_ptr = NULL;
35 /* Define board data structure */
36 static bd_t bdata __attribute__ ((section(".data")));
39 * Board-specific Platform code can reimplement show_boot_progress () if needed
41 __weak void show_boot_progress(int val) {}
44 * Default function to determine if u-boot or the OS should
45 * be started. This implementation always returns 1.
47 * Please implement your own board specific funcion to do this.
50 * 0 to not start u-boot
51 * positive if u-boot should start
53 #ifdef CONFIG_SPL_OS_BOOT
54 __weak int spl_start_uboot(void)
56 puts("SPL: Please implement spl_start_uboot() for your board\n");
57 puts("SPL: Direct Linux boot not active!\n");
61 /* weak default platform specific function to initialize
64 __weak int dram_init_banksize(void)
70 * Weak default function for arch specific zImage check. Return zero
71 * and fill start and end address if image is recognized.
73 int __weak bootz_setup(ulong image, ulong *start, ulong *end)
79 void spl_fixup_fdt(void)
81 #if defined(CONFIG_SPL_OF_LIBFDT) && defined(CONFIG_SYS_SPL_ARGS_ADDR)
82 void *fdt_blob = (void *)CONFIG_SYS_SPL_ARGS_ADDR;
85 err = fdt_check_header(fdt_blob);
87 printf("fdt_root: %s\n", fdt_strerror(err));
91 /* fixup the memory dt node */
92 err = fdt_shrink_to_minimum(fdt_blob, 0);
94 printf("spl: fdt_shrink_to_minimum err - %d\n", err);
98 err = arch_fixup_fdt(fdt_blob);
100 printf("spl: arch_fixup_fdt err - %d\n", err);
107 * Weak default function for board specific cleanup/preparation before
108 * Linux boot. Some boards/platforms might not need it, so just provide
109 * an empty stub here.
111 __weak void spl_board_prepare_for_linux(void)
116 __weak void spl_board_prepare_for_boot(void)
121 void spl_set_header_raw_uboot(struct spl_image_info *spl_image)
123 spl_image->size = CONFIG_SYS_MONITOR_LEN;
124 spl_image->entry_point = CONFIG_SYS_UBOOT_START;
125 spl_image->load_addr = CONFIG_SYS_TEXT_BASE;
126 spl_image->os = IH_OS_U_BOOT;
127 spl_image->name = "U-Boot";
130 int spl_parse_image_header(struct spl_image_info *spl_image,
131 const struct image_header *header)
133 if (image_get_magic(header) == IH_MAGIC) {
134 #ifdef CONFIG_SPL_LEGACY_IMAGE_SUPPORT
135 u32 header_size = sizeof(struct image_header);
137 if (spl_image->flags & SPL_COPY_PAYLOAD_ONLY) {
139 * On some system (e.g. powerpc), the load-address and
140 * entry-point is located at address 0. We can't load
141 * to 0-0x40. So skip header in this case.
143 spl_image->load_addr = image_get_load(header);
144 spl_image->entry_point = image_get_ep(header);
145 spl_image->size = image_get_data_size(header);
147 spl_image->entry_point = image_get_load(header);
148 /* Load including the header */
149 spl_image->load_addr = spl_image->entry_point -
151 spl_image->size = image_get_data_size(header) +
154 spl_image->os = image_get_os(header);
155 spl_image->name = image_get_name(header);
156 debug("spl: payload image: %.*s load addr: 0x%lx size: %d\n",
157 IH_NMLEN, spl_image->name,
158 spl_image->load_addr, spl_image->size);
160 /* LEGACY image not supported */
161 debug("Legacy boot image support not enabled, proceeding to other boot methods\n");
165 #ifdef CONFIG_SPL_PANIC_ON_RAW_IMAGE
167 * CONFIG_SPL_PANIC_ON_RAW_IMAGE is defined when the
168 * code which loads images in SPL cannot guarantee that
169 * absolutely all read errors will be reported.
170 * An example is the LPC32XX MLC NAND driver, which
171 * will consider that a completely unreadable NAND block
172 * is bad, and thus should be skipped silently.
174 panic("** no mkimage signature but raw image not supported");
177 #ifdef CONFIG_SPL_OS_BOOT
180 if (!bootz_setup((ulong)header, &start, &end)) {
181 spl_image->name = "Linux";
182 spl_image->os = IH_OS_LINUX;
183 spl_image->load_addr = CONFIG_SYS_LOAD_ADDR;
184 spl_image->entry_point = CONFIG_SYS_LOAD_ADDR;
185 spl_image->size = end - start;
186 debug("spl: payload zImage, load addr: 0x%lx size: %d\n",
187 spl_image->load_addr, spl_image->size);
192 #ifdef CONFIG_SPL_RAW_IMAGE_SUPPORT
193 /* Signature not found - assume u-boot.bin */
194 debug("mkimage signature not found - ih_magic = %x\n",
196 spl_set_header_raw_uboot(spl_image);
198 /* RAW image not supported, proceed to other boot methods. */
199 debug("Raw boot image support not enabled, proceeding to other boot methods\n");
207 __weak void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image)
209 typedef void __noreturn (*image_entry_noargs_t)(void);
211 image_entry_noargs_t image_entry =
212 (image_entry_noargs_t)spl_image->entry_point;
214 debug("image entry point: 0x%lX\n", spl_image->entry_point);
218 static int spl_common_init(bool setup_malloc)
222 debug("spl_early_init()\n");
224 #if CONFIG_VAL(SYS_MALLOC_F_LEN)
226 #ifdef CONFIG_MALLOC_F_ADDR
227 gd->malloc_base = CONFIG_MALLOC_F_ADDR;
229 gd->malloc_limit = CONFIG_VAL(SYS_MALLOC_F_LEN);
233 ret = bootstage_init(true);
235 debug("%s: Failed to set up bootstage: ret=%d\n", __func__,
239 bootstage_mark_name(BOOTSTAGE_ID_START_SPL, "spl");
240 if (CONFIG_IS_ENABLED(OF_CONTROL) && !CONFIG_IS_ENABLED(OF_PLATDATA)) {
241 ret = fdtdec_setup();
243 debug("fdtdec_setup() returned error %d\n", ret);
247 if (CONFIG_IS_ENABLED(DM)) {
248 bootstage_start(BOOTSTATE_ID_ACCUM_DM_SPL, "dm_spl");
249 /* With CONFIG_SPL_OF_PLATDATA, bring in all devices */
250 ret = dm_init_and_scan(!CONFIG_IS_ENABLED(OF_PLATDATA));
251 bootstage_accum(BOOTSTATE_ID_ACCUM_DM_SPL);
253 debug("dm_init_and_scan() returned error %d\n", ret);
261 void spl_set_bd(void)
267 int spl_early_init(void)
271 ret = spl_common_init(true);
274 gd->flags |= GD_FLG_SPL_EARLY_INIT;
282 bool setup_malloc = !(IS_ENABLED(CONFIG_SPL_STACK_R) &&
283 IS_ENABLED(CONFIG_SPL_SYS_MALLOC_SIMPLE));
285 if (!(gd->flags & GD_FLG_SPL_EARLY_INIT)) {
286 ret = spl_common_init(setup_malloc);
290 gd->flags |= GD_FLG_SPL_INIT;
295 #ifndef BOOT_DEVICE_NONE
296 #define BOOT_DEVICE_NONE 0xdeadbeef
299 __weak void board_boot_order(u32 *spl_boot_list)
301 spl_boot_list[0] = spl_boot_device();
304 static struct spl_image_loader *spl_ll_find_loader(uint boot_device)
306 struct spl_image_loader *drv =
307 ll_entry_start(struct spl_image_loader, spl_image_loader);
309 ll_entry_count(struct spl_image_loader, spl_image_loader);
310 struct spl_image_loader *entry;
312 for (entry = drv; entry != drv + n_ents; entry++) {
313 if (boot_device == entry->boot_device)
321 static int spl_load_image(struct spl_image_info *spl_image,
322 struct spl_image_loader *loader)
324 struct spl_boot_device bootdev;
326 bootdev.boot_device = loader->boot_device;
327 bootdev.boot_device_name = NULL;
329 return loader->load_image(spl_image, &bootdev);
333 * boot_from_devices() - Try loading an booting U-Boot from a list of devices
335 * @spl_image: Place to put the image details if successful
336 * @spl_boot_list: List of boot devices to try
337 * @count: Number of elements in spl_boot_list
338 * @return 0 if OK, -ve on error
340 static int boot_from_devices(struct spl_image_info *spl_image,
341 u32 spl_boot_list[], int count)
345 for (i = 0; i < count && spl_boot_list[i] != BOOT_DEVICE_NONE; i++) {
346 struct spl_image_loader *loader;
348 loader = spl_ll_find_loader(spl_boot_list[i]);
349 #if defined(CONFIG_SPL_SERIAL_SUPPORT) && defined(CONFIG_SPL_LIBCOMMON_SUPPORT)
351 printf("Trying to boot from %s\n", loader->name);
353 puts("SPL: Unsupported Boot Device!\n");
355 if (loader && !spl_load_image(spl_image, loader))
362 void board_init_r(gd_t *dummy1, ulong dummy2)
364 u32 spl_boot_list[] = {
371 struct spl_image_info spl_image;
373 debug(">>spl:board_init_r()\n");
377 #ifdef CONFIG_SPL_OS_BOOT
378 dram_init_banksize();
381 #if defined(CONFIG_SYS_SPL_MALLOC_START)
382 mem_malloc_init(CONFIG_SYS_SPL_MALLOC_START,
383 CONFIG_SYS_SPL_MALLOC_SIZE);
384 gd->flags |= GD_FLG_FULL_MALLOC_INIT;
386 if (!(gd->flags & GD_FLG_SPL_INIT)) {
390 #if !defined(CONFIG_PPC) && !defined(CONFIG_ARCH_MX6)
392 * timer_init() does not exist on PPC systems. The timer is initialized
393 * and enabled (decrementer) in interrupt_init() here.
398 #ifdef CONFIG_SPL_BOARD_INIT
402 memset(&spl_image, '\0', sizeof(spl_image));
403 #ifdef CONFIG_SYS_SPL_ARGS_ADDR
404 spl_image.arg = (void *)CONFIG_SYS_SPL_ARGS_ADDR;
406 board_boot_order(spl_boot_list);
408 if (boot_from_devices(&spl_image, spl_boot_list,
409 ARRAY_SIZE(spl_boot_list))) {
410 puts("SPL: failed to boot from all boot devices\n");
414 #ifdef CONFIG_CPU_V7M
415 spl_image.entry_point |= 0x1;
417 switch (spl_image.os) {
419 debug("Jumping to U-Boot\n");
421 #if CONFIG_IS_ENABLED(ATF)
422 case IH_OS_ARM_TRUSTED_FIRMWARE:
423 debug("Jumping to U-Boot via ARM Trusted Firmware\n");
424 spl_invoke_atf(&spl_image);
427 #ifdef CONFIG_SPL_OS_BOOT
429 debug("Jumping to Linux\n");
431 spl_board_prepare_for_linux();
432 jump_to_image_linux(&spl_image);
435 debug("Unsupported OS image.. Jumping nevertheless..\n");
437 #if CONFIG_VAL(SYS_MALLOC_F_LEN) && !defined(CONFIG_SYS_SPL_MALLOC_SIZE)
438 debug("SPL malloc() used %#lx bytes (%ld KB)\n", gd->malloc_ptr,
439 gd->malloc_ptr / 1024);
441 #ifdef CONFIG_BOOTSTAGE_STASH
444 bootstage_mark_name(BOOTSTAGE_ID_END_SPL, "end_spl");
445 ret = bootstage_stash((void *)CONFIG_BOOTSTAGE_STASH_ADDR,
446 CONFIG_BOOTSTAGE_STASH_SIZE);
448 debug("Failed to stash bootstage: err=%d\n", ret);
451 debug("loaded - jumping to U-Boot...\n");
452 spl_board_prepare_for_boot();
453 jump_to_image_no_args(&spl_image);
457 * This requires UART clocks to be enabled. In order for this to work the
458 * caller must ensure that the gd pointer is valid.
460 void preloader_console_init(void)
462 gd->baudrate = CONFIG_BAUDRATE;
464 serial_init(); /* serial communications setup */
466 gd->have_console = 1;
468 puts("\nU-Boot SPL " PLAIN_VERSION " (" U_BOOT_DATE " - " \
470 #ifdef CONFIG_SPL_DISPLAY_PRINT
476 * spl_relocate_stack_gd() - Relocate stack ready for board_init_r() execution
478 * Sometimes board_init_f() runs with a stack in SRAM but we want to use SDRAM
479 * for the main board_init_r() execution. This is typically because we need
480 * more stack space for things like the MMC sub-system.
482 * This function calculates the stack position, copies the global_data into
483 * place, sets the new gd (except for ARM, for which setting GD within a C
484 * function may not always work) and returns the new stack position. The
485 * caller is responsible for setting up the sp register and, in the case
486 * of ARM, setting up gd.
488 * All of this is done using the same layout and alignments as done in
489 * board_init_f_init_reserve() / board_init_f_alloc_reserve().
491 * @return new stack location, or 0 to use the same stack
493 ulong spl_relocate_stack_gd(void)
495 #ifdef CONFIG_SPL_STACK_R
497 ulong ptr = CONFIG_SPL_STACK_R_ADDR;
499 #if defined(CONFIG_SPL_SYS_MALLOC_SIMPLE) && CONFIG_VAL(SYS_MALLOC_F_LEN)
500 if (CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN) {
501 ptr -= CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN;
502 gd->malloc_base = ptr;
503 gd->malloc_limit = CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN;
507 /* Get stack position: use 8-byte alignment for ABI compliance */
508 ptr = CONFIG_SPL_STACK_R_ADDR - roundup(sizeof(gd_t),16);
509 new_gd = (gd_t *)ptr;
510 memcpy(new_gd, (void *)gd, sizeof(gd_t));
511 #if CONFIG_IS_ENABLED(DM)
512 dm_fixup_for_gd_move(new_gd);
514 #if !defined(CONFIG_ARM)