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