1 /* SPDX-License-Identifier: GPL-2.0+ */
4 * Texas Instruments, <www.ti.com>
9 #include <binman_sym.h>
10 #include <linker_lists.h>
12 /* Platform-specific defines */
13 #include <linux/compiler.h>
14 #include <asm/global_data.h>
21 /* Value in r0 indicates we booted from U-Boot */
22 #define UBOOT_NOT_LOADED_FROM_SPL 0x13578642
25 #define MMCSD_MODE_UNDEFINED 0
26 #define MMCSD_MODE_RAW 1
27 #define MMCSD_MODE_FS 2
28 #define MMCSD_MODE_EMMCBOOT 3
34 * u_boot_first_phase() - check if this is the first U-Boot phase
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.
42 * @returns true if this is the first phase of U-Boot
45 static inline bool u_boot_first_phase(void)
47 if (IS_ENABLED(CONFIG_TPL)) {
48 if (IS_ENABLED(CONFIG_TPL_BUILD))
50 } else if (IS_ENABLED(CONFIG_SPL)) {
51 if (IS_ENABLED(CONFIG_SPL_BUILD))
61 PHASE_TPL, /* Running in TPL */
62 PHASE_SPL, /* Running in SPL */
63 PHASE_BOARD_F, /* Running in U-Boot before relocation */
64 PHASE_BOARD_R, /* Running in U-Boot after relocation */
68 * spl_phase() - Find out the phase of U-Boot
70 * This can be used to avoid #ifdef logic and use if() instead.
72 * For example, to include code only in TPL, you might do:
74 * #ifdef CONFIG_TPL_BUILD
78 * but with this you can use:
80 * if (spl_phase() == PHASE_TPL) {
84 * To include code only in SPL, you might do:
86 * #if defined(CONFIG_SPL_BUILD) && !defined(CONFIG_TPL_BUILD)
90 * but with this you can use:
92 * if (spl_phase() == PHASE_SPL) {
96 * To include code only in U-Boot proper, you might do:
98 * #ifndef CONFIG_SPL_BUILD
102 * but with this you can use:
104 * if (spl_phase() == PHASE_BOARD_F) {
108 * @return U-Boot phase
110 static inline enum u_boot_phase spl_phase(void)
112 #ifdef CONFIG_TPL_BUILD
114 #elif CONFIG_SPL_BUILD
117 DECLARE_GLOBAL_DATA_PTR;
119 if (!(gd->flags & GD_FLG_RELOC))
120 return PHASE_BOARD_F;
122 return PHASE_BOARD_R;
126 /* A string name for SPL or TPL */
127 #ifdef CONFIG_SPL_BUILD
128 # ifdef CONFIG_TPL_BUILD
129 # define SPL_TPL_NAME "TPL"
131 # define SPL_TPL_NAME "SPL"
133 # define SPL_TPL_PROMPT SPL_TPL_NAME ": "
135 # define SPL_TPL_NAME ""
136 # define SPL_TPL_PROMPT ""
139 struct spl_image_info {
143 uintptr_t entry_point;
144 #if CONFIG_IS_ENABLED(LOAD_FIT) || CONFIG_IS_ENABLED(LOAD_FIT_FULL)
151 #ifdef CONFIG_SPL_LEGACY_IMAGE_CRC_CHECK
159 * Information required to load data from a device
161 * @dev: Pointer to the device, e.g. struct mmc *
162 * @priv: Private data for the device
163 * @bl_len: Block length for reading in bytes
164 * @filename: Name of the fit image file.
165 * @read: Function to call to read from the device
167 struct spl_load_info {
171 const char *filename;
172 ulong (*read)(struct spl_load_info *load, ulong sector, ulong count,
177 * We need to know the position of U-Boot in memory so we can jump to it. We
178 * allow any U-Boot binary to be used (u-boot.bin, u-boot-nodtb.bin,
179 * u-boot.img), hence the '_any'. These is no checking here that the correct
180 * image is found. For example if u-boot.img is used we don't check that
181 * spl_parse_image_header() can parse a valid header.
183 * Similarly for SPL, so that TPL can jump to SPL.
185 binman_sym_extern(ulong, u_boot_any, image_pos);
186 binman_sym_extern(ulong, u_boot_any, size);
187 binman_sym_extern(ulong, spl, image_pos);
188 binman_sym_extern(ulong, spl, size);
191 * spl_get_image_pos() - get the image position of the next phase
193 * This returns the image position to use to load the next phase of U-Boot
195 ulong spl_get_image_pos(void);
198 * spl_get_image_size() - get the size of the next phase
200 * This returns the size to use to load the next phase of U-Boot
202 ulong spl_get_image_size(void);
205 * spl_load_simple_fit_skip_processing() - Hook to allow skipping the FIT
206 * image processing during spl_load_simple_fit().
208 * Return true to skip FIT processing, false to preserve the full code flow
209 * of spl_load_simple_fit().
211 bool spl_load_simple_fit_skip_processing(void);
214 * spl_load_simple_fit() - Loads a fit image from a device.
215 * @spl_image: Image description to set up
216 * @info: Structure containing the information required to load data.
217 * @sector: Sector number where FIT image is located in the device
218 * @fdt: Pointer to the copied FIT header.
220 * Reads the FIT image @sector in the device. Loads u-boot image to
221 * specified load address and copies the dtb to end of u-boot image.
222 * Returns 0 on success.
224 int spl_load_simple_fit(struct spl_image_info *spl_image,
225 struct spl_load_info *info, ulong sector, void *fdt);
227 #define SPL_COPY_PAYLOAD_ONLY 1
228 #define SPL_FIT_FOUND 2
231 * spl_load_legacy_img() - Loads a legacy image from a device.
232 * @spl_image: Image description to set up
233 * @load: Structure containing the information required to load data.
234 * @header: Pointer to image header (including appended image)
236 * Reads an legacy image from the device. Loads u-boot image to
237 * specified load address.
238 * Returns 0 on success.
240 int spl_load_legacy_img(struct spl_image_info *spl_image,
241 struct spl_load_info *load, ulong header);
244 * spl_load_imx_container() - Loads a imx container image from a device.
245 * @spl_image: Image description to set up
246 * @info: Structure containing the information required to load data.
247 * @sector: Sector number where container image is located in the device
249 * Reads the container image @sector in the device. Loads u-boot image to
250 * specified load address.
252 int spl_load_imx_container(struct spl_image_info *spl_image,
253 struct spl_load_info *info, ulong sector);
255 /* SPL common functions */
256 void preloader_console_init(void);
257 u32 spl_boot_device(void);
260 * spl_mmc_boot_mode() - Lookup function for the mode of an MMC boot source.
261 * @boot_device: ID of the device which the MMC driver wants to read
262 * from. Common values are e.g. BOOT_DEVICE_MMC1,
263 * BOOT_DEVICE_MMC2, BOOT_DEVICE_MMC2_2.
265 * This function should return one of MMCSD_MODE_FS, MMCSD_MODE_EMMCBOOT, or
266 * MMCSD_MODE_RAW for each MMC boot source which is defined for the target. The
267 * boot_device parameter tells which device the MMC driver is interested in.
269 * If not overridden, it is weakly defined in common/spl/spl_mmc.c.
271 * Note: It is important to use the boot_device parameter instead of e.g.
272 * spl_boot_device() as U-Boot is not always loaded from the same device as SPL.
274 u32 spl_mmc_boot_mode(const u32 boot_device);
277 * spl_mmc_boot_partition() - MMC partition to load U-Boot from.
278 * @boot_device: ID of the device which the MMC driver wants to load
281 * This function should return the partition number which the SPL
282 * should load U-Boot from (on the given boot_device) when
283 * CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_USE_PARTITION is set.
285 * If not overridden, it is weakly defined in common/spl/spl_mmc.c.
287 int spl_mmc_boot_partition(const u32 boot_device);
290 * spl_alloc_bd() - Allocate space for bd_info
292 * This sets up the gd->bd pointer by allocating memory for it
294 * @return 0 if OK, -ENOMEM if out of memory
296 int spl_alloc_bd(void);
299 * spl_set_header_raw_uboot() - Set up a standard SPL image structure
301 * This sets up the given spl_image which the standard values obtained from
302 * config options: CONFIG_SYS_MONITOR_LEN, CONFIG_SYS_UBOOT_START,
303 * CONFIG_SYS_TEXT_BASE.
305 * @spl_image: Image description to set up
307 void spl_set_header_raw_uboot(struct spl_image_info *spl_image);
310 * spl_parse_image_header() - parse the image header and set up info
312 * This parses the legacy image header information at @header and sets up
313 * @spl_image according to what is found. If no image header is found, then
314 * a raw image or bootz is assumed. If CONFIG_SPL_PANIC_ON_RAW_IMAGE is
315 * enabled, then this causes a panic. If CONFIG_SPL_RAW_IMAGE_SUPPORT is not
316 * enabled then U-Boot gives up. Otherwise U-Boot sets up the image using
317 * spl_set_header_raw_uboot(), or possibly the bootz header.
319 * @spl_image: Image description to set up
320 * @header image header to parse
321 * @return 0 if a header was correctly parsed, -ve on error
323 int spl_parse_image_header(struct spl_image_info *spl_image,
324 const struct image_header *header);
326 void spl_board_prepare_for_linux(void);
327 void spl_board_prepare_for_boot(void);
328 int spl_board_ubi_load_image(u32 boot_device);
329 int spl_board_boot_device(u32 boot_device);
332 * jump_to_image_linux() - Jump to a Linux kernel from SPL
334 * This jumps into a Linux kernel using the information in @spl_image.
336 * @spl_image: Image description to set up
338 void __noreturn jump_to_image_linux(struct spl_image_info *spl_image);
341 * spl_start_uboot() - Check if SPL should start the kernel or U-Boot
343 * This is called by the various SPL loaders to determine whether the board
344 * wants to load the kernel or U-Boot. This function should be provided by
347 * @return 0 if SPL should start the kernel, 1 if U-Boot must be started
349 int spl_start_uboot(void);
352 * spl_display_print() - Display a board-specific message in SPL
354 * If CONFIG_SPL_DISPLAY_PRINT is enabled, U-Boot will call this function
355 * immediately after displaying the SPL console banner ("U-Boot SPL ...").
356 * This function should be provided by the board.
358 void spl_display_print(void);
361 * struct spl_boot_device - Describes a boot device used by SPL
363 * @boot_device: A number indicating the BOOT_DEVICE type. There are various
364 * BOOT_DEVICE... #defines and enums in U-Boot and they are not consistently
366 * @boot_device_name: Named boot device, or NULL if none.
368 * Note: Additional fields can be added here, bearing in mind that SPL is
369 * size-sensitive and common fields will be present on all boards. This
370 * struct can also be used to return additional information about the load
371 * process if that becomes useful.
373 struct spl_boot_device {
375 const char *boot_device_name;
379 * Holds information about a way of loading an SPL image
381 * @name: User-friendly name for this method (e.g. "MMC")
382 * @boot_device: Boot device that this loader supports
383 * @load_image: Function to call to load image
385 struct spl_image_loader {
386 #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
391 * load_image() - Load an SPL image
393 * @spl_image: place to put image information
394 * @bootdev: describes the boot device to load from
396 int (*load_image)(struct spl_image_info *spl_image,
397 struct spl_boot_device *bootdev);
400 /* Declare an SPL image loader */
401 #define SPL_LOAD_IMAGE(__name) \
402 ll_entry_declare(struct spl_image_loader, __name, spl_image_loader)
405 * _priority is the priority of this method, 0 meaning it will be the top
406 * choice for this device, 9 meaning it is the bottom choice.
407 * _boot_device is the BOOT_DEVICE_... value
408 * _method is the load_image function to call
410 #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
411 #define SPL_LOAD_IMAGE_METHOD(_name, _priority, _boot_device, _method) \
412 SPL_LOAD_IMAGE(_boot_device ## _priority ## _method) = { \
414 .boot_device = _boot_device, \
415 .load_image = _method, \
418 #define SPL_LOAD_IMAGE_METHOD(_name, _priority, _boot_device, _method) \
419 SPL_LOAD_IMAGE(_boot_device ## _priority ## _method) = { \
420 .boot_device = _boot_device, \
421 .load_image = _method, \
425 /* SPL FAT image functions */
426 int spl_load_image_fat(struct spl_image_info *spl_image,
427 struct blk_desc *block_dev, int partition,
428 const char *filename);
429 int spl_load_image_fat_os(struct spl_image_info *spl_image,
430 struct blk_desc *block_dev, int partition);
432 void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image);
434 /* SPL EXT image functions */
435 int spl_load_image_ext(struct spl_image_info *spl_image,
436 struct blk_desc *block_dev, int partition,
437 const char *filename);
438 int spl_load_image_ext_os(struct spl_image_info *spl_image,
439 struct blk_desc *block_dev, int partition);
442 * spl_early_init() - Set up device tree and driver model in SPL if enabled
444 * Call this function in board_init_f() if you want to use device tree and
445 * driver model early, before board_init_r() is called.
447 * If this is not called, then driver model will be inactive in SPL's
448 * board_init_f(), and no device tree will be available.
450 int spl_early_init(void);
453 * spl_init() - Set up device tree and driver model in SPL if enabled
455 * You can optionally call spl_early_init(), then optionally call spl_init().
456 * This function will be called from board_init_r() if not called earlier.
458 * Both spl_early_init() and spl_init() perform a similar function except that
459 * the latter will not set up the malloc() area if
460 * CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN is enabled, since it is assumed to
461 * already be done by a calll to spl_relocate_stack_gd() before board_init_r()
464 * This function will be called from board_init_r() if not called earlier.
466 * If this is not called, then driver model will be inactive in SPL's
467 * board_init_f(), and no device tree will be available.
471 #ifdef CONFIG_SPL_BOARD_INIT
472 void spl_board_init(void);
476 * spl_was_boot_source() - check if U-Boot booted from SPL
478 * This will normally be true, but if U-Boot jumps to second U-Boot, it will
479 * be false. This should be implemented by board-specific code.
481 * @return true if U-Boot booted from SPL, else false
483 bool spl_was_boot_source(void);
486 * spl_dfu_cmd- run dfu command with chosen mmc device interface
487 * @param usb_index - usb controller number
488 * @param mmc_dev - mmc device nubmer
490 * @return 0 on success, otherwise error code
492 int spl_dfu_cmd(int usbctrl, char *dfu_alt_info, char *interface, char *devstr);
494 int spl_mmc_load_image(struct spl_image_info *spl_image,
495 struct spl_boot_device *bootdev);
498 * spl_mmc_load() - Load an image file from MMC/SD media
500 * @param spl_image Image data filled in by loading process
501 * @param bootdev Describes which device to load from
502 * @param filename Name of file to load (in FS mode)
503 * @param raw_part Partition to load from (in RAW mode)
504 * @param raw_sect Sector to load from (in RAW mode)
506 * @return 0 on success, otherwise error code
508 int spl_mmc_load(struct spl_image_info *spl_image,
509 struct spl_boot_device *bootdev,
510 const char *filename,
512 unsigned long raw_sect);
515 * spl_usb_load() - Load an image file from USB mass storage
517 * @param spl_image Image data filled in by loading process
518 * @param bootdev Describes which device to load from
519 * @param raw_part Fat partition to load from
520 * @param filename Name of file to load
522 * @return 0 on success, otherwise error code
524 int spl_usb_load(struct spl_image_info *spl_image,
525 struct spl_boot_device *bootdev,
526 int partition, const char *filename);
528 int spl_ymodem_load_image(struct spl_image_info *spl_image,
529 struct spl_boot_device *bootdev);
532 * spl_invoke_atf - boot using an ARM trusted firmware image
534 void spl_invoke_atf(struct spl_image_info *spl_image);
537 * bl2_plat_get_bl31_params() - return params for bl31.
538 * @bl32_entry: address of BL32 executable (secure)
539 * @bl33_entry: address of BL33 executable (non secure)
540 * @fdt_addr: address of Flat Device Tree
542 * This is a weak function which might be overridden by the board code. By
543 * default it will just call bl2_plat_get_bl31_params_default().
545 * If you just want to manipulate or add some parameters, you can override
546 * this function, call bl2_plat_get_bl31_params_default and operate on the
547 * returned bl31 params.
549 * Return: bl31 params structure pointer
551 struct bl31_params *bl2_plat_get_bl31_params(uintptr_t bl32_entry,
552 uintptr_t bl33_entry,
556 * bl2_plat_get_bl31_params_default() - prepare params for bl31.
557 * @bl32_entry: address of BL32 executable (secure)
558 * @bl33_entry: address of BL33 executable (non secure)
559 * @fdt_addr: address of Flat Device Tree
561 * This is the default implementation of bl2_plat_get_bl31_params(). It assigns
562 * a pointer to the memory that the platform has kept aside to pass platform
563 * specific and trusted firmware related information to BL31. This memory is
564 * allocated by allocating memory to bl2_to_bl31_params_mem structure which is
565 * a superset of all the structure whose information is passed to BL31
567 * NOTE: The memory is statically allocated, thus this function should be
568 * called only once. All subsequent calls will overwrite any changes.
570 * Return: bl31 params structure pointer
572 struct bl31_params *bl2_plat_get_bl31_params_default(uintptr_t bl32_entry,
573 uintptr_t bl33_entry,
577 * bl2_plat_get_bl31_params_v2() - return params for bl31
578 * @bl32_entry: address of BL32 executable (secure)
579 * @bl33_entry: address of BL33 executable (non secure)
580 * @fdt_addr: address of Flat Device Tree
582 * This function does the same as bl2_plat_get_bl31_params() except that is is
583 * used for the new LOAD_IMAGE_V2 option, which uses a slightly different
584 * method to pass the parameters.
586 * Return: bl31 params structure pointer
588 struct bl_params *bl2_plat_get_bl31_params_v2(uintptr_t bl32_entry,
589 uintptr_t bl33_entry,
593 * bl2_plat_get_bl31_params_v2_default() - prepare params for bl31.
594 * @bl32_entry: address of BL32 executable (secure)
595 * @bl33_entry: address of BL33 executable (non secure)
596 * @fdt_addr: address of Flat Device Tree
598 * This is the default implementation of bl2_plat_get_bl31_params_v2(). It
599 * prepares the linked list of the bl31 params, populates the image types and
600 * set the entry points for bl32 and bl33 (if available).
602 * NOTE: The memory is statically allocated, thus this function should be
603 * called only once. All subsequent calls will overwrite any changes.
605 * Return: bl31 params structure pointer
607 struct bl_params *bl2_plat_get_bl31_params_v2_default(uintptr_t bl32_entry,
608 uintptr_t bl33_entry,
611 * spl_optee_entry - entry function for optee
613 * args defind in op-tee project
614 * https://github.com/OP-TEE/optee_os/
615 * core/arch/arm/kernel/generic_entry_a32.S
617 * @arg1: (ARMv7 standard bootarg #1)
618 * @arg2: device tree address, (ARMv7 standard bootarg #2)
619 * @arg3: non-secure entry address (ARMv7 bootarg #0)
621 void spl_optee_entry(void *arg0, void *arg1, void *arg2, void *arg3);
624 * spl_invoke_opensbi - boot using a RISC-V OpenSBI image
626 void spl_invoke_opensbi(struct spl_image_info *spl_image);
629 * board_return_to_bootrom - allow for boards to continue with the boot ROM
631 * If a board (e.g. the Rockchip RK3368 boards) provide some
632 * supporting functionality for SPL in their boot ROM and the SPL
633 * stage wants to return to the ROM code to continue booting, boards
634 * can implement 'board_return_to_bootrom'.
636 int board_return_to_bootrom(struct spl_image_info *spl_image,
637 struct spl_boot_device *bootdev);
640 * board_spl_fit_post_load - allow process images after loading finished
643 void board_spl_fit_post_load(ulong load_addr, size_t length);
646 * board_spl_fit_size_align - specific size align before processing payload
649 ulong board_spl_fit_size_align(ulong size);
652 * spl_perform_fixups() - arch/board-specific callback before processing
655 void spl_perform_fixups(struct spl_image_info *spl_image);
658 * spl_get_load_buffer() - get buffer for loading partial image data
660 * Returns memory area which can be populated by partial image data,
661 * ie. uImage or fitImage header.
663 struct image_header *spl_get_load_buffer(ssize_t offset, size_t size);
665 void spl_save_restore_data(void);