From patchwork Fri Mar 26 14:34:49 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Lee Jones X-Patchwork-Id: 12166873 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 941C7C433F8 for ; Fri, 26 Mar 2021 14:36:18 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 7DE9661A24 for ; Fri, 26 Mar 2021 14:36:18 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S230475AbhCZOf4 (ORCPT ); Fri, 26 Mar 2021 10:35:56 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:52710 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230288AbhCZOfU (ORCPT ); Fri, 26 Mar 2021 10:35:20 -0400 Received: from mail-wr1-x42b.google.com (mail-wr1-x42b.google.com [IPv6:2a00:1450:4864:20::42b]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 12966C0613B1 for ; Fri, 26 Mar 2021 07:35:19 -0700 (PDT) Received: by mail-wr1-x42b.google.com with SMTP id j7so5896213wrd.1 for ; Fri, 26 Mar 2021 07:35:19 -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=GplnaeoWUVj8YBA4hvKiO7ws+s2Csp6NEYWiX1mt5gw=; b=gVdY+BmiCv/le2JaAaXRNqHZOQ8FZPr77309AVj8qiOYOzB9wwc47ATRvKul6T1NMP sMaB3udcySV2cCjdqJ+8S5gvcJc3cwMtvek2Yk+zte3A4Y5Aaj/ttoXO3Qr21eXHsXJA +KdCKUwMY0faf8nInYF4e1kbRs4brqRmeIOnZlnjfKkG/qyrE6QM9dnZzCyN9HBJgWJN FJXL/foszoatEtn2KABcnNNi7sO/40iEDJyYspDOT49dQK7vkAARyAa/cmJ1OOu5nL3n uD9m3g8oT8AP+dNSMQqA2EpjCgMPx6HrRIzZn0KNGPvstVJZBts/2fvzmcDZc0zKfAI5 O4nA== 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=GplnaeoWUVj8YBA4hvKiO7ws+s2Csp6NEYWiX1mt5gw=; b=YDGxIVdaRJoaBGH3QlmMjD7DOCn/AzaGjARuz1Bf8+PexXA3A3HTTeYMZXmA7XbtzR tCJklinGIw/IFyuQZkpthBawNQ5GUSvCaaSbkTn0+tDpjptNVUGSNGlTiZq5E5L83iSW rj/X0lX/AeV4YGDn8LAGPdZCniQ4gh9AxhahBmjpHQtjy5PSRrWym6zFp6nb7AxAlfdB knSlbnLVBmFaieeCYWqm5tpKjqMyfvkQq4/K7tQ6V5NgjzTrOpL9oQX7mWzs9O/FDTAq NeQLfCGUalOt/Bzwh4GXFvL9RBj0jrRr6eXZIp9p/2/+8PEUCr4dLuB9qfJ6sZUVGyac OQdg== X-Gm-Message-State: AOAM5311wXidgKtG6Bvu3mP83orSL0+/6Kb9yMW1AyYTBYvPa+CM9DaV aipU06+FpLr3IqlPanw3aJQH5Q== X-Google-Smtp-Source: ABdhPJxrW/9zfhqyJX4I2dQcZ7VFapl1sAqOLChKrPCi63yz44kL11ViapqAsr1hJOmqk6421X27uw== X-Received: by 2002:adf:fa8d:: with SMTP id h13mr14798114wrr.331.1616769317753; Fri, 26 Mar 2021 07:35:17 -0700 (PDT) Received: from dell.default ([91.110.221.194]) by smtp.gmail.com with ESMTPSA id j26sm12878225wrh.57.2021.03.26.07.35.16 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 26 Mar 2021 07:35:17 -0700 (PDT) From: Lee Jones To: lee.jones@linaro.org Cc: linux-kernel@vger.kernel.org, Jiri Kosina , Benjamin Tissoires , Henrik Rydberg , Lopez Casado , linux-input@vger.kernel.org Subject: [PATCH 16/25] HID: hid-logitech-hidpp: Fix conformant kernel-doc header and demote abuses Date: Fri, 26 Mar 2021 14:34:49 +0000 Message-Id: <20210326143458.508959-18-lee.jones@linaro.org> X-Mailer: git-send-email 2.27.0 In-Reply-To: <20210326143458.508959-1-lee.jones@linaro.org> References: <20210326143458.508959-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-logitech-hidpp.c:275: warning: Function parameter or member 'hidpp' not described in 'hidpp_send_message_sync' drivers/hid/hid-logitech-hidpp.c:275: warning: Function parameter or member 'message' not described in 'hidpp_send_message_sync' drivers/hid/hid-logitech-hidpp.c:275: warning: Function parameter or member 'response' not described in 'hidpp_send_message_sync' drivers/hid/hid-logitech-hidpp.c:275: warning: expecting prototype for and something else(). Prototype was for hidpp_send_message_sync() instead drivers/hid/hid-logitech-hidpp.c:427: warning: wrong kernel-doc identifier on line: drivers/hid/hid-logitech-hidpp.c:470: warning: Function parameter or member 'input_dev' not described in 'hidpp_scroll_counter_handle_scroll' drivers/hid/hid-logitech-hidpp.c:1894: warning: Function parameter or member 'hidpp' not described in 'hidpp_touchpad_fw_items_set' drivers/hid/hid-logitech-hidpp.c:1894: warning: Function parameter or member 'feature_index' not described in 'hidpp_touchpad_fw_items_set' drivers/hid/hid-logitech-hidpp.c:1894: warning: Function parameter or member 'items' not described in 'hidpp_touchpad_fw_items_set' drivers/hid/hid-logitech-hidpp.c:1894: warning: expecting prototype for send a set state command to the device by reading the current items(). Prototype was for hidpp_touchpad_fw_items_set() instead Cc: Jiri Kosina Cc: Benjamin Tissoires Cc: Henrik Rydberg Cc: Lopez Casado Cc: linux-input@vger.kernel.org Signed-off-by: Lee Jones --- drivers/hid/hid-logitech-hidpp.c | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/drivers/hid/hid-logitech-hidpp.c b/drivers/hid/hid-logitech-hidpp.c index d459e2dbe6474..d598094dadd0c 100644 --- a/drivers/hid/hid-logitech-hidpp.c +++ b/drivers/hid/hid-logitech-hidpp.c @@ -261,7 +261,7 @@ static int __hidpp_send_report(struct hid_device *hdev, return ret == fields_count ? 0 : -1; } -/** +/* * hidpp_send_message_sync() returns 0 in case of success, and something else * in case of a failure. * - If ' something else' is positive, that means that an error has been raised @@ -423,7 +423,7 @@ static inline bool hidpp_report_is_connect_event(struct hidpp_device *hidpp, (report->rap.sub_id == 0x41)); } -/** +/* * hidpp_prefix_name() prefixes the current given name with "Logitech ". */ static void hidpp_prefix_name(char **name, int name_length) @@ -454,6 +454,7 @@ static void hidpp_prefix_name(char **name, int name_length) * hidpp_scroll_counter_handle_scroll() - Send high- and low-resolution scroll * events given a high-resolution wheel * movement. + * @input_dev: Pointer to the input device * @counter: a hid_scroll_counter struct describing the wheel. * @hi_res_value: the movement of the wheel, in the mouse's high-resolution * units. @@ -1884,7 +1885,7 @@ struct hidpp_touchpad_fw_items { uint8_t persistent; }; -/** +/* * send a set state command to the device by reading the current items->state * field. items is then filled with the current state. */