From 4faa1a5287b3a7fe6dbf7d79ec8ded86913f4f5b Mon Sep 17 00:00:00 2001 From: Peng Fan Date: Tue, 4 Nov 2025 18:06:01 +0800 Subject: [PATCH] doc: cmd: Document remoteproc usage Add documentation for rproc cmd usage. Signed-off-by: Peng Fan --- doc/usage/cmd/rproc.rst | 78 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 78 insertions(+) create mode 100644 doc/usage/cmd/rproc.rst 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 + +remoteproc command +================== + +Synopsis +-------- + +:: + + rproc init + rproc list + rproc load [addr] [size] + rproc start + rproc stop + rproc reset + rproc is_running + rproc ping + +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 -- 2.47.3