2024-05-05 19:32:52

by Jeff Johnson

[permalink] [raw]
Subject: [PATCH] dmaengine: xilinx: xdma: fix struct xdma_chan kernel-doc

make C=1 reports:

warning: Function parameter or struct member 'last_interrupt' not described in 'xdma_chan'
warning: Function parameter or struct member 'stop_requested' not described in 'xdma_chan'

So add missing documentation for these members.

Signed-off-by: Jeff Johnson <[email protected]>
---
drivers/dma/xilinx/xdma.c | 2 ++
1 file changed, 2 insertions(+)

diff --git a/drivers/dma/xilinx/xdma.c b/drivers/dma/xilinx/xdma.c
index 313b217388fe..43488678ef9e 100644
--- a/drivers/dma/xilinx/xdma.c
+++ b/drivers/dma/xilinx/xdma.c
@@ -61,6 +61,8 @@ struct xdma_desc_block {
* @dir: Transferring direction of the channel
* @cfg: Transferring config of the channel
* @irq: IRQ assigned to the channel
+ * @last_interrupt: Completion variable to signal the last interrupt
+ * @stop_requested: Stop Requested flag of the channel
*/
struct xdma_chan {
struct virt_dma_chan vchan;

---
base-commit: 2c4d8e19cf060744a9db466ffbaea13ab37f25ca
change-id: 20240505-xdma_chan-kdoc-bf82a3827d2a