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 #*(count: Int): Bits

    Permalink
    Definition Classes
    Data

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

    Permalink

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

    Permalink

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

    Permalink
    Definition Classes
    AnyRef → Any

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

    Permalink

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

    Permalink

  10. var _spinalTags: LinkedHashSet[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady

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

    Permalink
    Definition Classes
    Data → SpinalTagReady

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

    Permalink
    Definition Classes
    SpinalTagReady

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

    Permalink
    Definition Classes
    SpinalTagReady

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

    Permalink
    Definition Classes
    SpinalTagReady

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

    Permalink
    Definition Classes
    MultiData → SpinalTagReady

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

    Permalink
    Definition Classes
    SpinalTagReady

  17. def allowDirectionLessIo: Flow.this.type

    Permalink
    Definition Classes
    Data

  18. def allowOverride: Flow.this.type

    Permalink
    Definition Classes
    Data

  19. def allowPartialyAssigned: Flow.this.type

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    Data

  22. def allowUnsetRegToAvoidLatch: Flow.this.type

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    Data

  24. def asBits: Bits

    Permalink
    Definition Classes
    MultiData → Data

  25. def asData: Data

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    MultiData → Data

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

    Permalink
    Definition Classes
    MultiData → Data

  28. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  29. def asMaster(): Unit

    Permalink
    Definition Classes
    Flow → IMasterSlave

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

    Permalink
    Definition Classes
    MultiData → Data

  31. def asSlave(): Unit

    Permalink
    Definition Classes
    Flow → IMasterSlave

  32. def assignAllByName(that: Bundle): Unit

    Permalink
    Definition Classes
    Bundle

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

    Permalink
    Definition Classes
    Data

  34. def assignFormalRandom(kind: RandomExpKind): Unit

    Permalink
    Definition Classes
    MultiData → Data

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

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    MultiData → Data

  37. def assignFromBits(bits: Bits): Unit

    Permalink
    Definition Classes
    MultiData → Data

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

    Permalink
    Definition Classes
    Data

  39. def assignSomeByName(that: Bundle): Unit

    Permalink
    Definition Classes
    Bundle

  40. def assignUnassignedByName(that: MultiData): Unit

    Permalink
    Definition Classes
    MultiData

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

    Permalink
    Definition Classes
    Bundle

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

    Permalink

  43. def clone(): Flow[T]

    Permalink
    Definition Classes
    Flow → Bundle → Data → AnyRef

  44. def combStage(): Flow[T]

    Permalink

  45. def component: Component

    Permalink
    Definition Classes
    ContextUser

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

    Permalink
    Definition Classes
    Assignable

  47. var compositeAssign: Assignable

    Permalink
    Definition Classes
    Assignable

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

    Permalink

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

    Permalink
    Definition Classes
    MultiData → Data

  50. def default(that: T): Unit

    Permalink

  51. def dirString(): String

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    Bundle → MultiData

  54. def elementsString: String

    Permalink
    Definition Classes
    MultiData

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

    Permalink
    Definition Classes
    AnyRef

  56. def equals(obj: Any): Boolean

    Permalink
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any

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

    Permalink
    Definition Classes
    SpinalTagReady

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

    Permalink
    Definition Classes
    SpinalTagReady

  59. def find(name: String): Data

    Permalink
    Definition Classes
    MultiData

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

    Permalink
    Definition Classes
    SpinalTagReady

  61. def fire: Bool

    Permalink
    Definition Classes
    Flow → DataCarrier

  62. def flatten: Seq[BaseType]

    Permalink
    Definition Classes
    MultiData → Data

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

    Permalink
    Definition Classes
    MultiData → Data

  64. def flattenLocalName: Seq[String]

    Permalink
    Definition Classes
    MultiData → Data

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

    Permalink
    Definition Classes
    MultiData → Data

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    SpinalTagReady

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

    Permalink
    Definition Classes
    Flow → DataCarrier

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

    Permalink
    Definition Classes
    MultiData → Data

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

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    Data

  72. def getBitsWidth: Int

    Permalink
    Definition Classes
    MultiData → Data

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

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()

  74. def getComponent(): Component

    Permalink
    Definition Classes
    Data → InComponent → NameableByComponent

  75. def getComponents(): Seq[Component]

    Permalink
    Definition Classes
    InComponent

  76. def getDirection: IODirection

    Permalink
    Definition Classes
    Data

  77. def getDisplayName(): String

    Permalink
    Definition Classes
    Nameable

  78. def getInstanceCounter: Int

    Permalink
    Definition Classes
    ContextUser

  79. def getMode: Byte

    Permalink
    Attributes
    protected
    Definition Classes
    Nameable

  80. def getMuxType[T <: Data](list: TraversableOnce[T]): HardType[T]

    Permalink
    Definition Classes
    Data

  81. def getName(default: String): String

    Permalink
    Definition Classes
    NameableByComponent → Nameable

  82. def getName(): String

    Permalink
    Definition Classes
    NameableByComponent → Nameable

  83. def getPartialName(): String

    Permalink
    Definition Classes
    Nameable

  84. def getRealSource: Any

    Permalink
    Definition Classes
    Assignable

  85. def getRealSourceNoRec: Any

    Permalink
    Definition Classes
    Data → Assignable

  86. def getRefOwnersChain(): List[Any]

    Permalink
    Definition Classes
    OwnableRef

  87. def getRootParent: Data

    Permalink
    Definition Classes
    Data

  88. def getRtlPath(separator: String): String

    Permalink
    Definition Classes
    Data

  89. def getScalaLocationLong: String

    Permalink
    Definition Classes
    ScalaLocated

  90. def getScalaLocationShort: String

    Permalink
    Definition Classes
    ScalaLocated

  91. def getScalaTrace(): Throwable

    Permalink
    Definition Classes
    ScalaLocated

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

    Permalink
    Definition Classes
    SpinalTagReady

  93. def getTags(): LinkedHashSet[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady

  94. def getTypeString: String

    Permalink
    Definition Classes
    Bundle

  95. def getZero: Flow.this.type

    Permalink
    Definition Classes
    MultiData → Data

  96. val globalData: GlobalData

    Permalink
    Definition Classes
    GlobalDataUser

  97. var hardtype: HardType[_]

    Permalink
    Definition Classes
    Bundle

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

    Permalink
    Definition Classes
    SpinalTagReady

  99. def hasTag(spinalTag: SpinalTag): Boolean

    Permalink
    Definition Classes
    SpinalTagReady

  100. def hashCode(): Int

    Permalink
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any

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

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    SpinalTagReady

  103. def instanceAttributes: Iterable[Attribute]

    Permalink
    Definition Classes
    SpinalTagReady

  104. def isAnalog: Boolean

    Permalink
    Definition Classes
    Data

  105. def isComb: Boolean

    Permalink
    Definition Classes
    Data

  106. def isCompletelyUnnamed: Boolean

    Permalink
    Definition Classes
    Nameable

  107. def isDirectionLess: Boolean

    Permalink
    Definition Classes
    Data

  108. def isEmptyOfTag: Boolean

    Permalink
    Definition Classes
    SpinalTagReady

  109. def isInOut: Boolean

    Permalink
    Definition Classes
    Data

  110. def isInput: Boolean

    Permalink
    Definition Classes
    Data

  111. def isInputOrInOut: Boolean

    Permalink
    Definition Classes
    Data

  112. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  113. var isMasterInterface: Boolean

    Permalink
    Definition Classes
    IMasterSlave

  114. def isNamed: Boolean

    Permalink
    Definition Classes
    NameableByComponent → Nameable

  115. def isOutput: Boolean

    Permalink
    Definition Classes
    Data

  116. def isOutputOrInOut: Boolean

    Permalink
    Definition Classes
    Data

  117. def isPriorityApplicable(namePriority: Byte): Boolean

    Permalink
    Definition Classes
    Nameable

  118. def isReg: Boolean

    Permalink
    Definition Classes
    Data

  119. def isRegOnAssign: Boolean

    Permalink
    Definition Classes
    Data

  120. def isUnnamed: Boolean

    Permalink
    Definition Classes
    Nameable

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

    Permalink

  122. def m2sPipe: Flow[T]

    Permalink

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

    Permalink

  124. var name: String

    Permalink
    Definition Classes
    Nameable

  125. var nameableRef: Nameable

    Permalink
    Attributes
    protected
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    AnyRef

  127. def noBackendCombMerge: Flow.this.type

    Permalink
    Definition Classes
    Data

  128. def noCombLoopCheck: Flow.this.type

    Permalink
    Definition Classes
    Data

  129. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()

  130. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()

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

    Permalink
    Definition Classes
    SpinalTagReady

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

    Permalink
    Definition Classes
    Nameable

  133. var parent: Data

    Permalink
    Definition Classes
    Data

  134. var parentScope: ScopeStatement

    Permalink
    Definition Classes
    ContextUser

  135. val payload: T

    Permalink
    Definition Classes
    Flow → DataCarrier

  136. val payloadType: HardType[T]

    Permalink

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

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    Data

  140. def push(that: T): Unit

    Permalink

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

    Permalink

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

    Permalink

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

    Permalink
    Definition Classes
    Data

  144. var refOwner: RefOwnerType

    Permalink
    Definition Classes
    OwnableRef

  145. def reflectNames(): Unit

    Permalink
    Definition Classes
    Nameable

  146. def removeAssignments(data: Boolean, init: Boolean, initial: Boolean): Flow.this.type

    Permalink
    Definition Classes
    Data

  147. def removeDataAssignments(): Flow.this.type

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    SpinalTagReady

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

    Permalink
    Definition Classes
    SpinalTagReady

  151. def resized: Flow.this.type

    Permalink
    Definition Classes
    Data

  152. var scalaTrace: Throwable

    Permalink
    Definition Classes
    ScalaLocated

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

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    MultiData → Data

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

    Permalink
    Definition Classes
    MultiData → Data

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

    Permalink
    Definition Classes
    MultiData → Data

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

  175. def setRefOwner(that: Any): Unit

    Permalink
    Definition Classes
    OwnableRef

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

    Permalink
    Definition Classes
    ScalaLocated

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

    Permalink
    Definition Classes
    Nameable

  178. def spinalTags: LinkedHashSet[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady

  179. def stage(): Flow[T]

    Permalink

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

    Permalink

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

    Permalink
    Definition Classes
    AnyRef

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

    Permalink

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

    Permalink

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

    Permalink
    Definition Classes
    Data

  185. def toMuxInput[T <: Data](muxOutput: T): T

    Permalink
    Definition Classes
    Data

  186. def toReg(init: T): T

    Permalink

  187. def toReg(): T

    Permalink

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

    Permalink

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

    Permalink

  190. def toStream: Stream[T]

    Permalink

  191. def toString(): String

    Permalink
    Definition Classes
    Bundle → Nameable → AnyRef → Any

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

    Permalink

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

    Permalink

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

    Permalink
    Definition Classes
    MultiData → Data

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    ValCallbackRec → ValCallback

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

    Permalink
    Definition Classes
    ValCallbackRec

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

    Permalink
    Definition Classes
    Bundle → ValCallbackRec

  199. val valid: Bool

    Permalink
    Definition Classes
    Flow → DataCarrier

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

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

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

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

  202. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    MultiData

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

    Permalink

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