util/superiotool/README

   1 -------------------------------------------------------------------------------
   2 Superiotool README
   3 -------------------------------------------------------------------------------
   4
   5 Superiotool is a user-space utility which can
   6
   7  - detect which Super I/O chip is soldered onto your mainboard,
   8
   9  - at which configuration port it's located (usually 0x2e or 0x4e), and
  10
  11  - dump all register contents of the Super I/O chip, together with the
  12    default values as per datasheet (to make comparing the values easy).
  13
  14 It is mainly used for LinuxBIOS development purposes (see linuxbios.org
  15 for details on LinuxBIOS), but it may also be useful for other things.
  16
  17
  18 Installation
  19 ------------
  20
  21  $ svn co svn://linuxbios.org/repos/trunk/util/superiotool
  22
  23  $ make
  24
  25  $ sudo make install
  26
  27
  28 Usage
  29 -----
  30
  31  $ superiotool [-d] [-D] [-V] [-v] [-h]
  32
  33  -d | --dump            Dump Super I/O registers
  34  -D | --dump-readable   Dump Super I/O registers in human-readable format
  35  -V | --verbose         Verbose mode
  36  -v | --version         Show the superiotool version
  37  -h | --help            Show a short help text
  38
  39 Per default (no options) superiotool will just probe for a Super I/O
  40 and print its vendor, name, ID, version, and config port.
  41
  42 Typical usage of superiotool:
  43
  44  - Probe/detect the Super I/O in your mainboard:
  45
  46    $ superiotool
  47
  48  - Register dump as table of hex-values of the Super I/O (if detected):
  49
  50    $ superiotool -d
  51
  52  - Detailed register dump in human-readable format:
  53
  54    $ superiotool -D
  55
  56
  57 Supported Super I/O Chips
  58 -------------------------
  59
  60 Please see http://linuxbios.org/Superiotool#Supported_devices.
  61
  62
  63 Website and Mailing List
  64 ------------------------
  65
  66 The main website is http://linuxbios.org/Superiotool.
  67
  68 For additional information, patches, and discussions, please join the
  69 LinuxBIOS mailing list at http://linuxbios.org/Mailinglist, where most
  70 superiotool developers are subscribed.
  71
  72
  73 Copyright and License
  74 ---------------------
  75
  76 Superiotool is copyrighted by a number of individual developers. Please
  77 refer to the respective source code files for details.
  78
  79 It is licensed under the terms of the GNU General Public License (GPL),
  80 either version 2 of the License, or (at your option) any later version.
  81