arch: Get rid of the generic mmapped IPR mechanism.

Jira Issue: https://gem5.atlassian.net/browse/GEM5-187

Change-Id: I4ab6f80581eee39e90fb91c672eca8e1a8fd9046
Reviewed-on: https://gem5-review.googlesource.com/c/public/gem5/+/23186
Tested-by: kokoro <noreply+kokoro@google.com>
Reviewed-by: Gabe Black <gabeblack@google.com>
Maintainer: Gabe Black <gabeblack@google.com>
diff --git a/src/arch/alpha/mmapped_ipr.hh b/src/arch/alpha/mmapped_ipr.hh
index 46ed6bd..f10e36b 100644
--- a/src/arch/alpha/mmapped_ipr.hh
+++ b/src/arch/alpha/mmapped_ipr.hh
@@ -37,11 +37,17 @@
  * ISA-specific helper functions for memory mapped IPR accesses.
  */
 
-#include "arch/generic/mmapped_ipr.hh"
+#include "base/types.hh"
 
-namespace AlphaISA {
-    using GenericISA::handleIprRead;
-    using GenericISA::handleIprWrite;
+class Packet;
+class ThreadContext;
+
+namespace AlphaISA
+{
+
+inline Cycles handleIprRead(ThreadContext *, Packet *) { return Cycles(1); }
+inline Cycles handleIprWrite(ThreadContext *, Packet *) { return Cycles(1); }
+
 } // namespace AlphaISA
 
 #endif // __ARCH_ALPHA_MMAPPED_IPR_HH__
diff --git a/src/arch/arm/tlb.cc b/src/arch/arm/tlb.cc
index 5358159..cec4597 100644
--- a/src/arch/arm/tlb.cc
+++ b/src/arch/arm/tlb.cc
@@ -55,7 +55,6 @@
 #include "arch/arm/system.hh"
 #include "arch/arm/table_walker.hh"
 #include "arch/arm/utility.hh"
-#include "arch/generic/mmapped_ipr.hh"
 #include "base/inifile.hh"
 #include "base/str.hh"
 #include "base/trace.hh"
diff --git a/src/arch/generic/SConscript b/src/arch/generic/SConscript
index 64be7ce..ec46b07 100644
--- a/src/arch/generic/SConscript
+++ b/src/arch/generic/SConscript
@@ -44,7 +44,6 @@
     Return()
 
 Source('decode_cache.cc')
-Source('mmapped_ipr.cc')
 
 SimObject('BaseInterrupts.py')
 SimObject('BaseISA.py')
diff --git a/src/arch/generic/mmapped_ipr.cc b/src/arch/generic/mmapped_ipr.cc
deleted file mode 100644
index 754ee02..0000000
--- a/src/arch/generic/mmapped_ipr.cc
+++ /dev/null
@@ -1,86 +0,0 @@
-/*
- * Copyright (c) 2013 Andreas Sandberg
- * 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.
- *
- * Authors: Andreas Sandberg
- */
-
-#include "arch/generic/mmapped_ipr.hh"
-
-#include "arch/isa_traits.hh"
-#include "config/the_isa.hh"
-#include "mem/packet.hh"
-#include "mem/packet_access.hh"
-#include "sim/pseudo_inst.hh"
-
-using namespace GenericISA;
-
-static void
-handlePseudoInst(ThreadContext *xc, Packet *pkt)
-{
-    const Addr offset(pkt->getAddr() & IPR_IN_CLASS_MASK);
-    const uint8_t func((offset >> 8) & 0xFF);
-    uint64_t ret;
-
-    assert((offset >> 16) == 0);
-    ret = PseudoInst::pseudoInst<PseudoInstABI>(xc, func);
-    if (pkt->isRead())
-        pkt->set(ret, TheISA::GuestByteOrder);
-}
-
-Cycles
-GenericISA::handleGenericIprRead(ThreadContext *xc, Packet *pkt)
-{
-    Addr va(pkt->getAddr());
-    Addr cls(va >> IPR_CLASS_SHIFT);
-
-    switch (cls) {
-    case IPR_CLASS_PSEUDO_INST:
-        handlePseudoInst(xc, pkt);
-        break;
-    default:
-        panic("Unhandled generic IPR read: 0x%x\n", va);
-    }
-
-    return Cycles(1);
-}
-
-Cycles
-GenericISA::handleGenericIprWrite(ThreadContext *xc, Packet *pkt)
-{
-    Addr va(pkt->getAddr());
-    Addr cls(va >> IPR_CLASS_SHIFT);
-
-    switch (cls) {
-    case IPR_CLASS_PSEUDO_INST:
-        handlePseudoInst(xc, pkt);
-        break;
-    default:
-        panic("Unhandled generic IPR write: 0x%x\n", va);
-    }
-
-    return Cycles(1);
-}
diff --git a/src/arch/generic/mmapped_ipr.hh b/src/arch/generic/mmapped_ipr.hh
deleted file mode 100644
index a371699..0000000
--- a/src/arch/generic/mmapped_ipr.hh
+++ /dev/null
@@ -1,172 +0,0 @@
-/*
- * Copyright (c) 2013 Andreas Sandberg
- * 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.
- *
- * Authors: Andreas Sandberg
- */
-
-#ifndef __ARCH_GENERIC_MMAPPED_IPR_HH__
-#define __ARCH_GENERIC_MMAPPED_IPR_HH__
-
-#include "base/types.hh"
-#include "mem/packet.hh"
-
-class ThreadContext;
-
-/**
- * @file
- *
- * ISA-generic helper functions for memory mapped IPR accesses.
- */
-
-namespace GenericISA
-{
-    /** @{ */
-    /**
-     * Memory requests with the MMAPPED_IPR flag are generally mapped
-     * to registers. There is a class of these registers that are
-     * internal to gem5, for example gem5 pseudo-ops in virtualized
-     * mode. Such IPRs always have the flag GENERIC_IPR set and are
-     * handled by this code.
-     */
-
-    /** Shift amount when extracting the class of a generic IPR */
-    const int IPR_CLASS_SHIFT = 48;
-
-    /** Mask to extract the offset in within a generic IPR class */
-    const Addr IPR_IN_CLASS_MASK = ULL(0x0000FFFFFFFFFFFF);
-
-    /** gem5 pseudo-inst emulation.
-     *
-     * Read and writes to this class execute gem5
-     * pseudo-instructions. A write discards the return value of the
-     * instruction, while a read returns it.
-     *
-     * @see pseudoInst()
-     */
-    const Addr IPR_CLASS_PSEUDO_INST = 0x0;
-
-    /** @} */
-
-    /**
-     * Generate a generic IPR address that emulates a pseudo inst
-     *
-     * @see PseudoInst::pseudoInst()
-     *
-     * @param func Function ID to call.
-     * @param subfunc Sub-function, usually 0.
-     * @return Address in the IPR space corresponding to the call.
-     */
-    inline Addr
-    iprAddressPseudoInst(uint8_t func, uint8_t subfunc)
-    {
-        return (IPR_CLASS_PSEUDO_INST << IPR_CLASS_SHIFT)  |
-            (func << 8) | subfunc;
-    }
-
-    /**
-     * Check if this is an platform independent IPR access
-     *
-     * Accesses to internal platform independent gem5 registers are
-     * handled by handleGenericIprRead() and
-     * handleGenericIprWrite(). This method determines if a packet
-     * should be routed to those functions instead of the platform
-     * specific code.
-     *
-     * @see handleGenericIprRead
-     * @see handleGenericIprWrite
-     */
-    inline bool
-    isGenericIprAccess(const Packet *pkt)
-    {
-        Request::Flags flags(pkt->req->getFlags());
-        return (flags & Request::MMAPPED_IPR) &&
-            (flags & Request::GENERIC_IPR);
-    }
-
-    /**
-     * Handle generic IPR reads
-     *
-     * @param xc Thread context of the current thread.
-     * @param pkt Packet from the CPU
-     * @return Latency in CPU cycles
-     */
-    Cycles handleGenericIprRead(ThreadContext *xc, Packet *pkt);
-    /**
-     * Handle generic IPR writes
-     *
-     * @param xc Thread context of the current thread.
-     * @param pkt Packet from the CPU
-     * @return Latency in CPU cycles
-     */
-    Cycles handleGenericIprWrite(ThreadContext *xc, Packet *pkt);
-
-    /**
-     * Helper function to handle IPRs when the target architecture doesn't
-     * need its own IPR handling.
-     *
-     * This function calls handleGenericIprRead if the accessing a
-     * generic IPR and panics otherwise.
-     *
-     * @param xc Thread context of the current thread.
-     * @param pkt Packet from the CPU
-     * @return Latency in CPU cycles
-     */
-    inline Cycles
-    handleIprRead(ThreadContext *xc, Packet *pkt)
-    {
-        if (!isGenericIprAccess(pkt))
-            panic("Unhandled IPR access\n");
-
-        return handleGenericIprRead(xc, pkt);
-    }
-
-
-    /**
-     * Helper function to handle IPRs when the target architecture
-     * doesn't need its own IPR handling.
-     *
-     * This function calls handleGenericIprWrite if the accessing a
-     * generic IPR and panics otherwise.
-     *
-     * @param xc Thread context of the current thread.
-     * @param pkt Packet from the CPU
-     * @return Latency in CPU cycles
-     */
-    inline Cycles
-    handleIprWrite(ThreadContext *xc, Packet *pkt)
-    {
-        if (!isGenericIprAccess(pkt))
-            panic("Unhandled IPR access\n");
-
-        return handleGenericIprWrite(xc, pkt);
-    }
-
-} // namespace GenericISA
-
-
-
-#endif
diff --git a/src/arch/mips/mmapped_ipr.hh b/src/arch/mips/mmapped_ipr.hh
index 032fa28..c90f755 100644
--- a/src/arch/mips/mmapped_ipr.hh
+++ b/src/arch/mips/mmapped_ipr.hh
@@ -37,14 +37,17 @@
  * ISA-specific helper functions for memory mapped IPR accesses.
  */
 
-#include "arch/generic/mmapped_ipr.hh"
+#include "base/types.hh"
 
+class Packet;
 class ThreadContext;
 
 namespace MipsISA
 {
-    using GenericISA::handleIprRead;
-    using GenericISA::handleIprWrite;
+
+inline Cycles handleIprRead(ThreadContext *, Packet *) { return Cycles(1); }
+inline Cycles handleIprWrite(ThreadContext *, Packet *) { return Cycles(1); }
+
 } // namespace MipsISA
 
 #endif
diff --git a/src/arch/power/mmapped_ipr.hh b/src/arch/power/mmapped_ipr.hh
index 28e3b61..0d829c0 100644
--- a/src/arch/power/mmapped_ipr.hh
+++ b/src/arch/power/mmapped_ipr.hh
@@ -41,14 +41,17 @@
  * ISA-specific helper functions for memory mapped IPR accesses.
  */
 
-#include "arch/generic/mmapped_ipr.hh"
+#include "base/types.hh"
 
+class Packet;
 class ThreadContext;
 
 namespace PowerISA
 {
-    using GenericISA::handleIprRead;
-    using GenericISA::handleIprWrite;
+
+inline Cycles handleIprRead(ThreadContext *, Packet *) { return Cycles(1); }
+inline Cycles handleIprWrite(ThreadContext *, Packet *) { return Cycles(1); }
+
 } // namespace PowerISA
 
 #endif // __ARCH_POWER_MMAPPED_IPR_HH__
diff --git a/src/arch/riscv/mmapped_ipr.hh b/src/arch/riscv/mmapped_ipr.hh
index 023c49c..553d83e 100644
--- a/src/arch/riscv/mmapped_ipr.hh
+++ b/src/arch/riscv/mmapped_ipr.hh
@@ -37,14 +37,17 @@
  * ISA-specific helper functions for memory mapped IPR accesses.
  */
 
-#include "arch/generic/mmapped_ipr.hh"
+#include "base/types.hh"
 
+class Packet;
 class ThreadContext;
 
 namespace RiscvISA
 {
-    using GenericISA::handleIprRead;
-    using GenericISA::handleIprWrite;
+
+inline Cycles handleIprRead(ThreadContext *, Packet *) { return Cycles(1); }
+inline Cycles handleIprWrite(ThreadContext *, Packet *) { return Cycles(1); }
+
 } // namespace RiscvISA
 
 #endif
diff --git a/src/arch/sparc/mmapped_ipr.hh b/src/arch/sparc/mmapped_ipr.hh
index 35e4d89..4fcaa1b 100644
--- a/src/arch/sparc/mmapped_ipr.hh
+++ b/src/arch/sparc/mmapped_ipr.hh
@@ -37,7 +37,6 @@
  * ISA-specific helper functions for memory mapped IPR accesses.
  */
 
-#include "arch/generic/mmapped_ipr.hh"
 #include "arch/sparc/tlb.hh"
 #include "cpu/thread_context.hh"
 #include "mem/packet.hh"
@@ -48,19 +47,13 @@
 inline Cycles
 handleIprRead(ThreadContext *xc, Packet *pkt)
 {
-    if (GenericISA::isGenericIprAccess(pkt))
-        return GenericISA::handleGenericIprRead(xc, pkt);
-    else
-        return dynamic_cast<TLB *>(xc->getDTBPtr())->doMmuRegRead(xc, pkt);
+    return dynamic_cast<TLB *>(xc->getDTBPtr())->doMmuRegRead(xc, pkt);
 }
 
 inline Cycles
 handleIprWrite(ThreadContext *xc, Packet *pkt)
 {
-    if (GenericISA::isGenericIprAccess(pkt))
-        return GenericISA::handleGenericIprWrite(xc, pkt);
-    else
-        return dynamic_cast<TLB *>(xc->getDTBPtr())->doMmuRegWrite(xc, pkt);
+    return dynamic_cast<TLB *>(xc->getDTBPtr())->doMmuRegWrite(xc, pkt);
 }
 
 
diff --git a/src/arch/x86/tlb.cc b/src/arch/x86/tlb.cc
index a649871..e665769 100644
--- a/src/arch/x86/tlb.cc
+++ b/src/arch/x86/tlb.cc
@@ -42,7 +42,6 @@
 #include <cstring>
 #include <memory>
 
-#include "arch/generic/mmapped_ipr.hh"
 #include "arch/x86/faults.hh"
 #include "arch/x86/insts/microldstop.hh"
 #include "arch/x86/pagetable_walker.hh"