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