state.h 8.5 KB

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