xref: /XiangShan/src/main/scala/xiangshan/L2Top.scala (revision 4a699e275a42daaf03e4f014bad0bb16d893e6ff) 
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 chisel3._
20import chisel3.util._
21import org.chipsalliance.cde.config._
22import chisel3.util.{Valid, ValidIO}
23import freechips.rocketchip.devices.debug.DebugModuleKey
24import freechips.rocketchip.diplomacy._
25import freechips.rocketchip.interrupts._
26import freechips.rocketchip.tile.{BusErrorUnit, BusErrorUnitParams, BusErrors, MaxHartIdBits}
27import freechips.rocketchip.tilelink._
28import device.MsiInfoBundle
29import coupledL2.{EnableCHI, L2ParamKey, PrefetchCtrlFromCore}
30import coupledL2.tl2tl.TL2TLCoupledL2
31import coupledL2.tl2chi.{CHIIssue, PortIO, TL2CHICoupledL2}
32import huancun.BankBitsKey
33import system.HasSoCParameter
34import top.BusPerfMonitor
35import utility._
36import xiangshan.cache.mmu.TlbRequestIO
37import xiangshan.backend.fu.PMPRespBundle
38import xiangshan.backend.trace.{Itype, TraceCoreInterface}
39
40class L1BusErrorUnitInfo(implicit val p: Parameters) extends Bundle with HasSoCParameter {
41  val ecc_error = Valid(UInt(soc.PAddrBits.W))
42}
43
44class XSL1BusErrors()(implicit val p: Parameters) extends BusErrors {
45  val icache = new L1BusErrorUnitInfo
46  val dcache = new L1BusErrorUnitInfo
47  val l2 = new L1BusErrorUnitInfo
48
49  override def toErrorList: List[Option[(ValidIO[UInt], String, String)]] =
50    List(
51      Some(icache.ecc_error, "I_ECC", "Icache ecc error"),
52      Some(dcache.ecc_error, "D_ECC", "Dcache ecc error"),
53      Some(l2.ecc_error, "L2_ECC", "L2Cache ecc error")
54    )
55}
56
57/**
58  *   L2Top contains everything between Core and XSTile-IO
59  */
60class L2TopInlined()(implicit p: Parameters) extends LazyModule
61  with HasXSParameter
62  with HasSoCParameter
63{
64  override def shouldBeInlined: Boolean = true
65
66  def chainBuffer(depth: Int, n: String): (Seq[LazyModule], TLNode) = {
67    val buffers = Seq.fill(depth){ LazyModule(new TLBuffer()) }
68    buffers.zipWithIndex.foreach{ case (b, i) => {
69      b.suggestName(s"${n}_${i}")
70    }}
71    val node = buffers.map(_.node.asInstanceOf[TLNode]).reduce(_ :*=* _)
72    (buffers, node)
73  }
74  val enableL2 = coreParams.L2CacheParamsOpt.isDefined
75  // =========== Components ============
76  val l1_xbar = TLXbar()
77  val mmio_xbar = TLXbar()
78  val mmio_port = TLIdentityNode() // to L3
79  val memory_port = if (enableCHI && enableL2) None else Some(TLIdentityNode())
80  val beu = LazyModule(new BusErrorUnit(
81    new XSL1BusErrors(),
82    BusErrorUnitParams(soc.BEURange.base, soc.BEURange.mask.toInt + 1)
83  ))
84
85  val i_mmio_port = TLTempNode()
86  val d_mmio_port = TLTempNode()
87  val icachectrl_port_opt = Option.when(icacheParameters.cacheCtrlAddressOpt.nonEmpty)(TLTempNode())
88  val sep_dm_port_opt = Option.when(SeperateDMBus)(TLTempNode())
89
90  val misc_l2_pmu = BusPerfMonitor(name = "Misc_L2", enable = !debugOpts.FPGAPlatform) // l1D & l1I & PTW
91  val l2_l3_pmu = BusPerfMonitor(name = "L2_L3", enable = !debugOpts.FPGAPlatform && !enableCHI, stat_latency = true)
92  val xbar_l2_buffer = TLBuffer()
93
94  val enbale_tllog = !debugOpts.FPGAPlatform && debugOpts.AlwaysBasicDB
95  val l1d_logger = TLLogger(s"L2_L1D_${coreParams.HartId}", enbale_tllog)
96  val l1i_logger = TLLogger(s"L2_L1I_${coreParams.HartId}", enbale_tllog)
97  val ptw_logger = TLLogger(s"L2_PTW_${coreParams.HartId}", enbale_tllog)
98  val ptw_to_l2_buffer = LazyModule(new TLBuffer)
99  val i_mmio_buffer = LazyModule(new TLBuffer)
100
101  val clint_int_node = IntIdentityNode()
102  val debug_int_node = IntIdentityNode()
103  val plic_int_node = IntIdentityNode()
104  val nmi_int_node = IntIdentityNode()
105
106  println(s"enableCHI: ${enableCHI}")
107  val l2cache = if (enableL2) {
108    val config = new Config((_, _, _) => {
109      case L2ParamKey => coreParams.L2CacheParamsOpt.get.copy(
110        hartId = p(XSCoreParamsKey).HartId,
111        FPGAPlatform = debugOpts.FPGAPlatform
112      )
113      case EnableCHI => p(EnableCHI)
114      case CHIIssue => p(CHIIssue)
115      case BankBitsKey => log2Ceil(coreParams.L2NBanks)
116      case MaxHartIdBits => p(MaxHartIdBits)
117      case LogUtilsOptionsKey => p(LogUtilsOptionsKey)
118      case PerfCounterOptionsKey => p(PerfCounterOptionsKey)
119    })
120    if (enableCHI) Some(LazyModule(new TL2CHICoupledL2()(new Config(config))))
121    else Some(LazyModule(new TL2TLCoupledL2()(new Config(config))))
122  } else None
123  val l2_binder = coreParams.L2CacheParamsOpt.map(_ => BankBinder(coreParams.L2NBanks, 64))
124
125  // =========== Connection ============
126  // l2 to l2_binder, then to memory_port
127  l2cache match {
128    case Some(l2) =>
129      l2_binder.get :*= l2.node :*= xbar_l2_buffer :*= l1_xbar :=* misc_l2_pmu
130      l2 match {
131        case l2: TL2TLCoupledL2 =>
132          memory_port.get := l2_l3_pmu := TLClientsMerger() := TLXbar() :=* l2_binder.get
133        case l2: TL2CHICoupledL2 =>
134          l2.managerNode := TLXbar() :=* l2_binder.get
135          l2.mmioNode := mmio_port
136      }
137    case None =>
138      memory_port.get := l1_xbar
139  }
140
141  mmio_xbar := TLBuffer.chainNode(2) := i_mmio_port
142  mmio_xbar := TLBuffer.chainNode(2) := d_mmio_port
143  beu.node := TLBuffer.chainNode(1) := mmio_xbar
144  if (icacheParameters.cacheCtrlAddressOpt.nonEmpty) {
145    icachectrl_port_opt.get := TLBuffer.chainNode(1) := mmio_xbar
146  }
147  if (SeperateDMBus) {
148    sep_dm_port_opt.get := TLBuffer.chainNode(1) := mmio_xbar
149  }
150
151  // filter out in-core addresses before sent to mmio_port
152  // Option[AddressSet] ++ Option[AddressSet] => List[AddressSet]
153  private def mmioFilters: Seq[AddressSet] = p(DebugModuleKey).get.address +: (
154    icacheParameters.cacheCtrlAddressOpt ++
155    dcacheParameters.cacheCtrlAddressOpt
156  ).toSeq
157  mmio_port :=
158    TLFilter(TLFilter.mSubtract(mmioFilters)) :=
159    TLBuffer() :=
160    mmio_xbar
161
162  class Imp(wrapper: LazyModule) extends LazyModuleImp(wrapper) {
163    val io = IO(new Bundle {
164      val beu_errors = Input(chiselTypeOf(beu.module.io.errors))
165      val reset_vector = new Bundle {
166        val fromTile = Input(UInt(PAddrBits.W))
167        val toCore = Output(UInt(PAddrBits.W))
168      }
169      val hartId = new Bundle() {
170        val fromTile = Input(UInt(64.W))
171        val toCore = Output(UInt(64.W))
172      }
173      val msiInfo = new Bundle() {
174        val fromTile = Input(ValidIO(new MsiInfoBundle))
175        val toCore = Output(ValidIO(new MsiInfoBundle))
176      }
177      val cpu_halt = new Bundle() {
178        val fromCore = Input(Bool())
179        val toTile = Output(Bool())
180      }
181      val cpu_poff = new Bundle() {
182        val fromCore = Input(Bool())
183        val toTile = Output(Bool())
184      }
185      val cpu_critical_error = new Bundle() {
186        val fromCore = Input(Bool())
187        val toTile = Output(Bool())
188      }
189      val hartIsInReset = new Bundle() {
190        val resetInFrontend = Input(Bool())
191        val toTile = Output(Bool())
192      }
193      val traceCoreInterface = new Bundle{
194        val fromCore = Flipped(new TraceCoreInterface)
195        val toTile   = new TraceCoreInterface
196      }
197      val debugTopDown = new Bundle() {
198        val robTrueCommit = Input(UInt(64.W))
199        val robHeadPaddr = Flipped(Valid(UInt(36.W)))
200        val l2MissMatch = Output(Bool())
201      }
202      val l2Miss = Output(Bool())
203      val l3Miss = new Bundle {
204        val fromTile = Input(Bool())
205        val toCore = Output(Bool())
206      }
207      val clintTime = new Bundle {
208        val fromTile = Input(ValidIO(UInt(64.W)))
209        val toCore = Output(ValidIO(UInt(64.W)))
210      }
211      val chi = if (enableCHI) Some(new PortIO) else None
212      val nodeID = if (enableCHI) Some(Input(UInt(NodeIDWidth.W))) else None
213      val pfCtrlFromCore = Input(new PrefetchCtrlFromCore)
214      val l2_tlb_req = new TlbRequestIO(nRespDups = 2)
215      val l2_pmp_resp = Flipped(new PMPRespBundle)
216      val l2_hint = ValidIO(new L2ToL1Hint())
217      val perfEvents = Output(Vec(numPCntHc * coreParams.L2NBanks + 1, new PerfEvent))
218      val l2_flush_en = Input(Bool())
219      val l2_flush_done = Output(Bool())
220      // val reset_core = IO(Output(Reset()))
221    })
222
223    val resetDelayN = Module(new DelayN(UInt(PAddrBits.W), 5))
224
225    beu.module.io.errors.icache := io.beu_errors.icache
226    beu.module.io.errors.dcache := io.beu_errors.dcache
227    resetDelayN.io.in := io.reset_vector.fromTile
228    io.reset_vector.toCore := resetDelayN.io.out
229    io.hartId.toCore := io.hartId.fromTile
230    io.msiInfo.toCore := io.msiInfo.fromTile
231    io.cpu_halt.toTile := io.cpu_halt.fromCore
232    io.cpu_poff.toTile := io.cpu_poff.fromCore
233    io.cpu_critical_error.toTile := io.cpu_critical_error.fromCore
234    io.l2_flush_done := true.B //TODO connect CoupleedL2
235    io.l3Miss.toCore := io.l3Miss.fromTile
236    io.clintTime.toCore := io.clintTime.fromTile
237    // trace interface
238    val traceToTile = io.traceCoreInterface.toTile
239    val traceFromCore = io.traceCoreInterface.fromCore
240    traceFromCore.fromEncoder := RegNext(traceToTile.fromEncoder)
241    traceToTile.toEncoder.trap := RegEnable(
242      traceFromCore.toEncoder.trap,
243      traceFromCore.toEncoder.groups(0).valid && Itype.isTrap(traceFromCore.toEncoder.groups(0).bits.itype)
244    )
245    traceToTile.toEncoder.priv := RegEnable(
246      traceFromCore.toEncoder.priv,
247      traceFromCore.toEncoder.groups(0).valid
248    )
249    (0 until TraceGroupNum).foreach{ i =>
250      traceToTile.toEncoder.groups(i).valid := RegNext(traceFromCore.toEncoder.groups(i).valid)
251      traceToTile.toEncoder.groups(i).bits.iretire := RegNext(traceFromCore.toEncoder.groups(i).bits.iretire)
252      traceToTile.toEncoder.groups(i).bits.itype := RegNext(traceFromCore.toEncoder.groups(i).bits.itype)
253      traceToTile.toEncoder.groups(i).bits.ilastsize := RegEnable(
254        traceFromCore.toEncoder.groups(i).bits.ilastsize,
255        traceFromCore.toEncoder.groups(i).valid
256      )
257      traceToTile.toEncoder.groups(i).bits.iaddr := RegEnable(
258        traceFromCore.toEncoder.groups(i).bits.iaddr,
259        traceFromCore.toEncoder.groups(i).valid
260      )
261    }
262
263    dontTouch(io.hartId)
264    dontTouch(io.cpu_halt)
265    dontTouch(io.cpu_critical_error)
266    if (!io.chi.isEmpty) { dontTouch(io.chi.get) }
267
268    val hartIsInReset = RegInit(true.B)
269    hartIsInReset := io.hartIsInReset.resetInFrontend || reset.asBool
270    io.hartIsInReset.toTile := hartIsInReset
271
272    if (l2cache.isDefined) {
273      val l2 = l2cache.get.module
274
275      l2.io.pfCtrlFromCore := io.pfCtrlFromCore
276      io.l2_hint := l2.io.l2_hint
277      l2.io.debugTopDown.robHeadPaddr := DontCare
278      l2.io.hartId := io.hartId.fromTile
279      l2.io.debugTopDown.robHeadPaddr := io.debugTopDown.robHeadPaddr
280      l2.io.debugTopDown.robTrueCommit := io.debugTopDown.robTrueCommit
281      io.debugTopDown.l2MissMatch := l2.io.debugTopDown.l2MissMatch
282      io.l2Miss := l2.io.l2Miss
283
284      /* l2 tlb */
285      io.l2_tlb_req.req.bits := DontCare
286      io.l2_tlb_req.req.valid := l2.io.l2_tlb_req.req.valid
287      io.l2_tlb_req.resp.ready := l2.io.l2_tlb_req.resp.ready
288      io.l2_tlb_req.req.bits.vaddr := l2.io.l2_tlb_req.req.bits.vaddr
289      io.l2_tlb_req.req.bits.cmd := l2.io.l2_tlb_req.req.bits.cmd
290      io.l2_tlb_req.req.bits.size := l2.io.l2_tlb_req.req.bits.size
291      io.l2_tlb_req.req.bits.kill := l2.io.l2_tlb_req.req.bits.kill
292      io.l2_tlb_req.req.bits.no_translate := l2.io.l2_tlb_req.req.bits.no_translate
293      io.l2_tlb_req.req_kill := l2.io.l2_tlb_req.req_kill
294      io.perfEvents := l2.io_perf
295
296      val allPerfEvents = l2.getPerfEvents
297      if (printEventCoding) {
298        for (((name, inc), i) <- allPerfEvents.zipWithIndex) {
299          println("L2 Cache perfEvents Set", name, inc, i)
300        }
301      }
302
303      l2.io.l2_tlb_req.resp.valid := io.l2_tlb_req.resp.valid
304      l2.io.l2_tlb_req.req.ready := io.l2_tlb_req.req.ready
305      l2.io.l2_tlb_req.resp.bits.paddr.head := io.l2_tlb_req.resp.bits.paddr.head
306      l2.io.l2_tlb_req.resp.bits.pbmt := io.l2_tlb_req.resp.bits.pbmt.head
307      l2.io.l2_tlb_req.resp.bits.miss := io.l2_tlb_req.resp.bits.miss
308      l2.io.l2_tlb_req.resp.bits.excp.head.gpf := io.l2_tlb_req.resp.bits.excp.head.gpf
309      l2.io.l2_tlb_req.resp.bits.excp.head.pf := io.l2_tlb_req.resp.bits.excp.head.pf
310      l2.io.l2_tlb_req.resp.bits.excp.head.af := io.l2_tlb_req.resp.bits.excp.head.af
311      l2.io.l2_tlb_req.pmp_resp.ld := io.l2_pmp_resp.ld
312      l2.io.l2_tlb_req.pmp_resp.st := io.l2_pmp_resp.st
313      l2.io.l2_tlb_req.pmp_resp.instr := io.l2_pmp_resp.instr
314      l2.io.l2_tlb_req.pmp_resp.mmio := io.l2_pmp_resp.mmio
315      l2.io.l2_tlb_req.pmp_resp.atomic := io.l2_pmp_resp.atomic
316      l2cache.get match {
317        case l2cache: TL2CHICoupledL2 =>
318          val l2 = l2cache.module
319          l2.io_nodeID := io.nodeID.get
320          io.chi.get <> l2.io_chi
321        case l2cache: TL2TLCoupledL2 =>
322      }
323
324      beu.module.io.errors.l2.ecc_error.valid := l2.io.error.valid
325      beu.module.io.errors.l2.ecc_error.bits := l2.io.error.address
326    } else {
327      io.l2_hint := 0.U.asTypeOf(io.l2_hint)
328      io.debugTopDown <> DontCare
329      io.l2Miss := false.B
330
331      io.l2_tlb_req.req.valid := false.B
332      io.l2_tlb_req.req.bits := DontCare
333      io.l2_tlb_req.req_kill := DontCare
334      io.l2_tlb_req.resp.ready := true.B
335      io.perfEvents := DontCare
336
337      beu.module.io.errors.l2 := 0.U.asTypeOf(beu.module.io.errors.l2)
338    }
339  }
340
341  lazy val module = new Imp(this)
342}
343
344class L2Top()(implicit p: Parameters) extends LazyModule
345  with HasXSParameter
346  with HasSoCParameter {
347
348  override def shouldBeInlined: Boolean = false
349
350  val inner = LazyModule(new L2TopInlined())
351
352  class Imp(wrapper: LazyModule) extends LazyModuleImp(wrapper) {
353    val io = IO(inner.module.io.cloneType)
354    val reset_core = IO(Output(Reset()))
355    io <> inner.module.io
356
357    if (debugOpts.ResetGen) {
358      ResetGen(ResetGenNode(Seq(
359        CellNode(reset_core),
360        ModuleNode(inner.module)
361      )), reset, sim = false)
362    } else {
363      reset_core := DontCare
364    }
365  }
366
367  lazy val module = new Imp(this)
368}
369