Adding readme and license file.

2 files changed, 50 insertions, 0 deletions

diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..8d0d6ec
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,24 @@
+Author: Joachim Strömbergson
+Copyright (c) 2014, SUNET
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..752b39f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+novena_trng
+============
+This is an experimental HW system for the Novena platform.
+
+The purpose of the system is to debug, evaluate and qualify the
+Cryptech True Random Number Generator (TRNG) on the Novena platform with
+the Xilinx Spartan-6 FPGA. The entropy providers being tested are the noise
+based entropy provider and the ring oscillator based entropy provider.
+
+The following cores are used in the system:
+  - core/coretest, the test command parser
+
+  - core/i2c, the serial interface that connects the system to the
+    Novena CPU.
+
+  - core/avalanche_entropy, the entropy provider that is driven by an
+    external noise source.
+
+  - core/rosc_entropy, the entropy provider driven by jitter between 32
+  independently running ring oscillators in the FPGA.
+
+  - core/trng, the cryptech random number generator. This core uses the
+    ChaCha stream cipher core in core/chacha, the SHA-512 hash function
+    core in core/sha512
+
+Test SW is available in src/sw