Class

spinal.core

BlackBox

Related Doc: package core

Permalink

abstract class BlackBox extends Component

A blackbox allows the user to integrate an existing VHDL/Verilog component into the design by just specifying the interfaces.

Example:
  1.  class Ram_1w_1r(wordWidth: Int, wordCount: Int) extends BlackBox {
         val generic = new Generic {
             val wordCount = Ram_1w_1r.this.wordCount
             val wordWidth = Ram_1w_1r.this.wordWidth
         }
         val io = new Bundle {
             val clk = in Bool()
             val wr = new Bundle {
                 val en   = in Bool()
                 val addr = in UInt (log2Up(wordCount) bit)
                 val data = in Bits (wordWidth bit)
             }
             val rd = new Bundle {
                 val en   = in Bool()
                 val addr = in UInt (log2Up(wordCount) bit)
                 val data = out Bits (wordWidth bit)
             }
         }
         mapClockDomain(clock=io.clk)
    }
Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BlackBox
  2. Component
  3. ValCallbackRec
  4. ValCallback
  5. OverridedEqualsHashCode
  6. SpinalTagReady
  7. Stackable
  8. PostInitCallback
  9. NameableByComponent
  10. Nameable
  11. ContextUser
  12. ScalaLocated
  13. GlobalDataUser
  14. OwnableRef
  15. AnyRef
  16. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new BlackBox()

    Permalink

Type Members

  1. case class PrePopTask(task: () ⇒ Unit, clockDomain: Handle[ClockDomain]) extends Product with Serializable

    Permalink

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

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

    Definition Classes
    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): BlackBox.this.type

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

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  9. def addGeneric(name: String, that: Any): Unit

    Permalink
  10. def addGenerics(l: (String, Any)*): Unit

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

    Permalink

    Add a new prePopTask

    Add a new prePopTask

    Definition Classes
    Component
  12. def addRTLPath(path: String): LinkedHashSet[String]

    Permalink

    Add the path of the rtl file

  13. def addTag[T <: SpinalTag](spinalTag: T): BlackBox.this.type

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

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

    Permalink
    Definition Classes
    Component
  16. final def asInstanceOf[T0]: T0

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

    Permalink

    Contains an array of all children Component

    Contains an array of all children Component

    Definition Classes
    Component
  18. def clearBlackBox(): Unit

    Permalink
  19. val clockDomain: Handle[ClockDomain]

    Permalink

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

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

    Definition Classes
    Component
  20. def clone(): AnyRef

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

    Permalink
    Definition Classes
    ContextUser
  22. val definition: SpinalTagReady

    Permalink
    Definition Classes
    Component
  23. var definitionName: String

    Permalink

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

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

    Definition Classes
    Component
  24. val dslBody: ScopeStatement

    Permalink
    Definition Classes
    Component
  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. val genericElements: ArrayBuffer[(String, Any)]

    Permalink
  33. def getAllIo: Set[BaseType]

    Permalink

    Get a set of all IO available in the component

    Get a set of all IO available in the component

    Definition Classes
    Component
  34. final def getClass(): Class[_]

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

    Permalink
    Definition Classes
    ComponentNameable
  36. def getGeneric: Generic

    Permalink

    Return the generic of the blackbox

  37. def getGroupedIO(ioBundleBypass: Boolean): Seq[Data]

    Permalink
    Definition Classes
    Component
  38. def getInstanceCounter: Int

    Permalink
    Definition Classes
    ContextUser
  39. def getMode: Byte

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

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

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

    Permalink

    Sort all IO regarding instanceCounter

    Sort all IO regarding instanceCounter

    Definition Classes
    Component
  43. def getParentsPath(sep: String = "/"): String

    Permalink

    Return the path of the parent

    Return the path of the parent

    Definition Classes
    Component
    Example:
    1. toplevel/[myComponent1] // Current component is myComponent2
  44. def getPartialName(): String

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

    Permalink

    Return the path of the component

    Return the path of the component

    Definition Classes
    Component
    Example:
    1. toplevel/[myComponent1]/[myComponent2] // Current component is myComponent2
  46. def getRefOwnersChain(): List[Any]

    Permalink
    Definition Classes
    OwnableRef
  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. val globalData: GlobalData

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

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

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

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  58. def isBlackBox: Boolean

    Permalink
  59. def isCompletelyUnnamed: Boolean

    Permalink
    Definition Classes
    Nameable
  60. def isDefaultGenericValue: Boolean

    Permalink
  61. def isEmptyOfTag: Boolean

    Permalink
    Definition Classes
    SpinalTagReady
  62. def isInBlackBoxTree: Boolean

    Permalink
    Definition Classes
    BlackBoxComponent
  63. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  64. def isLogicLess: Boolean

    Permalink
    Definition Classes
    Component
  65. def isNamed: Boolean

    Permalink
    Definition Classes
    NameableByComponentNameable
  66. def isPriorityApplicable(namePriority: Byte): Boolean

    Permalink
    Definition Classes
    Nameable
  67. var isSpinalSimWb: Boolean

    Permalink
  68. def isUnnamed: Boolean

    Permalink
    Definition Classes
    Nameable
  69. def isUsingNoNumericType: Boolean

    Permalink

    Return true if the blackbox used the tag noNumericType

  70. def isUsingULogic: Boolean

    Permalink

    Return true if the blackbox used std_ulogic

  71. val librariesUsages: HashSet[String]

    Permalink
  72. val listRTLPath: LinkedHashSet[String]

    Permalink
  73. var localNamingScope: NamingScope

    Permalink

    Name allocation

    Name allocation

    Definition Classes
    Component
  74. def mapClockDomain(clockDomain: ClockDomain = ClockDomain.current, clock: Bool = null, reset: Bool = null, enable: Bool = null, resetActiveLevel: Polarity = HIGH, enableActiveLevel: Polarity = HIGH): Unit

    Permalink

    Map clock domain signals (clock, reset, enable) to a clockDomain

  75. def mapCurrentClockDomain(clock: Bool, reset: Bool = null, enable: Bool = null, resetActiveLevel: Polarity = HIGH, enableActiveLevel: Polarity = HIGH): Unit

    Permalink

    Map clock domains signal to the current ClockDomain

  76. var name: String

    Permalink
    Attributes
    protected
    Definition Classes
    Nameable
  77. var nameableRef: Nameable

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

    Permalink
    Definition Classes
    AnyRef
  79. def noIoPrefix(): BlackBox.this.type

    Permalink

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

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

    Definition Classes
    Component
  80. final def notify(): Unit

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

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

    Permalink
    Definition Classes
    Component
  83. def onEachAttributes(doIt: (Attribute) ⇒ Unit): Unit

    Permalink
    Definition Classes
    SpinalTagReady
  84. def overrideLocalName(name: String): BlackBox.this.type

    Permalink
    Definition Classes
    Nameable
  85. def parent: Component

    Permalink

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

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

    Definition Classes
    Component
  86. var parentScope: ScopeStatement

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

    Permalink

    Return a list of all parents of the components

    Return a list of all parents of the components

    Definition Classes
    Component
  88. def postInitCallback(): BlackBox.this.type

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

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

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

    Permalink
    Definition Classes
    Component
  92. def prePopEvent(): Unit

    Permalink
    Definition Classes
    ComponentStackable
  93. def propagateIo[T <: Data](childIo: T): T

    Permalink
    Definition Classes
    Component
  94. var pulledDataCache: Map[Data, Data]

    Permalink

    Reference owner type

    Reference owner type

    Definition Classes
    Component
  95. var refOwner: RefOwnerType

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

    Permalink
    Definition Classes
    Component
  97. def reflectNames(): Unit

    Permalink
    Definition Classes
    Nameable
  98. def removeTag(spinalTag: SpinalTag): BlackBox.this.type

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

    Permalink
    Definition Classes
    SpinalTagReady
  100. def replaceStdLogicByStdULogic(): BlackBox

    Permalink

    Replace std_logic by std_ulogic

  101. def rework[T](gen: ⇒ T): T

    Permalink
    Definition Classes
    Component
  102. val scopeProperties: LinkedHashMap[ScopeProperty[Any], Any]

    Permalink

    Rework the component

    Rework the component

    Definition Classes
    Component
  103. def setBlackBox(): Unit

    Permalink
  104. def setBlackBoxName(name: String): BlackBox.this.type

    Permalink

    Set the name of the blackbox

  105. def setCompositeName(nameable: Nameable, postfix: String, namePriority: Byte): BlackBox.this.type

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

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

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

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

    Permalink
    Definition Classes
    Nameable
  110. def setCompositeName(nameable: Nameable): BlackBox.this.type

    Permalink
    Definition Classes
    Nameable
  111. def setDefinitionName(name: String): BlackBox.this.type

    Permalink

    Set the definition name of the component

    Set the definition name of the component

    Definition Classes
    Component
  112. def setName(name: String, namePriority: Byte): BlackBox.this.type

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

    Permalink
    Definition Classes
    Nameable
  114. def setName(name: String): BlackBox.this.type

    Permalink
    Definition Classes
    Nameable
  115. def setNameAsWeak(): BlackBox.this.type

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

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

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

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

    Permalink
    Definition Classes
    Nameable
  120. def setPartialName(name: String): BlackBox.this.type

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

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

    Permalink
    Definition Classes
    OwnableRef
  123. def setScalaLocated(source: ScalaLocated): BlackBox.this.type

    Permalink
    Definition Classes
    ScalaLocated
  124. def setWeakName(name: String): BlackBox.this.type

    Permalink
    Definition Classes
    Nameable
  125. def spinalSimWhiteBox(): Unit

    Permalink
  126. def spinalTags: LinkedHashSet[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady
  127. final def synchronized[T0](arg0: ⇒ T0): T0

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

    Permalink
    Definition Classes
    Nameable → AnyRef → Any
  129. def unsetName(): BlackBox.this.type

    Permalink
    Definition Classes
    Nameable
  130. val userCache: Map[AnyRef, Map[AnyRef, AnyRef]]

    Permalink

    Used to store arbitrary object related to the component

    Used to store arbitrary object related to the component

    Definition Classes
    Component
  131. def valCallback[T](ref: T, name: String): T

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

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

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

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

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

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

    Permalink
    Definition Classes
    Component
  138. def withKeywords(): Unit

    Permalink
    Definition Classes
    Component
  139. def withoutKeywords(): Unit

    Permalink
    Definition Classes
    Component
  140. var withoutReservedKeywords: Boolean

    Permalink
    Definition Classes
    Component

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 Component

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