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 
12 struct cmd_tbl;
13 
14 #define BOOTM_ERR_RESET		(-1)
15 #define BOOTM_ERR_OVERLAP		(-2)
16 #define BOOTM_ERR_UNIMPLEMENTED	(-3)
17 
18 /*
19  *  Continue booting an OS image; caller already has:
20  *  - copied image header to global variable `header'
21  *  - checked header magic number, checksums (both header & image),
22  *  - verified image architecture (PPC) and type (KERNEL or MULTI),
23  *  - loaded (first part of) image to header load address,
24  *  - disabled interrupts.
25  *
26  * @flag: Flags indicating what to do (BOOTM_STATE_...)
27  * @argc: Number of arguments. Note that the arguments are shifted down
28  *	 so that 0 is the first argument not processed by U-Boot, and
29  *	 argc is adjusted accordingly. This avoids confusion as to how
30  *	 many arguments are available for the OS.
31  * @images: Pointers to os/initrd/fdt
32  * @return 1 on error. On success the OS boots so this function does
33  * not return.
34  */
35 typedef int boot_os_fn(int flag, int argc, char *const argv[],
36 			bootm_headers_t *images);
37 
38 extern boot_os_fn do_bootm_linux;
39 extern boot_os_fn do_bootm_vxworks;
40 
41 int do_bootelf(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]);
42 void lynxkdi_boot(image_header_t *hdr);
43 
44 boot_os_fn *bootm_os_get_boot_func(int os);
45 
46 #if defined(CONFIG_FIT_SIGNATURE)
47 int bootm_host_load_images(const void *fit, int cfg_noffset);
48 #endif
49 
50 int boot_selected_os(int argc, char *const argv[], int state,
51 		     bootm_headers_t *images, boot_os_fn *boot_fn);
52 
53 ulong bootm_disable_interrupts(void);
54 
55 /* This is a special function used by booti/bootz */
56 int bootm_find_images(int flag, int argc, char *const argv[], ulong start,
57 		      ulong size);
58 
59 int do_bootm_states(struct cmd_tbl *cmdtp, int flag, int argc,
60 		    char *const argv[], int states, bootm_headers_t *images,
61 		    int boot_progress);
62 
63 void arch_preboot_os(void);
64 
65 /*
66  * boards should define this to disable devices when EFI exits from boot
67  * services.
68  *
69  * TODO(sjg@chromium.org>): Update this to use driver model's device_remove().
70  */
71 void board_quiesce_devices(void);
72 
73 /**
74  * switch_to_non_secure_mode() - switch to non-secure mode
75  */
76 void switch_to_non_secure_mode(void);
77 
78 /* Flags to control bootm_process_cmdline() */
79 enum bootm_cmdline_t {
80 	BOOTM_CL_SILENT	= 1 << 0,	/* Do silent console processing */
81 	BOOTM_CL_SUBST	= 1 << 1,	/* Do substitution */
82 
83 	BOOTM_CL_ALL	= 3,		/* All substitutions */
84 };
85 
86 /**
87  * arch_preboot_os() - arch specific configuration before booting
88  */
89 void arch_preboot_os(void);
90 
91 /**
92  * board_preboot_os() - board specific configuration before booting
93  */
94 void board_preboot_os(void);
95 
96 /*
97  * bootm_process_cmdline() - Process fix-ups for the command line
98  *
99  * This handles:
100  *
101  *  - making Linux boot silently if requested ('silent_linux' envvar)
102  *  - performing substitutions in the command line ('bootargs_subst' envvar)
103  *
104  * @maxlen must provide enough space for the string being processed plus the
105  * resulting string
106  *
107  * @buf: buffer holding commandline string to adjust
108  * @maxlen: Maximum length of buffer at @buf (including \0)
109  * @flags: Flags to control what happens (see bootm_cmdline_t)
110  * @return 0 if OK, -ENOMEM if out of memory, -ENOSPC if the commandline is too
111  *	long
112  */
113 int bootm_process_cmdline(char *buf, int maxlen, int flags);
114 
115 /**
116  * bootm_process_cmdline_env() - Process fix-ups for the command line
117  *
118  * Updates the 'bootargs' envvar as required. This handles:
119  *
120  *  - making Linux boot silently if requested ('silent_linux' envvar)
121  *  - performing substitutions in the command line ('bootargs_subst' envvar)
122  *
123  * @flags: Flags to control what happens (see bootm_cmdline_t)
124  * @return 0 if OK, -ENOMEM if out of memory
125  */
126 int bootm_process_cmdline_env(int flags);
127 
128 #endif
129