* [PATCH] doc:dmaengine: clarify DMA desc. pointer after submission
@ 2019-02-08 15:30 Federico Vaga
2019-02-11 11:54 ` Vinod Koul
2019-02-11 15:40 ` Jonathan Corbet
0 siblings, 2 replies; 4+ messages in thread
From: Federico Vaga @ 2019-02-08 15:30 UTC (permalink / raw)
To: Vinod Koul, Jonathan Corbet
Cc: dmaengine, linux-doc, linux-kernel, Federico Vaga
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
+ descriptor.
+
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
^ permalink raw reply related [flat|nested] 4+ messages in thread
* Re: [PATCH] doc:dmaengine: clarify DMA desc. pointer after submission
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
2019-02-11 15:40 ` Jonathan Corbet
1 sibling, 1 reply; 4+ messages in thread
From: Vinod Koul @ 2019-02-11 11:54 UTC (permalink / raw)
To: Federico Vaga; +Cc: Jonathan Corbet, dmaengine, linux-doc, linux-kernel
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
--
~Vinod
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [PATCH] doc:dmaengine: clarify DMA desc. pointer after submission
2019-02-11 11:54 ` Vinod Koul
@ 2019-02-11 12:10 ` Federico Vaga
0 siblings, 0 replies; 4+ messages in thread
From: Federico Vaga @ 2019-02-11 12:10 UTC (permalink / raw)
To: Vinod Koul; +Cc: Jonathan Corbet, dmaengine, linux-doc, linux-kernel
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
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [PATCH] doc:dmaengine: clarify DMA desc. pointer after submission
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 15:40 ` Jonathan Corbet
1 sibling, 0 replies; 4+ messages in thread
From: Jonathan Corbet @ 2019-02-11 15:40 UTC (permalink / raw)
To: Federico Vaga; +Cc: Vinod Koul, dmaengine, linux-doc, linux-kernel
On Fri, 8 Feb 2019 16:30:38 +0100
Federico Vaga <federico.vaga@cern.ch> 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
> + descriptor.
> +
> 5. Issue pending DMA requests and wait for callback notification
>
> The transactions in the pending queue can be activated by calling the
Applied to the docs tree, thanks.
jon
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2019-02-11 15:40 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
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
2019-02-11 15:40 ` Jonathan Corbet
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).