Commit cf7da891 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Vinod Koul

docs: dmaengine: provider.rst: get rid of some warnings

Get rid of those warnings by adding extra blank lines:

    Documentation/driver-api/dmaengine/provider.rst:270: WARNING: Unexpected indentation.
    Documentation/driver-api/dmaengine/provider.rst:273: WARNING: Block quote ends without a blank line; unexpected unindent.
    Documentation/driver-api/dmaengine/provider.rst:288: WARNING: Unexpected indentation.
    Documentation/driver-api/dmaengine/provider.rst:290: WARNING: Block quote ends without a blank line; unexpected unindent.

While here, use parenthesis after get_metadata_ptr/set_metadata_len,
as, if some day someone adds a kerneldoc markup for those, it
should automatically generate a cross-reference to them.
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/62cf2a87b379a92c9c0e5a40c2ae8a138b01fe0a.1583250595.git.mchehab+huawei@kernel.orgSigned-off-by: default avatarVinod Koul <vkoul@kernel.org>
parent 25962e1a
...@@ -266,11 +266,15 @@ to use. ...@@ -266,11 +266,15 @@ to use.
attached (via the dmaengine_desc_attach_metadata() helper to the descriptor. attached (via the dmaengine_desc_attach_metadata() helper to the descriptor.
From the DMA driver the following is expected for this mode: From the DMA driver the following is expected for this mode:
- DMA_MEM_TO_DEV / DEV_MEM_TO_MEM - DMA_MEM_TO_DEV / DEV_MEM_TO_MEM
The data from the provided metadata buffer should be prepared for the DMA The data from the provided metadata buffer should be prepared for the DMA
controller to be sent alongside of the payload data. Either by copying to a controller to be sent alongside of the payload data. Either by copying to a
hardware descriptor, or highly coupled packet. hardware descriptor, or highly coupled packet.
- DMA_DEV_TO_MEM - DMA_DEV_TO_MEM
On transfer completion the DMA driver must copy the metadata to the client On transfer completion the DMA driver must copy the metadata to the client
provided metadata buffer before notifying the client about the completion. provided metadata buffer before notifying the client about the completion.
After the transfer completion, DMA drivers must not touch the metadata After the transfer completion, DMA drivers must not touch the metadata
...@@ -284,10 +288,14 @@ to use. ...@@ -284,10 +288,14 @@ to use.
and dmaengine_desc_set_metadata_len() is provided as helper functions. and dmaengine_desc_set_metadata_len() is provided as helper functions.
From the DMA driver the following is expected for this mode: From the DMA driver the following is expected for this mode:
- get_metadata_ptr
- get_metadata_ptr()
Should return a pointer for the metadata buffer, the maximum size of the Should return a pointer for the metadata buffer, the maximum size of the
metadata buffer and the currently used / valid (if any) bytes in the buffer. metadata buffer and the currently used / valid (if any) bytes in the buffer.
- set_metadata_len
- set_metadata_len()
It is called by the clients after it have placed the metadata to the buffer It is called by the clients after it have placed the metadata to the buffer
to let the DMA driver know the number of valid bytes provided. to let the DMA driver know the number of valid bytes provided.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment