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