dmaengine: xilinx: xdma: Clarify kdoc in XDMA driver

Clarify the kernel doc of xdma_fill_descs(), especially how big chunks
will be handled.

Signed-off-by: Miquel Raynal <miquel.raynal@bootlin.com>
Signed-off-by: Louis Chauvet <louis.chauvet@bootlin.com>
Link: https://lore.kernel.org/stable/20240327-digigram-xdma-fixes-v1-3-45f4a52c0283%40bootlin.com
Link: https://lore.kernel.org/r/20240327-digigram-xdma-fixes-v1-3-45f4a52c0283@bootlin.com
Signed-off-by: Vinod Koul <vkoul@kernel.org>
This commit is contained in:
Miquel Raynal 2024-03-27 10:58:50 +01:00 committed by Vinod Koul
parent 6a40fb8245
commit 7a71c6dc21

View file

@ -554,12 +554,14 @@ static void xdma_synchronize(struct dma_chan *chan)
}
/**
* xdma_fill_descs - Fill hardware descriptors with contiguous memory block addresses
* @sw_desc: tx descriptor state container
* @src_addr: Value for a ->src_addr field of a first descriptor
* @dst_addr: Value for a ->dst_addr field of a first descriptor
* @size: Total size of a contiguous memory block
* @filled_descs_num: Number of filled hardware descriptors for corresponding sw_desc
* xdma_fill_descs() - Fill hardware descriptors for one contiguous memory chunk.
* More than one descriptor will be used if the size is bigger
* than XDMA_DESC_BLEN_MAX.
* @sw_desc: Descriptor container
* @src_addr: First value for the ->src_addr field
* @dst_addr: First value for the ->dst_addr field
* @size: Size of the contiguous memory block
* @filled_descs_num: Index of the first descriptor to take care of in @sw_desc
*/
static inline u32 xdma_fill_descs(struct xdma_desc *sw_desc, u64 src_addr,
u64 dst_addr, u32 size, u32 filled_descs_num)