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