1 /* SPDX-License-Identifier: GPL-2.0+ */
2 /*
3  * (C) Copyright 2012
4  * Texas Instruments, <www.ti.com>
5  */
6 #ifndef	_SPL_H_
7 #define	_SPL_H_
8 
9 #include <binman_sym.h>
10 #include <linker_lists.h>
11 
12 /* Platform-specific defines */
13 #include <linux/compiler.h>
14 #include <asm/global_data.h>
15 #include <asm/spl.h>
16 #include <handoff.h>
17 
18 struct blk_desc;
19 struct image_header;
20 
21 /* Value in r0 indicates we booted from U-Boot */
22 #define UBOOT_NOT_LOADED_FROM_SPL	0x13578642
23 
24 /* Boot type */
25 #define MMCSD_MODE_UNDEFINED	0
26 #define MMCSD_MODE_RAW		1
27 #define MMCSD_MODE_FS		2
28 #define MMCSD_MODE_EMMCBOOT	3
29 
30 struct blk_desc;
31 struct image_header;
32 
33 /*
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  */
u_boot_first_phase(void)45 static 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 
60 enum u_boot_phase {
61 	PHASE_NONE,	/* Invalid phase, signifying before U-Boot */
62 	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 */
66 };
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  *
105  *    if (spl_phase() == PHASE_BOARD_F) {
106  *       ...
107  *    }
108  *
109  * @return U-Boot phase
110  */
spl_phase(void)111 static 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
118 	DECLARE_GLOBAL_DATA_PTR;
119 
120 	if (!(gd->flags & GD_FLG_RELOC))
121 		return PHASE_BOARD_F;
122 	else
123 		return PHASE_BOARD_R;
124 #endif
125 }
126 
127 /**
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  */
spl_prev_phase(void)133 static 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  */
spl_next_phase(void)150 static 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  */
spl_phase_name(enum u_boot_phase phase)164 static 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 
179 /* A string name for SPL or TPL */
180 #ifdef CONFIG_SPL_BUILD
181 # ifdef CONFIG_TPL_BUILD
182 #  define SPL_TPL_NAME	"TPL"
183 # else
184 #  define SPL_TPL_NAME	"SPL"
185 # endif
186 # define SPL_TPL_PROMPT	SPL_TPL_NAME ": "
187 #else
188 # define SPL_TPL_NAME	""
189 # define SPL_TPL_PROMPT	""
190 #endif
191 
192 struct spl_image_info {
193 	const char *name;
194 	u8 os;
195 	uintptr_t load_addr;
196 	uintptr_t entry_point;
197 #if CONFIG_IS_ENABLED(LOAD_FIT) || CONFIG_IS_ENABLED(LOAD_FIT_FULL)
198 	void *fdt_addr;
199 #endif
200 	u32 boot_device;
201 	u32 size;
202 	u32 flags;
203 	void *arg;
204 #ifdef CONFIG_SPL_LEGACY_IMAGE_CRC_CHECK
205 	ulong dcrc_data;
206 	ulong dcrc_length;
207 	ulong dcrc;
208 #endif
209 };
210 
211 /**
212  * 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
217  * @filename: Name of the fit image file.
218  * @read: Function to call to read from the device
219  */
220 struct spl_load_info {
221 	void *dev;
222 	void *priv;
223 	int bl_len;
224 	const char *filename;
225 	ulong (*read)(struct spl_load_info *load, ulong sector, ulong count,
226 		      void *buf);
227 };
228 
229 /*
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
233  * image is found. For example if u-boot.img is used we don't check that
234  * spl_parse_image_header() can parse a valid header.
235  *
236  * Similarly for SPL, so that TPL can jump to SPL.
237  */
238 binman_sym_extern(ulong, u_boot_any, image_pos);
239 binman_sym_extern(ulong, u_boot_any, size);
240 binman_sym_extern(ulong, spl, image_pos);
241 binman_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  */
248 ulong 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  */
255 ulong spl_get_image_size(void);
256 
257 /**
258  * spl_get_image_text_base() - get the text base of the next phase
259  *
260  * This returns the address that the next stage is linked to run at, i.e.
261  * CONFIG_SPL_TEXT_BASE or CONFIG_SYS_TEXT_BASE
262  *
263  * @return text-base address
264  */
265 ulong spl_get_image_text_base(void);
266 
267 /**
268  * spl_load_simple_fit_skip_processing() - Hook to allow skipping the FIT
269  *	image processing during spl_load_simple_fit().
270  *
271  * Return true to skip FIT processing, false to preserve the full code flow
272  * of spl_load_simple_fit().
273  */
274 bool spl_load_simple_fit_skip_processing(void);
275 
276 /**
277  * spl_load_simple_fit() - Loads a fit image from a device.
278  * @spl_image:	Image description to set up
279  * @info:	Structure containing the information required to load data.
280  * @sector:	Sector number where FIT image is located in the device
281  * @fdt:	Pointer to the copied FIT header.
282  *
283  * Reads the FIT image @sector in the device. Loads u-boot image to
284  * specified load address and copies the dtb to end of u-boot image.
285  * Returns 0 on success.
286  */
287 int spl_load_simple_fit(struct spl_image_info *spl_image,
288 			struct spl_load_info *info, ulong sector, void *fdt);
289 
290 #define SPL_COPY_PAYLOAD_ONLY	1
291 #define SPL_FIT_FOUND		2
292 
293 /**
294  * spl_load_legacy_img() - Loads a legacy image from a device.
295  * @spl_image:	Image description to set up
296  * @load:	Structure containing the information required to load data.
297  * @header:	Pointer to image header (including appended image)
298  *
299  * Reads an legacy image from the device. Loads u-boot image to
300  * specified load address.
301  * Returns 0 on success.
302  */
303 int spl_load_legacy_img(struct spl_image_info *spl_image,
304 			struct spl_load_info *load, ulong header);
305 
306 /**
307  * spl_load_imx_container() - Loads a imx container image from a device.
308  * @spl_image:	Image description to set up
309  * @info:	Structure containing the information required to load data.
310  * @sector:	Sector number where container image is located in the device
311  *
312  * Reads the container image @sector in the device. Loads u-boot image to
313  * specified load address.
314  */
315 int spl_load_imx_container(struct spl_image_info *spl_image,
316 			   struct spl_load_info *info, ulong sector);
317 
318 /* SPL common functions */
319 void preloader_console_init(void);
320 u32 spl_boot_device(void);
321 
322 /**
323  * spl_mmc_boot_mode() - Lookup function for the mode of an MMC boot source.
324  * @boot_device:	ID of the device which the MMC driver wants to read
325  *			from.  Common values are e.g. BOOT_DEVICE_MMC1,
326  *			BOOT_DEVICE_MMC2, BOOT_DEVICE_MMC2_2.
327  *
328  * This function should return one of MMCSD_MODE_FS, MMCSD_MODE_EMMCBOOT, or
329  * MMCSD_MODE_RAW for each MMC boot source which is defined for the target.  The
330  * boot_device parameter tells which device the MMC driver is interested in.
331  *
332  * If not overridden, it is weakly defined in common/spl/spl_mmc.c.
333  *
334  * Note:  It is important to use the boot_device parameter instead of e.g.
335  * spl_boot_device() as U-Boot is not always loaded from the same device as SPL.
336  */
337 u32 spl_mmc_boot_mode(const u32 boot_device);
338 
339 /**
340  * spl_mmc_boot_partition() - MMC partition to load U-Boot from.
341  * @boot_device:	ID of the device which the MMC driver wants to load
342  *			U-Boot from.
343  *
344  * This function should return the partition number which the SPL
345  * should load U-Boot from (on the given boot_device) when
346  * CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_USE_PARTITION is set.
347  *
348  * If not overridden, it is weakly defined in common/spl/spl_mmc.c.
349  */
350 int spl_mmc_boot_partition(const u32 boot_device);
351 
352 /**
353  * spl_alloc_bd() - Allocate space for bd_info
354  *
355  * This sets up the gd->bd pointer by allocating memory for it
356  *
357  * @return 0 if OK, -ENOMEM if out of memory
358  */
359 int spl_alloc_bd(void);
360 
361 /**
362  * spl_set_header_raw_uboot() - Set up a standard SPL image structure
363  *
364  * This sets up the given spl_image which the standard values obtained from
365  * config options: CONFIG_SYS_MONITOR_LEN, CONFIG_SYS_UBOOT_START,
366  * CONFIG_SYS_TEXT_BASE.
367  *
368  * @spl_image: Image description to set up
369  */
370 void spl_set_header_raw_uboot(struct spl_image_info *spl_image);
371 
372 /**
373  * spl_parse_image_header() - parse the image header and set up info
374  *
375  * This parses the legacy image header information at @header and sets up
376  * @spl_image according to what is found. If no image header is found, then
377  * a raw image or bootz is assumed. If CONFIG_SPL_PANIC_ON_RAW_IMAGE is
378  * enabled, then this causes a panic. If CONFIG_SPL_RAW_IMAGE_SUPPORT is not
379  * enabled then U-Boot gives up. Otherwise U-Boot sets up the image using
380  * spl_set_header_raw_uboot(), or possibly the bootz header.
381  *
382  * @spl_image: Image description to set up
383  * @header image header to parse
384  * @return 0 if a header was correctly parsed, -ve on error
385  */
386 int spl_parse_image_header(struct spl_image_info *spl_image,
387 			   const struct image_header *header);
388 
389 void spl_board_prepare_for_linux(void);
390 void spl_board_prepare_for_boot(void);
391 int spl_board_ubi_load_image(u32 boot_device);
392 int spl_board_boot_device(u32 boot_device);
393 
394 /**
395  * jump_to_image_linux() - Jump to a Linux kernel from SPL
396  *
397  * This jumps into a Linux kernel using the information in @spl_image.
398  *
399  * @spl_image: Image description to set up
400  */
401 void __noreturn jump_to_image_linux(struct spl_image_info *spl_image);
402 
403 /**
404  * spl_start_uboot() - Check if SPL should start the kernel or U-Boot
405  *
406  * This is called by the various SPL loaders to determine whether the board
407  * wants to load the kernel or U-Boot. This function should be provided by
408  * the board.
409  *
410  * @return 0 if SPL should start the kernel, 1 if U-Boot must be started
411  */
412 int spl_start_uboot(void);
413 
414 /**
415  * spl_display_print() - Display a board-specific message in SPL
416  *
417  * If CONFIG_SPL_DISPLAY_PRINT is enabled, U-Boot will call this function
418  * immediately after displaying the SPL console banner ("U-Boot SPL ...").
419  * This function should be provided by the board.
420  */
421 void spl_display_print(void);
422 
423 /**
424  * struct spl_boot_device - Describes a boot device used by SPL
425  *
426  * @boot_device: A number indicating the BOOT_DEVICE type. There are various
427  * BOOT_DEVICE... #defines and enums in U-Boot and they are not consistently
428  * numbered.
429  * @boot_device_name: Named boot device, or NULL if none.
430  *
431  * Note: Additional fields can be added here, bearing in mind that SPL is
432  * size-sensitive and common fields will be present on all boards. This
433  * struct can also be used to return additional information about the load
434  * process if that becomes useful.
435  */
436 struct spl_boot_device {
437 	uint boot_device;
438 	const char *boot_device_name;
439 };
440 
441 /**
442  * Holds information about a way of loading an SPL image
443  *
444  * @name: User-friendly name for this method (e.g. "MMC")
445  * @boot_device: Boot device that this loader supports
446  * @load_image: Function to call to load image
447  */
448 struct spl_image_loader {
449 #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
450 	const char *name;
451 #endif
452 	uint boot_device;
453 	/**
454 	 * load_image() - Load an SPL image
455 	 *
456 	 * @spl_image: place to put image information
457 	 * @bootdev: describes the boot device to load from
458 	 */
459 	int (*load_image)(struct spl_image_info *spl_image,
460 			  struct spl_boot_device *bootdev);
461 };
462 
463 /* Declare an SPL image loader */
464 #define SPL_LOAD_IMAGE(__name)					\
465 	ll_entry_declare(struct spl_image_loader, __name, spl_image_loader)
466 
467 /*
468  * _priority is the priority of this method, 0 meaning it will be the top
469  * choice for this device, 9 meaning it is the bottom choice.
470  * _boot_device is the BOOT_DEVICE_... value
471  * _method is the load_image function to call
472  */
473 #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
474 #define SPL_LOAD_IMAGE_METHOD(_name, _priority, _boot_device, _method) \
475 	SPL_LOAD_IMAGE(_boot_device ## _priority ## _method) = { \
476 		.name = _name, \
477 		.boot_device = _boot_device, \
478 		.load_image = _method, \
479 	}
480 #else
481 #define SPL_LOAD_IMAGE_METHOD(_name, _priority, _boot_device, _method) \
482 	SPL_LOAD_IMAGE(_boot_device ## _priority ## _method) = { \
483 		.boot_device = _boot_device, \
484 		.load_image = _method, \
485 	}
486 #endif
487 
488 /* SPL FAT image functions */
489 int spl_load_image_fat(struct spl_image_info *spl_image,
490 		       struct blk_desc *block_dev, int partition,
491 		       const char *filename);
492 int spl_load_image_fat_os(struct spl_image_info *spl_image,
493 			  struct blk_desc *block_dev, int partition);
494 
495 void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image);
496 
497 /* SPL EXT image functions */
498 int spl_load_image_ext(struct spl_image_info *spl_image,
499 		       struct blk_desc *block_dev, int partition,
500 		       const char *filename);
501 int spl_load_image_ext_os(struct spl_image_info *spl_image,
502 			  struct blk_desc *block_dev, int partition);
503 
504 /**
505  * spl_early_init() - Set up device tree and driver model in SPL if enabled
506  *
507  * Call this function in board_init_f() if you want to use device tree and
508  * driver model early, before board_init_r() is called.
509  *
510  * If this is not called, then driver model will be inactive in SPL's
511  * board_init_f(), and no device tree will be available.
512  */
513 int spl_early_init(void);
514 
515 /**
516  * spl_init() - Set up device tree and driver model in SPL if enabled
517  *
518  * You can optionally call spl_early_init(), then optionally call spl_init().
519  * This function will be called from board_init_r() if not called earlier.
520  *
521  * Both spl_early_init() and spl_init() perform a similar function except that
522  * the latter will not set up the malloc() area if
523  * CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN is enabled, since it is assumed to
524  * already be done by a calll to spl_relocate_stack_gd() before board_init_r()
525  * is reached.
526  *
527  * This function will be called from board_init_r() if not called earlier.
528  *
529  * If this is not called, then driver model will be inactive in SPL's
530  * board_init_f(), and no device tree will be available.
531  */
532 int spl_init(void);
533 
534 #ifdef CONFIG_SPL_BOARD_INIT
535 void spl_board_init(void);
536 #endif
537 
538 /**
539  * spl_was_boot_source() - check if U-Boot booted from SPL
540  *
541  * This will normally be true, but if U-Boot jumps to second U-Boot, it will
542  * be false. This should be implemented by board-specific code.
543  *
544  * @return true if U-Boot booted from SPL, else false
545  */
546 bool spl_was_boot_source(void);
547 
548 /**
549  * spl_dfu_cmd- run dfu command with chosen mmc device interface
550  * @param usb_index - usb controller number
551  * @param mmc_dev -  mmc device nubmer
552  *
553  * @return 0 on success, otherwise error code
554  */
555 int spl_dfu_cmd(int usbctrl, char *dfu_alt_info, char *interface, char *devstr);
556 
557 int spl_mmc_load_image(struct spl_image_info *spl_image,
558 		       struct spl_boot_device *bootdev);
559 
560 /**
561  * spl_mmc_load() - Load an image file from MMC/SD media
562  *
563  * @param spl_image	Image data filled in by loading process
564  * @param bootdev	Describes which device to load from
565  * @param filename	Name of file to load (in FS mode)
566  * @param raw_part	Partition to load from (in RAW mode)
567  * @param raw_sect	Sector to load from (in RAW mode)
568  *
569  * @return 0 on success, otherwise error code
570  */
571 int spl_mmc_load(struct spl_image_info *spl_image,
572 		 struct spl_boot_device *bootdev,
573 		 const char *filename,
574 		 int raw_part,
575 		 unsigned long raw_sect);
576 
577 /**
578  * spl_usb_load() - Load an image file from USB mass storage
579  *
580  * @param spl_image	Image data filled in by loading process
581  * @param bootdev	Describes which device to load from
582  * @param raw_part	Fat partition to load from
583  * @param filename	Name of file to load
584  *
585  * @return 0 on success, otherwise error code
586  */
587 int spl_usb_load(struct spl_image_info *spl_image,
588 		 struct spl_boot_device *bootdev,
589 		 int partition, const char *filename);
590 
591 int spl_ymodem_load_image(struct spl_image_info *spl_image,
592 			  struct spl_boot_device *bootdev);
593 
594 /**
595  * spl_invoke_atf - boot using an ARM trusted firmware image
596  */
597 void spl_invoke_atf(struct spl_image_info *spl_image);
598 
599 /**
600  * bl2_plat_get_bl31_params() - return params for bl31.
601  * @bl32_entry:	address of BL32 executable (secure)
602  * @bl33_entry:	address of BL33 executable (non secure)
603  * @fdt_addr:	address of Flat Device Tree
604  *
605  * This is a weak function which might be overridden by the board code. By
606  * default it will just call bl2_plat_get_bl31_params_default().
607  *
608  * If you just want to manipulate or add some parameters, you can override
609  * this function, call bl2_plat_get_bl31_params_default and operate on the
610  * returned bl31 params.
611  *
612  * Return: bl31 params structure pointer
613  */
614 struct bl31_params *bl2_plat_get_bl31_params(uintptr_t bl32_entry,
615 					     uintptr_t bl33_entry,
616 					     uintptr_t fdt_addr);
617 
618 /**
619  * bl2_plat_get_bl31_params_default() - prepare params for bl31.
620  * @bl32_entry:	address of BL32 executable (secure)
621  * @bl33_entry:	address of BL33 executable (non secure)
622  * @fdt_addr:	address of Flat Device Tree
623  *
624  * This is the default implementation of bl2_plat_get_bl31_params(). It assigns
625  * a pointer to the memory that the platform has kept aside to pass platform
626  * specific and trusted firmware related information to BL31. This memory is
627  * allocated by allocating memory to bl2_to_bl31_params_mem structure which is
628  * a superset of all the structure whose information is passed to BL31
629  *
630  * NOTE: The memory is statically allocated, thus this function should be
631  * called only once. All subsequent calls will overwrite any changes.
632  *
633  * Return: bl31 params structure pointer
634  */
635 struct bl31_params *bl2_plat_get_bl31_params_default(uintptr_t bl32_entry,
636 						     uintptr_t bl33_entry,
637 						     uintptr_t fdt_addr);
638 
639 /**
640  * bl2_plat_get_bl31_params_v2() - return params for bl31
641  * @bl32_entry:	address of BL32 executable (secure)
642  * @bl33_entry:	address of BL33 executable (non secure)
643  * @fdt_addr:	address of Flat Device Tree
644  *
645  * This function does the same as bl2_plat_get_bl31_params() except that is is
646  * used for the new LOAD_IMAGE_V2 option, which uses a slightly different
647  * method to pass the parameters.
648  *
649  * Return: bl31 params structure pointer
650  */
651 struct bl_params *bl2_plat_get_bl31_params_v2(uintptr_t bl32_entry,
652 					      uintptr_t bl33_entry,
653 					      uintptr_t fdt_addr);
654 
655 /**
656  * bl2_plat_get_bl31_params_v2_default() - prepare params for bl31.
657  * @bl32_entry:	address of BL32 executable (secure)
658  * @bl33_entry:	address of BL33 executable (non secure)
659  * @fdt_addr:	address of Flat Device Tree
660  *
661  * This is the default implementation of bl2_plat_get_bl31_params_v2(). It
662  * prepares the linked list of the bl31 params, populates the image types and
663  * set the entry points for bl32 and bl33 (if available).
664  *
665  * NOTE: The memory is statically allocated, thus this function should be
666  * called only once. All subsequent calls will overwrite any changes.
667  *
668  * Return: bl31 params structure pointer
669  */
670 struct bl_params *bl2_plat_get_bl31_params_v2_default(uintptr_t bl32_entry,
671 						      uintptr_t bl33_entry,
672 						      uintptr_t fdt_addr);
673 /**
674  * spl_optee_entry - entry function for optee
675  *
676  * args defind in op-tee project
677  * https://github.com/OP-TEE/optee_os/
678  * core/arch/arm/kernel/generic_entry_a32.S
679  * @arg0: pagestore
680  * @arg1: (ARMv7 standard bootarg #1)
681  * @arg2: device tree address, (ARMv7 standard bootarg #2)
682  * @arg3: non-secure entry address (ARMv7 bootarg #0)
683  */
684 void spl_optee_entry(void *arg0, void *arg1, void *arg2, void *arg3);
685 
686 /**
687  * spl_invoke_opensbi - boot using a RISC-V OpenSBI image
688  */
689 void spl_invoke_opensbi(struct spl_image_info *spl_image);
690 
691 /**
692  * board_return_to_bootrom - allow for boards to continue with the boot ROM
693  *
694  * If a board (e.g. the Rockchip RK3368 boards) provide some
695  * supporting functionality for SPL in their boot ROM and the SPL
696  * stage wants to return to the ROM code to continue booting, boards
697  * can implement 'board_return_to_bootrom'.
698  */
699 int board_return_to_bootrom(struct spl_image_info *spl_image,
700 			    struct spl_boot_device *bootdev);
701 
702 /**
703  * board_spl_fit_post_load - allow process images after loading finished
704  * @fit: Pointer to a valid Flattened Image Tree blob
705  */
706 void board_spl_fit_post_load(const void *fit);
707 
708 /**
709  * board_spl_fit_size_align - specific size align before processing payload
710  *
711  */
712 ulong board_spl_fit_size_align(ulong size);
713 
714 /**
715  * spl_perform_fixups() - arch/board-specific callback before processing
716  *                        the boot-payload
717  */
718 void spl_perform_fixups(struct spl_image_info *spl_image);
719 
720 /*
721  * spl_get_load_buffer() - get buffer for loading partial image data
722  *
723  * Returns memory area which can be populated by partial image data,
724  * ie. uImage or fitImage header.
725  */
726 struct image_header *spl_get_load_buffer(ssize_t offset, size_t size);
727 
728 void spl_save_restore_data(void);
729 #endif
730