Documentation/devicetree/bindings/regulator/qcom,spmi-regulator.txt

   1 Qualcomm SPMI Regulators
   2
   3 - compatible:
   4         Usage: required
   5         Value type: <string>
   6         Definition: must be one of:
   7                         "qcom,pm8841-regulators"
   8                         "qcom,pm8916-regulators"
   9                         "qcom,pm8941-regulators"
  10                         "qcom,pm8994-regulators"
  11                         "qcom,pmi8994-regulators"
  12
  13 - interrupts:
  14         Usage: optional
  15         Value type: <prop-encoded-array>
  16         Definition: List of OCP interrupts.
  17
  18 - interrupt-names:
  19         Usage: required if 'interrupts' property present
  20         Value type: <string-array>
  21         Definition: List of strings defining the names of the
  22                     interrupts in the 'interrupts' property 1-to-1.
  23                     Supported values are "ocp-<regulator_name>", where
  24                     <regulator_name> corresponds to a voltage switch
  25                     type regulator.
  26
  27 - vdd_s1-supply:
  28 - vdd_s2-supply:
  29 - vdd_s3-supply:
  30 - vdd_s4-supply:
  31 - vdd_s5-supply:
  32 - vdd_s6-supply:
  33 - vdd_s7-supply:
  34 - vdd_s8-supply:
  35         Usage: optional (pm8841 only)
  36         Value type: <phandle>
  37         Definition: Reference to regulator supplying the input pin, as
  38                     described in the data sheet.
  39
  40 - vdd_s1-supply:
  41 - vdd_s2-supply:
  42 - vdd_s3-supply:
  43 - vdd_s4-supply:
  44 - vdd_l1_l3-supply:
  45 - vdd_l2-supply:
  46 - vdd_l4_l5_l6-supply:
  47 - vdd_l7-supply:
  48 - vdd_l8_l11_l14_l15_l16-supply:
  49 - vdd_l9_l10_l12_l13_l17_l18-supply:
  50         Usage: optional (pm8916 only)
  51         Value type: <phandle>
  52         Definition: Reference to regulator supplying the input pin, as
  53                     described in the data sheet.
  54
  55 - vdd_s1-supply:
  56 - vdd_s2-supply:
  57 - vdd_s3-supply:
  58 - vdd_l1_l3-supply:
  59 - vdd_l2_lvs_1_2_3-supply:
  60 - vdd_l4_l11-supply:
  61 - vdd_l5_l7-supply:
  62 - vdd_l6_l12_l14_l15-supply:
  63 - vdd_l8_l16_l18_19-supply:
  64 - vdd_l9_l10_l17_l22-supply:
  65 - vdd_l13_l20_l23_l24-supply:
  66 - vdd_l21-supply:
  67 - vin_5vs-supply:
  68         Usage: optional (pm8941 only)
  69         Value type: <phandle>
  70         Definition: Reference to regulator supplying the input pin, as
  71                     described in the data sheet.
  72
  73 - vdd_s1-supply:
  74 - vdd_s2-supply:
  75 - vdd_s3-supply:
  76 - vdd_s4-supply:
  77 - vdd_s5-supply:
  78 - vdd_s6-supply:
  79 - vdd_s7-supply:
  80 - vdd_s8-supply:
  81 - vdd_s9-supply:
  82 - vdd_s10-supply:
  83 - vdd_s11-supply:
  84 - vdd_s12-supply:
  85 - vdd_l1-supply:
  86 - vdd_l2_l26_l28-supply:
  87 - vdd_l3_l11-supply:
  88 - vdd_l4_l27_l31-supply:
  89 - vdd_l5_l7-supply:
  90 - vdd_l6_l12_l32-supply:
  91 - vdd_l8_l16_l30-supply:
  92 - vdd_l9_l10_l18_l22-supply:
  93 - vdd_l13_l19_l23_l24-supply:
  94 - vdd_l14_l15-supply:
  95 - vdd_l17_l29-supply:
  96 - vdd_l20_l21-supply:
  97 - vdd_l25-supply:
  98 - vdd_lvs_1_2-supply:
  99         Usage: optional (pm8994 only)
 100         Value type: <phandle>
 101         Definition: Reference to regulator supplying the input pin, as
 102                     described in the data sheet.
 103
 104 - vdd_s1-supply:
 105 - vdd_s2-supply:
 106 - vdd_s3-supply:
 107 - vdd_l1-supply:
 108         Usage: optional (pmi8994 only)
 109         Value type: <phandle>
 110         Definition: Reference to regulator supplying the input pin, as
 111                     described in the data sheet.
 112
 113
 114 The regulator node houses sub-nodes for each regulator within the device. Each
 115 sub-node is identified using the node's name, with valid values listed for each
 116 of the PMICs below.
 117
 118 pm8841:
 119         s1, s2, s3, s4, s5, s6, s7, s8
 120
 121 pm8916:
 122         s1, s2, s3, s4, l1, l2, l3, l4, l5, l6, l7, l8, l9, l10, l11, l12, l13,
 123         l14, l15, l16, l17, l18
 124
 125 pm8941:
 126         s1, s2, s3, s4, l1, l2, l3, l4, l5, l6, l7, l8, l9, l10, l11, l12, l13,
 127         l14, l15, l16, l17, l18, l19, l20, l21, l22, l23, l24, lvs1, lvs2, lvs3,
 128         5vs1, 5vs2
 129
 130 pm8994:
 131         s1, s2, s3, s4, s5, s6, s7, s8, s9, s10, s11, s12, l1, l2, l3, l4, l5,
 132         l6, l7, l8, l9, l10, l11, l12, l13, l14, l15, l16, l17, l18, l19, l20,
 133         l21, l22, l23, l24, l25, l26, l27, l28, l29, l30, l31, l32, lvs1, lvs2
 134
 135 pmi8994:
 136         s1, s2, s3, l1
 137
 138 The content of each sub-node is defined by the standard binding for regulators -
 139 see regulator.txt - with additional custom properties described below:
 140
 141 - regulator-initial-mode:
 142         Usage: optional
 143         Value type: <u32>
 144         Description: 2 = Set initial mode to auto mode (automatically select
 145                     between HPM and LPM); not available on boost type
 146                     regulators.
 147
 148                     1 = Set initial mode to high power mode (HPM), also referred
 149                     to as NPM. HPM consumes more ground current than LPM, but
 150                     it can source significantly higher load current. HPM is not
 151                     available on boost type regulators. For voltage switch type
 152                     regulators, HPM implies that over current protection and
 153                     soft start are active all the time.
 154
 155                     0 = Set initial mode to low power mode (LPM).
 156
 157 - qcom,ocp-max-retries:
 158         Usage: optional
 159         Value type: <u32>
 160         Description: Maximum number of times to try toggling a voltage switch
 161                      off and back on as a result of consecutive over current
 162                      events.
 163
 164 - qcom,ocp-retry-delay:
 165         Usage: optional
 166         Value type: <u32>
 167         Description: Time to delay in milliseconds between each voltage switch
 168                      toggle after an over current event takes place.
 169
 170 - qcom,pin-ctrl-enable:
 171         Usage: optional
 172         Value type: <u32>
 173         Description: Bit mask specifying which hardware pins should be used to
 174                      enable the regulator, if any; supported bits are:
 175                         0 = ignore all hardware enable signals
 176                         BIT(0) = follow HW0_EN signal
 177                         BIT(1) = follow HW1_EN signal
 178                         BIT(2) = follow HW2_EN signal
 179                         BIT(3) = follow HW3_EN signal
 180
 181 - qcom,pin-ctrl-hpm:
 182         Usage: optional
 183         Value type: <u32>
 184         Description: Bit mask specifying which hardware pins should be used to
 185                      force the regulator into high power mode, if any;
 186                      supported bits are:
 187                         0 = ignore all hardware enable signals
 188                         BIT(0) = follow HW0_EN signal
 189                         BIT(1) = follow HW1_EN signal
 190                         BIT(2) = follow HW2_EN signal
 191                         BIT(3) = follow HW3_EN signal
 192                         BIT(4) = follow PMIC awake state
 193
 194 - qcom,vs-soft-start-strength:
 195         Usage: optional
 196         Value type: <u32>
 197         Description: This property sets the soft start strength for voltage
 198                      switch type regulators; supported values are:
 199                         0 = 0.05 uA
 200                         1 = 0.25 uA
 201                         2 = 0.55 uA
 202                         3 = 0.75 uA
 203
 204 Example:
 205
 206         regulators {
 207                 compatible = "qcom,pm8941-regulators";
 208                 vdd_l1_l3-supply = <&s1>;
 209
 210                 s1: s1 {
 211                         regulator-min-microvolt = <1300000>;
 212                         regulator-max-microvolt = <1400000>;
 213                 };
 214
 215                 ...
 216
 217                 l1: l1 {
 218                         regulator-min-microvolt = <1225000>;
 219                         regulator-max-microvolt = <1300000>;
 220                 };
 221
 222                 ....
 223         };