include/spl.h

   1 /* SPDX-License-Identifier: GPL-2.0+ */
   2 /*
   3  * (C) Copyright 2012
   4  * Texas Instruments, <www.ti.com>
   5  */
   6 #ifndef _SPL_H_
   7 #define _SPL_H_
   8
   9 #include <binman_sym.h>
  10
  11 /* Platform-specific defines */
  12 #include <linux/compiler.h>
  13 #include <asm/spl.h>
  14
  15 /* Value in r0 indicates we booted from U-Boot */
  16 #define UBOOT_NOT_LOADED_FROM_SPL       0x13578642
  17
  18 /* Boot type */
  19 #define MMCSD_MODE_UNDEFINED    0
  20 #define MMCSD_MODE_RAW          1
  21 #define MMCSD_MODE_FS           2
  22 #define MMCSD_MODE_EMMCBOOT     3
  23
  24 /*
  25  * u_boot_first_phase() - check if this is the first U-Boot phase
  26  *
  27  * U-Boot has up to three phases: TPL, SPL and U-Boot proper. Depending on the
  28  * build flags we can determine whether the current build is for the first
  29  * phase of U-Boot or not. If there is no SPL, then this is U-Boot proper. If
  30  * there is SPL but no TPL, the the first phase is SPL. If there is TPL, then
  31  * it is the first phase.
  32  *
  33  * @returns true if this is the first phase of U-Boot
  34  *
  35  */
  36 static inline bool u_boot_first_phase(void)
  37 {
  38         if (IS_ENABLED(CONFIG_TPL)) {
  39                 if (IS_ENABLED(CONFIG_TPL_BUILD))
  40                         return true;
  41         } else if (IS_ENABLED(CONFIG_SPL)) {
  42                 if (IS_ENABLED(CONFIG_SPL_BUILD))
  43                         return true;
  44         } else {
  45                 return true;
  46         }
  47
  48         return false;
  49 }
  50
  51 struct spl_image_info {
  52         const char *name;
  53         u8 os;
  54         uintptr_t load_addr;
  55         uintptr_t entry_point;
  56 #if CONFIG_IS_ENABLED(LOAD_FIT)
  57         void *fdt_addr;
  58 #endif
  59         u32 boot_device;
  60         u32 size;
  61         u32 flags;
  62         void *arg;
  63 };
  64
  65 /*
  66  * Information required to load data from a device
  67  *
  68  * @dev: Pointer to the device, e.g. struct mmc *
  69  * @priv: Private data for the device
  70  * @bl_len: Block length for reading in bytes
  71  * @filename: Name of the fit image file.
  72  * @read: Function to call to read from the device
  73  */
  74 struct spl_load_info {
  75         void *dev;
  76         void *priv;
  77         int bl_len;
  78         const char *filename;
  79         ulong (*read)(struct spl_load_info *load, ulong sector, ulong count,
  80                       void *buf);
  81 };
  82
  83 /*
  84  * We need to know the position of U-Boot in memory so we can jump to it. We
  85  * allow any U-Boot binary to be used (u-boot.bin, u-boot-nodtb.bin,
  86  * u-boot.img), hence the '_any'. These is no checking here that the correct
  87  * image is found. For * example if u-boot.img is used we don't check that
  88  * spl_parse_image_header() can parse a valid header.
  89  */
  90 binman_sym_extern(ulong, u_boot_any, image_pos);
  91
  92 /**
  93  * spl_load_simple_fit() - Loads a fit image from a device.
  94  * @spl_image:  Image description to set up
  95  * @info:       Structure containing the information required to load data.
  96  * @sector:     Sector number where FIT image is located in the device
  97  * @fdt:        Pointer to the copied FIT header.
  98  *
  99  * Reads the FIT image @sector in the device. Loads u-boot image to
 100  * specified load address and copies the dtb to end of u-boot image.
 101  * Returns 0 on success.
 102  */
 103 int spl_load_simple_fit(struct spl_image_info *spl_image,
 104                         struct spl_load_info *info, ulong sector, void *fdt);
 105
 106 #define SPL_COPY_PAYLOAD_ONLY   1
 107
 108 /* SPL common functions */
 109 void preloader_console_init(void);
 110 u32 spl_boot_device(void);
 111 u32 spl_boot_mode(const u32 boot_device);
 112 int spl_boot_partition(const u32 boot_device);
 113 void spl_set_bd(void);
 114
 115 /**
 116  * spl_set_header_raw_uboot() - Set up a standard SPL image structure
 117  *
 118  * This sets up the given spl_image which the standard values obtained from
 119  * config options: CONFIG_SYS_MONITOR_LEN, CONFIG_SYS_UBOOT_START,
 120  * CONFIG_SYS_TEXT_BASE.
 121  *
 122  * @spl_image: Image description to set up
 123  */
 124 void spl_set_header_raw_uboot(struct spl_image_info *spl_image);
 125
 126 /**
 127  * spl_parse_image_header() - parse the image header and set up info
 128  *
 129  * This parses the legacy image header information at @header and sets up
 130  * @spl_image according to what is found. If no image header is found, then
 131  * a raw image or bootz is assumed. If CONFIG_SPL_PANIC_ON_RAW_IMAGE is
 132  * enabled, then this causes a panic. If CONFIG_SPL_RAW_IMAGE_SUPPORT is not
 133  * enabled then U-Boot gives up. Otherwise U-Boot sets up the image using
 134  * spl_set_header_raw_uboot(), or possibly the bootz header.
 135  *
 136  * @spl_image: Image description to set up
 137  * @header image header to parse
 138  * @return 0 if a header was correctly parsed, -ve on error
 139  */
 140 int spl_parse_image_header(struct spl_image_info *spl_image,
 141                            const struct image_header *header);
 142
 143 void spl_board_prepare_for_linux(void);
 144 void spl_board_prepare_for_boot(void);
 145 int spl_board_ubi_load_image(u32 boot_device);
 146
 147 /**
 148  * jump_to_image_linux() - Jump to a Linux kernel from SPL
 149  *
 150  * This jumps into a Linux kernel using the information in @spl_image.
 151  *
 152  * @spl_image: Image description to set up
 153  */
 154 void __noreturn jump_to_image_linux(struct spl_image_info *spl_image);
 155
 156 /**
 157  * spl_start_uboot() - Check if SPL should start the kernel or U-Boot
 158  *
 159  * This is called by the various SPL loaders to determine whether the board
 160  * wants to load the kernel or U-Boot. This function should be provided by
 161  * the board.
 162  *
 163  * @return 0 if SPL should start the kernel, 1 if U-Boot must be started
 164  */
 165 int spl_start_uboot(void);
 166
 167 /**
 168  * spl_display_print() - Display a board-specific message in SPL
 169  *
 170  * If CONFIG_SPL_DISPLAY_PRINT is enabled, U-Boot will call this function
 171  * immediately after displaying the SPL console banner ("U-Boot SPL ...").
 172  * This function should be provided by the board.
 173  */
 174 void spl_display_print(void);
 175
 176 /**
 177  * struct spl_boot_device - Describes a boot device used by SPL
 178  *
 179  * @boot_device: A number indicating the BOOT_DEVICE type. There are various
 180  * BOOT_DEVICE... #defines and enums in U-Boot and they are not consistently
 181  * numbered.
 182  * @boot_device_name: Named boot device, or NULL if none.
 183  *
 184  * Note: Additional fields can be added here, bearing in mind that SPL is
 185  * size-sensitive and common fields will be present on all boards. This
 186  * struct can also be used to return additional information about the load
 187  * process if that becomes useful.
 188  */
 189 struct spl_boot_device {
 190         uint boot_device;
 191         const char *boot_device_name;
 192 };
 193
 194 /**
 195  * Holds information about a way of loading an SPL image
 196  *
 197  * @name: User-friendly name for this method (e.g. "MMC")
 198  * @boot_device: Boot device that this loader supports
 199  * @load_image: Function to call to load image
 200  */
 201 struct spl_image_loader {
 202 #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
 203         const char *name;
 204 #endif
 205         uint boot_device;
 206         /**
 207          * load_image() - Load an SPL image
 208          *
 209          * @spl_image: place to put image information
 210          * @bootdev: describes the boot device to load from
 211          */
 212         int (*load_image)(struct spl_image_info *spl_image,
 213                           struct spl_boot_device *bootdev);
 214 };
 215
 216 /* Declare an SPL image loader */
 217 #define SPL_LOAD_IMAGE(__name)                                  \
 218         ll_entry_declare(struct spl_image_loader, __name, spl_image_loader)
 219
 220 /*
 221  * _priority is the priority of this method, 0 meaning it will be the top
 222  * choice for this device, 9 meaning it is the bottom choice.
 223  * _boot_device is the BOOT_DEVICE_... value
 224  * _method is the load_image function to call
 225  */
 226 #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
 227 #define SPL_LOAD_IMAGE_METHOD(_name, _priority, _boot_device, _method) \
 228         SPL_LOAD_IMAGE(_method ## _priority ## _boot_device) = { \
 229                 .name = _name, \
 230                 .boot_device = _boot_device, \
 231                 .load_image = _method, \
 232         }
 233 #else
 234 #define SPL_LOAD_IMAGE_METHOD(_name, _priority, _boot_device, _method) \
 235         SPL_LOAD_IMAGE(_method ## _priority ## _boot_device) = { \
 236                 .boot_device = _boot_device, \
 237                 .load_image = _method, \
 238         }
 239 #endif
 240
 241 /* SPL FAT image functions */
 242 int spl_load_image_fat(struct spl_image_info *spl_image,
 243                        struct blk_desc *block_dev, int partition,
 244                        const char *filename);
 245 int spl_load_image_fat_os(struct spl_image_info *spl_image,
 246                           struct blk_desc *block_dev, int partition);
 247
 248 void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image);
 249
 250 /* SPL EXT image functions */
 251 int spl_load_image_ext(struct spl_image_info *spl_image,
 252                        struct blk_desc *block_dev, int partition,
 253                        const char *filename);
 254 int spl_load_image_ext_os(struct spl_image_info *spl_image,
 255                           struct blk_desc *block_dev, int partition);
 256
 257 /**
 258  * spl_early_init() - Set up device tree and driver model in SPL if enabled
 259  *
 260  * Call this function in board_init_f() if you want to use device tree and
 261  * driver model early, before board_init_r() is called.
 262  *
 263  * If this is not called, then driver model will be inactive in SPL's
 264  * board_init_f(), and no device tree will be available.
 265  */
 266 int spl_early_init(void);
 267
 268 /**
 269  * spl_init() - Set up device tree and driver model in SPL if enabled
 270  *
 271  * You can optionally call spl_early_init(), then optionally call spl_init().
 272  * This function will be called from board_init_r() if not called earlier.
 273  *
 274  * Both spl_early_init() and spl_init() perform a similar function except that
 275  * the latter will not set up the malloc() area if
 276  * CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN is enabled, since it is assumed to
 277  * already be done by a calll to spl_relocate_stack_gd() before board_init_r()
 278  * is reached.
 279  *
 280  * This function will be called from board_init_r() if not called earlier.
 281  *
 282  * If this is not called, then driver model will be inactive in SPL's
 283  * board_init_f(), and no device tree will be available.
 284  */
 285 int spl_init(void);
 286
 287 #ifdef CONFIG_SPL_BOARD_INIT
 288 void spl_board_init(void);
 289 #endif
 290
 291 /**
 292  * spl_was_boot_source() - check if U-Boot booted from SPL
 293  *
 294  * This will normally be true, but if U-Boot jumps to second U-Boot, it will
 295  * be false. This should be implemented by board-specific code.
 296  *
 297  * @return true if U-Boot booted from SPL, else false
 298  */
 299 bool spl_was_boot_source(void);
 300
 301 /**
 302  * spl_dfu_cmd- run dfu command with chosen mmc device interface
 303  * @param usb_index - usb controller number
 304  * @param mmc_dev -  mmc device nubmer
 305  *
 306  * @return 0 on success, otherwise error code
 307  */
 308 int spl_dfu_cmd(int usbctrl, char *dfu_alt_info, char *interface, char *devstr);
 309
 310 int spl_mmc_load_image(struct spl_image_info *spl_image,
 311                        struct spl_boot_device *bootdev);
 312
 313 /**
 314  * spl_invoke_atf - boot using an ARM trusted firmware image
 315  */
 316 void spl_invoke_atf(struct spl_image_info *spl_image);
 317
 318 /**
 319  * spl_optee_entry - entry function for optee
 320  *
 321  * args defind in op-tee project
 322  * https://github.com/OP-TEE/optee_os/
 323  * core/arch/arm/kernel/generic_entry_a32.S
 324  * @arg0: pagestore
 325  * @arg1: (ARMv7 standard bootarg #1)
 326  * @arg2: device tree address, (ARMv7 standard bootarg #2)
 327  * @arg3: non-secure entry address (ARMv7 bootarg #0)
 328  */
 329 void spl_optee_entry(void *arg0, void *arg1, void *arg2, void *arg3);
 330
 331 /**
 332  * board_return_to_bootrom - allow for boards to continue with the boot ROM
 333  *
 334  * If a board (e.g. the Rockchip RK3368 boards) provide some
 335  * supporting functionality for SPL in their boot ROM and the SPL
 336  * stage wants to return to the ROM code to continue booting, boards
 337  * can implement 'board_return_to_bootrom'.
 338  */
 339 void board_return_to_bootrom(void);
 340
 341 /**
 342  * spl_perform_fixups() - arch/board-specific callback before processing
 343  *                        the boot-payload
 344  */
 345 void spl_perform_fixups(struct spl_image_info *spl_image);
 346
 347 /*
 348  * spl_get_load_buffer() - get buffer for loading partial image data
 349  *
 350  * Returns memory area which can be populated by partial image data,
 351  * ie. uImage or fitImage header.
 352  */
 353 struct image_header *spl_get_load_buffer(ssize_t offset, size_t size);
 354
 355 #endif