2020-11-04 16:29:11

by Lee Jones

[permalink] [raw]
Subject: [PATCH 00/20] [Set 1/2] Rid W=1 issues from Input

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.

This is the first of 2 sets.

Lee Jones (20):
input: rmi4: rmi_bus: Fix misnaming of
'__rmi_register_function_handler's 'owner' param
input: mouse: cyapa: Fix misnaming of 'cyapa_i2c_write's 'reg' param
input: mouse: cyapa_gen5: Fix obvious abuse of kernel-doc format
input: misc: ab8500-ponkey: Fix incorrect name in 'ab8500_ponkey' doc
header
input: rmi4: rmi_f01: Struct headers are expected to start with
'struct <name>'
include: input: elan-i2c-ids: Mark 'elan_acpi_id' as __maybe_unused
input: keyboard: cros_ec_keyb: Struct headers should start with
'struct <name>'
input: rmi4: rmi_f11: Struct headers are expected to start with
'struct <name>'
input: touchscreen: resistive-adc-touch: Struct headers should start
with 'struct <name>'
input: mouse: synaptics: Place braces around empty if() body
input: keyboard: gpio_keys: Fix misnamed function parameter 'dev'
input: mouse: elantech: Demote obvious abuse of kernel-doc header
input: rmi4: rmi_f54: Provide some missing 'REPORT_TYPE' enums
input: rmi4: rmi_i2c: Provide some missing descriptions for struct
members
input: touchscreen: cyttsp4_core: Move 'cyttsp4_tch_abs_string' to
the only file that references it
input: misc: drv260x: Fix kernel-doc formatting and remove one abuse
input: misc: drv2665: Fix formatting expected by kernel-doc
input: misc: drv2667: Fix formatting and add missing member docs
input: keyboard: nomadik-ske-keypad: Provide some missing struct
member docs
input: keyboard: pmic8xxx-keypad: Fix kernel-doc formatting

drivers/input/keyboard/cros_ec_keyb.c | 5 ++--
drivers/input/keyboard/gpio_keys.c | 2 +-
drivers/input/keyboard/nomadik-ske-keypad.c | 2 ++
drivers/input/keyboard/pmic8xxx-keypad.c | 22 ++++++++--------
drivers/input/misc/ab8500-ponkey.c | 2 +-
drivers/input/misc/drv260x.c | 26 +++++++++----------
drivers/input/misc/drv2665.c | 10 +++----
drivers/input/misc/drv2667.c | 14 +++++-----
drivers/input/mouse/cyapa.c | 2 +-
drivers/input/mouse/cyapa_gen5.c | 4 +--
drivers/input/mouse/elantech.c | 2 +-
drivers/input/mouse/synaptics.c | 3 ++-
drivers/input/rmi4/rmi_bus.c | 2 +-
drivers/input/rmi4/rmi_f01.c | 1 +
drivers/input/rmi4/rmi_f11.c | 5 ++--
drivers/input/rmi4/rmi_f54.c | 6 +++++
drivers/input/rmi4/rmi_i2c.c | 4 +++
drivers/input/touchscreen/cyttsp4_core.c | 14 ++++++++++
drivers/input/touchscreen/cyttsp4_core.h | 14 ----------
.../input/touchscreen/resistive-adc-touch.c | 2 +-
include/linux/input/elan-i2c-ids.h | 2 +-
21 files changed, 80 insertions(+), 64 deletions(-)

Cc: Andrew Duggan <[email protected]>
Cc: Arjan Opmeer <[email protected]>
Cc: "at http://www.cypress.com" <[email protected]>
Cc: Benson Leung <[email protected]>
Cc: Bruce Kalk <[email protected]>
Cc: Christopher Heiny <[email protected]>
Cc: "C. Scott Ananian" <[email protected]>
Cc: Daniel Kurtz <[email protected]>
Cc: Dan Murphy <[email protected]>
Cc: David Jander <[email protected]>
Cc: Dmitry Torokhov <[email protected]>
Cc: Dudley Du <[email protected]>
Cc: [email protected]
Cc: Enric Balletbo i Serra <[email protected]>
Cc: Eugen Hristev <[email protected]>
Cc: Ferruh Yigit <[email protected]>
Cc: Guenter Roeck <[email protected]>
Cc: "Gustavo A. R. Silva" <[email protected]>
Cc: Hans de Goede <[email protected]>
Cc: Henrik Rydberg <[email protected]>
Cc: KT Liao <[email protected]>
Cc: Kumar G <[email protected]>
Cc: [email protected]
Cc: Peter Osterlund <[email protected]>
Cc: Phil Blundell <[email protected]>
Cc: Stefan Gmeiner <[email protected]>
Cc: Sundar Iyer <[email protected]>
Cc: this to <[email protected]>
Cc: Trilok Soni <[email protected]>
Cc: Vincent Huang <[email protected]>
--
2.25.1


2020-11-04 16:29:12

by Lee Jones

[permalink] [raw]
Subject: [PATCH 02/20] input: mouse: cyapa: Fix misnaming of 'cyapa_i2c_write's 'reg' param

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

drivers/input/mouse/cyapa.c:130: warning: Function parameter or member 'reg' not described in 'cyapa_i2c_write'
drivers/input/mouse/cyapa.c:130: warning: Excess function parameter 'ret' description in 'cyapa_i2c_write'

Cc: Dmitry Torokhov <[email protected]>
Cc: Henrik Rydberg <[email protected]>
Cc: Dudley Du <[email protected]>
Cc: Daniel Kurtz <[email protected]>
Cc: Benson Leung <[email protected]>
Cc: [email protected]
Signed-off-by: Lee Jones <[email protected]>
---
drivers/input/mouse/cyapa.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/input/mouse/cyapa.c b/drivers/input/mouse/cyapa.c
index c675f156948b5..dacf7c0e43f98 100644
--- a/drivers/input/mouse/cyapa.c
+++ b/drivers/input/mouse/cyapa.c
@@ -119,7 +119,7 @@ static ssize_t cyapa_i2c_read(struct cyapa *cyapa, u8 reg, size_t len,
/**
* cyapa_i2c_write - Execute i2c block data write operation
* @cyapa: Handle to this driver
- * @ret: Offset of the data to written in the register map
+ * @reg: Offset of the data to written in the register map
* @len: number of bytes to write
* @values: Data to be written
*
--
2.25.1

2020-11-04 16:29:43

by Lee Jones

[permalink] [raw]
Subject: [PATCH 16/20] input: misc: drv260x: Fix kernel-doc formatting and remove one abuse

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

drivers/input/misc/drv260x.c:194: warning: Function parameter or member 'input_dev' not described in 'drv260x_data'
drivers/input/misc/drv260x.c:194: warning: Function parameter or member 'client' not described in 'drv260x_data'
drivers/input/misc/drv260x.c:194: warning: Function parameter or member 'regmap' not described in 'drv260x_data'
drivers/input/misc/drv260x.c:194: warning: Function parameter or member 'work' not described in 'drv260x_data'
drivers/input/misc/drv260x.c:194: warning: Function parameter or member 'enable_gpio' not described in 'drv260x_data'
drivers/input/misc/drv260x.c:194: warning: Function parameter or member 'regulator' not described in 'drv260x_data'
drivers/input/misc/drv260x.c:194: warning: Function parameter or member 'magnitude' not described in 'drv260x_data'
drivers/input/misc/drv260x.c:194: warning: Function parameter or member 'mode' not described in 'drv260x_data'
drivers/input/misc/drv260x.c:194: warning: Function parameter or member 'library' not described in 'drv260x_data'
drivers/input/misc/drv260x.c:194: warning: Function parameter or member 'rated_voltage' not described in 'drv260x_data'
drivers/input/misc/drv260x.c:194: warning: Function parameter or member 'overdrive_voltage' not described in 'drv260x_data'
drivers/input/misc/drv260x.c:244: warning: Function parameter or member 'voltage' not described in 'drv260x_calculate_voltage'

Cc: Dmitry Torokhov <[email protected]>
Cc: Dan Murphy <[email protected]>
Cc: [email protected]
Signed-off-by: Lee Jones <[email protected]>
---
drivers/input/misc/drv260x.c | 26 +++++++++++++-------------
1 file changed, 13 insertions(+), 13 deletions(-)

diff --git a/drivers/input/misc/drv260x.c b/drivers/input/misc/drv260x.c
index 79d7fa710a714..fabe106d499d4 100644
--- a/drivers/input/misc/drv260x.c
+++ b/drivers/input/misc/drv260x.c
@@ -167,17 +167,17 @@

/**
* struct drv260x_data -
- * @input_dev - Pointer to the input device
- * @client - Pointer to the I2C client
- * @regmap - Register map of the device
- * @work - Work item used to off load the enable/disable of the vibration
- * @enable_gpio - Pointer to the gpio used for enable/disabling
- * @regulator - Pointer to the regulator for the IC
- * @magnitude - Magnitude of the vibration event
- * @mode - The operating mode of the IC (LRA_NO_CAL, ERM or LRA)
- * @library - The vibration library to be used
- * @rated_voltage - The rated_voltage of the actuator
- * @overdriver_voltage - The over drive voltage of the actuator
+ * @input_dev: Pointer to the input device
+ * @client: Pointer to the I2C client
+ * @regmap: Register map of the device
+ * @work: Work item used to off load the enable/disable of the vibration
+ * @enable_gpio: Pointer to the gpio used for enable/disabling
+ * @regulator: Pointer to the regulator for the IC
+ * @magnitude: Magnitude of the vibration event
+ * @mode: The operating mode of the IC (LRA_NO_CAL, ERM or LRA)
+ * @library: The vibration library to be used
+ * @rated_voltage: The rated_voltage of the actuator
+ * @overdriver_voltage: The over drive voltage of the actuator
**/
struct drv260x_data {
struct input_dev *input_dev;
@@ -234,12 +234,12 @@ static const struct reg_default drv260x_reg_defs[] = {
#define DRV260X_DEF_RATED_VOLT 0x90
#define DRV260X_DEF_OD_CLAMP_VOLT 0x90

-/**
+/*
* Rated and Overdriver Voltages:
* Calculated using the formula r = v * 255 / 5.6
* where r is what will be written to the register
* and v is the rated or overdriver voltage of the actuator
- **/
+ */
static int drv260x_calculate_voltage(unsigned int voltage)
{
return (voltage * 255 / 5600);
--
2.25.1

2020-11-04 16:30:22

by Lee Jones

[permalink] [raw]
Subject: [PATCH 01/20] input: rmi4: rmi_bus: Fix misnaming of '__rmi_register_function_handler's 'owner' param

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

drivers/input/rmi4/rmi_bus.c:299: warning: Function parameter or member 'owner' not described in '__rmi_register_function_handler'
drivers/input/rmi4/rmi_bus.c:299: warning: Excess function parameter 'module' description in '__rmi_register_function_handler'

Cc: Dmitry Torokhov <[email protected]>
Cc: Vincent Huang <[email protected]>
Cc: Hans de Goede <[email protected]>
Cc: Andrew Duggan <[email protected]>
Cc: Christopher Heiny <[email protected]>
Cc: [email protected]
Signed-off-by: Lee Jones <[email protected]>
---
drivers/input/rmi4/rmi_bus.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/input/rmi4/rmi_bus.c b/drivers/input/rmi4/rmi_bus.c
index 47d1b97ed6cf3..24f31a5c0e04a 100644
--- a/drivers/input/rmi4/rmi_bus.c
+++ b/drivers/input/rmi4/rmi_bus.c
@@ -286,7 +286,7 @@ void rmi_unregister_function(struct rmi_function *fn)
/**
* rmi_register_function_handler - register a handler for an RMI function
* @handler: RMI handler that should be registered.
- * @module: pointer to module that implements the handler
+ * @owner: pointer to module that implements the handler
* @mod_name: name of the module implementing the handler
*
* This function performs additional setup of RMI function handler and
--
2.25.1

2020-11-04 16:31:20

by Lee Jones

[permalink] [raw]
Subject: [PATCH 03/20] input: mouse: cyapa_gen5: Fix obvious abuse of kernel-doc format

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

drivers/input/mouse/cyapa_gen5.c:392: warning: Function parameter or member 'cyapa' not described in 'cyapa_i2c_pip_write'
drivers/input/mouse/cyapa_gen5.c:392: warning: Function parameter or member 'buf' not described in 'cyapa_i2c_pip_write'
drivers/input/mouse/cyapa_gen5.c:392: warning: Function parameter or member 'size' not described in 'cyapa_i2c_pip_write'
drivers/input/mouse/cyapa_gen5.c:444: warning: Function parameter or member 'cyapa' not described in 'cyapa_empty_pip_output_data'
drivers/input/mouse/cyapa_gen5.c:444: warning: Function parameter or member 'buf' not described in 'cyapa_empty_pip_output_data'
drivers/input/mouse/cyapa_gen5.c:444: warning: Function parameter or member 'len' not described in 'cyapa_empty_pip_output_data'
drivers/input/mouse/cyapa_gen5.c:444: warning: Function parameter or member 'func' not described in 'cyapa_empty_pip_output_data'

Cc: Dmitry Torokhov <[email protected]>
Cc: Henrik Rydberg <[email protected]>
Cc: "Gustavo A. R. Silva" <[email protected]>
Cc: Dudley Du <[email protected]>
Cc: [email protected]
Signed-off-by: Lee Jones <[email protected]>
---
drivers/input/mouse/cyapa_gen5.c | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/drivers/input/mouse/cyapa_gen5.c b/drivers/input/mouse/cyapa_gen5.c
index bb3a63d1268d1..5c37af994b5b5 100644
--- a/drivers/input/mouse/cyapa_gen5.c
+++ b/drivers/input/mouse/cyapa_gen5.c
@@ -385,7 +385,7 @@ ssize_t cyapa_i2c_pip_read(struct cyapa *cyapa, u8 *buf, size_t size)
return size;
}

-/**
+/*
* Return a negative errno code else zero on success.
*/
ssize_t cyapa_i2c_pip_write(struct cyapa *cyapa, u8 *buf, size_t size)
@@ -435,7 +435,7 @@ static enum cyapa_pm_stage cyapa_get_pip_pm_state(struct cyapa *cyapa)
return pm_stage;
}

-/**
+/*
* This function is aimed to dump all not read data in Gen5 trackpad
* before send any command, otherwise, the interrupt line will be blocked.
*/
--
2.25.1

2020-11-04 17:49:37

by Lee Jones

[permalink] [raw]
Subject: [PATCH 05/20] input: rmi4: rmi_f01: Struct headers are expected to start with 'struct <name>'

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

drivers/input/rmi4/rmi_f01.c:106: warning: Cannot understand * @ctrl0 - see the bit definitions above.

Cc: Dmitry Torokhov <[email protected]>
Cc: [email protected]
Signed-off-by: Lee Jones <[email protected]>
---
drivers/input/rmi4/rmi_f01.c | 1 +
1 file changed, 1 insertion(+)

diff --git a/drivers/input/rmi4/rmi_f01.c b/drivers/input/rmi4/rmi_f01.c
index e623c956376e3..23618fcb1f322 100644
--- a/drivers/input/rmi4/rmi_f01.c
+++ b/drivers/input/rmi4/rmi_f01.c
@@ -103,6 +103,7 @@ struct f01_basic_properties {
#define RMI_F01_CTRL0_CONFIGURED_BIT BIT(7)

/**
+ * struct f01_device_control
* @ctrl0 - see the bit definitions above.
* @doze_interval - controls the interval between checks for finger presence
* when the touch sensor is in doze mode, in units of 10ms.
--
2.25.1

2020-11-04 18:37:05

by Lee Jones

[permalink] [raw]
Subject: [PATCH 20/20] input: keyboard: pmic8xxx-keypad: Fix kernel-doc formatting

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

drivers/input/keyboard/pmic8xxx-keypad.c:106: warning: Function parameter or member 'num_rows' not described in 'pmic8xxx_kp'
drivers/input/keyboard/pmic8xxx-keypad.c:106: warning: Function parameter or member 'num_cols' not described in 'pmic8xxx_kp'
drivers/input/keyboard/pmic8xxx-keypad.c:106: warning: Function parameter or member 'input' not described in 'pmic8xxx_kp'
drivers/input/keyboard/pmic8xxx-keypad.c:106: warning: Function parameter or member 'regmap' not described in 'pmic8xxx_kp'
drivers/input/keyboard/pmic8xxx-keypad.c:106: warning: Function parameter or member 'key_sense_irq' not described in 'pmic8xxx_kp'
drivers/input/keyboard/pmic8xxx-keypad.c:106: warning: Function parameter or member 'key_stuck_irq' not described in 'pmic8xxx_kp'
drivers/input/keyboard/pmic8xxx-keypad.c:106: warning: Function parameter or member 'keycodes' not described in 'pmic8xxx_kp'
drivers/input/keyboard/pmic8xxx-keypad.c:106: warning: Function parameter or member 'dev' not described in 'pmic8xxx_kp'
drivers/input/keyboard/pmic8xxx-keypad.c:106: warning: Function parameter or member 'keystate' not described in 'pmic8xxx_kp'
drivers/input/keyboard/pmic8xxx-keypad.c:106: warning: Function parameter or member 'stuckstate' not described in 'pmic8xxx_kp'
drivers/input/keyboard/pmic8xxx-keypad.c:106: warning: Function parameter or member 'ctrl_reg' not described in 'pmic8xxx_kp'

Cc: Dmitry Torokhov <[email protected]>
Cc: Trilok Soni <[email protected]>
Cc: [email protected]
Signed-off-by: Lee Jones <[email protected]>
---
drivers/input/keyboard/pmic8xxx-keypad.c | 22 +++++++++++-----------
1 file changed, 11 insertions(+), 11 deletions(-)

diff --git a/drivers/input/keyboard/pmic8xxx-keypad.c b/drivers/input/keyboard/pmic8xxx-keypad.c
index 91d5811d6f0e1..36bee6f5a8af0 100644
--- a/drivers/input/keyboard/pmic8xxx-keypad.c
+++ b/drivers/input/keyboard/pmic8xxx-keypad.c
@@ -76,17 +76,17 @@

/**
* struct pmic8xxx_kp - internal keypad data structure
- * @num_cols - number of columns of keypad
- * @num_rows - number of row of keypad
- * @input - input device pointer for keypad
- * @regmap - regmap handle
- * @key_sense_irq - key press/release irq number
- * @key_stuck_irq - key stuck notification irq number
- * @keycodes - array to hold the key codes
- * @dev - parent device pointer
- * @keystate - present key press/release state
- * @stuckstate - present state when key stuck irq
- * @ctrl_reg - control register value
+ * @num_cols: number of columns of keypad
+ * @num_rows: number of row of keypad
+ * @input: input device pointer for keypad
+ * @regmap: regmap handle
+ * @key_sense_irq: key press/release irq number
+ * @key_stuck_irq: key stuck notification irq number
+ * @keycodes: array to hold the key codes
+ * @dev: parent device pointer
+ * @keystate: present key press/release state
+ * @stuckstate: present state when key stuck irq
+ * @ctrl_reg: control register value
*/
struct pmic8xxx_kp {
unsigned int num_rows;
--
2.25.1

2020-11-04 18:41:40

by Benson Leung

[permalink] [raw]
Subject: Re: [PATCH 02/20] input: mouse: cyapa: Fix misnaming of 'cyapa_i2c_write's 'reg' param

Hi Lee,

On Wed, Nov 04, 2020 at 04:24:09PM +0000, Lee Jones wrote:
> Fixes the following W=1 kernel build warning(s):
>
> drivers/input/mouse/cyapa.c:130: warning: Function parameter or member 'reg' not described in 'cyapa_i2c_write'
> drivers/input/mouse/cyapa.c:130: warning: Excess function parameter 'ret' description in 'cyapa_i2c_write'
>
> Cc: Dmitry Torokhov <[email protected]>
> Cc: Henrik Rydberg <[email protected]>
> Cc: Dudley Du <[email protected]>
> Cc: Daniel Kurtz <[email protected]>
> Cc: Benson Leung <[email protected]>
> Cc: [email protected]
> Signed-off-by: Lee Jones <[email protected]>

Reviewed-by: Benson Leung <[email protected]>

> ---
> drivers/input/mouse/cyapa.c | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/drivers/input/mouse/cyapa.c b/drivers/input/mouse/cyapa.c
> index c675f156948b5..dacf7c0e43f98 100644
> --- a/drivers/input/mouse/cyapa.c
> +++ b/drivers/input/mouse/cyapa.c
> @@ -119,7 +119,7 @@ static ssize_t cyapa_i2c_read(struct cyapa *cyapa, u8 reg, size_t len,
> /**
> * cyapa_i2c_write - Execute i2c block data write operation
> * @cyapa: Handle to this driver
> - * @ret: Offset of the data to written in the register map
> + * @reg: Offset of the data to written in the register map
> * @len: number of bytes to write
> * @values: Data to be written
> *
> --
> 2.25.1
>

--
Benson Leung
Staff Software Engineer
Chrome OS Kernel
Google Inc.
[email protected]
Chromium OS Project
[email protected]


Attachments:
(No filename) (1.54 kB)
signature.asc (235.00 B)
Download all attachments

2020-11-06 13:26:13

by Lee Jones

[permalink] [raw]
Subject: Re: [PATCH 00/20] [Set 1/2] Rid W=1 issues from Input

On Wed, 04 Nov 2020, Lee Jones wrote:

> 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.
>
> This is the first of 2 sets.
>
> Lee Jones (20):
> input: rmi4: rmi_bus: Fix misnaming of
> '__rmi_register_function_handler's 'owner' param
> input: mouse: cyapa: Fix misnaming of 'cyapa_i2c_write's 'reg' param
> input: mouse: cyapa_gen5: Fix obvious abuse of kernel-doc format
> input: misc: ab8500-ponkey: Fix incorrect name in 'ab8500_ponkey' doc
> header
> input: rmi4: rmi_f01: Struct headers are expected to start with
> 'struct <name>'
> include: input: elan-i2c-ids: Mark 'elan_acpi_id' as __maybe_unused
> input: keyboard: cros_ec_keyb: Struct headers should start with
> 'struct <name>'
> input: rmi4: rmi_f11: Struct headers are expected to start with
> 'struct <name>'
> input: touchscreen: resistive-adc-touch: Struct headers should start
> with 'struct <name>'
> input: mouse: synaptics: Place braces around empty if() body
> input: keyboard: gpio_keys: Fix misnamed function parameter 'dev'
> input: mouse: elantech: Demote obvious abuse of kernel-doc header
> input: rmi4: rmi_f54: Provide some missing 'REPORT_TYPE' enums
> input: rmi4: rmi_i2c: Provide some missing descriptions for struct
> members
> input: touchscreen: cyttsp4_core: Move 'cyttsp4_tch_abs_string' to
> the only file that references it
> input: misc: drv260x: Fix kernel-doc formatting and remove one abuse
> input: misc: drv2665: Fix formatting expected by kernel-doc
> input: misc: drv2667: Fix formatting and add missing member docs
> input: keyboard: nomadik-ske-keypad: Provide some missing struct
> member docs
> input: keyboard: pmic8xxx-keypad: Fix kernel-doc formatting

Dmitry,

Seeing as these changes are orthogonal, it would probably be easier
and certainly cause a lot less mailing list churn if you would be kind
enough to apply patches that do not need re-spinning.

I will rebase, rework and re-submit the remainder early next week.

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

2020-11-09 06:15:49

by Dmitry Torokhov

[permalink] [raw]
Subject: Re: [PATCH 16/20] input: misc: drv260x: Fix kernel-doc formatting and remove one abuse

On Wed, Nov 04, 2020 at 04:24:23PM +0000, Lee Jones wrote:
> Fixes the following W=1 kernel build warning(s):
>
> drivers/input/misc/drv260x.c:194: warning: Function parameter or member 'input_dev' not described in 'drv260x_data'
> drivers/input/misc/drv260x.c:194: warning: Function parameter or member 'client' not described in 'drv260x_data'
> drivers/input/misc/drv260x.c:194: warning: Function parameter or member 'regmap' not described in 'drv260x_data'
> drivers/input/misc/drv260x.c:194: warning: Function parameter or member 'work' not described in 'drv260x_data'
> drivers/input/misc/drv260x.c:194: warning: Function parameter or member 'enable_gpio' not described in 'drv260x_data'
> drivers/input/misc/drv260x.c:194: warning: Function parameter or member 'regulator' not described in 'drv260x_data'
> drivers/input/misc/drv260x.c:194: warning: Function parameter or member 'magnitude' not described in 'drv260x_data'
> drivers/input/misc/drv260x.c:194: warning: Function parameter or member 'mode' not described in 'drv260x_data'
> drivers/input/misc/drv260x.c:194: warning: Function parameter or member 'library' not described in 'drv260x_data'
> drivers/input/misc/drv260x.c:194: warning: Function parameter or member 'rated_voltage' not described in 'drv260x_data'
> drivers/input/misc/drv260x.c:194: warning: Function parameter or member 'overdrive_voltage' not described in 'drv260x_data'
> drivers/input/misc/drv260x.c:244: warning: Function parameter or member 'voltage' not described in 'drv260x_calculate_voltage'
>
> Cc: Dmitry Torokhov <[email protected]>
> Cc: Dan Murphy <[email protected]>
> Cc: [email protected]
> Signed-off-by: Lee Jones <[email protected]>
> ---
> drivers/input/misc/drv260x.c | 26 +++++++++++++-------------
> 1 file changed, 13 insertions(+), 13 deletions(-)
>
> diff --git a/drivers/input/misc/drv260x.c b/drivers/input/misc/drv260x.c
> index 79d7fa710a714..fabe106d499d4 100644
> --- a/drivers/input/misc/drv260x.c
> +++ b/drivers/input/misc/drv260x.c
> @@ -167,17 +167,17 @@
>
> /**
> * struct drv260x_data -
> - * @input_dev - Pointer to the input device
> - * @client - Pointer to the I2C client
> - * @regmap - Register map of the device
> - * @work - Work item used to off load the enable/disable of the vibration
> - * @enable_gpio - Pointer to the gpio used for enable/disabling
> - * @regulator - Pointer to the regulator for the IC
> - * @magnitude - Magnitude of the vibration event
> - * @mode - The operating mode of the IC (LRA_NO_CAL, ERM or LRA)
> - * @library - The vibration library to be used
> - * @rated_voltage - The rated_voltage of the actuator
> - * @overdriver_voltage - The over drive voltage of the actuator
> + * @input_dev: Pointer to the input device
> + * @client: Pointer to the I2C client
> + * @regmap: Register map of the device
> + * @work: Work item used to off load the enable/disable of the vibration
> + * @enable_gpio: Pointer to the gpio used for enable/disabling
> + * @regulator: Pointer to the regulator for the IC
> + * @magnitude: Magnitude of the vibration event
> + * @mode: The operating mode of the IC (LRA_NO_CAL, ERM or LRA)
> + * @library: The vibration library to be used
> + * @rated_voltage: The rated_voltage of the actuator
> + * @overdriver_voltage: The over drive voltage of the actuator

Applied with this typo fixed as well.

> **/
> struct drv260x_data {
> struct input_dev *input_dev;
> @@ -234,12 +234,12 @@ static const struct reg_default drv260x_reg_defs[] = {
> #define DRV260X_DEF_RATED_VOLT 0x90
> #define DRV260X_DEF_OD_CLAMP_VOLT 0x90
>
> -/**
> +/*
> * Rated and Overdriver Voltages:
> * Calculated using the formula r = v * 255 / 5.6
> * where r is what will be written to the register
> * and v is the rated or overdriver voltage of the actuator
> - **/
> + */
> static int drv260x_calculate_voltage(unsigned int voltage)
> {
> return (voltage * 255 / 5600);
> --
> 2.25.1
>

Thanks.

--
Dmitry

2020-11-09 06:33:47

by Dmitry Torokhov

[permalink] [raw]
Subject: Re: [PATCH 02/20] input: mouse: cyapa: Fix misnaming of 'cyapa_i2c_write's 'reg' param

On Wed, Nov 04, 2020 at 04:24:09PM +0000, Lee Jones wrote:
> Fixes the following W=1 kernel build warning(s):
>
> drivers/input/mouse/cyapa.c:130: warning: Function parameter or member 'reg' not described in 'cyapa_i2c_write'
> drivers/input/mouse/cyapa.c:130: warning: Excess function parameter 'ret' description in 'cyapa_i2c_write'
>
> Cc: Dmitry Torokhov <[email protected]>
> Cc: Henrik Rydberg <[email protected]>
> Cc: Dudley Du <[email protected]>
> Cc: Daniel Kurtz <[email protected]>
> Cc: Benson Leung <[email protected]>
> Cc: [email protected]
> Signed-off-by: Lee Jones <[email protected]>

Applied, thank you.

--
Dmitry

2020-11-09 06:33:55

by Dmitry Torokhov

[permalink] [raw]
Subject: Re: [PATCH 03/20] input: mouse: cyapa_gen5: Fix obvious abuse of kernel-doc format

On Wed, Nov 04, 2020 at 04:24:10PM +0000, Lee Jones wrote:
> Fixes the following W=1 kernel build warning(s):
>
> drivers/input/mouse/cyapa_gen5.c:392: warning: Function parameter or member 'cyapa' not described in 'cyapa_i2c_pip_write'
> drivers/input/mouse/cyapa_gen5.c:392: warning: Function parameter or member 'buf' not described in 'cyapa_i2c_pip_write'
> drivers/input/mouse/cyapa_gen5.c:392: warning: Function parameter or member 'size' not described in 'cyapa_i2c_pip_write'
> drivers/input/mouse/cyapa_gen5.c:444: warning: Function parameter or member 'cyapa' not described in 'cyapa_empty_pip_output_data'
> drivers/input/mouse/cyapa_gen5.c:444: warning: Function parameter or member 'buf' not described in 'cyapa_empty_pip_output_data'
> drivers/input/mouse/cyapa_gen5.c:444: warning: Function parameter or member 'len' not described in 'cyapa_empty_pip_output_data'
> drivers/input/mouse/cyapa_gen5.c:444: warning: Function parameter or member 'func' not described in 'cyapa_empty_pip_output_data'
>
> Cc: Dmitry Torokhov <[email protected]>
> Cc: Henrik Rydberg <[email protected]>
> Cc: "Gustavo A. R. Silva" <[email protected]>
> Cc: Dudley Du <[email protected]>
> Cc: [email protected]
> Signed-off-by: Lee Jones <[email protected]>

Applied, thank you.

--
Dmitry

2020-11-09 22:04:41

by Dmitry Torokhov

[permalink] [raw]
Subject: Re: [PATCH 20/20] input: keyboard: pmic8xxx-keypad: Fix kernel-doc formatting

On Wed, Nov 04, 2020 at 04:24:27PM +0000, Lee Jones wrote:
> Fixes the following W=1 kernel build warning(s):
>
> drivers/input/keyboard/pmic8xxx-keypad.c:106: warning: Function parameter or member 'num_rows' not described in 'pmic8xxx_kp'
> drivers/input/keyboard/pmic8xxx-keypad.c:106: warning: Function parameter or member 'num_cols' not described in 'pmic8xxx_kp'
> drivers/input/keyboard/pmic8xxx-keypad.c:106: warning: Function parameter or member 'input' not described in 'pmic8xxx_kp'
> drivers/input/keyboard/pmic8xxx-keypad.c:106: warning: Function parameter or member 'regmap' not described in 'pmic8xxx_kp'
> drivers/input/keyboard/pmic8xxx-keypad.c:106: warning: Function parameter or member 'key_sense_irq' not described in 'pmic8xxx_kp'
> drivers/input/keyboard/pmic8xxx-keypad.c:106: warning: Function parameter or member 'key_stuck_irq' not described in 'pmic8xxx_kp'
> drivers/input/keyboard/pmic8xxx-keypad.c:106: warning: Function parameter or member 'keycodes' not described in 'pmic8xxx_kp'
> drivers/input/keyboard/pmic8xxx-keypad.c:106: warning: Function parameter or member 'dev' not described in 'pmic8xxx_kp'
> drivers/input/keyboard/pmic8xxx-keypad.c:106: warning: Function parameter or member 'keystate' not described in 'pmic8xxx_kp'
> drivers/input/keyboard/pmic8xxx-keypad.c:106: warning: Function parameter or member 'stuckstate' not described in 'pmic8xxx_kp'
> drivers/input/keyboard/pmic8xxx-keypad.c:106: warning: Function parameter or member 'ctrl_reg' not described in 'pmic8xxx_kp'
>
> Cc: Dmitry Torokhov <[email protected]>
> Cc: Trilok Soni <[email protected]>
> Cc: [email protected]
> Signed-off-by: Lee Jones <[email protected]>

Applied, thank you.

--
Dmitry

2020-11-10 00:50:54

by Dmitry Torokhov

[permalink] [raw]
Subject: Re: [PATCH 05/20] input: rmi4: rmi_f01: Struct headers are expected to start with 'struct <name>'

Hi Lee,

On Wed, Nov 04, 2020 at 04:24:12PM +0000, Lee Jones wrote:
> Fixes the following W=1 kernel build warning(s):
>
> drivers/input/rmi4/rmi_f01.c:106: warning: Cannot understand * @ctrl0 - see the bit definitions above.
>
> Cc: Dmitry Torokhov <[email protected]>
> Cc: [email protected]
> Signed-off-by: Lee Jones <[email protected]>

I folded all RMI4 patches together and added more missing field
descriptions/fixed a few things, and applied.

Thank you.

--
Dmitry