Packages

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

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 data

    Concatenation between two data

    Definition Classes
    Data
  3. final def ##(): Int
    Definition Classes
    AnyRef → Any
  4. def #*(count: Int): Bits
    Definition Classes
    Data
  5. def &(cond: Bool): Stream[T]
  6. def <-/<(that: Stream[T]): Stream[T]

    Connect that to this.

    Connect that to this. The valid/payload/ready path are cut by an register stage

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

    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]

    Connect that to this.

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

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

    Connect that to this

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

    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]

    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]

    Connect this to that.

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

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

    Connect this to that

  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 Data of an io Bundle to be directionless

    Allow a Data of an io Bundle to be directionless

    See https://spinalhdl.github.io/SpinalDoc-RTD/master/SpinalHDL/Design%20errors/iobundle.html

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

    Allow a Data to be overriden

    Allow a Data to be overriden

    See https://spinalhdl.github.io/SpinalDoc-RTD/master/SpinalHDL/Design%20errors/assignment_overlap.html

    Definition Classes
    Data
  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)

    See https://spinalhdl.github.io/SpinalDoc-RTD/master/SpinalHDL/Design%20errors/unassigned_register.html#register-with-only-init

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

    Drive arbitration signals of this from that

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

    Cast data to Bits

    Cast data 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 data as inout

    set a data 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
    Definition Classes
    Data
  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
    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]
  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 dirString(): String
    Definition Classes
    Data
  70. def dontSimplifyIt(): Stream.this.type
    Definition Classes
    Data
  71. def elements: ArrayBuffer[(String, Data)]
    Definition Classes
    Bundle → MultiData
  72. var elementsCache: ArrayBuffer[(String, Data)]
    Definition Classes
    Bundle
  73. def elementsString: String
    Definition Classes
    MultiData
  74. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  75. def equals(obj: Any): Boolean
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  76. def existsTag(cond: (SpinalTag) ⇒ Boolean): Boolean
    Definition Classes
    SpinalTagReady
  77. def filterTag(cond: (SpinalTag) ⇒ Boolean): Iterable[SpinalTag]
    Definition Classes
    SpinalTagReady
  78. def find(name: String): Data
    Definition Classes
    MultiData
  79. def findTag(cond: (SpinalTag) ⇒ Boolean): Option[SpinalTag]
    Definition Classes
    SpinalTagReady
  80. 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
  81. def flatten: Seq[BaseType]
    Definition Classes
    MultiData → Data
  82. def flattenForeach(body: (BaseType) ⇒ Unit): Unit
    Definition Classes
    MultiData → Data
  83. def flattenLocalName: Seq[String]
    Definition Classes
    MultiData → Data
  84. def flip(): Stream.this.type

    flip the direction of the data

    flip the direction of the data

    Definition Classes
    MultiData → Data
  85. def foreachReflectableNameables(doThat: (Any) ⇒ Unit): Unit
    Definition Classes
    Nameable
  86. def foreachTag(body: (SpinalTag) ⇒ Unit): Unit
    Definition Classes
    SpinalTagReady
  87. def forkSerial(cond: Bool): Stream[T]
  88. 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 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.

  89. def formalAssertsOrder(dataAhead: T, dataBehind: T)(implicit loc: Location): (Bool, Bool)
  90. 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.

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

    Return the width of the data

    Return the width of the data

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

    Get current component with all parents

    Get current component with all parents

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

    Create a data set to 0

    Create a data set to 0

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

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

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

    Stop transactions on this when cond is True.

    Stop transactions on this when cond is True. Return the resulting stream

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

    Convert into master

    Convert into master

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

    Convert into slave

    Convert into slave

    Definition Classes
    IMasterSlave
  136. def isAnalog: Boolean
    Definition Classes
    Data
  137. def isComb: Boolean
    Definition Classes
    Data
  138. def isCompletelyUnnamed: Boolean
    Definition Classes
    Nameable
  139. def isDirectionLess: Boolean
    Definition Classes
    Data
  140. def isEmptyOfTag: Boolean
    Definition Classes
    SpinalTagReady
  141. def isFree: Bool

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

  142. def isInOut: Boolean
    Definition Classes
    Data
  143. def isInput: Boolean
    Definition Classes
    Data
  144. def isInputOrInOut: Boolean
    Definition Classes
    Data
  145. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  146. final def isMasterInterface: Boolean

    Are port directions set for a Master interface?

    Are port directions set for a Master interface?

    Definition Classes
    IMasterSlave
  147. final def isNamed: Boolean
    Definition Classes
    Nameable
  148. def isNew: Bool

    Return True when a transaction has appeared (first cycle)

  149. def isOutput: Boolean
    Definition Classes
    Data
  150. def isOutputOrInOut: Boolean
    Definition Classes
    Data
  151. def isPriorityApplicable(namePriority: Byte): Boolean
    Definition Classes
    Nameable
  152. def isReg: Boolean
    Definition Classes
    Data
  153. def isRegOnAssign: Boolean
    Definition Classes
    Data
  154. final def isSlaveInterface: Boolean

    Are port directions set for a Master interface?

    Are port directions set for a Master interface?

    Definition Classes
    IMasterSlave
  155. def isStall: Bool

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

  156. def isUnnamed: Boolean
    Definition Classes
    NameableByComponent → Nameable
  157. def m2sPipe(collapsBubble: Boolean = true, crossClockData: Boolean = false, flush: Bool = null, holdPayload: Boolean = false, keep: Boolean = false, initPayload: ⇒ T = null.asInstanceOf[T]): Stream[T]
  158. def map[T2 <: Data](translate: (T) ⇒ T2): Stream[T2]
  159. val name: String
    Definition Classes
    Nameable
  160. val nameableRef: Nameable
    Attributes
    protected
    Definition Classes
    Nameable
    Annotations
    @DontName()
  161. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  162. 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
  163. def noCombLoopCheck(): Stream.this.type

    Disable combinatorial loop checking for this Data

    Disable combinatorial loop checking for this Data

    See https://spinalhdl.github.io/SpinalDoc-RTD/master/SpinalHDL/Design%20errors/combinatorial_loop.html

    Definition Classes
    Data
  164. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  165. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  166. def onEachAttributes(doIt: (Attribute) ⇒ Unit): Unit
    Definition Classes
    SpinalTagReady
  167. def overrideLocalName(name: String): Stream.this.type
    Definition Classes
    Nameable
  168. val parent: Data
    Definition Classes
    Data
  169. val parentScope: ScopeStatement
    Definition Classes
    ContextUser
  170. val payload: T
    Definition Classes
    Stream → DataCarrier
  171. val payloadType: HardType[T]
  172. def pipelined(m2s: Boolean = false, s2m: Boolean = false, halfRate: Boolean = false): Stream[T]
  173. def pipelined(pipe: StreamPipe): Stream[T]
  174. def pull(propagateName: Boolean): Stream.this.type
    Definition Classes
    Data
  175. 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
  176. def purify(): Stream.this.type
    Definition Classes
    Data
  177. def queue(size: Int, pushClock: ClockDomain, popClock: ClockDomain): Stream[T]

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

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

    Connect this to a fifo and return its pop stream

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

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

  180. def queueWithAvailability(size: Int, latency: Int = 2, forFMax: Boolean = false): (Stream[T], UInt)
  181. 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

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

  183. 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
  184. val ready: Bool
  185. val refOwner: RefOwnerType
    Definition Classes
    OwnableRef
    Annotations
    @DontName()
  186. def reflectNames(): Unit
    Definition Classes
    Nameable
  187. def removeAssignments(data: Boolean = true, init: Boolean = true, initial: Boolean = true): Stream.this.type
    Definition Classes
    Data
  188. def removeDataAssignments(): Stream.this.type
    Definition Classes
    Data
  189. def removeInitAssignments(): Stream.this.type
    Definition Classes
    Data
  190. def removeTag(spinalTag: SpinalTag): Stream.this.type
    Definition Classes
    SpinalTagReady
  191. def removeTags(tags: Iterable[SpinalTag]): Stream.this.type
    Definition Classes
    SpinalTagReady
  192. 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.

  193. def resized: Stream.this.type

    Resized data regarding target

    Resized data regarding target

    Definition Classes
    Data
  194. def rootIF(): Interface

    root interface

    root interface

    Definition Classes
    Data
  195. def rootIFList(): List[Interface]
    Definition Classes
    Data
  196. def rootIFrec(now: Data, lastRoot: List[Interface]): List[Interface]
    Definition Classes
    Data
  197. def s2mPipe(stagesCount: Int): Stream[T]
  198. def s2mPipe(flush: Bool = null, keep: Boolean = false): Stream[T]
  199. val scalaTrace: Throwable
    Definition Classes
    ScalaLocated
  200. def setAll(): Stream.this.type
    Definition Classes
    Data
  201. def setAsAnalog(): Stream.this.type
    Definition Classes
    Data
  202. def setAsComb(): Stream.this.type

    Set baseType to Combinatorial

    Set baseType to Combinatorial

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

    remove the direction (in,out,inout) to a data

    remove the direction (in,out,inout) to a data

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

    Set as master interface

    Set as master interface

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

    Set baseType to reg

    Set baseType to reg

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

    Set a slave interface

    Set a slave interface

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

    Recursively set baseType to reg only for output

    Recursively set baseType to reg only for output

    Definition Classes
    Data
  221. def setPartialName(name: String, namePriority: Byte, owner: Any): Stream.this.type
    Definition Classes
    Nameable
  222. def setPartialName(name: String, namePriority: Byte): Stream.this.type
    Definition Classes
    Nameable
  223. def setPartialName(name: String, weak: Boolean): Stream.this.type
    Definition Classes
    Nameable
  224. def setPartialName(owner: Nameable, name: String, namePriority: Byte): Stream.this.type
    Definition Classes
    Nameable
  225. def setPartialName(owner: Nameable, name: String, weak: Boolean): Stream.this.type
    Definition Classes
    Nameable
  226. def setPartialName(name: String): Stream.this.type
    Definition Classes
    Nameable
  227. def setPartialName(owner: Nameable, name: String): Stream.this.type
    Definition Classes
    Nameable
  228. def setPartialName(owner: Nameable): Stream.this.type
    Definition Classes
    Nameable
  229. def setRefOwner(that: Any): Unit
    Definition Classes
    OwnableRef
  230. def setScalaLocated(source: ScalaLocated): Stream.this.type
    Definition Classes
    ScalaLocated
  231. def setWeakName(name: String): Stream.this.type
    Definition Classes
    Nameable
  232. 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.

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

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

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

    Drop transaction of this when cond is False.

    Drop transaction of this when cond is False. Return the resulting stream

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

    Drop transactions of this when cond is True.

    Drop transactions of this when cond is True. Return the resulting stream

  239. def toEvent(): Event

    Ignore the payload

  240. def toFlow: Flow[T]

    returns

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

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

    Replace this stream's payload with another one

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

  251. def unfreeze(): Stream.this.type
    Definition Classes
    MultiData → Data
  252. def unsetName(): Stream.this.type
    Definition Classes
    Nameable
  253. def valCallback[T](ref: T, name: String): T
    Definition Classes
    ValCallbackRec → ValCallback
  254. def valCallbackOn(ref: Any, name: String, refs: Set[Any]): Unit
    Definition Classes
    ValCallbackRec
  255. def valCallbackRec(ref: Any, name: String): Unit
    Definition Classes
    Bundle → ValCallbackRec
  256. val valid: Bool
    Definition Classes
    Stream → DataCarrier
  257. def validPipe(keep: Boolean = false): Stream[T]
  258. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  259. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  260. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  261. def wrapNext(): Stream.this.type
    Definition Classes
    Data
  262. def zipByName(that: MultiData, rec: ArrayBuffer[(BaseType, BaseType)] = ArrayBuffer()): ArrayBuffer[(BaseType, BaseType)]
    Definition Classes
    MultiData
  263. def ~[T2 <: Data](that: T2): Stream[T2]
  264. 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