Packages

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])

Type Members

  1. abstract type RefOwnerType
    Definition Classes
    OwnableRef

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. def ##(right: Data): Bits
    Definition Classes
    Data
  3. final def ##(): Int
    Definition Classes
    AnyRef → Any
  4. def #*(count: Int): Bits
    Definition Classes
    Data
  5. def <-<(that: Flow[T]): Flow[T]
  6. def <<(that: Flow[T]): Flow[T]
  7. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def >->(that: Flow[T]): Flow[T]
  9. def >>(into: Flow[T]): Flow[T]
  10. val _spinalTags: LinkedHashSet[SpinalTag]
    Definition Classes
    SpinalTagReady
  11. def addAttribute(attribute: Attribute): Flow.this.type
    Definition Classes
    Data → SpinalTagReady
  12. def addAttribute(name: String, value: Int): Flow.this.type
    Definition Classes
    SpinalTagReady
  13. def addAttribute(name: String, value: String): Flow.this.type
    Definition Classes
    SpinalTagReady
  14. def addAttribute(name: String): Flow.this.type
    Definition Classes
    SpinalTagReady
  15. def addTag[T <: SpinalTag](spinalTag: T): Flow.this.type
    Definition Classes
    MultiData → SpinalTagReady
  16. def addTags[T <: SpinalTag](tags: Iterable[T]): Flow.this.type
    Definition Classes
    SpinalTagReady
  17. def allowDirectionLessIo(): Flow.this.type
    Definition Classes
    Data
  18. def allowOverride(): Flow.this.type
    Definition Classes
    Data
  19. def allowPartialyAssigned(): Flow.this.type
    Definition Classes
    Data
  20. def allowPruning(): Flow.this.type
    Definition Classes
    Data
  21. def allowSimplifyIt(): Flow.this.type
    Definition Classes
    Data
  22. def allowUnsetRegToAvoidLatch(): Flow.this.type
    Definition Classes
    Data
  23. def as[T <: Data](dataType: HardType[T]): T
    Definition Classes
    Data
  24. def asBits: Bits
    Definition Classes
    MultiData → Data
  25. def asData: Data
    Definition Classes
    Data
  26. def asInOut(): Flow.this.type
    Definition Classes
    MultiData → Data
  27. def asInput(): Flow.this.type
    Definition Classes
    MultiData → Data
  28. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  29. def asOutput(): Flow.this.type
    Definition Classes
    MultiData → Data
  30. def assignAllByName(that: Bundle): Unit
    Definition Classes
    Bundle
  31. def assignDontCare(): Flow.this.type
    Definition Classes
    Data
  32. def assignFormalRandom(kind: RandomExpKind): Unit
    Definition Classes
    MultiData → Data
  33. final def assignFrom(that: AnyRef, target: AnyRef)(implicit loc: Location): Unit
    Definition Classes
    Data
  34. def assignFromBits(bits: Bits, hi: Int, lo: Int): Unit
    Definition Classes
    MultiData → Data
  35. def assignFromBits(bits: Bits): Unit
    Definition Classes
    MultiData → Data
  36. def assignFromBits(bits: Bits, offset: Int, bitCount: BitCount): Unit
    Definition Classes
    Data
  37. def assignSomeByName(that: Bundle): Unit
    Definition Classes
    Bundle
  38. def assignUnassignedByName(that: MultiData): Unit
    Definition Classes
    MultiData
  39. def bundleAssign(that: Bundle)(f: (Data, Data) ⇒ Unit): Unit
    Definition Classes
    Bundle
  40. def ccToggle(pushClock: ClockDomain, popClock: ClockDomain, withOutputBufferedReset: Boolean = true, withOutputM2sPipe: Boolean = true): Flow[T]
  41. def clone(): Flow[T]
    Definition Classes
    Flow → Bundle → Data → AnyRef
  42. def combStage(): Flow[T]
  43. def component: Component
    Definition Classes
    ContextUser
  44. final def compositAssignFrom(that: AnyRef, target: AnyRef, kind: AnyRef)(implicit loc: Location): Unit
    Definition Classes
    Assignable
  45. val compositeAssign: Assignable
    Definition Classes
    Assignable
  46. def connectFrom(that: Flow[T]): Flow[T]
  47. def copyDirectionOfImpl(that: Data): Flow.this.type
    Definition Classes
    MultiData → Data
  48. def default(that: T): Unit
  49. def dirString(): String
    Definition Classes
    Data
  50. def dontSimplifyIt(): Flow.this.type
    Definition Classes
    Data
  51. def elements: ArrayBuffer[(String, Data)]
    Definition Classes
    Bundle → MultiData
  52. var elementsCache: ArrayBuffer[(String, Data)]
    Definition Classes
    Bundle
  53. def elementsString: String
    Definition Classes
    MultiData
  54. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  55. def equals(obj: Any): Boolean
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  56. def existsTag(cond: (SpinalTag) ⇒ Boolean): Boolean
    Definition Classes
    SpinalTagReady
  57. def filterTag(cond: (SpinalTag) ⇒ Boolean): Iterable[SpinalTag]
    Definition Classes
    SpinalTagReady
  58. def find(name: String): Data
    Definition Classes
    MultiData
  59. def findTag(cond: (SpinalTag) ⇒ Boolean): Option[SpinalTag]
    Definition Classes
    SpinalTagReady
  60. def fire: Bool
    Definition Classes
    Flow → DataCarrier
  61. def flatten: Seq[BaseType]
    Definition Classes
    MultiData → Data
  62. def flattenForeach(body: (BaseType) ⇒ Unit): Unit
    Definition Classes
    MultiData → Data
  63. def flattenLocalName: Seq[String]
    Definition Classes
    MultiData → Data
  64. def flip(): Flow.this.type
    Definition Classes
    MultiData → Data
  65. def foreachReflectableNameables(doThat: (Any) ⇒ Unit): Unit
    Definition Classes
    Nameable
  66. def foreachTag(body: (SpinalTag) ⇒ Unit): Unit
    Definition Classes
    SpinalTagReady
  67. def freeRun(): Flow.this.type
    Definition Classes
    Flow → DataCarrier
  68. def freeze(): Flow.this.type
    Definition Classes
    MultiData → Data
  69. def genIf(cond: Boolean): Flow.this.type
    Definition Classes
    Data
  70. def getAheadValue(): Flow.this.type
    Definition Classes
    Data
  71. def getBitsWidth: Int
    Definition Classes
    MultiData → Data
  72. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  73. def getComponent(): Component
    Definition Classes
    Data → InComponent → NameableByComponent
  74. def getComponents(): Seq[Component]
    Definition Classes
    InComponent
  75. def getDirection: IODirection
    Definition Classes
    Data
  76. def getDisplayName(): String
    Definition Classes
    Nameable
  77. def getInstanceCounter: Int
    Definition Classes
    ContextUser
  78. def getMode: Byte
    Attributes
    protected
    Definition Classes
    Nameable
  79. def getMuxType[T <: Data](list: TraversableOnce[T]): HardType[T]
    Definition Classes
    Data
  80. def getName(default: String): String
    Definition Classes
    NameableByComponent → Nameable
  81. def getName(): String
    Definition Classes
    NameableByComponent → Nameable
  82. def getPartialName(): String
    Definition Classes
    Nameable
  83. def getPath(from: Component, to: Component): Seq[Component]
    Definition Classes
    NameableByComponent
  84. def getRealSource: Any
    Definition Classes
    Assignable
  85. def getRealSourceNoRec: Any
    Definition Classes
    Data → Assignable
  86. def getRefOwnersChain(): List[Any]
    Definition Classes
    OwnableRef
  87. def getRootParent: Data
    Definition Classes
    Data
  88. def getRtlPath(separator: String): String
    Definition Classes
    Data
  89. def getScalaLocationLong: String
    Definition Classes
    ScalaLocated
  90. def getScalaLocationShort: String
    Definition Classes
    ScalaLocated
  91. def getScalaTrace(): Throwable
    Definition Classes
    ScalaLocated
  92. def getTag[T <: SpinalTag](clazz: Class[T]): Option[T]
    Definition Classes
    SpinalTagReady
  93. def getTags(): LinkedHashSet[SpinalTag]
    Definition Classes
    SpinalTagReady
  94. def getTypeString: String
    Definition Classes
    Bundle
  95. def getZero: Flow.this.type
    Definition Classes
    MultiData → Data
  96. val globalData: GlobalData
    Definition Classes
    GlobalDataUser
  97. var hardtype: HardType[_]
    Definition Classes
    Bundle
  98. def hasTag[T <: SpinalTag](clazz: Class[T]): Boolean
    Definition Classes
    SpinalTagReady
  99. def hasTag(spinalTag: SpinalTag): Boolean
    Definition Classes
    SpinalTagReady
  100. def hashCode(): Int
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  101. final def initFrom(that: AnyRef, target: AnyRef): Unit
    Definition Classes
    Data
  102. def instanceAttributes(language: Language): Iterable[Attribute]
    Definition Classes
    SpinalTagReady
  103. def instanceAttributes: Iterable[Attribute]
    Definition Classes
    SpinalTagReady
  104. final def intoMaster(): Flow.this.type

    Convert into master

    Convert into master

    Definition Classes
    IMasterSlave
  105. final def intoSlave(): Flow.this.type

    Convert into slave

    Convert into slave

    Definition Classes
    IMasterSlave
  106. def isAnalog: Boolean
    Definition Classes
    Data
  107. def isComb: Boolean
    Definition Classes
    Data
  108. def isCompletelyUnnamed: Boolean
    Definition Classes
    Nameable
  109. def isDirectionLess: Boolean
    Definition Classes
    Data
  110. def isEmptyOfTag: Boolean
    Definition Classes
    SpinalTagReady
  111. def isInOut: Boolean
    Definition Classes
    Data
  112. def isInput: Boolean
    Definition Classes
    Data
  113. def isInputOrInOut: Boolean
    Definition Classes
    Data
  114. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  115. final def isMasterInterface: Boolean

    Are port directions set for a Master interface?

    Are port directions set for a Master interface?

    Definition Classes
    IMasterSlave
  116. def isNamed: Boolean
    Definition Classes
    NameableByComponent → Nameable
  117. def isOutput: Boolean
    Definition Classes
    Data
  118. def isOutputOrInOut: Boolean
    Definition Classes
    Data
  119. def isPriorityApplicable(namePriority: Byte): Boolean
    Definition Classes
    Nameable
  120. def isReg: Boolean
    Definition Classes
    Data
  121. def isRegOnAssign: Boolean
    Definition Classes
    Data
  122. final def isSlaveInterface: Boolean

    Are port directions set for a Master interface?

    Are port directions set for a Master interface?

    Definition Classes
    IMasterSlave
  123. def isUnnamed: Boolean
    Definition Classes
    Nameable
  124. def m2sPipe(holdPayload: Boolean = false, flush: Bool = null): Flow[T]
  125. def m2sPipe: Flow[T]
  126. def map[T2 <: Data](translate: (T) ⇒ T2): Flow[T2]
  127. val name: String
    Definition Classes
    Nameable
  128. val nameableRef: Nameable
    Attributes
    protected
    Definition Classes
    Nameable
    Annotations
    @DontName()
  129. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  130. def noBackendCombMerge(): Flow.this.type
    Definition Classes
    Data
  131. def noCombLoopCheck(): Flow.this.type
    Definition Classes
    Data
  132. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  133. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  134. def onEachAttributes(doIt: (Attribute) ⇒ Unit): Unit
    Definition Classes
    SpinalTagReady
  135. def overrideLocalName(name: String): Flow.this.type
    Definition Classes
    Nameable
  136. val parent: Data
    Definition Classes
    Data
  137. val parentScope: ScopeStatement
    Definition Classes
    ContextUser
  138. val payload: T
    Definition Classes
    Flow → DataCarrier
  139. val payloadType: HardType[T]
  140. def pull(propagateName: Boolean): Flow.this.type
    Definition Classes
    Data
  141. def pull(): Flow.this.type
    Definition Classes
    Data
  142. def purify(): Flow.this.type
    Definition Classes
    Data
  143. def push(that: T): Unit
  144. def queueWithAvailability(size: Int): (Stream[T], UInt)
  145. def queueWithOccupancy(size: Int): (Stream[T], UInt)
  146. def randBoot(u: Unit): Flow.this.type
    Definition Classes
    Data
  147. val refOwner: RefOwnerType
    Definition Classes
    OwnableRef
    Annotations
    @DontName()
  148. def reflectNames(): Unit
    Definition Classes
    Nameable
  149. def removeAssignments(data: Boolean, init: Boolean, initial: Boolean): Flow.this.type
    Definition Classes
    Data
  150. def removeDataAssignments(): Flow.this.type
    Definition Classes
    Data
  151. def removeInitAssignments(): Flow.this.type
    Definition Classes
    Data
  152. def removeTag(spinalTag: SpinalTag): Flow.this.type
    Definition Classes
    SpinalTagReady
  153. def removeTags(tags: Iterable[SpinalTag]): Flow.this.type
    Definition Classes
    SpinalTagReady
  154. def resized: Flow.this.type
    Definition Classes
    Data
  155. val scalaTrace: Throwable
    Definition Classes
    ScalaLocated
  156. def setAsAnalog(): Flow.this.type
    Definition Classes
    Data
  157. def setAsComb(): Flow.this.type
    Definition Classes
    MultiData → Data
  158. def setAsDirectionLess(): Flow.this.type
    Definition Classes
    MultiData → Data
  159. final def setAsMaster(): Unit

    Set as master interface

    Set as master interface

    Definition Classes
    IMasterSlave
  160. def setAsReg(): Flow.this.type
    Definition Classes
    MultiData → Data
  161. final def setAsSlave(): Unit

    Set a slave interface

    Set a slave interface

    Definition Classes
    IMasterSlave
  162. def setCompositeName(nameable: Nameable, postfix: String, namePriority: Byte): Flow.this.type
    Definition Classes
    Nameable
  163. def setCompositeName(nameable: Nameable, postfix: String, weak: Boolean): Flow.this.type
    Definition Classes
    Nameable
  164. def setCompositeName(nameable: Nameable, postfix: String): Flow.this.type
    Definition Classes
    Nameable
  165. def setCompositeName(nameable: Nameable, namePriority: Byte): Flow.this.type
    Definition Classes
    Nameable
  166. def setCompositeName(nameable: Nameable, weak: Boolean): Flow.this.type
    Definition Classes
    Nameable
  167. def setCompositeName(nameable: Nameable): Flow.this.type
    Definition Classes
    Nameable
  168. def setIdle(): Flow.this.type
  169. def setLambdaName(isNameBody: ⇒ Boolean)(nameGen: ⇒ String): Flow.this.type
    Definition Classes
    Nameable
  170. def setName(name: String, namePriority: Byte): Flow.this.type
    Definition Classes
    Nameable
  171. def setName(name: String, weak: Boolean): Flow.this.type
    Definition Classes
    Nameable
  172. def setName(name: String): Flow.this.type
    Definition Classes
    Nameable
  173. def setNameAsWeak(): Flow.this.type
    Definition Classes
    Nameable
  174. def setPartialName(name: String, namePriority: Byte, owner: Any): Flow.this.type
    Definition Classes
    Nameable
  175. def setPartialName(name: String, namePriority: Byte): Flow.this.type
    Definition Classes
    Nameable
  176. def setPartialName(name: String, weak: Boolean): Flow.this.type
    Definition Classes
    Nameable
  177. def setPartialName(owner: Nameable, name: String, namePriority: Byte): Flow.this.type
    Definition Classes
    Nameable
  178. def setPartialName(owner: Nameable, name: String, weak: Boolean): Flow.this.type
    Definition Classes
    Nameable
  179. def setPartialName(name: String): Flow.this.type
    Definition Classes
    Nameable
  180. def setPartialName(owner: Nameable, name: String): Flow.this.type
    Definition Classes
    Nameable
  181. def setPartialName(owner: Nameable): Flow.this.type
    Definition Classes
    Nameable
  182. def setRefOwner(that: Any): Unit
    Definition Classes
    OwnableRef
  183. def setScalaLocated(source: ScalaLocated): Flow.this.type
    Definition Classes
    ScalaLocated
  184. def setWeakName(name: String): Flow.this.type
    Definition Classes
    Nameable
  185. def spinalTags: LinkedHashSet[SpinalTag]
    Definition Classes
    SpinalTagReady
  186. def stage(): Flow[T]
  187. def swapPayload[T2 <: Data](that: HardType[T2]): Flow[T2]
  188. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  189. def takeWhen(cond: Bool): Flow[T]
  190. def throwWhen(cond: Bool): Flow[T]
  191. def toIo(): Flow.this.type
    Definition Classes
    Data
  192. def toMuxInput[T <: Data](muxOutput: T): T
    Definition Classes
    Data
  193. def toReg(init: T): T
  194. def toReg(): T
  195. def toStream(overflow: Bool, fifoSize: Int, overflowOccupancyAt: Int): Stream[T]
  196. def toStream(overflow: Bool): Stream[T]
  197. def toStream: Stream[T]
  198. def toString(): String
    Definition Classes
    Bundle → Nameable → AnyRef → Any
  199. def translateFrom[T2 <: Data](that: Flow[T2])(dataAssignment: (T, payload.type) ⇒ Unit): Flow[T]
  200. def translateWith[T2 <: Data](that: T2): Flow[T2]
  201. def unfreeze(): Flow.this.type
    Definition Classes
    MultiData → Data
  202. def unsetName(): Flow.this.type
    Definition Classes
    Nameable
  203. def valCallback[T](ref: T, name: String): T
    Definition Classes
    ValCallbackRec → ValCallback
  204. def valCallbackOn(ref: Any, name: String, refs: Set[Any]): Unit
    Definition Classes
    ValCallbackRec
  205. def valCallbackRec(ref: Any, name: String): Unit
    Definition Classes
    Bundle → ValCallbackRec
  206. val valid: Bool
    Definition Classes
    Flow → DataCarrier
  207. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  208. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  209. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  210. def wrapNext(): Flow.this.type
    Definition Classes
    Data
  211. def zipByName(that: MultiData, rec: ArrayBuffer[(BaseType, BaseType)]): ArrayBuffer[(BaseType, BaseType)]
    Definition Classes
    MultiData
  212. def ~[T2 <: Data](that: T2): Flow[T2]
  213. def ~~[T2 <: Data](translate: (T) ⇒ T2): Flow[T2]

Deprecated Value Members

  1. def asDirectionLess(): Flow.this.type
    Definition Classes
    Data
    Annotations
    @deprecated
    Deprecated

    (Since version ???) use setAsDirectionLess instead

  2. def asMaster(): Unit

    Override it to define port directions for a master interface.

    Override it to define port directions for a master interface.

    Definition Classes
    Flow → IMasterSlave
    Deprecated

    This method must be overriden but not called. Calling this method is not correct. Call setAsMaster() or intoMaster() instead. This method is named asXxx but it does not return Xxx. This method does not update isMasterInterface and isSlaveInterface.

  3. def asSlave(): Unit

    Override it to define port directions for a master interface.

    Override it to define port directions for a master interface.

    If not overriden, defaults to the opposite port directions of asMaster().

    Definition Classes
    Flow → IMasterSlave
    Deprecated

    This method can be overriden but not called. Calling this method is not correct. Call setAsSlave() or intoSlave() instead. This method is named asXxx but it does not return Xxx. This method does not update isMasterInterface and isSlaveInterface.

  4. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

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