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