All of lore.kernel.org
 help / color / mirror / Atom feed
From: Lee Jones <lee.jones@linaro.org>
To: lee.jones@linaro.org
Cc: linux-kernel@vger.kernel.org, Jiri Kosina <jikos@kernel.org>,
	Benjamin Tissoires <benjamin.tissoires@redhat.com>,
	Maxime Coquelin <mcoquelin.stm32@gmail.com>,
	Alexandre Torgue <alexandre.torgue@foss.st.com>,
	Dario Pagani <dario.pagani.146+linuxk@gmail.com>,
	Kim Kuparinen <kimi.h.kuparinen@gmail.com>,
	linux-input@vger.kernel.org,
	linux-stm32@st-md-mailman.stormreply.com,
	linux-arm-kernel@lists.infradead.org
Subject: [PATCH 18/25] HID: hid-thrustmaster: Demote a bunch of kernel-doc abuses
Date: Fri, 26 Mar 2021 14:34:51 +0000	[thread overview]
Message-ID: <20210326143458.508959-20-lee.jones@linaro.org> (raw)
In-Reply-To: <20210326143458.508959-1-lee.jones@linaro.org>

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@kernel.org>
Cc: Benjamin Tissoires <benjamin.tissoires@redhat.com>
Cc: Maxime Coquelin <mcoquelin.stm32@gmail.com>
Cc: Alexandre Torgue <alexandre.torgue@foss.st.com>
Cc: Dario Pagani <dario.pagani.146+linuxk@gmail.com>
Cc: Kim Kuparinen <kimi.h.kuparinen@gmail.com>
Cc: linux-input@vger.kernel.org
Cc: linux-stm32@st-md-mailman.stormreply.com
Cc: linux-arm-kernel@lists.infradead.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 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


WARNING: multiple messages have this Message-ID
From: Lee Jones <lee.jones@linaro.org>
To: lee.jones@linaro.org
Cc: linux-kernel@vger.kernel.org, Jiri Kosina <jikos@kernel.org>,
	Benjamin Tissoires <benjamin.tissoires@redhat.com>,
	Maxime Coquelin <mcoquelin.stm32@gmail.com>,
	Alexandre Torgue <alexandre.torgue@foss.st.com>,
	Dario Pagani <dario.pagani.146+linuxk@gmail.com>,
	Kim Kuparinen <kimi.h.kuparinen@gmail.com>,
	linux-input@vger.kernel.org,
	linux-stm32@st-md-mailman.stormreply.com,
	linux-arm-kernel@lists.infradead.org
Subject: [PATCH 18/25] HID: hid-thrustmaster: Demote a bunch of kernel-doc abuses
Date: Fri, 26 Mar 2021 14:34:51 +0000	[thread overview]
Message-ID: <20210326143458.508959-20-lee.jones@linaro.org> (raw)
In-Reply-To: <20210326143458.508959-1-lee.jones@linaro.org>

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@kernel.org>
Cc: Benjamin Tissoires <benjamin.tissoires@redhat.com>
Cc: Maxime Coquelin <mcoquelin.stm32@gmail.com>
Cc: Alexandre Torgue <alexandre.torgue@foss.st.com>
Cc: Dario Pagani <dario.pagani.146+linuxk@gmail.com>
Cc: Kim Kuparinen <kimi.h.kuparinen@gmail.com>
Cc: linux-input@vger.kernel.org
Cc: linux-stm32@st-md-mailman.stormreply.com
Cc: linux-arm-kernel@lists.infradead.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 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


_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel

  parent reply	other threads:[~2021-03-26 14:36 UTC|newest]

Thread overview: 54+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-03-26 14:34 [RESEND 00/25] Rid W=1 warnings from HID Lee Jones
2021-03-26 14:34 ` Lee Jones
2021-03-26 14:34 ` Lee Jones
2021-03-26 14:34 ` Lee Jones
2021-03-26 14:34   ` Lee Jones
2021-03-26 14:34   ` Lee Jones
2021-03-26 14:34 ` [PATCH 01/25] HID: intel-ish-hid: Remove unused variable 'err' Lee Jones
2021-03-26 14:34 ` [PATCH 02/25] HID: ishtp-hid-client: Move variable to where it's actually used Lee Jones
2021-03-26 14:34 ` [PATCH 03/25] HID: intel-ish-hid: pci-ish: Remove unused variable 'ret' Lee Jones
2021-03-26 14:34 ` [PATCH 04/25] HID: intel-ish: Supply some missing param descriptions Lee Jones
2021-03-26 14:34 ` [PATCH 05/25] HID: intel-ish: Fix a naming disparity and a formatting error Lee Jones
2021-03-26 14:34 ` [PATCH 06/25] HID: usbhid: Repair a formatting issue in a struct description Lee Jones
2021-04-07 16:56   ` Benjamin Tissoires
2021-04-08  7:05     ` Lee Jones
2021-03-26 14:34 ` [PATCH 07/25] HID: intel-ish-hid: Fix a little doc-rot Lee Jones
2021-03-26 14:34 ` [PATCH 08/25] HID: usbhid: hid-pidff: Demote a couple kernel-doc abuses Lee Jones
2021-03-26 14:34 ` [PATCH 09/25] HID: hid-alps: Correct struct misnaming Lee Jones
2021-03-26 14:34 ` [PATCH 10/25] HID: intel-ish-hid: Fix potential copy/paste error Lee Jones
2021-03-26 14:34 ` [PATCH 11/25] HID: hid-core: Fix incorrect function name in header Lee Jones
2021-03-26 14:34 ` [PATCH 12/25] HID: intel-ish-hid: ipc: Correct fw_reset_work_fn() " Lee Jones
2021-03-26 14:34 ` [PATCH 13/25] HID: ishtp-hid-client: Fix incorrect function name report_bad_packet() Lee Jones
2021-03-26 14:34 ` [PATCH 14/25] HID: hid-kye: Fix incorrect function name for kye_tablet_enable() Lee Jones
2021-03-26 14:34 ` [PATCH 15/25] HID: hid-picolcd_core: Remove unused variable 'ret' Lee Jones
2021-03-26 14:34 ` [PATCH 16/25] HID: hid-logitech-hidpp: Fix conformant kernel-doc header and demote abuses Lee Jones
2021-03-26 14:34 ` [PATCH 17/25] HID: hid-uclogic-rdesc: Kernel-doc is for functions and structs Lee Jones
2021-03-26 14:34 ` Lee Jones [this message]
2021-03-26 14:34   ` [PATCH 18/25] HID: hid-thrustmaster: Demote a bunch of kernel-doc abuses Lee Jones
2021-03-26 14:34 ` [PATCH 19/25] HID: hid-uclogic-params: Ensure function names are present and correct in kernel-doc headers Lee Jones
2021-03-26 14:34 ` [PATCH 20/25] HID: hid-sensor-custom: Remove unused variable 'ret' Lee Jones
2021-03-29 11:26   ` Jonathan Cameron
2021-03-26 14:34 ` [PATCH 21/25] HID: wacom_sys: Demote kernel-doc abuse Lee Jones
2021-03-26 14:34 ` [PATCH 22/25] HID: hid-sensor-hub: Remove unused struct member 'quirks' Lee Jones
2021-03-29 11:27   ` Jonathan Cameron
2021-03-26 14:34 ` [PATCH 23/25] HID: hid-sensor-hub: Move 'hsdev' description to correct struct definition Lee Jones
2021-03-29 11:30   ` Jonathan Cameron
2021-03-29 13:00     ` Lee Jones
2021-03-29 15:22       ` Jonathan Cameron
2021-03-26 14:34 ` [PATCH 24/25] HID: intel-ish-hid: ishtp-fw-loader: Fix a bunch of formatting issues Lee Jones
2021-03-26 14:34   ` Lee Jones
2021-03-26 14:34 ` [PATCH 25/25] HID: ishtp-hid-client: Fix 'suggest-attribute=format' compiler warning Lee Jones
2021-04-06  8:56 ` [RESEND 00/25] Rid W=1 warnings from HID Lee Jones
2021-04-06  8:56   ` Lee Jones
2021-04-06  8:56   ` Lee Jones
2021-04-07 16:09   ` Benjamin Tissoires
2021-04-07 16:09     ` Benjamin Tissoires
2021-04-07 16:09     ` Benjamin Tissoires
2021-04-08  7:06     ` Lee Jones
2021-04-08  7:06       ` Lee Jones
2021-04-08  7:06       ` Lee Jones
2021-04-08 11:43       ` Benjamin Tissoires
2021-04-08 11:43         ` Benjamin Tissoires
2021-04-08 11:43         ` Benjamin Tissoires
  -- strict thread matches above, loose matches on Subject: below --
2021-03-24 17:33 [PATCH " Lee Jones
2021-03-24 17:33 ` [PATCH 18/25] HID: hid-thrustmaster: Demote a bunch of kernel-doc abuses Lee Jones
2021-03-24 17:33   ` Lee Jones

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20210326143458.508959-20-lee.jones@linaro.org \
    --to=lee.jones@linaro.org \
    --cc=alexandre.torgue@foss.st.com \
    --cc=benjamin.tissoires@redhat.com \
    --cc=dario.pagani.146+linuxk@gmail.com \
    --cc=jikos@kernel.org \
    --cc=kimi.h.kuparinen@gmail.com \
    --cc=linux-arm-kernel@lists.infradead.org \
    --cc=linux-input@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-stm32@st-md-mailman.stormreply.com \
    --cc=mcoquelin.stm32@gmail.com \
    --subject='Re: [PATCH 18/25] HID: hid-thrustmaster: Demote a bunch of kernel-doc abuses' \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.