From: Vinod Koul <vkoul@kernel.org>
To: Federico Vaga <federico.vaga@cern.ch>
Cc: Jonathan Corbet <corbet@lwn.net>,
dmaengine@vger.kernel.org, linux-doc@vger.kernel.org,
linux-kernel@vger.kernel.org
Subject: doc:dmaengine: clarify DMA desc. pointer after submission
Date: Mon, 11 Feb 2019 17:24:11 +0530 [thread overview]
Message-ID: <20190211115411.GR4296@vkoul-mobl> (raw)
On 08-02-19, 16:30, Federico Vaga wrote:
> 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>
> ---
> Documentation/driver-api/dmaengine/client.rst | 7 +++++++
> 1 file changed, 7 insertions(+)
>
> diff --git a/Documentation/driver-api/dmaengine/client.rst b/Documentation/driver-api/dmaengine/client.rst
> index fbbb2831f29f..d728e50105eb 100644
> --- 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.
>
> + .. 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
Consequently
> + descriptor.
> +
Applied after fixing the typo and added tag as Documentation: dmaengine...
> 5. Issue pending DMA requests and wait for callback notification
>
> The transactions in the pending queue can be activated by calling the
> --
> 2.15.0
next reply other threads:[~2019-02-11 11:54 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-02-11 11:54 Vinod Koul [this message]
-- strict thread matches above, loose matches on Subject: below --
2019-02-11 15:40 doc:dmaengine: clarify DMA desc. pointer after submission Jonathan Corbet
2019-02-11 12:10 Federico Vaga
2019-02-08 15:30 Federico Vaga
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20190211115411.GR4296@vkoul-mobl \
--to=vkoul@kernel.org \
--cc=corbet@lwn.net \
--cc=dmaengine@vger.kernel.org \
--cc=federico.vaga@cern.ch \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox