blob: 3ce5bfeec8b9a520bcbff8da2dda42ad4d68e0c1 [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
Aneesh Vbcae7212011-07-21 09:10:21 -04009#include <common.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>
Aneesh Vbcae7212011-07-21 09:10:21 -040026#include <asm/u-boot.h>
Simon Schwarzbb085b82011-09-14 15:29:26 -040027#include <nand.h>
Aneesh V8cf686e2011-07-21 09:10:27 -040028#include <fat.h>
Simon Glass3db71102019-11-14 12:57:16 -070029#include <u-boot/crc.h>
Pali Rohár121a1652021-08-02 15:18:38 +020030#if CONFIG_IS_ENABLED(BANNER_PRINT)
31#include <timestamp.h>
32#endif
Simon Glassefb21722011-10-10 08:55:19 +000033#include <version.h>
Aneesh V8cf686e2011-07-21 09:10:27 -040034#include <image.h>
Aneesh V2d01dd92011-10-21 12:29:34 -040035#include <malloc.h>
Simon Glass31f9f0e2019-10-21 17:26:52 -060036#include <mapmem.h>
Simon Glass11516512014-11-10 17:16:46 -070037#include <dm/root.h>
Simon Glass4f6500a2022-05-08 04:39:27 -060038#include <dm/util.h>
Nikhil M Jain7a17e4c2023-04-10 14:19:13 +053039#include <dm/device-internal.h>
40#include <dm/uclass-internal.h>
Andreas Müller761ca312012-01-04 15:26:24 +000041#include <linux/compiler.h>
B, Ravi6e7585b2017-04-18 17:27:27 +053042#include <fdt_support.h>
Lukasz Majewskia8be2492018-05-02 16:10:54 +020043#include <bootcount.h>
Stefan Roese06985282019-04-11 15:58:44 +020044#include <wdt.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 Glassd6330062018-11-15 18:43:56 -0700100 puts(SPL_TPL_PROMPT
101 "Please implement spl_start_uboot() for your board\n");
102 puts(SPL_TPL_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 Glassd6330062018-11-15 18:43:56 -0700143 printf(SPL_TPL_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 Glassd6330062018-11-15 18:43:56 -0700149 printf(SPL_TPL_PROMPT "arch_fixup_fdt err - %d\n", err);
B, Ravi6e7585b2017-04-18 17:27:27 +0530150 return;
151 }
152#endif
153}
154
Simon Glasse82c6242019-12-08 17:40:12 -0700155ulong spl_get_image_pos(void)
156{
Alper Nebi Yasakd8830cf2022-06-18 15:13:09 +0300157 if (!CONFIG_IS_ENABLED(BINMAN_UBOOT_SYMBOLS))
Alper Nebi Yasakd7f07172022-06-18 15:13:06 +0300158 return BINMAN_SYM_MISSING;
159
Simon Glassf86ca5a2022-04-30 00:56:52 -0600160#ifdef CONFIG_VPL
161 if (spl_next_phase() == PHASE_VPL)
Simon Glass2b8d2cc2022-10-20 18:22:41 -0600162 return binman_sym(ulong, u_boot_vpl_any, image_pos);
Simon Glassf86ca5a2022-04-30 00:56:52 -0600163#endif
164 return spl_next_phase() == PHASE_SPL ?
Simon Glass2b8d2cc2022-10-20 18:22:41 -0600165 binman_sym(ulong, u_boot_spl_any, image_pos) :
Simon Glasse82c6242019-12-08 17:40:12 -0700166 binman_sym(ulong, u_boot_any, image_pos);
167}
168
169ulong spl_get_image_size(void)
170{
Alper Nebi Yasakd8830cf2022-06-18 15:13:09 +0300171 if (!CONFIG_IS_ENABLED(BINMAN_UBOOT_SYMBOLS))
Alper Nebi Yasakd7f07172022-06-18 15:13:06 +0300172 return BINMAN_SYM_MISSING;
173
Simon Glassf86ca5a2022-04-30 00:56:52 -0600174#ifdef CONFIG_VPL
175 if (spl_next_phase() == PHASE_VPL)
Simon Glass2b8d2cc2022-10-20 18:22:41 -0600176 return binman_sym(ulong, u_boot_vpl_any, size);
Simon Glassf86ca5a2022-04-30 00:56:52 -0600177#endif
178 return spl_next_phase() == PHASE_SPL ?
Simon Glass2b8d2cc2022-10-20 18:22:41 -0600179 binman_sym(ulong, u_boot_spl_any, size) :
Simon Glasse82c6242019-12-08 17:40:12 -0700180 binman_sym(ulong, u_boot_any, size);
181}
182
Simon Glass86c372a2021-01-24 10:06:03 -0700183ulong spl_get_image_text_base(void)
184{
Simon Glassf86ca5a2022-04-30 00:56:52 -0600185#ifdef CONFIG_VPL
186 if (spl_next_phase() == PHASE_VPL)
187 return CONFIG_VPL_TEXT_BASE;
188#endif
189 return spl_next_phase() == PHASE_SPL ? CONFIG_SPL_TEXT_BASE :
Simon Glass98463902022-10-20 18:22:39 -0600190 CONFIG_TEXT_BASE;
Simon Glass86c372a2021-01-24 10:06:03 -0700191}
192
Stefan Roeseea8256f2012-08-23 08:34:21 +0200193/*
194 * Weak default function for board specific cleanup/preparation before
195 * Linux boot. Some boards/platforms might not need it, so just provide
196 * an empty stub here.
197 */
198__weak void spl_board_prepare_for_linux(void)
199{
200 /* Nothing to do! */
201}
202
Alexandru Gagniuca25d6b62021-07-15 14:19:24 -0500203__weak void spl_board_prepare_for_optee(void *fdt)
204{
205}
206
Heiko Thieryc5922922022-01-17 16:25:41 +0100207__weak const char *spl_board_loader_name(u32 boot_device)
208{
209 return NULL;
210}
211
Ricardo Salveti949eb222021-10-20 15:12:06 +0300212#if CONFIG_IS_ENABLED(OPTEE_IMAGE)
213__weak void __noreturn jump_to_image_optee(struct spl_image_info *spl_image)
214{
215 spl_optee_entry(NULL, NULL, spl_image->fdt_addr,
216 (void *)spl_image->entry_point);
217}
218#endif
219
Michal Simek3a3b9142016-05-10 07:54:20 +0200220__weak void spl_board_prepare_for_boot(void)
221{
222 /* Nothing to do! */
223}
224
Simon Glassf3543e62022-09-06 20:26:52 -0600225__weak struct legacy_img_hdr *spl_get_load_buffer(ssize_t offset, size_t size)
Marek Vasut04ce5422018-08-14 11:27:02 +0200226{
Simon Glass98463902022-10-20 18:22:39 -0600227 return map_sysmem(CONFIG_TEXT_BASE + offset, 0);
Marek Vasut04ce5422018-08-14 11:27:02 +0200228}
229
Tom Rini08574ed2022-10-28 20:27:07 -0400230#ifdef CONFIG_SPL_RAW_IMAGE_SUPPORT
Simon Glassd95ceb92016-09-24 18:19:52 -0600231void spl_set_header_raw_uboot(struct spl_image_info *spl_image)
Heiko Schocher0c3117b2014-10-31 08:31:00 +0100232{
Alper Nebi Yasakd7f07172022-06-18 15:13:06 +0300233 ulong u_boot_pos = spl_get_image_pos();
Simon Glass8bee2d22017-11-13 18:55:03 -0700234
Tom Rini08574ed2022-10-28 20:27:07 -0400235#if CONFIG_SYS_MONITOR_LEN != 0
Simon Glassd95ceb92016-09-24 18:19:52 -0600236 spl_image->size = CONFIG_SYS_MONITOR_LEN;
Tom Rini08574ed2022-10-28 20:27:07 -0400237#else
238 /* Unknown U-Boot size, let's assume it will not be more than 200 KB */
239 spl_image->size = 200 * 1024;
240#endif
Miquel Raynal55fe0e22018-02-28 20:51:43 +0100241
242 /*
243 * Binman error cases: address of the end of the previous region or the
244 * start of the image's entry area (usually 0) if there is no previous
245 * region.
246 */
247 if (u_boot_pos && u_boot_pos != BINMAN_SYM_MISSING) {
248 /* Binman does not support separated entry addresses */
Simon Glass8bee2d22017-11-13 18:55:03 -0700249 spl_image->entry_point = u_boot_pos;
250 spl_image->load_addr = u_boot_pos;
251 } else {
Jesse Taube6ab77bb2023-08-24 21:59:48 -0400252 spl_image->entry_point = CONFIG_SYS_UBOOT_START;
Simon Glass98463902022-10-20 18:22:39 -0600253 spl_image->load_addr = CONFIG_TEXT_BASE;
Simon Glass8bee2d22017-11-13 18:55:03 -0700254 }
Simon Glassd95ceb92016-09-24 18:19:52 -0600255 spl_image->os = IH_OS_U_BOOT;
256 spl_image->name = "U-Boot";
Heiko Schocher0c3117b2014-10-31 08:31:00 +0100257}
Tom Rini08574ed2022-10-28 20:27:07 -0400258#endif
Heiko Schocher0c3117b2014-10-31 08:31:00 +0100259
Pali Rohár9baab602021-07-23 11:14:28 +0200260__weak int spl_parse_board_header(struct spl_image_info *spl_image,
Pali Rohár2e0429b2022-01-14 14:31:38 +0100261 const struct spl_boot_device *bootdev,
Pali Rohár9baab602021-07-23 11:14:28 +0200262 const void *image_header, size_t size)
263{
264 return -EINVAL;
265}
266
Stefan Roesec1108172020-04-21 09:28:41 +0200267__weak int spl_parse_legacy_header(struct spl_image_info *spl_image,
Simon Glassf3543e62022-09-06 20:26:52 -0600268 const struct legacy_img_hdr *header)
Stefan Roesec1108172020-04-21 09:28:41 +0200269{
270 /* LEGACY image not supported */
271 debug("Legacy boot image support not enabled, proceeding to other boot methods\n");
272 return -EINVAL;
273}
274
Simon Glass71316c12016-09-24 18:19:53 -0600275int spl_parse_image_header(struct spl_image_info *spl_image,
Pali Rohár2e0429b2022-01-14 14:31:38 +0100276 const struct spl_boot_device *bootdev,
Simon Glassf3543e62022-09-06 20:26:52 -0600277 const struct legacy_img_hdr *header)
Aneesh V8cf686e2011-07-21 09:10:27 -0400278{
Simon Glass035ab462023-09-26 08:14:34 -0600279 int ret;
Marek Vasut8a9dc162018-05-13 00:23:17 +0200280
Simon Glass035ab462023-09-26 08:14:34 -0600281 if (CONFIG_IS_ENABLED(LOAD_FIT_FULL)) {
282 ret = spl_load_fit_image(spl_image, header);
283
284 if (!ret)
285 return ret;
286 }
Stefan Roese77552b02012-08-27 12:50:57 +0200287 if (image_get_magic(header) == IH_MAGIC) {
Stefan Roesec1108172020-04-21 09:28:41 +0200288 int ret;
Andrew F. Davis722a6b12017-02-16 11:18:39 -0600289
Stefan Roesec1108172020-04-21 09:28:41 +0200290 ret = spl_parse_legacy_header(spl_image, header);
291 if (ret)
292 return ret;
Aneesh V8cf686e2011-07-21 09:10:27 -0400293 } else {
Albert ARIBAUD \(3ADEV\)8c80eb32015-03-31 11:40:50 +0200294#ifdef CONFIG_SPL_PANIC_ON_RAW_IMAGE
295 /*
296 * CONFIG_SPL_PANIC_ON_RAW_IMAGE is defined when the
297 * code which loads images in SPL cannot guarantee that
298 * absolutely all read errors will be reported.
299 * An example is the LPC32XX MLC NAND driver, which
300 * will consider that a completely unreadable NAND block
301 * is bad, and thus should be skipped silently.
302 */
303 panic("** no mkimage signature but raw image not supported");
Paul Kocialkowski85a37722016-08-24 20:04:42 +0200304#endif
305
Tom Rini71150072021-10-30 23:03:48 -0400306#if CONFIG_IS_ENABLED(OS_BOOT)
Nathan Barrett-Morrison7a0d8802022-02-02 15:05:18 -0500307#if defined(CMD_BOOTI)
308 ulong start, size;
309
310 if (!booti_setup((ulong)header, &start, &size, 0)) {
311 spl_image->name = "Linux";
312 spl_image->os = IH_OS_LINUX;
313 spl_image->load_addr = start;
314 spl_image->entry_point = start;
315 spl_image->size = size;
316 debug(SPL_TPL_PROMPT
317 "payload Image, load addr: 0x%lx size: %d\n",
318 spl_image->load_addr, spl_image->size);
319 return 0;
320 }
321#elif defined(CMD_BOOTZ)
Ladislav Michl431889d2016-07-12 20:28:14 +0200322 ulong start, end;
323
324 if (!bootz_setup((ulong)header, &start, &end)) {
Simon Glass71316c12016-09-24 18:19:53 -0600325 spl_image->name = "Linux";
326 spl_image->os = IH_OS_LINUX;
327 spl_image->load_addr = CONFIG_SYS_LOAD_ADDR;
328 spl_image->entry_point = CONFIG_SYS_LOAD_ADDR;
329 spl_image->size = end - start;
Simon Glassd6330062018-11-15 18:43:56 -0700330 debug(SPL_TPL_PROMPT
331 "payload zImage, load addr: 0x%lx size: %d\n",
Simon Glass71316c12016-09-24 18:19:53 -0600332 spl_image->load_addr, spl_image->size);
Ladislav Michl431889d2016-07-12 20:28:14 +0200333 return 0;
334 }
335#endif
Nathan Barrett-Morrison7a0d8802022-02-02 15:05:18 -0500336#endif
Paul Kocialkowski85a37722016-08-24 20:04:42 +0200337
Pali Rohár2e0429b2022-01-14 14:31:38 +0100338 if (!spl_parse_board_header(spl_image, bootdev, (const void *)header, sizeof(*header)))
Pali Rohár9baab602021-07-23 11:14:28 +0200339 return 0;
340
Andrew F. Davis24eb39b2017-02-16 11:18:38 -0600341#ifdef CONFIG_SPL_RAW_IMAGE_SUPPORT
Aneesh V8cf686e2011-07-21 09:10:27 -0400342 /* Signature not found - assume u-boot.bin */
Tom Rini026b2fe2012-08-14 12:06:43 -0700343 debug("mkimage signature not found - ih_magic = %x\n",
Aneesh V8cf686e2011-07-21 09:10:27 -0400344 header->ih_magic);
Simon Glass71316c12016-09-24 18:19:53 -0600345 spl_set_header_raw_uboot(spl_image);
Andrew F. Davis24eb39b2017-02-16 11:18:38 -0600346#else
347 /* RAW image not supported, proceed to other boot methods. */
Anatolij Gustschin2d2531b2017-08-01 16:17:12 +0200348 debug("Raw boot image support not enabled, proceeding to other boot methods\n");
Andrew F. Davis24eb39b2017-02-16 11:18:38 -0600349 return -EINVAL;
Albert ARIBAUD \(3ADEV\)8c80eb32015-03-31 11:40:50 +0200350#endif
Aneesh V8cf686e2011-07-21 09:10:27 -0400351 }
Andrew F. Davis24eb39b2017-02-16 11:18:38 -0600352
Marek Vasut7e0f2262016-04-29 00:44:54 +0200353 return 0;
Aneesh V8cf686e2011-07-21 09:10:27 -0400354}
355
Sean Anderson77507412023-11-08 11:48:47 -0500356#if SPL_LOAD_USERS > 1
357int spl_load(struct spl_image_info *spl_image,
358 const struct spl_boot_device *bootdev, struct spl_load_info *info,
359 size_t size, size_t offset)
360{
361 return _spl_load(spl_image, bootdev, info, size, offset);
362}
363#endif
364
Allen Martina759f1e2012-10-19 21:08:22 +0000365__weak void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image)
Aneesh V8cf686e2011-07-21 09:10:27 -0400366{
SRICHARAN R4a0eb752013-04-24 00:41:24 +0000367 typedef void __noreturn (*image_entry_noargs_t)(void);
368
Aneesh V8cf686e2011-07-21 09:10:27 -0400369 image_entry_noargs_t image_entry =
Andre Przywara11e14792017-01-02 11:48:31 +0000370 (image_entry_noargs_t)spl_image->entry_point;
Aneesh V8cf686e2011-07-21 09:10:27 -0400371
Simon Goldschmidt30c07402018-11-02 21:49:52 +0100372 debug("image entry point: 0x%lx\n", spl_image->entry_point);
SRICHARAN R4a0eb752013-04-24 00:41:24 +0000373 image_entry();
Aneesh V8cf686e2011-07-21 09:10:27 -0400374}
375
Simon Glassb0edea32018-11-15 18:44:09 -0700376#if CONFIG_IS_ENABLED(HANDOFF)
377/**
378 * Set up the SPL hand-off information
379 *
380 * This is initially empty (zero) but can be written by
381 */
382static int setup_spl_handoff(void)
383{
384 struct spl_handoff *ho;
385
Simon Glass7f3b79a2022-01-12 19:26:17 -0700386 ho = bloblist_ensure(BLOBLISTT_U_BOOT_SPL_HANDOFF, sizeof(struct spl_handoff));
Simon Glassb0edea32018-11-15 18:44:09 -0700387 if (!ho)
388 return -ENOENT;
389
390 return 0;
391}
392
Simon Glass366291a2019-09-25 08:11:18 -0600393__weak int handoff_arch_save(struct spl_handoff *ho)
394{
395 return 0;
396}
397
Simon Glassb0edea32018-11-15 18:44:09 -0700398static int write_spl_handoff(void)
399{
400 struct spl_handoff *ho;
Simon Glass366291a2019-09-25 08:11:18 -0600401 int ret;
Simon Glassb0edea32018-11-15 18:44:09 -0700402
Simon Glass7f3b79a2022-01-12 19:26:17 -0700403 ho = bloblist_find(BLOBLISTT_U_BOOT_SPL_HANDOFF, sizeof(struct spl_handoff));
Simon Glassb0edea32018-11-15 18:44:09 -0700404 if (!ho)
405 return -ENOENT;
406 handoff_save_dram(ho);
Simon Glass366291a2019-09-25 08:11:18 -0600407 ret = handoff_arch_save(ho);
408 if (ret)
409 return ret;
Simon Glassb0edea32018-11-15 18:44:09 -0700410 debug(SPL_TPL_PROMPT "Wrote SPL handoff\n");
411
412 return 0;
413}
414#else
415static inline int setup_spl_handoff(void) { return 0; }
416static inline int write_spl_handoff(void) { return 0; }
417
418#endif /* HANDOFF */
419
Simon Glass05e3a0d2021-03-15 18:11:15 +1300420/**
421 * get_bootstage_id() - Get the bootstage ID to emit
422 *
423 * @start: true if this is for starting SPL, false for ending it
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100424 * Return: bootstage ID to use
Simon Glass05e3a0d2021-03-15 18:11:15 +1300425 */
426static enum bootstage_id get_bootstage_id(bool start)
427{
428 enum u_boot_phase phase = spl_phase();
429
430 if (IS_ENABLED(CONFIG_TPL_BUILD) && phase == PHASE_TPL)
431 return start ? BOOTSTAGE_ID_START_TPL : BOOTSTAGE_ID_END_TPL;
Simon Glassf86ca5a2022-04-30 00:56:52 -0600432 else if (IS_ENABLED(CONFIG_VPL_BUILD) && phase == PHASE_VPL)
433 return start ? BOOTSTAGE_ID_START_VPL : BOOTSTAGE_ID_END_VPL;
Simon Glass05e3a0d2021-03-15 18:11:15 +1300434 else
435 return start ? BOOTSTAGE_ID_START_SPL : BOOTSTAGE_ID_END_SPL;
436}
437
Eddie Cai340f4182017-03-15 08:43:28 -0600438static int spl_common_init(bool setup_malloc)
Aneesh Vbcae7212011-07-21 09:10:21 -0400439{
Simon Glassf3d46bd2015-02-27 22:06:42 -0700440 int ret;
441
Simon Glass3d6d5072023-09-26 08:14:27 -0600442#if CONFIG_IS_ENABLED(SYS_MALLOC_F)
Eddie Cai340f4182017-03-15 08:43:28 -0600443 if (setup_malloc) {
Tom Rinidd5b58c2022-12-04 10:04:49 -0500444#ifdef CFG_MALLOC_F_ADDR
445 gd->malloc_base = CFG_MALLOC_F_ADDR;
Marek Vasut94b9e222016-05-25 02:14:56 +0200446#endif
Andy Yanf1896c42017-07-24 17:43:34 +0800447 gd->malloc_limit = CONFIG_VAL(SYS_MALLOC_F_LEN);
Eddie Cai340f4182017-03-15 08:43:28 -0600448 gd->malloc_ptr = 0;
449 }
Tom Rini24dafad2012-08-13 14:13:07 -0700450#endif
Simon Glass31f9f0e2019-10-21 17:26:52 -0600451 ret = bootstage_init(u_boot_first_phase());
Simon Glass824bb1b2017-05-22 05:05:35 -0600452 if (ret) {
453 debug("%s: Failed to set up bootstage: ret=%d\n", __func__,
454 ret);
455 return ret;
456 }
Simon Glass31f9f0e2019-10-21 17:26:52 -0600457 if (!u_boot_first_phase()) {
Simon Glass17ba5012023-09-26 08:14:32 -0600458 ret = bootstage_unstash_default();
Simon Glass31f9f0e2019-10-21 17:26:52 -0600459 if (ret)
Simon Glass17ba5012023-09-26 08:14:32 -0600460 log_debug("Failed to unstash bootstage: ret=%d\n", ret);
Simon Glass31f9f0e2019-10-21 17:26:52 -0600461 }
Simon Glass05e3a0d2021-03-15 18:11:15 +1300462 bootstage_mark_name(get_bootstage_id(true),
463 spl_phase_name(spl_phase()));
Simon Glass4d8d3052018-11-15 18:43:49 -0700464#if CONFIG_IS_ENABLED(LOG)
465 ret = log_init();
466 if (ret) {
467 debug("%s: Failed to set up logging\n", __func__);
468 return ret;
469 }
470#endif
Simon Glass414cc152021-08-07 07:24:03 -0600471 if (CONFIG_IS_ENABLED(OF_REAL)) {
Simon Glassf3d46bd2015-02-27 22:06:42 -0700472 ret = fdtdec_setup();
473 if (ret) {
474 debug("fdtdec_setup() returned error %d\n", ret);
Simon Glass070d00b2015-06-23 15:39:10 -0600475 return ret;
Simon Glassf3d46bd2015-02-27 22:06:42 -0700476 }
477 }
Philipp Tomsichf1c6e192017-06-30 19:02:53 +0200478 if (CONFIG_IS_ENABLED(DM)) {
Simon Glassb67eefd2020-05-10 11:39:59 -0600479 bootstage_start(BOOTSTAGE_ID_ACCUM_DM_SPL,
Simon Glass5256bee2019-10-21 17:26:51 -0600480 spl_phase() == PHASE_TPL ? "dm tpl" : "dm_spl");
Tom Rini7f73ca42017-01-14 12:20:23 -0500481 /* With CONFIG_SPL_OF_PLATDATA, bring in all devices */
Simon Glass7d23b9c2016-07-04 11:58:14 -0600482 ret = dm_init_and_scan(!CONFIG_IS_ENABLED(OF_PLATDATA));
Simon Glassb67eefd2020-05-10 11:39:59 -0600483 bootstage_accum(BOOTSTAGE_ID_ACCUM_DM_SPL);
Simon Glassf3d46bd2015-02-27 22:06:42 -0700484 if (ret) {
485 debug("dm_init_and_scan() returned error %d\n", ret);
Simon Glass070d00b2015-06-23 15:39:10 -0600486 return ret;
Simon Glassf3d46bd2015-02-27 22:06:42 -0700487 }
488 }
Eddie Cai340f4182017-03-15 08:43:28 -0600489
490 return 0;
491}
492
Alexandru Gagniuc58b504e2021-04-08 11:56:11 -0500493void spl_set_bd(void)
York Sund1fc0a32017-09-28 08:42:10 -0700494{
Simon Glassc21f4072018-11-15 18:43:58 -0700495 /*
496 * NOTE: On some platforms (e.g. x86) bdata may be in flash and not
497 * writeable.
498 */
Alexandru Gagniuc58b504e2021-04-08 11:56:11 -0500499 if (!gd->bd)
500 gd->bd = &bdata;
York Sund1fc0a32017-09-28 08:42:10 -0700501}
502
Eddie Cai340f4182017-03-15 08:43:28 -0600503int spl_early_init(void)
504{
505 int ret;
506
Simon Goldschmidt94cb9862018-08-13 11:24:05 +0200507 debug("%s\n", __func__);
508
Eddie Cai340f4182017-03-15 08:43:28 -0600509 ret = spl_common_init(true);
510 if (ret)
511 return ret;
512 gd->flags |= GD_FLG_SPL_EARLY_INIT;
513
514 return 0;
515}
516
517int spl_init(void)
518{
519 int ret;
Tom Rinicf334ed2017-03-20 14:19:27 -0400520 bool setup_malloc = !(IS_ENABLED(CONFIG_SPL_STACK_R) &&
521 IS_ENABLED(CONFIG_SPL_SYS_MALLOC_SIMPLE));
Eddie Cai340f4182017-03-15 08:43:28 -0600522
Simon Goldschmidt94cb9862018-08-13 11:24:05 +0200523 debug("%s\n", __func__);
524
Eddie Cai340f4182017-03-15 08:43:28 -0600525 if (!(gd->flags & GD_FLG_SPL_EARLY_INIT)) {
Tom Rinicf334ed2017-03-20 14:19:27 -0400526 ret = spl_common_init(setup_malloc);
Eddie Cai340f4182017-03-15 08:43:28 -0600527 if (ret)
528 return ret;
529 }
Simon Glass070d00b2015-06-23 15:39:10 -0600530 gd->flags |= GD_FLG_SPL_INIT;
Aneesh V2d01dd92011-10-21 12:29:34 -0400531
Simon Glass070d00b2015-06-23 15:39:10 -0600532 return 0;
533}
534
Nikita Kiryanovf101e4b2015-11-08 17:11:51 +0200535#ifndef BOOT_DEVICE_NONE
536#define BOOT_DEVICE_NONE 0xdeadbeef
537#endif
538
Nikita Kiryanovf101e4b2015-11-08 17:11:51 +0200539__weak void board_boot_order(u32 *spl_boot_list)
540{
541 spl_boot_list[0] = spl_boot_device();
542}
543
Pali Rohárc10939d2022-01-14 14:31:40 +0100544__weak int spl_check_board_image(struct spl_image_info *spl_image,
545 const struct spl_boot_device *bootdev)
546{
547 return 0;
548}
549
Simon Glass29d357d2016-11-30 15:30:52 -0700550static int spl_load_image(struct spl_image_info *spl_image,
551 struct spl_image_loader *loader)
Nikita Kiryanov5211b872015-11-08 17:11:50 +0200552{
Simon Goldschmidtdae5c2d2019-02-10 21:34:37 +0100553 int ret;
Simon Glassecdfd692016-09-24 18:19:57 -0600554 struct spl_boot_device bootdev;
555
Simon Glass29d357d2016-11-30 15:30:52 -0700556 bootdev.boot_device = loader->boot_device;
Simon Glassecdfd692016-09-24 18:19:57 -0600557 bootdev.boot_device_name = NULL;
558
Simon Goldschmidtdae5c2d2019-02-10 21:34:37 +0100559 ret = loader->load_image(spl_image, &bootdev);
560#ifdef CONFIG_SPL_LEGACY_IMAGE_CRC_CHECK
561 if (!ret && spl_image->dcrc_length) {
562 /* check data crc */
563 ulong dcrc = crc32_wd(0, (unsigned char *)spl_image->dcrc_data,
564 spl_image->dcrc_length, CHUNKSZ_CRC32);
565 if (dcrc != spl_image->dcrc) {
566 puts("SPL: Image data CRC check failed!\n");
567 ret = -EINVAL;
568 }
569 }
570#endif
Pali Rohárc10939d2022-01-14 14:31:40 +0100571 if (!ret)
572 ret = spl_check_board_image(spl_image, &bootdev);
573
Simon Goldschmidtdae5c2d2019-02-10 21:34:37 +0100574 return ret;
Simon Glass540bfe72016-11-30 15:30:51 -0700575}
576
577/**
Miquel Raynalfd4ee982019-05-07 14:18:43 +0200578 * boot_from_devices() - Try loading a booting U-Boot from a list of devices
Simon Glass540bfe72016-11-30 15:30:51 -0700579 *
580 * @spl_image: Place to put the image details if successful
581 * @spl_boot_list: List of boot devices to try
582 * @count: Number of elements in spl_boot_list
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100583 * Return: 0 if OK, -ENODEV if there were no boot devices
Simon Glass7d84fbb2021-07-05 16:32:57 -0600584 * if CONFIG_SHOW_ERRORS is enabled, returns -ENXIO if there were
585 * devices but none worked
Simon Glass540bfe72016-11-30 15:30:51 -0700586 */
587static int boot_from_devices(struct spl_image_info *spl_image,
588 u32 spl_boot_list[], int count)
589{
Simon Glass5a61bf12022-10-20 18:23:07 -0600590 struct spl_image_loader *drv =
591 ll_entry_start(struct spl_image_loader, spl_image_loader);
592 const int n_ents =
593 ll_entry_count(struct spl_image_loader, spl_image_loader);
Simon Glass7d84fbb2021-07-05 16:32:57 -0600594 int ret = -ENODEV;
Simon Glass540bfe72016-11-30 15:30:51 -0700595 int i;
596
597 for (i = 0; i < count && spl_boot_list[i] != BOOT_DEVICE_NONE; i++) {
598 struct spl_image_loader *loader;
Simon Glass7d84fbb2021-07-05 16:32:57 -0600599 int bootdev = spl_boot_list[i];
Simon Glass540bfe72016-11-30 15:30:51 -0700600
Simon Glass7d84fbb2021-07-05 16:32:57 -0600601 if (CONFIG_IS_ENABLED(SHOW_ERRORS))
602 ret = -ENXIO;
Simon Glass5a61bf12022-10-20 18:23:07 -0600603 for (loader = drv; loader != drv + n_ents; loader++) {
604 if (bootdev != loader->boot_device)
605 continue;
606 if (!CONFIG_IS_ENABLED(SILENT_CONSOLE)) {
607 if (loader)
608 printf("Trying to boot from %s\n",
609 spl_loader_name(loader));
610 else if (CONFIG_IS_ENABLED(SHOW_ERRORS)) {
611 printf(SPL_TPL_PROMPT
612 "Unsupported Boot Device %d\n",
613 bootdev);
614 } else {
615 puts(SPL_TPL_PROMPT
616 "Unsupported Boot Device!\n");
617 }
618 }
619 if (loader &&
620 !spl_load_image(spl_image, loader)) {
621 spl_image->boot_device = bootdev;
622 return 0;
623 }
Philipp Tomsichde5dd4c2018-05-24 17:15:50 +0200624 }
Simon Glass540bfe72016-11-30 15:30:51 -0700625 }
626
Simon Glass7d84fbb2021-07-05 16:32:57 -0600627 return ret;
Nikita Kiryanov5211b872015-11-08 17:11:50 +0200628}
629
Philippe Reynesa9a3aad2019-09-19 16:18:39 +0200630#if defined(CONFIG_SPL_FRAMEWORK_BOARD_INIT_F)
631void board_init_f(ulong dummy)
632{
633 if (CONFIG_IS_ENABLED(OF_CONTROL)) {
634 int ret;
635
636 ret = spl_early_init();
637 if (ret) {
638 debug("spl_early_init() failed: %d\n", ret);
639 hang();
640 }
641 }
642
Samuel Holland3988be52020-05-07 18:08:10 -0500643 preloader_console_init();
Philippe Reynesa9a3aad2019-09-19 16:18:39 +0200644}
645#endif
646
Simon Glass070d00b2015-06-23 15:39:10 -0600647void board_init_r(gd_t *dummy1, ulong dummy2)
648{
Simon Glassd32b2d12016-09-24 18:20:17 -0600649 u32 spl_boot_list[] = {
650 BOOT_DEVICE_NONE,
651 BOOT_DEVICE_NONE,
652 BOOT_DEVICE_NONE,
653 BOOT_DEVICE_NONE,
654 BOOT_DEVICE_NONE,
655 };
Jonas Karlman6826c432023-09-27 21:44:13 +0000656 typedef void __noreturn (*jump_to_image_t)(struct spl_image_info *);
657 jump_to_image_t jump_to_image = &jump_to_image_no_args;
Simon Glassd32b2d12016-09-24 18:20:17 -0600658 struct spl_image_info spl_image;
Simon Glassf817e082023-09-26 08:14:22 -0600659 int ret, os;
Simon Glass070d00b2015-06-23 15:39:10 -0600660
Simon Glassd6330062018-11-15 18:43:56 -0700661 debug(">>" SPL_TPL_PROMPT "board_init_r()\n");
York Sund1fc0a32017-09-28 08:42:10 -0700662
Alexandru Gagniuc58b504e2021-04-08 11:56:11 -0500663 spl_set_bd();
664
Simon Glass52779872023-09-26 08:14:18 -0600665 if (IS_ENABLED(CONFIG_SPL_SYS_MALLOC)) {
Sean Andersonb02c4e92023-10-14 16:47:55 -0400666 mem_malloc_init((ulong)map_sysmem(SPL_SYS_MALLOC_START,
667 SPL_SYS_MALLOC_SIZE),
668 SPL_SYS_MALLOC_SIZE);
Simon Glass52779872023-09-26 08:14:18 -0600669 gd->flags |= GD_FLG_FULL_MALLOC_INIT;
670 }
Simon Glass070d00b2015-06-23 15:39:10 -0600671 if (!(gd->flags & GD_FLG_SPL_INIT)) {
672 if (spl_init())
673 hang();
674 }
Ilya Yanok4063c772012-09-17 10:26:26 +0000675 timer_init();
Simon Glass3cd71982019-09-25 08:11:19 -0600676 if (CONFIG_IS_ENABLED(BLOBLIST)) {
677 ret = bloblist_init();
678 if (ret) {
679 debug("%s: Failed to set up bloblist: ret=%d\n",
680 __func__, ret);
681 puts(SPL_TPL_PROMPT "Cannot set up bloblist\n");
682 hang();
683 }
684 }
685 if (CONFIG_IS_ENABLED(HANDOFF)) {
686 int ret;
687
688 ret = setup_spl_handoff();
689 if (ret) {
690 puts(SPL_TPL_PROMPT "Cannot set up SPL handoff\n");
691 hang();
692 }
693 }
Ilya Yanok4063c772012-09-17 10:26:26 +0000694
Simon Glass6371c472023-09-26 08:14:20 -0600695 if (CONFIG_IS_ENABLED(BOARD_INIT))
696 spl_board_init();
Tom Riniee08a822011-11-23 05:13:06 +0000697
Simon Glass6371c472023-09-26 08:14:20 -0600698 if (IS_ENABLED(CONFIG_SPL_WATCHDOG) && CONFIG_IS_ENABLED(WDT))
699 initr_watchdog();
Stefan Roese06985282019-04-11 15:58:44 +0200700
Heiko Stuebnera343b4f2020-05-25 19:57:25 +0200701 if (IS_ENABLED(CONFIG_SPL_OS_BOOT) || CONFIG_IS_ENABLED(HANDOFF) ||
702 IS_ENABLED(CONFIG_SPL_ATF))
Simon Glassb0edea32018-11-15 18:44:09 -0700703 dram_init_banksize();
704
Simon Glass15a23b62023-09-07 09:58:13 -0600705 if (CONFIG_IS_ENABLED(PCI) && !(gd->flags & GD_FLG_DM_DEAD)) {
Heinrich Schuchardt7d4c8cf2023-07-24 22:18:41 +0200706 ret = pci_init();
707 if (ret)
708 puts(SPL_TPL_PROMPT "Cannot initialize PCI\n");
709 /* Don't fail. We still can try other boot methods. */
710 }
711
Lukasz Majewskia8be2492018-05-02 16:10:54 +0200712 bootcount_inc();
713
Simon Glass4f6500a2022-05-08 04:39:27 -0600714 /* Dump driver model states to aid analysis */
715 if (CONFIG_IS_ENABLED(DM_STATS)) {
716 struct dm_stats mem;
717
718 dm_get_mem(&mem);
719 dm_dump_mem(&mem);
720 }
721
Simon Glassd32b2d12016-09-24 18:20:17 -0600722 memset(&spl_image, '\0', sizeof(spl_image));
Simon Glasse0be6ea2023-09-26 08:14:21 -0600723 if (IS_ENABLED(CONFIG_SPL_OS_BOOT))
724 spl_image.arg = (void *)SPL_PAYLOAD_ARGS_ADDR;
Philipp Tomsichde5dd4c2018-05-24 17:15:50 +0200725 spl_image.boot_device = BOOT_DEVICE_NONE;
Nikita Kiryanovf101e4b2015-11-08 17:11:51 +0200726 board_boot_order(spl_boot_list);
Nikita Kiryanovf101e4b2015-11-08 17:11:51 +0200727
Simon Glass7d84fbb2021-07-05 16:32:57 -0600728 ret = boot_from_devices(&spl_image, spl_boot_list,
729 ARRAY_SIZE(spl_boot_list));
730 if (ret) {
Sean Anderson06b1bca2023-11-08 11:48:35 -0500731 if (CONFIG_IS_ENABLED(SHOW_ERRORS))
Simon Glass7d84fbb2021-07-05 16:32:57 -0600732 printf(SPL_TPL_PROMPT "failed to boot from all boot devices (err=%d)\n",
733 ret);
734 else
735 puts(SPL_TPL_PROMPT "failed to boot from all boot devices\n");
Aneesh V8cf686e2011-07-21 09:10:27 -0400736 hang();
Nikita Kiryanovf101e4b2015-11-08 17:11:51 +0200737 }
Aneesh V8cf686e2011-07-21 09:10:27 -0400738
Philipp Tomsichde5dd4c2018-05-24 17:15:50 +0200739 spl_perform_fixups(&spl_image);
740
Simon Glassf817e082023-09-26 08:14:22 -0600741 os = spl_image.os;
742 if (os == IH_OS_U_BOOT) {
Simon Glass1a9e75b2021-02-06 09:57:27 -0700743 debug("Jumping to %s...\n", spl_phase_name(spl_next_phase()));
Simon Glassf817e082023-09-26 08:14:22 -0600744 } else if (CONFIG_IS_ENABLED(ATF) && os == IH_OS_ARM_TRUSTED_FIRMWARE) {
Philipp Tomsich1d379092017-09-13 21:29:35 +0200745 debug("Jumping to U-Boot via ARM Trusted Firmware\n");
Simon Glassf817e082023-09-26 08:14:22 -0600746 spl_fixup_fdt(spl_image_fdt_addr(&spl_image));
Jonas Karlman6826c432023-09-27 21:44:13 +0000747 jump_to_image = &spl_invoke_atf;
Simon Glassf817e082023-09-26 08:14:22 -0600748 } else if (CONFIG_IS_ENABLED(OPTEE_IMAGE) && os == IH_OS_TEE) {
Kever Yang70fe2872018-08-23 17:17:59 +0800749 debug("Jumping to U-Boot via OP-TEE\n");
Simon Glassf817e082023-09-26 08:14:22 -0600750 spl_board_prepare_for_optee(spl_image_fdt_addr(&spl_image));
Jonas Karlman6826c432023-09-27 21:44:13 +0000751 jump_to_image = &jump_to_image_optee;
Simon Glassf817e082023-09-26 08:14:22 -0600752 } else if (CONFIG_IS_ENABLED(OPENSBI) && os == IH_OS_OPENSBI) {
Lukas Auer5e30e452019-08-21 21:14:44 +0200753 debug("Jumping to U-Boot via RISC-V OpenSBI\n");
Jonas Karlman6826c432023-09-27 21:44:13 +0000754 jump_to_image = &spl_invoke_opensbi;
Simon Glassf817e082023-09-26 08:14:22 -0600755 } else if (CONFIG_IS_ENABLED(OS_BOOT) && os == IH_OS_LINUX) {
Simon Schwarz379c19a2012-03-15 04:01:38 +0000756 debug("Jumping to Linux\n");
Simon Glasse0be6ea2023-09-26 08:14:21 -0600757 if (IS_ENABLED(CONFIG_SPL_OS_BOOT))
758 spl_fixup_fdt((void *)SPL_PAYLOAD_ARGS_ADDR);
Simon Schwarz379c19a2012-03-15 04:01:38 +0000759 spl_board_prepare_for_linux();
Jonas Karlman6826c432023-09-27 21:44:13 +0000760 jump_to_image = &jump_to_image_linux;
Simon Glassf817e082023-09-26 08:14:22 -0600761 } else {
Tom Rini42120982012-08-27 14:58:28 -0700762 debug("Unsupported OS image.. Jumping nevertheless..\n");
Aneesh V8cf686e2011-07-21 09:10:27 -0400763 }
Simon Glass2003a832023-09-26 08:14:31 -0600764 if (CONFIG_IS_ENABLED(SYS_MALLOC_F) &&
765 !IS_ENABLED(CONFIG_SPL_SYS_MALLOC_SIZE))
766 debug("SPL malloc() used 0x%lx bytes (%ld KB)\n",
767 gd_malloc_ptr(), gd_malloc_ptr() / 1024);
768
Simon Glass05e3a0d2021-03-15 18:11:15 +1300769 bootstage_mark_name(get_bootstage_id(false), "end phase");
Simon Glass17ba5012023-09-26 08:14:32 -0600770 ret = bootstage_stash_default();
Simon Glass824bb1b2017-05-22 05:05:35 -0600771 if (ret)
772 debug("Failed to stash bootstage: err=%d\n", ret);
Kever Yanga8c51122017-09-13 18:24:24 +0800773
Nikhil M Jain954b0ad2023-07-18 14:27:33 +0530774 if (IS_ENABLED(CONFIG_SPL_VIDEO_REMOVE)) {
775 struct udevice *dev;
776 int rc;
Nikhil M Jain7a17e4c2023-04-10 14:19:13 +0530777
Nikhil M Jain954b0ad2023-07-18 14:27:33 +0530778 rc = uclass_find_device(UCLASS_VIDEO, 0, &dev);
779 if (!rc && dev) {
780 rc = device_remove(dev, DM_REMOVE_NORMAL);
781 if (rc)
782 printf("Cannot remove video device '%s' (err=%d)\n",
783 dev->name, rc);
784 }
Nikhil M Jain7a17e4c2023-04-10 14:19:13 +0530785 }
Simon Glassa17e1e72023-09-26 08:14:36 -0600786 if (CONFIG_IS_ENABLED(HANDOFF)) {
787 ret = write_spl_handoff();
788 if (ret)
789 printf(SPL_TPL_PROMPT
790 "SPL hand-off write failed (err=%d)\n", ret);
791 }
792 if (CONFIG_IS_ENABLED(BLOBLIST)) {
793 ret = bloblist_finish();
794 if (ret)
795 printf("Warning: Failed to finish bloblist (ret=%d)\n",
796 ret);
797 }
Nikhil M Jain7a17e4c2023-04-10 14:19:13 +0530798
Michal Simek3a3b9142016-05-10 07:54:20 +0200799 spl_board_prepare_for_boot();
Jonas Karlman6826c432023-09-27 21:44:13 +0000800 jump_to_image(&spl_image);
Aneesh Vbcae7212011-07-21 09:10:21 -0400801}
802
Tom Rini6507f132012-08-22 15:31:05 -0700803/*
804 * This requires UART clocks to be enabled. In order for this to work the
805 * caller must ensure that the gd pointer is valid.
806 */
Aneesh Vbcae7212011-07-21 09:10:21 -0400807void preloader_console_init(void)
808{
Simon Glass2a736062021-08-08 12:20:12 -0600809#ifdef CONFIG_SPL_SERIAL
Aneesh Vbcae7212011-07-21 09:10:21 -0400810 gd->baudrate = CONFIG_BAUDRATE;
811
Aneesh Vbcae7212011-07-21 09:10:21 -0400812 serial_init(); /* serial communications setup */
813
Ilya Yanokb88befa2011-11-01 13:16:03 +0000814 gd->have_console = 1;
815
Simon Glassaedc08b2018-11-15 18:43:57 -0700816#if CONFIG_IS_ENABLED(BANNER_PRINT)
Simon Glassd6330062018-11-15 18:43:56 -0700817 puts("\nU-Boot " SPL_TPL_NAME " " PLAIN_VERSION " (" U_BOOT_DATE " - "
818 U_BOOT_TIME " " U_BOOT_TZ ")\n");
Anatolij Gustschin0292bc02018-01-25 18:45:22 +0100819#endif
Tom Rini861a86f2012-08-13 11:37:56 -0700820#ifdef CONFIG_SPL_DISPLAY_PRINT
821 spl_display_print();
822#endif
Alex Kiernan117a0e02018-04-19 04:32:51 +0000823#endif
Samuel Holland3988be52020-05-07 18:08:10 -0500824}
Simon Glassdb910352015-03-03 08:03:00 -0700825
826/**
Simon Goldschmidtd8c03322019-07-16 22:30:36 +0200827 * This function is called before the stack is changed from initial stack to
828 * relocated stack. It tries to dump the stack size used
829 */
830__weak void spl_relocate_stack_check(void)
831{
832#if CONFIG_IS_ENABLED(SYS_REPORT_STACK_F_USAGE)
833 ulong init_sp = gd->start_addr_sp;
834 ulong stack_bottom = init_sp - CONFIG_VAL(SIZE_LIMIT_PROVIDE_STACK);
835 u8 *ptr = (u8 *)stack_bottom;
836 ulong i;
837
838 for (i = 0; i < CONFIG_VAL(SIZE_LIMIT_PROVIDE_STACK); i++) {
839 if (*ptr != CONFIG_VAL(SYS_STACK_F_CHECK_BYTE))
840 break;
841 ptr++;
842 }
843 printf("SPL initial stack usage: %lu bytes\n",
844 CONFIG_VAL(SIZE_LIMIT_PROVIDE_STACK) - i);
845#endif
846}
847
848/**
Simon Glassdb910352015-03-03 08:03:00 -0700849 * spl_relocate_stack_gd() - Relocate stack ready for board_init_r() execution
850 *
851 * Sometimes board_init_f() runs with a stack in SRAM but we want to use SDRAM
852 * for the main board_init_r() execution. This is typically because we need
853 * more stack space for things like the MMC sub-system.
854 *
855 * This function calculates the stack position, copies the global_data into
Albert ARIBAUDadc421e2015-11-25 17:56:33 +0100856 * place, sets the new gd (except for ARM, for which setting GD within a C
857 * function may not always work) and returns the new stack position. The
858 * caller is responsible for setting up the sp register and, in the case
859 * of ARM, setting up gd.
860 *
861 * All of this is done using the same layout and alignments as done in
862 * board_init_f_init_reserve() / board_init_f_alloc_reserve().
Simon Glassdb910352015-03-03 08:03:00 -0700863 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100864 * Return: new stack location, or 0 to use the same stack
Simon Glassdb910352015-03-03 08:03:00 -0700865 */
866ulong spl_relocate_stack_gd(void)
867{
868#ifdef CONFIG_SPL_STACK_R
869 gd_t *new_gd;
Albert ARIBAUDadc421e2015-11-25 17:56:33 +0100870 ulong ptr = CONFIG_SPL_STACK_R_ADDR;
Simon Glassdb910352015-03-03 08:03:00 -0700871
Simon Goldschmidtd8c03322019-07-16 22:30:36 +0200872 if (CONFIG_IS_ENABLED(SYS_REPORT_STACK_F_USAGE))
873 spl_relocate_stack_check();
874
Simon Glass3d6d5072023-09-26 08:14:27 -0600875#if defined(CONFIG_SPL_SYS_MALLOC_SIMPLE) && CONFIG_IS_ENABLED(SYS_MALLOC_F)
Hans de Goededcfcb8d2015-09-13 15:04:17 +0200876 if (CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN) {
Simon Goldschmidt438dcab2019-02-26 22:27:52 +0100877 debug("SPL malloc() before relocation used 0x%lx bytes (%ld KB)\n",
878 gd->malloc_ptr, gd->malloc_ptr / 1024);
Hans de Goededcfcb8d2015-09-13 15:04:17 +0200879 ptr -= CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN;
880 gd->malloc_base = ptr;
881 gd->malloc_limit = CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN;
882 gd->malloc_ptr = 0;
883 }
884#endif
Albert ARIBAUDadc421e2015-11-25 17:56:33 +0100885 /* Get stack position: use 8-byte alignment for ABI compliance */
886 ptr = CONFIG_SPL_STACK_R_ADDR - roundup(sizeof(gd_t),16);
Nikhil M Jain149fb052023-07-18 14:27:27 +0530887 gd->start_addr_sp = ptr;
Albert ARIBAUDadc421e2015-11-25 17:56:33 +0100888 new_gd = (gd_t *)ptr;
889 memcpy(new_gd, (void *)gd, sizeof(gd_t));
Simon Glass2f11cd92016-11-13 14:21:58 -0700890#if CONFIG_IS_ENABLED(DM)
891 dm_fixup_for_gd_move(new_gd);
892#endif
Lukas Auerc7e1eff2019-08-21 21:14:46 +0200893#if !defined(CONFIG_ARM) && !defined(CONFIG_RISCV)
Albert ARIBAUDadc421e2015-11-25 17:56:33 +0100894 gd = new_gd;
895#endif
Simon Glassdb910352015-03-03 08:03:00 -0700896 return ptr;
897#else
898 return 0;
899#endif
900}
Simon Glassc6604442019-11-14 12:57:17 -0700901
Philippe Reynes4d145f22020-12-11 19:56:47 +0100902#if defined(CONFIG_BOOTCOUNT_LIMIT) && \
903 ((!defined(CONFIG_TPL_BUILD) && !defined(CONFIG_SPL_BOOTCOUNT_LIMIT)) || \
904 (defined(CONFIG_TPL_BUILD) && !defined(CONFIG_TPL_BOOTCOUNT_LIMIT)))
Simon Glassc6604442019-11-14 12:57:17 -0700905void bootcount_store(ulong a)
906{
907}
908
909ulong bootcount_load(void)
910{
911 return 0;
912}
913#endif