u-boot/doc/usage/cmd/dmareset.rst
Tom Rini 11da3403e9 doc: usage: Add general rule for $?
For nearly all commands in U-Boot the '?' variable is handled the same
way with 0 meaning success, 1 meaning any failure.  Explain this in the
general rules section of the cmdline documentation (with a link to a
counter example) and then remove the redundant wording from most
commands. We retain a section about the return value in a number of
places where we are doing something such as always returning a specific
value or we have useful additional information to go along with the
normal return codes.

Signed-off-by: Tom Rini <trini@konsulko.com>
Reviewed-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2025-10-26 09:03:35 -06:00

50 lines
875 B
ReStructuredText

.. SPDX-License-Identifier: GPL-2.0-or-later
.. 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
Description
-----------
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".