Packages

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

A simple interface with master payload valid, slave ready handshake.

When manually reading/driving the signals of a Stream keep in mind that:

  • After being asserted, valid may only be deasserted once the current payload was acknowledged. This means valid can only toggle to 0 the cycle after a the slave did a read by asserting ready.
  • In contrast to that ready may change at any time.
  • A transfer is only done on cycles where both valid and ready are asserted.
  • valid of a Stream must not depend on ready in a combinatorial way and any path between the two must be registered.

It is recommended that valid does not depend on ready at all.

See also

Stream documentation

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

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

    Concatenation between two signals

    Concatenation between two signals

    Definition Classes
    Data
  3. final def ##(): Int
    Definition Classes
    AnyRef → Any
  4. def #*(count: Int): Bits

    Return the count time concatenation of the signal.

    Return the count time concatenation of the signal.

    Definition Classes
    Data
  5. def &(cond: Bool): Stream[T]
  6. def <-/<(that: Stream[T]): Stream[T]

    Connect slaveStream <-/< masterStream.

    Connect slaveStream <-/< masterStream. The valid/payload/ready path are cut by an register stage.

  7. def <-<(that: Stream[T]): Stream[T]

    Connect slaveStream <-< masterStream.

    Connect slaveStream <-< masterStream. The valid/payload path are cut by an register stage.

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

    Connect slaveStream </< masterStream.

    Connect slaveStream </< masterStream. The ready path is cut by an register stage.

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

    Connect slaveStream << masterStream without any registering.

  10. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  11. def >->(into: Stream[T]): Stream[T]

    Connect masterStream >-> slaveStream.

    Connect masterStream >-> slaveStream. The valid/payload path are cut by an register stage.

  12. def >/->(into: Stream[T]): Stream[T]

    Connect masterStream >/-> slaveStream.

    Connect masterStream >/-> slaveStream. The valid/payload/ready path are cut by an register stage.

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

    Connect masterStream >/> slaveStream.

    Connect masterStream >/> slaveStream. The ready path is cut by an register stage.

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

    Connect masterStream >> slaveStream without any registering.

  15. def IFparent: Data
    Definition Classes
    Data
  16. val _spinalTags: LinkedHashSet[SpinalTag]
    Definition Classes
    SpinalTagReady
  17. def addAttribute(attribute: Attribute): Stream.this.type
    Definition Classes
    Data → SpinalTagReady
  18. def addAttribute(name: String, value: Int): Stream.this.type
    Definition Classes
    SpinalTagReady
  19. def addAttribute(name: String, value: String): Stream.this.type
    Definition Classes
    SpinalTagReady
  20. def addAttribute(name: String): Stream.this.type
    Definition Classes
    SpinalTagReady
  21. def addFragmentLast(counter: Counter): Stream[Fragment[T]]

    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))
  22. def addFragmentLast(last: Bool): Stream[Fragment[T]]

    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.

  23. def addTag[T <: SpinalTag](spinalTag: T): Stream.this.type
    Definition Classes
    MultiData → SpinalTagReady
  24. def addTags(h: SpinalTag, tail: SpinalTag*): Stream.this.type
    Definition Classes
    SpinalTagReady
  25. def addTags[T <: SpinalTag](tags: Iterable[T]): Stream.this.type
    Definition Classes
    SpinalTagReady
  26. def allowDirectionLessIo(): Stream.this.type

    Allow a signal of an io Bundle to be directionless.

    Allow a signal of an io Bundle to be directionless.

    Definition Classes
    Data
    See also

    IO Bundle Error Documentation

  27. def allowOverride(): Stream.this.type

    Allow a signal to be overridden.

    Allow a signal to be overridden.

    Definition Classes
    Data
    See also

    Assignment overlap Error Documentation

  28. def allowPartialyAssigned(): Stream.this.type

    Allow a register to be partially assigned

    Allow a register to be partially assigned

    Definition Classes
    Data
  29. def allowPruning(): Stream.this.type
    Definition Classes
    Data
  30. def allowSimplifyIt(): Stream.this.type
    Definition Classes
    Data
  31. def allowUnsetRegToAvoidLatch(): Stream.this.type

    Allow a register to have only an init (no assignments)

    Allow a register to have only an init (no assignments)

    Definition Classes
    Data
    See also

    "Register with only init" Error Documentation

  32. def arbitrationFrom[T2 <: Data](that: Stream[T2]): Unit

    Drive arbitration signals of this Stream from the provided Stream

  33. def as[T <: Data](dataType: HardType[T]): T
    Definition Classes
    Data
  34. def asBits: Bits

    Cast signal to Bits

    Cast signal to Bits

    Definition Classes
    MultiData → Data
  35. def asData: Data
    Definition Classes
    Data
  36. def asDataStream: Stream[Data]
  37. def asFlow: Flow[T]
  38. def asInOut(): Stream.this.type

    Set a signal as inout

    Set a signal as inout

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

    Set a data as input

    Set a data as input

    Definition Classes
    MultiData → Data
  40. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  41. def asOutput(): Stream.this.type

    Set a data as output

    Set a data as output

    Definition Classes
    MultiData → Data
  42. def assertPersistence(): Unit
  43. def assignAllByName(that: Bundle): Unit

    Assign the bundle with an other bundle by name

    Assign the bundle with an other bundle by name

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

    Assign the default 'x' value to all signals composing this type.

    Assign the default 'x' value to all signals composing this type.

    Definition Classes
    Data
    See also

    Data type documentation

    "Don't care term" wikipedia article

  45. def assignDontCareToUnasigned(): Stream.this.type
    Definition Classes
    Data
  46. def assignFormalRandom(kind: RandomExpKind): Unit
    Definition Classes
    MultiData → Data
  47. final def assignFrom(that: AnyRef, target: AnyRef = this)(implicit loc: Location): Unit
    Definition Classes
    Data
  48. def assignFromBits(bits: Bits, hi: Int, lo: Int): Unit
    Definition Classes
    MultiData → Data
  49. def assignFromBits(bits: Bits): Unit
    Definition Classes
    MultiData → Data
  50. def assignFromBits(bits: Bits, offset: Int, bitCount: BitCount): Unit
    Definition Classes
    Data
  51. def assignFromImpl(that: AnyRef, target: AnyRef, kind: AnyRef)(implicit loc: Location): Unit
    Attributes
    protected
    Definition Classes
    Bundle → Assignable
  52. def assignSomeByName(that: Bundle): Unit

    Assign all possible signal fo the bundle with an other bundle by name

    Assign all possible signal fo the bundle with an other bundle by name

    Definition Classes
    Bundle
  53. def assignUnassignedByName(that: MultiData): Unit
    Definition Classes
    MultiData
  54. def bundleAssign(that: Bundle)(f: (Data, Data) ⇒ Unit): Unit
    Definition Classes
    Bundle
  55. def ccToggle(pushClock: ClockDomain, popClock: ClockDomain): Stream[T]
  56. def ccToggleInputWait(pushClock: ClockDomain, popClock: ClockDomain): Stream[T]
  57. def ccToggleWithoutBuffer(pushClock: ClockDomain, popClock: ClockDomain): Stream[T]
  58. def checkDir(that: Bundle): Boolean

    for interface find modport

    for interface find modport

    Definition Classes
    Bundle
  59. def clearAll(): Stream.this.type

    Clear all bits to False and return itself

    Clear all bits to False and return itself

    Definition Classes
    Data
  60. def clearValidWhen(cond: Bool): Stream[T]
  61. def clone(): Stream[T]
    Definition Classes
    Stream → Bundle → Data → AnyRef
  62. def combStage(): Stream[T]

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

  63. def component: Component
    Definition Classes
    ContextUser
  64. final def compositAssignFrom(that: AnyRef, target: AnyRef, kind: AnyRef)(implicit loc: Location): Unit
    Definition Classes
    Assignable
  65. val compositeAssign: Assignable
    Definition Classes
    Assignable
  66. def connectFrom(that: Stream[T]): Stream[T]

    Connect this slave Stream to that master Stream

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

    Block this when cond is False.

    Block this when cond is False. Return the resulting Stream

  68. def copyDirectionOfImpl(that: Data): Stream.this.type
    Definition Classes
    MultiData → Data
  69. def delay(cycleCount: Int): Stream[T]

    Delay the stream by a given number of cycles.

    Delay the stream by a given number of cycles.

    cycleCount

    Number of cycles to delay the stream

    returns

    Delayed stream

  70. def dirString(): String
    Definition Classes
    Data
  71. def discardWhen(cond: Bool): Stream[T]

    Discard transactions when cond is True.

    Discard transactions when cond is True.

    This is the same as throwWhen() but with a semantically clearer function name. Prefer discardWhen() over throwWhen() for new designs.

    cond

    Condition

    returns

    The resulting Stream

  72. def dontSimplifyIt(): Stream.this.type
    Definition Classes
    Data
  73. def elements: ArrayBuffer[(String, Data)]
    Definition Classes
    Bundle → MultiData
  74. var elementsCache: ArrayBuffer[(String, Data)]
    Definition Classes
    Bundle
  75. def elementsString: String
    Definition Classes
    MultiData
  76. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  77. def equals(obj: Any): Boolean
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  78. def existsTag(cond: (SpinalTag) ⇒ Boolean): Boolean
    Definition Classes
    SpinalTagReady
  79. def filterTag(cond: (SpinalTag) ⇒ Boolean): Iterable[SpinalTag]
    Definition Classes
    SpinalTagReady
  80. def find(name: String): Data
    Definition Classes
    MultiData
  81. def findTag(cond: (SpinalTag) ⇒ Boolean): Option[SpinalTag]
    Definition Classes
    SpinalTagReady
  82. def fire: Bool

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

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

    Definition Classes
    Stream → DataCarrier
  83. def flatten: Seq[BaseType]
    Definition Classes
    MultiData → Data
  84. def flattenForeach(body: (BaseType) ⇒ Unit): Unit
    Definition Classes
    MultiData → Data
  85. def flattenLocalName: Seq[String]
    Definition Classes
    MultiData → Data
  86. def flip(): Stream.this.type

    Flip the direction of the signal.

    Flip the direction of the signal.

    in and out are swapped, inout stay the same.

    Definition Classes
    MultiData → Data
  87. def foreachReflectableNameables(doThat: (Any) ⇒ Unit): Unit
    Definition Classes
    Nameable
  88. def foreachTag(body: (SpinalTag) ⇒ Unit): Unit
    Definition Classes
    SpinalTagReady
  89. def forkSerial(cond: Bool): Stream[T]
  90. def formalAssertsMaster(payloadInvariance: Boolean = true)(implicit loc: Location): Composite[Stream[T]] { val stack: String }

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

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

    payloadInvariance

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

  91. def formalAssertsOrder(dataAhead: T, dataBehind: T)(implicit loc: Location): (Bool, Bool)
  92. def formalAssertsTimeout(maxStallCycles: Int = 0): Composite[Stream[T]] { val logic: spinal.core.Area{val counter: spinal.lib.Counter} }

    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.

  93. def formalAssumesOrder(dataAhead: T, dataBehind: T)(implicit loc: Location): (Bool, Bool)
  94. def formalAssumesSlave(payloadInvariance: Boolean = true)(implicit loc: Location): Composite[Stream[T]]
  95. def formalAssumesTimeout(maxStallCycles: Int = 0): Composite[Stream[T]] { val logic: spinal.core.Area{val counter: spinal.lib.Counter} }
  96. def formalCovers(back2BackCycles: Int = 1): Composite[Stream[T]] { val hist: spinal.core.Bool }
  97. def fragmentTransaction(bitsWidth: Int): Stream[Fragment[Bits]]
  98. def freeRun(): Stream.this.type
    Definition Classes
    Stream → DataCarrier
  99. def freeze(): Stream.this.type
    Definition Classes
    MultiData → Data
  100. def getAheadValue(): Stream.this.type

    For a register, get the value it will have at the next clock, as a combinational signal.

    For a register, get the value it will have at the next clock, as a combinational signal.

    Definition Classes
    Data
  101. def getBitsWidth: Int

    Return the width of the data

    Return the width of the data

    Definition Classes
    MultiData → Data
  102. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  103. def getComponent(): Component
    Definition Classes
    Data → InComponent → NameableByComponent
  104. def getComponents(): Seq[Component]

    Get current component with all parents

    Get current component with all parents

    Definition Classes
    InComponent
  105. def getDirection: IODirection
    Definition Classes
    Data
  106. def getDisplayName(): String
    Definition Classes
    Nameable
  107. def getInstanceCounter: Int
    Definition Classes
    ContextUser
  108. def getMode: Byte
    Attributes
    protected
    Definition Classes
    Nameable
  109. def getMuxType[T <: Data](list: TraversableOnce[T]): HardType[T]
    Definition Classes
    Data
  110. def getName(default: String): String
    Definition Classes
    NameableByComponent → Nameable
  111. def getName(): String
    Definition Classes
    NameableByComponent → Nameable
  112. def getPartialName(): String
    Definition Classes
    Nameable
  113. def getPath(from: Component, to: Component): Seq[Component]
    Definition Classes
    NameableByComponent
  114. def getRealSource: Any
    Definition Classes
    Assignable
  115. def getRealSourceNoRec: Any
    Definition Classes
    Data → Assignable
  116. def getRefOwnersChain(): List[Any]
    Definition Classes
    OwnableRef
  117. def getRootParent: Data
    Definition Classes
    Data
  118. def getRtlPath(separator: String = "/"): String
    Definition Classes
    Data
  119. def getScalaLocationLong: String
    Definition Classes
    ScalaLocated
  120. def getScalaLocationShort: String
    Definition Classes
    ScalaLocated
  121. def getScalaTrace(): Throwable
    Definition Classes
    ScalaLocated
  122. def getTag[T <: SpinalTag](clazz: Class[T]): Option[T]
    Definition Classes
    SpinalTagReady
  123. def getTags(): LinkedHashSet[SpinalTag]
    Definition Classes
    SpinalTagReady
  124. def getTagsOf[T <: SpinalTag]()(implicit tag: ClassTag[T]): Iterable[T]
    Definition Classes
    SpinalTagReady
  125. def getTypeString: String
    Definition Classes
    Stream → Bundle
  126. def getZero: Stream.this.type

    Create a signal set to 0

    Create a signal set to 0

    Definition Classes
    MultiData → Data
  127. val globalData: GlobalData
    Definition Classes
    GlobalDataUser
  128. def halfPipe(flush: Bool = null, keep: Boolean = false): Stream[T]

    Return a Stream that cut all path, but divide the bandwidth by 2.

    Return a Stream that cut all path, but divide the bandwidth by 2.

    The cost is (payload width + 2) flip-flops and the latency is 1.

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

    Stop transactions on this when cond is True and return the resulting Stream.

  130. var hardtype: HardType[_]
    Definition Classes
    Bundle
  131. def hasTag[T <: SpinalTag](clazz: Class[T]): Boolean
    Definition Classes
    SpinalTagReady
  132. def hasTag(spinalTag: SpinalTag): Boolean
    Definition Classes
    SpinalTagReady
  133. def hashCode(): Int
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  134. final def initFrom(that: AnyRef, target: AnyRef = this): Unit
    Definition Classes
    Data
  135. def instanceAttributes(language: Language): Iterable[Attribute]
    Definition Classes
    SpinalTagReady
  136. def instanceAttributes: Iterable[Attribute]
    Definition Classes
    SpinalTagReady
  137. final def intoMaster(): Stream.this.type

    Convert into master

    Convert into master

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

    Convert into slave

    Convert into slave

    Definition Classes
    IMasterSlave
  139. def isAnalog: Boolean
    Definition Classes
    Data
  140. def isComb: Boolean
    Definition Classes
    Data
  141. def isCompletelyUnnamed: Boolean
    Definition Classes
    Nameable
  142. def isDirectionLess: Boolean
    Definition Classes
    Data
  143. def isEmptyOfTag: Boolean
    Definition Classes
    SpinalTagReady
  144. def isFree: Bool

    Return True when the bus isn't stuck with a transaction (!isStall)

  145. def isInOut: Boolean
    Definition Classes
    Data
  146. def isInput: Boolean
    Definition Classes
    Data
  147. def isInputOrInOut: Boolean
    Definition Classes
    Data
  148. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  149. final def isMasterInterface: Boolean

    Are port directions set for a Master interface?

    Are port directions set for a Master interface?

    Definition Classes
    IMasterSlave
  150. final def isNamed: Boolean
    Definition Classes
    Nameable
  151. def isNew: Bool

    Return True when a transaction has appeared (first cycle)

  152. def isOutput: Boolean
    Definition Classes
    Data
  153. def isOutputOrInOut: Boolean
    Definition Classes
    Data
  154. def isPriorityApplicable(namePriority: Byte): Boolean
    Definition Classes
    Nameable
  155. def isReg: Boolean
    Definition Classes
    Data
  156. def isRegOnAssign: Boolean
    Definition Classes
    Data
  157. final def isSlaveInterface: Boolean

    Are port directions set for a Master interface?

    Are port directions set for a Master interface?

    Definition Classes
    IMasterSlave
  158. def isStall: Bool

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

  159. def isUnnamed: Boolean
    Definition Classes
    NameableByComponent → Nameable
  160. def m2sPipe(collapsBubble: Boolean = true, crossClockData: Boolean = false, flush: Bool = null, holdPayload: Boolean = false, keep: Boolean = false, initPayload: ⇒ T = null.asInstanceOf[T]): Stream[T]

    Return a stream that cut the valid and payload signals through registers.

    Return a stream that cut the valid and payload signals through registers.

    The cost is (payload width + 1) flip-flops and the latency is 1.

    The name "m2s" comes from from the fact that the signals that flow from Master-to-Slave are pipelined (namely ready and payload).

    collapsBubble

    When true(the default), add the logic to allow to store an incoming payload when there is no stored payload and the slave is not ready.

    crossClockData

    If false(the default), do not add tags on the payload signal for clock domain crossing.

    flush

    An optional signal to set the valid register to 0.

    holdPayload

    When false(the default), do not add the logic to keep the slave side payload constant after the one cycle when the slave consumed the payload.

    keep

    If false(the default), do not add an attribute to avoid optimization of the slave side valid and payload.

    initPayload

    If not null, a value to initialize the payload registers.

    See also

    stage()

    stream documentation

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

    Return a Stream with payload calculated by a translate function.

    Return a Stream with payload calculated by a translate function.

    Modify the payload of the x stream, while preserving the valid and ready signals

  162. val name: String
    Definition Classes
    Nameable
  163. val nameableRef: Nameable
    Attributes
    protected
    Definition Classes
    Nameable
    Annotations
    @DontName()
  164. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  165. def noBackendCombMerge(): Stream.this.type

    Put the combinatorial logic driving this signal in a separate process

    Put the combinatorial logic driving this signal in a separate process

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

    Disable combinatorial loop checking for this Data

    Disable combinatorial loop checking for this Data

    Definition Classes
    Data
    See also

    Combinatorial loop Error Documentation

  167. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  168. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  169. def onEachAttributes(doIt: (Attribute) ⇒ Unit): Unit
    Definition Classes
    SpinalTagReady
  170. def overrideLocalName(name: String): Stream.this.type
    Definition Classes
    Nameable
  171. val parent: Data
    Definition Classes
    Data
  172. val parentScope: ScopeStatement
    Definition Classes
    ContextUser
  173. val payload: T

    Content of the transaction driven by the master, don't care when valid is 0.

    Content of the transaction driven by the master, don't care when valid is 0.

    Definition Classes
    Stream → DataCarrier
  174. val payloadType: HardType[T]
  175. def pipelined(m2s: Boolean = false, s2m: Boolean = false, halfRate: Boolean = false): Stream[T]

    Return a pipelined version of this Stream based on the provided arguments.

    Return a pipelined version of this Stream based on the provided arguments.

    m2s

    cut valid and payload with registers if true

    s2m

    cut ready with a register if true

    halfRate

    Cut valid/ready/payload with some registers. Bandwidth divided by 2. Can be true only when m2s and s2m are false.

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

    Return a pipelined version of this Stream based on the provided StreamPipe spec.

  177. def pull(propagateName: Boolean): Stream.this.type
    Definition Classes
    Data
  178. def pull(): Stream.this.type

    Pull a signal to the top level (use for debugging)

    Pull a signal to the top level (use for debugging)

    Definition Classes
    Data
  179. def purify(): Stream.this.type
    Definition Classes
    Data
  180. def queue(size: Int, pushClock: ClockDomain, popClock: ClockDomain): Stream[T]

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

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

    Connect this to a fifo and return its pop stream

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

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

  183. def queueOfReg(size: Int, latency: Int = 1, forFMax: Boolean = false, initPayload: ⇒ Option[T] = None): Stream[T]

    Connect this to a register constructed fifo and return its pop stream

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

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

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

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

    Useful for register that doesn't need a reset value in RTL, but need a random value for simulation (avoid x-propagation)

    Useful for register that doesn't need a reset value in RTL, but need a random value for simulation (avoid x-propagation)

    Definition Classes
    Data
  188. val ready: Bool

    Signal driven by the slave, indicating consumption of the payload, don't care when valid is 0.

  189. val refOwner: RefOwnerType
    Definition Classes
    OwnableRef
    Annotations
    @DontName()
  190. def reflectNames(): Unit
    Definition Classes
    Nameable
  191. def removeAssignments(data: Boolean = true, init: Boolean = true, initial: Boolean = true): Stream.this.type
    Definition Classes
    Data
  192. def removeDataAssignments(): Stream.this.type
    Definition Classes
    Data
  193. def removeInitAssignments(): Stream.this.type
    Definition Classes
    Data
  194. def removeTag(spinalTag: SpinalTag): Stream.this.type
    Definition Classes
    SpinalTagReady
  195. def removeTags(tags: Iterable[SpinalTag]): Stream.this.type
    Definition Classes
    SpinalTagReady
  196. def repeat(times: Int): (Stream[T], UInt)

    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.

  197. def resized: Stream.this.type

    Return a version of the signal which is allowed to be automatically resized where needed.

    Return a version of the signal which is allowed to be automatically resized where needed.

    The resize operation is deferred until the point of assignment later. The resize may widen or truncate, retaining the LSB.

    Definition Classes
    Data
    See also

    Width checking Documentation

  198. def rootIF(): Interface

    root interface

    root interface

    Definition Classes
    Data
  199. def rootIFList(): List[Interface]
    Definition Classes
    Data
  200. def rootIFrec(now: Data, lastRoot: List[Interface]): List[Interface]
    Definition Classes
    Data
  201. def s2mPipe(stagesCount: Int): Stream[T]
  202. def s2mPipe(flush: Bool = null, keep: Boolean = false, savePower: Boolean = false): Stream[T]

    Return a stream that cut the ready path through a register.

    Return a stream that cut the ready path through a register.

    As long as the slave is ready, the valid and payload signal are passed without registering. When the slave ready goes to low, the payload is stored and will be consumed later at the first cycle of ready to high.

    The cost is payload width + 1 flip-flops and payload width mux2. The latency is 0.

    The name "s2m" comes from from the fact that the signal that flows from Slave-to-Master is pipelined (namely valid).

    flush

    An optional signal to set the valid register to 0.

    keep

    If false(the default), do not add an attribute to avoid optimization of the slave side valid and payload signals.

    See also

    stream documentation

  203. val scalaTrace: Throwable
    Definition Classes
    ScalaLocated
  204. def setAll(): Stream.this.type

    Set all bits to True and return itself

    Set all bits to True and return itself

    Definition Classes
    Data
  205. def setAsAnalog(): Stream.this.type
    Definition Classes
    Data
  206. def setAsComb(): Stream.this.type

    Set baseType to Combinatorial

    Set baseType to Combinatorial

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

    Remove the direction (in, out, inout) to a signal

    Remove the direction (in, out, inout) to a signal

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

    Set as master interface

    Set as master interface

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

    Set baseType to reg

    Set baseType to reg

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

    Set a slave interface

    Set a slave interface

    Definition Classes
    IMasterSlave
  211. def setBlocked(): Stream.this.type
  212. def setCompositeName(nameable: Nameable, postfix: String, namePriority: Byte): Stream.this.type
    Definition Classes
    Nameable
  213. def setCompositeName(nameable: Nameable, postfix: String, weak: Boolean): Stream.this.type
    Definition Classes
    Nameable
  214. def setCompositeName(nameable: Nameable, postfix: String): Stream.this.type
    Definition Classes
    Nameable
  215. def setCompositeName(nameable: Nameable, namePriority: Byte): Stream.this.type
    Definition Classes
    Nameable
  216. def setCompositeName(nameable: Nameable, weak: Boolean): Stream.this.type
    Definition Classes
    Nameable
  217. def setCompositeName(nameable: Nameable): Stream.this.type
    Definition Classes
    Nameable
  218. def setIdle(): Stream.this.type
  219. def setLambdaName(isNameBody: ⇒ Boolean)(nameGen: ⇒ String): Stream.this.type
    Definition Classes
    Nameable
  220. def setName(name: String, namePriority: Byte): Stream.this.type
    Definition Classes
    Nameable
  221. def setName(name: String, weak: Boolean): Stream.this.type
    Definition Classes
    Nameable
  222. def setName(name: String): Stream.this.type
    Definition Classes
    Nameable
  223. def setNameAsWeak(): Stream.this.type
    Definition Classes
    Nameable
  224. def setOutputAsReg(): Stream.this.type

    Recursively set baseType to reg only for output

    Recursively set baseType to reg only for output

    Definition Classes
    Data
  225. def setPartialName(name: String, namePriority: Byte, owner: Any): Stream.this.type
    Definition Classes
    Nameable
  226. def setPartialName(name: String, namePriority: Byte): Stream.this.type
    Definition Classes
    Nameable
  227. def setPartialName(name: String, weak: Boolean): Stream.this.type
    Definition Classes
    Nameable
  228. def setPartialName(owner: Nameable, name: String, namePriority: Byte): Stream.this.type
    Definition Classes
    Nameable
  229. def setPartialName(owner: Nameable, name: String, weak: Boolean): Stream.this.type
    Definition Classes
    Nameable
  230. def setPartialName(name: String): Stream.this.type
    Definition Classes
    Nameable
  231. def setPartialName(owner: Nameable, name: String): Stream.this.type
    Definition Classes
    Nameable
  232. def setPartialName(owner: Nameable): Stream.this.type
    Definition Classes
    Nameable
  233. def setRefOwner(that: Any): Unit
    Definition Classes
    OwnableRef
  234. def setScalaLocated(source: ScalaLocated): Stream.this.type
    Definition Classes
    ScalaLocated
  235. def setWeakName(name: String): Stream.this.type
    Definition Classes
    Nameable
  236. def slowdown(factor: Int): Stream[Vec[T]]

    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.

  237. def spinalTags: LinkedHashSet[SpinalTag]
    Definition Classes
    SpinalTagReady
  238. def stage(): Stream[T]

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

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

    The cost is (payload width + 1) flip-flops and the latency is 1.

    Equivalent to m2sPipe() but with "stage" name in the generated HDL.

    See also

    stream documentation

  239. def swapPayload[T2 <: Data](that: HardType[T2]): Stream[T2]
  240. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  241. def takeWhen(cond: Bool): Stream[T]

    Drop transaction of this when cond is False and return the resulting Stream.

  242. def throwWhen(cond: Bool): Stream[T]

    Drop transactions of this when cond is True and return the resulting Stream.

  243. def toEvent(): Event

    Ignore the payload

  244. def toFlow: Flow[T]

    returns

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

  245. def toFlowFire: Flow[T]
  246. def toIo(): Stream.this.type
    Definition Classes
    Data
  247. def toMuxInput[T <: Data](muxOutput: T): T
    Definition Classes
    Data
  248. def toReg(init: T): T
  249. def toReg(): T
  250. def toString(): String
    Definition Classes
    Bundle → Nameable → AnyRef → Any
  251. def translateFrom[T2 <: Data](that: Stream[T2])(dataAssignment: (T, payload.type) ⇒ Unit): Stream[T]
  252. def translateInto[T2 <: Data](into: Stream[T2])(dataAssignment: (T2, T) ⇒ Unit): Stream[T2]
  253. def translateWith[T2 <: Data](that: T2): Stream[T2]

    Replace this stream's payload with another one

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

    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.

  255. def unfreeze(): Stream.this.type
    Definition Classes
    MultiData → Data
  256. def unsetName(): Stream.this.type
    Definition Classes
    Nameable
  257. def valCallback[T](ref: T, name: String): T
    Definition Classes
    ValCallbackRec → ValCallback
  258. def valCallbackOn(ref: Any, name: String, refs: Set[Any]): Unit
    Definition Classes
    ValCallbackRec
  259. def valCallbackRec(ref: Any, name: String): Unit
    Definition Classes
    Bundle → ValCallbackRec
  260. val valid: Bool

    Signal driven by the master, indicating payload present on the interface.

    Signal driven by the master, indicating payload present on the interface.

    Definition Classes
    Stream → DataCarrier
  261. def validPipe(keep: Boolean = false): Stream[T]
  262. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  263. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  264. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  265. def wrapNext(): Stream.this.type
    Definition Classes
    Data
  266. def zipByName(that: MultiData, rec: ArrayBuffer[(BaseType, BaseType)] = ArrayBuffer()): ArrayBuffer[(BaseType, BaseType)]
    Definition Classes
    MultiData
  267. def ~[T2 <: Data](that: T2): Stream[T2]
  268. 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

  2. def asMaster(): Unit

    Override it to define port directions for a master interface.

    Override it to define port directions for a master interface.

    Definition Classes
    Stream → IMasterSlave
    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

    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
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated
  5. def genIf(cond: Boolean): Stream.this.type

    Generate this if condition is true

    Generate this if condition is true

    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