[PATCH v2] cmd/dma: documentation

[PATCH v2] cmd/dma: documentation

[Brian Sune]

This explains how
to use the new U-Boot command 'dmareset'.

Signed-off-by: Brian Sune <briansune@gmail.com>
---
 doc/usage/cmd/dmareset.rst | 55 ++++++++++++++++++++++++++++++++++++++
 doc/usage/index.rst        |  1 +
 2 files changed, 56 insertions(+)
 create mode 100644 doc/usage/cmd/dmareset.rst

diff --git a/doc/usage/cmd/dmareset.rst b/doc/usage/cmd/dmareset.rst
new file mode 100644
index 00000000000..d30f1d3e8d4
--- /dev/null
+++ b/doc/usage/cmd/dmareset.rst
@@ -0,0 +1,55 @@
+.. SPDX-License-Identifier: GPL-2.0+:
+
+.. index::
+   single: dmareset (command)
+
+dmareset command
+================
+
+Synopsis
+--------
+
+::
+
+    Usage: dmareset <channel 0-7> [<channel 0-7> ...]
+    dmareset - Release PL330 DMA channel reset(s) for SoCFPGA
+
+    Usage:
+    dmareset <channel 0-7> [<channel 0-7> ...]  - release reset for one or more DMA channels
+
+dmareset channel
+----------------
+
+Release the DMA channel reset *channel*.
+
+Parameters
+----------
+
+channel
+    DMA channel number
+
+Example
+-------
+
+Release DMA channel(s)::
+
+    => dmareset 0
+    PL330 DMA channel 0 reset released
+    => dmareset 1
+    PL330 DMA channel 1 reset released
+    => dmareset 0 1
+    PL330 DMA channel 0 reset released
+    PL330 DMA channel 1 reset released
+
+
+Configuration
+-------------
+
+The dmareset command is only available if CONFIG_CMD_C5_PL330_DMA=y in
+"Shell scripting commands".
+
+Return value
+------------
+
+If the command succeds the return PL330 DMA channel $? reset released.
+If an error occurs, the return Error: channel must be 0-7.
diff --git a/doc/usage/index.rst b/doc/usage/index.rst
index 3a48521d5d5..809bf31b2ac 100644
--- a/doc/usage/index.rst
+++ b/doc/usage/index.rst
@@ -57,6 +57,7 @@ Shell commands
    cmd/cpu
    cmd/cpuid
    cmd/cyclic
+   cmd/dmareset
    cmd/dm
    cmd/ebtupdate
    cmd/echo
-- 
2.47.1.windows.1

Re: [PATCH v2] cmd/dma: documentation

[Tom Rini]

[-- Attachment #1: Type: text/plain, Size: 283 bytes --]

On Thu, Oct 09, 2025 at 04:41:03AM +0800, Brian Sune wrote:

> This explains how
> to use the new U-Boot command 'dmareset'.
> 
> Signed-off-by: Brian Sune <briansune@gmail.com>

I built this locally and no problems.

Reviewed-by: Tom Rini <trini@konsulko.com>

-- 
Tom

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]

Re: [PATCH v2] cmd/dma: documentation

[Sune Brian]

Tom Rini <trini@konsulko.com> 於 2025年10月9日 週四 上午4:50寫道：

> Reviewed-by: Tom Rini <trini@konsulko.com>
>
> --
> Tom

Aaaaaa, no idea why my env no good.
But at least you checked.
Thank you.

Re: [PATCH v2] cmd/dma: documentation

[Sune Brian]

> Aaaaaa, no idea why my env no good.
> But at least you checked.
> Thank you.

I debugged the caused.
The previous warnings are all introduced due to disk access right.
And possible share driver thing that block some tools to run properly.
I can also built in in local trunk.
Learnt s.t. =]