diff options
| author |   Changbin Du <changbin.du@gmail.com> | 2020-02-04 20:51:15 +0800 |
|---|---|---|
| committer |   Vinod Koul <vkoul@kernel.org> | 2020-02-13 20:35:24 +0530 |
| commit | 83c49f734463980802d6dba376f69e787fb07a8e (patch) | |
| tree | e16116977ece722c135fa62a05682af94e96cd32 /Documentation/driver-api/dmaengine/client.rst | |
| parent | dmaengine: idxd: fix runaway module ref count on device driver bind (diff) | |
| download | linux-dev-83c49f734463980802d6dba376f69e787fb07a8e.tar.xz linux-dev-83c49f734463980802d6dba376f69e787fb07a8e.zip | |
dmaengine: doc: fix warnings/issues of client.rst
This fixed some warnings/issues of client.rst.
o Need a blank line for enumerated lists.
o Do not create section in enumerated list.
o Remove suffix ':' from section title.
Signed-off-by: Changbin Du <changbin.du@gmail.com>
Link: https://lore.kernel.org/r/20200204125115.12128-1-changbin.du@gmail.com
Signed-off-by: Vinod Koul <vkoul@kernel.org>
Diffstat (limited to '')
| -rw-r--r-- | Documentation/driver-api/dmaengine/client.rst | 14 |
1 files changed, 10 insertions, 4 deletions
diff --git a/Documentation/driver-api/dmaengine/client.rst b/Documentation/driver-api/dmaengine/client.rst index e5953e7e4bf4..2104830a99ae 100644 --- a/Documentation/driver-api/dmaengine/client.rst +++ b/Documentation/driver-api/dmaengine/client.rst @@ -151,8 +151,8 @@ The details of these operations are: Note that callbacks will always be invoked from the DMA engines tasklet, never from interrupt context. -Optional: per descriptor metadata ---------------------------------- + **Optional: per descriptor metadata** + DMAengine provides two ways for metadata support. DESC_METADATA_CLIENT @@ -199,12 +199,15 @@ Optional: per descriptor metadata DESC_METADATA_CLIENT - DMA_MEM_TO_DEV / DEV_MEM_TO_MEM: + 1. prepare the descriptor (dmaengine_prep_*) construct the metadata in the client's buffer 2. use dmaengine_desc_attach_metadata() to attach the buffer to the descriptor 3. submit the transfer + - DMA_DEV_TO_MEM: + 1. prepare the descriptor (dmaengine_prep_*) 2. use dmaengine_desc_attach_metadata() to attach the buffer to the descriptor @@ -215,6 +218,7 @@ Optional: per descriptor metadata DESC_METADATA_ENGINE - DMA_MEM_TO_DEV / DEV_MEM_TO_MEM: + 1. prepare the descriptor (dmaengine_prep_*) 2. use dmaengine_desc_get_metadata_ptr() to get the pointer to the engine's metadata area @@ -222,7 +226,9 @@ Optional: per descriptor metadata 4. use dmaengine_desc_set_metadata_len() to tell the DMA engine the amount of data the client has placed into the metadata buffer 5. submit the transfer + - DMA_DEV_TO_MEM: + 1. prepare the descriptor (dmaengine_prep_*) 2. submit the transfer 3. on transfer completion, use dmaengine_desc_get_metadata_ptr() to get @@ -278,8 +284,8 @@ Optional: per descriptor metadata void dma_async_issue_pending(struct dma_chan *chan); -Further APIs: -------------- +Further APIs +------------ 1. Terminate APIs |