Gitiles
Code Review Sign In
review.coreboot.org / coreboot / cd474afd08356bb4dbc7f0b73e9927c05defe3d8 / . / util / superiotool / README
blob: b60e861541bbf6c7ff54fcbd45cb15e6300281a5 [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
Uwe Hermanncd474af2008-01-18 18:04:28 +0000[diff] [blame^]36 -l | --list-supported Show the list of supported Super I/O chips
Uwe Hermanneddc4732007-09-20 23:57:44 +0000[diff] [blame]37 -V | --verbose Verbose mode
38 -v | --version Show the superiotool version
39 -h | --help Show a short help text
Uwe Hermanne4749562007-09-19 16:26:18 +0000[diff] [blame]40
41Per default (no options) superiotool will just probe for a Super I/O
Uwe Hermanne4d4eba2007-10-01 13:39:02 +0000[diff] [blame]42and print its vendor, name, ID, revision, and config port.
Uwe Hermanne4749562007-09-19 16:26:18 +0000[diff] [blame]43
44Typical usage of superiotool:
45
46 - Probe/detect the Super I/O in your mainboard:
47
48 $ superiotool
49
Uwe Hermanneddc4732007-09-20 23:57:44 +0000[diff] [blame]50 - Register dump as table of hex-values of the Super I/O (if detected):
Uwe Hermanne4749562007-09-19 16:26:18 +0000[diff] [blame]51
52 $ superiotool -d
Uwe Hermannd8a18a22007-09-18 00:01:27 +0000[diff] [blame]53
Uwe Hermannd8a18a22007-09-18 00:01:27 +0000[diff] [blame]54
55Supported Super I/O Chips
56-------------------------
57
Uwe Hermanncd474af2008-01-18 18:04:28 +0000[diff] [blame^]58Please see http://coreboot.org/Superiotool#Supported_devices, or type
59
60 $ superiotool -l
Uwe Hermannd8a18a22007-09-18 00:01:27 +0000[diff] [blame]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
Uwe Hermanncd474af2008-01-18 18:04:28 +0000[diff] [blame^]63chips on that web page. Please send further register dumps (either from a
Stefan Reinauer997afe62008-01-18 15:34:24 +0000[diff] [blame]64proprietary BIOS and/or from coreboot) to the coreboot mailing list
65(http://coreboot.org/Mailinglist).
Uwe Hermann84bf1e22007-10-07 19:10:24 +0000[diff] [blame]66
Uwe Hermannd8a18a22007-09-18 00:01:27 +0000[diff] [blame]67
68Website and Mailing List
69------------------------
70
Stefan Reinauer997afe62008-01-18 15:34:24 +0000[diff] [blame]71The main website is http://coreboot.org/Superiotool.
Uwe Hermannd8a18a22007-09-18 00:01:27 +0000[diff] [blame]72
73For additional information, patches, and discussions, please join the
Stefan Reinauer997afe62008-01-18 15:34:24 +0000[diff] [blame]74coreboot mailing list at http://coreboot.org/Mailinglist, where most
Uwe Hermannd8a18a22007-09-18 00:01:27 +0000[diff] [blame]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),
Uwe Hermanncd474af2008-01-18 18:04:28 +0000[diff] [blame^]85either version 2 of the license, or (at your option) any later version.
Uwe Hermannd8a18a22007-09-18 00:01:27 +0000[diff] [blame]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>
Uwe Hermann59b99d92007-11-29 02:43:50 +0000[diff] [blame]93Frieder Ferlemann <Frieder.Ferlemann@web.de>
94Idwer Vollering <idwer_v@hotmail.com>
Uwe Hermann84bf1e22007-10-07 19:10:24 +0000[diff] [blame]95Rasmus Wiman <rasmus@wiman.org>
96Robinson P. Tryon <bishop.robinson@gmail.com>
97Ronald Minnich <rminnich@gmail.com>
98Stefan Reinauer <stepan@coresystems.de>
Uwe Hermann59b99d92007-11-29 02:43:50 +0000[diff] [blame]99Ulf Jordan <jordan@chalmers.se>
Uwe Hermann84bf1e22007-10-07 19:10:24 +0000[diff] [blame]100Uwe Hermann <uwe@hermann-uwe.de>
101Ward Vandewege <ward@gnu.org>
102