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