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