SpinalStruct

final def !=(arg0: Any): Boolean

def ##(right: Data): Bits

Concatenation between two data

final def ##(): Int

def #*(count: Int): Bits

def :=(that: SpinalStruct)(implicit loc: Location): Unit

Assign a data to this

def <>(that: SpinalStruct)(implicit loc: Location): Unit

Auto connection between two data

def =/=(that: SpinalStruct): Bool

final def ==(arg0: Any): Boolean

def ===(that: SpinalStruct): Bool

Comparison between two data

def \(that: SpinalStruct): SpinalStruct

Use as \= to have the same behavioral as VHDL variable

var _spinalTags: LinkedHashSet[SpinalTag]

def addAttribute(attribute: Attribute): SpinalStruct.this.type

def addAttribute(name: String, value: Int): SpinalStruct.this.type

def addAttribute(name: String, value: String): SpinalStruct.this.type

def addAttribute(name: String): SpinalStruct.this.type

def addTag[T <: SpinalTag](spinalTag: T): SpinalStruct.this.type

def addTags[T <: SpinalTag](tags: Iterable[T]): SpinalStruct.this.type

var algoIncrementale: Int

var algoInt: Int

def allowDirectionLessIo(): SpinalStruct.this.type

Allow a Data of an io Bundle to be directionless

def allowOverride(): SpinalStruct.this.type

Allow a Data to be overriden

def allowPartialyAssigned(): SpinalStruct.this.type

Allow a register to be partially assigned

def allowPruning(): SpinalStruct.this.type

def allowSimplifyIt(): SpinalStruct.this.type

def allowUnsetRegToAvoidLatch(): SpinalStruct.this.type

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

def as[T <: Data](dataType: HardType[T]): T

def asBits: Bits

Cast data to Bits

def asData: Data

def asInOut(): SpinalStruct.this.type

set a data as inout

def asInput(): SpinalStruct.this.type

Set a data as input

final def asInstanceOf[T0]: T0

def asOutput(): SpinalStruct.this.type

Set a data as output

def assignAllByName(that: Bundle): Unit

Assign the bundle with an other bundle by name

def assignDontCare(): SpinalStruct.this.type

def assignDontCareToUnasigned(): SpinalStruct.this.type

def assignFormalRandom(kind: RandomExpKind): Unit

final def assignFrom(that: AnyRef, target: AnyRef = this)(implicit loc: Location): Unit

def assignFromBits(bits: Bits, hi: Int, lo: Int): Unit

def assignFromBits(bits: Bits): Unit

def assignFromBits(bits: Bits, offset: Int, bitCount: BitCount): Unit

def assignSomeByName(that: Bundle): Unit

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

def cldCount: Int

def clearAll(): SpinalStruct.this.type

var clockDomain: ClockDomain

def clone(): SpinalStruct.this.type

def component: Component

final def compositAssignFrom(that: AnyRef, target: AnyRef, kind: AnyRef)(implicit loc: Location): Unit

var compositeAssign: Assignable

def copyDirectionOf(that: SpinalStruct): Unit

def copyDirectionOfImpl(that: Data): SpinalStruct.this.type

def default(that: ⇒ SpinalStruct): SpinalStruct

Set a default value to a data

def dirString(): String

def dlcAppend(that: AssignmentStatement): SpinalStruct.this.type

def dlcForeach[T >: AssignmentStatement](func: (T) ⇒ Unit): Unit

def dlcHasOnlyOne: Boolean

var dlcHead: AssignmentStatement

def dlcIsEmpty: Boolean

var dlcLast: AssignmentStatement

def dlcPrepend(that: AssignmentStatement): SpinalStruct.this.type

def dontSimplifyIt(): SpinalStruct.this.type

def elements: ArrayBuffer[(String, Data)]

def elementsString: String

final def eq(arg0: AnyRef): Boolean

def equals(obj: Any): Boolean

def existsTag(cond: (SpinalTag) ⇒ Boolean): Boolean

def filterTag(cond: (SpinalTag) ⇒ Boolean): Iterable[SpinalTag]

def find(name: String): Data

def findTag(cond: (SpinalTag) ⇒ Boolean): Option[SpinalTag]

def flatten: Seq[BaseType]

def flattenForeach(body: (BaseType) ⇒ Unit): Unit

def flattenLocalName: Seq[String]

def flip(): SpinalStruct.this.type

flip the direction of the data

def foreachClockDomain(func: (ClockDomain) ⇒ Unit): Unit

def foreachDrivingExpression(func: (Expression) ⇒ Unit): Unit

def foreachExpression(func: (Expression) ⇒ Unit): Unit

def foreachReflectableNameables(doThat: (Any) ⇒ Unit): Unit

def foreachStatements(func: (AssignmentStatement) ⇒ Unit): Unit

def foreachTag(body: (SpinalTag) ⇒ Unit): Unit

def freeze(): SpinalStruct.this.type

def getAheadValue(): SpinalStruct.this.type

def getBitsWidth: Int

Return the width of the data

final def getClass(): Class[_]

def getComponent(): Component

def getComponents(): Seq[Component]

Get current component with all parents

def getDirection: IODirection

def getDisplayName(): String

def getDrivingReg(reportError: Boolean = true): SpinalStruct.this.type

def getInstanceCounter: Int

def getMode: Byte

def getMuxType[T <: Data](list: TraversableOnce[T]): HardType[T]

def getName(default: String): String

def getName(): String

def getPartialName(): String

def getPath(from: Component, to: Component): Seq[Component]

def getRealSource: Any

def getRealSourceNoRec: Any

def getRefOwnersChain(): List[Any]

def getRootParent: Data

def getRtlPath(separator: String = "/"): String

def getScalaLocationLong: String

def getScalaLocationShort: String

def getScalaTrace(): Throwable

def getSingleDriver: Option[SpinalStruct.this.type]

def getTag[T <: SpinalTag](clazz: Class[T]): Option[T]

def getTags(): LinkedHashSet[SpinalTag]

def getTypeObject: Any

def getTypeString: String

def getZero: SpinalStruct.this.type

Create a data set to 0

val globalData: GlobalData

def hasAssignement: Boolean

def hasDataAssignment: Boolean

def hasInit: Boolean

Does the base type have initial value

def hasOnlyOneStatement: Boolean

def hasTag[T <: SpinalTag](clazz: Class[T]): Boolean

def hasTag(spinalTag: SpinalTag): Boolean

def hashCode(): Int

def head: AssignmentStatement

def init(that: SpinalStruct): SpinalStruct

Set initial value to a data

final def initFrom(that: AnyRef, target: AnyRef = this): Unit

def initialFrom(that: AnyRef, target: AnyRef = this): Unit

def insertNext(s: Statement): Unit

def instanceAttributes(language: Language): Iterable[Attribute]

def instanceAttributes: Iterable[Attribute]

def isAnalog: Boolean

def isComb: Boolean

def isCompletelyUnnamed: Boolean

def isDirectionLess: Boolean

def isEmptyOfTag: Boolean

def isFrozen(): Boolean

def isInOut: Boolean

def isInput: Boolean

def isInputOrInOut: Boolean

final def isInstanceOf[T0]: Boolean

def isNamed: Boolean

def isOutput: Boolean

def isOutputOrInOut: Boolean

def isPriorityApplicable(namePriority: Byte): Boolean

def isReg: Boolean

def isRegOnAssign: Boolean

def isTypeNode: Boolean

Is the baseType a node

def isUnnamed: Boolean

def isUsingResetSignal: Boolean

Is the basetype using reset signal

def isUsingSoftResetSignal: Boolean

Is the basetype using soft reset signal

def isVital: Boolean

Check if the baseType is vital

var lastScopeStatement: Statement

def mux[T2 <: Data](mappings: (Any, T2)*): T2

def muxDc[T2 <: Data](mappings: (Any, T2)*): T2

def muxList[T2 <: Data](defaultValue: T2, mappings: Seq[(Any, T2)]): T2

def muxList[T2 <: Data](mappings: Seq[(Any, T2)]): T2

def muxListDc[T2 <: Data](mappings: Seq[(Any, T2)]): T2

var name: String

var nameableRef: Nameable

final def ne(arg0: AnyRef): Boolean

var nextScopeStatement: Statement

def noBackendCombMerge(): SpinalStruct.this.type

Put the combinatorial logic driving this signal in a separate process

def noCombLoopCheck(): SpinalStruct.this.type

Disable combinatorial loop checking for this Data

def normalizeInputs: Unit

final def notify(): Unit

final def notifyAll(): Unit

def onEachAttributes(doIt: (Attribute) ⇒ Unit): Unit

def opName: String

def overrideLocalName(name: String): SpinalStruct.this.type

var parent: Data

var parentScope: ScopeStatement

def pull(propagateName: Boolean): SpinalStruct.this.type

def pull(): SpinalStruct.this.type

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

def purify(): SpinalStruct.this.type

def randBoot(u: Unit): SpinalStruct.this.type

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

var refOwner: RefOwnerType

def reflectNames(): Unit

def remapDrivingExpressions(func: (Expression) ⇒ Expression): Unit

def remapExpressions(func: (Expression) ⇒ Expression): Unit

def removeAssignments(data: Boolean = true, init: Boolean = true, initial: Boolean = true): SpinalStruct.this.type

Remove all assignments of the base type

def removeDataAssignments(): SpinalStruct.this.type

def removeInitAssignments(): SpinalStruct.this.type

def removeStatement(): Unit

def removeStatementFromScope(): Unit

def removeTag(spinalTag: SpinalTag): SpinalStruct.this.type

def removeTags(tags: Iterable[SpinalTag]): SpinalStruct.this.type

def resized: SpinalStruct.this.type

Resized data regarding target

def rootScopeStatement: ScopeStatement

var scalaTrace: Throwable

def setAll(): SpinalStruct.this.type

def setAsAnalog(): SpinalStruct.this.type

def setAsComb(): SpinalStruct.this.type

Set baseType to Combinatorial

def setAsDirectionLess(): SpinalStruct.this.type

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

def setAsReg(): SpinalStruct.this.type

Set baseType to reg

def setAsTypeNode(): SpinalStruct.this.type

Set baseType to Node

def setAsVital(): SpinalStruct.this.type

Set the baseType to vital

def setCompositeName(nameable: Nameable, postfix: String, namePriority: Byte): SpinalStruct.this.type

def setCompositeName(nameable: Nameable, postfix: String, weak: Boolean): SpinalStruct.this.type

def setCompositeName(nameable: Nameable, postfix: String): SpinalStruct.this.type

def setCompositeName(nameable: Nameable, namePriority: Byte): SpinalStruct.this.type

def setCompositeName(nameable: Nameable, weak: Boolean): SpinalStruct.this.type

def setCompositeName(nameable: Nameable): SpinalStruct.this.type

def setLambdaName(isNameBody: ⇒ Boolean)(nameGen: ⇒ String): SpinalStruct.this.type

def setName(name: String, namePriority: Byte): SpinalStruct.this.type

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

def setName(name: String): SpinalStruct.this.type

def setNameAsWeak(): SpinalStruct.this.type

def setPartialName(name: String, namePriority: Byte, owner: Any): SpinalStruct.this.type

def setPartialName(name: String, namePriority: Byte): SpinalStruct.this.type

def setPartialName(name: String, weak: Boolean): SpinalStruct.this.type

def setPartialName(owner: Nameable, name: String, namePriority: Byte): SpinalStruct.this.type

def setPartialName(owner: Nameable, name: String, weak: Boolean): SpinalStruct.this.type

def setPartialName(name: String): SpinalStruct.this.type

def setPartialName(owner: Nameable, name: String): SpinalStruct.this.type

def setPartialName(owner: Nameable): SpinalStruct.this.type

def setRefOwner(that: Any): Unit

def setScalaLocated(source: ScalaLocated): SpinalStruct.this.type

def setWeakName(name: String): SpinalStruct.this.type

def simplifyNode: Expression

def spinalTags: LinkedHashSet[SpinalTag]

def stabilized(func: (Expression) ⇒ Expression, seed: Expression): Expression

def switchAssign[T2 <: BaseType](sel: T2)(mappings: (Any, SpinalStruct)*): Unit

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

def toIo(): SpinalStruct.this.type

def toMuxInput[T <: Data](muxOutput: T): T

def toString(): String

def toStringMultiLine(): String

def toStringRec(level: Int = 1): String

val typeName: String

Underlying structure name to use if not the subclass name.

def unfreeze(): SpinalStruct.this.type

def unsetName(): SpinalStruct.this.type

def valCallback[T](ref: T, name: String): T

def valCallbackOn(ref: Any, name: String, refs: Set[Any]): Unit

def valCallbackRec(ref: Any, name: String): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

final def wait(): Unit

def walkDrivingExpressions(func: (Expression) ⇒ Unit): Unit

def walkExpression(func: (Expression) ⇒ Unit): Unit

def walkExpressionPostorder(func: (Expression) ⇒ Unit): Unit

def walkParentTreeStatements(func: (TreeStatement) ⇒ Unit): Unit

def walkParentTreeStatementsUntilRootScope(func: (TreeStatement) ⇒ Unit): Unit

def walkRemapDrivingExpressions(func: (Expression) ⇒ Expression): Unit

def walkRemapExpressions(func: (Expression) ⇒ Expression): Unit

def wrapCast[T <: BaseType](result: T, node: Cast): T

def wrapNext(): SpinalStruct.this.type

def asDirectionLess(): SpinalStruct.this.type

def finalize(): Unit

def genIf(cond: Boolean): SpinalStruct.this.type

Generate this if condition is true