Trait

spinal.lib.bus.misc

BusSlaveFactory

Related Doc: package misc

Permalink

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

Type Members

  1. abstract type RefOwnerType

    Permalink
    Definition Classes
    OwnableRef

Abstract Value Members

  1. abstract def busDataWidth: Int

    Permalink

    Return the data width of the bus

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

    Permalink

    Permanently assign that by the bus write data from bitOffset

  3. abstract def onReadPrimitive(address: AddressMapping, haltSensitive: Boolean, documentation: String)(doThat: ⇒ Unit): Unit

    Permalink
  4. abstract def onWritePrimitive(address: AddressMapping, haltSensitive: Boolean, documentation: String)(doThat: ⇒ Unit): Unit

    Permalink
  5. abstract def readAddress(): UInt

    Permalink
  6. abstract def readHalt(): Unit

    Permalink
  7. abstract def readPrimitive[T <: Data](that: T, address: AddressMapping, bitOffset: Int, documentation: String): Unit

    Permalink
  8. abstract def writeAddress(): UInt

    Permalink
  9. abstract def writeHalt(): Unit

    Permalink
  10. abstract def writePrimitive[T <: Data](that: T, address: AddressMapping, bitOffset: Int, documentation: String): Unit

    Permalink

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. var _config: BusSlaveFactoryConfig

    Permalink

    Configuration of the BusSlaveFactory

    Configuration of the BusSlaveFactory

    Attributes
    protected
  5. val _context: Capture

    Permalink
    Definition Classes
    Area
  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. def childNamePriority: Byte

    Permalink
    Definition Classes
    Area
  8. def clearOnSet[T <: Data](that: T, address: BigInt, bitOffset: Int = 0): T

    Permalink
  9. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @throws( ... )
  10. def component: Component

    Permalink
    Definition Classes
    ContextUser
  11. def createAndDriveFlow[T <: Data](dataType: T, address: BigInt, bitOffset: Int = 0): Flow[T]

    Permalink

    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

    Permalink
  13. def createReadAndSetOnSet[T <: Data](dataType: T, address: BigInt, bitOffset: Int = 0): T

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

    Permalink

    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

    Permalink

    Create multi-words read register of type dataType

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

    Permalink

    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

    Permalink

    Create multi-words write and read register of type dataType

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

    Permalink

    Create multi-words write register of type dataType

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

    Permalink

    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

    Permalink

    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

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

    Permalink

    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

    Permalink

    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

    Permalink

    Drive and read that on multi-word

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

    Permalink

    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

    Permalink

    Drive that on multi-words

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

    Permalink
    Definition Classes
    AnyRef
  28. def equals(obj: Any): Boolean

    Permalink
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  29. def foreachReflectableNameables(doThat: (Any) ⇒ Unit): Unit

    Permalink
    Definition Classes
    Nameable
  30. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  31. def getConfig: BusSlaveFactoryConfig

    Permalink
  32. def getDisplayName(): String

    Permalink
    Definition Classes
    Nameable
  33. def getInstanceCounter: Int

    Permalink
    Definition Classes
    ContextUser
  34. def getMode: Byte

    Permalink
    Attributes
    protected
    Definition Classes
    Nameable
  35. def getName(default: String): String

    Permalink
    Definition Classes
    NameableByComponent → Nameable
  36. def getName(): String

    Permalink
    Definition Classes
    NameableByComponent → Nameable
  37. def getPartialName(): String

    Permalink
    Definition Classes
    Nameable
  38. def getRefOwnersChain(): List[Any]

    Permalink
    Definition Classes
    OwnableRef
  39. def getScalaLocationLong: String

    Permalink
    Definition Classes
    ScalaLocated
  40. def getScalaLocationShort: String

    Permalink
    Definition Classes
    ScalaLocated
  41. def getScalaTrace(): Throwable

    Permalink
    Definition Classes
    ScalaLocated
  42. val globalData: GlobalData

    Permalink
    Definition Classes
    GlobalDataUser
  43. def hashCode(): Int

    Permalink
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  44. def isCompletelyUnnamed: Boolean

    Permalink
    Definition Classes
    Nameable
  45. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  46. def isNamed: Boolean

    Permalink
    Definition Classes
    NameableByComponent → Nameable
  47. def isPriorityApplicable(namePriority: Byte): Boolean

    Permalink
    Definition Classes
    Nameable
  48. def isReading(address: BigInt): Bool

    Permalink

    Return true if the bus is reading

  49. def isUnnamed: Boolean

    Permalink
    Definition Classes
    Nameable
  50. def isWriting(address: BigInt): Bool

    Permalink

    Return true if the bus is writing

  51. def multiCycleRead(address: AddressMapping, cycles: BigInt): Unit

    Permalink
  52. var name: String

    Permalink
    Definition Classes
    Nameable
  53. var nameableRef: Nameable

    Permalink
    Attributes
    protected
    Definition Classes
    Nameable
  54. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  55. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  56. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  57. def onRead(address: BigInt, documentation: String = null)(doThat: ⇒ Unit): Unit

    Permalink

    Call doThat when a read transaction occurs on address

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

    Permalink

    Call doThat when a write transaction occurs on address

  59. def overrideLocalName(name: String): BusSlaveFactory.this.type

    Permalink
    Definition Classes
    Nameable
  60. var parentScope: ScopeStatement

    Permalink
    Definition Classes
    ContextUser
  61. def read[T <: Data](address: BigInt, bitMapping: (Int, Data)*): Unit

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

    Permalink

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

  63. def readAddress(address: AddressMapping): UInt

    Permalink
  64. def readAndClearOnSet[T <: Data](that: T, address: BigInt, bitOffset: Int = 0): T

    Permalink
  65. def readAndSetOnSet[T <: Data](that: T, address: BigInt, bitOffset: Int = 0): T

    Permalink
  66. def readAndWrite(that: Data, address: BigInt, bitOffset: Int = 0, documentation: String = null): Unit

    Permalink

    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

    Permalink

    Create the memory mapping to write/read that from address

  68. def readFire(): Bool

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

    Permalink

    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

    Permalink

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

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

    Permalink

    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]

    Permalink

    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]

    Permalink
  74. var refOwner: RefOwnerType

    Permalink
    Definition Classes
    OwnableRef
  75. def reflectNames(): Unit

    Permalink
    Definition Classes
    Nameable
  76. def rework[T](body: ⇒ T): T

    Permalink
    Definition Classes
    Area
  77. var scalaTrace: Throwable

    Permalink
    Definition Classes
    ScalaLocated
  78. def setCompositeName(nameable: Nameable, postfix: String, namePriority: Byte): BusSlaveFactory.this.type

    Permalink
    Definition Classes
    Nameable
  79. def setCompositeName(nameable: Nameable, postfix: String, weak: Boolean): BusSlaveFactory.this.type

    Permalink
    Definition Classes
    Nameable
  80. def setCompositeName(nameable: Nameable, postfix: String): BusSlaveFactory.this.type

    Permalink
    Definition Classes
    Nameable
  81. def setCompositeName(nameable: Nameable, namePriority: Byte): BusSlaveFactory.this.type

    Permalink
    Definition Classes
    Nameable
  82. def setCompositeName(nameable: Nameable, weak: Boolean): BusSlaveFactory.this.type

    Permalink
    Definition Classes
    Nameable
  83. def setCompositeName(nameable: Nameable): BusSlaveFactory.this.type

    Permalink
    Definition Classes
    Nameable
  84. def setConfig(value: BusSlaveFactoryConfig): BusSlaveFactory.this.type

    Permalink
  85. def setName(name: String, namePriority: Byte): BusSlaveFactory.this.type

    Permalink
    Definition Classes
    Nameable
  86. def setName(name: String, weak: Boolean): BusSlaveFactory.this.type

    Permalink
    Definition Classes
    Nameable
  87. def setName(name: String): BusSlaveFactory.this.type

    Permalink
    Definition Classes
    Nameable
  88. def setNameAsWeak(): BusSlaveFactory.this.type

    Permalink
    Definition Classes
    Nameable
  89. def setOnClear[T <: Data](that: T, address: BigInt, bitOffset: Int = 0): T

    Permalink
  90. def setOnSet[T <: Data](that: T, address: BigInt, bitOffset: Int = 0): T

    Permalink
  91. def setPartialName(name: String, namePriority: Byte, owner: Any): BusSlaveFactory.this.type

    Permalink
    Definition Classes
    Nameable
  92. def setPartialName(name: String, namePriority: Byte): BusSlaveFactory.this.type

    Permalink
    Definition Classes
    Nameable
  93. def setPartialName(name: String, weak: Boolean): BusSlaveFactory.this.type

    Permalink
    Definition Classes
    Nameable
  94. def setPartialName(owner: Nameable, name: String, namePriority: Byte): BusSlaveFactory.this.type

    Permalink
    Definition Classes
    Nameable
  95. def setPartialName(owner: Nameable, name: String, weak: Boolean): BusSlaveFactory.this.type

    Permalink
    Definition Classes
    Nameable
  96. def setPartialName(name: String): BusSlaveFactory.this.type

    Permalink
    Definition Classes
    Nameable
  97. def setPartialName(owner: Nameable, name: String): BusSlaveFactory.this.type

    Permalink
    Definition Classes
    Nameable
  98. def setRefOwner(that: Any): Unit

    Permalink
    Definition Classes
    OwnableRef
  99. def setScalaLocated(source: ScalaLocated): BusSlaveFactory.this.type

    Permalink
    Definition Classes
    ScalaLocated
  100. def setWeakName(name: String): BusSlaveFactory.this.type

    Permalink
    Definition Classes
    Nameable
  101. def setWordEndianness(value: Endianness): BusSlaveFactory

    Permalink

    Set the endianness during write/read multiword

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

    Permalink
    Definition Classes
    AnyRef
  103. def toString(): String

    Permalink
    Definition Classes
    Area → Nameable → AnyRef → Any
  104. def unsetName(): BusSlaveFactory.this.type

    Permalink
    Definition Classes
    Nameable
  105. def valCallback[T](ref: T, name: String): T

    Permalink
    Definition Classes
    ValCallbackRec → ValCallback
  106. def valCallbackOn(ref: Any, name: String, refs: Set[Any]): Unit

    Permalink
    Definition Classes
    ValCallbackRec
  107. def valCallbackRec(obj: Any, name: String): Unit

    Permalink
    Definition Classes
    Area → ValCallbackRec
  108. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  109. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  110. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  111. def withOffset(offset: Int): BusSlaveFactoryAddressWrapper

    Permalink
  112. def wordAddressInc: Int

    Permalink

    Address incrementation used by the read and write multi words registers

  113. def write[T <: Data](address: BigInt, bitMapping: (Int, Data)*): Unit

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

    Permalink

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

  115. def writeAddress(address: AddressMapping): UInt

    Permalink
  116. def writeByteEnable(): Bits

    Permalink

    Byte enable bits, defaulting to all ones

  117. def writeFire(): Bool

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

    Permalink

    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]

    Permalink
  120. def writeMultiWord(that: Data, address: BigInt, documentation: String = null): Unit

    Permalink

    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

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version ???) Use createReadAndWrite instead

  2. def finalize(): Unit

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

    (Since version ) see corresponding Javadoc for more information.

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