dmaengine: fix incorrect kernel-doc comment for struct dma_slave_config
PATCH 1/1 dmaengine: fix incorrect kernel-doc comment for struct dma_slave_config
The 'direction' member of 'struct dma_slave_config' is of data type 'enum dma_transfer_direction', so update the kernel-doc comment for 'struct dma_slave_config' to refer to appropriate values.
Signed-off-by Alexander Popov <[email protected]>
--- include/linux/dmaengine.h | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-)
include/linux/dmaengine.h +2 -3
@@ -305,9 +305,8 @@ enum dma_slave_buswidth {/** * struct dma_slave_config - dma slave channel runtime config * @direction: whether the data shall go in or out on this slave -* channel, right now. DMA_TO_DEVICE and DMA_FROM_DEVICE are -* legal values, DMA_BIDIRECTIONAL is not acceptable since we -* need to differentiate source and target addresses. +* channel, right now. DMA_MEM_TO_DEV and DMA_DEV_TO_MEM are +* legal values. * @src_addr: this is the physical address where DMA slave data * should be read (RX), if the source is memory this argument is * ignored.
Signature · 1 line
1.8.4.2
Vinod Koul
AppliedQuoted 5 lines · Alexander Popov
The 'direction' member of 'struct
dma_slave_config' is of data type 'enumdma_transfer_direction', so update the kernel-doc comment for 'structdma_slave_config' to refer to appropriate values.Signed-off-by Alexander Popov <[email protected]>
Applied, thanks
--
~Vinod
Quoted 23 lines
--- include/linux/dmaengine.h | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-)include/linux/dmaengine.h +2
-3@@ -305,9 +305,8 @@ enum dma_slave_buswidth {/** * struct dma_slave_config - dma slave channel runtime config * @direction: whether the data shall go in or out on this slave -* channel, right now. DMA_TO_DEVICE and DMA_FROM_DEVICE are -* legal values, DMA_BIDIRECTIONAL is not acceptable since we -* need to differentiate source and target addresses. +* channel, right now. DMA_MEM_TO_DEV and DMA_DEV_TO_MEM are +* legal values. * @src_addr: this is the physical address where DMA slave data * should be read (RX), if the source is memory this argument is * ignored. Signature · 1 line
1.8.4.2