3 * Texas Instruments, <www.ti.com>
5 * Aneesh V <aneesh@ti.com>
7 * SPDX-License-Identifier: GPL-2.0+
12 #include <asm/u-boot.h>
19 #include <linux/compiler.h>
21 DECLARE_GLOBAL_DATA_PTR;
23 #ifndef CONFIG_SYS_UBOOT_START
24 #define CONFIG_SYS_UBOOT_START CONFIG_SYS_TEXT_BASE
26 #ifndef CONFIG_SYS_MONITOR_LEN
27 /* Unknown U-Boot size, let's assume it will not be more than 200 KB */
28 #define CONFIG_SYS_MONITOR_LEN (200 * 1024)
31 u32 *boot_params_ptr = NULL;
32 struct spl_image_info spl_image;
34 /* Define board data structure */
35 static bd_t bdata __attribute__ ((section(".data")));
38 * Board-specific Platform code can reimplement show_boot_progress () if needed
40 __weak void show_boot_progress(int val) {}
43 * Default function to determine if u-boot or the OS should
44 * be started. This implementation always returns 1.
46 * Please implement your own board specific funcion to do this.
49 * 0 to not start u-boot
50 * positive if u-boot should start
52 #ifdef CONFIG_SPL_OS_BOOT
53 __weak int spl_start_uboot(void)
55 puts("SPL: Please implement spl_start_uboot() for your board\n");
56 puts("SPL: Direct Linux boot not active!\n");
61 * Weak default function for arch specific zImage check. Return zero
62 * and fill start and end address if image is recognized.
64 int __weak bootz_setup(ulong image, ulong *start, ulong *end)
71 * Weak default function for board specific cleanup/preparation before
72 * Linux boot. Some boards/platforms might not need it, so just provide
75 __weak void spl_board_prepare_for_linux(void)
80 __weak void spl_board_prepare_for_boot(void)
85 void spl_set_header_raw_uboot(struct spl_image_info *spl_image)
87 spl_image->size = CONFIG_SYS_MONITOR_LEN;
88 spl_image->entry_point = CONFIG_SYS_UBOOT_START;
89 spl_image->load_addr = CONFIG_SYS_TEXT_BASE;
90 spl_image->os = IH_OS_U_BOOT;
91 spl_image->name = "U-Boot";
94 int spl_parse_image_header(struct spl_image_info *spl_image,
95 const struct image_header *header)
97 u32 header_size = sizeof(struct image_header);
99 if (image_get_magic(header) == IH_MAGIC) {
100 if (spl_image->flags & SPL_COPY_PAYLOAD_ONLY) {
102 * On some system (e.g. powerpc), the load-address and
103 * entry-point is located at address 0. We can't load
104 * to 0-0x40. So skip header in this case.
106 spl_image->load_addr = image_get_load(header);
107 spl_image->entry_point = image_get_ep(header);
108 spl_image->size = image_get_data_size(header);
110 spl_image->entry_point = image_get_load(header);
111 /* Load including the header */
112 spl_image->load_addr = spl_image->entry_point -
114 spl_image->size = image_get_data_size(header) +
117 spl_image->os = image_get_os(header);
118 spl_image->name = image_get_name(header);
119 debug("spl: payload image: %.*s load addr: 0x%x size: %d\n",
120 (int)sizeof(spl_image->name), spl_image->name,
121 spl_image->load_addr, spl_image->size);
123 #ifdef CONFIG_SPL_PANIC_ON_RAW_IMAGE
125 * CONFIG_SPL_PANIC_ON_RAW_IMAGE is defined when the
126 * code which loads images in SPL cannot guarantee that
127 * absolutely all read errors will be reported.
128 * An example is the LPC32XX MLC NAND driver, which
129 * will consider that a completely unreadable NAND block
130 * is bad, and thus should be skipped silently.
132 panic("** no mkimage signature but raw image not supported");
135 #ifdef CONFIG_SPL_OS_BOOT
138 if (!bootz_setup((ulong)header, &start, &end)) {
139 spl_image->name = "Linux";
140 spl_image->os = IH_OS_LINUX;
141 spl_image->load_addr = CONFIG_SYS_LOAD_ADDR;
142 spl_image->entry_point = CONFIG_SYS_LOAD_ADDR;
143 spl_image->size = end - start;
144 debug("spl: payload zImage, load addr: 0x%x size: %d\n",
145 spl_image->load_addr, spl_image->size);
150 #ifdef CONFIG_SPL_ABORT_ON_RAW_IMAGE
151 /* Signature not found, proceed to other boot methods. */
154 /* Signature not found - assume u-boot.bin */
155 debug("mkimage signature not found - ih_magic = %x\n",
157 spl_set_header_raw_uboot(spl_image);
163 __weak void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image)
165 typedef void __noreturn (*image_entry_noargs_t)(void);
167 image_entry_noargs_t image_entry =
168 (image_entry_noargs_t)(unsigned long)spl_image->entry_point;
170 debug("image entry point: 0x%X\n", spl_image->entry_point);
174 #ifndef CONFIG_SPL_LOAD_FIT_ADDRESS
175 # define CONFIG_SPL_LOAD_FIT_ADDRESS 0
178 #if defined(CONFIG_SPL_RAM_DEVICE) || defined(CONFIG_SPL_DFU_SUPPORT)
179 static ulong spl_ram_load_read(struct spl_load_info *load, ulong sector,
180 ulong count, void *buf)
182 debug("%s: sector %lx, count %lx, buf %lx\n",
183 __func__, sector, count, (ulong)buf);
184 memcpy(buf, (void *)(CONFIG_SPL_LOAD_FIT_ADDRESS + sector), count);
188 static int spl_ram_load_image(struct spl_boot_device *bootdev)
190 struct image_header *header;
192 header = (struct image_header *)CONFIG_SPL_LOAD_FIT_ADDRESS;
194 #if defined(CONFIG_SPL_DFU_SUPPORT)
195 if (bootdev->boot_device == BOOT_DEVICE_DFU)
196 spl_dfu_cmd(0, "dfu_alt_info_ram", "ram", "0");
199 if (IS_ENABLED(CONFIG_SPL_LOAD_FIT) &&
200 image_get_magic(header) == FDT_MAGIC) {
201 struct spl_load_info load;
203 debug("Found FIT\n");
205 load.read = spl_ram_load_read;
206 spl_load_simple_fit(&load, 0, header);
208 debug("Legacy image\n");
210 * Get the header. It will point to an address defined by
211 * handoff which will tell where the image located inside
212 * the flash. For now, it will temporary fixed to address
215 header = (struct image_header *)
216 (CONFIG_SYS_TEXT_BASE - sizeof(struct image_header));
218 spl_parse_image_header(&spl_image, header);
223 SPL_LOAD_IMAGE_METHOD(0, BOOT_DEVICE_RAM, spl_ram_load_image);
224 #if defined(CONFIG_SPL_DFU_SUPPORT)
225 SPL_LOAD_IMAGE_METHOD(0, BOOT_DEVICE_DFU, spl_ram_load_image);
233 debug("spl_init()\n");
234 #if defined(CONFIG_SYS_MALLOC_F_LEN)
235 #ifdef CONFIG_MALLOC_F_ADDR
236 gd->malloc_base = CONFIG_MALLOC_F_ADDR;
238 gd->malloc_limit = CONFIG_SYS_MALLOC_F_LEN;
241 if (CONFIG_IS_ENABLED(OF_CONTROL) && !CONFIG_IS_ENABLED(OF_PLATDATA)) {
242 ret = fdtdec_setup();
244 debug("fdtdec_setup() returned error %d\n", ret);
248 if (IS_ENABLED(CONFIG_SPL_DM)) {
249 /* With CONFIG_OF_PLATDATA, bring in all devices */
250 ret = dm_init_and_scan(!CONFIG_IS_ENABLED(OF_PLATDATA));
252 debug("dm_init_and_scan() returned error %d\n", ret);
256 gd->flags |= GD_FLG_SPL_INIT;
261 #ifndef BOOT_DEVICE_NONE
262 #define BOOT_DEVICE_NONE 0xdeadbeef
265 static u32 spl_boot_list[] = {
273 __weak void board_boot_order(u32 *spl_boot_list)
275 spl_boot_list[0] = spl_boot_device();
278 #ifdef CONFIG_SPL_BOARD_LOAD_IMAGE
279 __weak void spl_board_announce_boot_device(void) { }
282 #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
283 struct boot_device_name {
288 struct boot_device_name boot_name_table[] = {
289 #ifdef CONFIG_SPL_RAM_DEVICE
290 { BOOT_DEVICE_RAM, "RAM" },
292 #ifdef CONFIG_SPL_MMC_SUPPORT
293 { BOOT_DEVICE_MMC1, "MMC1" },
294 { BOOT_DEVICE_MMC2, "MMC2" },
295 { BOOT_DEVICE_MMC2_2, "MMC2_2" },
297 #ifdef CONFIG_SPL_NAND_SUPPORT
298 { BOOT_DEVICE_NAND, "NAND" },
300 #ifdef CONFIG_SPL_ONENAND_SUPPORT
301 { BOOT_DEVICE_ONENAND, "OneNAND" },
303 #ifdef CONFIG_SPL_NOR_SUPPORT
304 { BOOT_DEVICE_NOR, "NOR" },
306 #ifdef CONFIG_SPL_YMODEM_SUPPORT
307 { BOOT_DEVICE_UART, "UART" },
309 #if defined(CONFIG_SPL_SPI_SUPPORT) || defined(CONFIG_SPL_SPI_FLASH_SUPPORT)
310 { BOOT_DEVICE_SPI, "SPI" },
312 #ifdef CONFIG_SPL_ETH_SUPPORT
313 #ifdef CONFIG_SPL_ETH_DEVICE
314 { BOOT_DEVICE_CPGMAC, "eth device" },
316 { BOOT_DEVICE_CPGMAC, "net" },
319 #ifdef CONFIG_SPL_USBETH_SUPPORT
320 { BOOT_DEVICE_USBETH, "USB eth" },
322 #ifdef CONFIG_SPL_USB_SUPPORT
323 { BOOT_DEVICE_USB, "USB" },
325 #ifdef CONFIG_SPL_DFU_SUPPORT
326 { BOOT_DEVICE_DFU, "USB DFU" },
328 #ifdef CONFIG_SPL_SATA_SUPPORT
329 { BOOT_DEVICE_SATA, "SATA" },
331 /* Keep this entry last */
332 { BOOT_DEVICE_NONE, "unknown boot device" },
335 static void announce_boot_device(u32 boot_device)
339 puts("Trying to boot from ");
341 #ifdef CONFIG_SPL_BOARD_LOAD_IMAGE
342 if (boot_device == BOOT_DEVICE_BOARD) {
343 spl_board_announce_boot_device();
348 for (i = 0; i < ARRAY_SIZE(boot_name_table) - 1; i++) {
349 if (boot_name_table[i].boot_dev == boot_device)
353 printf("%s\n", boot_name_table[i].name);
356 static inline void announce_boot_device(u32 boot_device) { }
359 static struct spl_image_loader *spl_ll_find_loader(uint boot_device)
361 struct spl_image_loader *drv =
362 ll_entry_start(struct spl_image_loader, spl_image_loader);
364 ll_entry_count(struct spl_image_loader, spl_image_loader);
365 struct spl_image_loader *entry;
367 for (entry = drv; entry != drv + n_ents; entry++) {
368 if (boot_device == entry->boot_device)
376 static int spl_load_image(u32 boot_device)
378 struct spl_boot_device bootdev;
379 struct spl_image_loader *loader = spl_ll_find_loader(boot_device);
381 bootdev.boot_device = boot_device;
382 bootdev.boot_device_name = NULL;
384 return loader->load_image(&bootdev);
386 switch (boot_device) {
387 #ifdef CONFIG_SPL_YMODEM_SUPPORT
388 case BOOT_DEVICE_UART:
389 return spl_ymodem_load_image(&bootdev);
391 #if defined(CONFIG_SPL_SPI_SUPPORT) || defined(CONFIG_SPL_SPI_FLASH_SUPPORT)
392 case BOOT_DEVICE_SPI:
393 return spl_spi_load_image(&bootdev);
395 #ifdef CONFIG_SPL_ETH_SUPPORT
396 case BOOT_DEVICE_CPGMAC:
397 #ifdef CONFIG_SPL_ETH_DEVICE
398 bootdev.boot_device_name = CONFIG_SPL_ETH_DEVICE;
400 return spl_net_load_image(&bootdev);
402 #ifdef CONFIG_SPL_USBETH_SUPPORT
403 case BOOT_DEVICE_USBETH:
404 bootdev.boot_device_name = "usb_ether";
405 return spl_net_load_image(&bootdev);
407 #ifdef CONFIG_SPL_USB_SUPPORT
408 case BOOT_DEVICE_USB:
409 return spl_usb_load_image(&bootdev);
411 #ifdef CONFIG_SPL_SATA_SUPPORT
412 case BOOT_DEVICE_SATA:
413 return spl_sata_load_image(&bootdev);
415 #ifdef CONFIG_SPL_BOARD_LOAD_IMAGE
416 case BOOT_DEVICE_BOARD:
417 return spl_board_load_image(&bootdev);
420 #if defined(CONFIG_SPL_SERIAL_SUPPORT) && defined(CONFIG_SPL_LIBCOMMON_SUPPORT)
421 puts("SPL: Unsupported Boot Device!\n");
429 void board_init_r(gd_t *dummy1, ulong dummy2)
433 debug(">>spl:board_init_r()\n");
435 #if defined(CONFIG_SYS_SPL_MALLOC_START)
436 mem_malloc_init(CONFIG_SYS_SPL_MALLOC_START,
437 CONFIG_SYS_SPL_MALLOC_SIZE);
438 gd->flags |= GD_FLG_FULL_MALLOC_INIT;
440 if (!(gd->flags & GD_FLG_SPL_INIT)) {
446 * timer_init() does not exist on PPC systems. The timer is initialized
447 * and enabled (decrementer) in interrupt_init() here.
452 #ifdef CONFIG_SPL_BOARD_INIT
456 board_boot_order(spl_boot_list);
457 for (i = 0; i < ARRAY_SIZE(spl_boot_list) &&
458 spl_boot_list[i] != BOOT_DEVICE_NONE; i++) {
459 announce_boot_device(spl_boot_list[i]);
460 if (!spl_load_image(spl_boot_list[i]))
464 if (i == ARRAY_SIZE(spl_boot_list) ||
465 spl_boot_list[i] == BOOT_DEVICE_NONE) {
466 puts("SPL: failed to boot from all boot devices\n");
470 switch (spl_image.os) {
472 debug("Jumping to U-Boot\n");
474 #ifdef CONFIG_SPL_OS_BOOT
476 debug("Jumping to Linux\n");
477 spl_board_prepare_for_linux();
478 jump_to_image_linux(&spl_image,
479 (void *)CONFIG_SYS_SPL_ARGS_ADDR);
482 debug("Unsupported OS image.. Jumping nevertheless..\n");
484 #if defined(CONFIG_SYS_MALLOC_F_LEN) && !defined(CONFIG_SYS_SPL_MALLOC_SIZE)
485 debug("SPL malloc() used %#lx bytes (%ld KB)\n", gd->malloc_ptr,
486 gd->malloc_ptr / 1024);
489 debug("loaded - jumping to U-Boot...");
490 spl_board_prepare_for_boot();
491 jump_to_image_no_args(&spl_image);
495 * This requires UART clocks to be enabled. In order for this to work the
496 * caller must ensure that the gd pointer is valid.
498 void preloader_console_init(void)
501 gd->baudrate = CONFIG_BAUDRATE;
503 serial_init(); /* serial communications setup */
505 gd->have_console = 1;
507 puts("\nU-Boot SPL " PLAIN_VERSION " (" U_BOOT_DATE " - " \
509 #ifdef CONFIG_SPL_DISPLAY_PRINT
515 * spl_relocate_stack_gd() - Relocate stack ready for board_init_r() execution
517 * Sometimes board_init_f() runs with a stack in SRAM but we want to use SDRAM
518 * for the main board_init_r() execution. This is typically because we need
519 * more stack space for things like the MMC sub-system.
521 * This function calculates the stack position, copies the global_data into
522 * place, sets the new gd (except for ARM, for which setting GD within a C
523 * function may not always work) and returns the new stack position. The
524 * caller is responsible for setting up the sp register and, in the case
525 * of ARM, setting up gd.
527 * All of this is done using the same layout and alignments as done in
528 * board_init_f_init_reserve() / board_init_f_alloc_reserve().
530 * @return new stack location, or 0 to use the same stack
532 ulong spl_relocate_stack_gd(void)
534 #ifdef CONFIG_SPL_STACK_R
536 ulong ptr = CONFIG_SPL_STACK_R_ADDR;
538 #ifdef CONFIG_SPL_SYS_MALLOC_SIMPLE
539 if (CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN) {
540 ptr -= CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN;
541 gd->malloc_base = ptr;
542 gd->malloc_limit = CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN;
546 /* Get stack position: use 8-byte alignment for ABI compliance */
547 ptr = CONFIG_SPL_STACK_R_ADDR - roundup(sizeof(gd_t),16);
548 new_gd = (gd_t *)ptr;
549 memcpy(new_gd, (void *)gd, sizeof(gd_t));
550 #if !defined(CONFIG_ARM)