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

c

chisel3.util

# Counter

###
Companion object Counter

#### class Counter extends AffectsChiselPrefix

Used to generate an inline (logic directly in the containing Module, no internal Module is created) hardware counter.

Typically instantiated with apply methods in object Counter

Does not create a new Chisel Module

Source
  Counter.scala
Examples:

1.     val countOn = true.B // increment counter every clock cycle
       val (counterValue, counterWrap) = Counter(countOn, 4)
       when (counterValue === 3.U) {
         ...
       }

,

2.     // Using Scala Range API
       val (counterValue, counterWrap) = Counter(0 until 10 by 2)
       when (counterValue === 4.U) {
         ...
       }

Linear Supertypes
AffectsChiselPrefix, AnyRef, Any
Type Hierarchy

Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. Counter
2. AffectsChiselPrefix
3. AnyRef
4. Any

Implicitly

1. by any2stringadd
2. by StringFormat
3. by Ensuring
4. by ArrowAssoc

1. Hide All
2. Show All

Visibility

1. Public
2. Protected

### Instance Constructors

1.  new Counter(n: Int)

   Creates a counter with the specified number of steps.

   Creates a counter with the specified number of steps.

   n

     number of steps before the counter resets

### Value Members

1.  final def !=(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
2.  final def ##: Int
   Definition Classes
     AnyRef → Any
3.  def +(other: String): String
   Implicit
     This member is added by an implicit conversion from Counter toany2stringadd[Counter] performed by method any2stringadd in scala.Predef.
   Definition Classes
     any2stringadd
4.  def ->[B](y: B): (Counter, B)
   Implicit
     This member is added by an implicit conversion from Counter toArrowAssoc[Counter] performed by method ArrowAssoc in scala.Predef.
   Definition Classes
     ArrowAssoc
   Annotations
     @inline()
5.  final def ==(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
6.  final def asInstanceOf[T0]: T0
   Definition Classes
     Any
7.  def clone(): AnyRef
   Attributes
     protected[lang]
   Definition Classes
     AnyRef
   Annotations
     @throws(classOf[java.lang.CloneNotSupportedException]) @native()
8.  def ensuring(cond: (Counter) => Boolean, msg: => Any): Counter
   Implicit
     This member is added by an implicit conversion from Counter toEnsuring[Counter] performed by method Ensuring in scala.Predef.
   Definition Classes
     Ensuring
9.  def ensuring(cond: (Counter) => Boolean): Counter
   Implicit
     This member is added by an implicit conversion from Counter toEnsuring[Counter] performed by method Ensuring in scala.Predef.
   Definition Classes
     Ensuring
10.  def ensuring(cond: Boolean, msg: => Any): Counter
    Implicit
      This member is added by an implicit conversion from Counter toEnsuring[Counter] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
11.  def ensuring(cond: Boolean): Counter
    Implicit
      This member is added by an implicit conversion from Counter toEnsuring[Counter] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
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.  def inc(): Bool

    Increments the counter by a step.

    Increments the counter by a step.

    returns

      whether the counter will wrap on the next clock cycle

    Note

      The incremented value is registered and will be visible on the next clock cycle

18.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
19.  def n: Int

    Number of counts before the counter resets

    Number of counts before the counter resets

    Note

      Only defined for ranges starting at zero with steps of size 1. Use range for other use cases.

20.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
21.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
22.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
23.  def range: Range

    The range of the counter values.

24.  def reset(): Unit

    Resets the counter to its initial value

25.  final def synchronized[T0](arg0: => T0): T0
    Definition Classes
      AnyRef
26.  def toString(): String
    Definition Classes
      AnyRef → Any
27.  val value: UInt

    The current value of the counter.

28.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
29.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
30.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException]) @native()

### Deprecated Value Members

1.  def formatted(fmtstr: String): String
   Implicit
     This member is added by an implicit conversion from Counter toStringFormat[Counter] performed by method StringFormat in scala.Predef.
   Definition Classes
     StringFormat
   Annotations
     @deprecated @inline()
   Deprecated

     (Since version 2.12.16) Use `formatString.format(value)` instead of `value.formatted(formatString)`, or use the `f""` string interpolator. In Java 15 and later, `formatted` resolves to the new method in String which has reversed parameters.

2.  def →[B](y: B): (Counter, B)
   Implicit
     This member is added by an implicit conversion from Counter toArrowAssoc[Counter] performed by method ArrowAssoc in scala.Predef.
   Definition Classes
     ArrowAssoc
   Annotations
     @deprecated
   Deprecated

     (Since version 2.13.0) Use `->` instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

### Inherited from AffectsChiselPrefix

### Inherited from AnyRef

### Inherited from Any

### Inherited by implicit conversion any2stringadd fromCounter to any2stringadd[Counter]

### Inherited by implicit conversion StringFormat fromCounter to StringFormat[Counter]

### Inherited by implicit conversion Ensuring fromCounter to Ensuring[Counter]

### Inherited by implicit conversion ArrowAssoc fromCounter to ArrowAssoc[Counter]

### Ungrouped