GNU Linux-libre 6.1.90-gnu
[releases.git] / Documentation / devicetree / bindings / power / qcom,rpmpd.yaml
1 # SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
2 %YAML 1.2
3 ---
4 $id: http://devicetree.org/schemas/power/qcom,rpmpd.yaml#
5 $schema: http://devicetree.org/meta-schemas/core.yaml#
6
7 title: Qualcomm RPM/RPMh Power domains
8
9 maintainers:
10   - Bjorn Andersson <andersson@kernel.org>
11
12 description:
13   For RPM/RPMh Power domains, we communicate a performance state to RPM/RPMh
14   which then translates it into a corresponding voltage on a rail.
15
16 properties:
17   compatible:
18     enum:
19       - qcom,mdm9607-rpmpd
20       - qcom,msm8226-rpmpd
21       - qcom,msm8909-rpmpd
22       - qcom,msm8916-rpmpd
23       - qcom,msm8939-rpmpd
24       - qcom,msm8953-rpmpd
25       - qcom,msm8976-rpmpd
26       - qcom,msm8994-rpmpd
27       - qcom,msm8996-rpmpd
28       - qcom,msm8998-rpmpd
29       - qcom,qcm2290-rpmpd
30       - qcom,qcs404-rpmpd
31       - qcom,sa8540p-rpmhpd
32       - qcom,sdm660-rpmpd
33       - qcom,sc7180-rpmhpd
34       - qcom,sc7280-rpmhpd
35       - qcom,sc8180x-rpmhpd
36       - qcom,sc8280xp-rpmhpd
37       - qcom,sdm845-rpmhpd
38       - qcom,sdx55-rpmhpd
39       - qcom,sdx65-rpmhpd
40       - qcom,sm6115-rpmpd
41       - qcom,sm6125-rpmpd
42       - qcom,sm6350-rpmhpd
43       - qcom,sm6375-rpmpd
44       - qcom,sm8150-rpmhpd
45       - qcom,sm8250-rpmhpd
46       - qcom,sm8350-rpmhpd
47       - qcom,sm8450-rpmhpd
48
49   '#power-domain-cells':
50     const: 1
51
52   operating-points-v2: true
53
54   opp-table:
55     type: object
56
57 required:
58   - compatible
59   - '#power-domain-cells'
60   - operating-points-v2
61
62 additionalProperties: false
63
64 examples:
65   - |
66
67     // Example 1 (rpmh power domain controller and OPP table):
68
69     #include <dt-bindings/power/qcom-rpmpd.h>
70
71     rpmhpd: power-controller {
72       compatible = "qcom,sdm845-rpmhpd";
73       #power-domain-cells = <1>;
74       operating-points-v2 = <&rpmhpd_opp_table>;
75
76       rpmhpd_opp_table: opp-table {
77         compatible = "operating-points-v2";
78
79         rpmhpd_opp_ret: opp1 {
80           opp-level = <RPMH_REGULATOR_LEVEL_RETENTION>;
81         };
82
83         rpmhpd_opp_min_svs: opp2 {
84           opp-level = <RPMH_REGULATOR_LEVEL_MIN_SVS>;
85         };
86
87         rpmhpd_opp_low_svs: opp3 {
88           opp-level = <RPMH_REGULATOR_LEVEL_LOW_SVS>;
89         };
90
91         rpmhpd_opp_svs: opp4 {
92           opp-level = <RPMH_REGULATOR_LEVEL_SVS>;
93         };
94
95         rpmhpd_opp_svs_l1: opp5 {
96           opp-level = <RPMH_REGULATOR_LEVEL_SVS_L1>;
97         };
98
99         rpmhpd_opp_nom: opp6 {
100           opp-level = <RPMH_REGULATOR_LEVEL_NOM>;
101         };
102
103         rpmhpd_opp_nom_l1: opp7 {
104           opp-level = <RPMH_REGULATOR_LEVEL_NOM_L1>;
105         };
106
107         rpmhpd_opp_nom_l2: opp8 {
108           opp-level = <RPMH_REGULATOR_LEVEL_NOM_L2>;
109         };
110
111         rpmhpd_opp_turbo: opp9 {
112           opp-level = <RPMH_REGULATOR_LEVEL_TURBO>;
113         };
114
115         rpmhpd_opp_turbo_l1: opp10 {
116           opp-level = <RPMH_REGULATOR_LEVEL_TURBO_L1>;
117         };
118       };
119     };
120
121   - |
122
123     // Example 2 (rpm power domain controller and OPP table):
124
125     rpmpd: power-controller {
126       compatible = "qcom,msm8996-rpmpd";
127       #power-domain-cells = <1>;
128       operating-points-v2 = <&rpmpd_opp_table>;
129
130       rpmpd_opp_table: opp-table {
131         compatible = "operating-points-v2";
132
133         rpmpd_opp_low: opp1 {
134           opp-level = <1>;
135         };
136
137         rpmpd_opp_ret: opp2 {
138           opp-level = <2>;
139         };
140
141         rpmpd_opp_svs: opp3 {
142           opp-level = <3>;
143         };
144
145         rpmpd_opp_normal: opp4 {
146           opp-level = <4>;
147         };
148
149         rpmpd_opp_high: opp5 {
150           opp-level = <5>;
151         };
152
153         rpmpd_opp_turbo: opp6 {
154           opp-level = <6>;
155         };
156       };
157     };
158
159   - |
160
161     // Example 3 (Client/Consumer device using OPP table):
162
163     leaky-device0@12350000 {
164       compatible = "foo,i-leak-current";
165       reg = <0x12350000 0x1000>;
166       power-domains = <&rpmhpd 0>;
167       operating-points-v2 = <&leaky_opp_table>;
168     };
169
170     leaky_opp_table: opp-table {
171       compatible = "operating-points-v2";
172       opp1 {
173         opp-hz = /bits/ 64 <144000>;
174         required-opps = <&rpmhpd_opp_low>;
175       };
176
177       opp2 {
178         opp-hz = /bits/ 64 <400000>;
179         required-opps = <&rpmhpd_opp_ret>;
180       };
181
182       opp3 {
183         opp-hz = /bits/ 64 <20000000>;
184         required-opps = <&rpmpd_opp_svs>;
185       };
186
187       opp4 {
188         opp-hz = /bits/ 64 <25000000>;
189         required-opps = <&rpmpd_opp_normal>;
190       };
191     };
192 ...