[v2] dmaengine: imx-sdma: Add missing struct documentation

Commit Message

Shengjiu Wang July 6, 2022, 5:45 a.m. UTC

Fix compile warning that 'Function parameter or member not described'
with 'W=1' option:

Add missing description for struct sdma_desc

There is not any description for struct sdma_script_start_addrs,
so use /* instead of /**

Signed-off-by: Shengjiu Wang <[e-mail]>
---
changes in v2
- refine the patch title

 drivers/dma/imx-sdma.c | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

Comments

Vinod Koul July 6, 2022, 4:28 p.m. UTC | #1

On 06-07-22, 13:45, Shengjiu Wang wrote:
> Fix compile warning that 'Function parameter or member not described'
> with 'W=1' option:
> 
> Add missing description for struct sdma_desc
> 
> There is not any description for struct sdma_script_start_addrs,
> so use /* instead of /**

Applied, thanks

Patch

diff --git a/drivers/dma/imx-sdma.c b/drivers/dma/imx-sdma.c
index 8535018ee7a2..39d70ef1caf0 100644
--- a/drivers/dma/imx-sdma.c
+++ b/drivers/dma/imx-sdma.c
@@ -188,7 +188,7 @@ 
 #define SDMA_DONE0_CONFIG_DONE_SEL	BIT(7)
 #define SDMA_DONE0_CONFIG_DONE_DIS	BIT(6)
 
-/**
+/*
  * struct sdma_script_start_addrs - SDMA script start pointers
  *
  * start addresses of the different functions in the physical
@@ -424,6 +424,11 @@  struct sdma_desc {
  * @data:		specific sdma interface structure
  * @bd_pool:		dma_pool for bd
  * @terminate_worker:	used to call back into terminate work function
+ * @terminated:		terminated list
+ * @is_ram_script:	flag for script in ram
+ * @n_fifos_src:	number of source device fifos
+ * @n_fifos_dst:	number of destination device fifos
+ * @sw_done:		software done flag
  */
 struct sdma_channel {
 	struct virt_dma_chan		vc;