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 /* 25 * u_boot_first_phase() - check if this is the first U-Boot phase 26 * 27 * U-Boot has up to three phases: TPL, SPL and U-Boot proper. Depending on the 28 * build flags we can determine whether the current build is for the first 29 * phase of U-Boot or not. If there is no SPL, then this is U-Boot proper. If 30 * there is SPL but no TPL, the the first phase is SPL. If there is TPL, then 31 * it is the first phase. 32 * 33 * @returns true if this is the first phase of U-Boot 34 * 35 */ 36 static inline bool u_boot_first_phase(void) 37 { 38 if (IS_ENABLED(CONFIG_TPL)) { 39 if (IS_ENABLED(CONFIG_TPL_BUILD)) 40 return true; 41 } else if (IS_ENABLED(CONFIG_SPL)) { 42 if (IS_ENABLED(CONFIG_SPL_BUILD)) 43 return true; 44 } else { 45 return true; 46 } 47 48 return false; 49 } 50 51 /* A string name for SPL or TPL */ 52 #ifdef CONFIG_SPL_BUILD 53 # ifdef CONFIG_TPL_BUILD 54 # define SPL_TPL_NAME "tpl" 55 # else 56 # define SPL_TPL_NAME "spl" 57 # endif 58 # define SPL_TPL_PROMPT SPL_TPL_NAME ": " 59 #else 60 # define SPL_TPL_NAME "" 61 # define SPL_TPL_PROMPT "" 62 #endif 63 64 struct spl_image_info { 65 const char *name; 66 u8 os; 67 uintptr_t load_addr; 68 uintptr_t entry_point; 69 #if CONFIG_IS_ENABLED(LOAD_FIT) 70 void *fdt_addr; 71 #endif 72 u32 boot_device; 73 u32 size; 74 u32 flags; 75 void *arg; 76 }; 77 78 /* 79 * Information required to load data from a device 80 * 81 * @dev: Pointer to the device, e.g. struct mmc * 82 * @priv: Private data for the device 83 * @bl_len: Block length for reading in bytes 84 * @filename: Name of the fit image file. 85 * @read: Function to call to read from the device 86 */ 87 struct spl_load_info { 88 void *dev; 89 void *priv; 90 int bl_len; 91 const char *filename; 92 ulong (*read)(struct spl_load_info *load, ulong sector, ulong count, 93 void *buf); 94 }; 95 96 /* 97 * We need to know the position of U-Boot in memory so we can jump to it. We 98 * allow any U-Boot binary to be used (u-boot.bin, u-boot-nodtb.bin, 99 * u-boot.img), hence the '_any'. These is no checking here that the correct 100 * image is found. For * example if u-boot.img is used we don't check that 101 * spl_parse_image_header() can parse a valid header. 102 */ 103 binman_sym_extern(ulong, u_boot_any, image_pos); 104 105 /** 106 * spl_load_simple_fit() - Loads a fit image from a device. 107 * @spl_image: Image description to set up 108 * @info: Structure containing the information required to load data. 109 * @sector: Sector number where FIT image is located in the device 110 * @fdt: Pointer to the copied FIT header. 111 * 112 * Reads the FIT image @sector in the device. Loads u-boot image to 113 * specified load address and copies the dtb to end of u-boot image. 114 * Returns 0 on success. 115 */ 116 int spl_load_simple_fit(struct spl_image_info *spl_image, 117 struct spl_load_info *info, ulong sector, void *fdt); 118 119 #define SPL_COPY_PAYLOAD_ONLY 1 120 121 /* SPL common functions */ 122 void preloader_console_init(void); 123 u32 spl_boot_device(void); 124 u32 spl_boot_mode(const u32 boot_device); 125 int spl_boot_partition(const u32 boot_device); 126 void spl_set_bd(void); 127 128 /** 129 * spl_set_header_raw_uboot() - Set up a standard SPL image structure 130 * 131 * This sets up the given spl_image which the standard values obtained from 132 * config options: CONFIG_SYS_MONITOR_LEN, CONFIG_SYS_UBOOT_START, 133 * CONFIG_SYS_TEXT_BASE. 134 * 135 * @spl_image: Image description to set up 136 */ 137 void spl_set_header_raw_uboot(struct spl_image_info *spl_image); 138 139 /** 140 * spl_parse_image_header() - parse the image header and set up info 141 * 142 * This parses the legacy image header information at @header and sets up 143 * @spl_image according to what is found. If no image header is found, then 144 * a raw image or bootz is assumed. If CONFIG_SPL_PANIC_ON_RAW_IMAGE is 145 * enabled, then this causes a panic. If CONFIG_SPL_RAW_IMAGE_SUPPORT is not 146 * enabled then U-Boot gives up. Otherwise U-Boot sets up the image using 147 * spl_set_header_raw_uboot(), or possibly the bootz header. 148 * 149 * @spl_image: Image description to set up 150 * @header image header to parse 151 * @return 0 if a header was correctly parsed, -ve on error 152 */ 153 int spl_parse_image_header(struct spl_image_info *spl_image, 154 const struct image_header *header); 155 156 void spl_board_prepare_for_linux(void); 157 void spl_board_prepare_for_boot(void); 158 int spl_board_ubi_load_image(u32 boot_device); 159 160 /** 161 * jump_to_image_linux() - Jump to a Linux kernel from SPL 162 * 163 * This jumps into a Linux kernel using the information in @spl_image. 164 * 165 * @spl_image: Image description to set up 166 */ 167 void __noreturn jump_to_image_linux(struct spl_image_info *spl_image); 168 169 /** 170 * spl_start_uboot() - Check if SPL should start the kernel or U-Boot 171 * 172 * This is called by the various SPL loaders to determine whether the board 173 * wants to load the kernel or U-Boot. This function should be provided by 174 * the board. 175 * 176 * @return 0 if SPL should start the kernel, 1 if U-Boot must be started 177 */ 178 int spl_start_uboot(void); 179 180 /** 181 * spl_display_print() - Display a board-specific message in SPL 182 * 183 * If CONFIG_SPL_DISPLAY_PRINT is enabled, U-Boot will call this function 184 * immediately after displaying the SPL console banner ("U-Boot SPL ..."). 185 * This function should be provided by the board. 186 */ 187 void spl_display_print(void); 188 189 /** 190 * struct spl_boot_device - Describes a boot device used by SPL 191 * 192 * @boot_device: A number indicating the BOOT_DEVICE type. There are various 193 * BOOT_DEVICE... #defines and enums in U-Boot and they are not consistently 194 * numbered. 195 * @boot_device_name: Named boot device, or NULL if none. 196 * 197 * Note: Additional fields can be added here, bearing in mind that SPL is 198 * size-sensitive and common fields will be present on all boards. This 199 * struct can also be used to return additional information about the load 200 * process if that becomes useful. 201 */ 202 struct spl_boot_device { 203 uint boot_device; 204 const char *boot_device_name; 205 }; 206 207 /** 208 * Holds information about a way of loading an SPL image 209 * 210 * @name: User-friendly name for this method (e.g. "MMC") 211 * @boot_device: Boot device that this loader supports 212 * @load_image: Function to call to load image 213 */ 214 struct spl_image_loader { 215 #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT 216 const char *name; 217 #endif 218 uint boot_device; 219 /** 220 * load_image() - Load an SPL image 221 * 222 * @spl_image: place to put image information 223 * @bootdev: describes the boot device to load from 224 */ 225 int (*load_image)(struct spl_image_info *spl_image, 226 struct spl_boot_device *bootdev); 227 }; 228 229 /* Declare an SPL image loader */ 230 #define SPL_LOAD_IMAGE(__name) \ 231 ll_entry_declare(struct spl_image_loader, __name, spl_image_loader) 232 233 /* 234 * _priority is the priority of this method, 0 meaning it will be the top 235 * choice for this device, 9 meaning it is the bottom choice. 236 * _boot_device is the BOOT_DEVICE_... value 237 * _method is the load_image function to call 238 */ 239 #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT 240 #define SPL_LOAD_IMAGE_METHOD(_name, _priority, _boot_device, _method) \ 241 SPL_LOAD_IMAGE(_method ## _priority ## _boot_device) = { \ 242 .name = _name, \ 243 .boot_device = _boot_device, \ 244 .load_image = _method, \ 245 } 246 #else 247 #define SPL_LOAD_IMAGE_METHOD(_name, _priority, _boot_device, _method) \ 248 SPL_LOAD_IMAGE(_method ## _priority ## _boot_device) = { \ 249 .boot_device = _boot_device, \ 250 .load_image = _method, \ 251 } 252 #endif 253 254 /* SPL FAT image functions */ 255 int spl_load_image_fat(struct spl_image_info *spl_image, 256 struct blk_desc *block_dev, int partition, 257 const char *filename); 258 int spl_load_image_fat_os(struct spl_image_info *spl_image, 259 struct blk_desc *block_dev, int partition); 260 261 void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image); 262 263 /* SPL EXT image functions */ 264 int spl_load_image_ext(struct spl_image_info *spl_image, 265 struct blk_desc *block_dev, int partition, 266 const char *filename); 267 int spl_load_image_ext_os(struct spl_image_info *spl_image, 268 struct blk_desc *block_dev, int partition); 269 270 /** 271 * spl_early_init() - Set up device tree and driver model in SPL if enabled 272 * 273 * Call this function in board_init_f() if you want to use device tree and 274 * driver model early, before board_init_r() is called. 275 * 276 * If this is not called, then driver model will be inactive in SPL's 277 * board_init_f(), and no device tree will be available. 278 */ 279 int spl_early_init(void); 280 281 /** 282 * spl_init() - Set up device tree and driver model in SPL if enabled 283 * 284 * You can optionally call spl_early_init(), then optionally call spl_init(). 285 * This function will be called from board_init_r() if not called earlier. 286 * 287 * Both spl_early_init() and spl_init() perform a similar function except that 288 * the latter will not set up the malloc() area if 289 * CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN is enabled, since it is assumed to 290 * already be done by a calll to spl_relocate_stack_gd() before board_init_r() 291 * is reached. 292 * 293 * This function will be called from board_init_r() if not called earlier. 294 * 295 * If this is not called, then driver model will be inactive in SPL's 296 * board_init_f(), and no device tree will be available. 297 */ 298 int spl_init(void); 299 300 #ifdef CONFIG_SPL_BOARD_INIT 301 void spl_board_init(void); 302 #endif 303 304 /** 305 * spl_was_boot_source() - check if U-Boot booted from SPL 306 * 307 * This will normally be true, but if U-Boot jumps to second U-Boot, it will 308 * be false. This should be implemented by board-specific code. 309 * 310 * @return true if U-Boot booted from SPL, else false 311 */ 312 bool spl_was_boot_source(void); 313 314 /** 315 * spl_dfu_cmd- run dfu command with chosen mmc device interface 316 * @param usb_index - usb controller number 317 * @param mmc_dev - mmc device nubmer 318 * 319 * @return 0 on success, otherwise error code 320 */ 321 int spl_dfu_cmd(int usbctrl, char *dfu_alt_info, char *interface, char *devstr); 322 323 int spl_mmc_load_image(struct spl_image_info *spl_image, 324 struct spl_boot_device *bootdev); 325 326 /** 327 * spl_invoke_atf - boot using an ARM trusted firmware image 328 */ 329 void spl_invoke_atf(struct spl_image_info *spl_image); 330 331 /** 332 * spl_optee_entry - entry function for optee 333 * 334 * args defind in op-tee project 335 * https://github.com/OP-TEE/optee_os/ 336 * core/arch/arm/kernel/generic_entry_a32.S 337 * @arg0: pagestore 338 * @arg1: (ARMv7 standard bootarg #1) 339 * @arg2: device tree address, (ARMv7 standard bootarg #2) 340 * @arg3: non-secure entry address (ARMv7 bootarg #0) 341 */ 342 void spl_optee_entry(void *arg0, void *arg1, void *arg2, void *arg3); 343 344 /** 345 * board_return_to_bootrom - allow for boards to continue with the boot ROM 346 * 347 * If a board (e.g. the Rockchip RK3368 boards) provide some 348 * supporting functionality for SPL in their boot ROM and the SPL 349 * stage wants to return to the ROM code to continue booting, boards 350 * can implement 'board_return_to_bootrom'. 351 */ 352 void board_return_to_bootrom(void); 353 354 /** 355 * spl_perform_fixups() - arch/board-specific callback before processing 356 * the boot-payload 357 */ 358 void spl_perform_fixups(struct spl_image_info *spl_image); 359 360 /* 361 * spl_get_load_buffer() - get buffer for loading partial image data 362 * 363 * Returns memory area which can be populated by partial image data, 364 * ie. uImage or fitImage header. 365 */ 366 struct image_header *spl_get_load_buffer(ssize_t offset, size_t size); 367 368 #endif 369