Skip to content

Commit

Permalink
Documentation: gpio: correct return value of gpiod_get_direction
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
Wolfram Sang authored and Linus Walleij committed Jan 9, 2018
1 parent 94fc730 commit 9961dbc
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion Documentation/gpio/consumer.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 9961dbc

Please sign in to comment.