diff options
| author | Geert Uytterhoeven <geert+renesas@glider.be> | 2014-06-16 15:13:24 +0200 |
|---|---|---|
| committer | Vinod Koul <vinod.koul@intel.com> | 2014-07-14 22:31:28 +0530 |
| commit | 96cb989857ddfe176f5d5258fbf750bb818c6500 (patch) | |
| tree | 2ddc7b2e0316fa5344ab8be7e78f4693572831af | |
| parent | 9f92d2232d5fabe18741044d8004160f8cf80e9e (diff) | |
| download | linux-96cb989857ddfe176f5d5258fbf750bb818c6500.tar.gz linux-96cb989857ddfe176f5d5258fbf750bb818c6500.tar.bz2 linux-96cb989857ddfe176f5d5258fbf750bb818c6500.zip | |
dmaengine: Update documentation for inline wrappers
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>
Signed-off-by: Vinod Koul <vinod.koul@intel.com>
| -rw-r--r-- | Documentation/dmaengine.txt | 11 |
1 files changed, 5 insertions, 6 deletions
diff --git a/Documentation/dmaengine.txt b/Documentation/dmaengine.txt index 879b6e31e2da..2def665baf6e 100644 --- a/Documentation/dmaengine.txt +++ b/Documentation/dmaengine.txt @@ -84,16 +84,16 @@ 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); @@ -107,8 +107,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 @@ -188,7 +187,7 @@ 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: |