update fraucheky
[gnuk/neug.git] / README
diff --git a/README b/README
index 6279ebd..470ba9b 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-19
+                                                         Version 1.0.1
+                                                            2015-02-??
                                                           Niibe Yutaka
                                      Free Software Initiative of Japan
 
@@ -28,12 +28,18 @@ 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.
+This is the first minor release of NeuG, after 1.0.
+
 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.
+things like fraucheky (USB Mass Storage Class) support and reGNUal
+(firmware upgrad) support should be considered experimental.
+
+Note that you need Chopstx (the thread library) as external source
+code (instead of ChibiOS/RT).
+
+The "boards" directory is now obsolete, it's for old versions of NeuG
+with ChibiOS/RT.  When you find a board under this directory, it means
+it doesn't work.  We leave them to port new NeuG.
 
 
 FAQ
@@ -41,10 +47,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,22 +56,34 @@ 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
     (Draft of) NIST SP 800-90B.  Those are Repetition Count Test,
     Adaptive Proportion Test (for 64 samples), and another Adaptive
-    Proportion Test (for 4096 samples).  When it detect an error (it
+    Proportion Test (for 4096 samples).  When it detects an error (it
     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 filtered output 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.  Porting to CQ-STARM, STBee Mini, and STBee is not that
+hard.
 
 
 Souce code
@@ -75,6 +91,11 @@ Souce code
 
 NeuG source code is under src/ directory.
 
+Note that SHA-2 hash function implementation, src/sha256.c, is based
+on the original implementation by Dr. Brian Gladman.  See:
+
+  http://gladman.plushost.co.uk/oldsite/cryptography_technology/sha/index.php
+
 
 License
 =======
@@ -86,12 +107,52 @@ 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
+
+* [optional] fraucheky/ -- Fraucheky, the GPL container
+
+It is available at:
+
+  http://gitorious.org/chopstx/chopstx
+
 
-* chibios/  -- ChibiOS/RT 2.3.x snapshot
+USB vendor ID and product ID (USB device ID)
+============================================
 
-  Please get it from http://chibios.sourceforge.net/
-  We use ChibiOS/RT as the kernel for NeuG device.
+When you have a vender ID and assign a product ID for NeuG, edit the
+file NEUG_USB_DEVICE_ID and add an entry for yours.  In this case,
+please contact Niibe, so that it is listed to the file in the official
+release of the source code.
+
+When you are modifing NeuG and installing the binary to device, you
+should replace the vendor string to yours, so that users can see it's
+not by original vendor, and it is modified version.
+
+FSIJ allows you to use USB device ID of FSIJ (234b:0001) for devices
+with standalone NeuG under one of following conditions:
+
+  * For everyone for experimental purpose:
+
+    - You must not distribute a binary with FSIJ's USB device ID, but
+      must use the binary by yourself only for your experiment.  Note
+      that "Distributing binary" includes distributing a device which
+      holds the binary.
+
+  * For individuals:
+
+    - No additional conditions.
+
+FSIJ could give companies or business entities "second source
+manufacturer" license to use USB device ID of FSIJ for devices with
+unmodified version of NeuG, provided they support Free Software and
+respect users' freedom for computing.  Please ask FSIJ for the
+license.
+
+Otherwise, companies which want to distribute NeuG devices, please use
+your own USB vendor ID and product ID.  Please replace vendor string
+and possibly product string to yours, when you modify NeuG.
 
 
 How to compile
@@ -99,7 +160,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':
@@ -108,38 +169,50 @@ Change directory to `src':
 
 Then, run `configure':
 
-  $ ./configure
+  $ ./configure --vidpid=<VID:PID>
+
+Here, you need to specify USB vendor ID and product ID.  For FSIJ's,
+it's: --vidpid=234b:0001 .  Please read section 'USB vendor ID and
+product ID' above.
+
 
 Type:
 
   $ make
 
-Then, we will have "neug.elf".
+Then, we will have "neug.elf" under the "build" directory.
 
 
 How to install
 ==============
 
-STBee Mini and STBee
---------------------
+Olimex STM32-H103 board
+-----------------------
+
+If you are using Olimex JTAG-Tiny, type following to invoke OpenOCD:
+
+  $ openocd -f interface/olimex-jtag-tiny.cfg -f board/olimex_stm32_h103.cfg
 
-Reset the board with "USER" switch pushed.  Type following to write
-to flash:
+Then, with another terminal, type following to write "neug.elf" to Flash ROM:
 
-  # cd ../tool
-  # ./dfuse.py ../src/neug.hex
+  $ telnet localhost 4444
+  > reset halt
+  > flash write_image erase neug.elf
+  > reset
+  > exit
+  $ 
 
-Then, reset the board.
 
+Flying Stone Tiny 01 and STM8S Discovery Kit
+--------------------------------------------
 
-Olimex STM32-H103 board
------------------------
+If you are using Flying Stone Tiny 01, you need a SWD writer.
 
-If you are using Olimex JTAG-Tiny, type following to invoke OpenOCD:
+OpenOCD 0.6.1 or newer supports ST-Link/V2.  With that we can do:
 
-  $ openocd -f interface/olimex-jtag-tiny.cfg -f board/olimex_stm32_h103.cfg
+  $ openocd -f interface/stlink-v2.cfg -f target/stm32f1x_stlink.cfg
 
-Then, with another terminal, type following to write "gnuk.elf" to Flash ROM:
+Then, with another terminal, type following to write "neug.elf" to Flash ROM:
 
   $ telnet localhost 4444
   > reset halt
@@ -148,6 +221,9 @@ Then, with another terminal, type following to write "gnuk.elf" to Flash ROM:
   > exit
   $ 
 
+Note that OpenOCD (as of 0.7.0) doesn't support option bytes handling yet.
+
+You can also use tool/stlinkv2.py in Gnuk.
 
 
 Use of NeuG device
@@ -164,7 +240,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
 
@@ -173,8 +250,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.
 
@@ -209,6 +286,7 @@ Here is a figure of the circuit.
                                                       |
                                                       / 32
                                                       |
+                                                      V
                                               [ Entropy Buffer ]
                                                       |          
             +--------------+                          |
@@ -219,7 +297,6 @@ Here is a figure of the circuit.
       +-----|  Hash_df     |
       |     |    by        |
       |     |  SHA-256     |
-      |     |              |
       |     |              |  128
       |     |              |<--/--+
       |     +--------------+      |
@@ -234,7 +311,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
@@ -243,10 +320,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
@@ -272,25 +349,25 @@ 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
+Git Repository
+==============
 
-You can get it by:
+NeuG is available in the Gnuk repository at Gitorious.org:
 
-  $ git clone git://www.gniibe.org/neug.git/
+    http://gitorious.org/gnuk/neug
 
-or
+You can get it by:
 
-  $ git clone http://www.gniibe.org/git/neug.git/
+    $ git clone git://gitorious.org/gnuk/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
@@ -300,7 +377,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/