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
    Data
  5. def &(b: Bool): Bool

    Permalink

    Logical AND operator

    Logical 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 \(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
  17. def ^(b: Bool): Bool

    Permalink

    Logical XOR operator

    Logical XOR operator

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  25. var algoIncrementale: Int

    Permalink
    Definition Classes
    BaseNode
  26. var algoInt: Int

    Permalink
    Definition Classes
    BaseNode
  27. 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
  28. def allowOutOfRangeLiterals: Bool.this.type

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

    Permalink

    Allow a register to be partially assigned

    Allow a register to be partially assigned

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

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

    Permalink
    Definition Classes
    BaseTypeData
  33. 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
  34. def as[T <: Data](dataType: HardType[T]): T

    Permalink
    Definition Classes
    Data
  35. def asBits: Bits

    Permalink

    Cast data to Bits

    Cast data to Bits

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

  37. def asData: Data

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

    Permalink

    set a data as inout

    set a data as inout

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

    Permalink

    Set a data as input

    Set a data as input

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

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

    Permalink

    Set a data as output

    Set a data as output

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

    Permalink
  43. 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
  44. 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)
  45. 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
  46. def assignDontCare(): Bool.this.type

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

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

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

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

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

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

    Permalink
    Definition Classes
    Data
  53. def cldCount: Int

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

    Permalink

    this is assigned to False

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

    Permalink

    this is assigned to False when cond is True

  57. var clockDomain: ClockDomain

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

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

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

    Permalink
    Definition Classes
    Assignable
  61. var compositeAssign: Assignable

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

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

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

    Permalink

    Set a default value to a data

    Set a default value to a data

    Definition Classes
    DataPrimitives
  65. def dirString(): String

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

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

    Permalink
    Definition Classes
    DoubleLinkedContainer
  68. def dlcHasOnlyOne: Boolean

    Permalink
    Definition Classes
    DoubleLinkedContainer
  69. var dlcHead: AssignmentStatement

    Permalink
    Definition Classes
    DoubleLinkedContainer
  70. def dlcIsEmpty: Boolean

    Permalink
    Definition Classes
    DoubleLinkedContainer
  71. var dlcLast: AssignmentStatement

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

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

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

    Permalink

    Edge detection

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

    Permalink

    Edge detection without intial value

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

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

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

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

    Permalink

    Falling edge detection

  82. 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)
  83. 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()

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

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

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

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

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

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

    Permalink

    flip the direction of the data

    flip the direction of the data

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    BaseTypeData
  98. def getBitsWidth: Int

    Permalink

    Return the width of the data

    Return the width of the data

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

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

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

    Permalink

    Get current component with all parents

    Get current component with all parents

    Definition Classes
    InComponent
  102. def getDirection: IODirection

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

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

    Permalink
    Definition Classes
    BaseType
  105. def getInstanceCounter: Int

    Permalink
    Definition Classes
    ContextUser
  106. def getMode: Byte

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

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

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

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

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

    Permalink
    Definition Classes
    NameableByComponent
  112. def getRealSource: Any

    Permalink
    Definition Classes
    Assignable
  113. def getRealSourceNoRec: Any

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

    Permalink
    Definition Classes
    OwnableRef
  115. def getRootParent: Data

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

    Permalink
    Definition Classes
    Data
  117. def getScalaLocationLong: String

    Permalink
    Definition Classes
    ScalaLocated
  118. def getScalaLocationShort: String

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

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

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

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

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

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

    Permalink

    Create a data set to 0

    Create a data set to 0

    Definition Classes
    BoolData
  125. val globalData: GlobalData

    Permalink
    Definition Classes
    GlobalDataUser
  126. def hasAssignement: Boolean

    Permalink
    Definition Classes
    BaseType
  127. def hasDataAssignment: Boolean

    Permalink
    Definition Classes
    BaseType
  128. def hasInit: Boolean

    Permalink

    Does the base type have initial value

    Does the base type have initial value

    Definition Classes
    BaseType
  129. def hasOnlyOneStatement: Boolean

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

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

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

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

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

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

    Permalink

    Set initial value to a data

    Set initial value to a data

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

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

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

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

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  142. def isAnalog: Boolean

    Permalink
    Definition Classes
    BaseTypeData
  143. def isComb: Boolean

    Permalink
    Definition Classes
    BaseTypeData
  144. def isCompletelyUnnamed: Boolean

    Permalink
    Definition Classes
    Nameable
  145. def isDirectionLess: Boolean

    Permalink
    Definition Classes
    Data
  146. def isEmptyOfTag: Boolean

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

    Permalink
    Definition Classes
    BaseType
  148. def isInOut: Boolean

    Permalink
    Definition Classes
    Data
  149. def isInput: Boolean

    Permalink
    Definition Classes
    Data
  150. def isInputOrInOut: Boolean

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

    Permalink
    Definition Classes
    Any
  152. def isNamed: Boolean

    Permalink
    Definition Classes
    NameableByComponentNameable
  153. def isOutput: Boolean

    Permalink
    Definition Classes
    Data
  154. def isOutputOrInOut: Boolean

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

    Permalink
    Definition Classes
    Nameable
  156. def isReg: Boolean

    Permalink
    Definition Classes
    BaseTypeData
  157. def isRegOnAssign: Boolean

    Permalink
    Definition Classes
    Data
  158. def isTypeNode: Boolean

    Permalink

    Is the baseType a node

    Is the baseType a node

    Definition Classes
    BaseType
  159. def isUnnamed: Boolean

    Permalink
    Definition Classes
    Nameable
  160. def isUsingResetSignal: Boolean

    Permalink

    Is the basetype using reset signal

    Is the basetype using reset signal

    Definition Classes
    BaseType
  161. def isUsingSoftResetSignal: Boolean

    Permalink

    Is the basetype using soft reset signal

    Is the basetype using soft reset signal

    Definition Classes
    BaseType
  162. def isVital: Boolean

    Permalink

    Check if the baseType is vital

    Check if the baseType is vital

    Definition Classes
    BaseType
  163. var lastScopeStatement: Statement

    Permalink
    Definition Classes
    Statement
  164. def mux[T <: Data](t: T, f: T): T

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

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

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

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

    Permalink
    Definition Classes
    BaseType
  169. var name: String

    Permalink
    Definition Classes
    Nameable
  170. var nameableRef: Nameable

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

    Permalink
    Definition Classes
    AnyRef
  172. var nextScopeStatement: Statement

    Permalink
    Definition Classes
    Statement
  173. 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
  174. 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
  175. def normalizeInputs: Unit

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

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  179. def opName: String

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

    Permalink
    Definition Classes
    Nameable
  181. var parent: Data

    Permalink
    Definition Classes
    Data
  182. var parentScope: ScopeStatement

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

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

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

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

    Permalink
    Definition Classes
    Nameable
  189. def remapDrivingExpressions(func: (Expression) ⇒ Expression): Unit

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

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

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

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

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

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

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

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

    Permalink

    Resized data regarding target

    Resized data regarding target

    Definition Classes
    Data
  199. def rise(): Bool

    Permalink

    Rising edge detection

  200. 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)
  201. 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)
  202. def rootScopeStatement: ScopeStatement

    Permalink
    Definition Classes
    BaseTypeStatement
  203. var scalaTrace: Throwable

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

    Permalink

    this is assigned to True

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

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

    Permalink

    Set baseType to Combinatorial

    Set baseType to Combinatorial

    Definition Classes
    BaseTypeData
  208. 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
  209. def setAsReg(): Bool.this.type

    Permalink

    Set baseType to reg

    Set baseType to reg

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

    Permalink

    Set baseType to Node

    Set baseType to Node

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

    Permalink

    Set the baseType to vital

    Set the baseType to vital

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink

    Logical NOT

    Logical NOT

    returns

    a Bool assign with the NOT result

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

    Permalink

    Inverse bitwise operator

    Inverse bitwise operator

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink

    Logical OR operator

    Logical OR operator

    Definition Classes
    BoolBitwiseOp
  263. 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