]>
Commit | Line | Data |
---|---|---|
1 | /* | |
2 | * (C) Copyright 2012 | |
3 | * Texas Instruments, <www.ti.com> | |
4 | * | |
5 | * SPDX-License-Identifier: GPL-2.0+ | |
6 | */ | |
7 | #ifndef _SPL_H_ | |
8 | #define _SPL_H_ | |
9 | ||
10 | #include <binman_sym.h> | |
11 | ||
12 | /* Platform-specific defines */ | |
13 | #include <linux/compiler.h> | |
14 | #include <asm/spl.h> | |
15 | ||
16 | /* Value in r0 indicates we booted from U-Boot */ | |
17 | #define UBOOT_NOT_LOADED_FROM_SPL 0x13578642 | |
18 | ||
19 | /* Boot type */ | |
20 | #define MMCSD_MODE_UNDEFINED 0 | |
21 | #define MMCSD_MODE_RAW 1 | |
22 | #define MMCSD_MODE_FS 2 | |
23 | #define MMCSD_MODE_EMMCBOOT 3 | |
24 | ||
25 | struct spl_image_info { | |
26 | const char *name; | |
27 | u8 os; | |
28 | uintptr_t load_addr; | |
29 | uintptr_t entry_point; | |
30 | #if CONFIG_IS_ENABLED(LOAD_FIT) | |
31 | void *fdt_addr; | |
32 | #endif | |
33 | u32 size; | |
34 | u32 flags; | |
35 | void *arg; | |
36 | }; | |
37 | ||
38 | /* | |
39 | * Information required to load data from a device | |
40 | * | |
41 | * @dev: Pointer to the device, e.g. struct mmc * | |
42 | * @priv: Private data for the device | |
43 | * @bl_len: Block length for reading in bytes | |
44 | * @filename: Name of the fit image file. | |
45 | * @read: Function to call to read from the device | |
46 | */ | |
47 | struct spl_load_info { | |
48 | void *dev; | |
49 | void *priv; | |
50 | int bl_len; | |
51 | const char *filename; | |
52 | ulong (*read)(struct spl_load_info *load, ulong sector, ulong count, | |
53 | void *buf); | |
54 | }; | |
55 | ||
56 | /* | |
57 | * We need to know the position of U-Boot in memory so we can jump to it. We | |
58 | * allow any U-Boot binary to be used (u-boot.bin, u-boot-nodtb.bin, | |
59 | * u-boot.img), hence the '_any'. These is no checking here that the correct | |
60 | * image is found. For * example if u-boot.img is used we don't check that | |
61 | * spl_parse_image_header() can parse a valid header. | |
62 | */ | |
63 | binman_sym_extern(ulong, u_boot_any, pos); | |
64 | ||
65 | /** | |
66 | * spl_load_simple_fit() - Loads a fit image from a device. | |
67 | * @spl_image: Image description to set up | |
68 | * @info: Structure containing the information required to load data. | |
69 | * @sector: Sector number where FIT image is located in the device | |
70 | * @fdt: Pointer to the copied FIT header. | |
71 | * | |
72 | * Reads the FIT image @sector in the device. Loads u-boot image to | |
73 | * specified load address and copies the dtb to end of u-boot image. | |
74 | * Returns 0 on success. | |
75 | */ | |
76 | int spl_load_simple_fit(struct spl_image_info *spl_image, | |
77 | struct spl_load_info *info, ulong sector, void *fdt); | |
78 | ||
79 | #define SPL_COPY_PAYLOAD_ONLY 1 | |
80 | ||
81 | /* SPL common functions */ | |
82 | void preloader_console_init(void); | |
83 | u32 spl_boot_device(void); | |
84 | u32 spl_boot_mode(const u32 boot_device); | |
85 | void spl_set_bd(void); | |
86 | ||
87 | /** | |
88 | * spl_set_header_raw_uboot() - Set up a standard SPL image structure | |
89 | * | |
90 | * This sets up the given spl_image which the standard values obtained from | |
91 | * config options: CONFIG_SYS_MONITOR_LEN, CONFIG_SYS_UBOOT_START, | |
92 | * CONFIG_SYS_TEXT_BASE. | |
93 | * | |
94 | * @spl_image: Image description to set up | |
95 | */ | |
96 | void spl_set_header_raw_uboot(struct spl_image_info *spl_image); | |
97 | ||
98 | /** | |
99 | * spl_parse_image_header() - parse the image header and set up info | |
100 | * | |
101 | * This parses the legacy image header information at @header and sets up | |
102 | * @spl_image according to what is found. If no image header is found, then | |
103 | * a raw image or bootz is assumed. If CONFIG_SPL_PANIC_ON_RAW_IMAGE is | |
104 | * enabled, then this causes a panic. If CONFIG_SPL_RAW_IMAGE_SUPPORT is not | |
105 | * enabled then U-Boot gives up. Otherwise U-Boot sets up the image using | |
106 | * spl_set_header_raw_uboot(), or possibly the bootz header. | |
107 | * | |
108 | * @spl_image: Image description to set up | |
109 | * @header image header to parse | |
110 | * @return 0 if a header was correctly parsed, -ve on error | |
111 | */ | |
112 | int spl_parse_image_header(struct spl_image_info *spl_image, | |
113 | const struct image_header *header); | |
114 | ||
115 | void spl_board_prepare_for_linux(void); | |
116 | void spl_board_prepare_for_boot(void); | |
117 | int spl_board_ubi_load_image(u32 boot_device); | |
118 | ||
119 | /** | |
120 | * jump_to_image_linux() - Jump to a Linux kernel from SPL | |
121 | * | |
122 | * This jumps into a Linux kernel using the information in @spl_image. | |
123 | * | |
124 | * @spl_image: Image description to set up | |
125 | */ | |
126 | void __noreturn jump_to_image_linux(struct spl_image_info *spl_image); | |
127 | ||
128 | /** | |
129 | * spl_start_uboot() - Check if SPL should start the kernel or U-Boot | |
130 | * | |
131 | * This is called by the various SPL loaders to determine whether the board | |
132 | * wants to load the kernel or U-Boot. This function should be provided by | |
133 | * the board. | |
134 | * | |
135 | * @return 0 if SPL should start the kernel, 1 if U-Boot must be started | |
136 | */ | |
137 | int spl_start_uboot(void); | |
138 | ||
139 | /** | |
140 | * spl_display_print() - Display a board-specific message in SPL | |
141 | * | |
142 | * If CONFIG_SPL_DISPLAY_PRINT is enabled, U-Boot will call this function | |
143 | * immediately after displaying the SPL console banner ("U-Boot SPL ..."). | |
144 | * This function should be provided by the board. | |
145 | */ | |
146 | void spl_display_print(void); | |
147 | ||
148 | /** | |
149 | * struct spl_boot_device - Describes a boot device used by SPL | |
150 | * | |
151 | * @boot_device: A number indicating the BOOT_DEVICE type. There are various | |
152 | * BOOT_DEVICE... #defines and enums in U-Boot and they are not consistently | |
153 | * numbered. | |
154 | * @boot_device_name: Named boot device, or NULL if none. | |
155 | * | |
156 | * Note: Additional fields can be added here, bearing in mind that SPL is | |
157 | * size-sensitive and common fields will be present on all boards. This | |
158 | * struct can also be used to return additional information about the load | |
159 | * process if that becomes useful. | |
160 | */ | |
161 | struct spl_boot_device { | |
162 | uint boot_device; | |
163 | const char *boot_device_name; | |
164 | }; | |
165 | ||
166 | /** | |
167 | * Holds information about a way of loading an SPL image | |
168 | * | |
169 | * @name: User-friendly name for this method (e.g. "MMC") | |
170 | * @boot_device: Boot device that this loader supports | |
171 | * @load_image: Function to call to load image | |
172 | */ | |
173 | struct spl_image_loader { | |
174 | #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT | |
175 | const char *name; | |
176 | #endif | |
177 | uint boot_device; | |
178 | /** | |
179 | * load_image() - Load an SPL image | |
180 | * | |
181 | * @spl_image: place to put image information | |
182 | * @bootdev: describes the boot device to load from | |
183 | */ | |
184 | int (*load_image)(struct spl_image_info *spl_image, | |
185 | struct spl_boot_device *bootdev); | |
186 | }; | |
187 | ||
188 | /* Declare an SPL image loader */ | |
189 | #define SPL_LOAD_IMAGE(__name) \ | |
190 | ll_entry_declare(struct spl_image_loader, __name, spl_image_loader) | |
191 | ||
192 | /* | |
193 | * _priority is the priority of this method, 0 meaning it will be the top | |
194 | * choice for this device, 9 meaning it is the bottom choice. | |
195 | * _boot_device is the BOOT_DEVICE_... value | |
196 | * _method is the load_image function to call | |
197 | */ | |
198 | #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT | |
199 | #define SPL_LOAD_IMAGE_METHOD(_name, _priority, _boot_device, _method) \ | |
200 | SPL_LOAD_IMAGE(_method ## _priority ## _boot_device) = { \ | |
201 | .name = _name, \ | |
202 | .boot_device = _boot_device, \ | |
203 | .load_image = _method, \ | |
204 | } | |
205 | #else | |
206 | #define SPL_LOAD_IMAGE_METHOD(_name, _priority, _boot_device, _method) \ | |
207 | SPL_LOAD_IMAGE(_method ## _priority ## _boot_device) = { \ | |
208 | .boot_device = _boot_device, \ | |
209 | .load_image = _method, \ | |
210 | } | |
211 | #endif | |
212 | ||
213 | /* SPL FAT image functions */ | |
214 | int spl_load_image_fat(struct spl_image_info *spl_image, | |
215 | struct blk_desc *block_dev, int partition, | |
216 | const char *filename); | |
217 | int spl_load_image_fat_os(struct spl_image_info *spl_image, | |
218 | struct blk_desc *block_dev, int partition); | |
219 | ||
220 | void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image); | |
221 | ||
222 | /* SPL EXT image functions */ | |
223 | int spl_load_image_ext(struct spl_image_info *spl_image, | |
224 | struct blk_desc *block_dev, int partition, | |
225 | const char *filename); | |
226 | int spl_load_image_ext_os(struct spl_image_info *spl_image, | |
227 | struct blk_desc *block_dev, int partition); | |
228 | ||
229 | /** | |
230 | * spl_early_init() - Set up device tree and driver model in SPL if enabled | |
231 | * | |
232 | * Call this function in board_init_f() if you want to use device tree and | |
233 | * driver model early, before board_init_r() is called. | |
234 | * | |
235 | * If this is not called, then driver model will be inactive in SPL's | |
236 | * board_init_f(), and no device tree will be available. | |
237 | */ | |
238 | int spl_early_init(void); | |
239 | ||
240 | /** | |
241 | * spl_init() - Set up device tree and driver model in SPL if enabled | |
242 | * | |
243 | * You can optionally call spl_early_init(), then optionally call spl_init(). | |
244 | * This function will be called from board_init_r() if not called earlier. | |
245 | * | |
246 | * Both spl_early_init() and spl_init() perform a similar function except that | |
247 | * the latter will not set up the malloc() area if | |
248 | * CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN is enabled, since it is assumed to | |
249 | * already be done by a calll to spl_relocate_stack_gd() before board_init_r() | |
250 | * is reached. | |
251 | * | |
252 | * This function will be called from board_init_r() if not called earlier. | |
253 | * | |
254 | * If this is not called, then driver model will be inactive in SPL's | |
255 | * board_init_f(), and no device tree will be available. | |
256 | */ | |
257 | int spl_init(void); | |
258 | ||
259 | #ifdef CONFIG_SPL_BOARD_INIT | |
260 | void spl_board_init(void); | |
261 | #endif | |
262 | ||
263 | /** | |
264 | * spl_was_boot_source() - check if U-Boot booted from SPL | |
265 | * | |
266 | * This will normally be true, but if U-Boot jumps to second U-Boot, it will | |
267 | * be false. This should be implemented by board-specific code. | |
268 | * | |
269 | * @return true if U-Boot booted from SPL, else false | |
270 | */ | |
271 | bool spl_was_boot_source(void); | |
272 | ||
273 | /** | |
274 | * spl_dfu_cmd- run dfu command with chosen mmc device interface | |
275 | * @param usb_index - usb controller number | |
276 | * @param mmc_dev - mmc device nubmer | |
277 | * | |
278 | * @return 0 on success, otherwise error code | |
279 | */ | |
280 | int spl_dfu_cmd(int usbctrl, char *dfu_alt_info, char *interface, char *devstr); | |
281 | ||
282 | int spl_mmc_load_image(struct spl_image_info *spl_image, | |
283 | struct spl_boot_device *bootdev); | |
284 | ||
285 | /** | |
286 | * spl_invoke_atf - boot using an ARM trusted firmware image | |
287 | */ | |
288 | void spl_invoke_atf(struct spl_image_info *spl_image); | |
289 | ||
290 | /** | |
291 | * board_return_to_bootrom - allow for boards to continue with the boot ROM | |
292 | * | |
293 | * If a board (e.g. the Rockchip RK3368 boards) provide some | |
294 | * supporting functionality for SPL in their boot ROM and the SPL | |
295 | * stage wants to return to the ROM code to continue booting, boards | |
296 | * can implement 'board_return_to_bootrom'. | |
297 | */ | |
298 | void board_return_to_bootrom(void); | |
299 | #endif |