xref: /XiangShan/src/main/scala/xiangshan/backend/fu/PMP.scala (revision ff1b5dbbf9b6e3fad4cd9555d3e29b7a8b3897ef)
1b6982e83SLemover/***************************************************************************************
2b6982e83SLemover* Copyright (c) 2020-2021 Institute of Computing Technology, Chinese Academy of Sciences
3b6982e83SLemover* Copyright (c) 2020-2021 Peng Cheng Laboratory
4b6982e83SLemover*
5b6982e83SLemover* XiangShan is licensed under Mulan PSL v2.
6b6982e83SLemover* You can use this software according to the terms and conditions of the Mulan PSL v2.
7b6982e83SLemover* You may obtain a copy of Mulan PSL v2 at:
8b6982e83SLemover*          http://license.coscl.org.cn/MulanPSL2
9b6982e83SLemover*
10b6982e83SLemover* THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND,
11b6982e83SLemover* EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT,
12b6982e83SLemover* MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
13b6982e83SLemover*
14b6982e83SLemover* See the Mulan PSL v2 for more details.
15b6982e83SLemover***************************************************************************************/
16b6982e83SLemover
17a15116bdSLemover// See LICENSE.SiFive for license details.
18a15116bdSLemover
19b6982e83SLemoverpackage xiangshan.backend.fu
20b6982e83SLemover
21b6982e83SLemoverimport chipsalliance.rocketchip.config.Parameters
22b6982e83SLemoverimport chisel3._
23b6982e83SLemoverimport chisel3.internal.naming.chiselName
24b6982e83SLemoverimport chisel3.util._
25b6982e83SLemoverimport utils.MaskedRegMap.WritableMask
26b6982e83SLemoverimport xiangshan._
27b6982e83SLemoverimport xiangshan.backend.fu.util.HasCSRConst
28b6982e83SLemoverimport utils._
29b6982e83SLemoverimport xiangshan.cache.mmu.{TlbCmd, TlbExceptionBundle}
30b6982e83SLemover
3198c71602SJiawei Lintrait PMPConst extends HasPMParameters {
32b6982e83SLemover  val PMPOffBits = 2 // minimal 4bytes
33b6982e83SLemover  val CoarserGrain: Boolean = PlatformGrain > PMPOffBits
34b6982e83SLemover}
35b6982e83SLemover
3698c71602SJiawei Linabstract class PMPBundle(implicit val p: Parameters) extends Bundle with PMPConst
3798c71602SJiawei Linabstract class PMPModule(implicit val p: Parameters) extends Module with PMPConst
3898c71602SJiawei Linabstract class PMPXSModule(implicit p: Parameters) extends XSModule with PMPConst
39b6982e83SLemover
40b6982e83SLemover@chiselName
41b6982e83SLemoverclass PMPConfig(implicit p: Parameters) extends PMPBundle {
42b6982e83SLemover  val l = Bool()
43ca2f90a6SLemover  val c = Bool() // res(1), unuse in pmp
44ca2f90a6SLemover  val atomic = Bool() // res(0), unuse in pmp
45b6982e83SLemover  val a = UInt(2.W)
46b6982e83SLemover  val x = Bool()
47b6982e83SLemover  val w = Bool()
48b6982e83SLemover  val r = Bool()
49b6982e83SLemover
50ca2f90a6SLemover  def res: UInt = Cat(c, atomic) // in pmp, unused
51b6982e83SLemover  def off = a === 0.U
52b6982e83SLemover  def tor = a === 1.U
53b6982e83SLemover  def na4 = { if (CoarserGrain) false.B else a === 2.U }
54b6982e83SLemover  def napot = { if (CoarserGrain) a(1).asBool else a === 3.U }
55b6982e83SLemover  def off_tor = !a(1)
56b6982e83SLemover  def na4_napot = a(1)
57b6982e83SLemover
58b6982e83SLemover  def locked = l
59b6982e83SLemover  def addr_locked: Bool = locked
60b6982e83SLemover  def addr_locked(next: PMPConfig): Bool = locked || (next.locked && next.tor)
61ca2f90a6SLemover}
62b6982e83SLemover
6398c71602SJiawei Lintrait PMPReadWriteMethodBare extends PMPConst {
6498c71602SJiawei Lin  def match_mask(cfg: PMPConfig, paddr: UInt) = {
6598c71602SJiawei Lin    val match_mask_c_addr = Cat(paddr, cfg.a(0)) | (((1 << PlatformGrain) - 1) >> PMPOffBits).U((paddr.getWidth + 1).W)
6698c71602SJiawei Lin    Cat(match_mask_c_addr & ~(match_mask_c_addr + 1.U), ((1 << PMPOffBits) - 1).U(PMPOffBits.W))
67b6982e83SLemover  }
68b6982e83SLemover
69b6982e83SLemover  def write_cfg_vec(mask: Vec[UInt], addr: Vec[UInt], index: Int)(cfgs: UInt): UInt = {
70b6982e83SLemover    val cfgVec = Wire(Vec(cfgs.getWidth/8, new PMPConfig))
71b6982e83SLemover    for (i <- cfgVec.indices) {
72ca2f90a6SLemover      val cfg_w_m_tmp = cfgs((i+1)*8-1, i*8).asUInt.asTypeOf(new PMPConfig)
73ca2f90a6SLemover      cfgVec(i) := cfg_w_m_tmp
74*ff1b5dbbSLemover      when (!cfg_w_m_tmp.l) {
75ca2f90a6SLemover        cfgVec(i).w := cfg_w_m_tmp.w && cfg_w_m_tmp.r
76ca2f90a6SLemover        if (CoarserGrain) { cfgVec(i).a := Cat(cfg_w_m_tmp.a(1), cfg_w_m_tmp.a.orR) }
77b6982e83SLemover        when (cfgVec(i).na4_napot) {
7898c71602SJiawei Lin          mask(index + i) := match_mask(cfgVec(i), addr(index + i))
79b6982e83SLemover        }
80b6982e83SLemover      }
81*ff1b5dbbSLemover    }
82b6982e83SLemover    cfgVec.asUInt
83b6982e83SLemover  }
84b6982e83SLemover
85b6982e83SLemover  def read_addr(cfg: PMPConfig)(addr: UInt): UInt = {
86b6982e83SLemover    val G = PlatformGrain - PMPOffBits
87b6982e83SLemover    require(G >= 0)
88b6982e83SLemover    if (G == 0) {
89b6982e83SLemover      addr
90b6982e83SLemover    } else if (G >= 2) {
91b6982e83SLemover      Mux(cfg.na4_napot, set_low_bits(addr, G-1), clear_low_bits(addr, G))
92b6982e83SLemover    } else { // G is 1
93b6982e83SLemover      Mux(cfg.off_tor, clear_low_bits(addr, G), addr)
94b6982e83SLemover    }
95b6982e83SLemover  }
9698c71602SJiawei Lin
9798c71602SJiawei Lin  def write_addr(next: PMPConfig, mask: UInt)(paddr: UInt, cfg: PMPConfig, addr: UInt): UInt = {
9898c71602SJiawei Lin    val locked = cfg.addr_locked(next)
9998c71602SJiawei Lin    mask := Mux(!locked, match_mask(cfg, paddr), mask)
10098c71602SJiawei Lin    Mux(!locked, paddr, addr)
101b6982e83SLemover  }
102b6982e83SLemover
103b6982e83SLemover  def set_low_bits(data: UInt, num: Int): UInt = {
104b6982e83SLemover    require(num >= 0)
105b6982e83SLemover    data | ((1 << num)-1).U
106b6982e83SLemover  }
107b6982e83SLemover
108b6982e83SLemover  /** mask the data's low num bits (lsb) */
109b6982e83SLemover  def clear_low_bits(data: UInt, num: Int): UInt = {
110b6982e83SLemover    require(num >= 0)
111b6982e83SLemover    // use Cat instead of & with mask to avoid "Signal Width" problem
112b6982e83SLemover    if (num == 0) { data }
113b6982e83SLemover    else { Cat(data(data.getWidth-1, num), 0.U(num.W)) }
114b6982e83SLemover  }
115ca2f90a6SLemover}
116ca2f90a6SLemover
11798c71602SJiawei Lintrait PMPReadWriteMethod extends PMPReadWriteMethodBare  { this: PMPBase =>
11898c71602SJiawei Lin  def write_cfg_vec(cfgs: UInt): UInt = {
11998c71602SJiawei Lin    val cfgVec = Wire(Vec(cfgs.getWidth/8, new PMPConfig))
12098c71602SJiawei Lin    for (i <- cfgVec.indices) {
12198c71602SJiawei Lin      val cfg_w_tmp = cfgs((i+1)*8-1, i*8).asUInt.asTypeOf(new PMPConfig)
12298c71602SJiawei Lin      cfgVec(i) := cfg_w_tmp
123*ff1b5dbbSLemover      when (!cfg_w_tmp.l) {
12498c71602SJiawei Lin        cfgVec(i).w := cfg_w_tmp.w && cfg_w_tmp.r
12598c71602SJiawei Lin        if (CoarserGrain) { cfgVec(i).a := Cat(cfg_w_tmp.a(1), cfg_w_tmp.a.orR) }
12698c71602SJiawei Lin      }
127*ff1b5dbbSLemover    }
12898c71602SJiawei Lin    cfgVec.asUInt
12998c71602SJiawei Lin  }
13098c71602SJiawei Lin
13198c71602SJiawei Lin  /** In general, the PMP grain is 2**{G+2} bytes. when G >= 1, na4 is not selectable.
13298c71602SJiawei Lin   * When G >= 2 and cfg.a(1) is set(then the mode is napot), the bits addr(G-2, 0) read as zeros.
13398c71602SJiawei Lin   * When G >= 1 and cfg.a(1) is clear(the mode is off or tor), the addr(G-1, 0) read as zeros.
13498c71602SJiawei Lin   * The low OffBits is dropped
13598c71602SJiawei Lin   */
13698c71602SJiawei Lin  def read_addr(): UInt = {
13798c71602SJiawei Lin    read_addr(cfg)(addr)
13898c71602SJiawei Lin  }
13998c71602SJiawei Lin
14098c71602SJiawei Lin  /** addr for inside addr, drop OffBits with.
14198c71602SJiawei Lin   * compare_addr for inside addr for comparing.
14298c71602SJiawei Lin   * paddr for outside addr.
14398c71602SJiawei Lin   */
14498c71602SJiawei Lin  def write_addr(next: PMPConfig)(paddr: UInt): UInt = {
14598c71602SJiawei Lin    Mux(!cfg.addr_locked(next), paddr, addr)
14698c71602SJiawei Lin  }
14798c71602SJiawei Lin  def write_addr(paddr: UInt): UInt = {
14898c71602SJiawei Lin    Mux(!cfg.addr_locked, paddr, addr)
14998c71602SJiawei Lin  }
15098c71602SJiawei Lin}
15198c71602SJiawei Lin
152ca2f90a6SLemover/** PMPBase for CSR unit
153ca2f90a6SLemover  * with only read and write logic
154ca2f90a6SLemover  */
155ca2f90a6SLemover@chiselName
156ca2f90a6SLemoverclass PMPBase(implicit p: Parameters) extends PMPBundle with PMPReadWriteMethod {
157ca2f90a6SLemover  val cfg = new PMPConfig
15898c71602SJiawei Lin  val addr = UInt((PMPAddrBits - PMPOffBits).W)
159b6982e83SLemover
160b6982e83SLemover  def gen(cfg: PMPConfig, addr: UInt) = {
161b6982e83SLemover    require(addr.getWidth == this.addr.getWidth)
162b6982e83SLemover    this.cfg := cfg
163b6982e83SLemover    this.addr := addr
164b6982e83SLemover  }
165b6982e83SLemover}
166b6982e83SLemover
167ca2f90a6SLemovertrait PMPMatchMethod extends PMPConst { this: PMPEntry =>
168b6982e83SLemover  /** compare_addr is used to compare with input addr */
16998c71602SJiawei Lin  def compare_addr: UInt = ((addr << PMPOffBits) & ~(((1 << PlatformGrain) - 1).U(PMPAddrBits.W))).asUInt
170b6982e83SLemover
171b6982e83SLemover  /** size and maxSize are all log2 Size
17298c71602SJiawei Lin   * for dtlb, the maxSize is bPMXLEN which is 8
173b6982e83SLemover   * for itlb and ptw, the maxSize is log2(512) ?
174b6982e83SLemover   * but we may only need the 64 bytes? how to prevent the bugs?
17598c71602SJiawei Lin   * TODO: handle the special case that itlb & ptw & dcache access wider size than PMXLEN
176b6982e83SLemover   */
177b6982e83SLemover  def is_match(paddr: UInt, lgSize: UInt, lgMaxSize: Int, last_pmp: PMPEntry): Bool = {
178b6982e83SLemover    Mux(cfg.na4_napot, napotMatch(paddr, lgSize, lgMaxSize),
179b6982e83SLemover      Mux(cfg.tor, torMatch(paddr, lgSize, lgMaxSize, last_pmp), false.B))
180b6982e83SLemover  }
181b6982e83SLemover
182b6982e83SLemover  /** generate match mask to help match in napot mode */
18398c71602SJiawei Lin  def match_mask(paddr: UInt): UInt = {
18498c71602SJiawei Lin    match_mask(cfg, paddr)
185b6982e83SLemover  }
186b6982e83SLemover
187ca2f90a6SLemover  def boundMatch(paddr: UInt, lgSize: UInt, lgMaxSize: Int): Bool = {
188b6982e83SLemover    if (lgMaxSize <= PlatformGrain) {
189ca2f90a6SLemover      (paddr < compare_addr)
190b6982e83SLemover    } else {
191b6982e83SLemover      val highLess = (paddr >> lgMaxSize) < (compare_addr >> lgMaxSize)
192b6982e83SLemover      val highEqual = (paddr >> lgMaxSize) === (compare_addr >> lgMaxSize)
193b6982e83SLemover      val lowLess = (paddr(lgMaxSize-1, 0) | OneHot.UIntToOH1(lgSize, lgMaxSize))  < compare_addr(lgMaxSize-1, 0)
194b6982e83SLemover      highLess || (highEqual && lowLess)
195b6982e83SLemover    }
196b6982e83SLemover  }
197b6982e83SLemover
198ca2f90a6SLemover  def lowerBoundMatch(paddr: UInt, lgSize: UInt, lgMaxSize: Int): Bool = {
199b6982e83SLemover    !boundMatch(paddr, lgSize, lgMaxSize)
200b6982e83SLemover  }
201b6982e83SLemover
202b6982e83SLemover  def higherBoundMatch(paddr: UInt, lgMaxSize: Int) = {
203b6982e83SLemover    boundMatch(paddr, 0.U, lgMaxSize)
204b6982e83SLemover  }
205b6982e83SLemover
206ca2f90a6SLemover  def torMatch(paddr: UInt, lgSize: UInt, lgMaxSize: Int, last_pmp: PMPEntry): Bool = {
207b6982e83SLemover    last_pmp.lowerBoundMatch(paddr, lgSize, lgMaxSize) && higherBoundMatch(paddr, lgMaxSize)
208b6982e83SLemover  }
209b6982e83SLemover
210b6982e83SLemover  def unmaskEqual(a: UInt, b: UInt, m: UInt) = {
211b6982e83SLemover    (a & ~m) === (b & ~m)
212b6982e83SLemover  }
213b6982e83SLemover
214b6982e83SLemover  def napotMatch(paddr: UInt, lgSize: UInt, lgMaxSize: Int) = {
215b6982e83SLemover    if (lgMaxSize <= PlatformGrain) {
216b6982e83SLemover      unmaskEqual(paddr, compare_addr, mask)
217b6982e83SLemover    } else {
218b6982e83SLemover      val lowMask = mask | OneHot.UIntToOH1(lgSize, lgMaxSize)
219b6982e83SLemover      val highMatch = unmaskEqual(paddr >> lgMaxSize, compare_addr >> lgMaxSize, mask >> lgMaxSize)
220b6982e83SLemover      val lowMatch = unmaskEqual(paddr(lgMaxSize-1, 0), compare_addr(lgMaxSize-1, 0), lowMask(lgMaxSize-1, 0))
221b6982e83SLemover      highMatch && lowMatch
222b6982e83SLemover    }
223b6982e83SLemover  }
224b6982e83SLemover
225b6982e83SLemover  def aligned(paddr: UInt, lgSize: UInt, lgMaxSize: Int, last: PMPEntry) = {
226b6982e83SLemover    if (lgMaxSize <= PlatformGrain) {
227b6982e83SLemover      true.B
228b6982e83SLemover    } else {
229b6982e83SLemover      val lowBitsMask = OneHot.UIntToOH1(lgSize, lgMaxSize)
230b6982e83SLemover      val lowerBound = ((paddr >> lgMaxSize) === (last.compare_addr >> lgMaxSize)) &&
231b6982e83SLemover        ((~paddr(lgMaxSize-1, 0) & last.compare_addr(lgMaxSize-1, 0)) =/= 0.U)
232b6982e83SLemover      val upperBound = ((paddr >> lgMaxSize) === (compare_addr >> lgMaxSize)) &&
233b6982e83SLemover        ((compare_addr(lgMaxSize-1, 0) & (paddr(lgMaxSize-1, 0) | lowBitsMask)) =/= 0.U)
234b6982e83SLemover      val torAligned = !(lowerBound || upperBound)
235b6982e83SLemover      val napotAligned = (lowBitsMask & ~mask(lgMaxSize-1, 0)) === 0.U
236b6982e83SLemover      Mux(cfg.na4_napot, napotAligned, torAligned)
237b6982e83SLemover    }
238b6982e83SLemover  }
239ca2f90a6SLemover}
240ca2f90a6SLemover
241ca2f90a6SLemover/** PMPEntry for outside pmp copies
242ca2f90a6SLemover  * with one more elements mask to help napot match
243ca2f90a6SLemover  * TODO: make mask an element, not an method, for timing opt
244ca2f90a6SLemover  */
245ca2f90a6SLemover@chiselName
246ca2f90a6SLemoverclass PMPEntry(implicit p: Parameters) extends PMPBase with PMPMatchMethod {
24798c71602SJiawei Lin  val mask = UInt(PMPAddrBits.W) // help to match in napot
248ca2f90a6SLemover
24998c71602SJiawei Lin  def write_addr(next: PMPConfig, mask: UInt)(paddr: UInt) = {
25098c71602SJiawei Lin    mask := Mux(!cfg.addr_locked(next), match_mask(paddr), mask)
25198c71602SJiawei Lin    Mux(!cfg.addr_locked(next), paddr, addr)
252ca2f90a6SLemover  }
253ca2f90a6SLemover
254ca2f90a6SLemover  def write_addr(mask: UInt)(paddr: UInt) = {
255ca2f90a6SLemover    mask := Mux(!cfg.addr_locked, match_mask(paddr), mask)
256ca2f90a6SLemover    Mux(!cfg.addr_locked, paddr, addr)
257ca2f90a6SLemover  }
258b6982e83SLemover
259b6982e83SLemover  def gen(cfg: PMPConfig, addr: UInt, mask: UInt) = {
260b6982e83SLemover    require(addr.getWidth == this.addr.getWidth)
261b6982e83SLemover    this.cfg := cfg
262b6982e83SLemover    this.addr := addr
263b6982e83SLemover    this.mask := mask
264b6982e83SLemover  }
265ca2f90a6SLemover}
266b6982e83SLemover
26798c71602SJiawei Lintrait PMPMethod extends PMPConst {
268ca2f90a6SLemover  def pmp_init() : (Vec[UInt], Vec[UInt], Vec[UInt])= {
26998c71602SJiawei Lin    val cfg = WireInit(0.U.asTypeOf(Vec(NumPMP/8, UInt(PMXLEN.W))))
27098c71602SJiawei Lin    val addr = Wire(Vec(NumPMP, UInt((PMPAddrBits-PMPOffBits).W)))
27198c71602SJiawei Lin    val mask = Wire(Vec(NumPMP, UInt(PMPAddrBits.W)))
272ca2f90a6SLemover    addr := DontCare
273ca2f90a6SLemover    mask := DontCare
274ca2f90a6SLemover    (cfg, addr, mask)
275ca2f90a6SLemover  }
276ca2f90a6SLemover
277ca2f90a6SLemover  def pmp_gen_mapping
278ca2f90a6SLemover  (
279ca2f90a6SLemover    init: () => (Vec[UInt], Vec[UInt], Vec[UInt]),
280ca2f90a6SLemover    num: Int = 16,
281ca2f90a6SLemover    cfgBase: Int,
282ca2f90a6SLemover    addrBase: Int,
283ca2f90a6SLemover    entries: Vec[PMPEntry]
284ca2f90a6SLemover  ) = {
28598c71602SJiawei Lin    val pmpCfgPerCSR = PMXLEN / new PMPConfig().getWidth
28698c71602SJiawei Lin    def pmpCfgIndex(i: Int) = (PMXLEN / 32) * (i / pmpCfgPerCSR)
287ca2f90a6SLemover    val init_value = init()
288ca2f90a6SLemover    /** to fit MaskedRegMap's write, declare cfgs as Merged CSRs and split them into each pmp */
28998c71602SJiawei Lin    val cfgMerged = RegInit(init_value._1) //(Vec(num / pmpCfgPerCSR, UInt(PMXLEN.W))) // RegInit(VecInit(Seq.fill(num / pmpCfgPerCSR)(0.U(PMXLEN.W))))
290ca2f90a6SLemover    val cfgs = WireInit(cfgMerged).asTypeOf(Vec(num, new PMPConfig()))
29198c71602SJiawei Lin    val addr = RegInit(init_value._2) // (Vec(num, UInt((PMPAddrBits-PMPOffBits).W)))
29298c71602SJiawei Lin    val mask = RegInit(init_value._3) // (Vec(num, UInt(PMPAddrBits.W)))
293ca2f90a6SLemover
294ca2f90a6SLemover    for (i <- entries.indices) {
295ca2f90a6SLemover      entries(i).gen(cfgs(i), addr(i), mask(i))
296ca2f90a6SLemover    }
297ca2f90a6SLemover
298ca2f90a6SLemover    val cfg_mapping = (0 until num by pmpCfgPerCSR).map(i => {Map(
299ca2f90a6SLemover      MaskedRegMap(
300ca2f90a6SLemover        addr = cfgBase + pmpCfgIndex(i),
301ca2f90a6SLemover        reg = cfgMerged(i/pmpCfgPerCSR),
302ca2f90a6SLemover        wmask = WritableMask,
303ca2f90a6SLemover        wfn = new PMPBase().write_cfg_vec(mask, addr, i)
304ca2f90a6SLemover      ))
305ca2f90a6SLemover    }).fold(Map())((a, b) => a ++ b) // ugly code, hit me if u have better codes
306ca2f90a6SLemover
307ca2f90a6SLemover    val addr_mapping = (0 until num).map(i => {Map(
308ca2f90a6SLemover      MaskedRegMap(
309ca2f90a6SLemover        addr = addrBase + i,
310ca2f90a6SLemover        reg = addr(i),
311ca2f90a6SLemover        wmask = WritableMask,
31298c71602SJiawei Lin        wfn = { if (i != num-1) entries(i).write_addr(entries(i+1).cfg, mask(i)) else entries(i).write_addr(mask(i)) },
313ca2f90a6SLemover        rmask = WritableMask,
314ca2f90a6SLemover        rfn = new PMPBase().read_addr(entries(i).cfg)
315ca2f90a6SLemover      ))
316ca2f90a6SLemover    }).fold(Map())((a, b) => a ++ b) // ugly code, hit me if u have better codes.
317ca2f90a6SLemover
318ca2f90a6SLemover    cfg_mapping ++ addr_mapping
319b6982e83SLemover  }
320b6982e83SLemover}
321b6982e83SLemover
322b6982e83SLemover@chiselName
32398c71602SJiawei Linclass PMP(implicit p: Parameters) extends PMPXSModule with HasXSParameter with PMPMethod with PMAMethod with HasCSRConst {
324b6982e83SLemover  val io = IO(new Bundle {
325b6982e83SLemover    val distribute_csr = Flipped(new DistributedCSRIO())
326b6982e83SLemover    val pmp = Output(Vec(NumPMP, new PMPEntry()))
327ca2f90a6SLemover    val pma = Output(Vec(NumPMA, new PMPEntry()))
328b6982e83SLemover  })
329b6982e83SLemover
330b6982e83SLemover  val w = io.distribute_csr.w
331b6982e83SLemover
332b6982e83SLemover  val pmp = Wire(Vec(NumPMP, new PMPEntry()))
333ca2f90a6SLemover  val pma = Wire(Vec(NumPMA, new PMPEntry()))
334b6982e83SLemover
335ca2f90a6SLemover  val pmpMapping = pmp_gen_mapping(pmp_init, NumPMP, PmpcfgBase, PmpaddrBase, pmp)
336ca2f90a6SLemover  val pmaMapping = pmp_gen_mapping(pma_init, NumPMA, PmacfgBase, PmaaddrBase, pma)
337ca2f90a6SLemover  val mapping = pmpMapping ++ pmaMapping
338b6982e83SLemover
33998c71602SJiawei Lin  val rdata = Wire(UInt(PMXLEN.W))
340ca2f90a6SLemover  MaskedRegMap.generate(mapping, w.bits.addr, rdata, w.valid, w.bits.data)
341b6982e83SLemover
342b6982e83SLemover  io.pmp := pmp
343ca2f90a6SLemover  io.pma := pma
344b6982e83SLemover}
345b6982e83SLemover
346b6982e83SLemoverclass PMPReqBundle(lgMaxSize: Int = 3)(implicit p: Parameters) extends PMPBundle {
34798c71602SJiawei Lin  val addr = Output(UInt(PMPAddrBits.W))
348b6982e83SLemover  val size = Output(UInt(log2Ceil(lgMaxSize+1).W))
349b6982e83SLemover  val cmd = Output(TlbCmd())
350b6982e83SLemover
35198c71602SJiawei Lin  def apply(addr: UInt, size: UInt, cmd: UInt) {
35298c71602SJiawei Lin    this.addr := addr
35398c71602SJiawei Lin    this.size := size
35498c71602SJiawei Lin    this.cmd := cmd
35598c71602SJiawei Lin  }
35698c71602SJiawei Lin
35798c71602SJiawei Lin  def apply(addr: UInt) { // req minimal permission and req align size
35898c71602SJiawei Lin    apply(addr, lgMaxSize.U, TlbCmd.read)
35998c71602SJiawei Lin  }
36098c71602SJiawei Lin
361b6982e83SLemover  override def cloneType = (new PMPReqBundle(lgMaxSize)).asInstanceOf[this.type]
362b6982e83SLemover}
363b6982e83SLemover
36498c71602SJiawei Linclass PMPRespBundle(implicit p: Parameters) extends PMPBundle {
36598c71602SJiawei Lin  val ld = Output(Bool())
36698c71602SJiawei Lin  val st = Output(Bool())
36798c71602SJiawei Lin  val instr = Output(Bool())
368ca2f90a6SLemover  val mmio = Output(Bool())
369b6982e83SLemover
370ca2f90a6SLemover  def |(resp: PMPRespBundle): PMPRespBundle = {
371ca2f90a6SLemover    val res = Wire(new PMPRespBundle())
372ca2f90a6SLemover    res.ld := this.ld || resp.ld
373ca2f90a6SLemover    res.st := this.st || resp.st
374ca2f90a6SLemover    res.instr := this.instr || resp.instr
375ca2f90a6SLemover    res.mmio := this.mmio || resp.mmio
376ca2f90a6SLemover    res
377ca2f90a6SLemover  }
378ca2f90a6SLemover}
379b6982e83SLemover
38098c71602SJiawei Lintrait PMPCheckMethod extends PMPConst {
38198c71602SJiawei Lin  def pmp_check(cmd: UInt, cfg: PMPConfig) = {
382ca2f90a6SLemover    val resp = Wire(new PMPRespBundle)
383ca2f90a6SLemover    resp.ld := TlbCmd.isRead(cmd) && !TlbCmd.isAtom(cmd) && !cfg.r
384ca2f90a6SLemover    resp.st := (TlbCmd.isWrite(cmd) || TlbCmd.isAtom(cmd)) && !cfg.w
385ca2f90a6SLemover    resp.instr := TlbCmd.isExec(cmd) && !cfg.x
386ca2f90a6SLemover    resp.mmio := false.B
387ca2f90a6SLemover    resp
388ca2f90a6SLemover  }
389b6982e83SLemover
3905cf62c1aSLemover  def pmp_match_res(leaveHitMux: Boolean = false, valid: Bool = true.B)(
3915cf62c1aSLemover    addr: UInt,
3925cf62c1aSLemover    size: UInt,
3935cf62c1aSLemover    pmpEntries: Vec[PMPEntry],
3945cf62c1aSLemover    mode: UInt,
3955cf62c1aSLemover    lgMaxSize: Int
3965cf62c1aSLemover  ) = {
397ca2f90a6SLemover    val num = pmpEntries.size
398ca2f90a6SLemover    require(num == NumPMP)
399ca2f90a6SLemover
40098c71602SJiawei Lin    val passThrough = if (pmpEntries.isEmpty) true.B else (mode > 1.U)
401a15116bdSLemover    val pmpDefault = WireInit(0.U.asTypeOf(new PMPEntry()))
402a15116bdSLemover    pmpDefault.cfg.r := passThrough
403a15116bdSLemover    pmpDefault.cfg.w := passThrough
404a15116bdSLemover    pmpDefault.cfg.x := passThrough
405b6982e83SLemover
406a15116bdSLemover    val match_vec = Wire(Vec(num+1, Bool()))
407a15116bdSLemover    val cfg_vec = Wire(Vec(num+1, new PMPEntry()))
408a15116bdSLemover
409a15116bdSLemover    pmpEntries.zip(pmpDefault +: pmpEntries.take(num-1)).zipWithIndex.foreach{ case ((pmp, last_pmp), i) =>
410ca2f90a6SLemover      val is_match = pmp.is_match(addr, size, lgMaxSize, last_pmp)
411b6982e83SLemover      val ignore = passThrough && !pmp.cfg.l
412ca2f90a6SLemover      val aligned = pmp.aligned(addr, size, lgMaxSize, last_pmp)
413b6982e83SLemover
414b6982e83SLemover      val cur = WireInit(pmp)
415b6982e83SLemover      cur.cfg.r := aligned && (pmp.cfg.r || ignore)
416b6982e83SLemover      cur.cfg.w := aligned && (pmp.cfg.w || ignore)
417b6982e83SLemover      cur.cfg.x := aligned && (pmp.cfg.x || ignore)
418b6982e83SLemover
419a15116bdSLemover//      Mux(is_match, cur, prev)
420a15116bdSLemover      match_vec(i) := is_match
421a15116bdSLemover      cfg_vec(i) := cur
422b6982e83SLemover    }
423a15116bdSLemover
424a15116bdSLemover    // default value
425a15116bdSLemover    match_vec(num) := true.B
426a15116bdSLemover    cfg_vec(num) := pmpDefault
427a15116bdSLemover
4285cf62c1aSLemover    if (leaveHitMux) {
4295cf62c1aSLemover      ParallelPriorityMux(match_vec.map(RegEnable(_, init = false.B, valid)), RegEnable(cfg_vec, valid))
4305cf62c1aSLemover    } else {
431a15116bdSLemover      ParallelPriorityMux(match_vec, cfg_vec)
432ca2f90a6SLemover    }
433ca2f90a6SLemover  }
4345cf62c1aSLemover}
435b6982e83SLemover
43698c71602SJiawei Linclass PMPCheckerEnv(implicit p: Parameters) extends PMPBundle {
43798c71602SJiawei Lin  val mode = UInt(2.W)
43898c71602SJiawei Lin  val pmp = Vec(NumPMP, new PMPEntry())
43998c71602SJiawei Lin  val pma = Vec(NumPMA, new PMPEntry())
44098c71602SJiawei Lin
44198c71602SJiawei Lin  def apply(mode: UInt, pmp: Vec[PMPEntry], pma: Vec[PMPEntry]): Unit = {
44298c71602SJiawei Lin    this.mode := mode
44398c71602SJiawei Lin    this.pmp := pmp
44498c71602SJiawei Lin    this.pma := pma
44598c71602SJiawei Lin  }
44698c71602SJiawei Lin}
44798c71602SJiawei Lin
44898c71602SJiawei Linclass PMPCheckIO(lgMaxSize: Int)(implicit p: Parameters) extends PMPBundle {
44998c71602SJiawei Lin  val check_env = Input(new PMPCheckerEnv())
45098c71602SJiawei Lin  val req = Flipped(Valid(new PMPReqBundle(lgMaxSize))) // usage: assign the valid to fire signal
45198c71602SJiawei Lin  val resp = new PMPRespBundle()
45298c71602SJiawei Lin
45398c71602SJiawei Lin  def apply(mode: UInt, pmp: Vec[PMPEntry], pma: Vec[PMPEntry], req: Valid[PMPReqBundle]) = {
45498c71602SJiawei Lin    check_env.apply(mode, pmp, pma)
45598c71602SJiawei Lin    this.req := req
45698c71602SJiawei Lin    resp
45798c71602SJiawei Lin  }
45898c71602SJiawei Lin
45998c71602SJiawei Lin  def req_apply(valid: Bool, addr: UInt): Unit = {
46098c71602SJiawei Lin    this.req.valid := valid
46198c71602SJiawei Lin    this.req.bits.apply(addr)
46298c71602SJiawei Lin  }
46398c71602SJiawei Lin
46498c71602SJiawei Lin  def apply(mode: UInt, pmp: Vec[PMPEntry], pma: Vec[PMPEntry], valid: Bool, addr: UInt) = {
46598c71602SJiawei Lin    check_env.apply(mode, pmp, pma)
46698c71602SJiawei Lin    req_apply(valid, addr)
46798c71602SJiawei Lin    resp
46898c71602SJiawei Lin  }
46998c71602SJiawei Lin  override def cloneType: this.type = (new PMPCheckIO(lgMaxSize)).asInstanceOf[this.type]
47098c71602SJiawei Lin}
47198c71602SJiawei Lin
4725b7ef044SLemoverclass PMPCheckv2IO(lgMaxSize: Int)(implicit p: Parameters) extends PMPBundle {
4735b7ef044SLemover  val check_env = Input(new PMPCheckerEnv())
4745b7ef044SLemover  val req = Flipped(Valid(new PMPReqBundle(lgMaxSize))) // usage: assign the valid to fire signal
4755b7ef044SLemover  val resp = Output(new PMPConfig())
4765b7ef044SLemover
4775b7ef044SLemover  def apply(mode: UInt, pmp: Vec[PMPEntry], pma: Vec[PMPEntry], req: Valid[PMPReqBundle]) = {
4785b7ef044SLemover    check_env.apply(mode, pmp, pma)
4795b7ef044SLemover    this.req := req
4805b7ef044SLemover    resp
4815b7ef044SLemover  }
4825b7ef044SLemover
4835b7ef044SLemover  def req_apply(valid: Bool, addr: UInt): Unit = {
4845b7ef044SLemover    this.req.valid := valid
4855b7ef044SLemover    this.req.bits.apply(addr)
4865b7ef044SLemover  }
4875b7ef044SLemover
4885b7ef044SLemover  def apply(mode: UInt, pmp: Vec[PMPEntry], pma: Vec[PMPEntry], valid: Bool, addr: UInt) = {
4895b7ef044SLemover    check_env.apply(mode, pmp, pma)
4905b7ef044SLemover    req_apply(valid, addr)
4915b7ef044SLemover    resp
4925b7ef044SLemover  }
4935b7ef044SLemover  override def cloneType: this.type = (new PMPCheckv2IO(lgMaxSize)).asInstanceOf[this.type]
4945b7ef044SLemover}
4955b7ef044SLemover
496ca2f90a6SLemover@chiselName
497ca2f90a6SLemoverclass PMPChecker
498ca2f90a6SLemover(
499ca2f90a6SLemover  lgMaxSize: Int = 3,
5005cf62c1aSLemover  sameCycle: Boolean = false,
50198c71602SJiawei Lin  leaveHitMux: Boolean = false,
50298c71602SJiawei Lin  pmpUsed: Boolean = true
50398c71602SJiawei Lin)(implicit p: Parameters) extends PMPModule
504ca2f90a6SLemover  with PMPCheckMethod
505ca2f90a6SLemover  with PMACheckMethod
506ca2f90a6SLemover{
5075cf62c1aSLemover  require(!(leaveHitMux && sameCycle))
50898c71602SJiawei Lin  val io = IO(new PMPCheckIO(lgMaxSize))
509ca2f90a6SLemover
510ca2f90a6SLemover  val req = io.req.bits
511ca2f90a6SLemover
51298c71602SJiawei Lin  val res_pmp = pmp_match_res(leaveHitMux, io.req.valid)(req.addr, req.size, io.check_env.pmp, io.check_env.mode, lgMaxSize)
51398c71602SJiawei Lin  val res_pma = pma_match_res(leaveHitMux, io.req.valid)(req.addr, req.size, io.check_env.pma, io.check_env.mode, lgMaxSize)
514ca2f90a6SLemover
515ca2f90a6SLemover  val resp_pmp = pmp_check(req.cmd, res_pmp.cfg)
516ca2f90a6SLemover  val resp_pma = pma_check(req.cmd, res_pma.cfg)
51798c71602SJiawei Lin  val resp = if (pmpUsed) (resp_pmp | resp_pma) else resp_pma
518ca2f90a6SLemover
5195cf62c1aSLemover  if (sameCycle || leaveHitMux) {
520ca2f90a6SLemover    io.resp := resp
521b6982e83SLemover  } else {
522ca2f90a6SLemover    io.resp := RegEnable(resp, io.req.valid)
523b6982e83SLemover  }
524b6982e83SLemover}
5255b7ef044SLemover
5265b7ef044SLemover/* get config with check */
5275b7ef044SLemover@chiselName
5285b7ef044SLemoverclass PMPCheckerv2
5295b7ef044SLemover(
5305b7ef044SLemover  lgMaxSize: Int = 3,
5315b7ef044SLemover  sameCycle: Boolean = false,
5325b7ef044SLemover  leaveHitMux: Boolean = false
5335b7ef044SLemover)(implicit p: Parameters) extends PMPModule
5345b7ef044SLemover  with PMPCheckMethod
5355b7ef044SLemover  with PMACheckMethod
5365b7ef044SLemover{
5375b7ef044SLemover  require(!(leaveHitMux && sameCycle))
5385b7ef044SLemover  val io = IO(new PMPCheckv2IO(lgMaxSize))
5395b7ef044SLemover
5405b7ef044SLemover  val req = io.req.bits
5415b7ef044SLemover
5425b7ef044SLemover  val res_pmp = pmp_match_res(leaveHitMux, io.req.valid)(req.addr, req.size, io.check_env.pmp, io.check_env.mode, lgMaxSize)
5435b7ef044SLemover  val res_pma = pma_match_res(leaveHitMux, io.req.valid)(req.addr, req.size, io.check_env.pma, io.check_env.mode, lgMaxSize)
5445b7ef044SLemover
5455b7ef044SLemover  val resp = and(res_pmp, res_pma)
5465b7ef044SLemover
5475b7ef044SLemover  if (sameCycle || leaveHitMux) {
5485b7ef044SLemover    io.resp := resp
5495b7ef044SLemover  } else {
5505b7ef044SLemover    io.resp := RegEnable(resp, io.req.valid)
5515b7ef044SLemover  }
5525b7ef044SLemover
5535b7ef044SLemover  def and(pmp: PMPEntry, pma: PMPEntry): PMPConfig = {
5545b7ef044SLemover    val tmp_res = Wire(new PMPConfig)
5555b7ef044SLemover    tmp_res.l := DontCare
5565b7ef044SLemover    tmp_res.a := DontCare
5575b7ef044SLemover    tmp_res.r := pmp.cfg.r && pma.cfg.r
5585b7ef044SLemover    tmp_res.w := pmp.cfg.w && pma.cfg.w
5595b7ef044SLemover    tmp_res.x := pmp.cfg.x && pma.cfg.x
5605b7ef044SLemover    tmp_res.c := pma.cfg.c
5615b7ef044SLemover    tmp_res.atomic := pma.cfg.atomic
5625b7ef044SLemover    tmp_res
5635b7ef044SLemover  }
5645b7ef044SLemover}