blob: 19b2ed739fa1325e09ab91cb629ce69b3331a2af [file] [log] [blame]
Charles Spirakis98739642006-04-25 14:21:03 +02001Kernel driver w83791d
2=====================
3
4Supported chips:
5 * Winbond W83791D
6 Prefix: 'w83791d'
7 Addresses scanned: I2C 0x2c - 0x2f
Charles Spirakis125751cb2006-09-24 20:53:04 +02008 Datasheet: http://www.winbond-usa.com/products/winbond_products/pdfs/PCIC/W83791D_W83791Gb.pdf
Charles Spirakis98739642006-04-25 14:21:03 +02009
10Author: Charles Spirakis <bezaur@gmail.com>
11
12This driver was derived from the w83781d.c and w83792d.c source files.
13
14Credits:
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@sh.cvut.cz>
22
Charles Spirakis125751cb2006-09-24 20:53:04 +020023Additional contributors:
24 Sven Anders <anders@anduras.de>
25
Charles Spirakis98739642006-04-25 14:21:03 +020026Module 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
49Description
50-----------
51
Charles Spirakis125751cb2006-09-24 20:53:04 +020052This driver implements support for the Winbond W83791D chip. The W83791G
53chip appears to be the same as the W83791D but is lead free.
Charles Spirakis98739642006-04-25 14:21:03 +020054
55Detection of the chip can sometimes be foiled because it can be in an
56internal state that allows no clean access (Bank with ID register is not
57currently selected). If you know the address of the chip, use a 'force'
58parameter; this will put it into a more well-behaved state first.
59
60The driver implements three temperature sensors, five fan rotation speed
61sensors, and ten voltage sensors.
62
63Temperatures are measured in degrees Celsius and measurement resolution is 1
64degC for temp1 and 0.5 degC for temp2 and temp3. An alarm is triggered when
65the temperature gets higher than the Overtemperature Shutdown value; it stays
66on until the temperature falls below the Hysteresis value.
67
68Fan rotation speeds are reported in RPM (rotations per minute). An alarm is
69triggered if the rotation speed has dropped below a programmable limit. Fan
70readings can be divided by a programmable divider (1, 2, 4, 8 for fan 1/2/3
71and 1, 2, 4, 8, 16, 32, 64 or 128 for fan 4/5) to give the readings more
72range or accuracy.
73
74Voltage sensors (also known as IN sensors) report their values in millivolts.
75An alarm is triggered if the voltage has crossed a programmable minimum
76or maximum limit.
77
Charles Spirakis125751cb2006-09-24 20:53:04 +020078The bit ordering for the alarm "realtime status register" and the
79"beep enable registers" are different.
Charles Spirakis98739642006-04-25 14:21:03 +020080
Charles Spirakis125751cb2006-09-24 20:53:04 +020081in0 (VCORE) : alarms: 0x000001 beep_enable: 0x000001
82in1 (VINR0) : alarms: 0x000002 beep_enable: 0x002000 <== mismatch
83in2 (+3.3VIN): alarms: 0x000004 beep_enable: 0x000004
84in3 (5VDD) : alarms: 0x000008 beep_enable: 0x000008
85in4 (+12VIN) : alarms: 0x000100 beep_enable: 0x000100
86in5 (-12VIN) : alarms: 0x000200 beep_enable: 0x000200
87in6 (-5VIN) : alarms: 0x000400 beep_enable: 0x000400
88in7 (VSB) : alarms: 0x080000 beep_enable: 0x010000 <== mismatch
89in8 (VBAT) : alarms: 0x100000 beep_enable: 0x020000 <== mismatch
90in9 (VINR1) : alarms: 0x004000 beep_enable: 0x004000
91temp1 : alarms: 0x000010 beep_enable: 0x000010
92temp2 : alarms: 0x000020 beep_enable: 0x000020
93temp3 : alarms: 0x002000 beep_enable: 0x000002 <== mismatch
94fan1 : alarms: 0x000040 beep_enable: 0x000040
95fan2 : alarms: 0x000080 beep_enable: 0x000080
96fan3 : alarms: 0x000800 beep_enable: 0x000800
97fan4 : alarms: 0x200000 beep_enable: 0x200000
98fan5 : alarms: 0x400000 beep_enable: 0x400000
99tart1 : alarms: 0x010000 beep_enable: 0x040000 <== mismatch
100tart2 : alarms: 0x020000 beep_enable: 0x080000 <== mismatch
101tart3 : alarms: 0x040000 beep_enable: 0x100000 <== mismatch
102case_open : alarms: 0x001000 beep_enable: 0x001000
103user_enable : alarms: -------- beep_enable: 0x800000
104
105*** NOTE: It is the responsibility of user-space code to handle the fact
106that the beep enable and alarm bits are in different positions when using that
107feature of the chip.
Charles Spirakis98739642006-04-25 14:21:03 +0200108
109When an alarm goes off, you can be warned by a beeping signal through your
110computer speaker. It is possible to enable all beeping globally, or only
111the beeping for some alarms.
112
113The driver only reads the chip values each 3 seconds; reading them more
114often will do no harm, but will return 'old' values.
115
116W83791D TODO:
117---------------
Charles Spirakis125751cb2006-09-24 20:53:04 +0200118Provide a patch for per-file alarms and beep enables as defined in the hwmon
119 documentation (Documentation/hwmon/sysfs-interface)
Charles Spirakis98739642006-04-25 14:21:03 +0200120Provide a patch for smart-fan control (still need appropriate motherboard/fans)