Object

firrtl

Driver

Related Doc: package firrtl

Permalink

object Driver

The driver provides methods to access the firrtl compiler. Invoke the compiler with either a FirrtlExecutionOption

Annotations
@deprecated
Deprecated

(Since version 1.2) Use firrtl.stage.FirrtlStage

Source
Driver.scala
Examples: 

  1. firrtl.Driver.execute(Array("--top-name Dummy --compiler verilog".split(" +"))

    each approach has its own endearing aspects

    2. , 

  2. val optionsManager = new ExecutionOptionsManager("firrtl")
optionsManager.register(
    FirrtlExecutionOptionsKey ->
    new FirrtlExecutionOptions(topName = "Dummy", compilerName = "verilog"))
firrtl.Driver.execute(optionsManager)

    or a series of command line arguments

See also

CompilerUtils.mergeTransforms to see how customTransformations are inserted

firrtlTests/DriverSpec.scala in the test directory for a lot more examples

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Driver
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. case class OptionsException(message: String) extends Exception with Product with Serializable

    Permalink

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. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. def clone(): AnyRef

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

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

    Permalink
    Definition Classes
    AnyRef

  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  8. def execute(args: Array[String]): FirrtlExecutionResult

    Permalink

    this is a wrapper for execute that builds the options from a standard command line args, for example, like strings passed to main()

    this is a wrapper for execute that builds the options from a standard command line args, for example, like strings passed to main()

    args

    an Array of string s containing legal arguments

  9. def execute(optionsManager: ExecutionOptionsManager with HasFirrtlOptions): FirrtlExecutionResult

    Permalink

    Run the firrtl compiler using the provided option

    Run the firrtl compiler using the provided option

    optionsManager

    the desired flags to the compiler

    returns

    a FirrtlExecutionResult indicating success or failure, provide access to emitted data on success for downstream tools as desired

  10. def getAnnotations(optionsManager: ExecutionOptionsManager with HasFirrtlOptions): Seq[Annotation]

    Permalink

    Get annotations from specified files and options

    Get annotations from specified files and options

    optionsManager

    use optionsManager config to load annotation files

    returns

    Annotations read from files

  11. def getCircuit(optionsManager: ExecutionOptionsManager with HasFirrtlOptions): Try[Circuit]

    Permalink

    Get the Circuit from the compile options

    Get the Circuit from the compile options

    Handles the myriad of ways it can be specified

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

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()

  13. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()

  14. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  15. def main(args: Array[String]): Unit

    Permalink

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

    Permalink
    Definition Classes
    AnyRef

  17. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()

  18. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()

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

    Permalink
    Definition Classes
    AnyRef

  20. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

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

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

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

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

  23. final def wait(): Unit

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

Deprecated Value Members

  1. def dramaticError(message: String): Unit

    Permalink

    print the message in red

    print the message in red

    message

    error message

    Annotations
    @deprecated
    Deprecated

    (Since version 1.2) Use firrtl.options.StageUtils.dramaticWarning

  2. def dramaticWarning(message: String): Unit

    Permalink

    Print a warning message

    Print a warning message

    message

    error message

    Annotations
    @deprecated
    Deprecated

    (Since version 1.2) Use firrtl.options.StageUtils.dramaticWarning

  3. 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.

  4. def loadAnnotations(optionsManager: ExecutionOptionsManager with HasFirrtlOptions): Unit

    Permalink

    Load annotation file based on options

    Load annotation file based on options

    optionsManager

    use optionsManager config to load annotation file if it exists update the firrtlOptions with new annotations if it does

    Annotations
    @deprecated
    Deprecated

    (Since version 1.1) Use side-effect free getAnnotation instead

Inherited from AnyRef

Inherited from Any

Ungrouped