Packages

  • package root

    This is the documentation for Firrtl.

    This is the documentation for Firrtl.

    Definition Classes
    root
  • package firrtl
    Definition Classes
    root
  • object Driver

    The driver provides methods to access the firrtl compiler.

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

    Definition Classes
    firrtl
    Annotations
    @deprecated
    Deprecated

    (Since version 1.2) Use firrtl.stage.FirrtlStage

    Examples: 

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

      2. , 

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

      each approach has its own endearing aspects

    See also

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

    CompilerUtils.mergeTransforms to see how customTransformations are inserted

  • OptionsException
c

firrtl.Driver

OptionsException

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

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. OptionsException
  2. Serializable
  3. Product
  4. Equals
  5. Exception
  6. Throwable
  7. Serializable
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new OptionsException(message: String)

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 addSuppressed(arg0: Throwable): Unit
    Definition Classes
    Throwable
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def fillInStackTrace(): Throwable
    Definition Classes
    Throwable
  9. def getCause(): Throwable
    Definition Classes
    Throwable
  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  11. def getLocalizedMessage(): String
    Definition Classes
    Throwable
  12. def getMessage(): String
    Definition Classes
    Throwable
  13. def getStackTrace(): Array[StackTraceElement]
    Definition Classes
    Throwable
  14. final def getSuppressed(): Array[Throwable]
    Definition Classes
    Throwable
  15. def initCause(arg0: Throwable): Throwable
    Definition Classes
    Throwable
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. val message: String
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. def printStackTrace(arg0: PrintWriter): Unit
    Definition Classes
    Throwable
  22. def printStackTrace(arg0: PrintStream): Unit
    Definition Classes
    Throwable
  23. def printStackTrace(): Unit
    Definition Classes
    Throwable
  24. def setStackTrace(arg0: Array[StackTraceElement]): Unit
    Definition Classes
    Throwable
  25. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  26. def toString(): String
    Definition Classes
    Throwable → AnyRef → Any
  27. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  29. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated @deprecated
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Exception

Inherited from Throwable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped