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