include/spl.h

   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 description to set up
  79  */
  80 void spl_set_header_raw_uboot(struct spl_image_info *spl_image);
  81
  82 /**
  83  * spl_parse_image_header() - parse the image header and set up info
  84  *
  85  * This parses the legacy image header information at @header and sets up
  86  * @spl_image according to what is found. If no image header is found, then
  87  * a raw image or bootz is assumed. If CONFIG_SPL_PANIC_ON_RAW_IMAGE is
  88  * enabled, then this causes a panic. If CONFIG_SPL_ABORT_ON_RAW_IMAGE is
  89  * enabled then U-Boot gives up. Otherwise U-Boot sets up the image using
  90  * spl_set_header_raw_uboot(), or possibly the bootz header.
  91  *
  92  * @spl_image: Image description to set up
  93  * @header image header to parse
  94  * @return 0 if a header was correctly parsed, -ve on error
  95  */
  96 int spl_parse_image_header(struct spl_image_info *spl_image,
  97                            const struct image_header *header);
  98
  99 void spl_board_prepare_for_linux(void);
 100 void spl_board_prepare_for_boot(void);
 101 int spl_board_ubi_load_image(u32 boot_device);
 102
 103 /**
 104  * jump_to_image_linux() - Jump to a Linux kernel from SPL
 105  *
 106  * This jumps into a Linux kernel using the information in @spl_image.
 107  *
 108  * @spl_image: Image description to set up
 109  * @arg: Argument to pass to Linux (typically a device tree pointer)
 110  */
 111 void __noreturn jump_to_image_linux(struct spl_image_info *spl_image,
 112                                     void *arg);
 113
 114 /**
 115  * spl_start_uboot() - Check if SPL should start the kernel or U-Boot
 116  *
 117  * This is called by the various SPL loaders to determine whether the board
 118  * wants to load the kernel or U-Boot. This function should be provided by
 119  * the board.
 120  *
 121  * @return 0 if SPL should start the kernel, 1 if U-Boot must be started
 122  */
 123 int spl_start_uboot(void);
 124
 125 void spl_display_print(void);
 126
 127 /* NAND SPL functions */
 128 int spl_nand_load_image(void);
 129
 130 /* OneNAND SPL functions */
 131 int spl_onenand_load_image(void);
 132
 133 /* NOR SPL functions */
 134 int spl_nor_load_image(void);
 135
 136 /* UBI SPL functions */
 137 int spl_ubi_load_image(u32 boot_device);
 138
 139 /* MMC SPL functions */
 140 int spl_mmc_load_image(u32 boot_device);
 141
 142 /* YMODEM SPL functions */
 143 int spl_ymodem_load_image(void);
 144
 145 /* SPI SPL functions */
 146 int spl_spi_load_image(void);
 147
 148 /* Ethernet SPL functions */
 149 int spl_net_load_image(const char *device);
 150
 151 /* USB SPL functions */
 152 int spl_usb_load_image(void);
 153
 154 /* SATA SPL functions */
 155 int spl_sata_load_image(void);
 156
 157 /* SPL FAT image functions */
 158 int spl_load_image_fat(struct blk_desc *block_dev, int partition,
 159                        const char *filename);
 160 int spl_load_image_fat_os(struct blk_desc *block_dev, int partition);
 161
 162 void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image);
 163
 164 /* SPL EXT image functions */
 165 int spl_load_image_ext(struct blk_desc *block_dev, int partition,
 166                        const char *filename);
 167 int spl_load_image_ext_os(struct blk_desc *block_dev, int partition);
 168
 169 /**
 170  * spl_init() - Set up device tree and driver model in SPL if enabled
 171  *
 172  * Call this function in board_init_f() if you want to use device tree and
 173  * driver model early, before board_init_r() is called. This function will
 174  * be called from board_init_r() if not called earlier.
 175  *
 176  * If this is not called, then driver model will be inactive in SPL's
 177  * board_init_f(), and no device tree will be available.
 178  */
 179 int spl_init(void);
 180
 181 #ifdef CONFIG_SPL_BOARD_INIT
 182 void spl_board_init(void);
 183 #endif
 184
 185 /**
 186  * spl_was_boot_source() - check if U-Boot booted from SPL
 187  *
 188  * This will normally be true, but if U-Boot jumps to second U-Boot, it will
 189  * be false. This should be implemented by board-specific code.
 190  *
 191  * @return true if U-Boot booted from SPL, else false
 192  */
 193 bool spl_was_boot_source(void);
 194
 195 /**
 196  * spl_dfu_cmd- run dfu command with chosen mmc device interface
 197  * @param usb_index - usb controller number
 198  * @param mmc_dev -  mmc device nubmer
 199  *
 200  * @return 0 on success, otherwise error code
 201  */
 202 int spl_dfu_cmd(int usbctrl, char *dfu_alt_info, char *interface, char *devstr);
 203
 204 /**
 205  * Board-specific load method for boards that have a special way of loading
 206  * U-Boot, which does not fit with the existing SPL code.
 207  *
 208  * @return 0 on success, negative errno value on failure.
 209  */
 210 int spl_board_load_image(void);
 211
 212 #endif