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, InComponent, 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. InComponent
  10. OverridedEqualsHashCode
  11. SpinalTagReady
  12. Assignable
  13. NameableByComponent
  14. Nameable
  15. OwnableRef
  16. ContextUser
  17. ScalaLocated
  18. GlobalDataUser
  19. AnyRef
  20. 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 #*(count: Int): Bits

    Permalink
    Definition Classes
    Data
  5. def &(cond: Bool): Stream[T]

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

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

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

    Permalink

    Connect that to this.

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

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

    Permalink

    Connect that to this

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

    Permalink
    Definition Classes
    AnyRef → Any
  11. 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

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

  13. def >/>(that: Stream[T]): Stream[T]

    Permalink

    Connect this to that.

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

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

    Permalink

    Connect this to that

  15. var _spinalTags: LinkedHashSet[SpinalTag]

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

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

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  20. def addFragmentLast(counter: Counter): Stream[Fragment[T]]

    Permalink

    Like addFragmentLast(Bool), but instead of manually telling which values go together, let a counter do the job.

    Like addFragmentLast(Bool), but instead of manually telling which values go together, let a counter do the job. The counter will increment for each passing element. Last will be set high at the end of each revolution.

    Example:
    1. outStream = inStream.addFragmentLast(new Counter(5))
  21. def addFragmentLast(last: Bool): Stream[Fragment[T]]

    Permalink

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

    Convert this stream to a fragmented stream by adding a last bit. To view it from another perspective, bundle together successive events as fragments of a larger whole. You can then use enhanced operations on fragmented streams, like reducing of elements.

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  24. def allowDirectionLessIo(): Stream.this.type

    Permalink
    Definition Classes
    Data
  25. def allowOverride(): Stream.this.type

    Permalink
    Definition Classes
    Data
  26. def allowPartialyAssigned(): Stream.this.type

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

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

    Permalink
    Definition Classes
    Data
  29. def allowUnsetRegToAvoidLatch(): Stream.this.type

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

    Permalink

    Drive arbitration signals of this from that

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

    Permalink
    Definition Classes
    Data
  32. def asBits: Bits

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

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

    Permalink
  35. def asFlow: Flow[T]

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

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

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

    Permalink
    Definition Classes
    Any
  39. def asOutput(): Stream.this.type

    Permalink
    Definition Classes
    MultiData → Data
  40. def assignAllByName(that: Bundle): Unit

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

    Permalink
    Definition Classes
    Data
  42. def assignDontCareToUnasigned(): Stream.this.type

    Permalink
    Definition Classes
    Data
  43. def assignFormalRandom(kind: RandomExpKind): Unit

    Permalink
    Definition Classes
    MultiData → Data
  44. final def assignFrom(that: AnyRef, target: AnyRef)(implicit loc: Location): Unit

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

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

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

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

    Permalink
    Definition Classes
    Bundle
  49. def assignUnassignedByName(that: MultiData): Unit

    Permalink
    Definition Classes
    MultiData
  50. def bundleAssign(that: Bundle)(f: (Data, Data) ⇒ Unit): Unit

    Permalink
    Definition Classes
    Bundle
  51. def ccToggle(pushClock: ClockDomain, popClock: ClockDomain): Stream[T]

    Permalink
  52. def ccToggleWithoutBuffer(pushClock: ClockDomain, popClock: ClockDomain): Stream[T]

    Permalink
  53. def clearAll(): Stream.this.type

    Permalink
    Definition Classes
    Data
  54. def clearValidWhen(cond: Bool): Stream[T]

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

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

    Permalink

    A combinatorial stage doesn't do anything, but it is nice to separate signals for combinatorial transformations.

  57. def component: Component

    Permalink
    Definition Classes
    ContextUser
  58. final def compositAssignFrom(that: AnyRef, target: AnyRef, kind: AnyRef)(implicit loc: Location): Unit

    Permalink
    Definition Classes
    Assignable
  59. var compositeAssign: Assignable

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

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

    Permalink

    Block this when cond is False.

    Block this when cond is False. Return the resulting stream

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

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

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

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

    Permalink
    Definition Classes
    Bundle → MultiData
  66. var elementsCache: ArrayBuffer[(String, Data)]

    Permalink
    Definition Classes
    Bundle
  67. def elementsString: String

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

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

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

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

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  74. 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
  75. def flatten: Seq[BaseType]

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

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

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

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  81. def forkSerial(cond: Bool): Stream[T]

    Permalink
  82. def formalAssertsMaster(payloadInvariance: Boolean = true)(implicit loc: Location): Composite[Stream[T]] { val stack: String }

    Permalink

    Assert that this stream conforms to the stream semantics: https://spinalhdl.github.io/SpinalDoc-RTD/dev/SpinalHDL/Libraries/stream.html#semantics - After being asserted, valid may only be deasserted once the current payload was acknowleged.

    Assert that this stream conforms to the stream semantics: https://spinalhdl.github.io/SpinalDoc-RTD/dev/SpinalHDL/Libraries/stream.html#semantics - After being asserted, valid may only be deasserted once the current payload was acknowleged.

    payloadInvariance

    Check that the payload does not change when valid is high and ready is low.

  83. def formalAssertsOrder(dataAhead: T, dataBehind: T)(implicit loc: Location): (Bool, Bool)

    Permalink
  84. def formalAssertsTimeout(maxStallCycles: Int = 0): Composite[Stream[T]] { val logic: spinal.core.Area{val counter: spinal.lib.Counter} }

    Permalink

    Assert that this stream conforms to the stream semantics: https://spinalhdl.github.io/SpinalDoc-RTD/dev/SpinalHDL/Libraries/stream.html#semantics - After being asserted, valid should be acknowledged in limited cycles.

    Assert that this stream conforms to the stream semantics: https://spinalhdl.github.io/SpinalDoc-RTD/dev/SpinalHDL/Libraries/stream.html#semantics - After being asserted, valid should be acknowledged in limited cycles.

    maxStallCycles

    Check that the max cycles the interface would hold in stall.

  85. def formalAssumesOrder(dataAhead: T, dataBehind: T)(implicit loc: Location): (Bool, Bool)

    Permalink
  86. def formalAssumesSlave(payloadInvariance: Boolean = true)(implicit loc: Location): Composite[Stream[T]]

    Permalink
  87. def formalAssumesTimeout(maxStallCycles: Int = 0): Composite[Stream[T]] { val logic: spinal.core.Area{val counter: spinal.lib.Counter} }

    Permalink
  88. def formalCovers(back2BackCycles: Int = 1): Composite[Stream[T]] { val hist: spinal.core.Bool }

    Permalink
  89. def fragmentTransaction(bitsWidth: Int): Stream[Fragment[Bits]]

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

    Permalink
    Definition Classes
    StreamDataCarrier
  91. def freeze(): Stream.this.type

    Permalink
    Definition Classes
    MultiData → Data
  92. def getAheadValue(): Stream.this.type

    Permalink
    Definition Classes
    Data
  93. def getBitsWidth: Int

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

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

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

    Permalink
    Definition Classes
    InComponent
  97. def getDirection: IODirection

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

    Permalink
    Definition Classes
    Nameable
  99. def getInstanceCounter: Int

    Permalink
    Definition Classes
    ContextUser
  100. def getMode: Byte

    Permalink
    Attributes
    protected
    Definition Classes
    Nameable
  101. def getMuxType[T <: Data](list: TraversableOnce[T]): HardType[T]

    Permalink
    Definition Classes
    Data
  102. def getName(default: String): String

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

    Permalink
    Definition Classes
    NameableByComponent → Nameable
  104. def getPartialName(): String

    Permalink
    Definition Classes
    Nameable
  105. def getPath(from: Component, to: Component): Seq[Component]

    Permalink
    Definition Classes
    NameableByComponent
  106. def getRealSource: Any

    Permalink
    Definition Classes
    Assignable
  107. def getRealSourceNoRec: Any

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

    Permalink
    Definition Classes
    OwnableRef
  109. def getRootParent: Data

    Permalink
    Definition Classes
    Data
  110. def getRtlPath(separator: String): String

    Permalink
    Definition Classes
    Data
  111. def getScalaLocationLong: String

    Permalink
    Definition Classes
    ScalaLocated
  112. def getScalaLocationShort: String

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  115. def getTags(): LinkedHashSet[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady
  116. def getTypeString: String

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

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

    Permalink
    Definition Classes
    GlobalDataUser
  119. def halfPipe(flush: Bool = null): Stream[T]

    Permalink

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

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

  121. var hardtype: HardType[_]

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

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

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

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

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  128. final def intoMaster(): Stream.this.type

    Permalink

    Convert into master

    Convert into master

    Definition Classes
    IMasterSlave
  129. final def intoSlave(): Stream.this.type

    Permalink

    Convert into slave

    Convert into slave

    Definition Classes
    IMasterSlave
  130. def isAnalog: Boolean

    Permalink
    Definition Classes
    Data
  131. def isComb: Boolean

    Permalink
    Definition Classes
    Data
  132. def isCompletelyUnnamed: Boolean

    Permalink
    Definition Classes
    Nameable
  133. def isDirectionLess: Boolean

    Permalink
    Definition Classes
    Data
  134. def isEmptyOfTag: Boolean

    Permalink
    Definition Classes
    SpinalTagReady
  135. def isFree: Bool

    Permalink

    Return True when the bus is ready, but no data is present

  136. def isInOut: Boolean

    Permalink
    Definition Classes
    Data
  137. def isInput: Boolean

    Permalink
    Definition Classes
    Data
  138. def isInputOrInOut: Boolean

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

    Permalink
    Definition Classes
    Any
  140. final def isMasterInterface: Boolean

    Permalink

    Are port directions set for a Master interface?

    Are port directions set for a Master interface?

    Definition Classes
    IMasterSlave
  141. def isNamed: Boolean

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

    Permalink

    Return True when a transaction has appeared (first cycle)

  143. def isOutput: Boolean

    Permalink
    Definition Classes
    Data
  144. def isOutputOrInOut: Boolean

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

    Permalink
    Definition Classes
    Nameable
  146. def isReg: Boolean

    Permalink
    Definition Classes
    Data
  147. def isRegOnAssign: Boolean

    Permalink
    Definition Classes
    Data
  148. final def isSlaveInterface: Boolean

    Permalink

    Are port directions set for a Master interface?

    Are port directions set for a Master interface?

    Definition Classes
    IMasterSlave
  149. def isStall: Bool

    Permalink

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

  150. def isUnnamed: Boolean

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

    Permalink
  152. def map[T2 <: Data](translate: (T) ⇒ T2): Stream[T2]

    Permalink
  153. var name: String

    Permalink
    Definition Classes
    Nameable
  154. var nameableRef: Nameable

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

    Permalink
    Definition Classes
    AnyRef
  156. def noBackendCombMerge(): Stream.this.type

    Permalink
    Definition Classes
    Data
  157. def noCombLoopCheck(): Stream.this.type

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

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  161. def overrideLocalName(name: String): Stream.this.type

    Permalink
    Definition Classes
    Nameable
  162. var parent: Data

    Permalink
    Definition Classes
    Data
  163. var parentScope: ScopeStatement

    Permalink
    Definition Classes
    ContextUser
  164. val payload: T

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

    Permalink
  166. def pipelined(m2s: Boolean = false, s2m: Boolean = false, halfRate: Boolean = false): Stream[T]

    Permalink
  167. def pipelined(pipe: StreamPipe): Stream[T]

    Permalink
  168. def pull(propagateName: Boolean): Stream.this.type

    Permalink
    Definition Classes
    Data
  169. def pull(): Stream.this.type

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

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

    Permalink

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

  172. def queue(size: Int, latency: Int = 2, forFMax: Boolean = false): Stream[T]

    Permalink

    Connect this to a fifo and return its pop stream

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

    Permalink

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

  174. def queueWithAvailability(size: Int, latency: Int = 2, forFMax: Boolean = false): (Stream[T], UInt)

    Permalink
  175. def queueWithOccupancy(size: Int, latency: Int = 2, forFMax: Boolean = false): (Stream[T], UInt)

    Permalink

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

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

  177. def randBoot(u: Unit): Stream.this.type

    Permalink
    Definition Classes
    Data
  178. val ready: Bool

    Permalink
  179. var refOwner: RefOwnerType

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

    Permalink
    Definition Classes
    Nameable
  181. def removeAssignments(data: Boolean, init: Boolean, initial: Boolean): Stream.this.type

    Permalink
    Definition Classes
    Data
  182. def removeDataAssignments(): Stream.this.type

    Permalink
    Definition Classes
    Data
  183. def removeInitAssignments(): Stream.this.type

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  186. 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.

  187. def resized: Stream.this.type

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

    Permalink
  189. def s2mPipe(flush: Bool = null): Stream[T]

    Permalink
  190. var scalaTrace: Throwable

    Permalink
    Definition Classes
    ScalaLocated
  191. def setAll(): Stream.this.type

    Permalink
    Definition Classes
    Data
  192. def setAsAnalog(): Stream.this.type

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

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

    Permalink
    Definition Classes
    MultiData → Data
  195. final def setAsMaster(): Unit

    Permalink

    Set as master interface

    Set as master interface

    Definition Classes
    IMasterSlave
  196. def setAsReg(): Stream.this.type

    Permalink
    Definition Classes
    MultiData → Data
  197. final def setAsSlave(): Unit

    Permalink

    Set a slave interface

    Set a slave interface

    Definition Classes
    IMasterSlave
  198. def setBlocked(): Stream.this.type

    Permalink
  199. def setCompositeName(nameable: Nameable, postfix: String, namePriority: Byte): Stream.this.type

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

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

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

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

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

    Permalink
    Definition Classes
    Nameable
  205. def setIdle(): Stream.this.type

    Permalink
  206. def setLambdaName(isNameBody: ⇒ Boolean)(nameGen: ⇒ String): Stream.this.type

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

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

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

    Permalink
    Definition Classes
    Nameable
  210. def setNameAsWeak(): Stream.this.type

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    Nameable
  218. def setPartialName(owner: Nameable): Stream.this.type

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

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

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

    Permalink
    Definition Classes
    Nameable
  222. 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 0 to factor-1 cycles of latency. Mapping a stream into memory and mapping a slowed down stream into memory should yield the same result, thus the elements of the input will be written from high bits to low bits.

  223. def spinalTags: LinkedHashSet[SpinalTag]

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

    Permalink

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

  225. def swapPayload[T2 <: Data](that: HardType[T2]): Stream[T2]

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

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

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

  229. def toEvent(): Event

    Permalink

    Ignore the payload

  230. def toFlow: Flow[T]

    Permalink

    returns

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

  231. def toFlowFire: Flow[T]

    Permalink
  232. def toIo(): Stream.this.type

    Permalink
    Definition Classes
    Data
  233. def toMuxInput[T <: Data](muxOutput: T): T

    Permalink
    Definition Classes
    Data
  234. def toReg(init: T): T

    Permalink
  235. def toReg(): T

    Permalink
  236. def toString(): String

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

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

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

    Permalink

    Replace this stream's payload with another one

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

  241. def unfreeze(): Stream.this.type

    Permalink
    Definition Classes
    MultiData → Data
  242. def unsetName(): Stream.this.type

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  251. def wrapNext(): Stream.this.type

    Permalink
    Definition Classes
    Data
  252. def zipByName(that: MultiData, rec: ArrayBuffer[(BaseType, BaseType)]): ArrayBuffer[(BaseType, BaseType)]

    Permalink
    Definition Classes
    MultiData
  253. def ~[T2 <: Data](that: T2): Stream[T2]

    Permalink
  254. 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 asMaster(): Unit

    Permalink

    Override it to define port directions for a master interface.

    Override it to define port directions for a master interface.

    Definition Classes
    StreamIMasterSlave
    Deprecated

    This method must be overriden but not called. Calling this method is not correct. Call setAsMaster() or intoMaster() instead. This method is named asXxx but it does not return Xxx. This method does not update isMasterInterface and isSlaveInterface.

  3. def asSlave(): Unit

    Permalink

    Override it to define port directions for a master interface.

    Override it to define port directions for a master interface.

    If not overriden, defaults to the opposite port directions of asMaster().

    Definition Classes
    IMasterSlave
    Deprecated

    This method can be overriden but not called. Calling this method is not correct. Call setAsSlave() or intoSlave() instead. This method is named asXxx but it does not return Xxx. This method does not update isMasterInterface and isSlaveInterface.

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

  5. def genIf(cond: Boolean): Stream.this.type

    Permalink
    Definition Classes
    Data
    Annotations
    @deprecated
    Deprecated

    does not work with <>, use 'someBool generate Type()' or 'if(condition) Type() else null' instead

Inherited from DataCarrier[T]

Inherited from IMasterSlave

Inherited from Bundle

Inherited from ValCallbackRec

Inherited from ValCallback

Inherited from MultiData

Inherited from Data

Inherited from InComponent

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