Packages

case class XipBus(p: XipBusParameters) extends Bundle with IMasterSlave with Product with Serializable

Linear Supertypes
Serializable, Serializable, Product, Equals, IMasterSlave, Bundle, ValCallbackRec, ValCallback, MultiData, Data, InComponent, OverridedEqualsHashCode, SpinalTagReady, Assignable, NameableByComponent, Nameable, OwnableRef, ContextUser, ScalaLocated, GlobalDataUser, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. XipBus
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. IMasterSlave
  7. Bundle
  8. ValCallbackRec
  9. ValCallback
  10. MultiData
  11. Data
  12. InComponent
  13. OverridedEqualsHashCode
  14. SpinalTagReady
  15. Assignable
  16. NameableByComponent
  17. Nameable
  18. OwnableRef
  19. ContextUser
  20. ScalaLocated
  21. GlobalDataUser
  22. AnyRef
  23. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new XipBus(p: XipBusParameters)

Type Members

  1. abstract type RefOwnerType
    Definition Classes
    OwnableRef

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. def ##(right: Data): Bits

    Concatenation between two data

    Concatenation between two data

    Definition Classes
    Data
  3. final def ##(): Int
    Definition Classes
    AnyRef → Any
  4. def #*(count: Int): Bits
    Definition Classes
    Data
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def IFparent: Data
    Definition Classes
    Data
  7. val _spinalTags: LinkedHashSet[SpinalTag]
    Definition Classes
    SpinalTagReady
  8. def addAttribute(attribute: Attribute): XipBus.this.type
    Definition Classes
    Data → SpinalTagReady
  9. def addAttribute(name: String, value: Int): XipBus.this.type
    Definition Classes
    SpinalTagReady
  10. def addAttribute(name: String, value: String): XipBus.this.type
    Definition Classes
    SpinalTagReady
  11. def addAttribute(name: String): XipBus.this.type
    Definition Classes
    SpinalTagReady
  12. def addTag[T <: SpinalTag](spinalTag: T): XipBus.this.type
    Definition Classes
    MultiData → SpinalTagReady
  13. def addTags(h: SpinalTag, tail: SpinalTag*): XipBus.this.type
    Definition Classes
    SpinalTagReady
  14. def addTags[T <: SpinalTag](tags: Iterable[T]): XipBus.this.type
    Definition Classes
    SpinalTagReady
  15. def allowDirectionLessIo(): XipBus.this.type

    Allow a Data of an io Bundle to be directionless

    Allow a Data of an io Bundle to be directionless

    See https://spinalhdl.github.io/SpinalDoc-RTD/master/SpinalHDL/Design%20errors/iobundle.html

    Definition Classes
    Data
  16. def allowOverride(): XipBus.this.type

    Allow a Data to be overriden

    Allow a Data to be overriden

    See https://spinalhdl.github.io/SpinalDoc-RTD/master/SpinalHDL/Design%20errors/assignment_overlap.html

    Definition Classes
    Data
  17. def allowPartialyAssigned(): XipBus.this.type

    Allow a register to be partially assigned

    Allow a register to be partially assigned

    Definition Classes
    Data
  18. def allowPruning(): XipBus.this.type
    Definition Classes
    Data
  19. def allowSimplifyIt(): XipBus.this.type
    Definition Classes
    Data
  20. def allowUnsetRegToAvoidLatch(): XipBus.this.type

    Allow a register to have only an init (no assignments)

    Allow a register to have only an init (no assignments)

    See https://spinalhdl.github.io/SpinalDoc-RTD/master/SpinalHDL/Design%20errors/unassigned_register.html#register-with-only-init

    Definition Classes
    Data
  21. def as[T <: Data](dataType: HardType[T]): T
    Definition Classes
    Data
  22. def asBits: Bits

    Cast data to Bits

    Cast data to Bits

    Definition Classes
    MultiData → Data
  23. def asData: Data
    Definition Classes
    Data
  24. def asInOut(): XipBus.this.type

    set a data as inout

    set a data as inout

    Definition Classes
    MultiData → Data
  25. def asInput(): XipBus.this.type

    Set a data as input

    Set a data as input

    Definition Classes
    MultiData → Data
  26. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  27. def asOutput(): XipBus.this.type

    Set a data as output

    Set a data as output

    Definition Classes
    MultiData → Data
  28. def assignAllByName(that: Bundle): Unit

    Assign the bundle with an other bundle by name

    Assign the bundle with an other bundle by name

    Definition Classes
    Bundle
  29. def assignDontCare(): XipBus.this.type
    Definition Classes
    Data
  30. def assignDontCareToUnasigned(): XipBus.this.type
    Definition Classes
    Data
  31. def assignFormalRandom(kind: RandomExpKind): Unit
    Definition Classes
    MultiData → Data
  32. final def assignFrom(that: AnyRef, target: AnyRef = this)(implicit loc: Location): Unit
    Definition Classes
    Data
  33. def assignFromBits(bits: Bits, hi: Int, lo: Int): Unit
    Definition Classes
    MultiData → Data
  34. def assignFromBits(bits: Bits): Unit
    Definition Classes
    MultiData → Data
  35. def assignFromBits(bits: Bits, offset: Int, bitCount: BitCount): Unit
    Definition Classes
    Data
  36. def assignFromImpl(that: AnyRef, target: AnyRef, kind: AnyRef)(implicit loc: Location): Unit
    Attributes
    protected
    Definition Classes
    Bundle → Assignable
  37. def assignSomeByName(that: Bundle): Unit

    Assign all possible signal fo the bundle with an other bundle by name

    Assign all possible signal fo the bundle with an other bundle by name

    Definition Classes
    Bundle
  38. def assignUnassignedByName(that: MultiData): Unit
    Definition Classes
    MultiData
  39. def bundleAssign(that: Bundle)(f: (Data, Data) ⇒ Unit): Unit
    Definition Classes
    Bundle
  40. def checkDir(that: Bundle): Boolean

    for interface find modport

    for interface find modport

    Definition Classes
    Bundle
  41. def clearAll(): XipBus.this.type
    Definition Classes
    Data
  42. def clone(): Bundle
    Definition Classes
    Bundle → Data → AnyRef
  43. val cmd: Stream[XipCmd]
  44. def component: Component
    Definition Classes
    ContextUser
  45. final def compositAssignFrom(that: AnyRef, target: AnyRef, kind: AnyRef)(implicit loc: Location): Unit
    Definition Classes
    Assignable
  46. val compositeAssign: Assignable
    Definition Classes
    Assignable
  47. def copyDirectionOfImpl(that: Data): XipBus.this.type
    Definition Classes
    MultiData → Data
  48. def dirString(): String
    Definition Classes
    Data
  49. def dontSimplifyIt(): XipBus.this.type
    Definition Classes
    Data
  50. def elements: ArrayBuffer[(String, Data)]
    Definition Classes
    Bundle → MultiData
  51. var elementsCache: ArrayBuffer[(String, Data)]
    Definition Classes
    Bundle
  52. def elementsString: String
    Definition Classes
    MultiData
  53. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  54. def equals(obj: Any): Boolean
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  55. def existsTag(cond: (SpinalTag) ⇒ Boolean): Boolean
    Definition Classes
    SpinalTagReady
  56. def filterTag(cond: (SpinalTag) ⇒ Boolean): Iterable[SpinalTag]
    Definition Classes
    SpinalTagReady
  57. def find(name: String): Data
    Definition Classes
    MultiData
  58. def findTag(cond: (SpinalTag) ⇒ Boolean): Option[SpinalTag]
    Definition Classes
    SpinalTagReady
  59. def flatten: Seq[BaseType]
    Definition Classes
    MultiData → Data
  60. def flattenForeach(body: (BaseType) ⇒ Unit): Unit
    Definition Classes
    MultiData → Data
  61. def flattenLocalName: Seq[String]
    Definition Classes
    MultiData → Data
  62. def flip(): XipBus.this.type

    flip the direction of the data

    flip the direction of the data

    Definition Classes
    MultiData → Data
  63. def foreachReflectableNameables(doThat: (Any) ⇒ Unit): Unit
    Definition Classes
    Nameable
  64. def foreachTag(body: (SpinalTag) ⇒ Unit): Unit
    Definition Classes
    SpinalTagReady
  65. def freeze(): XipBus.this.type
    Definition Classes
    MultiData → Data
  66. def fromBmb(p: BmbParameter): Bmb
  67. def fromPipelinedMemoryBus(): PipelinedMemoryBus
  68. def getAheadValue(): XipBus.this.type

    For a register, get the value it will have at the next clock, as a combinational signal.

    For a register, get the value it will have at the next clock, as a combinational signal.

    Definition Classes
    Data
  69. def getBitsWidth: Int

    Return the width of the data

    Return the width of the data

    Definition Classes
    MultiData → Data
  70. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  71. def getComponent(): Component
    Definition Classes
    Data → InComponent → NameableByComponent
  72. def getComponents(): Seq[Component]

    Get current component with all parents

    Get current component with all parents

    Definition Classes
    InComponent
  73. def getDirection: IODirection
    Definition Classes
    Data
  74. def getDisplayName(): String
    Definition Classes
    Nameable
  75. def getInstanceCounter: Int
    Definition Classes
    ContextUser
  76. def getMode: Byte
    Attributes
    protected
    Definition Classes
    Nameable
  77. def getMuxType[T <: Data](list: TraversableOnce[T]): HardType[T]
    Definition Classes
    Data
  78. def getName(default: String): String
    Definition Classes
    NameableByComponent → Nameable
  79. def getName(): String
    Definition Classes
    NameableByComponent → Nameable
  80. def getPartialName(): String
    Definition Classes
    Nameable
  81. def getPath(from: Component, to: Component): Seq[Component]
    Definition Classes
    NameableByComponent
  82. def getRealSource: Any
    Definition Classes
    Assignable
  83. def getRealSourceNoRec: Any
    Definition Classes
    Data → Assignable
  84. def getRefOwnersChain(): List[Any]
    Definition Classes
    OwnableRef
  85. def getRootParent: Data
    Definition Classes
    Data
  86. def getRtlPath(separator: String = "/"): String
    Definition Classes
    Data
  87. def getScalaLocationLong: String
    Definition Classes
    ScalaLocated
  88. def getScalaLocationShort: String
    Definition Classes
    ScalaLocated
  89. def getScalaTrace(): Throwable
    Definition Classes
    ScalaLocated
  90. def getTag[T <: SpinalTag](clazz: Class[T]): Option[T]
    Definition Classes
    SpinalTagReady
  91. def getTags(): LinkedHashSet[SpinalTag]
    Definition Classes
    SpinalTagReady
  92. def getTypeString: String
    Definition Classes
    Bundle
  93. def getZero: XipBus.this.type

    Create a data set to 0

    Create a data set to 0

    Definition Classes
    MultiData → Data
  94. val globalData: GlobalData
    Definition Classes
    GlobalDataUser
  95. var hardtype: HardType[_]
    Definition Classes
    Bundle
  96. def hasTag[T <: SpinalTag](clazz: Class[T]): Boolean
    Definition Classes
    SpinalTagReady
  97. def hasTag(spinalTag: SpinalTag): Boolean
    Definition Classes
    SpinalTagReady
  98. def hashCode(): Int
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  99. final def initFrom(that: AnyRef, target: AnyRef = this): Unit
    Definition Classes
    Data
  100. def instanceAttributes(language: Language): Iterable[Attribute]
    Definition Classes
    SpinalTagReady
  101. def instanceAttributes: Iterable[Attribute]
    Definition Classes
    SpinalTagReady
  102. final def intoMaster(): XipBus.this.type

    Convert into master

    Convert into master

    Definition Classes
    IMasterSlave
  103. final def intoSlave(): XipBus.this.type

    Convert into slave

    Convert into slave

    Definition Classes
    IMasterSlave
  104. def isAnalog: Boolean
    Definition Classes
    Data
  105. def isComb: Boolean
    Definition Classes
    Data
  106. def isCompletelyUnnamed: Boolean
    Definition Classes
    Nameable
  107. def isDirectionLess: Boolean
    Definition Classes
    Data
  108. def isEmptyOfTag: Boolean
    Definition Classes
    SpinalTagReady
  109. def isInOut: Boolean
    Definition Classes
    Data
  110. def isInput: Boolean
    Definition Classes
    Data
  111. def isInputOrInOut: Boolean
    Definition Classes
    Data
  112. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  113. final def isMasterInterface: Boolean

    Are port directions set for a Master interface?

    Are port directions set for a Master interface?

    Definition Classes
    IMasterSlave
  114. final def isNamed: Boolean
    Definition Classes
    Nameable
  115. def isOutput: Boolean
    Definition Classes
    Data
  116. def isOutputOrInOut: Boolean
    Definition Classes
    Data
  117. def isPriorityApplicable(namePriority: Byte): Boolean
    Definition Classes
    Nameable
  118. def isReg: Boolean
    Definition Classes
    Data
  119. def isRegOnAssign: Boolean
    Definition Classes
    Data
  120. final def isSlaveInterface: Boolean

    Are port directions set for a Master interface?

    Are port directions set for a Master interface?

    Definition Classes
    IMasterSlave
  121. def isUnnamed: Boolean
    Definition Classes
    NameableByComponent → Nameable
  122. val name: String
    Definition Classes
    Nameable
  123. val nameableRef: Nameable
    Attributes
    protected
    Definition Classes
    Nameable
    Annotations
    @DontName()
  124. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  125. def noBackendCombMerge(): XipBus.this.type

    Put the combinatorial logic driving this signal in a separate process

    Put the combinatorial logic driving this signal in a separate process

    Definition Classes
    Data
  126. def noCombLoopCheck(): XipBus.this.type

    Disable combinatorial loop checking for this Data

    Disable combinatorial loop checking for this Data

    See https://spinalhdl.github.io/SpinalDoc-RTD/master/SpinalHDL/Design%20errors/combinatorial_loop.html

    Definition Classes
    Data
  127. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  128. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  129. def onEachAttributes(doIt: (Attribute) ⇒ Unit): Unit
    Definition Classes
    SpinalTagReady
  130. def overrideLocalName(name: String): XipBus.this.type
    Definition Classes
    Nameable
  131. val p: XipBusParameters
  132. val parent: Data
    Definition Classes
    Data
  133. val parentScope: ScopeStatement
    Definition Classes
    ContextUser
  134. def pull(propagateName: Boolean): XipBus.this.type
    Definition Classes
    Data
  135. def pull(): XipBus.this.type

    Pull a signal to the top level (use for debugging)

    Pull a signal to the top level (use for debugging)

    Definition Classes
    Data
  136. def purify(): XipBus.this.type
    Definition Classes
    Data
  137. def randBoot(u: Unit): XipBus.this.type

    Useful for register that doesn't need a reset value in RTL, but need a random value for simulation (avoid x-propagation)

    Useful for register that doesn't need a reset value in RTL, but need a random value for simulation (avoid x-propagation)

    Definition Classes
    Data
  138. val refOwner: RefOwnerType
    Definition Classes
    OwnableRef
    Annotations
    @DontName()
  139. def reflectNames(): Unit
    Definition Classes
    Nameable
  140. def removeAssignments(data: Boolean = true, init: Boolean = true, initial: Boolean = true): XipBus.this.type
    Definition Classes
    Data
  141. def removeDataAssignments(): XipBus.this.type
    Definition Classes
    Data
  142. def removeInitAssignments(): XipBus.this.type
    Definition Classes
    Data
  143. def removeTag(spinalTag: SpinalTag): XipBus.this.type
    Definition Classes
    SpinalTagReady
  144. def removeTags(tags: Iterable[SpinalTag]): XipBus.this.type
    Definition Classes
    SpinalTagReady
  145. def resized: XipBus.this.type

    Resized data regarding target

    Resized data regarding target

    Definition Classes
    Data
  146. def rootIF(): Interface

    root interface

    root interface

    Definition Classes
    Data
  147. def rootIFList(): List[Interface]
    Definition Classes
    Data
  148. def rootIFrec(now: Data, lastRoot: List[Interface]): List[Interface]
    Definition Classes
    Data
  149. val rsp: Stream[Fragment[Bits]]
  150. val scalaTrace: Throwable
    Definition Classes
    ScalaLocated
  151. def setAll(): XipBus.this.type
    Definition Classes
    Data
  152. def setAsAnalog(): XipBus.this.type
    Definition Classes
    Data
  153. def setAsComb(): XipBus.this.type

    Set baseType to Combinatorial

    Set baseType to Combinatorial

    Definition Classes
    MultiData → Data
  154. def setAsDirectionLess(): XipBus.this.type

    remove the direction (in,out,inout) to a data

    remove the direction (in,out,inout) to a data

    Definition Classes
    MultiData → Data
  155. final def setAsMaster(): Unit

    Set as master interface

    Set as master interface

    Definition Classes
    IMasterSlave
  156. def setAsReg(): XipBus.this.type

    Set baseType to reg

    Set baseType to reg

    Definition Classes
    MultiData → Data
  157. final def setAsSlave(): Unit

    Set a slave interface

    Set a slave interface

    Definition Classes
    IMasterSlave
  158. def setCompositeName(nameable: Nameable, postfix: String, namePriority: Byte): XipBus.this.type
    Definition Classes
    Nameable
  159. def setCompositeName(nameable: Nameable, postfix: String, weak: Boolean): XipBus.this.type
    Definition Classes
    Nameable
  160. def setCompositeName(nameable: Nameable, postfix: String): XipBus.this.type
    Definition Classes
    Nameable
  161. def setCompositeName(nameable: Nameable, namePriority: Byte): XipBus.this.type
    Definition Classes
    Nameable
  162. def setCompositeName(nameable: Nameable, weak: Boolean): XipBus.this.type
    Definition Classes
    Nameable
  163. def setCompositeName(nameable: Nameable): XipBus.this.type
    Definition Classes
    Nameable
  164. def setLambdaName(isNameBody: ⇒ Boolean)(nameGen: ⇒ String): XipBus.this.type
    Definition Classes
    Nameable
  165. def setName(name: String, namePriority: Byte): XipBus.this.type
    Definition Classes
    Nameable
  166. def setName(name: String, weak: Boolean): XipBus.this.type
    Definition Classes
    Nameable
  167. def setName(name: String): XipBus.this.type
    Definition Classes
    Nameable
  168. def setNameAsWeak(): XipBus.this.type
    Definition Classes
    Nameable
  169. def setOutputAsReg(): XipBus.this.type

    Recursively set baseType to reg only for output

    Recursively set baseType to reg only for output

    Definition Classes
    Data
  170. def setPartialName(name: String, namePriority: Byte, owner: Any): XipBus.this.type
    Definition Classes
    Nameable
  171. def setPartialName(name: String, namePriority: Byte): XipBus.this.type
    Definition Classes
    Nameable
  172. def setPartialName(name: String, weak: Boolean): XipBus.this.type
    Definition Classes
    Nameable
  173. def setPartialName(owner: Nameable, name: String, namePriority: Byte): XipBus.this.type
    Definition Classes
    Nameable
  174. def setPartialName(owner: Nameable, name: String, weak: Boolean): XipBus.this.type
    Definition Classes
    Nameable
  175. def setPartialName(name: String): XipBus.this.type
    Definition Classes
    Nameable
  176. def setPartialName(owner: Nameable, name: String): XipBus.this.type
    Definition Classes
    Nameable
  177. def setPartialName(owner: Nameable): XipBus.this.type
    Definition Classes
    Nameable
  178. def setRefOwner(that: Any): Unit
    Definition Classes
    OwnableRef
  179. def setScalaLocated(source: ScalaLocated): XipBus.this.type
    Definition Classes
    ScalaLocated
  180. def setWeakName(name: String): XipBus.this.type
    Definition Classes
    Nameable
  181. def spinalTags: LinkedHashSet[SpinalTag]
    Definition Classes
    SpinalTagReady
  182. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  183. def toIo(): XipBus.this.type
    Definition Classes
    Data
  184. def toMuxInput[T <: Data](muxOutput: T): T
    Definition Classes
    Data
  185. def toString(): String
    Definition Classes
    Bundle → Nameable → AnyRef → Any
  186. def unfreeze(): XipBus.this.type
    Definition Classes
    MultiData → Data
  187. def unsetName(): XipBus.this.type
    Definition Classes
    Nameable
  188. def valCallback[T](ref: T, name: String): T
    Definition Classes
    ValCallbackRec → ValCallback
  189. def valCallbackOn(ref: Any, name: String, refs: Set[Any]): Unit
    Definition Classes
    ValCallbackRec
  190. def valCallbackRec(ref: Any, name: String): Unit
    Definition Classes
    Bundle → ValCallbackRec
  191. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  192. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  193. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  194. def wrapNext(): XipBus.this.type
    Definition Classes
    Data
  195. def zipByName(that: MultiData, rec: ArrayBuffer[(BaseType, BaseType)] = ArrayBuffer()): ArrayBuffer[(BaseType, BaseType)]
    Definition Classes
    MultiData

Deprecated Value Members

  1. def asDirectionLess(): XipBus.this.type
    Definition Classes
    Data
    Annotations
    @deprecated
    Deprecated

    (Since version ???) use setAsDirectionLess instead

  2. def asMaster(): Unit

    Override it to define port directions for a master interface.

    Override it to define port directions for a master interface.

    Definition Classes
    XipBus → IMasterSlave
    Deprecated

    This method must be overriden but not called. Calling this method is not correct. Call setAsMaster() or intoMaster() instead. This method is named asXxx but it does not return Xxx. This method does not update isMasterInterface and isSlaveInterface.

  3. def asSlave(): Unit

    Override it to define port directions for a master interface.

    Override it to define port directions for a master interface.

    If not overriden, defaults to the opposite port directions of asMaster().

    Definition Classes
    IMasterSlave
    Deprecated

    This method can be overriden but not called. Calling this method is not correct. Call setAsSlave() or intoSlave() instead. This method is named asXxx but it does not return Xxx. This method does not update isMasterInterface and isSlaveInterface.

  4. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated
  5. def genIf(cond: Boolean): XipBus.this.type

    Generate this if condition is true

    Generate this if condition is true

    Definition Classes
    Data
    Annotations
    @deprecated
    Deprecated

    does not work with <>, use 'someBool generate Type()' or 'if(condition) Type() else null' instead

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from IMasterSlave

Inherited from Bundle

Inherited from ValCallbackRec

Inherited from ValCallback

Inherited from MultiData

Inherited from Data

Inherited from InComponent

Inherited from OverridedEqualsHashCode

Inherited from SpinalTagReady

Inherited from Assignable

Inherited from NameableByComponent

Inherited from Nameable

Inherited from OwnableRef

Inherited from ContextUser

Inherited from ScalaLocated

Inherited from GlobalDataUser

Inherited from AnyRef

Inherited from Any

Ungrouped