Packages

c

chisel3

EnumType

abstract class EnumType extends Element with EnumTypeIntf

Source
ChiselEnum.scala
Linear Supertypes
EnumTypeIntf, Element, Data, DataIntf, SourceInfoDoc, NamedComponent, HasId, InstanceId, AnyRef, Any
Known Subclasses
Type
Type Hierarchy
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. EnumType
  2. EnumTypeIntf
  3. Element
  4. Data
  5. DataIntf
  6. SourceInfoDoc
  7. NamedComponent
  8. HasId
  9. InstanceId
  10. AnyRef
  11. Any
Implicitly
  1. by AsReadOnly
  2. by DataEquality
  3. by toConnectableDefault
  4. by ConnectableDefault
  5. by any2stringadd
  6. by StringFormat
  7. by Ensuring
  8. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new EnumType(factory: ChiselEnum)
  2. new EnumType(factory: ChiselEnum, selfAnnotating: Boolean)
    Annotations
    @deprecated
    Deprecated

    (Since version Chisel 7.0) ChiselEnum annotations have been removed so selfAnnotating no longer does anything.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from EnumType toany2stringadd[EnumType] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (EnumType, B)
    Implicit
    This member is added by an implicit conversion from EnumType toArrowAssoc[EnumType] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def :#=(producer: DontCare.type)(implicit sourceInfo: SourceInfo): Unit

    The "mono-direction connection operator", aka the "coercion operator".

    The "mono-direction connection operator", aka the "coercion operator".

    For consumer :#= producer, all leaf members of consumer (regardless of relative flip) are driven by the corresponding leaf members of producer (regardless of relative flip)

    Identical to calling :<= and :>=, but swapping consumer/producer for :>= (order is irrelevant), e.g.: consumer :<= producer producer :>= consumer

    Symbol reference:

    • ':' is the consumer side
    • '=' is the producer side
    • '#' means to ignore flips, always drive from producer to consumer

    The following restrictions apply:

    • The Chisel type of consumer and producer must be the "same shape" recursively:
      • All ground types are the same (UInt and UInt are same, SInt and UInt are not), but widths can be different (implicit trunction/padding occurs)
      • All vector types are the same length
      • All bundle types have the same member names, but the flips of members can be different between producer and consumer
    • The leaf members that are ultimately assigned to, must be assignable. This means they cannot be module inputs or instance outputs.

    Additional notes: - Connecting two util.DecoupledIO's would connect bits, valid, AND ready from producer to consumer (despite ready being flipped) - Functionally equivalent to chisel3.:=, but different than Chisel.:=

    producer

    the right-hand-side of the connection, all members will be driving, none will be driven-to

    Implicit
    This member is added by an implicit conversion from EnumType toConnectableDefault[EnumType] performed by method ConnectableDefault in chisel3.Data.
    Definition Classes
    ConnectableOpExtension
  6. final def :#=[S <: Data](producer: connectable.Connectable[S])(implicit evidence: =:=[EnumType, S], sourceInfo: SourceInfo): Unit

    The "mono-direction connection operator", aka the "coercion operator".

    The "mono-direction connection operator", aka the "coercion operator".

    For consumer :#= producer, all leaf members of consumer (regardless of relative flip) are driven by the corresponding leaf members of producer (regardless of relative flip)

    Identical to calling :<= and :>=, but swapping consumer/producer for :>= (order is irrelevant), e.g.: consumer :<= producer producer :>= consumer

    Symbol reference:

    • ':' is the consumer side
    • '=' is the producer side
    • '#' means to ignore flips, always drive from producer to consumer

    The following restrictions apply:

    • The Chisel type of consumer and producer must be the "same shape" recursively:
      • All ground types are the same (UInt and UInt are same, SInt and UInt are not), but widths can be different (implicit trunction/padding occurs)
      • All vector types are the same length
      • All bundle types have the same member names, but the flips of members can be different between producer and consumer
    • The leaf members that are ultimately assigned to, must be assignable. This means they cannot be module inputs or instance outputs.

    Additional notes: - Connecting two util.DecoupledIO's would connect bits, valid, AND ready from producer to consumer (despite ready being flipped) - Functionally equivalent to chisel3.:=, but different than Chisel.:=

    producer

    the right-hand-side of the connection, all members will be driving, none will be driven-to

    Implicit
    This member is added by an implicit conversion from EnumType toConnectableDefault[EnumType] performed by method ConnectableDefault in chisel3.Data.
    Definition Classes
    ConnectableOpExtension
  7. final def :#=[S <: Data](lProducer: => S)(implicit evidence: =:=[EnumType, S], sourceInfo: SourceInfo): Unit

    The "mono-direction connection operator", aka the "coercion operator".

    The "mono-direction connection operator", aka the "coercion operator".

    For consumer :#= producer, all leaf members of consumer (regardless of relative flip) are driven by the corresponding leaf members of producer (regardless of relative flip)

    Identical to calling :<= and :>=, but swapping consumer/producer for :>= (order is irrelevant), e.g.: consumer :<= producer producer :>= consumer

    Symbol reference:

    • ':' is the consumer side
    • '=' is the producer side
    • '#' means to ignore flips, always drive from producer to consumer

    The following restrictions apply:

    • The Chisel type of consumer and producer must be the "same shape" recursively:
      • All ground types are the same (UInt and UInt are same, SInt and UInt are not), but widths can be different (implicit trunction/padding occurs)
      • All vector types are the same length
      • All bundle types have the same member names, but the flips of members can be different between producer and consumer
    • The leaf members that are ultimately assigned to, must be assignable. This means they cannot be module inputs or instance outputs.

    Additional notes: - Connecting two util.DecoupledIO's would connect bits, valid, AND ready from producer to consumer (despite ready being flipped) - Functionally equivalent to chisel3.:=, but different than Chisel.:=

    Implicit
    This member is added by an implicit conversion from EnumType toConnectableDefault[EnumType] performed by method ConnectableDefault in chisel3.Data.
    Definition Classes
    ConnectableOpExtension
  8. final def :<=(producer: DontCare.type)(implicit sourceInfo: SourceInfo): Unit

    The "aligned connection operator" between a producer and consumer.

    The "aligned connection operator" between a producer and consumer.

    For consumer :<= producer, each of consumer's leaf members which are aligned with respect to consumer are driven from the corresponding producer leaf member. Only consumer's leaf/branch alignments influence the connection.

    Symbol reference:

    • ':' is the consumer side
    • '=' is the producer side
    • '<' means to connect from producer to consumer

    The following restrictions apply:

    • The Chisel type of consumer and producer must be the "same shape" recursively:
      • All ground types are the same (UInt and UInt are same, SInt and UInt are not), but widths can be different (implicit trunction/padding occurs)
      • All vector types are the same length
      • All bundle types have the same member names, but the flips of members can be different between producer and consumer
    • The leaf members that are ultimately assigned to, must be assignable. This means they cannot be module inputs or instance outputs.

    Additional notes:

    • Connecting two util.DecoupledIO's would connect bits and valid from producer to consumer, but leave ready unconnected
    producer

    the right-hand-side of the connection; will always drive leaf connections, and never get driven by leaf connections ("aligned connection")

    Implicit
    This member is added by an implicit conversion from EnumType toConnectableDefault[EnumType] performed by method ConnectableDefault in chisel3.Data.
    Definition Classes
    ConnectableOpExtension
  9. final def :<=[S <: Data](producer: connectable.Connectable[S])(implicit evidence: =:=[EnumType, S], sourceInfo: SourceInfo): Unit

    The "aligned connection operator" between a producer and consumer.

    The "aligned connection operator" between a producer and consumer.

    For consumer :<= producer, each of consumer's leaf members which are aligned with respect to consumer are driven from the corresponding producer leaf member. Only consumer's leaf/branch alignments influence the connection.

    Symbol reference:

    • ':' is the consumer side
    • '=' is the producer side
    • '<' means to connect from producer to consumer

    The following restrictions apply:

    • The Chisel type of consumer and producer must be the "same shape" recursively:
      • All ground types are the same (UInt and UInt are same, SInt and UInt are not), but widths can be different (implicit trunction/padding occurs)
      • All vector types are the same length
      • All bundle types have the same member names, but the flips of members can be different between producer and consumer
    • The leaf members that are ultimately assigned to, must be assignable. This means they cannot be module inputs or instance outputs.

    Additional notes:

    • Connecting two util.DecoupledIO's would connect bits and valid from producer to consumer, but leave ready unconnected
    producer

    the right-hand-side of the connection; will always drive leaf connections, and never get driven by leaf connections ("aligned connection")

    Implicit
    This member is added by an implicit conversion from EnumType toConnectableDefault[EnumType] performed by method ConnectableDefault in chisel3.Data.
    Definition Classes
    ConnectableOpExtension
  10. final def :<=[S <: Data](lProducer: => S)(implicit evidence: =:=[EnumType, S], sourceInfo: SourceInfo): Unit

    The "aligned connection operator" between a producer and consumer.

    The "aligned connection operator" between a producer and consumer.

    For consumer :<= producer, each of consumer's leaf members which are aligned with respect to consumer are driven from the corresponding producer leaf member. Only consumer's leaf/branch alignments influence the connection.

    Symbol reference:

    • ':' is the consumer side
    • '=' is the producer side
    • '<' means to connect from producer to consumer

    The following restrictions apply:

    • The Chisel type of consumer and producer must be the "same shape" recursively:
      • All ground types are the same (UInt and UInt are same, SInt and UInt are not), but widths can be different (implicit trunction/padding occurs)
      • All vector types are the same length
      • All bundle types have the same member names, but the flips of members can be different between producer and consumer
    • The leaf members that are ultimately assigned to, must be assignable. This means they cannot be module inputs or instance outputs.

    Additional notes:

    • Connecting two util.DecoupledIO's would connect bits and valid from producer to consumer, but leave ready unconnected
    Implicit
    This member is added by an implicit conversion from EnumType toConnectableDefault[EnumType] performed by method ConnectableDefault in chisel3.Data.
    Definition Classes
    ConnectableOpExtension
  11. final def :<>=(producer: DontCare.type)(implicit sourceInfo: SourceInfo): Unit

    The "bi-direction connection operator", aka the "tur-duck-en operator"

    The "bi-direction connection operator", aka the "tur-duck-en operator"

    For consumer :<>= producer, both producer and consumer leafs could be driving or be driven-to. The consumer's members aligned w.r.t. consumer will be driven by corresponding members of producer; the producer's members flipped w.r.t. producer will be driven by corresponding members of consumer

    Identical to calling :<= and :>= in sequence (order is irrelevant), e.g. consumer :<= producer then consumer :>= producer

    Symbol reference:

    • ':' is the consumer side
    • '=' is the producer side
    • '<' means to connect from producer to consumer
    • '>' means to connect from consumer to producer

    The following restrictions apply:

    • The Chisel type of consumer and producer must be the "same shape" recursively:
      • All ground types are the same (UInt and UInt are same, SInt and UInt are not), but widths can be different (implicit trunction/padding occurs)
      • All vector types are the same length
      • All bundle types have the same member names, but the flips of members can be different between producer and consumer
    • The leaf members that are ultimately assigned to, must be assignable. This means they cannot be module inputs or instance outputs. - An additional type restriction is that all relative orientations of consumer and producer must match exactly.

    Additional notes:

    • Connecting two wires of util.DecoupledIO chisel type would connect bits and valid from producer to consumer, and ready from consumer to producer.
    • If the types of consumer and producer also have identical relative flips, then we can emit FIRRTL.<= as it is a stricter version of chisel3.:<>=
    • "turk-duck-en" is a dish where a turkey is stuffed with a duck, which is stuffed with a chicken; :<>= is a := stuffed with a <>
    producer

    the right-hand-side of the connection

    Implicit
    This member is added by an implicit conversion from EnumType toConnectableDefault[EnumType] performed by method ConnectableDefault in chisel3.Data.
    Definition Classes
    ConnectableOpExtension
  12. final def :<>=[S <: Data](producer: connectable.Connectable[S])(implicit evidence: =:=[EnumType, S], sourceInfo: SourceInfo): Unit

    The "bi-direction connection operator", aka the "tur-duck-en operator"

    The "bi-direction connection operator", aka the "tur-duck-en operator"

    For consumer :<>= producer, both producer and consumer leafs could be driving or be driven-to. The consumer's members aligned w.r.t. consumer will be driven by corresponding members of producer; the producer's members flipped w.r.t. producer will be driven by corresponding members of consumer

    Identical to calling :<= and :>= in sequence (order is irrelevant), e.g. consumer :<= producer then consumer :>= producer

    Symbol reference:

    • ':' is the consumer side
    • '=' is the producer side
    • '<' means to connect from producer to consumer
    • '>' means to connect from consumer to producer

    The following restrictions apply:

    • The Chisel type of consumer and producer must be the "same shape" recursively:
      • All ground types are the same (UInt and UInt are same, SInt and UInt are not), but widths can be different (implicit trunction/padding occurs)
      • All vector types are the same length
      • All bundle types have the same member names, but the flips of members can be different between producer and consumer
    • The leaf members that are ultimately assigned to, must be assignable. This means they cannot be module inputs or instance outputs. - An additional type restriction is that all relative orientations of consumer and producer must match exactly.

    Additional notes:

    • Connecting two wires of util.DecoupledIO chisel type would connect bits and valid from producer to consumer, and ready from consumer to producer.
    • If the types of consumer and producer also have identical relative flips, then we can emit FIRRTL.<= as it is a stricter version of chisel3.:<>=
    • "turk-duck-en" is a dish where a turkey is stuffed with a duck, which is stuffed with a chicken; :<>= is a := stuffed with a <>
    producer

    the right-hand-side of the connection

    Implicit
    This member is added by an implicit conversion from EnumType toConnectableDefault[EnumType] performed by method ConnectableDefault in chisel3.Data.
    Definition Classes
    ConnectableOpExtension
  13. final def :<>=[S <: Data](lProducer: => S)(implicit evidence: =:=[EnumType, S], sourceInfo: SourceInfo): Unit

    The "bi-direction connection operator", aka the "tur-duck-en operator"

    The "bi-direction connection operator", aka the "tur-duck-en operator"

    For consumer :<>= producer, both producer and consumer leafs could be driving or be driven-to. The consumer's members aligned w.r.t. consumer will be driven by corresponding members of producer; the producer's members flipped w.r.t. producer will be driven by corresponding members of consumer

    Identical to calling :<= and :>= in sequence (order is irrelevant), e.g. consumer :<= producer then consumer :>= producer

    Symbol reference:

    • ':' is the consumer side
    • '=' is the producer side
    • '<' means to connect from producer to consumer
    • '>' means to connect from consumer to producer

    The following restrictions apply:

    • The Chisel type of consumer and producer must be the "same shape" recursively:
      • All ground types are the same (UInt and UInt are same, SInt and UInt are not), but widths can be different (implicit trunction/padding occurs)
      • All vector types are the same length
      • All bundle types have the same member names, but the flips of members can be different between producer and consumer
    • The leaf members that are ultimately assigned to, must be assignable. This means they cannot be module inputs or instance outputs. - An additional type restriction is that all relative orientations of consumer and producer must match exactly.

    Additional notes:

    • Connecting two wires of util.DecoupledIO chisel type would connect bits and valid from producer to consumer, and ready from consumer to producer.
    • If the types of consumer and producer also have identical relative flips, then we can emit FIRRTL.<= as it is a stricter version of chisel3.:<>=
    • "turk-duck-en" is a dish where a turkey is stuffed with a duck, which is stuffed with a chicken; :<>= is a := stuffed with a <>
    Implicit
    This member is added by an implicit conversion from EnumType toConnectableDefault[EnumType] performed by method ConnectableDefault in chisel3.Data.
    Definition Classes
    ConnectableOpExtension
  14. final def :=(that: => Data)(implicit sourceInfo: SourceInfo): Unit

    The "strong connect" operator.

    The "strong connect" operator.

    For chisel3._, this operator is mono-directioned; all sub-elements of this will be driven by sub-elements of that.

    • Equivalent to this :#= that

    For Chisel._, this operator connections bi-directionally via emitting the FIRRTL.<=

    • Equivalent to this :<>= that
    that

    the Data to connect from

    Definition Classes
    Data
  15. final def :>=(producer: DontCare.type)(implicit sourceInfo: SourceInfo): Unit

    The "flipped connection operator", or the "backpressure connection operator" between a producer and consumer.

    The "flipped connection operator", or the "backpressure connection operator" between a producer and consumer.

    For consumer :>= producer, each of producer's leaf members which are flipped with respect to producer are driven from the corresponding consumer leaf member Only producer's leaf/branch alignments influence the connection.

    Symbol reference:

    • ':' is the consumer side
    • '=' is the producer side
    • '>' means to connect from consumer to producer

    The following restrictions apply:

    • The Chisel type of consumer and producer must be the "same shape" recursively:
      • All ground types are the same (UInt and UInt are same, SInt and UInt are not), but widths can be different (implicit trunction/padding occurs)
      • All vector types are the same length
      • All bundle types have the same member names, but the flips of members can be different between producer and consumer
    • The leaf members that are ultimately assigned to, must be assignable. This means they cannot be module inputs or instance outputs.

    Additional notes:

    • Connecting two util.DecoupledIO's would connect ready from consumer to producer, but leave bits and valid unconnected
    producer

    the right-hand-side of the connection; will always be driven by leaf connections, and never drive leaf connections ("flipped connection")

    Implicit
    This member is added by an implicit conversion from EnumType toConnectableDefault[EnumType] performed by method ConnectableDefault in chisel3.Data.
    Definition Classes
    ConnectableOpExtension
  16. final def :>=[S <: Data](producer: connectable.Connectable[S])(implicit evidence: =:=[EnumType, S], sourceInfo: SourceInfo): Unit

    The "flipped connection operator", or the "backpressure connection operator" between a producer and consumer.

    The "flipped connection operator", or the "backpressure connection operator" between a producer and consumer.

    For consumer :>= producer, each of producer's leaf members which are flipped with respect to producer are driven from the corresponding consumer leaf member Only producer's leaf/branch alignments influence the connection.

    Symbol reference:

    • ':' is the consumer side
    • '=' is the producer side
    • '>' means to connect from consumer to producer

    The following restrictions apply:

    • The Chisel type of consumer and producer must be the "same shape" recursively:
      • All ground types are the same (UInt and UInt are same, SInt and UInt are not), but widths can be different (implicit trunction/padding occurs)
      • All vector types are the same length
      • All bundle types have the same member names, but the flips of members can be different between producer and consumer
    • The leaf members that are ultimately assigned to, must be assignable. This means they cannot be module inputs or instance outputs.

    Additional notes:

    • Connecting two util.DecoupledIO's would connect ready from consumer to producer, but leave bits and valid unconnected
    producer

    the right-hand-side of the connection; will always be driven by leaf connections, and never drive leaf connections ("flipped connection")

    Implicit
    This member is added by an implicit conversion from EnumType toConnectableDefault[EnumType] performed by method ConnectableDefault in chisel3.Data.
    Definition Classes
    ConnectableOpExtension
  17. final def :>=[S <: Data](lProducer: => S)(implicit evidence: =:=[EnumType, S], sourceInfo: SourceInfo): Unit

    The "flipped connection operator", or the "backpressure connection operator" between a producer and consumer.

    The "flipped connection operator", or the "backpressure connection operator" between a producer and consumer.

    For consumer :>= producer, each of producer's leaf members which are flipped with respect to producer are driven from the corresponding consumer leaf member Only producer's leaf/branch alignments influence the connection.

    Symbol reference:

    • ':' is the consumer side
    • '=' is the producer side
    • '>' means to connect from consumer to producer

    The following restrictions apply:

    • The Chisel type of consumer and producer must be the "same shape" recursively:
      • All ground types are the same (UInt and UInt are same, SInt and UInt are not), but widths can be different (implicit trunction/padding occurs)
      • All vector types are the same length
      • All bundle types have the same member names, but the flips of members can be different between producer and consumer
    • The leaf members that are ultimately assigned to, must be assignable. This means they cannot be module inputs or instance outputs.

    Additional notes:

    • Connecting two util.DecoupledIO's would connect ready from consumer to producer, but leave bits and valid unconnected
    Implicit
    This member is added by an implicit conversion from EnumType toConnectableDefault[EnumType] performed by method ConnectableDefault in chisel3.Data.
    Definition Classes
    ConnectableOpExtension
  18. final macro def <(that: EnumType): Bool
    Definition Classes
    EnumTypeIntf
  19. final macro def <=(that: EnumType): Bool
    Definition Classes
    EnumTypeIntf
  20. final def <>(that: => Data)(implicit sourceInfo: SourceInfo): Unit

    The "bulk connect operator", assigning elements in this Vec from elements in a Vec.

    The "bulk connect operator", assigning elements in this Vec from elements in a Vec.

    For chisel3._, uses the chisel3.internal.BiConnect algorithm; sub-elements of that may end up driving sub-elements of this

    • Complicated semantics, hard to write quickly, will likely be deprecated in the future

    For Chisel._, emits the FIRRTL.<- operator

    • Equivalent to this :<>= that without the restrictions that bundle field names and vector sizes must match
    that

    the Data to connect from

    Definition Classes
    Data
  21. final macro def =/=(that: EnumType): Bool
    Definition Classes
    EnumTypeIntf
  22. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  23. final macro def ===(that: EnumType): Bool
    Definition Classes
    EnumTypeIntf
  24. final macro def >(that: EnumType): Bool
    Definition Classes
    EnumTypeIntf
  25. final macro def >=(that: EnumType): Bool
    Definition Classes
    EnumTypeIntf
  26. def _asTypeOfImpl[T <: Data](that: T)(implicit sourceInfo: SourceInfo): T
    Definition Classes
    EnumType → Data
  27. def _asUIntImpl(implicit sourceInfo: SourceInfo): UInt
    Attributes
    protected
    Definition Classes
    Data
  28. def _fromUInt(that: UInt)(implicit sourceInfo: SourceInfo): Data

    Return a value of this type from a UInt type.

    Return a value of this type from a UInt type. Internal implementation for asTypeOf.

    Protected so that it can be implemented by the external FixedPoint library

    Attributes
    protected
    Definition Classes
    EnumType → Data
  29. def _impl_<(that: EnumType)(implicit sourceInfo: SourceInfo): Bool
    Attributes
    protected
  30. def _impl_<=(that: EnumType)(implicit sourceInfo: SourceInfo): Bool
    Attributes
    protected
  31. def _impl_=/=(that: EnumType)(implicit sourceInfo: SourceInfo): Bool
    Attributes
    protected
  32. def _impl_===(that: EnumType)(implicit sourceInfo: SourceInfo): Bool
    Attributes
    protected
  33. def _impl_>(that: EnumType)(implicit sourceInfo: SourceInfo): Bool
    Attributes
    protected
  34. def _impl_>=(that: EnumType)(implicit sourceInfo: SourceInfo): Bool
    Attributes
    protected
  35. def as[S <: Data](implicit ev: <:<[EnumType, S]): connectable.Connectable[S]

    Static cast to a super type

    Static cast to a super type

    Implicit
    This member is added by an implicit conversion from EnumType toConnectable[EnumType] performed by method toConnectableDefault in chisel3.Data.
    Definition Classes
    Connectable
  36. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  37. macro def asTypeOf[T <: Data](that: T): T

    Does a reinterpret cast of the bits in this node into the format that provides.

    Does a reinterpret cast of the bits in this node into the format that provides. Returns a new Wire of that type. Does not modify existing nodes.

    x.asTypeOf(that) performs the inverse operation of x := that.toBits.

    Definition Classes
    DataIntf
    Note

    bit widths are NOT checked, may pad or drop bits from input

    ,

    that should have known widths

  38. final macro def asUInt: UInt

    Reinterpret cast to UInt.

    Reinterpret cast to UInt.

    Definition Classes
    DataIntf
    Note

    value not guaranteed to be preserved: for example, a SInt of width 3 and value -1 (0b111) would become an UInt with value 7

    ,

    Aggregates are recursively packed with the first element appearing in the least-significant bits of the result.

  39. def autoSeed(name: String): EnumType.this.type

    Takes the last seed suggested.

    Takes the last seed suggested. Multiple calls to this function will take the last given seed, unless this HasId is a module port (see overridden method in Data.scala).

    If the final computed name conflicts with the final name of another signal, the final name may get uniquified by appending a digit at the end of the name.

    Is a lower priority than suggestName, in that regardless of whether autoSeed was called, suggestName will always take precedence if it was called.

    returns

    this object

    Definition Classes
    Data → HasId
  40. val base: EnumType
    Implicit
    This member is added by an implicit conversion from EnumType toConnectable[EnumType] performed by method toConnectableDefault in chisel3.Data.
    Definition Classes
    Connectable
  41. def binding: Option[Binding]
    Attributes
    protected[chisel3]
    Definition Classes
    Data
  42. def binding_=(target: Binding): Unit
    Attributes
    protected
    Definition Classes
    Data
  43. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  44. def cloneType: EnumType.this.type

    Internal API; Chisel users should look at chisel3.chiselTypeOf(...).

    Internal API; Chisel users should look at chisel3.chiselTypeOf(...).

    cloneType must be defined for any Chisel object extending Data. It is responsible for constructing a basic copy of the object being cloned.

    returns

    a copy of the object.

    Definition Classes
    EnumType → Data
  45. def containsAFlipped: Boolean
    Definition Classes
    Element → Data
  46. def do_<(that: EnumType)(implicit sourceInfo: SourceInfo): Bool
    Definition Classes
    EnumTypeIntf
  47. def do_<=(that: EnumType)(implicit sourceInfo: SourceInfo): Bool
    Definition Classes
    EnumTypeIntf
  48. def do_=/=(that: EnumType)(implicit sourceInfo: SourceInfo): Bool
    Definition Classes
    EnumTypeIntf
  49. def do_===(that: EnumType)(implicit sourceInfo: SourceInfo): Bool
    Definition Classes
    EnumTypeIntf
  50. def do_>(that: EnumType)(implicit sourceInfo: SourceInfo): Bool
    Definition Classes
    EnumTypeIntf
  51. def do_>=(that: EnumType)(implicit sourceInfo: SourceInfo): Bool
    Definition Classes
    EnumTypeIntf
  52. def do_asTypeOf[T <: Data](that: T)(implicit sourceInfo: SourceInfo): T

    Definition Classes
    DataIntf
  53. def do_asUInt(implicit sourceInfo: SourceInfo): UInt

    Definition Classes
    DataIntf
  54. def ensuring(cond: (EnumType) => Boolean, msg: => Any): EnumType
    Implicit
    This member is added by an implicit conversion from EnumType toEnsuring[EnumType] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  55. def ensuring(cond: (EnumType) => Boolean): EnumType
    Implicit
    This member is added by an implicit conversion from EnumType toEnsuring[EnumType] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  56. def ensuring(cond: Boolean, msg: => Any): EnumType
    Implicit
    This member is added by an implicit conversion from EnumType toEnsuring[EnumType] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  57. def ensuring(cond: Boolean): EnumType
    Implicit
    This member is added by an implicit conversion from EnumType toEnsuring[EnumType] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  58. def enumTypeName: String
    Attributes
    protected
  59. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  60. def equals(that: Any): Boolean
    Definition Classes
    HasId → AnyRef → Any
  61. def exclude(members: (EnumType) => Data*): connectable.Connectable[EnumType]

    Select members of base to exclude

    Select members of base to exclude

    members

    functions given the base return a member to exclude

    Implicit
    This member is added by an implicit conversion from EnumType toConnectable[EnumType] performed by method toConnectableDefault in chisel3.Data.
    Definition Classes
    Connectable
  62. def exclude: connectable.Connectable[EnumType]

    Adds base to excludes

    Adds base to excludes

    Implicit
    This member is added by an implicit conversion from EnumType toConnectable[EnumType] performed by method toConnectableDefault in chisel3.Data.
    Definition Classes
    Connectable
  63. def excludeAs[S <: Data](members: (EnumType) => Data*)(implicit ev: <:<[EnumType, S]): connectable.Connectable[S]

    Select members of base to exclude and static cast to a new type

    Select members of base to exclude and static cast to a new type

    members

    functions given the base return a member to exclude

    Implicit
    This member is added by an implicit conversion from EnumType toConnectable[EnumType] performed by method toConnectableDefault in chisel3.Data.
    Definition Classes
    Connectable
  64. def excludeEach[S <: Data](pf: PartialFunction[Data, Seq[Data]])(implicit ev: <:<[EnumType, S]): connectable.Connectable[S]

    Programmatically select members of base to exclude and static cast to a new type

    Programmatically select members of base to exclude and static cast to a new type

    Implicit
    This member is added by an implicit conversion from EnumType toConnectable[EnumType] performed by method toConnectableDefault in chisel3.Data.
    Definition Classes
    Connectable
  65. def excludeProbes: connectable.Connectable[EnumType]

    Exclude probes

    Exclude probes

    Implicit
    This member is added by an implicit conversion from EnumType toConnectable[EnumType] performed by method toConnectableDefault in chisel3.Data.
    Definition Classes
    Connectable
  66. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  67. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  68. final def getWidth: Int

    Returns the width, in bits, if currently known.

    Returns the width, in bits, if currently known.

    Definition Classes
    Data
  69. def hasSeed: Boolean

    returns

    Whether either autoName or suggestName has been called

    Definition Classes
    HasId
  70. def hashCode(): Int
    Definition Classes
    HasId → AnyRef → Any
  71. def instanceName: String
    Definition Classes
    HasId → InstanceId
  72. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  73. def isLit: Boolean
    Definition Classes
    Data
  74. final def isOneOf(u1: EnumType, u2: EnumType*)(implicit sourceInfo: SourceInfo): Bool

    Test if this enumeration is equal to any of the values given as arguments

    Test if this enumeration is equal to any of the values given as arguments

    u1

    the first value to look for

    u2

    zero or more additional values to look for

    returns

    a hardware Bool that indicates if this value matches any of the given values

  75. final def isOneOf(s: Seq[EnumType])(implicit sourceInfo: SourceInfo): Bool

    Test if this enumeration is equal to any of the values in a given sequence

    Test if this enumeration is equal to any of the values in a given sequence

    s

    a Seq of enumeration values to look for

    returns

    a hardware Bool that indicates if this value matches any of the given values

  76. def isValid(implicit sourceInfo: SourceInfo): Bool
  77. final def isWidthKnown: Boolean

    Returns whether the width is currently known.

    Returns whether the width is currently known.

    Definition Classes
    Data
  78. def litOption: Option[BigInt]

    If this is a literal that is representable as bits, returns the value as a BigInt.

    If this is a literal that is representable as bits, returns the value as a BigInt. If not a literal, or not representable as bits (for example, is or contains Analog), returns None.

    Definition Classes
    Element → Data
  79. def litValue: BigInt

    Returns the literal value if this is a literal that is representable as bits, otherwise crashes.

    Returns the literal value if this is a literal that is representable as bits, otherwise crashes.

    Definition Classes
    Data
  80. def name: String
    Definition Classes
    Element
  81. def nameContains(s: String)(implicit sourceInfo: SourceInfo): Bool

    Creates circuitry that outputs True iff the Enum is equal to one of the values that has s in its name

    Creates circuitry that outputs True iff the Enum is equal to one of the values that has s in its name

    s

    the substring to search for in the Enum value's name

  82. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  83. def next(implicit sourceInfo: SourceInfo): EnumType.this.type
  84. def notWaivedOrSqueezedOrExcluded: Boolean

    True if no members are waived or squeezed or excluded

    True if no members are waived or squeezed or excluded

    Implicit
    This member is added by an implicit conversion from EnumType toConnectable[EnumType] performed by method toConnectableDefault in chisel3.Data.
    Definition Classes
    Connectable
  85. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  86. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  87. def parentModName: String
    Definition Classes
    HasId → InstanceId
  88. def parentPathName: String
    Definition Classes
    HasId → InstanceId
  89. def pathName: String
    Definition Classes
    HasId → InstanceId
  90. def readOnly(implicit sourceInfo: SourceInfo): EnumType

    Returns a read-only view of this Data

    Returns a read-only view of this Data

    It is illegal to connect to the return value of this method. This Data this method is called on must be a hardware type.

    Implicit
    This member is added by an implicit conversion from EnumType toAsReadOnly[EnumType] performed by method AsReadOnly in chisel3.Data.
    Definition Classes
    AsReadOnly
  91. def squeeze(members: (EnumType) => Data*): connectable.Connectable[EnumType]

    Select members of base to squeeze

    Select members of base to squeeze

    members

    functions given the base return a member to squeeze

    Implicit
    This member is added by an implicit conversion from EnumType toConnectable[EnumType] performed by method toConnectableDefault in chisel3.Data.
    Definition Classes
    Connectable
  92. def squeeze: connectable.Connectable[EnumType]

    Adds base to squeezes

    Adds base to squeezes

    Implicit
    This member is added by an implicit conversion from EnumType toConnectable[EnumType] performed by method toConnectableDefault in chisel3.Data.
    Definition Classes
    Connectable
  93. def squeezeAll: connectable.Connectable[EnumType]

    Squeeze all members of base

    Squeeze all members of base

    Implicit
    This member is added by an implicit conversion from EnumType toConnectable[EnumType] performed by method toConnectableDefault in chisel3.Data.
    Definition Classes
    Connectable
  94. def squeezeAllAs[S <: Data](implicit ev: <:<[EnumType, S]): connectable.Connectable[S]

    Squeeze all members of base and upcast to super type

    Squeeze all members of base and upcast to super type

    Implicit
    This member is added by an implicit conversion from EnumType toConnectable[EnumType] performed by method toConnectableDefault in chisel3.Data.
    Definition Classes
    Connectable
  95. def squeezeEach[S <: Data](pf: PartialFunction[Data, Seq[Data]]): connectable.Connectable[EnumType]

    Programmatically select members of base to squeeze

    Programmatically select members of base to squeeze

    Implicit
    This member is added by an implicit conversion from EnumType toConnectable[EnumType] performed by method toConnectableDefault in chisel3.Data.
    Definition Classes
    Connectable
  96. def suggestName(seed: => String): EnumType.this.type

    Takes the first seed suggested.

    Takes the first seed suggested. Multiple calls to this function will be ignored. If the final computed name conflicts with another name, it may get uniquified by appending a digit at the end.

    Is a higher priority than autoSeed, in that regardless of whether autoSeed was called, suggestName will always take precedence.

    seed

    The seed for the name of this component

    returns

    this object

    Definition Classes
    HasId
  97. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  98. final def toAbsoluteTarget: ReferenceTarget

    Returns a FIRRTL IsMember that refers to the absolute path to this object in the elaborated hardware graph

    Returns a FIRRTL IsMember that refers to the absolute path to this object in the elaborated hardware graph

    Definition Classes
    NamedComponent → InstanceId
  99. final def toNamed: ComponentName

    Returns a FIRRTL ComponentName that references this object

    Returns a FIRRTL ComponentName that references this object

    Definition Classes
    NamedComponent → InstanceId
    Note

    Should not be called until circuit elaboration is complete

  100. def toPrintable: Printable

    Default pretty printing

    Default pretty printing

    Definition Classes
    EnumType → Data
  101. final def toRelativeTarget(root: Option[BaseModule]): ReferenceTarget

    Returns a FIRRTL ReferenceTarget that references this object, relative to an optional root.

    Returns a FIRRTL ReferenceTarget that references this object, relative to an optional root.

    If root is defined, the target is a hierarchical path starting from root.

    If root is not defined, the target is a hierarchical path equivalent to toAbsoluteTarget.

    Definition Classes
    NamedComponent
    Note

    If root is defined, and has not finished elaboration, this must be called within atModuleBodyEnd.

    ,

    The NamedComponent must be a descendant of root, if it is defined.

    ,

    This doesn't have special handling for Views.

  102. final def toRelativeTargetToHierarchy(root: Option[Hierarchy[BaseModule]]): ReferenceTarget

    Returns a FIRRTL ReferenceTarget that references this object, relative to an optional root.

    Returns a FIRRTL ReferenceTarget that references this object, relative to an optional root.

    If root is defined, the target is a hierarchical path starting from root.

    If root is not defined, the target is a hierarchical path equivalent to toAbsoluteTarget.

    Definition Classes
    NamedComponent
    Note

    If root is defined, and has not finished elaboration, this must be called within atModuleBodyEnd.

    ,

    The NamedComponent must be a descendant of root, if it is defined.

    ,

    This doesn't have special handling for Views.

  103. def toString(): String
    Definition Classes
    EnumType → AnyRef → Any
  104. final def toTarget: ReferenceTarget

    Returns a FIRRTL ReferenceTarget that references this object

    Returns a FIRRTL ReferenceTarget that references this object

    Definition Classes
    NamedComponent → InstanceId
    Note

    Should not be called until circuit elaboration is complete

  105. def typeName: String

    A non-ambiguous name of this Data for use in generated Verilog names

    A non-ambiguous name of this Data for use in generated Verilog names

    Definition Classes
    Data
  106. def unsafe: connectable.Connectable[Data]

    Connect to/from all fields regardless of Scala type, squeeze if necessary, and don't error if mismatched members

    Connect to/from all fields regardless of Scala type, squeeze if necessary, and don't error if mismatched members

    Implicit
    This member is added by an implicit conversion from EnumType toConnectable[EnumType] performed by method toConnectableDefault in chisel3.Data.
    Definition Classes
    Connectable
  107. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  108. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  109. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  110. def waive(members: (EnumType) => Data*): connectable.Connectable[EnumType]

    Select members of base to waive

    Select members of base to waive

    members

    functions given the base return a member to waive

    Implicit
    This member is added by an implicit conversion from EnumType toConnectable[EnumType] performed by method toConnectableDefault in chisel3.Data.
    Definition Classes
    Connectable
  111. def waiveAll: connectable.Connectable[EnumType]

    Waive all members of base

    Waive all members of base

    Implicit
    This member is added by an implicit conversion from EnumType toConnectable[EnumType] performed by method toConnectableDefault in chisel3.Data.
    Definition Classes
    Connectable
  112. def waiveAllAs[S <: Data](implicit ev: <:<[EnumType, S]): connectable.Connectable[S]

    Waive all members of base and static cast to a new type

    Waive all members of base and static cast to a new type

    Implicit
    This member is added by an implicit conversion from EnumType toConnectable[EnumType] performed by method toConnectableDefault in chisel3.Data.
    Definition Classes
    Connectable
  113. def waiveAs[S <: Data](members: (EnumType) => Data*)(implicit ev: <:<[EnumType, S]): connectable.Connectable[S]

    Select members of base to waive and static cast to a new type

    Select members of base to waive and static cast to a new type

    members

    functions given the base return a member to waive

    Implicit
    This member is added by an implicit conversion from EnumType toConnectable[EnumType] performed by method toConnectableDefault in chisel3.Data.
    Definition Classes
    Connectable
  114. def waiveEach[S <: Data](pf: PartialFunction[Data, Seq[Data]])(implicit ev: <:<[EnumType, S]): connectable.Connectable[S]

    Programmatically select members of base to waive and static cast to a new type

    Programmatically select members of base to waive and static cast to a new type

    Implicit
    This member is added by an implicit conversion from EnumType toConnectable[EnumType] performed by method toConnectableDefault in chisel3.Data.
    Definition Classes
    Connectable
  115. def width: Width
    Attributes
    protected[chisel3]
    Definition Classes
    EnumType → Data
  116. def widthKnown: Boolean
    Definition Classes
    Element
  117. final def widthOption: Option[Int]

    Returns Some(width) if the width is known, else None.

    Returns Some(width) if the width is known, else None.

    Definition Classes
    Data

Shadowed Implicit Value Members

  1. def ===(rhs: EnumType): Bool

    Dynamic recursive equality operator for generic Data

    Dynamic recursive equality operator for generic Data

    rhs

    a hardware Data to compare lhs to

    returns

    a hardware Bool asserted if lhs is equal to rhs

    Implicit
    This member is added by an implicit conversion from EnumType toDataEquality[EnumType] performed by method DataEquality in chisel3.Data.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (enumType: DataEquality[EnumType]).===(rhs)
    Definition Classes
    DataEquality
    Exceptions thrown

    ChiselException when lhs and rhs are different types during elaboration time

Deprecated Value Members

  1. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from EnumType toStringFormat[EnumType] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  2. def →[B](y: B): (EnumType, B)
    Implicit
    This member is added by an implicit conversion from EnumType toArrowAssoc[EnumType] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from EnumTypeIntf

Inherited from Element

Inherited from Data

Inherited from DataIntf

Inherited from SourceInfoDoc

Inherited from NamedComponent

Inherited from HasId

Inherited from InstanceId

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion AsReadOnly fromEnumType to AsReadOnly[EnumType]

Inherited by implicit conversion DataEquality fromEnumType to DataEquality[EnumType]

Inherited by implicit conversion toConnectableDefault fromEnumType to Connectable[EnumType]

Inherited by implicit conversion ConnectableDefault fromEnumType to ConnectableDefault[EnumType]

Inherited by implicit conversion any2stringadd fromEnumType to any2stringadd[EnumType]

Inherited by implicit conversion StringFormat fromEnumType to StringFormat[EnumType]

Inherited by implicit conversion Ensuring fromEnumType to Ensuring[EnumType]

Inherited by implicit conversion ArrowAssoc fromEnumType to ArrowAssoc[EnumType]

connection

Ungrouped

SourceInfoTransformMacro

These internal methods are not part of the public-facing API!

The equivalent public-facing methods do not have the do_ prefix or have the same name. Use and look at the documentation for those. If you want left shift, use <<, not do_<<. If you want conversion to a Seq of Bools look at the asBools above, not the one below. Users can safely ignore every method in this group!

🐉🐉🐉 Here be dragons... 🐉🐉🐉

These do_X methods are used to enable both implicit passing of SourceInfo while also supporting chained apply methods. In effect all "normal" methods that you, as a user, will use in your designs, are converted to their "hidden", do_*, via macro transformations. Without using macros here, only one of the above wanted behaviors is allowed (implicit passing and chained applies)---the compiler interprets a chained apply as an explicit 'implicit' argument and will throw type errors.

The "normal", public-facing methods then take no SourceInfo. However, a macro transforms this public-facing method into a call to an internal, hidden do_* that takes an explicit SourceInfo by inserting an implicitly[SourceInfo] as the explicit argument.