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