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. Alphabetic
  2. 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. All

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. macro def asTypeOf[T <: Data](that: T): T
    Definition Classes
    Data
  8. final macro def asUInt(): UInt
    Definition Classes
    Data
  9. def binding: Option[Binding]
    Attributes
    protected[chisel3]
    Definition Classes
    Data
  10. def bindingToString: String
    Attributes
    protected
    Definition Classes
    Data
  11. def binding_=(target: Binding): Unit
    Attributes
    protected
    Definition Classes
    Data
  12. val bits: T

    Some data

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

    True when valid is asserted

    True when valid is asserted

    returns

    a Chisel Bool true if valid is asserted

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

    A bit that will be asserted when bits is valid

  47. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  48. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  49. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  50. final def widthOption: Option[Int]
    Definition Classes
    Data

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated @deprecated
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

  2. def litArg(): Option[LitArg]
    Definition Classes
    Data
    Annotations
    @deprecated
    Deprecated

    (Since version 3.2) litArg is deprecated, use litOption or litTo*Option

  3. final def toNamed: ComponentName
    Definition Classes
    NamedComponent → InstanceId
    Annotations
    @deprecated
    Deprecated

    (Since version 3.2) toNamed API is deprecated -- use toTarget 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

Ungrouped