Skip to contentSkip to conversation

pinctrl: intel: Fix kernel doc format, i.e. add return sections

PATCH In review Andy Shevchenko 2 participants 3 messages May 19, 2022 – May 20, 2022

Subsystems (3)
GPIO Pin control Pin controller - Intel
lore
Share & tools
lore

Andy Shevchenko

author
#0 lore raw

PATCH 1/1 pinctrl: intel: Fix kernel doc format, i.e. add return sections

Kernel doc validator is not happy:

pinctrl-intel.c:865: warning: No description found for return value of 'intel_gpio_to_pin' pinctrl-intel.c:904: warning: No description found for return value of 'intel_pin_to_gpio' 2 warnings

Add return sections to the kernel documentation of the above mentioned functions.

Signed-off-by Andy Shevchenko <[email protected]>
---
 drivers/pinctrl/intel/pinctrl-intel.c | 5 +++++
 1 file changed, 5 insertions(+)
drivers/pinctrl/intel/pinctrl-intel.c +5 -0
index f882a31375ee..ffc045f7bf00 100644
@@ -858,6 +858,9 @@ static const struct pinctrl_desc intel_pinctrl_desc = {
  * When coming through gpiolib irqchip, the GPIO offset is not
  * automatically translated to pinctrl pin number. This function can be
  * used to find out the corresponding pinctrl pin.
+ *
+ * Return: a pin number and pointers to the community and pad group, which
+ * the pin belongs to, or negative error code if translation can't be done.
  */
 static int intel_gpio_to_pin(struct intel_pinctrl *pctrl, unsigned int offset,
 			     const struct intel_community **community,

@@ -899,6 +902,8 @@ static int intel_gpio_to_pin(struct intel_pinctrl *pctrl, unsigned int offset,
  * @pin: pin number
  *
  * Translate the pin number of pinctrl to GPIO offset
+ *
+ * Return: a GPIO offset, or negative error code if translation can't be done.
  */
 static __maybe_unused int intel_pin_to_gpio(struct intel_pinctrl *pctrl, int pin)
 {
Signature · 1 line
2.35.1
maintainer Acked-by on v1 1/1
#1 lore raw
Quoted 10 lines · Andy Shevchenko

Kernel doc validator is not happy:

pinctrl-intel.c:865: warning: No description found for return value of 'intel_gpio_to_pin' pinctrl-intel.c:904: warning: No description found for return value of 'intel_pin_to_gpio' 2 warnings

Add return sections to the kernel documentation of the above mentioned functions.

Signed-off-by Andy Shevchenko <[email protected]>
Acked-by Mika Westerberg <[email protected]>
author
#2 lore raw
Quoted 7 lines · Mika Westerberg
Quoted 6 lines · Andy Shevchenko

Kernel doc validator is not happy:

pinctrl-intel.c:865: warning: No description found for return value of 'intel_gpio_to_pin' pinctrl-intel.c:904: warning: No description found for return value of 'intel_pin_to_gpio' 2 warnings

Quoted 6 lines
Quoted 4 lines

Add return sections to the kernel documentation of the above mentioned functions.

Signed-off-by Andy Shevchenko <[email protected]>
Acked-by Mika Westerberg <[email protected]>

Pushed to my review and testing queue, thanks!

Signature · 2 lines
With Best Regards,
Andy Shevchenko