Packages

class Valid[+T <: Data] extends Bundle

A Bundle that adds a valid bit to some data. This indicates that the user expects a "valid" interface between a producer and a consumer. Here, the producer asserts the valid bit when data on the bits line contains valid data. This differs from DecoupledIO or IrrevocableIO as there is no ready line that the consumer can use to put back pressure on the producer.

In most scenarios, the Valid class will not be used directly. Instead, users will create Valid interfaces using the Valid factory.

T

the type of the data

Source
Valid.scala
See also

Valid factory for concrete examples

Linear Supertypes
Bundle, Record, Aggregate, Data, SourceInfoDoc, NamedComponent, HasId, internal.InstanceId, AnyRef, Any
Type Hierarchy
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. Valid
  2. Bundle
  3. Record
  4. Aggregate
  5. Data
  6. SourceInfoDoc
  7. NamedComponent
  8. HasId
  9. InstanceId
  10. AnyRef
  11. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Valid(gen: T)

    gen

    some data

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def :=(that: => Data)(implicit sourceInfo: SourceInfo, connectionCompileOptions: CompileOptions): Unit
    Definition Classes
    Data
  4. final def <>(that: => Data)(implicit sourceInfo: SourceInfo, connectionCompileOptions: CompileOptions): Unit
    Definition Classes
    Data
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def _cloneTypeImpl: Bundle
    Attributes
    protected
    Definition Classes
    Bundle
  7. def _elementsImpl: Iterable[(String, Any)]
    Attributes
    protected
    Definition Classes
    Bundle
  8. def _usingPlugin: Boolean
    Attributes
    protected
    Definition Classes
    Bundle
  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. macro def asTypeOf[T <: Data](that: T): T
    Definition Classes
    Data
  11. final macro def asUInt: UInt
    Definition Classes
    Data
  12. def autoSeed(name: String): Valid.this.type
    Definition Classes
    Data → HasId
  13. def binding: Option[Binding]
    Attributes
    protected[chisel3]
    Definition Classes
    Data
  14. def binding_=(target: Binding): Unit
    Attributes
    protected
    Definition Classes
    Data
  15. val bits: T

    The data to be transferred, qualified by valid

  16. def circuitName: String
    Attributes
    protected
    Definition Classes
    HasId
  17. def className: String
    Definition Classes
    Bundle → Record
  18. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  19. def cloneType: Valid.this.type
    Definition Classes
    Bundle → Data
  20. def do_asTypeOf[T <: Data](that: T)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): T
    Definition Classes
    Data
  21. def do_asUInt(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt
    Definition Classes
    Aggregate → Data
  22. final lazy val elements: SeqMap[String, Data]
    Definition Classes
    Bundle → Record
  23. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. def equals(that: Any): Boolean
    Definition Classes
    HasId → AnyRef → Any
  25. def fire: Bool

    True when valid is asserted

    True when valid is asserted

    returns

    a Chisel Bool true if valid is asserted

  26. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  27. def getElements: Seq[Data]
    Definition Classes
    Record → Aggregate
  28. final def getWidth: Int
    Definition Classes
    Data
  29. def hasSeed: Boolean
    Definition Classes
    HasId
  30. def hashCode(): Int
    Definition Classes
    HasId → AnyRef → Any
  31. def ignoreSeq: Boolean
    Definition Classes
    Bundle
  32. def instanceName: String
    Definition Classes
    HasId → InstanceId
  33. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  34. def isLit: Boolean
    Definition Classes
    Data
  35. final def isWidthKnown: Boolean
    Definition Classes
    Data
  36. def litOption: Option[BigInt]
    Definition Classes
    Aggregate → Data
  37. def litValue: BigInt
    Definition Classes
    Data
  38. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  39. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  40. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  41. def parentModName: String
    Definition Classes
    HasId → InstanceId
  42. def parentPathName: String
    Definition Classes
    HasId → InstanceId
  43. def pathName: String
    Definition Classes
    HasId → InstanceId
  44. def suggestName(seed: => String): Valid.this.type
    Definition Classes
    HasId
  45. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  46. final def toAbsoluteTarget: ReferenceTarget
    Definition Classes
    NamedComponent → InstanceId
  47. final def toNamed: ComponentName
    Definition Classes
    NamedComponent → InstanceId
  48. def toPrintable: Printable
    Definition Classes
    Bundle → Record → Data
  49. def toString(): String
    Definition Classes
    Record → AnyRef → Any
  50. final def toTarget: ReferenceTarget
    Definition Classes
    NamedComponent → InstanceId
  51. val valid: Bool

    A bit that will be asserted when bits is valid

  52. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  53. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  54. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  55. final def widthOption: Option[Int]
    Definition Classes
    Data

Deprecated Value Members

  1. final macro def asUInt(dummy: Int*): UInt
    Definition Classes
    Data
    Annotations
    @deprecated
    Deprecated

    (Since version Chisel 3.5) Calling this function with an empty argument list is invalid in Scala 3. Use the form without parentheses instead

  2. def bindingToString: String
    Attributes
    protected
    Definition Classes
    Data
    Annotations
    @deprecated
    Deprecated

    (Since version Chisel 3.5.0) This was never intended to be visible to user-defined types

  3. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated
  4. def fire(dummy: Int = 0): Bool
    Annotations
    @deprecated
    Deprecated

    (Since version Chisel 3.5) Calling this function with an empty argument list is invalid in Scala 3. Use the form without parentheses instead

  5. def isLit(dummy: Int*): Boolean
    Definition Classes
    Data
    Annotations
    @deprecated
    Deprecated

    (Since version Chisel 3.5) Calling this function with an empty argument list is invalid in Scala 3. Use the form without parentheses instead

  6. def litOption(dummy: Int*): Option[BigInt]
    Definition Classes
    Data
    Annotations
    @deprecated
    Deprecated

    (Since version Chisel 3.5) Calling this function with an empty argument list is invalid in Scala 3. Use the form without parentheses instead

  7. def litValue(dummy: Int*): BigInt
    Definition Classes
    Data
    Annotations
    @deprecated
    Deprecated

    (Since version Chisel 3.5) Calling this function with an empty argument list is invalid in Scala 3. Use the form without parentheses instead

Inherited from Bundle

Inherited from Record

Inherited from Aggregate

Inherited from Data

Inherited from SourceInfoDoc

Inherited from NamedComponent

Inherited from HasId

Inherited from internal.InstanceId

Inherited from AnyRef

Inherited from Any

Signals

The actual hardware fields of the Bundle

Ungrouped