Robinson P. Tryon | 552cfb7 | 2008-01-15 22:30:55 +0000 | [diff] [blame] | 1 | .TH SUPERIOTOOL 8 "January 13, 2008" |
Uwe Hermann | 0920357 | 2007-10-07 15:26:40 +0000 | [diff] [blame] | 2 | .SH NAME |
| 3 | superiotool \- Super I/O detection tool |
| 4 | .SH SYNOPSIS |
Robinson P. Tryon | 552cfb7 | 2008-01-15 22:30:55 +0000 | [diff] [blame] | 5 | .B superiotool \fR[\fB\-dlVvh\fR] |
Uwe Hermann | 0920357 | 2007-10-07 15:26:40 +0000 | [diff] [blame] | 6 | .SH DESCRIPTION |
| 7 | .B superiotool |
| 8 | is a GPL'd user-space utility which can |
| 9 | .PP |
| 10 | * detect which Super I/O chip is soldered onto your mainboard, |
| 11 | .PP |
| 12 | * at which configuration port it's located (usually 0x2e or 0x4e), and |
| 13 | .PP |
| 14 | * dump all register contents of the Super I/O chip, together with the |
| 15 | default values as per datasheet (to make comparing the values easy). |
| 16 | .PP |
Stefan Reinauer | 997afe6 | 2008-01-18 15:34:24 +0000 | [diff] [blame^] | 17 | It is mainly used for coreboot development purposes (see coreboot.org |
| 18 | for details on coreboot), but it may also be useful for other things. |
Uwe Hermann | 6dbc0e1 | 2007-10-11 18:30:05 +0000 | [diff] [blame] | 19 | .PP |
| 20 | The list of supported Super I/O chips is available at: |
| 21 | .br |
Stefan Reinauer | 997afe6 | 2008-01-18 15:34:24 +0000 | [diff] [blame^] | 22 | .B http://coreboot.org/Superiotool#Supported_devices |
Uwe Hermann | 0920357 | 2007-10-07 15:26:40 +0000 | [diff] [blame] | 23 | .SH OPTIONS |
| 24 | If no command line option is specified, |
| 25 | .B superiotool |
| 26 | merely tries to detect the Super I/O chip. |
Uwe Hermann | 59b99d9 | 2007-11-29 02:43:50 +0000 | [diff] [blame] | 27 | You must use the |
| 28 | .B "\-d" |
Uwe Hermann | 0920357 | 2007-10-07 15:26:40 +0000 | [diff] [blame] | 29 | option to dump the Super I/O register contents. |
| 30 | .TP |
| 31 | .B "\-d, \-\-dump" |
| 32 | Dump Super I/O registers (if the Super I/O chip is detected and |
| 33 | .B superiotool |
| 34 | supports the |
| 35 | .B "\-\-dump" |
Uwe Hermann | 6dbc0e1 | 2007-10-11 18:30:05 +0000 | [diff] [blame] | 36 | option for this chip). The output will look something like this: |
| 37 | .sp |
| 38 | .B "$ ./superiotool -d" |
| 39 | .br |
| 40 | Found SMSC FDC37N769 (id=0x28, rev=0x01) at 0x3f0 |
| 41 | .br |
| 42 | Register dump: |
| 43 | .br |
| 44 | idx 00 01 02 03 04 05 06 07 08 09 0a 0b 0c 0d 0e 0f 10 11... |
| 45 | .br |
| 46 | val 20 90 80 f4 00 00 ff 00 00 00 40 00 0e 28 01 00 00 00... |
| 47 | .br |
| 48 | def 28 9c 88 70 00 00 ff 00 00 00 00 00 02 28 NA 00 00 80... |
| 49 | .sp |
| 50 | The |
| 51 | .B idx |
| 52 | fields contain the register numbers/indexes of the Super I/O, the |
| 53 | .B val |
| 54 | fields contain the contents of the respective register as read from the |
| 55 | Super I/O, and the |
| 56 | .B def |
| 57 | fields contain the default values for the respective register, as specified |
| 58 | in the datasheet. |
| 59 | .sp |
| 60 | The numbers in the output are all in hex format, and some special values |
| 61 | may also occur: |
| 62 | .BR NA " stands for" |
| 63 | .I "not available" |
| 64 | (i.e., the datasheet doesn't specify a default value for the respective |
| 65 | register), |
| 66 | .BR RR " means" |
| 67 | .I reserved |
| 68 | (the datasheet explicitly marks this register as reserved), and |
| 69 | .BR MM " means" |
| 70 | .IR misc , |
| 71 | which can mean several things. It's recommended to consult the datasheet for |
| 72 | detailed information about the |
| 73 | .BR MM " fields." |
Uwe Hermann | 0920357 | 2007-10-07 15:26:40 +0000 | [diff] [blame] | 74 | .TP |
Robinson P. Tryon | 552cfb7 | 2008-01-15 22:30:55 +0000 | [diff] [blame] | 75 | .B "\-l, \-\-list-supported" |
| 76 | List all Super I/O chips recognized by |
| 77 | .BR superiotool ". The phrase" |
| 78 | .BR (dump available) |
| 79 | following a chip name indicates that |
| 80 | .B superiotool |
| 81 | supports the |
| 82 | .B --dump |
| 83 | option for this chip. |
| 84 | .TP |
Uwe Hermann | 0920357 | 2007-10-07 15:26:40 +0000 | [diff] [blame] | 85 | .B "\-V, \-\-verbose" |
| 86 | Enable verbose mode. This option can be used together with the |
Uwe Hermann | 74b29b9 | 2007-11-17 17:13:52 +0000 | [diff] [blame] | 87 | .BR "\-d" " option." |
Uwe Hermann | 6dbc0e1 | 2007-10-11 18:30:05 +0000 | [diff] [blame] | 88 | .sp |
| 89 | The verbose output will not only list for which type of Super I/O the tool |
| 90 | is scanning, but also at which configuration port it's probing, and which |
| 91 | Super I/O initialization sequence is used. If no Super I/O was detected |
| 92 | in a probing run, the returned output will be shown, as it may be useful |
| 93 | for figuring out which (currently unrecognized) Super I/O chip this may be. |
Uwe Hermann | 0920357 | 2007-10-07 15:26:40 +0000 | [diff] [blame] | 94 | .TP |
| 95 | .B "\-v, \-\-version" |
| 96 | Show version information and exit. |
| 97 | .TP |
| 98 | .B "\-h, \-\-help" |
| 99 | Show a help text and exit. |
| 100 | .SH BUGS |
Stefan Reinauer | 997afe6 | 2008-01-18 15:34:24 +0000 | [diff] [blame^] | 101 | Please report any bugs at http://tracker.coreboot.org/trac/coreboot/ |
| 102 | or on the coreboot mailing list (http://coreboot.org/Mailinglist). |
Uwe Hermann | 6dbc0e1 | 2007-10-11 18:30:05 +0000 | [diff] [blame] | 103 | .SH AUTHORS |
| 104 | Please see the individual source code files and/or the README file. |
Uwe Hermann | 0920357 | 2007-10-07 15:26:40 +0000 | [diff] [blame] | 105 | .SH LICENCE |
| 106 | .B superiotool |
Uwe Hermann | 6dbc0e1 | 2007-10-11 18:30:05 +0000 | [diff] [blame] | 107 | is covered by the GNU General Public License (GPL), either version 2 of |
| 108 | the License, or (at your option) any later version. |
Uwe Hermann | 0920357 | 2007-10-07 15:26:40 +0000 | [diff] [blame] | 109 | .SH SEE ALSO |
| 110 | .BR sensors-detect (8) |