xref: /XiangShan/src/main/scala/system/SoC.scala (revision 068bf978a62360db6c16671704497c3e01d6843f) 
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 system
18
19import chipsalliance.rocketchip.config.{Field, Parameters}
20import chisel3._
21import chisel3.util._
22import device.{DebugModule, TLPMA, TLPMAIO}
23import freechips.rocketchip.devices.tilelink.{CLINT, CLINTParams, DevNullParams, PLICParams, TLError, TLPLIC}
24import freechips.rocketchip.diplomacy.{AddressSet, IdRange, InModuleBody, LazyModule, LazyModuleImp, MemoryDevice, RegionType, SimpleDevice, TransferSizes}
25import freechips.rocketchip.interrupts.{IntSourceNode, IntSourcePortSimple}
26import freechips.rocketchip.regmapper.{RegField, RegFieldAccessType, RegFieldDesc, RegFieldGroup}
27import utils.{BinaryArbiter, TLEdgeBuffer}
28import xiangshan.{DebugOptionsKey, HasXSParameter, XSBundle, XSCore, XSCoreParameters, XSTileKey}
29import freechips.rocketchip.amba.axi4._
30import freechips.rocketchip.tilelink._
31import top.BusPerfMonitor
32import xiangshan.backend.fu.PMAConst
33import huancun._
34import huancun.debug.TLLogger
35
36case object SoCParamsKey extends Field[SoCParameters]
37
38case class SoCParameters
39(
40  EnableILA: Boolean = false,
41  PAddrBits: Int = 36,
42  extIntrs: Int = 64,
43  L3NBanks: Int = 4,
44  L3CacheParamsOpt: Option[HCCacheParameters] = Some(HCCacheParameters(
45    name = "l3",
46    level = 3,
47    ways = 8,
48    sets = 2048 // 1MB per bank
49  ))
50){
51  // L3 configurations
52  val L3InnerBusWidth = 256
53  val L3BlockSize = 64
54  // on chip network configurations
55  val L3OuterBusWidth = 256
56}
57
58trait HasSoCParameter {
59  implicit val p: Parameters
60
61  val soc = p(SoCParamsKey)
62  val debugOpts = p(DebugOptionsKey)
63  val tiles = p(XSTileKey)
64
65  val NumCores = tiles.size
66  val EnableILA = soc.EnableILA
67
68  // L3 configurations
69  val L3InnerBusWidth = soc.L3InnerBusWidth
70  val L3BlockSize = soc.L3BlockSize
71  val L3NBanks = soc.L3NBanks
72
73  // on chip network configurations
74  val L3OuterBusWidth = soc.L3OuterBusWidth
75
76  val NrExtIntr = soc.extIntrs
77}
78
79class ILABundle extends Bundle {}
80
81
82abstract class BaseSoC()(implicit p: Parameters) extends LazyModule with HasSoCParameter {
83  val bankedNode = BankBinder(L3NBanks, L3BlockSize)
84  val peripheralXbar = TLXbar()
85  val l3_xbar = TLXbar()
86  val l3_banked_xbar = TLXbar()
87}
88
89// We adapt the following three traits from rocket-chip.
90// Source: rocket-chip/src/main/scala/subsystem/Ports.scala
91trait HaveSlaveAXI4Port {
92  this: BaseSoC =>
93
94  val idBits = 14
95
96  val l3FrontendAXI4Node = AXI4MasterNode(Seq(AXI4MasterPortParameters(
97    Seq(AXI4MasterParameters(
98      name = "dma",
99      id = IdRange(0, 1 << idBits)
100    ))
101  )))
102  private val errorDevice = LazyModule(new TLError(
103    params = DevNullParams(
104      address = Seq(AddressSet(0x0, 0x7fffffffL)),
105      maxAtomic = 8,
106      maxTransfer = 64),
107    beatBytes = L3InnerBusWidth / 8
108  ))
109  private val error_xbar = TLXbar()
110
111  error_xbar :=
112    TLFIFOFixer() :=
113    TLWidthWidget(32) :=
114    AXI4ToTL() :=
115    AXI4UserYanker(Some(1)) :=
116    AXI4Fragmenter() :=
117    AXI4IdIndexer(1) :=
118    l3FrontendAXI4Node
119  errorDevice.node := error_xbar
120  l3_xbar :=
121    TLBuffer() :=
122    error_xbar
123
124  val dma = InModuleBody {
125    l3FrontendAXI4Node.makeIOs()
126  }
127}
128
129trait HaveAXI4MemPort {
130  this: BaseSoC =>
131  val device = new MemoryDevice
132  // 36-bit physical address
133  val memRange = AddressSet(0x00000000L, 0xfffffffffL).subtract(AddressSet(0x0L, 0x7fffffffL))
134  val memAXI4SlaveNode = AXI4SlaveNode(Seq(
135    AXI4SlavePortParameters(
136      slaves = Seq(
137        AXI4SlaveParameters(
138          address = memRange,
139          regionType = RegionType.UNCACHED,
140          executable = true,
141          supportsRead = TransferSizes(1, L3BlockSize),
142          supportsWrite = TransferSizes(1, L3BlockSize),
143          interleavedId = Some(0),
144          resources = device.reg("mem")
145        )
146      ),
147      beatBytes = L3OuterBusWidth / 8
148    )
149  ))
150
151  val mem_xbar = TLXbar()
152  mem_xbar :=*
153    TLXbar() :=*
154    TLEdgeBuffer(i => i == 0, Some("L3EdgeBuffer_1")) :=*
155    BinaryArbiter() :=*
156    TLEdgeBuffer(i => i == 0, Some("L3EdgeBuffer_0")) :=*
157    TLCacheCork() :=*
158    bankedNode
159
160  mem_xbar :=
161    TLWidthWidget(8) :=
162    TLBuffer.chainNode(5, name = Some("PeripheralXbar_to_MemXbar_buffer")) :=
163    peripheralXbar
164
165  memAXI4SlaveNode :=
166    AXI4IdIndexer(idBits = 14) :=
167    AXI4UserYanker() :=
168    AXI4Deinterleaver(L3BlockSize) :=
169    TLToAXI4() :=
170    TLWidthWidget(L3OuterBusWidth / 8) :=
171    TLEdgeBuffer(_ => true, Some("MemXbar_to_DDR_buffer")) :=
172    mem_xbar
173
174  val memory = InModuleBody {
175    memAXI4SlaveNode.makeIOs()
176  }
177}
178
179trait HaveAXI4PeripheralPort { this: BaseSoC =>
180  // on-chip devices: 0x3800_0000 - 0x3fff_ffff 0x0000_0000 - 0x0000_0fff
181  val onChipPeripheralRange = AddressSet(0x38000000L, 0x07ffffffL)
182  val uartRange = AddressSet(0x40600000, 0xf)
183  val uartDevice = new SimpleDevice("serial", Seq("xilinx,uartlite"))
184  val uartParams = AXI4SlaveParameters(
185    address = Seq(uartRange),
186    regionType = RegionType.UNCACHED,
187    supportsRead = TransferSizes(1, 8),
188    supportsWrite = TransferSizes(1, 8),
189    resources = uartDevice.reg
190  )
191  val peripheralRange = AddressSet(
192    0x0, 0x7fffffff
193  ).subtract(onChipPeripheralRange).flatMap(x => x.subtract(uartRange))
194  val peripheralNode = AXI4SlaveNode(Seq(AXI4SlavePortParameters(
195    Seq(AXI4SlaveParameters(
196      address = peripheralRange,
197      regionType = RegionType.UNCACHED,
198      supportsRead = TransferSizes(1, 8),
199      supportsWrite = TransferSizes(1, 8),
200      interleavedId = Some(0)
201    ), uartParams),
202    beatBytes = 8
203  )))
204
205  peripheralNode :=
206    AXI4IdIndexer(idBits = 2) :=
207    AXI4Buffer() :=
208    AXI4Buffer() :=
209    AXI4UserYanker() :=
210    AXI4Deinterleaver(8) :=
211    TLToAXI4() :=
212    peripheralXbar
213
214  val peripheral = InModuleBody {
215    peripheralNode.makeIOs()
216  }
217
218}
219
220class SoCMisc()(implicit p: Parameters) extends BaseSoC
221  with HaveAXI4MemPort
222  with HaveAXI4PeripheralPort
223  with PMAConst
224  with HaveSlaveAXI4Port
225{
226  val peripheral_ports = Array.fill(NumCores) { TLTempNode() }
227  val core_to_l3_ports = Array.fill(NumCores) { TLTempNode() }
228
229  val l3_in = TLTempNode()
230  val l3_out = TLTempNode()
231  val l3_mem_pmu = BusPerfMonitor(enable = !debugOpts.FPGAPlatform)
232
233  l3_in :*= TLEdgeBuffer(_ => true, Some("L3_in_buffer")) :*= l3_banked_xbar
234  bankedNode :*= TLLogger("MEM_L3", !debugOpts.FPGAPlatform) :*= l3_mem_pmu :*= l3_out
235
236  if(soc.L3CacheParamsOpt.isEmpty){
237    l3_out :*= l3_in
238  }
239
240  for(port <- peripheral_ports) {
241    peripheralXbar := TLBuffer.chainNode(1, Some("L2_to_L3_peripheral_buffer")) := port
242  }
243
244  for ((core_out, i) <- core_to_l3_ports.zipWithIndex){
245    l3_banked_xbar :=*
246      TLLogger(s"L3_L2_$i", !debugOpts.FPGAPlatform) :=*
247      TLBuffer() :=
248      core_out
249  }
250  l3_banked_xbar := l3_xbar
251
252  val clint = LazyModule(new CLINT(CLINTParams(0x38000000L), 8))
253  clint.node := peripheralXbar
254
255  class IntSourceNodeToModule(val num: Int)(implicit p: Parameters) extends LazyModule {
256    val sourceNode = IntSourceNode(IntSourcePortSimple(num, ports = 1, sources = 1))
257    lazy val module = new LazyModuleImp(this){
258      val in = IO(Input(Vec(num, Bool())))
259      in.zip(sourceNode.out.head._1).foreach{ case (i, s) => s := i }
260    }
261  }
262
263  val plic = LazyModule(new TLPLIC(PLICParams(0x3c000000L), 8))
264  val plicSource = LazyModule(new IntSourceNodeToModule(NrExtIntr))
265
266  plic.intnode := plicSource.sourceNode
267  plic.node := peripheralXbar
268
269  val pll_node = TLRegisterNode(
270    address = Seq(AddressSet(0x3a000000L, 0xfff)),
271    device = new SimpleDevice("pll_ctrl", Seq()),
272    beatBytes = 8,
273    concurrency = 1
274  )
275  pll_node := peripheralXbar
276
277  val debugModule = LazyModule(new DebugModule(NumCores)(p))
278  debugModule.debug.node := peripheralXbar
279  debugModule.debug.dmInner.dmInner.sb2tlOpt.foreach { sb2tl  =>
280    l3_xbar := TLBuffer() := TLWidthWidget(1) := sb2tl.node
281  }
282
283  val pma = LazyModule(new TLPMA)
284  pma.node := peripheralXbar
285
286  lazy val module = new LazyModuleImp(this){
287
288    val debug_module_io = IO(chiselTypeOf(debugModule.module.io))
289    val ext_intrs = IO(Input(UInt(NrExtIntr.W)))
290    val pll0_lock = IO(Input(Bool()))
291    val pll0_ctrl = IO(Output(Vec(6, UInt(32.W))))
292    val cacheable_check = IO(new TLPMAIO)
293
294    val ext_intrs_sync = RegNext(RegNext(RegNext(ext_intrs)))
295    val ext_intrs_wire = Wire(UInt(NrExtIntr.W))
296    ext_intrs_wire := ext_intrs_sync
297    debugModule.module.io <> debug_module_io
298    plicSource.module.in := ext_intrs_wire.asBools
299    pma.module.io <> cacheable_check
300
301    val freq = 100
302    val cnt = RegInit(freq.U)
303    val tick = cnt === 0.U
304    cnt := Mux(tick, freq.U, cnt - 1.U)
305    clint.module.io.rtcTick := tick
306
307    val pll_ctrl_regs = Seq.fill(6){ RegInit(0.U(32.W)) }
308    val pll_lock = RegNext(next = pll0_lock, init = false.B)
309
310    pll0_ctrl <> VecInit(pll_ctrl_regs)
311
312    pll_node.regmap(
313      0x000 -> RegFieldGroup(
314        "Pll", Some("PLL ctrl regs"),
315        pll_ctrl_regs.zipWithIndex.map{
316          case (r, i) => RegField(32, r, RegFieldDesc(
317            s"PLL_ctrl_$i",
318            desc = s"PLL ctrl register #$i"
319          ))
320        } :+ RegField.r(32, Cat(0.U(31.W), pll_lock), RegFieldDesc(
321          "PLL_lock",
322          "PLL lock register"
323        ))
324      )
325    )
326  }
327}
328