Class/Object

spinal.core

Component

Related Docs: object Component | package core

Permalink

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
Known Subclasses
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. All

Instance Constructors

  1. new Component()

    Permalink

Type Members

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

    Permalink

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

  2. abstract type RefOwnerType

    Permalink
    Definition Classes
    OwnableRef

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. var _spinalTags: LinkedHashSet[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady
  5. def addAttribute(attribute: Attribute): Component.this.type

    Permalink
    Definition Classes
    ComponentSpinalTagReady
  6. def addAttribute(name: String, value: Int): Component.this.type

    Permalink
    Definition Classes
    SpinalTagReady
  7. def addAttribute(name: String, value: String): Component.this.type

    Permalink
    Definition Classes
    SpinalTagReady
  8. def addAttribute(name: String): Component.this.type

    Permalink
    Definition Classes
    SpinalTagReady
  9. def addComment(str: String): Component

    Permalink
  10. def addPrePopTask(task: () ⇒ Unit): ArrayBuffer[PrePopTask]

    Permalink

    Add a new prePopTask

  11. def addTag[T <: SpinalTag](spinalTag: T): Component.this.type

    Permalink
    Definition Classes
    SpinalTagReady
  12. def addTags(h: SpinalTag, tail: SpinalTag*): Component.this.type

    Permalink
    Definition Classes
    SpinalTagReady
  13. def addTags[T <: SpinalTag](tags: Iterable[T]): Component.this.type

    Permalink
    Definition Classes
    SpinalTagReady
  14. def afterElaboration(body: ⇒ Unit): ArrayBuffer[PrePopTask]

    Permalink
  15. def asFormalDut(): Component.this.type

    Permalink
  16. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  17. val children: ArrayBuffer[Component]

    Permalink

    Contains an array of all children Component

  18. val clockDomain: Handle[ClockDomain]

    Permalink

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

  19. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @throws( ... )
  20. def component: Component

    Permalink
    Definition Classes
    ContextUser
  21. val definition: $anon forSome {type $anon <: SpinalTagReady { def addComment(str: String): $anon }}

    Permalink
  22. var definitionName: String

    Permalink

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

  23. var definitionNameNoMerge: Boolean

    Permalink
  24. val dslBody: ScopeStatement

    Permalink
  25. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  26. def equals(obj: Any): Boolean

    Permalink
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  27. def existsTag(cond: (SpinalTag) ⇒ Boolean): Boolean

    Permalink
    Definition Classes
    SpinalTagReady
  28. def filterTag(cond: (SpinalTag) ⇒ Boolean): Iterable[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady
  29. def findTag(cond: (SpinalTag) ⇒ Boolean): Option[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady
  30. def foreachReflectableNameables(doThat: (Any) ⇒ Unit): Unit

    Permalink
    Definition Classes
    Nameable
  31. def foreachTag(body: (SpinalTag) ⇒ Unit): Unit

    Permalink
    Definition Classes
    SpinalTagReady
  32. def getAllIo: Set[BaseType]

    Permalink

    Get a set of all IO available in the component

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

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  34. def getDisplayName(): String

    Permalink
    Definition Classes
    ComponentNameable
  35. def getGroupedIO(ioBundleBypass: Boolean): Seq[Data]

    Permalink
  36. def getInstanceCounter: Int

    Permalink
    Definition Classes
    ContextUser
  37. def getMode: Byte

    Permalink
    Attributes
    protected
    Definition Classes
    Nameable
  38. def getName(default: String): String

    Permalink
    Definition Classes
    NameableByComponentNameable
  39. def getName(): String

    Permalink
    Definition Classes
    NameableByComponentNameable
  40. def getOrdredNodeIo: List[BaseType]

    Permalink

    Sort all IO regarding instanceCounter

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

    Permalink

    Return the path of the parent

    Return the path of the parent

    Example:
    1. toplevel/[myComponent1] // Current component is myComponent2
  42. def getPartialName(): String

    Permalink
    Definition Classes
    Nameable
  43. def getPath(sep: String = "/"): String

    Permalink

    Return the path of the component

    Return the path of the component

    Example:
    1. toplevel/[myComponent1]/[myComponent2] // Current component is myComponent2
  44. def getPath(from: Component, to: Component): Seq[Component]

    Permalink
    Definition Classes
    NameableByComponent
  45. def getRefOwnersChain(): List[Any]

    Permalink
    Definition Classes
    OwnableRef
  46. def getRtlPath(separator: String = "/"): String

    Permalink
  47. def getScalaLocationLong: String

    Permalink
    Definition Classes
    ScalaLocated
  48. def getScalaLocationShort: String

    Permalink
    Definition Classes
    ScalaLocated
  49. def getScalaTrace(): Throwable

    Permalink
    Definition Classes
    ScalaLocated
  50. def getTag[T <: SpinalTag](clazz: Class[T]): Option[T]

    Permalink
    Definition Classes
    SpinalTagReady
  51. def getTags(): LinkedHashSet[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady
  52. def getTagsOf[T <: SpinalTag]()(implicit tag: ClassTag[T]): Iterable[T]

    Permalink
    Definition Classes
    SpinalTagReady
  53. var globalData: GlobalData

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

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

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

    Permalink
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  57. def instanceAttributes(language: Language): Iterable[Attribute]

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

    Permalink
    Definition Classes
    SpinalTagReady
  59. def isCompletelyUnnamed: Boolean

    Permalink
    Definition Classes
    Nameable
  60. def isEmptyOfTag: Boolean

    Permalink
    Definition Classes
    SpinalTagReady
  61. var isFormalTester: Boolean

    Permalink
  62. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  63. def isLogicLess: Boolean

    Permalink
  64. final def isNamed: Boolean

    Permalink
    Definition Classes
    Nameable
  65. def isPriorityApplicable(namePriority: Byte): Boolean

    Permalink
    Definition Classes
    Nameable
  66. def isUnnamed: Boolean

    Permalink
    Definition Classes
    NameableByComponentNameable
  67. var localNamingScope: NamingScope

    Permalink

    Name allocation

  68. def makeInputsAnyseq(): Unit

    Permalink

    Use anyseq on any input signals to this component which do not have existing assignments.

  69. var name: String

    Permalink
    Definition Classes
    Nameable
  70. var nameableRef: Nameable

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

    Permalink
    Definition Classes
    AnyRef
  72. def noIoPrefix(): Component.this.type

    Permalink

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

  73. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  74. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  75. def onBody[T](body: ⇒ T): T

    Permalink
  76. def onEachAttributes(doIt: (Attribute) ⇒ Unit): Unit

    Permalink
    Definition Classes
    SpinalTagReady
  77. def overrideLocalName(name: String): Component.this.type

    Permalink
    Definition Classes
    Nameable
  78. def parent: Component

    Permalink

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

  79. var parentScope: ScopeStatement

    Permalink
    Definition Classes
    ContextUser
  80. def parents(of: Component = this, list: List[Component] = Nil): List[Component]

    Permalink

    Return a list of all parents of the components

  81. def postInitCallback(): Component.this.type

    Permalink
    Definition Classes
    Component → PostInitCallback
  82. def postPopEvent(): Unit

    Permalink
    Definition Classes
    Stackable
  83. def postPushEvent(): Unit

    Permalink
    Definition Classes
    ComponentStackable
  84. def prePop(): Unit

    Permalink
  85. def prePopEvent(): Unit

    Permalink
    Definition Classes
    ComponentStackable
  86. var pulledDataCache: Map[Data, Data]

    Permalink
  87. var refOwner: RefOwnerType

    Permalink
    Definition Classes
    OwnableRef
  88. def reflectBaseType(name: String): BaseType

    Permalink
  89. def reflectNames(): Unit

    Permalink
    Definition Classes
    Nameable
  90. def removeTag(spinalTag: SpinalTag): Component.this.type

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

    Permalink
    Definition Classes
    SpinalTagReady
  92. def rework[T](gen: ⇒ T): T

    Permalink
  93. var scalaTrace: Throwable

    Permalink
    Definition Classes
    ScalaLocated
  94. val scopeProperties: Capture

    Permalink

    Rework the component

  95. def setCompositeName(nameable: Nameable, postfix: String, namePriority: Byte): Component.this.type

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

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

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

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

    Permalink
    Definition Classes
    Nameable
  100. def setCompositeName(nameable: Nameable): Component.this.type

    Permalink
    Definition Classes
    Nameable
  101. def setDefinitionName(name: String, noMerge: Boolean = true): Component.this.type

    Permalink

    Set the definition name of the component

  102. def setFormalTester(): Unit

    Permalink
  103. def setLambdaName(isNameBody: ⇒ Boolean)(nameGen: ⇒ String): Component.this.type

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

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

    Permalink
    Definition Classes
    Nameable
  106. def setName(name: String): Component.this.type

    Permalink
    Definition Classes
    Nameable
  107. def setNameAsWeak(): Component.this.type

    Permalink
    Definition Classes
    Nameable
  108. def setPartialName(name: String, namePriority: Byte, owner: Any): Component.this.type

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

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

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

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

    Permalink
    Definition Classes
    Nameable
  113. def setPartialName(name: String): Component.this.type

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

    Permalink
    Definition Classes
    Nameable
  115. def setPartialName(owner: Nameable): Component.this.type

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

    Permalink
    Definition Classes
    OwnableRef
  117. def setScalaLocated(source: ScalaLocated): Component.this.type

    Permalink
    Definition Classes
    ScalaLocated
  118. def setWeakName(name: String): Component.this.type

    Permalink
    Definition Classes
    Nameable
  119. def spinalTags: LinkedHashSet[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady
  120. def stub(): Component.this.type

    Permalink

    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()
  121. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  122. def toString(): String

    Permalink
    Definition Classes
    Nameable → AnyRef → Any
  123. def traceDisable(recursive: Boolean = true): Component.this.type

    Permalink
  124. def traceEnable(recursive: Boolean = true): Component.this.type

    Permalink
  125. var traceEnabled: Boolean

    Permalink
  126. def unsetName(): Component.this.type

    Permalink
    Definition Classes
    Nameable
  127. val userCache: Map[Any, Any]

    Permalink

    Used to store arbitrary object related to the component

  128. def valCallback[T](ref: T, name: String): T

    Permalink
    Definition Classes
    ValCallbackRec → ValCallback
  129. def valCallbackOn(ref: Any, name: String, refs: Set[Any]): Unit

    Permalink
    Definition Classes
    ValCallbackRec
  130. def valCallbackRec(ref: Any, name: String): Unit

    Permalink
    Definition Classes
    ComponentValCallbackRec
  131. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  132. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  133. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  134. def walkComponents(body: (Component) ⇒ Unit): Unit

    Permalink
  135. def withAutoPull(): Unit

    Permalink
  136. var withHierarchyAutoPull: Boolean

    Permalink
  137. def withKeywords(): Unit

    Permalink
  138. var withVitalOutputs: Boolean

    Permalink
  139. def withoutKeywords(): Unit

    Permalink
  140. var withoutReservedKeywords: Boolean

    Permalink

Deprecated Value Members

  1. def finalize(): Unit

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

    (Since version ) see corresponding Javadoc for more information.

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