1 // SPDX-License-Identifier: GPL-2.0+
4 * Texas Instruments, <www.ti.com>
6 * Aneesh V <aneesh@ti.com>
11 #include <binman_sym.h>
12 #include <bootstage.h>
21 #include <asm/u-boot.h>
24 #include <u-boot/crc.h>
30 #include <linux/compiler.h>
31 #include <fdt_support.h>
32 #include <bootcount.h>
35 DECLARE_GLOBAL_DATA_PTR;
37 #ifndef CONFIG_SYS_UBOOT_START
38 #define CONFIG_SYS_UBOOT_START CONFIG_SYS_TEXT_BASE
40 #ifndef CONFIG_SYS_MONITOR_LEN
41 /* Unknown U-Boot size, let's assume it will not be more than 200 KB */
42 #define CONFIG_SYS_MONITOR_LEN (200 * 1024)
45 u32 *boot_params_ptr = NULL;
47 /* See spl.h for information about this */
48 binman_sym_declare(ulong, u_boot_any, image_pos);
49 binman_sym_declare(ulong, u_boot_any, size);
52 binman_sym_declare(ulong, spl, image_pos);
53 binman_sym_declare(ulong, spl, size);
56 /* Define board data structure */
57 static struct bd_info bdata __attribute__ ((section(".data")));
60 * Board-specific Platform code can reimplement show_boot_progress () if needed
62 __weak void show_boot_progress(int val) {}
64 #if defined(CONFIG_SPL_OS_BOOT) || CONFIG_IS_ENABLED(HANDOFF) || \
65 defined(CONFIG_SPL_ATF)
66 /* weak, default platform-specific function to initialize dram banks */
67 __weak int dram_init_banksize(void)
74 * Default function to determine if u-boot or the OS should
75 * be started. This implementation always returns 1.
77 * Please implement your own board specific funcion to do this.
80 * 0 to not start u-boot
81 * positive if u-boot should start
83 #ifdef CONFIG_SPL_OS_BOOT
84 __weak int spl_start_uboot(void)
87 "Please implement spl_start_uboot() for your board\n");
88 puts(SPL_TPL_PROMPT "Direct Linux boot not active!\n");
93 * Weak default function for arch specific zImage check. Return zero
94 * and fill start and end address if image is recognized.
96 int __weak bootz_setup(ulong image, ulong *start, ulong *end)
102 /* Weak default function for arch/board-specific fixups to the spl_image_info */
103 void __weak spl_perform_fixups(struct spl_image_info *spl_image)
107 void spl_fixup_fdt(void *fdt_blob)
109 #if defined(CONFIG_SPL_OF_LIBFDT)
115 err = fdt_check_header(fdt_blob);
117 printf("fdt_root: %s\n", fdt_strerror(err));
121 /* fixup the memory dt node */
122 err = fdt_shrink_to_minimum(fdt_blob, 0);
124 printf(SPL_TPL_PROMPT "fdt_shrink_to_minimum err - %d\n", err);
128 err = arch_fixup_fdt(fdt_blob);
130 printf(SPL_TPL_PROMPT "arch_fixup_fdt err - %d\n", err);
136 ulong spl_get_image_pos(void)
138 return spl_phase() == PHASE_TPL ?
139 binman_sym(ulong, spl, image_pos) :
140 binman_sym(ulong, u_boot_any, image_pos);
143 ulong spl_get_image_size(void)
145 return spl_phase() == PHASE_TPL ?
146 binman_sym(ulong, spl, size) :
147 binman_sym(ulong, u_boot_any, size);
151 * Weak default function for board specific cleanup/preparation before
152 * Linux boot. Some boards/platforms might not need it, so just provide
153 * an empty stub here.
155 __weak void spl_board_prepare_for_linux(void)
160 __weak void spl_board_prepare_for_boot(void)
165 __weak struct image_header *spl_get_load_buffer(ssize_t offset, size_t size)
167 return (struct image_header *)(CONFIG_SYS_TEXT_BASE + offset);
170 void spl_set_header_raw_uboot(struct spl_image_info *spl_image)
172 ulong u_boot_pos = binman_sym(ulong, u_boot_any, image_pos);
174 spl_image->size = CONFIG_SYS_MONITOR_LEN;
177 * Binman error cases: address of the end of the previous region or the
178 * start of the image's entry area (usually 0) if there is no previous
181 if (u_boot_pos && u_boot_pos != BINMAN_SYM_MISSING) {
182 /* Binman does not support separated entry addresses */
183 spl_image->entry_point = u_boot_pos;
184 spl_image->load_addr = u_boot_pos;
186 spl_image->entry_point = CONFIG_SYS_UBOOT_START;
187 spl_image->load_addr = CONFIG_SYS_TEXT_BASE;
189 spl_image->os = IH_OS_U_BOOT;
190 spl_image->name = "U-Boot";
193 #ifdef CONFIG_SPL_LOAD_FIT_FULL
194 /* Parse and load full fitImage in SPL */
195 static int spl_load_fit_image(struct spl_image_info *spl_image,
196 const struct image_header *header)
198 bootm_headers_t images;
199 const char *fit_uname_config = NULL;
200 const char *fit_uname_fdt = FIT_FDT_PROP;
202 ulong fw_data = 0, dt_data = 0, img_data = 0;
203 ulong fw_len = 0, dt_len = 0, img_len = 0;
204 int idx, conf_noffset;
207 #ifdef CONFIG_SPL_FIT_SIGNATURE
210 ret = fit_image_load(&images, (ulong)header,
211 NULL, &fit_uname_config,
212 IH_ARCH_DEFAULT, IH_TYPE_STANDALONE, -1,
213 FIT_LOAD_REQUIRED, &fw_data, &fw_len);
217 spl_image->size = fw_len;
218 spl_image->entry_point = fw_data;
219 spl_image->load_addr = fw_data;
220 spl_image->os = IH_OS_U_BOOT;
221 spl_image->name = "U-Boot";
223 debug(SPL_TPL_PROMPT "payload image: %32s load addr: 0x%lx size: %d\n",
224 spl_image->name, spl_image->load_addr, spl_image->size);
226 #ifdef CONFIG_SPL_FIT_SIGNATURE
229 ret = fit_image_load(&images, (ulong)header,
230 &fit_uname_fdt, &fit_uname_config,
231 IH_ARCH_DEFAULT, IH_TYPE_FLATDT, -1,
232 FIT_LOAD_OPTIONAL, &dt_data, &dt_len);
234 spl_image->fdt_addr = (void *)dt_data;
236 conf_noffset = fit_conf_get_node((const void *)header,
238 if (conf_noffset <= 0)
242 uname = fdt_stringlist_get((const void *)header, conf_noffset,
243 FIT_LOADABLE_PROP, idx,
247 #ifdef CONFIG_SPL_FIT_SIGNATURE
250 ret = fit_image_load(&images, (ulong)header,
251 &uname, &fit_uname_config,
252 IH_ARCH_DEFAULT, IH_TYPE_LOADABLE, -1,
253 FIT_LOAD_OPTIONAL_NON_ZERO,
254 &img_data, &img_len);
263 __weak int spl_parse_legacy_header(struct spl_image_info *spl_image,
264 const struct image_header *header)
266 /* LEGACY image not supported */
267 debug("Legacy boot image support not enabled, proceeding to other boot methods\n");
271 int spl_parse_image_header(struct spl_image_info *spl_image,
272 const struct image_header *header)
274 #ifdef CONFIG_SPL_LOAD_FIT_FULL
275 int ret = spl_load_fit_image(spl_image, header);
280 if (image_get_magic(header) == IH_MAGIC) {
283 ret = spl_parse_legacy_header(spl_image, header);
287 #ifdef CONFIG_SPL_PANIC_ON_RAW_IMAGE
289 * CONFIG_SPL_PANIC_ON_RAW_IMAGE is defined when the
290 * code which loads images in SPL cannot guarantee that
291 * absolutely all read errors will be reported.
292 * An example is the LPC32XX MLC NAND driver, which
293 * will consider that a completely unreadable NAND block
294 * is bad, and thus should be skipped silently.
296 panic("** no mkimage signature but raw image not supported");
299 #ifdef CONFIG_SPL_OS_BOOT
302 if (!bootz_setup((ulong)header, &start, &end)) {
303 spl_image->name = "Linux";
304 spl_image->os = IH_OS_LINUX;
305 spl_image->load_addr = CONFIG_SYS_LOAD_ADDR;
306 spl_image->entry_point = CONFIG_SYS_LOAD_ADDR;
307 spl_image->size = end - start;
309 "payload zImage, load addr: 0x%lx size: %d\n",
310 spl_image->load_addr, spl_image->size);
315 #ifdef CONFIG_SPL_RAW_IMAGE_SUPPORT
316 /* Signature not found - assume u-boot.bin */
317 debug("mkimage signature not found - ih_magic = %x\n",
319 spl_set_header_raw_uboot(spl_image);
321 /* RAW image not supported, proceed to other boot methods. */
322 debug("Raw boot image support not enabled, proceeding to other boot methods\n");
330 __weak void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image)
332 typedef void __noreturn (*image_entry_noargs_t)(void);
334 image_entry_noargs_t image_entry =
335 (image_entry_noargs_t)spl_image->entry_point;
337 debug("image entry point: 0x%lx\n", spl_image->entry_point);
341 #if CONFIG_IS_ENABLED(HANDOFF)
343 * Set up the SPL hand-off information
345 * This is initially empty (zero) but can be written by
347 static int setup_spl_handoff(void)
349 struct spl_handoff *ho;
351 ho = bloblist_ensure(BLOBLISTT_SPL_HANDOFF, sizeof(struct spl_handoff));
358 __weak int handoff_arch_save(struct spl_handoff *ho)
363 static int write_spl_handoff(void)
365 struct spl_handoff *ho;
368 ho = bloblist_find(BLOBLISTT_SPL_HANDOFF, sizeof(struct spl_handoff));
371 handoff_save_dram(ho);
372 ret = handoff_arch_save(ho);
375 debug(SPL_TPL_PROMPT "Wrote SPL handoff\n");
380 static inline int setup_spl_handoff(void) { return 0; }
381 static inline int write_spl_handoff(void) { return 0; }
385 static int spl_common_init(bool setup_malloc)
389 #if CONFIG_VAL(SYS_MALLOC_F_LEN)
391 #ifdef CONFIG_MALLOC_F_ADDR
392 gd->malloc_base = CONFIG_MALLOC_F_ADDR;
394 gd->malloc_limit = CONFIG_VAL(SYS_MALLOC_F_LEN);
398 ret = bootstage_init(u_boot_first_phase());
400 debug("%s: Failed to set up bootstage: ret=%d\n", __func__,
404 #ifdef CONFIG_BOOTSTAGE_STASH
405 if (!u_boot_first_phase()) {
406 const void *stash = map_sysmem(CONFIG_BOOTSTAGE_STASH_ADDR,
407 CONFIG_BOOTSTAGE_STASH_SIZE);
409 ret = bootstage_unstash(stash, CONFIG_BOOTSTAGE_STASH_SIZE);
411 debug("%s: Failed to unstash bootstage: ret=%d\n",
414 #endif /* CONFIG_BOOTSTAGE_STASH */
415 bootstage_mark_name(spl_phase() == PHASE_TPL ? BOOTSTAGE_ID_START_TPL :
416 BOOTSTAGE_ID_START_SPL, SPL_TPL_NAME);
417 #if CONFIG_IS_ENABLED(LOG)
420 debug("%s: Failed to set up logging\n", __func__);
424 if (CONFIG_IS_ENABLED(OF_CONTROL) && !CONFIG_IS_ENABLED(OF_PLATDATA)) {
425 ret = fdtdec_setup();
427 debug("fdtdec_setup() returned error %d\n", ret);
431 if (CONFIG_IS_ENABLED(DM)) {
432 bootstage_start(BOOTSTAGE_ID_ACCUM_DM_SPL,
433 spl_phase() == PHASE_TPL ? "dm tpl" : "dm_spl");
434 /* With CONFIG_SPL_OF_PLATDATA, bring in all devices */
435 ret = dm_init_and_scan(!CONFIG_IS_ENABLED(OF_PLATDATA));
436 bootstage_accum(BOOTSTAGE_ID_ACCUM_DM_SPL);
438 debug("dm_init_and_scan() returned error %d\n", ret);
446 void spl_set_bd(void)
449 * NOTE: On some platforms (e.g. x86) bdata may be in flash and not
456 int spl_early_init(void)
460 debug("%s\n", __func__);
462 ret = spl_common_init(true);
465 gd->flags |= GD_FLG_SPL_EARLY_INIT;
473 bool setup_malloc = !(IS_ENABLED(CONFIG_SPL_STACK_R) &&
474 IS_ENABLED(CONFIG_SPL_SYS_MALLOC_SIMPLE));
476 debug("%s\n", __func__);
478 if (!(gd->flags & GD_FLG_SPL_EARLY_INIT)) {
479 ret = spl_common_init(setup_malloc);
483 gd->flags |= GD_FLG_SPL_INIT;
488 #ifndef BOOT_DEVICE_NONE
489 #define BOOT_DEVICE_NONE 0xdeadbeef
492 __weak void board_boot_order(u32 *spl_boot_list)
494 spl_boot_list[0] = spl_boot_device();
497 static struct spl_image_loader *spl_ll_find_loader(uint boot_device)
499 struct spl_image_loader *drv =
500 ll_entry_start(struct spl_image_loader, spl_image_loader);
502 ll_entry_count(struct spl_image_loader, spl_image_loader);
503 struct spl_image_loader *entry;
505 for (entry = drv; entry != drv + n_ents; entry++) {
506 if (boot_device == entry->boot_device)
514 static int spl_load_image(struct spl_image_info *spl_image,
515 struct spl_image_loader *loader)
518 struct spl_boot_device bootdev;
520 bootdev.boot_device = loader->boot_device;
521 bootdev.boot_device_name = NULL;
523 ret = loader->load_image(spl_image, &bootdev);
524 #ifdef CONFIG_SPL_LEGACY_IMAGE_CRC_CHECK
525 if (!ret && spl_image->dcrc_length) {
527 ulong dcrc = crc32_wd(0, (unsigned char *)spl_image->dcrc_data,
528 spl_image->dcrc_length, CHUNKSZ_CRC32);
529 if (dcrc != spl_image->dcrc) {
530 puts("SPL: Image data CRC check failed!\n");
539 * boot_from_devices() - Try loading a booting U-Boot from a list of devices
541 * @spl_image: Place to put the image details if successful
542 * @spl_boot_list: List of boot devices to try
543 * @count: Number of elements in spl_boot_list
544 * @return 0 if OK, -ve on error
546 static int boot_from_devices(struct spl_image_info *spl_image,
547 u32 spl_boot_list[], int count)
551 for (i = 0; i < count && spl_boot_list[i] != BOOT_DEVICE_NONE; i++) {
552 struct spl_image_loader *loader;
554 loader = spl_ll_find_loader(spl_boot_list[i]);
555 #if defined(CONFIG_SPL_SERIAL_SUPPORT) \
556 && defined(CONFIG_SPL_LIBCOMMON_SUPPORT) \
557 && !defined(CONFIG_SILENT_CONSOLE)
559 printf("Trying to boot from %s\n", loader->name);
561 puts(SPL_TPL_PROMPT "Unsupported Boot Device!\n");
563 if (loader && !spl_load_image(spl_image, loader)) {
564 spl_image->boot_device = spl_boot_list[i];
572 #if defined(CONFIG_SPL_FRAMEWORK_BOARD_INIT_F)
573 void board_init_f(ulong dummy)
575 if (CONFIG_IS_ENABLED(OF_CONTROL)) {
578 ret = spl_early_init();
580 debug("spl_early_init() failed: %d\n", ret);
585 preloader_console_init();
589 void board_init_r(gd_t *dummy1, ulong dummy2)
591 u32 spl_boot_list[] = {
598 struct spl_image_info spl_image;
601 debug(">>" SPL_TPL_PROMPT "board_init_r()\n");
605 #if defined(CONFIG_SYS_SPL_MALLOC_START)
606 mem_malloc_init(CONFIG_SYS_SPL_MALLOC_START,
607 CONFIG_SYS_SPL_MALLOC_SIZE);
608 gd->flags |= GD_FLG_FULL_MALLOC_INIT;
610 if (!(gd->flags & GD_FLG_SPL_INIT)) {
614 #if !defined(CONFIG_PPC) && !defined(CONFIG_ARCH_MX6)
616 * timer_init() does not exist on PPC systems. The timer is initialized
617 * and enabled (decrementer) in interrupt_init() here.
621 if (CONFIG_IS_ENABLED(BLOBLIST)) {
622 ret = bloblist_init();
624 debug("%s: Failed to set up bloblist: ret=%d\n",
626 puts(SPL_TPL_PROMPT "Cannot set up bloblist\n");
630 if (CONFIG_IS_ENABLED(HANDOFF)) {
633 ret = setup_spl_handoff();
635 puts(SPL_TPL_PROMPT "Cannot set up SPL handoff\n");
640 #if CONFIG_IS_ENABLED(BOARD_INIT)
644 #if defined(CONFIG_SPL_WATCHDOG_SUPPORT) && CONFIG_IS_ENABLED(WDT)
648 if (IS_ENABLED(CONFIG_SPL_OS_BOOT) || CONFIG_IS_ENABLED(HANDOFF) ||
649 IS_ENABLED(CONFIG_SPL_ATF))
650 dram_init_banksize();
654 memset(&spl_image, '\0', sizeof(spl_image));
655 #ifdef CONFIG_SYS_SPL_ARGS_ADDR
656 spl_image.arg = (void *)CONFIG_SYS_SPL_ARGS_ADDR;
658 spl_image.boot_device = BOOT_DEVICE_NONE;
659 board_boot_order(spl_boot_list);
661 if (boot_from_devices(&spl_image, spl_boot_list,
662 ARRAY_SIZE(spl_boot_list))) {
663 puts(SPL_TPL_PROMPT "failed to boot from all boot devices\n");
667 spl_perform_fixups(&spl_image);
668 if (CONFIG_IS_ENABLED(HANDOFF)) {
669 ret = write_spl_handoff();
671 printf(SPL_TPL_PROMPT
672 "SPL hand-off write failed (err=%d)\n", ret);
674 if (CONFIG_IS_ENABLED(BLOBLIST)) {
675 ret = bloblist_finish();
677 printf("Warning: Failed to finish bloblist (ret=%d)\n",
681 #ifdef CONFIG_CPU_V7M
682 spl_image.entry_point |= 0x1;
684 switch (spl_image.os) {
686 debug("Jumping to U-Boot\n");
688 #if CONFIG_IS_ENABLED(ATF)
689 case IH_OS_ARM_TRUSTED_FIRMWARE:
690 debug("Jumping to U-Boot via ARM Trusted Firmware\n");
691 spl_fixup_fdt(spl_image.fdt_addr);
692 spl_invoke_atf(&spl_image);
695 #if CONFIG_IS_ENABLED(OPTEE)
697 debug("Jumping to U-Boot via OP-TEE\n");
698 spl_optee_entry(NULL, NULL, spl_image.fdt_addr,
699 (void *)spl_image.entry_point);
702 #if CONFIG_IS_ENABLED(OPENSBI)
704 debug("Jumping to U-Boot via RISC-V OpenSBI\n");
705 spl_invoke_opensbi(&spl_image);
708 #ifdef CONFIG_SPL_OS_BOOT
710 debug("Jumping to Linux\n");
711 #if defined(CONFIG_SYS_SPL_ARGS_ADDR)
712 spl_fixup_fdt((void *)CONFIG_SYS_SPL_ARGS_ADDR);
714 spl_board_prepare_for_linux();
715 jump_to_image_linux(&spl_image);
718 debug("Unsupported OS image.. Jumping nevertheless..\n");
720 #if CONFIG_VAL(SYS_MALLOC_F_LEN) && !defined(CONFIG_SYS_SPL_MALLOC_SIZE)
721 debug("SPL malloc() used 0x%lx bytes (%ld KB)\n", gd->malloc_ptr,
722 gd->malloc_ptr / 1024);
724 bootstage_mark_name(spl_phase() == PHASE_TPL ? BOOTSTAGE_ID_END_TPL :
725 BOOTSTAGE_ID_END_SPL, "end " SPL_TPL_NAME);
726 #ifdef CONFIG_BOOTSTAGE_STASH
727 ret = bootstage_stash((void *)CONFIG_BOOTSTAGE_STASH_ADDR,
728 CONFIG_BOOTSTAGE_STASH_SIZE);
730 debug("Failed to stash bootstage: err=%d\n", ret);
733 debug("loaded - jumping to U-Boot...\n");
734 spl_board_prepare_for_boot();
735 jump_to_image_no_args(&spl_image);
739 * This requires UART clocks to be enabled. In order for this to work the
740 * caller must ensure that the gd pointer is valid.
742 void preloader_console_init(void)
744 #ifdef CONFIG_SPL_SERIAL_SUPPORT
745 gd->baudrate = CONFIG_BAUDRATE;
747 serial_init(); /* serial communications setup */
749 gd->have_console = 1;
751 #if CONFIG_IS_ENABLED(BANNER_PRINT)
752 puts("\nU-Boot " SPL_TPL_NAME " " PLAIN_VERSION " (" U_BOOT_DATE " - "
753 U_BOOT_TIME " " U_BOOT_TZ ")\n");
755 #ifdef CONFIG_SPL_DISPLAY_PRINT
762 * This function is called before the stack is changed from initial stack to
763 * relocated stack. It tries to dump the stack size used
765 __weak void spl_relocate_stack_check(void)
767 #if CONFIG_IS_ENABLED(SYS_REPORT_STACK_F_USAGE)
768 ulong init_sp = gd->start_addr_sp;
769 ulong stack_bottom = init_sp - CONFIG_VAL(SIZE_LIMIT_PROVIDE_STACK);
770 u8 *ptr = (u8 *)stack_bottom;
773 for (i = 0; i < CONFIG_VAL(SIZE_LIMIT_PROVIDE_STACK); i++) {
774 if (*ptr != CONFIG_VAL(SYS_STACK_F_CHECK_BYTE))
778 printf("SPL initial stack usage: %lu bytes\n",
779 CONFIG_VAL(SIZE_LIMIT_PROVIDE_STACK) - i);
784 * spl_relocate_stack_gd() - Relocate stack ready for board_init_r() execution
786 * Sometimes board_init_f() runs with a stack in SRAM but we want to use SDRAM
787 * for the main board_init_r() execution. This is typically because we need
788 * more stack space for things like the MMC sub-system.
790 * This function calculates the stack position, copies the global_data into
791 * place, sets the new gd (except for ARM, for which setting GD within a C
792 * function may not always work) and returns the new stack position. The
793 * caller is responsible for setting up the sp register and, in the case
794 * of ARM, setting up gd.
796 * All of this is done using the same layout and alignments as done in
797 * board_init_f_init_reserve() / board_init_f_alloc_reserve().
799 * @return new stack location, or 0 to use the same stack
801 ulong spl_relocate_stack_gd(void)
803 #ifdef CONFIG_SPL_STACK_R
805 ulong ptr = CONFIG_SPL_STACK_R_ADDR;
807 if (CONFIG_IS_ENABLED(SYS_REPORT_STACK_F_USAGE))
808 spl_relocate_stack_check();
810 #if defined(CONFIG_SPL_SYS_MALLOC_SIMPLE) && CONFIG_VAL(SYS_MALLOC_F_LEN)
811 if (CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN) {
812 debug("SPL malloc() before relocation used 0x%lx bytes (%ld KB)\n",
813 gd->malloc_ptr, gd->malloc_ptr / 1024);
814 ptr -= CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN;
815 gd->malloc_base = ptr;
816 gd->malloc_limit = CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN;
820 /* Get stack position: use 8-byte alignment for ABI compliance */
821 ptr = CONFIG_SPL_STACK_R_ADDR - roundup(sizeof(gd_t),16);
822 new_gd = (gd_t *)ptr;
823 memcpy(new_gd, (void *)gd, sizeof(gd_t));
824 #if CONFIG_IS_ENABLED(DM)
825 dm_fixup_for_gd_move(new_gd);
827 #if !defined(CONFIG_ARM) && !defined(CONFIG_RISCV)
836 #if defined(CONFIG_BOOTCOUNT_LIMIT) && !defined(CONFIG_SPL_BOOTCOUNT_LIMIT)
837 void bootcount_store(ulong a)
841 ulong bootcount_load(void)