xref: /openbmc/u-boot/include/spl.h (revision 7d301a59)
1 /*
2  * (C) Copyright 2012
3  * Texas Instruments, <www.ti.com>
4  *
5  * SPDX-License-Identifier:	GPL-2.0+
6  */
7 #ifndef	_SPL_H_
8 #define	_SPL_H_
9 
10 /* Platform-specific defines */
11 #include <linux/compiler.h>
12 #include <asm/spl.h>
13 
14 /* Value in r0 indicates we booted from U-Boot */
15 #define UBOOT_NOT_LOADED_FROM_SPL	0x13578642
16 
17 /* Boot type */
18 #define MMCSD_MODE_UNDEFINED	0
19 #define MMCSD_MODE_RAW		1
20 #define MMCSD_MODE_FS		2
21 #define MMCSD_MODE_EMMCBOOT	3
22 
23 struct spl_image_info {
24 	const char *name;
25 	u8 os;
26 	u32 load_addr;
27 	u32 entry_point;
28 	u32 size;
29 	u32 flags;
30 };
31 
32 /*
33  * Information required to load data from a device
34  *
35  * @dev: Pointer to the device, e.g. struct mmc *
36  * @priv: Private data for the device
37  * @bl_len: Block length for reading in bytes
38  * @filename: Name of the fit image file.
39  * @read: Function to call to read from the device
40  */
41 struct spl_load_info {
42 	void *dev;
43 	void *priv;
44 	int bl_len;
45 	const char *filename;
46 	ulong (*read)(struct spl_load_info *load, ulong sector, ulong count,
47 		      void *buf);
48 };
49 
50 /**
51  * spl_load_simple_fit() - Loads a fit image from a device.
52  * @info:	Structure containing the information required to load data.
53  * @sector:	Sector number where FIT image is located in the device
54  * @fdt:	Pointer to the copied FIT header.
55  *
56  * Reads the FIT image @sector in the device. Loads u-boot image to
57  * specified load address and copies the dtb to end of u-boot image.
58  * Returns 0 on success.
59  */
60 int spl_load_simple_fit(struct spl_load_info *info, ulong sector, void *fdt);
61 
62 #define SPL_COPY_PAYLOAD_ONLY	1
63 
64 extern struct spl_image_info spl_image;
65 
66 /* SPL common functions */
67 void preloader_console_init(void);
68 u32 spl_boot_device(void);
69 u32 spl_boot_mode(const u32 boot_device);
70 void spl_set_header_raw_uboot(void);
71 int spl_parse_image_header(const struct image_header *header);
72 void spl_board_prepare_for_linux(void);
73 void spl_board_prepare_for_boot(void);
74 int spl_board_ubi_load_image(u32 boot_device);
75 void __noreturn jump_to_image_linux(void *arg);
76 int spl_start_uboot(void);
77 void spl_display_print(void);
78 
79 /* NAND SPL functions */
80 int spl_nand_load_image(void);
81 
82 /* OneNAND SPL functions */
83 int spl_onenand_load_image(void);
84 
85 /* NOR SPL functions */
86 int spl_nor_load_image(void);
87 
88 /* UBI SPL functions */
89 int spl_ubi_load_image(u32 boot_device);
90 
91 /* MMC SPL functions */
92 int spl_mmc_load_image(u32 boot_device);
93 
94 /* YMODEM SPL functions */
95 int spl_ymodem_load_image(void);
96 
97 /* SPI SPL functions */
98 int spl_spi_load_image(void);
99 
100 /* Ethernet SPL functions */
101 int spl_net_load_image(const char *device);
102 
103 /* USB SPL functions */
104 int spl_usb_load_image(void);
105 
106 /* SATA SPL functions */
107 int spl_sata_load_image(void);
108 
109 /* SPL FAT image functions */
110 int spl_load_image_fat(struct blk_desc *block_dev, int partition,
111 		       const char *filename);
112 int spl_load_image_fat_os(struct blk_desc *block_dev, int partition);
113 
114 void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image);
115 
116 /* SPL EXT image functions */
117 int spl_load_image_ext(struct blk_desc *block_dev, int partition,
118 		       const char *filename);
119 int spl_load_image_ext_os(struct blk_desc *block_dev, int partition);
120 
121 /**
122  * spl_init() - Set up device tree and driver model in SPL if enabled
123  *
124  * Call this function in board_init_f() if you want to use device tree and
125  * driver model early, before board_init_r() is called. This function will
126  * be called from board_init_r() if not called earlier.
127  *
128  * If this is not called, then driver model will be inactive in SPL's
129  * board_init_f(), and no device tree will be available.
130  */
131 int spl_init(void);
132 
133 #ifdef CONFIG_SPL_BOARD_INIT
134 void spl_board_init(void);
135 #endif
136 
137 /**
138  * spl_was_boot_source() - check if U-Boot booted from SPL
139  *
140  * This will normally be true, but if U-Boot jumps to second U-Boot, it will
141  * be false. This should be implemented by board-specific code.
142  *
143  * @return true if U-Boot booted from SPL, else false
144  */
145 bool spl_was_boot_source(void);
146 
147 #endif
148