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;
33 /* Define board data structure */
34 static bd_t bdata __attribute__ ((section(".data")));
37 * Board-specific Platform code can reimplement show_boot_progress () if needed
39 __weak void show_boot_progress(int val) {}
42 * Default function to determine if u-boot or the OS should
43 * be started. This implementation always returns 1.
45 * Please implement your own board specific funcion to do this.
48 * 0 to not start u-boot
49 * positive if u-boot should start
51 #ifdef CONFIG_SPL_OS_BOOT
52 __weak int spl_start_uboot(void)
54 puts("SPL: Please implement spl_start_uboot() for your board\n");
55 puts("SPL: Direct Linux boot not active!\n");
60 * Weak default function for arch specific zImage check. Return zero
61 * and fill start and end address if image is recognized.
63 int __weak bootz_setup(ulong image, ulong *start, ulong *end)
70 * Weak default function for board specific cleanup/preparation before
71 * Linux boot. Some boards/platforms might not need it, so just provide
74 __weak void spl_board_prepare_for_linux(void)
79 __weak void spl_board_prepare_for_boot(void)
84 void spl_set_header_raw_uboot(struct spl_image_info *spl_image)
86 spl_image->size = CONFIG_SYS_MONITOR_LEN;
87 spl_image->entry_point = CONFIG_SYS_UBOOT_START;
88 spl_image->load_addr = CONFIG_SYS_TEXT_BASE;
89 spl_image->os = IH_OS_U_BOOT;
90 spl_image->name = "U-Boot";
93 int spl_parse_image_header(struct spl_image_info *spl_image,
94 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%lx 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%lx 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)spl_image->entry_point;
169 debug("image entry point: 0x%lX\n", spl_image->entry_point);
173 static int spl_common_init(bool setup_malloc)
177 debug("spl_early_init()\n");
179 #if defined(CONFIG_SYS_MALLOC_F_LEN)
181 #ifdef CONFIG_MALLOC_F_ADDR
182 gd->malloc_base = CONFIG_MALLOC_F_ADDR;
184 gd->malloc_limit = CONFIG_SYS_MALLOC_F_LEN;
188 if (CONFIG_IS_ENABLED(OF_CONTROL) && !CONFIG_IS_ENABLED(OF_PLATDATA)) {
189 ret = fdtdec_setup();
191 debug("fdtdec_setup() returned error %d\n", ret);
195 if (IS_ENABLED(CONFIG_SPL_DM)) {
196 /* With CONFIG_SPL_OF_PLATDATA, bring in all devices */
197 ret = dm_init_and_scan(!CONFIG_IS_ENABLED(OF_PLATDATA));
199 debug("dm_init_and_scan() returned error %d\n", ret);
207 int spl_early_init(void)
211 ret = spl_common_init(true);
214 gd->flags |= GD_FLG_SPL_EARLY_INIT;
223 if (!(gd->flags & GD_FLG_SPL_EARLY_INIT)) {
224 ret = spl_common_init(
225 !IS_ENABLED(CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN));
229 gd->flags |= GD_FLG_SPL_INIT;
234 #ifndef BOOT_DEVICE_NONE
235 #define BOOT_DEVICE_NONE 0xdeadbeef
238 __weak void board_boot_order(u32 *spl_boot_list)
240 spl_boot_list[0] = spl_boot_device();
243 static struct spl_image_loader *spl_ll_find_loader(uint boot_device)
245 struct spl_image_loader *drv =
246 ll_entry_start(struct spl_image_loader, spl_image_loader);
248 ll_entry_count(struct spl_image_loader, spl_image_loader);
249 struct spl_image_loader *entry;
251 for (entry = drv; entry != drv + n_ents; entry++) {
252 if (boot_device == entry->boot_device)
260 static int spl_load_image(struct spl_image_info *spl_image,
261 struct spl_image_loader *loader)
263 struct spl_boot_device bootdev;
265 bootdev.boot_device = loader->boot_device;
266 bootdev.boot_device_name = NULL;
268 return loader->load_image(spl_image, &bootdev);
272 * boot_from_devices() - Try loading an booting U-Boot from a list of devices
274 * @spl_image: Place to put the image details if successful
275 * @spl_boot_list: List of boot devices to try
276 * @count: Number of elements in spl_boot_list
277 * @return 0 if OK, -ve on error
279 static int boot_from_devices(struct spl_image_info *spl_image,
280 u32 spl_boot_list[], int count)
284 for (i = 0; i < count && spl_boot_list[i] != BOOT_DEVICE_NONE; i++) {
285 struct spl_image_loader *loader;
287 loader = spl_ll_find_loader(spl_boot_list[i]);
288 #if defined(CONFIG_SPL_SERIAL_SUPPORT) && defined(CONFIG_SPL_LIBCOMMON_SUPPORT)
290 printf("Trying to boot from %s\n", loader->name);
292 puts("SPL: Unsupported Boot Device!\n");
294 if (loader && !spl_load_image(spl_image, loader))
301 void board_init_r(gd_t *dummy1, ulong dummy2)
303 u32 spl_boot_list[] = {
310 struct spl_image_info spl_image;
312 debug(">>spl:board_init_r()\n");
314 #if defined(CONFIG_SYS_SPL_MALLOC_START)
315 mem_malloc_init(CONFIG_SYS_SPL_MALLOC_START,
316 CONFIG_SYS_SPL_MALLOC_SIZE);
317 gd->flags |= GD_FLG_FULL_MALLOC_INIT;
319 if (!(gd->flags & GD_FLG_SPL_INIT)) {
325 * timer_init() does not exist on PPC systems. The timer is initialized
326 * and enabled (decrementer) in interrupt_init() here.
331 #ifdef CONFIG_SPL_BOARD_INIT
335 memset(&spl_image, '\0', sizeof(spl_image));
336 board_boot_order(spl_boot_list);
338 if (boot_from_devices(&spl_image, spl_boot_list,
339 ARRAY_SIZE(spl_boot_list))) {
340 puts("SPL: failed to boot from all boot devices\n");
344 switch (spl_image.os) {
346 debug("Jumping to U-Boot\n");
348 #ifdef CONFIG_SPL_OS_BOOT
350 debug("Jumping to Linux\n");
351 spl_board_prepare_for_linux();
352 jump_to_image_linux(&spl_image,
353 (void *)CONFIG_SYS_SPL_ARGS_ADDR);
356 debug("Unsupported OS image.. Jumping nevertheless..\n");
358 #if defined(CONFIG_SYS_MALLOC_F_LEN) && !defined(CONFIG_SYS_SPL_MALLOC_SIZE)
359 debug("SPL malloc() used %#lx bytes (%ld KB)\n", gd->malloc_ptr,
360 gd->malloc_ptr / 1024);
363 debug("loaded - jumping to U-Boot...\n");
364 spl_board_prepare_for_boot();
365 jump_to_image_no_args(&spl_image);
369 * This requires UART clocks to be enabled. In order for this to work the
370 * caller must ensure that the gd pointer is valid.
372 void preloader_console_init(void)
375 gd->baudrate = CONFIG_BAUDRATE;
377 serial_init(); /* serial communications setup */
379 gd->have_console = 1;
381 puts("\nU-Boot SPL " PLAIN_VERSION " (" U_BOOT_DATE " - " \
383 #ifdef CONFIG_SPL_DISPLAY_PRINT
389 * spl_relocate_stack_gd() - Relocate stack ready for board_init_r() execution
391 * Sometimes board_init_f() runs with a stack in SRAM but we want to use SDRAM
392 * for the main board_init_r() execution. This is typically because we need
393 * more stack space for things like the MMC sub-system.
395 * This function calculates the stack position, copies the global_data into
396 * place, sets the new gd (except for ARM, for which setting GD within a C
397 * function may not always work) and returns the new stack position. The
398 * caller is responsible for setting up the sp register and, in the case
399 * of ARM, setting up gd.
401 * All of this is done using the same layout and alignments as done in
402 * board_init_f_init_reserve() / board_init_f_alloc_reserve().
404 * @return new stack location, or 0 to use the same stack
406 ulong spl_relocate_stack_gd(void)
408 #ifdef CONFIG_SPL_STACK_R
410 ulong ptr = CONFIG_SPL_STACK_R_ADDR;
412 #ifdef CONFIG_SPL_SYS_MALLOC_SIMPLE
413 if (CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN) {
414 ptr -= CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN;
415 gd->malloc_base = ptr;
416 gd->malloc_limit = CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN;
420 /* Get stack position: use 8-byte alignment for ABI compliance */
421 ptr = CONFIG_SPL_STACK_R_ADDR - roundup(sizeof(gd_t),16);
422 new_gd = (gd_t *)ptr;
423 memcpy(new_gd, (void *)gd, sizeof(gd_t));
424 #if CONFIG_IS_ENABLED(DM)
425 dm_fixup_for_gd_move(new_gd);
427 #if !defined(CONFIG_ARM)