Commit 5fa9d19b authored Jul 22, 2021 by Randy Dunlap Committed by Linus Walleij Aug 10, 2021

pinctrl: aspeed: placate kernel-doc warnings



Eliminate kernel-doc warnings in drivers/pinctrl/aspeed by using
proper kernel-doc notation.

Fixes these kernel-doc warnings:

drivers/pinctrl/aspeed/pinmux-aspeed.c:61: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Query the enabled or disabled state for a mux function's signal on a pin
drivers/pinctrl/aspeed/pinctrl-aspeed.c:135: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Search for the signal expression needed to enable the pin's signal for the

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Reported-by: kernel test robot <lkp@intel.com>
Cc: Aditya Srivastava <yashsri421@gmail.com>
Cc: Andrew Jeffery <andrew@aj.id.au>
Cc: linux-aspeed@lists.ozlabs.org
Cc: openbmc@lists.ozlabs.org
Cc: Linus Walleij <linus.walleij@linaro.org>
Cc: linux-gpio@vger.kernel.org
Acked-by: Andrew Jeffery <andrew@aj.id.au>
Link: https://lore.kernel.org/r/20210723034840.8752-1-rdunlap@infradead.org


Signed-off-by: Linus Walleij <linus.walleij@linaro.org>

parent 1b73e588

drivers/pinctrl/aspeed/pinctrl-aspeed.c

+2 −2

Original line number	Diff line number	Diff line
		@@ -133,8 +133,8 @@ static int aspeed_disable_sig(struct aspeed_pinmux_data *ctx,
		}

		/**
		* Search for the signal expression needed to enable the pin's signal for the
		* requested function.
		* aspeed_find_expr_by_name - Search for the signal expression needed to
		* enable the pin's signal for the requested function.
		*
		* @exprs: List of signal expressions (haystack)
		* @name: The name of the requested function (needle)

drivers/pinctrl/aspeed/pinmux-aspeed.c

+2 −1

Original line number	Diff line number	Diff line
		@@ -59,7 +59,8 @@ int aspeed_sig_desc_eval(const struct aspeed_sig_desc *desc,
		}

		/**
		* Query the enabled or disabled state for a mux function's signal on a pin
		* aspeed_sig_expr_eval - Query the enabled or disabled state for a
		* mux function's signal on a pin
		*
		* @ctx: The driver context for the pinctrl IP
		* @expr: An expression controlling the signal for a mux function on a pin