t

spinal.lib.bus.misc

BusSlaveFactory

trait BusSlaveFactory extends Area

Bus slave factory is a tool that provide an abstract and smooth way to define register bank

Linear Supertypes
Area, OverridedEqualsHashCode, ValCallbackRec, ValCallback, NameableByComponent, Nameable, ContextUser, ScalaLocated, GlobalDataUser, OwnableRef, AnyRef, Any
Known Subclasses
AhbLite3SlaveFactory, Apb3SlaveFactory, Axi4SlaveFactory, AxiLite4SlaveFactory, AvalonMMSlaveFactory, BmbSlaveFactory, BRAMSlaveFactory, BusSlaveFactoryAddressWrapper, BusSlaveFactoryDelayed, AsyncMemoryBusFactory, PipelinedMemoryBusSlaveFactory, WishboneSlaveFactory
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BusSlaveFactory
  2. Area
  3. OverridedEqualsHashCode
  4. ValCallbackRec
  5. ValCallback
  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. Protected

Type Members

  1. abstract type RefOwnerType
    Definition Classes
    OwnableRef

Abstract Value Members

  1. abstract def busDataWidth: Int

    Return the data width of the bus

  2. abstract def nonStopWrite[T <: Data](that: T, bitOffset: Int = 0, documentation: String = null): T

    Permanently assign that by the bus write data from bitOffset

  3. abstract def onReadPrimitive(address: AddressMapping, haltSensitive: Boolean, documentation: String)(doThat: => Unit): Unit
  4. abstract def onWritePrimitive(address: AddressMapping, haltSensitive: Boolean, documentation: String)(doThat: => Unit): Unit
  5. abstract def readAddress(): UInt
  6. abstract def readHalt(): Unit
  7. abstract def readPrimitive[T <: Data](that: T, address: AddressMapping, bitOffset: Int, documentation: String): Unit
  8. abstract def writeAddress(): UInt
  9. abstract def writeHalt(): Unit
  10. abstract def writePrimitive[T <: Data](that: T, address: AddressMapping, bitOffset: Int, documentation: String): Unit

Concrete 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 _config: BusSlaveFactoryConfig

    Configuration of the BusSlaveFactory

    Configuration of the BusSlaveFactory

    Attributes
    protected
  5. val _context: Capture
    Definition Classes
    Area
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def childNamePriority: Byte
    Definition Classes
    Area
  8. def clearOnSet[T <: Data](that: T, address: BigInt, bitOffset: Int = 0): T
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  10. def component: Component
    Definition Classes
    ContextUser
  11. def createAndDriveFlow[T <: Data](dataType: T, address: BigInt, bitOffset: Int = 0): Flow[T]

    Create a writable Flow register of type dataType at address and placed at bitOffset in the word

  12. def createReadAndClearOnSet[T <: Data](dataType: T, address: BigInt, bitOffset: Int = 0): T
  13. def createReadAndSetOnSet[T <: Data](dataType: T, address: BigInt, bitOffset: Int = 0): T
  14. def createReadAndWrite[T <: Data](dataType: T, address: BigInt, bitOffset: Int = 0, documentation: String = null): T

    Create a read write register of type dataType at address and placed at bitOffset in the word

  15. def createReadMultiWord[T <: Data](that: T, address: BigInt, documentation: String = null): T

    Create multi-words read register of type dataType

  16. def createReadOnly[T <: Data](dataType: T, address: BigInt, bitOffset: Int = 0, documentation: String = null): T

    Create a read only register of type dataType at address and placed at bitOffset in the word

  17. def createWriteAndReadMultiWord[T <: Data](that: T, address: BigInt, documentation: String = null): T

    Create multi-words write and read register of type dataType

  18. def createWriteMultiWord[T <: Data](that: T, address: BigInt, documentation: String = null): T

    Create multi-words write register of type dataType

  19. def createWriteOnly[T <: Data](dataType: T, address: BigInt, bitOffset: Int = 0, documentation: String = null): T

    Create a write only register of type dataType at address and placed at bitOffset in the word

  20. def doBitsAccumulationAndClearOnRead(that: Bits, address: BigInt, bitOffset: Int = 0): Unit

    Instantiate an internal register which at each cycle do : reg := reg | that Then when a read occur, the register is cleared.

    Instantiate an internal register which at each cycle do : reg := reg | that Then when a read occur, the register is cleared. This register is readable at address and placed at bitOffset in the word

  21. def drive[T <: Data](address: BigInt, bitMapping: (Int, Data)*): Unit
  22. def drive[T <: Data](that: T, address: BigInt, bitOffset: Int = 0, documentation: String = null): T

    Drive that with a register writable at address placed at bitOffset in the word

  23. def driveAndRead[T <: Data](that: T, address: BigInt, bitOffset: Int = 0, documentation: String = null): T

    Drive that with a register writable and readable at address placed at bitOffset in the word

  24. def driveAndReadMultiWord[T <: Data](that: T, address: BigInt, documentation: String = null): T

    Drive and read that on multi-word

  25. def driveFlow[T <: Data](that: Flow[T], address: BigInt, bitOffset: Int = 0): Unit

    Emit on that a transaction when a write happen at address by using data placed at bitOffset in the word

  26. def driveMultiWord[T <: Data](that: T, address: BigInt, documentation: String = null): T

    Drive that on multi-words

  27. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  28. def equals(obj: Any): Boolean
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  29. def foreachReflectableNameables(doThat: (Any) => Unit): Unit
    Definition Classes
    Nameable
  30. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  31. def getConfig: BusSlaveFactoryConfig
  32. def getDisplayName(): String
    Definition Classes
    Nameable
  33. def getInstanceCounter: Int
    Definition Classes
    ContextUser
  34. def getMode: Byte
    Attributes
    protected
    Definition Classes
    Nameable
  35. def getName(default: String): String
    Definition Classes
    NameableByComponent → Nameable
  36. def getName(): String
    Definition Classes
    NameableByComponent → Nameable
  37. def getPartialName(): String
    Definition Classes
    Nameable
  38. def getRefOwnersChain(): List[Any]
    Definition Classes
    OwnableRef
  39. def getScalaLocationLong: String
    Definition Classes
    ScalaLocated
  40. def getScalaLocationShort: String
    Definition Classes
    ScalaLocated
  41. def getScalaTrace(): Throwable
    Definition Classes
    ScalaLocated
  42. val globalData: GlobalData
    Definition Classes
    GlobalDataUser
  43. def hashCode(): Int
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  44. def isCompletelyUnnamed: Boolean
    Definition Classes
    Nameable
  45. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  46. def isNamed: Boolean
    Definition Classes
    NameableByComponent → Nameable
  47. def isPriorityApplicable(namePriority: Byte): Boolean
    Definition Classes
    Nameable
  48. def isReading(address: BigInt): Bool

    Return true if the bus is reading

  49. def isUnnamed: Boolean
    Definition Classes
    Nameable
  50. def isWriting(address: BigInt): Bool

    Return true if the bus is writing

  51. def multiCycleRead(address: AddressMapping, cycles: BigInt): Unit
  52. val name: String
    Definition Classes
    Nameable
  53. val nameableRef: Nameable
    Attributes
    protected
    Definition Classes
    Nameable
    Annotations
    @DontName()
  54. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  55. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  56. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  57. def onRead(address: BigInt, documentation: String = null)(doThat: => Unit): Unit

    Call doThat when a read transaction occurs on address

  58. def onWrite(address: BigInt, documentation: String = null)(doThat: => Unit): Unit

    Call doThat when a write transaction occurs on address

  59. def overrideLocalName(name: String): BusSlaveFactory.this.type
    Definition Classes
    Nameable
  60. val parentScope: ScopeStatement
    Definition Classes
    ContextUser
  61. def read[T <: Data](address: BigInt, bitMapping: (Int, Data)*): Unit
  62. def read[T <: Data](that: T, address: BigInt, bitOffset: Int = 0, documentation: String = null): T

    When the bus read the address, fill the response with that at bitOffset

  63. def readAddress(address: AddressMapping): UInt
  64. def readAndClearOnSet[T <: Data](that: T, address: BigInt, bitOffset: Int = 0): T
  65. def readAndSetOnSet[T <: Data](that: T, address: BigInt, bitOffset: Int = 0): T
  66. def readAndWrite(that: Data, address: BigInt, bitOffset: Int = 0, documentation: String = null): Unit

    Make that readable and writable at address and placed at bitOffset in the word

  67. def readAndWriteMultiWord(that: Data, address: BigInt, documentation: String = null): Unit

    Create the memory mapping to write/read that from address

  68. def readFire(): Bool
  69. def readMultiWord(that: Data, address: BigInt, documentation: String = null): Unit

    Create the memory mapping to read that from address If that is bigger than one word it extends the register on following addresses.

  70. def readStreamNonBlocking[T <: Data](that: Stream[T], address: BigInt, validBitOffset: Int, payloadBitOffset: Int, validInverted: Boolean = false): Unit

    Read that and consume the transaction when a read happen at address.

  71. def readStreamNonBlocking[T <: Data](that: Stream[T], address: BigInt): Unit

    Read that (that is bigger than the busWidth) and consume the transaction when a read happen at address.

    Read that (that is bigger than the busWidth) and consume the transaction when a read happen at address.

    Note

    in order to avoid to read wrong data read first the address which contains the valid signal. Little : payload - valid at address 0x00 Big : valid - payload at address 0x00 Once the valid signal is true you can read all registers

  72. def readSyncMemMultiWord[T <: Data](mem: Mem[T], addressOffset: BigInt): Mem[T]

    Memory map a Mem to bus for reading.

    Memory map a Mem to bus for reading. Elements can be larger than bus data width in bits.

  73. def readSyncMemWordAligned[T <: Data](mem: Mem[T], addressOffset: BigInt, bitOffset: Int = 0): Mem[T]
  74. val refOwner: RefOwnerType
    Definition Classes
    OwnableRef
    Annotations
    @DontName()
  75. def reflectNames(): Unit
    Definition Classes
    Nameable
  76. def rework[T](body: => T): T
    Definition Classes
    Area
  77. val scalaTrace: Throwable
    Definition Classes
    ScalaLocated
  78. def setCompositeName(nameable: Nameable, postfix: String, namePriority: Byte): BusSlaveFactory.this.type
    Definition Classes
    Nameable
  79. def setCompositeName(nameable: Nameable, postfix: String, weak: Boolean): BusSlaveFactory.this.type
    Definition Classes
    Nameable
  80. def setCompositeName(nameable: Nameable, postfix: String): BusSlaveFactory.this.type
    Definition Classes
    Nameable
  81. def setCompositeName(nameable: Nameable, namePriority: Byte): BusSlaveFactory.this.type
    Definition Classes
    Nameable
  82. def setCompositeName(nameable: Nameable, weak: Boolean): BusSlaveFactory.this.type
    Definition Classes
    Nameable
  83. def setCompositeName(nameable: Nameable): BusSlaveFactory.this.type
    Definition Classes
    Nameable
  84. def setConfig(value: BusSlaveFactoryConfig): BusSlaveFactory.this.type
  85. def setName(name: String, namePriority: Byte): BusSlaveFactory.this.type
    Definition Classes
    Nameable
  86. def setName(name: String, weak: Boolean): BusSlaveFactory.this.type
    Definition Classes
    Nameable
  87. def setName(name: String): BusSlaveFactory.this.type
    Definition Classes
    Nameable
  88. def setNameAsWeak(): BusSlaveFactory.this.type
    Definition Classes
    Nameable
  89. def setOnClear[T <: Data](that: T, address: BigInt, bitOffset: Int = 0): T
  90. def setOnSet[T <: Data](that: T, address: BigInt, bitOffset: Int = 0): T
  91. def setPartialName(name: String, namePriority: Byte, owner: Any): BusSlaveFactory.this.type
    Definition Classes
    Nameable
  92. def setPartialName(name: String, namePriority: Byte): BusSlaveFactory.this.type
    Definition Classes
    Nameable
  93. def setPartialName(name: String, weak: Boolean): BusSlaveFactory.this.type
    Definition Classes
    Nameable
  94. def setPartialName(owner: Nameable, name: String, namePriority: Byte): BusSlaveFactory.this.type
    Definition Classes
    Nameable
  95. def setPartialName(owner: Nameable, name: String, weak: Boolean): BusSlaveFactory.this.type
    Definition Classes
    Nameable
  96. def setPartialName(name: String): BusSlaveFactory.this.type
    Definition Classes
    Nameable
  97. def setPartialName(owner: Nameable, name: String): BusSlaveFactory.this.type
    Definition Classes
    Nameable
  98. def setRefOwner(that: Any): Unit
    Definition Classes
    OwnableRef
  99. def setScalaLocated(source: ScalaLocated): BusSlaveFactory.this.type
    Definition Classes
    ScalaLocated
  100. def setWeakName(name: String): BusSlaveFactory.this.type
    Definition Classes
    Nameable
  101. def setWordEndianness(value: Endianness): BusSlaveFactory

    Set the endianness during write/read multiword

  102. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  103. def toString(): String
    Definition Classes
    Area → Nameable → AnyRef → Any
  104. def unsetName(): BusSlaveFactory.this.type
    Definition Classes
    Nameable
  105. def valCallback[T](ref: T, name: String): T
    Definition Classes
    ValCallbackRec → ValCallback
  106. def valCallbackOn(ref: Any, name: String, refs: Set[Any]): Unit
    Definition Classes
    ValCallbackRec
  107. def valCallbackRec(obj: Any, name: String): Unit
    Definition Classes
    Area → ValCallbackRec
  108. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  109. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  110. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  111. def withOffset(offset: Int): BusSlaveFactoryAddressWrapper
  112. def wordAddressInc: Int

    Address incrementation used by the read and write multi words registers

  113. def write[T <: Data](address: BigInt, bitMapping: (Int, Data)*): Unit
  114. def write[T <: Data](that: T, address: BigInt, bitOffset: Int = 0, documentation: String = null): T

    When the bus write the address, assign that with bus’s data from bitOffset

  115. def writeAddress(address: AddressMapping): UInt
  116. def writeByteEnable(): Bits

    Byte enable bits, defaulting to all ones

  117. def writeFire(): Bool
  118. def writeMemMultiWord[T <: Data](mem: Mem[T], addressOffset: BigInt): Mem[T]

    Memory map a Mem to bus for writing.

    Memory map a Mem to bus for writing. Elements can be larger than bus data width in bits.

  119. def writeMemWordAligned[T <: Data](mem: Mem[T], addressOffset: BigInt, bitOffset: Int = 0): Mem[T]
  120. def writeMultiWord(that: Data, address: BigInt, documentation: String = null): Unit

    Create the memory mapping to write that at address.

    Create the memory mapping to write that at address. If that is bigger than one word it extends the register on following addresses.

Deprecated Value Members

  1. def createReadWrite[T <: Data](dataType: T, address: BigInt, bitOffset: Int = 0): T
    Annotations
    @deprecated
    Deprecated

    (Since version ???) Use createReadAndWrite instead

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

Inherited from Area

Inherited from OverridedEqualsHashCode

Inherited from ValCallbackRec

Inherited from ValCallback

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