xref: /XiangShan/src/main/scala/xiangshan/backend/fu/NewCSR/CSREvents/CSREvent.scala (revision 8882eb685de93177da606ee717b5ec8e459a768a)

package xiangshan.backend.fu.NewCSR.CSREvents

import chisel3._
import chisel3.util._
import org.chipsalliance.cde.config.Parameters
import utility.{SignExt, ZeroExt}
import xiangshan.HasXSParameter
import xiangshan.backend.fu.NewCSR.CSRBundles.{CauseBundle, PrivState}
import xiangshan.backend.fu.NewCSR.CSRConfig._
import xiangshan.backend.fu.NewCSR.CSRDefines.{HgatpMode, SatpMode}
import xiangshan.backend.fu.NewCSR._

trait CSREvents { self: NewCSR =>
  val trapEntryDEvent = Module(new TrapEntryDEventModule)

  val trapEntryMEvent = Module(new TrapEntryMEventModule)

  val trapEntryMNEvent = Module(new TrapEntryMNEventModule())

  val trapEntryHSEvent = Module(new TrapEntryHSEventModule)

  val trapEntryVSEvent = Module(new TrapEntryVSEventModule)

  val mretEvent  = Module(new MretEventModule)

  val mnretEvent = Module(new MNretEventModule)

  val sretEvent  = Module(new SretEventModule)

  val dretEvent  = Module(new DretEventModule)

  val events: Seq[Module with CSREventBase] = Seq(
    trapEntryDEvent,
    trapEntryMEvent,
    trapEntryHSEvent,
    trapEntryVSEvent,
    trapEntryMNEvent,
    mretEvent,
    sretEvent,
    dretEvent,
    mnretEvent,
  )

  events.foreach(x => dontTouch(x.out))

  val trapEntryEvents: Seq[Module with CSREventBase] = Seq(
    trapEntryDEvent,
    trapEntryMEvent,
    trapEntryHSEvent,
    trapEntryVSEvent,
  )
}

trait EventUpdatePrivStateOutput {
  val privState = ValidIO(new PrivState)
}

trait EventOutputBase {
  import scala.reflect.runtime.{universe => ru}

  def getBundleByName(name: String): Valid[CSRBundle] = {
    val mirror: ru.Mirror = ru.runtimeMirror(getClass.getClassLoader)
    val im = mirror.reflect(this)
    val classSymbol: ru.ClassSymbol = im.symbol.asClass
    val fieldSymbol = classSymbol.info.decl(ru.TermName(name)).asTerm
    val fieldMirror: ru.FieldMirror = mirror.reflect(this).reflectField(fieldSymbol)
    fieldMirror.get.asInstanceOf[Valid[CSRBundle]]
  }
}

trait CSREventBase {
  val valid = IO(Input(Bool()))
  val in: Bundle
  val out: Bundle

  def genTrapVA(
    transMode: PrivState,
    satp: SatpBundle,
    vsatp: SatpBundle,
    hgatp: HgatpBundle,
    addr: UInt,
  ) = {
    require(addr.getWidth >= 50)

    val isBare =
      transMode.isModeM ||
      transMode.isModeHSorHU &&  satp.MODE === SatpMode.Bare ||
      transMode.isVirtual    && vsatp.MODE === SatpMode.Bare && hgatp.MODE === HgatpMode.Bare
    val isSv39 =
      transMode.isModeHSorHU &&  satp.MODE === SatpMode.Sv39 ||
      transMode.isVirtual    && vsatp.MODE === SatpMode.Sv39
    val isSv48 =
      transMode.isModeHSorHU &&  satp.MODE === SatpMode.Sv48 ||
      transMode.isVirtual    && vsatp.MODE === SatpMode.Sv48
    val isSv39x4 =
      transMode.isVirtual && vsatp.MODE === SatpMode.Bare && hgatp.MODE === HgatpMode.Sv39x4
    val isSv48x4 =
      transMode.isVirtual && vsatp.MODE === SatpMode.Bare && hgatp.MODE === HgatpMode.Sv48x4

    val bareAddr   = ZeroExt(addr(PAddrWidth - 1, 0), XLEN)
    // When enable virtual memory, the higher bit should fill with the msb of address of Sv39/Sv48/Sv57
    val sv39Addr   = SignExt(addr.take(39), XLEN)
    val sv39x4Addr = ZeroExt(addr.take(39 + 2), XLEN)
    val sv48Addr   = SignExt(addr.take(48), XLEN)
    val sv48x4Addr = ZeroExt(addr.take(48 + 2), XLEN)

    val trapAddr = Mux1H(Seq(
      isBare   -> bareAddr,
      isSv39   -> sv39Addr,
      isSv39x4 -> sv39x4Addr,
      isSv48   -> sv48Addr,
      isSv48x4 -> sv48x4Addr,
    ))

    trapAddr
  }
}

class TrapEntryEventInput(implicit val p: Parameters) extends Bundle with HasXSParameter {
  val causeNO = Input(new CauseBundle)
  val trapPc = Input(UInt(VaddrMaxWidth.W))
  val trapPcGPA = Input(UInt(PAddrBitsMax.W))
  val trapInst = Input(ValidIO(UInt(InstWidth.W)))
  val fetchMalTval = Input(UInt(XLEN.W))
  val isCrossPageIPF = Input(Bool())
  val isHls = Input(Bool())
  val isFetchMalAddr = Input(Bool())
  val isFetchBkpt = Input(Bool())
  val trapIsForVSnonLeafPTE = Input(Bool())
  val hasDTExcp = Input(Bool())

  // always current privilege
  val iMode = Input(new PrivState())
  // take MRPV into consideration
  val dMode = Input(new PrivState())
  // status
  val privState = Input(new PrivState)
  val mstatus = Input(new MstatusBundle)
  val hstatus = Input(new HstatusBundle)
  val sstatus = Input(new SstatusBundle)
  val vsstatus = Input(new SstatusBundle)
  // envcfg
  val menvcfg = Input(new MEnvCfg)
  val henvcfg = Input(new HEnvCfg)

  val pcFromXtvec = Input(UInt(XLEN.W))

  val satp = Input(new SatpBundle)
  val vsatp = Input(new SatpBundle)
  val hgatp = Input(new HgatpBundle)
  val mbmc = Input(new MbmcBundle)
  // from mem
  val memExceptionVAddr = Input(UInt(XLEN.W))
  val memExceptionGPAddr = Input(UInt(XLEN.W))
  val memExceptionIsForVSnonLeafPTE = Input(Bool())
  val virtualInterruptIsHvictlInject = Input(Bool())
  val hvictlIID = Input(UInt(HIIDWidth.W))
}

trait EventSinkBundle { self: CSRModule[_ <: CSRBundle] =>
  protected def addUpdateBundleInCSREnumType(updateBundle: ValidIO[CSRBundle]): Unit = {
    (reg.asInstanceOf[CSRBundle].getFields zip updateBundle.bits.getFields).foreach { case (sink, source) =>
      if (updateBundle.bits.eventFields.contains(source)) {
        sink.addOtherUpdate(updateBundle.valid, source)
      }
    }
  }
}

class TargetPCBundle extends Bundle {
  val pc = UInt(XLEN.W)
  val raiseIPF = Bool()
  val raiseIAF = Bool()
  val raiseIGPF = Bool()

  def raiseFault = raiseIPF || raiseIAF || raiseIGPF
}