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