max34440.rst

  1Kernel driver max34440
  2======================
  3
  4Supported chips:
  5
  6  * ADI ADPM12160
  7
  8    Prefixes: 'adpm12160'
  9
 10    Addresses scanned: -
 11
 12    Datasheet: -
 13
 14  * ADI ADPM12200
 15
 16    Prefixes: 'adpm12200'
 17
 18    Addresses scanned: -
 19
 20    Datasheet: -
 21
 22  * Maxim MAX34440
 23
 24    Prefixes: 'max34440'
 25
 26    Addresses scanned: -
 27
 28    Datasheet: https://www.analog.com/media/en/technical-documentation/data-sheets/max34440.pdf
 29
 30  * Maxim MAX34441
 31
 32    PMBus 5-Channel Power-Supply Manager and Intelligent Fan Controller
 33
 34    Prefixes: 'max34441'
 35
 36    Addresses scanned: -
 37
 38    Datasheet: https://www.analog.com/media/en/technical-documentation/data-sheets/max34441.pdf
 39
 40  * Maxim MAX34446
 41
 42    PMBus Power-Supply Data Logger
 43
 44    Prefixes: 'max34446'
 45
 46    Addresses scanned: -
 47
 48    Datasheet: https://www.analog.com/media/en/technical-documentation/data-sheets/max34446.pdf
 49
 50  * Maxim MAX34451
 51
 52    PMBus 16-Channel V/I Monitor and 12-Channel Sequencer/Marginer
 53
 54    Prefixes: 'max34451'
 55
 56    Addresses scanned: -
 57
 58    Datasheet: https://www.analog.com/media/en/technical-documentation/data-sheets/max34451.pdf
 59
 60  * Maxim MAX34460
 61
 62    PMBus 12-Channel Voltage Monitor & Sequencer
 63
 64    Prefix: 'max34460'
 65
 66    Addresses scanned: -
 67
 68    Datasheet: https://www.analog.com/media/en/technical-documentation/data-sheets/max34460.pdf
 69
 70  * Maxim MAX34461
 71
 72    PMBus 16-Channel Voltage Monitor & Sequencer
 73
 74    Prefix: 'max34461'
 75
 76    Addresses scanned: -
 77
 78    Datasheet: https://www.analog.com/media/en/technical-documentation/data-sheets/max34461.pdf
 79
 80Author: Guenter Roeck <linux@roeck-us.net>
 81
 82
 83Description
 84-----------
 85
 86This driver supports multiple devices: hardware monitoring for Maxim MAX34440
 87PMBus 6-Channel Power-Supply Manager, MAX34441 PMBus 5-Channel Power-Supply
 88Manager and Intelligent Fan Controller, and MAX34446 PMBus Power-Supply Data
 89Logger; PMBus Voltage Monitor and Sequencers for MAX34451, MAX34460, and
 90MAX34461; PMBus DC/DC Power Module ADPM12160, and ADPM12200. The MAX34451
 91supports monitoring voltage or current of 12 channels based on GIN pins. The
 92MAX34460 supports 12 voltage channels, and the MAX34461 supports 16 voltage
 93channels. The ADPM12160, and ADPM12200 also monitors both input and output
 94of voltage and current.
 95
 96The driver is a client driver to the core PMBus driver. Please see
 97Documentation/hwmon/pmbus.rst for details on PMBus client drivers.
 98
 99
100Usage Notes
101-----------
102
103This driver does not auto-detect devices. You will have to instantiate the
104devices explicitly. Please see Documentation/i2c/instantiating-devices.rst for
105details.
106
107For MAX34446, the value of the currX_crit attribute determines if current or
108voltage measurement is enabled for a given channel. Voltage measurement is
109enabled if currX_crit is set to 0; current measurement is enabled if the
110attribute is set to a positive value. Power measurement is only enabled if
111channel 1 (3) is configured for voltage measurement, and channel 2 (4) is
112configured for current measurement.
113
114
115Platform data support
116---------------------
117
118The driver supports standard PMBus driver platform data.
119
120
121Sysfs entries
122-------------
123
124The following attributes are supported. Limits are read-write; all other
125attributes are read-only.
126
127In
128~~
129
130======================= =======================================================
131in[1-6]_label		"vout[1-6]".
132in[1-6]_input		Measured voltage. From READ_VOUT register.
133in[1-6]_min		Minimum Voltage. From VOUT_UV_WARN_LIMIT register.
134in[1-6]_max		Maximum voltage. From VOUT_OV_WARN_LIMIT register.
135in[1-6]_lcrit		Critical minimum Voltage. VOUT_UV_FAULT_LIMIT register.
136in[1-6]_crit		Critical maximum voltage. From VOUT_OV_FAULT_LIMIT
137			register.
138in[1-6]_min_alarm	Voltage low alarm. From VOLTAGE_UV_WARNING status.
139in[1-6]_max_alarm	Voltage high alarm. From VOLTAGE_OV_WARNING status.
140in[1-6]_lcrit_alarm	Voltage critical low alarm. From VOLTAGE_UV_FAULT
141			status.
142in[1-6]_crit_alarm	Voltage critical high alarm. From VOLTAGE_OV_FAULT
143			status.
144in[1-6]_lowest		Historical minimum voltage.
145in[1-6]_highest		Historical maximum voltage.
146in[1-6]_reset_history	Write any value to reset history.
147======================= =======================================================
148
149.. note::
150
151    - MAX34446 only supports in[1-4].
152    - ADPM12160, and ADPM12200 only supports in[1-2]. Label is "vin1"
153      and "vout1" respectively.
154
155Curr
156~~~~
157
158======================= ========================================================
159curr[1-6]_label		"iout[1-6]".
160curr[1-6]_input		Measured current. From READ_IOUT register.
161curr[1-6]_max		Maximum current. From IOUT_OC_WARN_LIMIT register.
162curr[1-6]_crit		Critical maximum current. From IOUT_OC_FAULT_LIMIT
163			register.
164curr[1-6]_max_alarm	Current high alarm. From IOUT_OC_WARNING status.
165curr[1-6]_crit_alarm	Current critical high alarm. From IOUT_OC_FAULT status.
166curr[1-4]_average	Historical average current (MAX34446/34451 only).
167curr[1-6]_highest	Historical maximum current.
168curr[1-6]_reset_history	Write any value to reset history.
169======================= ========================================================
170
171.. note::
172
173    - in6 and curr6 attributes only exist for MAX34440.
174    - MAX34446 only supports curr[1-4].
175    - For ADPM12160, and ADPM12200, curr[1] is "iin1" and curr[2-6]
176      are "iout[1-5]".
177
178Power
179~~~~~
180
181======================= ========================================================
182power[1,3]_label	"pout[1,3]"
183power[1,3]_input	Measured power.
184power[1,3]_average	Historical average power.
185power[1,3]_highest	Historical maximum power.
186======================= ========================================================
187
188.. note:: Power attributes only exist for MAX34446.
189
190Temp
191~~~~
192
193======================= ========================================================
194temp[1-8]_input		Measured temperatures. From READ_TEMPERATURE_1 register.
195			temp1 is the chip's internal temperature. temp2..temp5
196			are remote I2C temperature sensors. For MAX34441, temp6
197			is a remote thermal-diode sensor. For MAX34440, temp6..8
198			are remote I2C temperature sensors.
199temp[1-8]_max		Maximum temperature. From OT_WARN_LIMIT register.
200temp[1-8]_crit		Critical high temperature. From OT_FAULT_LIMIT register.
201temp[1-8]_max_alarm	Temperature high alarm.
202temp[1-8]_crit_alarm	Temperature critical high alarm.
203temp[1-8]_average	Historical average temperature (MAX34446 only).
204temp[1-8]_highest	Historical maximum temperature.
205temp[1-8]_reset_history	Write any value to reset history.
206======================= ========================================================
207
208
209.. note::
210   - temp7 and temp8 attributes only exist for MAX34440.
211   - MAX34446 only supports temp[1-3].
212   - ADPM12160, and ADPM12200 only supports temp[1].
213
214
215.. note::
216
217   - MAX34451 supports attribute groups in[1-16] (or curr[1-16] based on
218     input pins) and temp[1-5].
219   - MAX34460 supports attribute groups in[1-12] and temp[1-5].
220   - MAX34461 supports attribute groups in[1-16] and temp[1-5].