]> asedeno.scripts.mit.edu Git - linux.git/blob - Documentation/devicetree/bindings/regulator/qcom,smd-rpm-regulator.txt
Linux 5.6-rc7
[linux.git] / Documentation / devicetree / bindings / regulator / qcom,smd-rpm-regulator.txt
1 QCOM SMD RPM REGULATOR
2
3 The Qualcomm RPM over SMD regulator is modelled as a subdevice of the RPM.
4 Because SMD is used as the communication transport mechanism, the RPM resides as
5 a subnode of the SMD.  As such, the SMD-RPM regulator requires that the SMD and
6 RPM nodes be present.
7
8 Please refer to Documentation/devicetree/bindings/soc/qcom/qcom,smd.txt for
9 information pertaining to the SMD node.
10
11 Please refer to Documentation/devicetree/bindings/soc/qcom/qcom,smd-rpm.txt for
12 information regarding the RPM node.
13
14 == Regulator
15
16 Regulator nodes are identified by their compatible:
17
18 - compatible:
19         Usage: required
20         Value type: <string>
21         Definition: must be one of:
22                     "qcom,rpm-pm8841-regulators"
23                     "qcom,rpm-pm8916-regulators"
24                     "qcom,rpm-pm8941-regulators"
25                     "qcom,rpm-pm8950-regulators"
26                     "qcom,rpm-pm8994-regulators"
27                     "qcom,rpm-pm8998-regulators"
28                     "qcom,rpm-pma8084-regulators"
29                     "qcom,rpm-pmi8998-regulators"
30                     "qcom,rpm-pms405-regulators"
31
32 - vdd_s1-supply:
33 - vdd_s2-supply:
34 - vdd_s3-supply:
35 - vdd_s4-supply:
36 - vdd_s5-supply:
37 - vdd_s6-supply:
38 - vdd_s7-supply:
39 - vdd_s8-supply:
40         Usage: optional (pm8841 only)
41         Value type: <phandle>
42         Definition: reference to regulator supplying the input pin, as
43                     described in the data sheet
44
45 - vdd_s1-supply:
46 - vdd_s2-supply:
47 - vdd_s3-supply:
48 - vdd_s4-supply:
49 - vdd_l1_l2_l3-supply:
50 - vdd_l4_l5_l6-supply:
51 - vdd_l7-supply:
52 - vdd_l8_l9_l10_l11_l12_l13_l14_l15_l16_l17_l18-supply:
53         Usage: optional (pm8916 only)
54         Value type: <phandle>
55         Definition: reference to regulator supplying the input pin, as
56                     described in the data sheet
57
58 - vdd_s1-supply:
59 - vdd_s2-supply:
60 - vdd_s3-supply:
61 - vdd_s4-supply:
62 - vdd_s4-supply:
63 - vdd_s5-supply:
64 - vdd_s6-supply:
65 - vdd_l1_l19-supply:
66 - vdd_l2_l23-supply:
67 - vdd_l3-supply:
68 - vdd_l4_l5_l6_l7_l16-supply:
69 - vdd_l8_l11_l12_l17_l22-supply:
70 - vdd_l9_l10_l13_l14_l15_l18-supply:
71 - vdd_l20-supply:
72 - vdd_l21-supply:
73         Usage: optional (pm8950 only)
74         Value type: <phandle>
75         Definition: reference to regulator supplying the input pin, as
76                     described in the data sheet
77
78 - vdd_s1-supply:
79 - vdd_s2-supply:
80 - vdd_s3-supply:
81 - vdd_l1_l3-supply:
82 - vdd_l2_lvs1_2_3-supply:
83 - vdd_l4_l11-supply:
84 - vdd_l5_l7-supply:
85 - vdd_l6_l12_l14_l15-supply:
86 - vdd_l8_l16_l18_l19-supply:
87 - vdd_l9_l10_l17_l22-supply:
88 - vdd_l13_l20_l23_l24-supply:
89 - vdd_l21-supply:
90 - vin_5vs-supply:
91         Usage: optional (pm8941 only)
92         Value type: <phandle>
93         Definition: reference to regulator supplying the input pin, as
94                     described in the data sheet
95
96 - vdd_s1-supply:
97 - vdd_s2-supply:
98 - vdd_s3-supply:
99 - vdd_s4-supply:
100 - vdd_s5-supply:
101 - vdd_s6-supply:
102 - vdd_s7-supply:
103 - vdd_s8-supply:
104 - vdd_s9-supply:
105 - vdd_s10-supply:
106 - vdd_s11-supply:
107 - vdd_s12-supply:
108 - vdd_l1-supply:
109 - vdd_l2_l26_l28-supply:
110 - vdd_l3_l11-supply:
111 - vdd_l4_l27_l31-supply:
112 - vdd_l5_l7-supply:
113 - vdd_l6_l12_l32-supply:
114 - vdd_l5_l7-supply:
115 - vdd_l8_l16_l30-supply:
116 - vdd_l9_l10_l18_l22-supply:
117 - vdd_l9_l10_l18_l22-supply:
118 - vdd_l3_l11-supply:
119 - vdd_l6_l12_l32-supply:
120 - vdd_l13_l19_l23_l24-supply:
121 - vdd_l14_l15-supply:
122 - vdd_l14_l15-supply:
123 - vdd_l8_l16_l30-supply:
124 - vdd_l17_l29-supply:
125 - vdd_l9_l10_l18_l22-supply:
126 - vdd_l13_l19_l23_l24-supply:
127 - vdd_l20_l21-supply:
128 - vdd_l20_l21-supply:
129 - vdd_l9_l10_l18_l22-supply:
130 - vdd_l13_l19_l23_l24-supply:
131 - vdd_l13_l19_l23_l24-supply:
132 - vdd_l25-supply:
133 - vdd_l2_l26_l28-supply:
134 - vdd_l4_l27_l31-supply:
135 - vdd_l2_l26_l28-supply:
136 - vdd_l17_l29-supply:
137 - vdd_l8_l16_l30-supply:
138 - vdd_l4_l27_l31-supply:
139 - vdd_l6_l12_l32-supply:
140 - vdd_lvs1_2-supply:
141         Usage: optional (pm8994 only)
142         Value type: <phandle>
143         Definition: reference to regulator supplying the input pin, as
144                     described in the data sheet
145
146 - vdd_s1-supply:
147 - vdd_s2-supply:
148 - vdd_s3-supply:
149 - vdd_s4-supply:
150 - vdd_s5-supply:
151 - vdd_s6-supply:
152 - vdd_s7-supply:
153 - vdd_s8-supply:
154 - vdd_s9-supply:
155 - vdd_s10-supply:
156 - vdd_s11-supply:
157 - vdd_s12-supply:
158 - vdd_s13-supply:
159 - vdd_l1_l27-supply:
160 - vdd_l20_l24-supply:
161 - vdd_l26-supply:
162 - vdd_l2_l8_l17-supply:
163 - vdd_l3_l11-supply:
164 - vdd_l4_l5-supply:
165 - vdd_l6-supply:
166 - vdd_l7_l12_l14_l15-supply:
167 - vdd_l9-supply:
168 - vdd_l10_l23_l25-supply:
169 - vdd_l13_l19_l21-supply:
170 - vdd_l16_l28-supply:
171 - vdd_l18_l22-supply:
172 - vdd_lvs1_lvs2-supply:
173         Usage: optional (pmi8998 only)
174         Value type: <phandle>
175         Definition: reference to regulator supplying the input pin, as
176                     described in the data sheet
177
178 - vdd_s1-supply:
179 - vdd_s2-supply:
180 - vdd_s3-supply:
181 - vdd_s4-supply:
182 - vdd_s5-supply:
183 - vdd_s6-supply:
184 - vdd_s7-supply:
185 - vdd_s8-supply:
186 - vdd_s9-supply:
187 - vdd_s10-supply:
188 - vdd_s11-supply:
189 - vdd_s12-supply:
190 - vdd_l1_l11-supply:
191 - vdd_l2_l3_l4_l27-supply:
192 - vdd_l5_l7-supply:
193 - vdd_l6_l12_l14_l15_l26-supply:
194 - vdd_l8-supply:
195 - vdd_l9_l10_l13_l20_l23_l24-supply:
196 - vdd_l16_l25-supply:
197 - vdd_l17-supply:
198 - vdd_l18-supply:
199 - vdd_l19-supply:
200 - vdd_l21-supply:
201 - vdd_l22-supply:
202         Usage: optional (pma8084 only)
203         Value type: <phandle>
204         Definition: reference to regulator supplying the input pin, as
205                     described in the data sheet
206
207 - vdd_bob-supply:
208         Usage: optional (pmi8998 only)
209         Value type: <phandle>
210         Definition: reference to regulator supplying the input pin, as
211                     described in the data sheet
212
213 - vdd_s1-supply:
214 - vdd_s2-supply:
215 - vdd_s3-supply:
216 - vdd_s4-supply:
217 - vdd_s5-supply:
218 - vdd_l1_l2-supply:
219 - vdd_l3_l8-supply:
220 - vdd_l4-supply:
221 - vdd_l5_l6-supply:
222 - vdd_l7-supply:
223 - vdd_l3_l8-supply:
224 - vdd_l9-supply:
225 - vdd_l10_l11_l12_l13-supply:
226         Usage: optional (pms405 only)
227         Value type: <phandle>
228         Definition: reference to regulator supplying the input pin, as
229                     described in the data sheet
230
231 The regulator node houses sub-nodes for each regulator within the device. Each
232 sub-node is identified using the node's name, with valid values listed for each
233 of the pmics below.
234
235 pm8841:
236         s1, s2, s3, s4, s5, s6, s7, s8
237
238 pm8916:
239         s1, s2, s3, s4, l1, l2, l3, l4, l5, l6, l7, l8, l9, l10, l11, l12, l13,
240         l14, l15, l16, l17, l18
241
242 pm8941:
243         s1, s2, s3, s4, l1, l2, l3, l4, l5, l6, l7, l8, l9, l10, l11, l12, l13,
244         l14, l15, l16, l17, l18, l19, l20, l21, l22, l23, l24, lvs1, lvs2,
245         lvs3, 5vs1, 5vs2
246
247 pm8994:
248         s1, s2, s3, s4, s5, s6, s7, s8, s9, s10, s11, s12, l1, l2, l3, l4, l5,
249         l6, l7, l8, l9, l10, l11, l12, l13, l14, l15, l16, l17, l18, l19, l20,
250         l21, l22, l23, l24, l25, l26, l27, l28, l29, l30, l31, l32, lvs1, lvs2
251
252 pm8998:
253         s1, s2, s3, s4, s5, s6, s7, s8, s9, s10, s11, s12, s13, l1, l2, l3, l4,
254         l5, l6, l7, l8, l9, l10, l11, l12, l13, l14, l15, l16, l17, l18, l19,
255         l20, l21, l22, l23, l24, l25, l26, l27, l28, lvs1, lvs2
256
257 pma8084:
258         s1, s2, s3, s4, s5, s6, s7, s8, s9, s10, s11, s12, l1, l2, l3, l4, l5,
259         l6, l7, l8, l9, l10, l11, l12, l13, l14, l15, l16, l17, l18, l19, l20,
260         l21, l22, l23, l24, l25, l26, l27, lvs1, lvs2, lvs3, lvs4, 5vs1
261
262 pmi8998:
263         bob
264
265 pms405:
266         s1, s2, s3, s4, s5, l1, l2, l3, l4, l5, l6, l7, l8, l9, l10, l11, l12,
267         l13
268
269 The content of each sub-node is defined by the standard binding for regulators -
270 see regulator.txt.
271
272 = EXAMPLE
273
274         smd {
275                 compatible = "qcom,smd";
276
277                 rpm {
278                         interrupts = <0 168 1>;
279                         qcom,ipc = <&apcs 8 0>;
280                         qcom,smd-edge = <15>;
281
282                         rpm_requests {
283                                 compatible = "qcom,rpm-msm8974";
284                                 qcom,smd-channels = "rpm_requests";
285
286                                 pm8941-regulators {
287                                         compatible = "qcom,rpm-pm8941-regulators";
288                                         vdd_l13_l20_l23_l24-supply = <&pm8941_boost>;
289
290                                         pm8941_s3: s3 {
291                                                 regulator-min-microvolt = <1800000>;
292                                                 regulator-max-microvolt = <1800000>;
293                                         };
294
295                                         pm8941_boost: s4 {
296                                                 regulator-min-microvolt = <5000000>;
297                                                 regulator-max-microvolt = <5000000>;
298                                         };
299
300                                         pm8941_l20: l20 {
301                                                 regulator-min-microvolt = <2950000>;
302                                                 regulator-max-microvolt = <2950000>;
303                                         };
304                                 };
305                         };
306                 };
307         };