spinal.lib.bus.misc

BusSlaveFactory

Related Doc: package misc

trait BusSlaveFactory extends Area

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

Linear Supertypes
Area, ScalaLocated, Nameable, ContextUser, GlobalDataUser, OwnableRef, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. BusSlaveFactory
  2. Area
  3. ScalaLocated
  4. Nameable
  5. ContextUser
  6. GlobalDataUser
  7. OwnableRef
  8. AnyRef
  9. Any
  1. Hide All
  2. Show all
Learn more about member selection
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 readAdress(): 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. var _config: BusSlaveFactoryConfig

    Configuration of the BusSlaveFactory

    Configuration of the BusSlaveFactory

    Attributes
    protected
  5. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  6. def clone(): AnyRef

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

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

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

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

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

  11. def createReadMultiWord[T <: Data](that: T, address: BigInt): T

    Create multi-words read register of type dataType

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

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

  13. def createWriteAndReadMultiWord[T <: Data](that: T, address: BigInt): T

    Create multi-words write and read register of type dataType

  14. def createWriteMultiWord[T <: Data](that: T, address: BigInt): T

    Create multi-words write register of type dataType

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

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

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

  17. def drive[T <: Data](that: T, address: BigInt, bitOffset: Int = 0): T

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

  18. def driveAndRead[T <: Data](that: T, address: BigInt, bitOffset: Int = 0): T

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

  19. def driveAndReadMultiWord[T <: Data](that: T, address: BigInt): T

    Drive and read that on multi-word

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

  21. def driveMultiWord[T <: Data](that: T, address: BigInt): T

    Drive that on multi-words

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

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

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

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

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

    Definition Classes
    AnyRef → Any
  27. def getConfig: BusSlaveFactoryConfig

  28. def getDisplayName(): String

    Definition Classes
    Nameable
  29. def getInstanceCounter: Int

    Definition Classes
    ContextUser
  30. def getName(default: String): String

    Definition Classes
    Nameable
  31. def getName(): String

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

    Definition Classes
    OwnableRef
  33. def getScalaLocationLong: String

    Definition Classes
    ScalaLocated
  34. def getScalaLocationShort: String

    Definition Classes
    ScalaLocated
  35. val globalData: GlobalData

    Definition Classes
    GlobalDataUser
  36. def hashCode(): Int

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

    Definition Classes
    Any
  38. def isNamed: Boolean

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

    Return true if the bus is reading

  40. def isUnnamed: Boolean

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

    Return true if the bus is writing

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

  43. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  44. final def notify(): Unit

    Definition Classes
    AnyRef
  45. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  46. def onRead(address: BigInt)(doThat: ⇒ Unit): Unit

    Call doThat when a read transaction occurs on address

  47. def onWrite(address: BigInt)(doThat: ⇒ Unit): Unit

    Call doThat when a write transaction occurs on address

  48. var parentScope: ScopeStatement

    Definition Classes
    ContextUser
  49. def read[T <: Data](that: T, address: BigInt, bitOffset: Int = 0): T

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

  50. def readAddress(address: AddressMapping): UInt

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

  52. def readAndWrite(that: Data, address: BigInt, bitOffset: Int = 0): Unit

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

  53. def readAndWriteMultiWord(that: Data, address: BigInt): Unit

    Create the memory mapping to write/read that from address

  54. def readMultiWord(that: Data, address: BigInt): Unit

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

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

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

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

  58. var refOwner: RefOwnerType

    Definition Classes
    OwnableRef
  59. def reflectNames(): Unit

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

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

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

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

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

  65. def setName(name: String, weak: Boolean): BusSlaveFactory.this.type

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

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

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

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

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

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

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

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

    Set the endianness during write/read multiword

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

    Definition Classes
    AnyRef
  75. def toString(): String

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

    Definition Classes
    Nameable
  77. final def wait(): Unit

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

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

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

    Address incrementation used by the read and write multi words registers

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

  82. def write[T <: Data](that: T, address: BigInt, bitOffset: Int = 0): T

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

  83. def writeAddress(address: AddressMapping): UInt

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

  85. def writeMultiWord(that: Data, address: BigInt): 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 ScalaLocated

Inherited from Nameable

Inherited from ContextUser

Inherited from GlobalDataUser

Inherited from OwnableRef

Inherited from AnyRef

Inherited from Any

Ungrouped