hwmon: (lm90) Add support for the Winbond/Nuvoton W83L771AWG/ASG
[linux-2.6.git] / Documentation / hwmon / w83627ehf
1 Kernel driver w83627ehf
2 =======================
3
4 Supported chips:
5   * Winbond W83627EHF/EHG (ISA access ONLY)
6     Prefix: 'w83627ehf'
7     Addresses scanned: ISA address retrieved from Super I/O registers
8     Datasheet:
9         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
15   * Winbond W83627DHG-P
16     Prefix: 'w83627dhg'
17     Addresses scanned: ISA address retrieved from Super I/O registers
18     Datasheet: not available
19   * Winbond W83667HG
20     Prefix: 'w83667hg'
21     Addresses scanned: ISA address retrieved from Super I/O registers
22     Datasheet: not available
23
24 Authors:
25         Jean Delvare <khali@linux-fr.org>
26         Yuan Mu (Winbond)
27         Rudolf Marek <r.marek@assembler.cz>
28         David Hubbard <david.c.hubbard@gmail.com>
29         Gong Jun <JGong@nuvoton.com>
30
31 Description
32 -----------
33
34 This driver implements support for the Winbond W83627EHF, W83627EHG,
35 W83627DHG, W83627DHG-P and W83667HG super I/O chips. We will refer to them
36 collectively as Winbond chips.
37
38 The chips implement three temperature sensors, five fan rotation
39 speed sensors, ten analog voltage sensors (only nine for the 627DHG), one
40 VID (6 pins for the 627EHF/EHG, 8 pins for the 627DHG and 667HG), alarms
41 with beep warnings (control unimplemented), and some automatic fan
42 regulation strategies (plus manual fan control mode).
43
44 Temperatures are measured in degrees Celsius and measurement resolution is 1
45 degC for temp1 and 0.5 degC for temp2 and temp3. An alarm is triggered when
46 the temperature gets higher than high limit; it stays on until the temperature
47 falls below the hysteresis value.
48
49 Fan rotation speeds are reported in RPM (rotations per minute). An alarm is
50 triggered if the rotation speed has dropped below a programmable limit. Fan
51 readings can be divided by a programmable divider (1, 2, 4, 8, 16, 32, 64 or
52 128) to give the readings more range or accuracy. The driver sets the most
53 suitable fan divisor itself. Some fans might not be present because they
54 share pins with other functions.
55
56 Voltage sensors (also known as IN sensors) report their values in millivolts.
57 An alarm is triggered if the voltage has crossed a programmable minimum
58 or maximum limit.
59
60 The driver supports automatic fan control mode known as Thermal Cruise.
61 In this mode, the chip attempts to keep the measured temperature in a
62 predefined temperature range. If the temperature goes out of range, fan
63 is driven slower/faster to reach the predefined range again.
64
65 The mode works for fan1-fan4. Mapping of temperatures to pwm outputs is as
66 follows:
67
68 temp1 -> pwm1
69 temp2 -> pwm2
70 temp3 -> pwm3
71 prog  -> pwm4 (not on 667HG; the programmable setting is not supported by
72                the driver)
73
74 /sys files
75 ----------
76
77 name - 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
80 pwm[1-4] - this file stores PWM duty cycle or DC value (fan speed) in range:
81            0 (stop) to 255 (full)
82
83 pwm[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" mode
86         * 3 "Fan Speed Cruise" mode
87         * 4 "Smart Fan III" mode
88
89 pwm[1-4]_mode - controls if output is PWM or DC level
90         * 0 DC output (0 - 12v)
91         * 1 PWM output
92
93 Thermal Cruise mode
94 -------------------
95
96 If the temperature is in the range defined by:
97
98 pwm[1-4]_target    - set target temperature, unit millidegree Celsius
99                      (range 0 - 127000)
100 pwm[1-4]_tolerance - tolerance, unit millidegree Celsius (range 0 - 15000)
101
102 there are no changes to fan speed. Once the temperature leaves the interval,
103 fan speed increases (temp is higher) or decreases if lower than desired.
104 There are defined steps and times, but not exported by the driver yet.
105
106 pwm[1-4]_min_output - minimum fan speed (range 1 - 255), when the temperature
107                       is below defined range.
108 pwm[1-4]_stop_time  - how many milliseconds [ms] must elapse to switch
109                       corresponding fan off. (when the temperature was below
110                       defined range).
111
112 Note: last two functions are influenced by other control bits, not yet exported
113       by the driver, so a change might not have any effect.
114
115 Implementation Details
116 ----------------------
117
118 Future driver development should bear in mind that the following registers have
119 different functions on the 627EHF and the 627DHG. Some registers also have
120 different power-on default values, but BIOS should already be loading
121 appropriate defaults. Note that bank selection must be performed as is currently
122 done in the driver for all register addresses.
123
124 0x49:  only on DHG, selects temperature source for AUX fan, CPU fan0
125 0x4a:  not completely documented for the EHF and the DHG documentation assigns
126        different behavior to bits 7 and 6, including extending the temperature
127        input selection to SmartFan I, not just SmartFan III. Testing on the EHF
128        will reveal whether they are compatible or not.
129
130 0x58:  Chip ID: 0xa1=EHF 0xc1=DHG
131 0x5e:  only on DHG, has bits to enable "current mode" temperature detection and
132        critical temperature protection
133 0x45b: only on EHF, bit 3, vin4 alarm (EHF supports 10 inputs, only 9 on DHG)
134 0x552: only on EHF, vin4
135 0x558: only on EHF, vin4 high limit
136 0x559: only on EHF, vin4 low limit
137 0x6b:  only on DHG, SYS fan critical temperature
138 0x6c:  only on DHG, CPU fan0 critical temperature
139 0x6d:  only on DHG, AUX fan critical temperature
140 0x6e:  only on DHG, CPU fan1 critical temperature
141
142 0x50-0x55 and 0x650-0x657 are marked "Test Register" for the EHF, but "Reserved
143        Register" for the DHG
144
145 The DHG also supports PECI, where the DHG queries Intel CPU temperatures, and
146 the ICH8 southbridge gets that data via PECI from the DHG, so that the
147 southbridge drives the fans. And the DHG supports SST, a one-wire serial bus.
148
149 The DHG-P has an additional automatic fan speed control mode named Smart Fan
150 (TM) III+. This mode is not yet supported by the driver.