Packages

c

spinal.core

Interface

class Interface extends Bundle

system verilog interface

Example

case class MyIf(width: Int = 8) extends SVIF with IMasterSlave {
 val wParam = addGeneric("WIDTH", width, default = "8")
 val a = Bits(width bits)
 tieGeneric(a, wParam)
 val b = Bool()
 val c = SInt(8 bits)

 override def asMaster = mst
 @modport
 def mst = {
   out(a, b, c)
 }

 @modport
 def slv = {
   in(a, b, c)
 }

}
Linear Supertypes
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. Interface
  2. Bundle
  3. ValCallbackRec
  4. ValCallback
  5. MultiData
  6. Data
  7. InComponent
  8. OverridedEqualsHashCode
  9. SpinalTagReady
  10. Assignable
  11. NameableByComponent
  12. Nameable
  13. OwnableRef
  14. ContextUser
  15. ScalaLocated
  16. GlobalDataUser
  17. AnyRef
  18. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Interface()

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. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. val IFGeneric: LinkedHashMap[(Data, String), String]
  7. val _spinalTags: LinkedHashSet[SpinalTag]
    Definition Classes
    SpinalTagReady
  8. def addAttribute(attribute: Attribute): Interface.this.type
    Definition Classes
    Data → SpinalTagReady
  9. def addAttribute(name: String, value: Int): Interface.this.type
    Definition Classes
    SpinalTagReady
  10. def addAttribute(name: String, value: String): Interface.this.type
    Definition Classes
    SpinalTagReady
  11. def addAttribute(name: String): Interface.this.type
    Definition Classes
    SpinalTagReady
  12. def addGeneric(name: String, that: Any, default: String = null): String
  13. def addParameter(name: String, that: Any, default: String = null): String
  14. def addTag[T <: SpinalTag](spinalTag: T): Interface.this.type
    Definition Classes
    MultiData → SpinalTagReady
  15. def addTags(h: SpinalTag, tail: SpinalTag*): Interface.this.type
    Definition Classes
    SpinalTagReady
  16. def addTags[T <: SpinalTag](tags: Iterable[T]): Interface.this.type
    Definition Classes
    SpinalTagReady
  17. def allModPort: List[String]
  18. def allowDirectionLessIo(): Interface.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
  19. def allowOverride(): Interface.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
  20. def allowPartialyAssigned(): Interface.this.type

    Allow a register to be partially assigned

    Allow a register to be partially assigned

    Definition Classes
    Data
  21. def allowPruning(): Interface.this.type
    Definition Classes
    Data
  22. def allowSimplifyIt(): Interface.this.type
    Definition Classes
    Data
  23. def allowUnsetRegToAvoidLatch(): Interface.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
  24. def as[T <: Data](dataType: HardType[T]): T
    Definition Classes
    Data
  25. def asBits: Bits

    Cast data to Bits

    Cast data to Bits

    Definition Classes
    MultiData → Data
  26. def asData: Data
    Definition Classes
    Data
  27. def asInOut(): Interface.this.type

    set a data as inout

    set a data as inout

    Definition Classes
    MultiData → Data
  28. def asInput(): Interface.this.type

    Set a data as input

    Set a data as input

    Definition Classes
    MultiData → Data
  29. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  30. def asOutput(): Interface.this.type

    Set a data as output

    Set a data as output

    Definition Classes
    MultiData → Data
  31. 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
  32. def assignDontCare(): Interface.this.type
    Definition Classes
    Data
  33. def assignDontCareToUnasigned(): Interface.this.type
    Definition Classes
    Data
  34. def assignFormalRandom(kind: RandomExpKind): Unit
    Definition Classes
    MultiData → Data
  35. final def assignFrom(that: AnyRef, target: AnyRef = this)(implicit loc: Location): Unit
    Definition Classes
    Data
  36. def assignFromBits(bits: Bits, hi: Int, lo: Int): Unit
    Definition Classes
    MultiData → Data
  37. def assignFromBits(bits: Bits): Unit
    Definition Classes
    MultiData → Data
  38. def assignFromBits(bits: Bits, offset: Int, bitCount: BitCount): Unit
    Definition Classes
    Data
  39. def assignFromImpl(that: AnyRef, target: AnyRef, kind: AnyRef)(implicit loc: Location): Unit
    Attributes
    protected
    Definition Classes
    Bundle → Assignable
  40. 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
  41. def assignUnassignedByName(that: MultiData): Unit
    Definition Classes
    MultiData
  42. def bundleAssign(that: Bundle)(f: (Data, Data) => Unit): Unit
    Definition Classes
    Bundle
  43. def callModPort(s: String): Unit
  44. def checkDir(that: Bundle): Boolean

    for interface find modport

    for interface find modport

    Definition Classes
    Bundle
  45. def checkModport(): List[String]
  46. def clearAll(): Interface.this.type
    Definition Classes
    Data
  47. def clone(): Interface
    Definition Classes
    Interface → Bundle → Data → AnyRef
  48. def component: Component
    Definition Classes
    ContextUser
  49. final def compositAssignFrom(that: AnyRef, target: AnyRef, kind: AnyRef)(implicit loc: Location): Unit
    Definition Classes
    Assignable
  50. val compositeAssign: Assignable
    Definition Classes
    Assignable
  51. def copyDirectionOfImpl(that: Data): Interface.this.type
    Definition Classes
    MultiData → Data
  52. var definitionName: String
  53. def dirString(): String
    Definition Classes
    Data
  54. def dontSimplifyIt(): Interface.this.type
    Definition Classes
    Data
  55. def elements: ArrayBuffer[(String, Data)]
    Definition Classes
    Bundle → MultiData
  56. var elementsCache: ArrayBuffer[(String, Data)]
    Definition Classes
    Bundle
  57. def elementsString: String
    Definition Classes
    MultiData
  58. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  59. def equals(obj: Any): Boolean
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  60. def existsTag(cond: (SpinalTag) => Boolean): Boolean
    Definition Classes
    SpinalTagReady
  61. def filterTag(cond: (SpinalTag) => Boolean): Iterable[SpinalTag]
    Definition Classes
    SpinalTagReady
  62. def find(name: String): Data
    Definition Classes
    MultiData
  63. def findTag(cond: (SpinalTag) => Boolean): Option[SpinalTag]
    Definition Classes
    SpinalTagReady
  64. def flatten: Seq[BaseType]
    Definition Classes
    MultiData → Data
  65. def flattenForeach(body: (BaseType) => Unit): Unit
    Definition Classes
    MultiData → Data
  66. def flattenLocalName: Seq[String]
    Definition Classes
    MultiData → Data
  67. def flip(): Interface.this.type

    flip the direction of the data

    flip the direction of the data

    Definition Classes
    MultiData → Data
  68. def foreachReflectableNameables(doThat: (Any) => Unit): Unit
    Definition Classes
    Nameable
  69. def foreachTag(body: (SpinalTag) => Unit): Unit
    Definition Classes
    SpinalTagReady
  70. def freeze(): Interface.this.type
    Definition Classes
    MultiData → Data
  71. val genericElements: ArrayBuffer[(String, Any, String)]
  72. def getAheadValue(): Interface.this.type
    Definition Classes
    Data
  73. def getBitsWidth: Int

    Return the width of the data

    Return the width of the data

    Definition Classes
    MultiData → Data
  74. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  75. def getComponent(): Component
    Definition Classes
    Data → InComponent → NameableByComponent
  76. def getComponents(): Seq[Component]

    Get current component with all parents

    Get current component with all parents

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

    Create a data set to 0

    Create a data set to 0

    Definition Classes
    MultiData → Data
  98. val globalData: GlobalData
    Definition Classes
    GlobalDataUser
  99. var hardtype: HardType[_]
    Definition Classes
    Bundle
  100. def hasTag[T <: SpinalTag](clazz: Class[T]): Boolean
    Definition Classes
    SpinalTagReady
  101. def hasTag(spinalTag: SpinalTag): Boolean
    Definition Classes
    SpinalTagReady
  102. def hashCode(): Int
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  103. final def initFrom(that: AnyRef, target: AnyRef = this): Unit
    Definition Classes
    Data
  104. def instanceAttributes(language: Language): Iterable[Attribute]
    Definition Classes
    SpinalTagReady
  105. def instanceAttributes: Iterable[Attribute]
    Definition Classes
    SpinalTagReady
  106. def isAnalog: Boolean
    Definition Classes
    Data
  107. def isComb: Boolean
    Definition Classes
    Data
  108. def isCompletelyUnnamed: Boolean
    Definition Classes
    Nameable
  109. def isDirectionLess: Boolean
    Definition Classes
    Data
  110. def isEmptyOfTag: Boolean
    Definition Classes
    SpinalTagReady
  111. def isInOut: Boolean
    Definition Classes
    Data
  112. def isInput: Boolean
    Definition Classes
    Data
  113. def isInputOrInOut: Boolean
    Definition Classes
    Data
  114. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  115. def isNamed: Boolean
    Definition Classes
    NameableByComponent → Nameable
  116. def isOutput: Boolean
    Definition Classes
    Data
  117. def isOutputOrInOut: Boolean
    Definition Classes
    Data
  118. def isPriorityApplicable(namePriority: Byte): Boolean
    Definition Classes
    Nameable
  119. def isReg: Boolean
    Definition Classes
    Data
  120. def isRegOnAssign: Boolean
    Definition Classes
    Data
  121. def isUnnamed: Boolean
    Definition Classes
    Nameable
  122. val name: String
    Definition Classes
    Nameable
  123. val nameableRef: Nameable
    Attributes
    protected
    Definition Classes
    Nameable
    Annotations
    @DontName()
  124. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  125. def noBackendCombMerge(): Interface.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
  126. def noCombLoopCheck(): Interface.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
  127. def notSVIF(): Unit
  128. def notSVIFthisLevel(): Unit
  129. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  130. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  131. def onEachAttributes(doIt: (Attribute) => Unit): Unit
    Definition Classes
    SpinalTagReady
  132. def overrideLocalName(name: String): Interface.this.type
    Definition Classes
    Nameable
  133. val parent: Data
    Definition Classes
    Data
  134. val parentScope: ScopeStatement
    Definition Classes
    ContextUser
  135. def pull(propagateName: Boolean): Interface.this.type
    Definition Classes
    Data
  136. def pull(): Interface.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
  137. def purify(): Interface.this.type
    Definition Classes
    Data
  138. def randBoot(u: Unit): Interface.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
  139. val refOwner: RefOwnerType
    Definition Classes
    OwnableRef
    Annotations
    @DontName()
  140. def reflectNames(): Unit
    Definition Classes
    Nameable
  141. def removeAssignments(data: Boolean = true, init: Boolean = true, initial: Boolean = true): Interface.this.type
    Definition Classes
    Data
  142. def removeDataAssignments(): Interface.this.type
    Definition Classes
    Data
  143. def removeInitAssignments(): Interface.this.type
    Definition Classes
    Data
  144. def removeTag(spinalTag: SpinalTag): Interface.this.type
    Definition Classes
    SpinalTagReady
  145. def removeTags(tags: Iterable[SpinalTag]): Interface.this.type
    Definition Classes
    SpinalTagReady
  146. def resized: Interface.this.type

    Resized data regarding target

    Resized data regarding target

    Definition Classes
    Data
  147. def rootIF(): Interface

    root interface

    root interface

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

    Set baseType to Combinatorial

    Set baseType to Combinatorial

    Definition Classes
    MultiData → Data
  154. def setAsDirectionLess(): Interface.this.type

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

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

    Definition Classes
    MultiData → Data
  155. def setAsReg(): Interface.this.type

    Set baseType to reg

    Set baseType to reg

    Definition Classes
    MultiData → Data
  156. def setCompositeName(nameable: Nameable, postfix: String, namePriority: Byte): Interface.this.type
    Definition Classes
    Nameable
  157. def setCompositeName(nameable: Nameable, postfix: String, weak: Boolean): Interface.this.type
    Definition Classes
    Nameable
  158. def setCompositeName(nameable: Nameable, postfix: String): Interface.this.type
    Definition Classes
    Nameable
  159. def setCompositeName(nameable: Nameable, namePriority: Byte): Interface.this.type
    Definition Classes
    Nameable
  160. def setCompositeName(nameable: Nameable, weak: Boolean): Interface.this.type
    Definition Classes
    Nameable
  161. def setCompositeName(nameable: Nameable): Interface.this.type
    Definition Classes
    Nameable
  162. def setDefinitionName(name: String): Interface.this.type

    Set the definition name of the component

  163. def setLambdaName(isNameBody: => Boolean)(nameGen: => String): Interface.this.type
    Definition Classes
    Nameable
  164. def setName(name: String, namePriority: Byte): Interface.this.type
    Definition Classes
    Nameable
  165. def setName(name: String, weak: Boolean): Interface.this.type
    Definition Classes
    Nameable
  166. def setName(name: String): Interface.this.type
    Definition Classes
    Nameable
  167. def setNameAsWeak(): Interface.this.type
    Definition Classes
    Nameable
  168. def setOutputAsReg(): Interface.this.type

    Recursively set baseType to reg only for output

    Recursively set baseType to reg only for output

    Definition Classes
    Data
  169. def setPartialName(name: String, namePriority: Byte, owner: Any): Interface.this.type
    Definition Classes
    Nameable
  170. def setPartialName(name: String, namePriority: Byte): Interface.this.type
    Definition Classes
    Nameable
  171. def setPartialName(name: String, weak: Boolean): Interface.this.type
    Definition Classes
    Nameable
  172. def setPartialName(owner: Nameable, name: String, namePriority: Byte): Interface.this.type
    Definition Classes
    Nameable
  173. def setPartialName(owner: Nameable, name: String, weak: Boolean): Interface.this.type
    Definition Classes
    Nameable
  174. def setPartialName(name: String): Interface.this.type
    Definition Classes
    Nameable
  175. def setPartialName(owner: Nameable, name: String): Interface.this.type
    Definition Classes
    Nameable
  176. def setPartialName(owner: Nameable): Interface.this.type
    Definition Classes
    Nameable
  177. def setRefOwner(that: Any): Unit
    Definition Classes
    OwnableRef
  178. def setScalaLocated(source: ScalaLocated): Interface.this.type
    Definition Classes
    ScalaLocated
  179. def setWeakName(name: String): Interface.this.type
    Definition Classes
    Nameable
  180. def spinalTags: LinkedHashSet[SpinalTag]
    Definition Classes
    SpinalTagReady
  181. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  182. var thisIsNotSVIF: Boolean
  183. def tieGeneric[T <: BitVector](signal: T, generic: String): LinkedHashMap[BitVector, String]
  184. def tieIFParameter[T <: Interface](signal: T, signalParam: String, inputParam: String): LinkedHashMap[(Data, String), String]
  185. def tieParameter[T <: BitVector](signal: T, parameter: String): LinkedHashMap[BitVector, String]
  186. def toIo(): Interface.this.type
    Definition Classes
    Data
  187. def toMuxInput[T <: Data](muxOutput: T): T
    Definition Classes
    Data
  188. def toString(): String
    Definition Classes
    Bundle → Nameable → AnyRef → Any
  189. def unfreeze(): Interface.this.type
    Definition Classes
    MultiData → Data
  190. def unsetName(): Interface.this.type
    Definition Classes
    Nameable
  191. def valCallback[T](ref: T, name: String): T
    Definition Classes
    ValCallbackRec → ValCallback
  192. def valCallbackOn(ref: Any, name: String, refs: Set[Any]): Unit
    Definition Classes
    ValCallbackRec
  193. def valCallbackRec(ref: Any, name: String): Unit
    Definition Classes
    Interface → Bundle → ValCallbackRec
  194. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  195. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  196. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  197. val widthGeneric: LinkedHashMap[BitVector, String]
  198. def wrapNext(): Interface.this.type
    Definition Classes
    Data
  199. def zipByName(that: MultiData, rec: ArrayBuffer[(BaseType, BaseType)] = ArrayBuffer()): ArrayBuffer[(BaseType, BaseType)]
    Definition Classes
    MultiData

Deprecated Value Members

  1. def asDirectionLess(): Interface.this.type
    Definition Classes
    Data
    Annotations
    @deprecated
    Deprecated

    (Since version ???) use setAsDirectionLess instead

  2. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  3. def genIf(cond: Boolean): Interface.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 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