blob: 925b6f0cc6461663f20271d3be35950b747e167f [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;
32
Simon Glass4e0a52d2018-11-15 18:43:51 -070033/*
34 * u_boot_first_phase() - check if this is the first U-Boot phase
35 *
36 * U-Boot has up to three phases: TPL, SPL and U-Boot proper. Depending on the
37 * build flags we can determine whether the current build is for the first
38 * phase of U-Boot or not. If there is no SPL, then this is U-Boot proper. If
39 * there is SPL but no TPL, the the first phase is SPL. If there is TPL, then
40 * it is the first phase.
41 *
42 * @returns true if this is the first phase of U-Boot
43 *
44 */
45static inline bool u_boot_first_phase(void)
46{
47 if (IS_ENABLED(CONFIG_TPL)) {
48 if (IS_ENABLED(CONFIG_TPL_BUILD))
49 return true;
50 } else if (IS_ENABLED(CONFIG_SPL)) {
51 if (IS_ENABLED(CONFIG_SPL_BUILD))
52 return true;
53 } else {
54 return true;
55 }
56
57 return false;
58}
59
Simon Glassb7fb5132019-09-25 08:11:20 -060060enum u_boot_phase {
Simon Glass95e4ec12021-01-13 20:29:42 -070061 PHASE_NONE, /* Invalid phase, signifying before U-Boot */
Simon Glass3c573b52019-09-25 08:56:30 -060062 PHASE_TPL, /* Running in TPL */
63 PHASE_SPL, /* Running in SPL */
64 PHASE_BOARD_F, /* Running in U-Boot before relocation */
65 PHASE_BOARD_R, /* Running in U-Boot after relocation */
Simon Glassb7fb5132019-09-25 08:11:20 -060066};
67
68/**
69 * spl_phase() - Find out the phase of U-Boot
70 *
71 * This can be used to avoid #ifdef logic and use if() instead.
72 *
73 * For example, to include code only in TPL, you might do:
74 *
75 * #ifdef CONFIG_TPL_BUILD
76 * ...
77 * #endif
78 *
79 * but with this you can use:
80 *
81 * if (spl_phase() == PHASE_TPL) {
82 * ...
83 * }
84 *
85 * To include code only in SPL, you might do:
86 *
87 * #if defined(CONFIG_SPL_BUILD) && !defined(CONFIG_TPL_BUILD)
88 * ...
89 * #endif
90 *
91 * but with this you can use:
92 *
93 * if (spl_phase() == PHASE_SPL) {
94 * ...
95 * }
96 *
97 * To include code only in U-Boot proper, you might do:
98 *
99 * #ifndef CONFIG_SPL_BUILD
100 * ...
101 * #endif
102 *
103 * but with this you can use:
104 *
Simon Glass3c573b52019-09-25 08:56:30 -0600105 * if (spl_phase() == PHASE_BOARD_F) {
Simon Glassb7fb5132019-09-25 08:11:20 -0600106 * ...
107 * }
108 *
109 * @return U-Boot phase
110 */
111static inline enum u_boot_phase spl_phase(void)
112{
113#ifdef CONFIG_TPL_BUILD
114 return PHASE_TPL;
115#elif CONFIG_SPL_BUILD
116 return PHASE_SPL;
117#else
Simon Glass3c573b52019-09-25 08:56:30 -0600118 DECLARE_GLOBAL_DATA_PTR;
119
120 if (!(gd->flags & GD_FLG_RELOC))
121 return PHASE_BOARD_F;
122 else
123 return PHASE_BOARD_R;
Simon Glassb7fb5132019-09-25 08:11:20 -0600124#endif
125}
126
Simon Glass95e4ec12021-01-13 20:29:42 -0700127/**
128 * spl_prev_phase() - Figure out the previous U-Boot phase
129 *
130 * @return the previous phase from this one, e.g. if called in SPL this returns
131 * PHASE_TPL, if TPL is enabled
132 */
133static inline enum u_boot_phase spl_prev_phase(void)
134{
135#ifdef CONFIG_TPL_BUILD
136 return PHASE_NONE;
137#elif defined(CONFIG_SPL_BUILD)
138 return IS_ENABLED(CONFIG_TPL) ? PHASE_TPL : PHASE_NONE;
139#else
140 return IS_ENABLED(CONFIG_SPL) ? PHASE_SPL : PHASE_NONE;
141#endif
142}
143
144/**
145 * spl_next_phase() - Figure out the next U-Boot phase
146 *
147 * @return the next phase from this one, e.g. if called in TPL this returns
148 * PHASE_SPL
149 */
150static inline enum u_boot_phase spl_next_phase(void)
151{
152#ifdef CONFIG_TPL_BUILD
153 return PHASE_SPL;
154#else
155 return PHASE_BOARD_F;
156#endif
157}
158
159/**
160 * spl_phase_name() - Get the name of the current phase
161 *
162 * @return phase name
163 */
164static inline const char *spl_phase_name(enum u_boot_phase phase)
165{
166 switch (phase) {
167 case PHASE_TPL:
168 return "TPL";
169 case PHASE_SPL:
170 return "SPL";
171 case PHASE_BOARD_F:
172 case PHASE_BOARD_R:
173 return "U-Boot";
174 default:
175 return "phase?";
176 }
177}
178
Simon Glass1cd06002021-07-05 16:32:45 -0600179/**
180 * spl_phase_prefix() - Get the prefix of the current phase
181 *
182 * @phase: Phase to look up
183 * @return phase prefix ("spl", "tpl", etc.)
184 */
185static inline const char *spl_phase_prefix(enum u_boot_phase phase)
186{
187 switch (phase) {
188 case PHASE_TPL:
189 return "tpl";
190 case PHASE_SPL:
191 return "spl";
192 case PHASE_BOARD_F:
193 case PHASE_BOARD_R:
194 return "";
195 default:
196 return "phase?";
197 }
198}
199
Simon Glassdbd3f112018-11-15 18:43:56 -0700200/* A string name for SPL or TPL */
201#ifdef CONFIG_SPL_BUILD
202# ifdef CONFIG_TPL_BUILD
Heiko Schocherce251232018-12-05 11:29:54 +0100203# define SPL_TPL_NAME "TPL"
Simon Glassdbd3f112018-11-15 18:43:56 -0700204# else
Heiko Schocherce251232018-12-05 11:29:54 +0100205# define SPL_TPL_NAME "SPL"
Simon Glassdbd3f112018-11-15 18:43:56 -0700206# endif
207# define SPL_TPL_PROMPT SPL_TPL_NAME ": "
208#else
209# define SPL_TPL_NAME ""
210# define SPL_TPL_PROMPT ""
211#endif
212
Tom Rini28591df2012-08-13 12:03:19 -0700213struct spl_image_info {
214 const char *name;
215 u8 os;
Philipp Tomsichf13e9e02017-09-13 21:29:31 +0200216 uintptr_t load_addr;
217 uintptr_t entry_point;
Marek Vasut187b9e32019-05-07 21:17:02 +0200218#if CONFIG_IS_ENABLED(LOAD_FIT) || CONFIG_IS_ENABLED(LOAD_FIT_FULL)
Philipp Tomsichbe5ac1a2017-09-13 21:29:30 +0200219 void *fdt_addr;
220#endif
Philipp Tomsich58beb6e2018-05-24 17:15:50 +0200221 u32 boot_device;
Tom Rini28591df2012-08-13 12:03:19 -0700222 u32 size;
Stefan Roese00b57b32012-08-27 12:50:58 +0200223 u32 flags;
Vikas Manocha62b021c2017-04-07 15:38:13 -0700224 void *arg;
Simon Goldschmidt17140472019-02-10 21:34:37 +0100225#ifdef CONFIG_SPL_LEGACY_IMAGE_CRC_CHECK
226 ulong dcrc_data;
227 ulong dcrc_length;
228 ulong dcrc;
229#endif
Tom Rini28591df2012-08-13 12:03:19 -0700230};
231
Dario Binacchi0f860b62020-05-27 13:56:18 +0200232/**
Simon Glassa6131a22016-02-22 22:55:56 -0700233 * Information required to load data from a device
234 *
235 * @dev: Pointer to the device, e.g. struct mmc *
236 * @priv: Private data for the device
237 * @bl_len: Block length for reading in bytes
Lokesh Vutlaf62cef12016-05-24 10:34:38 +0530238 * @filename: Name of the fit image file.
Simon Glassa6131a22016-02-22 22:55:56 -0700239 * @read: Function to call to read from the device
240 */
241struct spl_load_info {
242 void *dev;
243 void *priv;
244 int bl_len;
Lokesh Vutlaf62cef12016-05-24 10:34:38 +0530245 const char *filename;
Simon Glassee112092021-03-07 17:35:15 -0700246 /**
247 * read() - Read from device
248 *
249 * @load: Information about the load state
250 * @sector: Sector number to read from (each @load->bl_len bytes)
251 * @count: Number of sectors to read
252 * @buf: Buffer to read into
253 * @return number of sectors read, 0 on error
254 */
Simon Glassa6131a22016-02-22 22:55:56 -0700255 ulong (*read)(struct spl_load_info *load, ulong sector, ulong count,
256 void *buf);
257};
258
Simon Glass867a3982017-11-13 18:55:03 -0700259/*
260 * We need to know the position of U-Boot in memory so we can jump to it. We
261 * allow any U-Boot binary to be used (u-boot.bin, u-boot-nodtb.bin,
262 * u-boot.img), hence the '_any'. These is no checking here that the correct
Simon Glass596f31c2019-12-08 17:40:12 -0700263 * image is found. For example if u-boot.img is used we don't check that
Simon Glass867a3982017-11-13 18:55:03 -0700264 * spl_parse_image_header() can parse a valid header.
Simon Glass596f31c2019-12-08 17:40:12 -0700265 *
266 * Similarly for SPL, so that TPL can jump to SPL.
Simon Glass867a3982017-11-13 18:55:03 -0700267 */
Simon Glass9dcc8612018-08-01 15:22:42 -0600268binman_sym_extern(ulong, u_boot_any, image_pos);
Simon Glass596f31c2019-12-08 17:40:12 -0700269binman_sym_extern(ulong, u_boot_any, size);
270binman_sym_extern(ulong, spl, image_pos);
271binman_sym_extern(ulong, spl, size);
272
273/**
274 * spl_get_image_pos() - get the image position of the next phase
275 *
276 * This returns the image position to use to load the next phase of U-Boot
277 */
278ulong spl_get_image_pos(void);
279
280/**
281 * spl_get_image_size() - get the size of the next phase
282 *
283 * This returns the size to use to load the next phase of U-Boot
284 */
285ulong spl_get_image_size(void);
Simon Glass867a3982017-11-13 18:55:03 -0700286
Lokesh Vutlaf62cef12016-05-24 10:34:38 +0530287/**
Simon Glass53857ee2021-01-24 10:06:03 -0700288 * spl_get_image_text_base() - get the text base of the next phase
289 *
290 * This returns the address that the next stage is linked to run at, i.e.
291 * CONFIG_SPL_TEXT_BASE or CONFIG_SYS_TEXT_BASE
292 *
293 * @return text-base address
294 */
295ulong spl_get_image_text_base(void);
296
297/**
Andreas Dannenberg8d9f7f12019-06-04 17:55:46 -0500298 * spl_load_simple_fit_skip_processing() - Hook to allow skipping the FIT
299 * image processing during spl_load_simple_fit().
300 *
301 * Return true to skip FIT processing, false to preserve the full code flow
302 * of spl_load_simple_fit().
303 */
304bool spl_load_simple_fit_skip_processing(void);
305
306/**
Lokesh Vutlaf62cef12016-05-24 10:34:38 +0530307 * spl_load_simple_fit() - Loads a fit image from a device.
Simon Glass43a734f2016-09-24 18:20:16 -0600308 * @spl_image: Image description to set up
Lokesh Vutlaf62cef12016-05-24 10:34:38 +0530309 * @info: Structure containing the information required to load data.
310 * @sector: Sector number where FIT image is located in the device
311 * @fdt: Pointer to the copied FIT header.
312 *
313 * Reads the FIT image @sector in the device. Loads u-boot image to
314 * specified load address and copies the dtb to end of u-boot image.
315 * Returns 0 on success.
316 */
Simon Glass43a734f2016-09-24 18:20:16 -0600317int spl_load_simple_fit(struct spl_image_info *spl_image,
318 struct spl_load_info *info, ulong sector, void *fdt);
Simon Glassa6131a22016-02-22 22:55:56 -0700319
Stefan Roese00b57b32012-08-27 12:50:58 +0200320#define SPL_COPY_PAYLOAD_ONLY 1
Ye Li9d5b0f42018-11-17 09:10:25 +0000321#define SPL_FIT_FOUND 2
Stefan Roese00b57b32012-08-27 12:50:58 +0200322
Peng Fand8670762019-08-22 07:42:38 +0000323/**
Stefan Roese84ae9d82020-04-21 09:28:43 +0200324 * spl_load_legacy_img() - Loads a legacy image from a device.
325 * @spl_image: Image description to set up
326 * @load: Structure containing the information required to load data.
327 * @header: Pointer to image header (including appended image)
328 *
329 * Reads an legacy image from the device. Loads u-boot image to
330 * specified load address.
331 * Returns 0 on success.
332 */
333int spl_load_legacy_img(struct spl_image_info *spl_image,
334 struct spl_load_info *load, ulong header);
335
336/**
Peng Fand8670762019-08-22 07:42:38 +0000337 * spl_load_imx_container() - Loads a imx container image from a device.
338 * @spl_image: Image description to set up
339 * @info: Structure containing the information required to load data.
340 * @sector: Sector number where container image is located in the device
341 *
342 * Reads the container image @sector in the device. Loads u-boot image to
343 * specified load address.
344 */
345int spl_load_imx_container(struct spl_image_info *spl_image,
346 struct spl_load_info *info, ulong sector);
347
Tom Rini28591df2012-08-13 12:03:19 -0700348/* SPL common functions */
349void preloader_console_init(void);
350u32 spl_boot_device(void);
Harald Seiler0bf7ab12020-04-15 11:33:30 +0200351
352/**
353 * spl_mmc_boot_mode() - Lookup function for the mode of an MMC boot source.
354 * @boot_device: ID of the device which the MMC driver wants to read
355 * from. Common values are e.g. BOOT_DEVICE_MMC1,
356 * BOOT_DEVICE_MMC2, BOOT_DEVICE_MMC2_2.
357 *
358 * This function should return one of MMCSD_MODE_FS, MMCSD_MODE_EMMCBOOT, or
359 * MMCSD_MODE_RAW for each MMC boot source which is defined for the target. The
360 * boot_device parameter tells which device the MMC driver is interested in.
361 *
362 * If not overridden, it is weakly defined in common/spl/spl_mmc.c.
363 *
364 * Note: It is important to use the boot_device parameter instead of e.g.
365 * spl_boot_device() as U-Boot is not always loaded from the same device as SPL.
366 */
367u32 spl_mmc_boot_mode(const u32 boot_device);
Harald Seilerbf16c302020-04-15 11:33:31 +0200368
369/**
370 * spl_mmc_boot_partition() - MMC partition to load U-Boot from.
371 * @boot_device: ID of the device which the MMC driver wants to load
372 * U-Boot from.
373 *
374 * This function should return the partition number which the SPL
375 * should load U-Boot from (on the given boot_device) when
376 * CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_USE_PARTITION is set.
377 *
378 * If not overridden, it is weakly defined in common/spl/spl_mmc.c.
379 */
380int spl_mmc_boot_partition(const u32 boot_device);
Marek Vasutde1ce232021-07-03 04:55:32 +0200381
382struct mmc;
383/**
384 * default_spl_mmc_emmc_boot_partition() - eMMC boot partition to load U-Boot from.
385 * mmc: Pointer for the mmc device structure
386 *
387 * This function should return the eMMC boot partition number which
388 * the SPL should load U-Boot from (on the given boot_device).
389 */
390int default_spl_mmc_emmc_boot_partition(struct mmc *mmc);
391
392/**
393 * spl_mmc_emmc_boot_partition() - eMMC boot partition to load U-Boot from.
394 * mmc: Pointer for the mmc device structure
395 *
396 * This function should return the eMMC boot partition number which
397 * the SPL should load U-Boot from (on the given boot_device).
398 *
399 * If not overridden, it is weakly defined in common/spl/spl_mmc.c
400 * and calls default_spl_mmc_emmc_boot_partition();
401 */
402int spl_mmc_emmc_boot_partition(struct mmc *mmc);
403
Alexandru Gagniuc7861f8b2021-04-08 11:56:11 -0500404void spl_set_bd(void);
Simon Glass11a1a272016-09-24 18:19:52 -0600405
406/**
407 * spl_set_header_raw_uboot() - Set up a standard SPL image structure
408 *
409 * This sets up the given spl_image which the standard values obtained from
410 * config options: CONFIG_SYS_MONITOR_LEN, CONFIG_SYS_UBOOT_START,
411 * CONFIG_SYS_TEXT_BASE.
412 *
Simon Glass6b2e4db2016-09-24 18:19:53 -0600413 * @spl_image: Image description to set up
Simon Glass11a1a272016-09-24 18:19:52 -0600414 */
415void spl_set_header_raw_uboot(struct spl_image_info *spl_image);
416
Simon Glass6b2e4db2016-09-24 18:19:53 -0600417/**
418 * spl_parse_image_header() - parse the image header and set up info
419 *
420 * This parses the legacy image header information at @header and sets up
421 * @spl_image according to what is found. If no image header is found, then
422 * a raw image or bootz is assumed. If CONFIG_SPL_PANIC_ON_RAW_IMAGE is
Andrew F. Davisb4be3c32017-02-16 11:18:38 -0600423 * enabled, then this causes a panic. If CONFIG_SPL_RAW_IMAGE_SUPPORT is not
Simon Glass6b2e4db2016-09-24 18:19:53 -0600424 * enabled then U-Boot gives up. Otherwise U-Boot sets up the image using
425 * spl_set_header_raw_uboot(), or possibly the bootz header.
426 *
427 * @spl_image: Image description to set up
428 * @header image header to parse
429 * @return 0 if a header was correctly parsed, -ve on error
430 */
431int spl_parse_image_header(struct spl_image_info *spl_image,
432 const struct image_header *header);
433
Tom Rini28591df2012-08-13 12:03:19 -0700434void spl_board_prepare_for_linux(void);
Alexandru Gagniucf2b410a2021-07-15 14:19:24 -0500435
436/**
437 * spl_board_prepare_for_optee() - Prepare board for an OPTEE payload
438 *
439 * Prepares the board for booting an OP-TEE payload. Initialization is platform
440 * specific, and may include configuring the TrustZone memory, and other
441 * initialization steps required by OP-TEE.
442 * Note that @fdt is not used directly by OP-TEE. OP-TEE passes this @fdt to
443 * its normal world target. This target is not guaranteed to be u-boot, so @fdt
444 * changes that would normally be done by u-boot should be done in this step.
445 *
446 * @fdt: Devicetree that will be passed on, or NULL
447 */
448void spl_board_prepare_for_optee(void *fdt);
Michal Simek7a8465b2016-05-10 07:54:20 +0200449void spl_board_prepare_for_boot(void);
Ladislav Michl2a8ea482016-07-12 20:28:13 +0200450int spl_board_ubi_load_image(u32 boot_device);
Alifer Moraes2649d0c2020-01-14 15:55:01 -0300451int spl_board_boot_device(u32 boot_device);
Simon Glassb805c352016-09-24 18:19:54 -0600452
453/**
454 * jump_to_image_linux() - Jump to a Linux kernel from SPL
455 *
456 * This jumps into a Linux kernel using the information in @spl_image.
457 *
458 * @spl_image: Image description to set up
Simon Glassb805c352016-09-24 18:19:54 -0600459 */
Vikas Manocha62b021c2017-04-07 15:38:13 -0700460void __noreturn jump_to_image_linux(struct spl_image_info *spl_image);
Simon Glass3e6b1c32016-09-24 18:19:55 -0600461
462/**
463 * spl_start_uboot() - Check if SPL should start the kernel or U-Boot
464 *
465 * This is called by the various SPL loaders to determine whether the board
466 * wants to load the kernel or U-Boot. This function should be provided by
467 * the board.
468 *
469 * @return 0 if SPL should start the kernel, 1 if U-Boot must be started
470 */
Tom Rini28591df2012-08-13 12:03:19 -0700471int spl_start_uboot(void);
Simon Glass3e6b1c32016-09-24 18:19:55 -0600472
Simon Glassf481ab12016-09-24 18:19:56 -0600473/**
474 * spl_display_print() - Display a board-specific message in SPL
475 *
476 * If CONFIG_SPL_DISPLAY_PRINT is enabled, U-Boot will call this function
477 * immediately after displaying the SPL console banner ("U-Boot SPL ...").
478 * This function should be provided by the board.
479 */
Tom Rini28591df2012-08-13 12:03:19 -0700480void spl_display_print(void);
481
Simon Glassc0b6c9b2016-09-24 18:19:57 -0600482/**
483 * struct spl_boot_device - Describes a boot device used by SPL
484 *
485 * @boot_device: A number indicating the BOOT_DEVICE type. There are various
486 * BOOT_DEVICE... #defines and enums in U-Boot and they are not consistently
487 * numbered.
488 * @boot_device_name: Named boot device, or NULL if none.
489 *
490 * Note: Additional fields can be added here, bearing in mind that SPL is
491 * size-sensitive and common fields will be present on all boards. This
492 * struct can also be used to return additional information about the load
493 * process if that becomes useful.
494 */
495struct spl_boot_device {
496 uint boot_device;
497 const char *boot_device_name;
498};
499
Simon Glassd1cf3732016-09-24 18:19:58 -0600500/**
501 * Holds information about a way of loading an SPL image
502 *
Simon Glass4fc1f252016-11-30 15:30:50 -0700503 * @name: User-friendly name for this method (e.g. "MMC")
Simon Glassd1cf3732016-09-24 18:19:58 -0600504 * @boot_device: Boot device that this loader supports
505 * @load_image: Function to call to load image
506 */
507struct spl_image_loader {
Simon Glass4fc1f252016-11-30 15:30:50 -0700508#ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
509 const char *name;
510#endif
Simon Glassd1cf3732016-09-24 18:19:58 -0600511 uint boot_device;
512 /**
513 * load_image() - Load an SPL image
514 *
Simon Glassee306792016-09-24 18:20:13 -0600515 * @spl_image: place to put image information
Simon Glassd1cf3732016-09-24 18:19:58 -0600516 * @bootdev: describes the boot device to load from
517 */
Simon Glassee306792016-09-24 18:20:13 -0600518 int (*load_image)(struct spl_image_info *spl_image,
519 struct spl_boot_device *bootdev);
Simon Glassd1cf3732016-09-24 18:19:58 -0600520};
521
Simon Glass58254e02021-07-05 16:32:57 -0600522/* Helper function for accessing the name */
523static inline const char *spl_loader_name(const struct spl_image_loader *loader)
524{
525#ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
526 return loader->name;
527#else
528 return NULL;
529#endif
530}
531
Simon Glassd1cf3732016-09-24 18:19:58 -0600532/* Declare an SPL image loader */
533#define SPL_LOAD_IMAGE(__name) \
534 ll_entry_declare(struct spl_image_loader, __name, spl_image_loader)
535
536/*
Simon Glassbf4fd552016-11-30 15:30:49 -0700537 * _priority is the priority of this method, 0 meaning it will be the top
Simon Glassd1cf3732016-09-24 18:19:58 -0600538 * choice for this device, 9 meaning it is the bottom choice.
Simon Glassbf4fd552016-11-30 15:30:49 -0700539 * _boot_device is the BOOT_DEVICE_... value
540 * _method is the load_image function to call
Simon Glassd1cf3732016-09-24 18:19:58 -0600541 */
Simon Glass4fc1f252016-11-30 15:30:50 -0700542#ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
543#define SPL_LOAD_IMAGE_METHOD(_name, _priority, _boot_device, _method) \
Simon Glassec1503c2019-10-20 21:31:45 -0600544 SPL_LOAD_IMAGE(_boot_device ## _priority ## _method) = { \
Simon Glass4fc1f252016-11-30 15:30:50 -0700545 .name = _name, \
Simon Glassbf4fd552016-11-30 15:30:49 -0700546 .boot_device = _boot_device, \
547 .load_image = _method, \
Simon Glassd1cf3732016-09-24 18:19:58 -0600548 }
Simon Glass4fc1f252016-11-30 15:30:50 -0700549#else
550#define SPL_LOAD_IMAGE_METHOD(_name, _priority, _boot_device, _method) \
Simon Glassec1503c2019-10-20 21:31:45 -0600551 SPL_LOAD_IMAGE(_boot_device ## _priority ## _method) = { \
Simon Glass4fc1f252016-11-30 15:30:50 -0700552 .boot_device = _boot_device, \
553 .load_image = _method, \
554 }
555#endif
Simon Glassd1cf3732016-09-24 18:19:58 -0600556
Dan Murphyb7b5b0c2014-01-16 11:23:29 -0600557/* SPL FAT image functions */
Simon Glass3eb382a2016-09-24 18:20:15 -0600558int spl_load_image_fat(struct spl_image_info *spl_image,
559 struct blk_desc *block_dev, int partition,
Simon Glasse3394752016-02-29 15:25:34 -0700560 const char *filename);
Simon Glass3eb382a2016-09-24 18:20:15 -0600561int spl_load_image_fat_os(struct spl_image_info *spl_image,
562 struct blk_desc *block_dev, int partition);
Dan Murphyb7b5b0c2014-01-16 11:23:29 -0600563
Jeroen Hofstee454c0712014-10-08 22:58:07 +0200564void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image);
565
Guillaume GARDET1eb410c2014-10-15 17:53:12 +0200566/* SPL EXT image functions */
Simon Glass0649e912016-09-24 18:20:14 -0600567int spl_load_image_ext(struct spl_image_info *spl_image,
568 struct blk_desc *block_dev, int partition,
Simon Glasse3394752016-02-29 15:25:34 -0700569 const char *filename);
Simon Glass0649e912016-09-24 18:20:14 -0600570int spl_load_image_ext_os(struct spl_image_info *spl_image,
571 struct blk_desc *block_dev, int partition);
Guillaume GARDET1eb410c2014-10-15 17:53:12 +0200572
Simon Glassfa2a4db2015-06-23 15:39:10 -0600573/**
Eddie Cai32258992017-03-15 08:43:28 -0600574 * spl_early_init() - Set up device tree and driver model in SPL if enabled
Simon Glassfa2a4db2015-06-23 15:39:10 -0600575 *
576 * Call this function in board_init_f() if you want to use device tree and
Eddie Cai32258992017-03-15 08:43:28 -0600577 * driver model early, before board_init_r() is called.
578 *
579 * If this is not called, then driver model will be inactive in SPL's
580 * board_init_f(), and no device tree will be available.
581 */
582int spl_early_init(void);
583
584/**
585 * spl_init() - Set up device tree and driver model in SPL if enabled
586 *
587 * You can optionally call spl_early_init(), then optionally call spl_init().
588 * This function will be called from board_init_r() if not called earlier.
589 *
590 * Both spl_early_init() and spl_init() perform a similar function except that
591 * the latter will not set up the malloc() area if
592 * CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN is enabled, since it is assumed to
593 * already be done by a calll to spl_relocate_stack_gd() before board_init_r()
594 * is reached.
595 *
596 * This function will be called from board_init_r() if not called earlier.
Simon Glassfa2a4db2015-06-23 15:39:10 -0600597 *
598 * If this is not called, then driver model will be inactive in SPL's
599 * board_init_f(), and no device tree will be available.
600 */
601int spl_init(void);
602
Tom Rini28591df2012-08-13 12:03:19 -0700603#ifdef CONFIG_SPL_BOARD_INIT
604void spl_board_init(void);
605#endif
Simon Glassa77e1b82015-05-13 07:02:24 -0600606
607/**
608 * spl_was_boot_source() - check if U-Boot booted from SPL
609 *
610 * This will normally be true, but if U-Boot jumps to second U-Boot, it will
611 * be false. This should be implemented by board-specific code.
612 *
613 * @return true if U-Boot booted from SPL, else false
614 */
615bool spl_was_boot_source(void);
616
B, Ravid207b7e2016-07-28 17:39:16 +0530617/**
618 * spl_dfu_cmd- run dfu command with chosen mmc device interface
619 * @param usb_index - usb controller number
620 * @param mmc_dev - mmc device nubmer
621 *
622 * @return 0 on success, otherwise error code
623 */
624int spl_dfu_cmd(int usbctrl, char *dfu_alt_info, char *interface, char *devstr);
Simon Glass8dd1c9e2016-09-24 18:19:51 -0600625
Marek Vasut8d5c4c32016-12-01 02:06:35 +0100626int spl_mmc_load_image(struct spl_image_info *spl_image,
627 struct spl_boot_device *bootdev);
628
Philipp Tomsichf13e9e02017-09-13 21:29:31 +0200629/**
Andreas Dannenberg8d9f7f12019-06-04 17:55:46 -0500630 * spl_mmc_load() - Load an image file from MMC/SD media
631 *
632 * @param spl_image Image data filled in by loading process
633 * @param bootdev Describes which device to load from
634 * @param filename Name of file to load (in FS mode)
635 * @param raw_part Partition to load from (in RAW mode)
636 * @param raw_sect Sector to load from (in RAW mode)
637 *
638 * @return 0 on success, otherwise error code
639 */
640int spl_mmc_load(struct spl_image_info *spl_image,
641 struct spl_boot_device *bootdev,
642 const char *filename,
643 int raw_part,
644 unsigned long raw_sect);
645
Faiz Abbas05e3a152020-08-03 11:35:04 +0530646/**
647 * spl_usb_load() - Load an image file from USB mass storage
648 *
649 * @param spl_image Image data filled in by loading process
650 * @param bootdev Describes which device to load from
651 * @param raw_part Fat partition to load from
652 * @param filename Name of file to load
653 *
654 * @return 0 on success, otherwise error code
655 */
656int spl_usb_load(struct spl_image_info *spl_image,
657 struct spl_boot_device *bootdev,
658 int partition, const char *filename);
659
Andreas Dannenberg58892082019-08-15 15:55:27 -0500660int spl_ymodem_load_image(struct spl_image_info *spl_image,
661 struct spl_boot_device *bootdev);
662
Andreas Dannenberg8d9f7f12019-06-04 17:55:46 -0500663/**
Philipp Tomsichf13e9e02017-09-13 21:29:31 +0200664 * spl_invoke_atf - boot using an ARM trusted firmware image
665 */
666void spl_invoke_atf(struct spl_image_info *spl_image);
Philipp Tomsich83ad7022017-06-22 23:38:36 +0200667
668/**
Michael Walle2def7d92020-11-18 17:45:56 +0100669 * bl2_plat_get_bl31_params() - return params for bl31.
670 * @bl32_entry: address of BL32 executable (secure)
671 * @bl33_entry: address of BL33 executable (non secure)
672 * @fdt_addr: address of Flat Device Tree
Michal Simekd1598e22019-12-19 18:13:31 +0100673 *
Michael Walle2def7d92020-11-18 17:45:56 +0100674 * This is a weak function which might be overridden by the board code. By
675 * default it will just call bl2_plat_get_bl31_params_default().
Michal Simekd1598e22019-12-19 18:13:31 +0100676 *
Michael Walle2def7d92020-11-18 17:45:56 +0100677 * If you just want to manipulate or add some parameters, you can override
678 * this function, call bl2_plat_get_bl31_params_default and operate on the
679 * returned bl31 params.
680 *
681 * Return: bl31 params structure pointer
Michal Simekd1598e22019-12-19 18:13:31 +0100682 */
683struct bl31_params *bl2_plat_get_bl31_params(uintptr_t bl32_entry,
684 uintptr_t bl33_entry,
685 uintptr_t fdt_addr);
686
687/**
Michael Walle2def7d92020-11-18 17:45:56 +0100688 * bl2_plat_get_bl31_params_default() - prepare params for bl31.
689 * @bl32_entry: address of BL32 executable (secure)
690 * @bl33_entry: address of BL33 executable (non secure)
691 * @fdt_addr: address of Flat Device Tree
692 *
693 * This is the default implementation of bl2_plat_get_bl31_params(). It assigns
694 * a pointer to the memory that the platform has kept aside to pass platform
695 * specific and trusted firmware related information to BL31. This memory is
696 * allocated by allocating memory to bl2_to_bl31_params_mem structure which is
697 * a superset of all the structure whose information is passed to BL31
698 *
699 * NOTE: The memory is statically allocated, thus this function should be
700 * called only once. All subsequent calls will overwrite any changes.
701 *
702 * Return: bl31 params structure pointer
703 */
704struct bl31_params *bl2_plat_get_bl31_params_default(uintptr_t bl32_entry,
705 uintptr_t bl33_entry,
706 uintptr_t fdt_addr);
Michael Walleafaf6ea2020-11-18 17:45:58 +0100707
708/**
709 * bl2_plat_get_bl31_params_v2() - return params for bl31
710 * @bl32_entry: address of BL32 executable (secure)
711 * @bl33_entry: address of BL33 executable (non secure)
712 * @fdt_addr: address of Flat Device Tree
713 *
714 * This function does the same as bl2_plat_get_bl31_params() except that is is
715 * used for the new LOAD_IMAGE_V2 option, which uses a slightly different
716 * method to pass the parameters.
717 *
718 * Return: bl31 params structure pointer
719 */
720struct bl_params *bl2_plat_get_bl31_params_v2(uintptr_t bl32_entry,
721 uintptr_t bl33_entry,
722 uintptr_t fdt_addr);
723
724/**
725 * bl2_plat_get_bl31_params_v2_default() - prepare params for bl31.
726 * @bl32_entry: address of BL32 executable (secure)
727 * @bl33_entry: address of BL33 executable (non secure)
728 * @fdt_addr: address of Flat Device Tree
729 *
730 * This is the default implementation of bl2_plat_get_bl31_params_v2(). It
731 * prepares the linked list of the bl31 params, populates the image types and
732 * set the entry points for bl32 and bl33 (if available).
733 *
734 * NOTE: The memory is statically allocated, thus this function should be
735 * called only once. All subsequent calls will overwrite any changes.
736 *
737 * Return: bl31 params structure pointer
738 */
739struct bl_params *bl2_plat_get_bl31_params_v2_default(uintptr_t bl32_entry,
740 uintptr_t bl33_entry,
741 uintptr_t fdt_addr);
Michael Walle2def7d92020-11-18 17:45:56 +0100742/**
Kever Yanga28d42c2018-08-23 17:17:59 +0800743 * spl_optee_entry - entry function for optee
744 *
745 * args defind in op-tee project
746 * https://github.com/OP-TEE/optee_os/
747 * core/arch/arm/kernel/generic_entry_a32.S
748 * @arg0: pagestore
749 * @arg1: (ARMv7 standard bootarg #1)
750 * @arg2: device tree address, (ARMv7 standard bootarg #2)
751 * @arg3: non-secure entry address (ARMv7 bootarg #0)
752 */
753void spl_optee_entry(void *arg0, void *arg1, void *arg2, void *arg3);
754
755/**
Lukas Auer515b9342019-08-21 21:14:44 +0200756 * spl_invoke_opensbi - boot using a RISC-V OpenSBI image
757 */
758void spl_invoke_opensbi(struct spl_image_info *spl_image);
759
760/**
Philipp Tomsich83ad7022017-06-22 23:38:36 +0200761 * board_return_to_bootrom - allow for boards to continue with the boot ROM
762 *
763 * If a board (e.g. the Rockchip RK3368 boards) provide some
764 * supporting functionality for SPL in their boot ROM and the SPL
765 * stage wants to return to the ROM code to continue booting, boards
766 * can implement 'board_return_to_bootrom'.
767 */
Peng Fanaa050c52019-08-07 06:40:53 +0000768int board_return_to_bootrom(struct spl_image_info *spl_image,
769 struct spl_boot_device *bootdev);
Philipp Tomsich58beb6e2018-05-24 17:15:50 +0200770
771/**
Peng Fanc86bacd2018-11-17 09:10:31 +0000772 * board_spl_fit_post_load - allow process images after loading finished
Alexandru Gagniuc44af2a52021-01-20 10:46:49 -0600773 * @fit: Pointer to a valid Flattened Image Tree blob
Peng Fanc86bacd2018-11-17 09:10:31 +0000774 */
Alexandru Gagniuc44af2a52021-01-20 10:46:49 -0600775void board_spl_fit_post_load(const void *fit);
Peng Fanc86bacd2018-11-17 09:10:31 +0000776
777/**
778 * board_spl_fit_size_align - specific size align before processing payload
779 *
780 */
781ulong board_spl_fit_size_align(ulong size);
782
783/**
Philipp Tomsich58beb6e2018-05-24 17:15:50 +0200784 * spl_perform_fixups() - arch/board-specific callback before processing
785 * the boot-payload
786 */
787void spl_perform_fixups(struct spl_image_info *spl_image);
Marek Vasut1dda46f2018-08-14 11:27:02 +0200788
789/*
790 * spl_get_load_buffer() - get buffer for loading partial image data
791 *
792 * Returns memory area which can be populated by partial image data,
793 * ie. uImage or fitImage header.
794 */
795struct image_header *spl_get_load_buffer(ssize_t offset, size_t size);
796
Peng Fan617fc292020-05-05 20:28:41 +0800797void spl_save_restore_data(void);
Tom Rini28591df2012-08-13 12:03:19 -0700798#endif