blob: ce4cf0abbebb6e599d7b8727afbf65fe80bfe348 [file] [log] [blame]
Tom Rini47f7bca2012-08-13 12:03:19 -07001/*
2 * (C) Copyright 2012
3 * Texas Instruments, <www.ti.com>
4 *
Wolfgang Denk1a459662013-07-08 09:37:19 +02005 * SPDX-License-Identifier: GPL-2.0+
Tom Rini47f7bca2012-08-13 12:03:19 -07006 */
7#ifndef _SPL_H_
8#define _SPL_H_
9
10/* Platform-specific defines */
Tom Rini6507f132012-08-22 15:31:05 -070011#include <linux/compiler.h>
Tom Rini47f7bca2012-08-13 12:03:19 -070012#include <asm/spl.h>
13
Simon Glass32ba8952015-05-13 07:02:24 -060014/* Value in r0 indicates we booted from U-Boot */
15#define UBOOT_NOT_LOADED_FROM_SPL 0x13578642
Dan Murphy773b5942014-01-16 11:23:29 -060016
Tom Rini47f7bca2012-08-13 12:03:19 -070017/* Boot type */
18#define MMCSD_MODE_UNDEFINED 0
19#define MMCSD_MODE_RAW 1
Guillaume GARDET205b4f32014-10-15 17:53:11 +020020#define MMCSD_MODE_FS 2
Tom Rini7dbe63b2014-02-05 10:24:18 -050021#define MMCSD_MODE_EMMCBOOT 3
Tom Rini47f7bca2012-08-13 12:03:19 -070022
23struct spl_image_info {
24 const char *name;
25 u8 os;
Andre Przywara11e14792017-01-02 11:48:31 +000026 ulong load_addr;
27 ulong entry_point;
Tom Rini47f7bca2012-08-13 12:03:19 -070028 u32 size;
Stefan Roese022b4972012-08-27 12:50:58 +020029 u32 flags;
Vikas Manocha5bf52502017-04-07 15:38:13 -070030 void *arg;
Tom Rini47f7bca2012-08-13 12:03:19 -070031};
32
Simon Glassf1dcee52016-02-22 22:55:56 -070033/*
34 * Information required to load data from a device
35 *
36 * @dev: Pointer to the device, e.g. struct mmc *
37 * @priv: Private data for the device
38 * @bl_len: Block length for reading in bytes
Lokesh Vutlaeafd5412016-05-24 10:34:38 +053039 * @filename: Name of the fit image file.
Simon Glassf1dcee52016-02-22 22:55:56 -070040 * @read: Function to call to read from the device
41 */
42struct spl_load_info {
43 void *dev;
44 void *priv;
45 int bl_len;
Lokesh Vutlaeafd5412016-05-24 10:34:38 +053046 const char *filename;
Simon Glassf1dcee52016-02-22 22:55:56 -070047 ulong (*read)(struct spl_load_info *load, ulong sector, ulong count,
48 void *buf);
49};
50
Lokesh Vutlaeafd5412016-05-24 10:34:38 +053051/**
52 * spl_load_simple_fit() - Loads a fit image from a device.
Simon Glassf4d7d852016-09-24 18:20:16 -060053 * @spl_image: Image description to set up
Lokesh Vutlaeafd5412016-05-24 10:34:38 +053054 * @info: Structure containing the information required to load data.
55 * @sector: Sector number where FIT image is located in the device
56 * @fdt: Pointer to the copied FIT header.
57 *
58 * Reads the FIT image @sector in the device. Loads u-boot image to
59 * specified load address and copies the dtb to end of u-boot image.
60 * Returns 0 on success.
61 */
Simon Glassf4d7d852016-09-24 18:20:16 -060062int spl_load_simple_fit(struct spl_image_info *spl_image,
63 struct spl_load_info *info, ulong sector, void *fdt);
Simon Glassf1dcee52016-02-22 22:55:56 -070064
Stefan Roese022b4972012-08-27 12:50:58 +020065#define SPL_COPY_PAYLOAD_ONLY 1
66
Tom Rini47f7bca2012-08-13 12:03:19 -070067/* SPL common functions */
68void preloader_console_init(void);
69u32 spl_boot_device(void);
Marek Vasut2b1cdaf2016-05-14 23:42:07 +020070u32 spl_boot_mode(const u32 boot_device);
Simon Glassd95ceb92016-09-24 18:19:52 -060071
72/**
73 * spl_set_header_raw_uboot() - Set up a standard SPL image structure
74 *
75 * This sets up the given spl_image which the standard values obtained from
76 * config options: CONFIG_SYS_MONITOR_LEN, CONFIG_SYS_UBOOT_START,
77 * CONFIG_SYS_TEXT_BASE.
78 *
Simon Glass71316c12016-09-24 18:19:53 -060079 * @spl_image: Image description to set up
Simon Glassd95ceb92016-09-24 18:19:52 -060080 */
81void spl_set_header_raw_uboot(struct spl_image_info *spl_image);
82
Simon Glass71316c12016-09-24 18:19:53 -060083/**
84 * spl_parse_image_header() - parse the image header and set up info
85 *
86 * This parses the legacy image header information at @header and sets up
87 * @spl_image according to what is found. If no image header is found, then
88 * a raw image or bootz is assumed. If CONFIG_SPL_PANIC_ON_RAW_IMAGE is
Andrew F. Davis24eb39b2017-02-16 11:18:38 -060089 * enabled, then this causes a panic. If CONFIG_SPL_RAW_IMAGE_SUPPORT is not
Simon Glass71316c12016-09-24 18:19:53 -060090 * enabled then U-Boot gives up. Otherwise U-Boot sets up the image using
91 * spl_set_header_raw_uboot(), or possibly the bootz header.
92 *
93 * @spl_image: Image description to set up
94 * @header image header to parse
95 * @return 0 if a header was correctly parsed, -ve on error
96 */
97int spl_parse_image_header(struct spl_image_info *spl_image,
98 const struct image_header *header);
99
Tom Rini47f7bca2012-08-13 12:03:19 -0700100void spl_board_prepare_for_linux(void);
Michal Simek3a3b9142016-05-10 07:54:20 +0200101void spl_board_prepare_for_boot(void);
Ladislav Michlbf55cd42016-07-12 20:28:13 +0200102int spl_board_ubi_load_image(u32 boot_device);
Simon Glassca12e652016-09-24 18:19:54 -0600103
104/**
105 * jump_to_image_linux() - Jump to a Linux kernel from SPL
106 *
107 * This jumps into a Linux kernel using the information in @spl_image.
108 *
109 * @spl_image: Image description to set up
Simon Glassca12e652016-09-24 18:19:54 -0600110 */
Vikas Manocha5bf52502017-04-07 15:38:13 -0700111void __noreturn jump_to_image_linux(struct spl_image_info *spl_image);
Simon Glassf59961e2016-09-24 18:19:55 -0600112
113/**
114 * spl_start_uboot() - Check if SPL should start the kernel or U-Boot
115 *
116 * This is called by the various SPL loaders to determine whether the board
117 * wants to load the kernel or U-Boot. This function should be provided by
118 * the board.
119 *
120 * @return 0 if SPL should start the kernel, 1 if U-Boot must be started
121 */
Tom Rini47f7bca2012-08-13 12:03:19 -0700122int spl_start_uboot(void);
Simon Glassf59961e2016-09-24 18:19:55 -0600123
Simon Glassa807ab32016-09-24 18:19:56 -0600124/**
125 * spl_display_print() - Display a board-specific message in SPL
126 *
127 * If CONFIG_SPL_DISPLAY_PRINT is enabled, U-Boot will call this function
128 * immediately after displaying the SPL console banner ("U-Boot SPL ...").
129 * This function should be provided by the board.
130 */
Tom Rini47f7bca2012-08-13 12:03:19 -0700131void spl_display_print(void);
132
Simon Glassecdfd692016-09-24 18:19:57 -0600133/**
134 * struct spl_boot_device - Describes a boot device used by SPL
135 *
136 * @boot_device: A number indicating the BOOT_DEVICE type. There are various
137 * BOOT_DEVICE... #defines and enums in U-Boot and they are not consistently
138 * numbered.
139 * @boot_device_name: Named boot device, or NULL if none.
140 *
141 * Note: Additional fields can be added here, bearing in mind that SPL is
142 * size-sensitive and common fields will be present on all boards. This
143 * struct can also be used to return additional information about the load
144 * process if that becomes useful.
145 */
146struct spl_boot_device {
147 uint boot_device;
148 const char *boot_device_name;
149};
150
Simon Glassa0a80292016-09-24 18:19:58 -0600151/**
152 * Holds information about a way of loading an SPL image
153 *
Simon Glassebc4ef62016-11-30 15:30:50 -0700154 * @name: User-friendly name for this method (e.g. "MMC")
Simon Glassa0a80292016-09-24 18:19:58 -0600155 * @boot_device: Boot device that this loader supports
156 * @load_image: Function to call to load image
157 */
158struct spl_image_loader {
Simon Glassebc4ef62016-11-30 15:30:50 -0700159#ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
160 const char *name;
161#endif
Simon Glassa0a80292016-09-24 18:19:58 -0600162 uint boot_device;
163 /**
164 * load_image() - Load an SPL image
165 *
Simon Glass2a2ee2a2016-09-24 18:20:13 -0600166 * @spl_image: place to put image information
Simon Glassa0a80292016-09-24 18:19:58 -0600167 * @bootdev: describes the boot device to load from
168 */
Simon Glass2a2ee2a2016-09-24 18:20:13 -0600169 int (*load_image)(struct spl_image_info *spl_image,
170 struct spl_boot_device *bootdev);
Simon Glassa0a80292016-09-24 18:19:58 -0600171};
172
173/* Declare an SPL image loader */
174#define SPL_LOAD_IMAGE(__name) \
175 ll_entry_declare(struct spl_image_loader, __name, spl_image_loader)
176
177/*
Simon Glass0d3b0592016-11-30 15:30:49 -0700178 * _priority is the priority of this method, 0 meaning it will be the top
Simon Glassa0a80292016-09-24 18:19:58 -0600179 * choice for this device, 9 meaning it is the bottom choice.
Simon Glass0d3b0592016-11-30 15:30:49 -0700180 * _boot_device is the BOOT_DEVICE_... value
181 * _method is the load_image function to call
Simon Glassa0a80292016-09-24 18:19:58 -0600182 */
Simon Glassebc4ef62016-11-30 15:30:50 -0700183#ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
184#define SPL_LOAD_IMAGE_METHOD(_name, _priority, _boot_device, _method) \
185 SPL_LOAD_IMAGE(_method ## _priority ## _boot_device) = { \
186 .name = _name, \
187 .boot_device = _boot_device, \
188 .load_image = _method, \
189 }
190#else
191#define SPL_LOAD_IMAGE_METHOD(_name, _priority, _boot_device, _method) \
Simon Glass0d3b0592016-11-30 15:30:49 -0700192 SPL_LOAD_IMAGE(_method ## _priority ## _boot_device) = { \
193 .boot_device = _boot_device, \
194 .load_image = _method, \
Simon Glassa0a80292016-09-24 18:19:58 -0600195 }
Simon Glassebc4ef62016-11-30 15:30:50 -0700196#endif
Simon Glassa0a80292016-09-24 18:19:58 -0600197
Dan Murphy773b5942014-01-16 11:23:29 -0600198/* SPL FAT image functions */
Simon Glass710e9ca2016-09-24 18:20:15 -0600199int spl_load_image_fat(struct spl_image_info *spl_image,
200 struct blk_desc *block_dev, int partition,
Simon Glass4101f682016-02-29 15:25:34 -0700201 const char *filename);
Simon Glass710e9ca2016-09-24 18:20:15 -0600202int spl_load_image_fat_os(struct spl_image_info *spl_image,
203 struct blk_desc *block_dev, int partition);
Dan Murphy773b5942014-01-16 11:23:29 -0600204
Jeroen Hofsteece048222014-10-08 22:58:07 +0200205void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image);
206
Guillaume GARDET592f9222014-10-15 17:53:12 +0200207/* SPL EXT image functions */
Simon Glassb4a6c2a2016-09-24 18:20:14 -0600208int spl_load_image_ext(struct spl_image_info *spl_image,
209 struct blk_desc *block_dev, int partition,
Simon Glass4101f682016-02-29 15:25:34 -0700210 const char *filename);
Simon Glassb4a6c2a2016-09-24 18:20:14 -0600211int spl_load_image_ext_os(struct spl_image_info *spl_image,
212 struct blk_desc *block_dev, int partition);
Guillaume GARDET592f9222014-10-15 17:53:12 +0200213
Simon Glass070d00b2015-06-23 15:39:10 -0600214/**
Eddie Cai340f4182017-03-15 08:43:28 -0600215 * spl_early_init() - Set up device tree and driver model in SPL if enabled
Simon Glass070d00b2015-06-23 15:39:10 -0600216 *
217 * Call this function in board_init_f() if you want to use device tree and
Eddie Cai340f4182017-03-15 08:43:28 -0600218 * driver model early, before board_init_r() is called.
219 *
220 * If this is not called, then driver model will be inactive in SPL's
221 * board_init_f(), and no device tree will be available.
222 */
223int spl_early_init(void);
224
225/**
226 * spl_init() - Set up device tree and driver model in SPL if enabled
227 *
228 * You can optionally call spl_early_init(), then optionally call spl_init().
229 * This function will be called from board_init_r() if not called earlier.
230 *
231 * Both spl_early_init() and spl_init() perform a similar function except that
232 * the latter will not set up the malloc() area if
233 * CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN is enabled, since it is assumed to
234 * already be done by a calll to spl_relocate_stack_gd() before board_init_r()
235 * is reached.
236 *
237 * This function will be called from board_init_r() if not called earlier.
Simon Glass070d00b2015-06-23 15:39:10 -0600238 *
239 * If this is not called, then driver model will be inactive in SPL's
240 * board_init_f(), and no device tree will be available.
241 */
242int spl_init(void);
243
Tom Rini47f7bca2012-08-13 12:03:19 -0700244#ifdef CONFIG_SPL_BOARD_INIT
245void spl_board_init(void);
246#endif
Simon Glass32ba8952015-05-13 07:02:24 -0600247
248/**
249 * spl_was_boot_source() - check if U-Boot booted from SPL
250 *
251 * This will normally be true, but if U-Boot jumps to second U-Boot, it will
252 * be false. This should be implemented by board-specific code.
253 *
254 * @return true if U-Boot booted from SPL, else false
255 */
256bool spl_was_boot_source(void);
257
B, Ravi52f2acc2016-07-28 17:39:16 +0530258/**
259 * spl_dfu_cmd- run dfu command with chosen mmc device interface
260 * @param usb_index - usb controller number
261 * @param mmc_dev - mmc device nubmer
262 *
263 * @return 0 on success, otherwise error code
264 */
265int spl_dfu_cmd(int usbctrl, char *dfu_alt_info, char *interface, char *devstr);
Simon Glasse50d76c2016-09-24 18:19:51 -0600266
Marek Vasut09410c62016-12-01 02:06:35 +0100267int spl_mmc_load_image(struct spl_image_info *spl_image,
268 struct spl_boot_device *bootdev);
269
Kever Yangbcc17262017-05-05 11:47:45 +0800270void bl31_entry(void);
Philipp Tomsich225d30b2017-06-22 23:38:36 +0200271
272/**
273 * board_return_to_bootrom - allow for boards to continue with the boot ROM
274 *
275 * If a board (e.g. the Rockchip RK3368 boards) provide some
276 * supporting functionality for SPL in their boot ROM and the SPL
277 * stage wants to return to the ROM code to continue booting, boards
278 * can implement 'board_return_to_bootrom'.
279 */
280void board_return_to_bootrom(void);
Tom Rini47f7bca2012-08-13 12:03:19 -0700281#endif