xref: /XiangShan/src/main/scala/xiangshan/cache/mmu/MMUBundle.scala (revision b6982e83d6fe4f8c3d111ebc70665f115e470ddf)
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
96d5ddbceSLemover*
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
196d5ddbceSLemoverimport chipsalliance.rocketchip.config.Parameters
206d5ddbceSLemoverimport chisel3._
216d5ddbceSLemoverimport chisel3.util._
226d5ddbceSLemoverimport xiangshan._
236d5ddbceSLemoverimport utils._
249aca92b9SYinan Xuimport xiangshan.backend.rob.RobPtr
256d5ddbceSLemoverimport xiangshan.backend.fu.util.HasCSRConst
266d5ddbceSLemoverimport freechips.rocketchip.diplomacy.{LazyModule, LazyModuleImp}
276d5ddbceSLemoverimport freechips.rocketchip.tilelink._
28*b6982e83SLemoverimport xiangshan.backend.fu.PMPReqBundle
296d5ddbceSLemover
306d5ddbceSLemoverabstract class TlbBundle(implicit p: Parameters) extends XSBundle with HasTlbConst
316d5ddbceSLemoverabstract class TlbModule(implicit p: Parameters) extends XSModule with HasTlbConst
326d5ddbceSLemover
33a0301c0dSLemover
34a0301c0dSLemover
35a0301c0dSLemover// case class ITLBKey
36a0301c0dSLemover// case class LDTLBKey
37a0301c0dSLemover// case class STTLBKey
38a0301c0dSLemover
39a0301c0dSLemoverclass VaBundle(implicit p: Parameters) extends TlbBundle {
40a0301c0dSLemover  val vpn  = UInt(vpnLen.W)
41a0301c0dSLemover  val off  = UInt(offLen.W)
42a0301c0dSLemover}
43a0301c0dSLemover
446d5ddbceSLemoverclass PtePermBundle(implicit p: Parameters) extends TlbBundle {
456d5ddbceSLemover  val d = Bool()
466d5ddbceSLemover  val a = Bool()
476d5ddbceSLemover  val g = Bool()
486d5ddbceSLemover  val u = Bool()
496d5ddbceSLemover  val x = Bool()
506d5ddbceSLemover  val w = Bool()
516d5ddbceSLemover  val r = Bool()
526d5ddbceSLemover
536d5ddbceSLemover  override def toPrintable: Printable = {
546d5ddbceSLemover    p"d:${d} a:${a} g:${g} u:${u} x:${x} w:${w} r:${r}"// +
556d5ddbceSLemover    //(if(hasV) (p"v:${v}") else p"")
566d5ddbceSLemover  }
576d5ddbceSLemover}
586d5ddbceSLemover
596d5ddbceSLemoverclass TlbPermBundle(implicit p: Parameters) extends TlbBundle {
606d5ddbceSLemover  val pf = Bool() // NOTE: if this is true, just raise pf
61*b6982e83SLemover  val af = Bool() // NOTE: if this is true, just raise af
626d5ddbceSLemover  // pagetable perm (software defined)
636d5ddbceSLemover  val d = Bool()
646d5ddbceSLemover  val a = Bool()
656d5ddbceSLemover  val g = Bool()
666d5ddbceSLemover  val u = Bool()
676d5ddbceSLemover  val x = Bool()
686d5ddbceSLemover  val w = Bool()
696d5ddbceSLemover  val r = Bool()
706d5ddbceSLemover  // pma perm (hardwired)
716d5ddbceSLemover  val pr = Bool() //readable
726d5ddbceSLemover  val pw = Bool() //writeable
736d5ddbceSLemover  val pe = Bool() //executable
746d5ddbceSLemover  val pa = Bool() //atom op permitted
756d5ddbceSLemover  val pi = Bool() //icacheable
766d5ddbceSLemover  val pd = Bool() //dcacheable
776d5ddbceSLemover
786d5ddbceSLemover  override def toPrintable: Printable = {
79*b6982e83SLemover    p"pf:${pf} af:${af} d:${d} a:${a} g:${g} u:${u} x:${x} w:${w} r:${r}"
806d5ddbceSLemover  }
816d5ddbceSLemover}
826d5ddbceSLemover
836d5ddbceSLemover// multi-read && single-write
846d5ddbceSLemover// input is data, output is hot-code(not one-hot)
856d5ddbceSLemoverclass CAMTemplate[T <: Data](val gen: T, val set: Int, val readWidth: Int)(implicit p: Parameters) extends TlbModule {
866d5ddbceSLemover  val io = IO(new Bundle {
876d5ddbceSLemover    val r = new Bundle {
886d5ddbceSLemover      val req = Input(Vec(readWidth, gen))
896d5ddbceSLemover      val resp = Output(Vec(readWidth, Vec(set, Bool())))
906d5ddbceSLemover    }
916d5ddbceSLemover    val w = Input(new Bundle {
926d5ddbceSLemover      val valid = Bool()
936d5ddbceSLemover      val bits = new Bundle {
946d5ddbceSLemover        val index = UInt(log2Up(set).W)
956d5ddbceSLemover        val data = gen
966d5ddbceSLemover      }
976d5ddbceSLemover    })
986d5ddbceSLemover  })
996d5ddbceSLemover
1006d5ddbceSLemover  val wordType = UInt(gen.getWidth.W)
1016d5ddbceSLemover  val array = Reg(Vec(set, wordType))
1026d5ddbceSLemover
1036d5ddbceSLemover  io.r.resp.zipWithIndex.map{ case (a,i) =>
1046d5ddbceSLemover    a := array.map(io.r.req(i).asUInt === _)
1056d5ddbceSLemover  }
1066d5ddbceSLemover
1076d5ddbceSLemover  when (io.w.valid) {
1086d5ddbceSLemover    array(io.w.bits.index) := io.w.bits.data
1096d5ddbceSLemover  }
1106d5ddbceSLemover}
1116d5ddbceSLemover
1126d5ddbceSLemoverclass TlbSPMeta(implicit p: Parameters) extends TlbBundle {
1136d5ddbceSLemover  val tag = UInt(vpnLen.W) // tag is vpn
1146d5ddbceSLemover  val level = UInt(1.W) // 1 for 2MB, 0 for 1GB
1156d5ddbceSLemover
1166d5ddbceSLemover  def hit(vpn: UInt): Bool = {
1176d5ddbceSLemover    val a = tag(vpnnLen*3-1, vpnnLen*2) === vpn(vpnnLen*3-1, vpnnLen*2)
1186d5ddbceSLemover    val b = tag(vpnnLen*2-1, vpnnLen*1) === vpn(vpnnLen*2-1, vpnnLen*1)
1196d5ddbceSLemover    XSDebug(Mux(level.asBool, a&b, a), p"Hit superpage: hit:${Mux(level.asBool, a&b, a)} tag:${Hexadecimal(tag)} level:${level} a:${a} b:${b} vpn:${Hexadecimal(vpn)}\n")
1206d5ddbceSLemover    Mux(level.asBool, a&b, a)
1216d5ddbceSLemover  }
1226d5ddbceSLemover
1236d5ddbceSLemover  def apply(vpn: UInt, level: UInt) = {
1246d5ddbceSLemover    this.tag := vpn
1256d5ddbceSLemover    this.level := level(0)
1266d5ddbceSLemover
1276d5ddbceSLemover    this
1286d5ddbceSLemover  }
1296d5ddbceSLemover
1306d5ddbceSLemover}
1316d5ddbceSLemover
1326d5ddbceSLemoverclass TlbData(superpage: Boolean = false)(implicit p: Parameters) extends TlbBundle {
1336d5ddbceSLemover  val level = if(superpage) Some(UInt(1.W)) else None // /*2 for 4KB,*/ 1 for 2MB, 0 for 1GB
1346d5ddbceSLemover  val ppn = UInt(ppnLen.W)
1356d5ddbceSLemover  val perm = new TlbPermBundle
1366d5ddbceSLemover
1376d5ddbceSLemover  def genPPN(vpn: UInt): UInt = {
1386d5ddbceSLemover    if (superpage) {
1396d5ddbceSLemover      val insideLevel = level.getOrElse(0.U)
1406d5ddbceSLemover      Mux(insideLevel.asBool, Cat(ppn(ppn.getWidth-1, vpnnLen*1), vpn(vpnnLen*1-1, 0)),
1416d5ddbceSLemover                              Cat(ppn(ppn.getWidth-1, vpnnLen*2), vpn(vpnnLen*2-1, 0)))
1426d5ddbceSLemover    } else {
1436d5ddbceSLemover      ppn
1446d5ddbceSLemover    }
1456d5ddbceSLemover  }
1466d5ddbceSLemover
147*b6982e83SLemover  def apply(ppn: UInt, level: UInt, perm: UInt, pf: Bool, af: Bool) = {
1486d5ddbceSLemover    this.level.map(_ := level(0))
1496d5ddbceSLemover    this.ppn := ppn
1506d5ddbceSLemover    // refill pagetable perm
1516d5ddbceSLemover    val ptePerm = perm.asTypeOf(new PtePermBundle)
1526d5ddbceSLemover    this.perm.pf:= pf
153*b6982e83SLemover    this.perm.af:= af
1546d5ddbceSLemover    this.perm.d := ptePerm.d
1556d5ddbceSLemover    this.perm.a := ptePerm.a
1566d5ddbceSLemover    this.perm.g := ptePerm.g
1576d5ddbceSLemover    this.perm.u := ptePerm.u
1586d5ddbceSLemover    this.perm.x := ptePerm.x
1596d5ddbceSLemover    this.perm.w := ptePerm.w
1606d5ddbceSLemover    this.perm.r := ptePerm.r
1616d5ddbceSLemover
1626d5ddbceSLemover    // get pma perm
1636d5ddbceSLemover    val (pmaMode, accessWidth) = AddressSpace.memmapAddrMatch(Cat(ppn, 0.U(12.W)))
1646d5ddbceSLemover    this.perm.pr := PMAMode.read(pmaMode)
1656d5ddbceSLemover    this.perm.pw := PMAMode.write(pmaMode)
1666d5ddbceSLemover    this.perm.pe := PMAMode.execute(pmaMode)
1676d5ddbceSLemover    this.perm.pa := PMAMode.atomic(pmaMode)
1686d5ddbceSLemover    this.perm.pi := PMAMode.icache(pmaMode)
1696d5ddbceSLemover    this.perm.pd := PMAMode.dcache(pmaMode)
1706d5ddbceSLemover
1716d5ddbceSLemover    this
1726d5ddbceSLemover  }
1736d5ddbceSLemover
1746d5ddbceSLemover  override def toPrintable: Printable = {
1756d5ddbceSLemover    val insideLevel = level.getOrElse(0.U)
1766d5ddbceSLemover    p"level:${insideLevel} ppn:${Hexadecimal(ppn)} perm:${perm}"
1776d5ddbceSLemover  }
1786d5ddbceSLemover
1796d5ddbceSLemover  override def cloneType: this.type = (new TlbData(superpage)).asInstanceOf[this.type]
1806d5ddbceSLemover}
1816d5ddbceSLemover
182a0301c0dSLemoverclass TlbEntry(pageNormal: Boolean, pageSuper: Boolean)(implicit p: Parameters) extends TlbBundle {
183a0301c0dSLemover  require(pageNormal || pageSuper)
184a0301c0dSLemover
185a0301c0dSLemover  val tag = if (!pageNormal) UInt((vpnLen - vpnnLen).W)
186a0301c0dSLemover            else UInt(vpnLen.W)
187a0301c0dSLemover  val level = if (!pageNormal) Some(UInt(1.W))
188a0301c0dSLemover              else if (!pageSuper) None
189a0301c0dSLemover              else Some(UInt(2.W))
190a0301c0dSLemover  val ppn = if (!pageNormal) UInt((ppnLen - vpnnLen).W)
191a0301c0dSLemover            else UInt(ppnLen.W)
192a0301c0dSLemover  val perm = new TlbPermBundle
193a0301c0dSLemover
194a0301c0dSLemover  def hit(vpn: UInt): Bool = {
195a0301c0dSLemover    if (!pageSuper) vpn === tag
196a0301c0dSLemover    else if (!pageNormal) MuxLookup(level.get, false.B, Seq(
197a0301c0dSLemover      0.U -> (tag(vpnnLen*2-1, vpnnLen) === vpn(vpnLen-1, vpnnLen*2)),
198a0301c0dSLemover      1.U -> (tag === vpn(vpnLen-1, vpnnLen)),
199a0301c0dSLemover    ))
200a0301c0dSLemover    else MuxLookup(level.get, false.B, Seq(
201a0301c0dSLemover      0.U -> (tag(vpnLen-1, vpnnLen*2) === vpn(vpnLen-1, vpnnLen*2)),
202a0301c0dSLemover      1.U -> (tag(vpnLen-1, vpnnLen) === vpn(vpnLen-1, vpnnLen)),
203a0301c0dSLemover      2.U -> (tag === vpn) // if pageNormal is false, this will always be false
204a0301c0dSLemover    ))
205a0301c0dSLemover  }
206a0301c0dSLemover
207a0301c0dSLemover  def apply(item: PtwResp): TlbEntry = {
208a0301c0dSLemover    this.tag := {if (pageNormal) item.entry.tag else item.entry.tag(vpnLen-1, vpnnLen)}
209a0301c0dSLemover    val inner_level = item.entry.level.getOrElse(0.U)
210a0301c0dSLemover    this.level.map(_ := { if (pageNormal && pageSuper) inner_level
211a0301c0dSLemover                          else if (pageSuper) inner_level(0)
212a0301c0dSLemover                          else 0.U})
213a0301c0dSLemover    this.ppn := { if (!pageNormal) item.entry.ppn(ppnLen-1, vpnnLen)
214a0301c0dSLemover                  else item.entry.ppn }
215a0301c0dSLemover    val ptePerm = item.entry.perm.get.asTypeOf(new PtePermBundle().cloneType)
216a0301c0dSLemover    this.perm.pf := item.pf
217*b6982e83SLemover    this.perm.af := item.af
218a0301c0dSLemover    this.perm.d := ptePerm.d
219a0301c0dSLemover    this.perm.a := ptePerm.a
220a0301c0dSLemover    this.perm.g := ptePerm.g
221a0301c0dSLemover    this.perm.u := ptePerm.u
222a0301c0dSLemover    this.perm.x := ptePerm.x
223a0301c0dSLemover    this.perm.w := ptePerm.w
224a0301c0dSLemover    this.perm.r := ptePerm.r
225a0301c0dSLemover
226a0301c0dSLemover    // get pma perm
227a0301c0dSLemover    val (pmaMode, accessWidth) = AddressSpace.memmapAddrMatch(Cat(item.entry.ppn, 0.U(12.W)))
228a0301c0dSLemover    this.perm.pr := PMAMode.read(pmaMode)
229a0301c0dSLemover    this.perm.pw := PMAMode.write(pmaMode)
230a0301c0dSLemover    this.perm.pe := PMAMode.execute(pmaMode)
231a0301c0dSLemover    this.perm.pa := PMAMode.atomic(pmaMode)
232a0301c0dSLemover    this.perm.pi := PMAMode.icache(pmaMode)
233a0301c0dSLemover    this.perm.pd := PMAMode.dcache(pmaMode)
234a0301c0dSLemover
235a0301c0dSLemover    this
236a0301c0dSLemover  }
237a0301c0dSLemover
238a0301c0dSLemover  def genPPN(vpn: UInt) : UInt = {
239a0301c0dSLemover    if (!pageSuper) ppn
240a0301c0dSLemover    else if (!pageNormal) MuxLookup(level.get, 0.U, Seq(
241a0301c0dSLemover      0.U -> Cat(ppn(ppn.getWidth-1, vpnnLen), vpn(vpnnLen*2-1, 0)),
242a0301c0dSLemover      1.U -> Cat(ppn, vpn(vpnnLen-1, 0))
243a0301c0dSLemover    ))
244a0301c0dSLemover    else MuxLookup(level.get, 0.U, Seq(
245a0301c0dSLemover      0.U -> Cat(ppn(ppn.getWidth-1, vpnnLen*2), vpn(vpnnLen*2-1, 0)),
246a0301c0dSLemover      1.U -> Cat(ppn(ppn.getWidth-1, vpnnLen), vpn(vpnnLen-1, 0)),
247a0301c0dSLemover      2.U -> ppn
248a0301c0dSLemover    ))
249a0301c0dSLemover  }
250a0301c0dSLemover
251a0301c0dSLemover  override def toPrintable: Printable = {
252a0301c0dSLemover    val inner_level = level.getOrElse(2.U)
253a0301c0dSLemover    p"level:${inner_level} vpn:${Hexadecimal(tag)} ppn:${Hexadecimal(ppn)} perm:${perm}"
254a0301c0dSLemover  }
255a0301c0dSLemover
256a0301c0dSLemover  override def cloneType: this.type = (new TlbEntry(pageNormal, pageSuper)).asInstanceOf[this.type]
257a0301c0dSLemover}
258a0301c0dSLemover
2596d5ddbceSLemoverobject TlbCmd {
2606d5ddbceSLemover  def read  = "b00".U
2616d5ddbceSLemover  def write = "b01".U
2626d5ddbceSLemover  def exec  = "b10".U
2636d5ddbceSLemover
2646d5ddbceSLemover  def atom_read  = "b100".U // lr
2656d5ddbceSLemover  def atom_write = "b101".U // sc / amo
2666d5ddbceSLemover
2676d5ddbceSLemover  def apply() = UInt(3.W)
2686d5ddbceSLemover  def isRead(a: UInt) = a(1,0)===read
2696d5ddbceSLemover  def isWrite(a: UInt) = a(1,0)===write
2706d5ddbceSLemover  def isExec(a: UInt) = a(1,0)===exec
2716d5ddbceSLemover
2726d5ddbceSLemover  def isAtom(a: UInt) = a(2)
2736d5ddbceSLemover}
2746d5ddbceSLemover
275a0301c0dSLemoverclass TlbStorageIO(nSets: Int, nWays: Int, ports: Int)(implicit p: Parameters) extends  TlbBundle {
276a0301c0dSLemover  val r = new Bundle {
277a0301c0dSLemover    val req = Vec(ports, Flipped(DecoupledIO(new Bundle {
278a0301c0dSLemover      val vpn = Output(UInt(vpnLen.W))
279a0301c0dSLemover    })))
280a0301c0dSLemover    val resp = Vec(ports, ValidIO(new Bundle{
281a0301c0dSLemover      val hit = Output(Bool())
282a0301c0dSLemover      val ppn = Output(UInt(ppnLen.W))
283a0301c0dSLemover      val perm = Output(new TlbPermBundle())
284a0301c0dSLemover      val hitVec = Output(UInt(nWays.W))
285a0301c0dSLemover    }))
286a0301c0dSLemover  }
287a0301c0dSLemover  val w = Flipped(ValidIO(new Bundle {
288a0301c0dSLemover    val wayIdx = Output(UInt(log2Up(nWays).W))
289a0301c0dSLemover    val data = Output(new PtwResp)
290a0301c0dSLemover  }))
291a0301c0dSLemover  val victim = new Bundle {
292a0301c0dSLemover    val out = ValidIO(Output(new TlbEntry(pageNormal = true, pageSuper = false)))
293a0301c0dSLemover    val in = Flipped(ValidIO(Output(new TlbEntry(pageNormal = true, pageSuper = false))))
294a0301c0dSLemover  }
295a0301c0dSLemover  val sfence = Input(new SfenceBundle())
296a0301c0dSLemover
297a0301c0dSLemover  def r_req_apply(valid: Bool, vpn: UInt, i: Int): Unit = {
298a0301c0dSLemover    this.r.req(i).valid := valid
299a0301c0dSLemover    this.r.req(i).bits.vpn := vpn
300a0301c0dSLemover  }
301a0301c0dSLemover
302a0301c0dSLemover  def r_resp_apply(i: Int) = {
303a0301c0dSLemover    (this.r.resp(i).bits.hit, this.r.resp(i).bits.ppn, this.r.resp(i).bits.perm, this.r.resp(i).bits.hitVec)
304a0301c0dSLemover  }
305a0301c0dSLemover
306a0301c0dSLemover  def w_apply(valid: Bool, wayIdx: UInt, data: PtwResp): Unit = {
307a0301c0dSLemover    this.w.valid := valid
308a0301c0dSLemover    this.w.bits.wayIdx := wayIdx
309a0301c0dSLemover    this.w.bits.data := data
310a0301c0dSLemover  }
311a0301c0dSLemover
312a0301c0dSLemover  override def cloneType: this.type = new TlbStorageIO(nSets, nWays, ports).asInstanceOf[this.type]
313a0301c0dSLemover}
314a0301c0dSLemover
315a0301c0dSLemoverclass ReplaceIO(Width: Int, nSets: Int, nWays: Int)(implicit p: Parameters) extends TlbBundle {
316a0301c0dSLemover  val access = Flipped(new Bundle {
317a0301c0dSLemover    val sets = Output(Vec(Width, UInt(log2Up(nSets).W)))
318a0301c0dSLemover    val touch_ways = Vec(Width, ValidIO(Output(UInt(log2Up(nWays).W))))
319a0301c0dSLemover  })
320a0301c0dSLemover
321a0301c0dSLemover  val refillIdx = Output(UInt(log2Up(nWays).W))
322a0301c0dSLemover  val chosen_set = Flipped(Output(UInt(log2Up(nSets).W)))
323a0301c0dSLemover
324a0301c0dSLemover  def apply_sep(in: Seq[ReplaceIO], vpn: UInt): Unit = {
325a0301c0dSLemover    for (i <- 0 until Width) {
326a0301c0dSLemover      this.access.sets(i) := in(i).access.sets(0)
327a0301c0dSLemover      this.access.touch_ways(i) := in(i).access.touch_ways(0)
328a0301c0dSLemover      this.chosen_set := get_idx(vpn, nSets)
329a0301c0dSLemover      in(i).refillIdx := this.refillIdx
330a0301c0dSLemover    }
331a0301c0dSLemover  }
332a0301c0dSLemover}
333a0301c0dSLemover
334a0301c0dSLemoverclass TlbReplaceIO(Width: Int, q: TLBParameters)(implicit p: Parameters) extends
335a0301c0dSLemover  TlbBundle {
336a0301c0dSLemover  val normalPage = new ReplaceIO(Width, q.normalNSets, q.normalNWays)
337a0301c0dSLemover  val superPage = new ReplaceIO(Width, q.superNSets, q.superNWays)
338a0301c0dSLemover
339a0301c0dSLemover  def apply_sep(in: Seq[TlbReplaceIO], vpn: UInt) = {
340a0301c0dSLemover    this.normalPage.apply_sep(in.map(_.normalPage), vpn)
341a0301c0dSLemover    this.superPage.apply_sep(in.map(_.superPage), vpn)
342a0301c0dSLemover  }
343a0301c0dSLemover
344a0301c0dSLemover  override def cloneType = (new TlbReplaceIO(Width, q)).asInstanceOf[this.type]
345a0301c0dSLemover}
346a0301c0dSLemover
3476d5ddbceSLemoverclass TlbReq(implicit p: Parameters) extends TlbBundle {
3486d5ddbceSLemover  val vaddr = UInt(VAddrBits.W)
3496d5ddbceSLemover  val cmd = TlbCmd()
350*b6982e83SLemover  val size = UInt(log2Ceil(log2Ceil(XLEN/8)+1).W)
3519aca92b9SYinan Xu  val robIdx = new RobPtr
3526d5ddbceSLemover  val debug = new Bundle {
3536d5ddbceSLemover    val pc = UInt(XLEN.W)
3546d5ddbceSLemover    val isFirstIssue = Bool()
3556d5ddbceSLemover  }
3566d5ddbceSLemover
3576d5ddbceSLemover  override def toPrintable: Printable = {
3589aca92b9SYinan Xu    p"vaddr:0x${Hexadecimal(vaddr)} cmd:${cmd} pc:0x${Hexadecimal(debug.pc)} robIdx:${robIdx}"
3596d5ddbceSLemover  }
3606d5ddbceSLemover}
3616d5ddbceSLemover
362*b6982e83SLemoverclass TlbExceptionBundle(implicit p: Parameters) extends TlbBundle {
363*b6982e83SLemover  val ld = Output(Bool())
364*b6982e83SLemover  val st = Output(Bool())
365*b6982e83SLemover  val instr = Output(Bool())
366*b6982e83SLemover}
367*b6982e83SLemover
3686d5ddbceSLemoverclass TlbResp(implicit p: Parameters) extends TlbBundle {
3696d5ddbceSLemover  val paddr = UInt(PAddrBits.W)
3706d5ddbceSLemover  val miss = Bool()
3716d5ddbceSLemover  val mmio = Bool()
3726d5ddbceSLemover  val excp = new Bundle {
373*b6982e83SLemover    val pf = new TlbExceptionBundle()
374*b6982e83SLemover    val af = new TlbExceptionBundle()
3756d5ddbceSLemover  }
3766d5ddbceSLemover  val ptwBack = Bool() // when ptw back, wake up replay rs's state
3776d5ddbceSLemover
3786d5ddbceSLemover  override def toPrintable: Printable = {
3796d5ddbceSLemover    p"paddr:0x${Hexadecimal(paddr)} miss:${miss} excp.pf: ld:${excp.pf.ld} st:${excp.pf.st} instr:${excp.pf.instr} ptwBack:${ptwBack}"
3806d5ddbceSLemover  }
3816d5ddbceSLemover}
3826d5ddbceSLemover
3836d5ddbceSLemoverclass TlbRequestIO()(implicit p: Parameters) extends TlbBundle {
3846d5ddbceSLemover  val req = DecoupledIO(new TlbReq)
3856d5ddbceSLemover  val resp = Flipped(DecoupledIO(new TlbResp))
3866d5ddbceSLemover}
3876d5ddbceSLemover
3886d5ddbceSLemoverclass BlockTlbRequestIO()(implicit p: Parameters) extends TlbBundle {
3896d5ddbceSLemover  val req = DecoupledIO(new TlbReq)
3906d5ddbceSLemover  val resp = Flipped(DecoupledIO(new TlbResp))
3916d5ddbceSLemover}
3926d5ddbceSLemover
3936d5ddbceSLemoverclass TlbPtwIO(Width: Int = 1)(implicit p: Parameters) extends TlbBundle {
3946d5ddbceSLemover  val req = Vec(Width, DecoupledIO(new PtwReq))
3956d5ddbceSLemover  val resp = Flipped(DecoupledIO(new PtwResp))
3966d5ddbceSLemover
3976d5ddbceSLemover  override def cloneType: this.type = (new TlbPtwIO(Width)).asInstanceOf[this.type]
3986d5ddbceSLemover
3996d5ddbceSLemover  override def toPrintable: Printable = {
4006d5ddbceSLemover    p"req(0):${req(0).valid} ${req(0).ready} ${req(0).bits} | resp:${resp.valid} ${resp.ready} ${resp.bits}"
4016d5ddbceSLemover  }
4026d5ddbceSLemover}
4036d5ddbceSLemover
404a0301c0dSLemoverclass TlbBaseBundle(implicit p: Parameters) extends TlbBundle {
405b052b972SLemover  val sfence = Input(new SfenceBundle)
406b052b972SLemover  val csr = Input(new TlbCsrBundle)
407a0301c0dSLemover}
4086d5ddbceSLemover
409a0301c0dSLemoverclass TlbIO(Width: Int, q: TLBParameters)(implicit p: Parameters) extends
410a0301c0dSLemover  TlbBaseBundle {
411a0301c0dSLemover  val requestor = Vec(Width, Flipped(new TlbRequestIO))
412a0301c0dSLemover  val ptw = new TlbPtwIO(Width)
413a0301c0dSLemover  val replace = if (q.outReplace) Flipped(new TlbReplaceIO(Width, q)) else null
414*b6982e83SLemover  val pmp = Vec(Width, ValidIO(new PMPReqBundle()))
415a0301c0dSLemover
416a0301c0dSLemover  override def cloneType: this.type = (new TlbIO(Width, q)).asInstanceOf[this.type]
417a0301c0dSLemover}
418a0301c0dSLemover
419a0301c0dSLemoverclass BTlbPtwIO(Width: Int)(implicit p: Parameters) extends TlbBundle {
420a0301c0dSLemover  val req = Vec(Width, DecoupledIO(new PtwReq))
421a0301c0dSLemover  val resp = Flipped(DecoupledIO(new Bundle {
422a0301c0dSLemover    val data = new PtwResp
423a0301c0dSLemover    val vector = Output(Vec(Width, Bool()))
424a0301c0dSLemover  }))
425a0301c0dSLemover
426a0301c0dSLemover  override def cloneType: this.type = (new BTlbPtwIO(Width)).asInstanceOf[this.type]
427a0301c0dSLemover}
428a0301c0dSLemover/****************************  Bridge TLB *******************************/
429a0301c0dSLemover
430a0301c0dSLemoverclass BridgeTLBIO(Width: Int)(implicit p: Parameters) extends TlbBaseBundle {
431a0301c0dSLemover  val requestor = Vec(Width, Flipped(new TlbPtwIO()))
432a0301c0dSLemover  val ptw = new BTlbPtwIO(Width)
433a0301c0dSLemover
434a0301c0dSLemover  override def cloneType: this.type = (new BridgeTLBIO(Width)).asInstanceOf[this.type]
4356d5ddbceSLemover}
4366d5ddbceSLemover
4376d5ddbceSLemover
4386d5ddbceSLemover/****************************  PTW  *************************************/
4396d5ddbceSLemoverabstract class PtwBundle(implicit p: Parameters) extends XSBundle with HasPtwConst
4406d5ddbceSLemoverabstract class PtwModule(outer: PTW) extends LazyModuleImp(outer)
4416d5ddbceSLemover  with HasXSParameter with HasPtwConst
4426d5ddbceSLemover
4436d5ddbceSLemoverclass PteBundle(implicit p: Parameters) extends PtwBundle{
4446d5ddbceSLemover  val reserved  = UInt(pteResLen.W)
4456d5ddbceSLemover  val ppn  = UInt(ppnLen.W)
4466d5ddbceSLemover  val rsw  = UInt(2.W)
4476d5ddbceSLemover  val perm = new Bundle {
4486d5ddbceSLemover    val d    = Bool()
4496d5ddbceSLemover    val a    = Bool()
4506d5ddbceSLemover    val g    = Bool()
4516d5ddbceSLemover    val u    = Bool()
4526d5ddbceSLemover    val x    = Bool()
4536d5ddbceSLemover    val w    = Bool()
4546d5ddbceSLemover    val r    = Bool()
4556d5ddbceSLemover    val v    = Bool()
4566d5ddbceSLemover  }
4576d5ddbceSLemover
4586d5ddbceSLemover  def unaligned(level: UInt) = {
4596d5ddbceSLemover    isLeaf() && !(level === 2.U ||
4606d5ddbceSLemover                  level === 1.U && ppn(vpnnLen-1,   0) === 0.U ||
4616d5ddbceSLemover                  level === 0.U && ppn(vpnnLen*2-1, 0) === 0.U)
4626d5ddbceSLemover  }
4636d5ddbceSLemover
4646d5ddbceSLemover  def isPf(level: UInt) = {
4656d5ddbceSLemover    !perm.v || (!perm.r && perm.w) || unaligned(level)
4666d5ddbceSLemover  }
4676d5ddbceSLemover
4686d5ddbceSLemover  def isLeaf() = {
4696d5ddbceSLemover    perm.r || perm.x || perm.w
4706d5ddbceSLemover  }
4716d5ddbceSLemover
4726d5ddbceSLemover  def getPerm() = {
4736d5ddbceSLemover    val pm = Wire(new PtePermBundle)
4746d5ddbceSLemover    pm.d := perm.d
4756d5ddbceSLemover    pm.a := perm.a
4766d5ddbceSLemover    pm.g := perm.g
4776d5ddbceSLemover    pm.u := perm.u
4786d5ddbceSLemover    pm.x := perm.x
4796d5ddbceSLemover    pm.w := perm.w
4806d5ddbceSLemover    pm.r := perm.r
4816d5ddbceSLemover    pm
4826d5ddbceSLemover  }
4836d5ddbceSLemover
4846d5ddbceSLemover  override def toPrintable: Printable = {
4856d5ddbceSLemover    p"ppn:0x${Hexadecimal(ppn)} perm:b${Binary(perm.asUInt)}"
4866d5ddbceSLemover  }
4876d5ddbceSLemover}
4886d5ddbceSLemover
4896d5ddbceSLemoverclass PtwEntry(tagLen: Int, hasPerm: Boolean = false, hasLevel: Boolean = false)(implicit p: Parameters) extends PtwBundle {
4906d5ddbceSLemover  val tag = UInt(tagLen.W)
4916d5ddbceSLemover  val ppn = UInt(ppnLen.W)
4926d5ddbceSLemover  val perm = if (hasPerm) Some(new PtePermBundle) else None
4936d5ddbceSLemover  val level = if (hasLevel) Some(UInt(log2Up(Level).W)) else None
4946d5ddbceSLemover
4956d5ddbceSLemover  def hit(vpn: UInt, allType: Boolean = false) = {
4966d5ddbceSLemover    require(vpn.getWidth == vpnLen)
4976d5ddbceSLemover    if (allType) {
4986d5ddbceSLemover      require(hasLevel)
4996d5ddbceSLemover      val hit0 = tag(tagLen - 1,    vpnnLen*2) === vpn(tagLen - 1, vpnnLen*2)
5006d5ddbceSLemover      val hit1 = tag(vpnnLen*2 - 1, vpnnLen)   === vpn(vpnnLen*2 - 1,  vpnnLen)
5016d5ddbceSLemover      val hit2 = tag(vpnnLen - 1,     0)         === vpn(vpnnLen - 1, 0)
5026d5ddbceSLemover      Mux(level.getOrElse(0.U) === 2.U, hit2 && hit1 && hit0, Mux(level.getOrElse(0.U) === 1.U, hit1 && hit0, hit0))
5036d5ddbceSLemover    } else if (hasLevel) {
5046d5ddbceSLemover      val hit0 = tag(tagLen - 1, tagLen - vpnnLen) === vpn(vpnLen - 1, vpnLen - vpnnLen)
5056d5ddbceSLemover      val hit1 = tag(tagLen - vpnnLen - 1, tagLen - vpnnLen * 2) === vpn(vpnLen - vpnnLen - 1, vpnLen - vpnnLen * 2)
5066d5ddbceSLemover      Mux(level.getOrElse(0.U) === 0.U, hit0, hit0 && hit1)
5076d5ddbceSLemover    } else {
5086d5ddbceSLemover      tag === vpn(vpnLen - 1, vpnLen - tagLen)
5096d5ddbceSLemover    }
5106d5ddbceSLemover  }
5116d5ddbceSLemover
5126d5ddbceSLemover  def refill(vpn: UInt, pte: UInt, level: UInt = 0.U) {
5136d5ddbceSLemover    tag := vpn(vpnLen - 1, vpnLen - tagLen)
514a0301c0dSLemover    ppn := pte.asTypeOf(new PteBundle().cloneType).ppn
515a0301c0dSLemover    perm.map(_ := pte.asTypeOf(new PteBundle().cloneType).perm)
5166d5ddbceSLemover    this.level.map(_ := level)
5176d5ddbceSLemover  }
5186d5ddbceSLemover
5196d5ddbceSLemover  def genPtwEntry(vpn: UInt, pte: UInt, level: UInt = 0.U) = {
5206d5ddbceSLemover    val e = Wire(new PtwEntry(tagLen, hasPerm, hasLevel))
5216d5ddbceSLemover    e.refill(vpn, pte, level)
5226d5ddbceSLemover    e
5236d5ddbceSLemover  }
5246d5ddbceSLemover
5256d5ddbceSLemover  override def cloneType: this.type = (new PtwEntry(tagLen, hasPerm, hasLevel)).asInstanceOf[this.type]
5266d5ddbceSLemover
5276d5ddbceSLemover  override def toPrintable: Printable = {
5286d5ddbceSLemover    // p"tag:0x${Hexadecimal(tag)} ppn:0x${Hexadecimal(ppn)} perm:${perm}"
5296d5ddbceSLemover    p"tag:0x${Hexadecimal(tag)} ppn:0x${Hexadecimal(ppn)} " +
5306d5ddbceSLemover      (if (hasPerm) p"perm:${perm.getOrElse(0.U.asTypeOf(new PtePermBundle))} " else p"") +
5316d5ddbceSLemover      (if (hasLevel) p"level:${level.getOrElse(0.U)}" else p"")
5326d5ddbceSLemover  }
5336d5ddbceSLemover}
5346d5ddbceSLemover
5356d5ddbceSLemoverclass PtwEntries(num: Int, tagLen: Int, level: Int, hasPerm: Boolean)(implicit p: Parameters) extends PtwBundle {
5366d5ddbceSLemover  require(log2Up(num)==log2Down(num))
5376d5ddbceSLemover
5386d5ddbceSLemover  val tag  = UInt(tagLen.W)
5396d5ddbceSLemover  val ppns = Vec(num, UInt(ppnLen.W))
5406d5ddbceSLemover  val vs   = Vec(num, Bool())
5416d5ddbceSLemover  val perms = if (hasPerm) Some(Vec(num, new PtePermBundle)) else None
5426d5ddbceSLemover  // println(s"PtwEntries: tag:1*${tagLen} ppns:${num}*${ppnLen} vs:${num}*1")
5436d5ddbceSLemover
5446d5ddbceSLemover  def tagClip(vpn: UInt) = {
5456d5ddbceSLemover    require(vpn.getWidth == vpnLen)
5466d5ddbceSLemover    vpn(vpnLen - 1, vpnLen - tagLen)
5476d5ddbceSLemover  }
5486d5ddbceSLemover
5496d5ddbceSLemover  def sectorIdxClip(vpn: UInt, level: Int) = {
5506d5ddbceSLemover    getVpnClip(vpn, level)(log2Up(num) - 1, 0)
5516d5ddbceSLemover  }
5526d5ddbceSLemover
5536d5ddbceSLemover  def hit(vpn: UInt) = {
5546d5ddbceSLemover    tag === tagClip(vpn) && vs(sectorIdxClip(vpn, level)) // TODO: optimize this. don't need to compare each with tag
5556d5ddbceSLemover  }
5566d5ddbceSLemover
5576d5ddbceSLemover  def genEntries(vpn: UInt, data: UInt, levelUInt: UInt) = {
5586d5ddbceSLemover    require((data.getWidth / XLEN) == num,
5595854c1edSLemover      s"input data length must be multiple of pte length: data.length:${data.getWidth} num:${num}")
5606d5ddbceSLemover
5616d5ddbceSLemover    val ps = Wire(new PtwEntries(num, tagLen, level, hasPerm))
5626d5ddbceSLemover    ps.tag := tagClip(vpn)
5636d5ddbceSLemover    for (i <- 0 until num) {
5646d5ddbceSLemover      val pte = data((i+1)*XLEN-1, i*XLEN).asTypeOf(new PteBundle)
5656d5ddbceSLemover      ps.ppns(i) := pte.ppn
5666d5ddbceSLemover      ps.vs(i)   := !pte.isPf(levelUInt) && (if (hasPerm) pte.isLeaf() else !pte.isLeaf())
5676d5ddbceSLemover      ps.perms.map(_(i) := pte.perm)
5686d5ddbceSLemover    }
5696d5ddbceSLemover    ps
5706d5ddbceSLemover  }
5716d5ddbceSLemover
5726d5ddbceSLemover  override def cloneType: this.type = (new PtwEntries(num, tagLen, level, hasPerm)).asInstanceOf[this.type]
5736d5ddbceSLemover  override def toPrintable: Printable = {
5746d5ddbceSLemover    // require(num == 4, "if num is not 4, please comment this toPrintable")
5756d5ddbceSLemover    // NOTE: if num is not 4, please comment this toPrintable
5766d5ddbceSLemover    val permsInner = perms.getOrElse(0.U.asTypeOf(Vec(num, new PtePermBundle)))
5776d5ddbceSLemover    p"tag:0x${Hexadecimal(tag)} ppns:${printVec(ppns)} vs:${Binary(vs.asUInt)} " +
5786d5ddbceSLemover      (if (hasPerm) p"perms:${printVec(permsInner)}" else p"")
5796d5ddbceSLemover  }
5806d5ddbceSLemover}
5816d5ddbceSLemover
5827196f5a2SLemoverclass PTWEntriesWithEcc(eccCode: Code, num: Int, tagLen: Int, level: Int, hasPerm: Boolean)(implicit p: Parameters) extends PtwBundle {
5837196f5a2SLemover  val entries = new PtwEntries(num, tagLen, level, hasPerm)
5847196f5a2SLemover
5857196f5a2SLemover  private val encBits = eccCode.width(entries.getWidth)
5867196f5a2SLemover  private val eccBits = encBits - entries.getWidth
5877196f5a2SLemover  val ecc = UInt(eccBits.W)
5887196f5a2SLemover
5897196f5a2SLemover  override def cloneType: this.type = new PTWEntriesWithEcc(eccCode, num, tagLen, level, hasPerm).asInstanceOf[this.type]
5907196f5a2SLemover}
5917196f5a2SLemover
5926d5ddbceSLemoverclass PtwReq(implicit p: Parameters) extends PtwBundle {
5936d5ddbceSLemover  val vpn = UInt(vpnLen.W)
5946d5ddbceSLemover
5956d5ddbceSLemover  override def toPrintable: Printable = {
5966d5ddbceSLemover    p"vpn:0x${Hexadecimal(vpn)}"
5976d5ddbceSLemover  }
5986d5ddbceSLemover}
5996d5ddbceSLemover
6006d5ddbceSLemoverclass PtwResp(implicit p: Parameters) extends PtwBundle {
6016d5ddbceSLemover  val entry = new PtwEntry(tagLen = vpnLen, hasPerm = true, hasLevel = true)
6026d5ddbceSLemover  val pf = Bool()
603*b6982e83SLemover  val af = Bool()
6046d5ddbceSLemover
605*b6982e83SLemover  def apply(pf: Bool, af: Bool, level: UInt, pte: PteBundle, vpn: UInt) = {
6065854c1edSLemover    this.entry.level.map(_ := level)
6075854c1edSLemover    this.entry.tag := vpn
6085854c1edSLemover    this.entry.perm.map(_ := pte.getPerm())
6095854c1edSLemover    this.entry.ppn := pte.ppn
6105854c1edSLemover    this.pf := pf
611*b6982e83SLemover    this.af := af
6125854c1edSLemover  }
6135854c1edSLemover
6146d5ddbceSLemover  override def toPrintable: Printable = {
615*b6982e83SLemover    p"entry:${entry} pf:${pf} af:${af}"
6166d5ddbceSLemover  }
6176d5ddbceSLemover}
6186d5ddbceSLemover
6196d5ddbceSLemoverclass PtwIO(implicit p: Parameters) extends PtwBundle {
6206d5ddbceSLemover  val tlb = Vec(PtwWidth, Flipped(new TlbPtwIO))
6216d5ddbceSLemover  val sfence = Input(new SfenceBundle)
622*b6982e83SLemover  val csr = new Bundle {
623*b6982e83SLemover    val tlb = Input(new TlbCsrBundle)
624*b6982e83SLemover    val distribute_csr = Flipped(new DistributedCSRIO)
625*b6982e83SLemover  }
6266d5ddbceSLemover}
6276d5ddbceSLemover
628b848eea5SLemoverclass L2TlbMemReqBundle(implicit p: Parameters) extends PtwBundle {
629b848eea5SLemover  val addr = UInt(PAddrBits.W)
630b848eea5SLemover  val id = UInt(bMemID.W)
631b848eea5SLemover}
632