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 <sysreset.h> 10#include <stdbool.h> 11#include <linux/list.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 */ 29enum 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 37struct sandbox_spi_info { 38 struct udevice *emul; 39}; 40 41struct sandbox_wdt_info { 42 unsigned long long counter; 43 uint reset_count; 44 bool running; 45}; 46 47/** 48 * struct sandbox_mapmem_entry - maps pointers to/from U-Boot addresses 49 * 50 * When map_to_sysmem() is called with an address outside sandbox's emulated 51 * RAM, a record is created with a tag that can be used to reference that 52 * pointer. When map_sysmem() is called later with that tag, the pointer will 53 * be returned, just as it would for a normal sandbox address. 54 * 55 * @tag: Address tag (a value which U-Boot uses to refer to the address) 56 * @ptr: Associated pointer for that tag 57 */ 58struct sandbox_mapmem_entry { 59 ulong tag; 60 void *ptr; 61 struct list_head sibling_node; 62}; 63 64/* The complete state of the test system */ 65struct sandbox_state { 66 const char *cmd; /* Command to execute */ 67 bool interactive; /* Enable cmdline after execute */ 68 bool run_distro_boot; /* Automatically run distro bootcommands */ 69 const char *fdt_fname; /* Filename of FDT binary */ 70 const char *parse_err; /* Error to report from parsing */ 71 int argc; /* Program arguments */ 72 char **argv; /* Command line arguments */ 73 const char *jumped_fname; /* Jumped from previous U-Boot */ 74 const char *prog_fname; /* U-Boot executable filename */ 75 uint8_t *ram_buf; /* Emulated RAM buffer */ 76 unsigned long 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 bool double_lcd; /* Double display size for high-DPI */ 87 enum sysreset_t last_sysreset; /* Last system reset type */ 88 bool sysreset_allowed[SYSRESET_COUNT]; /* Allowed system reset types */ 89 enum state_terminal_raw term_raw; /* Terminal raw/cooked */ 90 bool skip_delays; /* Ignore any time delays (for test) */ 91 bool show_test_output; /* Don't suppress stdout in tests */ 92 int default_log_level; /* Default log level for sandbox */ 93 bool ram_buf_read; /* true if we read the RAM buffer */ 94 bool run_unittests; /* Run unit tests */ 95 const char *select_unittests; /* Unit test to run */ 96 bool handle_signals; /* Handle signals within sandbox */ 97 bool autoboot_keyed; /* Use keyed-autoboot feature */ 98 bool disable_eth; /* Disable Ethernet devices */ 99 bool disable_sf_bootdevs; /* Don't bind SPI flash bootdevs */ 100 101 /* Pointer to information for each SPI bus/cs */ 102 struct sandbox_spi_info spi[CONFIG_SANDBOX_SPI_MAX_BUS] 103 [CONFIG_SANDBOX_SPI_MAX_CS]; 104 105 /* Information about Watchdog */ 106 struct sandbox_wdt_info wdt; 107 108 ulong next_tag; /* Next address tag to allocate */ 109 struct list_head mapmem_head; /* struct sandbox_mapmem_entry */ 110 bool hwspinlock; /* Hardware Spinlock status */ 111 bool allow_memio; /* Allow readl() etc. to work */ 112 113 void *other_fdt_buf; /* 'other' FDT blob used by tests */ 114 int other_size; /* size of other FDT blob */ 115 116 /* 117 * This struct is getting large. 118 * 119 * Consider putting test data in driver-private structs, like 120 * sandbox_pch.c. 121 * 122 * If you add new members, please put them above this comment. 123 */ 124}; 125 126/* Minimum space we guarantee in the state FDT when calling read/write*/ 127#define SANDBOX_STATE_MIN_SPACE 0x1000 128 129/** 130 * struct sandbox_state_io - methods to saved/restore sandbox state 131 * @name: Name of of the device tree node, also the name of the variable 132 * holding this data so it should be an identifier (use underscore 133 * instead of minus) 134 * @compat: Compatible string for the node containing this state 135 * 136 * @read: Function to read state from FDT 137 * If data is available, then blob and node will provide access to it. If 138 * not (blob == NULL and node == -1) this function should set up an empty 139 * data set for start-of-day. 140 * @param blob: Pointer to device tree blob, or NULL if no data to read 141 * @param node: Node offset to read from 142 * Return: 0 if OK, -ve on error 143 * 144 * @write: Function to write state to FDT 145 * The caller will ensure that there is a node ready for the state. The 146 * node may already contain the old state, in which case it should be 147 * overridden. There is guaranteed to be SANDBOX_STATE_MIN_SPACE bytes 148 * of free space, so error checking is not required for fdt_setprop...() 149 * calls which add up to less than this much space. 150 * 151 * For adding larger properties, use state_setprop(). 152 * 153 * @param blob: Device tree blob holding state 154 * @param node: Node to write our state into 155 * 156 * Note that it is possible to save data as large blobs or as individual 157 * hierarchical properties. However, unless you intend to keep state files 158 * around for a long time and be able to run an old state file on a new 159 * sandbox, it might not be worth using individual properties for everything. 160 * This is certainly supported, it is just a matter of the effort you wish 161 * to put into the state read/write feature. 162 */ 163struct sandbox_state_io { 164 const char *name; 165 const char *compat; 166 int (*write)(void *blob, int node); 167 int (*read)(const void *blob, int node); 168}; 169 170/** 171 * SANDBOX_STATE_IO - Declare sandbox state to read/write 172 * 173 * Sandbox permits saving state from one run and restoring it in another. This 174 * allows the test system to retain state between runs and thus better 175 * emulate a real system. Examples of state that might be useful to save are 176 * the emulated GPIOs pin settings, flash memory contents and TPM private 177 * data. U-Boot memory contents is dealth with separately since it is large 178 * and it is not normally useful to save it (since a normal system does not 179 * preserve DRAM between runs). See the '-m' option for this. 180 * 181 * See struct sandbox_state_io above for member documentation. 182 */ 183#define SANDBOX_STATE_IO(_name, _compat, _read, _write) \ 184 ll_entry_declare(struct sandbox_state_io, _name, state_io) = { \ 185 .name = __stringify(_name), \ 186 .read = _read, \ 187 .write = _write, \ 188 .compat = _compat, \ 189 } 190 191/** 192 * Gets a pointer to the current state. 193 * 194 * Return: pointer to state 195 */ 196struct sandbox_state *state_get_current(void); 197 198/** 199 * Read the sandbox state from the supplied device tree file 200 * 201 * This calls all registered state handlers to read in the sandbox state 202 * from a previous test run. 203 * 204 * @param state Sandbox state to update 205 * @param fname Filename of device tree file to read from 206 * Return: 0 if OK, -ve on error 207 */ 208int sandbox_read_state(struct sandbox_state *state, const char *fname); 209 210/** 211 * Write the sandbox state to the supplied device tree file 212 * 213 * This calls all registered state handlers to write out the sandbox state 214 * so that it can be preserved for a future test run. 215 * 216 * If the file exists it is overwritten. 217 * 218 * @param state Sandbox state to update 219 * @param fname Filename of device tree file to write to 220 * Return: 0 if OK, -ve on error 221 */ 222int sandbox_write_state(struct sandbox_state *state, const char *fname); 223 224/** 225 * Add a property to a sandbox state node 226 * 227 * This is equivalent to fdt_setprop except that it automatically enlarges 228 * the device tree if necessary. That means it is safe to write any amount 229 * of data here. 230 * 231 * This function can only be called from within struct sandbox_state_io's 232 * ->write method, i.e. within state I/O drivers. 233 * 234 * @param node Device tree node to write to 235 * @param prop_name Property to write 236 * @param data Data to write into property 237 * @param size Size of data to write into property 238 */ 239int state_setprop(int node, const char *prop_name, const void *data, int size); 240 241/** 242 * Control skipping of time delays 243 * 244 * Some tests have unnecessay time delays (e.g. USB). Allow these to be 245 * skipped to speed up testing 246 * 247 * @param skip_delays true to skip delays from now on, false to honour delay 248 * requests 249 */ 250void state_set_skip_delays(bool skip_delays); 251 252/** 253 * See if delays should be skipped 254 * 255 * Return: true if delays should be skipped, false if they should be honoured 256 */ 257bool state_get_skip_delays(void); 258 259/** 260 * state_reset_for_test() - Reset ready to re-run tests 261 * 262 * This clears out any test state ready for another test run. 263 */ 264void state_reset_for_test(struct sandbox_state *state); 265 266/** 267 * state_show() - Show information about the sandbox state 268 * 269 * @param state Sandbox state to show 270 */ 271void state_show(struct sandbox_state *state); 272 273/** 274 * state_get_rel_filename() - Get a filename relative to the executable 275 * 276 * This uses argv[0] to obtain a filename path 277 * 278 * @rel_path: Relative path to build, e.g. "arch/sandbox/dts/test.dtb". Must not 279 * have a trailing / 280 * @buf: Buffer to use to return the filename 281 * @size: Size of buffer 282 * @return length of filename (including terminator), -ENOSPC if @size is too 283 * small 284 */ 285int state_get_rel_filename(const char *rel_path, char *buf, int size); 286 287/** 288 * state_load_other_fdt() - load the 'other' FDT into a buffer 289 * 290 * This loads the other.dtb file into a buffer. This is typically used in tests. 291 * 292 * @bufp: Place to put allocated buffer pointer. The buffer is read using 293 * os_read_file() which calls os_malloc(), so does affect U-Boot's own malloc() 294 * space 295 * @sizep: Returns the size of the buffer 296 * @return 0 if OK, -ve on error 297 */ 298int state_load_other_fdt(const char **bufp, int *sizep); 299 300/** 301 * Initialize the test system state 302 */ 303int state_init(void); 304 305/** 306 * Uninitialize the test system state, writing out state if configured to 307 * do so. 308 * 309 * Return: 0 if OK, -ve on error 310 */ 311int state_uninit(void); 312 313#endif 314