Packages

c

spinal.lib

SamplerCC

class SamplerCC[T <: Data] extends BlackBox

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SamplerCC
  2. BlackBox
  3. Component
  4. ValCallbackRec
  5. ValCallback
  6. OverridedEqualsHashCode
  7. SpinalTagReady
  8. Stackable
  9. PostInitCallback
  10. NameableByComponent
  11. Nameable
  12. ContextUser
  13. ScalaLocated
  14. GlobalDataUser
  15. OwnableRef
  16. AnyRef
  17. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SamplerCC(dataType: HardType[T], init: ⇒ T, depth: Int, pushCd: ClockDomain, popCd: ClockDomain, bufferDepth: Option[Int], randBoot: Boolean = false, inputAttributes: Seq[SpinalTag] = List(), allBufAttributes: Seq[SpinalTag] = List())

Type Members

  1. 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
  2. abstract type RefOwnerType
    Definition Classes
    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. val _spinalTags: LinkedHashSet[SpinalTag]
    Definition Classes
    SpinalTagReady
  5. def addAttribute(attribute: Attribute): SamplerCC.this.type
    Definition Classes
    Component → SpinalTagReady
  6. def addAttribute(name: String, value: Int): SamplerCC.this.type
    Definition Classes
    SpinalTagReady
  7. def addAttribute(name: String, value: String): SamplerCC.this.type
    Definition Classes
    SpinalTagReady
  8. def addAttribute(name: String): SamplerCC.this.type
    Definition Classes
    SpinalTagReady
  9. def addComment(str: String): Component
    Definition Classes
    Component
  10. def addGeneric(name: String, that: Any): Unit
    Definition Classes
    BlackBox
  11. def addGenerics(l: (String, Any)*): Unit
    Definition Classes
    BlackBox
  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

    Add the path of the rtl file

    Definition Classes
    BlackBox
  14. def addTag[T <: SpinalTag](spinalTag: T): SamplerCC.this.type
    Definition Classes
    SpinalTagReady
  15. def addTags(h: SpinalTag, tail: SpinalTag*): SamplerCC.this.type
    Definition Classes
    SpinalTagReady
  16. def addTags[T <: SpinalTag](tags: Iterable[T]): SamplerCC.this.type
    Definition Classes
    SpinalTagReady
  17. def afterElaboration(body: ⇒ Unit): ArrayBuffer[PrePopTask]
    Definition Classes
    Component
  18. val allBufAttributes: Seq[SpinalTag]
  19. def asFormalDut(): SamplerCC.this.type
    Definition Classes
    Component
  20. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  21. val bufferDepth: Option[Int]
  22. val cc: BufferCC[T]
  23. val children: ArrayBuffer[Component]

    Contains an array of all children Component

    Contains an array of all children Component

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

    Return the generic of the blackbox

    Return the generic of the blackbox

    Definition Classes
    BlackBox
  46. def getGroupedIO(ioBundleBypass: Boolean): Seq[Data]
    Definition Classes
    Component
  47. def getInstanceCounter: Int
    Definition Classes
    ContextUser
  48. def getMode: Byte
    Attributes
    protected
    Definition Classes
    Nameable
  49. def getName(default: String): String
    Definition Classes
    NameableByComponent → Nameable
  50. def getName(): String
    Definition Classes
    NameableByComponent → Nameable
  51. def getOrdredNodeIo: List[BaseType]

    Sort all IO regarding instanceCounter

    Sort all IO regarding instanceCounter

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

    Return true if the blackbox used the tag noNumericType

    Return true if the blackbox used the tag noNumericType

    Definition Classes
    BlackBox
  85. def isUsingULogic: Boolean

    Return true if the blackbox used std_ulogic

    Return true if the blackbox used std_ulogic

    Definition Classes
    BlackBox
  86. val librariesUsages: HashSet[String]
    Definition Classes
    BlackBox
  87. val listRTLPath: LinkedHashSet[String]
    Definition Classes
    BlackBox
  88. var localNamingScope: NamingScope

    Name allocation

    Name allocation

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

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

    Definition Classes
    BlackBox
  90. 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

    Map clock domains signal to the current ClockDomain

    Definition Classes
    BlackBox
  91. val name: String
    Definition Classes
    Nameable
  92. val nameableRef: Nameable
    Attributes
    protected
    Definition Classes
    Nameable
    Annotations
    @DontName()
  93. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  94. def noIoPrefix(): SamplerCC.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
  95. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  96. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  97. def onBody[T](body: ⇒ T): T
    Definition Classes
    Component
  98. def onEachAttributes(doIt: (Attribute) ⇒ Unit): Unit
    Definition Classes
    SpinalTagReady
  99. def overrideLocalName(name: String): SamplerCC.this.type
    Definition Classes
    Nameable
  100. 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
  101. val parentScope: ScopeStatement
    Definition Classes
    ContextUser
  102. 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
  103. val popCd: ClockDomain
  104. def postInitCallback(): SamplerCC.this.type
    Definition Classes
    Component → PostInitCallback
  105. def postPopEvent(): Unit
    Definition Classes
    Stackable
  106. def postPushEvent(): Unit
    Definition Classes
    Component → Stackable
  107. def prePop(): Unit
    Definition Classes
    Component
  108. def prePopEvent(): Unit
    Definition Classes
    Component → Stackable
  109. var pulledDataCache: Map[Data, Data]
    Definition Classes
    Component
  110. val push: ClockingArea { val reg: T }
  111. val pushCd: ClockDomain
  112. val randBoot: Boolean
  113. val refOwner: RefOwnerType
    Definition Classes
    OwnableRef
    Annotations
    @DontName()
  114. def reflectBaseType(name: String): BaseType
    Definition Classes
    Component
  115. def reflectNames(): Unit
    Definition Classes
    Nameable
  116. def removeTag(spinalTag: SpinalTag): SamplerCC.this.type
    Definition Classes
    SpinalTagReady
  117. def removeTags(tags: Iterable[SpinalTag]): SamplerCC.this.type
    Definition Classes
    SpinalTagReady
  118. def replaceStdLogicByStdULogic(): BlackBox

    Replace std_logic by std_ulogic

    Replace std_logic by std_ulogic

    Definition Classes
    BlackBox
  119. def rework[T](gen: ⇒ T): T
    Definition Classes
    Component
  120. val scalaTrace: Throwable
    Definition Classes
    ScalaLocated
  121. val scopeProperties: Capture

    Rework the component

    Rework the component

    Definition Classes
    Component
  122. def setBlackBox(): Unit
    Definition Classes
    BlackBox
  123. def setBlackBoxName(name: String): SamplerCC.this.type

    Set the name of the blackbox

    Set the name of the blackbox

    Definition Classes
    BlackBox
  124. def setCompositeName(nameable: Nameable, postfix: String, namePriority: Byte): SamplerCC.this.type
    Definition Classes
    Nameable
  125. def setCompositeName(nameable: Nameable, postfix: String, weak: Boolean): SamplerCC.this.type
    Definition Classes
    Nameable
  126. def setCompositeName(nameable: Nameable, postfix: String): SamplerCC.this.type
    Definition Classes
    Nameable
  127. def setCompositeName(nameable: Nameable, namePriority: Byte): SamplerCC.this.type
    Definition Classes
    Nameable
  128. def setCompositeName(nameable: Nameable, weak: Boolean): SamplerCC.this.type
    Definition Classes
    Nameable
  129. def setCompositeName(nameable: Nameable): SamplerCC.this.type
    Definition Classes
    Nameable
  130. def setDefinitionName(name: String, noMerge: Boolean = true): SamplerCC.this.type

    Set the definition name of the component

    Set the definition name of the component

    Definition Classes
    Component
  131. def setFormalTester(): Unit
    Definition Classes
    Component
  132. def setInline(impl: BlackBoxImpl): Unit
    Definition Classes
    BlackBox
  133. def setInlineVerilog(str: String): Unit
    Definition Classes
    BlackBox
  134. def setInlineVhdl(str: String): Unit
    Definition Classes
    BlackBox
  135. def setIoCd(cd: ClockDomain = this.clockDomain): Unit
    Definition Classes
    BlackBox
  136. def setLambdaName(isNameBody: ⇒ Boolean)(nameGen: ⇒ String): SamplerCC.this.type
    Definition Classes
    Nameable
  137. def setName(name: String, namePriority: Byte): SamplerCC.this.type
    Definition Classes
    Nameable
  138. def setName(name: String, weak: Boolean): SamplerCC.this.type
    Definition Classes
    Nameable
  139. def setName(name: String): SamplerCC.this.type
    Definition Classes
    Nameable
  140. def setNameAsWeak(): SamplerCC.this.type
    Definition Classes
    Nameable
  141. def setPartialName(name: String, namePriority: Byte, owner: Any): SamplerCC.this.type
    Definition Classes
    Nameable
  142. def setPartialName(name: String, namePriority: Byte): SamplerCC.this.type
    Definition Classes
    Nameable
  143. def setPartialName(name: String, weak: Boolean): SamplerCC.this.type
    Definition Classes
    Nameable
  144. def setPartialName(owner: Nameable, name: String, namePriority: Byte): SamplerCC.this.type
    Definition Classes
    Nameable
  145. def setPartialName(owner: Nameable, name: String, weak: Boolean): SamplerCC.this.type
    Definition Classes
    Nameable
  146. def setPartialName(name: String): SamplerCC.this.type
    Definition Classes
    Nameable
  147. def setPartialName(owner: Nameable, name: String): SamplerCC.this.type
    Definition Classes
    Nameable
  148. def setPartialName(owner: Nameable): SamplerCC.this.type
    Definition Classes
    Nameable
  149. def setRefOwner(that: Any): Unit
    Definition Classes
    OwnableRef
  150. def setScalaLocated(source: ScalaLocated): SamplerCC.this.type
    Definition Classes
    ScalaLocated
  151. def setWeakName(name: String): SamplerCC.this.type
    Definition Classes
    Nameable
  152. def spinalSimWhiteBox(): Unit
    Definition Classes
    BlackBox
  153. def spinalTags: LinkedHashSet[SpinalTag]
    Definition Classes
    SpinalTagReady
  154. def stub(): SamplerCC.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()
  155. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  156. def toString(): String
    Definition Classes
    Nameable → AnyRef → Any
  157. def traceDisable(recursive: Boolean = true): SamplerCC.this.type
    Definition Classes
    Component
  158. def traceEnable(recursive: Boolean = true): SamplerCC.this.type
    Definition Classes
    Component
  159. var traceEnabled: Boolean
    Definition Classes
    Component
  160. def unsetName(): SamplerCC.this.type
    Definition Classes
    Nameable
  161. 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
  162. def valCallback[T](ref: T, name: String): T
    Definition Classes
    ValCallbackRec → ValCallback
  163. def valCallbackOn(ref: Any, name: String, refs: Set[Any]): Unit
    Definition Classes
    ValCallbackRec
  164. def valCallbackRec(ref: Any, name: String): Unit
    Definition Classes
    Component → ValCallbackRec
  165. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  166. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  167. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  168. def walkComponents(body: (Component) ⇒ Unit): Unit
    Definition Classes
    Component
  169. def withAutoPull(): Unit
    Definition Classes
    Component
  170. var withHierarchyAutoPull: Boolean
    Definition Classes
    Component
  171. def withKeywords(): Unit
    Definition Classes
    Component
  172. var withVitalOutputs: Boolean
    Definition Classes
    Component
  173. def withoutKeywords(): Unit
    Definition Classes
    Component
  174. 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 BlackBox

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