1 /* SPDX-License-Identifier: GPL-2.0+ */
3 * Copyright (c) 2011-2012 The Chromium OS Authors.
6 #ifndef __SANDBOX_STATE_H
7 #define __SANDBOX_STATE_H
12 #include <linux/list.h>
13 #include <linux/stringify.h>
16 * Selects the behavior of the serial terminal.
18 * If Ctrl-C is processed by U-Boot, then the only way to quit sandbox is with
19 * the 'reset' command, or equivalent.
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.
26 * raw-with-sigs - Raw, but allow signals (Ctrl-C will quit)
27 * raw - Terminal is always raw
28 * cooked - Terminal is always cooked
30 enum state_terminal_raw {
31 STATE_TERM_RAW_WITH_SIGS, /* Default */
38 struct sandbox_spi_info {
43 struct sandbox_wdt_info {
44 unsigned long long counter;
50 * struct sandbox_mapmem_entry - maps pointers to/from U-Boot addresses
52 * When map_to_sysmem() is called with an address outside sandbox's emulated
53 * RAM, a record is created with a tag that can be used to reference that
54 * pointer. When map_sysmem() is called later with that tag, the pointer will
55 * be returned, just as it would for a normal sandbox address.
57 * @tag: Address tag (a value which U-Boot uses to refer to the address)
58 * @ptr: Associated pointer for that tag
60 struct sandbox_mapmem_entry {
63 struct list_head sibling_node;
66 /* The complete state of the test system */
67 struct sandbox_state {
68 const char *cmd; /* Command to execute */
69 bool interactive; /* Enable cmdline after execute */
70 bool run_distro_boot; /* Automatically run distro bootcommands */
71 const char *fdt_fname; /* Filename of FDT binary */
72 const char *parse_err; /* Error to report from parsing */
73 int argc; /* Program arguments */
74 char **argv; /* Command line arguments */
75 const char *jumped_fname; /* Jumped from previous U_Boot */
76 uint8_t *ram_buf; /* Emulated RAM buffer */
77 unsigned int ram_size; /* Size of RAM buffer */
78 const char *ram_buf_fname; /* Filename to use for RAM buffer */
79 bool ram_buf_rm; /* Remove RAM buffer file after read */
80 bool write_ram_buf; /* Write RAM buffer on exit */
81 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 */
86 bool show_lcd; /* Show LCD on start-up */
87 enum sysreset_t last_sysreset; /* Last system reset type */
88 bool sysreset_allowed[SYSRESET_COUNT]; /* Allowed system reset types */
89 enum state_terminal_raw term_raw; /* Terminal raw/cooked */
90 bool skip_delays; /* Ignore any time delays (for test) */
91 bool show_test_output; /* Don't suppress stdout in tests */
93 /* Pointer to information for each SPI bus/cs */
94 struct sandbox_spi_info spi[CONFIG_SANDBOX_SPI_MAX_BUS]
95 [CONFIG_SANDBOX_SPI_MAX_CS];
97 /* Information about Watchdog */
98 struct sandbox_wdt_info wdt;
100 ulong next_tag; /* Next address tag to allocate */
101 struct list_head mapmem_head; /* struct sandbox_mapmem_entry */
104 /* Minimum space we guarantee in the state FDT when calling read/write*/
105 #define SANDBOX_STATE_MIN_SPACE 0x1000
108 * struct sandbox_state_io - methods to saved/restore sandbox state
109 * @name: Name of of the device tree node, also the name of the variable
110 * holding this data so it should be an identifier (use underscore
112 * @compat: Compatible string for the node containing this state
114 * @read: Function to read state from FDT
115 * If data is available, then blob and node will provide access to it. If
116 * not (blob == NULL and node == -1) this function should set up an empty
117 * data set for start-of-day.
118 * @param blob: Pointer to device tree blob, or NULL if no data to read
119 * @param node: Node offset to read from
120 * @return 0 if OK, -ve on error
122 * @write: Function to write state to FDT
123 * The caller will ensure that there is a node ready for the state. The
124 * node may already contain the old state, in which case it should be
125 * overridden. There is guaranteed to be SANDBOX_STATE_MIN_SPACE bytes
126 * of free space, so error checking is not required for fdt_setprop...()
127 * calls which add up to less than this much space.
129 * For adding larger properties, use state_setprop().
131 * @param blob: Device tree blob holding state
132 * @param node: Node to write our state into
134 * Note that it is possible to save data as large blobs or as individual
135 * hierarchical properties. However, unless you intend to keep state files
136 * around for a long time and be able to run an old state file on a new
137 * sandbox, it might not be worth using individual properties for everything.
138 * This is certainly supported, it is just a matter of the effort you wish
139 * to put into the state read/write feature.
141 struct sandbox_state_io {
144 int (*write)(void *blob, int node);
145 int (*read)(const void *blob, int node);
149 * SANDBOX_STATE_IO - Declare sandbox state to read/write
151 * Sandbox permits saving state from one run and restoring it in another. This
152 * allows the test system to retain state between runs and thus better
153 * emulate a real system. Examples of state that might be useful to save are
154 * the emulated GPIOs pin settings, flash memory contents and TPM private
155 * data. U-Boot memory contents is dealth with separately since it is large
156 * and it is not normally useful to save it (since a normal system does not
157 * preserve DRAM between runs). See the '-m' option for this.
159 * See struct sandbox_state_io above for member documentation.
161 #define SANDBOX_STATE_IO(_name, _compat, _read, _write) \
162 ll_entry_declare(struct sandbox_state_io, _name, state_io) = { \
163 .name = __stringify(_name), \
170 * Gets a pointer to the current state.
172 * @return pointer to state
174 struct sandbox_state *state_get_current(void);
177 * Read the sandbox state from the supplied device tree file
179 * This calls all registered state handlers to read in the sandbox state
180 * from a previous test run.
182 * @param state Sandbox state to update
183 * @param fname Filename of device tree file to read from
184 * @return 0 if OK, -ve on error
186 int sandbox_read_state(struct sandbox_state *state, const char *fname);
189 * Write the sandbox state to the supplied device tree file
191 * This calls all registered state handlers to write out the sandbox state
192 * so that it can be preserved for a future test run.
194 * If the file exists it is overwritten.
196 * @param state Sandbox state to update
197 * @param fname Filename of device tree file to write to
198 * @return 0 if OK, -ve on error
200 int sandbox_write_state(struct sandbox_state *state, const char *fname);
203 * Add a property to a sandbox state node
205 * This is equivalent to fdt_setprop except that it automatically enlarges
206 * the device tree if necessary. That means it is safe to write any amount
209 * This function can only be called from within struct sandbox_state_io's
210 * ->write method, i.e. within state I/O drivers.
212 * @param node Device tree node to write to
213 * @param prop_name Property to write
214 * @param data Data to write into property
215 * @param size Size of data to write into property
217 int state_setprop(int node, const char *prop_name, const void *data, int size);
220 * Control skipping of time delays
222 * Some tests have unnecessay time delays (e.g. USB). Allow these to be
223 * skipped to speed up testing
225 * @param skip_delays true to skip delays from now on, false to honour delay
228 void state_set_skip_delays(bool skip_delays);
231 * See if delays should be skipped
233 * @return true if delays should be skipped, false if they should be honoured
235 bool state_get_skip_delays(void);
238 * state_reset_for_test() - Reset ready to re-run tests
240 * This clears out any test state ready for another test run.
242 void state_reset_for_test(struct sandbox_state *state);
245 * Initialize the test system state
247 int state_init(void);
250 * Uninitialize the test system state, writing out state if configured to
253 * @return 0 if OK, -ve on error
255 int state_uninit(void);