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: 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: Set[SpinalTag]

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

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

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

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

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

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

    Permalink

    Add a new prePopTask

    Add a new prePopTask

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

    Permalink

    Add the path of the rtl file

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

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

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

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

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

    Permalink

    Contains an array of all children Component

    Contains an array of all children Component

    Definition Classes
    Component
  17. def clearBlackBox(): Unit

    Permalink
  18. val clockDomain: 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
  19. def clone(): AnyRef

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

    Permalink
    Definition Classes
    ContextUser
  21. 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
  22. val dslBody: ScopeStatement

    Permalink
    Definition Classes
    Component
  23. final def eq(arg0: AnyRef): Boolean

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

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

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

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

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  30. val genericElements: ArrayBuffer[(String, Any)]

    Permalink
  31. 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
  32. final def getClass(): Class[_]

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

    Permalink
    Definition Classes
    ComponentNameable
  34. def getGeneric: Generic

    Permalink

    Return the generic of the blackbox

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

    Permalink
    Definition Classes
    Component
  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
    Nameable
  40. def getOrdredNodeIo: List[BaseType]

    Permalink

    Sort all IO regarding instanceCounter

    Sort all IO regarding instanceCounter

    Definition Classes
    Component
  41. 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
  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

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

    Permalink
    Definition Classes
    OwnableRef
  45. def getScalaLocationLong: String

    Permalink
    Definition Classes
    ScalaLocated
  46. def getScalaLocationShort: String

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  49. def getTags(): Set[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady
  50. val globalData: GlobalData

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

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

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

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  56. def isBlackBox: Boolean

    Permalink
  57. def isDefaultGenericValue: Boolean

    Permalink
  58. def isEmptyOfTag: Boolean

    Permalink
    Definition Classes
    SpinalTagReady
  59. def isInBlackBoxTree: Boolean

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

    Permalink
    Definition Classes
    Any
  61. def isNamed: Boolean

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

    Permalink
    Definition Classes
    Nameable
  63. def isUnnamed: Boolean

    Permalink
    Definition Classes
    Nameable
  64. def isUsingNoNumericType: Boolean

    Permalink

    Return true if the blackbox used the tag noNumericType

  65. def isUsingULogic: Boolean

    Permalink

    Return true if the blackbox used std_ulogic

  66. val librariesUsages: HashSet[String]

    Permalink
  67. val listRTLPath: LinkedHashSet[String]

    Permalink
  68. var localNamingScope: NamingScope

    Permalink

    Name allocation

    Name allocation

    Definition Classes
    Component
  69. 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

  70. 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

  71. var name: String

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

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

    Permalink
    Definition Classes
    AnyRef
  74. 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
  75. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  77. def onEachAttributes(doIt: (Attribute) ⇒ Unit): Unit

    Permalink
    Definition Classes
    SpinalTagReady
  78. 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
  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

    Return a list of all parents of the components

    Definition Classes
    Component
  81. def postInitCallback(): BlackBox.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
    Definition Classes
    Component
  85. def prePopEvent(): Unit

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

    Permalink

    Reference owner type

    Reference owner type

    Definition Classes
    Component
  87. var refOwner: RefOwnerType

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

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

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

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

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

    Permalink

    Replace std_logic by std_ulogic

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

    Permalink

    Rework the component

    Rework the component

    Definition Classes
    Component
  94. def setBlackBox(): Unit

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

    Permalink

    Set the name of the blackbox

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

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

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

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

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

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

    Permalink
    Definition Classes
    Nameable
  102. 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
  103. def setName(name: String, namePriority: Byte): BlackBox.this.type

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    Nameable
  115. def spinalTags: Set[SpinalTag]

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

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

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

    Permalink
    Definition Classes
    Nameable
  119. 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
  120. def valCallback[T](ref: T, name: String): T

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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