2 * Copyright (c) 2011-2012 The Chromium OS Authors.
3 * SPDX-License-Identifier: GPL-2.0+
6 #ifndef __SANDBOX_STATE_H
7 #define __SANDBOX_STATE_H
11 #include <linux/stringify.h>
14 * Selects the behavior of the serial terminal.
16 * If Ctrl-C is processed by U-Boot, then the only way to quit sandbox is with
17 * the 'reset' command, or equivalent.
19 * If the terminal is cooked, then Ctrl-C will terminate U-Boot, and the
20 * command line will not be quite such a faithful emulation.
24 * raw-with-sigs - Raw, but allow signals (Ctrl-C will quit)
25 * raw - Terminal is always raw
26 * cooked - Terminal is always cooked
28 enum state_terminal_raw {
29 STATE_TERM_RAW_WITH_SIGS, /* Default */
36 struct sandbox_spi_info {
41 /* The complete state of the test system */
42 struct sandbox_state {
43 const char *cmd; /* Command to execute */
44 bool interactive; /* Enable cmdline after execute */
45 bool run_distro_boot; /* Automatically run distro bootcommands */
46 const char *fdt_fname; /* Filename of FDT binary */
47 const char *parse_err; /* Error to report from parsing */
48 int argc; /* Program arguments */
49 char **argv; /* Command line arguments */
50 const char *jumped_fname; /* Jumped from previous U_Boot */
51 uint8_t *ram_buf; /* Emulated RAM buffer */
52 unsigned int ram_size; /* Size of RAM buffer */
53 const char *ram_buf_fname; /* Filename to use for RAM buffer */
54 bool ram_buf_rm; /* Remove RAM buffer file after read */
55 bool write_ram_buf; /* Write RAM buffer on exit */
56 const char *state_fname; /* File containing sandbox state */
57 void *state_fdt; /* Holds saved state for sandbox */
58 bool read_state; /* Read sandbox state on startup */
59 bool write_state; /* Write sandbox state on exit */
60 bool ignore_missing_state_on_read; /* No error if state missing */
61 bool show_lcd; /* Show LCD on start-up */
62 enum state_terminal_raw term_raw; /* Terminal raw/cooked */
64 /* Pointer to information for each SPI bus/cs */
65 struct sandbox_spi_info spi[CONFIG_SANDBOX_SPI_MAX_BUS]
66 [CONFIG_SANDBOX_SPI_MAX_CS];
69 /* Minimum space we guarantee in the state FDT when calling read/write*/
70 #define SANDBOX_STATE_MIN_SPACE 0x1000
73 * struct sandbox_state_io - methods to saved/restore sandbox state
74 * @name: Name of of the device tree node, also the name of the variable
75 * holding this data so it should be an identifier (use underscore
77 * @compat: Compatible string for the node containing this state
79 * @read: Function to read state from FDT
80 * If data is available, then blob and node will provide access to it. If
81 * not (blob == NULL and node == -1) this function should set up an empty
82 * data set for start-of-day.
83 * @param blob: Pointer to device tree blob, or NULL if no data to read
84 * @param node: Node offset to read from
85 * @return 0 if OK, -ve on error
87 * @write: Function to write state to FDT
88 * The caller will ensure that there is a node ready for the state. The
89 * node may already contain the old state, in which case it should be
90 * overridden. There is guaranteed to be SANDBOX_STATE_MIN_SPACE bytes
91 * of free space, so error checking is not required for fdt_setprop...()
92 * calls which add up to less than this much space.
94 * For adding larger properties, use state_setprop().
96 * @param blob: Device tree blob holding state
97 * @param node: Node to write our state into
99 * Note that it is possible to save data as large blobs or as individual
100 * hierarchical properties. However, unless you intend to keep state files
101 * around for a long time and be able to run an old state file on a new
102 * sandbox, it might not be worth using individual properties for everything.
103 * This is certainly supported, it is just a matter of the effort you wish
104 * to put into the state read/write feature.
106 struct sandbox_state_io {
109 int (*write)(void *blob, int node);
110 int (*read)(const void *blob, int node);
114 * SANDBOX_STATE_IO - Declare sandbox state to read/write
116 * Sandbox permits saving state from one run and restoring it in another. This
117 * allows the test system to retain state between runs and thus better
118 * emulate a real system. Examples of state that might be useful to save are
119 * the emulated GPIOs pin settings, flash memory contents and TPM private
120 * data. U-Boot memory contents is dealth with separately since it is large
121 * and it is not normally useful to save it (since a normal system does not
122 * preserve DRAM between runs). See the '-m' option for this.
124 * See struct sandbox_state_io above for member documentation.
126 #define SANDBOX_STATE_IO(_name, _compat, _read, _write) \
127 ll_entry_declare(struct sandbox_state_io, _name, state_io) = { \
128 .name = __stringify(_name), \
135 * Gets a pointer to the current state.
137 * @return pointer to state
139 struct sandbox_state *state_get_current(void);
142 * Read the sandbox state from the supplied device tree file
144 * This calls all registered state handlers to read in the sandbox state
145 * from a previous test run.
147 * @param state Sandbox state to update
148 * @param fname Filename of device tree file to read from
149 * @return 0 if OK, -ve on error
151 int sandbox_read_state(struct sandbox_state *state, const char *fname);
154 * Write the sandbox state to the supplied device tree file
156 * This calls all registered state handlers to write out the sandbox state
157 * so that it can be preserved for a future test run.
159 * If the file exists it is overwritten.
161 * @param state Sandbox state to update
162 * @param fname Filename of device tree file to write to
163 * @return 0 if OK, -ve on error
165 int sandbox_write_state(struct sandbox_state *state, const char *fname);
168 * Add a property to a sandbox state node
170 * This is equivalent to fdt_setprop except that it automatically enlarges
171 * the device tree if necessary. That means it is safe to write any amount
174 * This function can only be called from within struct sandbox_state_io's
175 * ->write method, i.e. within state I/O drivers.
177 * @param node Device tree node to write to
178 * @param prop_name Property to write
179 * @param data Data to write into property
180 * @param size Size of data to write into property
182 int state_setprop(int node, const char *prop_name, const void *data, int size);
185 * Initialize the test system state
187 int state_init(void);
190 * Uninitialize the test system state, writing out state if configured to
193 * @return 0 if OK, -ve on error
195 int state_uninit(void);