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