Packages

abstract class Component extends NameableByComponent with ContextUser with ScalaLocated with PostInitCallback with Stackable with OwnableRef with SpinalTagReady with OverridedEqualsHashCode with ValCallbackRec

Abstract class used to create a new Component

Example:
  1. class MyAndGate extends Component {
      val io = new Bundle{
        val a,b = in Bool()
        val res = out Bool()
      }
      io.res := io.a & io.b
    }
See also

Component Documentation

Known Subclasses
BlackBox, BlackBoxULogic, Ram_1w_1ra, Ram_1w_1rs, Ram_1wors, Ram_1wrs, Ram_2c_1w_1rs, Ram_2wrs, BufferCC, FlowCCUnsafeByToggle, HistoryModifyable, PulseCCByToggle, StreamAccessibleFifo, StreamArbiter, StreamCCByToggle, StreamDemux, StreamFifo, StreamFifoCC, StreamFifoLowLatency, StreamFifoMultiChannelSharedSpace, StreamFork, StreamMux, StreamShiftChain, StreamToStreamFragmentBits, StreamTransactionCounter, StreamTransactionExtender, Wrapper, sld_virtual_jtag, EG_LOGIC_BUFG, EG_LOGIC_ODDR, EG_PHY_BRAM, EG_PHY_BRAM32K, EG_PHY_SDRAM_2M_32, BB, DCCA, EHXPLLL, IDDRX1F, IFS1P3BX, JTAGG, ODDRX1F, OFS1P3BX, TSFF, Ulx3sUsrMclk, ICE40_PLL, SB_DFFR, SB_DFFS, SB_GB, SB_IO, SB_PLL40_CORE, SB_PLL40_PAD, SB_SPRAM256KA, BSCANE2, BUFG, BUFGCE, BUFIO, FDRE, IBUF, IBUFG, IDELAYCTRL, IDELAYE2, IOBUF, IOBUFDS, ISERDESE2, MMCME2_BASE, Mmcme2Ctrl, OBUFDS, ODELAYE2, OSERDESE2, PLLE2_BASE, STARTUPE2, AhbLite3Arbiter, AhbLite3Decoder, AhbLite3OnChipRam, AhbLite3OnChipRamMultiPort, AhbLite3OnChipRom, AhbLite3ToApb3Bridge, DefaultAhbLite3Slave, Apb3CC, Apb3CCToggle, Apb3Decoder, Apb3Dummy, Apb3Gpio, Apb3Router, Apb3ToBmb, Apb4Hub, Axi4CC, Axi4Downsizer, Axi4DownsizerSubTransactionGenerator, Axi4IdRemover, Axi4ReadOnlyAligner, Axi4ReadOnlyArbiter, Axi4ReadOnlyCC, Axi4ReadOnlyChecker, Axi4ReadOnlyCompactor, Axi4ReadOnlyDecoder, Axi4ReadOnlyDownsizer, Axi4ReadOnlyErrorSlave, Axi4ReadOnlyIdRemover, Axi4ReadOnlyOnePerId, Axi4ReadOnlyToTilelink, Axi4ReadOnlyToTilelinkFull, Axi4ReadOnlyUnburster, Axi4ReadOnlyUpsizer, Axi4SharedArbiter, Axi4SharedCC, Axi4SharedChecker, Axi4SharedDecoder, Axi4SharedErrorSlave, Axi4SharedIdRemover, Axi4SharedOnChipRam, Axi4SharedOnChipRamMultiPort, Axi4SharedToApb3Bridge, Axi4SharedToAxi3Shared, Axi4SharedToBram, Axi4Upsizer, Axi4WriteOnlyAligner, Axi4WriteOnlyArbiter, Axi4WriteOnlyCC, Axi4WriteOnlyCompactor, Axi4WriteOnlyDecoder, Axi4WriteOnlyDownsizer, Axi4WriteOnlyErrorSlave, Axi4WriteOnlyIdRemover, Axi4WriteOnlyOnePerId, Axi4WriteOnlyToTilelink, Axi4WriteOnlyToTilelinkFull, Axi4WriteOnlyUnburster, Axi4WriteOnlyUpsizer, UnbursterIDManager, AxiLite4SimpleReadDma, Axi4StreamSimpleWidthAdapter, Axi4StreamSparseCompactor, Axi4StreamWidthAdapter, Axi4StreamWidthAdapter_8_8, AvalonReadDma, AvalonSTDelayAdapter, Axi4SharedToBmb, BmbAlignedSpliter, BmbAligner, BmbArbiter, BmbCcFifo, BmbCcToggle, BmbContextRemover, BmbDecoder, BmbDecoderOutOfOrder, BmbDecoderPerSource, BmbDownSizerBridge, BmbEg4S20Bram32K, BmbErrorSlave, BmbExclusiveMonitor, BmbIce40Spram, BmbInvalidateMonitor, BmbInvalidationArbiter, BmbLengthFixer, BmbOnChipRam, BmbOnChipRamMultiPort, BmbSourceDecoder, BmbSourceRemover, BmbSyncRemover, BmbToApb3Bridge, BmbToAxi4ReadOnlyBridge, BmbToAxi4SharedBridge, BmbToAxi4SharedBridgeAssumeInOrder, BmbToAxi4WriteOnlyBridge, BmbToTilelink, BmbToWishbone, BmbUnburstify, BmbUpSizerBridge, BmbWriteRetainer, TilelinkToBmb, BRAMDecoder, BsbDownSizerAlignedMultiWidth, BsbDownSizerSparse, BsbUpSizerDense, BsbUpSizerSparse, PipelinedMemoryBusArbiter, PipelinedMemoryBusDecoder, PipelinedMemoryBusToApbBridge, Apb3Bridge, Arbiter, Axi4Bridge, AxiLite4Bridge, ContextAsyncBufferBase, ContextAsyncBufferFull, Decoder, ErrorSlave, FifoCc, Ram, TransferFilter, WidthAdapter, Cache, Hub, WishboneAdapter, WishboneArbiter, WishboneDecoder, WishboneGpio, WishboneToBmb, BmbMacEth, Crc, MacEth, MacRxAligner, MacRxBuffer, MacRxChecker, MacRxPreamble, MacTxAligner, MacTxBuffer, MacTxCrc, MacTxHeader, MacTxInterFrame, MacTxManagedStreamFifoCc, MacTxPadder, Apb3I2cCtrl, BmbI2cCtrl, I2cSlave, TilelinkI2cCtrl, SimpleJtagTap, VJtag2BmbMaster, SimpleJtagTap, Bscane2BmbMaster, Decoder, Encoder, Apb3SpiMasterCtrl, Apb3SpiSlaveCtrl, SpiMasterCtrl, SpiSlaveCtrl, WishboneSpiMasterCtrl, WishboneSpiSlaveCtrl, Apb3SpiXdrMasterCtrl, BmbSpiXdrMasterCtrl, TopLevel, TilelinkSpiXdrMasterCtrl, Apb3UartCtrl, AvalonMMUartCtrl, BmbUartCtrl, TilelinkUartCtrl, UartCtrl, UartCtrlRx, UartCtrlTx, UartCtrlUsageExample, WishboneUartCtrl, UsbOhci, UsbOhciAxi4, UsbOhciAxi4Apb3, UsbOhciTilelink, UsbOhciWishbone, UsbDevicePhyNative, CtrlCc, UsbLsFsPhy, UsbLsFsPhyFilter, UsbDeviceCtrl, PhyCc, UsbDeviceWithPhyWishbone, DebugModule, DebugTransportModuleJtagTap, DebugTransportModuleJtagTapWithTunnel, DebugTransportModuleTunneled, Alu, DataCache, InstructionCache, TopLevel, RiscvCore, TopLevel, TopLevel, RiscvAhbLite3, RiscvAvalon, RiscvAxi4, alt_inbuf, alt_inbuf_diff, alt_outbuf, alt_outbuf_diff, alt_outbuf_tri, alt_outbuf_tri_diff, Test, Block, SblReadDma, Module, SerialCheckerPhysicalToSerial, SerialCheckerPhysicalfromSerial, SerialCheckerRx, SerialCheckerTx, SerialLinkRx, SerialLinkTx, SerialSafeLayerTx, SerialSafelLayerRx, LargeExample, TopLevel, TopLevel, TopLevel, TopLevel, TopLevel, TopLevel, TopLevel, TopLevel, TopLevel, TopLevel, TopLevel, TopLevel, GeneratorComponent, GeneratorComponent, VideoDma, TmdsEncoder, VgaToHdmiEcp5, AvalonMMVgaCtrl, Axi4VgaCtrl, BlinkingVgaCtrl, BmbVgaCtrl, TilelinkVgaCtrl, TilelinkVideoDma, VgaCtrl, VgaRgbToYcbcr, VgaYcbcrPix2, Apb3Gpio2, BmbGpio2, Ctrl, TilelinkGpio2, MixedDivider, SignedDivider, UnsignedDivider, Alignment, BmbBridge, Control, DfiController, BmbAdapter, BmbAlignedSpliter, BmbAligner, BmbToPreTaskPort, CAAlignment, CmdTxd, MakeTask, RdAlignment, RdDataRxd, Refresher, WrAlignment, WrDataTxd, Axi4SharedSdramCtrl, BmbSdramCtrl, SdramCtrl, Backend, BmbAdapter, BmbToCorePort, Core, CtrlWithoutPhy, CtrlWithoutPhyBmb, Refresher, Tasker, TimingEnforcer, mt41k128m16jt_model, mt48lc16m16a2_model, Ecp5Sdrx2Phy, PLLE2_ADV, RtlPhy, SdrInferedPhy, XilinxS7Phy, Apb3Clint, Apb3InterruptCtrl, AxiLite4Clint, BmbClint, BmbWatchdog, InterruptCtrl, MachineTimer, MappedClint, Prescaler, TilelinkClint, TilelinkWatchdog, Timer, WishboneClint, BmbBsbToDeltaSigma, BsbToDeltaSigma, SIntToSigmaDeltaSecondOrder, UIntToSigmaDeltaFirstOrder, PDMCore, AxiLite4Plic, MappedPlic, TilelinkPlic, WishbonePlic, PipelineTop, Pinsec, PinsecTimerCtrl, JtagAvalonDebugger, JtagAxi4SharedDebugger, JtagBridge, JtagBridgeNoTap, SystemDebugger, VJtagBridge, DmaMemoryCore, Aggregator, Core, FlowCCByToggle, StreamDispatcherSequencial
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Component
  2. ValCallbackRec
  3. ValCallback
  4. OverridedEqualsHashCode
  5. SpinalTagReady
  6. Stackable
  7. PostInitCallback
  8. NameableByComponent
  9. Nameable
  10. ContextUser
  11. ScalaLocated
  12. GlobalDataUser
  13. OwnableRef
  14. AnyRef
  15. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Component()

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

  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): Component.this.type
    Definition Classes
    ComponentSpinalTagReady
  6. def addAttribute(name: String, value: Int): Component.this.type
    Definition Classes
    SpinalTagReady
  7. def addAttribute(name: String, value: String): Component.this.type
    Definition Classes
    SpinalTagReady
  8. def addAttribute(name: String): Component.this.type
    Definition Classes
    SpinalTagReady
  9. def addComment(str: String): Component
  10. def addPrePopTask(task: () ⇒ Unit): ArrayBuffer[PrePopTask]

    Add a new prePopTask

  11. def addTag[T <: SpinalTag](spinalTag: T): Component.this.type
    Definition Classes
    SpinalTagReady
  12. def addTags(h: SpinalTag, tail: SpinalTag*): Component.this.type
    Definition Classes
    SpinalTagReady
  13. def addTags[T <: SpinalTag](tags: Iterable[T]): Component.this.type
    Definition Classes
    SpinalTagReady
  14. def afterElaboration(body: ⇒ Unit): ArrayBuffer[PrePopTask]
  15. def asFormalDut(): Component.this.type
  16. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  17. val children: ArrayBuffer[Component]

    Contains an array of all children Component

  18. val clockDomain: Handle[ClockDomain]

    Get the current clock domain (null if there is no clock domain already set )

  19. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @IntrinsicCandidate()
  20. def component: Component
    Definition Classes
    ContextUser
  21. val definition: $anon forSome {type $anon <: SpinalTagReady { def addComment(str: String): $anon }}
  22. var definitionName: String

    Definition Name (name of the entity (VHDL) or module (Verilog))

  23. var definitionNameNoMerge: Boolean
  24. val dslBody: ScopeStatement
  25. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. def equals(obj: Any): Boolean
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  27. def existsTag(cond: (SpinalTag) ⇒ Boolean): Boolean
    Definition Classes
    SpinalTagReady
  28. def filterTag(cond: (SpinalTag) ⇒ Boolean): Iterable[SpinalTag]
    Definition Classes
    SpinalTagReady
  29. def findTag(cond: (SpinalTag) ⇒ Boolean): Option[SpinalTag]
    Definition Classes
    SpinalTagReady
  30. def foreachReflectableNameables(doThat: (Any) ⇒ Unit): Unit
    Definition Classes
    Nameable
  31. def foreachTag(body: (SpinalTag) ⇒ Unit): Unit
    Definition Classes
    SpinalTagReady
  32. def getAllIo: Set[BaseType]

    Get a set of all IO available in the component

  33. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  34. def getDisplayName(): String
    Definition Classes
    ComponentNameable
  35. def getGroupedIO(ioBundleBypass: Boolean): Seq[Data]
  36. def getInstanceCounter: Int
    Definition Classes
    ContextUser
  37. def getMode: Byte
    Attributes
    protected
    Definition Classes
    Nameable
  38. def getName(default: String): String
    Definition Classes
    NameableByComponentNameable
  39. def getName(): String
    Definition Classes
    NameableByComponentNameable
  40. def getOrdredNodeIo: List[BaseType]

    Sort all IO regarding instanceCounter

  41. def getParentsPath(sep: String = "/"): String

    Return the path of the parent

    Return the path of the parent

    Example:
    1. toplevel/[myComponent1] // Current component is myComponent2
  42. def getPartialName(): String
    Definition Classes
    Nameable
  43. def getPath(sep: String = "/"): String

    Return the path of the component

    Return the path of the component

    Example:
    1. toplevel/[myComponent1]/[myComponent2] // Current component is myComponent2
  44. def getPath(from: Component, to: Component): Seq[Component]
    Definition Classes
    NameableByComponent
  45. def getRefOwnersChain(): List[Any]
    Definition Classes
    OwnableRef
  46. def getRtlPath(separator: String = "/"): String
  47. def getScalaLocationLong: String
    Definition Classes
    ScalaLocated
  48. def getScalaLocationShort: String
    Definition Classes
    ScalaLocated
  49. def getScalaTrace(): Throwable
    Definition Classes
    ScalaLocated
  50. def getTag[T <: SpinalTag](clazz: Class[T]): Option[T]
    Definition Classes
    SpinalTagReady
  51. def getTags(): LinkedHashSet[SpinalTag]
    Definition Classes
    SpinalTagReady
  52. val globalData: GlobalData
    Definition Classes
    GlobalDataUser
  53. def hasTag[T <: SpinalTag](clazz: Class[T]): Boolean
    Definition Classes
    SpinalTagReady
  54. def hasTag(spinalTag: SpinalTag): Boolean
    Definition Classes
    SpinalTagReady
  55. def hashCode(): Int
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  56. def instanceAttributes(language: Language): Iterable[Attribute]
    Definition Classes
    SpinalTagReady
  57. def instanceAttributes: Iterable[Attribute]
    Definition Classes
    SpinalTagReady
  58. def isCompletelyUnnamed: Boolean
    Definition Classes
    Nameable
  59. def isEmptyOfTag: Boolean
    Definition Classes
    SpinalTagReady
  60. var isFormalTester: Boolean
  61. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  62. def isLogicLess: Boolean
  63. final def isNamed: Boolean
    Definition Classes
    Nameable
  64. def isPriorityApplicable(namePriority: Byte): Boolean
    Definition Classes
    Nameable
  65. def isUnnamed: Boolean
    Definition Classes
    NameableByComponentNameable
  66. var localNamingScope: NamingScope

    Name allocation

  67. val name: String
    Definition Classes
    Nameable
  68. val nameableRef: Nameable
    Attributes
    protected
    Definition Classes
    Nameable
    Annotations
    @DontName()
  69. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  70. def noIoPrefix(): Component.this.type

    No "io_" prefix in front of the in/out signals

  71. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  72. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  73. def onBody[T](body: ⇒ T): T
  74. def onEachAttributes(doIt: (Attribute) ⇒ Unit): Unit
    Definition Classes
    SpinalTagReady
  75. def overrideLocalName(name: String): Component.this.type
    Definition Classes
    Nameable
  76. def parent: Component

    Get the parent component (null if there is no parent)

  77. val parentScope: ScopeStatement
    Definition Classes
    ContextUser
  78. def parents(of: Component = this, list: List[Component] = Nil): List[Component]

    Return a list of all parents of the components

  79. def postInitCallback(): Component.this.type
    Definition Classes
    Component → PostInitCallback
  80. def postPopEvent(): Unit
    Definition Classes
    Stackable
  81. def postPushEvent(): Unit
    Definition Classes
    ComponentStackable
  82. def prePop(): Unit
  83. def prePopEvent(): Unit
    Definition Classes
    ComponentStackable
  84. var pulledDataCache: Map[Data, Data]
  85. val refOwner: RefOwnerType
    Definition Classes
    OwnableRef
    Annotations
    @DontName()
  86. def reflectBaseType(name: String): BaseType
  87. def reflectNames(): Unit
    Definition Classes
    Nameable
  88. def removeTag(spinalTag: SpinalTag): Component.this.type
    Definition Classes
    SpinalTagReady
  89. def removeTags(tags: Iterable[SpinalTag]): Component.this.type
    Definition Classes
    SpinalTagReady
  90. def rework[T](gen: ⇒ T): T
  91. val scalaTrace: Throwable
    Definition Classes
    ScalaLocated
  92. val scopeProperties: Capture

    Rework the component

  93. def setCompositeName(nameable: Nameable, postfix: String, namePriority: Byte): Component.this.type
    Definition Classes
    Nameable
  94. def setCompositeName(nameable: Nameable, postfix: String, weak: Boolean): Component.this.type
    Definition Classes
    Nameable
  95. def setCompositeName(nameable: Nameable, postfix: String): Component.this.type
    Definition Classes
    Nameable
  96. def setCompositeName(nameable: Nameable, namePriority: Byte): Component.this.type
    Definition Classes
    Nameable
  97. def setCompositeName(nameable: Nameable, weak: Boolean): Component.this.type
    Definition Classes
    Nameable
  98. def setCompositeName(nameable: Nameable): Component.this.type
    Definition Classes
    Nameable
  99. def setDefinitionName(name: String, noMerge: Boolean = true): Component.this.type

    Set the definition name of the component

  100. def setFormalTester(): Unit
  101. def setLambdaName(isNameBody: ⇒ Boolean)(nameGen: ⇒ String): Component.this.type
    Definition Classes
    Nameable
  102. def setName(name: String, namePriority: Byte): Component.this.type
    Definition Classes
    Nameable
  103. def setName(name: String, weak: Boolean): Component.this.type
    Definition Classes
    Nameable
  104. def setName(name: String): Component.this.type
    Definition Classes
    Nameable
  105. def setNameAsWeak(): Component.this.type
    Definition Classes
    Nameable
  106. def setPartialName(name: String, namePriority: Byte, owner: Any): Component.this.type
    Definition Classes
    Nameable
  107. def setPartialName(name: String, namePriority: Byte): Component.this.type
    Definition Classes
    Nameable
  108. def setPartialName(name: String, weak: Boolean): Component.this.type
    Definition Classes
    Nameable
  109. def setPartialName(owner: Nameable, name: String, namePriority: Byte): Component.this.type
    Definition Classes
    Nameable
  110. def setPartialName(owner: Nameable, name: String, weak: Boolean): Component.this.type
    Definition Classes
    Nameable
  111. def setPartialName(name: String): Component.this.type
    Definition Classes
    Nameable
  112. def setPartialName(owner: Nameable, name: String): Component.this.type
    Definition Classes
    Nameable
  113. def setPartialName(owner: Nameable): Component.this.type
    Definition Classes
    Nameable
  114. def setRefOwner(that: Any): Unit
    Definition Classes
    OwnableRef
  115. def setScalaLocated(source: ScalaLocated): Component.this.type
    Definition Classes
    ScalaLocated
  116. def setWeakName(name: String): Component.this.type
    Definition Classes
    Nameable
  117. def spinalTags: LinkedHashSet[SpinalTag]
    Definition Classes
    SpinalTagReady
  118. def stub(): Component.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

    Example:
    1. val dut = (new MyComponent).stub()
  119. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  120. def toString(): String
    Definition Classes
    Nameable → AnyRef → Any
  121. def traceDisable(recursive: Boolean = true): Component.this.type
  122. def traceEnable(recursive: Boolean = true): Component.this.type
  123. var traceEnabled: Boolean
  124. def unsetName(): Component.this.type
    Definition Classes
    Nameable
  125. val userCache: Map[Any, Any]

    Used to store arbitrary object related to the component

  126. def valCallback[T](ref: T, name: String): T
    Definition Classes
    ValCallbackRec → ValCallback
  127. def valCallbackOn(ref: Any, name: String, refs: Set[Any]): Unit
    Definition Classes
    ValCallbackRec
  128. def valCallbackRec(ref: Any, name: String): Unit
    Definition Classes
    ComponentValCallbackRec
  129. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  130. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  131. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  132. def walkComponents(body: (Component) ⇒ Unit): Unit
  133. def withAutoPull(): Unit
  134. var withHierarchyAutoPull: Boolean
  135. def withKeywords(): Unit
  136. var withVitalOutputs: Boolean
  137. def withoutKeywords(): Unit
  138. var withoutReservedKeywords: Boolean

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

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