configs: meson: remove unnecessary MESON_FDTFILE_SETTING
[oweals/u-boot.git] / include / spl.h
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
15 /* Value in r0 indicates we booted from U-Boot */
16 #define UBOOT_NOT_LOADED_FROM_SPL       0x13578642
17
18 /* Boot type */
19 #define MMCSD_MODE_UNDEFINED    0
20 #define MMCSD_MODE_RAW          1
21 #define MMCSD_MODE_FS           2
22 #define MMCSD_MODE_EMMCBOOT     3
23
24 struct spl_image_info {
25         const char *name;
26         u8 os;
27         uintptr_t load_addr;
28         uintptr_t entry_point;
29 #if CONFIG_IS_ENABLED(LOAD_FIT)
30         void *fdt_addr;
31 #endif
32         u32 boot_device;
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, image_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 int spl_boot_partition(const u32 boot_device);
86 void spl_set_bd(void);
87
88 /**
89  * spl_set_header_raw_uboot() - Set up a standard SPL image structure
90  *
91  * This sets up the given spl_image which the standard values obtained from
92  * config options: CONFIG_SYS_MONITOR_LEN, CONFIG_SYS_UBOOT_START,
93  * CONFIG_SYS_TEXT_BASE.
94  *
95  * @spl_image: Image description to set up
96  */
97 void spl_set_header_raw_uboot(struct spl_image_info *spl_image);
98
99 /**
100  * spl_parse_image_header() - parse the image header and set up info
101  *
102  * This parses the legacy image header information at @header and sets up
103  * @spl_image according to what is found. If no image header is found, then
104  * a raw image or bootz is assumed. If CONFIG_SPL_PANIC_ON_RAW_IMAGE is
105  * enabled, then this causes a panic. If CONFIG_SPL_RAW_IMAGE_SUPPORT is not
106  * enabled then U-Boot gives up. Otherwise U-Boot sets up the image using
107  * spl_set_header_raw_uboot(), or possibly the bootz header.
108  *
109  * @spl_image: Image description to set up
110  * @header image header to parse
111  * @return 0 if a header was correctly parsed, -ve on error
112  */
113 int spl_parse_image_header(struct spl_image_info *spl_image,
114                            const struct image_header *header);
115
116 void spl_board_prepare_for_linux(void);
117 void spl_board_prepare_for_boot(void);
118 int spl_board_ubi_load_image(u32 boot_device);
119
120 /**
121  * jump_to_image_linux() - Jump to a Linux kernel from SPL
122  *
123  * This jumps into a Linux kernel using the information in @spl_image.
124  *
125  * @spl_image: Image description to set up
126  */
127 void __noreturn jump_to_image_linux(struct spl_image_info *spl_image);
128
129 /**
130  * spl_start_uboot() - Check if SPL should start the kernel or U-Boot
131  *
132  * This is called by the various SPL loaders to determine whether the board
133  * wants to load the kernel or U-Boot. This function should be provided by
134  * the board.
135  *
136  * @return 0 if SPL should start the kernel, 1 if U-Boot must be started
137  */
138 int spl_start_uboot(void);
139
140 /**
141  * spl_display_print() - Display a board-specific message in SPL
142  *
143  * If CONFIG_SPL_DISPLAY_PRINT is enabled, U-Boot will call this function
144  * immediately after displaying the SPL console banner ("U-Boot SPL ...").
145  * This function should be provided by the board.
146  */
147 void spl_display_print(void);
148
149 /**
150  * struct spl_boot_device - Describes a boot device used by SPL
151  *
152  * @boot_device: A number indicating the BOOT_DEVICE type. There are various
153  * BOOT_DEVICE... #defines and enums in U-Boot and they are not consistently
154  * numbered.
155  * @boot_device_name: Named boot device, or NULL if none.
156  *
157  * Note: Additional fields can be added here, bearing in mind that SPL is
158  * size-sensitive and common fields will be present on all boards. This
159  * struct can also be used to return additional information about the load
160  * process if that becomes useful.
161  */
162 struct spl_boot_device {
163         uint boot_device;
164         const char *boot_device_name;
165 };
166
167 /**
168  * Holds information about a way of loading an SPL image
169  *
170  * @name: User-friendly name for this method (e.g. "MMC")
171  * @boot_device: Boot device that this loader supports
172  * @load_image: Function to call to load image
173  */
174 struct spl_image_loader {
175 #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
176         const char *name;
177 #endif
178         uint boot_device;
179         /**
180          * load_image() - Load an SPL image
181          *
182          * @spl_image: place to put image information
183          * @bootdev: describes the boot device to load from
184          */
185         int (*load_image)(struct spl_image_info *spl_image,
186                           struct spl_boot_device *bootdev);
187 };
188
189 /* Declare an SPL image loader */
190 #define SPL_LOAD_IMAGE(__name)                                  \
191         ll_entry_declare(struct spl_image_loader, __name, spl_image_loader)
192
193 /*
194  * _priority is the priority of this method, 0 meaning it will be the top
195  * choice for this device, 9 meaning it is the bottom choice.
196  * _boot_device is the BOOT_DEVICE_... value
197  * _method is the load_image function to call
198  */
199 #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
200 #define SPL_LOAD_IMAGE_METHOD(_name, _priority, _boot_device, _method) \
201         SPL_LOAD_IMAGE(_method ## _priority ## _boot_device) = { \
202                 .name = _name, \
203                 .boot_device = _boot_device, \
204                 .load_image = _method, \
205         }
206 #else
207 #define SPL_LOAD_IMAGE_METHOD(_name, _priority, _boot_device, _method) \
208         SPL_LOAD_IMAGE(_method ## _priority ## _boot_device) = { \
209                 .boot_device = _boot_device, \
210                 .load_image = _method, \
211         }
212 #endif
213
214 /* SPL FAT image functions */
215 int spl_load_image_fat(struct spl_image_info *spl_image,
216                        struct blk_desc *block_dev, int partition,
217                        const char *filename);
218 int spl_load_image_fat_os(struct spl_image_info *spl_image,
219                           struct blk_desc *block_dev, int partition);
220
221 void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image);
222
223 /* SPL EXT image functions */
224 int spl_load_image_ext(struct spl_image_info *spl_image,
225                        struct blk_desc *block_dev, int partition,
226                        const char *filename);
227 int spl_load_image_ext_os(struct spl_image_info *spl_image,
228                           struct blk_desc *block_dev, int partition);
229
230 /**
231  * spl_early_init() - Set up device tree and driver model in SPL if enabled
232  *
233  * Call this function in board_init_f() if you want to use device tree and
234  * driver model early, before board_init_r() is called.
235  *
236  * If this is not called, then driver model will be inactive in SPL's
237  * board_init_f(), and no device tree will be available.
238  */
239 int spl_early_init(void);
240
241 /**
242  * spl_init() - Set up device tree and driver model in SPL if enabled
243  *
244  * You can optionally call spl_early_init(), then optionally call spl_init().
245  * This function will be called from board_init_r() if not called earlier.
246  *
247  * Both spl_early_init() and spl_init() perform a similar function except that
248  * the latter will not set up the malloc() area if
249  * CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN is enabled, since it is assumed to
250  * already be done by a calll to spl_relocate_stack_gd() before board_init_r()
251  * is reached.
252  *
253  * This function will be called from board_init_r() if not called earlier.
254  *
255  * If this is not called, then driver model will be inactive in SPL's
256  * board_init_f(), and no device tree will be available.
257  */
258 int spl_init(void);
259
260 #ifdef CONFIG_SPL_BOARD_INIT
261 void spl_board_init(void);
262 #endif
263
264 /**
265  * spl_was_boot_source() - check if U-Boot booted from SPL
266  *
267  * This will normally be true, but if U-Boot jumps to second U-Boot, it will
268  * be false. This should be implemented by board-specific code.
269  *
270  * @return true if U-Boot booted from SPL, else false
271  */
272 bool spl_was_boot_source(void);
273
274 /**
275  * spl_dfu_cmd- run dfu command with chosen mmc device interface
276  * @param usb_index - usb controller number
277  * @param mmc_dev -  mmc device nubmer
278  *
279  * @return 0 on success, otherwise error code
280  */
281 int spl_dfu_cmd(int usbctrl, char *dfu_alt_info, char *interface, char *devstr);
282
283 int spl_mmc_load_image(struct spl_image_info *spl_image,
284                        struct spl_boot_device *bootdev);
285
286 /**
287  * spl_invoke_atf - boot using an ARM trusted firmware image
288  */
289 void spl_invoke_atf(struct spl_image_info *spl_image);
290
291 /**
292  * spl_optee_entry - entry function for optee
293  *
294  * args defind in op-tee project
295  * https://github.com/OP-TEE/optee_os/
296  * core/arch/arm/kernel/generic_entry_a32.S
297  * @arg0: pagestore
298  * @arg1: (ARMv7 standard bootarg #1)
299  * @arg2: device tree address, (ARMv7 standard bootarg #2)
300  * @arg3: non-secure entry address (ARMv7 bootarg #0)
301  */
302 void spl_optee_entry(void *arg0, void *arg1, void *arg2, void *arg3);
303
304 /**
305  * board_return_to_bootrom - allow for boards to continue with the boot ROM
306  *
307  * If a board (e.g. the Rockchip RK3368 boards) provide some
308  * supporting functionality for SPL in their boot ROM and the SPL
309  * stage wants to return to the ROM code to continue booting, boards
310  * can implement 'board_return_to_bootrom'.
311  */
312 void board_return_to_bootrom(void);
313
314 /**
315  * spl_perform_fixups() - arch/board-specific callback before processing
316  *                        the boot-payload
317  */
318 void spl_perform_fixups(struct spl_image_info *spl_image);
319
320 /*
321  * spl_get_load_buffer() - get buffer for loading partial image data
322  *
323  * Returns memory area which can be populated by partial image data,
324  * ie. uImage or fitImage header.
325  */
326 struct image_header *spl_get_load_buffer(ssize_t offset, size_t size);
327
328 #endif