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