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 * @info: Structure containing the information required to load data. 53 * @sector: Sector number where FIT image is located in the device 54 * @fdt: Pointer to the copied FIT header. 55 * 56 * Reads the FIT image @sector in the device. Loads u-boot image to 57 * specified load address and copies the dtb to end of u-boot image. 58 * Returns 0 on success. 59 */ 60 int spl_load_simple_fit(struct spl_load_info *info, ulong sector, void *fdt); 61 62 #define SPL_COPY_PAYLOAD_ONLY 1 63 64 extern struct spl_image_info spl_image; 65 66 /* SPL common functions */ 67 void preloader_console_init(void); 68 u32 spl_boot_device(void); 69 u32 spl_boot_mode(const u32 boot_device); 70 71 /** 72 * spl_set_header_raw_uboot() - Set up a standard SPL image structure 73 * 74 * This sets up the given spl_image which the standard values obtained from 75 * config options: CONFIG_SYS_MONITOR_LEN, CONFIG_SYS_UBOOT_START, 76 * CONFIG_SYS_TEXT_BASE. 77 * 78 * @spl_image: Image to set up 79 */ 80 void spl_set_header_raw_uboot(struct spl_image_info *spl_image); 81 82 int spl_parse_image_header(const struct image_header *header); 83 void spl_board_prepare_for_linux(void); 84 void spl_board_prepare_for_boot(void); 85 int spl_board_ubi_load_image(u32 boot_device); 86 void __noreturn jump_to_image_linux(void *arg); 87 int spl_start_uboot(void); 88 void spl_display_print(void); 89 90 /* NAND SPL functions */ 91 int spl_nand_load_image(void); 92 93 /* OneNAND SPL functions */ 94 int spl_onenand_load_image(void); 95 96 /* NOR SPL functions */ 97 int spl_nor_load_image(void); 98 99 /* UBI SPL functions */ 100 int spl_ubi_load_image(u32 boot_device); 101 102 /* MMC SPL functions */ 103 int spl_mmc_load_image(u32 boot_device); 104 105 /* YMODEM SPL functions */ 106 int spl_ymodem_load_image(void); 107 108 /* SPI SPL functions */ 109 int spl_spi_load_image(void); 110 111 /* Ethernet SPL functions */ 112 int spl_net_load_image(const char *device); 113 114 /* USB SPL functions */ 115 int spl_usb_load_image(void); 116 117 /* SATA SPL functions */ 118 int spl_sata_load_image(void); 119 120 /* SPL FAT image functions */ 121 int spl_load_image_fat(struct blk_desc *block_dev, int partition, 122 const char *filename); 123 int spl_load_image_fat_os(struct blk_desc *block_dev, int partition); 124 125 void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image); 126 127 /* SPL EXT image functions */ 128 int spl_load_image_ext(struct blk_desc *block_dev, int partition, 129 const char *filename); 130 int spl_load_image_ext_os(struct blk_desc *block_dev, int partition); 131 132 /** 133 * spl_init() - Set up device tree and driver model in SPL if enabled 134 * 135 * Call this function in board_init_f() if you want to use device tree and 136 * driver model early, before board_init_r() is called. This function will 137 * be called from board_init_r() if not called earlier. 138 * 139 * If this is not called, then driver model will be inactive in SPL's 140 * board_init_f(), and no device tree will be available. 141 */ 142 int spl_init(void); 143 144 #ifdef CONFIG_SPL_BOARD_INIT 145 void spl_board_init(void); 146 #endif 147 148 /** 149 * spl_was_boot_source() - check if U-Boot booted from SPL 150 * 151 * This will normally be true, but if U-Boot jumps to second U-Boot, it will 152 * be false. This should be implemented by board-specific code. 153 * 154 * @return true if U-Boot booted from SPL, else false 155 */ 156 bool spl_was_boot_source(void); 157 158 /** 159 * spl_dfu_cmd- run dfu command with chosen mmc device interface 160 * @param usb_index - usb controller number 161 * @param mmc_dev - mmc device nubmer 162 * 163 * @return 0 on success, otherwise error code 164 */ 165 int spl_dfu_cmd(int usbctrl, char *dfu_alt_info, char *interface, char *devstr); 166 167 /** 168 * Board-specific load method for boards that have a special way of loading 169 * U-Boot, which does not fit with the existing SPL code. 170 * 171 * @return 0 on success, negative errno value on failure. 172 */ 173 int spl_board_load_image(void); 174 175 #endif 176