include/spl.h

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