[PATCH v2 1/6] dmaengine: Update documentation for inline wrappers

[PATCH v2 1/6] dmaengine: Update documentation for inline wrappers

[Geert Uytterhoeven]

During the last few years, several inline wrappers for DMA operations have
been introduced:
  - commit 16052827d98fbc13c31ebad560af4bd53e2b4dd5 ("dmaengine/dma_slave:
    introduce inline wrappers"),
  - commit a14acb4ac2a1486f6633c55eb7f7ded07f3ec9fc ("DMAEngine: add
    dmaengine_prep_interleaved_dma wrapper for interleaved api"),
  - commit 6e3ecaf0ad49de0bed829d409a164e7107c02993 ("dmaengine: add
    wrapper functions for device control functions").

Update the documentation to use the wrappers.

Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>
---
v2:
  - Added one more conversion in the textual explanation.
---
 Documentation/dmaengine.txt | 15 +++++++--------
 1 file changed, 7 insertions(+), 8 deletions(-)

diff --git a/Documentation/dmaengine.txt b/Documentation/dmaengine.txt
index 87d3f192e160..11fb87ff6cd0 100644
--- a/Documentation/dmaengine.txt
+++ b/Documentation/dmaengine.txt
@@ -84,21 +84,21 @@ The slave DMA usage consists of following steps:
    the given transaction.
 
    Interface:
-	struct dma_async_tx_descriptor *(*chan->device->device_prep_slave_sg)(
+	struct dma_async_tx_descriptor *dmaengine_prep_slave_sg(
 		struct dma_chan *chan, struct scatterlist *sgl,
 		unsigned int sg_len, enum dma_data_direction direction,
 		unsigned long flags);
 
-	struct dma_async_tx_descriptor *(*chan->device->device_prep_dma_cyclic)(
+	struct dma_async_tx_descriptor *dmaengine_prep_dma_cyclic(
 		struct dma_chan *chan, dma_addr_t buf_addr, size_t buf_len,
 		size_t period_len, enum dma_data_direction direction);
 
-	struct dma_async_tx_descriptor *(*device_prep_interleaved_dma)(
+	struct dma_async_tx_descriptor *dmaengine_prep_interleaved_dma(
 		struct dma_chan *chan, struct dma_interleaved_template *xt,
 		unsigned long flags);
 
    The peripheral driver is expected to have mapped the scatterlist for
-   the DMA operation prior to calling device_prep_slave_sg, and must
+   the DMA operation prior to calling dmaengine_prep_slave_sg(), and must
    keep the scatterlist mapped until the DMA operation has completed.
    The scatterlist must be mapped using the DMA struct device.
    If a mapping needs to be synchronized later, dma_sync_*_for_*() must be
@@ -109,8 +109,7 @@ The slave DMA usage consists of following steps:
 	if (nr_sg == 0)
 		/* error */
 
-	desc = chan->device->device_prep_slave_sg(chan, sgl, nr_sg,
-			direction, flags);
+	desc = dmaengine_prep_slave_sg(chan, sgl, nr_sg, direction, flags);
 
    Once a descriptor has been obtained, the callback information can be
    added and the descriptor must then be submitted.  Some DMA engine
@@ -190,11 +189,11 @@ Further APIs:
    description of this API.
 
    This can be used in conjunction with dma_async_is_complete() and
-   the cookie returned from 'descriptor->submit()' to check for
+   the cookie returned from dmaengine_submit() to check for
    completion of a specific DMA transaction.
 
    Note:
 	Not all DMA engine drivers can return reliable information for
 	a running DMA channel.  It is recommended that DMA engine users
-	pause or stop (via dmaengine_terminate_all) the channel before
+	pause or stop (via dmaengine_terminate_all()) the channel before
 	using this API.
-- 
1.9.1

[PATCH v2 trivial 2/6] crypto: ux500: Update error message for dmaengine_prep_slave_sg() API

[Geert Uytterhoeven]

Commit 7e933d3b1e25b250b58b827ef455a1b489c84157 ("crypto: ux500: use
dmaengine_prep_slave_sg API") changed the code to use the new API, but
forgot to update an error message.

Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>
Cc: Herbert Xu <herbert@gondor.apana.org.au>
Cc: Jiri Kosina <trivial@kernel.org>
Cc: linux-crypto@vger.kernel.org
--
v2:
  - New
---
 drivers/crypto/ux500/hash/hash_core.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/crypto/ux500/hash/hash_core.c b/drivers/crypto/ux500/hash/hash_core.c
index 1c73f4fbc252..ffa05b8f3bd8 100644
--- a/drivers/crypto/ux500/hash/hash_core.c
+++ b/drivers/crypto/ux500/hash/hash_core.c
@@ -184,7 +184,7 @@ static int hash_set_dma_transfer(struct hash_ctx *ctx, struct scatterlist *sg,
 			direction, DMA_CTRL_ACK | DMA_PREP_INTERRUPT);
 	if (!desc) {
 		dev_err(ctx->device->dev,
-			"%s: device_prep_slave_sg() failed!\n", __func__);
+			"%s: dmaengine_prep_slave_sg() failed!\n", __func__);
 		return -EFAULT;
 	}
 
-- 
1.9.1

[PATCH v2 trivial 3/6] spi: topcliff-pch: Update error messages for dmaengine_prep_slave_sg() API

[Geert Uytterhoeven]

Commit 16052827d98fbc13c31ebad560af4bd53e2b4dd5 ("dmaengine/dma_slave:
introduce inline wrappers") changed the code to use the new API, but forgot
to update the error messages.

Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>
Cc: Mark Brown <broonie@kernel.org>
Cc: Jiri Kosina <trivial@kernel.org>
Cc: linux-spi@vger.kernel.org
--
v2:
  - New
---
 drivers/spi/spi-topcliff-pch.c | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/drivers/spi/spi-topcliff-pch.c b/drivers/spi/spi-topcliff-pch.c
index f05abf89c067..af51d6a71cc8 100644
--- a/drivers/spi/spi-topcliff-pch.c
+++ b/drivers/spi/spi-topcliff-pch.c
@@ -1047,8 +1047,8 @@ static void pch_spi_handle_dma(struct pch_spi_data *data, int *bpw)
 					num, DMA_DEV_TO_MEM,
 					DMA_PREP_INTERRUPT | DMA_CTRL_ACK);
 	if (!desc_rx) {
-		dev_err(&data->master->dev, "%s:device_prep_slave_sg Failed\n",
-			__func__);
+		dev_err(&data->master->dev,
+			"%s:dmaengine_prep_slave_sg Failed\n", __func__);
 		return;
 	}
 	dma_sync_sg_for_device(&data->master->dev, sg, num, DMA_FROM_DEVICE);
@@ -1106,8 +1106,8 @@ static void pch_spi_handle_dma(struct pch_spi_data *data, int *bpw)
 					sg, num, DMA_MEM_TO_DEV,
 					DMA_PREP_INTERRUPT | DMA_CTRL_ACK);
 	if (!desc_tx) {
-		dev_err(&data->master->dev, "%s:device_prep_slave_sg Failed\n",
-			__func__);
+		dev_err(&data->master->dev,
+			"%s:dmaengine_prep_slave_sg Failed\n", __func__);
 		return;
 	}
 	dma_sync_sg_for_device(&data->master->dev, sg, num, DMA_TO_DEVICE);
-- 
1.9.1

Re: [PATCH v2 trivial 3/6] spi: topcliff-pch: Update error messages for dmaengine_prep_slave_sg() API

[Mark Brown]

[-- Attachment #1: Type: text/plain, Size: 382 bytes --]

On Fri, Jul 11, 2014 at 06:13:25PM +0200, Geert Uytterhoeven wrote:
> Commit 16052827d98fbc13c31ebad560af4bd53e2b4dd5 ("dmaengine/dma_slave:
> introduce inline wrappers") changed the code to use the new API, but forgot
> to update the error messages.

I seem to be missing a lot of patches in this series and the cover
letter, what's going on with regard to dependencies and so on?

[-- Attachment #2: Digital signature --]
[-- Type: application/pgp-signature, Size: 819 bytes --]

Re: [PATCH v2 trivial 3/6] spi: topcliff-pch: Update error messages for dmaengine_prep_slave_sg() API

[Mark Brown]

[-- Attachment #1: Type: text/plain, Size: 269 bytes --]

On Fri, Jul 11, 2014 at 06:13:25PM +0200, Geert Uytterhoeven wrote:
> Commit 16052827d98fbc13c31ebad560af4bd53e2b4dd5 ("dmaengine/dma_slave:
> introduce inline wrappers") changed the code to use the new API, but forgot
> to update the error messages.

Applied, thanks.

[-- Attachment #2: Digital signature --]
[-- Type: application/pgp-signature, Size: 819 bytes --]

[PATCH v2 trivial 4/6] serial: pch_uart: Update error message for dmaengine_prep_slave_sg() API

[Geert Uytterhoeven]

Commit 16052827d98fbc13c31ebad560af4bd53e2b4dd5 ("dmaengine/dma_slave:
introduce inline wrappers") changed the code to use the new API, but forgot
to update an error message.

Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: Jiri Kosina <trivial@kernel.org>
Cc: linux-serial@vger.kernel.org
--
v2:
  - New
---
 drivers/tty/serial/pch_uart.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/tty/serial/pch_uart.c b/drivers/tty/serial/pch_uart.c
index 0cb6a8e52bd0..2f06e5a71396 100644
--- a/drivers/tty/serial/pch_uart.c
+++ b/drivers/tty/serial/pch_uart.c
@@ -1047,7 +1047,7 @@ static unsigned int dma_handle_tx(struct eg20t_port *priv)
 					priv->sg_tx_p, nent, DMA_MEM_TO_DEV,
 					DMA_PREP_INTERRUPT | DMA_CTRL_ACK);
 	if (!desc) {
-		dev_err(priv->port.dev, "%s:device_prep_slave_sg Failed\n",
+		dev_err(priv->port.dev, "%s:dmaengine_prep_slave_sg Failed\n",
 			__func__);
 		return 0;
 	}
-- 
1.9.1

[PATCH v2 trivial 5/6] video: mx3fb: Update comment for dmaengine_prep_slave_sg() API

[Geert Uytterhoeven]

Commit 16052827d98fbc13c31ebad560af4bd53e2b4dd5 ("dmaengine/dma_slave:
introduce inline wrappers") changed the code to use the new API, but forgot
to update a comment.

Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>
Cc: Jean-Christophe Plagniol-Villard <plagnioj@jcrosoft.com>
Cc: Tomi Valkeinen <tomi.valkeinen@ti.com>
Cc: Jiri Kosina <trivial@kernel.org>
Cc: linux-fbdev@vger.kernel.org
--
v2:
  - New
---
 drivers/video/fbdev/mx3fb.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/video/fbdev/mx3fb.c b/drivers/video/fbdev/mx3fb.c
index c645a0a0c341..5e97baf92721 100644
--- a/drivers/video/fbdev/mx3fb.c
+++ b/drivers/video/fbdev/mx3fb.c
@@ -1179,7 +1179,7 @@ static int mx3fb_pan_display(struct fb_var_screeninfo *var,
 
 	/*
 	 * We enable the End of Frame interrupt, which will free a tx-descriptor,
-	 * which we will need for the next device_prep_slave_sg(). The
+	 * which we will need for the next dmaengine_prep_slave_sg(). The
 	 * IRQ-handler will disable the IRQ again.
 	 */
 	init_completion(&mx3_fbi->flip_cmpl);
-- 
1.9.1

Re: [PATCH v2 trivial 5/6] video: mx3fb: Update comment for dmaengine_prep_slave_sg() API

[Tomi Valkeinen]

[-- Attachment #1: Type: text/plain, Size: 1251 bytes --]

On 11/07/14 19:13, Geert Uytterhoeven wrote:
> Commit 16052827d98fbc13c31ebad560af4bd53e2b4dd5 ("dmaengine/dma_slave:
> introduce inline wrappers") changed the code to use the new API, but forgot
> to update a comment.
> 
> Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>
> Cc: Jean-Christophe Plagniol-Villard <plagnioj@jcrosoft.com>
> Cc: Tomi Valkeinen <tomi.valkeinen@ti.com>
> Cc: Jiri Kosina <trivial@kernel.org>
> Cc: linux-fbdev@vger.kernel.org
> --
> v2:
>   - New
> ---
>  drivers/video/fbdev/mx3fb.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/drivers/video/fbdev/mx3fb.c b/drivers/video/fbdev/mx3fb.c
> index c645a0a0c341..5e97baf92721 100644
> --- a/drivers/video/fbdev/mx3fb.c
> +++ b/drivers/video/fbdev/mx3fb.c
> @@ -1179,7 +1179,7 @@ static int mx3fb_pan_display(struct fb_var_screeninfo *var,
>  
>  	/*
>  	 * We enable the End of Frame interrupt, which will free a tx-descriptor,
> -	 * which we will need for the next device_prep_slave_sg(). The
> +	 * which we will need for the next dmaengine_prep_slave_sg(). The
>  	 * IRQ-handler will disable the IRQ again.
>  	 */
>  	init_completion(&mx3_fbi->flip_cmpl);
> 

Thanks, queued for 3.18.

 Tomi



[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 819 bytes --]

[PATCH v2 6/6] spi: atmel: Use dmaengine_prep_slave_sg() API

[Geert Uytterhoeven]

Use the inline wrapper introduced by commit
16052827d98fbc13c31ebad560af4bd53e2b4dd5 ("dmaengine/dma_slave: introduce
inline wrappers").

Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>
Cc: Mark Brown <broonie@kernel.org>
Cc: linux-spi@vger.kernel.org
--
v2:
  - New
---
 drivers/spi/spi-atmel.c | 18 ++++++------------
 1 file changed, 6 insertions(+), 12 deletions(-)

diff --git a/drivers/spi/spi-atmel.c b/drivers/spi/spi-atmel.c
index 92a6f0d93233..1fb90dda299b 100644
--- a/drivers/spi/spi-atmel.c
+++ b/drivers/spi/spi-atmel.c
@@ -597,21 +597,15 @@ static int atmel_spi_next_xfer_dma_submit(struct spi_master *master,
 		goto err_exit;
 
 	/* Send both scatterlists */
-	rxdesc = rxchan->device->device_prep_slave_sg(rxchan,
-					&as->dma.sgrx,
-					1,
-					DMA_FROM_DEVICE,
-					DMA_PREP_INTERRUPT | DMA_CTRL_ACK,
-					NULL);
+	rxdesc = dmaengine_prep_slave_sg(rxchan, &as->dma.sgrx, 1,
+					 DMA_FROM_DEVICE,
+					 DMA_PREP_INTERRUPT | DMA_CTRL_ACK);
 	if (!rxdesc)
 		goto err_dma;
 
-	txdesc = txchan->device->device_prep_slave_sg(txchan,
-					&as->dma.sgtx,
-					1,
-					DMA_TO_DEVICE,
-					DMA_PREP_INTERRUPT | DMA_CTRL_ACK,
-					NULL);
+	txdesc = dmaengine_prep_slave_sg(txchan, &as->dma.sgtx, 1,
+					 DMA_TO_DEVICE,
+					 DMA_PREP_INTERRUPT | DMA_CTRL_ACK);
 	if (!txdesc)
 		goto err_dma;
 
-- 
1.9.1

Re: [PATCH v2 6/6] spi: atmel: Use dmaengine_prep_slave_sg() API

[Mark Brown]

[-- Attachment #1: Type: text/plain, Size: 413 bytes --]

On Fri, Jul 11, 2014 at 06:13:28PM +0200, Geert Uytterhoeven wrote:
> Use the inline wrapper introduced by commit
> 16052827d98fbc13c31ebad560af4bd53e2b4dd5 ("dmaengine/dma_slave: introduce
> inline wrappers").

Applied, thanks.  Please make sure everyone gets the cover letter on
patch serieses (or just send the patches individually if there's no
dependency) - it makes it easier to figure out what's going on.

[-- Attachment #2: Digital signature --]
[-- Type: application/pgp-signature, Size: 819 bytes --]

Re: [PATCH v2 1/6] dmaengine: Update documentation for inline wrappers

[Vinod Koul]

On Fri, Jul 11, 2014 at 06:13:23PM +0200, Geert Uytterhoeven wrote:
> During the last few years, several inline wrappers for DMA operations have
> been introduced:
>   - commit 16052827d98fbc13c31ebad560af4bd53e2b4dd5 ("dmaengine/dma_slave:
>     introduce inline wrappers"),
>   - commit a14acb4ac2a1486f6633c55eb7f7ded07f3ec9fc ("DMAEngine: add
>     dmaengine_prep_interleaved_dma wrapper for interleaved api"),
>   - commit 6e3ecaf0ad49de0bed829d409a164e7107c02993 ("dmaengine: add
>     wrapper functions for device control functions").
> 
> Update the documentation to use the wrappers.
> 
> Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>
> ---
> v2:
>   - Added one more conversion in the textual explanation.

I have already applied v1, can you please send the update on added ones

Thanks
-- 
~Vinod

> ---
>  Documentation/dmaengine.txt | 15 +++++++--------
>  1 file changed, 7 insertions(+), 8 deletions(-)
> 
> diff --git a/Documentation/dmaengine.txt b/Documentation/dmaengine.txt
> index 87d3f192e160..11fb87ff6cd0 100644
> --- a/Documentation/dmaengine.txt
> +++ b/Documentation/dmaengine.txt
> @@ -84,21 +84,21 @@ The slave DMA usage consists of following steps:
>     the given transaction.
>  
>     Interface:
> -	struct dma_async_tx_descriptor *(*chan->device->device_prep_slave_sg)(
> +	struct dma_async_tx_descriptor *dmaengine_prep_slave_sg(
>  		struct dma_chan *chan, struct scatterlist *sgl,
>  		unsigned int sg_len, enum dma_data_direction direction,
>  		unsigned long flags);
>  
> -	struct dma_async_tx_descriptor *(*chan->device->device_prep_dma_cyclic)(
> +	struct dma_async_tx_descriptor *dmaengine_prep_dma_cyclic(
>  		struct dma_chan *chan, dma_addr_t buf_addr, size_t buf_len,
>  		size_t period_len, enum dma_data_direction direction);
>  
> -	struct dma_async_tx_descriptor *(*device_prep_interleaved_dma)(
> +	struct dma_async_tx_descriptor *dmaengine_prep_interleaved_dma(
>  		struct dma_chan *chan, struct dma_interleaved_template *xt,
>  		unsigned long flags);
>  
>     The peripheral driver is expected to have mapped the scatterlist for
> -   the DMA operation prior to calling device_prep_slave_sg, and must
> +   the DMA operation prior to calling dmaengine_prep_slave_sg(), and must
>     keep the scatterlist mapped until the DMA operation has completed.
>     The scatterlist must be mapped using the DMA struct device.
>     If a mapping needs to be synchronized later, dma_sync_*_for_*() must be
> @@ -109,8 +109,7 @@ The slave DMA usage consists of following steps:
>  	if (nr_sg == 0)
>  		/* error */
>  
> -	desc = chan->device->device_prep_slave_sg(chan, sgl, nr_sg,
> -			direction, flags);
> +	desc = dmaengine_prep_slave_sg(chan, sgl, nr_sg, direction, flags);
>  
>     Once a descriptor has been obtained, the callback information can be
>     added and the descriptor must then be submitted.  Some DMA engine
> @@ -190,11 +189,11 @@ Further APIs:
>     description of this API.
>  
>     This can be used in conjunction with dma_async_is_complete() and
> -   the cookie returned from 'descriptor->submit()' to check for
> +   the cookie returned from dmaengine_submit() to check for
>     completion of a specific DMA transaction.
>  
>     Note:
>  	Not all DMA engine drivers can return reliable information for
>  	a running DMA channel.  It is recommended that DMA engine users
> -	pause or stop (via dmaengine_terminate_all) the channel before
> +	pause or stop (via dmaengine_terminate_all()) the channel before
>  	using this API.
> -- 
> 1.9.1
> 

--