blob: c82f2fd033653dddc2a26198c0040a268b321024 [file] [log] [blame]
Tom Rini83d290c2018-05-06 17:58:06 -04001/* SPDX-License-Identifier: GPL-2.0+ */
Tom Rini47f7bca2012-08-13 12:03:19 -07002/*
3 * (C) Copyright 2012
4 * Texas Instruments, <www.ti.com>
Tom Rini47f7bca2012-08-13 12:03:19 -07005 */
6#ifndef _SPL_H_
7#define _SPL_H_
8
Simon Glass8bee2d22017-11-13 18:55:03 -07009#include <binman_sym.h>
10
Tom Rini47f7bca2012-08-13 12:03:19 -070011/* Platform-specific defines */
Tom Rini6507f132012-08-22 15:31:05 -070012#include <linux/compiler.h>
Tom Rini47f7bca2012-08-13 12:03:19 -070013#include <asm/spl.h>
Simon Glassb0edea32018-11-15 18:44:09 -070014#include <handoff.h>
Tom Rini47f7bca2012-08-13 12:03:19 -070015
Simon Glass32ba8952015-05-13 07:02:24 -060016/* Value in r0 indicates we booted from U-Boot */
17#define UBOOT_NOT_LOADED_FROM_SPL 0x13578642
Dan Murphy773b5942014-01-16 11:23:29 -060018
Tom Rini47f7bca2012-08-13 12:03:19 -070019/* Boot type */
20#define MMCSD_MODE_UNDEFINED 0
21#define MMCSD_MODE_RAW 1
Guillaume GARDET205b4f32014-10-15 17:53:11 +020022#define MMCSD_MODE_FS 2
Tom Rini7dbe63b2014-02-05 10:24:18 -050023#define MMCSD_MODE_EMMCBOOT 3
Tom Rini47f7bca2012-08-13 12:03:19 -070024
Simon Glasse945a722018-11-15 18:43:51 -070025/*
26 * u_boot_first_phase() - check if this is the first U-Boot phase
27 *
28 * U-Boot has up to three phases: TPL, SPL and U-Boot proper. Depending on the
29 * build flags we can determine whether the current build is for the first
30 * phase of U-Boot or not. If there is no SPL, then this is U-Boot proper. If
31 * there is SPL but no TPL, the the first phase is SPL. If there is TPL, then
32 * it is the first phase.
33 *
34 * @returns true if this is the first phase of U-Boot
35 *
36 */
37static inline bool u_boot_first_phase(void)
38{
39 if (IS_ENABLED(CONFIG_TPL)) {
40 if (IS_ENABLED(CONFIG_TPL_BUILD))
41 return true;
42 } else if (IS_ENABLED(CONFIG_SPL)) {
43 if (IS_ENABLED(CONFIG_SPL_BUILD))
44 return true;
45 } else {
46 return true;
47 }
48
49 return false;
50}
51
Simon Glassd6330062018-11-15 18:43:56 -070052/* A string name for SPL or TPL */
53#ifdef CONFIG_SPL_BUILD
54# ifdef CONFIG_TPL_BUILD
Heiko Schocher8fb23912018-12-05 11:29:54 +010055# define SPL_TPL_NAME "TPL"
Simon Glassd6330062018-11-15 18:43:56 -070056# else
Heiko Schocher8fb23912018-12-05 11:29:54 +010057# define SPL_TPL_NAME "SPL"
Simon Glassd6330062018-11-15 18:43:56 -070058# endif
59# define SPL_TPL_PROMPT SPL_TPL_NAME ": "
60#else
61# define SPL_TPL_NAME ""
62# define SPL_TPL_PROMPT ""
63#endif
64
Tom Rini47f7bca2012-08-13 12:03:19 -070065struct spl_image_info {
66 const char *name;
67 u8 os;
Philipp Tomsichf2efe672017-09-13 21:29:31 +020068 uintptr_t load_addr;
69 uintptr_t entry_point;
Philipp Tomsich75014472017-09-13 21:29:30 +020070#if CONFIG_IS_ENABLED(LOAD_FIT)
71 void *fdt_addr;
72#endif
Philipp Tomsichde5dd4c2018-05-24 17:15:50 +020073 u32 boot_device;
Tom Rini47f7bca2012-08-13 12:03:19 -070074 u32 size;
Stefan Roese022b4972012-08-27 12:50:58 +020075 u32 flags;
Vikas Manocha5bf52502017-04-07 15:38:13 -070076 void *arg;
Tom Rini47f7bca2012-08-13 12:03:19 -070077};
78
Simon Glassf1dcee52016-02-22 22:55:56 -070079/*
80 * Information required to load data from a device
81 *
82 * @dev: Pointer to the device, e.g. struct mmc *
83 * @priv: Private data for the device
84 * @bl_len: Block length for reading in bytes
Lokesh Vutlaeafd5412016-05-24 10:34:38 +053085 * @filename: Name of the fit image file.
Simon Glassf1dcee52016-02-22 22:55:56 -070086 * @read: Function to call to read from the device
87 */
88struct spl_load_info {
89 void *dev;
90 void *priv;
91 int bl_len;
Lokesh Vutlaeafd5412016-05-24 10:34:38 +053092 const char *filename;
Simon Glassf1dcee52016-02-22 22:55:56 -070093 ulong (*read)(struct spl_load_info *load, ulong sector, ulong count,
94 void *buf);
95};
96
Simon Glass8bee2d22017-11-13 18:55:03 -070097/*
98 * We need to know the position of U-Boot in memory so we can jump to it. We
99 * allow any U-Boot binary to be used (u-boot.bin, u-boot-nodtb.bin,
100 * u-boot.img), hence the '_any'. These is no checking here that the correct
101 * image is found. For * example if u-boot.img is used we don't check that
102 * spl_parse_image_header() can parse a valid header.
103 */
Simon Glassdbf6be92018-08-01 15:22:42 -0600104binman_sym_extern(ulong, u_boot_any, image_pos);
Simon Glass8bee2d22017-11-13 18:55:03 -0700105
Lokesh Vutlaeafd5412016-05-24 10:34:38 +0530106/**
107 * spl_load_simple_fit() - Loads a fit image from a device.
Simon Glassf4d7d852016-09-24 18:20:16 -0600108 * @spl_image: Image description to set up
Lokesh Vutlaeafd5412016-05-24 10:34:38 +0530109 * @info: Structure containing the information required to load data.
110 * @sector: Sector number where FIT image is located in the device
111 * @fdt: Pointer to the copied FIT header.
112 *
113 * Reads the FIT image @sector in the device. Loads u-boot image to
114 * specified load address and copies the dtb to end of u-boot image.
115 * Returns 0 on success.
116 */
Simon Glassf4d7d852016-09-24 18:20:16 -0600117int spl_load_simple_fit(struct spl_image_info *spl_image,
118 struct spl_load_info *info, ulong sector, void *fdt);
Simon Glassf1dcee52016-02-22 22:55:56 -0700119
Stefan Roese022b4972012-08-27 12:50:58 +0200120#define SPL_COPY_PAYLOAD_ONLY 1
Ye Lie246bfc2018-11-17 09:10:25 +0000121#define SPL_FIT_FOUND 2
Stefan Roese022b4972012-08-27 12:50:58 +0200122
Tom Rini47f7bca2012-08-13 12:03:19 -0700123/* SPL common functions */
124void preloader_console_init(void);
125u32 spl_boot_device(void);
Marek Vasut2b1cdaf2016-05-14 23:42:07 +0200126u32 spl_boot_mode(const u32 boot_device);
Patrick Delaunay35a66962018-03-20 10:54:51 +0100127int spl_boot_partition(const u32 boot_device);
York Sund1fc0a32017-09-28 08:42:10 -0700128void spl_set_bd(void);
Simon Glassd95ceb92016-09-24 18:19:52 -0600129
130/**
131 * spl_set_header_raw_uboot() - Set up a standard SPL image structure
132 *
133 * This sets up the given spl_image which the standard values obtained from
134 * config options: CONFIG_SYS_MONITOR_LEN, CONFIG_SYS_UBOOT_START,
135 * CONFIG_SYS_TEXT_BASE.
136 *
Simon Glass71316c12016-09-24 18:19:53 -0600137 * @spl_image: Image description to set up
Simon Glassd95ceb92016-09-24 18:19:52 -0600138 */
139void spl_set_header_raw_uboot(struct spl_image_info *spl_image);
140
Simon Glass71316c12016-09-24 18:19:53 -0600141/**
142 * spl_parse_image_header() - parse the image header and set up info
143 *
144 * This parses the legacy image header information at @header and sets up
145 * @spl_image according to what is found. If no image header is found, then
146 * a raw image or bootz is assumed. If CONFIG_SPL_PANIC_ON_RAW_IMAGE is
Andrew F. Davis24eb39b2017-02-16 11:18:38 -0600147 * enabled, then this causes a panic. If CONFIG_SPL_RAW_IMAGE_SUPPORT is not
Simon Glass71316c12016-09-24 18:19:53 -0600148 * enabled then U-Boot gives up. Otherwise U-Boot sets up the image using
149 * spl_set_header_raw_uboot(), or possibly the bootz header.
150 *
151 * @spl_image: Image description to set up
152 * @header image header to parse
153 * @return 0 if a header was correctly parsed, -ve on error
154 */
155int spl_parse_image_header(struct spl_image_info *spl_image,
156 const struct image_header *header);
157
Tom Rini47f7bca2012-08-13 12:03:19 -0700158void spl_board_prepare_for_linux(void);
Michal Simek3a3b9142016-05-10 07:54:20 +0200159void spl_board_prepare_for_boot(void);
Ladislav Michlbf55cd42016-07-12 20:28:13 +0200160int spl_board_ubi_load_image(u32 boot_device);
Simon Glassca12e652016-09-24 18:19:54 -0600161
162/**
163 * jump_to_image_linux() - Jump to a Linux kernel from SPL
164 *
165 * This jumps into a Linux kernel using the information in @spl_image.
166 *
167 * @spl_image: Image description to set up
Simon Glassca12e652016-09-24 18:19:54 -0600168 */
Vikas Manocha5bf52502017-04-07 15:38:13 -0700169void __noreturn jump_to_image_linux(struct spl_image_info *spl_image);
Simon Glassf59961e2016-09-24 18:19:55 -0600170
171/**
172 * spl_start_uboot() - Check if SPL should start the kernel or U-Boot
173 *
174 * This is called by the various SPL loaders to determine whether the board
175 * wants to load the kernel or U-Boot. This function should be provided by
176 * the board.
177 *
178 * @return 0 if SPL should start the kernel, 1 if U-Boot must be started
179 */
Tom Rini47f7bca2012-08-13 12:03:19 -0700180int spl_start_uboot(void);
Simon Glassf59961e2016-09-24 18:19:55 -0600181
Simon Glassa807ab32016-09-24 18:19:56 -0600182/**
183 * spl_display_print() - Display a board-specific message in SPL
184 *
185 * If CONFIG_SPL_DISPLAY_PRINT is enabled, U-Boot will call this function
186 * immediately after displaying the SPL console banner ("U-Boot SPL ...").
187 * This function should be provided by the board.
188 */
Tom Rini47f7bca2012-08-13 12:03:19 -0700189void spl_display_print(void);
190
Simon Glassecdfd692016-09-24 18:19:57 -0600191/**
192 * struct spl_boot_device - Describes a boot device used by SPL
193 *
194 * @boot_device: A number indicating the BOOT_DEVICE type. There are various
195 * BOOT_DEVICE... #defines and enums in U-Boot and they are not consistently
196 * numbered.
197 * @boot_device_name: Named boot device, or NULL if none.
198 *
199 * Note: Additional fields can be added here, bearing in mind that SPL is
200 * size-sensitive and common fields will be present on all boards. This
201 * struct can also be used to return additional information about the load
202 * process if that becomes useful.
203 */
204struct spl_boot_device {
205 uint boot_device;
206 const char *boot_device_name;
207};
208
Simon Glassa0a80292016-09-24 18:19:58 -0600209/**
210 * Holds information about a way of loading an SPL image
211 *
Simon Glassebc4ef62016-11-30 15:30:50 -0700212 * @name: User-friendly name for this method (e.g. "MMC")
Simon Glassa0a80292016-09-24 18:19:58 -0600213 * @boot_device: Boot device that this loader supports
214 * @load_image: Function to call to load image
215 */
216struct spl_image_loader {
Simon Glassebc4ef62016-11-30 15:30:50 -0700217#ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
218 const char *name;
219#endif
Simon Glassa0a80292016-09-24 18:19:58 -0600220 uint boot_device;
221 /**
222 * load_image() - Load an SPL image
223 *
Simon Glass2a2ee2a2016-09-24 18:20:13 -0600224 * @spl_image: place to put image information
Simon Glassa0a80292016-09-24 18:19:58 -0600225 * @bootdev: describes the boot device to load from
226 */
Simon Glass2a2ee2a2016-09-24 18:20:13 -0600227 int (*load_image)(struct spl_image_info *spl_image,
228 struct spl_boot_device *bootdev);
Simon Glassa0a80292016-09-24 18:19:58 -0600229};
230
231/* Declare an SPL image loader */
232#define SPL_LOAD_IMAGE(__name) \
233 ll_entry_declare(struct spl_image_loader, __name, spl_image_loader)
234
235/*
Simon Glass0d3b0592016-11-30 15:30:49 -0700236 * _priority is the priority of this method, 0 meaning it will be the top
Simon Glassa0a80292016-09-24 18:19:58 -0600237 * choice for this device, 9 meaning it is the bottom choice.
Simon Glass0d3b0592016-11-30 15:30:49 -0700238 * _boot_device is the BOOT_DEVICE_... value
239 * _method is the load_image function to call
Simon Glassa0a80292016-09-24 18:19:58 -0600240 */
Simon Glassebc4ef62016-11-30 15:30:50 -0700241#ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
242#define SPL_LOAD_IMAGE_METHOD(_name, _priority, _boot_device, _method) \
243 SPL_LOAD_IMAGE(_method ## _priority ## _boot_device) = { \
244 .name = _name, \
245 .boot_device = _boot_device, \
246 .load_image = _method, \
247 }
248#else
249#define SPL_LOAD_IMAGE_METHOD(_name, _priority, _boot_device, _method) \
Simon Glass0d3b0592016-11-30 15:30:49 -0700250 SPL_LOAD_IMAGE(_method ## _priority ## _boot_device) = { \
251 .boot_device = _boot_device, \
252 .load_image = _method, \
Simon Glassa0a80292016-09-24 18:19:58 -0600253 }
Simon Glassebc4ef62016-11-30 15:30:50 -0700254#endif
Simon Glassa0a80292016-09-24 18:19:58 -0600255
Dan Murphy773b5942014-01-16 11:23:29 -0600256/* SPL FAT image functions */
Simon Glass710e9ca2016-09-24 18:20:15 -0600257int spl_load_image_fat(struct spl_image_info *spl_image,
258 struct blk_desc *block_dev, int partition,
Simon Glass4101f682016-02-29 15:25:34 -0700259 const char *filename);
Simon Glass710e9ca2016-09-24 18:20:15 -0600260int spl_load_image_fat_os(struct spl_image_info *spl_image,
261 struct blk_desc *block_dev, int partition);
Dan Murphy773b5942014-01-16 11:23:29 -0600262
Jeroen Hofsteece048222014-10-08 22:58:07 +0200263void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image);
264
Guillaume GARDET592f9222014-10-15 17:53:12 +0200265/* SPL EXT image functions */
Simon Glassb4a6c2a2016-09-24 18:20:14 -0600266int spl_load_image_ext(struct spl_image_info *spl_image,
267 struct blk_desc *block_dev, int partition,
Simon Glass4101f682016-02-29 15:25:34 -0700268 const char *filename);
Simon Glassb4a6c2a2016-09-24 18:20:14 -0600269int spl_load_image_ext_os(struct spl_image_info *spl_image,
270 struct blk_desc *block_dev, int partition);
Guillaume GARDET592f9222014-10-15 17:53:12 +0200271
Simon Glass070d00b2015-06-23 15:39:10 -0600272/**
Eddie Cai340f4182017-03-15 08:43:28 -0600273 * spl_early_init() - Set up device tree and driver model in SPL if enabled
Simon Glass070d00b2015-06-23 15:39:10 -0600274 *
275 * Call this function in board_init_f() if you want to use device tree and
Eddie Cai340f4182017-03-15 08:43:28 -0600276 * driver model early, before board_init_r() is called.
277 *
278 * If this is not called, then driver model will be inactive in SPL's
279 * board_init_f(), and no device tree will be available.
280 */
281int spl_early_init(void);
282
283/**
284 * spl_init() - Set up device tree and driver model in SPL if enabled
285 *
286 * You can optionally call spl_early_init(), then optionally call spl_init().
287 * This function will be called from board_init_r() if not called earlier.
288 *
289 * Both spl_early_init() and spl_init() perform a similar function except that
290 * the latter will not set up the malloc() area if
291 * CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN is enabled, since it is assumed to
292 * already be done by a calll to spl_relocate_stack_gd() before board_init_r()
293 * is reached.
294 *
295 * This function will be called from board_init_r() if not called earlier.
Simon Glass070d00b2015-06-23 15:39:10 -0600296 *
297 * If this is not called, then driver model will be inactive in SPL's
298 * board_init_f(), and no device tree will be available.
299 */
300int spl_init(void);
301
Tom Rini47f7bca2012-08-13 12:03:19 -0700302#ifdef CONFIG_SPL_BOARD_INIT
303void spl_board_init(void);
304#endif
Simon Glass32ba8952015-05-13 07:02:24 -0600305
306/**
307 * spl_was_boot_source() - check if U-Boot booted from SPL
308 *
309 * This will normally be true, but if U-Boot jumps to second U-Boot, it will
310 * be false. This should be implemented by board-specific code.
311 *
312 * @return true if U-Boot booted from SPL, else false
313 */
314bool spl_was_boot_source(void);
315
B, Ravi52f2acc2016-07-28 17:39:16 +0530316/**
317 * spl_dfu_cmd- run dfu command with chosen mmc device interface
318 * @param usb_index - usb controller number
319 * @param mmc_dev - mmc device nubmer
320 *
321 * @return 0 on success, otherwise error code
322 */
323int spl_dfu_cmd(int usbctrl, char *dfu_alt_info, char *interface, char *devstr);
Simon Glasse50d76c2016-09-24 18:19:51 -0600324
Marek Vasut09410c62016-12-01 02:06:35 +0100325int spl_mmc_load_image(struct spl_image_info *spl_image,
326 struct spl_boot_device *bootdev);
327
Philipp Tomsichf2efe672017-09-13 21:29:31 +0200328/**
329 * spl_invoke_atf - boot using an ARM trusted firmware image
330 */
331void spl_invoke_atf(struct spl_image_info *spl_image);
Philipp Tomsich225d30b2017-06-22 23:38:36 +0200332
333/**
Kever Yang70fe2872018-08-23 17:17:59 +0800334 * spl_optee_entry - entry function for optee
335 *
336 * args defind in op-tee project
337 * https://github.com/OP-TEE/optee_os/
338 * core/arch/arm/kernel/generic_entry_a32.S
339 * @arg0: pagestore
340 * @arg1: (ARMv7 standard bootarg #1)
341 * @arg2: device tree address, (ARMv7 standard bootarg #2)
342 * @arg3: non-secure entry address (ARMv7 bootarg #0)
343 */
344void spl_optee_entry(void *arg0, void *arg1, void *arg2, void *arg3);
345
346/**
Philipp Tomsich225d30b2017-06-22 23:38:36 +0200347 * board_return_to_bootrom - allow for boards to continue with the boot ROM
348 *
349 * If a board (e.g. the Rockchip RK3368 boards) provide some
350 * supporting functionality for SPL in their boot ROM and the SPL
351 * stage wants to return to the ROM code to continue booting, boards
352 * can implement 'board_return_to_bootrom'.
353 */
354void board_return_to_bootrom(void);
Philipp Tomsichde5dd4c2018-05-24 17:15:50 +0200355
356/**
Peng Fan28ded1f2018-11-17 09:10:31 +0000357 * board_spl_fit_post_load - allow process images after loading finished
358 *
359 */
360void board_spl_fit_post_load(ulong load_addr, size_t length);
361
362/**
363 * board_spl_fit_size_align - specific size align before processing payload
364 *
365 */
366ulong board_spl_fit_size_align(ulong size);
367
368/**
Philipp Tomsichde5dd4c2018-05-24 17:15:50 +0200369 * spl_perform_fixups() - arch/board-specific callback before processing
370 * the boot-payload
371 */
372void spl_perform_fixups(struct spl_image_info *spl_image);
Marek Vasut04ce5422018-08-14 11:27:02 +0200373
374/*
375 * spl_get_load_buffer() - get buffer for loading partial image data
376 *
377 * Returns memory area which can be populated by partial image data,
378 * ie. uImage or fitImage header.
379 */
380struct image_header *spl_get_load_buffer(ssize_t offset, size_t size);
381
Tom Rini47f7bca2012-08-13 12:03:19 -0700382#endif