Packages

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

Linear Supertypes
DataCarrier[T], IMasterSlave, Bundle, OverridedEqualsHashCode, MultiData, Data, 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. OverridedEqualsHashCode
  6. MultiData
  7. Data
  8. SpinalTagReady
  9. Assignable
  10. NameableByComponent
  11. Nameable
  12. OwnableRef
  13. ContextUser
  14. ScalaLocated
  15. GlobalDataUser
  16. AnyRef
  17. 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]]
  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 clone(): Stream[T]
    Definition Classes
    Stream → Bundle → Data → AnyRef
  46. def component: Component
    Definition Classes
    ContextUser
  47. final def compositAssignFrom(that: AnyRef, target: AnyRef, kind: AnyRef): Unit
    Definition Classes
    Assignable
  48. val compositeAssign: Assignable
    Definition Classes
    Assignable
  49. def connectFrom(that: Stream[T]): Stream[T]
  50. def continueWhen(cond: Bool): Stream[T]

    Block this when cond is False.

    Block this when cond is False. Return the resulting stream

  51. def dirString(): String
    Definition Classes
    Data
  52. def dontSimplifyIt(): Stream.this.type
    Definition Classes
    Data
  53. def elements: ArrayBuffer[(String, Data)]
    Definition Classes
    Bundle → MultiData
  54. def elementsString: String
    Definition Classes
    MultiData
  55. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  56. def equals(obj: Any): Boolean
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  57. def existsTag(cond: (SpinalTag) ⇒ Boolean): Boolean
    Definition Classes
    SpinalTagReady
  58. def filterTag(cond: (SpinalTag) ⇒ Boolean): Iterable[SpinalTag]
    Definition Classes
    SpinalTagReady
  59. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  60. def find(name: String): Data
    Definition Classes
    MultiData
  61. def findTag(cond: (SpinalTag) ⇒ Boolean): Option[SpinalTag]
    Definition Classes
    SpinalTagReady
  62. def fire: Bool

    Return True when a transaction occure on the bus (Valid && ready)

    Return True when a transaction occure on the bus (Valid && ready)

    Definition Classes
    Stream → DataCarrier
  63. def flatten: Seq[BaseType]
    Definition Classes
    MultiData → Data
  64. def flattenForeach(body: (BaseType) ⇒ Unit): Unit
    Definition Classes
    MultiData → Data
  65. def flattenLocalName: Seq[String]
    Definition Classes
    MultiData → Data
  66. def flip(): Stream.this.type
    Definition Classes
    MultiData → Data
  67. def foreachReflectableNameables(doThat: (Any) ⇒ Unit): Unit
    Definition Classes
    Nameable
  68. def fragmentTransaction(bitsWidth: Int): Stream[Fragment[Bits]]
  69. def freeRun(): Stream.this.type
    Definition Classes
    Stream → DataCarrier
  70. def genIf(cond: Boolean): Stream.this.type
    Definition Classes
    Data
  71. def getBitsWidth: Int
    Definition Classes
    MultiData → Data
  72. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  73. def getComponent(): Component
    Definition Classes
    Data → NameableByComponent
  74. def getComponents(): Seq[Component]
    Definition Classes
    Data
  75. def getDisplayName(): String
    Definition Classes
    Nameable
  76. def getInstanceCounter: Int
    Definition Classes
    ContextUser
  77. def getMode: Byte
    Attributes
    protected
    Definition Classes
    Nameable
  78. def getName(default: String): String
    Definition Classes
    NameableByComponent → Nameable
  79. def getName(): String
    Definition Classes
    Nameable
  80. def getRealSource: Any
    Definition Classes
    Assignable
  81. def getRealSourceNoRec: Any
    Definition Classes
    Data → Assignable
  82. def getRefOwnersChain(): List[Any]
    Definition Classes
    OwnableRef
  83. def getRootParent: Data
    Definition Classes
    Data
  84. def getScalaLocationLong: String
    Definition Classes
    ScalaLocated
  85. def getScalaLocationShort: String
    Definition Classes
    ScalaLocated
  86. def getScalaTrace(): Throwable
    Definition Classes
    ScalaLocated
  87. def getTag[T <: SpinalTag](clazz: Class[T]): Option[T]
    Definition Classes
    SpinalTagReady
  88. def getTags(): Set[SpinalTag]
    Definition Classes
    SpinalTagReady
  89. def getTypeString: String
    Definition Classes
    Stream → Bundle
  90. def getZero: Stream.this.type
    Definition Classes
    MultiData → Data
  91. val globalData: GlobalData
    Definition Classes
    GlobalDataUser
  92. def halfPipe(): Stream[T]

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

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

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

    Return True when a transaction is appear (first cycle)

  113. def isOutput: Boolean
    Definition Classes
    Data
  114. def isOutputOrInOut: Boolean
    Definition Classes
    Data
  115. def isPriorityApplicable(namePriority: Byte): Boolean
    Definition Classes
    Nameable
  116. def isReg: Boolean
    Definition Classes
    Data
  117. def isStall: Bool

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

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

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

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

    Connect this to a fifo and return its pop stream

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

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

  138. def queueWithAvailability(size: Int): (Stream[T], UInt)
  139. def queueWithOccupancy(size: Int): (Stream[T], UInt)

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

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

  141. def randBoot(): Stream.this.type
    Definition Classes
    Data
  142. val ready: Bool
  143. val refOwner: RefOwnerType
    Definition Classes
    OwnableRef
    Annotations
    @dontName()
  144. def reflectNames(): Unit
    Definition Classes
    Nameable
  145. def removeAssignments(): Stream.this.type
    Definition Classes
    Data
  146. def removeTag(spinalTag: SpinalTag): Stream.this.type
    Definition Classes
    SpinalTagReady
  147. def removeTags(tags: Iterable[SpinalTag]): Stream.this.type
    Definition Classes
    SpinalTagReady
  148. def resized: Stream.this.type
    Definition Classes
    Data
  149. def s2mPipe(stagesCount: Int): Stream[T]
  150. def s2mPipe(): Stream[T]
  151. def setAsAnalog(): Stream.this.type
    Definition Classes
    Data
  152. def setAsComb(): Stream.this.type
    Definition Classes
    MultiData → Data
  153. def setAsDirectionLess(): Stream.this.type
    Definition Classes
    MultiData → Data
  154. def setAsReg(): Stream.this.type
    Definition Classes
    MultiData → Data
  155. def setCompositeName(nameable: Nameable, postfix: String, namePriority: Byte): Stream.this.type
    Definition Classes
    Nameable
  156. def setCompositeName(nameable: Nameable, postfix: String, weak: Boolean): Stream.this.type
    Definition Classes
    Nameable
  157. def setCompositeName(nameable: Nameable, postfix: String): Stream.this.type
    Definition Classes
    Nameable
  158. def setCompositeName(nameable: Nameable, namePriority: Byte): Stream.this.type
    Definition Classes
    Nameable
  159. def setCompositeName(nameable: Nameable, weak: Boolean): Stream.this.type
    Definition Classes
    Nameable
  160. def setCompositeName(nameable: Nameable): Stream.this.type
    Definition Classes
    Nameable
  161. def setName(name: String, namePriority: Byte): Stream.this.type
    Definition Classes
    Nameable
  162. def setName(name: String, weak: Boolean): Stream.this.type
    Definition Classes
    Nameable
  163. def setName(name: String): Stream.this.type
    Definition Classes
    Nameable
  164. def setPartialName(name: String, namePriority: Byte): Stream.this.type
    Definition Classes
    Nameable
  165. def setPartialName(name: String, weak: Boolean): Stream.this.type
    Definition Classes
    Nameable
  166. def setPartialName(owner: Nameable, name: String, namePriority: Byte): Stream.this.type
    Definition Classes
    Nameable
  167. def setPartialName(owner: Nameable, name: String, weak: Boolean): Stream.this.type
    Definition Classes
    Nameable
  168. def setPartialName(name: String): Stream.this.type
    Definition Classes
    Nameable
  169. def setPartialName(owner: Nameable, name: String): Stream.this.type
    Definition Classes
    Nameable
  170. def setRefOwner(that: Any): Unit
    Definition Classes
    OwnableRef
  171. def setScalaLocated(source: ScalaLocated): Stream.this.type
    Definition Classes
    ScalaLocated
  172. def setWeakName(name: String): Stream.this.type
    Definition Classes
    Nameable
  173. def spinalTags: Set[SpinalTag]
    Definition Classes
    SpinalTagReady
  174. def stage(): Stream[T]

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

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

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

  178. def toEvent(): Event
  179. def toFlow: Flow[T]

    returns

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

  180. def toString(): String
    Definition Classes
    Bundle → Nameable → AnyRef → Any
  181. def translateFrom[T2 <: Data](that: Stream[T2])(dataAssignment: (T, payload.type) ⇒ Unit): Stream[T]
  182. def translateInto[T2 <: Data](into: Stream[T2])(dataAssignment: (T2, T) ⇒ Unit): Stream[T2]
  183. def translateWith[T2 <: Data](that: T2): Stream[T2]
  184. def unsetName(): Stream.this.type
    Definition Classes
    Nameable
  185. val valid: Bool
    Definition Classes
    Stream → DataCarrier
  186. def validPipe(): Stream[T]
  187. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  188. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  189. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  190. def ~[T2 <: Data](that: T2): Stream[T2]
  191. 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

Inherited from DataCarrier[T]

Inherited from IMasterSlave

Inherited from Bundle

Inherited from OverridedEqualsHashCode

Inherited from MultiData

Inherited from Data

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