Merge branch 'upstream' of git://git.kernel.org/pub/scm/linux/kernel/git/vitb/linux...
[linux-2.6] / Documentation / hwmon / it87
1 Kernel driver it87
2 ==================
3
4 Supported chips:
5   * IT8705F
6     Prefix: 'it87'
7     Addresses scanned: from Super I/O config space (8 I/O ports)
8     Datasheet: Publicly available at the ITE website
9                http://www.ite.com.tw/
10   * IT8712F
11     Prefix: 'it8712'
12     Addresses scanned: I2C 0x2d
13                        from Super I/O config space (8 I/O ports)
14     Datasheet: Publicly available at the ITE website
15                http://www.ite.com.tw/
16   * IT8716F
17     Prefix: 'it8716'
18     Addresses scanned: from Super I/O config space (8 I/O ports)
19     Datasheet: Publicly available at the ITE website
20                http://www.ite.com.tw/product_info/file/pc/IT8716F_V0.3.ZIP
21   * IT8718F
22     Prefix: 'it8718'
23     Addresses scanned: from Super I/O config space (8 I/O ports)
24     Datasheet: Publicly available at the ITE website
25                http://www.ite.com.tw/product_info/file/pc/IT8718F_V0.2.zip
26                http://www.ite.com.tw/product_info/file/pc/IT8718F_V0%203_(for%20C%20version).zip
27   * SiS950   [clone of IT8705F]
28     Prefix: 'it87'
29     Addresses scanned: from Super I/O config space (8 I/O ports)
30     Datasheet: No longer be available
31
32 Authors:
33     Christophe Gauthron <chrisg@0-in.com>
34     Jean Delvare <khali@linux-fr.org>
35
36
37 Module Parameters
38 -----------------
39
40 * update_vbat: int
41
42   0 if vbat should report power on value, 1 if vbat should be updated after
43   each read. Default is 0. On some boards the battery voltage is provided
44   by either the battery or the onboard power supply. Only the first reading
45   at power on will be the actual battery voltage (which the chip does
46   automatically). On other boards the battery voltage is always fed to
47   the chip so can be read at any time. Excessive reading may decrease
48   battery life but no information is given in the datasheet.
49
50 * fix_pwm_polarity int
51
52   Force PWM polarity to active high (DANGEROUS). Some chips are
53   misconfigured by BIOS - PWM values would be inverted. This option tries
54   to fix this. Please contact your BIOS manufacturer and ask him for fix.
55
56 Description
57 -----------
58
59 This driver implements support for the IT8705F, IT8712F, IT8716F,
60 IT8718F and SiS950 chips.
61
62 These chips are 'Super I/O chips', supporting floppy disks, infrared ports,
63 joysticks and other miscellaneous stuff. For hardware monitoring, they
64 include an 'environment controller' with 3 temperature sensors, 3 fan
65 rotation speed sensors, 8 voltage sensors, and associated alarms.
66
67 The IT8712F and IT8716F additionally feature VID inputs, used to report
68 the Vcore voltage of the processor. The early IT8712F have 5 VID pins,
69 the IT8716F and late IT8712F have 6. They are shared with other functions
70 though, so the functionality may not be available on a given system.
71 The driver dumbly assume it is there.
72
73 The IT8718F also features VID inputs (up to 8 pins) but the value is
74 stored in the Super-I/O configuration space. Due to technical limitations,
75 this value can currently only be read once at initialization time, so
76 the driver won't notice and report changes in the VID value. The two
77 upper VID bits share their pins with voltage inputs (in5 and in6) so you
78 can't have both on a given board.
79
80 The IT8716F, IT8718F and later IT8712F revisions have support for
81 2 additional fans. They are not yet supported by the driver.
82
83 The IT8716F and IT8718F, and late IT8712F and IT8705F also have optional
84 16-bit tachometer counters for fans 1 to 3. This is better (no more fan
85 clock divider mess) but not compatible with the older chips and
86 revisions. For now, the driver only uses the 16-bit mode on the
87 IT8716F and IT8718F.
88
89 Temperatures are measured in degrees Celsius. An alarm is triggered once
90 when the Overtemperature Shutdown limit is crossed.
91
92 Fan rotation speeds are reported in RPM (rotations per minute). An alarm is
93 triggered if the rotation speed has dropped below a programmable limit. When
94 16-bit tachometer counters aren't used, fan readings can be divided by
95 a programmable divider (1, 2, 4 or 8) to give the readings more range or
96 accuracy. With a divider of 2, the lowest representable value is around
97 2600 RPM. Not all RPM values can accurately be represented, so some rounding
98 is done.
99
100 Voltage sensors (also known as IN sensors) report their values in volts. An
101 alarm is triggered if the voltage has crossed a programmable minimum or
102 maximum limit. Note that minimum in this case always means 'closest to
103 zero'; this is important for negative voltage measurements. All voltage
104 inputs can measure voltages between 0 and 4.08 volts, with a resolution of
105 0.016 volt. The battery voltage in8 does not have limit registers.
106
107 The VID lines (IT8712F/IT8716F/IT8718F) encode the core voltage value:
108 the voltage level your processor should work with. This is hardcoded by
109 the mainboard and/or processor itself. It is a value in volts.
110
111 If an alarm triggers, it will remain triggered until the hardware register
112 is read at least once. This means that the cause for the alarm may already
113 have disappeared! Note that in the current implementation, all hardware
114 registers are read whenever any data is read (unless it is less than 1.5
115 seconds since the last update). This means that you can easily miss
116 once-only alarms.
117
118 The IT87xx only updates its values each 1.5 seconds; reading it more often
119 will do no harm, but will return 'old' values.
120
121 To change sensor N to a thermistor, 'echo 2 > tempN_type' where N is 1, 2,
122 or 3. To change sensor N to a thermal diode, 'echo 3 > tempN_type'.
123 Give 0 for unused sensor. Any other value is invalid. To configure this at
124 startup, consult lm_sensors's /etc/sensors.conf. (2 = thermistor;
125 3 = thermal diode)
126
127 The fan speed control features are limited to manual PWM mode. Automatic
128 "Smart Guardian" mode control handling is not implemented. However
129 if you want to go for "manual mode" just write 1 to pwmN_enable.