summaryrefslogtreecommitdiff
path: root/apps/examples/README.txt
diff options
context:
space:
mode:
authorGregory Nutt <gnutt@nuttx.org>2013-10-20 11:37:56 -0600
committerGregory Nutt <gnutt@nuttx.org>2013-10-20 11:37:56 -0600
commit5d38ee0f6f16a8db3b212d9282a21d5833b669e7 (patch)
treee97ba7461ff319ab77864afdf2aa45f0fcc340d9 /apps/examples/README.txt
parentcd6eaa5af6142c5a1027a14763df280b5c141999 (diff)
downloadnuttx-5d38ee0f6f16a8db3b212d9282a21d5833b669e7.tar.gz
nuttx-5d38ee0f6f16a8db3b212d9282a21d5833b669e7.tar.bz2
nuttx-5d38ee0f6f16a8db3b212d9282a21d5833b669e7.zip
apps/examples/random: Add a test for /dev/random
Diffstat (limited to 'apps/examples/README.txt')
-rw-r--r--apps/examples/README.txt22
1 files changed, 22 insertions, 0 deletions
diff --git a/apps/examples/README.txt b/apps/examples/README.txt
index 85b0e60fc..9423dcbcd 100644
--- a/apps/examples/README.txt
+++ b/apps/examples/README.txt
@@ -1307,6 +1307,28 @@ examples/qencoder
is defined, then this value is the default delay if no other delay is
provided on the command line. Default: 100 milliseconds
+examples/random
+^^^^^^^^^^^^^^^
+
+ This is a very simply test of /dev/random. It simple collects random
+ numbers and displays them on the console.
+
+ Prerequistes:
+
+ CONFIG_DEV_RANDOM - Support for /dev/random must be enabled in order
+ to select this example.
+
+ Configuration:
+
+ CONFIG_EXAMPLES_RANDOM - Enables the /dev/random test
+ CONFIG_EXAMPLES_MAXSAMPLES - This is the size of the /dev/random I/O
+ buffer in units of 32-bit samples. Careful! This buffer is allocated
+ on the stack as needed! Default 64.
+ CONFIG_EXAMPLES_NSAMPLES; - When you execute the rand command, a number
+ of samples ranging from 1 to EXAMPLES_MAXSAMPLES may be specified. If
+ no argument is specified, this is the default number of samples that\
+ will be collected and displayed. Default 8
+
examples/relays
^^^^^^^^^^^^^^^