xref: /XiangShan/src/main/scala/xiangshan/cache/mmu/MMUConst.scala (revision 8a020714df826c6ac860308700137855ecd6ba07)
1/***************************************************************************************
2* Copyright (c) 2024 Beijing Institute of Open Source Chip (BOSC)
3* Copyright (c) 2020-2024 Institute of Computing Technology, Chinese Academy of Sciences
4* Copyright (c) 2020-2021 Peng Cheng Laboratory
5*
6* XiangShan is licensed under Mulan PSL v2.
7* You can use this software according to the terms and conditions of the Mulan PSL v2.
8* You may obtain a copy of Mulan PSL v2 at:
9*          http://license.coscl.org.cn/MulanPSL2
10*
11* THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND,
12* EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT,
13* MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
14*
15* See the Mulan PSL v2 for more details.
16***************************************************************************************/
17
18package xiangshan.cache.mmu
19
20import org.chipsalliance.cde.config.Parameters
21import chisel3._
22import chisel3.util._
23import xiangshan._
24import xiangshan.cache.{HasDCacheParameters, MemoryOpConstants}
25import utils._
26import utility._
27import freechips.rocketchip.diplomacy.{LazyModule, LazyModuleImp}
28import freechips.rocketchip.tilelink._
29
30
31case class TLBParameters
32(
33  name: String = "none",
34  fetchi: Boolean = false, // TODO: remove it
35  fenceDelay: Int = 2,
36  useDmode: Boolean = true,
37  NSets: Int = 1,
38  NWays: Int = 2,
39  Replacer: Option[String] = Some("plru"),
40  Associative: String = "fa", // must be fa
41  outReplace: Boolean = false,
42  partialStaticPMP: Boolean = false, // partial static pmp result stored in entries
43  outsideRecvFlush: Boolean = false, // if outside moudle waiting for tlb recv flush pipe
44  saveLevel: Boolean = false,
45  lgMaxSize: Int = 3
46)
47
48case class L2TLBParameters
49(
50  name: String = "l2tlb",
51  // l3
52  l3Size: Int = 16,
53  l3Associative: String = "fa",
54  l3Replacer: Option[String] = Some("plru"),
55  // l2
56  l2Size: Int = 16,
57  l2Associative: String = "fa",
58  l2Replacer: Option[String] = Some("plru"),
59  // l1
60  l1nSets: Int = 8,
61  l1nWays: Int = 4,
62  l1Replacer: Option[String] = Some("setplru"),
63  // l0
64  l0nSets: Int = 32,
65  l0nWays: Int = 8,
66  l0Replacer: Option[String] = Some("setplru"),
67  // sp
68  spSize: Int = 16,
69  spReplacer: Option[String] = Some("plru"),
70  // filter
71  ifilterSize: Int = 8,
72  dfilterSize: Int = 32,
73  // miss queue, add more entries than 'must require'
74  // 0 for easier bug trigger, please set as big as u can, 8 maybe
75  missqueueExtendSize: Int = 0,
76  // llptw
77  llptwsize: Int = 6,
78  // way size
79  blockBytes: Int = 64,
80  // prefetch
81  enablePrefetch: Boolean = true,
82  // ecc
83  ecc: Option[String] = Some("secded"),
84  // enable ecc
85  enablePTWECC: Boolean = false
86)
87
88trait HasTlbConst extends HasXSParameter {
89  val Level = if (EnableSv48) 3 else 2
90
91  val offLen  = 12
92  val ppnLen  = PAddrBits - offLen
93  val vpnnLen = 9
94  val extendVpnnBits = if (HasHExtension) 2 else 0
95  val vpnLen  = VAddrBits - offLen // when opening H extention, vpnlen broaden two bits
96  /*
97    Sv39 page table entry
98    +--+------+--------+----------------------+-----+--------+
99    |63|62  61|60    54|53                  10|9   8|7      0|
100    +--+------+--------+----------------------+-----+--------+
101    |N | PBMT |Reserved|        PPNs          | RSW |  FALG  |
102    +--+------+--------+----------------------+-----+--------+
103  */
104  val pteFlagLen = 8
105  val pteRswLen = 2
106  val ptePPNLen = 44
107  val pteResLen = 7
108  val ptePbmtLen = 2
109  val pteNLen = 1
110  val ppnHignLen = ptePPNLen - ppnLen
111  val gvpnLen = GPAddrBits - offLen
112
113  val tlbcontiguous = 8
114  val sectortlbwidth = log2Up(tlbcontiguous)
115  val sectorppnLen = ppnLen - sectortlbwidth
116  val sectorgvpnLen = gvpnLen - sectortlbwidth
117  val sectorvpnLen = vpnLen - sectortlbwidth
118  val sectorptePPNLen = ptePPNLen - sectortlbwidth
119
120  val loadfiltersize = 16 // 4*3(LduCnt:2 + HyuCnt:1) + 4(prefetch:1)
121  val storefiltersize = if (StorePipelineWidth >= 3) 16 else 8
122  val prefetchfiltersize = 8
123
124  val sramSinglePort = true
125
126  val timeOutThreshold = 10000
127
128  def noS2xlate = "b00".U
129  def allStage = "b11".U
130  def onlyStage1 = "b01".U
131  def onlyStage2 = "b10".U
132
133  def Sv39 = "h8".U
134  def Sv48 = "h9".U
135
136  def get_pn(addr: UInt) = {
137    require(addr.getWidth > offLen)
138    addr(addr.getWidth-1, offLen)
139  }
140  def get_off(addr: UInt) = {
141    require(addr.getWidth > offLen)
142    addr(offLen-1, 0)
143  }
144
145  def get_set_idx(vpn: UInt, nSets: Int): UInt = {
146    require(nSets >= 1)
147    vpn(log2Up(nSets)-1, 0)
148  }
149
150  def drop_set_idx(vpn: UInt, nSets: Int): UInt = {
151    require(nSets >= 1)
152    require(vpn.getWidth > log2Ceil(nSets))
153    vpn(vpn.getWidth-1, log2Ceil(nSets))
154  }
155
156  def drop_set_equal(vpn1: UInt, vpn2: UInt, nSets: Int): Bool = {
157    require(nSets >= 1)
158    require(vpn1.getWidth == vpn2.getWidth)
159    if (vpn1.getWidth <= log2Ceil(nSets)) {
160      true.B
161    } else {
162      drop_set_idx(vpn1, nSets) === drop_set_idx(vpn2, nSets)
163    }
164  }
165
166  def replaceWrapper(v: UInt, lruIdx: UInt): UInt = {
167    val width = v.getWidth
168    val emptyIdx = ParallelPriorityMux((0 until width).map( i => (!v(i), i.U(log2Up(width).W))))
169    val full = Cat(v).andR
170    Mux(full, lruIdx, emptyIdx)
171  }
172
173  def replaceWrapper(v: Seq[Bool], lruIdx: UInt): UInt = {
174    replaceWrapper(VecInit(v).asUInt, lruIdx)
175  }
176
177  import scala.language.implicitConversions
178
179  implicit def hptwresp_to_tlbperm(hptwResp: HptwResp): TlbPermBundle = {
180    val tp = Wire(new TlbPermBundle)
181    val ptePerm = hptwResp.entry.perm.get.asTypeOf(new PtePermBundle().cloneType)
182    tp.pf := hptwResp.gpf
183    tp.af := hptwResp.gaf
184    tp.d := ptePerm.d
185    tp.a := ptePerm.a
186    tp.g := ptePerm.g
187    tp.u := ptePerm.u
188    tp.x := ptePerm.x
189    tp.w := ptePerm.w
190    tp.r := ptePerm.r
191    tp
192  }
193
194  implicit def ptwresp_to_tlbperm(ptwResp: PtwSectorResp): TlbPermBundle = {
195    val tp = Wire(new TlbPermBundle)
196    val ptePerm = ptwResp.entry.perm.get.asTypeOf(new PtePermBundle().cloneType)
197    tp.pf := ptwResp.pf
198    tp.af := ptwResp.af
199    tp.d := ptePerm.d
200    tp.a := ptePerm.a
201    tp.g := ptePerm.g
202    tp.u := ptePerm.u
203    tp.x := ptePerm.x
204    tp.w := ptePerm.w
205    tp.r := ptePerm.r
206    tp
207  }
208}
209
210trait HasPtwConst extends HasTlbConst with MemoryOpConstants{
211  val PtwWidth = 2
212  val sourceWidth = { if (l2tlbParams.enablePrefetch) PtwWidth + 1 else PtwWidth}
213  val prefetchID = PtwWidth
214
215  val blockBits = l2tlbParams.blockBytes * 8
216
217  val bPtwWidth = log2Up(PtwWidth)
218  val bSourceWidth = log2Up(sourceWidth)
219  // ptwl3: fully-associated
220  val PtwL3TagLen = if (EnableSv48) vpnnLen + extendVpnnBits else 0
221  // ptwl2: fully-associated
222  val PtwL2TagLen = if (EnableSv48) vpnnLen * 2 + extendVpnnBits else vpnnLen + extendVpnnBits
223
224  /* +-------+----------+-------------+
225   * |  Tag  |  SetIdx  |  SectorIdx  |
226   * +-------+----------+-------------+
227   */
228  // ptwl1: 8-way group-associated
229  val PtwL1SetNum = l2tlbParams.l1nSets
230  val PtwL1SectorSize = blockBits / XLEN
231  val PtwL1IdxLen = log2Up(PtwL1SetNum * PtwL1SectorSize)
232  val PtwL1SectorIdxLen = log2Up(PtwL1SectorSize)
233  val PtwL1SetIdxLen = log2Up(PtwL1SetNum)
234  val PtwL1TagLen = if (EnableSv48) vpnnLen * 3 - PtwL1IdxLen + extendVpnnBits else vpnnLen * 2 - PtwL1IdxLen + extendVpnnBits
235
236  // ptwl0: 16-way group-associated
237  val PtwL0SetNum = l2tlbParams.l0nSets
238  val PtwL0SectorSize =  blockBits / XLEN
239  val PtwL0IdxLen = log2Up(PtwL0SetNum * PtwL0SectorSize)
240  val PtwL0SectorIdxLen = log2Up(PtwL0SectorSize)
241  val PtwL0SetIdxLen = log2Up(PtwL0SetNum)
242  val PtwL0TagLen = if (EnableSv48) vpnnLen * 4 - PtwL0IdxLen + extendVpnnBits else vpnnLen * 3 - PtwL0IdxLen + extendVpnnBits
243
244  // super page, including 1GB and 2MB page
245  val SPTagLen = if (EnableSv48) vpnnLen * 3 + extendVpnnBits else vpnnLen * 2 + extendVpnnBits
246
247  // miss queue
248  val MissQueueSize = l2tlbParams.ifilterSize + l2tlbParams.dfilterSize
249  val MemReqWidth = l2tlbParams.llptwsize + 1 + 1
250  val HptwReqId = l2tlbParams.llptwsize + 1
251  val FsmReqID = l2tlbParams.llptwsize
252  val bMemID = log2Up(MemReqWidth)
253
254  def genPtwL1Idx(vpn: UInt) = {
255    (vpn(vpnLen - 1, vpnnLen))(PtwL1IdxLen - 1, 0)
256  }
257
258  def genPtwL1SectorIdx(vpn: UInt) = {
259    genPtwL1Idx(vpn)(PtwL1SectorIdxLen - 1, 0)
260  }
261
262  def genPtwL1SetIdx(vpn: UInt) = {
263    genPtwL1Idx(vpn)(PtwL1SetIdxLen + PtwL1SectorIdxLen - 1, PtwL1SectorIdxLen)
264  }
265
266  def genPtwL0Idx(vpn: UInt) = {
267    vpn(PtwL0IdxLen - 1, 0)
268  }
269
270  def genPtwL0SectorIdx(vpn: UInt) = {
271    genPtwL0Idx(vpn)(PtwL0SectorIdxLen - 1, 0)
272  }
273
274  def dropL0SectorBits(vpn: UInt) = {
275    vpn(vpn.getWidth-1, PtwL0SectorIdxLen)
276  }
277
278  def genPtwL0SetIdx(vpn: UInt) = {
279    genPtwL0Idx(vpn)(PtwL0SetIdxLen + PtwL0SectorIdxLen - 1, PtwL0SectorIdxLen)
280  }
281
282  def MakeAddr(ppn: UInt, off: UInt) = {
283    require(off.getWidth == 9)
284    Cat(ppn, off, 0.U(log2Up(XLEN/8).W))
285  }
286
287  def MakeGPAddr(ppn: UInt, off: UInt) = {
288    require(off.getWidth == 9 || off.getWidth == 11)
289    (Cat(ppn, 0.U(offLen.W)) + Cat(off, 0.U(log2Up(XLEN / 8).W)))(GPAddrBits - 1, 0)
290  }
291
292  def getVpnn(vpn: UInt, idx: Int): UInt = {
293    vpn(vpnnLen*(idx+1)-1, vpnnLen*idx)
294  }
295
296  def getVpnn(vpn: UInt, idx: UInt): UInt = {
297    MuxLookup(idx, 0.U)(Seq(
298      0.U -> vpn(vpnnLen - 1, 0),
299      1.U -> vpn(vpnnLen * 2 - 1, vpnnLen),
300      2.U -> vpn(vpnnLen * 3 - 1, vpnnLen * 2),
301      3.U -> vpn(vpnnLen * 4 - 1, vpnnLen * 3))
302    )
303  }
304
305  def getGVpnn(vpn: UInt, idx: UInt, mode: UInt): UInt = {
306    MuxLookup(idx, 0.U)(Seq(
307      0.U -> vpn(vpnnLen - 1, 0),
308      1.U -> vpn(vpnnLen * 2 - 1, vpnnLen),
309      2.U -> Mux(mode === Sv48, vpn(vpnnLen * 3 - 1, vpnnLen * 2), vpn(vpnnLen * 3 + 1, vpnnLen * 2)),
310      3.U -> vpn(vpnnLen * 4 + 1, vpnnLen * 3))
311    )
312  }
313
314  def getVpnClip(vpn: UInt, level: Int) = {
315    // level 2  /* vpnn2 */
316    // level 1  /* vpnn2 * vpnn1 */
317    // level 0  /* vpnn2 * vpnn1 * vpnn0*/
318    vpn(vpnLen - 1, level * vpnnLen)
319  }
320
321  def get_next_line(vpn: UInt) = {
322    Cat(dropL0SectorBits(vpn) + 1.U, 0.U(PtwL0SectorIdxLen.W))
323  }
324
325  def same_l1entry(vpn1: UInt, vpn2: UInt) = {
326    vpn1(vpnLen-1, vpnnLen) === vpn2(vpnLen-1, vpnnLen)
327  }
328
329  def from_pre(source: UInt) = {
330    (source === prefetchID.U)
331  }
332
333  def sel_data(data: UInt, index: UInt): UInt = {
334    val inner_data = data.asTypeOf(Vec(data.getWidth / XLEN, UInt(XLEN.W)))
335    inner_data(index)
336  }
337
338  // vpn1 and vpn2 is at same cacheline
339  def dup(vpn1: UInt, vpn2: UInt): Bool = {
340    dropL0SectorBits(vpn1) === dropL0SectorBits(vpn2)
341  }
342
343
344  def printVec[T <: Data](x: Seq[T]): Printable = {
345    (0 until x.length).map(i => p"(${i.U})${x(i)} ").reduce(_+_)
346  }
347}
348