From 5d278605f2f398b17e7059a70ccd7420aa555cf8 Mon Sep 17 00:00:00 2001
From: chick
Date: Wed, 24 Feb 2016 22:52:50 -0800
Subject: Create a test that breaks because of assignment statements in DeqIO
 and EnqIO bundles

---
 src/test/scala/chiselTests/VectorPacketIO.scala | 52 +++++++++++++++++++++++++
 1 file changed, 52 insertions(+)
 create mode 100644 src/test/scala/chiselTests/VectorPacketIO.scala

(limited to 'src/test')

diff --git a/src/test/scala/chiselTests/VectorPacketIO.scala b/src/test/scala/chiselTests/VectorPacketIO.scala
new file mode 100644
index 00000000..8f68532e
--- /dev/null
+++ b/src/test/scala/chiselTests/VectorPacketIO.scala
@@ -0,0 +1,52 @@
+// See LICENSE for license details.
+
+package chiselTests
+
+import Chisel._
+import Chisel.testers.BasicTester
+
+/**
+  * This test illustrates the creation of a firrtl file
+  * with missing declarations, the problem is exposed by
+  * the creation of the val outs in VectorPacketIO
+  * NOTE: The problem does not exists if the initialization
+  * code is removed from DeqIO and EnqIO
+  * see: Decoupled.scala lines 29 and 38
+  * valid := Bool(false) and ready := Bool(false)
+  * statements inside a bundle
+  */
+class Packet extends Bundle {
+  val header = UInt(width = 1)
+}
+
+/**
+  * The problem occurs with just the ins or the outs
+  * lines also.
+  * The problem does not occur if the Vec is taken out
+  */
+class VectorPacketIO(n: Int) extends Bundle {
+  val ins  = Vec(n, new DeqIO(new Packet()))
+  val outs = Vec(n, new EnqIO(new Packet()))
+}
+
+/**
+  * a module uses the vector based IO bundle
+  * the value of n does not affect the error
+  */
+class BrokenVectorPacketModule extends Module {
+  val n  = 4
+  val io = new VectorPacketIO(n)
+}
+
+class VectorPacketIOUnitTester extends BasicTester {
+  val device_under_test = Module(new BrokenVectorPacketModule)
+}
+
+class VectorPacketIOUnitTesterSpec extends ChiselFlatSpec {
+  "a circuit using an io containing a vector of EnqIO wrapped packets" should
+    "compile and run" in {
+    assertTesterPasses {
+      new VectorPacketIOUnitTester
+    }
+  }
+}
-- 
cgit v1.2.3


From 3c0a67889280803c22fff441462d06bb5081a558 Mon Sep 17 00:00:00 2001
From: chick
Date: Wed, 24 Feb 2016 23:05:11 -0800
Subject: Remove the assignment statements in EnqIO and DeqIO Bundle
 constructors. Make the corresponding test run faster by giving it a Counter.

---
 src/test/scala/chiselTests/VectorPacketIO.scala | 17 +++++++++++------
 1 file changed, 11 insertions(+), 6 deletions(-)

(limited to 'src/test')

diff --git a/src/test/scala/chiselTests/VectorPacketIO.scala b/src/test/scala/chiselTests/VectorPacketIO.scala
index 8f68532e..5fff6236 100644
--- a/src/test/scala/chiselTests/VectorPacketIO.scala
+++ b/src/test/scala/chiselTests/VectorPacketIO.scala
@@ -6,14 +6,13 @@ import Chisel._
 import Chisel.testers.BasicTester
 
 /**
-  * This test illustrates the creation of a firrtl file
+  * This test used to fail when assignment statements were
+  * contained in DeqIO and EnqIO constructors.
+  * The symptom is creation of a firrtl file
   * with missing declarations, the problem is exposed by
   * the creation of the val outs in VectorPacketIO
-  * NOTE: The problem does not exists if the initialization
-  * code is removed from DeqIO and EnqIO
-  * see: Decoupled.scala lines 29 and 38
-  * valid := Bool(false) and ready := Bool(false)
-  * statements inside a bundle
+  * NOTE: The problem does not exist now because the initialization
+  * code has been removed from DeqIO and EnqIO
   */
 class Packet extends Bundle {
   val header = UInt(width = 1)
@@ -40,6 +39,12 @@ class BrokenVectorPacketModule extends Module {
 
 class VectorPacketIOUnitTester extends BasicTester {
   val device_under_test = Module(new BrokenVectorPacketModule)
+
+  // This counter just makes the test end quicker
+  val c = Counter(1)
+  when(c.inc()) {
+    stop()
+  }
 }
 
 class VectorPacketIOUnitTesterSpec extends ChiselFlatSpec {
-- 
cgit v1.2.3


From 2e4d7869400f121bdae692f5c5b7976b1cb58438 Mon Sep 17 00:00:00 2001
From: chick
Date: Thu, 25 Feb 2016 11:03:15 -0800
Subject: Fixed comment punctuation and made it clearer that using an init()
 method for DeqIO and EnqIO initialization is likely to change.

---
 src/test/scala/chiselTests/VectorPacketIO.scala | 6 ++++++
 1 file changed, 6 insertions(+)

(limited to 'src/test')

diff --git a/src/test/scala/chiselTests/VectorPacketIO.scala b/src/test/scala/chiselTests/VectorPacketIO.scala
index 5fff6236..99ec66a6 100644
--- a/src/test/scala/chiselTests/VectorPacketIO.scala
+++ b/src/test/scala/chiselTests/VectorPacketIO.scala
@@ -11,8 +11,11 @@ import Chisel.testers.BasicTester
   * The symptom is creation of a firrtl file
   * with missing declarations, the problem is exposed by
   * the creation of the val outs in VectorPacketIO
+  *
   * NOTE: The problem does not exist now because the initialization
   * code has been removed from DeqIO and EnqIO
+  *
+  * IMPORTANT:  The canonical way to initialize a decoupled inteface is still being debated.
   */
 class Packet extends Bundle {
   val header = UInt(width = 1)
@@ -35,6 +38,9 @@ class VectorPacketIO(n: Int) extends Bundle {
 class BrokenVectorPacketModule extends Module {
   val n  = 4
   val io = new VectorPacketIO(n)
+
+  /* the following method of initializing the circuit may change in the future */
+  io.outs.foreach(_.init())
 }
 
 class VectorPacketIOUnitTester extends BasicTester {
-- 
cgit v1.2.3