README
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 $ git clone https://review.coreboot.org/coreboot.git
22
23 $ cd coreboot/util/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 https://www.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(https://www.coreboot.org/Mailinglist).
64
65
66Website and Mailing List
67------------------------
68
69The main website is https://www.coreboot.org/Superiotool.
70
71For additional information, patches, and discussions, please join the
72coreboot mailing list at https://www.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 <[email protected]>
90Andriy Gapon <[email protected]>
91Arjan Koers <[email protected]>
92Bingxun Shi <[email protected]>
93Carl-Daniel Hailfinger <[email protected]>
94David Bartley <[email protected]>
95David Hendricks <[email protected]>
96Edward O'Callaghan <[email protected]>
97François-Regis Vuillemin <[email protected]>
98Frieder Ferlemann <[email protected]>
99Idwer Vollering <[email protected]>
100Ioannis Barkas <[email protected]>
101Josh Profitt <[email protected]>
102Luc Verhaegen <[email protected]>
103Michael Gold <[email protected]>
104Michał Mirosław <[email protected]>
105Nicola Corna <[email protected]>
106Nikos Barkas <[email protected]>
107Rasmus Wiman <[email protected]>
108Robinson P. Tryon <[email protected]>
109Ronald Hoogenboom <[email protected]>
110Ronald Minnich <[email protected]>
111Sean Young <[email protected]>
112Stefan Reinauer <[email protected]>
113Tom Sylla <[email protected]>
114Ulf Jordan <[email protected]>
115Urja Rannikko <[email protected]>
116Uwe Hermann <[email protected]>
117Ward Vandewege <[email protected]>
118Wilbert Duijvenvoorde <[email protected]>
119