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_NONE, /* Invalid phase, signifying before U-Boot */
62 PHASE_TPL, /* Running in TPL */
63 PHASE_SPL, /* Running in SPL */
64 PHASE_BOARD_F, /* Running in U-Boot before relocation */
65 PHASE_BOARD_R, /* Running in U-Boot after relocation */
69 * spl_phase() - Find out the phase of U-Boot
71 * This can be used to avoid #ifdef logic and use if() instead.
73 * For example, to include code only in TPL, you might do:
75 * #ifdef CONFIG_TPL_BUILD
79 * but with this you can use:
81 * if (spl_phase() == PHASE_TPL) {
85 * To include code only in SPL, you might do:
87 * #if defined(CONFIG_SPL_BUILD) && !defined(CONFIG_TPL_BUILD)
91 * but with this you can use:
93 * if (spl_phase() == PHASE_SPL) {
97 * To include code only in U-Boot proper, you might do:
99 * #ifndef CONFIG_SPL_BUILD
103 * but with this you can use:
105 * if (spl_phase() == PHASE_BOARD_F) {
109 * @return U-Boot phase
111 static inline enum u_boot_phase spl_phase(void)
113 #ifdef CONFIG_TPL_BUILD
115 #elif CONFIG_SPL_BUILD
118 DECLARE_GLOBAL_DATA_PTR;
120 if (!(gd->flags & GD_FLG_RELOC))
121 return PHASE_BOARD_F;
123 return PHASE_BOARD_R;
128 * spl_prev_phase() - Figure out the previous U-Boot phase
130 * @return the previous phase from this one, e.g. if called in SPL this returns
131 * PHASE_TPL, if TPL is enabled
133 static inline enum u_boot_phase spl_prev_phase(void)
135 #ifdef CONFIG_TPL_BUILD
137 #elif defined(CONFIG_SPL_BUILD)
138 return IS_ENABLED(CONFIG_TPL) ? PHASE_TPL : PHASE_NONE;
140 return IS_ENABLED(CONFIG_SPL) ? PHASE_SPL : PHASE_NONE;
145 * spl_next_phase() - Figure out the next U-Boot phase
147 * @return the next phase from this one, e.g. if called in TPL this returns
150 static inline enum u_boot_phase spl_next_phase(void)
152 #ifdef CONFIG_TPL_BUILD
155 return PHASE_BOARD_F;
160 * spl_phase_name() - Get the name of the current phase
164 static inline const char *spl_phase_name(enum u_boot_phase phase)
180 * spl_phase_prefix() - Get the prefix of the current phase
182 * @phase: Phase to look up
183 * @return phase prefix ("spl", "tpl", etc.)
185 static inline const char *spl_phase_prefix(enum u_boot_phase phase)
200 /* A string name for SPL or TPL */
201 #ifdef CONFIG_SPL_BUILD
202 # ifdef CONFIG_TPL_BUILD
203 # define SPL_TPL_NAME "TPL"
205 # define SPL_TPL_NAME "SPL"
207 # define SPL_TPL_PROMPT SPL_TPL_NAME ": "
209 # define SPL_TPL_NAME ""
210 # define SPL_TPL_PROMPT ""
213 struct spl_image_info {
217 uintptr_t entry_point;
218 #if CONFIG_IS_ENABLED(LOAD_FIT) || CONFIG_IS_ENABLED(LOAD_FIT_FULL)
225 #ifdef CONFIG_SPL_LEGACY_IMAGE_CRC_CHECK
233 * Information required to load data from a device
235 * @dev: Pointer to the device, e.g. struct mmc *
236 * @priv: Private data for the device
237 * @bl_len: Block length for reading in bytes
238 * @filename: Name of the fit image file.
239 * @read: Function to call to read from the device
241 struct spl_load_info {
245 const char *filename;
247 * read() - Read from device
249 * @load: Information about the load state
250 * @sector: Sector number to read from (each @load->bl_len bytes)
251 * @count: Number of sectors to read
252 * @buf: Buffer to read into
253 * @return number of sectors read, 0 on error
255 ulong (*read)(struct spl_load_info *load, ulong sector, ulong count,
260 * We need to know the position of U-Boot in memory so we can jump to it. We
261 * allow any U-Boot binary to be used (u-boot.bin, u-boot-nodtb.bin,
262 * u-boot.img), hence the '_any'. These is no checking here that the correct
263 * image is found. For example if u-boot.img is used we don't check that
264 * spl_parse_image_header() can parse a valid header.
266 * Similarly for SPL, so that TPL can jump to SPL.
268 binman_sym_extern(ulong, u_boot_any, image_pos);
269 binman_sym_extern(ulong, u_boot_any, size);
270 binman_sym_extern(ulong, spl, image_pos);
271 binman_sym_extern(ulong, spl, size);
274 * spl_get_image_pos() - get the image position of the next phase
276 * This returns the image position to use to load the next phase of U-Boot
278 ulong spl_get_image_pos(void);
281 * spl_get_image_size() - get the size of the next phase
283 * This returns the size to use to load the next phase of U-Boot
285 ulong spl_get_image_size(void);
288 * spl_get_image_text_base() - get the text base of the next phase
290 * This returns the address that the next stage is linked to run at, i.e.
291 * CONFIG_SPL_TEXT_BASE or CONFIG_SYS_TEXT_BASE
293 * @return text-base address
295 ulong spl_get_image_text_base(void);
298 * spl_load_simple_fit_skip_processing() - Hook to allow skipping the FIT
299 * image processing during spl_load_simple_fit().
301 * Return true to skip FIT processing, false to preserve the full code flow
302 * of spl_load_simple_fit().
304 bool spl_load_simple_fit_skip_processing(void);
307 * spl_load_simple_fit() - Loads a fit image from a device.
308 * @spl_image: Image description to set up
309 * @info: Structure containing the information required to load data.
310 * @sector: Sector number where FIT image is located in the device
311 * @fdt: Pointer to the copied FIT header.
313 * Reads the FIT image @sector in the device. Loads u-boot image to
314 * specified load address and copies the dtb to end of u-boot image.
315 * Returns 0 on success.
317 int spl_load_simple_fit(struct spl_image_info *spl_image,
318 struct spl_load_info *info, ulong sector, void *fdt);
320 #define SPL_COPY_PAYLOAD_ONLY 1
321 #define SPL_FIT_FOUND 2
324 * spl_load_legacy_img() - Loads a legacy image from a device.
325 * @spl_image: Image description to set up
326 * @load: Structure containing the information required to load data.
327 * @header: Pointer to image header (including appended image)
329 * Reads an legacy image from the device. Loads u-boot image to
330 * specified load address.
331 * Returns 0 on success.
333 int spl_load_legacy_img(struct spl_image_info *spl_image,
334 struct spl_load_info *load, ulong header);
337 * spl_load_imx_container() - Loads a imx container image from a device.
338 * @spl_image: Image description to set up
339 * @info: Structure containing the information required to load data.
340 * @sector: Sector number where container image is located in the device
342 * Reads the container image @sector in the device. Loads u-boot image to
343 * specified load address.
345 int spl_load_imx_container(struct spl_image_info *spl_image,
346 struct spl_load_info *info, ulong sector);
348 /* SPL common functions */
349 void preloader_console_init(void);
350 u32 spl_boot_device(void);
353 * spl_mmc_boot_mode() - Lookup function for the mode of an MMC boot source.
354 * @boot_device: ID of the device which the MMC driver wants to read
355 * from. Common values are e.g. BOOT_DEVICE_MMC1,
356 * BOOT_DEVICE_MMC2, BOOT_DEVICE_MMC2_2.
358 * This function should return one of MMCSD_MODE_FS, MMCSD_MODE_EMMCBOOT, or
359 * MMCSD_MODE_RAW for each MMC boot source which is defined for the target. The
360 * boot_device parameter tells which device the MMC driver is interested in.
362 * If not overridden, it is weakly defined in common/spl/spl_mmc.c.
364 * Note: It is important to use the boot_device parameter instead of e.g.
365 * spl_boot_device() as U-Boot is not always loaded from the same device as SPL.
367 u32 spl_mmc_boot_mode(const u32 boot_device);
370 * spl_mmc_boot_partition() - MMC partition to load U-Boot from.
371 * @boot_device: ID of the device which the MMC driver wants to load
374 * This function should return the partition number which the SPL
375 * should load U-Boot from (on the given boot_device) when
376 * CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_USE_PARTITION is set.
378 * If not overridden, it is weakly defined in common/spl/spl_mmc.c.
380 int spl_mmc_boot_partition(const u32 boot_device);
384 * default_spl_mmc_emmc_boot_partition() - eMMC boot partition to load U-Boot from.
385 * mmc: Pointer for the mmc device structure
387 * This function should return the eMMC boot partition number which
388 * the SPL should load U-Boot from (on the given boot_device).
390 int default_spl_mmc_emmc_boot_partition(struct mmc *mmc);
393 * spl_mmc_emmc_boot_partition() - eMMC boot partition to load U-Boot from.
394 * mmc: Pointer for the mmc device structure
396 * This function should return the eMMC boot partition number which
397 * the SPL should load U-Boot from (on the given boot_device).
399 * If not overridden, it is weakly defined in common/spl/spl_mmc.c
400 * and calls default_spl_mmc_emmc_boot_partition();
402 int spl_mmc_emmc_boot_partition(struct mmc *mmc);
404 void spl_set_bd(void);
407 * spl_set_header_raw_uboot() - Set up a standard SPL image structure
409 * This sets up the given spl_image which the standard values obtained from
410 * config options: CONFIG_SYS_MONITOR_LEN, CONFIG_SYS_UBOOT_START,
411 * CONFIG_SYS_TEXT_BASE.
413 * @spl_image: Image description to set up
415 void spl_set_header_raw_uboot(struct spl_image_info *spl_image);
418 * spl_parse_image_header() - parse the image header and set up info
420 * This parses the legacy image header information at @header and sets up
421 * @spl_image according to what is found. If no image header is found, then
422 * a raw image or bootz is assumed. If CONFIG_SPL_PANIC_ON_RAW_IMAGE is
423 * enabled, then this causes a panic. If CONFIG_SPL_RAW_IMAGE_SUPPORT is not
424 * enabled then U-Boot gives up. Otherwise U-Boot sets up the image using
425 * spl_set_header_raw_uboot(), or possibly the bootz header.
427 * @spl_image: Image description to set up
428 * @header image header to parse
429 * @return 0 if a header was correctly parsed, -ve on error
431 int spl_parse_image_header(struct spl_image_info *spl_image,
432 const struct image_header *header);
434 void spl_board_prepare_for_linux(void);
437 * spl_board_prepare_for_optee() - Prepare board for an OPTEE payload
439 * Prepares the board for booting an OP-TEE payload. Initialization is platform
440 * specific, and may include configuring the TrustZone memory, and other
441 * initialization steps required by OP-TEE.
442 * Note that @fdt is not used directly by OP-TEE. OP-TEE passes this @fdt to
443 * its normal world target. This target is not guaranteed to be u-boot, so @fdt
444 * changes that would normally be done by u-boot should be done in this step.
446 * @fdt: Devicetree that will be passed on, or NULL
448 void spl_board_prepare_for_optee(void *fdt);
449 void spl_board_prepare_for_boot(void);
450 int spl_board_ubi_load_image(u32 boot_device);
451 int spl_board_boot_device(u32 boot_device);
454 * jump_to_image_linux() - Jump to a Linux kernel from SPL
456 * This jumps into a Linux kernel using the information in @spl_image.
458 * @spl_image: Image description to set up
460 void __noreturn jump_to_image_linux(struct spl_image_info *spl_image);
463 * spl_start_uboot() - Check if SPL should start the kernel or U-Boot
465 * This is called by the various SPL loaders to determine whether the board
466 * wants to load the kernel or U-Boot. This function should be provided by
469 * @return 0 if SPL should start the kernel, 1 if U-Boot must be started
471 int spl_start_uboot(void);
474 * spl_display_print() - Display a board-specific message in SPL
476 * If CONFIG_SPL_DISPLAY_PRINT is enabled, U-Boot will call this function
477 * immediately after displaying the SPL console banner ("U-Boot SPL ...").
478 * This function should be provided by the board.
480 void spl_display_print(void);
483 * struct spl_boot_device - Describes a boot device used by SPL
485 * @boot_device: A number indicating the BOOT_DEVICE type. There are various
486 * BOOT_DEVICE... #defines and enums in U-Boot and they are not consistently
488 * @boot_device_name: Named boot device, or NULL if none.
490 * Note: Additional fields can be added here, bearing in mind that SPL is
491 * size-sensitive and common fields will be present on all boards. This
492 * struct can also be used to return additional information about the load
493 * process if that becomes useful.
495 struct spl_boot_device {
497 const char *boot_device_name;
501 * Holds information about a way of loading an SPL image
503 * @name: User-friendly name for this method (e.g. "MMC")
504 * @boot_device: Boot device that this loader supports
505 * @load_image: Function to call to load image
507 struct spl_image_loader {
508 #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
513 * load_image() - Load an SPL image
515 * @spl_image: place to put image information
516 * @bootdev: describes the boot device to load from
518 int (*load_image)(struct spl_image_info *spl_image,
519 struct spl_boot_device *bootdev);
522 /* Helper function for accessing the name */
523 static inline const char *spl_loader_name(const struct spl_image_loader *loader)
525 #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
532 /* Declare an SPL image loader */
533 #define SPL_LOAD_IMAGE(__name) \
534 ll_entry_declare(struct spl_image_loader, __name, spl_image_loader)
537 * _priority is the priority of this method, 0 meaning it will be the top
538 * choice for this device, 9 meaning it is the bottom choice.
539 * _boot_device is the BOOT_DEVICE_... value
540 * _method is the load_image function to call
542 #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
543 #define SPL_LOAD_IMAGE_METHOD(_name, _priority, _boot_device, _method) \
544 SPL_LOAD_IMAGE(_boot_device ## _priority ## _method) = { \
546 .boot_device = _boot_device, \
547 .load_image = _method, \
550 #define SPL_LOAD_IMAGE_METHOD(_name, _priority, _boot_device, _method) \
551 SPL_LOAD_IMAGE(_boot_device ## _priority ## _method) = { \
552 .boot_device = _boot_device, \
553 .load_image = _method, \
557 /* SPL FAT image functions */
558 int spl_load_image_fat(struct spl_image_info *spl_image,
559 struct blk_desc *block_dev, int partition,
560 const char *filename);
561 int spl_load_image_fat_os(struct spl_image_info *spl_image,
562 struct blk_desc *block_dev, int partition);
564 void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image);
566 /* SPL EXT image functions */
567 int spl_load_image_ext(struct spl_image_info *spl_image,
568 struct blk_desc *block_dev, int partition,
569 const char *filename);
570 int spl_load_image_ext_os(struct spl_image_info *spl_image,
571 struct blk_desc *block_dev, int partition);
574 * spl_early_init() - Set up device tree and driver model in SPL if enabled
576 * Call this function in board_init_f() if you want to use device tree and
577 * driver model early, before board_init_r() is called.
579 * If this is not called, then driver model will be inactive in SPL's
580 * board_init_f(), and no device tree will be available.
582 int spl_early_init(void);
585 * spl_init() - Set up device tree and driver model in SPL if enabled
587 * You can optionally call spl_early_init(), then optionally call spl_init().
588 * This function will be called from board_init_r() if not called earlier.
590 * Both spl_early_init() and spl_init() perform a similar function except that
591 * the latter will not set up the malloc() area if
592 * CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN is enabled, since it is assumed to
593 * already be done by a calll to spl_relocate_stack_gd() before board_init_r()
596 * This function will be called from board_init_r() if not called earlier.
598 * If this is not called, then driver model will be inactive in SPL's
599 * board_init_f(), and no device tree will be available.
603 #ifdef CONFIG_SPL_BOARD_INIT
604 void spl_board_init(void);
608 * spl_was_boot_source() - check if U-Boot booted from SPL
610 * This will normally be true, but if U-Boot jumps to second U-Boot, it will
611 * be false. This should be implemented by board-specific code.
613 * @return true if U-Boot booted from SPL, else false
615 bool spl_was_boot_source(void);
618 * spl_dfu_cmd- run dfu command with chosen mmc device interface
619 * @param usb_index - usb controller number
620 * @param mmc_dev - mmc device nubmer
622 * @return 0 on success, otherwise error code
624 int spl_dfu_cmd(int usbctrl, char *dfu_alt_info, char *interface, char *devstr);
626 int spl_mmc_load_image(struct spl_image_info *spl_image,
627 struct spl_boot_device *bootdev);
630 * spl_mmc_load() - Load an image file from MMC/SD media
632 * @param spl_image Image data filled in by loading process
633 * @param bootdev Describes which device to load from
634 * @param filename Name of file to load (in FS mode)
635 * @param raw_part Partition to load from (in RAW mode)
636 * @param raw_sect Sector to load from (in RAW mode)
638 * @return 0 on success, otherwise error code
640 int spl_mmc_load(struct spl_image_info *spl_image,
641 struct spl_boot_device *bootdev,
642 const char *filename,
644 unsigned long raw_sect);
647 * spl_usb_load() - Load an image file from USB mass storage
649 * @param spl_image Image data filled in by loading process
650 * @param bootdev Describes which device to load from
651 * @param raw_part Fat partition to load from
652 * @param filename Name of file to load
654 * @return 0 on success, otherwise error code
656 int spl_usb_load(struct spl_image_info *spl_image,
657 struct spl_boot_device *bootdev,
658 int partition, const char *filename);
660 int spl_ymodem_load_image(struct spl_image_info *spl_image,
661 struct spl_boot_device *bootdev);
664 * spl_invoke_atf - boot using an ARM trusted firmware image
666 void spl_invoke_atf(struct spl_image_info *spl_image);
669 * bl2_plat_get_bl31_params() - return params for bl31.
670 * @bl32_entry: address of BL32 executable (secure)
671 * @bl33_entry: address of BL33 executable (non secure)
672 * @fdt_addr: address of Flat Device Tree
674 * This is a weak function which might be overridden by the board code. By
675 * default it will just call bl2_plat_get_bl31_params_default().
677 * If you just want to manipulate or add some parameters, you can override
678 * this function, call bl2_plat_get_bl31_params_default and operate on the
679 * returned bl31 params.
681 * Return: bl31 params structure pointer
683 struct bl31_params *bl2_plat_get_bl31_params(uintptr_t bl32_entry,
684 uintptr_t bl33_entry,
688 * bl2_plat_get_bl31_params_default() - prepare params for bl31.
689 * @bl32_entry: address of BL32 executable (secure)
690 * @bl33_entry: address of BL33 executable (non secure)
691 * @fdt_addr: address of Flat Device Tree
693 * This is the default implementation of bl2_plat_get_bl31_params(). It assigns
694 * a pointer to the memory that the platform has kept aside to pass platform
695 * specific and trusted firmware related information to BL31. This memory is
696 * allocated by allocating memory to bl2_to_bl31_params_mem structure which is
697 * a superset of all the structure whose information is passed to BL31
699 * NOTE: The memory is statically allocated, thus this function should be
700 * called only once. All subsequent calls will overwrite any changes.
702 * Return: bl31 params structure pointer
704 struct bl31_params *bl2_plat_get_bl31_params_default(uintptr_t bl32_entry,
705 uintptr_t bl33_entry,
709 * bl2_plat_get_bl31_params_v2() - return params for bl31
710 * @bl32_entry: address of BL32 executable (secure)
711 * @bl33_entry: address of BL33 executable (non secure)
712 * @fdt_addr: address of Flat Device Tree
714 * This function does the same as bl2_plat_get_bl31_params() except that is is
715 * used for the new LOAD_IMAGE_V2 option, which uses a slightly different
716 * method to pass the parameters.
718 * Return: bl31 params structure pointer
720 struct bl_params *bl2_plat_get_bl31_params_v2(uintptr_t bl32_entry,
721 uintptr_t bl33_entry,
725 * bl2_plat_get_bl31_params_v2_default() - prepare params for bl31.
726 * @bl32_entry: address of BL32 executable (secure)
727 * @bl33_entry: address of BL33 executable (non secure)
728 * @fdt_addr: address of Flat Device Tree
730 * This is the default implementation of bl2_plat_get_bl31_params_v2(). It
731 * prepares the linked list of the bl31 params, populates the image types and
732 * set the entry points for bl32 and bl33 (if available).
734 * NOTE: The memory is statically allocated, thus this function should be
735 * called only once. All subsequent calls will overwrite any changes.
737 * Return: bl31 params structure pointer
739 struct bl_params *bl2_plat_get_bl31_params_v2_default(uintptr_t bl32_entry,
740 uintptr_t bl33_entry,
743 * spl_optee_entry - entry function for optee
745 * args defind in op-tee project
746 * https://github.com/OP-TEE/optee_os/
747 * core/arch/arm/kernel/generic_entry_a32.S
749 * @arg1: (ARMv7 standard bootarg #1)
750 * @arg2: device tree address, (ARMv7 standard bootarg #2)
751 * @arg3: non-secure entry address (ARMv7 bootarg #0)
753 void spl_optee_entry(void *arg0, void *arg1, void *arg2, void *arg3);
756 * spl_invoke_opensbi - boot using a RISC-V OpenSBI image
758 void spl_invoke_opensbi(struct spl_image_info *spl_image);
761 * board_return_to_bootrom - allow for boards to continue with the boot ROM
763 * If a board (e.g. the Rockchip RK3368 boards) provide some
764 * supporting functionality for SPL in their boot ROM and the SPL
765 * stage wants to return to the ROM code to continue booting, boards
766 * can implement 'board_return_to_bootrom'.
768 int board_return_to_bootrom(struct spl_image_info *spl_image,
769 struct spl_boot_device *bootdev);
772 * board_spl_fit_post_load - allow process images after loading finished
773 * @fit: Pointer to a valid Flattened Image Tree blob
775 void board_spl_fit_post_load(const void *fit);
778 * board_spl_fit_size_align - specific size align before processing payload
781 ulong board_spl_fit_size_align(ulong size);
784 * spl_perform_fixups() - arch/board-specific callback before processing
787 void spl_perform_fixups(struct spl_image_info *spl_image);
790 * spl_get_load_buffer() - get buffer for loading partial image data
792 * Returns memory area which can be populated by partial image data,
793 * ie. uImage or fitImage header.
795 struct image_header *spl_get_load_buffer(ssize_t offset, size_t size);
797 void spl_save_restore_data(void);