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, SpinalTagReady, Assignable, NameableByComponent, Nameable, OwnableRef, ContextUser, ScalaLocated, 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. SpinalTagReady
  9. Assignable
  10. NameableByComponent
  11. Nameable
  12. OwnableRef
  13. ContextUser
  14. ScalaLocated
  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(payloadType: HardType[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[T <: SpinalTag](spinalTag: T): Stream.this.type

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

    Definition Classes
    SpinalTagReady
  21. def allowDirectionLessIo: Stream.this.type

    Definition Classes
    Data
  22. def allowOverride: Stream.this.type

    Definition Classes
    Data
  23. def allowPruning(): Stream.this.type

    Definition Classes
    Data
  24. def allowSimplifyIt(): Stream.this.type

    Definition Classes
    Data
  25. def allowUnsetRegToAvoidLatch: Stream.this.type

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

    Drive arbitration signals of this from that

  27. def asBits: Bits

    Definition Classes
    MultiData → Data
  28. def asData: Data

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

  30. def asFlow: Flow[T]

  31. def asInOut(): Stream.this.type

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

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

    Definition Classes
    Any
  34. def asMaster(): Unit

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

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

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

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

    Definition Classes
    Data
  39. final def assignFrom(that: AnyRef, target: AnyRef): Unit

    Definition Classes
    Data
  40. def assignFromBits(bits: Bits, hi: Int, lo: Int): Unit

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

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

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

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

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

    Definition Classes
    Bundle
  46. def component: Component

    Definition Classes
    ContextUser
  47. final def compositAssignFrom(that: AnyRef, target: AnyRef, kind: AnyRef): Unit

    Definition Classes
    Assignable
  48. var compositeAssign: Assignable

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

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

    Block this when cond is False.

    Block this when cond is False. Return the resulting stream

  51. def dirString(): String

    Definition Classes
    Data
  52. def dontSimplifyIt(): Stream.this.type

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

    Definition Classes
    Bundle → MultiData
  54. def elementsString: String

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

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

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

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

    Definition Classes
    SpinalTagReady
  59. def finalize(): Unit

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

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

    Definition Classes
    SpinalTagReady
  62. 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
  63. def flatten: Seq[BaseType]

    Definition Classes
    MultiData → Data
  64. def flattenForeach(body: (BaseType) ⇒ Unit): Unit

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

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

    Definition Classes
    MultiData → Data
  67. def foreachReflectableNameables(doThat: (Any) ⇒ Unit): Unit

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

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

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

    Definition Classes
    Data
  71. def getBitsWidth: Int

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

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

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

    Definition Classes
    Data
  75. def getDisplayName(): String

    Definition Classes
    Nameable
  76. def getInstanceCounter: Int

    Definition Classes
    ContextUser
  77. def getMode: Byte

    Attributes
    protected
    Definition Classes
    Nameable
  78. def getName(default: String): String

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

    Definition Classes
    Nameable
  80. def getRealSource: Any

    Definition Classes
    Assignable
  81. def getRealSourceNoRec: Any

    Definition Classes
    Data → Assignable
  82. def getRefOwnersChain(): List[Any]

    Definition Classes
    OwnableRef
  83. def getRootParent: Data

    Definition Classes
    Data
  84. def getScalaLocationLong: String

    Definition Classes
    ScalaLocated
  85. def getScalaLocationShort: String

    Definition Classes
    ScalaLocated
  86. def getScalaTrace(): Throwable

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

    Definition Classes
    SpinalTagReady
  88. def getTags(): Set[SpinalTag]

    Definition Classes
    SpinalTagReady
  89. def getTypeString: String

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

    Definition Classes
    MultiData → Data
  91. val globalData: GlobalData

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

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

  93. 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

  94. def hasTag[T <: SpinalTag](clazz: Class[T]): Boolean

    Definition Classes
    SpinalTagReady
  95. def hasTag(spinalTag: SpinalTag): Boolean

    Definition Classes
    SpinalTagReady
  96. def hashCode(): Int

    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  97. final def initFrom(that: AnyRef, target: AnyRef): Unit

    Definition Classes
    Data
  98. def instanceAttributes(language: Language): Iterable[Attribute]

    Definition Classes
    SpinalTagReady
  99. def instanceAttributes: Iterable[Attribute]

    Definition Classes
    SpinalTagReady
  100. def isAnalog: Boolean

    Definition Classes
    Data
  101. def isComb: Boolean

    Definition Classes
    Data
  102. def isDirectionLess: Boolean

    Definition Classes
    Data
  103. def isEmptyOfTag: Boolean

    Definition Classes
    SpinalTagReady
  104. def isFree: Bool

  105. def isInOut: Boolean

    Definition Classes
    Data
  106. def isInput: Boolean

    Definition Classes
    Data
  107. def isInputOrInOut: Boolean

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

    Definition Classes
    Any
  109. var isMasterInterface: Boolean

    Definition Classes
    IMasterSlave
  110. def isNamed: Boolean

    Definition Classes
    NameableByComponent → Nameable
  111. def isNew: Bool

    Return True when a transaction is appear (first cycle)

  112. def isOutput: Boolean

    Definition Classes
    Data
  113. def isOutputOrInOut: Boolean

    Definition Classes
    Data
  114. def isPriorityApplicable(namePriority: Byte): Boolean

    Definition Classes
    Nameable
  115. def isReg: Boolean

    Definition Classes
    Data
  116. def isStall: Bool

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

  117. def isUnnamed: Boolean

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

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

  120. var name: String

    Attributes
    protected
    Definition Classes
    Nameable
  121. var nameableRef: Nameable

    Attributes
    protected
    Definition Classes
    Nameable
  122. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  123. def noBackendCombMerge: Stream.this.type

    Definition Classes
    Data
  124. def noCombLoopCheck: Stream.this.type

    Definition Classes
    Data
  125. final def notify(): Unit

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

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

    Definition Classes
    SpinalTagReady
  128. var parent: Data

    Definition Classes
    Data
  129. var parentScope: ScopeStatement

    Definition Classes
    ContextUser
  130. val payload: T

    Definition Classes
    StreamDataCarrier
  131. val payloadType: HardType[T]

  132. def pull(): Stream.this.type

    Definition Classes
    Data
  133. def purify(): Stream.this.type

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

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

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

    Connect this to a fifo and return its pop stream

  136. def queueLowLatency(size: Int, latency: Int = 0): Stream[T]

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

  137. def queueWithAvailability(size: Int): (Stream[T], UInt)

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

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

  139. 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

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

    Definition Classes
    Data
  141. val ready: Bool

  142. var refOwner: RefOwnerType

    Definition Classes
    OwnableRef
  143. def removeAssignments(): Stream.this.type

    Definition Classes
    Data
  144. def removeTag(spinalTag: SpinalTag): Stream.this.type

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

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

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

  148. def s2mPipe(): Stream[T]

  149. def setAsAnalog(): Stream.this.type

    Definition Classes
    Data
  150. def setAsComb(): Stream.this.type

    Definition Classes
    MultiData → Data
  151. def setAsDirectionLess(): Stream.this.type

    Definition Classes
    MultiData → Data
  152. def setAsReg(): Stream.this.type

    Definition Classes
    MultiData → Data
  153. def setCompositeName(nameable: Nameable, postfix: String, namePriority: Byte): Stream.this.type

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

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

    Definition Classes
    Nameable
  156. def setCompositeName(nameable: Nameable, namePriority: Byte): Stream.this.type

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

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

    Definition Classes
    Nameable
  159. def setName(name: String, namePriority: Byte): Stream.this.type

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

    Definition Classes
    Nameable
  161. def setName(name: String): Stream.this.type

    Definition Classes
    Nameable
  162. def setPartialName(name: String, namePriority: Byte): Stream.this.type

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

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

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

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

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

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

    Definition Classes
    OwnableRef
  169. def setScalaLocated(source: ScalaLocated): Stream.this.type

    Definition Classes
    ScalaLocated
  170. def setWeakName(name: String): Stream.this.type

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

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

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

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

    Definition Classes
    AnyRef
  174. 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

  175. 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

  176. def toEvent(): Event

  177. def toFlow: Flow[T]

    returns

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

  178. def toString(): String

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

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

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

  182. def unsetName(): Stream.this.type

    Definition Classes
    Nameable
  183. val valid: Bool

    Definition Classes
    StreamDataCarrier
  184. def validPipe(): Stream[T]

  185. final def wait(): Unit

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

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

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

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

Deprecated Value Members

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

    Definition Classes
    Data
    Annotations
    @deprecated
    Deprecated

    use setAsDirectionLess instead

Inherited from DataCarrier[T]

Inherited from IMasterSlave

Inherited from Bundle

Inherited from OverridedEqualsHashCode

Inherited from MultiData

Inherited from Data

Inherited from SpinalTagReady

Inherited from Assignable

Inherited from NameableByComponent

Inherited from Nameable

Inherited from OwnableRef

Inherited from ContextUser

Inherited from ScalaLocated

Inherited from GlobalDataUser

Inherited from AnyRef

Inherited from Any

Ungrouped