Packages

o

chisel3.experimental

EnumAnnotations

object EnumAnnotations

Source
StrongEnum.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. EnumAnnotations
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. case class EnumComponentAnnotation(target: Named, enumTypeName: String) extends SingleTargetAnnotation[Named] with Product with Serializable

    An annotation for strong enum instances that are not inside of Vecs

    An annotation for strong enum instances that are not inside of Vecs

    target

    the enum instance being annotated

    enumTypeName

    the name of the enum's type (e.g. "mypackage.MyEnum")

  2. case class EnumComponentChiselAnnotation(target: internal.InstanceId, enumTypeName: String) extends ChiselAnnotation with Product with Serializable
  3. case class EnumDefAnnotation(typeName: String, definition: Map[String, BigInt]) extends NoTargetAnnotation with Product with Serializable

    An annotation for enum types (rather than enum instances).

    An annotation for enum types (rather than enum instances).

    typeName

    the name of the enum's type (e.g. "mypackage.MyEnum")

    definition

    a map describing which integer values correspond to which enum names

  4. case class EnumDefChiselAnnotation(typeName: String, definition: Map[String, BigInt]) extends ChiselAnnotation with Product with Serializable
  5. case class EnumVecAnnotation(target: Named, typeName: String, fields: Seq[Seq[String]]) extends SingleTargetAnnotation[Named] with Product with Serializable

    An annotation for Vecs of strong enums.

    An annotation for Vecs of strong enums.

    The fields parameter deserves special attention, since it may be difficult to understand. Suppose you create a the following Vec:

    VecInit(new Bundle {
  val e = MyEnum()
  val b = new Bundle {
    val inner_e = MyEnum()
  }
  val v = Vec(3, MyEnum())
}

    Then, the fields parameter will be: Seq(Seq("e"), Seq("b", "inner_e"), Seq("v")). Note that for any Vec that doesn't contain Bundles, this field will simply be an empty Seq.

    target

    the Vec being annotated

    typeName

    the name of the enum's type (e.g. "mypackage.MyEnum")

    fields

    a list of all chains of elements leading from the Vec instance to its inner enum fields.

  6. case class EnumVecChiselAnnotation(target: internal.InstanceId, typeName: String, fields: Seq[Seq[String]]) extends ChiselAnnotation with Product with Serializable

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 equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped