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