summaryrefslogtreecommitdiff
path: root/doc/usage
diff options
context:
space:
mode:
authorPeng Fan <[email protected]>2025-11-04 18:06:01 +0800
committerFabio Estevam <[email protected]>2025-11-04 12:45:30 -0300
commit4faa1a5287b3a7fe6dbf7d79ec8ded86913f4f5b (patch)
treeceec6ddec0805a840581c3ce5cbda616ff648b57 /doc/usage
parent1e0d22cb6b0680c4973915bfa52fa47f518c0a27 (diff)
doc: cmd: Document remoteproc usage
Add documentation for rproc cmd usage. Signed-off-by: Peng Fan <[email protected]>
Diffstat (limited to 'doc/usage')
-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