Commit e6636d64 authored Aug 27, 2020 by Lee Jones Committed by Kalle Valo Aug 31, 2020

wil6210: txrx: Demote obvious abuse of kernel-doc

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>
Signed-off-by: Kalle Valo <kvalo@codeaurora.org>
Link: https://lore.kernel.org/r/20200827073442.GT3248864@dell

parent 299ff6c6

drivers/net/wireless/ath/wil6210/txrx.c

+10 −20

Original line number	Diff line number	Diff line
		@@ -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
		*/