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 void 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();
123 __weak void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image)
125 typedef void __noreturn (*image_entry_noargs_t)(void);
127 image_entry_noargs_t image_entry =
128 (image_entry_noargs_t)(unsigned long)spl_image->entry_point;
130 debug("image entry point: 0x%X\n", spl_image->entry_point);
134 #ifdef CONFIG_SPL_RAM_DEVICE
135 static int spl_ram_load_image(void)
137 const struct image_header *header;
140 * Get the header. It will point to an address defined by handoff
141 * which will tell where the image located inside the flash. For
142 * now, it will temporary fixed to address pointed by U-Boot.
144 header = (struct image_header *)
145 (CONFIG_SYS_TEXT_BASE - sizeof(struct image_header));
147 spl_parse_image_header(header);
157 debug("spl_init()\n");
158 #if defined(CONFIG_SYS_MALLOC_F_LEN)
159 gd->malloc_limit = CONFIG_SYS_MALLOC_F_LEN;
162 if (CONFIG_IS_ENABLED(OF_CONTROL)) {
163 ret = fdtdec_setup();
165 debug("fdtdec_setup() returned error %d\n", ret);
169 if (IS_ENABLED(CONFIG_SPL_DM)) {
170 ret = dm_init_and_scan(true);
172 debug("dm_init_and_scan() returned error %d\n", ret);
176 gd->flags |= GD_FLG_SPL_INIT;
181 void board_init_r(gd_t *dummy1, ulong dummy2)
185 debug(">>spl:board_init_r()\n");
187 #if defined(CONFIG_SYS_SPL_MALLOC_START)
188 mem_malloc_init(CONFIG_SYS_SPL_MALLOC_START,
189 CONFIG_SYS_SPL_MALLOC_SIZE);
190 gd->flags |= GD_FLG_FULL_MALLOC_INIT;
192 if (!(gd->flags & GD_FLG_SPL_INIT)) {
198 * timer_init() does not exist on PPC systems. The timer is initialized
199 * and enabled (decrementer) in interrupt_init() here.
204 #ifdef CONFIG_SPL_BOARD_INIT
208 boot_device = spl_boot_device();
209 debug("boot device - %d\n", boot_device);
210 switch (boot_device) {
211 #ifdef CONFIG_SPL_RAM_DEVICE
212 case BOOT_DEVICE_RAM:
213 if (spl_ram_load_image())
217 #ifdef CONFIG_SPL_MMC_SUPPORT
218 case BOOT_DEVICE_MMC1:
219 case BOOT_DEVICE_MMC2:
220 case BOOT_DEVICE_MMC2_2:
221 if (spl_mmc_load_image())
225 #ifdef CONFIG_SPL_NAND_SUPPORT
226 case BOOT_DEVICE_NAND:
227 if (spl_nand_load_image())
231 #ifdef CONFIG_SPL_ONENAND_SUPPORT
232 case BOOT_DEVICE_ONENAND:
233 if (spl_onenand_load_image())
237 #ifdef CONFIG_SPL_NOR_SUPPORT
238 case BOOT_DEVICE_NOR:
239 if (spl_nor_load_image())
243 #ifdef CONFIG_SPL_YMODEM_SUPPORT
244 case BOOT_DEVICE_UART:
245 if (spl_ymodem_load_image())
249 #ifdef CONFIG_SPL_SPI_SUPPORT
250 case BOOT_DEVICE_SPI:
251 if (spl_spi_load_image())
255 #ifdef CONFIG_SPL_ETH_SUPPORT
256 case BOOT_DEVICE_CPGMAC:
257 #ifdef CONFIG_SPL_ETH_DEVICE
258 if (spl_net_load_image(CONFIG_SPL_ETH_DEVICE))
261 if (spl_net_load_image(NULL))
266 #ifdef CONFIG_SPL_USBETH_SUPPORT
267 case BOOT_DEVICE_USBETH:
268 if (spl_net_load_image("usb_ether"))
272 #ifdef CONFIG_SPL_USB_SUPPORT
273 case BOOT_DEVICE_USB:
274 if (spl_usb_load_image())
278 #ifdef CONFIG_SPL_SATA_SUPPORT
279 case BOOT_DEVICE_SATA:
280 if (spl_sata_load_image())
284 #ifdef CONFIG_SPL_BOARD_LOAD_IMAGE
285 case BOOT_DEVICE_BOARD:
286 if (spl_board_load_image())
291 #if defined(CONFIG_SPL_SERIAL_SUPPORT) && defined(CONFIG_SPL_LIBCOMMON_SUPPORT)
292 puts("SPL: Unsupported Boot Device!\n");
297 switch (spl_image.os) {
299 debug("Jumping to U-Boot\n");
301 #ifdef CONFIG_SPL_OS_BOOT
303 debug("Jumping to Linux\n");
304 spl_board_prepare_for_linux();
305 jump_to_image_linux((void *)CONFIG_SYS_SPL_ARGS_ADDR);
308 debug("Unsupported OS image.. Jumping nevertheless..\n");
310 #if defined(CONFIG_SYS_MALLOC_F_LEN) && !defined(CONFIG_SYS_SPL_MALLOC_SIZE)
311 debug("SPL malloc() used %#lx bytes (%ld KB)\n", gd->malloc_ptr,
312 gd->malloc_ptr / 1024);
315 debug("loaded - jumping to U-Boot...");
316 jump_to_image_no_args(&spl_image);
320 * This requires UART clocks to be enabled. In order for this to work the
321 * caller must ensure that the gd pointer is valid.
323 void preloader_console_init(void)
326 gd->baudrate = CONFIG_BAUDRATE;
328 serial_init(); /* serial communications setup */
330 gd->have_console = 1;
332 puts("\nU-Boot SPL " PLAIN_VERSION " (" U_BOOT_DATE " - " \
334 #ifdef CONFIG_SPL_DISPLAY_PRINT
340 * spl_relocate_stack_gd() - Relocate stack ready for board_init_r() execution
342 * Sometimes board_init_f() runs with a stack in SRAM but we want to use SDRAM
343 * for the main board_init_r() execution. This is typically because we need
344 * more stack space for things like the MMC sub-system.
346 * This function calculates the stack position, copies the global_data into
347 * place and returns the new stack position. The caller is responsible for
348 * setting up the sp register.
350 * @return new stack location, or 0 to use the same stack
352 ulong spl_relocate_stack_gd(void)
354 #ifdef CONFIG_SPL_STACK_R
358 /* Get stack position: use 8-byte alignment for ABI compliance */
359 ptr = CONFIG_SPL_STACK_R_ADDR - sizeof(gd_t);
361 new_gd = (gd_t *)ptr;
362 memcpy(new_gd, (void *)gd, sizeof(gd_t));
365 #ifdef CONFIG_SPL_SYS_MALLOC_SIMPLE
366 if (CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN) {
367 if (!(gd->flags & GD_FLG_SPL_INIT))
368 panic("spl_init must be called before heap reloc");
370 ptr -= CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN;
371 gd->malloc_base = ptr;
372 gd->malloc_limit = CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN;