-------------------------------------------------------------------------------
Superiotool README
-------------------------------------------------------------------------------

Superiotool is a user-space utility which can

 - detect which Super I/O chip is soldered onto your mainboard,

 - at which configuration port it's located (usually 0x2e or 0x4e), and

 - dump all register contents of the Super I/O chip, together with the
   default values as per datasheet (to make comparing the values easy).

It is mainly used for coreboot development purposes (see coreboot.org
for details on coreboot), but it may also be useful for other things.


Installation
------------

 $ git clone https://review.coreboot.org/coreboot.git

 $ cd coreboot/util/superiotool

Optional: Edit the Makefile and set 'CONFIG_PCI = no' if you don't want to
support PCI-attached "Super I/Os" (which needs libpci-dev) such as the
VIA VT82686A/B southbridge with integrated Super I/O functionality.

 $ make

 $ sudo make install


Usage
-----

Please read the superiotool(8) manpage or type 'superiotool --help'.

Per default (no options) superiotool will just probe for a Super I/O
and print its vendor, name, ID, revision, and config port.

Typical usage of superiotool:

 - Probe/detect the Super I/O in your mainboard:

   $ superiotool

 - Register dump as table of hex-values of the Super I/O (if detected):

   $ superiotool -d


Supported Super I/O Chips
-------------------------

Please see https://www.coreboot.org/Superiotool#Supported_devices, or type

 $ superiotool -l

There's also a collection of sample register dumps from various Super I/O
chips on that web page. Please send further register dumps (either from a
proprietary BIOS and/or from coreboot) to the coreboot mailing list
(https://www.coreboot.org/Mailinglist).


Website and Mailing List
------------------------

The main website is https://www.coreboot.org/Superiotool.

For additional information, patches, and discussions, please join the
coreboot mailing list at https://www.coreboot.org/Mailinglist, where most
superiotool developers are subscribed.


Copyright and License
---------------------

Superiotool is copyrighted by a number of individual developers. Please
refer to the respective source code files for details.

It is licensed under the terms of the GNU General Public License (GPL),
either version 2 of the license, or (at your option) any later version.


Contributors
------------

Anders Juel Jensen <[email protected]>
Andriy Gapon <[email protected]>
Arjan Koers <[email protected]>
Bingxun Shi <[email protected]>
Carl-Daniel Hailfinger <[email protected]>
David Bartley <[email protected]>
David Hendricks <[email protected]>
Edward O'Callaghan <[email protected]>
François-Regis Vuillemin <[email protected]>
Frieder Ferlemann <[email protected]>
Idwer Vollering <[email protected]>
Ioannis Barkas <[email protected]>
Josh Profitt <[email protected]>
Luc Verhaegen <[email protected]>
Michael Gold <[email protected]>
Michał Mirosław <[email protected]>
Nicola Corna <[email protected]>
Nikos Barkas <[email protected]>
Rasmus Wiman <[email protected]>
Robinson P. Tryon <[email protected]>
Ronald Hoogenboom <[email protected]>
Ronald Minnich <[email protected]>
Sean Young <[email protected]>
Stefan Reinauer <[email protected]>
Tom Sylla <[email protected]>
Ulf Jordan <[email protected]>
Urja Rannikko <[email protected]>
Uwe Hermann <[email protected]>
Ward Vandewege <[email protected]>
Wilbert Duijvenvoorde <[email protected]>