spinal.lib

Stream

Related Docs: object Stream | package lib

class Stream[T <: Data] extends Bundle with IMasterSlave with DataCarrier[T]

Linear Supertypes
DataCarrier[T], IMasterSlave, Bundle, OverridedEqualsHashCode, MultiData, Data, ScalaLocated, SpinalTagReady, Assignable, NameableByComponent, Nameable, OwnableRef, ContextUser, GlobalDataUser, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Stream
  2. DataCarrier
  3. IMasterSlave
  4. Bundle
  5. OverridedEqualsHashCode
  6. MultiData
  7. Data
  8. ScalaLocated
  9. SpinalTagReady
  10. Assignable
  11. NameableByComponent
  12. Nameable
  13. OwnableRef
  14. ContextUser
  15. GlobalDataUser
  16. AnyRef
  17. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Stream(_dataType: T)

Type Members

  1. abstract type RefOwnerType

    Definition Classes
    OwnableRef

Value Members

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

    Definition Classes
    AnyRef → Any
  2. def ##(right: Data): Bits

    Definition Classes
    Data
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. def &(cond: Bool): Stream[T]

  5. def <-/<(that: Stream[T]): Stream[T]

    Connect that to this.

    Connect that to this. The valid/payload/ready path are cut by an register stage

  6. def <-<(that: Stream[T]): Stream[T]

    Connect that to this.

    Connect that to this. The valid/payload path are cut by an register stage

  7. def </<(that: Stream[T]): Stream[T]

    Connect that to this.

    Connect that to this. The ready path is cut by an register stage

  8. def <<(that: Stream[T]): Stream[T]

    Connect that to this

  9. final def ==(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  10. def >->(into: Stream[T]): Stream[T]

    Connect this to that.

    Connect this to that. The valid/payload path are cut by an register stage

  11. def >/->(into: Stream[T]): Stream[T]

    Connect that to this.

    Connect that to this. The valid/payload/ready path are cut by an register stage

  12. def >/>(that: Stream[T]): Stream[T]

    Connect this to that.

    Connect this to that. The ready path is cut by an register stage

  13. def >>(into: Stream[T]): Stream[T]

    Connect this to that

  14. var _spinalTags: Set[SpinalTag]

    Definition Classes
    SpinalTagReady
  15. def addAttribute(attribute: Attribute): Stream.this.type

    Definition Classes
    Data → SpinalTagReady
  16. def addAttribute(name: String, value: String): Stream.this.type

    Definition Classes
    SpinalTagReady
  17. def addAttribute(name: String): Stream.this.type

    Definition Classes
    SpinalTagReady
  18. def addFragmentLast(last: Bool): Stream[Fragment[T]]

  19. def addTag(spinalTag: SpinalTag): Stream.this.type

    Definition Classes
    MultiData → SpinalTagReady
  20. def addTags(tags: Iterable[SpinalTag]): Stream.this.type

    Definition Classes
    SpinalTagReady
  21. def allowSimplifyIt(): Stream.this.type

    Definition Classes
    Data
  22. def arbitrationFrom[T2 <: Data](that: Stream[T2]): Unit

    Drive arbitration signals of this from that

  23. def asBits: Bits

    Definition Classes
    MultiData → Data
  24. def asData: Data

    Definition Classes
    Data
  25. def asDataStream: Stream[Data]

  26. def asDirectionLess(): Stream.this.type

    Definition Classes
    MultiData → Data
  27. def asInput(): Stream.this.type

    Definition Classes
    MultiData → Data
  28. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  29. def asMaster(): Unit

    Definition Classes
    StreamIMasterSlave
  30. def asOutput(): Stream.this.type

    Definition Classes
    MultiData → Data
  31. def asSlave(): Unit

    Definition Classes
    IMasterSlave
  32. def assignAllByName(that: Bundle): Unit

    Definition Classes
    Bundle
  33. def assignDontCare(): Stream.this.type

    Definition Classes
    Data
  34. final def assignFrom(that: AnyRef, conservative: Boolean): Unit

    Definition Classes
    Assignable
  35. def assignFromBits(bits: Bits, hi: Int, lo: Int): Unit

    Definition Classes
    MultiData → Data
  36. def assignFromBits(bits: Bits): Unit

    Definition Classes
    MultiData → Data
  37. def assignFromBits(bits: Bits, offset: Int, bitCount: BitCount): Unit

    Definition Classes
    Data
  38. def assignSomeByName(that: Bundle): Unit

    Definition Classes
    Bundle
  39. def clone(): Stream[T]

    Definition Classes
    Stream → Bundle → Data → AnyRef
  40. var cloneFunc: () ⇒ AnyRef

    Definition Classes
    Bundle
  41. var component: Component

    Definition Classes
    ContextUser
  42. var compositeAssign: Assignable

    Definition Classes
    Assignable
  43. def connectFrom(that: Stream[T]): Stream[T]

  44. def continueWhen(cond: Bool): Stream[T]

    Block this when cond is False.

    Block this when cond is False. Return the resulting stream

  45. def dataType: T

  46. def dontSimplifyIt(): Stream.this.type

    Definition Classes
    Data
  47. def elements: ArrayBuffer[(String, Data)]

    Definition Classes
    Bundle → MultiData
  48. def elementsString: String

    Definition Classes
    MultiData
  49. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  50. def equals(obj: Any): Boolean

    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  51. def existsTag(cond: (SpinalTag) ⇒ Boolean): Boolean

    Definition Classes
    SpinalTagReady
  52. def filterTag(cond: (SpinalTag) ⇒ Boolean): Iterable[SpinalTag]

    Definition Classes
    SpinalTagReady
  53. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  54. def find(name: String): Data

    Definition Classes
    MultiData
  55. def findTag(cond: (SpinalTag) ⇒ Boolean): Option[SpinalTag]

    Definition Classes
    SpinalTagReady
  56. def fire: Bool

    Return True when a transaction occure on the bus (Valid && ready)

    Return True when a transaction occure on the bus (Valid && ready)

    Definition Classes
    StreamDataCarrier
  57. def flatten: Seq[BaseType]

    Definition Classes
    MultiData → Data
  58. def flattenLocalName: Seq[String]

    Definition Classes
    MultiData → Data
  59. def flip(): Stream.this.type

    Definition Classes
    MultiData → Data
  60. def forEachNameables(doThat: (Any) ⇒ Unit): Unit

    Definition Classes
    Nameable
  61. def fragmentTransaction(bitsWidth: Int): Stream[Fragment[Bits]]

  62. def freeRun(): Stream.this.type

    Definition Classes
    StreamDataCarrier
  63. def genIf(cond: Boolean): Stream.this.type

    Definition Classes
    Data
  64. def getBitsWidth: Int

    Definition Classes
    MultiData → Data
  65. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  66. def getComponent(): Component

    Definition Classes
    Data → NameableByComponent
  67. def getComponents(): Seq[Component]

    Definition Classes
    Data
  68. def getDisplayName(): String

    Definition Classes
    Nameable
  69. def getInstanceCounter: Int

    Definition Classes
    ContextUser
  70. def getName(): String

    Definition Classes
    NameableByComponent → Nameable
  71. def getName(default: String): String

    Definition Classes
    Nameable
  72. def getRefOwnersChain(): List[Any]

    Definition Classes
    OwnableRef
  73. def getRootParent: Data

    Definition Classes
    Data
  74. def getScalaLocationLong: String

    Definition Classes
    ScalaLocated
  75. def getScalaLocationShort: String

    Definition Classes
    ScalaLocated
  76. def getTag[T <: SpinalTag](clazz: Class[T]): Option[T]

    Definition Classes
    SpinalTagReady
  77. def getTypeString: String

    Definition Classes
    Stream → Bundle
  78. def getZero: Stream.this.type

    Definition Classes
    MultiData → Data
  79. val globalData: GlobalData

    Definition Classes
    GlobalDataUser
  80. def halfPipe(): Stream[T]

    cut all path, but divide the bandwidth by 2, 1 cycle latency

  81. def haltWhen(cond: Bool): Stream[T]

    Stop transactions on this when cond is True.

    Stop transactions on this when cond is True. Return the resulting stream

  82. def hasTag(spinalTag: SpinalTag): Boolean

    Definition Classes
    SpinalTagReady
  83. def hashCode(): Int

    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  84. def instanceAttributes: Iterable[Attribute]

    Definition Classes
    SpinalTagReady
  85. def isDirectionLess: Boolean

    Definition Classes
    Data
  86. def isEmptyOfTag: Boolean

    Definition Classes
    SpinalTagReady
  87. def isFree: Bool

  88. def isInput: Boolean

    Definition Classes
    Data
  89. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  90. def isNamed: Boolean

    Definition Classes
    Nameable
  91. def isOutput: Boolean

    Definition Classes
    Data
  92. def isReg: Boolean

    Definition Classes
    Data
  93. def isStall: Bool

    Return True when a transaction is present on the bus but the ready is low

  94. def isUnnamed: Boolean

    Definition Classes
    Nameable
  95. def keep(): Stream.this.type

    Definition Classes
    Data
  96. def m2sPipe(collapsBubble: Boolean = true, crossClockData: Boolean = false): Stream[T]

  97. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  98. final def notify(): Unit

    Definition Classes
    AnyRef
  99. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  100. def onEachAttributes(doIt: (Attribute) ⇒ Unit): Unit

    Definition Classes
    SpinalTagReady
  101. var parent: Data

    Definition Classes
    Data
  102. val payload: T

    Definition Classes
    StreamDataCarrier
  103. def pull(): Stream.this.type

    Definition Classes
    Data
  104. def queue(size: Int, pushClock: ClockDomain, popClock: ClockDomain): Stream[T]

    Connect this to an clock crossing fifo and return its pop stream

  105. def queue(size: Int): Stream[T]

    Connect this to a fifo and return its pop stream

  106. def queueWithOccupancy(size: Int): (Stream[T], UInt)

    Connect this to a fifo and return its pop stream and its occupancy

  107. def queueWithPushOccupancy(size: Int, pushClock: ClockDomain, popClock: ClockDomain): (Stream[T], UInt)

    Connect this to a cross clock domain fifo and return its pop stream and its push side occupancy

  108. def queueZeroLatency(size: Int): Stream[T]

    Connect this to a zero latency fifo and return its pop stream

  109. def randBoot(): Stream.this.type

    Definition Classes
    Data
  110. val ready: Bool

  111. var refOwner: RefOwnerType

    Definition Classes
    OwnableRef
  112. def removeTag(spinalTag: SpinalTag): Stream.this.type

    Definition Classes
    SpinalTagReady
  113. def removeTags(tags: Iterable[SpinalTag]): Stream.this.type

    Definition Classes
    SpinalTagReady
  114. def resized: Stream.this.type

    Definition Classes
    Data
  115. def s2mPipe(stagesCount: Int): Stream[T]

  116. def s2mPipe(): Stream[T]

  117. def setCompositeName(nameable: Nameable, postfix: String, weak: Boolean): Stream.this.type

    Definition Classes
    Nameable
  118. def setCompositeName(nameable: Nameable, postfix: String): Stream.this.type

    Definition Classes
    Nameable
  119. def setCompositeName(nameable: Nameable, weak: Boolean): Stream.this.type

    Definition Classes
    Nameable
  120. def setCompositeName(nameable: Nameable): Stream.this.type

    Definition Classes
    Nameable
  121. def setName(name: String, weak: Boolean): Stream.this.type

    Definition Classes
    Nameable
  122. def setPartialName(name: String, weak: Boolean): Stream.this.type

    Definition Classes
    Nameable
  123. def setPartialName(owner: Nameable, name: String, weak: Boolean): Stream.this.type

    Definition Classes
    Nameable
  124. def setPartialName(name: String): Stream.this.type

    Definition Classes
    Nameable
  125. def setPartialName(owner: Nameable, name: String): Stream.this.type

    Definition Classes
    Nameable
  126. def setRefOwner(that: Any): Unit

    Definition Classes
    OwnableRef
  127. def setWeakName(name: String): Stream.this.type

    Definition Classes
    Nameable
  128. def spinalTags: Set[SpinalTag]

    Definition Classes
    SpinalTagReady
  129. def stage(): Stream[T]

    Connect this to a valid/payload register stage and return its output stream

  130. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  131. def takeWhen(cond: Bool): Stream[T]

    Drop transaction of this when cond is False.

    Drop transaction of this when cond is False. Return the resulting stream

  132. def throwWhen(cond: Bool): Stream[T]

    Drop transactions of this when cond is True.

    Drop transactions of this when cond is True. Return the resulting stream

  133. def toFlow: Flow[T]

    returns

    Return a flow drived by this stream. Ready of ths stream is always high

  134. def toString(): String

    Definition Classes
    Bundle → Nameable → AnyRef → Any
  135. def translateFrom[T2 <: Data](that: Stream[T2])(dataAssignement: (T, payload.type) ⇒ Unit): Stream[T]

  136. def translateInto[T2 <: Data](into: Stream[T2])(dataAssignement: (T2, T) ⇒ Unit): Stream[T2]

  137. def translateWith[T2 <: Data](that: T2): Stream[T2]

  138. def unsetName(): Unit

    Definition Classes
    Nameable
  139. def unused: Unit

    Definition Classes
    Data
  140. val valid: Bool

    Definition Classes
    StreamDataCarrier
  141. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  144. def ~[T2 <: Data](that: T2): Stream[T2]

  145. def ~~[T2 <: Data](translate: (T) ⇒ T2): Stream[T2]

Inherited from DataCarrier[T]

Inherited from IMasterSlave

Inherited from Bundle

Inherited from OverridedEqualsHashCode

Inherited from MultiData

Inherited from Data

Inherited from ScalaLocated

Inherited from SpinalTagReady

Inherited from Assignable

Inherited from NameableByComponent

Inherited from Nameable

Inherited from OwnableRef

Inherited from ContextUser

Inherited from GlobalDataUser

Inherited from AnyRef

Inherited from Any

Ungrouped