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 __weak
void spl_board_prepare_for_boot(void)
72 void spl_set_header_raw_uboot(void)
74 spl_image
.size
= CONFIG_SYS_MONITOR_LEN
;
75 spl_image
.entry_point
= CONFIG_SYS_UBOOT_START
;
76 spl_image
.load_addr
= CONFIG_SYS_TEXT_BASE
;
77 spl_image
.os
= IH_OS_U_BOOT
;
78 spl_image
.name
= "U-Boot";
81 int spl_parse_image_header(const struct image_header
*header
)
83 u32 header_size
= sizeof(struct image_header
);
85 if (image_get_magic(header
) == IH_MAGIC
) {
86 if (spl_image
.flags
& SPL_COPY_PAYLOAD_ONLY
) {
88 * On some system (e.g. powerpc), the load-address and
89 * entry-point is located at address 0. We can't load
90 * to 0-0x40. So skip header in this case.
92 spl_image
.load_addr
= image_get_load(header
);
93 spl_image
.entry_point
= image_get_ep(header
);
94 spl_image
.size
= image_get_data_size(header
);
96 spl_image
.entry_point
= image_get_load(header
);
97 /* Load including the header */
98 spl_image
.load_addr
= spl_image
.entry_point
-
100 spl_image
.size
= image_get_data_size(header
) +
103 spl_image
.os
= image_get_os(header
);
104 spl_image
.name
= image_get_name(header
);
105 debug("spl: payload image: %.*s load addr: 0x%x size: %d\n",
106 (int)sizeof(spl_image
.name
), spl_image
.name
,
107 spl_image
.load_addr
, spl_image
.size
);
109 #ifdef CONFIG_SPL_PANIC_ON_RAW_IMAGE
111 * CONFIG_SPL_PANIC_ON_RAW_IMAGE is defined when the
112 * code which loads images in SPL cannot guarantee that
113 * absolutely all read errors will be reported.
114 * An example is the LPC32XX MLC NAND driver, which
115 * will consider that a completely unreadable NAND block
116 * is bad, and thus should be skipped silently.
118 panic("** no mkimage signature but raw image not supported");
119 #elif defined(CONFIG_SPL_ABORT_ON_RAW_IMAGE)
120 /* Signature not found, proceed to other boot methods. */
123 /* Signature not found - assume u-boot.bin */
124 debug("mkimage signature not found - ih_magic = %x\n",
126 spl_set_header_raw_uboot();
132 __weak
void __noreturn
jump_to_image_no_args(struct spl_image_info
*spl_image
)
134 typedef void __noreturn (*image_entry_noargs_t
)(void);
136 image_entry_noargs_t image_entry
=
137 (image_entry_noargs_t
)(unsigned long)spl_image
->entry_point
;
139 debug("image entry point: 0x%X\n", spl_image
->entry_point
);
143 #ifndef CONFIG_SPL_LOAD_FIT_ADDRESS
144 # define CONFIG_SPL_LOAD_FIT_ADDRESS 0
147 #ifdef CONFIG_SPL_RAM_DEVICE
148 static ulong
spl_ram_load_read(struct spl_load_info
*load
, ulong sector
,
149 ulong count
, void *buf
)
151 debug("%s: sector %lx, count %lx, buf %lx\n",
152 __func__
, sector
, count
, (ulong
)buf
);
153 memcpy(buf
, (void *)(CONFIG_SPL_LOAD_FIT_ADDRESS
+ sector
), count
);
157 static int spl_ram_load_image(void)
159 struct image_header
*header
;
161 header
= (struct image_header
*)CONFIG_SPL_LOAD_FIT_ADDRESS
;
163 if (IS_ENABLED(CONFIG_SPL_LOAD_FIT
) &&
164 image_get_magic(header
) == FDT_MAGIC
) {
165 struct spl_load_info load
;
167 debug("Found FIT\n");
169 load
.read
= spl_ram_load_read
;
170 spl_load_simple_fit(&load
, 0, header
);
172 debug("Legacy image\n");
174 * Get the header. It will point to an address defined by
175 * handoff which will tell where the image located inside
176 * the flash. For now, it will temporary fixed to address
179 header
= (struct image_header
*)
180 (CONFIG_SYS_TEXT_BASE
- sizeof(struct image_header
));
182 spl_parse_image_header(header
);
193 debug("spl_init()\n");
194 #if defined(CONFIG_SYS_MALLOC_F_LEN)
195 #ifdef CONFIG_MALLOC_F_ADDR
196 gd
->malloc_base
= CONFIG_MALLOC_F_ADDR
;
198 gd
->malloc_limit
= CONFIG_SYS_MALLOC_F_LEN
;
201 if (CONFIG_IS_ENABLED(OF_CONTROL
)) {
202 ret
= fdtdec_setup();
204 debug("fdtdec_setup() returned error %d\n", ret
);
208 if (IS_ENABLED(CONFIG_SPL_DM
)) {
209 ret
= dm_init_and_scan(true);
211 debug("dm_init_and_scan() returned error %d\n", ret
);
215 gd
->flags
|= GD_FLG_SPL_INIT
;
220 #ifndef BOOT_DEVICE_NONE
221 #define BOOT_DEVICE_NONE 0xdeadbeef
224 static u32 spl_boot_list
[] = {
232 __weak
void board_boot_order(u32
*spl_boot_list
)
234 spl_boot_list
[0] = spl_boot_device();
237 #ifdef CONFIG_SPL_BOARD_LOAD_IMAGE
238 __weak
void spl_board_announce_boot_device(void) { }
241 #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
242 struct boot_device_name
{
247 struct boot_device_name boot_name_table
[] = {
248 #ifdef CONFIG_SPL_RAM_DEVICE
249 { BOOT_DEVICE_RAM
, "RAM" },
251 #ifdef CONFIG_SPL_MMC_SUPPORT
252 { BOOT_DEVICE_MMC1
, "MMC1" },
253 { BOOT_DEVICE_MMC2
, "MMC2" },
254 { BOOT_DEVICE_MMC2_2
, "MMC2_2" },
256 #ifdef CONFIG_SPL_NAND_SUPPORT
257 { BOOT_DEVICE_NAND
, "NAND" },
259 #ifdef CONFIG_SPL_ONENAND_SUPPORT
260 { BOOT_DEVICE_ONENAND
, "OneNAND" },
262 #ifdef CONFIG_SPL_NOR_SUPPORT
263 { BOOT_DEVICE_NOR
, "NOR" },
265 #ifdef CONFIG_SPL_YMODEM_SUPPORT
266 { BOOT_DEVICE_UART
, "UART" },
268 #ifdef CONFIG_SPL_SPI_SUPPORT
269 { BOOT_DEVICE_SPI
, "SPI" },
271 #ifdef CONFIG_SPL_ETH_SUPPORT
272 #ifdef CONFIG_SPL_ETH_DEVICE
273 { BOOT_DEVICE_CPGMAC
, "eth device" },
275 { BOOT_DEVICE_CPGMAC
, "net" },
278 #ifdef CONFIG_SPL_USBETH_SUPPORT
279 { BOOT_DEVICE_USBETH
, "USB eth" },
281 #ifdef CONFIG_SPL_USB_SUPPORT
282 { BOOT_DEVICE_USB
, "USB" },
284 #ifdef CONFIG_SPL_SATA_SUPPORT
285 { BOOT_DEVICE_SATA
, "SATA" },
287 /* Keep this entry last */
288 { BOOT_DEVICE_NONE
, "unknown boot device" },
291 static void announce_boot_device(u32 boot_device
)
295 puts("Trying to boot from ");
297 #ifdef CONFIG_SPL_BOARD_LOAD_IMAGE
298 if (boot_device
== BOOT_DEVICE_BOARD
) {
299 spl_board_announce_boot_device();
304 for (i
= 0; i
< ARRAY_SIZE(boot_name_table
) - 1; i
++) {
305 if (boot_name_table
[i
].boot_dev
== boot_device
)
309 printf("%s\n", boot_name_table
[i
].name
);
312 static inline void announce_boot_device(u32 boot_device
) { }
315 static int spl_load_image(u32 boot_device
)
317 switch (boot_device
) {
318 #ifdef CONFIG_SPL_RAM_DEVICE
319 case BOOT_DEVICE_RAM
:
320 return spl_ram_load_image();
322 #ifdef CONFIG_SPL_MMC_SUPPORT
323 case BOOT_DEVICE_MMC1
:
324 case BOOT_DEVICE_MMC2
:
325 case BOOT_DEVICE_MMC2_2
:
326 return spl_mmc_load_image(boot_device
);
328 #ifdef CONFIG_SPL_NAND_SUPPORT
329 case BOOT_DEVICE_NAND
:
330 return spl_nand_load_image();
332 #ifdef CONFIG_SPL_ONENAND_SUPPORT
333 case BOOT_DEVICE_ONENAND
:
334 return spl_onenand_load_image();
336 #ifdef CONFIG_SPL_NOR_SUPPORT
337 case BOOT_DEVICE_NOR
:
338 return spl_nor_load_image();
340 #ifdef CONFIG_SPL_YMODEM_SUPPORT
341 case BOOT_DEVICE_UART
:
342 return spl_ymodem_load_image();
344 #ifdef CONFIG_SPL_SPI_SUPPORT
345 case BOOT_DEVICE_SPI
:
346 return spl_spi_load_image();
348 #ifdef CONFIG_SPL_ETH_SUPPORT
349 case BOOT_DEVICE_CPGMAC
:
350 #ifdef CONFIG_SPL_ETH_DEVICE
351 return spl_net_load_image(CONFIG_SPL_ETH_DEVICE
);
353 return spl_net_load_image(NULL
);
356 #ifdef CONFIG_SPL_USBETH_SUPPORT
357 case BOOT_DEVICE_USBETH
:
358 return spl_net_load_image("usb_ether");
360 #ifdef CONFIG_SPL_USB_SUPPORT
361 case BOOT_DEVICE_USB
:
362 return spl_usb_load_image();
364 #ifdef CONFIG_SPL_SATA_SUPPORT
365 case BOOT_DEVICE_SATA
:
366 return spl_sata_load_image();
368 #ifdef CONFIG_SPL_BOARD_LOAD_IMAGE
369 case BOOT_DEVICE_BOARD
:
370 return spl_board_load_image();
373 #if defined(CONFIG_SPL_SERIAL_SUPPORT) && defined(CONFIG_SPL_LIBCOMMON_SUPPORT)
374 puts("SPL: Unsupported Boot Device!\n");
382 void board_init_r(gd_t
*dummy1
, ulong dummy2
)
386 debug(">>spl:board_init_r()\n");
388 #if defined(CONFIG_SYS_SPL_MALLOC_START)
389 mem_malloc_init(CONFIG_SYS_SPL_MALLOC_START
,
390 CONFIG_SYS_SPL_MALLOC_SIZE
);
391 gd
->flags
|= GD_FLG_FULL_MALLOC_INIT
;
393 if (!(gd
->flags
& GD_FLG_SPL_INIT
)) {
399 * timer_init() does not exist on PPC systems. The timer is initialized
400 * and enabled (decrementer) in interrupt_init() here.
405 #ifdef CONFIG_SPL_BOARD_INIT
409 board_boot_order(spl_boot_list
);
410 for (i
= 0; i
< ARRAY_SIZE(spl_boot_list
) &&
411 spl_boot_list
[i
] != BOOT_DEVICE_NONE
; i
++) {
412 announce_boot_device(spl_boot_list
[i
]);
413 if (!spl_load_image(spl_boot_list
[i
]))
417 if (i
== ARRAY_SIZE(spl_boot_list
) ||
418 spl_boot_list
[i
] == BOOT_DEVICE_NONE
) {
419 puts("SPL: failed to boot from all boot devices\n");
423 switch (spl_image
.os
) {
425 debug("Jumping to U-Boot\n");
427 #ifdef CONFIG_SPL_OS_BOOT
429 debug("Jumping to Linux\n");
430 spl_board_prepare_for_linux();
431 jump_to_image_linux((void *)CONFIG_SYS_SPL_ARGS_ADDR
);
434 debug("Unsupported OS image.. Jumping nevertheless..\n");
436 #if defined(CONFIG_SYS_MALLOC_F_LEN) && !defined(CONFIG_SYS_SPL_MALLOC_SIZE)
437 debug("SPL malloc() used %#lx bytes (%ld KB)\n", gd
->malloc_ptr
,
438 gd
->malloc_ptr
/ 1024);
441 debug("loaded - jumping to U-Boot...");
442 spl_board_prepare_for_boot();
443 jump_to_image_no_args(&spl_image
);
447 * This requires UART clocks to be enabled. In order for this to work the
448 * caller must ensure that the gd pointer is valid.
450 void preloader_console_init(void)
453 gd
->baudrate
= CONFIG_BAUDRATE
;
455 serial_init(); /* serial communications setup */
457 gd
->have_console
= 1;
459 puts("\nU-Boot SPL " PLAIN_VERSION
" (" U_BOOT_DATE
" - " \
461 #ifdef CONFIG_SPL_DISPLAY_PRINT
467 * spl_relocate_stack_gd() - Relocate stack ready for board_init_r() execution
469 * Sometimes board_init_f() runs with a stack in SRAM but we want to use SDRAM
470 * for the main board_init_r() execution. This is typically because we need
471 * more stack space for things like the MMC sub-system.
473 * This function calculates the stack position, copies the global_data into
474 * place, sets the new gd (except for ARM, for which setting GD within a C
475 * function may not always work) and returns the new stack position. The
476 * caller is responsible for setting up the sp register and, in the case
477 * of ARM, setting up gd.
479 * All of this is done using the same layout and alignments as done in
480 * board_init_f_init_reserve() / board_init_f_alloc_reserve().
482 * @return new stack location, or 0 to use the same stack
484 ulong
spl_relocate_stack_gd(void)
486 #ifdef CONFIG_SPL_STACK_R
488 ulong ptr
= CONFIG_SPL_STACK_R_ADDR
;
490 #ifdef CONFIG_SPL_SYS_MALLOC_SIMPLE
491 if (CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN
) {
492 if (!(gd
->flags
& GD_FLG_SPL_INIT
))
493 panic_str("spl_init must be called before heap reloc");
495 ptr
-= CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN
;
496 gd
->malloc_base
= ptr
;
497 gd
->malloc_limit
= CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN
;
501 /* Get stack position: use 8-byte alignment for ABI compliance */
502 ptr
= CONFIG_SPL_STACK_R_ADDR
- roundup(sizeof(gd_t
),16);
503 new_gd
= (gd_t
*)ptr
;
504 memcpy(new_gd
, (void *)gd
, sizeof(gd_t
));
505 #if !defined(CONFIG_ARM)