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