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;
225 ulong (*read)(struct spl_load_info *load, ulong sector, ulong count,
230 * We need to know the position of U-Boot in memory so we can jump to it. We
231 * allow any U-Boot binary to be used (u-boot.bin, u-boot-nodtb.bin,
232 * u-boot.img), hence the '_any'. These is no checking here that the correct
233 * image is found. For example if u-boot.img is used we don't check that
234 * spl_parse_image_header() can parse a valid header.
236 * Similarly for SPL, so that TPL can jump to SPL.
238 binman_sym_extern(ulong, u_boot_any, image_pos);
239 binman_sym_extern(ulong, u_boot_any, size);
240 binman_sym_extern(ulong, spl, image_pos);
241 binman_sym_extern(ulong, spl, size);
244 * spl_get_image_pos() - get the image position of the next phase
246 * This returns the image position to use to load the next phase of U-Boot
248 ulong spl_get_image_pos(void);
251 * spl_get_image_size() - get the size of the next phase
253 * This returns the size to use to load the next phase of U-Boot
255 ulong spl_get_image_size(void);
258 * spl_load_simple_fit_skip_processing() - Hook to allow skipping the FIT
259 * image processing during spl_load_simple_fit().
261 * Return true to skip FIT processing, false to preserve the full code flow
262 * of spl_load_simple_fit().
264 bool spl_load_simple_fit_skip_processing(void);
267 * spl_load_simple_fit() - Loads a fit image from a device.
268 * @spl_image: Image description to set up
269 * @info: Structure containing the information required to load data.
270 * @sector: Sector number where FIT image is located in the device
271 * @fdt: Pointer to the copied FIT header.
273 * Reads the FIT image @sector in the device. Loads u-boot image to
274 * specified load address and copies the dtb to end of u-boot image.
275 * Returns 0 on success.
277 int spl_load_simple_fit(struct spl_image_info *spl_image,
278 struct spl_load_info *info, ulong sector, void *fdt);
280 #define SPL_COPY_PAYLOAD_ONLY 1
281 #define SPL_FIT_FOUND 2
284 * spl_load_legacy_img() - Loads a legacy image from a device.
285 * @spl_image: Image description to set up
286 * @load: Structure containing the information required to load data.
287 * @header: Pointer to image header (including appended image)
289 * Reads an legacy image from the device. Loads u-boot image to
290 * specified load address.
291 * Returns 0 on success.
293 int spl_load_legacy_img(struct spl_image_info *spl_image,
294 struct spl_load_info *load, ulong header);
297 * spl_load_imx_container() - Loads a imx container image from a device.
298 * @spl_image: Image description to set up
299 * @info: Structure containing the information required to load data.
300 * @sector: Sector number where container image is located in the device
302 * Reads the container image @sector in the device. Loads u-boot image to
303 * specified load address.
305 int spl_load_imx_container(struct spl_image_info *spl_image,
306 struct spl_load_info *info, ulong sector);
308 /* SPL common functions */
309 void preloader_console_init(void);
310 u32 spl_boot_device(void);
313 * spl_mmc_boot_mode() - Lookup function for the mode of an MMC boot source.
314 * @boot_device: ID of the device which the MMC driver wants to read
315 * from. Common values are e.g. BOOT_DEVICE_MMC1,
316 * BOOT_DEVICE_MMC2, BOOT_DEVICE_MMC2_2.
318 * This function should return one of MMCSD_MODE_FS, MMCSD_MODE_EMMCBOOT, or
319 * MMCSD_MODE_RAW for each MMC boot source which is defined for the target. The
320 * boot_device parameter tells which device the MMC driver is interested in.
322 * If not overridden, it is weakly defined in common/spl/spl_mmc.c.
324 * Note: It is important to use the boot_device parameter instead of e.g.
325 * spl_boot_device() as U-Boot is not always loaded from the same device as SPL.
327 u32 spl_mmc_boot_mode(const u32 boot_device);
330 * spl_mmc_boot_partition() - MMC partition to load U-Boot from.
331 * @boot_device: ID of the device which the MMC driver wants to load
334 * This function should return the partition number which the SPL
335 * should load U-Boot from (on the given boot_device) when
336 * CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_USE_PARTITION is set.
338 * If not overridden, it is weakly defined in common/spl/spl_mmc.c.
340 int spl_mmc_boot_partition(const u32 boot_device);
343 * spl_alloc_bd() - Allocate space for bd_info
345 * This sets up the gd->bd pointer by allocating memory for it
347 * @return 0 if OK, -ENOMEM if out of memory
349 int spl_alloc_bd(void);
352 * spl_set_header_raw_uboot() - Set up a standard SPL image structure
354 * This sets up the given spl_image which the standard values obtained from
355 * config options: CONFIG_SYS_MONITOR_LEN, CONFIG_SYS_UBOOT_START,
356 * CONFIG_SYS_TEXT_BASE.
358 * @spl_image: Image description to set up
360 void spl_set_header_raw_uboot(struct spl_image_info *spl_image);
363 * spl_parse_image_header() - parse the image header and set up info
365 * This parses the legacy image header information at @header and sets up
366 * @spl_image according to what is found. If no image header is found, then
367 * a raw image or bootz is assumed. If CONFIG_SPL_PANIC_ON_RAW_IMAGE is
368 * enabled, then this causes a panic. If CONFIG_SPL_RAW_IMAGE_SUPPORT is not
369 * enabled then U-Boot gives up. Otherwise U-Boot sets up the image using
370 * spl_set_header_raw_uboot(), or possibly the bootz header.
372 * @spl_image: Image description to set up
373 * @header image header to parse
374 * @return 0 if a header was correctly parsed, -ve on error
376 int spl_parse_image_header(struct spl_image_info *spl_image,
377 const struct image_header *header);
379 void spl_board_prepare_for_linux(void);
380 void spl_board_prepare_for_boot(void);
381 int spl_board_ubi_load_image(u32 boot_device);
382 int spl_board_boot_device(u32 boot_device);
385 * jump_to_image_linux() - Jump to a Linux kernel from SPL
387 * This jumps into a Linux kernel using the information in @spl_image.
389 * @spl_image: Image description to set up
391 void __noreturn jump_to_image_linux(struct spl_image_info *spl_image);
394 * spl_start_uboot() - Check if SPL should start the kernel or U-Boot
396 * This is called by the various SPL loaders to determine whether the board
397 * wants to load the kernel or U-Boot. This function should be provided by
400 * @return 0 if SPL should start the kernel, 1 if U-Boot must be started
402 int spl_start_uboot(void);
405 * spl_display_print() - Display a board-specific message in SPL
407 * If CONFIG_SPL_DISPLAY_PRINT is enabled, U-Boot will call this function
408 * immediately after displaying the SPL console banner ("U-Boot SPL ...").
409 * This function should be provided by the board.
411 void spl_display_print(void);
414 * struct spl_boot_device - Describes a boot device used by SPL
416 * @boot_device: A number indicating the BOOT_DEVICE type. There are various
417 * BOOT_DEVICE... #defines and enums in U-Boot and they are not consistently
419 * @boot_device_name: Named boot device, or NULL if none.
421 * Note: Additional fields can be added here, bearing in mind that SPL is
422 * size-sensitive and common fields will be present on all boards. This
423 * struct can also be used to return additional information about the load
424 * process if that becomes useful.
426 struct spl_boot_device {
428 const char *boot_device_name;
432 * Holds information about a way of loading an SPL image
434 * @name: User-friendly name for this method (e.g. "MMC")
435 * @boot_device: Boot device that this loader supports
436 * @load_image: Function to call to load image
438 struct spl_image_loader {
439 #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
444 * load_image() - Load an SPL image
446 * @spl_image: place to put image information
447 * @bootdev: describes the boot device to load from
449 int (*load_image)(struct spl_image_info *spl_image,
450 struct spl_boot_device *bootdev);
453 /* Declare an SPL image loader */
454 #define SPL_LOAD_IMAGE(__name) \
455 ll_entry_declare(struct spl_image_loader, __name, spl_image_loader)
458 * _priority is the priority of this method, 0 meaning it will be the top
459 * choice for this device, 9 meaning it is the bottom choice.
460 * _boot_device is the BOOT_DEVICE_... value
461 * _method is the load_image function to call
463 #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
464 #define SPL_LOAD_IMAGE_METHOD(_name, _priority, _boot_device, _method) \
465 SPL_LOAD_IMAGE(_boot_device ## _priority ## _method) = { \
467 .boot_device = _boot_device, \
468 .load_image = _method, \
471 #define SPL_LOAD_IMAGE_METHOD(_name, _priority, _boot_device, _method) \
472 SPL_LOAD_IMAGE(_boot_device ## _priority ## _method) = { \
473 .boot_device = _boot_device, \
474 .load_image = _method, \
478 /* SPL FAT image functions */
479 int spl_load_image_fat(struct spl_image_info *spl_image,
480 struct blk_desc *block_dev, int partition,
481 const char *filename);
482 int spl_load_image_fat_os(struct spl_image_info *spl_image,
483 struct blk_desc *block_dev, int partition);
485 void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image);
487 /* SPL EXT image functions */
488 int spl_load_image_ext(struct spl_image_info *spl_image,
489 struct blk_desc *block_dev, int partition,
490 const char *filename);
491 int spl_load_image_ext_os(struct spl_image_info *spl_image,
492 struct blk_desc *block_dev, int partition);
495 * spl_early_init() - Set up device tree and driver model in SPL if enabled
497 * Call this function in board_init_f() if you want to use device tree and
498 * driver model early, before board_init_r() is called.
500 * If this is not called, then driver model will be inactive in SPL's
501 * board_init_f(), and no device tree will be available.
503 int spl_early_init(void);
506 * spl_init() - Set up device tree and driver model in SPL if enabled
508 * You can optionally call spl_early_init(), then optionally call spl_init().
509 * This function will be called from board_init_r() if not called earlier.
511 * Both spl_early_init() and spl_init() perform a similar function except that
512 * the latter will not set up the malloc() area if
513 * CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN is enabled, since it is assumed to
514 * already be done by a calll to spl_relocate_stack_gd() before board_init_r()
517 * This function will be called from board_init_r() if not called earlier.
519 * If this is not called, then driver model will be inactive in SPL's
520 * board_init_f(), and no device tree will be available.
524 #ifdef CONFIG_SPL_BOARD_INIT
525 void spl_board_init(void);
529 * spl_was_boot_source() - check if U-Boot booted from SPL
531 * This will normally be true, but if U-Boot jumps to second U-Boot, it will
532 * be false. This should be implemented by board-specific code.
534 * @return true if U-Boot booted from SPL, else false
536 bool spl_was_boot_source(void);
539 * spl_dfu_cmd- run dfu command with chosen mmc device interface
540 * @param usb_index - usb controller number
541 * @param mmc_dev - mmc device nubmer
543 * @return 0 on success, otherwise error code
545 int spl_dfu_cmd(int usbctrl, char *dfu_alt_info, char *interface, char *devstr);
547 int spl_mmc_load_image(struct spl_image_info *spl_image,
548 struct spl_boot_device *bootdev);
551 * spl_mmc_load() - Load an image file from MMC/SD media
553 * @param spl_image Image data filled in by loading process
554 * @param bootdev Describes which device to load from
555 * @param filename Name of file to load (in FS mode)
556 * @param raw_part Partition to load from (in RAW mode)
557 * @param raw_sect Sector to load from (in RAW mode)
559 * @return 0 on success, otherwise error code
561 int spl_mmc_load(struct spl_image_info *spl_image,
562 struct spl_boot_device *bootdev,
563 const char *filename,
565 unsigned long raw_sect);
568 * spl_usb_load() - Load an image file from USB mass storage
570 * @param spl_image Image data filled in by loading process
571 * @param bootdev Describes which device to load from
572 * @param raw_part Fat partition to load from
573 * @param filename Name of file to load
575 * @return 0 on success, otherwise error code
577 int spl_usb_load(struct spl_image_info *spl_image,
578 struct spl_boot_device *bootdev,
579 int partition, const char *filename);
581 int spl_ymodem_load_image(struct spl_image_info *spl_image,
582 struct spl_boot_device *bootdev);
585 * spl_invoke_atf - boot using an ARM trusted firmware image
587 void spl_invoke_atf(struct spl_image_info *spl_image);
590 * bl2_plat_get_bl31_params() - return params for bl31.
591 * @bl32_entry: address of BL32 executable (secure)
592 * @bl33_entry: address of BL33 executable (non secure)
593 * @fdt_addr: address of Flat Device Tree
595 * This is a weak function which might be overridden by the board code. By
596 * default it will just call bl2_plat_get_bl31_params_default().
598 * If you just want to manipulate or add some parameters, you can override
599 * this function, call bl2_plat_get_bl31_params_default and operate on the
600 * returned bl31 params.
602 * Return: bl31 params structure pointer
604 struct bl31_params *bl2_plat_get_bl31_params(uintptr_t bl32_entry,
605 uintptr_t bl33_entry,
609 * bl2_plat_get_bl31_params_default() - prepare params for bl31.
610 * @bl32_entry: address of BL32 executable (secure)
611 * @bl33_entry: address of BL33 executable (non secure)
612 * @fdt_addr: address of Flat Device Tree
614 * This is the default implementation of bl2_plat_get_bl31_params(). It assigns
615 * a pointer to the memory that the platform has kept aside to pass platform
616 * specific and trusted firmware related information to BL31. This memory is
617 * allocated by allocating memory to bl2_to_bl31_params_mem structure which is
618 * a superset of all the structure whose information is passed to BL31
620 * NOTE: The memory is statically allocated, thus this function should be
621 * called only once. All subsequent calls will overwrite any changes.
623 * Return: bl31 params structure pointer
625 struct bl31_params *bl2_plat_get_bl31_params_default(uintptr_t bl32_entry,
626 uintptr_t bl33_entry,
630 * bl2_plat_get_bl31_params_v2() - return params for bl31
631 * @bl32_entry: address of BL32 executable (secure)
632 * @bl33_entry: address of BL33 executable (non secure)
633 * @fdt_addr: address of Flat Device Tree
635 * This function does the same as bl2_plat_get_bl31_params() except that is is
636 * used for the new LOAD_IMAGE_V2 option, which uses a slightly different
637 * method to pass the parameters.
639 * Return: bl31 params structure pointer
641 struct bl_params *bl2_plat_get_bl31_params_v2(uintptr_t bl32_entry,
642 uintptr_t bl33_entry,
646 * bl2_plat_get_bl31_params_v2_default() - prepare params for bl31.
647 * @bl32_entry: address of BL32 executable (secure)
648 * @bl33_entry: address of BL33 executable (non secure)
649 * @fdt_addr: address of Flat Device Tree
651 * This is the default implementation of bl2_plat_get_bl31_params_v2(). It
652 * prepares the linked list of the bl31 params, populates the image types and
653 * set the entry points for bl32 and bl33 (if available).
655 * NOTE: The memory is statically allocated, thus this function should be
656 * called only once. All subsequent calls will overwrite any changes.
658 * Return: bl31 params structure pointer
660 struct bl_params *bl2_plat_get_bl31_params_v2_default(uintptr_t bl32_entry,
661 uintptr_t bl33_entry,
664 * spl_optee_entry - entry function for optee
666 * args defind in op-tee project
667 * https://github.com/OP-TEE/optee_os/
668 * core/arch/arm/kernel/generic_entry_a32.S
670 * @arg1: (ARMv7 standard bootarg #1)
671 * @arg2: device tree address, (ARMv7 standard bootarg #2)
672 * @arg3: non-secure entry address (ARMv7 bootarg #0)
674 void spl_optee_entry(void *arg0, void *arg1, void *arg2, void *arg3);
677 * spl_invoke_opensbi - boot using a RISC-V OpenSBI image
679 void spl_invoke_opensbi(struct spl_image_info *spl_image);
682 * board_return_to_bootrom - allow for boards to continue with the boot ROM
684 * If a board (e.g. the Rockchip RK3368 boards) provide some
685 * supporting functionality for SPL in their boot ROM and the SPL
686 * stage wants to return to the ROM code to continue booting, boards
687 * can implement 'board_return_to_bootrom'.
689 int board_return_to_bootrom(struct spl_image_info *spl_image,
690 struct spl_boot_device *bootdev);
693 * board_spl_fit_post_load - allow process images after loading finished
696 void board_spl_fit_post_load(ulong load_addr, size_t length);
699 * board_spl_fit_size_align - specific size align before processing payload
702 ulong board_spl_fit_size_align(ulong size);
705 * spl_perform_fixups() - arch/board-specific callback before processing
708 void spl_perform_fixups(struct spl_image_info *spl_image);
711 * spl_get_load_buffer() - get buffer for loading partial image data
713 * Returns memory area which can be populated by partial image data,
714 * ie. uImage or fitImage header.
716 struct image_header *spl_get_load_buffer(ssize_t offset, size_t size);
718 void spl_save_restore_data(void);