1 // SPDX-License-Identifier: GPL-2.0+
4 * Texas Instruments, <www.ti.com>
11 #include <binman_sym.h>
15 #include <asm/u-boot.h>
22 #include <linux/compiler.h>
23 #include <fdt_support.h>
24 #include <bootcount.h>
27 DECLARE_GLOBAL_DATA_PTR;
29 #ifndef CONFIG_SYS_UBOOT_START
30 #define CONFIG_SYS_UBOOT_START CONFIG_SYS_TEXT_BASE
32 #ifndef CONFIG_SYS_MONITOR_LEN
33 /* Unknown U-Boot size, let's assume it will not be more than 200 KB */
34 #define CONFIG_SYS_MONITOR_LEN (200 * 1024)
37 u32 *boot_params_ptr = NULL;
39 /* See spl.h for information about this */
40 binman_sym_declare(ulong, u_boot_any, image_pos);
42 /* Define board data structure */
43 static bd_t bdata __attribute__ ((section(".data")));
46 * Board-specific Platform code can reimplement show_boot_progress () if needed
48 __weak void show_boot_progress(int val) {}
50 #if defined(CONFIG_SPL_OS_BOOT) || CONFIG_IS_ENABLED(HANDOFF)
51 /* weak, default platform-specific function to initialize dram banks */
52 __weak int dram_init_banksize(void)
59 * Default function to determine if u-boot or the OS should
60 * be started. This implementation always returns 1.
62 * Please implement your own board specific funcion to do this.
65 * 0 to not start u-boot
66 * positive if u-boot should start
68 #ifdef CONFIG_SPL_OS_BOOT
69 __weak int spl_start_uboot(void)
72 "Please implement spl_start_uboot() for your board\n");
73 puts(SPL_TPL_PROMPT "Direct Linux boot not active!\n");
78 * Weak default function for arch specific zImage check. Return zero
79 * and fill start and end address if image is recognized.
81 int __weak bootz_setup(ulong image, ulong *start, ulong *end)
87 /* Weak default function for arch/board-specific fixups to the spl_image_info */
88 void __weak spl_perform_fixups(struct spl_image_info *spl_image)
92 void spl_fixup_fdt(void)
94 #if defined(CONFIG_SPL_OF_LIBFDT) && defined(CONFIG_SYS_SPL_ARGS_ADDR)
95 void *fdt_blob = (void *)CONFIG_SYS_SPL_ARGS_ADDR;
98 err = fdt_check_header(fdt_blob);
100 printf("fdt_root: %s\n", fdt_strerror(err));
104 /* fixup the memory dt node */
105 err = fdt_shrink_to_minimum(fdt_blob, 0);
107 printf(SPL_TPL_PROMPT "fdt_shrink_to_minimum err - %d\n", err);
111 err = arch_fixup_fdt(fdt_blob);
113 printf(SPL_TPL_PROMPT "arch_fixup_fdt err - %d\n", err);
120 * Weak default function for board specific cleanup/preparation before
121 * Linux boot. Some boards/platforms might not need it, so just provide
122 * an empty stub here.
124 __weak void spl_board_prepare_for_linux(void)
129 __weak void spl_board_prepare_for_boot(void)
134 __weak struct image_header *spl_get_load_buffer(ssize_t offset, size_t size)
136 return (struct image_header *)(CONFIG_SYS_TEXT_BASE + offset);
139 void spl_set_header_raw_uboot(struct spl_image_info *spl_image)
141 ulong u_boot_pos = binman_sym(ulong, u_boot_any, image_pos);
143 spl_image->size = CONFIG_SYS_MONITOR_LEN;
146 * Binman error cases: address of the end of the previous region or the
147 * start of the image's entry area (usually 0) if there is no previous
150 if (u_boot_pos && u_boot_pos != BINMAN_SYM_MISSING) {
151 /* Binman does not support separated entry addresses */
152 spl_image->entry_point = u_boot_pos;
153 spl_image->load_addr = u_boot_pos;
155 spl_image->entry_point = CONFIG_SYS_UBOOT_START;
156 spl_image->load_addr = CONFIG_SYS_TEXT_BASE;
158 spl_image->os = IH_OS_U_BOOT;
159 spl_image->name = "U-Boot";
162 #ifdef CONFIG_SPL_LOAD_FIT_FULL
163 /* Parse and load full fitImage in SPL */
164 static int spl_load_fit_image(struct spl_image_info *spl_image,
165 const struct image_header *header)
167 bootm_headers_t images;
168 const char *fit_uname_config = NULL;
169 const char *fit_uname_fdt = FIT_FDT_PROP;
171 ulong fw_data = 0, dt_data = 0, img_data = 0;
172 ulong fw_len = 0, dt_len = 0, img_len = 0;
173 int idx, conf_noffset;
176 #ifdef CONFIG_SPL_FIT_SIGNATURE
179 ret = fit_image_load(&images, (ulong)header,
180 NULL, &fit_uname_config,
181 IH_ARCH_DEFAULT, IH_TYPE_STANDALONE, -1,
182 FIT_LOAD_REQUIRED, &fw_data, &fw_len);
186 spl_image->size = fw_len;
187 spl_image->entry_point = fw_data;
188 spl_image->load_addr = fw_data;
189 spl_image->os = IH_OS_U_BOOT;
190 spl_image->name = "U-Boot";
192 debug(SPL_TPL_PROMPT "payload image: %32s load addr: 0x%lx size: %d\n",
193 spl_image->name, spl_image->load_addr, spl_image->size);
195 #ifdef CONFIG_SPL_FIT_SIGNATURE
198 ret = fit_image_load(&images, (ulong)header,
199 &fit_uname_fdt, &fit_uname_config,
200 IH_ARCH_DEFAULT, IH_TYPE_FLATDT, -1,
201 FIT_LOAD_OPTIONAL, &dt_data, &dt_len);
203 spl_image->fdt_addr = (void *)dt_data;
205 conf_noffset = fit_conf_get_node((const void *)header,
207 if (conf_noffset <= 0)
211 uname = fdt_stringlist_get((const void *)header, conf_noffset,
212 FIT_LOADABLE_PROP, idx,
216 #ifdef CONFIG_SPL_FIT_SIGNATURE
219 ret = fit_image_load(&images, (ulong)header,
220 &uname, &fit_uname_config,
221 IH_ARCH_DEFAULT, IH_TYPE_LOADABLE, -1,
222 FIT_LOAD_OPTIONAL_NON_ZERO,
223 &img_data, &img_len);
232 int spl_parse_image_header(struct spl_image_info *spl_image,
233 const struct image_header *header)
235 #ifdef CONFIG_SPL_LOAD_FIT_FULL
236 int ret = spl_load_fit_image(spl_image, header);
241 if (image_get_magic(header) == IH_MAGIC) {
242 #ifdef CONFIG_SPL_LEGACY_IMAGE_SUPPORT
243 u32 header_size = sizeof(struct image_header);
245 #ifdef CONFIG_SPL_LEGACY_IMAGE_CRC_CHECK
246 /* check uImage header CRC */
247 if (!image_check_hcrc(header)) {
248 puts("SPL: Image header CRC check failed!\n");
253 if (spl_image->flags & SPL_COPY_PAYLOAD_ONLY) {
255 * On some system (e.g. powerpc), the load-address and
256 * entry-point is located at address 0. We can't load
257 * to 0-0x40. So skip header in this case.
259 spl_image->load_addr = image_get_load(header);
260 spl_image->entry_point = image_get_ep(header);
261 spl_image->size = image_get_data_size(header);
263 spl_image->entry_point = image_get_load(header);
264 /* Load including the header */
265 spl_image->load_addr = spl_image->entry_point -
267 spl_image->size = image_get_data_size(header) +
270 #ifdef CONFIG_SPL_LEGACY_IMAGE_CRC_CHECK
271 /* store uImage data length and CRC to check later */
272 spl_image->dcrc_data = image_get_load(header);
273 spl_image->dcrc_length = image_get_data_size(header);
274 spl_image->dcrc = image_get_dcrc(header);
277 spl_image->os = image_get_os(header);
278 spl_image->name = image_get_name(header);
280 "payload image: %32s load addr: 0x%lx size: %d\n",
281 spl_image->name, spl_image->load_addr, spl_image->size);
283 /* LEGACY image not supported */
284 debug("Legacy boot image support not enabled, proceeding to other boot methods\n");
288 #ifdef CONFIG_SPL_PANIC_ON_RAW_IMAGE
290 * CONFIG_SPL_PANIC_ON_RAW_IMAGE is defined when the
291 * code which loads images in SPL cannot guarantee that
292 * absolutely all read errors will be reported.
293 * An example is the LPC32XX MLC NAND driver, which
294 * will consider that a completely unreadable NAND block
295 * is bad, and thus should be skipped silently.
297 panic("** no mkimage signature but raw image not supported");
300 #ifdef CONFIG_SPL_OS_BOOT
303 if (!bootz_setup((ulong)header, &start, &end)) {
304 spl_image->name = "Linux";
305 spl_image->os = IH_OS_LINUX;
306 spl_image->load_addr = CONFIG_SYS_LOAD_ADDR;
307 spl_image->entry_point = CONFIG_SYS_LOAD_ADDR;
308 spl_image->size = end - start;
310 "payload zImage, load addr: 0x%lx size: %d\n",
311 spl_image->load_addr, spl_image->size);
316 #ifdef CONFIG_SPL_RAW_IMAGE_SUPPORT
317 /* Signature not found - assume u-boot.bin */
318 debug("mkimage signature not found - ih_magic = %x\n",
320 spl_set_header_raw_uboot(spl_image);
322 /* RAW image not supported, proceed to other boot methods. */
323 debug("Raw boot image support not enabled, proceeding to other boot methods\n");
331 __weak void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image)
333 typedef void __noreturn (*image_entry_noargs_t)(void);
335 image_entry_noargs_t image_entry =
336 (image_entry_noargs_t)spl_image->entry_point;
338 debug("image entry point: 0x%lx\n", spl_image->entry_point);
342 #if CONFIG_IS_ENABLED(HANDOFF)
344 * Set up the SPL hand-off information
346 * This is initially empty (zero) but can be written by
348 static int setup_spl_handoff(void)
350 struct spl_handoff *ho;
352 ho = bloblist_ensure(BLOBLISTT_SPL_HANDOFF, sizeof(struct spl_handoff));
359 static int write_spl_handoff(void)
361 struct spl_handoff *ho;
363 ho = bloblist_find(BLOBLISTT_SPL_HANDOFF, sizeof(struct spl_handoff));
366 handoff_save_dram(ho);
367 #ifdef CONFIG_SANDBOX
368 ho->arch.magic = TEST_HANDOFF_MAGIC;
370 debug(SPL_TPL_PROMPT "Wrote SPL handoff\n");
375 static inline int setup_spl_handoff(void) { return 0; }
376 static inline int write_spl_handoff(void) { return 0; }
380 static int spl_common_init(bool setup_malloc)
384 #if CONFIG_VAL(SYS_MALLOC_F_LEN)
386 #ifdef CONFIG_MALLOC_F_ADDR
387 gd->malloc_base = CONFIG_MALLOC_F_ADDR;
389 gd->malloc_limit = CONFIG_VAL(SYS_MALLOC_F_LEN);
393 ret = bootstage_init(true);
395 debug("%s: Failed to set up bootstage: ret=%d\n", __func__,
399 bootstage_mark_name(BOOTSTAGE_ID_START_SPL, "spl");
400 #if CONFIG_IS_ENABLED(LOG)
403 debug("%s: Failed to set up logging\n", __func__);
407 if (CONFIG_IS_ENABLED(BLOBLIST)) {
408 ret = bloblist_init();
410 debug("%s: Failed to set up bloblist: ret=%d\n",
415 if (CONFIG_IS_ENABLED(HANDOFF)) {
418 ret = setup_spl_handoff();
420 puts(SPL_TPL_PROMPT "Cannot set up SPL handoff\n");
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(BOOTSTATE_ID_ACCUM_DM_SPL, "dm_spl");
433 /* With CONFIG_SPL_OF_PLATDATA, bring in all devices */
434 ret = dm_init_and_scan(!CONFIG_IS_ENABLED(OF_PLATDATA));
435 bootstage_accum(BOOTSTATE_ID_ACCUM_DM_SPL);
437 debug("dm_init_and_scan() returned error %d\n", ret);
445 void spl_set_bd(void)
448 * NOTE: On some platforms (e.g. x86) bdata may be in flash and not
455 int spl_early_init(void)
459 debug("%s\n", __func__);
461 ret = spl_common_init(true);
464 gd->flags |= GD_FLG_SPL_EARLY_INIT;
472 bool setup_malloc = !(IS_ENABLED(CONFIG_SPL_STACK_R) &&
473 IS_ENABLED(CONFIG_SPL_SYS_MALLOC_SIMPLE));
475 debug("%s\n", __func__);
477 if (!(gd->flags & GD_FLG_SPL_EARLY_INIT)) {
478 ret = spl_common_init(setup_malloc);
482 gd->flags |= GD_FLG_SPL_INIT;
487 #ifndef BOOT_DEVICE_NONE
488 #define BOOT_DEVICE_NONE 0xdeadbeef
491 __weak void board_boot_order(u32 *spl_boot_list)
493 spl_boot_list[0] = spl_boot_device();
496 static struct spl_image_loader *spl_ll_find_loader(uint boot_device)
498 struct spl_image_loader *drv =
499 ll_entry_start(struct spl_image_loader, spl_image_loader);
501 ll_entry_count(struct spl_image_loader, spl_image_loader);
502 struct spl_image_loader *entry;
504 for (entry = drv; entry != drv + n_ents; entry++) {
505 if (boot_device == entry->boot_device)
513 static int spl_load_image(struct spl_image_info *spl_image,
514 struct spl_image_loader *loader)
517 struct spl_boot_device bootdev;
519 bootdev.boot_device = loader->boot_device;
520 bootdev.boot_device_name = NULL;
522 ret = loader->load_image(spl_image, &bootdev);
523 #ifdef CONFIG_SPL_LEGACY_IMAGE_CRC_CHECK
524 if (!ret && spl_image->dcrc_length) {
526 ulong dcrc = crc32_wd(0, (unsigned char *)spl_image->dcrc_data,
527 spl_image->dcrc_length, CHUNKSZ_CRC32);
528 if (dcrc != spl_image->dcrc) {
529 puts("SPL: Image data CRC check failed!\n");
538 * boot_from_devices() - Try loading a booting U-Boot from a list of devices
540 * @spl_image: Place to put the image details if successful
541 * @spl_boot_list: List of boot devices to try
542 * @count: Number of elements in spl_boot_list
543 * @return 0 if OK, -ve on error
545 static int boot_from_devices(struct spl_image_info *spl_image,
546 u32 spl_boot_list[], int count)
550 for (i = 0; i < count && spl_boot_list[i] != BOOT_DEVICE_NONE; i++) {
551 struct spl_image_loader *loader;
553 loader = spl_ll_find_loader(spl_boot_list[i]);
554 #if defined(CONFIG_SPL_SERIAL_SUPPORT) && defined(CONFIG_SPL_LIBCOMMON_SUPPORT)
556 printf("Trying to boot from %s\n", loader->name);
558 puts(SPL_TPL_PROMPT "Unsupported Boot Device!\n");
560 if (loader && !spl_load_image(spl_image, loader)) {
561 spl_image->boot_device = spl_boot_list[i];
569 void board_init_r(gd_t *dummy1, ulong dummy2)
571 u32 spl_boot_list[] = {
578 struct spl_image_info spl_image;
581 debug(">>" SPL_TPL_PROMPT "board_init_r()\n");
585 #if defined(CONFIG_SYS_SPL_MALLOC_START)
586 mem_malloc_init(CONFIG_SYS_SPL_MALLOC_START,
587 CONFIG_SYS_SPL_MALLOC_SIZE);
588 gd->flags |= GD_FLG_FULL_MALLOC_INIT;
590 if (!(gd->flags & GD_FLG_SPL_INIT)) {
594 #if !defined(CONFIG_PPC) && !defined(CONFIG_ARCH_MX6)
596 * timer_init() does not exist on PPC systems. The timer is initialized
597 * and enabled (decrementer) in interrupt_init() here.
602 #if CONFIG_IS_ENABLED(BOARD_INIT)
606 #if defined(CONFIG_SPL_WATCHDOG_SUPPORT) && CONFIG_IS_ENABLED(WDT)
610 if (IS_ENABLED(CONFIG_SPL_OS_BOOT) || CONFIG_IS_ENABLED(HANDOFF))
611 dram_init_banksize();
615 memset(&spl_image, '\0', sizeof(spl_image));
616 #ifdef CONFIG_SYS_SPL_ARGS_ADDR
617 spl_image.arg = (void *)CONFIG_SYS_SPL_ARGS_ADDR;
619 spl_image.boot_device = BOOT_DEVICE_NONE;
620 board_boot_order(spl_boot_list);
622 if (boot_from_devices(&spl_image, spl_boot_list,
623 ARRAY_SIZE(spl_boot_list))) {
624 puts(SPL_TPL_PROMPT "failed to boot from all boot devices\n");
628 spl_perform_fixups(&spl_image);
629 if (CONFIG_IS_ENABLED(HANDOFF)) {
630 ret = write_spl_handoff();
632 printf(SPL_TPL_PROMPT
633 "SPL hand-off write failed (err=%d)\n", ret);
635 if (CONFIG_IS_ENABLED(BLOBLIST)) {
636 ret = bloblist_finish();
638 printf("Warning: Failed to finish bloblist (ret=%d)\n",
642 #ifdef CONFIG_CPU_V7M
643 spl_image.entry_point |= 0x1;
645 switch (spl_image.os) {
647 debug("Jumping to U-Boot\n");
649 #if CONFIG_IS_ENABLED(ATF)
650 case IH_OS_ARM_TRUSTED_FIRMWARE:
651 debug("Jumping to U-Boot via ARM Trusted Firmware\n");
652 spl_invoke_atf(&spl_image);
655 #if CONFIG_IS_ENABLED(OPTEE)
657 debug("Jumping to U-Boot via OP-TEE\n");
658 spl_optee_entry(NULL, NULL, spl_image.fdt_addr,
659 (void *)spl_image.entry_point);
662 #if CONFIG_IS_ENABLED(OPENSBI)
664 debug("Jumping to U-Boot via RISC-V OpenSBI\n");
665 spl_invoke_opensbi(&spl_image);
668 #ifdef CONFIG_SPL_OS_BOOT
670 debug("Jumping to Linux\n");
672 spl_board_prepare_for_linux();
673 jump_to_image_linux(&spl_image);
676 debug("Unsupported OS image.. Jumping nevertheless..\n");
678 #if CONFIG_VAL(SYS_MALLOC_F_LEN) && !defined(CONFIG_SYS_SPL_MALLOC_SIZE)
679 debug("SPL malloc() used 0x%lx bytes (%ld KB)\n", gd->malloc_ptr,
680 gd->malloc_ptr / 1024);
682 #ifdef CONFIG_BOOTSTAGE_STASH
683 bootstage_mark_name(BOOTSTAGE_ID_END_SPL, "end_spl");
684 ret = bootstage_stash((void *)CONFIG_BOOTSTAGE_STASH_ADDR,
685 CONFIG_BOOTSTAGE_STASH_SIZE);
687 debug("Failed to stash bootstage: err=%d\n", ret);
690 debug("loaded - jumping to U-Boot...\n");
691 spl_board_prepare_for_boot();
692 jump_to_image_no_args(&spl_image);
695 #ifdef CONFIG_SPL_SERIAL_SUPPORT
697 * This requires UART clocks to be enabled. In order for this to work the
698 * caller must ensure that the gd pointer is valid.
700 void preloader_console_init(void)
702 gd->baudrate = CONFIG_BAUDRATE;
704 serial_init(); /* serial communications setup */
706 gd->have_console = 1;
708 #if CONFIG_IS_ENABLED(BANNER_PRINT)
709 puts("\nU-Boot " SPL_TPL_NAME " " PLAIN_VERSION " (" U_BOOT_DATE " - "
710 U_BOOT_TIME " " U_BOOT_TZ ")\n");
712 #ifdef CONFIG_SPL_DISPLAY_PRINT
719 * This function is called before the stack is changed from initial stack to
720 * relocated stack. It tries to dump the stack size used
722 __weak void spl_relocate_stack_check(void)
724 #if CONFIG_IS_ENABLED(SYS_REPORT_STACK_F_USAGE)
725 ulong init_sp = gd->start_addr_sp;
726 ulong stack_bottom = init_sp - CONFIG_VAL(SIZE_LIMIT_PROVIDE_STACK);
727 u8 *ptr = (u8 *)stack_bottom;
730 for (i = 0; i < CONFIG_VAL(SIZE_LIMIT_PROVIDE_STACK); i++) {
731 if (*ptr != CONFIG_VAL(SYS_STACK_F_CHECK_BYTE))
735 printf("SPL initial stack usage: %lu bytes\n",
736 CONFIG_VAL(SIZE_LIMIT_PROVIDE_STACK) - i);
741 * spl_relocate_stack_gd() - Relocate stack ready for board_init_r() execution
743 * Sometimes board_init_f() runs with a stack in SRAM but we want to use SDRAM
744 * for the main board_init_r() execution. This is typically because we need
745 * more stack space for things like the MMC sub-system.
747 * This function calculates the stack position, copies the global_data into
748 * place, sets the new gd (except for ARM, for which setting GD within a C
749 * function may not always work) and returns the new stack position. The
750 * caller is responsible for setting up the sp register and, in the case
751 * of ARM, setting up gd.
753 * All of this is done using the same layout and alignments as done in
754 * board_init_f_init_reserve() / board_init_f_alloc_reserve().
756 * @return new stack location, or 0 to use the same stack
758 ulong spl_relocate_stack_gd(void)
760 #ifdef CONFIG_SPL_STACK_R
762 ulong ptr = CONFIG_SPL_STACK_R_ADDR;
764 if (CONFIG_IS_ENABLED(SYS_REPORT_STACK_F_USAGE))
765 spl_relocate_stack_check();
767 #if defined(CONFIG_SPL_SYS_MALLOC_SIMPLE) && CONFIG_VAL(SYS_MALLOC_F_LEN)
768 if (CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN) {
769 debug("SPL malloc() before relocation used 0x%lx bytes (%ld KB)\n",
770 gd->malloc_ptr, gd->malloc_ptr / 1024);
771 ptr -= CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN;
772 gd->malloc_base = ptr;
773 gd->malloc_limit = CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN;
777 /* Get stack position: use 8-byte alignment for ABI compliance */
778 ptr = CONFIG_SPL_STACK_R_ADDR - roundup(sizeof(gd_t),16);
779 new_gd = (gd_t *)ptr;
780 memcpy(new_gd, (void *)gd, sizeof(gd_t));
781 #if CONFIG_IS_ENABLED(DM)
782 dm_fixup_for_gd_move(new_gd);
784 #if !defined(CONFIG_ARM)