blob: 308ce7b563bf94ad11e4e4dcc3b1752d063a8dd6 [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;
Philipp Tomsichf2efe672017-09-13 21:29:31 +020026 uintptr_t load_addr;
27 uintptr_t entry_point;
Philipp Tomsich75014472017-09-13 21:29:30 +020028#if CONFIG_IS_ENABLED(LOAD_FIT)
29 void *fdt_addr;
30#endif
Tom Rini47f7bca2012-08-13 12:03:19 -070031 u32 size;
Stefan Roese022b4972012-08-27 12:50:58 +020032 u32 flags;
Vikas Manocha5bf52502017-04-07 15:38:13 -070033 void *arg;
Tom Rini47f7bca2012-08-13 12:03:19 -070034};
35
Simon Glassf1dcee52016-02-22 22:55:56 -070036/*
37 * Information required to load data from a device
38 *
39 * @dev: Pointer to the device, e.g. struct mmc *
40 * @priv: Private data for the device
41 * @bl_len: Block length for reading in bytes
Lokesh Vutlaeafd5412016-05-24 10:34:38 +053042 * @filename: Name of the fit image file.
Simon Glassf1dcee52016-02-22 22:55:56 -070043 * @read: Function to call to read from the device
44 */
45struct spl_load_info {
46 void *dev;
47 void *priv;
48 int bl_len;
Lokesh Vutlaeafd5412016-05-24 10:34:38 +053049 const char *filename;
Simon Glassf1dcee52016-02-22 22:55:56 -070050 ulong (*read)(struct spl_load_info *load, ulong sector, ulong count,
51 void *buf);
52};
53
Lokesh Vutlaeafd5412016-05-24 10:34:38 +053054/**
55 * spl_load_simple_fit() - Loads a fit image from a device.
Simon Glassf4d7d852016-09-24 18:20:16 -060056 * @spl_image: Image description to set up
Lokesh Vutlaeafd5412016-05-24 10:34:38 +053057 * @info: Structure containing the information required to load data.
58 * @sector: Sector number where FIT image is located in the device
59 * @fdt: Pointer to the copied FIT header.
60 *
61 * Reads the FIT image @sector in the device. Loads u-boot image to
62 * specified load address and copies the dtb to end of u-boot image.
63 * Returns 0 on success.
64 */
Simon Glassf4d7d852016-09-24 18:20:16 -060065int spl_load_simple_fit(struct spl_image_info *spl_image,
66 struct spl_load_info *info, ulong sector, void *fdt);
Simon Glassf1dcee52016-02-22 22:55:56 -070067
Stefan Roese022b4972012-08-27 12:50:58 +020068#define SPL_COPY_PAYLOAD_ONLY 1
69
Tom Rini47f7bca2012-08-13 12:03:19 -070070/* SPL common functions */
71void preloader_console_init(void);
72u32 spl_boot_device(void);
Marek Vasut2b1cdaf2016-05-14 23:42:07 +020073u32 spl_boot_mode(const u32 boot_device);
York Sund1fc0a32017-09-28 08:42:10 -070074void spl_set_bd(void);
Simon Glassd95ceb92016-09-24 18:19:52 -060075
76/**
77 * spl_set_header_raw_uboot() - Set up a standard SPL image structure
78 *
79 * This sets up the given spl_image which the standard values obtained from
80 * config options: CONFIG_SYS_MONITOR_LEN, CONFIG_SYS_UBOOT_START,
81 * CONFIG_SYS_TEXT_BASE.
82 *
Simon Glass71316c12016-09-24 18:19:53 -060083 * @spl_image: Image description to set up
Simon Glassd95ceb92016-09-24 18:19:52 -060084 */
85void spl_set_header_raw_uboot(struct spl_image_info *spl_image);
86
Simon Glass71316c12016-09-24 18:19:53 -060087/**
88 * spl_parse_image_header() - parse the image header and set up info
89 *
90 * This parses the legacy image header information at @header and sets up
91 * @spl_image according to what is found. If no image header is found, then
92 * a raw image or bootz is assumed. If CONFIG_SPL_PANIC_ON_RAW_IMAGE is
Andrew F. Davis24eb39b2017-02-16 11:18:38 -060093 * enabled, then this causes a panic. If CONFIG_SPL_RAW_IMAGE_SUPPORT is not
Simon Glass71316c12016-09-24 18:19:53 -060094 * enabled then U-Boot gives up. Otherwise U-Boot sets up the image using
95 * spl_set_header_raw_uboot(), or possibly the bootz header.
96 *
97 * @spl_image: Image description to set up
98 * @header image header to parse
99 * @return 0 if a header was correctly parsed, -ve on error
100 */
101int spl_parse_image_header(struct spl_image_info *spl_image,
102 const struct image_header *header);
103
Tom Rini47f7bca2012-08-13 12:03:19 -0700104void spl_board_prepare_for_linux(void);
Michal Simek3a3b9142016-05-10 07:54:20 +0200105void spl_board_prepare_for_boot(void);
Ladislav Michlbf55cd42016-07-12 20:28:13 +0200106int spl_board_ubi_load_image(u32 boot_device);
Simon Glassca12e652016-09-24 18:19:54 -0600107
108/**
109 * jump_to_image_linux() - Jump to a Linux kernel from SPL
110 *
111 * This jumps into a Linux kernel using the information in @spl_image.
112 *
113 * @spl_image: Image description to set up
Simon Glassca12e652016-09-24 18:19:54 -0600114 */
Vikas Manocha5bf52502017-04-07 15:38:13 -0700115void __noreturn jump_to_image_linux(struct spl_image_info *spl_image);
Simon Glassf59961e2016-09-24 18:19:55 -0600116
117/**
118 * spl_start_uboot() - Check if SPL should start the kernel or U-Boot
119 *
120 * This is called by the various SPL loaders to determine whether the board
121 * wants to load the kernel or U-Boot. This function should be provided by
122 * the board.
123 *
124 * @return 0 if SPL should start the kernel, 1 if U-Boot must be started
125 */
Tom Rini47f7bca2012-08-13 12:03:19 -0700126int spl_start_uboot(void);
Simon Glassf59961e2016-09-24 18:19:55 -0600127
Simon Glassa807ab32016-09-24 18:19:56 -0600128/**
129 * spl_display_print() - Display a board-specific message in SPL
130 *
131 * If CONFIG_SPL_DISPLAY_PRINT is enabled, U-Boot will call this function
132 * immediately after displaying the SPL console banner ("U-Boot SPL ...").
133 * This function should be provided by the board.
134 */
Tom Rini47f7bca2012-08-13 12:03:19 -0700135void spl_display_print(void);
136
Simon Glassecdfd692016-09-24 18:19:57 -0600137/**
138 * struct spl_boot_device - Describes a boot device used by SPL
139 *
140 * @boot_device: A number indicating the BOOT_DEVICE type. There are various
141 * BOOT_DEVICE... #defines and enums in U-Boot and they are not consistently
142 * numbered.
143 * @boot_device_name: Named boot device, or NULL if none.
144 *
145 * Note: Additional fields can be added here, bearing in mind that SPL is
146 * size-sensitive and common fields will be present on all boards. This
147 * struct can also be used to return additional information about the load
148 * process if that becomes useful.
149 */
150struct spl_boot_device {
151 uint boot_device;
152 const char *boot_device_name;
153};
154
Simon Glassa0a80292016-09-24 18:19:58 -0600155/**
156 * Holds information about a way of loading an SPL image
157 *
Simon Glassebc4ef62016-11-30 15:30:50 -0700158 * @name: User-friendly name for this method (e.g. "MMC")
Simon Glassa0a80292016-09-24 18:19:58 -0600159 * @boot_device: Boot device that this loader supports
160 * @load_image: Function to call to load image
161 */
162struct spl_image_loader {
Simon Glassebc4ef62016-11-30 15:30:50 -0700163#ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
164 const char *name;
165#endif
Simon Glassa0a80292016-09-24 18:19:58 -0600166 uint boot_device;
167 /**
168 * load_image() - Load an SPL image
169 *
Simon Glass2a2ee2a2016-09-24 18:20:13 -0600170 * @spl_image: place to put image information
Simon Glassa0a80292016-09-24 18:19:58 -0600171 * @bootdev: describes the boot device to load from
172 */
Simon Glass2a2ee2a2016-09-24 18:20:13 -0600173 int (*load_image)(struct spl_image_info *spl_image,
174 struct spl_boot_device *bootdev);
Simon Glassa0a80292016-09-24 18:19:58 -0600175};
176
177/* Declare an SPL image loader */
178#define SPL_LOAD_IMAGE(__name) \
179 ll_entry_declare(struct spl_image_loader, __name, spl_image_loader)
180
181/*
Simon Glass0d3b0592016-11-30 15:30:49 -0700182 * _priority is the priority of this method, 0 meaning it will be the top
Simon Glassa0a80292016-09-24 18:19:58 -0600183 * choice for this device, 9 meaning it is the bottom choice.
Simon Glass0d3b0592016-11-30 15:30:49 -0700184 * _boot_device is the BOOT_DEVICE_... value
185 * _method is the load_image function to call
Simon Glassa0a80292016-09-24 18:19:58 -0600186 */
Simon Glassebc4ef62016-11-30 15:30:50 -0700187#ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
188#define SPL_LOAD_IMAGE_METHOD(_name, _priority, _boot_device, _method) \
189 SPL_LOAD_IMAGE(_method ## _priority ## _boot_device) = { \
190 .name = _name, \
191 .boot_device = _boot_device, \
192 .load_image = _method, \
193 }
194#else
195#define SPL_LOAD_IMAGE_METHOD(_name, _priority, _boot_device, _method) \
Simon Glass0d3b0592016-11-30 15:30:49 -0700196 SPL_LOAD_IMAGE(_method ## _priority ## _boot_device) = { \
197 .boot_device = _boot_device, \
198 .load_image = _method, \
Simon Glassa0a80292016-09-24 18:19:58 -0600199 }
Simon Glassebc4ef62016-11-30 15:30:50 -0700200#endif
Simon Glassa0a80292016-09-24 18:19:58 -0600201
Dan Murphy773b5942014-01-16 11:23:29 -0600202/* SPL FAT image functions */
Simon Glass710e9ca2016-09-24 18:20:15 -0600203int spl_load_image_fat(struct spl_image_info *spl_image,
204 struct blk_desc *block_dev, int partition,
Simon Glass4101f682016-02-29 15:25:34 -0700205 const char *filename);
Simon Glass710e9ca2016-09-24 18:20:15 -0600206int spl_load_image_fat_os(struct spl_image_info *spl_image,
207 struct blk_desc *block_dev, int partition);
Dan Murphy773b5942014-01-16 11:23:29 -0600208
Jeroen Hofsteece048222014-10-08 22:58:07 +0200209void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image);
210
Guillaume GARDET592f9222014-10-15 17:53:12 +0200211/* SPL EXT image functions */
Simon Glassb4a6c2a2016-09-24 18:20:14 -0600212int spl_load_image_ext(struct spl_image_info *spl_image,
213 struct blk_desc *block_dev, int partition,
Simon Glass4101f682016-02-29 15:25:34 -0700214 const char *filename);
Simon Glassb4a6c2a2016-09-24 18:20:14 -0600215int spl_load_image_ext_os(struct spl_image_info *spl_image,
216 struct blk_desc *block_dev, int partition);
Guillaume GARDET592f9222014-10-15 17:53:12 +0200217
Simon Glass070d00b2015-06-23 15:39:10 -0600218/**
Eddie Cai340f4182017-03-15 08:43:28 -0600219 * spl_early_init() - Set up device tree and driver model in SPL if enabled
Simon Glass070d00b2015-06-23 15:39:10 -0600220 *
221 * Call this function in board_init_f() if you want to use device tree and
Eddie Cai340f4182017-03-15 08:43:28 -0600222 * driver model early, before board_init_r() is called.
223 *
224 * If this is not called, then driver model will be inactive in SPL's
225 * board_init_f(), and no device tree will be available.
226 */
227int spl_early_init(void);
228
229/**
230 * spl_init() - Set up device tree and driver model in SPL if enabled
231 *
232 * You can optionally call spl_early_init(), then optionally call spl_init().
233 * This function will be called from board_init_r() if not called earlier.
234 *
235 * Both spl_early_init() and spl_init() perform a similar function except that
236 * the latter will not set up the malloc() area if
237 * CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN is enabled, since it is assumed to
238 * already be done by a calll to spl_relocate_stack_gd() before board_init_r()
239 * is reached.
240 *
241 * This function will be called from board_init_r() if not called earlier.
Simon Glass070d00b2015-06-23 15:39:10 -0600242 *
243 * If this is not called, then driver model will be inactive in SPL's
244 * board_init_f(), and no device tree will be available.
245 */
246int spl_init(void);
247
Tom Rini47f7bca2012-08-13 12:03:19 -0700248#ifdef CONFIG_SPL_BOARD_INIT
249void spl_board_init(void);
250#endif
Simon Glass32ba8952015-05-13 07:02:24 -0600251
252/**
253 * spl_was_boot_source() - check if U-Boot booted from SPL
254 *
255 * This will normally be true, but if U-Boot jumps to second U-Boot, it will
256 * be false. This should be implemented by board-specific code.
257 *
258 * @return true if U-Boot booted from SPL, else false
259 */
260bool spl_was_boot_source(void);
261
B, Ravi52f2acc2016-07-28 17:39:16 +0530262/**
263 * spl_dfu_cmd- run dfu command with chosen mmc device interface
264 * @param usb_index - usb controller number
265 * @param mmc_dev - mmc device nubmer
266 *
267 * @return 0 on success, otherwise error code
268 */
269int spl_dfu_cmd(int usbctrl, char *dfu_alt_info, char *interface, char *devstr);
Simon Glasse50d76c2016-09-24 18:19:51 -0600270
Marek Vasut09410c62016-12-01 02:06:35 +0100271int spl_mmc_load_image(struct spl_image_info *spl_image,
272 struct spl_boot_device *bootdev);
273
Philipp Tomsichf2efe672017-09-13 21:29:31 +0200274/**
275 * spl_invoke_atf - boot using an ARM trusted firmware image
276 */
277void spl_invoke_atf(struct spl_image_info *spl_image);
Philipp Tomsich225d30b2017-06-22 23:38:36 +0200278
279/**
280 * board_return_to_bootrom - allow for boards to continue with the boot ROM
281 *
282 * If a board (e.g. the Rockchip RK3368 boards) provide some
283 * supporting functionality for SPL in their boot ROM and the SPL
284 * stage wants to return to the ROM code to continue booting, boards
285 * can implement 'board_return_to_bootrom'.
286 */
287void board_return_to_bootrom(void);
Tom Rini47f7bca2012-08-13 12:03:19 -0700288#endif