Documentation/hwmon/w83791d

   1 Kernel driver w83791d
   2 =====================
   3
   4 Supported chips:
   5   * Winbond W83791D
   6     Prefix: 'w83791d'
   7     Addresses scanned: I2C 0x2c - 0x2f
   8     Datasheet: http://www.winbond-usa.com/products/winbond_products/pdfs/PCIC/W83791D_W83791Gb.pdf
   9
  10 Author: Charles Spirakis <bezaur@gmail.com>
  11
  12 This driver was derived from the w83781d.c and w83792d.c source files.
  13
  14 Credits:
  15   w83781d.c:
  16     Frodo Looijaard <frodol@dds.nl>,
  17     Philip Edelbrock <phil@netroedge.com>,
  18     and Mark Studebaker <mdsxyz123@yahoo.com>
  19   w83792d.c:
  20     Chunhao Huang <DZShen@Winbond.com.tw>,
  21     Rudolf Marek <r.marek@assembler.cz>
  22
  23 Additional contributors:
  24     Sven Anders <anders@anduras.de>
  25
  26 Module Parameters
  27 -----------------
  28
  29 * init boolean
  30   (default 0)
  31   Use 'init=1' to have the driver do extra software initializations.
  32   The default behavior is to do the minimum initialization possible
  33   and depend on the BIOS to properly setup the chip. If you know you
  34   have a w83791d and you're having problems, try init=1 before trying
  35   reset=1.
  36
  37 * reset boolean
  38   (default 0)
  39   Use 'reset=1' to reset the chip (via index 0x40, bit 7). The default
  40   behavior is no chip reset to preserve BIOS settings.
  41
  42 * force_subclients=bus,caddr,saddr,saddr
  43   This is used to force the i2c addresses for subclients of
  44   a certain chip. Example usage is `force_subclients=0,0x2f,0x4a,0x4b'
  45   to force the subclients of chip 0x2f on bus 0 to i2c addresses
  46   0x4a and 0x4b.
  47
  48
  49 Description
  50 -----------
  51
  52 This driver implements support for the Winbond W83791D chip. The W83791G
  53 chip appears to be the same as the W83791D but is lead free.
  54
  55 Detection of the chip can sometimes be foiled because it can be in an
  56 internal state that allows no clean access (Bank with ID register is not
  57 currently selected). If you know the address of the chip, use a 'force'
  58 parameter; this will put it into a more well-behaved state first.
  59
  60 The driver implements three temperature sensors, five fan rotation speed
  61 sensors, and ten voltage sensors.
  62
  63 Temperatures are measured in degrees Celsius and measurement resolution is 1
  64 degC for temp1 and 0.5 degC for temp2 and temp3. An alarm is triggered when
  65 the temperature gets higher than the Overtemperature Shutdown value; it stays
  66 on until the temperature falls below the Hysteresis value.
  67
  68 Fan rotation speeds are reported in RPM (rotations per minute). An alarm is
  69 triggered if the rotation speed has dropped below a programmable limit. Fan
  70 readings can be divided by a programmable divider (1, 2, 4, 8 for fan 1/2/3
  71 and 1, 2, 4, 8, 16, 32, 64 or 128 for fan 4/5) to give the readings more
  72 range or accuracy.
  73
  74 Voltage sensors (also known as IN sensors) report their values in millivolts.
  75 An alarm is triggered if the voltage has crossed a programmable minimum
  76 or maximum limit.
  77
  78 The bit ordering for the alarm "realtime status register" and the
  79 "beep enable registers" are different.
  80
  81 in0 (VCORE)  :  alarms: 0x000001 beep_enable: 0x000001
  82 in1 (VINR0)  :  alarms: 0x000002 beep_enable: 0x002000 <== mismatch
  83 in2 (+3.3VIN):  alarms: 0x000004 beep_enable: 0x000004
  84 in3 (5VDD)   :  alarms: 0x000008 beep_enable: 0x000008
  85 in4 (+12VIN) :  alarms: 0x000100 beep_enable: 0x000100
  86 in5 (-12VIN) :  alarms: 0x000200 beep_enable: 0x000200
  87 in6 (-5VIN)  :  alarms: 0x000400 beep_enable: 0x000400
  88 in7 (VSB)    :  alarms: 0x080000 beep_enable: 0x010000 <== mismatch
  89 in8 (VBAT)   :  alarms: 0x100000 beep_enable: 0x020000 <== mismatch
  90 in9 (VINR1)  :  alarms: 0x004000 beep_enable: 0x004000
  91 temp1        :  alarms: 0x000010 beep_enable: 0x000010
  92 temp2        :  alarms: 0x000020 beep_enable: 0x000020
  93 temp3        :  alarms: 0x002000 beep_enable: 0x000002 <== mismatch
  94 fan1         :  alarms: 0x000040 beep_enable: 0x000040
  95 fan2         :  alarms: 0x000080 beep_enable: 0x000080
  96 fan3         :  alarms: 0x000800 beep_enable: 0x000800
  97 fan4         :  alarms: 0x200000 beep_enable: 0x200000
  98 fan5         :  alarms: 0x400000 beep_enable: 0x400000
  99 tart1        :  alarms: 0x010000 beep_enable: 0x040000 <== mismatch
 100 tart2        :  alarms: 0x020000 beep_enable: 0x080000 <== mismatch
 101 tart3        :  alarms: 0x040000 beep_enable: 0x100000 <== mismatch
 102 case_open    :  alarms: 0x001000 beep_enable: 0x001000
 103 user_enable  :  alarms: -------- beep_enable: 0x800000
 104
 105 *** NOTE: It is the responsibility of user-space code to handle the fact
 106 that the beep enable and alarm bits are in different positions when using that
 107 feature of the chip.
 108
 109 When an alarm goes off, you can be warned by a beeping signal through your
 110 computer speaker. It is possible to enable all beeping globally, or only
 111 the beeping for some alarms.
 112
 113 The driver only reads the chip values each 3 seconds; reading them more
 114 often will do no harm, but will return 'old' values.
 115
 116 W83791D TODO:
 117 ---------------
 118 Provide a patch for per-file alarms and beep enables as defined in the hwmon
 119         documentation (Documentation/hwmon/sysfs-interface)
 120 Provide a patch for smart-fan control (still need appropriate motherboard/fans)