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