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