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 18struct blk_desc; 19struct 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 30struct blk_desc; 31struct 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 */ 45static 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 60enum u_boot_phase { 61 PHASE_TPL, /* Running in TPL */ 62 PHASE_SPL, /* Running in SPL */ 63 PHASE_BOARD_F, /* Running in U-Boot before relocation */ 64 PHASE_BOARD_R, /* Running in U-Boot after relocation */ 65}; 66 67/** 68 * spl_phase() - Find out the phase of U-Boot 69 * 70 * This can be used to avoid #ifdef logic and use if() instead. 71 * 72 * For example, to include code only in TPL, you might do: 73 * 74 * #ifdef CONFIG_TPL_BUILD 75 * ... 76 * #endif 77 * 78 * but with this you can use: 79 * 80 * if (spl_phase() == PHASE_TPL) { 81 * ... 82 * } 83 * 84 * To include code only in SPL, you might do: 85 * 86 * #if defined(CONFIG_SPL_BUILD) && !defined(CONFIG_TPL_BUILD) 87 * ... 88 * #endif 89 * 90 * but with this you can use: 91 * 92 * if (spl_phase() == PHASE_SPL) { 93 * ... 94 * } 95 * 96 * To include code only in U-Boot proper, you might do: 97 * 98 * #ifndef CONFIG_SPL_BUILD 99 * ... 100 * #endif 101 * 102 * but with this you can use: 103 * 104 * if (spl_phase() == PHASE_BOARD_F) { 105 * ... 106 * } 107 * 108 * @return U-Boot phase 109 */ 110static inline enum u_boot_phase spl_phase(void) 111{ 112#ifdef CONFIG_TPL_BUILD 113 return PHASE_TPL; 114#elif CONFIG_SPL_BUILD 115 return PHASE_SPL; 116#else 117 DECLARE_GLOBAL_DATA_PTR; 118 119 if (!(gd->flags & GD_FLG_RELOC)) 120 return PHASE_BOARD_F; 121 else 122 return PHASE_BOARD_R; 123#endif 124} 125 126/* A string name for SPL or TPL */ 127#ifdef CONFIG_SPL_BUILD 128# ifdef CONFIG_TPL_BUILD 129# define SPL_TPL_NAME "TPL" 130# else 131# define SPL_TPL_NAME "SPL" 132# endif 133# define SPL_TPL_PROMPT SPL_TPL_NAME ": " 134#else 135# define SPL_TPL_NAME "" 136# define SPL_TPL_PROMPT "" 137#endif 138 139struct spl_image_info { 140 const char *name; 141 u8 os; 142 uintptr_t load_addr; 143 uintptr_t entry_point; 144#if CONFIG_IS_ENABLED(LOAD_FIT) || CONFIG_IS_ENABLED(LOAD_FIT_FULL) 145 void *fdt_addr; 146#endif 147 u32 boot_device; 148 u32 size; 149 u32 flags; 150 void *arg; 151#ifdef CONFIG_SPL_LEGACY_IMAGE_CRC_CHECK 152 ulong dcrc_data; 153 ulong dcrc_length; 154 ulong dcrc; 155#endif 156}; 157 158/** 159 * Information required to load data from a device 160 * 161 * @dev: Pointer to the device, e.g. struct mmc * 162 * @priv: Private data for the device 163 * @bl_len: Block length for reading in bytes 164 * @filename: Name of the fit image file. 165 * @read: Function to call to read from the device 166 */ 167struct spl_load_info { 168 void *dev; 169 void *priv; 170 int bl_len; 171 const char *filename; 172 ulong (*read)(struct spl_load_info *load, ulong sector, ulong count, 173 void *buf); 174}; 175 176/* 177 * We need to know the position of U-Boot in memory so we can jump to it. We 178 * allow any U-Boot binary to be used (u-boot.bin, u-boot-nodtb.bin, 179 * u-boot.img), hence the '_any'. These is no checking here that the correct 180 * image is found. For example if u-boot.img is used we don't check that 181 * spl_parse_image_header() can parse a valid header. 182 * 183 * Similarly for SPL, so that TPL can jump to SPL. 184 */ 185binman_sym_extern(ulong, u_boot_any, image_pos); 186binman_sym_extern(ulong, u_boot_any, size); 187binman_sym_extern(ulong, spl, image_pos); 188binman_sym_extern(ulong, spl, size); 189 190/** 191 * spl_get_image_pos() - get the image position of the next phase 192 * 193 * This returns the image position to use to load the next phase of U-Boot 194 */ 195ulong spl_get_image_pos(void); 196 197/** 198 * spl_get_image_size() - get the size of the next phase 199 * 200 * This returns the size to use to load the next phase of U-Boot 201 */ 202ulong spl_get_image_size(void); 203 204/** 205 * spl_load_simple_fit_skip_processing() - Hook to allow skipping the FIT 206 * image processing during spl_load_simple_fit(). 207 * 208 * Return true to skip FIT processing, false to preserve the full code flow 209 * of spl_load_simple_fit(). 210 */ 211bool spl_load_simple_fit_skip_processing(void); 212 213/** 214 * spl_load_simple_fit() - Loads a fit image from a device. 215 * @spl_image: Image description to set up 216 * @info: Structure containing the information required to load data. 217 * @sector: Sector number where FIT image is located in the device 218 * @fdt: Pointer to the copied FIT header. 219 * 220 * Reads the FIT image @sector in the device. Loads u-boot image to 221 * specified load address and copies the dtb to end of u-boot image. 222 * Returns 0 on success. 223 */ 224int spl_load_simple_fit(struct spl_image_info *spl_image, 225 struct spl_load_info *info, ulong sector, void *fdt); 226 227#define SPL_COPY_PAYLOAD_ONLY 1 228#define SPL_FIT_FOUND 2 229 230/** 231 * spl_load_legacy_img() - Loads a legacy image from a device. 232 * @spl_image: Image description to set up 233 * @load: Structure containing the information required to load data. 234 * @header: Pointer to image header (including appended image) 235 * 236 * Reads an legacy image from the device. Loads u-boot image to 237 * specified load address. 238 * Returns 0 on success. 239 */ 240int spl_load_legacy_img(struct spl_image_info *spl_image, 241 struct spl_load_info *load, ulong header); 242 243/** 244 * spl_load_imx_container() - Loads a imx container image from a device. 245 * @spl_image: Image description to set up 246 * @info: Structure containing the information required to load data. 247 * @sector: Sector number where container image is located in the device 248 * 249 * Reads the container image @sector in the device. Loads u-boot image to 250 * specified load address. 251 */ 252int spl_load_imx_container(struct spl_image_info *spl_image, 253 struct spl_load_info *info, ulong sector); 254 255/* SPL common functions */ 256void preloader_console_init(void); 257u32 spl_boot_device(void); 258 259/** 260 * spl_mmc_boot_mode() - Lookup function for the mode of an MMC boot source. 261 * @boot_device: ID of the device which the MMC driver wants to read 262 * from. Common values are e.g. BOOT_DEVICE_MMC1, 263 * BOOT_DEVICE_MMC2, BOOT_DEVICE_MMC2_2. 264 * 265 * This function should return one of MMCSD_MODE_FS, MMCSD_MODE_EMMCBOOT, or 266 * MMCSD_MODE_RAW for each MMC boot source which is defined for the target. The 267 * boot_device parameter tells which device the MMC driver is interested in. 268 * 269 * If not overridden, it is weakly defined in common/spl/spl_mmc.c. 270 * 271 * Note: It is important to use the boot_device parameter instead of e.g. 272 * spl_boot_device() as U-Boot is not always loaded from the same device as SPL. 273 */ 274u32 spl_mmc_boot_mode(const u32 boot_device); 275 276/** 277 * spl_mmc_boot_partition() - MMC partition to load U-Boot from. 278 * @boot_device: ID of the device which the MMC driver wants to load 279 * U-Boot from. 280 * 281 * This function should return the partition number which the SPL 282 * should load U-Boot from (on the given boot_device) when 283 * CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_USE_PARTITION is set. 284 * 285 * If not overridden, it is weakly defined in common/spl/spl_mmc.c. 286 */ 287int spl_mmc_boot_partition(const u32 boot_device); 288void spl_set_bd(void); 289 290/** 291 * spl_set_header_raw_uboot() - Set up a standard SPL image structure 292 * 293 * This sets up the given spl_image which the standard values obtained from 294 * config options: CONFIG_SYS_MONITOR_LEN, CONFIG_SYS_UBOOT_START, 295 * CONFIG_SYS_TEXT_BASE. 296 * 297 * @spl_image: Image description to set up 298 */ 299void spl_set_header_raw_uboot(struct spl_image_info *spl_image); 300 301/** 302 * spl_parse_image_header() - parse the image header and set up info 303 * 304 * This parses the legacy image header information at @header and sets up 305 * @spl_image according to what is found. If no image header is found, then 306 * a raw image or bootz is assumed. If CONFIG_SPL_PANIC_ON_RAW_IMAGE is 307 * enabled, then this causes a panic. If CONFIG_SPL_RAW_IMAGE_SUPPORT is not 308 * enabled then U-Boot gives up. Otherwise U-Boot sets up the image using 309 * spl_set_header_raw_uboot(), or possibly the bootz header. 310 * 311 * @spl_image: Image description to set up 312 * @header image header to parse 313 * @return 0 if a header was correctly parsed, -ve on error 314 */ 315int spl_parse_image_header(struct spl_image_info *spl_image, 316 const struct image_header *header); 317 318void spl_board_prepare_for_linux(void); 319void spl_board_prepare_for_boot(void); 320int spl_board_ubi_load_image(u32 boot_device); 321int spl_board_boot_device(u32 boot_device); 322 323/** 324 * jump_to_image_linux() - Jump to a Linux kernel from SPL 325 * 326 * This jumps into a Linux kernel using the information in @spl_image. 327 * 328 * @spl_image: Image description to set up 329 */ 330void __noreturn jump_to_image_linux(struct spl_image_info *spl_image); 331 332/** 333 * spl_start_uboot() - Check if SPL should start the kernel or U-Boot 334 * 335 * This is called by the various SPL loaders to determine whether the board 336 * wants to load the kernel or U-Boot. This function should be provided by 337 * the board. 338 * 339 * @return 0 if SPL should start the kernel, 1 if U-Boot must be started 340 */ 341int spl_start_uboot(void); 342 343/** 344 * spl_display_print() - Display a board-specific message in SPL 345 * 346 * If CONFIG_SPL_DISPLAY_PRINT is enabled, U-Boot will call this function 347 * immediately after displaying the SPL console banner ("U-Boot SPL ..."). 348 * This function should be provided by the board. 349 */ 350void spl_display_print(void); 351 352/** 353 * struct spl_boot_device - Describes a boot device used by SPL 354 * 355 * @boot_device: A number indicating the BOOT_DEVICE type. There are various 356 * BOOT_DEVICE... #defines and enums in U-Boot and they are not consistently 357 * numbered. 358 * @boot_device_name: Named boot device, or NULL if none. 359 * 360 * Note: Additional fields can be added here, bearing in mind that SPL is 361 * size-sensitive and common fields will be present on all boards. This 362 * struct can also be used to return additional information about the load 363 * process if that becomes useful. 364 */ 365struct spl_boot_device { 366 uint boot_device; 367 const char *boot_device_name; 368}; 369 370/** 371 * Holds information about a way of loading an SPL image 372 * 373 * @name: User-friendly name for this method (e.g. "MMC") 374 * @boot_device: Boot device that this loader supports 375 * @load_image: Function to call to load image 376 */ 377struct spl_image_loader { 378#ifdef CONFIG_SPL_LIBCOMMON_SUPPORT 379 const char *name; 380#endif 381 uint boot_device; 382 /** 383 * load_image() - Load an SPL image 384 * 385 * @spl_image: place to put image information 386 * @bootdev: describes the boot device to load from 387 */ 388 int (*load_image)(struct spl_image_info *spl_image, 389 struct spl_boot_device *bootdev); 390}; 391 392/* Declare an SPL image loader */ 393#define SPL_LOAD_IMAGE(__name) \ 394 ll_entry_declare(struct spl_image_loader, __name, spl_image_loader) 395 396/* 397 * _priority is the priority of this method, 0 meaning it will be the top 398 * choice for this device, 9 meaning it is the bottom choice. 399 * _boot_device is the BOOT_DEVICE_... value 400 * _method is the load_image function to call 401 */ 402#ifdef CONFIG_SPL_LIBCOMMON_SUPPORT 403#define SPL_LOAD_IMAGE_METHOD(_name, _priority, _boot_device, _method) \ 404 SPL_LOAD_IMAGE(_boot_device ## _priority ## _method) = { \ 405 .name = _name, \ 406 .boot_device = _boot_device, \ 407 .load_image = _method, \ 408 } 409#else 410#define SPL_LOAD_IMAGE_METHOD(_name, _priority, _boot_device, _method) \ 411 SPL_LOAD_IMAGE(_boot_device ## _priority ## _method) = { \ 412 .boot_device = _boot_device, \ 413 .load_image = _method, \ 414 } 415#endif 416 417/* SPL FAT image functions */ 418int spl_load_image_fat(struct spl_image_info *spl_image, 419 struct blk_desc *block_dev, int partition, 420 const char *filename); 421int spl_load_image_fat_os(struct spl_image_info *spl_image, 422 struct blk_desc *block_dev, int partition); 423 424void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image); 425 426/* SPL EXT image functions */ 427int spl_load_image_ext(struct spl_image_info *spl_image, 428 struct blk_desc *block_dev, int partition, 429 const char *filename); 430int spl_load_image_ext_os(struct spl_image_info *spl_image, 431 struct blk_desc *block_dev, int partition); 432 433/** 434 * spl_early_init() - Set up device tree and driver model in SPL if enabled 435 * 436 * Call this function in board_init_f() if you want to use device tree and 437 * driver model early, before board_init_r() is called. 438 * 439 * If this is not called, then driver model will be inactive in SPL's 440 * board_init_f(), and no device tree will be available. 441 */ 442int spl_early_init(void); 443 444/** 445 * spl_init() - Set up device tree and driver model in SPL if enabled 446 * 447 * You can optionally call spl_early_init(), then optionally call spl_init(). 448 * This function will be called from board_init_r() if not called earlier. 449 * 450 * Both spl_early_init() and spl_init() perform a similar function except that 451 * the latter will not set up the malloc() area if 452 * CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN is enabled, since it is assumed to 453 * already be done by a calll to spl_relocate_stack_gd() before board_init_r() 454 * is reached. 455 * 456 * This function will be called from board_init_r() if not called earlier. 457 * 458 * If this is not called, then driver model will be inactive in SPL's 459 * board_init_f(), and no device tree will be available. 460 */ 461int spl_init(void); 462 463#ifdef CONFIG_SPL_BOARD_INIT 464void spl_board_init(void); 465#endif 466 467/** 468 * spl_was_boot_source() - check if U-Boot booted from SPL 469 * 470 * This will normally be true, but if U-Boot jumps to second U-Boot, it will 471 * be false. This should be implemented by board-specific code. 472 * 473 * @return true if U-Boot booted from SPL, else false 474 */ 475bool spl_was_boot_source(void); 476 477/** 478 * spl_dfu_cmd- run dfu command with chosen mmc device interface 479 * @param usb_index - usb controller number 480 * @param mmc_dev - mmc device nubmer 481 * 482 * @return 0 on success, otherwise error code 483 */ 484int spl_dfu_cmd(int usbctrl, char *dfu_alt_info, char *interface, char *devstr); 485 486int spl_mmc_load_image(struct spl_image_info *spl_image, 487 struct spl_boot_device *bootdev); 488 489/** 490 * spl_mmc_load() - Load an image file from MMC/SD media 491 * 492 * @param spl_image Image data filled in by loading process 493 * @param bootdev Describes which device to load from 494 * @param filename Name of file to load (in FS mode) 495 * @param raw_part Partition to load from (in RAW mode) 496 * @param raw_sect Sector to load from (in RAW mode) 497 * 498 * @return 0 on success, otherwise error code 499 */ 500int spl_mmc_load(struct spl_image_info *spl_image, 501 struct spl_boot_device *bootdev, 502 const char *filename, 503 int raw_part, 504 unsigned long raw_sect); 505 506/** 507 * spl_usb_load() - Load an image file from USB mass storage 508 * 509 * @param spl_image Image data filled in by loading process 510 * @param bootdev Describes which device to load from 511 * @param raw_part Fat partition to load from 512 * @param filename Name of file to load 513 * 514 * @return 0 on success, otherwise error code 515 */ 516int spl_usb_load(struct spl_image_info *spl_image, 517 struct spl_boot_device *bootdev, 518 int partition, const char *filename); 519 520int spl_ymodem_load_image(struct spl_image_info *spl_image, 521 struct spl_boot_device *bootdev); 522 523/** 524 * spl_invoke_atf - boot using an ARM trusted firmware image 525 */ 526void spl_invoke_atf(struct spl_image_info *spl_image); 527 528/** 529 * bl2_plat_get_bl31_params() - prepare params for bl31. 530 * @bl32_entry address of BL32 executable (secure) 531 * @bl33_entry address of BL33 executable (non secure) 532 * @fdt_addr address of Flat Device Tree 533 * 534 * This function assigns a pointer to the memory that the platform has kept 535 * aside to pass platform specific and trusted firmware related information 536 * to BL31. This memory is allocated by allocating memory to 537 * bl2_to_bl31_params_mem structure which is a superset of all the 538 * structure whose information is passed to BL31 539 * NOTE: This function should be called only once and should be done 540 * before generating params to BL31 541 * 542 * @return bl31 params structure pointer 543 */ 544struct bl31_params *bl2_plat_get_bl31_params(uintptr_t bl32_entry, 545 uintptr_t bl33_entry, 546 uintptr_t fdt_addr); 547 548/** 549 * spl_optee_entry - entry function for optee 550 * 551 * args defind in op-tee project 552 * https://github.com/OP-TEE/optee_os/ 553 * core/arch/arm/kernel/generic_entry_a32.S 554 * @arg0: pagestore 555 * @arg1: (ARMv7 standard bootarg #1) 556 * @arg2: device tree address, (ARMv7 standard bootarg #2) 557 * @arg3: non-secure entry address (ARMv7 bootarg #0) 558 */ 559void spl_optee_entry(void *arg0, void *arg1, void *arg2, void *arg3); 560 561/** 562 * spl_invoke_opensbi - boot using a RISC-V OpenSBI image 563 */ 564void spl_invoke_opensbi(struct spl_image_info *spl_image); 565 566/** 567 * board_return_to_bootrom - allow for boards to continue with the boot ROM 568 * 569 * If a board (e.g. the Rockchip RK3368 boards) provide some 570 * supporting functionality for SPL in their boot ROM and the SPL 571 * stage wants to return to the ROM code to continue booting, boards 572 * can implement 'board_return_to_bootrom'. 573 */ 574int board_return_to_bootrom(struct spl_image_info *spl_image, 575 struct spl_boot_device *bootdev); 576 577/** 578 * board_spl_fit_post_load - allow process images after loading finished 579 * 580 */ 581void board_spl_fit_post_load(ulong load_addr, size_t length); 582 583/** 584 * board_spl_fit_size_align - specific size align before processing payload 585 * 586 */ 587ulong board_spl_fit_size_align(ulong size); 588 589/** 590 * spl_perform_fixups() - arch/board-specific callback before processing 591 * the boot-payload 592 */ 593void spl_perform_fixups(struct spl_image_info *spl_image); 594 595/* 596 * spl_get_load_buffer() - get buffer for loading partial image data 597 * 598 * Returns memory area which can be populated by partial image data, 599 * ie. uImage or fitImage header. 600 */ 601struct image_header *spl_get_load_buffer(ssize_t offset, size_t size); 602 603void spl_save_restore_data(void); 604#endif 605