xref: /XiangShan/src/main/scala/xiangshan/Bundle.scala (revision b56f947ea6e9fe50fd06047a225356a808f2a3b1)
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  def apply() = UInt(3.W)
66}
67
68class PredictorAnswer(implicit p: Parameters) extends XSBundle {
69  val hit    = if (!env.FPGAPlatform) Bool() else UInt(0.W)
70  val taken  = if (!env.FPGAPlatform) Bool() else UInt(0.W)
71  val target = if (!env.FPGAPlatform) UInt(VAddrBits.W) else UInt(0.W)
72}
73
74class CfiUpdateInfo(implicit p: Parameters) extends XSBundle with HasBPUParameter {
75  // from backend
76  val pc = UInt(VAddrBits.W)
77  // frontend -> backend -> frontend
78  val pd = new PreDecodeInfo
79  val rasSp = UInt(log2Up(RasSize).W)
80  val rasEntry = new RASEntry
81  // val hist = new ShiftingGlobalHistory
82  val folded_hist = new AllFoldedHistories(foldedGHistInfos)
83  val afhob = new AllAheadFoldedHistoryOldestBits(foldedGHistInfos)
84  val lastBrNumOH = UInt((numBr+1).W)
85  val ghr = UInt(UbtbGHRLength.W)
86  val histPtr = new CGHPtr
87  val specCnt = Vec(numBr, UInt(10.W))
88  // need pipeline update
89  val br_hit = Bool()
90  val predTaken = Bool()
91  val target = UInt(VAddrBits.W)
92  val taken = Bool()
93  val isMisPred = Bool()
94  val shift = UInt((log2Ceil(numBr)+1).W)
95  val addIntoHist = Bool()
96
97  def fromFtqRedirectSram(entry: Ftq_Redirect_SRAMEntry) = {
98    // this.hist := entry.ghist
99    this.folded_hist := entry.folded_hist
100    this.lastBrNumOH := entry.lastBrNumOH
101    this.afhob := entry.afhob
102    this.histPtr := entry.histPtr
103    this.rasSp := entry.rasSp
104    this.rasEntry := entry.rasEntry
105    this
106  }
107}
108
109// Dequeue DecodeWidth insts from Ibuffer
110class CtrlFlow(implicit p: Parameters) extends XSBundle {
111  val instr = UInt(32.W)
112  val pc = UInt(VAddrBits.W)
113  val foldpc = UInt(MemPredPCWidth.W)
114  val exceptionVec = ExceptionVec()
115  val trigger = new TriggerCf
116  val pd = new PreDecodeInfo
117  val pred_taken = Bool()
118  val crossPageIPFFix = Bool()
119  val storeSetHit = Bool() // inst has been allocated an store set
120  val waitForRobIdx = new RobPtr // store set predicted previous store robIdx
121  // Load wait is needed
122  // load inst will not be executed until former store (predicted by mdp) addr calcuated
123  val loadWaitBit = Bool()
124  // If (loadWaitBit && loadWaitStrict), strict load wait is needed
125  // load inst will not be executed until ALL former store addr calcuated
126  val loadWaitStrict = Bool()
127  val ssid = UInt(SSIDWidth.W)
128  val ftqPtr = new FtqPtr
129  val ftqOffset = UInt(log2Up(PredictWidth).W)
130  // This inst will flush all the pipe when it is the oldest inst in ROB,
131  // then replay from this inst itself
132  val replayInst = Bool()
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(3, SrcType())
156  val lsrc = Vec(3, UInt(5.W))
157  val ldest = UInt(5.W)
158  val fuType = FuType()
159  val fuOpType = FuOpType()
160  val rfWen = Bool()
161  val fpWen = 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 isMove = Bool()
171  val singleStep = Bool()
172  // This inst will flush all the pipe when it is the oldest inst in ROB,
173  // then replay from this inst itself
174  val replayInst = Bool()
175
176  private def allSignals = srcType ++ Seq(fuType, fuOpType, rfWen, fpWen,
177    isXSTrap, noSpecExec, blockBackward, flushPipe, selImm)
178
179  def decode(inst: UInt, table: Iterable[(BitPat, List[BitPat])]): CtrlSignals = {
180    val decoder = freechips.rocketchip.rocket.DecodeLogic(inst, XDecode.decodeDefault, table)
181    allSignals zip decoder foreach { case (s, d) => s := d }
182    commitType := DontCare
183    this
184  }
185
186  def decode(bit: List[BitPat]): CtrlSignals = {
187    allSignals.zip(bit.map(bitPatToUInt(_))).foreach{ case (s, d) => s := d }
188    this
189  }
190
191  def isWFI: Bool = fuType === FuType.csr && fuOpType === CSROpType.wfi
192  def isSoftPrefetch: Bool = {
193    fuType === FuType.alu && fuOpType === ALUOpType.or && selImm === SelImm.IMM_I && ldest === 0.U
194  }
195}
196
197class CfCtrl(implicit p: Parameters) extends XSBundle {
198  val cf = new CtrlFlow
199  val ctrl = new CtrlSignals
200}
201
202class PerfDebugInfo(implicit p: Parameters) extends XSBundle {
203  val eliminatedMove = Bool()
204  // val fetchTime = UInt(64.W)
205  val renameTime = UInt(XLEN.W)
206  val dispatchTime = UInt(XLEN.W)
207  val enqRsTime = UInt(XLEN.W)
208  val selectTime = UInt(XLEN.W)
209  val issueTime = UInt(XLEN.W)
210  val writebackTime = UInt(XLEN.W)
211  // val commitTime = UInt(64.W)
212  val runahead_checkpoint_id = UInt(64.W)
213}
214
215// Separate LSQ
216class LSIdx(implicit p: Parameters) extends XSBundle {
217  val lqIdx = new LqPtr
218  val sqIdx = new SqPtr
219}
220
221// CfCtrl -> MicroOp at Rename Stage
222class MicroOp(implicit p: Parameters) extends CfCtrl {
223  val srcState = Vec(3, SrcState())
224  val psrc = Vec(3, UInt(PhyRegIdxWidth.W))
225  val pdest = UInt(PhyRegIdxWidth.W)
226  val old_pdest = UInt(PhyRegIdxWidth.W)
227  val robIdx = new RobPtr
228  val lqIdx = new LqPtr
229  val sqIdx = new SqPtr
230  val eliminatedMove = Bool()
231  val debugInfo = new PerfDebugInfo
232  def needRfRPort(index: Int, isFp: Boolean, ignoreState: Boolean = true) : Bool = {
233    val stateReady = srcState(index) === SrcState.rdy || ignoreState.B
234    val readReg = if (isFp) {
235      ctrl.srcType(index) === SrcType.fp
236    } else {
237      ctrl.srcType(index) === SrcType.reg && ctrl.lsrc(index) =/= 0.U
238    }
239    readReg && stateReady
240  }
241  def srcIsReady: Vec[Bool] = {
242    VecInit(ctrl.srcType.zip(srcState).map{ case (t, s) => SrcType.isPcOrImm(t) || s === SrcState.rdy })
243  }
244  def clearExceptions(
245    exceptionBits: Seq[Int] = Seq(),
246    flushPipe: Boolean = false,
247    replayInst: Boolean = false
248  ): MicroOp = {
249    cf.exceptionVec.zipWithIndex.filterNot(x => exceptionBits.contains(x._2)).foreach(_._1 := false.B)
250    if (!flushPipe) { ctrl.flushPipe := false.B }
251    if (!replayInst) { ctrl.replayInst := false.B }
252    this
253  }
254  // Assume only the LUI instruction is decoded with IMM_U in ALU.
255  def isLUI: Bool = ctrl.selImm === SelImm.IMM_U && ctrl.fuType === FuType.alu
256  // This MicroOp is used to wakeup another uop (the successor: (psrc, srcType).
257  def wakeup(successor: Seq[(UInt, UInt)], exuCfg: ExuConfig): Seq[(Bool, Bool)] = {
258    successor.map{ case (src, srcType) =>
259      val pdestMatch = pdest === src
260      // For state: no need to check whether src is x0/imm/pc because they are always ready.
261      val rfStateMatch = if (exuCfg.readIntRf) ctrl.rfWen else false.B
262      val fpMatch = if (exuCfg.readFpRf) ctrl.fpWen else false.B
263      val bothIntFp = exuCfg.readIntRf && exuCfg.readFpRf
264      val bothStateMatch = Mux(SrcType.regIsFp(srcType), fpMatch, rfStateMatch)
265      val stateCond = pdestMatch && (if (bothIntFp) bothStateMatch else rfStateMatch || fpMatch)
266      // For data: types are matched and int pdest is not $zero.
267      val rfDataMatch = if (exuCfg.readIntRf) ctrl.rfWen && src =/= 0.U else false.B
268      val dataCond = pdestMatch && (rfDataMatch && SrcType.isReg(srcType) || fpMatch && SrcType.isFp(srcType))
269      (stateCond, dataCond)
270    }
271  }
272  // This MicroOp is used to wakeup another uop (the successor: MicroOp).
273  def wakeup(successor: MicroOp, exuCfg: ExuConfig): Seq[(Bool, Bool)] = {
274    wakeup(successor.psrc.zip(successor.ctrl.srcType), exuCfg)
275  }
276  def isJump: Bool = FuType.isJumpExu(ctrl.fuType)
277}
278
279class XSBundleWithMicroOp(implicit p: Parameters) extends XSBundle {
280  val uop = new MicroOp
281}
282
283class MicroOpRbExt(implicit p: Parameters) extends XSBundleWithMicroOp {
284  val flag = UInt(1.W)
285}
286
287class Redirect(implicit p: Parameters) extends XSBundle {
288  val robIdx = new RobPtr
289  val ftqIdx = new FtqPtr
290  val ftqOffset = UInt(log2Up(PredictWidth).W)
291  val level = RedirectLevel()
292  val interrupt = Bool()
293  val cfiUpdate = new CfiUpdateInfo
294
295  val stFtqIdx = new FtqPtr // for load violation predict
296  val stFtqOffset = UInt(log2Up(PredictWidth).W)
297
298  val debug_runahead_checkpoint_id = UInt(64.W)
299
300  // def isUnconditional() = RedirectLevel.isUnconditional(level)
301  def flushItself() = RedirectLevel.flushItself(level)
302  // def isException() = RedirectLevel.isException(level)
303}
304
305class Dp1ToDp2IO(implicit p: Parameters) extends XSBundle {
306  val intDqToDp2 = Vec(dpParams.IntDqDeqWidth, DecoupledIO(new MicroOp))
307  val fpDqToDp2 = Vec(dpParams.FpDqDeqWidth, DecoupledIO(new MicroOp))
308  val lsDqToDp2 = Vec(dpParams.LsDqDeqWidth, DecoupledIO(new MicroOp))
309}
310
311class ResetPregStateReq(implicit p: Parameters) extends XSBundle {
312  // NOTE: set isInt and isFp both to 'false' when invalid
313  val isInt = Bool()
314  val isFp = Bool()
315  val preg = UInt(PhyRegIdxWidth.W)
316}
317
318class DebugBundle(implicit p: Parameters) extends XSBundle {
319  val isMMIO = Bool()
320  val isPerfCnt = Bool()
321  val paddr = UInt(PAddrBits.W)
322  val vaddr = UInt(VAddrBits.W)
323}
324
325class ExuInput(implicit p: Parameters) extends XSBundleWithMicroOp {
326  val src = Vec(3, UInt(XLEN.W))
327}
328
329class ExuOutput(implicit p: Parameters) extends XSBundleWithMicroOp {
330  val data = UInt(XLEN.W)
331  val fflags = UInt(5.W)
332  val redirectValid = Bool()
333  val redirect = new Redirect
334  val debug = new DebugBundle
335}
336
337class ExternalInterruptIO(implicit p: Parameters) extends XSBundle {
338  val mtip = Input(Bool())
339  val msip = Input(Bool())
340  val meip = Input(Bool())
341  val seip = Input(Bool())
342  val debug = Input(Bool())
343}
344
345class CSRSpecialIO(implicit p: Parameters) extends XSBundle {
346  val exception = Flipped(ValidIO(new MicroOp))
347  val isInterrupt = Input(Bool())
348  val memExceptionVAddr = Input(UInt(VAddrBits.W))
349  val trapTarget = Output(UInt(VAddrBits.W))
350  val externalInterrupt = new ExternalInterruptIO
351  val interrupt = Output(Bool())
352}
353
354class ExceptionInfo(implicit p: Parameters) extends XSBundleWithMicroOp {
355  val isInterrupt = Bool()
356}
357
358class RobCommitInfo(implicit p: Parameters) extends XSBundle {
359  val ldest = UInt(5.W)
360  val rfWen = Bool()
361  val fpWen = Bool()
362  val wflags = Bool()
363  val commitType = CommitType()
364  val pdest = UInt(PhyRegIdxWidth.W)
365  val old_pdest = UInt(PhyRegIdxWidth.W)
366  val ftqIdx = new FtqPtr
367  val ftqOffset = UInt(log2Up(PredictWidth).W)
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 = Output(Bool())
375  val commitValid = Vec(CommitWidth, Output(Bool()))
376
377  val isWalk = Output(Bool())
378  // valid bits optimized for walk
379  val walkValid = Vec(CommitWidth, Output(Bool()))
380
381  val info = Vec(CommitWidth, Output(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 move_elim_enable = Output(Bool())
498  // Decode
499  val svinval_enable = Output(Bool())
500
501  // distribute csr write signal
502  val distribute_csr = new DistributedCSRIO()
503
504  val singlestep = Output(Bool())
505  val frontend_trigger = new FrontendTdataDistributeIO()
506  val mem_trigger = new MemTdataDistributeIO()
507  val trigger_enable = Output(Vec(10, Bool()))
508}
509
510class DistributedCSRIO(implicit p: Parameters) extends XSBundle {
511  // CSR has been written by csr inst, copies of csr should be updated
512  val w = ValidIO(new Bundle {
513    val addr = Output(UInt(12.W))
514    val data = Output(UInt(XLEN.W))
515  })
516}
517
518class DistributedCSRUpdateReq(implicit p: Parameters) extends XSBundle {
519  // Request csr to be updated
520  //
521  // Note that this request will ONLY update CSR Module it self,
522  // copies of csr will NOT be updated, use it with care!
523  //
524  // For each cycle, no more than 1 DistributedCSRUpdateReq is valid
525  val w = ValidIO(new Bundle {
526    val addr = Output(UInt(12.W))
527    val data = Output(UInt(XLEN.W))
528  })
529  def apply(valid: Bool, addr: UInt, data: UInt, src_description: String) = {
530    when(valid){
531      w.bits.addr := addr
532      w.bits.data := data
533    }
534    println("Distributed CSR update req registered for " + src_description)
535  }
536}
537
538class L1CacheErrorInfo(implicit p: Parameters) extends XSBundle {
539  // L1CacheErrorInfo is also used to encode customized CACHE_ERROR CSR
540  val source = Output(new Bundle() {
541    val tag = Bool() // l1 tag array
542    val data = Bool() // l1 data array
543    val l2 = Bool()
544  })
545  val opType = Output(new Bundle() {
546    val fetch = Bool()
547    val load = Bool()
548    val store = Bool()
549    val probe = Bool()
550    val release = Bool()
551    val atom = Bool()
552  })
553  val paddr = Output(UInt(PAddrBits.W))
554
555  // report error and paddr to beu
556  // bus error unit will receive error info iff ecc_error.valid
557  val report_to_beu = Output(Bool())
558
559  // there is an valid error
560  // l1 cache error will always be report to CACHE_ERROR csr
561  val valid = Output(Bool())
562
563  def toL1BusErrorUnitInfo(): L1BusErrorUnitInfo = {
564    val beu_info = Wire(new L1BusErrorUnitInfo)
565    beu_info.ecc_error.valid := report_to_beu
566    beu_info.ecc_error.bits := paddr
567    beu_info
568  }
569}
570
571/* TODO how to trigger on next inst?
5721. If hit is determined at frontend, then set a "next instr" trap at dispatch like singlestep
5732. 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
574xret csr to pc + 4/ + 2
5752.5 The problem is to let it commit. This is the real TODO
5763. If it is load and hit before just treat it as regular load exception
577 */
578
579// This bundle carries trigger hit info along the pipeline
580// Now there are 10 triggers divided into 5 groups of 2
581// These groups are
582// (if if) (store store) (load loid) (if store) (if load)
583
584// Triggers in the same group can chain, meaning that they only
585// fire is both triggers in the group matches (the triggerHitVec bit is asserted)
586// Chaining of trigger No. (2i) and (2i+1) is indicated by triggerChainVec(i)
587// Timing of 0 means trap at current inst, 1 means trap at next inst
588// Chaining and timing and the validness of a trigger is controlled by csr
589// In two chained triggers, if they have different timing, both won't fire
590//class TriggerCf (implicit p: Parameters) extends XSBundle {
591//  val triggerHitVec = Vec(10, Bool())
592//  val triggerTiming = Vec(10, Bool())
593//  val triggerChainVec = Vec(5, Bool())
594//}
595
596class TriggerCf(implicit p: Parameters) extends XSBundle {
597  // frontend
598  val frontendHit = Vec(4, Bool())
599//  val frontendTiming = Vec(4, Bool())
600//  val frontendHitNext = Vec(4, Bool())
601
602//  val frontendException = Bool()
603  // backend
604  val backendEn = Vec(2, Bool()) // Hit(6) && chain(4) , Hit(8) && chain(4)
605  val backendHit = Vec(6, Bool())
606//  val backendTiming = Vec(6, Bool()) // trigger enable fro chain
607
608  // Two situations not allowed:
609  // 1. load data comparison
610  // 2. store chaining with store
611  def getHitFrontend = frontendHit.reduce(_ || _)
612  def getHitBackend = backendHit.reduce(_ || _)
613  def hit = getHitFrontend || getHitBackend
614  def clear(): Unit = {
615    frontendHit.foreach(_ := false.B)
616    backendEn.foreach(_ := false.B)
617    backendHit.foreach(_ := false.B)
618  }
619}
620
621// these 3 bundles help distribute trigger control signals from CSR
622// to Frontend, Load and Store.
623class FrontendTdataDistributeIO(implicit p: Parameters)  extends XSBundle {
624    val t = Valid(new Bundle {
625      val addr = Output(UInt(2.W))
626      val tdata = new MatchTriggerIO
627    })
628  }
629
630class MemTdataDistributeIO(implicit p: Parameters)  extends XSBundle {
631  val t = Valid(new Bundle {
632    val addr = Output(UInt(3.W))
633    val tdata = new MatchTriggerIO
634  })
635}
636
637class MatchTriggerIO(implicit p: Parameters) extends XSBundle {
638  val matchType = Output(UInt(2.W))
639  val select = Output(Bool())
640  val timing = Output(Bool())
641  val action = Output(Bool())
642  val chain = Output(Bool())
643  val tdata2 = Output(UInt(64.W))
644}
645