xref: /openbmc/u-boot/arch/sandbox/cpu/start.c (revision ecab65e4)
1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3  * Copyright (c) 2011-2012 The Chromium OS Authors.
4  */
5 
6 #include <common.h>
7 #include <errno.h>
8 #include <os.h>
9 #include <cli.h>
10 #include <malloc.h>
11 #include <asm/getopt.h>
12 #include <asm/io.h>
13 #include <asm/sections.h>
14 #include <asm/state.h>
15 
16 DECLARE_GLOBAL_DATA_PTR;
17 
18 int sandbox_early_getopt_check(void)
19 {
20 	struct sandbox_state *state = state_get_current();
21 	struct sandbox_cmdline_option **sb_opt = __u_boot_sandbox_option_start;
22 	size_t num_options = __u_boot_sandbox_option_count();
23 	size_t i;
24 	int max_arg_len, max_noarg_len;
25 
26 	/* parse_err will be a string of the faulting option */
27 	if (!state->parse_err)
28 		return 0;
29 
30 	if (strcmp(state->parse_err, "help")) {
31 		printf("u-boot: error: failed while parsing option: %s\n"
32 			"\ttry running with --help for more information.\n",
33 			state->parse_err);
34 		os_exit(1);
35 	}
36 
37 	printf(
38 		"u-boot, a command line test interface to U-Boot\n\n"
39 		"Usage: u-boot [options]\n"
40 		"Options:\n");
41 
42 	max_arg_len = 0;
43 	for (i = 0; i < num_options; ++i)
44 		max_arg_len = max((int)strlen(sb_opt[i]->flag), max_arg_len);
45 	max_noarg_len = max_arg_len + 7;
46 
47 	for (i = 0; i < num_options; ++i) {
48 		struct sandbox_cmdline_option *opt = sb_opt[i];
49 
50 		/* first output the short flag if it has one */
51 		if (opt->flag_short >= 0x100)
52 			printf("      ");
53 		else
54 			printf("  -%c, ", opt->flag_short);
55 
56 		/* then the long flag */
57 		if (opt->has_arg)
58 			printf("--%-*s <arg> ", max_arg_len, opt->flag);
59 		else
60 			printf("--%-*s", max_noarg_len, opt->flag);
61 
62 		/* finally the help text */
63 		printf("  %s\n", opt->help);
64 	}
65 
66 	os_exit(0);
67 }
68 
69 int misc_init_f(void)
70 {
71 	return sandbox_early_getopt_check();
72 }
73 
74 static int sandbox_cmdline_cb_help(struct sandbox_state *state, const char *arg)
75 {
76 	/* just flag to sandbox_early_getopt_check to show usage */
77 	return 1;
78 }
79 SANDBOX_CMDLINE_OPT_SHORT(help, 'h', 0, "Display help");
80 
81 #ifndef CONFIG_SPL_BUILD
82 int sandbox_main_loop_init(void)
83 {
84 	struct sandbox_state *state = state_get_current();
85 
86 	/* Execute command if required */
87 	if (state->cmd || state->run_distro_boot) {
88 		int retval = 0;
89 
90 		cli_init();
91 
92 #ifdef CONFIG_CMDLINE
93 		if (state->cmd)
94 			retval = run_command_list(state->cmd, -1, 0);
95 
96 		if (state->run_distro_boot)
97 			retval = cli_simple_run_command("run distro_bootcmd",
98 							0);
99 #endif
100 		if (!state->interactive)
101 			os_exit(retval);
102 	}
103 
104 	return 0;
105 }
106 #endif
107 
108 static int sandbox_cmdline_cb_boot(struct sandbox_state *state,
109 				      const char *arg)
110 {
111 	state->run_distro_boot = true;
112 	return 0;
113 }
114 SANDBOX_CMDLINE_OPT_SHORT(boot, 'b', 0, "Run distro boot commands");
115 
116 static int sandbox_cmdline_cb_command(struct sandbox_state *state,
117 				      const char *arg)
118 {
119 	state->cmd = arg;
120 	return 0;
121 }
122 SANDBOX_CMDLINE_OPT_SHORT(command, 'c', 1, "Execute U-Boot command");
123 
124 static int sandbox_cmdline_cb_fdt(struct sandbox_state *state, const char *arg)
125 {
126 	state->fdt_fname = arg;
127 	return 0;
128 }
129 SANDBOX_CMDLINE_OPT_SHORT(fdt, 'd', 1, "Specify U-Boot's control FDT");
130 
131 static int sandbox_cmdline_cb_default_fdt(struct sandbox_state *state,
132 					  const char *arg)
133 {
134 	const char *fmt = "%s.dtb";
135 	char *fname;
136 	int len;
137 
138 	len = strlen(state->argv[0]) + strlen(fmt) + 1;
139 	fname = os_malloc(len);
140 	if (!fname)
141 		return -ENOMEM;
142 	snprintf(fname, len, fmt, state->argv[0]);
143 	state->fdt_fname = fname;
144 
145 	return 0;
146 }
147 SANDBOX_CMDLINE_OPT_SHORT(default_fdt, 'D', 0,
148 		"Use the default u-boot.dtb control FDT in U-Boot directory");
149 
150 static int sandbox_cmdline_cb_interactive(struct sandbox_state *state,
151 					  const char *arg)
152 {
153 	state->interactive = true;
154 	return 0;
155 }
156 
157 SANDBOX_CMDLINE_OPT_SHORT(interactive, 'i', 0, "Enter interactive mode");
158 
159 static int sandbox_cmdline_cb_jump(struct sandbox_state *state,
160 				   const char *arg)
161 {
162 	/* Remember to delete this U-Boot image later */
163 	state->jumped_fname = arg;
164 
165 	return 0;
166 }
167 SANDBOX_CMDLINE_OPT_SHORT(jump, 'j', 1, "Jumped from previous U-Boot");
168 
169 static int sandbox_cmdline_cb_memory(struct sandbox_state *state,
170 				     const char *arg)
171 {
172 	int err;
173 
174 	/* For now assume we always want to write it */
175 	state->write_ram_buf = true;
176 	state->ram_buf_fname = arg;
177 
178 	err = os_read_ram_buf(arg);
179 	if (err) {
180 		printf("Failed to read RAM buffer '%s': %d\n", arg, err);
181 		return err;
182 	}
183 	state->ram_buf_read = true;
184 
185 	return 0;
186 }
187 SANDBOX_CMDLINE_OPT_SHORT(memory, 'm', 1,
188 			  "Read/write ram_buf memory contents from file");
189 
190 static int sandbox_cmdline_cb_rm_memory(struct sandbox_state *state,
191 					const char *arg)
192 {
193 	state->ram_buf_rm = true;
194 
195 	return 0;
196 }
197 SANDBOX_CMDLINE_OPT(rm_memory, 0, "Remove memory file after reading");
198 
199 static int sandbox_cmdline_cb_state(struct sandbox_state *state,
200 				    const char *arg)
201 {
202 	state->state_fname = arg;
203 	return 0;
204 }
205 SANDBOX_CMDLINE_OPT_SHORT(state, 's', 1, "Specify the sandbox state FDT");
206 
207 static int sandbox_cmdline_cb_read(struct sandbox_state *state,
208 				   const char *arg)
209 {
210 	state->read_state = true;
211 	return 0;
212 }
213 SANDBOX_CMDLINE_OPT_SHORT(read, 'r', 0, "Read the state FDT on startup");
214 
215 static int sandbox_cmdline_cb_write(struct sandbox_state *state,
216 				    const char *arg)
217 {
218 	state->write_state = true;
219 	return 0;
220 }
221 SANDBOX_CMDLINE_OPT_SHORT(write, 'w', 0, "Write state FDT on exit");
222 
223 static int sandbox_cmdline_cb_ignore_missing(struct sandbox_state *state,
224 					     const char *arg)
225 {
226 	state->ignore_missing_state_on_read = true;
227 	return 0;
228 }
229 SANDBOX_CMDLINE_OPT_SHORT(ignore_missing, 'n', 0,
230 			  "Ignore missing state on read");
231 
232 static int sandbox_cmdline_cb_show_lcd(struct sandbox_state *state,
233 				       const char *arg)
234 {
235 	state->show_lcd = true;
236 	return 0;
237 }
238 SANDBOX_CMDLINE_OPT_SHORT(show_lcd, 'l', 0,
239 			  "Show the sandbox LCD display");
240 
241 static const char *term_args[STATE_TERM_COUNT] = {
242 	"raw-with-sigs",
243 	"raw",
244 	"cooked",
245 };
246 
247 static int sandbox_cmdline_cb_terminal(struct sandbox_state *state,
248 				       const char *arg)
249 {
250 	int i;
251 
252 	for (i = 0; i < STATE_TERM_COUNT; i++) {
253 		if (!strcmp(arg, term_args[i])) {
254 			state->term_raw = i;
255 			return 0;
256 		}
257 	}
258 
259 	printf("Unknown terminal setting '%s' (", arg);
260 	for (i = 0; i < STATE_TERM_COUNT; i++)
261 		printf("%s%s", i ? ", " : "", term_args[i]);
262 	puts(")\n");
263 
264 	return 1;
265 }
266 SANDBOX_CMDLINE_OPT_SHORT(terminal, 't', 1,
267 			  "Set terminal to raw/cooked mode");
268 
269 static int sandbox_cmdline_cb_verbose(struct sandbox_state *state,
270 				      const char *arg)
271 {
272 	state->show_test_output = true;
273 	return 0;
274 }
275 SANDBOX_CMDLINE_OPT_SHORT(verbose, 'v', 0, "Show test output");
276 
277 static int sandbox_cmdline_cb_log_level(struct sandbox_state *state,
278 					const char *arg)
279 {
280 	state->default_log_level = simple_strtol(arg, NULL, 10);
281 
282 	return 0;
283 }
284 SANDBOX_CMDLINE_OPT_SHORT(log_level, 'L', 1,
285 			  "Set log level (0=panic, 7=debug)");
286 
287 static int sandbox_cmdline_cb_show_of_platdata(struct sandbox_state *state,
288 					       const char *arg)
289 {
290 	state->show_of_platdata = true;
291 
292 	return 0;
293 }
294 SANDBOX_CMDLINE_OPT(show_of_platdata, 0, "Show of-platdata in SPL");
295 
296 int board_run_command(const char *cmdline)
297 {
298 	printf("## Commands are disabled. Please enable CONFIG_CMDLINE.\n");
299 
300 	return 1;
301 }
302 
303 static void setup_ram_buf(struct sandbox_state *state)
304 {
305 	/* Zero the RAM buffer if we didn't read it, to keep valgrind happy */
306 	if (!state->ram_buf_read) {
307 		memset(state->ram_buf, '\0', state->ram_size);
308 		printf("clear %p %x\n", state->ram_buf, state->ram_size);
309 	}
310 
311 	gd->arch.ram_buf = state->ram_buf;
312 	gd->ram_size = state->ram_size;
313 }
314 
315 void state_show(struct sandbox_state *state)
316 {
317 	char **p;
318 
319 	printf("Arguments:\n");
320 	for (p = state->argv; *p; p++)
321 		printf("%s ", *p);
322 	printf("\n");
323 }
324 
325 int main(int argc, char *argv[])
326 {
327 	struct sandbox_state *state;
328 	gd_t data;
329 	int ret;
330 
331 	ret = state_init();
332 	if (ret)
333 		goto err;
334 
335 	state = state_get_current();
336 	if (os_parse_args(state, argc, argv))
337 		return 1;
338 
339 	ret = sandbox_read_state(state, state->state_fname);
340 	if (ret)
341 		goto err;
342 
343 	memset(&data, '\0', sizeof(data));
344 	gd = &data;
345 #if CONFIG_VAL(SYS_MALLOC_F_LEN)
346 	gd->malloc_base = CONFIG_MALLOC_F_ADDR;
347 #endif
348 #if CONFIG_IS_ENABLED(LOG)
349 	gd->default_log_level = state->default_log_level;
350 #endif
351 	setup_ram_buf(state);
352 
353 	/* Do pre- and post-relocation init */
354 	board_init_f(0);
355 
356 	board_init_r(gd->new_gd, 0);
357 
358 	/* NOTREACHED - board_init_r() does not return */
359 	return 0;
360 
361 err:
362 	printf("Error %d\n", ret);
363 	return 1;
364 }
365