summaryrefslogtreecommitdiff
path: root/doc/usage/cmd
diff options
context:
space:
mode:
authorTom Rini <[email protected]>2025-11-04 13:06:26 -0600
committerTom Rini <[email protected]>2025-11-04 13:06:26 -0600
commit1c250e444ad3b15315ee8b0fcb3fc3acc26449e2 (patch)
tree47cd432ccfc396c9fabd4631566289f120c01605 /doc/usage/cmd
parentef34776f21969a71594dc6224d0e54cf5a2a980c (diff)
parent2b7892255bd617dfc523cfe8455dbf386a3dfaf5 (diff)
Merge tag 'u-boot-imx-master-20251104' of https://gitlab.denx.de/u-boot/custodians/u-boot-imx
CI: https://source.denx.de/u-boot/custodians/u-boot-imx/-/pipelines/28144 - Extend USB support for the i.MX9 family. - Update memory controller for imx6ulz_smm_m2. - Add remoteproc support for several i.MX boards. - Add support for iMX95 15x15 EVK.
Diffstat (limited to 'doc/usage/cmd')
-rw-r--r--doc/usage/cmd/rproc.rst78
1 files changed, 78 insertions, 0 deletions
diff --git a/doc/usage/cmd/rproc.rst b/doc/usage/cmd/rproc.rst
new file mode 100644
index 00000000000..663c1e3d490
--- /dev/null
+++ b/doc/usage/cmd/rproc.rst
@@ -0,0 +1,78 @@
+.. SPDX-License-Identifier: GPL-2.0+
+ Copyright 2025 NXP
+ Written by Peng Fan <[email protected]>
+
+remoteproc command
+==================
+
+Synopsis
+--------
+
+::
+
+ rproc init <id>
+ rproc list
+ rproc load <id> [addr] [size]
+ rproc start <id>
+ rproc stop <id>
+ rproc reset <id>
+ rproc is_running <id>
+ rproc ping <id>
+
+Description
+-----------
+
+The rproc command provides a generic U-Boot mechanism to manage the Remote
+Processors inside a SoC .
+
+The 'rproc init' command enumerate and initialize the remote processor.
+
+ id
+ remote processor id. if id is not passed, initialize all the
+ remote prcessors
+
+The 'rproc list' list available remote processors.
+
+The 'rproc load' load the remote processor with binary.
+
+ id
+ remote processor id.
+ addr
+ address that image is loaded at.
+ size
+ image size
+
+The 'rproc start' start the remote processor(must be loaded).
+
+ id
+ remote processor id.
+
+The 'rproc stop' stop the remote processor.
+
+ id
+ remote processor id.
+
+The 'rproc reset' reset the remote processor.
+
+ id
+ remote processor id.
+
+The 'rproc is_running' reports if the remote processor is running.
+
+ id
+ remote processor id.
+
+The 'rproc ping' ping the remote processor for communication.
+
+ id
+ remote processor id.
+
+Configuration
+-------------
+
+The rproc command is only available if CONFIG_CMD_REMOTEPROC=y.
+
+.. toctree::
+ :maxdepth: 2
+
+ ../../board/nxp/rproc.rst