Class

Chisel

DecoupledIO

Related Doc: package Chisel

Permalink

class DecoupledIO[+T <: Data] extends Bundle

An I/O Bundle with simple handshaking using valid and ready signals for data 'bits'

Source
ChiselUtil.scala
Example:
  1.  val io = Decoupled(UInt(width=4))
    io.valid := io.ready
    io.bits := UInt(5)
Note

can be created using Decoupled

Linear Supertypes
Bundle, Aggregate, Data, Node, Nameable, AnyRef, Any
Known Subclasses
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DecoupledIO
  2. Bundle
  3. Aggregate
  4. Data
  5. Node
  6. Nameable
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new DecoupledIO(gen: T)

    Permalink

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. def ##[T <: Data](right: T): DecoupledIO.this.type

    Permalink

    Interface required by Cat is an operator to combine data nodes together

    Interface required by Cat is an operator to combine data nodes together

    Definition Classes
    Data
  3. def ##(b: Node): Node

    Permalink

    The cat operator to combine two values

    The cat operator to combine two values

    0x5 ## 0x3 => 0x53
    b

    Node to cat after

    returns

    a new node as the combination of both this node and b

    Definition Classes
    Node
  4. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  5. def +(other: Bundle): Bundle

    Permalink

    Create a new Bundle with all the elements of both

    Create a new Bundle with all the elements of both

    Definition Classes
    Bundle
  6. def :=(that: Data): Unit

    Permalink
    Definition Classes
    Data
  7. def <>(src: Node): Unit

    Permalink

    Connect all elements contained in this to node 'src'

    Connect all elements contained in this to node 'src'

    Definition Classes
    BundleNode
    Example:
    1.  // pass through all wires in this modules io to the sub module which have the same name
      // Note: ignores any extra defined in io
      mySubModule.io <> io
    Note

    The elements are checked for compatibility based on their name If elements are in src that are not in this Bundle no warning will be produced

  8. def =/=[T <: Data](right: T): Bool

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

    Permalink
    Definition Classes
    AnyRef → Any
  10. def ===[T <: Data](right: T): Bool

    Permalink
    Definition Classes
    Data
  11. def W0Wtransform(): Unit

    Permalink

    Eliminate any zero-width wires attached to this node

    Eliminate any zero-width wires attached to this node

    returns

    if the node was modified

    Definition Classes
    Node
  12. def ^^(src: Node): Unit

    Permalink
    Definition Classes
    Node
  13. val _id: Int

    Permalink

    The unique id of this node

    The unique id of this node

    Definition Classes
    Node
  14. def _isComplementOf(x: Node): Boolean

    Permalink
    Definition Classes
    Node
  15. def apply(name: String): Data

    Permalink
    Definition Classes
    BundleData
  16. def asDirectionless(): DecoupledIO.this.type

    Permalink

    set this node as directionless

    set this node as directionless

    Definition Classes
    BundleData
  17. def asInput(): DecoupledIO.this.type

    Permalink

    Return this object as an INPUT

    Return this object as an INPUT

    Definition Classes
    BundleData
  18. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  19. def asOutput(): DecoupledIO.this.type

    Permalink

    Sets the direction (*dir*) of instances derived from Bits to OUTPUT or recursively sets members of Bundle/Vec to OUTPUT.

    Sets the direction (*dir*) of instances derived from Bits to OUTPUT or recursively sets members of Bundle/Vec to OUTPUT.

    returns

    this instance with its exact type.

    Definition Classes
    BundleData
  20. final def asSInt(): SInt

    Permalink
    Definition Classes
    Node
  21. final def asUInt(): UInt

    Permalink
    Definition Classes
    Node
  22. def assign(src: Node): Unit

    Permalink
    Definition Classes
    Node
  23. val bits: T

    Permalink

    OUTPUT data of type T

  24. def calcElements(view: Seq[String]): LinkedHashMap[String, Data]

    Permalink

    Populates the cache of elements declared in the Bundle.

    Populates the cache of elements declared in the Bundle.

    Attributes
    protected
    Definition Classes
    Bundle
  25. def canCSE: Boolean

    Permalink
    Definition Classes
    Node
  26. def checkPort(obj: Any, name: String): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Bundle
  27. lazy val chiselName: String

    Permalink
    Definition Classes
    Node
  28. var clock: Option[Clock]

    Permalink

    The clock for this node

    The clock for this node

    Definition Classes
    Node
  29. def clone(): DecoupledIO.this.type

    Permalink
    Definition Classes
    Data → AnyRef
  30. def cloneType(): DecoupledIO.this.type

    Permalink
    Definition Classes
    DecoupledIOData
  31. def colonEquals(src: Bundle): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    BundleData
  32. def colonEquals[T <: Data](that: Seq[T]): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Data
  33. def colonEquals(that: Bits): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Data
  34. var comp: Option[proc]

    Permalink
    Definition Classes
    Data
  35. def componentOf: Module

    Permalink

    Get the module that this node is a part of or the top module if not assigned yet

    Get the module that this node is a part of or the top module if not assigned yet

    returns

    The module that this node is a part of

    Definition Classes
    Node
  36. val consumers: LinkedHashSet[Node]

    Permalink

    nodes that consume one of my outputs

    nodes that consume one of my outputs

    Definition Classes
    Node
  37. def contains(name: String): Boolean

    Permalink

    Check if an element exists with that name

    Check if an element exists with that name

    Definition Classes
    Bundle
  38. def dblLitValue: Double

    Permalink

    Convert the node literal to a Double

    Convert the node literal to a Double

    Definition Classes
    Node
  39. var driveRand: Boolean

    Permalink
    Definition Classes
    Node
  40. lazy val elements: LinkedHashMap[String, Data]

    Permalink
    Definition Classes
    Bundle
  41. final def eq(arg0: AnyRef): Boolean

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

    Permalink

    Compare two nodes

    Compare two nodes

    that

    the node to compare with

    Definition Classes
    Node → AnyRef → Any
  43. def equalsForCSE(x: Node): Boolean

    Permalink
    Definition Classes
    Node
  44. def finalize(): Unit

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

    Permalink

    Indicate when data has been consumed

    Indicate when data has been consumed

    Note

    defined as ready && valid

  46. def flatten: Array[(String, Bits)]

    Permalink
    Definition Classes
    BundleData
  47. def flip(): DecoupledIO.this.type

    Permalink

    Change all INPUT to OUTPUT and visa versa for all elements in this Bundle

    Change all INPUT to OUTPUT and visa versa for all elements in this Bundle

    Definition Classes
    BundleData
  48. def floLitValue: Float

    Permalink

    Convert the node literal to a Float

    Convert the node literal to a Float

    Definition Classes
    Node
  49. def fromBits(b: Bits): DecoupledIO.this.type

    Permalink
    Definition Classes
    Data
  50. def fromMap(elemmap: Map[String, Data]): DecoupledIO.this.type

    Permalink

    Connect all data nodes in the map as inputs for this bundle using the names in the map

    Connect all data nodes in the map as inputs for this bundle using the names in the map

    Definition Classes
    Bundle
  51. def fromNode(n: Node): DecoupledIO.this.type

    Permalink

    Factory method to create and assign a leaf-type instance out of a subclass of *Node* instance which we have lost the concrete type.

    Factory method to create and assign a leaf-type instance out of a subclass of *Node* instance which we have lost the concrete type.

    Definition Classes
    Data
  52. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  53. def getNode: Node

    Permalink

    returns

    The root node input

    Definition Classes
    Node
  54. def getWidth(): Int

    Permalink

    returns

    the width or number of bits used by this node

    Definition Classes
    BundleAggregateNode
    Exceptions thrown

    ChiselException if the width of the node is unknown

  55. def hashCode(): Int

    Permalink

    returns

    the unique hashCode for this node

    Definition Classes
    Node → AnyRef → Any
  56. def hashCodeForCSE: Int

    Permalink
    Definition Classes
    Node
  57. def illegalAssignment(that: Any): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Data
  58. def infer: Boolean

    Permalink

    Called while we're walking the graph inferring the width of nodes.

    Called while we're walking the graph inferring the width of nodes. We return true if we should continue to walk the graph, either because there's a node whose width we don't know, or because we updated a node's width.

    Definition Classes
    Node
  59. def init(n: String, w: Int, ins: Node*): Node

    Permalink

    Init the node and calculate its width and add inputs to the node

    Init the node and calculate its width and add inputs to the node

    n

    name of node

    w

    the bit width of the node

    ins

    Nodes that are inputs to this node

    Definition Classes
    Node
  60. def init(n: String, widthFunc: (⇒ Node) ⇒ Width, ins: Node*): Node

    Permalink

    Init the node and calculate its width and add inputs to the node

    Init the node and calculate its width and add inputs to the node

    n

    name of node

    widthFunc

    the function to use to calculate the width of the node

    ins

    Nodes that are inputs to this node

    Definition Classes
    Node
  61. def initOf(n: String, widthfunc: (⇒ Node) ⇒ Width, ins: Seq[Node]): Node

    Permalink

    Init the node and calculate its width and add inputs to the node

    Init the node and calculate its width and add inputs to the node

    n

    name of node

    widthfunc

    the function to use to calculate the width of the node

    ins

    Nodes that are inputs to this node

    Definition Classes
    Node
  62. val inputs: ArrayBuffer[Node]

    Permalink

    The inputs that this node depends on

    The inputs that this node depends on

    Definition Classes
    Node
  63. def isDirectionless: Boolean

    Permalink

    check if this node is neither INPUT or OUTPUT

    check if this node is neither INPUT or OUTPUT

    Definition Classes
    BundleData
  64. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  65. def isIo: Boolean

    Permalink

    returns

    this node is an I/O Node for a module

    Definition Classes
    Node
  66. def isIo_=(isIo: Boolean): Unit

    Permalink
    Attributes
    protected[Chisel]
    Definition Classes
    Node
  67. final def isLit: Boolean

    Permalink

    This function determines if a node is a literal, a fixed value

    This function determines if a node is a literal, a fixed value

    Definition Classes
    Node
  68. def isTopLevelIO: Boolean

    Permalink

    returns

    is this node I/O for the top level module

    Definition Classes
    Node
  69. var isTypeNode: Boolean

    Permalink
    Definition Classes
    Node
  70. def isTypeOnly: Boolean

    Permalink

    Chisel3 - type-only nodes (no data - no initialization or assignment) This is used to determine which nodes must be Wire() wrapped, and whether Wire() wrapping of the node is legal or not.

    Chisel3 - type-only nodes (no data - no initialization or assignment) This is used to determine which nodes must be Wire() wrapped, and whether Wire() wrapping of the node is legal or not.

    Definition Classes
    BundleDataNode
  71. def isUsedByClockHi: Boolean

    Permalink

    returns

    this node is a Register

    Definition Classes
    Node
  72. def isWired: Boolean

    Permalink
    Definition Classes
    AggregateData
  73. def isZeroWidth: Boolean

    Permalink

    returns

    this node has zero-width

    Definition Classes
    Node
  74. val line: StackTraceElement

    Permalink

    The trace information for chisel for this node

    The trace information for chisel for this node

    Definition Classes
    Node
  75. def litOf: Literal

    Permalink

    returns

    the literal value of a node

    Definition Classes
    Node
    Exceptions thrown

    ChiselException if there is no literal value available

  76. def litValue(default: BigInt = BigInt(-1)): BigInt

    Permalink

    returns

    the literal value of the node as a BigInt

    Bool(true).litValue() => BigInt(1)
    Definition Classes
    Node
  77. def maybeFlatten: Seq[Node]

    Permalink

    Deprecated: Do not use

    Deprecated: Do not use

    Definition Classes
    Node
  78. var modified: Boolean

    Permalink
    Definition Classes
    Node
  79. var name: String

    Permalink

    Name of the instance.

    Name of the instance.

    Definition Classes
    Nameable
  80. def nameIt(path: String, isNamingIo: Boolean): Unit

    Permalink

    Name the bundle, do not use directly, use setName instead

    Name the bundle, do not use directly, use setName instead

    Definition Classes
    BundleDataNode
  81. var named: Boolean

    Permalink

    named is used to indicate that name was set explicitly and should not be overriden

    named is used to indicate that name was set explicitly and should not be overriden

    Definition Classes
    Nameable
  82. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  83. def needWidth(): Int

    Permalink

    returns

    the bitWidth of the node

    Definition Classes
    Node
    Exceptions thrown

    ChiselException if the width is not yet defined

  84. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  86. def params: Parameters

    Permalink
    Definition Classes
    Data
  87. def printTree(writer: PrintStream, depth: Int = 4, indent: String = ""): Unit

    Permalink

    Prints all members of a node and recursively its inputs up to a certain depth level This method is purely used for debugging

    Prints all members of a node and recursively its inputs up to a certain depth level This method is purely used for debugging

    Definition Classes
    Node
  88. var prune: Boolean

    Permalink
    Definition Classes
    Node
  89. val ready: Bool

    Permalink

    INPUT signal to indicate data is ready

  90. def removeTypeNodes(): Unit

    Permalink
    Definition Classes
    BundleNode
  91. def replaceTree(newNode: Node): Unit

    Permalink

    Replace the subtree starting from this node with the indicated replacement

    Replace the subtree starting from this node with the indicated replacement

    newNode

    The node to start tree from

    Definition Classes
    Node
  92. def review(): Unit

    Permalink

    Review a node for optimization possibilities if its children have been updated

    Review a node for optimization possibilities if its children have been updated

    Definition Classes
    Node
  93. def setIsTypeNode: Unit

    Permalink

    make this node a type node

    make this node a type node

    Definition Classes
    BundleData
  94. def setIsWired(value: Boolean): Unit

    Permalink
    Definition Classes
    AggregateData
  95. def setName(n: String): Unit

    Permalink

    Set the name of this module to the string 'n'

    Set the name of this module to the string 'n'

    Definition Classes
    Nameable
    Example:
    1. my.io.node.setName("MY_IO_NODE")
  96. def setWidth(w: Int): Unit

    Permalink

    Force the bit width of a node

    Force the bit width of a node

    w

    the bit width to force

    Definition Classes
    Node
  97. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  98. def toBits(): UInt

    Permalink

    returns

    This node as a UInt

    Definition Classes
    Node
  99. def toBool(): Bool

    Permalink

    Try to convert this data to a Bool

    Try to convert this data to a Bool

    Definition Classes
    Data
    Exceptions thrown

    ChiselException if the width is not 1

  100. lazy val toNode: Node

    Permalink

    returns

    This node

    Definition Classes
    DataNode
  101. def toSInt(): SInt

    Permalink
    Definition Classes
    Node
  102. def toString(): String

    Permalink
    Definition Classes
    Bundle → AnyRef → Any
  103. def toUInt(): UInt

    Permalink
    Definition Classes
    Node
  104. def usesInClockHi(i: Node): Boolean

    Permalink
    Definition Classes
    Node
  105. val valid: Bool

    Permalink

    OUTPUT signal to indicate data is valid

  106. val view: Seq[String]

    Permalink
    Definition Classes
    Bundle
  107. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Bundle

Inherited from Aggregate

Inherited from Data

Inherited from Node

Inherited from Nameable

Inherited from AnyRef

Inherited from Any

Ungrouped