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