sim/arm/armemu.h - binutils-gdb - Git at Google

 /*  armemu.h -- ARMulator emulation macros:  ARM6 Instruction Emulator.
     Copyright (C) 1994 Advanced RISC Machines Ltd.

     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     the Free Software Foundation; either version 3 of the License, or
     (at your option) any later version.

     This program is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.

     You should have received a copy of the GNU General Public License
     along with this program; if not, see <http://www.gnu.org/licenses/>. */

 extern ARMword isize;
 extern int trace;
 extern int disas;
 extern int trace_funcs;
 extern void print_insn (ARMword);

 /* Condition code values.  */
 #define EQ 0
 #define NE 1
 #define CS 2
 #define CC 3
 #define MI 4
 #define PL 5
 #define VS 6
 #define VC 7
 #define HI 8
 #define LS 9
 #define GE 10
 #define LT 11
 #define GT 12
 #define LE 13
 #define AL 14
 #define NV 15

 /* Shift Opcodes.  */
 #define LSL 0
 #define LSR 1
 #define ASR 2
 #define ROR 3

 /* Macros to twiddle the status flags and mode.  */
 #define NBIT ((unsigned)1L << 31)
 #define ZBIT (1L << 30)
 #define CBIT (1L << 29)
 #define VBIT (1L << 28)
 #define SBIT (1L << 27)
 #define GE0 (1L << 16)
 #define GE1 (1L << 17)
 #define GE2 (1L << 18)
 #define GE3 (1L << 19)
 #define IBIT (1L << 7)
 #define FBIT (1L << 6)
 #define IFBITS (3L << 6)
 #define R15IBIT (1L << 27)
 #define R15FBIT (1L << 26)
 #define R15IFBITS (3L << 26)

 #define POS(i) ( (~(i)) >> 31 )
 #define NEG(i) ( (i) >> 31 )

 #ifdef MODET			/* Thumb support.  */
 /* ??? This bit is actually in the low order bit of the PC in the hardware.
    It isn't clear if the simulator needs to model that or not.  */
 #define TBIT (1L << 5)
 #define TFLAG state->TFlag
 #define SETT state->TFlag = 1
 #define CLEART state->TFlag = 0
 #define ASSIGNT(res) state->TFlag = res
 #define INSN_SIZE (TFLAG ? 2 : 4)
 #else
 #define INSN_SIZE 4
 #endif

 #define NFLAG state->NFlag
 #define SETN state->NFlag = 1
 #define CLEARN state->NFlag = 0
 #define ASSIGNN(res) state->NFlag = res

 #define ZFLAG state->ZFlag
 #define SETZ state->ZFlag = 1
 #define CLEARZ state->ZFlag = 0
 #define ASSIGNZ(res) state->ZFlag = res

 #define CFLAG state->CFlag
 #define SETC state->CFlag = 1
 #define CLEARC state->CFlag = 0
 #define ASSIGNC(res) state->CFlag = res

 #define VFLAG state->VFlag
 #define SETV state->VFlag = 1
 #define CLEARV state->VFlag = 0
 #define ASSIGNV(res) state->VFlag = res

 #define SFLAG state->SFlag
 #define SETS state->SFlag = 1
 #define CLEARS state->SFlag = 0
 #define ASSIGNS(res) state->SFlag = res

 #define IFLAG (state->IFFlags >> 1)
 #define FFLAG (state->IFFlags & 1)
 #define IFFLAGS state->IFFlags
 #define ASSIGNINT(res) state->IFFlags = (((res) >> 6) & 3)
 #define ASSIGNR15INT(res) state->IFFlags = (((res) >> 26) & 3) ;

 #define PSR_FBITS (0xff000000L)
 #define PSR_SBITS (0x00ff0000L)
 #define PSR_XBITS (0x0000ff00L)
 #define PSR_CBITS (0x000000ffL)

 #if defined MODE32 || defined MODET
 #define CCBITS (0xf8000000L)
 #else
 #define CCBITS (0xf0000000L)
 #endif

 #define INTBITS (0xc0L)

 #if defined MODET && defined MODE32
 #define PCBITS (0xffffffffL)
 #else
 #define PCBITS (0xfffffffcL)
 #endif

 #define MODEBITS (0x1fL)
 #define R15INTBITS (3L << 26)

 #if defined MODET && defined MODE32
 #define R15PCBITS (0x03ffffffL)
 #else
 #define R15PCBITS (0x03fffffcL)
 #endif

 #define R15PCMODEBITS (0x03ffffffL)
 #define R15MODEBITS (0x3L)

 #ifdef MODE32
 #define PCMASK PCBITS
 #define PCWRAP(pc) (pc)
 #else
 #define PCMASK R15PCBITS
 #define PCWRAP(pc) ((pc) & R15PCBITS)
 #endif

 #define PC (state->Reg[15] & PCMASK)
 #define R15CCINTMODE (state->Reg[15] & (CCBITS | R15INTBITS | R15MODEBITS))
 #define R15INT (state->Reg[15] & R15INTBITS)
 #define R15INTPC (state->Reg[15] & (R15INTBITS | R15PCBITS))
 #define R15INTPCMODE (state->Reg[15] & (R15INTBITS | R15PCBITS | R15MODEBITS))
 #define R15INTMODE (state->Reg[15] & (R15INTBITS | R15MODEBITS))
 #define R15PC (state->Reg[15] & R15PCBITS)
 #define R15PCMODE (state->Reg[15] & (R15PCBITS | R15MODEBITS))
 #define R15MODE (state->Reg[15] & R15MODEBITS)

 #define ECC ((NFLAG << 31) | (ZFLAG << 30) | (CFLAG << 29) | (VFLAG << 28) | (SFLAG << 27))
 #define EINT (IFFLAGS << 6)
 #define ER15INT (IFFLAGS << 26)
 #define EMODE (state->Mode)

 #ifdef MODET
 #define CPSR (ECC | EINT | EMODE | (TFLAG << 5))
 #else
 #define CPSR (ECC | EINT | EMODE)
 #endif

 #ifdef MODE32
 #define PATCHR15
 #else
 #define PATCHR15 state->Reg[15] = ECC | ER15INT | EMODE | R15PC
 #endif

 #define GETSPSR(bank) (ARMul_GetSPSR (state, EMODE))
 #define SETPSR_F(d,s) d = ((d) & ~PSR_FBITS) | ((s) & PSR_FBITS)
 #define SETPSR_S(d,s) d = ((d) & ~PSR_SBITS) | ((s) & PSR_SBITS)
 #define SETPSR_X(d,s) d = ((d) & ~PSR_XBITS) | ((s) & PSR_XBITS)
 #define SETPSR_C(d,s) d = ((d) & ~PSR_CBITS) | ((s) & PSR_CBITS)

 #define SETR15PSR(s) 								\
   do										\
     {										\
       if (state->Mode == USER26MODE)						\
         {									\
           state->Reg[15] = ((s) & CCBITS) | R15PC | ER15INT | EMODE;		\
           ASSIGNN ((state->Reg[15] & NBIT) != 0);				\
           ASSIGNZ ((state->Reg[15] & ZBIT) != 0);				\
           ASSIGNC ((state->Reg[15] & CBIT) != 0);				\
           ASSIGNV ((state->Reg[15] & VBIT) != 0);				\
         }									\
       else									\
         {									\
           state->Reg[15] = R15PC | ((s) & (CCBITS | R15INTBITS | R15MODEBITS));	\
           ARMul_R15Altered (state);						\
        }									\
     }										\
   while (0)

 #define SETABORT(i, m, d)						\
   do									\
     { 									\
       int SETABORT_mode = (m);						\
 									\
       ARMul_SetSPSR (state, SETABORT_mode, ARMul_GetCPSR (state));	\
       ARMul_SetCPSR (state, ((ARMul_GetCPSR (state) & ~(EMODE | TBIT))	\
 			     | (i) | SETABORT_mode));			\
       state->Reg[14] = temp - (d);					\
     }									\
   while (0)

 #ifndef MODE32
 #define VECTORS 0x20
 #define LEGALADDR 0x03ffffff
 #define VECTORACCESS(address) (address < VECTORS && ARMul_MODE26BIT && state->prog32Sig)
 #define ADDREXCEPT(address)   (address > LEGALADDR && !state->data32Sig)
 #endif

 #define INTERNALABORT(address)			\
   do						\
     {						\
       if (address < VECTORS)			\
 	state->Aborted = ARMul_DataAbortV;	\
       else					\
 	state->Aborted = ARMul_AddrExceptnV;	\
     }						\
   while (0)

 #ifdef MODE32
 #define TAKEABORT ARMul_Abort (state, ARMul_DataAbortV)
 #else
 #define TAKEABORT 					\
   do							\
     {							\
       if (state->Aborted == ARMul_AddrExceptnV) 	\
 	ARMul_Abort (state, ARMul_AddrExceptnV); 	\
       else 						\
 	ARMul_Abort (state, ARMul_DataAbortV);		\
     }							\
   while (0)
 #endif

 #define CPTAKEABORT					\
   do							\
     {							\
       if (!state->Aborted)				\
 	ARMul_Abort (state, ARMul_UndefinedInstrV); 	\
       else if (state->Aborted == ARMul_AddrExceptnV) 	\
 	ARMul_Abort (state, ARMul_AddrExceptnV); 	\
       else 						\
 	ARMul_Abort (state, ARMul_DataAbortV);		\
     }							\
   while (0);


 /* Different ways to start the next instruction.  */
 #define SEQ           0
 #define NONSEQ        1
 #define PCINCEDSEQ    2
 #define PCINCEDNONSEQ 3
 #define PRIMEPIPE     4
 #define RESUME        8

 #define NORMALCYCLE state->NextInstr = 0
 #define BUSUSEDN    state->NextInstr |= 1  /* The next fetch will be an N cycle.  */
 #define BUSUSEDINCPCS						\
   do								\
     {								\
       if (! state->is_v4)					\
         {							\
 	  /* A standard PC inc and an S cycle.  */		\
 	  state->Reg[15] += isize;				\
 	  state->NextInstr = (state->NextInstr & 0xff) | 2;	\
 	}							\
     }								\
   while (0)

 #define BUSUSEDINCPCN					\
   do							\
     {							\
       if (state->is_v4)					\
 	BUSUSEDN;					\
       else						\
 	{						\
 	  /* A standard PC inc and an N cycle.  */	\
 	  state->Reg[15] += isize;			\
 	  state->NextInstr |= 3;			\
 	}						\
     }							\
   while (0)

 #define INCPC 			\
   do				\
     {				\
       /* A standard PC inc.  */	\
       state->Reg[15] += isize;	\
       state->NextInstr |= 2;	\
     }				\
   while (0)

 #define FLUSHPIPE state->NextInstr |= PRIMEPIPE

 /* Cycle based emulation.  */

 #define OUTPUTCP(i,a,b)
 #define NCYCLE
 #define SCYCLE
 #define ICYCLE
 #define CCYCLE
 #define NEXTCYCLE(c)

 /* Macros to extract parts of instructions.  */
 #define DESTReg (BITS (12, 15))
 #define LHSReg  (BITS (16, 19))
 #define RHSReg  (BITS ( 0,  3))

 #define DEST (state->Reg[DESTReg])

 #ifdef MODE32
 #ifdef MODET
 #define LHS ((LHSReg == 15) ? (state->Reg[15] & 0xFFFFFFFC): (state->Reg[LHSReg]))
 #else
 #define LHS (state->Reg[LHSReg])
 #endif
 #else
 #define LHS ((LHSReg == 15) ? R15PC : (state->Reg[LHSReg]))
 #endif

 #define MULDESTReg (BITS (16, 19))
 #define MULLHSReg  (BITS ( 0,  3))
 #define MULRHSReg  (BITS ( 8, 11))
 #define MULACCReg  (BITS (12, 15))

 #define DPImmRHS (ARMul_ImmedTable[BITS(0, 11)])
 #define DPSImmRHS temp = BITS(0,11) ; \
                   rhs = ARMul_ImmedTable[temp] ; \
                   if (temp > 255) /* There was a shift.  */ \
                      ASSIGNC (rhs >> 31) ;

 #ifdef MODE32
 #define DPRegRHS  ((BITS (4,11) == 0) ? state->Reg[RHSReg] \
                                       : GetDPRegRHS (state, instr))
 #define DPSRegRHS ((BITS (4,11) == 0) ? state->Reg[RHSReg] \
                                       : GetDPSRegRHS (state, instr))
 #else
 #define DPRegRHS  ((BITS (0, 11) < 15) ? state->Reg[RHSReg] \
                                        : GetDPRegRHS (state, instr))
 #define DPSRegRHS ((BITS (0, 11) < 15) ? state->Reg[RHSReg] \
                                        : GetDPSRegRHS (state, instr))
 #endif

 #define LSBase state->Reg[LHSReg]
 #define LSImmRHS (BITS(0,11))

 #ifdef MODE32
 #define LSRegRHS ((BITS (4, 11) == 0) ? state->Reg[RHSReg] \
                                       : GetLSRegRHS (state, instr))
 #else
 #define LSRegRHS ((BITS (0, 11) < 15) ? state->Reg[RHSReg] \
                                       : GetLSRegRHS (state, instr))
 #endif

 #define LSMNumRegs ((ARMword) ARMul_BitList[BITS (0, 7)] + \
                     (ARMword) ARMul_BitList[BITS (8, 15)] )
 #define LSMBaseFirst ((LHSReg == 0 && BIT (0)) || \
                       (BIT (LHSReg) && BITS (0, LHSReg - 1) == 0))

 #define SWAPSRC (state->Reg[RHSReg])

 #define LSCOff (BITS (0, 7) << 2)
 #define CPNum   BITS (8, 11)

 /* Determine if access to coprocessor CP is permitted.
    The XScale has a register in CP15 which controls access to CP0 - CP13.  */
 #define CP_ACCESS_ALLOWED(STATE, CP)			\
     (   ((CP) >= 14)					\
      || (! (STATE)->is_XScale)				\
      || (read_cp15_reg (15, 0, 1) & (1 << (CP))))

 /* Macro to rotate n right by b bits.  */
 #define ROTATER(n, b) (((n) >> (b)) | ((n) << (32 - (b))))

 /* Macros to store results of instructions.  */
 #define WRITEDEST(d)				\
   do						\
     {						\
       if (DESTReg == 15) 			\
 	WriteR15 (state, d); 			\
       else 					\
 	DEST = d;				\
     }						\
   while (0)

 #define WRITESDEST(d)				\
   do						\
     {						\
       if (DESTReg == 15)			\
 	WriteSR15 (state, d);			\
       else					\
 	{					\
 	  DEST = d;				\
 	  ARMul_NegZero (state, d);		\
 	}					\
     }						\
   while (0)

 #define WRITEDESTB(d)				\
   do						\
     {						\
       if (DESTReg == 15)			\
 	WriteR15Load (state, d);		\
       else					\
 	DEST = d;				\
     }						\
   while (0)

 #define BYTETOBUS(data) ((data & 0xff) | \
                         ((data & 0xff) << 8) | \
                         ((data & 0xff) << 16) | \
                         ((data & 0xff) << 24))

 #define BUSTOBYTE(address, data)				\
   do								\
     {								\
       if (state->bigendSig) 					\
 	temp = (data >> (((address ^ 3) & 3) << 3)) & 0xff;	\
       else							\
 	temp = (data >> ((address & 3) << 3)) & 0xff;		\
     }								\
   while (0)

 #define LOADMULT(instr,   address, wb)  LoadMult   (state, instr, address, wb)
 #define LOADSMULT(instr,  address, wb)  LoadSMult  (state, instr, address, wb)
 #define STOREMULT(instr,  address, wb)  StoreMult  (state, instr, address, wb)
 #define STORESMULT(instr, address, wb)  StoreSMult (state, instr, address, wb)

 #define POSBRANCH ((instr & 0x7fffff) << 2)
 #define NEGBRANCH ((0xff000000 |(instr & 0xffffff)) << 2)


 /* Values for Emulate.  */
 #define STOP            0	/* stop */
 #define CHANGEMODE      1	/* change mode */
 #define ONCE            2	/* execute just one interation */
 #define RUN             3	/* continuous execution */

 /* Stuff that is shared across modes.  */
 extern unsigned ARMul_MultTable[];	/* Number of I cycles for a mult.  */
 extern ARMword  ARMul_ImmedTable[];	/* Immediate DP LHS values.  */
 extern char     ARMul_BitList[];	/* Number of bits in a byte table.  */

 #define EVENTLISTSIZE 1024L

 /* Thumb support.  */
 typedef enum
 {
   t_undefined,		/* Undefined Thumb instruction.  */
   t_decoded,		/* Instruction decoded to ARM equivalent.  */
   t_branch		/* Thumb branch (already processed).  */
 }
 tdstate;

 #define t_resolved t_branch

 /* Macros to scrutinize instructions.  The dummy do loop is to keep the compiler
    happy when the statement is used in an otherwise empty else statement.  */
 #define UNDEF_Test		do { ; } while (0)
 #define UNDEF_Shift		do { ; } while (0)
 #define UNDEF_MSRPC		do { ; } while (0)
 #define UNDEF_MRSPC		do { ; } while (0)
 #define UNDEF_MULPCDest		do { ; } while (0)
 #define UNDEF_MULDestEQOp1	do { ; } while (0)
 #define UNDEF_LSRBPC		do { ; } while (0)
 #define UNDEF_LSRBaseEQOffWb	do { ; } while (0)
 #define UNDEF_LSRBaseEQDestWb	do { ; } while (0)
 #define UNDEF_LSRPCBaseWb	do { ; } while (0)
 #define UNDEF_LSRPCOffWb	do { ; } while (0)
 #define UNDEF_LSMNoRegs		do { ; } while (0)
 #define UNDEF_LSMPCBase		do { ; } while (0)
 #define UNDEF_LSMUserBankWb	do { ; } while (0)
 #define UNDEF_LSMBaseInListWb	do { ; } while (0)
 #define UNDEF_SWPPC		do { ; } while (0)
 #define UNDEF_CoProHS		do { ; } while (0)
 #define UNDEF_MCRPC		do { ; } while (0)
 #define UNDEF_LSCPCBaseWb	do { ; } while (0)
 #define UNDEF_UndefNotBounced	do { ; } while (0)
 #define UNDEF_ShortInt		do { ; } while (0)
 #define UNDEF_IllegalMode	do { ; } while (0)
 #define UNDEF_Prog32SigChange	do { ; } while (0)
 #define UNDEF_Data32SigChange	do { ; } while (0)

 /* Prototypes for exported functions.  */
 extern unsigned ARMul_NthReg        (ARMword, unsigned);
 extern int      AddOverflow         (ARMword, ARMword, ARMword);
 extern int      SubOverflow         (ARMword, ARMword, ARMword);
 extern ARMword  ARMul_Emulate26     (ARMul_State *);
 extern ARMword  ARMul_Emulate32     (ARMul_State *);
 extern unsigned IntPending          (ARMul_State *);
 extern void     ARMul_CPSRAltered   (ARMul_State *);
 extern void     ARMul_R15Altered    (ARMul_State *);
 extern ARMword  ARMul_GetPC         (ARMul_State *);
 extern ARMword  ARMul_GetNextPC     (ARMul_State *);
 extern ARMword  ARMul_GetR15        (ARMul_State *);
 extern ARMword  ARMul_GetCPSR       (ARMul_State *);
 extern void     ARMul_EnvokeEvent   (ARMul_State *);
 extern unsigned long ARMul_Time     (ARMul_State *);
 extern void     ARMul_NegZero       (ARMul_State *, ARMword);
 extern void     ARMul_SetPC         (ARMul_State *, ARMword);
 extern void     ARMul_SetR15        (ARMul_State *, ARMword);
 extern void     ARMul_SetCPSR       (ARMul_State *, ARMword);
 extern ARMword  ARMul_GetSPSR       (ARMul_State *, ARMword);
 extern void     ARMul_Abort26       (ARMul_State *, ARMword);
 extern void     ARMul_Abort32       (ARMul_State *, ARMword);
 extern ARMword  ARMul_MRC           (ARMul_State *, ARMword);
 extern void     ARMul_CDP           (ARMul_State *, ARMword);
 extern void     ARMul_LDC           (ARMul_State *, ARMword, ARMword);
 extern void     ARMul_STC           (ARMul_State *, ARMword, ARMword);
 extern void     ARMul_MCR           (ARMul_State *, ARMword, ARMword);
 extern void     ARMul_SetSPSR       (ARMul_State *, ARMword, ARMword);
 extern ARMword  ARMul_SwitchMode    (ARMul_State *, ARMword, ARMword);
 extern ARMword  ARMul_Align         (ARMul_State *, ARMword, ARMword);
 extern ARMword  ARMul_SwitchMode    (ARMul_State *, ARMword, ARMword);
 extern void     ARMul_MSRCpsr       (ARMul_State *, ARMword, ARMword);
 extern void     ARMul_SubOverflow   (ARMul_State *, ARMword, ARMword, ARMword);
 extern void     ARMul_AddOverflow   (ARMul_State *, ARMword, ARMword, ARMword);
 extern void     ARMul_SubCarry      (ARMul_State *, ARMword, ARMword, ARMword);
 extern void     ARMul_AddCarry      (ARMul_State *, ARMword, ARMword, ARMword);
 extern tdstate  ARMul_ThumbDecode   (ARMul_State *, ARMword, ARMword, ARMword *);
 extern ARMword  ARMul_GetReg        (ARMul_State *, unsigned, unsigned);
 extern void     ARMul_SetReg        (ARMul_State *, unsigned, unsigned, ARMword);
 extern void     ARMul_ScheduleEvent (ARMul_State *, unsigned long, unsigned (*) (ARMul_State *));
 /* Coprocessor support functions.  */
 extern unsigned ARMul_CoProInit     (ARMul_State *);
 extern void     ARMul_CoProExit     (ARMul_State *);
 extern void     ARMul_CoProAttach   (ARMul_State *, unsigned, ARMul_CPInits *, ARMul_CPExits *,
 				     ARMul_LDCs *, ARMul_STCs *, ARMul_MRCs *, ARMul_MCRs *,
 				     ARMul_CDPs *, ARMul_CPReads *, ARMul_CPWrites *);
 extern void     ARMul_CoProDetach   (ARMul_State *, unsigned);
 extern ARMword  read_cp15_reg       (unsigned, unsigned, unsigned);

 extern unsigned DSPLDC4 (ARMul_State *, unsigned, ARMword, ARMword);
 extern unsigned DSPMCR4 (ARMul_State *, unsigned, ARMword, ARMword);
 extern unsigned DSPMRC4 (ARMul_State *, unsigned, ARMword, ARMword *);
 extern unsigned	DSPSTC4 (ARMul_State *, unsigned, ARMword, ARMword *);
 extern unsigned	DSPCDP4 (ARMul_State *, unsigned, ARMword);
 extern unsigned DSPMCR5 (ARMul_State *, unsigned, ARMword, ARMword);
 extern unsigned DSPMRC5 (ARMul_State *, unsigned, ARMword, ARMword *);
 extern unsigned DSPLDC5 (ARMul_State *, unsigned, ARMword, ARMword);
 extern unsigned	DSPSTC5 (ARMul_State *, unsigned, ARMword, ARMword *);
 extern unsigned	DSPCDP5 (ARMul_State *, unsigned, ARMword);
 extern unsigned DSPMCR6 (ARMul_State *, unsigned, ARMword, ARMword);
 extern unsigned DSPMRC6 (ARMul_State *, unsigned, ARMword, ARMword *);
 extern unsigned	DSPCDP6 (ARMul_State *, unsigned, ARMword);
	/* armemu.h -- ARMulator emulation macros: ARM6 Instruction Emulator.
	Copyright (C) 1994 Advanced RISC Machines Ltd.

	This program is free software; you can redistribute it and/or modify
	it under the terms of the GNU General Public License as published by
	the Free Software Foundation; either version 3 of the License, or
	(at your option) any later version.

	This program is distributed in the hope that it will be useful,
	but WITHOUT ANY WARRANTY; without even the implied warranty of
	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	GNU General Public License for more details.

	You should have received a copy of the GNU General Public License
	along with this program; if not, see <http://www.gnu.org/licenses/>. */

	extern ARMword isize;
	extern int trace;
	extern int disas;
	extern int trace_funcs;
	extern void print_insn (ARMword);

	/* Condition code values. */
	#define EQ 0
	#define NE 1
	#define CS 2
	#define CC 3
	#define MI 4
	#define PL 5
	#define VS 6
	#define VC 7
	#define HI 8
	#define LS 9
	#define GE 10
	#define LT 11
	#define GT 12
	#define LE 13
	#define AL 14
	#define NV 15

	/* Shift Opcodes. */
	#define LSL 0
	#define LSR 1
	#define ASR 2
	#define ROR 3

	/* Macros to twiddle the status flags and mode. */
	#define NBIT ((unsigned)1L << 31)
	#define ZBIT (1L << 30)
	#define CBIT (1L << 29)
	#define VBIT (1L << 28)
	#define SBIT (1L << 27)
	#define GE0 (1L << 16)
	#define GE1 (1L << 17)
	#define GE2 (1L << 18)
	#define GE3 (1L << 19)
	#define IBIT (1L << 7)
	#define FBIT (1L << 6)
	#define IFBITS (3L << 6)
	#define R15IBIT (1L << 27)
	#define R15FBIT (1L << 26)
	#define R15IFBITS (3L << 26)

	#define POS(i) ( (~(i)) >> 31 )
	#define NEG(i) ( (i) >> 31 )

	#ifdef MODET /* Thumb support. */
	/* ??? This bit is actually in the low order bit of the PC in the hardware.
	It isn't clear if the simulator needs to model that or not. */
	#define TBIT (1L << 5)
	#define TFLAG state->TFlag
	#define SETT state->TFlag = 1
	#define CLEART state->TFlag = 0
	#define ASSIGNT(res) state->TFlag = res
	#define INSN_SIZE (TFLAG ? 2 : 4)
	#else
	#define INSN_SIZE 4
	#endif

	#define NFLAG state->NFlag
	#define SETN state->NFlag = 1
	#define CLEARN state->NFlag = 0
	#define ASSIGNN(res) state->NFlag = res

	#define ZFLAG state->ZFlag
	#define SETZ state->ZFlag = 1
	#define CLEARZ state->ZFlag = 0
	#define ASSIGNZ(res) state->ZFlag = res

	#define CFLAG state->CFlag
	#define SETC state->CFlag = 1
	#define CLEARC state->CFlag = 0
	#define ASSIGNC(res) state->CFlag = res

	#define VFLAG state->VFlag
	#define SETV state->VFlag = 1
	#define CLEARV state->VFlag = 0
	#define ASSIGNV(res) state->VFlag = res

	#define SFLAG state->SFlag
	#define SETS state->SFlag = 1
	#define CLEARS state->SFlag = 0
	#define ASSIGNS(res) state->SFlag = res

	#define IFLAG (state->IFFlags >> 1)
	#define FFLAG (state->IFFlags & 1)
	#define IFFLAGS state->IFFlags
	#define ASSIGNINT(res) state->IFFlags = (((res) >> 6) & 3)
	#define ASSIGNR15INT(res) state->IFFlags = (((res) >> 26) & 3) ;

	#define PSR_FBITS (0xff000000L)
	#define PSR_SBITS (0x00ff0000L)
	#define PSR_XBITS (0x0000ff00L)
	#define PSR_CBITS (0x000000ffL)

	#if defined MODE32 \|\| defined MODET
	#define CCBITS (0xf8000000L)
	#else
	#define CCBITS (0xf0000000L)
	#endif

	#define INTBITS (0xc0L)

	#if defined MODET && defined MODE32
	#define PCBITS (0xffffffffL)
	#else
	#define PCBITS (0xfffffffcL)
	#endif

	#define MODEBITS (0x1fL)
	#define R15INTBITS (3L << 26)

	#if defined MODET && defined MODE32
	#define R15PCBITS (0x03ffffffL)
	#else
	#define R15PCBITS (0x03fffffcL)
	#endif

	#define R15PCMODEBITS (0x03ffffffL)
	#define R15MODEBITS (0x3L)

	#ifdef MODE32
	#define PCMASK PCBITS
	#define PCWRAP(pc) (pc)
	#else
	#define PCMASK R15PCBITS
	#define PCWRAP(pc) ((pc) & R15PCBITS)
	#endif

	#define PC (state->Reg[15] & PCMASK)
	#define R15CCINTMODE (state->Reg[15] & (CCBITS \| R15INTBITS \| R15MODEBITS))
	#define R15INT (state->Reg[15] & R15INTBITS)
	#define R15INTPC (state->Reg[15] & (R15INTBITS \| R15PCBITS))
	#define R15INTPCMODE (state->Reg[15] & (R15INTBITS \| R15PCBITS \| R15MODEBITS))
	#define R15INTMODE (state->Reg[15] & (R15INTBITS \| R15MODEBITS))
	#define R15PC (state->Reg[15] & R15PCBITS)
	#define R15PCMODE (state->Reg[15] & (R15PCBITS \| R15MODEBITS))
	#define R15MODE (state->Reg[15] & R15MODEBITS)

	#define ECC ((NFLAG << 31) \| (ZFLAG << 30) \| (CFLAG << 29) \| (VFLAG << 28) \| (SFLAG << 27))
	#define EINT (IFFLAGS << 6)
	#define ER15INT (IFFLAGS << 26)
	#define EMODE (state->Mode)

	#ifdef MODET
	#define CPSR (ECC \| EINT \| EMODE \| (TFLAG << 5))
	#else
	#define CPSR (ECC \| EINT \| EMODE)
	#endif

	#ifdef MODE32
	#define PATCHR15
	#else
	#define PATCHR15 state->Reg[15] = ECC \| ER15INT \| EMODE \| R15PC
	#endif

	#define GETSPSR(bank) (ARMul_GetSPSR (state, EMODE))
	#define SETPSR_F(d,s) d = ((d) & ~PSR_FBITS) \| ((s) & PSR_FBITS)
	#define SETPSR_S(d,s) d = ((d) & ~PSR_SBITS) \| ((s) & PSR_SBITS)
	#define SETPSR_X(d,s) d = ((d) & ~PSR_XBITS) \| ((s) & PSR_XBITS)
	#define SETPSR_C(d,s) d = ((d) & ~PSR_CBITS) \| ((s) & PSR_CBITS)

	#define SETR15PSR(s) \
	do \
	{ \
	if (state->Mode == USER26MODE) \
	{ \
	state->Reg[15] = ((s) & CCBITS) \| R15PC \| ER15INT \| EMODE; \
	ASSIGNN ((state->Reg[15] & NBIT) != 0); \
	ASSIGNZ ((state->Reg[15] & ZBIT) != 0); \
	ASSIGNC ((state->Reg[15] & CBIT) != 0); \
	ASSIGNV ((state->Reg[15] & VBIT) != 0); \
	} \
	else \
	{ \
	state->Reg[15] = R15PC \| ((s) & (CCBITS \| R15INTBITS \| R15MODEBITS)); \
	ARMul_R15Altered (state); \
	} \
	} \
	while (0)

	#define SETABORT(i, m, d) \
	do \
	{ \
	int SETABORT_mode = (m); \
	\
	ARMul_SetSPSR (state, SETABORT_mode, ARMul_GetCPSR (state)); \
	ARMul_SetCPSR (state, ((ARMul_GetCPSR (state) & ~(EMODE \| TBIT)) \
	\| (i) \| SETABORT_mode)); \
	state->Reg[14] = temp - (d); \
	} \
	while (0)

	#ifndef MODE32
	#define VECTORS 0x20
	#define LEGALADDR 0x03ffffff
	#define VECTORACCESS(address) (address < VECTORS && ARMul_MODE26BIT && state->prog32Sig)
	#define ADDREXCEPT(address) (address > LEGALADDR && !state->data32Sig)
	#endif

	#define INTERNALABORT(address) \
	do \
	{ \
	if (address < VECTORS) \
	state->Aborted = ARMul_DataAbortV; \
	else \
	state->Aborted = ARMul_AddrExceptnV; \
	} \
	while (0)

	#ifdef MODE32
	#define TAKEABORT ARMul_Abort (state, ARMul_DataAbortV)
	#else
	#define TAKEABORT \
	do \
	{ \
	if (state->Aborted == ARMul_AddrExceptnV) \
	ARMul_Abort (state, ARMul_AddrExceptnV); \
	else \
	ARMul_Abort (state, ARMul_DataAbortV); \
	} \
	while (0)
	#endif

	#define CPTAKEABORT \
	do \
	{ \
	if (!state->Aborted) \
	ARMul_Abort (state, ARMul_UndefinedInstrV); \
	else if (state->Aborted == ARMul_AddrExceptnV) \
	ARMul_Abort (state, ARMul_AddrExceptnV); \
	else \
	ARMul_Abort (state, ARMul_DataAbortV); \
	} \
	while (0);


	/* Different ways to start the next instruction. */
	#define SEQ 0
	#define NONSEQ 1
	#define PCINCEDSEQ 2
	#define PCINCEDNONSEQ 3
	#define PRIMEPIPE 4
	#define RESUME 8

	#define NORMALCYCLE state->NextInstr = 0
	#define BUSUSEDN state->NextInstr \|= 1 /* The next fetch will be an N cycle. */
	#define BUSUSEDINCPCS \
	do \
	{ \
	if (! state->is_v4) \
	{ \
	/* A standard PC inc and an S cycle. */ \
	state->Reg[15] += isize; \
	state->NextInstr = (state->NextInstr & 0xff) \| 2; \
	} \
	} \
	while (0)

	#define BUSUSEDINCPCN \
	do \
	{ \
	if (state->is_v4) \
	BUSUSEDN; \
	else \
	{ \
	/* A standard PC inc and an N cycle. */ \
	state->Reg[15] += isize; \
	state->NextInstr \|= 3; \
	} \
	} \
	while (0)

	#define INCPC \
	do \
	{ \
	/* A standard PC inc. */ \
	state->Reg[15] += isize; \
	state->NextInstr \|= 2; \
	} \
	while (0)

	#define FLUSHPIPE state->NextInstr \|= PRIMEPIPE

	/* Cycle based emulation. */

	#define OUTPUTCP(i,a,b)
	#define NCYCLE
	#define SCYCLE
	#define ICYCLE
	#define CCYCLE
	#define NEXTCYCLE(c)

	/* Macros to extract parts of instructions. */
	#define DESTReg (BITS (12, 15))
	#define LHSReg (BITS (16, 19))
	#define RHSReg (BITS ( 0, 3))

	#define DEST (state->Reg[DESTReg])

	#ifdef MODE32
	#ifdef MODET
	#define LHS ((LHSReg == 15) ? (state->Reg[15] & 0xFFFFFFFC): (state->Reg[LHSReg]))
	#else
	#define LHS (state->Reg[LHSReg])
	#endif
	#else
	#define LHS ((LHSReg == 15) ? R15PC : (state->Reg[LHSReg]))
	#endif

	#define MULDESTReg (BITS (16, 19))
	#define MULLHSReg (BITS ( 0, 3))
	#define MULRHSReg (BITS ( 8, 11))
	#define MULACCReg (BITS (12, 15))

	#define DPImmRHS (ARMul_ImmedTable[BITS(0, 11)])
	#define DPSImmRHS temp = BITS(0,11) ; \
	rhs = ARMul_ImmedTable[temp] ; \
	if (temp > 255) /* There was a shift. */ \
	ASSIGNC (rhs >> 31) ;

	#ifdef MODE32
	#define DPRegRHS ((BITS (4,11) == 0) ? state->Reg[RHSReg] \
	: GetDPRegRHS (state, instr))
	#define DPSRegRHS ((BITS (4,11) == 0) ? state->Reg[RHSReg] \
	: GetDPSRegRHS (state, instr))
	#else
	#define DPRegRHS ((BITS (0, 11) < 15) ? state->Reg[RHSReg] \
	: GetDPRegRHS (state, instr))
	#define DPSRegRHS ((BITS (0, 11) < 15) ? state->Reg[RHSReg] \
	: GetDPSRegRHS (state, instr))
	#endif

	#define LSBase state->Reg[LHSReg]
	#define LSImmRHS (BITS(0,11))

	#ifdef MODE32
	#define LSRegRHS ((BITS (4, 11) == 0) ? state->Reg[RHSReg] \
	: GetLSRegRHS (state, instr))
	#else
	#define LSRegRHS ((BITS (0, 11) < 15) ? state->Reg[RHSReg] \
	: GetLSRegRHS (state, instr))
	#endif

	#define LSMNumRegs ((ARMword) ARMul_BitList[BITS (0, 7)] + \
	(ARMword) ARMul_BitList[BITS (8, 15)] )
	#define LSMBaseFirst ((LHSReg == 0 && BIT (0)) \|\| \
	(BIT (LHSReg) && BITS (0, LHSReg - 1) == 0))

	#define SWAPSRC (state->Reg[RHSReg])

	#define LSCOff (BITS (0, 7) << 2)
	#define CPNum BITS (8, 11)

	/* Determine if access to coprocessor CP is permitted.
	The XScale has a register in CP15 which controls access to CP0 - CP13. */
	#define CP_ACCESS_ALLOWED(STATE, CP) \
	( ((CP) >= 14) \
	\|\| (! (STATE)->is_XScale) \
	\|\| (read_cp15_reg (15, 0, 1) & (1 << (CP))))

	/* Macro to rotate n right by b bits. */
	#define ROTATER(n, b) (((n) >> (b)) \| ((n) << (32 - (b))))

	/* Macros to store results of instructions. */
	#define WRITEDEST(d) \
	do \
	{ \
	if (DESTReg == 15) \
	WriteR15 (state, d); \
	else \
	DEST = d; \
	} \
	while (0)

	#define WRITESDEST(d) \
	do \
	{ \
	if (DESTReg == 15) \
	WriteSR15 (state, d); \
	else \
	{ \
	DEST = d; \
	ARMul_NegZero (state, d); \
	} \
	} \
	while (0)

	#define WRITEDESTB(d) \
	do \
	{ \
	if (DESTReg == 15) \
	WriteR15Load (state, d); \
	else \
	DEST = d; \
	} \
	while (0)

	#define BYTETOBUS(data) ((data & 0xff) \| \
	((data & 0xff) << 8) \| \
	((data & 0xff) << 16) \| \
	((data & 0xff) << 24))

	#define BUSTOBYTE(address, data) \
	do \
	{ \
	if (state->bigendSig) \
	temp = (data >> (((address ^ 3) & 3) << 3)) & 0xff; \
	else \
	temp = (data >> ((address & 3) << 3)) & 0xff; \
	} \
	while (0)

	#define LOADMULT(instr, address, wb) LoadMult (state, instr, address, wb)
	#define LOADSMULT(instr, address, wb) LoadSMult (state, instr, address, wb)
	#define STOREMULT(instr, address, wb) StoreMult (state, instr, address, wb)
	#define STORESMULT(instr, address, wb) StoreSMult (state, instr, address, wb)

	#define POSBRANCH ((instr & 0x7fffff) << 2)
	#define NEGBRANCH ((0xff000000 \|(instr & 0xffffff)) << 2)


	/* Values for Emulate. */
	#define STOP 0 /* stop */
	#define CHANGEMODE 1 /* change mode */
	#define ONCE 2 /* execute just one interation */
	#define RUN 3 /* continuous execution */

	/* Stuff that is shared across modes. */
	extern unsigned ARMul_MultTable[]; /* Number of I cycles for a mult. */
	extern ARMword ARMul_ImmedTable[]; /* Immediate DP LHS values. */
	extern char ARMul_BitList[]; /* Number of bits in a byte table. */

	#define EVENTLISTSIZE 1024L

	/* Thumb support. */
	typedef enum
	{
	t_undefined, /* Undefined Thumb instruction. */
	t_decoded, /* Instruction decoded to ARM equivalent. */
	t_branch /* Thumb branch (already processed). */
	}
	tdstate;

	#define t_resolved t_branch

	/* Macros to scrutinize instructions. The dummy do loop is to keep the compiler
	happy when the statement is used in an otherwise empty else statement. */
	#define UNDEF_Test do { ; } while (0)
	#define UNDEF_Shift do { ; } while (0)
	#define UNDEF_MSRPC do { ; } while (0)
	#define UNDEF_MRSPC do { ; } while (0)
	#define UNDEF_MULPCDest do { ; } while (0)
	#define UNDEF_MULDestEQOp1 do { ; } while (0)
	#define UNDEF_LSRBPC do { ; } while (0)
	#define UNDEF_LSRBaseEQOffWb do { ; } while (0)
	#define UNDEF_LSRBaseEQDestWb do { ; } while (0)
	#define UNDEF_LSRPCBaseWb do { ; } while (0)
	#define UNDEF_LSRPCOffWb do { ; } while (0)
	#define UNDEF_LSMNoRegs do { ; } while (0)
	#define UNDEF_LSMPCBase do { ; } while (0)
	#define UNDEF_LSMUserBankWb do { ; } while (0)
	#define UNDEF_LSMBaseInListWb do { ; } while (0)
	#define UNDEF_SWPPC do { ; } while (0)
	#define UNDEF_CoProHS do { ; } while (0)
	#define UNDEF_MCRPC do { ; } while (0)
	#define UNDEF_LSCPCBaseWb do { ; } while (0)
	#define UNDEF_UndefNotBounced do { ; } while (0)
	#define UNDEF_ShortInt do { ; } while (0)
	#define UNDEF_IllegalMode do { ; } while (0)
	#define UNDEF_Prog32SigChange do { ; } while (0)
	#define UNDEF_Data32SigChange do { ; } while (0)

	/* Prototypes for exported functions. */
	extern unsigned ARMul_NthReg (ARMword, unsigned);
	extern int AddOverflow (ARMword, ARMword, ARMword);
	extern int SubOverflow (ARMword, ARMword, ARMword);
	extern ARMword ARMul_Emulate26 (ARMul_State *);
	extern ARMword ARMul_Emulate32 (ARMul_State *);
	extern unsigned IntPending (ARMul_State *);
	extern void ARMul_CPSRAltered (ARMul_State *);
	extern void ARMul_R15Altered (ARMul_State *);
	extern ARMword ARMul_GetPC (ARMul_State *);
	extern ARMword ARMul_GetNextPC (ARMul_State *);
	extern ARMword ARMul_GetR15 (ARMul_State *);
	extern ARMword ARMul_GetCPSR (ARMul_State *);
	extern void ARMul_EnvokeEvent (ARMul_State *);
	extern unsigned long ARMul_Time (ARMul_State *);
	extern void ARMul_NegZero (ARMul_State *, ARMword);
	extern void ARMul_SetPC (ARMul_State *, ARMword);
	extern void ARMul_SetR15 (ARMul_State *, ARMword);
	extern void ARMul_SetCPSR (ARMul_State *, ARMword);
	extern ARMword ARMul_GetSPSR (ARMul_State *, ARMword);
	extern void ARMul_Abort26 (ARMul_State *, ARMword);
	extern void ARMul_Abort32 (ARMul_State *, ARMword);
	extern ARMword ARMul_MRC (ARMul_State *, ARMword);
	extern void ARMul_CDP (ARMul_State *, ARMword);
	extern void ARMul_LDC (ARMul_State *, ARMword, ARMword);
	extern void ARMul_STC (ARMul_State *, ARMword, ARMword);
	extern void ARMul_MCR (ARMul_State *, ARMword, ARMword);
	extern void ARMul_SetSPSR (ARMul_State *, ARMword, ARMword);
	extern ARMword ARMul_SwitchMode (ARMul_State *, ARMword, ARMword);
	extern ARMword ARMul_Align (ARMul_State *, ARMword, ARMword);
	extern ARMword ARMul_SwitchMode (ARMul_State *, ARMword, ARMword);
	extern void ARMul_MSRCpsr (ARMul_State *, ARMword, ARMword);
	extern void ARMul_SubOverflow (ARMul_State *, ARMword, ARMword, ARMword);
	extern void ARMul_AddOverflow (ARMul_State *, ARMword, ARMword, ARMword);
	extern void ARMul_SubCarry (ARMul_State *, ARMword, ARMword, ARMword);
	extern void ARMul_AddCarry (ARMul_State *, ARMword, ARMword, ARMword);
	extern tdstate ARMul_ThumbDecode (ARMul_State , ARMword, ARMword, ARMword );
	extern ARMword ARMul_GetReg (ARMul_State *, unsigned, unsigned);
	extern void ARMul_SetReg (ARMul_State *, unsigned, unsigned, ARMword);
	extern void ARMul_ScheduleEvent (ARMul_State , unsigned long, unsigned () (ARMul_State *));
	/* Coprocessor support functions. */
	extern unsigned ARMul_CoProInit (ARMul_State *);
	extern void ARMul_CoProExit (ARMul_State *);
	extern void ARMul_CoProAttach (ARMul_State , unsigned, ARMul_CPInits , ARMul_CPExits *,
	ARMul_LDCs , ARMul_STCs , ARMul_MRCs , ARMul_MCRs ,
	ARMul_CDPs , ARMul_CPReads , ARMul_CPWrites *);
	extern void ARMul_CoProDetach (ARMul_State *, unsigned);
	extern ARMword read_cp15_reg (unsigned, unsigned, unsigned);

	extern unsigned DSPLDC4 (ARMul_State *, unsigned, ARMword, ARMword);
	extern unsigned DSPMCR4 (ARMul_State *, unsigned, ARMword, ARMword);
	extern unsigned DSPMRC4 (ARMul_State , unsigned, ARMword, ARMword );
	extern unsigned DSPSTC4 (ARMul_State , unsigned, ARMword, ARMword );
	extern unsigned DSPCDP4 (ARMul_State *, unsigned, ARMword);
	extern unsigned DSPMCR5 (ARMul_State *, unsigned, ARMword, ARMword);
	extern unsigned DSPMRC5 (ARMul_State , unsigned, ARMword, ARMword );
	extern unsigned DSPLDC5 (ARMul_State *, unsigned, ARMword, ARMword);
	extern unsigned DSPSTC5 (ARMul_State , unsigned, ARMword, ARMword );
	extern unsigned DSPCDP5 (ARMul_State *, unsigned, ARMword);
	extern unsigned DSPMCR6 (ARMul_State *, unsigned, ARMword, ARMword);
	extern unsigned DSPMRC6 (ARMul_State , unsigned, ARMword, ARMword );
	extern unsigned DSPCDP6 (ARMul_State *, unsigned, ARMword);