sim/arm/armemu.h

   1 /*  armemu.h -- ARMulator emulation macros:  ARM6 Instruction Emulator.
   2     Copyright (C) 1994 Advanced RISC Machines Ltd.
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
  17
  18 extern ARMword isize;
  19
  20 /***************************************************************************\
  21 *                           Condition code values                           *
  22 \***************************************************************************/
  23
  24 #define EQ 0
  25 #define NE 1
  26 #define CS 2
  27 #define CC 3
  28 #define MI 4
  29 #define PL 5
  30 #define VS 6
  31 #define VC 7
  32 #define HI 8
  33 #define LS 9
  34 #define GE 10
  35 #define LT 11
  36 #define GT 12
  37 #define LE 13
  38 #define AL 14
  39 #define NV 15
  40
  41 /***************************************************************************\
  42 *                               Shift Opcodes                               *
  43 \***************************************************************************/
  44
  45 #define LSL 0
  46 #define LSR 1
  47 #define ASR 2
  48 #define ROR 3
  49
  50 /***************************************************************************\
  51 *               Macros to twiddle the status flags and mode                 *
  52 \***************************************************************************/
  53
  54 #define NBIT ((unsigned)1L << 31)
  55 #define ZBIT (1L << 30)
  56 #define CBIT (1L << 29)
  57 #define VBIT (1L << 28)
  58 #define IBIT (1L << 7)
  59 #define FBIT (1L << 6)
  60 #define IFBITS (3L << 6)
  61 #define R15IBIT (1L << 27)
  62 #define R15FBIT (1L << 26)
  63 #define R15IFBITS (3L << 26)
  64
  65 #define POS(i) ( (~(i)) >> 31 )
  66 #define NEG(i) ( (i) >> 31 )
  67
  68 #ifdef MODET                    /* Thumb support */
  69 /* ??? This bit is actually in the low order bit of the PC in the hardware.
  70    It isn't clear if the simulator needs to model that or not.  */
  71 #define TBIT (1L << 5)
  72 #define TFLAG state->TFlag
  73 #define SETT state->TFlag = 1
  74 #define CLEART state->TFlag = 0
  75 #define ASSIGNT(res) state->TFlag = res
  76 #define INSN_SIZE (TFLAG ? 2 : 4)
  77 #else
  78 #define INSN_SIZE 4
  79 #endif
  80
  81 #define NFLAG state->NFlag
  82 #define SETN state->NFlag = 1
  83 #define CLEARN state->NFlag = 0
  84 #define ASSIGNN(res) state->NFlag = res
  85
  86 #define ZFLAG state->ZFlag
  87 #define SETZ state->ZFlag = 1
  88 #define CLEARZ state->ZFlag = 0
  89 #define ASSIGNZ(res) state->ZFlag = res
  90
  91 #define CFLAG state->CFlag
  92 #define SETC state->CFlag = 1
  93 #define CLEARC state->CFlag = 0
  94 #define ASSIGNC(res) state->CFlag = res
  95
  96 #define VFLAG state->VFlag
  97 #define SETV state->VFlag = 1
  98 #define CLEARV state->VFlag = 0
  99 #define ASSIGNV(res) state->VFlag = res
 100
 101
 102 #define IFLAG (state->IFFlags >> 1)
 103 #define FFLAG (state->IFFlags & 1)
 104 #define IFFLAGS state->IFFlags
 105 #define ASSIGNINT(res) state->IFFlags = (((res) >> 6) & 3)
 106 #define ASSIGNR15INT(res) state->IFFlags = (((res) >> 26) & 3) ;
 107
 108 #define PSR_FBITS (0xff000000L)
 109 #define PSR_SBITS (0x00ff0000L)
 110 #define PSR_XBITS (0x0000ff00L)
 111 #define PSR_CBITS (0x000000ffL)
 112
 113 #define CCBITS (0xf0000000L)
 114 #define INTBITS (0xc0L)
 115
 116 #if defined MODET && defined MODE32
 117 #define PCBITS (0xffffffffL)
 118 #else
 119 #define PCBITS (0xfffffffcL)
 120 #endif
 121
 122 #define MODEBITS (0x1fL)
 123 #define R15INTBITS (3L << 26)
 124
 125 #if defined MODET && defined MODE32
 126 #define R15PCBITS (0x03ffffffL)
 127 #else
 128 #define R15PCBITS (0x03fffffcL)
 129 #endif
 130
 131 #define R15PCMODEBITS (0x03ffffffL)
 132 #define R15MODEBITS (0x3L)
 133
 134 #ifdef MODE32
 135 #define PCMASK PCBITS
 136 #define PCWRAP(pc) (pc)
 137 #else
 138 #define PCMASK R15PCBITS
 139 #define PCWRAP(pc) ((pc) & R15PCBITS)
 140 #endif
 141
 142 #define PC (state->Reg[15] & PCMASK)
 143 #define R15CCINTMODE (state->Reg[15] & (CCBITS | R15INTBITS | R15MODEBITS))
 144 #define R15INT (state->Reg[15] & R15INTBITS)
 145 #define R15INTPC (state->Reg[15] & (R15INTBITS | R15PCBITS))
 146 #define R15INTPCMODE (state->Reg[15] & (R15INTBITS | R15PCBITS | R15MODEBITS))
 147 #define R15INTMODE (state->Reg[15] & (R15INTBITS | R15MODEBITS))
 148 #define R15PC (state->Reg[15] & R15PCBITS)
 149 #define R15PCMODE (state->Reg[15] & (R15PCBITS | R15MODEBITS))
 150 #define R15MODE (state->Reg[15] & R15MODEBITS)
 151
 152 #define ECC ((NFLAG << 31) | (ZFLAG << 30) | (CFLAG << 29) | (VFLAG << 28))
 153 #define EINT (IFFLAGS << 6)
 154 #define ER15INT (IFFLAGS << 26)
 155 #define EMODE (state->Mode)
 156
 157 #ifdef MODET
 158 #define CPSR (ECC | EINT | EMODE | (TFLAG << 5))
 159 #else
 160 #define CPSR (ECC | EINT | EMODE)
 161 #endif
 162
 163 #ifdef MODE32
 164 #define PATCHR15
 165 #else
 166 #define PATCHR15 state->Reg[15] = ECC | ER15INT | EMODE | R15PC
 167 #endif
 168
 169 #define GETSPSR(bank) (ARMul_GetSPSR (state, EMODE))
 170 #define SETPSR_F(d,s) d = ((d) & ~PSR_FBITS) | ((s) & PSR_FBITS)
 171 #define SETPSR_S(d,s) d = ((d) & ~PSR_SBITS) | ((s) & PSR_SBITS)
 172 #define SETPSR_X(d,s) d = ((d) & ~PSR_XBITS) | ((s) & PSR_XBITS)
 173 #define SETPSR_C(d,s) d = ((d) & ~PSR_CBITS) | ((s) & PSR_CBITS)
 174 #define SETR15PSR(s) if (state->Mode == USER26MODE) { \
 175                         state->Reg[15] = ((s) & CCBITS) | R15PC | ER15INT | EMODE ; \
 176                         ASSIGNN((state->Reg[15] & NBIT) != 0) ; \
 177                         ASSIGNZ((state->Reg[15] & ZBIT) != 0) ; \
 178                         ASSIGNC((state->Reg[15] & CBIT) != 0) ; \
 179                         ASSIGNV((state->Reg[15] & VBIT) != 0) ; \
 180                         } \
 181                      else { \
 182                         state->Reg[15] = R15PC | ((s) & (CCBITS | R15INTBITS | R15MODEBITS)) ; \
 183                         ARMul_R15Altered (state) ; \
 184                         }
 185 #define SETABORT(i,m,d) do { \
 186   int SETABORT_mode = (m); \
 187   ARMul_SetSPSR (state, SETABORT_mode, ARMul_GetCPSR (state)); \
 188   ARMul_SetCPSR (state, ((ARMul_GetCPSR (state) & ~(EMODE | TBIT)) \
 189                          | (i) | SETABORT_mode)); \
 190   state->Reg[14] = temp - (d); \
 191 } while (0)
 192
 193 #ifndef MODE32
 194 #define VECTORS 0x20
 195 #define LEGALADDR 0x03ffffff
 196 #define VECTORACCESS(address) (address < VECTORS && ARMul_MODE26BIT && state->prog32Sig)
 197 #define ADDREXCEPT(address) (address > LEGALADDR && !state->data32Sig)
 198 #endif
 199
 200 #define INTERNALABORT(address) if (address < VECTORS) \
 201                                   state->Aborted = ARMul_DataAbortV ; \
 202                                else \
 203                                   state->Aborted = ARMul_AddrExceptnV ;
 204
 205 #ifdef MODE32
 206 #define TAKEABORT ARMul_Abort(state,ARMul_DataAbortV)
 207 #else
 208 #define TAKEABORT if (state->Aborted == ARMul_AddrExceptnV) \
 209                      ARMul_Abort(state,ARMul_AddrExceptnV) ; \
 210                   else \
 211                      ARMul_Abort(state,ARMul_DataAbortV)
 212 #endif
 213 #define CPTAKEABORT if (!state->Aborted) \
 214                        ARMul_Abort(state,ARMul_UndefinedInstrV) ; \
 215                     else if (state->Aborted == ARMul_AddrExceptnV) \
 216                        ARMul_Abort(state,ARMul_AddrExceptnV) ; \
 217                     else \
 218                        ARMul_Abort(state,ARMul_DataAbortV)
 219
 220
 221 /***************************************************************************\
 222 *               Different ways to start the next instruction                *
 223 \***************************************************************************/
 224
 225 #define SEQ 0
 226 #define NONSEQ 1
 227 #define PCINCEDSEQ 2
 228 #define PCINCEDNONSEQ 3
 229 #define PRIMEPIPE 4
 230 #define RESUME 8
 231
 232 #define NORMALCYCLE state->NextInstr = 0
 233 #define BUSUSEDN state->NextInstr |= 1  /* the next fetch will be an N cycle */
 234 #define BUSUSEDINCPCS state->Reg[15] += isize ; /* a standard PC inc and an S cycle */ \
 235                       state->NextInstr = (state->NextInstr & 0xff) | 2
 236 #define BUSUSEDINCPCN state->Reg[15] += isize ; /* a standard PC inc and an N cycle */ \
 237                       state->NextInstr |= 3
 238 #define INCPC state->Reg[15] += isize ; /* a standard PC inc */ \
 239               state->NextInstr |= 2
 240 #define FLUSHPIPE state->NextInstr |= PRIMEPIPE
 241
 242 /***************************************************************************\
 243 *                          Cycle based emulation                            *
 244 \***************************************************************************/
 245
 246 #define OUTPUTCP(i,a,b)
 247 #define NCYCLE
 248 #define SCYCLE
 249 #define ICYCLE
 250 #define CCYCLE
 251 #define NEXTCYCLE(c)
 252
 253 /***************************************************************************\
 254 *                 States of the cycle based state machine                   *
 255 \***************************************************************************/
 256
 257
 258 /***************************************************************************\
 259 *                 Macros to extract parts of instructions                   *
 260 \***************************************************************************/
 261
 262 #define DESTReg (BITS(12,15))
 263 #define LHSReg (BITS(16,19))
 264 #define RHSReg (BITS(0,3))
 265
 266 #define DEST (state->Reg[DESTReg])
 267
 268 #ifdef MODE32
 269 #ifdef MODET
 270 #define LHS ((LHSReg == 15) ? (state->Reg[15] & 0xFFFFFFFC): (state->Reg[LHSReg]))
 271 #else
 272 #define LHS (state->Reg[LHSReg])
 273 #endif
 274 #else
 275 #define LHS ((LHSReg == 15) ? R15PC : (state->Reg[LHSReg]) )
 276 #endif
 277
 278 #define MULDESTReg (BITS(16,19))
 279 #define MULLHSReg (BITS(0,3))
 280 #define MULRHSReg (BITS(8,11))
 281 #define MULACCReg (BITS(12,15))
 282
 283 #define DPImmRHS (ARMul_ImmedTable[BITS(0,11)])
 284 #define DPSImmRHS temp = BITS(0,11) ; \
 285                   rhs = ARMul_ImmedTable[temp] ; \
 286                   if (temp > 255) /* there was a shift */ \
 287                      ASSIGNC(rhs >> 31) ;
 288
 289 #ifdef MODE32
 290 #define DPRegRHS ((BITS(4,11)==0) ? state->Reg[RHSReg] \
 291                                   : GetDPRegRHS(state, instr))
 292 #define DPSRegRHS ((BITS(4,11)==0) ? state->Reg[RHSReg] \
 293                                    : GetDPSRegRHS(state, instr))
 294 #else
 295 #define DPRegRHS ((BITS(0,11)<15) ? state->Reg[RHSReg] \
 296                                   : GetDPRegRHS(state, instr))
 297 #define DPSRegRHS ((BITS(0,11)<15) ? state->Reg[RHSReg] \
 298                                    : GetDPSRegRHS(state, instr))
 299 #endif
 300
 301 #define LSBase state->Reg[LHSReg]
 302 #define LSImmRHS (BITS(0,11))
 303
 304 #ifdef MODE32
 305 #define LSRegRHS ((BITS(4,11)==0) ? state->Reg[RHSReg] \
 306                                   : GetLSRegRHS(state, instr))
 307 #else
 308 #define LSRegRHS ((BITS(0,11)<15) ? state->Reg[RHSReg] \
 309                                   : GetLSRegRHS(state, instr))
 310 #endif
 311
 312 #define LSMNumRegs ((ARMword)ARMul_BitList[BITS(0,7)] + \
 313                     (ARMword)ARMul_BitList[BITS(8,15)] )
 314 #define LSMBaseFirst ((LHSReg == 0 && BIT(0)) || \
 315                       (BIT(LHSReg) && BITS(0,LHSReg-1) == 0))
 316
 317 #define SWAPSRC (state->Reg[RHSReg])
 318
 319 #define LSCOff (BITS(0,7) << 2)
 320 #define CPNum BITS(8,11)
 321
 322 /***************************************************************************\
 323 *                    Macro to rotate n right by b bits                      *
 324 \***************************************************************************/
 325
 326 #define ROTATER(n,b) (((n)>>(b))|((n)<<(32-(b))))
 327
 328 /***************************************************************************\
 329 *                 Macros to store results of instructions                   *
 330 \***************************************************************************/
 331
 332 #define WRITEDEST(d) if (DESTReg==15) \
 333                         WriteR15(state, d) ; \
 334                      else \
 335                           DEST = d
 336
 337 #define WRITESDEST(d) if (DESTReg == 15) \
 338                          WriteSR15(state, d) ; \
 339                       else { \
 340                          DEST = d ; \
 341                          ARMul_NegZero(state, d) ; \
 342                          }
 343
 344 #define WRITEDESTB(d) if (DESTReg == 15) \
 345                         WriteR15Branch(state, d) ; \
 346                      else \
 347                           DEST = d
 348
 349 #define BYTETOBUS(data) ((data & 0xff) | \
 350                         ((data & 0xff) << 8) | \
 351                         ((data & 0xff) << 16) | \
 352                         ((data & 0xff) << 24))
 353 #define BUSTOBYTE(address,data) \
 354            if (state->bigendSig) \
 355               temp = (data >> (((address ^ 3) & 3) << 3)) & 0xff ; \
 356            else \
 357               temp = (data >> ((address & 3) << 3)) & 0xff
 358
 359 #define LOADMULT(instr,address,wb) LoadMult(state,instr,address,wb)
 360 #define LOADSMULT(instr,address,wb) LoadSMult(state,instr,address,wb)
 361 #define STOREMULT(instr,address,wb) StoreMult(state,instr,address,wb)
 362 #define STORESMULT(instr,address,wb) StoreSMult(state,instr,address,wb)
 363
 364 #define POSBRANCH ((instr & 0x7fffff) << 2)
 365 #define NEGBRANCH (0xfc000000 | ((instr & 0xffffff) << 2))
 366
 367 /***************************************************************************\
 368 *                          Values for Emulate                               *
 369 \***************************************************************************/
 370
 371 #define STOP            0       /* stop */
 372 #define CHANGEMODE      1       /* change mode */
 373 #define ONCE            2       /* execute just one interation */
 374 #define RUN             3       /* continuous execution */
 375
 376 /***************************************************************************\
 377 *                      Stuff that is shared across modes                    *
 378 \***************************************************************************/
 379
 380 extern ARMword ARMul_Emulate26 (ARMul_State * state);
 381 extern ARMword ARMul_Emulate32 (ARMul_State * state);
 382 extern unsigned ARMul_MultTable[];      /* Number of I cycles for a mult */
 383 extern ARMword ARMul_ImmedTable[];      /* immediate DP LHS values */
 384 extern char ARMul_BitList[];    /* number of bits in a byte table */
 385 extern void ARMul_Abort26 (ARMul_State * state, ARMword);
 386 extern void ARMul_Abort32 (ARMul_State * state, ARMword);
 387 extern unsigned ARMul_NthReg (ARMword instr, unsigned number);
 388 extern void ARMul_MSRCpsr (ARMul_State * state, ARMword instr, ARMword rhs);
 389 extern void ARMul_NegZero (ARMul_State * state, ARMword result);
 390 extern void ARMul_AddCarry (ARMul_State * state, ARMword a, ARMword b,
 391                             ARMword result);
 392 extern int AddOverflow (ARMword a, ARMword b, ARMword result);
 393 extern int SubOverflow (ARMword a, ARMword b, ARMword result);
 394 extern void ARMul_AddOverflow (ARMul_State * state, ARMword a, ARMword b,
 395                                ARMword result);
 396 extern void ARMul_SubCarry (ARMul_State * state, ARMword a, ARMword b,
 397                             ARMword result);
 398 extern void ARMul_SubOverflow (ARMul_State * state, ARMword a, ARMword b,
 399                                ARMword result);
 400 extern void ARMul_CPSRAltered (ARMul_State * state);
 401 extern void ARMul_R15Altered (ARMul_State * state);
 402 extern ARMword ARMul_SwitchMode (ARMul_State * state, ARMword oldmode,
 403                                  ARMword newmode);
 404 extern unsigned ARMul_NthReg (ARMword instr, unsigned number);
 405 extern void ARMul_LDC (ARMul_State * state, ARMword instr, ARMword address);
 406 extern void ARMul_STC (ARMul_State * state, ARMword instr, ARMword address);
 407 extern void ARMul_MCR (ARMul_State * state, ARMword instr, ARMword source);
 408 extern ARMword ARMul_MRC (ARMul_State * state, ARMword instr);
 409 extern void ARMul_CDP (ARMul_State * state, ARMword instr);
 410 extern unsigned IntPending (ARMul_State * state);
 411 extern ARMword ARMul_Align (ARMul_State * state, ARMword address,
 412                             ARMword data);
 413 #define EVENTLISTSIZE 1024L
 414
 415 /* Thumb support: */
 416
 417 typedef enum
 418 {
 419   t_undefined,                  /* undefined Thumb instruction */
 420   t_decoded,                    /* instruction decoded to ARM equivalent */
 421   t_branch                      /* Thumb branch (already processed) */
 422 }
 423 tdstate;
 424
 425 extern tdstate ARMul_ThumbDecode (ARMul_State * state, ARMword pc,
 426                                   ARMword tinstr, ARMword * ainstr);
 427
 428 /***************************************************************************\
 429 *                      Macros to scrutinize instructions                    *
 430 \***************************************************************************/
 431
 432
 433 #define UNDEF_Test
 434 #define UNDEF_Shift
 435 #define UNDEF_MSRPC
 436 #define UNDEF_MRSPC
 437 #define UNDEF_MULPCDest
 438 #define UNDEF_MULDestEQOp1
 439 #define UNDEF_LSRBPC
 440 #define UNDEF_LSRBaseEQOffWb
 441 #define UNDEF_LSRBaseEQDestWb
 442 #define UNDEF_LSRPCBaseWb
 443 #define UNDEF_LSRPCOffWb
 444 #define UNDEF_LSMNoRegs
 445 #define UNDEF_LSMPCBase
 446 #define UNDEF_LSMUserBankWb
 447 #define UNDEF_LSMBaseInListWb
 448 #define UNDEF_SWPPC
 449 #define UNDEF_CoProHS
 450 #define UNDEF_MCRPC
 451 #define UNDEF_LSCPCBaseWb
 452 #define UNDEF_UndefNotBounced
 453 #define UNDEF_ShortInt
 454 #define UNDEF_IllegalMode
 455 #define UNDEF_Prog32SigChange
 456 #define UNDEF_Data32SigChange