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