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 19struct blk_desc; 20struct 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 31struct blk_desc; 32struct legacy_img_hdr; 33struct spl_boot_device; 34enum 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 */ 48static 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 63enum 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 */ 117static 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 */ 136static 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 */ 151static 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 */ 173static 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 */ 189static 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 */ 212static 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 */ 251enum spl_sandbox_flags { 252 SPL_SANDBOXF_ARG_IS_FNAME = 0, 253 SPL_SANDBOXF_ARG_IS_BUF, 254}; 255 256struct 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 276static 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 * @priv: Private data for the device 289 * @bl_len: Block length for reading in bytes 290 * @read: Function to call to read from the device 291 */ 292struct spl_load_info { 293 void *priv; 294 /** 295 * read() - Read from device 296 * 297 * @load: Information about the load state 298 * @offset: Offset to read from in bytes. This must be a multiple of 299 * @load->bl_len. 300 * @count: Number of bytes to read. This must be a multiple of 301 * @load->bl_len. 302 * @buf: Buffer to read into 303 * @return number of bytes read, 0 on error 304 */ 305 ulong (*read)(struct spl_load_info *load, ulong sector, ulong count, 306 void *buf); 307#if IS_ENABLED(CONFIG_SPL_LOAD_BLOCK) 308 int bl_len; 309}; 310 311static inline int spl_get_bl_len(struct spl_load_info *info) 312{ 313 return info->bl_len; 314} 315 316static inline void spl_set_bl_len(struct spl_load_info *info, int bl_len) 317{ 318 info->bl_len = bl_len; 319} 320#else 321}; 322 323static inline int spl_get_bl_len(struct spl_load_info *info) 324{ 325 return 1; 326} 327 328static inline void spl_set_bl_len(struct spl_load_info *info, int bl_len) 329{ 330 if (bl_len != 1) 331 panic("CONFIG_SPL_LOAD_BLOCK not enabled"); 332} 333#endif 334 335/* 336 * We need to know the position of U-Boot in memory so we can jump to it. We 337 * allow any U-Boot binary to be used (u-boot.bin, u-boot-nodtb.bin, 338 * u-boot.img), hence the '_any'. These is no checking here that the correct 339 * image is found. For example if u-boot.img is used we don't check that 340 * spl_parse_image_header() can parse a valid header. 341 * 342 * Similarly for SPL, so that TPL can jump to SPL. 343 */ 344binman_sym_extern(ulong, u_boot_any, image_pos); 345binman_sym_extern(ulong, u_boot_any, size); 346binman_sym_extern(ulong, u_boot_spl_any, image_pos); 347binman_sym_extern(ulong, u_boot_spl_any, size); 348binman_sym_extern(ulong, u_boot_vpl_any, image_pos); 349binman_sym_extern(ulong, u_boot_vpl_any, size); 350 351/** 352 * spl_get_image_pos() - get the image position of the next phase 353 * 354 * This returns the image position to use to load the next phase of U-Boot 355 */ 356ulong spl_get_image_pos(void); 357 358/** 359 * spl_get_image_size() - get the size of the next phase 360 * 361 * This returns the size to use to load the next phase of U-Boot 362 */ 363ulong spl_get_image_size(void); 364 365/** 366 * spl_get_image_text_base() - get the text base of the next phase 367 * 368 * This returns the address that the next stage is linked to run at, i.e. 369 * CONFIG_SPL_TEXT_BASE or CONFIG_TEXT_BASE 370 * 371 * Return: text-base address 372 */ 373ulong spl_get_image_text_base(void); 374 375/** 376 * spl_load_simple_fit_skip_processing() - Hook to allow skipping the FIT 377 * image processing during spl_load_simple_fit(). 378 * 379 * Return true to skip FIT processing, false to preserve the full code flow 380 * of spl_load_simple_fit(). 381 */ 382bool spl_load_simple_fit_skip_processing(void); 383 384/** 385 * spl_load_simple_fit_fix_load() - Hook to make fixes 386 * after fit image header is loaded 387 * 388 * Returns pointer to fit 389 */ 390void *spl_load_simple_fit_fix_load(const void *fit); 391 392/** 393 * spl_load_simple_fit() - Loads a fit image from a device. 394 * @spl_image: Image description to set up 395 * @info: Structure containing the information required to load data. 396 * @offset: Offset where FIT image is located in the device. Must be aligned 397 * to the device's bl_len. 398 * @fdt: Pointer to the copied FIT header. 399 * 400 * Reads the FIT image @sector in the device. Loads u-boot image to 401 * specified load address and copies the dtb to end of u-boot image. 402 * Returns 0 on success. 403 */ 404int spl_load_simple_fit(struct spl_image_info *spl_image, 405 struct spl_load_info *info, ulong offset, void *fdt); 406 407#define SPL_COPY_PAYLOAD_ONLY 1 408#define SPL_FIT_FOUND 2 409 410/** 411 * spl_load_legacy_lzma() - Load an LZMA-compressed legacy image 412 * @spl_image: Image description (already set up) 413 * @load: Structure containing the information required to load data. 414 * @offset: Pointer to image 415 * 416 * Load/decompress an LZMA-compressed legacy image from the device. 417 * 418 * Return: 0 on success, or a negative error on failure 419 */ 420int spl_load_legacy_lzma(struct spl_image_info *spl_image, 421 struct spl_load_info *load, ulong offset); 422 423/** 424 * spl_load_legacy_img() - Loads a legacy image from a device. 425 * @spl_image: Image description to set up 426 * @load: Structure containing the information required to load data. 427 * @offset: Pointer to image 428 * @hdr: Pointer to image header 429 * 430 * Reads an legacy image from the device. Loads u-boot image to 431 * specified load address. 432 * Returns 0 on success. 433 */ 434int spl_load_legacy_img(struct spl_image_info *spl_image, 435 struct spl_boot_device *bootdev, 436 struct spl_load_info *load, ulong offset, 437 struct legacy_img_hdr *hdr); 438 439 440/** 441 * spl_load_imx_container() - Loads a imx container image from a device. 442 * @spl_image: Image description to set up 443 * @info: Structure containing the information required to load data. 444 * @sector: Offset where container image is located in the device. Must be 445 * aligned to the device block size. 446 * 447 * Reads the container image @sector in the device. Loads u-boot image to 448 * specified load address. 449 */ 450int spl_load_imx_container(struct spl_image_info *spl_image, 451 struct spl_load_info *info, ulong offset); 452 453/* SPL common functions */ 454void preloader_console_init(void); 455u32 spl_boot_device(void); 456 457struct spi_flash; 458 459/** 460 * spl_spi_get_uboot_offs() - Lookup function for the SPI boot offset 461 * @flash: The spi flash to boot from 462 * 463 * Return: The offset of U-Boot within the SPI flash 464 */ 465unsigned int spl_spi_get_uboot_offs(struct spi_flash *flash); 466 467/** 468 * spl_spi_boot_bus() - Lookup function for the SPI boot bus source. 469 * 470 * This function returns the SF bus to load from. 471 * If not overridden, it is weakly defined in common/spl/spl_spi.c. 472 */ 473u32 spl_spi_boot_bus(void); 474 475/** 476 * spl_spi_boot_cs() - Lookup function for the SPI boot CS source. 477 * 478 * This function returns the SF CS to load from. 479 * If not overridden, it is weakly defined in common/spl/spl_spi.c. 480 */ 481u32 spl_spi_boot_cs(void); 482 483/** 484 * spl_mmc_boot_mode() - Lookup function for the mode of an MMC boot source. 485 * @boot_device: ID of the device which the MMC driver wants to read 486 * from. Common values are e.g. BOOT_DEVICE_MMC1, 487 * BOOT_DEVICE_MMC2, BOOT_DEVICE_MMC2_2. 488 * 489 * This function should return one of MMCSD_MODE_FS, MMCSD_MODE_EMMCBOOT, or 490 * MMCSD_MODE_RAW for each MMC boot source which is defined for the target. The 491 * boot_device parameter tells which device the MMC driver is interested in. 492 * 493 * If not overridden, it is weakly defined in common/spl/spl_mmc.c. 494 * 495 * Note: It is important to use the boot_device parameter instead of e.g. 496 * spl_boot_device() as U-Boot is not always loaded from the same device as SPL. 497 */ 498u32 spl_mmc_boot_mode(struct mmc *mmc, const u32 boot_device); 499 500/** 501 * spl_mmc_boot_partition() - MMC partition to load U-Boot from. 502 * @boot_device: ID of the device which the MMC driver wants to load 503 * U-Boot from. 504 * 505 * This function should return the partition number which the SPL 506 * should load U-Boot from (on the given boot_device) when 507 * CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_USE_PARTITION is set. 508 * 509 * If not overridden, it is weakly defined in common/spl/spl_mmc.c. 510 */ 511int spl_mmc_boot_partition(const u32 boot_device); 512 513struct mmc; 514/** 515 * default_spl_mmc_emmc_boot_partition() - eMMC boot partition to load U-Boot from. 516 * mmc: Pointer for the mmc device structure 517 * 518 * This function should return the eMMC boot partition number which 519 * the SPL should load U-Boot from (on the given boot_device). 520 */ 521int default_spl_mmc_emmc_boot_partition(struct mmc *mmc); 522 523/** 524 * spl_mmc_emmc_boot_partition() - eMMC boot partition to load U-Boot from. 525 * mmc: Pointer for the mmc device structure 526 * 527 * This function should return the eMMC boot partition number which 528 * the SPL should load U-Boot from (on the given boot_device). 529 * 530 * If not overridden, it is weakly defined in common/spl/spl_mmc.c 531 * and calls default_spl_mmc_emmc_boot_partition(); 532 */ 533int spl_mmc_emmc_boot_partition(struct mmc *mmc); 534 535void spl_set_bd(void); 536 537/** 538 * spl_mmc_get_uboot_raw_sector() - Provide raw sector of the start of U-Boot (architecture override) 539 * 540 * This is a weak function which by default will provide the raw sector that is 541 * where the start of the U-Boot image has been written to. 542 * 543 * @mmc: struct mmc that describes the devie where U-Boot resides 544 * @raw_sect: The raw sector number where U-Boot is by default. 545 * Return: The raw sector location that U-Boot resides at 546 */ 547unsigned long arch_spl_mmc_get_uboot_raw_sector(struct mmc *mmc, 548 unsigned long raw_sect); 549 550/** 551 * spl_mmc_get_uboot_raw_sector() - Provide raw sector of the start of U-Boot (board override) 552 * 553 * This is a weak function which by default will provide the raw sector that is 554 * where the start of the U-Boot image has been written to. 555 * 556 * @mmc: struct mmc that describes the devie where U-Boot resides 557 * @raw_sect: The raw sector number where U-Boot is by default. 558 * Return: The raw sector location that U-Boot resides at 559 */ 560unsigned long board_spl_mmc_get_uboot_raw_sector(struct mmc *mmc, 561 unsigned long raw_sect); 562 563/** 564 * spl_mmc_get_uboot_raw_sector() - Provide raw sector of the start of U-Boot 565 * 566 * This is a weak function which by default will provide the raw sector that is 567 * where the start of the U-Boot image has been written to. 568 * 569 * @mmc: struct mmc that describes the devie where U-Boot resides 570 * @raw_sect: The raw sector number where U-Boot is by default. 571 * Return: The raw sector location that U-Boot resides at 572 */ 573unsigned long spl_mmc_get_uboot_raw_sector(struct mmc *mmc, 574 unsigned long raw_sect); 575 576/** 577 * spl_set_header_raw_uboot() - Set up a standard SPL image structure 578 * 579 * This sets up the given spl_image which the standard values obtained from 580 * config options: CONFIG_SYS_MONITOR_LEN, CONFIG_SYS_UBOOT_START, 581 * CONFIG_TEXT_BASE. 582 * 583 * @spl_image: Image description to set up 584 */ 585void spl_set_header_raw_uboot(struct spl_image_info *spl_image); 586 587/** 588 * spl_parse_image_header() - parse the image header and set up info 589 * 590 * This parses the legacy image header information at @header and sets up 591 * @spl_image according to what is found. If no image header is found, then 592 * a raw image or bootz is assumed. If CONFIG_SPL_PANIC_ON_RAW_IMAGE is 593 * enabled, then this causes a panic. If CONFIG_SPL_RAW_IMAGE_SUPPORT is not 594 * enabled then U-Boot gives up. Otherwise U-Boot sets up the image using 595 * spl_set_header_raw_uboot(), or possibly the bootz header. 596 * 597 * @spl_image: Image description to set up 598 * @header image header to parse 599 * Return: 0 if a header was correctly parsed, -ve on error 600 */ 601int spl_parse_image_header(struct spl_image_info *spl_image, 602 const struct spl_boot_device *bootdev, 603 const struct legacy_img_hdr *header); 604 605void spl_board_prepare_for_linux(void); 606 607/** 608 * spl_board_prepare_for_optee() - Prepare board for an OPTEE payload 609 * 610 * Prepares the board for booting an OP-TEE payload. Initialization is platform 611 * specific, and may include configuring the TrustZone memory, and other 612 * initialization steps required by OP-TEE. 613 * Note that @fdt is not used directly by OP-TEE. OP-TEE passes this @fdt to 614 * its normal world target. This target is not guaranteed to be u-boot, so @fdt 615 * changes that would normally be done by u-boot should be done in this step. 616 * 617 * @fdt: Devicetree that will be passed on, or NULL 618 */ 619void spl_board_prepare_for_optee(void *fdt); 620void spl_board_prepare_for_boot(void); 621int spl_board_ubi_load_image(u32 boot_device); 622int spl_board_boot_device(enum boot_device boot_dev_spl); 623 624/** 625 * spl_board_loader_name() - Return a name for the loader 626 * 627 * This is a weak function which might be overridden by the board code. With 628 * that a board specific value for the device where the U-Boot will be loaded 629 * from can be set. By default it returns NULL. 630 * 631 * @boot_device: ID of the device which SPL wants to load U-Boot from. 632 */ 633const char *spl_board_loader_name(u32 boot_device); 634 635/** 636 * jump_to_image_linux() - Jump to a Linux kernel from SPL 637 * 638 * This jumps into a Linux kernel using the information in @spl_image. 639 * 640 * @spl_image: Image description to set up 641 */ 642void __noreturn jump_to_image_linux(struct spl_image_info *spl_image); 643 644/** 645 * jump_to_image_optee() - Jump to OP-TEE OS from SPL 646 * 647 * This jumps into OP-TEE OS using the information in @spl_image. 648 * 649 * @spl_image: Image description to set up 650 */ 651void __noreturn jump_to_image_optee(struct spl_image_info *spl_image); 652 653/** 654 * spl_start_uboot() - Check if SPL should start the kernel or U-Boot 655 * 656 * This is called by the various SPL loaders to determine whether the board 657 * wants to load the kernel or U-Boot. This function should be provided by 658 * the board. 659 * 660 * Return: 0 if SPL should start the kernel, 1 if U-Boot must be started 661 */ 662int spl_start_uboot(void); 663 664/** 665 * spl_display_print() - Display a board-specific message in SPL 666 * 667 * If CONFIG_SPL_DISPLAY_PRINT is enabled, U-Boot will call this function 668 * immediately after displaying the SPL console banner ("U-Boot SPL ..."). 669 * This function should be provided by the board. 670 */ 671void spl_display_print(void); 672 673/** 674 * struct spl_boot_device - Describes a boot device used by SPL 675 * 676 * @boot_device: A number indicating the BOOT_DEVICE type. There are various 677 * BOOT_DEVICE... #defines and enums in U-Boot and they are not consistently 678 * numbered. 679 * @boot_device_name: Named boot device, or NULL if none. 680 * 681 * Note: Additional fields can be added here, bearing in mind that SPL is 682 * size-sensitive and common fields will be present on all boards. This 683 * struct can also be used to return additional information about the load 684 * process if that becomes useful. 685 */ 686struct spl_boot_device { 687 uint boot_device; 688 const char *boot_device_name; 689}; 690 691/** 692 * Holds information about a way of loading an SPL image 693 * 694 * @name: User-friendly name for this method (e.g. "MMC") 695 * @boot_device: Boot device that this loader supports 696 * @load_image: Function to call to load image 697 */ 698struct spl_image_loader { 699#ifdef CONFIG_SPL_LIBCOMMON_SUPPORT 700 const char *name; 701#endif 702 uint boot_device; 703 /** 704 * load_image() - Load an SPL image 705 * 706 * @spl_image: place to put image information 707 * @bootdev: describes the boot device to load from 708 */ 709 int (*load_image)(struct spl_image_info *spl_image, 710 struct spl_boot_device *bootdev); 711}; 712 713/* Helper function for accessing the name */ 714static inline const char *spl_loader_name(const struct spl_image_loader *loader) 715{ 716#ifdef CONFIG_SPL_LIBCOMMON_SUPPORT 717 const char *name; 718 name = spl_board_loader_name(loader->boot_device); 719 return name ?: loader->name; 720#else 721 return NULL; 722#endif 723} 724 725/* Declare an SPL image loader */ 726#define SPL_LOAD_IMAGE(__name) \ 727 ll_entry_declare(struct spl_image_loader, __name, spl_image_loader) 728 729/* 730 * _priority is the priority of this method, 0 meaning it will be the top 731 * choice for this device, 9 meaning it is the bottom choice. 732 * _boot_device is the BOOT_DEVICE_... value 733 * _method is the load_image function to call 734 */ 735#ifdef CONFIG_SPL_LIBCOMMON_SUPPORT 736#define SPL_LOAD_IMAGE_METHOD(_name, _priority, _boot_device, _method) \ 737 SPL_LOAD_IMAGE(_boot_device ## _priority ## _method) = { \ 738 .name = _name, \ 739 .boot_device = _boot_device, \ 740 .load_image = _method, \ 741 } 742#else 743#define SPL_LOAD_IMAGE_METHOD(_name, _priority, _boot_device, _method) \ 744 SPL_LOAD_IMAGE(_boot_device ## _priority ## _method) = { \ 745 .boot_device = _boot_device, \ 746 .load_image = _method, \ 747 } 748#endif 749 750#define SPL_LOAD_IMAGE_GET(_priority, _boot_device, _method) \ 751 ll_entry_get(struct spl_image_loader, \ 752 _boot_device ## _priority ## _method, spl_image_loader) 753 754/* SPL FAT image functions */ 755 756/** 757 * spl_fat_force_reregister() - Force reregistration of FAT block devices 758 * 759 * To avoid repeatedly looking up block devices, spl_load_image_fat keeps track 760 * of whether it has already registered a block device. This is fine for most 761 * cases, but when running unit tests all devices are removed and recreated 762 * in-between tests. This function will force re-registration of any block 763 * devices, ensuring that we don't try to use an invalid block device. 764 */ 765void spl_fat_force_reregister(void); 766 767int spl_load_image_fat(struct spl_image_info *spl_image, 768 struct spl_boot_device *bootdev, 769 struct blk_desc *block_dev, int partition, 770 const char *filename); 771int spl_load_image_fat_os(struct spl_image_info *spl_image, 772 struct spl_boot_device *bootdev, 773 struct blk_desc *block_dev, int partition); 774 775void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image); 776 777/* SPL EXT image functions */ 778int spl_load_image_ext(struct spl_image_info *spl_image, 779 struct spl_boot_device *bootdev, 780 struct blk_desc *block_dev, int partition, 781 const char *filename); 782int spl_load_image_ext_os(struct spl_image_info *spl_image, 783 struct spl_boot_device *bootdev, 784 struct blk_desc *block_dev, int partition); 785int spl_blk_load_image(struct spl_image_info *spl_image, 786 struct spl_boot_device *bootdev, 787 enum uclass_id uclass_id, int devnum, int partnum); 788 789/** 790 * spl_early_init() - Set up device tree and driver model in SPL if enabled 791 * 792 * Call this function in board_init_f() if you want to use device tree and 793 * driver model early, before board_init_r() is called. 794 * 795 * If this is not called, then driver model will be inactive in SPL's 796 * board_init_f(), and no device tree will be available. 797 */ 798int spl_early_init(void); 799 800/** 801 * spl_init() - Set up device tree and driver model in SPL if enabled 802 * 803 * You can optionally call spl_early_init(), then optionally call spl_init(). 804 * This function will be called from board_init_r() if not called earlier. 805 * 806 * Both spl_early_init() and spl_init() perform a similar function except that 807 * the latter will not set up the malloc() area if 808 * CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN is enabled, since it is assumed to 809 * already be done by a calll to spl_relocate_stack_gd() before board_init_r() 810 * is reached. 811 * 812 * This function will be called from board_init_r() if not called earlier. 813 * 814 * If this is not called, then driver model will be inactive in SPL's 815 * board_init_f(), and no device tree will be available. 816 */ 817int spl_init(void); 818 819/* 820 * spl_board_init() - Do board-specific init in SPL 821 * 822 * If xPL_BOARD_INIT is enabled, this is called from board_init_r() before 823 * jumping to the next phase. 824 */ 825void spl_board_init(void); 826 827/** 828 * spl_was_boot_source() - check if U-Boot booted from SPL 829 * 830 * This will normally be true, but if U-Boot jumps to second U-Boot, it will 831 * be false. This should be implemented by board-specific code. 832 * 833 * Return: true if U-Boot booted from SPL, else false 834 */ 835bool spl_was_boot_source(void); 836 837/** 838 * spl_dfu_cmd- run dfu command with chosen mmc device interface 839 * @param usb_index - usb controller number 840 * @param mmc_dev - mmc device nubmer 841 * 842 * Return: 0 on success, otherwise error code 843 */ 844int spl_dfu_cmd(int usbctrl, char *dfu_alt_info, char *interface, char *devstr); 845 846/** 847 * spl_mmc_clear_cache() - Clear cached MMC devices 848 * 849 * To avoid reinitializing MMCs, spl_mmc_load caches the most-recently-used MMC 850 * device. This is fine for most cases, but when running unit tests all devices 851 * are removed and recreated in-between tests. This function will clear any 852 * cached state, ensuring that we don't try to use an invalid MMC. 853 */ 854void spl_mmc_clear_cache(void); 855 856int spl_mmc_load_image(struct spl_image_info *spl_image, 857 struct spl_boot_device *bootdev); 858 859/** 860 * spl_mmc_load() - Load an image file from MMC/SD media 861 * 862 * @param spl_image Image data filled in by loading process 863 * @param bootdev Describes which device to load from 864 * @param filename Name of file to load (in FS mode) 865 * @param raw_part Partition to load from (in RAW mode) 866 * @param raw_sect Sector to load from (in RAW mode) 867 * 868 * Return: 0 on success, otherwise error code 869 */ 870int spl_mmc_load(struct spl_image_info *spl_image, 871 struct spl_boot_device *bootdev, 872 const char *filename, 873 int raw_part, 874 unsigned long raw_sect); 875 876/** 877 * spl_usb_load() - Load an image file from USB mass storage 878 * 879 * @param spl_image Image data filled in by loading process 880 * @param bootdev Describes which device to load from 881 * @param raw_part Fat partition to load from 882 * @param filename Name of file to load 883 * 884 * Return: 0 on success, otherwise error code 885 */ 886int spl_usb_load(struct spl_image_info *spl_image, 887 struct spl_boot_device *bootdev, 888 int partition, const char *filename); 889 890int spl_ymodem_load_image(struct spl_image_info *spl_image, 891 struct spl_boot_device *bootdev); 892/** 893 * spl_reserve_video_from_ram_top() - Reserve framebuffer memory from end of RAM 894 * 895 * This enforces framebuffer reservation at SPL stage from end of RAM so that 896 * next stage can directly skip this pre-reserved area before carrying out 897 * further reservations. The allocation address is stored in struct video_uc_plat. 898 * 899 * Return: 0 on success, otherwise error code 900 */ 901int spl_reserve_video_from_ram_top(void); 902 903/** 904 * spl_invoke_atf - boot using an ARM trusted firmware image 905 */ 906void __noreturn spl_invoke_atf(struct spl_image_info *spl_image); 907 908/** 909 * bl2_plat_get_bl31_params() - return params for bl31. 910 * @bl32_entry: address of BL32 executable (secure) 911 * @bl33_entry: address of BL33 executable (non secure) 912 * @fdt_addr: address of Flat Device Tree 913 * 914 * This is a weak function which might be overridden by the board code. By 915 * default it will just call bl2_plat_get_bl31_params_default(). 916 * 917 * If you just want to manipulate or add some parameters, you can override 918 * this function, call bl2_plat_get_bl31_params_default and operate on the 919 * returned bl31 params. 920 * 921 * Return: bl31 params structure pointer 922 */ 923struct bl31_params *bl2_plat_get_bl31_params(uintptr_t bl32_entry, 924 uintptr_t bl33_entry, 925 uintptr_t fdt_addr); 926 927/** 928 * bl2_plat_get_bl31_params_default() - prepare params for bl31. 929 * @bl32_entry: address of BL32 executable (secure) 930 * @bl33_entry: address of BL33 executable (non secure) 931 * @fdt_addr: address of Flat Device Tree 932 * 933 * This is the default implementation of bl2_plat_get_bl31_params(). It assigns 934 * a pointer to the memory that the platform has kept aside to pass platform 935 * specific and trusted firmware related information to BL31. This memory is 936 * allocated by allocating memory to bl2_to_bl31_params_mem structure which is 937 * a superset of all the structure whose information is passed to BL31 938 * 939 * NOTE: The memory is statically allocated, thus this function should be 940 * called only once. All subsequent calls will overwrite any changes. 941 * 942 * Return: bl31 params structure pointer 943 */ 944struct bl31_params *bl2_plat_get_bl31_params_default(uintptr_t bl32_entry, 945 uintptr_t bl33_entry, 946 uintptr_t fdt_addr); 947 948/** 949 * bl2_plat_get_bl31_params_v2() - return params for bl31 950 * @bl32_entry: address of BL32 executable (secure) 951 * @bl33_entry: address of BL33 executable (non secure) 952 * @fdt_addr: address of Flat Device Tree 953 * 954 * This function does the same as bl2_plat_get_bl31_params() except that is is 955 * used for the new LOAD_IMAGE_V2 option, which uses a slightly different 956 * method to pass the parameters. 957 * 958 * Return: bl31 params structure pointer 959 */ 960struct bl_params *bl2_plat_get_bl31_params_v2(uintptr_t bl32_entry, 961 uintptr_t bl33_entry, 962 uintptr_t fdt_addr); 963 964/** 965 * bl2_plat_get_bl31_params_v2_default() - prepare params for bl31. 966 * @bl32_entry: address of BL32 executable (secure) 967 * @bl33_entry: address of BL33 executable (non secure) 968 * @fdt_addr: address of Flat Device Tree 969 * 970 * This is the default implementation of bl2_plat_get_bl31_params_v2(). It 971 * prepares the linked list of the bl31 params, populates the image types and 972 * set the entry points for bl32 and bl33 (if available). 973 * 974 * NOTE: The memory is statically allocated, thus this function should be 975 * called only once. All subsequent calls will overwrite any changes. 976 * 977 * Return: bl31 params structure pointer 978 */ 979struct bl_params *bl2_plat_get_bl31_params_v2_default(uintptr_t bl32_entry, 980 uintptr_t bl33_entry, 981 uintptr_t fdt_addr); 982/** 983 * spl_optee_entry - entry function for optee 984 * 985 * args defind in op-tee project 986 * https://github.com/OP-TEE/optee_os/ 987 * core/arch/arm/kernel/generic_entry_a32.S 988 * @arg0: pagestore 989 * @arg1: (ARMv7 standard bootarg #1) 990 * @arg2: device tree address, (ARMv7 standard bootarg #2) 991 * @arg3: non-secure entry address (ARMv7 bootarg #0) 992 */ 993void __noreturn spl_optee_entry(void *arg0, void *arg1, void *arg2, void *arg3); 994 995/** 996 * spl_invoke_opensbi - boot using a RISC-V OpenSBI image 997 */ 998void __noreturn spl_invoke_opensbi(struct spl_image_info *spl_image); 999 1000/** 1001 * board_return_to_bootrom - allow for boards to continue with the boot ROM 1002 * 1003 * If a board (e.g. the Rockchip RK3368 boards) provide some 1004 * supporting functionality for SPL in their boot ROM and the SPL 1005 * stage wants to return to the ROM code to continue booting, boards 1006 * can implement 'board_return_to_bootrom'. 1007 */ 1008int board_return_to_bootrom(struct spl_image_info *spl_image, 1009 struct spl_boot_device *bootdev); 1010 1011/** 1012 * board_spl_fit_size_align - specific size align before processing payload 1013 * 1014 */ 1015ulong board_spl_fit_size_align(ulong size); 1016 1017/** 1018 * spl_perform_fixups() - arch/board-specific callback before processing 1019 * the boot-payload 1020 */ 1021void spl_perform_fixups(struct spl_image_info *spl_image); 1022 1023/* 1024 * spl_get_load_buffer() - get buffer for loading partial image data 1025 * 1026 * Returns memory area which can be populated by partial image data, 1027 * ie. uImage or fitImage header. 1028 */ 1029struct legacy_img_hdr *spl_get_load_buffer(ssize_t offset, size_t size); 1030 1031/** 1032 * board_spl_fit_append_fdt_skip(): test whether DTO application should be skipped 1033 * @name: DTO node name within fitImage images node 1034 * 1035 * A board-specific function used to indicate whether a DTO from fitImage 1036 * configuration node 'fdt' property DT and DTO list should be applied onto 1037 * the base DT or not applied. 1038 * 1039 * This is useful in case of DTOs which implement e.g. different board revision 1040 * details, where such DTO should be applied on one board revision, and should 1041 * not be applied on another board revision. 1042 * 1043 * Return: 0 to indicate DTO is not skipped, all else to indicate DTO is skipped. 1044 */ 1045int board_spl_fit_append_fdt_skip(const char *name); 1046 1047void board_boot_order(u32 *spl_boot_list); 1048void spl_save_restore_data(void); 1049 1050/** 1051 * spl_load_fit_image() - Fully parse and a FIT image in SPL 1052 * 1053 * @spl_image: SPL Image data to fill in 1054 * @header: Pointer to FIT image 1055 * Return 0 if OK, -ve on error 1056 */ 1057int spl_load_fit_image(struct spl_image_info *spl_image, 1058 const struct legacy_img_hdr *header); 1059 1060/* 1061 * spl_decompression_enabled() - check decompression support is enabled for SPL build 1062 * 1063 * Returns true if decompression support is enabled, else False 1064 */ 1065static inline bool spl_decompression_enabled(void) 1066{ 1067 return IS_ENABLED(CONFIG_SPL_GZIP) || IS_ENABLED(CONFIG_SPL_LZMA); 1068} 1069#endif 1070