• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /* SPDX-License-Identifier: GPL-2.0+ */
2 /*
3  * (C) Copyright 2012
4  * Texas Instruments, <www.ti.com>
5  */
6 #ifndef	_SPL_H_
7 #define	_SPL_H_
8 
9 #include <binman_sym.h>
10 
11 /* Platform-specific defines */
12 #include <linux/compiler.h>
13 #include <asm/spl.h>
14 #include <handoff.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 /*
26  * u_boot_first_phase() - check if this is the first U-Boot phase
27  *
28  * U-Boot has up to three phases: TPL, SPL and U-Boot proper. Depending on the
29  * build flags we can determine whether the current build is for the first
30  * phase of U-Boot or not. If there is no SPL, then this is U-Boot proper. If
31  * there is SPL but no TPL, the the first phase is SPL. If there is TPL, then
32  * it is the first phase.
33  *
34  * @returns true if this is the first phase of U-Boot
35  *
36  */
u_boot_first_phase(void)37 static inline bool u_boot_first_phase(void)
38 {
39 	if (IS_ENABLED(CONFIG_TPL)) {
40 		if (IS_ENABLED(CONFIG_TPL_BUILD))
41 			return true;
42 	} else if (IS_ENABLED(CONFIG_SPL)) {
43 		if (IS_ENABLED(CONFIG_SPL_BUILD))
44 			return true;
45 	} else {
46 		return true;
47 	}
48 
49 	return false;
50 }
51 
52 enum u_boot_phase {
53 	PHASE_TPL,	/* Running in TPL */
54 	PHASE_SPL,	/* Running in SPL */
55 	PHASE_BOARD_F,	/* Running in U-Boot before relocation */
56 	PHASE_BOARD_R,	/* Running in U-Boot after relocation */
57 };
58 
59 /**
60  * spl_phase() - Find out the phase of U-Boot
61  *
62  * This can be used to avoid #ifdef logic and use if() instead.
63  *
64  * For example, to include code only in TPL, you might do:
65  *
66  *    #ifdef CONFIG_TPL_BUILD
67  *    ...
68  *    #endif
69  *
70  * but with this you can use:
71  *
72  *    if (spl_phase() == PHASE_TPL) {
73  *       ...
74  *    }
75  *
76  * To include code only in SPL, you might do:
77  *
78  *    #if defined(CONFIG_SPL_BUILD) && !defined(CONFIG_TPL_BUILD)
79  *    ...
80  *    #endif
81  *
82  * but with this you can use:
83  *
84  *    if (spl_phase() == PHASE_SPL) {
85  *       ...
86  *    }
87  *
88  * To include code only in U-Boot proper, you might do:
89  *
90  *    #ifndef CONFIG_SPL_BUILD
91  *    ...
92  *    #endif
93  *
94  * but with this you can use:
95  *
96  *    if (spl_phase() == PHASE_BOARD_F) {
97  *       ...
98  *    }
99  *
100  * @return U-Boot phase
101  */
spl_phase(void)102 static inline enum u_boot_phase spl_phase(void)
103 {
104 #ifdef CONFIG_TPL_BUILD
105 	return PHASE_TPL;
106 #elif CONFIG_SPL_BUILD
107 	return PHASE_SPL;
108 #else
109 	DECLARE_GLOBAL_DATA_PTR;
110 
111 	if (!(gd->flags & GD_FLG_RELOC))
112 		return PHASE_BOARD_F;
113 	else
114 		return PHASE_BOARD_R;
115 #endif
116 }
117 
118 /* A string name for SPL or TPL */
119 #ifdef CONFIG_SPL_BUILD
120 # ifdef CONFIG_TPL_BUILD
121 #  define SPL_TPL_NAME	"TPL"
122 # else
123 #  define SPL_TPL_NAME	"SPL"
124 # endif
125 # define SPL_TPL_PROMPT	SPL_TPL_NAME ": "
126 #else
127 # define SPL_TPL_NAME	""
128 # define SPL_TPL_PROMPT	""
129 #endif
130 
131 struct spl_image_info {
132 	const char *name;
133 	u8 os;
134 	uintptr_t load_addr;
135 	uintptr_t entry_point;
136 #if CONFIG_IS_ENABLED(LOAD_FIT) || CONFIG_IS_ENABLED(LOAD_FIT_FULL)
137 	void *fdt_addr;
138 #endif
139 	u32 boot_device;
140 	u32 size;
141 	u32 flags;
142 	void *arg;
143 #ifdef CONFIG_SPL_LEGACY_IMAGE_CRC_CHECK
144 	ulong dcrc_data;
145 	ulong dcrc_length;
146 	ulong dcrc;
147 #endif
148 };
149 
150 /*
151  * Information required to load data from a device
152  *
153  * @dev: Pointer to the device, e.g. struct mmc *
154  * @priv: Private data for the device
155  * @bl_len: Block length for reading in bytes
156  * @filename: Name of the fit image file.
157  * @read: Function to call to read from the device
158  */
159 struct spl_load_info {
160 	void *dev;
161 	void *priv;
162 	int bl_len;
163 	const char *filename;
164 	ulong (*read)(struct spl_load_info *load, ulong sector, ulong count,
165 		      void *buf);
166 };
167 
168 /*
169  * We need to know the position of U-Boot in memory so we can jump to it. We
170  * allow any U-Boot binary to be used (u-boot.bin, u-boot-nodtb.bin,
171  * u-boot.img), hence the '_any'. These is no checking here that the correct
172  * image is found. For * example if u-boot.img is used we don't check that
173  * spl_parse_image_header() can parse a valid header.
174  */
175 binman_sym_extern(ulong, u_boot_any, image_pos);
176 
177 /**
178  * spl_load_simple_fit_skip_processing() - Hook to allow skipping the FIT
179  *	image processing during spl_load_simple_fit().
180  *
181  * Return true to skip FIT processing, false to preserve the full code flow
182  * of spl_load_simple_fit().
183  */
184 bool spl_load_simple_fit_skip_processing(void);
185 
186 /**
187  * spl_load_simple_fit() - Loads a fit image from a device.
188  * @spl_image:	Image description to set up
189  * @info:	Structure containing the information required to load data.
190  * @sector:	Sector number where FIT image is located in the device
191  * @fdt:	Pointer to the copied FIT header.
192  *
193  * Reads the FIT image @sector in the device. Loads u-boot image to
194  * specified load address and copies the dtb to end of u-boot image.
195  * Returns 0 on success.
196  */
197 int spl_load_simple_fit(struct spl_image_info *spl_image,
198 			struct spl_load_info *info, ulong sector, void *fdt);
199 
200 #define SPL_COPY_PAYLOAD_ONLY	1
201 #define SPL_FIT_FOUND		2
202 
203 /**
204  * spl_load_imx_container() - Loads a imx container image from a device.
205  * @spl_image:	Image description to set up
206  * @info:	Structure containing the information required to load data.
207  * @sector:	Sector number where container image is located in the device
208  *
209  * Reads the container image @sector in the device. Loads u-boot image to
210  * specified load address.
211  */
212 int spl_load_imx_container(struct spl_image_info *spl_image,
213 			   struct spl_load_info *info, ulong sector);
214 
215 /* SPL common functions */
216 void preloader_console_init(void);
217 u32 spl_boot_device(void);
218 u32 spl_boot_mode(const u32 boot_device);
219 int spl_boot_partition(const u32 boot_device);
220 void spl_set_bd(void);
221 
222 /**
223  * spl_set_header_raw_uboot() - Set up a standard SPL image structure
224  *
225  * This sets up the given spl_image which the standard values obtained from
226  * config options: CONFIG_SYS_MONITOR_LEN, CONFIG_SYS_UBOOT_START,
227  * CONFIG_SYS_TEXT_BASE.
228  *
229  * @spl_image: Image description to set up
230  */
231 void spl_set_header_raw_uboot(struct spl_image_info *spl_image);
232 
233 /**
234  * spl_parse_image_header() - parse the image header and set up info
235  *
236  * This parses the legacy image header information at @header and sets up
237  * @spl_image according to what is found. If no image header is found, then
238  * a raw image or bootz is assumed. If CONFIG_SPL_PANIC_ON_RAW_IMAGE is
239  * enabled, then this causes a panic. If CONFIG_SPL_RAW_IMAGE_SUPPORT is not
240  * enabled then U-Boot gives up. Otherwise U-Boot sets up the image using
241  * spl_set_header_raw_uboot(), or possibly the bootz header.
242  *
243  * @spl_image: Image description to set up
244  * @header image header to parse
245  * @return 0 if a header was correctly parsed, -ve on error
246  */
247 int spl_parse_image_header(struct spl_image_info *spl_image,
248 			   const struct image_header *header);
249 
250 void spl_board_prepare_for_linux(void);
251 void spl_board_prepare_for_boot(void);
252 int spl_board_ubi_load_image(u32 boot_device);
253 
254 /**
255  * jump_to_image_linux() - Jump to a Linux kernel from SPL
256  *
257  * This jumps into a Linux kernel using the information in @spl_image.
258  *
259  * @spl_image: Image description to set up
260  */
261 void __noreturn jump_to_image_linux(struct spl_image_info *spl_image);
262 
263 /**
264  * spl_start_uboot() - Check if SPL should start the kernel or U-Boot
265  *
266  * This is called by the various SPL loaders to determine whether the board
267  * wants to load the kernel or U-Boot. This function should be provided by
268  * the board.
269  *
270  * @return 0 if SPL should start the kernel, 1 if U-Boot must be started
271  */
272 int spl_start_uboot(void);
273 
274 /**
275  * spl_display_print() - Display a board-specific message in SPL
276  *
277  * If CONFIG_SPL_DISPLAY_PRINT is enabled, U-Boot will call this function
278  * immediately after displaying the SPL console banner ("U-Boot SPL ...").
279  * This function should be provided by the board.
280  */
281 void spl_display_print(void);
282 
283 /**
284  * struct spl_boot_device - Describes a boot device used by SPL
285  *
286  * @boot_device: A number indicating the BOOT_DEVICE type. There are various
287  * BOOT_DEVICE... #defines and enums in U-Boot and they are not consistently
288  * numbered.
289  * @boot_device_name: Named boot device, or NULL if none.
290  *
291  * Note: Additional fields can be added here, bearing in mind that SPL is
292  * size-sensitive and common fields will be present on all boards. This
293  * struct can also be used to return additional information about the load
294  * process if that becomes useful.
295  */
296 struct spl_boot_device {
297 	uint boot_device;
298 	const char *boot_device_name;
299 };
300 
301 /**
302  * Holds information about a way of loading an SPL image
303  *
304  * @name: User-friendly name for this method (e.g. "MMC")
305  * @boot_device: Boot device that this loader supports
306  * @load_image: Function to call to load image
307  */
308 struct spl_image_loader {
309 #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
310 	const char *name;
311 #endif
312 	uint boot_device;
313 	/**
314 	 * load_image() - Load an SPL image
315 	 *
316 	 * @spl_image: place to put image information
317 	 * @bootdev: describes the boot device to load from
318 	 */
319 	int (*load_image)(struct spl_image_info *spl_image,
320 			  struct spl_boot_device *bootdev);
321 };
322 
323 /* Declare an SPL image loader */
324 #define SPL_LOAD_IMAGE(__name)					\
325 	ll_entry_declare(struct spl_image_loader, __name, spl_image_loader)
326 
327 /*
328  * _priority is the priority of this method, 0 meaning it will be the top
329  * choice for this device, 9 meaning it is the bottom choice.
330  * _boot_device is the BOOT_DEVICE_... value
331  * _method is the load_image function to call
332  */
333 #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
334 #define SPL_LOAD_IMAGE_METHOD(_name, _priority, _boot_device, _method) \
335 	SPL_LOAD_IMAGE(_boot_device ## _priority ## _method) = { \
336 		.name = _name, \
337 		.boot_device = _boot_device, \
338 		.load_image = _method, \
339 	}
340 #else
341 #define SPL_LOAD_IMAGE_METHOD(_name, _priority, _boot_device, _method) \
342 	SPL_LOAD_IMAGE(_boot_device ## _priority ## _method) = { \
343 		.boot_device = _boot_device, \
344 		.load_image = _method, \
345 	}
346 #endif
347 
348 /* SPL FAT image functions */
349 int spl_load_image_fat(struct spl_image_info *spl_image,
350 		       struct blk_desc *block_dev, int partition,
351 		       const char *filename);
352 int spl_load_image_fat_os(struct spl_image_info *spl_image,
353 			  struct blk_desc *block_dev, int partition);
354 
355 void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image);
356 
357 /* SPL EXT image functions */
358 int spl_load_image_ext(struct spl_image_info *spl_image,
359 		       struct blk_desc *block_dev, int partition,
360 		       const char *filename);
361 int spl_load_image_ext_os(struct spl_image_info *spl_image,
362 			  struct blk_desc *block_dev, int partition);
363 
364 /**
365  * spl_early_init() - Set up device tree and driver model in SPL if enabled
366  *
367  * Call this function in board_init_f() if you want to use device tree and
368  * driver model early, before board_init_r() is called.
369  *
370  * If this is not called, then driver model will be inactive in SPL's
371  * board_init_f(), and no device tree will be available.
372  */
373 int spl_early_init(void);
374 
375 /**
376  * spl_init() - Set up device tree and driver model in SPL if enabled
377  *
378  * You can optionally call spl_early_init(), then optionally call spl_init().
379  * This function will be called from board_init_r() if not called earlier.
380  *
381  * Both spl_early_init() and spl_init() perform a similar function except that
382  * the latter will not set up the malloc() area if
383  * CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN is enabled, since it is assumed to
384  * already be done by a calll to spl_relocate_stack_gd() before board_init_r()
385  * is reached.
386  *
387  * This function will be called from board_init_r() if not called earlier.
388  *
389  * If this is not called, then driver model will be inactive in SPL's
390  * board_init_f(), and no device tree will be available.
391  */
392 int spl_init(void);
393 
394 #ifdef CONFIG_SPL_BOARD_INIT
395 void spl_board_init(void);
396 #endif
397 
398 /**
399  * spl_was_boot_source() - check if U-Boot booted from SPL
400  *
401  * This will normally be true, but if U-Boot jumps to second U-Boot, it will
402  * be false. This should be implemented by board-specific code.
403  *
404  * @return true if U-Boot booted from SPL, else false
405  */
406 bool spl_was_boot_source(void);
407 
408 /**
409  * spl_dfu_cmd- run dfu command with chosen mmc device interface
410  * @param usb_index - usb controller number
411  * @param mmc_dev -  mmc device nubmer
412  *
413  * @return 0 on success, otherwise error code
414  */
415 int spl_dfu_cmd(int usbctrl, char *dfu_alt_info, char *interface, char *devstr);
416 
417 int spl_mmc_load_image(struct spl_image_info *spl_image,
418 		       struct spl_boot_device *bootdev);
419 
420 /**
421  * spl_mmc_load() - Load an image file from MMC/SD media
422  *
423  * @param spl_image	Image data filled in by loading process
424  * @param bootdev	Describes which device to load from
425  * @param filename	Name of file to load (in FS mode)
426  * @param raw_part	Partition to load from (in RAW mode)
427  * @param raw_sect	Sector to load from (in RAW mode)
428  *
429  * @return 0 on success, otherwise error code
430  */
431 int spl_mmc_load(struct spl_image_info *spl_image,
432 		 struct spl_boot_device *bootdev,
433 		 const char *filename,
434 		 int raw_part,
435 		 unsigned long raw_sect);
436 
437 int spl_ymodem_load_image(struct spl_image_info *spl_image,
438 			  struct spl_boot_device *bootdev);
439 
440 /**
441  * spl_invoke_atf - boot using an ARM trusted firmware image
442  */
443 void spl_invoke_atf(struct spl_image_info *spl_image);
444 
445 /**
446  * spl_optee_entry - entry function for optee
447  *
448  * args defind in op-tee project
449  * https://github.com/OP-TEE/optee_os/
450  * core/arch/arm/kernel/generic_entry_a32.S
451  * @arg0: pagestore
452  * @arg1: (ARMv7 standard bootarg #1)
453  * @arg2: device tree address, (ARMv7 standard bootarg #2)
454  * @arg3: non-secure entry address (ARMv7 bootarg #0)
455  */
456 void spl_optee_entry(void *arg0, void *arg1, void *arg2, void *arg3);
457 
458 /**
459  * spl_invoke_opensbi - boot using a RISC-V OpenSBI image
460  */
461 void spl_invoke_opensbi(struct spl_image_info *spl_image);
462 
463 /**
464  * board_return_to_bootrom - allow for boards to continue with the boot ROM
465  *
466  * If a board (e.g. the Rockchip RK3368 boards) provide some
467  * supporting functionality for SPL in their boot ROM and the SPL
468  * stage wants to return to the ROM code to continue booting, boards
469  * can implement 'board_return_to_bootrom'.
470  */
471 int board_return_to_bootrom(struct spl_image_info *spl_image,
472 			    struct spl_boot_device *bootdev);
473 
474 /**
475  * board_spl_fit_post_load - allow process images after loading finished
476  *
477  */
478 void board_spl_fit_post_load(ulong load_addr, size_t length);
479 
480 /**
481  * board_spl_fit_size_align - specific size align before processing payload
482  *
483  */
484 ulong board_spl_fit_size_align(ulong size);
485 
486 /**
487  * spl_perform_fixups() - arch/board-specific callback before processing
488  *                        the boot-payload
489  */
490 void spl_perform_fixups(struct spl_image_info *spl_image);
491 
492 /*
493  * spl_get_load_buffer() - get buffer for loading partial image data
494  *
495  * Returns memory area which can be populated by partial image data,
496  * ie. uImage or fitImage header.
497  */
498 struct image_header *spl_get_load_buffer(ssize_t offset, size_t size);
499 
500 #endif
501