xref: /freebsd/sys/contrib/device-tree/Bindings/power/qcom,rpmpd.yaml (revision 43a5ec4eb41567cc92586503212743d89686d78f) 
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
7title: Qualcomm RPM/RPMh Power domains
8
9maintainers:
10  - Rajendra Nayak <rnayak@codeaurora.org>
11
12description:
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
16properties:
17  compatible:
18    enum:
19      - qcom,msm8916-rpmpd
20      - qcom,msm8939-rpmpd
21      - qcom,msm8976-rpmpd
22      - qcom,msm8994-rpmpd
23      - qcom,msm8996-rpmpd
24      - qcom,msm8998-rpmpd
25      - qcom,qcs404-rpmpd
26      - qcom,sdm660-rpmpd
27      - qcom,sc7180-rpmhpd
28      - qcom,sc7280-rpmhpd
29      - qcom,sdm845-rpmhpd
30      - qcom,sdx55-rpmhpd
31      - qcom,sm8150-rpmhpd
32      - qcom,sm8250-rpmhpd
33      - qcom,sm8350-rpmhpd
34
35  '#power-domain-cells':
36    const: 1
37
38  operating-points-v2: true
39
40  opp-table:
41    type: object
42
43required:
44  - compatible
45  - '#power-domain-cells'
46  - operating-points-v2
47
48additionalProperties: false
49
50examples:
51  - |
52
53    // Example 1 (rpmh power domain controller and OPP table):
54
55    #include <dt-bindings/power/qcom-rpmpd.h>
56
57    rpmhpd: power-controller {
58      compatible = "qcom,sdm845-rpmhpd";
59      #power-domain-cells = <1>;
60      operating-points-v2 = <&rpmhpd_opp_table>;
61
62      rpmhpd_opp_table: opp-table {
63        compatible = "operating-points-v2";
64
65        rpmhpd_opp_ret: opp1 {
66          opp-level = <RPMH_REGULATOR_LEVEL_RETENTION>;
67        };
68
69        rpmhpd_opp_min_svs: opp2 {
70          opp-level = <RPMH_REGULATOR_LEVEL_MIN_SVS>;
71        };
72
73        rpmhpd_opp_low_svs: opp3 {
74          opp-level = <RPMH_REGULATOR_LEVEL_LOW_SVS>;
75        };
76
77        rpmhpd_opp_svs: opp4 {
78          opp-level = <RPMH_REGULATOR_LEVEL_SVS>;
79        };
80
81        rpmhpd_opp_svs_l1: opp5 {
82          opp-level = <RPMH_REGULATOR_LEVEL_SVS_L1>;
83        };
84
85        rpmhpd_opp_nom: opp6 {
86          opp-level = <RPMH_REGULATOR_LEVEL_NOM>;
87        };
88
89        rpmhpd_opp_nom_l1: opp7 {
90          opp-level = <RPMH_REGULATOR_LEVEL_NOM_L1>;
91        };
92
93        rpmhpd_opp_nom_l2: opp8 {
94          opp-level = <RPMH_REGULATOR_LEVEL_NOM_L2>;
95        };
96
97        rpmhpd_opp_turbo: opp9 {
98          opp-level = <RPMH_REGULATOR_LEVEL_TURBO>;
99        };
100
101        rpmhpd_opp_turbo_l1: opp10 {
102          opp-level = <RPMH_REGULATOR_LEVEL_TURBO_L1>;
103        };
104      };
105    };
106
107  - |
108
109    // Example 2 (rpm power domain controller and OPP table):
110
111    rpmpd: power-controller {
112      compatible = "qcom,msm8996-rpmpd";
113      #power-domain-cells = <1>;
114      operating-points-v2 = <&rpmpd_opp_table>;
115
116      rpmpd_opp_table: opp-table {
117        compatible = "operating-points-v2";
118
119        rpmpd_opp_low: opp1 {
120          opp-level = <1>;
121        };
122
123        rpmpd_opp_ret: opp2 {
124          opp-level = <2>;
125        };
126
127        rpmpd_opp_svs: opp3 {
128          opp-level = <3>;
129        };
130
131        rpmpd_opp_normal: opp4 {
132          opp-level = <4>;
133        };
134
135        rpmpd_opp_high: opp5 {
136          opp-level = <5>;
137        };
138
139        rpmpd_opp_turbo: opp6 {
140          opp-level = <6>;
141        };
142      };
143    };
144
145  - |
146
147    // Example 3 (Client/Consumer device using OPP table):
148
149    leaky-device0@12350000 {
150      compatible = "foo,i-leak-current";
151      reg = <0x12350000 0x1000>;
152      power-domains = <&rpmhpd 0>;
153      operating-points-v2 = <&leaky_opp_table>;
154    };
155
156    leaky_opp_table: opp-table {
157      compatible = "operating-points-v2";
158      opp1 {
159        opp-hz = /bits/ 64 <144000>;
160        required-opps = <&rpmhpd_opp_low>;
161      };
162
163      opp2 {
164        opp-hz = /bits/ 64 <400000>;
165        required-opps = <&rpmhpd_opp_ret>;
166      };
167
168      opp3 {
169        opp-hz = /bits/ 64 <20000000>;
170        required-opps = <&rpmpd_opp_svs>;
171      };
172
173      opp4 {
174        opp-hz = /bits/ 64 <25000000>;
175        required-opps = <&rpmpd_opp_normal>;
176      };
177    };
178...
179