Class/Object

chisel3.util

Valid

Related Docs: object Valid | package util

Permalink

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
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)

    Permalink

    gen

    some data

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def :=(that: ⇒ Data)(implicit sourceInfo: SourceInfo, connectionCompileOptions: CompileOptions): Unit

    Permalink
    Definition Classes
    Data
  4. final def <>(that: ⇒ Data)(implicit sourceInfo: SourceInfo, connectionCompileOptions: CompileOptions): Unit

    Permalink
    Definition Classes
    Data
  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. macro def asTypeOf[T <: Data](that: T): T

    Permalink
    Definition Classes
    Data
  8. final macro def asUInt(): UInt

    Permalink
    Definition Classes
    Data
  9. def autoSeed(name: String): Valid.this.type

    Permalink
    Definition Classes
    Data → HasId
  10. def binding: Option[Binding]

    Permalink
    Attributes
    protected[chisel3]
    Definition Classes
    Data
  11. def bindingToString: String

    Permalink
    Attributes
    protected
    Definition Classes
    Data
  12. def binding_=(target: Binding): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Data
  13. val bits: T

    Permalink

    Some data

  14. def circuitName: String

    Permalink
    Attributes
    protected
    Definition Classes
    HasId
  15. def className: String

    Permalink
    Definition Classes
    Bundle → Record
  16. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  17. def cloneType: Valid.this.type

    Permalink
    Definition Classes
    Valid → Bundle → Data
  18. def computeName(defaultPrefix: Option[String], defaultSeed: Option[String]): Option[String]

    Permalink
    Definition Classes
    HasId
  19. def do_asTypeOf[T <: Data](that: T)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): T

    Permalink
    Definition Classes
    Data
  20. def do_asUInt(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt

    Permalink
    Definition Classes
    Aggregate → Data
  21. final lazy val elements: ListMap[String, Data]

    Permalink
    Definition Classes
    Bundle → Record
  22. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  23. def equals(that: Any): Boolean

    Permalink
    Definition Classes
    HasId → AnyRef → Any
  24. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  25. def fire(dummy: Int = 0): Bool

    Permalink

    True when valid is asserted

    True when valid is asserted

    returns

    a Chisel Bool true if valid is asserted

  26. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  27. def getElements: Seq[Data]

    Permalink
    Definition Classes
    Record → Aggregate
  28. final def getWidth: Int

    Permalink
    Definition Classes
    Data
  29. def hasSeed: Boolean

    Permalink
    Definition Classes
    HasId
  30. def hashCode(): Int

    Permalink
    Definition Classes
    HasId → AnyRef → Any
  31. def ignoreSeq: Boolean

    Permalink
    Definition Classes
    Bundle
  32. def instanceName: String

    Permalink
    Definition Classes
    HasId → InstanceId
  33. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  34. def isLit(): Boolean

    Permalink
    Definition Classes
    Data
  35. final def isWidthKnown: Boolean

    Permalink
    Definition Classes
    Data
  36. def litOption(): Option[BigInt]

    Permalink
    Definition Classes
    Aggregate → Data
  37. def litValue(): BigInt

    Permalink
    Definition Classes
    Data
  38. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  39. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  40. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  41. def parentModName: String

    Permalink
    Definition Classes
    HasId → InstanceId
  42. def parentPathName: String

    Permalink
    Definition Classes
    HasId → InstanceId
  43. def pathName: String

    Permalink
    Definition Classes
    HasId → InstanceId
  44. def suggestName(seed: ⇒ String): Valid.this.type

    Permalink
    Definition Classes
    HasId
  45. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  46. final def toAbsoluteTarget: ReferenceTarget

    Permalink
    Definition Classes
    NamedComponent → InstanceId
  47. final def toNamed: ComponentName

    Permalink
    Definition Classes
    NamedComponent → InstanceId
  48. def toPrintable: Printable

    Permalink
    Definition Classes
    Bundle → Record → Data
  49. def toString(): String

    Permalink
    Definition Classes
    Record → AnyRef → Any
  50. final def toTarget: ReferenceTarget

    Permalink
    Definition Classes
    NamedComponent → InstanceId
  51. val valid: Bool

    Permalink

    A bit that will be asserted when bits is valid

  52. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  53. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  54. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  55. final def widthOption: Option[Int]

    Permalink
    Definition Classes
    Data

Deprecated Value Members

  1. def litArg(): Option[LitArg]

    Permalink
    Definition Classes
    Data
    Annotations
    @deprecated
    Deprecated

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

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