linux-kernel - [PATCH] dmaengine: dw_edma: correct kernel-doc warnings in <linux/dma/edma.h>

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: <20251101191524.1991135-1-rdunlap@infradead.org>
Date: Sat,  1 Nov 2025 12:15:24 -0700
From: Randy Dunlap <rdunlap@...radead.org>
To: linux-kernel@...r.kernel.org
Cc: Randy Dunlap <rdunlap@...radead.org>,
	Manivannan Sadhasivam <mani@...nel.org>,
	Vinod Koul <vkoul@...nel.org>,
	dmaengine@...r.kernel.org
Subject: [PATCH] dmaengine: dw_edma: correct kernel-doc warnings in <linux/dma/edma.h>

Use the correct enum name in its kernel-doc heading.
Add ending ':' to struct member names.
Drop the @id: kernel-doc entry since there is no struct member named 'id'.

edma.h:46: warning: expecting prototype for struct dw_edma_core_ops.
 Prototype was for struct dw_edma_plat_ops instead
Warning: edma.h:101 struct member 'ops' not described in 'dw_edma_chip'
Warning: edma.h:101 struct member 'flags' not described in 'dw_edma_chip'
Warning: edma.h:101 struct member 'reg_base' not described
 in 'dw_edma_chip'
Warning: edma.h:101 struct member 'll_wr_cnt' not described
 in 'dw_edma_chip'
Warning: edma.h:101 struct member 'll_rd_cnt' not described
 in 'dw_edma_chip'
Warning: edma.h:101 struct member 'll_region_wr' not described
 in 'dw_edma_chip'
Warning: edma.h:101 struct member 'll_region_rd' not described
 in 'dw_edma_chip'
Warning: edma.h:101 struct member 'dt_region_wr' not described
 in 'dw_edma_chip'
Warning: edma.h:101 struct member 'dt_region_rd' not described
 in 'dw_edma_chip'
Warning: edma.h:101 struct member 'mf' not described in 'dw_edma_chip'

Signed-off-by: Randy Dunlap <rdunlap@...radead.org>
---
Cc: Manivannan Sadhasivam <mani@...nel.org>
Cc: Vinod Koul <vkoul@...nel.org>
Cc: dmaengine@...r.kernel.org
---
 include/linux/dma/edma.h |   24 +++++++++++-------------
 1 file changed, 11 insertions(+), 13 deletions(-)

--- linux-next-20251031.orig/include/linux/dma/edma.h
+++ linux-next-20251031/include/linux/dma/edma.h
@@ -27,7 +27,7 @@ struct dw_edma_region {
 };
 
 /**
- * struct dw_edma_core_ops - platform-specific eDMA methods
+ * struct dw_edma_plat_ops - platform-specific eDMA methods
  * @irq_vector:		Get IRQ number of the passed eDMA channel. Note the
  *			method accepts the channel id in the end-to-end
  *			numbering with the eDMA write channels being placed
@@ -63,19 +63,17 @@ enum dw_edma_chip_flags {
 /**
  * struct dw_edma_chip - representation of DesignWare eDMA controller hardware
  * @dev:		 struct device of the eDMA controller
- * @id:			 instance ID
  * @nr_irqs:		 total number of DMA IRQs
- * @ops			 DMA channel to IRQ number mapping
- * @flags		 dw_edma_chip_flags
- * @reg_base		 DMA register base address
- * @ll_wr_cnt		 DMA write link list count
- * @ll_rd_cnt		 DMA read link list count
- * @rg_region		 DMA register region
- * @ll_region_wr	 DMA descriptor link list memory for write channel
- * @ll_region_rd	 DMA descriptor link list memory for read channel
- * @dt_region_wr	 DMA data memory for write channel
- * @dt_region_rd	 DMA data memory for read channel
- * @mf			 DMA register map format
+ * @ops:		 DMA channel to IRQ number mapping
+ * @flags:		 dw_edma_chip_flags
+ * @reg_base:		 DMA register base address
+ * @ll_wr_cnt:		 DMA write link list count
+ * @ll_rd_cnt:		 DMA read link list count
+ * @ll_region_wr:	 DMA descriptor link list memory for write channel
+ * @ll_region_rd:	 DMA descriptor link list memory for read channel
+ * @dt_region_wr:	 DMA data memory for write channel
+ * @dt_region_rd:	 DMA data memory for read channel
+ * @mf:			 DMA register map format
  * @dw:			 struct dw_edma that is filled by dw_edma_probe()
  */
 struct dw_edma_chip {