[1/2] Documentation: gpio: board: add flags parameter to gpiod_get*() functions
diff mbox

Message ID 1437808318-4453-1-git-send-email-dirk.behme@gmail.com
State New
Headers show

Commit Message

Dirk Behme July 25, 2015, 7:11 a.m. UTC
With commit 39b2bbe3d715 ("gpio: add flags argument to gpiod_get*()
functions") the gpiod_get*() functions got a 'flags' parameter. Reflect
this in the documentation, too.

Signed-off-by: Dirk Behme <dirk.behme@gmail.com>
---
 Documentation/gpio/board.txt | 17 ++++++++---------
 1 file changed, 8 insertions(+), 9 deletions(-)

Comments

Dirk Behme Aug. 24, 2015, 4:47 p.m. UTC | #1
On 25.07.2015 09:11, Dirk Behme wrote:
> With commit 39b2bbe3d715 ("gpio: add flags argument to gpiod_get*()
> functions") the gpiod_get*() functions got a 'flags' parameter. Reflect
> this in the documentation, too.
>
> Signed-off-by: Dirk Behme <dirk.behme@gmail.com>
> ---
>   Documentation/gpio/board.txt | 17 ++++++++---------
>   1 file changed, 8 insertions(+), 9 deletions(-)
>
> diff --git a/Documentation/gpio/board.txt b/Documentation/gpio/board.txt
> index b80606d..7605773 100644
> --- a/Documentation/gpio/board.txt
> +++ b/Documentation/gpio/board.txt
> @@ -39,11 +39,11 @@ This property will make GPIOs 15, 16 and 17 available to the driver under the
>
>   	struct gpio_desc *red, *green, *blue, *power;
>
> -	red = gpiod_get_index(dev, "led", 0);
> -	green = gpiod_get_index(dev, "led", 1);
> -	blue = gpiod_get_index(dev, "led", 2);
> +	red = gpiod_get_index(dev, "led", 0, GPIOD_OUT_HIGH);
> +	green = gpiod_get_index(dev, "led", 1, GPIOD_OUT_HIGH);
> +	blue = gpiod_get_index(dev, "led", 2, GPIOD_OUT_HIGH);
>
> -	power = gpiod_get(dev, "power");
> +	power = gpiod_get(dev, "power", GPIOD_OUT_HIGH);
>
>   The led GPIOs will be active-high, while the power GPIO will be active-low (i.e.
>   gpiod_is_active_low(power) will be true).
> @@ -142,12 +142,11 @@ The driver controlling "foo.0" will then be able to obtain its GPIOs as follows:
>
>   	struct gpio_desc *red, *green, *blue, *power;
>
> -	red = gpiod_get_index(dev, "led", 0);
> -	green = gpiod_get_index(dev, "led", 1);
> -	blue = gpiod_get_index(dev, "led", 2);
> +	red = gpiod_get_index(dev, "led", 0, GPIOD_OUT_HIGH);
> +	green = gpiod_get_index(dev, "led", 1, GPIOD_OUT_HIGH);
> +	blue = gpiod_get_index(dev, "led", 2, GPIOD_OUT_HIGH);
>
> -	power = gpiod_get(dev, "power");
> -	gpiod_direction_output(power, 1);
> +	power = gpiod_get(dev, "power", GPIOD_OUT_HIGH);
>
>   Since the "power" GPIO is mapped as active-low, its actual signal will be 0
>   after this code. Contrary to the legacy integer GPIO interface, the active-low


Any further comments on this? Or could this be applied?


Best regards

Dirk
--
To unsubscribe from this list: send the line "unsubscribe linux-gpio" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Alexandre Courbot Aug. 31, 2015, 5:24 a.m. UTC | #2
On Sat, Jul 25, 2015 at 4:11 PM, Dirk Behme <dirk.behme@gmail.com> wrote:
> With commit 39b2bbe3d715 ("gpio: add flags argument to gpiod_get*()
> functions") the gpiod_get*() functions got a 'flags' parameter. Reflect
> this in the documentation, too.
>
> Signed-off-by: Dirk Behme <dirk.behme@gmail.com>
> ---
>  Documentation/gpio/board.txt | 17 ++++++++---------
>  1 file changed, 8 insertions(+), 9 deletions(-)
>
> diff --git a/Documentation/gpio/board.txt b/Documentation/gpio/board.txt
> index b80606d..7605773 100644
> --- a/Documentation/gpio/board.txt
> +++ b/Documentation/gpio/board.txt
> @@ -39,11 +39,11 @@ This property will make GPIOs 15, 16 and 17 available to the driver under the
>
>         struct gpio_desc *red, *green, *blue, *power;
>
> -       red = gpiod_get_index(dev, "led", 0);
> -       green = gpiod_get_index(dev, "led", 1);
> -       blue = gpiod_get_index(dev, "led", 2);
> +       red = gpiod_get_index(dev, "led", 0, GPIOD_OUT_HIGH);
> +       green = gpiod_get_index(dev, "led", 1, GPIOD_OUT_HIGH);
> +       blue = gpiod_get_index(dev, "led", 2, GPIOD_OUT_HIGH);
>
> -       power = gpiod_get(dev, "power");
> +       power = gpiod_get(dev, "power", GPIOD_OUT_HIGH);
>
>  The led GPIOs will be active-high, while the power GPIO will be active-low (i.e.
>  gpiod_is_active_low(power) will be true).
> @@ -142,12 +142,11 @@ The driver controlling "foo.0" will then be able to obtain its GPIOs as follows:
>
>         struct gpio_desc *red, *green, *blue, *power;
>
> -       red = gpiod_get_index(dev, "led", 0);
> -       green = gpiod_get_index(dev, "led", 1);
> -       blue = gpiod_get_index(dev, "led", 2);
> +       red = gpiod_get_index(dev, "led", 0, GPIOD_OUT_HIGH);
> +       green = gpiod_get_index(dev, "led", 1, GPIOD_OUT_HIGH);
> +       blue = gpiod_get_index(dev, "led", 2, GPIOD_OUT_HIGH);

You are right in that the documentation needs to be updated. But since
the new code sets an output value for the 3 leds GPIO, could you also
add a short note in this paragraph to mention the fact that it will
switch the LEDs on, similarly to the explanation for the "power" GPIO
below?

Oh, and apologies for taking so long to come back to this m(__)m
--
To unsubscribe from this list: send the line "unsubscribe linux-gpio" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Patch
diff mbox

diff --git a/Documentation/gpio/board.txt b/Documentation/gpio/board.txt
index b80606d..7605773 100644
--- a/Documentation/gpio/board.txt
+++ b/Documentation/gpio/board.txt
@@ -39,11 +39,11 @@  This property will make GPIOs 15, 16 and 17 available to the driver under the
 
 	struct gpio_desc *red, *green, *blue, *power;
 
-	red = gpiod_get_index(dev, "led", 0);
-	green = gpiod_get_index(dev, "led", 1);
-	blue = gpiod_get_index(dev, "led", 2);
+	red = gpiod_get_index(dev, "led", 0, GPIOD_OUT_HIGH);
+	green = gpiod_get_index(dev, "led", 1, GPIOD_OUT_HIGH);
+	blue = gpiod_get_index(dev, "led", 2, GPIOD_OUT_HIGH);
 
-	power = gpiod_get(dev, "power");
+	power = gpiod_get(dev, "power", GPIOD_OUT_HIGH);
 
 The led GPIOs will be active-high, while the power GPIO will be active-low (i.e.
 gpiod_is_active_low(power) will be true).
@@ -142,12 +142,11 @@  The driver controlling "foo.0" will then be able to obtain its GPIOs as follows:
 
 	struct gpio_desc *red, *green, *blue, *power;
 
-	red = gpiod_get_index(dev, "led", 0);
-	green = gpiod_get_index(dev, "led", 1);
-	blue = gpiod_get_index(dev, "led", 2);
+	red = gpiod_get_index(dev, "led", 0, GPIOD_OUT_HIGH);
+	green = gpiod_get_index(dev, "led", 1, GPIOD_OUT_HIGH);
+	blue = gpiod_get_index(dev, "led", 2, GPIOD_OUT_HIGH);
 
-	power = gpiod_get(dev, "power");
-	gpiod_direction_output(power, 1);
+	power = gpiod_get(dev, "power", GPIOD_OUT_HIGH);
 
 Since the "power" GPIO is mapped as active-low, its actual signal will be 0
 after this code. Contrary to the legacy integer GPIO interface, the active-low