1 /* 2 * Copyright (c) 2011-2012 The Chromium OS Authors. 3 * SPDX-License-Identifier: GPL-2.0+ 4 */ 5 6 #ifndef __SANDBOX_STATE_H 7 #define __SANDBOX_STATE_H 8 9 #include <config.h> 10 #include <sysreset.h> 11 #include <stdbool.h> 12 #include <linux/stringify.h> 13 14 /** 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 */ 29 enum 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 37 struct sandbox_spi_info { 38 struct udevice *emul; 39 }; 40 41 struct sandbox_wdt_info { 42 unsigned long long counter; 43 uint reset_count; 44 bool running; 45 }; 46 47 /* The complete state of the test system */ 48 struct sandbox_state { 49 const char *cmd; /* Command to execute */ 50 bool interactive; /* Enable cmdline after execute */ 51 bool run_distro_boot; /* Automatically run distro bootcommands */ 52 const char *fdt_fname; /* Filename of FDT binary */ 53 const char *parse_err; /* Error to report from parsing */ 54 int argc; /* Program arguments */ 55 char **argv; /* Command line arguments */ 56 const char *jumped_fname; /* Jumped from previous U_Boot */ 57 uint8_t *ram_buf; /* Emulated RAM buffer */ 58 unsigned int ram_size; /* Size of RAM buffer */ 59 const char *ram_buf_fname; /* Filename to use for RAM buffer */ 60 bool ram_buf_rm; /* Remove RAM buffer file after read */ 61 bool write_ram_buf; /* Write RAM buffer on exit */ 62 const char *state_fname; /* File containing sandbox state */ 63 void *state_fdt; /* Holds saved state for sandbox */ 64 bool read_state; /* Read sandbox state on startup */ 65 bool write_state; /* Write sandbox state on exit */ 66 bool ignore_missing_state_on_read; /* No error if state missing */ 67 bool show_lcd; /* Show LCD on start-up */ 68 enum sysreset_t last_sysreset; /* Last system reset type */ 69 bool sysreset_allowed[SYSRESET_COUNT]; /* Allowed system reset types */ 70 enum state_terminal_raw term_raw; /* Terminal raw/cooked */ 71 bool skip_delays; /* Ignore any time delays (for test) */ 72 bool show_test_output; /* Don't suppress stdout in tests */ 73 74 /* Pointer to information for each SPI bus/cs */ 75 struct sandbox_spi_info spi[CONFIG_SANDBOX_SPI_MAX_BUS] 76 [CONFIG_SANDBOX_SPI_MAX_CS]; 77 78 /* Information about Watchdog */ 79 struct sandbox_wdt_info wdt; 80 }; 81 82 /* Minimum space we guarantee in the state FDT when calling read/write*/ 83 #define SANDBOX_STATE_MIN_SPACE 0x1000 84 85 /** 86 * struct sandbox_state_io - methods to saved/restore sandbox state 87 * @name: Name of of the device tree node, also the name of the variable 88 * holding this data so it should be an identifier (use underscore 89 * instead of minus) 90 * @compat: Compatible string for the node containing this state 91 * 92 * @read: Function to read state from FDT 93 * If data is available, then blob and node will provide access to it. If 94 * not (blob == NULL and node == -1) this function should set up an empty 95 * data set for start-of-day. 96 * @param blob: Pointer to device tree blob, or NULL if no data to read 97 * @param node: Node offset to read from 98 * @return 0 if OK, -ve on error 99 * 100 * @write: Function to write state to FDT 101 * The caller will ensure that there is a node ready for the state. The 102 * node may already contain the old state, in which case it should be 103 * overridden. There is guaranteed to be SANDBOX_STATE_MIN_SPACE bytes 104 * of free space, so error checking is not required for fdt_setprop...() 105 * calls which add up to less than this much space. 106 * 107 * For adding larger properties, use state_setprop(). 108 * 109 * @param blob: Device tree blob holding state 110 * @param node: Node to write our state into 111 * 112 * Note that it is possible to save data as large blobs or as individual 113 * hierarchical properties. However, unless you intend to keep state files 114 * around for a long time and be able to run an old state file on a new 115 * sandbox, it might not be worth using individual properties for everything. 116 * This is certainly supported, it is just a matter of the effort you wish 117 * to put into the state read/write feature. 118 */ 119 struct sandbox_state_io { 120 const char *name; 121 const char *compat; 122 int (*write)(void *blob, int node); 123 int (*read)(const void *blob, int node); 124 }; 125 126 /** 127 * SANDBOX_STATE_IO - Declare sandbox state to read/write 128 * 129 * Sandbox permits saving state from one run and restoring it in another. This 130 * allows the test system to retain state between runs and thus better 131 * emulate a real system. Examples of state that might be useful to save are 132 * the emulated GPIOs pin settings, flash memory contents and TPM private 133 * data. U-Boot memory contents is dealth with separately since it is large 134 * and it is not normally useful to save it (since a normal system does not 135 * preserve DRAM between runs). See the '-m' option for this. 136 * 137 * See struct sandbox_state_io above for member documentation. 138 */ 139 #define SANDBOX_STATE_IO(_name, _compat, _read, _write) \ 140 ll_entry_declare(struct sandbox_state_io, _name, state_io) = { \ 141 .name = __stringify(_name), \ 142 .read = _read, \ 143 .write = _write, \ 144 .compat = _compat, \ 145 } 146 147 /** 148 * Gets a pointer to the current state. 149 * 150 * @return pointer to state 151 */ 152 struct sandbox_state *state_get_current(void); 153 154 /** 155 * Read the sandbox state from the supplied device tree file 156 * 157 * This calls all registered state handlers to read in the sandbox state 158 * from a previous test run. 159 * 160 * @param state Sandbox state to update 161 * @param fname Filename of device tree file to read from 162 * @return 0 if OK, -ve on error 163 */ 164 int sandbox_read_state(struct sandbox_state *state, const char *fname); 165 166 /** 167 * Write the sandbox state to the supplied device tree file 168 * 169 * This calls all registered state handlers to write out the sandbox state 170 * so that it can be preserved for a future test run. 171 * 172 * If the file exists it is overwritten. 173 * 174 * @param state Sandbox state to update 175 * @param fname Filename of device tree file to write to 176 * @return 0 if OK, -ve on error 177 */ 178 int sandbox_write_state(struct sandbox_state *state, const char *fname); 179 180 /** 181 * Add a property to a sandbox state node 182 * 183 * This is equivalent to fdt_setprop except that it automatically enlarges 184 * the device tree if necessary. That means it is safe to write any amount 185 * of data here. 186 * 187 * This function can only be called from within struct sandbox_state_io's 188 * ->write method, i.e. within state I/O drivers. 189 * 190 * @param node Device tree node to write to 191 * @param prop_name Property to write 192 * @param data Data to write into property 193 * @param size Size of data to write into property 194 */ 195 int state_setprop(int node, const char *prop_name, const void *data, int size); 196 197 /** 198 * Control skipping of time delays 199 * 200 * Some tests have unnecessay time delays (e.g. USB). Allow these to be 201 * skipped to speed up testing 202 * 203 * @param skip_delays true to skip delays from now on, false to honour delay 204 * requests 205 */ 206 void state_set_skip_delays(bool skip_delays); 207 208 /** 209 * See if delays should be skipped 210 * 211 * @return true if delays should be skipped, false if they should be honoured 212 */ 213 bool state_get_skip_delays(void); 214 215 /** 216 * state_reset_for_test() - Reset ready to re-run tests 217 * 218 * This clears out any test state ready for another test run. 219 */ 220 void state_reset_for_test(struct sandbox_state *state); 221 222 /** 223 * Initialize the test system state 224 */ 225 int state_init(void); 226 227 /** 228 * Uninitialize the test system state, writing out state if configured to 229 * do so. 230 * 231 * @return 0 if OK, -ve on error 232 */ 233 int state_uninit(void); 234 235 #endif 236