From patchwork Wed Mar 24 17:33:57 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Lee Jones X-Patchwork-Id: 12161935 X-Patchwork-Delegate: jikos@jikos.cz Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-18.8 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER, INCLUDES_PATCH,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED, USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 9D714C4345A for ; Wed, 24 Mar 2021 17:35:14 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 8C10A61A1D for ; Wed, 24 Mar 2021 17:35:14 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S237331AbhCXReq (ORCPT ); Wed, 24 Mar 2021 13:34:46 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:33892 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S237274AbhCXRec (ORCPT ); Wed, 24 Mar 2021 13:34:32 -0400 Received: from mail-ej1-x62d.google.com (mail-ej1-x62d.google.com [IPv6:2a00:1450:4864:20::62d]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id CD5AAC061763 for ; Wed, 24 Mar 2021 10:34:31 -0700 (PDT) Received: by mail-ej1-x62d.google.com with SMTP id e14so16032485ejz.11 for ; Wed, 24 Mar 2021 10:34:31 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=5ncqrjTAWBMAuIT+QNk4MgUhfbKLtj8kt+uo2wlM/dg=; b=PISlI40CQm3nn/6AYfPh4VAEVaX46+vrAoFPGv+FIfCNbX/dfRhw301twvFcF1W7fp tJIZiI1/hYX5yIk8M4FF7wWW6kjhjE6qnW1AWg0BpiQ2WfxcHRiN92YdT2Al5w+8qgZI TOIeIxu7+z5JK86KZppnoQWi6aoUzAe27/XauJtm3RZE5TcoBeTV1zPaXGJbVFx1SVq9 cXpzQRQbpPs/CLRZzi8A/DR37PBtQQklruvPt3JBN53GYwHWBdtQL0S1CPqxyW9xWR+c 7LGEsPWhvyo5jil0JJA9C0QS0S4je/Ks+68bJ/U8S3LwVbMiTPp+8B9W0qD/vVM6DPa8 03pw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=5ncqrjTAWBMAuIT+QNk4MgUhfbKLtj8kt+uo2wlM/dg=; b=or4qOmZDw+YQaroSXmIwKVSZo8D+gfWJ446AaJ/BVlrzevCd0HHQcJBaC1+/e8Mzll p6AB9wY9SfiSNn93G+XKgGq/PlvtlmdeElSGLagSN9+3myXX+JJ0NmrzGaTISvmS0J/n N0Quv+EKFk8CU7FSIsCiVCLSrjPfgXxz4Bh3iInUHnTRSlAG8Kgz91YLG7gLIZ/UqwhA WiLDCFb3bmppyR0M+aQIedQB8zyUNJIu+ddr1dHDrSc6KxicN28uijlOrBs5F6XxZHUe ds15mr/KKVE/5GOvst5bB8PU1psNViGkliO7wV4Ro+YgZeMXVHu7s+OibF6HcdRWo9Yd UUHA== X-Gm-Message-State: AOAM532pqdzhYP77wlxzT79M5LUfVvrjsRKiymy66Druc7oe27kz1X/N GS3DWFjJ55DAq0MXqJYAKAn1VQ== X-Google-Smtp-Source: ABdhPJwoWLddMYQprFC2QnlJ4CHKIY3FK362cwfc9slhyDWW/PZ3XNOqAY34ntweYwyIWvqZBmovqw== X-Received: by 2002:a17:906:51c3:: with SMTP id v3mr4959484ejk.497.1616607270465; Wed, 24 Mar 2021 10:34:30 -0700 (PDT) Received: from dell.default ([91.110.221.180]) by smtp.gmail.com with ESMTPSA id p19sm1466367edr.57.2021.03.24.10.34.25 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 24 Mar 2021 10:34:26 -0700 (PDT) From: Lee Jones To: lee.jones@linaro.org Cc: linux-kernel@vger.kernel.org, Jiri Kosina , Benjamin Tissoires , Maxime Coquelin , Alexandre Torgue , Dario Pagani , Kim Kuparinen , 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: Wed, 24 Mar 2021 17:33:57 +0000 Message-Id: <20210324173404.66340-19-lee.jones@linaro.org> X-Mailer: git-send-email 2.27.0 In-Reply-To: <20210324173404.66340-1-lee.jones@linaro.org> References: <20210324173404.66340-1-lee.jones@linaro.org> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-input@vger.kernel.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 Cc: Benjamin Tissoires Cc: Maxime Coquelin Cc: Alexandre Torgue Cc: Dario Pagani Cc: Kim Kuparinen 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 --- 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 #include -/** +/* * 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