From patchwork Thu Sep 10 06:54:20 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Lee Jones X-Patchwork-Id: 259278 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,DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, 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 B5F77C433E2 for ; Thu, 10 Sep 2020 07:14:57 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 6A86E2075B for ; Thu, 10 Sep 2020 07:14:57 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=linaro.org header.i=@linaro.org header.b="QljOQg6a" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1730077AbgIJHOF (ORCPT ); Thu, 10 Sep 2020 03:14:05 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:41666 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1730252AbgIJG6c (ORCPT ); Thu, 10 Sep 2020 02:58:32 -0400 Received: from mail-wr1-x443.google.com (mail-wr1-x443.google.com [IPv6:2a00:1450:4864:20::443]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 77506C061350 for ; Wed, 9 Sep 2020 23:55:15 -0700 (PDT) Received: by mail-wr1-x443.google.com with SMTP id z4so5440264wrr.4 for ; Wed, 09 Sep 2020 23:55:15 -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=nMutSp2j8lDpsARJd2bf3g5RNBU3idpv78njSHIfOe8=; b=QljOQg6ahzpYjtb0kGIGCOo64fMNlgB1cVe0SNBFGpY0ii1cbB3Sr9cenvrboi77Lw NdZv76OAyTL9u0uR8KeiUdB4cpaDuUc6xZ5ptiP+22K4CrnOIWTJru2o4coGISsMHlzp xlXIZjbRN6Cv6VSxWiU1CzA4o5hIl9/GmU02bF4MuCrSNoRgJSZhyAJcjHELXnhMiDEW hXfucooZSwn7SGDOyzf9EGqSR3/upMRcxev7uYgIS/9wijrOb2ycLY0PhSLqnmr5hHnt qLLjlITbCTXR/9+w3D+m0FCcu1PrwNWOzisEJiqeclHGTyBnS3DQwDj12DMBJyaxVvOu hm7A== 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=nMutSp2j8lDpsARJd2bf3g5RNBU3idpv78njSHIfOe8=; b=lSOQ/OFBd0x3+MF9VOrincuwT9VumQPQU/WtMzJc9p0AsKgpkJh54Do9OWgG8tF6XJ n1Dhly1oUY+ETFvpoAl1wMYh7fHAWehDkRDyw6OGuHCvdYRfMWfSMznsoSpcxeZhyjvz Do16Yu9HyxUH8SjWw5bLfh9IfbEPkKZYAzDraRRpant/xm0gqmCfQ7VEOI8Q/yZw2sI0 orTKQct4/48L1om8TuOEqvxEtj+52axoc566D8xLA1ke7iH6Blwx/lGCn0K6rVyh4i1T 44uMvwVKRJMQpnu7zoDQ4u0RRtlJ01j2rYD11Dmf0eDFRRrR37+rI3hbcM6R5JYx5I9Q iEeg== X-Gm-Message-State: AOAM532v83WVPUzP1FXktV/VN5/F1o5W28UlK0AO+hUNiUXmOfU7lzIs 55Rw8EFZ4ljltYGFpBlSi1o6YQ== X-Google-Smtp-Source: ABdhPJxezyb1HS3XFxzcfbbIQd/MatQOfGqknEyXcbxMZIDF2Fv0wwqEmHgQBEDTOHmpkq+4ePJrUw== X-Received: by 2002:a5d:4645:: with SMTP id j5mr6648574wrs.388.1599720914289; Wed, 09 Sep 2020 23:55:14 -0700 (PDT) Received: from dell.default ([91.110.221.246]) by smtp.gmail.com with ESMTPSA id m3sm2444028wme.31.2020.09.09.23.55.13 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 09 Sep 2020 23:55:13 -0700 (PDT) From: Lee Jones To: kvalo@codeaurora.org, davem@davemloft.net, kuba@kernel.org Cc: linux-kernel@vger.kernel.org, linux-wireless@vger.kernel.org, netdev@vger.kernel.org, Lee Jones , Maya Erez , wil6210@qti.qualcomm.com Subject: [PATCH 18/29] wil6210: txrx: Demote obvious abuse of kernel-doc Date: Thu, 10 Sep 2020 07:54:20 +0100 Message-Id: <20200910065431.657636-19-lee.jones@linaro.org> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20200910065431.657636-1-lee.jones@linaro.org> References: <20200910065431.657636-1-lee.jones@linaro.org> MIME-Version: 1.0 Sender: linux-wireless-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-wireless@vger.kernel.org None of these headers provide any parameter documentation. Fixes the following W=1 kernel build warning(s): drivers/net/wireless/ath/wil6210/txrx.c:259: warning: Function parameter or member 'wil' not described in 'wil_vring_alloc_skb' drivers/net/wireless/ath/wil6210/txrx.c:259: warning: Function parameter or member 'vring' not described in 'wil_vring_alloc_skb' drivers/net/wireless/ath/wil6210/txrx.c:259: warning: Function parameter or member 'i' not described in 'wil_vring_alloc_skb' drivers/net/wireless/ath/wil6210/txrx.c:259: warning: Function parameter or member 'headroom' not described in 'wil_vring_alloc_skb' drivers/net/wireless/ath/wil6210/txrx.c:309: warning: Function parameter or member 'wil' not described in 'wil_rx_add_radiotap_header' drivers/net/wireless/ath/wil6210/txrx.c:309: warning: Function parameter or member 'skb' not described in 'wil_rx_add_radiotap_header' drivers/net/wireless/ath/wil6210/txrx.c:444: warning: Function parameter or member 'wil' not described in 'wil_vring_reap_rx' drivers/net/wireless/ath/wil6210/txrx.c:444: warning: Function parameter or member 'vring' not described in 'wil_vring_reap_rx' drivers/net/wireless/ath/wil6210/txrx.c:610: warning: Function parameter or member 'wil' not described in 'wil_rx_refill' drivers/net/wireless/ath/wil6210/txrx.c:610: warning: Function parameter or member 'count' not described in 'wil_rx_refill' drivers/net/wireless/ath/wil6210/txrx.c:1011: warning: Function parameter or member 'wil' not described in 'wil_rx_handle' drivers/net/wireless/ath/wil6210/txrx.c:1011: warning: Function parameter or member 'quota' not described in 'wil_rx_handle' drivers/net/wireless/ath/wil6210/txrx.c:1643: warning: Function parameter or member 'd' not described in 'wil_tx_desc_offload_setup_tso' drivers/net/wireless/ath/wil6210/txrx.c:1643: warning: Function parameter or member 'skb' not described in 'wil_tx_desc_offload_setup_tso' drivers/net/wireless/ath/wil6210/txrx.c:1643: warning: Function parameter or member 'tso_desc_type' not described in 'wil_tx_desc_offload_setup_tso' drivers/net/wireless/ath/wil6210/txrx.c:1643: warning: Function parameter or member 'is_ipv4' not described in 'wil_tx_desc_offload_setup_tso' drivers/net/wireless/ath/wil6210/txrx.c:1643: warning: Function parameter or member 'tcp_hdr_len' not described in 'wil_tx_desc_offload_setup_tso' drivers/net/wireless/ath/wil6210/txrx.c:1643: warning: Function parameter or member 'skb_net_hdr_len' not described in 'wil_tx_desc_offload_setup_tso' drivers/net/wireless/ath/wil6210/txrx.c:1674: warning: Function parameter or member 'd' not described in 'wil_tx_desc_offload_setup' drivers/net/wireless/ath/wil6210/txrx.c:1674: warning: Function parameter or member 'skb' not described in 'wil_tx_desc_offload_setup' drivers/net/wireless/ath/wil6210/txrx.c:2240: warning: Function parameter or member 'wil' not described in '__wil_update_net_queues' drivers/net/wireless/ath/wil6210/txrx.c:2240: warning: Function parameter or member 'vif' not described in '__wil_update_net_queues' drivers/net/wireless/ath/wil6210/txrx.c:2240: warning: Function parameter or member 'ring' not described in '__wil_update_net_queues' drivers/net/wireless/ath/wil6210/txrx.c:2240: warning: Function parameter or member 'check_stop' not described in '__wil_update_net_queues' drivers/net/wireless/ath/wil6210/txrx.c:2430: warning: Function parameter or member 'vif' not described in 'wil_tx_complete' drivers/net/wireless/ath/wil6210/txrx.c:2430: warning: Function parameter or member 'ringid' not described in 'wil_tx_complete' Cc: Maya Erez Cc: Kalle Valo Cc: "David S. Miller" Cc: Jakub Kicinski Cc: linux-wireless@vger.kernel.org Cc: wil6210@qti.qualcomm.com Cc: netdev@vger.kernel.org Signed-off-by: Lee Jones --- drivers/net/wireless/ath/wil6210/txrx.c | 30 +++++++++---------------- 1 file changed, 10 insertions(+), 20 deletions(-) diff --git a/drivers/net/wireless/ath/wil6210/txrx.c b/drivers/net/wireless/ath/wil6210/txrx.c index 080e5aa60bea4..cc830c795b33c 100644 --- a/drivers/net/wireless/ath/wil6210/txrx.c +++ b/drivers/net/wireless/ath/wil6210/txrx.c @@ -249,8 +249,7 @@ static void wil_vring_free(struct wil6210_priv *wil, struct wil_ring *vring) vring->ctx = NULL; } -/** - * Allocate one skb for Rx VRING +/* Allocate one skb for Rx VRING * * Safe to call from IRQ */ @@ -295,8 +294,7 @@ static int wil_vring_alloc_skb(struct wil6210_priv *wil, struct wil_ring *vring, return 0; } -/** - * Adds radiotap header +/* Adds radiotap header * * Any error indicated as "Bad FCS" * @@ -432,8 +430,7 @@ static int wil_rx_get_cid_by_skb(struct wil6210_priv *wil, struct sk_buff *skb) return cid; } -/** - * reap 1 frame from @swhead +/* reap 1 frame from @swhead * * Rx descriptor copied to skb->cb * @@ -597,8 +594,7 @@ static struct sk_buff *wil_vring_reap_rx(struct wil6210_priv *wil, return skb; } -/** - * allocate and fill up to @count buffers in rx ring +/* allocate and fill up to @count buffers in rx ring * buffers posted at @swtail * Note: we have a single RX queue for servicing all VIFs, but we * allocate skbs with headroom according to main interface only. This @@ -1002,8 +998,7 @@ void wil_netif_rx_any(struct sk_buff *skb, struct net_device *ndev) wil_netif_rx(skb, ndev, cid, stats, true); } -/** - * Proceed all completed skb's from Rx VRING +/* Proceed all completed skb's from Rx VRING * * Safe to call from NAPI poll, i.e. softirq with interrupts enabled */ @@ -1629,8 +1624,7 @@ void wil_tx_desc_set_nr_frags(struct vring_tx_desc *d, int nr_frags) d->mac.d[2] |= (nr_frags << MAC_CFG_DESC_TX_2_NUM_OF_DESCRIPTORS_POS); } -/** - * Sets the descriptor @d up for csum and/or TSO offloading. The corresponding +/* Sets the descriptor @d up for csum and/or TSO offloading. The corresponding * @skb is used to obtain the protocol and headers length. * @tso_desc_type is a descriptor type for TSO: 0 - a header, 1 - first data, * 2 - middle, 3 - last descriptor. @@ -1660,8 +1654,7 @@ static void wil_tx_desc_offload_setup_tso(struct vring_tx_desc *d, d->dma.d0 |= BIT(DMA_CFG_DESC_TX_0_PSEUDO_HEADER_CALC_EN_POS); } -/** - * Sets the descriptor @d up for csum. The corresponding +/* Sets the descriptor @d up for csum. The corresponding * @skb is used to obtain the protocol and headers length. * Returns the protocol: 0 - not TCP, 1 - TCPv4, 2 - TCPv6. * Note, if d==NULL, the function only returns the protocol result. @@ -2216,8 +2209,7 @@ static int wil_tx_ring(struct wil6210_priv *wil, struct wil6210_vif *vif, return rc; } -/** - * Check status of tx vrings and stop/wake net queues if needed +/* Check status of tx vrings and stop/wake net queues if needed * It will start/stop net queues of a specific VIF net_device. * * This function does one of two checks: @@ -2419,8 +2411,7 @@ void wil_tx_latency_calc(struct wil6210_priv *wil, struct sk_buff *skb, sta->stats.tx_latency_max_us = skb_time_us; } -/** - * Clean up transmitted skb's from the Tx VRING +/* Clean up transmitted skb's from the Tx VRING * * Return number of descriptors cleared * @@ -2460,8 +2451,7 @@ int wil_tx_complete(struct wil6210_vif *vif, int ringid) while (!wil_ring_is_empty(vring)) { int new_swtail; struct wil_ctx *ctx = &vring->ctx[vring->swtail]; - /** - * For the fragmented skb, HW will set DU bit only for the + /* For the fragmented skb, HW will set DU bit only for the * last fragment. look for it. * In TSO the first DU will include hdr desc */