Packages

c

spinal.core

BlackBox

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
Component, ValCallbackRec, ValCallback, OverridedEqualsHashCode, SpinalTagReady, Stackable, PostInitCallback, NameableByComponent, Nameable, ContextUser, ScalaLocated, GlobalDataUser, OwnableRef, AnyRef, Any
Known Subclasses
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. 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()

Type Members

  1. abstract type RefOwnerType
    Definition Classes
    OwnableRef
  2. case class PrePopTask(task: () ⇒ Unit, clockDomain: ClockDomain) extends Product with Serializable

    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

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: Set[SpinalTag]
    Definition Classes
    SpinalTagReady
  5. def addAttribute(attribute: Attribute): BlackBox.this.type
    Definition Classes
    Component → SpinalTagReady
  6. def addAttribute(name: String, value: String): BlackBox.this.type
    Definition Classes
    SpinalTagReady
  7. def addAttribute(name: String): BlackBox.this.type
    Definition Classes
    SpinalTagReady
  8. def addGeneric(name: String, that: Any): Unit
  9. def addGenerics(l: (String, Any)*): Unit
  10. def addPrePopTask(task: () ⇒ Unit): ArrayBuffer[PrePopTask]

    Add a new prePopTask

    Add a new prePopTask

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

    Add the path of the rtl file

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

    Contains an array of all children Component

    Contains an array of all children Component

    Definition Classes
    Component
  17. def clearBlackBox(): Unit
  18. val clockDomain: ClockDomain

    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
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  20. def component: Component
    Definition Classes
    ContextUser
  21. var definitionName: String

    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
    Definition Classes
    Component
  23. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. def equals(obj: Any): Boolean
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  25. def existsTag(cond: (SpinalTag) ⇒ Boolean): Boolean
    Definition Classes
    SpinalTagReady
  26. def filterTag(cond: (SpinalTag) ⇒ Boolean): Iterable[SpinalTag]
    Definition Classes
    SpinalTagReady
  27. def findTag(cond: (SpinalTag) ⇒ Boolean): Option[SpinalTag]
    Definition Classes
    SpinalTagReady
  28. def foreachReflectableNameables(doThat: (Any) ⇒ Unit): Unit
    Definition Classes
    Nameable
  29. def foreachTag(body: (SpinalTag) ⇒ Unit): Unit
    Definition Classes
    SpinalTagReady
  30. val genericElements: ArrayBuffer[(String, Any)]
  31. def getAllIo: Set[BaseType]

    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[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  33. def getDisplayName(): String
    Definition Classes
    Component → Nameable
  34. def getGeneric: Generic

    Return the generic of the blackbox

  35. def getGroupedIO(ioBundleBypass: Boolean): Seq[Data]
    Definition Classes
    Component
  36. def getInstanceCounter: Int
    Definition Classes
    ContextUser
  37. def getMode: Byte
    Attributes
    protected
    Definition Classes
    Nameable
  38. def getName(default: String): String
    Definition Classes
    NameableByComponent → Nameable
  39. def getName(): String
    Definition Classes
    Nameable
  40. def getOrdredNodeIo: List[BaseType]

    Sort all IO regarding instanceCounter

    Sort all IO regarding instanceCounter

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

    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
    Definition Classes
    Nameable
  43. def getPath(sep: String = "/"): String

    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]
    Definition Classes
    OwnableRef
  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(): Set[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 isBlackBox: Boolean
  57. def isDefaultGenericValue: Boolean
  58. def isEmptyOfTag: Boolean
    Definition Classes
    SpinalTagReady
  59. def isInBlackBoxTree: Boolean
    Definition Classes
    BlackBox → Component
  60. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  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. def isUsingNoNumericType: Boolean

    Return true if the blackbox used the tag noNumericType

  65. def isUsingULogic: Boolean

    Return true if the blackbox used std_ulogic

  66. val librariesUsages: HashSet[String]
  67. val listRTLPath: LinkedHashSet[String]
  68. var localNamingScope: NamingScope

    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

    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

    Map clock domains signal to the current ClockDomain

  71. val name: String
    Attributes
    protected
    Definition Classes
    Nameable
  72. val nameableRef: Nameable
    Attributes
    protected
    Definition Classes
    Nameable
    Annotations
    @DontName()
  73. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  74. def noIoPrefix(): BlackBox.this.type

    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
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  76. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  77. def onEachAttributes(doIt: (Attribute) ⇒ Unit): Unit
    Definition Classes
    SpinalTagReady
  78. def parent: Component

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

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

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

    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
    Definition Classes
    Component → PostInitCallback
  82. def postPopEvent(): Unit
    Definition Classes
    Stackable
  83. def postPushEvent(): Unit
    Definition Classes
    Component → Stackable
  84. def prePop(): Unit
    Definition Classes
    Component
  85. def prePopEvent(): Unit
    Definition Classes
    Component → Stackable
  86. var pulledDataCache: Map[Data, Data]

    Reference owner type

    Reference owner type

    Definition Classes
    Component
  87. val refOwner: RefOwnerType
    Definition Classes
    OwnableRef
    Annotations
    @DontName()
  88. def reflectBaseType(name: String): BaseType
    Definition Classes
    Component
  89. def reflectNames(): Unit
    Definition Classes
    Nameable
  90. def removeTag(spinalTag: SpinalTag): BlackBox.this.type
    Definition Classes
    SpinalTagReady
  91. def removeTags(tags: Iterable[SpinalTag]): BlackBox.this.type
    Definition Classes
    SpinalTagReady
  92. def replaceStdLogicByStdULogic(): BlackBox

    Replace std_logic by std_ulogic

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

    Rework the component

    Rework the component

    Definition Classes
    Component
  94. def setBlackBox(): Unit
  95. def setBlackBoxName(name: String): BlackBox.this.type

    Set the name of the blackbox

  96. def setCompositeName(nameable: Nameable, postfix: String, namePriority: Byte): BlackBox.this.type
    Definition Classes
    Nameable
  97. def setCompositeName(nameable: Nameable, postfix: String, weak: Boolean): BlackBox.this.type
    Definition Classes
    Nameable
  98. def setCompositeName(nameable: Nameable, postfix: String): BlackBox.this.type
    Definition Classes
    Nameable
  99. def setCompositeName(nameable: Nameable, namePriority: Byte): BlackBox.this.type
    Definition Classes
    Nameable
  100. def setCompositeName(nameable: Nameable, weak: Boolean): BlackBox.this.type
    Definition Classes
    Nameable
  101. def setCompositeName(nameable: Nameable): BlackBox.this.type
    Definition Classes
    Nameable
  102. def setDefinitionName(name: String): BlackBox.this.type

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

    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
    Definition Classes
    ValCallbackRec → ValCallback
  121. def valCallbackOn(ref: Any, name: String, refs: Set[Any]): Unit
    Definition Classes
    ValCallbackRec
  122. def valCallbackRec(ref: Any, name: String): Unit
    Definition Classes
    Component → ValCallbackRec
  123. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  124. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  125. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated @deprecated
    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