Blame view
include/spl.h
11.7 KB
83d290c56 SPDX: Convert all... |
1 |
/* SPDX-License-Identifier: GPL-2.0+ */ |
47f7bcae8 SPL: Move the oma... |
2 3 4 |
/* * (C) Copyright 2012 * Texas Instruments, <www.ti.com> |
47f7bcae8 SPL: Move the oma... |
5 6 7 |
*/ #ifndef _SPL_H_ #define _SPL_H_ |
8bee2d251 binman: Add binma... |
8 |
#include <binman_sym.h> |
47f7bcae8 SPL: Move the oma... |
9 |
/* Platform-specific defines */ |
6507f133f SPL: Create arch/... |
10 |
#include <linux/compiler.h> |
47f7bcae8 SPL: Move the oma... |
11 |
#include <asm/spl.h> |
b0edea3c2 spl: Add support ... |
12 |
#include <handoff.h> |
47f7bcae8 SPL: Move the oma... |
13 |
|
32ba8952c arm: spl: Add an ... |
14 15 |
/* Value in r0 indicates we booted from U-Boot */ #define UBOOT_NOT_LOADED_FROM_SPL 0x13578642 |
773b5940b spl: common: Move... |
16 |
|
47f7bcae8 SPL: Move the oma... |
17 18 19 |
/* Boot type */ #define MMCSD_MODE_UNDEFINED 0 #define MMCSD_MODE_RAW 1 |
205b4f33c Rename some defin... |
20 |
#define MMCSD_MODE_FS 2 |
7dbe63bc9 SPL: Add CONFIG_S... |
21 |
#define MMCSD_MODE_EMMCBOOT 3 |
47f7bcae8 SPL: Move the oma... |
22 |
|
e945a7262 spl: Set up the b... |
23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 |
/* * u_boot_first_phase() - check if this is the first U-Boot phase * * U-Boot has up to three phases: TPL, SPL and U-Boot proper. Depending on the * build flags we can determine whether the current build is for the first * phase of U-Boot or not. If there is no SPL, then this is U-Boot proper. If * there is SPL but no TPL, the the first phase is SPL. If there is TPL, then * it is the first phase. * * @returns true if this is the first phase of U-Boot * */ static inline bool u_boot_first_phase(void) { if (IS_ENABLED(CONFIG_TPL)) { if (IS_ENABLED(CONFIG_TPL_BUILD)) return true; } else if (IS_ENABLED(CONFIG_SPL)) { if (IS_ENABLED(CONFIG_SPL_BUILD)) return true; } else { return true; } return false; } |
d63300646 spl: Add a define... |
49 50 51 |
/* A string name for SPL or TPL */ #ifdef CONFIG_SPL_BUILD # ifdef CONFIG_TPL_BUILD |
8fb2391ea spl/tpl: change b... |
52 |
# define SPL_TPL_NAME "TPL" |
d63300646 spl: Add a define... |
53 |
# else |
8fb2391ea spl/tpl: change b... |
54 |
# define SPL_TPL_NAME "SPL" |
d63300646 spl: Add a define... |
55 56 57 58 59 60 |
# endif # define SPL_TPL_PROMPT SPL_TPL_NAME ": " #else # define SPL_TPL_NAME "" # define SPL_TPL_PROMPT "" #endif |
47f7bcae8 SPL: Move the oma... |
61 62 63 |
struct spl_image_info { const char *name; u8 os; |
f2efe6786 spl: change load_... |
64 65 |
uintptr_t load_addr; uintptr_t entry_point; |
75014470a spl: add a fdt_ad... |
66 67 68 |
#if CONFIG_IS_ENABLED(LOAD_FIT) void *fdt_addr; #endif |
de5dd4c4e spl: record boot_... |
69 |
u32 boot_device; |
47f7bcae8 SPL: Move the oma... |
70 |
u32 size; |
022b4975c SPL: Add option t... |
71 |
u32 flags; |
5bf5250e9 spl: make image a... |
72 |
void *arg; |
dae5c2dcd spl: implement CR... |
73 74 75 76 77 |
#ifdef CONFIG_SPL_LEGACY_IMAGE_CRC_CHECK ulong dcrc_data; ulong dcrc_length; ulong dcrc; #endif |
30355b43d MA-14916-4 suppor... |
78 79 80 |
#ifdef CONFIG_DUAL_BOOTLOADER uint64_t rbindex; #endif |
47f7bcae8 SPL: Move the oma... |
81 |
}; |
f1dcee59a spl: Add an optio... |
82 83 84 85 86 87 |
/* * Information required to load data from a device * * @dev: Pointer to the device, e.g. struct mmc * * @priv: Private data for the device * @bl_len: Block length for reading in bytes |
eafd5410a spl: Allow to loa... |
88 |
* @filename: Name of the fit image file. |
f1dcee59a spl: Add an optio... |
89 90 91 92 93 94 |
* @read: Function to call to read from the device */ struct spl_load_info { void *dev; void *priv; int bl_len; |
eafd5410a spl: Allow to loa... |
95 |
const char *filename; |
f1dcee59a spl: Add an optio... |
96 97 98 |
ulong (*read)(struct spl_load_info *load, ulong sector, ulong count, void *buf); }; |
8bee2d251 binman: Add binma... |
99 100 101 102 103 104 105 |
/* * We need to know the position of U-Boot in memory so we can jump to it. We * allow any U-Boot binary to be used (u-boot.bin, u-boot-nodtb.bin, * u-boot.img), hence the '_any'. These is no checking here that the correct * image is found. For * example if u-boot.img is used we don't check that * spl_parse_image_header() can parse a valid header. */ |
dbf6be9f7 binman: Add a new... |
106 |
binman_sym_extern(ulong, u_boot_any, image_pos); |
8bee2d251 binman: Add binma... |
107 |
|
eafd5410a spl: Allow to loa... |
108 109 |
/** * spl_load_simple_fit() - Loads a fit image from a device. |
f4d7d8596 spl: Update spl_l... |
110 |
* @spl_image: Image description to set up |
eafd5410a spl: Allow to loa... |
111 112 113 114 115 116 117 118 |
* @info: Structure containing the information required to load data. * @sector: Sector number where FIT image is located in the device * @fdt: Pointer to the copied FIT header. * * Reads the FIT image @sector in the device. Loads u-boot image to * specified load address and copies the dtb to end of u-boot image. * Returns 0 on success. */ |
f4d7d8596 spl: Update spl_l... |
119 120 |
int spl_load_simple_fit(struct spl_image_info *spl_image, struct spl_load_info *info, ulong sector, void *fdt); |
f1dcee59a spl: Add an optio... |
121 |
|
022b4975c SPL: Add option t... |
122 |
#define SPL_COPY_PAYLOAD_ONLY 1 |
e246bfcfe SPL: Add HAB imag... |
123 |
#define SPL_FIT_FOUND 2 |
3e50573a7 MLK-22078 romapi:... |
124 |
#define SPL_FIT_BYPASS_POST_LOAD 4 |
022b4975c SPL: Add option t... |
125 |
|
47f7bcae8 SPL: Move the oma... |
126 127 128 |
/* SPL common functions */ void preloader_console_init(void); u32 spl_boot_device(void); |
2b1cdafa9 common: Pass the ... |
129 |
u32 spl_boot_mode(const u32 boot_device); |
35a66960c spl: spl_mmc: pro... |
130 |
int spl_boot_partition(const u32 boot_device); |
d1fc0a31b spl: fix assignme... |
131 |
void spl_set_bd(void); |
d95ceb97c spl: Add a parame... |
132 133 134 135 136 137 138 139 |
/** * spl_set_header_raw_uboot() - Set up a standard SPL image structure * * This sets up the given spl_image which the standard values obtained from * config options: CONFIG_SYS_MONITOR_LEN, CONFIG_SYS_UBOOT_START, * CONFIG_SYS_TEXT_BASE. * |
71316c1d8 spl: Add a parame... |
140 |
* @spl_image: Image description to set up |
d95ceb97c spl: Add a parame... |
141 142 |
*/ void spl_set_header_raw_uboot(struct spl_image_info *spl_image); |
71316c1d8 spl: Add a parame... |
143 144 145 146 147 148 |
/** * spl_parse_image_header() - parse the image header and set up info * * This parses the legacy image header information at @header and sets up * @spl_image according to what is found. If no image header is found, then * a raw image or bootz is assumed. If CONFIG_SPL_PANIC_ON_RAW_IMAGE is |
24eb39b57 spl: Convert CONF... |
149 |
* enabled, then this causes a panic. If CONFIG_SPL_RAW_IMAGE_SUPPORT is not |
71316c1d8 spl: Add a parame... |
150 151 152 153 154 155 156 157 158 |
* enabled then U-Boot gives up. Otherwise U-Boot sets up the image using * spl_set_header_raw_uboot(), or possibly the bootz header. * * @spl_image: Image description to set up * @header image header to parse * @return 0 if a header was correctly parsed, -ve on error */ int spl_parse_image_header(struct spl_image_info *spl_image, const struct image_header *header); |
47f7bcae8 SPL: Move the oma... |
159 |
void spl_board_prepare_for_linux(void); |
3a3b91478 spl: Introduce ne... |
160 |
void spl_board_prepare_for_boot(void); |
bf55cd4f3 spl: support load... |
161 |
int spl_board_ubi_load_image(u32 boot_device); |
ca12e65ca spl: Add a parame... |
162 163 164 165 166 167 168 |
/** * jump_to_image_linux() - Jump to a Linux kernel from SPL * * This jumps into a Linux kernel using the information in @spl_image. * * @spl_image: Image description to set up |
ca12e65ca spl: Add a parame... |
169 |
*/ |
5bf5250e9 spl: make image a... |
170 |
void __noreturn jump_to_image_linux(struct spl_image_info *spl_image); |
f59961e34 spl: Add function... |
171 172 173 174 175 176 177 178 179 180 |
/** * spl_start_uboot() - Check if SPL should start the kernel or U-Boot * * This is called by the various SPL loaders to determine whether the board * wants to load the kernel or U-Boot. This function should be provided by * the board. * * @return 0 if SPL should start the kernel, 1 if U-Boot must be started */ |
47f7bcae8 SPL: Move the oma... |
181 |
int spl_start_uboot(void); |
f59961e34 spl: Add function... |
182 |
|
a807ab330 spl: Kconfig: Mov... |
183 184 185 186 187 188 189 |
/** * spl_display_print() - Display a board-specific message in SPL * * If CONFIG_SPL_DISPLAY_PRINT is enabled, U-Boot will call this function * immediately after displaying the SPL console banner ("U-Boot SPL ..."). * This function should be provided by the board. */ |
47f7bcae8 SPL: Move the oma... |
190 |
void spl_display_print(void); |
ecdfd69a4 spl: Convert boot... |
191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 |
/** * struct spl_boot_device - Describes a boot device used by SPL * * @boot_device: A number indicating the BOOT_DEVICE type. There are various * BOOT_DEVICE... #defines and enums in U-Boot and they are not consistently * numbered. * @boot_device_name: Named boot device, or NULL if none. * * Note: Additional fields can be added here, bearing in mind that SPL is * size-sensitive and common fields will be present on all boards. This * struct can also be used to return additional information about the load * process if that becomes useful. */ struct spl_boot_device { uint boot_device; const char *boot_device_name; }; |
a0a802905 spl: Add a way to... |
208 209 210 |
/** * Holds information about a way of loading an SPL image * |
ebc4ef61d spl: Add a name t... |
211 |
* @name: User-friendly name for this method (e.g. "MMC") |
a0a802905 spl: Add a way to... |
212 213 214 215 |
* @boot_device: Boot device that this loader supports * @load_image: Function to call to load image */ struct spl_image_loader { |
ebc4ef61d spl: Add a name t... |
216 217 218 |
#ifdef CONFIG_SPL_LIBCOMMON_SUPPORT const char *name; #endif |
a0a802905 spl: Add a way to... |
219 220 221 222 |
uint boot_device; /** * load_image() - Load an SPL image * |
2a2ee2ac3 spl: Pass spl_ima... |
223 |
* @spl_image: place to put image information |
a0a802905 spl: Add a way to... |
224 225 |
* @bootdev: describes the boot device to load from */ |
2a2ee2ac3 spl: Pass spl_ima... |
226 227 |
int (*load_image)(struct spl_image_info *spl_image, struct spl_boot_device *bootdev); |
a0a802905 spl: Add a way to... |
228 229 230 231 232 233 234 |
}; /* Declare an SPL image loader */ #define SPL_LOAD_IMAGE(__name) \ ll_entry_declare(struct spl_image_loader, __name, spl_image_loader) /* |
0d3b05913 spl: Use a single... |
235 |
* _priority is the priority of this method, 0 meaning it will be the top |
a0a802905 spl: Add a way to... |
236 |
* choice for this device, 9 meaning it is the bottom choice. |
0d3b05913 spl: Use a single... |
237 238 |
* _boot_device is the BOOT_DEVICE_... value * _method is the load_image function to call |
a0a802905 spl: Add a way to... |
239 |
*/ |
ebc4ef61d spl: Add a name t... |
240 241 242 243 244 245 246 247 248 |
#ifdef CONFIG_SPL_LIBCOMMON_SUPPORT #define SPL_LOAD_IMAGE_METHOD(_name, _priority, _boot_device, _method) \ SPL_LOAD_IMAGE(_method ## _priority ## _boot_device) = { \ .name = _name, \ .boot_device = _boot_device, \ .load_image = _method, \ } #else #define SPL_LOAD_IMAGE_METHOD(_name, _priority, _boot_device, _method) \ |
0d3b05913 spl: Use a single... |
249 250 251 |
SPL_LOAD_IMAGE(_method ## _priority ## _boot_device) = { \ .boot_device = _boot_device, \ .load_image = _method, \ |
a0a802905 spl: Add a way to... |
252 |
} |
ebc4ef61d spl: Add a name t... |
253 |
#endif |
a0a802905 spl: Add a way to... |
254 |
|
773b5940b spl: common: Move... |
255 |
/* SPL FAT image functions */ |
710e9ca57 spl: Update fat f... |
256 257 |
int spl_load_image_fat(struct spl_image_info *spl_image, struct blk_desc *block_dev, int partition, |
4101f6879 dm: Drop the bloc... |
258 |
const char *filename); |
710e9ca57 spl: Update fat f... |
259 260 |
int spl_load_image_fat_os(struct spl_image_info *spl_image, struct blk_desc *block_dev, int partition); |
773b5940b spl: common: Move... |
261 |
|
ce0482243 spl: add prototyp... |
262 |
void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image); |
592f92226 spl: Add EXT supp... |
263 |
/* SPL EXT image functions */ |
b4a6c2aae spl: Update ext f... |
264 265 |
int spl_load_image_ext(struct spl_image_info *spl_image, struct blk_desc *block_dev, int partition, |
4101f6879 dm: Drop the bloc... |
266 |
const char *filename); |
b4a6c2aae spl: Update ext f... |
267 268 |
int spl_load_image_ext_os(struct spl_image_info *spl_image, struct blk_desc *block_dev, int partition); |
592f92226 spl: Add EXT supp... |
269 |
|
070d00b8d dm: spl: Allow de... |
270 |
/** |
340f418ac spl: Add spl_earl... |
271 |
* spl_early_init() - Set up device tree and driver model in SPL if enabled |
070d00b8d dm: spl: Allow de... |
272 273 |
* * Call this function in board_init_f() if you want to use device tree and |
340f418ac spl: Add spl_earl... |
274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 |
* driver model early, before board_init_r() is called. * * If this is not called, then driver model will be inactive in SPL's * board_init_f(), and no device tree will be available. */ int spl_early_init(void); /** * spl_init() - Set up device tree and driver model in SPL if enabled * * You can optionally call spl_early_init(), then optionally call spl_init(). * This function will be called from board_init_r() if not called earlier. * * Both spl_early_init() and spl_init() perform a similar function except that * the latter will not set up the malloc() area if * CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN is enabled, since it is assumed to * already be done by a calll to spl_relocate_stack_gd() before board_init_r() * is reached. * * This function will be called from board_init_r() if not called earlier. |
070d00b8d dm: spl: Allow de... |
294 295 296 297 298 |
* * If this is not called, then driver model will be inactive in SPL's * board_init_f(), and no device tree will be available. */ int spl_init(void); |
47f7bcae8 SPL: Move the oma... |
299 300 301 |
#ifdef CONFIG_SPL_BOARD_INIT void spl_board_init(void); #endif |
32ba8952c arm: spl: Add an ... |
302 303 304 305 306 307 308 309 310 311 |
/** * spl_was_boot_source() - check if U-Boot booted from SPL * * This will normally be true, but if U-Boot jumps to second U-Boot, it will * be false. This should be implemented by board-specific code. * * @return true if U-Boot booted from SPL, else false */ bool spl_was_boot_source(void); |
52f2acc5e spl: dfu: adding ... |
312 313 314 315 316 317 318 319 |
/** * spl_dfu_cmd- run dfu command with chosen mmc device interface * @param usb_index - usb controller number * @param mmc_dev - mmc device nubmer * * @return 0 on success, otherwise error code */ int spl_dfu_cmd(int usbctrl, char *dfu_alt_info, char *interface, char *devstr); |
e50d76cc3 spl: Move spl_boa... |
320 |
|
09410c657 SPL: mmc: Make sp... |
321 322 |
int spl_mmc_load_image(struct spl_image_info *spl_image, struct spl_boot_device *bootdev); |
f2efe6786 spl: change load_... |
323 324 325 326 |
/** * spl_invoke_atf - boot using an ARM trusted firmware image */ void spl_invoke_atf(struct spl_image_info *spl_image); |
225d30b70 spl: add a 'retur... |
327 328 |
/** |
70fe28763 spl: add support ... |
329 330 331 332 333 334 335 336 337 338 339 340 341 |
* spl_optee_entry - entry function for optee * * args defind in op-tee project * https://github.com/OP-TEE/optee_os/ * core/arch/arm/kernel/generic_entry_a32.S * @arg0: pagestore * @arg1: (ARMv7 standard bootarg #1) * @arg2: device tree address, (ARMv7 standard bootarg #2) * @arg3: non-secure entry address (ARMv7 bootarg #0) */ void spl_optee_entry(void *arg0, void *arg1, void *arg2, void *arg3); /** |
225d30b70 spl: add a 'retur... |
342 343 344 345 346 347 348 349 |
* board_return_to_bootrom - allow for boards to continue with the boot ROM * * If a board (e.g. the Rockchip RK3368 boards) provide some * supporting functionality for SPL in their boot ROM and the SPL * stage wants to return to the ROM code to continue booting, boards * can implement 'board_return_to_bootrom'. */ void board_return_to_bootrom(void); |
de5dd4c4e spl: record boot_... |
350 351 |
/** |
28ded1f37 spl: introduce fu... |
352 353 354 355 356 357 358 359 360 361 362 363 |
* board_spl_fit_post_load - allow process images after loading finished * */ void board_spl_fit_post_load(ulong load_addr, size_t length); /** * board_spl_fit_size_align - specific size align before processing payload * */ ulong board_spl_fit_size_align(ulong size); /** |
de5dd4c4e spl: record boot_... |
364 365 366 367 |
* spl_perform_fixups() - arch/board-specific callback before processing * the boot-payload */ void spl_perform_fixups(struct spl_image_info *spl_image); |
04ce5427b spl: Weed out CON... |
368 369 370 371 372 373 374 375 |
/* * spl_get_load_buffer() - get buffer for loading partial image data * * Returns memory area which can be populated by partial image data, * ie. uImage or fitImage header. */ struct image_header *spl_get_load_buffer(ssize_t offset, size_t size); |
47f7bcae8 SPL: Move the oma... |
376 |
#endif |