arch/sandbox/include/asm/state.h

   1 /* SPDX-License-Identifier: GPL-2.0+ */
   2 /*
   3  * Copyright (c) 2011-2012 The Chromium OS Authors.
   4  */
   5
   6 #ifndef __SANDBOX_STATE_H
   7 #define __SANDBOX_STATE_H
   8
   9 #include <config.h>
  10 #include <sysreset.h>
  11 #include <stdbool.h>
  12 #include <linux/list.h>
  13 #include <linux/stringify.h>
  14
  15 /**
  16  * Selects the behavior of the serial terminal.
  17  *
  18  * If Ctrl-C is processed by U-Boot, then the only way to quit sandbox is with
  19  * the 'reset' command, or equivalent.
  20  *
  21  * If the terminal is cooked, then Ctrl-C will terminate U-Boot, and the
  22  * command line will not be quite such a faithful emulation.
  23  *
  24  * Options are:
  25  *
  26  *      raw-with-sigs           - Raw, but allow signals (Ctrl-C will quit)
  27  *      raw                     - Terminal is always raw
  28  *      cooked                  - Terminal is always cooked
  29  */
  30 enum state_terminal_raw {
  31         STATE_TERM_RAW_WITH_SIGS,       /* Default */
  32         STATE_TERM_RAW,
  33         STATE_TERM_COOKED,
  34
  35         STATE_TERM_COUNT,
  36 };
  37
  38 struct sandbox_spi_info {
  39         struct udevice *emul;
  40 };
  41
  42 struct sandbox_wdt_info {
  43         unsigned long long counter;
  44         uint reset_count;
  45         bool running;
  46 };
  47
  48 /**
  49  * struct sandbox_mapmem_entry - maps pointers to/from U-Boot addresses
  50  *
  51  * When map_to_sysmem() is called with an address outside sandbox's emulated
  52  * RAM, a record is created with a tag that can be used to reference that
  53  * pointer. When map_sysmem() is called later with that tag, the pointer will
  54  * be returned, just as it would for a normal sandbox address.
  55  *
  56  * @tag: Address tag (a value which U-Boot uses to refer to the address)
  57  * @ptr: Associated pointer for that tag
  58  */
  59 struct sandbox_mapmem_entry {
  60         ulong tag;
  61         void *ptr;
  62         struct list_head sibling_node;
  63 };
  64
  65 /* The complete state of the test system */
  66 struct sandbox_state {
  67         const char *cmd;                /* Command to execute */
  68         bool interactive;               /* Enable cmdline after execute */
  69         bool run_distro_boot;           /* Automatically run distro bootcommands */
  70         const char *fdt_fname;          /* Filename of FDT binary */
  71         const char *parse_err;          /* Error to report from parsing */
  72         int argc;                       /* Program arguments */
  73         char **argv;                    /* Command line arguments */
  74         const char *jumped_fname;       /* Jumped from previous U_Boot */
  75         uint8_t *ram_buf;               /* Emulated RAM buffer */
  76         unsigned long ram_size;         /* Size of RAM buffer */
  77         const char *ram_buf_fname;      /* Filename to use for RAM buffer */
  78         bool ram_buf_rm;                /* Remove RAM buffer file after read */
  79         bool write_ram_buf;             /* Write RAM buffer on exit */
  80         const char *state_fname;        /* File containing sandbox state */
  81         void *state_fdt;                /* Holds saved state for sandbox */
  82         bool read_state;                /* Read sandbox state on startup */
  83         bool write_state;               /* Write sandbox state on exit */
  84         bool ignore_missing_state_on_read;      /* No error if state missing */
  85         bool show_lcd;                  /* Show LCD on start-up */
  86         bool double_lcd;                /* Double display size for high-DPI */
  87         enum sysreset_t last_sysreset;  /* Last system reset type */
  88         bool sysreset_allowed[SYSRESET_COUNT];  /* Allowed system reset types */
  89         enum state_terminal_raw term_raw;       /* Terminal raw/cooked */
  90         bool skip_delays;               /* Ignore any time delays (for test) */
  91         bool show_test_output;          /* Don't suppress stdout in tests */
  92         int default_log_level;          /* Default log level for sandbox */
  93         bool ram_buf_read;              /* true if we read the RAM buffer */
  94         bool run_unittests;             /* Run unit tests */
  95         const char *select_unittests;   /* Unit test to run */
  96         bool handle_signals;            /* Handle signals within sandbox */
  97         bool autoboot_keyed;            /* Use keyed-autoboot feature */
  98
  99         /* Pointer to information for each SPI bus/cs */
 100         struct sandbox_spi_info spi[CONFIG_SANDBOX_SPI_MAX_BUS]
 101                                         [CONFIG_SANDBOX_SPI_MAX_CS];
 102
 103         /* Information about Watchdog */
 104         struct sandbox_wdt_info wdt;
 105
 106         ulong next_tag;                 /* Next address tag to allocate */
 107         struct list_head mapmem_head;   /* struct sandbox_mapmem_entry */
 108         bool hwspinlock;                /* Hardware Spinlock status */
 109         bool allow_memio;               /* Allow readl() etc. to work */
 110
 111         /*
 112          * This struct is getting large.
 113          *
 114          * Consider putting test data in driver-private structs, like
 115          * sandbox_pch.c.
 116          *
 117          * If you add new members, please put them above this comment.
 118          */
 119 };
 120
 121 /* Minimum space we guarantee in the state FDT when calling read/write*/
 122 #define SANDBOX_STATE_MIN_SPACE         0x1000
 123
 124 /**
 125  * struct sandbox_state_io - methods to saved/restore sandbox state
 126  * @name: Name of of the device tree node, also the name of the variable
 127  *      holding this data so it should be an identifier (use underscore
 128  *      instead of minus)
 129  * @compat: Compatible string for the node containing this state
 130  *
 131  * @read: Function to read state from FDT
 132  *      If data is available, then blob and node will provide access to it. If
 133  *      not (blob == NULL and node == -1) this function should set up an empty
 134  *      data set for start-of-day.
 135  *      @param blob: Pointer to device tree blob, or NULL if no data to read
 136  *      @param node: Node offset to read from
 137  *      Return: 0 if OK, -ve on error
 138  *
 139  * @write: Function to write state to FDT
 140  *      The caller will ensure that there is a node ready for the state. The
 141  *      node may already contain the old state, in which case it should be
 142  *      overridden. There is guaranteed to be SANDBOX_STATE_MIN_SPACE bytes
 143  *      of free space, so error checking is not required for fdt_setprop...()
 144  *      calls which add up to less than this much space.
 145  *
 146  *      For adding larger properties, use state_setprop().
 147  *
 148  * @param blob: Device tree blob holding state
 149  * @param node: Node to write our state into
 150  *
 151  * Note that it is possible to save data as large blobs or as individual
 152  * hierarchical properties. However, unless you intend to keep state files
 153  * around for a long time and be able to run an old state file on a new
 154  * sandbox, it might not be worth using individual properties for everything.
 155  * This is certainly supported, it is just a matter of the effort you wish
 156  * to put into the state read/write feature.
 157  */
 158 struct sandbox_state_io {
 159         const char *name;
 160         const char *compat;
 161         int (*write)(void *blob, int node);
 162         int (*read)(const void *blob, int node);
 163 };
 164
 165 /**
 166  * SANDBOX_STATE_IO - Declare sandbox state to read/write
 167  *
 168  * Sandbox permits saving state from one run and restoring it in another. This
 169  * allows the test system to retain state between runs and thus better
 170  * emulate a real system. Examples of state that might be useful to save are
 171  * the emulated GPIOs pin settings, flash memory contents and TPM private
 172  * data. U-Boot memory contents is dealth with separately since it is large
 173  * and it is not normally useful to save it (since a normal system does not
 174  * preserve DRAM between runs). See the '-m' option for this.
 175  *
 176  * See struct sandbox_state_io above for member documentation.
 177  */
 178 #define SANDBOX_STATE_IO(_name, _compat, _read, _write) \
 179         ll_entry_declare(struct sandbox_state_io, _name, state_io) = { \
 180                 .name = __stringify(_name), \
 181                 .read = _read, \
 182                 .write = _write, \
 183                 .compat = _compat, \
 184         }
 185
 186 /**
 187  * Gets a pointer to the current state.
 188  *
 189  * Return: pointer to state
 190  */
 191 struct sandbox_state *state_get_current(void);
 192
 193 /**
 194  * Read the sandbox state from the supplied device tree file
 195  *
 196  * This calls all registered state handlers to read in the sandbox state
 197  * from a previous test run.
 198  *
 199  * @param state         Sandbox state to update
 200  * @param fname         Filename of device tree file to read from
 201  * Return: 0 if OK, -ve on error
 202  */
 203 int sandbox_read_state(struct sandbox_state *state, const char *fname);
 204
 205 /**
 206  * Write the sandbox state to the supplied device tree file
 207  *
 208  * This calls all registered state handlers to write out the sandbox state
 209  * so that it can be preserved for a future test run.
 210  *
 211  * If the file exists it is overwritten.
 212  *
 213  * @param state         Sandbox state to update
 214  * @param fname         Filename of device tree file to write to
 215  * Return: 0 if OK, -ve on error
 216  */
 217 int sandbox_write_state(struct sandbox_state *state, const char *fname);
 218
 219 /**
 220  * Add a property to a sandbox state node
 221  *
 222  * This is equivalent to fdt_setprop except that it automatically enlarges
 223  * the device tree if necessary. That means it is safe to write any amount
 224  * of data here.
 225  *
 226  * This function can only be called from within struct sandbox_state_io's
 227  * ->write method, i.e. within state I/O drivers.
 228  *
 229  * @param node          Device tree node to write to
 230  * @param prop_name     Property to write
 231  * @param data          Data to write into property
 232  * @param size          Size of data to write into property
 233  */
 234 int state_setprop(int node, const char *prop_name, const void *data, int size);
 235
 236 /**
 237  * Control skipping of time delays
 238  *
 239  * Some tests have unnecessay time delays (e.g. USB). Allow these to be
 240  * skipped to speed up testing
 241  *
 242  * @param skip_delays   true to skip delays from now on, false to honour delay
 243  *                      requests
 244  */
 245 void state_set_skip_delays(bool skip_delays);
 246
 247 /**
 248  * See if delays should be skipped
 249  *
 250  * Return: true if delays should be skipped, false if they should be honoured
 251  */
 252 bool state_get_skip_delays(void);
 253
 254 /**
 255  * state_reset_for_test() - Reset ready to re-run tests
 256  *
 257  * This clears out any test state ready for another test run.
 258  */
 259 void state_reset_for_test(struct sandbox_state *state);
 260
 261 /**
 262  * state_show() - Show information about the sandbox state
 263  *
 264  * @param state         Sandbox state to show
 265  */
 266 void state_show(struct sandbox_state *state);
 267
 268 /**
 269  * Initialize the test system state
 270  */
 271 int state_init(void);
 272
 273 /**
 274  * Uninitialize the test system state, writing out state if configured to
 275  * do so.
 276  *
 277  * Return: 0 if OK, -ve on error
 278  */
 279 int state_uninit(void);
 280
 281 #endif