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/>.
24 #include "kvm-consts.h"
26 #if defined(TARGET_AARCH64)
27 /* AArch64 definitions */
28 # define TARGET_LONG_BITS 64
29 # define ELF_MACHINE EM_AARCH64
31 # define TARGET_LONG_BITS 32
32 # define ELF_MACHINE EM_ARM
35 #define CPUArchState struct CPUARMState
37 #include "qemu-common.h"
38 #include "exec/cpu-defs.h"
40 #include "fpu/softfloat.h"
42 #define TARGET_HAS_ICE 1
44 #define EXCP_UDEF 1 /* undefined instruction */
45 #define EXCP_SWI 2 /* software interrupt */
46 #define EXCP_PREFETCH_ABORT 3
47 #define EXCP_DATA_ABORT 4
51 #define EXCP_EXCEPTION_EXIT 8 /* Return from v7M exception. */
52 #define EXCP_KERNEL_TRAP 9 /* Jumped to kernel code page. */
55 #define ARMV7M_EXCP_RESET 1
56 #define ARMV7M_EXCP_NMI 2
57 #define ARMV7M_EXCP_HARD 3
58 #define ARMV7M_EXCP_MEM 4
59 #define ARMV7M_EXCP_BUS 5
60 #define ARMV7M_EXCP_USAGE 6
61 #define ARMV7M_EXCP_SVC 11
62 #define ARMV7M_EXCP_DEBUG 12
63 #define ARMV7M_EXCP_PENDSV 14
64 #define ARMV7M_EXCP_SYSTICK 15
66 /* ARM-specific interrupt pending bits. */
67 #define CPU_INTERRUPT_FIQ CPU_INTERRUPT_TGT_EXT_1
69 /* The usual mapping for an AArch64 system register to its AArch32
70 * counterpart is for the 32 bit world to have access to the lower
71 * half only (with writes leaving the upper half untouched). It's
72 * therefore useful to be able to pass TCG the offset of the least
73 * significant half of a uint64_t struct member.
75 #ifdef HOST_WORDS_BIGENDIAN
76 #define offsetoflow32(S, M) (offsetof(S, M) + sizeof(uint32_t))
77 #define offsetofhigh32(S, M) offsetof(S, M)
79 #define offsetoflow32(S, M) offsetof(S, M)
80 #define offsetofhigh32(S, M) (offsetof(S, M) + sizeof(uint32_t))
83 /* Meanings of the ARMCPU object's two inbound GPIO lines */
87 typedef void ARMWriteCPFunc(void *opaque, int cp_info,
88 int srcreg, int operand, uint32_t value);
89 typedef uint32_t ARMReadCPFunc(void *opaque, int cp_info,
90 int dstreg, int operand);
94 #define NB_MMU_MODES 2
96 /* We currently assume float and double are IEEE single and double
97 precision respectively.
98 Doing runtime conversions is tricky because VFP registers may contain
99 integer values (eg. as the result of a FTOSI instruction).
100 s<2n> maps to the least significant half of d<n>
101 s<2n+1> maps to the most significant half of d<n>
104 /* CPU state for each instance of a generic timer (in cp15 c14) */
105 typedef struct ARMGenericTimer {
106 uint64_t cval; /* Timer CompareValue register */
107 uint32_t ctl; /* Timer Control register */
110 #define GTIMER_PHYS 0
111 #define GTIMER_VIRT 1
112 #define NUM_GTIMERS 2
114 /* Scale factor for generic timers, ie number of ns per tick.
115 * This gives a 62.5MHz timer.
117 #define GTIMER_SCALE 16
119 typedef struct CPUARMState {
120 /* Regs for current mode. */
123 /* 32/64 switch only happens when taking and returning from
124 * exceptions so the overlap semantics are taken care of then
125 * instead of having a complicated union.
127 /* Regs for A64 mode. */
130 /* PSTATE isn't an architectural register for ARMv8. However, it is
131 * convenient for us to assemble the underlying state into a 32 bit format
132 * identical to the architectural format used for the SPSR. (This is also
133 * what the Linux kernel's 'pstate' field in signal handlers and KVM's
134 * 'pstate' register are.) Of the PSTATE bits:
135 * NZCV are kept in the split out env->CF/VF/NF/ZF, (which have the same
136 * semantics as for AArch32, as described in the comments on each field)
137 * nRW (also known as M[4]) is kept, inverted, in env->aarch64
138 * all other bits are stored in their correct places in env->pstate
141 uint32_t aarch64; /* 1 if CPU is in aarch64 state; inverse of PSTATE.nRW */
143 /* Frequently accessed CPSR bits are stored separately for efficiency.
144 This contains all the other bits. Use cpsr_{read,write} to access
146 uint32_t uncached_cpsr;
149 /* Banked registers. */
150 uint32_t banked_spsr[6];
151 uint32_t banked_r13[6];
152 uint32_t banked_r14[6];
154 /* These hold r8-r12. */
155 uint32_t usr_regs[5];
156 uint32_t fiq_regs[5];
158 /* cpsr flag cache for faster execution */
159 uint32_t CF; /* 0 or 1 */
160 uint32_t VF; /* V is the bit 31. All other bits are undefined */
161 uint32_t NF; /* N is bit 31. All other bits are undefined. */
162 uint32_t ZF; /* Z set if zero. */
163 uint32_t QF; /* 0 or 1 */
164 uint32_t GE; /* cpsr[19:16] */
165 uint32_t thumb; /* cpsr[5]. 0 = arm mode, 1 = thumb mode. */
166 uint32_t condexec_bits; /* IT bits. cpsr[15:10,26:25]. */
168 /* System control coprocessor (cp15) */
171 uint64_t c0_cssel; /* Cache size selection. */
172 uint64_t c1_sys; /* System control register. */
173 uint32_t c1_coproc; /* Coprocessor access register. */
174 uint32_t c1_xscaleauxcr; /* XScale auxiliary control register. */
175 uint32_t c1_scr; /* secure config register. */
176 uint64_t ttbr0_el1; /* MMU translation table base 0. */
177 uint64_t ttbr1_el1; /* MMU translation table base 1. */
178 uint64_t c2_control; /* MMU translation table base control. */
179 uint32_t c2_mask; /* MMU translation table base selection mask. */
180 uint32_t c2_base_mask; /* MMU translation table base 0 mask. */
181 uint32_t c2_data; /* MPU data cachable bits. */
182 uint32_t c2_insn; /* MPU instruction cachable bits. */
183 uint32_t c3; /* MMU domain access control register
184 MPU write buffer control. */
185 uint32_t c5_insn; /* Fault status registers. */
187 uint32_t c6_region[8]; /* MPU base/size registers. */
188 uint32_t c6_insn; /* Fault address registers. */
190 uint32_t c7_par; /* Translation result. */
191 uint32_t c7_par_hi; /* Translation result, high 32 bits */
192 uint32_t c9_insn; /* Cache lockdown registers. */
194 uint32_t c9_pmcr; /* performance monitor control register */
195 uint32_t c9_pmcnten; /* perf monitor counter enables */
196 uint32_t c9_pmovsr; /* perf monitor overflow status */
197 uint32_t c9_pmxevtyper; /* perf monitor event type */
198 uint32_t c9_pmuserenr; /* perf monitor user enable */
199 uint32_t c9_pminten; /* perf monitor interrupt enables */
201 uint64_t c12_vbar; /* vector base address register */
202 uint32_t c13_fcse; /* FCSE PID. */
203 uint32_t c13_context; /* Context ID. */
204 uint64_t tpidr_el0; /* User RW Thread register. */
205 uint64_t tpidrro_el0; /* User RO Thread register. */
206 uint64_t tpidr_el1; /* Privileged Thread register. */
207 uint32_t c14_cntfrq; /* Counter Frequency register */
208 uint32_t c14_cntkctl; /* Timer Control register */
209 ARMGenericTimer c14_timer[NUM_GTIMERS];
210 uint32_t c15_cpar; /* XScale Coprocessor Access Register */
211 uint32_t c15_ticonfig; /* TI925T configuration byte. */
212 uint32_t c15_i_max; /* Maximum D-cache dirty line index. */
213 uint32_t c15_i_min; /* Minimum D-cache dirty line index. */
214 uint32_t c15_threadid; /* TI debugger thread-ID. */
215 uint32_t c15_config_base_address; /* SCU base address. */
216 uint32_t c15_diagnostic; /* diagnostic register */
217 uint32_t c15_power_diagnostic;
218 uint32_t c15_power_control; /* power control */
228 int pending_exception;
231 /* Thumb-2 EE state. */
235 /* VFP coprocessor state. */
237 /* VFP/Neon register state. Note that the mapping between S, D and Q
238 * views of the register bank differs between AArch64 and AArch32:
240 * Qn = regs[2n+1]:regs[2n]
242 * Sn = regs[n/2] bits 31..0 for even n, and bits 63..32 for odd n
243 * (and regs[32] to regs[63] are inaccessible)
245 * Qn = regs[2n+1]:regs[2n]
247 * Sn = regs[2n] bits 31..0
248 * This corresponds to the architecturally defined mapping between
249 * the two execution states, and means we do not need to explicitly
250 * map these registers when changing states.
255 /* We store these fpcsr fields separately for convenience. */
259 /* scratch space when Tn are not sufficient. */
262 /* fp_status is the "normal" fp status. standard_fp_status retains
263 * values corresponding to the ARM "Standard FPSCR Value", ie
264 * default-NaN, flush-to-zero, round-to-nearest and is used by
265 * any operations (generally Neon) which the architecture defines
266 * as controlled by the standard FPSCR value rather than the FPSCR.
268 * To avoid having to transfer exception bits around, we simply
269 * say that the FPSCR cumulative exception flags are the logical
270 * OR of the flags in the two fp statuses. This relies on the
271 * only thing which needs to read the exception flags being
272 * an explicit FPSCR read.
274 float_status fp_status;
275 float_status standard_fp_status;
277 uint64_t exclusive_addr;
278 uint64_t exclusive_val;
279 uint64_t exclusive_high;
280 #if defined(CONFIG_USER_ONLY)
281 uint64_t exclusive_test;
282 uint32_t exclusive_info;
285 /* iwMMXt coprocessor state. */
293 /* For mixed endian mode. */
296 #if defined(CONFIG_USER_ONLY)
297 /* For usermode syscall translation. */
303 /* These fields after the common ones so they are preserved on reset. */
305 /* Internal CPU feature flags. */
309 const struct arm_boot_info *boot_info;
314 ARMCPU *cpu_arm_init(const char *cpu_model);
315 void arm_translate_init(void);
316 void arm_cpu_register_gdb_regs_for_features(ARMCPU *cpu);
317 int cpu_arm_exec(CPUARMState *s);
318 int bank_number(int mode);
319 void switch_mode(CPUARMState *, int);
320 uint32_t do_arm_semihosting(CPUARMState *env);
322 static inline bool is_a64(CPUARMState *env)
327 /* you can call this signal handler from your SIGBUS and SIGSEGV
328 signal handlers to inform the virtual CPU of exceptions. non zero
329 is returned if the signal was handled by the virtual CPU. */
330 int cpu_arm_signal_handler(int host_signum, void *pinfo,
332 int cpu_arm_handle_mmu_fault (CPUARMState *env, target_ulong address, int rw,
334 #define cpu_handle_mmu_fault cpu_arm_handle_mmu_fault
336 /* SCTLR bit meanings. Several bits have been reused in newer
337 * versions of the architecture; in that case we define constants
338 * for both old and new bit meanings. Code which tests against those
339 * bits should probably check or otherwise arrange that the CPU
340 * is the architectural version it expects.
342 #define SCTLR_M (1U << 0)
343 #define SCTLR_A (1U << 1)
344 #define SCTLR_C (1U << 2)
345 #define SCTLR_W (1U << 3) /* up to v6; RAO in v7 */
346 #define SCTLR_SA (1U << 3)
347 #define SCTLR_P (1U << 4) /* up to v5; RAO in v6 and v7 */
348 #define SCTLR_SA0 (1U << 4) /* v8 onward, AArch64 only */
349 #define SCTLR_D (1U << 5) /* up to v5; RAO in v6 */
350 #define SCTLR_CP15BEN (1U << 5) /* v7 onward */
351 #define SCTLR_L (1U << 6) /* up to v5; RAO in v6 and v7; RAZ in v8 */
352 #define SCTLR_B (1U << 7) /* up to v6; RAZ in v7 */
353 #define SCTLR_ITD (1U << 7) /* v8 onward */
354 #define SCTLR_S (1U << 8) /* up to v6; RAZ in v7 */
355 #define SCTLR_SED (1U << 8) /* v8 onward */
356 #define SCTLR_R (1U << 9) /* up to v6; RAZ in v7 */
357 #define SCTLR_UMA (1U << 9) /* v8 onward, AArch64 only */
358 #define SCTLR_F (1U << 10) /* up to v6 */
359 #define SCTLR_SW (1U << 10) /* v7 onward */
360 #define SCTLR_Z (1U << 11)
361 #define SCTLR_I (1U << 12)
362 #define SCTLR_V (1U << 13)
363 #define SCTLR_RR (1U << 14) /* up to v7 */
364 #define SCTLR_DZE (1U << 14) /* v8 onward, AArch64 only */
365 #define SCTLR_L4 (1U << 15) /* up to v6; RAZ in v7 */
366 #define SCTLR_UCT (1U << 15) /* v8 onward, AArch64 only */
367 #define SCTLR_DT (1U << 16) /* up to ??, RAO in v6 and v7 */
368 #define SCTLR_nTWI (1U << 16) /* v8 onward */
369 #define SCTLR_HA (1U << 17)
370 #define SCTLR_IT (1U << 18) /* up to ??, RAO in v6 and v7 */
371 #define SCTLR_nTWE (1U << 18) /* v8 onward */
372 #define SCTLR_WXN (1U << 19)
373 #define SCTLR_ST (1U << 20) /* up to ??, RAZ in v6 */
374 #define SCTLR_UWXN (1U << 20) /* v7 onward */
375 #define SCTLR_FI (1U << 21)
376 #define SCTLR_U (1U << 22)
377 #define SCTLR_XP (1U << 23) /* up to v6; v7 onward RAO */
378 #define SCTLR_VE (1U << 24) /* up to v7 */
379 #define SCTLR_E0E (1U << 24) /* v8 onward, AArch64 only */
380 #define SCTLR_EE (1U << 25)
381 #define SCTLR_L2 (1U << 26) /* up to v6, RAZ in v7 */
382 #define SCTLR_UCI (1U << 26) /* v8 onward, AArch64 only */
383 #define SCTLR_NMFI (1U << 27)
384 #define SCTLR_TRE (1U << 28)
385 #define SCTLR_AFE (1U << 29)
386 #define SCTLR_TE (1U << 30)
388 #define CPSR_M (0x1fU)
389 #define CPSR_T (1U << 5)
390 #define CPSR_F (1U << 6)
391 #define CPSR_I (1U << 7)
392 #define CPSR_A (1U << 8)
393 #define CPSR_E (1U << 9)
394 #define CPSR_IT_2_7 (0xfc00U)
395 #define CPSR_GE (0xfU << 16)
396 #define CPSR_RESERVED (0xfU << 20)
397 #define CPSR_J (1U << 24)
398 #define CPSR_IT_0_1 (3U << 25)
399 #define CPSR_Q (1U << 27)
400 #define CPSR_V (1U << 28)
401 #define CPSR_C (1U << 29)
402 #define CPSR_Z (1U << 30)
403 #define CPSR_N (1U << 31)
404 #define CPSR_NZCV (CPSR_N | CPSR_Z | CPSR_C | CPSR_V)
406 #define CPSR_IT (CPSR_IT_0_1 | CPSR_IT_2_7)
407 #define CACHED_CPSR_BITS (CPSR_T | CPSR_GE | CPSR_IT | CPSR_Q | CPSR_NZCV)
408 /* Bits writable in user mode. */
409 #define CPSR_USER (CPSR_NZCV | CPSR_Q | CPSR_GE)
410 /* Execution state bits. MRS read as zero, MSR writes ignored. */
411 #define CPSR_EXEC (CPSR_T | CPSR_IT | CPSR_J)
413 /* Bit definitions for ARMv8 SPSR (PSTATE) format.
414 * Only these are valid when in AArch64 mode; in
415 * AArch32 mode SPSRs are basically CPSR-format.
417 #define PSTATE_M (0xFU)
418 #define PSTATE_nRW (1U << 4)
419 #define PSTATE_F (1U << 6)
420 #define PSTATE_I (1U << 7)
421 #define PSTATE_A (1U << 8)
422 #define PSTATE_D (1U << 9)
423 #define PSTATE_IL (1U << 20)
424 #define PSTATE_SS (1U << 21)
425 #define PSTATE_V (1U << 28)
426 #define PSTATE_C (1U << 29)
427 #define PSTATE_Z (1U << 30)
428 #define PSTATE_N (1U << 31)
429 #define PSTATE_NZCV (PSTATE_N | PSTATE_Z | PSTATE_C | PSTATE_V)
430 #define CACHED_PSTATE_BITS (PSTATE_NZCV)
431 /* Mode values for AArch64 */
432 #define PSTATE_MODE_EL3h 13
433 #define PSTATE_MODE_EL3t 12
434 #define PSTATE_MODE_EL2h 9
435 #define PSTATE_MODE_EL2t 8
436 #define PSTATE_MODE_EL1h 5
437 #define PSTATE_MODE_EL1t 4
438 #define PSTATE_MODE_EL0t 0
440 /* Return the current PSTATE value. For the moment we don't support 32<->64 bit
441 * interprocessing, so we don't attempt to sync with the cpsr state used by
442 * the 32 bit decoder.
444 static inline uint32_t pstate_read(CPUARMState *env)
449 return (env->NF & 0x80000000) | (ZF << 30)
450 | (env->CF << 29) | ((env->VF & 0x80000000) >> 3)
454 static inline void pstate_write(CPUARMState *env, uint32_t val)
456 env->ZF = (~val) & PSTATE_Z;
458 env->CF = (val >> 29) & 1;
459 env->VF = (val << 3) & 0x80000000;
460 env->pstate = val & ~CACHED_PSTATE_BITS;
463 /* Return the current CPSR value. */
464 uint32_t cpsr_read(CPUARMState *env);
465 /* Set the CPSR. Note that some bits of mask must be all-set or all-clear. */
466 void cpsr_write(CPUARMState *env, uint32_t val, uint32_t mask);
468 /* Return the current xPSR value. */
469 static inline uint32_t xpsr_read(CPUARMState *env)
473 return (env->NF & 0x80000000) | (ZF << 30)
474 | (env->CF << 29) | ((env->VF & 0x80000000) >> 3) | (env->QF << 27)
475 | (env->thumb << 24) | ((env->condexec_bits & 3) << 25)
476 | ((env->condexec_bits & 0xfc) << 8)
477 | env->v7m.exception;
480 /* Set the xPSR. Note that some bits of mask must be all-set or all-clear. */
481 static inline void xpsr_write(CPUARMState *env, uint32_t val, uint32_t mask)
483 if (mask & CPSR_NZCV) {
484 env->ZF = (~val) & CPSR_Z;
486 env->CF = (val >> 29) & 1;
487 env->VF = (val << 3) & 0x80000000;
490 env->QF = ((val & CPSR_Q) != 0);
491 if (mask & (1 << 24))
492 env->thumb = ((val & (1 << 24)) != 0);
493 if (mask & CPSR_IT_0_1) {
494 env->condexec_bits &= ~3;
495 env->condexec_bits |= (val >> 25) & 3;
497 if (mask & CPSR_IT_2_7) {
498 env->condexec_bits &= 3;
499 env->condexec_bits |= (val >> 8) & 0xfc;
502 env->v7m.exception = val & 0x1ff;
506 /* Return the current FPSCR value. */
507 uint32_t vfp_get_fpscr(CPUARMState *env);
508 void vfp_set_fpscr(CPUARMState *env, uint32_t val);
510 /* For A64 the FPSCR is split into two logically distinct registers,
511 * FPCR and FPSR. However since they still use non-overlapping bits
512 * we store the underlying state in fpscr and just mask on read/write.
514 #define FPSR_MASK 0xf800009f
515 #define FPCR_MASK 0x07f79f00
516 static inline uint32_t vfp_get_fpsr(CPUARMState *env)
518 return vfp_get_fpscr(env) & FPSR_MASK;
521 static inline void vfp_set_fpsr(CPUARMState *env, uint32_t val)
523 uint32_t new_fpscr = (vfp_get_fpscr(env) & ~FPSR_MASK) | (val & FPSR_MASK);
524 vfp_set_fpscr(env, new_fpscr);
527 static inline uint32_t vfp_get_fpcr(CPUARMState *env)
529 return vfp_get_fpscr(env) & FPCR_MASK;
532 static inline void vfp_set_fpcr(CPUARMState *env, uint32_t val)
534 uint32_t new_fpscr = (vfp_get_fpscr(env) & ~FPCR_MASK) | (val & FPCR_MASK);
535 vfp_set_fpscr(env, new_fpscr);
538 enum arm_fprounding {
547 int arm_rmode_to_sf(int rmode);
550 ARM_CPU_MODE_USR = 0x10,
551 ARM_CPU_MODE_FIQ = 0x11,
552 ARM_CPU_MODE_IRQ = 0x12,
553 ARM_CPU_MODE_SVC = 0x13,
554 ARM_CPU_MODE_ABT = 0x17,
555 ARM_CPU_MODE_UND = 0x1b,
556 ARM_CPU_MODE_SYS = 0x1f
559 /* VFP system registers. */
560 #define ARM_VFP_FPSID 0
561 #define ARM_VFP_FPSCR 1
562 #define ARM_VFP_MVFR1 6
563 #define ARM_VFP_MVFR0 7
564 #define ARM_VFP_FPEXC 8
565 #define ARM_VFP_FPINST 9
566 #define ARM_VFP_FPINST2 10
568 /* iwMMXt coprocessor control registers. */
569 #define ARM_IWMMXT_wCID 0
570 #define ARM_IWMMXT_wCon 1
571 #define ARM_IWMMXT_wCSSF 2
572 #define ARM_IWMMXT_wCASF 3
573 #define ARM_IWMMXT_wCGR0 8
574 #define ARM_IWMMXT_wCGR1 9
575 #define ARM_IWMMXT_wCGR2 10
576 #define ARM_IWMMXT_wCGR3 11
578 /* If adding a feature bit which corresponds to a Linux ELF
579 * HWCAP bit, remember to update the feature-bit-to-hwcap
580 * mapping in linux-user/elfload.c:get_elf_hwcap().
584 ARM_FEATURE_AUXCR, /* ARM1026 Auxiliary control register. */
585 ARM_FEATURE_XSCALE, /* Intel XScale extensions. */
586 ARM_FEATURE_IWMMXT, /* Intel iwMMXt extension. */
591 ARM_FEATURE_MPU, /* Only has Memory Protection Unit, not full MMU. */
593 ARM_FEATURE_VFP_FP16,
595 ARM_FEATURE_THUMB_DIV, /* divide supported in Thumb encoding */
596 ARM_FEATURE_M, /* Microcontroller profile. */
597 ARM_FEATURE_OMAPCP, /* OMAP specific CP15 ops handling. */
598 ARM_FEATURE_THUMB2EE,
599 ARM_FEATURE_V7MP, /* v7 Multiprocessing Extensions */
602 ARM_FEATURE_STRONGARM,
603 ARM_FEATURE_VAPA, /* cp15 VA to PA lookups */
604 ARM_FEATURE_ARM_DIV, /* divide supported in ARM encoding */
605 ARM_FEATURE_VFP4, /* VFPv4 (implies that NEON is v2) */
606 ARM_FEATURE_GENERIC_TIMER,
607 ARM_FEATURE_MVFR, /* Media and VFP Feature Registers 0 and 1 */
608 ARM_FEATURE_DUMMY_C15_REGS, /* RAZ/WI all of cp15 crn=15 */
609 ARM_FEATURE_CACHE_TEST_CLEAN, /* 926/1026 style test-and-clean ops */
610 ARM_FEATURE_CACHE_DIRTY_REG, /* 1136/1176 cache dirty status register */
611 ARM_FEATURE_CACHE_BLOCK_OPS, /* v6 optional cache block operations */
612 ARM_FEATURE_MPIDR, /* has cp15 MPIDR */
613 ARM_FEATURE_PXN, /* has Privileged Execute Never bit */
614 ARM_FEATURE_LPAE, /* has Large Physical Address Extension */
616 ARM_FEATURE_AARCH64, /* supports 64 bit mode */
617 ARM_FEATURE_V8_AES, /* implements AES part of v8 Crypto Extensions */
618 ARM_FEATURE_CBAR, /* has cp15 CBAR */
621 static inline int arm_feature(CPUARMState *env, int feature)
623 return (env->features & (1ULL << feature)) != 0;
626 void arm_cpu_list(FILE *f, fprintf_function cpu_fprintf);
628 /* Interface between CPU and Interrupt controller. */
629 void armv7m_nvic_set_pending(void *opaque, int irq);
630 int armv7m_nvic_acknowledge_irq(void *opaque);
631 void armv7m_nvic_complete_irq(void *opaque, int irq);
633 /* Interface for defining coprocessor registers.
634 * Registers are defined in tables of arm_cp_reginfo structs
635 * which are passed to define_arm_cp_regs().
638 /* When looking up a coprocessor register we look for it
639 * via an integer which encodes all of:
641 * Crn, Crm, opc1, opc2 fields
642 * 32 or 64 bit register (ie is it accessed via MRC/MCR
644 * We allow 4 bits for opc1 because MRRC/MCRR have a 4 bit field.
645 * (In this case crn and opc2 should be zero.)
646 * For AArch64, there is no 32/64 bit size distinction;
647 * instead all registers have a 2 bit op0, 3 bit op1 and op2,
648 * and 4 bit CRn and CRm. The encoding patterns are chosen
649 * to be easy to convert to and from the KVM encodings, and also
650 * so that the hashtable can contain both AArch32 and AArch64
651 * registers (to allow for interprocessing where we might run
652 * 32 bit code on a 64 bit core).
654 /* This bit is private to our hashtable cpreg; in KVM register
655 * IDs the AArch64/32 distinction is the KVM_REG_ARM/ARM64
656 * in the upper bits of the 64 bit ID.
658 #define CP_REG_AA64_SHIFT 28
659 #define CP_REG_AA64_MASK (1 << CP_REG_AA64_SHIFT)
661 #define ENCODE_CP_REG(cp, is64, crn, crm, opc1, opc2) \
662 (((cp) << 16) | ((is64) << 15) | ((crn) << 11) | \
663 ((crm) << 7) | ((opc1) << 3) | (opc2))
665 #define ENCODE_AA64_CP_REG(cp, crn, crm, op0, op1, op2) \
666 (CP_REG_AA64_MASK | \
667 ((cp) << CP_REG_ARM_COPROC_SHIFT) | \
668 ((op0) << CP_REG_ARM64_SYSREG_OP0_SHIFT) | \
669 ((op1) << CP_REG_ARM64_SYSREG_OP1_SHIFT) | \
670 ((crn) << CP_REG_ARM64_SYSREG_CRN_SHIFT) | \
671 ((crm) << CP_REG_ARM64_SYSREG_CRM_SHIFT) | \
672 ((op2) << CP_REG_ARM64_SYSREG_OP2_SHIFT))
674 /* Convert a full 64 bit KVM register ID to the truncated 32 bit
675 * version used as a key for the coprocessor register hashtable
677 static inline uint32_t kvm_to_cpreg_id(uint64_t kvmid)
679 uint32_t cpregid = kvmid;
680 if ((kvmid & CP_REG_ARCH_MASK) == CP_REG_ARM64) {
681 cpregid |= CP_REG_AA64_MASK;
682 } else if ((kvmid & CP_REG_SIZE_MASK) == CP_REG_SIZE_U64) {
683 cpregid |= (1 << 15);
688 /* Convert a truncated 32 bit hashtable key into the full
689 * 64 bit KVM register ID.
691 static inline uint64_t cpreg_to_kvm_id(uint32_t cpregid)
695 if (cpregid & CP_REG_AA64_MASK) {
696 kvmid = cpregid & ~CP_REG_AA64_MASK;
697 kvmid |= CP_REG_SIZE_U64 | CP_REG_ARM64;
699 kvmid = cpregid & ~(1 << 15);
700 if (cpregid & (1 << 15)) {
701 kvmid |= CP_REG_SIZE_U64 | CP_REG_ARM;
703 kvmid |= CP_REG_SIZE_U32 | CP_REG_ARM;
709 /* ARMCPRegInfo type field bits. If the SPECIAL bit is set this is a
710 * special-behaviour cp reg and bits [15..8] indicate what behaviour
711 * it has. Otherwise it is a simple cp reg, where CONST indicates that
712 * TCG can assume the value to be constant (ie load at translate time)
713 * and 64BIT indicates a 64 bit wide coprocessor register. SUPPRESS_TB_END
714 * indicates that the TB should not be ended after a write to this register
715 * (the default is that the TB ends after cp writes). OVERRIDE permits
716 * a register definition to override a previous definition for the
717 * same (cp, is64, crn, crm, opc1, opc2) tuple: either the new or the
718 * old must have the OVERRIDE bit set.
719 * NO_MIGRATE indicates that this register should be ignored for migration;
720 * (eg because any state is accessed via some other coprocessor register).
721 * IO indicates that this register does I/O and therefore its accesses
722 * need to be surrounded by gen_io_start()/gen_io_end(). In particular,
723 * registers which implement clocks or timers require this.
725 #define ARM_CP_SPECIAL 1
726 #define ARM_CP_CONST 2
727 #define ARM_CP_64BIT 4
728 #define ARM_CP_SUPPRESS_TB_END 8
729 #define ARM_CP_OVERRIDE 16
730 #define ARM_CP_NO_MIGRATE 32
732 #define ARM_CP_NOP (ARM_CP_SPECIAL | (1 << 8))
733 #define ARM_CP_WFI (ARM_CP_SPECIAL | (2 << 8))
734 #define ARM_CP_NZCV (ARM_CP_SPECIAL | (3 << 8))
735 #define ARM_CP_CURRENTEL (ARM_CP_SPECIAL | (4 << 8))
736 #define ARM_LAST_SPECIAL ARM_CP_CURRENTEL
737 /* Used only as a terminator for ARMCPRegInfo lists */
738 #define ARM_CP_SENTINEL 0xffff
739 /* Mask of only the flag bits in a type field */
740 #define ARM_CP_FLAG_MASK 0x7f
742 /* Valid values for ARMCPRegInfo state field, indicating which of
743 * the AArch32 and AArch64 execution states this register is visible in.
744 * If the reginfo doesn't explicitly specify then it is AArch32 only.
745 * If the reginfo is declared to be visible in both states then a second
746 * reginfo is synthesised for the AArch32 view of the AArch64 register,
747 * such that the AArch32 view is the lower 32 bits of the AArch64 one.
748 * Note that we rely on the values of these enums as we iterate through
749 * the various states in some places.
752 ARM_CP_STATE_AA32 = 0,
753 ARM_CP_STATE_AA64 = 1,
754 ARM_CP_STATE_BOTH = 2,
757 /* Return true if cptype is a valid type field. This is used to try to
758 * catch errors where the sentinel has been accidentally left off the end
759 * of a list of registers.
761 static inline bool cptype_valid(int cptype)
763 return ((cptype & ~ARM_CP_FLAG_MASK) == 0)
764 || ((cptype & ARM_CP_SPECIAL) &&
765 ((cptype & ~ARM_CP_FLAG_MASK) <= ARM_LAST_SPECIAL));
769 * We define bits for Read and Write access for what rev C of the v7-AR ARM ARM
770 * defines as PL0 (user), PL1 (fiq/irq/svc/abt/und/sys, ie privileged), and
771 * PL2 (hyp). The other level which has Read and Write bits is Secure PL1
772 * (ie any of the privileged modes in Secure state, or Monitor mode).
773 * If a register is accessible in one privilege level it's always accessible
774 * in higher privilege levels too. Since "Secure PL1" also follows this rule
775 * (ie anything visible in PL2 is visible in S-PL1, some things are only
776 * visible in S-PL1) but "Secure PL1" is a bit of a mouthful, we bend the
777 * terminology a little and call this PL3.
778 * In AArch64 things are somewhat simpler as the PLx bits line up exactly
779 * with the ELx exception levels.
781 * If access permissions for a register are more complex than can be
782 * described with these bits, then use a laxer set of restrictions, and
783 * do the more restrictive/complex check inside a helper function.
787 #define PL2_R (0x20 | PL3_R)
788 #define PL2_W (0x10 | PL3_W)
789 #define PL1_R (0x08 | PL2_R)
790 #define PL1_W (0x04 | PL2_W)
791 #define PL0_R (0x02 | PL1_R)
792 #define PL0_W (0x01 | PL1_W)
794 #define PL3_RW (PL3_R | PL3_W)
795 #define PL2_RW (PL2_R | PL2_W)
796 #define PL1_RW (PL1_R | PL1_W)
797 #define PL0_RW (PL0_R | PL0_W)
799 static inline int arm_current_pl(CPUARMState *env)
802 return extract32(env->pstate, 2, 2);
805 if ((env->uncached_cpsr & 0x1f) == ARM_CPU_MODE_USR) {
808 /* We don't currently implement the Virtualization or TrustZone
809 * extensions, so PL2 and PL3 don't exist for us.
814 typedef struct ARMCPRegInfo ARMCPRegInfo;
816 typedef enum CPAccessResult {
817 /* Access is permitted */
819 /* Access fails due to a configurable trap or enable which would
820 * result in a categorized exception syndrome giving information about
821 * the failing instruction (ie syndrome category 0x3, 0x4, 0x5, 0x6,
825 /* Access fails and results in an exception syndrome 0x0 ("uncategorized").
826 * Note that this is not a catch-all case -- the set of cases which may
827 * result in this failure is specifically defined by the architecture.
829 CP_ACCESS_TRAP_UNCATEGORIZED = 2,
832 /* Access functions for coprocessor registers. These cannot fail and
833 * may not raise exceptions.
835 typedef uint64_t CPReadFn(CPUARMState *env, const ARMCPRegInfo *opaque);
836 typedef void CPWriteFn(CPUARMState *env, const ARMCPRegInfo *opaque,
838 /* Access permission check functions for coprocessor registers. */
839 typedef CPAccessResult CPAccessFn(CPUARMState *env, const ARMCPRegInfo *opaque);
840 /* Hook function for register reset */
841 typedef void CPResetFn(CPUARMState *env, const ARMCPRegInfo *opaque);
845 /* Definition of an ARM coprocessor register */
846 struct ARMCPRegInfo {
847 /* Name of register (useful mainly for debugging, need not be unique) */
849 /* Location of register: coprocessor number and (crn,crm,opc1,opc2)
850 * tuple. Any of crm, opc1 and opc2 may be CP_ANY to indicate a
851 * 'wildcard' field -- any value of that field in the MRC/MCR insn
852 * will be decoded to this register. The register read and write
853 * callbacks will be passed an ARMCPRegInfo with the crn/crm/opc1/opc2
854 * used by the program, so it is possible to register a wildcard and
855 * then behave differently on read/write if necessary.
856 * For 64 bit registers, only crm and opc1 are relevant; crn and opc2
858 * For AArch64-visible registers, opc0 is also used.
859 * Since there are no "coprocessors" in AArch64, cp is purely used as a
860 * way to distinguish (for KVM's benefit) guest-visible system registers
861 * from demuxed ones provided to preserve the "no side effects on
862 * KVM register read/write from QEMU" semantics. cp==0x13 is guest
863 * visible (to match KVM's encoding); cp==0 will be converted to
864 * cp==0x13 when the ARMCPRegInfo is registered, for convenience.
872 /* Execution state in which this register is visible: ARM_CP_STATE_* */
874 /* Register type: ARM_CP_* bits/values */
876 /* Access rights: PL*_[RW] */
878 /* The opaque pointer passed to define_arm_cp_regs_with_opaque() when
879 * this register was defined: can be used to hand data through to the
880 * register read/write functions, since they are passed the ARMCPRegInfo*.
883 /* Value of this register, if it is ARM_CP_CONST. Otherwise, if
884 * fieldoffset is non-zero, the reset value of the register.
887 /* Offset of the field in CPUARMState for this register. This is not
889 * 1. type is ARM_CP_CONST or one of the ARM_CP_SPECIALs
890 * 2. both readfn and writefn are specified
892 ptrdiff_t fieldoffset; /* offsetof(CPUARMState, field) */
893 /* Function for making any access checks for this register in addition to
894 * those specified by the 'access' permissions bits. If NULL, no extra
895 * checks required. The access check is performed at runtime, not at
898 CPAccessFn *accessfn;
899 /* Function for handling reads of this register. If NULL, then reads
900 * will be done by loading from the offset into CPUARMState specified
904 /* Function for handling writes of this register. If NULL, then writes
905 * will be done by writing to the offset into CPUARMState specified
909 /* Function for doing a "raw" read; used when we need to copy
910 * coprocessor state to the kernel for KVM or out for
911 * migration. This only needs to be provided if there is also a
912 * readfn and it has side effects (for instance clear-on-read bits).
914 CPReadFn *raw_readfn;
915 /* Function for doing a "raw" write; used when we need to copy KVM
916 * kernel coprocessor state into userspace, or for inbound
917 * migration. This only needs to be provided if there is also a
918 * writefn and it masks out "unwritable" bits or has write-one-to-clear
919 * or similar behaviour.
921 CPWriteFn *raw_writefn;
922 /* Function for resetting the register. If NULL, then reset will be done
923 * by writing resetvalue to the field specified in fieldoffset. If
924 * fieldoffset is 0 then no reset will be done.
929 /* Macros which are lvalues for the field in CPUARMState for the
932 #define CPREG_FIELD32(env, ri) \
933 (*(uint32_t *)((char *)(env) + (ri)->fieldoffset))
934 #define CPREG_FIELD64(env, ri) \
935 (*(uint64_t *)((char *)(env) + (ri)->fieldoffset))
937 #define REGINFO_SENTINEL { .type = ARM_CP_SENTINEL }
939 void define_arm_cp_regs_with_opaque(ARMCPU *cpu,
940 const ARMCPRegInfo *regs, void *opaque);
941 void define_one_arm_cp_reg_with_opaque(ARMCPU *cpu,
942 const ARMCPRegInfo *regs, void *opaque);
943 static inline void define_arm_cp_regs(ARMCPU *cpu, const ARMCPRegInfo *regs)
945 define_arm_cp_regs_with_opaque(cpu, regs, 0);
947 static inline void define_one_arm_cp_reg(ARMCPU *cpu, const ARMCPRegInfo *regs)
949 define_one_arm_cp_reg_with_opaque(cpu, regs, 0);
951 const ARMCPRegInfo *get_arm_cp_reginfo(GHashTable *cpregs, uint32_t encoded_cp);
953 /* CPWriteFn that can be used to implement writes-ignored behaviour */
954 void arm_cp_write_ignore(CPUARMState *env, const ARMCPRegInfo *ri,
956 /* CPReadFn that can be used for read-as-zero behaviour */
957 uint64_t arm_cp_read_zero(CPUARMState *env, const ARMCPRegInfo *ri);
959 /* CPResetFn that does nothing, for use if no reset is required even
960 * if fieldoffset is non zero.
962 void arm_cp_reset_ignore(CPUARMState *env, const ARMCPRegInfo *opaque);
964 /* Return true if this reginfo struct's field in the cpu state struct
967 static inline bool cpreg_field_is_64bit(const ARMCPRegInfo *ri)
969 return (ri->state == ARM_CP_STATE_AA64) || (ri->type & ARM_CP_64BIT);
972 static inline bool cp_access_ok(int current_pl,
973 const ARMCPRegInfo *ri, int isread)
975 return (ri->access >> ((current_pl * 2) + isread)) & 1;
979 * write_list_to_cpustate
982 * For each register listed in the ARMCPU cpreg_indexes list, write
983 * its value from the cpreg_values list into the ARMCPUState structure.
984 * This updates TCG's working data structures from KVM data or
985 * from incoming migration state.
987 * Returns: true if all register values were updated correctly,
988 * false if some register was unknown or could not be written.
989 * Note that we do not stop early on failure -- we will attempt
990 * writing all registers in the list.
992 bool write_list_to_cpustate(ARMCPU *cpu);
995 * write_cpustate_to_list:
998 * For each register listed in the ARMCPU cpreg_indexes list, write
999 * its value from the ARMCPUState structure into the cpreg_values list.
1000 * This is used to copy info from TCG's working data structures into
1001 * KVM or for outbound migration.
1003 * Returns: true if all register values were read correctly,
1004 * false if some register was unknown or could not be read.
1005 * Note that we do not stop early on failure -- we will attempt
1006 * reading all registers in the list.
1008 bool write_cpustate_to_list(ARMCPU *cpu);
1010 /* Does the core conform to the the "MicroController" profile. e.g. Cortex-M3.
1011 Note the M in older cores (eg. ARM7TDMI) stands for Multiply. These are
1012 conventional cores (ie. Application or Realtime profile). */
1014 #define IS_M(env) arm_feature(env, ARM_FEATURE_M)
1016 #define ARM_CPUID_TI915T 0x54029152
1017 #define ARM_CPUID_TI925T 0x54029252
1019 #if defined(CONFIG_USER_ONLY)
1020 #define TARGET_PAGE_BITS 12
1022 /* The ARM MMU allows 1k pages. */
1023 /* ??? Linux doesn't actually use these, and they're deprecated in recent
1024 architecture revisions. Maybe a configure option to disable them. */
1025 #define TARGET_PAGE_BITS 10
1028 #if defined(TARGET_AARCH64)
1029 # define TARGET_PHYS_ADDR_SPACE_BITS 48
1030 # define TARGET_VIRT_ADDR_SPACE_BITS 64
1032 # define TARGET_PHYS_ADDR_SPACE_BITS 40
1033 # define TARGET_VIRT_ADDR_SPACE_BITS 32
1036 static inline CPUARMState *cpu_init(const char *cpu_model)
1038 ARMCPU *cpu = cpu_arm_init(cpu_model);
1045 #define cpu_exec cpu_arm_exec
1046 #define cpu_gen_code cpu_arm_gen_code
1047 #define cpu_signal_handler cpu_arm_signal_handler
1048 #define cpu_list arm_cpu_list
1050 /* MMU modes definitions */
1051 #define MMU_MODE0_SUFFIX _kernel
1052 #define MMU_MODE1_SUFFIX _user
1053 #define MMU_USER_IDX 1
1054 static inline int cpu_mmu_index (CPUARMState *env)
1056 return (env->uncached_cpsr & CPSR_M) == ARM_CPU_MODE_USR ? 1 : 0;
1059 #include "exec/cpu-all.h"
1061 /* Bit usage in the TB flags field: bit 31 indicates whether we are
1062 * in 32 or 64 bit mode. The meaning of the other bits depends on that.
1064 #define ARM_TBFLAG_AARCH64_STATE_SHIFT 31
1065 #define ARM_TBFLAG_AARCH64_STATE_MASK (1U << ARM_TBFLAG_AARCH64_STATE_SHIFT)
1067 /* Bit usage when in AArch32 state: */
1068 #define ARM_TBFLAG_THUMB_SHIFT 0
1069 #define ARM_TBFLAG_THUMB_MASK (1 << ARM_TBFLAG_THUMB_SHIFT)
1070 #define ARM_TBFLAG_VECLEN_SHIFT 1
1071 #define ARM_TBFLAG_VECLEN_MASK (0x7 << ARM_TBFLAG_VECLEN_SHIFT)
1072 #define ARM_TBFLAG_VECSTRIDE_SHIFT 4
1073 #define ARM_TBFLAG_VECSTRIDE_MASK (0x3 << ARM_TBFLAG_VECSTRIDE_SHIFT)
1074 #define ARM_TBFLAG_PRIV_SHIFT 6
1075 #define ARM_TBFLAG_PRIV_MASK (1 << ARM_TBFLAG_PRIV_SHIFT)
1076 #define ARM_TBFLAG_VFPEN_SHIFT 7
1077 #define ARM_TBFLAG_VFPEN_MASK (1 << ARM_TBFLAG_VFPEN_SHIFT)
1078 #define ARM_TBFLAG_CONDEXEC_SHIFT 8
1079 #define ARM_TBFLAG_CONDEXEC_MASK (0xff << ARM_TBFLAG_CONDEXEC_SHIFT)
1080 #define ARM_TBFLAG_BSWAP_CODE_SHIFT 16
1081 #define ARM_TBFLAG_BSWAP_CODE_MASK (1 << ARM_TBFLAG_BSWAP_CODE_SHIFT)
1083 /* Bit usage when in AArch64 state: currently no bits defined */
1085 /* some convenience accessor macros */
1086 #define ARM_TBFLAG_AARCH64_STATE(F) \
1087 (((F) & ARM_TBFLAG_AARCH64_STATE_MASK) >> ARM_TBFLAG_AARCH64_STATE_SHIFT)
1088 #define ARM_TBFLAG_THUMB(F) \
1089 (((F) & ARM_TBFLAG_THUMB_MASK) >> ARM_TBFLAG_THUMB_SHIFT)
1090 #define ARM_TBFLAG_VECLEN(F) \
1091 (((F) & ARM_TBFLAG_VECLEN_MASK) >> ARM_TBFLAG_VECLEN_SHIFT)
1092 #define ARM_TBFLAG_VECSTRIDE(F) \
1093 (((F) & ARM_TBFLAG_VECSTRIDE_MASK) >> ARM_TBFLAG_VECSTRIDE_SHIFT)
1094 #define ARM_TBFLAG_PRIV(F) \
1095 (((F) & ARM_TBFLAG_PRIV_MASK) >> ARM_TBFLAG_PRIV_SHIFT)
1096 #define ARM_TBFLAG_VFPEN(F) \
1097 (((F) & ARM_TBFLAG_VFPEN_MASK) >> ARM_TBFLAG_VFPEN_SHIFT)
1098 #define ARM_TBFLAG_CONDEXEC(F) \
1099 (((F) & ARM_TBFLAG_CONDEXEC_MASK) >> ARM_TBFLAG_CONDEXEC_SHIFT)
1100 #define ARM_TBFLAG_BSWAP_CODE(F) \
1101 (((F) & ARM_TBFLAG_BSWAP_CODE_MASK) >> ARM_TBFLAG_BSWAP_CODE_SHIFT)
1103 static inline void cpu_get_tb_cpu_state(CPUARMState *env, target_ulong *pc,
1104 target_ulong *cs_base, int *flags)
1108 *flags = ARM_TBFLAG_AARCH64_STATE_MASK;
1111 *pc = env->regs[15];
1112 *flags = (env->thumb << ARM_TBFLAG_THUMB_SHIFT)
1113 | (env->vfp.vec_len << ARM_TBFLAG_VECLEN_SHIFT)
1114 | (env->vfp.vec_stride << ARM_TBFLAG_VECSTRIDE_SHIFT)
1115 | (env->condexec_bits << ARM_TBFLAG_CONDEXEC_SHIFT)
1116 | (env->bswap_code << ARM_TBFLAG_BSWAP_CODE_SHIFT);
1117 if (arm_feature(env, ARM_FEATURE_M)) {
1118 privmode = !((env->v7m.exception == 0) && (env->v7m.control & 1));
1120 privmode = (env->uncached_cpsr & CPSR_M) != ARM_CPU_MODE_USR;
1123 *flags |= ARM_TBFLAG_PRIV_MASK;
1125 if (env->vfp.xregs[ARM_VFP_FPEXC] & (1 << 30)) {
1126 *flags |= ARM_TBFLAG_VFPEN_MASK;
1133 static inline bool cpu_has_work(CPUState *cpu)
1135 return cpu->interrupt_request &
1136 (CPU_INTERRUPT_FIQ | CPU_INTERRUPT_HARD | CPU_INTERRUPT_EXITTB);
1139 #include "exec/exec-all.h"
1141 static inline void cpu_pc_from_tb(CPUARMState *env, TranslationBlock *tb)
1143 if (ARM_TBFLAG_AARCH64_STATE(tb->flags)) {
1146 env->regs[15] = tb->pc;
1150 /* Load an instruction and return it in the standard little-endian order */
1151 static inline uint32_t arm_ldl_code(CPUARMState *env, target_ulong addr,
1154 uint32_t insn = cpu_ldl_code(env, addr);
1156 return bswap32(insn);
1161 /* Ditto, for a halfword (Thumb) instruction */
1162 static inline uint16_t arm_lduw_code(CPUARMState *env, target_ulong addr,
1165 uint16_t insn = cpu_lduw_code(env, addr);
1167 return bswap16(insn);