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

    Name allocation

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

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

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

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

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

    Return a list of all parents of the components

  77. def postInitCallback(): Component.this.type
    Definition Classes
    Component → PostInitCallback
  78. def postPopEvent(): Unit
    Definition Classes
    Stackable
  79. def postPushEvent(): Unit
    Definition Classes
    Component → Stackable
  80. def prePop(): Unit
  81. def prePopEvent(): Unit
    Definition Classes
    Component → Stackable
  82. var pulledDataCache: Map[Data, Data]

    Reference owner type

  83. val refOwner: RefOwnerType
    Definition Classes
    OwnableRef
    Annotations
    @DontName()
  84. def reflectBaseType(name: String): BaseType
  85. def reflectNames(): Unit
    Definition Classes
    Nameable
  86. def removeTag(spinalTag: SpinalTag): Component.this.type
    Definition Classes
    SpinalTagReady
  87. def removeTags(tags: Iterable[SpinalTag]): Component.this.type
    Definition Classes
    SpinalTagReady
  88. def rework[T](gen: => T): T
  89. val scalaTrace: Throwable
    Definition Classes
    ScalaLocated
  90. val scopeProperties: Capture

    Rework the component

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

    Set the definition name of the component

  98. def setFormalTester(): Unit
  99. def setName(name: String, namePriority: Byte): Component.this.type
    Definition Classes
    Nameable
  100. def setName(name: String, weak: Boolean): Component.this.type
    Definition Classes
    Nameable
  101. def setName(name: String): Component.this.type
    Definition Classes
    Nameable
  102. def setNameAsWeak(): Component.this.type
    Definition Classes
    Nameable
  103. def setPartialName(name: String, namePriority: Byte, owner: Any): Component.this.type
    Definition Classes
    Nameable
  104. def setPartialName(name: String, namePriority: Byte): Component.this.type
    Definition Classes
    Nameable
  105. def setPartialName(name: String, weak: Boolean): Component.this.type
    Definition Classes
    Nameable
  106. def setPartialName(owner: Nameable, name: String, namePriority: Byte): Component.this.type
    Definition Classes
    Nameable
  107. def setPartialName(owner: Nameable, name: String, weak: Boolean): Component.this.type
    Definition Classes
    Nameable
  108. def setPartialName(name: String): Component.this.type
    Definition Classes
    Nameable
  109. def setPartialName(owner: Nameable, name: String): Component.this.type
    Definition Classes
    Nameable
  110. def setRefOwner(that: Any): Unit
    Definition Classes
    OwnableRef
  111. def setScalaLocated(source: ScalaLocated): Component.this.type
    Definition Classes
    ScalaLocated
  112. def setWeakName(name: String): Component.this.type
    Definition Classes
    Nameable
  113. def spinalTags: LinkedHashSet[SpinalTag]
    Definition Classes
    SpinalTagReady
  114. 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()
  115. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  116. def toString(): String
    Definition Classes
    Nameable → AnyRef → Any
  117. def unsetName(): Component.this.type
    Definition Classes
    Nameable
  118. val userCache: Map[Any, Any]

    Used to store arbitrary object related to the component

  119. def valCallback[T](ref: T, name: String): T
    Definition Classes
    ValCallbackRec → ValCallback
  120. def valCallbackOn(ref: Any, name: String, refs: Set[Any]): Unit
    Definition Classes
    ValCallbackRec
  121. def valCallbackRec(ref: Any, name: String): Unit
    Definition Classes
    Component → ValCallbackRec
  122. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  123. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  124. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  125. def walkComponents(body: (Component) => Unit): Unit
  126. def withAutoPull(): Unit
  127. var withHierarchyAutoPull: Boolean
  128. def withKeywords(): Unit
  129. var withVitalOutputs: Boolean
  130. def withoutKeywords(): Unit
  131. 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