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