linux-kernel - Re: [PATCH] gpio: Further document optional GPIOLIB

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Date:   Wed, 4 Oct 2023 13:41:00 +0200
From:   Bartosz Golaszewski <brgl@...ev.pl>
To:     Linus Walleij <linus.walleij@...aro.org>
Cc:     Andy Shevchenko <andy@...nel.org>,
        Jonathan Corbet <corbet@....net>, linux-gpio@...r.kernel.org,
        linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH] gpio: Further document optional GPIOLIB

On Mon, Oct 2, 2023 at 10:12 AM Linus Walleij <linus.walleij@...aro.org> wrote:
>
> Optional GPIOLIB as in not depended on or selected by a driver
> should NOT use any *_optional() calls, this becomes paradoxical.
>
> Signed-off-by: Linus Walleij <linus.walleij@...aro.org>
> ---
>  Documentation/driver-api/gpio/consumer.rst | 4 ++++
>  1 file changed, 4 insertions(+)
>
> diff --git a/Documentation/driver-api/gpio/consumer.rst b/Documentation/driver-api/gpio/consumer.rst
> index de6fc79ad6f0..3e588b9d678c 100644
> --- a/Documentation/driver-api/gpio/consumer.rst
> +++ b/Documentation/driver-api/gpio/consumer.rst
> @@ -29,6 +29,10 @@ warnings. These stubs are used for two use cases:
>    will use it under other compile-time configurations. In this case the
>    consumer must make sure not to call into these functions, or the user will
>    be met with console warnings that may be perceived as intimidating.
> +  Combining truly optional GPIOLIB usage with calls to
> +  ``[devm_]gpiod_get_optional()`` is a *bad idea*, and will result in weird
> +  error messages. Use the ordinary getter functions with optional GPIOLIB:
> +  some open coding of error handling should be expected when you do this.
>
>  All the functions that work with the descriptor-based GPIO interface are
>  prefixed with ``gpiod_``. The ``gpio_`` prefix is used for the legacy
>
> ---
> base-commit: 0bb80ecc33a8fb5a682236443c1e740d5c917d1d
> change-id: 20231002-gpiodoc-cf9430641b91
>
> Best regards,
> --
> Linus Walleij <linus.walleij@...aro.org>
>

Applied, thanks!

Bart