Packages

c

firrtl.transforms

CustomRadixConfigFileAnnotation

case class CustomRadixConfigFileAnnotation(signals: Seq[(String, Seq[String])], filters: Seq[CustomRadixDefAnnotation]) extends NoTargetAnnotation with CustomFileEmission with Product with Serializable

Dumps a JSON config file for custom radix. Users can generate script using the emitted file.

signals

which alias contains which signals, the signals should be converted from ReferenceTarget to String

filters

sequence of CustomRadixDefAnnotation, the name should match signals.map(_._1)

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

Instance Constructors

  1. new CustomRadixConfigFileAnnotation(signals: Seq[(String, Seq[String])], filters: Seq[CustomRadixDefAnnotation])

    signals

    which alias contains which signals, the signals should be converted from ReferenceTarget to String

    filters

    sequence of CustomRadixDefAnnotation, the name should match signals.map(_._1)

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 baseFileName(annotations: AnnotationSeq): String

    Output filename where serialized content will be written

    Output filename where serialized content will be written

    The full annotation sequence is a parameter to allow for the location where this annotation will be serialized to be a function of other annotations, e.g., if the location where information is written is controlled by a separate file location annotation.

    annotations

    the annotation sequence at the time of emission

    Definition Classes
    CustomRadixConfigFileAnnotationCustomFileEmission
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. final def filename(annotations: AnnotationSeq): File

    Method that returns the filename where this annotation will be serialized.

    Method that returns the filename where this annotation will be serialized.

    annotations

    the annotations at the time of serialization

    Definition Classes
    CustomFileEmission
  9. val filters: Seq[CustomRadixDefAnnotation]
  10. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. def getBytes: Iterable[Byte]

    A method that can convert this annotation to bytes that will be written to a file.

    A method that can convert this annotation to bytes that will be written to a file.

    If you only need to serialize a string, you can use the getBytes method:

    def getBytes: Iterable[Byte] = myString.getBytes
    Definition Classes
    CustomRadixConfigFileAnnotationCustomFileEmission
  12. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. def getTargets: Seq[Target]

    Returns all Target members in this annotation

    Returns all Target members in this annotation

    Definition Classes
    NoTargetAnnotationAnnotation
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. def replacements(file: File): AnnotationSeq

    Optionally, a sequence of annotations that will replace this annotation in the output annotation file.

    Optionally, a sequence of annotations that will replace this annotation in the output annotation file.

    A non-empty implementation of this method is a mechanism for telling a downstream Stage how to deserialize the information that was serialized to a separate file. For example, if a FIRRTL circuit is serialized to a separate file, this method could include an input file annotation that a later stage can use to read the serialized FIRRTL circuit back in.

    Definition Classes
    CustomFileEmission
  19. def serialize: String

    Optional pretty print

    Optional pretty print

    Definition Classes
    Annotation
    Note

    rarely used

  20. val signals: Seq[(String, Seq[String])]
  21. def suffix: Option[String]

    Optional suffix of the output file

    Optional suffix of the output file

    Definition Classes
    CustomRadixConfigFileAnnotationCustomFileEmission
  22. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  23. 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
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  27. def waveViewer: String

Inherited from Serializable

Inherited from Serializable

Inherited from CustomFileEmission

Inherited from NoTargetAnnotation

Inherited from Annotation

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped