diff mbox series

[v3,3/5] doc/usage: cmd: documentation for meson/sm command

Message ID 20221222125727.47893-4-avromanov@sberdevices.ru
State Superseded
Delegated to: Neil Armstrong
Headers show
Series arch-meson: introduce efusedump command | expand

Commit Message

Alexey Romanov Dec. 22, 2022, 12:57 p.m. UTC
Signed-off-by: Alexey Romanov <avromanov@sberdevices.ru>
---
 doc/usage/cmd/sm.rst | 44 ++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 44 insertions(+)
 create mode 100644 doc/usage/cmd/sm.rst

Comments

Neil Armstrong Jan. 4, 2023, 12:35 p.m. UTC | #1
Le 22/12/2022 à 13:57, Alexey Romanov via groups.io a écrit :

Please add a short description of the change in the commit message.

With this added:
Reviewed-by: Neil Armstrong <neil.armstrong@linaro.org>

> Signed-off-by: Alexey Romanov <avromanov@sberdevices.ru>
> ---
>   doc/usage/cmd/sm.rst | 44 ++++++++++++++++++++++++++++++++++++++++++++
>   1 file changed, 44 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..3a70c137ec9
> --- /dev/null
> +++ b/doc/usage/cmd/sm.rst
> @@ -0,0 +1,44 @@
> +.. SPDX-License-Identifier: GPL-2.0+:
> +
> +Meson Security Monitor 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
Heinrich Schuchardt Jan. 4, 2023, 1:21 p.m. UTC | #2
On 1/4/23 13:35, Neil Armstrong wrote:
> Le 22/12/2022 à 13:57, Alexey Romanov via groups.io a écrit :
>
> Please add a short description of the change in the commit message.
>
> With this added:
> Reviewed-by: Neil Armstrong <neil.armstrong@linaro.org>
>
>> Signed-off-by: Alexey Romanov <avromanov@sberdevices.ru>
>> ---
>>   doc/usage/cmd/sm.rst | 44 ++++++++++++++++++++++++++++++++++++++++++++

This lacks an addition to doc/usage/index.rst.

>>   1 file changed, 44 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..3a70c137ec9
>> --- /dev/null
>> +++ b/doc/usage/cmd/sm.rst
>> @@ -0,0 +1,44 @@
>> +.. SPDX-License-Identifier: GPL-2.0+:
>> +
>> +Meson Security Monitor command

sm command
==========

We always use the actual command name here as it appears in the index.

You can mention the Meson Security Monitor in the text below.

Best regards

Heinrich

>> +==============================
>> +
>> +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 mbox series

Patch

diff --git a/doc/usage/cmd/sm.rst b/doc/usage/cmd/sm.rst
new file mode 100644
index 00000000000..3a70c137ec9
--- /dev/null
+++ b/doc/usage/cmd/sm.rst
@@ -0,0 +1,44 @@ 
+.. SPDX-License-Identifier: GPL-2.0+:
+
+Meson Security Monitor 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