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. def assignFormalRandom(kind: RandomExpKind): Unit

    Permalink
    Definition Classes
    MultiData → Data

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

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    MultiData → Data

  36. def assignFromBits(bits: Bits): Unit

    Permalink
    Definition Classes
    MultiData → Data

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

    Permalink
    Definition Classes
    Data

  38. def assignSomeByName(that: Bundle): Unit

    Permalink
    Definition Classes
    Bundle

  39. def assignUnassignedByName(that: MultiData): Unit

    Permalink
    Definition Classes
    MultiData

  40. def bundleAssign(that: Bundle)(f: (Data, Data) ⇒ Unit): Unit

    Permalink
    Definition Classes
    Bundle

  41. def ccToggle(pushClock: ClockDomain, popClock: ClockDomain, withOutputBufferedReset: Boolean = true, withOutputM2sPipe: Boolean = true): Flow[T]

    Permalink

  42. def clone(): Flow[T]

    Permalink
    Definition Classes
    Flow → Bundle → Data → AnyRef

  43. def combStage(): Flow[T]

    Permalink

  44. def component: Component

    Permalink
    Definition Classes
    ContextUser

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

    Permalink
    Definition Classes
    Assignable

  46. var compositeAssign: Assignable

    Permalink
    Definition Classes
    Assignable

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

    Permalink

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

    Permalink
    Definition Classes
    MultiData → Data

  49. def default(that: T): Unit

    Permalink

  50. def dirString(): String

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    Bundle → MultiData

  53. def elementsString: String

    Permalink
    Definition Classes
    MultiData

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

    Permalink
    Definition Classes
    AnyRef

  55. def equals(obj: Any): Boolean

    Permalink
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any

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

    Permalink
    Definition Classes
    SpinalTagReady

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

    Permalink
    Definition Classes
    SpinalTagReady

  58. def find(name: String): Data

    Permalink
    Definition Classes
    MultiData

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

    Permalink
    Definition Classes
    SpinalTagReady

  60. def fire: Bool

    Permalink
    Definition Classes
    Flow → DataCarrier

  61. def flatten: Seq[BaseType]

    Permalink
    Definition Classes
    MultiData → Data

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

    Permalink
    Definition Classes
    MultiData → Data

  63. def flattenLocalName: Seq[String]

    Permalink
    Definition Classes
    MultiData → Data

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

    Permalink
    Definition Classes
    MultiData → Data

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    SpinalTagReady

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

    Permalink
    Definition Classes
    Flow → DataCarrier

  68. def freeze(): Flow.this.type

    Permalink
    Definition Classes
    MultiData → Data

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

    Permalink
    Definition Classes
    Data

  70. def getAheadValue(): Flow.this.type

    Permalink
    Definition Classes
    Data

  71. def getBitsWidth: Int

    Permalink
    Definition Classes
    MultiData → Data

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

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()

  73. def getComponent(): Component

    Permalink
    Definition Classes
    Data → InComponent → NameableByComponent

  74. def getComponents(): Seq[Component]

    Permalink
    Definition Classes
    InComponent

  75. def getDirection: IODirection

    Permalink
    Definition Classes
    Data

  76. def getDisplayName(): String

    Permalink
    Definition Classes
    Nameable

  77. def getInstanceCounter: Int

    Permalink
    Definition Classes
    ContextUser

  78. def getMode: Byte

    Permalink
    Attributes
    protected
    Definition Classes
    Nameable

  79. def getName(default: String): String

    Permalink
    Definition Classes
    NameableByComponent → Nameable

  80. def getName(): String

    Permalink
    Definition Classes
    NameableByComponent → Nameable

  81. def getPartialName(): String

    Permalink
    Definition Classes
    Nameable

  82. def getRealSource: Any

    Permalink
    Definition Classes
    Assignable

  83. def getRealSourceNoRec: Any

    Permalink
    Definition Classes
    Data → Assignable

  84. def getRefOwnersChain(): List[Any]

    Permalink
    Definition Classes
    OwnableRef

  85. def getRootParent: Data

    Permalink
    Definition Classes
    Data

  86. def getRtlPath(separator: String): String

    Permalink
    Definition Classes
    Data

  87. def getScalaLocationLong: String

    Permalink
    Definition Classes
    ScalaLocated

  88. def getScalaLocationShort: String

    Permalink
    Definition Classes
    ScalaLocated

  89. def getScalaTrace(): Throwable

    Permalink
    Definition Classes
    ScalaLocated

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

    Permalink
    Definition Classes
    SpinalTagReady

  91. def getTags(): LinkedHashSet[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady

  92. def getTypeString: String

    Permalink
    Definition Classes
    Bundle

  93. def getZero: Flow.this.type

    Permalink
    Definition Classes
    MultiData → Data

  94. val globalData: GlobalData

    Permalink
    Definition Classes
    GlobalDataUser

  95. var hardtype: HardType[_]

    Permalink
    Definition Classes
    Bundle

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

    Permalink
    Definition Classes
    SpinalTagReady

  97. def hasTag(spinalTag: SpinalTag): Boolean

    Permalink
    Definition Classes
    SpinalTagReady

  98. def hashCode(): Int

    Permalink
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any

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

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    SpinalTagReady

  101. def instanceAttributes: Iterable[Attribute]

    Permalink
    Definition Classes
    SpinalTagReady

  102. def isAnalog: Boolean

    Permalink
    Definition Classes
    Data

  103. def isComb: Boolean

    Permalink
    Definition Classes
    Data

  104. def isCompletelyUnnamed: Boolean

    Permalink
    Definition Classes
    Nameable

  105. def isDirectionLess: Boolean

    Permalink
    Definition Classes
    Data

  106. def isEmptyOfTag: Boolean

    Permalink
    Definition Classes
    SpinalTagReady

  107. def isInOut: Boolean

    Permalink
    Definition Classes
    Data

  108. def isInput: Boolean

    Permalink
    Definition Classes
    Data

  109. def isInputOrInOut: Boolean

    Permalink
    Definition Classes
    Data

  110. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  111. var isMasterInterface: Boolean

    Permalink
    Definition Classes
    IMasterSlave

  112. def isNamed: Boolean

    Permalink
    Definition Classes
    NameableByComponent → Nameable

  113. def isOutput: Boolean

    Permalink
    Definition Classes
    Data

  114. def isOutputOrInOut: Boolean

    Permalink
    Definition Classes
    Data

  115. def isPriorityApplicable(namePriority: Byte): Boolean

    Permalink
    Definition Classes
    Nameable

  116. def isReg: Boolean

    Permalink
    Definition Classes
    Data

  117. def isUnnamed: Boolean

    Permalink
    Definition Classes
    Nameable

  118. def m2sPipe(holdPayload: Boolean = false, flush: Bool = null): Flow[T]

    Permalink

  119. def m2sPipe: Flow[T]

    Permalink

  120. def map[T2 <: Data](translate: (T) ⇒ T2): Flow[T2]

    Permalink

  121. var name: String

    Permalink
    Definition Classes
    Nameable

  122. var nameableRef: Nameable

    Permalink
    Attributes
    protected
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    AnyRef

  124. def noBackendCombMerge: Flow.this.type

    Permalink
    Definition Classes
    Data

  125. def noCombLoopCheck: Flow.this.type

    Permalink
    Definition Classes
    Data

  126. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()

  127. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()

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

    Permalink
    Definition Classes
    SpinalTagReady

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

    Permalink
    Definition Classes
    Nameable

  130. var parent: Data

    Permalink
    Definition Classes
    Data

  131. var parentScope: ScopeStatement

    Permalink
    Definition Classes
    ContextUser

  132. val payload: T

    Permalink
    Definition Classes
    Flow → DataCarrier

  133. val payloadType: HardType[T]

    Permalink

  134. def pull(propagateName: Boolean): Flow.this.type

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    Data

  137. def push(that: T): Unit

    Permalink

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

    Permalink

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

    Permalink

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

    Permalink
    Definition Classes
    Data

  141. var refOwner: RefOwnerType

    Permalink
    Definition Classes
    OwnableRef

  142. def reflectNames(): Unit

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    SpinalTagReady

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

    Permalink
    Definition Classes
    SpinalTagReady

  146. def resized: Flow.this.type

    Permalink
    Definition Classes
    Data

  147. var scalaTrace: Throwable

    Permalink
    Definition Classes
    ScalaLocated

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

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    MultiData → Data

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

    Permalink
    Definition Classes
    MultiData → Data

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

    Permalink
    Definition Classes
    MultiData → Data

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

  163. def setPartialName(name: String, namePriority: Byte, owner: Any): Flow.this.type

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

  170. def setRefOwner(that: Any): Unit

    Permalink
    Definition Classes
    OwnableRef

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

    Permalink
    Definition Classes
    ScalaLocated

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

    Permalink
    Definition Classes
    Nameable

  173. def spinalTags: LinkedHashSet[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady

  174. def stage(): Flow[T]

    Permalink

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

    Permalink

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

    Permalink
    Definition Classes
    AnyRef

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

    Permalink

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

    Permalink

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

    Permalink
    Definition Classes
    Data

  180. def toReg(init: T): T

    Permalink

  181. def toReg(): T

    Permalink

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

    Permalink

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

    Permalink

  184. def toStream: Stream[T]

    Permalink

  185. def toString(): String

    Permalink
    Definition Classes
    Bundle → Nameable → AnyRef → Any

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

    Permalink

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

    Permalink

  188. def unfreeze(): Flow.this.type

    Permalink
    Definition Classes
    MultiData → Data

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    ValCallbackRec → ValCallback

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

    Permalink
    Definition Classes
    ValCallbackRec

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

    Permalink
    Definition Classes
    Bundle → ValCallbackRec

  193. val valid: Bool

    Permalink
    Definition Classes
    Flow → DataCarrier

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

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

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

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

  196. final def wait(): Unit

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

  197. def wrapNext(): Flow.this.type

    Permalink
    Definition Classes
    Data

  198. def zipByName(that: MultiData, rec: ArrayBuffer[(BaseType, BaseType)]): ArrayBuffer[(BaseType, BaseType)]

    Permalink
    Definition Classes
    MultiData

  199. def ~[T2 <: Data](that: T2): Flow[T2]

    Permalink

  200. def ~~[T2 <: Data](translate: (T) ⇒ T2): Flow[T2]

    Permalink

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