From dec6a3c6d6dfc6402118529de230e76e65df9a9b Mon Sep 17 00:00:00 2001 From: Randy Dunlap Date: Sun, 16 Nov 2025 18:02:13 -0800 Subject: [PATCH] wifi: wil6210: fix a bunch of kernel-doc warnings scripts/kernel-doc.py reports 51 kernel-doc warnings in wil6210.h. Fix all kernel-doc warnings reported in wil6210.h. Several comments are changed from "/**" to "/*" since it appears that "/**" was used for many non-kernel-doc comments. - add kernel-doc for missing function parameters - add one function "Returns:" - correct kernel-doc struct name to match actual struct name in 2 places Signed-off-by: Randy Dunlap Reviewed-by: Simon Horman Link: https://patch.msgid.link/20251117020213.443126-1-rdunlap@infradead.org Signed-off-by: Jeff Johnson --- drivers/net/wireless/ath/wil6210/wil6210.h | 33 +++++++++++----------- 1 file changed, 16 insertions(+), 17 deletions(-) diff --git a/drivers/net/wireless/ath/wil6210/wil6210.h b/drivers/net/wireless/ath/wil6210/wil6210.h index 9bd1286d2857b..31e107c81e2d4 100644 --- a/drivers/net/wireless/ath/wil6210/wil6210.h +++ b/drivers/net/wireless/ath/wil6210/wil6210.h @@ -58,7 +58,7 @@ union wil_tx_desc; */ #define WIL_MAX_VIFS 4 -/** +/* * extract bits [@b0:@b1] (inclusive) from the value @x * it should be @b0 <= @b1, or result is incorrect */ @@ -433,7 +433,7 @@ extern struct fw_map fw_mapping[MAX_FW_MAPPING_TABLE_SIZE]; * @cid: CID value * @tid: TID value * - * @cidxtid field encoded as bits 0..3 - CID; 4..7 - TID + * Returns: @cidxtid field encoded as bits 0..3 - CID; 4..7 - TID */ static inline u8 mk_cidxtid(u8 cid, u8 tid) { @@ -444,8 +444,7 @@ static inline u8 mk_cidxtid(u8 cid, u8 tid) * parse_cidxtid - parse @cidxtid field * @cid: store CID value here * @tid: store TID value here - * - * @cidxtid field encoded as bits 0..3 - CID; 4..7 - TID + * @cidxtid: field encoded as bits 0..3 - CID; 4..7 - TID */ static inline void parse_cidxtid(u8 cidxtid, u8 *cid, u8 *tid) { @@ -500,7 +499,7 @@ enum { /* for wil_ctx.mapped_as */ wil_mapped_as_page = 2, }; -/** +/* * struct wil_ctx - software context for ring descriptor */ struct wil_ctx { @@ -514,7 +513,7 @@ struct wil_desc_ring_rx_swtail { /* relevant for enhanced DMA only */ dma_addr_t pa; }; -/** +/* * A general ring structure, used for RX and TX. * In legacy DMA it represents the vring, * In enahnced DMA it represents the descriptor ring (vrings are handled by FW) @@ -531,7 +530,7 @@ struct wil_ring { bool is_rx; }; -/** +/* * Additional data for Rx ring. * Used for enhanced DMA RX chaining. */ @@ -543,7 +542,7 @@ struct wil_ring_rx_data { u16 buff_size; }; -/** +/* * Status ring structure, used for enhanced DMA completions for RX and TX. */ struct wil_status_ring { @@ -586,8 +585,8 @@ struct wil_net_stats { u32 ft_roams; /* relevant in STA mode */ }; -/** - * struct tx_rx_ops - different TX/RX ops for legacy and enhanced +/* + * struct wil_txrx_ops - different TX/RX ops for legacy and enhanced * DMA flow */ struct wil_txrx_ops { @@ -627,7 +626,7 @@ struct wil_txrx_ops { irqreturn_t (*irq_rx)(int irq, void *cookie); }; -/** +/* * Additional data for Tx ring */ struct wil_ring_tx_data { @@ -658,7 +657,7 @@ enum { /* for wil6210_priv.status */ struct pci_dev; /** - * struct tid_ampdu_rx - TID aggregation information (Rx). + * struct wil_tid_ampdu_rx - TID aggregation information (Rx). * * @reorder_buf: buffer to reorder incoming aggregated MPDUs * @last_rx: jiffies of last rx activity @@ -728,7 +727,7 @@ enum wil_rekey_state { WIL_REKEY_WAIT_M4_SENT = 2, }; -/** +/* * struct wil_sta_info - data for peer * * Peer identified by its CID (connection ID) @@ -741,7 +740,7 @@ struct wil_sta_info { u8 mid; enum wil_sta_status status; struct wil_net_stats stats; - /** + /* * 20 latency bins. 1st bin counts packets with latency * of 0..tx_latency_res, last bin counts packets with latency * of 19*tx_latency_res and above. @@ -882,7 +881,7 @@ struct wil6210_vif { struct work_struct enable_tx_key_worker; }; -/** +/* * RX buffer allocated for enhanced DMA RX descriptors */ struct wil_rx_buff { @@ -891,7 +890,7 @@ struct wil_rx_buff { int id; }; -/** +/* * During Rx completion processing, the driver extracts a buffer ID which * is used as an index to the rx_buff_mgmt.buff_arr array and then the SKB * is given to the network stack and the buffer is moved from the 'active' @@ -1147,7 +1146,7 @@ static inline void wil_c(struct wil6210_priv *wil, u32 reg, u32 val) wil_w(wil, reg, wil_r(wil, reg) & ~val); } -/** +/* * wil_cid_valid - check cid is valid */ static inline bool wil_cid_valid(struct wil6210_priv *wil, int cid) -- 2.47.3