ARM: Set up an intregs.hh for ARM.

Add constants for all the modes and registers, maps for aliasing, functions
that use the maps and range check, and use a named constant instead of a magic
number for the microcode register.

3 files changed, 339 insertions, 11 deletions

diff --git a/src/arch/arm/intregs.hh b/src/arch/arm/intregs.hh
new file mode 100644
index 000000000..191965c55
--- /dev/null
+++ b/src/arch/arm/intregs.hh
@@ -0,0 +1,326 @@
+/*
+ * Copyright (c) 2009 The Regents of The University of Michigan
+ * 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: Gabe Black
+ */
+
+#include <assert.h>
+
+#ifndef __ARCH_ARM_INTREGS_HH__
+#define __ARCH_ARM_INTREGS_HH__
+
+namespace ArmISA
+{
+
+enum IntRegIndex
+{
+    /* All the unique register indices. */
+    INTREG_R0,
+    INTREG_R1,
+    INTREG_R2,
+    INTREG_R3,
+    INTREG_R4,
+    INTREG_R5,
+    INTREG_R6,
+    INTREG_R7,
+    INTREG_R8,
+    INTREG_R9,
+    INTREG_R10,
+    INTREG_R11,
+    INTREG_R12,
+    INTREG_R13,
+    INTREG_SP = INTREG_R13,
+    INTREG_R14,
+    INTREG_LR = INTREG_R14,
+    INTREG_R15,
+    INTREG_PC = INTREG_R15,
+
+    INTREG_R13_SVC,
+    INTREG_SP_SVC = INTREG_R13_SVC,
+    INTREG_R14_SVC,
+    INTREG_LR_SVC = INTREG_R14_SVC,
+    INTREG_R15_SVC = INTREG_R15,
+
+    INTREG_R13_MON,
+    INTREG_SP_MON = INTREG_R13_MON,
+    INTREG_R14_MON,
+    INTREG_LR_MON = INTREG_R14_MON,
+    INTREG_R15_MON = INTREG_R15,
+
+    INTREG_R13_ABT,
+    INTREG_SP_ABT = INTREG_R13_ABT,
+    INTREG_R14_ABT,
+    INTREG_LR_ABT = INTREG_R14_ABT,
+    INTREG_R15_ABT = INTREG_R15,
+
+    INTREG_R13_UND,
+    INTREG_SP_UND = INTREG_R13_UND,
+    INTREG_R14_UND,
+    INTREG_LR_UND = INTREG_R14_UND,
+    INTREG_R15_UND = INTREG_R15,
+
+    INTREG_R13_IRQ,
+    INTREG_SP_IRQ = INTREG_R13_IRQ,
+    INTREG_R14_IRQ,
+    INTREG_LR_IRQ = INTREG_R14_IRQ,
+    INTREG_R15_IRQ = INTREG_R15,
+
+    INTREG_R8_FIQ,
+    INTREG_R9_FIQ,
+    INTREG_R10_FIQ,
+    INTREG_R11_FIQ,
+    INTREG_R12_FIQ,
+    INTREG_R13_FIQ,
+    INTREG_SP_FIQ = INTREG_R13_FIQ,
+    INTREG_R14_FIQ,
+    INTREG_LR_FIQ = INTREG_R14_FIQ,
+    INTREG_R15_FIQ = INTREG_R15,
+
+    INTREG_ZERO, // Dummy zero reg since there has to be one.
+    INTREG_UREG0,
+
+    NUM_INTREGS,
+    NUM_ARCH_INTREGS = INTREG_PC + 1,
+
+    /* All the aliased indexes. */
+    
+    /* USR mode */
+    INTREG_R0_USR = INTREG_R0,
+    INTREG_R1_USR = INTREG_R1,
+    INTREG_R2_USR = INTREG_R2,
+    INTREG_R3_USR = INTREG_R3,
+    INTREG_R4_USR = INTREG_R4,
+    INTREG_R5_USR = INTREG_R5,
+    INTREG_R6_USR = INTREG_R6,
+    INTREG_R7_USR = INTREG_R7,
+    INTREG_R8_USR = INTREG_R8,
+    INTREG_R9_USR = INTREG_R9,
+    INTREG_R10_USR = INTREG_R10,
+    INTREG_R11_USR = INTREG_R11,
+    INTREG_R12_USR = INTREG_R12,
+    INTREG_R13_USR = INTREG_R13,
+    INTREG_SP_USR = INTREG_SP,
+    INTREG_R14_USR = INTREG_R14,
+    INTREG_LR_USR = INTREG_LR,
+    INTREG_R15_USR = INTREG_R15,
+    INTREG_PC_USR = INTREG_PC,
+
+    /* SVC mode */
+    INTREG_R0_SVC = INTREG_R0,
+    INTREG_R1_SVC = INTREG_R1,
+    INTREG_R2_SVC = INTREG_R2,
+    INTREG_R3_SVC = INTREG_R3,
+    INTREG_R4_SVC = INTREG_R4,
+    INTREG_R5_SVC = INTREG_R5,
+    INTREG_R6_SVC = INTREG_R6,
+    INTREG_R7_SVC = INTREG_R7,
+    INTREG_R8_SVC = INTREG_R8,
+    INTREG_R9_SVC = INTREG_R9,
+    INTREG_R10_SVC = INTREG_R10,
+    INTREG_R11_SVC = INTREG_R11,
+    INTREG_R12_SVC = INTREG_R12,
+    INTREG_PC_SVC = INTREG_PC,
+
+    /* MON mode */
+    INTREG_R0_MON = INTREG_R0,
+    INTREG_R1_MON = INTREG_R1,
+    INTREG_R2_MON = INTREG_R2,
+    INTREG_R3_MON = INTREG_R3,
+    INTREG_R4_MON = INTREG_R4,
+    INTREG_R5_MON = INTREG_R5,
+    INTREG_R6_MON = INTREG_R6,
+    INTREG_R7_MON = INTREG_R7,
+    INTREG_R8_MON = INTREG_R8,
+    INTREG_R9_MON = INTREG_R9,
+    INTREG_R10_MON = INTREG_R10,
+    INTREG_R11_MON = INTREG_R11,
+    INTREG_R12_MON = INTREG_R12,
+    INTREG_PC_MON = INTREG_PC,
+
+    /* ABT mode */
+    INTREG_R0_ABT = INTREG_R0,
+    INTREG_R1_ABT = INTREG_R1,
+    INTREG_R2_ABT = INTREG_R2,
+    INTREG_R3_ABT = INTREG_R3,
+    INTREG_R4_ABT = INTREG_R4,
+    INTREG_R5_ABT = INTREG_R5,
+    INTREG_R6_ABT = INTREG_R6,
+    INTREG_R7_ABT = INTREG_R7,
+    INTREG_R8_ABT = INTREG_R8,
+    INTREG_R9_ABT = INTREG_R9,
+    INTREG_R10_ABT = INTREG_R10,
+    INTREG_R11_ABT = INTREG_R11,
+    INTREG_R12_ABT = INTREG_R12,
+    INTREG_PC_ABT = INTREG_PC,
+
+    /* UND mode */
+    INTREG_R0_UND = INTREG_R0,
+    INTREG_R1_UND = INTREG_R1,
+    INTREG_R2_UND = INTREG_R2,
+    INTREG_R3_UND = INTREG_R3,
+    INTREG_R4_UND = INTREG_R4,
+    INTREG_R5_UND = INTREG_R5,
+    INTREG_R6_UND = INTREG_R6,
+    INTREG_R7_UND = INTREG_R7,
+    INTREG_R8_UND = INTREG_R8,
+    INTREG_R9_UND = INTREG_R9,
+    INTREG_R10_UND = INTREG_R10,
+    INTREG_R11_UND = INTREG_R11,
+    INTREG_R12_UND = INTREG_R12,
+    INTREG_PC_UND = INTREG_PC,
+
+    /* IRQ mode */
+    INTREG_R0_IRQ = INTREG_R0,
+    INTREG_R1_IRQ = INTREG_R1,
+    INTREG_R2_IRQ = INTREG_R2,
+    INTREG_R3_IRQ = INTREG_R3,
+    INTREG_R4_IRQ = INTREG_R4,
+    INTREG_R5_IRQ = INTREG_R5,
+    INTREG_R6_IRQ = INTREG_R6,
+    INTREG_R7_IRQ = INTREG_R7,
+    INTREG_R8_IRQ = INTREG_R8,
+    INTREG_R9_IRQ = INTREG_R9,
+    INTREG_R10_IRQ = INTREG_R10,
+    INTREG_R11_IRQ = INTREG_R11,
+    INTREG_R12_IRQ = INTREG_R12,
+    INTREG_PC_IRQ = INTREG_PC,
+
+    /* FIQ mode */
+    INTREG_R0_FIQ = INTREG_R0,
+    INTREG_R1_FIQ = INTREG_R1,
+    INTREG_R2_FIQ = INTREG_R2,
+    INTREG_R3_FIQ = INTREG_R3,
+    INTREG_R4_FIQ = INTREG_R4,
+    INTREG_R5_FIQ = INTREG_R5,
+    INTREG_R6_FIQ = INTREG_R6,
+    INTREG_R7_FIQ = INTREG_R7,
+    INTREG_PC_FIQ = INTREG_PC,
+};
+
+typedef IntRegIndex IntRegMap[NUM_ARCH_INTREGS];
+
+const IntRegMap IntRegUsrMap = {
+    INTREG_R0_USR,  INTREG_R1_USR,  INTREG_R2_USR,  INTREG_R3_USR,
+    INTREG_R4_USR,  INTREG_R5_USR,  INTREG_R6_USR,  INTREG_R7_USR,
+    INTREG_R8_USR,  INTREG_R9_USR,  INTREG_R10_USR, INTREG_R11_USR,
+    INTREG_R12_USR, INTREG_R13_USR, INTREG_R14_USR, INTREG_R15_USR
+};
+
+static inline IntRegIndex
+INTREG_USR(unsigned index)
+{
+    assert(index < NUM_ARCH_INTREGS);
+    return IntRegUsrMap[index];
+}
+
+const IntRegMap IntRegSvcMap = {
+    INTREG_R0_SVC,  INTREG_R1_SVC,  INTREG_R2_SVC,  INTREG_R3_SVC,
+    INTREG_R4_SVC,  INTREG_R5_SVC,  INTREG_R6_SVC,  INTREG_R7_SVC,
+    INTREG_R8_SVC,  INTREG_R9_SVC,  INTREG_R10_SVC, INTREG_R11_SVC,
+    INTREG_R12_SVC, INTREG_R13_SVC, INTREG_R14_SVC, INTREG_R15_SVC
+};
+
+static inline IntRegIndex
+INTREG_SVC(unsigned index)
+{
+    assert(index < NUM_ARCH_INTREGS);
+    return IntRegSvcMap[index];
+}
+
+const IntRegMap IntRegMonMap = {
+    INTREG_R0_MON,  INTREG_R1_MON,  INTREG_R2_MON,  INTREG_R3_MON,
+    INTREG_R4_MON,  INTREG_R5_MON,  INTREG_R6_MON,  INTREG_R7_MON,
+    INTREG_R8_MON,  INTREG_R9_MON,  INTREG_R10_MON, INTREG_R11_MON,
+    INTREG_R12_MON, INTREG_R13_MON, INTREG_R14_MON, INTREG_R15_MON
+};
+
+static inline IntRegIndex
+INTREG_MON(unsigned index)
+{
+    assert(index < NUM_ARCH_INTREGS);
+    return IntRegMonMap[index];
+}
+
+const IntRegMap IntRegAbtMap = {
+    INTREG_R0_ABT,  INTREG_R1_ABT,  INTREG_R2_ABT,  INTREG_R3_ABT,
+    INTREG_R4_ABT,  INTREG_R5_ABT,  INTREG_R6_ABT,  INTREG_R7_ABT,
+    INTREG_R8_ABT,  INTREG_R9_ABT,  INTREG_R10_ABT, INTREG_R11_ABT,
+    INTREG_R12_ABT, INTREG_R13_ABT, INTREG_R14_ABT, INTREG_R15_ABT
+};
+
+static inline IntRegIndex
+INTREG_ABT(unsigned index)
+{
+    assert(index < NUM_ARCH_INTREGS);
+    return IntRegAbtMap[index];
+}
+
+const IntRegMap IntRegUndMap = {
+    INTREG_R0_UND,  INTREG_R1_UND,  INTREG_R2_UND,  INTREG_R3_UND,
+    INTREG_R4_UND,  INTREG_R5_UND,  INTREG_R6_UND,  INTREG_R7_UND,
+    INTREG_R8_UND,  INTREG_R9_UND,  INTREG_R10_UND, INTREG_R11_UND,
+    INTREG_R12_UND, INTREG_R13_UND, INTREG_R14_UND, INTREG_R15_UND
+};
+
+static inline IntRegIndex
+INTREG_UND(unsigned index)
+{
+    assert(index < NUM_ARCH_INTREGS);
+    return IntRegUndMap[index];
+}
+
+const IntRegMap IntRegIrqMap = {
+    INTREG_R0_IRQ,  INTREG_R1_IRQ,  INTREG_R2_IRQ,  INTREG_R3_IRQ,
+    INTREG_R4_IRQ,  INTREG_R5_IRQ,  INTREG_R6_IRQ,  INTREG_R7_IRQ,
+    INTREG_R8_IRQ,  INTREG_R9_IRQ,  INTREG_R10_IRQ, INTREG_R11_IRQ,
+    INTREG_R12_IRQ, INTREG_R13_IRQ, INTREG_R14_IRQ, INTREG_R15_IRQ
+};
+
+static inline IntRegIndex
+INTREG_IRQ(unsigned index)
+{
+    assert(index < NUM_ARCH_INTREGS);
+    return IntRegIrqMap[index];
+}
+
+const IntRegMap IntRegFiqMap = {
+    INTREG_R0_FIQ,  INTREG_R1_FIQ,  INTREG_R2_FIQ,  INTREG_R3_FIQ,
+    INTREG_R4_FIQ,  INTREG_R5_FIQ,  INTREG_R6_FIQ,  INTREG_R7_FIQ,
+    INTREG_R8_FIQ,  INTREG_R9_FIQ,  INTREG_R10_FIQ, INTREG_R11_FIQ,
+    INTREG_R12_FIQ, INTREG_R13_FIQ, INTREG_R14_FIQ, INTREG_R15_FIQ
+};
+
+static inline IntRegIndex
+INTREG_FIQ(unsigned index)
+{
+    assert(index < NUM_ARCH_INTREGS);
+    return IntRegFiqMap[index];
+}
+
+}
+
+#endif
diff --git a/src/arch/arm/isa/formats/macromem.isa b/src/arch/arm/isa/formats/macromem.isa
index 355a67ea9..d978967ac 100644
--- a/src/arch/arm/isa/formats/macromem.isa
+++ b/src/arch/arm/isa/formats/macromem.isa
@@ -213,9 +213,9 @@ inline %(class_name)s::%(class_name)s(ExtMachInst machInst)
             break;
     }
 
-    // Add 0 to Rn and stick it in Raddr (register 17).
+    // Add 0 to Rn and stick it in ureg0.
     // This is equivalent to a move.
-    microOps[0] = new MicroAddiUop(machInst, 17, RN, 0);
+    microOps[0] = new MicroAddiUop(machInst, INTREG_UREG0, RN, 0);
 
     unsigned j = 0;
     for (int i = 1; i < ones+1; i++) {
@@ -225,9 +225,11 @@ inline %(class_name)s::%(class_name)s(ExtMachInst machInst)
         regs_to_handle &= ~(1<<j);
 
         if (loadop)
-            microOps[i] = new MicroLdrUop(machInst, j, 17, start_addr);
+            microOps[i] = new MicroLdrUop(machInst, j,
+                    INTREG_UREG0, start_addr);
         else
-            microOps[i] = new MicroStrUop(machInst, j, 17, start_addr);
+            microOps[i] = new MicroStrUop(machInst, j,
+                    INTREG_UREG0, start_addr);
 
         if (up)
             start_addr += 4;
diff --git a/src/arch/arm/registers.hh b/src/arch/arm/registers.hh
index 07af32c1e..04fd00f3a 100644
--- a/src/arch/arm/registers.hh
+++ b/src/arch/arm/registers.hh
@@ -32,6 +32,7 @@
 #define __ARCH_ARM_REGISTERS_HH__
 
 #include "arch/arm/max_inst_regs.hh"
+#include "arch/arm/intregs.hh"
 #include "arch/arm/miscregs.hh"
 
 namespace ArmISA {
@@ -51,13 +52,12 @@ typedef float FloatReg;
 typedef uint64_t MiscReg;
 
 // Constants Related to the number of registers
-const int NumIntArchRegs = 16;
-const int NumIntSpecialRegs = 19;
+const int NumIntArchRegs = NUM_ARCH_INTREGS;
 const int NumFloatArchRegs = 16;
 const int NumFloatSpecialRegs = 5;
 const int NumInternalProcRegs = 0;
 
-const int NumIntRegs = NumIntArchRegs + NumIntSpecialRegs;
+const int NumIntRegs = NUM_INTREGS;
 const int NumFloatRegs = NumFloatArchRegs + NumFloatSpecialRegs;
 
 const int NumMiscRegs = NUM_MISCREGS;
@@ -72,11 +72,11 @@ const int ArgumentReg1 = 1;
 const int ArgumentReg2 = 2;
 const int ArgumentReg3 = 3;
 const int FramePointerReg = 11;
-const int StackPointerReg = 13;
-const int ReturnAddressReg = 14;
-const int PCReg = 15;
+const int StackPointerReg = INTREG_SP;
+const int ReturnAddressReg = INTREG_LR;
+const int PCReg = INTREG_PC;
 
-const int ZeroReg = NumIntArchRegs;
+const int ZeroReg = INTREG_ZERO;
 
 const int SyscallNumReg = ReturnValueReg;
 const int SyscallPseudoReturnReg = ReturnValueReg;