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