Packages

class StreamFork[T <: Data] extends Component

A StreamFork will clone each incoming data to all its output streams. If synchronous is true, all output streams will always fire together, which means that the stream will halt until all output streams are ready. If synchronous is false, output streams may be ready one at a time, at the cost of an additional flip flop (1 bit per output). The input stream will block until all output streams have processed each item regardlessly.

Note that this means that when synchronous is true, the valid signal of the outputs depends on their inputs, which may lead to dead locks when used in combination with systems that have it the other way around. It also violates the handshake of the AXI specification (section A3.3.1).

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. StreamFork
  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 StreamFork(dataType: HardType[T], portCount: Int, synchronous: Boolean = false)

Type Members

  1. case class PrePopTask(task: () ⇒ Unit) extends Product with Serializable

    Class used to create a task that must be executed after the creation of the component

    Class used to create a task that must be executed after the creation of the component

    Definition Classes
    Component
  2. abstract type RefOwnerType
    Definition Classes
    OwnableRef

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val _spinalTags: LinkedHashSet[SpinalTag]
    Definition Classes
    SpinalTagReady
  5. def addAttribute(attribute: Attribute): StreamFork.this.type
    Definition Classes
    Component → SpinalTagReady
  6. def addAttribute(name: String, value: Int): StreamFork.this.type
    Definition Classes
    SpinalTagReady
  7. def addAttribute(name: String, value: String): StreamFork.this.type
    Definition Classes
    SpinalTagReady
  8. def addAttribute(name: String): StreamFork.this.type
    Definition Classes
    SpinalTagReady
  9. def addComment(str: String): Component
    Definition Classes
    Component
  10. def addPrePopTask(task: () ⇒ Unit): ArrayBuffer[PrePopTask]

    Add a new prePopTask

    Add a new prePopTask

    Definition Classes
    Component
  11. def addTag[T <: SpinalTag](spinalTag: T): StreamFork.this.type
    Definition Classes
    SpinalTagReady
  12. def addTags(h: SpinalTag, tail: SpinalTag*): StreamFork.this.type
    Definition Classes
    SpinalTagReady
  13. def addTags[T <: SpinalTag](tags: Iterable[T]): StreamFork.this.type
    Definition Classes
    SpinalTagReady
  14. def afterElaboration(body: ⇒ Unit): ArrayBuffer[PrePopTask]
    Definition Classes
    Component
  15. def asFormalDut(): StreamFork.this.type
    Definition Classes
    Component
  16. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  17. val children: ArrayBuffer[Component]

    Contains an array of all children Component

    Contains an array of all children Component

    Definition Classes
    Component
  18. val clockDomain: Handle[ClockDomain]

    Get the current clock domain (null if there is no clock domain already set )

    Get the current clock domain (null if there is no clock domain already set )

    Definition Classes
    Component
  19. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @IntrinsicCandidate()
  20. def component: Component
    Definition Classes
    ContextUser
  21. val definition: $anon forSome {type $anon <: SpinalTagReady { def addComment(str: String): $anon }}
    Definition Classes
    Component
  22. var definitionName: String

    Definition Name (name of the entity (VHDL) or module (Verilog))

    Definition Name (name of the entity (VHDL) or module (Verilog))

    Definition Classes
    Component
  23. var definitionNameNoMerge: Boolean
    Definition Classes
    Component
  24. val dslBody: ScopeStatement
    Definition Classes
    Component
  25. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. def equals(obj: Any): Boolean
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  27. def existsTag(cond: (SpinalTag) ⇒ Boolean): Boolean
    Definition Classes
    SpinalTagReady
  28. def filterTag(cond: (SpinalTag) ⇒ Boolean): Iterable[SpinalTag]
    Definition Classes
    SpinalTagReady
  29. def findTag(cond: (SpinalTag) ⇒ Boolean): Option[SpinalTag]
    Definition Classes
    SpinalTagReady
  30. def foreachReflectableNameables(doThat: (Any) ⇒ Unit): Unit
    Definition Classes
    Nameable
  31. def foreachTag(body: (SpinalTag) ⇒ Unit): Unit
    Definition Classes
    SpinalTagReady
  32. def getAllIo: Set[BaseType]

    Get a set of all IO available in the component

    Get a set of all IO available in the component

    Definition Classes
    Component
  33. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  34. def getDisplayName(): String
    Definition Classes
    Component → Nameable
  35. def getGroupedIO(ioBundleBypass: Boolean): Seq[Data]
    Definition Classes
    Component
  36. def getInstanceCounter: Int
    Definition Classes
    ContextUser
  37. def getMode: Byte
    Attributes
    protected
    Definition Classes
    Nameable
  38. def getName(default: String): String
    Definition Classes
    NameableByComponent → Nameable
  39. def getName(): String
    Definition Classes
    NameableByComponent → Nameable
  40. def getOrdredNodeIo: List[BaseType]

    Sort all IO regarding instanceCounter

    Sort all IO regarding instanceCounter

    Definition Classes
    Component
  41. def getParentsPath(sep: String = "/"): String

    Return the path of the parent

    Return the path of the parent

    Definition Classes
    Component
    Example: 

    1. toplevel/[myComponent1] // Current component is myComponent2
  42. def getPartialName(): String
    Definition Classes
    Nameable
  43. def getPath(sep: String = "/"): String

    Return the path of the component

    Return the path of the component

    Definition Classes
    Component
    Example: 

    1. toplevel/[myComponent1]/[myComponent2] // Current component is myComponent2
  44. def getPath(from: Component, to: Component): Seq[Component]
    Definition Classes
    NameableByComponent
  45. def getRefOwnersChain(): List[Any]
    Definition Classes
    OwnableRef
  46. def getRtlPath(separator: String = "/"): String
    Definition Classes
    Component
  47. def getScalaLocationLong: String
    Definition Classes
    ScalaLocated
  48. def getScalaLocationShort: String
    Definition Classes
    ScalaLocated
  49. def getScalaTrace(): Throwable
    Definition Classes
    ScalaLocated
  50. def getTag[T <: SpinalTag](clazz: Class[T]): Option[T]
    Definition Classes
    SpinalTagReady
  51. def getTags(): LinkedHashSet[SpinalTag]
    Definition Classes
    SpinalTagReady
  52. val globalData: GlobalData
    Definition Classes
    GlobalDataUser
  53. def hasTag[T <: SpinalTag](clazz: Class[T]): Boolean
    Definition Classes
    SpinalTagReady
  54. def hasTag(spinalTag: SpinalTag): Boolean
    Definition Classes
    SpinalTagReady
  55. def hashCode(): Int
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  56. def instanceAttributes(language: Language): Iterable[Attribute]
    Definition Classes
    SpinalTagReady
  57. def instanceAttributes: Iterable[Attribute]
    Definition Classes
    SpinalTagReady
  58. val io: Bundle { ... /* 2 definitions in type refinement */ }
  59. def isCompletelyUnnamed: Boolean
    Definition Classes
    Nameable
  60. def isEmptyOfTag: Boolean
    Definition Classes
    SpinalTagReady
  61. var isFormalTester: Boolean
    Definition Classes
    Component
  62. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  63. def isLogicLess: Boolean
    Definition Classes
    Component
  64. final def isNamed: Boolean
    Definition Classes
    Nameable
  65. def isPriorityApplicable(namePriority: Byte): Boolean
    Definition Classes
    Nameable
  66. def isUnnamed: Boolean
    Definition Classes
    NameableByComponent → Nameable
  67. var localNamingScope: NamingScope

    Name allocation

    Name allocation

    Definition Classes
    Component
  68. val logic: StreamForkArea[T]
  69. val name: String
    Definition Classes
    Nameable
  70. val nameableRef: Nameable
    Attributes
    protected
    Definition Classes
    Nameable
    Annotations
    @DontName()
  71. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  72. def noIoPrefix(): StreamFork.this.type

    No "io_" prefix in front of the in/out signals

    No "io_" prefix in front of the in/out signals

    Definition Classes
    Component
  73. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  74. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  75. def onBody[T](body: ⇒ T): T
    Definition Classes
    Component
  76. def onEachAttributes(doIt: (Attribute) ⇒ Unit): Unit
    Definition Classes
    SpinalTagReady
  77. def overrideLocalName(name: String): StreamFork.this.type
    Definition Classes
    Nameable
  78. def parent: Component

    Get the parent component (null if there is no parent)

    Get the parent component (null if there is no parent)

    Definition Classes
    Component
  79. val parentScope: ScopeStatement
    Definition Classes
    ContextUser
  80. def parents(of: Component = this, list: List[Component] = Nil): List[Component]

    Return a list of all parents of the components

    Return a list of all parents of the components

    Definition Classes
    Component
  81. def postInitCallback(): StreamFork.this.type
    Definition Classes
    Component → PostInitCallback
  82. def postPopEvent(): Unit
    Definition Classes
    Stackable
  83. def postPushEvent(): Unit
    Definition Classes
    Component → Stackable
  84. def prePop(): Unit
    Definition Classes
    Component
  85. def prePopEvent(): Unit
    Definition Classes
    Component → Stackable
  86. var pulledDataCache: Map[Data, Data]
    Definition Classes
    Component
  87. val refOwner: RefOwnerType
    Definition Classes
    OwnableRef
    Annotations
    @DontName()
  88. def reflectBaseType(name: String): BaseType
    Definition Classes
    Component
  89. def reflectNames(): Unit
    Definition Classes
    Nameable
  90. def removeTag(spinalTag: SpinalTag): StreamFork.this.type
    Definition Classes
    SpinalTagReady
  91. def removeTags(tags: Iterable[SpinalTag]): StreamFork.this.type
    Definition Classes
    SpinalTagReady
  92. def rework[T](gen: ⇒ T): T
    Definition Classes
    Component
  93. val scalaTrace: Throwable
    Definition Classes
    ScalaLocated
  94. val scopeProperties: Capture

    Rework the component

    Rework the component

    Definition Classes
    Component
  95. def setCompositeName(nameable: Nameable, postfix: String, namePriority: Byte): StreamFork.this.type
    Definition Classes
    Nameable
  96. def setCompositeName(nameable: Nameable, postfix: String, weak: Boolean): StreamFork.this.type
    Definition Classes
    Nameable
  97. def setCompositeName(nameable: Nameable, postfix: String): StreamFork.this.type
    Definition Classes
    Nameable
  98. def setCompositeName(nameable: Nameable, namePriority: Byte): StreamFork.this.type
    Definition Classes
    Nameable
  99. def setCompositeName(nameable: Nameable, weak: Boolean): StreamFork.this.type
    Definition Classes
    Nameable
  100. def setCompositeName(nameable: Nameable): StreamFork.this.type
    Definition Classes
    Nameable
  101. def setDefinitionName(name: String, noMerge: Boolean = true): StreamFork.this.type

    Set the definition name of the component

    Set the definition name of the component

    Definition Classes
    Component
  102. def setFormalTester(): Unit
    Definition Classes
    Component
  103. def setLambdaName(isNameBody: ⇒ Boolean)(nameGen: ⇒ String): StreamFork.this.type
    Definition Classes
    Nameable
  104. def setName(name: String, namePriority: Byte): StreamFork.this.type
    Definition Classes
    Nameable
  105. def setName(name: String, weak: Boolean): StreamFork.this.type
    Definition Classes
    Nameable
  106. def setName(name: String): StreamFork.this.type
    Definition Classes
    Nameable
  107. def setNameAsWeak(): StreamFork.this.type
    Definition Classes
    Nameable
  108. def setPartialName(name: String, namePriority: Byte, owner: Any): StreamFork.this.type
    Definition Classes
    Nameable
  109. def setPartialName(name: String, namePriority: Byte): StreamFork.this.type
    Definition Classes
    Nameable
  110. def setPartialName(name: String, weak: Boolean): StreamFork.this.type
    Definition Classes
    Nameable
  111. def setPartialName(owner: Nameable, name: String, namePriority: Byte): StreamFork.this.type
    Definition Classes
    Nameable
  112. def setPartialName(owner: Nameable, name: String, weak: Boolean): StreamFork.this.type
    Definition Classes
    Nameable
  113. def setPartialName(name: String): StreamFork.this.type
    Definition Classes
    Nameable
  114. def setPartialName(owner: Nameable, name: String): StreamFork.this.type
    Definition Classes
    Nameable
  115. def setPartialName(owner: Nameable): StreamFork.this.type
    Definition Classes
    Nameable
  116. def setRefOwner(that: Any): Unit
    Definition Classes
    OwnableRef
  117. def setScalaLocated(source: ScalaLocated): StreamFork.this.type
    Definition Classes
    ScalaLocated
  118. def setWeakName(name: String): StreamFork.this.type
    Definition Classes
    Nameable
  119. def spinalTags: LinkedHashSet[SpinalTag]
    Definition Classes
    SpinalTagReady
  120. def stub(): StreamFork.this.type

    Empty Component, remove logic in component and assign zero on output port as stub

    Empty Component, remove logic in component and assign zero on output port as stub

    Definition Classes
    Component
    Example: 

    1. val dut = (new MyComponent).stub()
  121. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  122. def toString(): String
    Definition Classes
    Nameable → AnyRef → Any
  123. def traceDisable(recursive: Boolean = true): StreamFork.this.type
    Definition Classes
    Component
  124. def traceEnable(recursive: Boolean = true): StreamFork.this.type
    Definition Classes
    Component
  125. var traceEnabled: Boolean
    Definition Classes
    Component
  126. def unsetName(): StreamFork.this.type
    Definition Classes
    Nameable
  127. val userCache: Map[Any, Any]

    Used to store arbitrary object related to the component

    Used to store arbitrary object related to the component

    Definition Classes
    Component
  128. def valCallback[T](ref: T, name: String): T
    Definition Classes
    ValCallbackRec → ValCallback
  129. def valCallbackOn(ref: Any, name: String, refs: Set[Any]): Unit
    Definition Classes
    ValCallbackRec
  130. def valCallbackRec(ref: Any, name: String): Unit
    Definition Classes
    Component → ValCallbackRec
  131. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  132. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  133. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  134. def walkComponents(body: (Component) ⇒ Unit): Unit
    Definition Classes
    Component
  135. def withAutoPull(): Unit
    Definition Classes
    Component
  136. var withHierarchyAutoPull: Boolean
    Definition Classes
    Component
  137. def withKeywords(): Unit
    Definition Classes
    Component
  138. var withVitalOutputs: Boolean
    Definition Classes
    Component
  139. def withoutKeywords(): Unit
    Definition Classes
    Component
  140. var withoutReservedKeywords: Boolean
    Definition Classes
    Component

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

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