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
Component, SpinalTagReady, Stackable, DelayedInit, 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. SpinalTagReady
  4. Stackable
  5. DelayedInit
  6. NameableByComponent
  7. Nameable
  8. ContextUser
  9. ScalaLocated
  10. GlobalDataUser
  11. OwnableRef
  12. AnyRef
  13. 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
    Component → SpinalTagReady

  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 addPrePopTask(task: () ⇒ Unit): ArrayBuffer[PrePopTask]

    Permalink

    Add a new prePopTask

    Add a new prePopTask

    Definition Classes
    Component

  10. def addRTLPath(path: String): LinkedHashSet[String]

    Permalink

    Add the path of the rtl file

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

    Permalink
    Definition Classes
    SpinalTagReady

  12. def addTags[T <: SpinalTag](tags: Iterable[T]): BlackBox.this.type

    Permalink
    Definition Classes
    SpinalTagReady

  13. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  14. val children: ArrayBuffer[Component]

    Permalink

    Contains an array of all children Component

    Contains an array of all children Component

    Definition Classes
    Component

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

  16. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  17. def component: Component

    Permalink
    Definition Classes
    ContextUser

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

  19. def delayedInit(body: ⇒ Unit): Unit

    Permalink

    Initialization class delay

    Initialization class delay

    Definition Classes
    Component → DelayedInit

  20. val dslBody: ScopeStatement

    Permalink
    Definition Classes
    Component

  21. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  22. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  23. def existsTag(cond: (SpinalTag) ⇒ Boolean): Boolean

    Permalink
    Definition Classes
    SpinalTagReady

  24. def filterTag(cond: (SpinalTag) ⇒ Boolean): Iterable[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady

  25. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  26. def findTag(cond: (SpinalTag) ⇒ Boolean): Option[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady

  27. def foreachReflectableNameables(doThat: (Any) ⇒ Unit): Unit

    Permalink
    Definition Classes
    Nameable

  28. val genericElements: ArrayBuffer[(String, Any)]

    Permalink

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

  30. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  31. def getDisplayName(): String

    Permalink
    Definition Classes
    Component → Nameable

  32. def getGeneric: Generic

    Permalink

    Return the generic of the blackbox

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

    Permalink
    Definition Classes
    Component

  34. def getInstanceCounter: Int

    Permalink
    Definition Classes
    ContextUser

  35. def getMode: Byte

    Permalink
    Attributes
    protected
    Definition Classes
    Nameable

  36. def getName(default: String): String

    Permalink
    Definition Classes
    NameableByComponent → Nameable

  37. def getName(): String

    Permalink
    Definition Classes
    Nameable

  38. def getOrdredNodeIo: List[BaseType]

    Permalink

    Sort all IO regarding instanceCounter

    Sort all IO regarding instanceCounter

    Definition Classes
    Component

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

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

  41. def getRefOwnersChain(): List[Any]

    Permalink
    Definition Classes
    OwnableRef

  42. def getScalaLocationLong: String

    Permalink
    Definition Classes
    ScalaLocated

  43. def getScalaLocationShort: String

    Permalink
    Definition Classes
    ScalaLocated

  44. def getScalaTrace(): Throwable

    Permalink
    Definition Classes
    ScalaLocated

  45. def getTag[T <: SpinalTag](clazz: Class[T]): Option[T]

    Permalink
    Definition Classes
    SpinalTagReady

  46. def getTags(): Set[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady

  47. val globalData: GlobalData

    Permalink
    Definition Classes
    GlobalDataUser

  48. def hasTag[T <: SpinalTag](clazz: Class[T]): Boolean

    Permalink
    Definition Classes
    SpinalTagReady

  49. def hasTag(spinalTag: SpinalTag): Boolean

    Permalink
    Definition Classes
    SpinalTagReady

  50. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  51. def instanceAttributes(language: Language): Iterable[Attribute]

    Permalink
    Definition Classes
    SpinalTagReady

  52. def instanceAttributes: Iterable[Attribute]

    Permalink
    Definition Classes
    SpinalTagReady

  53. def isEmptyOfTag: Boolean

    Permalink
    Definition Classes
    SpinalTagReady

  54. def isInBlackBoxTree: Boolean

    Permalink
    Definition Classes
    BlackBox → Component

  55. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  56. def isNamed: Boolean

    Permalink
    Definition Classes
    NameableByComponent → Nameable

  57. def isPriorityApplicable(namePriority: Byte): Boolean

    Permalink
    Definition Classes
    Nameable

  58. def isUnnamed: Boolean

    Permalink
    Definition Classes
    Nameable

  59. def isUsingNoNumericType: Boolean

    Permalink

    Return true if the blackbox used the tag noNumericType

  60. def isUsingULogic: Boolean

    Permalink

    Return true if the blackbox used std_ulogic

  61. val librariesUsages: HashSet[String]

    Permalink

  62. val listRTLPath: LinkedHashSet[String]

    Permalink

  63. var localNamingScope: NamingScope

    Permalink

    Name allocation

    Name allocation

    Definition Classes
    Component

  64. def mapClockDomain(clockDomain: ClockDomain = ClockDomain.current, clock: Bool = null, reset: Bool = null, enable: Bool = null): Unit

    Permalink

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

  65. def mapCurrentClockDomain(clock: Bool, reset: Bool = null, enable: Bool = null): Unit

    Permalink

    Map clock domains signal to the current ClockDomain

  66. var name: String

    Permalink
    Attributes
    protected
    Definition Classes
    Nameable

  67. def nameElements(): Unit

    Permalink

    Name all Nameable object

    Name all Nameable object

    Definition Classes
    Component

  68. var nameableRef: Nameable

    Permalink
    Attributes
    protected
    Definition Classes
    Nameable

  69. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

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

  71. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  72. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  73. def onEachAttributes(doIt: (Attribute) ⇒ Unit): Unit

    Permalink
    Definition Classes
    SpinalTagReady

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

  75. var parentScope: ScopeStatement

    Permalink
    Definition Classes
    ContextUser

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

  77. def postPopEvent(): Unit

    Permalink
    Definition Classes
    Stackable

  78. def postPushEvent(): Unit

    Permalink
    Definition Classes
    Component → Stackable

  79. def prePop(): Unit

    Permalink
    Definition Classes
    Component

  80. def prePopEvent(): Unit

    Permalink
    Definition Classes
    Component → Stackable

  81. var pulledDataCache: Map[Data, Data]

    Permalink

    Reference owner type

    Reference owner type

    Definition Classes
    Component

  82. var refOwner: RefOwnerType

    Permalink
    Definition Classes
    OwnableRef

  83. def removeTag(spinalTag: SpinalTag): BlackBox.this.type

    Permalink
    Definition Classes
    SpinalTagReady

  84. def removeTags(tags: Iterable[SpinalTag]): BlackBox.this.type

    Permalink
    Definition Classes
    SpinalTagReady

  85. def replaceStdLogicByStdULogic(): BlackBox

    Permalink

    Replace std_logic by std_ulogic

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

    Permalink

    Rework the component

    Rework the component

    Definition Classes
    Component

  87. def setBlackBoxName(name: String): BlackBox.this.type

    Permalink

    Set the name of the blackbox

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

    Permalink
    Definition Classes
    Nameable

  89. def setCompositeName(nameable: Nameable, postfix: String, weak: Boolean): BlackBox.this.type

    Permalink
    Definition Classes
    Nameable

  90. def setCompositeName(nameable: Nameable, postfix: String): BlackBox.this.type

    Permalink
    Definition Classes
    Nameable

  91. def setCompositeName(nameable: Nameable, namePriority: Byte): BlackBox.this.type

    Permalink
    Definition Classes
    Nameable

  92. def setCompositeName(nameable: Nameable, weak: Boolean): BlackBox.this.type

    Permalink
    Definition Classes
    Nameable

  93. def setCompositeName(nameable: Nameable): BlackBox.this.type

    Permalink
    Definition Classes
    Nameable

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

  95. def setName(name: String, namePriority: Byte): BlackBox.this.type

    Permalink
    Definition Classes
    Nameable

  96. def setName(name: String, weak: Boolean): BlackBox.this.type

    Permalink
    Definition Classes
    Nameable

  97. def setName(name: String): BlackBox.this.type

    Permalink
    Definition Classes
    Nameable

  98. def setPartialName(name: String, namePriority: Byte): BlackBox.this.type

    Permalink
    Definition Classes
    Nameable

  99. def setPartialName(name: String, weak: Boolean): BlackBox.this.type

    Permalink
    Definition Classes
    Nameable

  100. def setPartialName(owner: Nameable, name: String, namePriority: Byte): BlackBox.this.type

    Permalink
    Definition Classes
    Nameable

  101. def setPartialName(owner: Nameable, name: String, weak: Boolean): BlackBox.this.type

    Permalink
    Definition Classes
    Nameable

  102. def setPartialName(name: String): BlackBox.this.type

    Permalink
    Definition Classes
    Nameable

  103. def setPartialName(owner: Nameable, name: String): BlackBox.this.type

    Permalink
    Definition Classes
    Nameable

  104. def setRefOwner(that: Any): Unit

    Permalink
    Definition Classes
    OwnableRef

  105. def setScalaLocated(source: ScalaLocated): BlackBox.this.type

    Permalink
    Definition Classes
    ScalaLocated

  106. def setWeakName(name: String): BlackBox.this.type

    Permalink
    Definition Classes
    Nameable

  107. def spinalTags: Set[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady

  108. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  109. def toString(): String

    Permalink
    Definition Classes
    Nameable → AnyRef → Any

  110. def unsetName(): BlackBox.this.type

    Permalink
    Definition Classes
    Nameable

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

  112. final def wait(): Unit

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

  113. final def wait(arg0: Long, arg1: Int): Unit

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

  114. final def wait(arg0: Long): Unit

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

Inherited from Component

Inherited from SpinalTagReady

Inherited from Stackable

Inherited from DelayedInit

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