Netdev Archive on lore.kernel.org
help / color / mirror / Atom feed
From: Lee Jones <lee.jones@linaro.org>
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, Maya Erez <merez@codeaurora.org>,
	wil6210@qti.qualcomm.com
Subject: [PATCH v2 27/32] wireless: ath: wil6210: txrx: Demote obvious abuse of kernel-doc
Date: Thu, 27 Aug 2020 08:34:42 +0100	[thread overview]
Message-ID: <20200827073442.GT3248864@dell> (raw)
In-Reply-To: <20200821071644.109970-28-lee.jones@linaro.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 <merez@codeaurora.org>
Cc: Kalle Valo <kvalo@codeaurora.org>
Cc: "David S. Miller" <davem@davemloft.net>
Cc: Jakub Kicinski <kuba@kernel.org>
Cc: linux-wireless@vger.kernel.org
Cc: wil6210@qti.qualcomm.com
Cc: netdev@vger.kernel.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 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
 		 */
-- 
2.25.1

  reply	other threads:[~2020-08-27  7:34 UTC|newest]

Thread overview: 52+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-08-21  7:16 [PATCH 00/32] Set 2: Rid W=1 warnings in Wireless Lee Jones
2020-08-21  7:16 ` [PATCH 01/32] wireless: marvell: mwifiex: sdio: Move 'static const struct's into their own header file Lee Jones
2020-09-01  9:15   ` Kalle Valo
2020-09-09 14:17     ` Lee Jones
2020-08-21  7:16 ` [PATCH 02/32] wireless: rsi: rsi_91x_mac80211: Add description for function param 'sta' Lee Jones
2020-09-01  9:20   ` [02/32] rsi: " Kalle Valo
2020-08-21  7:16 ` [PATCH 03/32] wireless: intel: iwlwifi: mvm: ops: Remove unused static struct 'iwl_mvm_debug_names' Lee Jones
2020-08-21  7:16 ` [PATCH 04/32] wireless: broadcom: brcm80211: brcmsmac: ampdu: Remove a bunch of unused variables Lee Jones
2020-08-21  7:16 ` [PATCH 05/32] wireless: broadcom: brcm80211: brcmfmac: p2p: Fix a bunch of function docs Lee Jones
2020-08-21  7:16 ` [PATCH 06/32] wireless: rsi: rsi_91x_mgmt: Add descriptions for rsi_set_vap_capabilities()'s parameters Lee Jones
2020-08-21  7:16 ` [PATCH 07/32] wireless: intel: iwlwifi: dvm: rx: Demote a couple of nonconformant kernel-doc headers Lee Jones
2020-08-21  7:16 ` [PATCH 08/32] wireless: intel: iwlwifi: mvm: utils: Fix some doc-rot Lee Jones
2020-08-21  7:16 ` [PATCH 09/32] wireless: broadcom: brcm80211: brcmsmac: main: Remove a bunch of unused variables Lee Jones
2020-08-21  7:16 ` [PATCH 10/32] wireless: rsi: rsi_91x_ps: Source file headers do not make good kernel-doc candidates Lee Jones
2020-08-21  7:16 ` [PATCH 11/32] wireless: intel: iwlwifi: dvm: scan: Demote a few nonconformant kernel-doc headers Lee Jones
2020-08-21  7:16 ` [PATCH 12/32] wireless: brcm80211: brcmfmac: firmware: Demote seemingly unintentional kernel-doc header Lee Jones
2020-08-21  7:16 ` [PATCH 13/32] wireless: intel: iwlwifi: dvm: rxon: Demote non-conformant kernel-doc headers Lee Jones
2020-08-21  7:16 ` [PATCH 14/32] wireless: rsi: rsi_91x_coex: File headers are not suitable for kernel-doc Lee Jones
2020-08-21  7:16 ` [PATCH 15/32] wireless: intel: iwlegacy: 4965-mac: Convert function headers to standard comment blocks Lee Jones
2020-08-21  7:16 ` [PATCH 16/32] wireless: brcm80211: btcoex: Update 'brcmf_btcoex_state' and demote others Lee Jones
2020-09-01  9:23   ` [16/32] brcmfmac: " Kalle Valo
2020-08-21  7:16 ` [PATCH 17/32] wireless: broadcom: b43: phy_ht: Remove 9 year old TODO Lee Jones
2020-08-21  7:16 ` [PATCH 18/32] wireless: intel: iwlwifi: mvm: tx: Demote misuse of kernel-doc headers Lee Jones
2020-08-21  7:16 ` [PATCH 19/32] wireless: intel: iwlwifi: dvm: devices: Fix function documentation formatting issues Lee Jones
2020-08-21  7:16 ` [PATCH 20/32] wireless: rsi: rsi_91x_debugfs: Source file headers are not suitable for kernel-doc Lee Jones
2020-08-21  7:16 ` [PATCH 21/32] wireless: intel: iwlwifi: iwl-drv: Provide descriptions debugfs dentries Lee Jones
2020-08-21  7:16 ` [PATCH 22/32] wireless: intel: iwlegacy: 4965-rs: Demote non kernel-doc headers to standard comment blocks Lee Jones
2020-08-21  7:16 ` [PATCH 23/32] wireless: intel: iwlegacy: 4965-calib: Demote seemingly accidental kernel-doc header Lee Jones
2020-08-21  7:16 ` [PATCH 24/32] wireless: brcmfmac: fwsignal: Remove unused variable 'brcmf_fws_prio2fifo' Lee Jones
2020-08-21  7:16 ` [PATCH 25/32] wireless: ath: wil6210: wmi: Fix formatting and demote non-conforming function headers Lee Jones
2020-08-26 10:21   ` merez
2020-08-26 11:21     ` Lee Jones
2020-08-26 15:55   ` Kalle Valo
     [not found]   ` <20200826155523.EB372C43387@smtp.codeaurora.org>
2020-08-27  6:33     ` Lee Jones
2020-08-27  7:32   ` [PATCH v2 " Lee Jones
2020-08-31 15:19     ` Kalle Valo
2020-08-21  7:16 ` [PATCH 26/32] wireless: ath: wil6210: interrupt: Demote comment header which is clearly not kernel-doc Lee Jones
2020-08-27  7:33   ` [PATCH v2 " Lee Jones
2020-08-21  7:16 ` [PATCH 27/32] wireless: ath: wil6210: txrx: Demote obvious abuse of kernel-doc Lee Jones
2020-08-27  7:34   ` Lee Jones [this message]
2020-08-21  7:16 ` [PATCH 28/32] wireless: ath: wil6210: txrx_edma: Demote comments which are clearly not kernel-doc Lee Jones
2020-08-27  7:35   ` [PATCH v2 " Lee Jones
2020-08-21  7:16 ` [PATCH 29/32] wireless: realtek: rtl8192c: phy_common: Remove unused variable 'bbvalue' Lee Jones
2020-08-21  7:16 ` [PATCH 30/32] wireless: ath: wil6210: pmc: Demote a few nonconformant kernel-doc function headers Lee Jones
2020-08-27  7:37   ` [PATCH v2 " Lee Jones
2020-08-21  7:16 ` [PATCH 31/32] wireless: ath: wil6210: wil_platform: Demote kernel-doc header to standard comment block Lee Jones
2020-08-27  7:38   ` [PATCH v2 " Lee Jones
2020-08-21  7:16 ` [PATCH 32/32] wireless: mediatek: mt76x0: Move tables used only by init.c to their own header file Lee Jones
2020-08-22 18:30 ` [PATCH 00/32] Set 2: Rid W=1 warnings in Wireless Christian Lamparter
2020-08-24  8:16   ` Lee Jones
2020-09-01  9:14 ` Kalle Valo
2020-09-08  8:46   ` Lee Jones

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20200827073442.GT3248864@dell \
    --to=lee.jones@linaro.org \
    --cc=davem@davemloft.net \
    --cc=kuba@kernel.org \
    --cc=kvalo@codeaurora.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-wireless@vger.kernel.org \
    --cc=merez@codeaurora.org \
    --cc=netdev@vger.kernel.org \
    --cc=wil6210@qti.qualcomm.com \
    --subject='Re: [PATCH v2 27/32] wireless: ath: wil6210: txrx: Demote obvious abuse of kernel-doc' \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).