xref: /XiangShan/src/main/scala/top/Configs.scala (revision 887862dbb8debde8ab099befc426493834a69ee7)
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 top
18
19import chisel3._
20import chisel3.util._
21import xiangshan._
22import utils._
23import utility._
24import system._
25import org.chipsalliance.cde.config._
26import freechips.rocketchip.tile.{BusErrorUnit, BusErrorUnitParams, XLen}
27import xiangshan.frontend.icache.ICacheParameters
28import freechips.rocketchip.devices.debug._
29import freechips.rocketchip.tile.{MaxHartIdBits, XLen}
30import system._
31import utility._
32import utils._
33import huancun._
34import xiangshan._
35import xiangshan.backend.dispatch.DispatchParameters
36import xiangshan.backend.regfile.{IntPregParams, VfPregParams}
37import xiangshan.cache.DCacheParameters
38import xiangshan.cache.mmu.{L2TLBParameters, TLBParameters}
39import device.{EnableJtag, XSDebugModuleParams}
40import huancun._
41import coupledL2._
42import coupledL2.prefetch._
43import xiangshan.frontend.icache.ICacheParameters
44
45class BaseConfig(n: Int) extends Config((site, here, up) => {
46  case XLen => 64
47  case DebugOptionsKey => DebugOptions()
48  case SoCParamsKey => SoCParameters()
49  case PMParameKey => PMParameters()
50  case XSTileKey => Seq.tabulate(n){ i => XSCoreParameters(HartId = i) }
51  case ExportDebug => DebugAttachParams(protocols = Set(JTAG))
52  case DebugModuleKey => Some(XSDebugModuleParams(site(XLen)))
53  case JtagDTMKey => JtagDTMKey
54  case MaxHartIdBits => log2Up(n) max 6
55  case EnableJtag => true.B
56})
57
58// Synthesizable minimal XiangShan
59// * It is still an out-of-order, super-scalaer arch
60// * L1 cache included
61// * L2 cache NOT included
62// * L3 cache included
63class MinimalConfig(n: Int = 1) extends Config(
64  new BaseConfig(n).alter((site, here, up) => {
65    case XSTileKey => up(XSTileKey).map(
66      p => p.copy(
67        DecodeWidth = 6,
68        RenameWidth = 6,
69        RobCommitWidth = 8,
70        FetchWidth = 4,
71        VirtualLoadQueueSize = 24,
72        LoadQueueRARSize = 24,
73        LoadQueueRAWSize = 12,
74        LoadQueueReplaySize = 24,
75        LoadUncacheBufferSize = 8,
76        LoadQueueNWriteBanks = 4, // NOTE: make sure that LoadQueue{RAR, RAW, Replay}Size is divided by LoadQueueNWriteBanks.
77        RollbackGroupSize = 8,
78        StoreQueueSize = 20,
79        StoreQueueNWriteBanks = 4, // NOTE: make sure that StoreQueueSize is divided by StoreQueueNWriteBanks
80        StoreQueueForwardWithMask = true,
81        // ============ VLSU ============
82        VlMergeBufferSize = 16,
83        VsMergeBufferSize = 8,
84        UopWritebackWidth = 2,
85        // ==============================
86        RobSize = 48,
87        RabSize = 96,
88        FtqSize = 8,
89        IBufSize = 24,
90        IBufNBank = 6,
91        StoreBufferSize = 4,
92        StoreBufferThreshold = 3,
93        IssueQueueSize = 10,
94        IssueQueueCompEntrySize = 4,
95        dpParams = DispatchParameters(
96          IntDqSize = 12,
97          FpDqSize = 12,
98          LsDqSize = 12,
99          IntDqDeqWidth = 8,
100          FpDqDeqWidth = 6,
101          VecDqDeqWidth = 6,
102          LsDqDeqWidth = 6
103        ),
104        intPreg = IntPregParams(
105          numEntries = 64,
106          numRead = None,
107          numWrite = None,
108        ),
109        vfPreg = VfPregParams(
110          numEntries = 160,
111          numRead = None,
112          numWrite = None,
113        ),
114        icacheParameters = ICacheParameters(
115          nSets = 64, // 16KB ICache
116          tagECC = Some("parity"),
117          dataECC = Some("parity"),
118          replacer = Some("setplru"),
119        ),
120        dcacheParametersOpt = Some(DCacheParameters(
121          nSets = 64, // 32KB DCache
122          nWays = 8,
123          tagECC = Some("secded"),
124          dataECC = Some("secded"),
125          replacer = Some("setplru"),
126          nMissEntries = 4,
127          nProbeEntries = 4,
128          nReleaseEntries = 8,
129          nMaxPrefetchEntry = 2,
130        )),
131        // ============ BPU ===============
132        EnableLoop = false,
133        EnableGHistDiff = false,
134        FtbSize = 256,
135        FtbWays = 2,
136        RasSize = 8,
137        RasSpecSize = 16,
138        TageTableInfos =
139          Seq((512, 4, 6),
140            (512, 9, 6),
141            (1024, 19, 6)),
142        SCNRows = 128,
143        SCNTables = 2,
144        SCHistLens = Seq(0, 5),
145        ITTageTableInfos =
146          Seq((256, 4, 7),
147            (256, 8, 7),
148            (512, 16, 7)),
149        // ================================
150        itlbParameters = TLBParameters(
151          name = "itlb",
152          fetchi = true,
153          useDmode = false,
154          NWays = 4,
155        ),
156        ldtlbParameters = TLBParameters(
157          name = "ldtlb",
158          NWays = 4,
159          partialStaticPMP = true,
160          outsideRecvFlush = true,
161          outReplace = false,
162          lgMaxSize = 4
163        ),
164        sttlbParameters = TLBParameters(
165          name = "sttlb",
166          NWays = 4,
167          partialStaticPMP = true,
168          outsideRecvFlush = true,
169          outReplace = false,
170          lgMaxSize = 4
171        ),
172        hytlbParameters = TLBParameters(
173          name = "hytlb",
174          NWays = 4,
175          partialStaticPMP = true,
176          outsideRecvFlush = true,
177          outReplace = false,
178          lgMaxSize = 4
179        ),
180        pftlbParameters = TLBParameters(
181          name = "pftlb",
182          NWays = 4,
183          partialStaticPMP = true,
184          outsideRecvFlush = true,
185          outReplace = false,
186          lgMaxSize = 4
187        ),
188        btlbParameters = TLBParameters(
189          name = "btlb",
190          NWays = 4,
191        ),
192        l2tlbParameters = L2TLBParameters(
193          l3Size = 4,
194          l2Size = 4,
195          l1nSets = 4,
196          l1nWays = 4,
197          l0nSets = 4,
198          l0nWays = 8,
199          spSize = 4,
200        ),
201        L2CacheParamsOpt = Some(L2Param(
202          name = "L2",
203          ways = 8,
204          sets = 128,
205          echoField = Seq(huancun.DirtyField()),
206          prefetch = Nil,
207          clientCaches = Seq(L1Param(
208            "dcache",
209            isKeywordBitsOpt = p.dcacheParametersOpt.get.isKeywordBitsOpt
210          )),
211          hasCMO = p.HasCMO && site(EnableCHI),
212        )),
213        L2NBanks = 2,
214        prefetcher = None // if L2 pf_recv_node does not exist, disable SMS prefetcher
215      )
216    )
217    case SoCParamsKey =>
218      val tiles = site(XSTileKey)
219      up(SoCParamsKey).copy(
220        L3CacheParamsOpt = Some(up(SoCParamsKey).L3CacheParamsOpt.get.copy(
221          sets = 1024,
222          inclusive = false,
223          clientCaches = tiles.map{ core =>
224            val clientDirBytes = tiles.map{ t =>
225              t.L2NBanks * t.L2CacheParamsOpt.map(_.toCacheParams.capacity).getOrElse(0)
226            }.sum
227            val l2params = core.L2CacheParamsOpt.get.toCacheParams
228            l2params.copy(sets = 2 * clientDirBytes / core.L2NBanks / l2params.ways / 64)
229          },
230          simulation = !site(DebugOptionsKey).FPGAPlatform,
231          prefetch = None
232        )),
233        L3NBanks = 1
234      )
235  })
236)
237
238// Non-synthesizable MinimalConfig, for fast simulation only
239class MinimalSimConfig(n: Int = 1) extends Config(
240  new MinimalConfig(n).alter((site, here, up) => {
241    case XSTileKey => up(XSTileKey).map(_.copy(
242      dcacheParametersOpt = None,
243      softPTW = true
244    ))
245    case SoCParamsKey => up(SoCParamsKey).copy(
246      L3CacheParamsOpt = None
247    )
248  })
249)
250
251class WithNKBL1D(n: Int, ways: Int = 8) extends Config((site, here, up) => {
252  case XSTileKey =>
253    val sets = n * 1024 / ways / 64
254    up(XSTileKey).map(_.copy(
255      dcacheParametersOpt = Some(DCacheParameters(
256        nSets = sets,
257        nWays = ways,
258        tagECC = Some("secded"),
259        dataECC = Some("secded"),
260        replacer = Some("setplru"),
261        nMissEntries = 16,
262        nProbeEntries = 8,
263        nReleaseEntries = 18,
264        nMaxPrefetchEntry = 6,
265      ))
266    ))
267})
268
269class WithNKBL2
270(
271  n: Int,
272  ways: Int = 8,
273  inclusive: Boolean = true,
274  banks: Int = 1,
275  tp: Boolean = true
276) extends Config((site, here, up) => {
277  case XSTileKey =>
278    require(inclusive, "L2 must be inclusive")
279    val upParams = up(XSTileKey)
280    val l2sets = n * 1024 / banks / ways / 64
281    upParams.map(p => p.copy(
282      L2CacheParamsOpt = Some(L2Param(
283        name = "L2",
284        ways = ways,
285        sets = l2sets,
286        clientCaches = Seq(L1Param(
287          "dcache",
288          sets = 2 * p.dcacheParametersOpt.get.nSets / banks,
289          ways = p.dcacheParametersOpt.get.nWays + 2,
290          aliasBitsOpt = p.dcacheParametersOpt.get.aliasBitsOpt,
291          vaddrBitsOpt = Some((if(p.EnableSv48) p.VAddrBitsSv48 else p.VAddrBitsSv39) - log2Up(p.dcacheParametersOpt.get.blockBytes)),
292          isKeywordBitsOpt = p.dcacheParametersOpt.get.isKeywordBitsOpt
293        )),
294        reqField = Seq(utility.ReqSourceField()),
295        echoField = Seq(huancun.DirtyField()),
296        prefetch = Seq(BOPParameters()) ++
297          (if (tp) Seq(TPParameters()) else Nil) ++
298          (if (p.prefetcher.nonEmpty) Seq(PrefetchReceiverParams()) else Nil),
299        hasCMO = p.HasCMO && site(EnableCHI),
300        enablePerf = !site(DebugOptionsKey).FPGAPlatform && site(DebugOptionsKey).EnablePerfDebug,
301        enableRollingDB = site(DebugOptionsKey).EnableRollingDB,
302        enableMonitor = site(DebugOptionsKey).AlwaysBasicDB,
303        elaboratedTopDown = !site(DebugOptionsKey).FPGAPlatform
304      )),
305      L2NBanks = banks
306    ))
307})
308
309class WithNKBL3(n: Int, ways: Int = 8, inclusive: Boolean = true, banks: Int = 1) extends Config((site, here, up) => {
310  case SoCParamsKey =>
311    val sets = n * 1024 / banks / ways / 64
312    val tiles = site(XSTileKey)
313    val clientDirBytes = tiles.map{ t =>
314      t.L2NBanks * t.L2CacheParamsOpt.map(_.toCacheParams.capacity).getOrElse(0)
315    }.sum
316    up(SoCParamsKey).copy(
317      L3NBanks = banks,
318      L3CacheParamsOpt = Some(HCCacheParameters(
319        name = "L3",
320        level = 3,
321        ways = ways,
322        sets = sets,
323        inclusive = inclusive,
324        clientCaches = tiles.map{ core =>
325          val l2params = core.L2CacheParamsOpt.get.toCacheParams
326          l2params.copy(sets = 2 * clientDirBytes / core.L2NBanks / l2params.ways / 64, ways = l2params.ways + 2)
327        },
328        enablePerf = !site(DebugOptionsKey).FPGAPlatform && site(DebugOptionsKey).EnablePerfDebug,
329        ctrl = Some(CacheCtrl(
330          address = 0x39000000,
331          numCores = tiles.size
332        )),
333        reqField = Seq(utility.ReqSourceField()),
334        sramClkDivBy2 = true,
335        sramDepthDiv = 4,
336        tagECC = Some("secded"),
337        dataECC = Some("secded"),
338        simulation = !site(DebugOptionsKey).FPGAPlatform,
339        prefetch = Some(huancun.prefetch.L3PrefetchReceiverParams()),
340        tpmeta = Some(huancun.prefetch.DefaultTPmetaParameters())
341      ))
342    )
343})
344
345class WithL3DebugConfig extends Config(
346  new WithNKBL3(256, inclusive = false) ++ new WithNKBL2(64)
347)
348
349class MinimalL3DebugConfig(n: Int = 1) extends Config(
350  new WithL3DebugConfig ++ new MinimalConfig(n)
351)
352
353class DefaultL3DebugConfig(n: Int = 1) extends Config(
354  new WithL3DebugConfig ++ new BaseConfig(n)
355)
356
357class WithFuzzer extends Config((site, here, up) => {
358  case DebugOptionsKey => up(DebugOptionsKey).copy(
359    EnablePerfDebug = false,
360  )
361  case SoCParamsKey => up(SoCParamsKey).copy(
362    L3CacheParamsOpt = Some(up(SoCParamsKey).L3CacheParamsOpt.get.copy(
363      enablePerf = false,
364    )),
365  )
366  case XSTileKey => up(XSTileKey).zipWithIndex.map{ case (p, i) =>
367    p.copy(
368      L2CacheParamsOpt = Some(up(XSTileKey)(i).L2CacheParamsOpt.get.copy(
369        enablePerf = false,
370      )),
371    )
372  }
373})
374
375class MinimalAliasDebugConfig(n: Int = 1) extends Config(
376  new WithNKBL3(512, inclusive = false) ++
377    new WithNKBL2(256, inclusive = true) ++
378    new WithNKBL1D(128) ++
379    new MinimalConfig(n)
380)
381
382class MediumConfig(n: Int = 1) extends Config(
383  new WithNKBL3(4096, inclusive = false, banks = 4)
384    ++ new WithNKBL2(512, inclusive = true)
385    ++ new WithNKBL1D(128)
386    ++ new BaseConfig(n)
387)
388
389class FuzzConfig(dummy: Int = 0) extends Config(
390  new WithFuzzer
391    ++ new DefaultConfig(1)
392)
393
394class DefaultConfig(n: Int = 1) extends Config(
395  new WithNKBL3(16 * 1024, inclusive = false, banks = 4, ways = 16)
396    ++ new WithNKBL2(2 * 512, inclusive = true, banks = 4)
397    ++ new WithNKBL1D(64, ways = 8)
398    ++ new BaseConfig(n)
399)
400
401class WithCHI extends Config((_, _, _) => {
402  case EnableCHI => true
403})
404
405class KunminghuV2Config(n: Int = 1) extends Config(
406  new WithCHI
407    ++ new Config((site, here, up) => {
408      case SoCParamsKey => up(SoCParamsKey).copy(L3CacheParamsOpt = None) // There will be no L3
409    })
410    ++ new WithNKBL2(2 * 512, inclusive = true, banks = 4, tp = false)
411    ++ new WithNKBL1D(64, ways = 8)
412    ++ new DefaultConfig(n)
413)
414
415class XSNoCTopConfig(n: Int = 1) extends Config(
416  (new KunminghuV2Config(n)).alter((site, here, up) => {
417    case SoCParamsKey => up(SoCParamsKey).copy(UseXSNoCTop = true)
418  })
419)
420
421class FpgaDefaultConfig(n: Int = 1) extends Config(
422  (new WithNKBL3(3 * 1024, inclusive = false, banks = 1, ways = 6)
423    ++ new WithNKBL2(2 * 512, inclusive = true, banks = 4)
424    ++ new WithNKBL1D(64, ways = 8)
425    ++ new BaseConfig(n)).alter((site, here, up) => {
426    case DebugOptionsKey => up(DebugOptionsKey).copy(
427      AlwaysBasicDiff = false,
428      AlwaysBasicDB = false
429    )
430    case SoCParamsKey => up(SoCParamsKey).copy(
431      L3CacheParamsOpt = Some(up(SoCParamsKey).L3CacheParamsOpt.get.copy(
432        sramClkDivBy2 = false,
433      )),
434    )
435  })
436)
437