xref: /XiangShan/src/main/scala/top/Configs.scala (revision b1e920234888fd3e5463ceb2a99c9bdca087f585)
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 xiangshan.frontend.icache.ICacheParameters
43
44class BaseConfig(n: Int) extends Config((site, here, up) => {
45  case XLen => 64
46  case DebugOptionsKey => DebugOptions()
47  case SoCParamsKey => SoCParameters()
48  case PMParameKey => PMParameters()
49  case XSTileKey => Seq.tabulate(n){ i => XSCoreParameters(HartId = i) }
50  case ExportDebug => DebugAttachParams(protocols = Set(JTAG))
51  case DebugModuleKey => Some(XSDebugModuleParams(site(XLen)))
52  case JtagDTMKey => JtagDTMKey
53  case MaxHartIdBits => 2
54  case EnableJtag => true.B
55})
56
57// Synthesizable minimal XiangShan
58// * It is still an out-of-order, super-scalaer arch
59// * L1 cache included
60// * L2 cache NOT included
61// * L3 cache included
62class MinimalConfig(n: Int = 1) extends Config(
63  new BaseConfig(n).alter((site, here, up) => {
64    case XSTileKey => up(XSTileKey).map(
65      _.copy(
66        DecodeWidth = 2,
67        RenameWidth = 2,
68        CommitWidth = 2,
69        FetchWidth = 4,
70        VirtualLoadQueueSize = 16,
71        LoadQueueRARSize = 16,
72        LoadQueueRAWSize = 12,
73        LoadQueueReplaySize = 12,
74        LoadUncacheBufferSize = 8,
75        LoadQueueNWriteBanks = 4, // NOTE: make sure that LoadQueue{RAR, RAW, Replay}Size is divided by LoadQueueNWriteBanks.
76        RollbackGroupSize = 8,
77        StoreQueueSize = 12,
78        StoreQueueNWriteBanks = 4, // NOTE: make sure that StoreQueueSize is divided by StoreQueueNWriteBanks
79        StoreQueueForwardWithMask = true,
80        RobSize = 32,
81        RabSize = 96,
82        FtqSize = 8,
83        IBufSize = 16,
84        StoreBufferSize = 4,
85        StoreBufferThreshold = 3,
86        IssueQueueSize = 8,
87        dpParams = DispatchParameters(
88          IntDqSize = 12,
89          FpDqSize = 12,
90          LsDqSize = 12,
91          IntDqDeqWidth = 4,
92          FpDqDeqWidth = 4,
93          LsDqDeqWidth = 6
94        ),
95        intPreg = IntPregParams(
96          numEntries = 64,
97          numRead = None,
98          numWrite = None,
99        ),
100        vfPreg = VfPregParams(
101          numEntries = 160,
102          numRead = Some(14),
103          numWrite = None,
104        ),
105        icacheParameters = ICacheParameters(
106          nSets = 64, // 16KB ICache
107          tagECC = Some("parity"),
108          dataECC = Some("parity"),
109          replacer = Some("setplru"),
110          nMissEntries = 2,
111          nReleaseEntries = 1,
112          nProbeEntries = 2,
113          // fdip
114          enableICachePrefetch = true,
115          prefetchToL1 = false,
116        ),
117        dcacheParametersOpt = Some(DCacheParameters(
118          nSets = 64, // 32KB DCache
119          nWays = 8,
120          tagECC = Some("secded"),
121          dataECC = Some("secded"),
122          replacer = Some("setplru"),
123          nMissEntries = 4,
124          nProbeEntries = 4,
125          nReleaseEntries = 8,
126          nMaxPrefetchEntry = 2,
127        )),
128        EnableBPD = false, // disable TAGE
129        EnableLoop = false,
130        itlbParameters = TLBParameters(
131          name = "itlb",
132          fetchi = true,
133          useDmode = false,
134          NWays = 4,
135        ),
136        ldtlbParameters = TLBParameters(
137          name = "ldtlb",
138          NWays = 4,
139          partialStaticPMP = true,
140          outsideRecvFlush = true,
141          outReplace = false
142        ),
143        sttlbParameters = TLBParameters(
144          name = "sttlb",
145          NWays = 4,
146          partialStaticPMP = true,
147          outsideRecvFlush = true,
148          outReplace = false
149        ),
150        hytlbParameters = TLBParameters(
151          name = "hytlb",
152          NWays = 4,
153          partialStaticPMP = true,
154          outsideRecvFlush = true,
155          outReplace = false
156        ),
157        pftlbParameters = TLBParameters(
158          name = "pftlb",
159          NWays = 4,
160          partialStaticPMP = true,
161          outsideRecvFlush = true,
162          outReplace = false
163        ),
164        btlbParameters = TLBParameters(
165          name = "btlb",
166          NWays = 4,
167        ),
168        l2tlbParameters = L2TLBParameters(
169          l1Size = 4,
170          l2nSets = 4,
171          l2nWays = 4,
172          l3nSets = 4,
173          l3nWays = 8,
174          spSize = 2,
175        ),
176        L2CacheParamsOpt = Some(L2Param(
177          name = "L2",
178          ways = 8,
179          sets = 128,
180          echoField = Seq(huancun.DirtyField()),
181          prefetch = None
182        )),
183        L2NBanks = 2,
184        prefetcher = None // if L2 pf_recv_node does not exist, disable SMS prefetcher
185      )
186    )
187    case SoCParamsKey =>
188      val tiles = site(XSTileKey)
189      up(SoCParamsKey).copy(
190        L3CacheParamsOpt = Some(up(SoCParamsKey).L3CacheParamsOpt.get.copy(
191          sets = 1024,
192          inclusive = false,
193          clientCaches = tiles.map{ core =>
194            val clientDirBytes = tiles.map{ t =>
195              t.L2NBanks * t.L2CacheParamsOpt.map(_.toCacheParams.capacity).getOrElse(0)
196            }.sum
197            val l2params = core.L2CacheParamsOpt.get.toCacheParams
198            l2params.copy(sets = 2 * clientDirBytes / core.L2NBanks / l2params.ways / 64)
199          },
200          simulation = !site(DebugOptionsKey).FPGAPlatform,
201          prefetch = None
202        )),
203        L3NBanks = 1
204      )
205  })
206)
207
208// Non-synthesizable MinimalConfig, for fast simulation only
209class MinimalSimConfig(n: Int = 1) extends Config(
210  new MinimalConfig(n).alter((site, here, up) => {
211    case XSTileKey => up(XSTileKey).map(_.copy(
212      dcacheParametersOpt = None,
213      softPTW = true
214    ))
215    case SoCParamsKey => up(SoCParamsKey).copy(
216      L3CacheParamsOpt = None
217    )
218  })
219)
220
221class WithNKBL1D(n: Int, ways: Int = 8) extends Config((site, here, up) => {
222  case XSTileKey =>
223    val sets = n * 1024 / ways / 64
224    up(XSTileKey).map(_.copy(
225      dcacheParametersOpt = Some(DCacheParameters(
226        nSets = sets,
227        nWays = ways,
228        tagECC = Some("secded"),
229        dataECC = Some("secded"),
230        replacer = Some("setplru"),
231        nMissEntries = 16,
232        nProbeEntries = 8,
233        nReleaseEntries = 18,
234        nMaxPrefetchEntry = 6,
235      ))
236    ))
237})
238
239class WithNKBL2
240(
241  n: Int,
242  ways: Int = 8,
243  inclusive: Boolean = true,
244  banks: Int = 1
245) extends Config((site, here, up) => {
246  case XSTileKey =>
247    val upParams = up(XSTileKey)
248    val l2sets = n * 1024 / banks / ways / 64
249    upParams.map(p => p.copy(
250      L2CacheParamsOpt = Some(L2Param(
251        name = "L2",
252        ways = ways,
253        sets = l2sets,
254        clientCaches = Seq(L1Param(
255          "dcache",
256          sets = 2 * p.dcacheParametersOpt.get.nSets / banks,
257          ways = p.dcacheParametersOpt.get.nWays + 2,
258          aliasBitsOpt = p.dcacheParametersOpt.get.aliasBitsOpt,
259          vaddrBitsOpt = Some(p.VAddrBits - log2Up(p.dcacheParametersOpt.get.blockBytes))
260        )),
261        reqField = Seq(utility.ReqSourceField()),
262        echoField = Seq(huancun.DirtyField()),
263        prefetch = Some(coupledL2.prefetch.PrefetchReceiverParams())
264      )),
265      L2NBanks = banks
266    ))
267})
268
269class WithNKBL3(n: Int, ways: Int = 8, inclusive: Boolean = true, banks: Int = 1) extends Config((site, here, up) => {
270  case SoCParamsKey =>
271    val sets = n * 1024 / banks / ways / 64
272    val tiles = site(XSTileKey)
273    val clientDirBytes = tiles.map{ t =>
274      t.L2NBanks * t.L2CacheParamsOpt.map(_.toCacheParams.capacity).getOrElse(0)
275    }.sum
276    up(SoCParamsKey).copy(
277      L3NBanks = banks,
278      L3CacheParamsOpt = Some(HCCacheParameters(
279        name = "L3",
280        level = 3,
281        ways = ways,
282        sets = sets,
283        inclusive = inclusive,
284        clientCaches = tiles.map{ core =>
285          val l2params = core.L2CacheParamsOpt.get.toCacheParams
286          l2params.copy(sets = 2 * clientDirBytes / core.L2NBanks / l2params.ways / 64, ways = l2params.ways + 2)
287        },
288        enablePerf = true,
289        ctrl = Some(CacheCtrl(
290          address = 0x39000000,
291          numCores = tiles.size
292        )),
293        reqField = Seq(utility.ReqSourceField()),
294        sramClkDivBy2 = true,
295        sramDepthDiv = 4,
296        tagECC = Some("secded"),
297        dataECC = Some("secded"),
298        simulation = !site(DebugOptionsKey).FPGAPlatform,
299        prefetch = Some(huancun.prefetch.L3PrefetchReceiverParams())
300      ))
301    )
302})
303
304class WithL3DebugConfig extends Config(
305  new WithNKBL3(256, inclusive = false) ++ new WithNKBL2(64)
306)
307
308class MinimalL3DebugConfig(n: Int = 1) extends Config(
309  new WithL3DebugConfig ++ new MinimalConfig(n)
310)
311
312class DefaultL3DebugConfig(n: Int = 1) extends Config(
313  new WithL3DebugConfig ++ new BaseConfig(n)
314)
315
316class WithFuzzer extends Config((site, here, up) => {
317  case DebugOptionsKey => up(DebugOptionsKey).copy(
318    EnablePerfDebug = false,
319  )
320  case SoCParamsKey => up(SoCParamsKey).copy(
321    L3CacheParamsOpt = Some(up(SoCParamsKey).L3CacheParamsOpt.get.copy(
322      enablePerf = false,
323    )),
324  )
325  case XSTileKey => up(XSTileKey).zipWithIndex.map{ case (p, i) =>
326    p.copy(
327      L2CacheParamsOpt = Some(up(XSTileKey)(i).L2CacheParamsOpt.get.copy(
328        enablePerf = false,
329      )),
330    )
331  }
332})
333
334class MinimalAliasDebugConfig(n: Int = 1) extends Config(
335  new WithNKBL3(512, inclusive = false) ++
336    new WithNKBL2(256, inclusive = false) ++
337    new WithNKBL1D(128) ++
338    new MinimalConfig(n)
339)
340
341class MediumConfig(n: Int = 1) extends Config(
342  new WithNKBL3(4096, inclusive = false, banks = 4)
343    ++ new WithNKBL2(512, inclusive = false)
344    ++ new WithNKBL1D(128)
345    ++ new BaseConfig(n)
346)
347
348class FuzzConfig(dummy: Int = 0) extends Config(
349  new WithFuzzer
350    ++ new DefaultConfig(1)
351)
352
353class DefaultConfig(n: Int = 1) extends Config(
354  new WithNKBL3(6 * 1024, inclusive = false, banks = 4, ways = 6)
355    ++ new WithNKBL2(2 * 512, inclusive = false, banks = 4)
356    ++ new WithNKBL1D(128)
357    ++ new BaseConfig(n)
358)
359