xref: /XiangShan/src/main/scala/xiangshan/cache/mmu/MMUConst.scala (revision 78a8cd257caa1ff2b977d80082b1b3a2fa98a1d3)
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.cache.mmu
18
19import org.chipsalliance.cde.config.Parameters
20import chisel3._
21import chisel3.util._
22import xiangshan._
23import xiangshan.cache.{HasDCacheParameters, MemoryOpConstants}
24import utils._
25import utility._
26import freechips.rocketchip.diplomacy.{LazyModule, LazyModuleImp}
27import freechips.rocketchip.tilelink._
28
29
30case class TLBParameters
31(
32  name: String = "none",
33  fetchi: Boolean = false, // TODO: remove it
34  fenceDelay: Int = 2,
35  useDmode: Boolean = true,
36  NSets: Int = 1,
37  NWays: Int = 2,
38  Replacer: Option[String] = Some("plru"),
39  Associative: String = "fa", // must be fa
40  outReplace: Boolean = false,
41  partialStaticPMP: Boolean = false, // partial static pmp result stored in entries
42  outsideRecvFlush: Boolean = false, // if outside moudle waiting for tlb recv flush pipe
43  saveLevel: Boolean = false,
44  lgMaxSize: Int = 3
45)
46
47case class L2TLBParameters
48(
49  name: String = "l2tlb",
50  // l1
51  l1Size: Int = 16,
52  l1Associative: String = "fa",
53  l1Replacer: Option[String] = Some("plru"),
54  // l2
55  l2nSets: Int = 8,
56  l2nWays: Int = 4,
57  l2Replacer: Option[String] = Some("setplru"),
58  // l3
59  l3nSets: Int = 32,
60  l3nWays: Int = 8,
61  l3Replacer: Option[String] = Some("setplru"),
62  // sp
63  spSize: Int = 16,
64  spReplacer: Option[String] = Some("plru"),
65  // filter
66  ifilterSize: Int = 8,
67  dfilterSize: Int = 32,
68  // miss queue, add more entries than 'must require'
69  // 0 for easier bug trigger, please set as big as u can, 8 maybe
70  missqueueExtendSize: Int = 0,
71  // llptw
72  llptwsize: Int = 6,
73  // way size
74  blockBytes: Int = 64,
75  // prefetch
76  enablePrefetch: Boolean = true,
77  // ecc
78  ecc: Option[String] = Some("secded"),
79  // enable ecc
80  enablePTWECC: Boolean = false
81)
82
83trait HasTlbConst extends HasXSParameter {
84  val Level = 3
85
86  val offLen  = 12
87  val ppnLen  = PAddrBits - offLen
88  val vpnnLen = 9
89  val extendVpnnBits = if (HasHExtension) 2 else 0
90  val vpnLen  = VAddrBits - offLen // when opening H extention, vpnlen broaden two bits
91  val flagLen = 8
92  val pteResLen = XLEN - 44 - 2 - flagLen
93  val ppnHignLen = 44 - ppnLen
94  val gvpnLen = GPAddrBits - offLen
95
96  val tlbcontiguous = 8
97  val sectortlbwidth = log2Up(tlbcontiguous)
98  val sectorppnLen = ppnLen - sectortlbwidth
99  val sectorgvpnLen = gvpnLen - sectortlbwidth
100  val sectorvpnLen = vpnLen - sectortlbwidth
101
102  val loadfiltersize = 16 // 4*3(LduCnt:2 + HyuCnt:1) + 4(prefetch:1)
103  val storefiltersize = if (StorePipelineWidth >= 3) 16 else 8
104  val prefetchfiltersize = 8
105
106  val sramSinglePort = true
107
108  val timeOutThreshold = 10000
109
110  def noS2xlate = "b00".U
111  def allStage = "b11".U
112  def onlyStage1 = "b01".U
113  def onlyStage2 = "b10".U
114
115  def get_pn(addr: UInt) = {
116    require(addr.getWidth > offLen)
117    addr(addr.getWidth-1, offLen)
118  }
119  def get_off(addr: UInt) = {
120    require(addr.getWidth > offLen)
121    addr(offLen-1, 0)
122  }
123
124  def get_set_idx(vpn: UInt, nSets: Int): UInt = {
125    require(nSets >= 1)
126    vpn(log2Up(nSets)-1, 0)
127  }
128
129  def drop_set_idx(vpn: UInt, nSets: Int): UInt = {
130    require(nSets >= 1)
131    require(vpn.getWidth > log2Ceil(nSets))
132    vpn(vpn.getWidth-1, log2Ceil(nSets))
133  }
134
135  def drop_set_equal(vpn1: UInt, vpn2: UInt, nSets: Int): Bool = {
136    require(nSets >= 1)
137    require(vpn1.getWidth == vpn2.getWidth)
138    if (vpn1.getWidth <= log2Ceil(nSets)) {
139      true.B
140    } else {
141      drop_set_idx(vpn1, nSets) === drop_set_idx(vpn2, nSets)
142    }
143  }
144
145  def replaceWrapper(v: UInt, lruIdx: UInt): UInt = {
146    val width = v.getWidth
147    val emptyIdx = ParallelPriorityMux((0 until width).map( i => (!v(i), i.U(log2Up(width).W))))
148    val full = Cat(v).andR
149    Mux(full, lruIdx, emptyIdx)
150  }
151
152  def replaceWrapper(v: Seq[Bool], lruIdx: UInt): UInt = {
153    replaceWrapper(VecInit(v).asUInt, lruIdx)
154  }
155
156  implicit def hptwresp_to_tlbperm(hptwResp: HptwResp): TlbPermBundle = {
157    val tp = Wire(new TlbPermBundle)
158    val ptePerm = hptwResp.entry.perm.get.asTypeOf(new PtePermBundle().cloneType)
159    tp.pf := hptwResp.gpf
160    tp.af := hptwResp.gaf
161    tp.d := ptePerm.d
162    tp.a := ptePerm.a
163    tp.g := ptePerm.g
164    tp.u := ptePerm.u
165    tp.x := ptePerm.x
166    tp.w := ptePerm.w
167    tp.r := ptePerm.r
168    tp
169  }
170
171  implicit def ptwresp_to_tlbperm(ptwResp: PtwSectorResp): TlbPermBundle = {
172    val tp = Wire(new TlbPermBundle)
173    val ptePerm = ptwResp.entry.perm.get.asTypeOf(new PtePermBundle().cloneType)
174    tp.pf := ptwResp.pf
175    tp.af := ptwResp.af
176    tp.d := ptePerm.d
177    tp.a := ptePerm.a
178    tp.g := ptePerm.g
179    tp.u := ptePerm.u
180    tp.x := ptePerm.x
181    tp.w := ptePerm.w
182    tp.r := ptePerm.r
183    tp
184  }
185}
186
187trait HasPtwConst extends HasTlbConst with MemoryOpConstants{
188  val PtwWidth = 2
189  val sourceWidth = { if (l2tlbParams.enablePrefetch) PtwWidth + 1 else PtwWidth}
190  val prefetchID = PtwWidth
191
192  val blockBits = l2tlbParams.blockBytes * 8
193
194  val bPtwWidth = log2Up(PtwWidth)
195  val bSourceWidth = log2Up(sourceWidth)
196  // ptwl1: fully-associated
197  val PtwL1TagLen = vpnnLen + extendVpnnBits
198
199  /* +-------+----------+-------------+
200   * |  Tag  |  SetIdx  |  SectorIdx  |
201   * +-------+----------+-------------+
202   */
203  // ptwl2: 8-way group-associated
204  val PtwL2SetNum = l2tlbParams.l2nSets
205  val PtwL2SectorSize = blockBits / XLEN
206  val PtwL2IdxLen = log2Up(PtwL2SetNum * PtwL2SectorSize)
207  val PtwL2SectorIdxLen = log2Up(PtwL2SectorSize)
208  val PtwL2SetIdxLen = log2Up(PtwL2SetNum)
209  val PtwL2TagLen = vpnnLen * 2 - PtwL2IdxLen + extendVpnnBits
210
211  // ptwl3: 16-way group-associated
212  val PtwL3SetNum = l2tlbParams.l3nSets
213  val PtwL3SectorSize =  blockBits / XLEN
214  val PtwL3IdxLen = log2Up(PtwL3SetNum * PtwL3SectorSize)
215  val PtwL3SectorIdxLen = log2Up(PtwL3SectorSize)
216  val PtwL3SetIdxLen = log2Up(PtwL3SetNum)
217  val PtwL3TagLen = vpnnLen * 3 - PtwL3IdxLen + extendVpnnBits
218
219  // super page, including 1GB and 2MB page
220  val SPTagLen = vpnnLen * 2 + extendVpnnBits
221
222  // miss queue
223  val MissQueueSize = l2tlbParams.ifilterSize + l2tlbParams.dfilterSize
224  val MemReqWidth = l2tlbParams.llptwsize + 1 + 1
225  val HptwReqId = l2tlbParams.llptwsize + 1
226  val FsmReqID = l2tlbParams.llptwsize
227  val bMemID = log2Up(MemReqWidth)
228
229  def genPtwL2Idx(vpn: UInt) = {
230    (vpn(vpnLen - 1, vpnnLen))(PtwL2IdxLen - 1, 0)
231  }
232
233  def genPtwL2SectorIdx(vpn: UInt) = {
234    genPtwL2Idx(vpn)(PtwL2SectorIdxLen - 1, 0)
235  }
236
237  def genPtwL2SetIdx(vpn: UInt) = {
238    genPtwL2Idx(vpn)(PtwL2SetIdxLen + PtwL2SectorIdxLen - 1, PtwL2SectorIdxLen)
239  }
240
241  def genPtwL3Idx(vpn: UInt) = {
242    vpn(PtwL3IdxLen - 1, 0)
243  }
244
245  def genPtwL3SectorIdx(vpn: UInt) = {
246    genPtwL3Idx(vpn)(PtwL3SectorIdxLen - 1, 0)
247  }
248
249  def dropL3SectorBits(vpn: UInt) = {
250    vpn(vpn.getWidth-1, PtwL3SectorIdxLen)
251  }
252
253  def genPtwL3SetIdx(vpn: UInt) = {
254    genPtwL3Idx(vpn)(PtwL3SetIdxLen + PtwL3SectorIdxLen - 1, PtwL3SectorIdxLen)
255  }
256
257  def MakeAddr(ppn: UInt, off: UInt) = {
258    require(off.getWidth == 9)
259    Cat(ppn, off, 0.U(log2Up(XLEN/8).W))(PAddrBits-1, 0)
260  }
261
262  def MakeGPAddr(ppn: UInt, off: UInt) = {
263    require(off.getWidth == 9 || off.getWidth == 11)
264    (Cat(ppn, 0.U(offLen.W)) + Cat(off, 0.U(log2Up(XLEN / 8).W)))(GPAddrBits - 1, 0)
265  }
266
267  def getVpnn(vpn: UInt, idx: Int): UInt = {
268    vpn(vpnnLen*(idx+1)-1, vpnnLen*idx)
269  }
270
271  def getVpnn(vpn: UInt, idx: UInt): UInt = {
272    Mux(idx === 0.U, vpn(vpnnLen - 1, 0), Mux(idx === 1.U, vpn(vpnnLen * 2 - 1, vpnnLen), vpn(vpnnLen * 3 - 1, vpnnLen * 2)))
273  }
274
275  def getGVpnn(vpn: UInt, idx: UInt): UInt = {
276    Mux(idx === 0.U, vpn(vpnnLen - 1, 0), Mux(idx === 1.U, vpn(vpnnLen * 2 - 1, vpnnLen), vpn(vpnnLen * 3 + 1, vpnnLen * 2)))
277  }
278
279  def getVpnClip(vpn: UInt, level: Int) = {
280    // level 0  /* vpnn2 */
281    // level 1  /* vpnn2 * vpnn1 */
282    // level 2  /* vpnn2 * vpnn1 * vpnn0*/
283    vpn(vpnLen - 1, (2 - level) * vpnnLen)
284  }
285
286  def get_next_line(vpn: UInt) = {
287    Cat(dropL3SectorBits(vpn) + 1.U, 0.U(PtwL3SectorIdxLen.W))
288  }
289
290  def same_l2entry(vpn1: UInt, vpn2: UInt) = {
291    vpn1(vpnLen-1, vpnnLen) === vpn2(vpnLen-1, vpnnLen)
292  }
293
294  def from_pre(source: UInt) = {
295    (source === prefetchID.U)
296  }
297
298  def sel_data(data: UInt, index: UInt): UInt = {
299    val inner_data = data.asTypeOf(Vec(data.getWidth / XLEN, UInt(XLEN.W)))
300    inner_data(index)
301  }
302
303  // vpn1 and vpn2 is at same cacheline
304  def dup(vpn1: UInt, vpn2: UInt): Bool = {
305    dropL3SectorBits(vpn1) === dropL3SectorBits(vpn2)
306  }
307
308
309  def printVec[T <: Data](x: Seq[T]): Printable = {
310    (0 until x.length).map(i => p"(${i.U})${x(i)} ").reduce(_+_)
311  }
312}
313