config/README

   1 The files in this directory define a basic set of functionality for each
   2 board. They are loaded by calling "load_generic_config", normally done
   3 as part of the baseboard description for a given board.
   4
   5 This functionality is a partial replacement for the tool-specific
   6 configuration previously found in the testsuite/config directory. Note
   7 that no tool-specific actions are defined here; they still need to be
   8 defined by the tool-specific config files. However, for tools that
   9 simply wish to download and execute programs on a board, the
  10 functionality here should be sufficient.
  11
  12 The functions that can be defined are:
  13
  14 ${board}_open
  15 ${board}_close
  16 ${board}_exec
  17 ${board}_binary
  18 ${board}_reboot
  19 ${board}_download
  20 ${board}_upload
  21 ${board}_transmit
  22 ${board}_send
  23 ${board}_file
  24 ${board}_spawn
  25 ${board}_load
  26
  27 Normally these functions are invoked indirectly by the testcases when
  28 they invoke the remote_xxx version of the function.
  29
  30 The ${board}_xxx functions will be called in preference to the default
  31 versions (or the ones specified by the "connect" protocol in the board
  32 description). However, the version defined by the "connect" protocol
  33 are still accessible by calling remote_raw_xxx, which will ignore any
  34 board-specific or generic versions of these functions.