summaryrefslogtreecommitdiff
path: root/Documentation/driver-api/dmaengine
diff options
context:
space:
mode:
authorBhanu Seshu Kumar Valluri <bhanuseshukumar@gmail.com>2025-11-13 12:19:37 +0530
committerVinod Koul <vkoul@kernel.org>2025-12-16 21:23:20 +0530
commit08be54a9e56f9523b50d1923a94a48ef5890c0bc (patch)
treeee07a7af6efd6446c6ab95f8765b508581bc420f /Documentation/driver-api/dmaengine
parentf94163e950c9568fe2d2d88317d9602ce021e646 (diff)
docs: dmaengine: add explanation for phys field in dma_async_tx_descriptor structure
Describe the need to initialize the phys field in the dma_async_tx_descriptor structure during its initialization. Signed-off-by: Bhanu Seshu Kumar Valluri <bhanuseshukumar@gmail.com> Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com> Link: https://patch.msgid.link/20251113064937.8735-1-bhanuseshukumar@gmail.com Signed-off-by: Vinod Koul <vkoul@kernel.org>
Diffstat (limited to 'Documentation/driver-api/dmaengine')
-rw-r--r--Documentation/driver-api/dmaengine/provider.rst5
1 files changed, 4 insertions, 1 deletions
diff --git a/Documentation/driver-api/dmaengine/provider.rst b/Documentation/driver-api/dmaengine/provider.rst
index 1594598b3317..f4ed98f701c9 100644
--- a/Documentation/driver-api/dmaengine/provider.rst
+++ b/Documentation/driver-api/dmaengine/provider.rst
@@ -411,7 +411,7 @@ supported.
- This structure can be initialized using the function
``dma_async_tx_descriptor_init``.
- - You'll also need to set two fields in this structure:
+ - You'll also need to set following fields in this structure:
- flags:
TODO: Can it be modified by the driver itself, or
@@ -421,6 +421,9 @@ supported.
that is supposed to push the current transaction descriptor to a
pending queue, waiting for issue_pending to be called.
+ - phys: Physical address of the descriptor which is used later by
+ the dma engine to read the descriptor and initiate transfer.
+
- In this structure the function pointer callback_result can be
initialized in order for the submitter to be notified that a
transaction has completed. In the earlier code the function pointer