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 67 /* Pointer to information for each SPI bus/cs */ 68 struct sandbox_spi_info spi[CONFIG_SANDBOX_SPI_MAX_BUS] 69 [CONFIG_SANDBOX_SPI_MAX_CS]; 70 }; 71 72 /* Minimum space we guarantee in the state FDT when calling read/write*/ 73 #define SANDBOX_STATE_MIN_SPACE 0x1000 74 75 /** 76 * struct sandbox_state_io - methods to saved/restore sandbox state 77 * @name: Name of of the device tree node, also the name of the variable 78 * holding this data so it should be an identifier (use underscore 79 * instead of minus) 80 * @compat: Compatible string for the node containing this state 81 * 82 * @read: Function to read state from FDT 83 * If data is available, then blob and node will provide access to it. If 84 * not (blob == NULL and node == -1) this function should set up an empty 85 * data set for start-of-day. 86 * @param blob: Pointer to device tree blob, or NULL if no data to read 87 * @param node: Node offset to read from 88 * @return 0 if OK, -ve on error 89 * 90 * @write: Function to write state to FDT 91 * The caller will ensure that there is a node ready for the state. The 92 * node may already contain the old state, in which case it should be 93 * overridden. There is guaranteed to be SANDBOX_STATE_MIN_SPACE bytes 94 * of free space, so error checking is not required for fdt_setprop...() 95 * calls which add up to less than this much space. 96 * 97 * For adding larger properties, use state_setprop(). 98 * 99 * @param blob: Device tree blob holding state 100 * @param node: Node to write our state into 101 * 102 * Note that it is possible to save data as large blobs or as individual 103 * hierarchical properties. However, unless you intend to keep state files 104 * around for a long time and be able to run an old state file on a new 105 * sandbox, it might not be worth using individual properties for everything. 106 * This is certainly supported, it is just a matter of the effort you wish 107 * to put into the state read/write feature. 108 */ 109 struct sandbox_state_io { 110 const char *name; 111 const char *compat; 112 int (*write)(void *blob, int node); 113 int (*read)(const void *blob, int node); 114 }; 115 116 /** 117 * SANDBOX_STATE_IO - Declare sandbox state to read/write 118 * 119 * Sandbox permits saving state from one run and restoring it in another. This 120 * allows the test system to retain state between runs and thus better 121 * emulate a real system. Examples of state that might be useful to save are 122 * the emulated GPIOs pin settings, flash memory contents and TPM private 123 * data. U-Boot memory contents is dealth with separately since it is large 124 * and it is not normally useful to save it (since a normal system does not 125 * preserve DRAM between runs). See the '-m' option for this. 126 * 127 * See struct sandbox_state_io above for member documentation. 128 */ 129 #define SANDBOX_STATE_IO(_name, _compat, _read, _write) \ 130 ll_entry_declare(struct sandbox_state_io, _name, state_io) = { \ 131 .name = __stringify(_name), \ 132 .read = _read, \ 133 .write = _write, \ 134 .compat = _compat, \ 135 } 136 137 /** 138 * Gets a pointer to the current state. 139 * 140 * @return pointer to state 141 */ 142 struct sandbox_state *state_get_current(void); 143 144 /** 145 * Read the sandbox state from the supplied device tree file 146 * 147 * This calls all registered state handlers to read in the sandbox state 148 * from a previous test run. 149 * 150 * @param state Sandbox state to update 151 * @param fname Filename of device tree file to read from 152 * @return 0 if OK, -ve on error 153 */ 154 int sandbox_read_state(struct sandbox_state *state, const char *fname); 155 156 /** 157 * Write the sandbox state to the supplied device tree file 158 * 159 * This calls all registered state handlers to write out the sandbox state 160 * so that it can be preserved for a future test run. 161 * 162 * If the file exists it is overwritten. 163 * 164 * @param state Sandbox state to update 165 * @param fname Filename of device tree file to write to 166 * @return 0 if OK, -ve on error 167 */ 168 int sandbox_write_state(struct sandbox_state *state, const char *fname); 169 170 /** 171 * Add a property to a sandbox state node 172 * 173 * This is equivalent to fdt_setprop except that it automatically enlarges 174 * the device tree if necessary. That means it is safe to write any amount 175 * of data here. 176 * 177 * This function can only be called from within struct sandbox_state_io's 178 * ->write method, i.e. within state I/O drivers. 179 * 180 * @param node Device tree node to write to 181 * @param prop_name Property to write 182 * @param data Data to write into property 183 * @param size Size of data to write into property 184 */ 185 int state_setprop(int node, const char *prop_name, const void *data, int size); 186 187 /** 188 * Initialize the test system state 189 */ 190 int state_init(void); 191 192 /** 193 * Uninitialize the test system state, writing out state if configured to 194 * do so. 195 * 196 * @return 0 if OK, -ve on error 197 */ 198 int state_uninit(void); 199 200 #endif 201