1 // SPDX-License-Identifier: GPL-2.0+
4 * Texas Instruments, <www.ti.com>
6 * Aneesh V <aneesh@ti.com>
11 #include <binman_sym.h>
18 #include <asm/u-boot.h>
21 #include <u-boot/crc.h>
27 #include <linux/compiler.h>
28 #include <fdt_support.h>
29 #include <bootcount.h>
32 DECLARE_GLOBAL_DATA_PTR;
34 #ifndef CONFIG_SYS_UBOOT_START
35 #define CONFIG_SYS_UBOOT_START CONFIG_SYS_TEXT_BASE
37 #ifndef CONFIG_SYS_MONITOR_LEN
38 /* Unknown U-Boot size, let's assume it will not be more than 200 KB */
39 #define CONFIG_SYS_MONITOR_LEN (200 * 1024)
42 u32 *boot_params_ptr = NULL;
44 /* See spl.h for information about this */
45 binman_sym_declare(ulong, u_boot_any, image_pos);
46 binman_sym_declare(ulong, u_boot_any, size);
49 binman_sym_declare(ulong, spl, image_pos);
50 binman_sym_declare(ulong, spl, size);
53 /* Define board data structure */
54 static bd_t bdata __attribute__ ((section(".data")));
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 /* weak, default platform-specific function to initialize dram banks */
63 __weak int dram_init_banksize(void)
70 * Default function to determine if u-boot or the OS should
71 * be started. This implementation always returns 1.
73 * Please implement your own board specific funcion to do this.
76 * 0 to not start u-boot
77 * positive if u-boot should start
79 #ifdef CONFIG_SPL_OS_BOOT
80 __weak int spl_start_uboot(void)
83 "Please implement spl_start_uboot() for your board\n");
84 puts(SPL_TPL_PROMPT "Direct Linux boot not active!\n");
89 * Weak default function for arch specific zImage check. Return zero
90 * and fill start and end address if image is recognized.
92 int __weak bootz_setup(ulong image, ulong *start, ulong *end)
98 /* Weak default function for arch/board-specific fixups to the spl_image_info */
99 void __weak spl_perform_fixups(struct spl_image_info *spl_image)
103 void spl_fixup_fdt(void)
105 #if defined(CONFIG_SPL_OF_LIBFDT) && defined(CONFIG_SYS_SPL_ARGS_ADDR)
106 void *fdt_blob = (void *)CONFIG_SYS_SPL_ARGS_ADDR;
109 err = fdt_check_header(fdt_blob);
111 printf("fdt_root: %s\n", fdt_strerror(err));
115 /* fixup the memory dt node */
116 err = fdt_shrink_to_minimum(fdt_blob, 0);
118 printf(SPL_TPL_PROMPT "fdt_shrink_to_minimum err - %d\n", err);
122 err = arch_fixup_fdt(fdt_blob);
124 printf(SPL_TPL_PROMPT "arch_fixup_fdt err - %d\n", err);
130 ulong spl_get_image_pos(void)
132 return spl_phase() == PHASE_TPL ?
133 binman_sym(ulong, spl, image_pos) :
134 binman_sym(ulong, u_boot_any, image_pos);
137 ulong spl_get_image_size(void)
139 return spl_phase() == PHASE_TPL ?
140 binman_sym(ulong, spl, size) :
141 binman_sym(ulong, u_boot_any, size);
145 * Weak default function for board specific cleanup/preparation before
146 * Linux boot. Some boards/platforms might not need it, so just provide
147 * an empty stub here.
149 __weak void spl_board_prepare_for_linux(void)
154 __weak void spl_board_prepare_for_boot(void)
159 __weak struct image_header *spl_get_load_buffer(ssize_t offset, size_t size)
161 return (struct image_header *)(CONFIG_SYS_TEXT_BASE + offset);
164 void spl_set_header_raw_uboot(struct spl_image_info *spl_image)
166 ulong u_boot_pos = binman_sym(ulong, u_boot_any, image_pos);
168 spl_image->size = CONFIG_SYS_MONITOR_LEN;
171 * Binman error cases: address of the end of the previous region or the
172 * start of the image's entry area (usually 0) if there is no previous
175 if (u_boot_pos && u_boot_pos != BINMAN_SYM_MISSING) {
176 /* Binman does not support separated entry addresses */
177 spl_image->entry_point = u_boot_pos;
178 spl_image->load_addr = u_boot_pos;
180 spl_image->entry_point = CONFIG_SYS_UBOOT_START;
181 spl_image->load_addr = CONFIG_SYS_TEXT_BASE;
183 spl_image->os = IH_OS_U_BOOT;
184 spl_image->name = "U-Boot";
187 #ifdef CONFIG_SPL_LOAD_FIT_FULL
188 /* Parse and load full fitImage in SPL */
189 static int spl_load_fit_image(struct spl_image_info *spl_image,
190 const struct image_header *header)
192 bootm_headers_t images;
193 const char *fit_uname_config = NULL;
194 const char *fit_uname_fdt = FIT_FDT_PROP;
196 ulong fw_data = 0, dt_data = 0, img_data = 0;
197 ulong fw_len = 0, dt_len = 0, img_len = 0;
198 int idx, conf_noffset;
201 #ifdef CONFIG_SPL_FIT_SIGNATURE
204 ret = fit_image_load(&images, (ulong)header,
205 NULL, &fit_uname_config,
206 IH_ARCH_DEFAULT, IH_TYPE_STANDALONE, -1,
207 FIT_LOAD_REQUIRED, &fw_data, &fw_len);
211 spl_image->size = fw_len;
212 spl_image->entry_point = fw_data;
213 spl_image->load_addr = fw_data;
214 spl_image->os = IH_OS_U_BOOT;
215 spl_image->name = "U-Boot";
217 debug(SPL_TPL_PROMPT "payload image: %32s load addr: 0x%lx size: %d\n",
218 spl_image->name, spl_image->load_addr, spl_image->size);
220 #ifdef CONFIG_SPL_FIT_SIGNATURE
223 ret = fit_image_load(&images, (ulong)header,
224 &fit_uname_fdt, &fit_uname_config,
225 IH_ARCH_DEFAULT, IH_TYPE_FLATDT, -1,
226 FIT_LOAD_OPTIONAL, &dt_data, &dt_len);
228 spl_image->fdt_addr = (void *)dt_data;
230 conf_noffset = fit_conf_get_node((const void *)header,
232 if (conf_noffset <= 0)
236 uname = fdt_stringlist_get((const void *)header, conf_noffset,
237 FIT_LOADABLE_PROP, idx,
241 #ifdef CONFIG_SPL_FIT_SIGNATURE
244 ret = fit_image_load(&images, (ulong)header,
245 &uname, &fit_uname_config,
246 IH_ARCH_DEFAULT, IH_TYPE_LOADABLE, -1,
247 FIT_LOAD_OPTIONAL_NON_ZERO,
248 &img_data, &img_len);
257 __weak int spl_parse_legacy_header(struct spl_image_info *spl_image,
258 const struct image_header *header)
260 /* LEGACY image not supported */
261 debug("Legacy boot image support not enabled, proceeding to other boot methods\n");
265 int spl_parse_image_header(struct spl_image_info *spl_image,
266 const struct image_header *header)
268 #ifdef CONFIG_SPL_LOAD_FIT_FULL
269 int ret = spl_load_fit_image(spl_image, header);
274 if (image_get_magic(header) == IH_MAGIC) {
277 ret = spl_parse_legacy_header(spl_image, header);
281 #ifdef CONFIG_SPL_PANIC_ON_RAW_IMAGE
283 * CONFIG_SPL_PANIC_ON_RAW_IMAGE is defined when the
284 * code which loads images in SPL cannot guarantee that
285 * absolutely all read errors will be reported.
286 * An example is the LPC32XX MLC NAND driver, which
287 * will consider that a completely unreadable NAND block
288 * is bad, and thus should be skipped silently.
290 panic("** no mkimage signature but raw image not supported");
293 #ifdef CONFIG_SPL_OS_BOOT
296 if (!bootz_setup((ulong)header, &start, &end)) {
297 spl_image->name = "Linux";
298 spl_image->os = IH_OS_LINUX;
299 spl_image->load_addr = CONFIG_SYS_LOAD_ADDR;
300 spl_image->entry_point = CONFIG_SYS_LOAD_ADDR;
301 spl_image->size = end - start;
303 "payload zImage, load addr: 0x%lx size: %d\n",
304 spl_image->load_addr, spl_image->size);
309 #ifdef CONFIG_SPL_RAW_IMAGE_SUPPORT
310 /* Signature not found - assume u-boot.bin */
311 debug("mkimage signature not found - ih_magic = %x\n",
313 spl_set_header_raw_uboot(spl_image);
315 /* RAW image not supported, proceed to other boot methods. */
316 debug("Raw boot image support not enabled, proceeding to other boot methods\n");
324 __weak void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image)
326 typedef void __noreturn (*image_entry_noargs_t)(void);
328 image_entry_noargs_t image_entry =
329 (image_entry_noargs_t)spl_image->entry_point;
331 debug("image entry point: 0x%lx\n", spl_image->entry_point);
335 #if CONFIG_IS_ENABLED(HANDOFF)
337 * Set up the SPL hand-off information
339 * This is initially empty (zero) but can be written by
341 static int setup_spl_handoff(void)
343 struct spl_handoff *ho;
345 ho = bloblist_ensure(BLOBLISTT_SPL_HANDOFF, sizeof(struct spl_handoff));
352 __weak int handoff_arch_save(struct spl_handoff *ho)
357 static int write_spl_handoff(void)
359 struct spl_handoff *ho;
362 ho = bloblist_find(BLOBLISTT_SPL_HANDOFF, sizeof(struct spl_handoff));
365 handoff_save_dram(ho);
366 ret = handoff_arch_save(ho);
369 debug(SPL_TPL_PROMPT "Wrote SPL handoff\n");
374 static inline int setup_spl_handoff(void) { return 0; }
375 static inline int write_spl_handoff(void) { return 0; }
379 static int spl_common_init(bool setup_malloc)
383 #if CONFIG_VAL(SYS_MALLOC_F_LEN)
385 #ifdef CONFIG_MALLOC_F_ADDR
386 gd->malloc_base = CONFIG_MALLOC_F_ADDR;
388 gd->malloc_limit = CONFIG_VAL(SYS_MALLOC_F_LEN);
392 ret = bootstage_init(u_boot_first_phase());
394 debug("%s: Failed to set up bootstage: ret=%d\n", __func__,
398 #ifdef CONFIG_BOOTSTAGE_STASH
399 if (!u_boot_first_phase()) {
400 const void *stash = map_sysmem(CONFIG_BOOTSTAGE_STASH_ADDR,
401 CONFIG_BOOTSTAGE_STASH_SIZE);
403 ret = bootstage_unstash(stash, CONFIG_BOOTSTAGE_STASH_SIZE);
405 debug("%s: Failed to unstash bootstage: ret=%d\n",
408 #endif /* CONFIG_BOOTSTAGE_STASH */
409 bootstage_mark_name(spl_phase() == PHASE_TPL ? BOOTSTAGE_ID_START_TPL :
410 BOOTSTAGE_ID_START_SPL, SPL_TPL_NAME);
411 #if CONFIG_IS_ENABLED(LOG)
414 debug("%s: Failed to set up logging\n", __func__);
418 if (CONFIG_IS_ENABLED(OF_CONTROL) && !CONFIG_IS_ENABLED(OF_PLATDATA)) {
419 ret = fdtdec_setup();
421 debug("fdtdec_setup() returned error %d\n", ret);
425 if (CONFIG_IS_ENABLED(DM)) {
426 bootstage_start(BOOTSTATE_ID_ACCUM_DM_SPL,
427 spl_phase() == PHASE_TPL ? "dm tpl" : "dm_spl");
428 /* With CONFIG_SPL_OF_PLATDATA, bring in all devices */
429 ret = dm_init_and_scan(!CONFIG_IS_ENABLED(OF_PLATDATA));
430 bootstage_accum(BOOTSTATE_ID_ACCUM_DM_SPL);
432 debug("dm_init_and_scan() returned error %d\n", ret);
440 void spl_set_bd(void)
443 * NOTE: On some platforms (e.g. x86) bdata may be in flash and not
450 int spl_early_init(void)
454 debug("%s\n", __func__);
456 ret = spl_common_init(true);
459 gd->flags |= GD_FLG_SPL_EARLY_INIT;
467 bool setup_malloc = !(IS_ENABLED(CONFIG_SPL_STACK_R) &&
468 IS_ENABLED(CONFIG_SPL_SYS_MALLOC_SIMPLE));
470 debug("%s\n", __func__);
472 if (!(gd->flags & GD_FLG_SPL_EARLY_INIT)) {
473 ret = spl_common_init(setup_malloc);
477 gd->flags |= GD_FLG_SPL_INIT;
482 #ifndef BOOT_DEVICE_NONE
483 #define BOOT_DEVICE_NONE 0xdeadbeef
486 __weak void board_boot_order(u32 *spl_boot_list)
488 spl_boot_list[0] = spl_boot_device();
491 static struct spl_image_loader *spl_ll_find_loader(uint boot_device)
493 struct spl_image_loader *drv =
494 ll_entry_start(struct spl_image_loader, spl_image_loader);
496 ll_entry_count(struct spl_image_loader, spl_image_loader);
497 struct spl_image_loader *entry;
499 for (entry = drv; entry != drv + n_ents; entry++) {
500 if (boot_device == entry->boot_device)
508 static int spl_load_image(struct spl_image_info *spl_image,
509 struct spl_image_loader *loader)
512 struct spl_boot_device bootdev;
514 bootdev.boot_device = loader->boot_device;
515 bootdev.boot_device_name = NULL;
517 ret = loader->load_image(spl_image, &bootdev);
518 #ifdef CONFIG_SPL_LEGACY_IMAGE_CRC_CHECK
519 if (!ret && spl_image->dcrc_length) {
521 ulong dcrc = crc32_wd(0, (unsigned char *)spl_image->dcrc_data,
522 spl_image->dcrc_length, CHUNKSZ_CRC32);
523 if (dcrc != spl_image->dcrc) {
524 puts("SPL: Image data CRC check failed!\n");
533 * boot_from_devices() - Try loading a booting U-Boot from a list of devices
535 * @spl_image: Place to put the image details if successful
536 * @spl_boot_list: List of boot devices to try
537 * @count: Number of elements in spl_boot_list
538 * @return 0 if OK, -ve on error
540 static int boot_from_devices(struct spl_image_info *spl_image,
541 u32 spl_boot_list[], int count)
545 for (i = 0; i < count && spl_boot_list[i] != BOOT_DEVICE_NONE; i++) {
546 struct spl_image_loader *loader;
548 loader = spl_ll_find_loader(spl_boot_list[i]);
549 #if defined(CONFIG_SPL_SERIAL_SUPPORT) && defined(CONFIG_SPL_LIBCOMMON_SUPPORT)
551 printf("Trying to boot from %s\n", loader->name);
553 puts(SPL_TPL_PROMPT "Unsupported Boot Device!\n");
555 if (loader && !spl_load_image(spl_image, loader)) {
556 spl_image->boot_device = spl_boot_list[i];
564 #if defined(CONFIG_SPL_FRAMEWORK_BOARD_INIT_F)
565 void board_init_f(ulong dummy)
567 if (CONFIG_IS_ENABLED(OF_CONTROL)) {
570 ret = spl_early_init();
572 debug("spl_early_init() failed: %d\n", ret);
577 if (CONFIG_IS_ENABLED(SERIAL_SUPPORT))
578 preloader_console_init();
582 void board_init_r(gd_t *dummy1, ulong dummy2)
584 u32 spl_boot_list[] = {
591 struct spl_image_info spl_image;
594 debug(">>" SPL_TPL_PROMPT "board_init_r()\n");
598 #if defined(CONFIG_SYS_SPL_MALLOC_START)
599 mem_malloc_init(CONFIG_SYS_SPL_MALLOC_START,
600 CONFIG_SYS_SPL_MALLOC_SIZE);
601 gd->flags |= GD_FLG_FULL_MALLOC_INIT;
603 if (!(gd->flags & GD_FLG_SPL_INIT)) {
607 #if !defined(CONFIG_PPC) && !defined(CONFIG_ARCH_MX6)
609 * timer_init() does not exist on PPC systems. The timer is initialized
610 * and enabled (decrementer) in interrupt_init() here.
614 if (CONFIG_IS_ENABLED(BLOBLIST)) {
615 ret = bloblist_init();
617 debug("%s: Failed to set up bloblist: ret=%d\n",
619 puts(SPL_TPL_PROMPT "Cannot set up bloblist\n");
623 if (CONFIG_IS_ENABLED(HANDOFF)) {
626 ret = setup_spl_handoff();
628 puts(SPL_TPL_PROMPT "Cannot set up SPL handoff\n");
633 #if CONFIG_IS_ENABLED(BOARD_INIT)
637 #if defined(CONFIG_SPL_WATCHDOG_SUPPORT) && CONFIG_IS_ENABLED(WDT)
641 if (IS_ENABLED(CONFIG_SPL_OS_BOOT) || CONFIG_IS_ENABLED(HANDOFF))
642 dram_init_banksize();
646 memset(&spl_image, '\0', sizeof(spl_image));
647 #ifdef CONFIG_SYS_SPL_ARGS_ADDR
648 spl_image.arg = (void *)CONFIG_SYS_SPL_ARGS_ADDR;
650 spl_image.boot_device = BOOT_DEVICE_NONE;
651 board_boot_order(spl_boot_list);
653 if (boot_from_devices(&spl_image, spl_boot_list,
654 ARRAY_SIZE(spl_boot_list))) {
655 puts(SPL_TPL_PROMPT "failed to boot from all boot devices\n");
659 spl_perform_fixups(&spl_image);
660 if (CONFIG_IS_ENABLED(HANDOFF)) {
661 ret = write_spl_handoff();
663 printf(SPL_TPL_PROMPT
664 "SPL hand-off write failed (err=%d)\n", ret);
666 if (CONFIG_IS_ENABLED(BLOBLIST)) {
667 ret = bloblist_finish();
669 printf("Warning: Failed to finish bloblist (ret=%d)\n",
673 #ifdef CONFIG_CPU_V7M
674 spl_image.entry_point |= 0x1;
676 switch (spl_image.os) {
678 debug("Jumping to U-Boot\n");
680 #if CONFIG_IS_ENABLED(ATF)
681 case IH_OS_ARM_TRUSTED_FIRMWARE:
682 debug("Jumping to U-Boot via ARM Trusted Firmware\n");
683 spl_invoke_atf(&spl_image);
686 #if CONFIG_IS_ENABLED(OPTEE)
688 debug("Jumping to U-Boot via OP-TEE\n");
689 spl_optee_entry(NULL, NULL, spl_image.fdt_addr,
690 (void *)spl_image.entry_point);
693 #if CONFIG_IS_ENABLED(OPENSBI)
695 debug("Jumping to U-Boot via RISC-V OpenSBI\n");
696 spl_invoke_opensbi(&spl_image);
699 #ifdef CONFIG_SPL_OS_BOOT
701 debug("Jumping to Linux\n");
703 spl_board_prepare_for_linux();
704 jump_to_image_linux(&spl_image);
707 debug("Unsupported OS image.. Jumping nevertheless..\n");
709 #if CONFIG_VAL(SYS_MALLOC_F_LEN) && !defined(CONFIG_SYS_SPL_MALLOC_SIZE)
710 debug("SPL malloc() used 0x%lx bytes (%ld KB)\n", gd->malloc_ptr,
711 gd->malloc_ptr / 1024);
713 bootstage_mark_name(spl_phase() == PHASE_TPL ? BOOTSTAGE_ID_END_TPL :
714 BOOTSTAGE_ID_END_SPL, "end " SPL_TPL_NAME);
715 #ifdef CONFIG_BOOTSTAGE_STASH
716 ret = bootstage_stash((void *)CONFIG_BOOTSTAGE_STASH_ADDR,
717 CONFIG_BOOTSTAGE_STASH_SIZE);
719 debug("Failed to stash bootstage: err=%d\n", ret);
722 debug("loaded - jumping to U-Boot...\n");
723 spl_board_prepare_for_boot();
724 jump_to_image_no_args(&spl_image);
727 #ifdef CONFIG_SPL_SERIAL_SUPPORT
729 * This requires UART clocks to be enabled. In order for this to work the
730 * caller must ensure that the gd pointer is valid.
732 void preloader_console_init(void)
734 gd->baudrate = CONFIG_BAUDRATE;
736 serial_init(); /* serial communications setup */
738 gd->have_console = 1;
740 #if CONFIG_IS_ENABLED(BANNER_PRINT)
741 puts("\nU-Boot " SPL_TPL_NAME " " PLAIN_VERSION " (" U_BOOT_DATE " - "
742 U_BOOT_TIME " " U_BOOT_TZ ")\n");
744 #ifdef CONFIG_SPL_DISPLAY_PRINT
751 * This function is called before the stack is changed from initial stack to
752 * relocated stack. It tries to dump the stack size used
754 __weak void spl_relocate_stack_check(void)
756 #if CONFIG_IS_ENABLED(SYS_REPORT_STACK_F_USAGE)
757 ulong init_sp = gd->start_addr_sp;
758 ulong stack_bottom = init_sp - CONFIG_VAL(SIZE_LIMIT_PROVIDE_STACK);
759 u8 *ptr = (u8 *)stack_bottom;
762 for (i = 0; i < CONFIG_VAL(SIZE_LIMIT_PROVIDE_STACK); i++) {
763 if (*ptr != CONFIG_VAL(SYS_STACK_F_CHECK_BYTE))
767 printf("SPL initial stack usage: %lu bytes\n",
768 CONFIG_VAL(SIZE_LIMIT_PROVIDE_STACK) - i);
773 * spl_relocate_stack_gd() - Relocate stack ready for board_init_r() execution
775 * Sometimes board_init_f() runs with a stack in SRAM but we want to use SDRAM
776 * for the main board_init_r() execution. This is typically because we need
777 * more stack space for things like the MMC sub-system.
779 * This function calculates the stack position, copies the global_data into
780 * place, sets the new gd (except for ARM, for which setting GD within a C
781 * function may not always work) and returns the new stack position. The
782 * caller is responsible for setting up the sp register and, in the case
783 * of ARM, setting up gd.
785 * All of this is done using the same layout and alignments as done in
786 * board_init_f_init_reserve() / board_init_f_alloc_reserve().
788 * @return new stack location, or 0 to use the same stack
790 ulong spl_relocate_stack_gd(void)
792 #ifdef CONFIG_SPL_STACK_R
794 ulong ptr = CONFIG_SPL_STACK_R_ADDR;
796 if (CONFIG_IS_ENABLED(SYS_REPORT_STACK_F_USAGE))
797 spl_relocate_stack_check();
799 #if defined(CONFIG_SPL_SYS_MALLOC_SIMPLE) && CONFIG_VAL(SYS_MALLOC_F_LEN)
800 if (CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN) {
801 debug("SPL malloc() before relocation used 0x%lx bytes (%ld KB)\n",
802 gd->malloc_ptr, gd->malloc_ptr / 1024);
803 ptr -= CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN;
804 gd->malloc_base = ptr;
805 gd->malloc_limit = CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN;
809 /* Get stack position: use 8-byte alignment for ABI compliance */
810 ptr = CONFIG_SPL_STACK_R_ADDR - roundup(sizeof(gd_t),16);
811 new_gd = (gd_t *)ptr;
812 memcpy(new_gd, (void *)gd, sizeof(gd_t));
813 #if CONFIG_IS_ENABLED(DM)
814 dm_fixup_for_gd_move(new_gd);
816 #if !defined(CONFIG_ARM) && !defined(CONFIG_RISCV)
825 #if defined(CONFIG_BOOTCOUNT_LIMIT) && !defined(CONFIG_SPL_BOOTCOUNT_LIMIT)
826 void bootcount_store(ulong a)
830 ulong bootcount_load(void)