Class/Object

spinal.lib

StreamFifo

Related Docs: object StreamFifo | package lib

Permalink

class StreamFifo[T <: Data] extends Component

Fully redesigned in release 1.8.2 allowing improved timing closure. - latency of 0, 1, 2 cycles

Linear Supertypes
Component, ValCallbackRec, ValCallback, OverridedEqualsHashCode, SpinalTagReady, Stackable, PostInitCallback, NameableByComponent, Nameable, ContextUser, ScalaLocated, GlobalDataUser, OwnableRef, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. StreamFifo
  2. Component
  3. ValCallbackRec
  4. ValCallback
  5. OverridedEqualsHashCode
  6. SpinalTagReady
  7. Stackable
  8. PostInitCallback
  9. NameableByComponent
  10. Nameable
  11. ContextUser
  12. ScalaLocated
  13. GlobalDataUser
  14. OwnableRef
  15. AnyRef
  16. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new StreamFifo(dataType: HardType[T], depth: Int, withAsyncRead: Boolean = false, withBypass: Boolean = false, allowExtraMsb: Boolean = true, forFMax: Boolean = false, useVec: Boolean = false)

    Permalink

    depth

    Number of element stored in the fifo, Note that if withAsyncRead==false, then one extra transaction can be stored

    withAsyncRead

    Read the memory using asyncronous read port (ex distributed ram). If false, add 1 cycle latency

    withBypass

    Bypass the push port to the pop port when the fifo is empty. If false, add 1 cycle latency Only available if withAsyncRead == true

    forFMax

    Tune the design to get the maximal clock frequency

    useVec

    Use an Vec of register instead of a Mem to store the content Only available if withAsyncRead == true

Type Members

  1. class CounterUpDownFmax extends Area

    Permalink
  2. case class PrePopTask extends Product with Serializable

    Permalink
    Definition Classes
    Component
  3. abstract type RefOwnerType

    Permalink
    Definition Classes
    OwnableRef

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. var _spinalTags: LinkedHashSet[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady
  5. def addAttribute(attribute: Attribute): StreamFifo.this.type

    Permalink
    Definition Classes
    Component → SpinalTagReady
  6. def addAttribute(name: String, value: Int): StreamFifo.this.type

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

    Permalink
    Definition Classes
    SpinalTagReady
  8. def addAttribute(name: String): StreamFifo.this.type

    Permalink
    Definition Classes
    SpinalTagReady
  9. def addComment(str: String): Component

    Permalink
    Definition Classes
    Component
  10. def addPrePopTask(task: () ⇒ Unit): ArrayBuffer[PrePopTask]

    Permalink
    Definition Classes
    Component
  11. def addTag[T <: SpinalTag](spinalTag: T): StreamFifo.this.type

    Permalink
    Definition Classes
    SpinalTagReady
  12. def addTags(h: SpinalTag, tail: SpinalTag*): StreamFifo.this.type

    Permalink
    Definition Classes
    SpinalTagReady
  13. def addTags[T <: SpinalTag](tags: Iterable[T]): StreamFifo.this.type

    Permalink
    Definition Classes
    SpinalTagReady
  14. def afterElaboration(body: ⇒ Unit): ArrayBuffer[PrePopTask]

    Permalink
    Definition Classes
    Component
  15. val allowExtraMsb: Boolean

    Permalink
  16. def asFormalDut(): StreamFifo.this.type

    Permalink
    Definition Classes
    Component
  17. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  18. val bypass: Area

    Permalink
  19. val children: ArrayBuffer[Component]

    Permalink
    Definition Classes
    Component
  20. val clockDomain: Handle[ClockDomain]

    Permalink
    Definition Classes
    Component
  21. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @throws( ... )
  22. def component: Component

    Permalink
    Definition Classes
    ContextUser
  23. val dataType: HardType[T]

    Permalink
  24. val definition: $anon forSome {type $anon <: SpinalTagReady { def addComment(str: String): $anon }}

    Permalink
    Definition Classes
    Component
  25. var definitionName: String

    Permalink
    Definition Classes
    Component
  26. var definitionNameNoMerge: Boolean

    Permalink
    Definition Classes
    Component
  27. val depth: Int

    Permalink

    Number of element stored in the fifo, Note that if withAsyncRead==false, then one extra transaction can be stored

  28. val dslBody: ScopeStatement

    Permalink
    Definition Classes
    Component
  29. final def eq(arg0: AnyRef): Boolean

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

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

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  34. val forFMax: Boolean

    Permalink

    Tune the design to get the maximal clock frequency

  35. def foreachReflectableNameables(doThat: (Any) ⇒ Unit): Unit

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

    Permalink
    Definition Classes
    SpinalTagReady
  37. def formalCheckOutputStage(cond: (T) ⇒ Bool): Bool

    Permalink
  38. def formalCheckRam(cond: (T) ⇒ Bool): Vec[Bool]

    Permalink
  39. def formalContains(cond: (T) ⇒ Bool): Bool

    Permalink
  40. def formalContains(word: T): Bool

    Permalink
  41. def formalCount(cond: (T) ⇒ Bool): UInt

    Permalink
  42. def formalCount(word: T): UInt

    Permalink
  43. def formalFullToEmpty(): Area { val was_full: spinal.core.Bool }

    Permalink
  44. def getAllIo: Set[BaseType]

    Permalink
    Definition Classes
    Component
  45. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  46. def getDisplayName(): String

    Permalink
    Definition Classes
    Component → Nameable
  47. def getGroupedIO(ioBundleBypass: Boolean): Seq[Data]

    Permalink
    Definition Classes
    Component
  48. def getInstanceCounter: Int

    Permalink
    Definition Classes
    ContextUser
  49. def getMode: Byte

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

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

    Permalink
    Definition Classes
    NameableByComponent → Nameable
  52. def getOrdredNodeIo: List[BaseType]

    Permalink
    Definition Classes
    Component
  53. def getParentsPath(sep: String): String

    Permalink
    Definition Classes
    Component
  54. def getPartialName(): String

    Permalink
    Definition Classes
    Nameable
  55. def getPath(sep: String): String

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

    Permalink
    Definition Classes
    NameableByComponent
  57. def getRefOwnersChain(): List[Any]

    Permalink
    Definition Classes
    OwnableRef
  58. def getRtlPath(separator: String): String

    Permalink
    Definition Classes
    Component
  59. def getScalaLocationLong: String

    Permalink
    Definition Classes
    ScalaLocated
  60. def getScalaLocationShort: String

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

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  64. var globalData: GlobalData

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

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

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

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  70. val io: Bundle with StreamFifoInterface[T] { ... /* 5 definitions in type refinement */ }

    Permalink
  71. def isCompletelyUnnamed: Boolean

    Permalink
    Definition Classes
    Nameable
  72. def isEmptyOfTag: Boolean

    Permalink
    Definition Classes
    SpinalTagReady
  73. var isFormalTester: Boolean

    Permalink
    Definition Classes
    Component
  74. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  75. def isLogicLess: Boolean

    Permalink
    Definition Classes
    Component
  76. final def isNamed: Boolean

    Permalink
    Definition Classes
    Nameable
  77. def isPriorityApplicable(namePriority: Byte): Boolean

    Permalink
    Definition Classes
    Nameable
  78. def isUnnamed: Boolean

    Permalink
    Definition Classes
    NameableByComponent → Nameable
  79. var localNamingScope: NamingScope

    Permalink
    Definition Classes
    Component
  80. val logic: Area { ... /* 6 definitions in type refinement */ }

    Permalink
  81. def makeInputsAnyseq(): Unit

    Permalink
    Definition Classes
    Component
  82. var name: String

    Permalink
    Definition Classes
    Nameable
  83. var nameableRef: Nameable

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

    Permalink
    Definition Classes
    AnyRef
  85. def noIoPrefix(): StreamFifo.this.type

    Permalink
    Definition Classes
    Component
  86. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  88. def onBody[T](body: ⇒ T): T

    Permalink
    Definition Classes
    Component
  89. def onEachAttributes(doIt: (Attribute) ⇒ Unit): Unit

    Permalink
    Definition Classes
    SpinalTagReady
  90. val oneStage: Area { ... /* 2 definitions in type refinement */ }

    Permalink
  91. def overrideLocalName(name: String): StreamFifo.this.type

    Permalink
    Definition Classes
    Nameable
  92. def parent: Component

    Permalink
    Definition Classes
    Component
  93. var parentScope: ScopeStatement

    Permalink
    Definition Classes
    ContextUser
  94. def parents(of: Component, list: List[Component]): List[Component]

    Permalink
    Definition Classes
    Component
  95. def postInitCallback(): StreamFifo.this.type

    Permalink
    Definition Classes
    Component → PostInitCallback
  96. def postPopEvent(): Unit

    Permalink
    Definition Classes
    Stackable
  97. def postPushEvent(): Unit

    Permalink
    Definition Classes
    Component → Stackable
  98. def prePop(): Unit

    Permalink
    Definition Classes
    Component
  99. def prePopEvent(): Unit

    Permalink
    Definition Classes
    Component → Stackable
  100. var pulledDataCache: Map[Data, Data]

    Permalink
    Definition Classes
    Component
  101. var refOwner: RefOwnerType

    Permalink
    Definition Classes
    OwnableRef
  102. def reflectBaseType(name: String): BaseType

    Permalink
    Definition Classes
    Component
  103. def reflectNames(): Unit

    Permalink
    Definition Classes
    Nameable
  104. def removeTag(spinalTag: SpinalTag): StreamFifo.this.type

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

    Permalink
    Definition Classes
    SpinalTagReady
  106. def rework[T](gen: ⇒ T): T

    Permalink
    Definition Classes
    Component
  107. var scalaTrace: Throwable

    Permalink
    Definition Classes
    ScalaLocated
  108. val scopeProperties: Capture

    Permalink
    Definition Classes
    Component
  109. def setCompositeName(nameable: Nameable, postfix: String, namePriority: Byte): StreamFifo.this.type

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

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

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

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

    Permalink
    Definition Classes
    Nameable
  114. def setCompositeName(nameable: Nameable): StreamFifo.this.type

    Permalink
    Definition Classes
    Nameable
  115. def setDefinitionName(name: String, noMerge: Boolean): StreamFifo.this.type

    Permalink
    Definition Classes
    Component
  116. def setFormalTester(): Unit

    Permalink
    Definition Classes
    Component
  117. def setLambdaName(isNameBody: ⇒ Boolean)(nameGen: ⇒ String): StreamFifo.this.type

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

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

    Permalink
    Definition Classes
    Nameable
  120. def setName(name: String): StreamFifo.this.type

    Permalink
    Definition Classes
    Nameable
  121. def setNameAsWeak(): StreamFifo.this.type

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

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

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

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

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

    Permalink
    Definition Classes
    Nameable
  127. def setPartialName(name: String): StreamFifo.this.type

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

    Permalink
    Definition Classes
    Nameable
  129. def setPartialName(owner: Nameable): StreamFifo.this.type

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

    Permalink
    Definition Classes
    OwnableRef
  131. def setScalaLocated(source: ScalaLocated): StreamFifo.this.type

    Permalink
    Definition Classes
    ScalaLocated
  132. def setWeakName(name: String): StreamFifo.this.type

    Permalink
    Definition Classes
    Nameable
  133. def spinalTags: LinkedHashSet[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady
  134. def stub(): StreamFifo.this.type

    Permalink
    Definition Classes
    Component
  135. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  136. def toString(): String

    Permalink
    Definition Classes
    Nameable → AnyRef → Any
  137. def traceDisable(recursive: Boolean): StreamFifo.this.type

    Permalink
    Definition Classes
    Component
  138. def traceEnable(recursive: Boolean): StreamFifo.this.type

    Permalink
    Definition Classes
    Component
  139. var traceEnabled: Boolean

    Permalink
    Definition Classes
    Component
  140. def unsetName(): StreamFifo.this.type

    Permalink
    Definition Classes
    Nameable
  141. val useVec: Boolean

    Permalink

    Use an Vec of register instead of a Mem to store the content Only available if withAsyncRead == true

  142. val userCache: Map[Any, Any]

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

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

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

    Permalink
    Definition Classes
    Component → ValCallbackRec
  146. final def wait(arg0: Long, arg1: Int): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  149. def walkComponents(body: (Component) ⇒ Unit): Unit

    Permalink
    Definition Classes
    Component
  150. val withAsyncRead: Boolean

    Permalink

    Read the memory using asyncronous read port (ex distributed ram).

    Read the memory using asyncronous read port (ex distributed ram). If false, add 1 cycle latency

  151. def withAutoPull(): Unit

    Permalink
    Definition Classes
    Component
  152. val withBypass: Boolean

    Permalink

    Bypass the push port to the pop port when the fifo is empty.

    Bypass the push port to the pop port when the fifo is empty. If false, add 1 cycle latency Only available if withAsyncRead == true

  153. val withExtraMsb: Boolean

    Permalink
  154. var withHierarchyAutoPull: Boolean

    Permalink
    Definition Classes
    Component
  155. def withKeywords(): Unit

    Permalink
    Definition Classes
    Component
  156. var withVitalOutputs: Boolean

    Permalink
    Definition Classes
    Component
  157. def withoutKeywords(): Unit

    Permalink
    Definition Classes
    Component
  158. var withoutReservedKeywords: Boolean

    Permalink
    Definition Classes
    Component

Deprecated Value Members

  1. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from Component

Inherited from ValCallbackRec

Inherited from ValCallback

Inherited from OverridedEqualsHashCode

Inherited from SpinalTagReady

Inherited from Stackable

Inherited from PostInitCallback

Inherited from NameableByComponent

Inherited from Nameable

Inherited from ContextUser

Inherited from ScalaLocated

Inherited from GlobalDataUser

Inherited from OwnableRef

Inherited from AnyRef

Inherited from Any

Ungrouped