abstract class ReadyValidIO[+T <: Data] extends Bundle
An I/O Bundle containing 'valid' and 'ready' signals that handshake the transfer of data stored in the 'bits' subfield. The base protocol implied by the directionality is that the producer uses the interface as-is (outputs bits) while the consumer uses the flipped interface (inputs bits). The actual semantics of ready/valid are enforced via the use of concrete subclasses.
- Source
- Decoupled.scala
- Grouped
- Alphabetic
- By Inheritance
- ReadyValidIO
- Bundle
- Record
- Aggregate
- Data
- SourceInfoDoc
- NamedComponent
- HasId
- InstanceId
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new ReadyValidIO(gen: T)
- gen
the type of data to be wrapped in Ready/Valid
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def :=(that: => Data)(implicit sourceInfo: SourceInfo, connectionCompileOptions: CompileOptions): Unit
- Definition Classes
- Data
- final def <>(that: => Data)(implicit sourceInfo: SourceInfo, connectionCompileOptions: CompileOptions): Unit
- Definition Classes
- Data
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def _cloneTypeImpl: Bundle
- Attributes
- protected
- Definition Classes
- Bundle
- def _elementsImpl: Iterable[(String, Any)]
- Attributes
- protected
- Definition Classes
- Bundle
- def _usingPlugin: Boolean
- Attributes
- protected
- Definition Classes
- Bundle
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- macro def asTypeOf[T <: Data](that: T): T
- Definition Classes
- Data
- final macro def asUInt: UInt
- Definition Classes
- Data
- def autoSeed(name: String): ReadyValidIO.this.type
- Definition Classes
- Data → HasId
- def binding: Option[Binding]
- Attributes
- protected[chisel3]
- Definition Classes
- Data
- def binding_=(target: Binding): Unit
- Attributes
- protected
- Definition Classes
- Data
- val bits: T
The data to be transferred when ready and valid are asserted at the same cycle
- def circuitName: String
- Attributes
- protected
- Definition Classes
- HasId
- def className: String
- Definition Classes
- Bundle → Record
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- def cloneType: ReadyValidIO.this.type
- Definition Classes
- Bundle → Data
- def do_asTypeOf[T <: Data](that: T)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): T
- Definition Classes
- Data
- def do_asUInt(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): UInt
- Definition Classes
- Aggregate → Data
- final lazy val elements: SeqMap[String, Data]
- Definition Classes
- Bundle → Record
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(that: Any): Boolean
- Definition Classes
- HasId → AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def getElements: Seq[Data]
- Definition Classes
- Record → Aggregate
- final def getWidth: Int
- Definition Classes
- Data
- def hasSeed: Boolean
- Definition Classes
- HasId
- def hashCode(): Int
- Definition Classes
- HasId → AnyRef → Any
- def ignoreSeq: Boolean
- Definition Classes
- Bundle
- def instanceName: String
- Definition Classes
- HasId → InstanceId
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isLit: Boolean
- Definition Classes
- Data
- final def isWidthKnown: Boolean
- Definition Classes
- Data
- def litOption: Option[BigInt]
- Definition Classes
- Aggregate → Data
- def litValue: BigInt
- Definition Classes
- Data
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def parentModName: String
- Definition Classes
- HasId → InstanceId
- def parentPathName: String
- Definition Classes
- HasId → InstanceId
- def pathName: String
- Definition Classes
- HasId → InstanceId
- val ready: Bool
Indicates that the consumer is ready to accept the data this cycle
- def suggestName(seed: => String): ReadyValidIO.this.type
- Definition Classes
- HasId
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- final def toAbsoluteTarget: ReferenceTarget
- Definition Classes
- NamedComponent → InstanceId
- final def toNamed: ComponentName
- Definition Classes
- NamedComponent → InstanceId
- def toPrintable: Printable
- Definition Classes
- Bundle → Record → Data
- def toString(): String
- Definition Classes
- Record → AnyRef → Any
- final def toTarget: ReferenceTarget
- Definition Classes
- NamedComponent → InstanceId
- val valid: Bool
Indicates that the producer has put valid data in 'bits'
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def widthOption: Option[Int]
- Definition Classes
- Data
Deprecated Value Members
- 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
- 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
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
- 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
- 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
- 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
This is the documentation for Chisel.
Package structure
The chisel3 package presents the public API of Chisel. It contains the concrete core types
UInt,SInt,Bool,FixedPoint,Clock, andReg, the abstract typesBits,Aggregate, andData, and the aggregate typesBundleandVec.The Chisel package is a compatibility layer that attempts to provide chisel2 compatibility in chisel3.
Utility objects and methods are found in the
utilpackage.The
testerspackage defines the basic interface for chisel testers.