Merge remote-tracking branches 'asoc/topic/rockchip', 'asoc/topic/rt5514', 'asoc...
[sfrench/cifs-2.6.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-pm8994-regulators"
26                     "qcom,rpm-pma8084-regulators"
27
28 - vdd_s1-supply:
29 - vdd_s2-supply:
30 - vdd_s3-supply:
31 - vdd_s4-supply:
32 - vdd_s5-supply:
33 - vdd_s6-supply:
34 - vdd_s7-supply:
35 - vdd_s8-supply:
36         Usage: optional (pm8841 only)
37         Value type: <phandle>
38         Definition: reference to regulator supplying the input pin, as
39                     described in the data sheet
40
41 - vdd_s1-supply:
42 - vdd_s2-supply:
43 - vdd_s3-supply:
44 - vdd_s4-supply:
45 - vdd_l1_l2_l3-supply:
46 - vdd_l4_l5_l6-supply:
47 - vdd_l7-supply:
48 - vdd_l8_l9_l10_l11_l12_l13_l14_l15_l16_l17_l18-supply:
49         Usage: optional (pm8916 only)
50         Value type: <phandle>
51         Definition: reference to regulator supplying the input pin, as
52                     described in the data sheet
53
54 - vdd_s1-supply:
55 - vdd_s2-supply:
56 - vdd_s3-supply:
57 - vdd_l1_l3-supply:
58 - vdd_l2_lvs1_2_3-supply:
59 - vdd_l4_l11-supply:
60 - vdd_l5_l7-supply:
61 - vdd_l6_l12_l14_l15-supply:
62 - vdd_l8_l16_l18_l19-supply:
63 - vdd_l9_l10_l17_l22-supply:
64 - vdd_l13_l20_l23_l24-supply:
65 - vdd_l21-supply:
66 - vin_5vs-supply:
67         Usage: optional (pm8941 only)
68         Value type: <phandle>
69         Definition: reference to regulator supplying the input pin, as
70                     described in the data sheet
71
72 - vdd_s1-supply:
73 - vdd_s2-supply:
74 - vdd_s3-supply:
75 - vdd_s4-supply:
76 - vdd_s5-supply:
77 - vdd_s6-supply:
78 - vdd_s7-supply:
79 - vdd_s8-supply:
80 - vdd_s9-supply:
81 - vdd_s10-supply:
82 - vdd_s11-supply:
83 - vdd_s12-supply:
84 - vdd_l1-supply:
85 - vdd_l2_l26_l28-supply:
86 - vdd_l3_l11-supply:
87 - vdd_l4_l27_l31-supply:
88 - vdd_l5_l7-supply:
89 - vdd_l6_l12_l32-supply:
90 - vdd_l5_l7-supply:
91 - vdd_l8_l16_l30-supply:
92 - vdd_l9_l10_l18_l22-supply:
93 - vdd_l9_l10_l18_l22-supply:
94 - vdd_l3_l11-supply:
95 - vdd_l6_l12_l32-supply:
96 - vdd_l13_l19_l23_l24-supply:
97 - vdd_l14_l15-supply:
98 - vdd_l14_l15-supply:
99 - vdd_l8_l16_l30-supply:
100 - vdd_l17_l29-supply:
101 - vdd_l9_l10_l18_l22-supply:
102 - vdd_l13_l19_l23_l24-supply:
103 - vdd_l20_l21-supply:
104 - vdd_l20_l21-supply:
105 - vdd_l9_l10_l18_l22-supply:
106 - vdd_l13_l19_l23_l24-supply:
107 - vdd_l13_l19_l23_l24-supply:
108 - vdd_l25-supply:
109 - vdd_l2_l26_l28-supply:
110 - vdd_l4_l27_l31-supply:
111 - vdd_l2_l26_l28-supply:
112 - vdd_l17_l29-supply:
113 - vdd_l8_l16_l30-supply:
114 - vdd_l4_l27_l31-supply:
115 - vdd_l6_l12_l32-supply:
116 - vdd_lvs1_2-supply:
117         Usage: optional (pm8994 only)
118         Value type: <phandle>
119         Definition: reference to regulator supplying the input pin, as
120                     described in the data sheet
121
122 - vdd_s1-supply:
123 - vdd_s2-supply:
124 - vdd_s3-supply:
125 - vdd_s4-supply:
126 - vdd_s5-supply:
127 - vdd_s6-supply:
128 - vdd_s7-supply:
129 - vdd_s8-supply:
130 - vdd_s9-supply:
131 - vdd_s10-supply:
132 - vdd_s11-supply:
133 - vdd_s12-supply:
134 - vdd_l1_l11-supply:
135 - vdd_l2_l3_l4_l27-supply:
136 - vdd_l5_l7-supply:
137 - vdd_l6_l12_l14_l15_l26-supply:
138 - vdd_l8-supply:
139 - vdd_l9_l10_l13_l20_l23_l24-supply:
140 - vdd_l16_l25-supply:
141 - vdd_l17-supply:
142 - vdd_l18-supply:
143 - vdd_l19-supply:
144 - vdd_l21-supply:
145 - vdd_l22-supply:
146         Usage: optional (pma8084 only)
147         Value type: <phandle>
148         Definition: reference to regulator supplying the input pin, as
149                     described in the data sheet
150
151 The regulator node houses sub-nodes for each regulator within the device. Each
152 sub-node is identified using the node's name, with valid values listed for each
153 of the pmics below.
154
155 pm8841:
156         s1, s2, s3, s4, s5, s6, s7, s8
157
158 pm8916:
159         s1, s2, s3, s4, l1, l2, l3, l4, l5, l6, l7, l8, l9, l10, l11, l12, l13,
160         l14, l15, l16, l17, l18
161
162 pm8941:
163         s1, s2, s3, s4, l1, l2, l3, l4, l5, l6, l7, l8, l9, l10, l11, l12, l13,
164         l14, l15, l16, l17, l18, l19, l20, l21, l22, l23, l24, lvs1, lvs2,
165         lvs3, 5vs1, 5vs2
166
167 pm8994:
168         s1, s2, s3, s4, s5, s6, s7, s8, s9, s10, s11, s12, l1, l2, l3, l4, l5,
169         l6, l7, l8, l9, l10, l11, l12, l13, l14, l15, l16, l17, l18, l19, l20,
170         l21, l22, l23, l24, l25, l26, l27, l28, l29, l30, l31, l32, lvs1, lvs2
171
172 pma8084:
173         s1, s2, s3, s4, s5, s6, s7, s8, s9, s10, s11, s12, l1, l2, l3, l4, l5,
174         l6, l7, l8, l9, l10, l11, l12, l13, l14, l15, l16, l17, l18, l19, l20,
175         l21, l22, l23, l24, l25, l26, l27, lvs1, lvs2, lvs3, lvs4, 5vs1
176
177 The content of each sub-node is defined by the standard binding for regulators -
178 see regulator.txt.
179
180 = EXAMPLE
181
182         smd {
183                 compatible = "qcom,smd";
184
185                 rpm {
186                         interrupts = <0 168 1>;
187                         qcom,ipc = <&apcs 8 0>;
188                         qcom,smd-edge = <15>;
189
190                         rpm_requests {
191                                 compatible = "qcom,rpm-msm8974";
192                                 qcom,smd-channels = "rpm_requests";
193
194                                 pm8941-regulators {
195                                         compatible = "qcom,rpm-pm8941-regulators";
196                                         vdd_l13_l20_l23_l24-supply = <&pm8941_boost>;
197
198                                         pm8941_s3: s3 {
199                                                 regulator-min-microvolt = <1800000>;
200                                                 regulator-max-microvolt = <1800000>;
201                                         };
202
203                                         pm8941_boost: s4 {
204                                                 regulator-min-microvolt = <5000000>;
205                                                 regulator-max-microvolt = <5000000>;
206                                         };
207
208                                         pm8941_l20: l20 {
209                                                 regulator-min-microvolt = <2950000>;
210                                                 regulator-max-microvolt = <2950000>;
211                                         };
212                                 };
213                         };
214                 };
215         };