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

    Concatenation between two data

    Concatenation between two data

    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
    DataSpinalTagReady
  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
    MultiDataSpinalTagReady
  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

    Allow a data to be overrided

    Allow a data to be overrided

    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 asBits: Bits

    Permalink

    Cast data to Bits

    Cast data to Bits

    Definition Classes
    MultiDataData
  21. def asData: Data

    Permalink
    Definition Classes
    Data
  22. def asInOut(): Flow.this.type

    Permalink

    set a data as inout

    set a data as inout

    Definition Classes
    MultiDataData
  23. def asInput(): Flow.this.type

    Permalink

    Set a data as input

    Set a data as input

    Definition Classes
    MultiDataData
  24. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  25. def asMaster(): Unit

    Permalink
    Definition Classes
    FlowIMasterSlave
  26. def asOutput(): Flow.this.type

    Permalink

    Set a data as output

    Set a data as output

    Definition Classes
    MultiDataData
  27. def asSlave(): Unit

    Permalink
    Definition Classes
    FlowIMasterSlave
  28. def assignAllByName(that: Bundle): Unit

    Permalink

    Assign the bundle with an other bundle by name

    Assign the bundle with an other bundle by name

    Definition Classes
    Bundle
  29. def assignDontCare(): Flow.this.type

    Permalink
    Definition Classes
    Data
  30. final def assignFrom(that: AnyRef, target: AnyRef = this): Unit

    Permalink
    Definition Classes
    Data
  31. def assignFromBits(bits: Bits, hi: Int, lo: Int): Unit

    Permalink
    Definition Classes
    MultiDataData
  32. def assignFromBits(bits: Bits): Unit

    Permalink
    Definition Classes
    MultiDataData
  33. def assignFromBits(bits: Bits, offset: Int, bitCount: BitCount): Unit

    Permalink
    Definition Classes
    Data
  34. def assignSomeByName(that: Bundle): Unit

    Permalink

    Assign all possible signal fo the bundle with an other bundle by name

    Assign all possible signal fo the bundle with an other bundle by name

    Definition Classes
    Bundle
  35. def clone(): Flow[T]

    Permalink
    Definition Classes
    FlowBundleData → AnyRef
  36. var cloneFunc: () ⇒ AnyRef

    Permalink
    Definition Classes
    Bundle
  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

    Return all element of the bundle

    Return all element of the bundle

    Definition Classes
    BundleMultiData
  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
    FlowDataCarrier
  54. def flatten: Seq[BaseType]

    Permalink
    Definition Classes
    MultiDataData
  55. def flattenForeach(body: (BaseType) ⇒ Unit): Unit

    Permalink
    Definition Classes
    MultiDataData
  56. def flattenLocalName: Seq[String]

    Permalink
    Definition Classes
    MultiDataData
  57. def flip(): Flow.this.type

    Permalink

    flip the direction of the data

    flip the direction of the data

    Definition Classes
    MultiDataData
  58. def foreachReflectableNameables(doThat: (Any) ⇒ Unit): Unit

    Permalink
    Definition Classes
    Nameable
  59. def freeRun(): Flow.this.type

    Permalink
    Definition Classes
    FlowDataCarrier
  60. def genIf(cond: Boolean): Flow.this.type

    Permalink

    Generate this if condition is true

    Generate this if condition is true

    Definition Classes
    Data
  61. def getBitsWidth: Int

    Permalink

    Return the width of the data

    Return the width of the data

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

    Permalink
    Definition Classes
    AnyRef → Any
  63. def getComponent(): Component

    Permalink
    Definition Classes
    DataNameableByComponent
  64. def getComponents(): Seq[Component]

    Permalink

    Get current component with all parents

    Get current component with all parents

    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
    NameableByComponentNameable
  69. def getName(): String

    Permalink
    Definition Classes
    Nameable
  70. def getRealSource: Any

    Permalink
    Definition Classes
    Assignable
  71. def getRealSourceNoRec: Any

    Permalink
    Definition Classes
    DataAssignable
  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

    Create a data set to 0

    Create a data set to 0

    Definition Classes
    MultiDataData
  81. val globalData: GlobalData

    Permalink
    Definition Classes
    GlobalDataUser
  82. def hasTag[T <: SpinalTag](clazz: Class[T]): Boolean

    Permalink
    Definition Classes
    SpinalTagReady
  83. def hasTag(spinalTag: SpinalTag): Boolean

    Permalink
    Definition Classes
    SpinalTagReady
  84. def hashCode(): Int

    Permalink
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  85. final def initFrom(that: AnyRef, target: AnyRef = this): Unit

    Permalink
    Definition Classes
    Data
  86. def instanceAttributes(language: Language): Iterable[Attribute]

    Permalink
    Definition Classes
    SpinalTagReady
  87. def instanceAttributes: Iterable[Attribute]

    Permalink
    Definition Classes
    SpinalTagReady
  88. def isAnalog: Boolean

    Permalink
    Definition Classes
    Data
  89. def isComb: Boolean

    Permalink
    Definition Classes
    Data
  90. def isDirectionLess: Boolean

    Permalink
    Definition Classes
    Data
  91. def isEmptyOfTag: Boolean

    Permalink
    Definition Classes
    SpinalTagReady
  92. def isInOut: Boolean

    Permalink
    Definition Classes
    Data
  93. def isInput: Boolean

    Permalink
    Definition Classes
    Data
  94. def isInputOrInOut: Boolean

    Permalink
    Definition Classes
    Data
  95. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  96. var isMasterInterface: Boolean

    Permalink
    Definition Classes
    IMasterSlave
  97. def isNamed: Boolean

    Permalink
    Definition Classes
    NameableByComponentNameable
  98. def isOutput: Boolean

    Permalink
    Definition Classes
    Data
  99. def isOutputOrInOut: Boolean

    Permalink
    Definition Classes
    Data
  100. def isPriorityApplicable(namePriority: Byte): Boolean

    Permalink
    Definition Classes
    Nameable
  101. def isReg: Boolean

    Permalink
    Definition Classes
    Data
  102. def isUnnamed: Boolean

    Permalink
    Definition Classes
    Nameable
  103. def keep(): Flow.this.type

    Permalink
    Definition Classes
    Data
  104. def m2sPipe(holdPayload: Boolean = false): Flow[T]

    Permalink
  105. def m2sPipe: Flow[T]

    Permalink
  106. var name: String

    Permalink
    Attributes
    protected
    Definition Classes
    Nameable
  107. var nameableRef: Nameable

    Permalink
    Attributes
    protected
    Definition Classes
    Nameable
  108. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  109. def noBackendCombMerge: Flow.this.type

    Permalink
    Definition Classes
    Data
  110. def noCombLoopCheck: Flow.this.type

    Permalink
    Definition Classes
    Data
  111. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  112. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  113. def onEachAttributes(doIt: (Attribute) ⇒ Unit): Unit

    Permalink
    Definition Classes
    SpinalTagReady
  114. var parent: Data

    Permalink
    Definition Classes
    Data
  115. var parentScope: ScopeStatement

    Permalink
    Definition Classes
    ContextUser
  116. val payload: T

    Permalink
    Definition Classes
    FlowDataCarrier
  117. val payloadType: HardType[T]

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

    Permalink

    Pull a signal to the top level (use for debugging)

    Pull a signal to the top level (use for debugging)

    Definition Classes
    Data
  119. def purify(): Flow.this.type

    Permalink
    Definition Classes
    Data
  120. def push(that: T): Unit

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

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

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

    Permalink

    Usefull for register that doesn't need a reset value in RTL, but need a randome value for simulation (avoid x-propagation)

    Usefull for register that doesn't need a reset value in RTL, but need a randome value for simulation (avoid x-propagation)

    Definition Classes
    Data
  124. var refOwner: RefOwnerType

    Permalink
    Definition Classes
    OwnableRef
  125. def removeAssignments(): Flow.this.type

    Permalink
    Definition Classes
    Data
  126. def removeTag(spinalTag: SpinalTag): Flow.this.type

    Permalink
    Definition Classes
    SpinalTagReady
  127. def removeTags(tags: Iterable[SpinalTag]): Flow.this.type

    Permalink
    Definition Classes
    SpinalTagReady
  128. def resized: Flow.this.type

    Permalink

    Resized data regarding target

    Resized data regarding target

    Definition Classes
    Data
  129. def setAsAnalog(): Flow.this.type

    Permalink
    Definition Classes
    Data
  130. def setAsComb(): Flow.this.type

    Permalink

    Set baseType to Combinatorial

    Set baseType to Combinatorial

    Definition Classes
    MultiDataData
  131. def setAsDirectionLess(): Flow.this.type

    Permalink

    remove the direction (in,out,inout) to a data

    remove the direction (in,out,inout) to a data

    Definition Classes
    MultiDataData
  132. def setAsReg(): Flow.this.type

    Permalink

    Set baseType to reg

    Set baseType to reg

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

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

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

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

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

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

    Permalink
    Definition Classes
    Nameable
  139. def setName(name: String, namePriority: Byte): Flow.this.type

    Permalink
    Definition Classes
    Nameable
  140. def setName(name: String, weak: Boolean): Flow.this.type

    Permalink
    Definition Classes
    Nameable
  141. def setName(name: String): Flow.this.type

    Permalink
    Definition Classes
    Nameable
  142. def setPartialName(name: String, namePriority: Byte): Flow.this.type

    Permalink
    Definition Classes
    Nameable
  143. def setPartialName(name: String, weak: Boolean): Flow.this.type

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

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

    Permalink
    Definition Classes
    Nameable
  146. def setPartialName(name: String): Flow.this.type

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

    Permalink
    Definition Classes
    Nameable
  148. def setRefOwner(that: Any): Unit

    Permalink
    Definition Classes
    OwnableRef
  149. def setScalaLocated(source: ScalaLocated): Flow.this.type

    Permalink
    Definition Classes
    ScalaLocated
  150. def setWeakName(name: String): Flow.this.type

    Permalink
    Definition Classes
    Nameable
  151. def spinalTags: Set[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady
  152. def stage(): Flow[T]

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

    Permalink
    Definition Classes
    AnyRef
  154. def takeWhen(cond: Bool): Flow[T]

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

    Permalink
  156. def toReg(init: T): T

    Permalink
  157. def toReg(): T

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

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

    Permalink
  160. def toStream: Stream[T]

    Permalink
  161. def toString(): String

    Permalink
    Definition Classes
    BundleNameable → AnyRef → Any
  162. def translateFrom[T2 <: Data](that: Flow[T2])(dataAssignment: (T, payload.type) ⇒ Unit): Flow[T]

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

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

    Permalink
    Definition Classes
    Nameable
  165. val valid: Bool

    Permalink
    Definition Classes
    FlowDataCarrier
  166. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  167. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  168. 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

    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