c

spinal.lib.io

TriState

case class TriState[T <: Data](dataType: HardType[T]) extends Bundle with IMasterSlave with Product with Serializable

Linear Supertypes
Serializable, Serializable, Product, Equals, 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. TriState
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. IMasterSlave
  7. Bundle
  8. ValCallbackRec
  9. ValCallback
  10. MultiData
  11. Data
  12. InComponent
  13. OverridedEqualsHashCode
  14. SpinalTagReady
  15. Assignable
  16. NameableByComponent
  17. Nameable
  18. OwnableRef
  19. ContextUser
  20. ScalaLocated
  21. GlobalDataUser
  22. AnyRef
  23. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new TriState(dataType: 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

    Concatenation between two data

    Concatenation between two data

    Definition Classes
    Data
  3. final def ##(): Int
    Definition Classes
    AnyRef → Any
  4. def #*(count: Int): Bits
    Definition Classes
    Data
  5. def <<(m: TriState[T]): Unit
  6. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  7. def IFparent: Data
    Definition Classes
    Data
  8. val _spinalTags: LinkedHashSet[SpinalTag]
    Definition Classes
    SpinalTagReady
  9. def addAttribute(attribute: Attribute): TriState.this.type
    Definition Classes
    Data → SpinalTagReady
  10. def addAttribute(name: String, value: Int): TriState.this.type
    Definition Classes
    SpinalTagReady
  11. def addAttribute(name: String, value: String): TriState.this.type
    Definition Classes
    SpinalTagReady
  12. def addAttribute(name: String): TriState.this.type
    Definition Classes
    SpinalTagReady
  13. def addTag[T <: SpinalTag](spinalTag: T): TriState.this.type
    Definition Classes
    MultiData → SpinalTagReady
  14. def addTags(h: SpinalTag, tail: SpinalTag*): TriState.this.type
    Definition Classes
    SpinalTagReady
  15. def addTags[T <: SpinalTag](tags: Iterable[T]): TriState.this.type
    Definition Classes
    SpinalTagReady
  16. def allowDirectionLessIo(): TriState.this.type

    Allow a Data of an io Bundle to be directionless

    Allow a Data of an io Bundle to be directionless

    See https://spinalhdl.github.io/SpinalDoc-RTD/master/SpinalHDL/Design%20errors/iobundle.html

    Definition Classes
    Data
  17. def allowOverride(): TriState.this.type

    Allow a Data to be overriden

    Allow a Data to be overriden

    See https://spinalhdl.github.io/SpinalDoc-RTD/master/SpinalHDL/Design%20errors/assignment_overlap.html

    Definition Classes
    Data
  18. def allowPartialyAssigned(): TriState.this.type

    Allow a register to be partially assigned

    Allow a register to be partially assigned

    Definition Classes
    Data
  19. def allowPruning(): TriState.this.type
    Definition Classes
    Data
  20. def allowSimplifyIt(): TriState.this.type
    Definition Classes
    Data
  21. def allowUnsetRegToAvoidLatch(): TriState.this.type

    Allow a register to have only an init (no assignments)

    Allow a register to have only an init (no assignments)

    See https://spinalhdl.github.io/SpinalDoc-RTD/master/SpinalHDL/Design%20errors/unassigned_register.html#register-with-only-init

    Definition Classes
    Data
  22. def as[T <: Data](dataType: HardType[T]): T
    Definition Classes
    Data
  23. def asBits: Bits

    Cast data to Bits

    Cast data to Bits

    Definition Classes
    MultiData → Data
  24. def asData: Data
    Definition Classes
    Data
  25. def asInOut(): TriState.this.type

    set a data as inout

    set a data as inout

    Definition Classes
    MultiData → Data
  26. def asInput(): TriState.this.type

    Set a data as input

    Set a data as input

    Definition Classes
    MultiData → Data
  27. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  28. def asOutput(): TriState.this.type

    Set a data as output

    Set a data as output

    Definition Classes
    MultiData → Data
  29. def assignAllByName(that: Bundle): Unit

    Assign the bundle with an other bundle by name

    Assign the bundle with an other bundle by name

    Definition Classes
    Bundle
  30. def assignDontCare(): TriState.this.type
    Definition Classes
    Data
  31. def assignDontCareToUnasigned(): TriState.this.type
    Definition Classes
    Data
  32. def assignFormalRandom(kind: RandomExpKind): Unit
    Definition Classes
    MultiData → Data
  33. final def assignFrom(that: AnyRef, target: AnyRef = this)(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 assignFromImpl(that: AnyRef, target: AnyRef, kind: AnyRef)(implicit loc: Location): Unit
    Attributes
    protected
    Definition Classes
    Bundle → Assignable
  38. def assignSomeByName(that: Bundle): Unit

    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
  39. def assignUnassignedByName(that: MultiData): Unit
    Definition Classes
    MultiData
  40. def bundleAssign(that: Bundle)(f: (Data, Data) ⇒ Unit): Unit
    Definition Classes
    Bundle
  41. def checkDir(that: Bundle): Boolean

    for interface find modport

    for interface find modport

    Definition Classes
    Bundle
  42. def clearAll(): TriState.this.type
    Definition Classes
    Data
  43. def clone(): Bundle
    Definition Classes
    Bundle → Data → AnyRef
  44. def component: Component
    Definition Classes
    ContextUser
  45. final def compositAssignFrom(that: AnyRef, target: AnyRef, kind: AnyRef)(implicit loc: Location): Unit
    Definition Classes
    Assignable
  46. val compositeAssign: Assignable
    Definition Classes
    Assignable
  47. def copyDirectionOfImpl(that: Data): TriState.this.type
    Definition Classes
    MultiData → Data
  48. val dataType: HardType[T]
  49. def dirString(): String
    Definition Classes
    Data
  50. def dontSimplifyIt(): TriState.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 flatten: Seq[BaseType]
    Definition Classes
    MultiData → Data
  61. def flattenForeach(body: (BaseType) ⇒ Unit): Unit
    Definition Classes
    MultiData → Data
  62. def flattenLocalName: Seq[String]
    Definition Classes
    MultiData → Data
  63. def flip(): TriState.this.type

    flip the direction of the data

    flip the direction of the data

    Definition Classes
    MultiData → Data
  64. def foreachReflectableNameables(doThat: (Any) ⇒ Unit): Unit
    Definition Classes
    Nameable
  65. def foreachTag(body: (SpinalTag) ⇒ Unit): Unit
    Definition Classes
    SpinalTagReady
  66. def freeze(): TriState.this.type
    Definition Classes
    MultiData → Data
  67. def getAheadValue(): TriState.this.type

    For a register, get the value it will have at the next clock, as a combinational signal.

    For a register, get the value it will have at the next clock, as a combinational signal.

    Definition Classes
    Data
  68. def getBitsWidth: Int

    Return the width of the data

    Return the width of the data

    Definition Classes
    MultiData → Data
  69. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  70. def getComponent(): Component
    Definition Classes
    Data → InComponent → NameableByComponent
  71. def getComponents(): Seq[Component]

    Get current component with all parents

    Get current component with all parents

    Definition Classes
    InComponent
  72. def getDirection: IODirection
    Definition Classes
    Data
  73. def getDisplayName(): String
    Definition Classes
    Nameable
  74. def getInstanceCounter: Int
    Definition Classes
    ContextUser
  75. def getMode: Byte
    Attributes
    protected
    Definition Classes
    Nameable
  76. def getMuxType[T <: Data](list: TraversableOnce[T]): HardType[T]
    Definition Classes
    Data
  77. def getName(default: String): String
    Definition Classes
    NameableByComponent → Nameable
  78. def getName(): String
    Definition Classes
    NameableByComponent → Nameable
  79. def getPartialName(): String
    Definition Classes
    Nameable
  80. def getPath(from: Component, to: Component): Seq[Component]
    Definition Classes
    NameableByComponent
  81. def getRealSource: Any
    Definition Classes
    Assignable
  82. def getRealSourceNoRec: Any
    Definition Classes
    Data → Assignable
  83. def getRefOwnersChain(): List[Any]
    Definition Classes
    OwnableRef
  84. def getRootParent: Data
    Definition Classes
    Data
  85. def getRtlPath(separator: String = "/"): String
    Definition Classes
    Data
  86. def getScalaLocationLong: String
    Definition Classes
    ScalaLocated
  87. def getScalaLocationShort: String
    Definition Classes
    ScalaLocated
  88. def getScalaTrace(): Throwable
    Definition Classes
    ScalaLocated
  89. def getTag[T <: SpinalTag](clazz: Class[T]): Option[T]
    Definition Classes
    SpinalTagReady
  90. def getTags(): LinkedHashSet[SpinalTag]
    Definition Classes
    SpinalTagReady
  91. def getTypeString: String
    Definition Classes
    Bundle
  92. def getZero: TriState.this.type

    Create a data set to 0

    Create a data set to 0

    Definition Classes
    MultiData → Data
  93. val globalData: GlobalData
    Definition Classes
    GlobalDataUser
  94. var hardtype: HardType[_]
    Definition Classes
    Bundle
  95. def hasTag[T <: SpinalTag](clazz: Class[T]): Boolean
    Definition Classes
    SpinalTagReady
  96. def hasTag(spinalTag: SpinalTag): Boolean
    Definition Classes
    SpinalTagReady
  97. def hashCode(): Int
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  98. final def initFrom(that: AnyRef, target: AnyRef = this): Unit
    Definition Classes
    Data
  99. def instanceAttributes(language: Language): Iterable[Attribute]
    Definition Classes
    SpinalTagReady
  100. def instanceAttributes: Iterable[Attribute]
    Definition Classes
    SpinalTagReady
  101. final def intoMaster(): TriState.this.type

    Convert into master

    Convert into master

    Definition Classes
    IMasterSlave
  102. final def intoSlave(): TriState.this.type

    Convert into slave

    Convert into slave

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

    Are port directions set for a Master interface?

    Are port directions set for a Master interface?

    Definition Classes
    IMasterSlave
  113. final def isNamed: Boolean
    Definition Classes
    Nameable
  114. def isOutput: Boolean
    Definition Classes
    Data
  115. def isOutputOrInOut: Boolean
    Definition Classes
    Data
  116. def isPriorityApplicable(namePriority: Byte): Boolean
    Definition Classes
    Nameable
  117. def isReg: Boolean
    Definition Classes
    Data
  118. def isRegOnAssign: Boolean
    Definition Classes
    Data
  119. final def isSlaveInterface: Boolean

    Are port directions set for a Master interface?

    Are port directions set for a Master interface?

    Definition Classes
    IMasterSlave
  120. def isUnnamed: Boolean
    Definition Classes
    NameableByComponent → Nameable
  121. val name: String
    Definition Classes
    Nameable
  122. val nameableRef: Nameable
    Attributes
    protected
    Definition Classes
    Nameable
    Annotations
    @DontName()
  123. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  124. def noBackendCombMerge(): TriState.this.type

    Put the combinatorial logic driving this signal in a separate process

    Put the combinatorial logic driving this signal in a separate process

    Definition Classes
    Data
  125. def noCombLoopCheck(): TriState.this.type

    Disable combinatorial loop checking for this Data

    Disable combinatorial loop checking for this Data

    See https://spinalhdl.github.io/SpinalDoc-RTD/master/SpinalHDL/Design%20errors/combinatorial_loop.html

    Definition Classes
    Data
  126. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  127. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  128. def onEachAttributes(doIt: (Attribute) ⇒ Unit): Unit
    Definition Classes
    SpinalTagReady
  129. def overrideLocalName(name: String): TriState.this.type
    Definition Classes
    Nameable
  130. val parent: Data
    Definition Classes
    Data
  131. val parentScope: ScopeStatement
    Definition Classes
    ContextUser
  132. def pull(propagateName: Boolean): TriState.this.type
    Definition Classes
    Data
  133. def pull(): TriState.this.type

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

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

    Definition Classes
    Data
  134. def purify(): TriState.this.type
    Definition Classes
    Data
  135. def randBoot(u: Unit): TriState.this.type

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

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

    Definition Classes
    Data
  136. val read: T
  137. val refOwner: RefOwnerType
    Definition Classes
    OwnableRef
    Annotations
    @DontName()
  138. def reflectNames(): Unit
    Definition Classes
    Nameable
  139. def removeAssignments(data: Boolean = true, init: Boolean = true, initial: Boolean = true): TriState.this.type
    Definition Classes
    Data
  140. def removeDataAssignments(): TriState.this.type
    Definition Classes
    Data
  141. def removeInitAssignments(): TriState.this.type
    Definition Classes
    Data
  142. def removeTag(spinalTag: SpinalTag): TriState.this.type
    Definition Classes
    SpinalTagReady
  143. def removeTags(tags: Iterable[SpinalTag]): TriState.this.type
    Definition Classes
    SpinalTagReady
  144. def resized: TriState.this.type

    Resized data regarding target

    Resized data regarding target

    Definition Classes
    Data
  145. def rootIF(): Interface

    root interface

    root interface

    Definition Classes
    Data
  146. def rootIFList(): List[Interface]
    Definition Classes
    Data
  147. def rootIFrec(now: Data, lastRoot: List[Interface]): List[Interface]
    Definition Classes
    Data
  148. val scalaTrace: Throwable
    Definition Classes
    ScalaLocated
  149. def setAll(): TriState.this.type
    Definition Classes
    Data
  150. def setAsAnalog(): TriState.this.type
    Definition Classes
    Data
  151. def setAsComb(): TriState.this.type

    Set baseType to Combinatorial

    Set baseType to Combinatorial

    Definition Classes
    MultiData → Data
  152. def setAsDirectionLess(): TriState.this.type

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

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

    Definition Classes
    MultiData → Data
  153. final def setAsMaster(): Unit

    Set as master interface

    Set as master interface

    Definition Classes
    IMasterSlave
  154. def setAsReg(): TriState.this.type

    Set baseType to reg

    Set baseType to reg

    Definition Classes
    MultiData → Data
  155. final def setAsSlave(): Unit

    Set a slave interface

    Set a slave interface

    Definition Classes
    IMasterSlave
  156. def setCompositeName(nameable: Nameable, postfix: String, namePriority: Byte): TriState.this.type
    Definition Classes
    Nameable
  157. def setCompositeName(nameable: Nameable, postfix: String, weak: Boolean): TriState.this.type
    Definition Classes
    Nameable
  158. def setCompositeName(nameable: Nameable, postfix: String): TriState.this.type
    Definition Classes
    Nameable
  159. def setCompositeName(nameable: Nameable, namePriority: Byte): TriState.this.type
    Definition Classes
    Nameable
  160. def setCompositeName(nameable: Nameable, weak: Boolean): TriState.this.type
    Definition Classes
    Nameable
  161. def setCompositeName(nameable: Nameable): TriState.this.type
    Definition Classes
    Nameable
  162. def setLambdaName(isNameBody: ⇒ Boolean)(nameGen: ⇒ String): TriState.this.type
    Definition Classes
    Nameable
  163. def setName(name: String, namePriority: Byte): TriState.this.type
    Definition Classes
    Nameable
  164. def setName(name: String, weak: Boolean): TriState.this.type
    Definition Classes
    Nameable
  165. def setName(name: String): TriState.this.type
    Definition Classes
    Nameable
  166. def setNameAsWeak(): TriState.this.type
    Definition Classes
    Nameable
  167. def setOutputAsReg(): TriState.this.type

    Recursively set baseType to reg only for output

    Recursively set baseType to reg only for output

    Definition Classes
    Data
  168. def setPartialName(name: String, namePriority: Byte, owner: Any): TriState.this.type
    Definition Classes
    Nameable
  169. def setPartialName(name: String, namePriority: Byte): TriState.this.type
    Definition Classes
    Nameable
  170. def setPartialName(name: String, weak: Boolean): TriState.this.type
    Definition Classes
    Nameable
  171. def setPartialName(owner: Nameable, name: String, namePriority: Byte): TriState.this.type
    Definition Classes
    Nameable
  172. def setPartialName(owner: Nameable, name: String, weak: Boolean): TriState.this.type
    Definition Classes
    Nameable
  173. def setPartialName(name: String): TriState.this.type
    Definition Classes
    Nameable
  174. def setPartialName(owner: Nameable, name: String): TriState.this.type
    Definition Classes
    Nameable
  175. def setPartialName(owner: Nameable): TriState.this.type
    Definition Classes
    Nameable
  176. def setRefOwner(that: Any): Unit
    Definition Classes
    OwnableRef
  177. def setScalaLocated(source: ScalaLocated): TriState.this.type
    Definition Classes
    ScalaLocated
  178. def setWeakName(name: String): TriState.this.type
    Definition Classes
    Nameable
  179. def spinalTags: LinkedHashSet[SpinalTag]
    Definition Classes
    SpinalTagReady
  180. def stage(): TriState[T]
  181. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  182. def toIo(): TriState.this.type
    Definition Classes
    Data
  183. def toMuxInput[T <: Data](muxOutput: T): T
    Definition Classes
    Data
  184. def toString(): String
    Definition Classes
    Bundle → Nameable → AnyRef → Any
  185. def unfreeze(): TriState.this.type
    Definition Classes
    MultiData → Data
  186. def unsetName(): TriState.this.type
    Definition Classes
    Nameable
  187. def valCallback[T](ref: T, name: String): T
    Definition Classes
    ValCallbackRec → ValCallback
  188. def valCallbackOn(ref: Any, name: String, refs: Set[Any]): Unit
    Definition Classes
    ValCallbackRec
  189. def valCallbackRec(ref: Any, name: String): Unit
    Definition Classes
    Bundle → ValCallbackRec
  190. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  191. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  192. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  193. def wrapNext(): TriState.this.type
    Definition Classes
    Data
  194. val write: T
  195. val writeEnable: Bool
  196. def zipByName(that: MultiData, rec: ArrayBuffer[(BaseType, BaseType)] = ArrayBuffer()): ArrayBuffer[(BaseType, BaseType)]
    Definition Classes
    MultiData

Deprecated Value Members

  1. def asDirectionLess(): TriState.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
    TriState → 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
    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): TriState.this.type

    Generate this if condition is true

    Generate this if condition is true

    Definition Classes
    Data
    Annotations
    @deprecated
    Deprecated

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

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

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