pmp.hh

Go to the documentation of this file.

/*
 * Copyright (c) 2021 The Regents of the University of California
 * Copyright (c) 2023 Google LLC
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met: redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer;
 * redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution;
 * neither the name of the copyright holders nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef __ARCH_RISCV_PMP_HH__
#define __ARCH_RISCV_PMP_HH__
 
#include "arch/generic/tlb.hh"
#include "arch/riscv/isa.hh"
#include "base/addr_range.hh"
#include "base/types.hh"
#include "mem/packet.hh"
#include "params/PMP.hh"
#include "sim/sim_object.hh"
 
namespace gem5
{
 
namespace RiscvISA
{
 
class PMP : public SimObject
{
  public:
    PARAMS(PMP);
    PMP(const Params &params);
 
  private:
    int pmpEntries;
 
    enum pmpAmatch
    {
        PMP_OFF,
        PMP_TOR,
        PMP_NA4,
        PMP_NAPOT
    };
 
    const uint8_t PMP_READ = 1 << 0;
 
    const uint8_t PMP_WRITE = 1 << 1;
 
    const uint8_t PMP_EXEC = 1 << 2;
 
    const uint8_t PMP_A_MASK = 3 << 3;
 
    const uint8_t PMP_LOCK = 1 << 7;
 
    int numRules;
 
    bool hasLockEntry;
 
    struct PmpEntry
    {
        AddrRange pmpAddr = AddrRange(0, 0);
        Addr rawAddr;
        uint8_t pmpCfg = 0;
    };
 
    std::vector<PmpEntry> pmpTable;
 
  public:
    Fault pmpCheck(const RequestPtr &req, BaseMMU::Mode mode,
                  PrivilegeMode pmode, ThreadContext *tc,
                  Addr vaddr = 0);
 
    bool pmpUpdateCfg(uint32_t pmp_index, uint8_t this_cfg);
 
    bool pmpUpdateAddr(uint32_t pmp_index, Addr this_addr);
 
    void pmpReset();
 
  private:
    bool shouldCheckPMP(PrivilegeMode pmode, ThreadContext *tc);
 
    Fault createAddrfault(Addr vaddr, BaseMMU::Mode mode);
 
    void pmpUpdateRule(uint32_t pmp_index);
 
    inline uint8_t pmpGetAField(uint8_t cfg);
 
    inline AddrRange pmpDecodeNapot(Addr pmpaddr);
 
};
 
} // namespace RiscvISA
} // namespace gem5
 
#endif // __ARCH_RISCV_PMP_HH__