Packages

class TopLevel extends Component

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TopLevel
  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 TopLevel(p: Parameters)

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. val _spinalTags: LinkedHashSet[SpinalTag]
    Definition Classes
    SpinalTagReady
  2. def addAttribute(attribute: Attribute): TopLevel.this.type
    Definition Classes
    ComponentSpinalTagReady
  3. def addAttribute(name: String, value: Int): TopLevel.this.type
    Definition Classes
    SpinalTagReady
  4. def addAttribute(name: String, value: String): TopLevel.this.type
    Definition Classes
    SpinalTagReady
  5. def addAttribute(name: String): TopLevel.this.type
    Definition Classes
    SpinalTagReady
  6. def addComment(str: String): Component
    Definition Classes
    Component
  7. def addPrePopTask(task: () ⇒ Unit): ArrayBuffer[PrePopTask]

    Add a new prePopTask

    Add a new prePopTask

    Definition Classes
    Component
  8. def addTag[T <: SpinalTag](spinalTag: T): TopLevel.this.type
    Definition Classes
    SpinalTagReady
  9. def addTags(h: SpinalTag, tail: SpinalTag*): TopLevel.this.type
    Definition Classes
    SpinalTagReady
  10. def addTags[T <: SpinalTag](tags: Iterable[T]): TopLevel.this.type
    Definition Classes
    SpinalTagReady
  11. def afterElaboration(body: ⇒ Unit): ArrayBuffer[PrePopTask]
    Definition Classes
    Component
  12. def asFormalDut(): TopLevel.this.type
    Definition Classes
    Component
  13. val children: ArrayBuffer[Component]

    Contains an array of all children Component

    Contains an array of all children Component

    Definition Classes
    Component
  14. 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
  15. def component: Component
    Definition Classes
    ContextUser
  16. val definition: $anon forSome {type $anon <: SpinalTagReady { def addComment(str: String): $anon }}
    Definition Classes
    Component
  17. 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
  18. var definitionNameNoMerge: Boolean
    Definition Classes
    Component
  19. val dslBody: ScopeStatement
    Definition Classes
    Component
  20. def equals(obj: Any): Boolean
    Definition Classes
    OverridedEqualsHashCode → 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 findTag(cond: (SpinalTag) ⇒ Boolean): Option[SpinalTag]
    Definition Classes
    SpinalTagReady
  24. def foreachReflectableNameables(doThat: (Any) ⇒ Unit): Unit
    Definition Classes
    Nameable
  25. def foreachTag(body: (SpinalTag) ⇒ Unit): Unit
    Definition Classes
    SpinalTagReady
  26. val fsm: Area { ... /* 11 definitions in type refinement */ }
  27. 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
  28. def getDisplayName(): String
    Definition Classes
    ComponentNameable
  29. def getGroupedIO(ioBundleBypass: Boolean): Seq[Data]
    Definition Classes
    Component
  30. def getInstanceCounter: Int
    Definition Classes
    ContextUser
  31. def getName(default: String): String
    Definition Classes
    NameableByComponentNameable
  32. def getName(): String
    Definition Classes
    NameableByComponentNameable
  33. def getOrdredNodeIo: List[BaseType]

    Sort all IO regarding instanceCounter

    Sort all IO regarding instanceCounter

    Definition Classes
    Component
  34. 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
  35. def getPartialName(): String
    Definition Classes
    Nameable
  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 getPath(from: Component, to: Component): Seq[Component]
    Definition Classes
    NameableByComponent
  38. def getRefOwnersChain(): List[Any]
    Definition Classes
    OwnableRef
  39. def getRtlPath(separator: String = "/"): String
    Definition Classes
    Component
  40. def getScalaLocationLong: String
    Definition Classes
    ScalaLocated
  41. def getScalaLocationShort: String
    Definition Classes
    ScalaLocated
  42. def getScalaTrace(): Throwable
    Definition Classes
    ScalaLocated
  43. def getTag[T <: SpinalTag](clazz: Class[T]): Option[T]
    Definition Classes
    SpinalTagReady
  44. def getTags(): LinkedHashSet[SpinalTag]
    Definition Classes
    SpinalTagReady
  45. val globalData: GlobalData
    Definition Classes
    GlobalDataUser
  46. def hasTag[T <: SpinalTag](clazz: Class[T]): Boolean
    Definition Classes
    SpinalTagReady
  47. def hasTag(spinalTag: SpinalTag): Boolean
    Definition Classes
    SpinalTagReady
  48. def hashCode(): Int
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  49. val inputPhy: Area { ... /* 11 definitions in type refinement */ }
  50. def instanceAttributes(language: Language): Iterable[Attribute]
    Definition Classes
    SpinalTagReady
  51. def instanceAttributes: Iterable[Attribute]
    Definition Classes
    SpinalTagReady
  52. val io: Bundle { ... /* 4 definitions in type refinement */ }
  53. def isCompletelyUnnamed: Boolean
    Definition Classes
    Nameable
  54. def isEmptyOfTag: Boolean
    Definition Classes
    SpinalTagReady
  55. var isFormalTester: Boolean
    Definition Classes
    Component
  56. def isLogicLess: Boolean
    Definition Classes
    Component
  57. final def isNamed: Boolean
    Definition Classes
    Nameable
  58. def isPriorityApplicable(namePriority: Byte): Boolean
    Definition Classes
    Nameable
  59. def isUnnamed: Boolean
    Definition Classes
    NameableByComponentNameable
  60. var localNamingScope: NamingScope

    Name allocation

    Name allocation

    Definition Classes
    Component
  61. val maxBitRate: Int
  62. val name: String
    Definition Classes
    Nameable
  63. def noIoPrefix(): TopLevel.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
  64. def onBody[T](body: ⇒ T): T
    Definition Classes
    Component
  65. def onEachAttributes(doIt: (Attribute) ⇒ Unit): Unit
    Definition Classes
    SpinalTagReady
  66. val outputPhy: Area { ... /* 5 definitions in type refinement */ }
  67. def overrideLocalName(name: String): TopLevel.this.type
    Definition Classes
    Nameable
  68. val p: Parameters
  69. 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
  70. val parentScope: ScopeStatement
    Definition Classes
    ContextUser
  71. 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
  72. def postInitCallback(): TopLevel.this.type
    Definition Classes
    Component → PostInitCallback
  73. def postPopEvent(): Unit
    Definition Classes
    Stackable
  74. def postPushEvent(): Unit
    Definition Classes
    ComponentStackable
  75. def prePop(): Unit
    Definition Classes
    Component
  76. def prePopEvent(): Unit
    Definition Classes
    ComponentStackable
  77. var pulledDataCache: Map[Data, Data]
    Definition Classes
    Component
  78. val refOwner: RefOwnerType
    Definition Classes
    OwnableRef
    Annotations
    @DontName()
  79. def reflectBaseType(name: String): BaseType
    Definition Classes
    Component
  80. def reflectNames(): Unit
    Definition Classes
    Nameable
  81. def removeTag(spinalTag: SpinalTag): TopLevel.this.type
    Definition Classes
    SpinalTagReady
  82. def removeTags(tags: Iterable[SpinalTag]): TopLevel.this.type
    Definition Classes
    SpinalTagReady
  83. def rework[T](gen: ⇒ T): T
    Definition Classes
    Component
  84. val scalaTrace: Throwable
    Definition Classes
    ScalaLocated
  85. val scopeProperties: Capture

    Rework the component

    Rework the component

    Definition Classes
    Component
  86. def setCompositeName(nameable: Nameable, postfix: String, namePriority: Byte): TopLevel.this.type
    Definition Classes
    Nameable
  87. def setCompositeName(nameable: Nameable, postfix: String, weak: Boolean): TopLevel.this.type
    Definition Classes
    Nameable
  88. def setCompositeName(nameable: Nameable, postfix: String): TopLevel.this.type
    Definition Classes
    Nameable
  89. def setCompositeName(nameable: Nameable, namePriority: Byte): TopLevel.this.type
    Definition Classes
    Nameable
  90. def setCompositeName(nameable: Nameable, weak: Boolean): TopLevel.this.type
    Definition Classes
    Nameable
  91. def setCompositeName(nameable: Nameable): TopLevel.this.type
    Definition Classes
    Nameable
  92. def setDefinitionName(name: String, noMerge: Boolean = true): TopLevel.this.type

    Set the definition name of the component

    Set the definition name of the component

    Definition Classes
    Component
  93. def setFormalTester(): Unit
    Definition Classes
    Component
  94. def setLambdaName(isNameBody: ⇒ Boolean)(nameGen: ⇒ String): TopLevel.this.type
    Definition Classes
    Nameable
  95. def setName(name: String, namePriority: Byte): TopLevel.this.type
    Definition Classes
    Nameable
  96. def setName(name: String, weak: Boolean): TopLevel.this.type
    Definition Classes
    Nameable
  97. def setName(name: String): TopLevel.this.type
    Definition Classes
    Nameable
  98. def setNameAsWeak(): TopLevel.this.type
    Definition Classes
    Nameable
  99. def setPartialName(name: String, namePriority: Byte, owner: Any): TopLevel.this.type
    Definition Classes
    Nameable
  100. def setPartialName(name: String, namePriority: Byte): TopLevel.this.type
    Definition Classes
    Nameable
  101. def setPartialName(name: String, weak: Boolean): TopLevel.this.type
    Definition Classes
    Nameable
  102. def setPartialName(owner: Nameable, name: String, namePriority: Byte): TopLevel.this.type
    Definition Classes
    Nameable
  103. def setPartialName(owner: Nameable, name: String, weak: Boolean): TopLevel.this.type
    Definition Classes
    Nameable
  104. def setPartialName(name: String): TopLevel.this.type
    Definition Classes
    Nameable
  105. def setPartialName(owner: Nameable, name: String): TopLevel.this.type
    Definition Classes
    Nameable
  106. def setPartialName(owner: Nameable): TopLevel.this.type
    Definition Classes
    Nameable
  107. def setRefOwner(that: Any): Unit
    Definition Classes
    OwnableRef
  108. def setScalaLocated(source: ScalaLocated): TopLevel.this.type
    Definition Classes
    ScalaLocated
  109. def setWeakName(name: String): TopLevel.this.type
    Definition Classes
    Nameable
  110. def spinalTags: LinkedHashSet[SpinalTag]
    Definition Classes
    SpinalTagReady
  111. def stub(): TopLevel.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()
  112. val timer: Area { ... /* 4 definitions in type refinement */ }
  113. def toString(): String
    Definition Classes
    Nameable → AnyRef → Any
  114. def traceDisable(recursive: Boolean = true): TopLevel.this.type
    Definition Classes
    Component
  115. def traceEnable(recursive: Boolean = true): TopLevel.this.type
    Definition Classes
    Component
  116. var traceEnabled: Boolean
    Definition Classes
    Component
  117. def unsetName(): TopLevel.this.type
    Definition Classes
    Nameable
  118. 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
  119. def valCallback[T](ref: T, name: String): T
    Definition Classes
    ValCallbackRec → ValCallback
  120. def valCallbackOn(ref: Any, name: String, refs: Set[Any]): Unit
    Definition Classes
    ValCallbackRec
  121. def valCallbackRec(ref: Any, name: String): Unit
    Definition Classes
    ComponentValCallbackRec
  122. def walkComponents(body: (Component) ⇒ Unit): Unit
    Definition Classes
    Component
  123. val widthMax: Int
  124. val widths: ArrayBuffer[Int]
  125. def withAutoPull(): Unit
    Definition Classes
    Component
  126. var withHierarchyAutoPull: Boolean
    Definition Classes
    Component
  127. def withKeywords(): Unit
    Definition Classes
    Component
  128. var withVitalOutputs: Boolean
    Definition Classes
    Component
  129. def withoutKeywords(): Unit
    Definition Classes
    Component
  130. var withoutReservedKeywords: Boolean
    Definition Classes
    Component