u-boot/include/spl.h

1 /* SPDX-License-Identifier: GPL-2.0+ */
11 /* Platform-specific defines */
16 /* Value in r0 indicates we booted from U-Boot */
19 /* Boot type */
26  * u_boot_first_phase() - check if this is the first U-Boot phase
28  * U-Boot has up to three phases: TPL, SPL and U-Boot proper. Depending on the
30  * phase of U-Boot or not. If there is no SPL, then this is U-Boot proper. If
34  * @returns true if this is the first phase of U-Boot
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
112  * spl_load_simple_fit_skip_processing() - Hook to allow skipping the FIT
121  * spl_load_simple_fit() - Loads a fit image from a device.
122  * @spl_image:	Image description to set up
127  * Reads the FIT image @sector in the device. Loads u-boot image to
128  * specified load address and copies the dtb to end of u-boot image.
145  * spl_set_header_raw_uboot() - Set up a standard SPL image structure
147  * This sets up the given spl_image which the standard values obtained from
151  * @spl_image: Image description to set up
156  * spl_parse_image_header() - parse the image header and set up info
158  * This parses the legacy image header information at @header and sets up
162  * enabled then U-Boot gives up. Otherwise U-Boot sets up the image using
165  * @spl_image: Image description to set up
167  * @return 0 if a header was correctly parsed, -ve on error
177  * jump_to_image_linux() - Jump to a Linux kernel from SPL
181  * @spl_image: Image description to set up
186  * spl_start_uboot() - Check if SPL should start the kernel or U-Boot
189  * wants to load the kernel or U-Boot. This function should be provided by
192  * @return 0 if SPL should start the kernel, 1 if U-Boot must be started
197  * spl_display_print() - Display a board-specific message in SPL
199  * If CONFIG_SPL_DISPLAY_PRINT is enabled, U-Boot will call this function
200  * immediately after displaying the SPL console banner ("U-Boot SPL ...").
206  * struct spl_boot_device - Describes a boot device used by SPL
209  * BOOT_DEVICE... #defines and enums in U-Boot and they are not consistently
211  * @boot_device_name: Named boot device, or NULL if none.
214  * size-sensitive and common fields will be present on all boards. This
226  * @name: User-friendly name for this method (e.g. "MMC")
227  * @boot_device: Boot device that this loader supports
236 	 * load_image() - Load an SPL image
239 	 * @bootdev: describes the boot device to load from
287  * spl_early_init() - Set up device tree and driver model in SPL if enabled
298  * spl_init() - Set up device tree and driver model in SPL if enabled
304  * the latter will not set up the malloc() area if
321  * spl_was_boot_source() - check if U-Boot booted from SPL
323  * This will normally be true, but if U-Boot jumps to second U-Boot, it will
324  * be false. This should be implemented by board-specific code.
326  * @return true if U-Boot booted from SPL, else false
331  * spl_dfu_cmd- run dfu command with chosen mmc device interface
332  * @param usb_index - usb controller number
333  * @param mmc_dev -  mmc device nubmer
343  * spl_mmc_load() - Load an image file from MMC/SD media
360  * spl_invoke_atf - boot using an ARM trusted firmware image
365  * spl_optee_entry - entry function for optee
367  * args defind in op-tee project
368  * https://github.com/OP-TEE/optee_os/
373  * @arg3: non-secure entry address (ARMv7 bootarg #0)
378  * board_return_to_bootrom - allow for boards to continue with the boot ROM
381  * supporting functionality for SPL in their boot ROM and the SPL
388  * board_spl_fit_post_load - allow process images after loading finished
394  * board_spl_fit_size_align - specific size align before processing payload
400  * spl_perform_fixups() - arch/board-specific callback before processing
401  *                        the boot-payload
406  * spl_get_load_buffer() - get buffer for loading partial image data