xref: /XiangShan/src/main/scala/xiangshan/cache/mmu/MMUConst.scala (revision 195ef4a53ab54326d879e884c4e1568f424f2668)
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
95  val tlbcontiguous = 8
96  val sectortlbwidth = log2Up(tlbcontiguous)
97  val sectorppnLen = ppnLen - sectortlbwidth
98  val sectorvpnLen = vpnLen - sectortlbwidth
99
100  val loadfiltersize = 16 // 4*3(LduCnt:2 + HyuCnt:1) + 4(prefetch:1)
101  val storefiltersize = if (StorePipelineWidth >= 3) 16 else 8
102  val prefetchfiltersize = 8
103
104  val sramSinglePort = true
105
106  val timeOutThreshold = 10000
107
108  def noS2xlate = "b00".U
109  def allStage = "b11".U
110  def onlyStage1 = "b01".U
111  def onlyStage2 = "b10".U
112
113  def get_pn(addr: UInt) = {
114    require(addr.getWidth > offLen)
115    addr(addr.getWidth-1, offLen)
116  }
117  def get_off(addr: UInt) = {
118    require(addr.getWidth > offLen)
119    addr(offLen-1, 0)
120  }
121
122  def get_set_idx(vpn: UInt, nSets: Int): UInt = {
123    require(nSets >= 1)
124    vpn(log2Up(nSets)-1, 0)
125  }
126
127  def drop_set_idx(vpn: UInt, nSets: Int): UInt = {
128    require(nSets >= 1)
129    require(vpn.getWidth > log2Ceil(nSets))
130    vpn(vpn.getWidth-1, log2Ceil(nSets))
131  }
132
133  def drop_set_equal(vpn1: UInt, vpn2: UInt, nSets: Int): Bool = {
134    require(nSets >= 1)
135    require(vpn1.getWidth == vpn2.getWidth)
136    if (vpn1.getWidth <= log2Ceil(nSets)) {
137      true.B
138    } else {
139      drop_set_idx(vpn1, nSets) === drop_set_idx(vpn2, nSets)
140    }
141  }
142
143  def replaceWrapper(v: UInt, lruIdx: UInt): UInt = {
144    val width = v.getWidth
145    val emptyIdx = ParallelPriorityMux((0 until width).map( i => (!v(i), i.U(log2Up(width).W))))
146    val full = Cat(v).andR
147    Mux(full, lruIdx, emptyIdx)
148  }
149
150  def replaceWrapper(v: Seq[Bool], lruIdx: UInt): UInt = {
151    replaceWrapper(VecInit(v).asUInt, lruIdx)
152  }
153
154  implicit def hptwresp_to_tlbperm(hptwResp: HptwResp): TlbPermBundle = {
155    val tp = Wire(new TlbPermBundle)
156    val ptePerm = hptwResp.entry.perm.get.asTypeOf(new PtePermBundle().cloneType)
157    tp.pf := hptwResp.gpf
158    tp.af := hptwResp.gaf
159    tp.d := ptePerm.d
160    tp.a := ptePerm.a
161    tp.g := ptePerm.g
162    tp.u := ptePerm.u
163    tp.x := ptePerm.x
164    tp.w := ptePerm.w
165    tp.r := ptePerm.r
166    tp
167  }
168
169  implicit def ptwresp_to_tlbperm(ptwResp: PtwSectorResp): TlbPermBundle = {
170    val tp = Wire(new TlbPermBundle)
171    val ptePerm = ptwResp.entry.perm.get.asTypeOf(new PtePermBundle().cloneType)
172    tp.pf := ptwResp.pf
173    tp.af := ptwResp.af
174    tp.d := ptePerm.d
175    tp.a := ptePerm.a
176    tp.g := ptePerm.g
177    tp.u := ptePerm.u
178    tp.x := ptePerm.x
179    tp.w := ptePerm.w
180    tp.r := ptePerm.r
181    tp
182  }
183}
184
185trait HasPtwConst extends HasTlbConst with MemoryOpConstants{
186  val PtwWidth = 2
187  val sourceWidth = { if (l2tlbParams.enablePrefetch) PtwWidth + 1 else PtwWidth}
188  val prefetchID = PtwWidth
189
190  val blockBits = l2tlbParams.blockBytes * 8
191
192  val bPtwWidth = log2Up(PtwWidth)
193  val bSourceWidth = log2Up(sourceWidth)
194  // ptwl1: fully-associated
195  val PtwL1TagLen = vpnnLen + extendVpnnBits
196
197  /* +-------+----------+-------------+
198   * |  Tag  |  SetIdx  |  SectorIdx  |
199   * +-------+----------+-------------+
200   */
201  // ptwl2: 8-way group-associated
202  val PtwL2SetNum = l2tlbParams.l2nSets
203  val PtwL2SectorSize = blockBits / XLEN
204  val PtwL2IdxLen = log2Up(PtwL2SetNum * PtwL2SectorSize)
205  val PtwL2SectorIdxLen = log2Up(PtwL2SectorSize)
206  val PtwL2SetIdxLen = log2Up(PtwL2SetNum)
207  val PtwL2TagLen = vpnnLen * 2 - PtwL2IdxLen + extendVpnnBits
208
209  // ptwl3: 16-way group-associated
210  val PtwL3SetNum = l2tlbParams.l3nSets
211  val PtwL3SectorSize =  blockBits / XLEN
212  val PtwL3IdxLen = log2Up(PtwL3SetNum * PtwL3SectorSize)
213  val PtwL3SectorIdxLen = log2Up(PtwL3SectorSize)
214  val PtwL3SetIdxLen = log2Up(PtwL3SetNum)
215  val PtwL3TagLen = vpnnLen * 3 - PtwL3IdxLen + extendVpnnBits
216
217  // super page, including 1GB and 2MB page
218  val SPTagLen = vpnnLen * 2 + extendVpnnBits
219
220  // miss queue
221  val MissQueueSize = l2tlbParams.ifilterSize + l2tlbParams.dfilterSize
222  val MemReqWidth = l2tlbParams.llptwsize + 1 + 1
223  val HptwReqId = l2tlbParams.llptwsize + 1
224  val FsmReqID = l2tlbParams.llptwsize
225  val bMemID = log2Up(MemReqWidth)
226
227  def genPtwL2Idx(vpn: UInt) = {
228    (vpn(vpnLen - 1, vpnnLen))(PtwL2IdxLen - 1, 0)
229  }
230
231  def genPtwL2SectorIdx(vpn: UInt) = {
232    genPtwL2Idx(vpn)(PtwL2SectorIdxLen - 1, 0)
233  }
234
235  def genPtwL2SetIdx(vpn: UInt) = {
236    genPtwL2Idx(vpn)(PtwL2SetIdxLen + PtwL2SectorIdxLen - 1, PtwL2SectorIdxLen)
237  }
238
239  def genPtwL3Idx(vpn: UInt) = {
240    vpn(PtwL3IdxLen - 1, 0)
241  }
242
243  def genPtwL3SectorIdx(vpn: UInt) = {
244    genPtwL3Idx(vpn)(PtwL3SectorIdxLen - 1, 0)
245  }
246
247  def dropL3SectorBits(vpn: UInt) = {
248    vpn(vpn.getWidth-1, PtwL3SectorIdxLen)
249  }
250
251  def genPtwL3SetIdx(vpn: UInt) = {
252    genPtwL3Idx(vpn)(PtwL3SetIdxLen + PtwL3SectorIdxLen - 1, PtwL3SectorIdxLen)
253  }
254
255  def MakeAddr(ppn: UInt, off: UInt) = {
256    require(off.getWidth == 9)
257    Cat(ppn, off, 0.U(log2Up(XLEN/8).W))(PAddrBits-1, 0)
258  }
259
260  def MakeGPAddr(ppn: UInt, off: UInt) = {
261    require(off.getWidth == 9 || off.getWidth == 11)
262    (Cat(ppn, 0.U(offLen.W)) + Cat(off, 0.U(log2Up(XLEN / 8).W)))(GPAddrBits - 1, 0)
263  }
264
265  def getVpnn(vpn: UInt, idx: Int): UInt = {
266    vpn(vpnnLen*(idx+1)-1, vpnnLen*idx)
267  }
268
269  def getVpnn(vpn: UInt, idx: UInt): UInt = {
270    Mux(idx === 0.U, vpn(vpnnLen - 1, 0), Mux(idx === 1.U, vpn(vpnnLen * 2 - 1, vpnnLen), vpn(vpnnLen * 3 - 1, vpnnLen * 2)))
271  }
272
273  def getGVpnn(vpn: UInt, idx: UInt): UInt = {
274    Mux(idx === 0.U, vpn(vpnnLen - 1, 0), Mux(idx === 1.U, vpn(vpnnLen * 2 - 1, vpnnLen), vpn(vpnnLen * 3 + 1, vpnnLen * 2)))
275  }
276
277  def getVpnClip(vpn: UInt, level: Int) = {
278    // level 0  /* vpnn2 */
279    // level 1  /* vpnn2 * vpnn1 */
280    // level 2  /* vpnn2 * vpnn1 * vpnn0*/
281    vpn(vpnLen - 1, (2 - level) * vpnnLen)
282  }
283
284  def get_next_line(vpn: UInt) = {
285    Cat(dropL3SectorBits(vpn) + 1.U, 0.U(PtwL3SectorIdxLen.W))
286  }
287
288  def same_l2entry(vpn1: UInt, vpn2: UInt) = {
289    vpn1(vpnLen-1, vpnnLen) === vpn2(vpnLen-1, vpnnLen)
290  }
291
292  def from_pre(source: UInt) = {
293    (source === prefetchID.U)
294  }
295
296  def sel_data(data: UInt, index: UInt): UInt = {
297    val inner_data = data.asTypeOf(Vec(data.getWidth / XLEN, UInt(XLEN.W)))
298    inner_data(index)
299  }
300
301  // vpn1 and vpn2 is at same cacheline
302  def dup(vpn1: UInt, vpn2: UInt): Bool = {
303    dropL3SectorBits(vpn1) === dropL3SectorBits(vpn2)
304  }
305
306
307  def printVec[T <: Data](x: Seq[T]): Printable = {
308    (0 until x.length).map(i => p"(${i.U})${x(i)} ").reduce(_+_)
309  }
310}
311