Merge branch 'upstream' of git://electric-eye.fr.zoreil.com/home/romieu/linux-2.6...
[linux-2.6] / 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/W83791Da.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@sh.cvut.cz>
22
23 Module Parameters
24 -----------------
25
26 * init boolean
27   (default 0)
28   Use 'init=1' to have the driver do extra software initializations.
29   The default behavior is to do the minimum initialization possible
30   and depend on the BIOS to properly setup the chip. If you know you
31   have a w83791d and you're having problems, try init=1 before trying
32   reset=1.
33
34 * reset boolean
35   (default 0)
36   Use 'reset=1' to reset the chip (via index 0x40, bit 7). The default
37   behavior is no chip reset to preserve BIOS settings.
38
39 * force_subclients=bus,caddr,saddr,saddr
40   This is used to force the i2c addresses for subclients of
41   a certain chip. Example usage is `force_subclients=0,0x2f,0x4a,0x4b'
42   to force the subclients of chip 0x2f on bus 0 to i2c addresses
43   0x4a and 0x4b.
44
45
46 Description
47 -----------
48
49 This driver implements support for the Winbond W83791D chip.
50
51 Detection of the chip can sometimes be foiled because it can be in an
52 internal state that allows no clean access (Bank with ID register is not
53 currently selected). If you know the address of the chip, use a 'force'
54 parameter; this will put it into a more well-behaved state first.
55
56 The driver implements three temperature sensors, five fan rotation speed
57 sensors, and ten voltage sensors.
58
59 Temperatures are measured in degrees Celsius and measurement resolution is 1
60 degC for temp1 and 0.5 degC for temp2 and temp3. An alarm is triggered when
61 the temperature gets higher than the Overtemperature Shutdown value; it stays
62 on until the temperature falls below the Hysteresis value.
63
64 Fan rotation speeds are reported in RPM (rotations per minute). An alarm is
65 triggered if the rotation speed has dropped below a programmable limit. Fan
66 readings can be divided by a programmable divider (1, 2, 4, 8 for fan 1/2/3
67 and 1, 2, 4, 8, 16, 32, 64 or 128 for fan 4/5) to give the readings more
68 range or accuracy.
69
70 Voltage sensors (also known as IN sensors) report their values in millivolts.
71 An alarm is triggered if the voltage has crossed a programmable minimum
72 or maximum limit.
73
74 Alarms are provided as output from a "realtime status register". The
75 following bits are defined:
76
77 bit - alarm on:
78 0  - Vcore
79 1  - VINR0
80 2  - +3.3VIN
81 3  - 5VDD
82 4  - temp1
83 5  - temp2
84 6  - fan1
85 7  - fan2
86 8  - +12VIN
87 9  - -12VIN
88 10 - -5VIN
89 11 - fan3
90 12 - chassis
91 13 - temp3
92 14 - VINR1
93 15 - reserved
94 16 - tart1
95 17 - tart2
96 18 - tart3
97 19 - VSB
98 20 - VBAT
99 21 - fan4
100 22 - fan5
101 23 - reserved
102
103 When an alarm goes off, you can be warned by a beeping signal through your
104 computer speaker. It is possible to enable all beeping globally, or only
105 the beeping for some alarms.
106
107 The driver only reads the chip values each 3 seconds; reading them more
108 often will do no harm, but will return 'old' values.
109
110 W83791D TODO:
111 ---------------
112 Provide a patch for per-file alarms as discussed on the mailing list
113 Provide a patch for smart-fan control (still need appropriate motherboard/fans)