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, 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()

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

    Add a new prePopTask

    Add a new prePopTask

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

    Add the path of the rtl file

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

    Contains an array of all children Component

    Contains an array of all children Component

    Definition Classes
    Component
  15. 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
  16. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  17. def component: Component
    Definition Classes
    ContextUser
  18. 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
  19. def delayedInit(body: ⇒ Unit): Unit

    Initialization class delay

    Initialization class delay

    Definition Classes
    Component → DelayedInit
  20. val dslBody: ScopeStatement
    Definition Classes
    Component
  21. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  23. def existsTag(cond: (SpinalTag) ⇒ Boolean): Boolean
    Definition Classes
    SpinalTagReady
  24. def filterTag(cond: (SpinalTag) ⇒ Boolean): Iterable[SpinalTag]
    Definition Classes
    SpinalTagReady
  25. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  26. def findTag(cond: (SpinalTag) ⇒ Boolean): Option[SpinalTag]
    Definition Classes
    SpinalTagReady
  27. def foreachReflectableNameables(doThat: (Any) ⇒ Unit): Unit
    Definition Classes
    Nameable
  28. val genericElements: ArrayBuffer[(String, Any)]
  29. 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
  30. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  31. def getDisplayName(): String
    Definition Classes
    Component → Nameable
  32. def getGeneric: Generic

    Return the generic of the blackbox

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

    Sort all IO regarding instanceCounter

    Sort all IO regarding instanceCounter

    Definition Classes
    Component
  39. 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
  40. 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
  41. def getRefOwnersChain(): List[Any]
    Definition Classes
    OwnableRef
  42. def getScalaLocationLong: String
    Definition Classes
    ScalaLocated
  43. def getScalaLocationShort: String
    Definition Classes
    ScalaLocated
  44. def getScalaTrace(): Throwable
    Definition Classes
    ScalaLocated
  45. def getTag[T <: SpinalTag](clazz: Class[T]): Option[T]
    Definition Classes
    SpinalTagReady
  46. def getTags(): Set[SpinalTag]
    Definition Classes
    SpinalTagReady
  47. val globalData: GlobalData
    Definition Classes
    GlobalDataUser
  48. def hasTag[T <: SpinalTag](clazz: Class[T]): Boolean
    Definition Classes
    SpinalTagReady
  49. def hasTag(spinalTag: SpinalTag): Boolean
    Definition Classes
    SpinalTagReady
  50. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  51. def instanceAttributes(language: Language): Iterable[Attribute]
    Definition Classes
    SpinalTagReady
  52. def instanceAttributes: Iterable[Attribute]
    Definition Classes
    SpinalTagReady
  53. def isDefaultGenericValue: Boolean
  54. def isEmptyOfTag: Boolean
    Definition Classes
    SpinalTagReady
  55. def isInBlackBoxTree: Boolean
    Definition Classes
    BlackBox → Component
  56. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  57. def isNamed: Boolean
    Definition Classes
    NameableByComponent → Nameable
  58. def isPriorityApplicable(namePriority: Byte): Boolean
    Definition Classes
    Nameable
  59. def isUnnamed: Boolean
    Definition Classes
    Nameable
  60. def isUsingNoNumericType: Boolean

    Return true if the blackbox used the tag noNumericType

  61. def isUsingULogic: Boolean

    Return true if the blackbox used std_ulogic

  62. val librariesUsages: HashSet[String]
  63. val listRTLPath: LinkedHashSet[String]
  64. var localNamingScope: NamingScope

    Name allocation

    Name allocation

    Definition Classes
    Component
  65. def mapClockDomain(clockDomain: ClockDomain = ClockDomain.current, clock: Bool = null, reset: Bool = null, enable: Bool = null): Unit

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

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

    Map clock domains signal to the current ClockDomain

  67. val name: String
    Attributes
    protected
    Definition Classes
    Nameable
  68. def nameElements(): Unit

    Name all Nameable object

    Name all Nameable object

    Definition Classes
    Component
  69. val nameableRef: Nameable
    Attributes
    protected
    Definition Classes
    Nameable
  70. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  71. 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
  72. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  73. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  74. def onEachAttributes(doIt: (Attribute) ⇒ Unit): Unit
    Definition Classes
    SpinalTagReady
  75. 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
  76. val parentScope: ScopeStatement
    Definition Classes
    ContextUser
  77. 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
  78. def postPopEvent(): Unit
    Definition Classes
    Stackable
  79. def postPushEvent(): Unit
    Definition Classes
    Component → Stackable
  80. def prePop(): Unit
    Definition Classes
    Component
  81. def prePopEvent(): Unit
    Definition Classes
    Component → Stackable
  82. var pulledDataCache: Map[Data, Data]

    Reference owner type

    Reference owner type

    Definition Classes
    Component
  83. val refOwner: RefOwnerType
    Definition Classes
    OwnableRef
    Annotations
    @dontName()
  84. def reflectNames(): Unit
    Definition Classes
    Nameable
  85. def removeTag(spinalTag: SpinalTag): BlackBox.this.type
    Definition Classes
    SpinalTagReady
  86. def removeTags(tags: Iterable[SpinalTag]): BlackBox.this.type
    Definition Classes
    SpinalTagReady
  87. def replaceStdLogicByStdULogic(): BlackBox

    Replace std_logic by std_ulogic

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

    Rework the component

    Rework the component

    Definition Classes
    Component
  89. def setBlackBoxName(name: String): BlackBox.this.type

    Set the name of the blackbox

  90. def setCompositeName(nameable: Nameable, postfix: String, namePriority: Byte): BlackBox.this.type
    Definition Classes
    Nameable
  91. def setCompositeName(nameable: Nameable, postfix: String, weak: Boolean): BlackBox.this.type
    Definition Classes
    Nameable
  92. def setCompositeName(nameable: Nameable, postfix: String): BlackBox.this.type
    Definition Classes
    Nameable
  93. def setCompositeName(nameable: Nameable, namePriority: Byte): BlackBox.this.type
    Definition Classes
    Nameable
  94. def setCompositeName(nameable: Nameable, weak: Boolean): BlackBox.this.type
    Definition Classes
    Nameable
  95. def setCompositeName(nameable: Nameable): BlackBox.this.type
    Definition Classes
    Nameable
  96. def setDefinitionName(name: String): BlackBox.this.type

    Set the definition name of the component

    Set the definition name of the component

    Definition Classes
    Component
  97. def setName(name: String, namePriority: Byte): BlackBox.this.type
    Definition Classes
    Nameable
  98. def setName(name: String, weak: Boolean): BlackBox.this.type
    Definition Classes
    Nameable
  99. def setName(name: String): BlackBox.this.type
    Definition Classes
    Nameable
  100. def setPartialName(name: String, namePriority: Byte): BlackBox.this.type
    Definition Classes
    Nameable
  101. def setPartialName(name: String, weak: Boolean): BlackBox.this.type
    Definition Classes
    Nameable
  102. def setPartialName(owner: Nameable, name: String, namePriority: Byte): BlackBox.this.type
    Definition Classes
    Nameable
  103. def setPartialName(owner: Nameable, name: String, weak: Boolean): BlackBox.this.type
    Definition Classes
    Nameable
  104. def setPartialName(name: String): BlackBox.this.type
    Definition Classes
    Nameable
  105. def setPartialName(owner: Nameable, name: String): BlackBox.this.type
    Definition Classes
    Nameable
  106. def setRefOwner(that: Any): Unit
    Definition Classes
    OwnableRef
  107. def setScalaLocated(source: ScalaLocated): BlackBox.this.type
    Definition Classes
    ScalaLocated
  108. def setWeakName(name: String): BlackBox.this.type
    Definition Classes
    Nameable
  109. def spinalTags: Set[SpinalTag]
    Definition Classes
    SpinalTagReady
  110. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  111. def toString(): String
    Definition Classes
    Nameable → AnyRef → Any
  112. def unsetName(): BlackBox.this.type
    Definition Classes
    Nameable
  113. 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
  114. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  115. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  116. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @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