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, clockDomain: Handle[ClockDomain]) 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 addPrePopTask(task: () => Unit): ArrayBuffer[PrePopTask]

    Add a new prePopTask

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

    Contains an array of all children Component

  15. val clockDomain: Handle[ClockDomain]

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

  16. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  17. def component: Component
    Definition Classes
    ContextUser
  18. val definition: SpinalTagReady
  19. var definitionName: String

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

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

    Get a set of all IO available in the component

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

    Sort all IO regarding instanceCounter

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

    Name allocation

  60. val name: String
    Attributes
    protected
    Definition Classes
    Nameable
  61. val nameableRef: Nameable
    Attributes
    protected
    Definition Classes
    Nameable
    Annotations
    @DontName()
  62. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  63. def noIoPrefix(): Component.this.type

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

  64. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  65. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  66. def onBody[T](body: => T): T
  67. def onEachAttributes(doIt: (Attribute) => Unit): Unit
    Definition Classes
    SpinalTagReady
  68. def overrideLocalName(name: String): Component.this.type
    Definition Classes
    Nameable
  69. def parent: Component

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

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

    Return a list of all parents of the components

  72. def postInitCallback(): Component.this.type
    Definition Classes
    Component → PostInitCallback
  73. def postPopEvent(): Unit
    Definition Classes
    Stackable
  74. def postPushEvent(): Unit
    Definition Classes
    Component → Stackable
  75. def prePop(): Unit
  76. def prePopEvent(): Unit
    Definition Classes
    Component → Stackable
  77. def propagateIo[T <: Data](childIo: T): T
  78. var pulledDataCache: Map[Data, Data]

    Reference owner type

  79. val refOwner: RefOwnerType
    Definition Classes
    OwnableRef
    Annotations
    @DontName()
  80. def reflectBaseType(name: String): BaseType
  81. def reflectNames(): Unit
    Definition Classes
    Nameable
  82. def removeTag(spinalTag: SpinalTag): Component.this.type
    Definition Classes
    SpinalTagReady
  83. def removeTags(tags: Iterable[SpinalTag]): Component.this.type
    Definition Classes
    SpinalTagReady
  84. def rework[T](gen: => T): T
  85. val scopeProperties: LinkedHashMap[ScopeProperty[Any], Any]

    Rework the component

  86. def setCompositeName(nameable: Nameable, postfix: String, namePriority: Byte): Component.this.type
    Definition Classes
    Nameable
  87. def setCompositeName(nameable: Nameable, postfix: String, weak: Boolean): Component.this.type
    Definition Classes
    Nameable
  88. def setCompositeName(nameable: Nameable, postfix: String): Component.this.type
    Definition Classes
    Nameable
  89. def setCompositeName(nameable: Nameable, namePriority: Byte): Component.this.type
    Definition Classes
    Nameable
  90. def setCompositeName(nameable: Nameable, weak: Boolean): Component.this.type
    Definition Classes
    Nameable
  91. def setCompositeName(nameable: Nameable): Component.this.type
    Definition Classes
    Nameable
  92. def setDefinitionName(name: String): Component.this.type

    Set the definition name of the component

  93. def setName(name: String, namePriority: Byte): Component.this.type
    Definition Classes
    Nameable
  94. def setName(name: String, weak: Boolean): Component.this.type
    Definition Classes
    Nameable
  95. def setName(name: String): Component.this.type
    Definition Classes
    Nameable
  96. def setNameAsWeak(): Component.this.type
    Definition Classes
    Nameable
  97. def setPartialName(name: String, namePriority: Byte): Component.this.type
    Definition Classes
    Nameable
  98. def setPartialName(name: String, weak: Boolean): Component.this.type
    Definition Classes
    Nameable
  99. def setPartialName(owner: Nameable, name: String, namePriority: Byte): Component.this.type
    Definition Classes
    Nameable
  100. def setPartialName(owner: Nameable, name: String, weak: Boolean): Component.this.type
    Definition Classes
    Nameable
  101. def setPartialName(name: String): Component.this.type
    Definition Classes
    Nameable
  102. def setPartialName(owner: Nameable, name: String): Component.this.type
    Definition Classes
    Nameable
  103. def setRefOwner(that: Any): Unit
    Definition Classes
    OwnableRef
  104. def setScalaLocated(source: ScalaLocated): Component.this.type
    Definition Classes
    ScalaLocated
  105. def setWeakName(name: String): Component.this.type
    Definition Classes
    Nameable
  106. def spinalTags: LinkedHashSet[SpinalTag]
    Definition Classes
    SpinalTagReady
  107. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  108. def toString(): String
    Definition Classes
    Nameable → AnyRef → Any
  109. def unsetName(): Component.this.type
    Definition Classes
    Nameable
  110. val userCache: Map[AnyRef, Map[AnyRef, AnyRef]]

    Used to store arbitrary object related to the component

  111. def valCallback[T](ref: T, name: String): T
    Definition Classes
    ValCallbackRec → ValCallback
  112. def valCallbackOn(ref: Any, name: String, refs: Set[Any]): Unit
    Definition Classes
    ValCallbackRec
  113. def valCallbackRec(ref: Any, name: String): Unit
    Definition Classes
    Component → ValCallbackRec
  114. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  115. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  116. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  117. def walkComponents(body: (Component) => Unit): Unit
  118. def withKeywords(): Unit
  119. def withoutKeywords(): Unit
  120. 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