Support for load memory annotations in chisel (#833)

* Support for load memory annotations in chisel
This PR
 * Delays the BlackBoxSourceHelper transformation to the Emitter stage of the VerilogCompiler
   * remove from VerilogCompiler
   * move to VerilogEmitter
 * Changes the verilog emitter to allow programmatic access to the verilog module declaration
   * Creating a bindable module requires headers to match
 * Provides a unit test that shows how to generate a bindable module.

* Binding support
Treadle needed LoadMemoryAnnotation to be in firrtl instead of chisel in order to recognize the annotations and use them for memory loading

* Binding support
- Fixed bug that handled suffixes on memory initializing files

* Binding support
- Add a bit more doc to the API provided by the VerilogRenderer

2 files changed, 61 insertions, 2 deletions

diff --git a/src/test/scala/firrtlTests/VerilogEmitterTests.scala b/src/test/scala/firrtlTests/VerilogEmitterTests.scala
index f4df8519..46f3a711 100644
--- a/src/test/scala/firrtlTests/VerilogEmitterTests.scala
+++ b/src/test/scala/firrtlTests/VerilogEmitterTests.scala
@@ -173,4 +173,63 @@ class VerilogEmitterSpec extends FirrtlFlatSpec {
       result should containLine ("assign out = in;")
     }
   }
+
+  "The verilog emitter" should "offer support for generating bindable forms of modules" in {
+    val emitter = new VerilogEmitter
+    val input =
+      """circuit Test :
+        |  module Test :
+        |    input a : UInt<25000>
+        |    output b : UInt
+        |    input c : UInt<32>
+        |    output d : UInt
+        |    input e : UInt<1>
+        |    input f : Analog<32>
+        |    b <= a
+        |    d <= add(c, e)
+        |""".stripMargin
+    val check =
+      """
+        |module BindsToTest(
+        |  input  [24999:0] a,
+        |  output [24999:0] b,
+        |  input  [31:0]    c,
+        |  output [32:0]    d,
+        |  input            e,
+        |  inout  [31:0]    f
+        |);
+        |
+        |$readmemh("file", memory);
+        |
+        |endmodule""".stripMargin.split("\n")
+
+    // We don't use executeTest because we care about the spacing in the result
+    val writer = new java.io.StringWriter
+
+    val initialState = CircuitState(parse(input), ChirrtlForm)
+    val compiler = new LowFirrtlCompiler()
+
+    val state = compiler.compile(initialState, Seq.empty)
+
+    val moduleMap = state.circuit.modules.map(m => m.name -> m).toMap
+
+    val module = state.circuit.modules.filter(module => module.name == "Test").collectFirst { case m: firrtl.ir.Module => m }.get
+
+    val renderer = emitter.getRenderer(module, moduleMap)(writer)
+
+    renderer.emitVerilogBind("BindsToTest",
+      """
+        |$readmemh("file", memory);
+        |
+        |""".stripMargin)
+    val lines = writer.toString.split("\n")
+
+    val outString = writer.toString
+
+    // This confirms that the module io's were emitted
+    for (c <- check) {
+      lines should contain (c)
+    }
+  }
+
 }
diff --git a/src/test/scala/firrtlTests/transforms/BlacklBoxSourceHelperSpec.scala b/src/test/scala/firrtlTests/transforms/BlacklBoxSourceHelperSpec.scala
index d102378f..455ceb3f 100644
--- a/src/test/scala/firrtlTests/transforms/BlacklBoxSourceHelperSpec.scala
+++ b/src/test/scala/firrtlTests/transforms/BlacklBoxSourceHelperSpec.scala
@@ -4,7 +4,7 @@ package firrtlTests.transforms
 
 import firrtl.annotations.{Annotation, CircuitName, ModuleName}
 import firrtl.transforms._
-import firrtl.{FIRRTLException, Transform, VerilogCompiler}
+import firrtl.{FIRRTLException, Transform, VerilogCompiler, VerilogEmitter}
 import firrtlTests.{HighTransformSpec, LowTransformSpec}
 import org.scalacheck.Test.Failed
 import org.scalatest.{FreeSpec, Matchers, Succeeded}
@@ -63,7 +63,7 @@ class BlacklBoxSourceHelperTransformSpec extends LowTransformSpec {
   }
 
   "verilog compiler" should "have BlackBoxSourceHelper transform" in {
-    val verilogCompiler = new VerilogCompiler
+    val verilogCompiler = new VerilogEmitter
     verilogCompiler.transforms.map { x => x.getClass } should contain (classOf[BlackBoxSourceHelper])
   }
 }