4 I have been unable to meet support demands for this driver, resulting
5 in unpleasant experience and frustration for everyone involved.
7 Consequently, the driver will be removed from github, effective
8 August 1, 2018. Interested parties are encouraged to clone the driver
9 before that time and to start maintaining it on their own.
18 Addresses scanned: from Super I/O config space (8 I/O ports)
19 Datasheet: Not publicly available
22 Addresses scanned: from Super I/O config space (8 I/O ports)
23 Datasheet: Not publicly available
26 Addresses scanned: from Super I/O config space (8 I/O ports)
29 Addresses scanned: from Super I/O config space (8 I/O ports)
30 Datasheet: Not publicly available
33 Addresses scanned: from Super I/O config space (8 I/O ports)
34 Datasheet: Not publicly available
37 Addresses scanned: from Super I/O config space (8 I/O ports)
38 Datasheet: Not publicly available
41 Addresses scanned: from Super I/O config space (8 I/O ports)
42 Datasheet: Once publicly available at the ITE website, but no longer
45 Addresses scanned: from Super I/O config space (8 I/O ports)
46 Datasheet: Once publicly available at the ITE website, but no longer
49 Addresses scanned: from Super I/O config space (8 I/O ports)
50 Datasheet: Once publicly available at the ITE website, but no longer
53 Addresses scanned: from Super I/O config space (8 I/O ports)
54 Datasheet: Once publicly available at the ITE website, but no longer
57 Addresses scanned: from Super I/O config space (8 I/O ports)
58 Datasheet: Not publicly available
61 Addresses scanned: from Super I/O config space (8 I/O ports)
62 Datasheet: Not publicly available
65 Addresses scanned: from Super I/O config space (8 I/O ports)
66 Datasheet: Not publicly available
69 Addresses scanned: from Super I/O config space (8 I/O ports)
70 Datasheet: Not publicly available
73 Addresses scanned: from Super I/O config space (8 I/O ports)
74 Datasheet: Not publicly available
77 Addresses scanned: from Super I/O config space (8 I/O ports)
78 Datasheet: Not publicly available
81 Addresses scanned: from Super I/O config space (8 I/O ports)
82 Datasheet: Not publicly available
85 Addresses scanned: from Super I/O config space (8 I/O ports)
86 Datasheet: Not publicly available
89 Addresses scanned: from Super I/O config space (8 I/O ports)
90 Datasheet: Not publicly available
93 Addresses scanned: from Super I/O config space (8 I/O ports)
94 Datasheet: Not publicly available
97 Addresses scanned: from Super I/O config space (8 I/O ports)
98 Datasheet: Not publicly available
99 * SiS950 [clone of IT8705F]
101 Addresses scanned: from Super I/O config space (8 I/O ports)
102 Datasheet: No longer be available
106 Jean Delvare <jdelvare@suse.de>
107 Guenter Roeck <linux@roeck-us.net>
110 Building & Installing
111 ---------------------
127 * sudo make dkms_clean
131 * The module does not provide a real version number, so `git describe --long`
132 is used to create one. This means that anything that changes the git state
133 will change the version. `make dkms_clean` should be run before making a
134 commit or an update with `git pull` as the Makefile is currently unable to
135 track the last installed version to replace it. If this doesn't happen, the
136 old version will need to be manually removed from dkms, before installing
138 Something like `dkms remove -m it87 -v <old version> --all`, followed by
139 `rm -rf /usr/src/it87-<old version>`, should do.
140 `dkms status it87` can be used to list the installed versions.
148 0 if vbat should report power on value, 1 if vbat should be updated after
149 each read. Default is 0. On some boards the battery voltage is provided
150 by either the battery or the onboard power supply. Only the first reading
151 at power on will be the actual battery voltage (which the chip does
152 automatically). On other boards the battery voltage is always fed to
153 the chip so can be read at any time. Excessive reading may decrease
154 battery life but no information is given in the datasheet.
156 * fix_pwm_polarity int
158 Force PWM polarity to active high (DANGEROUS). Some chips are
159 misconfigured by BIOS - PWM values would be inverted. This option tries
160 to fix this. Please contact your BIOS manufacturer and ask him for fix.
164 Force chip ID to specified value. Should only be used for testing.
166 * ignore_resource_conflict
168 Similar to acpi_enforce_resources=lax, but only affects this driver.
169 ACPI resource conflicts are ignored if this parameter is provided and
171 Provided since there are reports that system-wide acpi_enfore_resources=lax
172 can result in boot failures on some systems.
173 Note: This is inherently risky since it means that both ACPI and this driver
174 may access the chip at the same time. This can result in race conditions and,
175 worst case, result in unexpected system reboots.
179 If set to 1, the driver uses MMIO to access the chip if supported. This is
180 faster and less risky (untested!).
186 All the chips supported by this driver are LPC Super-I/O chips, accessed
187 through the LPC bus (ISA-like I/O ports). The IT8712F additionally has an
188 SMBus interface to the hardware monitoring functions. This driver no
189 longer supports this interface though, as it is slower and less reliable
190 than the ISA access, and was only available on a small number of
197 This driver implements support for the IT8603E, IT8620E, IT8622E, IT8623E,
198 IT8628E, IT8705F, IT8712F, IT8716F, IT8718F, IT8720F, IT8721F, IT8726F, IT8728F,
199 IT8732F, IT8758E, IT8771E, IT8772E, IT8781F, IT8782F, IT8783E/F, IT8786E,
200 IT8790E, and SiS950 chips.
202 These chips are 'Super I/O chips', supporting floppy disks, infrared ports,
203 joysticks and other miscellaneous stuff. For hardware monitoring, they
204 include an 'environment controller' with 3 temperature sensors, 3 fan
205 rotation speed sensors, 8 voltage sensors, associated alarms, and chassis
208 The IT8712F and IT8716F additionally feature VID inputs, used to report
209 the Vcore voltage of the processor. The early IT8712F have 5 VID pins,
210 the IT8716F and late IT8712F have 6. They are shared with other functions
211 though, so the functionality may not be available on a given system.
213 The IT8718F and IT8720F also features VID inputs (up to 8 pins) but the value
214 is stored in the Super-I/O configuration space. Due to technical limitations,
215 this value can currently only be read once at initialization time, so
216 the driver won't notice and report changes in the VID value. The two
217 upper VID bits share their pins with voltage inputs (in5 and in6) so you
218 can't have both on a given board.
220 The IT8716F, IT8718F, IT8720F, IT8721F/IT8758E and later IT8712F revisions
221 have support for 2 additional fans. The additional fans are supported by the
224 The IT8716F, IT8718F, IT8720F, IT8721F/IT8758E, IT8732F, IT8781F, IT8782F,
225 IT8783E/F, and late IT8712F and IT8705F also have optional 16-bit tachometer
226 counters for fans 1 to 3. This is better (no more fan clock divider mess) but
227 not compatible with the older chips and revisions. The 16-bit tachometer mode
228 is enabled by the driver when one of the above chips is detected.
230 The IT8726F is just bit enhanced IT8716F with additional hardware
231 for AMD power sequencing. Therefore the chip will appear as IT8716F
232 to userspace applications.
234 The IT8728F, IT8771E, and IT8772E are considered compatible with the IT8721F,
235 until a datasheet becomes available (hopefully.)
237 The IT8603E/IT8623E is a custom design, hardware monitoring part is similar to
238 IT8728F. It only supports 3 fans, 16-bit fan mode, and the full speed mode
239 of the fan is not supported (value 0 of pwmX_enable).
241 The IT8620E and IT8628E are custom designs, hardware monitoring part is similar
242 to IT8728F. It only supports 16-bit fan mode. Both chips support up to 6 fans.
244 The IT8790E supports up to 3 fans. 16-bit fan mode is always enabled.
246 The IT8732F supports a closed-loop mode for fan control, but this is not
247 currently implemented by the driver.
249 Temperatures are measured in degrees Celsius. An alarm is triggered once
250 when the Overtemperature Shutdown limit is crossed.
252 Fan rotation speeds are reported in RPM (rotations per minute). An alarm is
253 triggered if the rotation speed has dropped below a programmable limit. When
254 16-bit tachometer counters aren't used, fan readings can be divided by
255 a programmable divider (1, 2, 4 or 8) to give the readings more range or
256 accuracy. With a divider of 2, the lowest representable value is around
257 2600 RPM. Not all RPM values can accurately be represented, so some rounding
260 Voltage sensors (also known as IN sensors) report their values in volts. An
261 alarm is triggered if the voltage has crossed a programmable minimum or
262 maximum limit. Note that minimum in this case always means 'closest to
263 zero'; this is important for negative voltage measurements. On most chips, all
264 voltage inputs can measure voltages between 0 and 4.08 volts, with a resolution
265 of 0.016 volt. IT8603E, IT8721F/IT8758E and IT8728F can measure between 0 and
266 3.06 volts, with a resolution of 0.012 volt. IT8732F can measure between 0 and
267 2.8 volts with a resolution of 0.0109 volt. The battery voltage in8 does not
268 have limit registers.
270 On the IT8603E, IT8620E, IT8628E, IT8721F/IT8758E, IT8732F, IT8781F, IT8782F,
271 and IT8783E/F, some voltage inputs are internal and scaled inside the chip:
273 * in7 (optional for IT8781F, IT8782F, and IT8783E/F)
275 * in9 (relevant for IT8603E only)
276 The driver handles this transparently so user-space doesn't have to care.
278 The VID lines (IT8712F/IT8716F/IT8718F/IT8720F) encode the core voltage value:
279 the voltage level your processor should work with. This is hardcoded by
280 the mainboard and/or processor itself. It is a value in volts.
282 If an alarm triggers, it will remain triggered until the hardware register
283 is read at least once. This means that the cause for the alarm may already
284 have disappeared! Note that in the current implementation, all hardware
285 registers are read whenever any data is read (unless it is less than 1.5
286 seconds since the last update). This means that you can easily miss
289 Out-of-limit readings can also result in beeping, if the chip is properly
290 wired and configured. Beeping can be enabled or disabled per sensor type
291 (temperatures, voltages and fans.)
293 The IT87xx only updates its values each 1.5 seconds; reading it more often
294 will do no harm, but will return 'old' values.
296 To change sensor N to a thermistor, 'echo 4 > tempN_type' where N is 1, 2,
297 or 3. To change sensor N to a thermal diode, 'echo 3 > tempN_type'.
298 Give 0 for unused sensor. Any other value is invalid. To configure this at
299 startup, consult lm_sensors's /etc/sensors.conf. (4 = thermistor;
306 The fan speed control features are limited to manual PWM mode. Automatic
307 "Smart Guardian" mode control handling is only implemented for older chips
308 (see below.) However if you want to go for "manual mode" just write 1 to
311 If you are only able to control the fan speed with very small PWM values,
312 try lowering the PWM base frequency (pwm1_freq). Depending on the fan,
313 it may give you a somewhat greater control range. The same frequency is
314 used to drive all fan outputs, which is why pwm2_freq and pwm3_freq are
318 Automatic fan speed control (old interface)
319 -------------------------------------------
321 The driver supports the old interface to automatic fan speed control
322 which is implemented by IT8705F chips up to revision F and IT8712F
323 chips up to revision G.
325 This interface implements 4 temperature vs. PWM output trip points.
326 The PWM output of trip point 4 is always the maximum value (fan running
327 at full speed) while the PWM output of the other 3 trip points can be
328 freely chosen. The temperature of all 4 trip points can be freely chosen.
329 Additionally, trip point 1 has an hysteresis temperature attached, to
330 prevent fast switching between fan on and off.
332 The chip automatically computes the PWM output value based on the input
333 temperature, based on this simple rule: if the temperature value is
334 between trip point N and trip point N+1 then the PWM output value is
335 the one of trip point N. The automatic control mode is less flexible
336 than the manual control mode, but it reacts faster, is more robust and
337 doesn't use CPU cycles.
339 Trip points must be set properly before switching to automatic fan speed
340 control mode. The driver will perform basic integrity checks before
341 actually switching to automatic control mode.
344 Temperature offset attributes
345 -----------------------------
347 The driver supports temp[1-3]_offset sysfs attributes to adjust the reported
348 temperature for thermal diodes or diode-connected thermal transistors.
349 If a temperature sensor is configured for thermistors, the attribute values
350 are ignored. If the thermal sensor type is Intel PECI, the temperature offset
351 must be programmed to the critical CPU temperature.
356 Support for IT8607E is preliminary. Voltage readings, temperature readings,
357 fan control, and fan speed measurements may be wrong and/or missing.
358 Fan control and fan speed may be enabled and reported for non-existing
359 fans. Please report any problems and inconsistencies.
361 Reporting information for unsupported chips
362 -------------------------------------------
364 If the chip in your system is not yet supported by the driver, please provide
365 the following information.
367 First, run sensors-detect. It will tell you something like
369 Probing for Super-I/O at 0x2e/0x2f
371 Trying family `ITE'... Yes
372 Found unknown chip with ID 0x8665
373 (logical device 4 has address 0x290, could be sensors)
375 With this information, run the following commands.
377 sudo isadump -k 0x87,0x01,0x55,0x55 0x2e 0x2f 7
378 sudo isadump 0x295 0x296
380 and report the results.
382 The addresses in the first command are from "Probing for Super-I/O at
383 0x2e/0x2f". Use those addresses in the first command.
384 sudo isadump -k 0x87,0x01,0x55,0x55 0x2e 0x2f 7
386 The addresses in the second command are from "has address 0x290".
387 Add 5 and 6 to this address for the next command.
388 sudo isadump 0x295 0x296
390 Next, force-install the driver by providing one of the already supported chips
391 as forced ID. Useful IDs to test are 0x8622, 0x8628, 0x8728, and 0x8732, though
392 feel free to test more IDs. For each ID, instantiate the driver as follows
393 (this example is instantiating driver with ID 0x8622).
394 sudo modprobe it87 force_id=0x8622
395 After entering this command, run the "sensors" command and provide the output.
396 Then unload the driver with
397 sudo modprobe -r it87
398 Repeat with different chip IDs, and report each result.
400 Please also report your board type as well as voltages and fan settings from
401 the BIOS. If possible, connect fans to different fan headers and let us know
402 if all fans are detected and reported.
404 This information _might_ give us enough information to add experimental support
405 for the chip in question. No guarantees, though - unless a datasheet is
406 available, something is likely to be wrong.
408 A note on sensors-detect
409 ========================
411 There is a persistent perception that changes in this driver would have impact
412 on the output of sensors-detect. This is not the case. sensors-detect is an
413 independent application. Changes in this driver do not affect sensors-detect,
414 and changes in sensors-detect do not affect this driver.