This file originates as //depot/hydra/main/common/README.txt.  It
documents the top-level directories in the Hydra common area.  If you
are seeing it anywhere other than //depot/hydra without this paragraph
altered, be wary as it has been integrated without the contents being
edited.

The Hydra common area has two purposes:
- defining the Hydra interface and providing associated tools for
  integration into other chip and host source code areas where the Hydra
  interface is used;
- sharing Hydra code between chip and host, as with other common areas.

The subdirectories are:

interface:
This contains XML files and C header files that define the Hydra
interface.  This is the key directory hierarchy required by all Hydra
subsystems; it will usually be integrated as a whole to within the
appropriate source code tree.  Some of the C headers are generated
automatically from the XML; these live under interface/gen.  Other
subdirectories include:
- slut: contains definitions for the symbol lookup table exported by
  Hydra subsystems, so that the Curator and host can read the table.
- drivers: contains host driver code in wide use across Hydra.  Within
  this:
  - trb: drivers for the Hydra transaction bridge hardware.
If the XML files are changed, the generated C headers should be
updated.  See tools/autogen/Readme.txt.

fsroot:
This directory is the file system root used by the tests scripts in the
scripts directory for finding patch and configuration files requested
by subsystems on the chip.  It contains binaries to be processed by on
chip code.

mib:
This contains code to define elements of the Management Information
Base (MIB), the configuration system used in the Hydra generic code.
Code here is specific to the Hydra generic code (chip and host); other
subsystems, even those sharing the basic MIB firmware, will probably not
wish to integrate this but create their own definitions.

scripts:
These are mostly test scripts in TCL used for basic sanity tests of
Hydra systems.  They do not form a complete test framework.  The scripts
run under 'expect' either from within the scripts directory itself or
from within the interface directory.  scripts/lib_tcl provides TCL
library functions for use by the scripts.

tools:
This includes the Perl scripts used to generate the files under
interface/gen; see tools/autogen/Readme.txt.  It also includes
(tools/wireshark) autogenerated code that can be used within Wireshark
for decoding traffic on the Hydra transaction bridge.  The
tools/uncrustify directory is used by the autogeneration scripts.

wireshark:
These are binary libraries for Wireshark, incorporating the code in
tools/wireshark.
