src/arch/mips/isa_traits.hh

   1 /*
   2  * Copyright (c) 2003-2005 The Regents of The University of Michigan
   3  * Copyright (c) 2007 MIPS Technologies, Inc.
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions are
   8  * met: redistributions of source code must retain the above copyright
   9  * notice, this list of conditions and the following disclaimer;
  10  * redistributions in binary form must reproduce the above copyright
  11  * notice, this list of conditions and the following disclaimer in the
  12  * documentation and/or other materials provided with the distribution;
  13  * neither the name of the copyright holders nor the names of its
  14  * contributors may be used to endorse or promote products derived from
  15  * this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  18  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  19  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  20  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  21  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  22  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  23  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  24  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  25  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  27  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28  *
  29  * Authors: Gabe Black
  30  *          Korey Sewell
  31  *          Jaidev Patwardhan
  32  */
  33
  34 #ifndef __ARCH_MIPS_ISA_TRAITS_HH__
  35 #define __ARCH_MIPS_ISA_TRAITS_HH__
  36
  37 #include "arch/mips/types.hh"
  38 #include "arch/mips/mips_core_specific.hh"
  39 #include "config/full_system.hh"
  40 #include "sim/host.hh"
  41
  42 namespace LittleEndianGuest {};
  43
  44 #define TARGET_MIPS
  45
  46 class StaticInstPtr;
  47
  48 namespace MipsISA
  49 {
  50     using namespace LittleEndianGuest;
  51
  52     StaticInstPtr decodeInst(ExtMachInst);
  53
  54     // MIPS DOES have a delay slot
  55     #define ISA_HAS_DELAY_SLOT 1
  56
  57     const Addr PageShift = 13;
  58     const Addr PageBytes = ULL(1) << PageShift;
  59     const Addr Page_Mask = ~(PageBytes - 1);
  60     const Addr PageOffset = PageBytes - 1;
  61
  62
  63     ////////////////////////////////////////////////////////////////////////
  64     //
  65     //  Translation stuff
  66     //
  67
  68     const Addr PteShift = 3;
  69     const Addr NPtePageShift = PageShift - PteShift;
  70     const Addr NPtePage = ULL(1) << NPtePageShift;
  71     const Addr PteMask = NPtePage - 1;
  72
  73     //// All 'Mapped' segments go through the TLB
  74     //// All other segments are translated by dropping the MSB, to give
  75     //// the corresponding physical address
  76     // User Segment - Mapped
  77     const Addr USegBase = ULL(0x0);
  78     const Addr USegEnd = ULL(0x7FFFFFFF);
  79
  80     // Kernel Segment 0 - Unmapped
  81     const Addr KSeg0End = ULL(0x9FFFFFFF);
  82     const Addr KSeg0Base =  ULL(0x80000000);
  83     const Addr KSeg0Mask = ULL(0x1FFFFFFF);
  84
  85     // Kernel Segment 1 - Unmapped, Uncached
  86     const Addr KSeg1End = ULL(0xBFFFFFFF);
  87     const Addr KSeg1Base = ULL(0xA0000000);
  88     const Addr KSeg1Mask = ULL(0x1FFFFFFF);
  89
  90     // Kernel/Supervisor Segment - Mapped
  91     const Addr KSSegEnd = ULL(0xDFFFFFFF);
  92     const Addr KSSegBase = ULL(0xC0000000);
  93
  94     // Kernel Segment 3 - Mapped
  95     const Addr KSeg3End = ULL(0xFFFFFFFF);
  96     const Addr KSeg3Base = ULL(0xE0000000);
  97
  98
  99     // For loading... XXX This maybe could be USegEnd?? --ali
 100     const Addr LoadAddrMask = ULL(0xffffffffff);
 101
 102     inline Addr Phys2K0Seg(Addr addr)
 103     {
 104    //  if (addr & PAddrUncachedBit43) {
 105 //         addr &= PAddrUncachedMask;
 106 //         addr |= PAddrUncachedBit40;
 107 //     }
 108         return addr | KSeg0Base;
 109     }
 110
 111
 112     const unsigned VABits = 32;
 113     const unsigned PABits = 32; // Is this correct?
 114     const Addr VAddrImplMask = (ULL(1) << VABits) - 1;
 115     const Addr VAddrUnImplMask = ~VAddrImplMask;
 116     inline Addr VAddrImpl(Addr a) { return a & VAddrImplMask; }
 117     inline Addr VAddrVPN(Addr a) { return a >> MipsISA::PageShift; }
 118     inline Addr VAddrOffset(Addr a) { return a & MipsISA::PageOffset; }
 119
 120     const Addr PAddrImplMask = (ULL(1) << PABits) - 1;
 121
 122     ////////////////////////////////////////////////////////////////////////
 123     //
 124     //  Interrupt levels
 125     //
 126     enum InterruptLevels
 127     {
 128         INTLEVEL_SOFTWARE_MIN = 4,
 129         INTLEVEL_SOFTWARE_MAX = 19,
 130
 131         INTLEVEL_EXTERNAL_MIN = 20,
 132         INTLEVEL_EXTERNAL_MAX = 34,
 133
 134         INTLEVEL_IRQ0 = 20,
 135         INTLEVEL_IRQ1 = 21,
 136         INTINDEX_ETHERNET = 0,
 137         INTINDEX_SCSI = 1,
 138         INTLEVEL_IRQ2 = 22,
 139         INTLEVEL_IRQ3 = 23,
 140
 141         INTLEVEL_SERIAL = 33,
 142
 143         NumInterruptLevels = INTLEVEL_EXTERNAL_MAX
 144     };
 145
 146
 147     // MIPS modes
 148     enum mode_type
 149     {
 150         mode_kernel = 0,        // kernel
 151         mode_supervisor = 1,    // supervisor
 152         mode_user = 2,          // user mode
 153         mode_debug = 3,         // debug mode
 154         mode_number             // number of modes
 155     };
 156
 157   inline mode_type getOperatingMode(MiscReg Stat)
 158   {
 159     if((Stat & 0x10000006) != 0 || (Stat & 0x18) ==0)
 160       return mode_kernel;
 161     else{
 162       if((Stat & 0x18) == 0x8)
 163         return mode_supervisor;
 164       else if((Stat & 0x18) == 0x10)
 165         return mode_user;
 166       else return mode_number;
 167     }
 168   }
 169
 170
 171     // return a no-op instruction... used for instruction fetch faults
 172     const ExtMachInst NoopMachInst = 0x00000000;
 173
 174     // Constants Related to the number of registers
 175     const int NumIntArchRegs = 32;
 176     const int NumIntSpecialRegs = 9;
 177     const int NumFloatArchRegs = 32;
 178     const int NumFloatSpecialRegs = 5;
 179
 180     const int NumShadowRegSets = 16; // Maximum number of shadow register sets
 181     const int NumIntRegs = NumIntArchRegs*NumShadowRegSets + NumIntSpecialRegs;        //HI & LO Regs
 182     const int NumFloatRegs = NumFloatArchRegs + NumFloatSpecialRegs;//
 183
 184     const int TotalArchRegs = NumIntArchRegs * NumShadowRegSets;
 185
 186     // Static instruction parameters
 187     const int MaxInstSrcRegs = 10;
 188     const int MaxInstDestRegs = 8;
 189
 190     // semantically meaningful register indices
 191     const int ZeroReg = 0;
 192     const int AssemblerReg = 1;
 193     const int KernelReg0 = 26;
 194     const int KernelReg1 = 27;
 195     const int GlobalPointerReg = 28;
 196     const int StackPointerReg = 29;
 197     const int FramePointerReg = 30;
 198     const int ReturnAddressReg = 31;
 199
 200     const int SyscallPseudoReturnReg = 3;
 201
 202     const int LogVMPageSize = 13;       // 8K bytes
 203     const int VMPageSize = (1 << LogVMPageSize);
 204
 205     const int BranchPredAddrShiftAmt = 2; // instructions are 4-byte aligned
 206
 207     const int MachineBytes = 4;
 208     const int WordBytes = 4;
 209     const int HalfwordBytes = 2;
 210     const int ByteBytes = 1;
 211
 212     const int ANNOTE_NONE = 0;
 213     const uint32_t ITOUCH_ANNOTE = 0xffffffff;
 214
 215     // These help enumerate all the registers for dependence tracking.
 216     const int FP_Base_DepTag = NumIntRegs;
 217     const int Ctrl_Base_DepTag = FP_Base_DepTag + NumFloatRegs;
 218
 219     // Enumerate names for 'Control' Registers in the CPU
 220     // Reference MIPS32 Arch. for Programmers, Vol. III, Ch.8
 221     // (Register Number-Register Select) Summary of Register
 222     //------------------------------------------------------
 223     // The first set of names classify the CP0 names as Register Banks
 224     // for easy indexing when using the 'RD + SEL' index combination
 225     // in CP0 instructions.
 226     enum MiscRegTags {
 227         Index = Ctrl_Base_DepTag + 0,       //Bank 0: 0 - 3
 228         MVPControl,
 229         MVPConf0,
 230         MVPConf1,
 231
 232         CP0_Random = Ctrl_Base_DepTag + 8,      //Bank 1: 8 - 15
 233         VPEControl,
 234         VPEConf0,
 235         VPEConf1,
 236         YQMask,
 237         VPESchedule,
 238         VPEScheFBack,
 239         VPEOpt,
 240
 241         EntryLo0 = Ctrl_Base_DepTag + 16,   //Bank 2: 16 - 23
 242         TCStatus,
 243         TCBind,
 244         TCRestart,
 245         TCHalt,
 246         TCContext,
 247         TCSchedule,
 248         TCScheFBack,
 249
 250         EntryLo1 = Ctrl_Base_DepTag + 24,   // Bank 3: 24
 251
 252         Context = Ctrl_Base_DepTag + 32,    // Bank 4: 32 - 33
 253         ContextConfig,
 254
 255         PageMask = Ctrl_Base_DepTag + 40, //Bank 5: 40 - 41
 256         PageGrain = Ctrl_Base_DepTag + 41,
 257
 258         Wired = Ctrl_Base_DepTag + 48,          //Bank 6:48-55
 259         SRSConf0,
 260         SRSConf1,
 261         SRSConf2,
 262         SRSConf3,
 263         SRSConf4,
 264
 265         HWRena = Ctrl_Base_DepTag + 56,         //Bank 7: 56-63
 266
 267         BadVAddr = Ctrl_Base_DepTag + 64,       //Bank 8: 64-71
 268
 269         Count = Ctrl_Base_DepTag + 72,          //Bank 9: 72-79
 270
 271         EntryHi = Ctrl_Base_DepTag + 80,        //Bank 10: 80-87
 272
 273         Compare = Ctrl_Base_DepTag + 88,        //Bank 11: 88-95
 274
 275         Status = Ctrl_Base_DepTag + 96,         //Bank 12: 96-103
 276         IntCtl,
 277         SRSCtl,
 278         SRSMap,
 279
 280         Cause = Ctrl_Base_DepTag + 104,         //Bank 13: 104-111
 281
 282         EPC = Ctrl_Base_DepTag + 112,           //Bank 14: 112-119
 283
 284         PRId = Ctrl_Base_DepTag + 120,          //Bank 15: 120-127,
 285         EBase,
 286
 287         Config = Ctrl_Base_DepTag + 128,        //Bank 16: 128-135
 288         Config1,
 289         Config2,
 290         Config3,
 291         Config4,
 292         Config5,
 293         Config6,
 294         Config7,
 295
 296
 297         LLAddr = Ctrl_Base_DepTag + 136,        //Bank 17: 136-143
 298
 299         WatchLo0 = Ctrl_Base_DepTag + 144,      //Bank 18: 144-151
 300         WatchLo1,
 301         WatchLo2,
 302         WatchLo3,
 303         WatchLo4,
 304         WatchLo5,
 305         WatchLo6,
 306         WatchLo7,
 307
 308         WatchHi0 = Ctrl_Base_DepTag + 152,     //Bank 19: 152-159
 309         WatchHi1,
 310         WatchHi2,
 311         WatchHi3,
 312         WatchHi4,
 313         WatchHi5,
 314         WatchHi6,
 315         WatchHi7,
 316
 317         XCContext64 = Ctrl_Base_DepTag + 160, //Bank 20: 160-167
 318
 319                            //Bank 21: 168-175
 320
 321                            //Bank 22: 176-183
 322
 323         Debug = Ctrl_Base_DepTag + 184,       //Bank 23: 184-191
 324         TraceControl1,
 325         TraceControl2,
 326         UserTraceData,
 327         TraceBPC,
 328
 329         DEPC = Ctrl_Base_DepTag + 192,        //Bank 24: 192-199
 330
 331         PerfCnt0 = Ctrl_Base_DepTag + 200,    //Bank 25: 200-207
 332         PerfCnt1,
 333         PerfCnt2,
 334         PerfCnt3,
 335         PerfCnt4,
 336         PerfCnt5,
 337         PerfCnt6,
 338         PerfCnt7,
 339
 340         ErrCtl = Ctrl_Base_DepTag + 208,      //Bank 26: 208-215
 341
 342         CacheErr0 = Ctrl_Base_DepTag + 216,   //Bank 27: 216-223
 343         CacheErr1,
 344         CacheErr2,
 345         CacheErr3,
 346
 347         TagLo0 = Ctrl_Base_DepTag + 224,      //Bank 28: 224-231
 348         DataLo1,
 349         TagLo2,
 350         DataLo3,
 351         TagLo4,
 352         DataLo5,
 353         TagLo6,
 354         DataLo7,
 355
 356         TagHi0 = Ctrl_Base_DepTag + 232,      //Bank 29: 232-239
 357         DataHi1,
 358         TagHi2,
 359         DataHi3,
 360         TagHi4,
 361         DataHi5,
 362         TagHi6,
 363         DataHi7,
 364
 365
 366         ErrorEPC = Ctrl_Base_DepTag + 240,    //Bank 30: 240-247
 367
 368         DESAVE = Ctrl_Base_DepTag + 248,       //Bank 31: 248-256
 369
 370         LLFlag = Ctrl_Base_DepTag + 257,
 371
 372         NumControlRegs
 373     };
 374
 375     const int TotalDataRegs = NumIntRegs + NumFloatRegs;
 376
 377     const int NumMiscRegs = NumControlRegs;
 378
 379     const int TotalNumRegs = NumIntRegs + NumFloatRegs + NumMiscRegs;
 380
 381
 382 };
 383
 384 using namespace MipsISA;
 385
 386 #endif // __ARCH_MIPS_ISA_TRAITS_HH__