tjh.dev / kernel
Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux
1
fork

Configure Feed

Select the types of activity you want to include in your feed.

net: xilinx: axienet: Fix kernel-doc warnings for missing return descriptions

Add missing "Return:" sections to kernel-doc comments for four functions:
- axienet_calc_cr()
- axienet_device_reset()
- axienet_free_tx_chain()
- axienet_dim_coalesce_count_rx()

Also standardize the return documentation format by replacing inline
"Returns" text with proper "Return:" tags as per kernel documentation
guidelines.

Fixes below kernel-doc warnings:
- Warning: No description found for return value of 'axienet_calc_cr'
- Warning: No description found for return value of 'axienet_device_reset'
- Warning: No description found for return value of 'axienet_free_tx_chain'
- Warning: No description found for return value of
'axienet_dim_coalesce_count_rx'

Signed-off-by: Suraj Gupta <suraj.gupta2@amd.com>
Link: https://patch.msgid.link/20250919103754.434711-1-suraj.gupta2@amd.com
Signed-off-by: Jakub Kicinski <kuba@kernel.org>

authored by

Suraj Gupta and committed by
Jakub Kicinski 312e6a58 ab528156

+8 -2
+8 -2
drivers/net/ethernet/xilinx/xilinx_axienet_main.c
··· 238 238 * 239 239 * Calculate a control register value based on the coalescing settings. The 240 240 * run/stop bit is not set. 241 + * 242 + * Return: Control register value with coalescing settings configured. 241 243 */ 242 244 static u32 axienet_calc_cr(struct axienet_local *lp, u32 count, u32 usec) 243 245 { ··· 704 702 * are connected to Axi Ethernet reset lines, this in turn resets the Axi 705 703 * Ethernet core. No separate hardware reset is done for the Axi Ethernet 706 704 * core. 707 - * Returns 0 on success or a negative error number otherwise. 705 + * 706 + * Return: 0 on success or a negative error number otherwise. 708 707 */ 709 708 static int axienet_device_reset(struct net_device *ndev) 710 709 { ··· 776 773 * 777 774 * Would either be called after a successful transmit operation, or after 778 775 * there was an error when setting up the chain. 779 - * Returns the number of packets handled. 776 + * 777 + * Return: The number of packets handled. 780 778 */ 781 779 static int axienet_free_tx_chain(struct axienet_local *lp, u32 first_bd, 782 780 int nr_bds, bool force, u32 *sizep, int budget) ··· 2116 2112 /** 2117 2113 * axienet_dim_coalesce_count_rx() - RX coalesce count for DIM 2118 2114 * @lp: Device private data 2115 + * 2116 + * Return: RX coalescing frame count value for DIM. 2119 2117 */ 2120 2118 static u32 axienet_dim_coalesce_count_rx(struct axienet_local *lp) 2121 2119 {