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)
179 /* A string name for SPL or TPL */
180 #ifdef CONFIG_SPL_BUILD
181 # ifdef CONFIG_TPL_BUILD
182 # define SPL_TPL_NAME "TPL"
184 # define SPL_TPL_NAME "SPL"
186 # define SPL_TPL_PROMPT SPL_TPL_NAME ": "
188 # define SPL_TPL_NAME ""
189 # define SPL_TPL_PROMPT ""
192 struct spl_image_info {
196 uintptr_t entry_point;
197 #if CONFIG_IS_ENABLED(LOAD_FIT) || CONFIG_IS_ENABLED(LOAD_FIT_FULL)
204 #ifdef CONFIG_SPL_LEGACY_IMAGE_CRC_CHECK
212 * Information required to load data from a device
214 * @dev: Pointer to the device, e.g. struct mmc *
215 * @priv: Private data for the device
216 * @bl_len: Block length for reading in bytes
217 * @filename: Name of the fit image file.
218 * @read: Function to call to read from the device
220 struct spl_load_info {
224 const char *filename;
226 * read() - Read from device
228 * @load: Information about the load state
229 * @sector: Sector number to read from (each @load->bl_len bytes)
230 * @count: Number of sectors to read
231 * @buf: Buffer to read into
232 * @return number of sectors read, 0 on error
234 ulong (*read)(struct spl_load_info *load, ulong sector, ulong count,
239 * We need to know the position of U-Boot in memory so we can jump to it. We
240 * allow any U-Boot binary to be used (u-boot.bin, u-boot-nodtb.bin,
241 * u-boot.img), hence the '_any'. These is no checking here that the correct
242 * image is found. For example if u-boot.img is used we don't check that
243 * spl_parse_image_header() can parse a valid header.
245 * Similarly for SPL, so that TPL can jump to SPL.
247 binman_sym_extern(ulong, u_boot_any, image_pos);
248 binman_sym_extern(ulong, u_boot_any, size);
249 binman_sym_extern(ulong, spl, image_pos);
250 binman_sym_extern(ulong, spl, size);
253 * spl_get_image_pos() - get the image position of the next phase
255 * This returns the image position to use to load the next phase of U-Boot
257 ulong spl_get_image_pos(void);
260 * spl_get_image_size() - get the size of the next phase
262 * This returns the size to use to load the next phase of U-Boot
264 ulong spl_get_image_size(void);
267 * spl_get_image_text_base() - get the text base of the next phase
269 * This returns the address that the next stage is linked to run at, i.e.
270 * CONFIG_SPL_TEXT_BASE or CONFIG_SYS_TEXT_BASE
272 * @return text-base address
274 ulong spl_get_image_text_base(void);
277 * spl_load_simple_fit_skip_processing() - Hook to allow skipping the FIT
278 * image processing during spl_load_simple_fit().
280 * Return true to skip FIT processing, false to preserve the full code flow
281 * of spl_load_simple_fit().
283 bool spl_load_simple_fit_skip_processing(void);
286 * spl_load_simple_fit() - Loads a fit image from a device.
287 * @spl_image: Image description to set up
288 * @info: Structure containing the information required to load data.
289 * @sector: Sector number where FIT image is located in the device
290 * @fdt: Pointer to the copied FIT header.
292 * Reads the FIT image @sector in the device. Loads u-boot image to
293 * specified load address and copies the dtb to end of u-boot image.
294 * Returns 0 on success.
296 int spl_load_simple_fit(struct spl_image_info *spl_image,
297 struct spl_load_info *info, ulong sector, void *fdt);
299 #define SPL_COPY_PAYLOAD_ONLY 1
300 #define SPL_FIT_FOUND 2
303 * spl_load_legacy_img() - Loads a legacy image from a device.
304 * @spl_image: Image description to set up
305 * @load: Structure containing the information required to load data.
306 * @header: Pointer to image header (including appended image)
308 * Reads an legacy image from the device. Loads u-boot image to
309 * specified load address.
310 * Returns 0 on success.
312 int spl_load_legacy_img(struct spl_image_info *spl_image,
313 struct spl_load_info *load, ulong header);
316 * spl_load_imx_container() - Loads a imx container image from a device.
317 * @spl_image: Image description to set up
318 * @info: Structure containing the information required to load data.
319 * @sector: Sector number where container image is located in the device
321 * Reads the container image @sector in the device. Loads u-boot image to
322 * specified load address.
324 int spl_load_imx_container(struct spl_image_info *spl_image,
325 struct spl_load_info *info, ulong sector);
327 /* SPL common functions */
328 void preloader_console_init(void);
329 u32 spl_boot_device(void);
332 * spl_mmc_boot_mode() - Lookup function for the mode of an MMC boot source.
333 * @boot_device: ID of the device which the MMC driver wants to read
334 * from. Common values are e.g. BOOT_DEVICE_MMC1,
335 * BOOT_DEVICE_MMC2, BOOT_DEVICE_MMC2_2.
337 * This function should return one of MMCSD_MODE_FS, MMCSD_MODE_EMMCBOOT, or
338 * MMCSD_MODE_RAW for each MMC boot source which is defined for the target. The
339 * boot_device parameter tells which device the MMC driver is interested in.
341 * If not overridden, it is weakly defined in common/spl/spl_mmc.c.
343 * Note: It is important to use the boot_device parameter instead of e.g.
344 * spl_boot_device() as U-Boot is not always loaded from the same device as SPL.
346 u32 spl_mmc_boot_mode(const u32 boot_device);
349 * spl_mmc_boot_partition() - MMC partition to load U-Boot from.
350 * @boot_device: ID of the device which the MMC driver wants to load
353 * This function should return the partition number which the SPL
354 * should load U-Boot from (on the given boot_device) when
355 * CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_USE_PARTITION is set.
357 * If not overridden, it is weakly defined in common/spl/spl_mmc.c.
359 int spl_mmc_boot_partition(const u32 boot_device);
363 * default_spl_mmc_emmc_boot_partition() - eMMC boot partition to load U-Boot from.
364 * mmc: Pointer for the mmc device structure
366 * This function should return the eMMC boot partition number which
367 * the SPL should load U-Boot from (on the given boot_device).
369 int default_spl_mmc_emmc_boot_partition(struct mmc *mmc);
372 * spl_mmc_emmc_boot_partition() - eMMC boot partition to load U-Boot from.
373 * mmc: Pointer for the mmc device structure
375 * This function should return the eMMC boot partition number which
376 * the SPL should load U-Boot from (on the given boot_device).
378 * If not overridden, it is weakly defined in common/spl/spl_mmc.c
379 * and calls default_spl_mmc_emmc_boot_partition();
381 int spl_mmc_emmc_boot_partition(struct mmc *mmc);
383 void spl_set_bd(void);
386 * spl_set_header_raw_uboot() - Set up a standard SPL image structure
388 * This sets up the given spl_image which the standard values obtained from
389 * config options: CONFIG_SYS_MONITOR_LEN, CONFIG_SYS_UBOOT_START,
390 * CONFIG_SYS_TEXT_BASE.
392 * @spl_image: Image description to set up
394 void spl_set_header_raw_uboot(struct spl_image_info *spl_image);
397 * spl_parse_image_header() - parse the image header and set up info
399 * This parses the legacy image header information at @header and sets up
400 * @spl_image according to what is found. If no image header is found, then
401 * a raw image or bootz is assumed. If CONFIG_SPL_PANIC_ON_RAW_IMAGE is
402 * enabled, then this causes a panic. If CONFIG_SPL_RAW_IMAGE_SUPPORT is not
403 * enabled then U-Boot gives up. Otherwise U-Boot sets up the image using
404 * spl_set_header_raw_uboot(), or possibly the bootz header.
406 * @spl_image: Image description to set up
407 * @header image header to parse
408 * @return 0 if a header was correctly parsed, -ve on error
410 int spl_parse_image_header(struct spl_image_info *spl_image,
411 const struct image_header *header);
413 void spl_board_prepare_for_linux(void);
414 void spl_board_prepare_for_boot(void);
415 int spl_board_ubi_load_image(u32 boot_device);
416 int spl_board_boot_device(u32 boot_device);
419 * jump_to_image_linux() - Jump to a Linux kernel from SPL
421 * This jumps into a Linux kernel using the information in @spl_image.
423 * @spl_image: Image description to set up
425 void __noreturn jump_to_image_linux(struct spl_image_info *spl_image);
428 * spl_start_uboot() - Check if SPL should start the kernel or U-Boot
430 * This is called by the various SPL loaders to determine whether the board
431 * wants to load the kernel or U-Boot. This function should be provided by
434 * @return 0 if SPL should start the kernel, 1 if U-Boot must be started
436 int spl_start_uboot(void);
439 * spl_display_print() - Display a board-specific message in SPL
441 * If CONFIG_SPL_DISPLAY_PRINT is enabled, U-Boot will call this function
442 * immediately after displaying the SPL console banner ("U-Boot SPL ...").
443 * This function should be provided by the board.
445 void spl_display_print(void);
448 * struct spl_boot_device - Describes a boot device used by SPL
450 * @boot_device: A number indicating the BOOT_DEVICE type. There are various
451 * BOOT_DEVICE... #defines and enums in U-Boot and they are not consistently
453 * @boot_device_name: Named boot device, or NULL if none.
455 * Note: Additional fields can be added here, bearing in mind that SPL is
456 * size-sensitive and common fields will be present on all boards. This
457 * struct can also be used to return additional information about the load
458 * process if that becomes useful.
460 struct spl_boot_device {
462 const char *boot_device_name;
466 * Holds information about a way of loading an SPL image
468 * @name: User-friendly name for this method (e.g. "MMC")
469 * @boot_device: Boot device that this loader supports
470 * @load_image: Function to call to load image
472 struct spl_image_loader {
473 #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
478 * load_image() - Load an SPL image
480 * @spl_image: place to put image information
481 * @bootdev: describes the boot device to load from
483 int (*load_image)(struct spl_image_info *spl_image,
484 struct spl_boot_device *bootdev);
487 /* Declare an SPL image loader */
488 #define SPL_LOAD_IMAGE(__name) \
489 ll_entry_declare(struct spl_image_loader, __name, spl_image_loader)
492 * _priority is the priority of this method, 0 meaning it will be the top
493 * choice for this device, 9 meaning it is the bottom choice.
494 * _boot_device is the BOOT_DEVICE_... value
495 * _method is the load_image function to call
497 #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
498 #define SPL_LOAD_IMAGE_METHOD(_name, _priority, _boot_device, _method) \
499 SPL_LOAD_IMAGE(_boot_device ## _priority ## _method) = { \
501 .boot_device = _boot_device, \
502 .load_image = _method, \
505 #define SPL_LOAD_IMAGE_METHOD(_name, _priority, _boot_device, _method) \
506 SPL_LOAD_IMAGE(_boot_device ## _priority ## _method) = { \
507 .boot_device = _boot_device, \
508 .load_image = _method, \
512 /* SPL FAT image functions */
513 int spl_load_image_fat(struct spl_image_info *spl_image,
514 struct blk_desc *block_dev, int partition,
515 const char *filename);
516 int spl_load_image_fat_os(struct spl_image_info *spl_image,
517 struct blk_desc *block_dev, int partition);
519 void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image);
521 /* SPL EXT image functions */
522 int spl_load_image_ext(struct spl_image_info *spl_image,
523 struct blk_desc *block_dev, int partition,
524 const char *filename);
525 int spl_load_image_ext_os(struct spl_image_info *spl_image,
526 struct blk_desc *block_dev, int partition);
529 * spl_early_init() - Set up device tree and driver model in SPL if enabled
531 * Call this function in board_init_f() if you want to use device tree and
532 * driver model early, before board_init_r() is called.
534 * If this is not called, then driver model will be inactive in SPL's
535 * board_init_f(), and no device tree will be available.
537 int spl_early_init(void);
540 * spl_init() - Set up device tree and driver model in SPL if enabled
542 * You can optionally call spl_early_init(), then optionally call spl_init().
543 * This function will be called from board_init_r() if not called earlier.
545 * Both spl_early_init() and spl_init() perform a similar function except that
546 * the latter will not set up the malloc() area if
547 * CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN is enabled, since it is assumed to
548 * already be done by a calll to spl_relocate_stack_gd() before board_init_r()
551 * This function will be called from board_init_r() if not called earlier.
553 * If this is not called, then driver model will be inactive in SPL's
554 * board_init_f(), and no device tree will be available.
558 #ifdef CONFIG_SPL_BOARD_INIT
559 void spl_board_init(void);
563 * spl_was_boot_source() - check if U-Boot booted from SPL
565 * This will normally be true, but if U-Boot jumps to second U-Boot, it will
566 * be false. This should be implemented by board-specific code.
568 * @return true if U-Boot booted from SPL, else false
570 bool spl_was_boot_source(void);
573 * spl_dfu_cmd- run dfu command with chosen mmc device interface
574 * @param usb_index - usb controller number
575 * @param mmc_dev - mmc device nubmer
577 * @return 0 on success, otherwise error code
579 int spl_dfu_cmd(int usbctrl, char *dfu_alt_info, char *interface, char *devstr);
581 int spl_mmc_load_image(struct spl_image_info *spl_image,
582 struct spl_boot_device *bootdev);
585 * spl_mmc_load() - Load an image file from MMC/SD media
587 * @param spl_image Image data filled in by loading process
588 * @param bootdev Describes which device to load from
589 * @param filename Name of file to load (in FS mode)
590 * @param raw_part Partition to load from (in RAW mode)
591 * @param raw_sect Sector to load from (in RAW mode)
593 * @return 0 on success, otherwise error code
595 int spl_mmc_load(struct spl_image_info *spl_image,
596 struct spl_boot_device *bootdev,
597 const char *filename,
599 unsigned long raw_sect);
602 * spl_usb_load() - Load an image file from USB mass storage
604 * @param spl_image Image data filled in by loading process
605 * @param bootdev Describes which device to load from
606 * @param raw_part Fat partition to load from
607 * @param filename Name of file to load
609 * @return 0 on success, otherwise error code
611 int spl_usb_load(struct spl_image_info *spl_image,
612 struct spl_boot_device *bootdev,
613 int partition, const char *filename);
615 int spl_ymodem_load_image(struct spl_image_info *spl_image,
616 struct spl_boot_device *bootdev);
619 * spl_invoke_atf - boot using an ARM trusted firmware image
621 void spl_invoke_atf(struct spl_image_info *spl_image);
624 * bl2_plat_get_bl31_params() - return params for bl31.
625 * @bl32_entry: address of BL32 executable (secure)
626 * @bl33_entry: address of BL33 executable (non secure)
627 * @fdt_addr: address of Flat Device Tree
629 * This is a weak function which might be overridden by the board code. By
630 * default it will just call bl2_plat_get_bl31_params_default().
632 * If you just want to manipulate or add some parameters, you can override
633 * this function, call bl2_plat_get_bl31_params_default and operate on the
634 * returned bl31 params.
636 * Return: bl31 params structure pointer
638 struct bl31_params *bl2_plat_get_bl31_params(uintptr_t bl32_entry,
639 uintptr_t bl33_entry,
643 * bl2_plat_get_bl31_params_default() - prepare params for bl31.
644 * @bl32_entry: address of BL32 executable (secure)
645 * @bl33_entry: address of BL33 executable (non secure)
646 * @fdt_addr: address of Flat Device Tree
648 * This is the default implementation of bl2_plat_get_bl31_params(). It assigns
649 * a pointer to the memory that the platform has kept aside to pass platform
650 * specific and trusted firmware related information to BL31. This memory is
651 * allocated by allocating memory to bl2_to_bl31_params_mem structure which is
652 * a superset of all the structure whose information is passed to BL31
654 * NOTE: The memory is statically allocated, thus this function should be
655 * called only once. All subsequent calls will overwrite any changes.
657 * Return: bl31 params structure pointer
659 struct bl31_params *bl2_plat_get_bl31_params_default(uintptr_t bl32_entry,
660 uintptr_t bl33_entry,
664 * bl2_plat_get_bl31_params_v2() - return params for bl31
665 * @bl32_entry: address of BL32 executable (secure)
666 * @bl33_entry: address of BL33 executable (non secure)
667 * @fdt_addr: address of Flat Device Tree
669 * This function does the same as bl2_plat_get_bl31_params() except that is is
670 * used for the new LOAD_IMAGE_V2 option, which uses a slightly different
671 * method to pass the parameters.
673 * Return: bl31 params structure pointer
675 struct bl_params *bl2_plat_get_bl31_params_v2(uintptr_t bl32_entry,
676 uintptr_t bl33_entry,
680 * bl2_plat_get_bl31_params_v2_default() - prepare params for bl31.
681 * @bl32_entry: address of BL32 executable (secure)
682 * @bl33_entry: address of BL33 executable (non secure)
683 * @fdt_addr: address of Flat Device Tree
685 * This is the default implementation of bl2_plat_get_bl31_params_v2(). It
686 * prepares the linked list of the bl31 params, populates the image types and
687 * set the entry points for bl32 and bl33 (if available).
689 * NOTE: The memory is statically allocated, thus this function should be
690 * called only once. All subsequent calls will overwrite any changes.
692 * Return: bl31 params structure pointer
694 struct bl_params *bl2_plat_get_bl31_params_v2_default(uintptr_t bl32_entry,
695 uintptr_t bl33_entry,
698 * spl_optee_entry - entry function for optee
700 * args defind in op-tee project
701 * https://github.com/OP-TEE/optee_os/
702 * core/arch/arm/kernel/generic_entry_a32.S
704 * @arg1: (ARMv7 standard bootarg #1)
705 * @arg2: device tree address, (ARMv7 standard bootarg #2)
706 * @arg3: non-secure entry address (ARMv7 bootarg #0)
708 void spl_optee_entry(void *arg0, void *arg1, void *arg2, void *arg3);
711 * spl_invoke_opensbi - boot using a RISC-V OpenSBI image
713 void spl_invoke_opensbi(struct spl_image_info *spl_image);
716 * board_return_to_bootrom - allow for boards to continue with the boot ROM
718 * If a board (e.g. the Rockchip RK3368 boards) provide some
719 * supporting functionality for SPL in their boot ROM and the SPL
720 * stage wants to return to the ROM code to continue booting, boards
721 * can implement 'board_return_to_bootrom'.
723 int board_return_to_bootrom(struct spl_image_info *spl_image,
724 struct spl_boot_device *bootdev);
727 * board_spl_fit_post_load - allow process images after loading finished
728 * @fit: Pointer to a valid Flattened Image Tree blob
730 void board_spl_fit_post_load(const void *fit);
733 * board_spl_fit_size_align - specific size align before processing payload
736 ulong board_spl_fit_size_align(ulong size);
739 * spl_perform_fixups() - arch/board-specific callback before processing
742 void spl_perform_fixups(struct spl_image_info *spl_image);
745 * spl_get_load_buffer() - get buffer for loading partial image data
747 * Returns memory area which can be populated by partial image data,
748 * ie. uImage or fitImage header.
750 struct image_header *spl_get_load_buffer(ssize_t offset, size_t size);
752 void spl_save_restore_data(void);