From fa55794c59e8d7d1a29eb76e4c0c175929316457 Mon Sep 17 00:00:00 2001
From: Sagar Karandikar <sagark@eecs.berkeley.edu>
Date: Thu, 16 Jun 2022 02:06:37 +0000
Subject: [PATCH] improvements to minimize diff during tutorials

---
 docs/Generators/SHA3.rst                      |  2 +-
 .../src/main/scala/RocketSha3Configs.scala    | 23 +++++++++++++++++++
 .../src/main/scala/config/RocketConfigs.scala |  7 ------
 .../RocketConfigs.scala.patch                 | 13 -----------
 scripts/tutorial-setup.sh                     |  3 ++-
 5 files changed, 26 insertions(+), 22 deletions(-)
 create mode 100644 generators/chipyard/src/main/scala/RocketSha3Configs.scala
 delete mode 100644 scripts/tutorial-patches/RocketConfigs.scala.patch

diff --git a/docs/Generators/SHA3.rst b/docs/Generators/SHA3.rst
index 9340caae..49e1985c 100644
--- a/docs/Generators/SHA3.rst
+++ b/docs/Generators/SHA3.rst
@@ -72,7 +72,7 @@ it can be mixed into a Rocket or BOOM core by overriding the
 generator. An example configuration highlighting the use of
 this config fragment is shown here:
 
-.. literalinclude:: ../../generators/chipyard/src/main/scala/config/RocketConfigs.scala
+.. literalinclude:: ../../generators/chipyard/src/main/scala/config/RocketSha3Configs.scala
    :language: scala
    :start-after: DOC include start: Sha3Rocket
    :end-before: DOC include end: Sha3Rocket
diff --git a/generators/chipyard/src/main/scala/RocketSha3Configs.scala b/generators/chipyard/src/main/scala/RocketSha3Configs.scala
new file mode 100644
index 00000000..1d6c6632
--- /dev/null
+++ b/generators/chipyard/src/main/scala/RocketSha3Configs.scala
@@ -0,0 +1,23 @@
+package chipyard
+
+import freechips.rocketchip.config.{Config}
+import freechips.rocketchip.diplomacy.{AsynchronousCrossing}
+
+// --------------
+// Rocket+SHA3 Configs
+// These live in a separate file to simplify patching out for the tutorials.
+// --------------
+
+// DOC include start: Sha3Rocket
+class Sha3RocketConfig extends Config(
+  new sha3.WithSha3Accel ++                                // add SHA3 rocc accelerator
+  new freechips.rocketchip.subsystem.WithNBigCores(1) ++
+  new chipyard.config.AbstractConfig)
+// DOC include end: Sha3Rocket
+
+class Sha3RocketPrintfConfig extends Config(
+  new sha3.WithSha3Printf ++
+  new sha3.WithSha3Accel ++                                // add SHA3 rocc accelerator
+  new freechips.rocketchip.subsystem.WithNBigCores(1) ++
+  new chipyard.config.AbstractConfig)
+
diff --git a/generators/chipyard/src/main/scala/config/RocketConfigs.scala b/generators/chipyard/src/main/scala/config/RocketConfigs.scala
index b1719773..0f9b5992 100644
--- a/generators/chipyard/src/main/scala/config/RocketConfigs.scala
+++ b/generators/chipyard/src/main/scala/config/RocketConfigs.scala
@@ -119,13 +119,6 @@ class GB1MemoryRocketConfig extends Config(
   new freechips.rocketchip.subsystem.WithNBigCores(1) ++
   new chipyard.config.AbstractConfig)
 
-// DOC include start: Sha3Rocket
-class Sha3RocketConfig extends Config(
-  new sha3.WithSha3Accel ++                                // add SHA3 rocc accelerator
-  new freechips.rocketchip.subsystem.WithNBigCores(1) ++
-  new chipyard.config.AbstractConfig)
-// DOC include end: Sha3Rocket
-
 // DOC include start: InitZeroRocketConfig
 class InitZeroRocketConfig extends Config(
   new chipyard.example.WithInitZero(0x88000000L, 0x1000L) ++   // add InitZero
diff --git a/scripts/tutorial-patches/RocketConfigs.scala.patch b/scripts/tutorial-patches/RocketConfigs.scala.patch
deleted file mode 100644
index 351f8ca2..00000000
--- a/scripts/tutorial-patches/RocketConfigs.scala.patch
+++ /dev/null
@@ -1,13 +0,0 @@
-diff --git a/generators/chipyard/src/main/scala/config/RocketConfigs.scala b/generators/chipyard/src/main/scala/config/RocketConfigs.scala
-index 8e6e486..fc3a811 100644
---- a/generators/chipyard/src/main/scala/config/RocketConfigs.scala
-+++ b/generators/chipyard/src/main/scala/config/RocketConfigs.scala
-@@ -105,7 +105,7 @@ class GB1MemoryRocketConfig extends Config(
- 
- // DOC include start: Sha3Rocket
- class Sha3RocketConfig extends Config(
--  new sha3.WithSha3Accel ++                                // add SHA3 rocc accelerator
-+//  new sha3.WithSha3Accel ++                                // add SHA3 rocc accelerator
-   new freechips.rocketchip.subsystem.WithNBigCores(1) ++
-   new chipyard.config.AbstractConfig)
- // DOC include end: Sha3Rocket
diff --git a/scripts/tutorial-setup.sh b/scripts/tutorial-setup.sh
index 88843f35..cfa73636 100755
--- a/scripts/tutorial-setup.sh
+++ b/scripts/tutorial-setup.sh
@@ -2,7 +2,8 @@
 
 set -e -x
 
-rm -rf generators/sha3
+git rm generators/chipyard/src/main/scala/config/RocketSha3Configs.scala
+git rm -rf generators/sha3
 
 for p in scripts/tutorial-patches/*.patch
 do