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