Merge remote-tracking branch 'kwolf/for-anthony' into staging
[qemu.git] / target-arm / cpu.h
blob01f5b57fbc2698636c73213d991d33dbe6100d67
1 /*
2 * ARM virtual CPU header
4 * Copyright (c) 2003 Fabrice Bellard
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.
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.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, see <http://www.gnu.org/licenses/>.
19 #ifndef CPU_ARM_H
20 #define CPU_ARM_H
22 #define TARGET_LONG_BITS 32
24 #define ELF_MACHINE EM_ARM
26 #define CPUState struct CPUARMState
28 #include "config.h"
29 #include "qemu-common.h"
30 #include "cpu-defs.h"
32 #include "softfloat.h"
34 #define TARGET_HAS_ICE 1
36 #define EXCP_UDEF 1 /* undefined instruction */
37 #define EXCP_SWI 2 /* software interrupt */
38 #define EXCP_PREFETCH_ABORT 3
39 #define EXCP_DATA_ABORT 4
40 #define EXCP_IRQ 5
41 #define EXCP_FIQ 6
42 #define EXCP_BKPT 7
43 #define EXCP_EXCEPTION_EXIT 8 /* Return from v7M exception. */
44 #define EXCP_KERNEL_TRAP 9 /* Jumped to kernel code page. */
45 #define EXCP_STREX 10
47 #define ARMV7M_EXCP_RESET 1
48 #define ARMV7M_EXCP_NMI 2
49 #define ARMV7M_EXCP_HARD 3
50 #define ARMV7M_EXCP_MEM 4
51 #define ARMV7M_EXCP_BUS 5
52 #define ARMV7M_EXCP_USAGE 6
53 #define ARMV7M_EXCP_SVC 11
54 #define ARMV7M_EXCP_DEBUG 12
55 #define ARMV7M_EXCP_PENDSV 14
56 #define ARMV7M_EXCP_SYSTICK 15
58 /* ARM-specific interrupt pending bits. */
59 #define CPU_INTERRUPT_FIQ CPU_INTERRUPT_TGT_EXT_1
62 typedef void ARMWriteCPFunc(void *opaque, int cp_info,
63 int srcreg, int operand, uint32_t value);
64 typedef uint32_t ARMReadCPFunc(void *opaque, int cp_info,
65 int dstreg, int operand);
67 struct arm_boot_info;
69 #define NB_MMU_MODES 2
71 /* We currently assume float and double are IEEE single and double
72 precision respectively.
73 Doing runtime conversions is tricky because VFP registers may contain
74 integer values (eg. as the result of a FTOSI instruction).
75 s<2n> maps to the least significant half of d<n>
76 s<2n+1> maps to the most significant half of d<n>
79 typedef struct CPUARMState {
80 /* Regs for current mode. */
81 uint32_t regs[16];
82 /* Frequently accessed CPSR bits are stored separately for efficiently.
83 This contains all the other bits. Use cpsr_{read,write} to access
84 the whole CPSR. */
85 uint32_t uncached_cpsr;
86 uint32_t spsr;
88 /* Banked registers. */
89 uint32_t banked_spsr[6];
90 uint32_t banked_r13[6];
91 uint32_t banked_r14[6];
93 /* These hold r8-r12. */
94 uint32_t usr_regs[5];
95 uint32_t fiq_regs[5];
97 /* cpsr flag cache for faster execution */
98 uint32_t CF; /* 0 or 1 */
99 uint32_t VF; /* V is the bit 31. All other bits are undefined */
100 uint32_t NF; /* N is bit 31. All other bits are undefined. */
101 uint32_t ZF; /* Z set if zero. */
102 uint32_t QF; /* 0 or 1 */
103 uint32_t GE; /* cpsr[19:16] */
104 uint32_t thumb; /* cpsr[5]. 0 = arm mode, 1 = thumb mode. */
105 uint32_t condexec_bits; /* IT bits. cpsr[15:10,26:25]. */
107 /* System control coprocessor (cp15) */
108 struct {
109 uint32_t c0_cpuid;
110 uint32_t c0_cachetype;
111 uint32_t c0_ccsid[16]; /* Cache size. */
112 uint32_t c0_clid; /* Cache level. */
113 uint32_t c0_cssel; /* Cache size selection. */
114 uint32_t c0_c1[8]; /* Feature registers. */
115 uint32_t c0_c2[8]; /* Instruction set registers. */
116 uint32_t c1_sys; /* System control register. */
117 uint32_t c1_coproc; /* Coprocessor access register. */
118 uint32_t c1_xscaleauxcr; /* XScale auxiliary control register. */
119 uint32_t c2_base0; /* MMU translation table base 0. */
120 uint32_t c2_base1; /* MMU translation table base 1. */
121 uint32_t c2_control; /* MMU translation table base control. */
122 uint32_t c2_mask; /* MMU translation table base selection mask. */
123 uint32_t c2_base_mask; /* MMU translation table base 0 mask. */
124 uint32_t c2_data; /* MPU data cachable bits. */
125 uint32_t c2_insn; /* MPU instruction cachable bits. */
126 uint32_t c3; /* MMU domain access control register
127 MPU write buffer control. */
128 uint32_t c5_insn; /* Fault status registers. */
129 uint32_t c5_data;
130 uint32_t c6_region[8]; /* MPU base/size registers. */
131 uint32_t c6_insn; /* Fault address registers. */
132 uint32_t c6_data;
133 uint32_t c7_par; /* Translation result. */
134 uint32_t c9_insn; /* Cache lockdown registers. */
135 uint32_t c9_data;
136 uint32_t c13_fcse; /* FCSE PID. */
137 uint32_t c13_context; /* Context ID. */
138 uint32_t c13_tls1; /* User RW Thread register. */
139 uint32_t c13_tls2; /* User RO Thread register. */
140 uint32_t c13_tls3; /* Privileged Thread register. */
141 uint32_t c15_cpar; /* XScale Coprocessor Access Register */
142 uint32_t c15_ticonfig; /* TI925T configuration byte. */
143 uint32_t c15_i_max; /* Maximum D-cache dirty line index. */
144 uint32_t c15_i_min; /* Minimum D-cache dirty line index. */
145 uint32_t c15_threadid; /* TI debugger thread-ID. */
146 } cp15;
148 struct {
149 uint32_t other_sp;
150 uint32_t vecbase;
151 uint32_t basepri;
152 uint32_t control;
153 int current_sp;
154 int exception;
155 int pending_exception;
156 } v7m;
158 /* Thumb-2 EE state. */
159 uint32_t teecr;
160 uint32_t teehbr;
162 /* Internal CPU feature flags. */
163 uint32_t features;
165 /* VFP coprocessor state. */
166 struct {
167 float64 regs[32];
169 uint32_t xregs[16];
170 /* We store these fpcsr fields separately for convenience. */
171 int vec_len;
172 int vec_stride;
174 /* scratch space when Tn are not sufficient. */
175 uint32_t scratch[8];
177 /* fp_status is the "normal" fp status. standard_fp_status retains
178 * values corresponding to the ARM "Standard FPSCR Value", ie
179 * default-NaN, flush-to-zero, round-to-nearest and is used by
180 * any operations (generally Neon) which the architecture defines
181 * as controlled by the standard FPSCR value rather than the FPSCR.
183 * To avoid having to transfer exception bits around, we simply
184 * say that the FPSCR cumulative exception flags are the logical
185 * OR of the flags in the two fp statuses. This relies on the
186 * only thing which needs to read the exception flags being
187 * an explicit FPSCR read.
189 float_status fp_status;
190 float_status standard_fp_status;
191 } vfp;
192 uint32_t exclusive_addr;
193 uint32_t exclusive_val;
194 uint32_t exclusive_high;
195 #if defined(CONFIG_USER_ONLY)
196 uint32_t exclusive_test;
197 uint32_t exclusive_info;
198 #endif
200 /* iwMMXt coprocessor state. */
201 struct {
202 uint64_t regs[16];
203 uint64_t val;
205 uint32_t cregs[16];
206 } iwmmxt;
208 #if defined(CONFIG_USER_ONLY)
209 /* For usermode syscall translation. */
210 int eabi;
211 #endif
213 CPU_COMMON
215 /* These fields after the common ones so they are preserved on reset. */
217 /* Coprocessor IO used by peripherals */
218 struct {
219 ARMReadCPFunc *cp_read;
220 ARMWriteCPFunc *cp_write;
221 void *opaque;
222 } cp[15];
223 void *nvic;
224 struct arm_boot_info *boot_info;
225 } CPUARMState;
227 CPUARMState *cpu_arm_init(const char *cpu_model);
228 void arm_translate_init(void);
229 int cpu_arm_exec(CPUARMState *s);
230 void cpu_arm_close(CPUARMState *s);
231 void do_interrupt(CPUARMState *);
232 void switch_mode(CPUARMState *, int);
233 uint32_t do_arm_semihosting(CPUARMState *env);
235 /* you can call this signal handler from your SIGBUS and SIGSEGV
236 signal handlers to inform the virtual CPU of exceptions. non zero
237 is returned if the signal was handled by the virtual CPU. */
238 int cpu_arm_signal_handler(int host_signum, void *pinfo,
239 void *puc);
240 int cpu_arm_handle_mmu_fault (CPUARMState *env, target_ulong address, int rw,
241 int mmu_idx, int is_softmuu);
242 #define cpu_handle_mmu_fault cpu_arm_handle_mmu_fault
244 static inline void cpu_set_tls(CPUARMState *env, target_ulong newtls)
246 env->cp15.c13_tls2 = newtls;
249 #define CPSR_M (0x1f)
250 #define CPSR_T (1 << 5)
251 #define CPSR_F (1 << 6)
252 #define CPSR_I (1 << 7)
253 #define CPSR_A (1 << 8)
254 #define CPSR_E (1 << 9)
255 #define CPSR_IT_2_7 (0xfc00)
256 #define CPSR_GE (0xf << 16)
257 #define CPSR_RESERVED (0xf << 20)
258 #define CPSR_J (1 << 24)
259 #define CPSR_IT_0_1 (3 << 25)
260 #define CPSR_Q (1 << 27)
261 #define CPSR_V (1 << 28)
262 #define CPSR_C (1 << 29)
263 #define CPSR_Z (1 << 30)
264 #define CPSR_N (1 << 31)
265 #define CPSR_NZCV (CPSR_N | CPSR_Z | CPSR_C | CPSR_V)
267 #define CPSR_IT (CPSR_IT_0_1 | CPSR_IT_2_7)
268 #define CACHED_CPSR_BITS (CPSR_T | CPSR_GE | CPSR_IT | CPSR_Q | CPSR_NZCV)
269 /* Bits writable in user mode. */
270 #define CPSR_USER (CPSR_NZCV | CPSR_Q | CPSR_GE)
271 /* Execution state bits. MRS read as zero, MSR writes ignored. */
272 #define CPSR_EXEC (CPSR_T | CPSR_IT | CPSR_J)
274 /* Return the current CPSR value. */
275 uint32_t cpsr_read(CPUARMState *env);
276 /* Set the CPSR. Note that some bits of mask must be all-set or all-clear. */
277 void cpsr_write(CPUARMState *env, uint32_t val, uint32_t mask);
279 /* Return the current xPSR value. */
280 static inline uint32_t xpsr_read(CPUARMState *env)
282 int ZF;
283 ZF = (env->ZF == 0);
284 return (env->NF & 0x80000000) | (ZF << 30)
285 | (env->CF << 29) | ((env->VF & 0x80000000) >> 3) | (env->QF << 27)
286 | (env->thumb << 24) | ((env->condexec_bits & 3) << 25)
287 | ((env->condexec_bits & 0xfc) << 8)
288 | env->v7m.exception;
291 /* Set the xPSR. Note that some bits of mask must be all-set or all-clear. */
292 static inline void xpsr_write(CPUARMState *env, uint32_t val, uint32_t mask)
294 if (mask & CPSR_NZCV) {
295 env->ZF = (~val) & CPSR_Z;
296 env->NF = val;
297 env->CF = (val >> 29) & 1;
298 env->VF = (val << 3) & 0x80000000;
300 if (mask & CPSR_Q)
301 env->QF = ((val & CPSR_Q) != 0);
302 if (mask & (1 << 24))
303 env->thumb = ((val & (1 << 24)) != 0);
304 if (mask & CPSR_IT_0_1) {
305 env->condexec_bits &= ~3;
306 env->condexec_bits |= (val >> 25) & 3;
308 if (mask & CPSR_IT_2_7) {
309 env->condexec_bits &= 3;
310 env->condexec_bits |= (val >> 8) & 0xfc;
312 if (mask & 0x1ff) {
313 env->v7m.exception = val & 0x1ff;
317 /* Return the current FPSCR value. */
318 uint32_t vfp_get_fpscr(CPUARMState *env);
319 void vfp_set_fpscr(CPUARMState *env, uint32_t val);
321 enum arm_cpu_mode {
322 ARM_CPU_MODE_USR = 0x10,
323 ARM_CPU_MODE_FIQ = 0x11,
324 ARM_CPU_MODE_IRQ = 0x12,
325 ARM_CPU_MODE_SVC = 0x13,
326 ARM_CPU_MODE_ABT = 0x17,
327 ARM_CPU_MODE_UND = 0x1b,
328 ARM_CPU_MODE_SYS = 0x1f
331 /* VFP system registers. */
332 #define ARM_VFP_FPSID 0
333 #define ARM_VFP_FPSCR 1
334 #define ARM_VFP_MVFR1 6
335 #define ARM_VFP_MVFR0 7
336 #define ARM_VFP_FPEXC 8
337 #define ARM_VFP_FPINST 9
338 #define ARM_VFP_FPINST2 10
340 /* iwMMXt coprocessor control registers. */
341 #define ARM_IWMMXT_wCID 0
342 #define ARM_IWMMXT_wCon 1
343 #define ARM_IWMMXT_wCSSF 2
344 #define ARM_IWMMXT_wCASF 3
345 #define ARM_IWMMXT_wCGR0 8
346 #define ARM_IWMMXT_wCGR1 9
347 #define ARM_IWMMXT_wCGR2 10
348 #define ARM_IWMMXT_wCGR3 11
350 enum arm_features {
351 ARM_FEATURE_VFP,
352 ARM_FEATURE_AUXCR, /* ARM1026 Auxiliary control register. */
353 ARM_FEATURE_XSCALE, /* Intel XScale extensions. */
354 ARM_FEATURE_IWMMXT, /* Intel iwMMXt extension. */
355 ARM_FEATURE_V6,
356 ARM_FEATURE_V6K,
357 ARM_FEATURE_V7,
358 ARM_FEATURE_THUMB2,
359 ARM_FEATURE_MPU, /* Only has Memory Protection Unit, not full MMU. */
360 ARM_FEATURE_VFP3,
361 ARM_FEATURE_VFP_FP16,
362 ARM_FEATURE_NEON,
363 ARM_FEATURE_DIV,
364 ARM_FEATURE_M, /* Microcontroller profile. */
365 ARM_FEATURE_OMAPCP, /* OMAP specific CP15 ops handling. */
366 ARM_FEATURE_THUMB2EE,
367 ARM_FEATURE_V7MP, /* v7 Multiprocessing Extensions */
368 ARM_FEATURE_V4T,
369 ARM_FEATURE_V5,
370 ARM_FEATURE_STRONGARM,
373 static inline int arm_feature(CPUARMState *env, int feature)
375 return (env->features & (1u << feature)) != 0;
378 void arm_cpu_list(FILE *f, fprintf_function cpu_fprintf);
380 /* Interface between CPU and Interrupt controller. */
381 void armv7m_nvic_set_pending(void *opaque, int irq);
382 int armv7m_nvic_acknowledge_irq(void *opaque);
383 void armv7m_nvic_complete_irq(void *opaque, int irq);
385 void cpu_arm_set_cp_io(CPUARMState *env, int cpnum,
386 ARMReadCPFunc *cp_read, ARMWriteCPFunc *cp_write,
387 void *opaque);
389 /* Does the core conform to the the "MicroController" profile. e.g. Cortex-M3.
390 Note the M in older cores (eg. ARM7TDMI) stands for Multiply. These are
391 conventional cores (ie. Application or Realtime profile). */
393 #define IS_M(env) arm_feature(env, ARM_FEATURE_M)
394 #define ARM_CPUID(env) (env->cp15.c0_cpuid)
396 #define ARM_CPUID_ARM1026 0x4106a262
397 #define ARM_CPUID_ARM926 0x41069265
398 #define ARM_CPUID_ARM946 0x41059461
399 #define ARM_CPUID_TI915T 0x54029152
400 #define ARM_CPUID_TI925T 0x54029252
401 #define ARM_CPUID_SA1100 0x4401A11B
402 #define ARM_CPUID_SA1110 0x6901B119
403 #define ARM_CPUID_PXA250 0x69052100
404 #define ARM_CPUID_PXA255 0x69052d00
405 #define ARM_CPUID_PXA260 0x69052903
406 #define ARM_CPUID_PXA261 0x69052d05
407 #define ARM_CPUID_PXA262 0x69052d06
408 #define ARM_CPUID_PXA270 0x69054110
409 #define ARM_CPUID_PXA270_A0 0x69054110
410 #define ARM_CPUID_PXA270_A1 0x69054111
411 #define ARM_CPUID_PXA270_B0 0x69054112
412 #define ARM_CPUID_PXA270_B1 0x69054113
413 #define ARM_CPUID_PXA270_C0 0x69054114
414 #define ARM_CPUID_PXA270_C5 0x69054117
415 #define ARM_CPUID_ARM1136 0x4117b363
416 #define ARM_CPUID_ARM1136_R2 0x4107b362
417 #define ARM_CPUID_ARM11MPCORE 0x410fb022
418 #define ARM_CPUID_CORTEXA8 0x410fc080
419 #define ARM_CPUID_CORTEXA9 0x410fc090
420 #define ARM_CPUID_CORTEXM3 0x410fc231
421 #define ARM_CPUID_ANY 0xffffffff
423 #if defined(CONFIG_USER_ONLY)
424 #define TARGET_PAGE_BITS 12
425 #else
426 /* The ARM MMU allows 1k pages. */
427 /* ??? Linux doesn't actually use these, and they're deprecated in recent
428 architecture revisions. Maybe a configure option to disable them. */
429 #define TARGET_PAGE_BITS 10
430 #endif
432 #define TARGET_PHYS_ADDR_SPACE_BITS 32
433 #define TARGET_VIRT_ADDR_SPACE_BITS 32
435 #define cpu_init cpu_arm_init
436 #define cpu_exec cpu_arm_exec
437 #define cpu_gen_code cpu_arm_gen_code
438 #define cpu_signal_handler cpu_arm_signal_handler
439 #define cpu_list arm_cpu_list
441 #define CPU_SAVE_VERSION 3
443 /* MMU modes definitions */
444 #define MMU_MODE0_SUFFIX _kernel
445 #define MMU_MODE1_SUFFIX _user
446 #define MMU_USER_IDX 1
447 static inline int cpu_mmu_index (CPUState *env)
449 return (env->uncached_cpsr & CPSR_M) == ARM_CPU_MODE_USR ? 1 : 0;
452 #if defined(CONFIG_USER_ONLY)
453 static inline void cpu_clone_regs(CPUState *env, target_ulong newsp)
455 if (newsp)
456 env->regs[13] = newsp;
457 env->regs[0] = 0;
459 #endif
461 #include "cpu-all.h"
463 /* Bit usage in the TB flags field: */
464 #define ARM_TBFLAG_THUMB_SHIFT 0
465 #define ARM_TBFLAG_THUMB_MASK (1 << ARM_TBFLAG_THUMB_SHIFT)
466 #define ARM_TBFLAG_VECLEN_SHIFT 1
467 #define ARM_TBFLAG_VECLEN_MASK (0x7 << ARM_TBFLAG_VECLEN_SHIFT)
468 #define ARM_TBFLAG_VECSTRIDE_SHIFT 4
469 #define ARM_TBFLAG_VECSTRIDE_MASK (0x3 << ARM_TBFLAG_VECSTRIDE_SHIFT)
470 #define ARM_TBFLAG_PRIV_SHIFT 6
471 #define ARM_TBFLAG_PRIV_MASK (1 << ARM_TBFLAG_PRIV_SHIFT)
472 #define ARM_TBFLAG_VFPEN_SHIFT 7
473 #define ARM_TBFLAG_VFPEN_MASK (1 << ARM_TBFLAG_VFPEN_SHIFT)
474 #define ARM_TBFLAG_CONDEXEC_SHIFT 8
475 #define ARM_TBFLAG_CONDEXEC_MASK (0xff << ARM_TBFLAG_CONDEXEC_SHIFT)
476 /* Bits 31..16 are currently unused. */
478 /* some convenience accessor macros */
479 #define ARM_TBFLAG_THUMB(F) \
480 (((F) & ARM_TBFLAG_THUMB_MASK) >> ARM_TBFLAG_THUMB_SHIFT)
481 #define ARM_TBFLAG_VECLEN(F) \
482 (((F) & ARM_TBFLAG_VECLEN_MASK) >> ARM_TBFLAG_VECLEN_SHIFT)
483 #define ARM_TBFLAG_VECSTRIDE(F) \
484 (((F) & ARM_TBFLAG_VECSTRIDE_MASK) >> ARM_TBFLAG_VECSTRIDE_SHIFT)
485 #define ARM_TBFLAG_PRIV(F) \
486 (((F) & ARM_TBFLAG_PRIV_MASK) >> ARM_TBFLAG_PRIV_SHIFT)
487 #define ARM_TBFLAG_VFPEN(F) \
488 (((F) & ARM_TBFLAG_VFPEN_MASK) >> ARM_TBFLAG_VFPEN_SHIFT)
489 #define ARM_TBFLAG_CONDEXEC(F) \
490 (((F) & ARM_TBFLAG_CONDEXEC_MASK) >> ARM_TBFLAG_CONDEXEC_SHIFT)
492 static inline void cpu_get_tb_cpu_state(CPUState *env, target_ulong *pc,
493 target_ulong *cs_base, int *flags)
495 int privmode;
496 *pc = env->regs[15];
497 *cs_base = 0;
498 *flags = (env->thumb << ARM_TBFLAG_THUMB_SHIFT)
499 | (env->vfp.vec_len << ARM_TBFLAG_VECLEN_SHIFT)
500 | (env->vfp.vec_stride << ARM_TBFLAG_VECSTRIDE_SHIFT)
501 | (env->condexec_bits << ARM_TBFLAG_CONDEXEC_SHIFT);
502 if (arm_feature(env, ARM_FEATURE_M)) {
503 privmode = !((env->v7m.exception == 0) && (env->v7m.control & 1));
504 } else {
505 privmode = (env->uncached_cpsr & CPSR_M) != ARM_CPU_MODE_USR;
507 if (privmode) {
508 *flags |= ARM_TBFLAG_PRIV_MASK;
510 if (env->vfp.xregs[ARM_VFP_FPEXC] & (1 << 30)) {
511 *flags |= ARM_TBFLAG_VFPEN_MASK;
515 #endif