Packages

o

firrtl

Driver

object Driver

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

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

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. def dramaticError(message: String): Unit

    print the message in red

    print the message in red

    message

    error message

  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. def execute(args: Array[String]): FirrtlExecutionResult

    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

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

    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

  11. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  13. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. def loadAnnotations(optionsManager: ExecutionOptionsManager with HasFirrtlOptions): Unit

    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

  16. def main(args: Array[String]): Unit
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  20. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  21. def toString(): String
    Definition Classes
    AnyRef → Any
  22. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def compile(input: String, output: String, compiler: Compiler, infoMode: InfoMode = IgnoreInfo, customTransforms: Seq[Transform] = Seq.empty, annotations: AnnotationMap = AnnotationMap(Seq.empty)): String
    Annotations
    @deprecated
    Deprecated

    (Since version firrtl 1.0) Please use execute

Inherited from AnyRef

Inherited from Any

Ungrouped