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