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, Nameable, ContextUser, ScalaLocated, GlobalDataUser, OwnableRef, AnyRef, Any
Known Subclasses
Apb3SlaveFactory, AxiLite4SlaveFactory, AvalonMMSlaveFactory, BusSlaveFactoryAddressWrapper, BusSlaveFactoryDelayed, AsyncMemoryBusFactory
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
    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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clearOnSet[T <: Data](that: T, address: BigInt, bitOffset: Int = 0): T
  7. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  8. def component: Component
    Definition Classes
    ContextUser
  9. 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

  10. def createReadAndClearOnSet[T <: Data](dataType: T, address: BigInt, bitOffset: Int = 0): T
  11. 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

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

    Create multi-words read register of type dataType

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

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

    Create multi-words write and read register of type dataType

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

    Create multi-words write register of type dataType

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

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

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

    Instanciate 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

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

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

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

    Drive and read that on multi-word

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

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

    Drive that on multi-words

  23. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  25. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  26. def foreachReflectableNameables(doThat: (Any) ⇒ Unit): Unit
    Definition Classes
    Nameable
  27. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  28. def getConfig: BusSlaveFactoryConfig
  29. def getDisplayName(): String
    Definition Classes
    Nameable
  30. def getInstanceCounter: Int
    Definition Classes
    ContextUser
  31. def getName(default: String): String
    Definition Classes
    Nameable
  32. def getName(): String
    Definition Classes
    Nameable
  33. def getRefOwnersChain(): List[Any]
    Definition Classes
    OwnableRef
  34. def getScalaLocationLong: String
    Definition Classes
    ScalaLocated
  35. def getScalaLocationShort: String
    Definition Classes
    ScalaLocated
  36. def getScalaTrace(): Throwable
    Definition Classes
    ScalaLocated
  37. val globalData: GlobalData
    Definition Classes
    GlobalDataUser
  38. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  39. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  40. def isNamed: Boolean
    Definition Classes
    Nameable
  41. def isPriorityApplicable(namePriority: Byte): Boolean
    Definition Classes
    Nameable
  42. def isReading(address: BigInt): Bool

    Return true if the bus is reading

  43. def isUnnamed: Boolean
    Definition Classes
    Nameable
  44. def isWriting(address: BigInt): Bool

    Return true if the bus is writing

  45. def multiCycleRead(address: AddressMapping, cycles: BigInt): Unit
  46. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  47. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  48. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  49. def onRead(address: BigInt, documentation: String = null)(doThat: ⇒ Unit): Unit

    Call doThat when a read transaction occurs on address

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

    Call doThat when a write transaction occurs on address

  51. val parentScope: ScopeStatement
    Definition Classes
    ContextUser
  52. 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

  53. def readAddress(address: AddressMapping): UInt
  54. def readAndClearOnSet[T <: Data](that: T, address: BigInt, bitOffset: Int = 0): T
  55. 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

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

    Create the memory mapping to write/read that from address

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

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

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

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

  60. def readSyncMemWordAligned[T <: Data](mem: Mem[T], addressOffset: BigInt, bitOffset: Int = 0): Mem[T]
  61. val refOwner: RefOwnerType
    Definition Classes
    OwnableRef
    Annotations
    @dontName()
  62. def reflectNames(): Unit
    Definition Classes
    Area
  63. def setCompositeName(nameable: Nameable, postfix: String, namePriority: Byte): BusSlaveFactory.this.type
    Definition Classes
    Nameable
  64. def setCompositeName(nameable: Nameable, postfix: String, weak: Boolean): BusSlaveFactory.this.type
    Definition Classes
    Nameable
  65. def setCompositeName(nameable: Nameable, postfix: String): BusSlaveFactory.this.type
    Definition Classes
    Nameable
  66. def setCompositeName(nameable: Nameable, namePriority: Byte): BusSlaveFactory.this.type
    Definition Classes
    Nameable
  67. def setCompositeName(nameable: Nameable, weak: Boolean): BusSlaveFactory.this.type
    Definition Classes
    Nameable
  68. def setCompositeName(nameable: Nameable): BusSlaveFactory.this.type
    Definition Classes
    Nameable
  69. def setConfig(value: BusSlaveFactoryConfig): BusSlaveFactory.this.type
  70. def setName(name: String, namePriority: Byte): BusSlaveFactory.this.type
    Definition Classes
    Nameable
  71. def setName(name: String, weak: Boolean): BusSlaveFactory.this.type
    Definition Classes
    Nameable
  72. def setName(name: String): BusSlaveFactory.this.type
    Definition Classes
    Nameable
  73. def setPartialName(name: String, namePriority: Byte): BusSlaveFactory.this.type
    Definition Classes
    Nameable
  74. def setPartialName(name: String, weak: Boolean): BusSlaveFactory.this.type
    Definition Classes
    Nameable
  75. def setPartialName(owner: Nameable, name: String, namePriority: Byte): BusSlaveFactory.this.type
    Definition Classes
    Nameable
  76. def setPartialName(owner: Nameable, name: String, weak: Boolean): BusSlaveFactory.this.type
    Definition Classes
    Nameable
  77. def setPartialName(name: String): BusSlaveFactory.this.type
    Definition Classes
    Nameable
  78. def setPartialName(owner: Nameable, name: String): BusSlaveFactory.this.type
    Definition Classes
    Nameable
  79. def setRefOwner(that: Any): Unit
    Definition Classes
    OwnableRef
  80. def setScalaLocated(source: ScalaLocated): BusSlaveFactory.this.type
    Definition Classes
    ScalaLocated
  81. def setWeakName(name: String): BusSlaveFactory.this.type
    Definition Classes
    Nameable
  82. def setWordEndianness(value: Endianness): BusSlaveFactory

    Set the endianness during write/read multiword

  83. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  84. def toString(): String
    Definition Classes
    Area → Nameable → AnyRef → Any
  85. def unsetName(): BusSlaveFactory.this.type
    Definition Classes
    Nameable
  86. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  87. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  88. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  89. def wordAddressInc: Int

    Address incrementation used by the read and write multi words registers

  90. def write[T <: Data](address: BigInt, bitMapping: (Int, Data)*): Unit
  91. 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

  92. def writeAddress(address: AddressMapping): UInt
  93. def writeMemWordAligned[T <: Data](mem: Mem[T], addressOffset: BigInt, bitOffset: Int = 0): Mem[T]
  94. 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 followings addresses

Deprecated Value Members

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

    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