Trait

spinal.lib.bus.misc

BusSlaveFactoryDelayed

Related Doc: package misc

Permalink

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
Visibility
  1. Public
  2. All

Type Members

  1. abstract type RefOwnerType

    Permalink
    Definition Classes
    OwnableRef

Abstract Value Members

  1. abstract def build(): Unit

    Permalink

    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

    Permalink

    Return the data width of the bus

    Return the data width of the bus

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

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

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

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

    Permalink
    Definition Classes
    BusSlaveFactory

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
    Definition Classes
    BusSlaveFactory
  5. final def asInstanceOf[T0]: T0

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

    Permalink
    Definition Classes
    BusSlaveFactory
  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @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

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

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

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

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

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

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

    Permalink

    Create multi-words read register of type dataType

    Create multi-words read register of type dataType

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

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

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

    Permalink

    Create multi-words write and read register of type dataType

    Create multi-words write and read register of type dataType

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

    Permalink

    Create multi-words write register of type dataType

    Create multi-words write register of type dataType

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

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

    Definition Classes
    BusSlaveFactory
  18. def dataModelString(): String

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

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

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

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

    Permalink
  23. def doNonStopWrite(writeData: Bits): Unit

    Permalink
  24. def drive[T <: Data](address: BigInt, bitMapping: (Int, Data)*): Unit

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

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

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

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

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

    Permalink

    Drive and read that on multi-word

    Drive and read that on multi-word

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

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

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

    Permalink

    Drive that on multi-words

    Drive that on multi-words

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

    Permalink

    Contains all elements created

  31. val elementsOk: HashSet[BusSlaveFactoryElement]

    Permalink
  32. val elementsPerAddress: LinkedHashMap[AddressMapping, ArrayBuffer[BusSlaveFactoryElement]]

    Permalink

    Contains all elements related to an address

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  35. def foreachReflectableNameables(doThat: (Any) ⇒ Unit): Unit

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

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  37. def getConfig: BusSlaveFactoryConfig

    Permalink
    Definition Classes
    BusSlaveFactory
  38. def getDisplayName(): String

    Permalink
    Definition Classes
    Nameable
  39. def getInstanceCounter: Int

    Permalink
    Definition Classes
    ContextUser
  40. def getMode: Byte

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

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

    Permalink
    Definition Classes
    Nameable
  43. def getPartialName(): String

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

    Permalink
    Definition Classes
    OwnableRef
  45. def getScalaLocationLong: String

    Permalink
    Definition Classes
    ScalaLocated
  46. def getScalaLocationShort: String

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

    Permalink
    Definition Classes
    ScalaLocated
  48. val globalData: GlobalData

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

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  50. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  51. def isNamed: Boolean

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

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

    Permalink

    Return true if the bus is reading

    Return true if the bus is reading

    Definition Classes
    BusSlaveFactory
  54. def isUnnamed: Boolean

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

    Permalink

    Return true if the bus is writing

    Return true if the bus is writing

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

    Permalink
    Definition Classes
    BusSlaveFactory
  57. var name: String

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

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

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

    Permalink

    Permanently assign that by the bus write data from bitOffset

    Permanently assign that by the bus write data from bitOffset

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  62. final def notifyAll(): Unit

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

    Permalink

    Call doThat when a read transaction occurs on address

    Call doThat when a read transaction occurs on address

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

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

    Permalink

    Call doThat when a write transaction occurs on address

    Call doThat when a write transaction occurs on address

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

    Permalink
  67. var parentScope: ScopeStatement

    Permalink
    Definition Classes
    ContextUser
  68. def printDataModel(): Unit

    Permalink
  69. def read[T <: Data](address: BigInt, bitMapping: (Int, Data)*): Unit

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

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

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

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

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

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

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

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

    Permalink

    Create the memory mapping to write/read that from address

    Create the memory mapping to write/read that from address

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

    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
  77. def readPrimitive[T <: Data](that: T, address: AddressMapping, bitOffset: Int, documentation: String): Unit

    Permalink
  78. def readStreamNonBlocking[T <: Data](that: Stream[T], address: BigInt, validBitOffset: Int, payloadBitOffset: Int, validInverted: Boolean = false): Unit

    Permalink

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

    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

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

    Permalink
    Definition Classes
    BusSlaveFactory
  81. var refOwner: RefOwnerType

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

    Permalink
    Definition Classes
    Nameable
  83. def setCompositeName(nameable: Nameable, postfix: String, namePriority: Byte): BusSlaveFactoryDelayed.this.type

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

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

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

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

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

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

    Permalink
    Definition Classes
    BusSlaveFactory
  90. def setName(name: String, namePriority: Byte): BusSlaveFactoryDelayed.this.type

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

    Permalink
    Definition Classes
    Nameable
  92. def setName(name: String): BusSlaveFactoryDelayed.this.type

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

    Permalink
    Definition Classes
    BusSlaveFactory
  94. def setPartialName(name: String, namePriority: Byte): BusSlaveFactoryDelayed.this.type

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

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

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

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

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

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

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

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

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

    Permalink

    Set the endianness during write/read multiword

    Set the endianness during write/read multiword

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

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

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

    Permalink
    Definition Classes
    Nameable
  107. final def wait(arg0: Long, arg1: Int): Unit

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  109. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  110. def withOffset(offset: Int): BusSlaveFactoryAddressWrapper

    Permalink
    Definition Classes
    BusSlaveFactory
  111. def wordAddressInc: Int

    Permalink

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

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

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

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

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

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

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

    Permalink

Deprecated Value Members

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

    Permalink
    Definition Classes
    BusSlaveFactory
    Annotations
    @deprecated
    Deprecated

    (Since version ???) Use createReadAndWrite instead

  2. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

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