Support firrtl output in command line for MacroCompiler (#28)

* Use the given port prefix (fix a bug preventing two unit tests from passing)
* Support firrtl output in addition to Verilog

macros/src/main/scala/MacroCompiler.scala

@@ -611,6 +611,7 @@ object MacroCompiler extends App {
   case object Macros extends MacroParam
   case object Library extends MacroParam
   case object Verilog extends MacroParam
+  case object Firrtl extends MacroParam
   case object CostFunc extends MacroParam
   case object Mode extends MacroParam
   type MacroParamMap = Map[MacroParam, String]
@@ -620,6 +621,7 @@ object MacroCompiler extends App {
     "  -m, --macro-list: The set of macros to compile",
     "  -l, --library: The set of macros that have blackbox instances",
     "  -v, --verilog: Verilog output",
+    "  -f, --firrtl: FIRRTL output (optional)",
     "  -c, --cost-func: Cost function to use. Optional (default: \"default\")",
     "  -cp, --cost-param: Cost function parameter. (Optional depending on the cost function.). e.g. -c ExternalMetric -cp path /path/to/my/cost/script",
   """  --mode:
@@ -638,6 +640,8 @@ object MacroCompiler extends App {
         parseArgs(map + (Library -> value), costMap, tail)
       case ("-v" | "--verilog") :: value :: tail =>
         parseArgs(map + (Verilog -> value), costMap, tail)
+      case ("-f" | "--firrtl") :: value :: tail =>
+        parseArgs(map + (Firrtl -> value), costMap, tail)
       case ("-c" | "--cost-func") :: value :: tail =>
         parseArgs(map + (CostFunc -> value), costMap, tail)
       case ("-cp" | "--cost-param") :: value1 :: value2 :: tail =>
@@ -655,9 +659,6 @@ object MacroCompiler extends App {
     try {
       val macros = Utils.filterForSRAM(mdf.macrolib.Utils.readMDFFromPath(params.get(Macros))).get map (x => (new Macro(x)).blackbox)
 
-      // Open the writer for the output Verilog file.
-      val verilogWriter = new FileWriter(new File(params.get(Verilog).get))
-
       if (macros.nonEmpty) {
         // Note: the last macro in the input list is (seemingly arbitrarily)
         // determined as the firrtl "top-level module".
@@ -677,18 +678,39 @@ object MacroCompiler extends App {
         // Run the compiler.
         val result = new MacroCompiler().compileAndEmit(state)
 
-        // Extract Verilog circuit and write it.
+        // Write output FIRRTL file.
-        verilogWriter.write(result.getEmittedCircuit.value)
+        params.get(Firrtl) match {
-      }
+          case Some(firrtlFile: String) => {
+            val fileWriter = new FileWriter(new File(firrtlFile))
+            fileWriter.write(result.circuit.serialize)
+            fileWriter.close()
+          }
+          case None =>
+        }
 
-      // Close the writer.
+        // Write output Verilog file.
-      verilogWriter.close()
+        params.get(Verilog) match {
+          case Some(verilogFile: String) => {
+            // Open the writer for the output Verilog file.
+            val verilogWriter = new FileWriter(new File(verilogFile))
+
+            // Extract Verilog circuit and write it.
+            verilogWriter.write(result.getEmittedCircuit.value)
+
+            // Close the writer.
+            verilogWriter.close()
+          }
+          case None =>
+        }
+      }
     } catch {
       case e: java.util.NoSuchElementException =>
         println(usage)
+        e.printStackTrace()
         sys.exit(1)
       case e: MacroCompilerException =>
-        System.err.println(e.getMessage)
+        println(usage)
+        e.printStackTrace()
         sys.exit(1)
       case e: Throwable =>
         throw e

macros/src/test/scala/MacroCompilerSpec.scala

@@ -335,7 +335,7 @@ s"""
      * @param readEnable Has a read enable port?
      * @param mask Mask granularity (# bits) of the port or None. */
     def generateReadWriteFooterPort(prefix: String, readEnable: Boolean, mask: Option[Int]): String = {
-      generatePort(libPortPrefix, lib_addr_width, libWidth,
+      generatePort(prefix, lib_addr_width, libWidth,
         write=true, writeEnable=true, read=true, readEnable=readEnable, mask)
     }
 
@@ -344,7 +344,7 @@ s"""
      * @param readEnable Has a read enable port?
      * @param mask Mask granularity (# bits) of the port or None. */
     def generateReadWriteHeaderPort(prefix: String, readEnable: Boolean, mask: Option[Int]): String = {
-      generatePort(memPortPrefix, mem_addr_width, memWidth,
+      generatePort(prefix, mem_addr_width, memWidth,
         write=true, writeEnable=true, read=true, readEnable=readEnable, mask)
     }