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(void); 70 void spl_set_header_raw_uboot(void); 71 int spl_parse_image_header(const struct image_header *header); 72 void spl_board_prepare_for_linux(void); 73 void spl_board_prepare_for_boot(void); 74 void __noreturn jump_to_image_linux(void *arg); 75 int spl_start_uboot(void); 76 void spl_display_print(void); 77 78 /* NAND SPL functions */ 79 int spl_nand_load_image(void); 80 81 /* OneNAND SPL functions */ 82 int spl_onenand_load_image(void); 83 84 /* NOR SPL functions */ 85 int spl_nor_load_image(void); 86 87 /* MMC SPL functions */ 88 int spl_mmc_load_image(u32 boot_device); 89 90 /* YMODEM SPL functions */ 91 int spl_ymodem_load_image(void); 92 93 /* SPI SPL functions */ 94 int spl_spi_load_image(void); 95 96 /* Ethernet SPL functions */ 97 int spl_net_load_image(const char *device); 98 99 /* USB SPL functions */ 100 int spl_usb_load_image(void); 101 102 /* SATA SPL functions */ 103 int spl_sata_load_image(void); 104 105 /* SPL FAT image functions */ 106 int spl_load_image_fat(struct blk_desc *block_dev, int partition, 107 const char *filename); 108 int spl_load_image_fat_os(struct blk_desc *block_dev, int partition); 109 110 void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image); 111 112 /* SPL EXT image functions */ 113 int spl_load_image_ext(struct blk_desc *block_dev, int partition, 114 const char *filename); 115 int spl_load_image_ext_os(struct blk_desc *block_dev, int partition); 116 117 /** 118 * spl_init() - Set up device tree and driver model in SPL if enabled 119 * 120 * Call this function in board_init_f() if you want to use device tree and 121 * driver model early, before board_init_r() is called. This function will 122 * be called from board_init_r() if not called earlier. 123 * 124 * If this is not called, then driver model will be inactive in SPL's 125 * board_init_f(), and no device tree will be available. 126 */ 127 int spl_init(void); 128 129 #ifdef CONFIG_SPL_BOARD_INIT 130 void spl_board_init(void); 131 #endif 132 133 /** 134 * spl_was_boot_source() - check if U-Boot booted from SPL 135 * 136 * This will normally be true, but if U-Boot jumps to second U-Boot, it will 137 * be false. This should be implemented by board-specific code. 138 * 139 * @return true if U-Boot booted from SPL, else false 140 */ 141 bool spl_was_boot_source(void); 142 143 #endif 144