Class

firrtl

VerilogEmitter

Related Doc: package firrtl

Permalink

class VerilogEmitter extends SeqTransform with Emitter

Source
Emitter.scala
Linear Supertypes
Known Subclasses
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. VerilogEmitter
  2. Emitter
  3. SeqTransform
  4. SeqTransformBased
  5. Transform
  6. TransformLike
  7. LazyLogging
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new VerilogEmitter()

    Permalink

Type Members

  1. class VerilogRender extends AnyRef

    Permalink

    Used by getRenderer, it has machinery to produce verilog from IR.

    Used by getRenderer, it has machinery to produce verilog from IR. Making this a class allows access to particular parts of the verilog emission.

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. def AND(e1: WrappedExpression, e2: WrappedExpression): Expression

    Permalink
  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @throws( ... )
  7. def emit(state: CircuitState, writer: Writer): Unit

    Permalink
    Definition Classes
    VerilogEmitterEmitter
  8. def emit(x: Any, top: Int)(implicit w: Writer): Unit

    Permalink
  9. def emit(x: Any)(implicit w: Writer): Unit

    Permalink
  10. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  11. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  12. def execute(state: CircuitState): CircuitState

    Permalink

    Perform the transform, encode renaming with RenameMap, and can delete annotations Called by runTransform.

    Perform the transform, encode renaming with RenameMap, and can delete annotations Called by runTransform.

    state

    Input Firrtl AST

    returns

    A transformed Firrtl AST

    Definition Classes
    VerilogEmitterSeqTransformTransform
  13. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  14. def getRenderer(descriptions: Seq[DescriptionAnnotation], m: Module, moduleMap: Map[String, DefModule])(implicit writer: Writer): VerilogRender

    Permalink

    Gets a reference to a verilog renderer.

    Gets a reference to a verilog renderer. This is used by the current standard verilog emission process but allows access to individual portions, in particular, this function can be used to generate the header for a verilog file without generating anything else.

    descriptions

    comments to be emitted

    m

    the start module

    moduleMap

    a way of finding other modules

    writer

    where rendering will be placed

    returns

    the render reference

  15. def getRenderer(m: Module, moduleMap: Map[String, DefModule])(implicit writer: Writer): VerilogRender

    Permalink

    Gets a reference to a verilog renderer.

    Gets a reference to a verilog renderer. This is used by the current standard verilog emission process but allows access to individual portions, in particular, this function can be used to generate the header for a verilog file without generating anything else.

    m

    the start module

    moduleMap

    a way of finding other modules

    writer

    where rendering will be placed

    returns

    the render reference

  16. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  17. def inputForm: LowForm.type

    Permalink

    The firrtl.CircuitForm that this transform requires to operate on

    The firrtl.CircuitForm that this transform requires to operate on

    Definition Classes
    VerilogEmitterTransform
  18. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  19. val logger: Logger

    Permalink
    Definition Classes
    LazyLogging
  20. def name: String

    Permalink

    A convenience function useful for debugging and error messages

    A convenience function useful for debugging and error messages

    Definition Classes
    TransformTransformLike
  21. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  22. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  23. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  24. def op_stream(doprim: DoPrim): Seq[Any]

    Permalink
  25. def outputForm: LowForm.type

    Permalink

    The firrtl.CircuitForm that this transform outputs

    The firrtl.CircuitForm that this transform outputs

    Definition Classes
    VerilogEmitterTransform
  26. val outputSuffix: String

    Permalink

    An output suffix to use if the output of this Emitter was written to a file

    An output suffix to use if the output of this Emitter was written to a file

    Definition Classes
    VerilogEmitterEmitter
  27. def remove_root(ex: Expression): Expression

    Permalink
  28. final def runTransform(state: CircuitState): CircuitState

    Permalink

    Perform the transform and update annotations.

    Perform the transform and update annotations.

    state

    Input Firrtl AST

    returns

    A transformed Firrtl AST

    Definition Classes
    Transform
  29. def runTransforms(state: CircuitState): CircuitState

    Permalink
    Attributes
    protected
    Definition Classes
    SeqTransformBased
  30. def stringify(tpe: GroundType): String

    Permalink
  31. def stringify(param: Param): String

    Permalink

    Turn Params into Verilog Strings

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

    Permalink
    Definition Classes
    AnyRef
  33. val tab: String

    Permalink
  34. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  35. def transform(state: CircuitState): CircuitState

    Permalink

    A mathematical transform on some type

    A mathematical transform on some type

    returns

    an output object of the same type

    Definition Classes
    TransformTransformLike
  36. def transforms: Seq[Transform]

    Permalink

    Preamble for every emitted Verilog file

    Preamble for every emitted Verilog file

    Definition Classes
    VerilogEmitterSeqTransformBased
  37. def v_print(e: Expression)(implicit w: Writer): Unit

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  39. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  40. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  41. def wref(n: String, t: Type): WRef

    Permalink

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. final def getMyAnnotations(state: CircuitState): Seq[Annotation]

    Permalink

    Convenience method to get annotations relevant to this Transform

    Convenience method to get annotations relevant to this Transform

    state

    The CircuitState form which to extract annotations

    returns

    A collection of annotations

    Definition Classes
    Transform
    Annotations
    @deprecated
    Deprecated

    (Since version 1.1) Just collect the actual Annotation types the transform wants

Inherited from Emitter

Inherited from SeqTransform

Inherited from SeqTransformBased

Inherited from Transform

Inherited from TransformLike[CircuitState]

Inherited from LazyLogging

Inherited from AnyRef

Inherited from Any

Ungrouped