xref: /XiangShan/src/main/scala/xiangshan/Bundle.scala (revision 965c972ce9382a4eb4b7c69a52bbc0d09e351969)
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
193b739f49SXuan Huimport chipsalliance.rocketchip.config.Parameters
201e3fad10SLinJiaweiimport chisel3._
213b739f49SXuan Huimport chisel3.util.BitPat.bitPatToUInt
225844fcf0SLinJiaweiimport chisel3.util._
233b739f49SXuan Huimport utility._
243b739f49SXuan Huimport utils._
25f06ca0bfSLingrui98import xiangshan.backend.CtrlToFtqIO
26de169c67SWilliam Wangimport xiangshan.backend.decode.{ImmUnion, XDecode}
273b739f49SXuan Huimport xiangshan.backend.rob.RobPtr
283b739f49SXuan Huimport xiangshan.frontend._
295c1ae31bSYinan Xuimport xiangshan.mem.{LqPtr, SqPtr}
303b739f49SXuan Huimport xiangshan.v2backend.Bundles.DynInst
313b739f49SXuan 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)
51*965c972cSXuan Hu  val fuBusy = 5.U(3.W)
52141a6449SXuan Hu  val readRfSuccess = 6.U(3.W)
53eb163ef0SHaojin Tang  val feedbackInvalid = 7.U(3.W)
54eb163ef0SHaojin Tang
5567682d05SWilliam Wang  def apply() = UInt(3.W)
5661d88ec2SXuan Hu
5761d88ec2SXuan Hu  def isStageSuccess(feedbackType: UInt) = {
5861d88ec2SXuan Hu    feedbackType === readRfSuccess
5961d88ec2SXuan Hu  }
60*965c972cSXuan Hu
61*965c972cSXuan Hu  def isBlocked(feedbackType: UInt) = {
62*965c972cSXuan Hu    feedbackType === fuBusy
63*965c972cSXuan Hu  }
641b7adedcSWilliam Wang}
651b7adedcSWilliam Wang
662225d46eSJiawei Linclass PredictorAnswer(implicit p: Parameters) extends XSBundle {
67097c2688SLingrui98  val hit    = if (!env.FPGAPlatform) Bool() else UInt(0.W)
68097c2688SLingrui98  val taken  = if (!env.FPGAPlatform) Bool() else UInt(0.W)
69097c2688SLingrui98  val target = if (!env.FPGAPlatform) UInt(VAddrBits.W) else UInt(0.W)
7051b2a476Szoujr}
7151b2a476Szoujr
722225d46eSJiawei Linclass CfiUpdateInfo(implicit p: Parameters) extends XSBundle with HasBPUParameter {
73f226232fSzhanglinjuan  // from backend
7469cafcc9SLingrui98  val pc = UInt(VAddrBits.W)
75f226232fSzhanglinjuan  // frontend -> backend -> frontend
76f226232fSzhanglinjuan  val pd = new PreDecodeInfo
778a5e9243SLinJiawei  val rasSp = UInt(log2Up(RasSize).W)
782e947747SLinJiawei  val rasEntry = new RASEntry
79c2ad24ebSLingrui98  // val hist = new ShiftingGlobalHistory
80dd6c0695SLingrui98  val folded_hist = new AllFoldedHistories(foldedGHistInfos)
8167402d75SLingrui98  val afhob = new AllAheadFoldedHistoryOldestBits(foldedGHistInfos)
8267402d75SLingrui98  val lastBrNumOH = UInt((numBr+1).W)
83b37e4b45SLingrui98  val ghr = UInt(UbtbGHRLength.W)
84c2ad24ebSLingrui98  val histPtr = new CGHPtr
85e7b046c5Szoujr  val specCnt = Vec(numBr, UInt(10.W))
86fe3a74fcSYinan Xu  // need pipeline update
878a597714Szoujr  val br_hit = Bool()
882e947747SLinJiawei  val predTaken = Bool()
89b2e6921eSLinJiawei  val target = UInt(VAddrBits.W)
909a2e6b8aSLinJiawei  val taken = Bool()
91b2e6921eSLinJiawei  val isMisPred = Bool()
92d0527adfSzoujr  val shift = UInt((log2Ceil(numBr)+1).W)
93d0527adfSzoujr  val addIntoHist = Bool()
9414a6653fSLingrui98
9514a6653fSLingrui98  def fromFtqRedirectSram(entry: Ftq_Redirect_SRAMEntry) = {
96c2ad24ebSLingrui98    // this.hist := entry.ghist
97dd6c0695SLingrui98    this.folded_hist := entry.folded_hist
9867402d75SLingrui98    this.lastBrNumOH := entry.lastBrNumOH
9967402d75SLingrui98    this.afhob := entry.afhob
100c2ad24ebSLingrui98    this.histPtr := entry.histPtr
10114a6653fSLingrui98    this.rasSp := entry.rasSp
102c2d1ec7dSLingrui98    this.rasEntry := entry.rasTop
10314a6653fSLingrui98    this
10414a6653fSLingrui98  }
105b2e6921eSLinJiawei}
106b2e6921eSLinJiawei
1075844fcf0SLinJiawei// Dequeue DecodeWidth insts from Ibuffer
108de169c67SWilliam Wangclass CtrlFlow(implicit p: Parameters) extends XSBundle {
1095844fcf0SLinJiawei  val instr = UInt(32.W)
1105844fcf0SLinJiawei  val pc = UInt(VAddrBits.W)
111de169c67SWilliam Wang  val foldpc = UInt(MemPredPCWidth.W)
112baf8def6SYinan Xu  val exceptionVec = ExceptionVec()
11372951335SLi Qianruo  val trigger = new TriggerCf
114faf3cfa9SLinJiawei  val pd = new PreDecodeInfo
115cde9280dSLinJiawei  val pred_taken = Bool()
116c84054caSLinJiawei  val crossPageIPFFix = Bool()
117de169c67SWilliam Wang  val storeSetHit = Bool() // inst has been allocated an store set
118980c1bc3SWilliam Wang  val waitForRobIdx = new RobPtr // store set predicted previous store robIdx
119d1fe0262SWilliam Wang  // Load wait is needed
120d1fe0262SWilliam Wang  // load inst will not be executed until former store (predicted by mdp) addr calcuated
121d1fe0262SWilliam Wang  val loadWaitBit = Bool()
122d1fe0262SWilliam Wang  // If (loadWaitBit && loadWaitStrict), strict load wait is needed
123d1fe0262SWilliam Wang  // load inst will not be executed until ALL former store addr calcuated
124d1fe0262SWilliam Wang  val loadWaitStrict = Bool()
125de169c67SWilliam Wang  val ssid = UInt(SSIDWidth.W)
126884dbb3bSLinJiawei  val ftqPtr = new FtqPtr
127884dbb3bSLinJiawei  val ftqOffset = UInt(log2Up(PredictWidth).W)
1285844fcf0SLinJiawei}
1295844fcf0SLinJiawei
13072951335SLi Qianruo
1312225d46eSJiawei Linclass FPUCtrlSignals(implicit p: Parameters) extends XSBundle {
1322ce29ed6SLinJiawei  val isAddSub = Bool() // swap23
133dc597826SJiawei Lin  val typeTagIn = UInt(1.W)
134dc597826SJiawei Lin  val typeTagOut = UInt(1.W)
1352ce29ed6SLinJiawei  val fromInt = Bool()
1362ce29ed6SLinJiawei  val wflags = Bool()
1372ce29ed6SLinJiawei  val fpWen = Bool()
1382ce29ed6SLinJiawei  val fmaCmd = UInt(2.W)
1392ce29ed6SLinJiawei  val div = Bool()
1402ce29ed6SLinJiawei  val sqrt = Bool()
1412ce29ed6SLinJiawei  val fcvt = Bool()
1422ce29ed6SLinJiawei  val typ = UInt(2.W)
1432ce29ed6SLinJiawei  val fmt = UInt(2.W)
1442ce29ed6SLinJiawei  val ren3 = Bool() //TODO: remove SrcType.fp
145e6c6b64fSLinJiawei  val rm = UInt(3.W)
146579b9f28SLinJiawei}
147579b9f28SLinJiawei
1485844fcf0SLinJiawei// Decode DecodeWidth insts at Decode Stage
1492225d46eSJiawei Linclass CtrlSignals(implicit p: Parameters) extends XSBundle {
150a7a8a6ccSHaojin Tang  val srcType = Vec(4, SrcType())
151a7a8a6ccSHaojin Tang  val lsrc = Vec(4, UInt(6.W))
152a7a8a6ccSHaojin Tang  val ldest = UInt(6.W)
1539a2e6b8aSLinJiawei  val fuType = FuType()
1549a2e6b8aSLinJiawei  val fuOpType = FuOpType()
1559a2e6b8aSLinJiawei  val rfWen = Bool()
1569a2e6b8aSLinJiawei  val fpWen = Bool()
157deb6421eSHaojin Tang  val vecWen = Bool()
1589a2e6b8aSLinJiawei  val isXSTrap = Bool()
1592d366136SLinJiawei  val noSpecExec = Bool() // wait forward
1602d366136SLinJiawei  val blockBackward = Bool() // block backward
16145a56a29SZhangZifei  val flushPipe = Bool() // This inst will flush all the pipe when commit, like exception but can commit
162c2a8ae00SYikeZhou  val selImm = SelImm()
163b0ae3ac4SLinJiawei  val imm = UInt(ImmUnion.maxLen.W)
164a3edac52SYinan Xu  val commitType = CommitType()
165579b9f28SLinJiawei  val fpu = new FPUCtrlSignals
1664aa9ed34Sfdy  val uopIdx = UInt(5.W)
1674aa9ed34Sfdy  val vconfig = UInt(16.W)
168aac4464eSYinan Xu  val isMove = Bool()
169d4aca96cSlqre  val singleStep = Bool()
170c88c3a2aSYinan Xu  // This inst will flush all the pipe when it is the oldest inst in ROB,
171c88c3a2aSYinan Xu  // then replay from this inst itself
172c88c3a2aSYinan Xu  val replayInst = Bool()
173be25371aSYikeZhou
17457a10886SXuan Hu  private def allSignals = srcType.take(3) ++ Seq(fuType, fuOpType, rfWen, fpWen, vecWen,
1756e7c9679Shuxuan0307    isXSTrap, noSpecExec, blockBackward, flushPipe, selImm)
17688825c5cSYinan Xu
17788825c5cSYinan Xu  def decode(inst: UInt, table: Iterable[(BitPat, List[BitPat])]): CtrlSignals = {
17857a10886SXuan Hu    val decoder: Seq[UInt] = ListLookup(
17957a10886SXuan Hu      inst, XDecode.decodeDefault.map(bitPatToUInt),
18057a10886SXuan Hu      table.map{ case (pat, pats) => (pat, pats.map(bitPatToUInt)) }.toArray
18157a10886SXuan Hu    )
18288825c5cSYinan Xu    allSignals zip decoder foreach { case (s, d) => s := d }
1834d24c305SYikeZhou    commitType := DontCare
184be25371aSYikeZhou    this
185be25371aSYikeZhou  }
18688825c5cSYinan Xu
18788825c5cSYinan Xu  def decode(bit: List[BitPat]): CtrlSignals = {
18888825c5cSYinan Xu    allSignals.zip(bit.map(bitPatToUInt(_))).foreach{ case (s, d) => s := d }
18988825c5cSYinan Xu    this
19088825c5cSYinan Xu  }
191b6900d94SYinan Xu
1923b739f49SXuan Hu  def isWFI: Bool = fuType === FuType.csr.U && fuOpType === CSROpType.wfi
193f025d715SYinan Xu  def isSoftPrefetch: Bool = {
1943b739f49SXuan Hu    fuType === FuType.alu.U && fuOpType === ALUOpType.or && selImm === SelImm.IMM_I && ldest === 0.U
195f025d715SYinan Xu  }
1965844fcf0SLinJiawei}
1975844fcf0SLinJiawei
1982225d46eSJiawei Linclass CfCtrl(implicit p: Parameters) extends XSBundle {
1995844fcf0SLinJiawei  val cf = new CtrlFlow
2005844fcf0SLinJiawei  val ctrl = new CtrlSignals
2015844fcf0SLinJiawei}
2025844fcf0SLinJiawei
2032225d46eSJiawei Linclass PerfDebugInfo(implicit p: Parameters) extends XSBundle {
2048b8e745dSYikeZhou  val eliminatedMove = Bool()
205ba4100caSYinan Xu  // val fetchTime = UInt(64.W)
206ebb8ebf8SYinan Xu  val renameTime = UInt(XLEN.W)
207ebb8ebf8SYinan Xu  val dispatchTime = UInt(XLEN.W)
208ebb8ebf8SYinan Xu  val enqRsTime = UInt(XLEN.W)
209ebb8ebf8SYinan Xu  val selectTime = UInt(XLEN.W)
210ebb8ebf8SYinan Xu  val issueTime = UInt(XLEN.W)
211ebb8ebf8SYinan Xu  val writebackTime = UInt(XLEN.W)
2127cef916fSYinan Xu  // val commitTime = UInt(64.W)
21320edb3f7SWilliam Wang  val runahead_checkpoint_id = UInt(64.W)
214ba4100caSYinan Xu}
215ba4100caSYinan Xu
21648d1472eSWilliam Wang// Separate LSQ
2172225d46eSJiawei Linclass LSIdx(implicit p: Parameters) extends XSBundle {
218915c0dd4SYinan Xu  val lqIdx = new LqPtr
2195c1ae31bSYinan Xu  val sqIdx = new SqPtr
22024726fbfSWilliam Wang}
22124726fbfSWilliam Wang
222b2e6921eSLinJiawei// CfCtrl -> MicroOp at Rename Stage
2232225d46eSJiawei Linclass MicroOp(implicit p: Parameters) extends CfCtrl {
224a7a8a6ccSHaojin Tang  val srcState = Vec(4, SrcState())
225a7a8a6ccSHaojin Tang  val psrc = Vec(4, UInt(PhyRegIdxWidth.W))
22620e31bd1SYinan Xu  val pdest = UInt(PhyRegIdxWidth.W)
22720e31bd1SYinan Xu  val old_pdest = UInt(PhyRegIdxWidth.W)
2289aca92b9SYinan Xu  val robIdx = new RobPtr
229fe6452fcSYinan Xu  val lqIdx = new LqPtr
230fe6452fcSYinan Xu  val sqIdx = new SqPtr
2318b8e745dSYikeZhou  val eliminatedMove = Bool()
2327cef916fSYinan Xu  val debugInfo = new PerfDebugInfo
2339d4e1137SYinan Xu  def needRfRPort(index: Int, isFp: Boolean, ignoreState: Boolean = true) : Bool = {
234bcce877bSYinan Xu    val stateReady = srcState(index) === SrcState.rdy || ignoreState.B
235bcce877bSYinan Xu    val readReg = if (isFp) {
236bcce877bSYinan Xu      ctrl.srcType(index) === SrcType.fp
237bcce877bSYinan Xu    } else {
238bcce877bSYinan Xu      ctrl.srcType(index) === SrcType.reg && ctrl.lsrc(index) =/= 0.U
239a338f247SYinan Xu    }
240bcce877bSYinan Xu    readReg && stateReady
241a338f247SYinan Xu  }
2425c7674feSYinan Xu  def srcIsReady: Vec[Bool] = {
243c9ebdf90SYinan Xu    VecInit(ctrl.srcType.zip(srcState).map{ case (t, s) => SrcType.isPcOrImm(t) || s === SrcState.rdy })
2445c7674feSYinan Xu  }
2456ab6918fSYinan Xu  def clearExceptions(
2466ab6918fSYinan Xu    exceptionBits: Seq[Int] = Seq(),
2476ab6918fSYinan Xu    flushPipe: Boolean = false,
2486ab6918fSYinan Xu    replayInst: Boolean = false
2496ab6918fSYinan Xu  ): MicroOp = {
2506ab6918fSYinan Xu    cf.exceptionVec.zipWithIndex.filterNot(x => exceptionBits.contains(x._2)).foreach(_._1 := false.B)
2516ab6918fSYinan Xu    if (!flushPipe) { ctrl.flushPipe := false.B }
2526ab6918fSYinan Xu    if (!replayInst) { ctrl.replayInst := false.B }
253c88c3a2aSYinan Xu    this
254c88c3a2aSYinan Xu  }
2553b739f49SXuan Hu//  // Assume only the LUI instruction is decoded with IMM_U in ALU.
2563b739f49SXuan Hu//  def isLUI: Bool = ctrl.selImm === SelImm.IMM_U && ctrl.fuType === FuType.alu
2573b739f49SXuan Hu//  // This MicroOp is used to wakeup another uop (the successor: (psrc, srcType).
2583b739f49SXuan Hu//  def wakeup(successor: Seq[(UInt, UInt)], exuCfg: ExuConfig): Seq[(Bool, Bool)] = {
2593b739f49SXuan Hu//    successor.map{ case (src, srcType) =>
2603b739f49SXuan Hu//      val pdestMatch = pdest === src
2613b739f49SXuan Hu//      // For state: no need to check whether src is x0/imm/pc because they are always ready.
2623b739f49SXuan Hu//      val rfStateMatch = if (exuCfg.readIntRf) ctrl.rfWen else false.B
2633b739f49SXuan Hu//      val fpMatch = if (exuCfg.readFpRf) ctrl.fpWen else false.B
2643b739f49SXuan Hu//      val bothIntFp = exuCfg.readIntRf && exuCfg.readFpRf
2653b739f49SXuan Hu//      val bothStateMatch = Mux(SrcType.isFp(srcType), fpMatch, rfStateMatch)
2663b739f49SXuan Hu//      val stateCond = pdestMatch && (if (bothIntFp) bothStateMatch else rfStateMatch || fpMatch)
2673b739f49SXuan Hu//      // For data: types are matched and int pdest is not $zero.
2683b739f49SXuan Hu//      val rfDataMatch = if (exuCfg.readIntRf) ctrl.rfWen && src =/= 0.U else false.B
2693b739f49SXuan Hu//      val dataCond = pdestMatch && (rfDataMatch && SrcType.isReg(srcType) || fpMatch && SrcType.isFp(srcType))
2703b739f49SXuan Hu//      (stateCond, dataCond)
2713b739f49SXuan Hu//    }
2723b739f49SXuan Hu//  }
2733b739f49SXuan Hu//  // This MicroOp is used to wakeup another uop (the successor: MicroOp).
2743b739f49SXuan Hu//  def wakeup(successor: MicroOp, exuCfg: ExuConfig): Seq[(Bool, Bool)] = {
2753b739f49SXuan Hu//    wakeup(successor.psrc.zip(successor.ctrl.srcType), exuCfg)
2763b739f49SXuan Hu//  }
2773b739f49SXuan Hu//  def isJump: Bool = FuType.isJumpExu(ctrl.fuType)
2785844fcf0SLinJiawei}
2795844fcf0SLinJiawei
2803b739f49SXuan Hu//class XSBundleWithMicroOp(implicit p: Parameters) extends XSBundle {
2813b739f49SXuan Hu//  val uop = new MicroOp
2823b739f49SXuan Hu//}
28346f74b57SHaojin Tang
2843b739f49SXuan Hu//class MicroOpRbExt(implicit p: Parameters) extends XSBundleWithMicroOp {
2853b739f49SXuan Hu//  val flag = UInt(1.W)
2863b739f49SXuan Hu//}
287de169c67SWilliam Wang
2882225d46eSJiawei Linclass Redirect(implicit p: Parameters) extends XSBundle {
2899aca92b9SYinan Xu  val robIdx = new RobPtr
29036d7aed5SLinJiawei  val ftqIdx = new FtqPtr
29136d7aed5SLinJiawei  val ftqOffset = UInt(log2Up(PredictWidth).W)
292bfb958a3SYinan Xu  val level = RedirectLevel()
293bfb958a3SYinan Xu  val interrupt = Bool()
294c778d2afSLinJiawei  val cfiUpdate = new CfiUpdateInfo
295bfb958a3SYinan Xu
296de169c67SWilliam Wang  val stFtqIdx = new FtqPtr // for load violation predict
297de169c67SWilliam Wang  val stFtqOffset = UInt(log2Up(PredictWidth).W)
298fe211d16SLinJiawei
29920edb3f7SWilliam Wang  val debug_runahead_checkpoint_id = UInt(64.W)
30020edb3f7SWilliam Wang
3012d7c7105SYinan Xu  // def isUnconditional() = RedirectLevel.isUnconditional(level)
302bfb958a3SYinan Xu  def flushItself() = RedirectLevel.flushItself(level)
3032d7c7105SYinan Xu  // def isException() = RedirectLevel.isException(level)
304a25b1bceSLinJiawei}
305a25b1bceSLinJiawei
3062b4e8253SYinan Xuclass ResetPregStateReq(implicit p: Parameters) extends XSBundle {
30760deaca2SLinJiawei  // NOTE: set isInt and isFp both to 'false' when invalid
30860deaca2SLinJiawei  val isInt = Bool()
30960deaca2SLinJiawei  val isFp = Bool()
31060deaca2SLinJiawei  val preg = UInt(PhyRegIdxWidth.W)
3115844fcf0SLinJiawei}
3125844fcf0SLinJiawei
3132225d46eSJiawei Linclass DebugBundle(implicit p: Parameters) extends XSBundle {
31472235fa4SWilliam Wang  val isMMIO = Bool()
3158635f18fSwangkaifan  val isPerfCnt = Bool()
3168b91a337SWilliam Wang  val paddr = UInt(PAddrBits.W)
31772951335SLi Qianruo  val vaddr = UInt(VAddrBits.W)
318e402d94eSWilliam Wang}
3195844fcf0SLinJiawei
3203b739f49SXuan Hu//class ExuInput(isVpu: Boolean = false)(implicit p: Parameters) extends XSBundleWithMicroOp {
3213b739f49SXuan Hu//  val dataWidth = if (isVpu) VLEN else XLEN
3223b739f49SXuan Hu//
3233b739f49SXuan Hu//  val src = Vec(3, UInt(dataWidth.W))
3243b739f49SXuan Hu//}
32540a70bd6SZhangZifei
3263b739f49SXuan Hu//class ExuOutput(isVpu: Boolean = false)(implicit p: Parameters) extends XSBundleWithMicroOp {
3273b739f49SXuan Hu//  val dataWidth = if (isVpu) VLEN else XLEN
3283b739f49SXuan Hu//
3293b739f49SXuan Hu//  val data = UInt(dataWidth.W)
3303b739f49SXuan Hu//  val fflags = UInt(5.W)
3313b739f49SXuan Hu//  val redirectValid = Bool()
3323b739f49SXuan Hu//  val redirect = new Redirect
3333b739f49SXuan Hu//  val debug = new DebugBundle
3343b739f49SXuan Hu//}
3355844fcf0SLinJiawei
3362225d46eSJiawei Linclass ExternalInterruptIO(implicit p: Parameters) extends XSBundle {
33735bfeecbSYinan Xu  val mtip = Input(Bool())
33835bfeecbSYinan Xu  val msip = Input(Bool())
33935bfeecbSYinan Xu  val meip = Input(Bool())
340b3d79b37SYinan Xu  val seip = Input(Bool())
341d4aca96cSlqre  val debug = Input(Bool())
3425844fcf0SLinJiawei}
3435844fcf0SLinJiawei
3442225d46eSJiawei Linclass CSRSpecialIO(implicit p: Parameters) extends XSBundle {
3453b739f49SXuan Hu  val exception = Flipped(ValidIO(new DynInst))
3463fa7b737SYinan Xu  val isInterrupt = Input(Bool())
34735bfeecbSYinan Xu  val memExceptionVAddr = Input(UInt(VAddrBits.W))
34835bfeecbSYinan Xu  val trapTarget = Output(UInt(VAddrBits.W))
34935bfeecbSYinan Xu  val externalInterrupt = new ExternalInterruptIO
35035bfeecbSYinan Xu  val interrupt = Output(Bool())
35135bfeecbSYinan Xu}
35235bfeecbSYinan Xu
3533b739f49SXuan Hu//class ExceptionInfo(implicit p: Parameters) extends XSBundleWithMicroOp {
3543b739f49SXuan Hu//  val isInterrupt = Bool()
3553b739f49SXuan Hu//}
3563a474d38SYinan Xu
3579aca92b9SYinan Xuclass RobCommitInfo(implicit p: Parameters) extends XSBundle {
358a7a8a6ccSHaojin Tang  val ldest = UInt(6.W)
359fe6452fcSYinan Xu  val rfWen = Bool()
360fe6452fcSYinan Xu  val fpWen = Bool()
361deb6421eSHaojin Tang  val vecWen = Bool()
362a1fd7de4SLinJiawei  val wflags = Bool()
363fe6452fcSYinan Xu  val commitType = CommitType()
364fe6452fcSYinan Xu  val pdest = UInt(PhyRegIdxWidth.W)
365fe6452fcSYinan Xu  val old_pdest = UInt(PhyRegIdxWidth.W)
366884dbb3bSLinJiawei  val ftqIdx = new FtqPtr
367884dbb3bSLinJiawei  val ftqOffset = UInt(log2Up(PredictWidth).W)
368ccfddc82SHaojin Tang  val isMove = Bool()
3695844fcf0SLinJiawei
3709ecac1e8SYinan Xu  // these should be optimized for synthesis verilog
3719ecac1e8SYinan Xu  val pc = UInt(VAddrBits.W)
3724aa9ed34Sfdy
3734aa9ed34Sfdy  val uopIdx = UInt(5.W)
3743b739f49SXuan Hu//  val vconfig = UInt(16.W)
375fe6452fcSYinan Xu}
3765844fcf0SLinJiawei
3779aca92b9SYinan Xuclass RobCommitIO(implicit p: Parameters) extends XSBundle {
378ccfddc82SHaojin Tang  val isCommit = Bool()
379ccfddc82SHaojin Tang  val commitValid = Vec(CommitWidth, Bool())
3806474c47fSYinan Xu
381ccfddc82SHaojin Tang  val isWalk = Bool()
382c51eab43SYinan Xu  // valid bits optimized for walk
383ccfddc82SHaojin Tang  val walkValid = Vec(CommitWidth, Bool())
3846474c47fSYinan Xu
385ccfddc82SHaojin Tang  val info = Vec(CommitWidth, new RobCommitInfo)
38621e7a6c5SYinan Xu
3876474c47fSYinan Xu  def hasWalkInstr: Bool = isWalk && walkValid.asUInt.orR
3886474c47fSYinan Xu  def hasCommitInstr: Bool = isCommit && commitValid.asUInt.orR
3895844fcf0SLinJiawei}
3905844fcf0SLinJiawei
3911b7adedcSWilliam Wangclass RSFeedback(implicit p: Parameters) extends XSBundle {
39264e8d8bdSZhangZifei  val rsIdx = UInt(log2Up(IssQueSize).W)
393037a131fSWilliam Wang  val hit = Bool()
39462f57a35SLemover  val flushState = Bool()
3951b7adedcSWilliam Wang  val sourceType = RSFeedbackType()
396c7160cd3SWilliam Wang  val dataInvalidSqIdx = new SqPtr
397037a131fSWilliam Wang}
398037a131fSWilliam Wang
399d87b76aaSWilliam Wangclass MemRSFeedbackIO(implicit p: Parameters) extends XSBundle {
400d87b76aaSWilliam Wang  // Note: you need to update in implicit Parameters p before imp MemRSFeedbackIO
401d87b76aaSWilliam Wang  // for instance: MemRSFeedbackIO()(updateP)
402d87b76aaSWilliam Wang  val feedbackSlow = ValidIO(new RSFeedback()) // dcache miss queue full, dtlb miss
403d87b76aaSWilliam Wang  val feedbackFast = ValidIO(new RSFeedback()) // bank conflict
404d87b76aaSWilliam Wang}
405d87b76aaSWilliam Wang
406f06ca0bfSLingrui98class FrontendToCtrlIO(implicit p: Parameters) extends XSBundle {
4075844fcf0SLinJiawei  // to backend end
4085844fcf0SLinJiawei  val cfVec = Vec(DecodeWidth, DecoupledIO(new CtrlFlow))
409f06ca0bfSLingrui98  val fromFtq = new FtqToCtrlIO
4105844fcf0SLinJiawei  // from backend
411f06ca0bfSLingrui98  val toFtq = Flipped(new CtrlToFtqIO)
4121e3fad10SLinJiawei}
413fcff7e94SZhangZifei
414f1fe8698SLemoverclass SatpStruct(implicit p: Parameters) extends XSBundle {
41545f497a4Shappy-lx  val mode = UInt(4.W)
41645f497a4Shappy-lx  val asid = UInt(16.W)
41745f497a4Shappy-lx  val ppn  = UInt(44.W)
41845f497a4Shappy-lx}
41945f497a4Shappy-lx
420f1fe8698SLemoverclass TlbSatpBundle(implicit p: Parameters) extends SatpStruct {
42145f497a4Shappy-lx  val changed = Bool()
42245f497a4Shappy-lx
42345f497a4Shappy-lx  def apply(satp_value: UInt): Unit = {
42445f497a4Shappy-lx    require(satp_value.getWidth == XLEN)
42545f497a4Shappy-lx    val sa = satp_value.asTypeOf(new SatpStruct)
42645f497a4Shappy-lx    mode := sa.mode
42745f497a4Shappy-lx    asid := sa.asid
428f1fe8698SLemover    ppn := Cat(0.U(44-PAddrBits), sa.ppn(PAddrBits-1, 0)).asUInt()
42945f497a4Shappy-lx    changed := DataChanged(sa.asid) // when ppn is changed, software need do the flush
43045f497a4Shappy-lx  }
431fcff7e94SZhangZifei}
432f1fe8698SLemover
433f1fe8698SLemoverclass TlbCsrBundle(implicit p: Parameters) extends XSBundle {
434f1fe8698SLemover  val satp = new TlbSatpBundle()
435fcff7e94SZhangZifei  val priv = new Bundle {
436fcff7e94SZhangZifei    val mxr = Bool()
437fcff7e94SZhangZifei    val sum = Bool()
438fcff7e94SZhangZifei    val imode = UInt(2.W)
439fcff7e94SZhangZifei    val dmode = UInt(2.W)
440fcff7e94SZhangZifei  }
4418fc4e859SZhangZifei
4428fc4e859SZhangZifei  override def toPrintable: Printable = {
4438fc4e859SZhangZifei    p"Satp mode:0x${Hexadecimal(satp.mode)} asid:0x${Hexadecimal(satp.asid)} ppn:0x${Hexadecimal(satp.ppn)} " +
4448fc4e859SZhangZifei      p"Priv mxr:${priv.mxr} sum:${priv.sum} imode:${priv.imode} dmode:${priv.dmode}"
4458fc4e859SZhangZifei  }
446fcff7e94SZhangZifei}
447fcff7e94SZhangZifei
4482225d46eSJiawei Linclass SfenceBundle(implicit p: Parameters) extends XSBundle {
449fcff7e94SZhangZifei  val valid = Bool()
450fcff7e94SZhangZifei  val bits = new Bundle {
451fcff7e94SZhangZifei    val rs1 = Bool()
452fcff7e94SZhangZifei    val rs2 = Bool()
453fcff7e94SZhangZifei    val addr = UInt(VAddrBits.W)
45445f497a4Shappy-lx    val asid = UInt(AsidLength.W)
455f1fe8698SLemover    val flushPipe = Bool()
456fcff7e94SZhangZifei  }
4578fc4e859SZhangZifei
4588fc4e859SZhangZifei  override def toPrintable: Printable = {
459f1fe8698SLemover    p"valid:0x${Hexadecimal(valid)} rs1:${bits.rs1} rs2:${bits.rs2} addr:${Hexadecimal(bits.addr)}, flushPipe:${bits.flushPipe}"
4608fc4e859SZhangZifei  }
461fcff7e94SZhangZifei}
462a165bd69Swangkaifan
463de169c67SWilliam Wang// Bundle for load violation predictor updating
464de169c67SWilliam Wangclass MemPredUpdateReq(implicit p: Parameters) extends XSBundle  {
4652b8b2e7aSWilliam Wang  val valid = Bool()
466de169c67SWilliam Wang
467de169c67SWilliam Wang  // wait table update
468de169c67SWilliam Wang  val waddr = UInt(MemPredPCWidth.W)
4692b8b2e7aSWilliam Wang  val wdata = Bool() // true.B by default
470de169c67SWilliam Wang
471de169c67SWilliam Wang  // store set update
472de169c67SWilliam Wang  // by default, ldpc/stpc should be xor folded
473de169c67SWilliam Wang  val ldpc = UInt(MemPredPCWidth.W)
474de169c67SWilliam Wang  val stpc = UInt(MemPredPCWidth.W)
4752b8b2e7aSWilliam Wang}
4762b8b2e7aSWilliam Wang
4772225d46eSJiawei Linclass CustomCSRCtrlIO(implicit p: Parameters) extends XSBundle {
4782b8b2e7aSWilliam Wang  // Prefetcher
479ecccf78fSJay  val l1I_pf_enable = Output(Bool())
4802b8b2e7aSWilliam Wang  val l2_pf_enable = Output(Bool())
481ecccf78fSJay  // ICache
482ecccf78fSJay  val icache_parity_enable = Output(Bool())
483f3f22d72SYinan Xu  // Labeled XiangShan
4842b8b2e7aSWilliam Wang  val dsid = Output(UInt(8.W)) // TODO: DsidWidth as parameter
485f3f22d72SYinan Xu  // Load violation predictor
4862b8b2e7aSWilliam Wang  val lvpred_disable = Output(Bool())
4872b8b2e7aSWilliam Wang  val no_spec_load = Output(Bool())
488c7160cd3SWilliam Wang  val storeset_wait_store = Output(Bool())
489c7160cd3SWilliam Wang  val storeset_no_fast_wakeup = Output(Bool())
490c7160cd3SWilliam Wang  val lvpred_timeout = Output(UInt(5.W))
491f3f22d72SYinan Xu  // Branch predictor
4922b8b2e7aSWilliam Wang  val bp_ctrl = Output(new BPUCtrl)
493f3f22d72SYinan Xu  // Memory Block
494f3f22d72SYinan Xu  val sbuffer_threshold = Output(UInt(4.W))
495d10a581eSWilliam Wang  val ldld_vio_check_enable = Output(Bool())
496d10a581eSWilliam Wang  val soft_prefetch_enable = Output(Bool())
497a4e57ea3SLi Qianruo  val cache_error_enable = Output(Bool())
49837225120Ssfencevma  val uncache_write_outstanding_enable = Output(Bool())
499aac4464eSYinan Xu  // Rename
5005b47c58cSYinan Xu  val fusion_enable = Output(Bool())
5015b47c58cSYinan Xu  val wfi_enable = Output(Bool())
502af2f7849Shappy-lx  // Decode
503af2f7849Shappy-lx  val svinval_enable = Output(Bool())
504af2f7849Shappy-lx
505b6982e83SLemover  // distribute csr write signal
506b6982e83SLemover  val distribute_csr = new DistributedCSRIO()
50772951335SLi Qianruo
508ddb65c47SLi Qianruo  val singlestep = Output(Bool())
50972951335SLi Qianruo  val frontend_trigger = new FrontendTdataDistributeIO()
51072951335SLi Qianruo  val mem_trigger = new MemTdataDistributeIO()
51172951335SLi Qianruo  val trigger_enable = Output(Vec(10, Bool()))
512b6982e83SLemover}
513b6982e83SLemover
514b6982e83SLemoverclass DistributedCSRIO(implicit p: Parameters) extends XSBundle {
5151c746d3aScui fliter  // CSR has been written by csr inst, copies of csr should be updated
516b6982e83SLemover  val w = ValidIO(new Bundle {
517b6982e83SLemover    val addr = Output(UInt(12.W))
518b6982e83SLemover    val data = Output(UInt(XLEN.W))
519b6982e83SLemover  })
5202b8b2e7aSWilliam Wang}
521e19f7967SWilliam Wang
522e19f7967SWilliam Wangclass DistributedCSRUpdateReq(implicit p: Parameters) extends XSBundle {
523e19f7967SWilliam Wang  // Request csr to be updated
524e19f7967SWilliam Wang  //
525e19f7967SWilliam Wang  // Note that this request will ONLY update CSR Module it self,
526e19f7967SWilliam Wang  // copies of csr will NOT be updated, use it with care!
527e19f7967SWilliam Wang  //
528e19f7967SWilliam Wang  // For each cycle, no more than 1 DistributedCSRUpdateReq is valid
529e19f7967SWilliam Wang  val w = ValidIO(new Bundle {
530e19f7967SWilliam Wang    val addr = Output(UInt(12.W))
531e19f7967SWilliam Wang    val data = Output(UInt(XLEN.W))
532e19f7967SWilliam Wang  })
533e19f7967SWilliam Wang  def apply(valid: Bool, addr: UInt, data: UInt, src_description: String) = {
534e19f7967SWilliam Wang    when(valid){
535e19f7967SWilliam Wang      w.bits.addr := addr
536e19f7967SWilliam Wang      w.bits.data := data
537e19f7967SWilliam Wang    }
538e19f7967SWilliam Wang    println("Distributed CSR update req registered for " + src_description)
539e19f7967SWilliam Wang  }
540e19f7967SWilliam Wang}
54172951335SLi Qianruo
5420f59c834SWilliam Wangclass L1CacheErrorInfo(implicit p: Parameters) extends XSBundle {
5430f59c834SWilliam Wang  // L1CacheErrorInfo is also used to encode customized CACHE_ERROR CSR
5440f59c834SWilliam Wang  val source = Output(new Bundle() {
5450f59c834SWilliam Wang    val tag = Bool() // l1 tag array
5460f59c834SWilliam Wang    val data = Bool() // l1 data array
5470f59c834SWilliam Wang    val l2 = Bool()
5480f59c834SWilliam Wang  })
5490f59c834SWilliam Wang  val opType = Output(new Bundle() {
5500f59c834SWilliam Wang    val fetch = Bool()
5510f59c834SWilliam Wang    val load = Bool()
5520f59c834SWilliam Wang    val store = Bool()
5530f59c834SWilliam Wang    val probe = Bool()
5540f59c834SWilliam Wang    val release = Bool()
5550f59c834SWilliam Wang    val atom = Bool()
5560f59c834SWilliam Wang  })
5570f59c834SWilliam Wang  val paddr = Output(UInt(PAddrBits.W))
5580f59c834SWilliam Wang
5590f59c834SWilliam Wang  // report error and paddr to beu
5600f59c834SWilliam Wang  // bus error unit will receive error info iff ecc_error.valid
5610f59c834SWilliam Wang  val report_to_beu = Output(Bool())
5620f59c834SWilliam Wang
5630f59c834SWilliam Wang  // there is an valid error
5640f59c834SWilliam Wang  // l1 cache error will always be report to CACHE_ERROR csr
5650f59c834SWilliam Wang  val valid = Output(Bool())
5660f59c834SWilliam Wang
5670f59c834SWilliam Wang  def toL1BusErrorUnitInfo(): L1BusErrorUnitInfo = {
5680f59c834SWilliam Wang    val beu_info = Wire(new L1BusErrorUnitInfo)
5690f59c834SWilliam Wang    beu_info.ecc_error.valid := report_to_beu
5700f59c834SWilliam Wang    beu_info.ecc_error.bits := paddr
5710f59c834SWilliam Wang    beu_info
5720f59c834SWilliam Wang  }
5730f59c834SWilliam Wang}
574bc63e578SLi Qianruo
575bc63e578SLi Qianruo/* TODO how to trigger on next inst?
576bc63e578SLi Qianruo1. If hit is determined at frontend, then set a "next instr" trap at dispatch like singlestep
577bc63e578SLi 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
578bc63e578SLi Qianruoxret csr to pc + 4/ + 2
579bc63e578SLi Qianruo2.5 The problem is to let it commit. This is the real TODO
580bc63e578SLi Qianruo3. If it is load and hit before just treat it as regular load exception
581bc63e578SLi Qianruo */
582bc63e578SLi Qianruo
583bc63e578SLi Qianruo// This bundle carries trigger hit info along the pipeline
584bc63e578SLi Qianruo// Now there are 10 triggers divided into 5 groups of 2
585bc63e578SLi Qianruo// These groups are
586bc63e578SLi Qianruo// (if if) (store store) (load loid) (if store) (if load)
587bc63e578SLi Qianruo
588bc63e578SLi Qianruo// Triggers in the same group can chain, meaning that they only
589bc63e578SLi Qianruo// fire is both triggers in the group matches (the triggerHitVec bit is asserted)
590bc63e578SLi Qianruo// Chaining of trigger No. (2i) and (2i+1) is indicated by triggerChainVec(i)
591bc63e578SLi Qianruo// Timing of 0 means trap at current inst, 1 means trap at next inst
592bc63e578SLi Qianruo// Chaining and timing and the validness of a trigger is controlled by csr
593bc63e578SLi Qianruo// In two chained triggers, if they have different timing, both won't fire
59484e47f35SLi Qianruo//class TriggerCf (implicit p: Parameters) extends XSBundle {
59584e47f35SLi Qianruo//  val triggerHitVec = Vec(10, Bool())
59684e47f35SLi Qianruo//  val triggerTiming = Vec(10, Bool())
59784e47f35SLi Qianruo//  val triggerChainVec = Vec(5, Bool())
59884e47f35SLi Qianruo//}
59984e47f35SLi Qianruo
60072951335SLi Qianruoclass TriggerCf(implicit p: Parameters) extends XSBundle {
60184e47f35SLi Qianruo  // frontend
60284e47f35SLi Qianruo  val frontendHit = Vec(4, Bool())
603ddb65c47SLi Qianruo//  val frontendTiming = Vec(4, Bool())
604ddb65c47SLi Qianruo//  val frontendHitNext = Vec(4, Bool())
60584e47f35SLi Qianruo
606ddb65c47SLi Qianruo//  val frontendException = Bool()
60784e47f35SLi Qianruo  // backend
60884e47f35SLi Qianruo  val backendEn = Vec(2, Bool()) // Hit(6) && chain(4) , Hit(8) && chain(4)
60984e47f35SLi Qianruo  val backendHit = Vec(6, Bool())
610ddb65c47SLi Qianruo//  val backendTiming = Vec(6, Bool()) // trigger enable fro chain
61184e47f35SLi Qianruo
61284e47f35SLi Qianruo  // Two situations not allowed:
61384e47f35SLi Qianruo  // 1. load data comparison
61484e47f35SLi Qianruo  // 2. store chaining with store
61584e47f35SLi Qianruo  def getHitFrontend = frontendHit.reduce(_ || _)
61684e47f35SLi Qianruo  def getHitBackend = backendHit.reduce(_ || _)
617ddb65c47SLi Qianruo  def hit = getHitFrontend || getHitBackend
618d7dd1af1SLi Qianruo  def clear(): Unit = {
619d7dd1af1SLi Qianruo    frontendHit.foreach(_ := false.B)
620d7dd1af1SLi Qianruo    backendEn.foreach(_ := false.B)
621d7dd1af1SLi Qianruo    backendHit.foreach(_ := false.B)
622d7dd1af1SLi Qianruo  }
62372951335SLi Qianruo}
62472951335SLi Qianruo
625bc63e578SLi Qianruo// these 3 bundles help distribute trigger control signals from CSR
626bc63e578SLi Qianruo// to Frontend, Load and Store.
62772951335SLi Qianruoclass FrontendTdataDistributeIO(implicit p: Parameters)  extends XSBundle {
62872951335SLi Qianruo    val t = Valid(new Bundle {
62972951335SLi Qianruo      val addr = Output(UInt(2.W))
63072951335SLi Qianruo      val tdata = new MatchTriggerIO
63172951335SLi Qianruo    })
63272951335SLi Qianruo  }
63372951335SLi Qianruo
63472951335SLi Qianruoclass MemTdataDistributeIO(implicit p: Parameters)  extends XSBundle {
63572951335SLi Qianruo  val t = Valid(new Bundle {
63672951335SLi Qianruo    val addr = Output(UInt(3.W))
63772951335SLi Qianruo    val tdata = new MatchTriggerIO
63872951335SLi Qianruo  })
63972951335SLi Qianruo}
64072951335SLi Qianruo
64172951335SLi Qianruoclass MatchTriggerIO(implicit p: Parameters) extends XSBundle {
64272951335SLi Qianruo  val matchType = Output(UInt(2.W))
64372951335SLi Qianruo  val select = Output(Bool())
64472951335SLi Qianruo  val timing = Output(Bool())
64572951335SLi Qianruo  val action = Output(Bool())
64672951335SLi Qianruo  val chain = Output(Bool())
64772951335SLi Qianruo  val tdata2 = Output(UInt(64.W))
64872951335SLi Qianruo}
649