blob: 4f6e0e53f5d4f67a18c94e276162ca3c5c7a4faf [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;
32
Simon Glasse945a722018-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 Glass8e83b762019-09-25 08:11:20 -060060enum u_boot_phase {
Simon Glass09d9ba92021-01-13 20:29:42 -070061 PHASE_NONE, /* Invalid phase, signifying before U-Boot */
Simon Glass59c871b2019-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 Glass8e83b762019-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 Glass59c871b2019-09-25 08:56:30 -0600105 * if (spl_phase() == PHASE_BOARD_F) {
Simon Glass8e83b762019-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 Glass59c871b2019-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 Glass8e83b762019-09-25 08:11:20 -0600124#endif
125}
126
Simon Glass09d9ba92021-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 Glassd6330062018-11-15 18:43:56 -0700179/* A string name for SPL or TPL */
180#ifdef CONFIG_SPL_BUILD
181# ifdef CONFIG_TPL_BUILD
Heiko Schocher8fb23912018-12-05 11:29:54 +0100182# define SPL_TPL_NAME "TPL"
Simon Glassd6330062018-11-15 18:43:56 -0700183# else
Heiko Schocher8fb23912018-12-05 11:29:54 +0100184# define SPL_TPL_NAME "SPL"
Simon Glassd6330062018-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 Rini47f7bca2012-08-13 12:03:19 -0700192struct spl_image_info {
193 const char *name;
194 u8 os;
Philipp Tomsichf2efe672017-09-13 21:29:31 +0200195 uintptr_t load_addr;
196 uintptr_t entry_point;
Marek Vasuta9a82712019-05-07 21:17:02 +0200197#if CONFIG_IS_ENABLED(LOAD_FIT) || CONFIG_IS_ENABLED(LOAD_FIT_FULL)
Philipp Tomsich75014472017-09-13 21:29:30 +0200198 void *fdt_addr;
199#endif
Philipp Tomsichde5dd4c2018-05-24 17:15:50 +0200200 u32 boot_device;
Tom Rini47f7bca2012-08-13 12:03:19 -0700201 u32 size;
Stefan Roese022b4972012-08-27 12:50:58 +0200202 u32 flags;
Vikas Manocha5bf52502017-04-07 15:38:13 -0700203 void *arg;
Simon Goldschmidtdae5c2d2019-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 Rini47f7bca2012-08-13 12:03:19 -0700209};
210
Dario Binacchi146a17a2020-05-27 13:56:18 +0200211/**
Simon Glassf1dcee52016-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 Vutlaeafd5412016-05-24 10:34:38 +0530217 * @filename: Name of the fit image file.
Simon Glassf1dcee52016-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 Vutlaeafd5412016-05-24 10:34:38 +0530224 const char *filename;
Simon Glass2e059e42021-03-07 17:35:15 -0700225 /**
226 * read() - Read from device
227 *
228 * @load: Information about the load state
229 * @sector: Sector number to read from (each @load->bl_len bytes)
230 * @count: Number of sectors to read
231 * @buf: Buffer to read into
232 * @return number of sectors read, 0 on error
233 */
Simon Glassf1dcee52016-02-22 22:55:56 -0700234 ulong (*read)(struct spl_load_info *load, ulong sector, ulong count,
235 void *buf);
236};
237
Simon Glass8bee2d22017-11-13 18:55:03 -0700238/*
239 * We need to know the position of U-Boot in memory so we can jump to it. We
240 * allow any U-Boot binary to be used (u-boot.bin, u-boot-nodtb.bin,
241 * u-boot.img), hence the '_any'. These is no checking here that the correct
Simon Glasse82c6242019-12-08 17:40:12 -0700242 * image is found. For example if u-boot.img is used we don't check that
Simon Glass8bee2d22017-11-13 18:55:03 -0700243 * spl_parse_image_header() can parse a valid header.
Simon Glasse82c6242019-12-08 17:40:12 -0700244 *
245 * Similarly for SPL, so that TPL can jump to SPL.
Simon Glass8bee2d22017-11-13 18:55:03 -0700246 */
Simon Glassdbf6be92018-08-01 15:22:42 -0600247binman_sym_extern(ulong, u_boot_any, image_pos);
Simon Glasse82c6242019-12-08 17:40:12 -0700248binman_sym_extern(ulong, u_boot_any, size);
249binman_sym_extern(ulong, spl, image_pos);
250binman_sym_extern(ulong, spl, size);
251
252/**
253 * spl_get_image_pos() - get the image position of the next phase
254 *
255 * This returns the image position to use to load the next phase of U-Boot
256 */
257ulong spl_get_image_pos(void);
258
259/**
260 * spl_get_image_size() - get the size of the next phase
261 *
262 * This returns the size to use to load the next phase of U-Boot
263 */
264ulong spl_get_image_size(void);
Simon Glass8bee2d22017-11-13 18:55:03 -0700265
Lokesh Vutlaeafd5412016-05-24 10:34:38 +0530266/**
Simon Glass86c372a2021-01-24 10:06:03 -0700267 * spl_get_image_text_base() - get the text base of the next phase
268 *
269 * This returns the address that the next stage is linked to run at, i.e.
270 * CONFIG_SPL_TEXT_BASE or CONFIG_SYS_TEXT_BASE
271 *
272 * @return text-base address
273 */
274ulong spl_get_image_text_base(void);
275
276/**
Andreas Dannenberge1eb6ad2019-06-04 17:55:46 -0500277 * spl_load_simple_fit_skip_processing() - Hook to allow skipping the FIT
278 * image processing during spl_load_simple_fit().
279 *
280 * Return true to skip FIT processing, false to preserve the full code flow
281 * of spl_load_simple_fit().
282 */
283bool spl_load_simple_fit_skip_processing(void);
284
285/**
Lokesh Vutlaeafd5412016-05-24 10:34:38 +0530286 * spl_load_simple_fit() - Loads a fit image from a device.
Simon Glassf4d7d852016-09-24 18:20:16 -0600287 * @spl_image: Image description to set up
Lokesh Vutlaeafd5412016-05-24 10:34:38 +0530288 * @info: Structure containing the information required to load data.
289 * @sector: Sector number where FIT image is located in the device
290 * @fdt: Pointer to the copied FIT header.
291 *
292 * Reads the FIT image @sector in the device. Loads u-boot image to
293 * specified load address and copies the dtb to end of u-boot image.
294 * Returns 0 on success.
295 */
Simon Glassf4d7d852016-09-24 18:20:16 -0600296int spl_load_simple_fit(struct spl_image_info *spl_image,
297 struct spl_load_info *info, ulong sector, void *fdt);
Simon Glassf1dcee52016-02-22 22:55:56 -0700298
Stefan Roese022b4972012-08-27 12:50:58 +0200299#define SPL_COPY_PAYLOAD_ONLY 1
Ye Lie246bfc2018-11-17 09:10:25 +0000300#define SPL_FIT_FOUND 2
Stefan Roese022b4972012-08-27 12:50:58 +0200301
Peng Fandd7d0912019-08-22 07:42:38 +0000302/**
Stefan Roese2fc91ed2020-04-21 09:28:43 +0200303 * spl_load_legacy_img() - Loads a legacy image from a device.
304 * @spl_image: Image description to set up
305 * @load: Structure containing the information required to load data.
306 * @header: Pointer to image header (including appended image)
307 *
308 * Reads an legacy image from the device. Loads u-boot image to
309 * specified load address.
310 * Returns 0 on success.
311 */
312int spl_load_legacy_img(struct spl_image_info *spl_image,
313 struct spl_load_info *load, ulong header);
314
315/**
Peng Fandd7d0912019-08-22 07:42:38 +0000316 * spl_load_imx_container() - Loads a imx container image from a device.
317 * @spl_image: Image description to set up
318 * @info: Structure containing the information required to load data.
319 * @sector: Sector number where container image is located in the device
320 *
321 * Reads the container image @sector in the device. Loads u-boot image to
322 * specified load address.
323 */
324int spl_load_imx_container(struct spl_image_info *spl_image,
325 struct spl_load_info *info, ulong sector);
326
Tom Rini47f7bca2012-08-13 12:03:19 -0700327/* SPL common functions */
328void preloader_console_init(void);
329u32 spl_boot_device(void);
Harald Seilere9759062020-04-15 11:33:30 +0200330
331/**
332 * spl_mmc_boot_mode() - Lookup function for the mode of an MMC boot source.
333 * @boot_device: ID of the device which the MMC driver wants to read
334 * from. Common values are e.g. BOOT_DEVICE_MMC1,
335 * BOOT_DEVICE_MMC2, BOOT_DEVICE_MMC2_2.
336 *
337 * This function should return one of MMCSD_MODE_FS, MMCSD_MODE_EMMCBOOT, or
338 * MMCSD_MODE_RAW for each MMC boot source which is defined for the target. The
339 * boot_device parameter tells which device the MMC driver is interested in.
340 *
341 * If not overridden, it is weakly defined in common/spl/spl_mmc.c.
342 *
343 * Note: It is important to use the boot_device parameter instead of e.g.
344 * spl_boot_device() as U-Boot is not always loaded from the same device as SPL.
345 */
346u32 spl_mmc_boot_mode(const u32 boot_device);
Harald Seilerc51b7512020-04-15 11:33:31 +0200347
348/**
349 * spl_mmc_boot_partition() - MMC partition to load U-Boot from.
350 * @boot_device: ID of the device which the MMC driver wants to load
351 * U-Boot from.
352 *
353 * This function should return the partition number which the SPL
354 * should load U-Boot from (on the given boot_device) when
355 * CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_USE_PARTITION is set.
356 *
357 * If not overridden, it is weakly defined in common/spl/spl_mmc.c.
358 */
359int spl_mmc_boot_partition(const u32 boot_device);
Simon Glass38d6b7e2020-12-22 19:30:21 -0700360
361/**
362 * spl_alloc_bd() - Allocate space for bd_info
363 *
364 * This sets up the gd->bd pointer by allocating memory for it
365 *
366 * @return 0 if OK, -ENOMEM if out of memory
367 */
368int spl_alloc_bd(void);
Simon Glassd95ceb92016-09-24 18:19:52 -0600369
370/**
371 * spl_set_header_raw_uboot() - Set up a standard SPL image structure
372 *
373 * This sets up the given spl_image which the standard values obtained from
374 * config options: CONFIG_SYS_MONITOR_LEN, CONFIG_SYS_UBOOT_START,
375 * CONFIG_SYS_TEXT_BASE.
376 *
Simon Glass71316c12016-09-24 18:19:53 -0600377 * @spl_image: Image description to set up
Simon Glassd95ceb92016-09-24 18:19:52 -0600378 */
379void spl_set_header_raw_uboot(struct spl_image_info *spl_image);
380
Simon Glass71316c12016-09-24 18:19:53 -0600381/**
382 * spl_parse_image_header() - parse the image header and set up info
383 *
384 * This parses the legacy image header information at @header and sets up
385 * @spl_image according to what is found. If no image header is found, then
386 * a raw image or bootz is assumed. If CONFIG_SPL_PANIC_ON_RAW_IMAGE is
Andrew F. Davis24eb39b2017-02-16 11:18:38 -0600387 * enabled, then this causes a panic. If CONFIG_SPL_RAW_IMAGE_SUPPORT is not
Simon Glass71316c12016-09-24 18:19:53 -0600388 * enabled then U-Boot gives up. Otherwise U-Boot sets up the image using
389 * spl_set_header_raw_uboot(), or possibly the bootz header.
390 *
391 * @spl_image: Image description to set up
392 * @header image header to parse
393 * @return 0 if a header was correctly parsed, -ve on error
394 */
395int spl_parse_image_header(struct spl_image_info *spl_image,
396 const struct image_header *header);
397
Tom Rini47f7bca2012-08-13 12:03:19 -0700398void spl_board_prepare_for_linux(void);
Michal Simek3a3b9142016-05-10 07:54:20 +0200399void spl_board_prepare_for_boot(void);
Ladislav Michlbf55cd42016-07-12 20:28:13 +0200400int spl_board_ubi_load_image(u32 boot_device);
Alifer Moraes40eeb9c2020-01-14 15:55:01 -0300401int spl_board_boot_device(u32 boot_device);
Simon Glassca12e652016-09-24 18:19:54 -0600402
403/**
404 * jump_to_image_linux() - Jump to a Linux kernel from SPL
405 *
406 * This jumps into a Linux kernel using the information in @spl_image.
407 *
408 * @spl_image: Image description to set up
Simon Glassca12e652016-09-24 18:19:54 -0600409 */
Vikas Manocha5bf52502017-04-07 15:38:13 -0700410void __noreturn jump_to_image_linux(struct spl_image_info *spl_image);
Simon Glassf59961e2016-09-24 18:19:55 -0600411
412/**
413 * spl_start_uboot() - Check if SPL should start the kernel or U-Boot
414 *
415 * This is called by the various SPL loaders to determine whether the board
416 * wants to load the kernel or U-Boot. This function should be provided by
417 * the board.
418 *
419 * @return 0 if SPL should start the kernel, 1 if U-Boot must be started
420 */
Tom Rini47f7bca2012-08-13 12:03:19 -0700421int spl_start_uboot(void);
Simon Glassf59961e2016-09-24 18:19:55 -0600422
Simon Glassa807ab32016-09-24 18:19:56 -0600423/**
424 * spl_display_print() - Display a board-specific message in SPL
425 *
426 * If CONFIG_SPL_DISPLAY_PRINT is enabled, U-Boot will call this function
427 * immediately after displaying the SPL console banner ("U-Boot SPL ...").
428 * This function should be provided by the board.
429 */
Tom Rini47f7bca2012-08-13 12:03:19 -0700430void spl_display_print(void);
431
Simon Glassecdfd692016-09-24 18:19:57 -0600432/**
433 * struct spl_boot_device - Describes a boot device used by SPL
434 *
435 * @boot_device: A number indicating the BOOT_DEVICE type. There are various
436 * BOOT_DEVICE... #defines and enums in U-Boot and they are not consistently
437 * numbered.
438 * @boot_device_name: Named boot device, or NULL if none.
439 *
440 * Note: Additional fields can be added here, bearing in mind that SPL is
441 * size-sensitive and common fields will be present on all boards. This
442 * struct can also be used to return additional information about the load
443 * process if that becomes useful.
444 */
445struct spl_boot_device {
446 uint boot_device;
447 const char *boot_device_name;
448};
449
Simon Glassa0a80292016-09-24 18:19:58 -0600450/**
451 * Holds information about a way of loading an SPL image
452 *
Simon Glassebc4ef62016-11-30 15:30:50 -0700453 * @name: User-friendly name for this method (e.g. "MMC")
Simon Glassa0a80292016-09-24 18:19:58 -0600454 * @boot_device: Boot device that this loader supports
455 * @load_image: Function to call to load image
456 */
457struct spl_image_loader {
Simon Glassebc4ef62016-11-30 15:30:50 -0700458#ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
459 const char *name;
460#endif
Simon Glassa0a80292016-09-24 18:19:58 -0600461 uint boot_device;
462 /**
463 * load_image() - Load an SPL image
464 *
Simon Glass2a2ee2a2016-09-24 18:20:13 -0600465 * @spl_image: place to put image information
Simon Glassa0a80292016-09-24 18:19:58 -0600466 * @bootdev: describes the boot device to load from
467 */
Simon Glass2a2ee2a2016-09-24 18:20:13 -0600468 int (*load_image)(struct spl_image_info *spl_image,
469 struct spl_boot_device *bootdev);
Simon Glassa0a80292016-09-24 18:19:58 -0600470};
471
472/* Declare an SPL image loader */
473#define SPL_LOAD_IMAGE(__name) \
474 ll_entry_declare(struct spl_image_loader, __name, spl_image_loader)
475
476/*
Simon Glass0d3b0592016-11-30 15:30:49 -0700477 * _priority is the priority of this method, 0 meaning it will be the top
Simon Glassa0a80292016-09-24 18:19:58 -0600478 * choice for this device, 9 meaning it is the bottom choice.
Simon Glass0d3b0592016-11-30 15:30:49 -0700479 * _boot_device is the BOOT_DEVICE_... value
480 * _method is the load_image function to call
Simon Glassa0a80292016-09-24 18:19:58 -0600481 */
Simon Glassebc4ef62016-11-30 15:30:50 -0700482#ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
483#define SPL_LOAD_IMAGE_METHOD(_name, _priority, _boot_device, _method) \
Simon Glasse1500a62019-10-20 21:31:45 -0600484 SPL_LOAD_IMAGE(_boot_device ## _priority ## _method) = { \
Simon Glassebc4ef62016-11-30 15:30:50 -0700485 .name = _name, \
486 .boot_device = _boot_device, \
487 .load_image = _method, \
488 }
489#else
490#define SPL_LOAD_IMAGE_METHOD(_name, _priority, _boot_device, _method) \
Simon Glasse1500a62019-10-20 21:31:45 -0600491 SPL_LOAD_IMAGE(_boot_device ## _priority ## _method) = { \
Simon Glass0d3b0592016-11-30 15:30:49 -0700492 .boot_device = _boot_device, \
493 .load_image = _method, \
Simon Glassa0a80292016-09-24 18:19:58 -0600494 }
Simon Glassebc4ef62016-11-30 15:30:50 -0700495#endif
Simon Glassa0a80292016-09-24 18:19:58 -0600496
Dan Murphy773b5942014-01-16 11:23:29 -0600497/* SPL FAT image functions */
Simon Glass710e9ca2016-09-24 18:20:15 -0600498int spl_load_image_fat(struct spl_image_info *spl_image,
499 struct blk_desc *block_dev, int partition,
Simon Glass4101f682016-02-29 15:25:34 -0700500 const char *filename);
Simon Glass710e9ca2016-09-24 18:20:15 -0600501int spl_load_image_fat_os(struct spl_image_info *spl_image,
502 struct blk_desc *block_dev, int partition);
Dan Murphy773b5942014-01-16 11:23:29 -0600503
Jeroen Hofsteece048222014-10-08 22:58:07 +0200504void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image);
505
Guillaume GARDET592f9222014-10-15 17:53:12 +0200506/* SPL EXT image functions */
Simon Glassb4a6c2a2016-09-24 18:20:14 -0600507int spl_load_image_ext(struct spl_image_info *spl_image,
508 struct blk_desc *block_dev, int partition,
Simon Glass4101f682016-02-29 15:25:34 -0700509 const char *filename);
Simon Glassb4a6c2a2016-09-24 18:20:14 -0600510int spl_load_image_ext_os(struct spl_image_info *spl_image,
511 struct blk_desc *block_dev, int partition);
Guillaume GARDET592f9222014-10-15 17:53:12 +0200512
Simon Glass070d00b2015-06-23 15:39:10 -0600513/**
Eddie Cai340f4182017-03-15 08:43:28 -0600514 * spl_early_init() - Set up device tree and driver model in SPL if enabled
Simon Glass070d00b2015-06-23 15:39:10 -0600515 *
516 * Call this function in board_init_f() if you want to use device tree and
Eddie Cai340f4182017-03-15 08:43:28 -0600517 * driver model early, before board_init_r() is called.
518 *
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_early_init(void);
523
524/**
525 * spl_init() - Set up device tree and driver model in SPL if enabled
526 *
527 * You can optionally call spl_early_init(), then optionally call spl_init().
528 * This function will be called from board_init_r() if not called earlier.
529 *
530 * Both spl_early_init() and spl_init() perform a similar function except that
531 * the latter will not set up the malloc() area if
532 * CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN is enabled, since it is assumed to
533 * already be done by a calll to spl_relocate_stack_gd() before board_init_r()
534 * is reached.
535 *
536 * This function will be called from board_init_r() if not called earlier.
Simon Glass070d00b2015-06-23 15:39:10 -0600537 *
538 * If this is not called, then driver model will be inactive in SPL's
539 * board_init_f(), and no device tree will be available.
540 */
541int spl_init(void);
542
Tom Rini47f7bca2012-08-13 12:03:19 -0700543#ifdef CONFIG_SPL_BOARD_INIT
544void spl_board_init(void);
545#endif
Simon Glass32ba8952015-05-13 07:02:24 -0600546
547/**
548 * spl_was_boot_source() - check if U-Boot booted from SPL
549 *
550 * This will normally be true, but if U-Boot jumps to second U-Boot, it will
551 * be false. This should be implemented by board-specific code.
552 *
553 * @return true if U-Boot booted from SPL, else false
554 */
555bool spl_was_boot_source(void);
556
B, Ravi52f2acc2016-07-28 17:39:16 +0530557/**
558 * spl_dfu_cmd- run dfu command with chosen mmc device interface
559 * @param usb_index - usb controller number
560 * @param mmc_dev - mmc device nubmer
561 *
562 * @return 0 on success, otherwise error code
563 */
564int spl_dfu_cmd(int usbctrl, char *dfu_alt_info, char *interface, char *devstr);
Simon Glasse50d76c2016-09-24 18:19:51 -0600565
Marek Vasut09410c62016-12-01 02:06:35 +0100566int spl_mmc_load_image(struct spl_image_info *spl_image,
567 struct spl_boot_device *bootdev);
568
Philipp Tomsichf2efe672017-09-13 21:29:31 +0200569/**
Andreas Dannenberge1eb6ad2019-06-04 17:55:46 -0500570 * spl_mmc_load() - Load an image file from MMC/SD media
571 *
572 * @param spl_image Image data filled in by loading process
573 * @param bootdev Describes which device to load from
574 * @param filename Name of file to load (in FS mode)
575 * @param raw_part Partition to load from (in RAW mode)
576 * @param raw_sect Sector to load from (in RAW mode)
577 *
578 * @return 0 on success, otherwise error code
579 */
580int spl_mmc_load(struct spl_image_info *spl_image,
581 struct spl_boot_device *bootdev,
582 const char *filename,
583 int raw_part,
584 unsigned long raw_sect);
585
Faiz Abbasc3ab97c2020-08-03 11:35:04 +0530586/**
587 * spl_usb_load() - Load an image file from USB mass storage
588 *
589 * @param spl_image Image data filled in by loading process
590 * @param bootdev Describes which device to load from
591 * @param raw_part Fat partition to load from
592 * @param filename Name of file to load
593 *
594 * @return 0 on success, otherwise error code
595 */
596int spl_usb_load(struct spl_image_info *spl_image,
597 struct spl_boot_device *bootdev,
598 int partition, const char *filename);
599
Andreas Dannenberge4130332019-08-15 15:55:27 -0500600int spl_ymodem_load_image(struct spl_image_info *spl_image,
601 struct spl_boot_device *bootdev);
602
Andreas Dannenberge1eb6ad2019-06-04 17:55:46 -0500603/**
Philipp Tomsichf2efe672017-09-13 21:29:31 +0200604 * spl_invoke_atf - boot using an ARM trusted firmware image
605 */
606void spl_invoke_atf(struct spl_image_info *spl_image);
Philipp Tomsich225d30b2017-06-22 23:38:36 +0200607
608/**
Michael Walled2cb0c82020-11-18 17:45:56 +0100609 * bl2_plat_get_bl31_params() - return 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
Michal Simek5c03c992019-12-19 18:13:31 +0100613 *
Michael Walled2cb0c82020-11-18 17:45:56 +0100614 * This is a weak function which might be overridden by the board code. By
615 * default it will just call bl2_plat_get_bl31_params_default().
Michal Simek5c03c992019-12-19 18:13:31 +0100616 *
Michael Walled2cb0c82020-11-18 17:45:56 +0100617 * If you just want to manipulate or add some parameters, you can override
618 * this function, call bl2_plat_get_bl31_params_default and operate on the
619 * returned bl31 params.
620 *
621 * Return: bl31 params structure pointer
Michal Simek5c03c992019-12-19 18:13:31 +0100622 */
623struct bl31_params *bl2_plat_get_bl31_params(uintptr_t bl32_entry,
624 uintptr_t bl33_entry,
625 uintptr_t fdt_addr);
626
627/**
Michael Walled2cb0c82020-11-18 17:45:56 +0100628 * bl2_plat_get_bl31_params_default() - prepare params for bl31.
629 * @bl32_entry: address of BL32 executable (secure)
630 * @bl33_entry: address of BL33 executable (non secure)
631 * @fdt_addr: address of Flat Device Tree
632 *
633 * This is the default implementation of bl2_plat_get_bl31_params(). It assigns
634 * a pointer to the memory that the platform has kept aside to pass platform
635 * specific and trusted firmware related information to BL31. This memory is
636 * allocated by allocating memory to bl2_to_bl31_params_mem structure which is
637 * a superset of all the structure whose information is passed to BL31
638 *
639 * NOTE: The memory is statically allocated, thus this function should be
640 * called only once. All subsequent calls will overwrite any changes.
641 *
642 * Return: bl31 params structure pointer
643 */
644struct bl31_params *bl2_plat_get_bl31_params_default(uintptr_t bl32_entry,
645 uintptr_t bl33_entry,
646 uintptr_t fdt_addr);
Michael Walle7b866822020-11-18 17:45:58 +0100647
648/**
649 * bl2_plat_get_bl31_params_v2() - return params for bl31
650 * @bl32_entry: address of BL32 executable (secure)
651 * @bl33_entry: address of BL33 executable (non secure)
652 * @fdt_addr: address of Flat Device Tree
653 *
654 * This function does the same as bl2_plat_get_bl31_params() except that is is
655 * used for the new LOAD_IMAGE_V2 option, which uses a slightly different
656 * method to pass the parameters.
657 *
658 * Return: bl31 params structure pointer
659 */
660struct bl_params *bl2_plat_get_bl31_params_v2(uintptr_t bl32_entry,
661 uintptr_t bl33_entry,
662 uintptr_t fdt_addr);
663
664/**
665 * bl2_plat_get_bl31_params_v2_default() - prepare params for bl31.
666 * @bl32_entry: address of BL32 executable (secure)
667 * @bl33_entry: address of BL33 executable (non secure)
668 * @fdt_addr: address of Flat Device Tree
669 *
670 * This is the default implementation of bl2_plat_get_bl31_params_v2(). It
671 * prepares the linked list of the bl31 params, populates the image types and
672 * set the entry points for bl32 and bl33 (if available).
673 *
674 * NOTE: The memory is statically allocated, thus this function should be
675 * called only once. All subsequent calls will overwrite any changes.
676 *
677 * Return: bl31 params structure pointer
678 */
679struct bl_params *bl2_plat_get_bl31_params_v2_default(uintptr_t bl32_entry,
680 uintptr_t bl33_entry,
681 uintptr_t fdt_addr);
Michael Walled2cb0c82020-11-18 17:45:56 +0100682/**
Kever Yang70fe2872018-08-23 17:17:59 +0800683 * spl_optee_entry - entry function for optee
684 *
685 * args defind in op-tee project
686 * https://github.com/OP-TEE/optee_os/
687 * core/arch/arm/kernel/generic_entry_a32.S
688 * @arg0: pagestore
689 * @arg1: (ARMv7 standard bootarg #1)
690 * @arg2: device tree address, (ARMv7 standard bootarg #2)
691 * @arg3: non-secure entry address (ARMv7 bootarg #0)
692 */
693void spl_optee_entry(void *arg0, void *arg1, void *arg2, void *arg3);
694
695/**
Lukas Auer5e30e452019-08-21 21:14:44 +0200696 * spl_invoke_opensbi - boot using a RISC-V OpenSBI image
697 */
698void spl_invoke_opensbi(struct spl_image_info *spl_image);
699
700/**
Philipp Tomsich225d30b2017-06-22 23:38:36 +0200701 * board_return_to_bootrom - allow for boards to continue with the boot ROM
702 *
703 * If a board (e.g. the Rockchip RK3368 boards) provide some
704 * supporting functionality for SPL in their boot ROM and the SPL
705 * stage wants to return to the ROM code to continue booting, boards
706 * can implement 'board_return_to_bootrom'.
707 */
Peng Fancda789a2019-08-07 06:40:53 +0000708int board_return_to_bootrom(struct spl_image_info *spl_image,
709 struct spl_boot_device *bootdev);
Philipp Tomsichde5dd4c2018-05-24 17:15:50 +0200710
711/**
Peng Fan28ded1f2018-11-17 09:10:31 +0000712 * board_spl_fit_post_load - allow process images after loading finished
Alexandru Gagniucefc4ad0bc2021-01-20 10:46:49 -0600713 * @fit: Pointer to a valid Flattened Image Tree blob
Peng Fan28ded1f2018-11-17 09:10:31 +0000714 */
Alexandru Gagniucefc4ad0bc2021-01-20 10:46:49 -0600715void board_spl_fit_post_load(const void *fit);
Peng Fan28ded1f2018-11-17 09:10:31 +0000716
717/**
718 * board_spl_fit_size_align - specific size align before processing payload
719 *
720 */
721ulong board_spl_fit_size_align(ulong size);
722
723/**
Philipp Tomsichde5dd4c2018-05-24 17:15:50 +0200724 * spl_perform_fixups() - arch/board-specific callback before processing
725 * the boot-payload
726 */
727void spl_perform_fixups(struct spl_image_info *spl_image);
Marek Vasut04ce5422018-08-14 11:27:02 +0200728
729/*
730 * spl_get_load_buffer() - get buffer for loading partial image data
731 *
732 * Returns memory area which can be populated by partial image data,
733 * ie. uImage or fitImage header.
734 */
735struct image_header *spl_get_load_buffer(ssize_t offset, size_t size);
736
Peng Fan6aead232020-05-05 20:28:41 +0800737void spl_save_restore_data(void);
Tom Rini47f7bca2012-08-13 12:03:19 -0700738#endif