linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Lee Jones <lee.jones@linaro.org>
To: linus.walleij@linaro.org
Cc: linux-kernel@vger.kernel.org, linux-gpio@vger.kernel.org,
	Lee Jones <lee.jones@linaro.org>
Subject: [PATCH 12/25] pinctrl: pinmux: Add some missing parameter descriptions
Date: Mon, 13 Jul 2020 15:49:17 +0100	[thread overview]
Message-ID: <20200713144930.1034632-13-lee.jones@linaro.org> (raw)
In-Reply-To: <20200713144930.1034632-1-lee.jones@linaro.org>

And rename another which has probably bitrotted.

Fixes the following W=1 kernel build warning(s):

 drivers/pinctrl/pinmux.c:83: warning: Function parameter or member 'pctldev' not described in 'pinmux_can_be_used_for_gpio'
 drivers/pinctrl/pinmux.c:108: warning: Function parameter or member 'pctldev' not described in 'pin_request'
 drivers/pinctrl/pinmux.c:261: warning: Function parameter or member 'gpio' not described in 'pinmux_request_gpio'
 drivers/pinctrl/pinmux.c:751: warning: Function parameter or member 'selector' not described in 'pinmux_generic_get_function'
 drivers/pinctrl/pinmux.c:751: warning: Excess function parameter 'group_selector' description in 'pinmux_generic_get_function'

Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/pinctrl/pinmux.c | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/drivers/pinctrl/pinmux.c b/drivers/pinctrl/pinmux.c
index 9503ddf2edc76..bab888fe3f8e3 100644
--- a/drivers/pinctrl/pinmux.c
+++ b/drivers/pinctrl/pinmux.c
@@ -74,6 +74,7 @@ int pinmux_validate_map(const struct pinctrl_map *map, int i)
  * pinmux_can_be_used_for_gpio() - check if a specific pin
  *	is either muxed to a different function or used as gpio.
  *
+ * @pctldev: the associated pin controller device
  * @pin: the pin number in the global pin space
  *
  * Controllers not defined as strict will always return true,
@@ -96,6 +97,7 @@ bool pinmux_can_be_used_for_gpio(struct pinctrl_dev *pctldev, unsigned pin)
 
 /**
  * pin_request() - request a single pin to be muxed in, typically for GPIO
+ * @pctldev: the associated pin controller device
  * @pin: the pin number in the global pin space
  * @owner: a representation of the owner of this pin; typically the device
  *	name that controls its mux function, or the requested GPIO name
@@ -254,6 +256,7 @@ static const char *pin_free(struct pinctrl_dev *pctldev, int pin,
  * @pctldev: pin controller device affected
  * @pin: the pin to mux in for GPIO
  * @range: the applicable GPIO range
+ * @gpio: number of requested GPIO
  */
 int pinmux_request_gpio(struct pinctrl_dev *pctldev,
 			struct pinctrl_gpio_range *range,
@@ -744,7 +747,7 @@ EXPORT_SYMBOL_GPL(pinmux_generic_get_function_groups);
 /**
  * pinmux_generic_get_function() - returns a function based on the number
  * @pctldev: pin controller device
- * @group_selector: function number
+ * @selector: function number
  */
 struct function_desc *pinmux_generic_get_function(struct pinctrl_dev *pctldev,
 						  unsigned int selector)
-- 
2.25.1


  parent reply	other threads:[~2020-07-13 14:49 UTC|newest]

Thread overview: 61+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-07-13 14:49 [PATCH 00/25] Rid W=1 warnings in Pinctrl Lee Jones
2020-07-13 14:49 ` [PATCH 01/25] pinctrl: actions: pinctrl-owl: Supply missing 'struct owl_pinctrl' attribute descriptions Lee Jones
2020-07-14 17:18   ` Manivannan Sadhasivam
2020-07-13 14:49 ` [PATCH 02/25] pinctrl: sirf: pinctrl-atlas7: Fix a bunch of documentation misdemeanours Lee Jones
2020-07-13 14:49 ` [PATCH 03/25] pinctrl: bcm: pinctrl-bcm281xx: Demote obvious misuse of kerneldoc to standard comment blocks Lee Jones
2020-07-13 17:59   ` Scott Branden
2020-07-13 14:49 ` [PATCH 04/25] pinctrl: bcm: pinctrl-iproc-gpio: Rename incorrectly documented function param Lee Jones
2020-07-13 17:58   ` Scott Branden
2020-07-13 14:49 ` [PATCH 05/25] pinctrl: qcom: pinctrl-msm: Complete 'struct msm_pinctrl' documentation Lee Jones
2020-07-13 14:49 ` [PATCH 06/25] pinctrl: samsung: pinctrl-samsung: Demote obvious misuse of kerneldoc to standard comment blocks Lee Jones
2020-07-20 14:27   ` Krzysztof Kozlowski
2020-07-20 14:49     ` Lee Jones
2020-07-20 14:52       ` Krzysztof Kozlowski
2020-07-23  8:43         ` Linus Walleij
2020-07-23  8:45           ` Krzysztof Kozlowski
2020-07-13 14:49 ` [PATCH 07/25] pinctrl: samsung: pinctrl-s3c24xx: Fix formatting issues Lee Jones
2020-07-14 18:30   ` Heiko Stuebner
2020-07-20 14:27   ` Krzysztof Kozlowski
2020-07-20 14:49     ` Lee Jones
2020-07-13 14:49 ` [PATCH 08/25] pinctrl: samsung: pinctrl-s3c64xx: " Lee Jones
2020-07-20 14:28   ` Krzysztof Kozlowski
2020-07-20 14:48     ` Lee Jones
2020-07-13 14:49 ` [PATCH 09/25] pinctrl: qcom: pinctrl-msm8976: Remove unused variable 'nav_tsync_groups' Lee Jones
2020-07-13 14:49 ` [PATCH 10/25] pinctrl: mediatek: pinctrl-mtk-common-v2: Mark 'mtk_default_register_base_names' as __maybe_unused Lee Jones
2020-07-14 21:21   ` Sean Wang
2020-07-13 14:49 ` [PATCH 11/25] pinctrl: core: Fix a bunch of kerneldoc issues Lee Jones
2020-07-13 14:49 ` Lee Jones [this message]
2020-07-13 14:49 ` [PATCH 13/25] pinctrl: devicetree: Add one new attribute description and rename another two Lee Jones
2020-07-13 14:49 ` [PATCH 14/25] pinctrl: pinconf-generic: Add function parameter description 'pctldev' Lee Jones
2020-07-13 14:49 ` [PATCH 15/25] pinctrl: pinctrl-at91-pio4: PM related attribute descriptions Lee Jones
2020-07-13 14:49 ` [PATCH 16/25] arch: arm: mach-at91: pm: Move prototypes to mutually included header Lee Jones
2020-07-13 20:02   ` Alexandre Belloni
2020-07-16 13:14     ` Linus Walleij
2020-07-16 13:42     ` Lee Jones
2020-07-17 14:10       ` Alexandre Belloni
2020-11-12  9:39   ` [PATCH v2 " Lee Jones
2020-11-12 10:07     ` Alexandre Belloni
2020-11-12 10:48       ` Lee Jones
2020-11-13  9:39         ` Alexandre Belloni
2020-11-13 10:00           ` Lee Jones
2020-11-26 13:28     ` [PATCH v3 " Lee Jones
2020-11-26 15:33       ` Alexandre Belloni
2020-07-13 14:49 ` [PATCH 17/25] pinctrl: pinctrl-at91: Demote non-kerneldoc header and complete another Lee Jones
2020-07-13 14:49 ` [PATCH 18/25] pinctrl: pinctrl-bm1880: Rename ill documented struct attribute entries Lee Jones
2020-07-14 17:17   ` Manivannan Sadhasivam
2020-07-13 14:49 ` [PATCH 19/25] pinctrl: pinctrl-rockchip: Fix a bunch of kerneldoc misdemeanours Lee Jones
2020-07-14 18:32   ` Heiko Stuebner
2020-07-13 14:49 ` [PATCH 20/25] pinctrl: pinctrl-rza1: Demote some kerneldoc headers and fix others Lee Jones
2020-07-14 13:14   ` Jacopo Mondi
2020-07-14 13:45     ` Lee Jones
2020-07-15  7:30   ` Geert Uytterhoeven
2020-07-16 13:57     ` Linus Walleij
2020-07-16 14:12       ` Geert Uytterhoeven
2020-07-13 14:49 ` [PATCH 21/25] pinctrl: pinctrl-single: Fix struct/function documentation blocks Lee Jones
2020-07-13 16:32   ` Tony Lindgren
2020-07-13 14:49 ` [PATCH 22/25] pinctrl: tegra: pinctrl-tegra194: Do not initialise field twice Lee Jones
2020-07-14 15:49   ` Thierry Reding
2020-07-13 14:49 ` [PATCH 23/25] pinctrl: meson: pinctrl-meson-a1: Remove unused const variable 'i2c_slave_groups' Lee Jones
2020-07-13 14:49 ` [PATCH 24/25] pinctrl: mvebu: pinctrl-armada-37xx: Update documentation block for 'struct armada_37xx_pin_group' Lee Jones
2020-07-13 14:49 ` [PATCH 25/25] pinctrl: pinctrl-amd: Do not define 'struct acpi_device_id' when !CONFIG_ACPI Lee Jones
2020-07-16 13:05 ` [PATCH 00/25] Rid W=1 warnings in Pinctrl Linus Walleij

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20200713144930.1034632-13-lee.jones@linaro.org \
    --to=lee.jones@linaro.org \
    --cc=linus.walleij@linaro.org \
    --cc=linux-gpio@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).