Add documentation for rproc cmd usage. Signed-off-by: Peng Fan <[email protected]> --- doc/usage/cmd/rproc.rst | 78 +++++++++++++++++++++++++++++++++++++++++++++++++ doc/usage/index.rst | 1 + 2 files changed, 79 insertions(+)
diff --git a/doc/usage/cmd/rproc.rst b/doc/usage/cmd/rproc.rst new file mode 100644 index 0000000000000000000000000000000000000000..663c1e3d490baa429e77936dec5f54ac91091ed0 --- /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 diff --git a/doc/usage/index.rst b/doc/usage/index.rst index 14daa08ca18cf590ef837ae38faf8c6bc85a26b9..31ac3b438a6a0c77f1a1ed2d1d2cc6c05ec90d3f 100644 --- a/doc/usage/index.rst +++ b/doc/usage/index.rst @@ -110,6 +110,7 @@ Shell commands cmd/read cmd/reset cmd/rng + cmd/rproc cmd/saves cmd/sb cmd/sbi -- 2.37.1
