aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJoachim StroĢˆmbergson <joachim@secworks.se>2014-02-25 10:20:02 +0100
committerJoachim StroĢˆmbergson <joachim@secworks.se>2014-02-25 10:20:02 +0100
commit19918044375794d90b9fa7d960b50d1832115c4e (patch)
treec8c531a3e7b901d517cdc6795f85d332fd45cf93
parente242bbecb22b37672427db9956a667ea75a435c9 (diff)
Adding more info about the core.
-rw-r--r--README.md10
1 files changed, 6 insertions, 4 deletions
diff --git a/README.md b/README.md
index d27d280..10150df 100644
--- a/README.md
+++ b/README.md
@@ -25,12 +25,14 @@ The actual core consists of the following files:
- sha256_w_mem.v - W message block memort and expansion logic.
- sha256_k_constants.v - K constants ROM memory.
-The top level entity is called sha256_core.
+The top level entity is called sha256_core. This entity has wide
+interfaces (512 bit block input, 256 bit digest). In order to make it
+usable you probably want to wrap the core with a bus interface.
-Unless you want to provide your own interface you also need to select
-one top level wrapper. There are two wrappers provided:
+Unless you want to provide your own interface you therefore also need to
+select one top level wrapper. There are two wrappers provided:
- sha256.v - A wrapper with a 32-bit memory like interface.
-- wb_sha256.v - A wrapper that implement a [Wishbone](http://opencores.org/opencores,wishbone) interface.
+- wb_sha256.v - A wrapper that implements a [Wishbone](http://opencores.org/opencores,wishbone) interface.
***Do not include both wrappers in the same project.***