xref: /XiangShan/src/main/scala/xiangshan/L2Top.scala (revision b03c55a5df5dc8793cb44b42dd60141566e57e78)
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.diplomacy._
24import freechips.rocketchip.interrupts._
25import freechips.rocketchip.tile.{BusErrorUnit, BusErrorUnitParams, BusErrors, MaxHartIdBits}
26import freechips.rocketchip.tilelink._
27import coupledL2.{L2ParamKey, EnableCHI}
28import coupledL2.tl2tl.TL2TLCoupledL2
29import coupledL2.tl2chi.{TL2CHICoupledL2, PortIO}
30import huancun.BankBitsKey
31import system.HasSoCParameter
32import top.BusPerfMonitor
33import utility._
34import xiangshan.cache.mmu.TlbRequestIO
35
36class L1BusErrorUnitInfo(implicit val p: Parameters) extends Bundle with HasSoCParameter {
37  val ecc_error = Valid(UInt(soc.PAddrBits.W))
38}
39
40class XSL1BusErrors()(implicit val p: Parameters) extends BusErrors {
41  val icache = new L1BusErrorUnitInfo
42  val dcache = new L1BusErrorUnitInfo
43  val l2 = new L1BusErrorUnitInfo
44
45  override def toErrorList: List[Option[(ValidIO[UInt], String, String)]] =
46    List(
47      Some(icache.ecc_error, "I_ECC", "Icache ecc error"),
48      Some(dcache.ecc_error, "D_ECC", "Dcache ecc error"),
49      Some(l2.ecc_error, "L2_ECC", "L2Cache ecc error")
50    )
51}
52
53/**
54  *   L2Top contains everything between Core and XSTile-IO
55  */
56class L2Top()(implicit p: Parameters) extends LazyModule
57  with HasXSParameter
58  with HasSoCParameter
59{
60  def chainBuffer(depth: Int, n: String): (Seq[LazyModule], TLNode) = {
61    val buffers = Seq.fill(depth){ LazyModule(new TLBuffer()) }
62    buffers.zipWithIndex.foreach{ case (b, i) => {
63      b.suggestName(s"${n}_${i}")
64    }}
65    val node = buffers.map(_.node.asInstanceOf[TLNode]).reduce(_ :*=* _)
66    (buffers, node)
67  }
68  val enableL2 = coreParams.L2CacheParamsOpt.isDefined
69  // =========== Components ============
70  val l1_xbar = TLXbar()
71  val mmio_xbar = TLXbar()
72  val mmio_port = TLIdentityNode() // to L3
73  val memory_port = if (enableCHI && enableL2) None else Some(TLIdentityNode())
74  val beu = LazyModule(new BusErrorUnit(
75    new XSL1BusErrors(), BusErrorUnitParams(0x38010000)
76  ))
77
78  val i_mmio_port = TLTempNode()
79  val d_mmio_port = TLTempNode()
80
81  val misc_l2_pmu = BusPerfMonitor(name = "Misc_L2", enable = !debugOpts.FPGAPlatform) // l1D & l1I & PTW
82  val l2_l3_pmu = BusPerfMonitor(name = "L2_L3", enable = !debugOpts.FPGAPlatform && !enableCHI, stat_latency = true)
83  val xbar_l2_buffer = TLBuffer()
84
85  val enbale_tllog = !debugOpts.FPGAPlatform && debugOpts.AlwaysBasicDB
86  val l1d_logger = TLLogger(s"L2_L1D_${coreParams.HartId}", enbale_tllog)
87  val l1i_logger = TLLogger(s"L2_L1I_${coreParams.HartId}", enbale_tllog)
88  val ptw_logger = TLLogger(s"L2_PTW_${coreParams.HartId}", enbale_tllog)
89  val ptw_to_l2_buffer = LazyModule(new TLBuffer)
90  val i_mmio_buffer = LazyModule(new TLBuffer)
91
92  val clint_int_node = IntIdentityNode()
93  val debug_int_node = IntIdentityNode()
94  val plic_int_node = IntIdentityNode()
95
96  println(s"enableCHI: ${enableCHI}")
97  val l2cache = if (enableL2) {
98    val config = new Config((_, _, _) => {
99      case L2ParamKey => coreParams.L2CacheParamsOpt.get.copy(
100        hartId = p(XSCoreParamsKey).HartId,
101        FPGAPlatform = debugOpts.FPGAPlatform
102      )
103      case EnableCHI => p(EnableCHI)
104      case BankBitsKey => log2Ceil(coreParams.L2NBanks)
105      case MaxHartIdBits => p(MaxHartIdBits)
106      case LogUtilsOptionsKey => p(LogUtilsOptionsKey)
107      case PerfCounterOptionsKey => p(PerfCounterOptionsKey)
108    })
109    if (enableCHI) Some(LazyModule(new TL2CHICoupledL2()(new Config(config))))
110    else Some(LazyModule(new TL2TLCoupledL2()(new Config(config))))
111  } else None
112  val l2_binder = coreParams.L2CacheParamsOpt.map(_ => BankBinder(coreParams.L2NBanks, 64))
113
114  // =========== Connection ============
115  // l2 to l2_binder, then to memory_port
116  l2cache match {
117    case Some(l2) =>
118      l2_binder.get :*= l2.node :*= xbar_l2_buffer :*= l1_xbar :=* misc_l2_pmu
119      l2 match {
120        case l2: TL2TLCoupledL2 =>
121          memory_port.get := l2_l3_pmu := TLClientsMerger() := TLXbar() :=* l2_binder.get
122        case l2: TL2CHICoupledL2 =>
123          l2.managerNode := TLXbar() :=* l2_binder.get
124          l2.mmioNode := mmio_port
125      }
126    case None =>
127      memory_port.get := l1_xbar
128  }
129
130  mmio_xbar := TLBuffer.chainNode(2) := i_mmio_port
131  mmio_xbar := TLBuffer.chainNode(2) := d_mmio_port
132  beu.node := TLBuffer.chainNode(1) := mmio_xbar
133  mmio_port := TLBuffer() := mmio_xbar
134
135  class L2TopImp(wrapper: LazyModule) extends LazyModuleImp(wrapper) {
136    val beu_errors = IO(Input(chiselTypeOf(beu.module.io.errors)))
137    val reset_vector = IO(new Bundle {
138      val fromTile = Input(UInt(PAddrBits.W))
139      val toCore = Output(UInt(PAddrBits.W))
140    })
141    val hartId = IO(new Bundle() {
142      val fromTile = Input(UInt(64.W))
143      val toCore = Output(UInt(64.W))
144    })
145    val cpu_halt = IO(new Bundle() {
146      val fromCore = Input(Bool())
147      val toTile = Output(Bool())
148    })
149    val debugTopDown = IO(new Bundle() {
150      val robTrueCommit = Input(UInt(64.W))
151      val robHeadPaddr = Flipped(Valid(UInt(36.W)))
152      val l2MissMatch = Output(Bool())
153    })
154    val chi = if (enableCHI) Some(IO(new PortIO)) else None
155    val nodeID = if (enableCHI) Some(IO(Input(UInt(NodeIDWidth.W)))) else None
156    val l2_tlb_req = IO(new TlbRequestIO(nRespDups = 2))
157    val l2_hint = IO(ValidIO(new L2ToL1Hint()))
158
159    val resetDelayN = Module(new DelayN(UInt(PAddrBits.W), 5))
160
161    beu.module.io.errors <> beu_errors
162    resetDelayN.io.in := reset_vector.fromTile
163    reset_vector.toCore := resetDelayN.io.out
164    hartId.toCore := hartId.fromTile
165    cpu_halt.toTile := cpu_halt.fromCore
166    dontTouch(hartId)
167    dontTouch(cpu_halt)
168    if (!chi.isEmpty) { dontTouch(chi.get) }
169
170    if (l2cache.isDefined) {
171      val l2 = l2cache.get.module
172      l2_hint := l2.io.l2_hint
173      l2.io.debugTopDown.robHeadPaddr := DontCare
174      l2.io.hartId := hartId.fromTile
175      l2.io.debugTopDown.robHeadPaddr := debugTopDown.robHeadPaddr
176      l2.io.debugTopDown.robTrueCommit := debugTopDown.robTrueCommit
177      debugTopDown.l2MissMatch := l2.io.debugTopDown.l2MissMatch
178
179      /* l2 tlb */
180      l2_tlb_req.req.bits := DontCare
181      l2_tlb_req.req.valid := l2.io.l2_tlb_req.req.valid
182      l2_tlb_req.resp.ready := l2.io.l2_tlb_req.resp.ready
183      l2_tlb_req.req.bits.vaddr := l2.io.l2_tlb_req.req.bits.vaddr
184      l2_tlb_req.req.bits.cmd := l2.io.l2_tlb_req.req.bits.cmd
185      l2_tlb_req.req.bits.size := l2.io.l2_tlb_req.req.bits.size
186      l2_tlb_req.req.bits.kill := l2.io.l2_tlb_req.req.bits.kill
187      l2_tlb_req.req.bits.no_translate := l2.io.l2_tlb_req.req.bits.no_translate
188      l2_tlb_req.req_kill := l2.io.l2_tlb_req.req_kill
189      l2.io.l2_tlb_req.resp.valid := l2_tlb_req.resp.valid
190      l2.io.l2_tlb_req.req.ready := l2_tlb_req.req.ready
191      l2.io.l2_tlb_req.resp.bits.paddr.head := l2_tlb_req.resp.bits.paddr.head
192      l2.io.l2_tlb_req.resp.bits.miss := l2_tlb_req.resp.bits.miss
193      l2.io.l2_tlb_req.resp.bits.excp.head <> l2_tlb_req.resp.bits.excp.head
194
195      l2cache.get match {
196        case l2cache: TL2CHICoupledL2 =>
197          val l2 = l2cache.module
198          l2.io_nodeID := nodeID.get
199          chi.get <> l2.io_chi
200        case l2cache: TL2TLCoupledL2 =>
201      }
202    } else {
203      l2_hint := 0.U.asTypeOf(l2_hint)
204      debugTopDown <> DontCare
205
206      l2_tlb_req.req.valid := false.B
207      l2_tlb_req.req.bits := DontCare
208      l2_tlb_req.req_kill := DontCare
209      l2_tlb_req.resp.ready := true.B
210    }
211  }
212
213  lazy val module = new L2TopImp(this)
214}
215