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 #include <linker_lists.h>
  11
  12 /* Platform-specific defines */
  13 #include <linux/compiler.h>
  14 #include <asm/global_data.h>
  15 #include <asm/spl.h>
  16 #include <handoff.h>
  17 #include <mmc.h>
  18
  19 struct blk_desc;
  20 struct legacy_img_hdr;
  21
  22 /* Value in r0 indicates we booted from U-Boot */
  23 #define UBOOT_NOT_LOADED_FROM_SPL       0x13578642
  24
  25 /* Boot type */
  26 #define MMCSD_MODE_UNDEFINED    0
  27 #define MMCSD_MODE_RAW          1
  28 #define MMCSD_MODE_FS           2
  29 #define MMCSD_MODE_EMMCBOOT     3
  30
  31 struct blk_desc;
  32 struct legacy_img_hdr;
  33 struct spl_boot_device;
  34
  35 /*
  36  * u_boot_first_phase() - check if this is the first U-Boot phase
  37  *
  38  * U-Boot has up to three phases: TPL, SPL and U-Boot proper. Depending on the
  39  * build flags we can determine whether the current build is for the first
  40  * phase of U-Boot or not. If there is no SPL, then this is U-Boot proper. If
  41  * there is SPL but no TPL, the the first phase is SPL. If there is TPL, then
  42  * it is the first phase.
  43  *
  44  * @returns true if this is the first phase of U-Boot
  45  *
  46  */
  47 static inline bool u_boot_first_phase(void)
  48 {
  49         if (IS_ENABLED(CONFIG_TPL)) {
  50                 if (IS_ENABLED(CONFIG_TPL_BUILD))
  51                         return true;
  52         } else if (IS_ENABLED(CONFIG_SPL)) {
  53                 if (IS_ENABLED(CONFIG_SPL_BUILD))
  54                         return true;
  55         } else {
  56                 return true;
  57         }
  58
  59         return false;
  60 }
  61
  62 enum u_boot_phase {
  63         PHASE_NONE,     /* Invalid phase, signifying before U-Boot */
  64         PHASE_TPL,      /* Running in TPL */
  65         PHASE_VPL,      /* Running in VPL */
  66         PHASE_SPL,      /* Running in SPL */
  67         PHASE_BOARD_F,  /* Running in U-Boot before relocation */
  68         PHASE_BOARD_R,  /* Running in U-Boot after relocation */
  69
  70         PHASE_COUNT,
  71 };
  72
  73 /**
  74  * spl_phase() - Find out the phase of U-Boot
  75  *
  76  * This can be used to avoid #ifdef logic and use if() instead.
  77  *
  78  * For example, to include code only in TPL, you might do:
  79  *
  80  *    #ifdef CONFIG_TPL_BUILD
  81  *    ...
  82  *    #endif
  83  *
  84  * but with this you can use:
  85  *
  86  *    if (spl_phase() == PHASE_TPL) {
  87  *       ...
  88  *    }
  89  *
  90  * To include code only in SPL, you might do:
  91  *
  92  *    #if defined(CONFIG_SPL_BUILD) && !defined(CONFIG_TPL_BUILD)
  93  *    ...
  94  *    #endif
  95  *
  96  * but with this you can use:
  97  *
  98  *    if (spl_phase() == PHASE_SPL) {
  99  *       ...
 100  *    }
 101  *
 102  * To include code only in U-Boot proper, you might do:
 103  *
 104  *    #ifndef CONFIG_SPL_BUILD
 105  *    ...
 106  *    #endif
 107  *
 108  * but with this you can use:
 109  *
 110  *    if (spl_phase() == PHASE_BOARD_F) {
 111  *       ...
 112  *    }
 113  *
 114  * Return: U-Boot phase
 115  */
 116 static inline enum u_boot_phase spl_phase(void)
 117 {
 118 #ifdef CONFIG_TPL_BUILD
 119         return PHASE_TPL;
 120 #elif defined(CONFIG_VPL_BUILD)
 121         return PHASE_VPL;
 122 #elif defined(CONFIG_SPL_BUILD)
 123         return PHASE_SPL;
 124 #else
 125         DECLARE_GLOBAL_DATA_PTR;
 126
 127         if (!(gd->flags & GD_FLG_RELOC))
 128                 return PHASE_BOARD_F;
 129         else
 130                 return PHASE_BOARD_R;
 131 #endif
 132 }
 133
 134 /**
 135  * spl_prev_phase() - Figure out the previous U-Boot phase
 136  *
 137  * Return: the previous phase from this one, e.g. if called in SPL this returns
 138  *      PHASE_TPL, if TPL is enabled
 139  */
 140 static inline enum u_boot_phase spl_prev_phase(void)
 141 {
 142 #ifdef CONFIG_TPL_BUILD
 143         return PHASE_NONE;
 144 #elif defined(CONFIG_VPL_BUILD)
 145         return PHASE_TPL;       /* VPL requires TPL */
 146 #elif defined(CONFIG_SPL_BUILD)
 147         return IS_ENABLED(CONFIG_VPL) ? PHASE_VPL :
 148                 IS_ENABLED(CONFIG_TPL) ? PHASE_TPL :
 149                 PHASE_NONE;
 150 #else
 151         return IS_ENABLED(CONFIG_SPL) ? PHASE_SPL :
 152                 PHASE_NONE;
 153 #endif
 154 }
 155
 156 /**
 157  * spl_next_phase() - Figure out the next U-Boot phase
 158  *
 159  * Return: the next phase from this one, e.g. if called in TPL this returns
 160  *      PHASE_SPL
 161  */
 162 static inline enum u_boot_phase spl_next_phase(void)
 163 {
 164 #ifdef CONFIG_TPL_BUILD
 165         return IS_ENABLED(CONFIG_VPL) ? PHASE_VPL : PHASE_SPL;
 166 #elif defined(CONFIG_VPL_BUILD)
 167         return PHASE_SPL;
 168 #else
 169         return PHASE_BOARD_F;
 170 #endif
 171 }
 172
 173 /**
 174  * spl_phase_name() - Get the name of the current phase
 175  *
 176  * Return: phase name
 177  */
 178 static inline const char *spl_phase_name(enum u_boot_phase phase)
 179 {
 180         switch (phase) {
 181         case PHASE_TPL:
 182                 return "TPL";
 183         case PHASE_VPL:
 184                 return "VPL";
 185         case PHASE_SPL:
 186                 return "SPL";
 187         case PHASE_BOARD_F:
 188         case PHASE_BOARD_R:
 189                 return "U-Boot";
 190         default:
 191                 return "phase?";
 192         }
 193 }
 194
 195 /**
 196  * spl_phase_prefix() - Get the prefix  of the current phase
 197  *
 198  * @phase: Phase to look up
 199  * Return: phase prefix ("spl", "tpl", etc.)
 200  */
 201 static inline const char *spl_phase_prefix(enum u_boot_phase phase)
 202 {
 203         switch (phase) {
 204         case PHASE_TPL:
 205                 return "tpl";
 206         case PHASE_VPL:
 207                 return "vpl";
 208         case PHASE_SPL:
 209                 return "spl";
 210         case PHASE_BOARD_F:
 211         case PHASE_BOARD_R:
 212                 return "";
 213         default:
 214                 return "phase?";
 215         }
 216 }
 217
 218 /* A string name for SPL or TPL */
 219 #ifdef CONFIG_SPL_BUILD
 220 # ifdef CONFIG_TPL_BUILD
 221 #  define SPL_TPL_NAME  "TPL"
 222 # elif defined(CONFIG_VPL_BUILD)
 223 #  define SPL_TPL_NAME  "VPL"
 224 # else
 225 #  define SPL_TPL_NAME  "SPL"
 226 # endif
 227 # define SPL_TPL_PROMPT SPL_TPL_NAME ": "
 228 #else
 229 # define SPL_TPL_NAME   ""
 230 # define SPL_TPL_PROMPT ""
 231 #endif
 232
 233 /**
 234  * enum spl_sandbox_flags - flags for sandbox's use of spl_image_info->flags
 235  *
 236  * @SPL_SANDBOXF_ARG_IS_FNAME: arg is the filename to jump to (default)
 237  * @SPL_SANDBOXF_ARG_IS_BUF: arg is the containing image to jump to, @offset is
 238  *      the start offset within the image, @size is the size of the image
 239  */
 240 enum spl_sandbox_flags {
 241         SPL_SANDBOXF_ARG_IS_FNAME = 0,
 242         SPL_SANDBOXF_ARG_IS_BUF,
 243 };
 244
 245 struct spl_image_info {
 246         const char *name;
 247         u8 os;
 248         uintptr_t load_addr;
 249         uintptr_t entry_point;
 250 #if CONFIG_IS_ENABLED(LOAD_FIT) || CONFIG_IS_ENABLED(LOAD_FIT_FULL)
 251         void *fdt_addr;
 252 #endif
 253         u32 boot_device;
 254         u32 offset;
 255         u32 size;
 256         u32 flags;
 257         void *arg;
 258 #ifdef CONFIG_SPL_LEGACY_IMAGE_CRC_CHECK
 259         ulong dcrc_data;
 260         ulong dcrc_length;
 261         ulong dcrc;
 262 #endif
 263 };
 264
 265 /**
 266  * Information required to load data from a device
 267  *
 268  * @dev: Pointer to the device, e.g. struct mmc *
 269  * @priv: Private data for the device
 270  * @bl_len: Block length for reading in bytes
 271  * @filename: Name of the fit image file.
 272  * @read: Function to call to read from the device
 273  */
 274 struct spl_load_info {
 275         void *dev;
 276         void *priv;
 277         int bl_len;
 278         const char *filename;
 279         /**
 280          * read() - Read from device
 281          *
 282          * @load: Information about the load state
 283          * @sector: Sector number to read from (each @load->bl_len bytes)
 284          * @count: Number of sectors to read
 285          * @buf: Buffer to read into
 286          * @return number of sectors read, 0 on error
 287          */
 288         ulong (*read)(struct spl_load_info *load, ulong sector, ulong count,
 289                       void *buf);
 290 };
 291
 292 /*
 293  * We need to know the position of U-Boot in memory so we can jump to it. We
 294  * allow any U-Boot binary to be used (u-boot.bin, u-boot-nodtb.bin,
 295  * u-boot.img), hence the '_any'. These is no checking here that the correct
 296  * image is found. For example if u-boot.img is used we don't check that
 297  * spl_parse_image_header() can parse a valid header.
 298  *
 299  * Similarly for SPL, so that TPL can jump to SPL.
 300  */
 301 binman_sym_extern(ulong, u_boot_any, image_pos);
 302 binman_sym_extern(ulong, u_boot_any, size);
 303 binman_sym_extern(ulong, u_boot_spl_any, image_pos);
 304 binman_sym_extern(ulong, u_boot_spl_any, size);
 305 binman_sym_extern(ulong, u_boot_vpl_any, image_pos);
 306 binman_sym_extern(ulong, u_boot_vpl_any, size);
 307
 308 /**
 309  * spl_get_image_pos() - get the image position of the next phase
 310  *
 311  * This returns the image position to use to load the next phase of U-Boot
 312  */
 313 ulong spl_get_image_pos(void);
 314
 315 /**
 316  * spl_get_image_size() - get the size of the next phase
 317  *
 318  * This returns the size to use to load the next phase of U-Boot
 319  */
 320 ulong spl_get_image_size(void);
 321
 322 /**
 323  * spl_get_image_text_base() - get the text base of the next phase
 324  *
 325  * This returns the address that the next stage is linked to run at, i.e.
 326  * CONFIG_SPL_TEXT_BASE or CONFIG_TEXT_BASE
 327  *
 328  * Return: text-base address
 329  */
 330 ulong spl_get_image_text_base(void);
 331
 332 /**
 333  * spl_load_simple_fit_skip_processing() - Hook to allow skipping the FIT
 334  *      image processing during spl_load_simple_fit().
 335  *
 336  * Return true to skip FIT processing, false to preserve the full code flow
 337  * of spl_load_simple_fit().
 338  */
 339 bool spl_load_simple_fit_skip_processing(void);
 340
 341 /**
 342  * spl_load_simple_fit_fix_load() - Hook to make fixes
 343  * after fit image header is loaded
 344  *
 345  * Returns pointer to fit
 346  */
 347 void *spl_load_simple_fit_fix_load(const void *fit);
 348
 349 /**
 350  * spl_load_simple_fit() - Loads a fit image from a device.
 351  * @spl_image:  Image description to set up
 352  * @info:       Structure containing the information required to load data.
 353  * @sector:     Sector number where FIT image is located in the device
 354  * @fdt:        Pointer to the copied FIT header.
 355  *
 356  * Reads the FIT image @sector in the device. Loads u-boot image to
 357  * specified load address and copies the dtb to end of u-boot image.
 358  * Returns 0 on success.
 359  */
 360 int spl_load_simple_fit(struct spl_image_info *spl_image,
 361                         struct spl_load_info *info, ulong sector, void *fdt);
 362
 363 #define SPL_COPY_PAYLOAD_ONLY   1
 364 #define SPL_FIT_FOUND           2
 365
 366 /**
 367  * spl_load_legacy_img() - Loads a legacy image from a device.
 368  * @spl_image:  Image description to set up
 369  * @load:       Structure containing the information required to load data.
 370  * @offset:     Pointer to image
 371  * @hdr:        Pointer to image header
 372  *
 373  * Reads an legacy image from the device. Loads u-boot image to
 374  * specified load address.
 375  * Returns 0 on success.
 376  */
 377 int spl_load_legacy_img(struct spl_image_info *spl_image,
 378                         struct spl_boot_device *bootdev,
 379                         struct spl_load_info *load, ulong offset,
 380                         struct legacy_img_hdr *hdr);
 381
 382
 383 /**
 384  * spl_load_imx_container() - Loads a imx container image from a device.
 385  * @spl_image:  Image description to set up
 386  * @info:       Structure containing the information required to load data.
 387  * @sector:     Sector number where container image is located in the device
 388  *
 389  * Reads the container image @sector in the device. Loads u-boot image to
 390  * specified load address.
 391  */
 392 int spl_load_imx_container(struct spl_image_info *spl_image,
 393                            struct spl_load_info *info, ulong sector);
 394
 395 /* SPL common functions */
 396 void preloader_console_init(void);
 397 u32 spl_boot_device(void);
 398
 399 /**
 400  * spl_spi_boot_bus() - Lookup function for the SPI boot bus source.
 401  *
 402  * This function returns the SF bus to load from.
 403  * If not overridden, it is weakly defined in common/spl/spl_spi.c.
 404  */
 405 u32 spl_spi_boot_bus(void);
 406
 407 /**
 408  * spl_spi_boot_cs() - Lookup function for the SPI boot CS source.
 409  *
 410  * This function returns the SF CS to load from.
 411  * If not overridden, it is weakly defined in common/spl/spl_spi.c.
 412  */
 413 u32 spl_spi_boot_cs(void);
 414
 415 /**
 416  * spl_mmc_boot_mode() - Lookup function for the mode of an MMC boot source.
 417  * @boot_device:        ID of the device which the MMC driver wants to read
 418  *                      from.  Common values are e.g. BOOT_DEVICE_MMC1,
 419  *                      BOOT_DEVICE_MMC2, BOOT_DEVICE_MMC2_2.
 420  *
 421  * This function should return one of MMCSD_MODE_FS, MMCSD_MODE_EMMCBOOT, or
 422  * MMCSD_MODE_RAW for each MMC boot source which is defined for the target.  The
 423  * boot_device parameter tells which device the MMC driver is interested in.
 424  *
 425  * If not overridden, it is weakly defined in common/spl/spl_mmc.c.
 426  *
 427  * Note:  It is important to use the boot_device parameter instead of e.g.
 428  * spl_boot_device() as U-Boot is not always loaded from the same device as SPL.
 429  */
 430 u32 spl_mmc_boot_mode(struct mmc *mmc, const u32 boot_device);
 431
 432 /**
 433  * spl_mmc_boot_partition() - MMC partition to load U-Boot from.
 434  * @boot_device:        ID of the device which the MMC driver wants to load
 435  *                      U-Boot from.
 436  *
 437  * This function should return the partition number which the SPL
 438  * should load U-Boot from (on the given boot_device) when
 439  * CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_USE_PARTITION is set.
 440  *
 441  * If not overridden, it is weakly defined in common/spl/spl_mmc.c.
 442  */
 443 int spl_mmc_boot_partition(const u32 boot_device);
 444
 445 struct mmc;
 446 /**
 447  * default_spl_mmc_emmc_boot_partition() - eMMC boot partition to load U-Boot from.
 448  * mmc:                 Pointer for the mmc device structure
 449  *
 450  * This function should return the eMMC boot partition number which
 451  * the SPL should load U-Boot from (on the given boot_device).
 452  */
 453 int default_spl_mmc_emmc_boot_partition(struct mmc *mmc);
 454
 455 /**
 456  * spl_mmc_emmc_boot_partition() - eMMC boot partition to load U-Boot from.
 457  * mmc:                 Pointer for the mmc device structure
 458  *
 459  * This function should return the eMMC boot partition number which
 460  * the SPL should load U-Boot from (on the given boot_device).
 461  *
 462  * If not overridden, it is weakly defined in common/spl/spl_mmc.c
 463  * and calls default_spl_mmc_emmc_boot_partition();
 464  */
 465 int spl_mmc_emmc_boot_partition(struct mmc *mmc);
 466
 467 void spl_set_bd(void);
 468
 469 /**
 470  * spl_mmc_get_uboot_raw_sector() - Provide raw sector of the start of U-Boot
 471  *
 472  * This is a weak function which by default will provide the raw sector that is
 473  * where the start of the U-Boot image has been written to.
 474  *
 475  * @mmc: struct mmc that describes the devie where U-Boot resides
 476  * @raw_sect: The raw sector number where U-Boot is by default.
 477  * Return: The raw sector location that U-Boot resides at
 478  */
 479 unsigned long spl_mmc_get_uboot_raw_sector(struct mmc *mmc,
 480                                            unsigned long raw_sect);
 481
 482 /**
 483  * spl_set_header_raw_uboot() - Set up a standard SPL image structure
 484  *
 485  * This sets up the given spl_image which the standard values obtained from
 486  * config options: CONFIG_SYS_MONITOR_LEN, CFG_SYS_UBOOT_START,
 487  * CONFIG_TEXT_BASE.
 488  *
 489  * @spl_image: Image description to set up
 490  */
 491 void spl_set_header_raw_uboot(struct spl_image_info *spl_image);
 492
 493 /**
 494  * spl_parse_image_header() - parse the image header and set up info
 495  *
 496  * This parses the legacy image header information at @header and sets up
 497  * @spl_image according to what is found. If no image header is found, then
 498  * a raw image or bootz is assumed. If CONFIG_SPL_PANIC_ON_RAW_IMAGE is
 499  * enabled, then this causes a panic. If CONFIG_SPL_RAW_IMAGE_SUPPORT is not
 500  * enabled then U-Boot gives up. Otherwise U-Boot sets up the image using
 501  * spl_set_header_raw_uboot(), or possibly the bootz header.
 502  *
 503  * @spl_image: Image description to set up
 504  * @header image header to parse
 505  * Return: 0 if a header was correctly parsed, -ve on error
 506  */
 507 int spl_parse_image_header(struct spl_image_info *spl_image,
 508                            const struct spl_boot_device *bootdev,
 509                            const struct legacy_img_hdr *header);
 510
 511 void spl_board_prepare_for_linux(void);
 512
 513 /**
 514  * spl_board_prepare_for_optee() - Prepare board for an OPTEE payload
 515  *
 516  * Prepares the board for booting an OP-TEE payload. Initialization is platform
 517  * specific, and may include configuring the TrustZone memory, and other
 518  * initialization steps required by OP-TEE.
 519  * Note that @fdt is not used directly by OP-TEE. OP-TEE passes this @fdt to
 520  * its normal world target. This target is not guaranteed to be u-boot, so @fdt
 521  * changes that would normally be done by u-boot should be done in this step.
 522  *
 523  * @fdt: Devicetree that will be passed on, or NULL
 524  */
 525 void spl_board_prepare_for_optee(void *fdt);
 526 void spl_board_prepare_for_boot(void);
 527 int spl_board_ubi_load_image(u32 boot_device);
 528 int spl_board_boot_device(u32 boot_device);
 529
 530 /**
 531  * spl_board_loader_name() - Return a name for the loader
 532  *
 533  * This is a weak function which might be overridden by the board code. With
 534  * that a board specific value for the device where the U-Boot will be loaded
 535  * from can be set. By default it returns NULL.
 536  *
 537  * @boot_device:        ID of the device which SPL wants to load U-Boot from.
 538  */
 539 const char *spl_board_loader_name(u32 boot_device);
 540
 541 /**
 542  * jump_to_image_linux() - Jump to a Linux kernel from SPL
 543  *
 544  * This jumps into a Linux kernel using the information in @spl_image.
 545  *
 546  * @spl_image: Image description to set up
 547  */
 548 void __noreturn jump_to_image_linux(struct spl_image_info *spl_image);
 549
 550 /**
 551  * jump_to_image_optee() - Jump to OP-TEE OS from SPL
 552  *
 553  * This jumps into OP-TEE OS using the information in @spl_image.
 554  *
 555  * @spl_image: Image description to set up
 556  */
 557 void __noreturn jump_to_image_optee(struct spl_image_info *spl_image);
 558
 559 /**
 560  * spl_start_uboot() - Check if SPL should start the kernel or U-Boot
 561  *
 562  * This is called by the various SPL loaders to determine whether the board
 563  * wants to load the kernel or U-Boot. This function should be provided by
 564  * the board.
 565  *
 566  * Return: 0 if SPL should start the kernel, 1 if U-Boot must be started
 567  */
 568 int spl_start_uboot(void);
 569
 570 /**
 571  * spl_display_print() - Display a board-specific message in SPL
 572  *
 573  * If CONFIG_SPL_DISPLAY_PRINT is enabled, U-Boot will call this function
 574  * immediately after displaying the SPL console banner ("U-Boot SPL ...").
 575  * This function should be provided by the board.
 576  */
 577 void spl_display_print(void);
 578
 579 /**
 580  * struct spl_boot_device - Describes a boot device used by SPL
 581  *
 582  * @boot_device: A number indicating the BOOT_DEVICE type. There are various
 583  * BOOT_DEVICE... #defines and enums in U-Boot and they are not consistently
 584  * numbered.
 585  * @boot_device_name: Named boot device, or NULL if none.
 586  *
 587  * Note: Additional fields can be added here, bearing in mind that SPL is
 588  * size-sensitive and common fields will be present on all boards. This
 589  * struct can also be used to return additional information about the load
 590  * process if that becomes useful.
 591  */
 592 struct spl_boot_device {
 593         uint boot_device;
 594         const char *boot_device_name;
 595 };
 596
 597 /**
 598  * Holds information about a way of loading an SPL image
 599  *
 600  * @name: User-friendly name for this method (e.g. "MMC")
 601  * @boot_device: Boot device that this loader supports
 602  * @load_image: Function to call to load image
 603  */
 604 struct spl_image_loader {
 605 #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
 606         const char *name;
 607 #endif
 608         uint boot_device;
 609         /**
 610          * load_image() - Load an SPL image
 611          *
 612          * @spl_image: place to put image information
 613          * @bootdev: describes the boot device to load from
 614          */
 615         int (*load_image)(struct spl_image_info *spl_image,
 616                           struct spl_boot_device *bootdev);
 617 };
 618
 619 /* Helper function for accessing the name */
 620 static inline const char *spl_loader_name(const struct spl_image_loader *loader)
 621 {
 622 #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
 623         const char *name;
 624         name = spl_board_loader_name(loader->boot_device);
 625         return name ?: loader->name;
 626 #else
 627         return NULL;
 628 #endif
 629 }
 630
 631 /* Declare an SPL image loader */
 632 #define SPL_LOAD_IMAGE(__name)                                  \
 633         ll_entry_declare(struct spl_image_loader, __name, spl_image_loader)
 634
 635 /*
 636  * _priority is the priority of this method, 0 meaning it will be the top
 637  * choice for this device, 9 meaning it is the bottom choice.
 638  * _boot_device is the BOOT_DEVICE_... value
 639  * _method is the load_image function to call
 640  */
 641 #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
 642 #define SPL_LOAD_IMAGE_METHOD(_name, _priority, _boot_device, _method) \
 643         SPL_LOAD_IMAGE(_boot_device ## _priority ## _method) = { \
 644                 .name = _name, \
 645                 .boot_device = _boot_device, \
 646                 .load_image = _method, \
 647         }
 648 #else
 649 #define SPL_LOAD_IMAGE_METHOD(_name, _priority, _boot_device, _method) \
 650         SPL_LOAD_IMAGE(_boot_device ## _priority ## _method) = { \
 651                 .boot_device = _boot_device, \
 652                 .load_image = _method, \
 653         }
 654 #endif
 655
 656 /* SPL FAT image functions */
 657 int spl_load_image_fat(struct spl_image_info *spl_image,
 658                        struct spl_boot_device *bootdev,
 659                        struct blk_desc *block_dev, int partition,
 660                        const char *filename);
 661 int spl_load_image_fat_os(struct spl_image_info *spl_image,
 662                           struct spl_boot_device *bootdev,
 663                           struct blk_desc *block_dev, int partition);
 664
 665 void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image);
 666
 667 /* SPL EXT image functions */
 668 int spl_load_image_ext(struct spl_image_info *spl_image,
 669                        struct spl_boot_device *bootdev,
 670                        struct blk_desc *block_dev, int partition,
 671                        const char *filename);
 672 int spl_load_image_ext_os(struct spl_image_info *spl_image,
 673                           struct spl_boot_device *bootdev,
 674                           struct blk_desc *block_dev, int partition);
 675 int spl_blk_load_image(struct spl_image_info *spl_image,
 676                        struct spl_boot_device *bootdev,
 677                        enum uclass_id uclass_id, int devnum, int partnum);
 678
 679 /**
 680  * spl_early_init() - Set up device tree and driver model in SPL if enabled
 681  *
 682  * Call this function in board_init_f() if you want to use device tree and
 683  * driver model early, before board_init_r() is called.
 684  *
 685  * If this is not called, then driver model will be inactive in SPL's
 686  * board_init_f(), and no device tree will be available.
 687  */
 688 int spl_early_init(void);
 689
 690 /**
 691  * spl_init() - Set up device tree and driver model in SPL if enabled
 692  *
 693  * You can optionally call spl_early_init(), then optionally call spl_init().
 694  * This function will be called from board_init_r() if not called earlier.
 695  *
 696  * Both spl_early_init() and spl_init() perform a similar function except that
 697  * the latter will not set up the malloc() area if
 698  * CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN is enabled, since it is assumed to
 699  * already be done by a calll to spl_relocate_stack_gd() before board_init_r()
 700  * is reached.
 701  *
 702  * This function will be called from board_init_r() if not called earlier.
 703  *
 704  * If this is not called, then driver model will be inactive in SPL's
 705  * board_init_f(), and no device tree will be available.
 706  */
 707 int spl_init(void);
 708
 709 #ifdef CONFIG_SPL_BOARD_INIT
 710 void spl_board_init(void);
 711 #endif
 712
 713 /**
 714  * spl_was_boot_source() - check if U-Boot booted from SPL
 715  *
 716  * This will normally be true, but if U-Boot jumps to second U-Boot, it will
 717  * be false. This should be implemented by board-specific code.
 718  *
 719  * Return: true if U-Boot booted from SPL, else false
 720  */
 721 bool spl_was_boot_source(void);
 722
 723 /**
 724  * spl_dfu_cmd- run dfu command with chosen mmc device interface
 725  * @param usb_index - usb controller number
 726  * @param mmc_dev -  mmc device nubmer
 727  *
 728  * Return: 0 on success, otherwise error code
 729  */
 730 int spl_dfu_cmd(int usbctrl, char *dfu_alt_info, char *interface, char *devstr);
 731
 732 int spl_mmc_load_image(struct spl_image_info *spl_image,
 733                        struct spl_boot_device *bootdev);
 734
 735 /**
 736  * spl_mmc_load() - Load an image file from MMC/SD media
 737  *
 738  * @param spl_image     Image data filled in by loading process
 739  * @param bootdev       Describes which device to load from
 740  * @param filename      Name of file to load (in FS mode)
 741  * @param raw_part      Partition to load from (in RAW mode)
 742  * @param raw_sect      Sector to load from (in RAW mode)
 743  *
 744  * Return: 0 on success, otherwise error code
 745  */
 746 int spl_mmc_load(struct spl_image_info *spl_image,
 747                  struct spl_boot_device *bootdev,
 748                  const char *filename,
 749                  int raw_part,
 750                  unsigned long raw_sect);
 751
 752 /**
 753  * spl_usb_load() - Load an image file from USB mass storage
 754  *
 755  * @param spl_image     Image data filled in by loading process
 756  * @param bootdev       Describes which device to load from
 757  * @param raw_part      Fat partition to load from
 758  * @param filename      Name of file to load
 759  *
 760  * Return: 0 on success, otherwise error code
 761  */
 762 int spl_usb_load(struct spl_image_info *spl_image,
 763                  struct spl_boot_device *bootdev,
 764                  int partition, const char *filename);
 765
 766 int spl_ymodem_load_image(struct spl_image_info *spl_image,
 767                           struct spl_boot_device *bootdev);
 768
 769 /**
 770  * spl_invoke_atf - boot using an ARM trusted firmware image
 771  */
 772 void spl_invoke_atf(struct spl_image_info *spl_image);
 773
 774 /**
 775  * bl2_plat_get_bl31_params() - return params for bl31.
 776  * @bl32_entry: address of BL32 executable (secure)
 777  * @bl33_entry: address of BL33 executable (non secure)
 778  * @fdt_addr:   address of Flat Device Tree
 779  *
 780  * This is a weak function which might be overridden by the board code. By
 781  * default it will just call bl2_plat_get_bl31_params_default().
 782  *
 783  * If you just want to manipulate or add some parameters, you can override
 784  * this function, call bl2_plat_get_bl31_params_default and operate on the
 785  * returned bl31 params.
 786  *
 787  * Return: bl31 params structure pointer
 788  */
 789 struct bl31_params *bl2_plat_get_bl31_params(uintptr_t bl32_entry,
 790                                              uintptr_t bl33_entry,
 791                                              uintptr_t fdt_addr);
 792
 793 /**
 794  * bl2_plat_get_bl31_params_default() - prepare params for bl31.
 795  * @bl32_entry: address of BL32 executable (secure)
 796  * @bl33_entry: address of BL33 executable (non secure)
 797  * @fdt_addr:   address of Flat Device Tree
 798  *
 799  * This is the default implementation of bl2_plat_get_bl31_params(). It assigns
 800  * a pointer to the memory that the platform has kept aside to pass platform
 801  * specific and trusted firmware related information to BL31. This memory is
 802  * allocated by allocating memory to bl2_to_bl31_params_mem structure which is
 803  * a superset of all the structure whose information is passed to BL31
 804  *
 805  * NOTE: The memory is statically allocated, thus this function should be
 806  * called only once. All subsequent calls will overwrite any changes.
 807  *
 808  * Return: bl31 params structure pointer
 809  */
 810 struct bl31_params *bl2_plat_get_bl31_params_default(uintptr_t bl32_entry,
 811                                                      uintptr_t bl33_entry,
 812                                                      uintptr_t fdt_addr);
 813
 814 /**
 815  * bl2_plat_get_bl31_params_v2() - return params for bl31
 816  * @bl32_entry: address of BL32 executable (secure)
 817  * @bl33_entry: address of BL33 executable (non secure)
 818  * @fdt_addr:   address of Flat Device Tree
 819  *
 820  * This function does the same as bl2_plat_get_bl31_params() except that is is
 821  * used for the new LOAD_IMAGE_V2 option, which uses a slightly different
 822  * method to pass the parameters.
 823  *
 824  * Return: bl31 params structure pointer
 825  */
 826 struct bl_params *bl2_plat_get_bl31_params_v2(uintptr_t bl32_entry,
 827                                               uintptr_t bl33_entry,
 828                                               uintptr_t fdt_addr);
 829
 830 /**
 831  * bl2_plat_get_bl31_params_v2_default() - prepare params for bl31.
 832  * @bl32_entry: address of BL32 executable (secure)
 833  * @bl33_entry: address of BL33 executable (non secure)
 834  * @fdt_addr:   address of Flat Device Tree
 835  *
 836  * This is the default implementation of bl2_plat_get_bl31_params_v2(). It
 837  * prepares the linked list of the bl31 params, populates the image types and
 838  * set the entry points for bl32 and bl33 (if available).
 839  *
 840  * NOTE: The memory is statically allocated, thus this function should be
 841  * called only once. All subsequent calls will overwrite any changes.
 842  *
 843  * Return: bl31 params structure pointer
 844  */
 845 struct bl_params *bl2_plat_get_bl31_params_v2_default(uintptr_t bl32_entry,
 846                                                       uintptr_t bl33_entry,
 847                                                       uintptr_t fdt_addr);
 848 /**
 849  * spl_optee_entry - entry function for optee
 850  *
 851  * args defind in op-tee project
 852  * https://github.com/OP-TEE/optee_os/
 853  * core/arch/arm/kernel/generic_entry_a32.S
 854  * @arg0: pagestore
 855  * @arg1: (ARMv7 standard bootarg #1)
 856  * @arg2: device tree address, (ARMv7 standard bootarg #2)
 857  * @arg3: non-secure entry address (ARMv7 bootarg #0)
 858  */
 859 void __noreturn spl_optee_entry(void *arg0, void *arg1, void *arg2, void *arg3);
 860
 861 /**
 862  * spl_invoke_opensbi - boot using a RISC-V OpenSBI image
 863  */
 864 void spl_invoke_opensbi(struct spl_image_info *spl_image);
 865
 866 /**
 867  * board_return_to_bootrom - allow for boards to continue with the boot ROM
 868  *
 869  * If a board (e.g. the Rockchip RK3368 boards) provide some
 870  * supporting functionality for SPL in their boot ROM and the SPL
 871  * stage wants to return to the ROM code to continue booting, boards
 872  * can implement 'board_return_to_bootrom'.
 873  */
 874 int board_return_to_bootrom(struct spl_image_info *spl_image,
 875                             struct spl_boot_device *bootdev);
 876
 877 /**
 878  * board_spl_fit_size_align - specific size align before processing payload
 879  *
 880  */
 881 ulong board_spl_fit_size_align(ulong size);
 882
 883 /**
 884  * spl_perform_fixups() - arch/board-specific callback before processing
 885  *                        the boot-payload
 886  */
 887 void spl_perform_fixups(struct spl_image_info *spl_image);
 888
 889 /*
 890  * spl_get_load_buffer() - get buffer for loading partial image data
 891  *
 892  * Returns memory area which can be populated by partial image data,
 893  * ie. uImage or fitImage header.
 894  */
 895 struct legacy_img_hdr *spl_get_load_buffer(ssize_t offset, size_t size);
 896
 897 void board_boot_order(u32 *spl_boot_list);
 898 void spl_save_restore_data(void);
 899 #endif