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     oneOf:
  19       - enum:
  20           - qcom,mdm9607-rpmpd
  21           - qcom,msm8226-rpmpd
  22           - qcom,msm8909-rpmpd
  23           - qcom,msm8916-rpmpd
  24           - qcom,msm8917-rpmpd
  25           - qcom,msm8939-rpmpd
  26           - qcom,msm8953-rpmpd
  27           - qcom,msm8976-rpmpd
  28           - qcom,msm8994-rpmpd
  29           - qcom,msm8996-rpmpd
  30           - qcom,msm8998-rpmpd
  31           - qcom,qcm2290-rpmpd
  32           - qcom,qcs404-rpmpd
  33           - qcom,qdu1000-rpmhpd
  34           - qcom,qm215-rpmpd
  35           - qcom,sa8155p-rpmhpd
  36           - qcom,sa8540p-rpmhpd
  37           - qcom,sa8775p-rpmhpd
  38           - qcom,sc7180-rpmhpd
  39           - qcom,sc7280-rpmhpd
  40           - qcom,sc8180x-rpmhpd
  41           - qcom,sc8280xp-rpmhpd
  42           - qcom,sc8380xp-rpmhpd
  43           - qcom,sdm660-rpmpd
  44           - qcom,sdm670-rpmhpd
  45           - qcom,sdm845-rpmhpd
  46           - qcom,sdx55-rpmhpd
  47           - qcom,sdx65-rpmhpd
  48           - qcom,sdx75-rpmhpd
  49           - qcom,sm6115-rpmpd
  50           - qcom,sm6125-rpmpd
  51           - qcom,sm6350-rpmhpd
  52           - qcom,sm6375-rpmpd
  53           - qcom,sm7150-rpmhpd
  54           - qcom,sm8150-rpmhpd
  55           - qcom,sm8250-rpmhpd
  56           - qcom,sm8350-rpmhpd
  57           - qcom,sm8450-rpmhpd
  58           - qcom,sm8550-rpmhpd
  59           - qcom,sm8650-rpmhpd
  60       - items:
  61           - enum:
  62               - qcom,msm8937-rpmpd
  63           - const: qcom,msm8917-rpmpd
  64
  65   '#power-domain-cells':
  66     const: 1
  67
  68   operating-points-v2: true
  69
  70   opp-table:
  71     type: object
  72
  73 required:
  74   - compatible
  75   - '#power-domain-cells'
  76   - operating-points-v2
  77
  78 additionalProperties: false
  79
  80 examples:
  81   - |
  82
  83     // Example 1 (rpmh power domain controller and OPP table):
  84
  85     #include <dt-bindings/power/qcom-rpmpd.h>
  86
  87     rpmhpd: power-controller {
  88       compatible = "qcom,sdm845-rpmhpd";
  89       #power-domain-cells = <1>;
  90       operating-points-v2 = <&rpmhpd_opp_table>;
  91
  92       rpmhpd_opp_table: opp-table {
  93         compatible = "operating-points-v2";
  94
  95         rpmhpd_opp_ret: opp1 {
  96           opp-level = <RPMH_REGULATOR_LEVEL_RETENTION>;
  97         };
  98
  99         rpmhpd_opp_min_svs: opp2 {
 100           opp-level = <RPMH_REGULATOR_LEVEL_MIN_SVS>;
 101         };
 102
 103         rpmhpd_opp_low_svs: opp3 {
 104           opp-level = <RPMH_REGULATOR_LEVEL_LOW_SVS>;
 105         };
 106
 107         rpmhpd_opp_svs: opp4 {
 108           opp-level = <RPMH_REGULATOR_LEVEL_SVS>;
 109         };
 110
 111         rpmhpd_opp_svs_l1: opp5 {
 112           opp-level = <RPMH_REGULATOR_LEVEL_SVS_L1>;
 113         };
 114
 115         rpmhpd_opp_nom: opp6 {
 116           opp-level = <RPMH_REGULATOR_LEVEL_NOM>;
 117         };
 118
 119         rpmhpd_opp_nom_l1: opp7 {
 120           opp-level = <RPMH_REGULATOR_LEVEL_NOM_L1>;
 121         };
 122
 123         rpmhpd_opp_nom_l2: opp8 {
 124           opp-level = <RPMH_REGULATOR_LEVEL_NOM_L2>;
 125         };
 126
 127         rpmhpd_opp_turbo: opp9 {
 128           opp-level = <RPMH_REGULATOR_LEVEL_TURBO>;
 129         };
 130
 131         rpmhpd_opp_turbo_l1: opp10 {
 132           opp-level = <RPMH_REGULATOR_LEVEL_TURBO_L1>;
 133         };
 134       };
 135     };
 136
 137   - |
 138
 139     // Example 2 (rpm power domain controller and OPP table):
 140
 141     rpmpd: power-controller {
 142       compatible = "qcom,msm8996-rpmpd";
 143       #power-domain-cells = <1>;
 144       operating-points-v2 = <&rpmpd_opp_table>;
 145
 146       rpmpd_opp_table: opp-table {
 147         compatible = "operating-points-v2";
 148
 149         rpmpd_opp_low: opp1 {
 150           opp-level = <1>;
 151         };
 152
 153         rpmpd_opp_ret: opp2 {
 154           opp-level = <2>;
 155         };
 156
 157         rpmpd_opp_svs: opp3 {
 158           opp-level = <3>;
 159         };
 160
 161         rpmpd_opp_normal: opp4 {
 162           opp-level = <4>;
 163         };
 164
 165         rpmpd_opp_high: opp5 {
 166           opp-level = <5>;
 167         };
 168
 169         rpmpd_opp_turbo: opp6 {
 170           opp-level = <6>;
 171         };
 172       };
 173     };
 174
 175   - |
 176
 177     // Example 3 (Client/Consumer device using OPP table):
 178
 179     leaky-device0@12350000 {
 180       compatible = "foo,i-leak-current";
 181       reg = <0x12350000 0x1000>;
 182       power-domains = <&rpmhpd 0>;
 183       operating-points-v2 = <&leaky_opp_table>;
 184     };
 185
 186     leaky_opp_table: opp-table {
 187       compatible = "operating-points-v2";
 188       opp1 {
 189         opp-hz = /bits/ 64 <144000>;
 190         required-opps = <&rpmhpd_opp_low>;
 191       };
 192
 193       opp2 {
 194         opp-hz = /bits/ 64 <400000>;
 195         required-opps = <&rpmhpd_opp_ret>;
 196       };
 197
 198       opp3 {
 199         opp-hz = /bits/ 64 <20000000>;
 200         required-opps = <&rpmpd_opp_svs>;
 201       };
 202
 203       opp4 {
 204         opp-hz = /bits/ 64 <25000000>;
 205         required-opps = <&rpmpd_opp_normal>;
 206       };
 207     };
 208 ...