case class FirrtlExecutionOptions(inputFileNameOverride: String = "", outputFileNameOverride: String = "", compilerName: String = "verilog", infoModeName: String = "append", inferRW: Seq[String] = Seq.empty, firrtlSource: Option[String] = None, customTransforms: Seq[Transform] = List.empty, annotations: List[Annotation] = List.empty, annotationFileNameOverride: String = "", outputAnnotationFileName: String = "", emitOneFilePerModule: Boolean = false, dontCheckCombLoops: Boolean = false, noDCE: Boolean = false, annotationFileNames: List[String] = List.empty, firrtlCircuit: Option[Circuit] = None) extends ComposableOptions with Product with Serializable
The options that firrtl supports in callable component sense
- inputFileNameOverride
default is targetDir/topName.fir
- outputFileNameOverride
default is targetDir/topName.v the .v is based on the compilerName parameter
- compilerName
which compiler to use
- annotations
annotations to pass to compiler
- Annotations
- @deprecated
- Deprecated
(Since version FIRRTL 1.2) Use a FirrtlOptionsView or construct your own view of an AnnotationSeq
- Source
- ExecutionOptionsManager.scala
- Alphabetic
- By Inheritance
- FirrtlExecutionOptions
- Serializable
- Serializable
- Product
- Equals
- ComposableOptions
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
FirrtlExecutionOptions(inputFileNameOverride: String = "", outputFileNameOverride: String = "", compilerName: String = "verilog", infoModeName: String = "append", inferRW: Seq[String] = Seq.empty, firrtlSource: Option[String] = None, customTransforms: Seq[Transform] = List.empty, annotations: List[Annotation] = List.empty, annotationFileNameOverride: String = "", outputAnnotationFileName: String = "", emitOneFilePerModule: Boolean = false, dontCheckCombLoops: Boolean = false, noDCE: Boolean = false, annotationFileNames: List[String] = List.empty, firrtlCircuit: Option[Circuit] = None)
- inputFileNameOverride
default is targetDir/topName.fir
- outputFileNameOverride
default is targetDir/topName.v the .v is based on the compilerName parameter
- compilerName
which compiler to use
- annotations
annotations to pass to compiler
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- val annotationFileNameOverride: String
- val annotationFileNames: List[String]
- val annotations: List[Annotation]
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
- def compiler: Compiler
- val compilerName: String
- val customTransforms: Seq[Transform]
- val dontCheckCombLoops: Boolean
- val emitOneFilePerModule: Boolean
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
- val firrtlCircuit: Option[Circuit]
- val firrtlSource: Option[String]
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
getEmitterAnnos(optionsManager: ExecutionOptionsManager): Seq[Annotation]
Gives annotations based on the output configuration
Gives annotations based on the output configuration
- optionsManager
this is needed to access build function and its common options
- returns
Annotations that will be consumed by emitter Transforms
-
def
getInputFileName(optionsManager: ExecutionOptionsManager): String
Get the name of the input file
Get the name of the input file
- optionsManager
this is needed to access build function and its common options
- returns
a properly constructed input file name
- Note
Does not implicitly add a file extension to the input file
-
def
getOutputConfig(optionsManager: ExecutionOptionsManager): OutputConfig
Get the user-specified OutputConfig
Get the user-specified OutputConfig
- optionsManager
this is needed to access build function and its common options
- returns
the output configuration
-
def
getTargetFile(optionsManager: ExecutionOptionsManager): String
Get the user-specified targetFile assuming OutputConfig is SingleFile
Get the user-specified targetFile assuming OutputConfig is SingleFile
- optionsManager
this is needed to access build function and its common options
- returns
the targetFile as a String
- val inferRW: Seq[String]
- def infoMode: InfoMode
- val infoModeName: String
- val inputFileNameOverride: String
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val noDCE: Boolean
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- val outputAnnotationFileName: String
- val outputFileNameOverride: String
- def outputSuffix: String
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
- def toAnnotations: AnnotationSeq
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
Deprecated Value Members
-
def
getAnnotationFileName(optionsManager: ExecutionOptionsManager): String
build the annotation file name, taking overriding parameters
build the annotation file name, taking overriding parameters
- optionsManager
this is needed to access build function and its common options
- Annotations
- @deprecated
- Deprecated
(Since version FIRRTL 1.1) Use FirrtlOptions.annotationFileNames instead
This is the documentation for Firrtl.