[PATCH 18/25] HID: hid-thrustmaster: Demote a bunch of kernel-doc abuses

From: Lee Jones
Date: Wed Mar 24 2021 - 13:36:06 EST


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

drivers/hid/hid-thrustmaster.c:23: warning: Incorrect use of kernel-doc format: * These interrupts are used to prevent a nasty crash when initializing the
drivers/hid/hid-thrustmaster.c:26: warning: cannot understand function prototype: 'const u8 setup_0[] = '
drivers/hid/hid-thrustmaster.c:49: warning: cannot understand function prototype: 'struct tm_wheel_info '
drivers/hid/hid-thrustmaster.c:62: warning: wrong kernel-doc identifier on line:
drivers/hid/hid-thrustmaster.c:84: warning: cannot understand function prototype: 'struct __packed tm_wheel_response '
drivers/hid/hid-thrustmaster.c:143: warning: wrong kernel-doc identifier on line:
drivers/hid/hid-thrustmaster.c:202: warning: Function parameter or member 'urb' not described in 'thrustmaster_model_handler'
drivers/hid/hid-thrustmaster.c:202: warning: expecting prototype for Called by the USB subsystem when the wheel responses to our request(). Prototype was for thrustmaster_model_handler() instead
drivers/hid/hid-thrustmaster.c:265: warning: wrong kernel-doc identifier on line:

Cc: Jiri Kosina <jikos@xxxxxxxxxx>
Cc: Benjamin Tissoires <benjamin.tissoires@xxxxxxxxxx>
Cc: Maxime Coquelin <mcoquelin.stm32@xxxxxxxxx>
Cc: Alexandre Torgue <alexandre.torgue@xxxxxxxxxxx>
Cc: Dario Pagani <dario.pagani.146+linuxk@xxxxxxxxx>
Cc: Kim Kuparinen <kimi.h.kuparinen@xxxxxxxxx>
Cc: linux-input@xxxxxxxxxxxxxxx
Cc: linux-stm32@xxxxxxxxxxxxxxxxxxxxxxxxxxxx
Cc: linux-arm-kernel@xxxxxxxxxxxxxxxxxxx
Signed-off-by: Lee Jones <lee.jones@xxxxxxxxxx>
---
drivers/hid/hid-thrustmaster.c | 24 ++++++++++++------------
1 file changed, 12 insertions(+), 12 deletions(-)

diff --git a/drivers/hid/hid-thrustmaster.c b/drivers/hid/hid-thrustmaster.c
index bfcd08759ba09..4f9c0642e816b 100644
--- a/drivers/hid/hid-thrustmaster.c
+++ b/drivers/hid/hid-thrustmaster.c
@@ -1,5 +1,5 @@
// SPDX-License-Identifier: GPL-2.0
-/**
+/*
* When connected to the machine, the Thrustmaster wheels appear as
* a «generic» hid gamepad called "Thrustmaster FFB Wheel".
*
@@ -19,7 +19,7 @@
#include <linux/slab.h>
#include <linux/module.h>

-/**
+/*
* These interrupts are used to prevent a nasty crash when initializing the
* T300RS. Used in thrustmaster_interrupts().
*/
@@ -36,7 +36,7 @@ static const unsigned int setup_arr_sizes[] = {
ARRAY_SIZE(setup_3),
ARRAY_SIZE(setup_4)
};
-/**
+/*
* This struct contains for each type of
* Thrustmaster wheel
*
@@ -49,7 +49,7 @@ static const unsigned int setup_arr_sizes[] = {
struct tm_wheel_info {
uint16_t wheel_type;

- /**
+ /*
* See when the USB control out packet is prepared...
* @TODO The TMX seems to require multiple control codes to switch.
*/
@@ -58,7 +58,7 @@ struct tm_wheel_info {
char const *const wheel_name;
};

-/**
+/*
* Known wheels.
* Note: TMX does not work as it requires 2 control packets
*/
@@ -72,7 +72,7 @@ static const struct tm_wheel_info tm_wheels_infos[] = {

static const uint8_t tm_wheels_infos_length = 4;

-/**
+/*
* This structs contains (in little endian) the response data
* of the wheel to the request 73
*
@@ -82,7 +82,7 @@ static const uint8_t tm_wheels_infos_length = 4;
*/
struct __packed tm_wheel_response
{
- /**
+ /*
* Seems to be the type of packet
* - 0x0049 if is data.a (15 bytes)
* - 0x0047 if is data.b (7 bytes)
@@ -93,7 +93,7 @@ struct __packed tm_wheel_response
struct __packed {
uint16_t field0;
uint16_t field1;
- /**
+ /*
* Seems to be the model code of the wheel
* Read table thrustmaster_wheels to values
*/
@@ -122,7 +122,7 @@ struct tm_wheel {
struct usb_ctrlrequest *change_request;
};

-/** The control packet to send to wheel */
+/* The control packet to send to wheel */
static const struct usb_ctrlrequest model_request = {
.bRequestType = 0xc1,
.bRequest = 73,
@@ -139,7 +139,7 @@ static const struct usb_ctrlrequest change_request = {
.wLength = 0
};

-/**
+/*
* On some setups initializing the T300RS crashes the kernel,
* these interrupts fix that particular issue. So far they haven't caused any
* adverse effects in other wheels.
@@ -191,7 +191,7 @@ static void thrustmaster_change_handler(struct urb *urb)
hid_warn(hdev, "URB to change wheel mode seems to have failed with error %d\n", urb->status);
}

-/**
+/*
* Called by the USB subsystem when the wheel responses to our request
* to get [what it seems to be] the wheel's model.
*
@@ -261,7 +261,7 @@ static void thrustmaster_remove(struct hid_device *hdev)
hid_hw_stop(hdev);
}

-/**
+/*
* Function called by HID when a hid Thrustmaster FFB wheel is connected to the host.
* This function starts the hid dev, tries to allocate the tm_wheel data structure and
* finally send an USB CONTROL REQUEST to the wheel to get [what it seems to be] its
--
2.27.0