xref: /XiangShan/src/main/scala/xiangshan/backend/fu/CSR.scala (revision 5d13017ec21a682fa7c9fb193ba217ea13795ed3)
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.backend.fu
18
19import chipsalliance.rocketchip.config.Parameters
20import chisel3._
21import chisel3.util._
22import difftest._
23import freechips.rocketchip.util._
24import utility.MaskedRegMap.WritableMask
25import utils._
26import utility._
27import xiangshan.ExceptionNO._
28import xiangshan._
29import xiangshan.backend.fu.util._
30import xiangshan.cache._
31
32// Trigger Tdata1 bundles
33trait HasTriggerConst {
34  def I_Trigger = 0.U
35  def S_Trigger = 1.U
36  def L_Trigger = 2.U
37  def GenESL(triggerType: UInt) = Cat((triggerType === I_Trigger), (triggerType === S_Trigger), (triggerType === L_Trigger))
38}
39
40class TdataBundle extends Bundle {
41  val ttype = UInt(4.W)
42  val dmode = Bool()
43  val maskmax = UInt(6.W)
44  val zero1 = UInt(30.W)
45  val sizehi = UInt(2.W)
46  val hit = Bool()
47  val select = Bool()
48  val timing = Bool()
49  val sizelo = UInt(2.W)
50  val action = UInt(4.W)
51  val chain = Bool()
52  val matchType = UInt(4.W)
53  val m = Bool()
54  val zero2 = Bool()
55  val s = Bool()
56  val u = Bool()
57  val execute = Bool()
58  val store = Bool()
59  val load = Bool()
60}
61
62class FpuCsrIO extends Bundle {
63  val fflags = Output(Valid(UInt(5.W)))
64  val isIllegal = Output(Bool())
65  val dirty_fs = Output(Bool())
66  val frm = Input(UInt(3.W))
67}
68
69
70class PerfCounterIO(implicit p: Parameters) extends XSBundle {
71  val perfEventsFrontend  = Vec(numCSRPCntFrontend, new PerfEvent)
72  val perfEventsCtrl      = Vec(numCSRPCntCtrl, new PerfEvent)
73  val perfEventsLsu       = Vec(numCSRPCntLsu, new PerfEvent)
74  val perfEventsHc        = Vec(numPCntHc * coreParams.L2NBanks, new PerfEvent)
75  val retiredInstr = UInt(3.W)
76  val frontendInfo = new Bundle {
77    val ibufFull  = Bool()
78    val bpuInfo = new Bundle {
79      val bpRight = UInt(XLEN.W)
80      val bpWrong = UInt(XLEN.W)
81    }
82  }
83  val ctrlInfo = new Bundle {
84    val robFull   = Bool()
85    val intdqFull = Bool()
86    val fpdqFull  = Bool()
87    val lsdqFull  = Bool()
88  }
89  val memInfo = new Bundle {
90    val sqFull = Bool()
91    val lqFull = Bool()
92    val dcacheMSHRFull = Bool()
93  }
94
95  val cacheInfo = new Bundle {
96    val l2MSHRFull = Bool()
97    val l3MSHRFull = Bool()
98    val l2nAcquire = UInt(XLEN.W)
99    val l2nAcquireMiss = UInt(XLEN.W)
100    val l3nAcquire = UInt(XLEN.W)
101    val l3nAcquireMiss = UInt(XLEN.W)
102  }
103}
104
105class CSRFileIO(implicit p: Parameters) extends XSBundle {
106  val hartId = Input(UInt(8.W))
107  // output (for func === CSROpType.jmp)
108  val perf = Input(new PerfCounterIO)
109  val isPerfCnt = Output(Bool())
110  // to FPU
111  val fpu = Flipped(new FpuCsrIO)
112  // from rob
113  val exception = Flipped(ValidIO(new ExceptionInfo))
114  // to ROB
115  val isXRet = Output(Bool())
116  val trapTarget = Output(UInt(VAddrBits.W))
117  val interrupt = Output(Bool())
118  val wfi_event = Output(Bool())
119  // from LSQ
120  val memExceptionVAddr = Input(UInt(VAddrBits.W))
121  // from outside cpu,externalInterrupt
122  val externalInterrupt = new ExternalInterruptIO
123  // TLB
124  val tlb = Output(new TlbCsrBundle)
125  // Debug Mode
126  // val singleStep = Output(Bool())
127  val debugMode = Output(Bool())
128  // to Fence to disable sfence
129  val disableSfence = Output(Bool())
130  // Custom microarchiture ctrl signal
131  val customCtrl = Output(new CustomCSRCtrlIO)
132  // distributed csr write
133  val distributedUpdate = Vec(2, Flipped(new DistributedCSRUpdateReq))
134}
135
136class CSR(implicit p: Parameters) extends FunctionUnit with HasCSRConst with PMPMethod with PMAMethod with HasTriggerConst
137{
138  val csrio = IO(new CSRFileIO)
139
140  val cfIn = io.in.bits.uop.cf
141  val cfOut = Wire(new CtrlFlow)
142  cfOut := cfIn
143  val flushPipe = Wire(Bool())
144
145  val (valid, src1, src2, func) = (
146    io.in.valid,
147    io.in.bits.src(0),
148    io.in.bits.uop.ctrl.imm,
149    io.in.bits.uop.ctrl.fuOpType
150  )
151
152  // CSR define
153
154  class Priv extends Bundle {
155    val m = Output(Bool())
156    val h = Output(Bool())
157    val s = Output(Bool())
158    val u = Output(Bool())
159  }
160
161  val csrNotImplemented = RegInit(UInt(XLEN.W), 0.U)
162
163  class DcsrStruct extends Bundle {
164    val xdebugver = Output(UInt(2.W))
165    val zero4 = Output(UInt(2.W))
166    val zero3 = Output(UInt(12.W))
167    val ebreakm = Output(Bool())
168    val ebreakh = Output(Bool())
169    val ebreaks = Output(Bool())
170    val ebreaku = Output(Bool())
171    val stepie = Output(Bool()) // 0
172    val stopcycle = Output(Bool())
173    val stoptime = Output(Bool())
174    val cause = Output(UInt(3.W))
175    val v = Output(Bool()) // 0
176    val mprven = Output(Bool())
177    val nmip = Output(Bool())
178    val step = Output(Bool())
179    val prv = Output(UInt(2.W))
180  }
181
182  class MstatusStruct extends Bundle {
183    val sd = Output(UInt(1.W))
184
185    val pad1 = if (XLEN == 64) Output(UInt(25.W)) else null
186    val mbe  = if (XLEN == 64) Output(UInt(1.W)) else null
187    val sbe  = if (XLEN == 64) Output(UInt(1.W)) else null
188    val sxl  = if (XLEN == 64) Output(UInt(2.W))  else null
189    val uxl  = if (XLEN == 64) Output(UInt(2.W))  else null
190    val pad0 = if (XLEN == 64) Output(UInt(9.W))  else Output(UInt(8.W))
191
192    val tsr = Output(UInt(1.W))
193    val tw = Output(UInt(1.W))
194    val tvm = Output(UInt(1.W))
195    val mxr = Output(UInt(1.W))
196    val sum = Output(UInt(1.W))
197    val mprv = Output(UInt(1.W))
198    val xs = Output(UInt(2.W))
199    val fs = Output(UInt(2.W))
200    val mpp = Output(UInt(2.W))
201    val hpp = Output(UInt(2.W))
202    val spp = Output(UInt(1.W))
203    val pie = new Priv
204    val ie = new Priv
205    assert(this.getWidth == XLEN)
206
207    def ube = pie.h // a little ugly
208    def ube_(r: UInt): Unit = {
209      pie.h := r(0)
210    }
211  }
212
213  class Interrupt extends Bundle {
214//  val d = Output(Bool())    // Debug
215    val e = new Priv
216    val t = new Priv
217    val s = new Priv
218  }
219
220  // Debug CSRs
221  val dcsr = RegInit(UInt(32.W), 0x4000b000.U)
222  val dpc = Reg(UInt(64.W))
223  val dscratch = Reg(UInt(64.W))
224  val dscratch1 = Reg(UInt(64.W))
225  val debugMode = RegInit(false.B)
226  val debugIntrEnable = RegInit(true.B)
227  csrio.debugMode := debugMode
228
229  val dpcPrev = RegNext(dpc)
230  XSDebug(dpcPrev =/= dpc, "Debug Mode: dpc is altered! Current is %x, previous is %x\n", dpc, dpcPrev)
231
232  // dcsr value table
233  // | debugver | 0100
234  // | zero     | 10 bits of 0
235  // | ebreakvs | 0
236  // | ebreakvu | 0
237  // | ebreakm  | 1 if ebreak enters debug
238  // | zero     | 0
239  // | ebreaks  |
240  // | ebreaku  |
241  // | stepie   | disable interrupts in singlestep
242  // | stopcount| stop counter, 0
243  // | stoptime | stop time, 0
244  // | cause    | 3 bits read only
245  // | v        | 0
246  // | mprven   | 1
247  // | nmip     | read only
248  // | step     |
249  // | prv      | 2 bits
250
251  val dcsrData = Wire(new DcsrStruct)
252  dcsrData := dcsr.asTypeOf(new DcsrStruct)
253  val dcsrMask = ZeroExt(GenMask(15) | GenMask(13, 11) | GenMask(4) | GenMask(2, 0), XLEN)// Dcsr write mask
254  def dcsrUpdateSideEffect(dcsr: UInt): UInt = {
255    val dcsrOld = WireInit(dcsr.asTypeOf(new DcsrStruct))
256    val dcsrNew = dcsr | (dcsrOld.prv(0) | dcsrOld.prv(1)).asUInt // turn 10 priv into 11
257    dcsrNew
258  }
259  // csrio.singleStep := dcsrData.step
260  csrio.customCtrl.singlestep := dcsrData.step && !debugMode
261
262  // Trigger CSRs
263
264  val type_config = Array(
265    0.U -> I_Trigger, 1.U -> I_Trigger,
266    2.U -> S_Trigger, 3.U -> S_Trigger,
267    4.U -> L_Trigger, 5.U -> L_Trigger, // No.5 Load Trigger
268    6.U -> I_Trigger, 7.U -> S_Trigger,
269    8.U -> I_Trigger, 9.U -> L_Trigger
270  )
271  def TypeLookup(select: UInt) = MuxLookup(select, I_Trigger, type_config)
272
273  val tdata1Phy = RegInit(VecInit(List.fill(10) {(2L << 60L).U(64.W)})) // init ttype 2
274  val tdata2Phy = Reg(Vec(10, UInt(64.W)))
275  val tselectPhy = RegInit(0.U(4.W))
276  val tinfo = RegInit(2.U(64.W))
277  val tControlPhy = RegInit(0.U(64.W))
278  val triggerAction = RegInit(false.B)
279
280  def ReadTdata1(rdata: UInt) = rdata | Cat(triggerAction, 0.U(12.W)) // fix action
281  def WriteTdata1(wdata: UInt): UInt = {
282    val tdata1 = WireInit(tdata1Phy(tselectPhy).asTypeOf(new TdataBundle))
283    val wdata_wire = WireInit(wdata.asTypeOf(new TdataBundle))
284    val tdata1_new = WireInit(wdata.asTypeOf(new TdataBundle))
285    XSDebug(src2(11, 0) === Tdata1.U && valid && func =/= CSROpType.jmp, p"Debug Mode: tdata1(${tselectPhy})is written, the actual value is ${wdata}\n")
286//    tdata1_new.hit := wdata(20)
287    tdata1_new.ttype := tdata1.ttype
288    tdata1_new.dmode := 0.U // Mux(debugMode, wdata_wire.dmode, tdata1.dmode)
289    tdata1_new.maskmax := 0.U
290    tdata1_new.hit := 0.U
291    tdata1_new.select := (TypeLookup(tselectPhy) === I_Trigger) && wdata_wire.select
292    when(wdata_wire.action <= 1.U){
293      triggerAction := tdata1_new.action(0)
294    } .otherwise{
295      tdata1_new.action := tdata1.action
296    }
297    tdata1_new.timing := false.B // hardwire this because we have singlestep
298    tdata1_new.zero1 := 0.U
299    tdata1_new.zero2 := 0.U
300    tdata1_new.chain := !tselectPhy(0) && wdata_wire.chain
301    when(wdata_wire.matchType =/= 0.U && wdata_wire.matchType =/= 2.U && wdata_wire.matchType =/= 3.U) {
302      tdata1_new.matchType := tdata1.matchType
303    }
304    tdata1_new.sizehi := Mux(wdata_wire.select && TypeLookup(tselectPhy) === I_Trigger, 0.U, 1.U)
305    tdata1_new.sizelo:= Mux(wdata_wire.select && TypeLookup(tselectPhy) === I_Trigger, 3.U, 1.U)
306    tdata1_new.execute := TypeLookup(tselectPhy) === I_Trigger
307    tdata1_new.store := TypeLookup(tselectPhy) === S_Trigger
308    tdata1_new.load := TypeLookup(tselectPhy) === L_Trigger
309    tdata1_new.asUInt
310  }
311
312  def WriteTselect(wdata: UInt) = {
313    Mux(wdata < 10.U, wdata(3, 0), tselectPhy)
314  }
315
316  val tcontrolWriteMask = ZeroExt(GenMask(3) | GenMask(7), XLEN)
317
318
319  def GenTdataDistribute(tdata1: TdataBundle, tdata2: UInt): MatchTriggerIO = {
320    val res = Wire(new MatchTriggerIO)
321    res.matchType := tdata1.matchType
322    res.select := tdata1.select
323    res.timing := tdata1.timing
324    res.action := triggerAction
325    res.chain := tdata1.chain
326    res.tdata2 := tdata2
327    res
328  }
329
330  csrio.customCtrl.frontend_trigger.t.bits.addr := MuxLookup(tselectPhy, 0.U, Seq(
331    0.U -> 0.U,
332    1.U -> 1.U,
333    6.U -> 2.U,
334    8.U -> 3.U
335  ))
336  csrio.customCtrl.mem_trigger.t.bits.addr := MuxLookup(tselectPhy, 0.U, Seq(
337    2.U -> 0.U,
338    3.U -> 1.U,
339    4.U -> 2.U,
340    5.U -> 3.U,
341    7.U -> 4.U,
342    9.U -> 5.U
343  ))
344  csrio.customCtrl.frontend_trigger.t.bits.tdata := GenTdataDistribute(tdata1Phy(tselectPhy).asTypeOf(new TdataBundle), tdata2Phy(tselectPhy))
345  csrio.customCtrl.mem_trigger.t.bits.tdata := GenTdataDistribute(tdata1Phy(tselectPhy).asTypeOf(new TdataBundle), tdata2Phy(tselectPhy))
346
347  // Machine-Level CSRs
348  // mtvec: {BASE (WARL), MODE (WARL)} where mode is 0 or 1
349  val mtvecMask = ~(0x2.U(XLEN.W))
350  val mtvec = RegInit(UInt(XLEN.W), 0.U)
351  val mcounteren = RegInit(UInt(XLEN.W), 0.U)
352  val mcause = RegInit(UInt(XLEN.W), 0.U)
353  val mtval = RegInit(UInt(XLEN.W), 0.U)
354  val mepc = Reg(UInt(XLEN.W))
355  // Page 36 in riscv-priv: The low bit of mepc (mepc[0]) is always zero.
356  val mepcMask = ~(0x1.U(XLEN.W))
357
358  val mie = RegInit(0.U(XLEN.W))
359  val mipWire = WireInit(0.U.asTypeOf(new Interrupt))
360  val mipReg  = RegInit(0.U(XLEN.W))
361  val mipFixMask = ZeroExt(GenMask(9) | GenMask(5) | GenMask(1), XLEN)
362  val mip = (mipWire.asUInt | mipReg).asTypeOf(new Interrupt)
363
364  def getMisaMxl(mxl: BigInt): BigInt = mxl << (XLEN - 2)
365  def getMisaExt(ext: Char): Long = 1 << (ext.toInt - 'a'.toInt)
366  var extList = List('a', 's', 'i', 'u')
367  if (HasMExtension) { extList = extList :+ 'm' }
368  if (HasCExtension) { extList = extList :+ 'c' }
369  if (HasFPU) { extList = extList ++ List('f', 'd') }
370  val misaInitVal = getMisaMxl(2) | extList.foldLeft(0L)((sum, i) => sum | getMisaExt(i)) //"h8000000000141105".U
371  val misa = RegInit(UInt(XLEN.W), misaInitVal.U)
372
373  // MXL = 2          | 0 | EXT = b 00 0000 0100 0001 0001 0000 0101
374  // (XLEN-1, XLEN-2) |   |(25, 0)  ZY XWVU TSRQ PONM LKJI HGFE DCBA
375
376  val mvendorid = RegInit(UInt(XLEN.W), 0.U) // this is a non-commercial implementation
377  val marchid = RegInit(UInt(XLEN.W), 25.U) // architecture id for XiangShan is 25; see https://github.com/riscv/riscv-isa-manual/blob/master/marchid.md
378  val mimpid = RegInit(UInt(XLEN.W), 0.U) // provides a unique encoding of the version of the processor implementation
379  val mhartid = Reg(UInt(XLEN.W)) // the hardware thread running the code
380  when (RegNext(RegNext(reset.asBool) && !reset.asBool)) {
381    mhartid := csrio.hartId
382  }
383  val mconfigptr = RegInit(UInt(XLEN.W), 0.U) // the read-only pointer pointing to the platform config structure, 0 for not supported.
384  val mstatus = RegInit("ha00002000".U(XLEN.W))
385
386  // mstatus Value Table
387  // | sd   |
388  // | pad1 |
389  // | sxl  | hardlinked to 10, use 00 to pass xv6 test
390  // | uxl  | hardlinked to 10
391  // | pad0 |
392  // | tsr  |
393  // | tw   |
394  // | tvm  |
395  // | mxr  |
396  // | sum  |
397  // | mprv |
398  // | xs   | 00 |
399  // | fs   | 01 |
400  // | mpp  | 00 |
401  // | hpp  | 00 |
402  // | spp  | 0 |
403  // | pie  | 0000 | pie.h is used as UBE
404  // | ie   | 0000 | uie hardlinked to 0, as N ext is not implemented
405
406  val mstatusStruct = mstatus.asTypeOf(new MstatusStruct)
407  def mstatusUpdateSideEffect(mstatus: UInt): UInt = {
408    val mstatusOld = WireInit(mstatus.asTypeOf(new MstatusStruct))
409    val mstatusNew = Cat(mstatusOld.xs === "b11".U || mstatusOld.fs === "b11".U, mstatus(XLEN-2, 0))
410    mstatusNew
411  }
412
413  val mstatusWMask = (~ZeroExt((
414    GenMask(XLEN - 2, 36) | // WPRI
415    GenMask(35, 32)       | // SXL and UXL cannot be changed
416    GenMask(31, 23)       | // WPRI
417    GenMask(16, 15)       | // XS is read-only
418    GenMask(10, 9)        | // WPRI
419    GenMask(6)            | // WPRI
420    GenMask(2)              // WPRI
421  ), 64)).asUInt
422  val mstatusMask = (~ZeroExt((
423    GenMask(XLEN - 2, 36) | // WPRI
424    GenMask(31, 23)       | // WPRI
425    GenMask(10, 9)        | // WPRI
426    GenMask(6)            | // WPRI
427    GenMask(2)              // WPRI
428  ), 64)).asUInt
429
430  val medeleg = RegInit(UInt(XLEN.W), 0.U)
431  val mideleg = RegInit(UInt(XLEN.W), 0.U)
432  val mscratch = RegInit(UInt(XLEN.W), 0.U)
433
434  // PMP Mapping
435  val pmp = Wire(Vec(NumPMP, new PMPEntry())) // just used for method parameter
436  val pma = Wire(Vec(NumPMA, new PMPEntry())) // just used for method parameter
437  val pmpMapping = pmp_gen_mapping(pmp_init, NumPMP, PmpcfgBase, PmpaddrBase, pmp)
438  val pmaMapping = pmp_gen_mapping(pma_init, NumPMA, PmacfgBase, PmaaddrBase, pma)
439
440  // Superviser-Level CSRs
441
442  // val sstatus = RegInit(UInt(XLEN.W), "h00000000".U)
443  val sstatusWmask = "hc6122".U(XLEN.W)
444  // Sstatus Write Mask
445  // -------------------------------------------------------
446  //    19           9   5     2
447  // 0  1100 0000 0001 0010 0010
448  // 0  c    0    1    2    2
449  // -------------------------------------------------------
450  val sstatusRmask = sstatusWmask | "h8000000300018000".U
451  // Sstatus Read Mask = (SSTATUS_WMASK | (0xf << 13) | (1ull << 63) | (3ull << 32))
452  // stvec: {BASE (WARL), MODE (WARL)} where mode is 0 or 1
453  val stvecMask = ~(0x2.U(XLEN.W))
454  val stvec = RegInit(UInt(XLEN.W), 0.U)
455  // val sie = RegInit(0.U(XLEN.W))
456  val sieMask = "h222".U & mideleg
457  val sipMask = "h222".U & mideleg
458  val sipWMask = "h2".U(XLEN.W) // ssip is writeable in smode
459  val satp = if(EnbaleTlbDebug) RegInit(UInt(XLEN.W), "h8000000000087fbe".U) else RegInit(0.U(XLEN.W))
460  // val satp = RegInit(UInt(XLEN.W), "h8000000000087fbe".U) // only use for tlb naive debug
461  // val satpMask = "h80000fffffffffff".U(XLEN.W) // disable asid, mode can only be 8 / 0
462  // TODO: use config to control the length of asid
463  // val satpMask = "h8fffffffffffffff".U(XLEN.W) // enable asid, mode can only be 8 / 0
464  val satpMask = Cat("h8".U(Satp_Mode_len.W), satp_part_wmask(Satp_Asid_len, AsidLength), satp_part_wmask(Satp_Addr_len, PAddrBits-12))
465  val sepc = RegInit(UInt(XLEN.W), 0.U)
466  // Page 60 in riscv-priv: The low bit of sepc (sepc[0]) is always zero.
467  val sepcMask = ~(0x1.U(XLEN.W))
468  val scause = RegInit(UInt(XLEN.W), 0.U)
469  val stval = Reg(UInt(XLEN.W))
470  val sscratch = RegInit(UInt(XLEN.W), 0.U)
471  val scounteren = RegInit(UInt(XLEN.W), 0.U)
472
473  // sbpctl
474  // Bits 0-7: {LOOP, RAS, SC, TAGE, BIM, BTB, uBTB}
475  val sbpctl = RegInit(UInt(XLEN.W), "h7f".U)
476  csrio.customCtrl.bp_ctrl.ubtb_enable := sbpctl(0)
477  csrio.customCtrl.bp_ctrl.btb_enable  := sbpctl(1)
478  csrio.customCtrl.bp_ctrl.bim_enable  := sbpctl(2)
479  csrio.customCtrl.bp_ctrl.tage_enable := sbpctl(3)
480  csrio.customCtrl.bp_ctrl.sc_enable   := sbpctl(4)
481  csrio.customCtrl.bp_ctrl.ras_enable  := sbpctl(5)
482  csrio.customCtrl.bp_ctrl.loop_enable := sbpctl(6)
483
484  // spfctl Bit 0: L1I Cache Prefetcher Enable
485  // spfctl Bit 1: L2Cache Prefetcher Enable
486  // spfctl Bit 2: L1D Cache Prefetcher Enable
487  // spfctl Bit 3: L1D train prefetch on hit
488  // spfctl Bit 4: L1D prefetch enable agt
489  // spfctl Bit 5: L1D prefetch enable pht
490  // turn off L2 BOP, turn on L1 SMS by default
491  val spfctl = RegInit(UInt(XLEN.W), Cat(
492    30.U(6.W), // L1D active page stride [12:7]
493    12.U(4.W), // L1D active page threshold [9:6]
494    true.B,    // L1D enable pht [5]
495    true.B,    // L1D enable agt [4]
496    false.B,   // L1D train on hit agt [3]
497    true.B,    // L1D pf enable [2]
498    false.B,   // L2 pf enable [1]
499    true.B,    // L1I pf enable [0]
500  ))
501  csrio.customCtrl.l1I_pf_enable := spfctl(0)
502  csrio.customCtrl.l2_pf_enable := spfctl(1)
503  csrio.customCtrl.l1D_pf_enable := spfctl(2)
504  csrio.customCtrl.l1D_pf_train_on_hit := spfctl(3)
505  csrio.customCtrl.l1D_pf_enable_agt := spfctl(4)
506  csrio.customCtrl.l1D_pf_enable_pht := spfctl(5)
507  csrio.customCtrl.l1D_pf_active_threshold := spfctl(9, 6)
508  csrio.customCtrl.l1D_pf_active_stride := spfctl(12, 7)
509
510  // sfetchctl Bit 0: L1I Cache Parity check enable
511  val sfetchctl = RegInit(UInt(XLEN.W), "b0".U)
512  csrio.customCtrl.icache_parity_enable := sfetchctl(0)
513
514  // sdsid: Differentiated Services ID
515  val sdsid = RegInit(UInt(XLEN.W), 0.U)
516  csrio.customCtrl.dsid := sdsid
517
518  // slvpredctl: load violation predict settings
519  // Default reset period: 2^16
520  // Why this number: reset more frequently while keeping the overhead low
521  // Overhead: extra two redirections in every 64K cycles => ~0.1% overhead
522  val slvpredctl = RegInit(UInt(XLEN.W), "h60".U)
523  csrio.customCtrl.lvpred_disable := slvpredctl(0)
524  csrio.customCtrl.no_spec_load := slvpredctl(1)
525  csrio.customCtrl.storeset_wait_store := slvpredctl(2)
526  csrio.customCtrl.storeset_no_fast_wakeup := slvpredctl(3)
527  csrio.customCtrl.lvpred_timeout := slvpredctl(8, 4)
528
529  //  smblockctl: memory block configurations
530  //  +------------------------------+---+----+----+-----+--------+
531  //  |XLEN-1                       8| 7 | 6  | 5  |  4  |3      0|
532  //  +------------------------------+---+----+----+-----+--------+
533  //  |           Reserved           | O | CE | SP | LVC |   Th   |
534  //  +------------------------------+---+----+----+-----+--------+
535  //  Description:
536  //  Bit 3-0   : Store buffer flush threshold (Th).
537  //  Bit 4     : Enable load violation check after reset (LVC).
538  //  Bit 5     : Enable soft-prefetch after reset (SP).
539  //  Bit 6     : Enable cache error after reset (CE).
540  //  Bit 7     : Enable uncache write outstanding (O).
541  //  Others    : Reserved.
542
543  val smblockctl_init_val =
544    (0xf & StoreBufferThreshold) |
545    (EnableLdVioCheckAfterReset.toInt << 4) |
546    (EnableSoftPrefetchAfterReset.toInt << 5) |
547    (EnableCacheErrorAfterReset.toInt << 6)
548    (EnableUncacheWriteOutstanding.toInt << 7)
549  val smblockctl = RegInit(UInt(XLEN.W), smblockctl_init_val.U)
550  csrio.customCtrl.sbuffer_threshold := smblockctl(3, 0)
551  // bits 4: enable load load violation check
552  csrio.customCtrl.ldld_vio_check_enable := smblockctl(4)
553  csrio.customCtrl.soft_prefetch_enable := smblockctl(5)
554  csrio.customCtrl.cache_error_enable := smblockctl(6)
555  csrio.customCtrl.uncache_write_outstanding_enable := smblockctl(7)
556
557  println("CSR smblockctl init value:")
558  println("  Store buffer replace threshold: " + StoreBufferThreshold)
559  println("  Enable ld-ld vio check after reset: " + EnableLdVioCheckAfterReset)
560  println("  Enable soft prefetch after reset: " + EnableSoftPrefetchAfterReset)
561  println("  Enable cache error after reset: " + EnableCacheErrorAfterReset)
562  println("  Enable uncache write outstanding: " + EnableUncacheWriteOutstanding)
563
564  val srnctl = RegInit(UInt(XLEN.W), "h7".U)
565  csrio.customCtrl.fusion_enable := srnctl(0)
566  csrio.customCtrl.svinval_enable := srnctl(1)
567  csrio.customCtrl.wfi_enable := srnctl(2)
568
569  val tlbBundle = Wire(new TlbCsrBundle)
570  tlbBundle.satp.apply(satp)
571
572  csrio.tlb := tlbBundle
573
574  // User-Level CSRs
575  val uepc = Reg(UInt(XLEN.W))
576
577  // fcsr
578  class FcsrStruct extends Bundle {
579    val reserved = UInt((XLEN-3-5).W)
580    val frm = UInt(3.W)
581    val fflags = UInt(5.W)
582    assert(this.getWidth == XLEN)
583  }
584  val fcsr = RegInit(0.U(XLEN.W))
585  // set mstatus->sd and mstatus->fs when true
586  val csrw_dirty_fp_state = WireInit(false.B)
587
588  def frm_wfn(wdata: UInt): UInt = {
589    val fcsrOld = WireInit(fcsr.asTypeOf(new FcsrStruct))
590    csrw_dirty_fp_state := true.B
591    fcsrOld.frm := wdata(2,0)
592    fcsrOld.asUInt
593  }
594  def frm_rfn(rdata: UInt): UInt = rdata(7,5)
595
596  def fflags_wfn(update: Boolean)(wdata: UInt): UInt = {
597    val fcsrOld = fcsr.asTypeOf(new FcsrStruct)
598    val fcsrNew = WireInit(fcsrOld)
599    csrw_dirty_fp_state := true.B
600    if (update) {
601      fcsrNew.fflags := wdata(4,0) | fcsrOld.fflags
602    } else {
603      fcsrNew.fflags := wdata(4,0)
604    }
605    fcsrNew.asUInt
606  }
607  def fflags_rfn(rdata:UInt): UInt = rdata(4,0)
608
609  def fcsr_wfn(wdata: UInt): UInt = {
610    val fcsrOld = WireInit(fcsr.asTypeOf(new FcsrStruct))
611    csrw_dirty_fp_state := true.B
612    Cat(fcsrOld.reserved, wdata.asTypeOf(fcsrOld).frm, wdata.asTypeOf(fcsrOld).fflags)
613  }
614
615  val fcsrMapping = Map(
616    MaskedRegMap(Fflags, fcsr, wfn = fflags_wfn(update = false), rfn = fflags_rfn),
617    MaskedRegMap(Frm, fcsr, wfn = frm_wfn, rfn = frm_rfn),
618    MaskedRegMap(Fcsr, fcsr, wfn = fcsr_wfn)
619  )
620
621  // Hart Priviledge Mode
622  val priviledgeMode = RegInit(UInt(2.W), ModeM)
623
624  //val perfEventscounten = List.fill(nrPerfCnts)(RegInit(false(Bool())))
625  // Perf Counter
626  val nrPerfCnts = 29  // 3...31
627  val priviledgeModeOH = UIntToOH(priviledgeMode)
628  val perfEventscounten = RegInit(0.U.asTypeOf(Vec(nrPerfCnts, Bool())))
629  val perfCnts   = List.fill(nrPerfCnts)(RegInit(0.U(XLEN.W)))
630  val perfEvents = List.fill(8)(RegInit("h0000000000".U(XLEN.W))) ++
631                   List.fill(8)(RegInit("h4010040100".U(XLEN.W))) ++
632                   List.fill(8)(RegInit("h8020080200".U(XLEN.W))) ++
633                   List.fill(5)(RegInit("hc0300c0300".U(XLEN.W)))
634  for (i <-0 until nrPerfCnts) {
635    perfEventscounten(i) := (Cat(perfEvents(i)(62),perfEvents(i)(61),(perfEvents(i)(61,60))) & priviledgeModeOH).orR
636  }
637
638  val hpmEvents = Wire(Vec(numPCntHc * coreParams.L2NBanks, new PerfEvent))
639  for (i <- 0 until numPCntHc * coreParams.L2NBanks) {
640    hpmEvents(i) := csrio.perf.perfEventsHc(i)
641  }
642
643  val csrevents = perfEvents.slice(24, 29)
644  val hpm_hc = HPerfMonitor(csrevents, hpmEvents)
645  val mcountinhibit = RegInit(0.U(XLEN.W))
646  val mcycle = RegInit(0.U(XLEN.W))
647  mcycle := mcycle + 1.U
648  val minstret = RegInit(0.U(XLEN.W))
649  val perf_events = csrio.perf.perfEventsFrontend ++
650                    csrio.perf.perfEventsCtrl ++
651                    csrio.perf.perfEventsLsu ++
652                    hpm_hc.getPerf
653  minstret := minstret + RegNext(csrio.perf.retiredInstr)
654  for(i <- 0 until 29){
655    perfCnts(i) := Mux(mcountinhibit(i+3) | !perfEventscounten(i), perfCnts(i), perfCnts(i) + perf_events(i).value)
656  }
657
658  // CSR reg map
659  val basicPrivMapping = Map(
660
661    //--- User Trap Setup ---
662    // MaskedRegMap(Ustatus, ustatus),
663    // MaskedRegMap(Uie, uie, 0.U, MaskedRegMap.Unwritable),
664    // MaskedRegMap(Utvec, utvec),
665
666    //--- User Trap Handling ---
667    // MaskedRegMap(Uscratch, uscratch),
668    // MaskedRegMap(Uepc, uepc),
669    // MaskedRegMap(Ucause, ucause),
670    // MaskedRegMap(Utval, utval),
671    // MaskedRegMap(Uip, uip),
672
673    //--- User Counter/Timers ---
674    // MaskedRegMap(Cycle, cycle),
675    // MaskedRegMap(Time, time),
676    // MaskedRegMap(Instret, instret),
677
678    //--- Supervisor Trap Setup ---
679    MaskedRegMap(Sstatus, mstatus, sstatusWmask, mstatusUpdateSideEffect, sstatusRmask),
680    // MaskedRegMap(Sedeleg, Sedeleg),
681    // MaskedRegMap(Sideleg, Sideleg),
682    MaskedRegMap(Sie, mie, sieMask, MaskedRegMap.NoSideEffect, sieMask),
683    MaskedRegMap(Stvec, stvec, stvecMask, MaskedRegMap.NoSideEffect, stvecMask),
684    MaskedRegMap(Scounteren, scounteren),
685
686    //--- Supervisor Trap Handling ---
687    MaskedRegMap(Sscratch, sscratch),
688    MaskedRegMap(Sepc, sepc, sepcMask, MaskedRegMap.NoSideEffect, sepcMask),
689    MaskedRegMap(Scause, scause),
690    MaskedRegMap(Stval, stval),
691    MaskedRegMap(Sip, mip.asUInt, sipWMask, MaskedRegMap.Unwritable, sipMask),
692
693    //--- Supervisor Protection and Translation ---
694    MaskedRegMap(Satp, satp, satpMask, MaskedRegMap.NoSideEffect, satpMask),
695
696    //--- Supervisor Custom Read/Write Registers
697    MaskedRegMap(Sbpctl, sbpctl),
698    MaskedRegMap(Spfctl, spfctl),
699    MaskedRegMap(Sfetchctl, sfetchctl),
700    MaskedRegMap(Sdsid, sdsid),
701    MaskedRegMap(Slvpredctl, slvpredctl),
702    MaskedRegMap(Smblockctl, smblockctl),
703    MaskedRegMap(Srnctl, srnctl),
704
705    //--- Machine Information Registers ---
706    MaskedRegMap(Mvendorid, mvendorid, 0.U(XLEN.W), MaskedRegMap.Unwritable),
707    MaskedRegMap(Marchid, marchid, 0.U(XLEN.W), MaskedRegMap.Unwritable),
708    MaskedRegMap(Mimpid, mimpid, 0.U(XLEN.W), MaskedRegMap.Unwritable),
709    MaskedRegMap(Mhartid, mhartid, 0.U(XLEN.W), MaskedRegMap.Unwritable),
710    MaskedRegMap(Mconfigptr, mconfigptr, 0.U(XLEN.W), MaskedRegMap.Unwritable),
711
712    //--- Machine Trap Setup ---
713    MaskedRegMap(Mstatus, mstatus, mstatusWMask, mstatusUpdateSideEffect, mstatusMask),
714    MaskedRegMap(Misa, misa, 0.U, MaskedRegMap.Unwritable), // now whole misa is unchangeable
715    MaskedRegMap(Medeleg, medeleg, "hb3ff".U(XLEN.W)),
716    MaskedRegMap(Mideleg, mideleg, "h222".U(XLEN.W)),
717    MaskedRegMap(Mie, mie),
718    MaskedRegMap(Mtvec, mtvec, mtvecMask, MaskedRegMap.NoSideEffect, mtvecMask),
719    MaskedRegMap(Mcounteren, mcounteren),
720
721    //--- Machine Trap Handling ---
722    MaskedRegMap(Mscratch, mscratch),
723    MaskedRegMap(Mepc, mepc, mepcMask, MaskedRegMap.NoSideEffect, mepcMask),
724    MaskedRegMap(Mcause, mcause),
725    MaskedRegMap(Mtval, mtval),
726    MaskedRegMap(Mip, mip.asUInt, 0.U(XLEN.W), MaskedRegMap.Unwritable),
727
728    //--- Trigger ---
729    MaskedRegMap(Tselect, tselectPhy, WritableMask, WriteTselect),
730    MaskedRegMap(Tdata1, tdata1Phy(tselectPhy), WritableMask, WriteTdata1, WritableMask, ReadTdata1),
731    MaskedRegMap(Tdata2, tdata2Phy(tselectPhy)),
732    MaskedRegMap(Tinfo, tinfo, 0.U(XLEN.W), MaskedRegMap.Unwritable),
733    MaskedRegMap(Tcontrol, tControlPhy, tcontrolWriteMask),
734
735    //--- Debug Mode ---
736    MaskedRegMap(Dcsr, dcsr, dcsrMask, dcsrUpdateSideEffect),
737    MaskedRegMap(Dpc, dpc),
738    MaskedRegMap(Dscratch, dscratch),
739    MaskedRegMap(Dscratch1, dscratch1),
740    MaskedRegMap(Mcountinhibit, mcountinhibit),
741    MaskedRegMap(Mcycle, mcycle),
742    MaskedRegMap(Minstret, minstret),
743  )
744
745  val perfCntMapping = (0 until 29).map(i => {Map(
746    MaskedRegMap(addr = Mhpmevent3 +i,
747                 reg  = perfEvents(i),
748                 wmask = "hf87fff3fcff3fcff".U(XLEN.W)),
749    MaskedRegMap(addr = Mhpmcounter3 +i,
750                 reg  = perfCnts(i))
751  )}).fold(Map())((a,b) => a ++ b)
752  // TODO: mechanism should be implemented later
753  // val MhpmcounterStart = Mhpmcounter3
754  // val MhpmeventStart   = Mhpmevent3
755  // for (i <- 0 until nrPerfCnts) {
756  //   perfCntMapping += MaskedRegMap(MhpmcounterStart + i, perfCnts(i))
757  //   perfCntMapping += MaskedRegMap(MhpmeventStart + i, perfEvents(i))
758  // }
759
760  val cacheopRegs = CacheInstrucion.CacheInsRegisterList.map{case (name, attribute) => {
761    name -> RegInit(0.U(attribute("width").toInt.W))
762  }}
763  val cacheopMapping = CacheInstrucion.CacheInsRegisterList.map{case (name, attribute) => {
764    MaskedRegMap(
765      Scachebase + attribute("offset").toInt,
766      cacheopRegs(name)
767    )
768  }}
769
770  val mapping = basicPrivMapping ++
771                perfCntMapping ++
772                pmpMapping ++
773                pmaMapping ++
774                (if (HasFPU) fcsrMapping else Nil) ++
775                (if (HasCustomCSRCacheOp) cacheopMapping else Nil)
776
777  val addr = src2(11, 0)
778  val csri = ZeroExt(src2(16, 12), XLEN)
779  val rdata = Wire(UInt(XLEN.W))
780  val wdata = LookupTree(func, List(
781    CSROpType.wrt  -> src1,
782    CSROpType.set  -> (rdata | src1),
783    CSROpType.clr  -> (rdata & (~src1).asUInt),
784    CSROpType.wrti -> csri,
785    CSROpType.seti -> (rdata | csri),
786    CSROpType.clri -> (rdata & (~csri).asUInt)
787  ))
788
789  val addrInPerfCnt = (addr >= Mcycle.U) && (addr <= Mhpmcounter31.U) ||
790    (addr >= Mcountinhibit.U) && (addr <= Mhpmevent31.U) ||
791    addr === Mip.U
792  csrio.isPerfCnt := addrInPerfCnt && valid && func =/= CSROpType.jmp
793
794  // satp wen check
795  val satpLegalMode = (wdata.asTypeOf(new SatpStruct).mode===0.U) || (wdata.asTypeOf(new SatpStruct).mode===8.U)
796
797  // csr access check, special case
798  val tvmNotPermit = (priviledgeMode === ModeS && mstatusStruct.tvm.asBool)
799  val accessPermitted = !(addr === Satp.U && tvmNotPermit)
800  csrio.disableSfence := tvmNotPermit
801
802  // general CSR wen check
803  val wen = valid && func =/= CSROpType.jmp && (addr=/=Satp.U || satpLegalMode)
804  val dcsrPermitted = dcsrPermissionCheck(addr, false.B, debugMode)
805  val triggerPermitted = triggerPermissionCheck(addr, true.B, debugMode) // todo dmode
806  val modePermitted = csrAccessPermissionCheck(addr, false.B, priviledgeMode) && dcsrPermitted && triggerPermitted
807  val perfcntPermitted = perfcntPermissionCheck(addr, priviledgeMode, mcounteren, scounteren)
808  val permitted = Mux(addrInPerfCnt, perfcntPermitted, modePermitted) && accessPermitted
809
810  MaskedRegMap.generate(mapping, addr, rdata, wen && permitted, wdata)
811  io.out.bits.data := rdata
812  io.out.bits.uop := io.in.bits.uop
813  io.out.bits.uop.cf := cfOut
814  io.out.bits.uop.ctrl.flushPipe := flushPipe
815
816  // send distribute csr a w signal
817  csrio.customCtrl.distribute_csr.w.valid := wen && permitted
818  csrio.customCtrl.distribute_csr.w.bits.data := wdata
819  csrio.customCtrl.distribute_csr.w.bits.addr := addr
820
821  // Fix Mip/Sip write
822  val fixMapping = Map(
823    MaskedRegMap(Mip, mipReg.asUInt, mipFixMask),
824    MaskedRegMap(Sip, mipReg.asUInt, sipWMask, MaskedRegMap.NoSideEffect, sipMask)
825  )
826  val rdataFix = Wire(UInt(XLEN.W))
827  val wdataFix = LookupTree(func, List(
828    CSROpType.wrt  -> src1,
829    CSROpType.set  -> (rdataFix | src1),
830    CSROpType.clr  -> (rdataFix & (~src1).asUInt),
831    CSROpType.wrti -> csri,
832    CSROpType.seti -> (rdataFix | csri),
833    CSROpType.clri -> (rdataFix & (~csri).asUInt)
834  ))
835  MaskedRegMap.generate(fixMapping, addr, rdataFix, wen && permitted, wdataFix)
836
837  when (RegNext(csrio.fpu.fflags.valid)) {
838    fcsr := fflags_wfn(update = true)(RegNext(csrio.fpu.fflags.bits))
839  }
840  // set fs and sd in mstatus
841  when (csrw_dirty_fp_state || RegNext(csrio.fpu.dirty_fs)) {
842    val mstatusNew = WireInit(mstatus.asTypeOf(new MstatusStruct))
843    mstatusNew.fs := "b11".U
844    mstatusNew.sd := true.B
845    mstatus := mstatusNew.asUInt
846  }
847  csrio.fpu.frm := fcsr.asTypeOf(new FcsrStruct).frm
848
849
850  // Trigger Ctrl
851  csrio.customCtrl.trigger_enable := tdata1Phy.map{t =>
852    def tdata1 = t.asTypeOf(new TdataBundle)
853    tdata1.m && priviledgeMode === ModeM ||
854    tdata1.s && priviledgeMode === ModeS || tdata1.u && priviledgeMode === ModeU
855  }
856  csrio.customCtrl.frontend_trigger.t.valid := RegNext(wen && (addr === Tdata1.U || addr === Tdata2.U) && TypeLookup(tselectPhy) === I_Trigger)
857  csrio.customCtrl.mem_trigger.t.valid := RegNext(wen && (addr === Tdata1.U || addr === Tdata2.U) && TypeLookup(tselectPhy) =/= I_Trigger)
858  XSDebug(csrio.customCtrl.trigger_enable.asUInt.orR, p"Debug Mode: At least 1 trigger is enabled," +
859    p"trigger enable is ${Binary(csrio.customCtrl.trigger_enable.asUInt)}\n")
860
861  // CSR inst decode
862  val isEbreak = addr === privEbreak && func === CSROpType.jmp
863  val isEcall  = addr === privEcall  && func === CSROpType.jmp
864  val isMret   = addr === privMret   && func === CSROpType.jmp
865  val isSret   = addr === privSret   && func === CSROpType.jmp
866  val isUret   = addr === privUret   && func === CSROpType.jmp
867  val isDret   = addr === privDret   && func === CSROpType.jmp
868  val isWFI    = func === CSROpType.wfi
869
870  XSDebug(wen, "csr write: pc %x addr %x rdata %x wdata %x func %x\n", cfIn.pc, addr, rdata, wdata, func)
871  XSDebug(wen, "pc %x mstatus %x mideleg %x medeleg %x mode %x\n", cfIn.pc, mstatus, mideleg , medeleg, priviledgeMode)
872
873  // Illegal priviledged operation list
874  val illegalMret = valid && isMret && priviledgeMode < ModeM
875  val illegalSret = valid && isSret && priviledgeMode < ModeS
876  val illegalSModeSret = valid && isSret && priviledgeMode === ModeS && mstatusStruct.tsr.asBool
877  // When TW=1, then if WFI is executed in any less-privileged mode,
878  // and it does not complete within an implementation-specific, bounded time limit,
879  // the WFI instruction causes an illegal instruction exception.
880  // The time limit may always be 0, in which case WFI always causes
881  // an illegal instruction exception in less-privileged modes when TW=1.
882  val illegalWFI = valid && isWFI && priviledgeMode < ModeM && mstatusStruct.tw === 1.U
883
884  // Illegal priviledged instruction check
885  val isIllegalAddr = valid && CSROpType.needAccess(func) && MaskedRegMap.isIllegalAddr(mapping, addr)
886  val isIllegalAccess = wen && !permitted
887  val isIllegalPrivOp = illegalMret || illegalSret || illegalSModeSret || illegalWFI
888
889  // expose several csr bits for tlb
890  tlbBundle.priv.mxr   := mstatusStruct.mxr.asBool
891  tlbBundle.priv.sum   := mstatusStruct.sum.asBool
892  tlbBundle.priv.imode := priviledgeMode
893  tlbBundle.priv.dmode := Mux(debugMode && dcsr.asTypeOf(new DcsrStruct).mprven, ModeM, Mux(mstatusStruct.mprv.asBool, mstatusStruct.mpp, priviledgeMode))
894
895  // Branch control
896  val retTarget = Wire(UInt(VAddrBits.W))
897  val resetSatp = addr === Satp.U && wen // write to satp will cause the pipeline be flushed
898  flushPipe := resetSatp || (valid && func === CSROpType.jmp && !isEcall && !isEbreak)
899
900  retTarget := DontCare
901  // val illegalEret = TODO
902
903  when (valid && isDret) {
904    val mstatusOld = WireInit(mstatus.asTypeOf(new MstatusStruct))
905    val mstatusNew = WireInit(mstatus.asTypeOf(new MstatusStruct))
906    val dcsrNew = WireInit(dcsr.asTypeOf(new DcsrStruct))
907    val debugModeNew = WireInit(debugMode)
908    when (dcsr.asTypeOf(new DcsrStruct).prv =/= ModeM) {mstatusNew.mprv := 0.U} //If the new privilege mode is less privileged than M-mode, MPRV in mstatus is cleared.
909    mstatus := mstatusNew.asUInt
910    priviledgeMode := dcsrNew.prv
911    retTarget := dpc(VAddrBits-1, 0)
912    debugModeNew := false.B
913    debugIntrEnable := true.B
914    debugMode := debugModeNew
915    XSDebug("Debug Mode: Dret executed, returning to %x.", retTarget)
916  }
917
918  when (valid && isMret && !illegalMret) {
919    val mstatusOld = WireInit(mstatus.asTypeOf(new MstatusStruct))
920    val mstatusNew = WireInit(mstatus.asTypeOf(new MstatusStruct))
921    mstatusNew.ie.m := mstatusOld.pie.m
922    priviledgeMode := mstatusOld.mpp
923    mstatusNew.pie.m := true.B
924    mstatusNew.mpp := ModeU
925    when (mstatusOld.mpp =/= ModeM) { mstatusNew.mprv := 0.U }
926    mstatus := mstatusNew.asUInt
927    // lr := false.B
928    retTarget := mepc(VAddrBits-1, 0)
929  }
930
931  when (valid && isSret && !illegalSret && !illegalSModeSret) {
932    val mstatusOld = WireInit(mstatus.asTypeOf(new MstatusStruct))
933    val mstatusNew = WireInit(mstatus.asTypeOf(new MstatusStruct))
934    mstatusNew.ie.s := mstatusOld.pie.s
935    priviledgeMode := Cat(0.U(1.W), mstatusOld.spp)
936    mstatusNew.pie.s := true.B
937    mstatusNew.spp := ModeU
938    mstatus := mstatusNew.asUInt
939    when (mstatusOld.spp =/= ModeM) { mstatusNew.mprv := 0.U }
940    // lr := false.B
941    retTarget := sepc(VAddrBits-1, 0)
942  }
943
944  when (valid && isUret) {
945    val mstatusOld = WireInit(mstatus.asTypeOf(new MstatusStruct))
946    val mstatusNew = WireInit(mstatus.asTypeOf(new MstatusStruct))
947    // mstatusNew.mpp.m := ModeU //TODO: add mode U
948    mstatusNew.ie.u := mstatusOld.pie.u
949    priviledgeMode := ModeU
950    mstatusNew.pie.u := true.B
951    mstatus := mstatusNew.asUInt
952    retTarget := uepc(VAddrBits-1, 0)
953  }
954
955  io.in.ready := true.B
956  io.out.valid := valid
957
958  val ebreakCauseException = (priviledgeMode === ModeM && dcsrData.ebreakm) || (priviledgeMode === ModeS && dcsrData.ebreaks) || (priviledgeMode === ModeU && dcsrData.ebreaku)
959
960  val csrExceptionVec = WireInit(cfIn.exceptionVec)
961  csrExceptionVec(breakPoint) := io.in.valid && isEbreak && (ebreakCauseException || debugMode)
962  csrExceptionVec(ecallM) := priviledgeMode === ModeM && io.in.valid && isEcall
963  csrExceptionVec(ecallS) := priviledgeMode === ModeS && io.in.valid && isEcall
964  csrExceptionVec(ecallU) := priviledgeMode === ModeU && io.in.valid && isEcall
965  // Trigger an illegal instr exception when:
966  // * unimplemented csr is being read/written
967  // * csr access is illegal
968  csrExceptionVec(illegalInstr) := isIllegalAddr || isIllegalAccess || isIllegalPrivOp
969  cfOut.exceptionVec := csrExceptionVec
970
971  XSDebug(io.in.valid && isEbreak, s"Debug Mode: an Ebreak is executed, ebreak cause exception ? ${ebreakCauseException}\n")
972
973  /**
974    * Exception and Intr
975    */
976  val ideleg =  (mideleg & mip.asUInt)
977  def priviledgedEnableDetect(x: Bool): Bool = Mux(x, ((priviledgeMode === ModeS) && mstatusStruct.ie.s) || (priviledgeMode < ModeS),
978    ((priviledgeMode === ModeM) && mstatusStruct.ie.m) || (priviledgeMode < ModeM))
979
980  val debugIntr = csrio.externalInterrupt.debug & debugIntrEnable
981  XSDebug(debugIntr, "Debug Mode: debug interrupt is asserted and valid!")
982  // send interrupt information to ROB
983  val intrVecEnable = Wire(Vec(12, Bool()))
984  val disableInterrupt = debugMode || (dcsrData.step && !dcsrData.stepie)
985  intrVecEnable.zip(ideleg.asBools).map{case(x,y) => x := priviledgedEnableDetect(y) && !disableInterrupt}
986  val intrVec = Cat(debugIntr && !debugMode, (mie(11,0) & mip.asUInt & intrVecEnable.asUInt))
987  val intrBitSet = intrVec.orR
988  csrio.interrupt := intrBitSet
989  // Page 45 in RISC-V Privileged Specification
990  // The WFI instruction can also be executed when interrupts are disabled. The operation of WFI
991  // must be unaffected by the global interrupt bits in mstatus (MIE and SIE) and the delegation
992  // register mideleg, but should honor the individual interrupt enables (e.g, MTIE).
993  csrio.wfi_event := debugIntr || (mie(11, 0) & mip.asUInt).orR
994  mipWire.t.m := csrio.externalInterrupt.mtip
995  mipWire.s.m := csrio.externalInterrupt.msip
996  mipWire.e.m := csrio.externalInterrupt.meip
997  mipWire.e.s := csrio.externalInterrupt.seip
998
999  // interrupts
1000  val intrNO = IntPriority.foldRight(0.U)((i: Int, sum: UInt) => Mux(intrVec(i), i.U, sum))
1001  val raiseIntr = csrio.exception.valid && csrio.exception.bits.isInterrupt
1002  val ivmEnable = tlbBundle.priv.imode < ModeM && satp.asTypeOf(new SatpStruct).mode === 8.U
1003  val iexceptionPC = Mux(ivmEnable, SignExt(csrio.exception.bits.uop.cf.pc, XLEN), csrio.exception.bits.uop.cf.pc)
1004  val dvmEnable = tlbBundle.priv.dmode < ModeM && satp.asTypeOf(new SatpStruct).mode === 8.U
1005  val dexceptionPC = Mux(dvmEnable, SignExt(csrio.exception.bits.uop.cf.pc, XLEN), csrio.exception.bits.uop.cf.pc)
1006  XSDebug(raiseIntr, "interrupt: pc=0x%x, %d\n", dexceptionPC, intrNO)
1007  val raiseDebugIntr = intrNO === IRQ_DEBUG.U && raiseIntr
1008
1009  // exceptions
1010  val raiseException = csrio.exception.valid && !csrio.exception.bits.isInterrupt
1011  val hasInstrPageFault = csrio.exception.bits.uop.cf.exceptionVec(instrPageFault) && raiseException
1012  val hasLoadPageFault = csrio.exception.bits.uop.cf.exceptionVec(loadPageFault) && raiseException
1013  val hasStorePageFault = csrio.exception.bits.uop.cf.exceptionVec(storePageFault) && raiseException
1014  val hasStoreAddrMisaligned = csrio.exception.bits.uop.cf.exceptionVec(storeAddrMisaligned) && raiseException
1015  val hasLoadAddrMisaligned = csrio.exception.bits.uop.cf.exceptionVec(loadAddrMisaligned) && raiseException
1016  val hasInstrAccessFault = csrio.exception.bits.uop.cf.exceptionVec(instrAccessFault) && raiseException
1017  val hasLoadAccessFault = csrio.exception.bits.uop.cf.exceptionVec(loadAccessFault) && raiseException
1018  val hasStoreAccessFault = csrio.exception.bits.uop.cf.exceptionVec(storeAccessFault) && raiseException
1019  val hasbreakPoint = csrio.exception.bits.uop.cf.exceptionVec(breakPoint) && raiseException
1020  val hasSingleStep = csrio.exception.bits.uop.ctrl.singleStep && raiseException
1021  val hasTriggerHit = (csrio.exception.bits.uop.cf.trigger.hit) && raiseException
1022
1023  XSDebug(hasSingleStep, "Debug Mode: single step exception\n")
1024  XSDebug(hasTriggerHit, p"Debug Mode: trigger hit, is frontend? ${Binary(csrio.exception.bits.uop.cf.trigger.frontendHit.asUInt)} " +
1025    p"backend hit vec ${Binary(csrio.exception.bits.uop.cf.trigger.backendHit.asUInt)}\n")
1026
1027  val raiseExceptionVec = csrio.exception.bits.uop.cf.exceptionVec
1028  val regularExceptionNO = ExceptionNO.priorities.foldRight(0.U)((i: Int, sum: UInt) => Mux(raiseExceptionVec(i), i.U, sum))
1029  val exceptionNO = Mux(hasSingleStep || hasTriggerHit, 3.U, regularExceptionNO)
1030  val causeNO = (raiseIntr << (XLEN-1)).asUInt | Mux(raiseIntr, intrNO, exceptionNO)
1031
1032  val raiseExceptionIntr = csrio.exception.valid
1033
1034  val raiseDebugExceptionIntr = !debugMode && (hasbreakPoint || raiseDebugIntr || hasSingleStep || hasTriggerHit && triggerAction) // TODO
1035  val ebreakEnterParkLoop = debugMode && raiseExceptionIntr
1036
1037  XSDebug(raiseExceptionIntr, "int/exc: pc %x int (%d):%x exc: (%d):%x\n",
1038    dexceptionPC, intrNO, intrVec, exceptionNO, raiseExceptionVec.asUInt
1039  )
1040  XSDebug(raiseExceptionIntr,
1041    "pc %x mstatus %x mideleg %x medeleg %x mode %x\n",
1042    dexceptionPC,
1043    mstatus,
1044    mideleg,
1045    medeleg,
1046    priviledgeMode
1047  )
1048
1049  // mtval write logic
1050  // Due to timing reasons of memExceptionVAddr, we delay the write of mtval and stval
1051  val memExceptionAddr = SignExt(csrio.memExceptionVAddr, XLEN)
1052  val updateTval = VecInit(Seq(
1053    hasInstrPageFault,
1054    hasLoadPageFault,
1055    hasStorePageFault,
1056    hasInstrAccessFault,
1057    hasLoadAccessFault,
1058    hasStoreAccessFault,
1059    hasLoadAddrMisaligned,
1060    hasStoreAddrMisaligned
1061  )).asUInt.orR
1062  when (RegNext(RegNext(updateTval))) {
1063      val tval = Mux(
1064        RegNext(RegNext(hasInstrPageFault || hasInstrAccessFault)),
1065        RegNext(RegNext(Mux(
1066          csrio.exception.bits.uop.cf.crossPageIPFFix,
1067          SignExt(csrio.exception.bits.uop.cf.pc + 2.U, XLEN),
1068          iexceptionPC
1069        ))),
1070        memExceptionAddr
1071    )
1072    when (RegNext(priviledgeMode === ModeM)) {
1073      mtval := tval
1074    }.otherwise {
1075      stval := tval
1076    }
1077  }
1078
1079  val debugTrapTarget = Mux(!isEbreak && debugMode, 0x38020808.U, 0x38020800.U) // 0x808 is when an exception occurs in debug mode prog buf exec
1080  val deleg = Mux(raiseIntr, mideleg , medeleg)
1081  // val delegS = ((deleg & (1 << (causeNO & 0xf))) != 0) && (priviledgeMode < ModeM);
1082  val delegS = deleg(causeNO(3,0)) && (priviledgeMode < ModeM)
1083  val clearTval = !updateTval || raiseIntr
1084  val isXRet = io.in.valid && func === CSROpType.jmp && !isEcall && !isEbreak
1085
1086  // ctrl block will use theses later for flush
1087  val isXRetFlag = RegInit(false.B)
1088  when (DelayN(io.redirectIn.valid, 5)) {
1089    isXRetFlag := false.B
1090  }.elsewhen (isXRet) {
1091    isXRetFlag := true.B
1092  }
1093  csrio.isXRet := isXRetFlag
1094  val retTargetReg = RegEnable(retTarget, isXRet)
1095
1096  val tvec = Mux(delegS, stvec, mtvec)
1097  val tvecBase = tvec(VAddrBits - 1, 2)
1098  // XRet sends redirect instead of Flush and isXRetFlag is true.B before redirect.valid.
1099  // ROB sends exception at T0 while CSR receives at T2.
1100  // We add a RegNext here and trapTarget is valid at T3.
1101  csrio.trapTarget := RegEnable(Mux(isXRetFlag,
1102    retTargetReg,
1103    Mux(raiseDebugExceptionIntr || ebreakEnterParkLoop, debugTrapTarget,
1104      // When MODE=Vectored, all synchronous exceptions into M/S mode
1105      // cause the pc to be set to the address in the BASE field, whereas
1106      // interrupts cause the pc to be set to the address in the BASE field
1107      // plus four times the interrupt cause number.
1108      Cat(tvecBase + Mux(tvec(0) && raiseIntr, causeNO(3, 0), 0.U), 0.U(2.W))
1109  )), isXRetFlag || csrio.exception.valid)
1110
1111  when (raiseExceptionIntr) {
1112    val mstatusOld = WireInit(mstatus.asTypeOf(new MstatusStruct))
1113    val mstatusNew = WireInit(mstatus.asTypeOf(new MstatusStruct))
1114    val dcsrNew = WireInit(dcsr.asTypeOf(new DcsrStruct))
1115    val debugModeNew = WireInit(debugMode)
1116
1117    when (raiseDebugExceptionIntr) {
1118      when (raiseDebugIntr) {
1119        debugModeNew := true.B
1120        mstatusNew.mprv := false.B
1121        dpc := iexceptionPC
1122        dcsrNew.cause := 3.U
1123        dcsrNew.prv := priviledgeMode
1124        priviledgeMode := ModeM
1125        XSDebug(raiseDebugIntr, "Debug Mode: Trap to %x at pc %x\n", debugTrapTarget, dpc)
1126      }.elsewhen ((hasbreakPoint || hasSingleStep) && !debugMode) {
1127        // ebreak or ss in running hart
1128        debugModeNew := true.B
1129        dpc := iexceptionPC
1130        dcsrNew.cause := Mux(hasTriggerHit, 2.U, Mux(hasbreakPoint, 1.U, 4.U))
1131        dcsrNew.prv := priviledgeMode // TODO
1132        priviledgeMode := ModeM
1133        mstatusNew.mprv := false.B
1134      }
1135      dcsr := dcsrNew.asUInt
1136      debugIntrEnable := false.B
1137    }.elsewhen (debugMode) {
1138      //do nothing
1139    }.elsewhen (delegS) {
1140      scause := causeNO
1141      sepc := Mux(hasInstrPageFault || hasInstrAccessFault, iexceptionPC, dexceptionPC)
1142      mstatusNew.spp := priviledgeMode
1143      mstatusNew.pie.s := mstatusOld.ie.s
1144      mstatusNew.ie.s := false.B
1145      priviledgeMode := ModeS
1146      when (clearTval) { stval := 0.U }
1147    }.otherwise {
1148      mcause := causeNO
1149      mepc := Mux(hasInstrPageFault || hasInstrAccessFault, iexceptionPC, dexceptionPC)
1150      mstatusNew.mpp := priviledgeMode
1151      mstatusNew.pie.m := mstatusOld.ie.m
1152      mstatusNew.ie.m := false.B
1153      priviledgeMode := ModeM
1154      when (clearTval) { mtval := 0.U }
1155    }
1156    mstatus := mstatusNew.asUInt
1157    debugMode := debugModeNew
1158  }
1159
1160  XSDebug(raiseExceptionIntr && delegS, "sepc is written!!! pc:%x\n", cfIn.pc)
1161
1162  // Distributed CSR update req
1163  //
1164  // For now we use it to implement customized cache op
1165  // It can be delayed if necessary
1166
1167  val delayedUpdate0 = DelayN(csrio.distributedUpdate(0), 2)
1168  val delayedUpdate1 = DelayN(csrio.distributedUpdate(1), 2)
1169  val distributedUpdateValid = delayedUpdate0.w.valid || delayedUpdate1.w.valid
1170  val distributedUpdateAddr = Mux(delayedUpdate0.w.valid,
1171    delayedUpdate0.w.bits.addr,
1172    delayedUpdate1.w.bits.addr
1173  )
1174  val distributedUpdateData = Mux(delayedUpdate0.w.valid,
1175    delayedUpdate0.w.bits.data,
1176    delayedUpdate1.w.bits.data
1177  )
1178
1179  assert(!(delayedUpdate0.w.valid && delayedUpdate1.w.valid))
1180
1181  when(distributedUpdateValid){
1182    // cacheopRegs can be distributed updated
1183    CacheInstrucion.CacheInsRegisterList.map{case (name, attribute) => {
1184      when((Scachebase + attribute("offset").toInt).U === distributedUpdateAddr){
1185        cacheopRegs(name) := distributedUpdateData
1186      }
1187    }}
1188  }
1189
1190  // Cache error debug support
1191  if(HasCustomCSRCacheOp){
1192    val cache_error_decoder = Module(new CSRCacheErrorDecoder)
1193    cache_error_decoder.io.encoded_cache_error := cacheopRegs("CACHE_ERROR")
1194  }
1195
1196  // Implicit add reset values for mepc[0] and sepc[0]
1197  // TODO: rewrite mepc and sepc using a struct-like style with the LSB always being 0
1198  when (RegNext(RegNext(reset.asBool) && !reset.asBool)) {
1199    mepc := Cat(mepc(XLEN - 1, 1), 0.U(1.W))
1200    sepc := Cat(sepc(XLEN - 1, 1), 0.U(1.W))
1201  }
1202
1203  def readWithScala(addr: Int): UInt = mapping(addr)._1
1204
1205  val difftestIntrNO = Mux(raiseIntr, causeNO, 0.U)
1206
1207  // Always instantiate basic difftest modules.
1208  if (env.AlwaysBasicDiff || env.EnableDifftest) {
1209    val difftest = Module(new DifftestArchEvent)
1210    difftest.io.clock := clock
1211    difftest.io.coreid := csrio.hartId
1212    difftest.io.intrNO := RegNext(RegNext(RegNext(difftestIntrNO)))
1213    difftest.io.cause  := RegNext(RegNext(RegNext(Mux(csrio.exception.valid, causeNO, 0.U))))
1214    difftest.io.exceptionPC := RegNext(RegNext(RegNext(dexceptionPC)))
1215    if (env.EnableDifftest) {
1216      difftest.io.exceptionInst := RegNext(RegNext(RegNext(csrio.exception.bits.uop.cf.instr)))
1217    }
1218  }
1219
1220  // Always instantiate basic difftest modules.
1221  if (env.AlwaysBasicDiff || env.EnableDifftest) {
1222    val difftest = Module(new DifftestCSRState)
1223    difftest.io.clock := clock
1224    difftest.io.coreid := csrio.hartId
1225    difftest.io.priviledgeMode := priviledgeMode
1226    difftest.io.mstatus := mstatus
1227    difftest.io.sstatus := mstatus & sstatusRmask
1228    difftest.io.mepc := mepc
1229    difftest.io.sepc := sepc
1230    difftest.io.mtval:= mtval
1231    difftest.io.stval:= stval
1232    difftest.io.mtvec := mtvec
1233    difftest.io.stvec := stvec
1234    difftest.io.mcause := mcause
1235    difftest.io.scause := scause
1236    difftest.io.satp := satp
1237    difftest.io.mip := mipReg
1238    difftest.io.mie := mie
1239    difftest.io.mscratch := mscratch
1240    difftest.io.sscratch := sscratch
1241    difftest.io.mideleg := mideleg
1242    difftest.io.medeleg := medeleg
1243  }
1244
1245  if(env.AlwaysBasicDiff || env.EnableDifftest) {
1246    val difftest = Module(new DifftestDebugMode)
1247    difftest.io.clock := clock
1248    difftest.io.coreid := csrio.hartId
1249    difftest.io.debugMode := debugMode
1250    difftest.io.dcsr := dcsr
1251    difftest.io.dpc := dpc
1252    difftest.io.dscratch0 := dscratch
1253    difftest.io.dscratch1 := dscratch1
1254  }
1255}
1256
1257class PFEvent(implicit p: Parameters) extends XSModule with HasCSRConst  {
1258  val io = IO(new Bundle {
1259    val distribute_csr = Flipped(new DistributedCSRIO())
1260    val hpmevent = Output(Vec(29, UInt(XLEN.W)))
1261  })
1262
1263  val w = io.distribute_csr.w
1264
1265  val perfEvents = List.fill(8)(RegInit("h0000000000".U(XLEN.W))) ++
1266                   List.fill(8)(RegInit("h4010040100".U(XLEN.W))) ++
1267                   List.fill(8)(RegInit("h8020080200".U(XLEN.W))) ++
1268                   List.fill(5)(RegInit("hc0300c0300".U(XLEN.W)))
1269
1270  val perfEventMapping = (0 until 29).map(i => {Map(
1271    MaskedRegMap(addr = Mhpmevent3 +i,
1272                 reg  = perfEvents(i),
1273                 wmask = "hf87fff3fcff3fcff".U(XLEN.W))
1274  )}).fold(Map())((a,b) => a ++ b)
1275
1276  val rdata = Wire(UInt(XLEN.W))
1277  MaskedRegMap.generate(perfEventMapping, w.bits.addr, rdata, w.valid, w.bits.data)
1278  for(i <- 0 until 29){
1279    io.hpmevent(i) := perfEvents(i)
1280  }
1281}
1282