Linux-GPIO Archive on lore.kernel.org
 help / color / 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>,
	Geert Uytterhoeven <geert+renesas@glider.be>,
	Jacopo Mondi <jacopo+renesas@jmondi.org>,
	linux-renesas-soc@vger.kernel.org
Subject: [PATCH 20/25] pinctrl: pinctrl-rza1: Demote some kerneldoc headers and fix others
Date: Mon, 13 Jul 2020 15:49:25 +0100
Message-ID: <20200713144930.1034632-21-lee.jones@linaro.org> (raw)
In-Reply-To: <20200713144930.1034632-1-lee.jones@linaro.org>

Some description blocks are void of any description/documentation,
others are missing 'struct' identifiers, there are also a couple of
misspellings of function parameter names.  Fix all of them.

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

 drivers/pinctrl/pinctrl-rza1.c:81: warning: cannot understand function prototype: 'struct rza1_bidir_pin '
 drivers/pinctrl/pinctrl-rza1.c:90: warning: cannot understand function prototype: 'struct rza1_bidir_entry '
 drivers/pinctrl/pinctrl-rza1.c:98: warning: cannot understand function prototype: 'struct rza1_swio_pin '
 drivers/pinctrl/pinctrl-rza1.c:108: warning: cannot understand function prototype: 'struct rza1_swio_entry '
 drivers/pinctrl/pinctrl-rza1.c:116: warning: cannot understand function prototype: 'struct rza1_pinmux_conf '
 drivers/pinctrl/pinctrl-rza1.c:443: warning: cannot understand function prototype: 'struct rza1_mux_conf '
 drivers/pinctrl/pinctrl-rza1.c:462: warning: cannot understand function prototype: 'struct rza1_port '
 drivers/pinctrl/pinctrl-rza1.c:482: warning: cannot understand function prototype: 'struct rza1_pinctrl '
 drivers/pinctrl/pinctrl-rza1.c:546: warning: Function parameter or member 'port' not described in 'rza1_pinmux_get_flags'
 drivers/pinctrl/pinctrl-rza1.c:546: warning: Function parameter or member 'pin' not described in 'rza1_pinmux_get_flags'
 drivers/pinctrl/pinctrl-rza1.c:546: warning: Function parameter or member 'func' not described in 'rza1_pinmux_get_flags'
 drivers/pinctrl/pinctrl-rza1.c:546: warning: Function parameter or member 'rza1_pctl' not described in 'rza1_pinmux_get_flags'
 drivers/pinctrl/pinctrl-rza1.c:575: warning: Function parameter or member 'port' not described in 'rza1_set_bit'
 drivers/pinctrl/pinctrl-rza1.c:575: warning: Function parameter or member 'reg' not described in 'rza1_set_bit'
 drivers/pinctrl/pinctrl-rza1.c:575: warning: Function parameter or member 'bit' not described in 'rza1_set_bit'
 drivers/pinctrl/pinctrl-rza1.c:575: warning: Function parameter or member 'set' not described in 'rza1_set_bit'
 drivers/pinctrl/pinctrl-rza1.c:672: warning: Function parameter or member 'rza1_pctl' not described in 'rza1_pin_mux_single'
 drivers/pinctrl/pinctrl-rza1.c:672: warning: Excess function parameter 'pinctrl' description in 'rza1_pin_mux_single'

Cc: Geert Uytterhoeven <geert+renesas@glider.be>
Cc: Jacopo Mondi <jacopo+renesas@jmondi.org>
Cc: linux-renesas-soc@vger.kernel.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/pinctrl/pinctrl-rza1.c | 24 ++++++++++++------------
 1 file changed, 12 insertions(+), 12 deletions(-)

diff --git a/drivers/pinctrl/pinctrl-rza1.c b/drivers/pinctrl/pinctrl-rza1.c
index 38a14bbced5f6..511f232ab7bc2 100644
--- a/drivers/pinctrl/pinctrl-rza1.c
+++ b/drivers/pinctrl/pinctrl-rza1.c
@@ -75,7 +75,7 @@
  * RZ/A1 pinmux flags
  */
 
-/**
+/*
  * rza1_bidir_pin - describe a single pin that needs bidir flag applied.
  */
 struct rza1_bidir_pin {
@@ -83,7 +83,7 @@ struct rza1_bidir_pin {
 	u8 func: 4;
 };
 
-/**
+/*
  * rza1_bidir_entry - describe a list of pins that needs bidir flag applied.
  *		      Each struct rza1_bidir_entry describes a port.
  */
@@ -92,7 +92,7 @@ struct rza1_bidir_entry {
 	const struct rza1_bidir_pin *pins;
 };
 
-/**
+/*
  * rza1_swio_pin - describe a single pin that needs swio flag applied.
  */
 struct rza1_swio_pin {
@@ -102,7 +102,7 @@ struct rza1_swio_pin {
 	u16 input: 1;
 };
 
-/**
+/*
  * rza1_swio_entry - describe a list of pins that needs swio flag applied
  */
 struct rza1_swio_entry {
@@ -110,7 +110,7 @@ struct rza1_swio_entry {
 	const struct rza1_swio_pin *pins;
 };
 
-/**
+/*
  * rza1_pinmux_conf - group together bidir and swio pinmux flag tables
  */
 struct rza1_pinmux_conf {
@@ -431,7 +431,7 @@ static const struct rza1_pinmux_conf rza1l_pmx_conf = {
  * RZ/A1 types
  */
 /**
- * rza1_mux_conf - describes a pin multiplexing operation
+ * struct rza1_mux_conf - describes a pin multiplexing operation
  *
  * @id: the pin identifier from 0 to RZA1_NPINS
  * @port: the port where pin sits on
@@ -450,7 +450,7 @@ struct rza1_mux_conf {
 };
 
 /**
- * rza1_port - describes a pin port
+ * struct rza1_port - describes a pin port
  *
  * This is mostly useful to lock register writes per-bank and not globally.
  *
@@ -467,12 +467,12 @@ struct rza1_port {
 };
 
 /**
- * rza1_pinctrl - RZ pincontroller device
+ * struct rza1_pinctrl - RZ pincontroller device
  *
  * @dev: parent device structure
  * @mutex: protect [pinctrl|pinmux]_generic functions
  * @base: logical address base
- * @nports: number of pin controller ports
+ * @nport: number of pin controller ports
  * @ports: pin controller banks
  * @pins: pin array for pinctrl core
  * @desc: pincontroller desc for pinctrl core
@@ -536,7 +536,7 @@ static inline int rza1_pinmux_get_swio(unsigned int port,
 	return -ENOENT;
 }
 
-/**
+/*
  * rza1_pinmux_get_flags() - return pinmux flags associated to a pin
  */
 static unsigned int rza1_pinmux_get_flags(unsigned int port, unsigned int pin,
@@ -566,7 +566,7 @@ static unsigned int rza1_pinmux_get_flags(unsigned int port, unsigned int pin,
  * RZ/A1 SoC operations
  */
 
-/**
+/*
  * rza1_set_bit() - un-locked set/clear a single bit in pin configuration
  *		    registers
  */
@@ -664,7 +664,7 @@ static inline int rza1_pin_get(struct rza1_port *port, unsigned int pin)
 /**
  * rza1_pin_mux_single() - configure pin multiplexing on a single pin
  *
- * @pinctrl: RZ/A1 pin controller device
+ * @rza1_pctl: RZ/A1 pin controller device
  * @mux_conf: pin multiplexing descriptor
  */
 static int rza1_pin_mux_single(struct rza1_pinctrl *rza1_pctl,
-- 
2.25.1


  parent reply index

Thread overview: 54+ 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 ` [PATCH 12/25] pinctrl: pinmux: Add some missing parameter descriptions Lee Jones
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-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 ` Lee Jones [this message]
2020-07-14 13:14   ` [PATCH 20/25] pinctrl: pinctrl-rza1: Demote some kerneldoc headers and fix others 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-21-lee.jones@linaro.org \
    --to=lee.jones@linaro.org \
    --cc=geert+renesas@glider.be \
    --cc=jacopo+renesas@jmondi.org \
    --cc=linus.walleij@linaro.org \
    --cc=linux-gpio@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-renesas-soc@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

Linux-GPIO Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/linux-gpio/0 linux-gpio/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 linux-gpio linux-gpio/ https://lore.kernel.org/linux-gpio \
		linux-gpio@vger.kernel.org
	public-inbox-index linux-gpio

Example config snippet for mirrors

Newsgroup available over NNTP:
	nntp://nntp.lore.kernel.org/org.kernel.vger.linux-gpio


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git