xref: /XiangShan/src/main/scala/xiangshan/Bundle.scala (revision 40a70bd6dfd3d57045629b3cc57f870a2d2bba4b)
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
65eb163ef0SHaojin Tang  val feedbackInvalid = 7.U(3.W)
66eb163ef0SHaojin 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)
1325844fcf0SLinJiawei}
1335844fcf0SLinJiawei
13472951335SLi Qianruo
1352225d46eSJiawei Linclass FPUCtrlSignals(implicit p: Parameters) extends XSBundle {
1362ce29ed6SLinJiawei  val isAddSub = Bool() // swap23
137dc597826SJiawei Lin  val typeTagIn = UInt(1.W)
138dc597826SJiawei Lin  val typeTagOut = UInt(1.W)
1392ce29ed6SLinJiawei  val fromInt = Bool()
1402ce29ed6SLinJiawei  val wflags = Bool()
1412ce29ed6SLinJiawei  val fpWen = Bool()
1422ce29ed6SLinJiawei  val fmaCmd = UInt(2.W)
1432ce29ed6SLinJiawei  val div = Bool()
1442ce29ed6SLinJiawei  val sqrt = Bool()
1452ce29ed6SLinJiawei  val fcvt = Bool()
1462ce29ed6SLinJiawei  val typ = UInt(2.W)
1472ce29ed6SLinJiawei  val fmt = UInt(2.W)
1482ce29ed6SLinJiawei  val ren3 = Bool() //TODO: remove SrcType.fp
149e6c6b64fSLinJiawei  val rm = UInt(3.W)
150579b9f28SLinJiawei}
151579b9f28SLinJiawei
1525844fcf0SLinJiawei// Decode DecodeWidth insts at Decode Stage
1532225d46eSJiawei Linclass CtrlSignals(implicit p: Parameters) extends XSBundle {
154a7a8a6ccSHaojin Tang  val srcType = Vec(4, SrcType())
155a7a8a6ccSHaojin Tang  val lsrc = Vec(4, UInt(6.W))
156a7a8a6ccSHaojin Tang  val ldest = UInt(6.W)
1579a2e6b8aSLinJiawei  val fuType = FuType()
1589a2e6b8aSLinJiawei  val fuOpType = FuOpType()
1599a2e6b8aSLinJiawei  val rfWen = Bool()
1609a2e6b8aSLinJiawei  val fpWen = Bool()
161deb6421eSHaojin Tang  val vecWen = Bool()
1629a2e6b8aSLinJiawei  val isXSTrap = Bool()
1632d366136SLinJiawei  val noSpecExec = Bool() // wait forward
1642d366136SLinJiawei  val blockBackward = Bool() // block backward
16545a56a29SZhangZifei  val flushPipe = Bool() // This inst will flush all the pipe when commit, like exception but can commit
166c2a8ae00SYikeZhou  val selImm = SelImm()
167b0ae3ac4SLinJiawei  val imm = UInt(ImmUnion.maxLen.W)
168a3edac52SYinan Xu  val commitType = CommitType()
169579b9f28SLinJiawei  val fpu = new FPUCtrlSignals
170aac4464eSYinan Xu  val isMove = Bool()
171d4aca96cSlqre  val singleStep = Bool()
172c88c3a2aSYinan Xu  // This inst will flush all the pipe when it is the oldest inst in ROB,
173c88c3a2aSYinan Xu  // then replay from this inst itself
174c88c3a2aSYinan Xu  val replayInst = Bool()
175be25371aSYikeZhou
176a7a8a6ccSHaojin Tang  private def allSignals = srcType.take(3) ++ Seq(fuType, fuOpType, rfWen, fpWen,
1776e7c9679Shuxuan0307    isXSTrap, noSpecExec, blockBackward, flushPipe, selImm)
17888825c5cSYinan Xu
17988825c5cSYinan Xu  def decode(inst: UInt, table: Iterable[(BitPat, List[BitPat])]): CtrlSignals = {
18088825c5cSYinan Xu    val decoder = freechips.rocketchip.rocket.DecodeLogic(inst, XDecode.decodeDefault, table)
18188825c5cSYinan Xu    allSignals zip decoder foreach { case (s, d) => s := d }
1824d24c305SYikeZhou    commitType := DontCare
183be25371aSYikeZhou    this
184be25371aSYikeZhou  }
18588825c5cSYinan Xu
18688825c5cSYinan Xu  def decode(bit: List[BitPat]): CtrlSignals = {
18788825c5cSYinan Xu    allSignals.zip(bit.map(bitPatToUInt(_))).foreach{ case (s, d) => s := d }
18888825c5cSYinan Xu    this
18988825c5cSYinan Xu  }
190b6900d94SYinan Xu
191b6900d94SYinan Xu  def isWFI: Bool = fuType === FuType.csr && fuOpType === CSROpType.wfi
192f025d715SYinan Xu  def isSoftPrefetch: Bool = {
193f025d715SYinan Xu    fuType === FuType.alu && fuOpType === ALUOpType.or && selImm === SelImm.IMM_I && ldest === 0.U
194f025d715SYinan Xu  }
1955844fcf0SLinJiawei}
1965844fcf0SLinJiawei
1972225d46eSJiawei Linclass CfCtrl(implicit p: Parameters) extends XSBundle {
1985844fcf0SLinJiawei  val cf = new CtrlFlow
1995844fcf0SLinJiawei  val ctrl = new CtrlSignals
2005844fcf0SLinJiawei}
2015844fcf0SLinJiawei
2022225d46eSJiawei Linclass PerfDebugInfo(implicit p: Parameters) extends XSBundle {
2038b8e745dSYikeZhou  val eliminatedMove = Bool()
204ba4100caSYinan Xu  // val fetchTime = UInt(64.W)
205ebb8ebf8SYinan Xu  val renameTime = UInt(XLEN.W)
206ebb8ebf8SYinan Xu  val dispatchTime = UInt(XLEN.W)
207ebb8ebf8SYinan Xu  val enqRsTime = UInt(XLEN.W)
208ebb8ebf8SYinan Xu  val selectTime = UInt(XLEN.W)
209ebb8ebf8SYinan Xu  val issueTime = UInt(XLEN.W)
210ebb8ebf8SYinan Xu  val writebackTime = UInt(XLEN.W)
2117cef916fSYinan Xu  // val commitTime = UInt(64.W)
21220edb3f7SWilliam Wang  val runahead_checkpoint_id = UInt(64.W)
213ba4100caSYinan Xu}
214ba4100caSYinan Xu
21548d1472eSWilliam Wang// Separate LSQ
2162225d46eSJiawei Linclass LSIdx(implicit p: Parameters) extends XSBundle {
217915c0dd4SYinan Xu  val lqIdx = new LqPtr
2185c1ae31bSYinan Xu  val sqIdx = new SqPtr
21924726fbfSWilliam Wang}
22024726fbfSWilliam Wang
221b2e6921eSLinJiawei// CfCtrl -> MicroOp at Rename Stage
2222225d46eSJiawei Linclass MicroOp(implicit p: Parameters) extends CfCtrl {
223a7a8a6ccSHaojin Tang  val srcState = Vec(4, SrcState())
224a7a8a6ccSHaojin Tang  val psrc = Vec(4, UInt(PhyRegIdxWidth.W))
22520e31bd1SYinan Xu  val pdest = UInt(PhyRegIdxWidth.W)
22620e31bd1SYinan Xu  val old_pdest = UInt(PhyRegIdxWidth.W)
2279aca92b9SYinan Xu  val robIdx = new RobPtr
228fe6452fcSYinan Xu  val lqIdx = new LqPtr
229fe6452fcSYinan Xu  val sqIdx = new SqPtr
2308b8e745dSYikeZhou  val eliminatedMove = Bool()
2317cef916fSYinan Xu  val debugInfo = new PerfDebugInfo
2329d4e1137SYinan Xu  def needRfRPort(index: Int, isFp: Boolean, ignoreState: Boolean = true) : Bool = {
233bcce877bSYinan Xu    val stateReady = srcState(index) === SrcState.rdy || ignoreState.B
234bcce877bSYinan Xu    val readReg = if (isFp) {
235bcce877bSYinan Xu      ctrl.srcType(index) === SrcType.fp
236bcce877bSYinan Xu    } else {
237bcce877bSYinan Xu      ctrl.srcType(index) === SrcType.reg && ctrl.lsrc(index) =/= 0.U
238a338f247SYinan Xu    }
239bcce877bSYinan Xu    readReg && stateReady
240a338f247SYinan Xu  }
2415c7674feSYinan Xu  def srcIsReady: Vec[Bool] = {
242c9ebdf90SYinan Xu    VecInit(ctrl.srcType.zip(srcState).map{ case (t, s) => SrcType.isPcOrImm(t) || s === SrcState.rdy })
2435c7674feSYinan Xu  }
2446ab6918fSYinan Xu  def clearExceptions(
2456ab6918fSYinan Xu    exceptionBits: Seq[Int] = Seq(),
2466ab6918fSYinan Xu    flushPipe: Boolean = false,
2476ab6918fSYinan Xu    replayInst: Boolean = false
2486ab6918fSYinan Xu  ): MicroOp = {
2496ab6918fSYinan Xu    cf.exceptionVec.zipWithIndex.filterNot(x => exceptionBits.contains(x._2)).foreach(_._1 := false.B)
2506ab6918fSYinan Xu    if (!flushPipe) { ctrl.flushPipe := false.B }
2516ab6918fSYinan Xu    if (!replayInst) { ctrl.replayInst := false.B }
252c88c3a2aSYinan Xu    this
253c88c3a2aSYinan Xu  }
254a19215ddSYinan Xu  // Assume only the LUI instruction is decoded with IMM_U in ALU.
255a19215ddSYinan Xu  def isLUI: Bool = ctrl.selImm === SelImm.IMM_U && ctrl.fuType === FuType.alu
256bcce877bSYinan Xu  // This MicroOp is used to wakeup another uop (the successor: (psrc, srcType).
257bcce877bSYinan Xu  def wakeup(successor: Seq[(UInt, UInt)], exuCfg: ExuConfig): Seq[(Bool, Bool)] = {
258bcce877bSYinan Xu    successor.map{ case (src, srcType) =>
259bcce877bSYinan Xu      val pdestMatch = pdest === src
260bcce877bSYinan Xu      // For state: no need to check whether src is x0/imm/pc because they are always ready.
261bcce877bSYinan Xu      val rfStateMatch = if (exuCfg.readIntRf) ctrl.rfWen else false.B
262bcce877bSYinan Xu      val fpMatch = if (exuCfg.readFpRf) ctrl.fpWen else false.B
263bcce877bSYinan Xu      val bothIntFp = exuCfg.readIntRf && exuCfg.readFpRf
2641285b047SXuan Hu      val bothStateMatch = Mux(SrcType.isFp(srcType), fpMatch, rfStateMatch)
265bcce877bSYinan Xu      val stateCond = pdestMatch && (if (bothIntFp) bothStateMatch else rfStateMatch || fpMatch)
266bcce877bSYinan Xu      // For data: types are matched and int pdest is not $zero.
267bcce877bSYinan Xu      val rfDataMatch = if (exuCfg.readIntRf) ctrl.rfWen && src =/= 0.U else false.B
268bcce877bSYinan Xu      val dataCond = pdestMatch && (rfDataMatch && SrcType.isReg(srcType) || fpMatch && SrcType.isFp(srcType))
269bcce877bSYinan Xu      (stateCond, dataCond)
270bcce877bSYinan Xu    }
271bcce877bSYinan Xu  }
272bcce877bSYinan Xu  // This MicroOp is used to wakeup another uop (the successor: MicroOp).
273bcce877bSYinan Xu  def wakeup(successor: MicroOp, exuCfg: ExuConfig): Seq[(Bool, Bool)] = {
274bcce877bSYinan Xu    wakeup(successor.psrc.zip(successor.ctrl.srcType), exuCfg)
275bcce877bSYinan Xu  }
27674515c5aSYinan Xu  def isJump: Bool = FuType.isJumpExu(ctrl.fuType)
2775844fcf0SLinJiawei}
2785844fcf0SLinJiawei
27946f74b57SHaojin Tangclass XSBundleWithMicroOp(implicit p: Parameters) extends XSBundle {
280de169c67SWilliam Wang  val uop = new MicroOp
28146f74b57SHaojin Tang}
28246f74b57SHaojin Tang
28346f74b57SHaojin Tangclass MicroOpRbExt(implicit p: Parameters) extends XSBundleWithMicroOp {
284de169c67SWilliam Wang  val flag = UInt(1.W)
285de169c67SWilliam Wang}
286de169c67SWilliam Wang
2872225d46eSJiawei Linclass Redirect(implicit p: Parameters) extends XSBundle {
2889aca92b9SYinan Xu  val robIdx = new RobPtr
28936d7aed5SLinJiawei  val ftqIdx = new FtqPtr
29036d7aed5SLinJiawei  val ftqOffset = UInt(log2Up(PredictWidth).W)
291bfb958a3SYinan Xu  val level = RedirectLevel()
292bfb958a3SYinan Xu  val interrupt = Bool()
293c778d2afSLinJiawei  val cfiUpdate = new CfiUpdateInfo
294bfb958a3SYinan Xu
295de169c67SWilliam Wang  val stFtqIdx = new FtqPtr // for load violation predict
296de169c67SWilliam Wang  val stFtqOffset = UInt(log2Up(PredictWidth).W)
297fe211d16SLinJiawei
29820edb3f7SWilliam Wang  val debug_runahead_checkpoint_id = UInt(64.W)
29920edb3f7SWilliam Wang
3002d7c7105SYinan Xu  // def isUnconditional() = RedirectLevel.isUnconditional(level)
301bfb958a3SYinan Xu  def flushItself() = RedirectLevel.flushItself(level)
3022d7c7105SYinan Xu  // def isException() = RedirectLevel.isException(level)
303a25b1bceSLinJiawei}
304a25b1bceSLinJiawei
3052225d46eSJiawei Linclass Dp1ToDp2IO(implicit p: Parameters) extends XSBundle {
3065c7b21d5SYinan Xu  val intDqToDp2 = Vec(dpParams.IntDqDeqWidth, DecoupledIO(new MicroOp))
3075c7b21d5SYinan Xu  val fpDqToDp2 = Vec(dpParams.FpDqDeqWidth, DecoupledIO(new MicroOp))
3085c7b21d5SYinan Xu  val lsDqToDp2 = Vec(dpParams.LsDqDeqWidth, DecoupledIO(new MicroOp))
3095844fcf0SLinJiawei}
3105844fcf0SLinJiawei
3112b4e8253SYinan Xuclass ResetPregStateReq(implicit p: Parameters) extends XSBundle {
31260deaca2SLinJiawei  // NOTE: set isInt and isFp both to 'false' when invalid
31360deaca2SLinJiawei  val isInt = Bool()
31460deaca2SLinJiawei  val isFp = Bool()
31560deaca2SLinJiawei  val preg = UInt(PhyRegIdxWidth.W)
3165844fcf0SLinJiawei}
3175844fcf0SLinJiawei
3182225d46eSJiawei Linclass DebugBundle(implicit p: Parameters) extends XSBundle {
31972235fa4SWilliam Wang  val isMMIO = Bool()
3208635f18fSwangkaifan  val isPerfCnt = Bool()
3218b91a337SWilliam Wang  val paddr = UInt(PAddrBits.W)
32272951335SLi Qianruo  val vaddr = UInt(VAddrBits.W)
323e402d94eSWilliam Wang}
3245844fcf0SLinJiawei
325*40a70bd6SZhangZifeiclass ExuInput(isVpu: Boolean = false)(implicit p: Parameters) extends XSBundleWithMicroOp {
326*40a70bd6SZhangZifei  val dataWidth = if (isVpu) VLEN else XLEN
327*40a70bd6SZhangZifei
328*40a70bd6SZhangZifei  val src = Vec(3, UInt(dataWidth.W))
3295844fcf0SLinJiawei}
3305844fcf0SLinJiawei
331*40a70bd6SZhangZifeiclass ExuOutput(isVpu: Boolean = false)(implicit p: Parameters) extends XSBundleWithMicroOp {
332*40a70bd6SZhangZifei  val dataWidth = if (isVpu) VLEN else XLEN
333*40a70bd6SZhangZifei
334*40a70bd6SZhangZifei  val data = UInt(dataWidth.W)
3357f1506e3SLinJiawei  val fflags = UInt(5.W)
33697cfa7f8SLinJiawei  val redirectValid = Bool()
33797cfa7f8SLinJiawei  val redirect = new Redirect
338e402d94eSWilliam Wang  val debug = new DebugBundle
3395844fcf0SLinJiawei}
3405844fcf0SLinJiawei
3412225d46eSJiawei Linclass ExternalInterruptIO(implicit p: Parameters) extends XSBundle {
34235bfeecbSYinan Xu  val mtip = Input(Bool())
34335bfeecbSYinan Xu  val msip = Input(Bool())
34435bfeecbSYinan Xu  val meip = Input(Bool())
345b3d79b37SYinan Xu  val seip = Input(Bool())
346d4aca96cSlqre  val debug = Input(Bool())
3475844fcf0SLinJiawei}
3485844fcf0SLinJiawei
3492225d46eSJiawei Linclass CSRSpecialIO(implicit p: Parameters) extends XSBundle {
35035bfeecbSYinan Xu  val exception = Flipped(ValidIO(new MicroOp))
3513fa7b737SYinan Xu  val isInterrupt = Input(Bool())
35235bfeecbSYinan Xu  val memExceptionVAddr = Input(UInt(VAddrBits.W))
35335bfeecbSYinan Xu  val trapTarget = Output(UInt(VAddrBits.W))
35435bfeecbSYinan Xu  val externalInterrupt = new ExternalInterruptIO
35535bfeecbSYinan Xu  val interrupt = Output(Bool())
35635bfeecbSYinan Xu}
35735bfeecbSYinan Xu
35846f74b57SHaojin Tangclass ExceptionInfo(implicit p: Parameters) extends XSBundleWithMicroOp {
3593a474d38SYinan Xu  val isInterrupt = Bool()
3603a474d38SYinan Xu}
3613a474d38SYinan Xu
3629aca92b9SYinan Xuclass RobCommitInfo(implicit p: Parameters) extends XSBundle {
363a7a8a6ccSHaojin Tang  val ldest = UInt(6.W)
364fe6452fcSYinan Xu  val rfWen = Bool()
365fe6452fcSYinan Xu  val fpWen = Bool()
366deb6421eSHaojin Tang  val vecWen = Bool()
367a1fd7de4SLinJiawei  val wflags = Bool()
368fe6452fcSYinan Xu  val commitType = CommitType()
369fe6452fcSYinan Xu  val pdest = UInt(PhyRegIdxWidth.W)
370fe6452fcSYinan Xu  val old_pdest = UInt(PhyRegIdxWidth.W)
371884dbb3bSLinJiawei  val ftqIdx = new FtqPtr
372884dbb3bSLinJiawei  val ftqOffset = UInt(log2Up(PredictWidth).W)
373ccfddc82SHaojin Tang  val isMove = Bool()
3745844fcf0SLinJiawei
3759ecac1e8SYinan Xu  // these should be optimized for synthesis verilog
3769ecac1e8SYinan Xu  val pc = UInt(VAddrBits.W)
377fe6452fcSYinan Xu}
3785844fcf0SLinJiawei
3799aca92b9SYinan Xuclass RobCommitIO(implicit p: Parameters) extends XSBundle {
380ccfddc82SHaojin Tang  val isCommit = Bool()
381ccfddc82SHaojin Tang  val commitValid = Vec(CommitWidth, Bool())
3826474c47fSYinan Xu
383ccfddc82SHaojin Tang  val isWalk = Bool()
384c51eab43SYinan Xu  // valid bits optimized for walk
385ccfddc82SHaojin Tang  val walkValid = Vec(CommitWidth, Bool())
3866474c47fSYinan Xu
387ccfddc82SHaojin Tang  val info = Vec(CommitWidth, new RobCommitInfo)
38821e7a6c5SYinan Xu
3896474c47fSYinan Xu  def hasWalkInstr: Bool = isWalk && walkValid.asUInt.orR
3906474c47fSYinan Xu  def hasCommitInstr: Bool = isCommit && commitValid.asUInt.orR
3915844fcf0SLinJiawei}
3925844fcf0SLinJiawei
3931b7adedcSWilliam Wangclass RSFeedback(implicit p: Parameters) extends XSBundle {
39464e8d8bdSZhangZifei  val rsIdx = UInt(log2Up(IssQueSize).W)
395037a131fSWilliam Wang  val hit = Bool()
39662f57a35SLemover  val flushState = Bool()
3971b7adedcSWilliam Wang  val sourceType = RSFeedbackType()
398c7160cd3SWilliam Wang  val dataInvalidSqIdx = new SqPtr
399037a131fSWilliam Wang}
400037a131fSWilliam Wang
401d87b76aaSWilliam Wangclass MemRSFeedbackIO(implicit p: Parameters) extends XSBundle {
402d87b76aaSWilliam Wang  // Note: you need to update in implicit Parameters p before imp MemRSFeedbackIO
403d87b76aaSWilliam Wang  // for instance: MemRSFeedbackIO()(updateP)
404d87b76aaSWilliam Wang  val feedbackSlow = ValidIO(new RSFeedback()) // dcache miss queue full, dtlb miss
405d87b76aaSWilliam Wang  val feedbackFast = ValidIO(new RSFeedback()) // bank conflict
406d87b76aaSWilliam Wang  val rsIdx = Input(UInt(log2Up(IssQueSize).W))
407d87b76aaSWilliam Wang  val isFirstIssue = Input(Bool())
408d87b76aaSWilliam Wang}
409d87b76aaSWilliam Wang
410f06ca0bfSLingrui98class FrontendToCtrlIO(implicit p: Parameters) extends XSBundle {
4115844fcf0SLinJiawei  // to backend end
4125844fcf0SLinJiawei  val cfVec = Vec(DecodeWidth, DecoupledIO(new CtrlFlow))
413f06ca0bfSLingrui98  val fromFtq = new FtqToCtrlIO
4145844fcf0SLinJiawei  // from backend
415f06ca0bfSLingrui98  val toFtq = Flipped(new CtrlToFtqIO)
4161e3fad10SLinJiawei}
417fcff7e94SZhangZifei
418f1fe8698SLemoverclass SatpStruct(implicit p: Parameters) extends XSBundle {
41945f497a4Shappy-lx  val mode = UInt(4.W)
42045f497a4Shappy-lx  val asid = UInt(16.W)
42145f497a4Shappy-lx  val ppn  = UInt(44.W)
42245f497a4Shappy-lx}
42345f497a4Shappy-lx
424f1fe8698SLemoverclass TlbSatpBundle(implicit p: Parameters) extends SatpStruct {
42545f497a4Shappy-lx  val changed = Bool()
42645f497a4Shappy-lx
42745f497a4Shappy-lx  def apply(satp_value: UInt): Unit = {
42845f497a4Shappy-lx    require(satp_value.getWidth == XLEN)
42945f497a4Shappy-lx    val sa = satp_value.asTypeOf(new SatpStruct)
43045f497a4Shappy-lx    mode := sa.mode
43145f497a4Shappy-lx    asid := sa.asid
432f1fe8698SLemover    ppn := Cat(0.U(44-PAddrBits), sa.ppn(PAddrBits-1, 0)).asUInt()
43345f497a4Shappy-lx    changed := DataChanged(sa.asid) // when ppn is changed, software need do the flush
43445f497a4Shappy-lx  }
435fcff7e94SZhangZifei}
436f1fe8698SLemover
437f1fe8698SLemoverclass TlbCsrBundle(implicit p: Parameters) extends XSBundle {
438f1fe8698SLemover  val satp = new TlbSatpBundle()
439fcff7e94SZhangZifei  val priv = new Bundle {
440fcff7e94SZhangZifei    val mxr = Bool()
441fcff7e94SZhangZifei    val sum = Bool()
442fcff7e94SZhangZifei    val imode = UInt(2.W)
443fcff7e94SZhangZifei    val dmode = UInt(2.W)
444fcff7e94SZhangZifei  }
4458fc4e859SZhangZifei
4468fc4e859SZhangZifei  override def toPrintable: Printable = {
4478fc4e859SZhangZifei    p"Satp mode:0x${Hexadecimal(satp.mode)} asid:0x${Hexadecimal(satp.asid)} ppn:0x${Hexadecimal(satp.ppn)} " +
4488fc4e859SZhangZifei      p"Priv mxr:${priv.mxr} sum:${priv.sum} imode:${priv.imode} dmode:${priv.dmode}"
4498fc4e859SZhangZifei  }
450fcff7e94SZhangZifei}
451fcff7e94SZhangZifei
4522225d46eSJiawei Linclass SfenceBundle(implicit p: Parameters) extends XSBundle {
453fcff7e94SZhangZifei  val valid = Bool()
454fcff7e94SZhangZifei  val bits = new Bundle {
455fcff7e94SZhangZifei    val rs1 = Bool()
456fcff7e94SZhangZifei    val rs2 = Bool()
457fcff7e94SZhangZifei    val addr = UInt(VAddrBits.W)
45845f497a4Shappy-lx    val asid = UInt(AsidLength.W)
459f1fe8698SLemover    val flushPipe = Bool()
460fcff7e94SZhangZifei  }
4618fc4e859SZhangZifei
4628fc4e859SZhangZifei  override def toPrintable: Printable = {
463f1fe8698SLemover    p"valid:0x${Hexadecimal(valid)} rs1:${bits.rs1} rs2:${bits.rs2} addr:${Hexadecimal(bits.addr)}, flushPipe:${bits.flushPipe}"
4648fc4e859SZhangZifei  }
465fcff7e94SZhangZifei}
466a165bd69Swangkaifan
467de169c67SWilliam Wang// Bundle for load violation predictor updating
468de169c67SWilliam Wangclass MemPredUpdateReq(implicit p: Parameters) extends XSBundle  {
4692b8b2e7aSWilliam Wang  val valid = Bool()
470de169c67SWilliam Wang
471de169c67SWilliam Wang  // wait table update
472de169c67SWilliam Wang  val waddr = UInt(MemPredPCWidth.W)
4732b8b2e7aSWilliam Wang  val wdata = Bool() // true.B by default
474de169c67SWilliam Wang
475de169c67SWilliam Wang  // store set update
476de169c67SWilliam Wang  // by default, ldpc/stpc should be xor folded
477de169c67SWilliam Wang  val ldpc = UInt(MemPredPCWidth.W)
478de169c67SWilliam Wang  val stpc = UInt(MemPredPCWidth.W)
4792b8b2e7aSWilliam Wang}
4802b8b2e7aSWilliam Wang
4812225d46eSJiawei Linclass CustomCSRCtrlIO(implicit p: Parameters) extends XSBundle {
4822b8b2e7aSWilliam Wang  // Prefetcher
483ecccf78fSJay  val l1I_pf_enable = Output(Bool())
4842b8b2e7aSWilliam Wang  val l2_pf_enable = Output(Bool())
485ecccf78fSJay  // ICache
486ecccf78fSJay  val icache_parity_enable = Output(Bool())
487f3f22d72SYinan Xu  // Labeled XiangShan
4882b8b2e7aSWilliam Wang  val dsid = Output(UInt(8.W)) // TODO: DsidWidth as parameter
489f3f22d72SYinan Xu  // Load violation predictor
4902b8b2e7aSWilliam Wang  val lvpred_disable = Output(Bool())
4912b8b2e7aSWilliam Wang  val no_spec_load = Output(Bool())
492c7160cd3SWilliam Wang  val storeset_wait_store = Output(Bool())
493c7160cd3SWilliam Wang  val storeset_no_fast_wakeup = Output(Bool())
494c7160cd3SWilliam Wang  val lvpred_timeout = Output(UInt(5.W))
495f3f22d72SYinan Xu  // Branch predictor
4962b8b2e7aSWilliam Wang  val bp_ctrl = Output(new BPUCtrl)
497f3f22d72SYinan Xu  // Memory Block
498f3f22d72SYinan Xu  val sbuffer_threshold = Output(UInt(4.W))
499d10a581eSWilliam Wang  val ldld_vio_check_enable = Output(Bool())
500d10a581eSWilliam Wang  val soft_prefetch_enable = Output(Bool())
501a4e57ea3SLi Qianruo  val cache_error_enable = Output(Bool())
50237225120Ssfencevma  val uncache_write_outstanding_enable = Output(Bool())
503aac4464eSYinan Xu  // Rename
5045b47c58cSYinan Xu  val fusion_enable = Output(Bool())
5055b47c58cSYinan Xu  val wfi_enable = Output(Bool())
506af2f7849Shappy-lx  // Decode
507af2f7849Shappy-lx  val svinval_enable = Output(Bool())
508af2f7849Shappy-lx
509b6982e83SLemover  // distribute csr write signal
510b6982e83SLemover  val distribute_csr = new DistributedCSRIO()
51172951335SLi Qianruo
512ddb65c47SLi Qianruo  val singlestep = Output(Bool())
51372951335SLi Qianruo  val frontend_trigger = new FrontendTdataDistributeIO()
51472951335SLi Qianruo  val mem_trigger = new MemTdataDistributeIO()
51572951335SLi Qianruo  val trigger_enable = Output(Vec(10, Bool()))
516b6982e83SLemover}
517b6982e83SLemover
518b6982e83SLemoverclass DistributedCSRIO(implicit p: Parameters) extends XSBundle {
5191c746d3aScui fliter  // CSR has been written by csr inst, copies of csr should be updated
520b6982e83SLemover  val w = ValidIO(new Bundle {
521b6982e83SLemover    val addr = Output(UInt(12.W))
522b6982e83SLemover    val data = Output(UInt(XLEN.W))
523b6982e83SLemover  })
5242b8b2e7aSWilliam Wang}
525e19f7967SWilliam Wang
526e19f7967SWilliam Wangclass DistributedCSRUpdateReq(implicit p: Parameters) extends XSBundle {
527e19f7967SWilliam Wang  // Request csr to be updated
528e19f7967SWilliam Wang  //
529e19f7967SWilliam Wang  // Note that this request will ONLY update CSR Module it self,
530e19f7967SWilliam Wang  // copies of csr will NOT be updated, use it with care!
531e19f7967SWilliam Wang  //
532e19f7967SWilliam Wang  // For each cycle, no more than 1 DistributedCSRUpdateReq is valid
533e19f7967SWilliam Wang  val w = ValidIO(new Bundle {
534e19f7967SWilliam Wang    val addr = Output(UInt(12.W))
535e19f7967SWilliam Wang    val data = Output(UInt(XLEN.W))
536e19f7967SWilliam Wang  })
537e19f7967SWilliam Wang  def apply(valid: Bool, addr: UInt, data: UInt, src_description: String) = {
538e19f7967SWilliam Wang    when(valid){
539e19f7967SWilliam Wang      w.bits.addr := addr
540e19f7967SWilliam Wang      w.bits.data := data
541e19f7967SWilliam Wang    }
542e19f7967SWilliam Wang    println("Distributed CSR update req registered for " + src_description)
543e19f7967SWilliam Wang  }
544e19f7967SWilliam Wang}
54572951335SLi Qianruo
5460f59c834SWilliam Wangclass L1CacheErrorInfo(implicit p: Parameters) extends XSBundle {
5470f59c834SWilliam Wang  // L1CacheErrorInfo is also used to encode customized CACHE_ERROR CSR
5480f59c834SWilliam Wang  val source = Output(new Bundle() {
5490f59c834SWilliam Wang    val tag = Bool() // l1 tag array
5500f59c834SWilliam Wang    val data = Bool() // l1 data array
5510f59c834SWilliam Wang    val l2 = Bool()
5520f59c834SWilliam Wang  })
5530f59c834SWilliam Wang  val opType = Output(new Bundle() {
5540f59c834SWilliam Wang    val fetch = Bool()
5550f59c834SWilliam Wang    val load = Bool()
5560f59c834SWilliam Wang    val store = Bool()
5570f59c834SWilliam Wang    val probe = Bool()
5580f59c834SWilliam Wang    val release = Bool()
5590f59c834SWilliam Wang    val atom = Bool()
5600f59c834SWilliam Wang  })
5610f59c834SWilliam Wang  val paddr = Output(UInt(PAddrBits.W))
5620f59c834SWilliam Wang
5630f59c834SWilliam Wang  // report error and paddr to beu
5640f59c834SWilliam Wang  // bus error unit will receive error info iff ecc_error.valid
5650f59c834SWilliam Wang  val report_to_beu = Output(Bool())
5660f59c834SWilliam Wang
5670f59c834SWilliam Wang  // there is an valid error
5680f59c834SWilliam Wang  // l1 cache error will always be report to CACHE_ERROR csr
5690f59c834SWilliam Wang  val valid = Output(Bool())
5700f59c834SWilliam Wang
5710f59c834SWilliam Wang  def toL1BusErrorUnitInfo(): L1BusErrorUnitInfo = {
5720f59c834SWilliam Wang    val beu_info = Wire(new L1BusErrorUnitInfo)
5730f59c834SWilliam Wang    beu_info.ecc_error.valid := report_to_beu
5740f59c834SWilliam Wang    beu_info.ecc_error.bits := paddr
5750f59c834SWilliam Wang    beu_info
5760f59c834SWilliam Wang  }
5770f59c834SWilliam Wang}
578bc63e578SLi Qianruo
579bc63e578SLi Qianruo/* TODO how to trigger on next inst?
580bc63e578SLi Qianruo1. If hit is determined at frontend, then set a "next instr" trap at dispatch like singlestep
581bc63e578SLi 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
582bc63e578SLi Qianruoxret csr to pc + 4/ + 2
583bc63e578SLi Qianruo2.5 The problem is to let it commit. This is the real TODO
584bc63e578SLi Qianruo3. If it is load and hit before just treat it as regular load exception
585bc63e578SLi Qianruo */
586bc63e578SLi Qianruo
587bc63e578SLi Qianruo// This bundle carries trigger hit info along the pipeline
588bc63e578SLi Qianruo// Now there are 10 triggers divided into 5 groups of 2
589bc63e578SLi Qianruo// These groups are
590bc63e578SLi Qianruo// (if if) (store store) (load loid) (if store) (if load)
591bc63e578SLi Qianruo
592bc63e578SLi Qianruo// Triggers in the same group can chain, meaning that they only
593bc63e578SLi Qianruo// fire is both triggers in the group matches (the triggerHitVec bit is asserted)
594bc63e578SLi Qianruo// Chaining of trigger No. (2i) and (2i+1) is indicated by triggerChainVec(i)
595bc63e578SLi Qianruo// Timing of 0 means trap at current inst, 1 means trap at next inst
596bc63e578SLi Qianruo// Chaining and timing and the validness of a trigger is controlled by csr
597bc63e578SLi Qianruo// In two chained triggers, if they have different timing, both won't fire
59884e47f35SLi Qianruo//class TriggerCf (implicit p: Parameters) extends XSBundle {
59984e47f35SLi Qianruo//  val triggerHitVec = Vec(10, Bool())
60084e47f35SLi Qianruo//  val triggerTiming = Vec(10, Bool())
60184e47f35SLi Qianruo//  val triggerChainVec = Vec(5, Bool())
60284e47f35SLi Qianruo//}
60384e47f35SLi Qianruo
60472951335SLi Qianruoclass TriggerCf(implicit p: Parameters) extends XSBundle {
60584e47f35SLi Qianruo  // frontend
60684e47f35SLi Qianruo  val frontendHit = Vec(4, Bool())
607ddb65c47SLi Qianruo//  val frontendTiming = Vec(4, Bool())
608ddb65c47SLi Qianruo//  val frontendHitNext = Vec(4, Bool())
60984e47f35SLi Qianruo
610ddb65c47SLi Qianruo//  val frontendException = Bool()
61184e47f35SLi Qianruo  // backend
61284e47f35SLi Qianruo  val backendEn = Vec(2, Bool()) // Hit(6) && chain(4) , Hit(8) && chain(4)
61384e47f35SLi Qianruo  val backendHit = Vec(6, Bool())
614ddb65c47SLi Qianruo//  val backendTiming = Vec(6, Bool()) // trigger enable fro chain
61584e47f35SLi Qianruo
61684e47f35SLi Qianruo  // Two situations not allowed:
61784e47f35SLi Qianruo  // 1. load data comparison
61884e47f35SLi Qianruo  // 2. store chaining with store
61984e47f35SLi Qianruo  def getHitFrontend = frontendHit.reduce(_ || _)
62084e47f35SLi Qianruo  def getHitBackend = backendHit.reduce(_ || _)
621ddb65c47SLi Qianruo  def hit = getHitFrontend || getHitBackend
622d7dd1af1SLi Qianruo  def clear(): Unit = {
623d7dd1af1SLi Qianruo    frontendHit.foreach(_ := false.B)
624d7dd1af1SLi Qianruo    backendEn.foreach(_ := false.B)
625d7dd1af1SLi Qianruo    backendHit.foreach(_ := false.B)
626d7dd1af1SLi Qianruo  }
62772951335SLi Qianruo}
62872951335SLi Qianruo
629bc63e578SLi Qianruo// these 3 bundles help distribute trigger control signals from CSR
630bc63e578SLi Qianruo// to Frontend, Load and Store.
63172951335SLi Qianruoclass FrontendTdataDistributeIO(implicit p: Parameters)  extends XSBundle {
63272951335SLi Qianruo    val t = Valid(new Bundle {
63372951335SLi Qianruo      val addr = Output(UInt(2.W))
63472951335SLi Qianruo      val tdata = new MatchTriggerIO
63572951335SLi Qianruo    })
63672951335SLi Qianruo  }
63772951335SLi Qianruo
63872951335SLi Qianruoclass MemTdataDistributeIO(implicit p: Parameters)  extends XSBundle {
63972951335SLi Qianruo  val t = Valid(new Bundle {
64072951335SLi Qianruo    val addr = Output(UInt(3.W))
64172951335SLi Qianruo    val tdata = new MatchTriggerIO
64272951335SLi Qianruo  })
64372951335SLi Qianruo}
64472951335SLi Qianruo
64572951335SLi Qianruoclass MatchTriggerIO(implicit p: Parameters) extends XSBundle {
64672951335SLi Qianruo  val matchType = Output(UInt(2.W))
64772951335SLi Qianruo  val select = Output(Bool())
64872951335SLi Qianruo  val timing = Output(Bool())
64972951335SLi Qianruo  val action = Output(Bool())
65072951335SLi Qianruo  val chain = Output(Bool())
65172951335SLi Qianruo  val tdata2 = Output(UInt(64.W))
65272951335SLi Qianruo}
653