hwmon: (pmbus) Simplify the calculation of variables
[linux-2.6-block.git] / Documentation / hwmon / max16601.rst
CommitLineData
2138f885
GR
1.. SPDX-License-Identifier: GPL-2.0
2
3Kernel driver max16601
4======================
5
6Supported chips:
7
8 * Maxim MAX16601
9
10 Prefix: 'max16601'
11
12 Addresses scanned: -
13
14 Datasheet: Not published
15
16Author: Guenter Roeck <linux@roeck-us.net>
17
18
19Description
20-----------
21
22This driver supports the MAX16601 VR13.HC Dual-Output Voltage Regulator
23Chipset.
24
25The driver is a client driver to the core PMBus driver.
26Please see Documentation/hwmon/pmbus.rst for details on PMBus client drivers.
27
28
29Usage Notes
30-----------
31
32This driver does not auto-detect devices. You will have to instantiate the
33devices explicitly. Please see Documentation/i2c/instantiating-devices.rst for
34details.
35
36
37Platform data support
38---------------------
39
40The driver supports standard PMBus driver platform data.
41
42
43Sysfs entries
44-------------
45
46The following attributes are supported.
47
48======================= =======================================================
49in1_label "vin1"
50in1_input VCORE input voltage.
51in1_alarm Input voltage alarm.
52
53in2_label "vout1"
54in2_input VCORE output voltage.
55in2_alarm Output voltage alarm.
56
57curr1_label "iin1"
58curr1_input VCORE input current, derived from duty cycle and output
59 current.
60curr1_max Maximum input current.
61curr1_max_alarm Current high alarm.
62
63curr2_label "iin1.0"
64curr2_input VCORE phase 0 input current.
65
66curr3_label "iin1.1"
67curr3_input VCORE phase 1 input current.
68
69curr4_label "iin1.2"
70curr4_input VCORE phase 2 input current.
71
72curr5_label "iin1.3"
73curr5_input VCORE phase 3 input current.
74
75curr6_label "iin1.4"
76curr6_input VCORE phase 4 input current.
77
78curr7_label "iin1.5"
79curr7_input VCORE phase 5 input current.
80
81curr8_label "iin1.6"
82curr8_input VCORE phase 6 input current.
83
84curr9_label "iin1.7"
85curr9_input VCORE phase 7 input current.
86
87curr10_label "iin2"
88curr10_input VCORE input current, derived from sensor element.
89
90curr11_label "iin3"
91curr11_input VSA input current.
92
93curr12_label "iout1"
94curr12_input VCORE output current.
95curr12_crit Critical output current.
96curr12_crit_alarm Output current critical alarm.
97curr12_max Maximum output current.
98curr12_max_alarm Output current high alarm.
99
100curr13_label "iout1.0"
101curr13_input VCORE phase 0 output current.
102
103curr14_label "iout1.1"
104curr14_input VCORE phase 1 output current.
105
106curr15_label "iout1.2"
107curr15_input VCORE phase 2 output current.
108
109curr16_label "iout1.3"
110curr16_input VCORE phase 3 output current.
111
112curr17_label "iout1.4"
113curr17_input VCORE phase 4 output current.
114
115curr18_label "iout1.5"
116curr18_input VCORE phase 5 output current.
117
118curr19_label "iout1.6"
119curr19_input VCORE phase 6 output current.
120
121curr20_label "iout1.7"
122curr20_input VCORE phase 7 output current.
123
124curr21_label "iout3"
125curr21_input VSA output current.
126curr21_highest Historical maximum VSA output current.
127curr21_reset_history Write any value to reset curr21_highest.
128curr21_crit Critical output current.
129curr21_crit_alarm Output current critical alarm.
130curr21_max Maximum output current.
131curr21_max_alarm Output current high alarm.
132
133power1_label "pin1"
134power1_input Input power, derived from duty cycle and output current.
135power1_alarm Input power alarm.
136
137power2_label "pin2"
138power2_input Input power, derived from input current sensor.
139
140power3_label "pout"
141power3_input Output power.
142
143temp1_input VCORE temperature.
144temp1_crit Critical high temperature.
145temp1_crit_alarm Chip temperature critical high alarm.
146temp1_max Maximum temperature.
147temp1_max_alarm Chip temperature high alarm.
148
149temp2_input TSENSE_0 temperature
150temp3_input TSENSE_1 temperature
151temp4_input TSENSE_2 temperature
152temp5_input TSENSE_3 temperature
153
154temp6_input VSA temperature.
155temp6_crit Critical high temperature.
156temp6_crit_alarm Chip temperature critical high alarm.
157temp6_max Maximum temperature.
158temp6_max_alarm Chip temperature high alarm.
159======================= =======================================================