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, sld_virtual_jtag, EG_LOGIC_BUFG, EG_LOGIC_ODDR, EG_PHY_BRAM, EG_PHY_BRAM32K, EG_PHY_SDRAM_2M_32, BB, DCCA, EHXPLLL, IDDRX1F, IFS1P3BX, JTAGG, ODDRX1F, OFS1P3BX, TSFF, Ulx3sUsrMclk, ICE40_PLL, SB_DFFR, SB_DFFS, SB_GB, SB_IO, SB_PLL40_CORE, SB_PLL40_PAD, SB_SPRAM256KA, BSCANE2, BUFG, BUFGCE, BUFIO, FDRE, IBUF, IBUFG, IDELAYCTRL, IDELAYE2, IOBUF, IOBUFDS, ISERDESE2, MMCME2_BASE, OBUFDS, ODELAYE2, OSERDESE2, PLLE2_BASE, STARTUPE2, alt_inbuf, alt_inbuf_diff, alt_outbuf, alt_outbuf_diff, alt_outbuf_tri, alt_outbuf_tri_diff, mt41k128m16jt_model, mt48lc16m16a2_model, PLLE2_ADV
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) 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: LinkedHashSet[SpinalTag]
    Definition Classes
    SpinalTagReady
  5. def addAttribute(attribute: Attribute): BlackBox.this.type
    Definition Classes
    Component → SpinalTagReady
  6. def addAttribute(name: String, value: Int): BlackBox.this.type
    Definition Classes
    SpinalTagReady
  7. def addAttribute(name: String, value: String): BlackBox.this.type
    Definition Classes
    SpinalTagReady
  8. def addAttribute(name: String): BlackBox.this.type
    Definition Classes
    SpinalTagReady
  9. def addComment(str: String): Component
    Definition Classes
    Component
  10. def addGeneric(name: String, that: Any): Unit
  11. def addGenerics(l: (String, Any)*): Unit
  12. def addPrePopTask(task: () ⇒ Unit): ArrayBuffer[PrePopTask]

    Add a new prePopTask

    Add a new prePopTask

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

    Add the path of the rtl file

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

    Contains an array of all children Component

    Contains an array of all children Component

    Definition Classes
    Component
  20. def clearBlackBox(): Unit
  21. val clockDomain: Handle[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
  22. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  23. def component: Component
    Definition Classes
    ContextUser
  24. val definition: $anon forSome {type $anon <: SpinalTagReady { def addComment(str: String): $anon }}
    Definition Classes
    Component
  25. 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
  26. var definitionNameNoMerge: Boolean
    Definition Classes
    Component
  27. val dslBody: ScopeStatement
    Definition Classes
    Component
  28. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  29. def equals(obj: Any): Boolean
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  30. def existsTag(cond: (SpinalTag) ⇒ Boolean): Boolean
    Definition Classes
    SpinalTagReady
  31. def filterTag(cond: (SpinalTag) ⇒ Boolean): Iterable[SpinalTag]
    Definition Classes
    SpinalTagReady
  32. def findTag(cond: (SpinalTag) ⇒ Boolean): Option[SpinalTag]
    Definition Classes
    SpinalTagReady
  33. def foreachReflectableNameables(doThat: (Any) ⇒ Unit): Unit
    Definition Classes
    Nameable
  34. def foreachTag(body: (SpinalTag) ⇒ Unit): Unit
    Definition Classes
    SpinalTagReady
  35. val genericElements: ArrayBuffer[(String, Any)]
  36. 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
  37. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  38. def getDisplayName(): String
    Definition Classes
    Component → Nameable
  39. def getGeneric: Generic

    Return the generic of the blackbox

  40. def getGroupedIO(ioBundleBypass: Boolean): Seq[Data]
    Definition Classes
    Component
  41. def getInstanceCounter: Int
    Definition Classes
    ContextUser
  42. def getMode: Byte
    Attributes
    protected
    Definition Classes
    Nameable
  43. def getName(default: String): String
    Definition Classes
    NameableByComponent → Nameable
  44. def getName(): String
    Definition Classes
    NameableByComponent → Nameable
  45. def getOrdredNodeIo: List[BaseType]

    Sort all IO regarding instanceCounter

    Sort all IO regarding instanceCounter

    Definition Classes
    Component
  46. 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
  47. def getPartialName(): String
    Definition Classes
    Nameable
  48. 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
  49. def getPath(from: Component, to: Component): Seq[Component]
    Definition Classes
    NameableByComponent
  50. def getRefOwnersChain(): List[Any]
    Definition Classes
    OwnableRef
  51. def getRtlPath(separator: String = "/"): String
    Definition Classes
    Component
  52. def getScalaLocationLong: String
    Definition Classes
    ScalaLocated
  53. def getScalaLocationShort: String
    Definition Classes
    ScalaLocated
  54. def getScalaTrace(): Throwable
    Definition Classes
    ScalaLocated
  55. def getTag[T <: SpinalTag](clazz: Class[T]): Option[T]
    Definition Classes
    SpinalTagReady
  56. def getTags(): LinkedHashSet[SpinalTag]
    Definition Classes
    SpinalTagReady
  57. val globalData: GlobalData
    Definition Classes
    GlobalDataUser
  58. def hasTag[T <: SpinalTag](clazz: Class[T]): Boolean
    Definition Classes
    SpinalTagReady
  59. def hasTag(spinalTag: SpinalTag): Boolean
    Definition Classes
    SpinalTagReady
  60. def hashCode(): Int
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  61. var impl: BlackBoxImpl
  62. def instanceAttributes(language: Language): Iterable[Attribute]
    Definition Classes
    SpinalTagReady
  63. def instanceAttributes: Iterable[Attribute]
    Definition Classes
    SpinalTagReady
  64. def isBlackBox: Boolean
  65. def isCompletelyUnnamed: Boolean
    Definition Classes
    Nameable
  66. def isDefaultGenericValue: Boolean
  67. def isEmptyOfTag: Boolean
    Definition Classes
    SpinalTagReady
  68. var isFormalTester: Boolean
    Definition Classes
    Component
  69. def isInBlackBoxTree: Boolean
    Definition Classes
    BlackBox → Component
  70. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  71. def isLogicLess: Boolean
    Definition Classes
    Component
  72. def isNamed: Boolean
    Definition Classes
    NameableByComponent → Nameable
  73. def isPriorityApplicable(namePriority: Byte): Boolean
    Definition Classes
    Nameable
  74. var isSpinalSimWb: Boolean
  75. def isUnnamed: Boolean
    Definition Classes
    Nameable
  76. def isUsingNoNumericType: Boolean

    Return true if the blackbox used the tag noNumericType

  77. def isUsingULogic: Boolean

    Return true if the blackbox used std_ulogic

  78. val librariesUsages: HashSet[String]
  79. val listRTLPath: LinkedHashSet[String]
  80. var localNamingScope: NamingScope

    Name allocation

    Name allocation

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

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

  83. val name: String
    Definition Classes
    Nameable
  84. val nameableRef: Nameable
    Attributes
    protected
    Definition Classes
    Nameable
    Annotations
    @DontName()
  85. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  86. 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
  87. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  88. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  89. def onBody[T](body: ⇒ T): T
    Definition Classes
    Component
  90. def onEachAttributes(doIt: (Attribute) ⇒ Unit): Unit
    Definition Classes
    SpinalTagReady
  91. def overrideLocalName(name: String): BlackBox.this.type
    Definition Classes
    Nameable
  92. 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
  93. val parentScope: ScopeStatement
    Definition Classes
    ContextUser
  94. 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
  95. def postInitCallback(): BlackBox.this.type
    Definition Classes
    Component → PostInitCallback
  96. def postPopEvent(): Unit
    Definition Classes
    Stackable
  97. def postPushEvent(): Unit
    Definition Classes
    Component → Stackable
  98. def prePop(): Unit
    Definition Classes
    Component
  99. def prePopEvent(): Unit
    Definition Classes
    Component → Stackable
  100. var pulledDataCache: Map[Data, Data]
    Definition Classes
    Component
  101. val refOwner: RefOwnerType
    Definition Classes
    OwnableRef
    Annotations
    @DontName()
  102. def reflectBaseType(name: String): BaseType
    Definition Classes
    Component
  103. def reflectNames(): Unit
    Definition Classes
    Nameable
  104. def removeTag(spinalTag: SpinalTag): BlackBox.this.type
    Definition Classes
    SpinalTagReady
  105. def removeTags(tags: Iterable[SpinalTag]): BlackBox.this.type
    Definition Classes
    SpinalTagReady
  106. def replaceStdLogicByStdULogic(): BlackBox

    Replace std_logic by std_ulogic

  107. def rework[T](gen: ⇒ T): T
    Definition Classes
    Component
  108. val scalaTrace: Throwable
    Definition Classes
    ScalaLocated
  109. val scopeProperties: Capture

    Rework the component

    Rework the component

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

    Set the name of the blackbox

  112. def setCompositeName(nameable: Nameable, postfix: String, namePriority: Byte): BlackBox.this.type
    Definition Classes
    Nameable
  113. def setCompositeName(nameable: Nameable, postfix: String, weak: Boolean): BlackBox.this.type
    Definition Classes
    Nameable
  114. def setCompositeName(nameable: Nameable, postfix: String): BlackBox.this.type
    Definition Classes
    Nameable
  115. def setCompositeName(nameable: Nameable, namePriority: Byte): BlackBox.this.type
    Definition Classes
    Nameable
  116. def setCompositeName(nameable: Nameable, weak: Boolean): BlackBox.this.type
    Definition Classes
    Nameable
  117. def setCompositeName(nameable: Nameable): BlackBox.this.type
    Definition Classes
    Nameable
  118. def setDefinitionName(name: String, noMerge: Boolean = true): BlackBox.this.type

    Set the definition name of the component

    Set the definition name of the component

    Definition Classes
    Component
  119. def setFormalTester(): Unit
    Definition Classes
    Component
  120. def setInline(impl: BlackBoxImpl): Unit
  121. def setInlineVerilog(str: String): Unit
  122. def setInlineVhdl(str: String): Unit
  123. def setIoCd(cd: ClockDomain = this.clockDomain): Unit
  124. def setLambdaName(isNameBody: ⇒ Boolean)(nameGen: ⇒ String): BlackBox.this.type
    Definition Classes
    Nameable
  125. def setName(name: String, namePriority: Byte): BlackBox.this.type
    Definition Classes
    Nameable
  126. def setName(name: String, weak: Boolean): BlackBox.this.type
    Definition Classes
    Nameable
  127. def setName(name: String): BlackBox.this.type
    Definition Classes
    Nameable
  128. def setNameAsWeak(): BlackBox.this.type
    Definition Classes
    Nameable
  129. def setPartialName(name: String, namePriority: Byte, owner: Any): BlackBox.this.type
    Definition Classes
    Nameable
  130. def setPartialName(name: String, namePriority: Byte): BlackBox.this.type
    Definition Classes
    Nameable
  131. def setPartialName(name: String, weak: Boolean): BlackBox.this.type
    Definition Classes
    Nameable
  132. def setPartialName(owner: Nameable, name: String, namePriority: Byte): BlackBox.this.type
    Definition Classes
    Nameable
  133. def setPartialName(owner: Nameable, name: String, weak: Boolean): BlackBox.this.type
    Definition Classes
    Nameable
  134. def setPartialName(name: String): BlackBox.this.type
    Definition Classes
    Nameable
  135. def setPartialName(owner: Nameable, name: String): BlackBox.this.type
    Definition Classes
    Nameable
  136. def setPartialName(owner: Nameable): BlackBox.this.type
    Definition Classes
    Nameable
  137. def setRefOwner(that: Any): Unit
    Definition Classes
    OwnableRef
  138. def setScalaLocated(source: ScalaLocated): BlackBox.this.type
    Definition Classes
    ScalaLocated
  139. def setWeakName(name: String): BlackBox.this.type
    Definition Classes
    Nameable
  140. def spinalSimWhiteBox(): Unit
  141. def spinalTags: LinkedHashSet[SpinalTag]
    Definition Classes
    SpinalTagReady
  142. def stub(): BlackBox.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

    Definition Classes
    Component
    Example: 

    1. val dut = (new MyComponent).stub()
  143. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  144. def toString(): String
    Definition Classes
    Nameable → AnyRef → Any
  145. def traceDisable(recursive: Boolean = true): BlackBox.this.type
    Definition Classes
    Component
  146. def traceEnable(recursive: Boolean = true): BlackBox.this.type
    Definition Classes
    Component
  147. var traceEnabled: Boolean
    Definition Classes
    Component
  148. def unsetName(): BlackBox.this.type
    Definition Classes
    Nameable
  149. val userCache: Map[Any, Any]

    Used to store arbitrary object related to the component

    Used to store arbitrary object related to the component

    Definition Classes
    Component
  150. def valCallback[T](ref: T, name: String): T
    Definition Classes
    ValCallbackRec → ValCallback
  151. def valCallbackOn(ref: Any, name: String, refs: Set[Any]): Unit
    Definition Classes
    ValCallbackRec
  152. def valCallbackRec(ref: Any, name: String): Unit
    Definition Classes
    Component → ValCallbackRec
  153. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  154. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  155. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  156. def walkComponents(body: (Component) ⇒ Unit): Unit
    Definition Classes
    Component
  157. def withAutoPull(): Unit
    Definition Classes
    Component
  158. var withHierarchyAutoPull: Boolean
    Definition Classes
    Component
  159. def withKeywords(): Unit
    Definition Classes
    Component
  160. var withVitalOutputs: Boolean
    Definition Classes
    Component
  161. def withoutKeywords(): Unit
    Definition Classes
    Component
  162. var withoutReservedKeywords: Boolean
    Definition Classes
    Component

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

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