blob: 2e5b885c8d66062158a70d945fe609353e58a8be [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;
Tom Rini47f7bca2012-08-13 12:03:19 -070030};
31
Simon Glassf1dcee52016-02-22 22:55:56 -070032/*
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
Lokesh Vutlaeafd5412016-05-24 10:34:38 +053038 * @filename: Name of the fit image file.
Simon Glassf1dcee52016-02-22 22:55:56 -070039 * @read: Function to call to read from the device
40 */
41struct spl_load_info {
42 void *dev;
43 void *priv;
44 int bl_len;
Lokesh Vutlaeafd5412016-05-24 10:34:38 +053045 const char *filename;
Simon Glassf1dcee52016-02-22 22:55:56 -070046 ulong (*read)(struct spl_load_info *load, ulong sector, ulong count,
47 void *buf);
48};
49
Lokesh Vutlaeafd5412016-05-24 10:34:38 +053050/**
51 * spl_load_simple_fit() - Loads a fit image from a device.
Simon Glassf4d7d852016-09-24 18:20:16 -060052 * @spl_image: Image description to set up
Lokesh Vutlaeafd5412016-05-24 10:34:38 +053053 * @info: Structure containing the information required to load data.
54 * @sector: Sector number where FIT image is located in the device
55 * @fdt: Pointer to the copied FIT header.
56 *
57 * Reads the FIT image @sector in the device. Loads u-boot image to
58 * specified load address and copies the dtb to end of u-boot image.
59 * Returns 0 on success.
60 */
Simon Glassf4d7d852016-09-24 18:20:16 -060061int spl_load_simple_fit(struct spl_image_info *spl_image,
62 struct spl_load_info *info, ulong sector, void *fdt);
Simon Glassf1dcee52016-02-22 22:55:56 -070063
Stefan Roese022b4972012-08-27 12:50:58 +020064#define SPL_COPY_PAYLOAD_ONLY 1
65
Tom Rini47f7bca2012-08-13 12:03:19 -070066/* SPL common functions */
67void preloader_console_init(void);
68u32 spl_boot_device(void);
Marek Vasut2b1cdaf2016-05-14 23:42:07 +020069u32 spl_boot_mode(const u32 boot_device);
Simon Glassd95ceb92016-09-24 18:19:52 -060070
71/**
72 * spl_set_header_raw_uboot() - Set up a standard SPL image structure
73 *
74 * This sets up the given spl_image which the standard values obtained from
75 * config options: CONFIG_SYS_MONITOR_LEN, CONFIG_SYS_UBOOT_START,
76 * CONFIG_SYS_TEXT_BASE.
77 *
Simon Glass71316c12016-09-24 18:19:53 -060078 * @spl_image: Image description to set up
Simon Glassd95ceb92016-09-24 18:19:52 -060079 */
80void spl_set_header_raw_uboot(struct spl_image_info *spl_image);
81
Simon Glass71316c12016-09-24 18:19:53 -060082/**
83 * spl_parse_image_header() - parse the image header and set up info
84 *
85 * This parses the legacy image header information at @header and sets up
86 * @spl_image according to what is found. If no image header is found, then
87 * a raw image or bootz is assumed. If CONFIG_SPL_PANIC_ON_RAW_IMAGE is
Andrew F. Davis24eb39b2017-02-16 11:18:38 -060088 * enabled, then this causes a panic. If CONFIG_SPL_RAW_IMAGE_SUPPORT is not
Simon Glass71316c12016-09-24 18:19:53 -060089 * enabled then U-Boot gives up. Otherwise U-Boot sets up the image using
90 * spl_set_header_raw_uboot(), or possibly the bootz header.
91 *
92 * @spl_image: Image description to set up
93 * @header image header to parse
94 * @return 0 if a header was correctly parsed, -ve on error
95 */
96int spl_parse_image_header(struct spl_image_info *spl_image,
97 const struct image_header *header);
98
Tom Rini47f7bca2012-08-13 12:03:19 -070099void spl_board_prepare_for_linux(void);
Michal Simek3a3b9142016-05-10 07:54:20 +0200100void spl_board_prepare_for_boot(void);
Ladislav Michlbf55cd42016-07-12 20:28:13 +0200101int spl_board_ubi_load_image(u32 boot_device);
Simon Glassca12e652016-09-24 18:19:54 -0600102
103/**
104 * jump_to_image_linux() - Jump to a Linux kernel from SPL
105 *
106 * This jumps into a Linux kernel using the information in @spl_image.
107 *
108 * @spl_image: Image description to set up
109 * @arg: Argument to pass to Linux (typically a device tree pointer)
110 */
111void __noreturn jump_to_image_linux(struct spl_image_info *spl_image,
112 void *arg);
Simon Glassf59961e2016-09-24 18:19:55 -0600113
114/**
115 * spl_start_uboot() - Check if SPL should start the kernel or U-Boot
116 *
117 * This is called by the various SPL loaders to determine whether the board
118 * wants to load the kernel or U-Boot. This function should be provided by
119 * the board.
120 *
121 * @return 0 if SPL should start the kernel, 1 if U-Boot must be started
122 */
Tom Rini47f7bca2012-08-13 12:03:19 -0700123int spl_start_uboot(void);
Simon Glassf59961e2016-09-24 18:19:55 -0600124
Simon Glassa807ab32016-09-24 18:19:56 -0600125/**
126 * spl_display_print() - Display a board-specific message in SPL
127 *
128 * If CONFIG_SPL_DISPLAY_PRINT is enabled, U-Boot will call this function
129 * immediately after displaying the SPL console banner ("U-Boot SPL ...").
130 * This function should be provided by the board.
131 */
Tom Rini47f7bca2012-08-13 12:03:19 -0700132void spl_display_print(void);
133
Simon Glassecdfd692016-09-24 18:19:57 -0600134/**
135 * struct spl_boot_device - Describes a boot device used by SPL
136 *
137 * @boot_device: A number indicating the BOOT_DEVICE type. There are various
138 * BOOT_DEVICE... #defines and enums in U-Boot and they are not consistently
139 * numbered.
140 * @boot_device_name: Named boot device, or NULL if none.
141 *
142 * Note: Additional fields can be added here, bearing in mind that SPL is
143 * size-sensitive and common fields will be present on all boards. This
144 * struct can also be used to return additional information about the load
145 * process if that becomes useful.
146 */
147struct spl_boot_device {
148 uint boot_device;
149 const char *boot_device_name;
150};
151
Simon Glassa0a80292016-09-24 18:19:58 -0600152/**
153 * Holds information about a way of loading an SPL image
154 *
Simon Glassebc4ef62016-11-30 15:30:50 -0700155 * @name: User-friendly name for this method (e.g. "MMC")
Simon Glassa0a80292016-09-24 18:19:58 -0600156 * @boot_device: Boot device that this loader supports
157 * @load_image: Function to call to load image
158 */
159struct spl_image_loader {
Simon Glassebc4ef62016-11-30 15:30:50 -0700160#ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
161 const char *name;
162#endif
Simon Glassa0a80292016-09-24 18:19:58 -0600163 uint boot_device;
164 /**
165 * load_image() - Load an SPL image
166 *
Simon Glass2a2ee2a2016-09-24 18:20:13 -0600167 * @spl_image: place to put image information
Simon Glassa0a80292016-09-24 18:19:58 -0600168 * @bootdev: describes the boot device to load from
169 */
Simon Glass2a2ee2a2016-09-24 18:20:13 -0600170 int (*load_image)(struct spl_image_info *spl_image,
171 struct spl_boot_device *bootdev);
Simon Glassa0a80292016-09-24 18:19:58 -0600172};
173
174/* Declare an SPL image loader */
175#define SPL_LOAD_IMAGE(__name) \
176 ll_entry_declare(struct spl_image_loader, __name, spl_image_loader)
177
178/*
Simon Glass0d3b0592016-11-30 15:30:49 -0700179 * _priority is the priority of this method, 0 meaning it will be the top
Simon Glassa0a80292016-09-24 18:19:58 -0600180 * choice for this device, 9 meaning it is the bottom choice.
Simon Glass0d3b0592016-11-30 15:30:49 -0700181 * _boot_device is the BOOT_DEVICE_... value
182 * _method is the load_image function to call
Simon Glassa0a80292016-09-24 18:19:58 -0600183 */
Simon Glassebc4ef62016-11-30 15:30:50 -0700184#ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
185#define SPL_LOAD_IMAGE_METHOD(_name, _priority, _boot_device, _method) \
186 SPL_LOAD_IMAGE(_method ## _priority ## _boot_device) = { \
187 .name = _name, \
188 .boot_device = _boot_device, \
189 .load_image = _method, \
190 }
191#else
192#define SPL_LOAD_IMAGE_METHOD(_name, _priority, _boot_device, _method) \
Simon Glass0d3b0592016-11-30 15:30:49 -0700193 SPL_LOAD_IMAGE(_method ## _priority ## _boot_device) = { \
194 .boot_device = _boot_device, \
195 .load_image = _method, \
Simon Glassa0a80292016-09-24 18:19:58 -0600196 }
Simon Glassebc4ef62016-11-30 15:30:50 -0700197#endif
Simon Glassa0a80292016-09-24 18:19:58 -0600198
Dan Murphy773b5942014-01-16 11:23:29 -0600199/* SPL FAT image functions */
Simon Glass710e9ca2016-09-24 18:20:15 -0600200int spl_load_image_fat(struct spl_image_info *spl_image,
201 struct blk_desc *block_dev, int partition,
Simon Glass4101f682016-02-29 15:25:34 -0700202 const char *filename);
Simon Glass710e9ca2016-09-24 18:20:15 -0600203int spl_load_image_fat_os(struct spl_image_info *spl_image,
204 struct blk_desc *block_dev, int partition);
Dan Murphy773b5942014-01-16 11:23:29 -0600205
Jeroen Hofsteece048222014-10-08 22:58:07 +0200206void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image);
207
Guillaume GARDET592f9222014-10-15 17:53:12 +0200208/* SPL EXT image functions */
Simon Glassb4a6c2a2016-09-24 18:20:14 -0600209int spl_load_image_ext(struct spl_image_info *spl_image,
210 struct blk_desc *block_dev, int partition,
Simon Glass4101f682016-02-29 15:25:34 -0700211 const char *filename);
Simon Glassb4a6c2a2016-09-24 18:20:14 -0600212int spl_load_image_ext_os(struct spl_image_info *spl_image,
213 struct blk_desc *block_dev, int partition);
Guillaume GARDET592f9222014-10-15 17:53:12 +0200214
Simon Glass070d00b2015-06-23 15:39:10 -0600215/**
Eddie Cai340f4182017-03-15 08:43:28 -0600216 * spl_early_init() - Set up device tree and driver model in SPL if enabled
Simon Glass070d00b2015-06-23 15:39:10 -0600217 *
218 * Call this function in board_init_f() if you want to use device tree and
Eddie Cai340f4182017-03-15 08:43:28 -0600219 * driver model early, before board_init_r() is called.
220 *
221 * If this is not called, then driver model will be inactive in SPL's
222 * board_init_f(), and no device tree will be available.
223 */
224int spl_early_init(void);
225
226/**
227 * spl_init() - Set up device tree and driver model in SPL if enabled
228 *
229 * You can optionally call spl_early_init(), then optionally call spl_init().
230 * This function will be called from board_init_r() if not called earlier.
231 *
232 * Both spl_early_init() and spl_init() perform a similar function except that
233 * the latter will not set up the malloc() area if
234 * CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN is enabled, since it is assumed to
235 * already be done by a calll to spl_relocate_stack_gd() before board_init_r()
236 * is reached.
237 *
238 * This function will be called from board_init_r() if not called earlier.
Simon Glass070d00b2015-06-23 15:39:10 -0600239 *
240 * If this is not called, then driver model will be inactive in SPL's
241 * board_init_f(), and no device tree will be available.
242 */
243int spl_init(void);
244
Tom Rini47f7bca2012-08-13 12:03:19 -0700245#ifdef CONFIG_SPL_BOARD_INIT
246void spl_board_init(void);
247#endif
Simon Glass32ba8952015-05-13 07:02:24 -0600248
249/**
250 * spl_was_boot_source() - check if U-Boot booted from SPL
251 *
252 * This will normally be true, but if U-Boot jumps to second U-Boot, it will
253 * be false. This should be implemented by board-specific code.
254 *
255 * @return true if U-Boot booted from SPL, else false
256 */
257bool spl_was_boot_source(void);
258
B, Ravi52f2acc2016-07-28 17:39:16 +0530259/**
260 * spl_dfu_cmd- run dfu command with chosen mmc device interface
261 * @param usb_index - usb controller number
262 * @param mmc_dev - mmc device nubmer
263 *
264 * @return 0 on success, otherwise error code
265 */
266int spl_dfu_cmd(int usbctrl, char *dfu_alt_info, char *interface, char *devstr);
Simon Glasse50d76c2016-09-24 18:19:51 -0600267
Marek Vasut09410c62016-12-01 02:06:35 +0100268int spl_mmc_load_image(struct spl_image_info *spl_image,
269 struct spl_boot_device *bootdev);
270
Tom Rini47f7bca2012-08-13 12:03:19 -0700271#endif