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: axienet: Fix kernel doc warnings

Add description of mdio enable, mdio disable and mdio wait functions.
Add description of skb pointer in axidma_bd data structure.
Remove 'phy_node' description in axienet local data structure since
it is not a valid struct member.
Correct description of struct axienet_option.

Fix below kernel-doc warnings in drivers/net/ethernet/xilinx/:
1) xilinx_axienet_mdio.c:1: warning: no structured comments found
2) xilinx_axienet.h:379: warning: Function parameter or struct member
'skb' not described in 'axidma_bd'
3) xilinx_axienet.h:538: warning: Excess struct member 'phy_node'
description in 'axienet_local'
4) xilinx_axienet.h:1002: warning: expecting prototype for struct
axiethernet_option. Prototype was for struct axienet_option instead

Signed-off-by: Suraj Gupta <suraj.gupta2@amd.com>
Reviewed-by: Radhey Shyam Pandey <radhey.shyam.pandey@amd.com>
Link: https://lore.kernel.org/r/20240328110713.12885-1-suraj.gupta2@amd.com
Signed-off-by: Jakub Kicinski <kuba@kernel.org>

authored by

Suraj Gupta and committed by
Jakub Kicinski 06c2a5cd 1ab6fe64

+22 -5
+2 -2
drivers/net/ethernet/xilinx/xilinx_axienet.h
··· 359 359 * @app2: MM2S/S2MM User Application Field 2. 360 360 * @app3: MM2S/S2MM User Application Field 3. 361 361 * @app4: MM2S/S2MM User Application Field 4. 362 + * @skb: Pointer to SKB transferred using DMA 362 363 */ 363 364 struct axidma_bd { 364 365 u32 next; /* Physical address of next buffer descriptor */ ··· 400 399 * struct axienet_local - axienet private per device data 401 400 * @ndev: Pointer for net_device to which it will be attached. 402 401 * @dev: Pointer to device structure 403 - * @phy_node: Pointer to device node structure 404 402 * @phylink: Pointer to phylink instance 405 403 * @phylink_config: phylink configuration settings 406 404 * @pcs_phy: Reference to PCS/PMA PHY if used ··· 537 537 }; 538 538 539 539 /** 540 - * struct axiethernet_option - Used to set axi ethernet hardware options 540 + * struct axienet_option - Used to set axi ethernet hardware options 541 541 * @opt: Option to be set. 542 542 * @reg: Register offset to be written for setting the option 543 543 * @m_or: Mask to be ORed for setting the option in the register
+20 -3
drivers/net/ethernet/xilinx/xilinx_axienet_mdio.c
··· 20 20 #define DEFAULT_MDIO_FREQ 2500000 /* 2.5 MHz */ 21 21 #define DEFAULT_HOST_CLOCK 150000000 /* 150 MHz */ 22 22 23 - /* Wait till MDIO interface is ready to accept a new transaction.*/ 23 + /** 24 + * axienet_mdio_wait_until_ready - MDIO wait function 25 + * @lp: Pointer to axienet local data structure. 26 + * 27 + * Return : 0 on success, Negative value on errors 28 + * 29 + * Wait till MDIO interface is ready to accept a new transaction. 30 + */ 24 31 static int axienet_mdio_wait_until_ready(struct axienet_local *lp) 25 32 { 26 33 u32 val; ··· 37 30 1, 20000); 38 31 } 39 32 40 - /* Enable the MDIO MDC. Called prior to a read/write operation */ 33 + /** 34 + * axienet_mdio_mdc_enable - MDIO MDC enable function 35 + * @lp: Pointer to axienet local data structure. 36 + * 37 + * Enable the MDIO MDC. Called prior to a read/write operation 38 + */ 41 39 static void axienet_mdio_mdc_enable(struct axienet_local *lp) 42 40 { 43 41 axienet_iow(lp, XAE_MDIO_MC_OFFSET, 44 42 ((u32)lp->mii_clk_div | XAE_MDIO_MC_MDIOEN_MASK)); 45 43 } 46 44 47 - /* Disable the MDIO MDC. Called after a read/write operation*/ 45 + /** 46 + * axienet_mdio_mdc_disable - MDIO MDC disable function 47 + * @lp: Pointer to axienet local data structure. 48 + * 49 + * Disable the MDIO MDC. Called after a read/write operation 50 + */ 48 51 static void axienet_mdio_mdc_disable(struct axienet_local *lp) 49 52 { 50 53 u32 mc_reg;