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