Packages

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

Linear Supertypes
DataCarrier[T], IMasterSlave, Bundle, ValCallbackRec, ValCallback, MultiData, Data, InComponent, OverridedEqualsHashCode, 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. ValCallbackRec
  6. ValCallback
  7. MultiData
  8. Data
  9. InComponent
  10. OverridedEqualsHashCode
  11. SpinalTagReady
  12. Assignable
  13. NameableByComponent
  14. Nameable
  15. OwnableRef
  16. ContextUser
  17. ScalaLocated
  18. GlobalDataUser
  19. AnyRef
  20. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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. val _spinalTags: LinkedHashSet[SpinalTag]
    Definition Classes
    SpinalTagReady
  15. def addAttribute(attribute: Attribute): Stream.this.type
    Definition Classes
    Data → SpinalTagReady
  16. def addAttribute(name: String, value: Int): Stream.this.type
    Definition Classes
    SpinalTagReady
  17. def addAttribute(name: String, value: String): Stream.this.type
    Definition Classes
    SpinalTagReady
  18. def addAttribute(name: String): Stream.this.type
    Definition Classes
    SpinalTagReady
  19. def addFragmentLast(counter: Counter): Stream[Fragment[T]]

    Like addFragmentLast(Bool), but instead of manually telling which values go together, let a counter do the job.

    Like addFragmentLast(Bool), but instead of manually telling which values go together, let a counter do the job. The counter will increment for each passing element. Last will be set high at the end of each revolution.

    Example:

    1. outStream = inStream.addFragmentLast(new Counter(5))
  20. def addFragmentLast(last: Bool): Stream[Fragment[T]]

    Convert this stream to a fragmented stream by adding a last bit.

    Convert this stream to a fragmented stream by adding a last bit. To view it from another perspective, bundle together successive events as fragments of a larger whole. You can then use enhanced operations on fragmented streams, like reducing of elements.

  21. def addTag[T <: SpinalTag](spinalTag: T): Stream.this.type
    Definition Classes
    MultiData → SpinalTagReady
  22. def addTags[T <: SpinalTag](tags: Iterable[T]): Stream.this.type
    Definition Classes
    SpinalTagReady
  23. def allowDirectionLessIo: Stream.this.type
    Definition Classes
    Data
  24. def allowOverride: Stream.this.type
    Definition Classes
    Data
  25. def allowPartialyAssigned: Stream.this.type
    Definition Classes
    Data
  26. def allowPruning(): Stream.this.type
    Definition Classes
    Data
  27. def allowSimplifyIt(): Stream.this.type
    Definition Classes
    Data
  28. def allowUnsetRegToAvoidLatch: Stream.this.type
    Definition Classes
    Data
  29. def arbitrationFrom[T2 <: Data](that: Stream[T2]): Unit

    Drive arbitration signals of this from that

  30. def as[T <: Data](dataType: HardType[T]): T
    Definition Classes
    Data
  31. def asBits: Bits
    Definition Classes
    MultiData → Data
  32. def asData: Data
    Definition Classes
    Data
  33. def asDataStream: Stream[Data]
  34. def asFlow: Flow[T]
  35. def asInOut(): Stream.this.type
    Definition Classes
    MultiData → Data
  36. def asInput(): Stream.this.type
    Definition Classes
    MultiData → Data
  37. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  38. def asMaster(): Unit
    Definition Classes
    Stream → IMasterSlave
  39. def asOutput(): Stream.this.type
    Definition Classes
    MultiData → Data
  40. def asSlave(): Unit
    Definition Classes
    IMasterSlave
  41. def assignAllByName(that: Bundle): Unit
    Definition Classes
    Bundle
  42. def assignDontCare(): Stream.this.type
    Definition Classes
    Data
  43. final def assignFrom(that: AnyRef, target: AnyRef): Unit
    Definition Classes
    Data
  44. def assignFromBits(bits: Bits, hi: Int, lo: Int): Unit
    Definition Classes
    MultiData → Data
  45. def assignFromBits(bits: Bits): Unit
    Definition Classes
    MultiData → Data
  46. def assignFromBits(bits: Bits, offset: Int, bitCount: BitCount): Unit
    Definition Classes
    Data
  47. def assignSomeByName(that: Bundle): Unit
    Definition Classes
    Bundle
  48. def ccToggle(pushClock: ClockDomain, popClock: ClockDomain): Stream[T]
  49. def ccToggleWithoutBuffer(pushClock: ClockDomain, popClock: ClockDomain): Stream[T]
  50. def clearValidWhen(cond: Bool): Stream[T]
  51. def clone(): Stream[T]
    Definition Classes
    Stream → Bundle → Data → AnyRef
  52. def combStage(): Stream[T]

    A combinatorial stage doesn't do anything, but it is nice to separate signals for combinatorial transformations.

  53. def component: Component
    Definition Classes
    ContextUser
  54. final def compositAssignFrom(that: AnyRef, target: AnyRef, kind: AnyRef): Unit
    Definition Classes
    Assignable
  55. val compositeAssign: Assignable
    Definition Classes
    Assignable
  56. def connectFrom(that: Stream[T]): Stream[T]
  57. def continueWhen(cond: Bool): Stream[T]

    Block this when cond is False.

    Block this when cond is False. Return the resulting stream

  58. def copyDirectionOfImpl(that: Data): Stream.this.type
    Definition Classes
    MultiData → Data
  59. def dirString(): String
    Definition Classes
    Data
  60. def dontSimplifyIt(): Stream.this.type
    Definition Classes
    Data
  61. def elements: ArrayBuffer[(String, Data)]
    Definition Classes
    Bundle → MultiData
  62. def elementsString: String
    Definition Classes
    MultiData
  63. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  64. def equals(obj: Any): Boolean
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  65. def existsTag(cond: (SpinalTag) => Boolean): Boolean
    Definition Classes
    SpinalTagReady
  66. def filterTag(cond: (SpinalTag) => Boolean): Iterable[SpinalTag]
    Definition Classes
    SpinalTagReady
  67. def find(name: String): Data
    Definition Classes
    MultiData
  68. def findTag(cond: (SpinalTag) => Boolean): Option[SpinalTag]
    Definition Classes
    SpinalTagReady
  69. def fire: Bool

    Return True when a transaction occurs on the bus (valid && ready)

    Return True when a transaction occurs on the bus (valid && ready)

    Definition Classes
    Stream → DataCarrier
  70. def flatten: Seq[BaseType]
    Definition Classes
    MultiData → Data
  71. def flattenForeach(body: (BaseType) => Unit): Unit
    Definition Classes
    MultiData → Data
  72. def flattenLocalName: Seq[String]
    Definition Classes
    MultiData → Data
  73. def flip(): Stream.this.type
    Definition Classes
    MultiData → Data
  74. def foreachReflectableNameables(doThat: (Any) => Unit): Unit
    Definition Classes
    Nameable
  75. def foreachTag(body: (SpinalTag) => Unit): Unit
    Definition Classes
    SpinalTagReady
  76. def fragmentTransaction(bitsWidth: Int): Stream[Fragment[Bits]]
  77. def freeRun(): Stream.this.type
    Definition Classes
    Stream → DataCarrier
  78. def genIf(cond: Boolean): Stream.this.type
    Definition Classes
    Data
  79. def getBitsWidth: Int
    Definition Classes
    MultiData → Data
  80. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  81. def getComponent(): Component
    Definition Classes
    Data → InComponent → NameableByComponent
  82. def getComponents(): Seq[Component]
    Definition Classes
    InComponent
  83. def getDirection: IODirection
    Definition Classes
    Data
  84. def getDisplayName(): String
    Definition Classes
    Nameable
  85. def getInstanceCounter: Int
    Definition Classes
    ContextUser
  86. def getMode: Byte
    Attributes
    protected
    Definition Classes
    Nameable
  87. def getName(default: String): String
    Definition Classes
    NameableByComponent → Nameable
  88. def getName(): String
    Definition Classes
    NameableByComponent → Nameable
  89. def getPartialName(): String
    Definition Classes
    Nameable
  90. def getRealSource: Any
    Definition Classes
    Assignable
  91. def getRealSourceNoRec: Any
    Definition Classes
    Data → Assignable
  92. def getRefOwnersChain(): List[Any]
    Definition Classes
    OwnableRef
  93. def getRootParent: Data
    Definition Classes
    Data
  94. def getScalaLocationLong: String
    Definition Classes
    ScalaLocated
  95. def getScalaLocationShort: String
    Definition Classes
    ScalaLocated
  96. def getScalaTrace(): Throwable
    Definition Classes
    ScalaLocated
  97. def getTag[T <: SpinalTag](clazz: Class[T]): Option[T]
    Definition Classes
    SpinalTagReady
  98. def getTags(): LinkedHashSet[SpinalTag]
    Definition Classes
    SpinalTagReady
  99. def getTypeString: String
    Definition Classes
    Stream → Bundle
  100. def getZero: Stream.this.type
    Definition Classes
    MultiData → Data
  101. val globalData: GlobalData
    Definition Classes
    GlobalDataUser
  102. def halfPipe(): Stream[T]

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

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

  104. var hardtype: HardType[_]
    Definition Classes
    Bundle
  105. def hasTag[T <: SpinalTag](clazz: Class[T]): Boolean
    Definition Classes
    SpinalTagReady
  106. def hasTag(spinalTag: SpinalTag): Boolean
    Definition Classes
    SpinalTagReady
  107. def hashCode(): Int
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  108. final def initFrom(that: AnyRef, target: AnyRef): Unit
    Definition Classes
    Data
  109. def instanceAttributes(language: Language): Iterable[Attribute]
    Definition Classes
    SpinalTagReady
  110. def instanceAttributes: Iterable[Attribute]
    Definition Classes
    SpinalTagReady
  111. def isAnalog: Boolean
    Definition Classes
    Data
  112. def isComb: Boolean
    Definition Classes
    Data
  113. def isCompletelyUnnamed: Boolean
    Definition Classes
    Nameable
  114. def isDirectionLess: Boolean
    Definition Classes
    Data
  115. def isEmptyOfTag: Boolean
    Definition Classes
    SpinalTagReady
  116. def isFree: Bool

    Return True when the bus is ready, but no data is present

  117. def isInOut: Boolean
    Definition Classes
    Data
  118. def isInput: Boolean
    Definition Classes
    Data
  119. def isInputOrInOut: Boolean
    Definition Classes
    Data
  120. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  121. val isMasterInterface: Boolean
    Definition Classes
    IMasterSlave
  122. def isNamed: Boolean
    Definition Classes
    NameableByComponent → Nameable
  123. def isNew: Bool

    Return True when a transaction has appeared (first cycle)

  124. def isOutput: Boolean
    Definition Classes
    Data
  125. def isOutputOrInOut: Boolean
    Definition Classes
    Data
  126. def isPriorityApplicable(namePriority: Byte): Boolean
    Definition Classes
    Nameable
  127. def isReg: Boolean
    Definition Classes
    Data
  128. def isStall: Bool

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

  129. def isUnnamed: Boolean
    Definition Classes
    Nameable
  130. def keep(): Stream.this.type
    Definition Classes
    Data
  131. def m2sPipe(collapsBubble: Boolean = true, crossClockData: Boolean = false, flush: Bool = null, holdPayload: Boolean = false): Stream[T]
  132. val name: String
    Attributes
    protected
    Definition Classes
    Nameable
  133. val nameableRef: Nameable
    Attributes
    protected
    Definition Classes
    Nameable
    Annotations
    @DontName()
  134. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  135. def noBackendCombMerge: Stream.this.type
    Definition Classes
    Data
  136. def noCombLoopCheck: Stream.this.type
    Definition Classes
    Data
  137. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  138. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  139. def onEachAttributes(doIt: (Attribute) => Unit): Unit
    Definition Classes
    SpinalTagReady
  140. def overrideLocalName(name: String): Stream.this.type
    Definition Classes
    Nameable
  141. val parent: Data
    Definition Classes
    Data
  142. val parentScope: ScopeStatement
    Definition Classes
    ContextUser
  143. val payload: T
    Definition Classes
    Stream → DataCarrier
  144. val payloadType: HardType[T]
  145. def pipelined(m2s: Boolean = false, s2m: Boolean = false, halfRate: Boolean = false): Stream[T]
  146. def pull(): Stream.this.type
    Definition Classes
    Data
  147. def purify(): Stream.this.type
    Definition Classes
    Data
  148. def queue(size: Int, pushClock: ClockDomain, popClock: ClockDomain): Stream[T]

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

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

    Connect this to a fifo and return its pop stream

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

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

  151. def queueWithAvailability(size: Int): (Stream[T], UInt)
  152. def queueWithOccupancy(size: Int): (Stream[T], UInt)

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

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

  154. def randBoot(u: Unit): Stream.this.type
    Definition Classes
    Data
  155. val ready: Bool
  156. val refOwner: RefOwnerType
    Definition Classes
    OwnableRef
    Annotations
    @DontName()
  157. def reflectNames(): Unit
    Definition Classes
    Nameable
  158. def removeAssignments(): Stream.this.type
    Definition Classes
    Data
  159. def removeTag(spinalTag: SpinalTag): Stream.this.type
    Definition Classes
    SpinalTagReady
  160. def removeTags(tags: Iterable[SpinalTag]): Stream.this.type
    Definition Classes
    SpinalTagReady
  161. def repeat(times: Int): (Stream[T], UInt)

    Connect this to a new stream that only advances every n elements, thus repeating the input several times.

    Connect this to a new stream that only advances every n elements, thus repeating the input several times.

    returns

    A tuple with the resulting stream that duplicates the items and the counter, indicating how many times the current element has been repeated.

  162. def resized: Stream.this.type
    Definition Classes
    Data
  163. def s2mPipe(stagesCount: Int): Stream[T]
  164. def s2mPipe(): Stream[T]
  165. def setAsAnalog(): Stream.this.type
    Definition Classes
    Data
  166. def setAsComb(): Stream.this.type
    Definition Classes
    MultiData → Data
  167. def setAsDirectionLess(): Stream.this.type
    Definition Classes
    MultiData → Data
  168. def setAsReg(): Stream.this.type
    Definition Classes
    MultiData → Data
  169. def setCompositeName(nameable: Nameable, postfix: String, namePriority: Byte): Stream.this.type
    Definition Classes
    Nameable
  170. def setCompositeName(nameable: Nameable, postfix: String, weak: Boolean): Stream.this.type
    Definition Classes
    Nameable
  171. def setCompositeName(nameable: Nameable, postfix: String): Stream.this.type
    Definition Classes
    Nameable
  172. def setCompositeName(nameable: Nameable, namePriority: Byte): Stream.this.type
    Definition Classes
    Nameable
  173. def setCompositeName(nameable: Nameable, weak: Boolean): Stream.this.type
    Definition Classes
    Nameable
  174. def setCompositeName(nameable: Nameable): Stream.this.type
    Definition Classes
    Nameable
  175. def setName(name: String, namePriority: Byte): Stream.this.type
    Definition Classes
    Nameable
  176. def setName(name: String, weak: Boolean): Stream.this.type
    Definition Classes
    Nameable
  177. def setName(name: String): Stream.this.type
    Definition Classes
    Nameable
  178. def setNameAsWeak(): Stream.this.type
    Definition Classes
    Nameable
  179. def setPartialName(name: String, namePriority: Byte): Stream.this.type
    Definition Classes
    Nameable
  180. def setPartialName(name: String, weak: Boolean): Stream.this.type
    Definition Classes
    Nameable
  181. def setPartialName(owner: Nameable, name: String, namePriority: Byte): Stream.this.type
    Definition Classes
    Nameable
  182. def setPartialName(owner: Nameable, name: String, weak: Boolean): Stream.this.type
    Definition Classes
    Nameable
  183. def setPartialName(name: String): Stream.this.type
    Definition Classes
    Nameable
  184. def setPartialName(owner: Nameable, name: String): Stream.this.type
    Definition Classes
    Nameable
  185. def setRefOwner(that: Any): Unit
    Definition Classes
    OwnableRef
  186. def setScalaLocated(source: ScalaLocated): Stream.this.type
    Definition Classes
    ScalaLocated
  187. def setWeakName(name: String): Stream.this.type
    Definition Classes
    Nameable
  188. def slowdown(factor: Int): Stream[Vec[T]]

    Connect this to a new stream whose payload is n times as wide, but that only fires every n cycles.

    Connect this to a new stream whose payload is n times as wide, but that only fires every n cycles. It introduces 0 to factor-1 cycles of latency. Mapping a stream into memory and mapping a slowed down stream into memory should yield the same result, thus the elements of the input will be written from high bits to low bits.

  189. def spinalTags: LinkedHashSet[SpinalTag]
    Definition Classes
    SpinalTagReady
  190. def stage(): Stream[T]

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

  191. def swapPayload[T2 <: Data](that: HardType[T2]): Stream[T2]
  192. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  193. 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

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

  195. def toEvent(): Event

    Ignore the payload

  196. def toFlow: Flow[T]

    returns

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

  197. def toFlowFire: Flow[T]
  198. def toIo(): Stream.this.type
    Definition Classes
    Data
  199. def toString(): String
    Definition Classes
    Bundle → Nameable → AnyRef → Any
  200. def translateFrom[T2 <: Data](that: Stream[T2])(dataAssignment: (T, payload.type) => Unit): Stream[T]
  201. def translateInto[T2 <: Data](into: Stream[T2])(dataAssignment: (T2, T) => Unit): Stream[T2]
  202. def translateWith[T2 <: Data](that: T2): Stream[T2]

    Replace this stream's payload with another one

  203. def transmuteWith[T2 <: Data](that: HardType[T2]): Stream[T2]

    Change the payload's content type.

    Change the payload's content type. The new type must have the same bit length as the current one.

  204. def unsetName(): Stream.this.type
    Definition Classes
    Nameable
  205. def valCallback[T](ref: T, name: String): T
    Definition Classes
    ValCallbackRec → ValCallback
  206. def valCallbackOn(ref: Any, name: String, refs: Set[Any]): Unit
    Definition Classes
    ValCallbackRec
  207. def valCallbackRec(ref: Any, name: String): Unit
    Definition Classes
    Bundle → ValCallbackRec
  208. val valid: Bool
    Definition Classes
    Stream → DataCarrier
  209. def validPipe(): Stream[T]
  210. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  211. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  212. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  213. def ~[T2 <: Data](that: T2): Stream[T2]
  214. def ~~[T2 <: Data](translate: (T) => T2): Stream[T2]

Deprecated Value Members

  1. def asDirectionLess(): Stream.this.type
    Definition Classes
    Data
    Annotations
    @deprecated
    Deprecated

    (Since version ???) use setAsDirectionLess instead

  2. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from DataCarrier[T]

Inherited from IMasterSlave

Inherited from Bundle

Inherited from ValCallbackRec

Inherited from ValCallback

Inherited from MultiData

Inherited from Data

Inherited from InComponent

Inherited from OverridedEqualsHashCode

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