util/superiotool/superiotool.8

   1 .TH SUPERIOTOOL 8 "October 11, 2007"
   2 .SH NAME
   3 superiotool \- Super I/O detection tool
   4 .SH SYNOPSIS
   5 .B superiotool \fR[\fB\-dVvh\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 LinuxBIOS development purposes (see linuxbios.org
  18 for details on LinuxBIOS), 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
  22 .B http://linuxbios.org/Superiotool#Supported_devices
  23 .SH OPTIONS
  24 If no command line option is specified,
  25 .B superiotool
  26 merely tries to detect the Super I/O chip.
  27 You must use the
  28 .B "\-d"
  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"
  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."
  74 .TP
  75 .B "\-V, \-\-verbose"
  76 Enable verbose mode. This option can be used together with the
  77 .BR "\-d" " option."
  78 .sp
  79 The verbose output will not only list for which type of Super I/O the tool
  80 is scanning, but also at which configuration port it's probing, and which
  81 Super I/O initialization sequence is used. If no Super I/O was detected
  82 in a probing run, the returned output will be shown, as it may be useful
  83 for figuring out which (currently unrecognized) Super I/O chip this may be.
  84 .TP
  85 .B "\-v, \-\-version"
  86 Show version information and exit.
  87 .TP
  88 .B "\-h, \-\-help"
  89 Show a help text and exit.
  90 .SH BUGS
  91 Please report any bugs at http://tracker.linuxbios.org/trac/LinuxBIOS/
  92 or on the LinuxBIOS mailing list (http://linuxbios.org/Mailinglist).
  93 .SH AUTHORS
  94 Please see the individual source code files and/or the README file.
  95 .SH LICENCE
  96 .B superiotool
  97 is covered by the GNU General Public License (GPL), either version 2 of
  98 the License, or (at your option) any later version.
  99 .SH SEE ALSO
 100 .BR sensors-detect (8)