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. def IFparent: Data
    Definition Classes
    Data
  11. val _spinalTags: LinkedHashSet[SpinalTag]
    Definition Classes
    SpinalTagReady
  12. def addAttribute(attribute: Attribute): Flow.this.type
    Definition Classes
    Data → SpinalTagReady
  13. def addAttribute(name: String, value: Int): Flow.this.type
    Definition Classes
    SpinalTagReady
  14. def addAttribute(name: String, value: String): Flow.this.type
    Definition Classes
    SpinalTagReady
  15. def addAttribute(name: String): Flow.this.type
    Definition Classes
    SpinalTagReady
  16. def addTag[T <: SpinalTag](spinalTag: T): Flow.this.type
    Definition Classes
    MultiData → SpinalTagReady
  17. def addTags(h: SpinalTag, tail: SpinalTag*): Flow.this.type
    Definition Classes
    SpinalTagReady
  18. def addTags[T <: SpinalTag](tags: Iterable[T]): Flow.this.type
    Definition Classes
    SpinalTagReady
  19. def allowDirectionLessIo(): Flow.this.type
    Definition Classes
    Data
  20. def allowOverride(): Flow.this.type
    Definition Classes
    Data
  21. def allowPartialyAssigned(): Flow.this.type
    Definition Classes
    Data
  22. def allowPruning(): Flow.this.type
    Definition Classes
    Data
  23. def allowSimplifyIt(): Flow.this.type
    Definition Classes
    Data
  24. def allowUnsetRegToAvoidLatch(): Flow.this.type
    Definition Classes
    Data
  25. def as[T <: Data](dataType: HardType[T]): T
    Definition Classes
    Data
  26. def asBits: Bits
    Definition Classes
    MultiData → Data
  27. def asData: Data
    Definition Classes
    Data
  28. def asInOut(): Flow.this.type
    Definition Classes
    MultiData → Data
  29. def asInput(): Flow.this.type
    Definition Classes
    MultiData → Data
  30. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  31. def asOutput(): Flow.this.type
    Definition Classes
    MultiData → Data
  32. def assignAllByName(that: Bundle): Unit
    Definition Classes
    Bundle
  33. def assignDontCare(): Flow.this.type
    Definition Classes
    Data
  34. def assignDontCareToUnasigned(): Flow.this.type
    Definition Classes
    Data
  35. def assignFormalRandom(kind: RandomExpKind): Unit
    Definition Classes
    MultiData → Data
  36. final def assignFrom(that: AnyRef, target: AnyRef)(implicit loc: Location): Unit
    Definition Classes
    Data
  37. def assignFromBits(bits: Bits, hi: Int, lo: Int): Unit
    Definition Classes
    MultiData → Data
  38. def assignFromBits(bits: Bits): Unit
    Definition Classes
    MultiData → Data
  39. def assignFromBits(bits: Bits, offset: Int, bitCount: BitCount): Unit
    Definition Classes
    Data
  40. def assignFromImpl(that: AnyRef, target: AnyRef, kind: AnyRef)(implicit loc: Location): Unit
    Attributes
    protected
    Definition Classes
    Bundle → Assignable
  41. def assignSomeByName(that: Bundle): Unit
    Definition Classes
    Bundle
  42. def assignUnassignedByName(that: MultiData): Unit
    Definition Classes
    MultiData
  43. def bundleAssign(that: Bundle)(f: (Data, Data) ⇒ Unit): Unit
    Definition Classes
    Bundle
  44. def ccToggle(pushClock: ClockDomain, popClock: ClockDomain, withOutputBufferedReset: Boolean = ..., withOutputM2sPipe: Boolean = true): Flow[T]
  45. def checkDir(that: Bundle): Boolean
    Definition Classes
    Bundle
  46. def clearAll(): Flow.this.type
    Definition Classes
    Data
  47. def clone(): Flow[T]
    Definition Classes
    Flow → Bundle → Data → AnyRef
  48. def combStage(): Flow[T]
  49. def component: Component
    Definition Classes
    ContextUser
  50. final def compositAssignFrom(that: AnyRef, target: AnyRef, kind: AnyRef)(implicit loc: Location): Unit
    Definition Classes
    Assignable
  51. val compositeAssign: Assignable
    Definition Classes
    Assignable
  52. def connectFrom(that: Flow[T]): Flow[T]
  53. def copyDirectionOfImpl(that: Data): Flow.this.type
    Definition Classes
    MultiData → Data
  54. def default(that: T): Unit
  55. def dirString(): String
    Definition Classes
    Data
  56. def discardWhen(cond: Bool): Flow[T]

    Discard transactions when cond is true.

    Discard transactions when cond is true.

    This is the same as throwWhen() but with a semantically clearer function name. Prefer discardWhen() over throwWhen() for new designs.

    cond

    Condition

    returns

    The resulting Flow

  57. def dontSimplifyIt(): Flow.this.type
    Definition Classes
    Data
  58. def elements: ArrayBuffer[(String, Data)]
    Definition Classes
    Bundle → MultiData
  59. var elementsCache: ArrayBuffer[(String, Data)]
    Definition Classes
    Bundle
  60. def elementsString: String
    Definition Classes
    MultiData
  61. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  62. def equals(obj: Any): Boolean
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  63. def existsTag(cond: (SpinalTag) ⇒ Boolean): Boolean
    Definition Classes
    SpinalTagReady
  64. def filterTag(cond: (SpinalTag) ⇒ Boolean): Iterable[SpinalTag]
    Definition Classes
    SpinalTagReady
  65. def find(name: String): Data
    Definition Classes
    MultiData
  66. def findTag(cond: (SpinalTag) ⇒ Boolean): Option[SpinalTag]
    Definition Classes
    SpinalTagReady
  67. def fire: Bool
    Definition Classes
    Flow → DataCarrier
  68. def flatten: Seq[BaseType]
    Definition Classes
    MultiData → Data
  69. def flattenForeach(body: (BaseType) ⇒ Unit): Unit
    Definition Classes
    MultiData → Data
  70. def flattenLocalName: Seq[String]
    Definition Classes
    MultiData → Data
  71. def flip(): Flow.this.type
    Definition Classes
    MultiData → Data
  72. def foreachReflectableNameables(doThat: (Any) ⇒ Unit): Unit
    Definition Classes
    Nameable
  73. def foreachTag(body: (SpinalTag) ⇒ Unit): Unit
    Definition Classes
    SpinalTagReady
  74. def freeRun(): Flow.this.type
    Definition Classes
    Flow → DataCarrier
  75. def freeze(): Flow.this.type
    Definition Classes
    MultiData → Data
  76. def getAheadValue(): Flow.this.type
    Definition Classes
    Data
  77. def getBitsWidth: Int
    Definition Classes
    MultiData → Data
  78. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  79. def getComponent(): Component
    Definition Classes
    Data → InComponent → NameableByComponent
  80. def getComponents(): Seq[Component]
    Definition Classes
    InComponent
  81. def getDirection: IODirection
    Definition Classes
    Data
  82. def getDisplayName(): String
    Definition Classes
    Nameable
  83. def getInstanceCounter: Int
    Definition Classes
    ContextUser
  84. def getMode: Byte
    Attributes
    protected
    Definition Classes
    Nameable
  85. def getMuxType[T <: Data](list: TraversableOnce[T]): HardType[T]
    Definition Classes
    Data
  86. def getName(default: String): String
    Definition Classes
    NameableByComponent → Nameable
  87. def getName(): String
    Definition Classes
    NameableByComponent → Nameable
  88. def getPartialName(): String
    Definition Classes
    Nameable
  89. def getPath(from: Component, to: Component): Seq[Component]
    Definition Classes
    NameableByComponent
  90. def getRealSource: Any
    Definition Classes
    Assignable
  91. def getRealSourceNoRec: Any
    Definition Classes
    Data → Assignable
  92. def getRefOwnersChain(): List[Any]
    Definition Classes
    OwnableRef
  93. def getRootParent: Data
    Definition Classes
    Data
  94. def getRtlPath(separator: String): String
    Definition Classes
    Data
  95. def getScalaLocationLong: String
    Definition Classes
    ScalaLocated
  96. def getScalaLocationShort: String
    Definition Classes
    ScalaLocated
  97. def getScalaTrace(): Throwable
    Definition Classes
    ScalaLocated
  98. def getTag[T <: SpinalTag](clazz: Class[T]): Option[T]
    Definition Classes
    SpinalTagReady
  99. def getTags(): LinkedHashSet[SpinalTag]
    Definition Classes
    SpinalTagReady
  100. def getTypeString: String
    Definition Classes
    Bundle
  101. def getZero: Flow.this.type
    Definition Classes
    MultiData → Data
  102. val globalData: GlobalData
    Definition Classes
    GlobalDataUser
  103. var hardtype: HardType[_]
    Definition Classes
    Bundle
  104. def hasTag[T <: SpinalTag](clazz: Class[T]): Boolean
    Definition Classes
    SpinalTagReady
  105. def hasTag(spinalTag: SpinalTag): Boolean
    Definition Classes
    SpinalTagReady
  106. def hashCode(): Int
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  107. final def initFrom(that: AnyRef, target: AnyRef): Unit
    Definition Classes
    Data
  108. def instanceAttributes(language: Language): Iterable[Attribute]
    Definition Classes
    SpinalTagReady
  109. def instanceAttributes: Iterable[Attribute]
    Definition Classes
    SpinalTagReady
  110. final def intoMaster(): Flow.this.type

    Convert into master

    Convert into master

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

    Convert into slave

    Convert into slave

    Definition Classes
    IMasterSlave
  112. def isAnalog: Boolean
    Definition Classes
    Data
  113. def isComb: Boolean
    Definition Classes
    Data
  114. def isCompletelyUnnamed: Boolean
    Definition Classes
    Nameable
  115. def isDirectionLess: Boolean
    Definition Classes
    Data
  116. def isEmptyOfTag: Boolean
    Definition Classes
    SpinalTagReady
  117. def isInOut: Boolean
    Definition Classes
    Data
  118. def isInput: Boolean
    Definition Classes
    Data
  119. def isInputOrInOut: Boolean
    Definition Classes
    Data
  120. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  121. final def isMasterInterface: Boolean

    Are port directions set for a Master interface?

    Are port directions set for a Master interface?

    Definition Classes
    IMasterSlave
  122. final def isNamed: Boolean
    Definition Classes
    Nameable
  123. def isOutput: Boolean
    Definition Classes
    Data
  124. def isOutputOrInOut: Boolean
    Definition Classes
    Data
  125. def isPriorityApplicable(namePriority: Byte): Boolean
    Definition Classes
    Nameable
  126. def isReg: Boolean
    Definition Classes
    Data
  127. def isRegOnAssign: Boolean
    Definition Classes
    Data
  128. final def isSlaveInterface: Boolean

    Are port directions set for a Master interface?

    Are port directions set for a Master interface?

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

    Set as master interface

    Set as master interface

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

    Set a slave interface

    Set a slave interface

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

    does not work with <>, use 'someBool generate Type()' or 'if(condition) Type() else null' instead

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