mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Vinod Koul <vinod.koul@intel.com>
To: Jassi Brar <jaswinder.singh@linaro.org>
Cc: dan.j.williams@intel.com, linux-kernel@vger.kernel.org,
	rmk@arm.linux.org.uk, 21cnbao@gmail.com
Subject: Re: [PATCHv3] DMAEngine: Define interleaved transfer request api
Date: Tue, 20 Sep 2011 22:22:09 +0530	[thread overview]
Message-ID: <1316537529.31295.14.camel@vkoul-udesk3> (raw)
In-Reply-To: <1316520730-3655-1-git-send-email-jaswinder.singh@linaro.org>

On Tue, 2011-09-20 at 17:42 +0530, Jassi Brar wrote:
> Define a new api that could be used for doing fancy data transfers
> like interleaved to contiguous copy and vice-versa.
> Traditional SG_list based transfers tend to be very inefficient in
> such cases as where the interleave and chunk are only a few bytes,
> which call for a very condensed api to convey pattern of the transfer.
> This api supports all 4 variants of scatter-gather and contiguous transfer.
> 
> Of course, neither can this api help transfers that don't lend to DMA by
> nature, i.e, scattered tiny read/writes with no periodic pattern.
> 
> Also since now we support SLAVE channels that might not provide
> device_prep_slave_sg callback but device_prep_interleaved_dma,
> remove the BUG_ON check.
> 
> Signed-off-by: Jassi Brar <jaswinder.singh@linaro.org>
> ---
> 
> Changes since v2:
> 1) Added some notes to documentation.
> 2) Removed the BUG_ON check that expects every SLAVE channel to
>    provide a prep_slave_sg, as we are now valid otherwise too.
> 3) Fixed the DMA_TX_TYPE_END offset - made it last element of enum.
> 4) Renamed prep_dma_genxfer to prep_interleaved_dma as Vinod wanted.
> 
> Changes since v1:
> 1) Dropped the 'dma_transaction_type' member until we really
>    merge another type into this api. Instead added special
>    type for this api - DMA_GENXFER in dma_transaction_type.
> 2) Renamed 'xfer_template' to 'dmaxfer_template' inorder to
>    preserve namespace, closer to as suggested by Barry Song.
> 
>  Documentation/dmaengine.txt |    8 ++++
>  drivers/dma/dmaengine.c     |    4 +-
>  include/linux/dmaengine.h   |   77 +++++++++++++++++++++++++++++++++++++++++-
>  3 files changed, 85 insertions(+), 4 deletions(-)
> 
> diff --git a/Documentation/dmaengine.txt b/Documentation/dmaengine.txt
> index 94b7e0f..962a2d3 100644
> --- a/Documentation/dmaengine.txt
> +++ b/Documentation/dmaengine.txt
> @@ -75,6 +75,10 @@ The slave DMA usage consists of following steps:
>     slave_sg	- DMA a list of scatter gather buffers from/to a peripheral
>     dma_cyclic	- Perform a cyclic DMA operation from/to a peripheral till the
>  		  operation is explicitly stopped.
> +   interleaved_dma - This is common to Slave as well as M2M clients. For slave
> +		 address of devices' fifo could be already known to the driver.
> +		 Various types of operations could be expressed by setting
> +		 appropriate values to the 'dmaxfer_template' members.
>  
>     A non-NULL return of this transfer API represents a "descriptor" for
>     the given transaction.
> @@ -89,6 +93,10 @@ The slave DMA usage consists of following steps:
>  		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_chan *chan, struct dmaxfer_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
>     keep the scatterlist mapped until the DMA operation has completed.
> diff --git a/drivers/dma/dmaengine.c b/drivers/dma/dmaengine.c
> index b48967b..a6c6051 100644
> --- a/drivers/dma/dmaengine.c
> +++ b/drivers/dma/dmaengine.c
> @@ -693,12 +693,12 @@ int dma_async_device_register(struct dma_device *device)
>  		!device->device_prep_dma_interrupt);
>  	BUG_ON(dma_has_cap(DMA_SG, device->cap_mask) &&
>  		!device->device_prep_dma_sg);
> -	BUG_ON(dma_has_cap(DMA_SLAVE, device->cap_mask) &&
> -		!device->device_prep_slave_sg);
>  	BUG_ON(dma_has_cap(DMA_CYCLIC, device->cap_mask) &&
>  		!device->device_prep_dma_cyclic);
>  	BUG_ON(dma_has_cap(DMA_SLAVE, device->cap_mask) &&
>  		!device->device_control);
> +	BUG_ON(dma_has_cap(DMA_INTERLEAVE, device->cap_mask) &&
> +		!device->device_prep_interleaved_dma);
>  
>  	BUG_ON(!device->device_alloc_chan_resources);
>  	BUG_ON(!device->device_free_chan_resources);
> diff --git a/include/linux/dmaengine.h b/include/linux/dmaengine.h
> index 8fbf40e..fcc85d7 100644
> --- a/include/linux/dmaengine.h
> +++ b/include/linux/dmaengine.h
> @@ -71,11 +71,78 @@ enum dma_transaction_type {
>  	DMA_ASYNC_TX,
>  	DMA_SLAVE,
>  	DMA_CYCLIC,
> +	DMA_INTERLEAVE,
> +/* last transaction type for creation of the capabilities mask */
> +	DMA_TX_TYPE_END,
>  };
>  
> -/* last transaction type for creation of the capabilities mask */
> -#define DMA_TX_TYPE_END (DMA_CYCLIC + 1)
> +/**
> + * Interleaved Transfer Request
> + * ----------------------------
> + * A chunk is collection of contiguous bytes to be transfered.
> + * The gap(in bytes) between two chunks is called inter-chunk-gap(ICG).
> + * ICGs may or maynot change between chunks.
> + * A FRAME is the smallest series of contiguous {chunk,icg} pairs,
> + *  that when repeated an integral number of times, specifies the transfer.
> + * A transfer template is specification of a Frame, the number of times
> + *  it is to be repeated and other per-transfer attributes.
> + *
> + * Practically, a client driver would have ready a template for each
> + *  type of transfer it is going to need during its lifetime and
> + *  set only 'src_start' and 'dst_start' before submitting the requests.
> + *
> + *
> + *  |      Frame-1        |       Frame-2       | ~ |       Frame-'numf'  |
> + *  |====....==.===...=...|====....==.===...=...| ~ |====....==.===...=...|
> + *
> + *    ==  Chunk size
> + *    ... ICG
> + */
>  
> +/**
> + * struct data_chunk - Element of scatter-gather list that makes a frame.
> + * @size: Number of bytes to read from source.
> + *	  size_dst := fn(op, size_src), so doesn't mean much for destination.
> + * @icg: Number of bytes to jump after last src/dst address of this
> + *	 chunk and before first src/dst address for next chunk.
> + *	 Ignored for dst(assumed 0), if dst_inc is true and dst_sgl is false.
> + *	 Ignored for src(assumed 0), if src_inc is true and src_sgl is false.
> + */
> +struct data_chunk {
> +	size_t size;
> +	size_t icg;
> +};
> +
> +/**
> + * struct dmaxfer_template - Template to convey DMAC the transfer pattern
> + *	 and attributes.
> + * @src_start: Bus address of source for the first chunk.
> + * @dst_start: Bus address of destination for the first chunk.
> + * @src_inc: If the source address increments after reading from it.
> + * @dst_inc: If the destination address increments after writing to it.
> + * @src_sgl: If the 'icg' of sgl[] applies to Source (scattered read).
> + *		Otherwise, source is read contiguously (icg ignored).
> + *		Ignored if src_inc is false.
> + * @dst_sgl: If the 'icg' of sgl[] applies to Destination (scattered write).
> + *		Otherwise, destination is filled contiguously (icg ignored).
> + *		Ignored if dst_inc is false.
> + * @frm_irq: If the client expects DMAC driver to do callback after each frame.
> + * @numf: Number of frames in this template.
> + * @frame_size: Number of chunks in a frame i.e, size of sgl[].
> + * @sgl: Array of {chunk,icg} pairs that make up a frame.
> + */
> +struct dmaxfer_template {
> +	dma_addr_t src_start;
> +	dma_addr_t dst_start;
> +	bool src_inc;
> +	bool dst_inc;
> +	bool src_sgl;
> +	bool dst_sgl;
> +	bool frm_irq;
> +	size_t numf;
> +	size_t frame_size;
> +	struct data_chunk sgl[0];
> +};
>  
>  /**
>   * enum dma_ctrl_flags - DMA flags to augment operation preparation,
> @@ -309,6 +376,8 @@ typedef void (*dma_async_tx_callback)(void *dma_async_param);
>   * @chan: target channel for this operation
>   * @tx_submit: set the prepared descriptor(s) to be executed by the engine
>   * @callback: routine to call after this operation is complete
> + *	And after each frame if the 'frm_irq' flag is set during
> + *	device_prep_interleaved_dma.
Nope, if callback is set it should be called, additionally you may use
the flag DMA_PREP_INTERRUPT (which few dmacs use).
I think frm_irq is not required, if you need please use
DMA_PREP_INTERRUPT passed thru flags arg

Also for slave transfers, how do we infer direction?
>   * @callback_param: general parameter to pass to the callback routine
>   * ---async_tx api specific fields---
>   * @next: at completion submit this descriptor
> @@ -432,6 +501,7 @@ struct dma_tx_state {
>   * @device_prep_dma_cyclic: prepare a cyclic dma operation suitable for audio.
>   *	The function takes a buffer of size buf_len. The callback function will
>   *	be called after period_len bytes have been transferred.
> + * @device_prep_interleaved_dma: Transfer expression in a generic way.
>   * @device_control: manipulate all pending operations on a channel, returns
>   *	zero or error code
>   * @device_tx_status: poll for transaction completion, the optional
> @@ -496,6 +566,9 @@ struct dma_device {
>  	struct dma_async_tx_descriptor *(*device_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_chan *chan, struct dmaxfer_template *xt,
> +		unsigned long flags);
>  	int (*device_control)(struct dma_chan *chan, enum dma_ctrl_cmd cmd,
>  		unsigned long arg);
>  


-- 
~Vinod


  reply	other threads:[~2011-09-20 16:56 UTC|newest]

Thread overview: 120+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2011-08-12 11:14 [PATCH] DMAEngine: Define generic " Jassi Brar
2011-08-16 12:56 ` Koul, Vinod
2011-08-16 13:06   ` Linus Walleij
2011-08-19 13:43     ` Koul, Vinod
2011-08-19 14:19       ` Linus Walleij
2011-08-19 15:46         ` Jassi Brar
2011-08-19 17:28           ` Koul, Vinod
2011-08-19 18:45             ` Jassi Brar
2011-08-23 14:43       ` Matt Porter
2011-08-16 14:32   ` Jassi Brar
2011-09-15  7:46 ` [PATCHv2] " Jassi Brar
2011-09-15  8:22   ` Russell King
2011-09-15 10:02     ` Jassi Brar
2011-09-16  7:17   ` Barry Song
2011-09-16 11:03     ` Jassi Brar
2011-09-16  9:07   ` Vinod Koul
2011-09-16 12:30     ` Jassi Brar
2011-09-16 17:06       ` Vinod Koul
2011-09-16 17:51         ` Jassi Brar
2011-09-19  3:23           ` Vinod Koul
2011-09-20 12:12   ` [PATCHv3] DMAEngine: Define interleaved " Jassi Brar
2011-09-20 16:52     ` Vinod Koul [this message]
2011-09-20 18:08       ` Jassi Brar
2011-09-21  6:32         ` Vinod Koul
2011-09-21  6:45           ` Jassi Brar
2011-09-21  6:51             ` Vinod Koul
2011-09-21  7:31               ` Jassi Brar
2011-09-21 10:18                 ` Russell King
2011-09-21 15:21                   ` Jassi Brar
2011-09-28  6:39     ` [PATCHv4] " Jassi Brar
2011-09-28  9:03       ` Vinod Koul
2011-09-28 15:15         ` Jassi Brar
2011-09-29 11:17           ` Vinod Koul
2011-09-30  6:43             ` Barry Song
2011-09-30 16:01               ` Jassi Brar
2011-10-01  3:05                 ` Barry Song
2011-10-01 18:11                   ` Vinod Koul
2011-10-01 18:45                     ` Jassi Brar
2011-10-01 18:41                   ` Jassi Brar
2011-10-01 18:48                     ` Jassi Brar
2011-10-02  0:33                     ` Barry Song
2011-10-03  6:24                       ` Jassi Brar
2011-10-03 16:13                         ` Russell King
2011-10-03 16:19                           ` Jassi Brar
2011-10-03 17:15                             ` Williams, Dan J
2011-10-03 18:23                               ` Jassi Brar
2011-10-05 18:19                                 ` Williams, Dan J
2011-10-06  9:06                                   ` Jassi Brar
2011-10-05 18:14                             ` Williams, Dan J
2011-10-06  7:12                               ` Jassi Brar
2011-10-07  5:45                               ` Vinod Koul
2011-10-07 11:27                                 ` Jassi Brar
2011-10-07 14:19                                   ` Vinod Koul
2011-10-07 14:38                                     ` Jassi Brar
2011-10-10  6:53                                       ` Vinod Koul
2011-10-10  9:16                                         ` Jassi Brar
2011-10-10  9:18                                           ` Vinod Koul
2011-10-10  9:53                                             ` Jassi Brar
2011-10-10 10:45                                               ` Vinod Koul
2011-10-10 11:16                                                 ` Jassi Brar
2011-10-10 16:02                                                   ` Vinod Koul
2011-10-10 16:28                                                     ` Jassi Brar
2011-10-11 11:56                                                       ` Vinod Koul
2011-10-11 15:57                                                         ` Jassi Brar
2011-10-11 16:45                                                           ` Vinod Koul
2011-10-12  5:41                                                       ` Barry Song
2011-10-12  6:19                                                         ` Vinod Koul
2011-10-12  6:30                                                           ` Jassi Brar
2011-10-12  6:53                                                           ` Barry Song
2011-10-11 16:44                                   ` Williams, Dan J
2011-10-11 18:42                                     ` Jassi Brar
2011-10-14 18:11                                       ` Bounine, Alexandre
2011-10-14 17:50                                     ` Bounine, Alexandre
2011-10-14 18:36                                       ` Jassi Brar
2011-10-14 19:15                                         ` Bounine, Alexandre
2011-10-15 11:25                                           ` Jassi Brar
2011-10-17 14:07                                             ` Bounine, Alexandre
2011-10-17 15:16                                               ` Jassi Brar
2011-10-17 18:00                                                 ` Bounine, Alexandre
2011-10-17 19:29                                                   ` Jassi Brar
2011-10-17 21:07                                                     ` Bounine, Alexandre
2011-10-18  5:45                                                       ` Jassi Brar
2011-10-18  7:42                                                         ` Russell King
2011-10-18  8:30                                                           ` Jassi Brar
2011-10-18  8:26                                                             ` Vinod Koul
2011-10-18  8:37                                                               ` Jassi Brar
2011-10-18 14:44                                                                 ` Bounine, Alexandre
2011-10-18  9:49                                                             ` Russell King
2011-10-18 11:50                                                               ` Jassi Brar
2011-10-18 11:59                                                                 ` Russell King
2011-10-18 17:57                                                                 ` Bounine, Alexandre
2011-10-24  3:49                                                                   ` Vinod Koul
2011-10-24 12:36                                                                     ` Bounine, Alexandre
2011-10-24 15:27                                                                       ` Vinod Koul
2011-10-18 17:26                                                               ` Bounine, Alexandre
2011-10-18 17:35                                                                 ` Russell King
2011-10-18 17:53                                                                   ` Jassi Brar
2011-10-18 13:51                                                         ` Bounine, Alexandre
2011-10-18 14:54                                                           ` Jassi Brar
2011-10-18 15:15                                                             ` Bounine, Alexandre
2011-09-30 15:47             ` Jassi Brar
2011-10-13  7:03       ` [PATCHv5] " Jassi Brar
2011-10-14  7:32         ` Barry Song
2011-10-14 11:51           ` Jassi Brar
2011-10-14 13:31             ` Vinod Koul
2011-10-14 13:51               ` Jassi Brar
2011-10-14 14:05                 ` Vinod Koul
2011-10-14 14:18                   ` Vinod Koul
2011-10-14 14:55               ` Barry Song
2011-10-14 15:06                 ` Vinod Koul
2011-10-14 15:38                   ` Barry Song
2011-10-14 16:09                     ` Vinod Koul
2011-10-14 16:35                   ` Jassi Brar
2011-10-14 17:04                     ` Vinod Koul
2011-10-14 17:59                       ` Jassi Brar
2011-10-15 17:11                         ` Vinod Koul
2011-10-14 15:16         ` Vinod Koul
2011-10-14 15:50           ` Barry Song
2011-10-16 11:16           ` Jassi Brar
2011-10-16 12:16             ` Vinod Koul

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=1316537529.31295.14.camel@vkoul-udesk3 \
    --to=vinod.koul@intel.com \
    --cc=21cnbao@gmail.com \
    --cc=dan.j.williams@intel.com \
    --cc=jaswinder.singh@linaro.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=rmk@arm.linux.org.uk \
    /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

all inboxes | Powered by JetHome®