xref: /XiangShan/src/main/scala/xiangshan/cache/mmu/TLB.scala (revision 0841a83fafba25ea94b6da4cd8d63c09461694b6)
16d5ddbceSLemover/***************************************************************************************
26d5ddbceSLemover* Copyright (c) 2020-2021 Institute of Computing Technology, Chinese Academy of Sciences
3f320e0f0SYinan Xu* Copyright (c) 2020-2021 Peng Cheng Laboratory
46d5ddbceSLemover*
56d5ddbceSLemover* XiangShan is licensed under Mulan PSL v2.
66d5ddbceSLemover* You can use this software according to the terms and conditions of the Mulan PSL v2.
76d5ddbceSLemover* You may obtain a copy of Mulan PSL v2 at:
86d5ddbceSLemover*          http://license.coscl.org.cn/MulanPSL2
9f1fe8698SLemover
106d5ddbceSLemover* THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND,
116d5ddbceSLemover* EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT,
126d5ddbceSLemover* MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
136d5ddbceSLemover*
146d5ddbceSLemover* See the Mulan PSL v2 for more details.
156d5ddbceSLemover***************************************************************************************/
166d5ddbceSLemover
176d5ddbceSLemoverpackage xiangshan.cache.mmu
186d5ddbceSLemover
198891a219SYinan Xuimport org.chipsalliance.cde.config.Parameters
206d5ddbceSLemoverimport chisel3._
216d5ddbceSLemoverimport chisel3.util._
225ab1b84dSHaoyuan Fengimport difftest._
23a0301c0dSLemoverimport freechips.rocketchip.util.SRAMAnnotation
246d5ddbceSLemoverimport xiangshan._
256d5ddbceSLemoverimport utils._
263c02ee8fSwakafaimport utility._
27f1fe8698SLemoverimport xiangshan.backend.fu.{PMPChecker, PMPReqBundle, PMPConfig => XSPMPConfig}
289aca92b9SYinan Xuimport xiangshan.backend.rob.RobPtr
296d5ddbceSLemoverimport xiangshan.backend.fu.util.HasCSRConst
30f1fe8698SLemoverimport freechips.rocketchip.rocket.PMPConfig
316d5ddbceSLemover
32f1fe8698SLemover/** TLB module
33f1fe8698SLemover  * support block request and non-block request io at the same time
34f1fe8698SLemover  * return paddr at next cycle, then go for pmp/pma check
35f1fe8698SLemover  * @param Width: The number of requestors
36f1fe8698SLemover  * @param Block: Blocked or not for each requestor ports
37f1fe8698SLemover  * @param q: TLB Parameters, like entry number, each TLB has its own parameters
38f1fe8698SLemover  * @param p: XiangShan Paramemters, like XLEN
39f1fe8698SLemover  */
40a0301c0dSLemover
4103efd994Shappy-lxclass TLB(Width: Int, nRespDups: Int = 1, Block: Seq[Boolean], q: TLBParameters)(implicit p: Parameters) extends TlbModule
42f1fe8698SLemover  with HasCSRConst
43f1fe8698SLemover  with HasPerfEvents
44f1fe8698SLemover{
4503efd994Shappy-lx  val io = IO(new TlbIO(Width, nRespDups, q))
46a0301c0dSLemover
476d5ddbceSLemover  val req = io.requestor.map(_.req)
486d5ddbceSLemover  val resp = io.requestor.map(_.resp)
496d5ddbceSLemover  val ptw = io.ptw
50b6982e83SLemover  val pmp = io.pmp
518744445eSMaxpicca-Li  val refill_to_mem = io.refill_to_mem
526d5ddbceSLemover
53f1fe8698SLemover  /** Sfence.vma & Svinval
54f1fe8698SLemover    * Sfence.vma will 1. flush old entries 2. flush inflight 3. flush pipe
55f1fe8698SLemover    * Svinval will 1. flush old entries 2. flush inflight
56f1fe8698SLemover    * So, Svinval will not flush pipe, which means
57f1fe8698SLemover    * it should not drop reqs from pipe and should return right resp
58f1fe8698SLemover    */
59f1fe8698SLemover  val sfence = DelayN(io.sfence, q.fenceDelay)
606d5ddbceSLemover  val csr = io.csr
61f1fe8698SLemover  val satp = DelayN(io.csr.satp, q.fenceDelay)
62d0de7e4aSpeixiaokun  val vsatp = DelayN(io.csr.vsatp, q.fenceDelay)
63d0de7e4aSpeixiaokun  val hgatp = DelayN(io.csr.hgatp, q.fenceDelay)
64d0de7e4aSpeixiaokun
65d0de7e4aSpeixiaokun  val flush_mmu = DelayN(sfence.valid || csr.satp.changed || csr.vsatp.changed || csr.hgatp.changed, q.fenceDelay)
66f1fe8698SLemover  val mmu_flush_pipe = DelayN(sfence.valid && sfence.bits.flushPipe, q.fenceDelay) // for svinval, won't flush pipe
67f1fe8698SLemover  val flush_pipe = io.flushPipe
68a4f9c77fSpeixiaokun  val redirect = io.redirect
69ffa711ffSpeixiaokun  val req_in = req
703222d00fSpeixiaokun  val req_out = req.map(a => RegEnable(a.bits, a.fire))
71ffa711ffSpeixiaokun  val req_out_v = (0 until Width).map(i => ValidHold(req_in(i).fire && !req_in(i).bits.kill, resp(i).fire, flush_pipe(i)))
72ffa711ffSpeixiaokun
73ffa711ffSpeixiaokun  val isHyperInst = (0 until Width).map(i => req_out_v(i) && req_out(i).hyperinst)
7450c7aa78Speixiaokun
75f1fe8698SLemover  // ATTENTION: csr and flush from backend are delayed. csr should not be later than flush.
76f1fe8698SLemover  // because, csr will influence tlb behavior.
77a0301c0dSLemover  val ifecth = if (q.fetchi) true.B else false.B
78d0de7e4aSpeixiaokun  val mode_tmp = if (q.useDmode) csr.priv.dmode else csr.priv.imode
79d0de7e4aSpeixiaokun  val mode = (0 until Width).map(i => Mux(isHyperInst(i), csr.priv.spvp, mode_tmp))
8082e4705bSpeixiaokun  val virt_in = csr.priv.virt
8182e4705bSpeixiaokun  val virt_out = req.map(a => RegEnable(csr.priv.virt, a.fire))
8282e4705bSpeixiaokun  val sum = (0 until Width).map(i => Mux(virt_out(i) || isHyperInst(i), io.csr.priv.vsum, io.csr.priv.sum))
8382e4705bSpeixiaokun  val mxr = (0 until Width).map(i => Mux(virt_out(i) || isHyperInst(i), io.csr.priv.vmxr || io.csr.priv.mxr, io.csr.priv.mxr))
84ffa711ffSpeixiaokun  val req_in_s2xlate = (0 until Width).map(i => MuxCase(noS2xlate, Seq(
8582e4705bSpeixiaokun      (!(virt_in || req_in(i).bits.hyperinst)) -> noS2xlate,
86251a1ca9Speixiaokun      (csr.vsatp.mode =/= 0.U && csr.hgatp.mode =/= 0.U) -> allStage,
87251a1ca9Speixiaokun      (csr.vsatp.mode === 0.U) -> onlyStage2,
88251a1ca9Speixiaokun      (csr.hgatp.mode === 0.U) -> onlyStage1
89ffa711ffSpeixiaokun    )))
90ffa711ffSpeixiaokun  val req_out_s2xlate = (0 until Width).map(i => MuxCase(noS2xlate, Seq(
9182e4705bSpeixiaokun    (!(virt_out(i) || isHyperInst(i))) -> noS2xlate,
92251a1ca9Speixiaokun    (csr.vsatp.mode =/= 0.U && csr.hgatp.mode =/= 0.U) -> allStage,
93251a1ca9Speixiaokun    (csr.vsatp.mode === 0.U) -> onlyStage2,
94251a1ca9Speixiaokun    (csr.hgatp.mode === 0.U) -> onlyStage1
953106de0aSpeixiaokun  )))
96e9027bcdSpeixiaokun  val need_gpa = RegInit(false.B)
97a4f9c77fSpeixiaokun  val need_gpa_robidx = Reg(new RobPtr)
98e9027bcdSpeixiaokun  val need_gpa_vpn = Reg(UInt(vpnLen.W))
99e9027bcdSpeixiaokun  val need_gpa_gvpn = Reg(UInt(vpnLen.W))
100e9566d21Speixiaokun  val resp_gpa_refill = RegInit(false.B)
101e9027bcdSpeixiaokun  val hasGpf = Wire(Vec(Width, Bool()))
102d0de7e4aSpeixiaokun
103*0841a83fSXuan Hu  val vmEnable = (0 until Width).map(i => !(isHyperInst(i) || virt_out(i)) && (
104*0841a83fSXuan Hu    if (EnbaleTlbDebug) (satp.mode === 8.U)
105*0841a83fSXuan Hu    else (satp.mode === 8.U) && (mode(i) < ModeM))
106*0841a83fSXuan Hu  )
10782e4705bSpeixiaokun  val s2xlateEnable = (0 until Width).map(i => (isHyperInst(i) || virt_out(i)) && (vsatp.mode === 8.U || hgatp.mode === 8.U) && (mode(i) < ModeM))
1085adc4829SYanqin Li  val portTranslateEnable = (0 until Width).map(i => (vmEnable(i) || s2xlateEnable(i)) && RegEnable(!req(i).bits.no_translate, req(i).valid))
1096d5ddbceSLemover
1106d5ddbceSLemover
111ec159517SXiaokun-Pei  val refill = ptw.resp.fire && !(ptw.resp.bits.getGpa) && !flush_mmu
112eb4bf3f2Speixiaokun  refill_to_mem := DontCare
11303efd994Shappy-lx  val entries = Module(new TlbStorageWrapper(Width, q, nRespDups))
114f1fe8698SLemover  entries.io.base_connect(sfence, csr, satp)
115f1fe8698SLemover  if (q.outReplace) { io.replace <> entries.io.replace }
1166d5ddbceSLemover  for (i <- 0 until Width) {
117ffa711ffSpeixiaokun    entries.io.r_req_apply(io.requestor(i).req.valid, get_pn(req_in(i).bits.vaddr), i, req_in_s2xlate(i))
118ec159517SXiaokun-Pei    entries.io.w_apply(refill, ptw.resp.bits)
1195adc4829SYanqin Li    // TODO: RegNext enable:req.valid
1205adc4829SYanqin Li    resp(i).bits.debug.isFirstIssue := RegEnable(req(i).bits.debug.isFirstIssue, req(i).valid)
1215adc4829SYanqin Li    resp(i).bits.debug.robIdx := RegEnable(req(i).bits.debug.robIdx, req(i).valid)
122a0301c0dSLemover  }
123e9027bcdSpeixiaokun
124f1fe8698SLemover  // read TLB, get hit/miss, paddr, perm bits
125f1fe8698SLemover  val readResult = (0 until Width).map(TLBRead(_))
126f1fe8698SLemover  val hitVec = readResult.map(_._1)
127f1fe8698SLemover  val missVec = readResult.map(_._2)
128f1fe8698SLemover  val pmp_addr = readResult.map(_._3)
129f9ac118cSHaoyuan Feng  val perm = readResult.map(_._4)
1303106de0aSpeixiaokun  val g_perm = readResult.map(_._5)
131f1fe8698SLemover  // check pmp use paddr (for timing optization, use pmp_addr here)
132f1fe8698SLemover  // check permisson
133f1fe8698SLemover  (0 until Width).foreach{i =>
134f1fe8698SLemover    pmp_check(pmp_addr(i), req_out(i).size, req_out(i).cmd, i)
13503efd994Shappy-lx    for (d <- 0 until nRespDups) {
136ffa711ffSpeixiaokun      perm_check(perm(i)(d), req_out(i).cmd, i, d, g_perm(i)(d), req_out(i).hlvx, req_out_s2xlate(i))
13703efd994Shappy-lx    }
138c3d5cfb3Speixiaokun    hasGpf(i) := resp(i).bits.excp(0).gpf.ld || resp(i).bits.excp(0).gpf.st || resp(i).bits.excp(0).gpf.instr
139f1fe8698SLemover  }
1406d5ddbceSLemover
141f1fe8698SLemover  // handle block or non-block io
142f1fe8698SLemover  // for non-block io, just return the above result, send miss to ptw
143f1fe8698SLemover  // for block io, hold the request, send miss to ptw,
144f1fe8698SLemover  //   when ptw back, return the result
145f1fe8698SLemover  (0 until Width) foreach {i =>
146f1fe8698SLemover    if (Block(i)) handle_block(i)
147f1fe8698SLemover    else handle_nonblock(i)
148f1fe8698SLemover  }
149f1fe8698SLemover  io.ptw.resp.ready := true.B
150a0301c0dSLemover
151f1fe8698SLemover  /************************  main body above | method/log/perf below ****************************/
152f1fe8698SLemover  def TLBRead(i: Int) = {
153ffa711ffSpeixiaokun    val (e_hit, e_ppn, e_perm, e_g_perm, e_s2xlate) = entries.io.r_resp_apply(i)
154ffa711ffSpeixiaokun    val (p_hit, p_ppn, p_perm, p_gvpn, p_g_perm, p_s2xlate) = ptw_resp_bypass(get_pn(req_in(i).bits.vaddr), req_in_s2xlate(i))
155292bea3fSWilliam Wang    val enable = portTranslateEnable(i)
156f86480a7Speixiaokun    val isOnlys2xlate = req_out_s2xlate(i) === onlyStage2
1579cb05b4dSXiaokun-Pei    val need_gpa_vpn_hit = need_gpa_vpn === get_pn(req_out(i).vaddr)
158a4f9c77fSpeixiaokun    val isitlb = TlbCmd.isExec(req_out(i).cmd)
159a4f9c77fSpeixiaokun
160a4f9c77fSpeixiaokun    when (!isitlb && need_gpa_robidx.needFlush(redirect) || isitlb && flush_pipe(i)){
161a4f9c77fSpeixiaokun      need_gpa := false.B
162a4f9c77fSpeixiaokun      resp_gpa_refill := false.B
163a4f9c77fSpeixiaokun      need_gpa_vpn := 0.U
1649cb05b4dSXiaokun-Pei    }.elsewhen (req_out_v(i) && !p_hit && !(resp_gpa_refill && need_gpa_vpn_hit) && !isOnlys2xlate && hasGpf(i) && need_gpa === false.B && !io.requestor(i).req_kill) {
165c3d5cfb3Speixiaokun      need_gpa := true.B
1663106de0aSpeixiaokun      need_gpa_vpn := get_pn(req_out(i).vaddr)
1673106de0aSpeixiaokun      resp_gpa_refill := false.B
168a4f9c77fSpeixiaokun      need_gpa_robidx := req_out(i).debug.robIdx
1699cb05b4dSXiaokun-Pei    }.elsewhen (ptw.resp.fire && need_gpa && need_gpa_vpn === ptw.resp.bits.getVpn(need_gpa_vpn)) {
170e9566d21Speixiaokun      need_gpa_gvpn := ptw.resp.bits.s2.entry.tag
1713106de0aSpeixiaokun      resp_gpa_refill := true.B
1723106de0aSpeixiaokun    }
1733106de0aSpeixiaokun
1749cb05b4dSXiaokun-Pei    when (req_out_v(i) && hasGpf(i) && resp_gpa_refill && need_gpa_vpn_hit ){
175c3d5cfb3Speixiaokun      need_gpa := false.B
176c3d5cfb3Speixiaokun    }
177c3d5cfb3Speixiaokun
1789cb05b4dSXiaokun-Pei    TimeOutAssert(need_gpa && !resp_gpa_refill, timeOutThreshold, s"port{i} need gpa long time not refill.")
1799cb05b4dSXiaokun-Pei
180cb8f2f2aSLemover    val hit = e_hit || p_hit
1814c4af37cSpeixiaokun    val miss = (!hit && enable) || hasGpf(i) && !p_hit && !(resp_gpa_refill && need_gpa_vpn_hit) && !isOnlys2xlate
182f1fe8698SLemover    hit.suggestName(s"hit_read_${i}")
183f1fe8698SLemover    miss.suggestName(s"miss_read_${i}")
1846d5ddbceSLemover
185f1fe8698SLemover    val vaddr = SignExt(req_out(i).vaddr, PAddrBits)
186f1fe8698SLemover    resp(i).bits.miss := miss
187935edac4STang Haojin    resp(i).bits.ptwBack := ptw.resp.fire
1885adc4829SYanqin Li    resp(i).bits.memidx := RegEnable(req_in(i).bits.memidx, req_in(i).valid)
1896d5ddbceSLemover
19003efd994Shappy-lx    val ppn = WireInit(VecInit(Seq.fill(nRespDups)(0.U(ppnLen.W))))
19103efd994Shappy-lx    val perm = WireInit(VecInit(Seq.fill(nRespDups)(0.U.asTypeOf(new TlbPermBundle))))
19282978df9Speixiaokun    val gvpn = WireInit(VecInit(Seq.fill(nRespDups)(0.U(vpnLen.W))))
193d0de7e4aSpeixiaokun    val g_perm = WireInit(VecInit(Seq.fill(nRespDups)(0.U.asTypeOf(new TlbPermBundle))))
19450c7aa78Speixiaokun    val r_s2xlate = WireInit(VecInit(Seq.fill(nRespDups)(0.U(2.W))))
19503efd994Shappy-lx    for (d <- 0 until nRespDups) {
19603efd994Shappy-lx      ppn(d) := Mux(p_hit, p_ppn, e_ppn(d))
19703efd994Shappy-lx      perm(d) := Mux(p_hit, p_perm, e_perm(d))
1984c4af37cSpeixiaokun      gvpn(d) :=  Mux(hasGpf(i), Mux(p_hit, p_gvpn, need_gpa_gvpn), 0.U)
199d0de7e4aSpeixiaokun      g_perm(d) := Mux(p_hit, p_g_perm, e_g_perm(d))
20050c7aa78Speixiaokun      r_s2xlate(d) := Mux(p_hit, p_s2xlate, e_s2xlate(d))
20103efd994Shappy-lx      val paddr = Cat(ppn(d), get_off(req_out(i).vaddr))
202d0de7e4aSpeixiaokun      val gpaddr = Cat(gvpn(d), get_off(req_out(i).vaddr))
203292bea3fSWilliam Wang      resp(i).bits.paddr(d) := Mux(enable, paddr, vaddr)
20450c7aa78Speixiaokun      resp(i).bits.gpaddr(d) := Mux(r_s2xlate(d) === onlyStage2, vaddr, gpaddr)
20503efd994Shappy-lx    }
20603efd994Shappy-lx
20703efd994Shappy-lx    XSDebug(req_out_v(i), p"(${i.U}) hit:${hit} miss:${miss} ppn:${Hexadecimal(ppn(0))} perm:${perm(0)}\n")
20803efd994Shappy-lx
209f9ac118cSHaoyuan Feng    val pmp_paddr = resp(i).bits.paddr(0)
210f1fe8698SLemover
2113106de0aSpeixiaokun    (hit, miss, pmp_paddr, perm, g_perm)
212f1fe8698SLemover  }
213f1fe8698SLemover
214f1fe8698SLemover  def pmp_check(addr: UInt, size: UInt, cmd: UInt, idx: Int): Unit = {
215f1fe8698SLemover    pmp(idx).valid := resp(idx).valid
216f1fe8698SLemover    pmp(idx).bits.addr := addr
217f1fe8698SLemover    pmp(idx).bits.size := size
218f1fe8698SLemover    pmp(idx).bits.cmd := cmd
219f1fe8698SLemover  }
220f1fe8698SLemover
221d0de7e4aSpeixiaokun  def perm_check(perm: TlbPermBundle, cmd: UInt, idx: Int, nDups: Int, g_perm: TlbPermBundle, hlvx: Bool, s2xlate: UInt) = {
2225b7ef044SLemover    // for timing optimization, pmp check is divided into dynamic and static
2235b7ef044SLemover    // dynamic: superpage (or full-connected reg entries) -> check pmp when translation done
2245b7ef044SLemover    // static: 4K pages (or sram entries) -> check pmp with pre-checked results
225c3d5cfb3Speixiaokun    val hasS2xlate = s2xlate =/= noS2xlate
22607f77bf0Speixiaokun    val onlyS2 = s2xlate === onlyStage2
227d0de7e4aSpeixiaokun    val af = perm.af || (hasS2xlate && g_perm.af)
228d0de7e4aSpeixiaokun
229d0de7e4aSpeixiaokun    // Stage 1 perm check
230e5831642Speixiaokun    val pf = perm.pf
231f1fe8698SLemover    val ldUpdate = !perm.a && TlbCmd.isRead(cmd) && !TlbCmd.isAmo(cmd) // update A/D through exception
232f1fe8698SLemover    val stUpdate = (!perm.a || !perm.d) && (TlbCmd.isWrite(cmd) || TlbCmd.isAmo(cmd)) // update A/D through exception
233f1fe8698SLemover    val instrUpdate = !perm.a && TlbCmd.isExec(cmd) // update A/D through exception
234d0de7e4aSpeixiaokun    val modeCheck = !(mode(idx) === ModeU && !perm.u || mode(idx) === ModeS && perm.u && (!sum(idx) || ifecth))
235e5831642Speixiaokun    val ldPermFail = !(modeCheck && Mux(hlvx, perm.x, perm.r || mxr(idx) && perm.x))
236a79fef67Swakafa    val stPermFail = !(modeCheck && perm.w)
237a79fef67Swakafa    val instrPermFail = !(modeCheck && perm.x)
238f1fe8698SLemover    val ldPf = (ldPermFail || pf) && (TlbCmd.isRead(cmd) && !TlbCmd.isAmo(cmd))
239f1fe8698SLemover    val stPf = (stPermFail || pf) && (TlbCmd.isWrite(cmd) || TlbCmd.isAmo(cmd))
240f1fe8698SLemover    val instrPf = (instrPermFail || pf) && TlbCmd.isExec(cmd)
241d0de7e4aSpeixiaokun    val s1_valid = portTranslateEnable(idx) && !onlyS2
242d0de7e4aSpeixiaokun
243d0de7e4aSpeixiaokun    // Stage 2 perm check
244e5831642Speixiaokun    val gpf = g_perm.pf
245d0de7e4aSpeixiaokun    val g_ldUpdate = !g_perm.a && TlbCmd.isRead(cmd) && !TlbCmd.isAmo(cmd)
246d0de7e4aSpeixiaokun    val g_stUpdate = (!g_perm.a || !g_perm.d) && (TlbCmd.isWrite(cmd) || TlbCmd.isAmo(cmd))
247d0de7e4aSpeixiaokun    val g_instrUpdate = !g_perm.a && TlbCmd.isExec(cmd)
248e5831642Speixiaokun    val g_ldPermFail = !Mux(hlvx, g_perm.x, (g_perm.r || io.csr.priv.mxr && g_perm.x))
249d0de7e4aSpeixiaokun    val g_stPermFail = !g_perm.w
250d0de7e4aSpeixiaokun    val g_instrPermFail = !g_perm.x
251d0de7e4aSpeixiaokun    val ldGpf = (g_ldPermFail || gpf) && (TlbCmd.isRead(cmd) && !TlbCmd.isAmo(cmd))
252d0de7e4aSpeixiaokun    val stGpf = (g_stPermFail || gpf) && (TlbCmd.isWrite(cmd) || TlbCmd.isAmo(cmd))
253d0de7e4aSpeixiaokun    val instrGpf = (g_instrPermFail || gpf) && TlbCmd.isExec(cmd)
25444f8e3e4Speixiaokun    val s2_valid = hasS2xlate && portTranslateEnable(idx)
255d0de7e4aSpeixiaokun
256d0de7e4aSpeixiaokun    val fault_valid = s1_valid || s2_valid
257d0de7e4aSpeixiaokun
258c794d992Speixiaokun    // when pf and gpf can't happens simultaneously
259c794d992Speixiaokun    val hasPf = (ldPf || ldUpdate || stPf || stUpdate || instrPf || instrUpdate) && s1_valid && !af
260d0de7e4aSpeixiaokun    resp(idx).bits.excp(nDups).pf.ld := (ldPf || ldUpdate) && s1_valid && !af
261d0de7e4aSpeixiaokun    resp(idx).bits.excp(nDups).pf.st := (stPf || stUpdate) && s1_valid && !af
262d0de7e4aSpeixiaokun    resp(idx).bits.excp(nDups).pf.instr := (instrPf || instrUpdate) && s1_valid && !af
263b6982e83SLemover    // NOTE: pf need && with !af, page fault has higher priority than access fault
264b6982e83SLemover    // but ptw may also have access fault, then af happens, the translation is wrong.
265b6982e83SLemover    // In this case, pf has lower priority than af
2666d5ddbceSLemover
267c794d992Speixiaokun    resp(idx).bits.excp(nDups).gpf.ld := (ldGpf || g_ldUpdate) && s2_valid && !af && !hasPf
268c794d992Speixiaokun    resp(idx).bits.excp(nDups).gpf.st := (stGpf || g_stUpdate) && s2_valid && !af && !hasPf
269c794d992Speixiaokun    resp(idx).bits.excp(nDups).gpf.instr := (instrGpf || g_instrUpdate) && s2_valid && !af && !hasPf
270d0de7e4aSpeixiaokun
271f9ac118cSHaoyuan Feng    resp(idx).bits.excp(nDups).af.ld    := af && TlbCmd.isRead(cmd) && fault_valid
272f9ac118cSHaoyuan Feng    resp(idx).bits.excp(nDups).af.st    := af && TlbCmd.isWrite(cmd) && fault_valid
273f9ac118cSHaoyuan Feng    resp(idx).bits.excp(nDups).af.instr := af && TlbCmd.isExec(cmd) && fault_valid
274d0de7e4aSpeixiaokun
275d0de7e4aSpeixiaokun
2766d5ddbceSLemover  }
2776d5ddbceSLemover
278f1fe8698SLemover  def handle_nonblock(idx: Int): Unit = {
279f1fe8698SLemover    io.requestor(idx).resp.valid := req_out_v(idx)
280f1fe8698SLemover    io.requestor(idx).req.ready := io.requestor(idx).resp.ready // should always be true
2819930e66fSLemover    XSError(!io.requestor(idx).resp.ready, s"${q.name} port ${idx} is non-block, resp.ready must be true.B")
282cb8f2f2aSLemover
283c3d5cfb3Speixiaokun    val req_need_gpa = hasGpf(idx)
284d0de7e4aSpeixiaokun    val req_s2xlate = Wire(UInt(2.W))
28582978df9Speixiaokun    req_s2xlate := MuxCase(noS2xlate, Seq(
28682e4705bSpeixiaokun      (!(virt_out(idx) || req_out(idx).hyperinst)) -> noS2xlate,
28782e4705bSpeixiaokun      (csr.vsatp.mode =/= 0.U && csr.hgatp.mode =/= 0.U) -> allStage,
28882e4705bSpeixiaokun      (csr.vsatp.mode === 0.U) -> onlyStage2,
28982e4705bSpeixiaokun      (csr.hgatp.mode === 0.U || req_need_gpa) -> onlyStage1
29082978df9Speixiaokun    ))
2914c4af37cSpeixiaokun
2924c4af37cSpeixiaokun    val ptw_just_back = ptw.resp.fire && req_s2xlate === ptw.resp.bits.s2xlate && ptw.resp.bits.hit(get_pn(req_out(idx).vaddr), io.csr.satp.asid, io.csr.vsatp.asid, io.csr.hgatp.asid, true, false)
2935adc4829SYanqin Li    // TODO: RegNext enable: ptw.resp.valid ? req.valid
2945adc4829SYanqin Li    val ptw_resp_bits_reg = RegEnable(ptw.resp.bits, ptw.resp.valid)
2955adc4829SYanqin Li    val ptw_already_back = GatedValidRegNext(ptw.resp.fire) && req_s2xlate === ptw_resp_bits_reg.s2xlate && ptw_resp_bits_reg.hit(get_pn(req_out(idx).vaddr), io.csr.satp.asid, io.csr.vsatp.asid, io.csr.hgatp.asid, allType = true)
2960bfa491aSpeixiaokun    io.ptw.req(idx).valid := req_out_v(idx) && missVec(idx) && !(ptw_just_back || ptw_already_back) // TODO: remove the regnext, timing
297185e6164SHaoyuan Feng    io.tlbreplay(idx) := req_out_v(idx) && missVec(idx) && (ptw_just_back || ptw_already_back)
2985adc4829SYanqin Li    when (io.requestor(idx).req_kill && GatedValidRegNext(io.requestor(idx).req.fire)) {
299c3b763d0SYinan Xu      io.ptw.req(idx).valid := false.B
300185e6164SHaoyuan Feng      io.tlbreplay(idx) := true.B
301c3b763d0SYinan Xu    }
302185e6164SHaoyuan Feng    io.ptw.req(idx).bits.vpn := get_pn(req_out(idx).vaddr)
3034c4af37cSpeixiaokun    io.ptw.req(idx).bits.s2xlate := req_s2xlate
304a4f9c77fSpeixiaokun    io.ptw.req(idx).bits.getGpa := req_need_gpa && hitVec(idx)
305185e6164SHaoyuan Feng    io.ptw.req(idx).bits.memidx := req_out(idx).memidx
306149086eaSLemover  }
307a0301c0dSLemover
308f1fe8698SLemover  def handle_block(idx: Int): Unit = {
309f1fe8698SLemover    // three valid: 1.if exist a entry; 2.if sent to ptw; 3.unset resp.valid
310935edac4STang Haojin    io.requestor(idx).req.ready := !req_out_v(idx) || io.requestor(idx).resp.fire
311f1fe8698SLemover    // req_out_v for if there is a request, may long latency, fixme
312f1fe8698SLemover
313f1fe8698SLemover    // miss request entries
314c3d5cfb3Speixiaokun    val req_need_gpa = hasGpf(idx)
315f1fe8698SLemover    val miss_req_vpn = get_pn(req_out(idx).vaddr)
3168744445eSMaxpicca-Li    val miss_req_memidx = req_out(idx).memidx
317d0de7e4aSpeixiaokun    val miss_req_s2xlate = Wire(UInt(2.W))
31882978df9Speixiaokun    miss_req_s2xlate := MuxCase(noS2xlate, Seq(
31982e4705bSpeixiaokun      (!(virt_out(idx) || req_out(idx).hyperinst)) -> noS2xlate,
32082e4705bSpeixiaokun      (csr.vsatp.mode =/= 0.U && csr.hgatp.mode =/= 0.U) -> allStage,
32182e4705bSpeixiaokun      (csr.vsatp.mode === 0.U) -> onlyStage2,
32282e4705bSpeixiaokun      (csr.hgatp.mode === 0.U || req_need_gpa) -> onlyStage1
32382978df9Speixiaokun    ))
3243222d00fSpeixiaokun    val miss_req_s2xlate_reg = RegEnable(miss_req_s2xlate, io.ptw.req(idx).fire)
325c3d5cfb3Speixiaokun    val hasS2xlate = miss_req_s2xlate_reg =/= noS2xlate
326c3d5cfb3Speixiaokun    val onlyS2 = miss_req_s2xlate_reg === onlyStage2
32782978df9Speixiaokun    val hit_s1 = io.ptw.resp.bits.s1.hit(miss_req_vpn, Mux(hasS2xlate, io.csr.vsatp.asid, io.csr.satp.asid), io.csr.hgatp.asid, allType = true, false, hasS2xlate)
328d0de7e4aSpeixiaokun    val hit_s2 = io.ptw.resp.bits.s2.hit(miss_req_vpn, io.csr.hgatp.asid)
329c3d5cfb3Speixiaokun    val hit = Mux(onlyS2, hit_s2, hit_s1) && io.ptw.resp.valid && miss_req_s2xlate_reg === io.ptw.resp.bits.s2xlate
330f1fe8698SLemover
3315adc4829SYanqin Li    val new_coming_valid = WireInit(false.B)
3325adc4829SYanqin Li    new_coming_valid := req_in(idx).fire && !req_in(idx).bits.kill && !flush_pipe(idx)
3335adc4829SYanqin Li    val new_coming = GatedValidRegNext(new_coming_valid)
334f1fe8698SLemover    val miss_wire = new_coming && missVec(idx)
335935edac4STang Haojin    val miss_v = ValidHoldBypass(miss_wire, resp(idx).fire, flush_pipe(idx))
336f1fe8698SLemover    val miss_req_v = ValidHoldBypass(miss_wire || (miss_v && flush_mmu && !mmu_flush_pipe),
337935edac4STang Haojin      io.ptw.req(idx).fire || resp(idx).fire, flush_pipe(idx))
338f1fe8698SLemover
339f1fe8698SLemover    // when ptw resp, check if hit, reset miss_v, resp to lsu/ifu
340292bea3fSWilliam Wang    resp(idx).valid := req_out_v(idx) && !(miss_v && portTranslateEnable(idx))
341935edac4STang Haojin    when (io.ptw.resp.fire && hit && req_out_v(idx) && portTranslateEnable(idx)) {
342d0de7e4aSpeixiaokun      val stage1 = io.ptw.resp.bits.s1
343d0de7e4aSpeixiaokun      val stage2 = io.ptw.resp.bits.s2
344d0de7e4aSpeixiaokun      val s2xlate = io.ptw.resp.bits.s2xlate
345f1fe8698SLemover      resp(idx).valid := true.B
346c3d5cfb3Speixiaokun      resp(idx).bits.miss := false.B
347d0de7e4aSpeixiaokun      val s1_paddr = Cat(stage1.genPPN(get_pn(req_out(idx).vaddr)), get_off(req_out(idx).vaddr))
348cda84113Speixiaokun      val s2_paddr = Cat(stage2.genPPNS2(get_pn(req_out(idx).vaddr)), get_off(req_out(idx).vaddr))
34903efd994Shappy-lx      for (d <- 0 until nRespDups) {
35082978df9Speixiaokun        resp(idx).bits.paddr(d) := Mux(s2xlate =/= noS2xlate, s2_paddr, s1_paddr)
351d0de7e4aSpeixiaokun        resp(idx).bits.gpaddr(d) := s1_paddr
352cca17e78Speixiaokun        perm_check(stage1, req_out(idx).cmd, idx, d, stage2, req_out(idx).hlvx, s2xlate)
35303efd994Shappy-lx      }
35403efd994Shappy-lx      pmp_check(resp(idx).bits.paddr(0), req_out(idx).size, req_out(idx).cmd, idx)
355f1fe8698SLemover
356f1fe8698SLemover      // NOTE: the unfiltered req would be handled by Repeater
357f1fe8698SLemover    }
358f1fe8698SLemover    assert(RegNext(!resp(idx).valid || resp(idx).ready, true.B), "when tlb resp valid, ready should be true, must")
359f1fe8698SLemover    assert(RegNext(req_out_v(idx) || !(miss_v || miss_req_v), true.B), "when not req_out_v, should not set miss_v/miss_req_v")
360f1fe8698SLemover
361f1fe8698SLemover    val ptw_req = io.ptw.req(idx)
362f1fe8698SLemover    ptw_req.valid := miss_req_v
363f1fe8698SLemover    ptw_req.bits.vpn := miss_req_vpn
364d0de7e4aSpeixiaokun    ptw_req.bits.s2xlate := miss_req_s2xlate
365a4f9c77fSpeixiaokun    ptw_req.bits.getGpa := req_need_gpa && hitVec(idx)
3668744445eSMaxpicca-Li    ptw_req.bits.memidx := miss_req_memidx
367f1fe8698SLemover
368185e6164SHaoyuan Feng    io.tlbreplay(idx) := false.B
369185e6164SHaoyuan Feng
370f1fe8698SLemover    // NOTE: when flush pipe, tlb should abandon last req
371f1fe8698SLemover    // however, some outside modules like icache, dont care flushPipe, and still waiting for tlb resp
372f1fe8698SLemover    // just resp valid and raise page fault to go through. The pipe(ifu) will abandon it.
373f1fe8698SLemover    if (!q.outsideRecvFlush) {
374292bea3fSWilliam Wang      when (req_out_v(idx) && flush_pipe(idx) && portTranslateEnable(idx)) {
375f1fe8698SLemover        resp(idx).valid := true.B
37603efd994Shappy-lx        for (d <- 0 until nRespDups) {
37703efd994Shappy-lx          resp(idx).bits.excp(d).pf.ld := true.B // sfence happened, pf for not to use this addr
37803efd994Shappy-lx          resp(idx).bits.excp(d).pf.st := true.B
37903efd994Shappy-lx          resp(idx).bits.excp(d).pf.instr := true.B
38003efd994Shappy-lx        }
381f1fe8698SLemover      }
382f1fe8698SLemover    }
383f1fe8698SLemover  }
384cb8f2f2aSLemover
385cb8f2f2aSLemover  // when ptw resp, tlb at refill_idx maybe set to miss by force.
386cb8f2f2aSLemover  // Bypass ptw resp to check.
387d0de7e4aSpeixiaokun  def ptw_resp_bypass(vpn: UInt, s2xlate: UInt) = {
3885adc4829SYanqin Li    // TODO: RegNext enable: ptw.resp.valid
389cca17e78Speixiaokun    val hasS2xlate = s2xlate =/= noS2xlate
390cca17e78Speixiaokun    val onlyS2 = s2xlate === onlyStage2
391c3d5cfb3Speixiaokun    val onlyS1 = s2xlate === onlyStage1
392d0de7e4aSpeixiaokun    val s2xlate_hit = s2xlate === ptw.resp.bits.s2xlate
393a4d73371Speixiaokun    val resp_hit = ptw.resp.bits.hit(vpn, io.csr.satp.asid, io.csr.vsatp.asid, io.csr.hgatp.asid, true, false)
3945adc4829SYanqin Li    val p_hit = GatedValidRegNext(resp_hit && io.ptw.resp.fire && s2xlate_hit)
395d0de7e4aSpeixiaokun    val ppn_s1 = ptw.resp.bits.s1.genPPN(vpn)
396cda84113Speixiaokun    val gvpn = Mux(onlyS2, vpn, ppn_s1)
397cda84113Speixiaokun    val ppn_s2 = ptw.resp.bits.s2.genPPNS2(gvpn)
398d0de7e4aSpeixiaokun    val p_ppn = RegEnable(Mux(hasS2xlate, ppn_s2, ppn_s1), io.ptw.resp.fire)
399d0de7e4aSpeixiaokun    val p_perm = RegEnable(ptwresp_to_tlbperm(ptw.resp.bits.s1), io.ptw.resp.fire)
4005de1056cSpeixiaokun    val p_gvpn = RegEnable(Mux(onlyS2, ptw.resp.bits.s2.entry.tag, ppn_s1), io.ptw.resp.fire)
401d0de7e4aSpeixiaokun    val p_g_perm = RegEnable(hptwresp_to_tlbperm(ptw.resp.bits.s2), io.ptw.resp.fire)
402d0de7e4aSpeixiaokun    val p_s2xlate = RegEnable(ptw.resp.bits.s2xlate, io.ptw.resp.fire)
403d0de7e4aSpeixiaokun    (p_hit, p_ppn, p_perm, p_gvpn, p_g_perm, p_s2xlate)
404cb8f2f2aSLemover  }
405cb8f2f2aSLemover
406f1fe8698SLemover  // assert
407f1fe8698SLemover  for(i <- 0 until Width) {
408f1fe8698SLemover    TimeOutAssert(req_out_v(i) && !resp(i).valid, timeOutThreshold, s"{q.name} port{i} long time no resp valid.")
409149086eaSLemover  }
410a0301c0dSLemover
411f1fe8698SLemover  // perf event
4125adc4829SYanqin Li  val result_ok = req_in.map(a => GatedValidRegNext(a.fire))
413f1fe8698SLemover  val perfEvents =
414f1fe8698SLemover    Seq(
415935edac4STang Haojin      ("access", PopCount((0 until Width).map{i => if (Block(i)) io.requestor(i).req.fire else portTranslateEnable(i) && result_ok(i) })),
416935edac4STang Haojin      ("miss  ", PopCount((0 until Width).map{i => if (Block(i)) portTranslateEnable(i) && result_ok(i) && missVec(i) else ptw.req(i).fire })),
417a0301c0dSLemover    )
418f1fe8698SLemover  generatePerfEvent()
419a0301c0dSLemover
420f1fe8698SLemover  // perf log
4216d5ddbceSLemover  for (i <- 0 until Width) {
422f1fe8698SLemover    if (Block(i)) {
423292bea3fSWilliam Wang      XSPerfAccumulate(s"access${i}",result_ok(i) && portTranslateEnable(i))
424f1fe8698SLemover      XSPerfAccumulate(s"miss${i}", result_ok(i) && missVec(i))
4256d5ddbceSLemover    } else {
4265adc4829SYanqin Li      XSPerfAccumulate("first_access" + Integer.toString(i, 10), result_ok(i) && portTranslateEnable(i) && RegEnable(req(i).bits.debug.isFirstIssue, req(i).valid))
427292bea3fSWilliam Wang      XSPerfAccumulate("access" + Integer.toString(i, 10), result_ok(i) && portTranslateEnable(i))
4285adc4829SYanqin Li      XSPerfAccumulate("first_miss" + Integer.toString(i, 10), result_ok(i) && portTranslateEnable(i) && missVec(i) && RegEnable(req(i).bits.debug.isFirstIssue, req(i).valid))
429292bea3fSWilliam Wang      XSPerfAccumulate("miss" + Integer.toString(i, 10), result_ok(i) && portTranslateEnable(i) && missVec(i))
430a0301c0dSLemover    }
4316d5ddbceSLemover  }
432935edac4STang Haojin  XSPerfAccumulate("ptw_resp_count", ptw.resp.fire)
433cca17e78Speixiaokun  XSPerfAccumulate("ptw_resp_pf_count", ptw.resp.fire && ptw.resp.bits.s1.pf)
4346d5ddbceSLemover
4356d5ddbceSLemover  // Log
4366d5ddbceSLemover  for(i <- 0 until Width) {
4376d5ddbceSLemover    XSDebug(req(i).valid, p"req(${i.U}): (${req(i).valid} ${req(i).ready}) ${req(i).bits}\n")
4386d5ddbceSLemover    XSDebug(resp(i).valid, p"resp(${i.U}): (${resp(i).valid} ${resp(i).ready}) ${resp(i).bits}\n")
4396d5ddbceSLemover  }
4406d5ddbceSLemover
441f1fe8698SLemover  XSDebug(io.sfence.valid, p"Sfence: ${io.sfence}\n")
442f1fe8698SLemover  XSDebug(ParallelOR(req_out_v) || ptw.resp.valid, p"vmEnable:${vmEnable} hit:${Binary(VecInit(hitVec).asUInt)} miss:${Binary(VecInit(missVec).asUInt)}\n")
4436d5ddbceSLemover  for (i <- ptw.req.indices) {
444935edac4STang Haojin    XSDebug(ptw.req(i).fire, p"L2TLB req:${ptw.req(i).bits}\n")
4456d5ddbceSLemover  }
44692e3bfefSLemover  XSDebug(ptw.resp.valid, p"L2TLB resp:${ptw.resp.bits} (v:${ptw.resp.valid}r:${ptw.resp.ready}) \n")
4476d5ddbceSLemover
448f9ac118cSHaoyuan Feng  println(s"${q.name}: page: ${q.NWays} ${q.Associative} ${q.Replacer.get}")
449a0301c0dSLemover
4505ab1b84dSHaoyuan Feng  if (env.EnableDifftest) {
4515ab1b84dSHaoyuan Feng    for (i <- 0 until Width) {
4525ab1b84dSHaoyuan Feng      val pf = io.requestor(i).resp.bits.excp(0).pf.instr || io.requestor(i).resp.bits.excp(0).pf.st || io.requestor(i).resp.bits.excp(0).pf.ld
453d0de7e4aSpeixiaokun      val gpf = io.requestor(i).resp.bits.excp(0).gpf.instr || io.requestor(i).resp.bits.excp(0).gpf.st || io.requestor(i).resp.bits.excp(0).gpf.ld
4545ab1b84dSHaoyuan Feng      val af = io.requestor(i).resp.bits.excp(0).af.instr || io.requestor(i).resp.bits.excp(0).af.st || io.requestor(i).resp.bits.excp(0).af.ld
4557d45a146SYinan Xu      val difftest = DifftestModule(new DiffL1TLBEvent)
456254e4960SHaoyuan Feng      difftest.coreid := io.hartId
457d0de7e4aSpeixiaokun      difftest.valid := RegNext(io.requestor(i).req.fire) && !io.requestor(i).req_kill && io.requestor(i).resp.fire && !io.requestor(i).resp.bits.miss && !pf && !af && !gpf && portTranslateEnable(i)
4587d45a146SYinan Xu      if (!Seq("itlb", "ldtlb", "sttlb").contains(q.name)) {
4597d45a146SYinan Xu        difftest.valid := false.B
4607d45a146SYinan Xu      }
4617d45a146SYinan Xu      difftest.index := TLBDiffId(p(XSCoreParamsKey).HartId).U
4625adc4829SYanqin Li      difftest.vpn := RegEnable(get_pn(req_in(i).bits.vaddr), req_in(i).valid)
4637d45a146SYinan Xu      difftest.ppn := get_pn(io.requestor(i).resp.bits.paddr(0))
46487d0ba30Speixiaokun      difftest.satp := Cat(io.csr.satp.mode, io.csr.satp.asid, io.csr.satp.ppn)
46587d0ba30Speixiaokun      difftest.vsatp := Cat(io.csr.vsatp.mode, io.csr.vsatp.asid, io.csr.vsatp.ppn)
46687d0ba30Speixiaokun      difftest.hgatp := Cat(io.csr.hgatp.mode, io.csr.hgatp.asid, io.csr.hgatp.ppn)
467dd103903Speixiaokun      val req_need_gpa = gpf
468dd103903Speixiaokun      val req_s2xlate = Wire(UInt(2.W))
469dd103903Speixiaokun      req_s2xlate := MuxCase(noS2xlate, Seq(
47082e4705bSpeixiaokun        (!RegNext(virt_in || req_in(i).bits.hyperinst)) -> noS2xlate,
471cca17e78Speixiaokun        (vsatp.mode =/= 0.U && hgatp.mode =/= 0.U) -> allStage,
472cca17e78Speixiaokun        (vsatp.mode === 0.U) -> onlyStage2,
473dd103903Speixiaokun        (hgatp.mode === 0.U || req_need_gpa) -> onlyStage1
47482978df9Speixiaokun      ))
475dd103903Speixiaokun      difftest.s2xlate := req_s2xlate
4767d45a146SYinan Xu    }
4775ab1b84dSHaoyuan Feng  }
4785ab1b84dSHaoyuan Feng}
4795ab1b84dSHaoyuan Feng
4807d45a146SYinan Xuobject TLBDiffId {
4817d45a146SYinan Xu  var i: Int = 0
4827d45a146SYinan Xu  var lastHartId: Int = -1
4837d45a146SYinan Xu  def apply(hartId: Int): Int = {
4847d45a146SYinan Xu    if (lastHartId != hartId) {
4857d45a146SYinan Xu      i = 0
4867d45a146SYinan Xu      lastHartId = hartId
4877d45a146SYinan Xu    }
4887d45a146SYinan Xu    i += 1
4897d45a146SYinan Xu    i - 1
4907d45a146SYinan Xu  }
491f1fe8698SLemover}
4921ca0e4f3SYinan Xu
49303efd994Shappy-lxclass TLBNonBlock(Width: Int, nRespDups: Int = 1, q: TLBParameters)(implicit p: Parameters) extends TLB(Width, nRespDups, Seq.fill(Width)(false), q)
49403efd994Shappy-lxclass TLBBLock(Width: Int, nRespDups: Int = 1, q: TLBParameters)(implicit p: Parameters) extends TLB(Width, nRespDups, Seq.fill(Width)(true), q)
4956d5ddbceSLemover
496a0301c0dSLemoverclass TlbReplace(Width: Int, q: TLBParameters)(implicit p: Parameters) extends TlbModule {
497a0301c0dSLemover  val io = IO(new TlbReplaceIO(Width, q))
498a0301c0dSLemover
499f9ac118cSHaoyuan Feng  if (q.Associative == "fa") {
500f9ac118cSHaoyuan Feng    val re = ReplacementPolicy.fromString(q.Replacer, q.NWays)
501f9ac118cSHaoyuan Feng    re.access(io.page.access.map(_.touch_ways))
502f9ac118cSHaoyuan Feng    io.page.refillIdx := re.way
503a0301c0dSLemover  } else { // set-acco && plru
504f9ac118cSHaoyuan Feng    val re = ReplacementPolicy.fromString(q.Replacer, q.NSets, q.NWays)
505f9ac118cSHaoyuan Feng    re.access(io.page.access.map(_.sets), io.page.access.map(_.touch_ways))
506f9ac118cSHaoyuan Feng    io.page.refillIdx := { if (q.NWays == 1) 0.U else re.way(io.page.chosen_set) }
507a0301c0dSLemover  }
508a0301c0dSLemover}
509