Class/Object

spinal.lib

Flow

Related Docs: object Flow | package lib

Permalink

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

Linear Supertypes
DataCarrier[T], IMasterSlave, Bundle, ValCallbackRec, ValCallback, MultiData, Data, InComponent, OverridedEqualsHashCode, SpinalTagReady, Assignable, NameableByComponent, Nameable, OwnableRef, ContextUser, ScalaLocated, GlobalDataUser, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Flow
  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 Flow(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
    Definition Classes
    Data

  3. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  4. def <-<(that: Flow[T]): Flow[T]

    Permalink

  5. def <<(that: Flow[T]): Flow[T]

    Permalink

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

    Permalink
    Definition Classes
    AnyRef → Any

  7. def >->(that: Flow[T]): Flow[T]

    Permalink

  8. def >>(into: Flow[T]): Flow[T]

    Permalink

  9. var _spinalTags: LinkedHashSet[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady

  10. def addAttribute(attribute: Attribute): Flow.this.type

    Permalink
    Definition Classes
    Data → SpinalTagReady

  11. def addAttribute(name: String, value: String): Flow.this.type

    Permalink
    Definition Classes
    SpinalTagReady

  12. def addAttribute(name: String): Flow.this.type

    Permalink
    Definition Classes
    SpinalTagReady

  13. def addTag[T <: SpinalTag](spinalTag: T): Flow.this.type

    Permalink
    Definition Classes
    MultiData → SpinalTagReady

  14. def addTags[T <: SpinalTag](tags: Iterable[T]): Flow.this.type

    Permalink
    Definition Classes
    SpinalTagReady

  15. def allowDirectionLessIo: Flow.this.type

    Permalink
    Definition Classes
    Data

  16. def allowOverride: Flow.this.type

    Permalink
    Definition Classes
    Data

  17. def allowPartialyAssigned: Flow.this.type

    Permalink
    Definition Classes
    Data

  18. def allowPruning(): Flow.this.type

    Permalink
    Definition Classes
    Data

  19. def allowSimplifyIt(): Flow.this.type

    Permalink
    Definition Classes
    Data

  20. def allowUnsetRegToAvoidLatch: Flow.this.type

    Permalink
    Definition Classes
    Data

  21. def as[T <: Data](dataType: HardType[T]): T

    Permalink
    Definition Classes
    Data

  22. def asBits: Bits

    Permalink
    Definition Classes
    MultiData → Data

  23. def asData: Data

    Permalink
    Definition Classes
    Data

  24. def asInOut(): Flow.this.type

    Permalink
    Definition Classes
    MultiData → Data

  25. def asInput(): Flow.this.type

    Permalink
    Definition Classes
    MultiData → Data

  26. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  27. def asMaster(): Unit

    Permalink
    Definition Classes
    Flow → IMasterSlave

  28. def asOutput(): Flow.this.type

    Permalink
    Definition Classes
    MultiData → Data

  29. def asSlave(): Unit

    Permalink
    Definition Classes
    Flow → IMasterSlave

  30. def assignAllByName(that: Bundle): Unit

    Permalink
    Definition Classes
    Bundle

  31. def assignDontCare(): Flow.this.type

    Permalink
    Definition Classes
    Data

  32. final def assignFrom(that: AnyRef, target: AnyRef): Unit

    Permalink
    Definition Classes
    Data

  33. def assignFromBits(bits: Bits, hi: Int, lo: Int): Unit

    Permalink
    Definition Classes
    MultiData → Data

  34. def assignFromBits(bits: Bits): Unit

    Permalink
    Definition Classes
    MultiData → Data

  35. def assignFromBits(bits: Bits, offset: Int, bitCount: BitCount): Unit

    Permalink
    Definition Classes
    Data

  36. def assignSomeByName(that: Bundle): Unit

    Permalink
    Definition Classes
    Bundle

  37. def clone(): Flow[T]

    Permalink
    Definition Classes
    Flow → Bundle → Data → AnyRef

  38. def combStage(): Flow[T]

    Permalink

  39. def component: Component

    Permalink
    Definition Classes
    ContextUser

  40. final def compositAssignFrom(that: AnyRef, target: AnyRef, kind: AnyRef): Unit

    Permalink
    Definition Classes
    Assignable

  41. var compositeAssign: Assignable

    Permalink
    Definition Classes
    Assignable

  42. def connectFrom(that: Flow[T]): Flow[T]

    Permalink

  43. def copyDirectionOfImpl(that: Data): Flow.this.type

    Permalink
    Definition Classes
    MultiData → Data

  44. def default(that: T): Unit

    Permalink

  45. def dirString(): String

    Permalink
    Definition Classes
    Data

  46. def dontSimplifyIt(): Flow.this.type

    Permalink
    Definition Classes
    Data

  47. def elements: ArrayBuffer[(String, Data)]

    Permalink
    Definition Classes
    Bundle → MultiData

  48. def elementsString: String

    Permalink
    Definition Classes
    MultiData

  49. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  50. def equals(obj: Any): Boolean

    Permalink
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any

  51. def existsTag(cond: (SpinalTag) ⇒ Boolean): Boolean

    Permalink
    Definition Classes
    SpinalTagReady

  52. def filterTag(cond: (SpinalTag) ⇒ Boolean): Iterable[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady

  53. def find(name: String): Data

    Permalink
    Definition Classes
    MultiData

  54. def findTag(cond: (SpinalTag) ⇒ Boolean): Option[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady

  55. def fire: Bool

    Permalink
    Definition Classes
    Flow → DataCarrier

  56. def flatten: Seq[BaseType]

    Permalink
    Definition Classes
    MultiData → Data

  57. def flattenForeach(body: (BaseType) ⇒ Unit): Unit

    Permalink
    Definition Classes
    MultiData → Data

  58. def flattenLocalName: Seq[String]

    Permalink
    Definition Classes
    MultiData → Data

  59. def flip(): Flow.this.type

    Permalink
    Definition Classes
    MultiData → Data

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

    Permalink
    Definition Classes
    Nameable

  61. def foreachTag(body: (SpinalTag) ⇒ Unit): Unit

    Permalink
    Definition Classes
    SpinalTagReady

  62. def freeRun(): Flow.this.type

    Permalink
    Definition Classes
    Flow → DataCarrier

  63. def genIf(cond: Boolean): Flow.this.type

    Permalink
    Definition Classes
    Data

  64. def getBitsWidth: Int

    Permalink
    Definition Classes
    MultiData → Data

  65. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()

  66. def getComponent(): Component

    Permalink
    Definition Classes
    Data → InComponent → NameableByComponent

  67. def getComponents(): Seq[Component]

    Permalink
    Definition Classes
    InComponent

  68. def getDirection: IODirection

    Permalink
    Definition Classes
    Data

  69. def getDisplayName(): String

    Permalink
    Definition Classes
    Nameable

  70. def getInstanceCounter: Int

    Permalink
    Definition Classes
    ContextUser

  71. def getMode: Byte

    Permalink
    Attributes
    protected
    Definition Classes
    Nameable

  72. def getName(default: String): String

    Permalink
    Definition Classes
    NameableByComponent → Nameable

  73. def getName(): String

    Permalink
    Definition Classes
    Nameable

  74. def getPartialName(): String

    Permalink
    Definition Classes
    Nameable

  75. def getRealSource: Any

    Permalink
    Definition Classes
    Assignable

  76. def getRealSourceNoRec: Any

    Permalink
    Definition Classes
    Data → Assignable

  77. def getRefOwnersChain(): List[Any]

    Permalink
    Definition Classes
    OwnableRef

  78. def getRootParent: Data

    Permalink
    Definition Classes
    Data

  79. def getScalaLocationLong: String

    Permalink
    Definition Classes
    ScalaLocated

  80. def getScalaLocationShort: String

    Permalink
    Definition Classes
    ScalaLocated

  81. def getScalaTrace(): Throwable

    Permalink
    Definition Classes
    ScalaLocated

  82. def getTag[T <: SpinalTag](clazz: Class[T]): Option[T]

    Permalink
    Definition Classes
    SpinalTagReady

  83. def getTags(): LinkedHashSet[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady

  84. def getTypeString: String

    Permalink
    Definition Classes
    Bundle

  85. def getZero: Flow.this.type

    Permalink
    Definition Classes
    MultiData → Data

  86. val globalData: GlobalData

    Permalink
    Definition Classes
    GlobalDataUser

  87. var hardtype: HardType[_]

    Permalink
    Definition Classes
    Bundle

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

    Permalink
    Definition Classes
    SpinalTagReady

  89. def hasTag(spinalTag: SpinalTag): Boolean

    Permalink
    Definition Classes
    SpinalTagReady

  90. def hashCode(): Int

    Permalink
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any

  91. final def initFrom(that: AnyRef, target: AnyRef): Unit

    Permalink
    Definition Classes
    Data

  92. def instanceAttributes(language: Language): Iterable[Attribute]

    Permalink
    Definition Classes
    SpinalTagReady

  93. def instanceAttributes: Iterable[Attribute]

    Permalink
    Definition Classes
    SpinalTagReady

  94. def isAnalog: Boolean

    Permalink
    Definition Classes
    Data

  95. def isComb: Boolean

    Permalink
    Definition Classes
    Data

  96. def isDirectionLess: Boolean

    Permalink
    Definition Classes
    Data

  97. def isEmptyOfTag: Boolean

    Permalink
    Definition Classes
    SpinalTagReady

  98. def isInOut: Boolean

    Permalink
    Definition Classes
    Data

  99. def isInput: Boolean

    Permalink
    Definition Classes
    Data

  100. def isInputOrInOut: Boolean

    Permalink
    Definition Classes
    Data

  101. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  102. var isMasterInterface: Boolean

    Permalink
    Definition Classes
    IMasterSlave

  103. def isNamed: Boolean

    Permalink
    Definition Classes
    NameableByComponent → Nameable

  104. def isOutput: Boolean

    Permalink
    Definition Classes
    Data

  105. def isOutputOrInOut: Boolean

    Permalink
    Definition Classes
    Data

  106. def isPriorityApplicable(namePriority: Byte): Boolean

    Permalink
    Definition Classes
    Nameable

  107. def isReg: Boolean

    Permalink
    Definition Classes
    Data

  108. def isUnnamed: Boolean

    Permalink
    Definition Classes
    Nameable

  109. def keep(): Flow.this.type

    Permalink
    Definition Classes
    Data

  110. def m2sPipe(holdPayload: Boolean = false): Flow[T]

    Permalink

  111. def m2sPipe: Flow[T]

    Permalink

  112. var name: String

    Permalink
    Attributes
    protected
    Definition Classes
    Nameable

  113. var nameableRef: Nameable

    Permalink
    Attributes
    protected
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    AnyRef

  115. def noBackendCombMerge: Flow.this.type

    Permalink
    Definition Classes
    Data

  116. def noCombLoopCheck: Flow.this.type

    Permalink
    Definition Classes
    Data

  117. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()

  118. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()

  119. def onEachAttributes(doIt: (Attribute) ⇒ Unit): Unit

    Permalink
    Definition Classes
    SpinalTagReady

  120. def overrideLocalName(name: String): Flow.this.type

    Permalink
    Definition Classes
    Nameable

  121. var parent: Data

    Permalink
    Definition Classes
    Data

  122. var parentScope: ScopeStatement

    Permalink
    Definition Classes
    ContextUser

  123. val payload: T

    Permalink
    Definition Classes
    Flow → DataCarrier

  124. val payloadType: HardType[T]

    Permalink

  125. def pull(): Flow.this.type

    Permalink
    Definition Classes
    Data

  126. def purify(): Flow.this.type

    Permalink
    Definition Classes
    Data

  127. def push(that: T): Unit

    Permalink

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

    Permalink

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

    Permalink

  130. def randBoot(): Flow.this.type

    Permalink
    Definition Classes
    Data

  131. var refOwner: RefOwnerType

    Permalink
    Definition Classes
    OwnableRef

  132. def reflectNames(): Unit

    Permalink
    Definition Classes
    Nameable

  133. def removeAssignments(): Flow.this.type

    Permalink
    Definition Classes
    Data

  134. def removeTag(spinalTag: SpinalTag): Flow.this.type

    Permalink
    Definition Classes
    SpinalTagReady

  135. def removeTags(tags: Iterable[SpinalTag]): Flow.this.type

    Permalink
    Definition Classes
    SpinalTagReady

  136. def resized: Flow.this.type

    Permalink
    Definition Classes
    Data

  137. def setAsAnalog(): Flow.this.type

    Permalink
    Definition Classes
    Data

  138. def setAsComb(): Flow.this.type

    Permalink
    Definition Classes
    MultiData → Data

  139. def setAsDirectionLess(): Flow.this.type

    Permalink
    Definition Classes
    MultiData → Data

  140. def setAsReg(): Flow.this.type

    Permalink
    Definition Classes
    MultiData → Data

  141. def setCompositeName(nameable: Nameable, postfix: String, namePriority: Byte): Flow.this.type

    Permalink
    Definition Classes
    Nameable

  142. def setCompositeName(nameable: Nameable, postfix: String, weak: Boolean): Flow.this.type

    Permalink
    Definition Classes
    Nameable

  143. def setCompositeName(nameable: Nameable, postfix: String): Flow.this.type

    Permalink
    Definition Classes
    Nameable

  144. def setCompositeName(nameable: Nameable, namePriority: Byte): Flow.this.type

    Permalink
    Definition Classes
    Nameable

  145. def setCompositeName(nameable: Nameable, weak: Boolean): Flow.this.type

    Permalink
    Definition Classes
    Nameable

  146. def setCompositeName(nameable: Nameable): Flow.this.type

    Permalink
    Definition Classes
    Nameable

  147. def setName(name: String, namePriority: Byte): Flow.this.type

    Permalink
    Definition Classes
    Nameable

  148. def setName(name: String, weak: Boolean): Flow.this.type

    Permalink
    Definition Classes
    Nameable

  149. def setName(name: String): Flow.this.type

    Permalink
    Definition Classes
    Nameable

  150. def setNameAsWeak(): Flow.this.type

    Permalink
    Definition Classes
    Nameable

  151. def setPartialName(name: String, namePriority: Byte): Flow.this.type

    Permalink
    Definition Classes
    Nameable

  152. def setPartialName(name: String, weak: Boolean): Flow.this.type

    Permalink
    Definition Classes
    Nameable

  153. def setPartialName(owner: Nameable, name: String, namePriority: Byte): Flow.this.type

    Permalink
    Definition Classes
    Nameable

  154. def setPartialName(owner: Nameable, name: String, weak: Boolean): Flow.this.type

    Permalink
    Definition Classes
    Nameable

  155. def setPartialName(name: String): Flow.this.type

    Permalink
    Definition Classes
    Nameable

  156. def setPartialName(owner: Nameable, name: String): Flow.this.type

    Permalink
    Definition Classes
    Nameable

  157. def setRefOwner(that: Any): Unit

    Permalink
    Definition Classes
    OwnableRef

  158. def setScalaLocated(source: ScalaLocated): Flow.this.type

    Permalink
    Definition Classes
    ScalaLocated

  159. def setWeakName(name: String): Flow.this.type

    Permalink
    Definition Classes
    Nameable

  160. def spinalTags: LinkedHashSet[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady

  161. def stage(): Flow[T]

    Permalink

  162. def swapPayload[T2 <: Data](that: HardType[T2]): Flow[T2]

    Permalink

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

    Permalink
    Definition Classes
    AnyRef

  164. def takeWhen(cond: Bool): Flow[T]

    Permalink

  165. def throwWhen(cond: Bool): Flow[T]

    Permalink

  166. def toReg(init: T): T

    Permalink

  167. def toReg(): T

    Permalink

  168. def toStream(overflow: Bool, fifoSize: Int, overflowOccupancyAt: Int): Stream[T]

    Permalink

  169. def toStream(overflow: Bool): Stream[T]

    Permalink

  170. def toStream: Stream[T]

    Permalink

  171. def toString(): String

    Permalink
    Definition Classes
    Bundle → Nameable → AnyRef → Any

  172. def translateFrom[T2 <: Data](that: Flow[T2])(dataAssignment: (T, payload.type) ⇒ Unit): Flow[T]

    Permalink

  173. def translateWith[T2 <: Data](that: T2): Flow[T2]

    Permalink

  174. def unsetName(): Flow.this.type

    Permalink
    Definition Classes
    Nameable

  175. def valCallback[T](ref: T, name: String): T

    Permalink
    Definition Classes
    ValCallbackRec → ValCallback

  176. def valCallbackOn(ref: Any, name: String, refs: Set[Any]): Unit

    Permalink
    Definition Classes
    ValCallbackRec

  177. def valCallbackRec(ref: Any, name: String): Unit

    Permalink
    Definition Classes
    Bundle → ValCallbackRec

  178. val valid: Bool

    Permalink
    Definition Classes
    Flow → DataCarrier

  179. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  180. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  181. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def asDirectionLess(): Flow.this.type

    Permalink
    Definition Classes
    Data
    Annotations
    @deprecated
    Deprecated

    (Since version ???) use setAsDirectionLess instead

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