1 // SPDX-License-Identifier: GPL-2.0+
4 * Texas Instruments, <www.ti.com>
6 * Aneesh V <aneesh@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: %.*s load addr: 0x%lx size: %d\n",
189 (int)sizeof(spl_image->name), spl_image->name,
190 spl_image->load_addr, spl_image->size);
192 #ifdef CONFIG_SPL_FIT_SIGNATURE
195 fit_image_load(&images, (ulong)header,
196 &fit_uname_fdt, &fit_uname_config,
197 IH_ARCH_DEFAULT, IH_TYPE_FLATDT, -1,
198 FIT_LOAD_OPTIONAL, &dt_data, &dt_len);
200 conf_noffset = fit_conf_get_node((const void *)header,
202 if (conf_noffset <= 0)
206 uname = fdt_stringlist_get((const void *)header, conf_noffset,
207 FIT_LOADABLE_PROP, idx,
211 #ifdef CONFIG_SPL_FIT_SIGNATURE
214 ret = fit_image_load(&images, (ulong)header,
215 &uname, &fit_uname_config,
216 IH_ARCH_DEFAULT, IH_TYPE_LOADABLE, -1,
217 FIT_LOAD_OPTIONAL_NON_ZERO,
218 &img_data, &img_len);
227 int spl_parse_image_header(struct spl_image_info *spl_image,
228 const struct image_header *header)
230 #ifdef CONFIG_SPL_LOAD_FIT_FULL
231 int ret = spl_load_fit_image(spl_image, header);
236 if (image_get_magic(header) == IH_MAGIC) {
237 #ifdef CONFIG_SPL_LEGACY_IMAGE_SUPPORT
238 u32 header_size = sizeof(struct image_header);
240 if (spl_image->flags & SPL_COPY_PAYLOAD_ONLY) {
242 * On some system (e.g. powerpc), the load-address and
243 * entry-point is located at address 0. We can't load
244 * to 0-0x40. So skip header in this case.
246 spl_image->load_addr = image_get_load(header);
247 spl_image->entry_point = image_get_ep(header);
248 spl_image->size = image_get_data_size(header);
250 spl_image->entry_point = image_get_load(header);
251 /* Load including the header */
252 spl_image->load_addr = spl_image->entry_point -
254 spl_image->size = image_get_data_size(header) +
257 spl_image->os = image_get_os(header);
258 spl_image->name = image_get_name(header);
259 debug("spl: payload image: %.*s load addr: 0x%lx size: %d\n",
260 IH_NMLEN, spl_image->name,
261 spl_image->load_addr, spl_image->size);
263 /* LEGACY image not supported */
264 debug("Legacy boot image support not enabled, proceeding to other boot methods\n");
268 #ifdef CONFIG_SPL_PANIC_ON_RAW_IMAGE
270 * CONFIG_SPL_PANIC_ON_RAW_IMAGE is defined when the
271 * code which loads images in SPL cannot guarantee that
272 * absolutely all read errors will be reported.
273 * An example is the LPC32XX MLC NAND driver, which
274 * will consider that a completely unreadable NAND block
275 * is bad, and thus should be skipped silently.
277 panic("** no mkimage signature but raw image not supported");
280 #ifdef CONFIG_SPL_OS_BOOT
283 if (!bootz_setup((ulong)header, &start, &end)) {
284 spl_image->name = "Linux";
285 spl_image->os = IH_OS_LINUX;
286 spl_image->load_addr = CONFIG_SYS_LOAD_ADDR;
287 spl_image->entry_point = CONFIG_SYS_LOAD_ADDR;
288 spl_image->size = end - start;
289 debug("spl: payload zImage, load addr: 0x%lx size: %d\n",
290 spl_image->load_addr, spl_image->size);
295 #ifdef CONFIG_SPL_RAW_IMAGE_SUPPORT
296 /* Signature not found - assume u-boot.bin */
297 debug("mkimage signature not found - ih_magic = %x\n",
299 spl_set_header_raw_uboot(spl_image);
301 /* RAW image not supported, proceed to other boot methods. */
302 debug("Raw boot image support not enabled, proceeding to other boot methods\n");
310 __weak void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image)
312 typedef void __noreturn (*image_entry_noargs_t)(void);
314 image_entry_noargs_t image_entry =
315 (image_entry_noargs_t)spl_image->entry_point;
317 debug("image entry point: 0x%lX\n", spl_image->entry_point);
321 static int spl_common_init(bool setup_malloc)
325 #if CONFIG_VAL(SYS_MALLOC_F_LEN)
327 #ifdef CONFIG_MALLOC_F_ADDR
328 gd->malloc_base = CONFIG_MALLOC_F_ADDR;
330 gd->malloc_limit = CONFIG_VAL(SYS_MALLOC_F_LEN);
334 ret = bootstage_init(true);
336 debug("%s: Failed to set up bootstage: ret=%d\n", __func__,
340 bootstage_mark_name(BOOTSTAGE_ID_START_SPL, "spl");
341 if (CONFIG_IS_ENABLED(OF_CONTROL) && !CONFIG_IS_ENABLED(OF_PLATDATA)) {
342 ret = fdtdec_setup();
344 debug("fdtdec_setup() returned error %d\n", ret);
348 if (CONFIG_IS_ENABLED(DM)) {
349 bootstage_start(BOOTSTATE_ID_ACCUM_DM_SPL, "dm_spl");
350 /* With CONFIG_SPL_OF_PLATDATA, bring in all devices */
351 ret = dm_init_and_scan(!CONFIG_IS_ENABLED(OF_PLATDATA));
352 bootstage_accum(BOOTSTATE_ID_ACCUM_DM_SPL);
354 debug("dm_init_and_scan() returned error %d\n", ret);
362 void spl_set_bd(void)
368 int spl_early_init(void)
372 debug("%s\n", __func__);
374 ret = spl_common_init(true);
377 gd->flags |= GD_FLG_SPL_EARLY_INIT;
385 bool setup_malloc = !(IS_ENABLED(CONFIG_SPL_STACK_R) &&
386 IS_ENABLED(CONFIG_SPL_SYS_MALLOC_SIMPLE));
388 debug("%s\n", __func__);
390 if (!(gd->flags & GD_FLG_SPL_EARLY_INIT)) {
391 ret = spl_common_init(setup_malloc);
395 gd->flags |= GD_FLG_SPL_INIT;
400 #ifndef BOOT_DEVICE_NONE
401 #define BOOT_DEVICE_NONE 0xdeadbeef
404 __weak void board_boot_order(u32 *spl_boot_list)
406 spl_boot_list[0] = spl_boot_device();
409 static struct spl_image_loader *spl_ll_find_loader(uint boot_device)
411 struct spl_image_loader *drv =
412 ll_entry_start(struct spl_image_loader, spl_image_loader);
414 ll_entry_count(struct spl_image_loader, spl_image_loader);
415 struct spl_image_loader *entry;
417 for (entry = drv; entry != drv + n_ents; entry++) {
418 if (boot_device == entry->boot_device)
426 static int spl_load_image(struct spl_image_info *spl_image,
427 struct spl_image_loader *loader)
429 struct spl_boot_device bootdev;
431 bootdev.boot_device = loader->boot_device;
432 bootdev.boot_device_name = NULL;
434 return loader->load_image(spl_image, &bootdev);
438 * boot_from_devices() - Try loading an booting U-Boot from a list of devices
440 * @spl_image: Place to put the image details if successful
441 * @spl_boot_list: List of boot devices to try
442 * @count: Number of elements in spl_boot_list
443 * @return 0 if OK, -ve on error
445 static int boot_from_devices(struct spl_image_info *spl_image,
446 u32 spl_boot_list[], int count)
450 for (i = 0; i < count && spl_boot_list[i] != BOOT_DEVICE_NONE; i++) {
451 struct spl_image_loader *loader;
453 loader = spl_ll_find_loader(spl_boot_list[i]);
454 #if defined(CONFIG_SPL_SERIAL_SUPPORT) && defined(CONFIG_SPL_LIBCOMMON_SUPPORT)
456 printf("Trying to boot from %s\n", loader->name);
458 puts("SPL: Unsupported Boot Device!\n");
460 if (loader && !spl_load_image(spl_image, loader)) {
461 spl_image->boot_device = spl_boot_list[i];
469 void board_init_r(gd_t *dummy1, ulong dummy2)
471 u32 spl_boot_list[] = {
478 struct spl_image_info spl_image;
480 debug(">>spl:board_init_r()\n");
484 #ifdef CONFIG_SPL_OS_BOOT
485 dram_init_banksize();
488 #if defined(CONFIG_SYS_SPL_MALLOC_START)
489 mem_malloc_init(CONFIG_SYS_SPL_MALLOC_START,
490 CONFIG_SYS_SPL_MALLOC_SIZE);
491 gd->flags |= GD_FLG_FULL_MALLOC_INIT;
493 if (!(gd->flags & GD_FLG_SPL_INIT)) {
497 #if !defined(CONFIG_PPC) && !defined(CONFIG_ARCH_MX6)
499 * timer_init() does not exist on PPC systems. The timer is initialized
500 * and enabled (decrementer) in interrupt_init() here.
505 #if CONFIG_IS_ENABLED(BOARD_INIT)
511 memset(&spl_image, '\0', sizeof(spl_image));
512 #ifdef CONFIG_SYS_SPL_ARGS_ADDR
513 spl_image.arg = (void *)CONFIG_SYS_SPL_ARGS_ADDR;
515 spl_image.boot_device = BOOT_DEVICE_NONE;
516 board_boot_order(spl_boot_list);
518 if (boot_from_devices(&spl_image, spl_boot_list,
519 ARRAY_SIZE(spl_boot_list))) {
520 puts("SPL: failed to boot from all boot devices\n");
524 spl_perform_fixups(&spl_image);
526 #ifdef CONFIG_CPU_V7M
527 spl_image.entry_point |= 0x1;
529 switch (spl_image.os) {
531 debug("Jumping to U-Boot\n");
533 #if CONFIG_IS_ENABLED(ATF)
534 case IH_OS_ARM_TRUSTED_FIRMWARE:
535 debug("Jumping to U-Boot via ARM Trusted Firmware\n");
536 spl_invoke_atf(&spl_image);
539 #ifdef CONFIG_SPL_OS_BOOT
541 debug("Jumping to Linux\n");
543 spl_board_prepare_for_linux();
544 jump_to_image_linux(&spl_image);
547 debug("Unsupported OS image.. Jumping nevertheless..\n");
549 #if CONFIG_VAL(SYS_MALLOC_F_LEN) && !defined(CONFIG_SYS_SPL_MALLOC_SIZE)
550 debug("SPL malloc() used %#lx bytes (%ld KB)\n", gd->malloc_ptr,
551 gd->malloc_ptr / 1024);
553 #ifdef CONFIG_BOOTSTAGE_STASH
556 bootstage_mark_name(BOOTSTAGE_ID_END_SPL, "end_spl");
557 ret = bootstage_stash((void *)CONFIG_BOOTSTAGE_STASH_ADDR,
558 CONFIG_BOOTSTAGE_STASH_SIZE);
560 debug("Failed to stash bootstage: err=%d\n", ret);
563 debug("loaded - jumping to U-Boot...\n");
564 spl_board_prepare_for_boot();
565 jump_to_image_no_args(&spl_image);
568 #ifdef CONFIG_SPL_SERIAL_SUPPORT
570 * This requires UART clocks to be enabled. In order for this to work the
571 * caller must ensure that the gd pointer is valid.
573 void preloader_console_init(void)
575 gd->baudrate = CONFIG_BAUDRATE;
577 serial_init(); /* serial communications setup */
579 gd->have_console = 1;
581 #ifndef CONFIG_SPL_DISABLE_BANNER_PRINT
582 puts("\nU-Boot SPL " PLAIN_VERSION " (" U_BOOT_DATE " - " \
583 U_BOOT_TIME " " U_BOOT_TZ ")\n");
585 #ifdef CONFIG_SPL_DISPLAY_PRINT
592 * spl_relocate_stack_gd() - Relocate stack ready for board_init_r() execution
594 * Sometimes board_init_f() runs with a stack in SRAM but we want to use SDRAM
595 * for the main board_init_r() execution. This is typically because we need
596 * more stack space for things like the MMC sub-system.
598 * This function calculates the stack position, copies the global_data into
599 * place, sets the new gd (except for ARM, for which setting GD within a C
600 * function may not always work) and returns the new stack position. The
601 * caller is responsible for setting up the sp register and, in the case
602 * of ARM, setting up gd.
604 * All of this is done using the same layout and alignments as done in
605 * board_init_f_init_reserve() / board_init_f_alloc_reserve().
607 * @return new stack location, or 0 to use the same stack
609 ulong spl_relocate_stack_gd(void)
611 #ifdef CONFIG_SPL_STACK_R
613 ulong ptr = CONFIG_SPL_STACK_R_ADDR;
615 #if defined(CONFIG_SPL_SYS_MALLOC_SIMPLE) && CONFIG_VAL(SYS_MALLOC_F_LEN)
616 if (CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN) {
617 ptr -= CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN;
618 gd->malloc_base = ptr;
619 gd->malloc_limit = CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN;
623 /* Get stack position: use 8-byte alignment for ABI compliance */
624 ptr = CONFIG_SPL_STACK_R_ADDR - roundup(sizeof(gd_t),16);
625 new_gd = (gd_t *)ptr;
626 memcpy(new_gd, (void *)gd, sizeof(gd_t));
627 #if CONFIG_IS_ENABLED(DM)
628 dm_fixup_for_gd_move(new_gd);
630 #if !defined(CONFIG_ARM)