blob: 488adbeb1bc68fd3a2e2034332ec6e2a7efdc2e6 [file] [log] [blame]
Tom Rini10e47792018-05-06 17:58:06 -04001/* SPDX-License-Identifier: GPL-2.0+ */
Tom Rini28591df2012-08-13 12:03:19 -07002/*
3 * (C) Copyright 2012
4 * Texas Instruments, <www.ti.com>
Tom Rini28591df2012-08-13 12:03:19 -07005 */
6#ifndef _SPL_H_
7#define _SPL_H_
8
Simon Glass867a3982017-11-13 18:55:03 -07009#include <binman_sym.h>
Simon Glass0f2af882020-05-10 11:40:05 -060010#include <linker_lists.h>
Simon Glass867a3982017-11-13 18:55:03 -070011
Tom Rini28591df2012-08-13 12:03:19 -070012/* Platform-specific defines */
Tom Rini31dfba42012-08-22 15:31:05 -070013#include <linux/compiler.h>
Masahiro Yamada5a5ef782020-02-25 02:25:46 +090014#include <asm/global_data.h>
Tom Rini28591df2012-08-13 12:03:19 -070015#include <asm/spl.h>
Simon Glasse14f1a22018-11-15 18:44:09 -070016#include <handoff.h>
Simon Glassb7e05ab2025-01-15 18:27:17 -070017#include <image.h>
Andre Przywara3cb12ef2021-07-12 11:06:49 +010018#include <mmc.h>
Tom Rini28591df2012-08-13 12:03:19 -070019
Masahiro Yamada5a5ef782020-02-25 02:25:46 +090020struct blk_desc;
Simon Glassbb7d3bb2022-09-06 20:26:52 -060021struct legacy_img_hdr;
Masahiro Yamada5a5ef782020-02-25 02:25:46 +090022
Simon Glassa77e1b82015-05-13 07:02:24 -060023/* Value in r0 indicates we booted from U-Boot */
24#define UBOOT_NOT_LOADED_FROM_SPL 0x13578642
Dan Murphyb7b5b0c2014-01-16 11:23:29 -060025
Tom Rini28591df2012-08-13 12:03:19 -070026/* Boot type */
27#define MMCSD_MODE_UNDEFINED 0
28#define MMCSD_MODE_RAW 1
Guillaume GARDET602a16c2014-10-15 17:53:11 +020029#define MMCSD_MODE_FS 2
Tom Rinicc612692014-02-05 10:24:18 -050030#define MMCSD_MODE_EMMCBOOT 3
Tom Rini28591df2012-08-13 12:03:19 -070031
Simon Glass655306c2020-05-10 11:39:58 -060032struct blk_desc;
Simon Glassbb7d3bb2022-09-06 20:26:52 -060033struct legacy_img_hdr;
Pali Rohárdda8f882022-01-14 14:31:38 +010034struct spl_boot_device;
Tom Rinie0897402023-07-13 20:37:34 -040035enum boot_device;
Simon Glass1e268642020-05-10 11:39:55 -060036
Simon Glass4e0a52d2018-11-15 18:43:51 -070037/*
Simon Glass3235f1e2024-09-29 19:49:34 -060038 * xpl_is_first_phase() - check if this is the first U-Boot phase
Simon Glass4e0a52d2018-11-15 18:43:51 -070039 *
Simon Glass3235f1e2024-09-29 19:49:34 -060040 * U-Boot has up to four phases: TPL, VPL, SPL and U-Boot proper. Depending on
41 * the build flags we can determine whether the current build is for the first
Simon Glass4e0a52d2018-11-15 18:43:51 -070042 * phase of U-Boot or not. If there is no SPL, then this is U-Boot proper. If
43 * there is SPL but no TPL, the the first phase is SPL. If there is TPL, then
Simon Glass3235f1e2024-09-29 19:49:34 -060044 * it is the first phase, etc.
Simon Glass4e0a52d2018-11-15 18:43:51 -070045 *
Simon Glass3235f1e2024-09-29 19:49:34 -060046 * Note that VPL can never be the first phase. If it exists, it is loaded from
47 * TPL
Simon Glass4e0a52d2018-11-15 18:43:51 -070048 *
Simon Glass3235f1e2024-09-29 19:49:34 -060049 * Return: true if this is the first phase of U-Boot
Simon Glass4e0a52d2018-11-15 18:43:51 -070050 */
Simon Glass3235f1e2024-09-29 19:49:34 -060051static inline bool xpl_is_first_phase(void)
Simon Glass4e0a52d2018-11-15 18:43:51 -070052{
53 if (IS_ENABLED(CONFIG_TPL)) {
54 if (IS_ENABLED(CONFIG_TPL_BUILD))
55 return true;
56 } else if (IS_ENABLED(CONFIG_SPL)) {
Simon Glass209ae762024-09-29 19:49:49 -060057 if (IS_ENABLED(CONFIG_XPL_BUILD))
Simon Glass4e0a52d2018-11-15 18:43:51 -070058 return true;
59 } else {
60 return true;
61 }
62
63 return false;
64}
65
Simon Glassdb2d1012024-09-29 19:49:35 -060066enum xpl_phase_t {
Simon Glass95e4ec12021-01-13 20:29:42 -070067 PHASE_NONE, /* Invalid phase, signifying before U-Boot */
Simon Glass3c573b52019-09-25 08:56:30 -060068 PHASE_TPL, /* Running in TPL */
Simon Glass7eec8842022-04-30 00:56:52 -060069 PHASE_VPL, /* Running in VPL */
Simon Glass3c573b52019-09-25 08:56:30 -060070 PHASE_SPL, /* Running in SPL */
71 PHASE_BOARD_F, /* Running in U-Boot before relocation */
72 PHASE_BOARD_R, /* Running in U-Boot after relocation */
Simon Glassc017c522022-10-20 18:23:19 -060073
74 PHASE_COUNT,
Simon Glassb7fb5132019-09-25 08:11:20 -060075};
76
77/**
Simon Glassd4dce4a2024-09-29 19:49:36 -060078 * xpl_phase() - Find out the phase of U-Boot
Simon Glassb7fb5132019-09-25 08:11:20 -060079 *
80 * This can be used to avoid #ifdef logic and use if() instead.
81 *
82 * For example, to include code only in TPL, you might do:
83 *
84 * #ifdef CONFIG_TPL_BUILD
85 * ...
86 * #endif
87 *
88 * but with this you can use:
89 *
Simon Glassd4dce4a2024-09-29 19:49:36 -060090 * if (xpl_phase() == PHASE_TPL) {
Simon Glassb7fb5132019-09-25 08:11:20 -060091 * ...
92 * }
93 *
94 * To include code only in SPL, you might do:
95 *
Simon Glass209ae762024-09-29 19:49:49 -060096 * #if defined(CONFIG_XPL_BUILD) && !defined(CONFIG_TPL_BUILD)
Simon Glassb7fb5132019-09-25 08:11:20 -060097 * ...
98 * #endif
99 *
100 * but with this you can use:
101 *
Simon Glassd4dce4a2024-09-29 19:49:36 -0600102 * if (xpl_phase() == PHASE_SPL) {
Simon Glassb7fb5132019-09-25 08:11:20 -0600103 * ...
104 * }
105 *
106 * To include code only in U-Boot proper, you might do:
107 *
Simon Glass209ae762024-09-29 19:49:49 -0600108 * #ifndef CONFIG_XPL_BUILD
Simon Glassb7fb5132019-09-25 08:11:20 -0600109 * ...
110 * #endif
111 *
112 * but with this you can use:
113 *
Simon Glassd4dce4a2024-09-29 19:49:36 -0600114 * if (xpl_phase() == PHASE_BOARD_F) {
Simon Glassb7fb5132019-09-25 08:11:20 -0600115 * ...
116 * }
117 *
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +0100118 * Return: U-Boot phase
Simon Glassb7fb5132019-09-25 08:11:20 -0600119 */
Simon Glassd4dce4a2024-09-29 19:49:36 -0600120static inline enum xpl_phase_t xpl_phase(void)
Simon Glassb7fb5132019-09-25 08:11:20 -0600121{
122#ifdef CONFIG_TPL_BUILD
123 return PHASE_TPL;
Simon Glass7eec8842022-04-30 00:56:52 -0600124#elif defined(CONFIG_VPL_BUILD)
125 return PHASE_VPL;
Simon Glass209ae762024-09-29 19:49:49 -0600126#elif defined(CONFIG_XPL_BUILD)
Simon Glassb7fb5132019-09-25 08:11:20 -0600127 return PHASE_SPL;
128#else
Simon Glass3c573b52019-09-25 08:56:30 -0600129 DECLARE_GLOBAL_DATA_PTR;
130
131 if (!(gd->flags & GD_FLG_RELOC))
132 return PHASE_BOARD_F;
133 else
134 return PHASE_BOARD_R;
Simon Glassb7fb5132019-09-25 08:11:20 -0600135#endif
136}
137
Simon Glassf218eeb2024-09-29 19:49:37 -0600138/* returns true if in U-Boot proper, false if in xPL */
139static inline bool not_xpl(void)
Simon Glass38da4f92023-09-26 08:14:55 -0600140{
Simon Glass209ae762024-09-29 19:49:49 -0600141#ifdef CONFIG_XPL_BUILD
Simon Glass38da4f92023-09-26 08:14:55 -0600142 return false;
143#endif
144
145 return true;
146}
147
Simon Glass91222f82024-09-29 19:49:38 -0600148/* returns true if in xPL, false if in U-Boot proper */
149static inline bool is_xpl(void)
150{
151#ifdef CONFIG_XPL_BUILD
152 return true;
153#endif
154
155 return false;
156}
157
Simon Glass95e4ec12021-01-13 20:29:42 -0700158/**
Simon Glass6b7f9c02024-09-29 19:49:39 -0600159 * xpl_prev_phase() - Figure out the previous U-Boot phase
Simon Glass95e4ec12021-01-13 20:29:42 -0700160 *
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +0100161 * Return: the previous phase from this one, e.g. if called in SPL this returns
Simon Glass95e4ec12021-01-13 20:29:42 -0700162 * PHASE_TPL, if TPL is enabled
163 */
Simon Glass6b7f9c02024-09-29 19:49:39 -0600164static inline enum xpl_phase_t xpl_prev_phase(void)
Simon Glass95e4ec12021-01-13 20:29:42 -0700165{
166#ifdef CONFIG_TPL_BUILD
167 return PHASE_NONE;
Simon Glass7eec8842022-04-30 00:56:52 -0600168#elif defined(CONFIG_VPL_BUILD)
169 return PHASE_TPL; /* VPL requires TPL */
Simon Glass209ae762024-09-29 19:49:49 -0600170#elif defined(CONFIG_XPL_BUILD)
Simon Glass7eec8842022-04-30 00:56:52 -0600171 return IS_ENABLED(CONFIG_VPL) ? PHASE_VPL :
172 IS_ENABLED(CONFIG_TPL) ? PHASE_TPL :
173 PHASE_NONE;
Simon Glass95e4ec12021-01-13 20:29:42 -0700174#else
Simon Glass7eec8842022-04-30 00:56:52 -0600175 return IS_ENABLED(CONFIG_SPL) ? PHASE_SPL :
176 PHASE_NONE;
Simon Glass95e4ec12021-01-13 20:29:42 -0700177#endif
178}
179
180/**
Simon Glass6b7f9c02024-09-29 19:49:39 -0600181 * xpl_next_phase() - Figure out the next U-Boot phase
Simon Glass95e4ec12021-01-13 20:29:42 -0700182 *
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +0100183 * Return: the next phase from this one, e.g. if called in TPL this returns
Simon Glass95e4ec12021-01-13 20:29:42 -0700184 * PHASE_SPL
185 */
Simon Glass6b7f9c02024-09-29 19:49:39 -0600186static inline enum xpl_phase_t xpl_next_phase(void)
Simon Glass95e4ec12021-01-13 20:29:42 -0700187{
188#ifdef CONFIG_TPL_BUILD
Simon Glass7eec8842022-04-30 00:56:52 -0600189 return IS_ENABLED(CONFIG_VPL) ? PHASE_VPL : PHASE_SPL;
190#elif defined(CONFIG_VPL_BUILD)
Simon Glass95e4ec12021-01-13 20:29:42 -0700191 return PHASE_SPL;
192#else
193 return PHASE_BOARD_F;
194#endif
195}
196
197/**
Simon Glass6c6fcc62024-09-29 19:49:40 -0600198 * xpl_name() - Get the name of a phase
Simon Glass95e4ec12021-01-13 20:29:42 -0700199 *
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +0100200 * Return: phase name
Simon Glass95e4ec12021-01-13 20:29:42 -0700201 */
Simon Glass6c6fcc62024-09-29 19:49:40 -0600202static inline const char *xpl_name(enum xpl_phase_t phase)
Simon Glass95e4ec12021-01-13 20:29:42 -0700203{
204 switch (phase) {
205 case PHASE_TPL:
206 return "TPL";
Simon Glass7eec8842022-04-30 00:56:52 -0600207 case PHASE_VPL:
208 return "VPL";
Simon Glass95e4ec12021-01-13 20:29:42 -0700209 case PHASE_SPL:
210 return "SPL";
211 case PHASE_BOARD_F:
212 case PHASE_BOARD_R:
213 return "U-Boot";
214 default:
215 return "phase?";
216 }
217}
218
Simon Glass1cd06002021-07-05 16:32:45 -0600219/**
Simon Glass6c6fcc62024-09-29 19:49:40 -0600220 * xpl_prefix() - Get the prefix of the current phase
Simon Glass1cd06002021-07-05 16:32:45 -0600221 *
222 * @phase: Phase to look up
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +0100223 * Return: phase prefix ("spl", "tpl", etc.)
Simon Glass1cd06002021-07-05 16:32:45 -0600224 */
Simon Glass6c6fcc62024-09-29 19:49:40 -0600225static inline const char *xpl_prefix(enum xpl_phase_t phase)
Simon Glass1cd06002021-07-05 16:32:45 -0600226{
227 switch (phase) {
228 case PHASE_TPL:
229 return "tpl";
Simon Glass7eec8842022-04-30 00:56:52 -0600230 case PHASE_VPL:
231 return "vpl";
Simon Glass1cd06002021-07-05 16:32:45 -0600232 case PHASE_SPL:
233 return "spl";
234 case PHASE_BOARD_F:
235 case PHASE_BOARD_R:
236 return "";
237 default:
238 return "phase?";
239 }
240}
241
Simon Glassdbd3f112018-11-15 18:43:56 -0700242/* A string name for SPL or TPL */
Simon Glass209ae762024-09-29 19:49:49 -0600243#ifdef CONFIG_XPL_BUILD
Simon Glassdbd3f112018-11-15 18:43:56 -0700244# ifdef CONFIG_TPL_BUILD
Simon Glass8bc93262024-09-29 19:49:55 -0600245# define PHASE_NAME "TPL"
Simon Glass7eec8842022-04-30 00:56:52 -0600246# elif defined(CONFIG_VPL_BUILD)
Simon Glass8bc93262024-09-29 19:49:55 -0600247# define PHASE_NAME "VPL"
248# elif defined(CONFIG_SPL_BUILD)
249# define PHASE_NAME "SPL"
Simon Glassdbd3f112018-11-15 18:43:56 -0700250# endif
Simon Glass8bc93262024-09-29 19:49:55 -0600251# define PHASE_PROMPT PHASE_NAME ": "
Simon Glassdbd3f112018-11-15 18:43:56 -0700252#else
Simon Glass8bc93262024-09-29 19:49:55 -0600253# define PHASE_NAME ""
254# define PHASE_PROMPT ""
Simon Glassdbd3f112018-11-15 18:43:56 -0700255#endif
256
Simon Glass4aa6a9b2022-10-20 18:23:01 -0600257/**
258 * enum spl_sandbox_flags - flags for sandbox's use of spl_image_info->flags
259 *
260 * @SPL_SANDBOXF_ARG_IS_FNAME: arg is the filename to jump to (default)
Simon Glassa87cd0c2022-10-20 18:23:08 -0600261 * @SPL_SANDBOXF_ARG_IS_BUF: arg is the containing image to jump to, @offset is
262 * the start offset within the image, @size is the size of the image
Simon Glass4aa6a9b2022-10-20 18:23:01 -0600263 */
264enum spl_sandbox_flags {
265 SPL_SANDBOXF_ARG_IS_FNAME = 0,
Simon Glassa87cd0c2022-10-20 18:23:08 -0600266 SPL_SANDBOXF_ARG_IS_BUF,
Simon Glass4aa6a9b2022-10-20 18:23:01 -0600267};
268
Simon Glassb7e05ab2025-01-15 18:27:17 -0700269/**
270 * struct spl_image_info - Information about the SPL image being loaded
271 *
272 * @fdt_size: Size of the FDT for the image (0 if none)
273 */
Tom Rini28591df2012-08-13 12:03:19 -0700274struct spl_image_info {
275 const char *name;
276 u8 os;
Simon Glass9a9097f2024-12-19 11:29:00 -0700277 ulong load_addr;
278 ulong entry_point;
Marek Vasut187b9e32019-05-07 21:17:02 +0200279#if CONFIG_IS_ENABLED(LOAD_FIT) || CONFIG_IS_ENABLED(LOAD_FIT_FULL)
Philipp Tomsichbe5ac1a2017-09-13 21:29:30 +0200280 void *fdt_addr;
281#endif
Philipp Tomsich58beb6e2018-05-24 17:15:50 +0200282 u32 boot_device;
Pali Rohár11041672021-07-23 11:14:27 +0200283 u32 offset;
Tom Rini28591df2012-08-13 12:03:19 -0700284 u32 size;
Simon Glassb7e05ab2025-01-15 18:27:17 -0700285 ulong fdt_size;
Stefan Roese00b57b32012-08-27 12:50:58 +0200286 u32 flags;
Vikas Manocha62b021c2017-04-07 15:38:13 -0700287 void *arg;
Simon Goldschmidt17140472019-02-10 21:34:37 +0100288#ifdef CONFIG_SPL_LEGACY_IMAGE_CRC_CHECK
289 ulong dcrc_data;
290 ulong dcrc_length;
291 ulong dcrc;
292#endif
Tom Rini28591df2012-08-13 12:03:19 -0700293};
294
Simon Glass7ba1b8c2025-01-15 18:27:18 -0700295/* function to jump to an image from SPL */
296typedef void __noreturn (*spl_jump_to_image_t)(struct spl_image_info *);
297
Simon Glass35c84e52023-09-26 08:14:22 -0600298static inline void *spl_image_fdt_addr(struct spl_image_info *info)
299{
300#if CONFIG_IS_ENABLED(LOAD_FIT) || CONFIG_IS_ENABLED(LOAD_FIT_FULL)
301 return info->fdt_addr;
302#else
303 return 0;
304#endif
305}
306
Simon Glasse8066862024-08-22 07:55:02 -0600307struct spl_load_info;
308
309/**
310 * spl_load_reader() - Read from device
311 *
312 * @load: Information about the load state
313 * @offset: Offset to read from in bytes. This must be a multiple of
314 * @load->bl_len.
315 * @count: Number of bytes to read. This must be a multiple of
316 * @load->bl_len.
317 * @buf: Buffer to read into
318 * @return number of bytes read, 0 on error
319 */
320typedef ulong (*spl_load_reader)(struct spl_load_info *load, ulong sector,
321 ulong count, void *buf);
322
Dario Binacchi0f860b62020-05-27 13:56:18 +0200323/**
Simon Glassa6131a22016-02-22 22:55:56 -0700324 * Information required to load data from a device
325 *
Simon Glasse8066862024-08-22 07:55:02 -0600326 * @read: Function to call to read from the device
Simon Glassa6131a22016-02-22 22:55:56 -0700327 * @priv: Private data for the device
328 * @bl_len: Block length for reading in bytes
Simon Glassb7e05ab2025-01-15 18:27:17 -0700329 * @phase: Image phase to load
330 * @fit_loaded: true if the FIT has been loaded, except for external data
Simon Glassa6131a22016-02-22 22:55:56 -0700331 */
332struct spl_load_info {
Simon Glasse8066862024-08-22 07:55:02 -0600333 spl_load_reader read;
Simon Glassa6131a22016-02-22 22:55:56 -0700334 void *priv;
Sean Anderson35f15fe2023-11-08 11:48:43 -0500335#if IS_ENABLED(CONFIG_SPL_LOAD_BLOCK)
Simon Glassb7e05ab2025-01-15 18:27:17 -0700336 u16 bl_len;
337#endif
338#if CONFIG_IS_ENABLED(BOOTMETH_VBE)
339 u8 phase;
340 u8 fit_loaded;
Simon Glass9cce28b2024-08-22 07:55:01 -0600341#endif
Simon Glassa6131a22016-02-22 22:55:56 -0700342};
343
Sean Anderson35f15fe2023-11-08 11:48:43 -0500344static inline int spl_get_bl_len(struct spl_load_info *info)
345{
Simon Glass9cce28b2024-08-22 07:55:01 -0600346#if IS_ENABLED(CONFIG_SPL_LOAD_BLOCK)
Sean Anderson35f15fe2023-11-08 11:48:43 -0500347 return info->bl_len;
Sean Anderson35f15fe2023-11-08 11:48:43 -0500348#else
Sean Anderson35f15fe2023-11-08 11:48:43 -0500349 return 1;
Simon Glass9cce28b2024-08-22 07:55:01 -0600350#endif
Sean Anderson35f15fe2023-11-08 11:48:43 -0500351}
352
353static inline void spl_set_bl_len(struct spl_load_info *info, int bl_len)
354{
Simon Glass9cce28b2024-08-22 07:55:01 -0600355#if IS_ENABLED(CONFIG_SPL_LOAD_BLOCK)
356 info->bl_len = bl_len;
357#else
Sean Anderson35f15fe2023-11-08 11:48:43 -0500358 if (bl_len != 1)
359 panic("CONFIG_SPL_LOAD_BLOCK not enabled");
Sean Anderson35f15fe2023-11-08 11:48:43 -0500360#endif
Simon Glass9cce28b2024-08-22 07:55:01 -0600361}
Sean Anderson35f15fe2023-11-08 11:48:43 -0500362
Simon Glassb7e05ab2025-01-15 18:27:17 -0700363static inline void xpl_set_phase(struct spl_load_info *info,
364 enum image_phase_t phase)
365{
366#if CONFIG_IS_ENABLED(BOOTMETH_VBE)
367 info->phase = phase;
368#endif
369}
370
371static inline enum image_phase_t xpl_get_phase(struct spl_load_info *info)
372{
373#if CONFIG_IS_ENABLED(BOOTMETH_VBE)
374 return info->phase;
375#else
376 return IH_PHASE_NONE;
377#endif
378}
379
380static inline bool xpl_get_fit_loaded(struct spl_load_info *info)
381{
382#if CONFIG_IS_ENABLED(BOOTMETH_VBE)
383 return info->fit_loaded;
384#else
385 return false;
386#endif
387}
388
Simon Glasse8066862024-08-22 07:55:02 -0600389/**
390 * spl_load_init() - Set up a new spl_load_info structure
391 */
392static inline void spl_load_init(struct spl_load_info *load,
393 spl_load_reader h_read, void *priv,
394 uint bl_len)
395{
396 load->read = h_read;
397 load->priv = priv;
398 spl_set_bl_len(load, bl_len);
399}
400
Simon Glass867a3982017-11-13 18:55:03 -0700401/*
402 * We need to know the position of U-Boot in memory so we can jump to it. We
403 * allow any U-Boot binary to be used (u-boot.bin, u-boot-nodtb.bin,
404 * u-boot.img), hence the '_any'. These is no checking here that the correct
Simon Glass596f31c2019-12-08 17:40:12 -0700405 * image is found. For example if u-boot.img is used we don't check that
Simon Glass867a3982017-11-13 18:55:03 -0700406 * spl_parse_image_header() can parse a valid header.
Simon Glass596f31c2019-12-08 17:40:12 -0700407 *
408 * Similarly for SPL, so that TPL can jump to SPL.
Simon Glass867a3982017-11-13 18:55:03 -0700409 */
Simon Glass9dcc8612018-08-01 15:22:42 -0600410binman_sym_extern(ulong, u_boot_any, image_pos);
Simon Glass596f31c2019-12-08 17:40:12 -0700411binman_sym_extern(ulong, u_boot_any, size);
Simon Glass5a332c12022-10-20 18:22:41 -0600412binman_sym_extern(ulong, u_boot_spl_any, image_pos);
413binman_sym_extern(ulong, u_boot_spl_any, size);
414binman_sym_extern(ulong, u_boot_vpl_any, image_pos);
415binman_sym_extern(ulong, u_boot_vpl_any, size);
Simon Glass596f31c2019-12-08 17:40:12 -0700416
417/**
418 * spl_get_image_pos() - get the image position of the next phase
419 *
420 * This returns the image position to use to load the next phase of U-Boot
421 */
422ulong spl_get_image_pos(void);
423
424/**
425 * spl_get_image_size() - get the size of the next phase
426 *
427 * This returns the size to use to load the next phase of U-Boot
428 */
429ulong spl_get_image_size(void);
Simon Glass867a3982017-11-13 18:55:03 -0700430
Lokesh Vutlaf62cef12016-05-24 10:34:38 +0530431/**
Simon Glass53857ee2021-01-24 10:06:03 -0700432 * spl_get_image_text_base() - get the text base of the next phase
433 *
434 * This returns the address that the next stage is linked to run at, i.e.
Simon Glass72cc5382022-10-20 18:22:39 -0600435 * CONFIG_SPL_TEXT_BASE or CONFIG_TEXT_BASE
Simon Glass53857ee2021-01-24 10:06:03 -0700436 *
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +0100437 * Return: text-base address
Simon Glass53857ee2021-01-24 10:06:03 -0700438 */
439ulong spl_get_image_text_base(void);
440
441/**
Andreas Dannenberg8d9f7f12019-06-04 17:55:46 -0500442 * spl_load_simple_fit_skip_processing() - Hook to allow skipping the FIT
443 * image processing during spl_load_simple_fit().
444 *
445 * Return true to skip FIT processing, false to preserve the full code flow
446 * of spl_load_simple_fit().
447 */
448bool spl_load_simple_fit_skip_processing(void);
449
450/**
Heiko Schocher67e8f5d2021-08-06 06:44:26 +0200451 * spl_load_simple_fit_fix_load() - Hook to make fixes
452 * after fit image header is loaded
453 *
454 * Returns pointer to fit
455 */
456void *spl_load_simple_fit_fix_load(const void *fit);
457
458/**
Lokesh Vutlaf62cef12016-05-24 10:34:38 +0530459 * spl_load_simple_fit() - Loads a fit image from a device.
Simon Glass43a734f2016-09-24 18:20:16 -0600460 * @spl_image: Image description to set up
Lokesh Vutlaf62cef12016-05-24 10:34:38 +0530461 * @info: Structure containing the information required to load data.
Sean Anderson7d8d6132023-11-08 11:48:40 -0500462 * @offset: Offset where FIT image is located in the device. Must be aligned
463 * to the device's bl_len.
Lokesh Vutlaf62cef12016-05-24 10:34:38 +0530464 * @fdt: Pointer to the copied FIT header.
465 *
466 * Reads the FIT image @sector in the device. Loads u-boot image to
467 * specified load address and copies the dtb to end of u-boot image.
468 * Returns 0 on success.
469 */
Simon Glass43a734f2016-09-24 18:20:16 -0600470int spl_load_simple_fit(struct spl_image_info *spl_image,
Sean Anderson7d8d6132023-11-08 11:48:40 -0500471 struct spl_load_info *info, ulong offset, void *fdt);
Simon Glassa6131a22016-02-22 22:55:56 -0700472
Stefan Roese00b57b32012-08-27 12:50:58 +0200473#define SPL_COPY_PAYLOAD_ONLY 1
Ye Li9d5b0f42018-11-17 09:10:25 +0000474#define SPL_FIT_FOUND 2
Stefan Roese00b57b32012-08-27 12:50:58 +0200475
Peng Fand8670762019-08-22 07:42:38 +0000476/**
Sean Andersonce9ffb92023-11-08 11:48:45 -0500477 * spl_load_legacy_lzma() - Load an LZMA-compressed legacy image
478 * @spl_image: Image description (already set up)
479 * @load: Structure containing the information required to load data.
480 * @offset: Pointer to image
481 *
482 * Load/decompress an LZMA-compressed legacy image from the device.
483 *
484 * Return: 0 on success, or a negative error on failure
485 */
486int spl_load_legacy_lzma(struct spl_image_info *spl_image,
487 struct spl_load_info *load, ulong offset);
488
489/**
Stefan Roese84ae9d82020-04-21 09:28:43 +0200490 * spl_load_legacy_img() - Loads a legacy image from a device.
491 * @spl_image: Image description to set up
492 * @load: Structure containing the information required to load data.
Roger Quadros237f0182022-09-29 13:11:28 +0300493 * @offset: Pointer to image
494 * @hdr: Pointer to image header
Stefan Roese84ae9d82020-04-21 09:28:43 +0200495 *
496 * Reads an legacy image from the device. Loads u-boot image to
497 * specified load address.
498 * Returns 0 on success.
499 */
500int spl_load_legacy_img(struct spl_image_info *spl_image,
Pali Rohárdda8f882022-01-14 14:31:38 +0100501 struct spl_boot_device *bootdev,
Roger Quadros237f0182022-09-29 13:11:28 +0300502 struct spl_load_info *load, ulong offset,
503 struct legacy_img_hdr *hdr);
504
Stefan Roese84ae9d82020-04-21 09:28:43 +0200505/**
Peng Fand8670762019-08-22 07:42:38 +0000506 * spl_load_imx_container() - Loads a imx container image from a device.
507 * @spl_image: Image description to set up
508 * @info: Structure containing the information required to load data.
Sean Anderson7d8d6132023-11-08 11:48:40 -0500509 * @sector: Offset where container image is located in the device. Must be
510 * aligned to the device block size.
Peng Fand8670762019-08-22 07:42:38 +0000511 *
512 * Reads the container image @sector in the device. Loads u-boot image to
513 * specified load address.
514 */
515int spl_load_imx_container(struct spl_image_info *spl_image,
Sean Anderson7d8d6132023-11-08 11:48:40 -0500516 struct spl_load_info *info, ulong offset);
Peng Fand8670762019-08-22 07:42:38 +0000517
Tom Rini28591df2012-08-13 12:03:19 -0700518/* SPL common functions */
519void preloader_console_init(void);
520u32 spl_boot_device(void);
Harald Seiler0bf7ab12020-04-15 11:33:30 +0200521
Sean Anderson8734d6f2023-10-14 16:48:05 -0400522struct spi_flash;
523
524/**
525 * spl_spi_get_uboot_offs() - Lookup function for the SPI boot offset
526 * @flash: The spi flash to boot from
527 *
528 * Return: The offset of U-Boot within the SPI flash
529 */
530unsigned int spl_spi_get_uboot_offs(struct spi_flash *flash);
531
Harald Seiler0bf7ab12020-04-15 11:33:30 +0200532/**
Vaishnav Achath58a0cdb2022-06-03 11:32:15 +0530533 * spl_spi_boot_bus() - Lookup function for the SPI boot bus source.
534 *
535 * This function returns the SF bus to load from.
536 * If not overridden, it is weakly defined in common/spl/spl_spi.c.
537 */
538u32 spl_spi_boot_bus(void);
539
540/**
541 * spl_spi_boot_cs() - Lookup function for the SPI boot CS source.
542 *
543 * This function returns the SF CS to load from.
544 * If not overridden, it is weakly defined in common/spl/spl_spi.c.
545 */
546u32 spl_spi_boot_cs(void);
547
548/**
Harald Seiler0bf7ab12020-04-15 11:33:30 +0200549 * spl_mmc_boot_mode() - Lookup function for the mode of an MMC boot source.
550 * @boot_device: ID of the device which the MMC driver wants to read
551 * from. Common values are e.g. BOOT_DEVICE_MMC1,
552 * BOOT_DEVICE_MMC2, BOOT_DEVICE_MMC2_2.
553 *
554 * This function should return one of MMCSD_MODE_FS, MMCSD_MODE_EMMCBOOT, or
555 * MMCSD_MODE_RAW for each MMC boot source which is defined for the target. The
556 * boot_device parameter tells which device the MMC driver is interested in.
557 *
558 * If not overridden, it is weakly defined in common/spl/spl_mmc.c.
559 *
560 * Note: It is important to use the boot_device parameter instead of e.g.
561 * spl_boot_device() as U-Boot is not always loaded from the same device as SPL.
562 */
Andre Przywara3cb12ef2021-07-12 11:06:49 +0100563u32 spl_mmc_boot_mode(struct mmc *mmc, const u32 boot_device);
Harald Seilerbf16c302020-04-15 11:33:31 +0200564
565/**
566 * spl_mmc_boot_partition() - MMC partition to load U-Boot from.
567 * @boot_device: ID of the device which the MMC driver wants to load
568 * U-Boot from.
569 *
570 * This function should return the partition number which the SPL
571 * should load U-Boot from (on the given boot_device) when
572 * CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_USE_PARTITION is set.
573 *
574 * If not overridden, it is weakly defined in common/spl/spl_mmc.c.
575 */
576int spl_mmc_boot_partition(const u32 boot_device);
Marek Vasutde1ce232021-07-03 04:55:32 +0200577
578struct mmc;
579/**
580 * default_spl_mmc_emmc_boot_partition() - eMMC boot partition to load U-Boot from.
581 * mmc: Pointer for the mmc device structure
582 *
583 * This function should return the eMMC boot partition number which
584 * the SPL should load U-Boot from (on the given boot_device).
585 */
586int default_spl_mmc_emmc_boot_partition(struct mmc *mmc);
587
588/**
589 * spl_mmc_emmc_boot_partition() - eMMC boot partition to load U-Boot from.
590 * mmc: Pointer for the mmc device structure
591 *
592 * This function should return the eMMC boot partition number which
593 * the SPL should load U-Boot from (on the given boot_device).
594 *
595 * If not overridden, it is weakly defined in common/spl/spl_mmc.c
596 * and calls default_spl_mmc_emmc_boot_partition();
597 */
598int spl_mmc_emmc_boot_partition(struct mmc *mmc);
599
Alexandru Gagniuc7861f8b2021-04-08 11:56:11 -0500600void spl_set_bd(void);
Simon Glass11a1a272016-09-24 18:19:52 -0600601
602/**
Marek Vasutf9a921e2023-10-16 18:16:12 +0200603 * spl_mmc_get_uboot_raw_sector() - Provide raw sector of the start of U-Boot (architecture override)
604 *
605 * This is a weak function which by default will provide the raw sector that is
606 * where the start of the U-Boot image has been written to.
607 *
608 * @mmc: struct mmc that describes the devie where U-Boot resides
609 * @raw_sect: The raw sector number where U-Boot is by default.
610 * Return: The raw sector location that U-Boot resides at
611 */
612unsigned long arch_spl_mmc_get_uboot_raw_sector(struct mmc *mmc,
613 unsigned long raw_sect);
614
615/**
616 * spl_mmc_get_uboot_raw_sector() - Provide raw sector of the start of U-Boot (board override)
617 *
618 * This is a weak function which by default will provide the raw sector that is
619 * where the start of the U-Boot image has been written to.
620 *
621 * @mmc: struct mmc that describes the devie where U-Boot resides
622 * @raw_sect: The raw sector number where U-Boot is by default.
623 * Return: The raw sector location that U-Boot resides at
624 */
625unsigned long board_spl_mmc_get_uboot_raw_sector(struct mmc *mmc,
626 unsigned long raw_sect);
627
628/**
Tom Rinia3a142c2023-03-09 11:22:08 -0500629 * spl_mmc_get_uboot_raw_sector() - Provide raw sector of the start of U-Boot
630 *
631 * This is a weak function which by default will provide the raw sector that is
632 * where the start of the U-Boot image has been written to.
633 *
634 * @mmc: struct mmc that describes the devie where U-Boot resides
635 * @raw_sect: The raw sector number where U-Boot is by default.
636 * Return: The raw sector location that U-Boot resides at
637 */
638unsigned long spl_mmc_get_uboot_raw_sector(struct mmc *mmc,
639 unsigned long raw_sect);
640
641/**
Simon Glass11a1a272016-09-24 18:19:52 -0600642 * spl_set_header_raw_uboot() - Set up a standard SPL image structure
643 *
644 * This sets up the given spl_image which the standard values obtained from
Jesse Taube93ee5c82023-08-24 21:59:48 -0400645 * config options: CONFIG_SYS_MONITOR_LEN, CONFIG_SYS_UBOOT_START,
Simon Glass72cc5382022-10-20 18:22:39 -0600646 * CONFIG_TEXT_BASE.
Simon Glass11a1a272016-09-24 18:19:52 -0600647 *
Simon Glass6b2e4db2016-09-24 18:19:53 -0600648 * @spl_image: Image description to set up
Simon Glass11a1a272016-09-24 18:19:52 -0600649 */
650void spl_set_header_raw_uboot(struct spl_image_info *spl_image);
651
Simon Glass6b2e4db2016-09-24 18:19:53 -0600652/**
653 * spl_parse_image_header() - parse the image header and set up info
654 *
655 * This parses the legacy image header information at @header and sets up
656 * @spl_image according to what is found. If no image header is found, then
657 * a raw image or bootz is assumed. If CONFIG_SPL_PANIC_ON_RAW_IMAGE is
Andrew F. Davisb4be3c32017-02-16 11:18:38 -0600658 * enabled, then this causes a panic. If CONFIG_SPL_RAW_IMAGE_SUPPORT is not
Simon Glass6b2e4db2016-09-24 18:19:53 -0600659 * enabled then U-Boot gives up. Otherwise U-Boot sets up the image using
660 * spl_set_header_raw_uboot(), or possibly the bootz header.
661 *
662 * @spl_image: Image description to set up
663 * @header image header to parse
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +0100664 * Return: 0 if a header was correctly parsed, -ve on error
Simon Glass6b2e4db2016-09-24 18:19:53 -0600665 */
666int spl_parse_image_header(struct spl_image_info *spl_image,
Pali Rohárdda8f882022-01-14 14:31:38 +0100667 const struct spl_boot_device *bootdev,
Simon Glassbb7d3bb2022-09-06 20:26:52 -0600668 const struct legacy_img_hdr *header);
Simon Glass6b2e4db2016-09-24 18:19:53 -0600669
Tom Rini28591df2012-08-13 12:03:19 -0700670void spl_board_prepare_for_linux(void);
Alexandru Gagniucf2b410a2021-07-15 14:19:24 -0500671
672/**
673 * spl_board_prepare_for_optee() - Prepare board for an OPTEE payload
674 *
675 * Prepares the board for booting an OP-TEE payload. Initialization is platform
676 * specific, and may include configuring the TrustZone memory, and other
677 * initialization steps required by OP-TEE.
678 * Note that @fdt is not used directly by OP-TEE. OP-TEE passes this @fdt to
679 * its normal world target. This target is not guaranteed to be u-boot, so @fdt
680 * changes that would normally be done by u-boot should be done in this step.
681 *
682 * @fdt: Devicetree that will be passed on, or NULL
683 */
684void spl_board_prepare_for_optee(void *fdt);
Michal Simek7a8465b2016-05-10 07:54:20 +0200685void spl_board_prepare_for_boot(void);
Ladislav Michl2a8ea482016-07-12 20:28:13 +0200686int spl_board_ubi_load_image(u32 boot_device);
Tom Rinie0897402023-07-13 20:37:34 -0400687int spl_board_boot_device(enum boot_device boot_dev_spl);
Simon Glassb805c352016-09-24 18:19:54 -0600688
689/**
Heiko Thiery3db30332022-01-17 16:25:41 +0100690 * spl_board_loader_name() - Return a name for the loader
691 *
692 * This is a weak function which might be overridden by the board code. With
693 * that a board specific value for the device where the U-Boot will be loaded
694 * from can be set. By default it returns NULL.
695 *
696 * @boot_device: ID of the device which SPL wants to load U-Boot from.
697 */
698const char *spl_board_loader_name(u32 boot_device);
699
700/**
Simon Glassb805c352016-09-24 18:19:54 -0600701 * jump_to_image_linux() - Jump to a Linux kernel from SPL
702 *
703 * This jumps into a Linux kernel using the information in @spl_image.
704 *
705 * @spl_image: Image description to set up
Simon Glassb805c352016-09-24 18:19:54 -0600706 */
Vikas Manocha62b021c2017-04-07 15:38:13 -0700707void __noreturn jump_to_image_linux(struct spl_image_info *spl_image);
Simon Glass3e6b1c32016-09-24 18:19:55 -0600708
709/**
Ovidiu Panait6abd6d82023-01-22 19:57:13 +0200710 * jump_to_image_optee() - Jump to OP-TEE OS from SPL
Ricardo Salvetiec0352a2021-10-20 15:12:06 +0300711 *
712 * This jumps into OP-TEE OS using the information in @spl_image.
713 *
714 * @spl_image: Image description to set up
715 */
716void __noreturn jump_to_image_optee(struct spl_image_info *spl_image);
717
718/**
Simon Glass3e6b1c32016-09-24 18:19:55 -0600719 * spl_start_uboot() - Check if SPL should start the kernel or U-Boot
720 *
721 * This is called by the various SPL loaders to determine whether the board
722 * wants to load the kernel or U-Boot. This function should be provided by
723 * the board.
724 *
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +0100725 * Return: 0 if SPL should start the kernel, 1 if U-Boot must be started
Simon Glass3e6b1c32016-09-24 18:19:55 -0600726 */
Tom Rini28591df2012-08-13 12:03:19 -0700727int spl_start_uboot(void);
Simon Glass3e6b1c32016-09-24 18:19:55 -0600728
Simon Glassf481ab12016-09-24 18:19:56 -0600729/**
730 * spl_display_print() - Display a board-specific message in SPL
731 *
732 * If CONFIG_SPL_DISPLAY_PRINT is enabled, U-Boot will call this function
733 * immediately after displaying the SPL console banner ("U-Boot SPL ...").
734 * This function should be provided by the board.
735 */
Tom Rini28591df2012-08-13 12:03:19 -0700736void spl_display_print(void);
737
Simon Glassc0b6c9b2016-09-24 18:19:57 -0600738/**
739 * struct spl_boot_device - Describes a boot device used by SPL
740 *
741 * @boot_device: A number indicating the BOOT_DEVICE type. There are various
742 * BOOT_DEVICE... #defines and enums in U-Boot and they are not consistently
743 * numbered.
744 * @boot_device_name: Named boot device, or NULL if none.
745 *
746 * Note: Additional fields can be added here, bearing in mind that SPL is
747 * size-sensitive and common fields will be present on all boards. This
748 * struct can also be used to return additional information about the load
749 * process if that becomes useful.
750 */
751struct spl_boot_device {
752 uint boot_device;
753 const char *boot_device_name;
754};
755
Simon Glassd1cf3732016-09-24 18:19:58 -0600756/**
757 * Holds information about a way of loading an SPL image
758 *
Simon Glass4fc1f252016-11-30 15:30:50 -0700759 * @name: User-friendly name for this method (e.g. "MMC")
Simon Glassd1cf3732016-09-24 18:19:58 -0600760 * @boot_device: Boot device that this loader supports
761 * @load_image: Function to call to load image
762 */
763struct spl_image_loader {
Simon Glass4fc1f252016-11-30 15:30:50 -0700764#ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
765 const char *name;
766#endif
Simon Glassd1cf3732016-09-24 18:19:58 -0600767 uint boot_device;
768 /**
769 * load_image() - Load an SPL image
770 *
Simon Glassee306792016-09-24 18:20:13 -0600771 * @spl_image: place to put image information
Simon Glassd1cf3732016-09-24 18:19:58 -0600772 * @bootdev: describes the boot device to load from
773 */
Simon Glassee306792016-09-24 18:20:13 -0600774 int (*load_image)(struct spl_image_info *spl_image,
775 struct spl_boot_device *bootdev);
Simon Glassd1cf3732016-09-24 18:19:58 -0600776};
777
Simon Glass58254e02021-07-05 16:32:57 -0600778/* Helper function for accessing the name */
779static inline const char *spl_loader_name(const struct spl_image_loader *loader)
780{
781#ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
Heiko Thiery3db30332022-01-17 16:25:41 +0100782 const char *name;
783 name = spl_board_loader_name(loader->boot_device);
784 return name ?: loader->name;
Simon Glass58254e02021-07-05 16:32:57 -0600785#else
786 return NULL;
787#endif
788}
789
Simon Glassd1cf3732016-09-24 18:19:58 -0600790/* Declare an SPL image loader */
791#define SPL_LOAD_IMAGE(__name) \
792 ll_entry_declare(struct spl_image_loader, __name, spl_image_loader)
793
794/*
Simon Glassbf4fd552016-11-30 15:30:49 -0700795 * _priority is the priority of this method, 0 meaning it will be the top
Simon Glassd1cf3732016-09-24 18:19:58 -0600796 * choice for this device, 9 meaning it is the bottom choice.
Simon Glassbf4fd552016-11-30 15:30:49 -0700797 * _boot_device is the BOOT_DEVICE_... value
798 * _method is the load_image function to call
Simon Glassd1cf3732016-09-24 18:19:58 -0600799 */
Simon Glass4fc1f252016-11-30 15:30:50 -0700800#ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
801#define SPL_LOAD_IMAGE_METHOD(_name, _priority, _boot_device, _method) \
Simon Glassec1503c2019-10-20 21:31:45 -0600802 SPL_LOAD_IMAGE(_boot_device ## _priority ## _method) = { \
Simon Glass4fc1f252016-11-30 15:30:50 -0700803 .name = _name, \
Simon Glassbf4fd552016-11-30 15:30:49 -0700804 .boot_device = _boot_device, \
805 .load_image = _method, \
Simon Glassd1cf3732016-09-24 18:19:58 -0600806 }
Simon Glass4fc1f252016-11-30 15:30:50 -0700807#else
808#define SPL_LOAD_IMAGE_METHOD(_name, _priority, _boot_device, _method) \
Simon Glassec1503c2019-10-20 21:31:45 -0600809 SPL_LOAD_IMAGE(_boot_device ## _priority ## _method) = { \
Simon Glass4fc1f252016-11-30 15:30:50 -0700810 .boot_device = _boot_device, \
811 .load_image = _method, \
812 }
813#endif
Simon Glassd1cf3732016-09-24 18:19:58 -0600814
Sean Anderson576295d2023-10-14 16:48:02 -0400815#define SPL_LOAD_IMAGE_GET(_priority, _boot_device, _method) \
816 ll_entry_get(struct spl_image_loader, \
817 _boot_device ## _priority ## _method, spl_image_loader)
818
Dan Murphyb7b5b0c2014-01-16 11:23:29 -0600819/* SPL FAT image functions */
Sean Anderson13e6d912023-10-14 16:47:54 -0400820
821/**
822 * spl_fat_force_reregister() - Force reregistration of FAT block devices
823 *
824 * To avoid repeatedly looking up block devices, spl_load_image_fat keeps track
825 * of whether it has already registered a block device. This is fine for most
826 * cases, but when running unit tests all devices are removed and recreated
827 * in-between tests. This function will force re-registration of any block
828 * devices, ensuring that we don't try to use an invalid block device.
829 */
830void spl_fat_force_reregister(void);
831
Simon Glass3eb382a2016-09-24 18:20:15 -0600832int spl_load_image_fat(struct spl_image_info *spl_image,
Pali Rohárdda8f882022-01-14 14:31:38 +0100833 struct spl_boot_device *bootdev,
Simon Glass3eb382a2016-09-24 18:20:15 -0600834 struct blk_desc *block_dev, int partition,
Simon Glasse3394752016-02-29 15:25:34 -0700835 const char *filename);
Simon Glass3eb382a2016-09-24 18:20:15 -0600836int spl_load_image_fat_os(struct spl_image_info *spl_image,
Pali Rohárdda8f882022-01-14 14:31:38 +0100837 struct spl_boot_device *bootdev,
Simon Glass3eb382a2016-09-24 18:20:15 -0600838 struct blk_desc *block_dev, int partition);
Dan Murphyb7b5b0c2014-01-16 11:23:29 -0600839
Jeroen Hofstee454c0712014-10-08 22:58:07 +0200840void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image);
841
Guillaume GARDET1eb410c2014-10-15 17:53:12 +0200842/* SPL EXT image functions */
Simon Glass0649e912016-09-24 18:20:14 -0600843int spl_load_image_ext(struct spl_image_info *spl_image,
Pali Rohárdda8f882022-01-14 14:31:38 +0100844 struct spl_boot_device *bootdev,
Simon Glass0649e912016-09-24 18:20:14 -0600845 struct blk_desc *block_dev, int partition,
Simon Glasse3394752016-02-29 15:25:34 -0700846 const char *filename);
Simon Glass0649e912016-09-24 18:20:14 -0600847int spl_load_image_ext_os(struct spl_image_info *spl_image,
Pali Rohárdda8f882022-01-14 14:31:38 +0100848 struct spl_boot_device *bootdev,
Simon Glass0649e912016-09-24 18:20:14 -0600849 struct blk_desc *block_dev, int partition);
Mayuresh Chitale5d96a912023-06-03 19:32:54 +0530850int spl_blk_load_image(struct spl_image_info *spl_image,
851 struct spl_boot_device *bootdev,
852 enum uclass_id uclass_id, int devnum, int partnum);
Guillaume GARDET1eb410c2014-10-15 17:53:12 +0200853
Simon Glassfa2a4db2015-06-23 15:39:10 -0600854/**
Eddie Cai32258992017-03-15 08:43:28 -0600855 * spl_early_init() - Set up device tree and driver model in SPL if enabled
Simon Glassfa2a4db2015-06-23 15:39:10 -0600856 *
857 * Call this function in board_init_f() if you want to use device tree and
Eddie Cai32258992017-03-15 08:43:28 -0600858 * driver model early, before board_init_r() is called.
859 *
860 * If this is not called, then driver model will be inactive in SPL's
861 * board_init_f(), and no device tree will be available.
862 */
863int spl_early_init(void);
864
865/**
866 * spl_init() - Set up device tree and driver model in SPL if enabled
867 *
868 * You can optionally call spl_early_init(), then optionally call spl_init().
869 * This function will be called from board_init_r() if not called earlier.
870 *
871 * Both spl_early_init() and spl_init() perform a similar function except that
872 * the latter will not set up the malloc() area if
873 * CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN is enabled, since it is assumed to
874 * already be done by a calll to spl_relocate_stack_gd() before board_init_r()
875 * is reached.
876 *
877 * This function will be called from board_init_r() if not called earlier.
Simon Glassfa2a4db2015-06-23 15:39:10 -0600878 *
879 * If this is not called, then driver model will be inactive in SPL's
880 * board_init_f(), and no device tree will be available.
881 */
882int spl_init(void);
883
Simon Glasse49743f2023-09-26 08:14:20 -0600884/*
Lukas Funkee51ca6a2024-03-27 13:11:52 +0100885 * spl_soc_init() - Do architecture-specific init in SPL
886 *
887 * If SPL_SOC_INIT is enabled, this is called from board_init_r() before
888 * jumping to the next phase.
889 */
890void spl_soc_init(void);
891
892/*
Simon Glasse49743f2023-09-26 08:14:20 -0600893 * spl_board_init() - Do board-specific init in SPL
894 *
895 * If xPL_BOARD_INIT is enabled, this is called from board_init_r() before
896 * jumping to the next phase.
897 */
Tom Rini28591df2012-08-13 12:03:19 -0700898void spl_board_init(void);
Simon Glassa77e1b82015-05-13 07:02:24 -0600899
900/**
901 * spl_was_boot_source() - check if U-Boot booted from SPL
902 *
903 * This will normally be true, but if U-Boot jumps to second U-Boot, it will
904 * be false. This should be implemented by board-specific code.
905 *
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +0100906 * Return: true if U-Boot booted from SPL, else false
Simon Glassa77e1b82015-05-13 07:02:24 -0600907 */
908bool spl_was_boot_source(void);
909
B, Ravid207b7e2016-07-28 17:39:16 +0530910/**
911 * spl_dfu_cmd- run dfu command with chosen mmc device interface
912 * @param usb_index - usb controller number
913 * @param mmc_dev - mmc device nubmer
914 *
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +0100915 * Return: 0 on success, otherwise error code
B, Ravid207b7e2016-07-28 17:39:16 +0530916 */
917int spl_dfu_cmd(int usbctrl, char *dfu_alt_info, char *interface, char *devstr);
Simon Glass8dd1c9e2016-09-24 18:19:51 -0600918
Sean Anderson13e6d912023-10-14 16:47:54 -0400919/**
920 * spl_mmc_clear_cache() - Clear cached MMC devices
921 *
922 * To avoid reinitializing MMCs, spl_mmc_load caches the most-recently-used MMC
923 * device. This is fine for most cases, but when running unit tests all devices
924 * are removed and recreated in-between tests. This function will clear any
925 * cached state, ensuring that we don't try to use an invalid MMC.
926 */
927void spl_mmc_clear_cache(void);
928
Marek Vasut8d5c4c32016-12-01 02:06:35 +0100929int spl_mmc_load_image(struct spl_image_info *spl_image,
930 struct spl_boot_device *bootdev);
931
Philipp Tomsichf13e9e02017-09-13 21:29:31 +0200932/**
Andreas Dannenberg8d9f7f12019-06-04 17:55:46 -0500933 * spl_mmc_load() - Load an image file from MMC/SD media
934 *
935 * @param spl_image Image data filled in by loading process
936 * @param bootdev Describes which device to load from
937 * @param filename Name of file to load (in FS mode)
938 * @param raw_part Partition to load from (in RAW mode)
939 * @param raw_sect Sector to load from (in RAW mode)
940 *
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +0100941 * Return: 0 on success, otherwise error code
Andreas Dannenberg8d9f7f12019-06-04 17:55:46 -0500942 */
943int spl_mmc_load(struct spl_image_info *spl_image,
944 struct spl_boot_device *bootdev,
945 const char *filename,
946 int raw_part,
947 unsigned long raw_sect);
948
Faiz Abbas05e3a152020-08-03 11:35:04 +0530949/**
950 * spl_usb_load() - Load an image file from USB mass storage
951 *
952 * @param spl_image Image data filled in by loading process
953 * @param bootdev Describes which device to load from
954 * @param raw_part Fat partition to load from
955 * @param filename Name of file to load
956 *
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +0100957 * Return: 0 on success, otherwise error code
Faiz Abbas05e3a152020-08-03 11:35:04 +0530958 */
959int spl_usb_load(struct spl_image_info *spl_image,
960 struct spl_boot_device *bootdev,
961 int partition, const char *filename);
962
Andreas Dannenberg58892082019-08-15 15:55:27 -0500963int spl_ymodem_load_image(struct spl_image_info *spl_image,
964 struct spl_boot_device *bootdev);
Devarsh Thakkar84e08342023-12-05 21:25:16 +0530965/**
966 * spl_reserve_video_from_ram_top() - Reserve framebuffer memory from end of RAM
967 *
968 * This enforces framebuffer reservation at SPL stage from end of RAM so that
969 * next stage can directly skip this pre-reserved area before carrying out
970 * further reservations. The allocation address is stored in struct video_uc_plat.
971 *
972 * Return: 0 on success, otherwise error code
973 */
974int spl_reserve_video_from_ram_top(void);
Andreas Dannenberg58892082019-08-15 15:55:27 -0500975
Andreas Dannenberg8d9f7f12019-06-04 17:55:46 -0500976/**
Philipp Tomsichf13e9e02017-09-13 21:29:31 +0200977 * spl_invoke_atf - boot using an ARM trusted firmware image
978 */
Chanho Park53a44fc2023-09-08 17:08:56 +0900979void __noreturn spl_invoke_atf(struct spl_image_info *spl_image);
Philipp Tomsich83ad7022017-06-22 23:38:36 +0200980
981/**
Michael Walle2def7d92020-11-18 17:45:56 +0100982 * bl2_plat_get_bl31_params() - return params for bl31.
983 * @bl32_entry: address of BL32 executable (secure)
984 * @bl33_entry: address of BL33 executable (non secure)
985 * @fdt_addr: address of Flat Device Tree
Michal Simekd1598e22019-12-19 18:13:31 +0100986 *
Michael Walle2def7d92020-11-18 17:45:56 +0100987 * This is a weak function which might be overridden by the board code. By
988 * default it will just call bl2_plat_get_bl31_params_default().
Michal Simekd1598e22019-12-19 18:13:31 +0100989 *
Michael Walle2def7d92020-11-18 17:45:56 +0100990 * If you just want to manipulate or add some parameters, you can override
991 * this function, call bl2_plat_get_bl31_params_default and operate on the
992 * returned bl31 params.
993 *
994 * Return: bl31 params structure pointer
Michal Simekd1598e22019-12-19 18:13:31 +0100995 */
Simon Glass9a9097f2024-12-19 11:29:00 -0700996struct bl31_params *bl2_plat_get_bl31_params(ulong bl32_entry,
997 ulong bl33_entry,
998 ulong fdt_addr);
Michal Simekd1598e22019-12-19 18:13:31 +0100999
1000/**
Michael Walle2def7d92020-11-18 17:45:56 +01001001 * bl2_plat_get_bl31_params_default() - prepare params for bl31.
1002 * @bl32_entry: address of BL32 executable (secure)
1003 * @bl33_entry: address of BL33 executable (non secure)
1004 * @fdt_addr: address of Flat Device Tree
1005 *
1006 * This is the default implementation of bl2_plat_get_bl31_params(). It assigns
1007 * a pointer to the memory that the platform has kept aside to pass platform
1008 * specific and trusted firmware related information to BL31. This memory is
1009 * allocated by allocating memory to bl2_to_bl31_params_mem structure which is
1010 * a superset of all the structure whose information is passed to BL31
1011 *
1012 * NOTE: The memory is statically allocated, thus this function should be
1013 * called only once. All subsequent calls will overwrite any changes.
1014 *
1015 * Return: bl31 params structure pointer
1016 */
Simon Glass9a9097f2024-12-19 11:29:00 -07001017struct bl31_params *bl2_plat_get_bl31_params_default(ulong bl32_entry,
1018 ulong bl33_entry,
1019 ulong fdt_addr);
Michael Walleafaf6ea2020-11-18 17:45:58 +01001020
1021/**
1022 * bl2_plat_get_bl31_params_v2() - return params for bl31
1023 * @bl32_entry: address of BL32 executable (secure)
1024 * @bl33_entry: address of BL33 executable (non secure)
1025 * @fdt_addr: address of Flat Device Tree
1026 *
1027 * This function does the same as bl2_plat_get_bl31_params() except that is is
1028 * used for the new LOAD_IMAGE_V2 option, which uses a slightly different
1029 * method to pass the parameters.
1030 *
1031 * Return: bl31 params structure pointer
1032 */
Simon Glass9a9097f2024-12-19 11:29:00 -07001033struct bl_params *bl2_plat_get_bl31_params_v2(ulong bl32_entry,
1034 ulong bl33_entry,
1035 ulong fdt_addr);
Michael Walleafaf6ea2020-11-18 17:45:58 +01001036
1037/**
1038 * bl2_plat_get_bl31_params_v2_default() - prepare params for bl31.
1039 * @bl32_entry: address of BL32 executable (secure)
1040 * @bl33_entry: address of BL33 executable (non secure)
1041 * @fdt_addr: address of Flat Device Tree
1042 *
1043 * This is the default implementation of bl2_plat_get_bl31_params_v2(). It
1044 * prepares the linked list of the bl31 params, populates the image types and
1045 * set the entry points for bl32 and bl33 (if available).
1046 *
1047 * NOTE: The memory is statically allocated, thus this function should be
1048 * called only once. All subsequent calls will overwrite any changes.
1049 *
1050 * Return: bl31 params structure pointer
1051 */
Simon Glass9a9097f2024-12-19 11:29:00 -07001052struct bl_params *bl2_plat_get_bl31_params_v2_default(ulong bl32_entry,
1053 ulong bl33_entry,
1054 ulong fdt_addr);
Michael Walle2def7d92020-11-18 17:45:56 +01001055/**
Kever Yanga28d42c2018-08-23 17:17:59 +08001056 * spl_optee_entry - entry function for optee
1057 *
1058 * args defind in op-tee project
1059 * https://github.com/OP-TEE/optee_os/
1060 * core/arch/arm/kernel/generic_entry_a32.S
1061 * @arg0: pagestore
1062 * @arg1: (ARMv7 standard bootarg #1)
1063 * @arg2: device tree address, (ARMv7 standard bootarg #2)
1064 * @arg3: non-secure entry address (ARMv7 bootarg #0)
1065 */
Ricardo Salvetiec0352a2021-10-20 15:12:06 +03001066void __noreturn spl_optee_entry(void *arg0, void *arg1, void *arg2, void *arg3);
Kever Yanga28d42c2018-08-23 17:17:59 +08001067
1068/**
Lukas Auer515b9342019-08-21 21:14:44 +02001069 * spl_invoke_opensbi - boot using a RISC-V OpenSBI image
1070 */
Chanho Park8973e372023-08-29 10:20:14 +09001071void __noreturn spl_invoke_opensbi(struct spl_image_info *spl_image);
Lukas Auer515b9342019-08-21 21:14:44 +02001072
1073/**
Philipp Tomsich83ad7022017-06-22 23:38:36 +02001074 * board_return_to_bootrom - allow for boards to continue with the boot ROM
1075 *
1076 * If a board (e.g. the Rockchip RK3368 boards) provide some
1077 * supporting functionality for SPL in their boot ROM and the SPL
1078 * stage wants to return to the ROM code to continue booting, boards
1079 * can implement 'board_return_to_bootrom'.
1080 */
Peng Fanaa050c52019-08-07 06:40:53 +00001081int board_return_to_bootrom(struct spl_image_info *spl_image,
1082 struct spl_boot_device *bootdev);
Philipp Tomsich58beb6e2018-05-24 17:15:50 +02001083
1084/**
Peng Fanc86bacd2018-11-17 09:10:31 +00001085 * board_spl_fit_size_align - specific size align before processing payload
1086 *
1087 */
1088ulong board_spl_fit_size_align(ulong size);
1089
1090/**
Philipp Tomsich58beb6e2018-05-24 17:15:50 +02001091 * spl_perform_fixups() - arch/board-specific callback before processing
1092 * the boot-payload
1093 */
1094void spl_perform_fixups(struct spl_image_info *spl_image);
Marek Vasut1dda46f2018-08-14 11:27:02 +02001095
1096/*
1097 * spl_get_load_buffer() - get buffer for loading partial image data
1098 *
1099 * Returns memory area which can be populated by partial image data,
1100 * ie. uImage or fitImage header.
1101 */
Simon Glassbb7d3bb2022-09-06 20:26:52 -06001102struct legacy_img_hdr *spl_get_load_buffer(ssize_t offset, size_t size);
Marek Vasut1dda46f2018-08-14 11:27:02 +02001103
Marek Vasuta0494272023-09-21 20:44:16 +02001104/**
1105 * board_spl_fit_append_fdt_skip(): test whether DTO application should be skipped
1106 * @name: DTO node name within fitImage images node
1107 *
1108 * A board-specific function used to indicate whether a DTO from fitImage
1109 * configuration node 'fdt' property DT and DTO list should be applied onto
1110 * the base DT or not applied.
1111 *
1112 * This is useful in case of DTOs which implement e.g. different board revision
1113 * details, where such DTO should be applied on one board revision, and should
1114 * not be applied on another board revision.
1115 *
1116 * Return: 0 to indicate DTO is not skipped, all else to indicate DTO is skipped.
1117 */
1118int board_spl_fit_append_fdt_skip(const char *name);
1119
Algapally Santosh Sagar4e3bdb52023-03-01 03:33:34 -07001120void board_boot_order(u32 *spl_boot_list);
Peng Fan617fc292020-05-05 20:28:41 +08001121void spl_save_restore_data(void);
Simon Glassc0bd55e2023-09-26 08:14:34 -06001122
1123/**
1124 * spl_load_fit_image() - Fully parse and a FIT image in SPL
1125 *
1126 * @spl_image: SPL Image data to fill in
1127 * @header: Pointer to FIT image
1128 * Return 0 if OK, -ve on error
1129 */
1130int spl_load_fit_image(struct spl_image_info *spl_image,
1131 const struct legacy_img_hdr *header);
1132
Manoj Sai2b2e6282023-09-18 00:56:25 +05301133/*
1134 * spl_decompression_enabled() - check decompression support is enabled for SPL build
1135 *
1136 * Returns true if decompression support is enabled, else False
1137 */
1138static inline bool spl_decompression_enabled(void)
1139{
Manoj Saia8560992023-09-18 00:56:26 +05301140 return IS_ENABLED(CONFIG_SPL_GZIP) || IS_ENABLED(CONFIG_SPL_LZMA);
Manoj Sai2b2e6282023-09-18 00:56:25 +05301141}
Simon Glassbc3ec002024-08-07 16:47:31 -06001142
1143/**
1144 * spl_write_upl_handoff() - Write a Universal Payload hand-off structure
1145 *
1146 * @spl_image: Information about the image being booted
1147 * Return: 0 if OK, -ve on error
1148 */
1149int spl_write_upl_handoff(struct spl_image_info *spl_image);
1150
1151/**
1152 * spl_upl_init() - Get UPL ready for information to be added
1153 *
1154 * This must be called before upl_add_image(), etc.
1155 */
1156void spl_upl_init(void);
1157
Tom Rini28591df2012-08-13 12:03:19 -07001158#endif