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