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