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: Int): Flow.this.type

    Permalink
    Definition Classes
    SpinalTagReady

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

    Permalink
    Definition Classes
    SpinalTagReady

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

    Permalink
    Definition Classes
    SpinalTagReady

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

    Permalink
    Definition Classes
    MultiData → SpinalTagReady

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

    Permalink
    Definition Classes
    SpinalTagReady

  16. def allowDirectionLessIo: Flow.this.type

    Permalink
    Definition Classes
    Data

  17. def allowOverride: Flow.this.type

    Permalink
    Definition Classes
    Data

  18. def allowPartialyAssigned: Flow.this.type

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    Data

  21. def allowUnsetRegToAvoidLatch: Flow.this.type

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    Data

  23. def asBits: Bits

    Permalink
    Definition Classes
    MultiData → Data

  24. def asData: Data

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    MultiData → Data

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

    Permalink
    Definition Classes
    MultiData → Data

  27. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  28. def asMaster(): Unit

    Permalink
    Definition Classes
    Flow → IMasterSlave

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

    Permalink
    Definition Classes
    MultiData → Data

  30. def asSlave(): Unit

    Permalink
    Definition Classes
    Flow → IMasterSlave

  31. def assignAllByName(that: Bundle): Unit

    Permalink
    Definition Classes
    Bundle

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

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    MultiData → Data

  35. def assignFromBits(bits: Bits): Unit

    Permalink
    Definition Classes
    MultiData → Data

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

    Permalink
    Definition Classes
    Data

  37. def assignSomeByName(that: Bundle): Unit

    Permalink
    Definition Classes
    Bundle

  38. def ccToggle(pushClock: ClockDomain, popClock: ClockDomain): Flow[T]

    Permalink

  39. def clone(): Flow[T]

    Permalink
    Definition Classes
    Flow → Bundle → Data → AnyRef

  40. def combStage(): Flow[T]

    Permalink

  41. def component: Component

    Permalink
    Definition Classes
    ContextUser

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

    Permalink
    Definition Classes
    Assignable

  43. var compositeAssign: Assignable

    Permalink
    Definition Classes
    Assignable

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

    Permalink

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

    Permalink
    Definition Classes
    MultiData → Data

  46. def default(that: T): Unit

    Permalink

  47. def dirString(): String

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    Bundle → MultiData

  50. def elementsString: String

    Permalink
    Definition Classes
    MultiData

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

    Permalink
    Definition Classes
    AnyRef

  52. def equals(obj: Any): Boolean

    Permalink
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any

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

    Permalink
    Definition Classes
    SpinalTagReady

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

    Permalink
    Definition Classes
    SpinalTagReady

  55. def find(name: String): Data

    Permalink
    Definition Classes
    MultiData

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

    Permalink
    Definition Classes
    SpinalTagReady

  57. def fire: Bool

    Permalink
    Definition Classes
    Flow → DataCarrier

  58. def flatten: Seq[BaseType]

    Permalink
    Definition Classes
    MultiData → Data

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

    Permalink
    Definition Classes
    MultiData → Data

  60. def flattenLocalName: Seq[String]

    Permalink
    Definition Classes
    MultiData → Data

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

    Permalink
    Definition Classes
    MultiData → Data

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    SpinalTagReady

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

    Permalink
    Definition Classes
    Flow → DataCarrier

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

    Permalink
    Definition Classes
    Data

  66. def getBitsWidth: Int

    Permalink
    Definition Classes
    MultiData → Data

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

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()

  68. def getComponent(): Component

    Permalink
    Definition Classes
    Data → InComponent → NameableByComponent

  69. def getComponents(): Seq[Component]

    Permalink
    Definition Classes
    InComponent

  70. def getDirection: IODirection

    Permalink
    Definition Classes
    Data

  71. def getDisplayName(): String

    Permalink
    Definition Classes
    Nameable

  72. def getInstanceCounter: Int

    Permalink
    Definition Classes
    ContextUser

  73. def getMode: Byte

    Permalink
    Attributes
    protected
    Definition Classes
    Nameable

  74. def getName(default: String): String

    Permalink
    Definition Classes
    NameableByComponent → Nameable

  75. def getName(): String

    Permalink
    Definition Classes
    NameableByComponent → Nameable

  76. def getPartialName(): String

    Permalink
    Definition Classes
    Nameable

  77. def getRealSource: Any

    Permalink
    Definition Classes
    Assignable

  78. def getRealSourceNoRec: Any

    Permalink
    Definition Classes
    Data → Assignable

  79. def getRefOwnersChain(): List[Any]

    Permalink
    Definition Classes
    OwnableRef

  80. def getRootParent: Data

    Permalink
    Definition Classes
    Data

  81. def getScalaLocationLong: String

    Permalink
    Definition Classes
    ScalaLocated

  82. def getScalaLocationShort: String

    Permalink
    Definition Classes
    ScalaLocated

  83. def getScalaTrace(): Throwable

    Permalink
    Definition Classes
    ScalaLocated

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

    Permalink
    Definition Classes
    SpinalTagReady

  85. def getTags(): LinkedHashSet[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady

  86. def getTypeString: String

    Permalink
    Definition Classes
    Bundle

  87. def getZero: Flow.this.type

    Permalink
    Definition Classes
    MultiData → Data

  88. val globalData: GlobalData

    Permalink
    Definition Classes
    GlobalDataUser

  89. var hardtype: HardType[_]

    Permalink
    Definition Classes
    Bundle

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

    Permalink
    Definition Classes
    SpinalTagReady

  91. def hasTag(spinalTag: SpinalTag): Boolean

    Permalink
    Definition Classes
    SpinalTagReady

  92. def hashCode(): Int

    Permalink
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any

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

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    SpinalTagReady

  95. def instanceAttributes: Iterable[Attribute]

    Permalink
    Definition Classes
    SpinalTagReady

  96. def isAnalog: Boolean

    Permalink
    Definition Classes
    Data

  97. def isComb: Boolean

    Permalink
    Definition Classes
    Data

  98. def isCompletelyUnnamed: Boolean

    Permalink
    Definition Classes
    Nameable

  99. def isDirectionLess: Boolean

    Permalink
    Definition Classes
    Data

  100. def isEmptyOfTag: Boolean

    Permalink
    Definition Classes
    SpinalTagReady

  101. def isInOut: Boolean

    Permalink
    Definition Classes
    Data

  102. def isInput: Boolean

    Permalink
    Definition Classes
    Data

  103. def isInputOrInOut: Boolean

    Permalink
    Definition Classes
    Data

  104. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  105. var isMasterInterface: Boolean

    Permalink
    Definition Classes
    IMasterSlave

  106. def isNamed: Boolean

    Permalink
    Definition Classes
    NameableByComponent → Nameable

  107. def isOutput: Boolean

    Permalink
    Definition Classes
    Data

  108. def isOutputOrInOut: Boolean

    Permalink
    Definition Classes
    Data

  109. def isPriorityApplicable(namePriority: Byte): Boolean

    Permalink
    Definition Classes
    Nameable

  110. def isReg: Boolean

    Permalink
    Definition Classes
    Data

  111. def isUnnamed: Boolean

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Data

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

    Permalink

  114. def m2sPipe: Flow[T]

    Permalink

  115. var name: String

    Permalink
    Attributes
    protected
    Definition Classes
    Nameable

  116. var nameableRef: Nameable

    Permalink
    Attributes
    protected
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    AnyRef

  118. def noBackendCombMerge: Flow.this.type

    Permalink
    Definition Classes
    Data

  119. def noCombLoopCheck: Flow.this.type

    Permalink
    Definition Classes
    Data

  120. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()

  121. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()

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

    Permalink
    Definition Classes
    SpinalTagReady

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

    Permalink
    Definition Classes
    Nameable

  124. var parent: Data

    Permalink
    Definition Classes
    Data

  125. var parentScope: ScopeStatement

    Permalink
    Definition Classes
    ContextUser

  126. val payload: T

    Permalink
    Definition Classes
    Flow → DataCarrier

  127. val payloadType: HardType[T]

    Permalink

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

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    Data

  130. def push(that: T): Unit

    Permalink

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

    Permalink

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

    Permalink

  133. def randBoot(u: Unit): Flow.this.type

    Permalink
    Definition Classes
    Data

  134. var refOwner: RefOwnerType

    Permalink
    Definition Classes
    OwnableRef

  135. def reflectNames(): Unit

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    SpinalTagReady

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

    Permalink
    Definition Classes
    SpinalTagReady

  139. def resized: Flow.this.type

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    MultiData → Data

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

    Permalink
    Definition Classes
    MultiData → Data

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

    Permalink
    Definition Classes
    MultiData → Data

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

  161. def setRefOwner(that: Any): Unit

    Permalink
    Definition Classes
    OwnableRef

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

    Permalink
    Definition Classes
    ScalaLocated

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

    Permalink
    Definition Classes
    Nameable

  164. def spinalTags: LinkedHashSet[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady

  165. def stage(): Flow[T]

    Permalink

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

    Permalink

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

    Permalink
    Definition Classes
    AnyRef

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

    Permalink

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

    Permalink

  170. def toIo(): Flow.this.type

    Permalink
    Definition Classes
    Data

  171. def toReg(init: T): T

    Permalink

  172. def toReg(): T

    Permalink

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

    Permalink

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

    Permalink

  175. def toStream: Stream[T]

    Permalink

  176. def toString(): String

    Permalink
    Definition Classes
    Bundle → Nameable → AnyRef → Any

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

    Permalink

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

    Permalink

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    ValCallbackRec → ValCallback

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

    Permalink
    Definition Classes
    ValCallbackRec

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

    Permalink
    Definition Classes
    Bundle → ValCallbackRec

  183. val valid: Bool

    Permalink
    Definition Classes
    Flow → DataCarrier

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

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

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

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

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