source: trunk/util/superiotool/README

Last change on this file was 5050, checked in by uwe, 5 years ago

Document CONFIG_PCI usage in the README (trivial).

Signed-off-by: Uwe Hermann <uwe@…>
Acked-by: Uwe Hermann <uwe@…>

File size: 3.4 KB
Line 
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 coreboot development purposes (see coreboot.org
15for details on coreboot), but it may also be useful for other things.
16
17
18Installation
19------------
20
21 $ svn co svn://coreboot.org/repos/trunk/util/superiotool
22
23 $ cd superiotool
24
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
29 $ make
30
31 $ sudo make install
32
33
34Usage
35-----
36
37Please read the superiotool(8) manpage or type 'superiotool --help'.
38
39Per default (no options) superiotool will just probe for a Super I/O
40and print its vendor, name, ID, revision, and config port.
41
42Typical usage of superiotool:
43
44 - Probe/detect the Super I/O in your mainboard:
45
46   $ superiotool
47
48 - Register dump as table of hex-values of the Super I/O (if detected):
49
50   $ superiotool -d
51
52
53Supported Super I/O Chips
54-------------------------
55
56Please see http://coreboot.org/Superiotool#Supported_devices, or type
57
58 $ superiotool -l
59
60There's also a collection of sample register dumps from various Super I/O
61chips on that web page. Please send further register dumps (either from a
62proprietary BIOS and/or from coreboot) to the coreboot mailing list
63(http://coreboot.org/Mailinglist).
64
65
66Website and Mailing List
67------------------------
68
69The main website is http://coreboot.org/Superiotool.
70
71For additional information, patches, and discussions, please join the
72coreboot mailing list at http://coreboot.org/Mailinglist, where most
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),
83either version 2 of the license, or (at your option) any later version.
84
85
86Contributors
87------------
88
89Anders Juel Jensen <andersjjensen@gmail.com>
90Andriy Gapon <avg@icyb.net.ua>
91Arjan Koers <0h3q2rmn2bdb@list.nospam.xutrox.com>
92Bingxun Shi <bingxunshi@gmail.com>
93Carl-Daniel Hailfinger <c-d.hailfinger.devel.2006@gmx.net>
94David Bartley <dtbartle@csclub.uwaterloo.ca>
95David Hendricks <david.hendricks@gmail.com>
96François-Regis Vuillemin <coreboot@miradou.com>
97Frieder Ferlemann <Frieder.Ferlemann@web.de>
98Idwer Vollering <idwer_v@hotmail.com>
99Ioannis Barkas <tripl3fault@yahoo.com>
100Josh Profitt <zorn169@gmail.com>
101Luc Verhaegen <libv@skynet.be>
102Michael Gold <mgold@ncf.ca>
103Michał Mirosław <mirq-linux@rere.qmqm.pl>
104Nikos Barkas <levelwol@gmail.com>
105Rasmus Wiman <rasmus@wiman.org>
106Robinson P. Tryon <bishop.robinson@gmail.com>
107Ronald Hoogenboom <hoogenboom30@zonnet.nl>
108Ronald Minnich <rminnich@gmail.com>
109Sean Young <sean@mess.org>
110Stefan Reinauer <stepan@coresystems.de>
111Tom Sylla <tsylla@gmail.com>
112Ulf Jordan <jordan@chalmers.se>
113Urja Rannikko <urjaman@gmail.com>
114Uwe Hermann <uwe@hermann-uwe.de>
115Ward Vandewege <ward@gnu.org>
116
Note: See TracBrowser for help on using the repository browser.