Gitiles
Code Review Sign In
review.coreboot.org / coreboot / 9631016660423d0585a1 / . / util / superiotool / README
blob: 7ff6138e2d4be8386c7a5731e8f27c9301019bfb [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
Paul Menzel4d6ab4e2013-04-03 23:10:22 +0200[diff] [blame]21 $ git clone http://review.coreboot.org/p/coreboot.git
Uwe Hermannd8a18a22007-09-18 00:01:27 +0000[diff] [blame]22
Paul Menzel72ef8882013-04-04 14:12:26 +0200[diff] [blame]23 $ cd coreboot/util/superiotool
Uwe Hermann6dbc0e12007-10-11 18:30:05 +0000[diff] [blame]24
Uwe Hermann480b37f2010-01-24 17:29:38 +0000[diff] [blame]25Optional: Edit the Makefile and set 'CONFIG_PCI = no' if you don't want to
26support PCI-attached "Super I/Os" (which needs libpci-dev) such as the
27VIA VT82686A/B southbridge with integrated Super I/O functionality.
28
Uwe Hermannd8a18a22007-09-18 00:01:27 +0000[diff] [blame]29 $ make
30
31 $ sudo make install
32
33
34Usage
35-----
36
Uwe Hermann969a9f62008-03-17 13:43:48 +0000[diff] [blame]37Please read the superiotool(8) manpage or type 'superiotool --help'.
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 Hermannd8a18a22007-09-18 00:01:27 +0000[diff] [blame]52
53Supported Super I/O Chips
54-------------------------
55
Uwe Hermanncd474af2008-01-18 18:04:28 +0000[diff] [blame]56Please see http://coreboot.org/Superiotool#Supported_devices, or type
57
58 $ superiotool -l
Uwe Hermannd8a18a22007-09-18 00:01:27 +0000[diff] [blame]59
Uwe Hermann84bf1e22007-10-07 19:10:24 +0000[diff] [blame]60There's also a collection of sample register dumps from various Super I/O
Uwe Hermanncd474af2008-01-18 18:04:28 +0000[diff] [blame]61chips on that web page. Please send further register dumps (either from a
Stefan Reinauer997afe62008-01-18 15:34:24 +0000[diff] [blame]62proprietary BIOS and/or from coreboot) to the coreboot mailing list
63(http://coreboot.org/Mailinglist).
Uwe Hermann84bf1e22007-10-07 19:10:24 +0000[diff] [blame]64
Uwe Hermannd8a18a22007-09-18 00:01:27 +0000[diff] [blame]65
66Website and Mailing List
67------------------------
68
Stefan Reinauer997afe62008-01-18 15:34:24 +0000[diff] [blame]69The main website is http://coreboot.org/Superiotool.
Uwe Hermannd8a18a22007-09-18 00:01:27 +0000[diff] [blame]70
71For additional information, patches, and discussions, please join the
Stefan Reinauer997afe62008-01-18 15:34:24 +0000[diff] [blame]72coreboot mailing list at http://coreboot.org/Mailinglist, where most
Uwe Hermannd8a18a22007-09-18 00:01:27 +0000[diff] [blame]73superiotool developers are subscribed.
74
75
76Copyright and License
77---------------------
78
79Superiotool is copyrighted by a number of individual developers. Please
80refer to the respective source code files for details.
81
82It is licensed under the terms of the GNU General Public License (GPL),
Uwe Hermanncd474af2008-01-18 18:04:28 +0000[diff] [blame]83either version 2 of the license, or (at your option) any later version.
Uwe Hermannd8a18a22007-09-18 00:01:27 +0000[diff] [blame]84
Uwe Hermann84bf1e22007-10-07 19:10:24 +0000[diff] [blame]85
86Contributors
87------------
88
Uwe Hermann2ca94912010-01-24 17:15:25 +0000[diff] [blame]89Anders Juel Jensen <andersjjensen@gmail.com>
Andriy Gaponc880a362008-10-19 21:03:41 +0000[diff] [blame]90Andriy Gapon <avg@icyb.net.ua>
Uwe Hermann2ca94912010-01-24 17:15:25 +0000[diff] [blame]91Arjan Koers <0h3q2rmn2bdb@list.nospam.xutrox.com>
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>
Uwe Hermann2ca94912010-01-24 17:15:25 +0000[diff] [blame]94David Bartley <dtbartle@csclub.uwaterloo.ca>
Uwe Hermann84bf1e22007-10-07 19:10:24 +0000[diff] [blame]95David Hendricks <david.hendricks@gmail.com>
Edward O'Callaghan5b5f8342014-01-26 00:19:58 +1100[diff] [blame]96Edward O'Callaghan <eocallaghan@alterapraxis.com>
Uwe Hermann2ca94912010-01-24 17:15:25 +0000[diff] [blame]97François-Regis Vuillemin <coreboot@miradou.com>
Uwe Hermann59b99d92007-11-29 02:43:50 +0000[diff] [blame]98Frieder Ferlemann <Frieder.Ferlemann@web.de>
99Idwer Vollering <idwer_v@hotmail.com>
Uwe Hermann2ca94912010-01-24 17:15:25 +0000[diff] [blame]100Ioannis Barkas <tripl3fault@yahoo.com>
Josh Profittb9c6b0e2008-10-14 16:28:50 +0000[diff] [blame]101Josh Profitt <zorn169@gmail.com>
Uwe Hermann2ca94912010-01-24 17:15:25 +0000[diff] [blame]102Luc Verhaegen <libv@skynet.be>
103Michael Gold <mgold@ncf.ca>
Uwe Hermann83da8dc2009-03-25 17:38:40 +0000[diff] [blame]104Michał Mirosław <mirq-linux@rere.qmqm.pl>
Uwe Hermann2ca94912010-01-24 17:15:25 +0000[diff] [blame]105Nikos Barkas <levelwol@gmail.com>
Uwe Hermann84bf1e22007-10-07 19:10:24 +0000[diff] [blame]106Rasmus Wiman <rasmus@wiman.org>
107Robinson P. Tryon <bishop.robinson@gmail.com>
Ronald Hoogenboom0be73bb2008-02-25 22:32:41 +0000[diff] [blame]108Ronald Hoogenboom <hoogenboom30@zonnet.nl>
Uwe Hermann84bf1e22007-10-07 19:10:24 +0000[diff] [blame]109Ronald Minnich <rminnich@gmail.com>
Uwe Hermann2ca94912010-01-24 17:15:25 +0000[diff] [blame]110Sean Young <sean@mess.org>
Uwe Hermann84bf1e22007-10-07 19:10:24 +0000[diff] [blame]111Stefan Reinauer <stepan@coresystems.de>
Uwe Hermann2ca94912010-01-24 17:15:25 +0000[diff] [blame]112Tom Sylla <tsylla@gmail.com>
Uwe Hermann59b99d92007-11-29 02:43:50 +0000[diff] [blame]113Ulf Jordan <jordan@chalmers.se>
Urja Rannikko38204a22008-10-23 23:33:18 +0000[diff] [blame]114Urja Rannikko <urjaman@gmail.com>
Uwe Hermann84bf1e22007-10-07 19:10:24 +0000[diff] [blame]115Uwe Hermann <uwe@hermann-uwe.de>
116Ward Vandewege <ward@gnu.org>
Wilbert Duijvenvoorde21648312014-03-12 11:19:31 +0100[diff] [blame]117Wilbert Duijvenvoorde <w.a.n.duijvenvoorde@gmail.com>