Tom Rini | 10e4779 | 2018-05-06 17:58:06 -0400 | [diff] [blame] | 1 | /* SPDX-License-Identifier: GPL-2.0+ */ |
Tom Rini | 28591df | 2012-08-13 12:03:19 -0700 | [diff] [blame] | 2 | /* |
| 3 | * (C) Copyright 2012 |
| 4 | * Texas Instruments, <www.ti.com> |
Tom Rini | 28591df | 2012-08-13 12:03:19 -0700 | [diff] [blame] | 5 | */ |
| 6 | #ifndef _SPL_H_ |
| 7 | #define _SPL_H_ |
| 8 | |
Simon Glass | 867a398 | 2017-11-13 18:55:03 -0700 | [diff] [blame] | 9 | #include <binman_sym.h> |
Simon Glass | 0f2af88 | 2020-05-10 11:40:05 -0600 | [diff] [blame] | 10 | #include <linker_lists.h> |
Simon Glass | 867a398 | 2017-11-13 18:55:03 -0700 | [diff] [blame] | 11 | |
Tom Rini | 28591df | 2012-08-13 12:03:19 -0700 | [diff] [blame] | 12 | /* Platform-specific defines */ |
Tom Rini | 31dfba4 | 2012-08-22 15:31:05 -0700 | [diff] [blame] | 13 | #include <linux/compiler.h> |
Masahiro Yamada | 5a5ef78 | 2020-02-25 02:25:46 +0900 | [diff] [blame] | 14 | #include <asm/global_data.h> |
Tom Rini | 28591df | 2012-08-13 12:03:19 -0700 | [diff] [blame] | 15 | #include <asm/spl.h> |
Simon Glass | e14f1a2 | 2018-11-15 18:44:09 -0700 | [diff] [blame] | 16 | #include <handoff.h> |
Andre Przywara | 3cb12ef | 2021-07-12 11:06:49 +0100 | [diff] [blame] | 17 | #include <mmc.h> |
Tom Rini | 28591df | 2012-08-13 12:03:19 -0700 | [diff] [blame] | 18 | |
Masahiro Yamada | 5a5ef78 | 2020-02-25 02:25:46 +0900 | [diff] [blame] | 19 | struct blk_desc; |
Simon Glass | bb7d3bb | 2022-09-06 20:26:52 -0600 | [diff] [blame] | 20 | struct legacy_img_hdr; |
Masahiro Yamada | 5a5ef78 | 2020-02-25 02:25:46 +0900 | [diff] [blame] | 21 | |
Simon Glass | a77e1b8 | 2015-05-13 07:02:24 -0600 | [diff] [blame] | 22 | /* Value in r0 indicates we booted from U-Boot */ |
| 23 | #define UBOOT_NOT_LOADED_FROM_SPL 0x13578642 |
Dan Murphy | b7b5b0c | 2014-01-16 11:23:29 -0600 | [diff] [blame] | 24 | |
Tom Rini | 28591df | 2012-08-13 12:03:19 -0700 | [diff] [blame] | 25 | /* Boot type */ |
| 26 | #define MMCSD_MODE_UNDEFINED 0 |
| 27 | #define MMCSD_MODE_RAW 1 |
Guillaume GARDET | 602a16c | 2014-10-15 17:53:11 +0200 | [diff] [blame] | 28 | #define MMCSD_MODE_FS 2 |
Tom Rini | cc61269 | 2014-02-05 10:24:18 -0500 | [diff] [blame] | 29 | #define MMCSD_MODE_EMMCBOOT 3 |
Tom Rini | 28591df | 2012-08-13 12:03:19 -0700 | [diff] [blame] | 30 | |
Simon Glass | 655306c | 2020-05-10 11:39:58 -0600 | [diff] [blame] | 31 | struct blk_desc; |
Simon Glass | bb7d3bb | 2022-09-06 20:26:52 -0600 | [diff] [blame] | 32 | struct legacy_img_hdr; |
Pali Rohár | dda8f88 | 2022-01-14 14:31:38 +0100 | [diff] [blame] | 33 | struct spl_boot_device; |
Tom Rini | e089740 | 2023-07-13 20:37:34 -0400 | [diff] [blame] | 34 | enum boot_device; |
Simon Glass | 1e26864 | 2020-05-10 11:39:55 -0600 | [diff] [blame] | 35 | |
Simon Glass | 4e0a52d | 2018-11-15 18:43:51 -0700 | [diff] [blame] | 36 | /* |
| 37 | * u_boot_first_phase() - check if this is the first U-Boot phase |
| 38 | * |
| 39 | * U-Boot has up to three phases: TPL, SPL and U-Boot proper. Depending on the |
| 40 | * build flags we can determine whether the current build is for the first |
| 41 | * phase of U-Boot or not. If there is no SPL, then this is U-Boot proper. If |
| 42 | * there is SPL but no TPL, the the first phase is SPL. If there is TPL, then |
| 43 | * it is the first phase. |
| 44 | * |
| 45 | * @returns true if this is the first phase of U-Boot |
| 46 | * |
| 47 | */ |
| 48 | static inline bool u_boot_first_phase(void) |
| 49 | { |
| 50 | if (IS_ENABLED(CONFIG_TPL)) { |
| 51 | if (IS_ENABLED(CONFIG_TPL_BUILD)) |
| 52 | return true; |
| 53 | } else if (IS_ENABLED(CONFIG_SPL)) { |
| 54 | if (IS_ENABLED(CONFIG_SPL_BUILD)) |
| 55 | return true; |
| 56 | } else { |
| 57 | return true; |
| 58 | } |
| 59 | |
| 60 | return false; |
| 61 | } |
| 62 | |
Simon Glass | b7fb513 | 2019-09-25 08:11:20 -0600 | [diff] [blame] | 63 | enum u_boot_phase { |
Simon Glass | 95e4ec1 | 2021-01-13 20:29:42 -0700 | [diff] [blame] | 64 | PHASE_NONE, /* Invalid phase, signifying before U-Boot */ |
Simon Glass | 3c573b5 | 2019-09-25 08:56:30 -0600 | [diff] [blame] | 65 | PHASE_TPL, /* Running in TPL */ |
Simon Glass | 7eec884 | 2022-04-30 00:56:52 -0600 | [diff] [blame] | 66 | PHASE_VPL, /* Running in VPL */ |
Simon Glass | 3c573b5 | 2019-09-25 08:56:30 -0600 | [diff] [blame] | 67 | PHASE_SPL, /* Running in SPL */ |
| 68 | PHASE_BOARD_F, /* Running in U-Boot before relocation */ |
| 69 | PHASE_BOARD_R, /* Running in U-Boot after relocation */ |
Simon Glass | c017c52 | 2022-10-20 18:23:19 -0600 | [diff] [blame] | 70 | |
| 71 | PHASE_COUNT, |
Simon Glass | b7fb513 | 2019-09-25 08:11:20 -0600 | [diff] [blame] | 72 | }; |
| 73 | |
| 74 | /** |
| 75 | * spl_phase() - Find out the phase of U-Boot |
| 76 | * |
| 77 | * This can be used to avoid #ifdef logic and use if() instead. |
| 78 | * |
| 79 | * For example, to include code only in TPL, you might do: |
| 80 | * |
| 81 | * #ifdef CONFIG_TPL_BUILD |
| 82 | * ... |
| 83 | * #endif |
| 84 | * |
| 85 | * but with this you can use: |
| 86 | * |
| 87 | * if (spl_phase() == PHASE_TPL) { |
| 88 | * ... |
| 89 | * } |
| 90 | * |
| 91 | * To include code only in SPL, you might do: |
| 92 | * |
| 93 | * #if defined(CONFIG_SPL_BUILD) && !defined(CONFIG_TPL_BUILD) |
| 94 | * ... |
| 95 | * #endif |
| 96 | * |
| 97 | * but with this you can use: |
| 98 | * |
| 99 | * if (spl_phase() == PHASE_SPL) { |
| 100 | * ... |
| 101 | * } |
| 102 | * |
| 103 | * To include code only in U-Boot proper, you might do: |
| 104 | * |
| 105 | * #ifndef CONFIG_SPL_BUILD |
| 106 | * ... |
| 107 | * #endif |
| 108 | * |
| 109 | * but with this you can use: |
| 110 | * |
Simon Glass | 3c573b5 | 2019-09-25 08:56:30 -0600 | [diff] [blame] | 111 | * if (spl_phase() == PHASE_BOARD_F) { |
Simon Glass | b7fb513 | 2019-09-25 08:11:20 -0600 | [diff] [blame] | 112 | * ... |
| 113 | * } |
| 114 | * |
Heinrich Schuchardt | 47b4c02 | 2022-01-19 18:05:50 +0100 | [diff] [blame] | 115 | * Return: U-Boot phase |
Simon Glass | b7fb513 | 2019-09-25 08:11:20 -0600 | [diff] [blame] | 116 | */ |
| 117 | static inline enum u_boot_phase spl_phase(void) |
| 118 | { |
| 119 | #ifdef CONFIG_TPL_BUILD |
| 120 | return PHASE_TPL; |
Simon Glass | 7eec884 | 2022-04-30 00:56:52 -0600 | [diff] [blame] | 121 | #elif defined(CONFIG_VPL_BUILD) |
| 122 | return PHASE_VPL; |
| 123 | #elif defined(CONFIG_SPL_BUILD) |
Simon Glass | b7fb513 | 2019-09-25 08:11:20 -0600 | [diff] [blame] | 124 | return PHASE_SPL; |
| 125 | #else |
Simon Glass | 3c573b5 | 2019-09-25 08:56:30 -0600 | [diff] [blame] | 126 | DECLARE_GLOBAL_DATA_PTR; |
| 127 | |
| 128 | if (!(gd->flags & GD_FLG_RELOC)) |
| 129 | return PHASE_BOARD_F; |
| 130 | else |
| 131 | return PHASE_BOARD_R; |
Simon Glass | b7fb513 | 2019-09-25 08:11:20 -0600 | [diff] [blame] | 132 | #endif |
| 133 | } |
| 134 | |
Simon Glass | 38da4f9 | 2023-09-26 08:14:55 -0600 | [diff] [blame] | 135 | /* returns true if in U-Boot proper, false if in SPL */ |
| 136 | static inline bool spl_in_proper(void) |
| 137 | { |
| 138 | #ifdef CONFIG_SPL_BUILD |
| 139 | return false; |
| 140 | #endif |
| 141 | |
| 142 | return true; |
| 143 | } |
| 144 | |
Simon Glass | 95e4ec1 | 2021-01-13 20:29:42 -0700 | [diff] [blame] | 145 | /** |
| 146 | * spl_prev_phase() - Figure out the previous U-Boot phase |
| 147 | * |
Heinrich Schuchardt | 47b4c02 | 2022-01-19 18:05:50 +0100 | [diff] [blame] | 148 | * Return: the previous phase from this one, e.g. if called in SPL this returns |
Simon Glass | 95e4ec1 | 2021-01-13 20:29:42 -0700 | [diff] [blame] | 149 | * PHASE_TPL, if TPL is enabled |
| 150 | */ |
| 151 | static inline enum u_boot_phase spl_prev_phase(void) |
| 152 | { |
| 153 | #ifdef CONFIG_TPL_BUILD |
| 154 | return PHASE_NONE; |
Simon Glass | 7eec884 | 2022-04-30 00:56:52 -0600 | [diff] [blame] | 155 | #elif defined(CONFIG_VPL_BUILD) |
| 156 | return PHASE_TPL; /* VPL requires TPL */ |
Simon Glass | 95e4ec1 | 2021-01-13 20:29:42 -0700 | [diff] [blame] | 157 | #elif defined(CONFIG_SPL_BUILD) |
Simon Glass | 7eec884 | 2022-04-30 00:56:52 -0600 | [diff] [blame] | 158 | return IS_ENABLED(CONFIG_VPL) ? PHASE_VPL : |
| 159 | IS_ENABLED(CONFIG_TPL) ? PHASE_TPL : |
| 160 | PHASE_NONE; |
Simon Glass | 95e4ec1 | 2021-01-13 20:29:42 -0700 | [diff] [blame] | 161 | #else |
Simon Glass | 7eec884 | 2022-04-30 00:56:52 -0600 | [diff] [blame] | 162 | return IS_ENABLED(CONFIG_SPL) ? PHASE_SPL : |
| 163 | PHASE_NONE; |
Simon Glass | 95e4ec1 | 2021-01-13 20:29:42 -0700 | [diff] [blame] | 164 | #endif |
| 165 | } |
| 166 | |
| 167 | /** |
| 168 | * spl_next_phase() - Figure out the next U-Boot phase |
| 169 | * |
Heinrich Schuchardt | 47b4c02 | 2022-01-19 18:05:50 +0100 | [diff] [blame] | 170 | * Return: the next phase from this one, e.g. if called in TPL this returns |
Simon Glass | 95e4ec1 | 2021-01-13 20:29:42 -0700 | [diff] [blame] | 171 | * PHASE_SPL |
| 172 | */ |
| 173 | static inline enum u_boot_phase spl_next_phase(void) |
| 174 | { |
| 175 | #ifdef CONFIG_TPL_BUILD |
Simon Glass | 7eec884 | 2022-04-30 00:56:52 -0600 | [diff] [blame] | 176 | return IS_ENABLED(CONFIG_VPL) ? PHASE_VPL : PHASE_SPL; |
| 177 | #elif defined(CONFIG_VPL_BUILD) |
Simon Glass | 95e4ec1 | 2021-01-13 20:29:42 -0700 | [diff] [blame] | 178 | return PHASE_SPL; |
| 179 | #else |
| 180 | return PHASE_BOARD_F; |
| 181 | #endif |
| 182 | } |
| 183 | |
| 184 | /** |
| 185 | * spl_phase_name() - Get the name of the current phase |
| 186 | * |
Heinrich Schuchardt | 47b4c02 | 2022-01-19 18:05:50 +0100 | [diff] [blame] | 187 | * Return: phase name |
Simon Glass | 95e4ec1 | 2021-01-13 20:29:42 -0700 | [diff] [blame] | 188 | */ |
| 189 | static inline const char *spl_phase_name(enum u_boot_phase phase) |
| 190 | { |
| 191 | switch (phase) { |
| 192 | case PHASE_TPL: |
| 193 | return "TPL"; |
Simon Glass | 7eec884 | 2022-04-30 00:56:52 -0600 | [diff] [blame] | 194 | case PHASE_VPL: |
| 195 | return "VPL"; |
Simon Glass | 95e4ec1 | 2021-01-13 20:29:42 -0700 | [diff] [blame] | 196 | case PHASE_SPL: |
| 197 | return "SPL"; |
| 198 | case PHASE_BOARD_F: |
| 199 | case PHASE_BOARD_R: |
| 200 | return "U-Boot"; |
| 201 | default: |
| 202 | return "phase?"; |
| 203 | } |
| 204 | } |
| 205 | |
Simon Glass | 1cd0600 | 2021-07-05 16:32:45 -0600 | [diff] [blame] | 206 | /** |
| 207 | * spl_phase_prefix() - Get the prefix of the current phase |
| 208 | * |
| 209 | * @phase: Phase to look up |
Heinrich Schuchardt | 47b4c02 | 2022-01-19 18:05:50 +0100 | [diff] [blame] | 210 | * Return: phase prefix ("spl", "tpl", etc.) |
Simon Glass | 1cd0600 | 2021-07-05 16:32:45 -0600 | [diff] [blame] | 211 | */ |
| 212 | static inline const char *spl_phase_prefix(enum u_boot_phase phase) |
| 213 | { |
| 214 | switch (phase) { |
| 215 | case PHASE_TPL: |
| 216 | return "tpl"; |
Simon Glass | 7eec884 | 2022-04-30 00:56:52 -0600 | [diff] [blame] | 217 | case PHASE_VPL: |
| 218 | return "vpl"; |
Simon Glass | 1cd0600 | 2021-07-05 16:32:45 -0600 | [diff] [blame] | 219 | case PHASE_SPL: |
| 220 | return "spl"; |
| 221 | case PHASE_BOARD_F: |
| 222 | case PHASE_BOARD_R: |
| 223 | return ""; |
| 224 | default: |
| 225 | return "phase?"; |
| 226 | } |
| 227 | } |
| 228 | |
Simon Glass | dbd3f11 | 2018-11-15 18:43:56 -0700 | [diff] [blame] | 229 | /* A string name for SPL or TPL */ |
| 230 | #ifdef CONFIG_SPL_BUILD |
| 231 | # ifdef CONFIG_TPL_BUILD |
Heiko Schocher | ce25123 | 2018-12-05 11:29:54 +0100 | [diff] [blame] | 232 | # define SPL_TPL_NAME "TPL" |
Simon Glass | 7eec884 | 2022-04-30 00:56:52 -0600 | [diff] [blame] | 233 | # elif defined(CONFIG_VPL_BUILD) |
| 234 | # define SPL_TPL_NAME "VPL" |
Simon Glass | dbd3f11 | 2018-11-15 18:43:56 -0700 | [diff] [blame] | 235 | # else |
Heiko Schocher | ce25123 | 2018-12-05 11:29:54 +0100 | [diff] [blame] | 236 | # define SPL_TPL_NAME "SPL" |
Simon Glass | dbd3f11 | 2018-11-15 18:43:56 -0700 | [diff] [blame] | 237 | # endif |
| 238 | # define SPL_TPL_PROMPT SPL_TPL_NAME ": " |
| 239 | #else |
| 240 | # define SPL_TPL_NAME "" |
| 241 | # define SPL_TPL_PROMPT "" |
| 242 | #endif |
| 243 | |
Simon Glass | 4aa6a9b | 2022-10-20 18:23:01 -0600 | [diff] [blame] | 244 | /** |
| 245 | * enum spl_sandbox_flags - flags for sandbox's use of spl_image_info->flags |
| 246 | * |
| 247 | * @SPL_SANDBOXF_ARG_IS_FNAME: arg is the filename to jump to (default) |
Simon Glass | a87cd0c | 2022-10-20 18:23:08 -0600 | [diff] [blame] | 248 | * @SPL_SANDBOXF_ARG_IS_BUF: arg is the containing image to jump to, @offset is |
| 249 | * the start offset within the image, @size is the size of the image |
Simon Glass | 4aa6a9b | 2022-10-20 18:23:01 -0600 | [diff] [blame] | 250 | */ |
| 251 | enum spl_sandbox_flags { |
| 252 | SPL_SANDBOXF_ARG_IS_FNAME = 0, |
Simon Glass | a87cd0c | 2022-10-20 18:23:08 -0600 | [diff] [blame] | 253 | SPL_SANDBOXF_ARG_IS_BUF, |
Simon Glass | 4aa6a9b | 2022-10-20 18:23:01 -0600 | [diff] [blame] | 254 | }; |
| 255 | |
Tom Rini | 28591df | 2012-08-13 12:03:19 -0700 | [diff] [blame] | 256 | struct spl_image_info { |
| 257 | const char *name; |
| 258 | u8 os; |
Philipp Tomsich | f13e9e0 | 2017-09-13 21:29:31 +0200 | [diff] [blame] | 259 | uintptr_t load_addr; |
| 260 | uintptr_t entry_point; |
Marek Vasut | 187b9e3 | 2019-05-07 21:17:02 +0200 | [diff] [blame] | 261 | #if CONFIG_IS_ENABLED(LOAD_FIT) || CONFIG_IS_ENABLED(LOAD_FIT_FULL) |
Philipp Tomsich | be5ac1a | 2017-09-13 21:29:30 +0200 | [diff] [blame] | 262 | void *fdt_addr; |
| 263 | #endif |
Philipp Tomsich | 58beb6e | 2018-05-24 17:15:50 +0200 | [diff] [blame] | 264 | u32 boot_device; |
Pali Rohár | 1104167 | 2021-07-23 11:14:27 +0200 | [diff] [blame] | 265 | u32 offset; |
Tom Rini | 28591df | 2012-08-13 12:03:19 -0700 | [diff] [blame] | 266 | u32 size; |
Stefan Roese | 00b57b3 | 2012-08-27 12:50:58 +0200 | [diff] [blame] | 267 | u32 flags; |
Vikas Manocha | 62b021c | 2017-04-07 15:38:13 -0700 | [diff] [blame] | 268 | void *arg; |
Simon Goldschmidt | 1714047 | 2019-02-10 21:34:37 +0100 | [diff] [blame] | 269 | #ifdef CONFIG_SPL_LEGACY_IMAGE_CRC_CHECK |
| 270 | ulong dcrc_data; |
| 271 | ulong dcrc_length; |
| 272 | ulong dcrc; |
| 273 | #endif |
Tom Rini | 28591df | 2012-08-13 12:03:19 -0700 | [diff] [blame] | 274 | }; |
| 275 | |
Simon Glass | 35c84e5 | 2023-09-26 08:14:22 -0600 | [diff] [blame] | 276 | static inline void *spl_image_fdt_addr(struct spl_image_info *info) |
| 277 | { |
| 278 | #if CONFIG_IS_ENABLED(LOAD_FIT) || CONFIG_IS_ENABLED(LOAD_FIT_FULL) |
| 279 | return info->fdt_addr; |
| 280 | #else |
| 281 | return 0; |
| 282 | #endif |
| 283 | } |
| 284 | |
Dario Binacchi | 0f860b6 | 2020-05-27 13:56:18 +0200 | [diff] [blame] | 285 | /** |
Simon Glass | a6131a2 | 2016-02-22 22:55:56 -0700 | [diff] [blame] | 286 | * Information required to load data from a device |
| 287 | * |
| 288 | * @dev: Pointer to the device, e.g. struct mmc * |
| 289 | * @priv: Private data for the device |
| 290 | * @bl_len: Block length for reading in bytes |
Lokesh Vutla | f62cef1 | 2016-05-24 10:34:38 +0530 | [diff] [blame] | 291 | * @filename: Name of the fit image file. |
Simon Glass | a6131a2 | 2016-02-22 22:55:56 -0700 | [diff] [blame] | 292 | * @read: Function to call to read from the device |
| 293 | */ |
| 294 | struct spl_load_info { |
| 295 | void *dev; |
| 296 | void *priv; |
| 297 | int bl_len; |
Lokesh Vutla | f62cef1 | 2016-05-24 10:34:38 +0530 | [diff] [blame] | 298 | const char *filename; |
Simon Glass | ee11209 | 2021-03-07 17:35:15 -0700 | [diff] [blame] | 299 | /** |
| 300 | * read() - Read from device |
| 301 | * |
| 302 | * @load: Information about the load state |
| 303 | * @sector: Sector number to read from (each @load->bl_len bytes) |
| 304 | * @count: Number of sectors to read |
| 305 | * @buf: Buffer to read into |
| 306 | * @return number of sectors read, 0 on error |
| 307 | */ |
Simon Glass | a6131a2 | 2016-02-22 22:55:56 -0700 | [diff] [blame] | 308 | ulong (*read)(struct spl_load_info *load, ulong sector, ulong count, |
| 309 | void *buf); |
| 310 | }; |
| 311 | |
Simon Glass | 867a398 | 2017-11-13 18:55:03 -0700 | [diff] [blame] | 312 | /* |
| 313 | * We need to know the position of U-Boot in memory so we can jump to it. We |
| 314 | * allow any U-Boot binary to be used (u-boot.bin, u-boot-nodtb.bin, |
| 315 | * u-boot.img), hence the '_any'. These is no checking here that the correct |
Simon Glass | 596f31c | 2019-12-08 17:40:12 -0700 | [diff] [blame] | 316 | * image is found. For example if u-boot.img is used we don't check that |
Simon Glass | 867a398 | 2017-11-13 18:55:03 -0700 | [diff] [blame] | 317 | * spl_parse_image_header() can parse a valid header. |
Simon Glass | 596f31c | 2019-12-08 17:40:12 -0700 | [diff] [blame] | 318 | * |
| 319 | * Similarly for SPL, so that TPL can jump to SPL. |
Simon Glass | 867a398 | 2017-11-13 18:55:03 -0700 | [diff] [blame] | 320 | */ |
Simon Glass | 9dcc861 | 2018-08-01 15:22:42 -0600 | [diff] [blame] | 321 | binman_sym_extern(ulong, u_boot_any, image_pos); |
Simon Glass | 596f31c | 2019-12-08 17:40:12 -0700 | [diff] [blame] | 322 | binman_sym_extern(ulong, u_boot_any, size); |
Simon Glass | 5a332c1 | 2022-10-20 18:22:41 -0600 | [diff] [blame] | 323 | binman_sym_extern(ulong, u_boot_spl_any, image_pos); |
| 324 | binman_sym_extern(ulong, u_boot_spl_any, size); |
| 325 | binman_sym_extern(ulong, u_boot_vpl_any, image_pos); |
| 326 | binman_sym_extern(ulong, u_boot_vpl_any, size); |
Simon Glass | 596f31c | 2019-12-08 17:40:12 -0700 | [diff] [blame] | 327 | |
| 328 | /** |
| 329 | * spl_get_image_pos() - get the image position of the next phase |
| 330 | * |
| 331 | * This returns the image position to use to load the next phase of U-Boot |
| 332 | */ |
| 333 | ulong spl_get_image_pos(void); |
| 334 | |
| 335 | /** |
| 336 | * spl_get_image_size() - get the size of the next phase |
| 337 | * |
| 338 | * This returns the size to use to load the next phase of U-Boot |
| 339 | */ |
| 340 | ulong spl_get_image_size(void); |
Simon Glass | 867a398 | 2017-11-13 18:55:03 -0700 | [diff] [blame] | 341 | |
Lokesh Vutla | f62cef1 | 2016-05-24 10:34:38 +0530 | [diff] [blame] | 342 | /** |
Simon Glass | 53857ee | 2021-01-24 10:06:03 -0700 | [diff] [blame] | 343 | * spl_get_image_text_base() - get the text base of the next phase |
| 344 | * |
| 345 | * This returns the address that the next stage is linked to run at, i.e. |
Simon Glass | 72cc538 | 2022-10-20 18:22:39 -0600 | [diff] [blame] | 346 | * CONFIG_SPL_TEXT_BASE or CONFIG_TEXT_BASE |
Simon Glass | 53857ee | 2021-01-24 10:06:03 -0700 | [diff] [blame] | 347 | * |
Heinrich Schuchardt | 47b4c02 | 2022-01-19 18:05:50 +0100 | [diff] [blame] | 348 | * Return: text-base address |
Simon Glass | 53857ee | 2021-01-24 10:06:03 -0700 | [diff] [blame] | 349 | */ |
| 350 | ulong spl_get_image_text_base(void); |
| 351 | |
| 352 | /** |
Andreas Dannenberg | 8d9f7f1 | 2019-06-04 17:55:46 -0500 | [diff] [blame] | 353 | * spl_load_simple_fit_skip_processing() - Hook to allow skipping the FIT |
| 354 | * image processing during spl_load_simple_fit(). |
| 355 | * |
| 356 | * Return true to skip FIT processing, false to preserve the full code flow |
| 357 | * of spl_load_simple_fit(). |
| 358 | */ |
| 359 | bool spl_load_simple_fit_skip_processing(void); |
| 360 | |
| 361 | /** |
Heiko Schocher | 67e8f5d | 2021-08-06 06:44:26 +0200 | [diff] [blame] | 362 | * spl_load_simple_fit_fix_load() - Hook to make fixes |
| 363 | * after fit image header is loaded |
| 364 | * |
| 365 | * Returns pointer to fit |
| 366 | */ |
| 367 | void *spl_load_simple_fit_fix_load(const void *fit); |
| 368 | |
| 369 | /** |
Lokesh Vutla | f62cef1 | 2016-05-24 10:34:38 +0530 | [diff] [blame] | 370 | * spl_load_simple_fit() - Loads a fit image from a device. |
Simon Glass | 43a734f | 2016-09-24 18:20:16 -0600 | [diff] [blame] | 371 | * @spl_image: Image description to set up |
Lokesh Vutla | f62cef1 | 2016-05-24 10:34:38 +0530 | [diff] [blame] | 372 | * @info: Structure containing the information required to load data. |
| 373 | * @sector: Sector number where FIT image is located in the device |
| 374 | * @fdt: Pointer to the copied FIT header. |
| 375 | * |
| 376 | * Reads the FIT image @sector in the device. Loads u-boot image to |
| 377 | * specified load address and copies the dtb to end of u-boot image. |
| 378 | * Returns 0 on success. |
| 379 | */ |
Simon Glass | 43a734f | 2016-09-24 18:20:16 -0600 | [diff] [blame] | 380 | int spl_load_simple_fit(struct spl_image_info *spl_image, |
| 381 | struct spl_load_info *info, ulong sector, void *fdt); |
Simon Glass | a6131a2 | 2016-02-22 22:55:56 -0700 | [diff] [blame] | 382 | |
Stefan Roese | 00b57b3 | 2012-08-27 12:50:58 +0200 | [diff] [blame] | 383 | #define SPL_COPY_PAYLOAD_ONLY 1 |
Ye Li | 9d5b0f4 | 2018-11-17 09:10:25 +0000 | [diff] [blame] | 384 | #define SPL_FIT_FOUND 2 |
Stefan Roese | 00b57b3 | 2012-08-27 12:50:58 +0200 | [diff] [blame] | 385 | |
Peng Fan | d867076 | 2019-08-22 07:42:38 +0000 | [diff] [blame] | 386 | /** |
Stefan Roese | 84ae9d8 | 2020-04-21 09:28:43 +0200 | [diff] [blame] | 387 | * spl_load_legacy_img() - Loads a legacy image from a device. |
| 388 | * @spl_image: Image description to set up |
| 389 | * @load: Structure containing the information required to load data. |
Roger Quadros | 237f018 | 2022-09-29 13:11:28 +0300 | [diff] [blame] | 390 | * @offset: Pointer to image |
| 391 | * @hdr: Pointer to image header |
Stefan Roese | 84ae9d8 | 2020-04-21 09:28:43 +0200 | [diff] [blame] | 392 | * |
| 393 | * Reads an legacy image from the device. Loads u-boot image to |
| 394 | * specified load address. |
| 395 | * Returns 0 on success. |
| 396 | */ |
| 397 | int spl_load_legacy_img(struct spl_image_info *spl_image, |
Pali Rohár | dda8f88 | 2022-01-14 14:31:38 +0100 | [diff] [blame] | 398 | struct spl_boot_device *bootdev, |
Roger Quadros | 237f018 | 2022-09-29 13:11:28 +0300 | [diff] [blame] | 399 | struct spl_load_info *load, ulong offset, |
| 400 | struct legacy_img_hdr *hdr); |
| 401 | |
Stefan Roese | 84ae9d8 | 2020-04-21 09:28:43 +0200 | [diff] [blame] | 402 | |
| 403 | /** |
Peng Fan | d867076 | 2019-08-22 07:42:38 +0000 | [diff] [blame] | 404 | * spl_load_imx_container() - Loads a imx container image from a device. |
| 405 | * @spl_image: Image description to set up |
| 406 | * @info: Structure containing the information required to load data. |
| 407 | * @sector: Sector number where container image is located in the device |
| 408 | * |
| 409 | * Reads the container image @sector in the device. Loads u-boot image to |
| 410 | * specified load address. |
| 411 | */ |
| 412 | int spl_load_imx_container(struct spl_image_info *spl_image, |
| 413 | struct spl_load_info *info, ulong sector); |
| 414 | |
Tom Rini | 28591df | 2012-08-13 12:03:19 -0700 | [diff] [blame] | 415 | /* SPL common functions */ |
| 416 | void preloader_console_init(void); |
| 417 | u32 spl_boot_device(void); |
Harald Seiler | 0bf7ab1 | 2020-04-15 11:33:30 +0200 | [diff] [blame] | 418 | |
| 419 | /** |
Vaishnav Achath | 58a0cdb | 2022-06-03 11:32:15 +0530 | [diff] [blame] | 420 | * spl_spi_boot_bus() - Lookup function for the SPI boot bus source. |
| 421 | * |
| 422 | * This function returns the SF bus to load from. |
| 423 | * If not overridden, it is weakly defined in common/spl/spl_spi.c. |
| 424 | */ |
| 425 | u32 spl_spi_boot_bus(void); |
| 426 | |
| 427 | /** |
| 428 | * spl_spi_boot_cs() - Lookup function for the SPI boot CS source. |
| 429 | * |
| 430 | * This function returns the SF CS to load from. |
| 431 | * If not overridden, it is weakly defined in common/spl/spl_spi.c. |
| 432 | */ |
| 433 | u32 spl_spi_boot_cs(void); |
| 434 | |
| 435 | /** |
Harald Seiler | 0bf7ab1 | 2020-04-15 11:33:30 +0200 | [diff] [blame] | 436 | * spl_mmc_boot_mode() - Lookup function for the mode of an MMC boot source. |
| 437 | * @boot_device: ID of the device which the MMC driver wants to read |
| 438 | * from. Common values are e.g. BOOT_DEVICE_MMC1, |
| 439 | * BOOT_DEVICE_MMC2, BOOT_DEVICE_MMC2_2. |
| 440 | * |
| 441 | * This function should return one of MMCSD_MODE_FS, MMCSD_MODE_EMMCBOOT, or |
| 442 | * MMCSD_MODE_RAW for each MMC boot source which is defined for the target. The |
| 443 | * boot_device parameter tells which device the MMC driver is interested in. |
| 444 | * |
| 445 | * If not overridden, it is weakly defined in common/spl/spl_mmc.c. |
| 446 | * |
| 447 | * Note: It is important to use the boot_device parameter instead of e.g. |
| 448 | * spl_boot_device() as U-Boot is not always loaded from the same device as SPL. |
| 449 | */ |
Andre Przywara | 3cb12ef | 2021-07-12 11:06:49 +0100 | [diff] [blame] | 450 | u32 spl_mmc_boot_mode(struct mmc *mmc, const u32 boot_device); |
Harald Seiler | bf16c30 | 2020-04-15 11:33:31 +0200 | [diff] [blame] | 451 | |
| 452 | /** |
| 453 | * spl_mmc_boot_partition() - MMC partition to load U-Boot from. |
| 454 | * @boot_device: ID of the device which the MMC driver wants to load |
| 455 | * U-Boot from. |
| 456 | * |
| 457 | * This function should return the partition number which the SPL |
| 458 | * should load U-Boot from (on the given boot_device) when |
| 459 | * CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_USE_PARTITION is set. |
| 460 | * |
| 461 | * If not overridden, it is weakly defined in common/spl/spl_mmc.c. |
| 462 | */ |
| 463 | int spl_mmc_boot_partition(const u32 boot_device); |
Marek Vasut | de1ce23 | 2021-07-03 04:55:32 +0200 | [diff] [blame] | 464 | |
| 465 | struct mmc; |
| 466 | /** |
| 467 | * default_spl_mmc_emmc_boot_partition() - eMMC boot partition to load U-Boot from. |
| 468 | * mmc: Pointer for the mmc device structure |
| 469 | * |
| 470 | * This function should return the eMMC boot partition number which |
| 471 | * the SPL should load U-Boot from (on the given boot_device). |
| 472 | */ |
| 473 | int default_spl_mmc_emmc_boot_partition(struct mmc *mmc); |
| 474 | |
| 475 | /** |
| 476 | * spl_mmc_emmc_boot_partition() - eMMC boot partition to load U-Boot from. |
| 477 | * mmc: Pointer for the mmc device structure |
| 478 | * |
| 479 | * This function should return the eMMC boot partition number which |
| 480 | * the SPL should load U-Boot from (on the given boot_device). |
| 481 | * |
| 482 | * If not overridden, it is weakly defined in common/spl/spl_mmc.c |
| 483 | * and calls default_spl_mmc_emmc_boot_partition(); |
| 484 | */ |
| 485 | int spl_mmc_emmc_boot_partition(struct mmc *mmc); |
| 486 | |
Alexandru Gagniuc | 7861f8b | 2021-04-08 11:56:11 -0500 | [diff] [blame] | 487 | void spl_set_bd(void); |
Simon Glass | 11a1a27 | 2016-09-24 18:19:52 -0600 | [diff] [blame] | 488 | |
| 489 | /** |
Tom Rini | a3a142c | 2023-03-09 11:22:08 -0500 | [diff] [blame] | 490 | * spl_mmc_get_uboot_raw_sector() - Provide raw sector of the start of U-Boot |
| 491 | * |
| 492 | * This is a weak function which by default will provide the raw sector that is |
| 493 | * where the start of the U-Boot image has been written to. |
| 494 | * |
| 495 | * @mmc: struct mmc that describes the devie where U-Boot resides |
| 496 | * @raw_sect: The raw sector number where U-Boot is by default. |
| 497 | * Return: The raw sector location that U-Boot resides at |
| 498 | */ |
| 499 | unsigned long spl_mmc_get_uboot_raw_sector(struct mmc *mmc, |
| 500 | unsigned long raw_sect); |
| 501 | |
| 502 | /** |
Simon Glass | 11a1a27 | 2016-09-24 18:19:52 -0600 | [diff] [blame] | 503 | * spl_set_header_raw_uboot() - Set up a standard SPL image structure |
| 504 | * |
| 505 | * This sets up the given spl_image which the standard values obtained from |
Jesse Taube | 93ee5c8 | 2023-08-24 21:59:48 -0400 | [diff] [blame] | 506 | * config options: CONFIG_SYS_MONITOR_LEN, CONFIG_SYS_UBOOT_START, |
Simon Glass | 72cc538 | 2022-10-20 18:22:39 -0600 | [diff] [blame] | 507 | * CONFIG_TEXT_BASE. |
Simon Glass | 11a1a27 | 2016-09-24 18:19:52 -0600 | [diff] [blame] | 508 | * |
Simon Glass | 6b2e4db | 2016-09-24 18:19:53 -0600 | [diff] [blame] | 509 | * @spl_image: Image description to set up |
Simon Glass | 11a1a27 | 2016-09-24 18:19:52 -0600 | [diff] [blame] | 510 | */ |
| 511 | void spl_set_header_raw_uboot(struct spl_image_info *spl_image); |
| 512 | |
Simon Glass | 6b2e4db | 2016-09-24 18:19:53 -0600 | [diff] [blame] | 513 | /** |
| 514 | * spl_parse_image_header() - parse the image header and set up info |
| 515 | * |
| 516 | * This parses the legacy image header information at @header and sets up |
| 517 | * @spl_image according to what is found. If no image header is found, then |
| 518 | * a raw image or bootz is assumed. If CONFIG_SPL_PANIC_ON_RAW_IMAGE is |
Andrew F. Davis | b4be3c3 | 2017-02-16 11:18:38 -0600 | [diff] [blame] | 519 | * enabled, then this causes a panic. If CONFIG_SPL_RAW_IMAGE_SUPPORT is not |
Simon Glass | 6b2e4db | 2016-09-24 18:19:53 -0600 | [diff] [blame] | 520 | * enabled then U-Boot gives up. Otherwise U-Boot sets up the image using |
| 521 | * spl_set_header_raw_uboot(), or possibly the bootz header. |
| 522 | * |
| 523 | * @spl_image: Image description to set up |
| 524 | * @header image header to parse |
Heinrich Schuchardt | 47b4c02 | 2022-01-19 18:05:50 +0100 | [diff] [blame] | 525 | * Return: 0 if a header was correctly parsed, -ve on error |
Simon Glass | 6b2e4db | 2016-09-24 18:19:53 -0600 | [diff] [blame] | 526 | */ |
| 527 | int spl_parse_image_header(struct spl_image_info *spl_image, |
Pali Rohár | dda8f88 | 2022-01-14 14:31:38 +0100 | [diff] [blame] | 528 | const struct spl_boot_device *bootdev, |
Simon Glass | bb7d3bb | 2022-09-06 20:26:52 -0600 | [diff] [blame] | 529 | const struct legacy_img_hdr *header); |
Simon Glass | 6b2e4db | 2016-09-24 18:19:53 -0600 | [diff] [blame] | 530 | |
Tom Rini | 28591df | 2012-08-13 12:03:19 -0700 | [diff] [blame] | 531 | void spl_board_prepare_for_linux(void); |
Alexandru Gagniuc | f2b410a | 2021-07-15 14:19:24 -0500 | [diff] [blame] | 532 | |
| 533 | /** |
| 534 | * spl_board_prepare_for_optee() - Prepare board for an OPTEE payload |
| 535 | * |
| 536 | * Prepares the board for booting an OP-TEE payload. Initialization is platform |
| 537 | * specific, and may include configuring the TrustZone memory, and other |
| 538 | * initialization steps required by OP-TEE. |
| 539 | * Note that @fdt is not used directly by OP-TEE. OP-TEE passes this @fdt to |
| 540 | * its normal world target. This target is not guaranteed to be u-boot, so @fdt |
| 541 | * changes that would normally be done by u-boot should be done in this step. |
| 542 | * |
| 543 | * @fdt: Devicetree that will be passed on, or NULL |
| 544 | */ |
| 545 | void spl_board_prepare_for_optee(void *fdt); |
Michal Simek | 7a8465b | 2016-05-10 07:54:20 +0200 | [diff] [blame] | 546 | void spl_board_prepare_for_boot(void); |
Ladislav Michl | 2a8ea48 | 2016-07-12 20:28:13 +0200 | [diff] [blame] | 547 | int spl_board_ubi_load_image(u32 boot_device); |
Tom Rini | e089740 | 2023-07-13 20:37:34 -0400 | [diff] [blame] | 548 | int spl_board_boot_device(enum boot_device boot_dev_spl); |
Simon Glass | b805c35 | 2016-09-24 18:19:54 -0600 | [diff] [blame] | 549 | |
| 550 | /** |
Heiko Thiery | 3db3033 | 2022-01-17 16:25:41 +0100 | [diff] [blame] | 551 | * spl_board_loader_name() - Return a name for the loader |
| 552 | * |
| 553 | * This is a weak function which might be overridden by the board code. With |
| 554 | * that a board specific value for the device where the U-Boot will be loaded |
| 555 | * from can be set. By default it returns NULL. |
| 556 | * |
| 557 | * @boot_device: ID of the device which SPL wants to load U-Boot from. |
| 558 | */ |
| 559 | const char *spl_board_loader_name(u32 boot_device); |
| 560 | |
| 561 | /** |
Simon Glass | b805c35 | 2016-09-24 18:19:54 -0600 | [diff] [blame] | 562 | * jump_to_image_linux() - Jump to a Linux kernel from SPL |
| 563 | * |
| 564 | * This jumps into a Linux kernel using the information in @spl_image. |
| 565 | * |
| 566 | * @spl_image: Image description to set up |
Simon Glass | b805c35 | 2016-09-24 18:19:54 -0600 | [diff] [blame] | 567 | */ |
Vikas Manocha | 62b021c | 2017-04-07 15:38:13 -0700 | [diff] [blame] | 568 | void __noreturn jump_to_image_linux(struct spl_image_info *spl_image); |
Simon Glass | 3e6b1c3 | 2016-09-24 18:19:55 -0600 | [diff] [blame] | 569 | |
| 570 | /** |
Ovidiu Panait | 6abd6d8 | 2023-01-22 19:57:13 +0200 | [diff] [blame] | 571 | * jump_to_image_optee() - Jump to OP-TEE OS from SPL |
Ricardo Salveti | ec0352a | 2021-10-20 15:12:06 +0300 | [diff] [blame] | 572 | * |
| 573 | * This jumps into OP-TEE OS using the information in @spl_image. |
| 574 | * |
| 575 | * @spl_image: Image description to set up |
| 576 | */ |
| 577 | void __noreturn jump_to_image_optee(struct spl_image_info *spl_image); |
| 578 | |
| 579 | /** |
Simon Glass | 3e6b1c3 | 2016-09-24 18:19:55 -0600 | [diff] [blame] | 580 | * spl_start_uboot() - Check if SPL should start the kernel or U-Boot |
| 581 | * |
| 582 | * This is called by the various SPL loaders to determine whether the board |
| 583 | * wants to load the kernel or U-Boot. This function should be provided by |
| 584 | * the board. |
| 585 | * |
Heinrich Schuchardt | 47b4c02 | 2022-01-19 18:05:50 +0100 | [diff] [blame] | 586 | * Return: 0 if SPL should start the kernel, 1 if U-Boot must be started |
Simon Glass | 3e6b1c3 | 2016-09-24 18:19:55 -0600 | [diff] [blame] | 587 | */ |
Tom Rini | 28591df | 2012-08-13 12:03:19 -0700 | [diff] [blame] | 588 | int spl_start_uboot(void); |
Simon Glass | 3e6b1c3 | 2016-09-24 18:19:55 -0600 | [diff] [blame] | 589 | |
Simon Glass | f481ab1 | 2016-09-24 18:19:56 -0600 | [diff] [blame] | 590 | /** |
| 591 | * spl_display_print() - Display a board-specific message in SPL |
| 592 | * |
| 593 | * If CONFIG_SPL_DISPLAY_PRINT is enabled, U-Boot will call this function |
| 594 | * immediately after displaying the SPL console banner ("U-Boot SPL ..."). |
| 595 | * This function should be provided by the board. |
| 596 | */ |
Tom Rini | 28591df | 2012-08-13 12:03:19 -0700 | [diff] [blame] | 597 | void spl_display_print(void); |
| 598 | |
Simon Glass | c0b6c9b | 2016-09-24 18:19:57 -0600 | [diff] [blame] | 599 | /** |
| 600 | * struct spl_boot_device - Describes a boot device used by SPL |
| 601 | * |
| 602 | * @boot_device: A number indicating the BOOT_DEVICE type. There are various |
| 603 | * BOOT_DEVICE... #defines and enums in U-Boot and they are not consistently |
| 604 | * numbered. |
| 605 | * @boot_device_name: Named boot device, or NULL if none. |
| 606 | * |
| 607 | * Note: Additional fields can be added here, bearing in mind that SPL is |
| 608 | * size-sensitive and common fields will be present on all boards. This |
| 609 | * struct can also be used to return additional information about the load |
| 610 | * process if that becomes useful. |
| 611 | */ |
| 612 | struct spl_boot_device { |
| 613 | uint boot_device; |
| 614 | const char *boot_device_name; |
| 615 | }; |
| 616 | |
Simon Glass | d1cf373 | 2016-09-24 18:19:58 -0600 | [diff] [blame] | 617 | /** |
| 618 | * Holds information about a way of loading an SPL image |
| 619 | * |
Simon Glass | 4fc1f25 | 2016-11-30 15:30:50 -0700 | [diff] [blame] | 620 | * @name: User-friendly name for this method (e.g. "MMC") |
Simon Glass | d1cf373 | 2016-09-24 18:19:58 -0600 | [diff] [blame] | 621 | * @boot_device: Boot device that this loader supports |
| 622 | * @load_image: Function to call to load image |
| 623 | */ |
| 624 | struct spl_image_loader { |
Simon Glass | 4fc1f25 | 2016-11-30 15:30:50 -0700 | [diff] [blame] | 625 | #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT |
| 626 | const char *name; |
| 627 | #endif |
Simon Glass | d1cf373 | 2016-09-24 18:19:58 -0600 | [diff] [blame] | 628 | uint boot_device; |
| 629 | /** |
| 630 | * load_image() - Load an SPL image |
| 631 | * |
Simon Glass | ee30679 | 2016-09-24 18:20:13 -0600 | [diff] [blame] | 632 | * @spl_image: place to put image information |
Simon Glass | d1cf373 | 2016-09-24 18:19:58 -0600 | [diff] [blame] | 633 | * @bootdev: describes the boot device to load from |
| 634 | */ |
Simon Glass | ee30679 | 2016-09-24 18:20:13 -0600 | [diff] [blame] | 635 | int (*load_image)(struct spl_image_info *spl_image, |
| 636 | struct spl_boot_device *bootdev); |
Simon Glass | d1cf373 | 2016-09-24 18:19:58 -0600 | [diff] [blame] | 637 | }; |
| 638 | |
Simon Glass | 58254e0 | 2021-07-05 16:32:57 -0600 | [diff] [blame] | 639 | /* Helper function for accessing the name */ |
| 640 | static inline const char *spl_loader_name(const struct spl_image_loader *loader) |
| 641 | { |
| 642 | #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT |
Heiko Thiery | 3db3033 | 2022-01-17 16:25:41 +0100 | [diff] [blame] | 643 | const char *name; |
| 644 | name = spl_board_loader_name(loader->boot_device); |
| 645 | return name ?: loader->name; |
Simon Glass | 58254e0 | 2021-07-05 16:32:57 -0600 | [diff] [blame] | 646 | #else |
| 647 | return NULL; |
| 648 | #endif |
| 649 | } |
| 650 | |
Simon Glass | d1cf373 | 2016-09-24 18:19:58 -0600 | [diff] [blame] | 651 | /* Declare an SPL image loader */ |
| 652 | #define SPL_LOAD_IMAGE(__name) \ |
| 653 | ll_entry_declare(struct spl_image_loader, __name, spl_image_loader) |
| 654 | |
| 655 | /* |
Simon Glass | bf4fd55 | 2016-11-30 15:30:49 -0700 | [diff] [blame] | 656 | * _priority is the priority of this method, 0 meaning it will be the top |
Simon Glass | d1cf373 | 2016-09-24 18:19:58 -0600 | [diff] [blame] | 657 | * choice for this device, 9 meaning it is the bottom choice. |
Simon Glass | bf4fd55 | 2016-11-30 15:30:49 -0700 | [diff] [blame] | 658 | * _boot_device is the BOOT_DEVICE_... value |
| 659 | * _method is the load_image function to call |
Simon Glass | d1cf373 | 2016-09-24 18:19:58 -0600 | [diff] [blame] | 660 | */ |
Simon Glass | 4fc1f25 | 2016-11-30 15:30:50 -0700 | [diff] [blame] | 661 | #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT |
| 662 | #define SPL_LOAD_IMAGE_METHOD(_name, _priority, _boot_device, _method) \ |
Simon Glass | ec1503c | 2019-10-20 21:31:45 -0600 | [diff] [blame] | 663 | SPL_LOAD_IMAGE(_boot_device ## _priority ## _method) = { \ |
Simon Glass | 4fc1f25 | 2016-11-30 15:30:50 -0700 | [diff] [blame] | 664 | .name = _name, \ |
Simon Glass | bf4fd55 | 2016-11-30 15:30:49 -0700 | [diff] [blame] | 665 | .boot_device = _boot_device, \ |
| 666 | .load_image = _method, \ |
Simon Glass | d1cf373 | 2016-09-24 18:19:58 -0600 | [diff] [blame] | 667 | } |
Simon Glass | 4fc1f25 | 2016-11-30 15:30:50 -0700 | [diff] [blame] | 668 | #else |
| 669 | #define SPL_LOAD_IMAGE_METHOD(_name, _priority, _boot_device, _method) \ |
Simon Glass | ec1503c | 2019-10-20 21:31:45 -0600 | [diff] [blame] | 670 | SPL_LOAD_IMAGE(_boot_device ## _priority ## _method) = { \ |
Simon Glass | 4fc1f25 | 2016-11-30 15:30:50 -0700 | [diff] [blame] | 671 | .boot_device = _boot_device, \ |
| 672 | .load_image = _method, \ |
| 673 | } |
| 674 | #endif |
Simon Glass | d1cf373 | 2016-09-24 18:19:58 -0600 | [diff] [blame] | 675 | |
Dan Murphy | b7b5b0c | 2014-01-16 11:23:29 -0600 | [diff] [blame] | 676 | /* SPL FAT image functions */ |
Simon Glass | 3eb382a | 2016-09-24 18:20:15 -0600 | [diff] [blame] | 677 | int spl_load_image_fat(struct spl_image_info *spl_image, |
Pali Rohár | dda8f88 | 2022-01-14 14:31:38 +0100 | [diff] [blame] | 678 | struct spl_boot_device *bootdev, |
Simon Glass | 3eb382a | 2016-09-24 18:20:15 -0600 | [diff] [blame] | 679 | struct blk_desc *block_dev, int partition, |
Simon Glass | e339475 | 2016-02-29 15:25:34 -0700 | [diff] [blame] | 680 | const char *filename); |
Simon Glass | 3eb382a | 2016-09-24 18:20:15 -0600 | [diff] [blame] | 681 | int spl_load_image_fat_os(struct spl_image_info *spl_image, |
Pali Rohár | dda8f88 | 2022-01-14 14:31:38 +0100 | [diff] [blame] | 682 | struct spl_boot_device *bootdev, |
Simon Glass | 3eb382a | 2016-09-24 18:20:15 -0600 | [diff] [blame] | 683 | struct blk_desc *block_dev, int partition); |
Dan Murphy | b7b5b0c | 2014-01-16 11:23:29 -0600 | [diff] [blame] | 684 | |
Jeroen Hofstee | 454c071 | 2014-10-08 22:58:07 +0200 | [diff] [blame] | 685 | void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image); |
| 686 | |
Guillaume GARDET | 1eb410c | 2014-10-15 17:53:12 +0200 | [diff] [blame] | 687 | /* SPL EXT image functions */ |
Simon Glass | 0649e91 | 2016-09-24 18:20:14 -0600 | [diff] [blame] | 688 | int spl_load_image_ext(struct spl_image_info *spl_image, |
Pali Rohár | dda8f88 | 2022-01-14 14:31:38 +0100 | [diff] [blame] | 689 | struct spl_boot_device *bootdev, |
Simon Glass | 0649e91 | 2016-09-24 18:20:14 -0600 | [diff] [blame] | 690 | struct blk_desc *block_dev, int partition, |
Simon Glass | e339475 | 2016-02-29 15:25:34 -0700 | [diff] [blame] | 691 | const char *filename); |
Simon Glass | 0649e91 | 2016-09-24 18:20:14 -0600 | [diff] [blame] | 692 | int spl_load_image_ext_os(struct spl_image_info *spl_image, |
Pali Rohár | dda8f88 | 2022-01-14 14:31:38 +0100 | [diff] [blame] | 693 | struct spl_boot_device *bootdev, |
Simon Glass | 0649e91 | 2016-09-24 18:20:14 -0600 | [diff] [blame] | 694 | struct blk_desc *block_dev, int partition); |
Mayuresh Chitale | 5d96a91 | 2023-06-03 19:32:54 +0530 | [diff] [blame] | 695 | int spl_blk_load_image(struct spl_image_info *spl_image, |
| 696 | struct spl_boot_device *bootdev, |
| 697 | enum uclass_id uclass_id, int devnum, int partnum); |
Guillaume GARDET | 1eb410c | 2014-10-15 17:53:12 +0200 | [diff] [blame] | 698 | |
Simon Glass | fa2a4db | 2015-06-23 15:39:10 -0600 | [diff] [blame] | 699 | /** |
Eddie Cai | 3225899 | 2017-03-15 08:43:28 -0600 | [diff] [blame] | 700 | * spl_early_init() - Set up device tree and driver model in SPL if enabled |
Simon Glass | fa2a4db | 2015-06-23 15:39:10 -0600 | [diff] [blame] | 701 | * |
| 702 | * Call this function in board_init_f() if you want to use device tree and |
Eddie Cai | 3225899 | 2017-03-15 08:43:28 -0600 | [diff] [blame] | 703 | * driver model early, before board_init_r() is called. |
| 704 | * |
| 705 | * If this is not called, then driver model will be inactive in SPL's |
| 706 | * board_init_f(), and no device tree will be available. |
| 707 | */ |
| 708 | int spl_early_init(void); |
| 709 | |
| 710 | /** |
| 711 | * spl_init() - Set up device tree and driver model in SPL if enabled |
| 712 | * |
| 713 | * You can optionally call spl_early_init(), then optionally call spl_init(). |
| 714 | * This function will be called from board_init_r() if not called earlier. |
| 715 | * |
| 716 | * Both spl_early_init() and spl_init() perform a similar function except that |
| 717 | * the latter will not set up the malloc() area if |
| 718 | * CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN is enabled, since it is assumed to |
| 719 | * already be done by a calll to spl_relocate_stack_gd() before board_init_r() |
| 720 | * is reached. |
| 721 | * |
| 722 | * This function will be called from board_init_r() if not called earlier. |
Simon Glass | fa2a4db | 2015-06-23 15:39:10 -0600 | [diff] [blame] | 723 | * |
| 724 | * If this is not called, then driver model will be inactive in SPL's |
| 725 | * board_init_f(), and no device tree will be available. |
| 726 | */ |
| 727 | int spl_init(void); |
| 728 | |
Simon Glass | e49743f | 2023-09-26 08:14:20 -0600 | [diff] [blame] | 729 | /* |
| 730 | * spl_board_init() - Do board-specific init in SPL |
| 731 | * |
| 732 | * If xPL_BOARD_INIT is enabled, this is called from board_init_r() before |
| 733 | * jumping to the next phase. |
| 734 | */ |
Tom Rini | 28591df | 2012-08-13 12:03:19 -0700 | [diff] [blame] | 735 | void spl_board_init(void); |
Simon Glass | a77e1b8 | 2015-05-13 07:02:24 -0600 | [diff] [blame] | 736 | |
| 737 | /** |
| 738 | * spl_was_boot_source() - check if U-Boot booted from SPL |
| 739 | * |
| 740 | * This will normally be true, but if U-Boot jumps to second U-Boot, it will |
| 741 | * be false. This should be implemented by board-specific code. |
| 742 | * |
Heinrich Schuchardt | 47b4c02 | 2022-01-19 18:05:50 +0100 | [diff] [blame] | 743 | * Return: true if U-Boot booted from SPL, else false |
Simon Glass | a77e1b8 | 2015-05-13 07:02:24 -0600 | [diff] [blame] | 744 | */ |
| 745 | bool spl_was_boot_source(void); |
| 746 | |
B, Ravi | d207b7e | 2016-07-28 17:39:16 +0530 | [diff] [blame] | 747 | /** |
| 748 | * spl_dfu_cmd- run dfu command with chosen mmc device interface |
| 749 | * @param usb_index - usb controller number |
| 750 | * @param mmc_dev - mmc device nubmer |
| 751 | * |
Heinrich Schuchardt | 47b4c02 | 2022-01-19 18:05:50 +0100 | [diff] [blame] | 752 | * Return: 0 on success, otherwise error code |
B, Ravi | d207b7e | 2016-07-28 17:39:16 +0530 | [diff] [blame] | 753 | */ |
| 754 | int spl_dfu_cmd(int usbctrl, char *dfu_alt_info, char *interface, char *devstr); |
Simon Glass | 8dd1c9e | 2016-09-24 18:19:51 -0600 | [diff] [blame] | 755 | |
Marek Vasut | 8d5c4c3 | 2016-12-01 02:06:35 +0100 | [diff] [blame] | 756 | int spl_mmc_load_image(struct spl_image_info *spl_image, |
| 757 | struct spl_boot_device *bootdev); |
| 758 | |
Philipp Tomsich | f13e9e0 | 2017-09-13 21:29:31 +0200 | [diff] [blame] | 759 | /** |
Andreas Dannenberg | 8d9f7f1 | 2019-06-04 17:55:46 -0500 | [diff] [blame] | 760 | * spl_mmc_load() - Load an image file from MMC/SD media |
| 761 | * |
| 762 | * @param spl_image Image data filled in by loading process |
| 763 | * @param bootdev Describes which device to load from |
| 764 | * @param filename Name of file to load (in FS mode) |
| 765 | * @param raw_part Partition to load from (in RAW mode) |
| 766 | * @param raw_sect Sector to load from (in RAW mode) |
| 767 | * |
Heinrich Schuchardt | 47b4c02 | 2022-01-19 18:05:50 +0100 | [diff] [blame] | 768 | * Return: 0 on success, otherwise error code |
Andreas Dannenberg | 8d9f7f1 | 2019-06-04 17:55:46 -0500 | [diff] [blame] | 769 | */ |
| 770 | int spl_mmc_load(struct spl_image_info *spl_image, |
| 771 | struct spl_boot_device *bootdev, |
| 772 | const char *filename, |
| 773 | int raw_part, |
| 774 | unsigned long raw_sect); |
| 775 | |
Faiz Abbas | 05e3a15 | 2020-08-03 11:35:04 +0530 | [diff] [blame] | 776 | /** |
| 777 | * spl_usb_load() - Load an image file from USB mass storage |
| 778 | * |
| 779 | * @param spl_image Image data filled in by loading process |
| 780 | * @param bootdev Describes which device to load from |
| 781 | * @param raw_part Fat partition to load from |
| 782 | * @param filename Name of file to load |
| 783 | * |
Heinrich Schuchardt | 47b4c02 | 2022-01-19 18:05:50 +0100 | [diff] [blame] | 784 | * Return: 0 on success, otherwise error code |
Faiz Abbas | 05e3a15 | 2020-08-03 11:35:04 +0530 | [diff] [blame] | 785 | */ |
| 786 | int spl_usb_load(struct spl_image_info *spl_image, |
| 787 | struct spl_boot_device *bootdev, |
| 788 | int partition, const char *filename); |
| 789 | |
Andreas Dannenberg | 5889208 | 2019-08-15 15:55:27 -0500 | [diff] [blame] | 790 | int spl_ymodem_load_image(struct spl_image_info *spl_image, |
| 791 | struct spl_boot_device *bootdev); |
| 792 | |
Andreas Dannenberg | 8d9f7f1 | 2019-06-04 17:55:46 -0500 | [diff] [blame] | 793 | /** |
Philipp Tomsich | f13e9e0 | 2017-09-13 21:29:31 +0200 | [diff] [blame] | 794 | * spl_invoke_atf - boot using an ARM trusted firmware image |
| 795 | */ |
| 796 | void spl_invoke_atf(struct spl_image_info *spl_image); |
Philipp Tomsich | 83ad702 | 2017-06-22 23:38:36 +0200 | [diff] [blame] | 797 | |
| 798 | /** |
Michael Walle | 2def7d9 | 2020-11-18 17:45:56 +0100 | [diff] [blame] | 799 | * bl2_plat_get_bl31_params() - return params for bl31. |
| 800 | * @bl32_entry: address of BL32 executable (secure) |
| 801 | * @bl33_entry: address of BL33 executable (non secure) |
| 802 | * @fdt_addr: address of Flat Device Tree |
Michal Simek | d1598e2 | 2019-12-19 18:13:31 +0100 | [diff] [blame] | 803 | * |
Michael Walle | 2def7d9 | 2020-11-18 17:45:56 +0100 | [diff] [blame] | 804 | * This is a weak function which might be overridden by the board code. By |
| 805 | * default it will just call bl2_plat_get_bl31_params_default(). |
Michal Simek | d1598e2 | 2019-12-19 18:13:31 +0100 | [diff] [blame] | 806 | * |
Michael Walle | 2def7d9 | 2020-11-18 17:45:56 +0100 | [diff] [blame] | 807 | * If you just want to manipulate or add some parameters, you can override |
| 808 | * this function, call bl2_plat_get_bl31_params_default and operate on the |
| 809 | * returned bl31 params. |
| 810 | * |
| 811 | * Return: bl31 params structure pointer |
Michal Simek | d1598e2 | 2019-12-19 18:13:31 +0100 | [diff] [blame] | 812 | */ |
| 813 | struct bl31_params *bl2_plat_get_bl31_params(uintptr_t bl32_entry, |
| 814 | uintptr_t bl33_entry, |
| 815 | uintptr_t fdt_addr); |
| 816 | |
| 817 | /** |
Michael Walle | 2def7d9 | 2020-11-18 17:45:56 +0100 | [diff] [blame] | 818 | * bl2_plat_get_bl31_params_default() - prepare params for bl31. |
| 819 | * @bl32_entry: address of BL32 executable (secure) |
| 820 | * @bl33_entry: address of BL33 executable (non secure) |
| 821 | * @fdt_addr: address of Flat Device Tree |
| 822 | * |
| 823 | * This is the default implementation of bl2_plat_get_bl31_params(). It assigns |
| 824 | * a pointer to the memory that the platform has kept aside to pass platform |
| 825 | * specific and trusted firmware related information to BL31. This memory is |
| 826 | * allocated by allocating memory to bl2_to_bl31_params_mem structure which is |
| 827 | * a superset of all the structure whose information is passed to BL31 |
| 828 | * |
| 829 | * NOTE: The memory is statically allocated, thus this function should be |
| 830 | * called only once. All subsequent calls will overwrite any changes. |
| 831 | * |
| 832 | * Return: bl31 params structure pointer |
| 833 | */ |
| 834 | struct bl31_params *bl2_plat_get_bl31_params_default(uintptr_t bl32_entry, |
| 835 | uintptr_t bl33_entry, |
| 836 | uintptr_t fdt_addr); |
Michael Walle | afaf6ea | 2020-11-18 17:45:58 +0100 | [diff] [blame] | 837 | |
| 838 | /** |
| 839 | * bl2_plat_get_bl31_params_v2() - return params for bl31 |
| 840 | * @bl32_entry: address of BL32 executable (secure) |
| 841 | * @bl33_entry: address of BL33 executable (non secure) |
| 842 | * @fdt_addr: address of Flat Device Tree |
| 843 | * |
| 844 | * This function does the same as bl2_plat_get_bl31_params() except that is is |
| 845 | * used for the new LOAD_IMAGE_V2 option, which uses a slightly different |
| 846 | * method to pass the parameters. |
| 847 | * |
| 848 | * Return: bl31 params structure pointer |
| 849 | */ |
| 850 | struct bl_params *bl2_plat_get_bl31_params_v2(uintptr_t bl32_entry, |
| 851 | uintptr_t bl33_entry, |
| 852 | uintptr_t fdt_addr); |
| 853 | |
| 854 | /** |
| 855 | * bl2_plat_get_bl31_params_v2_default() - prepare params for bl31. |
| 856 | * @bl32_entry: address of BL32 executable (secure) |
| 857 | * @bl33_entry: address of BL33 executable (non secure) |
| 858 | * @fdt_addr: address of Flat Device Tree |
| 859 | * |
| 860 | * This is the default implementation of bl2_plat_get_bl31_params_v2(). It |
| 861 | * prepares the linked list of the bl31 params, populates the image types and |
| 862 | * set the entry points for bl32 and bl33 (if available). |
| 863 | * |
| 864 | * NOTE: The memory is statically allocated, thus this function should be |
| 865 | * called only once. All subsequent calls will overwrite any changes. |
| 866 | * |
| 867 | * Return: bl31 params structure pointer |
| 868 | */ |
| 869 | struct bl_params *bl2_plat_get_bl31_params_v2_default(uintptr_t bl32_entry, |
| 870 | uintptr_t bl33_entry, |
| 871 | uintptr_t fdt_addr); |
Michael Walle | 2def7d9 | 2020-11-18 17:45:56 +0100 | [diff] [blame] | 872 | /** |
Kever Yang | a28d42c | 2018-08-23 17:17:59 +0800 | [diff] [blame] | 873 | * spl_optee_entry - entry function for optee |
| 874 | * |
| 875 | * args defind in op-tee project |
| 876 | * https://github.com/OP-TEE/optee_os/ |
| 877 | * core/arch/arm/kernel/generic_entry_a32.S |
| 878 | * @arg0: pagestore |
| 879 | * @arg1: (ARMv7 standard bootarg #1) |
| 880 | * @arg2: device tree address, (ARMv7 standard bootarg #2) |
| 881 | * @arg3: non-secure entry address (ARMv7 bootarg #0) |
| 882 | */ |
Ricardo Salveti | ec0352a | 2021-10-20 15:12:06 +0300 | [diff] [blame] | 883 | void __noreturn spl_optee_entry(void *arg0, void *arg1, void *arg2, void *arg3); |
Kever Yang | a28d42c | 2018-08-23 17:17:59 +0800 | [diff] [blame] | 884 | |
| 885 | /** |
Lukas Auer | 515b934 | 2019-08-21 21:14:44 +0200 | [diff] [blame] | 886 | * spl_invoke_opensbi - boot using a RISC-V OpenSBI image |
| 887 | */ |
Chanho Park | 8973e37 | 2023-08-29 10:20:14 +0900 | [diff] [blame] | 888 | void __noreturn spl_invoke_opensbi(struct spl_image_info *spl_image); |
Lukas Auer | 515b934 | 2019-08-21 21:14:44 +0200 | [diff] [blame] | 889 | |
| 890 | /** |
Philipp Tomsich | 83ad702 | 2017-06-22 23:38:36 +0200 | [diff] [blame] | 891 | * board_return_to_bootrom - allow for boards to continue with the boot ROM |
| 892 | * |
| 893 | * If a board (e.g. the Rockchip RK3368 boards) provide some |
| 894 | * supporting functionality for SPL in their boot ROM and the SPL |
| 895 | * stage wants to return to the ROM code to continue booting, boards |
| 896 | * can implement 'board_return_to_bootrom'. |
| 897 | */ |
Peng Fan | aa050c5 | 2019-08-07 06:40:53 +0000 | [diff] [blame] | 898 | int board_return_to_bootrom(struct spl_image_info *spl_image, |
| 899 | struct spl_boot_device *bootdev); |
Philipp Tomsich | 58beb6e | 2018-05-24 17:15:50 +0200 | [diff] [blame] | 900 | |
| 901 | /** |
Peng Fan | c86bacd | 2018-11-17 09:10:31 +0000 | [diff] [blame] | 902 | * board_spl_fit_size_align - specific size align before processing payload |
| 903 | * |
| 904 | */ |
| 905 | ulong board_spl_fit_size_align(ulong size); |
| 906 | |
| 907 | /** |
Philipp Tomsich | 58beb6e | 2018-05-24 17:15:50 +0200 | [diff] [blame] | 908 | * spl_perform_fixups() - arch/board-specific callback before processing |
| 909 | * the boot-payload |
| 910 | */ |
| 911 | void spl_perform_fixups(struct spl_image_info *spl_image); |
Marek Vasut | 1dda46f | 2018-08-14 11:27:02 +0200 | [diff] [blame] | 912 | |
| 913 | /* |
| 914 | * spl_get_load_buffer() - get buffer for loading partial image data |
| 915 | * |
| 916 | * Returns memory area which can be populated by partial image data, |
| 917 | * ie. uImage or fitImage header. |
| 918 | */ |
Simon Glass | bb7d3bb | 2022-09-06 20:26:52 -0600 | [diff] [blame] | 919 | struct legacy_img_hdr *spl_get_load_buffer(ssize_t offset, size_t size); |
Marek Vasut | 1dda46f | 2018-08-14 11:27:02 +0200 | [diff] [blame] | 920 | |
Algapally Santosh Sagar | 4e3bdb5 | 2023-03-01 03:33:34 -0700 | [diff] [blame] | 921 | void board_boot_order(u32 *spl_boot_list); |
Peng Fan | 617fc29 | 2020-05-05 20:28:41 +0800 | [diff] [blame] | 922 | void spl_save_restore_data(void); |
Simon Glass | c0bd55e | 2023-09-26 08:14:34 -0600 | [diff] [blame] | 923 | |
| 924 | /** |
| 925 | * spl_load_fit_image() - Fully parse and a FIT image in SPL |
| 926 | * |
| 927 | * @spl_image: SPL Image data to fill in |
| 928 | * @header: Pointer to FIT image |
| 929 | * Return 0 if OK, -ve on error |
| 930 | */ |
| 931 | int spl_load_fit_image(struct spl_image_info *spl_image, |
| 932 | const struct legacy_img_hdr *header); |
| 933 | |
Tom Rini | 28591df | 2012-08-13 12:03:19 -0700 | [diff] [blame] | 934 | #endif |