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