commit 9c425d8e37ffac6f761b5253b28c41da8901255d
author Konrad Rzeszutek Wilk <konrad@kernel.org> Wed Jun 09 21:00:56 2021 -0400
committer Konrad Rzeszutek Wilk <konrad@kernel.org> Thu Jun 10 18:53:14 2021 +0200
tree 932b16673524ed226af0edfd4b2a9f7aa786efc3
parent 2b9b8493e3b6a179af42f702d1df7d58daefdff9

info.yaml/README.md: Fill in the details

Signed-off-by: Konrad Rzeszutek Wilk <konrad@kernel.org>

README.md

diff --git a/README.md b/README.md
index 3706438..d279ce5 100644
--- a/README.md
+++ b/README.md
@@ -2,10 +2,27 @@
 
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) [![UPRJ_CI](https://github.com/efabless/caravel_project_example/actions/workflows/user_project_ci.yml/badge.svg)](https://github.com/efabless/caravel_project_example/actions/workflows/user_project_ci.yml) [![Caravel Build](https://github.com/efabless/caravel_project_example/actions/workflows/caravel_build.yml/badge.svg)](https://github.com/efabless/caravel_project_example/actions/workflows/caravel_build.yml)
 
-| :exclamation: Important Note            |
-|-----------------------------------------|
 
-## Please fill in your project documentation in this README.md file 
+# SHA-1 engine
 
+See a [https://github.com/konradwilk/sha1](https://github.com/konradwilk/sha1) for the full git history of this code. Branch name is submission-mpw-two-c.
 
-Refer to [README](docs/source/index.rst) for this sample project documentation. 
+This is an implementation of [https://www.rfc-editor.org/rfc/inline-errata/rfc3174.html](RFC 3174) of SHA-1 engine.
+
+It is not the most secure one nowadays (it is still used for git commit ids and TPM PCR values), but
+it looked like the easiest of the SHA engines to implement. The communication channel is via
+WishBone commands to provide sixteen words after which the engine starts and computes the digest
+in about 160 cycles. Then digest can be retrieved via the wishbone. There is a IRQ line so when
+it has completed it will bring it high if that is enabled.
+
+![SHA1](pics/sha1.png)
+
+If you want to see this more interactively, I would recommend you clone
+[https://github.com/konradwilk/sha1](https://github.com/konradwilk/sha1) and run
+
+```
+make test_wb_logic
+```
+
+which will use the various WishBone commands to program it.
+

info.yaml

diff --git a/info.yaml b/info.yaml
index bdd53ba..7a88af3 100644
--- a/info.yaml
+++ b/info.yaml
@@ -1,11 +1,11 @@
 ---
 project:
-  description: "A template SoC for Google sponsored Open MPW shuttles for SKY130."
+  description: "A SHA-1 engine using WishBone to calculate digest."
   foundry: "SkyWater"
-  git_url: "https://github.com/efabless/caravel_project_example.git"
-  organization: "Efabless"
-  organization_url: "http://efabless.com"
-  owner: "Tim Edwards"
+  git_url: "https://github.com/konradwilk/sha1"
+  organization: ""
+  organization_url: "http://darnok.org"
+  owner: "Konrad Rzeszutek Wilk"
   process: "SKY130"
   project_name: "Caravel"
   project_id: "00000000"
@@ -16,4 +16,4 @@
   top_level_netlist: "caravel/verilog/gl/caravel.v"
   user_level_netlist: "verilog/gl/user_project_wrapper.v"
   version: "1.00"
-  cover_image: "docs/source/_static/caravel_harness.png"
+  cover_image: "pics/sha1.png"

pics/sha1.png

diff --git a/pics/sha1.png b/pics/sha1.png
new file mode 100644
index 0000000..44635e1
--- /dev/null
+++ b/pics/sha1.png
Binary files differ