]> git.ipfire.org Git - thirdparty/linux.git/commitdiff
docs: dmaengine: add explanation for DMA_ASYNC_TX capability
authorKendra Moore <kendra.j.moore3443@gmail.com>
Mon, 21 Apr 2025 01:02:05 +0000 (21:02 -0400)
committerJonathan Corbet <corbet@lwn.net>
Wed, 7 May 2025 07:02:57 +0000 (01:02 -0600)
This patch replaces the TODO for DMA_ASYNC_TX in the DMA engine
provider documentation. The flag is automatically set by the DMA
framework when a device supports key asynchronous memory-to-memory
operations such as memcpy, memset, xor, pq, xor_val, and pq_val.

It must not be set by drivers directly.

Signed-off-by: Kendra Moore <kendra.j.moore3443@gmail.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <20250421010205.84719-1-kendra.j.moore3443@gmail.com>

Documentation/driver-api/dmaengine/provider.rst

index 3085f8b460fa5514bf95d07e9c7120c19f2d467b..8f0910668ca31780cd3a53c4bbeacd332ea8d854 100644 (file)
@@ -217,10 +217,12 @@ Currently, the types available are:
 
 - DMA_ASYNC_TX
 
-  - Must not be set by the device, and will be set by the framework
-    if needed
+  - The device supports asynchronous memory-to-memory operations,
+    including memcpy, memset, xor, pq, xor_val, and pq_val.
 
-  - TODO: What is it about?
+  - This capability is automatically set by the DMA engine
+    framework and must not be configured manually by device
+    drivers.
 
 - DMA_SLAVE