xref: /XiangShan/src/main/scala/top/Configs.scala (revision b03c55a5df5dc8793cb44b42dd60141566e57e78)
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          l1Size = 4,
194          l2nSets = 4,
195          l2nWays = 4,
196          l3nSets = 4,
197          l3nWays = 8,
198          spSize = 2,
199        ),
200        L2CacheParamsOpt = Some(L2Param(
201          name = "L2",
202          ways = 8,
203          sets = 128,
204          echoField = Seq(huancun.DirtyField()),
205          prefetch = Nil,
206          clientCaches = Seq(L1Param(
207            "dcache",
208            isKeywordBitsOpt = p.dcacheParametersOpt.get.isKeywordBitsOpt
209          )),
210        )),
211        L2NBanks = 2,
212        prefetcher = None // if L2 pf_recv_node does not exist, disable SMS prefetcher
213      )
214    )
215    case SoCParamsKey =>
216      val tiles = site(XSTileKey)
217      up(SoCParamsKey).copy(
218        L3CacheParamsOpt = Some(up(SoCParamsKey).L3CacheParamsOpt.get.copy(
219          sets = 1024,
220          inclusive = false,
221          clientCaches = tiles.map{ core =>
222            val clientDirBytes = tiles.map{ t =>
223              t.L2NBanks * t.L2CacheParamsOpt.map(_.toCacheParams.capacity).getOrElse(0)
224            }.sum
225            val l2params = core.L2CacheParamsOpt.get.toCacheParams
226            l2params.copy(sets = 2 * clientDirBytes / core.L2NBanks / l2params.ways / 64)
227          },
228          simulation = !site(DebugOptionsKey).FPGAPlatform,
229          prefetch = None
230        )),
231        L3NBanks = 1
232      )
233  })
234)
235
236// Non-synthesizable MinimalConfig, for fast simulation only
237class MinimalSimConfig(n: Int = 1) extends Config(
238  new MinimalConfig(n).alter((site, here, up) => {
239    case XSTileKey => up(XSTileKey).map(_.copy(
240      dcacheParametersOpt = None,
241      softPTW = true
242    ))
243    case SoCParamsKey => up(SoCParamsKey).copy(
244      L3CacheParamsOpt = None
245    )
246  })
247)
248
249class WithNKBL1D(n: Int, ways: Int = 8) extends Config((site, here, up) => {
250  case XSTileKey =>
251    val sets = n * 1024 / ways / 64
252    up(XSTileKey).map(_.copy(
253      dcacheParametersOpt = Some(DCacheParameters(
254        nSets = sets,
255        nWays = ways,
256        tagECC = Some("secded"),
257        dataECC = Some("secded"),
258        replacer = Some("setplru"),
259        nMissEntries = 16,
260        nProbeEntries = 8,
261        nReleaseEntries = 18,
262        nMaxPrefetchEntry = 6,
263      ))
264    ))
265})
266
267class WithNKBL2
268(
269  n: Int,
270  ways: Int = 8,
271  inclusive: Boolean = true,
272  banks: Int = 1,
273  tp: Boolean = true
274) extends Config((site, here, up) => {
275  case XSTileKey =>
276    require(inclusive, "L2 must be inclusive")
277    val upParams = up(XSTileKey)
278    val l2sets = n * 1024 / banks / ways / 64
279    upParams.map(p => p.copy(
280      L2CacheParamsOpt = Some(L2Param(
281        name = "L2",
282        ways = ways,
283        sets = l2sets,
284        clientCaches = Seq(L1Param(
285          "dcache",
286          sets = 2 * p.dcacheParametersOpt.get.nSets / banks,
287          ways = p.dcacheParametersOpt.get.nWays + 2,
288          aliasBitsOpt = p.dcacheParametersOpt.get.aliasBitsOpt,
289          vaddrBitsOpt = Some(p.VAddrBits - log2Up(p.dcacheParametersOpt.get.blockBytes)),
290          isKeywordBitsOpt = p.dcacheParametersOpt.get.isKeywordBitsOpt
291        )),
292        reqField = Seq(utility.ReqSourceField()),
293        echoField = Seq(huancun.DirtyField()),
294        prefetch = Seq(BOPParameters()) ++
295          (if (tp) Seq(TPParameters()) else Nil) ++
296          (if (p.prefetcher.nonEmpty) Seq(PrefetchReceiverParams()) else Nil),
297        enablePerf = !site(DebugOptionsKey).FPGAPlatform && site(DebugOptionsKey).EnablePerfDebug,
298        enableRollingDB = site(DebugOptionsKey).EnableRollingDB,
299        enableMonitor = site(DebugOptionsKey).AlwaysBasicDB,
300        elaboratedTopDown = !site(DebugOptionsKey).FPGAPlatform
301      )),
302      L2NBanks = banks
303    ))
304})
305
306class WithNKBL3(n: Int, ways: Int = 8, inclusive: Boolean = true, banks: Int = 1) extends Config((site, here, up) => {
307  case SoCParamsKey =>
308    val sets = n * 1024 / banks / ways / 64
309    val tiles = site(XSTileKey)
310    val clientDirBytes = tiles.map{ t =>
311      t.L2NBanks * t.L2CacheParamsOpt.map(_.toCacheParams.capacity).getOrElse(0)
312    }.sum
313    up(SoCParamsKey).copy(
314      L3NBanks = banks,
315      L3CacheParamsOpt = Some(HCCacheParameters(
316        name = "L3",
317        level = 3,
318        ways = ways,
319        sets = sets,
320        inclusive = inclusive,
321        clientCaches = tiles.map{ core =>
322          val l2params = core.L2CacheParamsOpt.get.toCacheParams
323          l2params.copy(sets = 2 * clientDirBytes / core.L2NBanks / l2params.ways / 64, ways = l2params.ways + 2)
324        },
325        enablePerf = !site(DebugOptionsKey).FPGAPlatform && site(DebugOptionsKey).EnablePerfDebug,
326        ctrl = Some(CacheCtrl(
327          address = 0x39000000,
328          numCores = tiles.size
329        )),
330        reqField = Seq(utility.ReqSourceField()),
331        sramClkDivBy2 = true,
332        sramDepthDiv = 4,
333        tagECC = Some("secded"),
334        dataECC = Some("secded"),
335        simulation = !site(DebugOptionsKey).FPGAPlatform,
336        prefetch = Some(huancun.prefetch.L3PrefetchReceiverParams()),
337        tpmeta = Some(huancun.prefetch.DefaultTPmetaParameters())
338      ))
339    )
340})
341
342class WithL3DebugConfig extends Config(
343  new WithNKBL3(256, inclusive = false) ++ new WithNKBL2(64)
344)
345
346class MinimalL3DebugConfig(n: Int = 1) extends Config(
347  new WithL3DebugConfig ++ new MinimalConfig(n)
348)
349
350class DefaultL3DebugConfig(n: Int = 1) extends Config(
351  new WithL3DebugConfig ++ new BaseConfig(n)
352)
353
354class WithFuzzer extends Config((site, here, up) => {
355  case DebugOptionsKey => up(DebugOptionsKey).copy(
356    EnablePerfDebug = false,
357  )
358  case SoCParamsKey => up(SoCParamsKey).copy(
359    L3CacheParamsOpt = Some(up(SoCParamsKey).L3CacheParamsOpt.get.copy(
360      enablePerf = false,
361    )),
362  )
363  case XSTileKey => up(XSTileKey).zipWithIndex.map{ case (p, i) =>
364    p.copy(
365      L2CacheParamsOpt = Some(up(XSTileKey)(i).L2CacheParamsOpt.get.copy(
366        enablePerf = false,
367      )),
368    )
369  }
370})
371
372class MinimalAliasDebugConfig(n: Int = 1) extends Config(
373  new WithNKBL3(512, inclusive = false) ++
374    new WithNKBL2(256, inclusive = true) ++
375    new WithNKBL1D(128) ++
376    new MinimalConfig(n)
377)
378
379class MediumConfig(n: Int = 1) extends Config(
380  new WithNKBL3(4096, inclusive = false, banks = 4)
381    ++ new WithNKBL2(512, inclusive = true)
382    ++ new WithNKBL1D(128)
383    ++ new BaseConfig(n)
384)
385
386class FuzzConfig(dummy: Int = 0) extends Config(
387  new WithFuzzer
388    ++ new DefaultConfig(1)
389)
390
391class DefaultConfig(n: Int = 1) extends Config(
392  new WithNKBL3(16 * 1024, inclusive = false, banks = 4, ways = 16)
393    ++ new WithNKBL2(2 * 512, inclusive = true, banks = 4)
394    ++ new WithNKBL1D(64, ways = 8)
395    ++ new BaseConfig(n)
396)
397
398class WithCHI extends Config((_, _, _) => {
399  case EnableCHI => true
400})
401
402class KunminghuV2Config(n: Int = 1) extends Config(
403  new WithCHI
404    ++ new Config((site, here, up) => {
405      case SoCParamsKey => up(SoCParamsKey).copy(L3CacheParamsOpt = None) // There will be no L3
406    })
407    ++ new WithNKBL2(2 * 512, inclusive = true, banks = 4, tp = false)
408    ++ new WithNKBL1D(64, ways = 8)
409    ++ new DefaultConfig(n)
410)
411
412class XSNoCTopConfig(n: Int = 1) extends Config(
413  (new KunminghuV2Config(n)).alter((site, here, up) => {
414    case SoCParamsKey => up(SoCParamsKey).copy(UseXSNoCTop = true)
415  })
416)
417