* armdefs.h (SYSTEMBANK): Define as USERBANK.
[external/binutils.git] / sim / arm / armdefs.h
1 /*  armdefs.h -- ARMulator common definitions:  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 #include <stdio.h>
19 #include <stdlib.h>
20
21 #define FALSE 0
22 #define TRUE 1
23 #define LOW 0
24 #define HIGH 1
25 #define LOWHIGH 1
26 #define HIGHLOW 2
27
28 #ifndef __STDC__
29 typedef char *VoidStar;
30 #endif
31
32 typedef unsigned long ARMword;  /* must be 32 bits wide */
33 typedef struct ARMul_State ARMul_State;
34
35 typedef unsigned ARMul_CPInits (ARMul_State * state);
36 typedef unsigned ARMul_CPExits (ARMul_State * state);
37 typedef unsigned ARMul_LDCs (ARMul_State * state, unsigned type,
38                              ARMword instr, ARMword value);
39 typedef unsigned ARMul_STCs (ARMul_State * state, unsigned type,
40                              ARMword instr, ARMword * value);
41 typedef unsigned ARMul_MRCs (ARMul_State * state, unsigned type,
42                              ARMword instr, ARMword * value);
43 typedef unsigned ARMul_MCRs (ARMul_State * state, unsigned type,
44                              ARMword instr, ARMword value);
45 typedef unsigned ARMul_CDPs (ARMul_State * state, unsigned type,
46                              ARMword instr);
47 typedef unsigned ARMul_CPReads (ARMul_State * state, unsigned reg,
48                                 ARMword * value);
49 typedef unsigned ARMul_CPWrites (ARMul_State * state, unsigned reg,
50                                  ARMword value);
51
52 struct ARMul_State
53 {
54   ARMword Emulate;              /* to start and stop emulation */
55   unsigned EndCondition;        /* reason for stopping */
56   unsigned ErrorCode;           /* type of illegal instruction */
57   ARMword Reg[16];              /* the current register file */
58   ARMword RegBank[7][16];       /* all the registers */
59   ARMword Cpsr;                 /* the current psr */
60   ARMword Spsr[7];              /* the exception psr's */
61   ARMword NFlag, ZFlag, CFlag, VFlag, IFFlags;  /* dummy flags for speed */
62 #ifdef MODET
63   ARMword TFlag;                /* Thumb state */
64 #endif
65   ARMword Bank;                 /* the current register bank */
66   ARMword Mode;                 /* the current mode */
67   ARMword instr, pc, temp;      /* saved register state */
68   ARMword loaded, decoded;      /* saved pipeline state */
69   unsigned long NumScycles, NumNcycles, NumIcycles, NumCcycles, NumFcycles;     /* emulated cycles used */
70   unsigned long NumInstrs;      /* the number of instructions executed */
71   unsigned NextInstr;
72   unsigned VectorCatch;         /* caught exception mask */
73   unsigned CallDebug;           /* set to call the debugger */
74   unsigned CanWatch;            /* set by memory interface if its willing to suffer the
75                                    overhead of checking for watchpoints on each memory
76                                    access */
77   unsigned MemReadDebug, MemWriteDebug;
78   unsigned long StopHandle;
79
80   unsigned char *MemDataPtr;    /* admin data */
81   unsigned char *MemInPtr;      /* the Data In bus */
82   unsigned char *MemOutPtr;     /* the Data Out bus (which you may not need */
83   unsigned char *MemSparePtr;   /* extra space */
84   ARMword MemSize;
85
86   unsigned char *OSptr;         /* OS Handle */
87   char *CommandLine;            /* Command Line from ARMsd */
88
89   ARMul_CPInits *CPInit[16];    /* coprocessor initialisers */
90   ARMul_CPExits *CPExit[16];    /* coprocessor finalisers */
91   ARMul_LDCs *LDC[16];          /* LDC instruction */
92   ARMul_STCs *STC[16];          /* STC instruction */
93   ARMul_MRCs *MRC[16];          /* MRC instruction */
94   ARMul_MCRs *MCR[16];          /* MCR instruction */
95   ARMul_CDPs *CDP[16];          /* CDP instruction */
96   ARMul_CPReads *CPRead[16];    /* Read CP register */
97   ARMul_CPWrites *CPWrite[16];  /* Write CP register */
98   unsigned char *CPData[16];    /* Coprocessor data */
99   unsigned char const *CPRegWords[16];  /* map of coprocessor register sizes */
100
101   unsigned EventSet;            /* the number of events in the queue */
102   unsigned long Now;            /* time to the nearest cycle */
103   struct EventNode **EventPtr;  /* the event list */
104
105   unsigned Exception;           /* enable the next four values */
106   unsigned Debug;               /* show instructions as they are executed */
107   unsigned NresetSig;           /* reset the processor */
108   unsigned NfiqSig;
109   unsigned NirqSig;
110
111   unsigned abortSig;
112   unsigned NtransSig;
113   unsigned bigendSig;
114   unsigned prog32Sig;
115   unsigned data32Sig;
116   unsigned lateabtSig;
117   ARMword Vector;               /* synthesize aborts in cycle modes */
118   ARMword Aborted;              /* sticky flag for aborts */
119   ARMword Reseted;              /* sticky flag for Reset */
120   ARMword Inted, LastInted;     /* sticky flags for interrupts */
121   ARMword Base;                 /* extra hand for base writeback */
122   ARMword AbortAddr;            /* to keep track of Prefetch aborts */
123
124   const struct Dbg_HostosInterface *hostif;
125
126   int verbose;                  /* non-zero means print various messages like the banner */
127 };
128
129 #define ResetPin NresetSig
130 #define FIQPin NfiqSig
131 #define IRQPin NirqSig
132 #define AbortPin abortSig
133 #define TransPin NtransSig
134 #define BigEndPin bigendSig
135 #define Prog32Pin prog32Sig
136 #define Data32Pin data32Sig
137 #define LateAbortPin lateabtSig
138
139 /***************************************************************************\
140 *                        Types of ARM we know about                         *
141 \***************************************************************************/
142
143 /* The bitflags */
144 #define ARM_Fix26_Prop   0x01
145 #define ARM_Nexec_Prop   0x02
146 #define ARM_Debug_Prop   0x10
147 #define ARM_Isync_Prop   ARM_Debug_Prop
148 #define ARM_Lock_Prop    0x20
149
150 /* ARM2 family */
151 #define ARM2    (ARM_Fix26_Prop)
152 #define ARM2as  ARM2
153 #define ARM61   ARM2
154 #define ARM3    ARM2
155
156 #ifdef ARM60                    /* previous definition in armopts.h */
157 #undef ARM60
158 #endif
159
160 /* ARM6 family */
161 #define ARM6    (ARM_Lock_Prop)
162 #define ARM60   ARM6
163 #define ARM600  ARM6
164 #define ARM610  ARM6
165 #define ARM620  ARM6
166
167
168 /***************************************************************************\
169 *                   Macros to extract instruction fields                    *
170 \***************************************************************************/
171
172 #define BIT(n) ( (ARMword)(instr>>(n))&1)       /* bit n of instruction */
173 #define BITS(m,n) ( (ARMword)(instr<<(31-(n))) >> ((31-(n))+(m)) )      /* bits m to n of instr */
174 #define TOPBITS(n) (instr >> (n))       /* bits 31 to n of instr */
175
176 /***************************************************************************\
177 *                      The hardware vector addresses                        *
178 \***************************************************************************/
179
180 #define ARMResetV 0L
181 #define ARMUndefinedInstrV 4L
182 #define ARMSWIV 8L
183 #define ARMPrefetchAbortV 12L
184 #define ARMDataAbortV 16L
185 #define ARMAddrExceptnV 20L
186 #define ARMIRQV 24L
187 #define ARMFIQV 28L
188 #define ARMErrorV 32L           /* This is an offset, not an address ! */
189
190 #define ARMul_ResetV ARMResetV
191 #define ARMul_UndefinedInstrV ARMUndefinedInstrV
192 #define ARMul_SWIV ARMSWIV
193 #define ARMul_PrefetchAbortV ARMPrefetchAbortV
194 #define ARMul_DataAbortV ARMDataAbortV
195 #define ARMul_AddrExceptnV ARMAddrExceptnV
196 #define ARMul_IRQV ARMIRQV
197 #define ARMul_FIQV ARMFIQV
198
199 /***************************************************************************\
200 *                          Mode and Bank Constants                          *
201 \***************************************************************************/
202
203 #define USER26MODE   0L
204 #define FIQ26MODE    1L
205 #define IRQ26MODE    2L
206 #define SVC26MODE    3L
207 #define USER32MODE  16L
208 #define FIQ32MODE   17L
209 #define IRQ32MODE   18L
210 #define SVC32MODE   19L
211 #define ABORT32MODE 23L
212 #define UNDEF32MODE 27L
213 #define SYSTEMMODE  31L
214
215 #define ARM32BITMODE (state->Mode > 3)
216 #define ARM26BITMODE (state->Mode <= 3)
217 #define ARMMODE (state->Mode)
218 #define ARMul_MODEBITS 0x1fL
219 #define ARMul_MODE32BIT ARM32BITMODE
220 #define ARMul_MODE26BIT ARM26BITMODE
221
222 #define USERBANK 0
223 #define FIQBANK 1
224 #define IRQBANK 2
225 #define SVCBANK 3
226 #define ABORTBANK 4
227 #define UNDEFBANK 5
228 #define DUMMYBANK 6
229 #define SYSTEMBANK USERBANK
230
231 #define BANK_CAN_ACCESS_SPSR(bank)  \
232   ((bank) != USERBANK && (bank) != SYSTEMBANK && (bank) != DUMMYBANK)
233
234 /***************************************************************************\
235 *                  Definitons of things in the emulator                     *
236 \***************************************************************************/
237
238 extern void ARMul_EmulateInit (void);
239 extern ARMul_State *ARMul_NewState (void);
240 extern void ARMul_Reset (ARMul_State * state);
241 extern ARMword ARMul_DoProg (ARMul_State * state);
242 extern ARMword ARMul_DoInstr (ARMul_State * state);
243
244 /***************************************************************************\
245 *                Definitons of things for event handling                    *
246 \***************************************************************************/
247
248 extern void ARMul_ScheduleEvent (ARMul_State * state, unsigned long delay,
249                                  unsigned (*func) ());
250 extern void ARMul_EnvokeEvent (ARMul_State * state);
251 extern unsigned long ARMul_Time (ARMul_State * state);
252
253 /***************************************************************************\
254 *                          Useful support routines                          *
255 \***************************************************************************/
256
257 extern ARMword ARMul_GetReg (ARMul_State * state, unsigned mode,
258                              unsigned reg);
259 extern void ARMul_SetReg (ARMul_State * state, unsigned mode, unsigned reg,
260                           ARMword value);
261 extern ARMword ARMul_GetPC (ARMul_State * state);
262 extern ARMword ARMul_GetNextPC (ARMul_State * state);
263 extern void ARMul_SetPC (ARMul_State * state, ARMword value);
264 extern ARMword ARMul_GetR15 (ARMul_State * state);
265 extern void ARMul_SetR15 (ARMul_State * state, ARMword value);
266
267 extern ARMword ARMul_GetCPSR (ARMul_State * state);
268 extern void ARMul_SetCPSR (ARMul_State * state, ARMword value);
269 extern ARMword ARMul_GetSPSR (ARMul_State * state, ARMword mode);
270 extern void ARMul_SetSPSR (ARMul_State * state, ARMword mode, ARMword value);
271
272 /***************************************************************************\
273 *                  Definitons of things to handle aborts                    *
274 \***************************************************************************/
275
276 extern void ARMul_Abort (ARMul_State * state, ARMword address);
277 #define ARMul_ABORTWORD 0xefffffff      /* SWI -1 */
278 #define ARMul_PREFETCHABORT(address) if (state->AbortAddr == 1) \
279                                         state->AbortAddr = (address & ~3L)
280 #define ARMul_DATAABORT(address) state->abortSig = HIGH ; \
281                                  state->Aborted = ARMul_DataAbortV ;
282 #define ARMul_CLEARABORT state->abortSig = LOW
283
284 /***************************************************************************\
285 *              Definitons of things in the memory interface                 *
286 \***************************************************************************/
287
288 extern unsigned ARMul_MemoryInit (ARMul_State * state,
289                                   unsigned long initmemsize);
290 extern void ARMul_MemoryExit (ARMul_State * state);
291
292 extern ARMword ARMul_LoadInstrS (ARMul_State * state, ARMword address,
293                                  ARMword isize);
294 extern ARMword ARMul_LoadInstrN (ARMul_State * state, ARMword address,
295                                  ARMword isize);
296 extern ARMword ARMul_ReLoadInstr (ARMul_State * state, ARMword address,
297                                   ARMword isize);
298
299 extern ARMword ARMul_LoadWordS (ARMul_State * state, ARMword address);
300 extern ARMword ARMul_LoadWordN (ARMul_State * state, ARMword address);
301 extern ARMword ARMul_LoadHalfWord (ARMul_State * state, ARMword address);
302 extern ARMword ARMul_LoadByte (ARMul_State * state, ARMword address);
303
304 extern void ARMul_StoreWordS (ARMul_State * state, ARMword address,
305                               ARMword data);
306 extern void ARMul_StoreWordN (ARMul_State * state, ARMword address,
307                               ARMword data);
308 extern void ARMul_StoreHalfWord (ARMul_State * state, ARMword address,
309                                  ARMword data);
310 extern void ARMul_StoreByte (ARMul_State * state, ARMword address,
311                              ARMword data);
312
313 extern ARMword ARMul_SwapWord (ARMul_State * state, ARMword address,
314                                ARMword data);
315 extern ARMword ARMul_SwapByte (ARMul_State * state, ARMword address,
316                                ARMword data);
317
318 extern void ARMul_Icycles (ARMul_State * state, unsigned number,
319                            ARMword address);
320 extern void ARMul_Ccycles (ARMul_State * state, unsigned number,
321                            ARMword address);
322
323 extern ARMword ARMul_ReadWord (ARMul_State * state, ARMword address);
324 extern ARMword ARMul_ReadByte (ARMul_State * state, ARMword address);
325 extern void ARMul_WriteWord (ARMul_State * state, ARMword address,
326                              ARMword data);
327 extern void ARMul_WriteByte (ARMul_State * state, ARMword address,
328                              ARMword data);
329
330 extern ARMword ARMul_MemAccess (ARMul_State * state, ARMword, ARMword,
331                                 ARMword, ARMword, ARMword, ARMword, ARMword,
332                                 ARMword, ARMword, ARMword);
333
334 /***************************************************************************\
335 *            Definitons of things in the co-processor interface             *
336 \***************************************************************************/
337
338 #define ARMul_FIRST 0
339 #define ARMul_TRANSFER 1
340 #define ARMul_BUSY 2
341 #define ARMul_DATA 3
342 #define ARMul_INTERRUPT 4
343 #define ARMul_DONE 0
344 #define ARMul_CANT 1
345 #define ARMul_INC 3
346
347 extern unsigned ARMul_CoProInit (ARMul_State * state);
348 extern void ARMul_CoProExit (ARMul_State * state);
349 extern void ARMul_CoProAttach (ARMul_State * state, unsigned number,
350                                ARMul_CPInits * init, ARMul_CPExits * exit,
351                                ARMul_LDCs * ldc, ARMul_STCs * stc,
352                                ARMul_MRCs * mrc, ARMul_MCRs * mcr,
353                                ARMul_CDPs * cdp,
354                                ARMul_CPReads * read, ARMul_CPWrites * write);
355 extern void ARMul_CoProDetach (ARMul_State * state, unsigned number);
356
357 /***************************************************************************\
358 *               Definitons of things in the host environment                *
359 \***************************************************************************/
360
361 extern unsigned ARMul_OSInit (ARMul_State * state);
362 extern void ARMul_OSExit (ARMul_State * state);
363 extern unsigned ARMul_OSHandleSWI (ARMul_State * state, ARMword number);
364 extern ARMword ARMul_OSLastErrorP (ARMul_State * state);
365
366 extern ARMword ARMul_Debug (ARMul_State * state, ARMword pc, ARMword instr);
367 extern unsigned ARMul_OSException (ARMul_State * state, ARMword vector,
368                                    ARMword pc);
369 extern int rdi_log;
370
371 /***************************************************************************\
372 *                            Host-dependent stuff                           *
373 \***************************************************************************/
374
375 #ifdef macintosh
376 pascal void SpinCursor (short increment);       /* copied from CursorCtl.h */
377 # define HOURGLASS           SpinCursor( 1 )
378 # define HOURGLASS_RATE      1023       /* 2^n - 1 */
379 #endif
380
381 extern void ARMul_UndefInstr      (ARMul_State *, ARMword);
382 extern void ARMul_FixCPSR         (ARMul_State *, ARMword, ARMword);
383 extern void ARMul_FixSPSR         (ARMul_State *, ARMword, ARMword);
384 extern void ARMul_ConsolePrint    (ARMul_State *, const char *, ...);
385 extern void ARMul_SelectProcessor (ARMul_State *, unsigned);