Packages

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

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

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

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

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

    Return True when a transaction is appear (first cycle)

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

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

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

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

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

    Connect this to a fifo and return its pop stream

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

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

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

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

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

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

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

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

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

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

    returns

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

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