blob: fe80e9adebfa452d184cf8ec75491cb4d26785b4 [file] [log] [blame]
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +00001Kernel driver it87
2==================
3
4Supported chips:
Rudolf Marek574e9bd2014-04-04 18:01:35 +02005 * IT8603E/IT8623E
Rudolf Marekc145d5c2014-01-29 20:40:08 +01006 Prefix: 'it8603'
7 Addresses scanned: from Super I/O config space (8 I/O ports)
8 Datasheet: Not publicly available
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +00009 * IT8705F
10 Prefix: 'it87'
Jean Delvare91749992005-10-08 00:10:00 +020011 Addresses scanned: from Super I/O config space (8 I/O ports)
Jean Delvare404a5522010-03-05 22:17:21 +010012 Datasheet: Once publicly available at the ITE website, but no longer
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +000013 * IT8712F
14 Prefix: 'it8712'
Jean Delvare8e9afcb2006-12-12 18:18:28 +010015 Addresses scanned: from Super I/O config space (8 I/O ports)
Jean Delvare404a5522010-03-05 22:17:21 +010016 Datasheet: Once publicly available at the ITE website, but no longer
Rudolf Marek08a8f6e2007-06-09 10:11:16 -040017 * IT8716F/IT8726F
Jean Delvare17d648b2006-08-28 14:23:46 +020018 Prefix: 'it8716'
19 Addresses scanned: from Super I/O config space (8 I/O ports)
Jean Delvare404a5522010-03-05 22:17:21 +010020 Datasheet: Once publicly available at the ITE website, but no longer
Jean Delvare87673dd2006-08-28 14:37:19 +020021 * IT8718F
22 Prefix: 'it8718'
23 Addresses scanned: from Super I/O config space (8 I/O ports)
Jean Delvare404a5522010-03-05 22:17:21 +010024 Datasheet: Once publicly available at the ITE website, but no longer
Jean-Marc Spaggiarib4da93e2009-01-07 16:37:32 +010025 * IT8720F
26 Prefix: 'it8720'
27 Addresses scanned: from Super I/O config space (8 I/O ports)
Jean Delvare404a5522010-03-05 22:17:21 +010028 Datasheet: Not publicly available
Jean Delvare44c1bcd2010-10-28 20:31:51 +020029 * IT8721F/IT8758E
30 Prefix: 'it8721'
31 Addresses scanned: from Super I/O config space (8 I/O ports)
32 Datasheet: Not publicly available
Jean Delvare16b5dda2012-01-16 22:51:48 +010033 * IT8728F
34 Prefix: 'it8728'
35 Addresses scanned: from Super I/O config space (8 I/O ports)
36 Datasheet: Not publicly available
Guenter Roeckb0636702012-09-07 17:34:41 -060037 * IT8771E
38 Prefix: 'it8771'
39 Addresses scanned: from Super I/O config space (8 I/O ports)
40 Datasheet: Not publicly available
41 * IT8772E
42 Prefix: 'it8772'
43 Addresses scanned: from Super I/O config space (8 I/O ports)
44 Datasheet: Not publicly available
Guenter Roeck0531d982012-03-02 11:46:44 -080045 * IT8782F
46 Prefix: 'it8782'
47 Addresses scanned: from Super I/O config space (8 I/O ports)
48 Datasheet: Not publicly available
49 * IT8783E/F
50 Prefix: 'it8783'
51 Addresses scanned: from Super I/O config space (8 I/O ports)
52 Datasheet: Not publicly available
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +000053 * SiS950 [clone of IT8705F]
Jean Delvare91749992005-10-08 00:10:00 +020054 Prefix: 'it87'
55 Addresses scanned: from Super I/O config space (8 I/O ports)
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +000056 Datasheet: No longer be available
57
Jean Delvareb19367c2006-08-28 14:39:26 +020058Authors:
Jean Delvaref1d8e332007-11-25 16:14:44 +010059 Christophe Gauthron
Jean Delvare7c81c602014-01-29 20:40:08 +010060 Jean Delvare <jdelvare@suse.de>
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +000061
62
63Module Parameters
64-----------------
65
66* update_vbat: int
67
68 0 if vbat should report power on value, 1 if vbat should be updated after
69 each read. Default is 0. On some boards the battery voltage is provided
70 by either the battery or the onboard power supply. Only the first reading
71 at power on will be the actual battery voltage (which the chip does
72 automatically). On other boards the battery voltage is always fed to
73 the chip so can be read at any time. Excessive reading may decrease
74 battery life but no information is given in the datasheet.
75
76* fix_pwm_polarity int
77
78 Force PWM polarity to active high (DANGEROUS). Some chips are
79 misconfigured by BIOS - PWM values would be inverted. This option tries
80 to fix this. Please contact your BIOS manufacturer and ask him for fix.
81
Jean Delvare8e9afcb2006-12-12 18:18:28 +010082
83Hardware Interfaces
84-------------------
85
Masanari Iidac94bed8e2012-04-10 00:22:13 +090086All the chips supported by this driver are LPC Super-I/O chips, accessed
Jean Delvare8e9afcb2006-12-12 18:18:28 +010087through the LPC bus (ISA-like I/O ports). The IT8712F additionally has an
88SMBus interface to the hardware monitoring functions. This driver no
89longer supports this interface though, as it is slower and less reliable
90than the ISA access, and was only available on a small number of
91motherboard models.
92
93
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +000094Description
95-----------
96
Rudolf Marek574e9bd2014-04-04 18:01:35 +020097This driver implements support for the IT8603E, IT8623E, IT8705F, IT8712F,
98IT8716F, IT8718F, IT8720F, IT8721F, IT8726F, IT8728F, IT8758E, IT8771E,
99IT8772E, IT8782F, IT8783E/F, and SiS950 chips.
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +0000100
101These chips are 'Super I/O chips', supporting floppy disks, infrared ports,
102joysticks and other miscellaneous stuff. For hardware monitoring, they
103include an 'environment controller' with 3 temperature sensors, 3 fan
Jean Delvare3d30f9e2011-07-25 21:46:10 +0200104rotation speed sensors, 8 voltage sensors, associated alarms, and chassis
105intrusion detection.
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +0000106
Jean Delvare17d648b2006-08-28 14:23:46 +0200107The IT8712F and IT8716F additionally feature VID inputs, used to report
108the Vcore voltage of the processor. The early IT8712F have 5 VID pins,
109the IT8716F and late IT8712F have 6. They are shared with other functions
110though, so the functionality may not be available on a given system.
Jean Delvare17d648b2006-08-28 14:23:46 +0200111
Jean-Marc Spaggiarib4da93e2009-01-07 16:37:32 +0100112The IT8718F and IT8720F also features VID inputs (up to 8 pins) but the value
113is stored in the Super-I/O configuration space. Due to technical limitations,
Jean Delvare87673dd2006-08-28 14:37:19 +0200114this value can currently only be read once at initialization time, so
115the driver won't notice and report changes in the VID value. The two
116upper VID bits share their pins with voltage inputs (in5 and in6) so you
117can't have both on a given board.
Jean Delvare17d648b2006-08-28 14:23:46 +0200118
Jean Delvare44c1bcd2010-10-28 20:31:51 +0200119The IT8716F, IT8718F, IT8720F, IT8721F/IT8758E and later IT8712F revisions
120have support for 2 additional fans. The additional fans are supported by the
121driver.
Jean Delvare87673dd2006-08-28 14:37:19 +0200122
Guenter Roeck0531d982012-03-02 11:46:44 -0800123The IT8716F, IT8718F, IT8720F, IT8721F/IT8758E, IT8782F, IT8783E/F, and late
124IT8712F and IT8705F also have optional 16-bit tachometer counters for fans 1 to
1253. This is better (no more fan clock divider mess) but not compatible with the
126older chips and revisions. The 16-bit tachometer mode is enabled by the driver
127when one of the above chips is detected.
Jean Delvare17d648b2006-08-28 14:23:46 +0200128
Rudolf Marek08a8f6e2007-06-09 10:11:16 -0400129The IT8726F is just bit enhanced IT8716F with additional hardware
130for AMD power sequencing. Therefore the chip will appear as IT8716F
131to userspace applications.
132
Guenter Roeckb0636702012-09-07 17:34:41 -0600133The IT8728F, IT8771E, and IT8772E are considered compatible with the IT8721F,
134until a datasheet becomes available (hopefully.)
Jean Delvare16b5dda2012-01-16 22:51:48 +0100135
Rudolf Marek574e9bd2014-04-04 18:01:35 +0200136The IT8603E/IT8623E is a custom design, hardware monitoring part is similar to
Rudolf Marekc145d5c2014-01-29 20:40:08 +0100137IT8728F. It only supports 16-bit fan mode, the full speed mode of the
138fan is not supported (value 0 of pwmX_enable).
139
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +0000140Temperatures are measured in degrees Celsius. An alarm is triggered once
141when the Overtemperature Shutdown limit is crossed.
142
143Fan rotation speeds are reported in RPM (rotations per minute). An alarm is
Jean Delvare17d648b2006-08-28 14:23:46 +0200144triggered if the rotation speed has dropped below a programmable limit. When
14516-bit tachometer counters aren't used, fan readings can be divided by
146a programmable divider (1, 2, 4 or 8) to give the readings more range or
147accuracy. With a divider of 2, the lowest representable value is around
1482600 RPM. Not all RPM values can accurately be represented, so some rounding
149is done.
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +0000150
151Voltage sensors (also known as IN sensors) report their values in volts. An
152alarm is triggered if the voltage has crossed a programmable minimum or
153maximum limit. Note that minimum in this case always means 'closest to
154zero'; this is important for negative voltage measurements. All voltage
155inputs can measure voltages between 0 and 4.08 volts, with a resolution of
Rudolf Marekc145d5c2014-01-29 20:40:08 +01001560.016 volt (except IT8603E, IT8721F/IT8758E and IT8728F: 0.012 volt.) The
157battery voltage in8 does not have limit registers.
Jean Delvare44c1bcd2010-10-28 20:31:51 +0200158
Rudolf Marekc145d5c2014-01-29 20:40:08 +0100159On the IT8603E, IT8721F/IT8758E, IT8782F, and IT8783E/F, some voltage inputs
160are internal and scaled inside the chip:
161* in3 (optional)
162* in7 (optional for IT8782F and IT8783E/F)
163* in8 (always)
164* in9 (relevant for IT8603E only)
165The driver handles this transparently so user-space doesn't have to care.
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +0000166
Jean-Marc Spaggiarib4da93e2009-01-07 16:37:32 +0100167The VID lines (IT8712F/IT8716F/IT8718F/IT8720F) encode the core voltage value:
Jean Delvare87673dd2006-08-28 14:37:19 +0200168the voltage level your processor should work with. This is hardcoded by
169the mainboard and/or processor itself. It is a value in volts.
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +0000170
171If an alarm triggers, it will remain triggered until the hardware register
172is read at least once. This means that the cause for the alarm may already
173have disappeared! Note that in the current implementation, all hardware
174registers are read whenever any data is read (unless it is less than 1.5
175seconds since the last update). This means that you can easily miss
176once-only alarms.
177
Jean Delvared9b327c2010-03-05 22:17:17 +0100178Out-of-limit readings can also result in beeping, if the chip is properly
179wired and configured. Beeping can be enabled or disabled per sensor type
180(temperatures, voltages and fans.)
181
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +0000182The IT87xx only updates its values each 1.5 seconds; reading it more often
183will do no harm, but will return 'old' values.
184
Jean Delvare4ed10772008-10-17 17:51:16 +0200185To change sensor N to a thermistor, 'echo 4 > tempN_type' where N is 1, 2,
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +0000186or 3. To change sensor N to a thermal diode, 'echo 3 > tempN_type'.
187Give 0 for unused sensor. Any other value is invalid. To configure this at
Jean Delvare4ed10772008-10-17 17:51:16 +0200188startup, consult lm_sensors's /etc/sensors.conf. (4 = thermistor;
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +00001893 = thermal diode)
190
Jean Delvaref8d0c192007-02-14 21:15:02 +0100191
192Fan speed control
193-----------------
194
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +0000195The fan speed control features are limited to manual PWM mode. Automatic
Jean Delvare4f3f51b2010-03-05 22:17:21 +0100196"Smart Guardian" mode control handling is only implemented for older chips
197(see below.) However if you want to go for "manual mode" just write 1 to
198pwmN_enable.
Jean Delvaref8d0c192007-02-14 21:15:02 +0100199
200If you are only able to control the fan speed with very small PWM values,
201try lowering the PWM base frequency (pwm1_freq). Depending on the fan,
202it may give you a somewhat greater control range. The same frequency is
203used to drive all fan outputs, which is why pwm2_freq and pwm3_freq are
204read-only.
Jean Delvare4f3f51b2010-03-05 22:17:21 +0100205
206
207Automatic fan speed control (old interface)
208-------------------------------------------
209
210The driver supports the old interface to automatic fan speed control
211which is implemented by IT8705F chips up to revision F and IT8712F
212chips up to revision G.
213
214This interface implements 4 temperature vs. PWM output trip points.
215The PWM output of trip point 4 is always the maximum value (fan running
216at full speed) while the PWM output of the other 3 trip points can be
217freely chosen. The temperature of all 4 trip points can be freely chosen.
218Additionally, trip point 1 has an hysteresis temperature attached, to
219prevent fast switching between fan on and off.
220
221The chip automatically computes the PWM output value based on the input
222temperature, based on this simple rule: if the temperature value is
223between trip point N and trip point N+1 then the PWM output value is
224the one of trip point N. The automatic control mode is less flexible
225than the manual control mode, but it reacts faster, is more robust and
226doesn't use CPU cycles.
Jean Delvarecccfc9c2010-03-05 22:17:21 +0100227
228Trip points must be set properly before switching to automatic fan speed
229control mode. The driver will perform basic integrity checks before
230actually switching to automatic control mode.
Guenter Roeck161d8982012-12-19 22:17:01 +0100231
232
233Temperature offset attributes
234-----------------------------
235
236The driver supports temp[1-3]_offset sysfs attributes to adjust the reported
237temperature for thermal diodes or diode-connected thermal transistors.
238If a temperature sensor is configured for thermistors, the attribute values
Guenter Roeck5d8d2f22012-12-19 22:17:02 +0100239are ignored. If the thermal sensor type is Intel PECI, the temperature offset
240must be programmed to the critical CPU temperature.