hwmon: (ltc2978) Add support for LTC3887
[pandora-kernel.git] / Documentation / hwmon / ltc2978
1 Kernel driver ltc2978
2 =====================
3
4 Supported chips:
5   * Linear Technology LTC2974
6     Prefix: 'ltc2974'
7     Addresses scanned: -
8     Datasheet: http://www.linear.com/product/ltc2974
9   * Linear Technology LTC2977
10     Prefix: 'ltc2977'
11     Addresses scanned: -
12     Datasheet: http://www.linear.com/product/ltc2977
13   * Linear Technology LTC2978, LTC2978A
14     Prefix: 'ltc2978'
15     Addresses scanned: -
16     Datasheet: http://www.linear.com/product/ltc2978
17                http://www.linear.com/product/ltc2978a
18   * Linear Technology LTC3880
19     Prefix: 'ltc3880'
20     Addresses scanned: -
21     Datasheet: http://www.linear.com/product/ltc3880
22   * Linear Technology LTC3882
23     Prefix: 'ltc3882'
24     Addresses scanned: -
25     Datasheet: http://www.linear.com/product/ltc3882
26   * Linear Technology LTC3883
27     Prefix: 'ltc3883'
28     Addresses scanned: -
29     Datasheet: http://www.linear.com/product/ltc3883
30   * Linear Technology LTC3887
31     Prefix: 'ltc3887'
32     Addresses scanned: -
33     Datasheet: http://www.linear.com/product/ltc3887
34   * Linear Technology LTM4676
35     Prefix: 'ltm4676'
36     Addresses scanned: -
37     Datasheet: http://www.linear.com/product/ltm4676
38
39 Author: Guenter Roeck <linux@roeck-us.net>
40
41
42 Description
43 -----------
44
45 LTC2974 is a quad digital power supply managers.
46 LTC2978 is an octal power supply monitor.
47 LTC2977 is a pin compatible replacement for LTC2978.
48 LTC3880, LTC3882, and LTC3887 are dual output poly-phase step-down DC/DC
49 controllers.
50 LTC3883 is a single phase step-down DC/DC controller.
51 LTM4676 is a dual 13A or single 26A uModule regulator.
52
53
54 Usage Notes
55 -----------
56
57 This driver does not probe for PMBus devices. You will have to instantiate
58 devices explicitly.
59
60 Example: the following commands will load the driver for an LTC2978 at address
61 0x60 on I2C bus #1:
62
63 # modprobe ltc2978
64 # echo ltc2978 0x60 > /sys/bus/i2c/devices/i2c-1/new_device
65
66
67 Sysfs attributes
68 ----------------
69
70 in1_label               "vin"
71 in1_input               Measured input voltage.
72 in1_min                 Minimum input voltage.
73 in1_max                 Maximum input voltage.
74                         LTC2974, LTC2977, and LTC2978 only.
75 in1_lcrit               Critical minimum input voltage.
76                         LTC2974, LTC2977, and LTC2978 only.
77 in1_crit                Critical maximum input voltage.
78 in1_min_alarm           Input voltage low alarm.
79 in1_max_alarm           Input voltage high alarm.
80                         LTC2974, LTC2977, and LTC2978 only.
81 in1_lcrit_alarm         Input voltage critical low alarm.
82                         LTC2974, LTC2977, and LTC2978 only.
83 in1_crit_alarm          Input voltage critical high alarm.
84 in1_lowest              Lowest input voltage.
85                         LTC2974, LTC2977, and LTC2978 only.
86 in1_highest             Highest input voltage.
87 in1_reset_history       Reset input voltage history.
88
89 in[N]_label             "vout[1-8]".
90                         LTC2974: N=2-5
91                         LTC2977: N=2-9
92                         LTC2978: N=2-9
93                         LTC3880, LTC3882, LTC3887, LTM4676: N=2-3
94                         LTC3883: N=2
95 in[N]_input             Measured output voltage.
96 in[N]_min               Minimum output voltage.
97 in[N]_max               Maximum output voltage.
98 in[N]_lcrit             Critical minimum output voltage.
99 in[N]_crit              Critical maximum output voltage.
100 in[N]_min_alarm         Output voltage low alarm.
101 in[N]_max_alarm         Output voltage high alarm.
102 in[N]_lcrit_alarm       Output voltage critical low alarm.
103 in[N]_crit_alarm        Output voltage critical high alarm.
104 in[N]_lowest            Lowest output voltage. LTC2974 and LTC2978 only.
105 in[N]_highest           Highest output voltage.
106 in[N]_reset_history     Reset output voltage history.
107
108 temp[N]_input           Measured temperature.
109                         On LTC2974, temp[1-4] report external temperatures,
110                         and temp5 reports the chip temperature.
111                         On LTC2977 and LTC2978, only one temperature measurement
112                         is supported and reports the chip temperature.
113                         On LTC3880, LTC3882, LTC3887, and LTM4676, temp1 and
114                         temp2 report external temperatures, and temp3 reports
115                         the chip temperature.
116                         On LTC3883, temp1 reports an external temperature,
117                         and temp2 reports the chip temperature.
118 temp[N]_min             Mimimum temperature. LTC2974, LCT2977, and LTC2978 only.
119 temp[N]_max             Maximum temperature.
120 temp[N]_lcrit           Critical low temperature.
121 temp[N]_crit            Critical high temperature.
122 temp[N]_min_alarm       Temperature low alarm.
123                         LTC2974, LTC2977, and LTC2978 only.
124 temp[N]_max_alarm       Temperature high alarm.
125 temp[N]_lcrit_alarm     Temperature critical low alarm.
126 temp[N]_crit_alarm      Temperature critical high alarm.
127 temp[N]_lowest          Lowest measured temperature.
128                         LTC2974, LTC2977, and LTC2978 only.
129                         Not supported for chip temperature sensor on LTC2974.
130 temp[N]_highest         Highest measured temperature. Not supported for chip
131                         temperature sensor on LTC2974.
132 temp[N]_reset_history   Reset temperature history. Not supported for chip
133                         temperature sensor on LTC2974.
134
135 power1_label            "pin". LTC3883 only.
136 power1_input            Measured input power.
137
138 power[N]_label          "pout[1-4]".
139                         LTC2974: N=1-4
140                         LTC2977: Not supported
141                         LTC2978: Not supported
142                         LTC3880, LTC3882, LTC3887, LTM4676: N=1-2
143                         LTC3883: N=2
144 power[N]_input          Measured output power.
145
146 curr1_label             "iin". LTC3880, LTC3883, LTC3887, and LTM4676 only.
147 curr1_input             Measured input current.
148 curr1_max               Maximum input current.
149 curr1_max_alarm         Input current high alarm.
150 curr1_highest           Highest input current. LTC3883 only.
151 curr1_reset_history     Reset input current history. LTC3883 only.
152
153 curr[N]_label           "iout[1-4]".
154                         LTC2974: N=1-4
155                         LTC2977: not supported
156                         LTC2978: not supported
157                         LTC3880, LTC3882, LTC3887, LTM4676: N=2-3
158                         LTC3883: N=2
159 curr[N]_input           Measured output current.
160 curr[N]_max             Maximum output current.
161 curr[N]_crit            Critical high output current.
162 curr[N]_lcrit           Critical low output current. LTC2974 only.
163 curr[N]_max_alarm       Output current high alarm.
164 curr[N]_crit_alarm      Output current critical high alarm.
165 curr[N]_lcrit_alarm     Output current critical low alarm. LTC2974 only.
166 curr[N]_lowest          Lowest output current. LTC2974 only.
167 curr[N]_highest         Highest output current.
168 curr[N]_reset_history   Reset output current history.