Documentation/devicetree/bindings/pinctrl/qcom,pmic-gpio.txt

   1 Qualcomm PMIC GPIO block
   2
   3 This binding describes the GPIO block(s) found in the 8xxx series of
   4 PMIC's from Qualcomm.
   5
   6 - compatible:
   7         Usage: required
   8         Value type: <string>
   9         Definition: must be one of:
  10                     "qcom,pm8018-gpio"
  11                     "qcom,pm8038-gpio"
  12                     "qcom,pm8058-gpio"
  13                     "qcom,pm8916-gpio"
  14                     "qcom,pm8917-gpio"
  15                     "qcom,pm8921-gpio"
  16                     "qcom,pm8941-gpio"
  17                     "qcom,pm8994-gpio"
  18                     "qcom,pma8084-gpio"
  19
  20                     And must contain either "qcom,spmi-gpio" or "qcom,ssbi-gpio"
  21                     if the device is on an spmi bus or an ssbi bus respectively
  22
  23 - reg:
  24         Usage: required
  25         Value type: <prop-encoded-array>
  26         Definition: Register base of the GPIO block and length.
  27
  28 - interrupts:
  29         Usage: required
  30         Value type: <prop-encoded-array>
  31         Definition: Must contain an array of encoded interrupt specifiers for
  32                     each available GPIO
  33
  34 - gpio-controller:
  35         Usage: required
  36         Value type: <none>
  37         Definition: Mark the device node as a GPIO controller
  38
  39 - #gpio-cells:
  40         Usage: required
  41         Value type: <u32>
  42         Definition: Must be 2;
  43                     the first cell will be used to define gpio number and the
  44                     second denotes the flags for this gpio
  45
  46 Please refer to ../gpio/gpio.txt and ../interrupt-controller/interrupts.txt for
  47 a general description of GPIO and interrupt bindings.
  48
  49 Please refer to pinctrl-bindings.txt in this directory for details of the
  50 common pinctrl bindings used by client devices, including the meaning of the
  51 phrase "pin configuration node".
  52
  53 The pin configuration nodes act as a container for an arbitrary number of
  54 subnodes. Each of these subnodes represents some desired configuration for a
  55 pin or a list of pins. This configuration can include the
  56 mux function to select on those pin(s), and various pin configuration
  57 parameters, as listed below.
  58
  59
  60 SUBNODES:
  61
  62 The name of each subnode is not important; all subnodes should be enumerated
  63 and processed purely based on their content.
  64
  65 Each subnode only affects those parameters that are explicitly listed. In
  66 other words, a subnode that lists a mux function but no pin configuration
  67 parameters implies no information about any pin configuration parameters.
  68 Similarly, a pin subnode that describes a pullup parameter implies no
  69 information about e.g. the mux function.
  70
  71 The following generic properties as defined in pinctrl-bindings.txt are valid
  72 to specify in a pin configuration subnode:
  73
  74 - pins:
  75         Usage: required
  76         Value type: <string-array>
  77         Definition: List of gpio pins affected by the properties specified in
  78                     this subnode.  Valid pins are:
  79                     gpio1-gpio6 for pm8018
  80                     gpio1-gpio12 for pm8038
  81                     gpio1-gpio40 for pm8058
  82                     gpio1-gpio4 for pm8916
  83                     gpio1-gpio38 for pm8917
  84                     gpio1-gpio44 for pm8921
  85                     gpio1-gpio36 for pm8941
  86                     gpio1-gpio22 for pm8994
  87                     gpio1-gpio22 for pma8084
  88
  89 - function:
  90         Usage: required
  91         Value type: <string>
  92         Definition: Specify the alternative function to be configured for the
  93                     specified pins.  Valid values are:
  94                     "normal",
  95                     "paired",
  96                     "func1",
  97                     "func2",
  98                     "dtest1",
  99                     "dtest2",
 100                     "dtest3",
 101                     "dtest4"
 102
 103 - bias-disable:
 104         Usage: optional
 105         Value type: <none>
 106         Definition: The specified pins should be configured as no pull.
 107
 108 - bias-pull-down:
 109         Usage: optional
 110         Value type: <none>
 111         Definition: The specified pins should be configured as pull down.
 112
 113 - bias-pull-up:
 114         Usage: optional
 115         Value type: <empty>
 116         Definition: The specified pins should be configured as pull up.
 117
 118 - qcom,pull-up-strength:
 119         Usage: optional
 120         Value type: <u32>
 121         Definition: Specifies the strength to use for pull up, if selected.
 122                     Valid values are; as defined in
 123                     <dt-bindings/pinctrl/qcom,pmic-gpio.h>:
 124                     1: 30uA                     (PMIC_GPIO_PULL_UP_30)
 125                     2: 1.5uA                    (PMIC_GPIO_PULL_UP_1P5)
 126                     3: 31.5uA                   (PMIC_GPIO_PULL_UP_31P5)
 127                     4: 1.5uA + 30uA boost       (PMIC_GPIO_PULL_UP_1P5_30)
 128                     If this property is omitted 30uA strength will be used if
 129                     pull up is selected
 130
 131 - bias-high-impedance:
 132         Usage: optional
 133         Value type: <none>
 134         Definition: The specified pins will put in high-Z mode and disabled.
 135
 136 - input-enable:
 137         Usage: optional
 138         Value type: <none>
 139         Definition: The specified pins are put in input mode.
 140
 141 - output-high:
 142         Usage: optional
 143         Value type: <none>
 144         Definition: The specified pins are configured in output mode, driven
 145                     high.
 146
 147 - output-low:
 148         Usage: optional
 149         Value type: <none>
 150         Definition: The specified pins are configured in output mode, driven
 151                     low.
 152
 153 - power-source:
 154         Usage: optional
 155         Value type: <u32>
 156         Definition: Selects the power source for the specified pins. Valid
 157                     power sources are defined per chip in
 158                     <dt-bindings/pinctrl/qcom,pmic-gpio.h>
 159
 160 - qcom,drive-strength:
 161         Usage: optional
 162         Value type: <u32>
 163         Definition: Selects the drive strength for the specified pins. Value
 164                     drive strengths are:
 165                     0: no (PMIC_GPIO_STRENGTH_NO)
 166                     1: high (PMIC_GPIO_STRENGTH_HIGH) 0.9mA @ 1.8V - 1.9mA @ 2.6V
 167                     2: medium (PMIC_GPIO_STRENGTH_MED) 0.6mA @ 1.8V - 1.25mA @ 2.6V
 168                     3: low (PMIC_GPIO_STRENGTH_LOW) 0.15mA @ 1.8V - 0.3mA @ 2.6V
 169                     as defined in <dt-bindings/pinctrl/qcom,pmic-gpio.h>
 170
 171 - drive-push-pull:
 172         Usage: optional
 173         Value type: <none>
 174         Definition: The specified pins are configured in push-pull mode.
 175
 176 - drive-open-drain:
 177         Usage: optional
 178         Value type: <none>
 179         Definition: The specified pins are configured in open-drain mode.
 180
 181 - drive-open-source:
 182         Usage: optional
 183         Value type: <none>
 184         Definition: The specified pins are configured in open-source mode.
 185
 186 Example:
 187
 188         pm8921_gpio: gpio@150 {
 189                 compatible = "qcom,pm8921-gpio", "qcom,ssbi-gpio";
 190                 reg = <0x150 0x160>;
 191                 interrupts = <192 1>, <193 1>, <194 1>,
 192                              <195 1>, <196 1>, <197 1>,
 193                              <198 1>, <199 1>, <200 1>,
 194                              <201 1>, <202 1>, <203 1>,
 195                              <204 1>, <205 1>, <206 1>,
 196                              <207 1>, <208 1>, <209 1>,
 197                              <210 1>, <211 1>, <212 1>,
 198                              <213 1>, <214 1>, <215 1>,
 199                              <216 1>, <217 1>, <218 1>,
 200                              <219 1>, <220 1>, <221 1>,
 201                              <222 1>, <223 1>, <224 1>,
 202                              <225 1>, <226 1>, <227 1>,
 203                              <228 1>, <229 1>, <230 1>,
 204                              <231 1>, <232 1>, <233 1>,
 205                              <234 1>, <235 1>;
 206
 207                 gpio-controller;
 208                 #gpio-cells = <2>;
 209
 210                 pm8921_gpio_keys: gpio-keys {
 211                         volume-keys {
 212                                 pins = "gpio20", "gpio21";
 213                                 function = "normal";
 214
 215                                 input-enable;
 216                                 bias-pull-up;
 217                                 drive-push-pull;
 218                                 qcom,drive-strength = <PMIC_GPIO_STRENGTH_NO>;
 219                                 power-source = <PM8921_GPIO_S4>;
 220                         };
 221                 };
 222         };