Class

firrtl

FirrtlExecutionOptions

Related Doc: package firrtl

Permalink

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 1.2) Use a FirrtlOptionsView or construct your own view of an AnnotationSeq

Source
ExecutionOptionsManager.scala
Linear Supertypes
Serializable, Serializable, Product, Equals, ComposableOptions, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FirrtlExecutionOptions
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. ComposableOptions
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. 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)

    Permalink

    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

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. val annotationFileNameOverride: String

    Permalink

  5. val annotationFileNames: List[String]

    Permalink

  6. val annotations: List[Annotation]

    Permalink

    annotations to pass to compiler

  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  8. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @throws( ... )

  9. def compiler: Compiler

    Permalink

  10. val compilerName: String

    Permalink

    which compiler to use

  11. val customTransforms: Seq[Transform]

    Permalink

  12. val dontCheckCombLoops: Boolean

    Permalink

  13. val emitOneFilePerModule: Boolean

    Permalink

  14. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  15. val firrtlCircuit: Option[Circuit]

    Permalink

  16. val firrtlSource: Option[String]

    Permalink

  17. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()

  18. def getEmitterAnnos(optionsManager: ExecutionOptionsManager): Seq[Annotation]

    Permalink

    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

  19. def getInputFileName(optionsManager: ExecutionOptionsManager): String

    Permalink

    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

  20. def getOutputConfig(optionsManager: ExecutionOptionsManager): OutputConfig

    Permalink

    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

  21. def getTargetFile(optionsManager: ExecutionOptionsManager): String

    Permalink

    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

  22. val inferRW: Seq[String]

    Permalink

  23. def infoMode: InfoMode

    Permalink

  24. val infoModeName: String

    Permalink

  25. val inputFileNameOverride: String

    Permalink

    default is targetDir/topName.fir

  26. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  27. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  28. val noDCE: Boolean

    Permalink

  29. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()

  30. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()

  31. val outputAnnotationFileName: String

    Permalink

  32. val outputFileNameOverride: String

    Permalink

    default is targetDir/topName.v the .v is based on the compilerName parameter

  33. def outputSuffix: String

    Permalink

  34. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  35. def toAnnotations: AnnotationSeq

    Permalink

  36. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  37. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  38. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

  2. def getAnnotationFileName(optionsManager: ExecutionOptionsManager): String

    Permalink

    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 1.1) Use FirrtlOptions.annotationFileNames instead

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from ComposableOptions

Inherited from AnyRef

Inherited from Any

Ungrouped