tjh.dev / kernel
Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux
1
fork

Configure Feed

Select the types of activity you want to include in your feed.

dmaengine: shdma: correct most kernel-doc issues in shdma-base.h

Fix kernel-doc comments in include/linux/shdma-base.h to avoid
most warnings:

- prefix an enum name with "enum"
- prefix enum values with '@'
- prefix struct member names with '@'

shdma-base.h:28: warning: cannot understand function prototype:
'enum shdma_pm_state '
Warning: shdma-base.h:103 struct member 'desc_completed' not described
in 'shdma_ops'
Warning: shdma-base.h:103 struct member 'halt_channel' not described
in 'shdma_ops'
Warning: shdma-base.h:103 struct member 'channel_busy' not described
in 'shdma_ops'
Warning: shdma-base.h:103 struct member 'slave_addr' not described
in 'shdma_ops'
Warning: shdma-base.h:103 struct member 'desc_setup' not described
in 'shdma_ops'
Warning: shdma-base.h:103 struct member 'set_slave' not described
in 'shdma_ops'
Warning: shdma-base.h:103 struct member 'setup_xfer' not described
in 'shdma_ops'
Warning: shdma-base.h:103 struct member 'start_xfer' not described
in 'shdma_ops'
Warning: shdma-base.h:103 struct member 'embedded_desc' not described
in 'shdma_ops'
Warning: shdma-base.h:103 struct member 'chan_irq' not described
in 'shdma_ops'

This one is not fixed: from 4f46f8ac80416:
Warning: shdma-base.h:103 struct member 'get_partial' not described
in 'shdma_ops'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Link: https://patch.msgid.link/20251104002001.445297-1-rdunlap@infradead.org
Signed-off-by: Vinod Koul <vkoul@kernel.org>

authored by

Randy Dunlap and committed by
Vinod Koul de4761fb f5a4aa64

+14 -14
+14 -14
include/linux/shdma-base.h
··· 19 19 #include <linux/types.h> 20 20 21 21 /** 22 - * shdma_pm_state - DMA channel PM state 23 - * SHDMA_PM_ESTABLISHED: either idle or during data transfer 24 - * SHDMA_PM_BUSY: during the transfer preparation, when we have to 22 + * enum shdma_pm_state - DMA channel PM state 23 + * @SHDMA_PM_ESTABLISHED: either idle or during data transfer 24 + * @SHDMA_PM_BUSY: during the transfer preparation, when we have to 25 25 * drop the lock temporarily 26 - * SHDMA_PM_PENDING: transfers pending 26 + * @SHDMA_PM_PENDING: transfers pending 27 27 */ 28 28 enum shdma_pm_state { 29 29 SHDMA_PM_ESTABLISHED, ··· 74 74 75 75 /** 76 76 * struct shdma_ops - simple DMA driver operations 77 - * desc_completed: return true, if this is the descriptor, that just has 77 + * @desc_completed: return true, if this is the descriptor, that just has 78 78 * completed (atomic) 79 - * halt_channel: stop DMA channel operation (atomic) 80 - * channel_busy: return true, if the channel is busy (atomic) 81 - * slave_addr: return slave DMA address 82 - * desc_setup: set up the hardware specific descriptor portion (atomic) 83 - * set_slave: bind channel to a slave 84 - * setup_xfer: configure channel hardware for operation (atomic) 85 - * start_xfer: start the DMA transfer (atomic) 86 - * embedded_desc: return Nth struct shdma_desc pointer from the 79 + * @halt_channel: stop DMA channel operation (atomic) 80 + * @channel_busy: return true, if the channel is busy (atomic) 81 + * @slave_addr: return slave DMA address 82 + * @desc_setup: set up the hardware specific descriptor portion (atomic) 83 + * @set_slave: bind channel to a slave 84 + * @setup_xfer: configure channel hardware for operation (atomic) 85 + * @start_xfer: start the DMA transfer (atomic) 86 + * @embedded_desc: return Nth struct shdma_desc pointer from the 87 87 * descriptor array 88 - * chan_irq: process channel IRQ, return true if a transfer has 88 + * @chan_irq: process channel IRQ, return true if a transfer has 89 89 * completed (atomic) 90 90 */ 91 91 struct shdma_ops {