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