blob: 11856c2fede654e6a26ce3d64e563702aeaaa9b0 [file] [log] [blame]
Simon Glass6fb62072012-02-15 15:51:15 -08001/*
2 * Copyright (c) 2011-2012 The Chromium OS Authors.
Wolfgang Denk1a459662013-07-08 09:37:19 +02003 * SPDX-License-Identifier: GPL-2.0+
Simon Glass6fb62072012-02-15 15:51:15 -08004 */
5
6#ifndef __SANDBOX_STATE_H
7#define __SANDBOX_STATE_H
8
Simon Glass70db4212012-02-15 15:51:16 -08009#include <config.h>
Simon Glassdc6f4d32015-07-06 12:54:26 -060010#include <reset.h>
Simon Glassc5a62d42013-11-10 10:27:02 -070011#include <stdbool.h>
Simon Glass1209e272013-11-10 10:27:04 -070012#include <linux/stringify.h>
Simon Glass70db4212012-02-15 15:51:16 -080013
Simon Glassffb87902014-02-27 13:26:22 -070014/**
15 * Selects the behavior of the serial terminal.
16 *
17 * If Ctrl-C is processed by U-Boot, then the only way to quit sandbox is with
18 * the 'reset' command, or equivalent.
19 *
20 * If the terminal is cooked, then Ctrl-C will terminate U-Boot, and the
21 * command line will not be quite such a faithful emulation.
22 *
23 * Options are:
24 *
25 * raw-with-sigs - Raw, but allow signals (Ctrl-C will quit)
26 * raw - Terminal is always raw
27 * cooked - Terminal is always cooked
28 */
29enum state_terminal_raw {
30 STATE_TERM_RAW_WITH_SIGS, /* Default */
31 STATE_TERM_RAW,
32 STATE_TERM_COOKED,
33
34 STATE_TERM_COUNT,
35};
36
Mike Frysinger61228132013-12-03 16:43:26 -070037struct sandbox_spi_info {
38 const char *spec;
Simon Glass49b5d6e2014-10-13 23:41:57 -060039 struct udevice *emul;
Mike Frysinger61228132013-12-03 16:43:26 -070040};
41
Simon Glass6fb62072012-02-15 15:51:15 -080042/* The complete state of the test system */
43struct sandbox_state {
44 const char *cmd; /* Command to execute */
Simon Glassc5a62d42013-11-10 10:27:02 -070045 bool interactive; /* Enable cmdline after execute */
Sjoerd Simonsebaa8322015-04-30 22:16:09 +020046 bool run_distro_boot; /* Automatically run distro bootcommands */
Simon Glassf828bf22013-04-20 08:42:41 +000047 const char *fdt_fname; /* Filename of FDT binary */
Simon Glass70db4212012-02-15 15:51:16 -080048 const char *parse_err; /* Error to report from parsing */
49 int argc; /* Program arguments */
Simon Glassbda77732014-02-27 13:26:16 -070050 char **argv; /* Command line arguments */
Simon Glassab839dc2014-02-27 13:26:23 -070051 const char *jumped_fname; /* Jumped from previous U_Boot */
Simon Glass5c2859c2013-11-10 10:27:03 -070052 uint8_t *ram_buf; /* Emulated RAM buffer */
53 unsigned int ram_size; /* Size of RAM buffer */
54 const char *ram_buf_fname; /* Filename to use for RAM buffer */
Simon Glassab839dc2014-02-27 13:26:23 -070055 bool ram_buf_rm; /* Remove RAM buffer file after read */
Simon Glass5c2859c2013-11-10 10:27:03 -070056 bool write_ram_buf; /* Write RAM buffer on exit */
Simon Glass1209e272013-11-10 10:27:04 -070057 const char *state_fname; /* File containing sandbox state */
58 void *state_fdt; /* Holds saved state for sandbox */
59 bool read_state; /* Read sandbox state on startup */
60 bool write_state; /* Write sandbox state on exit */
61 bool ignore_missing_state_on_read; /* No error if state missing */
Simon Glass7d95f2a2014-02-27 13:26:19 -070062 bool show_lcd; /* Show LCD on start-up */
Simon Glassdc6f4d32015-07-06 12:54:26 -060063 enum reset_t last_reset; /* Last reset type */
64 bool reset_allowed[RESET_COUNT]; /* Allowed reset types */
Simon Glassffb87902014-02-27 13:26:22 -070065 enum state_terminal_raw term_raw; /* Terminal raw/cooked */
Simon Glass97235632015-11-08 23:47:43 -070066 bool skip_delays; /* Ignore any time delays (for test) */
Simon Glass9ce8b402015-11-08 23:47:50 -070067 bool show_test_output; /* Don't suppress stdout in tests */
Mike Frysinger61228132013-12-03 16:43:26 -070068
69 /* Pointer to information for each SPI bus/cs */
70 struct sandbox_spi_info spi[CONFIG_SANDBOX_SPI_MAX_BUS]
71 [CONFIG_SANDBOX_SPI_MAX_CS];
Simon Glass6fb62072012-02-15 15:51:15 -080072};
73
Simon Glass1209e272013-11-10 10:27:04 -070074/* Minimum space we guarantee in the state FDT when calling read/write*/
75#define SANDBOX_STATE_MIN_SPACE 0x1000
76
77/**
78 * struct sandbox_state_io - methods to saved/restore sandbox state
79 * @name: Name of of the device tree node, also the name of the variable
80 * holding this data so it should be an identifier (use underscore
81 * instead of minus)
82 * @compat: Compatible string for the node containing this state
83 *
84 * @read: Function to read state from FDT
85 * If data is available, then blob and node will provide access to it. If
86 * not (blob == NULL and node == -1) this function should set up an empty
87 * data set for start-of-day.
88 * @param blob: Pointer to device tree blob, or NULL if no data to read
89 * @param node: Node offset to read from
90 * @return 0 if OK, -ve on error
91 *
92 * @write: Function to write state to FDT
93 * The caller will ensure that there is a node ready for the state. The
94 * node may already contain the old state, in which case it should be
95 * overridden. There is guaranteed to be SANDBOX_STATE_MIN_SPACE bytes
96 * of free space, so error checking is not required for fdt_setprop...()
97 * calls which add up to less than this much space.
98 *
99 * For adding larger properties, use state_setprop().
100 *
101 * @param blob: Device tree blob holding state
102 * @param node: Node to write our state into
103 *
104 * Note that it is possible to save data as large blobs or as individual
105 * hierarchical properties. However, unless you intend to keep state files
106 * around for a long time and be able to run an old state file on a new
107 * sandbox, it might not be worth using individual properties for everything.
108 * This is certainly supported, it is just a matter of the effort you wish
109 * to put into the state read/write feature.
110 */
111struct sandbox_state_io {
112 const char *name;
113 const char *compat;
114 int (*write)(void *blob, int node);
115 int (*read)(const void *blob, int node);
116};
117
118/**
119 * SANDBOX_STATE_IO - Declare sandbox state to read/write
120 *
121 * Sandbox permits saving state from one run and restoring it in another. This
122 * allows the test system to retain state between runs and thus better
123 * emulate a real system. Examples of state that might be useful to save are
124 * the emulated GPIOs pin settings, flash memory contents and TPM private
125 * data. U-Boot memory contents is dealth with separately since it is large
126 * and it is not normally useful to save it (since a normal system does not
127 * preserve DRAM between runs). See the '-m' option for this.
128 *
129 * See struct sandbox_state_io above for member documentation.
130 */
131#define SANDBOX_STATE_IO(_name, _compat, _read, _write) \
132 ll_entry_declare(struct sandbox_state_io, _name, state_io) = { \
133 .name = __stringify(_name), \
134 .read = _read, \
135 .write = _write, \
136 .compat = _compat, \
137 }
138
Simon Glass6fb62072012-02-15 15:51:15 -0800139/**
Simon Glass6fb62072012-02-15 15:51:15 -0800140 * Gets a pointer to the current state.
141 *
142 * @return pointer to state
143 */
144struct sandbox_state *state_get_current(void);
145
146/**
Simon Glass1209e272013-11-10 10:27:04 -0700147 * Read the sandbox state from the supplied device tree file
148 *
149 * This calls all registered state handlers to read in the sandbox state
150 * from a previous test run.
151 *
152 * @param state Sandbox state to update
153 * @param fname Filename of device tree file to read from
154 * @return 0 if OK, -ve on error
155 */
156int sandbox_read_state(struct sandbox_state *state, const char *fname);
157
158/**
159 * Write the sandbox state to the supplied device tree file
160 *
161 * This calls all registered state handlers to write out the sandbox state
162 * so that it can be preserved for a future test run.
163 *
164 * If the file exists it is overwritten.
165 *
166 * @param state Sandbox state to update
167 * @param fname Filename of device tree file to write to
168 * @return 0 if OK, -ve on error
169 */
170int sandbox_write_state(struct sandbox_state *state, const char *fname);
171
172/**
173 * Add a property to a sandbox state node
174 *
175 * This is equivalent to fdt_setprop except that it automatically enlarges
176 * the device tree if necessary. That means it is safe to write any amount
177 * of data here.
178 *
179 * This function can only be called from within struct sandbox_state_io's
180 * ->write method, i.e. within state I/O drivers.
181 *
182 * @param node Device tree node to write to
183 * @param prop_name Property to write
184 * @param data Data to write into property
185 * @param size Size of data to write into property
186 */
187int state_setprop(int node, const char *prop_name, const void *data, int size);
188
189/**
Simon Glass97235632015-11-08 23:47:43 -0700190 * Control skipping of time delays
191 *
192 * Some tests have unnecessay time delays (e.g. USB). Allow these to be
193 * skipped to speed up testing
194 *
195 * @param skip_delays true to skip delays from now on, false to honour delay
196 * requests
197 */
198void state_set_skip_delays(bool skip_delays);
199
200/**
201 * See if delays should be skipped
202 *
203 * @return true if delays should be skipped, false if they should be honoured
204 */
205bool state_get_skip_delays(void);
206
207/**
Simon Glass6fb62072012-02-15 15:51:15 -0800208 * Initialize the test system state
209 */
210int state_init(void);
211
Simon Glass5c2859c2013-11-10 10:27:03 -0700212/**
213 * Uninitialize the test system state, writing out state if configured to
214 * do so.
215 *
216 * @return 0 if OK, -ve on error
217 */
218int state_uninit(void);
219
Simon Glass6fb62072012-02-15 15:51:15 -0800220#endif