Skip to contentSkip to conversation

Rid W=1 issues from Input

PATCH In review Lee Jones 4 participants 48 messages Nov 4, 2020 – Nov 18, 2020

Subsystems (5)
lore
Share & tools
lore

Lee Jones

author
#0 lore raw

PATCH 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 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 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 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]>
Signature · 1 line
2.25.1
author
#1 lore raw

PATCH 1/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]>
---
 drivers/input/rmi4/rmi_bus.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/input/rmi4/rmi_bus.c +1 -1
index 47d1b97ed6cf3..24f31a5c0e04a 100644
@@ -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
Signature · 1 line
2.25.1
author
#2 lore raw

PATCH 2/20 input: mouse: cyapa: Fix misnaming of 'cyapa_i2c_write's 'reg' param

In reply to Lee Jones

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]>
---
 drivers/input/mouse/cyapa.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/input/mouse/cyapa.c +1 -1
index c675f156948b5..dacf7c0e43f98 100644
@@ -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
  *
Signature · 1 line
2.25.1
Reviewed-by on v1 2/20
#3 lore raw

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

Hi Lee,

Quoted 5 lines · Lee Jones

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'

Quoted 7 lines
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]>
Quoted 20 lines
---
 drivers/input/mouse/cyapa.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/input/mouse/cyapa.c +1 -1
index c675f156948b5..dacf7c0e43f98 100644
@@ -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
  *
Signature · 1 line
2.25.1
Signature · 7 lines
Benson Leung
Staff Software Engineer
Chrome OS Kernel
Google Inc.
[email protected]
Chromium OS Project
[email protected]
maintainer Applied
#4 lore raw

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

In reply to Lee Jones
Quoted 5 lines · Lee Jones

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'

Quoted 7 lines
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]>

Applied, thank you.

Signature · 1 line
Dmitry
author
#5 lore raw

PATCH 3/20 input: mouse: cyapa_gen5: Fix obvious abuse of kernel-doc format

In reply to Lee Jones

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]>
---
 drivers/input/mouse/cyapa_gen5.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
drivers/input/mouse/cyapa_gen5.c +2 -2
index bb3a63d1268d1..5c37af994b5b5 100644
@@ -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.
  */
Signature · 1 line
2.25.1
maintainer Applied
#6 lore raw

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

Quoted 10 lines · Lee Jones

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'

Quoted 6 lines
Cc Dmitry Torokhov <[email protected]>
Cc Henrik Rydberg <[email protected]>
Cc "Gustavo A. R. Silva" <[email protected]>
Cc Dudley Du <[email protected]>

Applied, thank you.

Signature · 1 line
Dmitry
author
#7 lore raw

PATCH 4/20 input: misc: ab8500-ponkey: Fix incorrect name in 'ab8500_ponkey' doc header

In reply to Lee Jones

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

drivers/input/misc/ab8500-ponkey.c:32: warning: Function parameter or member 'idev' not described in 'ab8500_ponkey'

---
 drivers/input/misc/ab8500-ponkey.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/input/misc/ab8500-ponkey.c +1 -1
index ea3b8292acdd5..a9b9013680d62 100644
@@ -19,7 +19,7 @@
 
 /**
  * struct ab8500_ponkey - ab8500 ponkey information
- * @input_dev: pointer to input device
+ * @idev: pointer to input device
  * @ab8500: ab8500 parent
  * @irq_dbf: irq number for falling transition
  * @irq_dbr: irq number for rising transition
Signature · 1 line
2.25.1
maintainer Applied
#8 lore raw

Re: [PATCH 04/20] input: misc: ab8500-ponkey: Fix incorrect name in 'ab8500_ponkey' doc header

Quoted 8 lines · Lee Jones

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

drivers/input/misc/ab8500-ponkey.c:32: warning: Function parameter or member 'idev' not described in 'ab8500_ponkey'

Applied, thank you.

Signature · 1 line
Dmitry
author
#9 lore raw

PATCH 5/20 input: rmi4: rmi_f01: Struct headers are expected to start with 'struct <name>'

In reply to Lee Jones

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.

---
 drivers/input/rmi4/rmi_f01.c | 1 +
 1 file changed, 1 insertion(+)
drivers/input/rmi4/rmi_f01.c +1 -0
index e623c956376e3..23618fcb1f322 100644
@@ -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.
Signature · 1 line
2.25.1
maintainer
#10 lore raw

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

Hi Lee,

Quoted 7 lines · Lee Jones

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.

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

Thank you.

Signature · 1 line
Dmitry
author
#11 lore raw

PATCH 6/20 include: input: elan-i2c-ids: Mark 'elan_acpi_id' as __maybe_unused

In reply to Lee Jones

Some drivers which include 'elan-i2c-ids.h' make use of 'elan_acpi_id', but not all do. Tell the compiler that this is expected behaviour.

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

include/linux/input/elan-i2c-ids.h:26:36: warning: ‘elan_acpi_id’ defined but not used [-Wunused-const-variable=]

---
 include/linux/input/elan-i2c-ids.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
include/linux/input/elan-i2c-ids.h +1 -1
index 520858d126808..b6976d99b6b75 100644
@@ -23,7 +23,7 @@
 
 #include <linux/mod_devicetable.h>
 
-static const struct acpi_device_id elan_acpi_id[] = {
+static const struct acpi_device_id __maybe_unused elan_acpi_id[] = {
 	{ "ELAN0000", 0 },
 	{ "ELAN0100", 0 },
 	{ "ELAN0600", 0 },
Signature · 1 line
2.25.1
maintainer
#12 lore raw

Re: [PATCH 06/20] include: input: elan-i2c-ids: Mark 'elan_acpi_id' as __maybe_unused

Hi Lee,

Quoted 22 lines · Lee Jones

Some drivers which include 'elan-i2c-ids.h' make use of 'elan_acpi_id', but not all do. Tell the compiler that this is expected behaviour.

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

include/linux/input/elan-i2c-ids.h:26:36: warning: ‘elan_acpi_id’ defined but not used [-Wunused-const-variable=]

---
 include/linux/input/elan-i2c-ids.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
include/linux/input/elan-i2c-ids.h +0 -0
index 520858d126808..b6976d99b6b75 100644

include/linux/input/elan-i2c-ids.h line 29

Quoted 8 lines
include/linux/input/elan-i2c-ids.h +1 -1
@@ -23,7 +23,7 @@
 
 #include <linux/mod_devicetable.h>
 
-static const struct acpi_device_id elan_acpi_id[] = {
+static const struct acpi_device_id __maybe_unused elan_acpi_id[] = {
 	{ "ELAN0000", 0 },
 	{ "ELAN0100", 0 },
 	{ "ELAN0600", 0 },

I think I'd prefer something like this instead:

(quoted diff) +0 -0

b/drivers/input/mouse/elan_i2c_core.c
index c599e21a8478..65d21a050cea 100644

drivers/input/mouse/elan_i2c_core.c +1 -1
@@ -34,7 +34,6 @@
 #include <linux/completion.h>
 #include <linux/of.h>
 #include <linux/property.h>
-#include <linux/input/elan-i2c-ids.h>
 #include <linux/regulator/consumer.h>
 #include <asm/unaligned.h>
 
@@ -1413,6 +1412,7 @@ static const struct i2c_device_id elan_id[] = {
 MODULE_DEVICE_TABLE(i2c, elan_id);
 
 #ifdef CONFIG_ACPI
+#include <linux/input/elan-i2c-ids.h>
 MODULE_DEVICE_TABLE(acpi, elan_acpi_id);
 #endif
 

Thanks.

Signature · 1 line
Dmitry
author
#13 lore raw

Re: [PATCH 06/20] include: input: elan-i2c-ids: Mark 'elan_acpi_id' as __maybe_unused

Quoted 50 lines · Dmitry Torokhov

Hi Lee,

Quoted 22 lines · Lee Jones

Some drivers which include 'elan-i2c-ids.h' make use of 'elan_acpi_id', but not all do. Tell the compiler that this is expected behaviour.

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

include/linux/input/elan-i2c-ids.h:26:36: warning: ‘elan_acpi_id’ defined but not used [-Wunused-const-variable=]

---
 include/linux/input/elan-i2c-ids.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
include/linux/input/elan-i2c-ids.h +0 -0
index 520858d126808..b6976d99b6b75 100644

include/linux/input/elan-i2c-ids.h line 29

Quoted 8 lines
include/linux/input/elan-i2c-ids.h +1 -1
@@ -23,7 +23,7 @@
 
 #include <linux/mod_devicetable.h>
 
-static const struct acpi_device_id elan_acpi_id[] = {
+static const struct acpi_device_id __maybe_unused elan_acpi_id[] = {
 	{ "ELAN0000", 0 },
 	{ "ELAN0100", 0 },
 	{ "ELAN0600", 0 },

I think I'd prefer something like this instead:

drivers/input/mouse/elan_i2c_core.c +0 -1
index c599e21a8478..65d21a050cea 100644
@@ -34,7 +34,6 @@
 #include <linux/completion.h>
 #include <linux/of.h>
 #include <linux/property.h>
-#include <linux/input/elan-i2c-ids.h>
 #include <linux/regulator/consumer.h>
 #include <asm/unaligned.h>
 

drivers/input/mouse/elan_i2c_core.c static const struct i2c_device_id elan_id[] = { · line 1417

Quoted 6 lines
drivers/input/mouse/elan_i2c_core.c +1 -0
@@ -1413,6 +1412,7 @@ static const struct i2c_device_id elan_id[] = {
 MODULE_DEVICE_TABLE(i2c, elan_id);
 
 #ifdef CONFIG_ACPI
+#include <linux/input/elan-i2c-ids.h>
 MODULE_DEVICE_TABLE(acpi, elan_acpi_id);
 #endif

Moving an #include file to the bottom of a source file, really?

I can do as you wish, but it's a pretty 'interesting' solution. :)

Signature · 4 lines
Lee Jones [李琼斯]
Senior Technical Lead - Developer Services
Linaro.org │ Open source software for Arm SoCs
Follow Linaro: Facebook | Twitter | Blog
maintainer
#14 lore raw

Re: [PATCH 06/20] include: input: elan-i2c-ids: Mark 'elan_acpi_id' as __maybe_unused

Quoted 54 lines · Lee Jones
Quoted 52 lines · Dmitry Torokhov

Hi Lee,

Quoted 22 lines · Lee Jones

Some drivers which include 'elan-i2c-ids.h' make use of 'elan_acpi_id', but not all do. Tell the compiler that this is expected behaviour.

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

include/linux/input/elan-i2c-ids.h:26:36: warning: ‘elan_acpi_id’ defined but not used [-Wunused-const-variable=]

---
 include/linux/input/elan-i2c-ids.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
include/linux/input/elan-i2c-ids.h +0 -0
index 520858d126808..b6976d99b6b75 100644

include/linux/input/elan-i2c-ids.h line 29

Quoted 8 lines
include/linux/input/elan-i2c-ids.h +1 -1
@@ -23,7 +23,7 @@
 
 #include <linux/mod_devicetable.h>
 
-static const struct acpi_device_id elan_acpi_id[] = {
+static const struct acpi_device_id __maybe_unused elan_acpi_id[] = {
 	{ "ELAN0000", 0 },
 	{ "ELAN0100", 0 },
 	{ "ELAN0600", 0 },

I think I'd prefer something like this instead:

drivers/input/mouse/elan_i2c_core.c +0 -1
index c599e21a8478..65d21a050cea 100644
@@ -34,7 +34,6 @@
 #include <linux/completion.h>
 #include <linux/of.h>
 #include <linux/property.h>
-#include <linux/input/elan-i2c-ids.h>
 #include <linux/regulator/consumer.h>
 #include <asm/unaligned.h>
 
@@ -1413,6 +1412,7 @@ static const struct i2c_device_id elan_id[] = {
 MODULE_DEVICE_TABLE(i2c, elan_id);
 
Quoted 8 lines

drivers/input/mouse/elan_i2c_core.c static const struct i2c_device_id elan_id[] = { · line 1417

Quoted 4 lines
drivers/input/mouse/elan_i2c_core.c +1 -0
 #ifdef CONFIG_ACPI
+#include <linux/input/elan-i2c-ids.h>
 MODULE_DEVICE_TABLE(acpi, elan_acpi_id);
 #endif

Moving an #include file to the bottom of a source file, really?

I can do as you wish, but it's a pretty 'interesting' solution. :)

I see absolutely nothing wrong with it, and if you check kernel sources you will see #includes used this way.

What is your concern?

Thanks.

Signature · 1 line
Dmitry
author
#15 lore raw

Re: [PATCH 06/20] include: input: elan-i2c-ids: Mark 'elan_acpi_id' as __maybe_unused

Quoted 62 lines · Dmitry Torokhov
Quoted 61 lines · Lee Jones
Quoted 50 lines · Dmitry Torokhov

Hi Lee,

Quoted 22 lines · Lee Jones

Some drivers which include 'elan-i2c-ids.h' make use of 'elan_acpi_id', but not all do. Tell the compiler that this is expected behaviour.

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

include/linux/input/elan-i2c-ids.h:26:36: warning: ‘elan_acpi_id’ defined but not used [-Wunused-const-variable=]

---
 include/linux/input/elan-i2c-ids.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
include/linux/input/elan-i2c-ids.h +0 -0
index 520858d126808..b6976d99b6b75 100644

include/linux/input/elan-i2c-ids.h line 29

Quoted 8 lines
include/linux/input/elan-i2c-ids.h +1 -1
@@ -23,7 +23,7 @@
 
 #include <linux/mod_devicetable.h>
 
-static const struct acpi_device_id elan_acpi_id[] = {
+static const struct acpi_device_id __maybe_unused elan_acpi_id[] = {
 	{ "ELAN0000", 0 },
 	{ "ELAN0100", 0 },
 	{ "ELAN0600", 0 },

I think I'd prefer something like this instead:

drivers/input/mouse/elan_i2c_core.c +0 -1
index c599e21a8478..65d21a050cea 100644
@@ -34,7 +34,6 @@
 #include <linux/completion.h>
 #include <linux/of.h>
 #include <linux/property.h>
-#include <linux/input/elan-i2c-ids.h>
 #include <linux/regulator/consumer.h>
 #include <asm/unaligned.h>
 

drivers/input/mouse/elan_i2c_core.c static const struct i2c_device_id elan_id[] = { · line 1417

Quoted 6 lines
drivers/input/mouse/elan_i2c_core.c +1 -0
@@ -1413,6 +1412,7 @@ static const struct i2c_device_id elan_id[] = {
 MODULE_DEVICE_TABLE(i2c, elan_id);
 
 #ifdef CONFIG_ACPI
+#include <linux/input/elan-i2c-ids.h>
 MODULE_DEVICE_TABLE(acpi, elan_acpi_id);
 #endif

Moving an #include file to the bottom of a source file, really?

Quoted 6 lines
Quoted 1 line

I can do as you wish, but it's a pretty 'interesting' solution. :)

I see absolutely nothing wrong with it, and if you check kernel sources you will see #includes used this way.

What is your concern?

I guess just the unfamiliarity of it.

It's the first time I've seen such a solution.

Will fix.

Signature · 4 lines
Lee Jones [李琼斯]
Senior Technical Lead - Developer Services
Linaro.org │ Open source software for Arm SoCs
Follow Linaro: Facebook | Twitter | Blog
author
#16 lore raw

PATCH 1/1 input: mouse: elan_i2c_core: Move header inclusion inside

In reply to Lee Jones

The same clause as its use.

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

include/linux/input/elan-i2c-ids.h:26:36: warning: ‘elan_acpi_id’ defined but not used [-Wunused-const-variable=]

---
 drivers/input/mouse/elan_i2c_core.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/input/mouse/elan_i2c_core.c +1 -1
index c599e21a84784..65d21a050cea0 100644
@@ -34,7 +34,6 @@
 #include <linux/completion.h>
 #include <linux/of.h>
 #include <linux/property.h>
-#include <linux/input/elan-i2c-ids.h>
 #include <linux/regulator/consumer.h>
 #include <asm/unaligned.h>
 
@@ -1413,6 +1412,7 @@ static const struct i2c_device_id elan_id[] = {
 MODULE_DEVICE_TABLE(i2c, elan_id);
 
 #ifdef CONFIG_ACPI
+#include <linux/input/elan-i2c-ids.h>
 MODULE_DEVICE_TABLE(acpi, elan_acpi_id);
 #endif
 
Signature · 1 line
2.25.1
maintainer Applied
#17 lore raw

Re: [PATCH] input: mouse: elan_i2c_core: Move header inclusion inside

Quoted 6 lines · Lee Jones

The same clause as its use.

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

include/linux/input/elan-i2c-ids.h:26:36: warning: ‘elan_acpi_id’ defined but not used [-Wunused-const-variable=]

Quoted 7 lines

Applied, thank you.

Signature · 1 line
Dmitry
author
#18 lore raw

PATCH 7/20 input: keyboard: cros_ec_keyb: Struct headers should start with 'struct <name>'

In reply to Lee Jones

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

drivers/input/keyboard/cros_ec_keyb.c:72: warning: cannot understand function prototype: 'struct cros_ec_bs_map '

Cc Dmitry Torokhov <[email protected]>
Cc Benson Leung <[email protected]>
Cc Enric Balletbo i Serra <[email protected]>
Cc Guenter Roeck <[email protected]>
---
 drivers/input/keyboard/cros_ec_keyb.c | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)
drivers/input/keyboard/cros_ec_keyb.c +2 -3
index 15d17c7170816..fce0c839e1430 100644
@@ -58,10 +58,9 @@ struct cros_ec_keyb {
 	struct notifier_block notifier;
 };
 
-
 /**
- * cros_ec_bs_map - Struct mapping Linux keycodes to EC button/switch bitmap
- * #defines
+ * struct cros_ec_bs_map - Struct mapping Linux keycodes to EC button/switch
+ *			   bitmap #defines
  *
  * @ev_type: The type of the input event to generate (e.g., EV_KEY).
  * @code: A linux keycode
Signature · 1 line
2.25.1
Reviewed-by on v1 7/20
#19 lore raw

Re: [PATCH 07/20] input: keyboard: cros_ec_keyb: Struct headers should start with 'struct <name>'

Hi Lee,

Quoted 10 lines · Lee Jones

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

drivers/input/keyboard/cros_ec_keyb.c:72: warning: cannot understand function prototype: 'struct cros_ec_bs_map '

Cc Dmitry Torokhov <[email protected]>
Cc Benson Leung <[email protected]>
Cc Enric Balletbo i Serra <[email protected]>
Cc Guenter Roeck <[email protected]>
Quoted 24 lines
---
 drivers/input/keyboard/cros_ec_keyb.c | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)
drivers/input/keyboard/cros_ec_keyb.c +2 -3
index 15d17c7170816..fce0c839e1430 100644
@@ -58,10 +58,9 @@ struct cros_ec_keyb {
 	struct notifier_block notifier;
 };
 
-
 /**
- * cros_ec_bs_map - Struct mapping Linux keycodes to EC button/switch bitmap
- * #defines
+ * struct cros_ec_bs_map - Struct mapping Linux keycodes to EC button/switch
+ *			   bitmap #defines
  *
  * @ev_type: The type of the input event to generate (e.g., EV_KEY).
  * @code: A linux keycode
Signature · 1 line
2.25.1
Signature · 7 lines
Benson Leung
Staff Software Engineer
Chrome OS Kernel
Google Inc.
[email protected]
Chromium OS Project
[email protected]
author
#20 lore raw

PATCH 8/20 input: rmi4: rmi_f11: Struct headers are expected to start with 'struct <name>'

In reply to Lee Jones

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

drivers/input/rmi4/rmi_f11.c:66: warning: Cannot understand * @rezero - writing this to the F11 command register will cause the sensor to drivers/input/rmi4/rmi_f11.c:311: warning: cannot understand function prototype: 'struct f11_2d_sensor_queries '

Cc Dmitry Torokhov <[email protected]>
Cc Henrik Rydberg <[email protected]>
Cc Andrew Duggan <[email protected]>
---
 drivers/input/rmi4/rmi_f11.c | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)
drivers/input/rmi4/rmi_f11.c +3 -2
index ffa39ab153f2a..38baf39ce0916 100644
@@ -62,7 +62,7 @@
 /* maximum ABS_MT_POSITION displacement (in mm) */
 #define DMAX 10
 
-/**
+/*
  * @rezero - writing this to the F11 command register will cause the sensor to
  * calibrate to the current capacitive state.
  */
@@ -178,7 +178,8 @@
 #define F11_UNIFORM_CLICKPAD 0x02
 
 /**
- * Query registers 1 through 4 are always present.
+ * struct f11_2d_sensor_queries - Query registers 1 through 4 are always
+ *				  present.
  *
  * @nr_fingers - describes the maximum number of fingers the 2-D sensor
  * supports.
Signature · 1 line
2.25.1
author
#21 lore raw

PATCH 9/20 input: touchscreen: resistive-adc-touch: Struct headers should start with 'struct <name>'

In reply to Lee Jones

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

drivers/input/touchscreen/resistive-adc-touch.c:34: warning: cannot understand function prototype: 'struct grts_state '

Cc Eugen Hristev <[email protected]>
Cc Dmitry Torokhov <[email protected]>
---
 drivers/input/touchscreen/resistive-adc-touch.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/input/touchscreen/resistive-adc-touch.c +1 -1
index cfc8bb4553f78..e50af30183f4e 100644
@@ -23,7 +23,7 @@
 #define GRTS_MAX_POS_MASK				GENMASK(11, 0)
 
 /**
- * grts_state - generic resistive touch screen information struct
+ * struct grts_state - generic resistive touch screen information struct
  * @pressure_min:	number representing the minimum for the pressure
  * @pressure:		are we getting pressure info or not
  * @iio_chans:		list of channels acquired
Signature · 1 line
2.25.1
maintainer Applied
#22 lore raw

Re: [PATCH 09/20] input: touchscreen: resistive-adc-touch: Struct headers should start with 'struct <name>'

Quoted 8 lines · Lee Jones

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

drivers/input/touchscreen/resistive-adc-touch.c:34: warning: cannot understand function prototype: 'struct grts_state '

Cc Eugen Hristev <[email protected]>
Cc Dmitry Torokhov <[email protected]>

Applied, thank you.

Signature · 1 line
Dmitry
author
#23 lore raw

PATCH 10/20 input: mouse: synaptics: Place braces around empty if() body

In reply to Lee Jones

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

drivers/input/mouse/synaptics.c: In function ‘synaptics_process_packet’:
drivers/input/mouse/synaptics.c:1110:6: warning: suggest braces around empty body in an ‘if’ statement [-Wempty-body]

Cc Dmitry Torokhov <[email protected]>
Cc Henrik Rydberg <[email protected]>
Cc Peter Osterlund <[email protected]>
Cc Stefan Gmeiner <[email protected]>
Cc "C. Scott Ananian" <[email protected]>
Cc Bruce Kalk <[email protected]>
Cc this to <[email protected]>
---
 drivers/input/mouse/synaptics.c | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
drivers/input/mouse/synaptics.c +2 -1
index 82577095e175e..07835939d83b9 100644
@@ -1106,8 +1106,9 @@ static void synaptics_process_packet(struct psmouse *psmouse)
 					num_fingers = hw.w + 2;
 				break;
 			case 2:
-				if (SYN_MODEL_PEN(info->model_id))
+				if (SYN_MODEL_PEN(info->model_id)) {
 					;   /* Nothing, treat a pen as a single finger */
+				}
 				break;
 			case 4 ... 15:
 				if (SYN_CAP_PALMDETECT(info->capabilities))
Signature · 1 line
2.25.1
maintainer
#24 lore raw

Re: [PATCH 10/20] input: mouse: synaptics: Place braces around empty if() body

Hi Lee,

Quoted 23 lines · Lee Jones

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

drivers/input/mouse/synaptics.c: In function ‘synaptics_process_packet’:
drivers/input/mouse/synaptics.c:1110:6: warning: suggest braces around empty body in an ‘if’ statement [-Wempty-body]

Cc Dmitry Torokhov <[email protected]>
Cc Henrik Rydberg <[email protected]>
Cc Peter Osterlund <[email protected]>
Cc Stefan Gmeiner <[email protected]>
Cc "C. Scott Ananian" <[email protected]>
Cc Bruce Kalk <[email protected]>
Cc this to <[email protected]>
---
 drivers/input/mouse/synaptics.c | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
drivers/input/mouse/synaptics.c +0 -0
index 82577095e175e..07835939d83b9 100644

drivers/input/mouse/synaptics.c static void synaptics_process_packet(struct psmouse *psmouse) · line 1111

Quoted 7 lines
drivers/input/mouse/synaptics.c +2 -1
@@ -1106,8 +1106,9 @@ static void synaptics_process_packet(struct psmouse *psmouse)
 					num_fingers = hw.w + 2;
 				break;
 			case 2:
-				if (SYN_MODEL_PEN(info->model_id))
+				if (SYN_MODEL_PEN(info->model_id)) {
 					;   /* Nothing, treat a pen as a single finger */
+				}

This gives me:

WARNING: braces {} are not necessary for single statement blocks

from checkpatch.

Thanks.

Signature · 1 line
Dmitry
author
#25 lore raw

Re: [PATCH 10/20] input: mouse: synaptics: Place braces around empty if() body

Quoted 36 lines · Dmitry Torokhov

Hi Lee,

Quoted 23 lines · Lee Jones

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

drivers/input/mouse/synaptics.c: In function ‘synaptics_process_packet’:
drivers/input/mouse/synaptics.c:1110:6: warning: suggest braces around empty body in an ‘if’ statement [-Wempty-body]

Cc Dmitry Torokhov <[email protected]>
Cc Henrik Rydberg <[email protected]>
Cc Peter Osterlund <[email protected]>
Cc Stefan Gmeiner <[email protected]>
Cc "C. Scott Ananian" <[email protected]>
Cc Bruce Kalk <[email protected]>
Cc this to <[email protected]>
---
 drivers/input/mouse/synaptics.c | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
drivers/input/mouse/synaptics.c +0 -0
index 82577095e175e..07835939d83b9 100644

drivers/input/mouse/synaptics.c static void synaptics_process_packet(struct psmouse *psmouse) · line 1111

Quoted 7 lines
drivers/input/mouse/synaptics.c +2 -1
@@ -1106,8 +1106,9 @@ static void synaptics_process_packet(struct psmouse *psmouse)
 					num_fingers = hw.w + 2;
 				break;
 			case 2:
-				if (SYN_MODEL_PEN(info->model_id))
+				if (SYN_MODEL_PEN(info->model_id)) {
 					;   /* Nothing, treat a pen as a single finger */
+				}

This gives me:

Quoted 3 lines

WARNING: braces {} are not necessary for single statement blocks

from checkpatch.

Yes, because checkpatch just sees it as a normal single statement, rather than an empty one. It complains about macros that can be compiled out too, which is even more dangerous.

GCC wins this one though, as it *knows* it's an empty statement.

Signature · 4 lines
Lee Jones [李琼斯]
Senior Technical Lead - Developer Services
Linaro.org │ Open source software for Arm SoCs
Follow Linaro: Facebook | Twitter | Blog
#26 lore raw

Re: [PATCH 10/20] input: mouse: synaptics: Place braces around empty if() body

In reply to Dmitry Torokhov
Quoted 5 lines · Dmitry Torokhov
Quoted 4 lines · Lee Jones

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

 drivers/input/mouse/synaptics.c: In function ‘synaptics_process_packet’:
 drivers/input/mouse/synaptics.c:1110:6: warning: suggest braces around empty body in an ‘if’ statement [-Wempty-body]

[]

Quoted 1 line

drivers/input/mouse/synaptics.c

Quoted 1 line
drivers/input/mouse/synaptics.c +0 -0

[]

Quoted 11 lines

drivers/input/mouse/synaptics.c static void synaptics_process_packet(struct psmouse *psmouse) · line 1111

Quoted 8 lines
drivers/input/mouse/synaptics.c +0 -0
@@ -1106,8 +1106,9 @@ static void synaptics_process_packet(struct psmouse *psmouse)
  					num_fingers = hw.w + 2;
  				break;

  case 2:

drivers/input/mouse/synaptics.c +1 -1
-				if (SYN_MODEL_PEN(info->model_id))
+				if (SYN_MODEL_PEN(info->model_id)) {

  ; /* Nothing, treat a pen as a single finger */

drivers/input/mouse/synaptics.c +1 -0
+				}

This gives me:

Quoted 3 lines

WARNING: braces {} are not necessary for single statement blocks

from checkpatch.

As the entire case 2 is effectively a noop, why not just comment it better and remove the if (SYN_MODEL_PEN(...)) test altogether.

author
#27 lore raw

Re: [PATCH 10/20] input: mouse: synaptics: Place braces around empty if() body

Quoted 20 lines · Joe Perches
Quoted 5 lines · Dmitry Torokhov
Quoted 4 lines · Lee Jones

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

 drivers/input/mouse/synaptics.c: In function ‘synaptics_process_packet’:
 drivers/input/mouse/synaptics.c:1110:6: warning: suggest braces around empty body in an ‘if’ statement [-Wempty-body]

[]

Quoted 1 line

drivers/input/mouse/synaptics.c

Quoted 1 line
drivers/input/mouse/synaptics.c +0 -0

[]

Quoted 11 lines

drivers/input/mouse/synaptics.c static void synaptics_process_packet(struct psmouse *psmouse) · line 1111

Quoted 8 lines
drivers/input/mouse/synaptics.c +0 -0
@@ -1106,8 +1106,9 @@ static void synaptics_process_packet(struct psmouse *psmouse)
  					num_fingers = hw.w + 2;
  				break;

  case 2:

drivers/input/mouse/synaptics.c +1 -1
-				if (SYN_MODEL_PEN(info->model_id))
+				if (SYN_MODEL_PEN(info->model_id)) {

  ; /* Nothing, treat a pen as a single finger */

drivers/input/mouse/synaptics.c +1 -0
+				}

This gives me:

Quoted 6 lines
Quoted 3 lines

WARNING: braces {} are not necessary for single statement blocks

from checkpatch.

As the entire case 2 is effectively a noop, why not just comment it better and remove the if (SYN_MODEL_PEN(...)) test altogether.

Happy to do that if that's okay with Dmitry.

Signature · 4 lines
Lee Jones [李琼斯]
Senior Technical Lead - Developer Services
Linaro.org │ Open source software for Arm SoCs
Follow Linaro: Facebook | Twitter | Blog
author
#28 lore raw

PATCH 11/20 input: keyboard: gpio_keys: Fix misnamed function parameter 'dev'

In reply to Lee Jones

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

drivers/input/keyboard/gpio_keys.c:119: warning: Function parameter or member 'dev' not described in 'get_bm_events_by_type' drivers/input/keyboard/gpio_keys.c:119: warning: Excess function parameter 'input' description in 'get_bm_events_by_type'

Cc Dmitry Torokhov <[email protected]>
Cc "Gustavo A. R. Silva" <[email protected]>
Cc David Jander <[email protected]>
Cc Phil Blundell <[email protected]>
---
 drivers/input/keyboard/gpio_keys.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/input/keyboard/gpio_keys.c +1 -1
index f2d4e4daa818f..a079504e98e82 100644
@@ -108,7 +108,7 @@ static int get_n_events_by_type(int type)
 
 /**
  * get_bm_events_by_type() - returns bitmap of supported events per @type
- * @input: input device from which bitmap is retrieved
+ * @dev: input device from which bitmap is retrieved
  * @type: type of button (%EV_KEY, %EV_SW)
  *
  * Return value of this function can be used to allocate bitmap
Signature · 1 line
2.25.1
maintainer Applied
#29 lore raw

Re: [PATCH 11/20] input: keyboard: gpio_keys: Fix misnamed function parameter 'dev'

Quoted 11 lines · Lee Jones

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

drivers/input/keyboard/gpio_keys.c:119: warning: Function parameter or member 'dev' not described in 'get_bm_events_by_type' drivers/input/keyboard/gpio_keys.c:119: warning: Excess function parameter 'input' description in 'get_bm_events_by_type'

Cc Dmitry Torokhov <[email protected]>
Cc "Gustavo A. R. Silva" <[email protected]>
Cc David Jander <[email protected]>
Cc Phil Blundell <[email protected]>

Applied, thank you.

Signature · 1 line
Dmitry
author
#30 lore raw

PATCH 12/20 input: mouse: elantech: Demote obvious abuse of kernel-doc header

In reply to Lee Jones

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

drivers/input/mouse/elantech.c:1837: warning: Function parameter or member 'psmouse' not described in 'elantech_setup_smbus' drivers/input/mouse/elantech.c:1837: warning: Function parameter or member 'info' not described in 'elantech_setup_smbus' drivers/input/mouse/elantech.c:1837: warning: Function parameter or member 'leave_breadcrumbs' not described in 'elantech_setup_smbus'

Cc Dmitry Torokhov <[email protected]>
Cc Henrik Rydberg <[email protected]>
Cc Arjan Opmeer <[email protected]>
---
 drivers/input/mouse/elantech.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/input/mouse/elantech.c +1 -1
index 90f8765f9efc8..47cd0e7f79bd1 100644
@@ -1827,7 +1827,7 @@ static int elantech_create_smbus(struct psmouse *psmouse,
 				  leave_breadcrumbs);
 }
 
-/**
+/*
  * elantech_setup_smbus - called once the PS/2 devices are enumerated
  * and decides to instantiate a SMBus InterTouch device.
  */
Signature · 1 line
2.25.1
maintainer Applied
#31 lore raw

Re: [PATCH 12/20] input: mouse: elantech: Demote obvious abuse of kernel-doc header

Quoted 11 lines · Lee Jones

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

drivers/input/mouse/elantech.c:1837: warning: Function parameter or member 'psmouse' not described in 'elantech_setup_smbus' drivers/input/mouse/elantech.c:1837: warning: Function parameter or member 'info' not described in 'elantech_setup_smbus' drivers/input/mouse/elantech.c:1837: warning: Function parameter or member 'leave_breadcrumbs' not described in 'elantech_setup_smbus'

Cc Dmitry Torokhov <[email protected]>
Cc Henrik Rydberg <[email protected]>
Cc Arjan Opmeer <[email protected]>

Applied, thank you.

Signature · 1 line
Dmitry
author
#32 lore raw

PATCH 13/20 input: rmi4: rmi_f54: Provide some missing 'REPORT_TYPE' enums

In reply to Lee Jones

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

drivers/input/rmi4/rmi_f54.c:77: warning: Enum value 'F54_REPORT_NONE' not described in enum 'rmi_f54_report_type' drivers/input/rmi4/rmi_f54.c:77: warning: Enum value 'F54_MAX_REPORT_TYPE' not described in enum 'rmi_f54_report_type'

---
 drivers/input/rmi4/rmi_f54.c | 6 ++++++
 1 file changed, 6 insertions(+)
drivers/input/rmi4/rmi_f54.c +6 -0
index 6b23e679606ee..93b328c796c64 100644
@@ -42,6 +42,8 @@
 /**
  * enum rmi_f54_report_type - RMI4 F54 report types
  *
+ * @F54_REPORT_NONE:	No Image Report.
+ *
  * @F54_8BIT_IMAGE:	Normalized 8-Bit Image Report. The capacitance variance
  *			from baseline for each pixel.
  *
@@ -64,6 +66,10 @@
  *			Report. Set Low reference to its minimum value and high
  *			references to its maximum value, then report the raw
  *			capacitance for each pixel.
+ *
+ * @F54_MAX_REPORT_TYPE:
+ *			Maximum number of Report Types.  Used for sanity
+ *			checking.
  */
 enum rmi_f54_report_type {
 	F54_REPORT_NONE = 0,
Signature · 1 line
2.25.1
author
#33 lore raw

PATCH 14/20 input: rmi4: rmi_i2c: Provide some missing descriptions for struct members

In reply to Lee Jones

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

drivers/input/rmi4/rmi_i2c.c:39: warning: Function parameter or member 'client' not described in 'rmi_i2c_xport' drivers/input/rmi4/rmi_i2c.c:39: warning: Function parameter or member 'supplies' not described in 'rmi_i2c_xport' drivers/input/rmi4/rmi_i2c.c:39: warning: Function parameter or member 'startup_delay' not described in 'rmi_i2c_xport'

Cc Dmitry Torokhov <[email protected]>
Cc Christopher Heiny <[email protected]>
Cc Andrew Duggan <[email protected]>
---
 drivers/input/rmi4/rmi_i2c.c | 4 ++++
 1 file changed, 4 insertions(+)
drivers/input/rmi4/rmi_i2c.c +4 -0
index a95c2c9bcab4c..50305fcfbef59 100644
@@ -17,12 +17,16 @@
  * struct rmi_i2c_xport - stores information for i2c communication
  *
  * @xport: The transport interface structure
+ * @client: The I2C client device structure
  *
  * @page_mutex: Locks current page to avoid changing pages in unexpected ways.
  * @page: Keeps track of the current virtual page
  *
  * @tx_buf: Buffer used for transmitting data to the sensor over i2c.
  * @tx_buf_size: Size of the buffer
+ *
+ * @supplies: Array of voltage regulators
+ * @startup_delay: Milliseconds to pause after powering up the regulators
  */
 struct rmi_i2c_xport {
 	struct rmi_transport_dev xport;
Signature · 1 line
2.25.1
author
#34 lore raw

PATCH 15/20 input: touchscreen: cyttsp4_core: Move 'cyttsp4_tch_abs_string' to the only file that references it

In reply to Lee Jones

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

In file included from drivers/input/touchscreen/cyttsp_i2c_common.c:24:
drivers/input/touchscreen/cyttsp4_core.h:236:27: warning: ‘cyttsp4_tch_abs_string’ defined but not used [-Wunused-const-variable=] 236 | static const char const cyttsp4_tch_abs_string[] = {
| ^~~~~~~~~~~~~~~~~~~~~~
In file included from drivers/input/touchscreen/cyttsp4_i2c.c:17:
drivers/input/touchscreen/cyttsp4_core.h:236:27: warning: ‘cyttsp4_tch_abs_string’ defined but not used [-Wunused-const-variable=] 236 | static const char * const cyttsp4_tch_abs_string[] = {
| ^~~~~~~~~~~~~~~~~~~~~~
In file included from drivers/input/touchscreen/cyttsp4_spi.c:17:
drivers/input/touchscreen/cyttsp4_core.h:236:27: warning: ‘cyttsp4_tch_abs_string’ defined but not used [-Wunused-const-variable=] 236 | static const char * const cyttsp4_tch_abs_string[] = {
| ^~~~~~~~~~~~~~~~~~~~~~

Cc Ferruh Yigit <[email protected]>
Cc Dmitry Torokhov <[email protected]>
Cc "at www.cypress.com" <[email protected]>
---
 drivers/input/touchscreen/cyttsp4_core.c | 14 ++++++++++++++
 drivers/input/touchscreen/cyttsp4_core.h | 14 --------------
 2 files changed, 14 insertions(+), 14 deletions(-)
drivers/input/touchscreen/cyttsp4_core.c +14 -0
index 02a73d9a4defe..dccbcb942fe59 100644
@@ -30,6 +30,20 @@
 
 #define CY_CORE_STARTUP_RETRY_COUNT		3
 
+static const char * const cyttsp4_tch_abs_string[] = {
+	[CY_TCH_X]	= "X",
+	[CY_TCH_Y]	= "Y",
+	[CY_TCH_P]	= "P",
+	[CY_TCH_T]	= "T",
+	[CY_TCH_E]	= "E",
+	[CY_TCH_O]	= "O",
+	[CY_TCH_W]	= "W",
+	[CY_TCH_MAJ]	= "MAJ",
+	[CY_TCH_MIN]	= "MIN",
+	[CY_TCH_OR]	= "OR",
+	[CY_TCH_NUM_ABS] = "INVALID"
+};
+
 static const u8 ldr_exit[] = {
 	0xFF, 0x01, 0x3B, 0x00, 0x00, 0x4F, 0x6D, 0x17
 };
drivers/input/touchscreen/cyttsp4_core.h +0 -14
index f3e4443594404..6262f6e450751 100644
@@ -233,20 +233,6 @@ enum cyttsp4_tch_abs {	/* for ordering within the extracted touch data array */
 	CY_TCH_NUM_ABS
 };
 
-static const char * const cyttsp4_tch_abs_string[] = {
-	[CY_TCH_X]	= "X",
-	[CY_TCH_Y]	= "Y",
-	[CY_TCH_P]	= "P",
-	[CY_TCH_T]	= "T",
-	[CY_TCH_E]	= "E",
-	[CY_TCH_O]	= "O",
-	[CY_TCH_W]	= "W",
-	[CY_TCH_MAJ]	= "MAJ",
-	[CY_TCH_MIN]	= "MIN",
-	[CY_TCH_OR]	= "OR",
-	[CY_TCH_NUM_ABS] = "INVALID"
-};
-
 struct cyttsp4_touch {
 	int abs[CY_TCH_NUM_ABS];
 };
Signature · 1 line
2.25.1
maintainer Applied
#35 lore raw

Re: [PATCH 15/20] input: touchscreen: cyttsp4_core: Move 'cyttsp4_tch_abs_string' to the only file that references it

Quoted 15 lines · Lee Jones

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

In file included from drivers/input/touchscreen/cyttsp_i2c_common.c:24:
drivers/input/touchscreen/cyttsp4_core.h:236:27: warning: ‘cyttsp4_tch_abs_string’ defined but not used [-Wunused-const-variable=] 236 | static const char const cyttsp4_tch_abs_string[] = {
| ^~~~~~~~~~~~~~~~~~~~~~
In file included from drivers/input/touchscreen/cyttsp4_i2c.c:17:
drivers/input/touchscreen/cyttsp4_core.h:236:27: warning: ‘cyttsp4_tch_abs_string’ defined but not used [-Wunused-const-variable=] 236 | static const char * const cyttsp4_tch_abs_string[] = {
| ^~~~~~~~~~~~~~~~~~~~~~
In file included from drivers/input/touchscreen/cyttsp4_spi.c:17:
drivers/input/touchscreen/cyttsp4_core.h:236:27: warning: ‘cyttsp4_tch_abs_string’ defined but not used [-Wunused-const-variable=] 236 | static const char * const cyttsp4_tch_abs_string[] = {
| ^~~~~~~~~~~~~~~~~~~~~~

Quoted 5 lines
Cc Ferruh Yigit <[email protected]>
Cc Dmitry Torokhov <[email protected]>
Cc "at www.cypress.com" <[email protected]>

Applied, thank you.

Signature · 1 line
Dmitry
author
#36 lore raw

Re: [PATCH 15/20] input: touchscreen: cyttsp4_core: Move 'cyttsp4_tch_abs_string' to the only file that references it

Quoted 16 lines · Dmitry Torokhov
Quoted 15 lines · Lee Jones

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

In file included from drivers/input/touchscreen/cyttsp_i2c_common.c:24:
drivers/input/touchscreen/cyttsp4_core.h:236:27: warning: ‘cyttsp4_tch_abs_string’ defined but not used [-Wunused-const-variable=] 236 | static const char const cyttsp4_tch_abs_string[] = {
| ^~~~~~~~~~~~~~~~~~~~~~
In file included from drivers/input/touchscreen/cyttsp4_i2c.c:17:
drivers/input/touchscreen/cyttsp4_core.h:236:27: warning: ‘cyttsp4_tch_abs_string’ defined but not used [-Wunused-const-variable=] 236 | static const char * const cyttsp4_tch_abs_string[] = {
| ^~~~~~~~~~~~~~~~~~~~~~
In file included from drivers/input/touchscreen/cyttsp4_spi.c:17:
drivers/input/touchscreen/cyttsp4_core.h:236:27: warning: ‘cyttsp4_tch_abs_string’ defined but not used [-Wunused-const-variable=] 236 | static const char * const cyttsp4_tch_abs_string[] = {
| ^~~~~~~~~~~~~~~~~~~~~~

Quoted 7 lines
Quoted 5 lines
Cc Ferruh Yigit <[email protected]>
Cc Dmitry Torokhov <[email protected]>
Cc "at www.cypress.com" <[email protected]>

Applied, thank you.

Thanks for this Dmitry.

I'll rebase in a couple of days and fix the stragglers.

Signature · 4 lines
Lee Jones [李琼斯]
Senior Technical Lead - Developer Services
Linaro.org │ Open source software for Arm SoCs
Follow Linaro: Facebook | Twitter | Blog
author
#37 lore raw

PATCH 16/20 input: misc: drv260x: Fix kernel-doc formatting and remove one abuse

In reply to Lee Jones

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'

---
 drivers/input/misc/drv260x.c | 26 +++++++++++++-------------
 1 file changed, 13 insertions(+), 13 deletions(-)
drivers/input/misc/drv260x.c +13 -13
index 79d7fa710a714..fabe106d499d4 100644
@@ -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);
Signature · 1 line
2.25.1
maintainer
#38 lore raw

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

Quoted 43 lines · Lee Jones

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'

---
 drivers/input/misc/drv260x.c | 26 +++++++++++++-------------
 1 file changed, 13 insertions(+), 13 deletions(-)
drivers/input/misc/drv260x.c +1 -11
index 79d7fa710a714..fabe106d499d4 100644
@@ -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

drivers/input/misc/drv260x.c line 180

Quoted 10 lines
drivers/input/misc/drv260x.c +10 -0
+ * @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.

Quoted 21 lines
drivers/input/misc/drv260x.c +2 -2
 **/
 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);
Signature · 1 line
2.25.1

Thanks.

Signature · 1 line
Dmitry
author
#39 lore raw

PATCH 17/20 input: misc: drv2665: Fix formatting expected by kernel-doc

In reply to Lee Jones

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

drivers/input/misc/drv2665.c:59: warning: Function parameter or member 'input_dev' not described in 'drv2665_data' drivers/input/misc/drv2665.c:59: warning: Function parameter or member 'client' not described in 'drv2665_data' drivers/input/misc/drv2665.c:59: warning: Function parameter or member 'regmap' not described in 'drv2665_data' drivers/input/misc/drv2665.c:59: warning: Function parameter or member 'work' not described in 'drv2665_data' drivers/input/misc/drv2665.c:59: warning: Function parameter or member 'regulator' not described in 'drv2665_data'

---
 drivers/input/misc/drv2665.c | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)
drivers/input/misc/drv2665.c +5 -5
index 918ad9c3fa812..0e65ab180f499 100644
@@ -44,11 +44,11 @@
 
 /**
  * struct drv2665_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
- * @regulator - Pointer to the regulator for the IC
+ * @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
+ * @regulator: Pointer to the regulator for the IC
  */
 struct drv2665_data {
 	struct input_dev *input_dev;
Signature · 1 line
2.25.1
maintainer Applied
#40 lore raw

Re: [PATCH 17/20] input: misc: drv2665: Fix formatting expected by kernel-doc

Quoted 8 lines · Lee Jones

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

drivers/input/misc/drv2665.c:59: warning: Function parameter or member 'input_dev' not described in 'drv2665_data' drivers/input/misc/drv2665.c:59: warning: Function parameter or member 'client' not described in 'drv2665_data' drivers/input/misc/drv2665.c:59: warning: Function parameter or member 'regmap' not described in 'drv2665_data' drivers/input/misc/drv2665.c:59: warning: Function parameter or member 'work' not described in 'drv2665_data' drivers/input/misc/drv2665.c:59: warning: Function parameter or member 'regulator' not described in 'drv2665_data'

Quoted 4 lines

Applied, thank you.

Signature · 1 line
Dmitry
author
#41 lore raw

PATCH 18/20 input: misc: drv2667: Fix formatting and add missing member docs

In reply to Lee Jones

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

drivers/input/misc/drv2667.c:109: warning: Function parameter or member 'input_dev' not described in 'drv2667_data' drivers/input/misc/drv2667.c:109: warning: Function parameter or member 'client' not described in 'drv2667_data' drivers/input/misc/drv2667.c:109: warning: Function parameter or member 'regmap' not described in 'drv2667_data' drivers/input/misc/drv2667.c:109: warning: Function parameter or member 'work' not described in 'drv2667_data' drivers/input/misc/drv2667.c:109: warning: Function parameter or member 'regulator' not described in 'drv2667_data' drivers/input/misc/drv2667.c:109: warning: Function parameter or member 'page' not described in 'drv2667_data' drivers/input/misc/drv2667.c:109: warning: Function parameter or member 'magnitude' not described in 'drv2667_data' drivers/input/misc/drv2667.c:109: warning: Function parameter or member 'frequency' not described in 'drv2667_data'

---
 drivers/input/misc/drv2667.c | 14 ++++++++------
 1 file changed, 8 insertions(+), 6 deletions(-)
drivers/input/misc/drv2667.c +8 -6
index bb9d5784df17d..dc19eb6a8713f 100644
@@ -90,12 +90,14 @@
 
 /**
  * struct drv2667_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
- * @regulator - Pointer to the regulator for the IC
- * @magnitude - Magnitude of the vibration event
+ * @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
+ * @regulator: Pointer to the regulator for the IC
+ * @page: Page number
+ * @magnitude: Magnitude of the vibration event
+ * @frequency: Frequency of the vibration event
 **/
 struct drv2667_data {
 	struct input_dev *input_dev;
Signature · 1 line
2.25.1
maintainer Applied
#42 lore raw

Re: [PATCH 18/20] input: misc: drv2667: Fix formatting and add missing member docs

Quoted 11 lines · Lee Jones

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

drivers/input/misc/drv2667.c:109: warning: Function parameter or member 'input_dev' not described in 'drv2667_data' drivers/input/misc/drv2667.c:109: warning: Function parameter or member 'client' not described in 'drv2667_data' drivers/input/misc/drv2667.c:109: warning: Function parameter or member 'regmap' not described in 'drv2667_data' drivers/input/misc/drv2667.c:109: warning: Function parameter or member 'work' not described in 'drv2667_data' drivers/input/misc/drv2667.c:109: warning: Function parameter or member 'regulator' not described in 'drv2667_data' drivers/input/misc/drv2667.c:109: warning: Function parameter or member 'page' not described in 'drv2667_data' drivers/input/misc/drv2667.c:109: warning: Function parameter or member 'magnitude' not described in 'drv2667_data' drivers/input/misc/drv2667.c:109: warning: Function parameter or member 'frequency' not described in 'drv2667_data'

Quoted 4 lines

Applied, thank you.

Signature · 1 line
Dmitry
author
#43 lore raw

PATCH 19/20 input: keyboard: nomadik-ske-keypad: Provide some missing struct member docs

In reply to Lee Jones

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

drivers/input/keyboard/nomadik-ske-keypad.c:71: warning: Function parameter or member 'pclk' not described in 'ske_keypad' drivers/input/keyboard/nomadik-ske-keypad.c:71: warning: Function parameter or member 'ske_keypad_lock' not described in 'ske_keypad'

Cc Dmitry Torokhov <[email protected]>
Cc Kumar G <[email protected]>
Cc Sundar Iyer <[email protected]>
---
 drivers/input/keyboard/nomadik-ske-keypad.c | 2 ++
 1 file changed, 2 insertions(+)
drivers/input/keyboard/nomadik-ske-keypad.c +2 -0
index 608446e14614d..0d55a95347f16 100644
@@ -58,6 +58,8 @@
  * @board:	keypad platform device
  * @keymap:	matrix scan code table for keycodes
  * @clk:	clock structure pointer
+ * @pclk:	clock structure pointer
+ * @ske_keypad_lock: spinlock protecting the keypad read/writes
  */
 struct ske_keypad {
 	int irq;
Signature · 1 line
2.25.1
maintainer Applied
#44 lore raw

Re: [PATCH 19/20] input: keyboard: nomadik-ske-keypad: Provide some missing struct member docs

Quoted 10 lines · Lee Jones

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

drivers/input/keyboard/nomadik-ske-keypad.c:71: warning: Function parameter or member 'pclk' not described in 'ske_keypad' drivers/input/keyboard/nomadik-ske-keypad.c:71: warning: Function parameter or member 'ske_keypad_lock' not described in 'ske_keypad'

Cc Dmitry Torokhov <[email protected]>
Cc Kumar G <[email protected]>
Cc Sundar Iyer <[email protected]>

Applied, thank you.

Signature · 1 line
Dmitry
author
#45 lore raw

PATCH 20/20 input: keyboard: pmic8xxx-keypad: Fix kernel-doc formatting

In reply to Lee Jones

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'

---
 drivers/input/keyboard/pmic8xxx-keypad.c | 22 +++++++++++-----------
 1 file changed, 11 insertions(+), 11 deletions(-)
drivers/input/keyboard/pmic8xxx-keypad.c +11 -11
index 91d5811d6f0e1..36bee6f5a8af0 100644
@@ -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;
Signature · 1 line
2.25.1
maintainer Applied
#46 lore raw

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

Quoted 14 lines · Lee Jones

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'

Quoted 4 lines

Applied, thank you.

Signature · 1 line
Dmitry
author
#47 lore raw
In reply to Lee Jones
Quoted 20 lines · 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.

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>'
Quoted 16 lines

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.

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