docs: hwmon: Include 'xdpe12284.rst' into docs
[linux-block.git] / Documentation / hwmon / xdpe12284.rst
CommitLineData
971dfd8c
VP
1.. SPDX-License-Identifier: GPL-2.0
2
3Kernel driver xdpe122
4=====================
5
6Supported chips:
7
8 * Infineon XDPE12254
9
10 Prefix: 'xdpe12254'
11
12 * Infineon XDPE12284
13
14 Prefix: 'xdpe12284'
15
16Authors:
17
18 Vadim Pasternak <vadimp@mellanox.com>
19
20Description
21-----------
22
23This driver implements support for Infineon Multi-phase XDPE122 family
24dual loop voltage regulators.
25The family includes XDPE12284 and XDPE12254 devices.
26The devices from this family complaint with:
27- Intel VR13 and VR13HC rev 1.3, IMVP8 rev 1.2 and IMPVP9 rev 1.3 DC-DC
28 converter specification.
29- Intel SVID rev 1.9. protocol.
30- PMBus rev 1.3 interface.
31
32Devices support linear format for reading input voltage, input and output current,
33input and output power and temperature.
34Device supports VID format for reading output voltage. The below modes are
35supported:
36- VR12.0 mode, 5-mV DAC - 0x01.
37- VR12.5 mode, 10-mV DAC - 0x02.
38- IMVP9 mode, 5-mV DAC - 0x03.
39- AMD mode 6.25mV - 0x10.
40
41Devices support two pages for telemetry.
42
43The driver provides for current: input, maximum and critical thresholds
44and maximum and critical alarms. Critical thresholds and critical alarm are
45supported only for current output.
46The driver exports the following attributes for via the sysfs files, where
47indexes 1, 2 are for "iin" and 3, 4 for "iout":
48
49**curr[3-4]_crit**
50
51**curr[3-4]_crit_alarm**
52
53**curr[1-4]_input**
54
55**curr[1-4]_label**
56
57**curr[1-4]_max**
58
59**curr[1-4]_max_alarm**
60
61The driver provides for voltage: input, critical and low critical thresholds
62and critical and low critical alarms.
63The driver exports the following attributes for via the sysfs files, where
64indexes 1, 2 are for "vin" and 3, 4 for "vout":
65
66**in[1-4]_crit**
67
68**in[1-4_crit_alarm**
69
70**in[1-4]_input**
71
72**in[1-4_label**
73
74**in[1-4]_lcrit**
75
76**in[1-41_lcrit_alarm**
77
78The driver provides for power: input and alarms. Power alarm is supported only
79for power input.
80The driver exports the following attributes for via the sysfs files, where
81indexes 1, 2 are for "pin" and 3, 4 for "pout":
82
83**power[1-2]_alarm**
84
85**power[1-4]_input**
86
87**power[1-4]_label**
88
89The driver provides for temperature: input, maximum and critical thresholds
90and maximum and critical alarms.
91The driver exports the following attributes for via the sysfs files:
92
93**temp[1-2]_crit**
94
95**temp[1-2]_crit_alarm**
96
97**temp[1-2]_input**
98
99**temp[1-2]_max**
100
101**temp[1-2]_max_alarm**