spinal.lib

Stream

Related Docs: object Stream | package lib

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

Linear Supertypes
DataCarrier[T], IMasterSlave, Bundle, OverridedEqualsHashCode, MultiData, Data, ScalaLocated, SpinalTagReady, Assignable, NameableByComponent, Nameable, OwnableRef, ContextUser, GlobalDataUser, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Stream
  2. DataCarrier
  3. IMasterSlave
  4. Bundle
  5. OverridedEqualsHashCode
  6. MultiData
  7. Data
  8. ScalaLocated
  9. SpinalTagReady
  10. Assignable
  11. NameableByComponent
  12. Nameable
  13. OwnableRef
  14. ContextUser
  15. GlobalDataUser
  16. AnyRef
  17. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Stream(_dataType: 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

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

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

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

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

    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]

    Connect that to this.

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

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

    Connect that to this

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

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

    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]

    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]

    Connect this to that.

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

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

    Connect this to that

  14. var _spinalTags: Set[SpinalTag]

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

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

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

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

  19. def addTag(spinalTag: SpinalTag): Stream.this.type

    Definition Classes
    MultiData → SpinalTagReady
  20. def addTags(tags: Iterable[SpinalTag]): Stream.this.type

    Definition Classes
    SpinalTagReady
  21. def allowPruning(): Unit

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

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

    Drive arbitration signals of this from that

  24. def asBits: Bits

    Definition Classes
    MultiData → Data
  25. def asData: Data

    Definition Classes
    Data
  26. def asDataStream: Stream[Data]

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

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

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

    Definition Classes
    Any
  30. def asMaster(): Unit

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

    Definition Classes
    MultiData → Data
  32. def asSlave(): Unit

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

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

    Definition Classes
    Data
  35. final def assignFrom(that: AnyRef, conservative: Boolean): Unit

    Definition Classes
    Assignable
  36. def assignFromBits(bits: Bits, hi: Int, lo: Int): Unit

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

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

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

    Definition Classes
    Bundle
  40. def clone(): Stream[T]

    Definition Classes
    Stream → Bundle → Data → AnyRef
  41. var cloneFunc: () ⇒ AnyRef

    Definition Classes
    Bundle
  42. var component: Component

    Definition Classes
    ContextUser
  43. var compositeAssign: Assignable

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

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

    Block this when cond is False.

    Block this when cond is False. Return the resulting stream

  46. def dataType: T

  47. def dontSimplifyIt(): Stream.this.type

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

    Definition Classes
    Bundle → MultiData
  49. def elementsString: String

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

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

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

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

    Definition Classes
    SpinalTagReady
  54. def finalize(): Unit

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

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

    Definition Classes
    SpinalTagReady
  57. def fire: Bool

    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
  58. def flatten: Seq[BaseType]

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

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

    Definition Classes
    MultiData → Data
  61. def forEachNameables(doThat: (Any) ⇒ Unit): Unit

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

  63. def freeRun(): Stream.this.type

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

    Definition Classes
    Data
  65. def getBitsWidth: Int

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

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

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

    Definition Classes
    Data
  69. def getDisplayName(): String

    Definition Classes
    Nameable
  70. def getInstanceCounter: Int

    Definition Classes
    ContextUser
  71. def getName(): String

    Definition Classes
    NameableByComponent → Nameable
  72. def getName(default: String): String

    Definition Classes
    Nameable
  73. def getRefOwnersChain(): List[Any]

    Definition Classes
    OwnableRef
  74. def getRootParent: Data

    Definition Classes
    Data
  75. def getScalaLocationLong: String

    Definition Classes
    ScalaLocated
  76. def getScalaLocationShort: String

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

    Definition Classes
    SpinalTagReady
  78. def getTypeString: String

    Definition Classes
    Stream → Bundle
  79. def getZero: Stream.this.type

    Definition Classes
    MultiData → Data
  80. val globalData: GlobalData

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

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

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

  83. def hasTag(spinalTag: SpinalTag): Boolean

    Definition Classes
    SpinalTagReady
  84. def hashCode(): Int

    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  85. def instanceAttributes(language: Language): Iterable[Attribute]

    Definition Classes
    SpinalTagReady
  86. def instanceAttributes: Iterable[Attribute]

    Definition Classes
    SpinalTagReady
  87. def isDirectionLess: Boolean

    Definition Classes
    Data
  88. def isEmptyOfTag: Boolean

    Definition Classes
    SpinalTagReady
  89. def isFree: Bool

  90. def isInput: Boolean

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

    Definition Classes
    Any
  92. var isMasterInterface: Boolean

    Definition Classes
    IMasterSlave
  93. def isNamed: Boolean

    Definition Classes
    Nameable
  94. def isNew: Bool

    Return True when a transaction is appear (first cycle)

  95. def isOutput: Boolean

    Definition Classes
    Data
  96. def isReg: Boolean

    Definition Classes
    Data
  97. def isStall: Bool

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

  98. def isUnnamed: Boolean

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

    Definition Classes
    Data
  100. def m2sPipe(collapsBubble: Boolean = true, crossClockData: Boolean = false): Stream[T]

  101. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  102. final def notify(): Unit

    Definition Classes
    AnyRef
  103. final def notifyAll(): Unit

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

    Definition Classes
    SpinalTagReady
  105. var parent: Data

    Definition Classes
    Data
  106. val payload: T

    Definition Classes
    StreamDataCarrier
  107. def pull(): Stream.this.type

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

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

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

    Connect this to a fifo and return its pop stream

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

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

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

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

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

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

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

    Definition Classes
    Data
  115. val ready: Bool

  116. var refOwner: RefOwnerType

    Definition Classes
    OwnableRef
  117. def removeTag(spinalTag: SpinalTag): Stream.this.type

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

    Definition Classes
    SpinalTagReady
  119. def resized: Stream.this.type

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

  121. def s2mPipe(): Stream[T]

  122. def setCompositeName(nameable: Nameable, postfix: String, weak: Boolean): Stream.this.type

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

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

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

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

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

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

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

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

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

    Definition Classes
    OwnableRef
  132. def setWeakName(name: String): Stream.this.type

    Definition Classes
    Nameable
  133. def spinalTags: Set[SpinalTag]

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

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

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

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

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

  138. def toEvent(): Event

  139. def toFlow: Flow[T]

    returns

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

  140. def toString(): String

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

  142. def translateInto[T2 <: Data](into: Stream[T2])(dataAssignement: (T2, T) ⇒ Unit): Stream[T2]

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

  144. def unsetName(): Unit

    Definition Classes
    Nameable
  145. val valid: Bool

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

  147. final def wait(): Unit

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

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

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

  151. def ~~[T2 <: Data](translate: (T) ⇒ T2): Stream[T2]

Deprecated Value Members

  1. def unused: Unit

    Definition Classes
    Data
    Annotations
    @deprecated
    Deprecated

    use allowPruning instead

Inherited from DataCarrier[T]

Inherited from IMasterSlave

Inherited from Bundle

Inherited from OverridedEqualsHashCode

Inherited from MultiData

Inherited from Data

Inherited from ScalaLocated

Inherited from SpinalTagReady

Inherited from Assignable

Inherited from NameableByComponent

Inherited from Nameable

Inherited from OwnableRef

Inherited from ContextUser

Inherited from GlobalDataUser

Inherited from AnyRef

Inherited from Any

Ungrouped