Linux-GPIO Archive on lore.kernel.org
 help / color / Atom feed
* [PATCH 00/10] Clean GPIO of W=1 warnings
@ 2020-06-30 13:33 Lee Jones
  2020-06-30 13:33 ` [PATCH 01/10] gpio: gpiolib-of: Provide documentation for of_gpio_spi_cs_get_count() Lee Jones
                   ` (9 more replies)
  0 siblings, 10 replies; 16+ messages in thread
From: Lee Jones @ 2020-06-30 13:33 UTC (permalink / raw)
  To: linus.walleij, bgolaszewski
  Cc: linux-arm-kernel, linux-kernel, linux-gpio, Lee Jones

This set is part of a larger effort attempting to clean-up W=1
kernel builds, which are currently overwhelmingly riddled with
niggly little warnings.

Lee Jones (10):
  gpio: gpiolib-of: Provide documentation for of_gpio_spi_cs_get_count()
  gpio: gpio-altera: Add missing kerneldoc entry and demote comment
  gpio: gpio-ml-ioh: Fix missing ':' in 'struct ioh_gpio_reg_data
  gpio: gpio-pmic-eic-sprd: Fix incorrectly named property 'map'
  gpio: gpio-sama5d2-piobu: Demote all kerneldoc headers to basic
    comment blocks
  gpio: gpio-syscon: Fix formatting issues which confuse kerneldoc
  gpio: gpio-it87: Fix formatting issues which confuse kerneldoc
  gpio: gpio-mlxbf: Tell the compiler that ACPI functions may not be
    used
  gpio: gpio-mlxbf2: Tell the compiler that ACPI functions may not be
    use
  gpio: gpio-mlxbf2.c: Provide __releases() annotation to stop confusing
    Sparse

 drivers/gpio/gpio-altera.c        |  3 ++-
 drivers/gpio/gpio-it87.c          | 14 +++++++-------
 drivers/gpio/gpio-ml-ioh.c        |  2 +-
 drivers/gpio/gpio-mlxbf.c         |  2 +-
 drivers/gpio/gpio-mlxbf2.c        |  4 +++-
 drivers/gpio/gpio-pmic-eic-sprd.c |  2 +-
 drivers/gpio/gpio-sama5d2-piobu.c | 16 ++++++++--------
 drivers/gpio/gpio-syscon.c        | 12 ++++++------
 drivers/gpio/gpiolib-of.c         |  3 +++
 9 files changed, 32 insertions(+), 26 deletions(-)

-- 
2.25.1


^ permalink raw reply	[flat|nested] 16+ messages in thread

* [PATCH 01/10] gpio: gpiolib-of: Provide documentation for of_gpio_spi_cs_get_count()
  2020-06-30 13:33 [PATCH 00/10] Clean GPIO of W=1 warnings Lee Jones
@ 2020-06-30 13:33 ` Lee Jones
  2020-06-30 13:33 ` [PATCH 02/10] gpio: gpio-altera: Add missing kerneldoc entry and demote comment Lee Jones
                   ` (8 subsequent siblings)
  9 siblings, 0 replies; 16+ messages in thread
From: Lee Jones @ 2020-06-30 13:33 UTC (permalink / raw)
  To: linus.walleij, bgolaszewski
  Cc: linux-arm-kernel, linux-kernel, linux-gpio, Lee Jones, Anton Vorontsov

Descriptions for of_gpio_spi_cs_get_count()'s 2 arguments are
missing.  Document both 'dev' and 'con_id'.

Fixes the following W=1 kernel build warnings:

 drivers/gpio/gpiolib-of.c:36: warning: Function parameter or member 'dev' not described in 'of_gpio_spi_cs_get_count'
 drivers/gpio/gpiolib-of.c:36: warning: Function parameter or member 'con_id' not described in 'of_gpio_spi_cs_get_count'

Cc: Anton Vorontsov <avorontsov@ru.mvista.com>
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/gpio/gpiolib-of.c | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/drivers/gpio/gpiolib-of.c b/drivers/gpio/gpiolib-of.c
index 219eb00542334..236985714ea92 100644
--- a/drivers/gpio/gpiolib-of.c
+++ b/drivers/gpio/gpiolib-of.c
@@ -25,6 +25,9 @@
 
 /**
  * of_gpio_spi_cs_get_count() - special GPIO counting for SPI
+ * @dev:    Consuming device
+ * @con_id: Function within the GPIO consumer
+ *
  * Some elder GPIO controllers need special quirks. Currently we handle
  * the Freescale GPIO controller with bindings that doesn't use the
  * established "cs-gpios" for chip selects but instead rely on
-- 
2.25.1


^ permalink raw reply	[flat|nested] 16+ messages in thread

* [PATCH 02/10] gpio: gpio-altera: Add missing kerneldoc entry and demote comment
  2020-06-30 13:33 [PATCH 00/10] Clean GPIO of W=1 warnings Lee Jones
  2020-06-30 13:33 ` [PATCH 01/10] gpio: gpiolib-of: Provide documentation for of_gpio_spi_cs_get_count() Lee Jones
@ 2020-06-30 13:33 ` Lee Jones
  2020-06-30 13:33 ` [PATCH 03/10] gpio: gpio-ml-ioh: Fix missing ':' in 'struct ioh_gpio_reg_data Lee Jones
                   ` (7 subsequent siblings)
  9 siblings, 0 replies; 16+ messages in thread
From: Lee Jones @ 2020-06-30 13:33 UTC (permalink / raw)
  To: linus.walleij, bgolaszewski
  Cc: linux-arm-kernel, linux-kernel, linux-gpio, Lee Jones, Joyce Ooi,
	Tien Hock Loh

'struct altera_gpio_chip's 'irq_chip' property is undocumented.  So
add property description to the struct's kerneldoc header.  Also
demote comment block which is clearly not in kerneldoc format.

Fixes the following W=1 warnings:

 drivers/gpio/gpio-altera.c:34: warning: Function parameter or member 'irq_chip' not described in 'altera_gpio_chip'
 drivers/gpio/gpio-altera.c:78: warning: Function parameter or member 'd' not described in 'altera_gpio_irq_set_type'
 drivers/gpio/gpio-altera.c:78: warning: Function parameter or member 'type' not described in 'altera_gpio_irq_set_type'

Cc: Joyce Ooi <joyce.ooi@intel.com>
Cc: Tien Hock Loh <thloh@altera.com>
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/gpio/gpio-altera.c | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/drivers/gpio/gpio-altera.c b/drivers/gpio/gpio-altera.c
index cc4ba71e4fe3c..b7932ecc3b613 100644
--- a/drivers/gpio/gpio-altera.c
+++ b/drivers/gpio/gpio-altera.c
@@ -24,6 +24,7 @@
 * @interrupt_trigger	: specifies the hardware configured IRQ trigger type
 *			  (rising, falling, both, high)
 * @mapped_irq		: kernel mapped irq number.
+* @irq_chip		: IRQ chip configuration
 */
 struct altera_gpio_chip {
 	struct of_mm_gpio_chip mmchip;
@@ -69,7 +70,7 @@ static void altera_gpio_irq_mask(struct irq_data *d)
 	raw_spin_unlock_irqrestore(&altera_gc->gpio_lock, flags);
 }
 
-/**
+/*
  * This controller's IRQ type is synthesized in hardware, so this function
  * just checks if the requested set_type matches the synthesized IRQ type
  */
-- 
2.25.1


^ permalink raw reply	[flat|nested] 16+ messages in thread

* [PATCH 03/10] gpio: gpio-ml-ioh: Fix missing ':' in 'struct ioh_gpio_reg_data
  2020-06-30 13:33 [PATCH 00/10] Clean GPIO of W=1 warnings Lee Jones
  2020-06-30 13:33 ` [PATCH 01/10] gpio: gpiolib-of: Provide documentation for of_gpio_spi_cs_get_count() Lee Jones
  2020-06-30 13:33 ` [PATCH 02/10] gpio: gpio-altera: Add missing kerneldoc entry and demote comment Lee Jones
@ 2020-06-30 13:33 ` Lee Jones
  2020-06-30 14:01   ` Andy Shevchenko
  2020-06-30 13:33 ` [PATCH 04/10] gpio: gpio-pmic-eic-sprd: Fix incorrectly named property 'map' Lee Jones
                   ` (6 subsequent siblings)
  9 siblings, 1 reply; 16+ messages in thread
From: Lee Jones @ 2020-06-30 13:33 UTC (permalink / raw)
  To: linus.walleij, bgolaszewski
  Cc: linux-arm-kernel, linux-kernel, linux-gpio, Lee Jones, Andy Shevchenko

'struct ioh_gpio_reg_data's 'ien_reg' property is missing a ':'
which confuses the kerneldoc tooling/parsers/validators.

Replacing it squashes the following W=1 warning:

 drivers/gpio/gpio-ml-ioh.c:63: warning: Function parameter or member 'ien_reg' not described in 'ioh_gpio_reg_data'

Cc: Andy Shevchenko <andy@kernel.org>
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/gpio/gpio-ml-ioh.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/gpio/gpio-ml-ioh.c b/drivers/gpio/gpio-ml-ioh.c
index 92b6e958cfed5..53d4abefa6ff2 100644
--- a/drivers/gpio/gpio-ml-ioh.c
+++ b/drivers/gpio/gpio-ml-ioh.c
@@ -44,7 +44,7 @@ struct ioh_regs {
 
 /**
  * struct ioh_gpio_reg_data - The register store data.
- * @ien_reg	To store contents of interrupt enable register.
+ * @ien_reg:	To store contents of interrupt enable register.
  * @imask_reg:	To store contents of interrupt mask regist
  * @po_reg:	To store contents of PO register.
  * @pm_reg:	To store contents of PM register.
-- 
2.25.1


^ permalink raw reply	[flat|nested] 16+ messages in thread

* [PATCH 04/10] gpio: gpio-pmic-eic-sprd: Fix incorrectly named property 'map'
  2020-06-30 13:33 [PATCH 00/10] Clean GPIO of W=1 warnings Lee Jones
                   ` (2 preceding siblings ...)
  2020-06-30 13:33 ` [PATCH 03/10] gpio: gpio-ml-ioh: Fix missing ':' in 'struct ioh_gpio_reg_data Lee Jones
@ 2020-06-30 13:33 ` Lee Jones
  2020-06-30 15:01   ` Baolin Wang
  2020-06-30 13:33 ` [PATCH 05/10] gpio: gpio-sama5d2-piobu: Demote all kerneldoc headers to basic comment blocks Lee Jones
                   ` (5 subsequent siblings)
  9 siblings, 1 reply; 16+ messages in thread
From: Lee Jones @ 2020-06-30 13:33 UTC (permalink / raw)
  To: linus.walleij, bgolaszewski
  Cc: linux-arm-kernel, linux-kernel, linux-gpio, Lee Jones,
	Orson Zhai, Baolin Wang, Chunyan Zhang

A good attempt has been made to properly document 'struct
sprd_pmic_eic', but 'map' has been incorrectly described as
'regmap' since the driver's inception in 2018.

Fixes the following W=1 kernel build warning:

 drivers/gpio/gpio-pmic-eic-sprd.c:65: warning: Function parameter or member 'map' not described in 'sprd_pmic_eic'

Cc: Orson Zhai <orsonzhai@gmail.com>
Cc: Baolin Wang <baolin.wang7@gmail.com>
Cc: Chunyan Zhang <zhang.lyra@gmail.com>
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/gpio/gpio-pmic-eic-sprd.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/gpio/gpio-pmic-eic-sprd.c b/drivers/gpio/gpio-pmic-eic-sprd.c
index 05000cace9b24..9382851905662 100644
--- a/drivers/gpio/gpio-pmic-eic-sprd.c
+++ b/drivers/gpio/gpio-pmic-eic-sprd.c
@@ -48,7 +48,7 @@ enum {
  * struct sprd_pmic_eic - PMIC EIC controller
  * @chip: the gpio_chip structure.
  * @intc: the irq_chip structure.
- * @regmap: the regmap from the parent device.
+ * @map:  the regmap from the parent device.
  * @offset: the EIC controller's offset address of the PMIC.
  * @reg: the array to cache the EIC registers.
  * @buslock: for bus lock/sync and unlock.
-- 
2.25.1


^ permalink raw reply	[flat|nested] 16+ messages in thread

* [PATCH 05/10] gpio: gpio-sama5d2-piobu: Demote all kerneldoc headers to basic comment blocks
  2020-06-30 13:33 [PATCH 00/10] Clean GPIO of W=1 warnings Lee Jones
                   ` (3 preceding siblings ...)
  2020-06-30 13:33 ` [PATCH 04/10] gpio: gpio-pmic-eic-sprd: Fix incorrectly named property 'map' Lee Jones
@ 2020-06-30 13:33 ` Lee Jones
  2020-07-01  7:05   ` Ludovic Desroches
  2020-06-30 13:33 ` [PATCH 06/10] gpio: gpio-syscon: Fix formatting issues which confuse kerneldoc Lee Jones
                   ` (4 subsequent siblings)
  9 siblings, 1 reply; 16+ messages in thread
From: Lee Jones @ 2020-06-30 13:33 UTC (permalink / raw)
  To: linus.walleij, bgolaszewski
  Cc: linux-arm-kernel, linux-kernel, linux-gpio, Lee Jones,
	Ludovic Desroches, Andrei Stefanescu

No attempt has been made to provide proper descriptions for each of
the function arguments throughout the file.  Simply demote all
kerneldoc headers to basic function headers.

Fixes the following W=1 kernel build warnings:

 drivers/gpio/gpio-sama5d2-piobu.c:59: warning: Function parameter or member 'chip' not described in 'sama5d2_piobu_setup_pin'
 drivers/gpio/gpio-sama5d2-piobu.c:59: warning: Function parameter or member 'pin' not described in 'sama5d2_piobu_setup_pin'
 drivers/gpio/gpio-sama5d2-piobu.c:81: warning: Function parameter or member 'chip' not described in 'sama5d2_piobu_write_value'
 drivers/gpio/gpio-sama5d2-piobu.c:81: warning: Function parameter or member 'pin' not described in 'sama5d2_piobu_write_value'
 drivers/gpio/gpio-sama5d2-piobu.c:81: warning: Function parameter or member 'mask' not described in 'sama5d2_piobu_write_value'
 drivers/gpio/gpio-sama5d2-piobu.c:81: warning: Function parameter or member 'value' not described in 'sama5d2_piobu_write_value'
 drivers/gpio/gpio-sama5d2-piobu.c:97: warning: Function parameter or member 'chip' not described in 'sama5d2_piobu_read_value'
 drivers/gpio/gpio-sama5d2-piobu.c:97: warning: Function parameter or member 'pin' not described in 'sama5d2_piobu_read_value'
 drivers/gpio/gpio-sama5d2-piobu.c:97: warning: Function parameter or member 'mask' not described in 'sama5d2_piobu_read_value'
 drivers/gpio/gpio-sama5d2-piobu.c:116: warning: Function parameter or member 'chip' not described in 'sama5d2_piobu_get_direction'
 drivers/gpio/gpio-sama5d2-piobu.c:116: warning: Function parameter or member 'pin' not described in 'sama5d2_piobu_get_direction'
 drivers/gpio/gpio-sama5d2-piobu.c:131: warning: Function parameter or member 'chip' not described in 'sama5d2_piobu_direction_input'
 drivers/gpio/gpio-sama5d2-piobu.c:131: warning: Function parameter or member 'pin' not described in 'sama5d2_piobu_direction_input'
 drivers/gpio/gpio-sama5d2-piobu.c:140: warning: Function parameter or member 'chip' not described in 'sama5d2_piobu_direction_output'
 drivers/gpio/gpio-sama5d2-piobu.c:140: warning: Function parameter or member 'pin' not described in 'sama5d2_piobu_direction_output'
 drivers/gpio/gpio-sama5d2-piobu.c:140: warning: Function parameter or member 'value' not described in 'sama5d2_piobu_direction_output'
 drivers/gpio/gpio-sama5d2-piobu.c:154: warning: Function parameter or member 'chip' not described in 'sama5d2_piobu_get'
 drivers/gpio/gpio-sama5d2-piobu.c:154: warning: Function parameter or member 'pin' not described in 'sama5d2_piobu_get'
 drivers/gpio/gpio-sama5d2-piobu.c:174: warning: Function parameter or member 'chip' not described in 'sama5d2_piobu_set'
 drivers/gpio/gpio-sama5d2-piobu.c:174: warning: Function parameter or member 'pin' not described in 'sama5d2_piobu_set'
 drivers/gpio/gpio-sama5d2-piobu.c:174: warning: Function parameter or member 'value' not described in 'sama5d2_piobu_set'

Cc: Ludovic Desroches <ludovic.desroches@microchip.com>
Cc: Andrei Stefanescu <andrei.stefanescu@microchip.com>
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/gpio/gpio-sama5d2-piobu.c | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)

diff --git a/drivers/gpio/gpio-sama5d2-piobu.c b/drivers/gpio/gpio-sama5d2-piobu.c
index 4d47b2c411868..b7c9506581701 100644
--- a/drivers/gpio/gpio-sama5d2-piobu.c
+++ b/drivers/gpio/gpio-sama5d2-piobu.c
@@ -49,7 +49,7 @@ struct sama5d2_piobu {
 	struct regmap *regmap;
 };
 
-/**
+/*
  * sama5d2_piobu_setup_pin() - prepares a pin for set_direction call
  *
  * Do not consider pin for tamper detection (normal and backup modes)
@@ -73,7 +73,7 @@ static int sama5d2_piobu_setup_pin(struct gpio_chip *chip, unsigned int pin)
 	return regmap_update_bits(piobu->regmap, PIOBU_WKPR, mask, 0);
 }
 
-/**
+/*
  * sama5d2_piobu_write_value() - writes value & mask at the pin's PIOBU register
  */
 static int sama5d2_piobu_write_value(struct gpio_chip *chip, unsigned int pin,
@@ -88,7 +88,7 @@ static int sama5d2_piobu_write_value(struct gpio_chip *chip, unsigned int pin,
 	return regmap_update_bits(piobu->regmap, reg, mask, value);
 }
 
-/**
+/*
  * sama5d2_piobu_read_value() - read the value with masking from the pin's PIOBU
  *			      register
  */
@@ -108,7 +108,7 @@ static int sama5d2_piobu_read_value(struct gpio_chip *chip, unsigned int pin,
 	return val & mask;
 }
 
-/**
+/*
  * sama5d2_piobu_get_direction() - gpiochip get_direction
  */
 static int sama5d2_piobu_get_direction(struct gpio_chip *chip,
@@ -123,7 +123,7 @@ static int sama5d2_piobu_get_direction(struct gpio_chip *chip,
 				   GPIO_LINE_DIRECTION_OUT;
 }
 
-/**
+/*
  * sama5d2_piobu_direction_input() - gpiochip direction_input
  */
 static int sama5d2_piobu_direction_input(struct gpio_chip *chip,
@@ -132,7 +132,7 @@ static int sama5d2_piobu_direction_input(struct gpio_chip *chip,
 	return sama5d2_piobu_write_value(chip, pin, PIOBU_DIRECTION, PIOBU_IN);
 }
 
-/**
+/*
  * sama5d2_piobu_direction_output() - gpiochip direction_output
  */
 static int sama5d2_piobu_direction_output(struct gpio_chip *chip,
@@ -147,7 +147,7 @@ static int sama5d2_piobu_direction_output(struct gpio_chip *chip,
 					 val);
 }
 
-/**
+/*
  * sama5d2_piobu_get() - gpiochip get
  */
 static int sama5d2_piobu_get(struct gpio_chip *chip, unsigned int pin)
@@ -166,7 +166,7 @@ static int sama5d2_piobu_get(struct gpio_chip *chip, unsigned int pin)
 	return !!ret;
 }
 
-/**
+/*
  * sama5d2_piobu_set() - gpiochip set
  */
 static void sama5d2_piobu_set(struct gpio_chip *chip, unsigned int pin,
-- 
2.25.1


^ permalink raw reply	[flat|nested] 16+ messages in thread

* [PATCH 06/10] gpio: gpio-syscon: Fix formatting issues which confuse kerneldoc
  2020-06-30 13:33 [PATCH 00/10] Clean GPIO of W=1 warnings Lee Jones
                   ` (4 preceding siblings ...)
  2020-06-30 13:33 ` [PATCH 05/10] gpio: gpio-sama5d2-piobu: Demote all kerneldoc headers to basic comment blocks Lee Jones
@ 2020-06-30 13:33 ` Lee Jones
  2020-06-30 13:33 ` [PATCH 07/10] gpio: gpio-it87: " Lee Jones
                   ` (3 subsequent siblings)
  9 siblings, 0 replies; 16+ messages in thread
From: Lee Jones @ 2020-06-30 13:33 UTC (permalink / raw)
  To: linus.walleij, bgolaszewski
  Cc: linux-arm-kernel, linux-kernel, linux-gpio, Lee Jones, Alexander Shiyan

Kerneldoc expects struct properties to be documented using the syntax
'@.*: ', but no '@' has been provided in 'struct syscon_gpio_data's
header.  Add them to stop confusing kerneldoc.

Fixes the following W=1 warnings:

 drivers/gpio/gpio-syscon.c:48: warning: Function parameter or member 'compatible' not described in 'syscon_gpio_data'
 drivers/gpio/gpio-syscon.c:48: warning: Function parameter or member 'flags' not described in 'syscon_gpio_data'
 drivers/gpio/gpio-syscon.c:48: warning: Function parameter or member 'bit_count' not described in 'syscon_gpio_data'
 drivers/gpio/gpio-syscon.c:48: warning: Function parameter or member 'dat_bit_offset' not described in 'syscon_gpio_data'
 drivers/gpio/gpio-syscon.c:48: warning: Function parameter or member 'dir_bit_offset' not described in 'syscon_gpio_data'
 drivers/gpio/gpio-syscon.c:48: warning: Function parameter or member 'set' not described in 'syscon_gpio_data'

Cc: Alexander Shiyan <shc_work@mail.ru>
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/gpio/gpio-syscon.c | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/drivers/gpio/gpio-syscon.c b/drivers/gpio/gpio-syscon.c
index 31f332074d7d5..fdd3d497b5350 100644
--- a/drivers/gpio/gpio-syscon.c
+++ b/drivers/gpio/gpio-syscon.c
@@ -24,16 +24,16 @@
 
 /**
  * struct syscon_gpio_data - Configuration for the device.
- * compatible:		SYSCON driver compatible string.
- * flags:		Set of GPIO_SYSCON_FEAT_ flags:
+ * @compatible:		SYSCON driver compatible string.
+ * @flags:		Set of GPIO_SYSCON_FEAT_ flags:
  *			GPIO_SYSCON_FEAT_IN:	GPIOs supports input,
  *			GPIO_SYSCON_FEAT_OUT:	GPIOs supports output,
  *			GPIO_SYSCON_FEAT_DIR:	GPIOs supports switch direction.
- * bit_count:		Number of bits used as GPIOs.
- * dat_bit_offset:	Offset (in bits) to the first GPIO bit.
- * dir_bit_offset:	Optional offset (in bits) to the first bit to switch
+ * @bit_count:		Number of bits used as GPIOs.
+ * @dat_bit_offset:	Offset (in bits) to the first GPIO bit.
+ * @dir_bit_offset:	Optional offset (in bits) to the first bit to switch
  *			GPIO direction (Used with GPIO_SYSCON_FEAT_DIR flag).
- * set:		HW specific callback to assigns output value
+ * @set:		HW specific callback to assigns output value
  *			for signal "offset"
  */
 
-- 
2.25.1


^ permalink raw reply	[flat|nested] 16+ messages in thread

* [PATCH 07/10] gpio: gpio-it87: Fix formatting issues which confuse kerneldoc
  2020-06-30 13:33 [PATCH 00/10] Clean GPIO of W=1 warnings Lee Jones
                   ` (5 preceding siblings ...)
  2020-06-30 13:33 ` [PATCH 06/10] gpio: gpio-syscon: Fix formatting issues which confuse kerneldoc Lee Jones
@ 2020-06-30 13:33 ` Lee Jones
  2020-06-30 13:33 ` [PATCH 08/10] gpio: gpio-mlxbf: Tell the compiler that ACPI functions may not be used Lee Jones
                   ` (2 subsequent siblings)
  9 siblings, 0 replies; 16+ messages in thread
From: Lee Jones @ 2020-06-30 13:33 UTC (permalink / raw)
  To: linus.walleij, bgolaszewski
  Cc: linux-arm-kernel, linux-kernel, linux-gpio, Lee Jones,
	Diego Elio Pettenò

Kerneldoc expects struct properties to be documented using the syntax
'@.*: ', but no ':' has been provided in 'struct it87_gpio's
header.  Add them to stop confusing kerneldoc.

Fixes the following W=1 warnings:

 drivers/gpio/gpio-it87.c:69: warning: Function parameter or member 'chip' not described in 'it87_gpio'
 drivers/gpio/gpio-it87.c:69: warning: Function parameter or member 'lock' not described in 'it87_gpio'
 drivers/gpio/gpio-it87.c:69: warning: Function parameter or member 'io_base' not described in 'it87_gpio'
 drivers/gpio/gpio-it87.c:69: warning: Function parameter or member 'io_size' not described in 'it87_gpio'
 drivers/gpio/gpio-it87.c:69: warning: Function parameter or member 'output_base' not described in 'it87_gpio'
 drivers/gpio/gpio-it87.c:69: warning: Function parameter or member 'simple_base' not described in 'it87_gpio'
 drivers/gpio/gpio-it87.c:69: warning: Function parameter or member 'simple_size' not described in 'it87_gpio'

Cc: "Diego Elio Pettenò" <flameeyes@flameeyes.eu>
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/gpio/gpio-it87.c | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)

diff --git a/drivers/gpio/gpio-it87.c b/drivers/gpio/gpio-it87.c
index b497a1d18ca9b..8f1be34953ce4 100644
--- a/drivers/gpio/gpio-it87.c
+++ b/drivers/gpio/gpio-it87.c
@@ -47,13 +47,13 @@
 
 /**
  * struct it87_gpio - it87-specific GPIO chip
- * @chip the underlying gpio_chip structure
- * @lock a lock to avoid races between operations
- * @io_base base address for gpio ports
- * @io_size size of the port rage starting from io_base.
- * @output_base Super I/O register address for Output Enable register
- * @simple_base Super I/O 'Simple I/O' Enable register
- * @simple_size Super IO 'Simple I/O' Enable register size; this is
+ * @chip: the underlying gpio_chip structure
+ * @lock: a lock to avoid races between operations
+ * @io_base: base address for gpio ports
+ * @io_size: size of the port rage starting from io_base.
+ * @output_base: Super I/O register address for Output Enable register
+ * @simple_base: Super I/O 'Simple I/O' Enable register
+ * @simple_size: Super IO 'Simple I/O' Enable register size; this is
  *	required because IT87xx chips might only provide Simple I/O
  *	switches on a subset of lines, whereas the others keep the
  *	same status all time.
-- 
2.25.1


^ permalink raw reply	[flat|nested] 16+ messages in thread

* [PATCH 08/10] gpio: gpio-mlxbf: Tell the compiler that ACPI functions may not be used
  2020-06-30 13:33 [PATCH 00/10] Clean GPIO of W=1 warnings Lee Jones
                   ` (6 preceding siblings ...)
  2020-06-30 13:33 ` [PATCH 07/10] gpio: gpio-it87: " Lee Jones
@ 2020-06-30 13:33 ` Lee Jones
  2020-06-30 13:33 ` [PATCH 09/10] gpio: gpio-mlxbf2: Tell the compiler that ACPI functions may not be use Lee Jones
  2020-06-30 13:33 ` [PATCH 10/10] gpio: gpio-mlxbf2.c: Provide __releases() annotation to stop confusing Sparse Lee Jones
  9 siblings, 0 replies; 16+ messages in thread
From: Lee Jones @ 2020-06-30 13:33 UTC (permalink / raw)
  To: linus.walleij, bgolaszewski
  Cc: linux-arm-kernel, linux-kernel, linux-gpio, Lee Jones,
	Shravan Kumar Ramani

... as is the case when !CONFIG_ACPI.

Fixes the following W=1 kernel build warning:

 drivers/gpio/gpio-mlxbf.c:130:36: warning: ‘mlxbf_gpio_acpi_match’ defined but not used [-Wunused-const-variable=]
 130 | static const struct acpi_device_id mlxbf_gpio_acpi_match[] = {
 | ^~~~~~~~~~~~~~~~~~~~~

Cc: Shravan Kumar Ramani <sramani@mellanox.com>
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/gpio/gpio-mlxbf.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/gpio/gpio-mlxbf.c b/drivers/gpio/gpio-mlxbf.c
index 894aaf55fc96c..1fa9973f55b96 100644
--- a/drivers/gpio/gpio-mlxbf.c
+++ b/drivers/gpio/gpio-mlxbf.c
@@ -127,7 +127,7 @@ static int mlxbf_gpio_resume(struct platform_device *pdev)
 }
 #endif
 
-static const struct acpi_device_id mlxbf_gpio_acpi_match[] = {
+static const struct acpi_device_id __maybe_unused mlxbf_gpio_acpi_match[] = {
 	{ "MLNXBF02", 0 },
 	{}
 };
-- 
2.25.1


^ permalink raw reply	[flat|nested] 16+ messages in thread

* [PATCH 09/10] gpio: gpio-mlxbf2: Tell the compiler that ACPI functions may not be use
  2020-06-30 13:33 [PATCH 00/10] Clean GPIO of W=1 warnings Lee Jones
                   ` (7 preceding siblings ...)
  2020-06-30 13:33 ` [PATCH 08/10] gpio: gpio-mlxbf: Tell the compiler that ACPI functions may not be used Lee Jones
@ 2020-06-30 13:33 ` Lee Jones
  2020-06-30 14:17   ` Asmaa Mnebhi
  2020-06-30 13:33 ` [PATCH 10/10] gpio: gpio-mlxbf2.c: Provide __releases() annotation to stop confusing Sparse Lee Jones
  9 siblings, 1 reply; 16+ messages in thread
From: Lee Jones @ 2020-06-30 13:33 UTC (permalink / raw)
  To: linus.walleij, bgolaszewski
  Cc: linux-arm-kernel, linux-kernel, linux-gpio, Lee Jones, Asmaa Mnebhi

... as is the case when !CONFIG_ACPI.

Fixes the following W=1 kernel build warning:

 drivers/gpio/gpio-mlxbf2.c:312:36: warning: ‘mlxbf2_gpio_acpi_match’ defined but not used [-Wunused-const-variable=]
 312 | static const struct acpi_device_id mlxbf2_gpio_acpi_match[] = {
 | ^~~~~~~~~~~~~~~~~~~~~~

Cc: Asmaa Mnebhi <Asmaa@mellanox.com>
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/gpio/gpio-mlxbf2.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/gpio/gpio-mlxbf2.c b/drivers/gpio/gpio-mlxbf2.c
index 94d5efce1721c..861a8d0a84be0 100644
--- a/drivers/gpio/gpio-mlxbf2.c
+++ b/drivers/gpio/gpio-mlxbf2.c
@@ -309,7 +309,7 @@ static int mlxbf2_gpio_resume(struct platform_device *pdev)
 }
 #endif
 
-static const struct acpi_device_id mlxbf2_gpio_acpi_match[] = {
+static const struct acpi_device_id __maybe_unused mlxbf2_gpio_acpi_match[] = {
 	{ "MLNXBF22", 0 },
 	{},
 };
-- 
2.25.1


^ permalink raw reply	[flat|nested] 16+ messages in thread

* [PATCH 10/10] gpio: gpio-mlxbf2.c: Provide __releases() annotation to stop confusing Sparse
  2020-06-30 13:33 [PATCH 00/10] Clean GPIO of W=1 warnings Lee Jones
                   ` (8 preceding siblings ...)
  2020-06-30 13:33 ` [PATCH 09/10] gpio: gpio-mlxbf2: Tell the compiler that ACPI functions may not be use Lee Jones
@ 2020-06-30 13:33 ` Lee Jones
  2020-06-30 14:18   ` Asmaa Mnebhi
  9 siblings, 1 reply; 16+ messages in thread
From: Lee Jones @ 2020-06-30 13:33 UTC (permalink / raw)
  To: linus.walleij, bgolaszewski
  Cc: linux-arm-kernel, linux-kernel, linux-gpio, Lee Jones, Asmaa Mnebhi

Sparse cannot peer into other functions to see when and if locks are
acquired and released, thus it simply warns that a 'context imbalance'
is detected instead.  Let's be kind to Sparse and let it know that
this behaviour is intentional.

 drivers/gpio/gpio-mlxbf2.c:125:12: warning: context imbalance in 'mlxbf2_gpio_lock_acquire' - different lock contexts for basic block
 drivers/gpio/gpio-mlxbf2.c:151:13: warning: context imbalance in 'mlxbf2_gpio_lock_release' - unexpected unlock

Cc: Asmaa Mnebhi <Asmaa@mellanox.com>
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/gpio/gpio-mlxbf2.c | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/drivers/gpio/gpio-mlxbf2.c b/drivers/gpio/gpio-mlxbf2.c
index 861a8d0a84be0..befa5e1099439 100644
--- a/drivers/gpio/gpio-mlxbf2.c
+++ b/drivers/gpio/gpio-mlxbf2.c
@@ -149,6 +149,8 @@ static int mlxbf2_gpio_lock_acquire(struct mlxbf2_gpio_context *gs)
  * Release the YU arm_gpio_lock after changing the direction mode.
  */
 static void mlxbf2_gpio_lock_release(struct mlxbf2_gpio_context *gs)
+	__releases(&gs->gc.bgpio_lock)
+	__releases(yu_arm_gpio_lock_param.lock)
 {
 	writel(YU_ARM_GPIO_LOCK_RELEASE, yu_arm_gpio_lock_param.io);
 	spin_unlock(&gs->gc.bgpio_lock);
-- 
2.25.1


^ permalink raw reply	[flat|nested] 16+ messages in thread

* Re: [PATCH 03/10] gpio: gpio-ml-ioh: Fix missing ':' in 'struct ioh_gpio_reg_data
  2020-06-30 13:33 ` [PATCH 03/10] gpio: gpio-ml-ioh: Fix missing ':' in 'struct ioh_gpio_reg_data Lee Jones
@ 2020-06-30 14:01   ` Andy Shevchenko
  0 siblings, 0 replies; 16+ messages in thread
From: Andy Shevchenko @ 2020-06-30 14:01 UTC (permalink / raw)
  To: Lee Jones
  Cc: linus.walleij, bgolaszewski, linux-arm-kernel, linux-kernel,
	linux-gpio, Andy Shevchenko

On Tue, Jun 30, 2020 at 02:33:38PM +0100, Lee Jones wrote:
> 'struct ioh_gpio_reg_data's 'ien_reg' property is missing a ':'
> which confuses the kerneldoc tooling/parsers/validators.
> 
> Replacing it squashes the following W=1 warning:
> 
>  drivers/gpio/gpio-ml-ioh.c:63: warning: Function parameter or member 'ien_reg' not described in 'ioh_gpio_reg_data'

Applied, thanks!

> 
> Cc: Andy Shevchenko <andy@kernel.org>
> Signed-off-by: Lee Jones <lee.jones@linaro.org>
> ---
>  drivers/gpio/gpio-ml-ioh.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/drivers/gpio/gpio-ml-ioh.c b/drivers/gpio/gpio-ml-ioh.c
> index 92b6e958cfed5..53d4abefa6ff2 100644
> --- a/drivers/gpio/gpio-ml-ioh.c
> +++ b/drivers/gpio/gpio-ml-ioh.c
> @@ -44,7 +44,7 @@ struct ioh_regs {
>  
>  /**
>   * struct ioh_gpio_reg_data - The register store data.
> - * @ien_reg	To store contents of interrupt enable register.
> + * @ien_reg:	To store contents of interrupt enable register.
>   * @imask_reg:	To store contents of interrupt mask regist
>   * @po_reg:	To store contents of PO register.
>   * @pm_reg:	To store contents of PM register.
> -- 
> 2.25.1
> 

-- 
With Best Regards,
Andy Shevchenko



^ permalink raw reply	[flat|nested] 16+ messages in thread

* RE: [PATCH 09/10] gpio: gpio-mlxbf2: Tell the compiler that ACPI functions may not be use
  2020-06-30 13:33 ` [PATCH 09/10] gpio: gpio-mlxbf2: Tell the compiler that ACPI functions may not be use Lee Jones
@ 2020-06-30 14:17   ` Asmaa Mnebhi
  0 siblings, 0 replies; 16+ messages in thread
From: Asmaa Mnebhi @ 2020-06-30 14:17 UTC (permalink / raw)
  To: Lee Jones, linus.walleij, bgolaszewski
  Cc: linux-arm-kernel, linux-kernel, linux-gpio

Reviewed-by: Asmaa Mnebhi <asmaa@mellanox.com>

Thank you.

-----Original Message-----
From: Lee Jones <lee.jones@linaro.org> 
Sent: Tuesday, June 30, 2020 9:34 AM
To: linus.walleij@linaro.org; bgolaszewski@baylibre.com
Cc: linux-arm-kernel@lists.infradead.org; linux-kernel@vger.kernel.org; linux-gpio@vger.kernel.org; Lee Jones <lee.jones@linaro.org>; Asmaa Mnebhi <Asmaa@mellanox.com>
Subject: [PATCH 09/10] gpio: gpio-mlxbf2: Tell the compiler that ACPI functions may not be use

... as is the case when !CONFIG_ACPI.

Fixes the following W=1 kernel build warning:

 drivers/gpio/gpio-mlxbf2.c:312:36: warning: ‘mlxbf2_gpio_acpi_match’ defined but not used [-Wunused-const-variable=]
 312 | static const struct acpi_device_id mlxbf2_gpio_acpi_match[] = {  | ^~~~~~~~~~~~~~~~~~~~~~

Cc: Asmaa Mnebhi <Asmaa@mellanox.com>
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/gpio/gpio-mlxbf2.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/gpio/gpio-mlxbf2.c b/drivers/gpio/gpio-mlxbf2.c index 94d5efce1721c..861a8d0a84be0 100644
--- a/drivers/gpio/gpio-mlxbf2.c
+++ b/drivers/gpio/gpio-mlxbf2.c
@@ -309,7 +309,7 @@ static int mlxbf2_gpio_resume(struct platform_device *pdev)  }  #endif
 
-static const struct acpi_device_id mlxbf2_gpio_acpi_match[] = {
+static const struct acpi_device_id __maybe_unused 
+mlxbf2_gpio_acpi_match[] = {
 	{ "MLNXBF22", 0 },
 	{},
 };
--
2.25.1


^ permalink raw reply	[flat|nested] 16+ messages in thread

* RE: [PATCH 10/10] gpio: gpio-mlxbf2.c: Provide __releases() annotation to stop confusing Sparse
  2020-06-30 13:33 ` [PATCH 10/10] gpio: gpio-mlxbf2.c: Provide __releases() annotation to stop confusing Sparse Lee Jones
@ 2020-06-30 14:18   ` Asmaa Mnebhi
  0 siblings, 0 replies; 16+ messages in thread
From: Asmaa Mnebhi @ 2020-06-30 14:18 UTC (permalink / raw)
  To: Lee Jones, linus.walleij, bgolaszewski
  Cc: linux-arm-kernel, linux-kernel, linux-gpio

Reviewed-by: Asmaa Mnebhi <asmaa@mellanox.com>

Thank you.

-----Original Message-----
From: Lee Jones <lee.jones@linaro.org> 
Sent: Tuesday, June 30, 2020 9:34 AM
To: linus.walleij@linaro.org; bgolaszewski@baylibre.com
Cc: linux-arm-kernel@lists.infradead.org; linux-kernel@vger.kernel.org; linux-gpio@vger.kernel.org; Lee Jones <lee.jones@linaro.org>; Asmaa Mnebhi <Asmaa@mellanox.com>
Subject: [PATCH 10/10] gpio: gpio-mlxbf2.c: Provide __releases() annotation to stop confusing Sparse

Sparse cannot peer into other functions to see when and if locks are acquired and released, thus it simply warns that a 'context imbalance'
is detected instead.  Let's be kind to Sparse and let it know that this behaviour is intentional.

 drivers/gpio/gpio-mlxbf2.c:125:12: warning: context imbalance in 'mlxbf2_gpio_lock_acquire' - different lock contexts for basic block
 drivers/gpio/gpio-mlxbf2.c:151:13: warning: context imbalance in 'mlxbf2_gpio_lock_release' - unexpected unlock

Cc: Asmaa Mnebhi <Asmaa@mellanox.com>
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/gpio/gpio-mlxbf2.c | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/drivers/gpio/gpio-mlxbf2.c b/drivers/gpio/gpio-mlxbf2.c index 861a8d0a84be0..befa5e1099439 100644
--- a/drivers/gpio/gpio-mlxbf2.c
+++ b/drivers/gpio/gpio-mlxbf2.c
@@ -149,6 +149,8 @@ static int mlxbf2_gpio_lock_acquire(struct mlxbf2_gpio_context *gs)
  * Release the YU arm_gpio_lock after changing the direction mode.
  */
 static void mlxbf2_gpio_lock_release(struct mlxbf2_gpio_context *gs)
+	__releases(&gs->gc.bgpio_lock)
+	__releases(yu_arm_gpio_lock_param.lock)
 {
 	writel(YU_ARM_GPIO_LOCK_RELEASE, yu_arm_gpio_lock_param.io);
 	spin_unlock(&gs->gc.bgpio_lock);
--
2.25.1


^ permalink raw reply	[flat|nested] 16+ messages in thread

* Re: [PATCH 04/10] gpio: gpio-pmic-eic-sprd: Fix incorrectly named property 'map'
  2020-06-30 13:33 ` [PATCH 04/10] gpio: gpio-pmic-eic-sprd: Fix incorrectly named property 'map' Lee Jones
@ 2020-06-30 15:01   ` Baolin Wang
  0 siblings, 0 replies; 16+ messages in thread
From: Baolin Wang @ 2020-06-30 15:01 UTC (permalink / raw)
  To: Lee Jones
  Cc: Linus Walleij, bgolaszewski, linux-arm-kernel, LKML, linux-gpio,
	Orson Zhai, Chunyan Zhang

On Tue, Jun 30, 2020 at 9:33 PM Lee Jones <lee.jones@linaro.org> wrote:
>
> A good attempt has been made to properly document 'struct
> sprd_pmic_eic', but 'map' has been incorrectly described as
> 'regmap' since the driver's inception in 2018.
>
> Fixes the following W=1 kernel build warning:
>
>  drivers/gpio/gpio-pmic-eic-sprd.c:65: warning: Function parameter or member 'map' not described in 'sprd_pmic_eic'
>
> Cc: Orson Zhai <orsonzhai@gmail.com>
> Cc: Baolin Wang <baolin.wang7@gmail.com>
> Cc: Chunyan Zhang <zhang.lyra@gmail.com>
> Signed-off-by: Lee Jones <lee.jones@linaro.org>

Looks good to me.
Reviewed-by: Baolin Wang <baolin.wang7@gmail.com>

> ---
>  drivers/gpio/gpio-pmic-eic-sprd.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/drivers/gpio/gpio-pmic-eic-sprd.c b/drivers/gpio/gpio-pmic-eic-sprd.c
> index 05000cace9b24..9382851905662 100644
> --- a/drivers/gpio/gpio-pmic-eic-sprd.c
> +++ b/drivers/gpio/gpio-pmic-eic-sprd.c
> @@ -48,7 +48,7 @@ enum {
>   * struct sprd_pmic_eic - PMIC EIC controller
>   * @chip: the gpio_chip structure.
>   * @intc: the irq_chip structure.
> - * @regmap: the regmap from the parent device.
> + * @map:  the regmap from the parent device.
>   * @offset: the EIC controller's offset address of the PMIC.
>   * @reg: the array to cache the EIC registers.
>   * @buslock: for bus lock/sync and unlock.
> --
> 2.25.1
>


-- 
Baolin Wang

^ permalink raw reply	[flat|nested] 16+ messages in thread

* Re: [PATCH 05/10] gpio: gpio-sama5d2-piobu: Demote all kerneldoc headers to basic comment blocks
  2020-06-30 13:33 ` [PATCH 05/10] gpio: gpio-sama5d2-piobu: Demote all kerneldoc headers to basic comment blocks Lee Jones
@ 2020-07-01  7:05   ` Ludovic Desroches
  0 siblings, 0 replies; 16+ messages in thread
From: Ludovic Desroches @ 2020-07-01  7:05 UTC (permalink / raw)
  To: Lee Jones
  Cc: linus.walleij, bgolaszewski, linux-arm-kernel, linux-kernel,
	linux-gpio, Andrei Stefanescu

On Tue, Jun 30, 2020 at 02:33:40PM +0100, Lee Jones wrote:
> EXTERNAL EMAIL: Do not click links or open attachments unless you know the content is safe
> 
> No attempt has been made to provide proper descriptions for each of
> the function arguments throughout the file.  Simply demote all
> kerneldoc headers to basic function headers.
> 
> Fixes the following W=1 kernel build warnings:
> 
>  drivers/gpio/gpio-sama5d2-piobu.c:59: warning: Function parameter or member 'chip' not described in 'sama5d2_piobu_setup_pin'
>  drivers/gpio/gpio-sama5d2-piobu.c:59: warning: Function parameter or member 'pin' not described in 'sama5d2_piobu_setup_pin'
>  drivers/gpio/gpio-sama5d2-piobu.c:81: warning: Function parameter or member 'chip' not described in 'sama5d2_piobu_write_value'
>  drivers/gpio/gpio-sama5d2-piobu.c:81: warning: Function parameter or member 'pin' not described in 'sama5d2_piobu_write_value'
>  drivers/gpio/gpio-sama5d2-piobu.c:81: warning: Function parameter or member 'mask' not described in 'sama5d2_piobu_write_value'
>  drivers/gpio/gpio-sama5d2-piobu.c:81: warning: Function parameter or member 'value' not described in 'sama5d2_piobu_write_value'
>  drivers/gpio/gpio-sama5d2-piobu.c:97: warning: Function parameter or member 'chip' not described in 'sama5d2_piobu_read_value'
>  drivers/gpio/gpio-sama5d2-piobu.c:97: warning: Function parameter or member 'pin' not described in 'sama5d2_piobu_read_value'
>  drivers/gpio/gpio-sama5d2-piobu.c:97: warning: Function parameter or member 'mask' not described in 'sama5d2_piobu_read_value'
>  drivers/gpio/gpio-sama5d2-piobu.c:116: warning: Function parameter or member 'chip' not described in 'sama5d2_piobu_get_direction'
>  drivers/gpio/gpio-sama5d2-piobu.c:116: warning: Function parameter or member 'pin' not described in 'sama5d2_piobu_get_direction'
>  drivers/gpio/gpio-sama5d2-piobu.c:131: warning: Function parameter or member 'chip' not described in 'sama5d2_piobu_direction_input'
>  drivers/gpio/gpio-sama5d2-piobu.c:131: warning: Function parameter or member 'pin' not described in 'sama5d2_piobu_direction_input'
>  drivers/gpio/gpio-sama5d2-piobu.c:140: warning: Function parameter or member 'chip' not described in 'sama5d2_piobu_direction_output'
>  drivers/gpio/gpio-sama5d2-piobu.c:140: warning: Function parameter or member 'pin' not described in 'sama5d2_piobu_direction_output'
>  drivers/gpio/gpio-sama5d2-piobu.c:140: warning: Function parameter or member 'value' not described in 'sama5d2_piobu_direction_output'
>  drivers/gpio/gpio-sama5d2-piobu.c:154: warning: Function parameter or member 'chip' not described in 'sama5d2_piobu_get'
>  drivers/gpio/gpio-sama5d2-piobu.c:154: warning: Function parameter or member 'pin' not described in 'sama5d2_piobu_get'
>  drivers/gpio/gpio-sama5d2-piobu.c:174: warning: Function parameter or member 'chip' not described in 'sama5d2_piobu_set'
>  drivers/gpio/gpio-sama5d2-piobu.c:174: warning: Function parameter or member 'pin' not described in 'sama5d2_piobu_set'
>  drivers/gpio/gpio-sama5d2-piobu.c:174: warning: Function parameter or member 'value' not described in 'sama5d2_piobu_set'
> 
> Cc: Ludovic Desroches <ludovic.desroches@microchip.com>
> Cc: Andrei Stefanescu <andrei.stefanescu@microchip.com>
> Signed-off-by: Lee Jones <lee.jones@linaro.org>

Acked-by: Ludovic Desroches <ludovic.desroches@microchip.com>

Thanks.

> ---
>  drivers/gpio/gpio-sama5d2-piobu.c | 16 ++++++++--------
>  1 file changed, 8 insertions(+), 8 deletions(-)
> 
> diff --git a/drivers/gpio/gpio-sama5d2-piobu.c b/drivers/gpio/gpio-sama5d2-piobu.c
> index 4d47b2c411868..b7c9506581701 100644
> --- a/drivers/gpio/gpio-sama5d2-piobu.c
> +++ b/drivers/gpio/gpio-sama5d2-piobu.c
> @@ -49,7 +49,7 @@ struct sama5d2_piobu {
>         struct regmap *regmap;
>  };
> 
> -/**
> +/*
>   * sama5d2_piobu_setup_pin() - prepares a pin for set_direction call
>   *
>   * Do not consider pin for tamper detection (normal and backup modes)
> @@ -73,7 +73,7 @@ static int sama5d2_piobu_setup_pin(struct gpio_chip *chip, unsigned int pin)
>         return regmap_update_bits(piobu->regmap, PIOBU_WKPR, mask, 0);
>  }
> 
> -/**
> +/*
>   * sama5d2_piobu_write_value() - writes value & mask at the pin's PIOBU register
>   */
>  static int sama5d2_piobu_write_value(struct gpio_chip *chip, unsigned int pin,
> @@ -88,7 +88,7 @@ static int sama5d2_piobu_write_value(struct gpio_chip *chip, unsigned int pin,
>         return regmap_update_bits(piobu->regmap, reg, mask, value);
>  }
> 
> -/**
> +/*
>   * sama5d2_piobu_read_value() - read the value with masking from the pin's PIOBU
>   *                           register
>   */
> @@ -108,7 +108,7 @@ static int sama5d2_piobu_read_value(struct gpio_chip *chip, unsigned int pin,
>         return val & mask;
>  }
> 
> -/**
> +/*
>   * sama5d2_piobu_get_direction() - gpiochip get_direction
>   */
>  static int sama5d2_piobu_get_direction(struct gpio_chip *chip,
> @@ -123,7 +123,7 @@ static int sama5d2_piobu_get_direction(struct gpio_chip *chip,
>                                    GPIO_LINE_DIRECTION_OUT;
>  }
> 
> -/**
> +/*
>   * sama5d2_piobu_direction_input() - gpiochip direction_input
>   */
>  static int sama5d2_piobu_direction_input(struct gpio_chip *chip,
> @@ -132,7 +132,7 @@ static int sama5d2_piobu_direction_input(struct gpio_chip *chip,
>         return sama5d2_piobu_write_value(chip, pin, PIOBU_DIRECTION, PIOBU_IN);
>  }
> 
> -/**
> +/*
>   * sama5d2_piobu_direction_output() - gpiochip direction_output
>   */
>  static int sama5d2_piobu_direction_output(struct gpio_chip *chip,
> @@ -147,7 +147,7 @@ static int sama5d2_piobu_direction_output(struct gpio_chip *chip,
>                                          val);
>  }
> 
> -/**
> +/*
>   * sama5d2_piobu_get() - gpiochip get
>   */
>  static int sama5d2_piobu_get(struct gpio_chip *chip, unsigned int pin)
> @@ -166,7 +166,7 @@ static int sama5d2_piobu_get(struct gpio_chip *chip, unsigned int pin)
>         return !!ret;
>  }
> 
> -/**
> +/*
>   * sama5d2_piobu_set() - gpiochip set
>   */
>  static void sama5d2_piobu_set(struct gpio_chip *chip, unsigned int pin,
> --
> 2.25.1
> 

^ permalink raw reply	[flat|nested] 16+ messages in thread

end of thread, back to index

Thread overview: 16+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-06-30 13:33 [PATCH 00/10] Clean GPIO of W=1 warnings Lee Jones
2020-06-30 13:33 ` [PATCH 01/10] gpio: gpiolib-of: Provide documentation for of_gpio_spi_cs_get_count() Lee Jones
2020-06-30 13:33 ` [PATCH 02/10] gpio: gpio-altera: Add missing kerneldoc entry and demote comment Lee Jones
2020-06-30 13:33 ` [PATCH 03/10] gpio: gpio-ml-ioh: Fix missing ':' in 'struct ioh_gpio_reg_data Lee Jones
2020-06-30 14:01   ` Andy Shevchenko
2020-06-30 13:33 ` [PATCH 04/10] gpio: gpio-pmic-eic-sprd: Fix incorrectly named property 'map' Lee Jones
2020-06-30 15:01   ` Baolin Wang
2020-06-30 13:33 ` [PATCH 05/10] gpio: gpio-sama5d2-piobu: Demote all kerneldoc headers to basic comment blocks Lee Jones
2020-07-01  7:05   ` Ludovic Desroches
2020-06-30 13:33 ` [PATCH 06/10] gpio: gpio-syscon: Fix formatting issues which confuse kerneldoc Lee Jones
2020-06-30 13:33 ` [PATCH 07/10] gpio: gpio-it87: " Lee Jones
2020-06-30 13:33 ` [PATCH 08/10] gpio: gpio-mlxbf: Tell the compiler that ACPI functions may not be used Lee Jones
2020-06-30 13:33 ` [PATCH 09/10] gpio: gpio-mlxbf2: Tell the compiler that ACPI functions may not be use Lee Jones
2020-06-30 14:17   ` Asmaa Mnebhi
2020-06-30 13:33 ` [PATCH 10/10] gpio: gpio-mlxbf2.c: Provide __releases() annotation to stop confusing Sparse Lee Jones
2020-06-30 14:18   ` Asmaa Mnebhi

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