blob: faffeb519ac5d8c82bc6a0badf03a45b248b5155 [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 Glassdbd3f112018-11-15 18:43:56 -0700179/* A string name for SPL or TPL */
180#ifdef CONFIG_SPL_BUILD
181# ifdef CONFIG_TPL_BUILD
Heiko Schocherce251232018-12-05 11:29:54 +0100182# define SPL_TPL_NAME "TPL"
Simon Glassdbd3f112018-11-15 18:43:56 -0700183# else
Heiko Schocherce251232018-12-05 11:29:54 +0100184# define SPL_TPL_NAME "SPL"
Simon Glassdbd3f112018-11-15 18:43:56 -0700185# endif
186# define SPL_TPL_PROMPT SPL_TPL_NAME ": "
187#else
188# define SPL_TPL_NAME ""
189# define SPL_TPL_PROMPT ""
190#endif
191
Tom Rini28591df2012-08-13 12:03:19 -0700192struct spl_image_info {
193 const char *name;
194 u8 os;
Philipp Tomsichf13e9e02017-09-13 21:29:31 +0200195 uintptr_t load_addr;
196 uintptr_t entry_point;
Marek Vasut187b9e32019-05-07 21:17:02 +0200197#if CONFIG_IS_ENABLED(LOAD_FIT) || CONFIG_IS_ENABLED(LOAD_FIT_FULL)
Philipp Tomsichbe5ac1a2017-09-13 21:29:30 +0200198 void *fdt_addr;
199#endif
Philipp Tomsich58beb6e2018-05-24 17:15:50 +0200200 u32 boot_device;
Tom Rini28591df2012-08-13 12:03:19 -0700201 u32 size;
Stefan Roese00b57b32012-08-27 12:50:58 +0200202 u32 flags;
Vikas Manocha62b021c2017-04-07 15:38:13 -0700203 void *arg;
Simon Goldschmidt17140472019-02-10 21:34:37 +0100204#ifdef CONFIG_SPL_LEGACY_IMAGE_CRC_CHECK
205 ulong dcrc_data;
206 ulong dcrc_length;
207 ulong dcrc;
208#endif
Tom Rini28591df2012-08-13 12:03:19 -0700209};
210
Dario Binacchi0f860b62020-05-27 13:56:18 +0200211/**
Simon Glassa6131a22016-02-22 22:55:56 -0700212 * Information required to load data from a device
213 *
214 * @dev: Pointer to the device, e.g. struct mmc *
215 * @priv: Private data for the device
216 * @bl_len: Block length for reading in bytes
Lokesh Vutlaf62cef12016-05-24 10:34:38 +0530217 * @filename: Name of the fit image file.
Simon Glassa6131a22016-02-22 22:55:56 -0700218 * @read: Function to call to read from the device
219 */
220struct spl_load_info {
221 void *dev;
222 void *priv;
223 int bl_len;
Lokesh Vutlaf62cef12016-05-24 10:34:38 +0530224 const char *filename;
Simon Glassa6131a22016-02-22 22:55:56 -0700225 ulong (*read)(struct spl_load_info *load, ulong sector, ulong count,
226 void *buf);
227};
228
Simon Glass867a3982017-11-13 18:55:03 -0700229/*
230 * We need to know the position of U-Boot in memory so we can jump to it. We
231 * allow any U-Boot binary to be used (u-boot.bin, u-boot-nodtb.bin,
232 * u-boot.img), hence the '_any'. These is no checking here that the correct
Simon Glass596f31c2019-12-08 17:40:12 -0700233 * image is found. For example if u-boot.img is used we don't check that
Simon Glass867a3982017-11-13 18:55:03 -0700234 * spl_parse_image_header() can parse a valid header.
Simon Glass596f31c2019-12-08 17:40:12 -0700235 *
236 * Similarly for SPL, so that TPL can jump to SPL.
Simon Glass867a3982017-11-13 18:55:03 -0700237 */
Simon Glass9dcc8612018-08-01 15:22:42 -0600238binman_sym_extern(ulong, u_boot_any, image_pos);
Simon Glass596f31c2019-12-08 17:40:12 -0700239binman_sym_extern(ulong, u_boot_any, size);
240binman_sym_extern(ulong, spl, image_pos);
241binman_sym_extern(ulong, spl, size);
242
243/**
244 * spl_get_image_pos() - get the image position of the next phase
245 *
246 * This returns the image position to use to load the next phase of U-Boot
247 */
248ulong spl_get_image_pos(void);
249
250/**
251 * spl_get_image_size() - get the size of the next phase
252 *
253 * This returns the size to use to load the next phase of U-Boot
254 */
255ulong spl_get_image_size(void);
Simon Glass867a3982017-11-13 18:55:03 -0700256
Lokesh Vutlaf62cef12016-05-24 10:34:38 +0530257/**
Andreas Dannenberg8d9f7f12019-06-04 17:55:46 -0500258 * spl_load_simple_fit_skip_processing() - Hook to allow skipping the FIT
259 * image processing during spl_load_simple_fit().
260 *
261 * Return true to skip FIT processing, false to preserve the full code flow
262 * of spl_load_simple_fit().
263 */
264bool spl_load_simple_fit_skip_processing(void);
265
266/**
Lokesh Vutlaf62cef12016-05-24 10:34:38 +0530267 * spl_load_simple_fit() - Loads a fit image from a device.
Simon Glass43a734f2016-09-24 18:20:16 -0600268 * @spl_image: Image description to set up
Lokesh Vutlaf62cef12016-05-24 10:34:38 +0530269 * @info: Structure containing the information required to load data.
270 * @sector: Sector number where FIT image is located in the device
271 * @fdt: Pointer to the copied FIT header.
272 *
273 * Reads the FIT image @sector in the device. Loads u-boot image to
274 * specified load address and copies the dtb to end of u-boot image.
275 * Returns 0 on success.
276 */
Simon Glass43a734f2016-09-24 18:20:16 -0600277int spl_load_simple_fit(struct spl_image_info *spl_image,
278 struct spl_load_info *info, ulong sector, void *fdt);
Simon Glassa6131a22016-02-22 22:55:56 -0700279
Stefan Roese00b57b32012-08-27 12:50:58 +0200280#define SPL_COPY_PAYLOAD_ONLY 1
Ye Li9d5b0f42018-11-17 09:10:25 +0000281#define SPL_FIT_FOUND 2
Stefan Roese00b57b32012-08-27 12:50:58 +0200282
Peng Fand8670762019-08-22 07:42:38 +0000283/**
Stefan Roese84ae9d82020-04-21 09:28:43 +0200284 * spl_load_legacy_img() - Loads a legacy image from a device.
285 * @spl_image: Image description to set up
286 * @load: Structure containing the information required to load data.
287 * @header: Pointer to image header (including appended image)
288 *
289 * Reads an legacy image from the device. Loads u-boot image to
290 * specified load address.
291 * Returns 0 on success.
292 */
293int spl_load_legacy_img(struct spl_image_info *spl_image,
294 struct spl_load_info *load, ulong header);
295
296/**
Peng Fand8670762019-08-22 07:42:38 +0000297 * spl_load_imx_container() - Loads a imx container image from a device.
298 * @spl_image: Image description to set up
299 * @info: Structure containing the information required to load data.
300 * @sector: Sector number where container image is located in the device
301 *
302 * Reads the container image @sector in the device. Loads u-boot image to
303 * specified load address.
304 */
305int spl_load_imx_container(struct spl_image_info *spl_image,
306 struct spl_load_info *info, ulong sector);
307
Tom Rini28591df2012-08-13 12:03:19 -0700308/* SPL common functions */
309void preloader_console_init(void);
310u32 spl_boot_device(void);
Harald Seiler0bf7ab12020-04-15 11:33:30 +0200311
312/**
313 * spl_mmc_boot_mode() - Lookup function for the mode of an MMC boot source.
314 * @boot_device: ID of the device which the MMC driver wants to read
315 * from. Common values are e.g. BOOT_DEVICE_MMC1,
316 * BOOT_DEVICE_MMC2, BOOT_DEVICE_MMC2_2.
317 *
318 * This function should return one of MMCSD_MODE_FS, MMCSD_MODE_EMMCBOOT, or
319 * MMCSD_MODE_RAW for each MMC boot source which is defined for the target. The
320 * boot_device parameter tells which device the MMC driver is interested in.
321 *
322 * If not overridden, it is weakly defined in common/spl/spl_mmc.c.
323 *
324 * Note: It is important to use the boot_device parameter instead of e.g.
325 * spl_boot_device() as U-Boot is not always loaded from the same device as SPL.
326 */
327u32 spl_mmc_boot_mode(const u32 boot_device);
Harald Seilerbf16c302020-04-15 11:33:31 +0200328
329/**
330 * spl_mmc_boot_partition() - MMC partition to load U-Boot from.
331 * @boot_device: ID of the device which the MMC driver wants to load
332 * U-Boot from.
333 *
334 * This function should return the partition number which the SPL
335 * should load U-Boot from (on the given boot_device) when
336 * CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_USE_PARTITION is set.
337 *
338 * If not overridden, it is weakly defined in common/spl/spl_mmc.c.
339 */
340int spl_mmc_boot_partition(const u32 boot_device);
Simon Glassb79ff7c2020-12-22 19:30:21 -0700341
342/**
343 * spl_alloc_bd() - Allocate space for bd_info
344 *
345 * This sets up the gd->bd pointer by allocating memory for it
346 *
347 * @return 0 if OK, -ENOMEM if out of memory
348 */
349int spl_alloc_bd(void);
Simon Glass11a1a272016-09-24 18:19:52 -0600350
351/**
352 * spl_set_header_raw_uboot() - Set up a standard SPL image structure
353 *
354 * This sets up the given spl_image which the standard values obtained from
355 * config options: CONFIG_SYS_MONITOR_LEN, CONFIG_SYS_UBOOT_START,
356 * CONFIG_SYS_TEXT_BASE.
357 *
Simon Glass6b2e4db2016-09-24 18:19:53 -0600358 * @spl_image: Image description to set up
Simon Glass11a1a272016-09-24 18:19:52 -0600359 */
360void spl_set_header_raw_uboot(struct spl_image_info *spl_image);
361
Simon Glass6b2e4db2016-09-24 18:19:53 -0600362/**
363 * spl_parse_image_header() - parse the image header and set up info
364 *
365 * This parses the legacy image header information at @header and sets up
366 * @spl_image according to what is found. If no image header is found, then
367 * a raw image or bootz is assumed. If CONFIG_SPL_PANIC_ON_RAW_IMAGE is
Andrew F. Davisb4be3c32017-02-16 11:18:38 -0600368 * enabled, then this causes a panic. If CONFIG_SPL_RAW_IMAGE_SUPPORT is not
Simon Glass6b2e4db2016-09-24 18:19:53 -0600369 * enabled then U-Boot gives up. Otherwise U-Boot sets up the image using
370 * spl_set_header_raw_uboot(), or possibly the bootz header.
371 *
372 * @spl_image: Image description to set up
373 * @header image header to parse
374 * @return 0 if a header was correctly parsed, -ve on error
375 */
376int spl_parse_image_header(struct spl_image_info *spl_image,
377 const struct image_header *header);
378
Tom Rini28591df2012-08-13 12:03:19 -0700379void spl_board_prepare_for_linux(void);
Michal Simek7a8465b2016-05-10 07:54:20 +0200380void spl_board_prepare_for_boot(void);
Ladislav Michl2a8ea482016-07-12 20:28:13 +0200381int spl_board_ubi_load_image(u32 boot_device);
Alifer Moraes2649d0c2020-01-14 15:55:01 -0300382int spl_board_boot_device(u32 boot_device);
Simon Glassb805c352016-09-24 18:19:54 -0600383
384/**
385 * jump_to_image_linux() - Jump to a Linux kernel from SPL
386 *
387 * This jumps into a Linux kernel using the information in @spl_image.
388 *
389 * @spl_image: Image description to set up
Simon Glassb805c352016-09-24 18:19:54 -0600390 */
Vikas Manocha62b021c2017-04-07 15:38:13 -0700391void __noreturn jump_to_image_linux(struct spl_image_info *spl_image);
Simon Glass3e6b1c32016-09-24 18:19:55 -0600392
393/**
394 * spl_start_uboot() - Check if SPL should start the kernel or U-Boot
395 *
396 * This is called by the various SPL loaders to determine whether the board
397 * wants to load the kernel or U-Boot. This function should be provided by
398 * the board.
399 *
400 * @return 0 if SPL should start the kernel, 1 if U-Boot must be started
401 */
Tom Rini28591df2012-08-13 12:03:19 -0700402int spl_start_uboot(void);
Simon Glass3e6b1c32016-09-24 18:19:55 -0600403
Simon Glassf481ab12016-09-24 18:19:56 -0600404/**
405 * spl_display_print() - Display a board-specific message in SPL
406 *
407 * If CONFIG_SPL_DISPLAY_PRINT is enabled, U-Boot will call this function
408 * immediately after displaying the SPL console banner ("U-Boot SPL ...").
409 * This function should be provided by the board.
410 */
Tom Rini28591df2012-08-13 12:03:19 -0700411void spl_display_print(void);
412
Simon Glassc0b6c9b2016-09-24 18:19:57 -0600413/**
414 * struct spl_boot_device - Describes a boot device used by SPL
415 *
416 * @boot_device: A number indicating the BOOT_DEVICE type. There are various
417 * BOOT_DEVICE... #defines and enums in U-Boot and they are not consistently
418 * numbered.
419 * @boot_device_name: Named boot device, or NULL if none.
420 *
421 * Note: Additional fields can be added here, bearing in mind that SPL is
422 * size-sensitive and common fields will be present on all boards. This
423 * struct can also be used to return additional information about the load
424 * process if that becomes useful.
425 */
426struct spl_boot_device {
427 uint boot_device;
428 const char *boot_device_name;
429};
430
Simon Glassd1cf3732016-09-24 18:19:58 -0600431/**
432 * Holds information about a way of loading an SPL image
433 *
Simon Glass4fc1f252016-11-30 15:30:50 -0700434 * @name: User-friendly name for this method (e.g. "MMC")
Simon Glassd1cf3732016-09-24 18:19:58 -0600435 * @boot_device: Boot device that this loader supports
436 * @load_image: Function to call to load image
437 */
438struct spl_image_loader {
Simon Glass4fc1f252016-11-30 15:30:50 -0700439#ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
440 const char *name;
441#endif
Simon Glassd1cf3732016-09-24 18:19:58 -0600442 uint boot_device;
443 /**
444 * load_image() - Load an SPL image
445 *
Simon Glassee306792016-09-24 18:20:13 -0600446 * @spl_image: place to put image information
Simon Glassd1cf3732016-09-24 18:19:58 -0600447 * @bootdev: describes the boot device to load from
448 */
Simon Glassee306792016-09-24 18:20:13 -0600449 int (*load_image)(struct spl_image_info *spl_image,
450 struct spl_boot_device *bootdev);
Simon Glassd1cf3732016-09-24 18:19:58 -0600451};
452
453/* Declare an SPL image loader */
454#define SPL_LOAD_IMAGE(__name) \
455 ll_entry_declare(struct spl_image_loader, __name, spl_image_loader)
456
457/*
Simon Glassbf4fd552016-11-30 15:30:49 -0700458 * _priority is the priority of this method, 0 meaning it will be the top
Simon Glassd1cf3732016-09-24 18:19:58 -0600459 * choice for this device, 9 meaning it is the bottom choice.
Simon Glassbf4fd552016-11-30 15:30:49 -0700460 * _boot_device is the BOOT_DEVICE_... value
461 * _method is the load_image function to call
Simon Glassd1cf3732016-09-24 18:19:58 -0600462 */
Simon Glass4fc1f252016-11-30 15:30:50 -0700463#ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
464#define SPL_LOAD_IMAGE_METHOD(_name, _priority, _boot_device, _method) \
Simon Glassec1503c2019-10-20 21:31:45 -0600465 SPL_LOAD_IMAGE(_boot_device ## _priority ## _method) = { \
Simon Glass4fc1f252016-11-30 15:30:50 -0700466 .name = _name, \
Simon Glassbf4fd552016-11-30 15:30:49 -0700467 .boot_device = _boot_device, \
468 .load_image = _method, \
Simon Glassd1cf3732016-09-24 18:19:58 -0600469 }
Simon Glass4fc1f252016-11-30 15:30:50 -0700470#else
471#define SPL_LOAD_IMAGE_METHOD(_name, _priority, _boot_device, _method) \
Simon Glassec1503c2019-10-20 21:31:45 -0600472 SPL_LOAD_IMAGE(_boot_device ## _priority ## _method) = { \
Simon Glass4fc1f252016-11-30 15:30:50 -0700473 .boot_device = _boot_device, \
474 .load_image = _method, \
475 }
476#endif
Simon Glassd1cf3732016-09-24 18:19:58 -0600477
Dan Murphyb7b5b0c2014-01-16 11:23:29 -0600478/* SPL FAT image functions */
Simon Glass3eb382a2016-09-24 18:20:15 -0600479int spl_load_image_fat(struct spl_image_info *spl_image,
480 struct blk_desc *block_dev, int partition,
Simon Glasse3394752016-02-29 15:25:34 -0700481 const char *filename);
Simon Glass3eb382a2016-09-24 18:20:15 -0600482int spl_load_image_fat_os(struct spl_image_info *spl_image,
483 struct blk_desc *block_dev, int partition);
Dan Murphyb7b5b0c2014-01-16 11:23:29 -0600484
Jeroen Hofstee454c0712014-10-08 22:58:07 +0200485void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image);
486
Guillaume GARDET1eb410c2014-10-15 17:53:12 +0200487/* SPL EXT image functions */
Simon Glass0649e912016-09-24 18:20:14 -0600488int spl_load_image_ext(struct spl_image_info *spl_image,
489 struct blk_desc *block_dev, int partition,
Simon Glasse3394752016-02-29 15:25:34 -0700490 const char *filename);
Simon Glass0649e912016-09-24 18:20:14 -0600491int spl_load_image_ext_os(struct spl_image_info *spl_image,
492 struct blk_desc *block_dev, int partition);
Guillaume GARDET1eb410c2014-10-15 17:53:12 +0200493
Simon Glassfa2a4db2015-06-23 15:39:10 -0600494/**
Eddie Cai32258992017-03-15 08:43:28 -0600495 * spl_early_init() - Set up device tree and driver model in SPL if enabled
Simon Glassfa2a4db2015-06-23 15:39:10 -0600496 *
497 * Call this function in board_init_f() if you want to use device tree and
Eddie Cai32258992017-03-15 08:43:28 -0600498 * driver model early, before board_init_r() is called.
499 *
500 * If this is not called, then driver model will be inactive in SPL's
501 * board_init_f(), and no device tree will be available.
502 */
503int spl_early_init(void);
504
505/**
506 * spl_init() - Set up device tree and driver model in SPL if enabled
507 *
508 * You can optionally call spl_early_init(), then optionally call spl_init().
509 * This function will be called from board_init_r() if not called earlier.
510 *
511 * Both spl_early_init() and spl_init() perform a similar function except that
512 * the latter will not set up the malloc() area if
513 * CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN is enabled, since it is assumed to
514 * already be done by a calll to spl_relocate_stack_gd() before board_init_r()
515 * is reached.
516 *
517 * This function will be called from board_init_r() if not called earlier.
Simon Glassfa2a4db2015-06-23 15:39:10 -0600518 *
519 * If this is not called, then driver model will be inactive in SPL's
520 * board_init_f(), and no device tree will be available.
521 */
522int spl_init(void);
523
Tom Rini28591df2012-08-13 12:03:19 -0700524#ifdef CONFIG_SPL_BOARD_INIT
525void spl_board_init(void);
526#endif
Simon Glassa77e1b82015-05-13 07:02:24 -0600527
528/**
529 * spl_was_boot_source() - check if U-Boot booted from SPL
530 *
531 * This will normally be true, but if U-Boot jumps to second U-Boot, it will
532 * be false. This should be implemented by board-specific code.
533 *
534 * @return true if U-Boot booted from SPL, else false
535 */
536bool spl_was_boot_source(void);
537
B, Ravid207b7e2016-07-28 17:39:16 +0530538/**
539 * spl_dfu_cmd- run dfu command with chosen mmc device interface
540 * @param usb_index - usb controller number
541 * @param mmc_dev - mmc device nubmer
542 *
543 * @return 0 on success, otherwise error code
544 */
545int spl_dfu_cmd(int usbctrl, char *dfu_alt_info, char *interface, char *devstr);
Simon Glass8dd1c9e2016-09-24 18:19:51 -0600546
Marek Vasut8d5c4c32016-12-01 02:06:35 +0100547int spl_mmc_load_image(struct spl_image_info *spl_image,
548 struct spl_boot_device *bootdev);
549
Philipp Tomsichf13e9e02017-09-13 21:29:31 +0200550/**
Andreas Dannenberg8d9f7f12019-06-04 17:55:46 -0500551 * spl_mmc_load() - Load an image file from MMC/SD media
552 *
553 * @param spl_image Image data filled in by loading process
554 * @param bootdev Describes which device to load from
555 * @param filename Name of file to load (in FS mode)
556 * @param raw_part Partition to load from (in RAW mode)
557 * @param raw_sect Sector to load from (in RAW mode)
558 *
559 * @return 0 on success, otherwise error code
560 */
561int spl_mmc_load(struct spl_image_info *spl_image,
562 struct spl_boot_device *bootdev,
563 const char *filename,
564 int raw_part,
565 unsigned long raw_sect);
566
Faiz Abbas05e3a152020-08-03 11:35:04 +0530567/**
568 * spl_usb_load() - Load an image file from USB mass storage
569 *
570 * @param spl_image Image data filled in by loading process
571 * @param bootdev Describes which device to load from
572 * @param raw_part Fat partition to load from
573 * @param filename Name of file to load
574 *
575 * @return 0 on success, otherwise error code
576 */
577int spl_usb_load(struct spl_image_info *spl_image,
578 struct spl_boot_device *bootdev,
579 int partition, const char *filename);
580
Andreas Dannenberg58892082019-08-15 15:55:27 -0500581int spl_ymodem_load_image(struct spl_image_info *spl_image,
582 struct spl_boot_device *bootdev);
583
Andreas Dannenberg8d9f7f12019-06-04 17:55:46 -0500584/**
Philipp Tomsichf13e9e02017-09-13 21:29:31 +0200585 * spl_invoke_atf - boot using an ARM trusted firmware image
586 */
587void spl_invoke_atf(struct spl_image_info *spl_image);
Philipp Tomsich83ad7022017-06-22 23:38:36 +0200588
589/**
Michael Walle2def7d92020-11-18 17:45:56 +0100590 * bl2_plat_get_bl31_params() - return params for bl31.
591 * @bl32_entry: address of BL32 executable (secure)
592 * @bl33_entry: address of BL33 executable (non secure)
593 * @fdt_addr: address of Flat Device Tree
Michal Simekd1598e22019-12-19 18:13:31 +0100594 *
Michael Walle2def7d92020-11-18 17:45:56 +0100595 * This is a weak function which might be overridden by the board code. By
596 * default it will just call bl2_plat_get_bl31_params_default().
Michal Simekd1598e22019-12-19 18:13:31 +0100597 *
Michael Walle2def7d92020-11-18 17:45:56 +0100598 * If you just want to manipulate or add some parameters, you can override
599 * this function, call bl2_plat_get_bl31_params_default and operate on the
600 * returned bl31 params.
601 *
602 * Return: bl31 params structure pointer
Michal Simekd1598e22019-12-19 18:13:31 +0100603 */
604struct bl31_params *bl2_plat_get_bl31_params(uintptr_t bl32_entry,
605 uintptr_t bl33_entry,
606 uintptr_t fdt_addr);
607
608/**
Michael Walle2def7d92020-11-18 17:45:56 +0100609 * bl2_plat_get_bl31_params_default() - prepare params for bl31.
610 * @bl32_entry: address of BL32 executable (secure)
611 * @bl33_entry: address of BL33 executable (non secure)
612 * @fdt_addr: address of Flat Device Tree
613 *
614 * This is the default implementation of bl2_plat_get_bl31_params(). It assigns
615 * a pointer to the memory that the platform has kept aside to pass platform
616 * specific and trusted firmware related information to BL31. This memory is
617 * allocated by allocating memory to bl2_to_bl31_params_mem structure which is
618 * a superset of all the structure whose information is passed to BL31
619 *
620 * NOTE: The memory is statically allocated, thus this function should be
621 * called only once. All subsequent calls will overwrite any changes.
622 *
623 * Return: bl31 params structure pointer
624 */
625struct bl31_params *bl2_plat_get_bl31_params_default(uintptr_t bl32_entry,
626 uintptr_t bl33_entry,
627 uintptr_t fdt_addr);
Michael Walleafaf6ea2020-11-18 17:45:58 +0100628
629/**
630 * bl2_plat_get_bl31_params_v2() - return params for bl31
631 * @bl32_entry: address of BL32 executable (secure)
632 * @bl33_entry: address of BL33 executable (non secure)
633 * @fdt_addr: address of Flat Device Tree
634 *
635 * This function does the same as bl2_plat_get_bl31_params() except that is is
636 * used for the new LOAD_IMAGE_V2 option, which uses a slightly different
637 * method to pass the parameters.
638 *
639 * Return: bl31 params structure pointer
640 */
641struct bl_params *bl2_plat_get_bl31_params_v2(uintptr_t bl32_entry,
642 uintptr_t bl33_entry,
643 uintptr_t fdt_addr);
644
645/**
646 * bl2_plat_get_bl31_params_v2_default() - prepare params for bl31.
647 * @bl32_entry: address of BL32 executable (secure)
648 * @bl33_entry: address of BL33 executable (non secure)
649 * @fdt_addr: address of Flat Device Tree
650 *
651 * This is the default implementation of bl2_plat_get_bl31_params_v2(). It
652 * prepares the linked list of the bl31 params, populates the image types and
653 * set the entry points for bl32 and bl33 (if available).
654 *
655 * NOTE: The memory is statically allocated, thus this function should be
656 * called only once. All subsequent calls will overwrite any changes.
657 *
658 * Return: bl31 params structure pointer
659 */
660struct bl_params *bl2_plat_get_bl31_params_v2_default(uintptr_t bl32_entry,
661 uintptr_t bl33_entry,
662 uintptr_t fdt_addr);
Michael Walle2def7d92020-11-18 17:45:56 +0100663/**
Kever Yanga28d42c2018-08-23 17:17:59 +0800664 * spl_optee_entry - entry function for optee
665 *
666 * args defind in op-tee project
667 * https://github.com/OP-TEE/optee_os/
668 * core/arch/arm/kernel/generic_entry_a32.S
669 * @arg0: pagestore
670 * @arg1: (ARMv7 standard bootarg #1)
671 * @arg2: device tree address, (ARMv7 standard bootarg #2)
672 * @arg3: non-secure entry address (ARMv7 bootarg #0)
673 */
674void spl_optee_entry(void *arg0, void *arg1, void *arg2, void *arg3);
675
676/**
Lukas Auer515b9342019-08-21 21:14:44 +0200677 * spl_invoke_opensbi - boot using a RISC-V OpenSBI image
678 */
679void spl_invoke_opensbi(struct spl_image_info *spl_image);
680
681/**
Philipp Tomsich83ad7022017-06-22 23:38:36 +0200682 * board_return_to_bootrom - allow for boards to continue with the boot ROM
683 *
684 * If a board (e.g. the Rockchip RK3368 boards) provide some
685 * supporting functionality for SPL in their boot ROM and the SPL
686 * stage wants to return to the ROM code to continue booting, boards
687 * can implement 'board_return_to_bootrom'.
688 */
Peng Fanaa050c52019-08-07 06:40:53 +0000689int board_return_to_bootrom(struct spl_image_info *spl_image,
690 struct spl_boot_device *bootdev);
Philipp Tomsich58beb6e2018-05-24 17:15:50 +0200691
692/**
Peng Fanc86bacd2018-11-17 09:10:31 +0000693 * board_spl_fit_post_load - allow process images after loading finished
694 *
695 */
696void board_spl_fit_post_load(ulong load_addr, size_t length);
697
698/**
699 * board_spl_fit_size_align - specific size align before processing payload
700 *
701 */
702ulong board_spl_fit_size_align(ulong size);
703
704/**
Philipp Tomsich58beb6e2018-05-24 17:15:50 +0200705 * spl_perform_fixups() - arch/board-specific callback before processing
706 * the boot-payload
707 */
708void spl_perform_fixups(struct spl_image_info *spl_image);
Marek Vasut1dda46f2018-08-14 11:27:02 +0200709
710/*
711 * spl_get_load_buffer() - get buffer for loading partial image data
712 *
713 * Returns memory area which can be populated by partial image data,
714 * ie. uImage or fitImage header.
715 */
716struct image_header *spl_get_load_buffer(ssize_t offset, size_t size);
717
Peng Fan617fc292020-05-05 20:28:41 +0800718void spl_save_restore_data(void);
Tom Rini28591df2012-08-13 12:03:19 -0700719#endif