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