abstract class SpinalStruct extends BaseType with Nameable with ValCallbackRec with DataPrimitives[SpinalStruct] with Suffixable
Class representing Verilog Struct and VHDL Record data types.
Linear Supertypes
Ordering
- Alphabetic
- By Inheritance
Inherited
- SpinalStruct
- Suffixable
- DataPrimitives
- ValCallbackRec
- ValCallback
- BaseType
- Expression
- StatementDoubleLinkedContainer
- DoubleLinkedContainer
- DeclarationStatement
- LeafStatement
- Statement
- BaseNode
- ExpressionContainer
- Data
- InComponent
- OverridedEqualsHashCode
- SpinalTagReady
- Assignable
- NameableByComponent
- Nameable
- OwnableRef
- ContextUser
- ScalaLocated
- GlobalDataUser
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- Protected
Instance Constructors
- new SpinalStruct(typeName: String = null)
- typeName
Underlying structure name to use if not the subclass name.
Type Members
- abstract type RefOwnerType
- Definition Classes
- OwnableRef
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def ##(right: Data): Bits
Concatenation between two data
Concatenation between two data
- Definition Classes
- Data
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def :=(that: SpinalStruct): Unit
Assign a data to this
Assign a data to this
- Definition Classes
- DataPrimitives
- def <>(that: SpinalStruct): Unit
Auto connection between two data
Auto connection between two data
- Definition Classes
- DataPrimitives
- def =/=(that: SpinalStruct): Bool
- Definition Classes
- DataPrimitives
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def ===(that: SpinalStruct): Bool
Comparison between two data
Comparison between two data
- Definition Classes
- DataPrimitives
- def \(that: SpinalStruct): SpinalStruct
Use as \= to have the same behavioral as VHDL variable
Use as \= to have the same behavioral as VHDL variable
- Definition Classes
- DataPrimitives
- val _spinalTags: LinkedHashSet[SpinalTag]
- Definition Classes
- SpinalTagReady
- def addAttribute(attribute: Attribute): SpinalStruct.this.type
- Definition Classes
- BaseType → Data → SpinalTagReady
- def addAttribute(name: String, value: Int): SpinalStruct.this.type
- Definition Classes
- SpinalTagReady
- def addAttribute(name: String, value: String): SpinalStruct.this.type
- Definition Classes
- SpinalTagReady
- def addAttribute(name: String): SpinalStruct.this.type
- Definition Classes
- SpinalTagReady
- def addTag[T <: SpinalTag](spinalTag: T): SpinalStruct.this.type
- Definition Classes
- SpinalTagReady
- def addTags[T <: SpinalTag](tags: Iterable[T]): SpinalStruct.this.type
- Definition Classes
- SpinalTagReady
- val algoIncrementale: Int
- Definition Classes
- BaseNode
- val algoInt: Int
- Definition Classes
- BaseNode
- def allowDirectionLessIo: SpinalStruct.this.type
- Definition Classes
- Data
- def allowOverride: SpinalStruct.this.type
Allow a data to be overrided
Allow a data to be overrided
- Definition Classes
- Data
- def allowPartialyAssigned: SpinalStruct.this.type
- Definition Classes
- Data
- def allowPruning(): SpinalStruct.this.type
- Definition Classes
- Data
- def allowSimplifyIt(): SpinalStruct.this.type
- def allowUnsetRegToAvoidLatch: SpinalStruct.this.type
- Definition Classes
- Data
- def as[T <: Data](dataType: HardType[T]): T
- Definition Classes
- Data
- def asBits: Bits
Cast data to Bits
Cast data to Bits
- Definition Classes
- SpinalStruct → Data
- def asData: Data
- Definition Classes
- Data
- def asInOut(): SpinalStruct.this.type
set a data as inout
set a data as inout
- Definition Classes
- SpinalStruct → BaseType → Data
- def asInput(): SpinalStruct.this.type
Set a data as input
Set a data as input
- Definition Classes
- SpinalStruct → BaseType → Data
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def asOutput(): SpinalStruct.this.type
Set a data as output
Set a data as output
- Definition Classes
- SpinalStruct → BaseType → Data
- def assignAllByName(that: Bundle): Unit
Assign the bundle with an other bundle by name
- def assignDontCare(): SpinalStruct.this.type
- Definition Classes
- Data
- final def assignFrom(that: AnyRef, target: AnyRef = this): Unit
- Definition Classes
- Data
- def assignFromBits(bits: Bits, hi: Int, lo: Int): Unit
- Definition Classes
- SpinalStruct → Data
- def assignFromBits(bits: Bits): Unit
- Definition Classes
- SpinalStruct → Data
- def assignFromBits(bits: Bits, offset: Int, bitCount: BitCount): Unit
- Definition Classes
- Data
- def assignSomeByName(that: Bundle): Unit
Assign all possible signal fo the bundle with an other bundle by name
- var clockDomain: ClockDomain
- Definition Classes
- BaseType
- def clone(): SpinalStruct.this.type
- def component: Component
- Definition Classes
- ContextUser
- final def compositAssignFrom(that: AnyRef, target: AnyRef, kind: AnyRef): Unit
- Definition Classes
- Assignable
- val compositeAssign: Assignable
- Definition Classes
- Assignable
- def copyDirectionOf(that: SpinalStruct): Unit
- Definition Classes
- DataPrimitives
- def copyDirectionOfImpl(that: Data): SpinalStruct.this.type
- Definition Classes
- SpinalStruct → BaseType → Data
- def default(that: => SpinalStruct): SpinalStruct
Set a default value to a data
Set a default value to a data
- Definition Classes
- DataPrimitives
- def dirString(): String
- Definition Classes
- Data
- def dlcAppend(that: AssignmentStatement): SpinalStruct.this.type
- Definition Classes
- DoubleLinkedContainer
- def dlcForeach[T >: AssignmentStatement](func: (T) => Unit): Unit
- Definition Classes
- DoubleLinkedContainer
- def dlcHasOnlyOne: Boolean
- Definition Classes
- DoubleLinkedContainer
- val dlcHead: AssignmentStatement
- Definition Classes
- DoubleLinkedContainer
- def dlcIsEmpty: Boolean
- Definition Classes
- DoubleLinkedContainer
- val dlcLast: AssignmentStatement
- Definition Classes
- DoubleLinkedContainer
- def dlcPrepend(that: AssignmentStatement): SpinalStruct.this.type
- Definition Classes
- DoubleLinkedContainer
- def dontSimplifyIt(): SpinalStruct.this.type
- def elements: ArrayBuffer[(String, Data)]
- Definition Classes
- SpinalStruct → Suffixable
- def elementsString: String
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(obj: Any): Boolean
- Definition Classes
- OverridedEqualsHashCode → AnyRef → Any
- def existsTag(cond: (SpinalTag) => Boolean): Boolean
- Definition Classes
- SpinalTagReady
- def filterTag(cond: (SpinalTag) => Boolean): Iterable[SpinalTag]
- Definition Classes
- SpinalTagReady
- def find(name: String): Data
- def findTag(cond: (SpinalTag) => Boolean): Option[SpinalTag]
- Definition Classes
- SpinalTagReady
- def flatten: Seq[BaseType]
- Definition Classes
- SpinalStruct → BaseType → Data
- def flattenForeach(body: (BaseType) => Unit): Unit
- def flattenLocalName: Seq[String]
- def flip(): SpinalStruct.this.type
flip the direction of the data
flip the direction of the data
- Definition Classes
- Data
- def foreachClockDomain(func: (ClockDomain) => Unit): Unit
- def foreachDrivingExpression(func: (Expression) => Unit): Unit
- Definition Classes
- ExpressionContainer
- def foreachExpression(func: (Expression) => Unit): Unit
- Definition Classes
- DeclarationStatement → ExpressionContainer
- def foreachReflectableNameables(doThat: (Any) => Unit): Unit
- Definition Classes
- Nameable
- def foreachStatements(func: (AssignmentStatement) => Unit): Unit
- Definition Classes
- StatementDoubleLinkedContainer
- def foreachTag(body: (SpinalTag) => Unit): Unit
- Definition Classes
- SpinalTagReady
- def genIf(cond: Boolean): SpinalStruct.this.type
Generate this if condition is true
Generate this if condition is true
- Definition Classes
- Data
- def getBitsWidth: Int
Return the width of the data
Return the width of the data
- Definition Classes
- SpinalStruct → Data
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def getComponent(): Component
- Definition Classes
- Data → InComponent → NameableByComponent
- def getComponents(): Seq[Component]
Get current component with all parents
Get current component with all parents
- Definition Classes
- InComponent
- def getDirection: IODirection
- Definition Classes
- Data
- def getDisplayName(): String
- Definition Classes
- Nameable
- def getDrivingReg: SpinalStruct.this.type
- Definition Classes
- BaseType
- def getInstanceCounter: Int
- Definition Classes
- ContextUser
- def getMode: Byte
- Attributes
- protected
- Definition Classes
- Nameable
- def getName(default: String): String
- Definition Classes
- NameableByComponent → Nameable
- def getName(): String
- Definition Classes
- NameableByComponent → Nameable
- def getPartialName(): String
- Definition Classes
- Nameable
- def getRealSource: Any
- Definition Classes
- Assignable
- def getRealSourceNoRec: Any
- Definition Classes
- Data → Assignable
- def getRefOwnersChain(): List[Any]
- Definition Classes
- OwnableRef
- def getRootParent: Data
- Definition Classes
- Data
- def getScalaLocationLong: String
- Definition Classes
- ScalaLocated
- def getScalaLocationShort: String
- Definition Classes
- ScalaLocated
- def getScalaTrace(): Throwable
- Definition Classes
- ScalaLocated
- def getSingleDriver: Option[SpinalStruct.this.type]
- Definition Classes
- BaseType
- def getTag[T <: SpinalTag](clazz: Class[T]): Option[T]
- Definition Classes
- SpinalTagReady
- def getTags(): LinkedHashSet[SpinalTag]
- Definition Classes
- SpinalTagReady
- def getTypeObject: Any
- Definition Classes
- SpinalStruct → Expression
- def getTypeString: String
- def getZero: SpinalStruct.this.type
Create a data set to 0
Create a data set to 0
- Definition Classes
- SpinalStruct → Data
- val globalData: GlobalData
- Definition Classes
- GlobalDataUser
- def hasAssignement: Boolean
- Definition Classes
- BaseType
- def hasInit: Boolean
Does the base type have initial value
Does the base type have initial value
- Definition Classes
- BaseType
- def hasOnlyOneStatement: Boolean
- Definition Classes
- StatementDoubleLinkedContainer
- def hasTag[T <: SpinalTag](clazz: Class[T]): Boolean
- Definition Classes
- SpinalTagReady
- def hasTag(spinalTag: SpinalTag): Boolean
- Definition Classes
- SpinalTagReady
- def hashCode(): Int
- Definition Classes
- OverridedEqualsHashCode → AnyRef → Any
- def head: AssignmentStatement
- Definition Classes
- StatementDoubleLinkedContainer
- def init(that: SpinalStruct): SpinalStruct
Set initial value to a data
Set initial value to a data
- Definition Classes
- DataPrimitives
- final def initFrom(that: AnyRef, target: AnyRef = this): Unit
- Definition Classes
- Data
- def initialFrom(that: AnyRef, target: AnyRef = this): Unit
- Definition Classes
- BaseType
- def insertNext(s: Statement): Unit
- Definition Classes
- Statement
- def instanceAttributes(language: Language): Iterable[Attribute]
- Definition Classes
- SpinalTagReady
- def instanceAttributes: Iterable[Attribute]
- Definition Classes
- SpinalTagReady
- def isAnalog: Boolean
- def isComb: Boolean
- def isCompletelyUnnamed: Boolean
- Definition Classes
- Nameable
- def isDirectionLess: Boolean
- Definition Classes
- Data
- def isEmptyOfTag: Boolean
- Definition Classes
- SpinalTagReady
- def isInOut: Boolean
- Definition Classes
- Data
- def isInput: Boolean
- Definition Classes
- Data
- def isInputOrInOut: Boolean
- Definition Classes
- Data
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isNamed: Boolean
- Definition Classes
- NameableByComponent → Nameable
- def isOutput: Boolean
- Definition Classes
- Data
- def isOutputOrInOut: Boolean
- Definition Classes
- Data
- def isPriorityApplicable(namePriority: Byte): Boolean
- Definition Classes
- Nameable
- def isReg: Boolean
- def isTypeNode: Boolean
Is the baseType a node
Is the baseType a node
- Definition Classes
- BaseType
- def isUnnamed: Boolean
- Definition Classes
- Nameable
- def isUsingResetSignal: Boolean
Is the basetype using reset signal
Is the basetype using reset signal
- Definition Classes
- BaseType
- def isUsingSoftResetSignal: Boolean
Is the basetype using soft reset signal
Is the basetype using soft reset signal
- Definition Classes
- BaseType
- def isVital: Boolean
Check if the baseType is vital
Check if the baseType is vital
- Definition Classes
- BaseType
- def keep(): SpinalStruct.this.type
- Definition Classes
- Data
- val lastScopeStatement: Statement
- Definition Classes
- Statement
- def mux[T2 <: Data](mappings: (Any, T2)*): T2
- Definition Classes
- BaseType
- def muxList[T2 <: Data](defaultValue: T2, mappings: Seq[(Any, T2)]): T2
- Definition Classes
- BaseType
- def muxList[T2 <: Data](mappings: Seq[(Any, T2)]): T2
- Definition Classes
- BaseType
- def muxListDc[T2 <: Data](mappings: Seq[(Any, T2)]): T2
- Definition Classes
- BaseType
- val name: String
- Attributes
- protected
- Definition Classes
- Nameable
- val nameableRef: Nameable
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val nextScopeStatement: Statement
- Definition Classes
- Statement
- def noBackendCombMerge: SpinalStruct.this.type
- Definition Classes
- Data
- def noCombLoopCheck: SpinalStruct.this.type
- Definition Classes
- Data
- def normalizeInputs: Unit
- Definition Classes
- BaseType → ExpressionContainer
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def onEachAttributes(doIt: (Attribute) => Unit): Unit
- Definition Classes
- SpinalTagReady
- def opName: String
- Definition Classes
- SpinalStruct → Expression
- def overrideLocalName(name: String): SpinalStruct.this.type
- Definition Classes
- Nameable
- val parent: Data
- Definition Classes
- Data
- val parentScope: ScopeStatement
- Definition Classes
- ContextUser
- def pull(): SpinalStruct.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
- def purify(): SpinalStruct.this.type
- Definition Classes
- Data
- 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)
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
- val refOwner: RefOwnerType
- Definition Classes
- OwnableRef
- Annotations
- @DontName()
- def reflectNames(): Unit
- Definition Classes
- Nameable
- def remapDrivingExpressions(func: (Expression) => Expression): Unit
- Definition Classes
- ExpressionContainer
- def remapExpressions(func: (Expression) => Expression): Unit
- Definition Classes
- DeclarationStatement → ExpressionContainer
- def removeAssignments(): SpinalStruct.this.type
Remove all assignments of the base type
- def removeStatement(): Unit
- def removeStatementFromScope(): Unit
- Definition Classes
- Statement
- def removeTag(spinalTag: SpinalTag): SpinalStruct.this.type
- Definition Classes
- SpinalTagReady
- def removeTags(tags: Iterable[SpinalTag]): SpinalStruct.this.type
- Definition Classes
- SpinalTagReady
- def resized: SpinalStruct.this.type
Resized data regarding target
Resized data regarding target
- Definition Classes
- Data
- def rootScopeStatement: ScopeStatement
- def setAsAnalog(): SpinalStruct.this.type
- def setAsComb(): SpinalStruct.this.type
Set baseType to Combinatorial
Set baseType to Combinatorial
- Definition Classes
- SpinalStruct → BaseType → Data
- def setAsDirectionLess(): SpinalStruct.this.type
remove the direction (in,out,inout) to a data
remove the direction (in,out,inout) to a data
- Definition Classes
- SpinalStruct → BaseType → Data
- def setAsReg(): SpinalStruct.this.type
Set baseType to reg
Set baseType to reg
- Definition Classes
- SpinalStruct → BaseType → Data
- def setAsTypeNode(): SpinalStruct.this.type
Set baseType to Node
Set baseType to Node
- Definition Classes
- BaseType
- def setAsVital(): SpinalStruct.this.type
Set the baseType to vital
Set the baseType to vital
- Definition Classes
- BaseType
- def setCompositeName(nameable: Nameable, postfix: String, namePriority: Byte): SpinalStruct.this.type
- Definition Classes
- Nameable
- def setCompositeName(nameable: Nameable, postfix: String, weak: Boolean): SpinalStruct.this.type
- Definition Classes
- Nameable
- def setCompositeName(nameable: Nameable, postfix: String): SpinalStruct.this.type
- Definition Classes
- Nameable
- def setCompositeName(nameable: Nameable, namePriority: Byte): SpinalStruct.this.type
- Definition Classes
- Nameable
- def setCompositeName(nameable: Nameable, weak: Boolean): SpinalStruct.this.type
- Definition Classes
- Nameable
- def setCompositeName(nameable: Nameable): SpinalStruct.this.type
- Definition Classes
- Nameable
- def setName(name: String, namePriority: Byte): SpinalStruct.this.type
- Definition Classes
- Nameable
- def setName(name: String, weak: Boolean): SpinalStruct.this.type
- Definition Classes
- Nameable
- def setName(name: String): SpinalStruct.this.type
- Definition Classes
- Nameable
- def setNameAsWeak(): SpinalStruct.this.type
- Definition Classes
- Nameable
- def setPartialName(name: String, namePriority: Byte): SpinalStruct.this.type
- Definition Classes
- Nameable
- def setPartialName(name: String, weak: Boolean): SpinalStruct.this.type
- Definition Classes
- Nameable
- def setPartialName(owner: Nameable, name: String, namePriority: Byte): SpinalStruct.this.type
- Definition Classes
- Nameable
- def setPartialName(owner: Nameable, name: String, weak: Boolean): SpinalStruct.this.type
- Definition Classes
- Nameable
- def setPartialName(name: String): SpinalStruct.this.type
- Definition Classes
- Nameable
- def setPartialName(owner: Nameable, name: String): SpinalStruct.this.type
- Definition Classes
- Nameable
- def setRefOwner(that: Any): Unit
- Definition Classes
- OwnableRef
- def setScalaLocated(source: ScalaLocated): SpinalStruct.this.type
- Definition Classes
- ScalaLocated
- def setWeakName(name: String): SpinalStruct.this.type
- Definition Classes
- Nameable
- def simplifyNode: Expression
- Definition Classes
- Expression
- def spinalTags: LinkedHashSet[SpinalTag]
- Definition Classes
- SpinalTagReady
- def stabilized(func: (Expression) => Expression, seed: Expression): Expression
- Definition Classes
- ExpressionContainer
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toIo(): SpinalStruct.this.type
- Definition Classes
- Data
- def toString(): String
- Definition Classes
- BaseType → Expression → Nameable → AnyRef → Any
- def toStringMultiLine(): String
- Definition Classes
- BaseNode
- val typeName: String
- def unsetName(): SpinalStruct.this.type
- Definition Classes
- Nameable
- def valCallback[T](ref: T, name: String): T
- Definition Classes
- ValCallbackRec → ValCallback
- def valCallbackOn(ref: Any, name: String, refs: Set[Any]): Unit
- Definition Classes
- ValCallbackRec
- def valCallbackRec(ref: Any, name: String): Unit
- Definition Classes
- SpinalStruct → ValCallbackRec
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- def walkDrivingExpressions(func: (Expression) => Unit): Unit
- Definition Classes
- ExpressionContainer
- def walkExpression(func: (Expression) => Unit): Unit
- Definition Classes
- ExpressionContainer
- def walkExpressionPostorder(func: (Expression) => Unit): Unit
- Definition Classes
- ExpressionContainer
- def walkParentTreeStatements(func: (TreeStatement) => Unit): Unit
- Definition Classes
- Statement
- def walkParentTreeStatementsUntilRootScope(func: (TreeStatement) => Unit): Unit
- Definition Classes
- Statement
- def walkRemapDrivingExpressions(func: (Expression) => Expression): Unit
- Definition Classes
- ExpressionContainer
- def walkRemapExpressions(func: (Expression) => Expression): Unit
- Definition Classes
- ExpressionContainer
- def wrapCast[T <: BaseType](result: T, node: Cast): T
- Definition Classes
- BaseType
Deprecated Value Members
- def asDirectionLess(): SpinalStruct.this.type
- Definition Classes
- Data
- Annotations
- @deprecated
- Deprecated
(Since version ???) use setAsDirectionLess instead
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated