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