]> git.ipfire.org Git - thirdparty/u-boot.git/commitdiff
net: xilinx: Fix kernel-doc for axi_mrmac function parameters
authorVenkatesh Yadav Abbarapu <venkatesh.abbarapu@amd.com>
Thu, 17 Jul 2025 04:48:55 +0000 (10:18 +0530)
committerMichal Simek <michal.simek@amd.com>
Thu, 24 Jul 2025 06:54:16 +0000 (08:54 +0200)
The kernel-doc comment for the axi_mrmac_recv function was missing
the colon (':') after the '@packetp' parameter tag.

The kernel-doc comment for the axi_mrmac_free_pkt function was missing
the colon (':') after the 'length' parameter tag.

This caused a Sparse warnings regarding the 'packetp' and 'length'
parameters not being described. Fix the formatting to align
with kernel-doc standards and resolve the warning.

drivers/net/xilinx_axi_mrmac.c:357:
warning: Function parameter or member 'packetp' not described
in 'axi_mrmac_recv'
drivers/net/xilinx_axi_mrmac.c:411:
warning: Function parameter or member 'length' not described
in 'axi_mrmac_free_pkt'

Signed-off-by: Venkatesh Yadav Abbarapu <venkatesh.abbarapu@amd.com>
Link: https://lore.kernel.org/r/20250717044855.1359443-1-venkatesh.abbarapu@amd.com
Signed-off-by: Michal Simek <michal.simek@amd.com>
drivers/net/xilinx_axi_mrmac.c

index 555651937f863c00c5426c6cd86ac9fedb0d1e00..56f877c20a6f207a35956483ba47b9274d9bb0c6 100644 (file)
@@ -346,7 +346,7 @@ static bool isrxready(struct axi_mrmac_priv *priv)
  * axi_mrmac_recv - MRMAC Rx function
  * @dev:       udevice structure
  * @flags:     flags from network stack
- * @packetp    pointer to received data
+ * @packetp:   pointer to received data
  *
  * Return:     received data length on success, negative value on errors
  *
@@ -399,7 +399,7 @@ static int axi_mrmac_recv(struct udevice *dev, int flags, uchar **packetp)
  * axi_mrmac_free_pkt - MRMAC free packet function
  * @dev:       udevice structure
  * @packet:    receive buffer pointer
- * @length     received data length
+ * @length:    received data length
  *
  * Return:     0 on success, negative value on errors
  *