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);
57 * Board-specific Platform code can reimplement show_boot_progress () if needed
59 __weak void show_boot_progress(int val) {}
61 #if defined(CONFIG_SPL_OS_BOOT) || CONFIG_IS_ENABLED(HANDOFF) || \
62 defined(CONFIG_SPL_ATF)
63 /* weak, default platform-specific function to initialize dram banks */
64 __weak int dram_init_banksize(void)
71 * Default function to determine if u-boot or the OS should
72 * be started. This implementation always returns 1.
74 * Please implement your own board specific funcion to do this.
77 * 0 to not start u-boot
78 * positive if u-boot should start
80 #ifdef CONFIG_SPL_OS_BOOT
81 __weak int spl_start_uboot(void)
84 "Please implement spl_start_uboot() for your board\n");
85 puts(SPL_TPL_PROMPT "Direct Linux boot not active!\n");
90 * Weak default function for arch specific zImage check. Return zero
91 * and fill start and end address if image is recognized.
93 int __weak bootz_setup(ulong image, ulong *start, ulong *end)
99 /* Weak default function for arch/board-specific fixups to the spl_image_info */
100 void __weak spl_perform_fixups(struct spl_image_info *spl_image)
104 void spl_fixup_fdt(void *fdt_blob)
106 #if defined(CONFIG_SPL_OF_LIBFDT)
112 err = fdt_check_header(fdt_blob);
114 printf("fdt_root: %s\n", fdt_strerror(err));
118 /* fixup the memory dt node */
119 err = fdt_shrink_to_minimum(fdt_blob, 0);
121 printf(SPL_TPL_PROMPT "fdt_shrink_to_minimum err - %d\n", err);
125 err = arch_fixup_fdt(fdt_blob);
127 printf(SPL_TPL_PROMPT "arch_fixup_fdt err - %d\n", err);
133 ulong spl_get_image_pos(void)
135 return spl_phase() == PHASE_TPL ?
136 binman_sym(ulong, spl, image_pos) :
137 binman_sym(ulong, u_boot_any, image_pos);
140 ulong spl_get_image_size(void)
142 return spl_phase() == PHASE_TPL ?
143 binman_sym(ulong, spl, size) :
144 binman_sym(ulong, u_boot_any, size);
148 * Weak default function for board specific cleanup/preparation before
149 * Linux boot. Some boards/platforms might not need it, so just provide
150 * an empty stub here.
152 __weak void spl_board_prepare_for_linux(void)
157 __weak void spl_board_prepare_for_boot(void)
162 __weak struct image_header *spl_get_load_buffer(ssize_t offset, size_t size)
164 return (struct image_header *)(CONFIG_SYS_TEXT_BASE + offset);
167 void spl_set_header_raw_uboot(struct spl_image_info *spl_image)
169 ulong u_boot_pos = binman_sym(ulong, u_boot_any, image_pos);
171 spl_image->size = CONFIG_SYS_MONITOR_LEN;
174 * Binman error cases: address of the end of the previous region or the
175 * start of the image's entry area (usually 0) if there is no previous
178 if (u_boot_pos && u_boot_pos != BINMAN_SYM_MISSING) {
179 /* Binman does not support separated entry addresses */
180 spl_image->entry_point = u_boot_pos;
181 spl_image->load_addr = u_boot_pos;
183 spl_image->entry_point = CONFIG_SYS_UBOOT_START;
184 spl_image->load_addr = CONFIG_SYS_TEXT_BASE;
186 spl_image->os = IH_OS_U_BOOT;
187 spl_image->name = "U-Boot";
190 #ifdef CONFIG_SPL_LOAD_FIT_FULL
191 /* Parse and load full fitImage in SPL */
192 static int spl_load_fit_image(struct spl_image_info *spl_image,
193 const struct image_header *header)
195 bootm_headers_t images;
196 const char *fit_uname_config = NULL;
197 const char *fit_uname_fdt = FIT_FDT_PROP;
199 ulong fw_data = 0, dt_data = 0, img_data = 0;
200 ulong fw_len = 0, dt_len = 0, img_len = 0;
201 int idx, conf_noffset;
204 #ifdef CONFIG_SPL_FIT_SIGNATURE
207 ret = fit_image_load(&images, (ulong)header,
208 NULL, &fit_uname_config,
209 IH_ARCH_DEFAULT, IH_TYPE_STANDALONE, -1,
210 FIT_LOAD_REQUIRED, &fw_data, &fw_len);
214 spl_image->size = fw_len;
215 spl_image->entry_point = fw_data;
216 spl_image->load_addr = fw_data;
217 spl_image->os = IH_OS_U_BOOT;
218 spl_image->name = "U-Boot";
220 debug(SPL_TPL_PROMPT "payload image: %32s load addr: 0x%lx size: %d\n",
221 spl_image->name, spl_image->load_addr, spl_image->size);
223 #ifdef CONFIG_SPL_FIT_SIGNATURE
226 ret = fit_image_load(&images, (ulong)header,
227 &fit_uname_fdt, &fit_uname_config,
228 IH_ARCH_DEFAULT, IH_TYPE_FLATDT, -1,
229 FIT_LOAD_OPTIONAL, &dt_data, &dt_len);
231 spl_image->fdt_addr = (void *)dt_data;
233 conf_noffset = fit_conf_get_node((const void *)header,
235 if (conf_noffset <= 0)
239 uname = fdt_stringlist_get((const void *)header, conf_noffset,
240 FIT_LOADABLE_PROP, idx,
244 #ifdef CONFIG_SPL_FIT_SIGNATURE
247 ret = fit_image_load(&images, (ulong)header,
248 &uname, &fit_uname_config,
249 IH_ARCH_DEFAULT, IH_TYPE_LOADABLE, -1,
250 FIT_LOAD_OPTIONAL_NON_ZERO,
251 &img_data, &img_len);
260 __weak int spl_parse_legacy_header(struct spl_image_info *spl_image,
261 const struct image_header *header)
263 /* LEGACY image not supported */
264 debug("Legacy boot image support not enabled, proceeding to other boot methods\n");
268 int spl_parse_image_header(struct spl_image_info *spl_image,
269 const struct image_header *header)
271 #ifdef CONFIG_SPL_LOAD_FIT_FULL
272 int ret = spl_load_fit_image(spl_image, header);
277 if (image_get_magic(header) == IH_MAGIC) {
280 ret = spl_parse_legacy_header(spl_image, header);
284 #ifdef CONFIG_SPL_PANIC_ON_RAW_IMAGE
286 * CONFIG_SPL_PANIC_ON_RAW_IMAGE is defined when the
287 * code which loads images in SPL cannot guarantee that
288 * absolutely all read errors will be reported.
289 * An example is the LPC32XX MLC NAND driver, which
290 * will consider that a completely unreadable NAND block
291 * is bad, and thus should be skipped silently.
293 panic("** no mkimage signature but raw image not supported");
296 #ifdef CONFIG_SPL_OS_BOOT
299 if (!bootz_setup((ulong)header, &start, &end)) {
300 spl_image->name = "Linux";
301 spl_image->os = IH_OS_LINUX;
302 spl_image->load_addr = CONFIG_SYS_LOAD_ADDR;
303 spl_image->entry_point = CONFIG_SYS_LOAD_ADDR;
304 spl_image->size = end - start;
306 "payload zImage, load addr: 0x%lx size: %d\n",
307 spl_image->load_addr, spl_image->size);
312 #ifdef CONFIG_SPL_RAW_IMAGE_SUPPORT
313 /* Signature not found - assume u-boot.bin */
314 debug("mkimage signature not found - ih_magic = %x\n",
316 spl_set_header_raw_uboot(spl_image);
318 /* RAW image not supported, proceed to other boot methods. */
319 debug("Raw boot image support not enabled, proceeding to other boot methods\n");
327 __weak void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image)
329 typedef void __noreturn (*image_entry_noargs_t)(void);
331 image_entry_noargs_t image_entry =
332 (image_entry_noargs_t)spl_image->entry_point;
334 debug("image entry point: 0x%lx\n", spl_image->entry_point);
338 #if CONFIG_IS_ENABLED(HANDOFF)
340 * Set up the SPL hand-off information
342 * This is initially empty (zero) but can be written by
344 static int setup_spl_handoff(void)
346 struct spl_handoff *ho;
348 ho = bloblist_ensure(BLOBLISTT_SPL_HANDOFF, sizeof(struct spl_handoff));
355 __weak int handoff_arch_save(struct spl_handoff *ho)
360 static int write_spl_handoff(void)
362 struct spl_handoff *ho;
365 ho = bloblist_find(BLOBLISTT_SPL_HANDOFF, sizeof(struct spl_handoff));
368 handoff_save_dram(ho);
369 ret = handoff_arch_save(ho);
372 debug(SPL_TPL_PROMPT "Wrote SPL handoff\n");
377 static inline int setup_spl_handoff(void) { return 0; }
378 static inline int write_spl_handoff(void) { return 0; }
382 static int spl_common_init(bool setup_malloc)
386 #if CONFIG_VAL(SYS_MALLOC_F_LEN)
388 #ifdef CONFIG_MALLOC_F_ADDR
389 gd->malloc_base = CONFIG_MALLOC_F_ADDR;
391 gd->malloc_limit = CONFIG_VAL(SYS_MALLOC_F_LEN);
395 ret = bootstage_init(u_boot_first_phase());
397 debug("%s: Failed to set up bootstage: ret=%d\n", __func__,
401 #ifdef CONFIG_BOOTSTAGE_STASH
402 if (!u_boot_first_phase()) {
403 const void *stash = map_sysmem(CONFIG_BOOTSTAGE_STASH_ADDR,
404 CONFIG_BOOTSTAGE_STASH_SIZE);
406 ret = bootstage_unstash(stash, CONFIG_BOOTSTAGE_STASH_SIZE);
408 debug("%s: Failed to unstash bootstage: ret=%d\n",
411 #endif /* CONFIG_BOOTSTAGE_STASH */
412 bootstage_mark_name(spl_phase() == PHASE_TPL ? BOOTSTAGE_ID_START_TPL :
413 BOOTSTAGE_ID_START_SPL, SPL_TPL_NAME);
414 #if CONFIG_IS_ENABLED(LOG)
417 debug("%s: Failed to set up logging\n", __func__);
421 if (CONFIG_IS_ENABLED(OF_CONTROL) && !CONFIG_IS_ENABLED(OF_PLATDATA)) {
422 ret = fdtdec_setup();
424 debug("fdtdec_setup() returned error %d\n", ret);
428 if (CONFIG_IS_ENABLED(DM)) {
429 bootstage_start(BOOTSTAGE_ID_ACCUM_DM_SPL,
430 spl_phase() == PHASE_TPL ? "dm tpl" : "dm_spl");
431 /* With CONFIG_SPL_OF_PLATDATA, bring in all devices */
432 ret = dm_init_and_scan(!CONFIG_IS_ENABLED(OF_PLATDATA));
433 bootstage_accum(BOOTSTAGE_ID_ACCUM_DM_SPL);
435 debug("dm_init_and_scan() returned error %d\n", ret);
443 int spl_alloc_bd(void)
446 * NOTE: On some platforms (e.g. x86) bdata may be in flash and not
450 gd->bd = malloc(sizeof(*gd->bd));
458 int spl_early_init(void)
462 debug("%s\n", __func__);
464 ret = spl_common_init(true);
467 gd->flags |= GD_FLG_SPL_EARLY_INIT;
475 bool setup_malloc = !(IS_ENABLED(CONFIG_SPL_STACK_R) &&
476 IS_ENABLED(CONFIG_SPL_SYS_MALLOC_SIMPLE));
478 debug("%s\n", __func__);
480 if (!(gd->flags & GD_FLG_SPL_EARLY_INIT)) {
481 ret = spl_common_init(setup_malloc);
485 gd->flags |= GD_FLG_SPL_INIT;
490 #ifndef BOOT_DEVICE_NONE
491 #define BOOT_DEVICE_NONE 0xdeadbeef
494 __weak void board_boot_order(u32 *spl_boot_list)
496 spl_boot_list[0] = spl_boot_device();
499 static struct spl_image_loader *spl_ll_find_loader(uint boot_device)
501 struct spl_image_loader *drv =
502 ll_entry_start(struct spl_image_loader, spl_image_loader);
504 ll_entry_count(struct spl_image_loader, spl_image_loader);
505 struct spl_image_loader *entry;
507 for (entry = drv; entry != drv + n_ents; entry++) {
508 if (boot_device == entry->boot_device)
516 static int spl_load_image(struct spl_image_info *spl_image,
517 struct spl_image_loader *loader)
520 struct spl_boot_device bootdev;
522 bootdev.boot_device = loader->boot_device;
523 bootdev.boot_device_name = NULL;
525 ret = loader->load_image(spl_image, &bootdev);
526 #ifdef CONFIG_SPL_LEGACY_IMAGE_CRC_CHECK
527 if (!ret && spl_image->dcrc_length) {
529 ulong dcrc = crc32_wd(0, (unsigned char *)spl_image->dcrc_data,
530 spl_image->dcrc_length, CHUNKSZ_CRC32);
531 if (dcrc != spl_image->dcrc) {
532 puts("SPL: Image data CRC check failed!\n");
541 * boot_from_devices() - Try loading a booting U-Boot from a list of devices
543 * @spl_image: Place to put the image details if successful
544 * @spl_boot_list: List of boot devices to try
545 * @count: Number of elements in spl_boot_list
546 * @return 0 if OK, -ve on error
548 static int boot_from_devices(struct spl_image_info *spl_image,
549 u32 spl_boot_list[], int count)
553 for (i = 0; i < count && spl_boot_list[i] != BOOT_DEVICE_NONE; i++) {
554 struct spl_image_loader *loader;
556 loader = spl_ll_find_loader(spl_boot_list[i]);
557 #if defined(CONFIG_SPL_SERIAL_SUPPORT) \
558 && defined(CONFIG_SPL_LIBCOMMON_SUPPORT) \
559 && !defined(CONFIG_SILENT_CONSOLE)
561 printf("Trying to boot from %s\n", loader->name);
563 puts(SPL_TPL_PROMPT "Unsupported Boot Device!\n");
565 if (loader && !spl_load_image(spl_image, loader)) {
566 spl_image->boot_device = spl_boot_list[i];
574 #if defined(CONFIG_SPL_FRAMEWORK_BOARD_INIT_F)
575 void board_init_f(ulong dummy)
577 if (CONFIG_IS_ENABLED(OF_CONTROL)) {
580 ret = spl_early_init();
582 debug("spl_early_init() failed: %d\n", ret);
587 preloader_console_init();
591 void board_init_r(gd_t *dummy1, ulong dummy2)
593 u32 spl_boot_list[] = {
600 struct spl_image_info spl_image;
603 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 (IS_ENABLED(CONFIG_SPL_ALLOC_BD) && spl_alloc_bd()) {
615 puts("Cannot alloc bd\n");
618 #if !defined(CONFIG_PPC) && !defined(CONFIG_ARCH_MX6)
620 * timer_init() does not exist on PPC systems. The timer is initialized
621 * and enabled (decrementer) in interrupt_init() here.
625 if (CONFIG_IS_ENABLED(BLOBLIST)) {
626 ret = bloblist_init();
628 debug("%s: Failed to set up bloblist: ret=%d\n",
630 puts(SPL_TPL_PROMPT "Cannot set up bloblist\n");
634 if (CONFIG_IS_ENABLED(HANDOFF)) {
637 ret = setup_spl_handoff();
639 puts(SPL_TPL_PROMPT "Cannot set up SPL handoff\n");
644 #if CONFIG_IS_ENABLED(BOARD_INIT)
648 #if defined(CONFIG_SPL_WATCHDOG_SUPPORT) && CONFIG_IS_ENABLED(WDT)
652 if (IS_ENABLED(CONFIG_SPL_OS_BOOT) || CONFIG_IS_ENABLED(HANDOFF) ||
653 IS_ENABLED(CONFIG_SPL_ATF))
654 dram_init_banksize();
658 memset(&spl_image, '\0', sizeof(spl_image));
659 #ifdef CONFIG_SYS_SPL_ARGS_ADDR
660 spl_image.arg = (void *)CONFIG_SYS_SPL_ARGS_ADDR;
662 spl_image.boot_device = BOOT_DEVICE_NONE;
663 board_boot_order(spl_boot_list);
665 if (boot_from_devices(&spl_image, spl_boot_list,
666 ARRAY_SIZE(spl_boot_list))) {
667 puts(SPL_TPL_PROMPT "failed to boot from all boot devices\n");
671 spl_perform_fixups(&spl_image);
672 if (CONFIG_IS_ENABLED(HANDOFF)) {
673 ret = write_spl_handoff();
675 printf(SPL_TPL_PROMPT
676 "SPL hand-off write failed (err=%d)\n", ret);
678 if (CONFIG_IS_ENABLED(BLOBLIST)) {
679 ret = bloblist_finish();
681 printf("Warning: Failed to finish bloblist (ret=%d)\n",
685 #ifdef CONFIG_CPU_V7M
686 spl_image.entry_point |= 0x1;
688 switch (spl_image.os) {
690 debug("Jumping to U-Boot\n");
692 #if CONFIG_IS_ENABLED(ATF)
693 case IH_OS_ARM_TRUSTED_FIRMWARE:
694 debug("Jumping to U-Boot via ARM Trusted Firmware\n");
695 spl_fixup_fdt(spl_image.fdt_addr);
696 spl_invoke_atf(&spl_image);
699 #if CONFIG_IS_ENABLED(OPTEE)
701 debug("Jumping to U-Boot via OP-TEE\n");
702 spl_optee_entry(NULL, NULL, spl_image.fdt_addr,
703 (void *)spl_image.entry_point);
706 #if CONFIG_IS_ENABLED(OPENSBI)
708 debug("Jumping to U-Boot via RISC-V OpenSBI\n");
709 spl_invoke_opensbi(&spl_image);
712 #ifdef CONFIG_SPL_OS_BOOT
714 debug("Jumping to Linux\n");
715 #if defined(CONFIG_SYS_SPL_ARGS_ADDR)
716 spl_fixup_fdt((void *)CONFIG_SYS_SPL_ARGS_ADDR);
718 spl_board_prepare_for_linux();
719 jump_to_image_linux(&spl_image);
722 debug("Unsupported OS image.. Jumping nevertheless..\n");
724 #if CONFIG_VAL(SYS_MALLOC_F_LEN) && !defined(CONFIG_SYS_SPL_MALLOC_SIZE)
725 debug("SPL malloc() used 0x%lx bytes (%ld KB)\n", gd->malloc_ptr,
726 gd->malloc_ptr / 1024);
728 bootstage_mark_name(spl_phase() == PHASE_TPL ? BOOTSTAGE_ID_END_TPL :
729 BOOTSTAGE_ID_END_SPL, "end " SPL_TPL_NAME);
730 #ifdef CONFIG_BOOTSTAGE_STASH
731 ret = bootstage_stash((void *)CONFIG_BOOTSTAGE_STASH_ADDR,
732 CONFIG_BOOTSTAGE_STASH_SIZE);
734 debug("Failed to stash bootstage: err=%d\n", ret);
737 debug("loaded - jumping to U-Boot...\n");
738 spl_board_prepare_for_boot();
739 jump_to_image_no_args(&spl_image);
743 * This requires UART clocks to be enabled. In order for this to work the
744 * caller must ensure that the gd pointer is valid.
746 void preloader_console_init(void)
748 #ifdef CONFIG_SPL_SERIAL_SUPPORT
749 gd->baudrate = CONFIG_BAUDRATE;
751 serial_init(); /* serial communications setup */
753 gd->have_console = 1;
755 #if CONFIG_IS_ENABLED(BANNER_PRINT)
756 puts("\nU-Boot " SPL_TPL_NAME " " PLAIN_VERSION " (" U_BOOT_DATE " - "
757 U_BOOT_TIME " " U_BOOT_TZ ")\n");
759 #ifdef CONFIG_SPL_DISPLAY_PRINT
766 * This function is called before the stack is changed from initial stack to
767 * relocated stack. It tries to dump the stack size used
769 __weak void spl_relocate_stack_check(void)
771 #if CONFIG_IS_ENABLED(SYS_REPORT_STACK_F_USAGE)
772 ulong init_sp = gd->start_addr_sp;
773 ulong stack_bottom = init_sp - CONFIG_VAL(SIZE_LIMIT_PROVIDE_STACK);
774 u8 *ptr = (u8 *)stack_bottom;
777 for (i = 0; i < CONFIG_VAL(SIZE_LIMIT_PROVIDE_STACK); i++) {
778 if (*ptr != CONFIG_VAL(SYS_STACK_F_CHECK_BYTE))
782 printf("SPL initial stack usage: %lu bytes\n",
783 CONFIG_VAL(SIZE_LIMIT_PROVIDE_STACK) - i);
788 * spl_relocate_stack_gd() - Relocate stack ready for board_init_r() execution
790 * Sometimes board_init_f() runs with a stack in SRAM but we want to use SDRAM
791 * for the main board_init_r() execution. This is typically because we need
792 * more stack space for things like the MMC sub-system.
794 * This function calculates the stack position, copies the global_data into
795 * place, sets the new gd (except for ARM, for which setting GD within a C
796 * function may not always work) and returns the new stack position. The
797 * caller is responsible for setting up the sp register and, in the case
798 * of ARM, setting up gd.
800 * All of this is done using the same layout and alignments as done in
801 * board_init_f_init_reserve() / board_init_f_alloc_reserve().
803 * @return new stack location, or 0 to use the same stack
805 ulong spl_relocate_stack_gd(void)
807 #ifdef CONFIG_SPL_STACK_R
809 ulong ptr = CONFIG_SPL_STACK_R_ADDR;
811 if (CONFIG_IS_ENABLED(SYS_REPORT_STACK_F_USAGE))
812 spl_relocate_stack_check();
814 #if defined(CONFIG_SPL_SYS_MALLOC_SIMPLE) && CONFIG_VAL(SYS_MALLOC_F_LEN)
815 if (CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN) {
816 debug("SPL malloc() before relocation used 0x%lx bytes (%ld KB)\n",
817 gd->malloc_ptr, gd->malloc_ptr / 1024);
818 ptr -= CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN;
819 gd->malloc_base = ptr;
820 gd->malloc_limit = CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN;
824 /* Get stack position: use 8-byte alignment for ABI compliance */
825 ptr = CONFIG_SPL_STACK_R_ADDR - roundup(sizeof(gd_t),16);
826 new_gd = (gd_t *)ptr;
827 memcpy(new_gd, (void *)gd, sizeof(gd_t));
828 #if CONFIG_IS_ENABLED(DM)
829 dm_fixup_for_gd_move(new_gd);
831 #if !defined(CONFIG_ARM) && !defined(CONFIG_RISCV)
840 #if defined(CONFIG_BOOTCOUNT_LIMIT) && !defined(CONFIG_SPL_BOOTCOUNT_LIMIT)
841 void bootcount_store(ulong a)
845 ulong bootcount_load(void)