dtoc: Add a way for tests to request the fallback library

[u-boot] / include / spl.h

diff --git a/include/spl.h b/include/spl.h
index 16f1ef449c1e5d4401f607b911070aa59d962c7d..e080a82b979dce663eadea7cca8126e7970c23b7 100644 (file)
--- a/include/spl.h
+++ b/include/spl.h
@@ -49,6 +49,7 @@ struct spl_load_info {
 
 /**
  * spl_load_simple_fit() - Loads a fit image from a device.
+ * @spl_image: Image description to set up
  * @info:      Structure containing the information required to load data.
  * @sector:    Sector number where FIT image is located in the device
  * @fdt:       Pointer to the copied FIT header.
@@ -57,12 +58,11 @@ struct spl_load_info {
  * specified load address and copies the dtb to end of u-boot image.
  * Returns 0 on success.
  */
-int spl_load_simple_fit(struct spl_load_info *info, ulong sector, void *fdt);
+int spl_load_simple_fit(struct spl_image_info *spl_image,
+                       struct spl_load_info *info, ulong sector, void *fdt);
 
 #define SPL_COPY_PAYLOAD_ONLY  1
 
-extern struct spl_image_info spl_image;
-
 /* SPL common functions */
 void preloader_console_init(void);
 u32 spl_boot_device(void);
@@ -122,49 +122,82 @@ void __noreturn jump_to_image_linux(struct spl_image_info *spl_image,
  */
 int spl_start_uboot(void);
 
+/**
+ * spl_display_print() - Display a board-specific message in SPL
+ *
+ * If CONFIG_SPL_DISPLAY_PRINT is enabled, U-Boot will call this function
+ * immediately after displaying the SPL console banner ("U-Boot SPL ...").
+ * This function should be provided by the board.
+ */
 void spl_display_print(void);
 
-/* NAND SPL functions */
-int spl_nand_load_image(void);
-
-/* OneNAND SPL functions */
-int spl_onenand_load_image(void);
-
-/* NOR SPL functions */
-int spl_nor_load_image(void);
-
-/* UBI SPL functions */
-int spl_ubi_load_image(u32 boot_device);
-
-/* MMC SPL functions */
-int spl_mmc_load_image(u32 boot_device);
-
-/* YMODEM SPL functions */
-int spl_ymodem_load_image(void);
-
-/* SPI SPL functions */
-int spl_spi_load_image(void);
+/**
+ * struct spl_boot_device - Describes a boot device used by SPL
+ *
+ * @boot_device: A number indicating the BOOT_DEVICE type. There are various
+ * BOOT_DEVICE... #defines and enums in U-Boot and they are not consistently
+ * numbered.
+ * @boot_device_name: Named boot device, or NULL if none.
+ *
+ * Note: Additional fields can be added here, bearing in mind that SPL is
+ * size-sensitive and common fields will be present on all boards. This
+ * struct can also be used to return additional information about the load
+ * process if that becomes useful.
+ */
+struct spl_boot_device {
+       uint boot_device;
+       const char *boot_device_name;
+};
 
-/* Ethernet SPL functions */
-int spl_net_load_image(const char *device);
+/**
+ * Holds information about a way of loading an SPL image
+ *
+ * @boot_device: Boot device that this loader supports
+ * @load_image: Function to call to load image
+ */
+struct spl_image_loader {
+       uint boot_device;
+       /**
+        * load_image() - Load an SPL image
+        *
+        * @spl_image: place to put image information
+        * @bootdev: describes the boot device to load from
+        */
+       int (*load_image)(struct spl_image_info *spl_image,
+                         struct spl_boot_device *bootdev);
+};
 
-/* USB SPL functions */
-int spl_usb_load_image(void);
+/* Declare an SPL image loader */
+#define SPL_LOAD_IMAGE(__name)                                 \
+       ll_entry_declare(struct spl_image_loader, __name, spl_image_loader)
 
-/* SATA SPL functions */
-int spl_sata_load_image(void);
+/*
+ * __priority is the priority of this method, 0 meaning it will be the top
+ * choice for this device, 9 meaning it is the bottom choice.
+ * __boot_device is the BOOT_DEVICE_... value
+ * __method is the load_image function to call
+ */
+#define SPL_LOAD_IMAGE_METHOD(__priority, __boot_device, __method) \
+       SPL_LOAD_IMAGE(__method ## __priority ## __boot_device) = { \
+               .boot_device = __boot_device, \
+               .load_image = __method, \
+       }
 
 /* SPL FAT image functions */
-int spl_load_image_fat(struct blk_desc *block_dev, int partition,
+int spl_load_image_fat(struct spl_image_info *spl_image,
+                      struct blk_desc *block_dev, int partition,
                       const char *filename);
-int spl_load_image_fat_os(struct blk_desc *block_dev, int partition);
+int spl_load_image_fat_os(struct spl_image_info *spl_image,
+                         struct blk_desc *block_dev, int partition);
 
 void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image);
 
 /* SPL EXT image functions */
-int spl_load_image_ext(struct blk_desc *block_dev, int partition,
+int spl_load_image_ext(struct spl_image_info *spl_image,
+                      struct blk_desc *block_dev, int partition,
                       const char *filename);
-int spl_load_image_ext_os(struct blk_desc *block_dev, int partition);
+int spl_load_image_ext_os(struct spl_image_info *spl_image,
+                         struct blk_desc *block_dev, int partition);
 
 /**
  * spl_init() - Set up device tree and driver model in SPL if enabled
@@ -201,12 +234,4 @@ bool spl_was_boot_source(void);
  */
 int spl_dfu_cmd(int usbctrl, char *dfu_alt_info, char *interface, char *devstr);
 
-/**
- * Board-specific load method for boards that have a special way of loading
- * U-Boot, which does not fit with the existing SPL code.
- *
- * @return 0 on success, negative errno value on failure.
- */
-int spl_board_load_image(void);
-
 #endif