xref: /XiangShan/src/main/scala/xiangshan/Bundle.scala (revision 5da19fb3f5e30e8e3654dcd8ba1fefc3f257bb3a)
1/***************************************************************************************
2* Copyright (c) 2020-2021 Institute of Computing Technology, Chinese Academy of Sciences
3* Copyright (c) 2020-2021 Peng Cheng Laboratory
4*
5* XiangShan is licensed under Mulan PSL v2.
6* You can use this software according to the terms and conditions of the Mulan PSL v2.
7* You may obtain a copy of Mulan PSL v2 at:
8*          http://license.coscl.org.cn/MulanPSL2
9*
10* THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND,
11* EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT,
12* MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
13*
14* See the Mulan PSL v2 for more details.
15***************************************************************************************/
16
17package xiangshan
18
19import chisel3._
20import chisel3.util._
21import xiangshan.backend.rob.RobPtr
22import xiangshan.backend.CtrlToFtqIO
23import xiangshan.backend.decode.{ImmUnion, XDecode}
24import xiangshan.mem.{LqPtr, SqPtr}
25import xiangshan.frontend.PreDecodeInfo
26import xiangshan.frontend.HasBPUParameter
27import xiangshan.frontend.{AllFoldedHistories, CircularGlobalHistory, GlobalHistory, ShiftingGlobalHistory}
28import xiangshan.frontend.RASEntry
29import xiangshan.frontend.BPUCtrl
30import xiangshan.frontend.FtqPtr
31import xiangshan.frontend.CGHPtr
32import xiangshan.frontend.FtqRead
33import xiangshan.frontend.FtqToCtrlIO
34import utils._
35
36import scala.math.max
37import Chisel.experimental.chiselName
38import chipsalliance.rocketchip.config.Parameters
39import chisel3.util.BitPat.bitPatToUInt
40import xiangshan.backend.exu.ExuConfig
41import xiangshan.backend.fu.PMPEntry
42import xiangshan.frontend.Ftq_Redirect_SRAMEntry
43import xiangshan.frontend.AllFoldedHistories
44import xiangshan.frontend.AllAheadFoldedHistoryOldestBits
45
46class ValidUndirectioned[T <: Data](gen: T) extends Bundle {
47  val valid = Bool()
48  val bits = gen.cloneType.asInstanceOf[T]
49
50}
51
52object ValidUndirectioned {
53  def apply[T <: Data](gen: T) = {
54    new ValidUndirectioned[T](gen)
55  }
56}
57
58object RSFeedbackType {
59  val tlbMiss = 0.U(3.W)
60  val mshrFull = 1.U(3.W)
61  val dataInvalid = 2.U(3.W)
62  val bankConflict = 3.U(3.W)
63  val ldVioCheckRedo = 4.U(3.W)
64
65  val feedbackInvalid = 7.U(3.W)
66
67  def apply() = UInt(3.W)
68}
69
70class PredictorAnswer(implicit p: Parameters) extends XSBundle {
71  val hit    = if (!env.FPGAPlatform) Bool() else UInt(0.W)
72  val taken  = if (!env.FPGAPlatform) Bool() else UInt(0.W)
73  val target = if (!env.FPGAPlatform) UInt(VAddrBits.W) else UInt(0.W)
74}
75
76class CfiUpdateInfo(implicit p: Parameters) extends XSBundle with HasBPUParameter {
77  // from backend
78  val pc = UInt(VAddrBits.W)
79  // frontend -> backend -> frontend
80  val pd = new PreDecodeInfo
81  val rasSp = UInt(log2Up(RasSize).W)
82  val rasEntry = new RASEntry
83  // val hist = new ShiftingGlobalHistory
84  val folded_hist = new AllFoldedHistories(foldedGHistInfos)
85  val afhob = new AllAheadFoldedHistoryOldestBits(foldedGHistInfos)
86  val lastBrNumOH = UInt((numBr+1).W)
87  val ghr = UInt(UbtbGHRLength.W)
88  val histPtr = new CGHPtr
89  val specCnt = Vec(numBr, UInt(10.W))
90  // need pipeline update
91  val br_hit = Bool()
92  val predTaken = Bool()
93  val target = UInt(VAddrBits.W)
94  val taken = Bool()
95  val isMisPred = Bool()
96  val shift = UInt((log2Ceil(numBr)+1).W)
97  val addIntoHist = Bool()
98
99  def fromFtqRedirectSram(entry: Ftq_Redirect_SRAMEntry) = {
100    // this.hist := entry.ghist
101    this.folded_hist := entry.folded_hist
102    this.lastBrNumOH := entry.lastBrNumOH
103    this.afhob := entry.afhob
104    this.histPtr := entry.histPtr
105    this.rasSp := entry.rasSp
106    this.rasEntry := entry.rasTop
107    this
108  }
109}
110
111// Dequeue DecodeWidth insts from Ibuffer
112class CtrlFlow(implicit p: Parameters) extends XSBundle {
113  val instr = UInt(32.W)
114  val pc = UInt(VAddrBits.W)
115  val foldpc = UInt(MemPredPCWidth.W)
116  val exceptionVec = ExceptionVec()
117  val trigger = new TriggerCf
118  val pd = new PreDecodeInfo
119  val pred_taken = Bool()
120  val crossPageIPFFix = Bool()
121  val storeSetHit = Bool() // inst has been allocated an store set
122  val waitForRobIdx = new RobPtr // store set predicted previous store robIdx
123  // Load wait is needed
124  // load inst will not be executed until former store (predicted by mdp) addr calcuated
125  val loadWaitBit = Bool()
126  // If (loadWaitBit && loadWaitStrict), strict load wait is needed
127  // load inst will not be executed until ALL former store addr calcuated
128  val loadWaitStrict = Bool()
129  val ssid = UInt(SSIDWidth.W)
130  val ftqPtr = new FtqPtr
131  val ftqOffset = UInt(log2Up(PredictWidth).W)
132}
133
134
135class FPUCtrlSignals(implicit p: Parameters) extends XSBundle {
136  val isAddSub = Bool() // swap23
137  val typeTagIn = UInt(1.W)
138  val typeTagOut = UInt(1.W)
139  val fromInt = Bool()
140  val wflags = Bool()
141  val fpWen = Bool()
142  val fmaCmd = UInt(2.W)
143  val div = Bool()
144  val sqrt = Bool()
145  val fcvt = Bool()
146  val typ = UInt(2.W)
147  val fmt = UInt(2.W)
148  val ren3 = Bool() //TODO: remove SrcType.fp
149  val rm = UInt(3.W)
150}
151
152// Decode DecodeWidth insts at Decode Stage
153class CtrlSignals(implicit p: Parameters) extends XSBundle {
154  val srcType = Vec(3, SrcType())
155  val lsrc = Vec(3, UInt(5.W))
156  val ldest = UInt(5.W)
157  val fuType = FuType()
158  val fuOpType = FuOpType()
159  val rfWen = Bool()
160  val fpWen = Bool()
161  val isXSTrap = Bool()
162  val noSpecExec = Bool() // wait forward
163  val blockBackward = Bool() // block backward
164  val flushPipe = Bool() // This inst will flush all the pipe when commit, like exception but can commit
165  val selImm = SelImm()
166  val imm = UInt(ImmUnion.maxLen.W)
167  val commitType = CommitType()
168  val fpu = new FPUCtrlSignals
169  val isMove = Bool()
170  val singleStep = Bool()
171  // This inst will flush all the pipe when it is the oldest inst in ROB,
172  // then replay from this inst itself
173  val replayInst = Bool()
174
175  private def allSignals = srcType ++ Seq(fuType, fuOpType, rfWen, fpWen,
176    isXSTrap, noSpecExec, blockBackward, flushPipe, selImm)
177
178  def decode(inst: UInt, table: Iterable[(BitPat, List[BitPat])]): CtrlSignals = {
179    val decoder = freechips.rocketchip.rocket.DecodeLogic(inst, XDecode.decodeDefault, table)
180    allSignals zip decoder foreach { case (s, d) => s := d }
181    commitType := DontCare
182    this
183  }
184
185  def decode(bit: List[BitPat]): CtrlSignals = {
186    allSignals.zip(bit.map(bitPatToUInt(_))).foreach{ case (s, d) => s := d }
187    this
188  }
189
190  def isWFI: Bool = fuType === FuType.csr && fuOpType === CSROpType.wfi
191  def isSoftPrefetch: Bool = {
192    fuType === FuType.alu && fuOpType === ALUOpType.or && selImm === SelImm.IMM_I && ldest === 0.U
193  }
194}
195
196class CfCtrl(implicit p: Parameters) extends XSBundle {
197  val cf = new CtrlFlow
198  val ctrl = new CtrlSignals
199}
200
201class PerfDebugInfo(implicit p: Parameters) extends XSBundle {
202  val eliminatedMove = Bool()
203  // val fetchTime = UInt(64.W)
204  val renameTime = UInt(XLEN.W)
205  val dispatchTime = UInt(XLEN.W)
206  val enqRsTime = UInt(XLEN.W)
207  val selectTime = UInt(XLEN.W)
208  val issueTime = UInt(XLEN.W)
209  val writebackTime = UInt(XLEN.W)
210  // val commitTime = UInt(64.W)
211  val runahead_checkpoint_id = UInt(64.W)
212}
213
214// Separate LSQ
215class LSIdx(implicit p: Parameters) extends XSBundle {
216  val lqIdx = new LqPtr
217  val sqIdx = new SqPtr
218}
219
220// CfCtrl -> MicroOp at Rename Stage
221class MicroOp(implicit p: Parameters) extends CfCtrl {
222  val srcState = Vec(3, SrcState())
223  val psrc = Vec(3, UInt(PhyRegIdxWidth.W))
224  val pdest = UInt(PhyRegIdxWidth.W)
225  val old_pdest = UInt(PhyRegIdxWidth.W)
226  val robIdx = new RobPtr
227  val lqIdx = new LqPtr
228  val sqIdx = new SqPtr
229  val eliminatedMove = Bool()
230  val debugInfo = new PerfDebugInfo
231  def needRfRPort(index: Int, isFp: Boolean, ignoreState: Boolean = true) : Bool = {
232    val stateReady = srcState(index) === SrcState.rdy || ignoreState.B
233    val readReg = if (isFp) {
234      ctrl.srcType(index) === SrcType.fp
235    } else {
236      ctrl.srcType(index) === SrcType.reg && ctrl.lsrc(index) =/= 0.U
237    }
238    readReg && stateReady
239  }
240  def srcIsReady: Vec[Bool] = {
241    VecInit(ctrl.srcType.zip(srcState).map{ case (t, s) => SrcType.isPcOrImm(t) || s === SrcState.rdy })
242  }
243  def clearExceptions(
244    exceptionBits: Seq[Int] = Seq(),
245    flushPipe: Boolean = false,
246    replayInst: Boolean = false
247  ): MicroOp = {
248    cf.exceptionVec.zipWithIndex.filterNot(x => exceptionBits.contains(x._2)).foreach(_._1 := false.B)
249    if (!flushPipe) { ctrl.flushPipe := false.B }
250    if (!replayInst) { ctrl.replayInst := false.B }
251    this
252  }
253  // Assume only the LUI instruction is decoded with IMM_U in ALU.
254  def isLUI: Bool = ctrl.selImm === SelImm.IMM_U && ctrl.fuType === FuType.alu
255  // This MicroOp is used to wakeup another uop (the successor: (psrc, srcType).
256  def wakeup(successor: Seq[(UInt, UInt)], exuCfg: ExuConfig): Seq[(Bool, Bool)] = {
257    successor.map{ case (src, srcType) =>
258      val pdestMatch = pdest === src
259      // For state: no need to check whether src is x0/imm/pc because they are always ready.
260      val rfStateMatch = if (exuCfg.readIntRf) ctrl.rfWen else false.B
261      val fpMatch = if (exuCfg.readFpRf) ctrl.fpWen else false.B
262      val bothIntFp = exuCfg.readIntRf && exuCfg.readFpRf
263      val bothStateMatch = Mux(SrcType.regIsFp(srcType), fpMatch, rfStateMatch)
264      val stateCond = pdestMatch && (if (bothIntFp) bothStateMatch else rfStateMatch || fpMatch)
265      // For data: types are matched and int pdest is not $zero.
266      val rfDataMatch = if (exuCfg.readIntRf) ctrl.rfWen && src =/= 0.U else false.B
267      val dataCond = pdestMatch && (rfDataMatch && SrcType.isReg(srcType) || fpMatch && SrcType.isFp(srcType))
268      (stateCond, dataCond)
269    }
270  }
271  // This MicroOp is used to wakeup another uop (the successor: MicroOp).
272  def wakeup(successor: MicroOp, exuCfg: ExuConfig): Seq[(Bool, Bool)] = {
273    wakeup(successor.psrc.zip(successor.ctrl.srcType), exuCfg)
274  }
275  def isJump: Bool = FuType.isJumpExu(ctrl.fuType)
276}
277
278class XSBundleWithMicroOp(implicit p: Parameters) extends XSBundle {
279  val uop = new MicroOp
280}
281
282class MicroOpRbExt(implicit p: Parameters) extends XSBundleWithMicroOp {
283  val flag = UInt(1.W)
284}
285
286class Redirect(implicit p: Parameters) extends XSBundle {
287  val robIdx = new RobPtr
288  val ftqIdx = new FtqPtr
289  val ftqOffset = UInt(log2Up(PredictWidth).W)
290  val level = RedirectLevel()
291  val interrupt = Bool()
292  val cfiUpdate = new CfiUpdateInfo
293
294  val stFtqIdx = new FtqPtr // for load violation predict
295  val stFtqOffset = UInt(log2Up(PredictWidth).W)
296
297  val debug_runahead_checkpoint_id = UInt(64.W)
298
299  // def isUnconditional() = RedirectLevel.isUnconditional(level)
300  def flushItself() = RedirectLevel.flushItself(level)
301  // def isException() = RedirectLevel.isException(level)
302}
303
304class Dp1ToDp2IO(implicit p: Parameters) extends XSBundle {
305  val intDqToDp2 = Vec(dpParams.IntDqDeqWidth, DecoupledIO(new MicroOp))
306  val fpDqToDp2 = Vec(dpParams.FpDqDeqWidth, DecoupledIO(new MicroOp))
307  val lsDqToDp2 = Vec(dpParams.LsDqDeqWidth, DecoupledIO(new MicroOp))
308}
309
310class ResetPregStateReq(implicit p: Parameters) extends XSBundle {
311  // NOTE: set isInt and isFp both to 'false' when invalid
312  val isInt = Bool()
313  val isFp = Bool()
314  val preg = UInt(PhyRegIdxWidth.W)
315}
316
317class DebugBundle(implicit p: Parameters) extends XSBundle {
318  val isMMIO = Bool()
319  val isPerfCnt = Bool()
320  val paddr = UInt(PAddrBits.W)
321  val vaddr = UInt(VAddrBits.W)
322}
323
324class ExuInput(implicit p: Parameters) extends XSBundleWithMicroOp {
325  val src = Vec(3, UInt(XLEN.W))
326}
327
328class ExuOutput(implicit p: Parameters) extends XSBundleWithMicroOp {
329  val data = UInt(XLEN.W)
330  val fflags = UInt(5.W)
331  val redirectValid = Bool()
332  val redirect = new Redirect
333  val debug = new DebugBundle
334}
335
336class ExternalInterruptIO(implicit p: Parameters) extends XSBundle {
337  val mtip = Input(Bool())
338  val msip = Input(Bool())
339  val meip = Input(Bool())
340  val seip = Input(Bool())
341  val debug = Input(Bool())
342}
343
344class CSRSpecialIO(implicit p: Parameters) extends XSBundle {
345  val exception = Flipped(ValidIO(new MicroOp))
346  val isInterrupt = Input(Bool())
347  val memExceptionVAddr = Input(UInt(VAddrBits.W))
348  val trapTarget = Output(UInt(VAddrBits.W))
349  val externalInterrupt = new ExternalInterruptIO
350  val interrupt = Output(Bool())
351}
352
353class ExceptionInfo(implicit p: Parameters) extends XSBundleWithMicroOp {
354  val isInterrupt = Bool()
355}
356
357class RobCommitInfo(implicit p: Parameters) extends XSBundle {
358  val ldest = UInt(5.W)
359  val rfWen = Bool()
360  val fpWen = Bool()
361  val wflags = Bool()
362  val commitType = CommitType()
363  val pdest = UInt(PhyRegIdxWidth.W)
364  val old_pdest = UInt(PhyRegIdxWidth.W)
365  val ftqIdx = new FtqPtr
366  val ftqOffset = UInt(log2Up(PredictWidth).W)
367  val isMove = Bool()
368
369  // these should be optimized for synthesis verilog
370  val pc = UInt(VAddrBits.W)
371}
372
373class RobCommitIO(implicit p: Parameters) extends XSBundle {
374  val isCommit = Bool()
375  val commitValid = Vec(CommitWidth, Bool())
376
377  val isWalk = Bool()
378  // valid bits optimized for walk
379  val walkValid = Vec(CommitWidth, Bool())
380
381  val info = Vec(CommitWidth, new RobCommitInfo)
382
383  def hasWalkInstr: Bool = isWalk && walkValid.asUInt.orR
384  def hasCommitInstr: Bool = isCommit && commitValid.asUInt.orR
385}
386
387class RSFeedback(implicit p: Parameters) extends XSBundle {
388  val rsIdx = UInt(log2Up(IssQueSize).W)
389  val hit = Bool()
390  val flushState = Bool()
391  val sourceType = RSFeedbackType()
392  val dataInvalidSqIdx = new SqPtr
393}
394
395class MemRSFeedbackIO(implicit p: Parameters) extends XSBundle {
396  // Note: you need to update in implicit Parameters p before imp MemRSFeedbackIO
397  // for instance: MemRSFeedbackIO()(updateP)
398  val feedbackSlow = ValidIO(new RSFeedback()) // dcache miss queue full, dtlb miss
399  val feedbackFast = ValidIO(new RSFeedback()) // bank conflict
400  val rsIdx = Input(UInt(log2Up(IssQueSize).W))
401  val isFirstIssue = Input(Bool())
402}
403
404class FrontendToCtrlIO(implicit p: Parameters) extends XSBundle {
405  // to backend end
406  val cfVec = Vec(DecodeWidth, DecoupledIO(new CtrlFlow))
407  val fromFtq = new FtqToCtrlIO
408  // from backend
409  val toFtq = Flipped(new CtrlToFtqIO)
410}
411
412class SatpStruct(implicit p: Parameters) extends XSBundle {
413  val mode = UInt(4.W)
414  val asid = UInt(16.W)
415  val ppn  = UInt(44.W)
416}
417
418class TlbSatpBundle(implicit p: Parameters) extends SatpStruct {
419  val changed = Bool()
420
421  def apply(satp_value: UInt): Unit = {
422    require(satp_value.getWidth == XLEN)
423    val sa = satp_value.asTypeOf(new SatpStruct)
424    mode := sa.mode
425    asid := sa.asid
426    ppn := Cat(0.U(44-PAddrBits), sa.ppn(PAddrBits-1, 0)).asUInt()
427    changed := DataChanged(sa.asid) // when ppn is changed, software need do the flush
428  }
429}
430
431class TlbCsrBundle(implicit p: Parameters) extends XSBundle {
432  val satp = new TlbSatpBundle()
433  val priv = new Bundle {
434    val mxr = Bool()
435    val sum = Bool()
436    val imode = UInt(2.W)
437    val dmode = UInt(2.W)
438  }
439
440  override def toPrintable: Printable = {
441    p"Satp mode:0x${Hexadecimal(satp.mode)} asid:0x${Hexadecimal(satp.asid)} ppn:0x${Hexadecimal(satp.ppn)} " +
442      p"Priv mxr:${priv.mxr} sum:${priv.sum} imode:${priv.imode} dmode:${priv.dmode}"
443  }
444}
445
446class SfenceBundle(implicit p: Parameters) extends XSBundle {
447  val valid = Bool()
448  val bits = new Bundle {
449    val rs1 = Bool()
450    val rs2 = Bool()
451    val addr = UInt(VAddrBits.W)
452    val asid = UInt(AsidLength.W)
453    val flushPipe = Bool()
454  }
455
456  override def toPrintable: Printable = {
457    p"valid:0x${Hexadecimal(valid)} rs1:${bits.rs1} rs2:${bits.rs2} addr:${Hexadecimal(bits.addr)}, flushPipe:${bits.flushPipe}"
458  }
459}
460
461// Bundle for load violation predictor updating
462class MemPredUpdateReq(implicit p: Parameters) extends XSBundle  {
463  val valid = Bool()
464
465  // wait table update
466  val waddr = UInt(MemPredPCWidth.W)
467  val wdata = Bool() // true.B by default
468
469  // store set update
470  // by default, ldpc/stpc should be xor folded
471  val ldpc = UInt(MemPredPCWidth.W)
472  val stpc = UInt(MemPredPCWidth.W)
473}
474
475class CustomCSRCtrlIO(implicit p: Parameters) extends XSBundle {
476  // Prefetcher
477  val l1I_pf_enable = Output(Bool())
478  val l2_pf_enable = Output(Bool())
479  // ICache
480  val icache_parity_enable = Output(Bool())
481  // Labeled XiangShan
482  val dsid = Output(UInt(8.W)) // TODO: DsidWidth as parameter
483  // Load violation predictor
484  val lvpred_disable = Output(Bool())
485  val no_spec_load = Output(Bool())
486  val storeset_wait_store = Output(Bool())
487  val storeset_no_fast_wakeup = Output(Bool())
488  val lvpred_timeout = Output(UInt(5.W))
489  // Branch predictor
490  val bp_ctrl = Output(new BPUCtrl)
491  // Memory Block
492  val sbuffer_threshold = Output(UInt(4.W))
493  val ldld_vio_check_enable = Output(Bool())
494  val soft_prefetch_enable = Output(Bool())
495  val cache_error_enable = Output(Bool())
496  // Rename
497  val fusion_enable = Output(Bool())
498  val wfi_enable = Output(Bool())
499  // Decode
500  val svinval_enable = Output(Bool())
501
502  // distribute csr write signal
503  val distribute_csr = new DistributedCSRIO()
504
505  val singlestep = Output(Bool())
506  val frontend_trigger = new FrontendTdataDistributeIO()
507  val mem_trigger = new MemTdataDistributeIO()
508  val trigger_enable = Output(Vec(10, Bool()))
509}
510
511class DistributedCSRIO(implicit p: Parameters) extends XSBundle {
512  // CSR has been written by csr inst, copies of csr should be updated
513  val w = ValidIO(new Bundle {
514    val addr = Output(UInt(12.W))
515    val data = Output(UInt(XLEN.W))
516  })
517}
518
519class DistributedCSRUpdateReq(implicit p: Parameters) extends XSBundle {
520  // Request csr to be updated
521  //
522  // Note that this request will ONLY update CSR Module it self,
523  // copies of csr will NOT be updated, use it with care!
524  //
525  // For each cycle, no more than 1 DistributedCSRUpdateReq is valid
526  val w = ValidIO(new Bundle {
527    val addr = Output(UInt(12.W))
528    val data = Output(UInt(XLEN.W))
529  })
530  def apply(valid: Bool, addr: UInt, data: UInt, src_description: String) = {
531    when(valid){
532      w.bits.addr := addr
533      w.bits.data := data
534    }
535    println("Distributed CSR update req registered for " + src_description)
536  }
537}
538
539class L1CacheErrorInfo(implicit p: Parameters) extends XSBundle {
540  // L1CacheErrorInfo is also used to encode customized CACHE_ERROR CSR
541  val source = Output(new Bundle() {
542    val tag = Bool() // l1 tag array
543    val data = Bool() // l1 data array
544    val l2 = Bool()
545  })
546  val opType = Output(new Bundle() {
547    val fetch = Bool()
548    val load = Bool()
549    val store = Bool()
550    val probe = Bool()
551    val release = Bool()
552    val atom = Bool()
553  })
554  val paddr = Output(UInt(PAddrBits.W))
555
556  // report error and paddr to beu
557  // bus error unit will receive error info iff ecc_error.valid
558  val report_to_beu = Output(Bool())
559
560  // there is an valid error
561  // l1 cache error will always be report to CACHE_ERROR csr
562  val valid = Output(Bool())
563
564  def toL1BusErrorUnitInfo(): L1BusErrorUnitInfo = {
565    val beu_info = Wire(new L1BusErrorUnitInfo)
566    beu_info.ecc_error.valid := report_to_beu
567    beu_info.ecc_error.bits := paddr
568    beu_info
569  }
570}
571
572/* TODO how to trigger on next inst?
5731. If hit is determined at frontend, then set a "next instr" trap at dispatch like singlestep
5742. 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
575xret csr to pc + 4/ + 2
5762.5 The problem is to let it commit. This is the real TODO
5773. If it is load and hit before just treat it as regular load exception
578 */
579
580// This bundle carries trigger hit info along the pipeline
581// Now there are 10 triggers divided into 5 groups of 2
582// These groups are
583// (if if) (store store) (load loid) (if store) (if load)
584
585// Triggers in the same group can chain, meaning that they only
586// fire is both triggers in the group matches (the triggerHitVec bit is asserted)
587// Chaining of trigger No. (2i) and (2i+1) is indicated by triggerChainVec(i)
588// Timing of 0 means trap at current inst, 1 means trap at next inst
589// Chaining and timing and the validness of a trigger is controlled by csr
590// In two chained triggers, if they have different timing, both won't fire
591//class TriggerCf (implicit p: Parameters) extends XSBundle {
592//  val triggerHitVec = Vec(10, Bool())
593//  val triggerTiming = Vec(10, Bool())
594//  val triggerChainVec = Vec(5, Bool())
595//}
596
597class TriggerCf(implicit p: Parameters) extends XSBundle {
598  // frontend
599  val frontendHit = Vec(4, Bool())
600//  val frontendTiming = Vec(4, Bool())
601//  val frontendHitNext = Vec(4, Bool())
602
603//  val frontendException = Bool()
604  // backend
605  val backendEn = Vec(2, Bool()) // Hit(6) && chain(4) , Hit(8) && chain(4)
606  val backendHit = Vec(6, Bool())
607//  val backendTiming = Vec(6, Bool()) // trigger enable fro chain
608
609  // Two situations not allowed:
610  // 1. load data comparison
611  // 2. store chaining with store
612  def getHitFrontend = frontendHit.reduce(_ || _)
613  def getHitBackend = backendHit.reduce(_ || _)
614  def hit = getHitFrontend || getHitBackend
615  def clear(): Unit = {
616    frontendHit.foreach(_ := false.B)
617    backendEn.foreach(_ := false.B)
618    backendHit.foreach(_ := false.B)
619  }
620}
621
622// these 3 bundles help distribute trigger control signals from CSR
623// to Frontend, Load and Store.
624class FrontendTdataDistributeIO(implicit p: Parameters)  extends XSBundle {
625    val t = Valid(new Bundle {
626      val addr = Output(UInt(2.W))
627      val tdata = new MatchTriggerIO
628    })
629  }
630
631class MemTdataDistributeIO(implicit p: Parameters)  extends XSBundle {
632  val t = Valid(new Bundle {
633    val addr = Output(UInt(3.W))
634    val tdata = new MatchTriggerIO
635  })
636}
637
638class MatchTriggerIO(implicit p: Parameters) extends XSBundle {
639  val matchType = Output(UInt(2.W))
640  val select = Output(Bool())
641  val timing = Output(Bool())
642  val action = Output(Bool())
643  val chain = Output(Bool())
644  val tdata2 = Output(UInt(64.W))
645}
646