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, ContextUser, GlobalDataUser, Nameable, OwnableRef, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. BusSlaveFactory
  2. Area
  3. ScalaLocated
  4. ContextUser
  5. GlobalDataUser
  6. Nameable
  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(that: Data, bitOffset: Int = 0): Unit

    Permanently assign that by the bus write data from bitOffset

  3. abstract def onRead(doThat: ⇒ Unit): Unit

    Call doThat when a read transaction occurs

  4. abstract def onRead(address: BigInt)(doThat: ⇒ Unit): Unit

    Call doThat when a read transaction occurs on address

  5. abstract def onWrite(doThat: ⇒ Unit): Unit

    Call doThat when a write transcation occurs

  6. abstract def onWrite(address: BigInt)(doThat: ⇒ Unit): Unit

    Call doThat when a write transaction occurs on address

  7. abstract def read(that: Data, address: BigInt, bitOffset: Int = 0): Unit

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

  8. abstract 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

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

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

    Create multi-words read register of type dataType

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

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

    Create multi-words write and read register of type dataType

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

    Create multi-words write register of type dataType

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

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

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

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

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

    Drive and read that on multi-word

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

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

    Drive that on multi-words

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

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

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

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

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

    Definition Classes
    AnyRef → Any
  26. def getConfig: BusSlaveFactoryConfig

  27. def getDisplayName(): String

    Definition Classes
    Nameable
  28. def getInstanceCounter: Int

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

    Definition Classes
    Nameable
  30. def getName(): String

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

    Definition Classes
    OwnableRef
  32. def getScalaLocationLong: String

    Definition Classes
    ScalaLocated
  33. def getScalaLocationShort: String

    Definition Classes
    ScalaLocated
  34. val globalData: GlobalData

    Definition Classes
    GlobalDataUser
  35. def hashCode(): Int

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

    Definition Classes
    Any
  37. def isNamed: Boolean

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

    Return true if the bus is reading

  39. def isUnnamed: Boolean

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

    Return true if the bus is writing

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

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

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

    Definition Classes
    AnyRef
  44. def readAndWrite(that: Data, address: BigInt, bitOffset: Int = 0): Unit

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

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

    Create the memory mapping to write/read that from address

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

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

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

  49. var refOwner: RefOwnerType

    Definition Classes
    OwnableRef
  50. def reflectNames(): Unit

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

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

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

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

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

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

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

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

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

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

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

    Definition Classes
    OwnableRef
  62. def setWeakName(name: String): BusSlaveFactory.this.type

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

    Set the endianness during write/read multiword

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

    Definition Classes
    AnyRef
  65. def toString(): String

    Definition Classes
    Area → Nameable → AnyRef → Any
  66. def unsetName(): Unit

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

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

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

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

    Address incrementation used by the read and write multi words registers

  71. 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 ContextUser

Inherited from GlobalDataUser

Inherited from Nameable

Inherited from OwnableRef

Inherited from AnyRef

Inherited from Any

Ungrouped