Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/dtor/input
[linux-2.6-microblaze.git] / Documentation / hwmon / mp2888.rst
1 .. SPDX-License-Identifier: GPL-2.0
2
3 Kernel driver mp2888
4 ====================
5
6 Supported chips:
7
8   * MPS MP12254
9
10     Prefix: 'mp2888'
11
12 Author:
13
14         Vadim Pasternak <vadimp@nvidia.com>
15
16 Description
17 -----------
18
19 This driver implements support for Monolithic Power Systems, Inc. (MPS)
20 vendor dual-loop, digital, multi-phase controller MP2888.
21
22 This device: supports:
23
24 - One power rail.
25 - Programmable Multi-Phase up to 10 Phases.
26 - PWM-VID Interface
27 - One pages 0 for telemetry.
28 - Programmable pins for PMBus Address.
29 - Built-In EEPROM to Store Custom Configurations.
30
31 Device complaint with:
32
33 - PMBus rev 1.3 interface.
34
35 Device supports direct format for reading output current, output voltage,
36 input and output power and temperature.
37 Device supports linear format for reading input voltage and input power.
38
39 The driver provides the next attributes for the current:
40
41 - for current out input and maximum alarm;
42 - for phase current: input and label.
43
44 The driver exports the following attributes via the 'sysfs' files, where:
45
46 - 'n' is number of configured phases (from 1 to 10);
47 - index 1 for "iout";
48 - indexes 2 ... 1 + n for phases.
49
50 **curr[1-{1+n}]_input**
51
52 **curr[1-{1+n}]_label**
53
54 **curr1_max**
55
56 **curr1_max_alarm**
57
58 The driver provides the next attributes for the voltage:
59
60 - for voltage in: input, low and high critical thresholds, low and high
61   critical alarms;
62 - for voltage out: input and high alarm;
63
64 The driver exports the following attributes via the 'sysfs' files, where
65
66 **in1_crit**
67
68 **in1_crit_alarm**
69
70 **in1_input**
71
72 **in1_label**
73
74 **in1_min**
75
76 **in1_min_alarm**
77
78 **in2_alarm**
79
80 **in2_input**
81
82 **in2_label**
83
84 The driver provides the next attributes for the power:
85
86 - for power in alarm and input.
87 - for power out: cap, cap alarm an input.
88
89 The driver exports the following attributes via the 'sysfs' files, where
90 - indexes 1 for "pin";
91 - indexes 2 for "pout";
92
93 **power1_alarm**
94
95 **power1_input**
96
97 **power1_label**
98
99 **power2_input**
100
101 **power2_label**
102
103 **power2_max**
104
105 **power2_max_alarm**
106
107 The driver provides the next attributes for the temperature:
108
109 **temp1_input**
110
111 **temp1_max**
112
113 **temp1_max_alarm**