blob: 469e7fe1cc3d9478f9debd12c8db1084644cb100 [file] [log] [blame]
Tom Rini83d290c2018-05-06 17:58:06 -04001/* SPDX-License-Identifier: GPL-2.0+ */
Tom Rini47f7bca2012-08-13 12:03:19 -07002/*
3 * (C) Copyright 2012
4 * Texas Instruments, <www.ti.com>
Tom Rini47f7bca2012-08-13 12:03:19 -07005 */
6#ifndef _SPL_H_
7#define _SPL_H_
8
Simon Glass8bee2d22017-11-13 18:55:03 -07009#include <binman_sym.h>
Simon Glassf7ae49f2020-05-10 11:40:05 -060010#include <linker_lists.h>
Simon Glass8bee2d22017-11-13 18:55:03 -070011
Tom Rini47f7bca2012-08-13 12:03:19 -070012/* Platform-specific defines */
Tom Rini6507f132012-08-22 15:31:05 -070013#include <linux/compiler.h>
Masahiro Yamada271cf2f2020-02-25 02:25:46 +090014#include <asm/global_data.h>
Tom Rini47f7bca2012-08-13 12:03:19 -070015#include <asm/spl.h>
Simon Glassb0edea32018-11-15 18:44:09 -070016#include <handoff.h>
Tom Rini47f7bca2012-08-13 12:03:19 -070017
Masahiro Yamada271cf2f2020-02-25 02:25:46 +090018struct blk_desc;
19struct image_header;
20
Simon Glass32ba8952015-05-13 07:02:24 -060021/* Value in r0 indicates we booted from U-Boot */
22#define UBOOT_NOT_LOADED_FROM_SPL 0x13578642
Dan Murphy773b5942014-01-16 11:23:29 -060023
Tom Rini47f7bca2012-08-13 12:03:19 -070024/* Boot type */
25#define MMCSD_MODE_UNDEFINED 0
26#define MMCSD_MODE_RAW 1
Guillaume GARDET205b4f32014-10-15 17:53:11 +020027#define MMCSD_MODE_FS 2
Tom Rini7dbe63b2014-02-05 10:24:18 -050028#define MMCSD_MODE_EMMCBOOT 3
Tom Rini47f7bca2012-08-13 12:03:19 -070029
Simon Glasse6f6f9e2020-05-10 11:39:58 -060030struct blk_desc;
Simon Glassc3dc39a2020-05-10 11:39:55 -060031struct image_header;
Pali Rohár2e0429b2022-01-14 14:31:38 +010032struct spl_boot_device;
Simon Glassc3dc39a2020-05-10 11:39:55 -060033
Simon Glasse945a722018-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 Glass8e83b762019-09-25 08:11:20 -060061enum u_boot_phase {
Simon Glass09d9ba92021-01-13 20:29:42 -070062 PHASE_NONE, /* Invalid phase, signifying before U-Boot */
Simon Glass59c871b2019-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 Glass8e83b762019-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 Glass59c871b2019-09-25 08:56:30 -0600106 * if (spl_phase() == PHASE_BOARD_F) {
Simon Glass8e83b762019-09-25 08:11:20 -0600107 * ...
108 * }
109 *
110 * @return U-Boot phase
111 */
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 Glass59c871b2019-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 Glass8e83b762019-09-25 08:11:20 -0600125#endif
126}
127
Simon Glass09d9ba92021-01-13 20:29:42 -0700128/**
129 * spl_prev_phase() - Figure out the previous U-Boot phase
130 *
131 * @return the previous phase from this one, e.g. if called in SPL this returns
132 * 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 *
148 * @return the next phase from this one, e.g. if called in TPL this returns
149 * 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 *
163 * @return phase name
164 */
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 Glassf178beb2021-07-05 16:32:45 -0600180/**
181 * spl_phase_prefix() - Get the prefix of the current phase
182 *
183 * @phase: Phase to look up
184 * @return phase prefix ("spl", "tpl", etc.)
185 */
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 Glassd6330062018-11-15 18:43:56 -0700201/* A string name for SPL or TPL */
202#ifdef CONFIG_SPL_BUILD
203# ifdef CONFIG_TPL_BUILD
Heiko Schocher8fb23912018-12-05 11:29:54 +0100204# define SPL_TPL_NAME "TPL"
Simon Glassd6330062018-11-15 18:43:56 -0700205# else
Heiko Schocher8fb23912018-12-05 11:29:54 +0100206# define SPL_TPL_NAME "SPL"
Simon Glassd6330062018-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 Rini47f7bca2012-08-13 12:03:19 -0700214struct spl_image_info {
215 const char *name;
216 u8 os;
Philipp Tomsichf2efe672017-09-13 21:29:31 +0200217 uintptr_t load_addr;
218 uintptr_t entry_point;
Marek Vasuta9a82712019-05-07 21:17:02 +0200219#if CONFIG_IS_ENABLED(LOAD_FIT) || CONFIG_IS_ENABLED(LOAD_FIT_FULL)
Philipp Tomsich75014472017-09-13 21:29:30 +0200220 void *fdt_addr;
221#endif
Philipp Tomsichde5dd4c2018-05-24 17:15:50 +0200222 u32 boot_device;
Pali Rohár5fce2872021-07-23 11:14:27 +0200223 u32 offset;
Tom Rini47f7bca2012-08-13 12:03:19 -0700224 u32 size;
Stefan Roese022b4972012-08-27 12:50:58 +0200225 u32 flags;
Vikas Manocha5bf52502017-04-07 15:38:13 -0700226 void *arg;
Simon Goldschmidtdae5c2d2019-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 Rini47f7bca2012-08-13 12:03:19 -0700232};
233
Dario Binacchi146a17a2020-05-27 13:56:18 +0200234/**
Simon Glassf1dcee52016-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 Vutlaeafd5412016-05-24 10:34:38 +0530240 * @filename: Name of the fit image file.
Simon Glassf1dcee52016-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 Vutlaeafd5412016-05-24 10:34:38 +0530247 const char *filename;
Simon Glass2e059e42021-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 Glassf1dcee52016-02-22 22:55:56 -0700257 ulong (*read)(struct spl_load_info *load, ulong sector, ulong count,
258 void *buf);
259};
260
Simon Glass8bee2d22017-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 Glasse82c6242019-12-08 17:40:12 -0700265 * image is found. For example if u-boot.img is used we don't check that
Simon Glass8bee2d22017-11-13 18:55:03 -0700266 * spl_parse_image_header() can parse a valid header.
Simon Glasse82c6242019-12-08 17:40:12 -0700267 *
268 * Similarly for SPL, so that TPL can jump to SPL.
Simon Glass8bee2d22017-11-13 18:55:03 -0700269 */
Simon Glassdbf6be92018-08-01 15:22:42 -0600270binman_sym_extern(ulong, u_boot_any, image_pos);
Simon Glasse82c6242019-12-08 17:40:12 -0700271binman_sym_extern(ulong, u_boot_any, size);
272binman_sym_extern(ulong, spl, image_pos);
273binman_sym_extern(ulong, spl, size);
274
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 Glass8bee2d22017-11-13 18:55:03 -0700288
Lokesh Vutlaeafd5412016-05-24 10:34:38 +0530289/**
Simon Glass86c372a2021-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 *
295 * @return text-base address
296 */
297ulong spl_get_image_text_base(void);
298
299/**
Andreas Dannenberge1eb6ad2019-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 Schocher884ba502021-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 Vutlaeafd5412016-05-24 10:34:38 +0530317 * spl_load_simple_fit() - Loads a fit image from a device.
Simon Glassf4d7d852016-09-24 18:20:16 -0600318 * @spl_image: Image description to set up
Lokesh Vutlaeafd5412016-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 Glassf4d7d852016-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 Glassf1dcee52016-02-22 22:55:56 -0700329
Stefan Roese022b4972012-08-27 12:50:58 +0200330#define SPL_COPY_PAYLOAD_ONLY 1
Ye Lie246bfc2018-11-17 09:10:25 +0000331#define SPL_FIT_FOUND 2
Stefan Roese022b4972012-08-27 12:50:58 +0200332
Peng Fandd7d0912019-08-22 07:42:38 +0000333/**
Stefan Roese2fc91ed2020-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ár2e0429b2022-01-14 14:31:38 +0100344 struct spl_boot_device *bootdev,
Stefan Roese2fc91ed2020-04-21 09:28:43 +0200345 struct spl_load_info *load, ulong header);
346
347/**
Peng Fandd7d0912019-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 Rini47f7bca2012-08-13 12:03:19 -0700359/* SPL common functions */
360void preloader_console_init(void);
361u32 spl_boot_device(void);
Harald Seilere9759062020-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 Seilerc51b7512020-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 Vasut9b191592021-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 Gagniuc58b504e2021-04-08 11:56:11 -0500415void spl_set_bd(void);
Simon Glassd95ceb92016-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 Glass71316c12016-09-24 18:19:53 -0600424 * @spl_image: Image description to set up
Simon Glassd95ceb92016-09-24 18:19:52 -0600425 */
426void spl_set_header_raw_uboot(struct spl_image_info *spl_image);
427
Simon Glass71316c12016-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. Davis24eb39b2017-02-16 11:18:38 -0600434 * enabled, then this causes a panic. If CONFIG_SPL_RAW_IMAGE_SUPPORT is not
Simon Glass71316c12016-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
440 * @return 0 if a header was correctly parsed, -ve on error
441 */
442int spl_parse_image_header(struct spl_image_info *spl_image,
Pali Rohár2e0429b2022-01-14 14:31:38 +0100443 const struct spl_boot_device *bootdev,
Simon Glass71316c12016-09-24 18:19:53 -0600444 const struct image_header *header);
445
Tom Rini47f7bca2012-08-13 12:03:19 -0700446void spl_board_prepare_for_linux(void);
Alexandru Gagniuca25d6b62021-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 Simek3a3b9142016-05-10 07:54:20 +0200461void spl_board_prepare_for_boot(void);
Ladislav Michlbf55cd42016-07-12 20:28:13 +0200462int spl_board_ubi_load_image(u32 boot_device);
Alifer Moraes40eeb9c2020-01-14 15:55:01 -0300463int spl_board_boot_device(u32 boot_device);
Simon Glassca12e652016-09-24 18:19:54 -0600464
465/**
466 * jump_to_image_linux() - Jump to a Linux kernel from SPL
467 *
468 * This jumps into a Linux kernel using the information in @spl_image.
469 *
470 * @spl_image: Image description to set up
Simon Glassca12e652016-09-24 18:19:54 -0600471 */
Vikas Manocha5bf52502017-04-07 15:38:13 -0700472void __noreturn jump_to_image_linux(struct spl_image_info *spl_image);
Simon Glassf59961e2016-09-24 18:19:55 -0600473
474/**
Ricardo Salveti949eb222021-10-20 15:12:06 +0300475 * jump_to_image_linux() - Jump to OP-TEE OS from SPL
476 *
477 * This jumps into OP-TEE OS using the information in @spl_image.
478 *
479 * @spl_image: Image description to set up
480 */
481void __noreturn jump_to_image_optee(struct spl_image_info *spl_image);
482
483/**
Simon Glassf59961e2016-09-24 18:19:55 -0600484 * spl_start_uboot() - Check if SPL should start the kernel or U-Boot
485 *
486 * This is called by the various SPL loaders to determine whether the board
487 * wants to load the kernel or U-Boot. This function should be provided by
488 * the board.
489 *
490 * @return 0 if SPL should start the kernel, 1 if U-Boot must be started
491 */
Tom Rini47f7bca2012-08-13 12:03:19 -0700492int spl_start_uboot(void);
Simon Glassf59961e2016-09-24 18:19:55 -0600493
Simon Glassa807ab32016-09-24 18:19:56 -0600494/**
495 * spl_display_print() - Display a board-specific message in SPL
496 *
497 * If CONFIG_SPL_DISPLAY_PRINT is enabled, U-Boot will call this function
498 * immediately after displaying the SPL console banner ("U-Boot SPL ...").
499 * This function should be provided by the board.
500 */
Tom Rini47f7bca2012-08-13 12:03:19 -0700501void spl_display_print(void);
502
Simon Glassecdfd692016-09-24 18:19:57 -0600503/**
504 * struct spl_boot_device - Describes a boot device used by SPL
505 *
506 * @boot_device: A number indicating the BOOT_DEVICE type. There are various
507 * BOOT_DEVICE... #defines and enums in U-Boot and they are not consistently
508 * numbered.
509 * @boot_device_name: Named boot device, or NULL if none.
510 *
511 * Note: Additional fields can be added here, bearing in mind that SPL is
512 * size-sensitive and common fields will be present on all boards. This
513 * struct can also be used to return additional information about the load
514 * process if that becomes useful.
515 */
516struct spl_boot_device {
517 uint boot_device;
518 const char *boot_device_name;
519};
520
Simon Glassa0a80292016-09-24 18:19:58 -0600521/**
522 * Holds information about a way of loading an SPL image
523 *
Simon Glassebc4ef62016-11-30 15:30:50 -0700524 * @name: User-friendly name for this method (e.g. "MMC")
Simon Glassa0a80292016-09-24 18:19:58 -0600525 * @boot_device: Boot device that this loader supports
526 * @load_image: Function to call to load image
527 */
528struct spl_image_loader {
Simon Glassebc4ef62016-11-30 15:30:50 -0700529#ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
530 const char *name;
531#endif
Simon Glassa0a80292016-09-24 18:19:58 -0600532 uint boot_device;
533 /**
534 * load_image() - Load an SPL image
535 *
Simon Glass2a2ee2a2016-09-24 18:20:13 -0600536 * @spl_image: place to put image information
Simon Glassa0a80292016-09-24 18:19:58 -0600537 * @bootdev: describes the boot device to load from
538 */
Simon Glass2a2ee2a2016-09-24 18:20:13 -0600539 int (*load_image)(struct spl_image_info *spl_image,
540 struct spl_boot_device *bootdev);
Simon Glassa0a80292016-09-24 18:19:58 -0600541};
542
Simon Glass7d84fbb2021-07-05 16:32:57 -0600543/* Helper function for accessing the name */
544static inline const char *spl_loader_name(const struct spl_image_loader *loader)
545{
546#ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
547 return loader->name;
548#else
549 return NULL;
550#endif
551}
552
Simon Glassa0a80292016-09-24 18:19:58 -0600553/* Declare an SPL image loader */
554#define SPL_LOAD_IMAGE(__name) \
555 ll_entry_declare(struct spl_image_loader, __name, spl_image_loader)
556
557/*
Simon Glass0d3b0592016-11-30 15:30:49 -0700558 * _priority is the priority of this method, 0 meaning it will be the top
Simon Glassa0a80292016-09-24 18:19:58 -0600559 * choice for this device, 9 meaning it is the bottom choice.
Simon Glass0d3b0592016-11-30 15:30:49 -0700560 * _boot_device is the BOOT_DEVICE_... value
561 * _method is the load_image function to call
Simon Glassa0a80292016-09-24 18:19:58 -0600562 */
Simon Glassebc4ef62016-11-30 15:30:50 -0700563#ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
564#define SPL_LOAD_IMAGE_METHOD(_name, _priority, _boot_device, _method) \
Simon Glasse1500a62019-10-20 21:31:45 -0600565 SPL_LOAD_IMAGE(_boot_device ## _priority ## _method) = { \
Simon Glassebc4ef62016-11-30 15:30:50 -0700566 .name = _name, \
567 .boot_device = _boot_device, \
568 .load_image = _method, \
569 }
570#else
571#define SPL_LOAD_IMAGE_METHOD(_name, _priority, _boot_device, _method) \
Simon Glasse1500a62019-10-20 21:31:45 -0600572 SPL_LOAD_IMAGE(_boot_device ## _priority ## _method) = { \
Simon Glass0d3b0592016-11-30 15:30:49 -0700573 .boot_device = _boot_device, \
574 .load_image = _method, \
Simon Glassa0a80292016-09-24 18:19:58 -0600575 }
Simon Glassebc4ef62016-11-30 15:30:50 -0700576#endif
Simon Glassa0a80292016-09-24 18:19:58 -0600577
Dan Murphy773b5942014-01-16 11:23:29 -0600578/* SPL FAT image functions */
Simon Glass710e9ca2016-09-24 18:20:15 -0600579int spl_load_image_fat(struct spl_image_info *spl_image,
Pali Rohár2e0429b2022-01-14 14:31:38 +0100580 struct spl_boot_device *bootdev,
Simon Glass710e9ca2016-09-24 18:20:15 -0600581 struct blk_desc *block_dev, int partition,
Simon Glass4101f682016-02-29 15:25:34 -0700582 const char *filename);
Simon Glass710e9ca2016-09-24 18:20:15 -0600583int spl_load_image_fat_os(struct spl_image_info *spl_image,
Pali Rohár2e0429b2022-01-14 14:31:38 +0100584 struct spl_boot_device *bootdev,
Simon Glass710e9ca2016-09-24 18:20:15 -0600585 struct blk_desc *block_dev, int partition);
Dan Murphy773b5942014-01-16 11:23:29 -0600586
Jeroen Hofsteece048222014-10-08 22:58:07 +0200587void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image);
588
Guillaume GARDET592f9222014-10-15 17:53:12 +0200589/* SPL EXT image functions */
Simon Glassb4a6c2a2016-09-24 18:20:14 -0600590int spl_load_image_ext(struct spl_image_info *spl_image,
Pali Rohár2e0429b2022-01-14 14:31:38 +0100591 struct spl_boot_device *bootdev,
Simon Glassb4a6c2a2016-09-24 18:20:14 -0600592 struct blk_desc *block_dev, int partition,
Simon Glass4101f682016-02-29 15:25:34 -0700593 const char *filename);
Simon Glassb4a6c2a2016-09-24 18:20:14 -0600594int spl_load_image_ext_os(struct spl_image_info *spl_image,
Pali Rohár2e0429b2022-01-14 14:31:38 +0100595 struct spl_boot_device *bootdev,
Simon Glassb4a6c2a2016-09-24 18:20:14 -0600596 struct blk_desc *block_dev, int partition);
Guillaume GARDET592f9222014-10-15 17:53:12 +0200597
Simon Glass070d00b2015-06-23 15:39:10 -0600598/**
Eddie Cai340f4182017-03-15 08:43:28 -0600599 * spl_early_init() - Set up device tree and driver model in SPL if enabled
Simon Glass070d00b2015-06-23 15:39:10 -0600600 *
601 * Call this function in board_init_f() if you want to use device tree and
Eddie Cai340f4182017-03-15 08:43:28 -0600602 * driver model early, before board_init_r() is called.
603 *
604 * If this is not called, then driver model will be inactive in SPL's
605 * board_init_f(), and no device tree will be available.
606 */
607int spl_early_init(void);
608
609/**
610 * spl_init() - Set up device tree and driver model in SPL if enabled
611 *
612 * You can optionally call spl_early_init(), then optionally call spl_init().
613 * This function will be called from board_init_r() if not called earlier.
614 *
615 * Both spl_early_init() and spl_init() perform a similar function except that
616 * the latter will not set up the malloc() area if
617 * CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN is enabled, since it is assumed to
618 * already be done by a calll to spl_relocate_stack_gd() before board_init_r()
619 * is reached.
620 *
621 * This function will be called from board_init_r() if not called earlier.
Simon Glass070d00b2015-06-23 15:39:10 -0600622 *
623 * If this is not called, then driver model will be inactive in SPL's
624 * board_init_f(), and no device tree will be available.
625 */
626int spl_init(void);
627
Tom Rini47f7bca2012-08-13 12:03:19 -0700628#ifdef CONFIG_SPL_BOARD_INIT
629void spl_board_init(void);
630#endif
Simon Glass32ba8952015-05-13 07:02:24 -0600631
632/**
633 * spl_was_boot_source() - check if U-Boot booted from SPL
634 *
635 * This will normally be true, but if U-Boot jumps to second U-Boot, it will
636 * be false. This should be implemented by board-specific code.
637 *
638 * @return true if U-Boot booted from SPL, else false
639 */
640bool spl_was_boot_source(void);
641
B, Ravi52f2acc2016-07-28 17:39:16 +0530642/**
643 * spl_dfu_cmd- run dfu command with chosen mmc device interface
644 * @param usb_index - usb controller number
645 * @param mmc_dev - mmc device nubmer
646 *
647 * @return 0 on success, otherwise error code
648 */
649int spl_dfu_cmd(int usbctrl, char *dfu_alt_info, char *interface, char *devstr);
Simon Glasse50d76c2016-09-24 18:19:51 -0600650
Marek Vasut09410c62016-12-01 02:06:35 +0100651int spl_mmc_load_image(struct spl_image_info *spl_image,
652 struct spl_boot_device *bootdev);
653
Philipp Tomsichf2efe672017-09-13 21:29:31 +0200654/**
Andreas Dannenberge1eb6ad2019-06-04 17:55:46 -0500655 * spl_mmc_load() - Load an image file from MMC/SD media
656 *
657 * @param spl_image Image data filled in by loading process
658 * @param bootdev Describes which device to load from
659 * @param filename Name of file to load (in FS mode)
660 * @param raw_part Partition to load from (in RAW mode)
661 * @param raw_sect Sector to load from (in RAW mode)
662 *
663 * @return 0 on success, otherwise error code
664 */
665int spl_mmc_load(struct spl_image_info *spl_image,
666 struct spl_boot_device *bootdev,
667 const char *filename,
668 int raw_part,
669 unsigned long raw_sect);
670
Faiz Abbasc3ab97c2020-08-03 11:35:04 +0530671/**
672 * spl_usb_load() - Load an image file from USB mass storage
673 *
674 * @param spl_image Image data filled in by loading process
675 * @param bootdev Describes which device to load from
676 * @param raw_part Fat partition to load from
677 * @param filename Name of file to load
678 *
679 * @return 0 on success, otherwise error code
680 */
681int spl_usb_load(struct spl_image_info *spl_image,
682 struct spl_boot_device *bootdev,
683 int partition, const char *filename);
684
Andreas Dannenberge4130332019-08-15 15:55:27 -0500685int spl_ymodem_load_image(struct spl_image_info *spl_image,
686 struct spl_boot_device *bootdev);
687
Andreas Dannenberge1eb6ad2019-06-04 17:55:46 -0500688/**
Philipp Tomsichf2efe672017-09-13 21:29:31 +0200689 * spl_invoke_atf - boot using an ARM trusted firmware image
690 */
691void spl_invoke_atf(struct spl_image_info *spl_image);
Philipp Tomsich225d30b2017-06-22 23:38:36 +0200692
693/**
Michael Walled2cb0c82020-11-18 17:45:56 +0100694 * bl2_plat_get_bl31_params() - return params for bl31.
695 * @bl32_entry: address of BL32 executable (secure)
696 * @bl33_entry: address of BL33 executable (non secure)
697 * @fdt_addr: address of Flat Device Tree
Michal Simek5c03c992019-12-19 18:13:31 +0100698 *
Michael Walled2cb0c82020-11-18 17:45:56 +0100699 * This is a weak function which might be overridden by the board code. By
700 * default it will just call bl2_plat_get_bl31_params_default().
Michal Simek5c03c992019-12-19 18:13:31 +0100701 *
Michael Walled2cb0c82020-11-18 17:45:56 +0100702 * If you just want to manipulate or add some parameters, you can override
703 * this function, call bl2_plat_get_bl31_params_default and operate on the
704 * returned bl31 params.
705 *
706 * Return: bl31 params structure pointer
Michal Simek5c03c992019-12-19 18:13:31 +0100707 */
708struct bl31_params *bl2_plat_get_bl31_params(uintptr_t bl32_entry,
709 uintptr_t bl33_entry,
710 uintptr_t fdt_addr);
711
712/**
Michael Walled2cb0c82020-11-18 17:45:56 +0100713 * bl2_plat_get_bl31_params_default() - prepare params for bl31.
714 * @bl32_entry: address of BL32 executable (secure)
715 * @bl33_entry: address of BL33 executable (non secure)
716 * @fdt_addr: address of Flat Device Tree
717 *
718 * This is the default implementation of bl2_plat_get_bl31_params(). It assigns
719 * a pointer to the memory that the platform has kept aside to pass platform
720 * specific and trusted firmware related information to BL31. This memory is
721 * allocated by allocating memory to bl2_to_bl31_params_mem structure which is
722 * a superset of all the structure whose information is passed to BL31
723 *
724 * NOTE: The memory is statically allocated, thus this function should be
725 * called only once. All subsequent calls will overwrite any changes.
726 *
727 * Return: bl31 params structure pointer
728 */
729struct bl31_params *bl2_plat_get_bl31_params_default(uintptr_t bl32_entry,
730 uintptr_t bl33_entry,
731 uintptr_t fdt_addr);
Michael Walle7b866822020-11-18 17:45:58 +0100732
733/**
734 * bl2_plat_get_bl31_params_v2() - return params for bl31
735 * @bl32_entry: address of BL32 executable (secure)
736 * @bl33_entry: address of BL33 executable (non secure)
737 * @fdt_addr: address of Flat Device Tree
738 *
739 * This function does the same as bl2_plat_get_bl31_params() except that is is
740 * used for the new LOAD_IMAGE_V2 option, which uses a slightly different
741 * method to pass the parameters.
742 *
743 * Return: bl31 params structure pointer
744 */
745struct bl_params *bl2_plat_get_bl31_params_v2(uintptr_t bl32_entry,
746 uintptr_t bl33_entry,
747 uintptr_t fdt_addr);
748
749/**
750 * bl2_plat_get_bl31_params_v2_default() - prepare params for bl31.
751 * @bl32_entry: address of BL32 executable (secure)
752 * @bl33_entry: address of BL33 executable (non secure)
753 * @fdt_addr: address of Flat Device Tree
754 *
755 * This is the default implementation of bl2_plat_get_bl31_params_v2(). It
756 * prepares the linked list of the bl31 params, populates the image types and
757 * set the entry points for bl32 and bl33 (if available).
758 *
759 * NOTE: The memory is statically allocated, thus this function should be
760 * called only once. All subsequent calls will overwrite any changes.
761 *
762 * Return: bl31 params structure pointer
763 */
764struct bl_params *bl2_plat_get_bl31_params_v2_default(uintptr_t bl32_entry,
765 uintptr_t bl33_entry,
766 uintptr_t fdt_addr);
Michael Walled2cb0c82020-11-18 17:45:56 +0100767/**
Kever Yang70fe2872018-08-23 17:17:59 +0800768 * spl_optee_entry - entry function for optee
769 *
770 * args defind in op-tee project
771 * https://github.com/OP-TEE/optee_os/
772 * core/arch/arm/kernel/generic_entry_a32.S
773 * @arg0: pagestore
774 * @arg1: (ARMv7 standard bootarg #1)
775 * @arg2: device tree address, (ARMv7 standard bootarg #2)
776 * @arg3: non-secure entry address (ARMv7 bootarg #0)
777 */
Ricardo Salveti949eb222021-10-20 15:12:06 +0300778void __noreturn spl_optee_entry(void *arg0, void *arg1, void *arg2, void *arg3);
Kever Yang70fe2872018-08-23 17:17:59 +0800779
780/**
Lukas Auer5e30e452019-08-21 21:14:44 +0200781 * spl_invoke_opensbi - boot using a RISC-V OpenSBI image
782 */
783void spl_invoke_opensbi(struct spl_image_info *spl_image);
784
785/**
Philipp Tomsich225d30b2017-06-22 23:38:36 +0200786 * board_return_to_bootrom - allow for boards to continue with the boot ROM
787 *
788 * If a board (e.g. the Rockchip RK3368 boards) provide some
789 * supporting functionality for SPL in their boot ROM and the SPL
790 * stage wants to return to the ROM code to continue booting, boards
791 * can implement 'board_return_to_bootrom'.
792 */
Peng Fancda789a2019-08-07 06:40:53 +0000793int board_return_to_bootrom(struct spl_image_info *spl_image,
794 struct spl_boot_device *bootdev);
Philipp Tomsichde5dd4c2018-05-24 17:15:50 +0200795
796/**
Peng Fan28ded1f2018-11-17 09:10:31 +0000797 * board_spl_fit_post_load - allow process images after loading finished
Alexandru Gagniucefc4ad02021-01-20 10:46:49 -0600798 * @fit: Pointer to a valid Flattened Image Tree blob
Peng Fan28ded1f2018-11-17 09:10:31 +0000799 */
Alexandru Gagniucefc4ad02021-01-20 10:46:49 -0600800void board_spl_fit_post_load(const void *fit);
Peng Fan28ded1f2018-11-17 09:10:31 +0000801
802/**
803 * board_spl_fit_size_align - specific size align before processing payload
804 *
805 */
806ulong board_spl_fit_size_align(ulong size);
807
808/**
Philipp Tomsichde5dd4c2018-05-24 17:15:50 +0200809 * spl_perform_fixups() - arch/board-specific callback before processing
810 * the boot-payload
811 */
812void spl_perform_fixups(struct spl_image_info *spl_image);
Marek Vasut04ce5422018-08-14 11:27:02 +0200813
814/*
815 * spl_get_load_buffer() - get buffer for loading partial image data
816 *
817 * Returns memory area which can be populated by partial image data,
818 * ie. uImage or fitImage header.
819 */
820struct image_header *spl_get_load_buffer(ssize_t offset, size_t size);
821
Peng Fan6aead232020-05-05 20:28:41 +0800822void spl_save_restore_data(void);
Tom Rini47f7bca2012-08-13 12:03:19 -0700823#endif