blob: f0294d41cc9a8a77c6234b18693d805b55c951db [file] [log] [blame]
Uwe Hermannd8a18a22007-09-18 00:01:27 +00001-------------------------------------------------------------------------------
2Superiotool README
3-------------------------------------------------------------------------------
4
5Superiotool 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
14It is mainly used for LinuxBIOS development purposes (see linuxbios.org
15for details on LinuxBIOS), but it may also be useful for other things.
16
17
18Installation
19------------
20
21 $ svn co svn://linuxbios.org/repos/trunk/util/superiotool
22
23 $ make
24
25 $ sudo make install
26
27
28Usage
29-----
30
Uwe Hermanne4749562007-09-19 16:26:18 +000031 $ superiotool [-d] [-V] [-v] [-h]
Uwe Hermannd8a18a22007-09-18 00:01:27 +000032
Uwe Hermanne4749562007-09-19 16:26:18 +000033 -d | --dump Dump Super I/O registers
34 -V | --verbose Verbose mode
35 -v | --version Show the superiotool version
36 -h | --help Show a short help text
37
38Per default (no options) superiotool will just probe for a Super I/O
39and print its vendor, name, ID, version, and config port.
40
41Typical usage of superiotool:
42
43 - Probe/detect the Super I/O in your mainboard:
44
45 $ superiotool
46
47 - Detailed register dump of the Super I/O (if detected):
48
49 $ superiotool -d
Uwe Hermannd8a18a22007-09-18 00:01:27 +000050
51
52Supported Super I/O Chips
53-------------------------
54
55Please see http://linuxbios.org/Superiotool#Supported_devices.
56
57
58Website and Mailing List
59------------------------
60
61The main website is http://linuxbios.org/Superiotool.
62
63For additional information, patches, and discussions, please join the
64LinuxBIOS mailing list at http://linuxbios.org/Mailinglist, where most
65superiotool developers are subscribed.
66
67
68Copyright and License
69---------------------
70
71Superiotool is copyrighted by a number of individual developers. Please
72refer to the respective source code files for details.
73
74It is licensed under the terms of the GNU General Public License (GPL),
75either version 2 of the License, or (at your option) any later version.
76