All of lore.kernel.org
 help / color / mirror / Atom feed
From: Brian Sune <briansune@gmail.com>
To: Tom Rini <trini@konsulko.com>, u-boot@lists.denx.de
Subject: [PATCH v2] cmd/dma: documentation
Date: Thu,  9 Oct 2025 04:41:03 +0800	[thread overview]
Message-ID: <20251008204103.1497-1-briansune@gmail.com> (raw)

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


             reply	other threads:[~2025-10-08 20:41 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-10-08 20:41 Brian Sune [this message]
2025-10-08 20:50 ` [PATCH v2] cmd/dma: documentation Tom Rini
2025-10-08 20:53   ` Sune Brian
2025-10-08 23:09     ` Sune Brian

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20251008204103.1497-1-briansune@gmail.com \
    --to=briansune@gmail.com \
    --cc=trini@konsulko.com \
    --cc=u-boot@lists.denx.de \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.