Class/Object

spinal.lib

Stream

Related Docs: object Stream | package lib

Permalink

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])

    Permalink

Type Members

  1. abstract type RefOwnerType

    Permalink
    Definition Classes
    OwnableRef

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. def ##(right: Data): Bits

    Permalink
    Definition Classes
    Data
  3. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  4. def &(cond: Bool): Stream[T]

    Permalink
  5. def <-/<(that: Stream[T]): Stream[T]

    Permalink

    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]

    Permalink

    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]

    Permalink

    Connect that to this.

    Connect that to this. The ready path is cut by an register stage

  8. def <<(that: Stream[T]): Stream[T]

    Permalink

    Connect that to this

  9. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  10. def >->(into: Stream[T]): Stream[T]

    Permalink

    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]

    Permalink

    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]

    Permalink

    Connect this to that.

    Connect this to that. The ready path is cut by an register stage

  13. def >>(into: Stream[T]): Stream[T]

    Permalink

    Connect this to that

  14. var _spinalTags: Set[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady
  15. def addAttribute(attribute: Attribute): Stream.this.type

    Permalink
    Definition Classes
    Data → SpinalTagReady
  16. def addAttribute(name: String, value: String): Stream.this.type

    Permalink
    Definition Classes
    SpinalTagReady
  17. def addAttribute(name: String): Stream.this.type

    Permalink
    Definition Classes
    SpinalTagReady
  18. def addFragmentLast(last: Bool): Stream[Fragment[T]]

    Permalink

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

  19. def addTag[T <: SpinalTag](spinalTag: T): Stream.this.type

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

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

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

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

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

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

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

    Permalink

    Drive arbitration signals of this from that

  27. def as[T <: Data](dataType: HardType[T]): T

    Permalink
    Definition Classes
    Data
  28. def asBits: Bits

    Permalink
    Definition Classes
    MultiData → Data
  29. def asData: Data

    Permalink
    Definition Classes
    Data
  30. def asDataStream: Stream[Data]

    Permalink
  31. def asFlow: Flow[T]

    Permalink
  32. def asInOut(): Stream.this.type

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

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

    Permalink
    Definition Classes
    Any
  35. def asMaster(): Unit

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    Bundle
  45. def clearValidWhen(cond: Bool): Stream[T]

    Permalink
  46. def clone(): Stream[T]

    Permalink
    Definition Classes
    Stream → Bundle → Data → AnyRef
  47. def combStage(): Stream[T]

    Permalink
  48. def component: Component

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

    Permalink
    Definition Classes
    Assignable
  50. var compositeAssign: Assignable

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

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

    Permalink

    Block this when cond is False.

    Block this when cond is False. Return the resulting stream

  53. def copyDirectionOfImpl(that: Data): Stream.this.type

    Permalink
    Definition Classes
    MultiData → Data
  54. def dirString(): String

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

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

    Permalink
    Definition Classes
    Bundle → MultiData
  57. def elementsString: String

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

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

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  62. def find(name: String): Data

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

    Permalink
    Definition Classes
    SpinalTagReady
  64. def fire: Bool

    Permalink

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

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

    Definition Classes
    StreamDataCarrier
  65. def flatten: Seq[BaseType]

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

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

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

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

    Permalink
    Definition Classes
    Nameable
  70. def foreachTag(body: (SpinalTag) ⇒ Unit): Unit

    Permalink
    Definition Classes
    SpinalTagReady
  71. def fragmentTransaction(bitsWidth: Int): Stream[Fragment[Bits]]

    Permalink
  72. def freeRun(): Stream.this.type

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

    Permalink
    Definition Classes
    Data
  74. def getBitsWidth: Int

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

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  76. def getComponent(): Component

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

    Permalink
    Definition Classes
    Data
  78. def getDirection: IODirection

    Permalink
    Definition Classes
    Data
  79. def getDisplayName(): String

    Permalink
    Definition Classes
    Nameable
  80. def getInstanceCounter: Int

    Permalink
    Definition Classes
    ContextUser
  81. def getMode: Byte

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

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

    Permalink
    Definition Classes
    Nameable
  84. def getPartialName(): String

    Permalink
    Definition Classes
    Nameable
  85. def getRealSource: Any

    Permalink
    Definition Classes
    Assignable
  86. def getRealSourceNoRec: Any

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

    Permalink
    Definition Classes
    OwnableRef
  88. def getRootParent: Data

    Permalink
    Definition Classes
    Data
  89. def getScalaLocationLong: String

    Permalink
    Definition Classes
    ScalaLocated
  90. def getScalaLocationShort: String

    Permalink
    Definition Classes
    ScalaLocated
  91. def getScalaTrace(): Throwable

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  94. def getTypeString: String

    Permalink
    Definition Classes
    Stream → Bundle
  95. def getZero: Stream.this.type

    Permalink
    Definition Classes
    MultiData → Data
  96. val globalData: GlobalData

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

    Permalink

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

  98. def haltWhen(cond: Bool): Stream[T]

    Permalink

    Stop transactions on this when cond is True.

    Stop transactions on this when cond is True. Return the resulting stream

  99. var hardtype: HardType[_]

    Permalink
    Definition Classes
    Bundle
  100. def hasTag[T <: SpinalTag](clazz: Class[T]): Boolean

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

    Permalink
    Definition Classes
    SpinalTagReady
  102. def hashCode(): Int

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  105. def instanceAttributes: Iterable[Attribute]

    Permalink
    Definition Classes
    SpinalTagReady
  106. def isAnalog: Boolean

    Permalink
    Definition Classes
    Data
  107. def isComb: Boolean

    Permalink
    Definition Classes
    Data
  108. def isDirectionLess: Boolean

    Permalink
    Definition Classes
    Data
  109. def isEmptyOfTag: Boolean

    Permalink
    Definition Classes
    SpinalTagReady
  110. def isFree: Bool

    Permalink
  111. def isInOut: Boolean

    Permalink
    Definition Classes
    Data
  112. def isInput: Boolean

    Permalink
    Definition Classes
    Data
  113. def isInputOrInOut: Boolean

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

    Permalink
    Definition Classes
    Any
  115. var isMasterInterface: Boolean

    Permalink
    Definition Classes
    IMasterSlave
  116. def isNamed: Boolean

    Permalink
    Definition Classes
    NameableByComponent → Nameable
  117. def isNew: Bool

    Permalink

    Return True when a transaction has appeared (first cycle)

  118. def isOutput: Boolean

    Permalink
    Definition Classes
    Data
  119. def isOutputOrInOut: Boolean

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

    Permalink
    Definition Classes
    Nameable
  121. def isReg: Boolean

    Permalink
    Definition Classes
    Data
  122. def isStall: Bool

    Permalink

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

  123. def isUnnamed: Boolean

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

    Permalink
    Definition Classes
    Data
  125. def m2sPipe(collapsBubble: Boolean = true, crossClockData: Boolean = false, flush: Bool = null): Stream[T]

    Permalink
  126. var name: String

    Permalink
    Attributes
    protected
    Definition Classes
    Nameable
  127. var nameableRef: Nameable

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

    Permalink
    Definition Classes
    AnyRef
  129. def noBackendCombMerge: Stream.this.type

    Permalink
    Definition Classes
    Data
  130. def noCombLoopCheck: Stream.this.type

    Permalink
    Definition Classes
    Data
  131. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  132. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  133. def onEachAttributes(doIt: (Attribute) ⇒ Unit): Unit

    Permalink
    Definition Classes
    SpinalTagReady
  134. var parent: Data

    Permalink
    Definition Classes
    Data
  135. var parentScope: ScopeStatement

    Permalink
    Definition Classes
    ContextUser
  136. val payload: T

    Permalink
    Definition Classes
    StreamDataCarrier
  137. val payloadType: HardType[T]

    Permalink
  138. def pull(): Stream.this.type

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

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

    Permalink

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

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

    Permalink

    Connect this to a fifo and return its pop stream

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

    Permalink

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

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

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

    Permalink

    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)

    Permalink

    Connect this to a cross clock domain fifo and return its pop stream and its push side occupancy

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

    Permalink
    Definition Classes
    Data
  147. val ready: Bool

    Permalink
  148. var refOwner: RefOwnerType

    Permalink
    Definition Classes
    OwnableRef
  149. def reflectNames(): Unit

    Permalink
    Definition Classes
    Nameable
  150. def removeAssignments(): Stream.this.type

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  153. def repeat(times: Int): (Stream[T], UInt)

    Permalink

    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

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

    Permalink
  156. def s2mPipe(): Stream[T]

    Permalink
  157. def setAsAnalog(): Stream.this.type

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    Nameable
  179. def slowdown(factor: Int): Stream[Vec[T]]

    Permalink

    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]

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

    Permalink

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

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

    Permalink
    Definition Classes
    AnyRef
  183. def takeWhen(cond: Bool): Stream[T]

    Permalink

    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]

    Permalink

    Drop transactions of this when cond is True.

    Drop transactions of this when cond is True. Return the resulting stream

  185. def toEvent(): Event

    Permalink
  186. def toFlow: Flow[T]

    Permalink

    returns

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

  187. def toString(): String

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

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

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

    Permalink

    Replace this stream's payload with another one

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

    Permalink

    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

    Permalink
    Definition Classes
    Nameable
  193. def valCallback[T](ref: T, name: String): T

    Permalink
    Definition Classes
    ValCallbackRec → ValCallback
  194. def valCallbackOn(ref: Any, name: String, refs: Set[Any]): Unit

    Permalink
    Definition Classes
    ValCallbackRec
  195. def valCallbackRec(ref: Any, name: String): Unit

    Permalink
    Definition Classes
    Bundle → ValCallbackRec
  196. val valid: Bool

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

    Permalink
  198. final def wait(arg0: Long, arg1: Int): Unit

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  200. final def wait(): Unit

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

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

    Permalink

Deprecated Value Members

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

    Permalink
    Definition Classes
    Data
    Annotations
    @deprecated
    Deprecated

    (Since version ???) use setAsDirectionLess instead

  2. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    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