blob: 59a20595f51d2e3ca2b87de79ecb5f3c95c0acc6 [file] [log] [blame]
Tom Rini10e47792018-05-06 17:58:06 -04001/* SPDX-License-Identifier: GPL-2.0+ */
Simon Glass20bf89a2012-02-15 15:51:15 -08002/*
3 * Copyright (c) 2011-2012 The Chromium OS Authors.
Simon Glass20bf89a2012-02-15 15:51:15 -08004 */
5
6#ifndef __SANDBOX_STATE_H
7#define __SANDBOX_STATE_H
8
Simon Glass8a3e0352012-02-15 15:51:16 -08009#include <config.h>
Stephen Warren859f2562016-05-12 12:03:35 -060010#include <sysreset.h>
Simon Glassf498e432013-11-10 10:27:02 -070011#include <stdbool.h>
Simon Glassfc1ebd32018-09-15 00:50:56 -060012#include <linux/list.h>
Simon Glassd7c8d8d2013-11-10 10:27:04 -070013#include <linux/stringify.h>
Simon Glass8a3e0352012-02-15 15:51:16 -080014
Simon Glass678ef472014-02-27 13:26:22 -070015/**
16 * Selects the behavior of the serial terminal.
17 *
18 * If Ctrl-C is processed by U-Boot, then the only way to quit sandbox is with
19 * the 'reset' command, or equivalent.
20 *
21 * If the terminal is cooked, then Ctrl-C will terminate U-Boot, and the
22 * command line will not be quite such a faithful emulation.
23 *
24 * Options are:
25 *
26 * raw-with-sigs - Raw, but allow signals (Ctrl-C will quit)
27 * raw - Terminal is always raw
28 * cooked - Terminal is always cooked
29 */
30enum state_terminal_raw {
31 STATE_TERM_RAW_WITH_SIGS, /* Default */
32 STATE_TERM_RAW,
33 STATE_TERM_COOKED,
34
35 STATE_TERM_COUNT,
36};
37
Mike Frysinger1d8e57c2013-12-03 16:43:26 -070038struct sandbox_spi_info {
Simon Glass95429fe2014-10-13 23:41:57 -060039 struct udevice *emul;
Mike Frysinger1d8e57c2013-12-03 16:43:26 -070040};
41
maxims@google.comdaea6d42017-04-17 12:00:21 -070042struct sandbox_wdt_info {
43 unsigned long long counter;
44 uint reset_count;
45 bool running;
46};
47
Simon Glassfc1ebd32018-09-15 00:50:56 -060048/**
49 * struct sandbox_mapmem_entry - maps pointers to/from U-Boot addresses
50 *
51 * When map_to_sysmem() is called with an address outside sandbox's emulated
52 * RAM, a record is created with a tag that can be used to reference that
53 * pointer. When map_sysmem() is called later with that tag, the pointer will
54 * be returned, just as it would for a normal sandbox address.
55 *
56 * @tag: Address tag (a value which U-Boot uses to refer to the address)
57 * @ptr: Associated pointer for that tag
58 */
59struct sandbox_mapmem_entry {
60 ulong tag;
61 void *ptr;
62 struct list_head sibling_node;
63};
64
Simon Glass20bf89a2012-02-15 15:51:15 -080065/* The complete state of the test system */
66struct sandbox_state {
67 const char *cmd; /* Command to execute */
Simon Glassf498e432013-11-10 10:27:02 -070068 bool interactive; /* Enable cmdline after execute */
Sjoerd Simons335f4702015-04-30 22:16:09 +020069 bool run_distro_boot; /* Automatically run distro bootcommands */
Simon Glass15393432013-04-20 08:42:41 +000070 const char *fdt_fname; /* Filename of FDT binary */
Simon Glass8a3e0352012-02-15 15:51:16 -080071 const char *parse_err; /* Error to report from parsing */
72 int argc; /* Program arguments */
Simon Glasse9906532014-02-27 13:26:16 -070073 char **argv; /* Command line arguments */
Simon Glassf0b534f2022-10-20 18:23:02 -060074 const char *jumped_fname; /* Jumped from previous U-Boot */
75 const char *prog_fname; /* U-Boot executable filename */
Simon Glass9dd10bf2013-11-10 10:27:03 -070076 uint8_t *ram_buf; /* Emulated RAM buffer */
Heinrich Schuchardtfff251e2020-06-07 18:47:35 +020077 unsigned long ram_size; /* Size of RAM buffer */
Simon Glass9dd10bf2013-11-10 10:27:03 -070078 const char *ram_buf_fname; /* Filename to use for RAM buffer */
Simon Glass47acfc62014-02-27 13:26:23 -070079 bool ram_buf_rm; /* Remove RAM buffer file after read */
Simon Glass9dd10bf2013-11-10 10:27:03 -070080 bool write_ram_buf; /* Write RAM buffer on exit */
Simon Glassd7c8d8d2013-11-10 10:27:04 -070081 const char *state_fname; /* File containing sandbox state */
82 void *state_fdt; /* Holds saved state for sandbox */
83 bool read_state; /* Read sandbox state on startup */
84 bool write_state; /* Write sandbox state on exit */
85 bool ignore_missing_state_on_read; /* No error if state missing */
Simon Glassb9ddbf42014-02-27 13:26:19 -070086 bool show_lcd; /* Show LCD on start-up */
Simon Glassf91de0b2020-02-03 07:36:13 -070087 bool double_lcd; /* Double display size for high-DPI */
Stephen Warren859f2562016-05-12 12:03:35 -060088 enum sysreset_t last_sysreset; /* Last system reset type */
89 bool sysreset_allowed[SYSRESET_COUNT]; /* Allowed system reset types */
Simon Glass678ef472014-02-27 13:26:22 -070090 enum state_terminal_raw term_raw; /* Terminal raw/cooked */
Simon Glassb25fa312015-11-08 23:47:43 -070091 bool skip_delays; /* Ignore any time delays (for test) */
Simon Glassfe6d12a2015-11-08 23:47:50 -070092 bool show_test_output; /* Don't suppress stdout in tests */
Simon Glass4e9a64d2018-10-01 11:55:11 -060093 int default_log_level; /* Default log level for sandbox */
Simon Glass24a284a2018-11-23 21:29:29 -070094 bool ram_buf_read; /* true if we read the RAM buffer */
Simon Glassa4e289b2020-10-25 20:38:28 -060095 bool run_unittests; /* Run unit tests */
Simon Glasseff96582020-10-25 20:38:33 -060096 const char *select_unittests; /* Unit test to run */
Simon Glassb78cc9b2021-03-22 18:21:01 +130097 bool handle_signals; /* Handle signals within sandbox */
Simon Glassd8c60172021-07-24 15:14:39 -060098 bool autoboot_keyed; /* Use keyed-autoboot feature */
Simon Glass66014cc2023-01-17 10:47:27 -070099 bool disable_eth; /* Disable Ethernet devices */
Simon Glass4937be02023-01-17 10:48:02 -0700100 bool disable_sf_bootdevs; /* Don't bind SPI flash bootdevs */
Mike Frysinger1d8e57c2013-12-03 16:43:26 -0700101
102 /* Pointer to information for each SPI bus/cs */
103 struct sandbox_spi_info spi[CONFIG_SANDBOX_SPI_MAX_BUS]
104 [CONFIG_SANDBOX_SPI_MAX_CS];
maxims@google.comdaea6d42017-04-17 12:00:21 -0700105
106 /* Information about Watchdog */
107 struct sandbox_wdt_info wdt;
Simon Glassfc1ebd32018-09-15 00:50:56 -0600108
109 ulong next_tag; /* Next address tag to allocate */
110 struct list_head mapmem_head; /* struct sandbox_mapmem_entry */
Benjamin Gaignarda550b542018-11-27 13:49:50 +0100111 bool hwspinlock; /* Hardware Spinlock status */
Simon Glass0a341a72019-09-25 08:56:09 -0600112 bool allow_memio; /* Allow readl() etc. to work */
Simon Glass17d133b2019-02-16 20:24:45 -0700113
Simon Glassf17b9672022-09-06 20:27:09 -0600114 void *other_fdt_buf; /* 'other' FDT blob used by tests */
115 int other_size; /* size of other FDT blob */
116
Simon Glass17d133b2019-02-16 20:24:45 -0700117 /*
118 * This struct is getting large.
119 *
120 * Consider putting test data in driver-private structs, like
121 * sandbox_pch.c.
122 *
123 * If you add new members, please put them above this comment.
124 */
Simon Glass20bf89a2012-02-15 15:51:15 -0800125};
126
Simon Glassd7c8d8d2013-11-10 10:27:04 -0700127/* Minimum space we guarantee in the state FDT when calling read/write*/
128#define SANDBOX_STATE_MIN_SPACE 0x1000
129
130/**
131 * struct sandbox_state_io - methods to saved/restore sandbox state
132 * @name: Name of of the device tree node, also the name of the variable
133 * holding this data so it should be an identifier (use underscore
134 * instead of minus)
135 * @compat: Compatible string for the node containing this state
136 *
137 * @read: Function to read state from FDT
138 * If data is available, then blob and node will provide access to it. If
139 * not (blob == NULL and node == -1) this function should set up an empty
140 * data set for start-of-day.
141 * @param blob: Pointer to device tree blob, or NULL if no data to read
142 * @param node: Node offset to read from
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +0100143 * Return: 0 if OK, -ve on error
Simon Glassd7c8d8d2013-11-10 10:27:04 -0700144 *
145 * @write: Function to write state to FDT
146 * The caller will ensure that there is a node ready for the state. The
147 * node may already contain the old state, in which case it should be
148 * overridden. There is guaranteed to be SANDBOX_STATE_MIN_SPACE bytes
149 * of free space, so error checking is not required for fdt_setprop...()
150 * calls which add up to less than this much space.
151 *
152 * For adding larger properties, use state_setprop().
153 *
154 * @param blob: Device tree blob holding state
155 * @param node: Node to write our state into
156 *
157 * Note that it is possible to save data as large blobs or as individual
158 * hierarchical properties. However, unless you intend to keep state files
159 * around for a long time and be able to run an old state file on a new
160 * sandbox, it might not be worth using individual properties for everything.
161 * This is certainly supported, it is just a matter of the effort you wish
162 * to put into the state read/write feature.
163 */
164struct sandbox_state_io {
165 const char *name;
166 const char *compat;
167 int (*write)(void *blob, int node);
168 int (*read)(const void *blob, int node);
169};
170
171/**
172 * SANDBOX_STATE_IO - Declare sandbox state to read/write
173 *
174 * Sandbox permits saving state from one run and restoring it in another. This
175 * allows the test system to retain state between runs and thus better
176 * emulate a real system. Examples of state that might be useful to save are
177 * the emulated GPIOs pin settings, flash memory contents and TPM private
178 * data. U-Boot memory contents is dealth with separately since it is large
179 * and it is not normally useful to save it (since a normal system does not
180 * preserve DRAM between runs). See the '-m' option for this.
181 *
182 * See struct sandbox_state_io above for member documentation.
183 */
184#define SANDBOX_STATE_IO(_name, _compat, _read, _write) \
185 ll_entry_declare(struct sandbox_state_io, _name, state_io) = { \
186 .name = __stringify(_name), \
187 .read = _read, \
188 .write = _write, \
189 .compat = _compat, \
190 }
191
Simon Glass20bf89a2012-02-15 15:51:15 -0800192/**
Simon Glass20bf89a2012-02-15 15:51:15 -0800193 * Gets a pointer to the current state.
194 *
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +0100195 * Return: pointer to state
Simon Glass20bf89a2012-02-15 15:51:15 -0800196 */
197struct sandbox_state *state_get_current(void);
198
199/**
Simon Glassd7c8d8d2013-11-10 10:27:04 -0700200 * Read the sandbox state from the supplied device tree file
201 *
202 * This calls all registered state handlers to read in the sandbox state
203 * from a previous test run.
204 *
205 * @param state Sandbox state to update
206 * @param fname Filename of device tree file to read from
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +0100207 * Return: 0 if OK, -ve on error
Simon Glassd7c8d8d2013-11-10 10:27:04 -0700208 */
209int sandbox_read_state(struct sandbox_state *state, const char *fname);
210
211/**
212 * Write the sandbox state to the supplied device tree file
213 *
214 * This calls all registered state handlers to write out the sandbox state
215 * so that it can be preserved for a future test run.
216 *
217 * If the file exists it is overwritten.
218 *
219 * @param state Sandbox state to update
220 * @param fname Filename of device tree file to write to
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +0100221 * Return: 0 if OK, -ve on error
Simon Glassd7c8d8d2013-11-10 10:27:04 -0700222 */
223int sandbox_write_state(struct sandbox_state *state, const char *fname);
224
225/**
226 * Add a property to a sandbox state node
227 *
228 * This is equivalent to fdt_setprop except that it automatically enlarges
229 * the device tree if necessary. That means it is safe to write any amount
230 * of data here.
231 *
232 * This function can only be called from within struct sandbox_state_io's
233 * ->write method, i.e. within state I/O drivers.
234 *
235 * @param node Device tree node to write to
236 * @param prop_name Property to write
237 * @param data Data to write into property
238 * @param size Size of data to write into property
239 */
240int state_setprop(int node, const char *prop_name, const void *data, int size);
241
242/**
Simon Glassb25fa312015-11-08 23:47:43 -0700243 * Control skipping of time delays
244 *
245 * Some tests have unnecessay time delays (e.g. USB). Allow these to be
246 * skipped to speed up testing
247 *
248 * @param skip_delays true to skip delays from now on, false to honour delay
249 * requests
250 */
251void state_set_skip_delays(bool skip_delays);
252
253/**
254 * See if delays should be skipped
255 *
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +0100256 * Return: true if delays should be skipped, false if they should be honoured
Simon Glassb25fa312015-11-08 23:47:43 -0700257 */
258bool state_get_skip_delays(void);
259
260/**
Simon Glass36d08d822017-05-18 20:09:13 -0600261 * state_reset_for_test() - Reset ready to re-run tests
262 *
263 * This clears out any test state ready for another test run.
264 */
265void state_reset_for_test(struct sandbox_state *state);
266
267/**
Simon Glass46508c92018-11-15 18:44:03 -0700268 * state_show() - Show information about the sandbox state
269 *
270 * @param state Sandbox state to show
271 */
272void state_show(struct sandbox_state *state);
273
274/**
Simon Glassd74c4612022-09-06 20:27:08 -0600275 * state_get_rel_filename() - Get a filename relative to the executable
276 *
277 * This uses argv[0] to obtain a filename path
278 *
279 * @rel_path: Relative path to build, e.g. "arch/sandbox/dts/test.dtb". Must not
280 * have a trailing /
281 * @buf: Buffer to use to return the filename
282 * @size: Size of buffer
283 * @return length of filename (including terminator), -ENOSPC if @size is too
284 * small
285 */
286int state_get_rel_filename(const char *rel_path, char *buf, int size);
287
288/**
Simon Glassf17b9672022-09-06 20:27:09 -0600289 * state_load_other_fdt() - load the 'other' FDT into a buffer
290 *
291 * This loads the other.dtb file into a buffer. This is typically used in tests.
292 *
293 * @bufp: Place to put allocated buffer pointer. The buffer is read using
294 * os_read_file() which calls os_malloc(), so does affect U-Boot's own malloc()
295 * space
296 * @sizep: Returns the size of the buffer
297 * @return 0 if OK, -ve on error
298 */
299int state_load_other_fdt(const char **bufp, int *sizep);
300
301/**
Simon Glass20bf89a2012-02-15 15:51:15 -0800302 * Initialize the test system state
303 */
304int state_init(void);
305
Simon Glass9dd10bf2013-11-10 10:27:03 -0700306/**
307 * Uninitialize the test system state, writing out state if configured to
308 * do so.
309 *
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +0100310 * Return: 0 if OK, -ve on error
Simon Glass9dd10bf2013-11-10 10:27:03 -0700311 */
312int state_uninit(void);
313
Simon Glass20bf89a2012-02-15 15:51:15 -0800314#endif