WIP FPC-III support
[linux/fpc-iii.git] / Documentation / hwmon / ltc2978.rst
blobb99a63965cfb78721caf3cba835cdb8366fc8847
1 Kernel driver ltc2978
2 =====================
4 Supported chips:
6   * Linear Technology LTC2972
8     Prefix: 'ltc2972'
10     Addresses scanned: -
12     Datasheet: https://www.analog.com/en/products/ltc2972.html
14   * Linear Technology LTC2974
16     Prefix: 'ltc2974'
18     Addresses scanned: -
20     Datasheet: https://www.analog.com/en/products/ltc2974
22   * Linear Technology LTC2975
24     Prefix: 'ltc2975'
26     Addresses scanned: -
28     Datasheet: https://www.analog.com/en/products/ltc2975
30   * Linear Technology LTC2977
32     Prefix: 'ltc2977'
34     Addresses scanned: -
36     Datasheet: https://www.analog.com/en/products/ltc2977
38   * Linear Technology LTC2978, LTC2978A
40     Prefix: 'ltc2978'
42     Addresses scanned: -
44     Datasheet: https://www.analog.com/en/products/ltc2978
46                https://www.analog.com/en/products/ltc2978a
48   * Linear Technology LTC2979
50     Prefix: 'ltc2979'
52     Addresses scanned: -
54     Datasheet: https://www.analog.com/en/products/ltc2979
56   * Linear Technology LTC2980
58     Prefix: 'ltc2980'
60     Addresses scanned: -
62     Datasheet: https://www.analog.com/en/products/ltc2980
64   * Linear Technology LTC3880
66     Prefix: 'ltc3880'
68     Addresses scanned: -
70     Datasheet: https://www.analog.com/en/products/ltc3880
72   * Linear Technology LTC3882
74     Prefix: 'ltc3882'
76     Addresses scanned: -
78     Datasheet: https://www.analog.com/en/products/ltc3882
80   * Linear Technology LTC3883
82     Prefix: 'ltc3883'
84     Addresses scanned: -
86     Datasheet: https://www.analog.com/en/products/ltc3883
88   * Linear Technology LTC3884
90     Prefix: 'ltc3884'
92     Addresses scanned: -
94     Datasheet: https://www.analog.com/en/products/ltc3884
96   * Linear Technology LTC3886
98     Prefix: 'ltc3886'
100     Addresses scanned: -
102     Datasheet: https://www.analog.com/en/products/ltc3886
104   * Linear Technology LTC3887
106     Prefix: 'ltc3887'
108     Addresses scanned: -
110     Datasheet: https://www.analog.com/en/products/ltc3887
112   * Linear Technology LTC3889
114     Prefix: 'ltc3889'
116     Addresses scanned: -
118     Datasheet: https://www.analog.com/en/products/ltc3889
120   * Linear Technology LTC7880
122     Prefix: 'ltc7880'
124     Addresses scanned: -
126     Datasheet: https://www.analog.com/en/products/ltc7880
128   * Linear Technology LTM2987
130     Prefix: 'ltm2987'
132     Addresses scanned: -
134     Datasheet: https://www.analog.com/en/products/ltm2987
136   * Linear Technology LTM4644
138     Prefix: 'ltm4644'
140     Addresses scanned: -
142     Datasheet: https://www.analog.com/en/products/ltm4644
144    * Linear Technology LTM4675
146     Prefix: 'ltm4675'
148     Addresses scanned: -
150     Datasheet: https://www.analog.com/en/products/ltm4675
152   * Linear Technology LTM4676
154     Prefix: 'ltm4676'
156     Addresses scanned: -
158     Datasheet: https://www.analog.com/en/products/ltm4676
160   * Linear Technology LTM4677
162     Prefix: 'ltm4677'
164     Addresses scanned: -
166     Datasheet: https://www.analog.com/en/products/ltm4677
168   * Linear Technology LTM4678
170     Prefix: 'ltm4678'
172     Addresses scanned: -
174     Datasheet: https://www.analog.com/en/products/ltm4678
176   * Analog Devices LTM4680
178     Prefix: 'ltm4680'
180     Addresses scanned: -
182     Datasheet: https://www.analog.com/ltm4680
184   * Analog Devices LTM4686
186     Prefix: 'ltm4686'
188     Addresses scanned: -
190     Datasheet: https://www.analog.com/ltm4686
192   * Analog Devices LTM4700
194     Prefix: 'ltm4700'
196     Addresses scanned: -
198     Datasheet: https://www.analog.com/ltm4700
202 Author: Guenter Roeck <linux@roeck-us.net>
205 Description
206 -----------
208 - LTC2974 and LTC2975 are quad digital power supply managers.
209 - LTC2978 is an octal power supply monitor.
210 - LTC2977 is a pin compatible replacement for LTC2978.
211 - LTC2980 is a 16-channel Power System Manager, consisting of two LTC2977
212 - in a single die. The chip is instantiated and reported as two separate chips
213 - on two different I2C bus addresses.
214 - LTC3880, LTC3882, LTC3886, and LTC3887 are dual output poly-phase step-down
215 - DC/DC controllers.
216 - LTC3883 is a single phase step-down DC/DC controller.
217 - LTM2987 is a 16-channel Power System Manager with two LTC2977 plus
218 - additional components on a single die. The chip is instantiated and reported
219 - as two separate chips on two different I2C bus addresses.
220 - LTM4675 is a dual 9A or single 18A μModule regulator
221 - LTM4676 is a dual 13A or single 26A uModule regulator.
222 - LTM4686 is a dual 10A or single 20A uModule regulator.
225 Usage Notes
226 -----------
228 This driver does not probe for PMBus devices. You will have to instantiate
229 devices explicitly.
231 Example: the following commands will load the driver for an LTC2978 at address
232 0x60 on I2C bus #1::
234         # modprobe ltc2978
235         # echo ltc2978 0x60 > /sys/bus/i2c/devices/i2c-1/new_device
238 Sysfs attributes
239 ----------------
241 ======================= ========================================================
242 in1_label               "vin"
244 in1_input               Measured input voltage.
246 in1_min                 Minimum input voltage.
248 in1_max                 Maximum input voltage.
250                         LTC2974, LTC2975, LTC2977, LTC2980, LTC2978,
251                         LTC2979 and LTM2987 only.
253 in1_lcrit               Critical minimum input voltage.
255                         LTC2972, LTC2974, LTC2975, LTC2977, LTC2980, LTC2978,
256                         LTC2979 and LTM2987 only.
258 in1_crit                Critical maximum input voltage.
260 in1_min_alarm           Input voltage low alarm.
262 in1_max_alarm           Input voltage high alarm.
264                         LTC2972, LTC2974, LTC2975, LTC2977, LTC2980, LTC2978,
265                         LTC2979 and LTM2987 only.
267 in1_lcrit_alarm         Input voltage critical low alarm.
269                         LTC2972, LTC2974, LTC2975, LTC2977, LTC2980, LTC2978,
270                         LTC2979 and LTM2987 only.
272 in1_crit_alarm          Input voltage critical high alarm.
274 in1_lowest              Lowest input voltage.
276                         LTC2972, LTC2974, LTC2975, LTC2977, LTC2980, LTC2978,
277                         and LTM2987 only.
279 in1_highest             Highest input voltage.
281 in1_reset_history       Reset input voltage history.
283 in[N]_label             "vout[1-8]".
285                         - LTC2972: N=2-3
286                         - LTC2974, LTC2975: N=2-5
287                         - LTC2977, LTC2979, LTC2980, LTM2987: N=2-9
288                         - LTC2978: N=2-9
289                         - LTC3880, LTC3882, LTC3884, LTC23886 LTC3887, LTC3889,
290                           LTC7880, LTM4644, LTM4675, LTM4676, LTM4677, LTM4678,
291                           LTM4680, LTM4700: N=2-3
292                         - LTC3883: N=2
294 in[N]_input             Measured output voltage.
296 in[N]_min               Minimum output voltage.
298 in[N]_max               Maximum output voltage.
300 in[N]_lcrit             Critical minimum output voltage.
302 in[N]_crit              Critical maximum output voltage.
304 in[N]_min_alarm         Output voltage low alarm.
306 in[N]_max_alarm         Output voltage high alarm.
308 in[N]_lcrit_alarm       Output voltage critical low alarm.
310 in[N]_crit_alarm        Output voltage critical high alarm.
312 in[N]_lowest            Lowest output voltage.
314                         LTC2972, LTC2974, LTC2975,and LTC2978 only.
316 in[N]_highest           Highest output voltage.
318 in[N]_reset_history     Reset output voltage history.
320 temp[N]_input           Measured temperature.
322                         - On LTC2972, temp[1-2] report external temperatures,
323                           and temp 3 reports the chip temperature.
324                         - On LTC2974 and LTC2975, temp[1-4] report external
325                           temperatures, and temp5 reports the chip temperature.
326                         - On LTC2977, LTC2979, LTC2980, LTC2978, and LTM2987,
327                           only one temperature measurement is supported and
328                           reports the chip temperature.
329                         - On LTC3880, LTC3882, LTC3886, LTC3887, LTC3889,
330                           LTM4664, LTM4675, LTM4676, LTM4677, LTM4678, LTM4680,
331                           and LTM4700, temp1 and temp2 report external
332                           temperatures, and temp3 reports the chip temperature.
333                         - On LTC3883, temp1 reports an external temperature,
334                           and temp2 reports the chip temperature.
336 temp[N]_min             Mimimum temperature.
338                         LTC2972, LTC2974, LCT2977, LTM2980, LTC2978,
339                         LTC2979, and LTM2987 only.
341 temp[N]_max             Maximum temperature.
343 temp[N]_lcrit           Critical low temperature.
345 temp[N]_crit            Critical high temperature.
347 temp[N]_min_alarm       Temperature low alarm.
349                         LTC2972, LTC2974, LTC2975, LTC2977, LTM2980, LTC2978,
350                         LTC2979, and LTM2987 only.
352 temp[N]_max_alarm       Temperature high alarm.
355 temp[N]_lcrit_alarm     Temperature critical low alarm.
357 temp[N]_crit_alarm      Temperature critical high alarm.
359 temp[N]_lowest          Lowest measured temperature.
361                         - LTC2972, LTC2974, LTC2975, LTC2977, LTM2980, LTC2978,
362                           LTC2979, and LTM2987 only.
363                         - Not supported for chip temperature sensor on LTC2974
364                           and LTC2975.
366 temp[N]_highest         Highest measured temperature.
368                         Not supported for chip temperature sensor on
369                         LTC2974 and LTC2975.
371 temp[N]_reset_history   Reset temperature history.
373                         Not supported for chip temperature sensor on
374                         LTC2974 and LTC2975.
376 power1_label            "pin". LTC3883 and LTC3886 only.
378 power1_input            Measured input power.
380 power[N]_label          "pout[1-4]".
382                         - LTC2972: N=1-2
383                         - LTC2974, LTC2975: N=1-4
384                         - LTC2977, LTC2979, LTC2980, LTM2987: Not supported
385                         - LTC2978: Not supported
386                         - LTC3880, LTC3882, LTC3884, LTC3886, LTC3887, LTC3889,
387                           LTM4664, LTM4675, LTM4676, LTM4677, LTM4678, LTM4680,
388                           LTM4700: N=1-2
389                         - LTC3883: N=2
391 power[N]_input          Measured output power.
393 curr1_label             "iin".
395                         LTC3880, LTC3883, LTC3884, LTC3886, LTC3887, LTC3889,
396                         LTM4644, LTM4675, LTM4676, LTM4677, LTM4678, LTM4680,
397                         and LTM4700 only.
399 curr1_input             Measured input current.
401 curr1_max               Maximum input current.
403 curr1_max_alarm         Input current high alarm.
405 curr1_highest           Highest input current.
407                         LTC3883 and LTC3886 only.
409 curr1_reset_history     Reset input current history.
411                         LTC3883 and LTC3886 only.
413 curr[N]_label           "iout[1-4]".
415                         - LTC2972: N-1-2
416                         - LTC2974, LTC2975: N=1-4
417                         - LTC2977, LTC2979, LTC2980, LTM2987: not supported
418                         - LTC2978: not supported
419                         - LTC3880, LTC3882, LTC3884, LTC3886, LTC3887, LTC3889,
420                           LTM4664, LTM4675, LTM4676, LTM4677, LTM4678, LTM4680,
421                           LTM4700: N=2-3
422                         - LTC3883: N=2
424 curr[N]_input           Measured output current.
426 curr[N]_max             Maximum output current.
428 curr[N]_crit            Critical high output current.
430 curr[N]_lcrit           Critical low output current.
432                         LTC2972, LTC2974 and LTC2975 only.
434 curr[N]_max_alarm       Output current high alarm.
436 curr[N]_crit_alarm      Output current critical high alarm.
438 curr[N]_lcrit_alarm     Output current critical low alarm.
440                         LTC2972, LTC2974 and LTC2975 only.
442 curr[N]_lowest          Lowest output current.
444                         LTC2972, LTC2974 and LTC2975 only.
446 curr[N]_highest         Highest output current.
448 curr[N]_reset_history   Reset output current history.
449 ======================= ========================================================