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

    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
  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 clone(): Stream[T]

    Permalink
    Definition Classes
    Stream → Bundle → Data → AnyRef
  46. def component: Component

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

    Permalink
    Definition Classes
    Assignable
  48. var compositeAssign: Assignable

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

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

    Permalink

    Block this when cond is False.

    Block this when cond is False. Return the resulting stream

  51. def dirString(): String

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  59. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  60. def find(name: String): Data

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

    Permalink
    Definition Classes
    SpinalTagReady
  62. def fire: Bool

    Permalink

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    Data
  71. def getBitsWidth: Int

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

    Permalink
    Definition Classes
    AnyRef → Any
  73. def getComponent(): Component

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

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

    Permalink
    Definition Classes
    Nameable
  76. def getInstanceCounter: Int

    Permalink
    Definition Classes
    ContextUser
  77. def getMode: Byte

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

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

    Permalink
    Definition Classes
    Nameable
  80. def getRealSource: Any

    Permalink
    Definition Classes
    Assignable
  81. def getRealSourceNoRec: Any

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

    Permalink
    Definition Classes
    OwnableRef
  83. def getRootParent: Data

    Permalink
    Definition Classes
    Data
  84. def getScalaLocationLong: String

    Permalink
    Definition Classes
    ScalaLocated
  85. def getScalaLocationShort: String

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

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  89. def getTypeString: String

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

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

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

    Permalink

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

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

  94. var hardtype: HardType[_]

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

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

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

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

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  101. def isAnalog: Boolean

    Permalink
    Definition Classes
    Data
  102. def isComb: Boolean

    Permalink
    Definition Classes
    Data
  103. def isDirectionLess: Boolean

    Permalink
    Definition Classes
    Data
  104. def isEmptyOfTag: Boolean

    Permalink
    Definition Classes
    SpinalTagReady
  105. def isFree: Bool

    Permalink
  106. def isInOut: Boolean

    Permalink
    Definition Classes
    Data
  107. def isInput: Boolean

    Permalink
    Definition Classes
    Data
  108. def isInputOrInOut: Boolean

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

    Permalink
    Definition Classes
    Any
  110. var isMasterInterface: Boolean

    Permalink
    Definition Classes
    IMasterSlave
  111. def isNamed: Boolean

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

    Permalink

    Return True when a transaction is appear (first cycle)

  113. def isOutput: Boolean

    Permalink
    Definition Classes
    Data
  114. def isOutputOrInOut: Boolean

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

    Permalink
    Definition Classes
    Nameable
  116. def isReg: Boolean

    Permalink
    Definition Classes
    Data
  117. def isStall: Bool

    Permalink

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

  118. def isUnnamed: Boolean

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

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

    Permalink
  121. var name: String

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  127. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  128. def onEachAttributes(doIt: (Attribute) ⇒ Unit): Unit

    Permalink
    Definition Classes
    SpinalTagReady
  129. var parent: Data

    Permalink
    Definition Classes
    Data
  130. var parentScope: ScopeStatement

    Permalink
    Definition Classes
    ContextUser
  131. val payload: T

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

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

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

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

    Permalink

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

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

    Permalink

    Connect this to a fifo and return its pop stream

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

    Permalink

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

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

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

    Permalink

    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)

    Permalink

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

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

    Permalink
    Definition Classes
    Data
  142. val ready: Bool

    Permalink
  143. var refOwner: RefOwnerType

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

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

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  148. def resized: Stream.this.type

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    Nameable
  173. def spinalTags: Set[SpinalTag]

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

    Permalink

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

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

    Permalink
    Definition Classes
    AnyRef
  176. 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

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

  178. def toEvent(): Event

    Permalink
  179. def toFlow: Flow[T]

    Permalink

    returns

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

  180. def toString(): String

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

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

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

    Permalink
  184. def unsetName(): Stream.this.type

    Permalink
    Definition Classes
    Nameable
  185. val valid: Bool

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

    Permalink
  187. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  188. final def wait(arg0: Long, arg1: Int): Unit

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

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

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

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