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