[PATCH v2 1/3] doc: dmaengine: client-api: Add immediate commands in the DMA client API

Sireesh Kodali
2022-10-27T05:14:56Z

Immediate commands are used by the IPA driver to send commands to the
microcontroller over BAM. These are different from PREP_CMD.

Signed-off-by: Sireesh Kodali <sireeshkodali1@gmail.com>
---
Documentation/driver-api/dmaengine/provider.rst | 10 ++++++++++
1 file changed, 10 insertions(+)

diff --git a/Documentation/driver-api/dmaengine/provider.rst b/Documentation/driver-api/dmaengine/provider.rst
index ceac2a300e32..5afe21191299 100644
--- a/Documentation/driver-api/dmaengine/provider.rst
+++ b/Documentation/driver-api/dmaengine/provider.rst
@@ -590,6 +590,16 @@ DMA_CTRL_REUSE
writes for which the descriptor should be in different format from
normal data descriptors.

+- DMA_PREP_IMM_CMD
+
+ - If set, the client driver tells DMA controller that passed data in DMA
+ API is immediate command data.
+
+ - Interpretation of command data is DMA controller specific. It can be
+ used for issuing immediate commands to other peripherals/register
+ reads/register writes for which the descriptor should be in a
+ different format from normal data descriptors.
+
- DMA_PREP_REPEAT

- If set, the transfer will be automatically repeated when it ends until a
--
2.38.1