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");
115 /* Signature not found - assume u-boot.bin */
116 debug("mkimage signature not found - ih_magic = %x\n",
118 spl_set_header_raw_uboot();
124 __weak void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image)
126 typedef void __noreturn (*image_entry_noargs_t)(void);
128 image_entry_noargs_t image_entry =
129 (image_entry_noargs_t)(unsigned long)spl_image->entry_point;
131 debug("image entry point: 0x%X\n", spl_image->entry_point);
135 #ifdef CONFIG_SPL_RAM_DEVICE
136 static int spl_ram_load_image(void)
138 const struct image_header *header;
141 * Get the header. It will point to an address defined by handoff
142 * which will tell where the image located inside the flash. For
143 * now, it will temporary fixed to address pointed by U-Boot.
145 header = (struct image_header *)
146 (CONFIG_SYS_TEXT_BASE - sizeof(struct image_header));
148 spl_parse_image_header(header);
158 debug("spl_init()\n");
159 #if defined(CONFIG_SYS_MALLOC_F_LEN)
160 gd->malloc_limit = CONFIG_SYS_MALLOC_F_LEN;
163 if (CONFIG_IS_ENABLED(OF_CONTROL)) {
164 ret = fdtdec_setup();
166 debug("fdtdec_setup() returned error %d\n", ret);
170 if (IS_ENABLED(CONFIG_SPL_DM)) {
171 ret = dm_init_and_scan(true);
173 debug("dm_init_and_scan() returned error %d\n", ret);
177 gd->flags |= GD_FLG_SPL_INIT;
182 #ifndef BOOT_DEVICE_NONE
183 #define BOOT_DEVICE_NONE 0xdeadbeef
186 static u32 spl_boot_list[] = {
194 __weak void board_boot_order(u32 *spl_boot_list)
196 spl_boot_list[0] = spl_boot_device();
199 #ifdef CONFIG_SPL_BOARD_LOAD_IMAGE
200 __weak void spl_board_announce_boot_device(void) { }
203 #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
204 struct boot_device_name {
209 struct boot_device_name boot_name_table[] = {
210 #ifdef CONFIG_SPL_RAM_DEVICE
211 { BOOT_DEVICE_RAM, "RAM" },
213 #ifdef CONFIG_SPL_MMC_SUPPORT
214 { BOOT_DEVICE_MMC1, "MMC1" },
215 { BOOT_DEVICE_MMC2, "MMC2" },
216 { BOOT_DEVICE_MMC2_2, "MMC2_2" },
218 #ifdef CONFIG_SPL_NAND_SUPPORT
219 { BOOT_DEVICE_NAND, "NAND" },
221 #ifdef CONFIG_SPL_ONENAND_SUPPORT
222 { BOOT_DEVICE_ONENAND, "OneNAND" },
224 #ifdef CONFIG_SPL_NOR_SUPPORT
225 { BOOT_DEVICE_NOR, "NOR" },
227 #ifdef CONFIG_SPL_YMODEM_SUPPORT
228 { BOOT_DEVICE_UART, "UART" },
230 #ifdef CONFIG_SPL_SPI_SUPPORT
231 { BOOT_DEVICE_SPI, "SPI" },
233 #ifdef CONFIG_SPL_ETH_SUPPORT
234 #ifdef CONFIG_SPL_ETH_DEVICE
235 { BOOT_DEVICE_CPGMAC, "eth device" },
237 { BOOT_DEVICE_CPGMAC, "net" },
240 #ifdef CONFIG_SPL_USBETH_SUPPORT
241 { BOOT_DEVICE_USBETH, "USB eth" },
243 #ifdef CONFIG_SPL_USB_SUPPORT
244 { BOOT_DEVICE_USB, "USB" },
246 #ifdef CONFIG_SPL_SATA_SUPPORT
247 { BOOT_DEVICE_SATA, "SATA" },
249 /* Keep this entry last */
250 { BOOT_DEVICE_NONE, "unknown boot device" },
253 static void announce_boot_device(u32 boot_device)
257 puts("Trying to boot from ");
259 #ifdef CONFIG_SPL_BOARD_LOAD_IMAGE
260 if (boot_device == BOOT_DEVICE_BOARD) {
261 spl_board_announce_boot_device();
266 for (i = 0; i < ARRAY_SIZE(boot_name_table) - 1; i++) {
267 if (boot_name_table[i].boot_dev == boot_device)
271 printf("%s\n", boot_name_table[i].name);
274 static inline void announce_boot_device(u32 boot_device) { }
277 static int spl_load_image(u32 boot_device)
279 switch (boot_device) {
280 #ifdef CONFIG_SPL_RAM_DEVICE
281 case BOOT_DEVICE_RAM:
282 return spl_ram_load_image();
284 #ifdef CONFIG_SPL_MMC_SUPPORT
285 case BOOT_DEVICE_MMC1:
286 case BOOT_DEVICE_MMC2:
287 case BOOT_DEVICE_MMC2_2:
288 return spl_mmc_load_image(boot_device);
290 #ifdef CONFIG_SPL_NAND_SUPPORT
291 case BOOT_DEVICE_NAND:
292 return spl_nand_load_image();
294 #ifdef CONFIG_SPL_ONENAND_SUPPORT
295 case BOOT_DEVICE_ONENAND:
296 return spl_onenand_load_image();
298 #ifdef CONFIG_SPL_NOR_SUPPORT
299 case BOOT_DEVICE_NOR:
300 return spl_nor_load_image();
302 #ifdef CONFIG_SPL_YMODEM_SUPPORT
303 case BOOT_DEVICE_UART:
304 return spl_ymodem_load_image();
306 #ifdef CONFIG_SPL_SPI_SUPPORT
307 case BOOT_DEVICE_SPI:
308 return spl_spi_load_image();
310 #ifdef CONFIG_SPL_ETH_SUPPORT
311 case BOOT_DEVICE_CPGMAC:
312 #ifdef CONFIG_SPL_ETH_DEVICE
313 return spl_net_load_image(CONFIG_SPL_ETH_DEVICE);
315 return spl_net_load_image(NULL);
318 #ifdef CONFIG_SPL_USBETH_SUPPORT
319 case BOOT_DEVICE_USBETH:
320 return spl_net_load_image("usb_ether");
322 #ifdef CONFIG_SPL_USB_SUPPORT
323 case BOOT_DEVICE_USB:
324 return spl_usb_load_image();
326 #ifdef CONFIG_SPL_SATA_SUPPORT
327 case BOOT_DEVICE_SATA:
328 return spl_sata_load_image();
330 #ifdef CONFIG_SPL_BOARD_LOAD_IMAGE
331 case BOOT_DEVICE_BOARD:
332 return spl_board_load_image();
335 #if defined(CONFIG_SPL_SERIAL_SUPPORT) && defined(CONFIG_SPL_LIBCOMMON_SUPPORT)
336 puts("SPL: Unsupported Boot Device!\n");
344 void board_init_r(gd_t *dummy1, ulong dummy2)
348 debug(">>spl:board_init_r()\n");
350 #if defined(CONFIG_SYS_SPL_MALLOC_START)
351 mem_malloc_init(CONFIG_SYS_SPL_MALLOC_START,
352 CONFIG_SYS_SPL_MALLOC_SIZE);
353 gd->flags |= GD_FLG_FULL_MALLOC_INIT;
355 if (!(gd->flags & GD_FLG_SPL_INIT)) {
361 * timer_init() does not exist on PPC systems. The timer is initialized
362 * and enabled (decrementer) in interrupt_init() here.
367 #ifdef CONFIG_SPL_BOARD_INIT
371 board_boot_order(spl_boot_list);
372 for (i = 0; i < ARRAY_SIZE(spl_boot_list) &&
373 spl_boot_list[i] != BOOT_DEVICE_NONE; i++) {
374 announce_boot_device(spl_boot_list[i]);
375 if (!spl_load_image(spl_boot_list[i]))
379 if (i == ARRAY_SIZE(spl_boot_list) ||
380 spl_boot_list[i] == BOOT_DEVICE_NONE) {
381 puts("SPL: failed to boot from all boot devices\n");
385 switch (spl_image.os) {
387 debug("Jumping to U-Boot\n");
389 #ifdef CONFIG_SPL_OS_BOOT
391 debug("Jumping to Linux\n");
392 spl_board_prepare_for_linux();
393 jump_to_image_linux((void *)CONFIG_SYS_SPL_ARGS_ADDR);
396 debug("Unsupported OS image.. Jumping nevertheless..\n");
398 #if defined(CONFIG_SYS_MALLOC_F_LEN) && !defined(CONFIG_SYS_SPL_MALLOC_SIZE)
399 debug("SPL malloc() used %#lx bytes (%ld KB)\n", gd->malloc_ptr,
400 gd->malloc_ptr / 1024);
403 debug("loaded - jumping to U-Boot...");
404 jump_to_image_no_args(&spl_image);
408 * This requires UART clocks to be enabled. In order for this to work the
409 * caller must ensure that the gd pointer is valid.
411 void preloader_console_init(void)
414 gd->baudrate = CONFIG_BAUDRATE;
416 serial_init(); /* serial communications setup */
418 gd->have_console = 1;
420 puts("\nU-Boot SPL " PLAIN_VERSION " (" U_BOOT_DATE " - " \
422 #ifdef CONFIG_SPL_DISPLAY_PRINT
428 * spl_relocate_stack_gd() - Relocate stack ready for board_init_r() execution
430 * Sometimes board_init_f() runs with a stack in SRAM but we want to use SDRAM
431 * for the main board_init_r() execution. This is typically because we need
432 * more stack space for things like the MMC sub-system.
434 * This function calculates the stack position, copies the global_data into
435 * place, sets the new gd (except for ARM, for which setting GD within a C
436 * function may not always work) and returns the new stack position. The
437 * caller is responsible for setting up the sp register and, in the case
438 * of ARM, setting up gd.
440 * All of this is done using the same layout and alignments as done in
441 * board_init_f_init_reserve() / board_init_f_alloc_reserve().
443 * @return new stack location, or 0 to use the same stack
445 ulong spl_relocate_stack_gd(void)
447 #ifdef CONFIG_SPL_STACK_R
449 ulong ptr = CONFIG_SPL_STACK_R_ADDR;
451 #ifdef CONFIG_SPL_SYS_MALLOC_SIMPLE
452 if (CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN) {
453 if (!(gd->flags & GD_FLG_SPL_INIT))
454 panic_str("spl_init must be called before heap reloc");
456 ptr -= CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN;
457 gd->malloc_base = ptr;
458 gd->malloc_limit = CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN;
462 /* Get stack position: use 8-byte alignment for ABI compliance */
463 ptr = CONFIG_SPL_STACK_R_ADDR - roundup(sizeof(gd_t),16);
464 new_gd = (gd_t *)ptr;
465 memcpy(new_gd, (void *)gd, sizeof(gd_t));
466 #if !defined(CONFIG_ARM)