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(last: Bool): Stream[Fragment[T]]

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

  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 as[T <: Data](dataType: HardType[T]): T
    Definition Classes
    Data
  28. def asBits: Bits
    Definition Classes
    MultiData → Data
  29. def asData: Data
    Definition Classes
    Data
  30. def asDataStream: Stream[Data]
  31. def asFlow: Flow[T]
  32. def asInOut(): Stream.this.type
    Definition Classes
    MultiData → Data
  33. def asInput(): Stream.this.type
    Definition Classes
    MultiData → Data
  34. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  35. def asMaster(): Unit
    Definition Classes
    Stream → IMasterSlave
  36. def asOutput(): Stream.this.type
    Definition Classes
    MultiData → Data
  37. def asSlave(): Unit
    Definition Classes
    IMasterSlave
  38. def assignAllByName(that: Bundle): Unit
    Definition Classes
    Bundle
  39. def assignDontCare(): Stream.this.type
    Definition Classes
    Data
  40. final def assignFrom(that: AnyRef, target: AnyRef): Unit
    Definition Classes
    Data
  41. def assignFromBits(bits: Bits, hi: Int, lo: Int): Unit
    Definition Classes
    MultiData → Data
  42. def assignFromBits(bits: Bits): Unit
    Definition Classes
    MultiData → Data
  43. def assignFromBits(bits: Bits, offset: Int, bitCount: BitCount): Unit
    Definition Classes
    Data
  44. def assignSomeByName(that: Bundle): Unit
    Definition Classes
    Bundle
  45. def clearValidWhen(cond: Bool): Stream[T]
  46. def clone(): Stream[T]
    Definition Classes
    Stream → Bundle → Data → AnyRef
  47. def combStage(): Stream[T]
  48. def component: Component
    Definition Classes
    ContextUser
  49. final def compositAssignFrom(that: AnyRef, target: AnyRef, kind: AnyRef): Unit
    Definition Classes
    Assignable
  50. val compositeAssign: Assignable
    Definition Classes
    Assignable
  51. def connectFrom(that: Stream[T]): Stream[T]
  52. def continueWhen(cond: Bool): Stream[T]

    Block this when cond is False.

    Block this when cond is False. Return the resulting stream

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

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

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

  99. var hardtype: HardType[_]
    Definition Classes
    Bundle
  100. def hasTag[T <: SpinalTag](clazz: Class[T]): Boolean
    Definition Classes
    SpinalTagReady
  101. def hasTag(spinalTag: SpinalTag): Boolean
    Definition Classes
    SpinalTagReady
  102. def hashCode(): Int
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  103. final def initFrom(that: AnyRef, target: AnyRef): Unit
    Definition Classes
    Data
  104. def instanceAttributes(language: Language): Iterable[Attribute]
    Definition Classes
    SpinalTagReady
  105. def instanceAttributes: Iterable[Attribute]
    Definition Classes
    SpinalTagReady
  106. def isAnalog: Boolean
    Definition Classes
    Data
  107. def isComb: Boolean
    Definition Classes
    Data
  108. def isDirectionLess: Boolean
    Definition Classes
    Data
  109. def isEmptyOfTag: Boolean
    Definition Classes
    SpinalTagReady
  110. def isFree: Bool
  111. def isInOut: Boolean
    Definition Classes
    Data
  112. def isInput: Boolean
    Definition Classes
    Data
  113. def isInputOrInOut: Boolean
    Definition Classes
    Data
  114. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  115. val isMasterInterface: Boolean
    Definition Classes
    IMasterSlave
  116. def isNamed: Boolean
    Definition Classes
    NameableByComponent → Nameable
  117. def isNew: Bool

    Return True when a transaction has appeared (first cycle)

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

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

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

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

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

    Connect this to a fifo and return its pop stream

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

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

  143. def queueWithAvailability(size: Int): (Stream[T], UInt)
  144. def queueWithOccupancy(size: Int): (Stream[T], UInt)

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

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

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

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

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

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

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

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

  185. def toEvent(): Event
  186. def toFlow: Flow[T]

    returns

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

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

    Replace this stream's payload with another one

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

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