1Kernel driver max34440
2======================
3
4Supported chips:
5  * Maxim MAX34440
6    Prefixes: 'max34440'
7    Addresses scanned: -
8    Datasheet: http://datasheets.maximintegrated.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.maximintegrated.com/en/ds/MAX34441.pdf
14  * Maxim MAX34446
15    PMBus Power-Supply Data Logger
16    Prefixes: 'max34446'
17    Addresses scanned: -
18    Datasheet: http://datasheets.maximintegrated.com/en/ds/MAX34446.pdf
19  * Maxim MAX34451
20    PMBus 16-Channel V/I Monitor and 12-Channel Sequencer/Marginer
21    Prefixes: 'max34451'
22    Addresses scanned: -
23    Datasheet: http://datasheets.maximintegrated.com/en/ds/MAX34451.pdf
24  * Maxim MAX34460
25    PMBus 12-Channel Voltage Monitor & Sequencer
26    Prefix: 'max34460'
27    Addresses scanned: -
28    Datasheet: http://datasheets.maximintegrated.com/en/ds/MAX34460.pdf
29  * Maxim MAX34461
30    PMBus 16-Channel Voltage Monitor & Sequencer
31    Prefix: 'max34461'
32    Addresses scanned: -
33    Datasheet: http://datasheets.maximintegrated.com/en/ds/MAX34461.pdf
34
35Author: Guenter Roeck <linux@roeck-us.net>
36
37
38Description
39-----------
40
41This driver supports hardware monitoring for Maxim MAX34440 PMBus 6-Channel
42Power-Supply Manager, MAX34441 PMBus 5-Channel Power-Supply Manager
43and Intelligent Fan Controller, and MAX34446 PMBus Power-Supply Data Logger.
44It also supports the MAX34451, MAX34460, and MAX34461 PMBus Voltage Monitor &
45Sequencers. The MAX34451 supports monitoring voltage or current of 12 channels
46based on GIN pins. The MAX34460 supports 12 voltage channels, and the MAX34461
47supports 16 voltage channels.
48
49The driver is a client driver to the core PMBus driver. Please see
50Documentation/hwmon/pmbus for details on PMBus client drivers.
51
52
53Usage Notes
54-----------
55
56This driver does not auto-detect devices. You will have to instantiate the
57devices explicitly. Please see Documentation/i2c/instantiating-devices for
58details.
59
60For MAX34446, the value of the currX_crit attribute determines if current or
61voltage measurement is enabled for a given channel. Voltage measurement is
62enabled if currX_crit is set to 0; current measurement is enabled if the
63attribute is set to a positive value. Power measurement is only enabled if
64channel 1 (3) is configured for voltage measurement, and channel 2 (4) is
65configured for current measurement.
66
67
68Platform data support
69---------------------
70
71The driver supports standard PMBus driver platform data.
72
73
74Sysfs entries
75-------------
76
77The following attributes are supported. Limits are read-write; all other
78attributes are read-only.
79
80in[1-6]_label		"vout[1-6]".
81in[1-6]_input		Measured voltage. From READ_VOUT register.
82in[1-6]_min		Minimum Voltage. From VOUT_UV_WARN_LIMIT register.
83in[1-6]_max		Maximum voltage. From VOUT_OV_WARN_LIMIT register.
84in[1-6]_lcrit		Critical minimum Voltage. VOUT_UV_FAULT_LIMIT register.
85in[1-6]_crit		Critical maximum voltage. From VOUT_OV_FAULT_LIMIT register.
86in[1-6]_min_alarm	Voltage low alarm. From VOLTAGE_UV_WARNING status.
87in[1-6]_max_alarm	Voltage high alarm. From VOLTAGE_OV_WARNING status.
88in[1-6]_lcrit_alarm	Voltage critical low alarm. From VOLTAGE_UV_FAULT status.
89in[1-6]_crit_alarm	Voltage critical high alarm. From VOLTAGE_OV_FAULT status.
90in[1-6]_lowest		Historical minimum voltage.
91in[1-6]_highest		Historical maximum voltage.
92in[1-6]_reset_history	Write any value to reset history.
93
94			MAX34446 only supports in[1-4].
95
96curr[1-6]_label		"iout[1-6]".
97curr[1-6]_input		Measured current. From READ_IOUT register.
98curr[1-6]_max		Maximum current. From IOUT_OC_WARN_LIMIT register.
99curr[1-6]_crit		Critical maximum current. From IOUT_OC_FAULT_LIMIT register.
100curr[1-6]_max_alarm	Current high alarm. From IOUT_OC_WARNING status.
101curr[1-6]_crit_alarm	Current critical high alarm. From IOUT_OC_FAULT status.
102curr[1-4]_average	Historical average current (MAX34446/34451 only).
103curr[1-6]_highest	Historical maximum current.
104curr[1-6]_reset_history	Write any value to reset history.
105
106			in6 and curr6 attributes only exist for MAX34440.
107			MAX34446 only supports curr[1-4].
108
109power[1,3]_label	"pout[1,3]"
110power[1,3]_input	Measured power.
111power[1,3]_average	Historical average power.
112power[1,3]_highest	Historical maximum power.
113
114			Power attributes only exist for MAX34446.
115
116temp[1-8]_input		Measured temperatures. From READ_TEMPERATURE_1 register.
117			temp1 is the chip's internal temperature. temp2..temp5
118			are remote I2C temperature sensors. For MAX34441, temp6
119			is a remote thermal-diode sensor. For MAX34440, temp6..8
120			are remote I2C temperature sensors.
121temp[1-8]_max		Maximum temperature. From OT_WARN_LIMIT register.
122temp[1-8]_crit		Critical high temperature. From OT_FAULT_LIMIT register.
123temp[1-8]_max_alarm	Temperature high alarm.
124temp[1-8]_crit_alarm	Temperature critical high alarm.
125temp[1-8]_average	Historical average temperature (MAX34446 only).
126temp[1-8]_highest	Historical maximum temperature.
127temp[1-8]_reset_history	Write any value to reset history.
128
129			temp7 and temp8 attributes only exist for MAX34440.
130			MAX34446 only supports temp[1-3].
131
132MAX34451 supports attribute groups in[1-16] (or curr[1-16] based on input pins)
133and temp[1-5].
134MAX34460 supports attribute groups in[1-12] and temp[1-5].
135MAX34461 supports attribute groups in[1-16] and temp[1-5].
136