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