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