Packages

abstract class Component extends NameableByComponent with ContextUser with ScalaLocated with PostInitCallback with Stackable with OwnableRef with SpinalTagReady with OverridedEqualsHashCode with ValCallbackRec

Abstract class used to create a new Component

Example:

  1. class MyAndGate extends Component {
  val io = new Bundle{
    val a,b = in Bool()
    val res = out Bool()
  }
  io.res := io.a & io.b
}
See also

Component Documentation

Linear Supertypes
ValCallbackRec, ValCallback, OverridedEqualsHashCode, SpinalTagReady, Stackable, PostInitCallback, NameableByComponent, Nameable, ContextUser, ScalaLocated, GlobalDataUser, OwnableRef, AnyRef, Any
Known Subclasses
BlackBox, BlackBoxULogic, Ram_1w_1ra, Ram_1w_1rs, Ram_1wors, Ram_1wrs, Ram_2c_1w_1rs, Ram_2wrs
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Component
  2. ValCallbackRec
  3. ValCallback
  4. OverridedEqualsHashCode
  5. SpinalTagReady
  6. Stackable
  7. PostInitCallback
  8. NameableByComponent
  9. Nameable
  10. ContextUser
  11. ScalaLocated
  12. GlobalDataUser
  13. OwnableRef
  14. AnyRef
  15. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Component()

Type Members

  1. case class PrePopTask(task: () => Unit) extends Product with Serializable

    Class used to create a task that must be executed after the creation of the component

  2. abstract type RefOwnerType
    Definition Classes
    OwnableRef

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val _spinalTags: LinkedHashSet[SpinalTag]
    Definition Classes
    SpinalTagReady
  5. def addAttribute(attribute: Attribute): Component.this.type
    Definition Classes
    Component → SpinalTagReady
  6. def addAttribute(name: String, value: Int): Component.this.type
    Definition Classes
    SpinalTagReady
  7. def addAttribute(name: String, value: String): Component.this.type
    Definition Classes
    SpinalTagReady
  8. def addAttribute(name: String): Component.this.type
    Definition Classes
    SpinalTagReady
  9. def addComment(str: String): Component
  10. def addPrePopTask(task: () => Unit): ArrayBuffer[PrePopTask]

    Add a new prePopTask

  11. def addTag[T <: SpinalTag](spinalTag: T): Component.this.type
    Definition Classes
    SpinalTagReady
  12. def addTags[T <: SpinalTag](tags: Iterable[T]): Component.this.type
    Definition Classes
    SpinalTagReady
  13. def afterElaboration(body: => Unit): ArrayBuffer[PrePopTask]
  14. def asFormalDut(): Component.this.type
  15. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  16. val children: ArrayBuffer[Component]

    Contains an array of all children Component

  17. val clockDomain: Handle[ClockDomain]

    Get the current clock domain (null if there is no clock domain already set )

  18. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  19. def component: Component
    Definition Classes
    ContextUser
  20. val definition: $anon forSome {type $anon <: SpinalTagReady { def addComment(str: String): $anon }}
  21. var definitionName: String

    Definition Name (name of the entity (VHDL) or module (Verilog))

  22. var definitionNameNoMerge: Boolean
  23. val dslBody: ScopeStatement
  24. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  25. def equals(obj: Any): Boolean
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  26. def existsTag(cond: (SpinalTag) => Boolean): Boolean
    Definition Classes
    SpinalTagReady
  27. def filterTag(cond: (SpinalTag) => Boolean): Iterable[SpinalTag]
    Definition Classes
    SpinalTagReady
  28. def findTag(cond: (SpinalTag) => Boolean): Option[SpinalTag]
    Definition Classes
    SpinalTagReady
  29. def foreachReflectableNameables(doThat: (Any) => Unit): Unit
    Definition Classes
    Nameable
  30. def foreachTag(body: (SpinalTag) => Unit): Unit
    Definition Classes
    SpinalTagReady
  31. def getAllIo: Set[BaseType]

    Get a set of all IO available in the component

  32. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  33. def getDisplayName(): String
    Definition Classes
    Component → Nameable
  34. def getGroupedIO(ioBundleBypass: Boolean): Seq[Data]
  35. def getInstanceCounter: Int
    Definition Classes
    ContextUser
  36. def getMode: Byte
    Attributes
    protected
    Definition Classes
    Nameable
  37. def getName(default: String): String
    Definition Classes
    NameableByComponent → Nameable
  38. def getName(): String
    Definition Classes
    NameableByComponent → Nameable
  39. def getOrdredNodeIo: List[BaseType]

    Sort all IO regarding instanceCounter

  40. def getParentsPath(sep: String = "/"): String

    Return the path of the parent

    Return the path of the parent

    Example:

    1. toplevel/[myComponent1] // Current component is myComponent2
  41. def getPartialName(): String
    Definition Classes
    Nameable
  42. def getPath(sep: String = "/"): String

    Return the path of the component

    Return the path of the component

    Example:

    1. toplevel/[myComponent1]/[myComponent2] // Current component is myComponent2
  43. def getPath(from: Component, to: Component): Seq[Component]
    Definition Classes
    NameableByComponent
  44. def getRefOwnersChain(): List[Any]
    Definition Classes
    OwnableRef
  45. def getRtlPath(separator: String = "/"): String
  46. def getScalaLocationLong: String
    Definition Classes
    ScalaLocated
  47. def getScalaLocationShort: String
    Definition Classes
    ScalaLocated
  48. def getScalaTrace(): Throwable
    Definition Classes
    ScalaLocated
  49. def getTag[T <: SpinalTag](clazz: Class[T]): Option[T]
    Definition Classes
    SpinalTagReady
  50. def getTags(): LinkedHashSet[SpinalTag]
    Definition Classes
    SpinalTagReady
  51. val globalData: GlobalData
    Definition Classes
    GlobalDataUser
  52. def hasTag[T <: SpinalTag](clazz: Class[T]): Boolean
    Definition Classes
    SpinalTagReady
  53. def hasTag(spinalTag: SpinalTag): Boolean
    Definition Classes
    SpinalTagReady
  54. def hashCode(): Int
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  55. def instanceAttributes(language: Language): Iterable[Attribute]
    Definition Classes
    SpinalTagReady
  56. def instanceAttributes: Iterable[Attribute]
    Definition Classes
    SpinalTagReady
  57. def isCompletelyUnnamed: Boolean
    Definition Classes
    Nameable
  58. def isEmptyOfTag: Boolean
    Definition Classes
    SpinalTagReady
  59. var isFormalTester: Boolean
  60. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  61. def isLogicLess: Boolean
  62. def isNamed: Boolean
    Definition Classes
    NameableByComponent → Nameable
  63. def isPriorityApplicable(namePriority: Byte): Boolean
    Definition Classes
    Nameable
  64. def isUnnamed: Boolean
    Definition Classes
    Nameable
  65. var localNamingScope: NamingScope

    Name allocation

  66. val name: String
    Definition Classes
    Nameable
  67. val nameableRef: Nameable
    Attributes
    protected
    Definition Classes
    Nameable
    Annotations
    @DontName()
  68. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  69. def noIoPrefix(): Component.this.type

    No "io_" prefix in front of the in/out signals

  70. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  71. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  72. def onBody[T](body: => T): T
  73. def onEachAttributes(doIt: (Attribute) => Unit): Unit
    Definition Classes
    SpinalTagReady
  74. def overrideLocalName(name: String): Component.this.type
    Definition Classes
    Nameable
  75. def parent: Component

    Get the parent component (null if there is no parent)

  76. val parentScope: ScopeStatement
    Definition Classes
    ContextUser
  77. def parents(of: Component = this, list: List[Component] = Nil): List[Component]

    Return a list of all parents of the components

  78. def postInitCallback(): Component.this.type
    Definition Classes
    Component → PostInitCallback
  79. def postPopEvent(): Unit
    Definition Classes
    Stackable
  80. def postPushEvent(): Unit
    Definition Classes
    Component → Stackable
  81. def prePop(): Unit
  82. def prePopEvent(): Unit
    Definition Classes
    Component → Stackable
  83. var pulledDataCache: Map[Data, Data]
  84. val refOwner: RefOwnerType
    Definition Classes
    OwnableRef
    Annotations
    @DontName()
  85. def reflectBaseType(name: String): BaseType
  86. def reflectNames(): Unit
    Definition Classes
    Nameable
  87. def removeTag(spinalTag: SpinalTag): Component.this.type
    Definition Classes
    SpinalTagReady
  88. def removeTags(tags: Iterable[SpinalTag]): Component.this.type
    Definition Classes
    SpinalTagReady
  89. def rework[T](gen: => T): T
  90. val scalaTrace: Throwable
    Definition Classes
    ScalaLocated
  91. val scopeProperties: Capture

    Rework the component

  92. def setCompositeName(nameable: Nameable, postfix: String, namePriority: Byte): Component.this.type
    Definition Classes
    Nameable
  93. def setCompositeName(nameable: Nameable, postfix: String, weak: Boolean): Component.this.type
    Definition Classes
    Nameable
  94. def setCompositeName(nameable: Nameable, postfix: String): Component.this.type
    Definition Classes
    Nameable
  95. def setCompositeName(nameable: Nameable, namePriority: Byte): Component.this.type
    Definition Classes
    Nameable
  96. def setCompositeName(nameable: Nameable, weak: Boolean): Component.this.type
    Definition Classes
    Nameable
  97. def setCompositeName(nameable: Nameable): Component.this.type
    Definition Classes
    Nameable
  98. def setDefinitionName(name: String, noMerge: Boolean = true): Component.this.type

    Set the definition name of the component

  99. def setFormalTester(): Unit
  100. def setLambdaName(isNameBody: => Boolean)(nameGen: => String): Component.this.type
    Definition Classes
    Nameable
  101. def setName(name: String, namePriority: Byte): Component.this.type
    Definition Classes
    Nameable
  102. def setName(name: String, weak: Boolean): Component.this.type
    Definition Classes
    Nameable
  103. def setName(name: String): Component.this.type
    Definition Classes
    Nameable
  104. def setNameAsWeak(): Component.this.type
    Definition Classes
    Nameable
  105. def setPartialName(name: String, namePriority: Byte, owner: Any): Component.this.type
    Definition Classes
    Nameable
  106. def setPartialName(name: String, namePriority: Byte): Component.this.type
    Definition Classes
    Nameable
  107. def setPartialName(name: String, weak: Boolean): Component.this.type
    Definition Classes
    Nameable
  108. def setPartialName(owner: Nameable, name: String, namePriority: Byte): Component.this.type
    Definition Classes
    Nameable
  109. def setPartialName(owner: Nameable, name: String, weak: Boolean): Component.this.type
    Definition Classes
    Nameable
  110. def setPartialName(name: String): Component.this.type
    Definition Classes
    Nameable
  111. def setPartialName(owner: Nameable, name: String): Component.this.type
    Definition Classes
    Nameable
  112. def setPartialName(owner: Nameable): Component.this.type
    Definition Classes
    Nameable
  113. def setRefOwner(that: Any): Unit
    Definition Classes
    OwnableRef
  114. def setScalaLocated(source: ScalaLocated): Component.this.type
    Definition Classes
    ScalaLocated
  115. def setWeakName(name: String): Component.this.type
    Definition Classes
    Nameable
  116. def spinalTags: LinkedHashSet[SpinalTag]
    Definition Classes
    SpinalTagReady
  117. def stub(): Component.this.type

    Empty Component, remove logic in component and assign zero on output port as stub

    Empty Component, remove logic in component and assign zero on output port as stub

    Example:

    1. val dut = (new MyComponent).stub()
  118. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  119. def toString(): String
    Definition Classes
    Nameable → AnyRef → Any
  120. def traceDisable(recursive: Boolean = true): Component.this.type
  121. def traceEnable(recursive: Boolean = true): Component.this.type
  122. var traceEnabled: Boolean
  123. def unsetName(): Component.this.type
    Definition Classes
    Nameable
  124. val userCache: Map[Any, Any]

    Used to store arbitrary object related to the component

  125. def valCallback[T](ref: T, name: String): T
    Definition Classes
    ValCallbackRec → ValCallback
  126. def valCallbackOn(ref: Any, name: String, refs: Set[Any]): Unit
    Definition Classes
    ValCallbackRec
  127. def valCallbackRec(ref: Any, name: String): Unit
    Definition Classes
    Component → ValCallbackRec
  128. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  129. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  130. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  131. def walkComponents(body: (Component) => Unit): Unit
  132. def withAutoPull(): Unit
  133. var withHierarchyAutoPull: Boolean
  134. def withKeywords(): Unit
  135. var withVitalOutputs: Boolean
  136. def withoutKeywords(): Unit
  137. var withoutReservedKeywords: Boolean

Deprecated Value Members

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

Inherited from ValCallbackRec

Inherited from ValCallback

Inherited from OverridedEqualsHashCode

Inherited from SpinalTagReady

Inherited from Stackable

Inherited from PostInitCallback

Inherited from NameableByComponent

Inherited from Nameable

Inherited from ContextUser

Inherited from ScalaLocated

Inherited from GlobalDataUser

Inherited from OwnableRef

Inherited from AnyRef

Inherited from Any

Ungrouped