linux-kernel - [PATCH] dmaengine: xilinx: xdma: fix struct xdma

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [day] [month] [year] [list]

Message-ID: <20240505-xdma_chan-kdoc-v1-1-18cefca3f168@quicinc.com>
Date: Sun, 5 May 2024 12:32:12 -0700
From: Jeff Johnson <quic_jjohnson@...cinc.com>
To: Lizhi Hou <lizhi.hou@....com>, Brian Xu <brian.xu@....com>,
        "Raj Kumar
 Rampelli" <raj.kumar.rampelli@....com>,
        Vinod Koul <vkoul@...nel.org>, "Michal Simek" <michal.simek@....com>
CC: <dmaengine@...r.kernel.org>, <linux-arm-kernel@...ts.infradead.org>,
        <linux-kernel@...r.kernel.org>,
        Jeff Johnson <quic_jjohnson@...cinc.com>
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 <quic_jjohnson@...cinc.com>
---
 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