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
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BusSlaveFactory
  2. Area
  3. Nameable
  4. ContextUser
  5. ScalaLocated
  6. GlobalDataUser
  7. OwnableRef
  8. AnyRef
  9. 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. final def asInstanceOf[T0]: T0

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

    Permalink
  7. def clone(): AnyRef

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

    Permalink
    Definition Classes
    ContextUser
  9. 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

  10. def createReadAndClearOnSet[T <: Data](dataType: T, address: BigInt, bitOffset: Int = 0): T

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

    Permalink
  12. 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

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

    Permalink

    Create multi-words read register of type dataType

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

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

    Permalink

    Create multi-words write and read register of type dataType

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

    Permalink

    Create multi-words write register of type dataType

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

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

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

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

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

    Permalink

    Drive and read that on multi-word

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

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

    Permalink

    Drive that on multi-words

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

    Permalink
    Definition Classes
    AnyRef
  25. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  26. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  27. def foreachReflectableNameables(doThat: (Any) ⇒ Unit): Unit

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

    Permalink
    Definition Classes
    AnyRef → Any
  29. def getConfig: BusSlaveFactoryConfig

    Permalink
  30. def getDisplayName(): String

    Permalink
    Definition Classes
    Nameable
  31. def getInstanceCounter: Int

    Permalink
    Definition Classes
    ContextUser
  32. def getMode: Byte

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

    Permalink
    Definition Classes
    Nameable
  34. def getName(): String

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

    Permalink
    Definition Classes
    OwnableRef
  36. def getScalaLocationLong: String

    Permalink
    Definition Classes
    ScalaLocated
  37. def getScalaLocationShort: String

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

    Permalink
    Definition Classes
    ScalaLocated
  39. val globalData: GlobalData

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

    Permalink
    Definition Classes
    AnyRef → Any
  41. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  42. def isNamed: Boolean

    Permalink
    Definition Classes
    Nameable
  43. def isPriorityApplicable(namePriority: Byte): Boolean

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

    Permalink

    Return true if the bus is reading

  45. def isUnnamed: Boolean

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

    Permalink

    Return true if the bus is writing

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

    Permalink
  48. var name: String

    Permalink
    Attributes
    protected
    Definition Classes
    Nameable
  49. var nameableRef: Nameable

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

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

    Permalink
    Definition Classes
    AnyRef
  52. final def notifyAll(): Unit

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

    Permalink

    Call doThat when a read transaction occurs on address

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

    Permalink

    Call doThat when a write transaction occurs on address

  55. var parentScope: ScopeStatement

    Permalink
    Definition Classes
    ContextUser
  56. 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

  57. def readAddress(address: AddressMapping): UInt

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

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

    Permalink
  60. 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

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

    Permalink

    Create the memory mapping to write/read that from address

  62. 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 followings addresses

  63. def readStreamNonBlocking[T <: Data](that: Stream[T], address: BigInt, validBitOffset: Int, payloadBitOffset: Int): Unit

    Permalink

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

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

  65. def readSyncMemWordAligned[T <: Data](mem: Mem[T], addressOffset: BigInt, bitOffset: Int = 0): Mem[T]

    Permalink
  66. var refOwner: RefOwnerType

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
  79. def setPartialName(name: String, namePriority: Byte): BusSlaveFactory.this.type

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

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

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

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

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

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

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

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

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

    Permalink

    Set the endianness during write/read multiword

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

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

    Permalink
    Definition Classes
    AreaNameable → AnyRef → Any
  91. def unsetName(): BusSlaveFactory.this.type

    Permalink
    Definition Classes
    Nameable
  92. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  93. final def wait(arg0: Long, arg1: Int): Unit

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  95. def wordAddressInc: Int

    Permalink

    Address incrementation used by the read and write multi words registers

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

    Permalink
  97. 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

  98. def writeAddress(address: AddressMapping): UInt

    Permalink
  99. def writeMemWordAligned[T <: Data](mem: Mem[T], addressOffset: BigInt, bitOffset: Int = 0): Mem[T]

    Permalink
  100. 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 followings 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

Inherited from Area

Inherited from Nameable

Inherited from ContextUser

Inherited from ScalaLocated

Inherited from GlobalDataUser

Inherited from OwnableRef

Inherited from AnyRef

Inherited from Any

Ungrouped