Re: [PATCH v5 8/9] doc: rng: Add documentation for the rng command

2022-03-24 Thread Sughosh Ganu
hi Heinrich,

On Sun, 13 Mar 2022 at 20:19, Sughosh Ganu  wrote:
>
> Add a usage document for the 'rng' u-boot command.
>
> Signed-off-by: Sughosh Ganu 
> Reviewed-by: Ilias Apalodimas 
> Reviewed-by: Simon Glass 
> ---
>
> Changes since V4:
>
> * Reflect the fact that a maximum of 64 bytes can be read on each
>   invocation of the 'rng' command
>
>  doc/usage/index.rst |  1 +
>  doc/usage/rng.rst   | 26 ++
>  2 files changed, 27 insertions(+)
>  create mode 100644 doc/usage/rng.rst

Can you please pick this up, as this has been reviewed and is not
related to the TPM RNG changes which are still under discussion.
Thanks.

-sughosh

>
> diff --git a/doc/usage/index.rst b/doc/usage/index.rst
> index 0aacf531b2..5712a924ae 100644
> --- a/doc/usage/index.rst
> +++ b/doc/usage/index.rst
> @@ -45,6 +45,7 @@ Shell commands
> pstore
> qfw
> reset
> +   rng
> sbi
> sf
> scp03
> diff --git a/doc/usage/rng.rst b/doc/usage/rng.rst
> new file mode 100644
> index 00..1a352da41a
> --- /dev/null
> +++ b/doc/usage/rng.rst
> @@ -0,0 +1,26 @@
> +.. SPDX-License-Identifier: GPL-2.0+
> +
> +rng command
> +===
> +
> +Synopsis
> +
> +
> +::
> +
> +rng [devnum [n]]
> +
> +Description
> +---
> +
> +The *rng* command reads the random number generator(RNG) device and
> +prints the random bytes read on the console. A maximum of 64 bytes can
> +be read in one invocation of the command.
> +
> +devnum
> +The RNG device from which the random bytes are to be
> +read. Defaults to 0.
> +
> +n
> +Number of random bytes to be read and displayed on the
> +console. Default value is 0x40. Max value is 0x40.
> --
> 2.25.1
>


[PATCH v5 8/9] doc: rng: Add documentation for the rng command

2022-03-13 Thread Sughosh Ganu
Add a usage document for the 'rng' u-boot command.

Signed-off-by: Sughosh Ganu 
Reviewed-by: Ilias Apalodimas 
Reviewed-by: Simon Glass 
---

Changes since V4:

* Reflect the fact that a maximum of 64 bytes can be read on each
  invocation of the 'rng' command

 doc/usage/index.rst |  1 +
 doc/usage/rng.rst   | 26 ++
 2 files changed, 27 insertions(+)
 create mode 100644 doc/usage/rng.rst

diff --git a/doc/usage/index.rst b/doc/usage/index.rst
index 0aacf531b2..5712a924ae 100644
--- a/doc/usage/index.rst
+++ b/doc/usage/index.rst
@@ -45,6 +45,7 @@ Shell commands
pstore
qfw
reset
+   rng
sbi
sf
scp03
diff --git a/doc/usage/rng.rst b/doc/usage/rng.rst
new file mode 100644
index 00..1a352da41a
--- /dev/null
+++ b/doc/usage/rng.rst
@@ -0,0 +1,26 @@
+.. SPDX-License-Identifier: GPL-2.0+
+
+rng command
+===
+
+Synopsis
+
+
+::
+
+rng [devnum [n]]
+
+Description
+---
+
+The *rng* command reads the random number generator(RNG) device and
+prints the random bytes read on the console. A maximum of 64 bytes can
+be read in one invocation of the command.
+
+devnum
+The RNG device from which the random bytes are to be
+read. Defaults to 0.
+
+n
+Number of random bytes to be read and displayed on the
+console. Default value is 0x40. Max value is 0x40.
-- 
2.25.1