xref: /openbmc/u-boot/include/spl.h (revision 9ecb0c41)
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  * @read: Function to call to read from the device
39  */
40 struct spl_load_info {
41 	void *dev;
42 	void *priv;
43 	int bl_len;
44 	ulong (*read)(struct spl_load_info *load, ulong sector, ulong count,
45 		      void *buf);
46 };
47 
48 int spl_load_simple_fit(struct spl_load_info *info, ulong sector, void *fdt);
49 
50 #define SPL_COPY_PAYLOAD_ONLY	1
51 
52 extern struct spl_image_info spl_image;
53 
54 /* SPL common functions */
55 void preloader_console_init(void);
56 u32 spl_boot_device(void);
57 u32 spl_boot_mode(void);
58 void spl_set_header_raw_uboot(void);
59 void spl_parse_image_header(const struct image_header *header);
60 void spl_board_prepare_for_linux(void);
61 void __noreturn jump_to_image_linux(void *arg);
62 int spl_start_uboot(void);
63 void spl_display_print(void);
64 
65 /* NAND SPL functions */
66 int spl_nand_load_image(void);
67 
68 /* OneNAND SPL functions */
69 int spl_onenand_load_image(void);
70 
71 /* NOR SPL functions */
72 int spl_nor_load_image(void);
73 
74 /* MMC SPL functions */
75 int spl_mmc_load_image(u32 boot_device);
76 
77 /* YMODEM SPL functions */
78 int spl_ymodem_load_image(void);
79 
80 /* SPI SPL functions */
81 int spl_spi_load_image(void);
82 
83 /* Ethernet SPL functions */
84 int spl_net_load_image(const char *device);
85 
86 /* USB SPL functions */
87 int spl_usb_load_image(void);
88 
89 /* SATA SPL functions */
90 int spl_sata_load_image(void);
91 
92 /* SPL FAT image functions */
93 int spl_load_image_fat(struct blk_desc *block_dev, int partition,
94 		       const char *filename);
95 int spl_load_image_fat_os(struct blk_desc *block_dev, int partition);
96 
97 void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image);
98 
99 /* SPL EXT image functions */
100 int spl_load_image_ext(struct blk_desc *block_dev, int partition,
101 		       const char *filename);
102 int spl_load_image_ext_os(struct blk_desc *block_dev, int partition);
103 
104 /**
105  * spl_init() - Set up device tree and driver model in SPL if enabled
106  *
107  * Call this function in board_init_f() if you want to use device tree and
108  * driver model early, before board_init_r() is called. This function will
109  * be called from board_init_r() if not called earlier.
110  *
111  * If this is not called, then driver model will be inactive in SPL's
112  * board_init_f(), and no device tree will be available.
113  */
114 int spl_init(void);
115 
116 #ifdef CONFIG_SPL_BOARD_INIT
117 void spl_board_init(void);
118 #endif
119 
120 /**
121  * spl_was_boot_source() - check if U-Boot booted from SPL
122  *
123  * This will normally be true, but if U-Boot jumps to second U-Boot, it will
124  * be false. This should be implemented by board-specific code.
125  *
126  * @return true if U-Boot booted from SPL, else false
127  */
128 bool spl_was_boot_source(void);
129 
130 #endif
131