[PATCH] pinctrl: pinmux: Add missing .function_is_gpio kerneldoc

[PATCH] pinctrl: pinmux: Add missing .function_is_gpio kerneldoc

[Linus Walleij]

This callback was undocumented, add the docs.

Signed-off-by: Linus Walleij <linus.walleij@linaro.org>
---
 include/linux/pinctrl/pinmux.h | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/include/linux/pinctrl/pinmux.h b/include/linux/pinctrl/pinmux.h
index 6db6c3e1ccc2249d4b4204e6fc19bf7b4397cc81..d2da7169b767609682e66700411051e20ba3fed2 100644
--- a/include/linux/pinctrl/pinmux.h
+++ b/include/linux/pinctrl/pinmux.h
@@ -35,6 +35,13 @@ struct pinctrl_gpio_range;
  *	name can be used with the generic @pinctrl_ops to retrieve the
  *	actual pins affected. The applicable groups will be returned in
  *	@groups and the number of groups in @num_groups
+ * @function_is_gpio: determine, preferably by reading hardware register states
+ *	if the indicates function selector passed corresponds to the GPIO
+ *	function which can also be used by the accelerared GPIO functions
+ *	@gpio_request_enable, @gpio_disable_free and @gpio_set_direction.
+ *	When the pin control core can properly determine if a function is a
+ *	GPIO function, it is much easier to use the @strict mode on the pin
+ *	controller and avoid confusing set-ups.
  * @set_mux: enable a certain muxing function with a certain pin group. The
  *	driver does not need to figure out whether enabling this function
  *	conflicts some other use of the pins in that group, such collisions

---
base-commit: 3a8660878839faadb4f1a6dd72c3179c1df56787
change-id: 20251014-function-is-gpio-kerneldoc-29b9b9df9b2a

Best regards,
-- 
Linus Walleij <linus.walleij@linaro.org>

Re: [PATCH] pinctrl: pinmux: Add missing .function_is_gpio kerneldoc

[Alexander Stein]

Hi Linus,

Am Dienstag, 14. Oktober 2025, 13:03:21 CEST schrieb Linus Walleij:
> This callback was undocumented, add the docs.

I'm not an expert on grammar, but the things below somehow are bugging me.

> Signed-off-by: Linus Walleij <linus.walleij@linaro.org>
> ---
>  include/linux/pinctrl/pinmux.h | 7 +++++++
>  1 file changed, 7 insertions(+)
> 
> diff --git a/include/linux/pinctrl/pinmux.h b/include/linux/pinctrl/pinmux.h
> index 6db6c3e1ccc2249d4b4204e6fc19bf7b4397cc81..d2da7169b767609682e66700411051e20ba3fed2 100644
> --- a/include/linux/pinctrl/pinmux.h
> +++ b/include/linux/pinctrl/pinmux.h
> @@ -35,6 +35,13 @@ struct pinctrl_gpio_range;
>   *	name can be used with the generic @pinctrl_ops to retrieve the
>   *	actual pins affected. The applicable groups will be returned in
>   *	@groups and the number of groups in @num_groups
> + * @function_is_gpio: determine, preferably by reading hardware register states

Missing comma at the end?

> + *	if the indicates function selector passed corresponds to the GPIO

indicated?

Best regards
Alexander

> + *	function which can also be used by the accelerared GPIO functions
> + *	@gpio_request_enable, @gpio_disable_free and @gpio_set_direction.
> + *	When the pin control core can properly determine if a function is a
> + *	GPIO function, it is much easier to use the @strict mode on the pin
> + *	controller and avoid confusing set-ups.
>   * @set_mux: enable a certain muxing function with a certain pin group. The
>   *	driver does not need to figure out whether enabling this function
>   *	conflicts some other use of the pins in that group, such collisions
> 
> ---
> base-commit: 3a8660878839faadb4f1a6dd72c3179c1df56787
> change-id: 20251014-function-is-gpio-kerneldoc-29b9b9df9b2a
> 
> Best regards,
> 
-- 
TQ-Systems GmbH | Mühlstraße 2, Gut Delling | 82229 Seefeld, Germany
Amtsgericht München, HRB 105018
Geschäftsführer: Detlef Schneider, Rüdiger Stahl, Stefan Schneider
http://www.tq-group.com/

Re: [PATCH] pinctrl: pinmux: Add missing .function_is_gpio kerneldoc

[Linus Walleij]

On Tue, Oct 14, 2025 at 1:03 PM Linus Walleij <linus.walleij@linaro.org> wrote:

> This callback was undocumented, add the docs.
>
> Signed-off-by: Linus Walleij <linus.walleij@linaro.org>

Fixed the grammar errors pointed out by Alexander and applied.

Yours,
Linus Walleij