From patchwork Wed Nov 4 09:06:09 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Lee Jones X-Patchwork-Id: 11880023 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=-12.8 required=3.0 tests=BAYES_00,DKIMWL_WL_HIGH, DKIM_SIGNED,DKIM_VALID,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_PATCH, MAILING_LIST_MULTI,SIGNED_OFF_BY,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 88930C388F7 for ; Wed, 4 Nov 2020 09:10:25 +0000 (UTC) Received: from merlin.infradead.org (merlin.infradead.org [205.233.59.134]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id 0CAE52242A for ; Wed, 4 Nov 2020 09:10:22 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=lists.infradead.org header.i=@lists.infradead.org header.b="FtspIO07"; dkim=fail reason="signature verification failed" (2048-bit key) header.d=linaro.org header.i=@linaro.org header.b="YiTypI8h" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 0CAE52242A Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=linaro.org Authentication-Results: mail.kernel.org; spf=none smtp.mailfrom=linux-arm-kernel-bounces+linux-arm-kernel=archiver.kernel.org@lists.infradead.org DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=merlin.20170209; h=Sender:Content-Transfer-Encoding: Content-Type:Cc:List-Subscribe:List-Help:List-Post:List-Archive: List-Unsubscribe:List-Id:MIME-Version:References:In-Reply-To:Message-Id:Date: Subject:To:From:Reply-To:Content-ID:Content-Description:Resent-Date: Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:List-Owner; bh=EUzb7Fid8DNT9TgCxDNufwSTeC1h+e/6Xry152RzBv0=; b=FtspIO07isT2m0VeO205yCkw4 setHVzDoIaz83kkPT3M9z7MUobuFHAaY6UUkxg8C6HKuo5pbJ1TxSSr5R85gzW1yFW0dXZZdcBJ44 AdAX8Sfnauzj9bOK99ANg7+P8xDT2gqxaWyr4Vwf55s9ZUZ1yc9vk0FfoJNsj0/BR+5djWulF82tS xn/TD586UHGBhwdsS2EX+ibEjpO5Yu4T0Eg7Kl5PllqSftw0wqM46EtrJ9+UJnxv54UQK3ngZqqYx 71Yh/kmbA84iuYbsYB5ZjZim8k1P/58pcUXG3oFw5P0xS46Jv1ewNlsKaylUVozFdNCcXDyRBjDPj BZYHgICwQ==; Received: from localhost ([::1] helo=merlin.infradead.org) by merlin.infradead.org with esmtp (Exim 4.92.3 #3 (Red Hat Linux)) id 1kaEmI-0004QE-M5; Wed, 04 Nov 2020 09:08:26 +0000 Received: from mail-wm1-x342.google.com ([2a00:1450:4864:20::342]) by merlin.infradead.org with esmtps (Exim 4.92.3 #3 (Red Hat Linux)) id 1kaEkY-0003k7-L6 for linux-arm-kernel@lists.infradead.org; Wed, 04 Nov 2020 09:06:53 +0000 Received: by mail-wm1-x342.google.com with SMTP id p22so1611429wmg.3 for ; Wed, 04 Nov 2020 01:06:38 -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=x/23In7GphBjuvLzsFPzeVbxW1AkJoC7VMLuq9ClVEg=; b=YiTypI8hZJMKh9sJmaRi+HggGPKXrCVi8Zu3qoOl9kAypEC44nS3VpgKl3xbzREdyZ wfzHIsbs5c8WghTROvmLFtBQldqLIdaPixDKKmGXQMzCzH3DsnplE0PdACjD41pSynpL JN9oaLaiescMESIiZ1sdG85mnee6jGVqVVZLF9oLC58tvmS7C06vyoFuCz0bKihAZ/fd xJeS3uq+I2VvPb0B+y62Rx3H/GtEBiO4eFy9wrt5dba5KTYI3UJB/LPeckZECimjm40/ +xmzeoOWt2rR2d2Srid3vuCeAcQ2aWMnk8j4FibtOnSxwAzpV0unN7ZPF9FcnjZmJdOt /YRA== 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=x/23In7GphBjuvLzsFPzeVbxW1AkJoC7VMLuq9ClVEg=; b=nQ2XTGzvf/rWe6OOlUkR/KrTbyTMMIk2QTduEeknjyTyfm3KxtdOZIf75FqX1a69XN xePo/mRTfcDWrd9/qvT5fHvHLNymNf0u+DT0kgZz663lnoxFJyW3UZ7bOFoJjdDtr5y+ nI+1XEMjO1dbl7/XxreX/2wTJbjWJCCJwBgUMaiHVc6bgtKXa9pJxTFWFMjw6alGoY8W OvO/S7xLjn4+O5SvEXOWgFyFGFN1kR1e+RiQccZsltu/9sDbaJmtlHaJEZ8CEtTvIMlR qxuGllLab6f3rV1/GwYpxbOY+dYK/r4NCvYw1irAhM5bq8TvYELAFcXdPsMLrJu4G1Go GtnA== X-Gm-Message-State: AOAM533K4boQmk6WEDcwrFSBAT6sH9+pULX6zJNiu6c4We5YsuvIvS7A Dmcu1yKMr8lVA0vUiizxmuYwcg== X-Google-Smtp-Source: ABdhPJwlkdu+Vqx5xsQ3QhGy+QHBeYuiPfQ8/LYaV54nnmwGfoK2ltW77cXk6AUAu/xw/u3S5vS+7Q== X-Received: by 2002:a1c:1b8f:: with SMTP id b137mr3312243wmb.61.1604480797705; Wed, 04 Nov 2020 01:06:37 -0800 (PST) Received: from dell.default ([91.110.221.242]) by smtp.gmail.com with ESMTPSA id e25sm1607823wrc.76.2020.11.04.01.06.36 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 04 Nov 2020 01:06:36 -0800 (PST) From: Lee Jones To: davem@davemloft.net, kuba@kernel.org Subject: [PATCH 11/12] net: ethernet: toshiba: spider_net: Document a whole bunch of function parameters Date: Wed, 4 Nov 2020 09:06:09 +0000 Message-Id: <20201104090610.1446616-12-lee.jones@linaro.org> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20201104090610.1446616-1-lee.jones@linaro.org> References: <20201104090610.1446616-1-lee.jones@linaro.org> MIME-Version: 1.0 X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20201104_040639_050548_8932BDF0 X-CRM114-Status: GOOD ( 20.59 ) X-BeenThere: linux-arm-kernel@lists.infradead.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Jens Osterkamp , linux-kernel@vger.kernel.org, netdev@vger.kernel.org, Utz Bacher , Lee Jones , linux-arm-kernel@lists.infradead.org, Ishizaki Kou Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+linux-arm-kernel=archiver.kernel.org@lists.infradead.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 Signed-off-by: Lee Jones Reviewed-by: Andrew Lunn --- 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 */