blob: 1ceb63daf3183809fc98f23d967545190ca00616 [file] [log] [blame]
Tom Rini83d290c2018-05-06 17:58:06 -04001// SPDX-License-Identifier: GPL-2.0+
Aneesh Vbcae7212011-07-21 09:10:21 -04002/*
3 * (C) Copyright 2010
4 * Texas Instruments, <www.ti.com>
5 *
6 * Aneesh V <aneesh@ti.com>
Aneesh Vbcae7212011-07-21 09:10:21 -04007 */
Philipp Tomsichf1c6e192017-06-30 19:02:53 +02008
Tom Rini03de3052024-05-20 13:35:03 -06009#include <config.h>
Simon Glasse945a722018-11-15 18:43:51 -070010#include <bloblist.h>
Simon Glass8bee2d22017-11-13 18:55:03 -070011#include <binman_sym.h>
Simon Glass52f24232020-05-10 11:40:00 -060012#include <bootstage.h>
Simon Glass11516512014-11-10 17:16:46 -070013#include <dm.h>
Simon Glassb0edea32018-11-15 18:44:09 -070014#include <handoff.h>
Simon Glassdb41d652019-12-28 10:45:07 -070015#include <hang.h>
Simon Glass691d7192020-05-10 11:40:02 -060016#include <init.h>
Simon Glassc30b7ad2019-11-14 12:57:41 -070017#include <irq_func.h>
Simon Glassf7ae49f2020-05-10 11:40:05 -060018#include <log.h>
Simon Glass891d9e82021-03-07 17:35:14 -070019#include <mapmem.h>
Simon Glassb03e0512019-11-14 12:57:24 -070020#include <serial.h>
Tom Rini47f7bca2012-08-13 12:03:19 -070021#include <spl.h>
Sean Anderson77507412023-11-08 11:48:47 -050022#include <spl_load.h>
Tom Rini10f6e4d2022-05-27 12:48:32 -040023#include <system-constants.h>
Simon Glass401d1c42020-10-30 21:38:53 -060024#include <asm/global_data.h>
Eddie James1d99e672022-02-07 17:09:01 -060025#include <asm-generic/gpio.h>
Simon Schwarzbb085b82011-09-14 15:29:26 -040026#include <nand.h>
Aneesh V8cf686e2011-07-21 09:10:27 -040027#include <fat.h>
Simon Glass3db71102019-11-14 12:57:16 -070028#include <u-boot/crc.h>
Pali Rohár121a1652021-08-02 15:18:38 +020029#if CONFIG_IS_ENABLED(BANNER_PRINT)
30#include <timestamp.h>
31#endif
Simon Glassefb21722011-10-10 08:55:19 +000032#include <version.h>
Aneesh V8cf686e2011-07-21 09:10:27 -040033#include <image.h>
Aneesh V2d01dd92011-10-21 12:29:34 -040034#include <malloc.h>
Simon Glass31f9f0e2019-10-21 17:26:52 -060035#include <mapmem.h>
Simon Glass11516512014-11-10 17:16:46 -070036#include <dm/root.h>
Simon Glass4f6500a2022-05-08 04:39:27 -060037#include <dm/util.h>
Nikhil M Jain7a17e4c2023-04-10 14:19:13 +053038#include <dm/device-internal.h>
39#include <dm/uclass-internal.h>
Andreas Müller761ca312012-01-04 15:26:24 +000040#include <linux/compiler.h>
B, Ravi6e7585b2017-04-18 17:27:27 +053041#include <fdt_support.h>
Lukasz Majewskia8be2492018-05-02 16:10:54 +020042#include <bootcount.h>
Stefan Roese06985282019-04-11 15:58:44 +020043#include <wdt.h>
Devarsh Thakkar1d3c2662023-12-05 21:25:16 +053044#include <video.h>
Aneesh Vbcae7212011-07-21 09:10:21 -040045
46DECLARE_GLOBAL_DATA_PTR;
Alper Nebi Yasak367ecbf2022-06-18 15:13:11 +030047DECLARE_BINMAN_MAGIC_SYM;
Aneesh Vbcae7212011-07-21 09:10:21 -040048
Tom Rini47f7bca2012-08-13 12:03:19 -070049u32 *boot_params_ptr = NULL;
Simon Schwarz9ea5c6e2011-09-14 15:33:34 -040050
Alper Nebi Yasakd8830cf2022-06-18 15:13:09 +030051#if CONFIG_IS_ENABLED(BINMAN_UBOOT_SYMBOLS)
Simon Glass8bee2d22017-11-13 18:55:03 -070052/* See spl.h for information about this */
Simon Glassdbf6be92018-08-01 15:22:42 -060053binman_sym_declare(ulong, u_boot_any, image_pos);
Simon Glasse82c6242019-12-08 17:40:12 -070054binman_sym_declare(ulong, u_boot_any, size);
55
56#ifdef CONFIG_TPL
Simon Glass2b8d2cc2022-10-20 18:22:41 -060057binman_sym_declare(ulong, u_boot_spl_any, image_pos);
58binman_sym_declare(ulong, u_boot_spl_any, size);
Simon Glasse82c6242019-12-08 17:40:12 -070059#endif
Simon Glass8bee2d22017-11-13 18:55:03 -070060
Simon Glassf86ca5a2022-04-30 00:56:52 -060061#ifdef CONFIG_VPL
Simon Glass2b8d2cc2022-10-20 18:22:41 -060062binman_sym_declare(ulong, u_boot_vpl_any, image_pos);
63binman_sym_declare(ulong, u_boot_vpl_any, size);
Simon Glassf86ca5a2022-04-30 00:56:52 -060064#endif
65
Alper Nebi Yasakd8830cf2022-06-18 15:13:09 +030066#endif /* BINMAN_UBOOT_SYMBOLS */
67
Alexandru Gagniuc58b504e2021-04-08 11:56:11 -050068/* Define board data structure */
69static struct bd_info bdata __attribute__ ((section(".data")));
70
Marek Vasutb55881d2021-10-23 03:06:03 +020071#if CONFIG_IS_ENABLED(SHOW_BOOT_PROGRESS)
Simon Schwarz379c19a2012-03-15 04:01:38 +000072/*
Heiko Schocher496c5482016-06-07 08:31:20 +020073 * Board-specific Platform code can reimplement show_boot_progress () if needed
74 */
75__weak void show_boot_progress(int val) {}
Tom Rinicb80ff22021-05-03 16:48:58 -040076#endif
Heiko Schocher496c5482016-06-07 08:31:20 +020077
Heiko Stuebnera343b4f2020-05-25 19:57:25 +020078#if defined(CONFIG_SPL_OS_BOOT) || CONFIG_IS_ENABLED(HANDOFF) || \
79 defined(CONFIG_SPL_ATF)
Simon Glassb0edea32018-11-15 18:44:09 -070080/* weak, default platform-specific function to initialize dram banks */
81__weak int dram_init_banksize(void)
82{
83 return 0;
84}
85#endif
86
Heiko Schocher496c5482016-06-07 08:31:20 +020087/*
Simon Schwarz379c19a2012-03-15 04:01:38 +000088 * Default function to determine if u-boot or the OS should
89 * be started. This implementation always returns 1.
90 *
91 * Please implement your own board specific funcion to do this.
92 *
93 * RETURN
94 * 0 to not start u-boot
95 * positive if u-boot should start
96 */
Tom Rini71150072021-10-30 23:03:48 -040097#if CONFIG_IS_ENABLED(OS_BOOT)
Simon Schwarz379c19a2012-03-15 04:01:38 +000098__weak int spl_start_uboot(void)
99{
Simon Glass96ed5b02024-09-29 19:49:55 -0600100 puts(PHASE_PROMPT
Simon Glassd6330062018-11-15 18:43:56 -0700101 "Please implement spl_start_uboot() for your board\n");
Simon Glass96ed5b02024-09-29 19:49:55 -0600102 puts(PHASE_PROMPT "Direct Linux boot not active!\n");
Simon Schwarz379c19a2012-03-15 04:01:38 +0000103 return 1;
104}
Ladislav Michl431889d2016-07-12 20:28:14 +0200105
106/*
107 * Weak default function for arch specific zImage check. Return zero
108 * and fill start and end address if image is recognized.
109 */
110int __weak bootz_setup(ulong image, ulong *start, ulong *end)
111{
112 return 1;
113}
Nathan Barrett-Morrison7a0d8802022-02-02 15:05:18 -0500114
115int __weak booti_setup(ulong image, ulong *relocated_addr, ulong *size, bool force_reloc)
116{
117 return 1;
118}
Simon Schwarz379c19a2012-03-15 04:01:38 +0000119#endif
120
Philipp Tomsichde5dd4c2018-05-24 17:15:50 +0200121/* Weak default function for arch/board-specific fixups to the spl_image_info */
122void __weak spl_perform_fixups(struct spl_image_info *spl_image)
123{
124}
125
Heiko Stuebnera343b4f2020-05-25 19:57:25 +0200126void spl_fixup_fdt(void *fdt_blob)
B, Ravi6e7585b2017-04-18 17:27:27 +0530127{
Heiko Stuebnera343b4f2020-05-25 19:57:25 +0200128#if defined(CONFIG_SPL_OF_LIBFDT)
B, Ravi6e7585b2017-04-18 17:27:27 +0530129 int err;
130
Heiko Stuebnera343b4f2020-05-25 19:57:25 +0200131 if (!fdt_blob)
132 return;
133
B, Ravi6e7585b2017-04-18 17:27:27 +0530134 err = fdt_check_header(fdt_blob);
135 if (err < 0) {
136 printf("fdt_root: %s\n", fdt_strerror(err));
137 return;
138 }
139
140 /* fixup the memory dt node */
141 err = fdt_shrink_to_minimum(fdt_blob, 0);
142 if (err == 0) {
Simon Glass96ed5b02024-09-29 19:49:55 -0600143 printf(PHASE_PROMPT "fdt_shrink_to_minimum err - %d\n", err);
B, Ravi6e7585b2017-04-18 17:27:27 +0530144 return;
145 }
146
147 err = arch_fixup_fdt(fdt_blob);
148 if (err) {
Simon Glass96ed5b02024-09-29 19:49:55 -0600149 printf(PHASE_PROMPT "arch_fixup_fdt err - %d\n", err);
B, Ravi6e7585b2017-04-18 17:27:27 +0530150 return;
151 }
152#endif
153}
154
Devarsh Thakkar1d3c2662023-12-05 21:25:16 +0530155int spl_reserve_video_from_ram_top(void)
156{
157 if (CONFIG_IS_ENABLED(VIDEO)) {
158 ulong addr;
159 int ret;
160
161 addr = gd->ram_top;
162 ret = video_reserve(&addr);
163 if (ret)
164 return ret;
165 debug("Reserving %luk for video at: %08lx\n",
166 ((unsigned long)gd->relocaddr - addr) >> 10, addr);
167 gd->relocaddr = addr;
168 }
169
170 return 0;
171}
172
Simon Glasse82c6242019-12-08 17:40:12 -0700173ulong spl_get_image_pos(void)
174{
Alper Nebi Yasakd8830cf2022-06-18 15:13:09 +0300175 if (!CONFIG_IS_ENABLED(BINMAN_UBOOT_SYMBOLS))
Alper Nebi Yasakd7f07172022-06-18 15:13:06 +0300176 return BINMAN_SYM_MISSING;
177
Simon Glassf86ca5a2022-04-30 00:56:52 -0600178#ifdef CONFIG_VPL
Simon Glass6c49fc52024-09-29 19:49:39 -0600179 if (xpl_next_phase() == PHASE_VPL)
Simon Glass2b8d2cc2022-10-20 18:22:41 -0600180 return binman_sym(ulong, u_boot_vpl_any, image_pos);
Simon Glassf86ca5a2022-04-30 00:56:52 -0600181#endif
Simon Glass6c49fc52024-09-29 19:49:39 -0600182 return xpl_next_phase() == PHASE_SPL ?
Simon Glass2b8d2cc2022-10-20 18:22:41 -0600183 binman_sym(ulong, u_boot_spl_any, image_pos) :
Simon Glasse82c6242019-12-08 17:40:12 -0700184 binman_sym(ulong, u_boot_any, image_pos);
185}
186
187ulong spl_get_image_size(void)
188{
Alper Nebi Yasakd8830cf2022-06-18 15:13:09 +0300189 if (!CONFIG_IS_ENABLED(BINMAN_UBOOT_SYMBOLS))
Alper Nebi Yasakd7f07172022-06-18 15:13:06 +0300190 return BINMAN_SYM_MISSING;
191
Simon Glassf86ca5a2022-04-30 00:56:52 -0600192#ifdef CONFIG_VPL
Simon Glass6c49fc52024-09-29 19:49:39 -0600193 if (xpl_next_phase() == PHASE_VPL)
Simon Glass2b8d2cc2022-10-20 18:22:41 -0600194 return binman_sym(ulong, u_boot_vpl_any, size);
Simon Glassf86ca5a2022-04-30 00:56:52 -0600195#endif
Simon Glass6c49fc52024-09-29 19:49:39 -0600196 return xpl_next_phase() == PHASE_SPL ?
Simon Glass2b8d2cc2022-10-20 18:22:41 -0600197 binman_sym(ulong, u_boot_spl_any, size) :
Simon Glasse82c6242019-12-08 17:40:12 -0700198 binman_sym(ulong, u_boot_any, size);
199}
200
Simon Glass86c372a2021-01-24 10:06:03 -0700201ulong spl_get_image_text_base(void)
202{
Simon Glassf86ca5a2022-04-30 00:56:52 -0600203#ifdef CONFIG_VPL
Simon Glass6c49fc52024-09-29 19:49:39 -0600204 if (xpl_next_phase() == PHASE_VPL)
Simon Glassf86ca5a2022-04-30 00:56:52 -0600205 return CONFIG_VPL_TEXT_BASE;
206#endif
Simon Glass6c49fc52024-09-29 19:49:39 -0600207 return xpl_next_phase() == PHASE_SPL ? CONFIG_SPL_TEXT_BASE :
Simon Glass98463902022-10-20 18:22:39 -0600208 CONFIG_TEXT_BASE;
Simon Glass86c372a2021-01-24 10:06:03 -0700209}
210
Stefan Roeseea8256f2012-08-23 08:34:21 +0200211/*
212 * Weak default function for board specific cleanup/preparation before
213 * Linux boot. Some boards/platforms might not need it, so just provide
214 * an empty stub here.
215 */
216__weak void spl_board_prepare_for_linux(void)
217{
218 /* Nothing to do! */
219}
220
Alexandru Gagniuca25d6b62021-07-15 14:19:24 -0500221__weak void spl_board_prepare_for_optee(void *fdt)
222{
223}
224
Heiko Thieryc5922922022-01-17 16:25:41 +0100225__weak const char *spl_board_loader_name(u32 boot_device)
226{
227 return NULL;
228}
229
Ricardo Salveti949eb222021-10-20 15:12:06 +0300230#if CONFIG_IS_ENABLED(OPTEE_IMAGE)
231__weak void __noreturn jump_to_image_optee(struct spl_image_info *spl_image)
232{
233 spl_optee_entry(NULL, NULL, spl_image->fdt_addr,
234 (void *)spl_image->entry_point);
235}
236#endif
237
Michal Simek3a3b9142016-05-10 07:54:20 +0200238__weak void spl_board_prepare_for_boot(void)
239{
240 /* Nothing to do! */
241}
242
Simon Glassf3543e62022-09-06 20:26:52 -0600243__weak struct legacy_img_hdr *spl_get_load_buffer(ssize_t offset, size_t size)
Marek Vasut04ce5422018-08-14 11:27:02 +0200244{
Simon Glass98463902022-10-20 18:22:39 -0600245 return map_sysmem(CONFIG_TEXT_BASE + offset, 0);
Marek Vasut04ce5422018-08-14 11:27:02 +0200246}
247
Simon Glassd95ceb92016-09-24 18:19:52 -0600248void spl_set_header_raw_uboot(struct spl_image_info *spl_image)
Heiko Schocher0c3117b2014-10-31 08:31:00 +0100249{
Alper Nebi Yasakd7f07172022-06-18 15:13:06 +0300250 ulong u_boot_pos = spl_get_image_pos();
Simon Glass8bee2d22017-11-13 18:55:03 -0700251
Tom Rini08574ed2022-10-28 20:27:07 -0400252#if CONFIG_SYS_MONITOR_LEN != 0
Simon Glassd95ceb92016-09-24 18:19:52 -0600253 spl_image->size = CONFIG_SYS_MONITOR_LEN;
Tom Rini08574ed2022-10-28 20:27:07 -0400254#else
255 /* Unknown U-Boot size, let's assume it will not be more than 200 KB */
256 spl_image->size = 200 * 1024;
257#endif
Miquel Raynal55fe0e22018-02-28 20:51:43 +0100258
259 /*
260 * Binman error cases: address of the end of the previous region or the
261 * start of the image's entry area (usually 0) if there is no previous
262 * region.
263 */
264 if (u_boot_pos && u_boot_pos != BINMAN_SYM_MISSING) {
265 /* Binman does not support separated entry addresses */
Simon Glass8bee2d22017-11-13 18:55:03 -0700266 spl_image->entry_point = u_boot_pos;
267 spl_image->load_addr = u_boot_pos;
268 } else {
Jesse Taube6ab77bb2023-08-24 21:59:48 -0400269 spl_image->entry_point = CONFIG_SYS_UBOOT_START;
Simon Glass98463902022-10-20 18:22:39 -0600270 spl_image->load_addr = CONFIG_TEXT_BASE;
Simon Glass8bee2d22017-11-13 18:55:03 -0700271 }
Simon Glassd95ceb92016-09-24 18:19:52 -0600272 spl_image->os = IH_OS_U_BOOT;
273 spl_image->name = "U-Boot";
Heiko Schocher0c3117b2014-10-31 08:31:00 +0100274}
275
Pali Rohár9baab602021-07-23 11:14:28 +0200276__weak int spl_parse_board_header(struct spl_image_info *spl_image,
Pali Rohár2e0429b2022-01-14 14:31:38 +0100277 const struct spl_boot_device *bootdev,
Pali Rohár9baab602021-07-23 11:14:28 +0200278 const void *image_header, size_t size)
279{
280 return -EINVAL;
281}
282
Stefan Roesec1108172020-04-21 09:28:41 +0200283__weak int spl_parse_legacy_header(struct spl_image_info *spl_image,
Simon Glassf3543e62022-09-06 20:26:52 -0600284 const struct legacy_img_hdr *header)
Stefan Roesec1108172020-04-21 09:28:41 +0200285{
286 /* LEGACY image not supported */
287 debug("Legacy boot image support not enabled, proceeding to other boot methods\n");
288 return -EINVAL;
289}
290
Simon Glass71316c12016-09-24 18:19:53 -0600291int spl_parse_image_header(struct spl_image_info *spl_image,
Pali Rohár2e0429b2022-01-14 14:31:38 +0100292 const struct spl_boot_device *bootdev,
Simon Glassf3543e62022-09-06 20:26:52 -0600293 const struct legacy_img_hdr *header)
Aneesh V8cf686e2011-07-21 09:10:27 -0400294{
Simon Glass035ab462023-09-26 08:14:34 -0600295 int ret;
Marek Vasut8a9dc162018-05-13 00:23:17 +0200296
Simon Glass035ab462023-09-26 08:14:34 -0600297 if (CONFIG_IS_ENABLED(LOAD_FIT_FULL)) {
298 ret = spl_load_fit_image(spl_image, header);
299
300 if (!ret)
301 return ret;
302 }
Stefan Roese77552b02012-08-27 12:50:57 +0200303 if (image_get_magic(header) == IH_MAGIC) {
Stefan Roesec1108172020-04-21 09:28:41 +0200304 int ret;
Andrew F. Davis722a6b12017-02-16 11:18:39 -0600305
Stefan Roesec1108172020-04-21 09:28:41 +0200306 ret = spl_parse_legacy_header(spl_image, header);
307 if (ret)
308 return ret;
Simon Glassaf4ff282024-08-22 07:54:52 -0600309 return 0;
310 }
311
312 if (IS_ENABLED(CONFIG_SPL_PANIC_ON_RAW_IMAGE)) {
Albert ARIBAUD \(3ADEV\)8c80eb32015-03-31 11:40:50 +0200313 /*
314 * CONFIG_SPL_PANIC_ON_RAW_IMAGE is defined when the
315 * code which loads images in SPL cannot guarantee that
316 * absolutely all read errors will be reported.
317 * An example is the LPC32XX MLC NAND driver, which
318 * will consider that a completely unreadable NAND block
319 * is bad, and thus should be skipped silently.
320 */
321 panic("** no mkimage signature but raw image not supported");
Simon Glassaf4ff282024-08-22 07:54:52 -0600322 }
Paul Kocialkowski85a37722016-08-24 20:04:42 +0200323
Simon Glassaf4ff282024-08-22 07:54:52 -0600324 if (CONFIG_IS_ENABLED(OS_BOOT) && IS_ENABLED(CONFIG_CMD_BOOTI)) {
Nathan Barrett-Morrison7a0d8802022-02-02 15:05:18 -0500325 ulong start, size;
326
327 if (!booti_setup((ulong)header, &start, &size, 0)) {
328 spl_image->name = "Linux";
329 spl_image->os = IH_OS_LINUX;
330 spl_image->load_addr = start;
331 spl_image->entry_point = start;
332 spl_image->size = size;
Simon Glass96ed5b02024-09-29 19:49:55 -0600333 debug(PHASE_PROMPT
Nathan Barrett-Morrison7a0d8802022-02-02 15:05:18 -0500334 "payload Image, load addr: 0x%lx size: %d\n",
335 spl_image->load_addr, spl_image->size);
336 return 0;
337 }
Simon Glassaf4ff282024-08-22 07:54:52 -0600338 } else if (CONFIG_IS_ENABLED(OS_BOOT) && IS_ENABLED(CONFIG_CMD_BOOTZ)) {
Ladislav Michl431889d2016-07-12 20:28:14 +0200339 ulong start, end;
340
341 if (!bootz_setup((ulong)header, &start, &end)) {
Simon Glass71316c12016-09-24 18:19:53 -0600342 spl_image->name = "Linux";
343 spl_image->os = IH_OS_LINUX;
344 spl_image->load_addr = CONFIG_SYS_LOAD_ADDR;
345 spl_image->entry_point = CONFIG_SYS_LOAD_ADDR;
346 spl_image->size = end - start;
Simon Glass96ed5b02024-09-29 19:49:55 -0600347 debug(PHASE_PROMPT
Simon Glassd6330062018-11-15 18:43:56 -0700348 "payload zImage, load addr: 0x%lx size: %d\n",
Simon Glass71316c12016-09-24 18:19:53 -0600349 spl_image->load_addr, spl_image->size);
Ladislav Michl431889d2016-07-12 20:28:14 +0200350 return 0;
351 }
Simon Glassaf4ff282024-08-22 07:54:52 -0600352 }
Paul Kocialkowski85a37722016-08-24 20:04:42 +0200353
Simon Glassaf4ff282024-08-22 07:54:52 -0600354 if (!spl_parse_board_header(spl_image, bootdev, (const void *)header,
355 sizeof(*header)))
356 return 0;
Pali Rohár9baab602021-07-23 11:14:28 +0200357
Simon Glassbf85af62024-08-22 07:54:53 -0600358 if (IS_ENABLED(CONFIG_SPL_RAW_IMAGE_SUPPORT)) {
Aneesh V8cf686e2011-07-21 09:10:27 -0400359 /* Signature not found - assume u-boot.bin */
Tom Rini026b2fe2012-08-14 12:06:43 -0700360 debug("mkimage signature not found - ih_magic = %x\n",
Simon Glassbf85af62024-08-22 07:54:53 -0600361 header->ih_magic);
Simon Glass71316c12016-09-24 18:19:53 -0600362 spl_set_header_raw_uboot(spl_image);
Simon Glassbf85af62024-08-22 07:54:53 -0600363 } else {
Andrew F. Davis24eb39b2017-02-16 11:18:38 -0600364 /* RAW image not supported, proceed to other boot methods. */
Anatolij Gustschin2d2531b2017-08-01 16:17:12 +0200365 debug("Raw boot image support not enabled, proceeding to other boot methods\n");
Andrew F. Davis24eb39b2017-02-16 11:18:38 -0600366 return -EINVAL;
Simon Glassbf85af62024-08-22 07:54:53 -0600367 }
Andrew F. Davis24eb39b2017-02-16 11:18:38 -0600368
Marek Vasut7e0f2262016-04-29 00:44:54 +0200369 return 0;
Aneesh V8cf686e2011-07-21 09:10:27 -0400370}
371
Sean Anderson77507412023-11-08 11:48:47 -0500372#if SPL_LOAD_USERS > 1
373int spl_load(struct spl_image_info *spl_image,
374 const struct spl_boot_device *bootdev, struct spl_load_info *info,
375 size_t size, size_t offset)
376{
377 return _spl_load(spl_image, bootdev, info, size, offset);
378}
379#endif
380
Allen Martina759f1e2012-10-19 21:08:22 +0000381__weak void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image)
Aneesh V8cf686e2011-07-21 09:10:27 -0400382{
SRICHARAN R4a0eb752013-04-24 00:41:24 +0000383 typedef void __noreturn (*image_entry_noargs_t)(void);
384
Aneesh V8cf686e2011-07-21 09:10:27 -0400385 image_entry_noargs_t image_entry =
Andre Przywara11e14792017-01-02 11:48:31 +0000386 (image_entry_noargs_t)spl_image->entry_point;
Aneesh V8cf686e2011-07-21 09:10:27 -0400387
Simon Goldschmidt30c07402018-11-02 21:49:52 +0100388 debug("image entry point: 0x%lx\n", spl_image->entry_point);
SRICHARAN R4a0eb752013-04-24 00:41:24 +0000389 image_entry();
Aneesh V8cf686e2011-07-21 09:10:27 -0400390}
391
Simon Glassb0edea32018-11-15 18:44:09 -0700392#if CONFIG_IS_ENABLED(HANDOFF)
393/**
394 * Set up the SPL hand-off information
395 *
396 * This is initially empty (zero) but can be written by
397 */
398static int setup_spl_handoff(void)
399{
400 struct spl_handoff *ho;
401
Simon Glass7f3b79a2022-01-12 19:26:17 -0700402 ho = bloblist_ensure(BLOBLISTT_U_BOOT_SPL_HANDOFF, sizeof(struct spl_handoff));
Simon Glassb0edea32018-11-15 18:44:09 -0700403 if (!ho)
404 return -ENOENT;
405
406 return 0;
407}
408
Simon Glass366291a2019-09-25 08:11:18 -0600409__weak int handoff_arch_save(struct spl_handoff *ho)
410{
411 return 0;
412}
413
Simon Glassb0edea32018-11-15 18:44:09 -0700414static int write_spl_handoff(void)
415{
416 struct spl_handoff *ho;
Simon Glass366291a2019-09-25 08:11:18 -0600417 int ret;
Simon Glassb0edea32018-11-15 18:44:09 -0700418
Simon Glass7f3b79a2022-01-12 19:26:17 -0700419 ho = bloblist_find(BLOBLISTT_U_BOOT_SPL_HANDOFF, sizeof(struct spl_handoff));
Simon Glassb0edea32018-11-15 18:44:09 -0700420 if (!ho)
421 return -ENOENT;
422 handoff_save_dram(ho);
Simon Glass366291a2019-09-25 08:11:18 -0600423 ret = handoff_arch_save(ho);
424 if (ret)
425 return ret;
Simon Glass96ed5b02024-09-29 19:49:55 -0600426 debug(PHASE_PROMPT "Wrote SPL handoff\n");
Simon Glassb0edea32018-11-15 18:44:09 -0700427
428 return 0;
429}
430#else
431static inline int setup_spl_handoff(void) { return 0; }
432static inline int write_spl_handoff(void) { return 0; }
433
434#endif /* HANDOFF */
435
Simon Glass05e3a0d2021-03-15 18:11:15 +1300436/**
437 * get_bootstage_id() - Get the bootstage ID to emit
438 *
439 * @start: true if this is for starting SPL, false for ending it
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100440 * Return: bootstage ID to use
Simon Glass05e3a0d2021-03-15 18:11:15 +1300441 */
442static enum bootstage_id get_bootstage_id(bool start)
443{
Simon Glass456bdb72024-09-29 19:49:36 -0600444 enum xpl_phase_t phase = xpl_phase();
Simon Glass05e3a0d2021-03-15 18:11:15 +1300445
446 if (IS_ENABLED(CONFIG_TPL_BUILD) && phase == PHASE_TPL)
447 return start ? BOOTSTAGE_ID_START_TPL : BOOTSTAGE_ID_END_TPL;
Simon Glassf86ca5a2022-04-30 00:56:52 -0600448 else if (IS_ENABLED(CONFIG_VPL_BUILD) && phase == PHASE_VPL)
449 return start ? BOOTSTAGE_ID_START_VPL : BOOTSTAGE_ID_END_VPL;
Simon Glass05e3a0d2021-03-15 18:11:15 +1300450 else
451 return start ? BOOTSTAGE_ID_START_SPL : BOOTSTAGE_ID_END_SPL;
452}
453
Eddie Cai340f4182017-03-15 08:43:28 -0600454static int spl_common_init(bool setup_malloc)
Aneesh Vbcae7212011-07-21 09:10:21 -0400455{
Simon Glassf3d46bd2015-02-27 22:06:42 -0700456 int ret;
457
Simon Glass3d6d5072023-09-26 08:14:27 -0600458#if CONFIG_IS_ENABLED(SYS_MALLOC_F)
Eddie Cai340f4182017-03-15 08:43:28 -0600459 if (setup_malloc) {
Tom Rinidd5b58c2022-12-04 10:04:49 -0500460#ifdef CFG_MALLOC_F_ADDR
461 gd->malloc_base = CFG_MALLOC_F_ADDR;
Marek Vasut94b9e222016-05-25 02:14:56 +0200462#endif
Andy Yanf1896c42017-07-24 17:43:34 +0800463 gd->malloc_limit = CONFIG_VAL(SYS_MALLOC_F_LEN);
Eddie Cai340f4182017-03-15 08:43:28 -0600464 gd->malloc_ptr = 0;
465 }
Tom Rini24dafad2012-08-13 14:13:07 -0700466#endif
Simon Glass713bfc52024-09-29 19:49:34 -0600467 ret = bootstage_init(xpl_is_first_phase());
Simon Glass824bb1b2017-05-22 05:05:35 -0600468 if (ret) {
469 debug("%s: Failed to set up bootstage: ret=%d\n", __func__,
470 ret);
471 return ret;
472 }
Simon Glass713bfc52024-09-29 19:49:34 -0600473 if (!xpl_is_first_phase()) {
Simon Glass17ba5012023-09-26 08:14:32 -0600474 ret = bootstage_unstash_default();
Simon Glass31f9f0e2019-10-21 17:26:52 -0600475 if (ret)
Simon Glass17ba5012023-09-26 08:14:32 -0600476 log_debug("Failed to unstash bootstage: ret=%d\n", ret);
Simon Glass31f9f0e2019-10-21 17:26:52 -0600477 }
Simon Glass80580cd2024-09-29 19:49:40 -0600478 bootstage_mark_name(get_bootstage_id(true), xpl_name(xpl_phase()));
Simon Glass4d8d3052018-11-15 18:43:49 -0700479#if CONFIG_IS_ENABLED(LOG)
480 ret = log_init();
481 if (ret) {
482 debug("%s: Failed to set up logging\n", __func__);
483 return ret;
484 }
485#endif
Simon Glass414cc152021-08-07 07:24:03 -0600486 if (CONFIG_IS_ENABLED(OF_REAL)) {
Simon Glassf3d46bd2015-02-27 22:06:42 -0700487 ret = fdtdec_setup();
488 if (ret) {
489 debug("fdtdec_setup() returned error %d\n", ret);
Simon Glass070d00b2015-06-23 15:39:10 -0600490 return ret;
Simon Glassf3d46bd2015-02-27 22:06:42 -0700491 }
492 }
Philipp Tomsichf1c6e192017-06-30 19:02:53 +0200493 if (CONFIG_IS_ENABLED(DM)) {
Simon Glassb67eefd2020-05-10 11:39:59 -0600494 bootstage_start(BOOTSTAGE_ID_ACCUM_DM_SPL,
Simon Glass456bdb72024-09-29 19:49:36 -0600495 xpl_phase() == PHASE_TPL ? "dm tpl" : "dm_spl");
Tom Rini7f73ca42017-01-14 12:20:23 -0500496 /* With CONFIG_SPL_OF_PLATDATA, bring in all devices */
Simon Glass7d23b9c2016-07-04 11:58:14 -0600497 ret = dm_init_and_scan(!CONFIG_IS_ENABLED(OF_PLATDATA));
Simon Glassb67eefd2020-05-10 11:39:59 -0600498 bootstage_accum(BOOTSTAGE_ID_ACCUM_DM_SPL);
Simon Glassf3d46bd2015-02-27 22:06:42 -0700499 if (ret) {
500 debug("dm_init_and_scan() returned error %d\n", ret);
Simon Glass070d00b2015-06-23 15:39:10 -0600501 return ret;
Simon Glassf3d46bd2015-02-27 22:06:42 -0700502 }
503 }
Eddie Cai340f4182017-03-15 08:43:28 -0600504
505 return 0;
506}
507
Alexandru Gagniuc58b504e2021-04-08 11:56:11 -0500508void spl_set_bd(void)
York Sund1fc0a32017-09-28 08:42:10 -0700509{
Simon Glassc21f4072018-11-15 18:43:58 -0700510 /*
511 * NOTE: On some platforms (e.g. x86) bdata may be in flash and not
512 * writeable.
513 */
Alexandru Gagniuc58b504e2021-04-08 11:56:11 -0500514 if (!gd->bd)
515 gd->bd = &bdata;
York Sund1fc0a32017-09-28 08:42:10 -0700516}
517
Eddie Cai340f4182017-03-15 08:43:28 -0600518int spl_early_init(void)
519{
520 int ret;
521
Simon Goldschmidt94cb9862018-08-13 11:24:05 +0200522 debug("%s\n", __func__);
523
Eddie Cai340f4182017-03-15 08:43:28 -0600524 ret = spl_common_init(true);
525 if (ret)
526 return ret;
527 gd->flags |= GD_FLG_SPL_EARLY_INIT;
528
529 return 0;
530}
531
532int spl_init(void)
533{
534 int ret;
Tom Rinicf334ed2017-03-20 14:19:27 -0400535 bool setup_malloc = !(IS_ENABLED(CONFIG_SPL_STACK_R) &&
536 IS_ENABLED(CONFIG_SPL_SYS_MALLOC_SIMPLE));
Eddie Cai340f4182017-03-15 08:43:28 -0600537
Simon Goldschmidt94cb9862018-08-13 11:24:05 +0200538 debug("%s\n", __func__);
539
Eddie Cai340f4182017-03-15 08:43:28 -0600540 if (!(gd->flags & GD_FLG_SPL_EARLY_INIT)) {
Tom Rinicf334ed2017-03-20 14:19:27 -0400541 ret = spl_common_init(setup_malloc);
Eddie Cai340f4182017-03-15 08:43:28 -0600542 if (ret)
543 return ret;
544 }
Simon Glass070d00b2015-06-23 15:39:10 -0600545 gd->flags |= GD_FLG_SPL_INIT;
Aneesh V2d01dd92011-10-21 12:29:34 -0400546
Simon Glass070d00b2015-06-23 15:39:10 -0600547 return 0;
548}
549
Nikita Kiryanovf101e4b2015-11-08 17:11:51 +0200550#ifndef BOOT_DEVICE_NONE
551#define BOOT_DEVICE_NONE 0xdeadbeef
552#endif
553
Nikita Kiryanovf101e4b2015-11-08 17:11:51 +0200554__weak void board_boot_order(u32 *spl_boot_list)
555{
556 spl_boot_list[0] = spl_boot_device();
557}
558
Pali Rohárc10939d2022-01-14 14:31:40 +0100559__weak int spl_check_board_image(struct spl_image_info *spl_image,
560 const struct spl_boot_device *bootdev)
561{
562 return 0;
563}
564
Simon Glass29d357d2016-11-30 15:30:52 -0700565static int spl_load_image(struct spl_image_info *spl_image,
566 struct spl_image_loader *loader)
Nikita Kiryanov5211b872015-11-08 17:11:50 +0200567{
Simon Goldschmidtdae5c2d2019-02-10 21:34:37 +0100568 int ret;
Simon Glassecdfd692016-09-24 18:19:57 -0600569 struct spl_boot_device bootdev;
570
Simon Glass29d357d2016-11-30 15:30:52 -0700571 bootdev.boot_device = loader->boot_device;
Simon Glassecdfd692016-09-24 18:19:57 -0600572 bootdev.boot_device_name = NULL;
573
Simon Goldschmidtdae5c2d2019-02-10 21:34:37 +0100574 ret = loader->load_image(spl_image, &bootdev);
575#ifdef CONFIG_SPL_LEGACY_IMAGE_CRC_CHECK
576 if (!ret && spl_image->dcrc_length) {
577 /* check data crc */
578 ulong dcrc = crc32_wd(0, (unsigned char *)spl_image->dcrc_data,
579 spl_image->dcrc_length, CHUNKSZ_CRC32);
580 if (dcrc != spl_image->dcrc) {
581 puts("SPL: Image data CRC check failed!\n");
582 ret = -EINVAL;
583 }
584 }
585#endif
Pali Rohárc10939d2022-01-14 14:31:40 +0100586 if (!ret)
587 ret = spl_check_board_image(spl_image, &bootdev);
588
Simon Goldschmidtdae5c2d2019-02-10 21:34:37 +0100589 return ret;
Simon Glass540bfe72016-11-30 15:30:51 -0700590}
591
592/**
Miquel Raynalfd4ee982019-05-07 14:18:43 +0200593 * boot_from_devices() - Try loading a booting U-Boot from a list of devices
Simon Glass540bfe72016-11-30 15:30:51 -0700594 *
595 * @spl_image: Place to put the image details if successful
596 * @spl_boot_list: List of boot devices to try
597 * @count: Number of elements in spl_boot_list
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100598 * Return: 0 if OK, -ENODEV if there were no boot devices
Simon Glass7d84fbb2021-07-05 16:32:57 -0600599 * if CONFIG_SHOW_ERRORS is enabled, returns -ENXIO if there were
600 * devices but none worked
Simon Glass540bfe72016-11-30 15:30:51 -0700601 */
602static int boot_from_devices(struct spl_image_info *spl_image,
603 u32 spl_boot_list[], int count)
604{
Simon Glass5a61bf12022-10-20 18:23:07 -0600605 struct spl_image_loader *drv =
606 ll_entry_start(struct spl_image_loader, spl_image_loader);
607 const int n_ents =
608 ll_entry_count(struct spl_image_loader, spl_image_loader);
Simon Glass7d84fbb2021-07-05 16:32:57 -0600609 int ret = -ENODEV;
Simon Glass540bfe72016-11-30 15:30:51 -0700610 int i;
611
612 for (i = 0; i < count && spl_boot_list[i] != BOOT_DEVICE_NONE; i++) {
613 struct spl_image_loader *loader;
Simon Glass7d84fbb2021-07-05 16:32:57 -0600614 int bootdev = spl_boot_list[i];
Simon Glass540bfe72016-11-30 15:30:51 -0700615
Simon Glass7d84fbb2021-07-05 16:32:57 -0600616 if (CONFIG_IS_ENABLED(SHOW_ERRORS))
617 ret = -ENXIO;
Simon Glass5a61bf12022-10-20 18:23:07 -0600618 for (loader = drv; loader != drv + n_ents; loader++) {
619 if (bootdev != loader->boot_device)
620 continue;
621 if (!CONFIG_IS_ENABLED(SILENT_CONSOLE)) {
622 if (loader)
623 printf("Trying to boot from %s\n",
624 spl_loader_name(loader));
625 else if (CONFIG_IS_ENABLED(SHOW_ERRORS)) {
Simon Glass96ed5b02024-09-29 19:49:55 -0600626 printf(PHASE_PROMPT
Simon Glass5a61bf12022-10-20 18:23:07 -0600627 "Unsupported Boot Device %d\n",
628 bootdev);
629 } else {
Simon Glass96ed5b02024-09-29 19:49:55 -0600630 puts(PHASE_PROMPT
Simon Glass5a61bf12022-10-20 18:23:07 -0600631 "Unsupported Boot Device!\n");
632 }
633 }
634 if (loader &&
635 !spl_load_image(spl_image, loader)) {
636 spl_image->boot_device = bootdev;
637 return 0;
638 }
Philipp Tomsichde5dd4c2018-05-24 17:15:50 +0200639 }
Simon Glass540bfe72016-11-30 15:30:51 -0700640 }
641
Simon Glass7d84fbb2021-07-05 16:32:57 -0600642 return ret;
Nikita Kiryanov5211b872015-11-08 17:11:50 +0200643}
644
Philippe Reynesa9a3aad2019-09-19 16:18:39 +0200645#if defined(CONFIG_SPL_FRAMEWORK_BOARD_INIT_F)
646void board_init_f(ulong dummy)
647{
648 if (CONFIG_IS_ENABLED(OF_CONTROL)) {
649 int ret;
650
651 ret = spl_early_init();
652 if (ret) {
653 debug("spl_early_init() failed: %d\n", ret);
654 hang();
655 }
656 }
657
Samuel Holland3988be52020-05-07 18:08:10 -0500658 preloader_console_init();
Philippe Reynesa9a3aad2019-09-19 16:18:39 +0200659}
660#endif
661
Simon Glass070d00b2015-06-23 15:39:10 -0600662void board_init_r(gd_t *dummy1, ulong dummy2)
663{
Simon Glassd32b2d12016-09-24 18:20:17 -0600664 u32 spl_boot_list[] = {
665 BOOT_DEVICE_NONE,
666 BOOT_DEVICE_NONE,
667 BOOT_DEVICE_NONE,
668 BOOT_DEVICE_NONE,
669 BOOT_DEVICE_NONE,
670 };
Jonas Karlman6826c432023-09-27 21:44:13 +0000671 typedef void __noreturn (*jump_to_image_t)(struct spl_image_info *);
672 jump_to_image_t jump_to_image = &jump_to_image_no_args;
Simon Glassd32b2d12016-09-24 18:20:17 -0600673 struct spl_image_info spl_image;
Simon Glassf817e082023-09-26 08:14:22 -0600674 int ret, os;
Simon Glass070d00b2015-06-23 15:39:10 -0600675
Simon Glass96ed5b02024-09-29 19:49:55 -0600676 debug(">>" PHASE_PROMPT "board_init_r()\n");
York Sund1fc0a32017-09-28 08:42:10 -0700677
Alexandru Gagniuc58b504e2021-04-08 11:56:11 -0500678 spl_set_bd();
679
Simon Glass52779872023-09-26 08:14:18 -0600680 if (IS_ENABLED(CONFIG_SPL_SYS_MALLOC)) {
Simon Glass41fecdc2024-10-21 10:19:26 +0200681 mem_malloc_init(SPL_SYS_MALLOC_START, SPL_SYS_MALLOC_SIZE);
Simon Glass52779872023-09-26 08:14:18 -0600682 gd->flags |= GD_FLG_FULL_MALLOC_INIT;
683 }
Simon Glass070d00b2015-06-23 15:39:10 -0600684 if (!(gd->flags & GD_FLG_SPL_INIT)) {
685 if (spl_init())
686 hang();
687 }
Ilya Yanok4063c772012-09-17 10:26:26 +0000688 timer_init();
Simon Glass3cd71982019-09-25 08:11:19 -0600689 if (CONFIG_IS_ENABLED(BLOBLIST)) {
690 ret = bloblist_init();
691 if (ret) {
692 debug("%s: Failed to set up bloblist: ret=%d\n",
693 __func__, ret);
Simon Glass96ed5b02024-09-29 19:49:55 -0600694 puts(PHASE_PROMPT "Cannot set up bloblist\n");
Simon Glass3cd71982019-09-25 08:11:19 -0600695 hang();
696 }
697 }
698 if (CONFIG_IS_ENABLED(HANDOFF)) {
699 int ret;
700
701 ret = setup_spl_handoff();
702 if (ret) {
Simon Glass96ed5b02024-09-29 19:49:55 -0600703 puts(PHASE_PROMPT "Cannot set up SPL handoff\n");
Simon Glass3cd71982019-09-25 08:11:19 -0600704 hang();
705 }
706 }
Ilya Yanok4063c772012-09-17 10:26:26 +0000707
Lukas Funke52ef6a92024-03-27 13:11:52 +0100708 if (CONFIG_IS_ENABLED(SOC_INIT))
709 spl_soc_init();
710
Simon Glass6371c472023-09-26 08:14:20 -0600711 if (IS_ENABLED(CONFIG_SPL_WATCHDOG) && CONFIG_IS_ENABLED(WDT))
712 initr_watchdog();
Stefan Roese06985282019-04-11 15:58:44 +0200713
Heiko Stuebnera343b4f2020-05-25 19:57:25 +0200714 if (IS_ENABLED(CONFIG_SPL_OS_BOOT) || CONFIG_IS_ENABLED(HANDOFF) ||
Chintan Vankar62b096d2024-08-26 15:55:05 +0530715 IS_ENABLED(CONFIG_SPL_ATF) || IS_ENABLED(CONFIG_SPL_NET))
Simon Glassb0edea32018-11-15 18:44:09 -0700716 dram_init_banksize();
717
Sughosh Ganub6400de2024-08-26 17:29:28 +0530718 if (IS_ENABLED(CONFIG_SPL_LMB))
719 lmb_init();
720
Simon Glass15a23b62023-09-07 09:58:13 -0600721 if (CONFIG_IS_ENABLED(PCI) && !(gd->flags & GD_FLG_DM_DEAD)) {
Heinrich Schuchardt7d4c8cf2023-07-24 22:18:41 +0200722 ret = pci_init();
723 if (ret)
Simon Glass96ed5b02024-09-29 19:49:55 -0600724 puts(PHASE_PROMPT "Cannot initialize PCI\n");
Heinrich Schuchardt7d4c8cf2023-07-24 22:18:41 +0200725 /* Don't fail. We still can try other boot methods. */
726 }
727
Sughosh Ganufa6333a2024-08-26 17:29:33 +0530728 if (CONFIG_IS_ENABLED(BOARD_INIT))
729 spl_board_init();
730
Lukasz Majewskia8be2492018-05-02 16:10:54 +0200731 bootcount_inc();
732
Simon Glass4f6500a2022-05-08 04:39:27 -0600733 /* Dump driver model states to aid analysis */
734 if (CONFIG_IS_ENABLED(DM_STATS)) {
735 struct dm_stats mem;
736
737 dm_get_mem(&mem);
738 dm_dump_mem(&mem);
739 }
740
Simon Glassd32b2d12016-09-24 18:20:17 -0600741 memset(&spl_image, '\0', sizeof(spl_image));
Simon Glasse0be6ea2023-09-26 08:14:21 -0600742 if (IS_ENABLED(CONFIG_SPL_OS_BOOT))
743 spl_image.arg = (void *)SPL_PAYLOAD_ARGS_ADDR;
Philipp Tomsichde5dd4c2018-05-24 17:15:50 +0200744 spl_image.boot_device = BOOT_DEVICE_NONE;
Nikita Kiryanovf101e4b2015-11-08 17:11:51 +0200745 board_boot_order(spl_boot_list);
Nikita Kiryanovf101e4b2015-11-08 17:11:51 +0200746
Simon Glass7d84fbb2021-07-05 16:32:57 -0600747 ret = boot_from_devices(&spl_image, spl_boot_list,
748 ARRAY_SIZE(spl_boot_list));
749 if (ret) {
Sean Anderson06b1bca2023-11-08 11:48:35 -0500750 if (CONFIG_IS_ENABLED(SHOW_ERRORS))
Simon Glass96ed5b02024-09-29 19:49:55 -0600751 printf(PHASE_PROMPT "failed to boot from all boot devices (err=%d)\n",
Simon Glass7d84fbb2021-07-05 16:32:57 -0600752 ret);
753 else
Simon Glass96ed5b02024-09-29 19:49:55 -0600754 puts(PHASE_PROMPT "failed to boot from all boot devices\n");
Aneesh V8cf686e2011-07-21 09:10:27 -0400755 hang();
Nikita Kiryanovf101e4b2015-11-08 17:11:51 +0200756 }
Aneesh V8cf686e2011-07-21 09:10:27 -0400757
Philipp Tomsichde5dd4c2018-05-24 17:15:50 +0200758 spl_perform_fixups(&spl_image);
759
Simon Glassf817e082023-09-26 08:14:22 -0600760 os = spl_image.os;
761 if (os == IH_OS_U_BOOT) {
Simon Glass80580cd2024-09-29 19:49:40 -0600762 debug("Jumping to %s...\n", xpl_name(xpl_next_phase()));
Simon Glassf817e082023-09-26 08:14:22 -0600763 } else if (CONFIG_IS_ENABLED(ATF) && os == IH_OS_ARM_TRUSTED_FIRMWARE) {
Philipp Tomsich1d379092017-09-13 21:29:35 +0200764 debug("Jumping to U-Boot via ARM Trusted Firmware\n");
Simon Glassf817e082023-09-26 08:14:22 -0600765 spl_fixup_fdt(spl_image_fdt_addr(&spl_image));
Jonas Karlman6826c432023-09-27 21:44:13 +0000766 jump_to_image = &spl_invoke_atf;
Simon Glassf817e082023-09-26 08:14:22 -0600767 } else if (CONFIG_IS_ENABLED(OPTEE_IMAGE) && os == IH_OS_TEE) {
Kever Yang70fe2872018-08-23 17:17:59 +0800768 debug("Jumping to U-Boot via OP-TEE\n");
Simon Glassf817e082023-09-26 08:14:22 -0600769 spl_board_prepare_for_optee(spl_image_fdt_addr(&spl_image));
Jonas Karlman6826c432023-09-27 21:44:13 +0000770 jump_to_image = &jump_to_image_optee;
Simon Glassf817e082023-09-26 08:14:22 -0600771 } else if (CONFIG_IS_ENABLED(OPENSBI) && os == IH_OS_OPENSBI) {
Lukas Auer5e30e452019-08-21 21:14:44 +0200772 debug("Jumping to U-Boot via RISC-V OpenSBI\n");
Jonas Karlman6826c432023-09-27 21:44:13 +0000773 jump_to_image = &spl_invoke_opensbi;
Simon Glassf817e082023-09-26 08:14:22 -0600774 } else if (CONFIG_IS_ENABLED(OS_BOOT) && os == IH_OS_LINUX) {
Simon Schwarz379c19a2012-03-15 04:01:38 +0000775 debug("Jumping to Linux\n");
Simon Glasse0be6ea2023-09-26 08:14:21 -0600776 if (IS_ENABLED(CONFIG_SPL_OS_BOOT))
777 spl_fixup_fdt((void *)SPL_PAYLOAD_ARGS_ADDR);
Simon Schwarz379c19a2012-03-15 04:01:38 +0000778 spl_board_prepare_for_linux();
Jonas Karlman6826c432023-09-27 21:44:13 +0000779 jump_to_image = &jump_to_image_linux;
Simon Glassf817e082023-09-26 08:14:22 -0600780 } else {
Tom Rini42120982012-08-27 14:58:28 -0700781 debug("Unsupported OS image.. Jumping nevertheless..\n");
Aneesh V8cf686e2011-07-21 09:10:27 -0400782 }
Simon Glass2003a832023-09-26 08:14:31 -0600783 if (CONFIG_IS_ENABLED(SYS_MALLOC_F) &&
784 !IS_ENABLED(CONFIG_SPL_SYS_MALLOC_SIZE))
Simon Glass92aa3ec2024-08-23 14:27:04 -0600785 debug("SPL malloc() used 0x%x bytes (%d KB)\n",
Simon Glass2003a832023-09-26 08:14:31 -0600786 gd_malloc_ptr(), gd_malloc_ptr() / 1024);
787
Simon Glass05e3a0d2021-03-15 18:11:15 +1300788 bootstage_mark_name(get_bootstage_id(false), "end phase");
Simon Glass17ba5012023-09-26 08:14:32 -0600789 ret = bootstage_stash_default();
Simon Glass824bb1b2017-05-22 05:05:35 -0600790 if (ret)
791 debug("Failed to stash bootstage: err=%d\n", ret);
Kever Yanga8c51122017-09-13 18:24:24 +0800792
Nikhil M Jain954b0ad2023-07-18 14:27:33 +0530793 if (IS_ENABLED(CONFIG_SPL_VIDEO_REMOVE)) {
794 struct udevice *dev;
795 int rc;
Nikhil M Jain7a17e4c2023-04-10 14:19:13 +0530796
Nikhil M Jain954b0ad2023-07-18 14:27:33 +0530797 rc = uclass_find_device(UCLASS_VIDEO, 0, &dev);
798 if (!rc && dev) {
799 rc = device_remove(dev, DM_REMOVE_NORMAL);
800 if (rc)
801 printf("Cannot remove video device '%s' (err=%d)\n",
802 dev->name, rc);
803 }
Nikhil M Jain7a17e4c2023-04-10 14:19:13 +0530804 }
Simon Glassa17e1e72023-09-26 08:14:36 -0600805 if (CONFIG_IS_ENABLED(HANDOFF)) {
806 ret = write_spl_handoff();
807 if (ret)
Simon Glass96ed5b02024-09-29 19:49:55 -0600808 printf(PHASE_PROMPT
Simon Glassa17e1e72023-09-26 08:14:36 -0600809 "SPL hand-off write failed (err=%d)\n", ret);
810 }
Simon Glassec2186a2024-08-07 16:47:33 -0600811 if (CONFIG_IS_ENABLED(UPL_OUT) && (gd->flags & GD_FLG_UPL)) {
812 ret = spl_write_upl_handoff(&spl_image);
813 if (ret) {
Simon Glass96ed5b02024-09-29 19:49:55 -0600814 printf(PHASE_PROMPT
Simon Glassec2186a2024-08-07 16:47:33 -0600815 "UPL hand-off write failed (err=%d)\n", ret);
816 hang();
817 }
818 }
Simon Glassa17e1e72023-09-26 08:14:36 -0600819 if (CONFIG_IS_ENABLED(BLOBLIST)) {
820 ret = bloblist_finish();
821 if (ret)
822 printf("Warning: Failed to finish bloblist (ret=%d)\n",
823 ret);
824 }
Nikhil M Jain7a17e4c2023-04-10 14:19:13 +0530825
Michal Simek3a3b9142016-05-10 07:54:20 +0200826 spl_board_prepare_for_boot();
Jonas Karlman6826c432023-09-27 21:44:13 +0000827 jump_to_image(&spl_image);
Aneesh Vbcae7212011-07-21 09:10:21 -0400828}
829
Tom Rini6507f132012-08-22 15:31:05 -0700830/*
831 * This requires UART clocks to be enabled. In order for this to work the
832 * caller must ensure that the gd pointer is valid.
833 */
Aneesh Vbcae7212011-07-21 09:10:21 -0400834void preloader_console_init(void)
835{
Simon Glass2a736062021-08-08 12:20:12 -0600836#ifdef CONFIG_SPL_SERIAL
Aneesh Vbcae7212011-07-21 09:10:21 -0400837 gd->baudrate = CONFIG_BAUDRATE;
838
Aneesh Vbcae7212011-07-21 09:10:21 -0400839 serial_init(); /* serial communications setup */
840
Simon Glassf44fded2024-08-21 10:19:04 -0600841 gd->flags |= GD_FLG_HAVE_CONSOLE;
Ilya Yanokb88befa2011-11-01 13:16:03 +0000842
Simon Glassaedc08b2018-11-15 18:43:57 -0700843#if CONFIG_IS_ENABLED(BANNER_PRINT)
Simon Glass96ed5b02024-09-29 19:49:55 -0600844 puts("\nU-Boot " PHASE_NAME " " PLAIN_VERSION " (" U_BOOT_DATE " - "
Simon Glassd6330062018-11-15 18:43:56 -0700845 U_BOOT_TIME " " U_BOOT_TZ ")\n");
Anatolij Gustschin0292bc02018-01-25 18:45:22 +0100846#endif
Tom Rini861a86f2012-08-13 11:37:56 -0700847#ifdef CONFIG_SPL_DISPLAY_PRINT
848 spl_display_print();
849#endif
Alex Kiernan117a0e02018-04-19 04:32:51 +0000850#endif
Samuel Holland3988be52020-05-07 18:08:10 -0500851}
Simon Glassdb910352015-03-03 08:03:00 -0700852
853/**
Simon Goldschmidtd8c03322019-07-16 22:30:36 +0200854 * This function is called before the stack is changed from initial stack to
855 * relocated stack. It tries to dump the stack size used
856 */
857__weak void spl_relocate_stack_check(void)
858{
859#if CONFIG_IS_ENABLED(SYS_REPORT_STACK_F_USAGE)
860 ulong init_sp = gd->start_addr_sp;
861 ulong stack_bottom = init_sp - CONFIG_VAL(SIZE_LIMIT_PROVIDE_STACK);
862 u8 *ptr = (u8 *)stack_bottom;
863 ulong i;
864
865 for (i = 0; i < CONFIG_VAL(SIZE_LIMIT_PROVIDE_STACK); i++) {
866 if (*ptr != CONFIG_VAL(SYS_STACK_F_CHECK_BYTE))
867 break;
868 ptr++;
869 }
870 printf("SPL initial stack usage: %lu bytes\n",
871 CONFIG_VAL(SIZE_LIMIT_PROVIDE_STACK) - i);
872#endif
873}
874
875/**
Simon Glassdb910352015-03-03 08:03:00 -0700876 * spl_relocate_stack_gd() - Relocate stack ready for board_init_r() execution
877 *
878 * Sometimes board_init_f() runs with a stack in SRAM but we want to use SDRAM
879 * for the main board_init_r() execution. This is typically because we need
880 * more stack space for things like the MMC sub-system.
881 *
882 * This function calculates the stack position, copies the global_data into
Albert ARIBAUDadc421e2015-11-25 17:56:33 +0100883 * place, sets the new gd (except for ARM, for which setting GD within a C
884 * function may not always work) and returns the new stack position. The
885 * caller is responsible for setting up the sp register and, in the case
886 * of ARM, setting up gd.
887 *
888 * All of this is done using the same layout and alignments as done in
889 * board_init_f_init_reserve() / board_init_f_alloc_reserve().
Simon Glassdb910352015-03-03 08:03:00 -0700890 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100891 * Return: new stack location, or 0 to use the same stack
Simon Glassdb910352015-03-03 08:03:00 -0700892 */
893ulong spl_relocate_stack_gd(void)
894{
895#ifdef CONFIG_SPL_STACK_R
896 gd_t *new_gd;
Albert ARIBAUDadc421e2015-11-25 17:56:33 +0100897 ulong ptr = CONFIG_SPL_STACK_R_ADDR;
Simon Glassdb910352015-03-03 08:03:00 -0700898
Simon Goldschmidtd8c03322019-07-16 22:30:36 +0200899 if (CONFIG_IS_ENABLED(SYS_REPORT_STACK_F_USAGE))
900 spl_relocate_stack_check();
901
Simon Glass3d6d5072023-09-26 08:14:27 -0600902#if defined(CONFIG_SPL_SYS_MALLOC_SIMPLE) && CONFIG_IS_ENABLED(SYS_MALLOC_F)
Hans de Goededcfcb8d2015-09-13 15:04:17 +0200903 if (CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN) {
Simon Glass92aa3ec2024-08-23 14:27:04 -0600904 debug("SPL malloc() before relocation used 0x%x bytes (%d KB)\n",
Simon Goldschmidt438dcab2019-02-26 22:27:52 +0100905 gd->malloc_ptr, gd->malloc_ptr / 1024);
Hans de Goededcfcb8d2015-09-13 15:04:17 +0200906 ptr -= CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN;
907 gd->malloc_base = ptr;
908 gd->malloc_limit = CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN;
909 gd->malloc_ptr = 0;
910 }
911#endif
Albert ARIBAUDadc421e2015-11-25 17:56:33 +0100912 /* Get stack position: use 8-byte alignment for ABI compliance */
913 ptr = CONFIG_SPL_STACK_R_ADDR - roundup(sizeof(gd_t),16);
Nikhil M Jain149fb052023-07-18 14:27:27 +0530914 gd->start_addr_sp = ptr;
Albert ARIBAUDadc421e2015-11-25 17:56:33 +0100915 new_gd = (gd_t *)ptr;
916 memcpy(new_gd, (void *)gd, sizeof(gd_t));
Simon Glass2f11cd92016-11-13 14:21:58 -0700917#if CONFIG_IS_ENABLED(DM)
918 dm_fixup_for_gd_move(new_gd);
919#endif
Thomas Weißschuh39162d92024-02-13 18:13:28 +0100920#if CONFIG_IS_ENABLED(LOG)
921 log_fixup_for_gd_move(new_gd);
922#endif
Lukas Auerc7e1eff2019-08-21 21:14:46 +0200923#if !defined(CONFIG_ARM) && !defined(CONFIG_RISCV)
Albert ARIBAUDadc421e2015-11-25 17:56:33 +0100924 gd = new_gd;
925#endif
Simon Glassdb910352015-03-03 08:03:00 -0700926 return ptr;
927#else
928 return 0;
929#endif
930}
Simon Glassc6604442019-11-14 12:57:17 -0700931
Philippe Reynes4d145f22020-12-11 19:56:47 +0100932#if defined(CONFIG_BOOTCOUNT_LIMIT) && \
933 ((!defined(CONFIG_TPL_BUILD) && !defined(CONFIG_SPL_BOOTCOUNT_LIMIT)) || \
934 (defined(CONFIG_TPL_BUILD) && !defined(CONFIG_TPL_BOOTCOUNT_LIMIT)))
Simon Glassc6604442019-11-14 12:57:17 -0700935void bootcount_store(ulong a)
936{
937}
938
939ulong bootcount_load(void)
940{
941 return 0;
942}
943#endif