dt-bindings: gpio: document the new pull-up/pull-down flags
authorThomas Petazzoni <thomas.petazzoni@bootlin.com>
Thu, 7 Feb 2019 16:28:55 +0000 (17:28 +0100)
committerLinus Walleij <linus.walleij@linaro.org>
Wed, 13 Feb 2019 08:07:43 +0000 (09:07 +0100)
commitede033e1e863c36729de25b57145fff287415830
tree51113627e623b97fcb8f647dd06431b316cc5ceb
parentbfeffd155283772bbe78c6a05dec7c0128ee500c
dt-bindings: gpio: document the new pull-up/pull-down flags

This commit extends the flags that can be used in GPIO specifiers to
indicate if a pull-up resistor or pull-down resistor should be
enabled.

While some pinctrl DT bindings already offer the capability of
configuring pull-up/pull-down resistors at the pin level, a number of
simple GPIO controllers don't have any pinmuxing capability, and
therefore do not rely on the pinctrl DT bindings.

Such simple GPIO controllers however sometimes allow to configure
pull-up and pull-down resistors on a per-pin basis, and whether such
resistors should be enabled or not is a highly board-specific HW
characteristic.

By using two additional bits of the GPIO flag specifier, we can easily
allow the Device Tree to describe which GPIOs should have their
pull-up or pull-down resistors enabled. Even though the two options
are mutually exclusive, we still need two bits to encode at least
three states: no pull-up/pull-down, pull-up, pull-down.

Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
Signed-off-by: Linus Walleij <linus.walleij@linaro.org>
Documentation/devicetree/bindings/gpio/gpio.txt
include/dt-bindings/gpio/gpio.h