xref: /XiangShan/src/main/scala/xiangshan/Bundle.scala (revision b03c55a5df5dc8793cb44b42dd60141566e57e78)
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 org.chipsalliance.cde.config.Parameters
20import chisel3._
21import chisel3.util.BitPat.bitPatToUInt
22import chisel3.util._
23import utility._
24import utils._
25import xiangshan.backend.decode.{ImmUnion, XDecode}
26import xiangshan.backend.fu.FuType
27import xiangshan.backend.rob.RobPtr
28import xiangshan.frontend._
29import xiangshan.mem.{LqPtr, SqPtr}
30import xiangshan.backend.Bundles.{DynInst, UopIdx}
31import xiangshan.backend.fu.vector.Bundles.VType
32import xiangshan.frontend.{AllAheadFoldedHistoryOldestBits, AllFoldedHistories, BPUCtrl, CGHPtr, FtqPtr, FtqToCtrlIO}
33import xiangshan.frontend.{Ftq_Redirect_SRAMEntry, HasBPUParameter, IfuToBackendIO, PreDecodeInfo, RASPtr}
34import xiangshan.cache.HasDCacheParameters
35import utility._
36
37import org.chipsalliance.cde.config.Parameters
38import chisel3.util.BitPat.bitPatToUInt
39import chisel3.util.experimental.decode.EspressoMinimizer
40import xiangshan.backend.CtrlToFtqIO
41import xiangshan.backend.fu.NewCSR.{Mcontrol, Tdata1Bundle, Tdata2Bundle}
42import xiangshan.backend.fu.PMPEntry
43import xiangshan.frontend.Ftq_Redirect_SRAMEntry
44import xiangshan.frontend.AllFoldedHistories
45import xiangshan.frontend.AllAheadFoldedHistoryOldestBits
46import xiangshan.frontend.RASPtr
47import xiangshan.backend.rob.RobBundles.RobCommitEntryBundle
48
49class ValidUndirectioned[T <: Data](gen: T) extends Bundle {
50  val valid = Bool()
51  val bits = gen.cloneType.asInstanceOf[T]
52
53}
54
55object ValidUndirectioned {
56  def apply[T <: Data](gen: T) = {
57    new ValidUndirectioned[T](gen)
58  }
59}
60
61object RSFeedbackType {
62  val lrqFull         = 0.U(4.W)
63  val tlbMiss         = 1.U(4.W)
64  val mshrFull        = 2.U(4.W)
65  val dataInvalid     = 3.U(4.W)
66  val bankConflict    = 4.U(4.W)
67  val ldVioCheckRedo  = 5.U(4.W)
68  val feedbackInvalid = 7.U(4.W)
69  val issueSuccess    = 8.U(4.W)
70  val rfArbitFail     = 9.U(4.W)
71  val fuIdle          = 10.U(4.W)
72  val fuBusy          = 11.U(4.W)
73  val fuUncertain     = 12.U(4.W)
74
75  val allTypes = 16
76  def apply() = UInt(4.W)
77
78  def isStageSuccess(feedbackType: UInt) = {
79    feedbackType === issueSuccess
80  }
81
82  def isBlocked(feedbackType: UInt) = {
83    feedbackType === rfArbitFail || feedbackType === fuBusy || feedbackType >= lrqFull && feedbackType <= feedbackInvalid
84  }
85}
86
87class PredictorAnswer(implicit p: Parameters) extends XSBundle {
88  val hit    = if (!env.FPGAPlatform) Bool() else UInt(0.W)
89  val taken  = if (!env.FPGAPlatform) Bool() else UInt(0.W)
90  val target = if (!env.FPGAPlatform) UInt(VAddrBits.W) else UInt(0.W)
91}
92
93class CfiUpdateInfo(implicit p: Parameters) extends XSBundle with HasBPUParameter {
94  // from backend
95  val pc = UInt(VAddrBits.W)
96  // frontend -> backend -> frontend
97  val pd = new PreDecodeInfo
98  val ssp = UInt(log2Up(RasSize).W)
99  val sctr = UInt(RasCtrSize.W)
100  val TOSW = new RASPtr
101  val TOSR = new RASPtr
102  val NOS = new RASPtr
103  val topAddr = UInt(VAddrBits.W)
104  // val hist = new ShiftingGlobalHistory
105  val folded_hist = new AllFoldedHistories(foldedGHistInfos)
106  val afhob = new AllAheadFoldedHistoryOldestBits(foldedGHistInfos)
107  val lastBrNumOH = UInt((numBr+1).W)
108  val ghr = UInt(UbtbGHRLength.W)
109  val histPtr = new CGHPtr
110  val specCnt = Vec(numBr, UInt(10.W))
111  // need pipeline update
112  val br_hit = Bool() // if in ftb entry
113  val jr_hit = Bool() // if in ftb entry
114  val sc_hit = Bool() // if used in ftb entry, invalid if !br_hit
115  val predTaken = Bool()
116  val target = UInt(VAddrBits.W)
117  val taken = Bool()
118  val isMisPred = Bool()
119  val shift = UInt((log2Ceil(numBr)+1).W)
120  val addIntoHist = Bool()
121
122  def fromFtqRedirectSram(entry: Ftq_Redirect_SRAMEntry) = {
123    // this.hist := entry.ghist
124    this.histPtr := entry.histPtr
125    this.ssp := entry.ssp
126    this.sctr := entry.sctr
127    this.TOSW := entry.TOSW
128    this.TOSR := entry.TOSR
129    this.NOS := entry.NOS
130    this.topAddr := entry.topAddr
131    this
132  }
133}
134
135// Dequeue DecodeWidth insts from Ibuffer
136class CtrlFlow(implicit p: Parameters) extends XSBundle {
137  val instr = UInt(32.W)
138  val pc = UInt(VAddrBits.W)
139  val foldpc = UInt(MemPredPCWidth.W)
140  val exceptionVec = ExceptionVec()
141  val trigger = new TriggerCf
142  val pd = new PreDecodeInfo
143  val pred_taken = Bool()
144  val crossPageIPFFix = Bool()
145  val storeSetHit = Bool() // inst has been allocated an store set
146  val waitForRobIdx = new RobPtr // store set predicted previous store robIdx
147  // Load wait is needed
148  // load inst will not be executed until former store (predicted by mdp) addr calcuated
149  val loadWaitBit = Bool()
150  // If (loadWaitBit && loadWaitStrict), strict load wait is needed
151  // load inst will not be executed until ALL former store addr calcuated
152  val loadWaitStrict = Bool()
153  val ssid = UInt(SSIDWidth.W)
154  val ftqPtr = new FtqPtr
155  val ftqOffset = UInt(log2Up(PredictWidth).W)
156}
157
158
159class FPUCtrlSignals(implicit p: Parameters) extends XSBundle {
160  val isAddSub = Bool() // swap23
161  val typeTagIn = UInt(1.W)
162  val typeTagOut = UInt(1.W)
163  val fromInt = Bool()
164  val wflags = Bool()
165  val fpWen = Bool()
166  val fmaCmd = UInt(2.W)
167  val div = Bool()
168  val sqrt = Bool()
169  val fcvt = Bool()
170  val typ = UInt(2.W)
171  val fmt = UInt(2.W)
172  val ren3 = Bool() //TODO: remove SrcType.fp
173  val rm = UInt(3.W)
174}
175
176// Decode DecodeWidth insts at Decode Stage
177class CtrlSignals(implicit p: Parameters) extends XSBundle {
178  val debug_globalID = UInt(XLEN.W)
179  val srcType = Vec(4, SrcType())
180  val lsrc = Vec(4, UInt(LogicRegsWidth.W))
181  val ldest = UInt(LogicRegsWidth.W)
182  val fuType = FuType()
183  val fuOpType = FuOpType()
184  val rfWen = Bool()
185  val fpWen = Bool()
186  val vecWen = Bool()
187  val isXSTrap = Bool()
188  val noSpecExec = Bool() // wait forward
189  val blockBackward = Bool() // block backward
190  val flushPipe = Bool() // This inst will flush all the pipe when commit, like exception but can commit
191  val uopSplitType = UopSplitType()
192  val selImm = SelImm()
193  val imm = UInt(32.W)
194  val commitType = CommitType()
195  val fpu = new FPUCtrlSignals
196  val uopIdx = UopIdx()
197  val isMove = Bool()
198  val vm = Bool()
199  val singleStep = Bool()
200  // This inst will flush all the pipe when it is the oldest inst in ROB,
201  // then replay from this inst itself
202  val replayInst = Bool()
203  val canRobCompress = Bool()
204
205  private def allSignals = srcType.take(3) ++ Seq(fuType, fuOpType, rfWen, fpWen, vecWen,
206    isXSTrap, noSpecExec, blockBackward, flushPipe, canRobCompress, uopSplitType, selImm)
207
208  def decode(inst: UInt, table: Iterable[(BitPat, List[BitPat])]): CtrlSignals = {
209    val decoder = freechips.rocketchip.rocket.DecodeLogic(inst, XDecode.decodeDefault, table, EspressoMinimizer)
210    allSignals zip decoder foreach { case (s, d) => s := d }
211    commitType := DontCare
212    this
213  }
214
215  def decode(bit: List[BitPat]): CtrlSignals = {
216    allSignals.zip(bit.map(bitPatToUInt(_))).foreach{ case (s, d) => s := d }
217    this
218  }
219
220  def isWFI: Bool = fuType === FuType.csr.U && fuOpType === CSROpType.wfi
221  def isSoftPrefetch: Bool = {
222    fuType === FuType.alu.U && fuOpType === ALUOpType.or && selImm === SelImm.IMM_I && ldest === 0.U
223  }
224  def needWriteRf: Bool = (rfWen && ldest =/= 0.U) || fpWen || vecWen
225  def isHyperInst: Bool = {
226    fuType === FuType.ldu.U && LSUOpType.isHlv(fuOpType) || fuType === FuType.stu.U && LSUOpType.isHsv(fuOpType)
227  }
228}
229
230class CfCtrl(implicit p: Parameters) extends XSBundle {
231  val cf = new CtrlFlow
232  val ctrl = new CtrlSignals
233}
234
235class PerfDebugInfo(implicit p: Parameters) extends XSBundle {
236  val eliminatedMove = Bool()
237  // val fetchTime = UInt(XLEN.W)
238  val renameTime = UInt(XLEN.W)
239  val dispatchTime = UInt(XLEN.W)
240  val enqRsTime = UInt(XLEN.W)
241  val selectTime = UInt(XLEN.W)
242  val issueTime = UInt(XLEN.W)
243  val writebackTime = UInt(XLEN.W)
244  // val commitTime = UInt(XLEN.W)
245  val runahead_checkpoint_id = UInt(XLEN.W)
246  val tlbFirstReqTime = UInt(XLEN.W)
247  val tlbRespTime = UInt(XLEN.W) // when getting hit result (including delay in L2TLB hit)
248}
249
250// Separate LSQ
251class LSIdx(implicit p: Parameters) extends XSBundle {
252  val lqIdx = new LqPtr
253  val sqIdx = new SqPtr
254}
255
256// CfCtrl -> MicroOp at Rename Stage
257class MicroOp(implicit p: Parameters) extends CfCtrl {
258  val srcState = Vec(4, SrcState())
259  val psrc = Vec(4, UInt(PhyRegIdxWidth.W))
260  val pdest = UInt(PhyRegIdxWidth.W)
261  val robIdx = new RobPtr
262  val instrSize = UInt(log2Ceil(RenameWidth + 1).W)
263  val lqIdx = new LqPtr
264  val sqIdx = new SqPtr
265  val eliminatedMove = Bool()
266  val snapshot = Bool()
267  val debugInfo = new PerfDebugInfo
268  def needRfRPort(index: Int, isFp: Boolean, ignoreState: Boolean = true) : Bool = {
269    val stateReady = srcState(index) === SrcState.rdy || ignoreState.B
270    val readReg = if (isFp) {
271      ctrl.srcType(index) === SrcType.fp
272    } else {
273      ctrl.srcType(index) === SrcType.reg && ctrl.lsrc(index) =/= 0.U
274    }
275    readReg && stateReady
276  }
277  def srcIsReady: Vec[Bool] = {
278    VecInit(ctrl.srcType.zip(srcState).map{ case (t, s) => SrcType.isPcOrImm(t) || s === SrcState.rdy })
279  }
280  def clearExceptions(
281    exceptionBits: Seq[Int] = Seq(),
282    flushPipe: Boolean = false,
283    replayInst: Boolean = false
284  ): MicroOp = {
285    cf.exceptionVec.zipWithIndex.filterNot(x => exceptionBits.contains(x._2)).foreach(_._1 := false.B)
286    if (!flushPipe) { ctrl.flushPipe := false.B }
287    if (!replayInst) { ctrl.replayInst := false.B }
288    this
289  }
290}
291
292class XSBundleWithMicroOp(implicit p: Parameters) extends XSBundle {
293  val uop = new DynInst
294}
295
296class MicroOpRbExt(implicit p: Parameters) extends XSBundleWithMicroOp {
297  val flag = UInt(1.W)
298}
299
300class Redirect(implicit p: Parameters) extends XSBundle {
301  val isRVC = Bool()
302  val robIdx = new RobPtr
303  val ftqIdx = new FtqPtr
304  val ftqOffset = UInt(log2Up(PredictWidth).W)
305  val level = RedirectLevel()
306  val interrupt = Bool()
307  val cfiUpdate = new CfiUpdateInfo
308
309  val stFtqIdx = new FtqPtr // for load violation predict
310  val stFtqOffset = UInt(log2Up(PredictWidth).W)
311
312  val debug_runahead_checkpoint_id = UInt(64.W)
313  val debugIsCtrl = Bool()
314  val debugIsMemVio = Bool()
315
316  def flushItself() = RedirectLevel.flushItself(level)
317}
318
319class ResetPregStateReq(implicit p: Parameters) extends XSBundle {
320  // NOTE: set isInt and isFp both to 'false' when invalid
321  val isInt = Bool()
322  val isFp = Bool()
323  val isVec = Bool()
324  val isV0 = Bool()
325  val isVl = Bool()
326  val preg = UInt(PhyRegIdxWidth.W)
327}
328
329class DebugBundle(implicit p: Parameters) extends XSBundle {
330  val isMMIO = Bool()
331  val isPerfCnt = Bool()
332  val paddr = UInt(PAddrBits.W)
333  val vaddr = UInt(VAddrBits.W)
334  /* add L/S inst info in EXU */
335  // val L1toL2TlbLatency = UInt(XLEN.W)
336  // val levelTlbHit = UInt(2.W)
337}
338
339class ExternalInterruptIO(implicit p: Parameters) extends XSBundle {
340  val mtip = Input(Bool())
341  val msip = Input(Bool())
342  val meip = Input(Bool())
343  val seip = Input(Bool())
344  val debug = Input(Bool())
345}
346
347class CSRSpecialIO(implicit p: Parameters) extends XSBundle {
348  val exception = Flipped(ValidIO(new DynInst))
349  val isInterrupt = Input(Bool())
350  val memExceptionVAddr = Input(UInt(VAddrBits.W))
351  val trapTarget = Output(UInt(VAddrBits.W))
352  val externalInterrupt = new ExternalInterruptIO
353  val interrupt = Output(Bool())
354}
355
356class DiffCommitIO(implicit p: Parameters) extends XSBundle {
357  val isCommit = Bool()
358  val commitValid = Vec(CommitWidth * MaxUopSize, Bool())
359
360  val info = Vec(CommitWidth * MaxUopSize, new RabCommitInfo)
361}
362
363class RobCommitInfo(implicit p: Parameters) extends RobCommitEntryBundle
364
365class RobCommitIO(implicit p: Parameters) extends XSBundle {
366  val isCommit = Bool()
367  val commitValid = Vec(CommitWidth, Bool())
368
369  val isWalk = Bool()
370  // valid bits optimized for walk
371  val walkValid = Vec(CommitWidth, Bool())
372
373  val info = Vec(CommitWidth, new RobCommitInfo)
374  val robIdx = Vec(CommitWidth, new RobPtr)
375
376  def hasWalkInstr: Bool = isWalk && walkValid.asUInt.orR
377  def hasCommitInstr: Bool = isCommit && commitValid.asUInt.orR
378}
379
380class RabCommitInfo(implicit p: Parameters) extends XSBundle {
381  val ldest = UInt(LogicRegsWidth.W)
382  val pdest = UInt(PhyRegIdxWidth.W)
383  val rfWen = Bool()
384  val fpWen = Bool()
385  val vecWen = Bool()
386  val v0Wen = Bool()
387  val vlWen = Bool()
388  val isMove = Bool()
389}
390
391class RabCommitIO(implicit p: Parameters) extends XSBundle {
392  val isCommit = Bool()
393  val commitValid = Vec(RabCommitWidth, Bool())
394
395  val isWalk = Bool()
396  // valid bits optimized for walk
397  val walkValid = Vec(RabCommitWidth, Bool())
398
399  val info = Vec(RabCommitWidth, new RabCommitInfo)
400  val robIdx = OptionWrapper(!env.FPGAPlatform, Vec(RabCommitWidth, new RobPtr))
401
402  def hasWalkInstr: Bool = isWalk && walkValid.asUInt.orR
403  def hasCommitInstr: Bool = isCommit && commitValid.asUInt.orR
404}
405
406class SnapshotPort(implicit p: Parameters) extends XSBundle {
407  val snptEnq = Bool()
408  val snptDeq = Bool()
409  val useSnpt = Bool()
410  val snptSelect = UInt(log2Ceil(RenameSnapshotNum).W)
411  val flushVec = Vec(RenameSnapshotNum, Bool())
412}
413
414class RSFeedback(isVector: Boolean = false)(implicit p: Parameters) extends XSBundle {
415  val robIdx = new RobPtr
416  val hit = Bool()
417  val flushState = Bool()
418  val sourceType = RSFeedbackType()
419  val dataInvalidSqIdx = new SqPtr
420  val sqIdx = new SqPtr
421  val lqIdx = new LqPtr
422}
423
424class MemRSFeedbackIO(isVector: Boolean = false)(implicit p: Parameters) extends XSBundle {
425  // Note: you need to update in implicit Parameters p before imp MemRSFeedbackIO
426  // for instance: MemRSFeedbackIO()(updateP)
427  val feedbackSlow = ValidIO(new RSFeedback(isVector)) // dcache miss queue full, dtlb miss
428  val feedbackFast = ValidIO(new RSFeedback(isVector)) // bank conflict
429}
430
431class LoadCancelIO(implicit p: Parameters) extends XSBundle {
432  val ld1Cancel = Bool()
433  val ld2Cancel = Bool()
434}
435
436class FrontendToCtrlIO(implicit p: Parameters) extends XSBundle {
437  // to backend end
438  val cfVec = Vec(DecodeWidth, DecoupledIO(new CtrlFlow))
439  val stallReason = new StallReasonIO(DecodeWidth)
440  val fromFtq = new FtqToCtrlIO
441  val fromIfu = new IfuToBackendIO
442  // from backend
443  val toFtq = Flipped(new CtrlToFtqIO)
444  val canAccept = Input(Bool())
445}
446
447class SatpStruct(implicit p: Parameters) extends XSBundle {
448  val mode = UInt(4.W)
449  val asid = UInt(16.W)
450  val ppn  = UInt(44.W)
451}
452
453class TlbSatpBundle(implicit p: Parameters) extends SatpStruct {
454  val changed = Bool()
455
456  // Todo: remove it
457  def apply(satp_value: UInt): Unit = {
458    require(satp_value.getWidth == XLEN)
459    val sa = satp_value.asTypeOf(new SatpStruct)
460    mode := sa.mode
461    asid := sa.asid
462    ppn := Cat(0.U((44-PAddrBits).W), sa.ppn(PAddrBits-1, 0)).asUInt
463    changed := DataChanged(sa.asid) // when ppn is changed, software need do the flush
464  }
465}
466
467class TlbCsrBundle(implicit p: Parameters) extends XSBundle {
468  val satp = new TlbSatpBundle()
469  val vsatp = new TlbSatpBundle()
470  val hgatp = new TlbSatpBundle()
471  val priv = new Bundle {
472    val mxr = Bool()
473    val sum = Bool()
474    val vmxr = Bool()
475    val vsum = Bool()
476    val virt = Bool()
477    val spvp = UInt(1.W)
478    val imode = UInt(2.W)
479    val dmode = UInt(2.W)
480  }
481
482  override def toPrintable: Printable = {
483    p"Satp mode:0x${Hexadecimal(satp.mode)} asid:0x${Hexadecimal(satp.asid)} ppn:0x${Hexadecimal(satp.ppn)} " +
484      p"Priv mxr:${priv.mxr} sum:${priv.sum} imode:${priv.imode} dmode:${priv.dmode}"
485  }
486}
487
488class SfenceBundle(implicit p: Parameters) extends XSBundle {
489  val valid = Bool()
490  val bits = new Bundle {
491    val rs1 = Bool()
492    val rs2 = Bool()
493    val addr = UInt(VAddrBits.W)
494    val id = UInt((AsidLength).W) // asid or vmid
495    val flushPipe = Bool()
496    val hv = Bool()
497    val hg = Bool()
498  }
499
500  override def toPrintable: Printable = {
501    p"valid:0x${Hexadecimal(valid)} rs1:${bits.rs1} rs2:${bits.rs2} addr:${Hexadecimal(bits.addr)}, flushPipe:${bits.flushPipe}"
502  }
503}
504
505// Bundle for load violation predictor updating
506class MemPredUpdateReq(implicit p: Parameters) extends XSBundle  {
507  val valid = Bool()
508
509  // wait table update
510  val waddr = UInt(MemPredPCWidth.W)
511  val wdata = Bool() // true.B by default
512
513  // store set update
514  // by default, ldpc/stpc should be xor folded
515  val ldpc = UInt(MemPredPCWidth.W)
516  val stpc = UInt(MemPredPCWidth.W)
517}
518
519class CustomCSRCtrlIO(implicit p: Parameters) extends XSBundle {
520  // Prefetcher
521  val l1I_pf_enable = Output(Bool())
522  val l2_pf_enable = Output(Bool())
523  val l1D_pf_enable = Output(Bool())
524  val l1D_pf_train_on_hit = Output(Bool())
525  val l1D_pf_enable_agt = Output(Bool())
526  val l1D_pf_enable_pht = Output(Bool())
527  val l1D_pf_active_threshold = Output(UInt(4.W))
528  val l1D_pf_active_stride = Output(UInt(6.W))
529  val l1D_pf_enable_stride = Output(Bool())
530  val l2_pf_store_only = Output(Bool())
531  // ICache
532  val icache_parity_enable = Output(Bool())
533  // Load violation predictor
534  val lvpred_disable = Output(Bool())
535  val no_spec_load = Output(Bool())
536  val storeset_wait_store = Output(Bool())
537  val storeset_no_fast_wakeup = Output(Bool())
538  val lvpred_timeout = Output(UInt(5.W))
539  // Branch predictor
540  val bp_ctrl = Output(new BPUCtrl)
541  // Memory Block
542  val sbuffer_threshold = Output(UInt(4.W))
543  val ldld_vio_check_enable = Output(Bool())
544  val soft_prefetch_enable = Output(Bool())
545  val cache_error_enable = Output(Bool())
546  val uncache_write_outstanding_enable = Output(Bool())
547  // Rename
548  val fusion_enable = Output(Bool())
549  val wfi_enable = Output(Bool())
550
551  // distribute csr write signal
552  val distribute_csr = new DistributedCSRIO()
553  // TODO: move it to a new bundle, since single step is not a custom control signal
554  val singlestep = Output(Bool())
555  val frontend_trigger = new FrontendTdataDistributeIO()
556  val mem_trigger = new MemTdataDistributeIO()
557  // Virtualization Mode
558  val virtMode = Output(Bool())
559}
560
561class DistributedCSRIO(implicit p: Parameters) extends XSBundle {
562  // CSR has been written by csr inst, copies of csr should be updated
563  val w = ValidIO(new Bundle {
564    val addr = Output(UInt(12.W))
565    val data = Output(UInt(XLEN.W))
566  })
567}
568
569class DistributedCSRUpdateReq(implicit p: Parameters) extends XSBundle {
570  // Request csr to be updated
571  //
572  // Note that this request will ONLY update CSR Module it self,
573  // copies of csr will NOT be updated, use it with care!
574  //
575  // For each cycle, no more than 1 DistributedCSRUpdateReq is valid
576  val w = ValidIO(new Bundle {
577    val addr = Output(UInt(12.W))
578    val data = Output(UInt(XLEN.W))
579  })
580  def apply(valid: Bool, addr: UInt, data: UInt, src_description: String) = {
581    when(valid){
582      w.bits.addr := addr
583      w.bits.data := data
584    }
585    println("Distributed CSR update req registered for " + src_description)
586  }
587}
588
589class L1CacheErrorInfo(implicit p: Parameters) extends XSBundle {
590  // L1CacheErrorInfo is also used to encode customized CACHE_ERROR CSR
591  val source = Output(new Bundle() {
592    val tag = Bool() // l1 tag array
593    val data = Bool() // l1 data array
594    val l2 = Bool()
595  })
596  val opType = Output(new Bundle() {
597    val fetch = Bool()
598    val load = Bool()
599    val store = Bool()
600    val probe = Bool()
601    val release = Bool()
602    val atom = Bool()
603  })
604  val paddr = Output(UInt(PAddrBits.W))
605
606  // report error and paddr to beu
607  // bus error unit will receive error info iff ecc_error.valid
608  val report_to_beu = Output(Bool())
609
610  def toL1BusErrorUnitInfo(valid: Bool): L1BusErrorUnitInfo = {
611    val beu_info = Wire(new L1BusErrorUnitInfo)
612    beu_info.ecc_error.valid := valid && report_to_beu
613    beu_info.ecc_error.bits := paddr
614    beu_info
615  }
616}
617
618class TriggerCf(implicit p: Parameters) extends XSBundle {
619  // frontend
620  val frontendHit       = Vec(TriggerNum, Bool()) // en && hit
621  val frontendCanFire   = Vec(TriggerNum, Bool())
622  // backend
623  val backendHit        = Vec(TriggerNum, Bool())
624  val backendCanFire    = Vec(TriggerNum, Bool())
625
626  // Two situations not allowed:
627  // 1. load data comparison
628  // 2. store chaining with store
629  def getFrontendCanFire = frontendCanFire.reduce(_ || _)
630  def getBackendCanFire = backendCanFire.reduce(_ || _)
631  def canFire = getFrontendCanFire || getBackendCanFire
632  def clear(): Unit = {
633    frontendHit.foreach(_ := false.B)
634    frontendCanFire.foreach(_ := false.B)
635    backendHit.foreach(_ := false.B)
636    backendCanFire.foreach(_ := false.B)
637  }
638}
639
640// these 3 bundles help distribute trigger control signals from CSR
641// to Frontend, Load and Store.
642class FrontendTdataDistributeIO(implicit p: Parameters) extends XSBundle {
643  val tUpdate = ValidIO(new Bundle {
644    val addr = Output(UInt(log2Up(TriggerNum).W))
645    val tdata = new MatchTriggerIO
646  })
647  val tEnableVec: Vec[Bool] = Output(Vec(TriggerNum, Bool()))
648}
649
650class MemTdataDistributeIO(implicit p: Parameters) extends XSBundle {
651  val tUpdate = ValidIO(new Bundle {
652    val addr = Output(UInt(log2Up(TriggerNum).W))
653    val tdata = new MatchTriggerIO
654  })
655  val tEnableVec: Vec[Bool] = Output(Vec(TriggerNum, Bool()))
656  val triggerCanRaiseBpExp  = Output(Bool())
657}
658
659class MatchTriggerIO(implicit p: Parameters) extends XSBundle {
660  val matchType = Output(UInt(2.W))
661  val select    = Output(Bool()) // todo: delete
662  val timing    = Output(Bool())
663  val action    = Output(Bool()) // todo: delete
664  val chain     = Output(Bool())
665  val execute   = Output(Bool()) // todo: delete
666  val store     = Output(Bool())
667  val load      = Output(Bool())
668  val tdata2    = Output(UInt(64.W))
669
670  def GenTdataDistribute(tdata1: Tdata1Bundle, tdata2: Tdata2Bundle): MatchTriggerIO = {
671    val mcontrol = Wire(new Mcontrol)
672    mcontrol := tdata1.DATA.asUInt
673    this.matchType := mcontrol.MATCH.asUInt
674    this.select    := mcontrol.SELECT.asBool
675    this.timing    := mcontrol.TIMING.asBool
676    this.action    := mcontrol.ACTION.asUInt
677    this.chain     := mcontrol.CHAIN.asBool
678    this.execute   := mcontrol.EXECUTE.asBool
679    this.load      := mcontrol.LOAD.asBool
680    this.store     := mcontrol.STORE.asBool
681    this.tdata2    := tdata2.asUInt
682    this
683  }
684}
685
686class StallReasonIO(width: Int) extends Bundle {
687  val reason = Output(Vec(width, UInt(log2Ceil(TopDownCounters.NumStallReasons.id).W)))
688  val backReason = Flipped(Valid(UInt(log2Ceil(TopDownCounters.NumStallReasons.id).W)))
689}
690
691// custom l2 - l1 interface
692class L2ToL1Hint(implicit p: Parameters) extends XSBundle with HasDCacheParameters {
693  val sourceId = UInt(log2Up(cfg.nMissEntries).W)    // tilelink sourceID -> mshr id
694  val isKeyword = Bool()                             // miss entry keyword -> L1 load queue replay
695}
696
697