Packages

c

chisel3.util

DecoupledIO

class DecoupledIO[+T <: Data] extends ReadyValidIO[T]

A concrete subclass of ReadyValidIO signaling that the user expects a "decoupled" interface: 'valid' indicates that the producer has put valid data in 'bits', and 'ready' indicates that the consumer is ready to accept the data this cycle. No requirements are placed on the signaling of ready or valid.

Linear Supertypes
ReadyValidIO[T], core.Bundle, core.Record, core.Aggregate, core.Data, NamedComponent, HasId, internal.InstanceId, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DecoupledIO
  2. ReadyValidIO
  3. Bundle
  4. Record
  5. Aggregate
  6. Data
  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 DecoupledIO(gen: T)

    gen

    the type of data to be wrapped in DecoupledIO

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def :=(that: core.Data)(implicit sourceInfo: SourceInfo, connectionCompileOptions: CompileOptions): Unit
    Definition Classes
    Data
  4. final def <>(that: core.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 <: core.Data](that: T): T

    Does a reinterpret cast of the bits in this node into the format that provides.

    Does a reinterpret cast of the bits in this node into the format that provides. Returns a new Wire of that type. Does not modify existing nodes.

    x.asTypeOf(that) performs the inverse operation of x := that.toBits.

    Definition Classes
    Data
    Note

    that should have known widths

    ,

    bit widths are NOT checked, may pad or drop bits from input

  8. final macro def asUInt(): core.UInt

    Reinterpret cast to UInt.

    Reinterpret cast to UInt.

    Definition Classes
    Data
    Note

    Aggregates are recursively packed with the first element appearing in the least-significant bits of the result.

    ,

    value not guaranteed to be preserved: for example, a SInt of width 3 and value -1 (0b111) would become an UInt with value 7

  9. def binding_=(target: Binding): Unit
    Attributes
    protected
    Definition Classes
    Data
  10. val bits: T
    Definition Classes
    ReadyValidIO
  11. def circuitName: String
    Attributes
    protected
    Definition Classes
    HasId
  12. def className: String

    Name for Pretty Printing

    Name for Pretty Printing

    Definition Classes
    BundleRecord
  13. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  14. def cloneType: DecoupledIO.this.type

    Internal API; Chisel users should look at chisel3.chiselTypeOf(...).

    Internal API; Chisel users should look at chisel3.chiselTypeOf(...).

    cloneType must be defined for any Chisel object extending Data. It is responsible for constructing a basic copy of the object being cloned.

    returns

    a copy of the object.

    Definition Classes
    DecoupledIOBundleData
  15. def do_asTypeOf[T <: core.Data](that: T)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): T
    Definition Classes
    Data
  16. def do_asUInt(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): core.UInt
    Definition Classes
    AggregateData
  17. final lazy val elements: ListMap[String, core.Data]

    The collection of Data

    The collection of Data

    Elements defined earlier in the Bundle are higher order upon serialization. For example:

    Definition Classes
    BundleRecord
    Example:
    1. class MyBundle extends Bundle {
        val foo = UInt(16.W)
        val bar = UInt(16.W)
      }
      // Note that foo is higher order because its defined earlier in the Bundle
      val bundle = Wire(new MyBundle)
      bundle.foo := 0x1234.U
      bundle.bar := 0x5678.U
      val uint = bundle.asUInt
      assert(uint === "h12345678".U) // This will pass
  18. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. def equals(that: Any): Boolean
    Definition Classes
    HasId → AnyRef → Any
  20. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  21. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  22. def getElements: Seq[core.Data]

    Returns a Seq of the immediate contents of this Aggregate, in order.

    Returns a Seq of the immediate contents of this Aggregate, in order.

    Definition Classes
    RecordAggregate
  23. final def getWidth: Int

    Returns the width, in bits, if currently known.

    Returns the width, in bits, if currently known.

    Definition Classes
    Data
    Exceptions thrown

    java.util.NoSuchElementException if the width is not known.

  24. def hashCode(): Int
    Definition Classes
    HasId → AnyRef → Any
  25. def ignoreSeq: Boolean

    Overridden by IgnoreSeqInBundle to allow arbitrary Seqs of Chisel elements.

    Overridden by IgnoreSeqInBundle to allow arbitrary Seqs of Chisel elements.

    Definition Classes
    Bundle
  26. def instanceName: String
    Definition Classes
    HasId → InstanceId
  27. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  28. def isLit(): Boolean
    Definition Classes
    Data
  29. final def isWidthKnown: Boolean

    Returns whether the width is currently known.

    Returns whether the width is currently known.

    Definition Classes
    Data
  30. def litArg(): Option[LitArg]
    Definition Classes
    Data
  31. def litValue(): BigInt
    Definition Classes
    Data
  32. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  33. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  34. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  35. def parentModName: String
    Definition Classes
    HasId → InstanceId
  36. def parentPathName: String
    Definition Classes
    HasId → InstanceId
  37. def pathName: String
    Definition Classes
    HasId → InstanceId
  38. val ready: core.Bool
    Definition Classes
    ReadyValidIO
  39. def suggestName(name: ⇒ String): DecoupledIO.this.type
    Definition Classes
    HasId
  40. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  41. final def toNamed: ComponentName

    Returns a FIRRTL ComponentName that references this object

    Returns a FIRRTL ComponentName that references this object

    Definition Classes
    NamedComponent → InstanceId
    Note

    Should not be called until circuit elaboration is complete

  42. def toPrintable: core.Printable

    Default "pretty-print" implementation Analogous to printing a Map Results in "Bundle(elt0.name -> elt0.value, ...)"

    Default "pretty-print" implementation Analogous to printing a Map Results in "Bundle(elt0.name -> elt0.value, ...)"

    Definition Classes
    BundleRecordData
    Note

    The order is reversed from the order of elements in order to print the fields in the order they were defined

  43. def toString(): String
    Definition Classes
    AnyRef → Any
  44. val valid: core.Bool
    Definition Classes
    ReadyValidIO
  45. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  46. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  47. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  48. final def widthOption: Option[Int]

    Returns Some(width) if the width is known, else None.

    Returns Some(width) if the width is known, else None.

    Definition Classes
    Data

Deprecated Value Members

  1. def toBits(implicit compileOptions: CompileOptions): core.UInt

    Packs the value of this object as plain Bits.

    Packs the value of this object as plain Bits.

    This performs the inverse operation of fromBits(Bits).

    Definition Classes
    Data
    Annotations
    @chiselRuntimeDeprecated() @deprecated
    Deprecated

    (Since version chisel3) Best alternative, .asUInt()

Inherited from ReadyValidIO[T]

Inherited from core.Bundle

Inherited from core.Record

Inherited from core.Aggregate

Inherited from core.Data

Inherited from NamedComponent

Inherited from HasId

Inherited from internal.InstanceId

Inherited from AnyRef

Inherited from Any

Ungrouped