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
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Stream
  2. DataCarrier
  3. IMasterSlave
  4. Bundle
  5. OverridedEqualsHashCode
  6. MultiData
  7. Data
  8. SpinalTagReady
  9. Assignable
  10. NameableByComponent
  11. Nameable
  12. OwnableRef
  13. ContextUser
  14. ScalaLocated
  15. GlobalDataUser
  16. AnyRef
  17. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Stream(payloadType: HardType[T])

    Permalink

Type Members

  1. abstract type RefOwnerType

    Permalink
    Definition Classes
    OwnableRef

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. def ##(right: Data): Bits

    Permalink

    Concatenation between two data

    Concatenation between two data

    Definition Classes
    Data
  3. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  4. def &(cond: Bool): Stream[T]

    Permalink
  5. def <-/<(that: Stream[T]): Stream[T]

    Permalink

    Connect that to this.

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

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

    Permalink

    Connect that to this.

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

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

    Permalink

    Connect that to this.

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

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

    Permalink

    Connect that to this

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

    Permalink
    Definition Classes
    AnyRef → Any
  10. def >->(into: Stream[T]): Stream[T]

    Permalink

    Connect this to that.

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

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

    Permalink

    Connect that to this.

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

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

    Permalink

    Connect this to that.

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

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

    Permalink

    Connect this to that

  14. var _spinalTags: Set[SpinalTag]

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

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  18. def addFragmentLast(last: Bool): Stream[Fragment[T]]

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

    Permalink
    Definition Classes
    MultiDataSpinalTagReady
  20. def addTags[T <: SpinalTag](tags: Iterable[T]): Stream.this.type

    Permalink
    Definition Classes
    SpinalTagReady
  21. def allowDirectionLessIo: Stream.this.type

    Permalink
    Definition Classes
    Data
  22. def allowOverride: Stream.this.type

    Permalink

    Allow a data to be overrided

    Allow a data to be overrided

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

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

    Permalink
    Definition Classes
    Data
  25. def allowUnsetRegToAvoidLatch: Stream.this.type

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

    Permalink

    Drive arbitration signals of this from that

  27. def asBits: Bits

    Permalink

    Cast data to Bits

    Cast data to Bits

    Definition Classes
    MultiDataData
  28. def asData: Data

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

    Permalink
  30. def asFlow: Flow[T]

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

    Permalink

    set a data as inout

    set a data as inout

    Definition Classes
    MultiDataData
  32. def asInput(): Stream.this.type

    Permalink

    Set a data as input

    Set a data as input

    Definition Classes
    MultiDataData
  33. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  34. def asMaster(): Unit

    Permalink
    Definition Classes
    StreamIMasterSlave
  35. def asOutput(): Stream.this.type

    Permalink

    Set a data as output

    Set a data as output

    Definition Classes
    MultiDataData
  36. def asSlave(): Unit

    Permalink
    Definition Classes
    IMasterSlave
  37. def assignAllByName(that: Bundle): Unit

    Permalink

    Assign the bundle with an other bundle by name

    Assign the bundle with an other bundle by name

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

    Permalink
    Definition Classes
    Data
  39. final def assignFrom(that: AnyRef, target: AnyRef = this): Unit

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

    Permalink
    Definition Classes
    MultiDataData
  41. def assignFromBits(bits: Bits): Unit

    Permalink
    Definition Classes
    MultiDataData
  42. def assignFromBits(bits: Bits, offset: Int, bitCount: BitCount): Unit

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

    Permalink

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

    Permalink
    Definition Classes
    StreamBundleData → AnyRef
  45. var cloneFunc: () ⇒ AnyRef

    Permalink
    Definition Classes
    Bundle
  46. def component: Component

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

    Permalink
    Definition Classes
    Assignable
  48. var compositeAssign: Assignable

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

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

    Permalink

    Block this when cond is False.

    Block this when cond is False. Return the resulting stream

  51. def dirString(): String

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

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

    Permalink

    Return all element of the bundle

    Return all element of the bundle

    Definition Classes
    BundleMultiData
  54. def elementsString: String

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  62. def fire: Bool

    Permalink

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

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

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

    Permalink
    Definition Classes
    MultiDataData
  64. def flattenForeach(body: (BaseType) ⇒ Unit): Unit

    Permalink
    Definition Classes
    MultiDataData
  65. def flattenLocalName: Seq[String]

    Permalink
    Definition Classes
    MultiDataData
  66. def flip(): Stream.this.type

    Permalink

    flip the direction of the data

    flip the direction of the data

    Definition Classes
    MultiDataData
  67. def foreachReflectableNameables(doThat: (Any) ⇒ Unit): Unit

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

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

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

    Permalink

    Generate this if condition is true

    Generate this if condition is true

    Definition Classes
    Data
  71. def getBitsWidth: Int

    Permalink

    Return the width of the data

    Return the width of the data

    Definition Classes
    MultiDataData
  72. final def getClass(): Class[_]

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

    Permalink
    Definition Classes
    DataNameableByComponent
  74. def getComponents(): Seq[Component]

    Permalink

    Get current component with all parents

    Get current component with all parents

    Definition Classes
    Data
  75. def getDisplayName(): String

    Permalink
    Definition Classes
    Nameable
  76. def getInstanceCounter: Int

    Permalink
    Definition Classes
    ContextUser
  77. def getMode: Byte

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

    Permalink
    Definition Classes
    NameableByComponentNameable
  79. def getName(): String

    Permalink
    Definition Classes
    Nameable
  80. def getRealSource: Any

    Permalink
    Definition Classes
    Assignable
  81. def getRealSourceNoRec: Any

    Permalink
    Definition Classes
    DataAssignable
  82. def getRefOwnersChain(): List[Any]

    Permalink
    Definition Classes
    OwnableRef
  83. def getRootParent: Data

    Permalink
    Definition Classes
    Data
  84. def getScalaLocationLong: String

    Permalink
    Definition Classes
    ScalaLocated
  85. def getScalaLocationShort: String

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

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  89. def getTypeString: String

    Permalink
    Definition Classes
    StreamBundle
  90. def getZero: Stream.this.type

    Permalink

    Create a data set to 0

    Create a data set to 0

    Definition Classes
    MultiDataData
  91. val globalData: GlobalData

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

    Permalink

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

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

    Permalink

    Stop transactions on this when cond is True.

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

  94. def hasTag[T <: SpinalTag](clazz: Class[T]): Boolean

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

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

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

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  100. def isAnalog: Boolean

    Permalink
    Definition Classes
    Data
  101. def isComb: Boolean

    Permalink
    Definition Classes
    Data
  102. def isDirectionLess: Boolean

    Permalink
    Definition Classes
    Data
  103. def isEmptyOfTag: Boolean

    Permalink
    Definition Classes
    SpinalTagReady
  104. def isFree: Bool

    Permalink
  105. def isInOut: Boolean

    Permalink
    Definition Classes
    Data
  106. def isInput: Boolean

    Permalink
    Definition Classes
    Data
  107. def isInputOrInOut: Boolean

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

    Permalink
    Definition Classes
    Any
  109. var isMasterInterface: Boolean

    Permalink
    Definition Classes
    IMasterSlave
  110. def isNamed: Boolean

    Permalink
    Definition Classes
    NameableByComponentNameable
  111. def isNew: Bool

    Permalink

    Return True when a transaction is appear (first cycle)

  112. def isOutput: Boolean

    Permalink
    Definition Classes
    Data
  113. def isOutputOrInOut: Boolean

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

    Permalink
    Definition Classes
    Nameable
  115. def isReg: Boolean

    Permalink
    Definition Classes
    Data
  116. def isStall: Bool

    Permalink

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

  117. def isUnnamed: Boolean

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

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

    Permalink
  120. var name: String

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  128. var parent: Data

    Permalink
    Definition Classes
    Data
  129. var parentScope: ScopeStatement

    Permalink
    Definition Classes
    ContextUser
  130. val payload: T

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

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

    Permalink

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

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

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

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

    Permalink

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

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

    Permalink

    Connect this to a fifo and return its pop stream

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

    Permalink

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

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

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

    Permalink

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

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

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

    Permalink

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

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

    Definition Classes
    Data
  141. val ready: Bool

    Permalink
  142. var refOwner: RefOwnerType

    Permalink
    Definition Classes
    OwnableRef
  143. def removeAssignments(): Stream.this.type

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

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

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

    Permalink

    Resized data regarding target

    Resized data regarding target

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

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

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

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

    Permalink

    Set baseType to Combinatorial

    Set baseType to Combinatorial

    Definition Classes
    MultiDataData
  151. def setAsDirectionLess(): Stream.this.type

    Permalink

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

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

    Definition Classes
    MultiDataData
  152. def setAsReg(): Stream.this.type

    Permalink

    Set baseType to reg

    Set baseType to reg

    Definition Classes
    MultiDataData
  153. def setCompositeName(nameable: Nameable, postfix: String, namePriority: Byte): Stream.this.type

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink

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

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

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

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

  176. def toEvent(): Event

    Permalink
  177. def toFlow: Flow[T]

    Permalink

    returns

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

  178. def toString(): String

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

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

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

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

    Permalink
    Definition Classes
    Nameable
  183. val valid: Bool

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

    Permalink
  185. final def wait(): Unit

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

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

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

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

    use setAsDirectionLess instead

Inherited from DataCarrier[T]

Inherited from IMasterSlave

Inherited from Bundle

Inherited from OverridedEqualsHashCode

Inherited from MultiData

Inherited from Data

Inherited from SpinalTagReady

Inherited from Assignable

Inherited from NameableByComponent

Inherited from Nameable

Inherited from OwnableRef

Inherited from ContextUser

Inherited from ScalaLocated

Inherited from GlobalDataUser

Inherited from AnyRef

Inherited from Any

Ungrouped