[PATCH v4 3/5] doc/usage: cmd: documentation for meson/sm command

[Mattijs Korpershoek]

On Tue, Jan 10, 2023 at 13:56, Alexey Romanov <avromanov at sberdevices.ru> wrote:

> Added docs for Meson Security Monitor command.
>
> Signed-off-by: Alexey Romanov <avromanov at sberdevices.ru>

Reviewed-by: Mattijs Korpershoek <mkorpershoek at baylibre.com>

> ---
>  doc/usage/cmd/sm.rst | 44 ++++++++++++++++++++++++++++++++++++++++++++
>  doc/usage/index.rst  |  1 +
>  2 files changed, 45 insertions(+)
>  create mode 100644 doc/usage/cmd/sm.rst
>
> diff --git a/doc/usage/cmd/sm.rst b/doc/usage/cmd/sm.rst
> new file mode 100644
> index 00000000000..c41227f4b3b
> --- /dev/null
> +++ b/doc/usage/cmd/sm.rst
> @@ -0,0 +1,44 @@
> +.. SPDX-License-Identifier: GPL-2.0+:
> +
> +sm command
> +==========
> +
> +Synopis
> +-------
> +
> +::
> +
> +    sm serial <address>
> +    sm reboot_reason [name]
> +    sm efuseread <offset> <size> <address>
> +    sm efusewrite <offset> <size> <address>
> +    sm efusedump <offset> <size>
> +
> +Description
> +-----------
> +
> +The sm command is used to request services from the secure monitor. User
> +can call secure monitor to request special TEE function, for example chip
> +serial number info, reboot reason, etc.
> +
> +sm serial
> +  Retrieve chip unique serial number from sm and write it to memory on
> +  appropriate address.
> +
> +sm reboot_reason
> +  Print reboot reason to the console, if parameter [name] isn't specified.
> +  If parameter specified, set reboot reason string to environment variable
> +  with this name.
> +
> +sm efuseread
> +  Read <size> bytes starting from <offset> from efuse memory bank and write
> +  result to the address <address>.
> +
> +sm efusewrite
> +  Write into efuse memory bank, starting from <offset>, the <size> bytes
> +  of data, located at address <address>.
> +
> +Configuration
> +-------------
> +
> +To use the sm command you must specify CONFIG_CMD_MESON=y
> diff --git a/doc/usage/index.rst b/doc/usage/index.rst
> index 770418434ad..e34b98dae24 100644
> --- a/doc/usage/index.rst
> +++ b/doc/usage/index.rst
> @@ -61,6 +61,7 @@ Shell commands
>     cmd/true
>     cmd/ums
>     cmd/wdt
> +   cmd/sm
>  
>  Booting OS
>  ----------
> -- 
> 2.25.1