xref: /XiangShan/src/main/scala/top/Configs.scala (revision b92f84459b67a53e82d79920469d5fd6d21aad5e)
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 = 8,
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(PrefetchReceiverParams(), BOPParameters()) ++ (if (tp) Seq(TPParameters()) else Nil),
295        enablePerf = !site(DebugOptionsKey).FPGAPlatform && site(DebugOptionsKey).EnablePerfDebug,
296        enableRollingDB = site(DebugOptionsKey).EnableRollingDB,
297        enableMonitor = site(DebugOptionsKey).AlwaysBasicDB,
298        elaboratedTopDown = !site(DebugOptionsKey).FPGAPlatform
299      )),
300      L2NBanks = banks
301    ))
302})
303
304class WithNKBL3(n: Int, ways: Int = 8, inclusive: Boolean = true, banks: Int = 1) extends Config((site, here, up) => {
305  case SoCParamsKey =>
306    val sets = n * 1024 / banks / ways / 64
307    val tiles = site(XSTileKey)
308    val clientDirBytes = tiles.map{ t =>
309      t.L2NBanks * t.L2CacheParamsOpt.map(_.toCacheParams.capacity).getOrElse(0)
310    }.sum
311    up(SoCParamsKey).copy(
312      L3NBanks = banks,
313      L3CacheParamsOpt = Some(HCCacheParameters(
314        name = "L3",
315        level = 3,
316        ways = ways,
317        sets = sets,
318        inclusive = inclusive,
319        clientCaches = tiles.map{ core =>
320          val l2params = core.L2CacheParamsOpt.get.toCacheParams
321          l2params.copy(sets = 2 * clientDirBytes / core.L2NBanks / l2params.ways / 64, ways = l2params.ways + 2)
322        },
323        enablePerf = !site(DebugOptionsKey).FPGAPlatform && site(DebugOptionsKey).EnablePerfDebug,
324        ctrl = Some(CacheCtrl(
325          address = 0x39000000,
326          numCores = tiles.size
327        )),
328        reqField = Seq(utility.ReqSourceField()),
329        sramClkDivBy2 = true,
330        sramDepthDiv = 4,
331        tagECC = Some("secded"),
332        dataECC = Some("secded"),
333        simulation = !site(DebugOptionsKey).FPGAPlatform,
334        prefetch = Some(huancun.prefetch.L3PrefetchReceiverParams()),
335        tpmeta = Some(huancun.prefetch.DefaultTPmetaParameters())
336      ))
337    )
338})
339
340class WithL3DebugConfig extends Config(
341  new WithNKBL3(256, inclusive = false) ++ new WithNKBL2(64)
342)
343
344class MinimalL3DebugConfig(n: Int = 1) extends Config(
345  new WithL3DebugConfig ++ new MinimalConfig(n)
346)
347
348class DefaultL3DebugConfig(n: Int = 1) extends Config(
349  new WithL3DebugConfig ++ new BaseConfig(n)
350)
351
352class WithFuzzer extends Config((site, here, up) => {
353  case DebugOptionsKey => up(DebugOptionsKey).copy(
354    EnablePerfDebug = false,
355  )
356  case SoCParamsKey => up(SoCParamsKey).copy(
357    L3CacheParamsOpt = Some(up(SoCParamsKey).L3CacheParamsOpt.get.copy(
358      enablePerf = false,
359    )),
360  )
361  case XSTileKey => up(XSTileKey).zipWithIndex.map{ case (p, i) =>
362    p.copy(
363      L2CacheParamsOpt = Some(up(XSTileKey)(i).L2CacheParamsOpt.get.copy(
364        enablePerf = false,
365      )),
366    )
367  }
368})
369
370class MinimalAliasDebugConfig(n: Int = 1) extends Config(
371  new WithNKBL3(512, inclusive = false) ++
372    new WithNKBL2(256, inclusive = true) ++
373    new WithNKBL1D(128) ++
374    new MinimalConfig(n)
375)
376
377class MediumConfig(n: Int = 1) extends Config(
378  new WithNKBL3(4096, inclusive = false, banks = 4)
379    ++ new WithNKBL2(512, inclusive = true)
380    ++ new WithNKBL1D(128)
381    ++ new BaseConfig(n)
382)
383
384class FuzzConfig(dummy: Int = 0) extends Config(
385  new WithFuzzer
386    ++ new DefaultConfig(1)
387)
388
389class DefaultConfig(n: Int = 1) extends Config(
390  new WithNKBL3(16 * 1024, inclusive = false, banks = 4, ways = 16)
391    ++ new WithNKBL2(2 * 512, inclusive = true, banks = 4)
392    ++ new WithNKBL1D(64, ways = 8)
393    ++ new BaseConfig(n)
394)
395
396class WithCHI extends Config((_, _, _) => {
397  case EnableCHI => true
398})
399
400class KunminghuV2Config(n: Int = 1) extends Config(
401  new WithCHI
402    ++ new Config((site, here, up) => {
403      case SoCParamsKey => up(SoCParamsKey).copy(L3CacheParamsOpt = None) // There will be no L3
404    })
405    ++ new WithNKBL2(2 * 512, inclusive = true, banks = 4, tp = false)
406    ++ new WithNKBL1D(64, ways = 8)
407    ++ new BaseConfig(n)
408)