blob: 8ceb3c0f095e4e5f4232f0649317d93e0e82c213 [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>
Tom Rini28591df2012-08-13 12:03:19 -070017
Masahiro Yamada5a5ef782020-02-25 02:25:46 +090018struct blk_desc;
19struct image_header;
20
Simon Glassa77e1b82015-05-13 07:02:24 -060021/* Value in r0 indicates we booted from U-Boot */
22#define UBOOT_NOT_LOADED_FROM_SPL 0x13578642
Dan Murphyb7b5b0c2014-01-16 11:23:29 -060023
Tom Rini28591df2012-08-13 12:03:19 -070024/* Boot type */
25#define MMCSD_MODE_UNDEFINED 0
26#define MMCSD_MODE_RAW 1
Guillaume GARDET602a16c2014-10-15 17:53:11 +020027#define MMCSD_MODE_FS 2
Tom Rinicc612692014-02-05 10:24:18 -050028#define MMCSD_MODE_EMMCBOOT 3
Tom Rini28591df2012-08-13 12:03:19 -070029
Simon Glass655306c2020-05-10 11:39:58 -060030struct blk_desc;
Simon Glass1e268642020-05-10 11:39:55 -060031struct image_header;
Pali Rohárdda8f882022-01-14 14:31:38 +010032struct spl_boot_device;
Simon Glass1e268642020-05-10 11:39:55 -060033
Simon Glass4e0a52d2018-11-15 18:43:51 -070034/*
35 * u_boot_first_phase() - check if this is the first U-Boot phase
36 *
37 * U-Boot has up to three phases: TPL, SPL and U-Boot proper. Depending on the
38 * build flags we can determine whether the current build is for the first
39 * phase of U-Boot or not. If there is no SPL, then this is U-Boot proper. If
40 * there is SPL but no TPL, the the first phase is SPL. If there is TPL, then
41 * it is the first phase.
42 *
43 * @returns true if this is the first phase of U-Boot
44 *
45 */
46static inline bool u_boot_first_phase(void)
47{
48 if (IS_ENABLED(CONFIG_TPL)) {
49 if (IS_ENABLED(CONFIG_TPL_BUILD))
50 return true;
51 } else if (IS_ENABLED(CONFIG_SPL)) {
52 if (IS_ENABLED(CONFIG_SPL_BUILD))
53 return true;
54 } else {
55 return true;
56 }
57
58 return false;
59}
60
Simon Glassb7fb5132019-09-25 08:11:20 -060061enum u_boot_phase {
Simon Glass95e4ec12021-01-13 20:29:42 -070062 PHASE_NONE, /* Invalid phase, signifying before U-Boot */
Simon Glass3c573b52019-09-25 08:56:30 -060063 PHASE_TPL, /* Running in TPL */
64 PHASE_SPL, /* Running in SPL */
65 PHASE_BOARD_F, /* Running in U-Boot before relocation */
66 PHASE_BOARD_R, /* Running in U-Boot after relocation */
Simon Glassb7fb5132019-09-25 08:11:20 -060067};
68
69/**
70 * spl_phase() - Find out the phase of U-Boot
71 *
72 * This can be used to avoid #ifdef logic and use if() instead.
73 *
74 * For example, to include code only in TPL, you might do:
75 *
76 * #ifdef CONFIG_TPL_BUILD
77 * ...
78 * #endif
79 *
80 * but with this you can use:
81 *
82 * if (spl_phase() == PHASE_TPL) {
83 * ...
84 * }
85 *
86 * To include code only in SPL, you might do:
87 *
88 * #if defined(CONFIG_SPL_BUILD) && !defined(CONFIG_TPL_BUILD)
89 * ...
90 * #endif
91 *
92 * but with this you can use:
93 *
94 * if (spl_phase() == PHASE_SPL) {
95 * ...
96 * }
97 *
98 * To include code only in U-Boot proper, you might do:
99 *
100 * #ifndef CONFIG_SPL_BUILD
101 * ...
102 * #endif
103 *
104 * but with this you can use:
105 *
Simon Glass3c573b52019-09-25 08:56:30 -0600106 * if (spl_phase() == PHASE_BOARD_F) {
Simon Glassb7fb5132019-09-25 08:11:20 -0600107 * ...
108 * }
109 *
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +0100110 * Return: U-Boot phase
Simon Glassb7fb5132019-09-25 08:11:20 -0600111 */
112static inline enum u_boot_phase spl_phase(void)
113{
114#ifdef CONFIG_TPL_BUILD
115 return PHASE_TPL;
116#elif CONFIG_SPL_BUILD
117 return PHASE_SPL;
118#else
Simon Glass3c573b52019-09-25 08:56:30 -0600119 DECLARE_GLOBAL_DATA_PTR;
120
121 if (!(gd->flags & GD_FLG_RELOC))
122 return PHASE_BOARD_F;
123 else
124 return PHASE_BOARD_R;
Simon Glassb7fb5132019-09-25 08:11:20 -0600125#endif
126}
127
Simon Glass95e4ec12021-01-13 20:29:42 -0700128/**
129 * spl_prev_phase() - Figure out the previous U-Boot phase
130 *
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +0100131 * Return: the previous phase from this one, e.g. if called in SPL this returns
Simon Glass95e4ec12021-01-13 20:29:42 -0700132 * PHASE_TPL, if TPL is enabled
133 */
134static inline enum u_boot_phase spl_prev_phase(void)
135{
136#ifdef CONFIG_TPL_BUILD
137 return PHASE_NONE;
138#elif defined(CONFIG_SPL_BUILD)
139 return IS_ENABLED(CONFIG_TPL) ? PHASE_TPL : PHASE_NONE;
140#else
141 return IS_ENABLED(CONFIG_SPL) ? PHASE_SPL : PHASE_NONE;
142#endif
143}
144
145/**
146 * spl_next_phase() - Figure out the next U-Boot phase
147 *
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +0100148 * Return: the next phase from this one, e.g. if called in TPL this returns
Simon Glass95e4ec12021-01-13 20:29:42 -0700149 * PHASE_SPL
150 */
151static inline enum u_boot_phase spl_next_phase(void)
152{
153#ifdef CONFIG_TPL_BUILD
154 return PHASE_SPL;
155#else
156 return PHASE_BOARD_F;
157#endif
158}
159
160/**
161 * spl_phase_name() - Get the name of the current phase
162 *
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +0100163 * Return: phase name
Simon Glass95e4ec12021-01-13 20:29:42 -0700164 */
165static inline const char *spl_phase_name(enum u_boot_phase phase)
166{
167 switch (phase) {
168 case PHASE_TPL:
169 return "TPL";
170 case PHASE_SPL:
171 return "SPL";
172 case PHASE_BOARD_F:
173 case PHASE_BOARD_R:
174 return "U-Boot";
175 default:
176 return "phase?";
177 }
178}
179
Simon Glass1cd06002021-07-05 16:32:45 -0600180/**
181 * spl_phase_prefix() - Get the prefix of the current phase
182 *
183 * @phase: Phase to look up
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +0100184 * Return: phase prefix ("spl", "tpl", etc.)
Simon Glass1cd06002021-07-05 16:32:45 -0600185 */
186static inline const char *spl_phase_prefix(enum u_boot_phase phase)
187{
188 switch (phase) {
189 case PHASE_TPL:
190 return "tpl";
191 case PHASE_SPL:
192 return "spl";
193 case PHASE_BOARD_F:
194 case PHASE_BOARD_R:
195 return "";
196 default:
197 return "phase?";
198 }
199}
200
Simon Glassdbd3f112018-11-15 18:43:56 -0700201/* A string name for SPL or TPL */
202#ifdef CONFIG_SPL_BUILD
203# ifdef CONFIG_TPL_BUILD
Heiko Schocherce251232018-12-05 11:29:54 +0100204# define SPL_TPL_NAME "TPL"
Simon Glassdbd3f112018-11-15 18:43:56 -0700205# else
Heiko Schocherce251232018-12-05 11:29:54 +0100206# define SPL_TPL_NAME "SPL"
Simon Glassdbd3f112018-11-15 18:43:56 -0700207# endif
208# define SPL_TPL_PROMPT SPL_TPL_NAME ": "
209#else
210# define SPL_TPL_NAME ""
211# define SPL_TPL_PROMPT ""
212#endif
213
Tom Rini28591df2012-08-13 12:03:19 -0700214struct spl_image_info {
215 const char *name;
216 u8 os;
Philipp Tomsichf13e9e02017-09-13 21:29:31 +0200217 uintptr_t load_addr;
218 uintptr_t entry_point;
Marek Vasut187b9e32019-05-07 21:17:02 +0200219#if CONFIG_IS_ENABLED(LOAD_FIT) || CONFIG_IS_ENABLED(LOAD_FIT_FULL)
Philipp Tomsichbe5ac1a2017-09-13 21:29:30 +0200220 void *fdt_addr;
221#endif
Philipp Tomsich58beb6e2018-05-24 17:15:50 +0200222 u32 boot_device;
Pali Rohár11041672021-07-23 11:14:27 +0200223 u32 offset;
Tom Rini28591df2012-08-13 12:03:19 -0700224 u32 size;
Stefan Roese00b57b32012-08-27 12:50:58 +0200225 u32 flags;
Vikas Manocha62b021c2017-04-07 15:38:13 -0700226 void *arg;
Simon Goldschmidt17140472019-02-10 21:34:37 +0100227#ifdef CONFIG_SPL_LEGACY_IMAGE_CRC_CHECK
228 ulong dcrc_data;
229 ulong dcrc_length;
230 ulong dcrc;
231#endif
Tom Rini28591df2012-08-13 12:03:19 -0700232};
233
Dario Binacchi0f860b62020-05-27 13:56:18 +0200234/**
Simon Glassa6131a22016-02-22 22:55:56 -0700235 * Information required to load data from a device
236 *
237 * @dev: Pointer to the device, e.g. struct mmc *
238 * @priv: Private data for the device
239 * @bl_len: Block length for reading in bytes
Lokesh Vutlaf62cef12016-05-24 10:34:38 +0530240 * @filename: Name of the fit image file.
Simon Glassa6131a22016-02-22 22:55:56 -0700241 * @read: Function to call to read from the device
242 */
243struct spl_load_info {
244 void *dev;
245 void *priv;
246 int bl_len;
Lokesh Vutlaf62cef12016-05-24 10:34:38 +0530247 const char *filename;
Simon Glassee112092021-03-07 17:35:15 -0700248 /**
249 * read() - Read from device
250 *
251 * @load: Information about the load state
252 * @sector: Sector number to read from (each @load->bl_len bytes)
253 * @count: Number of sectors to read
254 * @buf: Buffer to read into
255 * @return number of sectors read, 0 on error
256 */
Simon Glassa6131a22016-02-22 22:55:56 -0700257 ulong (*read)(struct spl_load_info *load, ulong sector, ulong count,
258 void *buf);
259};
260
Simon Glass867a3982017-11-13 18:55:03 -0700261/*
262 * We need to know the position of U-Boot in memory so we can jump to it. We
263 * allow any U-Boot binary to be used (u-boot.bin, u-boot-nodtb.bin,
264 * u-boot.img), hence the '_any'. These is no checking here that the correct
Simon Glass596f31c2019-12-08 17:40:12 -0700265 * image is found. For example if u-boot.img is used we don't check that
Simon Glass867a3982017-11-13 18:55:03 -0700266 * spl_parse_image_header() can parse a valid header.
Simon Glass596f31c2019-12-08 17:40:12 -0700267 *
268 * Similarly for SPL, so that TPL can jump to SPL.
Simon Glass867a3982017-11-13 18:55:03 -0700269 */
Simon Glass9dcc8612018-08-01 15:22:42 -0600270binman_sym_extern(ulong, u_boot_any, image_pos);
Simon Glass596f31c2019-12-08 17:40:12 -0700271binman_sym_extern(ulong, u_boot_any, size);
Simon Glass9045faf2022-02-08 11:49:47 -0700272binman_sym_extern(ulong, u_boot_spl, image_pos);
273binman_sym_extern(ulong, u_boot_spl, size);
Simon Glass596f31c2019-12-08 17:40:12 -0700274
275/**
276 * spl_get_image_pos() - get the image position of the next phase
277 *
278 * This returns the image position to use to load the next phase of U-Boot
279 */
280ulong spl_get_image_pos(void);
281
282/**
283 * spl_get_image_size() - get the size of the next phase
284 *
285 * This returns the size to use to load the next phase of U-Boot
286 */
287ulong spl_get_image_size(void);
Simon Glass867a3982017-11-13 18:55:03 -0700288
Lokesh Vutlaf62cef12016-05-24 10:34:38 +0530289/**
Simon Glass53857ee2021-01-24 10:06:03 -0700290 * spl_get_image_text_base() - get the text base of the next phase
291 *
292 * This returns the address that the next stage is linked to run at, i.e.
293 * CONFIG_SPL_TEXT_BASE or CONFIG_SYS_TEXT_BASE
294 *
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +0100295 * Return: text-base address
Simon Glass53857ee2021-01-24 10:06:03 -0700296 */
297ulong spl_get_image_text_base(void);
298
299/**
Andreas Dannenberg8d9f7f12019-06-04 17:55:46 -0500300 * spl_load_simple_fit_skip_processing() - Hook to allow skipping the FIT
301 * image processing during spl_load_simple_fit().
302 *
303 * Return true to skip FIT processing, false to preserve the full code flow
304 * of spl_load_simple_fit().
305 */
306bool spl_load_simple_fit_skip_processing(void);
307
308/**
Heiko Schocher67e8f5d2021-08-06 06:44:26 +0200309 * spl_load_simple_fit_fix_load() - Hook to make fixes
310 * after fit image header is loaded
311 *
312 * Returns pointer to fit
313 */
314void *spl_load_simple_fit_fix_load(const void *fit);
315
316/**
Lokesh Vutlaf62cef12016-05-24 10:34:38 +0530317 * spl_load_simple_fit() - Loads a fit image from a device.
Simon Glass43a734f2016-09-24 18:20:16 -0600318 * @spl_image: Image description to set up
Lokesh Vutlaf62cef12016-05-24 10:34:38 +0530319 * @info: Structure containing the information required to load data.
320 * @sector: Sector number where FIT image is located in the device
321 * @fdt: Pointer to the copied FIT header.
322 *
323 * Reads the FIT image @sector in the device. Loads u-boot image to
324 * specified load address and copies the dtb to end of u-boot image.
325 * Returns 0 on success.
326 */
Simon Glass43a734f2016-09-24 18:20:16 -0600327int spl_load_simple_fit(struct spl_image_info *spl_image,
328 struct spl_load_info *info, ulong sector, void *fdt);
Simon Glassa6131a22016-02-22 22:55:56 -0700329
Stefan Roese00b57b32012-08-27 12:50:58 +0200330#define SPL_COPY_PAYLOAD_ONLY 1
Ye Li9d5b0f42018-11-17 09:10:25 +0000331#define SPL_FIT_FOUND 2
Stefan Roese00b57b32012-08-27 12:50:58 +0200332
Peng Fand8670762019-08-22 07:42:38 +0000333/**
Stefan Roese84ae9d82020-04-21 09:28:43 +0200334 * spl_load_legacy_img() - Loads a legacy image from a device.
335 * @spl_image: Image description to set up
336 * @load: Structure containing the information required to load data.
337 * @header: Pointer to image header (including appended image)
338 *
339 * Reads an legacy image from the device. Loads u-boot image to
340 * specified load address.
341 * Returns 0 on success.
342 */
343int spl_load_legacy_img(struct spl_image_info *spl_image,
Pali Rohárdda8f882022-01-14 14:31:38 +0100344 struct spl_boot_device *bootdev,
Stefan Roese84ae9d82020-04-21 09:28:43 +0200345 struct spl_load_info *load, ulong header);
346
347/**
Peng Fand8670762019-08-22 07:42:38 +0000348 * spl_load_imx_container() - Loads a imx container image from a device.
349 * @spl_image: Image description to set up
350 * @info: Structure containing the information required to load data.
351 * @sector: Sector number where container image is located in the device
352 *
353 * Reads the container image @sector in the device. Loads u-boot image to
354 * specified load address.
355 */
356int spl_load_imx_container(struct spl_image_info *spl_image,
357 struct spl_load_info *info, ulong sector);
358
Tom Rini28591df2012-08-13 12:03:19 -0700359/* SPL common functions */
360void preloader_console_init(void);
361u32 spl_boot_device(void);
Harald Seiler0bf7ab12020-04-15 11:33:30 +0200362
363/**
364 * spl_mmc_boot_mode() - Lookup function for the mode of an MMC boot source.
365 * @boot_device: ID of the device which the MMC driver wants to read
366 * from. Common values are e.g. BOOT_DEVICE_MMC1,
367 * BOOT_DEVICE_MMC2, BOOT_DEVICE_MMC2_2.
368 *
369 * This function should return one of MMCSD_MODE_FS, MMCSD_MODE_EMMCBOOT, or
370 * MMCSD_MODE_RAW for each MMC boot source which is defined for the target. The
371 * boot_device parameter tells which device the MMC driver is interested in.
372 *
373 * If not overridden, it is weakly defined in common/spl/spl_mmc.c.
374 *
375 * Note: It is important to use the boot_device parameter instead of e.g.
376 * spl_boot_device() as U-Boot is not always loaded from the same device as SPL.
377 */
378u32 spl_mmc_boot_mode(const u32 boot_device);
Harald Seilerbf16c302020-04-15 11:33:31 +0200379
380/**
381 * spl_mmc_boot_partition() - MMC partition to load U-Boot from.
382 * @boot_device: ID of the device which the MMC driver wants to load
383 * U-Boot from.
384 *
385 * This function should return the partition number which the SPL
386 * should load U-Boot from (on the given boot_device) when
387 * CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_USE_PARTITION is set.
388 *
389 * If not overridden, it is weakly defined in common/spl/spl_mmc.c.
390 */
391int spl_mmc_boot_partition(const u32 boot_device);
Marek Vasutde1ce232021-07-03 04:55:32 +0200392
393struct mmc;
394/**
395 * default_spl_mmc_emmc_boot_partition() - eMMC boot partition to load U-Boot from.
396 * mmc: Pointer for the mmc device structure
397 *
398 * This function should return the eMMC boot partition number which
399 * the SPL should load U-Boot from (on the given boot_device).
400 */
401int default_spl_mmc_emmc_boot_partition(struct mmc *mmc);
402
403/**
404 * spl_mmc_emmc_boot_partition() - eMMC boot partition to load U-Boot from.
405 * mmc: Pointer for the mmc device structure
406 *
407 * This function should return the eMMC boot partition number which
408 * the SPL should load U-Boot from (on the given boot_device).
409 *
410 * If not overridden, it is weakly defined in common/spl/spl_mmc.c
411 * and calls default_spl_mmc_emmc_boot_partition();
412 */
413int spl_mmc_emmc_boot_partition(struct mmc *mmc);
414
Alexandru Gagniuc7861f8b2021-04-08 11:56:11 -0500415void spl_set_bd(void);
Simon Glass11a1a272016-09-24 18:19:52 -0600416
417/**
418 * spl_set_header_raw_uboot() - Set up a standard SPL image structure
419 *
420 * This sets up the given spl_image which the standard values obtained from
421 * config options: CONFIG_SYS_MONITOR_LEN, CONFIG_SYS_UBOOT_START,
422 * CONFIG_SYS_TEXT_BASE.
423 *
Simon Glass6b2e4db2016-09-24 18:19:53 -0600424 * @spl_image: Image description to set up
Simon Glass11a1a272016-09-24 18:19:52 -0600425 */
426void spl_set_header_raw_uboot(struct spl_image_info *spl_image);
427
Simon Glass6b2e4db2016-09-24 18:19:53 -0600428/**
429 * spl_parse_image_header() - parse the image header and set up info
430 *
431 * This parses the legacy image header information at @header and sets up
432 * @spl_image according to what is found. If no image header is found, then
433 * a raw image or bootz is assumed. If CONFIG_SPL_PANIC_ON_RAW_IMAGE is
Andrew F. Davisb4be3c32017-02-16 11:18:38 -0600434 * enabled, then this causes a panic. If CONFIG_SPL_RAW_IMAGE_SUPPORT is not
Simon Glass6b2e4db2016-09-24 18:19:53 -0600435 * enabled then U-Boot gives up. Otherwise U-Boot sets up the image using
436 * spl_set_header_raw_uboot(), or possibly the bootz header.
437 *
438 * @spl_image: Image description to set up
439 * @header image header to parse
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +0100440 * Return: 0 if a header was correctly parsed, -ve on error
Simon Glass6b2e4db2016-09-24 18:19:53 -0600441 */
442int spl_parse_image_header(struct spl_image_info *spl_image,
Pali Rohárdda8f882022-01-14 14:31:38 +0100443 const struct spl_boot_device *bootdev,
Simon Glass6b2e4db2016-09-24 18:19:53 -0600444 const struct image_header *header);
445
Tom Rini28591df2012-08-13 12:03:19 -0700446void spl_board_prepare_for_linux(void);
Alexandru Gagniucf2b410a2021-07-15 14:19:24 -0500447
448/**
449 * spl_board_prepare_for_optee() - Prepare board for an OPTEE payload
450 *
451 * Prepares the board for booting an OP-TEE payload. Initialization is platform
452 * specific, and may include configuring the TrustZone memory, and other
453 * initialization steps required by OP-TEE.
454 * Note that @fdt is not used directly by OP-TEE. OP-TEE passes this @fdt to
455 * its normal world target. This target is not guaranteed to be u-boot, so @fdt
456 * changes that would normally be done by u-boot should be done in this step.
457 *
458 * @fdt: Devicetree that will be passed on, or NULL
459 */
460void spl_board_prepare_for_optee(void *fdt);
Michal Simek7a8465b2016-05-10 07:54:20 +0200461void spl_board_prepare_for_boot(void);
Ladislav Michl2a8ea482016-07-12 20:28:13 +0200462int spl_board_ubi_load_image(u32 boot_device);
Alifer Moraes2649d0c2020-01-14 15:55:01 -0300463int spl_board_boot_device(u32 boot_device);
Simon Glassb805c352016-09-24 18:19:54 -0600464
465/**
Heiko Thiery3db30332022-01-17 16:25:41 +0100466 * spl_board_loader_name() - Return a name for the loader
467 *
468 * This is a weak function which might be overridden by the board code. With
469 * that a board specific value for the device where the U-Boot will be loaded
470 * from can be set. By default it returns NULL.
471 *
472 * @boot_device: ID of the device which SPL wants to load U-Boot from.
473 */
474const char *spl_board_loader_name(u32 boot_device);
475
476/**
Simon Glassb805c352016-09-24 18:19:54 -0600477 * jump_to_image_linux() - Jump to a Linux kernel from SPL
478 *
479 * This jumps into a Linux kernel using the information in @spl_image.
480 *
481 * @spl_image: Image description to set up
Simon Glassb805c352016-09-24 18:19:54 -0600482 */
Vikas Manocha62b021c2017-04-07 15:38:13 -0700483void __noreturn jump_to_image_linux(struct spl_image_info *spl_image);
Simon Glass3e6b1c32016-09-24 18:19:55 -0600484
485/**
Ricardo Salvetiec0352a2021-10-20 15:12:06 +0300486 * jump_to_image_linux() - Jump to OP-TEE OS from SPL
487 *
488 * This jumps into OP-TEE OS using the information in @spl_image.
489 *
490 * @spl_image: Image description to set up
491 */
492void __noreturn jump_to_image_optee(struct spl_image_info *spl_image);
493
494/**
Simon Glass3e6b1c32016-09-24 18:19:55 -0600495 * spl_start_uboot() - Check if SPL should start the kernel or U-Boot
496 *
497 * This is called by the various SPL loaders to determine whether the board
498 * wants to load the kernel or U-Boot. This function should be provided by
499 * the board.
500 *
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +0100501 * Return: 0 if SPL should start the kernel, 1 if U-Boot must be started
Simon Glass3e6b1c32016-09-24 18:19:55 -0600502 */
Tom Rini28591df2012-08-13 12:03:19 -0700503int spl_start_uboot(void);
Simon Glass3e6b1c32016-09-24 18:19:55 -0600504
Simon Glassf481ab12016-09-24 18:19:56 -0600505/**
506 * spl_display_print() - Display a board-specific message in SPL
507 *
508 * If CONFIG_SPL_DISPLAY_PRINT is enabled, U-Boot will call this function
509 * immediately after displaying the SPL console banner ("U-Boot SPL ...").
510 * This function should be provided by the board.
511 */
Tom Rini28591df2012-08-13 12:03:19 -0700512void spl_display_print(void);
513
Simon Glassc0b6c9b2016-09-24 18:19:57 -0600514/**
515 * struct spl_boot_device - Describes a boot device used by SPL
516 *
517 * @boot_device: A number indicating the BOOT_DEVICE type. There are various
518 * BOOT_DEVICE... #defines and enums in U-Boot and they are not consistently
519 * numbered.
520 * @boot_device_name: Named boot device, or NULL if none.
521 *
522 * Note: Additional fields can be added here, bearing in mind that SPL is
523 * size-sensitive and common fields will be present on all boards. This
524 * struct can also be used to return additional information about the load
525 * process if that becomes useful.
526 */
527struct spl_boot_device {
528 uint boot_device;
529 const char *boot_device_name;
530};
531
Simon Glassd1cf3732016-09-24 18:19:58 -0600532/**
533 * Holds information about a way of loading an SPL image
534 *
Simon Glass4fc1f252016-11-30 15:30:50 -0700535 * @name: User-friendly name for this method (e.g. "MMC")
Simon Glassd1cf3732016-09-24 18:19:58 -0600536 * @boot_device: Boot device that this loader supports
537 * @load_image: Function to call to load image
538 */
539struct spl_image_loader {
Simon Glass4fc1f252016-11-30 15:30:50 -0700540#ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
541 const char *name;
542#endif
Simon Glassd1cf3732016-09-24 18:19:58 -0600543 uint boot_device;
544 /**
545 * load_image() - Load an SPL image
546 *
Simon Glassee306792016-09-24 18:20:13 -0600547 * @spl_image: place to put image information
Simon Glassd1cf3732016-09-24 18:19:58 -0600548 * @bootdev: describes the boot device to load from
549 */
Simon Glassee306792016-09-24 18:20:13 -0600550 int (*load_image)(struct spl_image_info *spl_image,
551 struct spl_boot_device *bootdev);
Simon Glassd1cf3732016-09-24 18:19:58 -0600552};
553
Simon Glass58254e02021-07-05 16:32:57 -0600554/* Helper function for accessing the name */
555static inline const char *spl_loader_name(const struct spl_image_loader *loader)
556{
557#ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
Heiko Thiery3db30332022-01-17 16:25:41 +0100558 const char *name;
559 name = spl_board_loader_name(loader->boot_device);
560 return name ?: loader->name;
Simon Glass58254e02021-07-05 16:32:57 -0600561#else
562 return NULL;
563#endif
564}
565
Simon Glassd1cf3732016-09-24 18:19:58 -0600566/* Declare an SPL image loader */
567#define SPL_LOAD_IMAGE(__name) \
568 ll_entry_declare(struct spl_image_loader, __name, spl_image_loader)
569
570/*
Simon Glassbf4fd552016-11-30 15:30:49 -0700571 * _priority is the priority of this method, 0 meaning it will be the top
Simon Glassd1cf3732016-09-24 18:19:58 -0600572 * choice for this device, 9 meaning it is the bottom choice.
Simon Glassbf4fd552016-11-30 15:30:49 -0700573 * _boot_device is the BOOT_DEVICE_... value
574 * _method is the load_image function to call
Simon Glassd1cf3732016-09-24 18:19:58 -0600575 */
Simon Glass4fc1f252016-11-30 15:30:50 -0700576#ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
577#define SPL_LOAD_IMAGE_METHOD(_name, _priority, _boot_device, _method) \
Simon Glassec1503c2019-10-20 21:31:45 -0600578 SPL_LOAD_IMAGE(_boot_device ## _priority ## _method) = { \
Simon Glass4fc1f252016-11-30 15:30:50 -0700579 .name = _name, \
Simon Glassbf4fd552016-11-30 15:30:49 -0700580 .boot_device = _boot_device, \
581 .load_image = _method, \
Simon Glassd1cf3732016-09-24 18:19:58 -0600582 }
Simon Glass4fc1f252016-11-30 15:30:50 -0700583#else
584#define SPL_LOAD_IMAGE_METHOD(_name, _priority, _boot_device, _method) \
Simon Glassec1503c2019-10-20 21:31:45 -0600585 SPL_LOAD_IMAGE(_boot_device ## _priority ## _method) = { \
Simon Glass4fc1f252016-11-30 15:30:50 -0700586 .boot_device = _boot_device, \
587 .load_image = _method, \
588 }
589#endif
Simon Glassd1cf3732016-09-24 18:19:58 -0600590
Dan Murphyb7b5b0c2014-01-16 11:23:29 -0600591/* SPL FAT image functions */
Simon Glass3eb382a2016-09-24 18:20:15 -0600592int spl_load_image_fat(struct spl_image_info *spl_image,
Pali Rohárdda8f882022-01-14 14:31:38 +0100593 struct spl_boot_device *bootdev,
Simon Glass3eb382a2016-09-24 18:20:15 -0600594 struct blk_desc *block_dev, int partition,
Simon Glasse3394752016-02-29 15:25:34 -0700595 const char *filename);
Simon Glass3eb382a2016-09-24 18:20:15 -0600596int spl_load_image_fat_os(struct spl_image_info *spl_image,
Pali Rohárdda8f882022-01-14 14:31:38 +0100597 struct spl_boot_device *bootdev,
Simon Glass3eb382a2016-09-24 18:20:15 -0600598 struct blk_desc *block_dev, int partition);
Dan Murphyb7b5b0c2014-01-16 11:23:29 -0600599
Jeroen Hofstee454c0712014-10-08 22:58:07 +0200600void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image);
601
Guillaume GARDET1eb410c2014-10-15 17:53:12 +0200602/* SPL EXT image functions */
Simon Glass0649e912016-09-24 18:20:14 -0600603int spl_load_image_ext(struct spl_image_info *spl_image,
Pali Rohárdda8f882022-01-14 14:31:38 +0100604 struct spl_boot_device *bootdev,
Simon Glass0649e912016-09-24 18:20:14 -0600605 struct blk_desc *block_dev, int partition,
Simon Glasse3394752016-02-29 15:25:34 -0700606 const char *filename);
Simon Glass0649e912016-09-24 18:20:14 -0600607int spl_load_image_ext_os(struct spl_image_info *spl_image,
Pali Rohárdda8f882022-01-14 14:31:38 +0100608 struct spl_boot_device *bootdev,
Simon Glass0649e912016-09-24 18:20:14 -0600609 struct blk_desc *block_dev, int partition);
Guillaume GARDET1eb410c2014-10-15 17:53:12 +0200610
Simon Glassfa2a4db2015-06-23 15:39:10 -0600611/**
Eddie Cai32258992017-03-15 08:43:28 -0600612 * spl_early_init() - Set up device tree and driver model in SPL if enabled
Simon Glassfa2a4db2015-06-23 15:39:10 -0600613 *
614 * Call this function in board_init_f() if you want to use device tree and
Eddie Cai32258992017-03-15 08:43:28 -0600615 * driver model early, before board_init_r() is called.
616 *
617 * If this is not called, then driver model will be inactive in SPL's
618 * board_init_f(), and no device tree will be available.
619 */
620int spl_early_init(void);
621
622/**
623 * spl_init() - Set up device tree and driver model in SPL if enabled
624 *
625 * You can optionally call spl_early_init(), then optionally call spl_init().
626 * This function will be called from board_init_r() if not called earlier.
627 *
628 * Both spl_early_init() and spl_init() perform a similar function except that
629 * the latter will not set up the malloc() area if
630 * CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN is enabled, since it is assumed to
631 * already be done by a calll to spl_relocate_stack_gd() before board_init_r()
632 * is reached.
633 *
634 * This function will be called from board_init_r() if not called earlier.
Simon Glassfa2a4db2015-06-23 15:39:10 -0600635 *
636 * If this is not called, then driver model will be inactive in SPL's
637 * board_init_f(), and no device tree will be available.
638 */
639int spl_init(void);
640
Tom Rini28591df2012-08-13 12:03:19 -0700641#ifdef CONFIG_SPL_BOARD_INIT
642void spl_board_init(void);
643#endif
Simon Glassa77e1b82015-05-13 07:02:24 -0600644
645/**
646 * spl_was_boot_source() - check if U-Boot booted from SPL
647 *
648 * This will normally be true, but if U-Boot jumps to second U-Boot, it will
649 * be false. This should be implemented by board-specific code.
650 *
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +0100651 * Return: true if U-Boot booted from SPL, else false
Simon Glassa77e1b82015-05-13 07:02:24 -0600652 */
653bool spl_was_boot_source(void);
654
B, Ravid207b7e2016-07-28 17:39:16 +0530655/**
656 * spl_dfu_cmd- run dfu command with chosen mmc device interface
657 * @param usb_index - usb controller number
658 * @param mmc_dev - mmc device nubmer
659 *
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +0100660 * Return: 0 on success, otherwise error code
B, Ravid207b7e2016-07-28 17:39:16 +0530661 */
662int spl_dfu_cmd(int usbctrl, char *dfu_alt_info, char *interface, char *devstr);
Simon Glass8dd1c9e2016-09-24 18:19:51 -0600663
Marek Vasut8d5c4c32016-12-01 02:06:35 +0100664int spl_mmc_load_image(struct spl_image_info *spl_image,
665 struct spl_boot_device *bootdev);
666
Philipp Tomsichf13e9e02017-09-13 21:29:31 +0200667/**
Andreas Dannenberg8d9f7f12019-06-04 17:55:46 -0500668 * spl_mmc_load() - Load an image file from MMC/SD media
669 *
670 * @param spl_image Image data filled in by loading process
671 * @param bootdev Describes which device to load from
672 * @param filename Name of file to load (in FS mode)
673 * @param raw_part Partition to load from (in RAW mode)
674 * @param raw_sect Sector to load from (in RAW mode)
675 *
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +0100676 * Return: 0 on success, otherwise error code
Andreas Dannenberg8d9f7f12019-06-04 17:55:46 -0500677 */
678int spl_mmc_load(struct spl_image_info *spl_image,
679 struct spl_boot_device *bootdev,
680 const char *filename,
681 int raw_part,
682 unsigned long raw_sect);
683
Faiz Abbas05e3a152020-08-03 11:35:04 +0530684/**
685 * spl_usb_load() - Load an image file from USB mass storage
686 *
687 * @param spl_image Image data filled in by loading process
688 * @param bootdev Describes which device to load from
689 * @param raw_part Fat partition to load from
690 * @param filename Name of file to load
691 *
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +0100692 * Return: 0 on success, otherwise error code
Faiz Abbas05e3a152020-08-03 11:35:04 +0530693 */
694int spl_usb_load(struct spl_image_info *spl_image,
695 struct spl_boot_device *bootdev,
696 int partition, const char *filename);
697
Andreas Dannenberg58892082019-08-15 15:55:27 -0500698int spl_ymodem_load_image(struct spl_image_info *spl_image,
699 struct spl_boot_device *bootdev);
700
Andreas Dannenberg8d9f7f12019-06-04 17:55:46 -0500701/**
Philipp Tomsichf13e9e02017-09-13 21:29:31 +0200702 * spl_invoke_atf - boot using an ARM trusted firmware image
703 */
704void spl_invoke_atf(struct spl_image_info *spl_image);
Philipp Tomsich83ad7022017-06-22 23:38:36 +0200705
706/**
Michael Walle2def7d92020-11-18 17:45:56 +0100707 * bl2_plat_get_bl31_params() - return params for bl31.
708 * @bl32_entry: address of BL32 executable (secure)
709 * @bl33_entry: address of BL33 executable (non secure)
710 * @fdt_addr: address of Flat Device Tree
Michal Simekd1598e22019-12-19 18:13:31 +0100711 *
Michael Walle2def7d92020-11-18 17:45:56 +0100712 * This is a weak function which might be overridden by the board code. By
713 * default it will just call bl2_plat_get_bl31_params_default().
Michal Simekd1598e22019-12-19 18:13:31 +0100714 *
Michael Walle2def7d92020-11-18 17:45:56 +0100715 * If you just want to manipulate or add some parameters, you can override
716 * this function, call bl2_plat_get_bl31_params_default and operate on the
717 * returned bl31 params.
718 *
719 * Return: bl31 params structure pointer
Michal Simekd1598e22019-12-19 18:13:31 +0100720 */
721struct bl31_params *bl2_plat_get_bl31_params(uintptr_t bl32_entry,
722 uintptr_t bl33_entry,
723 uintptr_t fdt_addr);
724
725/**
Michael Walle2def7d92020-11-18 17:45:56 +0100726 * bl2_plat_get_bl31_params_default() - prepare params for bl31.
727 * @bl32_entry: address of BL32 executable (secure)
728 * @bl33_entry: address of BL33 executable (non secure)
729 * @fdt_addr: address of Flat Device Tree
730 *
731 * This is the default implementation of bl2_plat_get_bl31_params(). It assigns
732 * a pointer to the memory that the platform has kept aside to pass platform
733 * specific and trusted firmware related information to BL31. This memory is
734 * allocated by allocating memory to bl2_to_bl31_params_mem structure which is
735 * a superset of all the structure whose information is passed to BL31
736 *
737 * NOTE: The memory is statically allocated, thus this function should be
738 * called only once. All subsequent calls will overwrite any changes.
739 *
740 * Return: bl31 params structure pointer
741 */
742struct bl31_params *bl2_plat_get_bl31_params_default(uintptr_t bl32_entry,
743 uintptr_t bl33_entry,
744 uintptr_t fdt_addr);
Michael Walleafaf6ea2020-11-18 17:45:58 +0100745
746/**
747 * bl2_plat_get_bl31_params_v2() - return params for bl31
748 * @bl32_entry: address of BL32 executable (secure)
749 * @bl33_entry: address of BL33 executable (non secure)
750 * @fdt_addr: address of Flat Device Tree
751 *
752 * This function does the same as bl2_plat_get_bl31_params() except that is is
753 * used for the new LOAD_IMAGE_V2 option, which uses a slightly different
754 * method to pass the parameters.
755 *
756 * Return: bl31 params structure pointer
757 */
758struct bl_params *bl2_plat_get_bl31_params_v2(uintptr_t bl32_entry,
759 uintptr_t bl33_entry,
760 uintptr_t fdt_addr);
761
762/**
763 * bl2_plat_get_bl31_params_v2_default() - prepare params for bl31.
764 * @bl32_entry: address of BL32 executable (secure)
765 * @bl33_entry: address of BL33 executable (non secure)
766 * @fdt_addr: address of Flat Device Tree
767 *
768 * This is the default implementation of bl2_plat_get_bl31_params_v2(). It
769 * prepares the linked list of the bl31 params, populates the image types and
770 * set the entry points for bl32 and bl33 (if available).
771 *
772 * NOTE: The memory is statically allocated, thus this function should be
773 * called only once. All subsequent calls will overwrite any changes.
774 *
775 * Return: bl31 params structure pointer
776 */
777struct bl_params *bl2_plat_get_bl31_params_v2_default(uintptr_t bl32_entry,
778 uintptr_t bl33_entry,
779 uintptr_t fdt_addr);
Michael Walle2def7d92020-11-18 17:45:56 +0100780/**
Kever Yanga28d42c2018-08-23 17:17:59 +0800781 * spl_optee_entry - entry function for optee
782 *
783 * args defind in op-tee project
784 * https://github.com/OP-TEE/optee_os/
785 * core/arch/arm/kernel/generic_entry_a32.S
786 * @arg0: pagestore
787 * @arg1: (ARMv7 standard bootarg #1)
788 * @arg2: device tree address, (ARMv7 standard bootarg #2)
789 * @arg3: non-secure entry address (ARMv7 bootarg #0)
790 */
Ricardo Salvetiec0352a2021-10-20 15:12:06 +0300791void __noreturn spl_optee_entry(void *arg0, void *arg1, void *arg2, void *arg3);
Kever Yanga28d42c2018-08-23 17:17:59 +0800792
793/**
Lukas Auer515b9342019-08-21 21:14:44 +0200794 * spl_invoke_opensbi - boot using a RISC-V OpenSBI image
795 */
796void spl_invoke_opensbi(struct spl_image_info *spl_image);
797
798/**
Philipp Tomsich83ad7022017-06-22 23:38:36 +0200799 * board_return_to_bootrom - allow for boards to continue with the boot ROM
800 *
801 * If a board (e.g. the Rockchip RK3368 boards) provide some
802 * supporting functionality for SPL in their boot ROM and the SPL
803 * stage wants to return to the ROM code to continue booting, boards
804 * can implement 'board_return_to_bootrom'.
805 */
Peng Fanaa050c52019-08-07 06:40:53 +0000806int board_return_to_bootrom(struct spl_image_info *spl_image,
807 struct spl_boot_device *bootdev);
Philipp Tomsich58beb6e2018-05-24 17:15:50 +0200808
809/**
Peng Fanc86bacd2018-11-17 09:10:31 +0000810 * board_spl_fit_post_load - allow process images after loading finished
Alexandru Gagniuc44af2a52021-01-20 10:46:49 -0600811 * @fit: Pointer to a valid Flattened Image Tree blob
Peng Fanc86bacd2018-11-17 09:10:31 +0000812 */
Alexandru Gagniuc44af2a52021-01-20 10:46:49 -0600813void board_spl_fit_post_load(const void *fit);
Peng Fanc86bacd2018-11-17 09:10:31 +0000814
815/**
816 * board_spl_fit_size_align - specific size align before processing payload
817 *
818 */
819ulong board_spl_fit_size_align(ulong size);
820
821/**
Philipp Tomsich58beb6e2018-05-24 17:15:50 +0200822 * spl_perform_fixups() - arch/board-specific callback before processing
823 * the boot-payload
824 */
825void spl_perform_fixups(struct spl_image_info *spl_image);
Marek Vasut1dda46f2018-08-14 11:27:02 +0200826
827/*
828 * spl_get_load_buffer() - get buffer for loading partial image data
829 *
830 * Returns memory area which can be populated by partial image data,
831 * ie. uImage or fitImage header.
832 */
833struct image_header *spl_get_load_buffer(ssize_t offset, size_t size);
834
Peng Fan617fc292020-05-05 20:28:41 +0800835void spl_save_restore_data(void);
Tom Rini28591df2012-08-13 12:03:19 -0700836#endif