2021-09-13 11:13:04

by Radhey Shyam Pandey

Subject: [PATCH] dmaengine: xilinx_dma: Fix kernel-doc warnings

From: Shravya Kumbham <[email protected]>

Modify the prototype from xilinx_dma_tx_descriptor to
xilinx_dma_alloc_tx_descriptor and xilinx_dma_channel_set_config
to xilinx_vdma_channel_set_config in API description to
fix below linux kernel-doc warnings.

drivers/dma/xilinx/xilinx_dma.c:800: warning: expecting
prototype for xilinx_dma_tx_descriptor(). Prototype was
for xilinx_dma_alloc_tx_descriptor() instead.

drivers/dma/xilinx/xilinx_dma.c:2471: warning: expecting
prototype for xilinx_dma_channel_set_config(). Prototype
was for xilinx_vdma_channel_set_config() instead.

Signed-off-by: Shravya Kumbham <[email protected]>
Signed-off-by: Radhey Shyam Pandey <[email protected]>
---
drivers/dma/xilinx/xilinx_dma.c | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/drivers/dma/xilinx/xilinx_dma.c b/drivers/dma/xilinx/xilinx_dma.c
index 75c0b8e904e5..5efaea74e6e3 100644
--- a/drivers/dma/xilinx/xilinx_dma.c
+++ b/drivers/dma/xilinx/xilinx_dma.c
@@ -790,7 +790,7 @@ static void xilinx_vdma_free_tx_segment(struct xilinx_dma_chan *chan,
}

/**
- * xilinx_dma_tx_descriptor - Allocate transaction descriptor
+ * xilinx_dma_alloc_tx_descriptor - Allocate transaction descriptor
* @chan: Driver specific DMA channel
*
* Return: The allocated descriptor on success and NULL on failure.
@@ -2461,7 +2461,7 @@ static void xilinx_dma_synchronize(struct dma_chan *dchan)
}

/**
- * xilinx_dma_channel_set_config - Configure VDMA channel
+ * xilinx_vdma_channel_set_config - Configure VDMA channel
* Run-time configuration for Axi VDMA, supports:
* . halt the channel
* . configure interrupt coalescing and inter-packet delay threshold
--
2.7.4

2021-10-25 07:57:08

by Vinod Koul

Subject: Re: [PATCH] dmaengine: xilinx_dma: Fix kernel-doc warnings

On 13-09-21, 14:58, Radhey Shyam Pandey wrote:
> From: Shravya Kumbham <[email protected]>
>
> Modify the prototype from xilinx_dma_tx_descriptor to
> xilinx_dma_alloc_tx_descriptor and xilinx_dma_channel_set_config
> to xilinx_vdma_channel_set_config in API description to
> fix below linux kernel-doc warnings.
>
> drivers/dma/xilinx/xilinx_dma.c:800: warning: expecting
> prototype for xilinx_dma_tx_descriptor(). Prototype was
> for xilinx_dma_alloc_tx_descriptor() instead.
>
> drivers/dma/xilinx/xilinx_dma.c:2471: warning: expecting
> prototype for xilinx_dma_channel_set_config(). Prototype
> was for xilinx_vdma_channel_set_config() instead.

Applied, thanks

--
~Vinod