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 struct spl_image_info { 24 const char *name; 25 u8 os; 26 uintptr_t load_addr; 27 uintptr_t entry_point; 28 #if CONFIG_IS_ENABLED(LOAD_FIT) 29 void *fdt_addr; 30 #endif 31 u32 size; 32 u32 flags; 33 void *arg; 34 }; 35 36 /* 37 * Information required to load data from a device 38 * 39 * @dev: Pointer to the device, e.g. struct mmc * 40 * @priv: Private data for the device 41 * @bl_len: Block length for reading in bytes 42 * @filename: Name of the fit image file. 43 * @read: Function to call to read from the device 44 */ 45 struct spl_load_info { 46 void *dev; 47 void *priv; 48 int bl_len; 49 const char *filename; 50 ulong (*read)(struct spl_load_info *load, ulong sector, ulong count, 51 void *buf); 52 }; 53 54 /** 55 * spl_load_simple_fit() - Loads a fit image from a device. 56 * @spl_image: Image description to set up 57 * @info: Structure containing the information required to load data. 58 * @sector: Sector number where FIT image is located in the device 59 * @fdt: Pointer to the copied FIT header. 60 * 61 * Reads the FIT image @sector in the device. Loads u-boot image to 62 * specified load address and copies the dtb to end of u-boot image. 63 * Returns 0 on success. 64 */ 65 int spl_load_simple_fit(struct spl_image_info *spl_image, 66 struct spl_load_info *info, ulong sector, void *fdt); 67 68 #define SPL_COPY_PAYLOAD_ONLY 1 69 70 /* SPL common functions */ 71 void preloader_console_init(void); 72 u32 spl_boot_device(void); 73 u32 spl_boot_mode(const u32 boot_device); 74 void spl_set_bd(void); 75 76 /** 77 * spl_set_header_raw_uboot() - Set up a standard SPL image structure 78 * 79 * This sets up the given spl_image which the standard values obtained from 80 * config options: CONFIG_SYS_MONITOR_LEN, CONFIG_SYS_UBOOT_START, 81 * CONFIG_SYS_TEXT_BASE. 82 * 83 * @spl_image: Image description to set up 84 */ 85 void spl_set_header_raw_uboot(struct spl_image_info *spl_image); 86 87 /** 88 * spl_parse_image_header() - parse the image header and set up info 89 * 90 * This parses the legacy image header information at @header and sets up 91 * @spl_image according to what is found. If no image header is found, then 92 * a raw image or bootz is assumed. If CONFIG_SPL_PANIC_ON_RAW_IMAGE is 93 * enabled, then this causes a panic. If CONFIG_SPL_RAW_IMAGE_SUPPORT is not 94 * enabled then U-Boot gives up. Otherwise U-Boot sets up the image using 95 * spl_set_header_raw_uboot(), or possibly the bootz header. 96 * 97 * @spl_image: Image description to set up 98 * @header image header to parse 99 * @return 0 if a header was correctly parsed, -ve on error 100 */ 101 int spl_parse_image_header(struct spl_image_info *spl_image, 102 const struct image_header *header); 103 104 void spl_board_prepare_for_linux(void); 105 void spl_board_prepare_for_boot(void); 106 int spl_board_ubi_load_image(u32 boot_device); 107 108 /** 109 * jump_to_image_linux() - Jump to a Linux kernel from SPL 110 * 111 * This jumps into a Linux kernel using the information in @spl_image. 112 * 113 * @spl_image: Image description to set up 114 */ 115 void __noreturn jump_to_image_linux(struct spl_image_info *spl_image); 116 117 /** 118 * spl_start_uboot() - Check if SPL should start the kernel or U-Boot 119 * 120 * This is called by the various SPL loaders to determine whether the board 121 * wants to load the kernel or U-Boot. This function should be provided by 122 * the board. 123 * 124 * @return 0 if SPL should start the kernel, 1 if U-Boot must be started 125 */ 126 int spl_start_uboot(void); 127 128 /** 129 * spl_display_print() - Display a board-specific message in SPL 130 * 131 * If CONFIG_SPL_DISPLAY_PRINT is enabled, U-Boot will call this function 132 * immediately after displaying the SPL console banner ("U-Boot SPL ..."). 133 * This function should be provided by the board. 134 */ 135 void spl_display_print(void); 136 137 /** 138 * struct spl_boot_device - Describes a boot device used by SPL 139 * 140 * @boot_device: A number indicating the BOOT_DEVICE type. There are various 141 * BOOT_DEVICE... #defines and enums in U-Boot and they are not consistently 142 * numbered. 143 * @boot_device_name: Named boot device, or NULL if none. 144 * 145 * Note: Additional fields can be added here, bearing in mind that SPL is 146 * size-sensitive and common fields will be present on all boards. This 147 * struct can also be used to return additional information about the load 148 * process if that becomes useful. 149 */ 150 struct spl_boot_device { 151 uint boot_device; 152 const char *boot_device_name; 153 }; 154 155 /** 156 * Holds information about a way of loading an SPL image 157 * 158 * @name: User-friendly name for this method (e.g. "MMC") 159 * @boot_device: Boot device that this loader supports 160 * @load_image: Function to call to load image 161 */ 162 struct spl_image_loader { 163 #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT 164 const char *name; 165 #endif 166 uint boot_device; 167 /** 168 * load_image() - Load an SPL image 169 * 170 * @spl_image: place to put image information 171 * @bootdev: describes the boot device to load from 172 */ 173 int (*load_image)(struct spl_image_info *spl_image, 174 struct spl_boot_device *bootdev); 175 }; 176 177 /* Declare an SPL image loader */ 178 #define SPL_LOAD_IMAGE(__name) \ 179 ll_entry_declare(struct spl_image_loader, __name, spl_image_loader) 180 181 /* 182 * _priority is the priority of this method, 0 meaning it will be the top 183 * choice for this device, 9 meaning it is the bottom choice. 184 * _boot_device is the BOOT_DEVICE_... value 185 * _method is the load_image function to call 186 */ 187 #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT 188 #define SPL_LOAD_IMAGE_METHOD(_name, _priority, _boot_device, _method) \ 189 SPL_LOAD_IMAGE(_method ## _priority ## _boot_device) = { \ 190 .name = _name, \ 191 .boot_device = _boot_device, \ 192 .load_image = _method, \ 193 } 194 #else 195 #define SPL_LOAD_IMAGE_METHOD(_name, _priority, _boot_device, _method) \ 196 SPL_LOAD_IMAGE(_method ## _priority ## _boot_device) = { \ 197 .boot_device = _boot_device, \ 198 .load_image = _method, \ 199 } 200 #endif 201 202 /* SPL FAT image functions */ 203 int spl_load_image_fat(struct spl_image_info *spl_image, 204 struct blk_desc *block_dev, int partition, 205 const char *filename); 206 int spl_load_image_fat_os(struct spl_image_info *spl_image, 207 struct blk_desc *block_dev, int partition); 208 209 void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image); 210 211 /* SPL EXT image functions */ 212 int spl_load_image_ext(struct spl_image_info *spl_image, 213 struct blk_desc *block_dev, int partition, 214 const char *filename); 215 int spl_load_image_ext_os(struct spl_image_info *spl_image, 216 struct blk_desc *block_dev, int partition); 217 218 /** 219 * spl_early_init() - Set up device tree and driver model in SPL if enabled 220 * 221 * Call this function in board_init_f() if you want to use device tree and 222 * driver model early, before board_init_r() is called. 223 * 224 * If this is not called, then driver model will be inactive in SPL's 225 * board_init_f(), and no device tree will be available. 226 */ 227 int spl_early_init(void); 228 229 /** 230 * spl_init() - Set up device tree and driver model in SPL if enabled 231 * 232 * You can optionally call spl_early_init(), then optionally call spl_init(). 233 * This function will be called from board_init_r() if not called earlier. 234 * 235 * Both spl_early_init() and spl_init() perform a similar function except that 236 * the latter will not set up the malloc() area if 237 * CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN is enabled, since it is assumed to 238 * already be done by a calll to spl_relocate_stack_gd() before board_init_r() 239 * is reached. 240 * 241 * This function will be called from board_init_r() if not called earlier. 242 * 243 * If this is not called, then driver model will be inactive in SPL's 244 * board_init_f(), and no device tree will be available. 245 */ 246 int spl_init(void); 247 248 #ifdef CONFIG_SPL_BOARD_INIT 249 void spl_board_init(void); 250 #endif 251 252 /** 253 * spl_was_boot_source() - check if U-Boot booted from SPL 254 * 255 * This will normally be true, but if U-Boot jumps to second U-Boot, it will 256 * be false. This should be implemented by board-specific code. 257 * 258 * @return true if U-Boot booted from SPL, else false 259 */ 260 bool spl_was_boot_source(void); 261 262 /** 263 * spl_dfu_cmd- run dfu command with chosen mmc device interface 264 * @param usb_index - usb controller number 265 * @param mmc_dev - mmc device nubmer 266 * 267 * @return 0 on success, otherwise error code 268 */ 269 int spl_dfu_cmd(int usbctrl, char *dfu_alt_info, char *interface, char *devstr); 270 271 int spl_mmc_load_image(struct spl_image_info *spl_image, 272 struct spl_boot_device *bootdev); 273 274 /** 275 * spl_invoke_atf - boot using an ARM trusted firmware image 276 */ 277 void spl_invoke_atf(struct spl_image_info *spl_image); 278 279 /** 280 * board_return_to_bootrom - allow for boards to continue with the boot ROM 281 * 282 * If a board (e.g. the Rockchip RK3368 boards) provide some 283 * supporting functionality for SPL in their boot ROM and the SPL 284 * stage wants to return to the ROM code to continue booting, boards 285 * can implement 'board_return_to_bootrom'. 286 */ 287 void board_return_to_bootrom(void); 288 #endif 289