sync README with upstream version

Signed-off-by: Guenter Roeck <linux@roeck-us.net>
This commit is contained in:
Guenter Roeck
2015-02-13 11:38:14 -08:00
parent e92fa72a82
commit 6200e84c62

70
README
View File

@@ -2,6 +2,10 @@ Kernel driver it87
================== ==================
Supported chips: Supported chips:
* IT8603E/IT8623E
Prefix: 'it8603'
Addresses scanned: from Super I/O config space (8 I/O ports)
Datasheet: Not publicly available
* IT8705F * IT8705F
Prefix: 'it87' Prefix: 'it87'
Addresses scanned: from Super I/O config space (8 I/O ports) Addresses scanned: from Super I/O config space (8 I/O ports)
@@ -30,6 +34,14 @@ Supported chips:
Prefix: 'it8728' Prefix: 'it8728'
Addresses scanned: from Super I/O config space (8 I/O ports) Addresses scanned: from Super I/O config space (8 I/O ports)
Datasheet: Not publicly available Datasheet: Not publicly available
* IT8771E
Prefix: 'it8771'
Addresses scanned: from Super I/O config space (8 I/O ports)
Datasheet: Not publicly available
* IT8772E
Prefix: 'it8772'
Addresses scanned: from Super I/O config space (8 I/O ports)
Datasheet: Not publicly available
* IT8781F * IT8781F
Prefix: 'it8781' Prefix: 'it8781'
Addresses scanned: from Super I/O config space (8 I/O ports) Addresses scanned: from Super I/O config space (8 I/O ports)
@@ -53,7 +65,7 @@ Supported chips:
Authors: Authors:
Christophe Gauthron Christophe Gauthron
Jean Delvare <khali@linux-fr.org> Jean Delvare <jdelvare@suse.de>
Module Parameters Module Parameters
@@ -79,7 +91,7 @@ Module Parameters
Hardware Interfaces Hardware Interfaces
------------------- -------------------
All the chips suported by this driver are LPC Super-I/O chips, accessed All the chips supported by this driver are LPC Super-I/O chips, accessed
through the LPC bus (ISA-like I/O ports). The IT8712F additionally has an through the LPC bus (ISA-like I/O ports). The IT8712F additionally has an
SMBus interface to the hardware monitoring functions. This driver no SMBus interface to the hardware monitoring functions. This driver no
longer supports this interface though, as it is slower and less reliable longer supports this interface though, as it is slower and less reliable
@@ -90,9 +102,9 @@ motherboard models.
Description Description
----------- -----------
This driver implements support for the IT8603E, IT8623E, IT8705F, This driver implements support for the IT8603E, IT8623E, IT8705F, IT8712F,
IT8712F, IT8716F, IT8718F, IT8720F, IT8721F, IT8726F, IT8728F, IT8758E, IT8716F, IT8718F, IT8720F, IT8721F, IT8726F, IT8728F, IT8758E, IT8771E,
IT8771E, IT8772E, IT8781F, IT8782F, IT8783E/F, and SiS950 chips. IT8772E, IT8781F, IT8782F, IT8783E/F, IT8786E, and SiS950 chips.
These chips are 'Super I/O chips', supporting floppy disks, infrared ports, These chips are 'Super I/O chips', supporting floppy disks, infrared ports,
joysticks and other miscellaneous stuff. For hardware monitoring, they joysticks and other miscellaneous stuff. For hardware monitoring, they
@@ -112,22 +124,26 @@ the driver won't notice and report changes in the VID value. The two
upper VID bits share their pins with voltage inputs (in5 and in6) so you upper VID bits share their pins with voltage inputs (in5 and in6) so you
can't have both on a given board. can't have both on a given board.
The IT8716F, IT8718F, IT8720F, IT8721F/IT8758E, IT8783E/F, and later IT8712F The IT8716F, IT8718F, IT8720F, IT8721F/IT8758E and later IT8712F revisions
revisions have support for 2 additional fans. The additional fans are supported have support for 2 additional fans. The additional fans are supported by the
by the driver. driver.
The IT8716F, IT8718F, IT8720F and IT8721F/IT8758E, IT8783E/F, and late IT8712F The IT8716F, IT8718F, IT8720F, IT8721F/IT8758E, IT8781F, IT8782F, IT8783E/F,
and IT8705F also have optional 16-bit tachometer counters for fans 1 to 3. This and late IT8712F and IT8705F also have optional 16-bit tachometer counters
is better (no more fan clock divider mess) but not compatible with the older for fans 1 to 3. This is better (no more fan clock divider mess) but not
chips and revisions. The 16-bit tachometer mode is enabled by the driver when compatible with the older chips and revisions. The 16-bit tachometer mode
one of the above chips is detected. is enabled by the driver when one of the above chips is detected.
The IT8726F is just bit enhanced IT8716F with additional hardware The IT8726F is just bit enhanced IT8716F with additional hardware
for AMD power sequencing. Therefore the chip will appear as IT8716F for AMD power sequencing. Therefore the chip will appear as IT8716F
to userspace applications. to userspace applications.
The IT8728F is considered compatible with the IT8721F, until a datasheet The IT8728F, IT8771E, and IT8772E are considered compatible with the IT8721F,
becomes available (hopefully.) until a datasheet becomes available (hopefully.)
The IT8603E/IT8623E is a custom design, hardware monitoring part is similar to
IT8728F. It only supports 16-bit fan mode, the full speed mode of the
fan is not supported (value 0 of pwmX_enable).
Temperatures are measured in degrees Celsius. An alarm is triggered once Temperatures are measured in degrees Celsius. An alarm is triggered once
when the Overtemperature Shutdown limit is crossed. when the Overtemperature Shutdown limit is crossed.
@@ -145,12 +161,16 @@ alarm is triggered if the voltage has crossed a programmable minimum or
maximum limit. Note that minimum in this case always means 'closest to maximum limit. Note that minimum in this case always means 'closest to
zero'; this is important for negative voltage measurements. All voltage zero'; this is important for negative voltage measurements. All voltage
inputs can measure voltages between 0 and 4.08 volts, with a resolution of inputs can measure voltages between 0 and 4.08 volts, with a resolution of
0.016 volt (except IT8721F/IT8758E and IT8728F: 0.012 volt.) The battery 0.016 volt (except IT8603E, IT8721F/IT8758E and IT8728F: 0.012 volt.) The
voltage in8 does not have limit registers. battery voltage in8 does not have limit registers.
On the IT8721F/IT8758E/IT8783E/F, some voltage inputs are internal and scaled On the IT8603E, IT8721F/IT8758E, IT8781F, IT8782F, and IT8783E/F, some
inside the chip (in7, in8 and optionally in3). The driver handles this voltage inputs are internal and scaled inside the chip:
transparently so user-space doesn't have to care. * in3 (optional)
* in7 (optional for IT8781F, IT8782F, and IT8783E/F)
* in8 (always)
* in9 (relevant for IT8603E only)
The driver handles this transparently so user-space doesn't have to care.
The VID lines (IT8712F/IT8716F/IT8718F/IT8720F) encode the core voltage value: The VID lines (IT8712F/IT8716F/IT8718F/IT8720F) encode the core voltage value:
the voltage level your processor should work with. This is hardcoded by the voltage level your processor should work with. This is hardcoded by
@@ -216,3 +236,13 @@ doesn't use CPU cycles.
Trip points must be set properly before switching to automatic fan speed Trip points must be set properly before switching to automatic fan speed
control mode. The driver will perform basic integrity checks before control mode. The driver will perform basic integrity checks before
actually switching to automatic control mode. actually switching to automatic control mode.
Temperature offset attributes
-----------------------------
The driver supports temp[1-3]_offset sysfs attributes to adjust the reported
temperature for thermal diodes or diode-connected thermal transistors.
If a temperature sensor is configured for thermistors, the attribute values
are ignored. If the thermal sensor type is Intel PECI, the temperature offset
must be programmed to the critical CPU temperature.