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>
20 #include <linux/compiler.h>
22 DECLARE_GLOBAL_DATA_PTR;
24 #ifndef CONFIG_SYS_UBOOT_START
25 #define CONFIG_SYS_UBOOT_START CONFIG_SYS_TEXT_BASE
27 #ifndef CONFIG_SYS_MONITOR_LEN
28 /* Unknown U-Boot size, let's assume it will not be more than 200 KB */
29 #define CONFIG_SYS_MONITOR_LEN (200 * 1024)
32 u32 *boot_params_ptr = NULL;
33 struct spl_image_info spl_image;
35 /* Define board data structure */
36 static bd_t bdata __attribute__ ((section(".data")));
39 * Default function to determine if u-boot or the OS should
40 * be started. This implementation always returns 1.
42 * Please implement your own board specific funcion to do this.
45 * 0 to not start u-boot
46 * positive if u-boot should start
48 #ifdef CONFIG_SPL_OS_BOOT
49 __weak int spl_start_uboot(void)
51 puts("SPL: Please implement spl_start_uboot() for your board\n");
52 puts("SPL: Direct Linux boot not active!\n");
58 * Weak default function for board specific cleanup/preparation before
59 * Linux boot. Some boards/platforms might not need it, so just provide
62 __weak void spl_board_prepare_for_linux(void)
67 void spl_set_header_raw_uboot(void)
69 spl_image.size = CONFIG_SYS_MONITOR_LEN;
70 spl_image.entry_point = CONFIG_SYS_UBOOT_START;
71 spl_image.load_addr = CONFIG_SYS_TEXT_BASE;
72 spl_image.os = IH_OS_U_BOOT;
73 spl_image.name = "U-Boot";
76 int spl_parse_image_header(const struct image_header *header)
78 u32 header_size = sizeof(struct image_header);
80 if (image_get_magic(header) == IH_MAGIC) {
81 if (spl_image.flags & SPL_COPY_PAYLOAD_ONLY) {
83 * On some system (e.g. powerpc), the load-address and
84 * entry-point is located at address 0. We can't load
85 * to 0-0x40. So skip header in this case.
87 spl_image.load_addr = image_get_load(header);
88 spl_image.entry_point = image_get_ep(header);
89 spl_image.size = image_get_data_size(header);
91 spl_image.entry_point = image_get_load(header);
92 /* Load including the header */
93 spl_image.load_addr = spl_image.entry_point -
95 spl_image.size = image_get_data_size(header) +
98 spl_image.os = image_get_os(header);
99 spl_image.name = image_get_name(header);
100 debug("spl: payload image: %.*s load addr: 0x%x size: %d\n",
101 (int)sizeof(spl_image.name), spl_image.name,
102 spl_image.load_addr, spl_image.size);
104 #ifdef CONFIG_SPL_PANIC_ON_RAW_IMAGE
106 * CONFIG_SPL_PANIC_ON_RAW_IMAGE is defined when the
107 * code which loads images in SPL cannot guarantee that
108 * absolutely all read errors will be reported.
109 * An example is the LPC32XX MLC NAND driver, which
110 * will consider that a completely unreadable NAND block
111 * is bad, and thus should be skipped silently.
113 panic("** no mkimage signature but raw image not supported");
114 #elif defined(CONFIG_SPL_ABORT_ON_RAW_IMAGE)
115 /* Signature not found, proceed to other boot methods. */
118 /* Signature not found - assume u-boot.bin */
119 debug("mkimage signature not found - ih_magic = %x\n",
121 spl_set_header_raw_uboot();
127 __weak void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image)
129 typedef void __noreturn (*image_entry_noargs_t)(void);
131 image_entry_noargs_t image_entry =
132 (image_entry_noargs_t)(unsigned long)spl_image->entry_point;
134 debug("image entry point: 0x%X\n", spl_image->entry_point);
138 #ifdef CONFIG_SPL_RAM_DEVICE
139 static int spl_ram_load_image(void)
141 const struct image_header *header;
144 * Get the header. It will point to an address defined by handoff
145 * which will tell where the image located inside the flash. For
146 * now, it will temporary fixed to address pointed by U-Boot.
148 header = (struct image_header *)
149 (CONFIG_SYS_TEXT_BASE - sizeof(struct image_header));
151 spl_parse_image_header(header);
161 debug("spl_init()\n");
162 #if defined(CONFIG_SYS_MALLOC_F_LEN)
163 gd->malloc_limit = CONFIG_SYS_MALLOC_F_LEN;
166 if (CONFIG_IS_ENABLED(OF_CONTROL)) {
167 ret = fdtdec_setup();
169 debug("fdtdec_setup() returned error %d\n", ret);
173 if (IS_ENABLED(CONFIG_SPL_DM)) {
174 ret = dm_init_and_scan(true);
176 debug("dm_init_and_scan() returned error %d\n", ret);
180 gd->flags |= GD_FLG_SPL_INIT;
185 #ifndef BOOT_DEVICE_NONE
186 #define BOOT_DEVICE_NONE 0xdeadbeef
189 static u32 spl_boot_list[] = {
197 __weak void board_boot_order(u32 *spl_boot_list)
199 spl_boot_list[0] = spl_boot_device();
202 #ifdef CONFIG_SPL_BOARD_LOAD_IMAGE
203 __weak void spl_board_announce_boot_device(void) { }
206 #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
207 struct boot_device_name {
212 struct boot_device_name boot_name_table[] = {
213 #ifdef CONFIG_SPL_RAM_DEVICE
214 { BOOT_DEVICE_RAM, "RAM" },
216 #ifdef CONFIG_SPL_MMC_SUPPORT
217 { BOOT_DEVICE_MMC1, "MMC1" },
218 { BOOT_DEVICE_MMC2, "MMC2" },
219 { BOOT_DEVICE_MMC2_2, "MMC2_2" },
221 #ifdef CONFIG_SPL_NAND_SUPPORT
222 { BOOT_DEVICE_NAND, "NAND" },
224 #ifdef CONFIG_SPL_ONENAND_SUPPORT
225 { BOOT_DEVICE_ONENAND, "OneNAND" },
227 #ifdef CONFIG_SPL_NOR_SUPPORT
228 { BOOT_DEVICE_NOR, "NOR" },
230 #ifdef CONFIG_SPL_YMODEM_SUPPORT
231 { BOOT_DEVICE_UART, "UART" },
233 #ifdef CONFIG_SPL_SPI_SUPPORT
234 { BOOT_DEVICE_SPI, "SPI" },
236 #ifdef CONFIG_SPL_ETH_SUPPORT
237 #ifdef CONFIG_SPL_ETH_DEVICE
238 { BOOT_DEVICE_CPGMAC, "eth device" },
240 { BOOT_DEVICE_CPGMAC, "net" },
243 #ifdef CONFIG_SPL_USBETH_SUPPORT
244 { BOOT_DEVICE_USBETH, "USB eth" },
246 #ifdef CONFIG_SPL_USB_SUPPORT
247 { BOOT_DEVICE_USB, "USB" },
249 #ifdef CONFIG_SPL_SATA_SUPPORT
250 { BOOT_DEVICE_SATA, "SATA" },
252 /* Keep this entry last */
253 { BOOT_DEVICE_NONE, "unknown boot device" },
256 static void announce_boot_device(u32 boot_device)
260 puts("Trying to boot from ");
262 #ifdef CONFIG_SPL_BOARD_LOAD_IMAGE
263 if (boot_device == BOOT_DEVICE_BOARD) {
264 spl_board_announce_boot_device();
269 for (i = 0; i < ARRAY_SIZE(boot_name_table) - 1; i++) {
270 if (boot_name_table[i].boot_dev == boot_device)
274 printf("%s\n", boot_name_table[i].name);
277 static inline void announce_boot_device(u32 boot_device) { }
280 static int spl_load_image(u32 boot_device)
282 switch (boot_device) {
283 #ifdef CONFIG_SPL_RAM_DEVICE
284 case BOOT_DEVICE_RAM:
285 return spl_ram_load_image();
287 #ifdef CONFIG_SPL_MMC_SUPPORT
288 case BOOT_DEVICE_MMC1:
289 case BOOT_DEVICE_MMC2:
290 case BOOT_DEVICE_MMC2_2:
291 return spl_mmc_load_image(boot_device);
293 #ifdef CONFIG_SPL_NAND_SUPPORT
294 case BOOT_DEVICE_NAND:
295 return spl_nand_load_image();
297 #ifdef CONFIG_SPL_ONENAND_SUPPORT
298 case BOOT_DEVICE_ONENAND:
299 return spl_onenand_load_image();
301 #ifdef CONFIG_SPL_NOR_SUPPORT
302 case BOOT_DEVICE_NOR:
303 return spl_nor_load_image();
305 #ifdef CONFIG_SPL_YMODEM_SUPPORT
306 case BOOT_DEVICE_UART:
307 return spl_ymodem_load_image();
309 #ifdef CONFIG_SPL_SPI_SUPPORT
310 case BOOT_DEVICE_SPI:
311 return spl_spi_load_image();
313 #ifdef CONFIG_SPL_ETH_SUPPORT
314 case BOOT_DEVICE_CPGMAC:
315 #ifdef CONFIG_SPL_ETH_DEVICE
316 return spl_net_load_image(CONFIG_SPL_ETH_DEVICE);
318 return spl_net_load_image(NULL);
321 #ifdef CONFIG_SPL_USBETH_SUPPORT
322 case BOOT_DEVICE_USBETH:
323 return spl_net_load_image("usb_ether");
325 #ifdef CONFIG_SPL_USB_SUPPORT
326 case BOOT_DEVICE_USB:
327 return spl_usb_load_image();
329 #ifdef CONFIG_SPL_SATA_SUPPORT
330 case BOOT_DEVICE_SATA:
331 return spl_sata_load_image();
333 #ifdef CONFIG_SPL_BOARD_LOAD_IMAGE
334 case BOOT_DEVICE_BOARD:
335 return spl_board_load_image();
338 #if defined(CONFIG_SPL_SERIAL_SUPPORT) && defined(CONFIG_SPL_LIBCOMMON_SUPPORT)
339 puts("SPL: Unsupported Boot Device!\n");
347 void board_init_r(gd_t *dummy1, ulong dummy2)
351 debug(">>spl:board_init_r()\n");
353 #if defined(CONFIG_SYS_SPL_MALLOC_START)
354 mem_malloc_init(CONFIG_SYS_SPL_MALLOC_START,
355 CONFIG_SYS_SPL_MALLOC_SIZE);
356 gd->flags |= GD_FLG_FULL_MALLOC_INIT;
358 if (!(gd->flags & GD_FLG_SPL_INIT)) {
364 * timer_init() does not exist on PPC systems. The timer is initialized
365 * and enabled (decrementer) in interrupt_init() here.
370 #ifdef CONFIG_SPL_BOARD_INIT
374 board_boot_order(spl_boot_list);
375 for (i = 0; i < ARRAY_SIZE(spl_boot_list) &&
376 spl_boot_list[i] != BOOT_DEVICE_NONE; i++) {
377 announce_boot_device(spl_boot_list[i]);
378 if (!spl_load_image(spl_boot_list[i]))
382 if (i == ARRAY_SIZE(spl_boot_list) ||
383 spl_boot_list[i] == BOOT_DEVICE_NONE) {
384 puts("SPL: failed to boot from all boot devices\n");
388 switch (spl_image.os) {
390 debug("Jumping to U-Boot\n");
392 #ifdef CONFIG_SPL_OS_BOOT
394 debug("Jumping to Linux\n");
395 spl_board_prepare_for_linux();
396 jump_to_image_linux((void *)CONFIG_SYS_SPL_ARGS_ADDR);
399 debug("Unsupported OS image.. Jumping nevertheless..\n");
401 #if defined(CONFIG_SYS_MALLOC_F_LEN) && !defined(CONFIG_SYS_SPL_MALLOC_SIZE)
402 debug("SPL malloc() used %#lx bytes (%ld KB)\n", gd->malloc_ptr,
403 gd->malloc_ptr / 1024);
406 debug("loaded - jumping to U-Boot...");
407 jump_to_image_no_args(&spl_image);
411 * This requires UART clocks to be enabled. In order for this to work the
412 * caller must ensure that the gd pointer is valid.
414 void preloader_console_init(void)
417 gd->baudrate = CONFIG_BAUDRATE;
419 serial_init(); /* serial communications setup */
421 gd->have_console = 1;
423 puts("\nU-Boot SPL " PLAIN_VERSION " (" U_BOOT_DATE " - " \
425 #ifdef CONFIG_SPL_DISPLAY_PRINT
431 * spl_relocate_stack_gd() - Relocate stack ready for board_init_r() execution
433 * Sometimes board_init_f() runs with a stack in SRAM but we want to use SDRAM
434 * for the main board_init_r() execution. This is typically because we need
435 * more stack space for things like the MMC sub-system.
437 * This function calculates the stack position, copies the global_data into
438 * place, sets the new gd (except for ARM, for which setting GD within a C
439 * function may not always work) and returns the new stack position. The
440 * caller is responsible for setting up the sp register and, in the case
441 * of ARM, setting up gd.
443 * All of this is done using the same layout and alignments as done in
444 * board_init_f_init_reserve() / board_init_f_alloc_reserve().
446 * @return new stack location, or 0 to use the same stack
448 ulong spl_relocate_stack_gd(void)
450 #ifdef CONFIG_SPL_STACK_R
452 ulong ptr = CONFIG_SPL_STACK_R_ADDR;
454 #ifdef CONFIG_SPL_SYS_MALLOC_SIMPLE
455 if (CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN) {
456 if (!(gd->flags & GD_FLG_SPL_INIT))
457 panic_str("spl_init must be called before heap reloc");
459 ptr -= CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN;
460 gd->malloc_base = ptr;
461 gd->malloc_limit = CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN;
465 /* Get stack position: use 8-byte alignment for ABI compliance */
466 ptr = CONFIG_SPL_STACK_R_ADDR - roundup(sizeof(gd_t),16);
467 new_gd = (gd_t *)ptr;
468 memcpy(new_gd, (void *)gd, sizeof(gd_t));
469 #if !defined(CONFIG_ARM)