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