leandrof/linux
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

dmaengine: doc: fix warnings/issues of client.rst

Browse Source 
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>
This commit is contained in:
Changbin Du 2020-02-04 20:51:15 +08:00 committed by Vinod Koul
parent 61b5865d56
commit 83c49f7344
1 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
Documentation/driver-api/dmaengine/client.rst
View File

@ -151,8 +151,8 @@ The details of these operations are:
Note that callbacks will always be invoked from the DMA Note that callbacks will always be invoked from the DMA
engines tasklet, never from interrupt context. engines tasklet, never from interrupt context.
Optional: per descriptor metadata **Optional: per descriptor metadata**
---------------------------------
DMAengine provides two ways for metadata support. DMAengine provides two ways for metadata support.
DESC_METADATA_CLIENT DESC_METADATA_CLIENT
@ -199,12 +199,15 @@ Optional: per descriptor metadata
DESC_METADATA_CLIENT DESC_METADATA_CLIENT
- DMA_MEM_TO_DEV / DEV_MEM_TO_MEM: - DMA_MEM_TO_DEV / DEV_MEM_TO_MEM:
1. prepare the descriptor (dmaengine_prep_*) 1. prepare the descriptor (dmaengine_prep_*)
construct the metadata in the client's buffer construct the metadata in the client's buffer
2. use dmaengine_desc_attach_metadata() to attach the buffer to the 2. use dmaengine_desc_attach_metadata() to attach the buffer to the
descriptor descriptor
3. submit the transfer 3. submit the transfer
- DMA_DEV_TO_MEM: - DMA_DEV_TO_MEM:
1. prepare the descriptor (dmaengine_prep_*) 1. prepare the descriptor (dmaengine_prep_*)
2. use dmaengine_desc_attach_metadata() to attach the buffer to the 2. use dmaengine_desc_attach_metadata() to attach the buffer to the
descriptor descriptor
@ -215,6 +218,7 @@ Optional: per descriptor metadata
DESC_METADATA_ENGINE DESC_METADATA_ENGINE
- DMA_MEM_TO_DEV / DEV_MEM_TO_MEM: - DMA_MEM_TO_DEV / DEV_MEM_TO_MEM:
1. prepare the descriptor (dmaengine_prep_*) 1. prepare the descriptor (dmaengine_prep_*)
2. use dmaengine_desc_get_metadata_ptr() to get the pointer to the 2. use dmaengine_desc_get_metadata_ptr() to get the pointer to the
engine's metadata area 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 4. use dmaengine_desc_set_metadata_len() to tell the DMA engine the
amount of data the client has placed into the metadata buffer amount of data the client has placed into the metadata buffer
5. submit the transfer 5. submit the transfer
- DMA_DEV_TO_MEM: - DMA_DEV_TO_MEM:
1. prepare the descriptor (dmaengine_prep_*) 1. prepare the descriptor (dmaengine_prep_*)
2. submit the transfer 2. submit the transfer
3. on transfer completion, use dmaengine_desc_get_metadata_ptr() to get 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); void dma_async_issue_pending(struct dma_chan *chan);
Further APIs: Further APIs
------------- ------------
1. Terminate APIs 1. Terminate APIs