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 * Board-specific Platform code can reimplement show_boot_progress () if needed
41 __weak
void show_boot_progress(int val
) {}
44 * Default function to determine if u-boot or the OS should
45 * be started. This implementation always returns 1.
47 * Please implement your own board specific funcion to do this.
50 * 0 to not start u-boot
51 * positive if u-boot should start
53 #ifdef CONFIG_SPL_OS_BOOT
54 __weak
int spl_start_uboot(void)
56 puts("SPL: Please implement spl_start_uboot() for your board\n");
57 puts("SPL: Direct Linux boot not active!\n");
63 * Weak default function for board specific cleanup/preparation before
64 * Linux boot. Some boards/platforms might not need it, so just provide
67 __weak
void spl_board_prepare_for_linux(void)
72 __weak
void spl_board_prepare_for_boot(void)
77 void spl_set_header_raw_uboot(void)
79 spl_image
.size
= CONFIG_SYS_MONITOR_LEN
;
80 spl_image
.entry_point
= CONFIG_SYS_UBOOT_START
;
81 spl_image
.load_addr
= CONFIG_SYS_TEXT_BASE
;
82 spl_image
.os
= IH_OS_U_BOOT
;
83 spl_image
.name
= "U-Boot";
86 int spl_parse_image_header(const struct image_header
*header
)
88 u32 header_size
= sizeof(struct image_header
);
90 if (image_get_magic(header
) == IH_MAGIC
) {
91 if (spl_image
.flags
& SPL_COPY_PAYLOAD_ONLY
) {
93 * On some system (e.g. powerpc), the load-address and
94 * entry-point is located at address 0. We can't load
95 * to 0-0x40. So skip header in this case.
97 spl_image
.load_addr
= image_get_load(header
);
98 spl_image
.entry_point
= image_get_ep(header
);
99 spl_image
.size
= image_get_data_size(header
);
101 spl_image
.entry_point
= image_get_load(header
);
102 /* Load including the header */
103 spl_image
.load_addr
= spl_image
.entry_point
-
105 spl_image
.size
= image_get_data_size(header
) +
108 spl_image
.os
= image_get_os(header
);
109 spl_image
.name
= image_get_name(header
);
110 debug("spl: payload image: %.*s load addr: 0x%x size: %d\n",
111 (int)sizeof(spl_image
.name
), spl_image
.name
,
112 spl_image
.load_addr
, spl_image
.size
);
114 #ifdef CONFIG_SPL_PANIC_ON_RAW_IMAGE
116 * CONFIG_SPL_PANIC_ON_RAW_IMAGE is defined when the
117 * code which loads images in SPL cannot guarantee that
118 * absolutely all read errors will be reported.
119 * An example is the LPC32XX MLC NAND driver, which
120 * will consider that a completely unreadable NAND block
121 * is bad, and thus should be skipped silently.
123 panic("** no mkimage signature but raw image not supported");
124 #elif defined(CONFIG_SPL_ABORT_ON_RAW_IMAGE)
125 /* Signature not found, proceed to other boot methods. */
128 /* Signature not found - assume u-boot.bin */
129 debug("mkimage signature not found - ih_magic = %x\n",
131 spl_set_header_raw_uboot();
137 __weak
void __noreturn
jump_to_image_no_args(struct spl_image_info
*spl_image
)
139 typedef void __noreturn (*image_entry_noargs_t
)(void);
141 image_entry_noargs_t image_entry
=
142 (image_entry_noargs_t
)(unsigned long)spl_image
->entry_point
;
144 debug("image entry point: 0x%X\n", spl_image
->entry_point
);
148 #ifndef CONFIG_SPL_LOAD_FIT_ADDRESS
149 # define CONFIG_SPL_LOAD_FIT_ADDRESS 0
152 #ifdef CONFIG_SPL_RAM_DEVICE
153 static ulong
spl_ram_load_read(struct spl_load_info
*load
, ulong sector
,
154 ulong count
, void *buf
)
156 debug("%s: sector %lx, count %lx, buf %lx\n",
157 __func__
, sector
, count
, (ulong
)buf
);
158 memcpy(buf
, (void *)(CONFIG_SPL_LOAD_FIT_ADDRESS
+ sector
), count
);
162 static int spl_ram_load_image(void)
164 struct image_header
*header
;
166 header
= (struct image_header
*)CONFIG_SPL_LOAD_FIT_ADDRESS
;
168 if (IS_ENABLED(CONFIG_SPL_LOAD_FIT
) &&
169 image_get_magic(header
) == FDT_MAGIC
) {
170 struct spl_load_info load
;
172 debug("Found FIT\n");
174 load
.read
= spl_ram_load_read
;
175 spl_load_simple_fit(&load
, 0, header
);
177 debug("Legacy image\n");
179 * Get the header. It will point to an address defined by
180 * handoff which will tell where the image located inside
181 * the flash. For now, it will temporary fixed to address
184 header
= (struct image_header
*)
185 (CONFIG_SYS_TEXT_BASE
- sizeof(struct image_header
));
187 spl_parse_image_header(header
);
198 debug("spl_init()\n");
199 #if defined(CONFIG_SYS_MALLOC_F_LEN)
200 #ifdef CONFIG_MALLOC_F_ADDR
201 gd
->malloc_base
= CONFIG_MALLOC_F_ADDR
;
203 gd
->malloc_limit
= CONFIG_SYS_MALLOC_F_LEN
;
206 if (CONFIG_IS_ENABLED(OF_CONTROL
)) {
207 ret
= fdtdec_setup();
209 debug("fdtdec_setup() returned error %d\n", ret
);
213 if (IS_ENABLED(CONFIG_SPL_DM
)) {
214 ret
= dm_init_and_scan(true);
216 debug("dm_init_and_scan() returned error %d\n", ret
);
220 gd
->flags
|= GD_FLG_SPL_INIT
;
225 #ifndef BOOT_DEVICE_NONE
226 #define BOOT_DEVICE_NONE 0xdeadbeef
229 static u32 spl_boot_list
[] = {
237 __weak
void board_boot_order(u32
*spl_boot_list
)
239 spl_boot_list
[0] = spl_boot_device();
242 #ifdef CONFIG_SPL_BOARD_LOAD_IMAGE
243 __weak
void spl_board_announce_boot_device(void) { }
246 #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
247 struct boot_device_name
{
252 struct boot_device_name boot_name_table
[] = {
253 #ifdef CONFIG_SPL_RAM_DEVICE
254 { BOOT_DEVICE_RAM
, "RAM" },
256 #ifdef CONFIG_SPL_MMC_SUPPORT
257 { BOOT_DEVICE_MMC1
, "MMC1" },
258 { BOOT_DEVICE_MMC2
, "MMC2" },
259 { BOOT_DEVICE_MMC2_2
, "MMC2_2" },
261 #ifdef CONFIG_SPL_NAND_SUPPORT
262 { BOOT_DEVICE_NAND
, "NAND" },
264 #ifdef CONFIG_SPL_ONENAND_SUPPORT
265 { BOOT_DEVICE_ONENAND
, "OneNAND" },
267 #ifdef CONFIG_SPL_NOR_SUPPORT
268 { BOOT_DEVICE_NOR
, "NOR" },
270 #ifdef CONFIG_SPL_YMODEM_SUPPORT
271 { BOOT_DEVICE_UART
, "UART" },
273 #ifdef CONFIG_SPL_SPI_SUPPORT
274 { BOOT_DEVICE_SPI
, "SPI" },
276 #ifdef CONFIG_SPL_ETH_SUPPORT
277 #ifdef CONFIG_SPL_ETH_DEVICE
278 { BOOT_DEVICE_CPGMAC
, "eth device" },
280 { BOOT_DEVICE_CPGMAC
, "net" },
283 #ifdef CONFIG_SPL_USBETH_SUPPORT
284 { BOOT_DEVICE_USBETH
, "USB eth" },
286 #ifdef CONFIG_SPL_USB_SUPPORT
287 { BOOT_DEVICE_USB
, "USB" },
289 #ifdef CONFIG_SPL_SATA_SUPPORT
290 { BOOT_DEVICE_SATA
, "SATA" },
292 /* Keep this entry last */
293 { BOOT_DEVICE_NONE
, "unknown boot device" },
296 static void announce_boot_device(u32 boot_device
)
300 puts("Trying to boot from ");
302 #ifdef CONFIG_SPL_BOARD_LOAD_IMAGE
303 if (boot_device
== BOOT_DEVICE_BOARD
) {
304 spl_board_announce_boot_device();
309 for (i
= 0; i
< ARRAY_SIZE(boot_name_table
) - 1; i
++) {
310 if (boot_name_table
[i
].boot_dev
== boot_device
)
314 printf("%s\n", boot_name_table
[i
].name
);
317 static inline void announce_boot_device(u32 boot_device
) { }
320 static int spl_load_image(u32 boot_device
)
322 switch (boot_device
) {
323 #ifdef CONFIG_SPL_RAM_DEVICE
324 case BOOT_DEVICE_RAM
:
325 return spl_ram_load_image();
327 #ifdef CONFIG_SPL_MMC_SUPPORT
328 case BOOT_DEVICE_MMC1
:
329 case BOOT_DEVICE_MMC2
:
330 case BOOT_DEVICE_MMC2_2
:
331 return spl_mmc_load_image(boot_device
);
333 #ifdef CONFIG_SPL_NAND_SUPPORT
334 case BOOT_DEVICE_NAND
:
335 return spl_nand_load_image();
337 #ifdef CONFIG_SPL_ONENAND_SUPPORT
338 case BOOT_DEVICE_ONENAND
:
339 return spl_onenand_load_image();
341 #ifdef CONFIG_SPL_NOR_SUPPORT
342 case BOOT_DEVICE_NOR
:
343 return spl_nor_load_image();
345 #ifdef CONFIG_SPL_YMODEM_SUPPORT
346 case BOOT_DEVICE_UART
:
347 return spl_ymodem_load_image();
349 #ifdef CONFIG_SPL_SPI_SUPPORT
350 case BOOT_DEVICE_SPI
:
351 return spl_spi_load_image();
353 #ifdef CONFIG_SPL_ETH_SUPPORT
354 case BOOT_DEVICE_CPGMAC
:
355 #ifdef CONFIG_SPL_ETH_DEVICE
356 return spl_net_load_image(CONFIG_SPL_ETH_DEVICE
);
358 return spl_net_load_image(NULL
);
361 #ifdef CONFIG_SPL_USBETH_SUPPORT
362 case BOOT_DEVICE_USBETH
:
363 return spl_net_load_image("usb_ether");
365 #ifdef CONFIG_SPL_USB_SUPPORT
366 case BOOT_DEVICE_USB
:
367 return spl_usb_load_image();
369 #ifdef CONFIG_SPL_SATA_SUPPORT
370 case BOOT_DEVICE_SATA
:
371 return spl_sata_load_image();
373 #ifdef CONFIG_SPL_BOARD_LOAD_IMAGE
374 case BOOT_DEVICE_BOARD
:
375 return spl_board_load_image();
378 #if defined(CONFIG_SPL_SERIAL_SUPPORT) && defined(CONFIG_SPL_LIBCOMMON_SUPPORT)
379 puts("SPL: Unsupported Boot Device!\n");
387 void board_init_r(gd_t
*dummy1
, ulong dummy2
)
391 debug(">>spl:board_init_r()\n");
393 #if defined(CONFIG_SYS_SPL_MALLOC_START)
394 mem_malloc_init(CONFIG_SYS_SPL_MALLOC_START
,
395 CONFIG_SYS_SPL_MALLOC_SIZE
);
396 gd
->flags
|= GD_FLG_FULL_MALLOC_INIT
;
398 if (!(gd
->flags
& GD_FLG_SPL_INIT
)) {
404 * timer_init() does not exist on PPC systems. The timer is initialized
405 * and enabled (decrementer) in interrupt_init() here.
410 #ifdef CONFIG_SPL_BOARD_INIT
414 board_boot_order(spl_boot_list
);
415 for (i
= 0; i
< ARRAY_SIZE(spl_boot_list
) &&
416 spl_boot_list
[i
] != BOOT_DEVICE_NONE
; i
++) {
417 announce_boot_device(spl_boot_list
[i
]);
418 if (!spl_load_image(spl_boot_list
[i
]))
422 if (i
== ARRAY_SIZE(spl_boot_list
) ||
423 spl_boot_list
[i
] == BOOT_DEVICE_NONE
) {
424 puts("SPL: failed to boot from all boot devices\n");
428 switch (spl_image
.os
) {
430 debug("Jumping to U-Boot\n");
432 #ifdef CONFIG_SPL_OS_BOOT
434 debug("Jumping to Linux\n");
435 spl_board_prepare_for_linux();
436 jump_to_image_linux((void *)CONFIG_SYS_SPL_ARGS_ADDR
);
439 debug("Unsupported OS image.. Jumping nevertheless..\n");
441 #if defined(CONFIG_SYS_MALLOC_F_LEN) && !defined(CONFIG_SYS_SPL_MALLOC_SIZE)
442 debug("SPL malloc() used %#lx bytes (%ld KB)\n", gd
->malloc_ptr
,
443 gd
->malloc_ptr
/ 1024);
446 debug("loaded - jumping to U-Boot...");
447 spl_board_prepare_for_boot();
448 jump_to_image_no_args(&spl_image
);
452 * This requires UART clocks to be enabled. In order for this to work the
453 * caller must ensure that the gd pointer is valid.
455 void preloader_console_init(void)
458 gd
->baudrate
= CONFIG_BAUDRATE
;
460 serial_init(); /* serial communications setup */
462 gd
->have_console
= 1;
464 puts("\nU-Boot SPL " PLAIN_VERSION
" (" U_BOOT_DATE
" - " \
466 #ifdef CONFIG_SPL_DISPLAY_PRINT
472 * spl_relocate_stack_gd() - Relocate stack ready for board_init_r() execution
474 * Sometimes board_init_f() runs with a stack in SRAM but we want to use SDRAM
475 * for the main board_init_r() execution. This is typically because we need
476 * more stack space for things like the MMC sub-system.
478 * This function calculates the stack position, copies the global_data into
479 * place, sets the new gd (except for ARM, for which setting GD within a C
480 * function may not always work) and returns the new stack position. The
481 * caller is responsible for setting up the sp register and, in the case
482 * of ARM, setting up gd.
484 * All of this is done using the same layout and alignments as done in
485 * board_init_f_init_reserve() / board_init_f_alloc_reserve().
487 * @return new stack location, or 0 to use the same stack
489 ulong
spl_relocate_stack_gd(void)
491 #ifdef CONFIG_SPL_STACK_R
493 ulong ptr
= CONFIG_SPL_STACK_R_ADDR
;
495 #ifdef CONFIG_SPL_SYS_MALLOC_SIMPLE
496 if (CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN
) {
497 ptr
-= CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN
;
498 gd
->malloc_base
= ptr
;
499 gd
->malloc_limit
= CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN
;
503 /* Get stack position: use 8-byte alignment for ABI compliance */
504 ptr
= CONFIG_SPL_STACK_R_ADDR
- roundup(sizeof(gd_t
),16);
505 new_gd
= (gd_t
*)ptr
;
506 memcpy(new_gd
, (void *)gd
, sizeof(gd_t
));
507 #if !defined(CONFIG_ARM)