[thirdparty/u-boot.git] / include / spl.h

/* SPDX-License-Identifier: GPL-2.0+ */
/*
 * (C) Copyright 2012
 * Texas Instruments, <www.ti.com>
 */
#ifndef	_SPL_H_
#define	_SPL_H_

#include <binman_sym.h>

/* Platform-specific defines */
#include <linux/compiler.h>
#include <asm/spl.h>
#include <handoff.h>

/* Value in r0 indicates we booted from U-Boot */
#define UBOOT_NOT_LOADED_FROM_SPL	0x13578642

/* Boot type */
#define MMCSD_MODE_UNDEFINED	0
#define MMCSD_MODE_RAW		1
#define MMCSD_MODE_FS		2
#define MMCSD_MODE_EMMCBOOT	3

/*
 * u_boot_first_phase() - check if this is the first U-Boot phase
 *
 * U-Boot has up to three phases: TPL, SPL and U-Boot proper. Depending on the
 * build flags we can determine whether the current build is for the first
 * phase of U-Boot or not. If there is no SPL, then this is U-Boot proper. If
 * there is SPL but no TPL, the the first phase is SPL. If there is TPL, then
 * it is the first phase.
 *
 * @returns true if this is the first phase of U-Boot
 *
 */
static inline bool u_boot_first_phase(void)
{
	if (IS_ENABLED(CONFIG_TPL)) {
		if (IS_ENABLED(CONFIG_TPL_BUILD))
			return true;
	} else if (IS_ENABLED(CONFIG_SPL)) {
		if (IS_ENABLED(CONFIG_SPL_BUILD))
			return true;
	} else {
		return true;
	}

	return false;
}

/* A string name for SPL or TPL */
#ifdef CONFIG_SPL_BUILD
# ifdef CONFIG_TPL_BUILD
#  define SPL_TPL_NAME	"TPL"
# else
#  define SPL_TPL_NAME	"SPL"
# endif
# define SPL_TPL_PROMPT	SPL_TPL_NAME ": "
#else
# define SPL_TPL_NAME	""
# define SPL_TPL_PROMPT	""
#endif

struct spl_image_info {
	const char *name;
	u8 os;
	uintptr_t load_addr;
	uintptr_t entry_point;
#if CONFIG_IS_ENABLED(LOAD_FIT)
	void *fdt_addr;
#endif
	u32 boot_device;
	u32 size;
	u32 flags;
	void *arg;
#ifdef CONFIG_SPL_LEGACY_IMAGE_CRC_CHECK
	ulong dcrc_data;
	ulong dcrc_length;
	ulong dcrc;
#endif
};

/*
 * Information required to load data from a device
 *
 * @dev: Pointer to the device, e.g. struct mmc *
 * @priv: Private data for the device
 * @bl_len: Block length for reading in bytes
 * @filename: Name of the fit image file.
 * @read: Function to call to read from the device
 */
struct spl_load_info {
	void *dev;
	void *priv;
	int bl_len;
	const char *filename;
	ulong (*read)(struct spl_load_info *load, ulong sector, ulong count,
		      void *buf);
};

/*
 * We need to know the position of U-Boot in memory so we can jump to it. We
 * allow any U-Boot binary to be used (u-boot.bin, u-boot-nodtb.bin,
 * u-boot.img), hence the '_any'. These is no checking here that the correct
 * image is found. For * example if u-boot.img is used we don't check that
 * spl_parse_image_header() can parse a valid header.
 */
binman_sym_extern(ulong, u_boot_any, image_pos);

/**
 * spl_load_simple_fit() - Loads a fit image from a device.
 * @spl_image:	Image description to set up
 * @info:	Structure containing the information required to load data.
 * @sector:	Sector number where FIT image is located in the device
 * @fdt:	Pointer to the copied FIT header.
 *
 * Reads the FIT image @sector in the device. Loads u-boot image to
 * specified load address and copies the dtb to end of u-boot image.
 * Returns 0 on success.
 */
int spl_load_simple_fit(struct spl_image_info *spl_image,
			struct spl_load_info *info, ulong sector, void *fdt);

#define SPL_COPY_PAYLOAD_ONLY	1
#define SPL_FIT_FOUND		2

/* SPL common functions */
void preloader_console_init(void);
u32 spl_boot_device(void);
u32 spl_boot_mode(const u32 boot_device);
int spl_boot_partition(const u32 boot_device);
void spl_set_bd(void);

/**
 * spl_set_header_raw_uboot() - Set up a standard SPL image structure
 *
 * This sets up the given spl_image which the standard values obtained from
 * config options: CONFIG_SYS_MONITOR_LEN, CONFIG_SYS_UBOOT_START,
 * CONFIG_SYS_TEXT_BASE.
 *
 * @spl_image: Image description to set up
 */
void spl_set_header_raw_uboot(struct spl_image_info *spl_image);

/**
 * spl_parse_image_header() - parse the image header and set up info
 *
 * This parses the legacy image header information at @header and sets up
 * @spl_image according to what is found. If no image header is found, then
 * a raw image or bootz is assumed. If CONFIG_SPL_PANIC_ON_RAW_IMAGE is
 * enabled, then this causes a panic. If CONFIG_SPL_RAW_IMAGE_SUPPORT is not
 * enabled then U-Boot gives up. Otherwise U-Boot sets up the image using
 * spl_set_header_raw_uboot(), or possibly the bootz header.
 *
 * @spl_image: Image description to set up
 * @header image header to parse
 * @return 0 if a header was correctly parsed, -ve on error
 */
int spl_parse_image_header(struct spl_image_info *spl_image,
			   const struct image_header *header);

void spl_board_prepare_for_linux(void);
void spl_board_prepare_for_boot(void);
int spl_board_ubi_load_image(u32 boot_device);

/**
 * jump_to_image_linux() - Jump to a Linux kernel from SPL
 *
 * This jumps into a Linux kernel using the information in @spl_image.
 *
 * @spl_image: Image description to set up
 */
void __noreturn jump_to_image_linux(struct spl_image_info *spl_image);

/**
 * spl_start_uboot() - Check if SPL should start the kernel or U-Boot
 *
 * This is called by the various SPL loaders to determine whether the board
 * wants to load the kernel or U-Boot. This function should be provided by
 * the board.
 *
 * @return 0 if SPL should start the kernel, 1 if U-Boot must be started
 */
int spl_start_uboot(void);

/**
 * spl_display_print() - Display a board-specific message in SPL
 *
 * If CONFIG_SPL_DISPLAY_PRINT is enabled, U-Boot will call this function
 * immediately after displaying the SPL console banner ("U-Boot SPL ...").
 * This function should be provided by the board.
 */
void spl_display_print(void);

/**
 * struct spl_boot_device - Describes a boot device used by SPL
 *
 * @boot_device: A number indicating the BOOT_DEVICE type. There are various
 * BOOT_DEVICE... #defines and enums in U-Boot and they are not consistently
 * numbered.
 * @boot_device_name: Named boot device, or NULL if none.
 *
 * Note: Additional fields can be added here, bearing in mind that SPL is
 * size-sensitive and common fields will be present on all boards. This
 * struct can also be used to return additional information about the load
 * process if that becomes useful.
 */
struct spl_boot_device {
	uint boot_device;
	const char *boot_device_name;
};

/**
 * Holds information about a way of loading an SPL image
 *
 * @name: User-friendly name for this method (e.g. "MMC")
 * @boot_device: Boot device that this loader supports
 * @load_image: Function to call to load image
 */
struct spl_image_loader {
#ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
	const char *name;
#endif
	uint boot_device;
	/**
	 * load_image() - Load an SPL image
	 *
	 * @spl_image: place to put image information
	 * @bootdev: describes the boot device to load from
	 */
	int (*load_image)(struct spl_image_info *spl_image,
			  struct spl_boot_device *bootdev);
};

/* Declare an SPL image loader */
#define SPL_LOAD_IMAGE(__name)					\
	ll_entry_declare(struct spl_image_loader, __name, spl_image_loader)

/*
 * _priority is the priority of this method, 0 meaning it will be the top
 * choice for this device, 9 meaning it is the bottom choice.
 * _boot_device is the BOOT_DEVICE_... value
 * _method is the load_image function to call
 */
#ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
#define SPL_LOAD_IMAGE_METHOD(_name, _priority, _boot_device, _method) \
	SPL_LOAD_IMAGE(_method ## _priority ## _boot_device) = { \
		.name = _name, \
		.boot_device = _boot_device, \
		.load_image = _method, \
	}
#else
#define SPL_LOAD_IMAGE_METHOD(_name, _priority, _boot_device, _method) \
	SPL_LOAD_IMAGE(_method ## _priority ## _boot_device) = { \
		.boot_device = _boot_device, \
		.load_image = _method, \
	}
#endif

/* SPL FAT image functions */
int spl_load_image_fat(struct spl_image_info *spl_image,
		       struct blk_desc *block_dev, int partition,
		       const char *filename);
int spl_load_image_fat_os(struct spl_image_info *spl_image,
			  struct blk_desc *block_dev, int partition);

void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image);

/* SPL EXT image functions */
int spl_load_image_ext(struct spl_image_info *spl_image,
		       struct blk_desc *block_dev, int partition,
		       const char *filename);
int spl_load_image_ext_os(struct spl_image_info *spl_image,
			  struct blk_desc *block_dev, int partition);

/**
 * spl_early_init() - Set up device tree and driver model in SPL if enabled
 *
 * Call this function in board_init_f() if you want to use device tree and
 * driver model early, before board_init_r() is called.
 *
 * If this is not called, then driver model will be inactive in SPL's
 * board_init_f(), and no device tree will be available.
 */
int spl_early_init(void);

/**
 * spl_init() - Set up device tree and driver model in SPL if enabled
 *
 * You can optionally call spl_early_init(), then optionally call spl_init().
 * This function will be called from board_init_r() if not called earlier.
 *
 * Both spl_early_init() and spl_init() perform a similar function except that
 * the latter will not set up the malloc() area if
 * CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN is enabled, since it is assumed to
 * already be done by a calll to spl_relocate_stack_gd() before board_init_r()
 * is reached.
 *
 * This function will be called from board_init_r() if not called earlier.
 *
 * If this is not called, then driver model will be inactive in SPL's
 * board_init_f(), and no device tree will be available.
 */
int spl_init(void);

#ifdef CONFIG_SPL_BOARD_INIT
void spl_board_init(void);
#endif

/**
 * spl_was_boot_source() - check if U-Boot booted from SPL
 *
 * This will normally be true, but if U-Boot jumps to second U-Boot, it will
 * be false. This should be implemented by board-specific code.
 *
 * @return true if U-Boot booted from SPL, else false
 */
bool spl_was_boot_source(void);

/**
 * spl_dfu_cmd- run dfu command with chosen mmc device interface
 * @param usb_index - usb controller number
 * @param mmc_dev -  mmc device nubmer
 *
 * @return 0 on success, otherwise error code
 */
int spl_dfu_cmd(int usbctrl, char *dfu_alt_info, char *interface, char *devstr);

int spl_mmc_load_image(struct spl_image_info *spl_image,
		       struct spl_boot_device *bootdev);

/**
 * spl_invoke_atf - boot using an ARM trusted firmware image
 */
void spl_invoke_atf(struct spl_image_info *spl_image);

/**
 * spl_optee_entry - entry function for optee
 *
 * args defind in op-tee project
 * https://github.com/OP-TEE/optee_os/
 * core/arch/arm/kernel/generic_entry_a32.S
 * @arg0: pagestore
 * @arg1: (ARMv7 standard bootarg #1)
 * @arg2: device tree address, (ARMv7 standard bootarg #2)
 * @arg3: non-secure entry address (ARMv7 bootarg #0)
 */
void spl_optee_entry(void *arg0, void *arg1, void *arg2, void *arg3);

/**
 * board_return_to_bootrom - allow for boards to continue with the boot ROM
 *
 * If a board (e.g. the Rockchip RK3368 boards) provide some
 * supporting functionality for SPL in their boot ROM and the SPL
 * stage wants to return to the ROM code to continue booting, boards
 * can implement 'board_return_to_bootrom'.
 */
void board_return_to_bootrom(void);

/**
 * board_spl_fit_post_load - allow process images after loading finished
 *
 */
void board_spl_fit_post_load(ulong load_addr, size_t length);

/**
 * board_spl_fit_size_align - specific size align before processing payload
 *
 */
ulong board_spl_fit_size_align(ulong size);

/**
 * spl_perform_fixups() - arch/board-specific callback before processing
 *                        the boot-payload
 */
void spl_perform_fixups(struct spl_image_info *spl_image);

/*
 * spl_get_load_buffer() - get buffer for loading partial image data
 *
 * Returns memory area which can be populated by partial image data,
 * ie. uImage or fitImage header.
 */
struct image_header *spl_get_load_buffer(ssize_t offset, size_t size);

#endif
Commit	Line	Data
83d290c5	1	/* SPDX-License-Identifier: GPL-2.0+ */
47f7bcae TR	2	/*
	3	* (C) Copyright 2012
	4	* Texas Instruments, <www.ti.com>
47f7bcae TR	5	*/
	6	#ifndef _SPL_H_
	7	#define _SPL_H_
	8
8bee2d25 SG	9	#include <binman_sym.h>
8bee2d25 SG	10
47f7bcae	11	/* Platform-specific defines */
6507f133	12	#include <linux/compiler.h>
47f7bcae	13	#include <asm/spl.h>
b0edea3c	14	#include <handoff.h>
47f7bcae	15
32ba8952 SG	16	/* Value in r0 indicates we booted from U-Boot */
32ba8952 SG	17	#define UBOOT_NOT_LOADED_FROM_SPL 0x13578642
773b5940	18
47f7bcae TR	19	/* Boot type */
	20	#define MMCSD_MODE_UNDEFINED 0
	21	#define MMCSD_MODE_RAW 1
205b4f33	22	#define MMCSD_MODE_FS 2
7dbe63bc	23	#define MMCSD_MODE_EMMCBOOT 3
47f7bcae	24
e945a726 SG	25	/*
	26	* u_boot_first_phase() - check if this is the first U-Boot phase
	27	*
	28	* U-Boot has up to three phases: TPL, SPL and U-Boot proper. Depending on the
	29	* build flags we can determine whether the current build is for the first
	30	* phase of U-Boot or not. If there is no SPL, then this is U-Boot proper. If
	31	* there is SPL but no TPL, the the first phase is SPL. If there is TPL, then
	32	* it is the first phase.
	33	*
	34	* @returns true if this is the first phase of U-Boot
	35	*
	36	*/
	37	static inline bool u_boot_first_phase(void)
	38	{
	39	if (IS_ENABLED(CONFIG_TPL)) {
	40	if (IS_ENABLED(CONFIG_TPL_BUILD))
	41	return true;
	42	} else if (IS_ENABLED(CONFIG_SPL)) {
	43	if (IS_ENABLED(CONFIG_SPL_BUILD))
	44	return true;
	45	} else {
	46	return true;
	47	}
	48
	49	return false;
	50	}
	51
d6330064 SG	52	/* A string name for SPL or TPL */
	53	#ifdef CONFIG_SPL_BUILD
	54	# ifdef CONFIG_TPL_BUILD
8fb2391e	55	# define SPL_TPL_NAME "TPL"
d6330064	56	# else
8fb2391e	57	# define SPL_TPL_NAME "SPL"
d6330064 SG	58	# endif
	59	# define SPL_TPL_PROMPT SPL_TPL_NAME ": "
	60	#else
	61	# define SPL_TPL_NAME ""
	62	# define SPL_TPL_PROMPT ""
	63	#endif
	64
47f7bcae TR	65	struct spl_image_info {
	66	const char *name;
	67	u8 os;
f2efe678 PT	68	uintptr_t load_addr;
f2efe678 PT	69	uintptr_t entry_point;
75014470 PT	70	#if CONFIG_IS_ENABLED(LOAD_FIT)
	71	void *fdt_addr;
	72	#endif
de5dd4c4	73	u32 boot_device;
47f7bcae	74	u32 size;
022b4975	75	u32 flags;
5bf5250e	76	void *arg;
dae5c2dc SG	77	#ifdef CONFIG_SPL_LEGACY_IMAGE_CRC_CHECK
	78	ulong dcrc_data;
	79	ulong dcrc_length;
	80	ulong dcrc;
	81	#endif
47f7bcae TR	82	};
47f7bcae TR	83
f1dcee59 SG	84	/*
	85	* Information required to load data from a device
	86	*
	87	* @dev: Pointer to the device, e.g. struct mmc *
	88	* @priv: Private data for the device
	89	* @bl_len: Block length for reading in bytes
eafd5410	90	* @filename: Name of the fit image file.
f1dcee59 SG	91	* @read: Function to call to read from the device
	92	*/
	93	struct spl_load_info {
	94	void *dev;
	95	void *priv;
	96	int bl_len;
eafd5410	97	const char *filename;
f1dcee59 SG	98	ulong (read)(struct spl_load_info load, ulong sector, ulong count,
	99	void *buf);
	100	};
	101
8bee2d25 SG	102	/*
	103	* We need to know the position of U-Boot in memory so we can jump to it. We
	104	* allow any U-Boot binary to be used (u-boot.bin, u-boot-nodtb.bin,
	105	* u-boot.img), hence the '_any'. These is no checking here that the correct
	106	* image is found. For * example if u-boot.img is used we don't check that
	107	* spl_parse_image_header() can parse a valid header.
	108	*/
dbf6be9f	109	binman_sym_extern(ulong, u_boot_any, image_pos);
8bee2d25	110
eafd5410 LV	111	/**
eafd5410 LV	112	* spl_load_simple_fit() - Loads a fit image from a device.
f4d7d859	113	* @spl_image: Image description to set up
eafd5410 LV	114	* @info: Structure containing the information required to load data.
	115	* @sector: Sector number where FIT image is located in the device
	116	* @fdt: Pointer to the copied FIT header.
	117	*
	118	* Reads the FIT image @sector in the device. Loads u-boot image to
	119	* specified load address and copies the dtb to end of u-boot image.
	120	* Returns 0 on success.
	121	*/
f4d7d859 SG	122	int spl_load_simple_fit(struct spl_image_info *spl_image,
f4d7d859 SG	123	struct spl_load_info info, ulong sector, void fdt);
f1dcee59	124
022b4975	125	#define SPL_COPY_PAYLOAD_ONLY 1
e246bfcf	126	#define SPL_FIT_FOUND 2
022b4975	127
47f7bcae TR	128	/* SPL common functions */
	129	void preloader_console_init(void);
	130	u32 spl_boot_device(void);
2b1cdafa	131	u32 spl_boot_mode(const u32 boot_device);
35a66960	132	int spl_boot_partition(const u32 boot_device);
d1fc0a31	133	void spl_set_bd(void);
d95ceb97 SG	134
	135	/**
	136	* spl_set_header_raw_uboot() - Set up a standard SPL image structure
	137	*
	138	* This sets up the given spl_image which the standard values obtained from
	139	* config options: CONFIG_SYS_MONITOR_LEN, CONFIG_SYS_UBOOT_START,
	140	* CONFIG_SYS_TEXT_BASE.
	141	*
71316c1d	142	* @spl_image: Image description to set up
d95ceb97 SG	143	*/
	144	void spl_set_header_raw_uboot(struct spl_image_info *spl_image);
	145
71316c1d SG	146	/**
	147	* spl_parse_image_header() - parse the image header and set up info
	148	*
	149	* This parses the legacy image header information at @header and sets up
	150	* @spl_image according to what is found. If no image header is found, then
	151	* a raw image or bootz is assumed. If CONFIG_SPL_PANIC_ON_RAW_IMAGE is
24eb39b5	152	* enabled, then this causes a panic. If CONFIG_SPL_RAW_IMAGE_SUPPORT is not
71316c1d SG	153	* enabled then U-Boot gives up. Otherwise U-Boot sets up the image using
	154	* spl_set_header_raw_uboot(), or possibly the bootz header.
	155	*
	156	* @spl_image: Image description to set up
	157	* @header image header to parse
	158	* @return 0 if a header was correctly parsed, -ve on error
	159	*/
	160	int spl_parse_image_header(struct spl_image_info *spl_image,
	161	const struct image_header *header);
	162
47f7bcae	163	void spl_board_prepare_for_linux(void);
3a3b9147	164	void spl_board_prepare_for_boot(void);
bf55cd4f	165	int spl_board_ubi_load_image(u32 boot_device);
ca12e65c SG	166
	167	/**
	168	* jump_to_image_linux() - Jump to a Linux kernel from SPL
	169	*
	170	* This jumps into a Linux kernel using the information in @spl_image.
	171	*
	172	* @spl_image: Image description to set up
ca12e65c	173	*/
5bf5250e	174	void __noreturn jump_to_image_linux(struct spl_image_info *spl_image);
f59961e3 SG	175
	176	/**
	177	* spl_start_uboot() - Check if SPL should start the kernel or U-Boot
	178	*
	179	* This is called by the various SPL loaders to determine whether the board
	180	* wants to load the kernel or U-Boot. This function should be provided by
	181	* the board.
	182	*
	183	* @return 0 if SPL should start the kernel, 1 if U-Boot must be started
	184	*/
47f7bcae	185	int spl_start_uboot(void);
f59961e3	186
a807ab33 SG	187	/**
	188	* spl_display_print() - Display a board-specific message in SPL
	189	*
	190	* If CONFIG_SPL_DISPLAY_PRINT is enabled, U-Boot will call this function
	191	* immediately after displaying the SPL console banner ("U-Boot SPL ...").
	192	* This function should be provided by the board.
	193	*/
47f7bcae TR	194	void spl_display_print(void);
47f7bcae TR	195
ecdfd69a SG	196	/**
	197	* struct spl_boot_device - Describes a boot device used by SPL
	198	*
	199	* @boot_device: A number indicating the BOOT_DEVICE type. There are various
	200	* BOOT_DEVICE... #defines and enums in U-Boot and they are not consistently
	201	* numbered.
	202	* @boot_device_name: Named boot device, or NULL if none.
	203	*
	204	* Note: Additional fields can be added here, bearing in mind that SPL is
	205	* size-sensitive and common fields will be present on all boards. This
	206	* struct can also be used to return additional information about the load
	207	* process if that becomes useful.
	208	*/
	209	struct spl_boot_device {
	210	uint boot_device;
	211	const char *boot_device_name;
	212	};
	213
a0a80290 SG	214	/**
	215	* Holds information about a way of loading an SPL image
	216	*
ebc4ef61	217	* @name: User-friendly name for this method (e.g. "MMC")
a0a80290 SG	218	* @boot_device: Boot device that this loader supports
	219	* @load_image: Function to call to load image
	220	*/
	221	struct spl_image_loader {
ebc4ef61 SG	222	#ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
	223	const char *name;
	224	#endif
a0a80290 SG	225	uint boot_device;
	226	/**
	227	* load_image() - Load an SPL image
	228	*
2a2ee2ac	229	* @spl_image: place to put image information
a0a80290 SG	230	* @bootdev: describes the boot device to load from
a0a80290 SG	231	*/
2a2ee2ac SG	232	int (load_image)(struct spl_image_info spl_image,
2a2ee2ac SG	233	struct spl_boot_device *bootdev);
a0a80290 SG	234	};
	235
	236	/* Declare an SPL image loader */
	237	#define SPL_LOAD_IMAGE(__name) \
	238	ll_entry_declare(struct spl_image_loader, __name, spl_image_loader)
	239
	240	/*
0d3b0591	241	* _priority is the priority of this method, 0 meaning it will be the top
a0a80290	242	* choice for this device, 9 meaning it is the bottom choice.
0d3b0591 SG	243	* _boot_device is the BOOT_DEVICE_... value
0d3b0591 SG	244	* _method is the load_image function to call
a0a80290	245	*/
ebc4ef61 SG	246	#ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
	247	#define SPL_LOAD_IMAGE_METHOD(_name, _priority, _boot_device, _method) \
	248	SPL_LOAD_IMAGE(_method ## _priority ## _boot_device) = { \
	249	.name = _name, \
	250	.boot_device = _boot_device, \
	251	.load_image = _method, \
	252	}
	253	#else
	254	#define SPL_LOAD_IMAGE_METHOD(_name, _priority, _boot_device, _method) \
0d3b0591 SG	255	SPL_LOAD_IMAGE(_method ## _priority ## _boot_device) = { \
	256	.boot_device = _boot_device, \
	257	.load_image = _method, \
a0a80290	258	}
ebc4ef61	259	#endif
a0a80290	260
773b5940	261	/* SPL FAT image functions */
710e9ca5 SG	262	int spl_load_image_fat(struct spl_image_info *spl_image,
710e9ca5 SG	263	struct blk_desc *block_dev, int partition,
4101f687	264	const char *filename);
710e9ca5 SG	265	int spl_load_image_fat_os(struct spl_image_info *spl_image,
710e9ca5 SG	266	struct blk_desc *block_dev, int partition);
773b5940	267
ce048224 JH	268	void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image);
ce048224 JH	269
592f9222	270	/* SPL EXT image functions */
b4a6c2aa SG	271	int spl_load_image_ext(struct spl_image_info *spl_image,
b4a6c2aa SG	272	struct blk_desc *block_dev, int partition,
4101f687	273	const char *filename);
b4a6c2aa SG	274	int spl_load_image_ext_os(struct spl_image_info *spl_image,
b4a6c2aa SG	275	struct blk_desc *block_dev, int partition);
592f9222	276
070d00b8	277	/**
340f418a	278	* spl_early_init() - Set up device tree and driver model in SPL if enabled
070d00b8 SG	279	*
070d00b8 SG	280	* Call this function in board_init_f() if you want to use device tree and
340f418a EC	281	* driver model early, before board_init_r() is called.
	282	*
	283	* If this is not called, then driver model will be inactive in SPL's
	284	* board_init_f(), and no device tree will be available.
	285	*/
	286	int spl_early_init(void);
	287
	288	/**
	289	* spl_init() - Set up device tree and driver model in SPL if enabled
	290	*
	291	* You can optionally call spl_early_init(), then optionally call spl_init().
	292	* This function will be called from board_init_r() if not called earlier.
	293	*
	294	* Both spl_early_init() and spl_init() perform a similar function except that
	295	* the latter will not set up the malloc() area if
	296	* CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN is enabled, since it is assumed to
	297	* already be done by a calll to spl_relocate_stack_gd() before board_init_r()
	298	* is reached.
	299	*
	300	* This function will be called from board_init_r() if not called earlier.
070d00b8 SG	301	*
	302	* If this is not called, then driver model will be inactive in SPL's
	303	* board_init_f(), and no device tree will be available.
	304	*/
	305	int spl_init(void);
	306
47f7bcae TR	307	#ifdef CONFIG_SPL_BOARD_INIT
	308	void spl_board_init(void);
	309	#endif
32ba8952 SG	310
	311	/**
	312	* spl_was_boot_source() - check if U-Boot booted from SPL
	313	*
	314	* This will normally be true, but if U-Boot jumps to second U-Boot, it will
	315	* be false. This should be implemented by board-specific code.
	316	*
	317	* @return true if U-Boot booted from SPL, else false
	318	*/
	319	bool spl_was_boot_source(void);
	320
52f2acc5 R	321	/**
	322	* spl_dfu_cmd- run dfu command with chosen mmc device interface
	323	* @param usb_index - usb controller number
	324	* @param mmc_dev - mmc device nubmer
	325	*
	326	* @return 0 on success, otherwise error code
	327	*/
	328	int spl_dfu_cmd(int usbctrl, char dfu_alt_info, char interface, char *devstr);
e50d76cc	329
09410c65 MV	330	int spl_mmc_load_image(struct spl_image_info *spl_image,
	331	struct spl_boot_device *bootdev);
	332
f2efe678 PT	333	/**
	334	* spl_invoke_atf - boot using an ARM trusted firmware image
	335	*/
	336	void spl_invoke_atf(struct spl_image_info *spl_image);
225d30b7	337
70fe2876 KY	338	/**
	339	* spl_optee_entry - entry function for optee
	340	*
	341	* args defind in op-tee project
	342	* https://github.com/OP-TEE/optee_os/
	343	* core/arch/arm/kernel/generic_entry_a32.S
	344	* @arg0: pagestore
	345	* @arg1: (ARMv7 standard bootarg #1)
	346	* @arg2: device tree address, (ARMv7 standard bootarg #2)
	347	* @arg3: non-secure entry address (ARMv7 bootarg #0)
	348	*/
	349	void spl_optee_entry(void arg0, void arg1, void arg2, void arg3);
	350
225d30b7 PT	351	/**
	352	* board_return_to_bootrom - allow for boards to continue with the boot ROM
	353	*
	354	* If a board (e.g. the Rockchip RK3368 boards) provide some
	355	* supporting functionality for SPL in their boot ROM and the SPL
	356	* stage wants to return to the ROM code to continue booting, boards
	357	* can implement 'board_return_to_bootrom'.
	358	*/
	359	void board_return_to_bootrom(void);
de5dd4c4	360
28ded1f3 PF	361	/**
	362	* board_spl_fit_post_load - allow process images after loading finished
	363	*
	364	*/
	365	void board_spl_fit_post_load(ulong load_addr, size_t length);
	366
	367	/**
	368	* board_spl_fit_size_align - specific size align before processing payload
	369	*
	370	*/
	371	ulong board_spl_fit_size_align(ulong size);
	372
de5dd4c4 PT	373	/**
	374	* spl_perform_fixups() - arch/board-specific callback before processing
	375	* the boot-payload
	376	*/
	377	void spl_perform_fixups(struct spl_image_info *spl_image);
04ce5427 MV	378
	379	/*
	380	* spl_get_load_buffer() - get buffer for loading partial image data
	381	*
	382	* Returns memory area which can be populated by partial image data,
	383	* ie. uImage or fitImage header.
	384	*/
	385	struct image_header *spl_get_load_buffer(ssize_t offset, size_t size);
	386
47f7bcae	387	#endif