Packages

  • package root

    This is the documentation for Firrtl.

    This is the documentation for Firrtl.

    Definition Classes
    root
  • package firrtl
    Definition Classes
    root
  • package stage

    The stage package provides an implementation of the FIRRTL compiler using the firrtl.options package.

    The stage package provides an implementation of the FIRRTL compiler using the firrtl.options package. This primarily consists of:

    Definition Classes
    firrtl
  • package phases
    Definition Classes
    stage
  • object DriverCompatibility

    Provides compatibility methods to replicate deprecated Driver semantics.

    Provides compatibility methods to replicate deprecated Driver semantics.

    At a high level, the Driver tries extremely hard to figure out what the user meant and to enable them to not be explicit with command line options. As an example, the --top-name option is not used for any FIRRTL top module determination, but to find a FIRRTL file by that name and/or an annotation file by that name. This mode of file discovery is only used if no explicit FIRRTL file/source/circuit and/or annotation file is given. Going further, the --top-name argument is implicitly specified by the main of an input circuit if not explicit and can be used to derive an annotation file. Summarily, the Phases provided by this enable this type of resolution.

    Only use these methods if you are intending to replicate old Driver semantics for a good reason. Otherwise, opt for more explicit specification by the user.

    Definition Classes
    phases
  • AddImplicitAnnotationFile
  • AddImplicitEmitter
  • AddImplicitFirrtlFile
  • AddImplicitOutputFile
  • EmitOneFilePerModuleAnnotation
  • TopNameAnnotation

case class TopNameAnnotation(topName: String) extends NoTargetAnnotation with Product with Serializable

Holds the name of the top (main) module in an input circuit

Annotations
@deprecated
Deprecated

(Since version 1.2) "top-name" is deprecated as part of the Stage/Phase refactor. Use explicit input/output files.

Source
DriverCompatibility.scala
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TopNameAnnotation
  2. Serializable
  3. Serializable
  4. NoTargetAnnotation
  5. Annotation
  6. Product
  7. Equals
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new TopNameAnnotation(topName: 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 asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  8. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  9. def getTargets: Seq[Target]

    Returns all Target members in this annotation

    Returns all Target members in this annotation

    Definition Classes
    NoTargetAnnotationAnnotation
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. def serialize: String

    Optional pretty print

    Optional pretty print

    Definition Classes
    Annotation
    Note

    rarely used

  15. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  16. val topName: String
  17. def update(renames: RenameMap): Seq[NoTargetAnnotation]

    Update the target based on how signals are renamed

    Update the target based on how signals are renamed

    Definition Classes
    NoTargetAnnotationAnnotation
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from Serializable

Inherited from Serializable

Inherited from NoTargetAnnotation

Inherited from Annotation

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped