util/superiotool/superiotool.8

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