2021-05-28 09:18:40

by Lee Jones

[permalink] [raw]
Subject: [PATCH 00/15] Rid W=1 warnings from LED

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 (15):
leds: trigger: ledtrig-cpu: Fix incorrectly documented param 'ledevt'
leds: leds-gpio-register: Supply description for param 'id'
leds: led-class: Fix incorrectly documented param 'dev'
leds: leds-bcm6328: Demote kernel-doc abuse
leds: leds-as3645a: Fix function name 'as3645a_set_current()'
leds: leds-blinkm: Remove unused variable 'ret'
leds: leds-is31fl32xx: Provide missing description for member
'sw_shutdown_func'
leds: leds-lp3944: Provide missing function names in documentation
headers
leds: leds-lm3530: Fix incorrect spelling of 'brightness'
leds: leds-lm3692x: Fix some kernel-doc formatting issues
leds: leds-lm3697: Provide some missing descriptions for struct
members
leds: leds-mlxreg: Fix incorrect documentation of struct member
'led_cdev' and 'led_cdev_name'
leds: leds-lp8860: Fix kernel-doc related formatting issues
leds: leds-lm3692x: Demote non-complete kernel-doc
leds: leds-mlxcpld: Fix a bunch of kernel-doc formatting issues

drivers/leds/led-class.c | 2 +-
drivers/leds/leds-as3645a.c | 2 +-
drivers/leds/leds-bcm6328.c | 2 +-
drivers/leds/leds-blinkm.c | 5 ++--
drivers/leds/leds-gpio-register.c | 1 +
drivers/leds/leds-is31fl32xx.c | 3 ++-
drivers/leds/leds-lm3530.c | 2 +-
drivers/leds/leds-lm3692x.c | 20 ++++++++--------
drivers/leds/leds-lm3697.c | 4 ++++
drivers/leds/leds-lp3944.c | 6 ++---
drivers/leds/leds-lp8860.c | 16 ++++++-------
drivers/leds/leds-mlxcpld.c | 38 +++++++++++++++---------------
drivers/leds/leds-mlxreg.c | 3 ++-
drivers/leds/trigger/ledtrig-cpu.c | 2 +-
14 files changed, 56 insertions(+), 50 deletions(-)

Cc: Antonio Ospite <[email protected]>
Cc: Bryan Wu <[email protected]>
Cc: Dan Murphy <[email protected]>
Cc: Dan Murphy <[email protected]>
Cc: David Rivshin <[email protected]>
Cc: "Fernández Rojas" <[email protected]>
Cc: Jan-Simon Moeller <[email protected]>
Cc: "Jan-Simon Möller" <[email protected]>
Cc: John Lenz <[email protected]>
Cc: Jonas Gorski <[email protected]>
Cc: Kumar SAHU <[email protected]>
Cc: Laurent Pinchart <[email protected]>
Cc: Liam Girdwood <[email protected]>
Cc: Linus Walleij <[email protected]>
Cc: [email protected]
Cc: Mark Brown <[email protected]>
Cc: Pavel Machek <[email protected]>
Cc: Richard Purdie <[email protected]>
Cc: Sakari Ailus <[email protected]>
Cc: Uwe Kleine-Koenig <[email protected]>
Cc: Vadim Pasternak <[email protected]>
--
2.31.1


2021-05-28 09:19:24

by Lee Jones

[permalink] [raw]
Subject: [PATCH 07/15] leds: leds-is31fl32xx: Provide missing description for member 'sw_shutdown_func'

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

drivers/leds/leds-is31fl32xx.c:85: warning: Function parameter or member 'sw_shutdown_func' not described in 'is31fl32xx_chipdef'

Cc: Pavel Machek <[email protected]>
Cc: David Rivshin <[email protected]>
Cc: [email protected]
Signed-off-by: Lee Jones <[email protected]>
---
drivers/leds/leds-is31fl32xx.c | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/drivers/leds/leds-is31fl32xx.c b/drivers/leds/leds-is31fl32xx.c
index 2180255ad3393..3b55af9a8c585 100644
--- a/drivers/leds/leds-is31fl32xx.c
+++ b/drivers/leds/leds-is31fl32xx.c
@@ -58,7 +58,8 @@ struct is31fl32xx_priv {
* @pwm_registers_reversed: : true if PWM registers count down instead of up
* @led_control_register_base : address of first LED control register (optional)
* @enable_bits_per_led_control_register: number of LEDs enable bits in each
- * @reset_func: : pointer to reset function
+ * @reset_func : pointer to reset function
+ * @sw_shutdown_func : pointer to software shutdown function
*
* For all optional register addresses, the sentinel value %IS31FL32XX_REG_NONE
* indicates that this chip has no such register.
--
2.31.1

2021-05-28 09:19:26

by Lee Jones

[permalink] [raw]
Subject: [PATCH 05/15] leds: leds-as3645a: Fix function name 'as3645a_set_current()'

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

drivers/leds/leds-as3645a.c:198: warning: expecting prototype for as3645a_set_config(). Prototype was for as3645a_set_current() instead

Cc: Sakari Ailus <[email protected]>
Cc: Pavel Machek <[email protected]>
Cc: Laurent Pinchart <[email protected]>
Cc: [email protected]
Signed-off-by: Lee Jones <[email protected]>
---
drivers/leds/leds-as3645a.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/leds/leds-as3645a.c b/drivers/leds/leds-as3645a.c
index e8922fa033796..c41937ff8fd33 100644
--- a/drivers/leds/leds-as3645a.c
+++ b/drivers/leds/leds-as3645a.c
@@ -185,7 +185,7 @@ static int as3645a_read(struct as3645a *flash, u8 addr)
*/

/**
- * as3645a_set_config - Set flash configuration registers
+ * as3645a_set_current - Set flash configuration registers
* @flash: The flash
*
* Configure the hardware with flash, assist and indicator currents, as well as
--
2.31.1

2021-05-28 09:21:01

by Lee Jones

[permalink] [raw]
Subject: [PATCH 01/15] leds: trigger: ledtrig-cpu: Fix incorrectly documented param 'ledevt'

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

drivers/leds/trigger/ledtrig-cpu.c:52: warning: Function parameter or member 'ledevt' not described in 'ledtrig_cpu'
drivers/leds/trigger/ledtrig-cpu.c:52: warning: Excess function parameter 'evt' description in 'ledtrig_cpu'

Cc: Pavel Machek <[email protected]>
Cc: Linus Walleij <[email protected]>
Cc: Bryan Wu <[email protected]>
Cc: [email protected]
Signed-off-by: Lee Jones <[email protected]>
---
drivers/leds/trigger/ledtrig-cpu.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/leds/trigger/ledtrig-cpu.c b/drivers/leds/trigger/ledtrig-cpu.c
index fca62d5035909..8af4f9bb9cde8 100644
--- a/drivers/leds/trigger/ledtrig-cpu.c
+++ b/drivers/leds/trigger/ledtrig-cpu.c
@@ -43,7 +43,7 @@ static atomic_t num_active_cpus = ATOMIC_INIT(0);

/**
* ledtrig_cpu - emit a CPU event as a trigger
- * @evt: CPU event to be emitted
+ * @ledevt: CPU event to be emitted
*
* Emit a CPU event on a CPU core, which will trigger a
* bound LED to turn on or turn off.
--
2.31.1

2021-05-28 09:21:28

by Lee Jones

[permalink] [raw]
Subject: [PATCH 09/15] leds: leds-lm3530: Fix incorrect spelling of 'brightness'

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

drivers/leds/leds-lm3530.c:113: warning: Function parameter or member 'brightness' not described in 'lm3530_data'

Cc: Pavel Machek <[email protected]>
Cc: Kumar SAHU <[email protected]>
Cc: Dan Murphy <[email protected]>
Cc: [email protected]
Signed-off-by: Lee Jones <[email protected]>
---
drivers/leds/leds-lm3530.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/leds/leds-lm3530.c b/drivers/leds/leds-lm3530.c
index 2db455efd4b17..e72393534b721 100644
--- a/drivers/leds/leds-lm3530.c
+++ b/drivers/leds/leds-lm3530.c
@@ -99,7 +99,7 @@ static struct lm3530_mode_map mode_map[] = {
* @pdata: LM3530 platform data
* @mode: mode of operation - manual, ALS, PWM
* @regulator: regulator
- * @brighness: previous brightness value
+ * @brightness: previous brightness value
* @enable: regulator is enabled
*/
struct lm3530_data {
--
2.31.1

2021-05-28 09:24:50

by Lee Jones

[permalink] [raw]
Subject: [PATCH 14/15] leds: leds-lm3692x: Demote non-complete kernel-doc

Needs updating by the author to re-promote.

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

drivers/leds/leds-lm3692x.c:121: warning: Function parameter or member 'boost_ctrl' not described in 'lm3692x_led'
drivers/leds/leds-lm3692x.c:121: warning: Function parameter or member 'brightness_ctrl' not described in 'lm3692x_led'
drivers/leds/leds-lm3692x.c:121: warning: Function parameter or member 'enabled' not described in 'lm3692x_led'

Cc: Pavel Machek <[email protected]>
Cc: Liam Girdwood <[email protected]>
Cc: Mark Brown <[email protected]>
Cc: Dan Murphy <[email protected]>
Cc: [email protected]
Signed-off-by: Lee Jones <[email protected]>
---
drivers/leds/leds-lm3692x.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/leds/leds-lm3692x.c b/drivers/leds/leds-lm3692x.c
index a2ab6bd5de111..f386766b2c4c1 100644
--- a/drivers/leds/leds-lm3692x.c
+++ b/drivers/leds/leds-lm3692x.c
@@ -95,7 +95,7 @@
#define LM3692X_FAULT_FLAG_SHRT BIT(3)
#define LM3692X_FAULT_FLAG_OPEN BIT(4)

-/**
+/*
* struct lm3692x_led
* @lock: Lock for reading/writing the device
* @client: Pointer to the I2C client
--
2.31.1

2021-05-28 09:25:00

by Lee Jones

[permalink] [raw]
Subject: [PATCH 12/15] leds: leds-mlxreg: Fix incorrect documentation of struct member 'led_cdev' and 'led_cdev_name'

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

drivers/leds/leds-mlxreg.c:42: warning: Function parameter or member 'led_cdev' not described in 'mlxreg_led_data'
drivers/leds/leds-mlxreg.c:42: warning: Function parameter or member 'led_cdev_name' not described in 'mlxreg_led_data'

Cc: Vadim Pasternak <[email protected]>
Cc: Pavel Machek <[email protected]>
Cc: [email protected]
Signed-off-by: Lee Jones <[email protected]>
---
drivers/leds/leds-mlxreg.c | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/drivers/leds/leds-mlxreg.c b/drivers/leds/leds-mlxreg.c
index 82aea1cd0c125..b7855c93bd725 100644
--- a/drivers/leds/leds-mlxreg.c
+++ b/drivers/leds/leds-mlxreg.c
@@ -28,10 +28,11 @@
* struct mlxreg_led_data - led control data:
*
* @data: led configuration data;
- * @led_classdev: led class data;
+ * @led_cdev: led class data;
* @base_color: base led color (other colors have constant offset from base);
* @led_data: led data;
* @data_parent: pointer to private device control data of parent;
+ * @led_cdev_name: class device name
*/
struct mlxreg_led_data {
struct mlxreg_core_data *data;
--
2.31.1

2021-05-28 09:34:15

by Sakari Ailus

[permalink] [raw]
Subject: Re: [PATCH 05/15] leds: leds-as3645a: Fix function name 'as3645a_set_current()'

Hi Lee,

On Fri, May 28, 2021 at 10:06:19AM +0100, Lee Jones wrote:
> Fixes the following W=1 kernel build warning(s):
>
> drivers/leds/leds-as3645a.c:198: warning: expecting prototype for as3645a_set_config(). Prototype was for as3645a_set_current() instead
>
> Cc: Sakari Ailus <[email protected]>
> Cc: Pavel Machek <[email protected]>
> Cc: Laurent Pinchart <[email protected]>
> Cc: [email protected]
> Signed-off-by: Lee Jones <[email protected]>
> ---
> drivers/leds/leds-as3645a.c | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/drivers/leds/leds-as3645a.c b/drivers/leds/leds-as3645a.c
> index e8922fa033796..c41937ff8fd33 100644
> --- a/drivers/leds/leds-as3645a.c
> +++ b/drivers/leds/leds-as3645a.c
> @@ -185,7 +185,7 @@ static int as3645a_read(struct as3645a *flash, u8 addr)
> */
>
> /**
> - * as3645a_set_config - Set flash configuration registers
> + * as3645a_set_current - Set flash configuration registers
> * @flash: The flash
> *
> * Configure the hardware with flash, assist and indicator currents, as well as

Thanks for the patch.

The entire comment could be removed. It's wrong and doesn't really tell
more than what you can read in the two functions below (the two are result
of splitting one the documentation was written for).

--
Kind regards,

Sakari Ailus

2021-05-28 09:41:11

by Pavel Machek

[permalink] [raw]
Subject: Re: [PATCH 05/15] leds: leds-as3645a: Fix function name 'as3645a_set_current()'

Hi!

> > drivers/leds/leds-as3645a.c:198: warning: expecting prototype for as3645a_set_config(). Prototype was for as3645a_set_current() instead
> >
> > Cc: Sakari Ailus <[email protected]>
> > Cc: Pavel Machek <[email protected]>
> > Cc: Laurent Pinchart <[email protected]>
> > Cc: [email protected]
> > Signed-off-by: Lee Jones <[email protected]>
> > ---
> > drivers/leds/leds-as3645a.c | 2 +-
> > 1 file changed, 1 insertion(+), 1 deletion(-)
> >
> > diff --git a/drivers/leds/leds-as3645a.c b/drivers/leds/leds-as3645a.c
> > index e8922fa033796..c41937ff8fd33 100644
> > --- a/drivers/leds/leds-as3645a.c
> > +++ b/drivers/leds/leds-as3645a.c
> > @@ -185,7 +185,7 @@ static int as3645a_read(struct as3645a *flash, u8 addr)
> > */
> >
> > /**
> > - * as3645a_set_config - Set flash configuration registers
> > + * as3645a_set_current - Set flash configuration registers
> > * @flash: The flash
> > *
> > * Configure the hardware with flash, assist and indicator currents, as well as
>
> Thanks for the patch.
>
> The entire comment could be removed. It's wrong and doesn't really tell
> more than what you can read in the two functions below (the two are result
> of splitting one the documentation was written for).

I just took the patch, I'll happily take a follow up.

Best regards,
Pavel
--
http://www.livejournal.com/~pavelmachek


Attachments:
(No filename) (1.41 kB)
signature.asc (188.00 B)
Digital signature
Download all attachments

2021-05-28 09:41:29

by Pavel Machek

[permalink] [raw]
Subject: Re: [PATCH 14/15] leds: leds-lm3692x: Demote non-complete kernel-doc

Hi!

> Needs updating by the author to re-promote.
>
> Fixes the following W=1 kernel build warning(s):
>
> drivers/leds/leds-lm3692x.c:121: warning: Function parameter or member 'boost_ctrl' not described in 'lm3692x_led'
> drivers/leds/leds-lm3692x.c:121: warning: Function parameter or member 'brightness_ctrl' not described in 'lm3692x_led'
> drivers/leds/leds-lm3692x.c:121: warning: Function parameter or member 'enabled' not described in 'lm3692x_led'
>

I'm not taking this one. I wanted to take the rest, but "leds:
tlc591xx: fix return value check in tlc591xx_probe()" did not apply.

I took the rest.

Thanks and best regards,
Pavel
--
http://www.livejournal.com/~pavelmachek


Attachments:
(No filename) (721.00 B)
signature.asc (188.00 B)
Digital signature
Download all attachments

2021-05-28 09:59:42

by Lee Jones

[permalink] [raw]
Subject: Re: [PATCH 14/15] leds: leds-lm3692x: Demote non-complete kernel-doc

On Fri, 28 May 2021, Pavel Machek wrote:

> Hi!
>
> > Needs updating by the author to re-promote.
> >
> > Fixes the following W=1 kernel build warning(s):
> >
> > drivers/leds/leds-lm3692x.c:121: warning: Function parameter or member 'boost_ctrl' not described in 'lm3692x_led'
> > drivers/leds/leds-lm3692x.c:121: warning: Function parameter or member 'brightness_ctrl' not described in 'lm3692x_led'
> > drivers/leds/leds-lm3692x.c:121: warning: Function parameter or member 'enabled' not described in 'lm3692x_led'
> >
>
> I'm not taking this one.

You didn't say why.

> I wanted to take the rest, but "leds:
> tlc591xx: fix return value check in tlc591xx_probe()" did not apply.

I will rebase on today's -next and resubmit.

> I took the rest.

Thank you.

--
Lee Jones [李琼斯]
Senior Technical Lead - Developer Services
Linaro.org │ Open source software for Arm SoCs
Follow Linaro: Facebook | Twitter | Blog

2021-05-28 10:05:49

by Alexander Dahl

[permalink] [raw]
Subject: Re: [PATCH 01/15] leds: trigger: ledtrig-cpu: Fix incorrectly documented param 'ledevt'

Hello,

Am Freitag, 28. Mai 2021, 11:06:15 CEST schrieb Lee Jones:
> Fixes the following W=1 kernel build warning(s):
>
> drivers/leds/trigger/ledtrig-cpu.c:52: warning: Function parameter or
> member 'ledevt' not described in 'ledtrig_cpu'
> drivers/leds/trigger/ledtrig-cpu.c:52: warning: Excess function parameter
> 'evt' description in 'ledtrig_cpu'
>
> Cc: Pavel Machek <[email protected]>
> Cc: Linus Walleij <[email protected]>
> Cc: Bryan Wu <[email protected]>
> Cc: [email protected]
> Signed-off-by: Lee Jones <[email protected]>
> ---
> drivers/leds/trigger/ledtrig-cpu.c | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/drivers/leds/trigger/ledtrig-cpu.c
> b/drivers/leds/trigger/ledtrig-cpu.c index fca62d5035909..8af4f9bb9cde8
> 100644
> --- a/drivers/leds/trigger/ledtrig-cpu.c
> +++ b/drivers/leds/trigger/ledtrig-cpu.c
> @@ -43,7 +43,7 @@ static atomic_t num_active_cpus = ATOMIC_INIT(0);
>
> /**
> * ledtrig_cpu - emit a CPU event as a trigger
> - * @evt: CPU event to be emitted
> + * @ledevt: CPU event to be emitted
> *
> * Emit a CPU event on a CPU core, which will trigger a
> * bound LED to turn on or turn off.

Reviewed-by: Alexander Dahl <[email protected]>

Greets
Alex




2021-05-28 11:39:22

by Lee Jones

[permalink] [raw]
Subject: [PATCH 08/15] leds: leds-lp3944: Provide missing function names in documentation headers

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

drivers/leds/leds-lp3944.c:95: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
drivers/leds/leds-lp3944.c:126: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
drivers/leds/leds-lp3944.c:158: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst

Cc: Pavel Machek <[email protected]>
Cc: Antonio Ospite <[email protected]>
Cc: [email protected]
Signed-off-by: Lee Jones <[email protected]>
---
drivers/leds/leds-lp3944.c | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/drivers/leds/leds-lp3944.c b/drivers/leds/leds-lp3944.c
index 838e6f19d37e5..437c711b2a27e 100644
--- a/drivers/leds/leds-lp3944.c
+++ b/drivers/leds/leds-lp3944.c
@@ -92,7 +92,7 @@ static int lp3944_reg_write(struct i2c_client *client, u8 reg, u8 value)
}

/**
- * Set the period for DIM status
+ * lp3944_dim_set_period() - Set the period for DIM status
*
* @client: the i2c client
* @dim: either LP3944_DIM0 or LP3944_DIM1
@@ -123,7 +123,7 @@ static int lp3944_dim_set_period(struct i2c_client *client, u8 dim, u16 period)
}

/**
- * Set the duty cycle for DIM status
+ * lp3944_dim_set_dutycycle - Set the duty cycle for DIM status
*
* @client: the i2c client
* @dim: either LP3944_DIM0 or LP3944_DIM1
@@ -155,7 +155,7 @@ static int lp3944_dim_set_dutycycle(struct i2c_client *client, u8 dim,
}

/**
- * Set the led status
+ * lp3944_led_set() - Set the led status
*
* @led: a lp3944_led_data structure
* @status: one of LP3944_LED_STATUS_OFF
--
2.31.1

2021-05-28 11:39:26

by Lee Jones

[permalink] [raw]
Subject: [PATCH 10/15] leds: leds-lm3692x: Fix some kernel-doc formatting issues

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

drivers/leds/leds-lm3692x.c:121: warning: Function parameter or member 'lock' not described in 'lm3692x_led'
drivers/leds/leds-lm3692x.c:121: warning: Function parameter or member 'client' not described in 'lm3692x_led'
drivers/leds/leds-lm3692x.c:121: warning: Function parameter or member 'led_dev' not described in 'lm3692x_led'
drivers/leds/leds-lm3692x.c:121: warning: Function parameter or member 'regmap' not described in 'lm3692x_led'
drivers/leds/leds-lm3692x.c:121: warning: Function parameter or member 'enable_gpio' not described in 'lm3692x_led'
drivers/leds/leds-lm3692x.c:121: warning: Function parameter or member 'regulator' not described in 'lm3692x_led'
drivers/leds/leds-lm3692x.c:121: warning: Function parameter or member 'led_enable' not described in 'lm3692x_led'
drivers/leds/leds-lm3692x.c:121: warning: Function parameter or member 'model_id' not described in 'lm3692x_led'
drivers/leds/leds-lm3692x.c:121: warning: Function parameter or member 'boost_ctrl' not described in 'lm3692x_led'
drivers/leds/leds-lm3692x.c:121: warning: Function parameter or member 'brightness_ctrl' not described in 'lm3692x_led'
drivers/leds/leds-lm3692x.c:121: warning: Function parameter or member 'enabled' not described in 'lm3692x_led'

Cc: Pavel Machek <[email protected]>
Cc: Liam Girdwood <[email protected]>
Cc: Mark Brown <[email protected]>
Cc: Dan Murphy <[email protected]>
Cc: [email protected]
Signed-off-by: Lee Jones <[email protected]>
---
drivers/leds/leds-lm3692x.c | 18 +++++++++---------
1 file changed, 9 insertions(+), 9 deletions(-)

diff --git a/drivers/leds/leds-lm3692x.c b/drivers/leds/leds-lm3692x.c
index e945de45388ca..a2ab6bd5de111 100644
--- a/drivers/leds/leds-lm3692x.c
+++ b/drivers/leds/leds-lm3692x.c
@@ -96,15 +96,15 @@
#define LM3692X_FAULT_FLAG_OPEN BIT(4)

/**
- * struct lm3692x_led -
- * @lock - Lock for reading/writing the device
- * @client - Pointer to the I2C client
- * @led_dev - LED class device pointer
- * @regmap - Devices register map
- * @enable_gpio - VDDIO/EN gpio to enable communication interface
- * @regulator - LED supply regulator pointer
- * @led_enable - LED sync to be enabled
- * @model_id - Current device model ID enumerated
+ * struct lm3692x_led
+ * @lock: Lock for reading/writing the device
+ * @client: Pointer to the I2C client
+ * @led_dev: LED class device pointer
+ * @regmap: Devices register map
+ * @enable_gpio: VDDIO/EN gpio to enable communication interface
+ * @regulator: LED supply regulator pointer
+ * @led_enable: LED sync to be enabled
+ * @model_id: Current device model ID enumerated
*/
struct lm3692x_led {
struct mutex lock;
--
2.31.1

2021-05-28 11:40:45

by Lee Jones

[permalink] [raw]
Subject: [PATCH 04/15] leds: leds-bcm6328: Demote kernel-doc abuse

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

drivers/leds/leds-bcm6328.c:97: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst

Cc: Pavel Machek <[email protected]>
Cc: "Fernández Rojas" <[email protected]>
Cc: Jonas Gorski <[email protected]>
Cc: [email protected]
Signed-off-by: Lee Jones <[email protected]>
---
drivers/leds/leds-bcm6328.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/leds/leds-bcm6328.c b/drivers/leds/leds-bcm6328.c
index 226d17d253ed3..2d4d87957a300 100644
--- a/drivers/leds/leds-bcm6328.c
+++ b/drivers/leds/leds-bcm6328.c
@@ -93,7 +93,7 @@ static unsigned long bcm6328_led_read(void __iomem *reg)
#endif
}

-/**
+/*
* LEDMode 64 bits / 24 LEDs
* bits [31:0] -> LEDs 8-23
* bits [47:32] -> LEDs 0-7
--
2.31.1

2021-05-28 11:40:50

by Lee Jones

[permalink] [raw]
Subject: [PATCH 03/15] leds: led-class: Fix incorrectly documented param 'dev'

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

drivers/leds/led-class.c:521: warning: Function parameter or member 'dev' not described in 'devm_led_classdev_unregister'
drivers/leds/led-class.c:521: warning: Excess function parameter 'parent' description in 'devm_led_classdev_unregister'

Cc: Pavel Machek <[email protected]>
Cc: John Lenz <[email protected]>
Cc: Richard Purdie <[email protected]>
Cc: [email protected]
Signed-off-by: Lee Jones <[email protected]>
---
drivers/leds/led-class.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/leds/led-class.c b/drivers/leds/led-class.c
index 2e495ff678562..16271a1de12a7 100644
--- a/drivers/leds/led-class.c
+++ b/drivers/leds/led-class.c
@@ -513,7 +513,7 @@ static int devm_led_classdev_match(struct device *dev, void *res, void *data)

/**
* devm_led_classdev_unregister() - resource managed led_classdev_unregister()
- * @parent: The device to unregister.
+ * @dev: The device to unregister.
* @led_cdev: the led_classdev structure for this device.
*/
void devm_led_classdev_unregister(struct device *dev,
--
2.31.1

2021-05-28 11:41:01

by Lee Jones

[permalink] [raw]
Subject: [PATCH 06/15] leds: leds-blinkm: Remove unused variable 'ret'

Function returns void anyway.

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

drivers/leds/leds-blinkm.c: In function ‘blinkm_init_hw’:
drivers/leds/leds-blinkm.c:483:6: warning: variable ‘ret’ set but not used [-Wunused-but-set-variable]

Cc: Jan-Simon Moeller <[email protected]>
Cc: Pavel Machek <[email protected]>
Cc: "Jan-Simon Möller" <[email protected]>
Cc: [email protected]
Signed-off-by: Lee Jones <[email protected]>
---
drivers/leds/leds-blinkm.c | 5 ++---
1 file changed, 2 insertions(+), 3 deletions(-)

diff --git a/drivers/leds/leds-blinkm.c b/drivers/leds/leds-blinkm.c
index b4e1fdff4186a..bd7d0d5cf3b62 100644
--- a/drivers/leds/leds-blinkm.c
+++ b/drivers/leds/leds-blinkm.c
@@ -480,9 +480,8 @@ static int blinkm_led_blue_set(struct led_classdev *led_cdev,

static void blinkm_init_hw(struct i2c_client *client)
{
- int ret;
- ret = blinkm_transfer_hw(client, BLM_STOP_SCRIPT);
- ret = blinkm_transfer_hw(client, BLM_GO_RGB);
+ blinkm_transfer_hw(client, BLM_STOP_SCRIPT);
+ blinkm_transfer_hw(client, BLM_GO_RGB);
}

static int blinkm_test_run(struct i2c_client *client)
--
2.31.1

2021-05-28 11:41:06

by Lee Jones

[permalink] [raw]
Subject: [PATCH 11/15] leds: leds-lm3697: Provide some missing descriptions for struct members

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

drivers/leds/leds-lm3697.c:60: warning: Function parameter or member 'enabled' not described in 'lm3697_led'
drivers/leds/leds-lm3697.c:60: warning: Function parameter or member 'num_leds' not described in 'lm3697_led'
drivers/leds/leds-lm3697.c:84: warning: Function parameter or member 'bank_cfg' not described in 'lm3697'
drivers/leds/leds-lm3697.c:84: warning: Function parameter or member 'num_banks' not described in 'lm3697'

Cc: Pavel Machek <[email protected]>
Cc: Dan Murphy <[email protected]>
Cc: [email protected]
Signed-off-by: Lee Jones <[email protected]>
---
drivers/leds/leds-lm3697.c | 4 ++++
1 file changed, 4 insertions(+)

diff --git a/drivers/leds/leds-lm3697.c b/drivers/leds/leds-lm3697.c
index 7d216cdb91a8a..0d10d12134479 100644
--- a/drivers/leds/leds-lm3697.c
+++ b/drivers/leds/leds-lm3697.c
@@ -47,6 +47,8 @@
* @lmu_data: Register and setting values for common code
* @control_bank: Control bank the LED is associated to. 0 is control bank A
* 1 is control bank B
+ * @enabled: LED brightness level (or LED_OFF)
+ * @num_leds: Number of LEDs available
*/
struct lm3697_led {
u32 hvled_strings[LM3697_MAX_LED_STRINGS];
@@ -68,6 +70,8 @@ struct lm3697_led {
* @dev: Pointer to the devices device struct
* @lock: Lock for reading/writing the device
* @leds: Array of LED strings
+ * @bank_cfg: OUTPUT_CONFIG register values
+ * @num_banks: Number of control banks
*/
struct lm3697 {
struct gpio_desc *enable_gpio;
--
2.31.1

2021-05-28 11:41:11

by Lee Jones

[permalink] [raw]
Subject: [PATCH 15/15] leds: leds-mlxcpld: Fix a bunch of kernel-doc formatting issues

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

drivers/leds/leds-mlxcpld.c:72: warning: cannot understand function prototype: 'struct mlxcpld_param '
drivers/leds/leds-mlxcpld.c:83: warning: cannot understand function prototype: 'struct mlxcpld_led_priv '
drivers/leds/leds-mlxcpld.c:98: warning: cannot understand function prototype: 'struct mlxcpld_led_profile '
drivers/leds/leds-mlxcpld.c:114: warning: cannot understand function prototype: 'struct mlxcpld_led_pdata '

Cc: Vadim Pasternak <[email protected]>
Cc: Pavel Machek <[email protected]>
Cc: [email protected]
Signed-off-by: Lee Jones <[email protected]>
---
drivers/leds/leds-mlxcpld.c | 38 ++++++++++++++++++-------------------
1 file changed, 19 insertions(+), 19 deletions(-)

diff --git a/drivers/leds/leds-mlxcpld.c b/drivers/leds/leds-mlxcpld.c
index f4721f8065f0f..1355c84a2919b 100644
--- a/drivers/leds/leds-mlxcpld.c
+++ b/drivers/leds/leds-mlxcpld.c
@@ -64,10 +64,10 @@
#define MLXCPLD_LED_BLINK_6HZ 83 /* ~83 msec off/on */

/**
- * mlxcpld_param - LED access parameters:
- * @offset - offset for LED access in CPLD device
- * @mask - mask for LED access in CPLD device
- * @base_color - base color code for LED
+ * struct mlxcpld_param - LED access parameters:
+ * @offset: offset for LED access in CPLD device
+ * @mask: mask for LED access in CPLD device
+ * @base_color: base color code for LED
**/
struct mlxcpld_param {
u8 offset;
@@ -76,9 +76,9 @@ struct mlxcpld_param {
};

/**
- * mlxcpld_led_priv - LED private data:
- * @cled - LED class device instance
- * @param - LED CPLD access parameters
+ * struct mlxcpld_led_priv - LED private data:
+ * @cled: LED class device instance
+ * @param: LED CPLD access parameters
**/
struct mlxcpld_led_priv {
struct led_classdev cdev;
@@ -88,12 +88,12 @@ struct mlxcpld_led_priv {
#define cdev_to_priv(c) container_of(c, struct mlxcpld_led_priv, cdev)

/**
- * mlxcpld_led_profile - system LED profile (defined per system class):
- * @offset - offset for LED access in CPLD device
- * @mask - mask for LED access in CPLD device
- * @base_color - base color code
- * @brightness - default brightness setting (on/off)
- * @name - LED name
+ * struct mlxcpld_led_profile - system LED profile (defined per system class):
+ * @offset: offset for LED access in CPLD device
+ * @mask: mask for LED access in CPLD device
+ * @base_color: base color code
+ * @brightness: default brightness setting (on/off)
+ * @name: LED name
**/
struct mlxcpld_led_profile {
u8 offset;
@@ -104,12 +104,12 @@ struct mlxcpld_led_profile {
};

/**
- * mlxcpld_led_pdata - system LED private data
- * @pdev - platform device pointer
- * @pled - LED class device instance
- * @profile - system configuration profile
- * @num_led_instances - number of LED instances
- * @lock - device access lock
+ * struct mlxcpld_led_pdata - system LED private data
+ * @pdev: platform device pointer
+ * @pled: LED class device instance
+ * @profile: system configuration profile
+ * @num_led_instances: number of LED instances
+ * @lock: device access lock
**/
struct mlxcpld_led_pdata {
struct platform_device *pdev;
--
2.31.1

2021-05-28 11:42:53

by Lee Jones

[permalink] [raw]
Subject: Re: [PATCH 05/15] leds: leds-as3645a: Fix function name 'as3645a_set_current()'

On Fri, 28 May 2021, Pavel Machek wrote:

> Hi!
>
> > > drivers/leds/leds-as3645a.c:198: warning: expecting prototype for as3645a_set_config(). Prototype was for as3645a_set_current() instead
> > >
> > > Cc: Sakari Ailus <[email protected]>
> > > Cc: Pavel Machek <[email protected]>
> > > Cc: Laurent Pinchart <[email protected]>
> > > Cc: [email protected]
> > > Signed-off-by: Lee Jones <[email protected]>
> > > ---
> > > drivers/leds/leds-as3645a.c | 2 +-
> > > 1 file changed, 1 insertion(+), 1 deletion(-)
> > >
> > > diff --git a/drivers/leds/leds-as3645a.c b/drivers/leds/leds-as3645a.c
> > > index e8922fa033796..c41937ff8fd33 100644
> > > --- a/drivers/leds/leds-as3645a.c
> > > +++ b/drivers/leds/leds-as3645a.c
> > > @@ -185,7 +185,7 @@ static int as3645a_read(struct as3645a *flash, u8 addr)
> > > */
> > >
> > > /**
> > > - * as3645a_set_config - Set flash configuration registers
> > > + * as3645a_set_current - Set flash configuration registers
> > > * @flash: The flash
> > > *
> > > * Configure the hardware with flash, assist and indicator currents, as well as
> >
> > Thanks for the patch.
> >
> > The entire comment could be removed. It's wrong and doesn't really tell
> > more than what you can read in the two functions below (the two are result
> > of splitting one the documentation was written for).
>
> I just took the patch, I'll happily take a follow up.

I'll follow-up. No problem.

--
Lee Jones [李琼斯]
Senior Technical Lead - Developer Services
Linaro.org │ Open source software for Arm SoCs
Follow Linaro: Facebook | Twitter | Blog

2021-05-28 11:56:50

by Lee Jones

[permalink] [raw]
Subject: [PATCH 13/15] leds: leds-lp8860: Fix kernel-doc related formatting issues

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

drivers/leds/leds-lp8860.c:105: warning: Function parameter or member 'lock' not described in 'lp8860_led'
drivers/leds/leds-lp8860.c:105: warning: Function parameter or member 'client' not described in 'lp8860_led'
drivers/leds/leds-lp8860.c:105: warning: Function parameter or member 'led_dev' not described in 'lp8860_led'
drivers/leds/leds-lp8860.c:105: warning: Function parameter or member 'regmap' not described in 'lp8860_led'
drivers/leds/leds-lp8860.c:105: warning: Function parameter or member 'eeprom_regmap' not described in 'lp8860_led'
drivers/leds/leds-lp8860.c:105: warning: Function parameter or member 'enable_gpio' not described in 'lp8860_led'
drivers/leds/leds-lp8860.c:105: warning: Function parameter or member 'regulator' not described in 'lp8860_led'

Cc: Pavel Machek <[email protected]>
Cc: Dan Murphy <[email protected]>
Cc: [email protected]
Signed-off-by: Lee Jones <[email protected]>
---
drivers/leds/leds-lp8860.c | 16 ++++++++--------
1 file changed, 8 insertions(+), 8 deletions(-)

diff --git a/drivers/leds/leds-lp8860.c b/drivers/leds/leds-lp8860.c
index f0533a337bc15..3c693d5e3b44c 100644
--- a/drivers/leds/leds-lp8860.c
+++ b/drivers/leds/leds-lp8860.c
@@ -85,14 +85,14 @@
#define LP8860_NAME "lp8860"

/**
- * struct lp8860_led -
- * @lock - Lock for reading/writing the device
- * @client - Pointer to the I2C client
- * @led_dev - led class device pointer
- * @regmap - Devices register map
- * @eeprom_regmap - EEPROM register map
- * @enable_gpio - VDDIO/EN gpio to enable communication interface
- * @regulator - LED supply regulator pointer
+ * struct lp8860_led
+ * @lock: Lock for reading/writing the device
+ * @client: Pointer to the I2C client
+ * @led_dev: led class device pointer
+ * @regmap: Devices register map
+ * @eeprom_regmap: EEPROM register map
+ * @enable_gpio: VDDIO/EN gpio to enable communication interface
+ * @regulator: LED supply regulator pointer
*/
struct lp8860_led {
struct mutex lock;
--
2.31.1

2021-05-28 12:13:03

by Alexander Dahl

[permalink] [raw]
Subject: Re: [PATCH 03/15] leds: led-class: Fix incorrectly documented param 'dev'

Hello,

Am Fri, May 28, 2021 at 10:06:17AM +0100 schrieb Lee Jones:
> Fixes the following W=1 kernel build warning(s):
>
> drivers/leds/led-class.c:521: warning: Function parameter or member 'dev' not described in 'devm_led_classdev_unregister'
> drivers/leds/led-class.c:521: warning: Excess function parameter 'parent' description in 'devm_led_classdev_unregister'
>
> Cc: Pavel Machek <[email protected]>
> Cc: John Lenz <[email protected]>
> Cc: Richard Purdie <[email protected]>
> Cc: [email protected]
> Signed-off-by: Lee Jones <[email protected]>
> ---
> drivers/leds/led-class.c | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/drivers/leds/led-class.c b/drivers/leds/led-class.c
> index 2e495ff678562..16271a1de12a7 100644
> --- a/drivers/leds/led-class.c
> +++ b/drivers/leds/led-class.c
> @@ -513,7 +513,7 @@ static int devm_led_classdev_match(struct device *dev, void *res, void *data)
>
> /**
> * devm_led_classdev_unregister() - resource managed led_classdev_unregister()
> - * @parent: The device to unregister.
> + * @dev: The device to unregister.
> * @led_cdev: the led_classdev structure for this device.
> */
> void devm_led_classdev_unregister(struct device *dev,

Fixes: ca1bb4ee4c3a ("leds: Introduce devres helper for led_classdev_register")
Reviewed-by: Alexander Dahl <[email protected]>

Greets
Alex

2021-06-01 09:09:18

by Lee Jones

[permalink] [raw]
Subject: Re: [PATCH 03/15] leds: led-class: Fix incorrectly documented param 'dev'

On Fri, 28 May 2021, Alexander Dahl wrote:

> Hello,
>
> Am Fri, May 28, 2021 at 10:06:17AM +0100 schrieb Lee Jones:
> > Fixes the following W=1 kernel build warning(s):
> >
> > drivers/leds/led-class.c:521: warning: Function parameter or member 'dev' not described in 'devm_led_classdev_unregister'
> > drivers/leds/led-class.c:521: warning: Excess function parameter 'parent' description in 'devm_led_classdev_unregister'
> >
> > Cc: Pavel Machek <[email protected]>
> > Cc: John Lenz <[email protected]>
> > Cc: Richard Purdie <[email protected]>
> > Cc: [email protected]
> > Signed-off-by: Lee Jones <[email protected]>
> > ---
> > drivers/leds/led-class.c | 2 +-
> > 1 file changed, 1 insertion(+), 1 deletion(-)
> >
> > diff --git a/drivers/leds/led-class.c b/drivers/leds/led-class.c
> > index 2e495ff678562..16271a1de12a7 100644
> > --- a/drivers/leds/led-class.c
> > +++ b/drivers/leds/led-class.c
> > @@ -513,7 +513,7 @@ static int devm_led_classdev_match(struct device *dev, void *res, void *data)
> >
> > /**
> > * devm_led_classdev_unregister() - resource managed led_classdev_unregister()
> > - * @parent: The device to unregister.
> > + * @dev: The device to unregister.
> > * @led_cdev: the led_classdev structure for this device.
> > */
> > void devm_led_classdev_unregister(struct device *dev,
>
> Fixes: ca1bb4ee4c3a ("leds: Introduce devres helper for led_classdev_register")

Kernel-doc fix-ups do not qualify for Stable unfortunately.

> Reviewed-by: Alexander Dahl <[email protected]>

Thanks.

--
Lee Jones [李琼斯]
Senior Technical Lead - Developer Services
Linaro.org │ Open source software for Arm SoCs
Follow Linaro: Facebook | Twitter | Blog