xref: /qemu/target/arm/cpu.h (revision c0b32426ce56182c1ce2a12904f3a702c2ecc460)
1 /*
2  * ARM virtual CPU header
3  *
4  *  Copyright (c) 2003 Fabrice Bellard
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.1 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, see <http://www.gnu.org/licenses/>.
18  */
19 
20 #ifndef ARM_CPU_H
21 #define ARM_CPU_H
22 
23 #include "kvm-consts.h"
24 #include "qemu/cpu-float.h"
25 #include "hw/registerfields.h"
26 #include "cpu-qom.h"
27 #include "exec/cpu-defs.h"
28 #include "exec/gdbstub.h"
29 #include "exec/page-protection.h"
30 #include "qapi/qapi-types-common.h"
31 #include "target/arm/multiprocessing.h"
32 #include "target/arm/gtimer.h"
33 
34 #ifdef TARGET_AARCH64
35 #define KVM_HAVE_MCE_INJECTION 1
36 #endif
37 
38 #define EXCP_UDEF            1   /* undefined instruction */
39 #define EXCP_SWI             2   /* software interrupt */
40 #define EXCP_PREFETCH_ABORT  3
41 #define EXCP_DATA_ABORT      4
42 #define EXCP_IRQ             5
43 #define EXCP_FIQ             6
44 #define EXCP_BKPT            7
45 #define EXCP_EXCEPTION_EXIT  8   /* Return from v7M exception.  */
46 #define EXCP_KERNEL_TRAP     9   /* Jumped to kernel code page.  */
47 #define EXCP_HVC            11   /* HyperVisor Call */
48 #define EXCP_HYP_TRAP       12
49 #define EXCP_SMC            13   /* Secure Monitor Call */
50 #define EXCP_VIRQ           14
51 #define EXCP_VFIQ           15
52 #define EXCP_SEMIHOST       16   /* semihosting call */
53 #define EXCP_NOCP           17   /* v7M NOCP UsageFault */
54 #define EXCP_INVSTATE       18   /* v7M INVSTATE UsageFault */
55 #define EXCP_STKOF          19   /* v8M STKOF UsageFault */
56 #define EXCP_LAZYFP         20   /* v7M fault during lazy FP stacking */
57 #define EXCP_LSERR          21   /* v8M LSERR SecureFault */
58 #define EXCP_UNALIGNED      22   /* v7M UNALIGNED UsageFault */
59 #define EXCP_DIVBYZERO      23   /* v7M DIVBYZERO UsageFault */
60 #define EXCP_VSERR          24
61 #define EXCP_GPC            25   /* v9 Granule Protection Check Fault */
62 #define EXCP_NMI            26
63 #define EXCP_VINMI          27
64 #define EXCP_VFNMI          28
65 #define EXCP_MON_TRAP       29   /* AArch32 trap to Monitor mode */
66 /* NB: add new EXCP_ defines to the array in arm_log_exception() too */
67 
68 #define ARMV7M_EXCP_RESET   1
69 #define ARMV7M_EXCP_NMI     2
70 #define ARMV7M_EXCP_HARD    3
71 #define ARMV7M_EXCP_MEM     4
72 #define ARMV7M_EXCP_BUS     5
73 #define ARMV7M_EXCP_USAGE   6
74 #define ARMV7M_EXCP_SECURE  7
75 #define ARMV7M_EXCP_SVC     11
76 #define ARMV7M_EXCP_DEBUG   12
77 #define ARMV7M_EXCP_PENDSV  14
78 #define ARMV7M_EXCP_SYSTICK 15
79 
80 /* ARM-specific interrupt pending bits.  */
81 #define CPU_INTERRUPT_FIQ   CPU_INTERRUPT_TGT_EXT_1
82 #define CPU_INTERRUPT_VIRQ  CPU_INTERRUPT_TGT_EXT_2
83 #define CPU_INTERRUPT_VFIQ  CPU_INTERRUPT_TGT_EXT_3
84 #define CPU_INTERRUPT_VSERR CPU_INTERRUPT_TGT_INT_0
85 #define CPU_INTERRUPT_NMI   CPU_INTERRUPT_TGT_EXT_4
86 #define CPU_INTERRUPT_VINMI CPU_INTERRUPT_TGT_EXT_0
87 #define CPU_INTERRUPT_VFNMI CPU_INTERRUPT_TGT_INT_1
88 
89 /* The usual mapping for an AArch64 system register to its AArch32
90  * counterpart is for the 32 bit world to have access to the lower
91  * half only (with writes leaving the upper half untouched). It's
92  * therefore useful to be able to pass TCG the offset of the least
93  * significant half of a uint64_t struct member.
94  */
95 #if HOST_BIG_ENDIAN
96 #define offsetoflow32(S, M) (offsetof(S, M) + sizeof(uint32_t))
97 #define offsetofhigh32(S, M) offsetof(S, M)
98 #else
99 #define offsetoflow32(S, M) offsetof(S, M)
100 #define offsetofhigh32(S, M) (offsetof(S, M) + sizeof(uint32_t))
101 #endif
102 
103 /* ARM-specific extra insn start words:
104  * 1: Conditional execution bits
105  * 2: Partial exception syndrome for data aborts
106  */
107 #define TARGET_INSN_START_EXTRA_WORDS 2
108 
109 /* The 2nd extra word holding syndrome info for data aborts does not use
110  * the upper 6 bits nor the lower 13 bits. We mask and shift it down to
111  * help the sleb128 encoder do a better job.
112  * When restoring the CPU state, we shift it back up.
113  */
114 #define ARM_INSN_START_WORD2_MASK ((1 << 26) - 1)
115 #define ARM_INSN_START_WORD2_SHIFT 13
116 
117 /* We currently assume float and double are IEEE single and double
118    precision respectively.
119    Doing runtime conversions is tricky because VFP registers may contain
120    integer values (eg. as the result of a FTOSI instruction).
121    s<2n> maps to the least significant half of d<n>
122    s<2n+1> maps to the most significant half of d<n>
123  */
124 
125 /**
126  * DynamicGDBFeatureInfo:
127  * @desc: Contains the feature descriptions.
128  * @data: A union with data specific to the set of registers
129  *    @cpregs_keys: Array that contains the corresponding Key of
130  *                  a given cpreg with the same order of the cpreg
131  *                  in the XML description.
132  */
133 typedef struct DynamicGDBFeatureInfo {
134     GDBFeature desc;
135     union {
136         struct {
137             uint32_t *keys;
138         } cpregs;
139     } data;
140 } DynamicGDBFeatureInfo;
141 
142 /* CPU state for each instance of a generic timer (in cp15 c14) */
143 typedef struct ARMGenericTimer {
144     uint64_t cval; /* Timer CompareValue register */
145     uint64_t ctl; /* Timer Control register */
146 } ARMGenericTimer;
147 
148 /* Define a maximum sized vector register.
149  * For 32-bit, this is a 128-bit NEON/AdvSIMD register.
150  * For 64-bit, this is a 2048-bit SVE register.
151  *
152  * Note that the mapping between S, D, and Q views of the register bank
153  * differs between AArch64 and AArch32.
154  * In AArch32:
155  *  Qn = regs[n].d[1]:regs[n].d[0]
156  *  Dn = regs[n / 2].d[n & 1]
157  *  Sn = regs[n / 4].d[n % 4 / 2],
158  *       bits 31..0 for even n, and bits 63..32 for odd n
159  *       (and regs[16] to regs[31] are inaccessible)
160  * In AArch64:
161  *  Zn = regs[n].d[*]
162  *  Qn = regs[n].d[1]:regs[n].d[0]
163  *  Dn = regs[n].d[0]
164  *  Sn = regs[n].d[0] bits 31..0
165  *  Hn = regs[n].d[0] bits 15..0
166  *
167  * This corresponds to the architecturally defined mapping between
168  * the two execution states, and means we do not need to explicitly
169  * map these registers when changing states.
170  *
171  * Align the data for use with TCG host vector operations.
172  */
173 
174 #ifdef TARGET_AARCH64
175 # define ARM_MAX_VQ    16
176 #else
177 # define ARM_MAX_VQ    1
178 #endif
179 
180 typedef struct ARMVectorReg {
181     uint64_t d[2 * ARM_MAX_VQ] QEMU_ALIGNED(16);
182 } ARMVectorReg;
183 
184 #ifdef TARGET_AARCH64
185 /* In AArch32 mode, predicate registers do not exist at all.  */
186 typedef struct ARMPredicateReg {
187     uint64_t p[DIV_ROUND_UP(2 * ARM_MAX_VQ, 8)] QEMU_ALIGNED(16);
188 } ARMPredicateReg;
189 
190 /* In AArch32 mode, PAC keys do not exist at all.  */
191 typedef struct ARMPACKey {
192     uint64_t lo, hi;
193 } ARMPACKey;
194 #endif
195 
196 /* See the commentary above the TBFLAG field definitions.  */
197 typedef struct CPUARMTBFlags {
198     uint32_t flags;
199     target_ulong flags2;
200 } CPUARMTBFlags;
201 
202 typedef struct ARMMMUFaultInfo ARMMMUFaultInfo;
203 
204 typedef struct NVICState NVICState;
205 
206 /*
207  * Enum for indexing vfp.fp_status[].
208  *
209  * FPST_A32: is the "normal" fp status for AArch32 insns
210  * FPST_A64: is the "normal" fp status for AArch64 insns
211  * FPST_A32_F16: used for AArch32 half-precision calculations
212  * FPST_A64_F16: used for AArch64 half-precision calculations
213  * FPST_STD: the ARM "Standard FPSCR Value"
214  * FPST_STD_F16: used for half-precision
215  *       calculations with the ARM "Standard FPSCR Value"
216  * FPST_AH: used for the A64 insns which change behaviour
217  *       when FPCR.AH == 1 (bfloat16 conversions and multiplies,
218  *       and the reciprocal and square root estimate/step insns)
219  * FPST_AH_F16: used for the A64 insns which change behaviour
220  *       when FPCR.AH == 1 (bfloat16 conversions and multiplies,
221  *       and the reciprocal and square root estimate/step insns);
222  *       for half-precision
223  *
224  * Half-precision operations are governed by a separate
225  * flush-to-zero control bit in FPSCR:FZ16. We pass a separate
226  * status structure to control this.
227  *
228  * The "Standard FPSCR", ie default-NaN, flush-to-zero,
229  * round-to-nearest and is used by any operations (generally
230  * Neon) which the architecture defines as controlled by the
231  * standard FPSCR value rather than the FPSCR.
232  *
233  * The "standard FPSCR but for fp16 ops" is needed because
234  * the "standard FPSCR" tracks the FPSCR.FZ16 bit rather than
235  * using a fixed value for it.
236  *
237  * FPST_AH is needed because some insns have different
238  * behaviour when FPCR.AH == 1: they don't update cumulative
239  * exception flags, they act like FPCR.{FZ,FIZ} = {1,1} and
240  * they ignore FPCR.RMode. But they don't ignore FPCR.FZ16,
241  * which means we need an FPST_AH_F16 as well.
242  *
243  * To avoid having to transfer exception bits around, we simply
244  * say that the FPSCR cumulative exception flags are the logical
245  * OR of the flags in the four fp statuses. This relies on the
246  * only thing which needs to read the exception flags being
247  * an explicit FPSCR read.
248  */
249 typedef enum ARMFPStatusFlavour {
250     FPST_A32,
251     FPST_A64,
252     FPST_A32_F16,
253     FPST_A64_F16,
254     FPST_AH,
255     FPST_AH_F16,
256     FPST_STD,
257     FPST_STD_F16,
258 } ARMFPStatusFlavour;
259 #define FPST_COUNT  8
260 
261 typedef struct CPUArchState {
262     /* Regs for current mode.  */
263     uint32_t regs[16];
264 
265     /* 32/64 switch only happens when taking and returning from
266      * exceptions so the overlap semantics are taken care of then
267      * instead of having a complicated union.
268      */
269     /* Regs for A64 mode.  */
270     uint64_t xregs[32];
271     uint64_t pc;
272     /* PSTATE isn't an architectural register for ARMv8. However, it is
273      * convenient for us to assemble the underlying state into a 32 bit format
274      * identical to the architectural format used for the SPSR. (This is also
275      * what the Linux kernel's 'pstate' field in signal handlers and KVM's
276      * 'pstate' register are.) Of the PSTATE bits:
277      *  NZCV are kept in the split out env->CF/VF/NF/ZF, (which have the same
278      *    semantics as for AArch32, as described in the comments on each field)
279      *  nRW (also known as M[4]) is kept, inverted, in env->aarch64
280      *  DAIF (exception masks) are kept in env->daif
281      *  BTYPE is kept in env->btype
282      *  SM and ZA are kept in env->svcr
283      *  all other bits are stored in their correct places in env->pstate
284      */
285     uint32_t pstate;
286     bool aarch64; /* True if CPU is in aarch64 state; inverse of PSTATE.nRW */
287     bool thumb;   /* True if CPU is in thumb mode; cpsr[5] */
288 
289     /* Cached TBFLAGS state.  See below for which bits are included.  */
290     CPUARMTBFlags hflags;
291 
292     /* Frequently accessed CPSR bits are stored separately for efficiency.
293        This contains all the other bits.  Use cpsr_{read,write} to access
294        the whole CPSR.  */
295     uint32_t uncached_cpsr;
296     uint32_t spsr;
297 
298     /* Banked registers.  */
299     uint64_t banked_spsr[8];
300     uint32_t banked_r13[8];
301     uint32_t banked_r14[8];
302 
303     /* These hold r8-r12.  */
304     uint32_t usr_regs[5];
305     uint32_t fiq_regs[5];
306 
307     /* cpsr flag cache for faster execution */
308     uint32_t CF; /* 0 or 1 */
309     uint32_t VF; /* V is the bit 31. All other bits are undefined */
310     uint32_t NF; /* N is bit 31. All other bits are undefined.  */
311     uint32_t ZF; /* Z set if zero.  */
312     uint32_t QF; /* 0 or 1 */
313     uint32_t GE; /* cpsr[19:16] */
314     uint32_t condexec_bits; /* IT bits.  cpsr[15:10,26:25].  */
315     uint32_t btype;  /* BTI branch type.  spsr[11:10].  */
316     uint64_t daif; /* exception masks, in the bits they are in PSTATE */
317     uint64_t svcr; /* PSTATE.{SM,ZA} in the bits they are in SVCR */
318 
319     uint64_t elr_el[4]; /* AArch64 exception link regs  */
320     uint64_t sp_el[4]; /* AArch64 banked stack pointers */
321 
322     /* System control coprocessor (cp15) */
323     struct {
324         uint32_t c0_cpuid;
325         union { /* Cache size selection */
326             struct {
327                 uint64_t _unused_csselr0;
328                 uint64_t csselr_ns;
329                 uint64_t _unused_csselr1;
330                 uint64_t csselr_s;
331             };
332             uint64_t csselr_el[4];
333         };
334         union { /* System control register. */
335             struct {
336                 uint64_t _unused_sctlr;
337                 uint64_t sctlr_ns;
338                 uint64_t hsctlr;
339                 uint64_t sctlr_s;
340             };
341             uint64_t sctlr_el[4];
342         };
343         uint64_t vsctlr; /* Virtualization System control register. */
344         uint64_t cpacr_el1; /* Architectural feature access control register */
345         uint64_t cptr_el[4];  /* ARMv8 feature trap registers */
346         uint32_t c1_xscaleauxcr; /* XScale auxiliary control register.  */
347         uint64_t sder; /* Secure debug enable register. */
348         uint32_t nsacr; /* Non-secure access control register. */
349         union { /* MMU translation table base 0. */
350             struct {
351                 uint64_t _unused_ttbr0_0;
352                 uint64_t ttbr0_ns;
353                 uint64_t _unused_ttbr0_1;
354                 uint64_t ttbr0_s;
355             };
356             uint64_t ttbr0_el[4];
357         };
358         union { /* MMU translation table base 1. */
359             struct {
360                 uint64_t _unused_ttbr1_0;
361                 uint64_t ttbr1_ns;
362                 uint64_t _unused_ttbr1_1;
363                 uint64_t ttbr1_s;
364             };
365             uint64_t ttbr1_el[4];
366         };
367         uint64_t vttbr_el2; /* Virtualization Translation Table Base.  */
368         uint64_t vsttbr_el2; /* Secure Virtualization Translation Table. */
369         /* MMU translation table base control. */
370         uint64_t tcr_el[4];
371         uint64_t vtcr_el2; /* Virtualization Translation Control.  */
372         uint64_t vstcr_el2; /* Secure Virtualization Translation Control. */
373         uint32_t c2_data; /* MPU data cacheable bits.  */
374         uint32_t c2_insn; /* MPU instruction cacheable bits.  */
375         union { /* MMU domain access control register
376                  * MPU write buffer control.
377                  */
378             struct {
379                 uint64_t dacr_ns;
380                 uint64_t dacr_s;
381             };
382             struct {
383                 uint64_t dacr32_el2;
384             };
385         };
386         uint32_t pmsav5_data_ap; /* PMSAv5 MPU data access permissions */
387         uint32_t pmsav5_insn_ap; /* PMSAv5 MPU insn access permissions */
388         uint64_t hcr_el2; /* Hypervisor configuration register */
389         uint64_t hcrx_el2; /* Extended Hypervisor configuration register */
390         uint64_t scr_el3; /* Secure configuration register.  */
391         union { /* Fault status registers.  */
392             struct {
393                 uint64_t ifsr_ns;
394                 uint64_t ifsr_s;
395             };
396             struct {
397                 uint64_t ifsr32_el2;
398             };
399         };
400         union {
401             struct {
402                 uint64_t _unused_dfsr;
403                 uint64_t dfsr_ns;
404                 uint64_t hsr;
405                 uint64_t dfsr_s;
406             };
407             uint64_t esr_el[4];
408         };
409         uint32_t c6_region[8]; /* MPU base/size registers.  */
410         union { /* Fault address registers. */
411             struct {
412                 uint64_t _unused_far0;
413 #if HOST_BIG_ENDIAN
414                 uint32_t ifar_ns;
415                 uint32_t dfar_ns;
416                 uint32_t ifar_s;
417                 uint32_t dfar_s;
418 #else
419                 uint32_t dfar_ns;
420                 uint32_t ifar_ns;
421                 uint32_t dfar_s;
422                 uint32_t ifar_s;
423 #endif
424                 uint64_t _unused_far3;
425             };
426             uint64_t far_el[4];
427         };
428         uint64_t hpfar_el2;
429         uint64_t hstr_el2;
430         union { /* Translation result. */
431             struct {
432                 uint64_t _unused_par_0;
433                 uint64_t par_ns;
434                 uint64_t _unused_par_1;
435                 uint64_t par_s;
436             };
437             uint64_t par_el[4];
438         };
439 
440         uint32_t c9_insn; /* Cache lockdown registers.  */
441         uint32_t c9_data;
442         uint64_t c9_pmcr; /* performance monitor control register */
443         uint64_t c9_pmcnten; /* perf monitor counter enables */
444         uint64_t c9_pmovsr; /* perf monitor overflow status */
445         uint64_t c9_pmuserenr; /* perf monitor user enable */
446         uint64_t c9_pmselr; /* perf monitor counter selection register */
447         uint64_t c9_pminten; /* perf monitor interrupt enables */
448         union { /* Memory attribute redirection */
449             struct {
450 #if HOST_BIG_ENDIAN
451                 uint64_t _unused_mair_0;
452                 uint32_t mair1_ns;
453                 uint32_t mair0_ns;
454                 uint64_t _unused_mair_1;
455                 uint32_t mair1_s;
456                 uint32_t mair0_s;
457 #else
458                 uint64_t _unused_mair_0;
459                 uint32_t mair0_ns;
460                 uint32_t mair1_ns;
461                 uint64_t _unused_mair_1;
462                 uint32_t mair0_s;
463                 uint32_t mair1_s;
464 #endif
465             };
466             uint64_t mair_el[4];
467         };
468         union { /* vector base address register */
469             struct {
470                 uint64_t _unused_vbar;
471                 uint64_t vbar_ns;
472                 uint64_t hvbar;
473                 uint64_t vbar_s;
474             };
475             uint64_t vbar_el[4];
476         };
477         uint32_t mvbar; /* (monitor) vector base address register */
478         uint64_t rvbar; /* rvbar sampled from rvbar property at reset */
479         struct { /* FCSE PID. */
480             uint32_t fcseidr_ns;
481             uint32_t fcseidr_s;
482         };
483         union { /* Context ID. */
484             struct {
485                 uint64_t _unused_contextidr_0;
486                 uint64_t contextidr_ns;
487                 uint64_t _unused_contextidr_1;
488                 uint64_t contextidr_s;
489             };
490             uint64_t contextidr_el[4];
491         };
492         union { /* User RW Thread register. */
493             struct {
494                 uint64_t tpidrurw_ns;
495                 uint64_t tpidrprw_ns;
496                 uint64_t htpidr;
497                 uint64_t _tpidr_el3;
498             };
499             uint64_t tpidr_el[4];
500         };
501         uint64_t tpidr2_el0;
502         /* The secure banks of these registers don't map anywhere */
503         uint64_t tpidrurw_s;
504         uint64_t tpidrprw_s;
505         uint64_t tpidruro_s;
506 
507         union { /* User RO Thread register. */
508             uint64_t tpidruro_ns;
509             uint64_t tpidrro_el[1];
510         };
511         uint64_t c14_cntfrq; /* Counter Frequency register */
512         uint64_t c14_cntkctl; /* Timer Control register */
513         uint64_t cnthctl_el2; /* Counter/Timer Hyp Control register */
514         uint64_t cntvoff_el2; /* Counter Virtual Offset register */
515         uint64_t cntpoff_el2; /* Counter Physical Offset register */
516         ARMGenericTimer c14_timer[NUM_GTIMERS];
517         uint32_t c15_cpar; /* XScale Coprocessor Access Register */
518         uint32_t c15_ticonfig; /* TI925T configuration byte.  */
519         uint32_t c15_i_max; /* Maximum D-cache dirty line index.  */
520         uint32_t c15_i_min; /* Minimum D-cache dirty line index.  */
521         uint32_t c15_threadid; /* TI debugger thread-ID.  */
522         uint32_t c15_config_base_address; /* SCU base address.  */
523         uint32_t c15_diagnostic; /* diagnostic register */
524         uint32_t c15_power_diagnostic;
525         uint32_t c15_power_control; /* power control */
526         uint64_t dbgbvr[16]; /* breakpoint value registers */
527         uint64_t dbgbcr[16]; /* breakpoint control registers */
528         uint64_t dbgwvr[16]; /* watchpoint value registers */
529         uint64_t dbgwcr[16]; /* watchpoint control registers */
530         uint64_t dbgclaim;   /* DBGCLAIM bits */
531         uint64_t mdscr_el1;
532         uint64_t oslsr_el1; /* OS Lock Status */
533         uint64_t osdlr_el1; /* OS DoubleLock status */
534         uint64_t mdcr_el2;
535         uint64_t mdcr_el3;
536         /* Stores the architectural value of the counter *the last time it was
537          * updated* by pmccntr_op_start. Accesses should always be surrounded
538          * by pmccntr_op_start/pmccntr_op_finish to guarantee the latest
539          * architecturally-correct value is being read/set.
540          */
541         uint64_t c15_ccnt;
542         /* Stores the delta between the architectural value and the underlying
543          * cycle count during normal operation. It is used to update c15_ccnt
544          * to be the correct architectural value before accesses. During
545          * accesses, c15_ccnt_delta contains the underlying count being used
546          * for the access, after which it reverts to the delta value in
547          * pmccntr_op_finish.
548          */
549         uint64_t c15_ccnt_delta;
550         uint64_t c14_pmevcntr[31];
551         uint64_t c14_pmevcntr_delta[31];
552         uint64_t c14_pmevtyper[31];
553         uint64_t pmccfiltr_el0; /* Performance Monitor Filter Register */
554         uint64_t vpidr_el2; /* Virtualization Processor ID Register */
555         uint64_t vmpidr_el2; /* Virtualization Multiprocessor ID Register */
556         uint64_t tfsr_el[4]; /* tfsre0_el1 is index 0.  */
557         uint64_t gcr_el1;
558         uint64_t rgsr_el1;
559 
560         /* Minimal RAS registers */
561         uint64_t disr_el1;
562         uint64_t vdisr_el2;
563         uint64_t vsesr_el2;
564 
565         /*
566          * Fine-Grained Trap registers. We store these as arrays so the
567          * access checking code doesn't have to manually select
568          * HFGRTR_EL2 vs HFDFGRTR_EL2 etc when looking up the bit to test.
569          * FEAT_FGT2 will add more elements to these arrays.
570          */
571         uint64_t fgt_read[2]; /* HFGRTR, HDFGRTR */
572         uint64_t fgt_write[2]; /* HFGWTR, HDFGWTR */
573         uint64_t fgt_exec[1]; /* HFGITR */
574 
575         /* RME registers */
576         uint64_t gpccr_el3;
577         uint64_t gptbr_el3;
578         uint64_t mfar_el3;
579 
580         /* NV2 register */
581         uint64_t vncr_el2;
582     } cp15;
583 
584     struct {
585         /* M profile has up to 4 stack pointers:
586          * a Main Stack Pointer and a Process Stack Pointer for each
587          * of the Secure and Non-Secure states. (If the CPU doesn't support
588          * the security extension then it has only two SPs.)
589          * In QEMU we always store the currently active SP in regs[13],
590          * and the non-active SP for the current security state in
591          * v7m.other_sp. The stack pointers for the inactive security state
592          * are stored in other_ss_msp and other_ss_psp.
593          * switch_v7m_security_state() is responsible for rearranging them
594          * when we change security state.
595          */
596         uint32_t other_sp;
597         uint32_t other_ss_msp;
598         uint32_t other_ss_psp;
599         uint32_t vecbase[M_REG_NUM_BANKS];
600         uint32_t basepri[M_REG_NUM_BANKS];
601         uint32_t control[M_REG_NUM_BANKS];
602         uint32_t ccr[M_REG_NUM_BANKS]; /* Configuration and Control */
603         uint32_t cfsr[M_REG_NUM_BANKS]; /* Configurable Fault Status */
604         uint32_t hfsr; /* HardFault Status */
605         uint32_t dfsr; /* Debug Fault Status Register */
606         uint32_t sfsr; /* Secure Fault Status Register */
607         uint32_t mmfar[M_REG_NUM_BANKS]; /* MemManage Fault Address */
608         uint32_t bfar; /* BusFault Address */
609         uint32_t sfar; /* Secure Fault Address Register */
610         unsigned mpu_ctrl[M_REG_NUM_BANKS]; /* MPU_CTRL */
611         int exception;
612         uint32_t primask[M_REG_NUM_BANKS];
613         uint32_t faultmask[M_REG_NUM_BANKS];
614         uint32_t aircr; /* only holds r/w state if security extn implemented */
615         uint32_t secure; /* Is CPU in Secure state? (not guest visible) */
616         uint32_t csselr[M_REG_NUM_BANKS];
617         uint32_t scr[M_REG_NUM_BANKS];
618         uint32_t msplim[M_REG_NUM_BANKS];
619         uint32_t psplim[M_REG_NUM_BANKS];
620         uint32_t fpcar[M_REG_NUM_BANKS];
621         uint32_t fpccr[M_REG_NUM_BANKS];
622         uint32_t fpdscr[M_REG_NUM_BANKS];
623         uint32_t cpacr[M_REG_NUM_BANKS];
624         uint32_t nsacr;
625         uint32_t ltpsize;
626         uint32_t vpr;
627     } v7m;
628 
629     /* Information associated with an exception about to be taken:
630      * code which raises an exception must set cs->exception_index and
631      * the relevant parts of this structure; the cpu_do_interrupt function
632      * will then set the guest-visible registers as part of the exception
633      * entry process.
634      */
635     struct {
636         uint32_t syndrome; /* AArch64 format syndrome register */
637         uint32_t fsr; /* AArch32 format fault status register info */
638         uint64_t vaddress; /* virtual addr associated with exception, if any */
639         uint32_t target_el; /* EL the exception should be targeted for */
640         /* If we implement EL2 we will also need to store information
641          * about the intermediate physical address for stage 2 faults.
642          */
643     } exception;
644 
645     /* Information associated with an SError */
646     struct {
647         uint8_t pending;
648         uint8_t has_esr;
649         uint64_t esr;
650     } serror;
651 
652     uint8_t ext_dabt_raised; /* Tracking/verifying injection of ext DABT */
653 
654     /* State of our input IRQ/FIQ/VIRQ/VFIQ lines */
655     uint32_t irq_line_state;
656 
657     /* Thumb-2 EE state.  */
658     uint32_t teecr;
659     uint32_t teehbr;
660 
661     /* VFP coprocessor state.  */
662     struct {
663         ARMVectorReg zregs[32];
664 
665 #ifdef TARGET_AARCH64
666         /* Store FFR as pregs[16] to make it easier to treat as any other.  */
667 #define FFR_PRED_NUM 16
668         ARMPredicateReg pregs[17];
669         /* Scratch space for aa64 sve predicate temporary.  */
670         ARMPredicateReg preg_tmp;
671 #endif
672 
673         /* We store these fpcsr fields separately for convenience.  */
674         uint32_t qc[4] QEMU_ALIGNED(16);
675         int vec_len;
676         int vec_stride;
677 
678         /*
679          * Floating point status and control registers. Some bits are
680          * stored separately in other fields or in the float_status below.
681          */
682         uint64_t fpsr;
683         uint64_t fpcr;
684 
685         uint32_t xregs[16];
686 
687         /* Scratch space for aa32 neon expansion.  */
688         uint32_t scratch[8];
689 
690         /* There are a number of distinct float control structures. */
691         float_status fp_status[FPST_COUNT];
692 
693         uint64_t zcr_el[4];   /* ZCR_EL[1-3] */
694         uint64_t smcr_el[4];  /* SMCR_EL[1-3] */
695     } vfp;
696 
697     uint64_t exclusive_addr;
698     uint64_t exclusive_val;
699     /*
700      * Contains the 'val' for the second 64-bit register of LDXP, which comes
701      * from the higher address, not the high part of a complete 128-bit value.
702      * In some ways it might be more convenient to record the exclusive value
703      * as the low and high halves of a 128 bit data value, but the current
704      * semantics of these fields are baked into the migration format.
705      */
706     uint64_t exclusive_high;
707 
708     /* iwMMXt coprocessor state.  */
709     struct {
710         uint64_t regs[16];
711         uint64_t val;
712 
713         uint32_t cregs[16];
714     } iwmmxt;
715 
716 #ifdef TARGET_AARCH64
717     struct {
718         ARMPACKey apia;
719         ARMPACKey apib;
720         ARMPACKey apda;
721         ARMPACKey apdb;
722         ARMPACKey apga;
723     } keys;
724 
725     uint64_t scxtnum_el[4];
726 
727     /*
728      * SME ZA storage -- 256 x 256 byte array, with bytes in host word order,
729      * as we do with vfp.zregs[].  This corresponds to the architectural ZA
730      * array, where ZA[N] is in the least-significant bytes of env->zarray[N].
731      * When SVL is less than the architectural maximum, the accessible
732      * storage is restricted, such that if the SVL is X bytes the guest can
733      * see only the bottom X elements of zarray[], and only the least
734      * significant X bytes of each element of the array. (In other words,
735      * the observable part is always square.)
736      *
737      * The ZA storage can also be considered as a set of square tiles of
738      * elements of different sizes. The mapping from tiles to the ZA array
739      * is architecturally defined, such that for tiles of elements of esz
740      * bytes, the Nth row (or "horizontal slice") of tile T is in
741      * ZA[T + N * esz]. Note that this means that each tile is not contiguous
742      * in the ZA storage, because its rows are striped through the ZA array.
743      *
744      * Because this is so large, keep this toward the end of the reset area,
745      * to keep the offsets into the rest of the structure smaller.
746      */
747     ARMVectorReg zarray[ARM_MAX_VQ * 16];
748 #endif
749 
750     struct CPUBreakpoint *cpu_breakpoint[16];
751     struct CPUWatchpoint *cpu_watchpoint[16];
752 
753     /* Optional fault info across tlb lookup. */
754     ARMMMUFaultInfo *tlb_fi;
755 
756     /* Fields up to this point are cleared by a CPU reset */
757     struct {} end_reset_fields;
758 
759     /* Fields after this point are preserved across CPU reset. */
760 
761     /* Internal CPU feature flags.  */
762     uint64_t features;
763 
764     /* PMSAv7 MPU */
765     struct {
766         uint32_t *drbar;
767         uint32_t *drsr;
768         uint32_t *dracr;
769         uint32_t rnr[M_REG_NUM_BANKS];
770     } pmsav7;
771 
772     /* PMSAv8 MPU */
773     struct {
774         /* The PMSAv8 implementation also shares some PMSAv7 config
775          * and state:
776          *  pmsav7.rnr (region number register)
777          *  pmsav7_dregion (number of configured regions)
778          */
779         uint32_t *rbar[M_REG_NUM_BANKS];
780         uint32_t *rlar[M_REG_NUM_BANKS];
781         uint32_t *hprbar;
782         uint32_t *hprlar;
783         uint32_t mair0[M_REG_NUM_BANKS];
784         uint32_t mair1[M_REG_NUM_BANKS];
785         uint32_t hprselr;
786     } pmsav8;
787 
788     /* v8M SAU */
789     struct {
790         uint32_t *rbar;
791         uint32_t *rlar;
792         uint32_t rnr;
793         uint32_t ctrl;
794     } sau;
795 
796 #if !defined(CONFIG_USER_ONLY)
797     NVICState *nvic;
798     const struct arm_boot_info *boot_info;
799     /* Store GICv3CPUState to access from this struct */
800     void *gicv3state;
801 #else /* CONFIG_USER_ONLY */
802     /* For usermode syscall translation.  */
803     bool eabi;
804 #endif /* CONFIG_USER_ONLY */
805 
806 #ifdef TARGET_TAGGED_ADDRESSES
807     /* Linux syscall tagged address support */
808     bool tagged_addr_enable;
809 #endif
810 } CPUARMState;
811 
812 static inline void set_feature(CPUARMState *env, int feature)
813 {
814     env->features |= 1ULL << feature;
815 }
816 
817 static inline void unset_feature(CPUARMState *env, int feature)
818 {
819     env->features &= ~(1ULL << feature);
820 }
821 
822 /**
823  * ARMELChangeHookFn:
824  * type of a function which can be registered via arm_register_el_change_hook()
825  * to get callbacks when the CPU changes its exception level or mode.
826  */
827 typedef void ARMELChangeHookFn(ARMCPU *cpu, void *opaque);
828 typedef struct ARMELChangeHook ARMELChangeHook;
829 struct ARMELChangeHook {
830     ARMELChangeHookFn *hook;
831     void *opaque;
832     QLIST_ENTRY(ARMELChangeHook) node;
833 };
834 
835 /* These values map onto the return values for
836  * QEMU_PSCI_0_2_FN_AFFINITY_INFO */
837 typedef enum ARMPSCIState {
838     PSCI_ON = 0,
839     PSCI_OFF = 1,
840     PSCI_ON_PENDING = 2
841 } ARMPSCIState;
842 
843 typedef struct ARMISARegisters ARMISARegisters;
844 
845 /*
846  * In map, each set bit is a supported vector length of (bit-number + 1) * 16
847  * bytes, i.e. each bit number + 1 is the vector length in quadwords.
848  *
849  * While processing properties during initialization, corresponding init bits
850  * are set for bits in sve_vq_map that have been set by properties.
851  *
852  * Bits set in supported represent valid vector lengths for the CPU type.
853  */
854 typedef struct {
855     uint32_t map, init, supported;
856 } ARMVQMap;
857 
858 /**
859  * ARMCPU:
860  * @env: #CPUARMState
861  *
862  * An ARM CPU core.
863  */
864 struct ArchCPU {
865     CPUState parent_obj;
866 
867     CPUARMState env;
868 
869     /* Coprocessor information */
870     GHashTable *cp_regs;
871     /* For marshalling (mostly coprocessor) register state between the
872      * kernel and QEMU (for KVM) and between two QEMUs (for migration),
873      * we use these arrays.
874      */
875     /* List of register indexes managed via these arrays; (full KVM style
876      * 64 bit indexes, not CPRegInfo 32 bit indexes)
877      */
878     uint64_t *cpreg_indexes;
879     /* Values of the registers (cpreg_indexes[i]'s value is cpreg_values[i]) */
880     uint64_t *cpreg_values;
881     /* Length of the indexes, values, reset_values arrays */
882     int32_t cpreg_array_len;
883     /* These are used only for migration: incoming data arrives in
884      * these fields and is sanity checked in post_load before copying
885      * to the working data structures above.
886      */
887     uint64_t *cpreg_vmstate_indexes;
888     uint64_t *cpreg_vmstate_values;
889     int32_t cpreg_vmstate_array_len;
890 
891     DynamicGDBFeatureInfo dyn_sysreg_feature;
892     DynamicGDBFeatureInfo dyn_svereg_feature;
893     DynamicGDBFeatureInfo dyn_m_systemreg_feature;
894     DynamicGDBFeatureInfo dyn_m_secextreg_feature;
895 
896     /* Timers used by the generic (architected) timer */
897     QEMUTimer *gt_timer[NUM_GTIMERS];
898     /*
899      * Timer used by the PMU. Its state is restored after migration by
900      * pmu_op_finish() - it does not need other handling during migration
901      */
902     QEMUTimer *pmu_timer;
903     /* Timer used for WFxT timeouts */
904     QEMUTimer *wfxt_timer;
905 
906     /* GPIO outputs for generic timer */
907     qemu_irq gt_timer_outputs[NUM_GTIMERS];
908     /* GPIO output for GICv3 maintenance interrupt signal */
909     qemu_irq gicv3_maintenance_interrupt;
910     /* GPIO output for the PMU interrupt */
911     qemu_irq pmu_interrupt;
912 
913     /* MemoryRegion to use for secure physical accesses */
914     MemoryRegion *secure_memory;
915 
916     /* MemoryRegion to use for allocation tag accesses */
917     MemoryRegion *tag_memory;
918     MemoryRegion *secure_tag_memory;
919 
920     /* For v8M, pointer to the IDAU interface provided by board/SoC */
921     Object *idau;
922 
923     /* 'compatible' string for this CPU for Linux device trees */
924     const char *dtb_compatible;
925 
926     /* PSCI version for this CPU
927      * Bits[31:16] = Major Version
928      * Bits[15:0] = Minor Version
929      */
930     uint32_t psci_version;
931 
932     /* Current power state, access guarded by BQL */
933     ARMPSCIState power_state;
934 
935     /* CPU has virtualization extension */
936     bool has_el2;
937     /* CPU has security extension */
938     bool has_el3;
939     /* CPU has PMU (Performance Monitor Unit) */
940     bool has_pmu;
941     /* CPU has VFP */
942     bool has_vfp;
943     /* CPU has 32 VFP registers */
944     bool has_vfp_d32;
945     /* CPU has Neon */
946     bool has_neon;
947     /* CPU has M-profile DSP extension */
948     bool has_dsp;
949 
950     /* CPU has memory protection unit */
951     bool has_mpu;
952     /* CPU has MTE enabled in KVM mode */
953     bool kvm_mte;
954     /* PMSAv7 MPU number of supported regions */
955     uint32_t pmsav7_dregion;
956     /* PMSAv8 MPU number of supported hyp regions */
957     uint32_t pmsav8r_hdregion;
958     /* v8M SAU number of supported regions */
959     uint32_t sau_sregion;
960 
961     /* PSCI conduit used to invoke PSCI methods
962      * 0 - disabled, 1 - smc, 2 - hvc
963      */
964     uint32_t psci_conduit;
965 
966     /* For v8M, initial value of the Secure VTOR */
967     uint32_t init_svtor;
968     /* For v8M, initial value of the Non-secure VTOR */
969     uint32_t init_nsvtor;
970 
971     /* [QEMU_]KVM_ARM_TARGET_* constant for this CPU, or
972      * QEMU_KVM_ARM_TARGET_NONE if the kernel doesn't support this CPU type.
973      */
974     uint32_t kvm_target;
975 
976 #ifdef CONFIG_KVM
977     /* KVM init features for this CPU */
978     uint32_t kvm_init_features[7];
979 
980     /* KVM CPU state */
981 
982     /* KVM virtual time adjustment */
983     bool kvm_adjvtime;
984     bool kvm_vtime_dirty;
985     uint64_t kvm_vtime;
986 
987     /* KVM steal time */
988     OnOffAuto kvm_steal_time;
989 #endif /* CONFIG_KVM */
990 
991     /* Uniprocessor system with MP extensions */
992     bool mp_is_up;
993 
994     /* True if we tried kvm_arm_host_cpu_features() during CPU instance_init
995      * and the probe failed (so we need to report the error in realize)
996      */
997     bool host_cpu_probe_failed;
998 
999     /* QOM property to indicate we should use the back-compat CNTFRQ default */
1000     bool backcompat_cntfrq;
1001 
1002     /* QOM property to indicate we should use the back-compat QARMA5 default */
1003     bool backcompat_pauth_default_use_qarma5;
1004 
1005     /* Specify the number of cores in this CPU cluster. Used for the L2CTLR
1006      * register.
1007      */
1008     int32_t core_count;
1009 
1010     /* The instance init functions for implementation-specific subclasses
1011      * set these fields to specify the implementation-dependent values of
1012      * various constant registers and reset values of non-constant
1013      * registers.
1014      * Some of these might become QOM properties eventually.
1015      * Field names match the official register names as defined in the
1016      * ARMv7AR ARM Architecture Reference Manual. A reset_ prefix
1017      * is used for reset values of non-constant registers; no reset_
1018      * prefix means a constant register.
1019      * Some of these registers are split out into a substructure that
1020      * is shared with the translators to control the ISA.
1021      *
1022      * Note that if you add an ID register to the ARMISARegisters struct
1023      * you need to also update the 32-bit and 64-bit versions of the
1024      * kvm_arm_get_host_cpu_features() function to correctly populate the
1025      * field by reading the value from the KVM vCPU.
1026      */
1027     struct ARMISARegisters {
1028         uint32_t id_isar0;
1029         uint32_t id_isar1;
1030         uint32_t id_isar2;
1031         uint32_t id_isar3;
1032         uint32_t id_isar4;
1033         uint32_t id_isar5;
1034         uint32_t id_isar6;
1035         uint32_t id_mmfr0;
1036         uint32_t id_mmfr1;
1037         uint32_t id_mmfr2;
1038         uint32_t id_mmfr3;
1039         uint32_t id_mmfr4;
1040         uint32_t id_mmfr5;
1041         uint32_t id_pfr0;
1042         uint32_t id_pfr1;
1043         uint32_t id_pfr2;
1044         uint32_t mvfr0;
1045         uint32_t mvfr1;
1046         uint32_t mvfr2;
1047         uint32_t id_dfr0;
1048         uint32_t id_dfr1;
1049         uint32_t dbgdidr;
1050         uint32_t dbgdevid;
1051         uint32_t dbgdevid1;
1052         uint64_t id_aa64isar0;
1053         uint64_t id_aa64isar1;
1054         uint64_t id_aa64isar2;
1055         uint64_t id_aa64pfr0;
1056         uint64_t id_aa64pfr1;
1057         uint64_t id_aa64mmfr0;
1058         uint64_t id_aa64mmfr1;
1059         uint64_t id_aa64mmfr2;
1060         uint64_t id_aa64mmfr3;
1061         uint64_t id_aa64dfr0;
1062         uint64_t id_aa64dfr1;
1063         uint64_t id_aa64zfr0;
1064         uint64_t id_aa64smfr0;
1065         uint64_t reset_pmcr_el0;
1066     } isar;
1067     uint64_t midr;
1068     uint32_t revidr;
1069     uint32_t reset_fpsid;
1070     uint64_t ctr;
1071     uint32_t reset_sctlr;
1072     uint64_t pmceid0;
1073     uint64_t pmceid1;
1074     uint32_t id_afr0;
1075     uint64_t id_aa64afr0;
1076     uint64_t id_aa64afr1;
1077     uint64_t clidr;
1078     uint64_t mp_affinity; /* MP ID without feature bits */
1079     /* The elements of this array are the CCSIDR values for each cache,
1080      * in the order L1DCache, L1ICache, L2DCache, L2ICache, etc.
1081      */
1082     uint64_t ccsidr[16];
1083     uint64_t reset_cbar;
1084     uint32_t reset_auxcr;
1085     bool reset_hivecs;
1086     uint8_t reset_l0gptsz;
1087 
1088     /*
1089      * Intermediate values used during property parsing.
1090      * Once finalized, the values should be read from ID_AA64*.
1091      */
1092     bool prop_pauth;
1093     bool prop_pauth_impdef;
1094     bool prop_pauth_qarma3;
1095     bool prop_pauth_qarma5;
1096     bool prop_lpa2;
1097 
1098     /* DCZ blocksize, in log_2(words), ie low 4 bits of DCZID_EL0 */
1099     uint8_t dcz_blocksize;
1100     /* GM blocksize, in log_2(words), ie low 4 bits of GMID_EL0 */
1101     uint8_t gm_blocksize;
1102 
1103     uint64_t rvbar_prop; /* Property/input signals.  */
1104 
1105     /* Configurable aspects of GIC cpu interface (which is part of the CPU) */
1106     int gic_num_lrs; /* number of list registers */
1107     int gic_vpribits; /* number of virtual priority bits */
1108     int gic_vprebits; /* number of virtual preemption bits */
1109     int gic_pribits; /* number of physical priority bits */
1110 
1111     /* Whether the cfgend input is high (i.e. this CPU should reset into
1112      * big-endian mode).  This setting isn't used directly: instead it modifies
1113      * the reset_sctlr value to have SCTLR_B or SCTLR_EE set, depending on the
1114      * architecture version.
1115      */
1116     bool cfgend;
1117 
1118     QLIST_HEAD(, ARMELChangeHook) pre_el_change_hooks;
1119     QLIST_HEAD(, ARMELChangeHook) el_change_hooks;
1120 
1121     int32_t node_id; /* NUMA node this CPU belongs to */
1122 
1123     /* Used to synchronize KVM and QEMU in-kernel device levels */
1124     uint8_t device_irq_level;
1125 
1126     /* Used to set the maximum vector length the cpu will support.  */
1127     uint32_t sve_max_vq;
1128 
1129 #ifdef CONFIG_USER_ONLY
1130     /* Used to set the default vector length at process start. */
1131     uint32_t sve_default_vq;
1132     uint32_t sme_default_vq;
1133 #endif
1134 
1135     ARMVQMap sve_vq;
1136     ARMVQMap sme_vq;
1137 
1138     /* Generic timer counter frequency, in Hz */
1139     uint64_t gt_cntfrq_hz;
1140 };
1141 
1142 typedef struct ARMCPUInfo {
1143     const char *name;
1144     const char *deprecation_note;
1145     void (*initfn)(Object *obj);
1146     void (*class_init)(ObjectClass *oc, void *data);
1147 } ARMCPUInfo;
1148 
1149 /**
1150  * ARMCPUClass:
1151  * @parent_realize: The parent class' realize handler.
1152  * @parent_phases: The parent class' reset phase handlers.
1153  *
1154  * An ARM CPU model.
1155  */
1156 struct ARMCPUClass {
1157     CPUClass parent_class;
1158 
1159     const ARMCPUInfo *info;
1160     DeviceRealize parent_realize;
1161     ResettablePhases parent_phases;
1162 };
1163 
1164 struct AArch64CPUClass {
1165     ARMCPUClass parent_class;
1166 };
1167 
1168 /* Callback functions for the generic timer's timers. */
1169 void arm_gt_ptimer_cb(void *opaque);
1170 void arm_gt_vtimer_cb(void *opaque);
1171 void arm_gt_htimer_cb(void *opaque);
1172 void arm_gt_stimer_cb(void *opaque);
1173 void arm_gt_hvtimer_cb(void *opaque);
1174 void arm_gt_sel2timer_cb(void *opaque);
1175 void arm_gt_sel2vtimer_cb(void *opaque);
1176 
1177 unsigned int gt_cntfrq_period_ns(ARMCPU *cpu);
1178 void gt_rme_post_el_change(ARMCPU *cpu, void *opaque);
1179 
1180 void arm_cpu_post_init(Object *obj);
1181 
1182 #define ARM_AFF0_SHIFT 0
1183 #define ARM_AFF0_MASK  (0xFFULL << ARM_AFF0_SHIFT)
1184 #define ARM_AFF1_SHIFT 8
1185 #define ARM_AFF1_MASK  (0xFFULL << ARM_AFF1_SHIFT)
1186 #define ARM_AFF2_SHIFT 16
1187 #define ARM_AFF2_MASK  (0xFFULL << ARM_AFF2_SHIFT)
1188 #define ARM_AFF3_SHIFT 32
1189 #define ARM_AFF3_MASK  (0xFFULL << ARM_AFF3_SHIFT)
1190 #define ARM_DEFAULT_CPUS_PER_CLUSTER 8
1191 
1192 #define ARM32_AFFINITY_MASK (ARM_AFF0_MASK | ARM_AFF1_MASK | ARM_AFF2_MASK)
1193 #define ARM64_AFFINITY_MASK \
1194     (ARM_AFF0_MASK | ARM_AFF1_MASK | ARM_AFF2_MASK | ARM_AFF3_MASK)
1195 #define ARM64_AFFINITY_INVALID (~ARM64_AFFINITY_MASK)
1196 
1197 uint64_t arm_build_mp_affinity(int idx, uint8_t clustersz);
1198 
1199 #ifndef CONFIG_USER_ONLY
1200 extern const VMStateDescription vmstate_arm_cpu;
1201 
1202 void arm_cpu_do_interrupt(CPUState *cpu);
1203 void arm_v7m_cpu_do_interrupt(CPUState *cpu);
1204 
1205 hwaddr arm_cpu_get_phys_page_attrs_debug(CPUState *cpu, vaddr addr,
1206                                          MemTxAttrs *attrs);
1207 #endif /* !CONFIG_USER_ONLY */
1208 
1209 int arm_cpu_gdb_read_register(CPUState *cpu, GByteArray *buf, int reg);
1210 int arm_cpu_gdb_write_register(CPUState *cpu, uint8_t *buf, int reg);
1211 
1212 int arm_cpu_write_elf64_note(WriteCoreDumpFunction f, CPUState *cs,
1213                              int cpuid, DumpState *s);
1214 int arm_cpu_write_elf32_note(WriteCoreDumpFunction f, CPUState *cs,
1215                              int cpuid, DumpState *s);
1216 
1217 /**
1218  * arm_emulate_firmware_reset: Emulate firmware CPU reset handling
1219  * @cpu: CPU (which must have been freshly reset)
1220  * @target_el: exception level to put the CPU into
1221  * @secure: whether to put the CPU in secure state
1222  *
1223  * When QEMU is directly running a guest kernel at a lower level than
1224  * EL3 it implicitly emulates some aspects of the guest firmware.
1225  * This includes that on reset we need to configure the parts of the
1226  * CPU corresponding to EL3 so that the real guest code can run at its
1227  * lower exception level. This function does that post-reset CPU setup,
1228  * for when we do direct boot of a guest kernel, and for when we
1229  * emulate PSCI and similar firmware interfaces starting a CPU at a
1230  * lower exception level.
1231  *
1232  * @target_el must be an EL implemented by the CPU between 1 and 3.
1233  * We do not support dropping into a Secure EL other than 3.
1234  *
1235  * It is the responsibility of the caller to call arm_rebuild_hflags().
1236  */
1237 void arm_emulate_firmware_reset(CPUState *cpustate, int target_el);
1238 
1239 #ifdef TARGET_AARCH64
1240 int aarch64_cpu_gdb_read_register(CPUState *cpu, GByteArray *buf, int reg);
1241 int aarch64_cpu_gdb_write_register(CPUState *cpu, uint8_t *buf, int reg);
1242 void aarch64_sve_narrow_vq(CPUARMState *env, unsigned vq);
1243 void aarch64_sve_change_el(CPUARMState *env, int old_el,
1244                            int new_el, bool el0_a64);
1245 void aarch64_set_svcr(CPUARMState *env, uint64_t new, uint64_t mask);
1246 
1247 /*
1248  * SVE registers are encoded in KVM's memory in an endianness-invariant format.
1249  * The byte at offset i from the start of the in-memory representation contains
1250  * the bits [(7 + 8 * i) : (8 * i)] of the register value. As this means the
1251  * lowest offsets are stored in the lowest memory addresses, then that nearly
1252  * matches QEMU's representation, which is to use an array of host-endian
1253  * uint64_t's, where the lower offsets are at the lower indices. To complete
1254  * the translation we just need to byte swap the uint64_t's on big-endian hosts.
1255  */
1256 static inline uint64_t *sve_bswap64(uint64_t *dst, uint64_t *src, int nr)
1257 {
1258 #if HOST_BIG_ENDIAN
1259     int i;
1260 
1261     for (i = 0; i < nr; ++i) {
1262         dst[i] = bswap64(src[i]);
1263     }
1264 
1265     return dst;
1266 #else
1267     return src;
1268 #endif
1269 }
1270 
1271 #else
1272 static inline void aarch64_sve_narrow_vq(CPUARMState *env, unsigned vq) { }
1273 static inline void aarch64_sve_change_el(CPUARMState *env, int o,
1274                                          int n, bool a)
1275 { }
1276 #endif
1277 
1278 void aarch64_sync_32_to_64(CPUARMState *env);
1279 void aarch64_sync_64_to_32(CPUARMState *env);
1280 
1281 int fp_exception_el(CPUARMState *env, int cur_el);
1282 int sve_exception_el(CPUARMState *env, int cur_el);
1283 int sme_exception_el(CPUARMState *env, int cur_el);
1284 
1285 /**
1286  * sve_vqm1_for_el_sm:
1287  * @env: CPUARMState
1288  * @el: exception level
1289  * @sm: streaming mode
1290  *
1291  * Compute the current vector length for @el & @sm, in units of
1292  * Quadwords Minus 1 -- the same scale used for ZCR_ELx.LEN.
1293  * If @sm, compute for SVL, otherwise NVL.
1294  */
1295 uint32_t sve_vqm1_for_el_sm(CPUARMState *env, int el, bool sm);
1296 
1297 /* Likewise, but using @sm = PSTATE.SM. */
1298 uint32_t sve_vqm1_for_el(CPUARMState *env, int el);
1299 
1300 static inline bool is_a64(CPUARMState *env)
1301 {
1302     return env->aarch64;
1303 }
1304 
1305 /**
1306  * pmu_op_start/finish
1307  * @env: CPUARMState
1308  *
1309  * Convert all PMU counters between their delta form (the typical mode when
1310  * they are enabled) and the guest-visible values. These two calls must
1311  * surround any action which might affect the counters.
1312  */
1313 void pmu_op_start(CPUARMState *env);
1314 void pmu_op_finish(CPUARMState *env);
1315 
1316 /*
1317  * Called when a PMU counter is due to overflow
1318  */
1319 void arm_pmu_timer_cb(void *opaque);
1320 
1321 /**
1322  * Functions to register as EL change hooks for PMU mode filtering
1323  */
1324 void pmu_pre_el_change(ARMCPU *cpu, void *ignored);
1325 void pmu_post_el_change(ARMCPU *cpu, void *ignored);
1326 
1327 /*
1328  * pmu_init
1329  * @cpu: ARMCPU
1330  *
1331  * Initialize the CPU's PMCEID[01]_EL0 registers and associated internal state
1332  * for the current configuration
1333  */
1334 void pmu_init(ARMCPU *cpu);
1335 
1336 /* SCTLR bit meanings. Several bits have been reused in newer
1337  * versions of the architecture; in that case we define constants
1338  * for both old and new bit meanings. Code which tests against those
1339  * bits should probably check or otherwise arrange that the CPU
1340  * is the architectural version it expects.
1341  */
1342 #define SCTLR_M       (1U << 0)
1343 #define SCTLR_A       (1U << 1)
1344 #define SCTLR_C       (1U << 2)
1345 #define SCTLR_W       (1U << 3) /* up to v6; RAO in v7 */
1346 #define SCTLR_nTLSMD_32 (1U << 3) /* v8.2-LSMAOC, AArch32 only */
1347 #define SCTLR_SA      (1U << 3) /* AArch64 only */
1348 #define SCTLR_P       (1U << 4) /* up to v5; RAO in v6 and v7 */
1349 #define SCTLR_LSMAOE_32 (1U << 4) /* v8.2-LSMAOC, AArch32 only */
1350 #define SCTLR_SA0     (1U << 4) /* v8 onward, AArch64 only */
1351 #define SCTLR_D       (1U << 5) /* up to v5; RAO in v6 */
1352 #define SCTLR_CP15BEN (1U << 5) /* v7 onward */
1353 #define SCTLR_L       (1U << 6) /* up to v5; RAO in v6 and v7; RAZ in v8 */
1354 #define SCTLR_nAA     (1U << 6) /* when FEAT_LSE2 is implemented */
1355 #define SCTLR_B       (1U << 7) /* up to v6; RAZ in v7 */
1356 #define SCTLR_ITD     (1U << 7) /* v8 onward */
1357 #define SCTLR_S       (1U << 8) /* up to v6; RAZ in v7 */
1358 #define SCTLR_SED     (1U << 8) /* v8 onward */
1359 #define SCTLR_R       (1U << 9) /* up to v6; RAZ in v7 */
1360 #define SCTLR_UMA     (1U << 9) /* v8 onward, AArch64 only */
1361 #define SCTLR_F       (1U << 10) /* up to v6 */
1362 #define SCTLR_SW      (1U << 10) /* v7 */
1363 #define SCTLR_EnRCTX  (1U << 10) /* in v8.0-PredInv */
1364 #define SCTLR_Z       (1U << 11) /* in v7, RES1 in v8 */
1365 #define SCTLR_EOS     (1U << 11) /* v8.5-ExS */
1366 #define SCTLR_I       (1U << 12)
1367 #define SCTLR_V       (1U << 13) /* AArch32 only */
1368 #define SCTLR_EnDB    (1U << 13) /* v8.3, AArch64 only */
1369 #define SCTLR_RR      (1U << 14) /* up to v7 */
1370 #define SCTLR_DZE     (1U << 14) /* v8 onward, AArch64 only */
1371 #define SCTLR_L4      (1U << 15) /* up to v6; RAZ in v7 */
1372 #define SCTLR_UCT     (1U << 15) /* v8 onward, AArch64 only */
1373 #define SCTLR_DT      (1U << 16) /* up to ??, RAO in v6 and v7 */
1374 #define SCTLR_nTWI    (1U << 16) /* v8 onward */
1375 #define SCTLR_HA      (1U << 17) /* up to v7, RES0 in v8 */
1376 #define SCTLR_BR      (1U << 17) /* PMSA only */
1377 #define SCTLR_IT      (1U << 18) /* up to ??, RAO in v6 and v7 */
1378 #define SCTLR_nTWE    (1U << 18) /* v8 onward */
1379 #define SCTLR_WXN     (1U << 19)
1380 #define SCTLR_ST      (1U << 20) /* up to ??, RAZ in v6 */
1381 #define SCTLR_UWXN    (1U << 20) /* v7 onward, AArch32 only */
1382 #define SCTLR_TSCXT   (1U << 20) /* FEAT_CSV2_1p2, AArch64 only */
1383 #define SCTLR_FI      (1U << 21) /* up to v7, v8 RES0 */
1384 #define SCTLR_IESB    (1U << 21) /* v8.2-IESB, AArch64 only */
1385 #define SCTLR_U       (1U << 22) /* up to v6, RAO in v7 */
1386 #define SCTLR_EIS     (1U << 22) /* v8.5-ExS */
1387 #define SCTLR_XP      (1U << 23) /* up to v6; v7 onward RAO */
1388 #define SCTLR_SPAN    (1U << 23) /* v8.1-PAN */
1389 #define SCTLR_VE      (1U << 24) /* up to v7 */
1390 #define SCTLR_E0E     (1U << 24) /* v8 onward, AArch64 only */
1391 #define SCTLR_EE      (1U << 25)
1392 #define SCTLR_L2      (1U << 26) /* up to v6, RAZ in v7 */
1393 #define SCTLR_UCI     (1U << 26) /* v8 onward, AArch64 only */
1394 #define SCTLR_NMFI    (1U << 27) /* up to v7, RAZ in v7VE and v8 */
1395 #define SCTLR_EnDA    (1U << 27) /* v8.3, AArch64 only */
1396 #define SCTLR_TRE     (1U << 28) /* AArch32 only */
1397 #define SCTLR_nTLSMD_64 (1U << 28) /* v8.2-LSMAOC, AArch64 only */
1398 #define SCTLR_AFE     (1U << 29) /* AArch32 only */
1399 #define SCTLR_LSMAOE_64 (1U << 29) /* v8.2-LSMAOC, AArch64 only */
1400 #define SCTLR_TE      (1U << 30) /* AArch32 only */
1401 #define SCTLR_EnIB    (1U << 30) /* v8.3, AArch64 only */
1402 #define SCTLR_EnIA    (1U << 31) /* v8.3, AArch64 only */
1403 #define SCTLR_DSSBS_32 (1U << 31) /* v8.5, AArch32 only */
1404 #define SCTLR_CMOW    (1ULL << 32) /* FEAT_CMOW */
1405 #define SCTLR_MSCEN   (1ULL << 33) /* FEAT_MOPS */
1406 #define SCTLR_BT0     (1ULL << 35) /* v8.5-BTI */
1407 #define SCTLR_BT1     (1ULL << 36) /* v8.5-BTI */
1408 #define SCTLR_ITFSB   (1ULL << 37) /* v8.5-MemTag */
1409 #define SCTLR_TCF0    (3ULL << 38) /* v8.5-MemTag */
1410 #define SCTLR_TCF     (3ULL << 40) /* v8.5-MemTag */
1411 #define SCTLR_ATA0    (1ULL << 42) /* v8.5-MemTag */
1412 #define SCTLR_ATA     (1ULL << 43) /* v8.5-MemTag */
1413 #define SCTLR_DSSBS_64 (1ULL << 44) /* v8.5, AArch64 only */
1414 #define SCTLR_TWEDEn  (1ULL << 45)  /* FEAT_TWED */
1415 #define SCTLR_TWEDEL  MAKE_64_MASK(46, 4)  /* FEAT_TWED */
1416 #define SCTLR_TMT0    (1ULL << 50) /* FEAT_TME */
1417 #define SCTLR_TMT     (1ULL << 51) /* FEAT_TME */
1418 #define SCTLR_TME0    (1ULL << 52) /* FEAT_TME */
1419 #define SCTLR_TME     (1ULL << 53) /* FEAT_TME */
1420 #define SCTLR_EnASR   (1ULL << 54) /* FEAT_LS64_V */
1421 #define SCTLR_EnAS0   (1ULL << 55) /* FEAT_LS64_ACCDATA */
1422 #define SCTLR_EnALS   (1ULL << 56) /* FEAT_LS64 */
1423 #define SCTLR_EPAN    (1ULL << 57) /* FEAT_PAN3 */
1424 #define SCTLR_EnTP2   (1ULL << 60) /* FEAT_SME */
1425 #define SCTLR_NMI     (1ULL << 61) /* FEAT_NMI */
1426 #define SCTLR_SPINTMASK (1ULL << 62) /* FEAT_NMI */
1427 #define SCTLR_TIDCP   (1ULL << 63) /* FEAT_TIDCP1 */
1428 
1429 #define CPSR_M (0x1fU)
1430 #define CPSR_T (1U << 5)
1431 #define CPSR_F (1U << 6)
1432 #define CPSR_I (1U << 7)
1433 #define CPSR_A (1U << 8)
1434 #define CPSR_E (1U << 9)
1435 #define CPSR_IT_2_7 (0xfc00U)
1436 #define CPSR_GE (0xfU << 16)
1437 #define CPSR_IL (1U << 20)
1438 #define CPSR_DIT (1U << 21)
1439 #define CPSR_PAN (1U << 22)
1440 #define CPSR_SSBS (1U << 23)
1441 #define CPSR_J (1U << 24)
1442 #define CPSR_IT_0_1 (3U << 25)
1443 #define CPSR_Q (1U << 27)
1444 #define CPSR_V (1U << 28)
1445 #define CPSR_C (1U << 29)
1446 #define CPSR_Z (1U << 30)
1447 #define CPSR_N (1U << 31)
1448 #define CPSR_NZCV (CPSR_N | CPSR_Z | CPSR_C | CPSR_V)
1449 #define CPSR_AIF (CPSR_A | CPSR_I | CPSR_F)
1450 #define ISR_FS (1U << 9)
1451 #define ISR_IS (1U << 10)
1452 
1453 #define CPSR_IT (CPSR_IT_0_1 | CPSR_IT_2_7)
1454 #define CACHED_CPSR_BITS (CPSR_T | CPSR_AIF | CPSR_GE | CPSR_IT | CPSR_Q \
1455     | CPSR_NZCV)
1456 /* Bits writable in user mode.  */
1457 #define CPSR_USER (CPSR_NZCV | CPSR_Q | CPSR_GE | CPSR_E)
1458 /* Execution state bits.  MRS read as zero, MSR writes ignored.  */
1459 #define CPSR_EXEC (CPSR_T | CPSR_IT | CPSR_J | CPSR_IL)
1460 
1461 /* Bit definitions for M profile XPSR. Most are the same as CPSR. */
1462 #define XPSR_EXCP 0x1ffU
1463 #define XPSR_SPREALIGN (1U << 9) /* Only set in exception stack frames */
1464 #define XPSR_IT_2_7 CPSR_IT_2_7
1465 #define XPSR_GE CPSR_GE
1466 #define XPSR_SFPA (1U << 20) /* Only set in exception stack frames */
1467 #define XPSR_T (1U << 24) /* Not the same as CPSR_T ! */
1468 #define XPSR_IT_0_1 CPSR_IT_0_1
1469 #define XPSR_Q CPSR_Q
1470 #define XPSR_V CPSR_V
1471 #define XPSR_C CPSR_C
1472 #define XPSR_Z CPSR_Z
1473 #define XPSR_N CPSR_N
1474 #define XPSR_NZCV CPSR_NZCV
1475 #define XPSR_IT CPSR_IT
1476 
1477 /* Bit definitions for ARMv8 SPSR (PSTATE) format.
1478  * Only these are valid when in AArch64 mode; in
1479  * AArch32 mode SPSRs are basically CPSR-format.
1480  */
1481 #define PSTATE_SP (1U)
1482 #define PSTATE_M (0xFU)
1483 #define PSTATE_nRW (1U << 4)
1484 #define PSTATE_F (1U << 6)
1485 #define PSTATE_I (1U << 7)
1486 #define PSTATE_A (1U << 8)
1487 #define PSTATE_D (1U << 9)
1488 #define PSTATE_BTYPE (3U << 10)
1489 #define PSTATE_SSBS (1U << 12)
1490 #define PSTATE_ALLINT (1U << 13)
1491 #define PSTATE_IL (1U << 20)
1492 #define PSTATE_SS (1U << 21)
1493 #define PSTATE_PAN (1U << 22)
1494 #define PSTATE_UAO (1U << 23)
1495 #define PSTATE_DIT (1U << 24)
1496 #define PSTATE_TCO (1U << 25)
1497 #define PSTATE_V (1U << 28)
1498 #define PSTATE_C (1U << 29)
1499 #define PSTATE_Z (1U << 30)
1500 #define PSTATE_N (1U << 31)
1501 #define PSTATE_NZCV (PSTATE_N | PSTATE_Z | PSTATE_C | PSTATE_V)
1502 #define PSTATE_DAIF (PSTATE_D | PSTATE_A | PSTATE_I | PSTATE_F)
1503 #define CACHED_PSTATE_BITS (PSTATE_NZCV | PSTATE_DAIF | PSTATE_BTYPE)
1504 /* Mode values for AArch64 */
1505 #define PSTATE_MODE_EL3h 13
1506 #define PSTATE_MODE_EL3t 12
1507 #define PSTATE_MODE_EL2h 9
1508 #define PSTATE_MODE_EL2t 8
1509 #define PSTATE_MODE_EL1h 5
1510 #define PSTATE_MODE_EL1t 4
1511 #define PSTATE_MODE_EL0t 0
1512 
1513 /* PSTATE bits that are accessed via SVCR and not stored in SPSR_ELx. */
1514 FIELD(SVCR, SM, 0, 1)
1515 FIELD(SVCR, ZA, 1, 1)
1516 
1517 /* Fields for SMCR_ELx. */
1518 FIELD(SMCR, LEN, 0, 4)
1519 FIELD(SMCR, FA64, 31, 1)
1520 
1521 /* Write a new value to v7m.exception, thus transitioning into or out
1522  * of Handler mode; this may result in a change of active stack pointer.
1523  */
1524 void write_v7m_exception(CPUARMState *env, uint32_t new_exc);
1525 
1526 /* Map EL and handler into a PSTATE_MODE.  */
1527 static inline unsigned int aarch64_pstate_mode(unsigned int el, bool handler)
1528 {
1529     return (el << 2) | handler;
1530 }
1531 
1532 /* Return the current PSTATE value. For the moment we don't support 32<->64 bit
1533  * interprocessing, so we don't attempt to sync with the cpsr state used by
1534  * the 32 bit decoder.
1535  */
1536 static inline uint32_t pstate_read(CPUARMState *env)
1537 {
1538     int ZF;
1539 
1540     ZF = (env->ZF == 0);
1541     return (env->NF & 0x80000000) | (ZF << 30)
1542         | (env->CF << 29) | ((env->VF & 0x80000000) >> 3)
1543         | env->pstate | env->daif | (env->btype << 10);
1544 }
1545 
1546 static inline void pstate_write(CPUARMState *env, uint32_t val)
1547 {
1548     env->ZF = (~val) & PSTATE_Z;
1549     env->NF = val;
1550     env->CF = (val >> 29) & 1;
1551     env->VF = (val << 3) & 0x80000000;
1552     env->daif = val & PSTATE_DAIF;
1553     env->btype = (val >> 10) & 3;
1554     env->pstate = val & ~CACHED_PSTATE_BITS;
1555 }
1556 
1557 /* Return the current CPSR value.  */
1558 uint32_t cpsr_read(CPUARMState *env);
1559 
1560 typedef enum CPSRWriteType {
1561     CPSRWriteByInstr = 0,         /* from guest MSR or CPS */
1562     CPSRWriteExceptionReturn = 1, /* from guest exception return insn */
1563     CPSRWriteRaw = 2,
1564         /* trust values, no reg bank switch, no hflags rebuild */
1565     CPSRWriteByGDBStub = 3,       /* from the GDB stub */
1566 } CPSRWriteType;
1567 
1568 /*
1569  * Set the CPSR.  Note that some bits of mask must be all-set or all-clear.
1570  * This will do an arm_rebuild_hflags() if any of the bits in @mask
1571  * correspond to TB flags bits cached in the hflags, unless @write_type
1572  * is CPSRWriteRaw.
1573  */
1574 void cpsr_write(CPUARMState *env, uint32_t val, uint32_t mask,
1575                 CPSRWriteType write_type);
1576 
1577 /* Return the current xPSR value.  */
1578 static inline uint32_t xpsr_read(CPUARMState *env)
1579 {
1580     int ZF;
1581     ZF = (env->ZF == 0);
1582     return (env->NF & 0x80000000) | (ZF << 30)
1583         | (env->CF << 29) | ((env->VF & 0x80000000) >> 3) | (env->QF << 27)
1584         | (env->thumb << 24) | ((env->condexec_bits & 3) << 25)
1585         | ((env->condexec_bits & 0xfc) << 8)
1586         | (env->GE << 16)
1587         | env->v7m.exception;
1588 }
1589 
1590 /* Set the xPSR.  Note that some bits of mask must be all-set or all-clear.  */
1591 static inline void xpsr_write(CPUARMState *env, uint32_t val, uint32_t mask)
1592 {
1593     if (mask & XPSR_NZCV) {
1594         env->ZF = (~val) & XPSR_Z;
1595         env->NF = val;
1596         env->CF = (val >> 29) & 1;
1597         env->VF = (val << 3) & 0x80000000;
1598     }
1599     if (mask & XPSR_Q) {
1600         env->QF = ((val & XPSR_Q) != 0);
1601     }
1602     if (mask & XPSR_GE) {
1603         env->GE = (val & XPSR_GE) >> 16;
1604     }
1605 #ifndef CONFIG_USER_ONLY
1606     if (mask & XPSR_T) {
1607         env->thumb = ((val & XPSR_T) != 0);
1608     }
1609     if (mask & XPSR_IT_0_1) {
1610         env->condexec_bits &= ~3;
1611         env->condexec_bits |= (val >> 25) & 3;
1612     }
1613     if (mask & XPSR_IT_2_7) {
1614         env->condexec_bits &= 3;
1615         env->condexec_bits |= (val >> 8) & 0xfc;
1616     }
1617     if (mask & XPSR_EXCP) {
1618         /* Note that this only happens on exception exit */
1619         write_v7m_exception(env, val & XPSR_EXCP);
1620     }
1621 #endif
1622 }
1623 
1624 #define HCR_VM        (1ULL << 0)
1625 #define HCR_SWIO      (1ULL << 1)
1626 #define HCR_PTW       (1ULL << 2)
1627 #define HCR_FMO       (1ULL << 3)
1628 #define HCR_IMO       (1ULL << 4)
1629 #define HCR_AMO       (1ULL << 5)
1630 #define HCR_VF        (1ULL << 6)
1631 #define HCR_VI        (1ULL << 7)
1632 #define HCR_VSE       (1ULL << 8)
1633 #define HCR_FB        (1ULL << 9)
1634 #define HCR_BSU_MASK  (3ULL << 10)
1635 #define HCR_DC        (1ULL << 12)
1636 #define HCR_TWI       (1ULL << 13)
1637 #define HCR_TWE       (1ULL << 14)
1638 #define HCR_TID0      (1ULL << 15)
1639 #define HCR_TID1      (1ULL << 16)
1640 #define HCR_TID2      (1ULL << 17)
1641 #define HCR_TID3      (1ULL << 18)
1642 #define HCR_TSC       (1ULL << 19)
1643 #define HCR_TIDCP     (1ULL << 20)
1644 #define HCR_TACR      (1ULL << 21)
1645 #define HCR_TSW       (1ULL << 22)
1646 #define HCR_TPCP      (1ULL << 23)
1647 #define HCR_TPU       (1ULL << 24)
1648 #define HCR_TTLB      (1ULL << 25)
1649 #define HCR_TVM       (1ULL << 26)
1650 #define HCR_TGE       (1ULL << 27)
1651 #define HCR_TDZ       (1ULL << 28)
1652 #define HCR_HCD       (1ULL << 29)
1653 #define HCR_TRVM      (1ULL << 30)
1654 #define HCR_RW        (1ULL << 31)
1655 #define HCR_CD        (1ULL << 32)
1656 #define HCR_ID        (1ULL << 33)
1657 #define HCR_E2H       (1ULL << 34)
1658 #define HCR_TLOR      (1ULL << 35)
1659 #define HCR_TERR      (1ULL << 36)
1660 #define HCR_TEA       (1ULL << 37)
1661 #define HCR_MIOCNCE   (1ULL << 38)
1662 #define HCR_TME       (1ULL << 39)
1663 #define HCR_APK       (1ULL << 40)
1664 #define HCR_API       (1ULL << 41)
1665 #define HCR_NV        (1ULL << 42)
1666 #define HCR_NV1       (1ULL << 43)
1667 #define HCR_AT        (1ULL << 44)
1668 #define HCR_NV2       (1ULL << 45)
1669 #define HCR_FWB       (1ULL << 46)
1670 #define HCR_FIEN      (1ULL << 47)
1671 #define HCR_GPF       (1ULL << 48)
1672 #define HCR_TID4      (1ULL << 49)
1673 #define HCR_TICAB     (1ULL << 50)
1674 #define HCR_AMVOFFEN  (1ULL << 51)
1675 #define HCR_TOCU      (1ULL << 52)
1676 #define HCR_ENSCXT    (1ULL << 53)
1677 #define HCR_TTLBIS    (1ULL << 54)
1678 #define HCR_TTLBOS    (1ULL << 55)
1679 #define HCR_ATA       (1ULL << 56)
1680 #define HCR_DCT       (1ULL << 57)
1681 #define HCR_TID5      (1ULL << 58)
1682 #define HCR_TWEDEN    (1ULL << 59)
1683 #define HCR_TWEDEL    MAKE_64BIT_MASK(60, 4)
1684 
1685 #define SCR_NS                (1ULL << 0)
1686 #define SCR_IRQ               (1ULL << 1)
1687 #define SCR_FIQ               (1ULL << 2)
1688 #define SCR_EA                (1ULL << 3)
1689 #define SCR_FW                (1ULL << 4)
1690 #define SCR_AW                (1ULL << 5)
1691 #define SCR_NET               (1ULL << 6)
1692 #define SCR_SMD               (1ULL << 7)
1693 #define SCR_HCE               (1ULL << 8)
1694 #define SCR_SIF               (1ULL << 9)
1695 #define SCR_RW                (1ULL << 10)
1696 #define SCR_ST                (1ULL << 11)
1697 #define SCR_TWI               (1ULL << 12)
1698 #define SCR_TWE               (1ULL << 13)
1699 #define SCR_TLOR              (1ULL << 14)
1700 #define SCR_TERR              (1ULL << 15)
1701 #define SCR_APK               (1ULL << 16)
1702 #define SCR_API               (1ULL << 17)
1703 #define SCR_EEL2              (1ULL << 18)
1704 #define SCR_EASE              (1ULL << 19)
1705 #define SCR_NMEA              (1ULL << 20)
1706 #define SCR_FIEN              (1ULL << 21)
1707 #define SCR_ENSCXT            (1ULL << 25)
1708 #define SCR_ATA               (1ULL << 26)
1709 #define SCR_FGTEN             (1ULL << 27)
1710 #define SCR_ECVEN             (1ULL << 28)
1711 #define SCR_TWEDEN            (1ULL << 29)
1712 #define SCR_TWEDEL            MAKE_64BIT_MASK(30, 4)
1713 #define SCR_TME               (1ULL << 34)
1714 #define SCR_AMVOFFEN          (1ULL << 35)
1715 #define SCR_ENAS0             (1ULL << 36)
1716 #define SCR_ADEN              (1ULL << 37)
1717 #define SCR_HXEN              (1ULL << 38)
1718 #define SCR_TRNDR             (1ULL << 40)
1719 #define SCR_ENTP2             (1ULL << 41)
1720 #define SCR_GPF               (1ULL << 48)
1721 #define SCR_NSE               (1ULL << 62)
1722 
1723 /* Return the current FPSCR value.  */
1724 uint32_t vfp_get_fpscr(CPUARMState *env);
1725 void vfp_set_fpscr(CPUARMState *env, uint32_t val);
1726 
1727 /*
1728  * FPCR, Floating Point Control Register
1729  * FPSR, Floating Point Status Register
1730  *
1731  * For A64 floating point control and status bits are stored in
1732  * two logically distinct registers, FPCR and FPSR. We store these
1733  * in QEMU in vfp.fpcr and vfp.fpsr.
1734  * For A32 there was only one register, FPSCR. The bits are arranged
1735  * such that FPSCR bits map to FPCR or FPSR bits in the same bit positions,
1736  * so we can use appropriate masking to handle FPSCR reads and writes.
1737  * Note that the FPCR has some bits which are not visible in the
1738  * AArch32 view (for FEAT_AFP). Writing the FPSCR leaves these unchanged.
1739  */
1740 
1741 /* FPCR bits */
1742 #define FPCR_FIZ    (1 << 0)    /* Flush Inputs to Zero (FEAT_AFP) */
1743 #define FPCR_AH     (1 << 1)    /* Alternate Handling (FEAT_AFP) */
1744 #define FPCR_NEP    (1 << 2)    /* SIMD scalar ops preserve elts (FEAT_AFP) */
1745 #define FPCR_IOE    (1 << 8)    /* Invalid Operation exception trap enable */
1746 #define FPCR_DZE    (1 << 9)    /* Divide by Zero exception trap enable */
1747 #define FPCR_OFE    (1 << 10)   /* Overflow exception trap enable */
1748 #define FPCR_UFE    (1 << 11)   /* Underflow exception trap enable */
1749 #define FPCR_IXE    (1 << 12)   /* Inexact exception trap enable */
1750 #define FPCR_EBF    (1 << 13)   /* Extended BFloat16 behaviors */
1751 #define FPCR_IDE    (1 << 15)   /* Input Denormal exception trap enable */
1752 #define FPCR_LEN_MASK (7 << 16) /* LEN, A-profile only */
1753 #define FPCR_FZ16   (1 << 19)   /* ARMv8.2+, FP16 flush-to-zero */
1754 #define FPCR_STRIDE_MASK (3 << 20) /* Stride */
1755 #define FPCR_RMODE_MASK (3 << 22) /* Rounding mode */
1756 #define FPCR_FZ     (1 << 24)   /* Flush-to-zero enable bit */
1757 #define FPCR_DN     (1 << 25)   /* Default NaN enable bit */
1758 #define FPCR_AHP    (1 << 26)   /* Alternative half-precision */
1759 
1760 #define FPCR_LTPSIZE_SHIFT 16   /* LTPSIZE, M-profile only */
1761 #define FPCR_LTPSIZE_MASK (7 << FPCR_LTPSIZE_SHIFT)
1762 #define FPCR_LTPSIZE_LENGTH 3
1763 
1764 /* Cumulative exception trap enable bits */
1765 #define FPCR_EEXC_MASK (FPCR_IOE | FPCR_DZE | FPCR_OFE | FPCR_UFE | FPCR_IXE | FPCR_IDE)
1766 
1767 /* FPSR bits */
1768 #define FPSR_IOC    (1 << 0)    /* Invalid Operation cumulative exception */
1769 #define FPSR_DZC    (1 << 1)    /* Divide by Zero cumulative exception */
1770 #define FPSR_OFC    (1 << 2)    /* Overflow cumulative exception */
1771 #define FPSR_UFC    (1 << 3)    /* Underflow cumulative exception */
1772 #define FPSR_IXC    (1 << 4)    /* Inexact cumulative exception */
1773 #define FPSR_IDC    (1 << 7)    /* Input Denormal cumulative exception */
1774 #define FPSR_QC     (1 << 27)   /* Cumulative saturation bit */
1775 #define FPSR_V      (1 << 28)   /* FP overflow flag */
1776 #define FPSR_C      (1 << 29)   /* FP carry flag */
1777 #define FPSR_Z      (1 << 30)   /* FP zero flag */
1778 #define FPSR_N      (1 << 31)   /* FP negative flag */
1779 
1780 /* Cumulative exception status bits */
1781 #define FPSR_CEXC_MASK (FPSR_IOC | FPSR_DZC | FPSR_OFC | FPSR_UFC | FPSR_IXC | FPSR_IDC)
1782 
1783 #define FPSR_NZCV_MASK (FPSR_N | FPSR_Z | FPSR_C | FPSR_V)
1784 #define FPSR_NZCVQC_MASK (FPSR_NZCV_MASK | FPSR_QC)
1785 
1786 /* A32 FPSCR bits which architecturally map to FPSR bits */
1787 #define FPSCR_FPSR_MASK (FPSR_NZCVQC_MASK | FPSR_CEXC_MASK)
1788 /* A32 FPSCR bits which architecturally map to FPCR bits */
1789 #define FPSCR_FPCR_MASK (FPCR_EEXC_MASK | FPCR_LEN_MASK | FPCR_FZ16 | \
1790                          FPCR_STRIDE_MASK | FPCR_RMODE_MASK | \
1791                          FPCR_FZ | FPCR_DN | FPCR_AHP)
1792 /* These masks don't overlap: each bit lives in only one place */
1793 QEMU_BUILD_BUG_ON(FPSCR_FPSR_MASK & FPSCR_FPCR_MASK);
1794 
1795 /**
1796  * vfp_get_fpsr: read the AArch64 FPSR
1797  * @env: CPU context
1798  *
1799  * Return the current AArch64 FPSR value
1800  */
1801 uint32_t vfp_get_fpsr(CPUARMState *env);
1802 
1803 /**
1804  * vfp_get_fpcr: read the AArch64 FPCR
1805  * @env: CPU context
1806  *
1807  * Return the current AArch64 FPCR value
1808  */
1809 uint32_t vfp_get_fpcr(CPUARMState *env);
1810 
1811 /**
1812  * vfp_set_fpsr: write the AArch64 FPSR
1813  * @env: CPU context
1814  * @value: new value
1815  */
1816 void vfp_set_fpsr(CPUARMState *env, uint32_t value);
1817 
1818 /**
1819  * vfp_set_fpcr: write the AArch64 FPCR
1820  * @env: CPU context
1821  * @value: new value
1822  */
1823 void vfp_set_fpcr(CPUARMState *env, uint32_t value);
1824 
1825 enum arm_cpu_mode {
1826   ARM_CPU_MODE_USR = 0x10,
1827   ARM_CPU_MODE_FIQ = 0x11,
1828   ARM_CPU_MODE_IRQ = 0x12,
1829   ARM_CPU_MODE_SVC = 0x13,
1830   ARM_CPU_MODE_MON = 0x16,
1831   ARM_CPU_MODE_ABT = 0x17,
1832   ARM_CPU_MODE_HYP = 0x1a,
1833   ARM_CPU_MODE_UND = 0x1b,
1834   ARM_CPU_MODE_SYS = 0x1f
1835 };
1836 
1837 /* VFP system registers.  */
1838 #define ARM_VFP_FPSID   0
1839 #define ARM_VFP_FPSCR   1
1840 #define ARM_VFP_MVFR2   5
1841 #define ARM_VFP_MVFR1   6
1842 #define ARM_VFP_MVFR0   7
1843 #define ARM_VFP_FPEXC   8
1844 #define ARM_VFP_FPINST  9
1845 #define ARM_VFP_FPINST2 10
1846 /* These ones are M-profile only */
1847 #define ARM_VFP_FPSCR_NZCVQC 2
1848 #define ARM_VFP_VPR 12
1849 #define ARM_VFP_P0 13
1850 #define ARM_VFP_FPCXT_NS 14
1851 #define ARM_VFP_FPCXT_S 15
1852 
1853 /* QEMU-internal value meaning "FPSCR, but we care only about NZCV" */
1854 #define QEMU_VFP_FPSCR_NZCV 0xffff
1855 
1856 /* iwMMXt coprocessor control registers.  */
1857 #define ARM_IWMMXT_wCID  0
1858 #define ARM_IWMMXT_wCon  1
1859 #define ARM_IWMMXT_wCSSF 2
1860 #define ARM_IWMMXT_wCASF 3
1861 #define ARM_IWMMXT_wCGR0 8
1862 #define ARM_IWMMXT_wCGR1 9
1863 #define ARM_IWMMXT_wCGR2 10
1864 #define ARM_IWMMXT_wCGR3 11
1865 
1866 /* V7M CCR bits */
1867 FIELD(V7M_CCR, NONBASETHRDENA, 0, 1)
1868 FIELD(V7M_CCR, USERSETMPEND, 1, 1)
1869 FIELD(V7M_CCR, UNALIGN_TRP, 3, 1)
1870 FIELD(V7M_CCR, DIV_0_TRP, 4, 1)
1871 FIELD(V7M_CCR, BFHFNMIGN, 8, 1)
1872 FIELD(V7M_CCR, STKALIGN, 9, 1)
1873 FIELD(V7M_CCR, STKOFHFNMIGN, 10, 1)
1874 FIELD(V7M_CCR, DC, 16, 1)
1875 FIELD(V7M_CCR, IC, 17, 1)
1876 FIELD(V7M_CCR, BP, 18, 1)
1877 FIELD(V7M_CCR, LOB, 19, 1)
1878 FIELD(V7M_CCR, TRD, 20, 1)
1879 
1880 /* V7M SCR bits */
1881 FIELD(V7M_SCR, SLEEPONEXIT, 1, 1)
1882 FIELD(V7M_SCR, SLEEPDEEP, 2, 1)
1883 FIELD(V7M_SCR, SLEEPDEEPS, 3, 1)
1884 FIELD(V7M_SCR, SEVONPEND, 4, 1)
1885 
1886 /* V7M AIRCR bits */
1887 FIELD(V7M_AIRCR, VECTRESET, 0, 1)
1888 FIELD(V7M_AIRCR, VECTCLRACTIVE, 1, 1)
1889 FIELD(V7M_AIRCR, SYSRESETREQ, 2, 1)
1890 FIELD(V7M_AIRCR, SYSRESETREQS, 3, 1)
1891 FIELD(V7M_AIRCR, PRIGROUP, 8, 3)
1892 FIELD(V7M_AIRCR, BFHFNMINS, 13, 1)
1893 FIELD(V7M_AIRCR, PRIS, 14, 1)
1894 FIELD(V7M_AIRCR, ENDIANNESS, 15, 1)
1895 FIELD(V7M_AIRCR, VECTKEY, 16, 16)
1896 
1897 /* V7M CFSR bits for MMFSR */
1898 FIELD(V7M_CFSR, IACCVIOL, 0, 1)
1899 FIELD(V7M_CFSR, DACCVIOL, 1, 1)
1900 FIELD(V7M_CFSR, MUNSTKERR, 3, 1)
1901 FIELD(V7M_CFSR, MSTKERR, 4, 1)
1902 FIELD(V7M_CFSR, MLSPERR, 5, 1)
1903 FIELD(V7M_CFSR, MMARVALID, 7, 1)
1904 
1905 /* V7M CFSR bits for BFSR */
1906 FIELD(V7M_CFSR, IBUSERR, 8 + 0, 1)
1907 FIELD(V7M_CFSR, PRECISERR, 8 + 1, 1)
1908 FIELD(V7M_CFSR, IMPRECISERR, 8 + 2, 1)
1909 FIELD(V7M_CFSR, UNSTKERR, 8 + 3, 1)
1910 FIELD(V7M_CFSR, STKERR, 8 + 4, 1)
1911 FIELD(V7M_CFSR, LSPERR, 8 + 5, 1)
1912 FIELD(V7M_CFSR, BFARVALID, 8 + 7, 1)
1913 
1914 /* V7M CFSR bits for UFSR */
1915 FIELD(V7M_CFSR, UNDEFINSTR, 16 + 0, 1)
1916 FIELD(V7M_CFSR, INVSTATE, 16 + 1, 1)
1917 FIELD(V7M_CFSR, INVPC, 16 + 2, 1)
1918 FIELD(V7M_CFSR, NOCP, 16 + 3, 1)
1919 FIELD(V7M_CFSR, STKOF, 16 + 4, 1)
1920 FIELD(V7M_CFSR, UNALIGNED, 16 + 8, 1)
1921 FIELD(V7M_CFSR, DIVBYZERO, 16 + 9, 1)
1922 
1923 /* V7M CFSR bit masks covering all of the subregister bits */
1924 FIELD(V7M_CFSR, MMFSR, 0, 8)
1925 FIELD(V7M_CFSR, BFSR, 8, 8)
1926 FIELD(V7M_CFSR, UFSR, 16, 16)
1927 
1928 /* V7M HFSR bits */
1929 FIELD(V7M_HFSR, VECTTBL, 1, 1)
1930 FIELD(V7M_HFSR, FORCED, 30, 1)
1931 FIELD(V7M_HFSR, DEBUGEVT, 31, 1)
1932 
1933 /* V7M DFSR bits */
1934 FIELD(V7M_DFSR, HALTED, 0, 1)
1935 FIELD(V7M_DFSR, BKPT, 1, 1)
1936 FIELD(V7M_DFSR, DWTTRAP, 2, 1)
1937 FIELD(V7M_DFSR, VCATCH, 3, 1)
1938 FIELD(V7M_DFSR, EXTERNAL, 4, 1)
1939 
1940 /* V7M SFSR bits */
1941 FIELD(V7M_SFSR, INVEP, 0, 1)
1942 FIELD(V7M_SFSR, INVIS, 1, 1)
1943 FIELD(V7M_SFSR, INVER, 2, 1)
1944 FIELD(V7M_SFSR, AUVIOL, 3, 1)
1945 FIELD(V7M_SFSR, INVTRAN, 4, 1)
1946 FIELD(V7M_SFSR, LSPERR, 5, 1)
1947 FIELD(V7M_SFSR, SFARVALID, 6, 1)
1948 FIELD(V7M_SFSR, LSERR, 7, 1)
1949 
1950 /* v7M MPU_CTRL bits */
1951 FIELD(V7M_MPU_CTRL, ENABLE, 0, 1)
1952 FIELD(V7M_MPU_CTRL, HFNMIENA, 1, 1)
1953 FIELD(V7M_MPU_CTRL, PRIVDEFENA, 2, 1)
1954 
1955 /* v7M CLIDR bits */
1956 FIELD(V7M_CLIDR, CTYPE_ALL, 0, 21)
1957 FIELD(V7M_CLIDR, LOUIS, 21, 3)
1958 FIELD(V7M_CLIDR, LOC, 24, 3)
1959 FIELD(V7M_CLIDR, LOUU, 27, 3)
1960 FIELD(V7M_CLIDR, ICB, 30, 2)
1961 
1962 FIELD(V7M_CSSELR, IND, 0, 1)
1963 FIELD(V7M_CSSELR, LEVEL, 1, 3)
1964 /* We use the combination of InD and Level to index into cpu->ccsidr[];
1965  * define a mask for this and check that it doesn't permit running off
1966  * the end of the array.
1967  */
1968 FIELD(V7M_CSSELR, INDEX, 0, 4)
1969 
1970 /* v7M FPCCR bits */
1971 FIELD(V7M_FPCCR, LSPACT, 0, 1)
1972 FIELD(V7M_FPCCR, USER, 1, 1)
1973 FIELD(V7M_FPCCR, S, 2, 1)
1974 FIELD(V7M_FPCCR, THREAD, 3, 1)
1975 FIELD(V7M_FPCCR, HFRDY, 4, 1)
1976 FIELD(V7M_FPCCR, MMRDY, 5, 1)
1977 FIELD(V7M_FPCCR, BFRDY, 6, 1)
1978 FIELD(V7M_FPCCR, SFRDY, 7, 1)
1979 FIELD(V7M_FPCCR, MONRDY, 8, 1)
1980 FIELD(V7M_FPCCR, SPLIMVIOL, 9, 1)
1981 FIELD(V7M_FPCCR, UFRDY, 10, 1)
1982 FIELD(V7M_FPCCR, RES0, 11, 15)
1983 FIELD(V7M_FPCCR, TS, 26, 1)
1984 FIELD(V7M_FPCCR, CLRONRETS, 27, 1)
1985 FIELD(V7M_FPCCR, CLRONRET, 28, 1)
1986 FIELD(V7M_FPCCR, LSPENS, 29, 1)
1987 FIELD(V7M_FPCCR, LSPEN, 30, 1)
1988 FIELD(V7M_FPCCR, ASPEN, 31, 1)
1989 /* These bits are banked. Others are non-banked and live in the M_REG_S bank */
1990 #define R_V7M_FPCCR_BANKED_MASK                 \
1991     (R_V7M_FPCCR_LSPACT_MASK |                  \
1992      R_V7M_FPCCR_USER_MASK |                    \
1993      R_V7M_FPCCR_THREAD_MASK |                  \
1994      R_V7M_FPCCR_MMRDY_MASK |                   \
1995      R_V7M_FPCCR_SPLIMVIOL_MASK |               \
1996      R_V7M_FPCCR_UFRDY_MASK |                   \
1997      R_V7M_FPCCR_ASPEN_MASK)
1998 
1999 /* v7M VPR bits */
2000 FIELD(V7M_VPR, P0, 0, 16)
2001 FIELD(V7M_VPR, MASK01, 16, 4)
2002 FIELD(V7M_VPR, MASK23, 20, 4)
2003 
2004 /*
2005  * System register ID fields.
2006  */
2007 FIELD(CLIDR_EL1, CTYPE1, 0, 3)
2008 FIELD(CLIDR_EL1, CTYPE2, 3, 3)
2009 FIELD(CLIDR_EL1, CTYPE3, 6, 3)
2010 FIELD(CLIDR_EL1, CTYPE4, 9, 3)
2011 FIELD(CLIDR_EL1, CTYPE5, 12, 3)
2012 FIELD(CLIDR_EL1, CTYPE6, 15, 3)
2013 FIELD(CLIDR_EL1, CTYPE7, 18, 3)
2014 FIELD(CLIDR_EL1, LOUIS, 21, 3)
2015 FIELD(CLIDR_EL1, LOC, 24, 3)
2016 FIELD(CLIDR_EL1, LOUU, 27, 3)
2017 FIELD(CLIDR_EL1, ICB, 30, 3)
2018 
2019 /* When FEAT_CCIDX is implemented */
2020 FIELD(CCSIDR_EL1, CCIDX_LINESIZE, 0, 3)
2021 FIELD(CCSIDR_EL1, CCIDX_ASSOCIATIVITY, 3, 21)
2022 FIELD(CCSIDR_EL1, CCIDX_NUMSETS, 32, 24)
2023 
2024 /* When FEAT_CCIDX is not implemented */
2025 FIELD(CCSIDR_EL1, LINESIZE, 0, 3)
2026 FIELD(CCSIDR_EL1, ASSOCIATIVITY, 3, 10)
2027 FIELD(CCSIDR_EL1, NUMSETS, 13, 15)
2028 
2029 FIELD(CTR_EL0,  IMINLINE, 0, 4)
2030 FIELD(CTR_EL0,  L1IP, 14, 2)
2031 FIELD(CTR_EL0,  DMINLINE, 16, 4)
2032 FIELD(CTR_EL0,  ERG, 20, 4)
2033 FIELD(CTR_EL0,  CWG, 24, 4)
2034 FIELD(CTR_EL0,  IDC, 28, 1)
2035 FIELD(CTR_EL0,  DIC, 29, 1)
2036 FIELD(CTR_EL0,  TMINLINE, 32, 6)
2037 
2038 FIELD(MIDR_EL1, REVISION, 0, 4)
2039 FIELD(MIDR_EL1, PARTNUM, 4, 12)
2040 FIELD(MIDR_EL1, ARCHITECTURE, 16, 4)
2041 FIELD(MIDR_EL1, VARIANT, 20, 4)
2042 FIELD(MIDR_EL1, IMPLEMENTER, 24, 8)
2043 
2044 FIELD(ID_ISAR0, SWAP, 0, 4)
2045 FIELD(ID_ISAR0, BITCOUNT, 4, 4)
2046 FIELD(ID_ISAR0, BITFIELD, 8, 4)
2047 FIELD(ID_ISAR0, CMPBRANCH, 12, 4)
2048 FIELD(ID_ISAR0, COPROC, 16, 4)
2049 FIELD(ID_ISAR0, DEBUG, 20, 4)
2050 FIELD(ID_ISAR0, DIVIDE, 24, 4)
2051 
2052 FIELD(ID_ISAR1, ENDIAN, 0, 4)
2053 FIELD(ID_ISAR1, EXCEPT, 4, 4)
2054 FIELD(ID_ISAR1, EXCEPT_AR, 8, 4)
2055 FIELD(ID_ISAR1, EXTEND, 12, 4)
2056 FIELD(ID_ISAR1, IFTHEN, 16, 4)
2057 FIELD(ID_ISAR1, IMMEDIATE, 20, 4)
2058 FIELD(ID_ISAR1, INTERWORK, 24, 4)
2059 FIELD(ID_ISAR1, JAZELLE, 28, 4)
2060 
2061 FIELD(ID_ISAR2, LOADSTORE, 0, 4)
2062 FIELD(ID_ISAR2, MEMHINT, 4, 4)
2063 FIELD(ID_ISAR2, MULTIACCESSINT, 8, 4)
2064 FIELD(ID_ISAR2, MULT, 12, 4)
2065 FIELD(ID_ISAR2, MULTS, 16, 4)
2066 FIELD(ID_ISAR2, MULTU, 20, 4)
2067 FIELD(ID_ISAR2, PSR_AR, 24, 4)
2068 FIELD(ID_ISAR2, REVERSAL, 28, 4)
2069 
2070 FIELD(ID_ISAR3, SATURATE, 0, 4)
2071 FIELD(ID_ISAR3, SIMD, 4, 4)
2072 FIELD(ID_ISAR3, SVC, 8, 4)
2073 FIELD(ID_ISAR3, SYNCHPRIM, 12, 4)
2074 FIELD(ID_ISAR3, TABBRANCH, 16, 4)
2075 FIELD(ID_ISAR3, T32COPY, 20, 4)
2076 FIELD(ID_ISAR3, TRUENOP, 24, 4)
2077 FIELD(ID_ISAR3, T32EE, 28, 4)
2078 
2079 FIELD(ID_ISAR4, UNPRIV, 0, 4)
2080 FIELD(ID_ISAR4, WITHSHIFTS, 4, 4)
2081 FIELD(ID_ISAR4, WRITEBACK, 8, 4)
2082 FIELD(ID_ISAR4, SMC, 12, 4)
2083 FIELD(ID_ISAR4, BARRIER, 16, 4)
2084 FIELD(ID_ISAR4, SYNCHPRIM_FRAC, 20, 4)
2085 FIELD(ID_ISAR4, PSR_M, 24, 4)
2086 FIELD(ID_ISAR4, SWP_FRAC, 28, 4)
2087 
2088 FIELD(ID_ISAR5, SEVL, 0, 4)
2089 FIELD(ID_ISAR5, AES, 4, 4)
2090 FIELD(ID_ISAR5, SHA1, 8, 4)
2091 FIELD(ID_ISAR5, SHA2, 12, 4)
2092 FIELD(ID_ISAR5, CRC32, 16, 4)
2093 FIELD(ID_ISAR5, RDM, 24, 4)
2094 FIELD(ID_ISAR5, VCMA, 28, 4)
2095 
2096 FIELD(ID_ISAR6, JSCVT, 0, 4)
2097 FIELD(ID_ISAR6, DP, 4, 4)
2098 FIELD(ID_ISAR6, FHM, 8, 4)
2099 FIELD(ID_ISAR6, SB, 12, 4)
2100 FIELD(ID_ISAR6, SPECRES, 16, 4)
2101 FIELD(ID_ISAR6, BF16, 20, 4)
2102 FIELD(ID_ISAR6, I8MM, 24, 4)
2103 
2104 FIELD(ID_MMFR0, VMSA, 0, 4)
2105 FIELD(ID_MMFR0, PMSA, 4, 4)
2106 FIELD(ID_MMFR0, OUTERSHR, 8, 4)
2107 FIELD(ID_MMFR0, SHARELVL, 12, 4)
2108 FIELD(ID_MMFR0, TCM, 16, 4)
2109 FIELD(ID_MMFR0, AUXREG, 20, 4)
2110 FIELD(ID_MMFR0, FCSE, 24, 4)
2111 FIELD(ID_MMFR0, INNERSHR, 28, 4)
2112 
2113 FIELD(ID_MMFR1, L1HVDVA, 0, 4)
2114 FIELD(ID_MMFR1, L1UNIVA, 4, 4)
2115 FIELD(ID_MMFR1, L1HVDSW, 8, 4)
2116 FIELD(ID_MMFR1, L1UNISW, 12, 4)
2117 FIELD(ID_MMFR1, L1HVD, 16, 4)
2118 FIELD(ID_MMFR1, L1UNI, 20, 4)
2119 FIELD(ID_MMFR1, L1TSTCLN, 24, 4)
2120 FIELD(ID_MMFR1, BPRED, 28, 4)
2121 
2122 FIELD(ID_MMFR2, L1HVDFG, 0, 4)
2123 FIELD(ID_MMFR2, L1HVDBG, 4, 4)
2124 FIELD(ID_MMFR2, L1HVDRNG, 8, 4)
2125 FIELD(ID_MMFR2, HVDTLB, 12, 4)
2126 FIELD(ID_MMFR2, UNITLB, 16, 4)
2127 FIELD(ID_MMFR2, MEMBARR, 20, 4)
2128 FIELD(ID_MMFR2, WFISTALL, 24, 4)
2129 FIELD(ID_MMFR2, HWACCFLG, 28, 4)
2130 
2131 FIELD(ID_MMFR3, CMAINTVA, 0, 4)
2132 FIELD(ID_MMFR3, CMAINTSW, 4, 4)
2133 FIELD(ID_MMFR3, BPMAINT, 8, 4)
2134 FIELD(ID_MMFR3, MAINTBCST, 12, 4)
2135 FIELD(ID_MMFR3, PAN, 16, 4)
2136 FIELD(ID_MMFR3, COHWALK, 20, 4)
2137 FIELD(ID_MMFR3, CMEMSZ, 24, 4)
2138 FIELD(ID_MMFR3, SUPERSEC, 28, 4)
2139 
2140 FIELD(ID_MMFR4, SPECSEI, 0, 4)
2141 FIELD(ID_MMFR4, AC2, 4, 4)
2142 FIELD(ID_MMFR4, XNX, 8, 4)
2143 FIELD(ID_MMFR4, CNP, 12, 4)
2144 FIELD(ID_MMFR4, HPDS, 16, 4)
2145 FIELD(ID_MMFR4, LSM, 20, 4)
2146 FIELD(ID_MMFR4, CCIDX, 24, 4)
2147 FIELD(ID_MMFR4, EVT, 28, 4)
2148 
2149 FIELD(ID_MMFR5, ETS, 0, 4)
2150 FIELD(ID_MMFR5, NTLBPA, 4, 4)
2151 
2152 FIELD(ID_PFR0, STATE0, 0, 4)
2153 FIELD(ID_PFR0, STATE1, 4, 4)
2154 FIELD(ID_PFR0, STATE2, 8, 4)
2155 FIELD(ID_PFR0, STATE3, 12, 4)
2156 FIELD(ID_PFR0, CSV2, 16, 4)
2157 FIELD(ID_PFR0, AMU, 20, 4)
2158 FIELD(ID_PFR0, DIT, 24, 4)
2159 FIELD(ID_PFR0, RAS, 28, 4)
2160 
2161 FIELD(ID_PFR1, PROGMOD, 0, 4)
2162 FIELD(ID_PFR1, SECURITY, 4, 4)
2163 FIELD(ID_PFR1, MPROGMOD, 8, 4)
2164 FIELD(ID_PFR1, VIRTUALIZATION, 12, 4)
2165 FIELD(ID_PFR1, GENTIMER, 16, 4)
2166 FIELD(ID_PFR1, SEC_FRAC, 20, 4)
2167 FIELD(ID_PFR1, VIRT_FRAC, 24, 4)
2168 FIELD(ID_PFR1, GIC, 28, 4)
2169 
2170 FIELD(ID_PFR2, CSV3, 0, 4)
2171 FIELD(ID_PFR2, SSBS, 4, 4)
2172 FIELD(ID_PFR2, RAS_FRAC, 8, 4)
2173 
2174 FIELD(ID_AA64ISAR0, AES, 4, 4)
2175 FIELD(ID_AA64ISAR0, SHA1, 8, 4)
2176 FIELD(ID_AA64ISAR0, SHA2, 12, 4)
2177 FIELD(ID_AA64ISAR0, CRC32, 16, 4)
2178 FIELD(ID_AA64ISAR0, ATOMIC, 20, 4)
2179 FIELD(ID_AA64ISAR0, TME, 24, 4)
2180 FIELD(ID_AA64ISAR0, RDM, 28, 4)
2181 FIELD(ID_AA64ISAR0, SHA3, 32, 4)
2182 FIELD(ID_AA64ISAR0, SM3, 36, 4)
2183 FIELD(ID_AA64ISAR0, SM4, 40, 4)
2184 FIELD(ID_AA64ISAR0, DP, 44, 4)
2185 FIELD(ID_AA64ISAR0, FHM, 48, 4)
2186 FIELD(ID_AA64ISAR0, TS, 52, 4)
2187 FIELD(ID_AA64ISAR0, TLB, 56, 4)
2188 FIELD(ID_AA64ISAR0, RNDR, 60, 4)
2189 
2190 FIELD(ID_AA64ISAR1, DPB, 0, 4)
2191 FIELD(ID_AA64ISAR1, APA, 4, 4)
2192 FIELD(ID_AA64ISAR1, API, 8, 4)
2193 FIELD(ID_AA64ISAR1, JSCVT, 12, 4)
2194 FIELD(ID_AA64ISAR1, FCMA, 16, 4)
2195 FIELD(ID_AA64ISAR1, LRCPC, 20, 4)
2196 FIELD(ID_AA64ISAR1, GPA, 24, 4)
2197 FIELD(ID_AA64ISAR1, GPI, 28, 4)
2198 FIELD(ID_AA64ISAR1, FRINTTS, 32, 4)
2199 FIELD(ID_AA64ISAR1, SB, 36, 4)
2200 FIELD(ID_AA64ISAR1, SPECRES, 40, 4)
2201 FIELD(ID_AA64ISAR1, BF16, 44, 4)
2202 FIELD(ID_AA64ISAR1, DGH, 48, 4)
2203 FIELD(ID_AA64ISAR1, I8MM, 52, 4)
2204 FIELD(ID_AA64ISAR1, XS, 56, 4)
2205 FIELD(ID_AA64ISAR1, LS64, 60, 4)
2206 
2207 FIELD(ID_AA64ISAR2, WFXT, 0, 4)
2208 FIELD(ID_AA64ISAR2, RPRES, 4, 4)
2209 FIELD(ID_AA64ISAR2, GPA3, 8, 4)
2210 FIELD(ID_AA64ISAR2, APA3, 12, 4)
2211 FIELD(ID_AA64ISAR2, MOPS, 16, 4)
2212 FIELD(ID_AA64ISAR2, BC, 20, 4)
2213 FIELD(ID_AA64ISAR2, PAC_FRAC, 24, 4)
2214 FIELD(ID_AA64ISAR2, CLRBHB, 28, 4)
2215 FIELD(ID_AA64ISAR2, SYSREG_128, 32, 4)
2216 FIELD(ID_AA64ISAR2, SYSINSTR_128, 36, 4)
2217 FIELD(ID_AA64ISAR2, PRFMSLC, 40, 4)
2218 FIELD(ID_AA64ISAR2, RPRFM, 48, 4)
2219 FIELD(ID_AA64ISAR2, CSSC, 52, 4)
2220 FIELD(ID_AA64ISAR2, ATS1A, 60, 4)
2221 
2222 FIELD(ID_AA64PFR0, EL0, 0, 4)
2223 FIELD(ID_AA64PFR0, EL1, 4, 4)
2224 FIELD(ID_AA64PFR0, EL2, 8, 4)
2225 FIELD(ID_AA64PFR0, EL3, 12, 4)
2226 FIELD(ID_AA64PFR0, FP, 16, 4)
2227 FIELD(ID_AA64PFR0, ADVSIMD, 20, 4)
2228 FIELD(ID_AA64PFR0, GIC, 24, 4)
2229 FIELD(ID_AA64PFR0, RAS, 28, 4)
2230 FIELD(ID_AA64PFR0, SVE, 32, 4)
2231 FIELD(ID_AA64PFR0, SEL2, 36, 4)
2232 FIELD(ID_AA64PFR0, MPAM, 40, 4)
2233 FIELD(ID_AA64PFR0, AMU, 44, 4)
2234 FIELD(ID_AA64PFR0, DIT, 48, 4)
2235 FIELD(ID_AA64PFR0, RME, 52, 4)
2236 FIELD(ID_AA64PFR0, CSV2, 56, 4)
2237 FIELD(ID_AA64PFR0, CSV3, 60, 4)
2238 
2239 FIELD(ID_AA64PFR1, BT, 0, 4)
2240 FIELD(ID_AA64PFR1, SSBS, 4, 4)
2241 FIELD(ID_AA64PFR1, MTE, 8, 4)
2242 FIELD(ID_AA64PFR1, RAS_FRAC, 12, 4)
2243 FIELD(ID_AA64PFR1, MPAM_FRAC, 16, 4)
2244 FIELD(ID_AA64PFR1, SME, 24, 4)
2245 FIELD(ID_AA64PFR1, RNDR_TRAP, 28, 4)
2246 FIELD(ID_AA64PFR1, CSV2_FRAC, 32, 4)
2247 FIELD(ID_AA64PFR1, NMI, 36, 4)
2248 FIELD(ID_AA64PFR1, MTE_FRAC, 40, 4)
2249 FIELD(ID_AA64PFR1, GCS, 44, 4)
2250 FIELD(ID_AA64PFR1, THE, 48, 4)
2251 FIELD(ID_AA64PFR1, MTEX, 52, 4)
2252 FIELD(ID_AA64PFR1, DF2, 56, 4)
2253 FIELD(ID_AA64PFR1, PFAR, 60, 4)
2254 
2255 FIELD(ID_AA64MMFR0, PARANGE, 0, 4)
2256 FIELD(ID_AA64MMFR0, ASIDBITS, 4, 4)
2257 FIELD(ID_AA64MMFR0, BIGEND, 8, 4)
2258 FIELD(ID_AA64MMFR0, SNSMEM, 12, 4)
2259 FIELD(ID_AA64MMFR0, BIGENDEL0, 16, 4)
2260 FIELD(ID_AA64MMFR0, TGRAN16, 20, 4)
2261 FIELD(ID_AA64MMFR0, TGRAN64, 24, 4)
2262 FIELD(ID_AA64MMFR0, TGRAN4, 28, 4)
2263 FIELD(ID_AA64MMFR0, TGRAN16_2, 32, 4)
2264 FIELD(ID_AA64MMFR0, TGRAN64_2, 36, 4)
2265 FIELD(ID_AA64MMFR0, TGRAN4_2, 40, 4)
2266 FIELD(ID_AA64MMFR0, EXS, 44, 4)
2267 FIELD(ID_AA64MMFR0, FGT, 56, 4)
2268 FIELD(ID_AA64MMFR0, ECV, 60, 4)
2269 
2270 FIELD(ID_AA64MMFR1, HAFDBS, 0, 4)
2271 FIELD(ID_AA64MMFR1, VMIDBITS, 4, 4)
2272 FIELD(ID_AA64MMFR1, VH, 8, 4)
2273 FIELD(ID_AA64MMFR1, HPDS, 12, 4)
2274 FIELD(ID_AA64MMFR1, LO, 16, 4)
2275 FIELD(ID_AA64MMFR1, PAN, 20, 4)
2276 FIELD(ID_AA64MMFR1, SPECSEI, 24, 4)
2277 FIELD(ID_AA64MMFR1, XNX, 28, 4)
2278 FIELD(ID_AA64MMFR1, TWED, 32, 4)
2279 FIELD(ID_AA64MMFR1, ETS, 36, 4)
2280 FIELD(ID_AA64MMFR1, HCX, 40, 4)
2281 FIELD(ID_AA64MMFR1, AFP, 44, 4)
2282 FIELD(ID_AA64MMFR1, NTLBPA, 48, 4)
2283 FIELD(ID_AA64MMFR1, TIDCP1, 52, 4)
2284 FIELD(ID_AA64MMFR1, CMOW, 56, 4)
2285 FIELD(ID_AA64MMFR1, ECBHB, 60, 4)
2286 
2287 FIELD(ID_AA64MMFR2, CNP, 0, 4)
2288 FIELD(ID_AA64MMFR2, UAO, 4, 4)
2289 FIELD(ID_AA64MMFR2, LSM, 8, 4)
2290 FIELD(ID_AA64MMFR2, IESB, 12, 4)
2291 FIELD(ID_AA64MMFR2, VARANGE, 16, 4)
2292 FIELD(ID_AA64MMFR2, CCIDX, 20, 4)
2293 FIELD(ID_AA64MMFR2, NV, 24, 4)
2294 FIELD(ID_AA64MMFR2, ST, 28, 4)
2295 FIELD(ID_AA64MMFR2, AT, 32, 4)
2296 FIELD(ID_AA64MMFR2, IDS, 36, 4)
2297 FIELD(ID_AA64MMFR2, FWB, 40, 4)
2298 FIELD(ID_AA64MMFR2, TTL, 48, 4)
2299 FIELD(ID_AA64MMFR2, BBM, 52, 4)
2300 FIELD(ID_AA64MMFR2, EVT, 56, 4)
2301 FIELD(ID_AA64MMFR2, E0PD, 60, 4)
2302 
2303 FIELD(ID_AA64MMFR3, TCRX, 0, 4)
2304 FIELD(ID_AA64MMFR3, SCTLRX, 4, 4)
2305 FIELD(ID_AA64MMFR3, S1PIE, 8, 4)
2306 FIELD(ID_AA64MMFR3, S2PIE, 12, 4)
2307 FIELD(ID_AA64MMFR3, S1POE, 16, 4)
2308 FIELD(ID_AA64MMFR3, S2POE, 20, 4)
2309 FIELD(ID_AA64MMFR3, AIE, 24, 4)
2310 FIELD(ID_AA64MMFR3, MEC, 28, 4)
2311 FIELD(ID_AA64MMFR3, D128, 32, 4)
2312 FIELD(ID_AA64MMFR3, D128_2, 36, 4)
2313 FIELD(ID_AA64MMFR3, SNERR, 40, 4)
2314 FIELD(ID_AA64MMFR3, ANERR, 44, 4)
2315 FIELD(ID_AA64MMFR3, SDERR, 52, 4)
2316 FIELD(ID_AA64MMFR3, ADERR, 56, 4)
2317 FIELD(ID_AA64MMFR3, SPEC_FPACC, 60, 4)
2318 
2319 FIELD(ID_AA64DFR0, DEBUGVER, 0, 4)
2320 FIELD(ID_AA64DFR0, TRACEVER, 4, 4)
2321 FIELD(ID_AA64DFR0, PMUVER, 8, 4)
2322 FIELD(ID_AA64DFR0, BRPS, 12, 4)
2323 FIELD(ID_AA64DFR0, PMSS, 16, 4)
2324 FIELD(ID_AA64DFR0, WRPS, 20, 4)
2325 FIELD(ID_AA64DFR0, SEBEP, 24, 4)
2326 FIELD(ID_AA64DFR0, CTX_CMPS, 28, 4)
2327 FIELD(ID_AA64DFR0, PMSVER, 32, 4)
2328 FIELD(ID_AA64DFR0, DOUBLELOCK, 36, 4)
2329 FIELD(ID_AA64DFR0, TRACEFILT, 40, 4)
2330 FIELD(ID_AA64DFR0, TRACEBUFFER, 44, 4)
2331 FIELD(ID_AA64DFR0, MTPMU, 48, 4)
2332 FIELD(ID_AA64DFR0, BRBE, 52, 4)
2333 FIELD(ID_AA64DFR0, EXTTRCBUFF, 56, 4)
2334 FIELD(ID_AA64DFR0, HPMN0, 60, 4)
2335 
2336 FIELD(ID_AA64ZFR0, SVEVER, 0, 4)
2337 FIELD(ID_AA64ZFR0, AES, 4, 4)
2338 FIELD(ID_AA64ZFR0, BITPERM, 16, 4)
2339 FIELD(ID_AA64ZFR0, BFLOAT16, 20, 4)
2340 FIELD(ID_AA64ZFR0, B16B16, 24, 4)
2341 FIELD(ID_AA64ZFR0, SHA3, 32, 4)
2342 FIELD(ID_AA64ZFR0, SM4, 40, 4)
2343 FIELD(ID_AA64ZFR0, I8MM, 44, 4)
2344 FIELD(ID_AA64ZFR0, F32MM, 52, 4)
2345 FIELD(ID_AA64ZFR0, F64MM, 56, 4)
2346 
2347 FIELD(ID_AA64SMFR0, F32F32, 32, 1)
2348 FIELD(ID_AA64SMFR0, BI32I32, 33, 1)
2349 FIELD(ID_AA64SMFR0, B16F32, 34, 1)
2350 FIELD(ID_AA64SMFR0, F16F32, 35, 1)
2351 FIELD(ID_AA64SMFR0, I8I32, 36, 4)
2352 FIELD(ID_AA64SMFR0, F16F16, 42, 1)
2353 FIELD(ID_AA64SMFR0, B16B16, 43, 1)
2354 FIELD(ID_AA64SMFR0, I16I32, 44, 4)
2355 FIELD(ID_AA64SMFR0, F64F64, 48, 1)
2356 FIELD(ID_AA64SMFR0, I16I64, 52, 4)
2357 FIELD(ID_AA64SMFR0, SMEVER, 56, 4)
2358 FIELD(ID_AA64SMFR0, FA64, 63, 1)
2359 
2360 FIELD(ID_DFR0, COPDBG, 0, 4)
2361 FIELD(ID_DFR0, COPSDBG, 4, 4)
2362 FIELD(ID_DFR0, MMAPDBG, 8, 4)
2363 FIELD(ID_DFR0, COPTRC, 12, 4)
2364 FIELD(ID_DFR0, MMAPTRC, 16, 4)
2365 FIELD(ID_DFR0, MPROFDBG, 20, 4)
2366 FIELD(ID_DFR0, PERFMON, 24, 4)
2367 FIELD(ID_DFR0, TRACEFILT, 28, 4)
2368 
2369 FIELD(ID_DFR1, MTPMU, 0, 4)
2370 FIELD(ID_DFR1, HPMN0, 4, 4)
2371 
2372 FIELD(DBGDIDR, SE_IMP, 12, 1)
2373 FIELD(DBGDIDR, NSUHD_IMP, 14, 1)
2374 FIELD(DBGDIDR, VERSION, 16, 4)
2375 FIELD(DBGDIDR, CTX_CMPS, 20, 4)
2376 FIELD(DBGDIDR, BRPS, 24, 4)
2377 FIELD(DBGDIDR, WRPS, 28, 4)
2378 
2379 FIELD(DBGDEVID, PCSAMPLE, 0, 4)
2380 FIELD(DBGDEVID, WPADDRMASK, 4, 4)
2381 FIELD(DBGDEVID, BPADDRMASK, 8, 4)
2382 FIELD(DBGDEVID, VECTORCATCH, 12, 4)
2383 FIELD(DBGDEVID, VIRTEXTNS, 16, 4)
2384 FIELD(DBGDEVID, DOUBLELOCK, 20, 4)
2385 FIELD(DBGDEVID, AUXREGS, 24, 4)
2386 FIELD(DBGDEVID, CIDMASK, 28, 4)
2387 
2388 FIELD(DBGDEVID1, PCSROFFSET, 0, 4)
2389 
2390 FIELD(MVFR0, SIMDREG, 0, 4)
2391 FIELD(MVFR0, FPSP, 4, 4)
2392 FIELD(MVFR0, FPDP, 8, 4)
2393 FIELD(MVFR0, FPTRAP, 12, 4)
2394 FIELD(MVFR0, FPDIVIDE, 16, 4)
2395 FIELD(MVFR0, FPSQRT, 20, 4)
2396 FIELD(MVFR0, FPSHVEC, 24, 4)
2397 FIELD(MVFR0, FPROUND, 28, 4)
2398 
2399 FIELD(MVFR1, FPFTZ, 0, 4)
2400 FIELD(MVFR1, FPDNAN, 4, 4)
2401 FIELD(MVFR1, SIMDLS, 8, 4) /* A-profile only */
2402 FIELD(MVFR1, SIMDINT, 12, 4) /* A-profile only */
2403 FIELD(MVFR1, SIMDSP, 16, 4) /* A-profile only */
2404 FIELD(MVFR1, SIMDHP, 20, 4) /* A-profile only */
2405 FIELD(MVFR1, MVE, 8, 4) /* M-profile only */
2406 FIELD(MVFR1, FP16, 20, 4) /* M-profile only */
2407 FIELD(MVFR1, FPHP, 24, 4)
2408 FIELD(MVFR1, SIMDFMAC, 28, 4)
2409 
2410 FIELD(MVFR2, SIMDMISC, 0, 4)
2411 FIELD(MVFR2, FPMISC, 4, 4)
2412 
2413 FIELD(GPCCR, PPS, 0, 3)
2414 FIELD(GPCCR, IRGN, 8, 2)
2415 FIELD(GPCCR, ORGN, 10, 2)
2416 FIELD(GPCCR, SH, 12, 2)
2417 FIELD(GPCCR, PGS, 14, 2)
2418 FIELD(GPCCR, GPC, 16, 1)
2419 FIELD(GPCCR, GPCP, 17, 1)
2420 FIELD(GPCCR, L0GPTSZ, 20, 4)
2421 
2422 FIELD(MFAR, FPA, 12, 40)
2423 FIELD(MFAR, NSE, 62, 1)
2424 FIELD(MFAR, NS, 63, 1)
2425 
2426 QEMU_BUILD_BUG_ON(ARRAY_SIZE(((ARMCPU *)0)->ccsidr) <= R_V7M_CSSELR_INDEX_MASK);
2427 
2428 /* If adding a feature bit which corresponds to a Linux ELF
2429  * HWCAP bit, remember to update the feature-bit-to-hwcap
2430  * mapping in linux-user/elfload.c:get_elf_hwcap().
2431  */
2432 enum arm_features {
2433     ARM_FEATURE_AUXCR,  /* ARM1026 Auxiliary control register.  */
2434     ARM_FEATURE_XSCALE, /* Intel XScale extensions.  */
2435     ARM_FEATURE_IWMMXT, /* Intel iwMMXt extension.  */
2436     ARM_FEATURE_V6,
2437     ARM_FEATURE_V6K,
2438     ARM_FEATURE_V7,
2439     ARM_FEATURE_THUMB2,
2440     ARM_FEATURE_PMSA,   /* no MMU; may have Memory Protection Unit */
2441     ARM_FEATURE_NEON,
2442     ARM_FEATURE_M, /* Microcontroller profile.  */
2443     ARM_FEATURE_OMAPCP, /* OMAP specific CP15 ops handling.  */
2444     ARM_FEATURE_THUMB2EE,
2445     ARM_FEATURE_V7MP,    /* v7 Multiprocessing Extensions */
2446     ARM_FEATURE_V7VE, /* v7 Virtualization Extensions (non-EL2 parts) */
2447     ARM_FEATURE_V4T,
2448     ARM_FEATURE_V5,
2449     ARM_FEATURE_STRONGARM,
2450     ARM_FEATURE_VAPA, /* cp15 VA to PA lookups */
2451     ARM_FEATURE_GENERIC_TIMER,
2452     ARM_FEATURE_MVFR, /* Media and VFP Feature Registers 0 and 1 */
2453     ARM_FEATURE_DUMMY_C15_REGS, /* RAZ/WI all of cp15 crn=15 */
2454     ARM_FEATURE_CACHE_TEST_CLEAN, /* 926/1026 style test-and-clean ops */
2455     ARM_FEATURE_CACHE_DIRTY_REG, /* 1136/1176 cache dirty status register */
2456     ARM_FEATURE_CACHE_BLOCK_OPS, /* v6 optional cache block operations */
2457     ARM_FEATURE_MPIDR, /* has cp15 MPIDR */
2458     ARM_FEATURE_LPAE, /* has Large Physical Address Extension */
2459     ARM_FEATURE_V8,
2460     ARM_FEATURE_AARCH64, /* supports 64 bit mode */
2461     ARM_FEATURE_CBAR, /* has cp15 CBAR */
2462     ARM_FEATURE_CBAR_RO, /* has cp15 CBAR and it is read-only */
2463     ARM_FEATURE_EL2, /* has EL2 Virtualization support */
2464     ARM_FEATURE_EL3, /* has EL3 Secure monitor support */
2465     ARM_FEATURE_THUMB_DSP, /* DSP insns supported in the Thumb encodings */
2466     ARM_FEATURE_PMU, /* has PMU support */
2467     ARM_FEATURE_VBAR, /* has cp15 VBAR */
2468     ARM_FEATURE_M_SECURITY, /* M profile Security Extension */
2469     ARM_FEATURE_M_MAIN, /* M profile Main Extension */
2470     ARM_FEATURE_V8_1M, /* M profile extras only in v8.1M and later */
2471     /*
2472      * ARM_FEATURE_BACKCOMPAT_CNTFRQ makes the CPU default cntfrq be 62.5MHz
2473      * if the board doesn't set a value, instead of 1GHz. It is for backwards
2474      * compatibility and used only with CPU definitions that were already
2475      * in QEMU before we changed the default. It should not be set on any
2476      * CPU types added in future.
2477      */
2478     ARM_FEATURE_BACKCOMPAT_CNTFRQ, /* 62.5MHz timer default */
2479 };
2480 
2481 static inline int arm_feature(CPUARMState *env, int feature)
2482 {
2483     return (env->features & (1ULL << feature)) != 0;
2484 }
2485 
2486 void arm_cpu_finalize_features(ARMCPU *cpu, Error **errp);
2487 
2488 /*
2489  * ARM v9 security states.
2490  * The ordering of the enumeration corresponds to the low 2 bits
2491  * of the GPI value, and (except for Root) the concat of NSE:NS.
2492  */
2493 
2494 typedef enum ARMSecuritySpace {
2495     ARMSS_Secure     = 0,
2496     ARMSS_NonSecure  = 1,
2497     ARMSS_Root       = 2,
2498     ARMSS_Realm      = 3,
2499 } ARMSecuritySpace;
2500 
2501 /* Return true if @space is secure, in the pre-v9 sense. */
2502 static inline bool arm_space_is_secure(ARMSecuritySpace space)
2503 {
2504     return space == ARMSS_Secure || space == ARMSS_Root;
2505 }
2506 
2507 /* Return the ARMSecuritySpace for @secure, assuming !RME or EL[0-2]. */
2508 static inline ARMSecuritySpace arm_secure_to_space(bool secure)
2509 {
2510     return secure ? ARMSS_Secure : ARMSS_NonSecure;
2511 }
2512 
2513 #if !defined(CONFIG_USER_ONLY)
2514 /**
2515  * arm_security_space_below_el3:
2516  * @env: cpu context
2517  *
2518  * Return the security space of exception levels below EL3, following
2519  * an exception return to those levels.  Unlike arm_security_space,
2520  * this doesn't care about the current EL.
2521  */
2522 ARMSecuritySpace arm_security_space_below_el3(CPUARMState *env);
2523 
2524 /**
2525  * arm_is_secure_below_el3:
2526  * @env: cpu context
2527  *
2528  * Return true if exception levels below EL3 are in secure state,
2529  * or would be following an exception return to those levels.
2530  */
2531 static inline bool arm_is_secure_below_el3(CPUARMState *env)
2532 {
2533     ARMSecuritySpace ss = arm_security_space_below_el3(env);
2534     return ss == ARMSS_Secure;
2535 }
2536 
2537 /* Return true if the CPU is AArch64 EL3 or AArch32 Mon */
2538 static inline bool arm_is_el3_or_mon(CPUARMState *env)
2539 {
2540     assert(!arm_feature(env, ARM_FEATURE_M));
2541     if (arm_feature(env, ARM_FEATURE_EL3)) {
2542         if (is_a64(env) && extract32(env->pstate, 2, 2) == 3) {
2543             /* CPU currently in AArch64 state and EL3 */
2544             return true;
2545         } else if (!is_a64(env) &&
2546                 (env->uncached_cpsr & CPSR_M) == ARM_CPU_MODE_MON) {
2547             /* CPU currently in AArch32 state and monitor mode */
2548             return true;
2549         }
2550     }
2551     return false;
2552 }
2553 
2554 /**
2555  * arm_security_space:
2556  * @env: cpu context
2557  *
2558  * Return the current security space of the cpu.
2559  */
2560 ARMSecuritySpace arm_security_space(CPUARMState *env);
2561 
2562 /**
2563  * arm_is_secure:
2564  * @env: cpu context
2565  *
2566  * Return true if the processor is in secure state.
2567  */
2568 static inline bool arm_is_secure(CPUARMState *env)
2569 {
2570     return arm_space_is_secure(arm_security_space(env));
2571 }
2572 
2573 /*
2574  * Return true if the current security state has AArch64 EL2 or AArch32 Hyp.
2575  * This corresponds to the pseudocode EL2Enabled().
2576  */
2577 static inline bool arm_is_el2_enabled_secstate(CPUARMState *env,
2578                                                ARMSecuritySpace space)
2579 {
2580     assert(space != ARMSS_Root);
2581     return arm_feature(env, ARM_FEATURE_EL2)
2582            && (space != ARMSS_Secure || (env->cp15.scr_el3 & SCR_EEL2));
2583 }
2584 
2585 static inline bool arm_is_el2_enabled(CPUARMState *env)
2586 {
2587     return arm_is_el2_enabled_secstate(env, arm_security_space_below_el3(env));
2588 }
2589 
2590 #else
2591 static inline ARMSecuritySpace arm_security_space_below_el3(CPUARMState *env)
2592 {
2593     return ARMSS_NonSecure;
2594 }
2595 
2596 static inline bool arm_is_secure_below_el3(CPUARMState *env)
2597 {
2598     return false;
2599 }
2600 
2601 static inline bool arm_is_el3_or_mon(CPUARMState *env)
2602 {
2603     return false;
2604 }
2605 
2606 static inline ARMSecuritySpace arm_security_space(CPUARMState *env)
2607 {
2608     return ARMSS_NonSecure;
2609 }
2610 
2611 static inline bool arm_is_secure(CPUARMState *env)
2612 {
2613     return false;
2614 }
2615 
2616 static inline bool arm_is_el2_enabled_secstate(CPUARMState *env,
2617                                                ARMSecuritySpace space)
2618 {
2619     return false;
2620 }
2621 
2622 static inline bool arm_is_el2_enabled(CPUARMState *env)
2623 {
2624     return false;
2625 }
2626 #endif
2627 
2628 /**
2629  * arm_hcr_el2_eff(): Return the effective value of HCR_EL2.
2630  * E.g. when in secure state, fields in HCR_EL2 are suppressed,
2631  * "for all purposes other than a direct read or write access of HCR_EL2."
2632  * Not included here is HCR_RW.
2633  */
2634 uint64_t arm_hcr_el2_eff_secstate(CPUARMState *env, ARMSecuritySpace space);
2635 uint64_t arm_hcr_el2_eff(CPUARMState *env);
2636 uint64_t arm_hcrx_el2_eff(CPUARMState *env);
2637 
2638 /*
2639  * Function for determining whether guest cp register reads and writes should
2640  * access the secure or non-secure bank of a cp register.  When EL3 is
2641  * operating in AArch32 state, the NS-bit determines whether the secure
2642  * instance of a cp register should be used. When EL3 is AArch64 (or if
2643  * it doesn't exist at all) then there is no register banking, and all
2644  * accesses are to the non-secure version.
2645  */
2646 bool access_secure_reg(CPUARMState *env);
2647 
2648 uint32_t arm_phys_excp_target_el(CPUState *cs, uint32_t excp_idx,
2649                                  uint32_t cur_el, bool secure);
2650 
2651 /* Return the highest implemented Exception Level */
2652 static inline int arm_highest_el(CPUARMState *env)
2653 {
2654     if (arm_feature(env, ARM_FEATURE_EL3)) {
2655         return 3;
2656     }
2657     if (arm_feature(env, ARM_FEATURE_EL2)) {
2658         return 2;
2659     }
2660     return 1;
2661 }
2662 
2663 /* Return true if a v7M CPU is in Handler mode */
2664 static inline bool arm_v7m_is_handler_mode(CPUARMState *env)
2665 {
2666     return env->v7m.exception != 0;
2667 }
2668 
2669 /**
2670  * write_list_to_cpustate
2671  * @cpu: ARMCPU
2672  *
2673  * For each register listed in the ARMCPU cpreg_indexes list, write
2674  * its value from the cpreg_values list into the ARMCPUState structure.
2675  * This updates TCG's working data structures from KVM data or
2676  * from incoming migration state.
2677  *
2678  * Returns: true if all register values were updated correctly,
2679  * false if some register was unknown or could not be written.
2680  * Note that we do not stop early on failure -- we will attempt
2681  * writing all registers in the list.
2682  */
2683 bool write_list_to_cpustate(ARMCPU *cpu);
2684 
2685 /**
2686  * write_cpustate_to_list:
2687  * @cpu: ARMCPU
2688  * @kvm_sync: true if this is for syncing back to KVM
2689  *
2690  * For each register listed in the ARMCPU cpreg_indexes list, write
2691  * its value from the ARMCPUState structure into the cpreg_values list.
2692  * This is used to copy info from TCG's working data structures into
2693  * KVM or for outbound migration.
2694  *
2695  * @kvm_sync is true if we are doing this in order to sync the
2696  * register state back to KVM. In this case we will only update
2697  * values in the list if the previous list->cpustate sync actually
2698  * successfully wrote the CPU state. Otherwise we will keep the value
2699  * that is in the list.
2700  *
2701  * Returns: true if all register values were read correctly,
2702  * false if some register was unknown or could not be read.
2703  * Note that we do not stop early on failure -- we will attempt
2704  * reading all registers in the list.
2705  */
2706 bool write_cpustate_to_list(ARMCPU *cpu, bool kvm_sync);
2707 
2708 #define ARM_CPUID_TI915T      0x54029152
2709 #define ARM_CPUID_TI925T      0x54029252
2710 
2711 #define CPU_RESOLVING_TYPE TYPE_ARM_CPU
2712 
2713 #define TYPE_ARM_HOST_CPU "host-" TYPE_ARM_CPU
2714 
2715 /* ARM has the following "translation regimes" (as the ARM ARM calls them):
2716  *
2717  * If EL3 is 64-bit:
2718  *  + NonSecure EL1 & 0 stage 1
2719  *  + NonSecure EL1 & 0 stage 2
2720  *  + NonSecure EL2
2721  *  + NonSecure EL2 & 0   (ARMv8.1-VHE)
2722  *  + Secure EL1 & 0 stage 1
2723  *  + Secure EL1 & 0 stage 2 (FEAT_SEL2)
2724  *  + Secure EL2 (FEAT_SEL2)
2725  *  + Secure EL2 & 0 (FEAT_SEL2)
2726  *  + Realm EL1 & 0 stage 1 (FEAT_RME)
2727  *  + Realm EL1 & 0 stage 2 (FEAT_RME)
2728  *  + Realm EL2 (FEAT_RME)
2729  *  + EL3
2730  * If EL3 is 32-bit:
2731  *  + NonSecure PL1 & 0 stage 1
2732  *  + NonSecure PL1 & 0 stage 2
2733  *  + NonSecure PL2
2734  *  + Secure PL1 & 0
2735  * (reminder: for 32 bit EL3, Secure PL1 is *EL3*, not EL1.)
2736  *
2737  * For QEMU, an mmu_idx is not quite the same as a translation regime because:
2738  *  1. we need to split the "EL1 & 0" and "EL2 & 0" regimes into two mmu_idxes,
2739  *     because they may differ in access permissions even if the VA->PA map is
2740  *     the same
2741  *  2. we want to cache in our TLB the full VA->IPA->PA lookup for a stage 1+2
2742  *     translation, which means that we have one mmu_idx that deals with two
2743  *     concatenated translation regimes [this sort of combined s1+2 TLB is
2744  *     architecturally permitted]
2745  *  3. we don't need to allocate an mmu_idx to translations that we won't be
2746  *     handling via the TLB. The only way to do a stage 1 translation without
2747  *     the immediate stage 2 translation is via the ATS or AT system insns,
2748  *     which can be slow-pathed and always do a page table walk.
2749  *     The only use of stage 2 translations is either as part of an s1+2
2750  *     lookup or when loading the descriptors during a stage 1 page table walk,
2751  *     and in both those cases we don't use the TLB.
2752  *  4. we can also safely fold together the "32 bit EL3" and "64 bit EL3"
2753  *     translation regimes, because they map reasonably well to each other
2754  *     and they can't both be active at the same time.
2755  *  5. we want to be able to use the TLB for accesses done as part of a
2756  *     stage1 page table walk, rather than having to walk the stage2 page
2757  *     table over and over.
2758  *  6. we need separate EL1/EL2 mmu_idx for handling the Privileged Access
2759  *     Never (PAN) bit within PSTATE.
2760  *  7. we fold together most secure and non-secure regimes for A-profile,
2761  *     because there are no banked system registers for aarch64, so the
2762  *     process of switching between secure and non-secure is
2763  *     already heavyweight.
2764  *  8. we cannot fold together Stage 2 Secure and Stage 2 NonSecure,
2765  *     because both are in use simultaneously for Secure EL2.
2766  *
2767  * This gives us the following list of cases:
2768  *
2769  * EL0 EL1&0 stage 1+2 (aka NS PL0 PL1&0 stage 1+2)
2770  * EL1 EL1&0 stage 1+2 (aka NS PL1 PL1&0 stage 1+2)
2771  * EL1 EL1&0 stage 1+2 +PAN (aka NS PL1 P1&0 stage 1+2 +PAN)
2772  * EL0 EL2&0
2773  * EL2 EL2&0
2774  * EL2 EL2&0 +PAN
2775  * EL2 (aka NS PL2)
2776  * EL3 (aka AArch32 S PL1 PL1&0)
2777  * AArch32 S PL0 PL1&0 (we call this EL30_0)
2778  * AArch32 S PL1 PL1&0 +PAN (we call this EL30_3_PAN)
2779  * Stage2 Secure
2780  * Stage2 NonSecure
2781  * plus one TLB per Physical address space: S, NS, Realm, Root
2782  *
2783  * for a total of 16 different mmu_idx.
2784  *
2785  * R profile CPUs have an MPU, but can use the same set of MMU indexes
2786  * as A profile. They only need to distinguish EL0 and EL1 (and
2787  * EL2 for cores like the Cortex-R52).
2788  *
2789  * M profile CPUs are rather different as they do not have a true MMU.
2790  * They have the following different MMU indexes:
2791  *  User
2792  *  Privileged
2793  *  User, execution priority negative (ie the MPU HFNMIENA bit may apply)
2794  *  Privileged, execution priority negative (ditto)
2795  * If the CPU supports the v8M Security Extension then there are also:
2796  *  Secure User
2797  *  Secure Privileged
2798  *  Secure User, execution priority negative
2799  *  Secure Privileged, execution priority negative
2800  *
2801  * The ARMMMUIdx and the mmu index value used by the core QEMU TLB code
2802  * are not quite the same -- different CPU types (most notably M profile
2803  * vs A/R profile) would like to use MMU indexes with different semantics,
2804  * but since we don't ever need to use all of those in a single CPU we
2805  * can avoid having to set NB_MMU_MODES to "total number of A profile MMU
2806  * modes + total number of M profile MMU modes". The lower bits of
2807  * ARMMMUIdx are the core TLB mmu index, and the higher bits are always
2808  * the same for any particular CPU.
2809  * Variables of type ARMMUIdx are always full values, and the core
2810  * index values are in variables of type 'int'.
2811  *
2812  * Our enumeration includes at the end some entries which are not "true"
2813  * mmu_idx values in that they don't have corresponding TLBs and are only
2814  * valid for doing slow path page table walks.
2815  *
2816  * The constant names here are patterned after the general style of the names
2817  * of the AT/ATS operations.
2818  * The values used are carefully arranged to make mmu_idx => EL lookup easy.
2819  * For M profile we arrange them to have a bit for priv, a bit for negpri
2820  * and a bit for secure.
2821  */
2822 #define ARM_MMU_IDX_A     0x10  /* A profile */
2823 #define ARM_MMU_IDX_NOTLB 0x20  /* does not have a TLB */
2824 #define ARM_MMU_IDX_M     0x40  /* M profile */
2825 
2826 /* Meanings of the bits for M profile mmu idx values */
2827 #define ARM_MMU_IDX_M_PRIV   0x1
2828 #define ARM_MMU_IDX_M_NEGPRI 0x2
2829 #define ARM_MMU_IDX_M_S      0x4  /* Secure */
2830 
2831 #define ARM_MMU_IDX_TYPE_MASK \
2832     (ARM_MMU_IDX_A | ARM_MMU_IDX_M | ARM_MMU_IDX_NOTLB)
2833 #define ARM_MMU_IDX_COREIDX_MASK 0xf
2834 
2835 typedef enum ARMMMUIdx {
2836     /*
2837      * A-profile.
2838      */
2839     ARMMMUIdx_E10_0     = 0 | ARM_MMU_IDX_A,
2840     ARMMMUIdx_E20_0     = 1 | ARM_MMU_IDX_A,
2841     ARMMMUIdx_E10_1     = 2 | ARM_MMU_IDX_A,
2842     ARMMMUIdx_E20_2     = 3 | ARM_MMU_IDX_A,
2843     ARMMMUIdx_E10_1_PAN = 4 | ARM_MMU_IDX_A,
2844     ARMMMUIdx_E20_2_PAN = 5 | ARM_MMU_IDX_A,
2845     ARMMMUIdx_E2        = 6 | ARM_MMU_IDX_A,
2846     ARMMMUIdx_E3        = 7 | ARM_MMU_IDX_A,
2847     ARMMMUIdx_E30_0     = 8 | ARM_MMU_IDX_A,
2848     ARMMMUIdx_E30_3_PAN = 9 | ARM_MMU_IDX_A,
2849 
2850     /*
2851      * Used for second stage of an S12 page table walk, or for descriptor
2852      * loads during first stage of an S1 page table walk.  Note that both
2853      * are in use simultaneously for SecureEL2: the security state for
2854      * the S2 ptw is selected by the NS bit from the S1 ptw.
2855      */
2856     ARMMMUIdx_Stage2_S  = 10 | ARM_MMU_IDX_A,
2857     ARMMMUIdx_Stage2    = 11 | ARM_MMU_IDX_A,
2858 
2859     /* TLBs with 1-1 mapping to the physical address spaces. */
2860     ARMMMUIdx_Phys_S     = 12 | ARM_MMU_IDX_A,
2861     ARMMMUIdx_Phys_NS    = 13 | ARM_MMU_IDX_A,
2862     ARMMMUIdx_Phys_Root  = 14 | ARM_MMU_IDX_A,
2863     ARMMMUIdx_Phys_Realm = 15 | ARM_MMU_IDX_A,
2864 
2865     /*
2866      * These are not allocated TLBs and are used only for AT system
2867      * instructions or for the first stage of an S12 page table walk.
2868      */
2869     ARMMMUIdx_Stage1_E0 = 0 | ARM_MMU_IDX_NOTLB,
2870     ARMMMUIdx_Stage1_E1 = 1 | ARM_MMU_IDX_NOTLB,
2871     ARMMMUIdx_Stage1_E1_PAN = 2 | ARM_MMU_IDX_NOTLB,
2872 
2873     /*
2874      * M-profile.
2875      */
2876     ARMMMUIdx_MUser = ARM_MMU_IDX_M,
2877     ARMMMUIdx_MPriv = ARM_MMU_IDX_M | ARM_MMU_IDX_M_PRIV,
2878     ARMMMUIdx_MUserNegPri = ARMMMUIdx_MUser | ARM_MMU_IDX_M_NEGPRI,
2879     ARMMMUIdx_MPrivNegPri = ARMMMUIdx_MPriv | ARM_MMU_IDX_M_NEGPRI,
2880     ARMMMUIdx_MSUser = ARMMMUIdx_MUser | ARM_MMU_IDX_M_S,
2881     ARMMMUIdx_MSPriv = ARMMMUIdx_MPriv | ARM_MMU_IDX_M_S,
2882     ARMMMUIdx_MSUserNegPri = ARMMMUIdx_MUserNegPri | ARM_MMU_IDX_M_S,
2883     ARMMMUIdx_MSPrivNegPri = ARMMMUIdx_MPrivNegPri | ARM_MMU_IDX_M_S,
2884 } ARMMMUIdx;
2885 
2886 /*
2887  * Bit macros for the core-mmu-index values for each index,
2888  * for use when calling tlb_flush_by_mmuidx() and friends.
2889  */
2890 #define TO_CORE_BIT(NAME) \
2891     ARMMMUIdxBit_##NAME = 1 << (ARMMMUIdx_##NAME & ARM_MMU_IDX_COREIDX_MASK)
2892 
2893 typedef enum ARMMMUIdxBit {
2894     TO_CORE_BIT(E10_0),
2895     TO_CORE_BIT(E20_0),
2896     TO_CORE_BIT(E10_1),
2897     TO_CORE_BIT(E10_1_PAN),
2898     TO_CORE_BIT(E2),
2899     TO_CORE_BIT(E20_2),
2900     TO_CORE_BIT(E20_2_PAN),
2901     TO_CORE_BIT(E3),
2902     TO_CORE_BIT(E30_0),
2903     TO_CORE_BIT(E30_3_PAN),
2904     TO_CORE_BIT(Stage2),
2905     TO_CORE_BIT(Stage2_S),
2906 
2907     TO_CORE_BIT(MUser),
2908     TO_CORE_BIT(MPriv),
2909     TO_CORE_BIT(MUserNegPri),
2910     TO_CORE_BIT(MPrivNegPri),
2911     TO_CORE_BIT(MSUser),
2912     TO_CORE_BIT(MSPriv),
2913     TO_CORE_BIT(MSUserNegPri),
2914     TO_CORE_BIT(MSPrivNegPri),
2915 } ARMMMUIdxBit;
2916 
2917 #undef TO_CORE_BIT
2918 
2919 #define MMU_USER_IDX 0
2920 
2921 /* Indexes used when registering address spaces with cpu_address_space_init */
2922 typedef enum ARMASIdx {
2923     ARMASIdx_NS = 0,
2924     ARMASIdx_S = 1,
2925     ARMASIdx_TagNS = 2,
2926     ARMASIdx_TagS = 3,
2927 } ARMASIdx;
2928 
2929 static inline ARMMMUIdx arm_space_to_phys(ARMSecuritySpace space)
2930 {
2931     /* Assert the relative order of the physical mmu indexes. */
2932     QEMU_BUILD_BUG_ON(ARMSS_Secure != 0);
2933     QEMU_BUILD_BUG_ON(ARMMMUIdx_Phys_NS != ARMMMUIdx_Phys_S + ARMSS_NonSecure);
2934     QEMU_BUILD_BUG_ON(ARMMMUIdx_Phys_Root != ARMMMUIdx_Phys_S + ARMSS_Root);
2935     QEMU_BUILD_BUG_ON(ARMMMUIdx_Phys_Realm != ARMMMUIdx_Phys_S + ARMSS_Realm);
2936 
2937     return ARMMMUIdx_Phys_S + space;
2938 }
2939 
2940 static inline ARMSecuritySpace arm_phys_to_space(ARMMMUIdx idx)
2941 {
2942     assert(idx >= ARMMMUIdx_Phys_S && idx <= ARMMMUIdx_Phys_Realm);
2943     return idx - ARMMMUIdx_Phys_S;
2944 }
2945 
2946 static inline bool arm_v7m_csselr_razwi(ARMCPU *cpu)
2947 {
2948     /* If all the CLIDR.Ctypem bits are 0 there are no caches, and
2949      * CSSELR is RAZ/WI.
2950      */
2951     return (cpu->clidr & R_V7M_CLIDR_CTYPE_ALL_MASK) != 0;
2952 }
2953 
2954 static inline bool arm_sctlr_b(CPUARMState *env)
2955 {
2956     return
2957         /* We need not implement SCTLR.ITD in user-mode emulation, so
2958          * let linux-user ignore the fact that it conflicts with SCTLR_B.
2959          * This lets people run BE32 binaries with "-cpu any".
2960          */
2961 #ifndef CONFIG_USER_ONLY
2962         !arm_feature(env, ARM_FEATURE_V7) &&
2963 #endif
2964         (env->cp15.sctlr_el[1] & SCTLR_B) != 0;
2965 }
2966 
2967 uint64_t arm_sctlr(CPUARMState *env, int el);
2968 
2969 #include "exec/cpu-all.h"
2970 
2971 /*
2972  * We have more than 32-bits worth of state per TB, so we split the data
2973  * between tb->flags and tb->cs_base, which is otherwise unused for ARM.
2974  * We collect these two parts in CPUARMTBFlags where they are named
2975  * flags and flags2 respectively.
2976  *
2977  * The flags that are shared between all execution modes, TBFLAG_ANY,
2978  * are stored in flags.  The flags that are specific to a given mode
2979  * are stores in flags2.  Since cs_base is sized on the configured
2980  * address size, flags2 always has 64-bits for A64, and a minimum of
2981  * 32-bits for A32 and M32.
2982  *
2983  * The bits for 32-bit A-profile and M-profile partially overlap:
2984  *
2985  *  31         23         11 10             0
2986  * +-------------+----------+----------------+
2987  * |             |          |   TBFLAG_A32   |
2988  * | TBFLAG_AM32 |          +-----+----------+
2989  * |             |                |TBFLAG_M32|
2990  * +-------------+----------------+----------+
2991  *  31         23                6 5        0
2992  *
2993  * Unless otherwise noted, these bits are cached in env->hflags.
2994  */
2995 FIELD(TBFLAG_ANY, AARCH64_STATE, 0, 1)
2996 FIELD(TBFLAG_ANY, SS_ACTIVE, 1, 1)
2997 FIELD(TBFLAG_ANY, PSTATE__SS, 2, 1)      /* Not cached. */
2998 FIELD(TBFLAG_ANY, BE_DATA, 3, 1)
2999 FIELD(TBFLAG_ANY, MMUIDX, 4, 4)
3000 /* Target EL if we take a floating-point-disabled exception */
3001 FIELD(TBFLAG_ANY, FPEXC_EL, 8, 2)
3002 /* Memory operations require alignment: SCTLR_ELx.A or CCR.UNALIGN_TRP */
3003 FIELD(TBFLAG_ANY, ALIGN_MEM, 10, 1)
3004 FIELD(TBFLAG_ANY, PSTATE__IL, 11, 1)
3005 FIELD(TBFLAG_ANY, FGT_ACTIVE, 12, 1)
3006 FIELD(TBFLAG_ANY, FGT_SVC, 13, 1)
3007 
3008 /*
3009  * Bit usage when in AArch32 state, both A- and M-profile.
3010  */
3011 FIELD(TBFLAG_AM32, CONDEXEC, 24, 8)      /* Not cached. */
3012 FIELD(TBFLAG_AM32, THUMB, 23, 1)         /* Not cached. */
3013 
3014 /*
3015  * Bit usage when in AArch32 state, for A-profile only.
3016  */
3017 FIELD(TBFLAG_A32, VECLEN, 0, 3)         /* Not cached. */
3018 FIELD(TBFLAG_A32, VECSTRIDE, 3, 2)     /* Not cached. */
3019 /*
3020  * We store the bottom two bits of the CPAR as TB flags and handle
3021  * checks on the other bits at runtime. This shares the same bits as
3022  * VECSTRIDE, which is OK as no XScale CPU has VFP.
3023  * Not cached, because VECLEN+VECSTRIDE are not cached.
3024  */
3025 FIELD(TBFLAG_A32, XSCALE_CPAR, 5, 2)
3026 FIELD(TBFLAG_A32, VFPEN, 7, 1)         /* Partially cached, minus FPEXC. */
3027 FIELD(TBFLAG_A32, SCTLR__B, 8, 1)      /* Cannot overlap with SCTLR_B */
3028 FIELD(TBFLAG_A32, HSTR_ACTIVE, 9, 1)
3029 /*
3030  * Indicates whether cp register reads and writes by guest code should access
3031  * the secure or nonsecure bank of banked registers; note that this is not
3032  * the same thing as the current security state of the processor!
3033  */
3034 FIELD(TBFLAG_A32, NS, 10, 1)
3035 /*
3036  * Indicates that SME Streaming mode is active, and SMCR_ELx.FA64 is not.
3037  * This requires an SME trap from AArch32 mode when using NEON.
3038  */
3039 FIELD(TBFLAG_A32, SME_TRAP_NONSTREAMING, 11, 1)
3040 
3041 /*
3042  * Bit usage when in AArch32 state, for M-profile only.
3043  */
3044 /* Handler (ie not Thread) mode */
3045 FIELD(TBFLAG_M32, HANDLER, 0, 1)
3046 /* Whether we should generate stack-limit checks */
3047 FIELD(TBFLAG_M32, STACKCHECK, 1, 1)
3048 /* Set if FPCCR.LSPACT is set */
3049 FIELD(TBFLAG_M32, LSPACT, 2, 1)                 /* Not cached. */
3050 /* Set if we must create a new FP context */
3051 FIELD(TBFLAG_M32, NEW_FP_CTXT_NEEDED, 3, 1)     /* Not cached. */
3052 /* Set if FPCCR.S does not match current security state */
3053 FIELD(TBFLAG_M32, FPCCR_S_WRONG, 4, 1)          /* Not cached. */
3054 /* Set if MVE insns are definitely not predicated by VPR or LTPSIZE */
3055 FIELD(TBFLAG_M32, MVE_NO_PRED, 5, 1)            /* Not cached. */
3056 /* Set if in secure mode */
3057 FIELD(TBFLAG_M32, SECURE, 6, 1)
3058 
3059 /*
3060  * Bit usage when in AArch64 state
3061  */
3062 FIELD(TBFLAG_A64, TBII, 0, 2)
3063 FIELD(TBFLAG_A64, SVEEXC_EL, 2, 2)
3064 /* The current vector length, either NVL or SVL. */
3065 FIELD(TBFLAG_A64, VL, 4, 4)
3066 FIELD(TBFLAG_A64, PAUTH_ACTIVE, 8, 1)
3067 FIELD(TBFLAG_A64, BT, 9, 1)
3068 FIELD(TBFLAG_A64, BTYPE, 10, 2)         /* Not cached. */
3069 FIELD(TBFLAG_A64, TBID, 12, 2)
3070 FIELD(TBFLAG_A64, UNPRIV, 14, 1)
3071 FIELD(TBFLAG_A64, ATA, 15, 1)
3072 FIELD(TBFLAG_A64, TCMA, 16, 2)
3073 FIELD(TBFLAG_A64, MTE_ACTIVE, 18, 1)
3074 FIELD(TBFLAG_A64, MTE0_ACTIVE, 19, 1)
3075 FIELD(TBFLAG_A64, SMEEXC_EL, 20, 2)
3076 FIELD(TBFLAG_A64, PSTATE_SM, 22, 1)
3077 FIELD(TBFLAG_A64, PSTATE_ZA, 23, 1)
3078 FIELD(TBFLAG_A64, SVL, 24, 4)
3079 /* Indicates that SME Streaming mode is active, and SMCR_ELx.FA64 is not. */
3080 FIELD(TBFLAG_A64, SME_TRAP_NONSTREAMING, 28, 1)
3081 FIELD(TBFLAG_A64, TRAP_ERET, 29, 1)
3082 FIELD(TBFLAG_A64, NAA, 30, 1)
3083 FIELD(TBFLAG_A64, ATA0, 31, 1)
3084 FIELD(TBFLAG_A64, NV, 32, 1)
3085 FIELD(TBFLAG_A64, NV1, 33, 1)
3086 FIELD(TBFLAG_A64, NV2, 34, 1)
3087 /* Set if FEAT_NV2 RAM accesses use the EL2&0 translation regime */
3088 FIELD(TBFLAG_A64, NV2_MEM_E20, 35, 1)
3089 /* Set if FEAT_NV2 RAM accesses are big-endian */
3090 FIELD(TBFLAG_A64, NV2_MEM_BE, 36, 1)
3091 FIELD(TBFLAG_A64, AH, 37, 1)   /* FPCR.AH */
3092 FIELD(TBFLAG_A64, NEP, 38, 1)   /* FPCR.NEP */
3093 
3094 /*
3095  * Helpers for using the above. Note that only the A64 accessors use
3096  * FIELD_DP64() and FIELD_EX64(), because in the other cases the flags
3097  * word either is or might be 32 bits only.
3098  */
3099 #define DP_TBFLAG_ANY(DST, WHICH, VAL) \
3100     (DST.flags = FIELD_DP32(DST.flags, TBFLAG_ANY, WHICH, VAL))
3101 #define DP_TBFLAG_A64(DST, WHICH, VAL) \
3102     (DST.flags2 = FIELD_DP64(DST.flags2, TBFLAG_A64, WHICH, VAL))
3103 #define DP_TBFLAG_A32(DST, WHICH, VAL) \
3104     (DST.flags2 = FIELD_DP32(DST.flags2, TBFLAG_A32, WHICH, VAL))
3105 #define DP_TBFLAG_M32(DST, WHICH, VAL) \
3106     (DST.flags2 = FIELD_DP32(DST.flags2, TBFLAG_M32, WHICH, VAL))
3107 #define DP_TBFLAG_AM32(DST, WHICH, VAL) \
3108     (DST.flags2 = FIELD_DP32(DST.flags2, TBFLAG_AM32, WHICH, VAL))
3109 
3110 #define EX_TBFLAG_ANY(IN, WHICH)   FIELD_EX32(IN.flags, TBFLAG_ANY, WHICH)
3111 #define EX_TBFLAG_A64(IN, WHICH)   FIELD_EX64(IN.flags2, TBFLAG_A64, WHICH)
3112 #define EX_TBFLAG_A32(IN, WHICH)   FIELD_EX32(IN.flags2, TBFLAG_A32, WHICH)
3113 #define EX_TBFLAG_M32(IN, WHICH)   FIELD_EX32(IN.flags2, TBFLAG_M32, WHICH)
3114 #define EX_TBFLAG_AM32(IN, WHICH)  FIELD_EX32(IN.flags2, TBFLAG_AM32, WHICH)
3115 
3116 /**
3117  * sve_vq
3118  * @env: the cpu context
3119  *
3120  * Return the VL cached within env->hflags, in units of quadwords.
3121  */
3122 static inline int sve_vq(CPUARMState *env)
3123 {
3124     return EX_TBFLAG_A64(env->hflags, VL) + 1;
3125 }
3126 
3127 /**
3128  * sme_vq
3129  * @env: the cpu context
3130  *
3131  * Return the SVL cached within env->hflags, in units of quadwords.
3132  */
3133 static inline int sme_vq(CPUARMState *env)
3134 {
3135     return EX_TBFLAG_A64(env->hflags, SVL) + 1;
3136 }
3137 
3138 static inline bool bswap_code(bool sctlr_b)
3139 {
3140 #ifdef CONFIG_USER_ONLY
3141     /* BE8 (SCTLR.B = 0, TARGET_BIG_ENDIAN = 1) is mixed endian.
3142      * The invalid combination SCTLR.B=1/CPSR.E=1/TARGET_BIG_ENDIAN=0
3143      * would also end up as a mixed-endian mode with BE code, LE data.
3144      */
3145     return TARGET_BIG_ENDIAN ^ sctlr_b;
3146 #else
3147     /* All code access in ARM is little endian, and there are no loaders
3148      * doing swaps that need to be reversed
3149      */
3150     return 0;
3151 #endif
3152 }
3153 
3154 void cpu_get_tb_cpu_state(CPUARMState *env, vaddr *pc,
3155                           uint64_t *cs_base, uint32_t *flags);
3156 
3157 enum {
3158     QEMU_PSCI_CONDUIT_DISABLED = 0,
3159     QEMU_PSCI_CONDUIT_SMC = 1,
3160     QEMU_PSCI_CONDUIT_HVC = 2,
3161 };
3162 
3163 #ifndef CONFIG_USER_ONLY
3164 /* Return the address space index to use for a memory access */
3165 static inline int arm_asidx_from_attrs(CPUState *cs, MemTxAttrs attrs)
3166 {
3167     return attrs.secure ? ARMASIdx_S : ARMASIdx_NS;
3168 }
3169 
3170 /* Return the AddressSpace to use for a memory access
3171  * (which depends on whether the access is S or NS, and whether
3172  * the board gave us a separate AddressSpace for S accesses).
3173  */
3174 static inline AddressSpace *arm_addressspace(CPUState *cs, MemTxAttrs attrs)
3175 {
3176     return cpu_get_address_space(cs, arm_asidx_from_attrs(cs, attrs));
3177 }
3178 #endif
3179 
3180 /**
3181  * arm_register_pre_el_change_hook:
3182  * Register a hook function which will be called immediately before this
3183  * CPU changes exception level or mode. The hook function will be
3184  * passed a pointer to the ARMCPU and the opaque data pointer passed
3185  * to this function when the hook was registered.
3186  *
3187  * Note that if a pre-change hook is called, any registered post-change hooks
3188  * are guaranteed to subsequently be called.
3189  */
3190 void arm_register_pre_el_change_hook(ARMCPU *cpu, ARMELChangeHookFn *hook,
3191                                  void *opaque);
3192 /**
3193  * arm_register_el_change_hook:
3194  * Register a hook function which will be called immediately after this
3195  * CPU changes exception level or mode. The hook function will be
3196  * passed a pointer to the ARMCPU and the opaque data pointer passed
3197  * to this function when the hook was registered.
3198  *
3199  * Note that any registered hooks registered here are guaranteed to be called
3200  * if pre-change hooks have been.
3201  */
3202 void arm_register_el_change_hook(ARMCPU *cpu, ARMELChangeHookFn *hook, void
3203         *opaque);
3204 
3205 /**
3206  * arm_rebuild_hflags:
3207  * Rebuild the cached TBFLAGS for arbitrary changed processor state.
3208  */
3209 void arm_rebuild_hflags(CPUARMState *env);
3210 
3211 /**
3212  * aa32_vfp_dreg:
3213  * Return a pointer to the Dn register within env in 32-bit mode.
3214  */
3215 static inline uint64_t *aa32_vfp_dreg(CPUARMState *env, unsigned regno)
3216 {
3217     return &env->vfp.zregs[regno >> 1].d[regno & 1];
3218 }
3219 
3220 /**
3221  * aa32_vfp_qreg:
3222  * Return a pointer to the Qn register within env in 32-bit mode.
3223  */
3224 static inline uint64_t *aa32_vfp_qreg(CPUARMState *env, unsigned regno)
3225 {
3226     return &env->vfp.zregs[regno].d[0];
3227 }
3228 
3229 /**
3230  * aa64_vfp_qreg:
3231  * Return a pointer to the Qn register within env in 64-bit mode.
3232  */
3233 static inline uint64_t *aa64_vfp_qreg(CPUARMState *env, unsigned regno)
3234 {
3235     return &env->vfp.zregs[regno].d[0];
3236 }
3237 
3238 /* Shared between translate-sve.c and sve_helper.c.  */
3239 extern const uint64_t pred_esz_masks[5];
3240 
3241 /*
3242  * AArch64 usage of the PAGE_TARGET_* bits for linux-user.
3243  * Note that with the Linux kernel, PROT_MTE may not be cleared by mprotect
3244  * mprotect but PROT_BTI may be cleared.  C.f. the kernel's VM_ARCH_CLEAR.
3245  */
3246 #define PAGE_BTI            PAGE_TARGET_1
3247 #define PAGE_MTE            PAGE_TARGET_2
3248 #define PAGE_TARGET_STICKY  PAGE_MTE
3249 
3250 /* We associate one allocation tag per 16 bytes, the minimum.  */
3251 #define LOG2_TAG_GRANULE 4
3252 #define TAG_GRANULE      (1 << LOG2_TAG_GRANULE)
3253 
3254 #ifdef CONFIG_USER_ONLY
3255 
3256 #define TARGET_PAGE_DATA_SIZE (TARGET_PAGE_SIZE >> (LOG2_TAG_GRANULE + 1))
3257 
3258 #ifdef TARGET_TAGGED_ADDRESSES
3259 /**
3260  * cpu_untagged_addr:
3261  * @cs: CPU context
3262  * @x: tagged address
3263  *
3264  * Remove any address tag from @x.  This is explicitly related to the
3265  * linux syscall TIF_TAGGED_ADDR setting, not TBI in general.
3266  *
3267  * There should be a better place to put this, but we need this in
3268  * include/exec/cpu_ldst.h, and not some place linux-user specific.
3269  */
3270 static inline target_ulong cpu_untagged_addr(CPUState *cs, target_ulong x)
3271 {
3272     CPUARMState *env = cpu_env(cs);
3273     if (env->tagged_addr_enable) {
3274         /*
3275          * TBI is enabled for userspace but not kernelspace addresses.
3276          * Only clear the tag if bit 55 is clear.
3277          */
3278         x &= sextract64(x, 0, 56);
3279     }
3280     return x;
3281 }
3282 #endif /* TARGET_TAGGED_ADDRESSES */
3283 #endif /* CONFIG_USER_ONLY */
3284 
3285 #endif
3286