Class

spinal.core

Bool

Related Doc: package core

Permalink

class Bool extends BaseType with DataPrimitives[Bool] with BaseTypePrimitives[Bool] with BitwiseOp[Bool]

The Bool type corresponds to a boolean value (True or False)

Example:
  1. val myBool = Bool()
    myBool := False
    myBool := Bool(false)
See also

Bool Documentation

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Bool
  2. BitwiseOp
  3. BaseTypePrimitives
  4. DataPrimitives
  5. BaseType
  6. Expression
  7. StatementDoubleLinkedContainer
  8. DoubleLinkedContainer
  9. DeclarationStatement
  10. LeafStatement
  11. Statement
  12. BaseNode
  13. ExpressionContainer
  14. Data
  15. InComponent
  16. OverridedEqualsHashCode
  17. SpinalTagReady
  18. Assignable
  19. NameableByComponent
  20. Nameable
  21. OwnableRef
  22. ContextUser
  23. ScalaLocated
  24. GlobalDataUser
  25. AnyRef
  26. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Bool()

    Permalink

Type Members

  1. class MuxBuilder[T <: Data] extends AnyRef

    Permalink

    Class used to write conditional operation on Data value

    Class used to write conditional operation on Data value

    Example:
    1. val res = myBool ? myBits1 | myBits2
  2. case class MuxBuilderEnum[T <: SpinalEnum](whenTrue: SpinalEnumCraft[T]) extends Product with Serializable

    Permalink

    Class used to write conditional operation on Enumeration value

    Class used to write conditional operation on Enumeration value

    Example:
    1. val res = myBool ? myEnum1 | myEnum2
    Note

    implicit conversion is used to send SpinalEnumElement

  3. abstract type RefOwnerType

    Permalink
    Definition Classes
    OwnableRef

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. def ##(right: Data): Bits

    Permalink

    Concatenation between two data

    Concatenation between two data

    Definition Classes
    Data
  3. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  4. def #*(count: Int): Bits

    Permalink
    Definition Classes
    BoolData
  5. def &(b: Bool): Bool

    Permalink

    Bitwise AND operator

    Bitwise AND operator

    Definition Classes
    BoolBitwiseOp
  6. def &&(b: Bool): Bool

    Permalink

    Logical AND

    Logical AND

    returns

    a Bool assign with the AND result

    Example:
    1. val result = myBool1 && myBool2
  7. def :=(that: Bool)(implicit loc: Location): Unit

    Permalink

    Assign a data to this

    Assign a data to this

    Definition Classes
    DataPrimitives
  8. def <>(that: Bool)(implicit loc: Location): Unit

    Permalink

    Auto connection between two data

    Auto connection between two data

    Definition Classes
    DataPrimitives
  9. def =/=(that: MaskedBoolean): Bool

    Permalink

    BitVector is not equal to MaskedLiteral

  10. def =/=(that: Bool): Bool

    Permalink
    Definition Classes
    DataPrimitives
  11. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  12. def ===(that: MaskedBoolean): Bool

    Permalink
  13. def ===(that: Bool): Bool

    Permalink

    Comparison between two data

    Comparison between two data

    Definition Classes
    DataPrimitives
  14. def ?[T <: SpinalEnum](whenTrue: SpinalEnumCraft[T]): MuxBuilderEnum[T]

    Permalink

    Conditional operation for Enumeration value

  15. def ?[T <: Data](whenTrue: T): MuxBuilder[T]

    Permalink

    Conditional operation for Data value

  16. def IFparent: Data

    Permalink
    Definition Classes
    Data
  17. def \(that: Bool): Bool

    Permalink

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

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

    Definition Classes
    DataPrimitives
  18. def ^(b: Bool): Bool

    Permalink

    Bitwise XOR operator

    Bitwise XOR operator

    Definition Classes
    BoolBitwiseOp
  19. var _spinalTags: LinkedHashSet[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady
  20. def addAttribute(attribute: Attribute): Bool.this.type

    Permalink
    Definition Classes
    BaseTypeDataSpinalTagReady
  21. def addAttribute(name: String, value: Int): Bool.this.type

    Permalink
    Definition Classes
    SpinalTagReady
  22. def addAttribute(name: String, value: String): Bool.this.type

    Permalink
    Definition Classes
    SpinalTagReady
  23. def addAttribute(name: String): Bool.this.type

    Permalink
    Definition Classes
    SpinalTagReady
  24. def addTag[T <: SpinalTag](spinalTag: T): Bool.this.type

    Permalink
    Definition Classes
    SpinalTagReady
  25. def addTags(h: SpinalTag, tail: SpinalTag*): Bool.this.type

    Permalink
    Definition Classes
    SpinalTagReady
  26. def addTags[T <: SpinalTag](tags: Iterable[T]): Bool.this.type

    Permalink
    Definition Classes
    SpinalTagReady
  27. var algoIncrementale: Int

    Permalink
    Definition Classes
    BaseNode
  28. var algoInt: Int

    Permalink
    Definition Classes
    BaseNode
  29. def allowDirectionLessIo(): Bool.this.type

    Permalink

    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
  30. def allowOutOfRangeLiterals: Bool.this.type

    Permalink
  31. def allowOverride(): Bool.this.type

    Permalink

    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
  32. def allowPartialyAssigned(): Bool.this.type

    Permalink

    Allow a register to be partially assigned

    Allow a register to be partially assigned

    Definition Classes
    Data
  33. def allowPruning(): Bool.this.type

    Permalink
    Definition Classes
    Data
  34. def allowSimplifyIt(): Bool.this.type

    Permalink
    Definition Classes
    BaseTypeData
  35. def allowUnsetRegToAvoidLatch(): Bool.this.type

    Permalink

    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
  36. def as[T <: Data](dataType: HardType[T]): T

    Permalink
    Definition Classes
    Data
  37. def asBits: Bits

    Permalink

    Cast data to Bits

    Cast data to Bits

    Definition Classes
    BoolData
  38. def asBits(bitCount: BitCount): Bits

    Permalink

    Cast a Bool to an Bits of a given width

    Cast a Bool to an Bits of a given width

    bitCount

    the width of the Bits

    returns

    a Bits data of a given length initialize to this

  39. def asData: Data

    Permalink
    Definition Classes
    Data
  40. def asInOut(): Bool.this.type

    Permalink

    set a data as inout

    set a data as inout

    Definition Classes
    BaseTypeData
  41. def asInput(): Bool.this.type

    Permalink

    Set a data as input

    Set a data as input

    Definition Classes
    BaseTypeData
  42. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  43. def asOutput(): Bool.this.type

    Permalink

    Set a data as output

    Set a data as output

    Definition Classes
    BaseTypeData
  44. def asSInt(bitCount: BitCount): SInt

    Permalink
  45. def asSInt: SInt

    Permalink

    Cast a Bool to an SInt

    Cast a Bool to an SInt

    returns

    a SInt data

    Example:
    1. mySInt := myBool.asSInt
  46. def asUInt(bitCount: BitCount): UInt

    Permalink

    Cast a Bool to an UInt of a given width

    Cast a Bool to an UInt of a given width

    bitCount

    the width of the UInt

    returns

    an UInt data of a given length initialize to this

    Example:
    1. myUInt := myBool.asUInt(8 bits)
  47. def asUInt: UInt

    Permalink

    Cast a Bool to an UInt

    Cast a Bool to an UInt

    returns

    an UInt data

    Example:
    1. myUInt := myBool.asUInt
  48. def assignDontCare(): Bool.this.type

    Permalink
    Definition Classes
    BoolData
  49. def assignDontCareToUnasigned(): Bool.this.type

    Permalink
    Definition Classes
    Data
  50. def assignFormalRandom(kind: RandomExpKind): Unit

    Permalink
    Definition Classes
    BoolData
  51. final def assignFrom(that: AnyRef, target: AnyRef = this)(implicit loc: Location): Unit

    Permalink
    Definition Classes
    Data
  52. def assignFromBits(bits: Bits, hi: Int, low: Int): Unit

    Permalink
    Definition Classes
    BoolData
  53. def assignFromBits(bits: Bits): Unit

    Permalink
    Definition Classes
    BoolData
  54. def assignFromBits(bits: Bits, offset: Int, bitCount: BitCount): Unit

    Permalink
    Definition Classes
    Data
  55. def assignFromImpl(that: AnyRef, target: AnyRef, kind: AnyRef)(implicit loc: Location): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    BaseTypeAssignable
  56. def cldCount: Int

    Permalink
    Definition Classes
    DoubleLinkedContainer
  57. def clear(): Unit

    Permalink

    this is assigned to False

  58. def clearAll(): Bool.this.type

    Permalink

    Set to False.

    Set to False.

    Direct call to clear() to reduce the number of nodes in the netlist.

    Definition Classes
    BoolData
  59. def clearWhen(cond: Bool)(implicit loc: Location): Bool

    Permalink

    this is assigned to False when cond is True

  60. var clockDomain: ClockDomain

    Permalink
    Definition Classes
    BaseType
  61. def clone(): Bool.this.type

    Permalink
    Definition Classes
    BaseTypeData → AnyRef
  62. def component: Component

    Permalink
    Definition Classes
    ContextUser
  63. final def compositAssignFrom(that: AnyRef, target: AnyRef, kind: AnyRef)(implicit loc: Location): Unit

    Permalink
    Definition Classes
    Assignable
  64. var compositeAssign: Assignable

    Permalink
    Definition Classes
    Assignable
  65. def copyDirectionOf(that: Bool): Unit

    Permalink
    Definition Classes
    DataPrimitives
  66. def copyDirectionOfImpl(that: Data): Bool.this.type

    Permalink
    Definition Classes
    BaseTypeData
  67. def default(that: ⇒ Bool): Bool

    Permalink

    Set a default value to a data

    Set a default value to a data

    Definition Classes
    DataPrimitives
  68. def dirString(): String

    Permalink
    Definition Classes
    Data
  69. def dlcAppend(that: AssignmentStatement): Bool.this.type

    Permalink
    Definition Classes
    DoubleLinkedContainer
  70. def dlcForeach[T >: AssignmentStatement](func: (T) ⇒ Unit): Unit

    Permalink
    Definition Classes
    DoubleLinkedContainer
  71. def dlcHasOnlyOne: Boolean

    Permalink
    Definition Classes
    DoubleLinkedContainer
  72. var dlcHead: AssignmentStatement

    Permalink
    Definition Classes
    DoubleLinkedContainer
  73. def dlcIsEmpty: Boolean

    Permalink
    Definition Classes
    DoubleLinkedContainer
  74. var dlcLast: AssignmentStatement

    Permalink
    Definition Classes
    DoubleLinkedContainer
  75. def dlcPrepend(that: AssignmentStatement): Bool.this.type

    Permalink
    Definition Classes
    DoubleLinkedContainer
  76. def dontSimplifyIt(): Bool.this.type

    Permalink
    Definition Classes
    BaseTypeData
  77. def edge(): Bool

    Permalink

    Edge detection

  78. def edge(initAt: Bool): Bool

    Permalink

    Edge detection of this with an initial value

    Edge detection of this with an initial value

    initAt

    the initial value

    returns

    a Bool

    Example:
    1. val res = myBool.edge(False)
  79. def edges(): BoolEdges

    Permalink

    Edge detection without intial value

  80. def edges(initAt: Bool): BoolEdges

    Permalink

    Detect all edges (falling, rising, toogling)

    Detect all edges (falling, rising, toogling)

    initAt

    the initial value

    returns

    a BoolEdges

    Example:
    1. val res = myBool.edges()
      when(res.fall){...}
      when(res.rise){...}
      when(res.toggle){...}
  81. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  82. def equals(obj: Any): Boolean

    Permalink
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  83. def existsTag(cond: (SpinalTag) ⇒ Boolean): Boolean

    Permalink
    Definition Classes
    SpinalTagReady
  84. def fall(): Bool

    Permalink

    Falling edge detection

  85. def fall(initAt: Bool): Bool

    Permalink

    Falling edge detection of this with an initial value

    Falling edge detection of this with an initial value

    initAt

    the initial value

    returns

    a Bool

    Example:
    1. val res = myBool.fall(False)
  86. def fallWhen(cond: Bool)(implicit loc: Location): Bool

    Permalink

    this is assigned to False when cond is True and the current value of this is True.

    this is assigned to False when cond is True and the current value of this is True. see riseWhen()

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

    Permalink
    Definition Classes
    SpinalTagReady
  88. def findTag(cond: (SpinalTag) ⇒ Boolean): Option[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady
  89. def flatten: Seq[BaseType]

    Permalink
    Definition Classes
    BaseTypeData
  90. def flattenForeach(body: (BaseType) ⇒ Unit): Unit

    Permalink
    Definition Classes
    BaseTypeData
  91. def flattenLocalName: Seq[String]

    Permalink
    Definition Classes
    BaseTypeData
  92. def flip(): Bool.this.type

    Permalink

    flip the direction of the data

    flip the direction of the data

    Definition Classes
    Data
  93. def foreachClockDomain(func: (ClockDomain) ⇒ Unit): Unit

    Permalink
    Definition Classes
    BaseTypeStatement
  94. def foreachDrivingExpression(func: (Expression) ⇒ Unit): Unit

    Permalink
    Definition Classes
    ExpressionContainer
  95. def foreachExpression(func: (Expression) ⇒ Unit): Unit

    Permalink
  96. def foreachReflectableNameables(doThat: (Any) ⇒ Unit): Unit

    Permalink
    Definition Classes
    Nameable
  97. def foreachStatements(func: (AssignmentStatement) ⇒ Unit): Unit

    Permalink
  98. def foreachTag(body: (SpinalTag) ⇒ Unit): Unit

    Permalink
    Definition Classes
    SpinalTagReady
  99. def freeze(): Bool.this.type

    Permalink
    Definition Classes
    BaseTypeData
  100. def getAheadValue(): Bool.this.type

    Permalink

    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
    BaseTypeData
  101. def getBitsWidth: Int

    Permalink

    Return the width of the data

    Return the width of the data

    Definition Classes
    BoolData
  102. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  103. def getComponent(): Component

    Permalink
    Definition Classes
    DataInComponentNameableByComponent
  104. def getComponents(): Seq[Component]

    Permalink

    Get current component with all parents

    Get current component with all parents

    Definition Classes
    InComponent
  105. def getDirection: IODirection

    Permalink
    Definition Classes
    Data
  106. def getDisplayName(): String

    Permalink
    Definition Classes
    Nameable
  107. def getDrivingReg(reportError: Boolean = true): Bool.this.type

    Permalink
    Definition Classes
    BaseType
  108. def getInstanceCounter: Int

    Permalink
    Definition Classes
    ContextUser
  109. def getMode: Byte

    Permalink
    Attributes
    protected
    Definition Classes
    Nameable
  110. def getMuxType[T <: Data](list: TraversableOnce[T]): HardType[T]

    Permalink
    Definition Classes
    Data
  111. def getName(default: String): String

    Permalink
    Definition Classes
    NameableByComponentNameable
  112. def getName(): String

    Permalink
    Definition Classes
    NameableByComponentNameable
  113. def getPartialName(): String

    Permalink
    Definition Classes
    Nameable
  114. def getPath(from: Component, to: Component): Seq[Component]

    Permalink
    Definition Classes
    NameableByComponent
  115. def getRealSource: Any

    Permalink
    Definition Classes
    Assignable
  116. def getRealSourceNoRec: Any

    Permalink
    Definition Classes
    DataAssignable
  117. def getRefOwnersChain(): List[Any]

    Permalink
    Definition Classes
    OwnableRef
  118. def getRootParent: Data

    Permalink
    Definition Classes
    Data
  119. def getRtlPath(separator: String = "/"): String

    Permalink
    Definition Classes
    Data
  120. def getScalaLocationLong: String

    Permalink
    Definition Classes
    ScalaLocated
  121. def getScalaLocationShort: String

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

    Permalink
    Definition Classes
    ScalaLocated
  123. def getSingleDriver: Option[Bool.this.type]

    Permalink
    Definition Classes
    BaseType
  124. def getTag[T <: SpinalTag](clazz: Class[T]): Option[T]

    Permalink
    Definition Classes
    SpinalTagReady
  125. def getTags(): LinkedHashSet[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady
  126. def getTypeObject: TypeBool.type

    Permalink
    Definition Classes
    BoolExpression
  127. def getZero: Bool.this.type

    Permalink

    Create a data set to 0

    Create a data set to 0

    Definition Classes
    BoolData
  128. var globalData: GlobalData

    Permalink
    Definition Classes
    GlobalDataUser
  129. def hasAssignement: Boolean

    Permalink
    Definition Classes
    BaseType
  130. def hasDataAssignment: Boolean

    Permalink
    Definition Classes
    BaseType
  131. def hasInit: Boolean

    Permalink

    Does the base type have initial value

    Does the base type have initial value

    Definition Classes
    BaseType
  132. def hasOnlyOneStatement: Boolean

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

    Permalink
    Definition Classes
    SpinalTagReady
  134. def hasTag(spinalTag: SpinalTag): Boolean

    Permalink
    Definition Classes
    SpinalTagReady
  135. def hashCode(): Int

    Permalink
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  136. def head: AssignmentStatement

    Permalink
  137. def init(value: Boolean): Bool

    Permalink
  138. def init(that: Bool): Bool

    Permalink

    Set initial value to a data

    Set initial value to a data

    Definition Classes
    DataPrimitives
  139. final def initFrom(that: AnyRef, target: AnyRef = this): Unit

    Permalink
    Definition Classes
    Data
  140. def initial(that: Bool): Bool

    Permalink
    Definition Classes
    BaseTypePrimitives
  141. def initialFrom(that: AnyRef, target: AnyRef = this): Unit

    Permalink
    Definition Classes
    BaseType
  142. def insertNext(s: Statement): Unit

    Permalink
    Definition Classes
    Statement
  143. def instanceAttributes(language: Language): Iterable[Attribute]

    Permalink
    Definition Classes
    SpinalTagReady
  144. def instanceAttributes: Iterable[Attribute]

    Permalink
    Definition Classes
    SpinalTagReady
  145. def isAnalog: Boolean

    Permalink
    Definition Classes
    BaseTypeData
  146. def isComb: Boolean

    Permalink
    Definition Classes
    BaseTypeData
  147. def isCompletelyUnnamed: Boolean

    Permalink
    Definition Classes
    Nameable
  148. def isDirectionLess: Boolean

    Permalink
    Definition Classes
    Data
  149. def isEmptyOfTag: Boolean

    Permalink
    Definition Classes
    SpinalTagReady
  150. def isFrozen(): Boolean

    Permalink
    Definition Classes
    BaseType
  151. def isInOut: Boolean

    Permalink
    Definition Classes
    Data
  152. def isInput: Boolean

    Permalink
    Definition Classes
    Data
  153. def isInputOrInOut: Boolean

    Permalink
    Definition Classes
    Data
  154. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  155. final def isNamed: Boolean

    Permalink
    Definition Classes
    Nameable
  156. def isOutput: Boolean

    Permalink
    Definition Classes
    Data
  157. def isOutputOrInOut: Boolean

    Permalink
    Definition Classes
    Data
  158. def isPriorityApplicable(namePriority: Byte): Boolean

    Permalink
    Definition Classes
    Nameable
  159. def isReg: Boolean

    Permalink
    Definition Classes
    BaseTypeData
  160. def isRegOnAssign: Boolean

    Permalink
    Definition Classes
    Data
  161. def isTypeNode: Boolean

    Permalink

    Is the baseType a node

    Is the baseType a node

    Definition Classes
    BaseType
  162. def isUnknown: Bool

    Permalink
  163. def isUnnamed: Boolean

    Permalink
    Definition Classes
    NameableByComponentNameable
  164. def isUsingResetSignal: Boolean

    Permalink

    Is the basetype using reset signal

    Is the basetype using reset signal

    Definition Classes
    BaseType
  165. def isUsingSoftResetSignal: Boolean

    Permalink

    Is the basetype using soft reset signal

    Is the basetype using soft reset signal

    Definition Classes
    BaseType
  166. def isVital: Boolean

    Permalink

    Check if the baseType is vital

    Check if the baseType is vital

    Definition Classes
    BaseType
  167. var lastScopeStatement: Statement

    Permalink
    Definition Classes
    Statement
  168. def mux[T <: SpinalEnum](t: SpinalEnumElement[T], f: SpinalEnumElement[T]): SpinalEnumCraft[T]

    Permalink
  169. def mux[T <: Data](t: T, f: T): T

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

    Permalink
    Definition Classes
    BaseType
  171. def muxDc[T2 <: Data](mappings: (Any, T2)*): T2

    Permalink
    Definition Classes
    BaseType
  172. def muxList[T2 <: Data](defaultValue: T2, mappings: Seq[(Any, T2)]): T2

    Permalink
    Definition Classes
    BaseType
  173. def muxList[T2 <: Data](mappings: Seq[(Any, T2)]): T2

    Permalink
    Definition Classes
    BaseType
  174. def muxListDc[T2 <: Data](mappings: Seq[(Any, T2)]): T2

    Permalink
    Definition Classes
    BaseType
  175. var name: String

    Permalink
    Definition Classes
    Nameable
  176. var nameableRef: Nameable

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

    Permalink
    Definition Classes
    AnyRef
  178. var nextScopeStatement: Statement

    Permalink
    Definition Classes
    Statement
  179. def noBackendCombMerge(): Bool.this.type

    Permalink

    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
  180. def noCombLoopCheck(): Bool.this.type

    Permalink

    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
  181. def normalizeInputs: Unit

    Permalink
    Definition Classes
    BaseTypeExpressionContainer
  182. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  184. def onEachAttributes(doIt: (Attribute) ⇒ Unit): Unit

    Permalink
    Definition Classes
    SpinalTagReady
  185. def opName: String

    Permalink
    Definition Classes
    BoolExpression
  186. def overrideLocalName(name: String): Bool.this.type

    Permalink
    Definition Classes
    Nameable
  187. var parent: Data

    Permalink
    Definition Classes
    Data
  188. var parentScope: ScopeStatement

    Permalink
    Definition Classes
    ContextUser
  189. def pull(propagateName: Boolean): Bool.this.type

    Permalink
    Definition Classes
    Data
  190. def pull(): Bool.this.type

    Permalink

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

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

    Definition Classes
    Data
  191. def purify(): Bool.this.type

    Permalink
    Definition Classes
    Data
  192. def randBoot(u: Unit): Bool.this.type

    Permalink

    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
  193. var refOwner: RefOwnerType

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

    Permalink
    Definition Classes
    Nameable
  195. def remapClockDomain(func: (ClockDomain) ⇒ ClockDomain): Unit

    Permalink
    Definition Classes
    BaseTypeStatement
  196. def remapDrivingExpressions(func: (Expression) ⇒ Expression): Unit

    Permalink
    Definition Classes
    ExpressionContainer
  197. def remapExpressions(func: (Expression) ⇒ Expression): Unit

    Permalink
  198. def removeAssignments(data: Boolean = true, init: Boolean = true, initial: Boolean = true): Bool.this.type

    Permalink

    Remove all assignments of the base type

    Remove all assignments of the base type

    Definition Classes
    BaseTypeData
  199. def removeDataAssignments(): Bool.this.type

    Permalink
    Definition Classes
    Data
  200. def removeInitAssignments(): Bool.this.type

    Permalink
    Definition Classes
    Data
  201. def removeStatement(): Unit

    Permalink
    Definition Classes
    BaseTypeStatement
  202. def removeStatementFromScope(): Unit

    Permalink
    Definition Classes
    Statement
  203. def removeTag(spinalTag: SpinalTag): Bool.this.type

    Permalink
    Definition Classes
    SpinalTagReady
  204. def removeTags(tags: Iterable[SpinalTag]): Bool.this.type

    Permalink
    Definition Classes
    SpinalTagReady
  205. def resized: Bool.this.type

    Permalink

    Resized data regarding target

    Resized data regarding target

    Definition Classes
    Data
  206. def rise(): Bool

    Permalink

    Rising edge detection

  207. def rise(initAt: Bool): Bool

    Permalink

    Rising edge detection of this with an initial value

    Rising edge detection of this with an initial value

    initAt

    the initial value

    returns

    a Bool

    Example:
    1. val res = myBool.rise(False)
  208. def riseWhen(cond: Bool)(implicit loc: Location): Bool

    Permalink

    this is assigned to True when cond is True and the current value of this is False.

    this is assigned to True when cond is True and the current value of this is False. Useful for coding a simple boolean state machine. riseWhen() is typically paired with fallWhen() but also works together with setWhen() and clearWhen().

    cond

    a Bool condition

    returns

    this is rising when cond is True

    Example:
    1. val active = RegInit(False) riseWhen(request) fallWhen(acknowledge)
  209. def rootIF(): Interface

    Permalink

    root interface

    root interface

    Definition Classes
    Data
  210. def rootIFList(): List[Interface]

    Permalink
    Definition Classes
    Data
  211. def rootIFrec(now: Data, lastRoot: List[Interface]): List[Interface]

    Permalink
    Definition Classes
    Data
  212. def rootScopeStatement: ScopeStatement

    Permalink
    Definition Classes
    BaseTypeStatement
  213. var scalaTrace: Throwable

    Permalink
    Definition Classes
    ScalaLocated
  214. def set(): Unit

    Permalink

    this is assigned to True

  215. def setAll(): Bool.this.type

    Permalink

    Set to True.

    Set to True.

    Direct call to set() to reduce the number of nodes in the netlist.

    Definition Classes
    BoolData
  216. def setAsAnalog(): Bool.this.type

    Permalink
    Definition Classes
    BaseTypeData
  217. def setAsComb(): Bool.this.type

    Permalink

    Set baseType to Combinatorial

    Set baseType to Combinatorial

    Definition Classes
    BaseTypeData
  218. def setAsDirectionLess(): Bool.this.type

    Permalink

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

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

    Definition Classes
    BaseTypeData
  219. def setAsReg(): Bool.this.type

    Permalink

    Set baseType to reg

    Set baseType to reg

    Definition Classes
    BaseTypeData
  220. def setAsTypeNode(): Bool.this.type

    Permalink

    Set baseType to Node

    Set baseType to Node

    Definition Classes
    BaseType
  221. def setAsVital(): Bool.this.type

    Permalink

    Set the baseType to vital

    Set the baseType to vital

    Definition Classes
    BaseType
  222. def setCompositeName(nameable: Nameable, postfix: String, namePriority: Byte): Bool.this.type

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

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

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

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

    Permalink
    Definition Classes
    Nameable
  227. def setCompositeName(nameable: Nameable): Bool.this.type

    Permalink
    Definition Classes
    Nameable
  228. def setLambdaName(isNameBody: ⇒ Boolean)(nameGen: ⇒ String): Bool.this.type

    Permalink
    Definition Classes
    Nameable
  229. def setName(name: String, namePriority: Byte): Bool.this.type

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

    Permalink
    Definition Classes
    Nameable
  231. def setName(name: String): Bool.this.type

    Permalink
    Definition Classes
    Nameable
  232. def setNameAsWeak(): Bool.this.type

    Permalink
    Definition Classes
    Nameable
  233. def setOutputAsReg(): Bool.this.type

    Permalink

    Recursively set baseType to reg only for output

    Recursively set baseType to reg only for output

    Definition Classes
    Data
  234. def setPartialName(name: String, namePriority: Byte, owner: Any): Bool.this.type

    Permalink
    Definition Classes
    Nameable
  235. def setPartialName(name: String, namePriority: Byte): Bool.this.type

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

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

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

    Permalink
    Definition Classes
    Nameable
  239. def setPartialName(name: String): Bool.this.type

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

    Permalink
    Definition Classes
    Nameable
  241. def setPartialName(owner: Nameable): Bool.this.type

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

    Permalink
    Definition Classes
    OwnableRef
  243. def setScalaLocated(source: ScalaLocated): Bool.this.type

    Permalink
    Definition Classes
    ScalaLocated
  244. def setWeakName(name: String): Bool.this.type

    Permalink
    Definition Classes
    Nameable
  245. def setWhen(cond: Bool)(implicit loc: Location): Bool

    Permalink

    this is assigned to True when cond is True

    this is assigned to True when cond is True

    cond

    a Bool condition

    returns

    this is assigned to True when cond is True

    Example:
    1. myBool.setWhen(cond)
  246. def simplifyNode: Expression

    Permalink
    Definition Classes
    Expression
  247. def spinalTags: LinkedHashSet[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady
  248. def stabilized(func: (Expression) ⇒ Expression, seed: Expression): Expression

    Permalink
    Definition Classes
    ExpressionContainer
  249. def switchAssign[T2 <: BaseType](sel: T2)(mappings: (Any, Bool)*): Unit

    Permalink
    Definition Classes
    DataPrimitives
  250. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  251. def toIo(): Bool.this.type

    Permalink
    Definition Classes
    Data
  252. def toMuxInput[T <: Data](muxOutput: T): T

    Permalink
    Definition Classes
    Data
  253. def toString(): String

    Permalink
    Definition Classes
    BaseTypeExpressionNameable → AnyRef → Any
  254. def toStringMultiLine(): String

    Permalink
    Definition Classes
    BaseNode
  255. def toStringRec(level: Int = 1): String

    Permalink
    Definition Classes
    Expression
  256. def toggleWhen(cond: Bool)(implicit loc: Location): Bool

    Permalink

    this is inverted when cond is True

    this is inverted when cond is True

    cond

    a Bool condition

    returns

    this is inverted when cond is True

    Example:
    1. mybool.toggleWhen(request)
  257. def unary_!: Bool

    Permalink

    Logical NOT

    Logical NOT

    returns

    a Bool assign with the NOT result

    Example:
    1. val result = !myBool1
  258. def unary_~: Bool

    Permalink

    Inverse bitwise operator

    Inverse bitwise operator

    Definition Classes
    BoolBitwiseOp
  259. def unfreeze(): Bool.this.type

    Permalink
    Definition Classes
    BaseTypeData
  260. def unsetName(): Bool.this.type

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  264. def walkDrivingExpressions(func: (Expression) ⇒ Unit): Unit

    Permalink
    Definition Classes
    ExpressionContainer
  265. def walkExpression(func: (Expression) ⇒ Unit): Unit

    Permalink
    Definition Classes
    ExpressionContainer
  266. def walkExpressionPostorder(func: (Expression) ⇒ Unit): Unit

    Permalink
    Definition Classes
    ExpressionContainer
  267. def walkParentTreeStatements(func: (TreeStatement) ⇒ Unit): Unit

    Permalink
    Definition Classes
    Statement
  268. def walkParentTreeStatementsUntilRootScope(func: (TreeStatement) ⇒ Unit): Unit

    Permalink
    Definition Classes
    Statement
  269. def walkRemapDrivingExpressions(func: (Expression) ⇒ Expression): Unit

    Permalink
    Definition Classes
    ExpressionContainer
  270. def walkRemapExpressions(func: (Expression) ⇒ Expression): Unit

    Permalink
    Definition Classes
    ExpressionContainer
  271. def wrapCast[T <: BaseType](result: T, node: Cast): T

    Permalink
    Definition Classes
    BaseType
  272. def wrapNext(): Bool.this.type

    Permalink
    Definition Classes
    Data
  273. def |(b: Bool): Bool

    Permalink

    Bitwise OR operator

    Bitwise OR operator

    Definition Classes
    BoolBitwiseOp
  274. def ||(b: Bool): Bool

    Permalink

    Logical OR

    Logical OR

    returns

    a Bool assign with the OR result

    Example:
    1. val result = myBool1 || myBool2

Deprecated Value Members

  1. def asDirectionLess(): Bool.this.type

    Permalink
    Definition Classes
    Data
    Annotations
    @deprecated
    Deprecated

    (Since version ???) use setAsDirectionLess 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.

  3. def genIf(cond: Boolean): Bool.this.type

    Permalink

    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 BitwiseOp[Bool]

Inherited from BaseTypePrimitives[Bool]

Inherited from DataPrimitives[Bool]

Inherited from BaseType

Inherited from Expression

Inherited from DeclarationStatement

Inherited from LeafStatement

Inherited from Statement

Inherited from BaseNode

Inherited from ExpressionContainer

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