1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
|
Qualcomm Technologies, Inc. RPMh Regulators
rpmh-regulator devices support PMIC regulator management via the VRM and XOB
RPMh accelerators. The APPS processor communicates with these hardware blocks
via an RSC using command packets. The VRM allows changing four parameters for a
given regulator: enable state, output voltage, operating mode, and minimum
headroom voltage. The XOB allows changing only a single parameter for a given
regulator: its enable state.
=======================
Required Node Structure
=======================
RPMh regulators must be described in two levels of device nodes. The first
level describes the PMIC containing the regulators and must reside within an
RPMh device node. The second level describes each regulator within the PMIC
which is to be used on the board. Each of these regulators maps to a single
RPMh resource.
The names used for regulator nodes must match those supported by a given PMIC.
Supported regulator node names:
PM8998: smps1 - smps13, ldo1 - ldo28, lvs1 - lvs2
PMI8998: bob
PM8005: smps1 - smps4
==================================
First Level Nodes - PMIC
==================================
- compatible
Usage: required
Value type: <string>
Definition: Must be one of: "qcom,pm8998-rpmh-regulators",
"qcom,pmi8998-rpmh-regulators" or
"qcom,pm8005-rpmh-regulators".
- qcom,pmic-id
Usage: required
Value type: <string>
Definition: RPMh resource name suffix used for the regulators found on
this PMIC. Typical values: "a", "b", "c", "d", "e", "f".
- vdd_s1-supply
- vdd_s2-supply
- vdd_s3-supply
- vdd_s4-supply
- vdd_s5-supply
- vdd_s6-supply
- vdd_s7-supply
- vdd_s8-supply
- vdd_s9-supply
- vdd_s10-supply
- vdd_s11-supply
- vdd_s12-supply
- vdd_s13-supply
- vdd_l1_l27-supply
- vdd_l2_l8_l17-supply
- vdd_l3_l11-supply
- vdd_l4_l5-supply
- vdd_l6-supply
- vdd_l7_l12_l14_l15-supply
- vdd_l9-supply
- vdd_l10_l23_l25-supply
- vdd_l13_l19_l21-supply
- vdd_l16_l28-supply
- vdd_l18_l22-supply
- vdd_l20_l24-supply
- vdd_l26-supply
- vdd_lvs1_lvs2-supply
- vdd_lvs1_lvs2-supply
Usage: optional (PM8998 only)
Value type: <phandle>
Definition: phandle of the parent supply regulator of one or more of the
regulators for this PMIC.
- vdd_bob-supply
Usage: optional (PMI8998 only)
Value type: <phandle>
Definition: phandle of the parent supply regulator of one or more of the
regulators for this PMIC.
- vdd_s1-supply
- vdd_s2-supply
- vdd_s3-supply
- vdd_s4-supply
Usage: optional (PM8005 only)
Value type: <phandle>
Definition: phandle of the parent supply regulator of one or more of the
regulators for this PMIC.
=========================================
Second Level Nodes - Regulators
=========================================
- regulator-name
Usage: optional
Value type: <string>
Definition: Specifies the name for this RPMh regulator. If not
specified, then the regulator's name is equal to its subnode
name.
- regulator-min-microvolt
Usage: required
Value type: <u32>
Definition: For VRM resources, this is the minimum supported voltage in
microvolts. For XOB resources, this is the fixed output
voltage.
- regulator-max-microvolt
Usage: required
Value type: <u32>
Definition: For VRM resources, this is the maximum supported voltage in
microvolts. For XOB resources, this is the fixed output
voltage.
- qcom,regulator-initial-voltage
Usage: optional; VRM regulators only
Value type: <u32>
Definition: Specifies the initial voltage in microvolts to request for a
VRM regulator. Supported values are 0 to 8191000.
- regulator-initial-mode
Usage: optional; VRM regulators only
Value type: <u32>
Definition: Specifies the initial mode to request for a VRM regulator.
Supported values are RPMH_REGULATOR_MODE_* which are defined
in [1] (i.e. 0 to 4).
- regulator-allow-set-load
Usage: optional
Value type: <empty>
Definition: Boolean flag indicating that the the mode of this regulator
may be configured at runtime based upon consumer load needs.
- qcom,allowed-modes
Usage: required if regulator-allow-set-load is specified;
VRM regulators only
Value type: <prop-encoded-array>
Definition: A list of integers specifying the PMIC regulator modes which
can be configured at runtime based upon consumer load needs.
Supported values are RPMH_REGULATOR_MODE_* which are defined
in [1] (i.e. 0 to 4). Elements must be specified in order
from lowest to highest value.
- qcom,mode-threshold-currents
Usage: required if regulator-allow-set-load is specified;
VRM regulators only
Value type: <prop-encoded-array>
Definition: A list of integers specifying the minimum allowed load
current in microamps for each of the modes listed in
qcom,allowed-modes. The first element should always be 0.
Elements must be specified in order from lowest to highest
value.
- qcom,headroom-voltage
Usage: optional; VRM regulators only
Value type: <u32>
Definition: Specifies the headroom voltage in microvolts to request for
a VRM regulator. RPMh hardware automatically ensures that
the parent of this regulator outputs a voltage high enough
to satisfy the requested headroom. Supported values are
0 to 511000.
- regulator-enable-ramp-delay
Usage: optional
Value type: <u32>
Definition: The time in microseconds to delay after enabling a
regulator. Note that RPMh hardware ensures that regulator
output has stabilized before acknowledging a given regulator
enable request.
- qcom,rpmh-resource-type
Usage: optional
Value type: <string>
Definition: RPMh accelerator type for this regulator. If not specified,
then the default type associated with this regulator will be
used. Supported values: "vrm" or "xob".
- qcom,always-wait-for-ack
Usage: optional
Value type: <empty>
Definition: Boolean flag which indicates that the application processor
must wait for an ACK or a NACK from RPMh for every request
sent for this regulator including those which are for a
strictly lower power state.
Other properties defined in regulator.txt may also be used.
[1] include/dt-bindings/regulator/qcom,rpmh-regulator.h
========
Examples
========
#include <dt-bindings/regulator/qcom,rpmh-regulator.h>
&apps_rsc {
pm8998-rpmh-regulators {
compatible = "qcom,pm8998-rpmh-regulators";
qcom,pmic-id = "a";
vdd_l7_l12_l14_l15-supply = <&pm8998_s5>;
smps2 {
regulator-min-microvolt = <1100000>;
regulator-max-microvolt = <1100000>;
qcom,regulator-initial-voltage = <1100000>;
};
pm8998_s5: smps5 {
regulator-min-microvolt = <1904000>;
regulator-max-microvolt = <2040000>;
qcom,regulator-initial-voltage = <1904000>;
};
ldo7 {
regulator-min-microvolt = <1800000>;
regulator-max-microvolt = <1800000>;
qcom,regulator-initial-voltage = <1800000>;
qcom,headroom-voltage = <56000>;
regulator-initial-mode = <RPMH_REGULATOR_MODE_LPM>;
regulator-allow-set-load;
qcom,allowed-modes =
<RPMH_REGULATOR_MODE_LPM
RPMH_REGULATOR_MODE_HPM>;
qcom,mode-threshold-currents = <0 10000>;
};
lvs1 {
regulator-min-microvolt = <1800000>;
regulator-max-microvolt = <1800000>;
};
};
pmi8998-rpmh-regulators {
compatible = "qcom,pmi8998-rpmh-regulators";
qcom,pmic-id = "b";
bob {
regulator-min-microvolt = <3312000>;
regulator-max-microvolt = <3600000>;
qcom,regulator-initial-voltage = <3312000>;
regulator-initial-mode = <RPMH_REGULATOR_MODE_PASS>;
};
};
};
|
