Add a README for superiotool (trivial).
[coreboot.git] / util / superiotool / README
1 -------------------------------------------------------------------------------
2 Superiotool README
3 -------------------------------------------------------------------------------
4
5 Superiotool 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
14 It is mainly used for LinuxBIOS development purposes (see linuxbios.org
15 for details on LinuxBIOS), but it may also be useful for other things.
16
17
18 Installation
19 ------------
20
21  $ svn co svn://linuxbios.org/repos/trunk/util/superiotool
22
23  $ make
24
25  $ sudo make install
26
27
28 Usage
29 -----
30
31  $ superiotool
32
33 Currently the tool will automatically try to detect which Super I/O you
34 have, and also dump the register contents.
35
36
37 Supported Super I/O Chips
38 -------------------------
39
40 Please see http://linuxbios.org/Superiotool#Supported_devices.
41
42
43 Website and Mailing List
44 ------------------------
45
46 The main website is http://linuxbios.org/Superiotool.
47
48 For additional information, patches, and discussions, please join the
49 LinuxBIOS mailing list at http://linuxbios.org/Mailinglist, where most
50 superiotool developers are subscribed.
51
52
53 Copyright and License
54 ---------------------
55
56 Superiotool is copyrighted by a number of individual developers. Please
57 refer to the respective source code files for details.
58
59 It is licensed under the terms of the GNU General Public License (GPL),
60 either version 2 of the License, or (at your option) any later version.
61