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 hardware 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 signals

    Concatenation between two signals

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

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

    Permalink

    Hardware repeat count time a Bool

    Hardware repeat count time a Bool

    returns

    Bits(count bits)

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

    Permalink

    Bitwise AND operator

    Bitwise AND operator

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

    Permalink

    Hardware logical AND

    Hardware 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

    Standard hardware assignment, equivalent to <= in VHDL/Verilog

    Standard hardware assignment, equivalent to <= in VHDL/Verilog

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

    Permalink

    Automatic connection between two hardware signals or two bundles of the same type.

    Automatic connection between two hardware signals or two bundles of the same type.

    Direction is inferred by using signal direction (in/out). (Similar behavior to :=)

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

    Permalink

    BitVector is not equal to MaskedLiteral

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

    Permalink

    isNotEqualTo comparison between two SpinalHDL data

    isNotEqualTo comparison between two SpinalHDL data

    Definition Classes
    DataPrimitives
  11. def =::=(that: Bool): Bool

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

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

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

    Permalink

    isEqualTo comparison between two SpinalHDL data

    isEqualTo comparison between two SpinalHDL data

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

    Permalink

    Conditional operation for Enumeration value

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

    Permalink

    Conditional operation for Data value

  17. def IFparent: Data

    Permalink
    Definition Classes
    Data
  18. 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
  19. def ^(b: Bool): Bool

    Permalink

    Hardware logical XOR

    Hardware logical XOR

    returns

    a Bool assign with the XOR result

    Definition Classes
    BoolBitwiseOp
    Example:
    1. val result = myBool1 ^ myBool2
  20. var _spinalTags: LinkedHashSet[SpinalTag]

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  28. var algoIncrementale: Int

    Permalink
    Definition Classes
    BaseNode
  29. var algoInt: Int

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

    Permalink

    Allow a signal of an io Bundle to be directionless.

    Allow a signal of an io Bundle to be directionless.

    Definition Classes
    Data
    See also

    IO Bundle Error Documentation

  31. def allowOutOfRangeLiterals: Bool.this.type

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

    Permalink

    Allow a signal to be overridden.

    Allow a signal to be overridden.

    Definition Classes
    Data
    See also

    Assignment overlap Error Documentation

  33. def allowPartialyAssigned(): Bool.this.type

    Permalink

    Allow a register to be partially assigned

    Allow a register to be partially assigned

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

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

    Permalink
    Definition Classes
    BaseTypeData
  36. 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)

    Definition Classes
    Data
    See also

    "Register with only init" Error Documentation

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

    Permalink
    Definition Classes
    Data
  38. def asBits: Bits

    Permalink

    Cast signal to Bits

    Cast signal to Bits

    Definition Classes
    BoolData
  39. 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

  40. def asData: Data

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

    Permalink

    Set a signal as inout

    Set a signal as inout

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

    Permalink

    Set a data as input

    Set a data as input

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

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

    Permalink

    Set a data as output

    Set a data as output

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

    Permalink
  46. 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
  47. 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)
  48. 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
  49. def assignDontCare(): Bool.this.type

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

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

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

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

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

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

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

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

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

    Permalink

    this is assigned to False

  59. 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
  60. def clearWhen(cond: Bool)(implicit loc: Location): Bool

    Permalink

    this is assigned to False when cond is True

  61. var clockDomain: ClockDomain

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

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

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

    Permalink
    Definition Classes
    Assignable
  65. var compositeAssign: Assignable

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

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

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

    Permalink

    Set a default value to a signal.

    Set a default value to a signal.

    Definition Classes
    DataPrimitives
    See also

    example of usage for Bits

  69. def dirString(): String

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

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

    Permalink
    Definition Classes
    DoubleLinkedContainer
  72. def dlcHasOnlyOne: Boolean

    Permalink
    Definition Classes
    DoubleLinkedContainer
  73. var dlcHead: AssignmentStatement

    Permalink
    Definition Classes
    DoubleLinkedContainer
  74. def dlcIsEmpty: Boolean

    Permalink
    Definition Classes
    DoubleLinkedContainer
  75. var dlcLast: AssignmentStatement

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

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

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

    Permalink

    Edge detection

  79. 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)
  80. def edges(): BoolEdges

    Permalink

    Edge detection without intial value

  81. 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){...}
  82. final def eq(arg0: AnyRef): Boolean

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

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

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

    Permalink

    Falling edge detection

  86. 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)
  87. 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()

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

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

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

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

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

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

    Permalink

    Flip the direction of the signal.

    Flip the direction of the signal.

    in and out are swapped, inout stay the same.

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    BaseTypeData
  101. 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
  102. def getBitsWidth: Int

    Permalink

    Return the width of the data

    Return the width of the data

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

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

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

    Permalink

    Get current component with all parents

    Get current component with all parents

    Definition Classes
    InComponent
  106. def getDirection: IODirection

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

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

    Permalink
    Definition Classes
    BaseType
  109. def getInstanceCounter: Int

    Permalink
    Definition Classes
    ContextUser
  110. def getMode: Byte

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

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

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

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

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

    Permalink
    Definition Classes
    NameableByComponent
  116. def getRealSource: Any

    Permalink
    Definition Classes
    Assignable
  117. def getRealSourceNoRec: Any

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

    Permalink
    Definition Classes
    OwnableRef
  119. def getRootParent: Data

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

    Permalink
    Definition Classes
    Data
  121. def getScalaLocationLong: String

    Permalink
    Definition Classes
    ScalaLocated
  122. def getScalaLocationShort: String

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

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

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

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

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

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

    Permalink

    Create a signal set to 0

    Create a signal set to 0

    Definition Classes
    BoolData
  129. var globalData: GlobalData

    Permalink
    Definition Classes
    GlobalDataUser
  130. def hasAssignement: Boolean

    Permalink
    Definition Classes
    BaseType
  131. def hasDataAssignment: Boolean

    Permalink
    Definition Classes
    BaseType
  132. def hasInit: Boolean

    Permalink

    Does the base type have initial value

    Does the base type have initial value

    Definition Classes
    BaseType
  133. def hasOnlyOneStatement: Boolean

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

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

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

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

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

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

    Permalink

    Set initial value of the signal

    Set initial value of the signal

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

    Permalink
    Definition Classes
    Data
  141. def initNull(that: Bool): Bool

    Permalink
    Definition Classes
    DataPrimitives
  142. def initZero(): Bool

    Permalink
    Definition Classes
    DataPrimitives
  143. def initial(that: Bool): Bool

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

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

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  148. def isAnalog: Boolean

    Permalink
    Definition Classes
    BaseTypeData
  149. def isComb: Boolean

    Permalink
    Definition Classes
    BaseTypeData
  150. def isCompletelyUnnamed: Boolean

    Permalink
    Definition Classes
    Nameable
  151. def isDirectionLess: Boolean

    Permalink
    Definition Classes
    Data
  152. def isEmptyOfTag: Boolean

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

    Permalink
    Definition Classes
    BaseType
  154. def isInOut: Boolean

    Permalink
    Definition Classes
    Data
  155. def isInput: Boolean

    Permalink
    Definition Classes
    Data
  156. def isInputOrInOut: Boolean

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

    Permalink
    Definition Classes
    Any
  158. final def isNamed: Boolean

    Permalink
    Definition Classes
    Nameable
  159. def isOutput: Boolean

    Permalink
    Definition Classes
    Data
  160. def isOutputOrInOut: Boolean

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

    Permalink
    Definition Classes
    Nameable
  162. def isReg: Boolean

    Permalink
    Definition Classes
    BaseTypeData
  163. def isRegOnAssign: Boolean

    Permalink
    Definition Classes
    Data
  164. def isTypeNode: Boolean

    Permalink

    Is the baseType a node

    Is the baseType a node

    Definition Classes
    BaseType
  165. def isUnknown: Bool

    Permalink
  166. def isUnnamed: Boolean

    Permalink
    Definition Classes
    NameableByComponentNameable
  167. def isUsingResetSignal: Boolean

    Permalink

    Is the basetype using reset signal

    Is the basetype using reset signal

    Definition Classes
    BaseType
  168. def isUsingSoftResetSignal: Boolean

    Permalink

    Is the basetype using soft reset signal

    Is the basetype using soft reset signal

    Definition Classes
    BaseType
  169. def isVital: Boolean

    Permalink

    Check if the baseType is vital

    Check if the baseType is vital

    Definition Classes
    BaseType
  170. var lastScopeStatement: Statement

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

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

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

    Permalink

    Use a SpinalHDL data as a selector for a mux.

    Use a SpinalHDL data as a selector for a mux.

    Definition Classes
    BaseType
    See also

    Bitwise selection Documentation

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

    Permalink

    Version of SpinalHDL mux that allows Don't Care.

    Version of SpinalHDL mux that allows Don't Care.

    Definition Classes
    BaseType
    See also

    Bitwise selection Documentation

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

    Permalink

    Use a scala.Seq of SpinalHDL data as mux inputs.

    Use a scala.Seq of SpinalHDL data as mux inputs.

    Definition Classes
    BaseType
    See also

    Bitwise selection Documentation

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

    Permalink

    Use a scala.Seq of SpinalHDL data as mux inputs.

    Use a scala.Seq of SpinalHDL data as mux inputs.

    Definition Classes
    BaseType
    See also

    Bitwise selection Documentation

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

    Permalink

    Version of SpinalHDL muxList that allows Don't Care.

    Version of SpinalHDL muxList that allows Don't Care.

    Definition Classes
    BaseType
    See also

    Bitwise selection Documentation

  178. var name: String

    Permalink
    Definition Classes
    Nameable
  179. var nameableRef: Nameable

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

    Permalink
    Definition Classes
    AnyRef
  181. var nextScopeStatement: Statement

    Permalink
    Definition Classes
    Statement
  182. 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
  183. def noCombLoopCheck(): Bool.this.type

    Permalink

    Disable combinatorial loop checking for this Data

    Disable combinatorial loop checking for this Data

    Definition Classes
    Data
    See also

    Combinatorial loop Error Documentation

  184. def normalizeInputs: Unit

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

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  188. def opName: String

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

    Permalink
    Definition Classes
    Nameable
  190. var parent: Data

    Permalink
    Definition Classes
    Data
  191. var parentScope: ScopeStatement

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

    Permalink
    Definition Classes
    Data
  193. 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
  194. def purify(): Bool.this.type

    Permalink
    Definition Classes
    Data
  195. 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
  196. var refOwner: RefOwnerType

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

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

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

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

    Permalink
  201. 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
  202. def removeDataAssignments(): Bool.this.type

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

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

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

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

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

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

    Permalink

    Return a version of the signal which is allowed to be automatically resized where needed.

    Return a version of the signal which is allowed to be automatically resized where needed.

    The resize operation is deferred until the point of assignment later. The resize may widen or truncate, retaining the LSB.

    Definition Classes
    Data
    See also

    Width checking Documentation

  209. def rise(): Bool

    Permalink

    Rising edge detection

  210. 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)
  211. 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)
  212. def rootIF(): Interface

    Permalink

    root interface

    root interface

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

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

    Permalink
    Definition Classes
    Data
  215. def rootScopeStatement: ScopeStatement

    Permalink
    Definition Classes
    BaseTypeStatement
  216. var scalaTrace: Throwable

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

    Permalink

    this is assigned to True

  218. 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
  219. def setAsAnalog(): Bool.this.type

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

    Permalink

    Set baseType to Combinatorial

    Set baseType to Combinatorial

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

    Permalink

    Remove the direction (in, out, inout) to a signal

    Remove the direction (in, out, inout) to a signal

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

    Permalink

    Set baseType to reg

    Set baseType to reg

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

    Permalink

    Set baseType to Node

    Set baseType to Node

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

    Permalink

    Set the baseType to vital

    Set the baseType to vital

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    Nameable
  236. 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
  237. def setPartialName(name: String, namePriority: Byte, owner: Any): Bool.this.type

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    Nameable
  248. 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)
  249. def simplifyNode: Expression

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    Expression
  259. 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)
  260. def unary_!: Bool

    Permalink

    Hardware logical NOT

    Hardware logical NOT

    returns

    a Bool assign with the NOT result

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

    Permalink

    Hardware alternative to logical NOT

    Hardware alternative to logical NOT

    returns

    a Bool assign with the NOT result

    Definition Classes
    BoolBitwiseOp
    Example:
    1. val result = ~myBool1
  262. def unfreeze(): Bool.this.type

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink

    Hardware alternative to logical OR

    Hardware alternative to logical OR

    returns

    a Bool assign with the OR result

    Definition Classes
    BoolBitwiseOp
    Example:
    1. val result = myBool1 | myBool2
  277. def ||(b: Bool): Bool

    Permalink

    Hardware logical OR

    Hardware 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