]> git.karo-electronics.de Git - karo-tx-linux.git/blob - Documentation/devicetree/bindings/soc/qcom,smd-rpm.txt
regulator: qcom-smd: Add support for PMA8084
[karo-tx-linux.git] / Documentation / devicetree / bindings / soc / qcom,smd-rpm.txt
1 Qualcomm Resource Power Manager (RPM) over SMD
2
3 This driver is used to interface with the Resource Power Manager (RPM) found in
4 various Qualcomm platforms. The RPM allows each component in the system to vote
5 for state of the system resources, such as clocks, regulators and bus
6 frequencies.
7
8 - compatible:
9         Usage: required
10         Value type: <string>
11         Definition: must be one of:
12                     "qcom,rpm-msm8974"
13
14 - qcom,smd-channels:
15         Usage: required
16         Value type: <stringlist>
17         Definition: Shared Memory channel used for communication with the RPM
18
19 = SUBDEVICES
20
21 The RPM exposes resources to its subnodes. The below bindings specify the set
22 of valid subnodes that can operate on these resources.
23
24 == Regulators
25
26 Regulator nodes are identified by their compatible:
27
28 - compatible:
29         Usage: required
30         Value type: <string>
31         Definition: must be one of:
32                     "qcom,rpm-pm8841-regulators"
33                     "qcom,rpm-pm8916-regulators"
34                     "qcom,rpm-pm8941-regulators"
35                     "qcom,rpm-pma8084-regulators"
36
37 - vdd_s1-supply:
38 - vdd_s2-supply:
39 - vdd_s3-supply:
40 - vdd_s4-supply:
41 - vdd_s5-supply:
42 - vdd_s6-supply:
43 - vdd_s7-supply:
44 - vdd_s8-supply:
45         Usage: optional (pm8841 only)
46         Value type: <phandle>
47         Definition: reference to regulator supplying the input pin, as
48                     described in the data sheet
49
50 - vdd_s1-supply:
51 - vdd_s2-supply:
52 - vdd_s3-supply:
53 - vdd_s4-supply:
54 - vdd_l1_l2_l3-supply:
55 - vdd_l4_l5_l6-supply:
56 - vdd_l7-supply:
57 - vdd_l8_l9_l10_l11_l12_l13_l14_l15_l16_l17_l18-supply:
58         Usage: optional (pm8916 only)
59         Value type: <phandle>
60         Definition: reference to regulator supplying the input pin, as
61                     described in the data sheet
62
63 - vdd_s1-supply:
64 - vdd_s2-supply:
65 - vdd_s3-supply:
66 - vdd_l1_l3-supply:
67 - vdd_l2_lvs1_2_3-supply:
68 - vdd_l4_l11-supply:
69 - vdd_l5_l7-supply:
70 - vdd_l6_l12_l14_l15-supply:
71 - vdd_l8_l16_l18_l19-supply:
72 - vdd_l9_l10_l17_l22-supply:
73 - vdd_l13_l20_l23_l24-supply:
74 - vdd_l21-supply:
75 - vin_5vs-supply:
76         Usage: optional (pm8941 only)
77         Value type: <phandle>
78         Definition: reference to regulator supplying the input pin, as
79                     described in the data sheet
80
81 - vdd_s1-supply:
82 - vdd_s2-supply:
83 - vdd_s3-supply:
84 - vdd_s4-supply:
85 - vdd_s5-supply:
86 - vdd_s6-supply:
87 - vdd_s7-supply:
88 - vdd_s8-supply:
89 - vdd_s9-supply:
90 - vdd_s10-supply:
91 - vdd_s11-supply:
92 - vdd_s12-supply:
93 - vdd_l1_l11-supply:
94 - vdd_l2_l3_l4_l27-supply:
95 - vdd_l5_l7-supply:
96 - vdd_l6_l12_l14_l15_l26-supply:
97 - vdd_l8-supply:
98 - vdd_l9_l10_l13_l20_l23_l24-supply:
99 - vdd_l16_l25-supply:
100 - vdd_l17-supply:
101 - vdd_l18-supply:
102 - vdd_l19-supply:
103 - vdd_l21-supply:
104 - vdd_l22-supply:
105         Usage: optional (pma8084 only)
106         Value type: <phandle>
107         Definition: reference to regulator supplying the input pin, as
108                     described in the data sheet
109
110 The regulator node houses sub-nodes for each regulator within the device. Each
111 sub-node is identified using the node's name, with valid values listed for each
112 of the pmics below.
113
114 pm8841:
115         s1, s2, s3, s4, s5, s6, s7, s8
116
117 pm8916:
118         s1, s2, s3, s4, l1, l2, l3, l4, l5, l6, l7, l8, l9, l10, l11, l12, l13,
119         l14, l15, l16, l17, l18
120
121 pm8941:
122         s1, s2, s3, s4, l1, l2, l3, l4, l5, l6, l7, l8, l9, l10, l11, l12, l13,
123         l14, l15, l16, l17, l18, l19, l20, l21, l22, l23, l24, lvs1, lvs2,
124         lvs3, 5vs1, 5vs2
125
126 pma8084:
127         s1, s2, s3, s4, s5, s6, s7, s8, s9, s10, s11, s12, l1, l2, l3, l4, l5,
128         l6, l7, l8, l9, l10, l11, l12, l13, l14, l15, l16, l17, l18, l19, l20,
129         l21, l22, l23, l24, l25, l26, l27, lvs1, lvs2, lvs3, lvs4, 5vs1
130
131 The content of each sub-node is defined by the standard binding for regulators -
132 see regulator.txt.
133
134 = EXAMPLE
135
136         smd {
137                 compatible = "qcom,smd";
138
139                 rpm {
140                         interrupts = <0 168 1>;
141                         qcom,ipc = <&apcs 8 0>;
142                         qcom,smd-edge = <15>;
143
144                         rpm_requests {
145                                 compatible = "qcom,rpm-msm8974";
146                                 qcom,smd-channels = "rpm_requests";
147
148                                 pm8941-regulators {
149                                         compatible = "qcom,rpm-pm8941-regulators";
150                                         vdd_l13_l20_l23_l24-supply = <&pm8941_boost>;
151
152                                         pm8941_s3: s3 {
153                                                 regulator-min-microvolt = <1800000>;
154                                                 regulator-max-microvolt = <1800000>;
155                                         };
156
157                                         pm8941_boost: s4 {
158                                                 regulator-min-microvolt = <5000000>;
159                                                 regulator-max-microvolt = <5000000>;
160                                         };
161
162                                         pm8941_l20: l20 {
163                                                 regulator-min-microvolt = <2950000>;
164                                                 regulator-max-microvolt = <2950000>;
165                                         };
166                                 };
167                         };
168                 };
169         };
170