|author||Robert Jarzmik <firstname.lastname@example.org>||2015-05-26 23:06:34 +0200|
|committer||Vinod Koul <email@example.com>||2015-06-17 22:16:15 +0530|
Documentation: dmaengine: document DMA_CTRL_ACK
Add documentation about acking the transfers, and their reusability. Signed-off-by: Robert Jarzmik <firstname.lastname@example.org> Acked-by: Maxime Ripard <email@example.com> Signed-off-by: Vinod Koul <firstname.lastname@example.org>
Diffstat (limited to 'Documentation/dmaengine')
1 files changed, 6 insertions, 5 deletions
diff --git a/Documentation/dmaengine/provider.txt b/Documentation/dmaengine/provider.txt
index 05d2280190f1..ca67b0f04c6e 100644
@@ -345,11 +345,12 @@ where to put them)
that abstracts it away.
- - Undocumented feature
- - No one really has an idea of what it's about, besides being
- related to reusing the DMA transaction descriptors or having
- additional transactions added to it in the async-tx API
- - Useless in the case of the slave API
+ - If set, the transfer can be reused after being completed.
+ - There is a guarantee the transfer won't be freed until it is acked
+ by async_tx_ack().
+ - As a consequence, if a device driver wants to skip the dma_map_sg() and
+ dma_unmap_sg() in between 2 transfers, because the DMA'd data wasn't used,
+ it can resubmit the transfer right after its completion.
General Design Notes