3 * Texas Instruments, <www.ti.com>
5 * SPDX-License-Identifier: GPL-2.0+
10 /* Platform-specific defines */
11 #include <linux/compiler.h>
14 /* Value in r0 indicates we booted from U-Boot */
15 #define UBOOT_NOT_LOADED_FROM_SPL 0x13578642
18 #define MMCSD_MODE_UNDEFINED 0
19 #define MMCSD_MODE_RAW 1
20 #define MMCSD_MODE_FS 2
21 #define MMCSD_MODE_EMMCBOOT 3
23 struct spl_image_info {
33 * Information required to load data from a device
35 * @dev: Pointer to the device, e.g. struct mmc *
36 * @priv: Private data for the device
37 * @bl_len: Block length for reading in bytes
38 * @filename: Name of the fit image file.
39 * @read: Function to call to read from the device
41 struct spl_load_info {
46 ulong (*read)(struct spl_load_info *load, ulong sector, ulong count,
51 * spl_load_simple_fit() - Loads a fit image from a device.
52 * @info: Structure containing the information required to load data.
53 * @sector: Sector number where FIT image is located in the device
54 * @fdt: Pointer to the copied FIT header.
56 * Reads the FIT image @sector in the device. Loads u-boot image to
57 * specified load address and copies the dtb to end of u-boot image.
58 * Returns 0 on success.
60 int spl_load_simple_fit(struct spl_load_info *info, ulong sector, void *fdt);
62 #define SPL_COPY_PAYLOAD_ONLY 1
64 extern struct spl_image_info spl_image;
66 /* SPL common functions */
67 void preloader_console_init(void);
68 u32 spl_boot_device(void);
69 u32 spl_boot_mode(const u32 boot_device);
72 * spl_set_header_raw_uboot() - Set up a standard SPL image structure
74 * This sets up the given spl_image which the standard values obtained from
75 * config options: CONFIG_SYS_MONITOR_LEN, CONFIG_SYS_UBOOT_START,
76 * CONFIG_SYS_TEXT_BASE.
78 * @spl_image: Image description to set up
80 void spl_set_header_raw_uboot(struct spl_image_info *spl_image);
83 * spl_parse_image_header() - parse the image header and set up info
85 * This parses the legacy image header information at @header and sets up
86 * @spl_image according to what is found. If no image header is found, then
87 * a raw image or bootz is assumed. If CONFIG_SPL_PANIC_ON_RAW_IMAGE is
88 * enabled, then this causes a panic. If CONFIG_SPL_ABORT_ON_RAW_IMAGE is
89 * enabled then U-Boot gives up. Otherwise U-Boot sets up the image using
90 * spl_set_header_raw_uboot(), or possibly the bootz header.
92 * @spl_image: Image description to set up
93 * @header image header to parse
94 * @return 0 if a header was correctly parsed, -ve on error
96 int spl_parse_image_header(struct spl_image_info *spl_image,
97 const struct image_header *header);
99 void spl_board_prepare_for_linux(void);
100 void spl_board_prepare_for_boot(void);
101 int spl_board_ubi_load_image(u32 boot_device);
104 * jump_to_image_linux() - Jump to a Linux kernel from SPL
106 * This jumps into a Linux kernel using the information in @spl_image.
108 * @spl_image: Image description to set up
109 * @arg: Argument to pass to Linux (typically a device tree pointer)
111 void __noreturn jump_to_image_linux(struct spl_image_info *spl_image,
115 * spl_start_uboot() - Check if SPL should start the kernel or U-Boot
117 * This is called by the various SPL loaders to determine whether the board
118 * wants to load the kernel or U-Boot. This function should be provided by
121 * @return 0 if SPL should start the kernel, 1 if U-Boot must be started
123 int spl_start_uboot(void);
126 * spl_display_print() - Display a board-specific message in SPL
128 * If CONFIG_SPL_DISPLAY_PRINT is enabled, U-Boot will call this function
129 * immediately after displaying the SPL console banner ("U-Boot SPL ...").
130 * This function should be provided by the board.
132 void spl_display_print(void);
134 /* NAND SPL functions */
135 int spl_nand_load_image(void);
137 /* OneNAND SPL functions */
138 int spl_onenand_load_image(void);
140 /* NOR SPL functions */
141 int spl_nor_load_image(void);
143 /* UBI SPL functions */
144 int spl_ubi_load_image(u32 boot_device);
146 /* MMC SPL functions */
147 int spl_mmc_load_image(u32 boot_device);
149 /* YMODEM SPL functions */
150 int spl_ymodem_load_image(void);
152 /* SPI SPL functions */
153 int spl_spi_load_image(void);
155 /* Ethernet SPL functions */
156 int spl_net_load_image(const char *device);
158 /* USB SPL functions */
159 int spl_usb_load_image(void);
161 /* SATA SPL functions */
162 int spl_sata_load_image(void);
164 /* SPL FAT image functions */
165 int spl_load_image_fat(struct blk_desc *block_dev, int partition,
166 const char *filename);
167 int spl_load_image_fat_os(struct blk_desc *block_dev, int partition);
169 void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image);
171 /* SPL EXT image functions */
172 int spl_load_image_ext(struct blk_desc *block_dev, int partition,
173 const char *filename);
174 int spl_load_image_ext_os(struct blk_desc *block_dev, int partition);
177 * spl_init() - Set up device tree and driver model in SPL if enabled
179 * Call this function in board_init_f() if you want to use device tree and
180 * driver model early, before board_init_r() is called. This function will
181 * be called from board_init_r() if not called earlier.
183 * If this is not called, then driver model will be inactive in SPL's
184 * board_init_f(), and no device tree will be available.
188 #ifdef CONFIG_SPL_BOARD_INIT
189 void spl_board_init(void);
193 * spl_was_boot_source() - check if U-Boot booted from SPL
195 * This will normally be true, but if U-Boot jumps to second U-Boot, it will
196 * be false. This should be implemented by board-specific code.
198 * @return true if U-Boot booted from SPL, else false
200 bool spl_was_boot_source(void);
203 * spl_dfu_cmd- run dfu command with chosen mmc device interface
204 * @param usb_index - usb controller number
205 * @param mmc_dev - mmc device nubmer
207 * @return 0 on success, otherwise error code
209 int spl_dfu_cmd(int usbctrl, char *dfu_alt_info, char *interface, char *devstr);
212 * Board-specific load method for boards that have a special way of loading
213 * U-Boot, which does not fit with the existing SPL code.
215 * @return 0 on success, negative errno value on failure.
217 int spl_board_load_image(void);