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