xref: /XiangShan/src/main/scala/utils/PipeWithFlush.scala (revision c5b130866fe98e1a2bcd0621ccc898bd736481e5)

package utils

import chisel3._
import chisel3.util._
import xiangshan._

/** Pipeline module generator parameterized by data type and latency.
  *
  * @param gen a Chisel type, used as data in pipe
  * @param flushGen a Chisel type, used as flush signal
  * @param latency the number of pipeline stages
  * @param flushFunc used to generate flush signal
  * @tparam T Type of [[io.enq.bits]] and [[io.deq.bits]]
  * @tparam TFlush Type of [[io.flush]]
  */
class PipeWithFlush[T <: Data, TFlush <: Data] (
  gen: T,
  flushGen: TFlush,
  latency: Int,
  flushFunc: (T, TFlush, Int) => Bool,
  modificationFunc: T => T = { x: T => x }
) extends Module {
  require(latency >= 0, "Pipe latency must be greater than or equal to zero!")

  class PipeIO extends Bundle {
    val flush = Input(flushGen)
    val enq = Input(Valid(gen))
    val deq = Output(Valid(gen))
  }

  val io = IO(new PipeIO)

  val valids: Seq[Bool] = io.enq.valid +: Seq.fill(latency)(RegInit(false.B))
  val bits: Seq[T] = io.enq.bits +: Seq.fill(latency)(Reg(gen))
  val modifiedBits: Seq[T] = bits.map(modificationFunc)

  for (i <- 0 until latency) {
    valids(i + 1) := valids(i) && !flushFunc(bits(i), io.flush, i)
    when (valids(i)) {
      bits(i + 1) := modifiedBits(i)
    }
  }
  io.deq.valid := valids.last
  io.deq.bits := bits.last
}