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  $ cd superiotool
  24
  25  $ make
  26
  27  $ sudo make install
  28
  29
  30 Usage
  31 -----
  32
  33  $ superiotool [-d] [-D] [-V] [-v] [-h]
  34
  35  -d | --dump            Dump Super I/O registers
  36  -D | --dump-readable   Dump Super I/O registers in human-readable format
  37  -V | --verbose         Verbose mode
  38  -v | --version         Show the superiotool version
  39  -h | --help            Show a short help text
  40
  41 Per default (no options) superiotool will just probe for a Super I/O
  42 and print its vendor, name, ID, revision, and config port.
  43
  44 Typical usage of superiotool:
  45
  46  - Probe/detect the Super I/O in your mainboard:
  47
  48    $ superiotool
  49
  50  - Register dump as table of hex-values of the Super I/O (if detected):
  51
  52    $ superiotool -d
  53
  54  - Detailed register dump in human-readable format:
  55
  56    $ superiotool -D
  57
  58
  59 Supported Super I/O Chips
  60 -------------------------
  61
  62 Please see http://linuxbios.org/Superiotool#Supported_devices.
  63
  64 There's also a collection of sample register dumps from various Super I/O
  65 chips on that page. Please send further register dumps (either from a
  66 proprietary BIOS and/or from LinuxBIOS) to the LinuxBIOS mailing list
  67 (http://linuxbios.org/Mailinglist).
  68
  69
  70 Website and Mailing List
  71 ------------------------
  72
  73 The main website is http://linuxbios.org/Superiotool.
  74
  75 For additional information, patches, and discussions, please join the
  76 LinuxBIOS mailing list at http://linuxbios.org/Mailinglist, where most
  77 superiotool developers are subscribed.
  78
  79
  80 Copyright and License
  81 ---------------------
  82
  83 Superiotool is copyrighted by a number of individual developers. Please
  84 refer to the respective source code files for details.
  85
  86 It is licensed under the terms of the GNU General Public License (GPL),
  87 either version 2 of the License, or (at your option) any later version.
  88
  89
  90 Contributors
  91 ------------
  92
  93 Carl-Daniel Hailfinger <c-d.hailfinger.devel.2006@gmx.net>
  94 David Hendricks <david.hendricks@gmail.com>
  95 Rasmus Wiman <rasmus@wiman.org>
  96 Robinson P. Tryon <bishop.robinson@gmail.com>
  97 Ronald Minnich <rminnich@gmail.com>
  98 Stefan Reinauer <stepan@coresystems.de>
  99 Uwe Hermann <uwe@hermann-uwe.de>
 100 Ward Vandewege <ward@gnu.org>
 101