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. 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: LinkedHashSet[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 allowPartialyAssigned: Stream.this.type
    Definition Classes
    Data
  25. def allowPruning(): Stream.this.type
    Definition Classes
    Data
  26. def allowSimplifyIt(): Stream.this.type
    Definition Classes
    Data
  27. def allowUnsetRegToAvoidLatch: Stream.this.type
    Definition Classes
    Data
  28. def arbitrationFrom[T2 <: Data](that: Stream[T2]): Unit

    Drive arbitration signals of this from that

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

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

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

    Block this when cond is False.

    Block this when cond is False. Return the resulting stream

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

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

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

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

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

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

    Return True when a transaction has appeared (first cycle)

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

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

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

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

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

    Connect this to a fifo and return its pop stream

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

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

  148. def queueWithAvailability(size: Int): (Stream[T], UInt)
  149. def queueWithOccupancy(size: Int): (Stream[T], UInt)

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

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

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

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

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

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

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

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

  191. def toEvent(): Event

    Ignore the payload

  192. def toFlow: Flow[T]

    returns

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

  193. def toFlowFire: Flow[T]
  194. def toString(): String
    Definition Classes
    Bundle → Nameable → AnyRef → Any
  195. def translateFrom[T2 <: Data](that: Stream[T2])(dataAssignment: (T, payload.type) ⇒ Unit): Stream[T]
  196. def translateInto[T2 <: Data](into: Stream[T2])(dataAssignment: (T2, T) ⇒ Unit): Stream[T2]
  197. def translateWith[T2 <: Data](that: T2): Stream[T2]

    Replace this stream's payload with another one

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

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