blob: 02b74899edaf42e5c1a266399aeb51c890fc5c5c [file] [log] [blame]
Rudolf Marek563daaf2006-07-05 18:15:31 +02001Kernel driver w83627ehf
2=======================
3
4Supported chips:
Gong Jun237c8d2f2009-03-30 21:46:42 +02005 * Winbond W83627EHF/EHG (ISA access ONLY)
Rudolf Marek563daaf2006-07-05 18:15:31 +02006 Prefix: 'w83627ehf'
7 Addresses scanned: ISA address retrieved from Super I/O registers
David Hubbard657c93b2007-02-14 21:15:04 +01008 Datasheet:
Gong Jun237c8d2f2009-03-30 21:46:42 +02009 http://www.nuvoton.com.tw/NR/rdonlyres/A6A258F0-F0C9-4F97-81C0-C4D29E7E943E/0/W83627EHF.pdf
10 * Winbond W83627DHG
11 Prefix: 'w83627dhg'
12 Addresses scanned: ISA address retrieved from Super I/O registers
13 Datasheet:
14 http://www.nuvoton.com.tw/NR/rdonlyres/7885623D-A487-4CF9-A47F-30C5F73D6FE6/0/W83627DHG.pdf
Jean Delvarec1e48dc2009-06-15 18:39:50 +020015 * Winbond W83627DHG-P
16 Prefix: 'w83627dhg'
17 Addresses scanned: ISA address retrieved from Super I/O registers
18 Datasheet: not available
Gong Jun237c8d2f2009-03-30 21:46:42 +020019 * Winbond W83667HG
20 Prefix: 'w83667hg'
21 Addresses scanned: ISA address retrieved from Super I/O registers
22 Datasheet: not available
Rudolf Marek563daaf2006-07-05 18:15:31 +020023
24Authors:
25 Jean Delvare <khali@linux-fr.org>
Jean Delvare3379cee2006-09-24 21:25:52 +020026 Yuan Mu (Winbond)
Jean Delvare7188cc62006-12-12 18:18:30 +010027 Rudolf Marek <r.marek@assembler.cz>
David Hubbard657c93b2007-02-14 21:15:04 +010028 David Hubbard <david.c.hubbard@gmail.com>
Gong Jun237c8d2f2009-03-30 21:46:42 +020029 Gong Jun <JGong@nuvoton.com>
Rudolf Marek563daaf2006-07-05 18:15:31 +020030
31Description
32-----------
33
Gong Jun237c8d2f2009-03-30 21:46:42 +020034This driver implements support for the Winbond W83627EHF, W83627EHG,
Jean Delvarec1e48dc2009-06-15 18:39:50 +020035W83627DHG, W83627DHG-P and W83667HG super I/O chips. We will refer to them
36collectively as Winbond chips.
Rudolf Marek563daaf2006-07-05 18:15:31 +020037
38The chips implement three temperature sensors, five fan rotation
Jean Delvarefc18d6c2007-06-24 11:19:42 +020039speed sensors, ten analog voltage sensors (only nine for the 627DHG), one
Gong Jun237c8d2f2009-03-30 21:46:42 +020040VID (6 pins for the 627EHF/EHG, 8 pins for the 627DHG and 667HG), alarms
41with beep warnings (control unimplemented), and some automatic fan
42regulation strategies (plus manual fan control mode).
Rudolf Marek563daaf2006-07-05 18:15:31 +020043
44Temperatures are measured in degrees Celsius and measurement resolution is 1
45degC for temp1 and 0.5 degC for temp2 and temp3. An alarm is triggered when
46the temperature gets higher than high limit; it stays on until the temperature
Jean Delvare15fe25c2006-10-08 21:59:54 +020047falls below the hysteresis value.
Rudolf Marek563daaf2006-07-05 18:15:31 +020048
49Fan rotation speeds are reported in RPM (rotations per minute). An alarm is
50triggered if the rotation speed has dropped below a programmable limit. Fan
51readings can be divided by a programmable divider (1, 2, 4, 8, 16, 32, 64 or
52128) to give the readings more range or accuracy. The driver sets the most
53suitable fan divisor itself. Some fans might not be present because they
54share pins with other functions.
55
56Voltage sensors (also known as IN sensors) report their values in millivolts.
57An alarm is triggered if the voltage has crossed a programmable minimum
58or maximum limit.
59
60The driver supports automatic fan control mode known as Thermal Cruise.
61In this mode, the chip attempts to keep the measured temperature in a
62predefined temperature range. If the temperature goes out of range, fan
63is driven slower/faster to reach the predefined range again.
64
65The mode works for fan1-fan4. Mapping of temperatures to pwm outputs is as
66follows:
67
68temp1 -> pwm1
69temp2 -> pwm2
70temp3 -> pwm3
Gong Jun237c8d2f2009-03-30 21:46:42 +020071prog -> pwm4 (not on 667HG; the programmable setting is not supported by
72 the driver)
Rudolf Marek563daaf2006-07-05 18:15:31 +020073
74/sys files
75----------
76
David Hubbard657c93b2007-02-14 21:15:04 +010077name - this is a standard hwmon device entry. For the W83627EHF and W83627EHG,
78 it is set to "w83627ehf" and for the W83627DHG it is set to "w83627dhg"
79
Rudolf Marek563daaf2006-07-05 18:15:31 +020080pwm[1-4] - this file stores PWM duty cycle or DC value (fan speed) in range:
81 0 (stop) to 255 (full)
82
83pwm[1-4]_enable - this file controls mode of fan/temperature control:
84 * 1 Manual Mode, write to pwm file any value 0-255 (full speed)
85 * 2 Thermal Cruise
86
87Thermal Cruise mode
88-------------------
89
90If the temperature is in the range defined by:
91
Jean Delvare15fe25c2006-10-08 21:59:54 +020092pwm[1-4]_target - set target temperature, unit millidegree Celsius
Rudolf Marek563daaf2006-07-05 18:15:31 +020093 (range 0 - 127000)
Jean Delvare15fe25c2006-10-08 21:59:54 +020094pwm[1-4]_tolerance - tolerance, unit millidegree Celsius (range 0 - 15000)
Rudolf Marek563daaf2006-07-05 18:15:31 +020095
96there are no changes to fan speed. Once the temperature leaves the interval,
97fan speed increases (temp is higher) or decreases if lower than desired.
98There are defined steps and times, but not exported by the driver yet.
99
100pwm[1-4]_min_output - minimum fan speed (range 1 - 255), when the temperature
101 is below defined range.
102pwm[1-4]_stop_time - how many milliseconds [ms] must elapse to switch
103 corresponding fan off. (when the temperature was below
104 defined range).
105
106Note: last two functions are influenced by other control bits, not yet exported
107 by the driver, so a change might not have any effect.
David Hubbard657c93b2007-02-14 21:15:04 +0100108
109Implementation Details
110----------------------
111
112Future driver development should bear in mind that the following registers have
113different functions on the 627EHF and the 627DHG. Some registers also have
114different power-on default values, but BIOS should already be loading
115appropriate defaults. Note that bank selection must be performed as is currently
116done in the driver for all register addresses.
117
1180x49: only on DHG, selects temperature source for AUX fan, CPU fan0
1190x4a: not completely documented for the EHF and the DHG documentation assigns
120 different behavior to bits 7 and 6, including extending the temperature
121 input selection to SmartFan I, not just SmartFan III. Testing on the EHF
122 will reveal whether they are compatible or not.
123
1240x58: Chip ID: 0xa1=EHF 0xc1=DHG
1250x5e: only on DHG, has bits to enable "current mode" temperature detection and
126 critical temperature protection
1270x45b: only on EHF, bit 3, vin4 alarm (EHF supports 10 inputs, only 9 on DHG)
1280x552: only on EHF, vin4
1290x558: only on EHF, vin4 high limit
1300x559: only on EHF, vin4 low limit
1310x6b: only on DHG, SYS fan critical temperature
1320x6c: only on DHG, CPU fan0 critical temperature
1330x6d: only on DHG, AUX fan critical temperature
1340x6e: only on DHG, CPU fan1 critical temperature
135
1360x50-0x55 and 0x650-0x657 are marked "Test Register" for the EHF, but "Reserved
137 Register" for the DHG
138
139The DHG also supports PECI, where the DHG queries Intel CPU temperatures, and
140the ICH8 southbridge gets that data via PECI from the DHG, so that the
141southbridge drives the fans. And the DHG supports SST, a one-wire serial bus.
Jean Delvarec1e48dc2009-06-15 18:39:50 +0200142
143The DHG-P has an additional automatic fan speed control mode named Smart Fan
144(TM) III+. This mode is not yet supported by the driver.