spinal.lib.bus.misc

BusSlaveFactoryDelayed

Related Doc: package misc

trait BusSlaveFactoryDelayed extends BusSlaveFactory

BusSlaveFactoryDelayed captures each primitives (BusSlaveFactoryElement) into a data-model

Example:
  1. class Apb3SlaveFactory(bus : Apb3) extends BusSlaveFactoryDelayed{
        override def build(): Unit = { ... }
        override def busDataWidth: Int = bus.config.dataWidth
     }
Linear Supertypes
BusSlaveFactory, Area, Nameable, ContextUser, ScalaLocated, GlobalDataUser, OwnableRef, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. BusSlaveFactoryDelayed
  2. BusSlaveFactory
  3. Area
  4. Nameable
  5. ContextUser
  6. ScalaLocated
  7. GlobalDataUser
  8. OwnableRef
  9. AnyRef
  10. 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 build(): Unit

    In this function you have to define the read/write logic thanks to element, elementsPerAddress and elementsPerRangeAddress This is the only thing with def busDataWidth that should be implement by class that extends BusSlaveFactoryDelay

  2. abstract def busDataWidth: Int

    Return the data width of the bus

    Return the data width of the bus

    Definition Classes
    BusSlaveFactory
  3. abstract def readAddress(): UInt

    Definition Classes
    BusSlaveFactory
  4. abstract def readHalt(): Unit

    Definition Classes
    BusSlaveFactory
  5. abstract def writeAddress(): UInt

    Definition Classes
    BusSlaveFactory
  6. abstract def writeHalt(): Unit

    Definition Classes
    BusSlaveFactory

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
    Definition Classes
    BusSlaveFactory
  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

    Create a writable Flow register of type dataType at address and placed at bitOffset in the word

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

    Definition Classes
    BusSlaveFactory
  10. 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

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

    Definition Classes
    BusSlaveFactory
  11. def createReadMultiWord[T <: Data](that: T, address: BigInt, documentation: String = null): T

    Create multi-words read register of type dataType

    Create multi-words read register of type dataType

    Definition Classes
    BusSlaveFactory
  12. 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

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

    Definition Classes
    BusSlaveFactory
  13. def createWriteAndReadMultiWord[T <: Data](that: T, address: BigInt, documentation: String = null): T

    Create multi-words write and read register of type dataType

    Create multi-words write and read register of type dataType

    Definition Classes
    BusSlaveFactory
  14. def createWriteMultiWord[T <: Data](that: T, address: BigInt, documentation: String = null): T

    Create multi-words write register of type dataType

    Create multi-words write register of type dataType

    Definition Classes
    BusSlaveFactory
  15. 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

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

    Definition Classes
    BusSlaveFactory
  16. def dataModelString(): String

  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

    Definition Classes
    BusSlaveFactory
  18. def doMappedElements(jobs: Seq[BusSlaveFactoryElement], askWrite: Bool, askRead: Bool, doWrite: Bool, doRead: Bool, writeData: Bits, readData: Bits): Unit

  19. def doMappedReadElements(jobs: Seq[BusSlaveFactoryElement], askRead: Bool, doRead: Bool, readData: Bits): Unit

  20. def doMappedWriteElements(jobs: Seq[BusSlaveFactoryElement], askWrite: Bool, doWrite: Bool, writeData: Bits): Unit

  21. def doNonStopWrite(writeData: Bits): Unit

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

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

    Definition Classes
    BusSlaveFactory
  23. 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

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

    Definition Classes
    BusSlaveFactory
  24. def driveAndReadMultiWord[T <: Data](that: T, address: BigInt, documentation: String = null): T

    Drive and read that on multi-word

    Drive and read that on multi-word

    Definition Classes
    BusSlaveFactory
  25. 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

    Emit on that a transaction when a write happen at address by using data placed at bitOffset in the word

    Definition Classes
    BusSlaveFactory
  26. def driveMultiWord[T <: Data](that: T, address: BigInt, documentation: String = null): T

    Drive that on multi-words

    Drive that on multi-words

    Definition Classes
    BusSlaveFactory
  27. val elements: ArrayBuffer[BusSlaveFactoryElement]

    Contains all elements created

  28. val elementsOk: HashSet[BusSlaveFactoryElement]

  29. val elementsPerAddress: LinkedHashMap[AddressMapping, ArrayBuffer[BusSlaveFactoryElement]]

    Contains all elements related to an address

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

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

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

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

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

    Definition Classes
    AnyRef → Any
  35. def getConfig: BusSlaveFactoryConfig

    Definition Classes
    BusSlaveFactory
  36. def getDisplayName(): String

    Definition Classes
    Nameable
  37. def getInstanceCounter: Int

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

    Definition Classes
    Nameable
  39. def getName(): String

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

    Definition Classes
    OwnableRef
  41. def getScalaLocationLong: String

    Definition Classes
    ScalaLocated
  42. def getScalaLocationShort: String

    Definition Classes
    ScalaLocated
  43. def getScalaTrace(): Throwable

    Definition Classes
    ContextUser → ScalaLocated
  44. val globalData: GlobalData

    Definition Classes
    GlobalDataUser
  45. def hashCode(): Int

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

    Definition Classes
    Any
  47. def isNamed: Boolean

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

    Return true if the bus is reading

    Return true if the bus is reading

    Definition Classes
    BusSlaveFactory
  49. def isUnnamed: Boolean

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

    Return true if the bus is writing

    Return true if the bus is writing

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

    Definition Classes
    BusSlaveFactory
  52. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  53. def nonStopWrite[T <: Data](that: T, bitOffset: Int = 0, documentation: String = null): T

    Permanently assign that by the bus write data from bitOffset

    Permanently assign that by the bus write data from bitOffset

    Definition Classes
    BusSlaveFactoryDelayedBusSlaveFactory
  54. final def notify(): Unit

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

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

    Call doThat when a read transaction occurs on address

    Call doThat when a read transaction occurs on address

    Definition Classes
    BusSlaveFactory
  57. def onReadPrimitive(address: AddressMapping, haltSensitive: Boolean, documentation: String)(doThat: ⇒ Unit): Unit

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

    Call doThat when a write transaction occurs on address

    Call doThat when a write transaction occurs on address

    Definition Classes
    BusSlaveFactory
  59. def onWritePrimitive(address: AddressMapping, haltSensitive: Boolean, documentation: String)(doThat: ⇒ Unit): Unit

  60. var parentScope: ScopeStatement

    Definition Classes
    ContextUser
  61. def printDataModel(): Unit

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

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

    Definition Classes
    BusSlaveFactory
  63. def readAddress(address: AddressMapping): UInt

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

    Definition Classes
    BusSlaveFactory
  65. 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

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

    Definition Classes
    BusSlaveFactory
  66. def readAndWriteMultiWord(that: Data, address: BigInt, documentation: String = null): Unit

    Create the memory mapping to write/read that from address

    Create the memory mapping to write/read that from address

    Definition Classes
    BusSlaveFactory
  67. 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

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

    Definition Classes
    BusSlaveFactory
  68. def readPrimitive[T <: Data](that: T, address: AddressMapping, bitOffset: Int, documentation: String): Unit

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

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

    Definition Classes
    BusSlaveFactory
  70. 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.

    Definition Classes
    BusSlaveFactory
    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

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

    Definition Classes
    BusSlaveFactory
  72. var refOwner: RefOwnerType

    Definition Classes
    OwnableRef
  73. def reflectNames(): Unit

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

    Definition Classes
    Nameable
  75. def setCompositeName(nameable: Nameable, postfix: String): BusSlaveFactoryDelayed.this.type

    Definition Classes
    Nameable
  76. def setCompositeName(nameable: Nameable, weak: Boolean): BusSlaveFactoryDelayed.this.type

    Definition Classes
    Nameable
  77. def setCompositeName(nameable: Nameable): BusSlaveFactoryDelayed.this.type

    Definition Classes
    Nameable
  78. def setConfig(value: BusSlaveFactoryConfig): BusSlaveFactoryDelayed.this.type

    Definition Classes
    BusSlaveFactory
  79. def setName(name: String, weak: Boolean): BusSlaveFactoryDelayed.this.type

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

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

    Definition Classes
    Nameable
  82. def setPartialName(name: String): BusSlaveFactoryDelayed.this.type

    Definition Classes
    Nameable
  83. def setPartialName(owner: Nameable, name: String): BusSlaveFactoryDelayed.this.type

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

    Definition Classes
    OwnableRef
  85. def setScalaLocated(source: ScalaLocated): BusSlaveFactoryDelayed.this.type

    Definition Classes
    ScalaLocated
  86. def setWeakName(name: String): BusSlaveFactoryDelayed.this.type

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

    Set the endianness during write/read multiword

    Set the endianness during write/read multiword

    Definition Classes
    BusSlaveFactory
  88. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  89. def toString(): String

    Definition Classes
    Area → Nameable → AnyRef → Any
  90. def unsetName(): BusSlaveFactoryDelayed.this.type

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

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

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

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

    Address incrementation used by the read and write multi words registers

    Address incrementation used by the read and write multi words registers

    Definition Classes
    BusSlaveFactory
  95. def write[T <: Data](address: BigInt, bitMapping: (Int, Data)*): Unit

    Definition Classes
    BusSlaveFactory
  96. 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

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

    Definition Classes
    BusSlaveFactory
  97. def writeAddress(address: AddressMapping): UInt

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

    Definition Classes
    BusSlaveFactory
  99. 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

    Definition Classes
    BusSlaveFactory
  100. def writePrimitive[T <: Data](that: T, address: AddressMapping, bitOffset: Int, documentation: String): Unit

Deprecated Value Members

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

    Definition Classes
    BusSlaveFactory
    Annotations
    @deprecated
    Deprecated

    Use createReadAndWrite instead

Inherited from BusSlaveFactory

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