fix locking of USB_MTX
[gnuk/neug.git] / README
diff --git a/README b/README
index 3b6690f..6ae5449 100644 (file)
--- a/README
+++ b/README
@@ -1,7 +1,7 @@
-NeuG - a random number generator implementation (for STM32F103)
+NeuG - a true random number generator implementation (for STM32F103)
 
-                                                          Version 0.03
-                                                            2012-10-XX
+                                                          Version 0.10
+                                                            2013-06-XX
                                                           Niibe Yutaka
                                      Free Software Initiative of Japan
 
@@ -28,12 +28,10 @@ NeuG was named after my daughter, but I don't say she is noisy.
 Release notes
 =============
 
-This is the fourth release of NeuG, which is still experimental.
-Basic features (generating random numbers) are stable, but newly added
+This is the seventh release of NeuG, which is still experimental.  Basic
+features (generating random numbers) are stable, but newly added
 things like reGNUal support should be considered unstable.  Note that
-you need the snapshot of ChibiOS/RT (from trunk).  This means that it
-is covered by GNU GPL.  No "linking exception" option is available for
-the snapshot.
+you need Chopstx as external source code.
 
 
 FAQ
@@ -41,10 +39,8 @@ FAQ
 
 Q0: How NeuG device is good?
 A0: I believe it's good enough if we compare to other hardware RNGs.
-    If its usage is as an entropy source for RNG-tools, or use for
-    computer simulations, I think that it's good enough.  I evaluated
-    it with rngtest of RNG-tools, NIST STS test suite and Dieharder.
-    See the directory neug/test-results/.
+    I evaluated it with rngtest of RNG-tools, NIST STS test suite and
+    Dieharder.  See the directory neug/test-results/.
 A0-dash: For better entropy device with embedded test, you could get
          EntropyKey.  See http://www.entropykey.co.uk/
 A0-double-dash: STM32F2xx and STM32F4xx have built-in TRNG, it would
@@ -52,7 +48,8 @@ A0-double-dash: STM32F2xx and STM32F4xx have built-in TRNG, it would
                 looks not that good).
 
 Q1: How fast is NeuG device?
-A1: It's more than 50 Ki-byte/second.
+A1: It's more than 50 Ki-byte/sec for conditioned output (by SHA-256),
+    and more than 140 Ki-byte/sec for CRC-32 filtered output.
 
 Q2: Should we check condition of noise sources?
 A2: Yes, we should.  Three continuous tests are implemented, following
@@ -62,12 +59,21 @@ A2: Yes, we should.  Three continuous tests are implemented, following
     is really rare, but it could occur even for normal condition), the
     generation of random bits restart again.
 
+Q3: Conditioning with SHA-256 sounds over-kill.  Why not simpler?
+A3: It is because NIST SP 800-90B mandates something like that for
+    "full entropy source".  If your usage is as an entropy source for
+    RNG-tools to feed entropy to your kernel, or use for computer
+    simulations, I think that CRC32 filter would be good enough.  You
+    can configure NeuG device by "stty -F /dev/ttyACM0 parenb parodd"
+    to get raw data before SHA-256 conditioning component.  With
+    high speed hub, you'll get more than 240 Ki-byte/second .
+
 
 Targets
 =======
 
-FST-01, STBee Mini, Olimex STM32-H103, CQ-STARM, and STBee are
-supported.
+FST-01, Olimex STM32-H103, and STM32 part of STM8S Discovery Kit are
+supported.  CQ-STARM, STBee Mini, and STBee will be supported.
 
 
 Souce code
@@ -86,12 +92,13 @@ It is distributed under GNU General Public Licence version 3 or later
 External source code
 ====================
 
-To build NeuG device, we need external source code.
+To build NeuG device, you need external source code.
+
+* chopstx/ -- Chopstx, the RT Thread Library
 
-* chibios/  -- ChibiOS/RT 2.3.x snapshot
+It is available at:
 
-  Please get it from http://chibios.sourceforge.net/
-  We use ChibiOS/RT as the kernel for NeuG device.
+  http://gitorious.org/chopstx/chopstx
 
 
 USB vendor ID and product ID (USB device ID)
@@ -140,7 +147,7 @@ How to compile
 
 You need GNU toolchain and newlib for 'arm-none-eabi' target.
 
-See http://github.com/uwehermann/summon-arm-toolchain/ for preparation
+See https://launchpad.net/gcc-arm-embedded for preparation
 of GNU Toolchain for 'arm-none-eabi' target.
 
 Change directory to `src':
@@ -205,7 +212,8 @@ When you want to get raw output (not conditioned), you can configure:
 
   $ stty -F /dev/ttyACM0 parenb parodd
 
-for raw data after filter.  For direct raw data of samples, configure:
+for raw data after filter.  For direct raw data of ADC samples,
+configure:
 
   $ stty -F /dev/ttyACM0 parenb -parodd
 
@@ -214,8 +222,8 @@ And you can get conditioned output by configuring:
   $ stty -F /dev/ttyACM0 -parenb
 
 
-Structure of the NeuG
-=====================
+Structure of NeuG
+=================
 
 Here is a figure of the circuit.
 
@@ -250,6 +258,7 @@ Here is a figure of the circuit.
                                                       |
                                                       / 32
                                                       |
+                                                      V
                                               [ Entropy Buffer ]
                                                       |          
             +--------------+                          |
@@ -260,7 +269,6 @@ Here is a figure of the circuit.
       +-----|  Hash_df     |
       |     |    by        |
       |     |  SHA-256     |
-      |     |              |
       |     |              |  128
       |     |              |<--/--+
       |     +--------------+      |
@@ -275,7 +283,7 @@ Here is a figure of the circuit.
 
 
 Specifying by "stty", you can get (*3) with -parenb, (*2) with parenb
-parodd, and (*1) with parenb 0parodd.
+parodd, and (*1) with parenb -parodd.
 
 STM32F103 has two built-in A/D converters.  NeuG uses A/D converters'
 outputs as entropy sources.  It is considered noise of quantization
@@ -284,10 +292,10 @@ error, plus noise from power supply, etc.
 We chose four analog input sources of: built-in voltage reference,
 temperature sensor and two analog inputs which are pull-up to Vdd.
 
-By a single sampling of two channel, we get 32-bit (not all 32-bit is
+By a single sampling of two channels, we get 32-bit (not all 32-bit is
 valid, as a A/D converter resolution is 12-bit only).  We take four
-sampling of different combinations: (Vref, IN0), (Temp, IN1), (Vref,
-IN1), and (Temp, IN0).  Those 32-bit * 4 is fed into CRC32 filter.
+sampling of combinations: (Vref, IN0), (Temp, IN1), (Vref, IN1), and
+(Temp, IN0).  Those 32-bit * 4 is fed into CRC32 filter.
 
 We use STM32F103's CRC32 calculation unit as a kind of filter.  We put
 output of A/D converters into CRC32 calculation unit, four times, to
@@ -313,14 +321,16 @@ Test results
 See files under the directory test-results, for test result of
 "rngtest" in rng-tools, NIST STS 2.1.1, and Dieharder.
 
-For Dieharder, I correct 13GiB (it took five days and six hours
-and more), and use scripts to invoke dieharder.
+I collect 110 files of 125MB (= 13750MB), and use scripts to invoke
+dieharder and rngtest.  Collecting 110 files, it took three days.
+
+For NIST STS 2.1.1, I used only 10 files of size 125MB.
 
 
 Read-only Git Repository
 ========================
 
-You can browse at http://www.gniibe.org/gitweb?p=neug.git;a=summary
+You can browse at http://www.gniibe.org/gitweb?p=neug.git
 
 You can get it by:
 
@@ -331,7 +341,7 @@ or
   $ git clone http://www.gniibe.org/git/neug.git/
 
 
-I put ChibiOS/RT as a submodule of Git.  Please do this:
+I put Chopstx as a submodule of Git.  Please do this:
 
   $ git submodule init
   $ git submodule update
@@ -341,7 +351,7 @@ I put ChibiOS/RT as a submodule of Git.  Please do this:
 Information on the Web
 ======================
 
-Not yet.
+Please use FST-01 Q&A Forum at: http://no-passwd.net/askbot/questions/