1 // SPDX-License-Identifier: GPL-2.0+
4 * Texas Instruments, <www.ti.com>
11 #include <binman_sym.h>
14 #include <asm/u-boot.h>
21 #include <linux/compiler.h>
22 #include <fdt_support.h>
23 #include <bootcount.h>
25 DECLARE_GLOBAL_DATA_PTR;
27 #ifndef CONFIG_SYS_UBOOT_START
28 #define CONFIG_SYS_UBOOT_START CONFIG_SYS_TEXT_BASE
30 #ifndef CONFIG_SYS_MONITOR_LEN
31 /* Unknown U-Boot size, let's assume it will not be more than 200 KB */
32 #define CONFIG_SYS_MONITOR_LEN (200 * 1024)
35 u32 *boot_params_ptr = NULL;
37 /* See spl.h for information about this */
38 binman_sym_declare(ulong, u_boot_any, image_pos);
40 /* Define board data structure */
41 static bd_t bdata __attribute__ ((section(".data")));
44 * Board-specific Platform code can reimplement show_boot_progress () if needed
46 __weak void show_boot_progress(int val) {}
49 * Default function to determine if u-boot or the OS should
50 * be started. This implementation always returns 1.
52 * Please implement your own board specific funcion to do this.
55 * 0 to not start u-boot
56 * positive if u-boot should start
58 #ifdef CONFIG_SPL_OS_BOOT
59 __weak int spl_start_uboot(void)
61 puts("SPL: Please implement spl_start_uboot() for your board\n");
62 puts("SPL: Direct Linux boot not active!\n");
66 /* weak default platform specific function to initialize
69 __weak int dram_init_banksize(void)
75 * Weak default function for arch specific zImage check. Return zero
76 * and fill start and end address if image is recognized.
78 int __weak bootz_setup(ulong image, ulong *start, ulong *end)
84 /* Weak default function for arch/board-specific fixups to the spl_image_info */
85 void __weak spl_perform_fixups(struct spl_image_info *spl_image)
89 void spl_fixup_fdt(void)
91 #if defined(CONFIG_SPL_OF_LIBFDT) && defined(CONFIG_SYS_SPL_ARGS_ADDR)
92 void *fdt_blob = (void *)CONFIG_SYS_SPL_ARGS_ADDR;
95 err = fdt_check_header(fdt_blob);
97 printf("fdt_root: %s\n", fdt_strerror(err));
101 /* fixup the memory dt node */
102 err = fdt_shrink_to_minimum(fdt_blob, 0);
104 printf("spl: fdt_shrink_to_minimum err - %d\n", err);
108 err = arch_fixup_fdt(fdt_blob);
110 printf("spl: arch_fixup_fdt err - %d\n", err);
117 * Weak default function for board specific cleanup/preparation before
118 * Linux boot. Some boards/platforms might not need it, so just provide
119 * an empty stub here.
121 __weak void spl_board_prepare_for_linux(void)
126 __weak void spl_board_prepare_for_boot(void)
131 __weak struct image_header *spl_get_load_buffer(ssize_t offset, size_t size)
133 return (struct image_header *)(CONFIG_SYS_TEXT_BASE + offset);
136 void spl_set_header_raw_uboot(struct spl_image_info *spl_image)
138 ulong u_boot_pos = binman_sym(ulong, u_boot_any, image_pos);
140 spl_image->size = CONFIG_SYS_MONITOR_LEN;
143 * Binman error cases: address of the end of the previous region or the
144 * start of the image's entry area (usually 0) if there is no previous
147 if (u_boot_pos && u_boot_pos != BINMAN_SYM_MISSING) {
148 /* Binman does not support separated entry addresses */
149 spl_image->entry_point = u_boot_pos;
150 spl_image->load_addr = u_boot_pos;
152 spl_image->entry_point = CONFIG_SYS_UBOOT_START;
153 spl_image->load_addr = CONFIG_SYS_TEXT_BASE;
155 spl_image->os = IH_OS_U_BOOT;
156 spl_image->name = "U-Boot";
159 #ifdef CONFIG_SPL_LOAD_FIT_FULL
160 /* Parse and load full fitImage in SPL */
161 static int spl_load_fit_image(struct spl_image_info *spl_image,
162 const struct image_header *header)
164 bootm_headers_t images;
165 const char *fit_uname_config = NULL;
166 const char *fit_uname_fdt = FIT_FDT_PROP;
168 ulong fw_data = 0, dt_data = 0, img_data = 0;
169 ulong fw_len = 0, dt_len = 0, img_len = 0;
170 int idx, conf_noffset;
173 #ifdef CONFIG_SPL_FIT_SIGNATURE
176 ret = fit_image_load(&images, (ulong)header,
177 NULL, &fit_uname_config,
178 IH_ARCH_DEFAULT, IH_TYPE_STANDALONE, -1,
179 FIT_LOAD_REQUIRED, &fw_data, &fw_len);
183 spl_image->size = fw_len;
184 spl_image->entry_point = fw_data;
185 spl_image->load_addr = fw_data;
186 spl_image->os = IH_OS_U_BOOT;
187 spl_image->name = "U-Boot";
189 debug("spl: payload image: %32s load addr: 0x%lx size: %d\n",
190 spl_image->name, spl_image->load_addr, spl_image->size);
192 #ifdef CONFIG_SPL_FIT_SIGNATURE
195 fit_image_load(&images, (ulong)header,
196 &fit_uname_fdt, &fit_uname_config,
197 IH_ARCH_DEFAULT, IH_TYPE_FLATDT, -1,
198 FIT_LOAD_OPTIONAL, &dt_data, &dt_len);
200 conf_noffset = fit_conf_get_node((const void *)header,
202 if (conf_noffset <= 0)
206 uname = fdt_stringlist_get((const void *)header, conf_noffset,
207 FIT_LOADABLE_PROP, idx,
211 #ifdef CONFIG_SPL_FIT_SIGNATURE
214 ret = fit_image_load(&images, (ulong)header,
215 &uname, &fit_uname_config,
216 IH_ARCH_DEFAULT, IH_TYPE_LOADABLE, -1,
217 FIT_LOAD_OPTIONAL_NON_ZERO,
218 &img_data, &img_len);
227 int spl_parse_image_header(struct spl_image_info *spl_image,
228 const struct image_header *header)
230 #ifdef CONFIG_SPL_LOAD_FIT_FULL
231 int ret = spl_load_fit_image(spl_image, header);
236 if (image_get_magic(header) == IH_MAGIC) {
237 #ifdef CONFIG_SPL_LEGACY_IMAGE_SUPPORT
238 u32 header_size = sizeof(struct image_header);
240 if (spl_image->flags & SPL_COPY_PAYLOAD_ONLY) {
242 * On some system (e.g. powerpc), the load-address and
243 * entry-point is located at address 0. We can't load
244 * to 0-0x40. So skip header in this case.
246 spl_image->load_addr = image_get_load(header);
247 spl_image->entry_point = image_get_ep(header);
248 spl_image->size = image_get_data_size(header);
250 spl_image->entry_point = image_get_load(header);
251 /* Load including the header */
252 spl_image->load_addr = spl_image->entry_point -
254 spl_image->size = image_get_data_size(header) +
257 spl_image->os = image_get_os(header);
258 spl_image->name = image_get_name(header);
259 debug("spl: payload image: %32s load addr: 0x%lx size: %d\n",
260 spl_image->name, spl_image->load_addr, spl_image->size);
262 /* LEGACY image not supported */
263 debug("Legacy boot image support not enabled, proceeding to other boot methods\n");
267 #ifdef CONFIG_SPL_PANIC_ON_RAW_IMAGE
269 * CONFIG_SPL_PANIC_ON_RAW_IMAGE is defined when the
270 * code which loads images in SPL cannot guarantee that
271 * absolutely all read errors will be reported.
272 * An example is the LPC32XX MLC NAND driver, which
273 * will consider that a completely unreadable NAND block
274 * is bad, and thus should be skipped silently.
276 panic("** no mkimage signature but raw image not supported");
279 #ifdef CONFIG_SPL_OS_BOOT
282 if (!bootz_setup((ulong)header, &start, &end)) {
283 spl_image->name = "Linux";
284 spl_image->os = IH_OS_LINUX;
285 spl_image->load_addr = CONFIG_SYS_LOAD_ADDR;
286 spl_image->entry_point = CONFIG_SYS_LOAD_ADDR;
287 spl_image->size = end - start;
288 debug("spl: payload zImage, load addr: 0x%lx size: %d\n",
289 spl_image->load_addr, spl_image->size);
294 #ifdef CONFIG_SPL_RAW_IMAGE_SUPPORT
295 /* Signature not found - assume u-boot.bin */
296 debug("mkimage signature not found - ih_magic = %x\n",
298 spl_set_header_raw_uboot(spl_image);
300 /* RAW image not supported, proceed to other boot methods. */
301 debug("Raw boot image support not enabled, proceeding to other boot methods\n");
309 __weak void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image)
311 typedef void __noreturn (*image_entry_noargs_t)(void);
313 image_entry_noargs_t image_entry =
314 (image_entry_noargs_t)spl_image->entry_point;
316 debug("image entry point: 0x%lx\n", spl_image->entry_point);
320 static int spl_common_init(bool setup_malloc)
324 #if CONFIG_VAL(SYS_MALLOC_F_LEN)
326 #ifdef CONFIG_MALLOC_F_ADDR
327 gd->malloc_base = CONFIG_MALLOC_F_ADDR;
329 gd->malloc_limit = CONFIG_VAL(SYS_MALLOC_F_LEN);
333 ret = bootstage_init(true);
335 debug("%s: Failed to set up bootstage: ret=%d\n", __func__,
339 bootstage_mark_name(BOOTSTAGE_ID_START_SPL, "spl");
340 #if CONFIG_IS_ENABLED(LOG)
343 debug("%s: Failed to set up logging\n", __func__);
347 if (CONFIG_IS_ENABLED(BLOBLIST)) {
348 ret = bloblist_init();
350 debug("%s: Failed to set up bloblist: ret=%d\n",
355 if (CONFIG_IS_ENABLED(OF_CONTROL) && !CONFIG_IS_ENABLED(OF_PLATDATA)) {
356 ret = fdtdec_setup();
358 debug("fdtdec_setup() returned error %d\n", ret);
362 if (CONFIG_IS_ENABLED(DM)) {
363 bootstage_start(BOOTSTATE_ID_ACCUM_DM_SPL, "dm_spl");
364 /* With CONFIG_SPL_OF_PLATDATA, bring in all devices */
365 ret = dm_init_and_scan(!CONFIG_IS_ENABLED(OF_PLATDATA));
366 bootstage_accum(BOOTSTATE_ID_ACCUM_DM_SPL);
368 debug("dm_init_and_scan() returned error %d\n", ret);
376 void spl_set_bd(void)
382 int spl_early_init(void)
386 debug("%s\n", __func__);
388 ret = spl_common_init(true);
391 gd->flags |= GD_FLG_SPL_EARLY_INIT;
399 bool setup_malloc = !(IS_ENABLED(CONFIG_SPL_STACK_R) &&
400 IS_ENABLED(CONFIG_SPL_SYS_MALLOC_SIMPLE));
402 debug("%s\n", __func__);
404 if (!(gd->flags & GD_FLG_SPL_EARLY_INIT)) {
405 ret = spl_common_init(setup_malloc);
409 gd->flags |= GD_FLG_SPL_INIT;
414 #ifndef BOOT_DEVICE_NONE
415 #define BOOT_DEVICE_NONE 0xdeadbeef
418 __weak void board_boot_order(u32 *spl_boot_list)
420 spl_boot_list[0] = spl_boot_device();
423 static struct spl_image_loader *spl_ll_find_loader(uint boot_device)
425 struct spl_image_loader *drv =
426 ll_entry_start(struct spl_image_loader, spl_image_loader);
428 ll_entry_count(struct spl_image_loader, spl_image_loader);
429 struct spl_image_loader *entry;
431 for (entry = drv; entry != drv + n_ents; entry++) {
432 if (boot_device == entry->boot_device)
440 static int spl_load_image(struct spl_image_info *spl_image,
441 struct spl_image_loader *loader)
443 struct spl_boot_device bootdev;
445 bootdev.boot_device = loader->boot_device;
446 bootdev.boot_device_name = NULL;
448 return loader->load_image(spl_image, &bootdev);
452 * boot_from_devices() - Try loading an booting U-Boot from a list of devices
454 * @spl_image: Place to put the image details if successful
455 * @spl_boot_list: List of boot devices to try
456 * @count: Number of elements in spl_boot_list
457 * @return 0 if OK, -ve on error
459 static int boot_from_devices(struct spl_image_info *spl_image,
460 u32 spl_boot_list[], int count)
464 for (i = 0; i < count && spl_boot_list[i] != BOOT_DEVICE_NONE; i++) {
465 struct spl_image_loader *loader;
467 loader = spl_ll_find_loader(spl_boot_list[i]);
468 #if defined(CONFIG_SPL_SERIAL_SUPPORT) && defined(CONFIG_SPL_LIBCOMMON_SUPPORT)
470 printf("Trying to boot from %s\n", loader->name);
472 puts("SPL: Unsupported Boot Device!\n");
474 if (loader && !spl_load_image(spl_image, loader)) {
475 spl_image->boot_device = spl_boot_list[i];
483 void board_init_r(gd_t *dummy1, ulong dummy2)
485 u32 spl_boot_list[] = {
492 struct spl_image_info spl_image;
495 debug(">>spl:board_init_r()\n");
499 #ifdef CONFIG_SPL_OS_BOOT
500 dram_init_banksize();
503 #if defined(CONFIG_SYS_SPL_MALLOC_START)
504 mem_malloc_init(CONFIG_SYS_SPL_MALLOC_START,
505 CONFIG_SYS_SPL_MALLOC_SIZE);
506 gd->flags |= GD_FLG_FULL_MALLOC_INIT;
508 if (!(gd->flags & GD_FLG_SPL_INIT)) {
512 #if !defined(CONFIG_PPC) && !defined(CONFIG_ARCH_MX6)
514 * timer_init() does not exist on PPC systems. The timer is initialized
515 * and enabled (decrementer) in interrupt_init() here.
520 #if CONFIG_IS_ENABLED(BOARD_INIT)
526 memset(&spl_image, '\0', sizeof(spl_image));
527 #ifdef CONFIG_SYS_SPL_ARGS_ADDR
528 spl_image.arg = (void *)CONFIG_SYS_SPL_ARGS_ADDR;
530 spl_image.boot_device = BOOT_DEVICE_NONE;
531 board_boot_order(spl_boot_list);
533 if (boot_from_devices(&spl_image, spl_boot_list,
534 ARRAY_SIZE(spl_boot_list))) {
535 puts("SPL: failed to boot from all boot devices\n");
539 spl_perform_fixups(&spl_image);
540 if (CONFIG_IS_ENABLED(BLOBLIST)) {
541 ret = bloblist_finish();
543 printf("Warning: Failed to finish bloblist (ret=%d)\n",
547 #ifdef CONFIG_CPU_V7M
548 spl_image.entry_point |= 0x1;
550 switch (spl_image.os) {
552 debug("Jumping to U-Boot\n");
554 #if CONFIG_IS_ENABLED(ATF)
555 case IH_OS_ARM_TRUSTED_FIRMWARE:
556 debug("Jumping to U-Boot via ARM Trusted Firmware\n");
557 spl_invoke_atf(&spl_image);
560 #if CONFIG_IS_ENABLED(OPTEE)
562 debug("Jumping to U-Boot via OP-TEE\n");
563 spl_optee_entry(NULL, NULL, spl_image.fdt_addr,
564 (void *)spl_image.entry_point);
567 #ifdef CONFIG_SPL_OS_BOOT
569 debug("Jumping to Linux\n");
571 spl_board_prepare_for_linux();
572 jump_to_image_linux(&spl_image);
575 debug("Unsupported OS image.. Jumping nevertheless..\n");
577 #if CONFIG_VAL(SYS_MALLOC_F_LEN) && !defined(CONFIG_SYS_SPL_MALLOC_SIZE)
578 debug("SPL malloc() used 0x%lx bytes (%ld KB)\n", gd->malloc_ptr,
579 gd->malloc_ptr / 1024);
581 #ifdef CONFIG_BOOTSTAGE_STASH
582 bootstage_mark_name(BOOTSTAGE_ID_END_SPL, "end_spl");
583 ret = bootstage_stash((void *)CONFIG_BOOTSTAGE_STASH_ADDR,
584 CONFIG_BOOTSTAGE_STASH_SIZE);
586 debug("Failed to stash bootstage: err=%d\n", ret);
589 debug("loaded - jumping to U-Boot...\n");
590 spl_board_prepare_for_boot();
591 jump_to_image_no_args(&spl_image);
594 #ifdef CONFIG_SPL_SERIAL_SUPPORT
596 * This requires UART clocks to be enabled. In order for this to work the
597 * caller must ensure that the gd pointer is valid.
599 void preloader_console_init(void)
601 gd->baudrate = CONFIG_BAUDRATE;
603 serial_init(); /* serial communications setup */
605 gd->have_console = 1;
607 #ifndef CONFIG_SPL_DISABLE_BANNER_PRINT
608 puts("\nU-Boot SPL " PLAIN_VERSION " (" U_BOOT_DATE " - " \
609 U_BOOT_TIME " " U_BOOT_TZ ")\n");
611 #ifdef CONFIG_SPL_DISPLAY_PRINT
618 * spl_relocate_stack_gd() - Relocate stack ready for board_init_r() execution
620 * Sometimes board_init_f() runs with a stack in SRAM but we want to use SDRAM
621 * for the main board_init_r() execution. This is typically because we need
622 * more stack space for things like the MMC sub-system.
624 * This function calculates the stack position, copies the global_data into
625 * place, sets the new gd (except for ARM, for which setting GD within a C
626 * function may not always work) and returns the new stack position. The
627 * caller is responsible for setting up the sp register and, in the case
628 * of ARM, setting up gd.
630 * All of this is done using the same layout and alignments as done in
631 * board_init_f_init_reserve() / board_init_f_alloc_reserve().
633 * @return new stack location, or 0 to use the same stack
635 ulong spl_relocate_stack_gd(void)
637 #ifdef CONFIG_SPL_STACK_R
639 ulong ptr = CONFIG_SPL_STACK_R_ADDR;
641 #if defined(CONFIG_SPL_SYS_MALLOC_SIMPLE) && CONFIG_VAL(SYS_MALLOC_F_LEN)
642 if (CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN) {
643 ptr -= CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN;
644 gd->malloc_base = ptr;
645 gd->malloc_limit = CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN;
649 /* Get stack position: use 8-byte alignment for ABI compliance */
650 ptr = CONFIG_SPL_STACK_R_ADDR - roundup(sizeof(gd_t),16);
651 new_gd = (gd_t *)ptr;
652 memcpy(new_gd, (void *)gd, sizeof(gd_t));
653 #if CONFIG_IS_ENABLED(DM)
654 dm_fixup_for_gd_move(new_gd);
656 #if !defined(CONFIG_ARM)