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