Packages

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

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

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

    Drive arbitration signals of this from that

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

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

  49. def component: Component
    Definition Classes
    ContextUser
  50. final def compositAssignFrom(that: AnyRef, target: AnyRef, kind: AnyRef): Unit
    Definition Classes
    Assignable
  51. val compositeAssign: Assignable
    Definition Classes
    Assignable
  52. def connectFrom(that: Stream[T]): Stream[T]
  53. def continueWhen(cond: Bool): Stream[T]

    Block this when cond is False.

    Block this when cond is False. Return the resulting stream

  54. def copyDirectionOfImpl(that: Data): Stream.this.type
    Definition Classes
    MultiData → Data
  55. def dirString(): String
    Definition Classes
    Data
  56. def dontSimplifyIt(): Stream.this.type
    Definition Classes
    Data
  57. def elements: ArrayBuffer[(String, Data)]
    Definition Classes
    Bundle → MultiData
  58. def elementsString: String
    Definition Classes
    MultiData
  59. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  60. def equals(obj: Any): Boolean
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  61. def existsTag(cond: (SpinalTag) ⇒ Boolean): Boolean
    Definition Classes
    SpinalTagReady
  62. def filterTag(cond: (SpinalTag) ⇒ Boolean): Iterable[SpinalTag]
    Definition Classes
    SpinalTagReady
  63. def find(name: String): Data
    Definition Classes
    MultiData
  64. def findTag(cond: (SpinalTag) ⇒ Boolean): Option[SpinalTag]
    Definition Classes
    SpinalTagReady
  65. 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
  66. def flatten: Seq[BaseType]
    Definition Classes
    MultiData → Data
  67. def flattenForeach(body: (BaseType) ⇒ Unit): Unit
    Definition Classes
    MultiData → Data
  68. def flattenLocalName: Seq[String]
    Definition Classes
    MultiData → Data
  69. def flip(): Stream.this.type
    Definition Classes
    MultiData → Data
  70. def foreachReflectableNameables(doThat: (Any) ⇒ Unit): Unit
    Definition Classes
    Nameable
  71. def foreachTag(body: (SpinalTag) ⇒ Unit): Unit
    Definition Classes
    SpinalTagReady
  72. def fragmentTransaction(bitsWidth: Int): Stream[Fragment[Bits]]
  73. def freeRun(): Stream.this.type
    Definition Classes
    Stream → DataCarrier
  74. def genIf(cond: Boolean): Stream.this.type
    Definition Classes
    Data
  75. def getBitsWidth: Int
    Definition Classes
    MultiData → Data
  76. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  77. def getComponent(): Component
    Definition Classes
    Data → NameableByComponent
  78. def getComponents(): Seq[Component]
    Definition Classes
    Data
  79. def getDirection: IODirection
    Definition Classes
    Data
  80. def getDisplayName(): String
    Definition Classes
    Nameable
  81. def getInstanceCounter: Int
    Definition Classes
    ContextUser
  82. def getMode: Byte
    Attributes
    protected
    Definition Classes
    Nameable
  83. def getName(default: String): String
    Definition Classes
    NameableByComponent → Nameable
  84. def getName(): String
    Definition Classes
    Nameable
  85. def getPartialName(): String
    Definition Classes
    Nameable
  86. def getRealSource: Any
    Definition Classes
    Assignable
  87. def getRealSourceNoRec: Any
    Definition Classes
    Data → Assignable
  88. def getRefOwnersChain(): List[Any]
    Definition Classes
    OwnableRef
  89. def getRootParent: Data
    Definition Classes
    Data
  90. def getScalaLocationLong: String
    Definition Classes
    ScalaLocated
  91. def getScalaLocationShort: String
    Definition Classes
    ScalaLocated
  92. def getScalaTrace(): Throwable
    Definition Classes
    ScalaLocated
  93. def getTag[T <: SpinalTag](clazz: Class[T]): Option[T]
    Definition Classes
    SpinalTagReady
  94. def getTags(): Set[SpinalTag]
    Definition Classes
    SpinalTagReady
  95. def getTypeString: String
    Definition Classes
    Stream → Bundle
  96. def getZero: Stream.this.type
    Definition Classes
    MultiData → Data
  97. val globalData: GlobalData
    Definition Classes
    GlobalDataUser
  98. def halfPipe(): Stream[T]

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

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

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

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

  112. def isInOut: Boolean
    Definition Classes
    Data
  113. def isInput: Boolean
    Definition Classes
    Data
  114. def isInputOrInOut: Boolean
    Definition Classes
    Data
  115. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  116. val isMasterInterface: Boolean
    Definition Classes
    IMasterSlave
  117. def isNamed: Boolean
    Definition Classes
    NameableByComponent → Nameable
  118. def isNew: Bool

    Return True when a transaction has appeared (first cycle)

  119. def isOutput: Boolean
    Definition Classes
    Data
  120. def isOutputOrInOut: Boolean
    Definition Classes
    Data
  121. def isPriorityApplicable(namePriority: Byte): Boolean
    Definition Classes
    Nameable
  122. def isReg: Boolean
    Definition Classes
    Data
  123. def isStall: Bool

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

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

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

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

    Connect this to a fifo and return its pop stream

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

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

  145. def queueWithAvailability(size: Int): (Stream[T], UInt)
  146. def queueWithOccupancy(size: Int): (Stream[T], UInt)

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

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

  148. def randBoot(): Stream.this.type
    Definition Classes
    Data
  149. val ready: Bool
  150. val refOwner: RefOwnerType
    Definition Classes
    OwnableRef
    Annotations
    @DontName()
  151. def reflectNames(): Unit
    Definition Classes
    Nameable
  152. def removeAssignments(): Stream.this.type
    Definition Classes
    Data
  153. def removeTag(spinalTag: SpinalTag): Stream.this.type
    Definition Classes
    SpinalTagReady
  154. def removeTags(tags: Iterable[SpinalTag]): Stream.this.type
    Definition Classes
    SpinalTagReady
  155. 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.

  156. def resized: Stream.this.type
    Definition Classes
    Data
  157. def s2mPipe(stagesCount: Int): Stream[T]
  158. def s2mPipe(): Stream[T]
  159. def setAsAnalog(): Stream.this.type
    Definition Classes
    Data
  160. def setAsComb(): Stream.this.type
    Definition Classes
    MultiData → Data
  161. def setAsDirectionLess(): Stream.this.type
    Definition Classes
    MultiData → Data
  162. def setAsReg(): Stream.this.type
    Definition Classes
    MultiData → Data
  163. def setCompositeName(nameable: Nameable, postfix: String, namePriority: Byte): Stream.this.type
    Definition Classes
    Nameable
  164. def setCompositeName(nameable: Nameable, postfix: String, weak: Boolean): Stream.this.type
    Definition Classes
    Nameable
  165. def setCompositeName(nameable: Nameable, postfix: String): Stream.this.type
    Definition Classes
    Nameable
  166. def setCompositeName(nameable: Nameable, namePriority: Byte): Stream.this.type
    Definition Classes
    Nameable
  167. def setCompositeName(nameable: Nameable, weak: Boolean): Stream.this.type
    Definition Classes
    Nameable
  168. def setCompositeName(nameable: Nameable): Stream.this.type
    Definition Classes
    Nameable
  169. def setName(name: String, namePriority: Byte): Stream.this.type
    Definition Classes
    Nameable
  170. def setName(name: String, weak: Boolean): Stream.this.type
    Definition Classes
    Nameable
  171. def setName(name: String): Stream.this.type
    Definition Classes
    Nameable
  172. def setNameAsWeak(): Stream.this.type
    Definition Classes
    Nameable
  173. def setPartialName(name: String, namePriority: Byte): Stream.this.type
    Definition Classes
    Nameable
  174. def setPartialName(name: String, weak: Boolean): Stream.this.type
    Definition Classes
    Nameable
  175. def setPartialName(owner: Nameable, name: String, namePriority: Byte): Stream.this.type
    Definition Classes
    Nameable
  176. def setPartialName(owner: Nameable, name: String, weak: Boolean): Stream.this.type
    Definition Classes
    Nameable
  177. def setPartialName(name: String): Stream.this.type
    Definition Classes
    Nameable
  178. def setPartialName(owner: Nameable, name: String): Stream.this.type
    Definition Classes
    Nameable
  179. def setRefOwner(that: Any): Unit
    Definition Classes
    OwnableRef
  180. def setScalaLocated(source: ScalaLocated): Stream.this.type
    Definition Classes
    ScalaLocated
  181. def setWeakName(name: String): Stream.this.type
    Definition Classes
    Nameable
  182. 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.

  183. def spinalTags: Set[SpinalTag]
    Definition Classes
    SpinalTagReady
  184. def stage(): Stream[T]

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

  185. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  186. 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

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

  188. def toEvent(): Event

    Ignore the payload

  189. def toFlow: Flow[T]

    returns

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

  190. def toString(): String
    Definition Classes
    Bundle → Nameable → AnyRef → Any
  191. def translateFrom[T2 <: Data](that: Stream[T2])(dataAssignment: (T, payload.type) ⇒ Unit): Stream[T]
  192. def translateInto[T2 <: Data](into: Stream[T2])(dataAssignment: (T2, T) ⇒ Unit): Stream[T2]
  193. def translateWith[T2 <: Data](that: T2): Stream[T2]

    Replace this stream's payload with another one

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

  195. def unsetName(): Stream.this.type
    Definition Classes
    Nameable
  196. def valCallback[T](ref: T, name: String): T
    Definition Classes
    ValCallbackRec → ValCallback
  197. def valCallbackOn(ref: Any, name: String, refs: Set[Any]): Unit
    Definition Classes
    ValCallbackRec
  198. def valCallbackRec(ref: Any, name: String): Unit
    Definition Classes
    Bundle → ValCallbackRec
  199. val valid: Bool
    Definition Classes
    Stream → DataCarrier
  200. def validPipe(): Stream[T]
  201. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  202. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  203. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  204. def ~[T2 <: Data](that: T2): Stream[T2]
  205. 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
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from DataCarrier[T]

Inherited from IMasterSlave

Inherited from Bundle

Inherited from ValCallbackRec

Inherited from ValCallback

Inherited from MultiData

Inherited from Data

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