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 <stdbool.h> 11 #include <linux/stringify.h> 12 13 /* How we exited U-Boot */ 14 enum exit_type_id { 15 STATE_EXIT_NORMAL, 16 STATE_EXIT_COLD_REBOOT, 17 STATE_EXIT_POWER_OFF, 18 }; 19 20 /** 21 * Selects the behavior of the serial terminal. 22 * 23 * If Ctrl-C is processed by U-Boot, then the only way to quit sandbox is with 24 * the 'reset' command, or equivalent. 25 * 26 * If the terminal is cooked, then Ctrl-C will terminate U-Boot, and the 27 * command line will not be quite such a faithful emulation. 28 * 29 * Options are: 30 * 31 * raw-with-sigs - Raw, but allow signals (Ctrl-C will quit) 32 * raw - Terminal is always raw 33 * cooked - Terminal is always cooked 34 */ 35 enum state_terminal_raw { 36 STATE_TERM_RAW_WITH_SIGS, /* Default */ 37 STATE_TERM_RAW, 38 STATE_TERM_COOKED, 39 40 STATE_TERM_COUNT, 41 }; 42 43 struct sandbox_spi_info { 44 const char *spec; 45 const struct sandbox_spi_emu_ops *ops; 46 struct udevice *emul; 47 }; 48 49 /* The complete state of the test system */ 50 struct sandbox_state { 51 const char *cmd; /* Command to execute */ 52 bool interactive; /* Enable cmdline after execute */ 53 const char *fdt_fname; /* Filename of FDT binary */ 54 enum exit_type_id exit_type; /* How we exited U-Boot */ 55 const char *parse_err; /* Error to report from parsing */ 56 int argc; /* Program arguments */ 57 char **argv; /* Command line arguments */ 58 const char *jumped_fname; /* Jumped from previous U_Boot */ 59 uint8_t *ram_buf; /* Emulated RAM buffer */ 60 unsigned int ram_size; /* Size of RAM buffer */ 61 const char *ram_buf_fname; /* Filename to use for RAM buffer */ 62 bool ram_buf_rm; /* Remove RAM buffer file after read */ 63 bool write_ram_buf; /* Write RAM buffer on exit */ 64 const char *state_fname; /* File containing sandbox state */ 65 void *state_fdt; /* Holds saved state for sandbox */ 66 bool read_state; /* Read sandbox state on startup */ 67 bool write_state; /* Write sandbox state on exit */ 68 bool ignore_missing_state_on_read; /* No error if state missing */ 69 bool show_lcd; /* Show LCD on start-up */ 70 enum state_terminal_raw term_raw; /* Terminal raw/cooked */ 71 72 /* Pointer to information for each SPI bus/cs */ 73 struct sandbox_spi_info spi[CONFIG_SANDBOX_SPI_MAX_BUS] 74 [CONFIG_SANDBOX_SPI_MAX_CS]; 75 }; 76 77 /* Minimum space we guarantee in the state FDT when calling read/write*/ 78 #define SANDBOX_STATE_MIN_SPACE 0x1000 79 80 /** 81 * struct sandbox_state_io - methods to saved/restore sandbox state 82 * @name: Name of of the device tree node, also the name of the variable 83 * holding this data so it should be an identifier (use underscore 84 * instead of minus) 85 * @compat: Compatible string for the node containing this state 86 * 87 * @read: Function to read state from FDT 88 * If data is available, then blob and node will provide access to it. If 89 * not (blob == NULL and node == -1) this function should set up an empty 90 * data set for start-of-day. 91 * @param blob: Pointer to device tree blob, or NULL if no data to read 92 * @param node: Node offset to read from 93 * @return 0 if OK, -ve on error 94 * 95 * @write: Function to write state to FDT 96 * The caller will ensure that there is a node ready for the state. The 97 * node may already contain the old state, in which case it should be 98 * overridden. There is guaranteed to be SANDBOX_STATE_MIN_SPACE bytes 99 * of free space, so error checking is not required for fdt_setprop...() 100 * calls which add up to less than this much space. 101 * 102 * For adding larger properties, use state_setprop(). 103 * 104 * @param blob: Device tree blob holding state 105 * @param node: Node to write our state into 106 * 107 * Note that it is possible to save data as large blobs or as individual 108 * hierarchical properties. However, unless you intend to keep state files 109 * around for a long time and be able to run an old state file on a new 110 * sandbox, it might not be worth using individual properties for everything. 111 * This is certainly supported, it is just a matter of the effort you wish 112 * to put into the state read/write feature. 113 */ 114 struct sandbox_state_io { 115 const char *name; 116 const char *compat; 117 int (*write)(void *blob, int node); 118 int (*read)(const void *blob, int node); 119 }; 120 121 /** 122 * SANDBOX_STATE_IO - Declare sandbox state to read/write 123 * 124 * Sandbox permits saving state from one run and restoring it in another. This 125 * allows the test system to retain state between runs and thus better 126 * emulate a real system. Examples of state that might be useful to save are 127 * the emulated GPIOs pin settings, flash memory contents and TPM private 128 * data. U-Boot memory contents is dealth with separately since it is large 129 * and it is not normally useful to save it (since a normal system does not 130 * preserve DRAM between runs). See the '-m' option for this. 131 * 132 * See struct sandbox_state_io above for member documentation. 133 */ 134 #define SANDBOX_STATE_IO(_name, _compat, _read, _write) \ 135 ll_entry_declare(struct sandbox_state_io, _name, state_io) = { \ 136 .name = __stringify(_name), \ 137 .read = _read, \ 138 .write = _write, \ 139 .compat = _compat, \ 140 } 141 142 /** 143 * Record the exit type to be reported by the test program. 144 * 145 * @param exit_type Exit type to record 146 */ 147 void state_record_exit(enum exit_type_id exit_type); 148 149 /** 150 * Gets a pointer to the current state. 151 * 152 * @return pointer to state 153 */ 154 struct sandbox_state *state_get_current(void); 155 156 /** 157 * Read the sandbox state from the supplied device tree file 158 * 159 * This calls all registered state handlers to read in the sandbox state 160 * from a previous test run. 161 * 162 * @param state Sandbox state to update 163 * @param fname Filename of device tree file to read from 164 * @return 0 if OK, -ve on error 165 */ 166 int sandbox_read_state(struct sandbox_state *state, const char *fname); 167 168 /** 169 * Write the sandbox state to the supplied device tree file 170 * 171 * This calls all registered state handlers to write out the sandbox state 172 * so that it can be preserved for a future test run. 173 * 174 * If the file exists it is overwritten. 175 * 176 * @param state Sandbox state to update 177 * @param fname Filename of device tree file to write to 178 * @return 0 if OK, -ve on error 179 */ 180 int sandbox_write_state(struct sandbox_state *state, const char *fname); 181 182 /** 183 * Add a property to a sandbox state node 184 * 185 * This is equivalent to fdt_setprop except that it automatically enlarges 186 * the device tree if necessary. That means it is safe to write any amount 187 * of data here. 188 * 189 * This function can only be called from within struct sandbox_state_io's 190 * ->write method, i.e. within state I/O drivers. 191 * 192 * @param node Device tree node to write to 193 * @param prop_name Property to write 194 * @param data Data to write into property 195 * @param size Size of data to write into property 196 */ 197 int state_setprop(int node, const char *prop_name, const void *data, int size); 198 199 /** 200 * Initialize the test system state 201 */ 202 int state_init(void); 203 204 /** 205 * Uninitialize the test system state, writing out state if configured to 206 * do so. 207 * 208 * @return 0 if OK, -ve on error 209 */ 210 int state_uninit(void); 211 212 #endif 213