blob: d931525f3f37db0394a97badfe9296e779d4d8b8 [file] [log] [blame]
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +00001Kernel driver it87
2==================
3
4Supported chips:
5 * IT8705F
6 Prefix: 'it87'
Jean Delvare91749992005-10-08 00:10:00 +02007 Addresses scanned: from Super I/O config space (8 I/O ports)
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +00008 Datasheet: Publicly available at the ITE website
9 http://www.ite.com.tw/
10 * IT8712F
11 Prefix: 'it8712'
Jean Delvare8e9afcb2006-12-12 18:18:28 +010012 Addresses scanned: from Super I/O config space (8 I/O ports)
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +000013 Datasheet: Publicly available at the ITE website
Andrew Paprocki04751692008-08-06 22:41:06 +020014 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
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)
20 Datasheet: Publicly available at the ITE website
21 http://www.ite.com.tw/product_info/file/pc/IT8716F_V0.3.ZIP
Rudolf Marek08a8f6e2007-06-09 10:11:16 -040022 http://www.ite.com.tw/product_info/file/pc/IT8726F_V0.3.pdf
Jean Delvare87673dd2006-08-28 14:37:19 +020023 * 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
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +000029 * SiS950 [clone of IT8705F]
Jean Delvare91749992005-10-08 00:10:00 +020030 Prefix: 'it87'
31 Addresses scanned: from Super I/O config space (8 I/O ports)
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +000032 Datasheet: No longer be available
33
Jean Delvareb19367c2006-08-28 14:39:26 +020034Authors:
Jean Delvaref1d8e332007-11-25 16:14:44 +010035 Christophe Gauthron
Jean Delvareb19367c2006-08-28 14:39:26 +020036 Jean Delvare <khali@linux-fr.org>
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +000037
38
39Module 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
Jean Delvare8e9afcb2006-12-12 18:18:28 +010058
59Hardware Interfaces
60-------------------
61
62All the chips suported by this driver are LPC Super-I/O chips, accessed
63through the LPC bus (ISA-like I/O ports). The IT8712F additionally has an
64SMBus interface to the hardware monitoring functions. This driver no
65longer supports this interface though, as it is slower and less reliable
66than the ISA access, and was only available on a small number of
67motherboard models.
68
69
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +000070Description
71-----------
72
Jean Delvare87673dd2006-08-28 14:37:19 +020073This driver implements support for the IT8705F, IT8712F, IT8716F,
Rudolf Marek08a8f6e2007-06-09 10:11:16 -040074IT8718F, IT8726F and SiS950 chips.
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +000075
76These chips are 'Super I/O chips', supporting floppy disks, infrared ports,
77joysticks and other miscellaneous stuff. For hardware monitoring, they
78include an 'environment controller' with 3 temperature sensors, 3 fan
79rotation speed sensors, 8 voltage sensors, and associated alarms.
80
Jean Delvare17d648b2006-08-28 14:23:46 +020081The IT8712F and IT8716F additionally feature VID inputs, used to report
82the Vcore voltage of the processor. The early IT8712F have 5 VID pins,
83the IT8716F and late IT8712F have 6. They are shared with other functions
84though, so the functionality may not be available on a given system.
85The driver dumbly assume it is there.
86
Jean Delvare87673dd2006-08-28 14:37:19 +020087The IT8718F also features VID inputs (up to 8 pins) but the value is
88stored in the Super-I/O configuration space. Due to technical limitations,
89this value can currently only be read once at initialization time, so
90the driver won't notice and report changes in the VID value. The two
91upper VID bits share their pins with voltage inputs (in5 and in6) so you
92can't have both on a given board.
Jean Delvare17d648b2006-08-28 14:23:46 +020093
Jean Delvare87673dd2006-08-28 14:37:19 +020094The IT8716F, IT8718F and later IT8712F revisions have support for
Andrew Paprocki04751692008-08-06 22:41:06 +0200952 additional fans. The additional fans are supported by the driver.
Jean Delvare87673dd2006-08-28 14:37:19 +020096
97The IT8716F and IT8718F, and late IT8712F and IT8705F also have optional
9816-bit tachometer counters for fans 1 to 3. This is better (no more fan
Jean Delvare17d648b2006-08-28 14:23:46 +020099clock divider mess) but not compatible with the older chips and
100revisions. For now, the driver only uses the 16-bit mode on the
Andrew Paprocki04751692008-08-06 22:41:06 +0200101late IT8712F, IT8716F and IT8718F.
Jean Delvare17d648b2006-08-28 14:23:46 +0200102
Rudolf Marek08a8f6e2007-06-09 10:11:16 -0400103The IT8726F is just bit enhanced IT8716F with additional hardware
104for AMD power sequencing. Therefore the chip will appear as IT8716F
105to userspace applications.
106
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +0000107Temperatures are measured in degrees Celsius. An alarm is triggered once
108when the Overtemperature Shutdown limit is crossed.
109
110Fan rotation speeds are reported in RPM (rotations per minute). An alarm is
Jean Delvare17d648b2006-08-28 14:23:46 +0200111triggered if the rotation speed has dropped below a programmable limit. When
11216-bit tachometer counters aren't used, fan readings can be divided by
113a programmable divider (1, 2, 4 or 8) to give the readings more range or
114accuracy. With a divider of 2, the lowest representable value is around
1152600 RPM. Not all RPM values can accurately be represented, so some rounding
116is done.
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +0000117
118Voltage sensors (also known as IN sensors) report their values in volts. An
119alarm is triggered if the voltage has crossed a programmable minimum or
120maximum limit. Note that minimum in this case always means 'closest to
121zero'; this is important for negative voltage measurements. All voltage
122inputs can measure voltages between 0 and 4.08 volts, with a resolution of
1230.016 volt. The battery voltage in8 does not have limit registers.
124
Jean Delvare87673dd2006-08-28 14:37:19 +0200125The VID lines (IT8712F/IT8716F/IT8718F) encode the core voltage value:
126the voltage level your processor should work with. This is hardcoded by
127the mainboard and/or processor itself. It is a value in volts.
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +0000128
129If an alarm triggers, it will remain triggered until the hardware register
130is read at least once. This means that the cause for the alarm may already
131have disappeared! Note that in the current implementation, all hardware
132registers are read whenever any data is read (unless it is less than 1.5
133seconds since the last update). This means that you can easily miss
134once-only alarms.
135
136The IT87xx only updates its values each 1.5 seconds; reading it more often
137will do no harm, but will return 'old' values.
138
139To change sensor N to a thermistor, 'echo 2 > tempN_type' where N is 1, 2,
140or 3. To change sensor N to a thermal diode, 'echo 3 > tempN_type'.
141Give 0 for unused sensor. Any other value is invalid. To configure this at
142startup, consult lm_sensors's /etc/sensors.conf. (2 = thermistor;
1433 = thermal diode)
144
Jean Delvaref8d0c192007-02-14 21:15:02 +0100145
146Fan speed control
147-----------------
148
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +0000149The fan speed control features are limited to manual PWM mode. Automatic
150"Smart Guardian" mode control handling is not implemented. However
151if you want to go for "manual mode" just write 1 to pwmN_enable.
Jean Delvaref8d0c192007-02-14 21:15:02 +0100152
153If you are only able to control the fan speed with very small PWM values,
154try lowering the PWM base frequency (pwm1_freq). Depending on the fan,
155it may give you a somewhat greater control range. The same frequency is
156used to drive all fan outputs, which is why pwm2_freq and pwm3_freq are
157read-only.