1 /* SPDX-License-Identifier: GPL-2.0+ */
4 * Texas Instruments, <www.ti.com>
9 #include <binman_sym.h>
11 /* Platform-specific defines */
12 #include <linux/compiler.h>
16 /* Value in r0 indicates we booted from U-Boot */
17 #define UBOOT_NOT_LOADED_FROM_SPL 0x13578642
20 #define MMCSD_MODE_UNDEFINED 0
21 #define MMCSD_MODE_RAW 1
22 #define MMCSD_MODE_FS 2
23 #define MMCSD_MODE_EMMCBOOT 3
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
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.
34 * @returns true if this is the first phase of U-Boot
37 static inline bool u_boot_first_phase(void)
39 if (IS_ENABLED(CONFIG_TPL)) {
40 if (IS_ENABLED(CONFIG_TPL_BUILD))
42 } else if (IS_ENABLED(CONFIG_SPL)) {
43 if (IS_ENABLED(CONFIG_SPL_BUILD))
52 /* A string name for SPL or TPL */
53 #ifdef CONFIG_SPL_BUILD
54 # ifdef CONFIG_TPL_BUILD
55 # define SPL_TPL_NAME "TPL"
57 # define SPL_TPL_NAME "SPL"
59 # define SPL_TPL_PROMPT SPL_TPL_NAME ": "
61 # define SPL_TPL_NAME ""
62 # define SPL_TPL_PROMPT ""
65 struct spl_image_info {
69 uintptr_t entry_point;
70 #if CONFIG_IS_ENABLED(LOAD_FIT) || CONFIG_IS_ENABLED(LOAD_FIT_FULL)
77 #ifdef CONFIG_SPL_LEGACY_IMAGE_CRC_CHECK
85 * Information required to load data from a device
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
90 * @filename: Name of the fit image file.
91 * @read: Function to call to read from the device
93 struct spl_load_info {
98 ulong (*read)(struct spl_load_info *load, ulong sector, ulong count,
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.
109 binman_sym_extern(ulong, u_boot_any, image_pos);
112 * spl_load_simple_fit_skip_processing() - Hook to allow skipping the FIT
113 * image processing during spl_load_simple_fit().
115 * Return true to skip FIT processing, false to preserve the full code flow
116 * of spl_load_simple_fit().
118 bool spl_load_simple_fit_skip_processing(void);
121 * spl_load_simple_fit() - Loads a fit image from a device.
122 * @spl_image: Image description to set up
123 * @info: Structure containing the information required to load data.
124 * @sector: Sector number where FIT image is located in the device
125 * @fdt: Pointer to the copied FIT header.
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.
129 * Returns 0 on success.
131 int spl_load_simple_fit(struct spl_image_info *spl_image,
132 struct spl_load_info *info, ulong sector, void *fdt);
134 #define SPL_COPY_PAYLOAD_ONLY 1
135 #define SPL_FIT_FOUND 2
138 * spl_load_imx_container() - Loads a imx container image from a device.
139 * @spl_image: Image description to set up
140 * @info: Structure containing the information required to load data.
141 * @sector: Sector number where container image is located in the device
143 * Reads the container image @sector in the device. Loads u-boot image to
144 * specified load address.
146 int spl_load_imx_container(struct spl_image_info *spl_image,
147 struct spl_load_info *info, ulong sector);
149 /* SPL common functions */
150 void preloader_console_init(void);
151 u32 spl_boot_device(void);
152 u32 spl_boot_mode(const u32 boot_device);
153 int spl_boot_partition(const u32 boot_device);
154 void spl_set_bd(void);
157 * spl_set_header_raw_uboot() - Set up a standard SPL image structure
159 * This sets up the given spl_image which the standard values obtained from
160 * config options: CONFIG_SYS_MONITOR_LEN, CONFIG_SYS_UBOOT_START,
161 * CONFIG_SYS_TEXT_BASE.
163 * @spl_image: Image description to set up
165 void spl_set_header_raw_uboot(struct spl_image_info *spl_image);
168 * spl_parse_image_header() - parse the image header and set up info
170 * This parses the legacy image header information at @header and sets up
171 * @spl_image according to what is found. If no image header is found, then
172 * a raw image or bootz is assumed. If CONFIG_SPL_PANIC_ON_RAW_IMAGE is
173 * enabled, then this causes a panic. If CONFIG_SPL_RAW_IMAGE_SUPPORT is not
174 * enabled then U-Boot gives up. Otherwise U-Boot sets up the image using
175 * spl_set_header_raw_uboot(), or possibly the bootz header.
177 * @spl_image: Image description to set up
178 * @header image header to parse
179 * @return 0 if a header was correctly parsed, -ve on error
181 int spl_parse_image_header(struct spl_image_info *spl_image,
182 const struct image_header *header);
184 void spl_board_prepare_for_linux(void);
185 void spl_board_prepare_for_boot(void);
186 int spl_board_ubi_load_image(u32 boot_device);
189 * jump_to_image_linux() - Jump to a Linux kernel from SPL
191 * This jumps into a Linux kernel using the information in @spl_image.
193 * @spl_image: Image description to set up
195 void __noreturn jump_to_image_linux(struct spl_image_info *spl_image);
198 * spl_start_uboot() - Check if SPL should start the kernel or U-Boot
200 * This is called by the various SPL loaders to determine whether the board
201 * wants to load the kernel or U-Boot. This function should be provided by
204 * @return 0 if SPL should start the kernel, 1 if U-Boot must be started
206 int spl_start_uboot(void);
209 * spl_display_print() - Display a board-specific message in SPL
211 * If CONFIG_SPL_DISPLAY_PRINT is enabled, U-Boot will call this function
212 * immediately after displaying the SPL console banner ("U-Boot SPL ...").
213 * This function should be provided by the board.
215 void spl_display_print(void);
218 * struct spl_boot_device - Describes a boot device used by SPL
220 * @boot_device: A number indicating the BOOT_DEVICE type. There are various
221 * BOOT_DEVICE... #defines and enums in U-Boot and they are not consistently
223 * @boot_device_name: Named boot device, or NULL if none.
225 * Note: Additional fields can be added here, bearing in mind that SPL is
226 * size-sensitive and common fields will be present on all boards. This
227 * struct can also be used to return additional information about the load
228 * process if that becomes useful.
230 struct spl_boot_device {
232 const char *boot_device_name;
236 * Holds information about a way of loading an SPL image
238 * @name: User-friendly name for this method (e.g. "MMC")
239 * @boot_device: Boot device that this loader supports
240 * @load_image: Function to call to load image
242 struct spl_image_loader {
243 #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
248 * load_image() - Load an SPL image
250 * @spl_image: place to put image information
251 * @bootdev: describes the boot device to load from
253 int (*load_image)(struct spl_image_info *spl_image,
254 struct spl_boot_device *bootdev);
257 /* Declare an SPL image loader */
258 #define SPL_LOAD_IMAGE(__name) \
259 ll_entry_declare(struct spl_image_loader, __name, spl_image_loader)
262 * _priority is the priority of this method, 0 meaning it will be the top
263 * choice for this device, 9 meaning it is the bottom choice.
264 * _boot_device is the BOOT_DEVICE_... value
265 * _method is the load_image function to call
267 #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
268 #define SPL_LOAD_IMAGE_METHOD(_name, _priority, _boot_device, _method) \
269 SPL_LOAD_IMAGE(_method ## _priority ## _boot_device) = { \
271 .boot_device = _boot_device, \
272 .load_image = _method, \
275 #define SPL_LOAD_IMAGE_METHOD(_name, _priority, _boot_device, _method) \
276 SPL_LOAD_IMAGE(_method ## _priority ## _boot_device) = { \
277 .boot_device = _boot_device, \
278 .load_image = _method, \
282 /* SPL FAT image functions */
283 int spl_load_image_fat(struct spl_image_info *spl_image,
284 struct blk_desc *block_dev, int partition,
285 const char *filename);
286 int spl_load_image_fat_os(struct spl_image_info *spl_image,
287 struct blk_desc *block_dev, int partition);
289 void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image);
291 /* SPL EXT image functions */
292 int spl_load_image_ext(struct spl_image_info *spl_image,
293 struct blk_desc *block_dev, int partition,
294 const char *filename);
295 int spl_load_image_ext_os(struct spl_image_info *spl_image,
296 struct blk_desc *block_dev, int partition);
299 * spl_early_init() - Set up device tree and driver model in SPL if enabled
301 * Call this function in board_init_f() if you want to use device tree and
302 * driver model early, before board_init_r() is called.
304 * If this is not called, then driver model will be inactive in SPL's
305 * board_init_f(), and no device tree will be available.
307 int spl_early_init(void);
310 * spl_init() - Set up device tree and driver model in SPL if enabled
312 * You can optionally call spl_early_init(), then optionally call spl_init().
313 * This function will be called from board_init_r() if not called earlier.
315 * Both spl_early_init() and spl_init() perform a similar function except that
316 * the latter will not set up the malloc() area if
317 * CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN is enabled, since it is assumed to
318 * already be done by a calll to spl_relocate_stack_gd() before board_init_r()
321 * This function will be called from board_init_r() if not called earlier.
323 * If this is not called, then driver model will be inactive in SPL's
324 * board_init_f(), and no device tree will be available.
328 #ifdef CONFIG_SPL_BOARD_INIT
329 void spl_board_init(void);
333 * spl_was_boot_source() - check if U-Boot booted from SPL
335 * This will normally be true, but if U-Boot jumps to second U-Boot, it will
336 * be false. This should be implemented by board-specific code.
338 * @return true if U-Boot booted from SPL, else false
340 bool spl_was_boot_source(void);
343 * spl_dfu_cmd- run dfu command with chosen mmc device interface
344 * @param usb_index - usb controller number
345 * @param mmc_dev - mmc device nubmer
347 * @return 0 on success, otherwise error code
349 int spl_dfu_cmd(int usbctrl, char *dfu_alt_info, char *interface, char *devstr);
351 int spl_mmc_load_image(struct spl_image_info *spl_image,
352 struct spl_boot_device *bootdev);
355 * spl_mmc_load() - Load an image file from MMC/SD media
357 * @param spl_image Image data filled in by loading process
358 * @param bootdev Describes which device to load from
359 * @param filename Name of file to load (in FS mode)
360 * @param raw_part Partition to load from (in RAW mode)
361 * @param raw_sect Sector to load from (in RAW mode)
363 * @return 0 on success, otherwise error code
365 int spl_mmc_load(struct spl_image_info *spl_image,
366 struct spl_boot_device *bootdev,
367 const char *filename,
369 unsigned long raw_sect);
372 * spl_invoke_atf - boot using an ARM trusted firmware image
374 void spl_invoke_atf(struct spl_image_info *spl_image);
377 * spl_optee_entry - entry function for optee
379 * args defind in op-tee project
380 * https://github.com/OP-TEE/optee_os/
381 * core/arch/arm/kernel/generic_entry_a32.S
383 * @arg1: (ARMv7 standard bootarg #1)
384 * @arg2: device tree address, (ARMv7 standard bootarg #2)
385 * @arg3: non-secure entry address (ARMv7 bootarg #0)
387 void spl_optee_entry(void *arg0, void *arg1, void *arg2, void *arg3);
390 * spl_invoke_opensbi - boot using a RISC-V OpenSBI image
392 void spl_invoke_opensbi(struct spl_image_info *spl_image);
395 * board_return_to_bootrom - allow for boards to continue with the boot ROM
397 * If a board (e.g. the Rockchip RK3368 boards) provide some
398 * supporting functionality for SPL in their boot ROM and the SPL
399 * stage wants to return to the ROM code to continue booting, boards
400 * can implement 'board_return_to_bootrom'.
402 int board_return_to_bootrom(struct spl_image_info *spl_image,
403 struct spl_boot_device *bootdev);
406 * board_spl_fit_post_load - allow process images after loading finished
409 void board_spl_fit_post_load(ulong load_addr, size_t length);
412 * board_spl_fit_size_align - specific size align before processing payload
415 ulong board_spl_fit_size_align(ulong size);
418 * spl_perform_fixups() - arch/board-specific callback before processing
421 void spl_perform_fixups(struct spl_image_info *spl_image);
424 * spl_get_load_buffer() - get buffer for loading partial image data
426 * Returns memory area which can be populated by partial image data,
427 * ie. uImage or fitImage header.
429 struct image_header *spl_get_load_buffer(ssize_t offset, size_t size);