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(const struct image_header *header)
96 u32 header_size = sizeof(struct image_header);
98 if (image_get_magic(header) == IH_MAGIC) {
99 if (spl_image.flags & SPL_COPY_PAYLOAD_ONLY) {
101 * On some system (e.g. powerpc), the load-address and
102 * entry-point is located at address 0. We can't load
103 * to 0-0x40. So skip header in this case.
105 spl_image.load_addr = image_get_load(header);
106 spl_image.entry_point = image_get_ep(header);
107 spl_image.size = image_get_data_size(header);
109 spl_image.entry_point = image_get_load(header);
110 /* Load including the header */
111 spl_image.load_addr = spl_image.entry_point -
113 spl_image.size = image_get_data_size(header) +
116 spl_image.os = image_get_os(header);
117 spl_image.name = image_get_name(header);
118 debug("spl: payload image: %.*s load addr: 0x%x size: %d\n",
119 (int)sizeof(spl_image.name), spl_image.name,
120 spl_image.load_addr, spl_image.size);
122 #ifdef CONFIG_SPL_PANIC_ON_RAW_IMAGE
124 * CONFIG_SPL_PANIC_ON_RAW_IMAGE is defined when the
125 * code which loads images in SPL cannot guarantee that
126 * absolutely all read errors will be reported.
127 * An example is the LPC32XX MLC NAND driver, which
128 * will consider that a completely unreadable NAND block
129 * is bad, and thus should be skipped silently.
131 panic("** no mkimage signature but raw image not supported");
134 #ifdef CONFIG_SPL_OS_BOOT
137 if (!bootz_setup((ulong)header, &start, &end)) {
138 spl_image.name = "Linux";
139 spl_image.os = IH_OS_LINUX;
140 spl_image.load_addr = CONFIG_SYS_LOAD_ADDR;
141 spl_image.entry_point = CONFIG_SYS_LOAD_ADDR;
142 spl_image.size = end - start;
143 debug("spl: payload zImage, load addr: 0x%x size: %d\n",
144 spl_image.load_addr, spl_image.size);
149 #ifdef CONFIG_SPL_ABORT_ON_RAW_IMAGE
150 /* Signature not found, proceed to other boot methods. */
153 /* Signature not found - assume u-boot.bin */
154 debug("mkimage signature not found - ih_magic = %x\n",
156 spl_set_header_raw_uboot(&spl_image);
162 __weak void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image)
164 typedef void __noreturn (*image_entry_noargs_t)(void);
166 image_entry_noargs_t image_entry =
167 (image_entry_noargs_t)(unsigned long)spl_image->entry_point;
169 debug("image entry point: 0x%X\n", spl_image->entry_point);
173 #ifndef CONFIG_SPL_LOAD_FIT_ADDRESS
174 # define CONFIG_SPL_LOAD_FIT_ADDRESS 0
177 #if defined(CONFIG_SPL_RAM_DEVICE) || defined(CONFIG_SPL_DFU_SUPPORT)
178 static ulong spl_ram_load_read(struct spl_load_info *load, ulong sector,
179 ulong count, void *buf)
181 debug("%s: sector %lx, count %lx, buf %lx\n",
182 __func__, sector, count, (ulong)buf);
183 memcpy(buf, (void *)(CONFIG_SPL_LOAD_FIT_ADDRESS + sector), count);
187 static int spl_ram_load_image(void)
189 struct image_header *header;
191 header = (struct image_header *)CONFIG_SPL_LOAD_FIT_ADDRESS;
193 if (IS_ENABLED(CONFIG_SPL_LOAD_FIT) &&
194 image_get_magic(header) == FDT_MAGIC) {
195 struct spl_load_info load;
197 debug("Found FIT\n");
199 load.read = spl_ram_load_read;
200 spl_load_simple_fit(&load, 0, header);
202 debug("Legacy image\n");
204 * Get the header. It will point to an address defined by
205 * handoff which will tell where the image located inside
206 * the flash. For now, it will temporary fixed to address
209 header = (struct image_header *)
210 (CONFIG_SYS_TEXT_BASE - sizeof(struct image_header));
212 spl_parse_image_header(header);
223 debug("spl_init()\n");
224 #if defined(CONFIG_SYS_MALLOC_F_LEN)
225 #ifdef CONFIG_MALLOC_F_ADDR
226 gd->malloc_base = CONFIG_MALLOC_F_ADDR;
228 gd->malloc_limit = CONFIG_SYS_MALLOC_F_LEN;
231 if (CONFIG_IS_ENABLED(OF_CONTROL) && !CONFIG_IS_ENABLED(OF_PLATDATA)) {
232 ret = fdtdec_setup();
234 debug("fdtdec_setup() returned error %d\n", ret);
238 if (IS_ENABLED(CONFIG_SPL_DM)) {
239 /* With CONFIG_OF_PLATDATA, bring in all devices */
240 ret = dm_init_and_scan(!CONFIG_IS_ENABLED(OF_PLATDATA));
242 debug("dm_init_and_scan() returned error %d\n", ret);
246 gd->flags |= GD_FLG_SPL_INIT;
251 #ifndef BOOT_DEVICE_NONE
252 #define BOOT_DEVICE_NONE 0xdeadbeef
255 static u32 spl_boot_list[] = {
263 __weak void board_boot_order(u32 *spl_boot_list)
265 spl_boot_list[0] = spl_boot_device();
268 #ifdef CONFIG_SPL_BOARD_LOAD_IMAGE
269 __weak void spl_board_announce_boot_device(void) { }
272 #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
273 struct boot_device_name {
278 struct boot_device_name boot_name_table[] = {
279 #ifdef CONFIG_SPL_RAM_DEVICE
280 { BOOT_DEVICE_RAM, "RAM" },
282 #ifdef CONFIG_SPL_MMC_SUPPORT
283 { BOOT_DEVICE_MMC1, "MMC1" },
284 { BOOT_DEVICE_MMC2, "MMC2" },
285 { BOOT_DEVICE_MMC2_2, "MMC2_2" },
287 #ifdef CONFIG_SPL_NAND_SUPPORT
288 { BOOT_DEVICE_NAND, "NAND" },
290 #ifdef CONFIG_SPL_ONENAND_SUPPORT
291 { BOOT_DEVICE_ONENAND, "OneNAND" },
293 #ifdef CONFIG_SPL_NOR_SUPPORT
294 { BOOT_DEVICE_NOR, "NOR" },
296 #ifdef CONFIG_SPL_YMODEM_SUPPORT
297 { BOOT_DEVICE_UART, "UART" },
299 #if defined(CONFIG_SPL_SPI_SUPPORT) || defined(CONFIG_SPL_SPI_FLASH_SUPPORT)
300 { BOOT_DEVICE_SPI, "SPI" },
302 #ifdef CONFIG_SPL_ETH_SUPPORT
303 #ifdef CONFIG_SPL_ETH_DEVICE
304 { BOOT_DEVICE_CPGMAC, "eth device" },
306 { BOOT_DEVICE_CPGMAC, "net" },
309 #ifdef CONFIG_SPL_USBETH_SUPPORT
310 { BOOT_DEVICE_USBETH, "USB eth" },
312 #ifdef CONFIG_SPL_USB_SUPPORT
313 { BOOT_DEVICE_USB, "USB" },
315 #ifdef CONFIG_SPL_DFU_SUPPORT
316 { BOOT_DEVICE_DFU, "USB DFU" },
318 #ifdef CONFIG_SPL_SATA_SUPPORT
319 { BOOT_DEVICE_SATA, "SATA" },
321 /* Keep this entry last */
322 { BOOT_DEVICE_NONE, "unknown boot device" },
325 static void announce_boot_device(u32 boot_device)
329 puts("Trying to boot from ");
331 #ifdef CONFIG_SPL_BOARD_LOAD_IMAGE
332 if (boot_device == BOOT_DEVICE_BOARD) {
333 spl_board_announce_boot_device();
338 for (i = 0; i < ARRAY_SIZE(boot_name_table) - 1; i++) {
339 if (boot_name_table[i].boot_dev == boot_device)
343 printf("%s\n", boot_name_table[i].name);
346 static inline void announce_boot_device(u32 boot_device) { }
349 static int spl_load_image(u32 boot_device)
351 switch (boot_device) {
352 #ifdef CONFIG_SPL_RAM_DEVICE
353 case BOOT_DEVICE_RAM:
354 return spl_ram_load_image();
356 #ifdef CONFIG_SPL_MMC_SUPPORT
357 case BOOT_DEVICE_MMC1:
358 case BOOT_DEVICE_MMC2:
359 case BOOT_DEVICE_MMC2_2:
360 return spl_mmc_load_image(boot_device);
362 #ifdef CONFIG_SPL_UBI
363 case BOOT_DEVICE_NAND:
364 case BOOT_DEVICE_ONENAND:
365 return spl_ubi_load_image(boot_device);
367 #ifdef CONFIG_SPL_NAND_SUPPORT
368 case BOOT_DEVICE_NAND:
369 return spl_nand_load_image();
371 #ifdef CONFIG_SPL_ONENAND_SUPPORT
372 case BOOT_DEVICE_ONENAND:
373 return spl_onenand_load_image();
376 #ifdef CONFIG_SPL_NOR_SUPPORT
377 case BOOT_DEVICE_NOR:
378 return spl_nor_load_image();
380 #ifdef CONFIG_SPL_YMODEM_SUPPORT
381 case BOOT_DEVICE_UART:
382 return spl_ymodem_load_image();
384 #if defined(CONFIG_SPL_SPI_SUPPORT) || defined(CONFIG_SPL_SPI_FLASH_SUPPORT)
385 case BOOT_DEVICE_SPI:
386 return spl_spi_load_image();
388 #ifdef CONFIG_SPL_ETH_SUPPORT
389 case BOOT_DEVICE_CPGMAC:
390 #ifdef CONFIG_SPL_ETH_DEVICE
391 return spl_net_load_image(CONFIG_SPL_ETH_DEVICE);
393 return spl_net_load_image(NULL);
396 #ifdef CONFIG_SPL_USBETH_SUPPORT
397 case BOOT_DEVICE_USBETH:
398 return spl_net_load_image("usb_ether");
400 #ifdef CONFIG_SPL_USB_SUPPORT
401 case BOOT_DEVICE_USB:
402 return spl_usb_load_image();
404 #ifdef CONFIG_SPL_DFU_SUPPORT
405 case BOOT_DEVICE_DFU:
406 spl_dfu_cmd(0, "dfu_alt_info_ram", "ram", "0");
407 return spl_ram_load_image();
409 #ifdef CONFIG_SPL_SATA_SUPPORT
410 case BOOT_DEVICE_SATA:
411 return spl_sata_load_image();
413 #ifdef CONFIG_SPL_BOARD_LOAD_IMAGE
414 case BOOT_DEVICE_BOARD:
415 return spl_board_load_image();
418 #if defined(CONFIG_SPL_SERIAL_SUPPORT) && defined(CONFIG_SPL_LIBCOMMON_SUPPORT)
419 puts("SPL: Unsupported Boot Device!\n");
427 void board_init_r(gd_t *dummy1, ulong dummy2)
431 debug(">>spl:board_init_r()\n");
433 #if defined(CONFIG_SYS_SPL_MALLOC_START)
434 mem_malloc_init(CONFIG_SYS_SPL_MALLOC_START,
435 CONFIG_SYS_SPL_MALLOC_SIZE);
436 gd->flags |= GD_FLG_FULL_MALLOC_INIT;
438 if (!(gd->flags & GD_FLG_SPL_INIT)) {
444 * timer_init() does not exist on PPC systems. The timer is initialized
445 * and enabled (decrementer) in interrupt_init() here.
450 #ifdef CONFIG_SPL_BOARD_INIT
454 board_boot_order(spl_boot_list);
455 for (i = 0; i < ARRAY_SIZE(spl_boot_list) &&
456 spl_boot_list[i] != BOOT_DEVICE_NONE; i++) {
457 announce_boot_device(spl_boot_list[i]);
458 if (!spl_load_image(spl_boot_list[i]))
462 if (i == ARRAY_SIZE(spl_boot_list) ||
463 spl_boot_list[i] == BOOT_DEVICE_NONE) {
464 puts("SPL: failed to boot from all boot devices\n");
468 switch (spl_image.os) {
470 debug("Jumping to U-Boot\n");
472 #ifdef CONFIG_SPL_OS_BOOT
474 debug("Jumping to Linux\n");
475 spl_board_prepare_for_linux();
476 jump_to_image_linux((void *)CONFIG_SYS_SPL_ARGS_ADDR);
479 debug("Unsupported OS image.. Jumping nevertheless..\n");
481 #if defined(CONFIG_SYS_MALLOC_F_LEN) && !defined(CONFIG_SYS_SPL_MALLOC_SIZE)
482 debug("SPL malloc() used %#lx bytes (%ld KB)\n", gd->malloc_ptr,
483 gd->malloc_ptr / 1024);
486 debug("loaded - jumping to U-Boot...");
487 spl_board_prepare_for_boot();
488 jump_to_image_no_args(&spl_image);
492 * This requires UART clocks to be enabled. In order for this to work the
493 * caller must ensure that the gd pointer is valid.
495 void preloader_console_init(void)
498 gd->baudrate = CONFIG_BAUDRATE;
500 serial_init(); /* serial communications setup */
502 gd->have_console = 1;
504 puts("\nU-Boot SPL " PLAIN_VERSION " (" U_BOOT_DATE " - " \
506 #ifdef CONFIG_SPL_DISPLAY_PRINT
512 * spl_relocate_stack_gd() - Relocate stack ready for board_init_r() execution
514 * Sometimes board_init_f() runs with a stack in SRAM but we want to use SDRAM
515 * for the main board_init_r() execution. This is typically because we need
516 * more stack space for things like the MMC sub-system.
518 * This function calculates the stack position, copies the global_data into
519 * place, sets the new gd (except for ARM, for which setting GD within a C
520 * function may not always work) and returns the new stack position. The
521 * caller is responsible for setting up the sp register and, in the case
522 * of ARM, setting up gd.
524 * All of this is done using the same layout and alignments as done in
525 * board_init_f_init_reserve() / board_init_f_alloc_reserve().
527 * @return new stack location, or 0 to use the same stack
529 ulong spl_relocate_stack_gd(void)
531 #ifdef CONFIG_SPL_STACK_R
533 ulong ptr = CONFIG_SPL_STACK_R_ADDR;
535 #ifdef CONFIG_SPL_SYS_MALLOC_SIMPLE
536 if (CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN) {
537 ptr -= CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN;
538 gd->malloc_base = ptr;
539 gd->malloc_limit = CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN;
543 /* Get stack position: use 8-byte alignment for ABI compliance */
544 ptr = CONFIG_SPL_STACK_R_ADDR - roundup(sizeof(gd_t),16);
545 new_gd = (gd_t *)ptr;
546 memcpy(new_gd, (void *)gd, sizeof(gd_t));
547 #if !defined(CONFIG_ARM)