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, 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. OverridedEqualsHashCode
  10. SpinalTagReady
  11. Assignable
  12. NameableByComponent
  13. Nameable
  14. OwnableRef
  15. ContextUser
  16. ScalaLocated
  17. GlobalDataUser
  18. AnyRef
  19. 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: Set[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 allowPruning(): Flow.this.type

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    Data

  19. def allowUnsetRegToAvoidLatch: Flow.this.type

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    Data

  21. def asBits: Bits

    Permalink
    Definition Classes
    MultiData → Data

  22. def asData: Data

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    MultiData → Data

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

    Permalink
    Definition Classes
    MultiData → Data

  25. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  26. def asMaster(): Unit

    Permalink
    Definition Classes
    Flow → IMasterSlave

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

    Permalink
    Definition Classes
    MultiData → Data

  28. def asSlave(): Unit

    Permalink
    Definition Classes
    Flow → IMasterSlave

  29. def assignAllByName(that: Bundle): Unit

    Permalink
    Definition Classes
    Bundle

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

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    MultiData → Data

  33. def assignFromBits(bits: Bits): Unit

    Permalink
    Definition Classes
    MultiData → Data

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

    Permalink
    Definition Classes
    Data

  35. def assignSomeByName(that: Bundle): Unit

    Permalink
    Definition Classes
    Bundle

  36. def clone(): Flow[T]

    Permalink
    Definition Classes
    Flow → Bundle → Data → AnyRef

  37. def component: Component

    Permalink
    Definition Classes
    ContextUser

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

    Permalink
    Definition Classes
    Assignable

  39. var compositeAssign: Assignable

    Permalink
    Definition Classes
    Assignable

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

    Permalink

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

    Permalink
    Definition Classes
    MultiData → Data

  42. def default(that: T): Unit

    Permalink

  43. def dirString(): String

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    Bundle → MultiData

  46. def elementsString: String

    Permalink
    Definition Classes
    MultiData

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

    Permalink
    Definition Classes
    AnyRef

  48. def equals(obj: Any): Boolean

    Permalink
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any

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

    Permalink
    Definition Classes
    SpinalTagReady

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

    Permalink
    Definition Classes
    SpinalTagReady

  51. def find(name: String): Data

    Permalink
    Definition Classes
    MultiData

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

    Permalink
    Definition Classes
    SpinalTagReady

  53. def fire: Bool

    Permalink
    Definition Classes
    Flow → DataCarrier

  54. def flatten: Seq[BaseType]

    Permalink
    Definition Classes
    MultiData → Data

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

    Permalink
    Definition Classes
    MultiData → Data

  56. def flattenLocalName: Seq[String]

    Permalink
    Definition Classes
    MultiData → Data

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

    Permalink
    Definition Classes
    MultiData → Data

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    SpinalTagReady

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

    Permalink
    Definition Classes
    Flow → DataCarrier

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

    Permalink
    Definition Classes
    Data

  62. def getBitsWidth: Int

    Permalink
    Definition Classes
    MultiData → Data

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

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()

  64. def getComponent(): Component

    Permalink
    Definition Classes
    Data → NameableByComponent

  65. def getComponents(): Seq[Component]

    Permalink
    Definition Classes
    Data

  66. def getDirection: IODirection

    Permalink
    Definition Classes
    Data

  67. def getDisplayName(): String

    Permalink
    Definition Classes
    Nameable

  68. def getInstanceCounter: Int

    Permalink
    Definition Classes
    ContextUser

  69. def getMode: Byte

    Permalink
    Attributes
    protected
    Definition Classes
    Nameable

  70. def getName(default: String): String

    Permalink
    Definition Classes
    NameableByComponent → Nameable

  71. def getName(): String

    Permalink
    Definition Classes
    Nameable

  72. def getPartialName(): String

    Permalink
    Definition Classes
    Nameable

  73. def getRealSource: Any

    Permalink
    Definition Classes
    Assignable

  74. def getRealSourceNoRec: Any

    Permalink
    Definition Classes
    Data → Assignable

  75. def getRefOwnersChain(): List[Any]

    Permalink
    Definition Classes
    OwnableRef

  76. def getRootParent: Data

    Permalink
    Definition Classes
    Data

  77. def getScalaLocationLong: String

    Permalink
    Definition Classes
    ScalaLocated

  78. def getScalaLocationShort: String

    Permalink
    Definition Classes
    ScalaLocated

  79. def getScalaTrace(): Throwable

    Permalink
    Definition Classes
    ScalaLocated

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

    Permalink
    Definition Classes
    SpinalTagReady

  81. def getTags(): Set[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady

  82. def getTypeString: String

    Permalink
    Definition Classes
    Bundle

  83. def getZero: Flow.this.type

    Permalink
    Definition Classes
    MultiData → Data

  84. val globalData: GlobalData

    Permalink
    Definition Classes
    GlobalDataUser

  85. var hardtype: HardType[_]

    Permalink
    Definition Classes
    Bundle

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

    Permalink
    Definition Classes
    SpinalTagReady

  87. def hasTag(spinalTag: SpinalTag): Boolean

    Permalink
    Definition Classes
    SpinalTagReady

  88. def hashCode(): Int

    Permalink
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any

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

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    SpinalTagReady

  91. def instanceAttributes: Iterable[Attribute]

    Permalink
    Definition Classes
    SpinalTagReady

  92. def isAnalog: Boolean

    Permalink
    Definition Classes
    Data

  93. def isComb: Boolean

    Permalink
    Definition Classes
    Data

  94. def isDirectionLess: Boolean

    Permalink
    Definition Classes
    Data

  95. def isEmptyOfTag: Boolean

    Permalink
    Definition Classes
    SpinalTagReady

  96. def isInOut: Boolean

    Permalink
    Definition Classes
    Data

  97. def isInput: Boolean

    Permalink
    Definition Classes
    Data

  98. def isInputOrInOut: Boolean

    Permalink
    Definition Classes
    Data

  99. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  100. var isMasterInterface: Boolean

    Permalink
    Definition Classes
    IMasterSlave

  101. def isNamed: Boolean

    Permalink
    Definition Classes
    NameableByComponent → Nameable

  102. def isOutput: Boolean

    Permalink
    Definition Classes
    Data

  103. def isOutputOrInOut: Boolean

    Permalink
    Definition Classes
    Data

  104. def isPriorityApplicable(namePriority: Byte): Boolean

    Permalink
    Definition Classes
    Nameable

  105. def isReg: Boolean

    Permalink
    Definition Classes
    Data

  106. def isUnnamed: Boolean

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Data

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

    Permalink

  109. def m2sPipe: Flow[T]

    Permalink

  110. var name: String

    Permalink
    Attributes
    protected
    Definition Classes
    Nameable

  111. var nameableRef: Nameable

    Permalink
    Attributes
    protected
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    AnyRef

  113. def noBackendCombMerge: Flow.this.type

    Permalink
    Definition Classes
    Data

  114. def noCombLoopCheck: Flow.this.type

    Permalink
    Definition Classes
    Data

  115. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()

  116. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()

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

    Permalink
    Definition Classes
    SpinalTagReady

  118. var parent: Data

    Permalink
    Definition Classes
    Data

  119. var parentScope: ScopeStatement

    Permalink
    Definition Classes
    ContextUser

  120. val payload: T

    Permalink
    Definition Classes
    Flow → DataCarrier

  121. val payloadType: HardType[T]

    Permalink

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

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    Data

  124. def push(that: T): Unit

    Permalink

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

    Permalink

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

    Permalink

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

    Permalink
    Definition Classes
    Data

  128. var refOwner: RefOwnerType

    Permalink
    Definition Classes
    OwnableRef

  129. def reflectNames(): Unit

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    SpinalTagReady

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

    Permalink
    Definition Classes
    SpinalTagReady

  133. def resized: Flow.this.type

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    MultiData → Data

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

    Permalink
    Definition Classes
    MultiData → Data

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

    Permalink
    Definition Classes
    MultiData → Data

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

  153. def setRefOwner(that: Any): Unit

    Permalink
    Definition Classes
    OwnableRef

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

    Permalink
    Definition Classes
    ScalaLocated

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

    Permalink
    Definition Classes
    Nameable

  156. def spinalTags: Set[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady

  157. def stage(): Flow[T]

    Permalink

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

    Permalink
    Definition Classes
    AnyRef

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

    Permalink

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

    Permalink

  161. def toReg(init: T): T

    Permalink

  162. def toReg(): T

    Permalink

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

    Permalink

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

    Permalink

  165. def toStream: Stream[T]

    Permalink

  166. def toString(): String

    Permalink
    Definition Classes
    Bundle → Nameable → AnyRef → Any

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

    Permalink

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

    Permalink

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    ValCallbackRec → ValCallback

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

    Permalink
    Definition Classes
    ValCallbackRec

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

    Permalink
    Definition Classes
    Bundle → ValCallbackRec

  173. val valid: Bool

    Permalink
    Definition Classes
    Flow → DataCarrier

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

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

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

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

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