spinal.core

BlackBox

Related Doc: package core

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, ScalaLocated, NameableByComponent, Nameable, ContextUser, 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. ScalaLocated
  7. NameableByComponent
  8. Nameable
  9. ContextUser
  10. GlobalDataUser
  11. OwnableRef
  12. AnyRef
  13. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new BlackBox()

Type Members

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

  2. type RefOwnerType = Component

    Reference owner type

    Reference owner type

    Definition Classes
    Component → OwnableRef

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

    Add a new prePopTask

    Add a new prePopTask

    Definition Classes
    Component

  9. def addTag(spinalTag: SpinalTag): BlackBox.this.type

    Definition Classes
    SpinalTagReady

  10. def addTags(tags: Iterable[SpinalTag]): BlackBox.this.type

    Definition Classes
    SpinalTagReady

  11. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  12. val children: ArrayBuffer[Component]

    Contains an array of all children Component

    Contains an array of all children Component

    Definition Classes
    Component

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

  14. def clone(): AnyRef

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

  15. def component: Component

    Definition Classes
    ContextUser

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

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

    Initialization class delay

    Initialization class delay

    Definition Classes
    Component → DelayedInit

  18. val dslBody: ScopeStatement

    Definition Classes
    Component

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

    Definition Classes
    AnyRef

  20. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

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

    Definition Classes
    SpinalTagReady

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

    Definition Classes
    SpinalTagReady

  23. def finalize(): Unit

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

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

    Definition Classes
    SpinalTagReady

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

    Definition Classes
    Nameable

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

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

    Definition Classes
    AnyRef → Any

  28. def getDisplayName(): String

    Definition Classes
    Component → Nameable

  29. def getGeneric: Generic

    Return the generic of the blackbox

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

    Definition Classes
    Component

  31. def getInstanceCounter: Int

    Definition Classes
    ContextUser

  32. def getName(): String

    Definition Classes
    NameableByComponent → Nameable

  33. def getName(default: String): String

    Definition Classes
    Nameable

  34. def getOrdredNodeIo: List[BaseType]

    Sort all IO regarding instanceCounter

    Sort all IO regarding instanceCounter

    Definition Classes
    Component

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

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

  37. def getRefOwnersChain(): List[Any]

    Definition Classes
    OwnableRef

  38. def getScalaLocationLong: String

    Definition Classes
    ScalaLocated

  39. def getScalaLocationShort: String

    Definition Classes
    ScalaLocated

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

    Definition Classes
    SpinalTagReady

  41. val globalData: GlobalData

    Definition Classes
    GlobalDataUser

  42. def hasTag(spinalTag: SpinalTag): Boolean

    Definition Classes
    SpinalTagReady

  43. def hashCode(): Int

    Definition Classes
    AnyRef → Any

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

    Definition Classes
    SpinalTagReady

  45. def instanceAttributes: Iterable[Attribute]

    Definition Classes
    SpinalTagReady

  46. def isEmptyOfTag: Boolean

    Definition Classes
    SpinalTagReady

  47. def isInBlackBoxTree: Boolean

    Definition Classes
    BlackBox → Component

  48. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  49. def isNamed: Boolean

    Definition Classes
    Nameable

  50. def isUnnamed: Boolean

    Definition Classes
    Nameable

  51. def isUsingULogic: Boolean

    Return true if the blackbox used std_ulogic

  52. var localNamingScope: NamingScope

    Name allocation

    Name allocation

    Definition Classes
    Component

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

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

    Map clock domains signal to the current ClockDomain

  55. def nameElements(): Unit

    Name all Nameable object

    Name all Nameable object

    Definition Classes
    Component

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

    Definition Classes
    AnyRef

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

  58. final def notify(): Unit

    Definition Classes
    AnyRef

  59. final def notifyAll(): Unit

    Definition Classes
    AnyRef

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

    Definition Classes
    SpinalTagReady

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

  62. var parentScope: ScopeStatement

    Definition Classes
    ContextUser

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

  64. def postPopEvent(): Unit

    Definition Classes
    Stackable

  65. def postPushEvent(): Unit

    Definition Classes
    Component → Stackable

  66. def prePop(): Unit

    Definition Classes
    Component

  67. def prePopEvent(): Unit

    Definition Classes
    Component → Stackable

  68. var refOwner: RefOwnerType

    Definition Classes
    OwnableRef

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

    Definition Classes
    SpinalTagReady

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

    Definition Classes
    SpinalTagReady

  71. def replaceStdLogicByStdULogic: BlackBox

    Replace std_logic by std_ulogic

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

    Rework the component

    Rework the component

    Definition Classes
    Component

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

    Set the name of the blackbox

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

    Definition Classes
    Nameable

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

    Definition Classes
    Nameable

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

    Definition Classes
    Nameable

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

    Definition Classes
    Nameable

  78. def setDefinitionName(name: String): BlackBox.this.type

    Set the definition name of the component

    Set the definition name of the component

    Definition Classes
    Component

  79. def setName(name: String, weak: Boolean = false): BlackBox.this.type

    Definition Classes
    Nameable

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

    Definition Classes
    Nameable

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

    Definition Classes
    Nameable

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

    Definition Classes
    Nameable

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

    Definition Classes
    Nameable

  84. def setRefOwner(that: Any): Unit

    Definition Classes
    OwnableRef

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

    Definition Classes
    ScalaLocated

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

    Definition Classes
    Nameable

  87. def spinalTags: Set[SpinalTag]

    Definition Classes
    SpinalTagReady

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

    Definition Classes
    AnyRef

  89. def toString(): String

    Definition Classes
    Nameable → AnyRef → Any

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

    Definition Classes
    Nameable

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

  92. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Component

Inherited from SpinalTagReady

Inherited from Stackable

Inherited from DelayedInit

Inherited from ScalaLocated

Inherited from NameableByComponent

Inherited from Nameable

Inherited from ContextUser

Inherited from GlobalDataUser

Inherited from OwnableRef

Inherited from AnyRef

Inherited from Any

Ungrouped