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 (IS_ENABLED(CONFIG_SPL_LOAD_FIT) &&
195 image_get_magic(header) == FDT_MAGIC) {
196 struct spl_load_info load;
198 debug("Found FIT\n");
200 load.read = spl_ram_load_read;
201 spl_load_simple_fit(&load, 0, header);
203 debug("Legacy image\n");
205 * Get the header. It will point to an address defined by
206 * handoff which will tell where the image located inside
207 * the flash. For now, it will temporary fixed to address
210 header = (struct image_header *)
211 (CONFIG_SYS_TEXT_BASE - sizeof(struct image_header));
213 spl_parse_image_header(&spl_image, header);
224 debug("spl_init()\n");
225 #if defined(CONFIG_SYS_MALLOC_F_LEN)
226 #ifdef CONFIG_MALLOC_F_ADDR
227 gd->malloc_base = CONFIG_MALLOC_F_ADDR;
229 gd->malloc_limit = CONFIG_SYS_MALLOC_F_LEN;
232 if (CONFIG_IS_ENABLED(OF_CONTROL) && !CONFIG_IS_ENABLED(OF_PLATDATA)) {
233 ret = fdtdec_setup();
235 debug("fdtdec_setup() returned error %d\n", ret);
239 if (IS_ENABLED(CONFIG_SPL_DM)) {
240 /* With CONFIG_OF_PLATDATA, bring in all devices */
241 ret = dm_init_and_scan(!CONFIG_IS_ENABLED(OF_PLATDATA));
243 debug("dm_init_and_scan() returned error %d\n", ret);
247 gd->flags |= GD_FLG_SPL_INIT;
252 #ifndef BOOT_DEVICE_NONE
253 #define BOOT_DEVICE_NONE 0xdeadbeef
256 static u32 spl_boot_list[] = {
264 __weak void board_boot_order(u32 *spl_boot_list)
266 spl_boot_list[0] = spl_boot_device();
269 #ifdef CONFIG_SPL_BOARD_LOAD_IMAGE
270 __weak void spl_board_announce_boot_device(void) { }
273 #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
274 struct boot_device_name {
279 struct boot_device_name boot_name_table[] = {
280 #ifdef CONFIG_SPL_RAM_DEVICE
281 { BOOT_DEVICE_RAM, "RAM" },
283 #ifdef CONFIG_SPL_MMC_SUPPORT
284 { BOOT_DEVICE_MMC1, "MMC1" },
285 { BOOT_DEVICE_MMC2, "MMC2" },
286 { BOOT_DEVICE_MMC2_2, "MMC2_2" },
288 #ifdef CONFIG_SPL_NAND_SUPPORT
289 { BOOT_DEVICE_NAND, "NAND" },
291 #ifdef CONFIG_SPL_ONENAND_SUPPORT
292 { BOOT_DEVICE_ONENAND, "OneNAND" },
294 #ifdef CONFIG_SPL_NOR_SUPPORT
295 { BOOT_DEVICE_NOR, "NOR" },
297 #ifdef CONFIG_SPL_YMODEM_SUPPORT
298 { BOOT_DEVICE_UART, "UART" },
300 #if defined(CONFIG_SPL_SPI_SUPPORT) || defined(CONFIG_SPL_SPI_FLASH_SUPPORT)
301 { BOOT_DEVICE_SPI, "SPI" },
303 #ifdef CONFIG_SPL_ETH_SUPPORT
304 #ifdef CONFIG_SPL_ETH_DEVICE
305 { BOOT_DEVICE_CPGMAC, "eth device" },
307 { BOOT_DEVICE_CPGMAC, "net" },
310 #ifdef CONFIG_SPL_USBETH_SUPPORT
311 { BOOT_DEVICE_USBETH, "USB eth" },
313 #ifdef CONFIG_SPL_USB_SUPPORT
314 { BOOT_DEVICE_USB, "USB" },
316 #ifdef CONFIG_SPL_DFU_SUPPORT
317 { BOOT_DEVICE_DFU, "USB DFU" },
319 #ifdef CONFIG_SPL_SATA_SUPPORT
320 { BOOT_DEVICE_SATA, "SATA" },
322 /* Keep this entry last */
323 { BOOT_DEVICE_NONE, "unknown boot device" },
326 static void announce_boot_device(u32 boot_device)
330 puts("Trying to boot from ");
332 #ifdef CONFIG_SPL_BOARD_LOAD_IMAGE
333 if (boot_device == BOOT_DEVICE_BOARD) {
334 spl_board_announce_boot_device();
339 for (i = 0; i < ARRAY_SIZE(boot_name_table) - 1; i++) {
340 if (boot_name_table[i].boot_dev == boot_device)
344 printf("%s\n", boot_name_table[i].name);
347 static inline void announce_boot_device(u32 boot_device) { }
350 static struct spl_image_loader *spl_ll_find_loader(uint boot_device)
352 struct spl_image_loader *drv =
353 ll_entry_start(struct spl_image_loader, spl_image_loader);
355 ll_entry_count(struct spl_image_loader, spl_image_loader);
356 struct spl_image_loader *entry;
358 for (entry = drv; entry != drv + n_ents; entry++) {
359 if (boot_device == entry->boot_device)
367 static int spl_load_image(u32 boot_device)
369 struct spl_boot_device bootdev;
370 struct spl_image_loader *loader = spl_ll_find_loader(boot_device);
372 bootdev.boot_device = boot_device;
373 bootdev.boot_device_name = NULL;
375 return loader->load_image(&bootdev);
377 switch (boot_device) {
378 #ifdef CONFIG_SPL_RAM_DEVICE
379 case BOOT_DEVICE_RAM:
380 return spl_ram_load_image(&bootdev);
382 #ifdef CONFIG_SPL_MMC_SUPPORT
383 case BOOT_DEVICE_MMC1:
384 case BOOT_DEVICE_MMC2:
385 case BOOT_DEVICE_MMC2_2:
386 return spl_mmc_load_image(&bootdev);
388 #ifdef CONFIG_SPL_UBI
389 case BOOT_DEVICE_NAND:
390 case BOOT_DEVICE_ONENAND:
391 return spl_ubi_load_image(&bootdev);
393 #ifdef CONFIG_SPL_NAND_SUPPORT
394 case BOOT_DEVICE_NAND:
395 return spl_nand_load_image(&bootdev);
397 #ifdef CONFIG_SPL_ONENAND_SUPPORT
398 case BOOT_DEVICE_ONENAND:
399 return spl_onenand_load_image(&bootdev);
402 #ifdef CONFIG_SPL_NOR_SUPPORT
403 case BOOT_DEVICE_NOR:
404 return spl_nor_load_image(&bootdev);
406 #ifdef CONFIG_SPL_YMODEM_SUPPORT
407 case BOOT_DEVICE_UART:
408 return spl_ymodem_load_image(&bootdev);
410 #if defined(CONFIG_SPL_SPI_SUPPORT) || defined(CONFIG_SPL_SPI_FLASH_SUPPORT)
411 case BOOT_DEVICE_SPI:
412 return spl_spi_load_image(&bootdev);
414 #ifdef CONFIG_SPL_ETH_SUPPORT
415 case BOOT_DEVICE_CPGMAC:
416 #ifdef CONFIG_SPL_ETH_DEVICE
417 bootdev.boot_device_name = CONFIG_SPL_ETH_DEVICE;
419 return spl_net_load_image(&bootdev);
421 #ifdef CONFIG_SPL_USBETH_SUPPORT
422 case BOOT_DEVICE_USBETH:
423 bootdev.boot_device_name = "usb_ether";
424 return spl_net_load_image(&bootdev);
426 #ifdef CONFIG_SPL_USB_SUPPORT
427 case BOOT_DEVICE_USB:
428 return spl_usb_load_image(&bootdev);
430 #ifdef CONFIG_SPL_DFU_SUPPORT
431 case BOOT_DEVICE_DFU:
432 spl_dfu_cmd(0, "dfu_alt_info_ram", "ram", "0");
433 return spl_ram_load_image(&bootdev);
435 #ifdef CONFIG_SPL_SATA_SUPPORT
436 case BOOT_DEVICE_SATA:
437 return spl_sata_load_image(&bootdev);
439 #ifdef CONFIG_SPL_BOARD_LOAD_IMAGE
440 case BOOT_DEVICE_BOARD:
441 return spl_board_load_image(&bootdev);
444 #if defined(CONFIG_SPL_SERIAL_SUPPORT) && defined(CONFIG_SPL_LIBCOMMON_SUPPORT)
445 puts("SPL: Unsupported Boot Device!\n");
453 void board_init_r(gd_t *dummy1, ulong dummy2)
457 debug(">>spl:board_init_r()\n");
459 #if defined(CONFIG_SYS_SPL_MALLOC_START)
460 mem_malloc_init(CONFIG_SYS_SPL_MALLOC_START,
461 CONFIG_SYS_SPL_MALLOC_SIZE);
462 gd->flags |= GD_FLG_FULL_MALLOC_INIT;
464 if (!(gd->flags & GD_FLG_SPL_INIT)) {
470 * timer_init() does not exist on PPC systems. The timer is initialized
471 * and enabled (decrementer) in interrupt_init() here.
476 #ifdef CONFIG_SPL_BOARD_INIT
480 board_boot_order(spl_boot_list);
481 for (i = 0; i < ARRAY_SIZE(spl_boot_list) &&
482 spl_boot_list[i] != BOOT_DEVICE_NONE; i++) {
483 announce_boot_device(spl_boot_list[i]);
484 if (!spl_load_image(spl_boot_list[i]))
488 if (i == ARRAY_SIZE(spl_boot_list) ||
489 spl_boot_list[i] == BOOT_DEVICE_NONE) {
490 puts("SPL: failed to boot from all boot devices\n");
494 switch (spl_image.os) {
496 debug("Jumping to U-Boot\n");
498 #ifdef CONFIG_SPL_OS_BOOT
500 debug("Jumping to Linux\n");
501 spl_board_prepare_for_linux();
502 jump_to_image_linux(&spl_image,
503 (void *)CONFIG_SYS_SPL_ARGS_ADDR);
506 debug("Unsupported OS image.. Jumping nevertheless..\n");
508 #if defined(CONFIG_SYS_MALLOC_F_LEN) && !defined(CONFIG_SYS_SPL_MALLOC_SIZE)
509 debug("SPL malloc() used %#lx bytes (%ld KB)\n", gd->malloc_ptr,
510 gd->malloc_ptr / 1024);
513 debug("loaded - jumping to U-Boot...");
514 spl_board_prepare_for_boot();
515 jump_to_image_no_args(&spl_image);
519 * This requires UART clocks to be enabled. In order for this to work the
520 * caller must ensure that the gd pointer is valid.
522 void preloader_console_init(void)
525 gd->baudrate = CONFIG_BAUDRATE;
527 serial_init(); /* serial communications setup */
529 gd->have_console = 1;
531 puts("\nU-Boot SPL " PLAIN_VERSION " (" U_BOOT_DATE " - " \
533 #ifdef CONFIG_SPL_DISPLAY_PRINT
539 * spl_relocate_stack_gd() - Relocate stack ready for board_init_r() execution
541 * Sometimes board_init_f() runs with a stack in SRAM but we want to use SDRAM
542 * for the main board_init_r() execution. This is typically because we need
543 * more stack space for things like the MMC sub-system.
545 * This function calculates the stack position, copies the global_data into
546 * place, sets the new gd (except for ARM, for which setting GD within a C
547 * function may not always work) and returns the new stack position. The
548 * caller is responsible for setting up the sp register and, in the case
549 * of ARM, setting up gd.
551 * All of this is done using the same layout and alignments as done in
552 * board_init_f_init_reserve() / board_init_f_alloc_reserve().
554 * @return new stack location, or 0 to use the same stack
556 ulong spl_relocate_stack_gd(void)
558 #ifdef CONFIG_SPL_STACK_R
560 ulong ptr = CONFIG_SPL_STACK_R_ADDR;
562 #ifdef CONFIG_SPL_SYS_MALLOC_SIMPLE
563 if (CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN) {
564 ptr -= CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN;
565 gd->malloc_base = ptr;
566 gd->malloc_limit = CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN;
570 /* Get stack position: use 8-byte alignment for ABI compliance */
571 ptr = CONFIG_SPL_STACK_R_ADDR - roundup(sizeof(gd_t),16);
572 new_gd = (gd_t *)ptr;
573 memcpy(new_gd, (void *)gd, sizeof(gd_t));
574 #if !defined(CONFIG_ARM)