Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
MIME-Version: 1.0
References: <5d1823c503629694de74ccd2d823188507c54706.1625445811.git.plr.vincent@gmail.com>
In-Reply-To: <5d1823c503629694de74ccd2d823188507c54706.1625445811.git.plr.vincent@gmail.com>
From:   Bartosz Golaszewski <bgolaszewski@baylibre.com>
Date:   Wed, 21 Jul 2021 15:18:14 +0200
Message-ID: <CAMpxmJVSSsRM1W957E-urQqbY1PB+wQ6sRCRnCaHVKg6ge13ZA@mail.gmail.com>
Subject: Re: [PATCH] Documentation: gpio: driver.rst: Remove
 gpiochip_irqchip_add mention
To:     Vincent Pelletier <plr.vincent@gmail.com>
Cc:     Linus Walleij <linus.walleij@linaro.org>,
        Jonathan Corbet <corbet@lwn.net>,
        linux-gpio <linux-gpio@vger.kernel.org>,
        linux-doc <linux-doc@vger.kernel.org>,
        LKML <linux-kernel@vger.kernel.org>
Content-Type: text/plain; charset="UTF-8"
Precedence: bulk

On Mon, Jul 5, 2021 at 2:44 AM Vincent Pelletier <plr.vincent@gmail.com> wrote:
>
> This function was removed in commit f1f37abbe6fc ("gpio: Retire the
> explicit gpio irqchip code") but this mention was left behind.
> Also, mention that .set_type() only has to set a line handler if the chip
> is cascaded, as opposed to hierarchical.
>
> Signed-off-by: Vincent Pelletier <plr.vincent@gmail.com>
> ---
>  Documentation/driver-api/gpio/driver.rst | 11 ++++-------
>  1 file changed, 4 insertions(+), 7 deletions(-)
>
> diff --git a/Documentation/driver-api/gpio/driver.rst b/Documentation/driver-api/gpio/driver.rst
> index d6b0d779859b..bbc53920d4dd 100644
> --- a/Documentation/driver-api/gpio/driver.rst
> +++ b/Documentation/driver-api/gpio/driver.rst
> @@ -547,13 +547,10 @@ To use the helpers please keep the following in mind:
>    the irqchip can initialize. E.g. .dev and .can_sleep shall be set up
>    properly.
>
> -- Nominally set all handlers to handle_bad_irq() in the setup call and pass
> -  handle_bad_irq() as flow handler parameter in gpiochip_irqchip_add() if it is
> -  expected for GPIO driver that irqchip .set_type() callback will be called
> -  before using/enabling each GPIO IRQ. Then set the handler to
> -  handle_level_irq() and/or handle_edge_irq() in the irqchip .set_type()
> -  callback depending on what your controller supports and what is requested
> -  by the consumer.
> +- Nominally set gpio_irq_chip.handler to handle_bad_irq. Then, if your irqchip
> +  is cascaded, set the handler to handle_level_irq() and/or handle_edge_irq()
> +  in the irqchip .set_type() callback depending on what your controller
> +  supports and what is requested by the consumer.
>
>
>  Locking IRQ usage
> --
> 2.32.0
>

Patch applied, thanks!

Bartosz