xref: /XiangShan/src/main/scala/xiangshan/Bundle.scala (revision eb163ef08fc5ac1da1f32d948699bd6de053e444)
1c6d43980SLemover/***************************************************************************************
2c6d43980SLemover* Copyright (c) 2020-2021 Institute of Computing Technology, Chinese Academy of Sciences
3f320e0f0SYinan Xu* Copyright (c) 2020-2021 Peng Cheng Laboratory
4c6d43980SLemover*
5c6d43980SLemover* XiangShan is licensed under Mulan PSL v2.
6c6d43980SLemover* You can use this software according to the terms and conditions of the Mulan PSL v2.
7c6d43980SLemover* You may obtain a copy of Mulan PSL v2 at:
8c6d43980SLemover*          http://license.coscl.org.cn/MulanPSL2
9c6d43980SLemover*
10c6d43980SLemover* THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND,
11c6d43980SLemover* EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT,
12c6d43980SLemover* MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
13c6d43980SLemover*
14c6d43980SLemover* See the Mulan PSL v2 for more details.
15c6d43980SLemover***************************************************************************************/
16c6d43980SLemover
171e3fad10SLinJiaweipackage xiangshan
181e3fad10SLinJiawei
191e3fad10SLinJiaweiimport chisel3._
205844fcf0SLinJiaweiimport chisel3.util._
219aca92b9SYinan Xuimport xiangshan.backend.rob.RobPtr
22f06ca0bfSLingrui98import xiangshan.backend.CtrlToFtqIO
23de169c67SWilliam Wangimport xiangshan.backend.decode.{ImmUnion, XDecode}
245c1ae31bSYinan Xuimport xiangshan.mem.{LqPtr, SqPtr}
2566b0d0c3Szhanglinjuanimport xiangshan.frontend.PreDecodeInfo
26f00290d7SLingrui98import xiangshan.frontend.HasBPUParameter
27bcce877bSYinan Xuimport xiangshan.frontend.{AllFoldedHistories, CircularGlobalHistory, GlobalHistory, ShiftingGlobalHistory}
287447ee13SLingrui98import xiangshan.frontend.RASEntry
292b8b2e7aSWilliam Wangimport xiangshan.frontend.BPUCtrl
30e0d9a9f0SLingrui98import xiangshan.frontend.FtqPtr
31c2ad24ebSLingrui98import xiangshan.frontend.CGHPtr
32e0d9a9f0SLingrui98import xiangshan.frontend.FtqRead
33f06ca0bfSLingrui98import xiangshan.frontend.FtqToCtrlIO
34ceaf5e1fSLingrui98import utils._
35b0ae3ac4SLinJiawei
362fbdb79bSLingrui98import scala.math.max
37d471c5aeSLingrui98import Chisel.experimental.chiselName
382225d46eSJiawei Linimport chipsalliance.rocketchip.config.Parameters
3988825c5cSYinan Xuimport chisel3.util.BitPat.bitPatToUInt
40bcce877bSYinan Xuimport xiangshan.backend.exu.ExuConfig
41b6982e83SLemoverimport xiangshan.backend.fu.PMPEntry
4214a6653fSLingrui98import xiangshan.frontend.Ftq_Redirect_SRAMEntry
43dd6c0695SLingrui98import xiangshan.frontend.AllFoldedHistories
4467402d75SLingrui98import xiangshan.frontend.AllAheadFoldedHistoryOldestBits
451e3fad10SLinJiawei
46627c0a19Szhanglinjuanclass ValidUndirectioned[T <: Data](gen: T) extends Bundle {
473803411bSzhanglinjuan  val valid = Bool()
4835fe60e8SLingrui98  val bits = gen.cloneType.asInstanceOf[T]
49fe211d16SLinJiawei
503803411bSzhanglinjuan}
513803411bSzhanglinjuan
52627c0a19Szhanglinjuanobject ValidUndirectioned {
53627c0a19Szhanglinjuan  def apply[T <: Data](gen: T) = {
54627c0a19Szhanglinjuan    new ValidUndirectioned[T](gen)
553803411bSzhanglinjuan  }
563803411bSzhanglinjuan}
573803411bSzhanglinjuan
581b7adedcSWilliam Wangobject RSFeedbackType {
5967682d05SWilliam Wang  val tlbMiss = 0.U(3.W)
6067682d05SWilliam Wang  val mshrFull = 1.U(3.W)
6167682d05SWilliam Wang  val dataInvalid = 2.U(3.W)
6267682d05SWilliam Wang  val bankConflict = 3.U(3.W)
6367682d05SWilliam Wang  val ldVioCheckRedo = 4.U(3.W)
641b7adedcSWilliam Wang
65*eb163ef0SHaojin Tang  val feedbackInvalid = 7.U(3.W)
66*eb163ef0SHaojin Tang
6767682d05SWilliam Wang  def apply() = UInt(3.W)
681b7adedcSWilliam Wang}
691b7adedcSWilliam Wang
702225d46eSJiawei Linclass PredictorAnswer(implicit p: Parameters) extends XSBundle {
71097c2688SLingrui98  val hit    = if (!env.FPGAPlatform) Bool() else UInt(0.W)
72097c2688SLingrui98  val taken  = if (!env.FPGAPlatform) Bool() else UInt(0.W)
73097c2688SLingrui98  val target = if (!env.FPGAPlatform) UInt(VAddrBits.W) else UInt(0.W)
7451b2a476Szoujr}
7551b2a476Szoujr
762225d46eSJiawei Linclass CfiUpdateInfo(implicit p: Parameters) extends XSBundle with HasBPUParameter {
77f226232fSzhanglinjuan  // from backend
7869cafcc9SLingrui98  val pc = UInt(VAddrBits.W)
79f226232fSzhanglinjuan  // frontend -> backend -> frontend
80f226232fSzhanglinjuan  val pd = new PreDecodeInfo
818a5e9243SLinJiawei  val rasSp = UInt(log2Up(RasSize).W)
822e947747SLinJiawei  val rasEntry = new RASEntry
83c2ad24ebSLingrui98  // val hist = new ShiftingGlobalHistory
84dd6c0695SLingrui98  val folded_hist = new AllFoldedHistories(foldedGHistInfos)
8567402d75SLingrui98  val afhob = new AllAheadFoldedHistoryOldestBits(foldedGHistInfos)
8667402d75SLingrui98  val lastBrNumOH = UInt((numBr+1).W)
87b37e4b45SLingrui98  val ghr = UInt(UbtbGHRLength.W)
88c2ad24ebSLingrui98  val histPtr = new CGHPtr
89e7b046c5Szoujr  val specCnt = Vec(numBr, UInt(10.W))
90fe3a74fcSYinan Xu  // need pipeline update
918a597714Szoujr  val br_hit = Bool()
922e947747SLinJiawei  val predTaken = Bool()
93b2e6921eSLinJiawei  val target = UInt(VAddrBits.W)
949a2e6b8aSLinJiawei  val taken = Bool()
95b2e6921eSLinJiawei  val isMisPred = Bool()
96d0527adfSzoujr  val shift = UInt((log2Ceil(numBr)+1).W)
97d0527adfSzoujr  val addIntoHist = Bool()
9814a6653fSLingrui98
9914a6653fSLingrui98  def fromFtqRedirectSram(entry: Ftq_Redirect_SRAMEntry) = {
100c2ad24ebSLingrui98    // this.hist := entry.ghist
101dd6c0695SLingrui98    this.folded_hist := entry.folded_hist
10267402d75SLingrui98    this.lastBrNumOH := entry.lastBrNumOH
10367402d75SLingrui98    this.afhob := entry.afhob
104c2ad24ebSLingrui98    this.histPtr := entry.histPtr
10514a6653fSLingrui98    this.rasSp := entry.rasSp
106c2d1ec7dSLingrui98    this.rasEntry := entry.rasTop
10714a6653fSLingrui98    this
10814a6653fSLingrui98  }
109b2e6921eSLinJiawei}
110b2e6921eSLinJiawei
1115844fcf0SLinJiawei// Dequeue DecodeWidth insts from Ibuffer
112de169c67SWilliam Wangclass CtrlFlow(implicit p: Parameters) extends XSBundle {
1135844fcf0SLinJiawei  val instr = UInt(32.W)
1145844fcf0SLinJiawei  val pc = UInt(VAddrBits.W)
115de169c67SWilliam Wang  val foldpc = UInt(MemPredPCWidth.W)
116baf8def6SYinan Xu  val exceptionVec = ExceptionVec()
11772951335SLi Qianruo  val trigger = new TriggerCf
118faf3cfa9SLinJiawei  val pd = new PreDecodeInfo
119cde9280dSLinJiawei  val pred_taken = Bool()
120c84054caSLinJiawei  val crossPageIPFFix = Bool()
121de169c67SWilliam Wang  val storeSetHit = Bool() // inst has been allocated an store set
122980c1bc3SWilliam Wang  val waitForRobIdx = new RobPtr // store set predicted previous store robIdx
123d1fe0262SWilliam Wang  // Load wait is needed
124d1fe0262SWilliam Wang  // load inst will not be executed until former store (predicted by mdp) addr calcuated
125d1fe0262SWilliam Wang  val loadWaitBit = Bool()
126d1fe0262SWilliam Wang  // If (loadWaitBit && loadWaitStrict), strict load wait is needed
127d1fe0262SWilliam Wang  // load inst will not be executed until ALL former store addr calcuated
128d1fe0262SWilliam Wang  val loadWaitStrict = Bool()
129de169c67SWilliam Wang  val ssid = UInt(SSIDWidth.W)
130884dbb3bSLinJiawei  val ftqPtr = new FtqPtr
131884dbb3bSLinJiawei  val ftqOffset = UInt(log2Up(PredictWidth).W)
1321f0e2dc7SJiawei Lin  // This inst will flush all the pipe when it is the oldest inst in ROB,
1331f0e2dc7SJiawei Lin  // then replay from this inst itself
1341f0e2dc7SJiawei Lin  val replayInst = Bool()
1355844fcf0SLinJiawei}
1365844fcf0SLinJiawei
13772951335SLi Qianruo
1382225d46eSJiawei Linclass FPUCtrlSignals(implicit p: Parameters) extends XSBundle {
1392ce29ed6SLinJiawei  val isAddSub = Bool() // swap23
140dc597826SJiawei Lin  val typeTagIn = UInt(1.W)
141dc597826SJiawei Lin  val typeTagOut = UInt(1.W)
1422ce29ed6SLinJiawei  val fromInt = Bool()
1432ce29ed6SLinJiawei  val wflags = Bool()
1442ce29ed6SLinJiawei  val fpWen = Bool()
1452ce29ed6SLinJiawei  val fmaCmd = UInt(2.W)
1462ce29ed6SLinJiawei  val div = Bool()
1472ce29ed6SLinJiawei  val sqrt = Bool()
1482ce29ed6SLinJiawei  val fcvt = Bool()
1492ce29ed6SLinJiawei  val typ = UInt(2.W)
1502ce29ed6SLinJiawei  val fmt = UInt(2.W)
1512ce29ed6SLinJiawei  val ren3 = Bool() //TODO: remove SrcType.fp
152e6c6b64fSLinJiawei  val rm = UInt(3.W)
153579b9f28SLinJiawei}
154579b9f28SLinJiawei
1555844fcf0SLinJiawei// Decode DecodeWidth insts at Decode Stage
1562225d46eSJiawei Linclass CtrlSignals(implicit p: Parameters) extends XSBundle {
15720e31bd1SYinan Xu  val srcType = Vec(3, SrcType())
15820e31bd1SYinan Xu  val lsrc = Vec(3, UInt(5.W))
1599a2e6b8aSLinJiawei  val ldest = UInt(5.W)
1609a2e6b8aSLinJiawei  val fuType = FuType()
1619a2e6b8aSLinJiawei  val fuOpType = FuOpType()
1629a2e6b8aSLinJiawei  val rfWen = Bool()
1639a2e6b8aSLinJiawei  val fpWen = Bool()
1649a2e6b8aSLinJiawei  val isXSTrap = Bool()
1652d366136SLinJiawei  val noSpecExec = Bool() // wait forward
1662d366136SLinJiawei  val blockBackward = Bool() // block backward
16745a56a29SZhangZifei  val flushPipe = Bool() // This inst will flush all the pipe when commit, like exception but can commit
168c2a8ae00SYikeZhou  val selImm = SelImm()
169b0ae3ac4SLinJiawei  val imm = UInt(ImmUnion.maxLen.W)
170a3edac52SYinan Xu  val commitType = CommitType()
171579b9f28SLinJiawei  val fpu = new FPUCtrlSignals
172aac4464eSYinan Xu  val isMove = Bool()
173d4aca96cSlqre  val singleStep = Bool()
174c88c3a2aSYinan Xu  // This inst will flush all the pipe when it is the oldest inst in ROB,
175c88c3a2aSYinan Xu  // then replay from this inst itself
176c88c3a2aSYinan Xu  val replayInst = Bool()
177be25371aSYikeZhou
17888825c5cSYinan Xu  private def allSignals = srcType ++ Seq(fuType, fuOpType, rfWen, fpWen,
1796e7c9679Shuxuan0307    isXSTrap, noSpecExec, blockBackward, flushPipe, selImm)
18088825c5cSYinan Xu
18188825c5cSYinan Xu  def decode(inst: UInt, table: Iterable[(BitPat, List[BitPat])]): CtrlSignals = {
18288825c5cSYinan Xu    val decoder = freechips.rocketchip.rocket.DecodeLogic(inst, XDecode.decodeDefault, table)
18388825c5cSYinan Xu    allSignals zip decoder foreach { case (s, d) => s := d }
1844d24c305SYikeZhou    commitType := DontCare
185be25371aSYikeZhou    this
186be25371aSYikeZhou  }
18788825c5cSYinan Xu
18888825c5cSYinan Xu  def decode(bit: List[BitPat]): CtrlSignals = {
18988825c5cSYinan Xu    allSignals.zip(bit.map(bitPatToUInt(_))).foreach{ case (s, d) => s := d }
19088825c5cSYinan Xu    this
19188825c5cSYinan Xu  }
192b6900d94SYinan Xu
193b6900d94SYinan Xu  def isWFI: Bool = fuType === FuType.csr && fuOpType === CSROpType.wfi
194f025d715SYinan Xu  def isSoftPrefetch: Bool = {
195f025d715SYinan Xu    fuType === FuType.alu && fuOpType === ALUOpType.or && selImm === SelImm.IMM_I && ldest === 0.U
196f025d715SYinan Xu  }
1975844fcf0SLinJiawei}
1985844fcf0SLinJiawei
1992225d46eSJiawei Linclass CfCtrl(implicit p: Parameters) extends XSBundle {
2005844fcf0SLinJiawei  val cf = new CtrlFlow
2015844fcf0SLinJiawei  val ctrl = new CtrlSignals
2025844fcf0SLinJiawei}
2035844fcf0SLinJiawei
2042225d46eSJiawei Linclass PerfDebugInfo(implicit p: Parameters) extends XSBundle {
2058b8e745dSYikeZhou  val eliminatedMove = Bool()
206ba4100caSYinan Xu  // val fetchTime = UInt(64.W)
207ebb8ebf8SYinan Xu  val renameTime = UInt(XLEN.W)
208ebb8ebf8SYinan Xu  val dispatchTime = UInt(XLEN.W)
209ebb8ebf8SYinan Xu  val enqRsTime = UInt(XLEN.W)
210ebb8ebf8SYinan Xu  val selectTime = UInt(XLEN.W)
211ebb8ebf8SYinan Xu  val issueTime = UInt(XLEN.W)
212ebb8ebf8SYinan Xu  val writebackTime = UInt(XLEN.W)
2137cef916fSYinan Xu  // val commitTime = UInt(64.W)
21420edb3f7SWilliam Wang  val runahead_checkpoint_id = UInt(64.W)
215ba4100caSYinan Xu}
216ba4100caSYinan Xu
21748d1472eSWilliam Wang// Separate LSQ
2182225d46eSJiawei Linclass LSIdx(implicit p: Parameters) extends XSBundle {
219915c0dd4SYinan Xu  val lqIdx = new LqPtr
2205c1ae31bSYinan Xu  val sqIdx = new SqPtr
22124726fbfSWilliam Wang}
22224726fbfSWilliam Wang
223b2e6921eSLinJiawei// CfCtrl -> MicroOp at Rename Stage
2242225d46eSJiawei Linclass MicroOp(implicit p: Parameters) extends CfCtrl {
22520e31bd1SYinan Xu  val srcState = Vec(3, SrcState())
22620e31bd1SYinan Xu  val psrc = Vec(3, UInt(PhyRegIdxWidth.W))
22720e31bd1SYinan Xu  val pdest = UInt(PhyRegIdxWidth.W)
22820e31bd1SYinan Xu  val old_pdest = UInt(PhyRegIdxWidth.W)
2299aca92b9SYinan Xu  val robIdx = new RobPtr
230fe6452fcSYinan Xu  val lqIdx = new LqPtr
231fe6452fcSYinan Xu  val sqIdx = new SqPtr
2328b8e745dSYikeZhou  val eliminatedMove = Bool()
2337cef916fSYinan Xu  val debugInfo = new PerfDebugInfo
2349d4e1137SYinan Xu  def needRfRPort(index: Int, isFp: Boolean, ignoreState: Boolean = true) : Bool = {
235bcce877bSYinan Xu    val stateReady = srcState(index) === SrcState.rdy || ignoreState.B
236bcce877bSYinan Xu    val readReg = if (isFp) {
237bcce877bSYinan Xu      ctrl.srcType(index) === SrcType.fp
238bcce877bSYinan Xu    } else {
239bcce877bSYinan Xu      ctrl.srcType(index) === SrcType.reg && ctrl.lsrc(index) =/= 0.U
240a338f247SYinan Xu    }
241bcce877bSYinan Xu    readReg && stateReady
242a338f247SYinan Xu  }
2435c7674feSYinan Xu  def srcIsReady: Vec[Bool] = {
244c9ebdf90SYinan Xu    VecInit(ctrl.srcType.zip(srcState).map{ case (t, s) => SrcType.isPcOrImm(t) || s === SrcState.rdy })
2455c7674feSYinan Xu  }
2466ab6918fSYinan Xu  def clearExceptions(
2476ab6918fSYinan Xu    exceptionBits: Seq[Int] = Seq(),
2486ab6918fSYinan Xu    flushPipe: Boolean = false,
2496ab6918fSYinan Xu    replayInst: Boolean = false
2506ab6918fSYinan Xu  ): MicroOp = {
2516ab6918fSYinan Xu    cf.exceptionVec.zipWithIndex.filterNot(x => exceptionBits.contains(x._2)).foreach(_._1 := false.B)
2526ab6918fSYinan Xu    if (!flushPipe) { ctrl.flushPipe := false.B }
2536ab6918fSYinan Xu    if (!replayInst) { ctrl.replayInst := false.B }
254c88c3a2aSYinan Xu    this
255c88c3a2aSYinan Xu  }
256a19215ddSYinan Xu  // Assume only the LUI instruction is decoded with IMM_U in ALU.
257a19215ddSYinan Xu  def isLUI: Bool = ctrl.selImm === SelImm.IMM_U && ctrl.fuType === FuType.alu
258bcce877bSYinan Xu  // This MicroOp is used to wakeup another uop (the successor: (psrc, srcType).
259bcce877bSYinan Xu  def wakeup(successor: Seq[(UInt, UInt)], exuCfg: ExuConfig): Seq[(Bool, Bool)] = {
260bcce877bSYinan Xu    successor.map{ case (src, srcType) =>
261bcce877bSYinan Xu      val pdestMatch = pdest === src
262bcce877bSYinan Xu      // For state: no need to check whether src is x0/imm/pc because they are always ready.
263bcce877bSYinan Xu      val rfStateMatch = if (exuCfg.readIntRf) ctrl.rfWen else false.B
264bcce877bSYinan Xu      val fpMatch = if (exuCfg.readFpRf) ctrl.fpWen else false.B
265bcce877bSYinan Xu      val bothIntFp = exuCfg.readIntRf && exuCfg.readFpRf
266bcce877bSYinan Xu      val bothStateMatch = Mux(SrcType.regIsFp(srcType), fpMatch, rfStateMatch)
267bcce877bSYinan Xu      val stateCond = pdestMatch && (if (bothIntFp) bothStateMatch else rfStateMatch || fpMatch)
268bcce877bSYinan Xu      // For data: types are matched and int pdest is not $zero.
269bcce877bSYinan Xu      val rfDataMatch = if (exuCfg.readIntRf) ctrl.rfWen && src =/= 0.U else false.B
270bcce877bSYinan Xu      val dataCond = pdestMatch && (rfDataMatch && SrcType.isReg(srcType) || fpMatch && SrcType.isFp(srcType))
271bcce877bSYinan Xu      (stateCond, dataCond)
272bcce877bSYinan Xu    }
273bcce877bSYinan Xu  }
274bcce877bSYinan Xu  // This MicroOp is used to wakeup another uop (the successor: MicroOp).
275bcce877bSYinan Xu  def wakeup(successor: MicroOp, exuCfg: ExuConfig): Seq[(Bool, Bool)] = {
276bcce877bSYinan Xu    wakeup(successor.psrc.zip(successor.ctrl.srcType), exuCfg)
277bcce877bSYinan Xu  }
27874515c5aSYinan Xu  def isJump: Bool = FuType.isJumpExu(ctrl.fuType)
2795844fcf0SLinJiawei}
2805844fcf0SLinJiawei
28146f74b57SHaojin Tangclass XSBundleWithMicroOp(implicit p: Parameters) extends XSBundle {
282de169c67SWilliam Wang  val uop = new MicroOp
28346f74b57SHaojin Tang}
28446f74b57SHaojin Tang
28546f74b57SHaojin Tangclass MicroOpRbExt(implicit p: Parameters) extends XSBundleWithMicroOp {
286de169c67SWilliam Wang  val flag = UInt(1.W)
287de169c67SWilliam Wang}
288de169c67SWilliam Wang
2892225d46eSJiawei Linclass Redirect(implicit p: Parameters) extends XSBundle {
2909aca92b9SYinan Xu  val robIdx = new RobPtr
29136d7aed5SLinJiawei  val ftqIdx = new FtqPtr
29236d7aed5SLinJiawei  val ftqOffset = UInt(log2Up(PredictWidth).W)
293bfb958a3SYinan Xu  val level = RedirectLevel()
294bfb958a3SYinan Xu  val interrupt = Bool()
295c778d2afSLinJiawei  val cfiUpdate = new CfiUpdateInfo
296bfb958a3SYinan Xu
297de169c67SWilliam Wang  val stFtqIdx = new FtqPtr // for load violation predict
298de169c67SWilliam Wang  val stFtqOffset = UInt(log2Up(PredictWidth).W)
299fe211d16SLinJiawei
30020edb3f7SWilliam Wang  val debug_runahead_checkpoint_id = UInt(64.W)
30120edb3f7SWilliam Wang
3022d7c7105SYinan Xu  // def isUnconditional() = RedirectLevel.isUnconditional(level)
303bfb958a3SYinan Xu  def flushItself() = RedirectLevel.flushItself(level)
3042d7c7105SYinan Xu  // def isException() = RedirectLevel.isException(level)
305a25b1bceSLinJiawei}
306a25b1bceSLinJiawei
3072225d46eSJiawei Linclass Dp1ToDp2IO(implicit p: Parameters) extends XSBundle {
3085c7b21d5SYinan Xu  val intDqToDp2 = Vec(dpParams.IntDqDeqWidth, DecoupledIO(new MicroOp))
3095c7b21d5SYinan Xu  val fpDqToDp2 = Vec(dpParams.FpDqDeqWidth, DecoupledIO(new MicroOp))
3105c7b21d5SYinan Xu  val lsDqToDp2 = Vec(dpParams.LsDqDeqWidth, DecoupledIO(new MicroOp))
3115844fcf0SLinJiawei}
3125844fcf0SLinJiawei
3132b4e8253SYinan Xuclass ResetPregStateReq(implicit p: Parameters) extends XSBundle {
31460deaca2SLinJiawei  // NOTE: set isInt and isFp both to 'false' when invalid
31560deaca2SLinJiawei  val isInt = Bool()
31660deaca2SLinJiawei  val isFp = Bool()
31760deaca2SLinJiawei  val preg = UInt(PhyRegIdxWidth.W)
3185844fcf0SLinJiawei}
3195844fcf0SLinJiawei
3202225d46eSJiawei Linclass DebugBundle(implicit p: Parameters) extends XSBundle {
32172235fa4SWilliam Wang  val isMMIO = Bool()
3228635f18fSwangkaifan  val isPerfCnt = Bool()
3238b91a337SWilliam Wang  val paddr = UInt(PAddrBits.W)
32472951335SLi Qianruo  val vaddr = UInt(VAddrBits.W)
325e402d94eSWilliam Wang}
3265844fcf0SLinJiawei
32746f74b57SHaojin Tangclass ExuInput(implicit p: Parameters) extends XSBundleWithMicroOp {
328dc597826SJiawei Lin  val src = Vec(3, UInt(XLEN.W))
3295844fcf0SLinJiawei}
3305844fcf0SLinJiawei
33146f74b57SHaojin Tangclass ExuOutput(implicit p: Parameters) extends XSBundleWithMicroOp {
332dc597826SJiawei Lin  val data = UInt(XLEN.W)
3337f1506e3SLinJiawei  val fflags = UInt(5.W)
33497cfa7f8SLinJiawei  val redirectValid = Bool()
33597cfa7f8SLinJiawei  val redirect = new Redirect
336e402d94eSWilliam Wang  val debug = new DebugBundle
3375844fcf0SLinJiawei}
3385844fcf0SLinJiawei
3392225d46eSJiawei Linclass ExternalInterruptIO(implicit p: Parameters) extends XSBundle {
34035bfeecbSYinan Xu  val mtip = Input(Bool())
34135bfeecbSYinan Xu  val msip = Input(Bool())
34235bfeecbSYinan Xu  val meip = Input(Bool())
343b3d79b37SYinan Xu  val seip = Input(Bool())
344d4aca96cSlqre  val debug = Input(Bool())
3455844fcf0SLinJiawei}
3465844fcf0SLinJiawei
3472225d46eSJiawei Linclass CSRSpecialIO(implicit p: Parameters) extends XSBundle {
34835bfeecbSYinan Xu  val exception = Flipped(ValidIO(new MicroOp))
3493fa7b737SYinan Xu  val isInterrupt = Input(Bool())
35035bfeecbSYinan Xu  val memExceptionVAddr = Input(UInt(VAddrBits.W))
35135bfeecbSYinan Xu  val trapTarget = Output(UInt(VAddrBits.W))
35235bfeecbSYinan Xu  val externalInterrupt = new ExternalInterruptIO
35335bfeecbSYinan Xu  val interrupt = Output(Bool())
35435bfeecbSYinan Xu}
35535bfeecbSYinan Xu
35646f74b57SHaojin Tangclass ExceptionInfo(implicit p: Parameters) extends XSBundleWithMicroOp {
3573a474d38SYinan Xu  val isInterrupt = Bool()
3583a474d38SYinan Xu}
3593a474d38SYinan Xu
3609aca92b9SYinan Xuclass RobCommitInfo(implicit p: Parameters) extends XSBundle {
361fe6452fcSYinan Xu  val ldest = UInt(5.W)
362fe6452fcSYinan Xu  val rfWen = Bool()
363fe6452fcSYinan Xu  val fpWen = Bool()
364a1fd7de4SLinJiawei  val wflags = Bool()
365fe6452fcSYinan Xu  val commitType = CommitType()
366fe6452fcSYinan Xu  val pdest = UInt(PhyRegIdxWidth.W)
367fe6452fcSYinan Xu  val old_pdest = UInt(PhyRegIdxWidth.W)
368884dbb3bSLinJiawei  val ftqIdx = new FtqPtr
369884dbb3bSLinJiawei  val ftqOffset = UInt(log2Up(PredictWidth).W)
370ccfddc82SHaojin Tang  val isMove = Bool()
3715844fcf0SLinJiawei
3729ecac1e8SYinan Xu  // these should be optimized for synthesis verilog
3739ecac1e8SYinan Xu  val pc = UInt(VAddrBits.W)
374fe6452fcSYinan Xu}
3755844fcf0SLinJiawei
3769aca92b9SYinan Xuclass RobCommitIO(implicit p: Parameters) extends XSBundle {
377ccfddc82SHaojin Tang  val isCommit = Bool()
378ccfddc82SHaojin Tang  val commitValid = Vec(CommitWidth, Bool())
3796474c47fSYinan Xu
380ccfddc82SHaojin Tang  val isWalk = Bool()
381c51eab43SYinan Xu  // valid bits optimized for walk
382ccfddc82SHaojin Tang  val walkValid = Vec(CommitWidth, Bool())
3836474c47fSYinan Xu
384ccfddc82SHaojin Tang  val info = Vec(CommitWidth, new RobCommitInfo)
38521e7a6c5SYinan Xu
3866474c47fSYinan Xu  def hasWalkInstr: Bool = isWalk && walkValid.asUInt.orR
3876474c47fSYinan Xu  def hasCommitInstr: Bool = isCommit && commitValid.asUInt.orR
3885844fcf0SLinJiawei}
3895844fcf0SLinJiawei
3901b7adedcSWilliam Wangclass RSFeedback(implicit p: Parameters) extends XSBundle {
39164e8d8bdSZhangZifei  val rsIdx = UInt(log2Up(IssQueSize).W)
392037a131fSWilliam Wang  val hit = Bool()
39362f57a35SLemover  val flushState = Bool()
3941b7adedcSWilliam Wang  val sourceType = RSFeedbackType()
395c7160cd3SWilliam Wang  val dataInvalidSqIdx = new SqPtr
396037a131fSWilliam Wang}
397037a131fSWilliam Wang
398d87b76aaSWilliam Wangclass MemRSFeedbackIO(implicit p: Parameters) extends XSBundle {
399d87b76aaSWilliam Wang  // Note: you need to update in implicit Parameters p before imp MemRSFeedbackIO
400d87b76aaSWilliam Wang  // for instance: MemRSFeedbackIO()(updateP)
401d87b76aaSWilliam Wang  val feedbackSlow = ValidIO(new RSFeedback()) // dcache miss queue full, dtlb miss
402d87b76aaSWilliam Wang  val feedbackFast = ValidIO(new RSFeedback()) // bank conflict
403d87b76aaSWilliam Wang  val rsIdx = Input(UInt(log2Up(IssQueSize).W))
404d87b76aaSWilliam Wang  val isFirstIssue = Input(Bool())
405d87b76aaSWilliam Wang}
406d87b76aaSWilliam Wang
407f06ca0bfSLingrui98class FrontendToCtrlIO(implicit p: Parameters) extends XSBundle {
4085844fcf0SLinJiawei  // to backend end
4095844fcf0SLinJiawei  val cfVec = Vec(DecodeWidth, DecoupledIO(new CtrlFlow))
410f06ca0bfSLingrui98  val fromFtq = new FtqToCtrlIO
4115844fcf0SLinJiawei  // from backend
412f06ca0bfSLingrui98  val toFtq = Flipped(new CtrlToFtqIO)
4131e3fad10SLinJiawei}
414fcff7e94SZhangZifei
415f1fe8698SLemoverclass SatpStruct(implicit p: Parameters) extends XSBundle {
41645f497a4Shappy-lx  val mode = UInt(4.W)
41745f497a4Shappy-lx  val asid = UInt(16.W)
41845f497a4Shappy-lx  val ppn  = UInt(44.W)
41945f497a4Shappy-lx}
42045f497a4Shappy-lx
421f1fe8698SLemoverclass TlbSatpBundle(implicit p: Parameters) extends SatpStruct {
42245f497a4Shappy-lx  val changed = Bool()
42345f497a4Shappy-lx
42445f497a4Shappy-lx  def apply(satp_value: UInt): Unit = {
42545f497a4Shappy-lx    require(satp_value.getWidth == XLEN)
42645f497a4Shappy-lx    val sa = satp_value.asTypeOf(new SatpStruct)
42745f497a4Shappy-lx    mode := sa.mode
42845f497a4Shappy-lx    asid := sa.asid
429f1fe8698SLemover    ppn := Cat(0.U(44-PAddrBits), sa.ppn(PAddrBits-1, 0)).asUInt()
43045f497a4Shappy-lx    changed := DataChanged(sa.asid) // when ppn is changed, software need do the flush
43145f497a4Shappy-lx  }
432fcff7e94SZhangZifei}
433f1fe8698SLemover
434f1fe8698SLemoverclass TlbCsrBundle(implicit p: Parameters) extends XSBundle {
435f1fe8698SLemover  val satp = new TlbSatpBundle()
436fcff7e94SZhangZifei  val priv = new Bundle {
437fcff7e94SZhangZifei    val mxr = Bool()
438fcff7e94SZhangZifei    val sum = Bool()
439fcff7e94SZhangZifei    val imode = UInt(2.W)
440fcff7e94SZhangZifei    val dmode = UInt(2.W)
441fcff7e94SZhangZifei  }
4428fc4e859SZhangZifei
4438fc4e859SZhangZifei  override def toPrintable: Printable = {
4448fc4e859SZhangZifei    p"Satp mode:0x${Hexadecimal(satp.mode)} asid:0x${Hexadecimal(satp.asid)} ppn:0x${Hexadecimal(satp.ppn)} " +
4458fc4e859SZhangZifei      p"Priv mxr:${priv.mxr} sum:${priv.sum} imode:${priv.imode} dmode:${priv.dmode}"
4468fc4e859SZhangZifei  }
447fcff7e94SZhangZifei}
448fcff7e94SZhangZifei
4492225d46eSJiawei Linclass SfenceBundle(implicit p: Parameters) extends XSBundle {
450fcff7e94SZhangZifei  val valid = Bool()
451fcff7e94SZhangZifei  val bits = new Bundle {
452fcff7e94SZhangZifei    val rs1 = Bool()
453fcff7e94SZhangZifei    val rs2 = Bool()
454fcff7e94SZhangZifei    val addr = UInt(VAddrBits.W)
45545f497a4Shappy-lx    val asid = UInt(AsidLength.W)
456f1fe8698SLemover    val flushPipe = Bool()
457fcff7e94SZhangZifei  }
4588fc4e859SZhangZifei
4598fc4e859SZhangZifei  override def toPrintable: Printable = {
460f1fe8698SLemover    p"valid:0x${Hexadecimal(valid)} rs1:${bits.rs1} rs2:${bits.rs2} addr:${Hexadecimal(bits.addr)}, flushPipe:${bits.flushPipe}"
4618fc4e859SZhangZifei  }
462fcff7e94SZhangZifei}
463a165bd69Swangkaifan
464de169c67SWilliam Wang// Bundle for load violation predictor updating
465de169c67SWilliam Wangclass MemPredUpdateReq(implicit p: Parameters) extends XSBundle  {
4662b8b2e7aSWilliam Wang  val valid = Bool()
467de169c67SWilliam Wang
468de169c67SWilliam Wang  // wait table update
469de169c67SWilliam Wang  val waddr = UInt(MemPredPCWidth.W)
4702b8b2e7aSWilliam Wang  val wdata = Bool() // true.B by default
471de169c67SWilliam Wang
472de169c67SWilliam Wang  // store set update
473de169c67SWilliam Wang  // by default, ldpc/stpc should be xor folded
474de169c67SWilliam Wang  val ldpc = UInt(MemPredPCWidth.W)
475de169c67SWilliam Wang  val stpc = UInt(MemPredPCWidth.W)
4762b8b2e7aSWilliam Wang}
4772b8b2e7aSWilliam Wang
4782225d46eSJiawei Linclass CustomCSRCtrlIO(implicit p: Parameters) extends XSBundle {
4792b8b2e7aSWilliam Wang  // Prefetcher
480ecccf78fSJay  val l1I_pf_enable = Output(Bool())
4812b8b2e7aSWilliam Wang  val l2_pf_enable = Output(Bool())
482ecccf78fSJay  // ICache
483ecccf78fSJay  val icache_parity_enable = Output(Bool())
484f3f22d72SYinan Xu  // Labeled XiangShan
4852b8b2e7aSWilliam Wang  val dsid = Output(UInt(8.W)) // TODO: DsidWidth as parameter
486f3f22d72SYinan Xu  // Load violation predictor
4872b8b2e7aSWilliam Wang  val lvpred_disable = Output(Bool())
4882b8b2e7aSWilliam Wang  val no_spec_load = Output(Bool())
489c7160cd3SWilliam Wang  val storeset_wait_store = Output(Bool())
490c7160cd3SWilliam Wang  val storeset_no_fast_wakeup = Output(Bool())
491c7160cd3SWilliam Wang  val lvpred_timeout = Output(UInt(5.W))
492f3f22d72SYinan Xu  // Branch predictor
4932b8b2e7aSWilliam Wang  val bp_ctrl = Output(new BPUCtrl)
494f3f22d72SYinan Xu  // Memory Block
495f3f22d72SYinan Xu  val sbuffer_threshold = Output(UInt(4.W))
496d10a581eSWilliam Wang  val ldld_vio_check_enable = Output(Bool())
497d10a581eSWilliam Wang  val soft_prefetch_enable = Output(Bool())
498a4e57ea3SLi Qianruo  val cache_error_enable = Output(Bool())
499aac4464eSYinan Xu  // Rename
500aac4464eSYinan Xu  val move_elim_enable = Output(Bool())
501af2f7849Shappy-lx  // Decode
502af2f7849Shappy-lx  val svinval_enable = Output(Bool())
503af2f7849Shappy-lx
504b6982e83SLemover  // distribute csr write signal
505b6982e83SLemover  val distribute_csr = new DistributedCSRIO()
50672951335SLi Qianruo
507ddb65c47SLi Qianruo  val singlestep = Output(Bool())
50872951335SLi Qianruo  val frontend_trigger = new FrontendTdataDistributeIO()
50972951335SLi Qianruo  val mem_trigger = new MemTdataDistributeIO()
51072951335SLi Qianruo  val trigger_enable = Output(Vec(10, Bool()))
511b6982e83SLemover}
512b6982e83SLemover
513b6982e83SLemoverclass DistributedCSRIO(implicit p: Parameters) extends XSBundle {
5141c746d3aScui fliter  // CSR has been written by csr inst, copies of csr should be updated
515b6982e83SLemover  val w = ValidIO(new Bundle {
516b6982e83SLemover    val addr = Output(UInt(12.W))
517b6982e83SLemover    val data = Output(UInt(XLEN.W))
518b6982e83SLemover  })
5192b8b2e7aSWilliam Wang}
520e19f7967SWilliam Wang
521e19f7967SWilliam Wangclass DistributedCSRUpdateReq(implicit p: Parameters) extends XSBundle {
522e19f7967SWilliam Wang  // Request csr to be updated
523e19f7967SWilliam Wang  //
524e19f7967SWilliam Wang  // Note that this request will ONLY update CSR Module it self,
525e19f7967SWilliam Wang  // copies of csr will NOT be updated, use it with care!
526e19f7967SWilliam Wang  //
527e19f7967SWilliam Wang  // For each cycle, no more than 1 DistributedCSRUpdateReq is valid
528e19f7967SWilliam Wang  val w = ValidIO(new Bundle {
529e19f7967SWilliam Wang    val addr = Output(UInt(12.W))
530e19f7967SWilliam Wang    val data = Output(UInt(XLEN.W))
531e19f7967SWilliam Wang  })
532e19f7967SWilliam Wang  def apply(valid: Bool, addr: UInt, data: UInt, src_description: String) = {
533e19f7967SWilliam Wang    when(valid){
534e19f7967SWilliam Wang      w.bits.addr := addr
535e19f7967SWilliam Wang      w.bits.data := data
536e19f7967SWilliam Wang    }
537e19f7967SWilliam Wang    println("Distributed CSR update req registered for " + src_description)
538e19f7967SWilliam Wang  }
539e19f7967SWilliam Wang}
54072951335SLi Qianruo
5410f59c834SWilliam Wangclass L1CacheErrorInfo(implicit p: Parameters) extends XSBundle {
5420f59c834SWilliam Wang  // L1CacheErrorInfo is also used to encode customized CACHE_ERROR CSR
5430f59c834SWilliam Wang  val source = Output(new Bundle() {
5440f59c834SWilliam Wang    val tag = Bool() // l1 tag array
5450f59c834SWilliam Wang    val data = Bool() // l1 data array
5460f59c834SWilliam Wang    val l2 = Bool()
5470f59c834SWilliam Wang  })
5480f59c834SWilliam Wang  val opType = Output(new Bundle() {
5490f59c834SWilliam Wang    val fetch = Bool()
5500f59c834SWilliam Wang    val load = Bool()
5510f59c834SWilliam Wang    val store = Bool()
5520f59c834SWilliam Wang    val probe = Bool()
5530f59c834SWilliam Wang    val release = Bool()
5540f59c834SWilliam Wang    val atom = Bool()
5550f59c834SWilliam Wang  })
5560f59c834SWilliam Wang  val paddr = Output(UInt(PAddrBits.W))
5570f59c834SWilliam Wang
5580f59c834SWilliam Wang  // report error and paddr to beu
5590f59c834SWilliam Wang  // bus error unit will receive error info iff ecc_error.valid
5600f59c834SWilliam Wang  val report_to_beu = Output(Bool())
5610f59c834SWilliam Wang
5620f59c834SWilliam Wang  // there is an valid error
5630f59c834SWilliam Wang  // l1 cache error will always be report to CACHE_ERROR csr
5640f59c834SWilliam Wang  val valid = Output(Bool())
5650f59c834SWilliam Wang
5660f59c834SWilliam Wang  def toL1BusErrorUnitInfo(): L1BusErrorUnitInfo = {
5670f59c834SWilliam Wang    val beu_info = Wire(new L1BusErrorUnitInfo)
5680f59c834SWilliam Wang    beu_info.ecc_error.valid := report_to_beu
5690f59c834SWilliam Wang    beu_info.ecc_error.bits := paddr
5700f59c834SWilliam Wang    beu_info
5710f59c834SWilliam Wang  }
5720f59c834SWilliam Wang}
573bc63e578SLi Qianruo
574bc63e578SLi Qianruo/* TODO how to trigger on next inst?
575bc63e578SLi Qianruo1. If hit is determined at frontend, then set a "next instr" trap at dispatch like singlestep
576bc63e578SLi Qianruo2. If it is determined at Load(meaning it must be "hit after", then it must not be a jump. So we can let it commit and set
577bc63e578SLi Qianruoxret csr to pc + 4/ + 2
578bc63e578SLi Qianruo2.5 The problem is to let it commit. This is the real TODO
579bc63e578SLi Qianruo3. If it is load and hit before just treat it as regular load exception
580bc63e578SLi Qianruo */
581bc63e578SLi Qianruo
582bc63e578SLi Qianruo// This bundle carries trigger hit info along the pipeline
583bc63e578SLi Qianruo// Now there are 10 triggers divided into 5 groups of 2
584bc63e578SLi Qianruo// These groups are
585bc63e578SLi Qianruo// (if if) (store store) (load loid) (if store) (if load)
586bc63e578SLi Qianruo
587bc63e578SLi Qianruo// Triggers in the same group can chain, meaning that they only
588bc63e578SLi Qianruo// fire is both triggers in the group matches (the triggerHitVec bit is asserted)
589bc63e578SLi Qianruo// Chaining of trigger No. (2i) and (2i+1) is indicated by triggerChainVec(i)
590bc63e578SLi Qianruo// Timing of 0 means trap at current inst, 1 means trap at next inst
591bc63e578SLi Qianruo// Chaining and timing and the validness of a trigger is controlled by csr
592bc63e578SLi Qianruo// In two chained triggers, if they have different timing, both won't fire
59384e47f35SLi Qianruo//class TriggerCf (implicit p: Parameters) extends XSBundle {
59484e47f35SLi Qianruo//  val triggerHitVec = Vec(10, Bool())
59584e47f35SLi Qianruo//  val triggerTiming = Vec(10, Bool())
59684e47f35SLi Qianruo//  val triggerChainVec = Vec(5, Bool())
59784e47f35SLi Qianruo//}
59884e47f35SLi Qianruo
59972951335SLi Qianruoclass TriggerCf(implicit p: Parameters) extends XSBundle {
60084e47f35SLi Qianruo  // frontend
60184e47f35SLi Qianruo  val frontendHit = Vec(4, Bool())
602ddb65c47SLi Qianruo//  val frontendTiming = Vec(4, Bool())
603ddb65c47SLi Qianruo//  val frontendHitNext = Vec(4, Bool())
60484e47f35SLi Qianruo
605ddb65c47SLi Qianruo//  val frontendException = Bool()
60684e47f35SLi Qianruo  // backend
60784e47f35SLi Qianruo  val backendEn = Vec(2, Bool()) // Hit(6) && chain(4) , Hit(8) && chain(4)
60884e47f35SLi Qianruo  val backendHit = Vec(6, Bool())
609ddb65c47SLi Qianruo//  val backendTiming = Vec(6, Bool()) // trigger enable fro chain
61084e47f35SLi Qianruo
61184e47f35SLi Qianruo  // Two situations not allowed:
61284e47f35SLi Qianruo  // 1. load data comparison
61384e47f35SLi Qianruo  // 2. store chaining with store
61484e47f35SLi Qianruo  def getHitFrontend = frontendHit.reduce(_ || _)
61584e47f35SLi Qianruo  def getHitBackend = backendHit.reduce(_ || _)
616ddb65c47SLi Qianruo  def hit = getHitFrontend || getHitBackend
617d7dd1af1SLi Qianruo  def clear(): Unit = {
618d7dd1af1SLi Qianruo    frontendHit.foreach(_ := false.B)
619d7dd1af1SLi Qianruo    backendEn.foreach(_ := false.B)
620d7dd1af1SLi Qianruo    backendHit.foreach(_ := false.B)
621d7dd1af1SLi Qianruo  }
62272951335SLi Qianruo}
62372951335SLi Qianruo
624bc63e578SLi Qianruo// these 3 bundles help distribute trigger control signals from CSR
625bc63e578SLi Qianruo// to Frontend, Load and Store.
62672951335SLi Qianruoclass FrontendTdataDistributeIO(implicit p: Parameters)  extends XSBundle {
62772951335SLi Qianruo    val t = Valid(new Bundle {
62872951335SLi Qianruo      val addr = Output(UInt(2.W))
62972951335SLi Qianruo      val tdata = new MatchTriggerIO
63072951335SLi Qianruo    })
63172951335SLi Qianruo  }
63272951335SLi Qianruo
63372951335SLi Qianruoclass MemTdataDistributeIO(implicit p: Parameters)  extends XSBundle {
63472951335SLi Qianruo  val t = Valid(new Bundle {
63572951335SLi Qianruo    val addr = Output(UInt(3.W))
63672951335SLi Qianruo    val tdata = new MatchTriggerIO
63772951335SLi Qianruo  })
63872951335SLi Qianruo}
63972951335SLi Qianruo
64072951335SLi Qianruoclass MatchTriggerIO(implicit p: Parameters) extends XSBundle {
64172951335SLi Qianruo  val matchType = Output(UInt(2.W))
64272951335SLi Qianruo  val select = Output(Bool())
64372951335SLi Qianruo  val timing = Output(Bool())
64472951335SLi Qianruo  val action = Output(Bool())
64572951335SLi Qianruo  val chain = Output(Bool())
64672951335SLi Qianruo  val tdata2 = Output(UInt(64.W))
64772951335SLi Qianruo}
648