diff mbox series

[14/15] input: keyboard: applespi: Provide missing struct 'message' descriptions

Message ID 20201112110204.2083435-15-lee.jones@linaro.org
State Accepted
Commit 39f4879e99a42d3ebcf9876bf4201d95679445d3
Headers show
Series Rid W=1 issues from Input | expand

Commit Message

Lee Jones Nov. 12, 2020, 11:02 a.m. UTC
Fixes the following W=1 kernel build warning(s):

 drivers/input/keyboard/applespi.c:306: warning: Function parameter or member 'keyboard' not described in 'message'
 drivers/input/keyboard/applespi.c:306: warning: Function parameter or member 'touchpad' not described in 'message'
 drivers/input/keyboard/applespi.c:306: warning: Function parameter or member 'tp_info' not described in 'message'
 drivers/input/keyboard/applespi.c:306: warning: Function parameter or member 'tp_info_command' not described in 'message'
 drivers/input/keyboard/applespi.c:306: warning: Function parameter or member 'init_mt_command' not described in 'message'
 drivers/input/keyboard/applespi.c:306: warning: Function parameter or member 'capsl_command' not described in 'message'
 drivers/input/keyboard/applespi.c:306: warning: Function parameter or member 'bl_command' not described in 'message'
 drivers/input/keyboard/applespi.c:306: warning: Function parameter or member 'data' not described in 'message'

Cc: Dmitry Torokhov <dmitry.torokhov@gmail.com>
Cc: Henrik Rydberg <rydberg@bitmath.org>
Cc: "Gustavo A. R. Silva" <gustavoars@kernel.org>
Cc: linux-input@vger.kernel.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>

---
 drivers/input/keyboard/applespi.c | 9 +++++++++
 1 file changed, 9 insertions(+)

-- 
2.25.1

Comments

Dmitry Torokhov Nov. 20, 2020, 3:21 a.m. UTC | #1
On Thu, Nov 12, 2020 at 11:02:03AM +0000, Lee Jones wrote:
> Fixes the following W=1 kernel build warning(s):

> 

>  drivers/input/keyboard/applespi.c:306: warning: Function parameter or member 'keyboard' not described in 'message'

>  drivers/input/keyboard/applespi.c:306: warning: Function parameter or member 'touchpad' not described in 'message'

>  drivers/input/keyboard/applespi.c:306: warning: Function parameter or member 'tp_info' not described in 'message'

>  drivers/input/keyboard/applespi.c:306: warning: Function parameter or member 'tp_info_command' not described in 'message'

>  drivers/input/keyboard/applespi.c:306: warning: Function parameter or member 'init_mt_command' not described in 'message'

>  drivers/input/keyboard/applespi.c:306: warning: Function parameter or member 'capsl_command' not described in 'message'

>  drivers/input/keyboard/applespi.c:306: warning: Function parameter or member 'bl_command' not described in 'message'

>  drivers/input/keyboard/applespi.c:306: warning: Function parameter or member 'data' not described in 'message'

> 

> Cc: Dmitry Torokhov <dmitry.torokhov@gmail.com>

> Cc: Henrik Rydberg <rydberg@bitmath.org>

> Cc: "Gustavo A. R. Silva" <gustavoars@kernel.org>

> Cc: linux-input@vger.kernel.org

> Signed-off-by: Lee Jones <lee.jones@linaro.org>


Applied, thank you.

-- 
Dmitry
diff mbox series

Patch

diff --git a/drivers/input/keyboard/applespi.c b/drivers/input/keyboard/applespi.c
index 14362ebab9a9d..8053a3d2ff635 100644
--- a/drivers/input/keyboard/applespi.c
+++ b/drivers/input/keyboard/applespi.c
@@ -286,6 +286,15 @@  struct command_protocol_bl {
  *		structure (after re-assembly in case of being split over
  *		multiple spi-packets), minus the trailing crc. The total size
  *		of the message struct is therefore @length + 10.
+ *
+ * @keyboard:		Keyboard message
+ * @touchpad:		Touchpad message
+ * @tp_info:		Touchpad info (response)
+ * @tp_info_command:	Touchpad info (CRC)
+ * @init_mt_command:	Initialise Multitouch
+ * @capsl_command:	Toggle caps-lock LED
+ * @bl_command:		Keyboard brightness
+ * @data:		Buffer data
  */
 struct message {
 	__le16		type;