blob: 37cbf472a19d19aef7aea0217d008943eb28909f [file] [log] [blame]
Guenter Roecke428d8d2011-04-18 09:55:59 -07001Kernel driver max34440
2======================
3
4Supported chips:
5 * Maxim MAX34440
6 Prefixes: 'max34440'
7 Addresses scanned: -
8 Datasheet: http://datasheets.maxim-ic.com/en/ds/MAX34440.pdf
9 * Maxim MAX34441
10 PMBus 5-Channel Power-Supply Manager and Intelligent Fan Controller
11 Prefixes: 'max34441'
12 Addresses scanned: -
13 Datasheet: http://datasheets.maxim-ic.com/en/ds/MAX34441.pdf
Guenter Roeck590defe2012-02-24 03:40:22 -080014 * Maxim MAX34446
15 PMBus Power-Supply Data Logger
16 Prefixes: 'max34446'
17 Addresses scanned: -
18 Datasheet: http://datasheets.maxim-ic.com/en/ds/MAX34446.pdf
Guenter Roeck50115ac2012-04-27 15:13:08 -070019 * Maxim MAX34460
20 PMBus 12-Channel Voltage Monitor & Sequencer
21 Prefix: 'max34460'
22 Addresses scanned: -
23 Datasheet: http://datasheets.maximintegrated.com/en/ds/MAX34460.pdf
24 * Maxim MAX34461
25 PMBus 16-Channel Voltage Monitor & Sequencer
26 Prefix: 'max34461'
27 Addresses scanned: -
28 Datasheet: http://datasheets.maximintegrated.com/en/ds/MAX34461.pdf
Guenter Roecke428d8d2011-04-18 09:55:59 -070029
Guenter Roecke3333e52013-02-20 20:58:42 -080030Author: Guenter Roeck <linux@roeck-us.net>
Guenter Roecke428d8d2011-04-18 09:55:59 -070031
32
33Description
34-----------
35
36This driver supports hardware montoring for Maxim MAX34440 PMBus 6-Channel
Guenter Roeck590defe2012-02-24 03:40:22 -080037Power-Supply Manager, MAX34441 PMBus 5-Channel Power-Supply Manager
38and Intelligent Fan Controller, and MAX34446 PMBus Power-Supply Data Logger.
Guenter Roeck50115ac2012-04-27 15:13:08 -070039It also supports the MAX34460 and MAX34461 PMBus Voltage Monitor & Sequencers.
40The MAX34460 supports 12 voltage channels, and the MAX34461 supports 16 voltage
41channels.
Guenter Roecke428d8d2011-04-18 09:55:59 -070042
43The driver is a client driver to the core PMBus driver. Please see
44Documentation/hwmon/pmbus for details on PMBus client drivers.
45
46
47Usage Notes
48-----------
49
50This driver does not auto-detect devices. You will have to instantiate the
51devices explicitly. Please see Documentation/i2c/instantiating-devices for
52details.
53
Guenter Roeck590defe2012-02-24 03:40:22 -080054For MAX34446, the value of the currX_crit attribute determines if current or
55voltage measurement is enabled for a given channel. Voltage measurement is
56enabled if currX_crit is set to 0; current measurement is enabled if the
57attribute is set to a positive value. Power measurement is only enabled if
58channel 1 (3) is configured for voltage measurement, and channel 2 (4) is
59configured for current measurement.
60
Guenter Roecke428d8d2011-04-18 09:55:59 -070061
62Platform data support
63---------------------
64
65The driver supports standard PMBus driver platform data.
66
67
68Sysfs entries
69-------------
70
71The following attributes are supported. Limits are read-write; all other
72attributes are read-only.
73
74in[1-6]_label "vout[1-6]".
75in[1-6]_input Measured voltage. From READ_VOUT register.
Masanari Iida40e47122012-03-04 23:16:11 +090076in[1-6]_min Minimum Voltage. From VOUT_UV_WARN_LIMIT register.
Guenter Roecke428d8d2011-04-18 09:55:59 -070077in[1-6]_max Maximum voltage. From VOUT_OV_WARN_LIMIT register.
Masanari Iida40e47122012-03-04 23:16:11 +090078in[1-6]_lcrit Critical minimum Voltage. VOUT_UV_FAULT_LIMIT register.
Guenter Roecke428d8d2011-04-18 09:55:59 -070079in[1-6]_crit Critical maximum voltage. From VOUT_OV_FAULT_LIMIT register.
80in[1-6]_min_alarm Voltage low alarm. From VOLTAGE_UV_WARNING status.
81in[1-6]_max_alarm Voltage high alarm. From VOLTAGE_OV_WARNING status.
82in[1-6]_lcrit_alarm Voltage critical low alarm. From VOLTAGE_UV_FAULT status.
83in[1-6]_crit_alarm Voltage critical high alarm. From VOLTAGE_OV_FAULT status.
Guenter Roeck56aad5d2012-02-24 08:13:31 -080084in[1-6]_lowest Historical minimum voltage.
Guenter Roeck98591db2011-07-09 13:17:43 -070085in[1-6]_highest Historical maximum voltage.
86in[1-6]_reset_history Write any value to reset history.
Guenter Roecke428d8d2011-04-18 09:55:59 -070087
Guenter Roeck590defe2012-02-24 03:40:22 -080088 MAX34446 only supports in[1-4].
89
Guenter Roecke428d8d2011-04-18 09:55:59 -070090curr[1-6]_label "iout[1-6]".
91curr[1-6]_input Measured current. From READ_IOUT register.
92curr[1-6]_max Maximum current. From IOUT_OC_WARN_LIMIT register.
93curr[1-6]_crit Critical maximum current. From IOUT_OC_FAULT_LIMIT register.
94curr[1-6]_max_alarm Current high alarm. From IOUT_OC_WARNING status.
95curr[1-6]_crit_alarm Current critical high alarm. From IOUT_OC_FAULT status.
Guenter Roeck590defe2012-02-24 03:40:22 -080096curr[1-4]_average Historical average current (MAX34446 only).
Guenter Roeck98591db2011-07-09 13:17:43 -070097curr[1-6]_highest Historical maximum current.
98curr[1-6]_reset_history Write any value to reset history.
Guenter Roecke428d8d2011-04-18 09:55:59 -070099
100 in6 and curr6 attributes only exist for MAX34440.
Guenter Roeck590defe2012-02-24 03:40:22 -0800101 MAX34446 only supports curr[1-4].
102
103power[1,3]_label "pout[1,3]"
104power[1,3]_input Measured power.
105power[1,3]_average Historical average power.
106power[1,3]_highest Historical maximum power.
107
108 Power attributes only exist for MAX34446.
Guenter Roecke428d8d2011-04-18 09:55:59 -0700109
110temp[1-8]_input Measured temperatures. From READ_TEMPERATURE_1 register.
111 temp1 is the chip's internal temperature. temp2..temp5
112 are remote I2C temperature sensors. For MAX34441, temp6
113 is a remote thermal-diode sensor. For MAX34440, temp6..8
114 are remote I2C temperature sensors.
115temp[1-8]_max Maximum temperature. From OT_WARN_LIMIT register.
116temp[1-8]_crit Critical high temperature. From OT_FAULT_LIMIT register.
117temp[1-8]_max_alarm Temperature high alarm.
118temp[1-8]_crit_alarm Temperature critical high alarm.
Guenter Roeck590defe2012-02-24 03:40:22 -0800119temp[1-8]_average Historical average temperature (MAX34446 only).
Guenter Roeck98591db2011-07-09 13:17:43 -0700120temp[1-8]_highest Historical maximum temperature.
121temp[1-8]_reset_history Write any value to reset history.
Guenter Roecke428d8d2011-04-18 09:55:59 -0700122
123 temp7 and temp8 attributes only exist for MAX34440.
Guenter Roeck590defe2012-02-24 03:40:22 -0800124 MAX34446 only supports temp[1-3].
Guenter Roeck50115ac2012-04-27 15:13:08 -0700125
126MAX34460 supports attribute groups in[1-12] and temp[1-5].
127MAX34461 supports attribute groups in[1-16] and temp[1-5].