spinal.core

Bool

Related Doc: package core

class Bool extends BaseType with DataPrimitives[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. DataPrimitives
  4. BaseType
  5. Expression
  6. StatementDoubleLinkedContainer
  7. DoubleLinkedContainer
  8. DeclarationStatement
  9. LeafStatement
  10. Statement
  11. BaseNode
  12. ExpressionContainer
  13. Data
  14. ScalaLocated
  15. SpinalTagReady
  16. Assignable
  17. NameableByComponent
  18. Nameable
  19. OwnableRef
  20. ContextUser
  21. GlobalDataUser
  22. AnyRef
  23. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Bool()

Type Members

  1. case class MuxBuilder[T <: Data](whenTrue: T) extends Product with Serializable

    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

    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

    Definition Classes
    OwnableRef

Value Members

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

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

    Concatenation between two data

    Concatenation between two data

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

    Definition Classes
    AnyRef → Any
  4. def &(b: Bool): Bool

    Logical AND operator

    Logical AND operator

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

    Logical AND

    Logical AND

    returns

    a Bool assign with the AND result

    Example:
    1. val result = myBool1 && myBool2
  6. def :=(that: Bool): Unit

    Assign a data to this

    Assign a data to this

    Definition Classes
    DataPrimitives
  7. def <>(that: Bool): Unit

    Auto connection between two data

    Auto connection between two data

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

    BitVector is not equal to MaskedLiteral

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

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

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

  12. def ===(that: Bool): Bool

    Comparison between two data

    Comparison between two data

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

    Conditional operation for Enumeration value

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

    Conditional operation for Data value

  15. def \(that: Bool): Bool

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

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

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

    Logical XOR operator

    Logical XOR operator

    Definition Classes
    BoolBitwiseOp
  17. var _spinalTags: Set[SpinalTag]

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

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

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

    Definition Classes
    SpinalTagReady
  21. def addTag(spinalTag: SpinalTag): Bool.this.type

    Definition Classes
    SpinalTagReady
  22. def addTags(tags: Iterable[SpinalTag]): Bool.this.type

    Definition Classes
    SpinalTagReady
  23. var algoIncrementale: Int

    Definition Classes
    BaseNode
  24. var algoInt: Int

    Definition Classes
    BaseNode
  25. def allowDirectionLessIo: Bool.this.type

    Definition Classes
    Data
  26. def allowOverride: Bool.this.type

    Allow a data to be overrided

    Allow a data to be overrided

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

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

    Definition Classes
    BaseTypeData
  29. def allowUnsetRegToAvoidLatch: Bool.this.type

    Definition Classes
    Data
  30. def asBits: Bits

    Cast data to Bits

    Cast data to Bits

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

    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

  32. def asData: Data

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

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

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

    Definition Classes
    BaseTypeData
  34. def asInOut(): Bool.this.type

    set a data as inout

    set a data as inout

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

    Set a data as input

    Set a data as input

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

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

    Set a data as output

    Set a data as output

    Definition Classes
    BaseTypeData
  38. def asSInt: SInt

    Cast a Bool to an SInt

    Cast a Bool to an SInt

    returns

    a SInt data

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

    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)
  40. def asUInt: UInt

    Cast a Bool to an UInt

    Cast a Bool to an UInt

    returns

    an UInt data

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

    Definition Classes
    BoolData
  42. final def assignFrom(that: AnyRef, target: AnyRef = this): Unit

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

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

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

    Definition Classes
    Data
  46. def clear(): Unit

    this is assigned to False

  47. def clearWhen(cond: Bool): Bool

    this is assigned to False when cond is True

  48. var clockDomain: ClockDomain

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

    Definition Classes
    BaseTypeData → AnyRef
  50. def component: Component

    Definition Classes
    ContextUser
  51. final def compositAssignFrom(that: AnyRef, target: AnyRef, kind: AnyRef): Unit

    Definition Classes
    Assignable
  52. var compositeAssign: Assignable

    Definition Classes
    Assignable
  53. def default(that: ⇒ Bool): Bool

    Set a default value to a data

    Set a default value to a data

    Definition Classes
    DataPrimitives
  54. def dirString(): String

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

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

    Definition Classes
    DoubleLinkedContainer
  57. def dlcHasOnlyOne: Boolean

    Definition Classes
    DoubleLinkedContainer
  58. var dlcHead: AssignmentStatement

    Definition Classes
    DoubleLinkedContainer
  59. def dlcIsEmpty: Boolean

    Definition Classes
    DoubleLinkedContainer
  60. var dlcLast: AssignmentStatement

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

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

    Definition Classes
    BaseTypeData
  63. def edge(): Bool

    Edge detection

  64. def edge(initAt: Bool): Bool

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

    Edge detection without intial value

  66. def edges(initAt: Bool): BoolEdges

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

    Definition Classes
    AnyRef
  68. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  69. def existsTag(cond: (SpinalTag) ⇒ Boolean): Boolean

    Definition Classes
    SpinalTagReady
  70. def fall(): Bool

    Falling edge detection

  71. def fall(initAt: Bool): Bool

    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)
  72. def filterTag(cond: (SpinalTag) ⇒ Boolean): Iterable[SpinalTag]

    Definition Classes
    SpinalTagReady
  73. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  74. def findTag(cond: (SpinalTag) ⇒ Boolean): Option[SpinalTag]

    Definition Classes
    SpinalTagReady
  75. def flatten: Seq[BaseType]

    Definition Classes
    BaseTypeData
  76. def flattenLocalName: Seq[String]

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

    flip the direction of the data

    flip the direction of the data

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

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

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

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

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

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

    Generate this if condition is true

    Generate this if condition is true

    Definition Classes
    Data
  84. def getBitsWidth: Int

    Return the width of the data

    Return the width of the data

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

    Definition Classes
    AnyRef → Any
  86. def getComponent(): Component

    Definition Classes
    DataNameableByComponent
  87. def getComponents(): Seq[Component]

    Get current component with all parents

    Get current component with all parents

    Definition Classes
    Data
  88. def getDisplayName(): String

    Definition Classes
    Nameable
  89. def getDrivingReg: Bool.this.type

    Definition Classes
    BaseType
  90. def getInstanceCounter: Int

    Definition Classes
    ContextUser
  91. def getName(): String

    Definition Classes
    NameableByComponentNameable
  92. def getName(default: String): String

    Definition Classes
    Nameable
  93. def getRealSource: Any

    Definition Classes
    Assignable
  94. def getRealSourceNoRec: Any

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

    Definition Classes
    OwnableRef
  96. def getRootParent: Data

    Definition Classes
    Data
  97. def getScalaLocationLong: String

    Definition Classes
    ScalaLocated
  98. def getScalaLocationShort: String

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

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

    Definition Classes
    SpinalTagReady
  101. def getTypeObject: TypeBool.type

    Definition Classes
    BoolExpression
  102. def getZero: Bool.this.type

    Create a data set to 0

    Create a data set to 0

    Definition Classes
    BoolData
  103. val globalData: GlobalData

    Definition Classes
    GlobalDataUser
  104. def hasInit: Boolean

    Does the base type have initial value

    Does the base type have initial value

    Definition Classes
    BaseType
  105. def hasOnlyOneStatement: Boolean

  106. def hasTag(spinalTag: SpinalTag): Boolean

    Definition Classes
    SpinalTagReady
  107. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  108. def head: AssignmentStatement

  109. def init(that: Bool): Bool

    Set inital value to a data

    Set inital value to a data

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

    Definition Classes
    Data
  111. def insertNext(s: Statement): Unit

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

    Definition Classes
    SpinalTagReady
  113. def instanceAttributes: Iterable[Attribute]

    Definition Classes
    SpinalTagReady
  114. def isAnalog: Boolean

    Definition Classes
    BaseTypeData
  115. def isComb: Boolean

    Definition Classes
    BaseTypeData
  116. def isDirectionLess: Boolean

    Definition Classes
    Data
  117. def isEmptyOfTag: Boolean

    Definition Classes
    SpinalTagReady
  118. def isInOut: Boolean

    Definition Classes
    Data
  119. def isInput: Boolean

    Definition Classes
    Data
  120. def isInputOrInOut: Boolean

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

    Definition Classes
    Any
  122. def isNamed: Boolean

    Definition Classes
    Nameable
  123. def isOutput: Boolean

    Definition Classes
    Data
  124. def isOutputOrInOut: Boolean

    Definition Classes
    Data
  125. def isReg: Boolean

    Definition Classes
    BaseTypeData
  126. def isTypeNode: Boolean

    Is the baseType a node

    Is the baseType a node

    Definition Classes
    BaseType
  127. def isUnnamed: Boolean

    Definition Classes
    Nameable
  128. def isUsingResetSignal: Boolean

    Is the basetype using reset signal

    Is the basetype using reset signal

    Definition Classes
    BaseType
  129. def isUsingSoftResetSignal: Boolean

    Is the basetype using soft reset signal

    Is the basetype using soft reset signal

    Definition Classes
    BaseType
  130. def isVital: Boolean

    Check if the baseType is vital

    Check if the baseType is vital

    Definition Classes
    BaseType
  131. def keep(): Bool.this.type

    Definition Classes
    Data
  132. var lastScopeStatement: Statement

    Definition Classes
    Statement
  133. def mux[T2 <: Data](mappings: (Any, T2)*): T2

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

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

    Definition Classes
    BaseType
  136. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  137. var nextScopeStatement: Statement

    Definition Classes
    Statement
  138. def noBackendCombMerge: Bool.this.type

    Definition Classes
    Data
  139. def noCombLoopCheck: Bool.this.type

    Definition Classes
    Data
  140. def normalizeInputs: Unit

    Definition Classes
    BaseTypeExpressionContainer
  141. final def notify(): Unit

    Definition Classes
    AnyRef
  142. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  143. def onEachAttributes(doIt: (Attribute) ⇒ Unit): Unit

    Definition Classes
    SpinalTagReady
  144. def opName: String

    Definition Classes
    BoolExpression
  145. var parent: Data

    Definition Classes
    Data
  146. var parentScope: ScopeStatement

    Definition Classes
    ContextUser
  147. def pull(): Bool.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
  148. def randBoot(): Bool.this.type

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

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

    Definition Classes
    Data
  149. var refOwner: RefOwnerType

    Definition Classes
    OwnableRef
  150. def remapDrivingExpressions(func: (Expression) ⇒ Expression): Unit

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

  152. def removeAssignments(): Bool.this.type

    Remove all assignements of the base type

    Remove all assignements of the base type

    Definition Classes
    BaseTypeData
  153. def removeStatement(): Unit

    Definition Classes
    BaseTypeStatement
  154. def removeStatementFromScope(): Unit

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

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

    Definition Classes
    SpinalTagReady
  157. def resized: Bool.this.type

    Resized data regarding target

    Resized data regarding target

    Definition Classes
    Data
  158. def rise(): Bool

    Rising edge detection

  159. def rise(initAt: Bool): Bool

    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)
  160. def rootScopeStatement: ScopeStatement

    Definition Classes
    BaseTypeStatement
  161. def set(): Unit

    this is assigned to True

  162. def setAsAnalog(): Bool.this.type

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

    Set baseType to Combinatorial

    Set baseType to Combinatorial

    Definition Classes
    BaseType
  164. def setAsReg(): Bool.this.type

    Set baseType to reg

    Set baseType to reg

    Definition Classes
    BaseType
  165. def setAsTypeNode(): Bool.this.type

    Set baseType to Node

    Set baseType to Node

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

    Set the baseType to vital

    Set the baseType to vital

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

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

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

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

    Definition Classes
    Nameable
  171. def setName(name: String, weak: Boolean = false): Bool.this.type

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

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

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

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

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

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

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

    Definition Classes
    Nameable
  179. def setWhen(cond: Bool): Bool

    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)
  180. def simplifyNode: Expression

    Definition Classes
    Expression
  181. def spinalTags: Set[SpinalTag]

    Definition Classes
    SpinalTagReady
  182. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  183. def toString(): String

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

    Definition Classes
    BaseNode
  185. def unary_!(): Bool

    Logical NOT

    Logical NOT

    returns

    a Bool assign with the NOT result

    Example:
    1. val result = !myBool1
  186. def unary_~(): Bool

    Inverse bitwise operator

    Inverse bitwise operator

    Definition Classes
    BoolBitwiseOp
  187. def unsetName(): Bool.this.type

    Definition Classes
    Nameable
  188. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  189. final def wait(arg0: Long, arg1: Int): Unit

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

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

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

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

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

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

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

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

    Definition Classes
    BaseType
  198. def |(b: Bool): Bool

    Logical OR operator

    Logical OR operator

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

    Logical OR

    Logical OR

    returns

    a Bool assign with the OR result

    Example:
    1. val result = myBool1 || myBool2

Inherited from BitwiseOp[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 ScalaLocated

Inherited from SpinalTagReady

Inherited from Assignable

Inherited from NameableByComponent

Inherited from Nameable

Inherited from OwnableRef

Inherited from ContextUser

Inherited from GlobalDataUser

Inherited from AnyRef

Inherited from Any

Ungrouped