root/trunk/util/superiotool/README

Revision 3163, 2.7 kB (checked in by uwe, 7 months ago)

Various smaller fixes in superiotool:

  • Also dump the extra registers (e.g. EC regs) in --list-supported.
  • Small fix in the code to allow for building with -pedantic (yes, the fix is a bit silly, but it's simple and allows us to use the -pedantic flag to keep the code even cleaner and nicer).
  • Install the binary in /usr/sbin, as it's meant to be run as root.
  • Small typo in README.

Signed-off-by: Uwe Hermann <uwe@…>
Acked-by: Stefan Reinauer <stepan@…>
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
25 $ make
26
27 $ sudo make install
28
29
30Usage
31-----
32
33Please read the superiotool(8) manpage or type 'superiotool --help'.
34
35Per default (no options) superiotool will just probe for a Super I/O
36and print its vendor, name, ID, revision, and config port.
37
38Typical usage of superiotool:
39
40 - Probe/detect the Super I/O in your mainboard:
41
42   $ superiotool
43
44 - Register dump as table of hex-values of the Super I/O (if detected):
45
46   $ superiotool -d
47
48
49Supported Super I/O Chips
50-------------------------
51
52Please see http://coreboot.org/Superiotool#Supported_devices, or type
53
54 $ superiotool -l
55
56There's also a collection of sample register dumps from various Super I/O
57chips on that web page. Please send further register dumps (either from a
58proprietary BIOS and/or from coreboot) to the coreboot mailing list
59(http://coreboot.org/Mailinglist).
60
61
62Website and Mailing List
63------------------------
64
65The main website is http://coreboot.org/Superiotool.
66
67For additional information, patches, and discussions, please join the
68coreboot mailing list at http://coreboot.org/Mailinglist, where most
69superiotool developers are subscribed.
70
71
72Copyright and License
73---------------------
74
75Superiotool is copyrighted by a number of individual developers. Please
76refer to the respective source code files for details.
77
78It is licensed under the terms of the GNU General Public License (GPL),
79either version 2 of the license, or (at your option) any later version.
80
81
82Contributors
83------------
84
85Bingxun Shi <bingxunshi@gmail.com>
86Carl-Daniel Hailfinger <c-d.hailfinger.devel.2006@gmx.net>
87David Hendricks <david.hendricks@gmail.com>
88Frieder Ferlemann <Frieder.Ferlemann@web.de>
89Idwer Vollering <idwer_v@hotmail.com>
90Rasmus Wiman <rasmus@wiman.org>
91Robinson P. Tryon <bishop.robinson@gmail.com>
92Ronald Hoogenboom <hoogenboom30@zonnet.nl>
93Ronald Minnich <rminnich@gmail.com>
94Stefan Reinauer <stepan@coresystems.de>
95Ulf Jordan <jordan@chalmers.se>
96Uwe Hermann <uwe@hermann-uwe.de>
97Ward Vandewege <ward@gnu.org>
Note: See TracBrowser for help on using the browser.