xref: /XiangShan/src/main/scala/top/Configs.scala (revision caa3d04af61ab7558600c8d4a2a4bd51abdee835)
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 chipsalliance.rocketchip.config._
26import freechips.rocketchip.tile.{BusErrorUnit, BusErrorUnitParams, XLen}
27import xiangshan.frontend.icache.ICacheParameters
28import freechips.rocketchip.devices.debug._
29import freechips.rocketchip.tile.MaxHartIdBits
30import xiangshan.backend.dispatch.DispatchParameters
31import xiangshan.backend.exu.ExuParameters
32import xiangshan.cache.DCacheParameters
33import xiangshan.cache.mmu.{L2TLBParameters, TLBParameters}
34import device.{EnableJtag, XSDebugModuleParams}
35import huancun._
36
37class BaseConfig(n: Int) extends Config((site, here, up) => {
38  case XLen => 64
39  case DebugOptionsKey => DebugOptions()
40  case SoCParamsKey => SoCParameters()
41  case PMParameKey => PMParameters()
42  case XSTileKey => Seq.tabulate(n){ i => XSCoreParameters(HartId = i) }
43  case ExportDebug => DebugAttachParams(protocols = Set(JTAG))
44  case DebugModuleKey => Some(XSDebugModuleParams(site(XLen)))
45  case JtagDTMKey => JtagDTMKey
46  case MaxHartIdBits => 2
47  case EnableJtag => true.B
48})
49
50// Synthesizable minimal XiangShan
51// * It is still an out-of-order, super-scalaer arch
52// * L1 cache included
53// * L2 cache NOT included
54// * L3 cache included
55class MinimalConfig(n: Int = 1) extends Config(
56  new BaseConfig(n).alter((site, here, up) => {
57    case XSTileKey => up(XSTileKey).map(
58      _.copy(
59        DecodeWidth = 2,
60        RenameWidth = 2,
61        CommitWidth = 2,
62        FetchWidth = 4,
63        IssQueSize = 8,
64        NRPhyRegs = 96,
65        IntPhyRegs = 96,
66        VfPhyRegs = 96,
67        LoadQueueSize = 16,
68        LoadQueueNWriteBanks = 4,
69        StoreQueueSize = 12,
70        StoreQueueNWriteBanks = 4,
71        RobSize = 32,
72        FtqSize = 8,
73        IBufSize = 16,
74        StoreBufferSize = 4,
75        StoreBufferThreshold = 3,
76        dpParams = DispatchParameters(
77          IntDqSize = 12,
78          FpDqSize = 12,
79          LsDqSize = 12,
80          IntDqDeqWidth = 4,
81          FpDqDeqWidth = 4,
82          LsDqDeqWidth = 4
83        ),
84        exuParameters = ExuParameters(
85          JmpCnt = 1,
86          AluCnt = 2,
87          MulCnt = 0,
88          MduCnt = 1,
89          FmacCnt = 1,
90          FmiscCnt = 1,
91          FmiscDivSqrtCnt = 0,
92          LduCnt = 2,
93          StuCnt = 2
94        ),
95        icacheParameters = ICacheParameters(
96          nSets = 64, // 16KB ICache
97          tagECC = Some("parity"),
98          dataECC = Some("parity"),
99          replacer = Some("setplru"),
100          nMissEntries = 2,
101          nReleaseEntries = 1,
102          nProbeEntries = 2,
103          nPrefetchEntries = 2,
104          hasPrefetch = false
105        ),
106        dcacheParametersOpt = Some(DCacheParameters(
107          nSets = 64, // 32KB DCache
108          nWays = 8,
109          tagECC = Some("secded"),
110          dataECC = Some("secded"),
111          replacer = Some("setplru"),
112          nMissEntries = 4,
113          nProbeEntries = 4,
114          nReleaseEntries = 8,
115        )),
116        EnableBPD = false, // disable TAGE
117        EnableLoop = false,
118        itlbParameters = TLBParameters(
119          name = "itlb",
120          fetchi = true,
121          useDmode = false,
122          normalReplacer = Some("plru"),
123          superReplacer = Some("plru"),
124          normalNWays = 4,
125          normalNSets = 1,
126          superNWays = 2
127        ),
128        ldtlbParameters = TLBParameters(
129          name = "ldtlb",
130          normalNSets = 16, // when da or sa
131          normalNWays = 1, // when fa or sa
132          normalAssociative = "sa",
133          normalReplacer = Some("setplru"),
134          superNWays = 4,
135          normalAsVictim = true,
136          partialStaticPMP = true,
137          outsideRecvFlush = true,
138          outReplace = false
139        ),
140        sttlbParameters = TLBParameters(
141          name = "sttlb",
142          normalNSets = 16, // when da or sa
143          normalNWays = 1, // when fa or sa
144          normalAssociative = "sa",
145          normalReplacer = Some("setplru"),
146          normalAsVictim = true,
147          superNWays = 4,
148          partialStaticPMP = true,
149          outsideRecvFlush = true,
150          outReplace = false
151        ),
152        btlbParameters = TLBParameters(
153          name = "btlb",
154          normalNSets = 1,
155          normalNWays = 8,
156          superNWays = 2
157        ),
158        l2tlbParameters = L2TLBParameters(
159          l1Size = 4,
160          l2nSets = 4,
161          l2nWays = 4,
162          l3nSets = 4,
163          l3nWays = 8,
164          spSize = 2,
165        ),
166        L2CacheParamsOpt = None, // remove L2 Cache
167        prefetcher = None // if L2 pf_recv_node does not exist, disable SMS prefetcher
168      )
169    )
170    case SoCParamsKey =>
171      val tiles = site(XSTileKey)
172      up(SoCParamsKey).copy(
173        L3CacheParamsOpt = Some(up(SoCParamsKey).L3CacheParamsOpt.get.copy(
174          sets = 1024,
175          inclusive = false,
176          clientCaches = tiles.map{ p =>
177            CacheParameters(
178              "dcache",
179              sets = 2 * p.dcacheParametersOpt.get.nSets,
180              ways = p.dcacheParametersOpt.get.nWays + 2,
181              blockGranularity = log2Ceil(2 * p.dcacheParametersOpt.get.nSets),
182              aliasBitsOpt = None
183            )
184          },
185          simulation = !site(DebugOptionsKey).FPGAPlatform
186        )),
187        L3NBanks = 1
188      )
189  })
190)
191
192// Non-synthesizable MinimalConfig, for fast simulation only
193class MinimalSimConfig(n: Int = 1) extends Config(
194  new MinimalConfig(n).alter((site, here, up) => {
195    case XSTileKey => up(XSTileKey).map(_.copy(
196      dcacheParametersOpt = None,
197      softPTW = true
198    ))
199    case SoCParamsKey => up(SoCParamsKey).copy(
200      L3CacheParamsOpt = None
201    )
202  })
203)
204
205class WithNKBL1D(n: Int, ways: Int = 8) extends Config((site, here, up) => {
206  case XSTileKey =>
207    val sets = n * 1024 / ways / 64
208    up(XSTileKey).map(_.copy(
209      dcacheParametersOpt = Some(DCacheParameters(
210        nSets = sets,
211        nWays = ways,
212        tagECC = Some("secded"),
213        dataECC = Some("secded"),
214        replacer = Some("setplru"),
215        nMissEntries = 16,
216        nProbeEntries = 8,
217        nReleaseEntries = 18
218      ))
219    ))
220})
221
222class WithNKBL2
223(
224  n: Int,
225  ways: Int = 8,
226  inclusive: Boolean = true,
227  banks: Int = 1,
228  alwaysReleaseData: Boolean = false
229) extends Config((site, here, up) => {
230  case XSTileKey =>
231    val upParams = up(XSTileKey)
232    val l2sets = n * 1024 / banks / ways / 64
233    upParams.map(p => p.copy(
234      L2CacheParamsOpt = Some(HCCacheParameters(
235        name = "L2",
236        level = 2,
237        ways = ways,
238        sets = l2sets,
239        inclusive = inclusive,
240        alwaysReleaseData = alwaysReleaseData,
241        clientCaches = Seq(CacheParameters(
242          "dcache",
243          sets = 2 * p.dcacheParametersOpt.get.nSets / banks,
244          ways = p.dcacheParametersOpt.get.nWays + 2,
245          blockGranularity = log2Ceil(2 * p.dcacheParametersOpt.get.nSets / banks),
246          aliasBitsOpt = p.dcacheParametersOpt.get.aliasBitsOpt
247        )),
248        reqField = Seq(PreferCacheField()),
249        echoField = Seq(DirtyField()),
250        prefetch = Some(huancun.prefetch.PrefetchReceiverParams()),
251        enablePerf = true,
252        sramDepthDiv = 2,
253        tagECC = Some("secded"),
254        dataECC = Some("secded"),
255        simulation = !site(DebugOptionsKey).FPGAPlatform
256      )),
257      L2NBanks = banks
258    ))
259})
260
261class WithNKBL3(n: Int, ways: Int = 8, inclusive: Boolean = true, banks: Int = 1) extends Config((site, here, up) => {
262  case SoCParamsKey =>
263    val sets = n * 1024 / banks / ways / 64
264    val tiles = site(XSTileKey)
265    val clientDirBytes = tiles.map{ t =>
266      t.L2NBanks * t.L2CacheParamsOpt.map(_.toCacheParams.capacity).getOrElse(0)
267    }.sum
268    up(SoCParamsKey).copy(
269      L3NBanks = banks,
270      L3CacheParamsOpt = Some(HCCacheParameters(
271        name = "L3",
272        level = 3,
273        ways = ways,
274        sets = sets,
275        inclusive = inclusive,
276        clientCaches = tiles.map{ core =>
277          val l2params = core.L2CacheParamsOpt.get.toCacheParams
278          l2params.copy(sets = 2 * clientDirBytes / core.L2NBanks / l2params.ways / 64)
279        },
280        enablePerf = true,
281        ctrl = Some(CacheCtrl(
282          address = 0x39000000,
283          numCores = tiles.size
284        )),
285        sramClkDivBy2 = true,
286        sramDepthDiv = 4,
287        tagECC = Some("secded"),
288        dataECC = Some("secded"),
289        simulation = !site(DebugOptionsKey).FPGAPlatform
290      ))
291    )
292})
293
294class WithL3DebugConfig extends Config(
295  new WithNKBL3(256, inclusive = false) ++ new WithNKBL2(64)
296)
297
298class MinimalL3DebugConfig(n: Int = 1) extends Config(
299  new WithL3DebugConfig ++ new MinimalConfig(n)
300)
301
302class DefaultL3DebugConfig(n: Int = 1) extends Config(
303  new WithL3DebugConfig ++ new BaseConfig(n)
304)
305
306class MinimalAliasDebugConfig(n: Int = 1) extends Config(
307  new WithNKBL3(512, inclusive = false) ++
308    new WithNKBL2(256, inclusive = false, alwaysReleaseData = true) ++
309    new WithNKBL1D(128) ++
310    new MinimalConfig(n)
311)
312
313class MediumConfig(n: Int = 1) extends Config(
314  new WithNKBL3(4096, inclusive = false, banks = 4)
315    ++ new WithNKBL2(512, inclusive = false, alwaysReleaseData = true)
316    ++ new WithNKBL1D(128)
317    ++ new BaseConfig(n)
318)
319
320class DefaultConfig(n: Int = 1) extends Config(
321  new WithNKBL3(6 * 1024, inclusive = false, banks = 4, ways = 6)
322    ++ new WithNKBL2(2 * 512, inclusive = false, banks = 4, alwaysReleaseData = true)
323    ++ new WithNKBL1D(128)
324    ++ new BaseConfig(n)
325)
326