Merge tag 'bitmain-soc-5.2' of git://git.kernel.org/pub/scm/linux/kernel/git/mani...
[sfrench/cifs-2.6.git] / Documentation / hwmon / max34440
1 Kernel driver max34440
2 ======================
3
4 Supported 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
35 Author: Guenter Roeck <linux@roeck-us.net>
36
37
38 Description
39 -----------
40
41 This driver supports hardware monitoring for Maxim MAX34440 PMBus 6-Channel
42 Power-Supply Manager, MAX34441 PMBus 5-Channel Power-Supply Manager
43 and Intelligent Fan Controller, and MAX34446 PMBus Power-Supply Data Logger.
44 It also supports the MAX34451, MAX34460, and MAX34461 PMBus Voltage Monitor &
45 Sequencers. The MAX34451 supports monitoring voltage or current of 12 channels
46 based on GIN pins. The MAX34460 supports 12 voltage channels, and the MAX34461
47 supports 16 voltage channels.
48
49 The driver is a client driver to the core PMBus driver. Please see
50 Documentation/hwmon/pmbus for details on PMBus client drivers.
51
52
53 Usage Notes
54 -----------
55
56 This driver does not auto-detect devices. You will have to instantiate the
57 devices explicitly. Please see Documentation/i2c/instantiating-devices for
58 details.
59
60 For MAX34446, the value of the currX_crit attribute determines if current or
61 voltage measurement is enabled for a given channel. Voltage measurement is
62 enabled if currX_crit is set to 0; current measurement is enabled if the
63 attribute is set to a positive value. Power measurement is only enabled if
64 channel 1 (3) is configured for voltage measurement, and channel 2 (4) is
65 configured for current measurement.
66
67
68 Platform data support
69 ---------------------
70
71 The driver supports standard PMBus driver platform data.
72
73
74 Sysfs entries
75 -------------
76
77 The following attributes are supported. Limits are read-write; all other
78 attributes are read-only.
79
80 in[1-6]_label           "vout[1-6]".
81 in[1-6]_input           Measured voltage. From READ_VOUT register.
82 in[1-6]_min             Minimum Voltage. From VOUT_UV_WARN_LIMIT register.
83 in[1-6]_max             Maximum voltage. From VOUT_OV_WARN_LIMIT register.
84 in[1-6]_lcrit           Critical minimum Voltage. VOUT_UV_FAULT_LIMIT register.
85 in[1-6]_crit            Critical maximum voltage. From VOUT_OV_FAULT_LIMIT register.
86 in[1-6]_min_alarm       Voltage low alarm. From VOLTAGE_UV_WARNING status.
87 in[1-6]_max_alarm       Voltage high alarm. From VOLTAGE_OV_WARNING status.
88 in[1-6]_lcrit_alarm     Voltage critical low alarm. From VOLTAGE_UV_FAULT status.
89 in[1-6]_crit_alarm      Voltage critical high alarm. From VOLTAGE_OV_FAULT status.
90 in[1-6]_lowest          Historical minimum voltage.
91 in[1-6]_highest         Historical maximum voltage.
92 in[1-6]_reset_history   Write any value to reset history.
93
94                         MAX34446 only supports in[1-4].
95
96 curr[1-6]_label         "iout[1-6]".
97 curr[1-6]_input         Measured current. From READ_IOUT register.
98 curr[1-6]_max           Maximum current. From IOUT_OC_WARN_LIMIT register.
99 curr[1-6]_crit          Critical maximum current. From IOUT_OC_FAULT_LIMIT register.
100 curr[1-6]_max_alarm     Current high alarm. From IOUT_OC_WARNING status.
101 curr[1-6]_crit_alarm    Current critical high alarm. From IOUT_OC_FAULT status.
102 curr[1-4]_average       Historical average current (MAX34446/34451 only).
103 curr[1-6]_highest       Historical maximum current.
104 curr[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
109 power[1,3]_label        "pout[1,3]"
110 power[1,3]_input        Measured power.
111 power[1,3]_average      Historical average power.
112 power[1,3]_highest      Historical maximum power.
113
114                         Power attributes only exist for MAX34446.
115
116 temp[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.
121 temp[1-8]_max           Maximum temperature. From OT_WARN_LIMIT register.
122 temp[1-8]_crit          Critical high temperature. From OT_FAULT_LIMIT register.
123 temp[1-8]_max_alarm     Temperature high alarm.
124 temp[1-8]_crit_alarm    Temperature critical high alarm.
125 temp[1-8]_average       Historical average temperature (MAX34446 only).
126 temp[1-8]_highest       Historical maximum temperature.
127 temp[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
132 MAX34451 supports attribute groups in[1-16] (or curr[1-16] based on input pins)
133 and temp[1-5].
134 MAX34460 supports attribute groups in[1-12] and temp[1-5].
135 MAX34461 supports attribute groups in[1-16] and temp[1-5].