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