chisel6.4.0 < Back


# Packages

-  package root
  Definition Classes
    root
-  package chisel3

  This package contains the main chisel3 API.

  This package contains the main chisel3 API.

  Definition Classes
    root
-  package util

  The util package provides extensions to core chisel for common hardware components and utility functions

  The util package provides extensions to core chisel for common hardware components and utility functions

  Definition Classes
    chisel3
-  package circt
  Definition Classes
    util
-  package experimental
  Definition Classes
    util
-  package random
  Definition Classes
    util
- Arbiter
- ArbiterIO
- BinaryMemoryFile
- BinaryToGray
- BitPat
- Cat
- Counter
- Decoupled
- DecoupledIO
- DeqIO
- EnqIO
- Enum
- Fill
- FillInterleaved
- GrayToBinary
- HasBlackBoxInline
- HasBlackBoxPath
- HasBlackBoxResource
- HasExtModuleInline
- HasExtModulePath
- HasExtModuleResource
- HexMemoryFile
- ImplicitConversions
- Irrevocable
- IrrevocableIO
- ListLookup
- LockingArbiter
- LockingArbiterLike
- LockingRRArbiter
- Log2
- Lookup
- MemoryFile
- MemoryReadPort
- MemoryReadWritePort
- MemoryWritePort
- MixedVec
- MixedVecInit
- Mux1H
- MuxCase
- MuxLookup
- OHToUInt
- Pipe
- PopCount
- PriorityEncoder
- PriorityEncoderOH
- PriorityMux
- Queue
- QueueIO
- RRArbiter
- ReadyValidIO
- RegEnable
- Reverse
- SRAM
- SRAMInterface
- ShiftRegister
- ShiftRegisters
- SparseVec
- SwitchContext
- UIntToOH
- Valid
- is
- isPow2
- log2Ceil
- log2Down
- log2Floor
- log2Up
- pla
- scanLeftOr
- scanRightOr
- signedBitLength
- simpleClassName
- switch
- unsignedBitLength

o

chisel3.util

# BitPat

###
Companion class BitPat

#### object BitPat

Source
  BitPat.scala

Linear Supertypes
AnyRef, Any

Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. BitPat
2. AnyRef
3. Any

1. Hide All
2. Show All

Visibility

1. Public
2. Protected

### Type Members

1.  implicit class fromUIntToBitPatComparable extends SourceInfoDoc

### Value Members

1.  final def !=(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
2.  final def ##: Int
   Definition Classes
     AnyRef → Any
3.  final def ==(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
4.  def N(width: Int = 1): BitPat

   Creates a `BitPat` of all 0 of the specified bitwidth.

   Creates a `BitPat` of all 0 of the specified bitwidth.

   Example:

   1.     val myN = BitPat.N(4)  // equivalent to BitPat("b0000")

5.  def Y(width: Int = 1): BitPat

   Creates a `BitPat` of all 1 of the specified bitwidth.

   Creates a `BitPat` of all 1 of the specified bitwidth.

   Example:

   1.     val myY = BitPat.Y(4)  // equivalent to BitPat("b1111")

6.  def apply(x: UInt): BitPat

   Allows UInts to be used where a BitPat is expected, useful for when an interface is defined with BitPats but not all cases need the partial matching capability.

   Allows UInts to be used where a BitPat is expected, useful for when an interface is defined with BitPats but not all cases need the partial matching capability.

   Note

     the UInt must be a literal

7.  def apply(n: String): BitPat

   Creates a `BitPat` literal from a string.

   Creates a `BitPat` literal from a string.

   n

     the literal value as a string, in binary, prefixed with 'b'

   Note

     legal characters are '0', '1', and '?', as well as '_' and white space (which are ignored)

8.  final def asInstanceOf[T0]: T0
   Definition Classes
     Any
9.  def bitPatToUInt(x: BitPat): UInt

   Allows BitPats to be used where a UInt is expected.

   Allows BitPats to be used where a UInt is expected.

   Note

     the BitPat must not have don't care bits (will error out otherwise)

10.  def clone(): AnyRef
    Attributes
      protected[lang]
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.CloneNotSupportedException]) @native()
11.  def dontCare(width: Int): BitPat

    Creates a `BitPat` of all don't cares of the specified bitwidth.

    Creates a `BitPat` of all don't cares of the specified bitwidth.

    Example:

    1.     val myDontCare = BitPat.dontCare(4)  // equivalent to BitPat("b????")

12.  final def eq(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
13.  def equals(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef → Any
14.  def finalize(): Unit
    Attributes
      protected[lang]
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.Throwable])
15.  final def getClass(): Class[_ <: AnyRef]
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
16.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
17.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
18.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
19.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
20.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
21.  final def synchronized[T0](arg0: => T0): T0
    Definition Classes
      AnyRef
22.  def toString(): String
    Definition Classes
      AnyRef → Any
23.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
24.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
25.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException]) @native()

### Inherited from AnyRef

### Inherited from Any

### Ungrouped