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