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 enum u_boot_phase {
  53         PHASE_TPL,
  54         PHASE_SPL,
  55         PHASE_U_BOOT,
  56 };
  57
  58 /**
  59  * spl_phase() - Find out the phase of U-Boot
  60  *
  61  * This can be used to avoid #ifdef logic and use if() instead.
  62  *
  63  * For example, to include code only in TPL, you might do:
  64  *
  65  *    #ifdef CONFIG_TPL_BUILD
  66  *    ...
  67  *    #endif
  68  *
  69  * but with this you can use:
  70  *
  71  *    if (spl_phase() == PHASE_TPL) {
  72  *       ...
  73  *    }
  74  *
  75  * To include code only in SPL, you might do:
  76  *
  77  *    #if defined(CONFIG_SPL_BUILD) && !defined(CONFIG_TPL_BUILD)
  78  *    ...
  79  *    #endif
  80  *
  81  * but with this you can use:
  82  *
  83  *    if (spl_phase() == PHASE_SPL) {
  84  *       ...
  85  *    }
  86  *
  87  * To include code only in U-Boot proper, you might do:
  88  *
  89  *    #ifndef CONFIG_SPL_BUILD
  90  *    ...
  91  *    #endif
  92  *
  93  * but with this you can use:
  94  *
  95  *    if (spl_phase() == PHASE_U_BOOT) {
  96  *       ...
  97  *    }
  98  *
  99  * @return U-Boot phase
 100  */
 101 static inline enum u_boot_phase spl_phase(void)
 102 {
 103 #ifdef CONFIG_TPL_BUILD
 104         return PHASE_TPL;
 105 #elif CONFIG_SPL_BUILD
 106         return PHASE_SPL;
 107 #else
 108         return PHASE_U_BOOT;
 109 #endif
 110 }
 111
 112 /* A string name for SPL or TPL */
 113 #ifdef CONFIG_SPL_BUILD
 114 # ifdef CONFIG_TPL_BUILD
 115 #  define SPL_TPL_NAME  "TPL"
 116 # else
 117 #  define SPL_TPL_NAME  "SPL"
 118 # endif
 119 # define SPL_TPL_PROMPT SPL_TPL_NAME ": "
 120 #else
 121 # define SPL_TPL_NAME   ""
 122 # define SPL_TPL_PROMPT ""
 123 #endif
 124
 125 struct spl_image_info {
 126         const char *name;
 127         u8 os;
 128         uintptr_t load_addr;
 129         uintptr_t entry_point;
 130 #if CONFIG_IS_ENABLED(LOAD_FIT) || CONFIG_IS_ENABLED(LOAD_FIT_FULL)
 131         void *fdt_addr;
 132 #endif
 133         u32 boot_device;
 134         u32 size;
 135         u32 flags;
 136         void *arg;
 137 #ifdef CONFIG_SPL_LEGACY_IMAGE_CRC_CHECK
 138         ulong dcrc_data;
 139         ulong dcrc_length;
 140         ulong dcrc;
 141 #endif
 142 };
 143
 144 /*
 145  * Information required to load data from a device
 146  *
 147  * @dev: Pointer to the device, e.g. struct mmc *
 148  * @priv: Private data for the device
 149  * @bl_len: Block length for reading in bytes
 150  * @filename: Name of the fit image file.
 151  * @read: Function to call to read from the device
 152  */
 153 struct spl_load_info {
 154         void *dev;
 155         void *priv;
 156         int bl_len;
 157         const char *filename;
 158         ulong (*read)(struct spl_load_info *load, ulong sector, ulong count,
 159                       void *buf);
 160 };
 161
 162 /*
 163  * We need to know the position of U-Boot in memory so we can jump to it. We
 164  * allow any U-Boot binary to be used (u-boot.bin, u-boot-nodtb.bin,
 165  * u-boot.img), hence the '_any'. These is no checking here that the correct
 166  * image is found. For * example if u-boot.img is used we don't check that
 167  * spl_parse_image_header() can parse a valid header.
 168  */
 169 binman_sym_extern(ulong, u_boot_any, image_pos);
 170
 171 /**
 172  * spl_load_simple_fit_skip_processing() - Hook to allow skipping the FIT
 173  *      image processing during spl_load_simple_fit().
 174  *
 175  * Return true to skip FIT processing, false to preserve the full code flow
 176  * of spl_load_simple_fit().
 177  */
 178 bool spl_load_simple_fit_skip_processing(void);
 179
 180 /**
 181  * spl_load_simple_fit() - Loads a fit image from a device.
 182  * @spl_image:  Image description to set up
 183  * @info:       Structure containing the information required to load data.
 184  * @sector:     Sector number where FIT image is located in the device
 185  * @fdt:        Pointer to the copied FIT header.
 186  *
 187  * Reads the FIT image @sector in the device. Loads u-boot image to
 188  * specified load address and copies the dtb to end of u-boot image.
 189  * Returns 0 on success.
 190  */
 191 int spl_load_simple_fit(struct spl_image_info *spl_image,
 192                         struct spl_load_info *info, ulong sector, void *fdt);
 193
 194 #define SPL_COPY_PAYLOAD_ONLY   1
 195 #define SPL_FIT_FOUND           2
 196
 197 /* SPL common functions */
 198 void preloader_console_init(void);
 199 u32 spl_boot_device(void);
 200 u32 spl_boot_mode(const u32 boot_device);
 201 int spl_boot_partition(const u32 boot_device);
 202 void spl_set_bd(void);
 203
 204 /**
 205  * spl_set_header_raw_uboot() - Set up a standard SPL image structure
 206  *
 207  * This sets up the given spl_image which the standard values obtained from
 208  * config options: CONFIG_SYS_MONITOR_LEN, CONFIG_SYS_UBOOT_START,
 209  * CONFIG_SYS_TEXT_BASE.
 210  *
 211  * @spl_image: Image description to set up
 212  */
 213 void spl_set_header_raw_uboot(struct spl_image_info *spl_image);
 214
 215 /**
 216  * spl_parse_image_header() - parse the image header and set up info
 217  *
 218  * This parses the legacy image header information at @header and sets up
 219  * @spl_image according to what is found. If no image header is found, then
 220  * a raw image or bootz is assumed. If CONFIG_SPL_PANIC_ON_RAW_IMAGE is
 221  * enabled, then this causes a panic. If CONFIG_SPL_RAW_IMAGE_SUPPORT is not
 222  * enabled then U-Boot gives up. Otherwise U-Boot sets up the image using
 223  * spl_set_header_raw_uboot(), or possibly the bootz header.
 224  *
 225  * @spl_image: Image description to set up
 226  * @header image header to parse
 227  * @return 0 if a header was correctly parsed, -ve on error
 228  */
 229 int spl_parse_image_header(struct spl_image_info *spl_image,
 230                            const struct image_header *header);
 231
 232 void spl_board_prepare_for_linux(void);
 233 void spl_board_prepare_for_boot(void);
 234 int spl_board_ubi_load_image(u32 boot_device);
 235
 236 /**
 237  * jump_to_image_linux() - Jump to a Linux kernel from SPL
 238  *
 239  * This jumps into a Linux kernel using the information in @spl_image.
 240  *
 241  * @spl_image: Image description to set up
 242  */
 243 void __noreturn jump_to_image_linux(struct spl_image_info *spl_image);
 244
 245 /**
 246  * spl_start_uboot() - Check if SPL should start the kernel or U-Boot
 247  *
 248  * This is called by the various SPL loaders to determine whether the board
 249  * wants to load the kernel or U-Boot. This function should be provided by
 250  * the board.
 251  *
 252  * @return 0 if SPL should start the kernel, 1 if U-Boot must be started
 253  */
 254 int spl_start_uboot(void);
 255
 256 /**
 257  * spl_display_print() - Display a board-specific message in SPL
 258  *
 259  * If CONFIG_SPL_DISPLAY_PRINT is enabled, U-Boot will call this function
 260  * immediately after displaying the SPL console banner ("U-Boot SPL ...").
 261  * This function should be provided by the board.
 262  */
 263 void spl_display_print(void);
 264
 265 /**
 266  * struct spl_boot_device - Describes a boot device used by SPL
 267  *
 268  * @boot_device: A number indicating the BOOT_DEVICE type. There are various
 269  * BOOT_DEVICE... #defines and enums in U-Boot and they are not consistently
 270  * numbered.
 271  * @boot_device_name: Named boot device, or NULL if none.
 272  *
 273  * Note: Additional fields can be added here, bearing in mind that SPL is
 274  * size-sensitive and common fields will be present on all boards. This
 275  * struct can also be used to return additional information about the load
 276  * process if that becomes useful.
 277  */
 278 struct spl_boot_device {
 279         uint boot_device;
 280         const char *boot_device_name;
 281 };
 282
 283 /**
 284  * Holds information about a way of loading an SPL image
 285  *
 286  * @name: User-friendly name for this method (e.g. "MMC")
 287  * @boot_device: Boot device that this loader supports
 288  * @load_image: Function to call to load image
 289  */
 290 struct spl_image_loader {
 291 #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
 292         const char *name;
 293 #endif
 294         uint boot_device;
 295         /**
 296          * load_image() - Load an SPL image
 297          *
 298          * @spl_image: place to put image information
 299          * @bootdev: describes the boot device to load from
 300          */
 301         int (*load_image)(struct spl_image_info *spl_image,
 302                           struct spl_boot_device *bootdev);
 303 };
 304
 305 /* Declare an SPL image loader */
 306 #define SPL_LOAD_IMAGE(__name)                                  \
 307         ll_entry_declare(struct spl_image_loader, __name, spl_image_loader)
 308
 309 /*
 310  * _priority is the priority of this method, 0 meaning it will be the top
 311  * choice for this device, 9 meaning it is the bottom choice.
 312  * _boot_device is the BOOT_DEVICE_... value
 313  * _method is the load_image function to call
 314  */
 315 #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
 316 #define SPL_LOAD_IMAGE_METHOD(_name, _priority, _boot_device, _method) \
 317         SPL_LOAD_IMAGE(_method ## _priority ## _boot_device) = { \
 318                 .name = _name, \
 319                 .boot_device = _boot_device, \
 320                 .load_image = _method, \
 321         }
 322 #else
 323 #define SPL_LOAD_IMAGE_METHOD(_name, _priority, _boot_device, _method) \
 324         SPL_LOAD_IMAGE(_method ## _priority ## _boot_device) = { \
 325                 .boot_device = _boot_device, \
 326                 .load_image = _method, \
 327         }
 328 #endif
 329
 330 /* SPL FAT image functions */
 331 int spl_load_image_fat(struct spl_image_info *spl_image,
 332                        struct blk_desc *block_dev, int partition,
 333                        const char *filename);
 334 int spl_load_image_fat_os(struct spl_image_info *spl_image,
 335                           struct blk_desc *block_dev, int partition);
 336
 337 void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image);
 338
 339 /* SPL EXT image functions */
 340 int spl_load_image_ext(struct spl_image_info *spl_image,
 341                        struct blk_desc *block_dev, int partition,
 342                        const char *filename);
 343 int spl_load_image_ext_os(struct spl_image_info *spl_image,
 344                           struct blk_desc *block_dev, int partition);
 345
 346 /**
 347  * spl_early_init() - Set up device tree and driver model in SPL if enabled
 348  *
 349  * Call this function in board_init_f() if you want to use device tree and
 350  * driver model early, before board_init_r() is called.
 351  *
 352  * If this is not called, then driver model will be inactive in SPL's
 353  * board_init_f(), and no device tree will be available.
 354  */
 355 int spl_early_init(void);
 356
 357 /**
 358  * spl_init() - Set up device tree and driver model in SPL if enabled
 359  *
 360  * You can optionally call spl_early_init(), then optionally call spl_init().
 361  * This function will be called from board_init_r() if not called earlier.
 362  *
 363  * Both spl_early_init() and spl_init() perform a similar function except that
 364  * the latter will not set up the malloc() area if
 365  * CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN is enabled, since it is assumed to
 366  * already be done by a calll to spl_relocate_stack_gd() before board_init_r()
 367  * is reached.
 368  *
 369  * This function will be called from board_init_r() if not called earlier.
 370  *
 371  * If this is not called, then driver model will be inactive in SPL's
 372  * board_init_f(), and no device tree will be available.
 373  */
 374 int spl_init(void);
 375
 376 #ifdef CONFIG_SPL_BOARD_INIT
 377 void spl_board_init(void);
 378 #endif
 379
 380 /**
 381  * spl_was_boot_source() - check if U-Boot booted from SPL
 382  *
 383  * This will normally be true, but if U-Boot jumps to second U-Boot, it will
 384  * be false. This should be implemented by board-specific code.
 385  *
 386  * @return true if U-Boot booted from SPL, else false
 387  */
 388 bool spl_was_boot_source(void);
 389
 390 /**
 391  * spl_dfu_cmd- run dfu command with chosen mmc device interface
 392  * @param usb_index - usb controller number
 393  * @param mmc_dev -  mmc device nubmer
 394  *
 395  * @return 0 on success, otherwise error code
 396  */
 397 int spl_dfu_cmd(int usbctrl, char *dfu_alt_info, char *interface, char *devstr);
 398
 399 int spl_mmc_load_image(struct spl_image_info *spl_image,
 400                        struct spl_boot_device *bootdev);
 401
 402 /**
 403  * spl_mmc_load() - Load an image file from MMC/SD media
 404  *
 405  * @param spl_image     Image data filled in by loading process
 406  * @param bootdev       Describes which device to load from
 407  * @param filename      Name of file to load (in FS mode)
 408  * @param raw_part      Partition to load from (in RAW mode)
 409  * @param raw_sect      Sector to load from (in RAW mode)
 410  *
 411  * @return 0 on success, otherwise error code
 412  */
 413 int spl_mmc_load(struct spl_image_info *spl_image,
 414                  struct spl_boot_device *bootdev,
 415                  const char *filename,
 416                  int raw_part,
 417                  unsigned long raw_sect);
 418
 419 /**
 420  * spl_invoke_atf - boot using an ARM trusted firmware image
 421  */
 422 void spl_invoke_atf(struct spl_image_info *spl_image);
 423
 424 /**
 425  * spl_optee_entry - entry function for optee
 426  *
 427  * args defind in op-tee project
 428  * https://github.com/OP-TEE/optee_os/
 429  * core/arch/arm/kernel/generic_entry_a32.S
 430  * @arg0: pagestore
 431  * @arg1: (ARMv7 standard bootarg #1)
 432  * @arg2: device tree address, (ARMv7 standard bootarg #2)
 433  * @arg3: non-secure entry address (ARMv7 bootarg #0)
 434  */
 435 void spl_optee_entry(void *arg0, void *arg1, void *arg2, void *arg3);
 436
 437 /**
 438  * spl_invoke_opensbi - boot using a RISC-V OpenSBI image
 439  */
 440 void spl_invoke_opensbi(struct spl_image_info *spl_image);
 441
 442 /**
 443  * board_return_to_bootrom - allow for boards to continue with the boot ROM
 444  *
 445  * If a board (e.g. the Rockchip RK3368 boards) provide some
 446  * supporting functionality for SPL in their boot ROM and the SPL
 447  * stage wants to return to the ROM code to continue booting, boards
 448  * can implement 'board_return_to_bootrom'.
 449  */
 450 void board_return_to_bootrom(void);
 451
 452 /**
 453  * board_spl_fit_post_load - allow process images after loading finished
 454  *
 455  */
 456 void board_spl_fit_post_load(ulong load_addr, size_t length);
 457
 458 /**
 459  * board_spl_fit_size_align - specific size align before processing payload
 460  *
 461  */
 462 ulong board_spl_fit_size_align(ulong size);
 463
 464 /**
 465  * spl_perform_fixups() - arch/board-specific callback before processing
 466  *                        the boot-payload
 467  */
 468 void spl_perform_fixups(struct spl_image_info *spl_image);
 469
 470 /*
 471  * spl_get_load_buffer() - get buffer for loading partial image data
 472  *
 473  * Returns memory area which can be populated by partial image data,
 474  * ie. uImage or fitImage header.
 475  */
 476 struct image_header *spl_get_load_buffer(ssize_t offset, size_t size);
 477
 478 #endif