spinal.lib

Flow

Related Docs: object Flow | package lib

class Flow[T <: Data] extends Bundle with IMasterSlave with DataCarrier[T]

Linear Supertypes
DataCarrier[T], IMasterSlave, Bundle, OverridedEqualsHashCode, MultiData, Data, 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. OverridedEqualsHashCode
  6. MultiData
  7. Data
  8. SpinalTagReady
  9. Assignable
  10. NameableByComponent
  11. Nameable
  12. OwnableRef
  13. ContextUser
  14. ScalaLocated
  15. GlobalDataUser
  16. AnyRef
  17. Any
  1. Hide All
  2. Show all
Learn more about member selection
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 <-<(that: Flow[T]): Flow[T]

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

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

    Definition Classes
    AnyRef → Any

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

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

  9. var _spinalTags: Set[SpinalTag]

    Definition Classes
    SpinalTagReady

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

    Definition Classes
    Data → SpinalTagReady

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

    Definition Classes
    SpinalTagReady

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

    Definition Classes
    SpinalTagReady

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

    Definition Classes
    MultiData → SpinalTagReady

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

    Definition Classes
    SpinalTagReady

  15. def allowDirectionLessIo: Flow.this.type

    Definition Classes
    Data

  16. def allowOverride: Flow.this.type

    Definition Classes
    Data

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

    Definition Classes
    Data

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

    Definition Classes
    Data

  19. def allowUnsetRegToAvoidLatch: Flow.this.type

    Definition Classes
    Data

  20. def asBits: Bits

    Definition Classes
    MultiData → Data

  21. def asData: Data

    Definition Classes
    Data

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

    Definition Classes
    MultiData → Data

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

    Definition Classes
    MultiData → Data

  24. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  25. def asMaster(): Unit

    Definition Classes
    Flow → IMasterSlave

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

    Definition Classes
    MultiData → Data

  27. def asSlave(): Unit

    Definition Classes
    Flow → IMasterSlave

  28. def assignAllByName(that: Bundle): Unit

    Definition Classes
    Bundle

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

    Definition Classes
    Data

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

    Definition Classes
    Data

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

    Definition Classes
    MultiData → Data

  32. def assignFromBits(bits: Bits): Unit

    Definition Classes
    MultiData → Data

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

    Definition Classes
    Data

  34. def assignSomeByName(that: Bundle): Unit

    Definition Classes
    Bundle

  35. def clone(): Flow[T]

    Definition Classes
    Flow → Bundle → Data → AnyRef

  36. var cloneFunc: () ⇒ AnyRef

    Definition Classes
    Bundle

  37. def component: Component

    Definition Classes
    ContextUser

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

    Definition Classes
    Assignable

  39. var compositeAssign: Assignable

    Definition Classes
    Assignable

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

  41. def default(that: T): Unit

  42. def dirString(): String

    Definition Classes
    Data

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

    Definition Classes
    Data

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

    Definition Classes
    Bundle → MultiData

  45. def elementsString: String

    Definition Classes
    MultiData

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

    Definition Classes
    AnyRef

  47. def equals(obj: Any): Boolean

    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any

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

    Definition Classes
    SpinalTagReady

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

    Definition Classes
    SpinalTagReady

  50. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  51. def find(name: String): Data

    Definition Classes
    MultiData

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

    Definition Classes
    SpinalTagReady

  53. def fire: Bool

    Definition Classes
    Flow → DataCarrier

  54. def flatten: Seq[BaseType]

    Definition Classes
    MultiData → Data

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

    Definition Classes
    MultiData → Data

  56. def flattenLocalName: Seq[String]

    Definition Classes
    MultiData → Data

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

    Definition Classes
    MultiData → Data

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

    Definition Classes
    Nameable

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

    Definition Classes
    Flow → DataCarrier

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

    Definition Classes
    Data

  61. def getBitsWidth: Int

    Definition Classes
    MultiData → Data

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

    Definition Classes
    AnyRef → Any

  63. def getComponent(): Component

    Definition Classes
    Data → NameableByComponent

  64. def getComponents(): Seq[Component]

    Definition Classes
    Data

  65. def getDisplayName(): String

    Definition Classes
    Nameable

  66. def getInstanceCounter: Int

    Definition Classes
    ContextUser

  67. def getMode: Byte

    Attributes
    protected
    Definition Classes
    Nameable

  68. def getName(default: String): String

    Definition Classes
    NameableByComponent → Nameable

  69. def getName(): String

    Definition Classes
    Nameable

  70. def getRealSource: Any

    Definition Classes
    Assignable

  71. def getRealSourceNoRec: Any

    Definition Classes
    Data → Assignable

  72. def getRefOwnersChain(): List[Any]

    Definition Classes
    OwnableRef

  73. def getRootParent: Data

    Definition Classes
    Data

  74. def getScalaLocationLong: String

    Definition Classes
    ScalaLocated

  75. def getScalaLocationShort: String

    Definition Classes
    ScalaLocated

  76. def getScalaTrace(): Throwable

    Definition Classes
    ScalaLocated

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

    Definition Classes
    SpinalTagReady

  78. def getTags(): Set[SpinalTag]

    Definition Classes
    SpinalTagReady

  79. def getTypeString: String

    Definition Classes
    Bundle

  80. def getZero: Flow.this.type

    Definition Classes
    MultiData → Data

  81. val globalData: GlobalData

    Definition Classes
    GlobalDataUser

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

    Definition Classes
    SpinalTagReady

  83. def hasTag(spinalTag: SpinalTag): Boolean

    Definition Classes
    SpinalTagReady

  84. def hashCode(): Int

    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any

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

    Definition Classes
    Data

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

    Definition Classes
    SpinalTagReady

  87. def instanceAttributes: Iterable[Attribute]

    Definition Classes
    SpinalTagReady

  88. def isAnalog: Boolean

    Definition Classes
    Data

  89. def isComb: Boolean

    Definition Classes
    Data

  90. def isDirectionLess: Boolean

    Definition Classes
    Data

  91. def isEmptyOfTag: Boolean

    Definition Classes
    SpinalTagReady

  92. def isInOut: Boolean

    Definition Classes
    Data

  93. def isInput: Boolean

    Definition Classes
    Data

  94. def isInputOrInOut: Boolean

    Definition Classes
    Data

  95. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  96. var isMasterInterface: Boolean

    Definition Classes
    IMasterSlave

  97. def isNamed: Boolean

    Definition Classes
    NameableByComponent → Nameable

  98. def isOutput: Boolean

    Definition Classes
    Data

  99. def isOutputOrInOut: Boolean

    Definition Classes
    Data

  100. def isPriorityApplicable(namePriority: Byte): Boolean

    Definition Classes
    Nameable

  101. def isReg: Boolean

    Definition Classes
    Data

  102. def isUnnamed: Boolean

    Definition Classes
    Nameable

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

    Definition Classes
    Data

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

  105. def m2sPipe: Flow[T]

  106. var name: String

    Attributes
    protected
    Definition Classes
    Nameable

  107. var nameableRef: Nameable

    Attributes
    protected
    Definition Classes
    Nameable

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

    Definition Classes
    AnyRef

  109. def noBackendCombMerge: Flow.this.type

    Definition Classes
    Data

  110. def noCombLoopCheck: Flow.this.type

    Definition Classes
    Data

  111. final def notify(): Unit

    Definition Classes
    AnyRef

  112. final def notifyAll(): Unit

    Definition Classes
    AnyRef

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

    Definition Classes
    SpinalTagReady

  114. var parent: Data

    Definition Classes
    Data

  115. var parentScope: ScopeStatement

    Definition Classes
    ContextUser

  116. val payload: T

    Definition Classes
    Flow → DataCarrier

  117. val payloadType: HardType[T]

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

    Definition Classes
    Data

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

    Definition Classes
    Data

  120. def push(that: T): Unit

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

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

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

    Definition Classes
    Data

  124. var refOwner: RefOwnerType

    Definition Classes
    OwnableRef

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

    Definition Classes
    Data

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

    Definition Classes
    SpinalTagReady

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

    Definition Classes
    SpinalTagReady

  128. def resized: Flow.this.type

    Definition Classes
    Data

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

    Definition Classes
    Data

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

    Definition Classes
    MultiData → Data

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

    Definition Classes
    MultiData → Data

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

    Definition Classes
    MultiData → Data

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

    Definition Classes
    Nameable

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

    Definition Classes
    Nameable

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

    Definition Classes
    Nameable

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

    Definition Classes
    Nameable

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

    Definition Classes
    Nameable

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

    Definition Classes
    Nameable

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

    Definition Classes
    Nameable

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

    Definition Classes
    Nameable

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

    Definition Classes
    Nameable

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

    Definition Classes
    Nameable

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

    Definition Classes
    Nameable

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

    Definition Classes
    Nameable

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

    Definition Classes
    Nameable

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

    Definition Classes
    Nameable

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

    Definition Classes
    Nameable

  148. def setRefOwner(that: Any): Unit

    Definition Classes
    OwnableRef

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

    Definition Classes
    ScalaLocated

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

    Definition Classes
    Nameable

  151. def spinalTags: Set[SpinalTag]

    Definition Classes
    SpinalTagReady

  152. def stage(): Flow[T]

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

    Definition Classes
    AnyRef

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

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

  156. def toReg(init: T): T

  157. def toReg(): T

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

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

  160. def toStream: Stream[T]

  161. def toString(): String

    Definition Classes
    Bundle → Nameable → AnyRef → Any

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

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

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

    Definition Classes
    Nameable

  165. val valid: Bool

    Definition Classes
    Flow → DataCarrier

  166. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def asDirectionLess(): Flow.this.type

    Definition Classes
    Data
    Annotations
    @deprecated
    Deprecated

    use setAsDirectionLess instead

Inherited from DataCarrier[T]

Inherited from IMasterSlave

Inherited from Bundle

Inherited from OverridedEqualsHashCode

Inherited from MultiData

Inherited from Data

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