Merge tag 'nfs-for-5.1-1' of git://git.linux-nfs.org/projects/trondmy/linux-nfs

[sfrench/cifs-2.6.git] / Documentation / driver-api / dmaengine / client.rst

diff --git a/Documentation/driver-api/dmaengine/client.rst b/Documentation/driver-api/dmaengine/client.rst
index fbbb2831f29f8c7f50675238289478c98f472606..d728e50105eb3d82c09758ba6584cd65cba07f8a 100644 (file)
--- a/Documentation/driver-api/dmaengine/client.rst
+++ b/Documentation/driver-api/dmaengine/client.rst
@@ -168,6 +168,13 @@ The details of these operations are:
    dmaengine_submit() will not start the DMA operation, it merely adds
    it to the pending queue. For this, see step 5, dma_async_issue_pending.
 
    dmaengine_submit() will not start the DMA operation, it merely adds
    it to the pending queue. For this, see step 5, dma_async_issue_pending.
 

+   .. note::
+
+      After calling ``dmaengine_submit()`` the submitted transfer descriptor
+      (``struct dma_async_tx_descriptor``) belongs to the DMA engine.
+      Consequentially, the client must consider invalid the pointer to that
+      descriptor.
+

 5. Issue pending DMA requests and wait for callback notification
 
    The transactions in the pending queue can be activated by calling the
 5. Issue pending DMA requests and wait for callback notification
 
    The transactions in the pending queue can be activated by calling the