xref: /XiangShan/src/main/scala/xiangshan/Bundle.scala (revision 3b739f49c5a26805be859c7231717ecc38aade30)
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
19*3b739f49SXuan Huimport chipsalliance.rocketchip.config.Parameters
201e3fad10SLinJiaweiimport chisel3._
21*3b739f49SXuan Huimport chisel3.util.BitPat.bitPatToUInt
225844fcf0SLinJiaweiimport chisel3.util._
23*3b739f49SXuan Huimport utility._
24*3b739f49SXuan Huimport utils._
25f06ca0bfSLingrui98import xiangshan.backend.CtrlToFtqIO
26de169c67SWilliam Wangimport xiangshan.backend.decode.{ImmUnion, XDecode}
27*3b739f49SXuan Huimport xiangshan.backend.rob.RobPtr
28*3b739f49SXuan Huimport xiangshan.frontend._
295c1ae31bSYinan Xuimport xiangshan.mem.{LqPtr, SqPtr}
30*3b739f49SXuan Huimport xiangshan.v2backend.Bundles.DynInst
31*3b739f49SXuan Huimport xiangshan.v2backend.FuType
321e3fad10SLinJiawei
33627c0a19Szhanglinjuanclass ValidUndirectioned[T <: Data](gen: T) extends Bundle {
343803411bSzhanglinjuan  val valid = Bool()
3535fe60e8SLingrui98  val bits = gen.cloneType.asInstanceOf[T]
36fe211d16SLinJiawei
373803411bSzhanglinjuan}
383803411bSzhanglinjuan
39627c0a19Szhanglinjuanobject ValidUndirectioned {
40627c0a19Szhanglinjuan  def apply[T <: Data](gen: T) = {
41627c0a19Szhanglinjuan    new ValidUndirectioned[T](gen)
423803411bSzhanglinjuan  }
433803411bSzhanglinjuan}
443803411bSzhanglinjuan
451b7adedcSWilliam Wangobject RSFeedbackType {
4667682d05SWilliam Wang  val tlbMiss = 0.U(3.W)
4767682d05SWilliam Wang  val mshrFull = 1.U(3.W)
4867682d05SWilliam Wang  val dataInvalid = 2.U(3.W)
4967682d05SWilliam Wang  val bankConflict = 3.U(3.W)
5067682d05SWilliam Wang  val ldVioCheckRedo = 4.U(3.W)
511b7adedcSWilliam Wang
52eb163ef0SHaojin Tang  val feedbackInvalid = 7.U(3.W)
53eb163ef0SHaojin Tang
5467682d05SWilliam Wang  def apply() = UInt(3.W)
551b7adedcSWilliam Wang}
561b7adedcSWilliam Wang
572225d46eSJiawei Linclass PredictorAnswer(implicit p: Parameters) extends XSBundle {
58097c2688SLingrui98  val hit    = if (!env.FPGAPlatform) Bool() else UInt(0.W)
59097c2688SLingrui98  val taken  = if (!env.FPGAPlatform) Bool() else UInt(0.W)
60097c2688SLingrui98  val target = if (!env.FPGAPlatform) UInt(VAddrBits.W) else UInt(0.W)
6151b2a476Szoujr}
6251b2a476Szoujr
632225d46eSJiawei Linclass CfiUpdateInfo(implicit p: Parameters) extends XSBundle with HasBPUParameter {
64f226232fSzhanglinjuan  // from backend
6569cafcc9SLingrui98  val pc = UInt(VAddrBits.W)
66f226232fSzhanglinjuan  // frontend -> backend -> frontend
67f226232fSzhanglinjuan  val pd = new PreDecodeInfo
688a5e9243SLinJiawei  val rasSp = UInt(log2Up(RasSize).W)
692e947747SLinJiawei  val rasEntry = new RASEntry
70c2ad24ebSLingrui98  // val hist = new ShiftingGlobalHistory
71dd6c0695SLingrui98  val folded_hist = new AllFoldedHistories(foldedGHistInfos)
7267402d75SLingrui98  val afhob = new AllAheadFoldedHistoryOldestBits(foldedGHistInfos)
7367402d75SLingrui98  val lastBrNumOH = UInt((numBr+1).W)
74b37e4b45SLingrui98  val ghr = UInt(UbtbGHRLength.W)
75c2ad24ebSLingrui98  val histPtr = new CGHPtr
76e7b046c5Szoujr  val specCnt = Vec(numBr, UInt(10.W))
77fe3a74fcSYinan Xu  // need pipeline update
788a597714Szoujr  val br_hit = Bool()
792e947747SLinJiawei  val predTaken = Bool()
80b2e6921eSLinJiawei  val target = UInt(VAddrBits.W)
819a2e6b8aSLinJiawei  val taken = Bool()
82b2e6921eSLinJiawei  val isMisPred = Bool()
83d0527adfSzoujr  val shift = UInt((log2Ceil(numBr)+1).W)
84d0527adfSzoujr  val addIntoHist = Bool()
8514a6653fSLingrui98
8614a6653fSLingrui98  def fromFtqRedirectSram(entry: Ftq_Redirect_SRAMEntry) = {
87c2ad24ebSLingrui98    // this.hist := entry.ghist
88dd6c0695SLingrui98    this.folded_hist := entry.folded_hist
8967402d75SLingrui98    this.lastBrNumOH := entry.lastBrNumOH
9067402d75SLingrui98    this.afhob := entry.afhob
91c2ad24ebSLingrui98    this.histPtr := entry.histPtr
9214a6653fSLingrui98    this.rasSp := entry.rasSp
93c2d1ec7dSLingrui98    this.rasEntry := entry.rasTop
9414a6653fSLingrui98    this
9514a6653fSLingrui98  }
96b2e6921eSLinJiawei}
97b2e6921eSLinJiawei
985844fcf0SLinJiawei// Dequeue DecodeWidth insts from Ibuffer
99de169c67SWilliam Wangclass CtrlFlow(implicit p: Parameters) extends XSBundle {
1005844fcf0SLinJiawei  val instr = UInt(32.W)
1015844fcf0SLinJiawei  val pc = UInt(VAddrBits.W)
102de169c67SWilliam Wang  val foldpc = UInt(MemPredPCWidth.W)
103baf8def6SYinan Xu  val exceptionVec = ExceptionVec()
10472951335SLi Qianruo  val trigger = new TriggerCf
105faf3cfa9SLinJiawei  val pd = new PreDecodeInfo
106cde9280dSLinJiawei  val pred_taken = Bool()
107c84054caSLinJiawei  val crossPageIPFFix = Bool()
108de169c67SWilliam Wang  val storeSetHit = Bool() // inst has been allocated an store set
109980c1bc3SWilliam Wang  val waitForRobIdx = new RobPtr // store set predicted previous store robIdx
110d1fe0262SWilliam Wang  // Load wait is needed
111d1fe0262SWilliam Wang  // load inst will not be executed until former store (predicted by mdp) addr calcuated
112d1fe0262SWilliam Wang  val loadWaitBit = Bool()
113d1fe0262SWilliam Wang  // If (loadWaitBit && loadWaitStrict), strict load wait is needed
114d1fe0262SWilliam Wang  // load inst will not be executed until ALL former store addr calcuated
115d1fe0262SWilliam Wang  val loadWaitStrict = Bool()
116de169c67SWilliam Wang  val ssid = UInt(SSIDWidth.W)
117884dbb3bSLinJiawei  val ftqPtr = new FtqPtr
118884dbb3bSLinJiawei  val ftqOffset = UInt(log2Up(PredictWidth).W)
1195844fcf0SLinJiawei}
1205844fcf0SLinJiawei
12172951335SLi Qianruo
1222225d46eSJiawei Linclass FPUCtrlSignals(implicit p: Parameters) extends XSBundle {
1232ce29ed6SLinJiawei  val isAddSub = Bool() // swap23
124dc597826SJiawei Lin  val typeTagIn = UInt(1.W)
125dc597826SJiawei Lin  val typeTagOut = UInt(1.W)
1262ce29ed6SLinJiawei  val fromInt = Bool()
1272ce29ed6SLinJiawei  val wflags = Bool()
1282ce29ed6SLinJiawei  val fpWen = Bool()
1292ce29ed6SLinJiawei  val fmaCmd = UInt(2.W)
1302ce29ed6SLinJiawei  val div = Bool()
1312ce29ed6SLinJiawei  val sqrt = Bool()
1322ce29ed6SLinJiawei  val fcvt = Bool()
1332ce29ed6SLinJiawei  val typ = UInt(2.W)
1342ce29ed6SLinJiawei  val fmt = UInt(2.W)
1352ce29ed6SLinJiawei  val ren3 = Bool() //TODO: remove SrcType.fp
136e6c6b64fSLinJiawei  val rm = UInt(3.W)
137579b9f28SLinJiawei}
138579b9f28SLinJiawei
1395844fcf0SLinJiawei// Decode DecodeWidth insts at Decode Stage
1402225d46eSJiawei Linclass CtrlSignals(implicit p: Parameters) extends XSBundle {
141a7a8a6ccSHaojin Tang  val srcType = Vec(4, SrcType())
142a7a8a6ccSHaojin Tang  val lsrc = Vec(4, UInt(6.W))
143a7a8a6ccSHaojin Tang  val ldest = UInt(6.W)
1449a2e6b8aSLinJiawei  val fuType = FuType()
1459a2e6b8aSLinJiawei  val fuOpType = FuOpType()
1469a2e6b8aSLinJiawei  val rfWen = Bool()
1479a2e6b8aSLinJiawei  val fpWen = Bool()
148deb6421eSHaojin Tang  val vecWen = Bool()
1499a2e6b8aSLinJiawei  val isXSTrap = Bool()
1502d366136SLinJiawei  val noSpecExec = Bool() // wait forward
1512d366136SLinJiawei  val blockBackward = Bool() // block backward
15245a56a29SZhangZifei  val flushPipe = Bool() // This inst will flush all the pipe when commit, like exception but can commit
153c2a8ae00SYikeZhou  val selImm = SelImm()
154b0ae3ac4SLinJiawei  val imm = UInt(ImmUnion.maxLen.W)
155a3edac52SYinan Xu  val commitType = CommitType()
156579b9f28SLinJiawei  val fpu = new FPUCtrlSignals
1574aa9ed34Sfdy  val uopIdx = UInt(5.W)
1584aa9ed34Sfdy  val vconfig = UInt(16.W)
159aac4464eSYinan Xu  val isMove = Bool()
160d4aca96cSlqre  val singleStep = Bool()
161c88c3a2aSYinan Xu  // This inst will flush all the pipe when it is the oldest inst in ROB,
162c88c3a2aSYinan Xu  // then replay from this inst itself
163c88c3a2aSYinan Xu  val replayInst = Bool()
164be25371aSYikeZhou
16557a10886SXuan Hu  private def allSignals = srcType.take(3) ++ Seq(fuType, fuOpType, rfWen, fpWen, vecWen,
1666e7c9679Shuxuan0307    isXSTrap, noSpecExec, blockBackward, flushPipe, selImm)
16788825c5cSYinan Xu
16888825c5cSYinan Xu  def decode(inst: UInt, table: Iterable[(BitPat, List[BitPat])]): CtrlSignals = {
16957a10886SXuan Hu    val decoder: Seq[UInt] = ListLookup(
17057a10886SXuan Hu      inst, XDecode.decodeDefault.map(bitPatToUInt),
17157a10886SXuan Hu      table.map{ case (pat, pats) => (pat, pats.map(bitPatToUInt)) }.toArray
17257a10886SXuan Hu    )
17388825c5cSYinan Xu    allSignals zip decoder foreach { case (s, d) => s := d }
1744d24c305SYikeZhou    commitType := DontCare
175be25371aSYikeZhou    this
176be25371aSYikeZhou  }
17788825c5cSYinan Xu
17888825c5cSYinan Xu  def decode(bit: List[BitPat]): CtrlSignals = {
17988825c5cSYinan Xu    allSignals.zip(bit.map(bitPatToUInt(_))).foreach{ case (s, d) => s := d }
18088825c5cSYinan Xu    this
18188825c5cSYinan Xu  }
182b6900d94SYinan Xu
183*3b739f49SXuan Hu  def isWFI: Bool = fuType === FuType.csr.U && fuOpType === CSROpType.wfi
184f025d715SYinan Xu  def isSoftPrefetch: Bool = {
185*3b739f49SXuan Hu    fuType === FuType.alu.U && fuOpType === ALUOpType.or && selImm === SelImm.IMM_I && ldest === 0.U
186f025d715SYinan Xu  }
1875844fcf0SLinJiawei}
1885844fcf0SLinJiawei
1892225d46eSJiawei Linclass CfCtrl(implicit p: Parameters) extends XSBundle {
1905844fcf0SLinJiawei  val cf = new CtrlFlow
1915844fcf0SLinJiawei  val ctrl = new CtrlSignals
1925844fcf0SLinJiawei}
1935844fcf0SLinJiawei
1942225d46eSJiawei Linclass PerfDebugInfo(implicit p: Parameters) extends XSBundle {
1958b8e745dSYikeZhou  val eliminatedMove = Bool()
196ba4100caSYinan Xu  // val fetchTime = UInt(64.W)
197ebb8ebf8SYinan Xu  val renameTime = UInt(XLEN.W)
198ebb8ebf8SYinan Xu  val dispatchTime = UInt(XLEN.W)
199ebb8ebf8SYinan Xu  val enqRsTime = UInt(XLEN.W)
200ebb8ebf8SYinan Xu  val selectTime = UInt(XLEN.W)
201ebb8ebf8SYinan Xu  val issueTime = UInt(XLEN.W)
202ebb8ebf8SYinan Xu  val writebackTime = UInt(XLEN.W)
2037cef916fSYinan Xu  // val commitTime = UInt(64.W)
20420edb3f7SWilliam Wang  val runahead_checkpoint_id = UInt(64.W)
205ba4100caSYinan Xu}
206ba4100caSYinan Xu
20748d1472eSWilliam Wang// Separate LSQ
2082225d46eSJiawei Linclass LSIdx(implicit p: Parameters) extends XSBundle {
209915c0dd4SYinan Xu  val lqIdx = new LqPtr
2105c1ae31bSYinan Xu  val sqIdx = new SqPtr
21124726fbfSWilliam Wang}
21224726fbfSWilliam Wang
213b2e6921eSLinJiawei// CfCtrl -> MicroOp at Rename Stage
2142225d46eSJiawei Linclass MicroOp(implicit p: Parameters) extends CfCtrl {
215a7a8a6ccSHaojin Tang  val srcState = Vec(4, SrcState())
216a7a8a6ccSHaojin Tang  val psrc = Vec(4, UInt(PhyRegIdxWidth.W))
21720e31bd1SYinan Xu  val pdest = UInt(PhyRegIdxWidth.W)
21820e31bd1SYinan Xu  val old_pdest = UInt(PhyRegIdxWidth.W)
2199aca92b9SYinan Xu  val robIdx = new RobPtr
220fe6452fcSYinan Xu  val lqIdx = new LqPtr
221fe6452fcSYinan Xu  val sqIdx = new SqPtr
2228b8e745dSYikeZhou  val eliminatedMove = Bool()
2237cef916fSYinan Xu  val debugInfo = new PerfDebugInfo
2249d4e1137SYinan Xu  def needRfRPort(index: Int, isFp: Boolean, ignoreState: Boolean = true) : Bool = {
225bcce877bSYinan Xu    val stateReady = srcState(index) === SrcState.rdy || ignoreState.B
226bcce877bSYinan Xu    val readReg = if (isFp) {
227bcce877bSYinan Xu      ctrl.srcType(index) === SrcType.fp
228bcce877bSYinan Xu    } else {
229bcce877bSYinan Xu      ctrl.srcType(index) === SrcType.reg && ctrl.lsrc(index) =/= 0.U
230a338f247SYinan Xu    }
231bcce877bSYinan Xu    readReg && stateReady
232a338f247SYinan Xu  }
2335c7674feSYinan Xu  def srcIsReady: Vec[Bool] = {
234c9ebdf90SYinan Xu    VecInit(ctrl.srcType.zip(srcState).map{ case (t, s) => SrcType.isPcOrImm(t) || s === SrcState.rdy })
2355c7674feSYinan Xu  }
2366ab6918fSYinan Xu  def clearExceptions(
2376ab6918fSYinan Xu    exceptionBits: Seq[Int] = Seq(),
2386ab6918fSYinan Xu    flushPipe: Boolean = false,
2396ab6918fSYinan Xu    replayInst: Boolean = false
2406ab6918fSYinan Xu  ): MicroOp = {
2416ab6918fSYinan Xu    cf.exceptionVec.zipWithIndex.filterNot(x => exceptionBits.contains(x._2)).foreach(_._1 := false.B)
2426ab6918fSYinan Xu    if (!flushPipe) { ctrl.flushPipe := false.B }
2436ab6918fSYinan Xu    if (!replayInst) { ctrl.replayInst := false.B }
244c88c3a2aSYinan Xu    this
245c88c3a2aSYinan Xu  }
246*3b739f49SXuan Hu//  // Assume only the LUI instruction is decoded with IMM_U in ALU.
247*3b739f49SXuan Hu//  def isLUI: Bool = ctrl.selImm === SelImm.IMM_U && ctrl.fuType === FuType.alu
248*3b739f49SXuan Hu//  // This MicroOp is used to wakeup another uop (the successor: (psrc, srcType).
249*3b739f49SXuan Hu//  def wakeup(successor: Seq[(UInt, UInt)], exuCfg: ExuConfig): Seq[(Bool, Bool)] = {
250*3b739f49SXuan Hu//    successor.map{ case (src, srcType) =>
251*3b739f49SXuan Hu//      val pdestMatch = pdest === src
252*3b739f49SXuan Hu//      // For state: no need to check whether src is x0/imm/pc because they are always ready.
253*3b739f49SXuan Hu//      val rfStateMatch = if (exuCfg.readIntRf) ctrl.rfWen else false.B
254*3b739f49SXuan Hu//      val fpMatch = if (exuCfg.readFpRf) ctrl.fpWen else false.B
255*3b739f49SXuan Hu//      val bothIntFp = exuCfg.readIntRf && exuCfg.readFpRf
256*3b739f49SXuan Hu//      val bothStateMatch = Mux(SrcType.isFp(srcType), fpMatch, rfStateMatch)
257*3b739f49SXuan Hu//      val stateCond = pdestMatch && (if (bothIntFp) bothStateMatch else rfStateMatch || fpMatch)
258*3b739f49SXuan Hu//      // For data: types are matched and int pdest is not $zero.
259*3b739f49SXuan Hu//      val rfDataMatch = if (exuCfg.readIntRf) ctrl.rfWen && src =/= 0.U else false.B
260*3b739f49SXuan Hu//      val dataCond = pdestMatch && (rfDataMatch && SrcType.isReg(srcType) || fpMatch && SrcType.isFp(srcType))
261*3b739f49SXuan Hu//      (stateCond, dataCond)
262*3b739f49SXuan Hu//    }
263*3b739f49SXuan Hu//  }
264*3b739f49SXuan Hu//  // This MicroOp is used to wakeup another uop (the successor: MicroOp).
265*3b739f49SXuan Hu//  def wakeup(successor: MicroOp, exuCfg: ExuConfig): Seq[(Bool, Bool)] = {
266*3b739f49SXuan Hu//    wakeup(successor.psrc.zip(successor.ctrl.srcType), exuCfg)
267*3b739f49SXuan Hu//  }
268*3b739f49SXuan Hu//  def isJump: Bool = FuType.isJumpExu(ctrl.fuType)
2695844fcf0SLinJiawei}
2705844fcf0SLinJiawei
271*3b739f49SXuan Hu//class XSBundleWithMicroOp(implicit p: Parameters) extends XSBundle {
272*3b739f49SXuan Hu//  val uop = new MicroOp
273*3b739f49SXuan Hu//}
27446f74b57SHaojin Tang
275*3b739f49SXuan Hu//class MicroOpRbExt(implicit p: Parameters) extends XSBundleWithMicroOp {
276*3b739f49SXuan Hu//  val flag = UInt(1.W)
277*3b739f49SXuan Hu//}
278de169c67SWilliam Wang
2792225d46eSJiawei Linclass Redirect(implicit p: Parameters) extends XSBundle {
2809aca92b9SYinan Xu  val robIdx = new RobPtr
28136d7aed5SLinJiawei  val ftqIdx = new FtqPtr
28236d7aed5SLinJiawei  val ftqOffset = UInt(log2Up(PredictWidth).W)
283bfb958a3SYinan Xu  val level = RedirectLevel()
284bfb958a3SYinan Xu  val interrupt = Bool()
285c778d2afSLinJiawei  val cfiUpdate = new CfiUpdateInfo
286bfb958a3SYinan Xu
287de169c67SWilliam Wang  val stFtqIdx = new FtqPtr // for load violation predict
288de169c67SWilliam Wang  val stFtqOffset = UInt(log2Up(PredictWidth).W)
289fe211d16SLinJiawei
29020edb3f7SWilliam Wang  val debug_runahead_checkpoint_id = UInt(64.W)
29120edb3f7SWilliam Wang
2922d7c7105SYinan Xu  // def isUnconditional() = RedirectLevel.isUnconditional(level)
293bfb958a3SYinan Xu  def flushItself() = RedirectLevel.flushItself(level)
2942d7c7105SYinan Xu  // def isException() = RedirectLevel.isException(level)
295a25b1bceSLinJiawei}
296a25b1bceSLinJiawei
2972b4e8253SYinan Xuclass ResetPregStateReq(implicit p: Parameters) extends XSBundle {
29860deaca2SLinJiawei  // NOTE: set isInt and isFp both to 'false' when invalid
29960deaca2SLinJiawei  val isInt = Bool()
30060deaca2SLinJiawei  val isFp = Bool()
30160deaca2SLinJiawei  val preg = UInt(PhyRegIdxWidth.W)
3025844fcf0SLinJiawei}
3035844fcf0SLinJiawei
3042225d46eSJiawei Linclass DebugBundle(implicit p: Parameters) extends XSBundle {
30572235fa4SWilliam Wang  val isMMIO = Bool()
3068635f18fSwangkaifan  val isPerfCnt = Bool()
3078b91a337SWilliam Wang  val paddr = UInt(PAddrBits.W)
30872951335SLi Qianruo  val vaddr = UInt(VAddrBits.W)
309e402d94eSWilliam Wang}
3105844fcf0SLinJiawei
311*3b739f49SXuan Hu//class ExuInput(isVpu: Boolean = false)(implicit p: Parameters) extends XSBundleWithMicroOp {
312*3b739f49SXuan Hu//  val dataWidth = if (isVpu) VLEN else XLEN
313*3b739f49SXuan Hu//
314*3b739f49SXuan Hu//  val src = Vec(3, UInt(dataWidth.W))
315*3b739f49SXuan Hu//}
31640a70bd6SZhangZifei
317*3b739f49SXuan Hu//class ExuOutput(isVpu: Boolean = false)(implicit p: Parameters) extends XSBundleWithMicroOp {
318*3b739f49SXuan Hu//  val dataWidth = if (isVpu) VLEN else XLEN
319*3b739f49SXuan Hu//
320*3b739f49SXuan Hu//  val data = UInt(dataWidth.W)
321*3b739f49SXuan Hu//  val fflags = UInt(5.W)
322*3b739f49SXuan Hu//  val redirectValid = Bool()
323*3b739f49SXuan Hu//  val redirect = new Redirect
324*3b739f49SXuan Hu//  val debug = new DebugBundle
325*3b739f49SXuan Hu//}
3265844fcf0SLinJiawei
3272225d46eSJiawei Linclass ExternalInterruptIO(implicit p: Parameters) extends XSBundle {
32835bfeecbSYinan Xu  val mtip = Input(Bool())
32935bfeecbSYinan Xu  val msip = Input(Bool())
33035bfeecbSYinan Xu  val meip = Input(Bool())
331b3d79b37SYinan Xu  val seip = Input(Bool())
332d4aca96cSlqre  val debug = Input(Bool())
3335844fcf0SLinJiawei}
3345844fcf0SLinJiawei
3352225d46eSJiawei Linclass CSRSpecialIO(implicit p: Parameters) extends XSBundle {
336*3b739f49SXuan Hu  val exception = Flipped(ValidIO(new DynInst))
3373fa7b737SYinan Xu  val isInterrupt = Input(Bool())
33835bfeecbSYinan Xu  val memExceptionVAddr = Input(UInt(VAddrBits.W))
33935bfeecbSYinan Xu  val trapTarget = Output(UInt(VAddrBits.W))
34035bfeecbSYinan Xu  val externalInterrupt = new ExternalInterruptIO
34135bfeecbSYinan Xu  val interrupt = Output(Bool())
34235bfeecbSYinan Xu}
34335bfeecbSYinan Xu
344*3b739f49SXuan Hu//class ExceptionInfo(implicit p: Parameters) extends XSBundleWithMicroOp {
345*3b739f49SXuan Hu//  val isInterrupt = Bool()
346*3b739f49SXuan Hu//}
3473a474d38SYinan Xu
3489aca92b9SYinan Xuclass RobCommitInfo(implicit p: Parameters) extends XSBundle {
349a7a8a6ccSHaojin Tang  val ldest = UInt(6.W)
350fe6452fcSYinan Xu  val rfWen = Bool()
351fe6452fcSYinan Xu  val fpWen = Bool()
352deb6421eSHaojin Tang  val vecWen = Bool()
353a1fd7de4SLinJiawei  val wflags = Bool()
354fe6452fcSYinan Xu  val commitType = CommitType()
355fe6452fcSYinan Xu  val pdest = UInt(PhyRegIdxWidth.W)
356fe6452fcSYinan Xu  val old_pdest = UInt(PhyRegIdxWidth.W)
357884dbb3bSLinJiawei  val ftqIdx = new FtqPtr
358884dbb3bSLinJiawei  val ftqOffset = UInt(log2Up(PredictWidth).W)
359ccfddc82SHaojin Tang  val isMove = Bool()
3605844fcf0SLinJiawei
3619ecac1e8SYinan Xu  // these should be optimized for synthesis verilog
3629ecac1e8SYinan Xu  val pc = UInt(VAddrBits.W)
3634aa9ed34Sfdy
3644aa9ed34Sfdy  val uopIdx = UInt(5.W)
365*3b739f49SXuan Hu//  val vconfig = UInt(16.W)
366fe6452fcSYinan Xu}
3675844fcf0SLinJiawei
3689aca92b9SYinan Xuclass RobCommitIO(implicit p: Parameters) extends XSBundle {
369ccfddc82SHaojin Tang  val isCommit = Bool()
370ccfddc82SHaojin Tang  val commitValid = Vec(CommitWidth, Bool())
3716474c47fSYinan Xu
372ccfddc82SHaojin Tang  val isWalk = Bool()
373c51eab43SYinan Xu  // valid bits optimized for walk
374ccfddc82SHaojin Tang  val walkValid = Vec(CommitWidth, Bool())
3756474c47fSYinan Xu
376ccfddc82SHaojin Tang  val info = Vec(CommitWidth, new RobCommitInfo)
37721e7a6c5SYinan Xu
3786474c47fSYinan Xu  def hasWalkInstr: Bool = isWalk && walkValid.asUInt.orR
3796474c47fSYinan Xu  def hasCommitInstr: Bool = isCommit && commitValid.asUInt.orR
3805844fcf0SLinJiawei}
3815844fcf0SLinJiawei
3821b7adedcSWilliam Wangclass RSFeedback(implicit p: Parameters) extends XSBundle {
38364e8d8bdSZhangZifei  val rsIdx = UInt(log2Up(IssQueSize).W)
384037a131fSWilliam Wang  val hit = Bool()
38562f57a35SLemover  val flushState = Bool()
3861b7adedcSWilliam Wang  val sourceType = RSFeedbackType()
387c7160cd3SWilliam Wang  val dataInvalidSqIdx = new SqPtr
388037a131fSWilliam Wang}
389037a131fSWilliam Wang
390d87b76aaSWilliam Wangclass MemRSFeedbackIO(implicit p: Parameters) extends XSBundle {
391d87b76aaSWilliam Wang  // Note: you need to update in implicit Parameters p before imp MemRSFeedbackIO
392d87b76aaSWilliam Wang  // for instance: MemRSFeedbackIO()(updateP)
393d87b76aaSWilliam Wang  val feedbackSlow = ValidIO(new RSFeedback()) // dcache miss queue full, dtlb miss
394d87b76aaSWilliam Wang  val feedbackFast = ValidIO(new RSFeedback()) // bank conflict
395d87b76aaSWilliam Wang  val rsIdx = Input(UInt(log2Up(IssQueSize).W))
396d87b76aaSWilliam Wang  val isFirstIssue = Input(Bool())
397d87b76aaSWilliam Wang}
398d87b76aaSWilliam Wang
399f06ca0bfSLingrui98class FrontendToCtrlIO(implicit p: Parameters) extends XSBundle {
4005844fcf0SLinJiawei  // to backend end
4015844fcf0SLinJiawei  val cfVec = Vec(DecodeWidth, DecoupledIO(new CtrlFlow))
402f06ca0bfSLingrui98  val fromFtq = new FtqToCtrlIO
4035844fcf0SLinJiawei  // from backend
404f06ca0bfSLingrui98  val toFtq = Flipped(new CtrlToFtqIO)
4051e3fad10SLinJiawei}
406fcff7e94SZhangZifei
407f1fe8698SLemoverclass SatpStruct(implicit p: Parameters) extends XSBundle {
40845f497a4Shappy-lx  val mode = UInt(4.W)
40945f497a4Shappy-lx  val asid = UInt(16.W)
41045f497a4Shappy-lx  val ppn  = UInt(44.W)
41145f497a4Shappy-lx}
41245f497a4Shappy-lx
413f1fe8698SLemoverclass TlbSatpBundle(implicit p: Parameters) extends SatpStruct {
41445f497a4Shappy-lx  val changed = Bool()
41545f497a4Shappy-lx
41645f497a4Shappy-lx  def apply(satp_value: UInt): Unit = {
41745f497a4Shappy-lx    require(satp_value.getWidth == XLEN)
41845f497a4Shappy-lx    val sa = satp_value.asTypeOf(new SatpStruct)
41945f497a4Shappy-lx    mode := sa.mode
42045f497a4Shappy-lx    asid := sa.asid
421f1fe8698SLemover    ppn := Cat(0.U(44-PAddrBits), sa.ppn(PAddrBits-1, 0)).asUInt()
42245f497a4Shappy-lx    changed := DataChanged(sa.asid) // when ppn is changed, software need do the flush
42345f497a4Shappy-lx  }
424fcff7e94SZhangZifei}
425f1fe8698SLemover
426f1fe8698SLemoverclass TlbCsrBundle(implicit p: Parameters) extends XSBundle {
427f1fe8698SLemover  val satp = new TlbSatpBundle()
428fcff7e94SZhangZifei  val priv = new Bundle {
429fcff7e94SZhangZifei    val mxr = Bool()
430fcff7e94SZhangZifei    val sum = Bool()
431fcff7e94SZhangZifei    val imode = UInt(2.W)
432fcff7e94SZhangZifei    val dmode = UInt(2.W)
433fcff7e94SZhangZifei  }
4348fc4e859SZhangZifei
4358fc4e859SZhangZifei  override def toPrintable: Printable = {
4368fc4e859SZhangZifei    p"Satp mode:0x${Hexadecimal(satp.mode)} asid:0x${Hexadecimal(satp.asid)} ppn:0x${Hexadecimal(satp.ppn)} " +
4378fc4e859SZhangZifei      p"Priv mxr:${priv.mxr} sum:${priv.sum} imode:${priv.imode} dmode:${priv.dmode}"
4388fc4e859SZhangZifei  }
439fcff7e94SZhangZifei}
440fcff7e94SZhangZifei
4412225d46eSJiawei Linclass SfenceBundle(implicit p: Parameters) extends XSBundle {
442fcff7e94SZhangZifei  val valid = Bool()
443fcff7e94SZhangZifei  val bits = new Bundle {
444fcff7e94SZhangZifei    val rs1 = Bool()
445fcff7e94SZhangZifei    val rs2 = Bool()
446fcff7e94SZhangZifei    val addr = UInt(VAddrBits.W)
44745f497a4Shappy-lx    val asid = UInt(AsidLength.W)
448f1fe8698SLemover    val flushPipe = Bool()
449fcff7e94SZhangZifei  }
4508fc4e859SZhangZifei
4518fc4e859SZhangZifei  override def toPrintable: Printable = {
452f1fe8698SLemover    p"valid:0x${Hexadecimal(valid)} rs1:${bits.rs1} rs2:${bits.rs2} addr:${Hexadecimal(bits.addr)}, flushPipe:${bits.flushPipe}"
4538fc4e859SZhangZifei  }
454fcff7e94SZhangZifei}
455a165bd69Swangkaifan
456de169c67SWilliam Wang// Bundle for load violation predictor updating
457de169c67SWilliam Wangclass MemPredUpdateReq(implicit p: Parameters) extends XSBundle  {
4582b8b2e7aSWilliam Wang  val valid = Bool()
459de169c67SWilliam Wang
460de169c67SWilliam Wang  // wait table update
461de169c67SWilliam Wang  val waddr = UInt(MemPredPCWidth.W)
4622b8b2e7aSWilliam Wang  val wdata = Bool() // true.B by default
463de169c67SWilliam Wang
464de169c67SWilliam Wang  // store set update
465de169c67SWilliam Wang  // by default, ldpc/stpc should be xor folded
466de169c67SWilliam Wang  val ldpc = UInt(MemPredPCWidth.W)
467de169c67SWilliam Wang  val stpc = UInt(MemPredPCWidth.W)
4682b8b2e7aSWilliam Wang}
4692b8b2e7aSWilliam Wang
4702225d46eSJiawei Linclass CustomCSRCtrlIO(implicit p: Parameters) extends XSBundle {
4712b8b2e7aSWilliam Wang  // Prefetcher
472ecccf78fSJay  val l1I_pf_enable = Output(Bool())
4732b8b2e7aSWilliam Wang  val l2_pf_enable = Output(Bool())
474ecccf78fSJay  // ICache
475ecccf78fSJay  val icache_parity_enable = Output(Bool())
476f3f22d72SYinan Xu  // Labeled XiangShan
4772b8b2e7aSWilliam Wang  val dsid = Output(UInt(8.W)) // TODO: DsidWidth as parameter
478f3f22d72SYinan Xu  // Load violation predictor
4792b8b2e7aSWilliam Wang  val lvpred_disable = Output(Bool())
4802b8b2e7aSWilliam Wang  val no_spec_load = Output(Bool())
481c7160cd3SWilliam Wang  val storeset_wait_store = Output(Bool())
482c7160cd3SWilliam Wang  val storeset_no_fast_wakeup = Output(Bool())
483c7160cd3SWilliam Wang  val lvpred_timeout = Output(UInt(5.W))
484f3f22d72SYinan Xu  // Branch predictor
4852b8b2e7aSWilliam Wang  val bp_ctrl = Output(new BPUCtrl)
486f3f22d72SYinan Xu  // Memory Block
487f3f22d72SYinan Xu  val sbuffer_threshold = Output(UInt(4.W))
488d10a581eSWilliam Wang  val ldld_vio_check_enable = Output(Bool())
489d10a581eSWilliam Wang  val soft_prefetch_enable = Output(Bool())
490a4e57ea3SLi Qianruo  val cache_error_enable = Output(Bool())
49137225120Ssfencevma  val uncache_write_outstanding_enable = Output(Bool())
492aac4464eSYinan Xu  // Rename
4935b47c58cSYinan Xu  val fusion_enable = Output(Bool())
4945b47c58cSYinan Xu  val wfi_enable = Output(Bool())
495af2f7849Shappy-lx  // Decode
496af2f7849Shappy-lx  val svinval_enable = Output(Bool())
497af2f7849Shappy-lx
498b6982e83SLemover  // distribute csr write signal
499b6982e83SLemover  val distribute_csr = new DistributedCSRIO()
50072951335SLi Qianruo
501ddb65c47SLi Qianruo  val singlestep = Output(Bool())
50272951335SLi Qianruo  val frontend_trigger = new FrontendTdataDistributeIO()
50372951335SLi Qianruo  val mem_trigger = new MemTdataDistributeIO()
50472951335SLi Qianruo  val trigger_enable = Output(Vec(10, Bool()))
505b6982e83SLemover}
506b6982e83SLemover
507b6982e83SLemoverclass DistributedCSRIO(implicit p: Parameters) extends XSBundle {
5081c746d3aScui fliter  // CSR has been written by csr inst, copies of csr should be updated
509b6982e83SLemover  val w = ValidIO(new Bundle {
510b6982e83SLemover    val addr = Output(UInt(12.W))
511b6982e83SLemover    val data = Output(UInt(XLEN.W))
512b6982e83SLemover  })
5132b8b2e7aSWilliam Wang}
514e19f7967SWilliam Wang
515e19f7967SWilliam Wangclass DistributedCSRUpdateReq(implicit p: Parameters) extends XSBundle {
516e19f7967SWilliam Wang  // Request csr to be updated
517e19f7967SWilliam Wang  //
518e19f7967SWilliam Wang  // Note that this request will ONLY update CSR Module it self,
519e19f7967SWilliam Wang  // copies of csr will NOT be updated, use it with care!
520e19f7967SWilliam Wang  //
521e19f7967SWilliam Wang  // For each cycle, no more than 1 DistributedCSRUpdateReq is valid
522e19f7967SWilliam Wang  val w = ValidIO(new Bundle {
523e19f7967SWilliam Wang    val addr = Output(UInt(12.W))
524e19f7967SWilliam Wang    val data = Output(UInt(XLEN.W))
525e19f7967SWilliam Wang  })
526e19f7967SWilliam Wang  def apply(valid: Bool, addr: UInt, data: UInt, src_description: String) = {
527e19f7967SWilliam Wang    when(valid){
528e19f7967SWilliam Wang      w.bits.addr := addr
529e19f7967SWilliam Wang      w.bits.data := data
530e19f7967SWilliam Wang    }
531e19f7967SWilliam Wang    println("Distributed CSR update req registered for " + src_description)
532e19f7967SWilliam Wang  }
533e19f7967SWilliam Wang}
53472951335SLi Qianruo
5350f59c834SWilliam Wangclass L1CacheErrorInfo(implicit p: Parameters) extends XSBundle {
5360f59c834SWilliam Wang  // L1CacheErrorInfo is also used to encode customized CACHE_ERROR CSR
5370f59c834SWilliam Wang  val source = Output(new Bundle() {
5380f59c834SWilliam Wang    val tag = Bool() // l1 tag array
5390f59c834SWilliam Wang    val data = Bool() // l1 data array
5400f59c834SWilliam Wang    val l2 = Bool()
5410f59c834SWilliam Wang  })
5420f59c834SWilliam Wang  val opType = Output(new Bundle() {
5430f59c834SWilliam Wang    val fetch = Bool()
5440f59c834SWilliam Wang    val load = Bool()
5450f59c834SWilliam Wang    val store = Bool()
5460f59c834SWilliam Wang    val probe = Bool()
5470f59c834SWilliam Wang    val release = Bool()
5480f59c834SWilliam Wang    val atom = Bool()
5490f59c834SWilliam Wang  })
5500f59c834SWilliam Wang  val paddr = Output(UInt(PAddrBits.W))
5510f59c834SWilliam Wang
5520f59c834SWilliam Wang  // report error and paddr to beu
5530f59c834SWilliam Wang  // bus error unit will receive error info iff ecc_error.valid
5540f59c834SWilliam Wang  val report_to_beu = Output(Bool())
5550f59c834SWilliam Wang
5560f59c834SWilliam Wang  // there is an valid error
5570f59c834SWilliam Wang  // l1 cache error will always be report to CACHE_ERROR csr
5580f59c834SWilliam Wang  val valid = Output(Bool())
5590f59c834SWilliam Wang
5600f59c834SWilliam Wang  def toL1BusErrorUnitInfo(): L1BusErrorUnitInfo = {
5610f59c834SWilliam Wang    val beu_info = Wire(new L1BusErrorUnitInfo)
5620f59c834SWilliam Wang    beu_info.ecc_error.valid := report_to_beu
5630f59c834SWilliam Wang    beu_info.ecc_error.bits := paddr
5640f59c834SWilliam Wang    beu_info
5650f59c834SWilliam Wang  }
5660f59c834SWilliam Wang}
567bc63e578SLi Qianruo
568bc63e578SLi Qianruo/* TODO how to trigger on next inst?
569bc63e578SLi Qianruo1. If hit is determined at frontend, then set a "next instr" trap at dispatch like singlestep
570bc63e578SLi 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
571bc63e578SLi Qianruoxret csr to pc + 4/ + 2
572bc63e578SLi Qianruo2.5 The problem is to let it commit. This is the real TODO
573bc63e578SLi Qianruo3. If it is load and hit before just treat it as regular load exception
574bc63e578SLi Qianruo */
575bc63e578SLi Qianruo
576bc63e578SLi Qianruo// This bundle carries trigger hit info along the pipeline
577bc63e578SLi Qianruo// Now there are 10 triggers divided into 5 groups of 2
578bc63e578SLi Qianruo// These groups are
579bc63e578SLi Qianruo// (if if) (store store) (load loid) (if store) (if load)
580bc63e578SLi Qianruo
581bc63e578SLi Qianruo// Triggers in the same group can chain, meaning that they only
582bc63e578SLi Qianruo// fire is both triggers in the group matches (the triggerHitVec bit is asserted)
583bc63e578SLi Qianruo// Chaining of trigger No. (2i) and (2i+1) is indicated by triggerChainVec(i)
584bc63e578SLi Qianruo// Timing of 0 means trap at current inst, 1 means trap at next inst
585bc63e578SLi Qianruo// Chaining and timing and the validness of a trigger is controlled by csr
586bc63e578SLi Qianruo// In two chained triggers, if they have different timing, both won't fire
58784e47f35SLi Qianruo//class TriggerCf (implicit p: Parameters) extends XSBundle {
58884e47f35SLi Qianruo//  val triggerHitVec = Vec(10, Bool())
58984e47f35SLi Qianruo//  val triggerTiming = Vec(10, Bool())
59084e47f35SLi Qianruo//  val triggerChainVec = Vec(5, Bool())
59184e47f35SLi Qianruo//}
59284e47f35SLi Qianruo
59372951335SLi Qianruoclass TriggerCf(implicit p: Parameters) extends XSBundle {
59484e47f35SLi Qianruo  // frontend
59584e47f35SLi Qianruo  val frontendHit = Vec(4, Bool())
596ddb65c47SLi Qianruo//  val frontendTiming = Vec(4, Bool())
597ddb65c47SLi Qianruo//  val frontendHitNext = Vec(4, Bool())
59884e47f35SLi Qianruo
599ddb65c47SLi Qianruo//  val frontendException = Bool()
60084e47f35SLi Qianruo  // backend
60184e47f35SLi Qianruo  val backendEn = Vec(2, Bool()) // Hit(6) && chain(4) , Hit(8) && chain(4)
60284e47f35SLi Qianruo  val backendHit = Vec(6, Bool())
603ddb65c47SLi Qianruo//  val backendTiming = Vec(6, Bool()) // trigger enable fro chain
60484e47f35SLi Qianruo
60584e47f35SLi Qianruo  // Two situations not allowed:
60684e47f35SLi Qianruo  // 1. load data comparison
60784e47f35SLi Qianruo  // 2. store chaining with store
60884e47f35SLi Qianruo  def getHitFrontend = frontendHit.reduce(_ || _)
60984e47f35SLi Qianruo  def getHitBackend = backendHit.reduce(_ || _)
610ddb65c47SLi Qianruo  def hit = getHitFrontend || getHitBackend
611d7dd1af1SLi Qianruo  def clear(): Unit = {
612d7dd1af1SLi Qianruo    frontendHit.foreach(_ := false.B)
613d7dd1af1SLi Qianruo    backendEn.foreach(_ := false.B)
614d7dd1af1SLi Qianruo    backendHit.foreach(_ := false.B)
615d7dd1af1SLi Qianruo  }
61672951335SLi Qianruo}
61772951335SLi Qianruo
618bc63e578SLi Qianruo// these 3 bundles help distribute trigger control signals from CSR
619bc63e578SLi Qianruo// to Frontend, Load and Store.
62072951335SLi Qianruoclass FrontendTdataDistributeIO(implicit p: Parameters)  extends XSBundle {
62172951335SLi Qianruo    val t = Valid(new Bundle {
62272951335SLi Qianruo      val addr = Output(UInt(2.W))
62372951335SLi Qianruo      val tdata = new MatchTriggerIO
62472951335SLi Qianruo    })
62572951335SLi Qianruo  }
62672951335SLi Qianruo
62772951335SLi Qianruoclass MemTdataDistributeIO(implicit p: Parameters)  extends XSBundle {
62872951335SLi Qianruo  val t = Valid(new Bundle {
62972951335SLi Qianruo    val addr = Output(UInt(3.W))
63072951335SLi Qianruo    val tdata = new MatchTriggerIO
63172951335SLi Qianruo  })
63272951335SLi Qianruo}
63372951335SLi Qianruo
63472951335SLi Qianruoclass MatchTriggerIO(implicit p: Parameters) extends XSBundle {
63572951335SLi Qianruo  val matchType = Output(UInt(2.W))
63672951335SLi Qianruo  val select = Output(Bool())
63772951335SLi Qianruo  val timing = Output(Bool())
63872951335SLi Qianruo  val action = Output(Bool())
63972951335SLi Qianruo  val chain = Output(Bool())
64072951335SLi Qianruo  val tdata2 = Output(UInt(64.W))
64172951335SLi Qianruo}
642