1 // SPDX-License-Identifier: GPL-2.0+
4 * Texas Instruments, <www.ti.com>
6 * Aneesh V <aneesh@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 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 conf_noffset = fit_conf_get_node((const void *)header,
205 if (conf_noffset <= 0)
209 uname = fdt_stringlist_get((const void *)header, conf_noffset,
210 FIT_LOADABLE_PROP, idx,
214 #ifdef CONFIG_SPL_FIT_SIGNATURE
217 ret = fit_image_load(&images, (ulong)header,
218 &uname, &fit_uname_config,
219 IH_ARCH_DEFAULT, IH_TYPE_LOADABLE, -1,
220 FIT_LOAD_OPTIONAL_NON_ZERO,
221 &img_data, &img_len);
230 int spl_parse_image_header(struct spl_image_info *spl_image,
231 const struct image_header *header)
233 #ifdef CONFIG_SPL_LOAD_FIT_FULL
234 int ret = spl_load_fit_image(spl_image, header);
239 if (image_get_magic(header) == IH_MAGIC) {
240 #ifdef CONFIG_SPL_LEGACY_IMAGE_SUPPORT
241 u32 header_size = sizeof(struct image_header);
243 #ifdef CONFIG_SPL_LEGACY_IMAGE_CRC_CHECK
244 /* check uImage header CRC */
245 if (!image_check_hcrc(header)) {
246 puts("SPL: Image header CRC check failed!\n");
251 if (spl_image->flags & SPL_COPY_PAYLOAD_ONLY) {
253 * On some system (e.g. powerpc), the load-address and
254 * entry-point is located at address 0. We can't load
255 * to 0-0x40. So skip header in this case.
257 spl_image->load_addr = image_get_load(header);
258 spl_image->entry_point = image_get_ep(header);
259 spl_image->size = image_get_data_size(header);
261 spl_image->entry_point = image_get_load(header);
262 /* Load including the header */
263 spl_image->load_addr = spl_image->entry_point -
265 spl_image->size = image_get_data_size(header) +
268 #ifdef CONFIG_SPL_LEGACY_IMAGE_CRC_CHECK
269 /* store uImage data length and CRC to check later */
270 spl_image->dcrc_data = image_get_load(header);
271 spl_image->dcrc_length = image_get_data_size(header);
272 spl_image->dcrc = image_get_dcrc(header);
275 spl_image->os = image_get_os(header);
276 spl_image->name = image_get_name(header);
278 "payload image: %32s load addr: 0x%lx size: %d\n",
279 spl_image->name, spl_image->load_addr, spl_image->size);
281 /* LEGACY image not supported */
282 debug("Legacy boot image support not enabled, proceeding to other boot methods\n");
286 #ifdef CONFIG_SPL_PANIC_ON_RAW_IMAGE
288 * CONFIG_SPL_PANIC_ON_RAW_IMAGE is defined when the
289 * code which loads images in SPL cannot guarantee that
290 * absolutely all read errors will be reported.
291 * An example is the LPC32XX MLC NAND driver, which
292 * will consider that a completely unreadable NAND block
293 * is bad, and thus should be skipped silently.
295 panic("** no mkimage signature but raw image not supported");
298 #ifdef CONFIG_SPL_OS_BOOT
301 if (!bootz_setup((ulong)header, &start, &end)) {
302 spl_image->name = "Linux";
303 spl_image->os = IH_OS_LINUX;
304 spl_image->load_addr = CONFIG_SYS_LOAD_ADDR;
305 spl_image->entry_point = CONFIG_SYS_LOAD_ADDR;
306 spl_image->size = end - start;
308 "payload zImage, load addr: 0x%lx size: %d\n",
309 spl_image->load_addr, spl_image->size);
314 #ifdef CONFIG_SPL_RAW_IMAGE_SUPPORT
315 /* Signature not found - assume u-boot.bin */
316 debug("mkimage signature not found - ih_magic = %x\n",
318 spl_set_header_raw_uboot(spl_image);
320 /* RAW image not supported, proceed to other boot methods. */
321 debug("Raw boot image support not enabled, proceeding to other boot methods\n");
329 __weak void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image)
331 typedef void __noreturn (*image_entry_noargs_t)(void);
333 image_entry_noargs_t image_entry =
334 (image_entry_noargs_t)spl_image->entry_point;
336 debug("image entry point: 0x%lx\n", spl_image->entry_point);
340 #if CONFIG_IS_ENABLED(HANDOFF)
342 * Set up the SPL hand-off information
344 * This is initially empty (zero) but can be written by
346 static int setup_spl_handoff(void)
348 struct spl_handoff *ho;
350 ho = bloblist_ensure(BLOBLISTT_SPL_HANDOFF, sizeof(struct spl_handoff));
357 static int write_spl_handoff(void)
359 struct spl_handoff *ho;
361 ho = bloblist_find(BLOBLISTT_SPL_HANDOFF, sizeof(struct spl_handoff));
364 handoff_save_dram(ho);
365 #ifdef CONFIG_SANDBOX
366 ho->arch.magic = TEST_HANDOFF_MAGIC;
368 debug(SPL_TPL_PROMPT "Wrote SPL handoff\n");
373 static inline int setup_spl_handoff(void) { return 0; }
374 static inline int write_spl_handoff(void) { return 0; }
378 static int spl_common_init(bool setup_malloc)
382 #if CONFIG_VAL(SYS_MALLOC_F_LEN)
384 #ifdef CONFIG_MALLOC_F_ADDR
385 gd->malloc_base = CONFIG_MALLOC_F_ADDR;
387 gd->malloc_limit = CONFIG_VAL(SYS_MALLOC_F_LEN);
391 ret = bootstage_init(true);
393 debug("%s: Failed to set up bootstage: ret=%d\n", __func__,
397 bootstage_mark_name(BOOTSTAGE_ID_START_SPL, "spl");
398 #if CONFIG_IS_ENABLED(LOG)
401 debug("%s: Failed to set up logging\n", __func__);
405 if (CONFIG_IS_ENABLED(BLOBLIST)) {
406 ret = bloblist_init();
408 debug("%s: Failed to set up bloblist: ret=%d\n",
413 if (CONFIG_IS_ENABLED(HANDOFF)) {
416 ret = setup_spl_handoff();
418 puts(SPL_TPL_PROMPT "Cannot set up SPL handoff\n");
422 if (CONFIG_IS_ENABLED(OF_CONTROL) && !CONFIG_IS_ENABLED(OF_PLATDATA)) {
423 ret = fdtdec_setup();
425 debug("fdtdec_setup() returned error %d\n", ret);
429 if (CONFIG_IS_ENABLED(DM)) {
430 bootstage_start(BOOTSTATE_ID_ACCUM_DM_SPL, "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(BOOTSTATE_ID_ACCUM_DM_SPL);
435 debug("dm_init_and_scan() returned error %d\n", ret);
443 void spl_set_bd(void)
446 * NOTE: On some platforms (e.g. x86) bdata may be in flash and not
453 int spl_early_init(void)
457 debug("%s\n", __func__);
459 ret = spl_common_init(true);
462 gd->flags |= GD_FLG_SPL_EARLY_INIT;
470 bool setup_malloc = !(IS_ENABLED(CONFIG_SPL_STACK_R) &&
471 IS_ENABLED(CONFIG_SPL_SYS_MALLOC_SIMPLE));
473 debug("%s\n", __func__);
475 if (!(gd->flags & GD_FLG_SPL_EARLY_INIT)) {
476 ret = spl_common_init(setup_malloc);
480 gd->flags |= GD_FLG_SPL_INIT;
485 #ifndef BOOT_DEVICE_NONE
486 #define BOOT_DEVICE_NONE 0xdeadbeef
489 __weak void board_boot_order(u32 *spl_boot_list)
491 spl_boot_list[0] = spl_boot_device();
494 static struct spl_image_loader *spl_ll_find_loader(uint boot_device)
496 struct spl_image_loader *drv =
497 ll_entry_start(struct spl_image_loader, spl_image_loader);
499 ll_entry_count(struct spl_image_loader, spl_image_loader);
500 struct spl_image_loader *entry;
502 for (entry = drv; entry != drv + n_ents; entry++) {
503 if (boot_device == entry->boot_device)
511 static int spl_load_image(struct spl_image_info *spl_image,
512 struct spl_image_loader *loader)
515 struct spl_boot_device bootdev;
517 bootdev.boot_device = loader->boot_device;
518 bootdev.boot_device_name = NULL;
520 ret = loader->load_image(spl_image, &bootdev);
521 #ifdef CONFIG_SPL_LEGACY_IMAGE_CRC_CHECK
522 if (!ret && spl_image->dcrc_length) {
524 ulong dcrc = crc32_wd(0, (unsigned char *)spl_image->dcrc_data,
525 spl_image->dcrc_length, CHUNKSZ_CRC32);
526 if (dcrc != spl_image->dcrc) {
527 puts("SPL: Image data CRC check failed!\n");
536 * boot_from_devices() - Try loading an booting U-Boot from a list of devices
538 * @spl_image: Place to put the image details if successful
539 * @spl_boot_list: List of boot devices to try
540 * @count: Number of elements in spl_boot_list
541 * @return 0 if OK, -ve on error
543 static int boot_from_devices(struct spl_image_info *spl_image,
544 u32 spl_boot_list[], int count)
548 for (i = 0; i < count && spl_boot_list[i] != BOOT_DEVICE_NONE; i++) {
549 struct spl_image_loader *loader;
551 loader = spl_ll_find_loader(spl_boot_list[i]);
552 #if defined(CONFIG_SPL_SERIAL_SUPPORT) && defined(CONFIG_SPL_LIBCOMMON_SUPPORT)
554 printf("Trying to boot from %s\n", loader->name);
556 puts(SPL_TPL_PROMPT "Unsupported Boot Device!\n");
558 if (loader && !spl_load_image(spl_image, loader)) {
559 spl_image->boot_device = spl_boot_list[i];
567 void board_init_r(gd_t *dummy1, ulong dummy2)
569 u32 spl_boot_list[] = {
576 struct spl_image_info spl_image;
579 debug(">>" SPL_TPL_PROMPT "board_init_r()\n");
583 #if defined(CONFIG_SYS_SPL_MALLOC_START)
584 mem_malloc_init(CONFIG_SYS_SPL_MALLOC_START,
585 CONFIG_SYS_SPL_MALLOC_SIZE);
586 gd->flags |= GD_FLG_FULL_MALLOC_INIT;
588 if (!(gd->flags & GD_FLG_SPL_INIT)) {
592 #if !defined(CONFIG_PPC) && !defined(CONFIG_ARCH_MX6)
594 * timer_init() does not exist on PPC systems. The timer is initialized
595 * and enabled (decrementer) in interrupt_init() here.
600 #if CONFIG_IS_ENABLED(BOARD_INIT)
604 #if defined(CONFIG_SPL_WATCHDOG_SUPPORT) && defined(CONFIG_WDT)
608 if (IS_ENABLED(CONFIG_SPL_OS_BOOT) || CONFIG_IS_ENABLED(HANDOFF))
609 dram_init_banksize();
613 memset(&spl_image, '\0', sizeof(spl_image));
614 #ifdef CONFIG_SYS_SPL_ARGS_ADDR
615 spl_image.arg = (void *)CONFIG_SYS_SPL_ARGS_ADDR;
617 spl_image.boot_device = BOOT_DEVICE_NONE;
618 board_boot_order(spl_boot_list);
620 if (boot_from_devices(&spl_image, spl_boot_list,
621 ARRAY_SIZE(spl_boot_list))) {
622 puts(SPL_TPL_PROMPT "failed to boot from all boot devices\n");
626 spl_perform_fixups(&spl_image);
627 if (CONFIG_IS_ENABLED(HANDOFF)) {
628 ret = write_spl_handoff();
630 printf(SPL_TPL_PROMPT
631 "SPL hand-off write failed (err=%d)\n", ret);
633 if (CONFIG_IS_ENABLED(BLOBLIST)) {
634 ret = bloblist_finish();
636 printf("Warning: Failed to finish bloblist (ret=%d)\n",
640 #ifdef CONFIG_CPU_V7M
641 spl_image.entry_point |= 0x1;
643 switch (spl_image.os) {
645 debug("Jumping to U-Boot\n");
647 #if CONFIG_IS_ENABLED(ATF)
648 case IH_OS_ARM_TRUSTED_FIRMWARE:
649 debug("Jumping to U-Boot via ARM Trusted Firmware\n");
650 spl_invoke_atf(&spl_image);
653 #if CONFIG_IS_ENABLED(OPTEE)
655 debug("Jumping to U-Boot via OP-TEE\n");
656 spl_optee_entry(NULL, NULL, spl_image.fdt_addr,
657 (void *)spl_image.entry_point);
660 #ifdef CONFIG_SPL_OS_BOOT
662 debug("Jumping to Linux\n");
664 spl_board_prepare_for_linux();
665 jump_to_image_linux(&spl_image);
668 debug("Unsupported OS image.. Jumping nevertheless..\n");
670 #if CONFIG_VAL(SYS_MALLOC_F_LEN) && !defined(CONFIG_SYS_SPL_MALLOC_SIZE)
671 debug("SPL malloc() used 0x%lx bytes (%ld KB)\n", gd->malloc_ptr,
672 gd->malloc_ptr / 1024);
674 #ifdef CONFIG_BOOTSTAGE_STASH
675 bootstage_mark_name(BOOTSTAGE_ID_END_SPL, "end_spl");
676 ret = bootstage_stash((void *)CONFIG_BOOTSTAGE_STASH_ADDR,
677 CONFIG_BOOTSTAGE_STASH_SIZE);
679 debug("Failed to stash bootstage: err=%d\n", ret);
682 debug("loaded - jumping to U-Boot...\n");
683 spl_board_prepare_for_boot();
684 jump_to_image_no_args(&spl_image);
687 #ifdef CONFIG_SPL_SERIAL_SUPPORT
689 * This requires UART clocks to be enabled. In order for this to work the
690 * caller must ensure that the gd pointer is valid.
692 void preloader_console_init(void)
694 gd->baudrate = CONFIG_BAUDRATE;
696 serial_init(); /* serial communications setup */
698 gd->have_console = 1;
700 #if CONFIG_IS_ENABLED(BANNER_PRINT)
701 puts("\nU-Boot " SPL_TPL_NAME " " PLAIN_VERSION " (" U_BOOT_DATE " - "
702 U_BOOT_TIME " " U_BOOT_TZ ")\n");
704 #ifdef CONFIG_SPL_DISPLAY_PRINT
711 * spl_relocate_stack_gd() - Relocate stack ready for board_init_r() execution
713 * Sometimes board_init_f() runs with a stack in SRAM but we want to use SDRAM
714 * for the main board_init_r() execution. This is typically because we need
715 * more stack space for things like the MMC sub-system.
717 * This function calculates the stack position, copies the global_data into
718 * place, sets the new gd (except for ARM, for which setting GD within a C
719 * function may not always work) and returns the new stack position. The
720 * caller is responsible for setting up the sp register and, in the case
721 * of ARM, setting up gd.
723 * All of this is done using the same layout and alignments as done in
724 * board_init_f_init_reserve() / board_init_f_alloc_reserve().
726 * @return new stack location, or 0 to use the same stack
728 ulong spl_relocate_stack_gd(void)
730 #ifdef CONFIG_SPL_STACK_R
732 ulong ptr = CONFIG_SPL_STACK_R_ADDR;
734 #if defined(CONFIG_SPL_SYS_MALLOC_SIMPLE) && CONFIG_VAL(SYS_MALLOC_F_LEN)
735 if (CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN) {
736 debug("SPL malloc() before relocation used 0x%lx bytes (%ld KB)\n",
737 gd->malloc_ptr, gd->malloc_ptr / 1024);
738 ptr -= CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN;
739 gd->malloc_base = ptr;
740 gd->malloc_limit = CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN;
744 /* Get stack position: use 8-byte alignment for ABI compliance */
745 ptr = CONFIG_SPL_STACK_R_ADDR - roundup(sizeof(gd_t),16);
746 new_gd = (gd_t *)ptr;
747 memcpy(new_gd, (void *)gd, sizeof(gd_t));
748 #if CONFIG_IS_ENABLED(DM)
749 dm_fixup_for_gd_move(new_gd);
751 #if !defined(CONFIG_ARM)