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: 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: InstanceId, typeName: String, fields: Seq[Seq[String]]) extends ChiselAnnotation with Product with Serializable