linux-kernel - [PATCH 14/20] input: rmi4: rmi_i2c: Provide some missing descriptions for struct members

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-Id: <20201104162427.2984742-15-lee.jones@linaro.org>
Date:   Wed,  4 Nov 2020 16:24:21 +0000
From:   Lee Jones <lee.jones@...aro.org>
To:     lee.jones@...aro.org
Cc:     linux-kernel@...r.kernel.org,
        Dmitry Torokhov <dmitry.torokhov@...il.com>,
        Christopher Heiny <cheiny@...aptics.com>,
        Andrew Duggan <aduggan@...aptics.com>,
        linux-input@...r.kernel.org
Subject: [PATCH 14/20] input: rmi4: rmi_i2c: Provide some missing descriptions for struct members

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 <dmitry.torokhov@...il.com>
Cc: Christopher Heiny <cheiny@...aptics.com>
Cc: Andrew Duggan <aduggan@...aptics.com>
Cc: linux-input@...r.kernel.org
Signed-off-by: Lee Jones <lee.jones@...aro.org>
---
 drivers/input/rmi4/rmi_i2c.c | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/drivers/input/rmi4/rmi_i2c.c b/drivers/input/rmi4/rmi_i2c.c
index a95c2c9bcab4c..50305fcfbef59 100644
--- a/drivers/input/rmi4/rmi_i2c.c
+++ b/drivers/input/rmi4/rmi_i2c.c
@@ -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;
-- 
2.25.1