summaryrefslogtreecommitdiffstats
path: root/Documentation/gpio
diff options
context:
space:
mode:
authorWolfram Sang <wsa+renesas@sang-engineering.com>2018-01-09 12:35:54 +0100
committerLinus Walleij <linus.walleij@linaro.org>2018-01-09 15:36:19 +0100
commit9961dbcd228e868224f5f725dfae69de739855dc (patch)
treeddec6cb7f2e68d22943af3ea70f640b07c40b1c0 /Documentation/gpio
parentgpio: correct docs about return value of gpiod_get_direction (diff)
downloadlinux-9961dbcd228e868224f5f725dfae69de739855dc.tar.xz
linux-9961dbcd228e868224f5f725dfae69de739855dc.zip
Documentation: gpio: correct return value of gpiod_get_direction
The use of the GPIOF_* flags is deprecated, so don't advertise them here. Document the plain numbers for now until we have a better solution. Signed-off-by: Wolfram Sang <wsa+renesas@sang-engineering.com> Signed-off-by: Linus Walleij <linus.walleij@linaro.org>
Diffstat (limited to 'Documentation/gpio')
-rw-r--r--Documentation/gpio/consumer.txt2
1 files changed, 1 insertions, 1 deletions
diff --git a/Documentation/gpio/consumer.txt b/Documentation/gpio/consumer.txt
index 63e1bd1d88e3..7aac33081510 100644
--- a/Documentation/gpio/consumer.txt
+++ b/Documentation/gpio/consumer.txt
@@ -184,7 +184,7 @@ A driver can also query the current direction of a GPIO:
int gpiod_get_direction(const struct gpio_desc *desc)
-This function will return either GPIOF_DIR_IN or GPIOF_DIR_OUT.
+This function returns 0 for output, 1 for input, or an error code in case of error.
Be aware that there is no default direction for GPIOs. Therefore, **using a GPIO
without setting its direction first is illegal and will result in undefined