1 // SPDX-License-Identifier: GPL-2.0+
4 * Texas Instruments, <www.ti.com>
10 #include <binman_sym.h>
13 #include <asm/u-boot.h>
20 #include <linux/compiler.h>
21 #include <fdt_support.h>
22 #include <bootcount.h>
24 DECLARE_GLOBAL_DATA_PTR;
26 #ifndef CONFIG_SYS_UBOOT_START
27 #define CONFIG_SYS_UBOOT_START CONFIG_SYS_TEXT_BASE
29 #ifndef CONFIG_SYS_MONITOR_LEN
30 /* Unknown U-Boot size, let's assume it will not be more than 200 KB */
31 #define CONFIG_SYS_MONITOR_LEN (200 * 1024)
34 u32 *boot_params_ptr = NULL;
36 /* See spl.h for information about this */
37 binman_sym_declare(ulong, u_boot_any, image_pos);
39 /* Define board data structure */
40 static bd_t bdata __attribute__ ((section(".data")));
43 * Board-specific Platform code can reimplement show_boot_progress () if needed
45 __weak void show_boot_progress(int val) {}
48 * Default function to determine if u-boot or the OS should
49 * be started. This implementation always returns 1.
51 * Please implement your own board specific funcion to do this.
54 * 0 to not start u-boot
55 * positive if u-boot should start
57 #ifdef CONFIG_SPL_OS_BOOT
58 __weak int spl_start_uboot(void)
60 puts("SPL: Please implement spl_start_uboot() for your board\n");
61 puts("SPL: Direct Linux boot not active!\n");
65 /* weak default platform specific function to initialize
68 __weak int dram_init_banksize(void)
74 * Weak default function for arch specific zImage check. Return zero
75 * and fill start and end address if image is recognized.
77 int __weak bootz_setup(ulong image, ulong *start, ulong *end)
83 /* Weak default function for arch/board-specific fixups to the spl_image_info */
84 void __weak spl_perform_fixups(struct spl_image_info *spl_image)
88 void spl_fixup_fdt(void)
90 #if defined(CONFIG_SPL_OF_LIBFDT) && defined(CONFIG_SYS_SPL_ARGS_ADDR)
91 void *fdt_blob = (void *)CONFIG_SYS_SPL_ARGS_ADDR;
94 err = fdt_check_header(fdt_blob);
96 printf("fdt_root: %s\n", fdt_strerror(err));
100 /* fixup the memory dt node */
101 err = fdt_shrink_to_minimum(fdt_blob, 0);
103 printf("spl: fdt_shrink_to_minimum err - %d\n", err);
107 err = arch_fixup_fdt(fdt_blob);
109 printf("spl: arch_fixup_fdt err - %d\n", err);
116 * Weak default function for board specific cleanup/preparation before
117 * Linux boot. Some boards/platforms might not need it, so just provide
118 * an empty stub here.
120 __weak void spl_board_prepare_for_linux(void)
125 __weak void spl_board_prepare_for_boot(void)
130 __weak struct image_header *spl_get_load_buffer(ssize_t offset, size_t size)
132 return (struct image_header *)(CONFIG_SYS_TEXT_BASE + offset);
135 void spl_set_header_raw_uboot(struct spl_image_info *spl_image)
137 ulong u_boot_pos = binman_sym(ulong, u_boot_any, image_pos);
139 spl_image->size = CONFIG_SYS_MONITOR_LEN;
142 * Binman error cases: address of the end of the previous region or the
143 * start of the image's entry area (usually 0) if there is no previous
146 if (u_boot_pos && u_boot_pos != BINMAN_SYM_MISSING) {
147 /* Binman does not support separated entry addresses */
148 spl_image->entry_point = u_boot_pos;
149 spl_image->load_addr = u_boot_pos;
151 spl_image->entry_point = CONFIG_SYS_UBOOT_START;
152 spl_image->load_addr = CONFIG_SYS_TEXT_BASE;
154 spl_image->os = IH_OS_U_BOOT;
155 spl_image->name = "U-Boot";
158 #ifdef CONFIG_SPL_LOAD_FIT_FULL
159 /* Parse and load full fitImage in SPL */
160 static int spl_load_fit_image(struct spl_image_info *spl_image,
161 const struct image_header *header)
163 bootm_headers_t images;
164 const char *fit_uname_config = NULL;
165 const char *fit_uname_fdt = FIT_FDT_PROP;
167 ulong fw_data = 0, dt_data = 0, img_data = 0;
168 ulong fw_len = 0, dt_len = 0, img_len = 0;
169 int idx, conf_noffset;
172 #ifdef CONFIG_SPL_FIT_SIGNATURE
175 ret = fit_image_load(&images, (ulong)header,
176 NULL, &fit_uname_config,
177 IH_ARCH_DEFAULT, IH_TYPE_STANDALONE, -1,
178 FIT_LOAD_REQUIRED, &fw_data, &fw_len);
182 spl_image->size = fw_len;
183 spl_image->entry_point = fw_data;
184 spl_image->load_addr = fw_data;
185 spl_image->os = IH_OS_U_BOOT;
186 spl_image->name = "U-Boot";
188 debug("spl: payload image: %32s load addr: 0x%lx size: %d\n",
189 spl_image->name, spl_image->load_addr, spl_image->size);
191 #ifdef CONFIG_SPL_FIT_SIGNATURE
194 fit_image_load(&images, (ulong)header,
195 &fit_uname_fdt, &fit_uname_config,
196 IH_ARCH_DEFAULT, IH_TYPE_FLATDT, -1,
197 FIT_LOAD_OPTIONAL, &dt_data, &dt_len);
199 conf_noffset = fit_conf_get_node((const void *)header,
201 if (conf_noffset <= 0)
205 uname = fdt_stringlist_get((const void *)header, conf_noffset,
206 FIT_LOADABLE_PROP, idx,
210 #ifdef CONFIG_SPL_FIT_SIGNATURE
213 ret = fit_image_load(&images, (ulong)header,
214 &uname, &fit_uname_config,
215 IH_ARCH_DEFAULT, IH_TYPE_LOADABLE, -1,
216 FIT_LOAD_OPTIONAL_NON_ZERO,
217 &img_data, &img_len);
226 int spl_parse_image_header(struct spl_image_info *spl_image,
227 const struct image_header *header)
229 #ifdef CONFIG_SPL_LOAD_FIT_FULL
230 int ret = spl_load_fit_image(spl_image, header);
235 if (image_get_magic(header) == IH_MAGIC) {
236 #ifdef CONFIG_SPL_LEGACY_IMAGE_SUPPORT
237 u32 header_size = sizeof(struct image_header);
239 if (spl_image->flags & SPL_COPY_PAYLOAD_ONLY) {
241 * On some system (e.g. powerpc), the load-address and
242 * entry-point is located at address 0. We can't load
243 * to 0-0x40. So skip header in this case.
245 spl_image->load_addr = image_get_load(header);
246 spl_image->entry_point = image_get_ep(header);
247 spl_image->size = image_get_data_size(header);
249 spl_image->entry_point = image_get_load(header);
250 /* Load including the header */
251 spl_image->load_addr = spl_image->entry_point -
253 spl_image->size = image_get_data_size(header) +
256 spl_image->os = image_get_os(header);
257 spl_image->name = image_get_name(header);
258 debug("spl: payload image: %32s load addr: 0x%lx size: %d\n",
259 spl_image->name, spl_image->load_addr, spl_image->size);
261 /* LEGACY image not supported */
262 debug("Legacy boot image support not enabled, proceeding to other boot methods\n");
266 #ifdef CONFIG_SPL_PANIC_ON_RAW_IMAGE
268 * CONFIG_SPL_PANIC_ON_RAW_IMAGE is defined when the
269 * code which loads images in SPL cannot guarantee that
270 * absolutely all read errors will be reported.
271 * An example is the LPC32XX MLC NAND driver, which
272 * will consider that a completely unreadable NAND block
273 * is bad, and thus should be skipped silently.
275 panic("** no mkimage signature but raw image not supported");
278 #ifdef CONFIG_SPL_OS_BOOT
281 if (!bootz_setup((ulong)header, &start, &end)) {
282 spl_image->name = "Linux";
283 spl_image->os = IH_OS_LINUX;
284 spl_image->load_addr = CONFIG_SYS_LOAD_ADDR;
285 spl_image->entry_point = CONFIG_SYS_LOAD_ADDR;
286 spl_image->size = end - start;
287 debug("spl: payload zImage, load addr: 0x%lx size: %d\n",
288 spl_image->load_addr, spl_image->size);
293 #ifdef CONFIG_SPL_RAW_IMAGE_SUPPORT
294 /* Signature not found - assume u-boot.bin */
295 debug("mkimage signature not found - ih_magic = %x\n",
297 spl_set_header_raw_uboot(spl_image);
299 /* RAW image not supported, proceed to other boot methods. */
300 debug("Raw boot image support not enabled, proceeding to other boot methods\n");
308 __weak void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image)
310 typedef void __noreturn (*image_entry_noargs_t)(void);
312 image_entry_noargs_t image_entry =
313 (image_entry_noargs_t)spl_image->entry_point;
315 debug("image entry point: 0x%lx\n", spl_image->entry_point);
319 static int spl_common_init(bool setup_malloc)
323 #if CONFIG_VAL(SYS_MALLOC_F_LEN)
325 #ifdef CONFIG_MALLOC_F_ADDR
326 gd->malloc_base = CONFIG_MALLOC_F_ADDR;
328 gd->malloc_limit = CONFIG_VAL(SYS_MALLOC_F_LEN);
332 ret = bootstage_init(true);
334 debug("%s: Failed to set up bootstage: ret=%d\n", __func__,
338 bootstage_mark_name(BOOTSTAGE_ID_START_SPL, "spl");
339 if (CONFIG_IS_ENABLED(OF_CONTROL) && !CONFIG_IS_ENABLED(OF_PLATDATA)) {
340 ret = fdtdec_setup();
342 debug("fdtdec_setup() returned error %d\n", ret);
346 if (CONFIG_IS_ENABLED(DM)) {
347 bootstage_start(BOOTSTATE_ID_ACCUM_DM_SPL, "dm_spl");
348 /* With CONFIG_SPL_OF_PLATDATA, bring in all devices */
349 ret = dm_init_and_scan(!CONFIG_IS_ENABLED(OF_PLATDATA));
350 bootstage_accum(BOOTSTATE_ID_ACCUM_DM_SPL);
352 debug("dm_init_and_scan() returned error %d\n", ret);
360 void spl_set_bd(void)
366 int spl_early_init(void)
370 debug("%s\n", __func__);
372 ret = spl_common_init(true);
375 gd->flags |= GD_FLG_SPL_EARLY_INIT;
383 bool setup_malloc = !(IS_ENABLED(CONFIG_SPL_STACK_R) &&
384 IS_ENABLED(CONFIG_SPL_SYS_MALLOC_SIMPLE));
386 debug("%s\n", __func__);
388 if (!(gd->flags & GD_FLG_SPL_EARLY_INIT)) {
389 ret = spl_common_init(setup_malloc);
393 gd->flags |= GD_FLG_SPL_INIT;
398 #ifndef BOOT_DEVICE_NONE
399 #define BOOT_DEVICE_NONE 0xdeadbeef
402 __weak void board_boot_order(u32 *spl_boot_list)
404 spl_boot_list[0] = spl_boot_device();
407 static struct spl_image_loader *spl_ll_find_loader(uint boot_device)
409 struct spl_image_loader *drv =
410 ll_entry_start(struct spl_image_loader, spl_image_loader);
412 ll_entry_count(struct spl_image_loader, spl_image_loader);
413 struct spl_image_loader *entry;
415 for (entry = drv; entry != drv + n_ents; entry++) {
416 if (boot_device == entry->boot_device)
424 static int spl_load_image(struct spl_image_info *spl_image,
425 struct spl_image_loader *loader)
427 struct spl_boot_device bootdev;
429 bootdev.boot_device = loader->boot_device;
430 bootdev.boot_device_name = NULL;
432 return loader->load_image(spl_image, &bootdev);
436 * boot_from_devices() - Try loading an booting U-Boot from a list of devices
438 * @spl_image: Place to put the image details if successful
439 * @spl_boot_list: List of boot devices to try
440 * @count: Number of elements in spl_boot_list
441 * @return 0 if OK, -ve on error
443 static int boot_from_devices(struct spl_image_info *spl_image,
444 u32 spl_boot_list[], int count)
448 for (i = 0; i < count && spl_boot_list[i] != BOOT_DEVICE_NONE; i++) {
449 struct spl_image_loader *loader;
451 loader = spl_ll_find_loader(spl_boot_list[i]);
452 #if defined(CONFIG_SPL_SERIAL_SUPPORT) && defined(CONFIG_SPL_LIBCOMMON_SUPPORT)
454 printf("Trying to boot from %s\n", loader->name);
456 puts("SPL: Unsupported Boot Device!\n");
458 if (loader && !spl_load_image(spl_image, loader)) {
459 spl_image->boot_device = spl_boot_list[i];
467 void board_init_r(gd_t *dummy1, ulong dummy2)
469 u32 spl_boot_list[] = {
476 struct spl_image_info spl_image;
478 debug(">>spl:board_init_r()\n");
482 #ifdef CONFIG_SPL_OS_BOOT
483 dram_init_banksize();
486 #if defined(CONFIG_SYS_SPL_MALLOC_START)
487 mem_malloc_init(CONFIG_SYS_SPL_MALLOC_START,
488 CONFIG_SYS_SPL_MALLOC_SIZE);
489 gd->flags |= GD_FLG_FULL_MALLOC_INIT;
491 if (!(gd->flags & GD_FLG_SPL_INIT)) {
495 #if !defined(CONFIG_PPC) && !defined(CONFIG_ARCH_MX6)
497 * timer_init() does not exist on PPC systems. The timer is initialized
498 * and enabled (decrementer) in interrupt_init() here.
503 #if CONFIG_IS_ENABLED(BOARD_INIT)
509 memset(&spl_image, '\0', sizeof(spl_image));
510 #ifdef CONFIG_SYS_SPL_ARGS_ADDR
511 spl_image.arg = (void *)CONFIG_SYS_SPL_ARGS_ADDR;
513 spl_image.boot_device = BOOT_DEVICE_NONE;
514 board_boot_order(spl_boot_list);
516 if (boot_from_devices(&spl_image, spl_boot_list,
517 ARRAY_SIZE(spl_boot_list))) {
518 puts("SPL: failed to boot from all boot devices\n");
522 spl_perform_fixups(&spl_image);
524 #ifdef CONFIG_CPU_V7M
525 spl_image.entry_point |= 0x1;
527 switch (spl_image.os) {
529 debug("Jumping to U-Boot\n");
531 #if CONFIG_IS_ENABLED(ATF)
532 case IH_OS_ARM_TRUSTED_FIRMWARE:
533 debug("Jumping to U-Boot via ARM Trusted Firmware\n");
534 spl_invoke_atf(&spl_image);
537 #if CONFIG_IS_ENABLED(OPTEE)
539 debug("Jumping to U-Boot via OP-TEE\n");
540 spl_optee_entry(NULL, NULL, spl_image.fdt_addr,
541 (void *)spl_image.entry_point);
544 #ifdef CONFIG_SPL_OS_BOOT
546 debug("Jumping to Linux\n");
548 spl_board_prepare_for_linux();
549 jump_to_image_linux(&spl_image);
552 debug("Unsupported OS image.. Jumping nevertheless..\n");
554 #if CONFIG_VAL(SYS_MALLOC_F_LEN) && !defined(CONFIG_SYS_SPL_MALLOC_SIZE)
555 debug("SPL malloc() used 0x%lx bytes (%ld KB)\n", gd->malloc_ptr,
556 gd->malloc_ptr / 1024);
558 #ifdef CONFIG_BOOTSTAGE_STASH
561 bootstage_mark_name(BOOTSTAGE_ID_END_SPL, "end_spl");
562 ret = bootstage_stash((void *)CONFIG_BOOTSTAGE_STASH_ADDR,
563 CONFIG_BOOTSTAGE_STASH_SIZE);
565 debug("Failed to stash bootstage: err=%d\n", ret);
568 debug("loaded - jumping to U-Boot...\n");
569 spl_board_prepare_for_boot();
570 jump_to_image_no_args(&spl_image);
573 #ifdef CONFIG_SPL_SERIAL_SUPPORT
575 * This requires UART clocks to be enabled. In order for this to work the
576 * caller must ensure that the gd pointer is valid.
578 void preloader_console_init(void)
580 gd->baudrate = CONFIG_BAUDRATE;
582 serial_init(); /* serial communications setup */
584 gd->have_console = 1;
586 #ifndef CONFIG_SPL_DISABLE_BANNER_PRINT
587 puts("\nU-Boot SPL " PLAIN_VERSION " (" U_BOOT_DATE " - " \
588 U_BOOT_TIME " " U_BOOT_TZ ")\n");
590 #ifdef CONFIG_SPL_DISPLAY_PRINT
597 * spl_relocate_stack_gd() - Relocate stack ready for board_init_r() execution
599 * Sometimes board_init_f() runs with a stack in SRAM but we want to use SDRAM
600 * for the main board_init_r() execution. This is typically because we need
601 * more stack space for things like the MMC sub-system.
603 * This function calculates the stack position, copies the global_data into
604 * place, sets the new gd (except for ARM, for which setting GD within a C
605 * function may not always work) and returns the new stack position. The
606 * caller is responsible for setting up the sp register and, in the case
607 * of ARM, setting up gd.
609 * All of this is done using the same layout and alignments as done in
610 * board_init_f_init_reserve() / board_init_f_alloc_reserve().
612 * @return new stack location, or 0 to use the same stack
614 ulong spl_relocate_stack_gd(void)
616 #ifdef CONFIG_SPL_STACK_R
618 ulong ptr = CONFIG_SPL_STACK_R_ADDR;
620 #if defined(CONFIG_SPL_SYS_MALLOC_SIMPLE) && CONFIG_VAL(SYS_MALLOC_F_LEN)
621 if (CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN) {
622 ptr -= CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN;
623 gd->malloc_base = ptr;
624 gd->malloc_limit = CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN;
628 /* Get stack position: use 8-byte alignment for ABI compliance */
629 ptr = CONFIG_SPL_STACK_R_ADDR - roundup(sizeof(gd_t),16);
630 new_gd = (gd_t *)ptr;
631 memcpy(new_gd, (void *)gd, sizeof(gd_t));
632 #if CONFIG_IS_ENABLED(DM)
633 dm_fixup_for_gd_move(new_gd);
635 #if !defined(CONFIG_ARM)