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%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(struct spl_image_info
*spl_image
,
188 struct spl_boot_device
*bootdev
)
190 struct image_header
*header
;
192 header
= (struct image_header
*)CONFIG_SPL_LOAD_FIT_ADDRESS
;
194 #if defined(CONFIG_SPL_DFU_SUPPORT)
195 if (bootdev
->boot_device
== BOOT_DEVICE_DFU
)
196 spl_dfu_cmd(0, "dfu_alt_info_ram", "ram", "0");
199 if (IS_ENABLED(CONFIG_SPL_LOAD_FIT
) &&
200 image_get_magic(header
) == FDT_MAGIC
) {
201 struct spl_load_info load
;
203 debug("Found FIT\n");
205 load
.read
= spl_ram_load_read
;
206 spl_load_simple_fit(spl_image
, &load
, 0, header
);
208 debug("Legacy image\n");
210 * Get the header. It will point to an address defined by
211 * handoff which will tell where the image located inside
212 * the flash. For now, it will temporary fixed to address
215 header
= (struct image_header
*)
216 (CONFIG_SYS_TEXT_BASE
- sizeof(struct image_header
));
218 spl_parse_image_header(spl_image
, header
);
223 #if defined(CONFIG_SPL_RAM_DEVICE)
224 SPL_LOAD_IMAGE_METHOD(0, BOOT_DEVICE_RAM
, spl_ram_load_image
);
226 #if defined(CONFIG_SPL_DFU_SUPPORT)
227 SPL_LOAD_IMAGE_METHOD(0, BOOT_DEVICE_DFU
, spl_ram_load_image
);
235 debug("spl_init()\n");
236 #if defined(CONFIG_SYS_MALLOC_F_LEN)
237 #ifdef CONFIG_MALLOC_F_ADDR
238 gd
->malloc_base
= CONFIG_MALLOC_F_ADDR
;
240 gd
->malloc_limit
= CONFIG_SYS_MALLOC_F_LEN
;
243 if (CONFIG_IS_ENABLED(OF_CONTROL
) && !CONFIG_IS_ENABLED(OF_PLATDATA
)) {
244 ret
= fdtdec_setup();
246 debug("fdtdec_setup() returned error %d\n", ret
);
250 if (IS_ENABLED(CONFIG_SPL_DM
)) {
251 /* With CONFIG_OF_PLATDATA, bring in all devices */
252 ret
= dm_init_and_scan(!CONFIG_IS_ENABLED(OF_PLATDATA
));
254 debug("dm_init_and_scan() returned error %d\n", ret
);
258 gd
->flags
|= GD_FLG_SPL_INIT
;
263 #ifndef BOOT_DEVICE_NONE
264 #define BOOT_DEVICE_NONE 0xdeadbeef
267 __weak
void board_boot_order(u32
*spl_boot_list
)
269 spl_boot_list
[0] = spl_boot_device();
272 #ifdef CONFIG_SPL_BOARD_LOAD_IMAGE
273 __weak
void spl_board_announce_boot_device(void) { }
276 #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
277 struct boot_device_name
{
282 struct boot_device_name boot_name_table
[] = {
283 #ifdef CONFIG_SPL_RAM_DEVICE
284 { BOOT_DEVICE_RAM
, "RAM" },
286 #ifdef CONFIG_SPL_MMC_SUPPORT
287 { BOOT_DEVICE_MMC1
, "MMC1" },
288 { BOOT_DEVICE_MMC2
, "MMC2" },
289 { BOOT_DEVICE_MMC2_2
, "MMC2_2" },
291 #ifdef CONFIG_SPL_NAND_SUPPORT
292 { BOOT_DEVICE_NAND
, "NAND" },
294 #ifdef CONFIG_SPL_ONENAND_SUPPORT
295 { BOOT_DEVICE_ONENAND
, "OneNAND" },
297 #ifdef CONFIG_SPL_NOR_SUPPORT
298 { BOOT_DEVICE_NOR
, "NOR" },
300 #ifdef CONFIG_SPL_YMODEM_SUPPORT
301 { BOOT_DEVICE_UART
, "UART" },
303 #if defined(CONFIG_SPL_SPI_SUPPORT) || defined(CONFIG_SPL_SPI_FLASH_SUPPORT)
304 { BOOT_DEVICE_SPI
, "SPI" },
306 #ifdef CONFIG_SPL_ETH_SUPPORT
307 #ifdef CONFIG_SPL_ETH_DEVICE
308 { BOOT_DEVICE_CPGMAC
, "eth device" },
310 { BOOT_DEVICE_CPGMAC
, "net" },
313 #ifdef CONFIG_SPL_USBETH_SUPPORT
314 { BOOT_DEVICE_USBETH
, "USB eth" },
316 #ifdef CONFIG_SPL_USB_SUPPORT
317 { BOOT_DEVICE_USB
, "USB" },
319 #ifdef CONFIG_SPL_DFU_SUPPORT
320 { BOOT_DEVICE_DFU
, "USB DFU" },
322 #ifdef CONFIG_SPL_SATA_SUPPORT
323 { BOOT_DEVICE_SATA
, "SATA" },
325 /* Keep this entry last */
326 { BOOT_DEVICE_NONE
, "unknown boot device" },
329 static void announce_boot_device(u32 boot_device
)
333 puts("Trying to boot from ");
335 #ifdef CONFIG_SPL_BOARD_LOAD_IMAGE
336 if (boot_device
== BOOT_DEVICE_BOARD
) {
337 spl_board_announce_boot_device();
342 for (i
= 0; i
< ARRAY_SIZE(boot_name_table
) - 1; i
++) {
343 if (boot_name_table
[i
].boot_dev
== boot_device
)
347 printf("%s\n", boot_name_table
[i
].name
);
350 static inline void announce_boot_device(u32 boot_device
) { }
353 static struct spl_image_loader
*spl_ll_find_loader(uint boot_device
)
355 struct spl_image_loader
*drv
=
356 ll_entry_start(struct spl_image_loader
, spl_image_loader
);
358 ll_entry_count(struct spl_image_loader
, spl_image_loader
);
359 struct spl_image_loader
*entry
;
361 for (entry
= drv
; entry
!= drv
+ n_ents
; entry
++) {
362 if (boot_device
== entry
->boot_device
)
370 static int spl_load_image(struct spl_image_info
*spl_image
, u32 boot_device
)
372 struct spl_boot_device bootdev
;
373 struct spl_image_loader
*loader
= spl_ll_find_loader(boot_device
);
375 bootdev
.boot_device
= boot_device
;
376 bootdev
.boot_device_name
= NULL
;
378 return loader
->load_image(spl_image
, &bootdev
);
380 #if defined(CONFIG_SPL_SERIAL_SUPPORT) && defined(CONFIG_SPL_LIBCOMMON_SUPPORT)
381 puts("SPL: Unsupported Boot Device!\n");
386 void board_init_r(gd_t
*dummy1
, ulong dummy2
)
388 u32 spl_boot_list
[] = {
395 struct spl_image_info spl_image
;
398 debug(">>spl:board_init_r()\n");
400 #if defined(CONFIG_SYS_SPL_MALLOC_START)
401 mem_malloc_init(CONFIG_SYS_SPL_MALLOC_START
,
402 CONFIG_SYS_SPL_MALLOC_SIZE
);
403 gd
->flags
|= GD_FLG_FULL_MALLOC_INIT
;
405 if (!(gd
->flags
& GD_FLG_SPL_INIT
)) {
411 * timer_init() does not exist on PPC systems. The timer is initialized
412 * and enabled (decrementer) in interrupt_init() here.
417 #ifdef CONFIG_SPL_BOARD_INIT
421 memset(&spl_image
, '\0', sizeof(spl_image
));
422 board_boot_order(spl_boot_list
);
423 for (i
= 0; i
< ARRAY_SIZE(spl_boot_list
) &&
424 spl_boot_list
[i
] != BOOT_DEVICE_NONE
; i
++) {
425 announce_boot_device(spl_boot_list
[i
]);
426 if (!spl_load_image(&spl_image
, spl_boot_list
[i
]))
430 if (i
== ARRAY_SIZE(spl_boot_list
) ||
431 spl_boot_list
[i
] == BOOT_DEVICE_NONE
) {
432 puts("SPL: failed to boot from all boot devices\n");
436 switch (spl_image
.os
) {
438 debug("Jumping to U-Boot\n");
440 #ifdef CONFIG_SPL_OS_BOOT
442 debug("Jumping to Linux\n");
443 spl_board_prepare_for_linux();
444 jump_to_image_linux(&spl_image
,
445 (void *)CONFIG_SYS_SPL_ARGS_ADDR
);
448 debug("Unsupported OS image.. Jumping nevertheless..\n");
450 #if defined(CONFIG_SYS_MALLOC_F_LEN) && !defined(CONFIG_SYS_SPL_MALLOC_SIZE)
451 debug("SPL malloc() used %#lx bytes (%ld KB)\n", gd
->malloc_ptr
,
452 gd
->malloc_ptr
/ 1024);
455 debug("loaded - jumping to U-Boot...");
456 spl_board_prepare_for_boot();
457 jump_to_image_no_args(&spl_image
);
461 * This requires UART clocks to be enabled. In order for this to work the
462 * caller must ensure that the gd pointer is valid.
464 void preloader_console_init(void)
467 gd
->baudrate
= CONFIG_BAUDRATE
;
469 serial_init(); /* serial communications setup */
471 gd
->have_console
= 1;
473 puts("\nU-Boot SPL " PLAIN_VERSION
" (" U_BOOT_DATE
" - " \
475 #ifdef CONFIG_SPL_DISPLAY_PRINT
481 * spl_relocate_stack_gd() - Relocate stack ready for board_init_r() execution
483 * Sometimes board_init_f() runs with a stack in SRAM but we want to use SDRAM
484 * for the main board_init_r() execution. This is typically because we need
485 * more stack space for things like the MMC sub-system.
487 * This function calculates the stack position, copies the global_data into
488 * place, sets the new gd (except for ARM, for which setting GD within a C
489 * function may not always work) and returns the new stack position. The
490 * caller is responsible for setting up the sp register and, in the case
491 * of ARM, setting up gd.
493 * All of this is done using the same layout and alignments as done in
494 * board_init_f_init_reserve() / board_init_f_alloc_reserve().
496 * @return new stack location, or 0 to use the same stack
498 ulong
spl_relocate_stack_gd(void)
500 #ifdef CONFIG_SPL_STACK_R
502 ulong ptr
= CONFIG_SPL_STACK_R_ADDR
;
504 #ifdef CONFIG_SPL_SYS_MALLOC_SIMPLE
505 if (CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN
) {
506 ptr
-= CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN
;
507 gd
->malloc_base
= ptr
;
508 gd
->malloc_limit
= CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN
;
512 /* Get stack position: use 8-byte alignment for ABI compliance */
513 ptr
= CONFIG_SPL_STACK_R_ADDR
- roundup(sizeof(gd_t
),16);
514 new_gd
= (gd_t
*)ptr
;
515 memcpy(new_gd
, (void *)gd
, sizeof(gd_t
));
516 #if !defined(CONFIG_ARM)