1/* SPDX-License-Identifier: GPL-2.0+ */
2/*
3 * (C) Copyright 2000-2009
4 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
5 */
6
7#ifndef _BOOTM_H
8#define _BOOTM_H
9
10#include <image.h>
11
12struct boot_params;
13struct cmd_tbl;
14
15#define BOOTM_ERR_RESET		(-1)
16#define BOOTM_ERR_OVERLAP		(-2)
17#define BOOTM_ERR_UNIMPLEMENTED	(-3)
18
19/**
20 * struct bootm_info() - information used when processing images to boot
21 *
22 * These mirror the first three arguments of the bootm command. They are
23 * designed to handle any type of image, but typically it is a FIT.
24 *
25 * @addr_img: Address of image to bootm, as passed to
26 *	genimg_get_kernel_addr_fit() for processing:
27 *
28 *    NULL: Usees default load address, i.e. image_load_addr
29 *    <addr>: Uses hex address
30 *
31 * For FIT:
32 *    "[<addr>]#<conf>": Uses address (or image_load_addr) and also specifies
33 *	the FIT configuration to use
34 *    "[<addr>]:<subimage>": Uses address (or image_load_addr) and also
35 *	specifies the subimage name containing the OS
36 *
37 * @conf_ramdisk: Address (or with FIT, the name) of the ramdisk image, as
38 *	passed to boot_get_ramdisk() for processing, or NULL for none
39 * @conf_fdt: Address (or with FIT, the name) of the FDT image, as passed to
40 *	boot_get_fdt() for processing, or NULL for none
41 * @boot_progress: true to show boot progress
42 * @images: images information
43 * @cmd_name: command which invoked this operation, e.g. "bootm"
44 * @argc: Number of arguments to the command (excluding the actual command).
45 *	This is 0 if there are no arguments
46 * @argv: NULL-terminated list of arguments, or NULL if there are no arguments
47 */
48struct bootm_info {
49	const char *addr_img;
50	const char *conf_ramdisk;
51	const char *conf_fdt;
52	bool boot_progress;
53	struct bootm_headers *images;
54	const char *cmd_name;
55	int argc;
56	char *const *argv;
57};
58
59/**
60 * bootm_init() - Set up a bootm_info struct with useful defaults
61 *
62 * Set up the struct with default values for all members:
63 * @boot_progress is set to true and @images is set to the global images
64 * variable. Everything else is set to NULL except @argc which is 0
65 */
66void bootm_init(struct bootm_info *bmi);
67
68/*
69 *  Continue booting an OS image; caller already has:
70 *  - copied image header to global variable `header'
71 *  - checked header magic number, checksums (both header & image),
72 *  - verified image architecture (PPC) and type (KERNEL or MULTI),
73 *  - loaded (first part of) image to header load address,
74 *  - disabled interrupts.
75 *
76 * @flag: Flags indicating what to do (BOOTM_STATE_...)
77 * bmi: Bootm information
78 * Return: 1 on error. On success the OS boots so this function does
79 * not return.
80 */
81typedef int boot_os_fn(int flag, struct bootm_info *bmi);
82
83extern boot_os_fn do_bootm_linux;
84extern boot_os_fn do_bootm_vxworks;
85
86int do_bootelf(struct cmd_tbl *cmdtp, int fglag, int argc, char *const argv[]);
87
88boot_os_fn *bootm_os_get_boot_func(int os);
89
90#if defined(CONFIG_FIT_SIGNATURE)
91int bootm_host_load_images(const void *fit, int cfg_noffset);
92#endif
93
94int boot_selected_os(int state, struct bootm_info *bmi, boot_os_fn *boot_fn);
95
96ulong bootm_disable_interrupts(void);
97
98/**
99 * bootm_find_images() - find and locate various images
100 *
101 * @img_addr: Address of image being loaded
102 * @conf_ramdisk: Indicates the ramdisk to use (typically second arg of bootm)
103 * @conf_fdt: Indicates the FDT to use (typically third arg of bootm)
104 * @start: OS image start address
105 * @size: OS image size
106 *
107 * boot_find_images() will attempt to load an available ramdisk,
108 * flattened device tree, as well as specifically marked
109 * "loadable" images (loadables are FIT only)
110 *
111 * Note: bootm_find_images will skip an image if it is not found
112 *
113 * This is a special function used by booti/bootz
114 *
115 * Return:
116 *     0, if all existing images were loaded correctly
117 *     1, if an image is found but corrupted, or invalid
118 */
119int bootm_find_images(ulong img_addr, const char *conf_ramdisk,
120		      const char *conf_fdt, ulong start, ulong size);
121
122/*
123 * Measure the boot images. Measurement is the process of hashing some binary
124 * data and storing it into secure memory, i.e. TPM PCRs. In addition, each
125 * measurement is logged into the platform event log such that the operating
126 * system can access it and perform attestation of the boot.
127 *
128 * @images:	The structure containing the various images to boot (linux,
129 *		initrd, dts, etc.)
130 */
131int bootm_measure(struct bootm_headers *images);
132
133/**
134 * bootm_run_states() - Execute selected states of the bootm command.
135 *
136 * Note that if states contains more than one flag it MUST contain
137 * BOOTM_STATE_START, since this handles the addr_fit, conf_ramdisk and conf_fit
138 * members of @bmi
139 *
140 * Also note that aside from boot_os_fn functions and bootm_load_os, no other
141 * functions store the return value of in 'ret' may use a negative return
142 * value, without special handling.
143 *
144 * @bmi: bootm information
145 * @states	Mask containing states to run (BOOTM_STATE_...)
146 * Return: 0 if ok, something else on error. Some errors will cause this
147 *	function to perform a reboot! If states contains BOOTM_STATE_OS_GO
148 *	then the intent is to boot an OS, so this function will not return
149 *	unless the image type is standalone.
150 */
151int bootm_run_states(struct bootm_info *bmi, int states);
152
153/**
154 * boot_run() - Run the entire bootm/booti/bootz process
155 *
156 * This runs through the boot process from start to finish, with a base set of
157 * states, along with the extra ones supplied.
158 *
159 * This uses bootm_run_states().
160 *
161 * Note that it is normally easier to use bootm_run(), etc. since they handle
162 * the extra states correctly.
163 *
164 * @bmi: bootm information
165 * @cmd: command being run, NULL if none
166 * @extra_states: Mask of extra states to use for the boot
167 * Return: 0 if ok, something else on error
168 */
169int boot_run(struct bootm_info *bmi, const char *cmd, int extra_states);
170
171/**
172 * bootm_run() - Run the entire bootm process
173 *
174 * This runs through the bootm process from start to finish, using the default
175 * set of states.
176 *
177 * This uses bootm_run_states().
178 *
179 * @bmi: bootm information
180 * Return: 0 if ok, something else on error
181 */
182int bootm_run(struct bootm_info *bmi);
183
184/**
185 * bootz_run() - Run the entire bootz process
186 *
187 * This runs through the bootz process from start to finish, using the default
188 * set of states.
189 *
190 * This uses bootm_run_states().
191 *
192 * @bmi: bootm information
193 * Return: 0 if ok, something else on error
194 */
195int bootz_run(struct bootm_info *bmi);
196
197/**
198 * booti_run() - Run the entire booti process
199 *
200 * This runs through the booti process from start to finish, using the default
201 * set of states.
202 *
203 * This uses bootm_run_states().
204 *
205 * @bmi: bootm information
206 * Return: 0 if ok, something else on error
207 */
208int booti_run(struct bootm_info *bmi);
209
210void arch_preboot_os(void);
211
212/*
213 * boards should define this to disable devices when EFI exits from boot
214 * services.
215 *
216 * TODO(sjg@chromium.org>): Update this to use driver model's device_remove().
217 */
218void board_quiesce_devices(void);
219
220/**
221 * switch_to_non_secure_mode() - switch to non-secure mode
222 */
223void switch_to_non_secure_mode(void);
224
225/* Flags to control bootm_process_cmdline() */
226enum bootm_cmdline_t {
227	BOOTM_CL_SILENT	= 1 << 0,	/* Do silent console processing */
228	BOOTM_CL_SUBST	= 1 << 1,	/* Do substitution */
229
230	BOOTM_CL_ALL	= 3,		/* All substitutions */
231};
232
233/**
234 * arch_preboot_os() - arch specific configuration before booting
235 */
236void arch_preboot_os(void);
237
238/**
239 * board_preboot_os() - board specific configuration before booting
240 */
241void board_preboot_os(void);
242
243/*
244 * bootm_process_cmdline() - Process fix-ups for the command line
245 *
246 * This handles:
247 *
248 *  - making Linux boot silently if requested ('silent_linux' envvar)
249 *  - performing substitutions in the command line ('bootargs_subst' envvar)
250 *
251 * @maxlen must provide enough space for the string being processed plus the
252 * resulting string
253 *
254 * @buf: buffer holding commandline string to adjust
255 * @maxlen: Maximum length of buffer at @buf (including \0)
256 * @flags: Flags to control what happens (see bootm_cmdline_t)
257 * Return: 0 if OK, -ENOMEM if out of memory, -ENOSPC if the commandline is too
258 *	long
259 */
260int bootm_process_cmdline(char *buf, int maxlen, int flags);
261
262/**
263 * bootm_process_cmdline_env() - Process fix-ups for the command line
264 *
265 * Updates the 'bootargs' envvar as required. This handles:
266 *
267 *  - making Linux boot silently if requested ('silent_linux' envvar)
268 *  - performing substitutions in the command line ('bootargs_subst' envvar)
269 *
270 * @flags: Flags to control what happens (see bootm_cmdline_t)
271 * Return: 0 if OK, -ENOMEM if out of memory
272 */
273int bootm_process_cmdline_env(int flags);
274
275/**
276 * zboot_run() - Run through the various steps to boot a zimage
277 *
278 * Boot a zimage, given the component parts
279 *
280 * @addr: Address where the bzImage is moved before booting, either
281 *	BZIMAGE_LOAD_ADDR or ZIMAGE_LOAD_ADDR
282 * @size: Size of bzImage, or 0 to detect this
283 * @initrd: Address of the initial ramdisk, or 0 if none
284 * @initrd_size: Size of the initial ramdisk, or 0 if none
285 * @base_addr: If non-zero, this indicates that the boot parameters have already
286 *	been loaded by the caller to this address, so the load_zimage() call
287 *	in zboot_load() will be skipped when booting
288 * @cmdline: If non-NULL, the environment variable containing the command line
289 *	to use for booting
290 * Return: -EFAULT on error (normally it does not return)
291 */
292int zboot_run(ulong addr, ulong size, ulong initrd, ulong initrd_size,
293	      ulong base, char *cmdline);
294
295/*
296 * zimage_get_kernel_version() - Get the version string from a kernel
297 *
298 * @params: boot_params pointer
299 * @kernel_base: base address of kernel
300 * Return: Kernel version as a NUL-terminated string
301 */
302const char *zimage_get_kernel_version(struct boot_params *params,
303				      void *kernel_base);
304
305/**
306 * zimage_dump() - Dump the metadata of a zimage
307 *
308 * This shows all available information in a zimage that has been loaded.
309 *
310 * @base_ptr: Pointer to the boot parameters, typically at address
311 *	DEFAULT_SETUP_BASE
312 * @show_cmdline: true to show the full command line
313 */
314void zimage_dump(struct boot_params *base_ptr, bool show_cmdline);
315
316/*
317 * bootm_boot_start() - Boot an image at the given address
318 *
319 * @addr: Image address
320 * @cmdline: Command line to set
321 */
322int bootm_boot_start(ulong addr, const char *cmdline);
323
324#endif
325