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 coreboot development purposes (see coreboot.org
  15 for details on coreboot), but it may also be useful for other things.
  16
  17
  18 Installation
  19 ------------
  20
  21  $ svn co svn://coreboot.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] [-l] [-V] [-v] [-h]
  34
  35  -d | --dump            Dump Super I/O register contents
  36  -e | --extra-dump      Dump Secondary registers too (like EC registers etc.)
  37  -l | --list-supported  Show the list of supported Super I/O chips
  38  -V | --verbose         Verbose mode
  39  -v | --version         Show the superiotool version
  40  -h | --help            Show a short help text
  41
  42 Per default (no options) superiotool will just probe for a Super I/O
  43 and print its vendor, name, ID, revision, and config port.
  44
  45 Typical usage of superiotool:
  46
  47  - Probe/detect the Super I/O in your mainboard:
  48
  49    $ superiotool
  50
  51  - Register dump as table of hex-values of the Super I/O (if detected):
  52
  53    $ superiotool -d
  54
  55
  56 Supported Super I/O Chips
  57 -------------------------
  58
  59 Please see http://coreboot.org/Superiotool#Supported_devices, or type
  60
  61  $ superiotool -l
  62
  63 There's also a collection of sample register dumps from various Super I/O
  64 chips on that web page. Please send further register dumps (either from a
  65 proprietary BIOS and/or from coreboot) to the coreboot mailing list
  66 (http://coreboot.org/Mailinglist).
  67
  68
  69 Website and Mailing List
  70 ------------------------
  71
  72 The main website is http://coreboot.org/Superiotool.
  73
  74 For additional information, patches, and discussions, please join the
  75 coreboot mailing list at http://coreboot.org/Mailinglist, where most
  76 superiotool developers are subscribed.
  77
  78
  79 Copyright and License
  80 ---------------------
  81
  82 Superiotool is copyrighted by a number of individual developers. Please
  83 refer to the respective source code files for details.
  84
  85 It is licensed under the terms of the GNU General Public License (GPL),
  86 either version 2 of the license, or (at your option) any later version.
  87
  88
  89 Contributors
  90 ------------
  91
  92 Bingxun Shi <bingxunshi@gmail.com>
  93 Carl-Daniel Hailfinger <c-d.hailfinger.devel.2006@gmx.net>
  94 David Hendricks <david.hendricks@gmail.com>
  95 Frieder Ferlemann <Frieder.Ferlemann@web.de>
  96 Idwer Vollering <idwer_v@hotmail.com>
  97 Rasmus Wiman <rasmus@wiman.org>
  98 Robinson P. Tryon <bishop.robinson@gmail.com>
  99 Ronald Hoogenboom <hoogenboom30@zonnet.nl>
 100 Ronald Minnich <rminnich@gmail.com>
 101 Stefan Reinauer <stepan@coresystems.de>
 102 Ulf Jordan <jordan@chalmers.se>
 103 Uwe Hermann <uwe@hermann-uwe.de>
 104 Ward Vandewege <ward@gnu.org>