linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Federico Vaga <federico.vaga@cern.ch>
To: Vinod Koul <vkoul@kernel.org>
Cc: Jonathan Corbet <corbet@lwn.net>, <dmaengine@vger.kernel.org>,
	<linux-doc@vger.kernel.org>, <linux-kernel@vger.kernel.org>
Subject: Re: [PATCH] doc:dmaengine: clarify DMA desc. pointer after submission
Date: Mon, 11 Feb 2019 13:10:39 +0100	[thread overview]
Message-ID: <4742302.Qfi8ekQbNf@pcbe13614> (raw)
In-Reply-To: <20190211115411.GR4296@vkoul-mobl>

On Monday, February 11, 2019 12:54:11 PM CET Vinod Koul wrote:
> 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

I'm not a native speaker but consequentially and consequently should be 
synonymous. As fa as I understood. but I do not mind to change it if you think 
is better.

> > +      descriptor.
> > +
> 
> Applied after fixing the typo and added tag as Documentation: dmaengine...

I used doc to make the string shorter

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





  reply	other threads:[~2019-02-11 12:10 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-02-08 15:30 [PATCH] doc:dmaengine: clarify DMA desc. pointer after submission Federico Vaga
2019-02-11 11:54 ` Vinod Koul
2019-02-11 12:10   ` Federico Vaga [this message]
2019-02-11 15:40 ` Jonathan Corbet

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=4742302.Qfi8ekQbNf@pcbe13614 \
    --to=federico.vaga@cern.ch \
    --cc=corbet@lwn.net \
    --cc=dmaengine@vger.kernel.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=vkoul@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;
as well as URLs for NNTP newsgroup(s).