Received-SPF: pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67;
Received-SPF: Pass (protection.outlook.com: domain of cern.ch designates
 188.184.36.48 as permitted sender) receiver=protection.outlook.com;
 client-ip=188.184.36.48; helo=cernmxgwlb4.cern.ch;
From:   Federico Vaga <federico.vaga@cern.ch>
To:     Vinod Koul <vkoul@kernel.org>
Reply-To: <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: Re: [PATCH] doc:dmaengine: clarify DMA desc. pointer after submission
Date:   Mon, 11 Feb 2019 13:10:39 +0100
Message-ID: <4742302.Qfi8ekQbNf@pcbe13614>
In-Reply-To: <20190211115411.GR4296@vkoul-mobl>
References: <20190208153038.23272-1-federico.vaga@cern.ch> <20190211115411.GR4296@vkoul-mobl>
MIME-Version: 1.0
Content-Transfer-Encoding: 7Bit
Content-Type: text/plain; charset="us-ascii"
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 11 Feb 2019 12:10:40.7071
 (UTC)
X-MS-Exchange-CrossTenant-Network-Message-Id: e44b5c01-6110-4079-94d7-08d69019f0e5
X-MS-Exchange-CrossTenant-Id: c80d3499-4a40-4a8c-986e-abce017d6b19
X-MS-Exchange-CrossTenant-OriginalAttributedTenantConnectingIp: TenantId=c80d3499-4a40-4a8c-986e-abce017d6b19;Ip=[188.184.36.48];Helo=[cernmxgwlb4.cern.ch]
X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem
X-MS-Exchange-Transport-CrossTenantHeadersStamped: DB7PR06MB4725
Sender: linux-kernel-owner@vger.kernel.org
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

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