xref: /XiangShan/src/main/scala/xiangshan/XSCore.scala (revision 3dbae6f866091b060d23d804d5a18edcb7d91fe3)
1package xiangshan
2
3import chisel3._
4import chisel3.util._
5import noop.{Cache, CacheConfig, HasExceptionNO, TLB, TLBConfig}
6import top.Parameters
7import xiangshan.backend._
8import xiangshan.backend.dispatch.DispatchParameters
9import xiangshan.backend.exu.ExuParameters
10import xiangshan.frontend._
11import xiangshan.mem._
12import xiangshan.cache.{ICache, DCache, DCacheParameters, ICacheParameters, PTW, Uncache}
13import chipsalliance.rocketchip.config
14import freechips.rocketchip.diplomacy.{LazyModule, LazyModuleImp}
15import freechips.rocketchip.tilelink.{TLBundleParameters, TLCacheCork, TLBuffer, TLClientNode, TLIdentityNode, TLXbar}
16import sifive.blocks.inclusivecache.{CacheParameters, InclusiveCache, InclusiveCacheMicroParameters}
17import utils._
18
19case class XSCoreParameters
20(
21  XLEN: Int = 64,
22  HasMExtension: Boolean = true,
23  HasCExtension: Boolean = true,
24  HasDiv: Boolean = true,
25  HasICache: Boolean = true,
26  HasDCache: Boolean = true,
27  EnableStoreQueue: Boolean = true,
28  AddrBits: Int = 64,
29  VAddrBits: Int = 39,
30  PAddrBits: Int = 40,
31  HasFPU: Boolean = false,
32  FectchWidth: Int = 8,
33  EnableBPU: Boolean = true,
34  EnableBPD: Boolean = true,
35  EnableRAS: Boolean = true,
36  EnableLB: Boolean = false,
37  EnableLoop: Boolean = false,
38  HistoryLength: Int = 64,
39  BtbSize: Int = 2048,
40  JbtacSize: Int = 1024,
41  JbtacBanks: Int = 8,
42  RasSize: Int = 16,
43  CacheLineSize: Int = 512,
44  UBtbWays: Int = 16,
45  BtbWays: Int = 2,
46  IBufSize: Int = 64,
47  DecodeWidth: Int = 6,
48  RenameWidth: Int = 6,
49  CommitWidth: Int = 6,
50  BrqSize: Int = 12,
51  IssQueSize: Int = 8,
52  NRPhyRegs: Int = 72,
53  NRIntReadPorts: Int = 8,
54  NRIntWritePorts: Int = 8,
55  NRFpReadPorts: Int = 14,
56  NRFpWritePorts: Int = 8,
57  EnableUnifiedLSQ: Boolean = false,
58  LsroqSize: Int = 16,
59  LoadQueueSize: Int = 16,
60  StoreQueueSize: Int = 16,
61  RoqSize: Int = 32,
62  dpParams: DispatchParameters = DispatchParameters(
63    DqEnqWidth = 4,
64    IntDqSize = 24,
65    FpDqSize = 16,
66    LsDqSize = 16,
67    IntDqDeqWidth = 4,
68    FpDqDeqWidth = 4,
69    LsDqDeqWidth = 4,
70    IntDqReplayWidth = 4,
71    FpDqReplayWidth = 4,
72    LsDqReplayWidth = 4
73  ),
74  exuParameters: ExuParameters = ExuParameters(
75    JmpCnt = 1,
76    AluCnt = 4,
77    MulCnt = 0,
78    MduCnt = 2,
79    FmacCnt = 0,
80    FmiscCnt = 0,
81    FmiscDivSqrtCnt = 0,
82    LduCnt = 2,
83    StuCnt = 2
84  ),
85  LoadPipelineWidth: Int = 2,
86  StorePipelineWidth: Int = 2,
87  StoreBufferSize: Int = 16,
88  RefillSize: Int = 512,
89  TlbEntrySize: Int = 32,
90  TlbL2EntrySize: Int = 256, // or 512
91  PtwL1EntrySize: Int = 16,
92  PtwL2EntrySize: Int = 256
93)
94
95trait HasXSParameter {
96
97  val core = Parameters.get.coreParameters
98  val env = Parameters.get.envParameters
99
100  val XLEN = core.XLEN
101  val HasMExtension = core.HasMExtension
102  val HasCExtension = core.HasCExtension
103  val HasDiv = core.HasDiv
104  val HasIcache = core.HasICache
105  val HasDcache = core.HasDCache
106  val EnableStoreQueue = core.EnableStoreQueue
107  val AddrBits = core.AddrBits // AddrBits is used in some cases
108  val VAddrBits = core.VAddrBits // VAddrBits is Virtual Memory addr bits
109  val PAddrBits = core.PAddrBits // PAddrBits is Phyical Memory addr bits
110  val AddrBytes = AddrBits / 8 // unused
111  val DataBits = XLEN
112  val DataBytes = DataBits / 8
113  val HasFPU = core.HasFPU
114  val FetchWidth = core.FectchWidth
115  val PredictWidth = FetchWidth * 2
116  val EnableBPU = core.EnableBPU
117  val EnableBPD = core.EnableBPD // enable backing predictor(like Tage) in BPUStage3
118  val EnableRAS = core.EnableRAS
119  val EnableLB = core.EnableLB
120  val EnableLoop = core.EnableLoop
121  val HistoryLength = core.HistoryLength
122  val BtbSize = core.BtbSize
123  // val BtbWays = 4
124  val BtbBanks = PredictWidth
125  // val BtbSets = BtbSize / BtbWays
126  val JbtacSize = core.JbtacSize
127  val JbtacBanks = core.JbtacBanks
128  val RasSize = core.RasSize
129  val CacheLineSize = core.CacheLineSize
130  val CacheLineHalfWord = CacheLineSize / 16
131  val ExtHistoryLength = HistoryLength + 64
132  val UBtbWays = core.UBtbWays
133  val BtbWays = core.BtbWays
134  val IBufSize = core.IBufSize
135  val DecodeWidth = core.DecodeWidth
136  val RenameWidth = core.RenameWidth
137  val CommitWidth = core.CommitWidth
138  val BrqSize = core.BrqSize
139  val IssQueSize = core.IssQueSize
140  val BrTagWidth = log2Up(BrqSize)
141  val NRPhyRegs = core.NRPhyRegs
142  val PhyRegIdxWidth = log2Up(NRPhyRegs)
143  val RoqSize = core.RoqSize
144  val InnerRoqIdxWidth = log2Up(RoqSize)
145  val RoqIdxWidth = InnerRoqIdxWidth + 1
146  val EnableUnifiedLSQ = core.EnableUnifiedLSQ
147  val LsroqSize = core.LsroqSize // 64
148  val InnerLsroqIdxWidth = log2Up(LsroqSize)
149  val LsroqIdxWidth = InnerLsroqIdxWidth + 1
150  val LoadQueueSize = core.LoadQueueSize
151  val StoreQueueSize = core.StoreQueueSize
152  val InnerLoadQueueIdxWidth = log2Up(LoadQueueSize)
153  val InnerStoreQueueIdxWidth = log2Up(StoreQueueSize)
154  val LoadQueueIdxWidth = InnerLoadQueueIdxWidth + 1
155  val StoreQueueIdxWidth = InnerStoreQueueIdxWidth + 1
156  val dpParams = core.dpParams
157  val ReplayWidth = dpParams.IntDqReplayWidth + dpParams.FpDqReplayWidth + dpParams.LsDqReplayWidth
158  val exuParameters = core.exuParameters
159  val NRIntReadPorts = core.NRIntReadPorts
160  val NRIntWritePorts = core.NRIntWritePorts
161  val NRMemReadPorts = exuParameters.LduCnt + 2*exuParameters.StuCnt
162  val NRFpReadPorts = core.NRFpReadPorts
163  val NRFpWritePorts = core.NRFpWritePorts
164  val LoadPipelineWidth = core.LoadPipelineWidth
165  val StorePipelineWidth = core.StorePipelineWidth
166  val StoreBufferSize = core.StoreBufferSize
167  val RefillSize = core.RefillSize
168  val DTLBWidth = core.LoadPipelineWidth + core.StorePipelineWidth
169  val TlbEntrySize = core.TlbEntrySize
170  val TlbL2EntrySize = core.TlbL2EntrySize
171  val PtwL1EntrySize = core.PtwL1EntrySize
172  val PtwL2EntrySize = core.PtwL2EntrySize
173
174  val l1BusDataWidth = 256
175
176  val icacheParameters = ICacheParameters(
177  )
178
179  val LRSCCycles = 100
180  val dcacheParameters = DCacheParameters(
181    tagECC = Some("secded"),
182    dataECC = Some("secded"),
183    nMissEntries = 16,
184    nLoadMissEntries = 8,
185    nStoreMissEntries = 8
186  )
187}
188
189trait HasXSLog { this: RawModule =>
190  implicit val moduleName: String = this.name
191}
192
193abstract class XSModule extends Module
194  with HasXSParameter
195  with HasExceptionNO
196  with HasXSLog
197
198//remove this trait after impl module logic
199trait NeedImpl { this: Module =>
200  override protected def IO[T <: Data](iodef: T): T = {
201    val io = chisel3.experimental.IO(iodef)
202    io <> DontCare
203    io
204  }
205}
206
207abstract class XSBundle extends Bundle
208  with HasXSParameter
209
210case class EnviromentParameters
211(
212  FPGAPlatform: Boolean = true,
213  EnableDebug: Boolean = false
214)
215
216object AddressSpace extends HasXSParameter {
217  // (start, size)
218  // address out of MMIO will be considered as DRAM
219  def mmio = List(
220    (0x30000000L, 0x10000000L),  // internal devices, such as CLINT and PLIC
221    (0x40000000L, 0x40000000L) // external devices
222  )
223
224  def isMMIO(addr: UInt): Bool = mmio.map(range => {
225    require(isPow2(range._2))
226    val bits = log2Up(range._2)
227    (addr ^ range._1.U)(PAddrBits-1, bits) === 0.U
228  }).reduce(_ || _)
229}
230
231
232
233class XSCore()(implicit p: config.Parameters) extends LazyModule {
234
235  val dcache = LazyModule(new DCache())
236  val uncache = LazyModule(new Uncache())
237  val icache = LazyModule(new ICache())
238  val ptw = LazyModule(new PTW())
239
240  val mem = TLIdentityNode()
241  val mmio = uncache.clientNode
242
243  // TODO: refactor these params
244  private val l2 = LazyModule(new InclusiveCache(
245    CacheParameters(
246      level = 2,
247      ways = 4,
248      sets = 512 * 1024 / (64 * 4),
249      blockBytes = 64,
250      beatBytes = 32 // beatBytes = l1BusDataWidth / 8
251    ),
252    InclusiveCacheMicroParameters(
253      writeBytes = 8
254    )
255  ))
256
257  private val xbar = TLXbar()
258
259  xbar := TLBuffer() := DebugIdentityNode() := dcache.clientNode
260  xbar := TLBuffer() := DebugIdentityNode() := icache.clientNode
261  xbar := TLBuffer() := DebugIdentityNode() := ptw.node
262
263  l2.node := xbar
264
265  mem := TLBuffer() := TLCacheCork() := TLBuffer() := l2.node
266
267  lazy val module = new XSCoreImp(this)
268}
269
270class XSCoreImp(outer: XSCore) extends LazyModuleImp(outer) with HasXSParameter {
271
272  val front = Module(new Frontend)
273  val backend = Module(new Backend)
274  val mem = Module(new Memend)
275
276  val dcache = outer.dcache.module
277  val uncache = outer.uncache.module
278  val icache = outer.icache.module
279  val ptw = outer.ptw.module
280
281  // TODO: connect this
282
283  front.io.backend <> backend.io.frontend
284  front.io.icacheResp <> icache.io.resp
285  front.io.icacheToTlb <> icache.io.tlb
286  icache.io.req <> front.io.icacheReq
287  icache.io.flush <> front.io.icacheFlush
288  mem.io.backend   <> backend.io.mem
289
290  ptw.io.tlb(0) <> mem.io.ptw
291  ptw.io.tlb(1) <> front.io.ptw
292
293  dcache.io.lsu.load    <> mem.io.loadUnitToDcacheVec
294  dcache.io.lsu.lsroq   <> mem.io.loadMiss
295  dcache.io.lsu.atomics <> mem.io.atomics
296  dcache.io.lsu.store   <> mem.io.sbufferToDcache
297  uncache.io.lsroq      <> mem.io.uncache
298
299}
300