suppressed explicit access type and use the exception routine to infer it from the...
[qemu] / target-ppc / cpu.h
1 /*
2  *  PPC emulation cpu definitions for qemu.
3  * 
4  *  Copyright (c) 2003 Jocelyn Mayer
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this library; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19  */
20 #if !defined (__CPU_PPC_H__)
21 #define __CPU_PPC_H__
22
23 #include <endian.h>
24 #include <asm/byteorder.h>
25
26 #include "cpu-defs.h"
27
28 //#define USE_OPEN_FIRMWARE
29
30 /***                          Sign extend constants                        ***/
31 /* 8 to 32 bits */
32 static inline int32_t s_ext8 (uint8_t value)
33 {
34     int8_t *tmp = &value;
35
36     return *tmp;
37 }
38
39 /* 16 to 32 bits */
40 static inline int32_t s_ext16 (uint16_t value)
41 {
42     int16_t *tmp = &value;
43
44     return *tmp;
45 }
46
47 /* 24 to 32 bits */
48 static inline int32_t s_ext24 (uint32_t value)
49 {
50     uint16_t utmp = (value >> 8) & 0xFFFF;
51     int16_t *tmp = &utmp;
52
53     return (*tmp << 8) | (value & 0xFF);
54 }
55
56 #include "config.h"
57 #include <setjmp.h>
58
59 /* Instruction types */
60 enum {
61     PPC_NONE     = 0x0000,
62     PPC_INTEGER  = 0x0001, /* CPU has integer operations instructions        */
63     PPC_FLOAT    = 0x0002, /* CPU has floating point operations instructions */
64     PPC_FLOW     = 0x0004, /* CPU has flow control instructions              */
65     PPC_MEM      = 0x0008, /* CPU has virtual memory instructions            */
66     PPC_RES      = 0x0010, /* CPU has ld/st with reservation instructions    */
67     PPC_CACHE    = 0x0020, /* CPU has cache control instructions             */
68     PPC_MISC     = 0x0040, /* CPU has spr/msr access instructions            */
69     PPC_EXTERN   = 0x0080, /* CPU has external control instructions          */
70     PPC_SEGMENT  = 0x0100, /* CPU has memory segment instructions            */
71     PPC_CACHE_OPT= 0x0200,
72     PPC_FLOAT_OPT= 0x0400,
73     PPC_MEM_OPT  = 0x0800,
74 };
75
76 #define PPC_COMMON  (PPC_INTEGER | PPC_FLOAT | PPC_FLOW | PPC_MEM |           \
77                      PPC_RES | PPC_CACHE | PPC_MISC | PPC_SEGMENT)
78 /* PPC 740/745/750/755 (aka G3) has external access instructions */
79 #define PPC_750 (PPC_INTEGER | PPC_FLOAT | PPC_FLOW | PPC_MEM |               \
80                  PPC_RES | PPC_CACHE | PPC_MISC | PPC_EXTERN | PPC_SEGMENT)
81
82 /* Supervisor mode registers */
83 /* Machine state register */
84 #define MSR_POW 18
85 #define MSR_ILE 16
86 #define MSR_EE  15
87 #define MSR_PR  14
88 #define MSR_FP  13
89 #define MSR_ME  12
90 #define MSR_FE0 11
91 #define MSR_SE  10
92 #define MSR_BE  9
93 #define MSR_FE1 8
94 #define MSR_IP 6
95 #define MSR_IR 5
96 #define MSR_DR 4
97 #define MSR_RI 1
98 #define MSR_LE 0
99 #define msr_pow env->msr[MSR_POW]
100 #define msr_ile env->msr[MSR_ILE]
101 #define msr_ee  env->msr[MSR_EE]
102 #define msr_pr  env->msr[MSR_PR]
103 #define msr_fp  env->msr[MSR_FP]
104 #define msr_me  env->msr[MSR_ME]
105 #define msr_fe0 env->msr[MSR_FE0]
106 #define msr_se  env->msr[MSR_SE]
107 #define msr_be  env->msr[MSR_BE]
108 #define msr_fe1 env->msr[MSR_FE1]
109 #define msr_ip  env->msr[MSR_IP]
110 #define msr_ir  env->msr[MSR_IR]
111 #define msr_dr  env->msr[MSR_DR]
112 #define msr_ri  env->msr[MSR_RI]
113 #define msr_le  env->msr[MSR_LE]
114
115 /* Segment registers */
116 typedef struct CPUPPCState {
117     /* general purpose registers */
118     uint32_t gpr[32];
119     /* floating point registers */
120     double fpr[32];
121     /* segment registers */
122     uint32_t sdr1;
123     uint32_t sr[16];
124     /* XER */
125     uint8_t xer[4];
126     /* Reservation address */
127     uint32_t reserve;
128     /* machine state register */
129     uint8_t msr[32];
130     /* condition register */
131     uint8_t crf[8];
132     /* floating point status and control register */
133     uint8_t fpscr[8];
134     uint32_t nip;
135     /* special purpose registers */
136     uint32_t lr;
137     uint32_t ctr;
138     /* Time base */
139     uint32_t tb[2];
140     /* decrementer */
141     uint32_t decr;
142     /* BATs */
143     uint32_t DBAT[2][8];
144     uint32_t IBAT[2][8];
145     /* all others */
146     uint32_t spr[1024];
147     /* qemu dedicated */
148      /* temporary float registers */
149     double ft0;
150     double ft1;
151     double ft2;
152     int interrupt_request;
153     jmp_buf jmp_env;
154     int exception_index;
155     int error_code;
156     int access_type; /* when a memory exception occurs, the access
157                         type is stored here */
158     uint32_t exceptions; /* exception queue */
159     uint32_t errors[16];
160     int user_mode_only; /* user mode only simulation */
161     struct TranslationBlock *current_tb; /* currently executing TB */
162     /* soft mmu support */
163     /* 0 = kernel, 1 = user */
164     CPUTLBEntry tlb_read[2][CPU_TLB_SIZE];
165     CPUTLBEntry tlb_write[2][CPU_TLB_SIZE];
166     /* user data */
167     void *opaque;
168 } CPUPPCState;
169
170 CPUPPCState *cpu_ppc_init(void);
171 int cpu_ppc_exec(CPUPPCState *s);
172 void cpu_ppc_close(CPUPPCState *s);
173 /* you can call this signal handler from your SIGBUS and SIGSEGV
174    signal handlers to inform the virtual CPU of exceptions. non zero
175    is returned if the signal was handled by the virtual CPU.  */
176 struct siginfo;
177 int cpu_ppc_signal_handler(int host_signum, struct siginfo *info, 
178                            void *puc);
179
180 void cpu_ppc_dump_state(CPUPPCState *env, FILE *f, int flags);
181 void cpu_loop_exit(void);
182 void dump_stack (CPUPPCState *env);
183 uint32_t _load_xer (void);
184 void _store_xer (uint32_t value);
185 uint32_t _load_msr (void);
186 void _store_msr (uint32_t value);
187 void do_interrupt (CPUPPCState *env);
188
189 #define TARGET_PAGE_BITS 12
190 #include "cpu-all.h"
191
192 #define ugpr(n) (env->gpr[n])
193 #define fprd(n) (env->fpr[n])
194 #define fprs(n) ((float)env->fpr[n])
195 #define fpru(n) ((uint32_t)env->fpr[n])
196 #define fpri(n) ((int32_t)env->fpr[n])
197
198 #define SPR_ENCODE(sprn)                               \
199 (((sprn) >> 5) | (((sprn) & 0x1F) << 5))
200
201 /* User mode SPR */
202 #define spr(n) env->spr[n]
203 #define XER_SO 31
204 #define XER_OV 30
205 #define XER_CA 29
206 #define XER_BC 0
207 #define xer_so env->xer[3]
208 #define xer_ov env->xer[2]
209 #define xer_ca env->xer[1]
210 #define xer_bc env->xer[0]
211
212 #define XER    SPR_ENCODE(1)
213 #define LR     SPR_ENCODE(8)
214 #define CTR    SPR_ENCODE(9)
215 /* VEA mode SPR */
216 #define V_TBL  SPR_ENCODE(268)
217 #define V_TBU  SPR_ENCODE(269)
218 /* supervisor mode SPR */
219 #define DSISR  SPR_ENCODE(18)
220 #define DAR    SPR_ENCODE(19)
221 #define DECR   SPR_ENCODE(22)
222 #define SDR1   SPR_ENCODE(25)
223 #define SRR0   SPR_ENCODE(26)
224 #define SRR1   SPR_ENCODE(27)
225 #define SPRG0  SPR_ENCODE(272)
226 #define SPRG1  SPR_ENCODE(273)
227 #define SPRG2  SPR_ENCODE(274)
228 #define SPRG3  SPR_ENCODE(275)
229 #define SPRG4  SPR_ENCODE(276)
230 #define SPRG5  SPR_ENCODE(277)
231 #define SPRG6  SPR_ENCODE(278)
232 #define SPRG7  SPR_ENCODE(279)
233 #define ASR    SPR_ENCODE(280)
234 #define EAR    SPR_ENCODE(282)
235 #define O_TBL  SPR_ENCODE(284)
236 #define O_TBU  SPR_ENCODE(285)
237 #define PVR    SPR_ENCODE(287)
238 #define IBAT0U SPR_ENCODE(528)
239 #define IBAT0L SPR_ENCODE(529)
240 #define IBAT1U SPR_ENCODE(530)
241 #define IBAT1L SPR_ENCODE(531)
242 #define IBAT2U SPR_ENCODE(532)
243 #define IBAT2L SPR_ENCODE(533)
244 #define IBAT3U SPR_ENCODE(534)
245 #define IBAT3L SPR_ENCODE(535)
246 #define DBAT0U SPR_ENCODE(536)
247 #define DBAT0L SPR_ENCODE(537)
248 #define DBAT1U SPR_ENCODE(538)
249 #define DBAT1L SPR_ENCODE(539)
250 #define DBAT2U SPR_ENCODE(540)
251 #define DBAT2L SPR_ENCODE(541)
252 #define DBAT3U SPR_ENCODE(542)
253 #define DBAT3L SPR_ENCODE(543)
254 #define IBAT4U SPR_ENCODE(560)
255 #define IBAT4L SPR_ENCODE(561)
256 #define IBAT5U SPR_ENCODE(562)
257 #define IBAT5L SPR_ENCODE(563)
258 #define IBAT6U SPR_ENCODE(564)
259 #define IBAT6L SPR_ENCODE(565)
260 #define IBAT7U SPR_ENCODE(566)
261 #define IBAT7L SPR_ENCODE(567)
262 #define DBAT4U SPR_ENCODE(568)
263 #define DBAT4L SPR_ENCODE(569)
264 #define DBAT5U SPR_ENCODE(570)
265 #define DBAT5L SPR_ENCODE(571)
266 #define DBAT6U SPR_ENCODE(572)
267 #define DBAT6L SPR_ENCODE(573)
268 #define DBAT7U SPR_ENCODE(574)
269 #define DBAT7L SPR_ENCODE(575)
270 #define DABR   SPR_ENCODE(1013)
271 #define DABR_MASK 0xFFFFFFF8
272 #define FPECR  SPR_ENCODE(1022)
273 #define PIR    SPR_ENCODE(1023)
274
275 #define TARGET_PAGE_BITS 12
276 #include "cpu-all.h"
277
278 CPUPPCState *cpu_ppc_init(void);
279 int cpu_ppc_exec(CPUPPCState *s);
280 void cpu_ppc_close(CPUPPCState *s);
281 void cpu_ppc_dump_state(CPUPPCState *env, FILE *f, int flags);
282 void PPC_init_hw (CPUPPCState *env, uint32_t mem_size,
283                   uint32_t kernel_addr, uint32_t kernel_size,
284                   uint32_t stack_addr, int boot_device);
285
286 /* Memory access type :
287  * may be needed for precise access rights control and precise exceptions.
288  */
289 enum {
290     /* 1 bit to define user level / supervisor access */
291     ACCESS_USER  = 0x00,
292     ACCESS_SUPER = 0x01,
293     /* Type of instruction that generated the access */
294     ACCESS_CODE  = 0x10, /* Code fetch access                */
295     ACCESS_INT   = 0x20, /* Integer load/store access        */
296     ACCESS_FLOAT = 0x30, /* floating point load/store access */
297     ACCESS_RES   = 0x40, /* load/store with reservation      */
298     ACCESS_EXT   = 0x50, /* external access                  */
299     ACCESS_CACHE = 0x60, /* Cache manipulation               */
300 };
301
302 /*****************************************************************************/
303 /* Exceptions */
304 enum {
305     EXCP_NONE          = -1,
306     /* PPC hardware exceptions : exception vector / 0x100 */
307     EXCP_RESET         = 0x01, /* System reset                     */
308     EXCP_MACHINE_CHECK = 0x02, /* Machine check exception          */
309     EXCP_DSI           = 0x03, /* Impossible memory access         */
310     EXCP_ISI           = 0x04, /* Impossible instruction fetch     */
311     EXCP_EXTERNAL      = 0x05, /* External interruption            */
312     EXCP_ALIGN         = 0x06, /* Alignment exception              */
313     EXCP_PROGRAM       = 0x07, /* Program exception                */
314     EXCP_NO_FP         = 0x08, /* No floating point                */
315     EXCP_DECR          = 0x09, /* Decrementer exception            */
316     EXCP_RESA          = 0x0A, /* Implementation specific          */
317     EXCP_RESB          = 0x0B, /* Implementation specific          */
318     EXCP_SYSCALL       = 0x0C, /* System call                      */
319     EXCP_TRACE         = 0x0D, /* Trace exception (optional)       */
320     EXCP_FP_ASSIST     = 0x0E, /* Floating-point assist (optional) */
321     /* MPC740/745/750 & IBM 750 */
322     EXCP_PERF          = 0x0F,  /* Performance monitor              */
323     EXCP_IABR          = 0x13,  /* Instruction address breakpoint   */
324     EXCP_SMI           = 0x14,  /* System management interrupt      */
325     EXCP_THRM          = 0x15,  /* Thermal management interrupt     */
326     /* MPC755 */
327     EXCP_TLBMISS       = 0x10,  /* Instruction TLB miss             */
328     EXCP_TLBMISS_DL    = 0x11,  /* Data TLB miss for load           */
329     EXCP_TLBMISS_DS    = 0x12,  /* Data TLB miss for store          */
330     EXCP_PPC_MAX       = 0x16,
331     /* Qemu exception */
332     EXCP_OFCALL        = 0x20,  /* Call open-firmware emulator      */
333     EXCP_RTASCALL      = 0x21,  /* Call RTAS emulator               */
334     /* Special cases where we want to stop translation */
335     EXCP_MTMSR         = 0x104, /* mtmsr instruction:               */
336                                 /* may change privilege level       */
337     EXCP_BRANCH        = 0x108, /* branch instruction               */
338     EXCP_RFI           = 0x10C, /* return from interrupt            */
339     EXCP_SYSCALL_USER  = 0x110, /* System call in user mode only    */
340 };
341 /* Error codes */
342 enum {
343     /* Exception subtypes for EXCP_DSI                              */
344     EXCP_DSI_TRANSLATE = 0x01,  /* Data address can't be translated */
345     EXCP_DSI_NOTSUP    = 0x02,  /* Access type not supported        */
346     EXCP_DSI_PROT      = 0x03,  /* Memory protection violation      */
347     EXCP_DSI_EXTERNAL  = 0x04,  /* External access disabled         */
348     EXCP_DSI_DABR      = 0x05,  /* Data address breakpoint          */
349     /* flags for EXCP_DSI */
350     EXCP_DSI_DIRECT    = 0x10,
351     EXCP_DSI_STORE     = 0x20,
352     EXCP_ECXW          = 0x40,
353     /* Exception subtypes for EXCP_ISI                              */
354     EXCP_ISI_TRANSLATE = 0x01,  /* Code address can't be translated */
355     EXCP_ISI_NOEXEC    = 0x02,  /* Try to fetch from a data segment */
356     EXCP_ISI_GUARD     = 0x03,  /* Fetch from guarded memory        */
357     EXCP_ISI_PROT      = 0x04,  /* Memory protection violation      */
358     /* Exception subtypes for EXCP_ALIGN                            */
359     EXCP_ALIGN_FP      = 0x01,  /* FP alignment exception           */
360     EXCP_ALIGN_LST     = 0x02,  /* Unaligned mult/extern load/store */
361     EXCP_ALIGN_LE      = 0x03,  /* Multiple little-endian access    */
362     EXCP_ALIGN_PROT    = 0x04,  /* Access cross protection boundary */
363     EXCP_ALIGN_BAT     = 0x05,  /* Access cross a BAT/seg boundary  */
364     EXCP_ALIGN_CACHE   = 0x06,  /* Impossible dcbz access           */
365     /* Exception subtypes for EXCP_PROGRAM                          */
366     /* FP exceptions */
367     EXCP_FP            = 0x10,
368     EXCP_FP_OX         = 0x01,  /* FP overflow                      */
369     EXCP_FP_UX         = 0x02,  /* FP underflow                     */
370     EXCP_FP_ZX         = 0x03,  /* FP divide by zero                */
371     EXCP_FP_XX         = 0x04,  /* FP inexact                       */
372     EXCP_FP_VXNAN      = 0x05,  /* FP invalid SNaN op               */
373     EXCP_FP_VXISI      = 0x06,  /* FP invalid infinite substraction */
374     EXCP_FP_VXIDI      = 0x07,  /* FP invalid infinite divide       */
375     EXCP_FP_VXZDZ      = 0x08,  /* FP invalid zero divide           */
376     EXCP_FP_VXIMZ      = 0x09,  /* FP invalid infinite * zero       */
377     EXCP_FP_VXVC       = 0x0A,  /* FP invalid compare               */
378     EXCP_FP_VXSOFT     = 0x0B,  /* FP invalid operation             */
379     EXCP_FP_VXSQRT     = 0x0C,  /* FP invalid square root           */
380     EXCP_FP_VXCVI      = 0x0D,  /* FP invalid integer conversion    */
381     /* Invalid instruction */
382     EXCP_INVAL         = 0x20,
383     EXCP_INVAL_INVAL   = 0x01,  /* Invalid instruction              */
384     EXCP_INVAL_LSWX    = 0x02,  /* Invalid lswx instruction         */
385     EXCP_INVAL_SPR     = 0x03,  /* Invalid SPR access               */
386     EXCP_INVAL_FP      = 0x04,  /* Unimplemented mandatory fp instr */
387     /* Privileged instruction */
388     EXCP_PRIV          = 0x30,
389     EXCP_PRIV_OPC      = 0x01,
390     EXCP_PRIV_REG      = 0x02,
391     /* Trap */
392     EXCP_TRAP          = 0x40,
393 };
394
395 /*****************************************************************************/
396
397 #endif /* !defined (__CPU_PPC_H__) */