Skip to content

Commit

Permalink
doc:dmaengine: clarify DMA desc. pointer after submission
Browse files Browse the repository at this point in the history
It clarifies that the DMA description pointer returned by
`dmaengine_prep_*` function should not be used after submission.

Signed-off-by: Federico Vaga <federico.vaga@cern.ch>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
  • Loading branch information
Federico Vaga authored and Jonathan Corbet committed Feb 11, 2019
1 parent 2c71d30 commit db693ad
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions Documentation/driver-api/dmaengine/client.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

.. 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
Expand Down

0 comments on commit db693ad

Please sign in to comment.