From patchwork Fri Jan 15 20:09:05 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Lee Jones X-Patchwork-Id: 12024053 X-Patchwork-Delegate: kuba@kernel.org 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=unavailable 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 D9C2AC43381 for ; Fri, 15 Jan 2021 20:11:30 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id B636B23A5A for ; Fri, 15 Jan 2021 20:11:30 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S2388665AbhAOUKw (ORCPT ); Fri, 15 Jan 2021 15:10:52 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:53348 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S2388220AbhAOUKj (ORCPT ); Fri, 15 Jan 2021 15:10:39 -0500 Received: from mail-wm1-x32d.google.com (mail-wm1-x32d.google.com [IPv6:2a00:1450:4864:20::32d]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 3E36AC0617A2 for ; Fri, 15 Jan 2021 12:09:26 -0800 (PST) Received: by mail-wm1-x32d.google.com with SMTP id o10so2520434wmc.1 for ; Fri, 15 Jan 2021 12:09:26 -0800 (PST) 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=ChGB+JX2oknD3GU9F+oPlQzChiJ0MNf1JzMjKC1b9JA=; b=hHi5eCMSCKRIHZs+AW6PVjhBGk5PWZBITFLeeaKh02RUYGNWd0XuWAmygYxQpSiMLo /IvW0bfnHYArnuKkoy6CXoAGaWY8H6k725azzyJjS2Fh4zVgdjHEMiJTXNrf6YQNkbPD C+7hiAeDdU5YHHsQa3cEfg9kJVWfwjlmESJyu2CVsSPC/bsrps5ZLiueS2vnWR+Tuy/R z1ZuMPcgf4zaHO2wZo2rclu7WKsBfImD3PGT91PkoVoA+U4EB/2blW1dbDyp7SYouhvk UO2HkHXxHfglxvTYwYktfI1KP5fnDKgbPN8gSCC4WG5I3hlgBZmbFxZeFFkhA44N7sr5 Cvow== 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=ChGB+JX2oknD3GU9F+oPlQzChiJ0MNf1JzMjKC1b9JA=; b=IubMVr5dtKT2l2FHMFwhgZJG1oQuLeptrIcLN0Ek+BfF802j9AQndFPfwllCb1Owb/ 07GWVkK8yezunM5WAS2fM8NDgGl6hNisC3Qe1TU7EjeJDjV2yx3u44dU7ZfbyqEz/e45 05LbwxaTlxPW1NgEohhinmK8If0hskfyU/bEhkmMC8qdfevtk9/DlMHGwYRnqAIefxGM 3WILTfscaALqJ7J2/TRTLw6/Xd4cPnmNi39jjdp5FGwM4GjO7KWYnhzeCNAi5QKehNeJ Mz873GiLrfI3Z/d7fB6hrgMkwxc01zUCVCzt9CGO31ejU0RoSLcVhcvuErfdWMGaV26r e4YQ== X-Gm-Message-State: AOAM531igCwezNIyYK5WG5lNQdgUqZka2ItkuPokzCcQvddM7vnF52v9 Ai8gwCxMuWbTKChyMajDWQg0gg== X-Google-Smtp-Source: ABdhPJwpsJ6om7dpmSink2Kvd+WW/SYJt/aG/4x3TTcsakw95M5VDVS8RCTFjl29lRPpQrnhIqkNsQ== X-Received: by 2002:a1c:10c:: with SMTP id 12mr10286793wmb.186.1610741364928; Fri, 15 Jan 2021 12:09:24 -0800 (PST) Received: from dell.default ([91.110.221.158]) by smtp.gmail.com with ESMTPSA id d85sm9187863wmd.2.2021.01.15.12.09.23 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 15 Jan 2021 12:09:24 -0800 (PST) From: Lee Jones To: lee.jones@linaro.org Cc: linux-kernel@vger.kernel.org, Ishizaki Kou , "David S. Miller" , Jakub Kicinski , Utz Bacher , Jens Osterkamp , netdev@vger.kernel.org, Andrew Lunn Subject: [PATCH 7/7] net: ethernet: toshiba: spider_net: Document a whole bunch of function parameters Date: Fri, 15 Jan 2021 20:09:05 +0000 Message-Id: <20210115200905.3470941-8-lee.jones@linaro.org> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20210115200905.3470941-1-lee.jones@linaro.org> References: <20210115200905.3470941-1-lee.jones@linaro.org> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: netdev@vger.kernel.org X-Patchwork-Delegate: kuba@kernel.org Fixes the following W=1 kernel build warning(s): drivers/net/ethernet/toshiba/spider_net.c:263: warning: Function parameter or member 'hwdescr' not described in 'spider_net_get_descr_status' drivers/net/ethernet/toshiba/spider_net.c:263: warning: Excess function parameter 'descr' description in 'spider_net_get_descr_status' drivers/net/ethernet/toshiba/spider_net.c:554: warning: Function parameter or member 'netdev' not described in 'spider_net_get_multicast_hash' drivers/net/ethernet/toshiba/spider_net.c:902: warning: Function parameter or member 't' not described in 'spider_net_cleanup_tx_ring' drivers/net/ethernet/toshiba/spider_net.c:902: warning: Excess function parameter 'card' description in 'spider_net_cleanup_tx_ring' drivers/net/ethernet/toshiba/spider_net.c:1074: warning: Function parameter or member 'card' not described in 'spider_net_resync_head_ptr' drivers/net/ethernet/toshiba/spider_net.c:1234: warning: Function parameter or member 'napi' not described in 'spider_net_poll' drivers/net/ethernet/toshiba/spider_net.c:1234: warning: Excess function parameter 'netdev' description in 'spider_net_poll' drivers/net/ethernet/toshiba/spider_net.c:1278: warning: Function parameter or member 'p' not described in 'spider_net_set_mac' drivers/net/ethernet/toshiba/spider_net.c:1278: warning: Excess function parameter 'ptr' description in 'spider_net_set_mac' drivers/net/ethernet/toshiba/spider_net.c:1350: warning: Function parameter or member 'error_reg1' not described in 'spider_net_handle_error_irq' drivers/net/ethernet/toshiba/spider_net.c:1350: warning: Function parameter or member 'error_reg2' not described in 'spider_net_handle_error_irq' drivers/net/ethernet/toshiba/spider_net.c:1968: warning: Function parameter or member 't' not described in 'spider_net_link_phy' drivers/net/ethernet/toshiba/spider_net.c:1968: warning: Excess function parameter 'data' description in 'spider_net_link_phy' drivers/net/ethernet/toshiba/spider_net.c:2149: warning: Function parameter or member 'work' not described in 'spider_net_tx_timeout_task' drivers/net/ethernet/toshiba/spider_net.c:2149: warning: Excess function parameter 'data' description in 'spider_net_tx_timeout_task' drivers/net/ethernet/toshiba/spider_net.c:2182: warning: Function parameter or member 'txqueue' not described in 'spider_net_tx_timeout' Cc: Ishizaki Kou Cc: "David S. Miller" Cc: Jakub Kicinski Cc: Utz Bacher Cc: Jens Osterkamp Cc: netdev@vger.kernel.org Reviewed-by: Andrew Lunn Signed-off-by: Lee Jones --- drivers/net/ethernet/toshiba/spider_net.c | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/drivers/net/ethernet/toshiba/spider_net.c b/drivers/net/ethernet/toshiba/spider_net.c index 5f5b33e6653b2..d5a75ef7e3ca9 100644 --- a/drivers/net/ethernet/toshiba/spider_net.c +++ b/drivers/net/ethernet/toshiba/spider_net.c @@ -254,7 +254,7 @@ spider_net_set_promisc(struct spider_net_card *card) /** * spider_net_get_descr_status -- returns the status of a descriptor - * @descr: descriptor to look at + * @hwdescr: descriptor to look at * * returns the status as in the dmac_cmd_status field of the descriptor */ @@ -542,6 +542,7 @@ spider_net_alloc_rx_skbs(struct spider_net_card *card) /** * spider_net_get_multicast_hash - generates hash for multicast filter table + * @netdev: interface device structure * @addr: multicast address * * returns the hash value. @@ -890,7 +891,7 @@ spider_net_xmit(struct sk_buff *skb, struct net_device *netdev) /** * spider_net_cleanup_tx_ring - cleans up the TX ring - * @card: card structure + * @t: timer context used to obtain the pointer to net card data structure * * spider_net_cleanup_tx_ring is called by either the tx_timer * or from the NAPI polling routine. @@ -1063,6 +1064,7 @@ static void show_rx_chain(struct spider_net_card *card) /** * spider_net_resync_head_ptr - Advance head ptr past empty descrs + * @card: card structure * * If the driver fails to keep up and empty the queue, then the * hardware wil run out of room to put incoming packets. This @@ -1220,7 +1222,7 @@ spider_net_decode_one_descr(struct spider_net_card *card) /** * spider_net_poll - NAPI poll function called by the stack to return packets - * @netdev: interface device structure + * @napi: napi device structure * @budget: number of packets we can pass to the stack at most * * returns 0 if no more packets available to the driver/stack. Returns 1, @@ -1268,7 +1270,7 @@ static int spider_net_poll(struct napi_struct *napi, int budget) /** * spider_net_set_mac - sets the MAC of an interface * @netdev: interface device structure - * @ptr: pointer to new MAC address + * @p: pointer to new MAC address * * Returns 0 on success, <0 on failure. Currently, we don't support this * and will always return EOPNOTSUPP. @@ -1340,6 +1342,8 @@ spider_net_link_reset(struct net_device *netdev) * spider_net_handle_error_irq - handles errors raised by an interrupt * @card: card structure * @status_reg: interrupt status register 0 (GHIINT0STS) + * @error_reg1: interrupt status register 1 (GHIINT1STS) + * @error_reg2: interrupt status register 2 (GHIINT2STS) * * spider_net_handle_error_irq treats or ignores all error conditions * found when an interrupt is presented @@ -1961,8 +1965,7 @@ spider_net_open(struct net_device *netdev) /** * spider_net_link_phy - * @data: used for pointer to card structure - * + * @t: timer context used to obtain the pointer to net card data structure */ static void spider_net_link_phy(struct timer_list *t) { @@ -2140,7 +2143,7 @@ spider_net_stop(struct net_device *netdev) /** * spider_net_tx_timeout_task - task scheduled by the watchdog timeout * function (to be called not under interrupt status) - * @data: data, is interface device structure + * @work: work context used to obtain the pointer to net card data structure * * called as task when tx hangs, resets interface (if interface is up) */ @@ -2174,6 +2177,7 @@ spider_net_tx_timeout_task(struct work_struct *work) /** * spider_net_tx_timeout - called when the tx timeout watchdog kicks in. * @netdev: interface device structure + * @txqueue: unused * * called, if tx hangs. Schedules a task that resets the interface */