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