summaryrefslogtreecommitdiff
path: root/src/main/scala/chisel3/util/Reg.scala
blob: 713a3b2e03d6058bc54b04d7fea20293678425ce (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
// See LICENSE for license details.

package chisel3.util

import chisel3._
// TODO: remove this once we have CompileOptions threaded through the macro system.
import chisel3.core.ExplicitCompileOptions.NotStrict

object RegNext {
  /** Returns a register with the specified next and no reset initialization.
    *
    * Essentially a 1-cycle delayed version of the input signal.
    */
  def apply[T <: Data](next: T): T = Reg[T](null.asInstanceOf[T], next, null.asInstanceOf[T])

  /** Returns a register with the specified next and reset initialization.
    *
    * Essentially a 1-cycle delayed version of the input signal.
    */
  def apply[T <: Data](next: T, init: T): T = Reg[T](null.asInstanceOf[T], next, init)
}

object RegInit {
  /** Returns a register pre-initialized (on reset) to the specified value.
    */
  def apply[T <: Data](init: T): T = Reg[T](null.asInstanceOf[T], null.asInstanceOf[T], init)
}

object RegEnable {
  /** Returns a register with the specified next, update enable gate, and no reset initialization.
    */
  def apply[T <: Data](updateData: T, enable: Bool): T = {
    val clonedUpdateData = updateData.chiselCloneType
    val r = Reg(clonedUpdateData)
    when (enable) { r := updateData }
    r
  }

  /** Returns a register with the specified next, update enable gate, and reset initialization.
    */
  def apply[T <: Data](updateData: T, resetData: T, enable: Bool): T = {
    val r = RegInit(resetData)
    when (enable) { r := updateData }
    r
  }
}

object ShiftRegister
{
  /** Returns the n-cycle delayed version of the input signal.
    *
    * @param in input to delay
    * @param n number of cycles to delay
    * @param en enable the shift
    */
  def apply[T <: Data](in: T, n: Int, en: Bool = Bool(true)): T = {
    // The order of tests reflects the expected use cases.
    if (n == 1) {
      RegEnable(in, en)
    } else if (n != 0) {
      RegNext(apply(in, n-1, en))
    } else {
      in
    }
  }
}