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
- Alphabetic
- By Inheritance
Inherited
- Valid
- Bundle
- Record
- Aggregate
- Data
- SourceInfoDoc
- NamedComponent
- HasId
- InstanceId
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- All
Instance Constructors
-
new
Valid(gen: T)
- gen
some data
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
-
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
binding: Option[Binding]
- Attributes
- protected[chisel3]
- Definition Classes
- Data
-
def
bindingToString: String
- Attributes
- protected
- Definition Classes
- Data
-
def
binding_=(target: Binding): Unit
- Attributes
- protected
- Definition Classes
- Data
-
val
bits: T
Some data
-
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( ... ) @native()
-
def
cloneType: Valid.this.type
- Definition Classes
- Valid → 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: ListMap[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
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
def
fire(dummy: Int = 0): Bool
True when
validis assertedTrue when
validis asserted- returns
a Chisel Bool true if
validis asserted
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
getElements: Seq[Data]
- Definition Classes
- Record → Aggregate
-
final
def
getWidth: Int
- Definition Classes
- Data
-
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()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
def
parentModName: String
- Definition Classes
- HasId → InstanceId
-
def
parentPathName: String
- Definition Classes
- HasId → InstanceId
-
def
pathName: String
- Definition Classes
- HasId → InstanceId
-
def
suggestName(name: ⇒ String): Valid.this.type
- Definition Classes
- HasId
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
final
def
toAbsoluteTarget: ReferenceTarget
- 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
A bit that will be asserted when
bitsis valid -
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
widthOption: Option[Int]
- Definition Classes
- Data
Deprecated Value Members
-
def
litArg(): Option[LitArg]
- Definition Classes
- Data
- Annotations
- @deprecated
- Deprecated
(Since version 3.2) litArg is deprecated, use litOption or litTo*Option
-
final
def
toNamed: ComponentName
- Definition Classes
- NamedComponent → InstanceId
- Annotations
- @deprecated
- Deprecated
(Since version 3.2) toNamed API is deprecated -- use toTarget instead
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.