xref: /XiangShan/src/main/scala/xiangshan/XSCore.scala (revision 491c16ade93d4956fec6dde187943d72bb010bc4)
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 xiangshan
18
19import org.chipsalliance.cde.config
20import org.chipsalliance.cde.config.Parameters
21import chisel3._
22import chisel3.util._
23import device.MsiInfoBundle
24import freechips.rocketchip.diplomacy.{BundleBridgeSource, LazyModule, LazyModuleImp}
25import freechips.rocketchip.tile.HasFPUParameters
26import system.HasSoCParameter
27import utils._
28import utility._
29import xiangshan.backend._
30import xiangshan.backend.fu.PMPRespBundle
31import xiangshan.backend.trace.TraceCoreInterface
32import xiangshan.cache.mmu._
33import xiangshan.frontend._
34import xiangshan.mem.L1PrefetchFuzzer
35import scala.collection.mutable.ListBuffer
36import xiangshan.cache.mmu.TlbRequestIO
37
38abstract class XSModule(implicit val p: Parameters) extends Module
39  with HasXSParameter
40  with HasFPUParameters
41
42//remove this trait after impl module logic
43trait NeedImpl {
44  this: RawModule =>
45  protected def IO[T <: Data](iodef: T): T = {
46    println(s"[Warn]: (${this.name}) please reomve 'NeedImpl' after implement this module")
47    val io = chisel3.IO(iodef)
48    io <> DontCare
49    io
50  }
51}
52
53abstract class XSBundle(implicit val p: Parameters) extends Bundle
54  with HasXSParameter
55
56abstract class XSCoreBase()(implicit p: config.Parameters) extends LazyModule
57  with HasXSParameter
58{
59  override def shouldBeInlined: Boolean = false
60  // outer facing nodes
61  val frontend = LazyModule(new Frontend())
62  val csrOut = BundleBridgeSource(Some(() => new DistributedCSRIO()))
63  val backend = LazyModule(new Backend(backendParams))
64
65  val memBlock = LazyModule(new MemBlock)
66
67  memBlock.inner.frontendBridge.icache_node := frontend.inner.icache.clientNode
68  memBlock.inner.frontendBridge.instr_uncache_node := frontend.inner.instrUncache.clientNode
69  if (icacheParameters.cacheCtrlAddressOpt.nonEmpty) {
70    frontend.inner.icache.ctrlUnitOpt.get.node := memBlock.inner.frontendBridge.icachectrl_node
71  }
72}
73
74class XSCore()(implicit p: config.Parameters) extends XSCoreBase
75  with HasXSDts
76{
77  lazy val module = new XSCoreImp(this)
78}
79
80class XSCoreImp(outer: XSCoreBase) extends LazyModuleImp(outer)
81  with HasXSParameter
82  with HasSoCParameter {
83  val io = IO(new Bundle {
84    val hartId = Input(UInt(hartIdLen.W))
85    val msiInfo = Input(ValidIO(new MsiInfoBundle))
86    val clintTime = Input(ValidIO(UInt(64.W)))
87    val reset_vector = Input(UInt(PAddrBits.W))
88    val cpu_halt = Output(Bool())
89    val cpu_critical_error = Output(Bool())
90    val resetInFrontend = Output(Bool())
91    val traceCoreInterface = new TraceCoreInterface
92    val l2_pf_enable = Output(Bool())
93    val perfEvents = Input(Vec(numPCntHc * coreParams.L2NBanks + 1, new PerfEvent))
94    val beu_errors = Output(new XSL1BusErrors())
95    val l2_hint = Input(Valid(new L2ToL1Hint()))
96    val l2_tlb_req = Flipped(new TlbRequestIO(nRespDups = 2))
97    val l2_pmp_resp = new PMPRespBundle
98    val l2PfqBusy = Input(Bool())
99    val debugTopDown = new Bundle {
100      val robTrueCommit = Output(UInt(64.W))
101      val robHeadPaddr = Valid(UInt(PAddrBits.W))
102      val l2MissMatch = Input(Bool())
103      val l3MissMatch = Input(Bool())
104    }
105  })
106
107  println(s"FPGAPlatform:${env.FPGAPlatform} EnableDebug:${env.EnableDebug}")
108
109  val frontend = outer.frontend.module
110  val backend = outer.backend.module
111  val memBlock = outer.memBlock.module
112
113  frontend.io.hartId := memBlock.io.inner_hartId
114  frontend.io.reset_vector := memBlock.io.inner_reset_vector
115  frontend.io.softPrefetch <> memBlock.io.ifetchPrefetch
116  frontend.io.backend <> backend.io.frontend
117  frontend.io.sfence <> backend.io.frontendSfence
118  frontend.io.tlbCsr <> backend.io.frontendTlbCsr
119  frontend.io.csrCtrl <> backend.io.frontendCsrCtrl
120  frontend.io.fencei <> backend.io.fenceio.fencei
121
122  backend.io.fromTop := memBlock.io.mem_to_ooo.topToBackendBypass
123
124  require(backend.io.mem.stIn.length == memBlock.io.mem_to_ooo.stIn.length)
125  backend.io.mem.stIn.zip(memBlock.io.mem_to_ooo.stIn).foreach { case (sink, source) =>
126    sink.valid := source.valid
127    sink.bits := 0.U.asTypeOf(sink.bits)
128    sink.bits.robIdx := source.bits.uop.robIdx
129    sink.bits.ssid := source.bits.uop.ssid
130    sink.bits.storeSetHit := source.bits.uop.storeSetHit
131    // The other signals have not been used
132  }
133  backend.io.mem.memoryViolation := memBlock.io.mem_to_ooo.memoryViolation
134  backend.io.mem.lsqEnqIO <> memBlock.io.ooo_to_mem.enqLsq
135  backend.io.mem.sqDeq := memBlock.io.mem_to_ooo.sqDeq
136  backend.io.mem.lqDeq := memBlock.io.mem_to_ooo.lqDeq
137  backend.io.mem.sqDeqPtr := memBlock.io.mem_to_ooo.sqDeqPtr
138  backend.io.mem.lqDeqPtr := memBlock.io.mem_to_ooo.lqDeqPtr
139  backend.io.mem.lqCancelCnt := memBlock.io.mem_to_ooo.lqCancelCnt
140  backend.io.mem.sqCancelCnt := memBlock.io.mem_to_ooo.sqCancelCnt
141  backend.io.mem.otherFastWakeup := memBlock.io.mem_to_ooo.otherFastWakeup
142  backend.io.mem.stIssuePtr := memBlock.io.mem_to_ooo.stIssuePtr
143  backend.io.mem.ldaIqFeedback := memBlock.io.mem_to_ooo.ldaIqFeedback
144  backend.io.mem.staIqFeedback := memBlock.io.mem_to_ooo.staIqFeedback
145  backend.io.mem.hyuIqFeedback := memBlock.io.mem_to_ooo.hyuIqFeedback
146  backend.io.mem.vstuIqFeedback := memBlock.io.mem_to_ooo.vstuIqFeedback
147  backend.io.mem.vlduIqFeedback := memBlock.io.mem_to_ooo.vlduIqFeedback
148  backend.io.mem.ldCancel := memBlock.io.mem_to_ooo.ldCancel
149  backend.io.mem.wakeup := memBlock.io.mem_to_ooo.wakeup
150  backend.io.mem.writebackLda <> memBlock.io.mem_to_ooo.writebackLda
151  backend.io.mem.writebackSta <> memBlock.io.mem_to_ooo.writebackSta
152  backend.io.mem.writebackHyuLda <> memBlock.io.mem_to_ooo.writebackHyuLda
153  backend.io.mem.writebackHyuSta <> memBlock.io.mem_to_ooo.writebackHyuSta
154  backend.io.mem.writebackStd <> memBlock.io.mem_to_ooo.writebackStd
155  backend.io.mem.writebackVldu <> memBlock.io.mem_to_ooo.writebackVldu
156  backend.io.mem.robLsqIO.mmio := memBlock.io.mem_to_ooo.lsqio.mmio
157  backend.io.mem.robLsqIO.uop := memBlock.io.mem_to_ooo.lsqio.uop
158
159  // memblock error exception writeback, 1 cycle after normal writeback
160  backend.io.mem.s3_delayed_load_error := memBlock.io.mem_to_ooo.s3_delayed_load_error
161
162  backend.io.mem.exceptionAddr.vaddr  := memBlock.io.mem_to_ooo.lsqio.vaddr
163  backend.io.mem.exceptionAddr.gpaddr := memBlock.io.mem_to_ooo.lsqio.gpaddr
164  backend.io.mem.exceptionAddr.isForVSnonLeafPTE := memBlock.io.mem_to_ooo.lsqio.isForVSnonLeafPTE
165  backend.io.mem.debugLS := memBlock.io.debug_ls
166  backend.io.mem.lsTopdownInfo := memBlock.io.mem_to_ooo.lsTopdownInfo
167  backend.io.mem.lqCanAccept := memBlock.io.mem_to_ooo.lsqio.lqCanAccept
168  backend.io.mem.sqCanAccept := memBlock.io.mem_to_ooo.lsqio.sqCanAccept
169  backend.io.fenceio.sbuffer.sbIsEmpty := memBlock.io.mem_to_ooo.sbIsEmpty
170
171  backend.io.perf.frontendInfo := frontend.io.frontendInfo
172  backend.io.perf.memInfo := memBlock.io.memInfo
173  backend.io.perf.perfEventsFrontend := frontend.io_perf
174  backend.io.perf.perfEventsLsu := memBlock.io_perf
175  backend.io.perf.perfEventsHc := memBlock.io.inner_hc_perfEvents
176  backend.io.perf.perfEventsBackend := DontCare
177  backend.io.perf.retiredInstr := DontCare
178  backend.io.perf.ctrlInfo := DontCare
179
180  backend.io.mem.storeDebugInfo <> memBlock.io.mem_to_ooo.storeDebugInfo
181
182  // top -> memBlock
183  memBlock.io.fromTopToBackend.clintTime := io.clintTime
184  memBlock.io.fromTopToBackend.msiInfo := io.msiInfo
185  memBlock.io.hartId := io.hartId
186  memBlock.io.outer_reset_vector := io.reset_vector
187  memBlock.io.outer_hc_perfEvents := io.perfEvents
188  // frontend -> memBlock
189  memBlock.io.inner_beu_errors_icache <> frontend.io.error.bits.toL1BusErrorUnitInfo(frontend.io.error.valid)
190  memBlock.io.inner_l2_pf_enable := backend.io.csrCustomCtrl.l2_pf_enable
191  memBlock.io.ooo_to_mem.backendToTopBypass := backend.io.toTop
192  memBlock.io.ooo_to_mem.issueLda <> backend.io.mem.issueLda
193  memBlock.io.ooo_to_mem.issueSta <> backend.io.mem.issueSta
194  memBlock.io.ooo_to_mem.issueStd <> backend.io.mem.issueStd
195  memBlock.io.ooo_to_mem.issueHya <> backend.io.mem.issueHylda
196  backend.io.mem.issueHysta.foreach(_.ready := false.B) // this fake port should not be used
197  memBlock.io.ooo_to_mem.issueVldu <> backend.io.mem.issueVldu
198
199  // By default, instructions do not have exceptions when they enter the function units.
200  memBlock.io.ooo_to_mem.issueUops.map(_.bits.uop.clearExceptions())
201  memBlock.io.ooo_to_mem.storePc := backend.io.mem.storePcRead
202  memBlock.io.ooo_to_mem.hybridPc := backend.io.mem.hyuPcRead
203  memBlock.io.ooo_to_mem.flushSb := backend.io.fenceio.sbuffer.flushSb
204  memBlock.io.ooo_to_mem.loadFastMatch := 0.U.asTypeOf(memBlock.io.ooo_to_mem.loadFastMatch)
205  memBlock.io.ooo_to_mem.loadFastImm := 0.U.asTypeOf(memBlock.io.ooo_to_mem.loadFastImm)
206  memBlock.io.ooo_to_mem.loadFastFuOpType := 0.U.asTypeOf(memBlock.io.ooo_to_mem.loadFastFuOpType)
207
208  memBlock.io.ooo_to_mem.sfence <> backend.io.mem.sfence
209
210  memBlock.io.redirect := backend.io.mem.redirect
211  memBlock.io.ooo_to_mem.csrCtrl := backend.io.mem.csrCtrl
212  memBlock.io.ooo_to_mem.tlbCsr := backend.io.mem.tlbCsr
213  memBlock.io.ooo_to_mem.lsqio.lcommit          := backend.io.mem.robLsqIO.lcommit
214  memBlock.io.ooo_to_mem.lsqio.scommit          := backend.io.mem.robLsqIO.scommit
215  memBlock.io.ooo_to_mem.lsqio.pendingMMIOld    := backend.io.mem.robLsqIO.pendingMMIOld
216  memBlock.io.ooo_to_mem.lsqio.pendingld        := backend.io.mem.robLsqIO.pendingld
217  memBlock.io.ooo_to_mem.lsqio.pendingst        := backend.io.mem.robLsqIO.pendingst
218  memBlock.io.ooo_to_mem.lsqio.pendingVst       := backend.io.mem.robLsqIO.pendingVst
219  memBlock.io.ooo_to_mem.lsqio.commit           := backend.io.mem.robLsqIO.commit
220  memBlock.io.ooo_to_mem.lsqio.pendingPtr       := backend.io.mem.robLsqIO.pendingPtr
221  memBlock.io.ooo_to_mem.lsqio.pendingPtrNext   := backend.io.mem.robLsqIO.pendingPtrNext
222  memBlock.io.ooo_to_mem.isStoreException       := backend.io.mem.isStoreException
223  memBlock.io.ooo_to_mem.isVlsException         := backend.io.mem.isVlsException
224
225  memBlock.io.fetch_to_mem.itlb <> frontend.io.ptw
226  memBlock.io.l2_hint.valid := io.l2_hint.valid
227  memBlock.io.l2_hint.bits.sourceId := io.l2_hint.bits.sourceId
228  memBlock.io.l2_tlb_req <> io.l2_tlb_req
229  memBlock.io.l2_pmp_resp <> io.l2_pmp_resp
230  memBlock.io.l2_hint.bits.isKeyword := io.l2_hint.bits.isKeyword
231  memBlock.io.l2PfqBusy := io.l2PfqBusy
232
233  // if l2 prefetcher use stream prefetch, it should be placed in XSCore
234
235  // top-down info
236  memBlock.io.debugTopDown.robHeadVaddr := backend.io.debugTopDown.fromRob.robHeadVaddr
237  frontend.io.debugTopDown.robHeadVaddr := backend.io.debugTopDown.fromRob.robHeadVaddr
238  io.debugTopDown.robHeadPaddr := backend.io.debugTopDown.fromRob.robHeadPaddr
239  io.debugTopDown.robTrueCommit := backend.io.debugRolling.robTrueCommit
240  backend.io.debugTopDown.fromCore.l2MissMatch := io.debugTopDown.l2MissMatch
241  backend.io.debugTopDown.fromCore.l3MissMatch := io.debugTopDown.l3MissMatch
242  backend.io.debugTopDown.fromCore.fromMem := memBlock.io.debugTopDown.toCore
243  memBlock.io.debugRolling := backend.io.debugRolling
244
245  io.cpu_halt := memBlock.io.outer_cpu_halt
246  io.cpu_critical_error := memBlock.io.outer_cpu_critical_error
247  io.beu_errors.icache <> memBlock.io.outer_beu_errors_icache
248  io.beu_errors.dcache <> memBlock.io.error.bits.toL1BusErrorUnitInfo(memBlock.io.error.valid)
249  io.beu_errors.l2 <> DontCare
250  io.l2_pf_enable := memBlock.io.outer_l2_pf_enable
251
252  memBlock.io.resetInFrontendBypass.fromFrontend := frontend.io.resetInFrontend
253  io.resetInFrontend := memBlock.io.resetInFrontendBypass.toL2Top
254  memBlock.io.traceCoreInterfaceBypass.fromBackend <> backend.io.traceCoreInterface
255  io.traceCoreInterface <> memBlock.io.traceCoreInterfaceBypass.toL2Top
256
257
258  if (debugOpts.ResetGen) {
259    backend.reset := memBlock.io.reset_backend
260    frontend.reset := backend.io.frontendReset
261  }
262}
263