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, 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
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 default(that: T): Unit

    Permalink

  42. def dirString(): String

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    Bundle → MultiData

  45. def elementsString: String

    Permalink
    Definition Classes
    MultiData

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

    Permalink
    Definition Classes
    AnyRef

  47. def equals(obj: Any): Boolean

    Permalink
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any

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

    Permalink
    Definition Classes
    SpinalTagReady

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

    Permalink
    Definition Classes
    SpinalTagReady

  50. def finalize(): Unit

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

  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 freeRun(): Flow.this.type

    Permalink
    Definition Classes
    Flow → DataCarrier

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

    Permalink
    Definition Classes
    Data

  61. def getBitsWidth: Int

    Permalink
    Definition Classes
    MultiData → Data

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

    Permalink
    Definition Classes
    AnyRef → Any

  63. def getComponent(): Component

    Permalink
    Definition Classes
    Data → NameableByComponent

  64. def getComponents(): Seq[Component]

    Permalink
    Definition Classes
    Data

  65. def getDisplayName(): String

    Permalink
    Definition Classes
    Nameable

  66. def getInstanceCounter: Int

    Permalink
    Definition Classes
    ContextUser

  67. def getMode: Byte

    Permalink
    Attributes
    protected
    Definition Classes
    Nameable

  68. def getName(default: String): String

    Permalink
    Definition Classes
    NameableByComponent → Nameable

  69. def getName(): String

    Permalink
    Definition Classes
    Nameable

  70. def getRealSource: Any

    Permalink
    Definition Classes
    Assignable

  71. def getRealSourceNoRec: Any

    Permalink
    Definition Classes
    Data → Assignable

  72. def getRefOwnersChain(): List[Any]

    Permalink
    Definition Classes
    OwnableRef

  73. def getRootParent: Data

    Permalink
    Definition Classes
    Data

  74. def getScalaLocationLong: String

    Permalink
    Definition Classes
    ScalaLocated

  75. def getScalaLocationShort: String

    Permalink
    Definition Classes
    ScalaLocated

  76. def getScalaTrace(): Throwable

    Permalink
    Definition Classes
    ScalaLocated

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

    Permalink
    Definition Classes
    SpinalTagReady

  78. def getTags(): Set[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady

  79. def getTypeString: String

    Permalink
    Definition Classes
    Bundle

  80. def getZero: Flow.this.type

    Permalink
    Definition Classes
    MultiData → Data

  81. val globalData: GlobalData

    Permalink
    Definition Classes
    GlobalDataUser

  82. var hardtype: HardType[_]

    Permalink
    Definition Classes
    Bundle

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

    Permalink
    Definition Classes
    SpinalTagReady

  84. def hasTag(spinalTag: SpinalTag): Boolean

    Permalink
    Definition Classes
    SpinalTagReady

  85. def hashCode(): Int

    Permalink
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any

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

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    SpinalTagReady

  88. def instanceAttributes: Iterable[Attribute]

    Permalink
    Definition Classes
    SpinalTagReady

  89. def isAnalog: Boolean

    Permalink
    Definition Classes
    Data

  90. def isComb: Boolean

    Permalink
    Definition Classes
    Data

  91. def isDirectionLess: Boolean

    Permalink
    Definition Classes
    Data

  92. def isEmptyOfTag: Boolean

    Permalink
    Definition Classes
    SpinalTagReady

  93. def isInOut: Boolean

    Permalink
    Definition Classes
    Data

  94. def isInput: Boolean

    Permalink
    Definition Classes
    Data

  95. def isInputOrInOut: Boolean

    Permalink
    Definition Classes
    Data

  96. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  97. var isMasterInterface: Boolean

    Permalink
    Definition Classes
    IMasterSlave

  98. def isNamed: Boolean

    Permalink
    Definition Classes
    NameableByComponent → Nameable

  99. def isOutput: Boolean

    Permalink
    Definition Classes
    Data

  100. def isOutputOrInOut: Boolean

    Permalink
    Definition Classes
    Data

  101. def isPriorityApplicable(namePriority: Byte): Boolean

    Permalink
    Definition Classes
    Nameable

  102. def isReg: Boolean

    Permalink
    Definition Classes
    Data

  103. def isUnnamed: Boolean

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Data

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

    Permalink

  106. def m2sPipe: Flow[T]

    Permalink

  107. var name: String

    Permalink
    Attributes
    protected
    Definition Classes
    Nameable

  108. var nameableRef: Nameable

    Permalink
    Attributes
    protected
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    AnyRef

  110. def noBackendCombMerge: Flow.this.type

    Permalink
    Definition Classes
    Data

  111. def noCombLoopCheck: Flow.this.type

    Permalink
    Definition Classes
    Data

  112. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  113. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

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

    Permalink
    Definition Classes
    SpinalTagReady

  115. var parent: Data

    Permalink
    Definition Classes
    Data

  116. var parentScope: ScopeStatement

    Permalink
    Definition Classes
    ContextUser

  117. val payload: T

    Permalink
    Definition Classes
    Flow → DataCarrier

  118. val payloadType: HardType[T]

    Permalink

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

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    Data

  121. def push(that: T): Unit

    Permalink

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

    Permalink

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

    Permalink

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

    Permalink
    Definition Classes
    Data

  125. var refOwner: RefOwnerType

    Permalink
    Definition Classes
    OwnableRef

  126. def reflectNames(): Unit

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    SpinalTagReady

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

    Permalink
    Definition Classes
    SpinalTagReady

  130. def resized: Flow.this.type

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    Data

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

    Permalink
    Definition Classes
    MultiData → Data

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

    Permalink
    Definition Classes
    MultiData → Data

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

    Permalink
    Definition Classes
    MultiData → Data

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

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

    Permalink
    Definition Classes
    Nameable

  150. def setRefOwner(that: Any): Unit

    Permalink
    Definition Classes
    OwnableRef

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

    Permalink
    Definition Classes
    ScalaLocated

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

    Permalink
    Definition Classes
    Nameable

  153. def spinalTags: Set[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady

  154. def stage(): Flow[T]

    Permalink

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

    Permalink
    Definition Classes
    AnyRef

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

    Permalink

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

    Permalink

  158. def toReg(init: T): T

    Permalink

  159. def toReg(): T

    Permalink

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

    Permalink

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

    Permalink

  162. def toStream: Stream[T]

    Permalink

  163. def toString(): String

    Permalink
    Definition Classes
    Bundle → Nameable → AnyRef → Any

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

    Permalink

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

    Permalink

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

    Permalink
    Definition Classes
    Nameable

  167. val valid: Bool

    Permalink
    Definition Classes
    Flow → DataCarrier

  168. final def wait(): Unit

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

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

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

  170. final def wait(arg0: Long): 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

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