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 __weak void spl_board_prepare_for_boot(void)
72 void spl_set_header_raw_uboot(void)
74 spl_image.size = CONFIG_SYS_MONITOR_LEN;
75 spl_image.entry_point = CONFIG_SYS_UBOOT_START;
76 spl_image.load_addr = CONFIG_SYS_TEXT_BASE;
77 spl_image.os = IH_OS_U_BOOT;
78 spl_image.name = "U-Boot";
81 int spl_parse_image_header(const struct image_header *header)
83 u32 header_size = sizeof(struct image_header);
85 if (image_get_magic(header) == IH_MAGIC) {
86 if (spl_image.flags & SPL_COPY_PAYLOAD_ONLY) {
88 * On some system (e.g. powerpc), the load-address and
89 * entry-point is located at address 0. We can't load
90 * to 0-0x40. So skip header in this case.
92 spl_image.load_addr = image_get_load(header);
93 spl_image.entry_point = image_get_ep(header);
94 spl_image.size = image_get_data_size(header);
96 spl_image.entry_point = image_get_load(header);
97 /* Load including the header */
98 spl_image.load_addr = spl_image.entry_point -
100 spl_image.size = image_get_data_size(header) +
103 spl_image.os = image_get_os(header);
104 spl_image.name = image_get_name(header);
105 debug("spl: payload image: %.*s load addr: 0x%x size: %d\n",
106 (int)sizeof(spl_image.name), spl_image.name,
107 spl_image.load_addr, spl_image.size);
109 #ifdef CONFIG_SPL_PANIC_ON_RAW_IMAGE
111 * CONFIG_SPL_PANIC_ON_RAW_IMAGE is defined when the
112 * code which loads images in SPL cannot guarantee that
113 * absolutely all read errors will be reported.
114 * An example is the LPC32XX MLC NAND driver, which
115 * will consider that a completely unreadable NAND block
116 * is bad, and thus should be skipped silently.
118 panic("** no mkimage signature but raw image not supported");
119 #elif defined(CONFIG_SPL_ABORT_ON_RAW_IMAGE)
120 /* Signature not found, proceed to other boot methods. */
123 /* Signature not found - assume u-boot.bin */
124 debug("mkimage signature not found - ih_magic = %x\n",
126 spl_set_header_raw_uboot();
132 __weak void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image)
134 typedef void __noreturn (*image_entry_noargs_t)(void);
136 image_entry_noargs_t image_entry =
137 (image_entry_noargs_t)(unsigned long)spl_image->entry_point;
139 debug("image entry point: 0x%X\n", spl_image->entry_point);
143 #ifndef CONFIG_SPL_LOAD_FIT_ADDRESS
144 # define CONFIG_SPL_LOAD_FIT_ADDRESS 0
147 #ifdef CONFIG_SPL_RAM_DEVICE
148 static ulong spl_ram_load_read(struct spl_load_info *load, ulong sector,
149 ulong count, void *buf)
151 debug("%s: sector %lx, count %lx, buf %lx\n",
152 __func__, sector, count, (ulong)buf);
153 memcpy(buf, (void *)(CONFIG_SPL_LOAD_FIT_ADDRESS + sector), count);
157 static int spl_ram_load_image(void)
159 struct image_header *header;
161 header = (struct image_header *)CONFIG_SPL_LOAD_FIT_ADDRESS;
163 if (IS_ENABLED(CONFIG_SPL_LOAD_FIT) &&
164 image_get_magic(header) == FDT_MAGIC) {
165 struct spl_load_info load;
167 debug("Found FIT\n");
169 load.read = spl_ram_load_read;
170 spl_load_simple_fit(&load, 0, header);
172 debug("Legacy image\n");
174 * Get the header. It will point to an address defined by
175 * handoff which will tell where the image located inside
176 * the flash. For now, it will temporary fixed to address
179 header = (struct image_header *)
180 (CONFIG_SYS_TEXT_BASE - sizeof(struct image_header));
182 spl_parse_image_header(header);
193 debug("spl_init()\n");
194 #if defined(CONFIG_SYS_MALLOC_F_LEN)
195 gd->malloc_limit = CONFIG_SYS_MALLOC_F_LEN;
198 if (CONFIG_IS_ENABLED(OF_CONTROL)) {
199 ret = fdtdec_setup();
201 debug("fdtdec_setup() returned error %d\n", ret);
205 if (IS_ENABLED(CONFIG_SPL_DM)) {
206 ret = dm_init_and_scan(true);
208 debug("dm_init_and_scan() returned error %d\n", ret);
212 gd->flags |= GD_FLG_SPL_INIT;
217 #ifndef BOOT_DEVICE_NONE
218 #define BOOT_DEVICE_NONE 0xdeadbeef
221 static u32 spl_boot_list[] = {
229 __weak void board_boot_order(u32 *spl_boot_list)
231 spl_boot_list[0] = spl_boot_device();
234 #ifdef CONFIG_SPL_BOARD_LOAD_IMAGE
235 __weak void spl_board_announce_boot_device(void) { }
238 #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
239 struct boot_device_name {
244 struct boot_device_name boot_name_table[] = {
245 #ifdef CONFIG_SPL_RAM_DEVICE
246 { BOOT_DEVICE_RAM, "RAM" },
248 #ifdef CONFIG_SPL_MMC_SUPPORT
249 { BOOT_DEVICE_MMC1, "MMC1" },
250 { BOOT_DEVICE_MMC2, "MMC2" },
251 { BOOT_DEVICE_MMC2_2, "MMC2_2" },
253 #ifdef CONFIG_SPL_NAND_SUPPORT
254 { BOOT_DEVICE_NAND, "NAND" },
256 #ifdef CONFIG_SPL_ONENAND_SUPPORT
257 { BOOT_DEVICE_ONENAND, "OneNAND" },
259 #ifdef CONFIG_SPL_NOR_SUPPORT
260 { BOOT_DEVICE_NOR, "NOR" },
262 #ifdef CONFIG_SPL_YMODEM_SUPPORT
263 { BOOT_DEVICE_UART, "UART" },
265 #ifdef CONFIG_SPL_SPI_SUPPORT
266 { BOOT_DEVICE_SPI, "SPI" },
268 #ifdef CONFIG_SPL_ETH_SUPPORT
269 #ifdef CONFIG_SPL_ETH_DEVICE
270 { BOOT_DEVICE_CPGMAC, "eth device" },
272 { BOOT_DEVICE_CPGMAC, "net" },
275 #ifdef CONFIG_SPL_USBETH_SUPPORT
276 { BOOT_DEVICE_USBETH, "USB eth" },
278 #ifdef CONFIG_SPL_USB_SUPPORT
279 { BOOT_DEVICE_USB, "USB" },
281 #ifdef CONFIG_SPL_SATA_SUPPORT
282 { BOOT_DEVICE_SATA, "SATA" },
284 /* Keep this entry last */
285 { BOOT_DEVICE_NONE, "unknown boot device" },
288 static void announce_boot_device(u32 boot_device)
292 puts("Trying to boot from ");
294 #ifdef CONFIG_SPL_BOARD_LOAD_IMAGE
295 if (boot_device == BOOT_DEVICE_BOARD) {
296 spl_board_announce_boot_device();
301 for (i = 0; i < ARRAY_SIZE(boot_name_table) - 1; i++) {
302 if (boot_name_table[i].boot_dev == boot_device)
306 printf("%s\n", boot_name_table[i].name);
309 static inline void announce_boot_device(u32 boot_device) { }
312 static int spl_load_image(u32 boot_device)
314 switch (boot_device) {
315 #ifdef CONFIG_SPL_RAM_DEVICE
316 case BOOT_DEVICE_RAM:
317 return spl_ram_load_image();
319 #ifdef CONFIG_SPL_MMC_SUPPORT
320 case BOOT_DEVICE_MMC1:
321 case BOOT_DEVICE_MMC2:
322 case BOOT_DEVICE_MMC2_2:
323 return spl_mmc_load_image(boot_device);
325 #ifdef CONFIG_SPL_NAND_SUPPORT
326 case BOOT_DEVICE_NAND:
327 return spl_nand_load_image();
329 #ifdef CONFIG_SPL_ONENAND_SUPPORT
330 case BOOT_DEVICE_ONENAND:
331 return spl_onenand_load_image();
333 #ifdef CONFIG_SPL_NOR_SUPPORT
334 case BOOT_DEVICE_NOR:
335 return spl_nor_load_image();
337 #ifdef CONFIG_SPL_YMODEM_SUPPORT
338 case BOOT_DEVICE_UART:
339 return spl_ymodem_load_image();
341 #ifdef CONFIG_SPL_SPI_SUPPORT
342 case BOOT_DEVICE_SPI:
343 return spl_spi_load_image();
345 #ifdef CONFIG_SPL_ETH_SUPPORT
346 case BOOT_DEVICE_CPGMAC:
347 #ifdef CONFIG_SPL_ETH_DEVICE
348 return spl_net_load_image(CONFIG_SPL_ETH_DEVICE);
350 return spl_net_load_image(NULL);
353 #ifdef CONFIG_SPL_USBETH_SUPPORT
354 case BOOT_DEVICE_USBETH:
355 return spl_net_load_image("usb_ether");
357 #ifdef CONFIG_SPL_USB_SUPPORT
358 case BOOT_DEVICE_USB:
359 return spl_usb_load_image();
361 #ifdef CONFIG_SPL_SATA_SUPPORT
362 case BOOT_DEVICE_SATA:
363 return spl_sata_load_image();
365 #ifdef CONFIG_SPL_BOARD_LOAD_IMAGE
366 case BOOT_DEVICE_BOARD:
367 return spl_board_load_image();
370 #if defined(CONFIG_SPL_SERIAL_SUPPORT) && defined(CONFIG_SPL_LIBCOMMON_SUPPORT)
371 puts("SPL: Unsupported Boot Device!\n");
379 void board_init_r(gd_t *dummy1, ulong dummy2)
383 debug(">>spl:board_init_r()\n");
385 #if defined(CONFIG_SYS_SPL_MALLOC_START)
386 mem_malloc_init(CONFIG_SYS_SPL_MALLOC_START,
387 CONFIG_SYS_SPL_MALLOC_SIZE);
388 gd->flags |= GD_FLG_FULL_MALLOC_INIT;
390 if (!(gd->flags & GD_FLG_SPL_INIT)) {
396 * timer_init() does not exist on PPC systems. The timer is initialized
397 * and enabled (decrementer) in interrupt_init() here.
402 #ifdef CONFIG_SPL_BOARD_INIT
406 board_boot_order(spl_boot_list);
407 for (i = 0; i < ARRAY_SIZE(spl_boot_list) &&
408 spl_boot_list[i] != BOOT_DEVICE_NONE; i++) {
409 announce_boot_device(spl_boot_list[i]);
410 if (!spl_load_image(spl_boot_list[i]))
414 if (i == ARRAY_SIZE(spl_boot_list) ||
415 spl_boot_list[i] == BOOT_DEVICE_NONE) {
416 puts("SPL: failed to boot from all boot devices\n");
420 switch (spl_image.os) {
422 debug("Jumping to U-Boot\n");
424 #ifdef CONFIG_SPL_OS_BOOT
426 debug("Jumping to Linux\n");
427 spl_board_prepare_for_linux();
428 jump_to_image_linux((void *)CONFIG_SYS_SPL_ARGS_ADDR);
431 debug("Unsupported OS image.. Jumping nevertheless..\n");
433 #if defined(CONFIG_SYS_MALLOC_F_LEN) && !defined(CONFIG_SYS_SPL_MALLOC_SIZE)
434 debug("SPL malloc() used %#lx bytes (%ld KB)\n", gd->malloc_ptr,
435 gd->malloc_ptr / 1024);
438 debug("loaded - jumping to U-Boot...");
439 spl_board_prepare_for_boot();
440 jump_to_image_no_args(&spl_image);
444 * This requires UART clocks to be enabled. In order for this to work the
445 * caller must ensure that the gd pointer is valid.
447 void preloader_console_init(void)
450 gd->baudrate = CONFIG_BAUDRATE;
452 serial_init(); /* serial communications setup */
454 gd->have_console = 1;
456 puts("\nU-Boot SPL " PLAIN_VERSION " (" U_BOOT_DATE " - " \
458 #ifdef CONFIG_SPL_DISPLAY_PRINT
464 * spl_relocate_stack_gd() - Relocate stack ready for board_init_r() execution
466 * Sometimes board_init_f() runs with a stack in SRAM but we want to use SDRAM
467 * for the main board_init_r() execution. This is typically because we need
468 * more stack space for things like the MMC sub-system.
470 * This function calculates the stack position, copies the global_data into
471 * place, sets the new gd (except for ARM, for which setting GD within a C
472 * function may not always work) and returns the new stack position. The
473 * caller is responsible for setting up the sp register and, in the case
474 * of ARM, setting up gd.
476 * All of this is done using the same layout and alignments as done in
477 * board_init_f_init_reserve() / board_init_f_alloc_reserve().
479 * @return new stack location, or 0 to use the same stack
481 ulong spl_relocate_stack_gd(void)
483 #ifdef CONFIG_SPL_STACK_R
485 ulong ptr = CONFIG_SPL_STACK_R_ADDR;
487 #ifdef CONFIG_SPL_SYS_MALLOC_SIMPLE
488 if (CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN) {
489 ptr -= CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN;
490 gd->malloc_base = ptr;
491 gd->malloc_limit = CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN;
495 /* Get stack position: use 8-byte alignment for ABI compliance */
496 ptr = CONFIG_SPL_STACK_R_ADDR - roundup(sizeof(gd_t),16);
497 new_gd = (gd_t *)ptr;
498 memcpy(new_gd, (void *)gd, sizeof(gd_t));
499 #if !defined(CONFIG_ARM)