c

spinal.lib.bus.misc

BusSlaveFactoryAddressWrapper

class BusSlaveFactoryAddressWrapper extends BusSlaveFactory

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BusSlaveFactoryAddressWrapper
  2. BusSlaveFactory
  3. Area
  4. OverridedEqualsHashCode
  5. ValCallbackRec
  6. ValCallback
  7. NameableByComponent
  8. Nameable
  9. ContextUser
  10. ScalaLocated
  11. GlobalDataUser
  12. OwnableRef
  13. AnyRef
  14. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new BusSlaveFactoryAddressWrapper(f: BusSlaveFactory, addressOffset: BigInt)

Type Members

  1. abstract type RefOwnerType
    Definition Classes
    OwnableRef

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
    Definition Classes
    BusSlaveFactory
  5. val _context: Capture
    Definition Classes
    Area
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def busDataWidth: Int

    Return the data width of the bus

    Return the data width of the bus

    Definition Classes
    BusSlaveFactoryAddressWrapper → BusSlaveFactory
  8. def childNamePriority: Byte
    Definition Classes
    Area
  9. def clearOnSet[T <: Data](that: T, address: BigInt, bitOffset: Int = 0): T
    Definition Classes
    BusSlaveFactory
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @IntrinsicCandidate()
  11. def component: Component
    Definition Classes
    ContextUser
  12. def createAndDriveFlow[T <: Data](dataType: T, address: BigInt, bitOffset: Int = 0, checkByteEnable: Boolean = false): 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

    checkByteEnable

    do not trigger flow if byte enable is all zero. See https://github.com/SpinalHDL/SpinalHDL/issues/1265 for the discussion about this behaviour.

    Definition Classes
    BusSlaveFactory
  13. def createReadAndClearOnSet[T <: Data](dataType: T, address: BigInt, bitOffset: Int = 0): T
    Definition Classes
    BusSlaveFactory
  14. def createReadAndSetOnSet[T <: Data](dataType: T, address: BigInt, bitOffset: Int = 0): T
    Definition Classes
    BusSlaveFactory
  15. 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
  16. 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
  17. 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
  18. 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
  19. 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
  20. 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
  21. def doBitsAccumulationAndClearOnRead(that: Bits, address: BigInt, bitOffset: Int = 0): Unit

    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
  22. def drive[T <: Data](address: BigInt, bitMapping: (Int, Data)*): Unit
    Definition Classes
    BusSlaveFactory
  23. 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
  24. 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
  25. 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
  26. def driveFlow[T <: Data](that: Flow[T], address: BigInt, bitOffset: Int = 0, checkByteEnable: Boolean = false): 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

    checkByteEnable

    do not trigger flow if byte enable is all zero. See https://github.com/SpinalHDL/SpinalHDL/issues/1265 for the discussion about this behaviour.

    Definition Classes
    BusSlaveFactory
  27. 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
  28. def driveStream[T <: Data](that: Stream[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. Block the write transaction until the transaction succeeds (stream becomes ready).

    Definition Classes
    BusSlaveFactory
  29. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  30. def equals(obj: Any): Boolean
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  31. def foreachReflectableNameables(doThat: (Any) ⇒ Unit): Unit
    Definition Classes
    Nameable
  32. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  33. def getConfig: BusSlaveFactoryConfig
    Definition Classes
    BusSlaveFactoryAddressWrapper → BusSlaveFactory
  34. def getDisplayName(): String
    Definition Classes
    Nameable
  35. def getInstanceCounter: Int
    Definition Classes
    ContextUser
  36. def getMode: Byte
    Attributes
    protected
    Definition Classes
    Nameable
  37. def getName(default: String): String
    Definition Classes
    NameableByComponent → Nameable
  38. def getName(): String
    Definition Classes
    NameableByComponent → Nameable
  39. def getPartialName(): String
    Definition Classes
    Nameable
  40. def getPath(from: Component, to: Component): Seq[Component]
    Definition Classes
    NameableByComponent
  41. def getRefOwnersChain(): List[Any]
    Definition Classes
    OwnableRef
  42. def getScalaLocationLong: String
    Definition Classes
    ScalaLocated
  43. def getScalaLocationShort: String
    Definition Classes
    ScalaLocated
  44. def getScalaTrace(): Throwable
    Definition Classes
    ScalaLocated
  45. val globalData: GlobalData
    Definition Classes
    GlobalDataUser
  46. def hashCode(): Int
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  47. def isCompletelyUnnamed: Boolean
    Definition Classes
    Nameable
  48. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  49. final def isNamed: Boolean
    Definition Classes
    Nameable
  50. def isPriorityApplicable(namePriority: Byte): Boolean
    Definition Classes
    Nameable
  51. def isReading(address: BigInt): Bool

    Return true if the bus is reading

    Return true if the bus is reading

    Definition Classes
    BusSlaveFactory
  52. def isUnnamed: Boolean
    Definition Classes
    NameableByComponent → Nameable
  53. def isWriting(address: BigInt): Bool

    Return true if the bus is writing

    Return true if the bus is writing

    Definition Classes
    BusSlaveFactory
  54. def multiCycleRead(address: AddressMapping, cycles: BigInt): Unit
    Definition Classes
    BusSlaveFactory
  55. val name: String
    Definition Classes
    Nameable
  56. val nameableRef: Nameable
    Attributes
    protected
    Definition Classes
    Nameable
    Annotations
    @DontName()
  57. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  58. def nonStopWrite[T <: Data](that: T, bitOffset: Int, documentation: String): T

    Permanently assign that by the bus write data from bitOffset

    Permanently assign that by the bus write data from bitOffset

    Definition Classes
    BusSlaveFactoryAddressWrapper → BusSlaveFactory
  59. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  60. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  61. 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
  62. def onReadPrimitive(address: AddressMapping, haltSensitive: Boolean, documentation: String)(doThat: ⇒ Unit): Unit
    Definition Classes
    BusSlaveFactoryAddressWrapper → BusSlaveFactory
  63. 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
  64. def onWritePrimitive(address: AddressMapping, haltSensitive: Boolean, documentation: String)(doThat: ⇒ Unit): Unit
    Definition Classes
    BusSlaveFactoryAddressWrapper → BusSlaveFactory
  65. def overrideLocalName(name: String): BusSlaveFactoryAddressWrapper.this.type
    Definition Classes
    Nameable
  66. val parentScope: ScopeStatement
    Definition Classes
    ContextUser
  67. def read[T <: Data](address: BigInt, bitMapping: (Int, Data)*): Unit
    Definition Classes
    BusSlaveFactory
  68. 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
  69. def readAddress(): UInt
    Definition Classes
    BusSlaveFactoryAddressWrapper → BusSlaveFactory
  70. def readAddress(address: AddressMapping): UInt
    Definition Classes
    BusSlaveFactory
  71. def readAndClearOnSet[T <: Data](that: T, address: BigInt, bitOffset: Int = 0): T
    Definition Classes
    BusSlaveFactory
  72. def readAndSetOnSet[T <: Data](that: T, address: BigInt, bitOffset: Int = 0): T
    Definition Classes
    BusSlaveFactory
  73. 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
  74. 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
  75. def readError(): Unit
    Definition Classes
    BusSlaveFactory
  76. val readErrorFlag: Bool
    Definition Classes
    BusSlaveFactory
  77. def readFire(): Bool
    Definition Classes
    BusSlaveFactory
  78. def readHalt(): Unit
    Definition Classes
    BusSlaveFactoryAddressWrapper → BusSlaveFactory
  79. 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 following addresses.

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

    Definition Classes
    BusSlaveFactory
  80. def readPrimitive[T <: Data](that: T, address: AddressMapping, bitOffset: Int, documentation: String): Unit
    Definition Classes
    BusSlaveFactoryAddressWrapper → BusSlaveFactory
  81. def readStreamBlockCycles[T <: Data](that: Stream[T], address: BigInt, blockCycles: UInt, timeout: Bool = null): Unit

    Same as readStreamNonBlocking, but block the bus for at most blockCycles before returning the NACK.

    Same as readStreamNonBlocking, but block the bus for at most blockCycles before returning the NACK.

    T

    type of stream payload

    that

    data to read over bus

    address

    address to map at

    blockCycles

    cycles to block read transaction before returning NACK

    timeout

    whether the read transaction timed out (returned NACK)

    Definition Classes
    BusSlaveFactory
  82. def readStreamNonBlocking[T <: Data](that: Stream[T], address: BigInt, validBitOffset: Int, payloadBitOffset: Int, validInverted: Boolean = false): 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
  83. 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

  84. def readSyncMemMultiWord[T <: Data](mem: Mem[T], addressOffset: BigInt, memOffset: UInt = U(0).resized): Mem[T]

    Memory map a Mem to bus for reading.

    Memory map a Mem to bus for reading. Elements can be larger than bus data width in bits.

    Definition Classes
    BusSlaveFactory
  85. def readSyncMemWordAligned[T <: Data](mem: Mem[T], addressOffset: BigInt, bitOffset: Int = 0, memOffset: UInt = U(0).resized): Mem[T]
    Definition Classes
    BusSlaveFactory
  86. val refOwner: RefOwnerType
    Definition Classes
    OwnableRef
    Annotations
    @DontName()
  87. def reflectNames(): Unit
    Definition Classes
    Nameable
  88. def rework[T](body: ⇒ T): T
    Definition Classes
    Area
  89. val scalaTrace: Throwable
    Definition Classes
    ScalaLocated
  90. def setCompositeName(nameable: Nameable, postfix: String, namePriority: Byte): BusSlaveFactoryAddressWrapper.this.type
    Definition Classes
    Nameable
  91. def setCompositeName(nameable: Nameable, postfix: String, weak: Boolean): BusSlaveFactoryAddressWrapper.this.type
    Definition Classes
    Nameable
  92. def setCompositeName(nameable: Nameable, postfix: String): BusSlaveFactoryAddressWrapper.this.type
    Definition Classes
    Nameable
  93. def setCompositeName(nameable: Nameable, namePriority: Byte): BusSlaveFactoryAddressWrapper.this.type
    Definition Classes
    Nameable
  94. def setCompositeName(nameable: Nameable, weak: Boolean): BusSlaveFactoryAddressWrapper.this.type
    Definition Classes
    Nameable
  95. def setCompositeName(nameable: Nameable): BusSlaveFactoryAddressWrapper.this.type
    Definition Classes
    Nameable
  96. def setConfig(value: BusSlaveFactoryConfig): BusSlaveFactoryAddressWrapper.this.type
    Definition Classes
    BusSlaveFactoryAddressWrapper → BusSlaveFactory
  97. def setLambdaName(isNameBody: ⇒ Boolean)(nameGen: ⇒ String): BusSlaveFactoryAddressWrapper.this.type
    Definition Classes
    Nameable
  98. def setName(name: String, namePriority: Byte): BusSlaveFactoryAddressWrapper.this.type
    Definition Classes
    Nameable
  99. def setName(name: String, weak: Boolean): BusSlaveFactoryAddressWrapper.this.type
    Definition Classes
    Nameable
  100. def setName(name: String): BusSlaveFactoryAddressWrapper.this.type
    Definition Classes
    Nameable
  101. def setNameAsWeak(): BusSlaveFactoryAddressWrapper.this.type
    Definition Classes
    Nameable
  102. def setOnClear[T <: Data](that: T, address: BigInt, bitOffset: Int = 0): T
    Definition Classes
    BusSlaveFactory
  103. def setOnSet[T <: Data](that: T, address: BigInt, bitOffset: Int = 0): T
    Definition Classes
    BusSlaveFactory
  104. def setPartialName(name: String, namePriority: Byte, owner: Any): BusSlaveFactoryAddressWrapper.this.type
    Definition Classes
    Nameable
  105. def setPartialName(name: String, namePriority: Byte): BusSlaveFactoryAddressWrapper.this.type
    Definition Classes
    Nameable
  106. def setPartialName(name: String, weak: Boolean): BusSlaveFactoryAddressWrapper.this.type
    Definition Classes
    Nameable
  107. def setPartialName(owner: Nameable, name: String, namePriority: Byte): BusSlaveFactoryAddressWrapper.this.type
    Definition Classes
    Nameable
  108. def setPartialName(owner: Nameable, name: String, weak: Boolean): BusSlaveFactoryAddressWrapper.this.type
    Definition Classes
    Nameable
  109. def setPartialName(name: String): BusSlaveFactoryAddressWrapper.this.type
    Definition Classes
    Nameable
  110. def setPartialName(owner: Nameable, name: String): BusSlaveFactoryAddressWrapper.this.type
    Definition Classes
    Nameable
  111. def setPartialName(owner: Nameable): BusSlaveFactoryAddressWrapper.this.type
    Definition Classes
    Nameable
  112. def setRefOwner(that: Any): Unit
    Definition Classes
    OwnableRef
  113. def setScalaLocated(source: ScalaLocated): BusSlaveFactoryAddressWrapper.this.type
    Definition Classes
    ScalaLocated
  114. def setWeakName(name: String): BusSlaveFactoryAddressWrapper.this.type
    Definition Classes
    Nameable
  115. def setWordEndianness(value: Endianness): BusSlaveFactory

    Set the endianness during write/read multiword

    Set the endianness during write/read multiword

    Definition Classes
    BusSlaveFactory
  116. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  117. def toString(): String
    Definition Classes
    Area → Nameable → AnyRef → Any
  118. def unsetName(): BusSlaveFactoryAddressWrapper.this.type
    Definition Classes
    Nameable
  119. def valCallback[T](ref: T, name: String): T
    Definition Classes
    ValCallbackRec → ValCallback
  120. def valCallbackOn(ref: Any, name: String, refs: Set[Any]): Unit
    Definition Classes
    ValCallbackRec
  121. def valCallbackRec(obj: Any, name: String): Unit
    Definition Classes
    Area → ValCallbackRec
  122. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  123. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  124. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  125. def withOffset(offset: BigInt): BusSlaveFactoryAddressWrapper
    Definition Classes
    BusSlaveFactory
  126. 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
    BusSlaveFactoryAddressWrapper → BusSlaveFactory
  127. def write[T <: Data](address: BigInt, bitMapping: (Int, Data)*): Unit
    Definition Classes
    BusSlaveFactory
  128. 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
  129. def writeAddress(): UInt
    Definition Classes
    BusSlaveFactoryAddressWrapper → BusSlaveFactory
  130. def writeAddress(address: AddressMapping): UInt
    Definition Classes
    BusSlaveFactory
  131. def writeByteEnable(): Bits

    Byte enable bits, defaulting to all ones

    Byte enable bits, defaulting to all ones

    Definition Classes
    BusSlaveFactory
  132. def writeError(): Unit
    Definition Classes
    BusSlaveFactory
  133. val writeErrorFlag: Bool
    Definition Classes
    BusSlaveFactory
  134. def writeFire(): Bool
    Definition Classes
    BusSlaveFactory
  135. def writeHalt(): Unit
    Definition Classes
    BusSlaveFactoryAddressWrapper → BusSlaveFactory
  136. def writeMemMultiWord[T <: Data](mem: Mem[T], addressOffset: BigInt): Mem[T]

    Memory map a Mem to bus for writing.

    Memory map a Mem to bus for writing. Elements can be larger than bus data width in bits.

    Definition Classes
    BusSlaveFactory
  137. def writeMemWordAligned[T <: Data](mem: Mem[T], addressOffset: BigInt, bitOffset: Int = 0, memOffset: UInt = U(0).resized): Mem[T]
    Definition Classes
    BusSlaveFactory
  138. 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 following addresses.

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

Deprecated Value Members

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

    (Since version ???) Use createReadAndWrite instead

  2. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from BusSlaveFactory

Inherited from Area

Inherited from OverridedEqualsHashCode

Inherited from ValCallbackRec

Inherited from ValCallback

Inherited from NameableByComponent

Inherited from Nameable

Inherited from ContextUser

Inherited from ScalaLocated

Inherited from GlobalDataUser

Inherited from OwnableRef

Inherited from AnyRef

Inherited from Any

Ungrouped