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