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>
13 #include <asm/global_data.h>
20 /* Value in r0 indicates we booted from U-Boot */
21 #define UBOOT_NOT_LOADED_FROM_SPL 0x13578642
24 #define MMCSD_MODE_UNDEFINED 0
25 #define MMCSD_MODE_RAW 1
26 #define MMCSD_MODE_FS 2
27 #define MMCSD_MODE_EMMCBOOT 3
30 * u_boot_first_phase() - check if this is the first U-Boot phase
32 * U-Boot has up to three phases: TPL, SPL and U-Boot proper. Depending on the
33 * build flags we can determine whether the current build is for the first
34 * phase of U-Boot or not. If there is no SPL, then this is U-Boot proper. If
35 * there is SPL but no TPL, the the first phase is SPL. If there is TPL, then
36 * it is the first phase.
38 * @returns true if this is the first phase of U-Boot
41 static inline bool u_boot_first_phase(void)
43 if (IS_ENABLED(CONFIG_TPL)) {
44 if (IS_ENABLED(CONFIG_TPL_BUILD))
46 } else if (IS_ENABLED(CONFIG_SPL)) {
47 if (IS_ENABLED(CONFIG_SPL_BUILD))
57 PHASE_TPL, /* Running in TPL */
58 PHASE_SPL, /* Running in SPL */
59 PHASE_BOARD_F, /* Running in U-Boot before relocation */
60 PHASE_BOARD_R, /* Running in U-Boot after relocation */
64 * spl_phase() - Find out the phase of U-Boot
66 * This can be used to avoid #ifdef logic and use if() instead.
68 * For example, to include code only in TPL, you might do:
70 * #ifdef CONFIG_TPL_BUILD
74 * but with this you can use:
76 * if (spl_phase() == PHASE_TPL) {
80 * To include code only in SPL, you might do:
82 * #if defined(CONFIG_SPL_BUILD) && !defined(CONFIG_TPL_BUILD)
86 * but with this you can use:
88 * if (spl_phase() == PHASE_SPL) {
92 * To include code only in U-Boot proper, you might do:
94 * #ifndef CONFIG_SPL_BUILD
98 * but with this you can use:
100 * if (spl_phase() == PHASE_BOARD_F) {
104 * @return U-Boot phase
106 static inline enum u_boot_phase spl_phase(void)
108 #ifdef CONFIG_TPL_BUILD
110 #elif CONFIG_SPL_BUILD
113 DECLARE_GLOBAL_DATA_PTR;
115 if (!(gd->flags & GD_FLG_RELOC))
116 return PHASE_BOARD_F;
118 return PHASE_BOARD_R;
122 /* A string name for SPL or TPL */
123 #ifdef CONFIG_SPL_BUILD
124 # ifdef CONFIG_TPL_BUILD
125 # define SPL_TPL_NAME "TPL"
127 # define SPL_TPL_NAME "SPL"
129 # define SPL_TPL_PROMPT SPL_TPL_NAME ": "
131 # define SPL_TPL_NAME ""
132 # define SPL_TPL_PROMPT ""
135 struct spl_image_info {
139 uintptr_t entry_point;
140 #if CONFIG_IS_ENABLED(LOAD_FIT) || CONFIG_IS_ENABLED(LOAD_FIT_FULL)
147 #ifdef CONFIG_SPL_LEGACY_IMAGE_CRC_CHECK
155 * Information required to load data from a device
157 * @dev: Pointer to the device, e.g. struct mmc *
158 * @priv: Private data for the device
159 * @bl_len: Block length for reading in bytes
160 * @filename: Name of the fit image file.
161 * @read: Function to call to read from the device
163 struct spl_load_info {
167 const char *filename;
168 ulong (*read)(struct spl_load_info *load, ulong sector, ulong count,
173 * We need to know the position of U-Boot in memory so we can jump to it. We
174 * allow any U-Boot binary to be used (u-boot.bin, u-boot-nodtb.bin,
175 * u-boot.img), hence the '_any'. These is no checking here that the correct
176 * image is found. For example if u-boot.img is used we don't check that
177 * spl_parse_image_header() can parse a valid header.
179 * Similarly for SPL, so that TPL can jump to SPL.
181 binman_sym_extern(ulong, u_boot_any, image_pos);
182 binman_sym_extern(ulong, u_boot_any, size);
183 binman_sym_extern(ulong, spl, image_pos);
184 binman_sym_extern(ulong, spl, size);
187 * spl_get_image_pos() - get the image position of the next phase
189 * This returns the image position to use to load the next phase of U-Boot
191 ulong spl_get_image_pos(void);
194 * spl_get_image_size() - get the size of the next phase
196 * This returns the size to use to load the next phase of U-Boot
198 ulong spl_get_image_size(void);
201 * spl_load_simple_fit_skip_processing() - Hook to allow skipping the FIT
202 * image processing during spl_load_simple_fit().
204 * Return true to skip FIT processing, false to preserve the full code flow
205 * of spl_load_simple_fit().
207 bool spl_load_simple_fit_skip_processing(void);
210 * spl_load_simple_fit() - Loads a fit image from a device.
211 * @spl_image: Image description to set up
212 * @info: Structure containing the information required to load data.
213 * @sector: Sector number where FIT image is located in the device
214 * @fdt: Pointer to the copied FIT header.
216 * Reads the FIT image @sector in the device. Loads u-boot image to
217 * specified load address and copies the dtb to end of u-boot image.
218 * Returns 0 on success.
220 int spl_load_simple_fit(struct spl_image_info *spl_image,
221 struct spl_load_info *info, ulong sector, void *fdt);
223 #define SPL_COPY_PAYLOAD_ONLY 1
224 #define SPL_FIT_FOUND 2
227 * spl_load_imx_container() - Loads a imx container image from a device.
228 * @spl_image: Image description to set up
229 * @info: Structure containing the information required to load data.
230 * @sector: Sector number where container image is located in the device
232 * Reads the container image @sector in the device. Loads u-boot image to
233 * specified load address.
235 int spl_load_imx_container(struct spl_image_info *spl_image,
236 struct spl_load_info *info, ulong sector);
238 /* SPL common functions */
239 void preloader_console_init(void);
240 u32 spl_boot_device(void);
243 * spl_mmc_boot_mode() - Lookup function for the mode of an MMC boot source.
244 * @boot_device: ID of the device which the MMC driver wants to read
245 * from. Common values are e.g. BOOT_DEVICE_MMC1,
246 * BOOT_DEVICE_MMC2, BOOT_DEVICE_MMC2_2.
248 * This function should return one of MMCSD_MODE_FS, MMCSD_MODE_EMMCBOOT, or
249 * MMCSD_MODE_RAW for each MMC boot source which is defined for the target. The
250 * boot_device parameter tells which device the MMC driver is interested in.
252 * If not overridden, it is weakly defined in common/spl/spl_mmc.c.
254 * Note: It is important to use the boot_device parameter instead of e.g.
255 * spl_boot_device() as U-Boot is not always loaded from the same device as SPL.
257 u32 spl_mmc_boot_mode(const u32 boot_device);
258 int spl_boot_partition(const u32 boot_device);
259 void spl_set_bd(void);
262 * spl_set_header_raw_uboot() - Set up a standard SPL image structure
264 * This sets up the given spl_image which the standard values obtained from
265 * config options: CONFIG_SYS_MONITOR_LEN, CONFIG_SYS_UBOOT_START,
266 * CONFIG_SYS_TEXT_BASE.
268 * @spl_image: Image description to set up
270 void spl_set_header_raw_uboot(struct spl_image_info *spl_image);
273 * spl_parse_image_header() - parse the image header and set up info
275 * This parses the legacy image header information at @header and sets up
276 * @spl_image according to what is found. If no image header is found, then
277 * a raw image or bootz is assumed. If CONFIG_SPL_PANIC_ON_RAW_IMAGE is
278 * enabled, then this causes a panic. If CONFIG_SPL_RAW_IMAGE_SUPPORT is not
279 * enabled then U-Boot gives up. Otherwise U-Boot sets up the image using
280 * spl_set_header_raw_uboot(), or possibly the bootz header.
282 * @spl_image: Image description to set up
283 * @header image header to parse
284 * @return 0 if a header was correctly parsed, -ve on error
286 int spl_parse_image_header(struct spl_image_info *spl_image,
287 const struct image_header *header);
289 void spl_board_prepare_for_linux(void);
290 void spl_board_prepare_for_boot(void);
291 int spl_board_ubi_load_image(u32 boot_device);
292 int spl_board_boot_device(u32 boot_device);
295 * jump_to_image_linux() - Jump to a Linux kernel from SPL
297 * This jumps into a Linux kernel using the information in @spl_image.
299 * @spl_image: Image description to set up
301 void __noreturn jump_to_image_linux(struct spl_image_info *spl_image);
304 * spl_start_uboot() - Check if SPL should start the kernel or U-Boot
306 * This is called by the various SPL loaders to determine whether the board
307 * wants to load the kernel or U-Boot. This function should be provided by
310 * @return 0 if SPL should start the kernel, 1 if U-Boot must be started
312 int spl_start_uboot(void);
315 * spl_display_print() - Display a board-specific message in SPL
317 * If CONFIG_SPL_DISPLAY_PRINT is enabled, U-Boot will call this function
318 * immediately after displaying the SPL console banner ("U-Boot SPL ...").
319 * This function should be provided by the board.
321 void spl_display_print(void);
324 * struct spl_boot_device - Describes a boot device used by SPL
326 * @boot_device: A number indicating the BOOT_DEVICE type. There are various
327 * BOOT_DEVICE... #defines and enums in U-Boot and they are not consistently
329 * @boot_device_name: Named boot device, or NULL if none.
331 * Note: Additional fields can be added here, bearing in mind that SPL is
332 * size-sensitive and common fields will be present on all boards. This
333 * struct can also be used to return additional information about the load
334 * process if that becomes useful.
336 struct spl_boot_device {
338 const char *boot_device_name;
342 * Holds information about a way of loading an SPL image
344 * @name: User-friendly name for this method (e.g. "MMC")
345 * @boot_device: Boot device that this loader supports
346 * @load_image: Function to call to load image
348 struct spl_image_loader {
349 #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
354 * load_image() - Load an SPL image
356 * @spl_image: place to put image information
357 * @bootdev: describes the boot device to load from
359 int (*load_image)(struct spl_image_info *spl_image,
360 struct spl_boot_device *bootdev);
363 /* Declare an SPL image loader */
364 #define SPL_LOAD_IMAGE(__name) \
365 ll_entry_declare(struct spl_image_loader, __name, spl_image_loader)
368 * _priority is the priority of this method, 0 meaning it will be the top
369 * choice for this device, 9 meaning it is the bottom choice.
370 * _boot_device is the BOOT_DEVICE_... value
371 * _method is the load_image function to call
373 #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
374 #define SPL_LOAD_IMAGE_METHOD(_name, _priority, _boot_device, _method) \
375 SPL_LOAD_IMAGE(_boot_device ## _priority ## _method) = { \
377 .boot_device = _boot_device, \
378 .load_image = _method, \
381 #define SPL_LOAD_IMAGE_METHOD(_name, _priority, _boot_device, _method) \
382 SPL_LOAD_IMAGE(_boot_device ## _priority ## _method) = { \
383 .boot_device = _boot_device, \
384 .load_image = _method, \
388 /* SPL FAT image functions */
389 int spl_load_image_fat(struct spl_image_info *spl_image,
390 struct blk_desc *block_dev, int partition,
391 const char *filename);
392 int spl_load_image_fat_os(struct spl_image_info *spl_image,
393 struct blk_desc *block_dev, int partition);
395 void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image);
397 /* SPL EXT image functions */
398 int spl_load_image_ext(struct spl_image_info *spl_image,
399 struct blk_desc *block_dev, int partition,
400 const char *filename);
401 int spl_load_image_ext_os(struct spl_image_info *spl_image,
402 struct blk_desc *block_dev, int partition);
405 * spl_early_init() - Set up device tree and driver model in SPL if enabled
407 * Call this function in board_init_f() if you want to use device tree and
408 * driver model early, before board_init_r() is called.
410 * If this is not called, then driver model will be inactive in SPL's
411 * board_init_f(), and no device tree will be available.
413 int spl_early_init(void);
416 * spl_init() - Set up device tree and driver model in SPL if enabled
418 * You can optionally call spl_early_init(), then optionally call spl_init().
419 * This function will be called from board_init_r() if not called earlier.
421 * Both spl_early_init() and spl_init() perform a similar function except that
422 * the latter will not set up the malloc() area if
423 * CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN is enabled, since it is assumed to
424 * already be done by a calll to spl_relocate_stack_gd() before board_init_r()
427 * This function will be called from board_init_r() if not called earlier.
429 * If this is not called, then driver model will be inactive in SPL's
430 * board_init_f(), and no device tree will be available.
434 #ifdef CONFIG_SPL_BOARD_INIT
435 void spl_board_init(void);
439 * spl_was_boot_source() - check if U-Boot booted from SPL
441 * This will normally be true, but if U-Boot jumps to second U-Boot, it will
442 * be false. This should be implemented by board-specific code.
444 * @return true if U-Boot booted from SPL, else false
446 bool spl_was_boot_source(void);
449 * spl_dfu_cmd- run dfu command with chosen mmc device interface
450 * @param usb_index - usb controller number
451 * @param mmc_dev - mmc device nubmer
453 * @return 0 on success, otherwise error code
455 int spl_dfu_cmd(int usbctrl, char *dfu_alt_info, char *interface, char *devstr);
457 int spl_mmc_load_image(struct spl_image_info *spl_image,
458 struct spl_boot_device *bootdev);
461 * spl_mmc_load() - Load an image file from MMC/SD media
463 * @param spl_image Image data filled in by loading process
464 * @param bootdev Describes which device to load from
465 * @param filename Name of file to load (in FS mode)
466 * @param raw_part Partition to load from (in RAW mode)
467 * @param raw_sect Sector to load from (in RAW mode)
469 * @return 0 on success, otherwise error code
471 int spl_mmc_load(struct spl_image_info *spl_image,
472 struct spl_boot_device *bootdev,
473 const char *filename,
475 unsigned long raw_sect);
477 int spl_ymodem_load_image(struct spl_image_info *spl_image,
478 struct spl_boot_device *bootdev);
481 * spl_invoke_atf - boot using an ARM trusted firmware image
483 void spl_invoke_atf(struct spl_image_info *spl_image);
486 * bl2_plat_get_bl31_params() - prepare params for bl31.
487 * @bl32_entry address of BL32 executable (secure)
488 * @bl33_entry address of BL33 executable (non secure)
489 * @fdt_addr address of Flat Device Tree
491 * This function assigns a pointer to the memory that the platform has kept
492 * aside to pass platform specific and trusted firmware related information
493 * to BL31. This memory is allocated by allocating memory to
494 * bl2_to_bl31_params_mem structure which is a superset of all the
495 * structure whose information is passed to BL31
496 * NOTE: This function should be called only once and should be done
497 * before generating params to BL31
499 * @return bl31 params structure pointer
501 struct bl31_params *bl2_plat_get_bl31_params(uintptr_t bl32_entry,
502 uintptr_t bl33_entry,
506 * spl_optee_entry - entry function for optee
508 * args defind in op-tee project
509 * https://github.com/OP-TEE/optee_os/
510 * core/arch/arm/kernel/generic_entry_a32.S
512 * @arg1: (ARMv7 standard bootarg #1)
513 * @arg2: device tree address, (ARMv7 standard bootarg #2)
514 * @arg3: non-secure entry address (ARMv7 bootarg #0)
516 void spl_optee_entry(void *arg0, void *arg1, void *arg2, void *arg3);
519 * spl_invoke_opensbi - boot using a RISC-V OpenSBI image
521 void spl_invoke_opensbi(struct spl_image_info *spl_image);
524 * board_return_to_bootrom - allow for boards to continue with the boot ROM
526 * If a board (e.g. the Rockchip RK3368 boards) provide some
527 * supporting functionality for SPL in their boot ROM and the SPL
528 * stage wants to return to the ROM code to continue booting, boards
529 * can implement 'board_return_to_bootrom'.
531 int board_return_to_bootrom(struct spl_image_info *spl_image,
532 struct spl_boot_device *bootdev);
535 * board_spl_fit_post_load - allow process images after loading finished
538 void board_spl_fit_post_load(ulong load_addr, size_t length);
541 * board_spl_fit_size_align - specific size align before processing payload
544 ulong board_spl_fit_size_align(ulong size);
547 * spl_perform_fixups() - arch/board-specific callback before processing
550 void spl_perform_fixups(struct spl_image_info *spl_image);
553 * spl_get_load_buffer() - get buffer for loading partial image data
555 * Returns memory area which can be populated by partial image data,
556 * ie. uImage or fitImage header.
558 struct image_header *spl_get_load_buffer(ssize_t offset, size_t size);