renegade-project/linux-next
2
0
Fork 0
mirror of https://github.com/edk2-porting/linux-next.git synced 2025-01-01 18:24:23 +08:00
Code

dmaengine: Update documentation for inline wrappers

Browse Source 
During the last few years, several inline wrappers for DMA operations have
been introduced:
  - commit 16052827d9 ("dmaengine/dma_slave:
    introduce inline wrappers"),
  - commit a14acb4ac2 ("DMAEngine: add
    dmaengine_prep_interleaved_dma wrapper for interleaved api"),
  - commit 6e3ecaf0ad ("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>
This commit is contained in:
Geert Uytterhoeven 2014-06-16 15:13:24 +02:00 committed by Vinod Koul
parent 9f92d2232d
commit 96cb989857
1 changed files with 5 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
Documentation/dmaengine.txt
View File

@ -84,16 +84,16 @@ The slave DMA usage consists of following steps:
the given transaction. the given transaction.
Interface: 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, struct dma_chan *chan, struct scatterlist *sgl,
unsigned int sg_len, enum dma_data_direction direction, unsigned int sg_len, enum dma_data_direction direction,
unsigned long flags); 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, struct dma_chan *chan, dma_addr_t buf_addr, size_t buf_len,
size_t period_len, enum dma_data_direction direction); 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, struct dma_chan *chan, struct dma_interleaved_template *xt,
unsigned long flags); unsigned long flags);
@ -107,8 +107,7 @@ The slave DMA usage consists of following steps:
if (nr_sg == 0) if (nr_sg == 0)
/* error */ /* error */
desc = chan->device->device_prep_slave_sg(chan, sgl, nr_sg, desc = dmaengine_prep_slave_sg(chan, sgl, nr_sg, direction, flags);
direction, flags);
Once a descriptor has been obtained, the callback information can be Once a descriptor has been obtained, the callback information can be
added and the descriptor must then be submitted. Some DMA engine added and the descriptor must then be submitted. Some DMA engine
@ -188,7 +187,7 @@ Further APIs:
description of this API. description of this API.
This can be used in conjunction with dma_async_is_complete() and 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. completion of a specific DMA transaction.
Note: Note: