VirtualBox

source: vbox/trunk/include/iprt/armv8.h@ 99901

Last change on this file since 99901 was 99739, checked in by vboxsync, 13 months ago

*: doxygen corrections (mostly about removing @returns from functions returning void).
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 63.3 KB
Line 
1/** @file
2 * IPRT - ARMv8 (AArch64 and AArch32) Structures and Definitions.
3 */
4
5/*
6 * Copyright (C) 2023 Oracle and/or its affiliates.
7 *
8 * This file is part of VirtualBox base platform packages, as
9 * available from https://www.virtualbox.org.
10 *
11 * This program is free software; you can redistribute it and/or
12 * modify it under the terms of the GNU General Public License
13 * as published by the Free Software Foundation, in version 3 of the
14 * License.
15 *
16 * This program is distributed in the hope that it will be useful, but
17 * WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 * General Public License for more details.
20 *
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, see <https://www.gnu.org/licenses>.
23 *
24 * The contents of this file may alternatively be used under the terms
25 * of the Common Development and Distribution License Version 1.0
26 * (CDDL), a copy of it is provided in the "COPYING.CDDL" file included
27 * in the VirtualBox distribution, in which case the provisions of the
28 * CDDL are applicable instead of those of the GPL.
29 *
30 * You may elect to license modified versions of this file under the
31 * terms and conditions of either the GPL or the CDDL or both.
32 *
33 * SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0
34 */
35
36#ifndef IPRT_INCLUDED_armv8_h
37#define IPRT_INCLUDED_armv8_h
38#ifndef RT_WITHOUT_PRAGMA_ONCE
39# pragma once
40#endif
41
42#ifndef VBOX_FOR_DTRACE_LIB
43# include <iprt/types.h>
44# include <iprt/assert.h>
45#else
46# pragma D depends_on library vbox-types.d
47#endif
48
49/** @defgroup grp_rt_armv8 ARMv8 Types and Definitions
50 * @ingroup grp_rt
51 * @{
52 */
53
54/** @name The AArch64 register encoding.
55 * @{ */
56#define ARMV8_AARCH64_REG_X0 0
57#define ARMV8_AARCH64_REG_W0 ARMV8_AARCH64_REG_X0
58#define ARMV8_AARCH64_REG_X1 1
59#define ARMV8_AARCH64_REG_W1 ARMV8_AARCH64_REG_X1
60#define ARMV8_AARCH64_REG_X2 2
61#define ARMV8_AARCH64_REG_W2 ARMV8_AARCH64_REG_X2
62#define ARMV8_AARCH64_REG_X3 3
63#define ARMV8_AARCH64_REG_W3 ARMV8_AARCH64_REG_X3
64#define ARMV8_AARCH64_REG_X4 4
65#define ARMV8_AARCH64_REG_W4 ARMV8_AARCH64_REG_X4
66#define ARMV8_AARCH64_REG_X5 5
67#define ARMV8_AARCH64_REG_W5 ARMV8_AARCH64_REG_X5
68#define ARMV8_AARCH64_REG_X6 6
69#define ARMV8_AARCH64_REG_W6 ARMV8_AARCH64_REG_X6
70#define ARMV8_AARCH64_REG_X7 7
71#define ARMV8_AARCH64_REG_W7 ARMV8_AARCH64_REG_X7
72#define ARMV8_AARCH64_REG_X8 8
73#define ARMV8_AARCH64_REG_W8 ARMV8_AARCH64_REG_X8
74#define ARMV8_AARCH64_REG_X9 9
75#define ARMV8_AARCH64_REG_W9 ARMV8_AARCH64_REG_X9
76#define ARMV8_AARCH64_REG_X10 10
77#define ARMV8_AARCH64_REG_W10 ARMV8_AARCH64_REG_X10
78#define ARMV8_AARCH64_REG_X11 11
79#define ARMV8_AARCH64_REG_W11 ARMV8_AARCH64_REG_X11
80#define ARMV8_AARCH64_REG_X12 12
81#define ARMV8_AARCH64_REG_W12 ARMV8_AARCH64_REG_X12
82#define ARMV8_AARCH64_REG_X13 13
83#define ARMV8_AARCH64_REG_W13 ARMV8_AARCH64_REG_X13
84#define ARMV8_AARCH64_REG_X14 14
85#define ARMV8_AARCH64_REG_W14 ARMV8_AARCH64_REG_X14
86#define ARMV8_AARCH64_REG_X15 15
87#define ARMV8_AARCH64_REG_W15 ARMV8_AARCH64_REG_X15
88#define ARMV8_AARCH64_REG_X16 16
89#define ARMV8_AARCH64_REG_W16 ARMV8_AARCH64_REG_X16
90#define ARMV8_AARCH64_REG_X17 17
91#define ARMV8_AARCH64_REG_W17 ARMV8_AARCH64_REG_X17
92#define ARMV8_AARCH64_REG_X18 18
93#define ARMV8_AARCH64_REG_W18 ARMV8_AARCH64_REG_X18
94#define ARMV8_AARCH64_REG_X19 19
95#define ARMV8_AARCH64_REG_W19 ARMV8_AARCH64_REG_X19
96#define ARMV8_AARCH64_REG_X20 20
97#define ARMV8_AARCH64_REG_W20 ARMV8_AARCH64_REG_X20
98#define ARMV8_AARCH64_REG_X21 21
99#define ARMV8_AARCH64_REG_W21 ARMV8_AARCH64_REG_X21
100#define ARMV8_AARCH64_REG_X22 22
101#define ARMV8_AARCH64_REG_W22 ARMV8_AARCH64_REG_X22
102#define ARMV8_AARCH64_REG_X23 23
103#define ARMV8_AARCH64_REG_W23 ARMV8_AARCH64_REG_X23
104#define ARMV8_AARCH64_REG_X24 24
105#define ARMV8_AARCH64_REG_W24 ARMV8_AARCH64_REG_X24
106#define ARMV8_AARCH64_REG_X25 25
107#define ARMV8_AARCH64_REG_W25 ARMV8_AARCH64_REG_X25
108#define ARMV8_AARCH64_REG_X26 26
109#define ARMV8_AARCH64_REG_W26 ARMV8_AARCH64_REG_X26
110#define ARMV8_AARCH64_REG_X27 27
111#define ARMV8_AARCH64_REG_W27 ARMV8_AARCH64_REG_X27
112#define ARMV8_AARCH64_REG_X28 28
113#define ARMV8_AARCH64_REG_W28 ARMV8_AARCH64_REG_X28
114#define ARMV8_AARCH64_REG_X29 29
115#define ARMV8_AARCH64_REG_W29 ARMV8_AARCH64_REG_X29
116#define ARMV8_AARCH64_REG_X30 30
117#define ARMV8_AARCH64_REG_W30 ARMV8_AARCH64_REG_X30
118/** The zero register. */
119#define ARMV8_AARCH64_REG_ZR 31
120/** @} */
121
122
123/** @name System register encoding.
124 * @{
125 */
126/** Mask for the op0 part of an MSR/MRS instruction */
127#define ARMV8_AARCH64_SYSREG_OP0_MASK (RT_BIT_32(19) | RT_BIT_32(20))
128/** Shift for the op0 part of an MSR/MRS instruction */
129#define ARMV8_AARCH64_SYSREG_OP0_SHIFT 19
130/** Returns the op0 part of the given MRS/MSR instruction. */
131#define ARMV8_AARCH64_SYSREG_OP0_GET(a_MsrMrsInsn) (((a_MsrMrsInsn) & ARMV8_AARCH64_SYSREG_OP0_MASK) >> ARMV8_AARCH64_SYSREG_OP0_SHIFT)
132/** Mask for the op1 part of an MSR/MRS instruction */
133#define ARMV8_AARCH64_SYSREG_OP1_MASK (RT_BIT_32(16) | RT_BIT_32(17) | RT_BIT_32(18))
134/** Shift for the op1 part of an MSR/MRS instruction */
135#define ARMV8_AARCH64_SYSREG_OP1_SHIFT 16
136/** Returns the op1 part of the given MRS/MSR instruction. */
137#define ARMV8_AARCH64_SYSREG_OP1_GET(a_MsrMrsInsn) (((a_MsrMrsInsn) & ARMV8_AARCH64_SYSREG_OP1_MASK) >> ARMV8_AARCH64_SYSREG_OP1_SHIFT)
138/** Mask for the CRn part of an MSR/MRS instruction */
139#define ARMV8_AARCH64_SYSREG_CRN_MASK ( RT_BIT_32(12) | RT_BIT_32(13) | RT_BIT_32(14) \
140 | RT_BIT_32(15) )
141/** Shift for the CRn part of an MSR/MRS instruction */
142#define ARMV8_AARCH64_SYSREG_CRN_SHIFT 12
143/** Returns the CRn part of the given MRS/MSR instruction. */
144#define ARMV8_AARCH64_SYSREG_CRN_GET(a_MsrMrsInsn) (((a_MsrMrsInsn) & ARMV8_AARCH64_SYSREG_CRN_MASK) >> ARMV8_AARCH64_SYSREG_CRN_SHIFT)
145/** Mask for the CRm part of an MSR/MRS instruction */
146#define ARMV8_AARCH64_SYSREG_CRM_MASK ( RT_BIT_32(8) | RT_BIT_32(9) | RT_BIT_32(10) \
147 | RT_BIT_32(11) )
148/** Shift for the CRm part of an MSR/MRS instruction */
149#define ARMV8_AARCH64_SYSREG_CRM_SHIFT 8
150/** Returns the CRn part of the given MRS/MSR instruction. */
151#define ARMV8_AARCH64_SYSREG_CRM_GET(a_MsrMrsInsn) (((a_MsrMrsInsn) & ARMV8_AARCH64_SYSREG_CRM_MASK) >> ARMV8_AARCH64_SYSREG_CRM_SHIFT)
152/** Mask for the op2 part of an MSR/MRS instruction */
153#define ARMV8_AARCH64_SYSREG_OP2_MASK (RT_BIT_32(5) | RT_BIT_32(6) | RT_BIT_32(7))
154/** Shift for the op2 part of an MSR/MRS instruction */
155#define ARMV8_AARCH64_SYSREG_OP2_SHIFT 5
156/** Returns the op2 part of the given MRS/MSR instruction. */
157#define ARMV8_AARCH64_SYSREG_OP2_GET(a_MsrMrsInsn) (((a_MsrMrsInsn) & ARMV8_AARCH64_SYSREG_OP2_MASK) >> ARMV8_AARCH64_SYSREG_OP2_SHIFT)
158/** Mask for all system register encoding relevant fields in an MRS/MSR instruction. */
159#define ARMV8_AARCH64_SYSREG_MASK ( ARMV8_AARCH64_SYSREG_OP0_MASK | ARMV8_AARCH64_SYSREG_OP1_MASK \
160 | ARMV8_AARCH64_SYSREG_CRN_MASK | ARMV8_AARCH64_SYSREG_CRN_MASK \
161 | ARMV8_AARCH64_SYSREG_OP2_MASK)
162/** @} */
163
164/** @name Mapping of op0:op1:CRn:CRm:op2 to a system register ID. This is
165 * IPRT specific and not part of the ARMv8 specification. */
166#define ARMV8_AARCH64_SYSREG_ID_CREATE(a_Op0, a_Op1, a_CRn, a_CRm, a_Op2) \
167 UINT16_C( (((a_Op0) & 0x3) << 14) \
168 | (((a_Op1) & 0x7) << 11) \
169 | (((a_CRn) & 0xf) << 7) \
170 | (((a_CRm) & 0xf) << 3) \
171 | ((a_Op2) & 0x7))
172/** Returns the internal system register ID from the given MRS/MSR instruction. */
173#define ARMV8_AARCH64_SYSREG_ID_FROM_MRS_MSR(a_MsrMrsInsn) \
174 ARMV8_AARCH64_SYSREG_ID_CREATE(ARMV8_AARCH64_SYSREG_OP0_GET(a_MsrMrsInsn), \
175 ARMV8_AARCH64_SYSREG_OP1_GET(a_MsrMrsInsn), \
176 ARMV8_AARCH64_SYSREG_CRN_GET(a_MsrMrsInsn), \
177 ARMV8_AARCH64_SYSREG_CRM_GET(a_MsrMrsInsn), \
178 ARMV8_AARCH64_SYSREG_OP2_GET(a_MsrMrsInsn))
179/** Encodes the given system register ID in the given MSR/MRS instruction. */
180#define ARMV8_AARCH64_SYSREG_ID_ENCODE_IN_MRS_MSR(a_MsrMrsInsn, a_SysregId) \
181 ((a_MsrMrsInsn) = ((a_MsrMrsInsn) & ~ARMV8_AARCH64_SYSREG_MASK) | (a_SysregId << ARMV8_AARCH64_SYSREG_OP2_SHIFT))
182/** @} */
183
184
185/** @name System register IDs.
186 * @{ */
187/** OSLAR_EL1 register - RW. */
188#define ARMV8_AARCH64_SYSREG_OSLAR_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(2, 0, 1, 0, 4)
189/** OSLSR_EL1 register - RW. */
190#define ARMV8_AARCH64_SYSREG_OSLSR_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(2, 0, 1, 1, 4)
191/** OSDLR_EL1 register - RW. */
192#define ARMV8_AARCH64_SYSREG_OSDLR_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(2, 0, 1, 3, 4)
193
194/** MIDR_EL1 register - RO. */
195#define ARMV8_AARCH64_SYSREG_MIDR_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 0, 0, 0)
196/** MIPDR_EL1 register - RO. */
197#define ARMV8_AARCH64_SYSREG_MPIDR_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 0, 0, 5)
198/** REVIDR_EL1 register - RO. */
199#define ARMV8_AARCH64_SYSREG_REVIDR_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 0, 0, 6)
200/** ID_PFR0_EL1 register - RO. */
201#define ARMV8_AARCH64_SYSREG_ID_PFR0_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 0, 1, 0)
202/** ID_PFR1_EL1 register - RO. */
203#define ARMV8_AARCH64_SYSREG_ID_PFR1_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 0, 1, 1)
204/** ID_DFR0_EL1 register - RO. */
205#define ARMV8_AARCH64_SYSREG_ID_DFR0_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 0, 1, 2)
206/** ID_AFR0_EL1 register - RO. */
207#define ARMV8_AARCH64_SYSREG_ID_AFR0_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 0, 1, 3)
208/** ID_MMFR0_EL1 register - RO. */
209#define ARMV8_AARCH64_SYSREG_ID_MMFR0_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 0, 1, 4)
210/** ID_MMFR1_EL1 register - RO. */
211#define ARMV8_AARCH64_SYSREG_ID_MMFR1_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 0, 1, 5)
212/** ID_MMFR2_EL1 register - RO. */
213#define ARMV8_AARCH64_SYSREG_ID_MMFR2_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 0, 1, 6)
214/** ID_MMFR3_EL1 register - RO. */
215#define ARMV8_AARCH64_SYSREG_ID_MMFR3_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 0, 1, 7)
216
217/** ID_ISAR0_EL1 register - RO. */
218#define ARMV8_AARCH64_SYSREG_ID_ISAR0_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 0, 2, 0)
219/** ID_ISAR1_EL1 register - RO. */
220#define ARMV8_AARCH64_SYSREG_ID_ISAR1_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 0, 2, 1)
221/** ID_ISAR2_EL1 register - RO. */
222#define ARMV8_AARCH64_SYSREG_ID_ISAR2_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 0, 2, 2)
223/** ID_ISAR3_EL1 register - RO. */
224#define ARMV8_AARCH64_SYSREG_ID_ISAR3_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 0, 2, 3)
225/** ID_ISAR4_EL1 register - RO. */
226#define ARMV8_AARCH64_SYSREG_ID_ISAR4_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 0, 2, 4)
227/** ID_ISAR5_EL1 register - RO. */
228#define ARMV8_AARCH64_SYSREG_ID_ISAR5_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 0, 2, 5)
229/** ID_MMFR4_EL1 register - RO. */
230#define ARMV8_AARCH64_SYSREG_ID_MMFR4_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 0, 2, 6)
231/** ID_ISAR6_EL1 register - RO. */
232#define ARMV8_AARCH64_SYSREG_ID_ISAR6_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 0, 2, 7)
233
234/** MVFR0_EL1 register - RO. */
235#define ARMV8_AARCH64_SYSREG_MVFR0_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 0, 3, 0)
236/** MVFR1_EL1 register - RO. */
237#define ARMV8_AARCH64_SYSREG_MVFR1_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 0, 3, 1)
238/** MVFR2_EL1 register - RO. */
239#define ARMV8_AARCH64_SYSREG_MVFR2_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 0, 3, 2)
240/** ID_PFR2_EL1 register - RO. */
241#define ARMV8_AARCH64_SYSREG_ID_PFR2_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 0, 3, 4)
242/** ID_DFR1_EL1 register - RO. */
243#define ARMV8_AARCH64_SYSREG_ID_DFR1_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 0, 3, 5)
244/** ID_MMFR5_EL1 register - RO. */
245#define ARMV8_AARCH64_SYSREG_ID_MMFR5_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 0, 3, 6)
246
247/** ID_AA64PFR0_EL1 register - RO. */
248#define ARMV8_AARCH64_SYSREG_ID_AA64PFR0_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 0, 4, 0)
249/** ID_AA64PFR0_EL1 register - RO. */
250#define ARMV8_AARCH64_SYSREG_ID_AA64PFR1_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 0, 4, 1)
251/** ID_AA64ZFR0_EL1 register - RO. */
252#define ARMV8_AARCH64_SYSREG_ID_AA64ZFR0_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 0, 4, 4)
253/** ID_AA64SMFR0_EL1 register - RO. */
254#define ARMV8_AARCH64_SYSREG_ID_AA64SMFR0_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 0, 4, 5)
255
256/** ID_AA64DFR0_EL1 register - RO. */
257#define ARMV8_AARCH64_SYSREG_ID_AA64DFR0_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 0, 5, 0)
258/** ID_AA64DFR0_EL1 register - RO. */
259#define ARMV8_AARCH64_SYSREG_ID_AA64DFR1_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 0, 5, 1)
260/** ID_AA64AFR0_EL1 register - RO. */
261#define ARMV8_AARCH64_SYSREG_ID_AA64AFR0_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 0, 5, 4)
262/** ID_AA64AFR1_EL1 register - RO. */
263#define ARMV8_AARCH64_SYSREG_ID_AA64AFR1_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 0, 5, 5)
264
265/** ID_AA64ISAR0_EL1 register - RO. */
266#define ARMV8_AARCH64_SYSREG_ID_AA64ISAR0_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 0, 6, 0)
267/** ID_AA64ISAR1_EL1 register - RO. */
268#define ARMV8_AARCH64_SYSREG_ID_AA64ISAR1_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 0, 6, 1)
269/** ID_AA64ISAR2_EL1 register - RO. */
270#define ARMV8_AARCH64_SYSREG_ID_AA64ISAR2_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 0, 6, 2)
271
272/** ID_AA64MMFR0_EL1 register - RO. */
273#define ARMV8_AARCH64_SYSREG_ID_AA64MMFR0_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 0, 7, 0)
274/** ID_AA64MMFR1_EL1 register - RO. */
275#define ARMV8_AARCH64_SYSREG_ID_AA64MMFR1_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 0, 7, 1)
276/** ID_AA64MMFR2_EL1 register - RO. */
277#define ARMV8_AARCH64_SYSREG_ID_AA64MMFR2_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 0, 7, 2)
278
279/** SCTRL_EL1 register - RW. */
280#define ARMV8_AARCH64_SYSREG_SCTRL_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 1, 0, 0)
281/** ACTRL_EL1 register - RW. */
282#define ARMV8_AARCH64_SYSREG_ACTRL_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 1, 0, 1)
283/** CPACR_EL1 register - RW. */
284#define ARMV8_AARCH64_SYSREG_CPACR_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 1, 0, 2)
285/** RGSR_EL1 register - RW. */
286#define ARMV8_AARCH64_SYSREG_RGSR_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 1, 0, 5)
287/** GCR_EL1 register - RW. */
288#define ARMV8_AARCH64_SYSREG_GCR_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 1, 0, 6)
289
290/** ZCR_EL1 register - RW. */
291#define ARMV8_AARCH64_SYSREG_ZCR_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 1, 2, 0)
292/** TRFCR_EL1 register - RW. */
293#define ARMV8_AARCH64_SYSREG_TRFCR_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 1, 2, 1)
294/** SMPRI_EL1 register - RW. */
295#define ARMV8_AARCH64_SYSREG_SMPRI_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 1, 2, 4)
296/** SMCR_EL1 register - RW. */
297#define ARMV8_AARCH64_SYSREG_SMCR_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 1, 2, 6)
298
299/** TTBR0_EL1 register - RW. */
300#define ARMV8_AARCH64_SYSREG_TTBR0_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 2, 0, 0)
301/** TTBR1_EL1 register - RW. */
302#define ARMV8_AARCH64_SYSREG_TTBR1_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 2, 0, 1)
303/** TCR_EL1 register - RW. */
304#define ARMV8_AARCH64_SYSREG_TCR_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 2, 0, 2)
305
306/** @todo APIA,APIB,APDA,APDB,APGA registers. */
307
308/** SPSR_EL1 register - RW. */
309#define ARMV8_AARCH64_SYSREG_SPSR_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 4, 0, 0)
310/** ELR_EL1 register - RW. */
311#define ARMV8_AARCH64_SYSREG_ELR_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 4, 0, 1)
312
313/** SP_EL0 register - RW. */
314#define ARMV8_AARCH64_SYSREG_SP_EL0 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 4, 1, 0)
315
316/** PSTATE.SPSel value. */
317#define ARMV8_AARCH64_SYSREG_SPSEL ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 4, 2, 0)
318/** PSTATE.CurrentEL value. */
319#define ARMV8_AARCH64_SYSREG_CURRENTEL ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 4, 2, 2)
320/** PSTATE.PAN value. */
321#define ARMV8_AARCH64_SYSREG_PAN ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 4, 2, 3)
322/** PSTATE.UAO value. */
323#define ARMV8_AARCH64_SYSREG_UAO ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 4, 2, 4)
324
325/** PSTATE.ALLINT value. */
326#define ARMV8_AARCH64_SYSREG_ALLINT ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 4, 3, 0)
327
328/** ICC_PMR_EL1 register - RW. */
329#define ARMV8_AARCH64_SYSREG_ICC_PMR_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 4, 6, 0)
330
331/** AFSR0_EL1 register - RW. */
332#define ARMV8_AARCH64_SYSREG_AFSR0_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 5, 1, 0)
333/** AFSR1_EL1 register - RW. */
334#define ARMV8_AARCH64_SYSREG_AFSR1_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 5, 1, 1)
335
336/** ESR_EL1 register - RW. */
337#define ARMV8_AARCH64_SYSREG_ESR_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 5, 2, 0)
338
339/** ERRIDR_EL1 register - RO. */
340#define ARMV8_AARCH64_SYSREG_ERRIDR_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 5, 3, 0)
341/** ERRSELR_EL1 register - RW. */
342#define ARMV8_AARCH64_SYSREG_ERRSELR_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 5, 3, 1)
343
344/** ICC_IAR0_EL1 register - RO. */
345#define ARMV8_AARCH64_SYSREG_ICC_IAR0_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 12, 8, 0)
346/** ICC_EOIR0_EL1 register - WO. */
347#define ARMV8_AARCH64_SYSREG_ICC_EOIR0_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 12, 8, 1)
348/** ICC_HPPIR0_EL1 register - WO. */
349#define ARMV8_AARCH64_SYSREG_ICC_HPPIR0_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 12, 8, 2)
350/** ICC_BPR0_EL1 register - RW. */
351#define ARMV8_AARCH64_SYSREG_ICC_BPR0_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 12, 8, 3)
352/** ICC_AP0R0_EL1 register - RW. */
353#define ARMV8_AARCH64_SYSREG_ICC_AP0R0_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 12, 8, 4)
354/** ICC_AP0R1_EL1 register - RW. */
355#define ARMV8_AARCH64_SYSREG_ICC_AP0R1_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 12, 8, 5)
356/** ICC_AP0R2_EL1 register - RW. */
357#define ARMV8_AARCH64_SYSREG_ICC_AP0R2_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 12, 8, 6)
358/** ICC_AP0R3_EL1 register - RW. */
359#define ARMV8_AARCH64_SYSREG_ICC_AP0R3_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 12, 8, 7)
360
361/** ICC_AP1R0_EL1 register - RW. */
362#define ARMV8_AARCH64_SYSREG_ICC_AP1R0_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 12, 9, 0)
363/** ICC_AP1R1_EL1 register - RW. */
364#define ARMV8_AARCH64_SYSREG_ICC_AP1R1_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 12, 9, 1)
365/** ICC_AP1R2_EL1 register - RW. */
366#define ARMV8_AARCH64_SYSREG_ICC_AP1R2_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 12, 9, 2)
367/** ICC_AP1R3_EL1 register - RW. */
368#define ARMV8_AARCH64_SYSREG_ICC_AP1R3_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 12, 9, 3)
369/** ICC_NMIAR1_EL1 register - RO. */
370#define ARMV8_AARCH64_SYSREG_ICC_NMIAR1_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 12, 9, 5)
371
372/** ICC_DIR_EL1 register - WO. */
373#define ARMV8_AARCH64_SYSREG_ICC_DIR_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 12, 11, 1)
374/** ICC_RPR_EL1 register - RO. */
375#define ARMV8_AARCH64_SYSREG_ICC_RPR_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 12, 11, 3)
376/** ICC_SGI1R_EL1 register - WO. */
377#define ARMV8_AARCH64_SYSREG_ICC_SGI1R_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 12, 11, 5)
378/** ICC_ASGI1R_EL1 register - WO. */
379#define ARMV8_AARCH64_SYSREG_ICC_ASGI1R_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 12, 11, 6)
380/** ICC_SGI0R_EL1 register - WO. */
381#define ARMV8_AARCH64_SYSREG_ICC_SGI0R_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 12, 11, 7)
382
383/** ICC_IAR1_EL1 register - RO. */
384#define ARMV8_AARCH64_SYSREG_ICC_IAR1_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 12, 12, 0)
385/** ICC_EOIR1_EL1 register - WO. */
386#define ARMV8_AARCH64_SYSREG_ICC_EOIR1_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 12, 12, 1)
387/** ICC_HPPIR1_EL1 register - RO. */
388#define ARMV8_AARCH64_SYSREG_ICC_HPPIR1_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 12, 12, 2)
389/** ICC_BPR1_EL1 register - RW. */
390#define ARMV8_AARCH64_SYSREG_ICC_BPR1_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 12, 12, 3)
391/** ICC_CTLR_EL1 register - RW. */
392#define ARMV8_AARCH64_SYSREG_ICC_CTLR_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 12, 12, 4)
393/** ICC_SRE_EL1 register - RW. */
394#define ARMV8_AARCH64_SYSREG_ICC_SRE_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 12, 12, 5)
395/** ICC_IGRPEN0_EL1 register - RW. */
396#define ARMV8_AARCH64_SYSREG_ICC_IGRPEN0_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 12, 12, 6)
397/** ICC_IGRPEN1_EL1 register - RW. */
398#define ARMV8_AARCH64_SYSREG_ICC_IGRPEN1_EL1 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 0, 12, 12, 7)
399
400/** CNTV_CTL_EL0 register - RW. */
401#define ARMV8_AARCH64_SYSREG_CNTV_CTL_EL0 ARMV8_AARCH64_SYSREG_ID_CREATE(3, 3, 14, 3, 1)
402/** @} */
403
404
405/**
406 * SPSR_EL2 (according to chapter C5.2.19)
407 */
408typedef union ARMV8SPSREL2
409{
410 /** The plain unsigned view. */
411 uint64_t u;
412 /** The 8-bit view. */
413 uint8_t au8[8];
414 /** The 16-bit view. */
415 uint16_t au16[4];
416 /** The 32-bit view. */
417 uint32_t au32[2];
418 /** The 64-bit view. */
419 uint64_t u64;
420} ARMV8SPSREL2;
421/** Pointer to SPSR_EL2. */
422typedef ARMV8SPSREL2 *PARMV8SPSREL2;
423/** Pointer to const SPSR_EL2. */
424typedef const ARMV8SPSREL2 *PCXARMV8SPSREL2;
425
426
427/** @name SPSR_EL2 (When exception is taken from AArch64 state)
428 * @{
429 */
430/** Bit 0 - 3 - M - AArch64 Exception level and selected stack pointer. */
431#define ARMV8_SPSR_EL2_AARCH64_M (RT_BIT_64(0) | RT_BIT_64(1) | RT_BIT_64(2) | RT_BIT_64(3))
432#define ARMV8_SPSR_EL2_AARCH64_GET_M(a_Spsr) ((a_Spsr) & ARMV8_SPSR_EL2_AARCH64_M)
433/** Bit 0 - SP - Selected stack pointer. */
434#define ARMV8_SPSR_EL2_AARCH64_SP RT_BIT_64(0)
435#define ARMV8_SPSR_EL2_AARCH64_SP_BIT 0
436/** Bit 1 - Reserved (read as zero). */
437#define ARMV8_SPSR_EL2_AARCH64_RSVD_1 RT_BIT_64(1)
438/** Bit 2 - 3 - EL - Exception level. */
439#define ARMV8_SPSR_EL2_AARCH64_EL (RT_BIT_64(2) | RT_BIT_64(3))
440#define ARMV8_SPSR_EL2_AARCH64_EL_SHIFT 2
441#define ARMV8_SPSR_EL2_AARCH64_GET_EL(a_Spsr) (((a_Spsr) >> ARMV8_SPSR_EL2_AARCH64_EL_SHIFT) & 3)
442#define ARMV8_SPSR_EL2_AARCH64_SET_EL(a_El) ((a_El) << ARMV8_SPSR_EL2_AARCH64_EL_SHIFT)
443/** Bit 4 - M[4] - Execution state (0 means AArch64, when 1 this contains a AArch32 state). */
444#define ARMV8_SPSR_EL2_AARCH64_M4 RT_BIT_64(4)
445#define ARMV8_SPSR_EL2_AARCH64_M4_BIT 4
446/** Bit 5 - Reserved (read as zero). */
447#define ARMV8_SPSR_EL2_AARCH64_RSVD_5 RT_BIT_64(5)
448/** Bit 6 - I - FIQ interrupt mask. */
449#define ARMV8_SPSR_EL2_AARCH64_F RT_BIT_64(6)
450#define ARMV8_SPSR_EL2_AARCH64_F_BIT 6
451/** Bit 7 - I - IRQ interrupt mask. */
452#define ARMV8_SPSR_EL2_AARCH64_I RT_BIT_64(7)
453#define ARMV8_SPSR_EL2_AARCH64_I_BIT 7
454/** Bit 8 - A - SError interrupt mask. */
455#define ARMV8_SPSR_EL2_AARCH64_A RT_BIT_64(8)
456#define ARMV8_SPSR_EL2_AARCH64_A_BIT 8
457/** Bit 9 - D - Debug Exception mask. */
458#define ARMV8_SPSR_EL2_AARCH64_D RT_BIT_64(9)
459#define ARMV8_SPSR_EL2_AARCH64_D_BIT 9
460/** Bit 10 - 11 - BTYPE - Branch Type indicator. */
461#define ARMV8_SPSR_EL2_AARCH64_BYTPE (RT_BIT_64(10) | RT_BIT_64(11))
462#define ARMV8_SPSR_EL2_AARCH64_BYTPE_SHIFT 10
463#define ARMV8_SPSR_EL2_AARCH64_GET_BYTPE(a_Spsr) (((a_Spsr) >> ARMV8_SPSR_EL2_AARCH64_BYTPE_SHIFT) & 3)
464/** Bit 12 - SSBS - Speculative Store Bypass. */
465#define ARMV8_SPSR_EL2_AARCH64_SSBS RT_BIT_64(12)
466#define ARMV8_SPSR_EL2_AARCH64_SSBS_BIT 12
467/** Bit 13 - ALLINT - All IRQ or FIQ interrupts mask. */
468#define ARMV8_SPSR_EL2_AARCH64_ALLINT RT_BIT_64(13)
469#define ARMV8_SPSR_EL2_AARCH64_ALLINT_BIT 13
470/** Bit 14 - 19 - Reserved (read as zero). */
471#define ARMV8_SPSR_EL2_AARCH64_RSVD_14_19 ( RT_BIT_64(14) | RT_BIT_64(15) | RT_BIT_64(16) \
472 | RT_BIT_64(17) | RT_BIT_64(18) | RT_BIT_64(19))
473/** Bit 20 - IL - Illegal Execution State flag. */
474#define ARMV8_SPSR_EL2_AARCH64_IL RT_BIT_64(20)
475#define ARMV8_SPSR_EL2_AARCH64_IL_BIT 20
476/** Bit 21 - SS - Software Step flag. */
477#define ARMV8_SPSR_EL2_AARCH64_SS RT_BIT_64(21)
478#define ARMV8_SPSR_EL2_AARCH64_SS_BIT 21
479/** Bit 22 - PAN - Privileged Access Never flag. */
480#define ARMV8_SPSR_EL2_AARCH64_PAN RT_BIT_64(25)
481#define ARMV8_SPSR_EL2_AARCH64_PAN_BIT 22
482/** Bit 23 - UAO - User Access Override flag. */
483#define ARMV8_SPSR_EL2_AARCH64_UAO RT_BIT_64(23)
484#define ARMV8_SPSR_EL2_AARCH64_UAO_BIT 23
485/** Bit 24 - DIT - Data Independent Timing flag. */
486#define ARMV8_SPSR_EL2_AARCH64_DIT RT_BIT_64(24)
487#define ARMV8_SPSR_EL2_AARCH64_DIT_BIT 24
488/** Bit 25 - TCO - Tag Check Override flag. */
489#define ARMV8_SPSR_EL2_AARCH64_TCO RT_BIT_64(25)
490#define ARMV8_SPSR_EL2_AARCH64_TCO_BIT 25
491/** Bit 26 - 27 - Reserved (read as zero). */
492#define ARMV8_SPSR_EL2_AARCH64_RSVD_26_27 (RT_BIT_64(26) | RT_BIT_64(27))
493/** Bit 28 - V - Overflow condition flag. */
494#define ARMV8_SPSR_EL2_AARCH64_V RT_BIT_64(28)
495#define ARMV8_SPSR_EL2_AARCH64_V_BIT 28
496/** Bit 29 - C - Carry condition flag. */
497#define ARMV8_SPSR_EL2_AARCH64_C RT_BIT_64(29)
498#define ARMV8_SPSR_EL2_AARCH64_C_BIT 29
499/** Bit 30 - Z - Zero condition flag. */
500#define ARMV8_SPSR_EL2_AARCH64_Z RT_BIT_64(30)
501#define ARMV8_SPSR_EL2_AARCH64_Z_BIT 30
502/** Bit 31 - N - Negative condition flag. */
503#define ARMV8_SPSR_EL2_AARCH64_N RT_BIT_64(31)
504#define ARMV8_SPSR_EL2_AARCH64_N_BIT 31
505/** Bit 32 - 63 - Reserved (read as zero). */
506#define ARMV8_SPSR_EL2_AARCH64_RSVD_32_63 (UINT64_C(0xffffffff00000000))
507/** Checks whether the given SPSR value contains a AARCH64 execution state. */
508#define ARMV8_SPSR_EL2_IS_AARCH64_STATE(a_Spsr) (!((a_Spsr) & ARMV8_SPSR_EL2_AARCH64_M4))
509/** @} */
510
511/** @name Aarch64 Exception levels
512 * @{ */
513/** Exception Level 0 - User mode. */
514#define ARMV8_AARCH64_EL_0 0
515/** Exception Level 1 - Supervisor mode. */
516#define ARMV8_AARCH64_EL_1 1
517/** Exception Level 2 - Hypervisor mode. */
518#define ARMV8_AARCH64_EL_2 2
519/** @} */
520
521
522/** @name ESR_EL2 (Exception Syndrome Register, EL2)
523 * @{
524 */
525/** Bit 0 - 24 - ISS - Instruction Specific Syndrome, encoding depends on the exception class. */
526#define ARMV8_ESR_EL2_ISS UINT64_C(0x1ffffff)
527#define ARMV8_ESR_EL2_ISS_GET(a_Esr) ((a_Esr) & ARMV8_ESR_EL2_ISS)
528/** Bit 25 - IL - Instruction length for synchronous exception (0 means 16-bit instruction, 1 32-bit instruction). */
529#define ARMV8_ESR_EL2_IL RT_BIT_64(25)
530#define ARMV8_ESR_EL2_IL_BIT 25
531#define ARMV8_ESR_EL2_IL_IS_32BIT(a_Esr) RT_BOOL((a_Esr) & ARMV8_ESR_EL2_IL)
532#define ARMV8_ESR_EL2_IL_IS_16BIT(a_Esr) (!((a_Esr) & ARMV8_ESR_EL2_IL))
533/** Bit 26 - 31 - EC - Exception class, indicates reason for the exception that this register holds information about. */
534#define ARMV8_ESR_EL2_EC ( RT_BIT_64(26) | RT_BIT_64(27) | RT_BIT_64(28) \
535 | RT_BIT_64(29) | RT_BIT_64(30) | RT_BIT_64(31))
536#define ARMV8_ESR_EL2_EC_GET(a_Esr) (((a_Esr) & ARMV8_ESR_EL2_EC) >> 26)
537/** Bit 32 - 36 - ISS2 - Only valid when FEAT_LS64_V and/or FEAT_LS64_ACCDATA is present. */
538#define ARMV8_ESR_EL2_ISS2 ( RT_BIT_64(32) | RT_BIT_64(33) | RT_BIT_64(34) \
539 | RT_BIT_64(35) | RT_BIT_64(36))
540#define ARMV8_ESR_EL2_ISS2_GET(a_Esr) (((a_Esr) & ARMV8_ESR_EL2_ISS2) >> 32)
541/** @} */
542
543
544/** @name ESR_EL2 Exception Classes (EC)
545 * @{ */
546/** Unknown exception reason. */
547#define ARMV8_ESR_EL2_EC_UNKNOWN UINT32_C(0)
548/** Trapped WF* instruction. */
549#define ARMV8_ESR_EL2_EC_TRAPPED_WFX UINT32_C(1)
550/** AArch32 - Trapped MCR or MRC access (coproc == 0b1111) not reported through ARMV8_ESR_EL2_EC_UNKNOWN. */
551#define ARMV8_ESR_EL2_EC_AARCH32_TRAPPED_MCR_MRC_COPROC_15 UINT32_C(3)
552/** AArch32 - Trapped MCRR or MRRC access (coproc == 0b1111) not reported through ARMV8_ESR_EL2_EC_UNKNOWN. */
553#define ARMV8_ESR_EL2_EC_AARCH32_TRAPPED_MCRR_MRRC_COPROC15 UINT32_C(4)
554/** AArch32 - Trapped MCR or MRC access (coproc == 0b1110). */
555#define ARMV8_ESR_EL2_EC_AARCH32_TRAPPED_MCR_MRC_COPROC_14 UINT32_C(5)
556/** AArch32 - Trapped LDC or STC access. */
557#define ARMV8_ESR_EL2_EC_AARCH32_TRAPPED_LDC_STC UINT32_C(6)
558/** AArch32 - Trapped access to SME, SVE or Advanced SIMD or floating point fnunctionality. */
559#define ARMV8_ESR_EL2_EC_AARCH32_TRAPPED_SME_SVE_NEON UINT32_C(7)
560/** AArch32 - Trapped VMRS access not reported using ARMV8_ESR_EL2_EC_AARCH32_TRAPPED_SME_SVE_NEON. */
561#define ARMV8_ESR_EL2_EC_AARCH32_TRAPPED_VMRS UINT32_C(8)
562/** AArch32 - Trapped pointer authentication instruction. */
563#define ARMV8_ESR_EL2_EC_AARCH32_TRAPPED_PA_INSN UINT32_C(9)
564/** FEAT_LS64 - Exception from LD64B or ST64B instruction. */
565#define ARMV8_ESR_EL2_EC_LS64_EXCEPTION UINT32_C(10)
566/** AArch32 - Trapped MRRC access (coproc == 0b1110). */
567#define ARMV8_ESR_EL2_EC_AARCH32_TRAPPED_MRRC_COPROC14 UINT32_C(12)
568/** FEAT_BTI - Branch Target Exception. */
569#define ARMV8_ESR_EL2_EC_BTI_BRANCH_TARGET_EXCEPTION UINT32_C(13)
570/** Illegal Execution State. */
571#define ARMV8_ESR_EL2_ILLEGAL_EXECUTION_STATE UINT32_C(14)
572/** AArch32 - SVC instruction execution. */
573#define ARMV8_ESR_EL2_EC_AARCH32_SVC_INSN UINT32_C(17)
574/** AArch32 - HVC instruction execution. */
575#define ARMV8_ESR_EL2_EC_AARCH32_HVC_INSN UINT32_C(18)
576/** AArch32 - SMC instruction execution. */
577#define ARMV8_ESR_EL2_EC_AARCH32_SMC_INSN UINT32_C(19)
578/** AArch64 - SVC instruction execution. */
579#define ARMV8_ESR_EL2_EC_AARCH64_SVC_INSN UINT32_C(21)
580/** AArch64 - HVC instruction execution. */
581#define ARMV8_ESR_EL2_EC_AARCH64_HVC_INSN UINT32_C(22)
582/** AArch64 - SMC instruction execution. */
583#define ARMV8_ESR_EL2_EC_AARCH64_SMC_INSN UINT32_C(23)
584/** AArch64 - Trapped MSR, MRS or System instruction execution in AArch64 state. */
585#define ARMV8_ESR_EL2_EC_AARCH64_TRAPPED_SYS_INSN UINT32_C(24)
586/** FEAT_SVE - Access to SVE vunctionality not reported using ARMV8_ESR_EL2_EC_UNKNOWN. */
587#define ARMV8_ESR_EL2_EC_SVE_TRAPPED UINT32_C(25)
588/** FEAT_PAuth and FEAT_NV - Trapped ERET, ERETAA or ERTAB instruction. */
589#define ARMV8_ESR_EL2_EC_PAUTH_NV_TRAPPED_ERET_ERETAA_ERETAB UINT32_C(26)
590/** FEAT_TME - Exception from TSTART instruction. */
591#define ARMV8_ESR_EL2_EC_TME_TSTART_INSN_EXCEPTION UINT32_C(27)
592/** FEAT_FPAC - Exception from a Pointer Authentication instruction failure. */
593#define ARMV8_ESR_EL2_EC_FPAC_PA_INSN_FAILURE_EXCEPTION UINT32_C(28)
594/** FEAT_SME - Access to SME functionality trapped. */
595#define ARMV8_ESR_EL2_EC_SME_TRAPPED_SME_ACCESS UINT32_C(29)
596/** FEAT_RME - Exception from Granule Protection Check. */
597#define ARMV8_ESR_EL2_EC_RME_GRANULE_PROT_CHECK_EXCEPTION UINT32_C(30)
598/** Instruction Abort from a lower Exception level. */
599#define ARMV8_ESR_EL2_INSN_ABORT_FROM_LOWER_EL UINT32_C(32)
600/** Instruction Abort from the same Exception level. */
601#define ARMV8_ESR_EL2_INSN_ABORT_FROM_EL2 UINT32_C(33)
602/** PC alignment fault exception. */
603#define ARMV8_ESR_EL2_PC_ALIGNMENT_EXCEPTION UINT32_C(34)
604/** Data Abort from a lower Exception level. */
605#define ARMV8_ESR_EL2_DATA_ABORT_FROM_LOWER_EL UINT32_C(36)
606/** Data Abort from the same Exception level (or access associated with VNCR_EL2). */
607#define ARMV8_ESR_EL2_DATA_ABORT_FROM_EL2 UINT32_C(37)
608/** SP alignment fault exception. */
609#define ARMV8_ESR_EL2_SP_ALIGNMENT_EXCEPTION UINT32_C(38)
610/** FEAT_MOPS - Memory Operation Exception. */
611#define ARMV8_ESR_EL2_EC_MOPS_EXCEPTION UINT32_C(39)
612/** AArch32 - Trapped floating point exception. */
613#define ARMV8_ESR_EL2_EC_AARCH32_TRAPPED_FP_EXCEPTION UINT32_C(40)
614/** AArch64 - Trapped floating point exception. */
615#define ARMV8_ESR_EL2_EC_AARCH64_TRAPPED_FP_EXCEPTION UINT32_C(44)
616/** SError interrupt. */
617#define ARMV8_ESR_EL2_SERROR_INTERRUPT UINT32_C(47)
618/** Breakpoint Exception from a lower Exception level. */
619#define ARMV8_ESR_EL2_BKPT_EXCEPTION_FROM_LOWER_EL UINT32_C(48)
620/** Breakpoint Exception from the same Exception level. */
621#define ARMV8_ESR_EL2_BKPT_EXCEPTION_FROM_EL2 UINT32_C(49)
622/** Software Step Exception from a lower Exception level. */
623#define ARMV8_ESR_EL2_SS_EXCEPTION_FROM_LOWER_EL UINT32_C(50)
624/** Software Step Exception from the same Exception level. */
625#define ARMV8_ESR_EL2_SS_EXCEPTION_FROM_EL2 UINT32_C(51)
626/** Watchpoint Exception from a lower Exception level. */
627#define ARMV8_ESR_EL2_WATCHPOINT_EXCEPTION_FROM_LOWER_EL UINT32_C(52)
628/** Watchpoint Exception from the same Exception level. */
629#define ARMV8_ESR_EL2_WATCHPOINT_EXCEPTION_FROM_EL2 UINT32_C(53)
630/** AArch32 - BKPT instruction execution. */
631#define ARMV8_ESR_EL2_EC_AARCH32_BKPT_INSN UINT32_C(56)
632/** AArch32 - Vector Catch exception. */
633#define ARMV8_ESR_EL2_EC_AARCH32_VEC_CATCH_EXCEPTION UINT32_C(58)
634/** AArch64 - BRK instruction execution. */
635#define ARMV8_ESR_EL2_EC_AARCH64_BRK_INSN UINT32_C(60)
636/** @} */
637
638
639/** @name ISS encoding for Data Abort exceptions.
640 * @{ */
641/** Bit 0 - 5 - DFSC - Data Fault Status Code. */
642#define ARMV8_EC_ISS_DATA_ABRT_DFSC ( RT_BIT_32(0) | RT_BIT_32(1) | RT_BIT_32(2) \
643 | RT_BIT_32(3) | RT_BIT_32(4) | RT_BIT_32(5))
644#define ARMV8_EC_ISS_DATA_ABRT_DFSC_GET(a_Iss) ((a_Iss) & ARMV8_EC_ISS_DATA_ABRT_DFSC)
645/** Bit 6 - WnR - Write not Read. */
646#define ARMV8_EC_ISS_DATA_ABRT_WNR RT_BIT_32(6)
647#define ARMV8_EC_ISS_DATA_ABRT_WNR_BIT 6
648/** Bit 7 - S1PTW - Stage 2 translation fault for an access made for a stage 1 translation table walk. */
649#define ARMV8_EC_ISS_DATA_ABRT_S1PTW RT_BIT_32(7)
650#define ARMV8_EC_ISS_DATA_ABRT_S1PTW_BIT 7
651/** Bit 8 - CM - Cache maintenance instruction. */
652#define ARMV8_EC_ISS_DATA_ABRT_CM RT_BIT_32(8)
653#define ARMV8_EC_ISS_DATA_ABRT_CM_BIT 8
654/** Bit 9 - EA - External abort type. */
655#define ARMV8_EC_ISS_DATA_ABRT_EA RT_BIT_32(9)
656#define ARMV8_EC_ISS_DATA_ABRT_EA_BIT 9
657/** Bit 10 - FnV - FAR not Valid. */
658#define ARMV8_EC_ISS_DATA_ABRT_FNV RT_BIT_32(10)
659#define ARMV8_EC_ISS_DATA_ABRT_FNV_BIT 10
660/** Bit 11 - 12 - LST - Load/Store Type. */
661#define ARMV8_EC_ISS_DATA_ABRT_LST (RT_BIT_32(11) | RT_BIT_32(12))
662#define ARMV8_EC_ISS_DATA_ABRT_LST_GET(a_Iss) (((a_Iss) & ARMV8_EC_ISS_DATA_ABRT_LST) >> 11)
663/** Bit 13 - VNCR - Fault came from use of VNCR_EL2 register by EL1 code. */
664#define ARMV8_EC_ISS_DATA_ABRT_VNCR RT_BIT_32(13)
665#define ARMV8_EC_ISS_DATA_ABRT_VNCR_BIT 13
666/** Bit 14 - AR - Acquire/Release semantics. */
667#define ARMV8_EC_ISS_DATA_ABRT_AR RT_BIT_32(14)
668#define ARMV8_EC_ISS_DATA_ABRT_AR_BIT 14
669/** Bit 15 - SF - Sixty Four bit general-purpose register transfer (only when ISV is 1). */
670#define ARMV8_EC_ISS_DATA_ABRT_SF RT_BIT_32(15)
671#define ARMV8_EC_ISS_DATA_ABRT_SF_BIT 15
672/** Bit 16 - 20 - SRT - Syndrome Register Transfer. */
673#define ARMV8_EC_ISS_DATA_ABRT_SRT ( RT_BIT_32(16) | RT_BIT_32(17) | RT_BIT_32(18) \
674 | RT_BIT_32(19) | RT_BIT_32(20))
675#define ARMV8_EC_ISS_DATA_ABRT_SRT_GET(a_Iss) (((a_Iss) & ARMV8_EC_ISS_DATA_ABRT_SRT) >> 16)
676/** Bit 21 - SSE - Syndrome Sign Extend. */
677#define ARMV8_EC_ISS_DATA_ABRT_SSE RT_BIT_32(21)
678#define ARMV8_EC_ISS_DATA_ABRT_SSE_BIT 21
679/** Bit 22 - 23 - SAS - Syndrome Access Size. */
680#define ARMV8_EC_ISS_DATA_ABRT_SAS (RT_BIT_32(22) | RT_BIT_32(23))
681#define ARMV8_EC_ISS_DATA_ABRT_SAS_GET(a_Iss) (((a_Iss) & ARMV8_EC_ISS_DATA_ABRT_SAS) >> 22)
682/** Bit 24 - ISV - Instruction Syndrome Valid. */
683#define ARMV8_EC_ISS_DATA_ABRT_ISV RT_BIT_32(24)
684#define ARMV8_EC_ISS_DATA_ABRT_ISV_BIT 24
685
686
687/** @name Data Fault Status Code (DFSC).
688 * @{ */
689/** Address size fault, level 0 of translation or translation table base register. */
690#define ARMV8_EC_ISS_DATA_ABRT_DFSC_ADDR_SIZE_FAULT_LVL0 0
691/** Address size fault, level 1. */
692#define ARMV8_EC_ISS_DATA_ABRT_DFSC_ADDR_SIZE_FAULT_LVL1 1
693/** Address size fault, level 2. */
694#define ARMV8_EC_ISS_DATA_ABRT_DFSC_ADDR_SIZE_FAULT_LVL2 2
695/** Address size fault, level 3. */
696#define ARMV8_EC_ISS_DATA_ABRT_DFSC_ADDR_SIZE_FAULT_LVL3 3
697/** Translation fault, level 0. */
698#define ARMV8_EC_ISS_DATA_ABRT_DFSC_TRANSLATION_FAULT_LVL0 4
699/** Translation fault, level 1. */
700#define ARMV8_EC_ISS_DATA_ABRT_DFSC_TRANSLATION_FAULT_LVL1 5
701/** Translation fault, level 2. */
702#define ARMV8_EC_ISS_DATA_ABRT_DFSC_TRANSLATION_FAULT_LVL2 6
703/** Translation fault, level 3. */
704#define ARMV8_EC_ISS_DATA_ABRT_DFSC_TRANSLATION_FAULT_LVL3 7
705/** FEAT_LPA2 - Access flag fault, level 0. */
706#define ARMV8_EC_ISS_DATA_ABRT_DFSC_ACCESS_FLAG_FAULT_LVL0 8
707/** Access flag fault, level 1. */
708#define ARMV8_EC_ISS_DATA_ABRT_DFSC_ACCESS_FLAG_FAULT_LVL1 9
709/** Access flag fault, level 2. */
710#define ARMV8_EC_ISS_DATA_ABRT_DFSC_ACCESS_FLAG_FAULT_LVL2 10
711/** Access flag fault, level 3. */
712#define ARMV8_EC_ISS_DATA_ABRT_DFSC_ACCESS_FLAG_FAULT_LVL3 11
713/** FEAT_LPA2 - Permission fault, level 0. */
714#define ARMV8_EC_ISS_DATA_ABRT_DFSC_PERMISSION_FAULT_LVL0 12
715/** Permission fault, level 1. */
716#define ARMV8_EC_ISS_DATA_ABRT_DFSC_PERMISSION_FAULT_LVL1 13
717/** Permission fault, level 2. */
718#define ARMV8_EC_ISS_DATA_ABRT_DFSC_PERMISSION_FAULT_LVL2 14
719/** Permission fault, level 3. */
720#define ARMV8_EC_ISS_DATA_ABRT_DFSC_PERMISSION_FAULT_LVL3 15
721/** Synchronous External abort, not a translation table walk or hardware update of translation table. */
722#define ARMV8_EC_ISS_DATA_ABRT_DFSC_SYNC_EXTERNAL 16
723/** FEAT_MTE2 - Synchronous Tag Check Fault. */
724#define ARMV8_EC_ISS_DATA_ABRT_DFSC_MTE2_SYNC_TAG_CHK_FAULT 17
725/** @todo Do the rest (lazy developer). */
726/** @} */
727
728
729/** @name SAS encoding.
730 * @{ */
731/** Byte access. */
732#define ARMV8_EC_ISS_DATA_ABRT_SAS_BYTE 0
733/** Halfword access (uint16_t). */
734#define ARMV8_EC_ISS_DATA_ABRT_SAS_HALFWORD 1
735/** Word access (uint32_t). */
736#define ARMV8_EC_ISS_DATA_ABRT_SAS_WORD 2
737/** Doubleword access (uint64_t). */
738#define ARMV8_EC_ISS_DATA_ABRT_SAS_DWORD 3
739/** @} */
740
741
742/** @name ISS encoding for trapped MSR, MRS or System instruction exceptions.
743 * @{ */
744/** Bit 0 - Direction flag. */
745#define ARMV8_EC_ISS_AARCH64_TRAPPED_SYS_INSN_DIRECTION RT_BIT_32(0)
746#define ARMV8_EC_ISS_AARCH64_TRAPPED_SYS_INSN_DIRECTION_IS_READ(a_Iss) RT_BOOL((a_Iss) & ARMV8_EC_ISS_AARCH64_TRAPPED_SYS_INSN_DIRECTION)
747/** Bit 1 - 4 - CRm value from the instruction. */
748#define ARMV8_EC_ISS_AARCH64_TRAPPED_SYS_INSN_CRM ( RT_BIT_32(1) | RT_BIT_32(2) | RT_BIT_32(3) \
749 | RT_BIT_32(4))
750#define ARMV8_EC_ISS_AARCH64_TRAPPED_SYS_INSN_CRM_GET(a_Iss) (((a_Iss) & ARMV8_EC_ISS_AARCH64_TRAPPED_SYS_INSN_CRM) >> 1)
751/** Bit 5 - 9 - Rt value from the instruction. */
752#define ARMV8_EC_ISS_AARCH64_TRAPPED_SYS_INSN_RT ( RT_BIT_32(5) | RT_BIT_32(6) | RT_BIT_32(7) \
753 | RT_BIT_32(8) | RT_BIT_32(9))
754#define ARMV8_EC_ISS_AARCH64_TRAPPED_SYS_INSN_RT_GET(a_Iss) (((a_Iss) & ARMV8_EC_ISS_AARCH64_TRAPPED_SYS_INSN_RT) >> 5)
755/** Bit 10 - 13 - CRn value from the instruction. */
756#define ARMV8_EC_ISS_AARCH64_TRAPPED_SYS_INSN_CRN ( RT_BIT_32(10) | RT_BIT_32(11) | RT_BIT_32(12) \
757 | RT_BIT_32(13))
758#define ARMV8_EC_ISS_AARCH64_TRAPPED_SYS_INSN_CRN_GET(a_Iss) (((a_Iss) & ARMV8_EC_ISS_AARCH64_TRAPPED_SYS_INSN_CRN) >> 10)
759/** Bit 14 - 16 - Op2 value from the instruction. */
760#define ARMV8_EC_ISS_AARCH64_TRAPPED_SYS_INSN_OP1 (RT_BIT_32(14) | RT_BIT_32(15) | RT_BIT_32(16))
761#define ARMV8_EC_ISS_AARCH64_TRAPPED_SYS_INSN_OP1_GET(a_Iss) (((a_Iss) & ARMV8_EC_ISS_AARCH64_TRAPPED_SYS_INSN_OP1) >> 14)
762/** Bit 17 - 19 - Op2 value from the instruction. */
763#define ARMV8_EC_ISS_AARCH64_TRAPPED_SYS_INSN_OP2 (RT_BIT_32(17) | RT_BIT_32(18) | RT_BIT_32(19))
764#define ARMV8_EC_ISS_AARCH64_TRAPPED_SYS_INSN_OP2_GET(a_Iss) (((a_Iss) & ARMV8_EC_ISS_AARCH64_TRAPPED_SYS_INSN_OP2) >> 17)
765/** Bit 20 - 21 - Op0 value from the instruction. */
766#define ARMV8_EC_ISS_AARCH64_TRAPPED_SYS_INSN_OP0 (RT_BIT_32(20) | RT_BIT_32(21))
767#define ARMV8_EC_ISS_AARCH64_TRAPPED_SYS_INSN_OP0_GET(a_Iss) (((a_Iss) & ARMV8_EC_ISS_AARCH64_TRAPPED_SYS_INSN_OP0) >> 20)
768/** Bit 22 - 24 - Reserved. */
769#define ARMV8_EC_ISS_AARCH64_TRAPPED_SYS_INSN_RSVD (RT_BIT_32(22) | RT_BIT_32(23) | RT_BIT_32(24))
770/** @} */
771
772
773/** @name ISS encoding for trapped HVC instruction exceptions.
774 * @{ */
775/** Bit 0 - 15 - imm16 value of the instruction. */
776#define ARMV8_EC_ISS_AARCH64_TRAPPED_HVC_INSN_IMM (UINT16_C(0xffff))
777#define ARMV8_EC_ISS_AARCH64_TRAPPED_HVC_INSN_IMM_GET(a_Iss) ((a_Iss) & ARMV8_EC_ISS_AARCH64_TRAPPED_HVC_INSN_IMM)
778/** @} */
779
780
781/** @name TCR_EL1 - Translation Control Register (EL1)
782 * @{
783 */
784/** Bit 0 - 5 - Size offset of the memory region addressed by TTBR0_EL1 (2^(64-T0SZ)). */
785#define ARMV8_TCR_EL1_AARCH64_T0SZ ( RT_BIT_64(0) | RT_BIT_64(1) | RT_BIT_64(2) \
786 | RT_BIT_64(3) | RT_BIT_64(4) | RT_BIT_64(5))
787#define ARMV8_TCR_EL1_AARCH64_T0SZ_GET(a_Tcr) ((a_Tcr) & ARMV8_TCR_EL1_AARCH64_T1SZ)
788/** Bit 7 - Translation table walk disable for translations using TTBR0_EL1. */
789#define ARMV8_TCR_EL1_AARCH64_EPD0 RT_BIT_64(7)
790#define ARMV8_TCR_EL1_AARCH64_EPD0_BIT 7
791/** Bit 8 - 9 - Inner cacheability attribute for memory associated with translation table walks using TTBR0_EL1. */
792#define ARMV8_TCR_EL1_AARCH64_IRGN0 (RT_BIT_64(8) | RT_BIT_64(9))
793#define ARMV8_TCR_EL1_AARCH64_IRGN0_GET(a_Tcr) (((a_Tcr) & ARMV8_TCR_EL1_AARCH64_IRGN0) >> 8)
794/** Non cacheable. */
795# define ARMV8_TCR_EL1_AARCH64_IRGN0_NON_CACHEABLE 0
796/** Write-Back, Read-Allocate, Write-Allocate Cacheable. */
797# define ARMV8_TCR_EL1_AARCH64_IRGN0_WB_RA_WA 1
798/** Write-Through, Read-Allocate, No Write-Allocate Cacheable. */
799# define ARMV8_TCR_EL1_AARCH64_IRGN0_WT_RA_NWA 2
800/** Write-Back, Read-Allocate, No Write-Allocate Cacheable. */
801# define ARMV8_TCR_EL1_AARCH64_IRGN0_WB_RA_NWA 3
802/** Bit 27 - 26 - Outer cacheability attribute for memory associated with translation table walks using TTBR0_EL1. */
803#define ARMV8_TCR_EL1_AARCH64_ORGN0 (RT_BIT_64(10) | RT_BIT_64(11))
804#define ARMV8_TCR_EL1_AARCH64_ORGN0_GET(a_Tcr) (((a_Tcr) & ARMV8_TCR_EL1_AARCH64_ORGN0) >> 10)
805/** Non cacheable. */
806# define ARMV8_TCR_EL1_AARCH64_ORGN0_NON_CACHEABLE 0
807/** Write-Back, Read-Allocate, Write-Allocate Cacheable. */
808# define ARMV8_TCR_EL1_AARCH64_ORGN0_WB_RA_WA 1
809/** Write-Through, Read-Allocate, No Write-Allocate Cacheable. */
810# define ARMV8_TCR_EL1_AARCH64_ORGN0_WT_RA_NWA 2
811/** Write-Back, Read-Allocate, No Write-Allocate Cacheable. */
812# define ARMV8_TCR_EL1_AARCH64_ORGN0_WB_RA_NWA 3
813/** Bit 12 - 13 - Shareability attribute memory associated with translation table walks using TTBR0_EL1. */
814#define ARMV8_TCR_EL1_AARCH64_SH0 (RT_BIT_64(12) | RT_BIT_64(13))
815#define ARMV8_TCR_EL1_AARCH64_SH0_GET(a_Tcr) (((a_Tcr) & ARMV8_TCR_EL1_AARCH64_SH0) >> 12)
816/** Non shareable. */
817# define ARMV8_TCR_EL1_AARCH64_SH0_NON_SHAREABLE 0
818/** Invalid value. */
819# define ARMV8_TCR_EL1_AARCH64_SH0_INVALID 1
820/** Outer Shareable. */
821# define ARMV8_TCR_EL1_AARCH64_SH0_OUTER_SHAREABLE 2
822/** Inner Shareable. */
823# define ARMV8_TCR_EL1_AARCH64_SH0_INNER_SHAREABLE 3
824/** Bit 14 - 15 - Translation Granule Size for TTBR0_EL1. */
825#define ARMV8_TCR_EL1_AARCH64_TG0 (RT_BIT_64(14) | RT_BIT_64(15))
826#define ARMV8_TCR_EL1_AARCH64_TG0_GET(a_Tcr) (((a_Tcr) & ARMV8_TCR_EL1_AARCH64_TG0) >> 14)
827/** Invalid granule size. */
828# define ARMV8_TCR_EL1_AARCH64_TG0_INVALID 0
829/** 16KiB granule size. */
830# define ARMV8_TCR_EL1_AARCH64_TG0_16KB 1
831/** 4KiB granule size. */
832# define ARMV8_TCR_EL1_AARCH64_TG0_4KB 2
833/** 64KiB granule size. */
834# define ARMV8_TCR_EL1_AARCH64_TG0_64KB 3
835/** Bit 16 - 21 - Size offset of the memory region addressed by TTBR1_EL1 (2^(64-T1SZ)). */
836#define ARMV8_TCR_EL1_AARCH64_T1SZ ( RT_BIT_64(16) | RT_BIT_64(17) | RT_BIT_64(18) \
837 | RT_BIT_64(19) | RT_BIT_64(20) | RT_BIT_64(21))
838#define ARMV8_TCR_EL1_AARCH64_T1SZ_GET(a_Tcr) (((a_Tcr) & ARMV8_TCR_EL1_AARCH64_T1SZ) >> 16)
839/** Bit 22 - Selects whether TTBR0_EL1 (0) or TTBR1_EL1 (1) defines the ASID. */
840#define ARMV8_TCR_EL1_AARCH64_A1 RT_BIT_64(22)
841#define ARMV8_TCR_EL1_AARCH64_A1_BIT 22
842/** Bit 23 - Translation table walk disable for translations using TTBR1_EL1. */
843#define ARMV8_TCR_EL1_AARCH64_EPD1 RT_BIT_64(23)
844#define ARMV8_TCR_EL1_AARCH64_EPD1_BIT 23
845/** Bit 24 - 25 - Inner cacheability attribute for memory associated with translation table walks using TTBR1_EL1. */
846#define ARMV8_TCR_EL1_AARCH64_IRGN1 (RT_BIT_64(24) | RT_BIT_64(25))
847#define ARMV8_TCR_EL1_AARCH64_IRGN1_GET(a_Tcr) (((a_Tcr) & ARMV8_TCR_EL1_AARCH64_IRGN1) >> 26)
848/** Non cacheable. */
849# define ARMV8_TCR_EL1_AARCH64_IRGN1_NON_CACHEABLE 0
850/** Write-Back, Read-Allocate, Write-Allocate Cacheable. */
851# define ARMV8_TCR_EL1_AARCH64_IRGN1_WB_RA_WA 1
852/** Write-Through, Read-Allocate, No Write-Allocate Cacheable. */
853# define ARMV8_TCR_EL1_AARCH64_IRGN1_WT_RA_NWA 2
854/** Write-Back, Read-Allocate, No Write-Allocate Cacheable. */
855# define ARMV8_TCR_EL1_AARCH64_IRGN1_WB_RA_NWA 3
856/** Bit 27 - 26 - Outer cacheability attribute for memory associated with translation table walks using TTBR1_EL1. */
857#define ARMV8_TCR_EL1_AARCH64_ORGN1 (RT_BIT_64(26) | RT_BIT_64(27))
858#define ARMV8_TCR_EL1_AARCH64_ORGN1_GET(a_Tcr) (((a_Tcr) & ARMV8_TCR_EL1_AARCH64_ORGN1) >> 26)
859/** Non cacheable. */
860# define ARMV8_TCR_EL1_AARCH64_ORGN1_NON_CACHEABLE 0
861/** Write-Back, Read-Allocate, Write-Allocate Cacheable. */
862# define ARMV8_TCR_EL1_AARCH64_ORGN1_WB_RA_WA 1
863/** Write-Through, Read-Allocate, No Write-Allocate Cacheable. */
864# define ARMV8_TCR_EL1_AARCH64_ORGN1_WT_RA_NWA 2
865/** Write-Back, Read-Allocate, No Write-Allocate Cacheable. */
866# define ARMV8_TCR_EL1_AARCH64_ORGN1_WB_RA_NWA 3
867/** Bit 28 - 29 - Shareability attribute memory associated with translation table walks using TTBR1_EL1. */
868#define ARMV8_TCR_EL1_AARCH64_SH1 (RT_BIT_64(28) | RT_BIT_64(29))
869#define ARMV8_TCR_EL1_AARCH64_SH1_GET(a_Tcr) (((a_Tcr) & ARMV8_TCR_EL1_AARCH64_SH1) >> 28)
870/** Non shareable. */
871# define ARMV8_TCR_EL1_AARCH64_SH1_NON_SHAREABLE 0
872/** Invalid value. */
873# define ARMV8_TCR_EL1_AARCH64_SH1_INVALID 1
874/** Outer Shareable. */
875# define ARMV8_TCR_EL1_AARCH64_SH1_OUTER_SHAREABLE 2
876/** Inner Shareable. */
877# define ARMV8_TCR_EL1_AARCH64_SH1_INNER_SHAREABLE 3
878/** Bit 30 - 31 - Translation Granule Size for TTBR1_EL1. */
879#define ARMV8_TCR_EL1_AARCH64_TG1 (RT_BIT_64(30) | RT_BIT_64(31))
880#define ARMV8_TCR_EL1_AARCH64_TG1_GET(a_Tcr) (((a_Tcr) & ARMV8_TCR_EL1_AARCH64_TG1) >> 30)
881/** Invalid granule size. */
882# define ARMV8_TCR_EL1_AARCH64_TG1_INVALID 0
883/** 16KiB granule size. */
884# define ARMV8_TCR_EL1_AARCH64_TG1_16KB 1
885/** 4KiB granule size. */
886# define ARMV8_TCR_EL1_AARCH64_TG1_4KB 2
887/** 64KiB granule size. */
888# define ARMV8_TCR_EL1_AARCH64_TG1_64KB 3
889/** Bit 32 - 34 - Intermediate Physical Address Size. */
890#define ARMV8_TCR_EL1_AARCH64_IPS (RT_BIT_64(32) | RT_BIT_64(33) | RT_BIT_64(34))
891#define ARMV8_TCR_EL1_AARCH64_IPS_GET(a_Tcr) (((a_Tcr) & ARMV8_TCR_EL1_AARCH64_IPS) >> 32)
892/** IPA - 32 bits, 4GiB. */
893# define ARMV8_TCR_EL1_AARCH64_IPS_32BITS 0
894/** IPA - 36 bits, 64GiB. */
895# define ARMV8_TCR_EL1_AARCH64_IPS_36BITS 1
896/** IPA - 40 bits, 1TiB. */
897# define ARMV8_TCR_EL1_AARCH64_IPS_40BITS 2
898/** IPA - 42 bits, 4TiB. */
899# define ARMV8_TCR_EL1_AARCH64_IPS_42BITS 3
900/** IPA - 44 bits, 16TiB. */
901# define ARMV8_TCR_EL1_AARCH64_IPS_44BITS 4
902/** IPA - 48 bits, 256TiB. */
903# define ARMV8_TCR_EL1_AARCH64_IPS_48BITS 5
904/** IPA - 52 bits, 4PiB. */
905# define ARMV8_TCR_EL1_AARCH64_IPS_52BITS 6
906/** Bit 36 - ASID Size (0 - 8 bit, 1 - 16 bit). */
907#define ARMV8_TCR_EL1_AARCH64_AS RT_BIT_64(36)
908#define ARMV8_TCR_EL1_AARCH64_AS_BIT 36
909/** Bit 37 - Top Byte Ignore for translations from TTBR0_EL1. */
910#define ARMV8_TCR_EL1_AARCH64_TBI0 RT_BIT_64(37)
911#define ARMV8_TCR_EL1_AARCH64_TBI0_BIT 37
912/** Bit 38 - Top Byte Ignore for translations from TTBR1_EL1. */
913#define ARMV8_TCR_EL1_AARCH64_TBI1 RT_BIT_64(38)
914#define ARMV8_TCR_EL1_AARCH64_TBI1_BIT 38
915/** Bit 39 - Hardware Access flag update in stage 1 translations from EL0 and EL1. */
916#define ARMV8_TCR_EL1_AARCH64_HA RT_BIT_64(39)
917#define ARMV8_TCR_EL1_AARCH64_HA_BIT 39
918/** Bit 40 - Hardware management of dirty state in stage 1 translations from EL0 and EL1. */
919#define ARMV8_TCR_EL1_AARCH64_HD RT_BIT_64(40)
920#define ARMV8_TCR_EL1_AARCH64_HD_BIT 40
921/** Bit 41 - Hierarchical Permission Disables for TTBR0_EL1. */
922#define ARMV8_TCR_EL1_AARCH64_HPD0 RT_BIT_64(41)
923#define ARMV8_TCR_EL1_AARCH64_HPD0_BIT 41
924/** Bit 42 - Hierarchical Permission Disables for TTBR1_EL1. */
925#define ARMV8_TCR_EL1_AARCH64_HPD1 RT_BIT_64(42)
926#define ARMV8_TCR_EL1_AARCH64_HPD1_BIT 42
927/** Bit 43 - Bit[59] Hardware Use for translations using TTBR0_EL1. */
928#define ARMV8_TCR_EL1_AARCH64_HWU059 RT_BIT_64(43)
929#define ARMV8_TCR_EL1_AARCH64_HWU059_BIT 43
930/** Bit 44 - Bit[60] Hardware Use for translations using TTBR0_EL1. */
931#define ARMV8_TCR_EL1_AARCH64_HWU060 RT_BIT_64(44)
932#define ARMV8_TCR_EL1_AARCH64_HWU060_BIT 44
933/** Bit 46 - Bit[61] Hardware Use for translations using TTBR0_EL1. */
934#define ARMV8_TCR_EL1_AARCH64_HWU061 RT_BIT_64(45)
935#define ARMV8_TCR_EL1_AARCH64_HWU061_BIT 45
936/** Bit 46 - Bit[62] Hardware Use for translations using TTBR0_EL1. */
937#define ARMV8_TCR_EL1_AARCH64_HWU062 RT_BIT_64(46)
938#define ARMV8_TCR_EL1_AARCH64_HWU062_BIT 46
939/** Bit 47 - Bit[59] Hardware Use for translations using TTBR1_EL1. */
940#define ARMV8_TCR_EL1_AARCH64_HWU159 RT_BIT_64(47)
941#define ARMV8_TCR_EL1_AARCH64_HWU159_BIT 47
942/** Bit 48 - Bit[60] Hardware Use for translations using TTBR1_EL1. */
943#define ARMV8_TCR_EL1_AARCH64_HWU160 RT_BIT_64(48)
944#define ARMV8_TCR_EL1_AARCH64_HWU160_BIT 48
945/** Bit 49 - Bit[61] Hardware Use for translations using TTBR1_EL1. */
946#define ARMV8_TCR_EL1_AARCH64_HWU161 RT_BIT_64(49)
947#define ARMV8_TCR_EL1_AARCH64_HWU161_BIT 49
948/** Bit 50 - Bit[62] Hardware Use for translations using TTBR1_EL1. */
949#define ARMV8_TCR_EL1_AARCH64_HWU162 RT_BIT_64(50)
950#define ARMV8_TCR_EL1_AARCH64_HWU162_BIT 50
951/** Bit 51 - Control the use of the top byte of instruction addresses for address matching for translations using TTBR0_EL1. */
952#define ARMV8_TCR_EL1_AARCH64_TBID0 RT_BIT_64(51)
953#define ARMV8_TCR_EL1_AARCH64_TBID0_BIT 51
954/** Bit 52 - Control the use of the top byte of instruction addresses for address matching for translations using TTBR1_EL1. */
955#define ARMV8_TCR_EL1_AARCH64_TBID1 RT_BIT_64(52)
956#define ARMV8_TCR_EL1_AARCH64_TBID1_BIT 52
957/** Bit 53 - Non fault translation table walk disable for stage 1 translations using TTBR0_EL1. */
958#define ARMV8_TCR_EL1_AARCH64_NFD0 RT_BIT_64(53)
959#define ARMV8_TCR_EL1_AARCH64_NFD0_BIT 53
960/** Bit 54 - Non fault translation table walk disable for stage 1 translations using TTBR1_EL1. */
961#define ARMV8_TCR_EL1_AARCH64_NFD1 RT_BIT_64(54)
962#define ARMV8_TCR_EL1_AARCH64_NFD1_BIT 54
963/** Bit 55 - Faulting Control for Unprivileged access to any address translated by TTBR0_EL1. */
964#define ARMV8_TCR_EL1_AARCH64_E0PD0 RT_BIT_64(55)
965#define ARMV8_TCR_EL1_AARCH64_E0PD0_BIT 55
966/** Bit 56 - Faulting Control for Unprivileged access to any address translated by TTBR1_EL1. */
967#define ARMV8_TCR_EL1_AARCH64_E0PD1 RT_BIT_64(56)
968#define ARMV8_TCR_EL1_AARCH64_E0PD1_BIT 56
969/** Bit 57 - TCMA0 */
970#define ARMV8_TCR_EL1_AARCH64_TCMA0 RT_BIT_64(57)
971#define ARMV8_TCR_EL1_AARCH64_TCMA0_BIT 57
972/** Bit 58 - TCMA1 */
973#define ARMV8_TCR_EL1_AARCH64_TCMA1 RT_BIT_64(58)
974#define ARMV8_TCR_EL1_AARCH64_TCMA1_BIT 58
975/** Bit 59 - Data Sharing(?). */
976#define ARMV8_TCR_EL1_AARCH64_DS RT_BIT_64(59)
977#define ARMV8_TCR_EL1_AARCH64_DS_BIT 59
978/** @} */
979
980
981/** @name TTBR<0,1>_EL1 - Translation Table Base Register <0,1> (EL1)
982 * @{
983 */
984/** Bit 0 - Common not Private (FEAT_TTCNP). */
985#define ARMV8_TTBR_EL1_AARCH64_CNP RT_BIT_64(0)
986#define ARMV8_TTBR_EL1_AARCH64_CNP_BIT 0
987/** Bit 1 - 47 - Translation table base address. */
988#define ARMV8_TTBR_EL1_AARCH64_BADDR UINT64_C(0x0000fffffffffffe)
989#define ARMV8_TTBR_EL1_AARCH64_BADDR_GET(a_Ttbr) (((a_Ttbr) & ARMV8_TTBR_EL1_AARCH64_BADDR) >> 1)
990/** Bit 48 - 63 - ASID. */
991#define ARMV8_TTBR_EL1_AARCH64_ASID UINT64_C(0xffff000000000000)
992#define ARMV8_TTBR_EL1_AARCH64_ASID_GET(a_Ttbr) (((a_Ttbr) & ARMV8_TTBR_EL1_AARCH64_ASID) >> 48)
993/** @} */
994
995
996/** @name ICC_PMR_EL1 - Interrupt Controller Interrupt Priority Mask Register
997 * @{ */
998/** Bit 0 - 7 - Priority - The priority mask level for the CPU interface. */
999#define ARMV8_ICC_PMR_EL1_AARCH64_PRIORITY UINT64_C(0xff)
1000#define ARMV8_ICC_PMR_EL1_AARCH64_PRIORITY_GET(a_Pmr) ((a_Pmr) & ARMV8_ICC_PMR_EL1_AARCH64_PRIORITY)
1001#define ARMV8_ICC_PMR_EL1_AARCH64_PRIORITY_SET(a_Prio) ((a_Prio) & ARMV8_ICC_PMR_EL1_AARCH64_PRIORITY)
1002/** @} */
1003
1004
1005/** @name ICC_BPR0_EL1 - The group priority for Group 0 interrupts.
1006 * @{ */
1007/** Bit 0 - 2 - BinaryPoint - Controls how the 8-bit interrupt priority field is split into a group priority and subpriority field. */
1008#define ARMV8_ICC_BPR0_EL1_AARCH64_BINARYPOINT (RT_BIT_64(0) | RT_BIT_64(1) | RT_BIT_64(2))
1009#define ARMV8_ICC_BPR0_EL1_AARCH64_BINARYPOINT_GET(a_Bpr0) ((a_Bpr0) & ARMV8_ICC_BPR0_EL1_AARCH64_BINARYPOINT)
1010#define ARMV8_ICC_BPR0_EL1_AARCH64_BINARYPOINT_SET(a_BinaryPt) ((a_BinaryPt) & ARMV8_ICC_BPR0_EL1_AARCH64_BINARYPOINT)
1011/** @} */
1012
1013
1014/** @name ICC_BPR1_EL1 - The group priority for Group 1 interrupts.
1015 * @{ */
1016/** Bit 0 - 2 - BinaryPoint - Controls how the 8-bit interrupt priority field is split into a group priority and subpriority field. */
1017#define ARMV8_ICC_BPR1_EL1_AARCH64_BINARYPOINT (RT_BIT_64(0) | RT_BIT_64(1) | RT_BIT_64(2))
1018#define ARMV8_ICC_BPR1_EL1_AARCH64_BINARYPOINT_GET(a_Bpr1) ((a_Bpr1) & ARMV8_ICC_BPR1_EL1_AARCH64_BINARYPOINT)
1019#define ARMV8_ICC_BPR1_EL1_AARCH64_BINARYPOINT_SET(a_BinaryPt) ((a_BinaryPt) & ARMV8_ICC_BPR1_EL1_AARCH64_BINARYPOINT)
1020/** @} */
1021
1022
1023/** @name ICC_CTLR_EL1 - Interrupt Controller Control Register (EL1)
1024 * @{ */
1025/** Bit 0 - Common Binary Pointer Register - RW. */
1026#define ARMV8_ICC_CTLR_EL1_AARCH64_CBPR RT_BIT_64(0)
1027#define ARMV8_ICC_CTLR_EL1_AARCH64_CBPR_BIT 0
1028/** Bit 1 - EOI mode for current security state, when set ICC_DIR_EL1 provides interrupt deactivation functionality - RW. */
1029#define ARMV8_ICC_CTLR_EL1_AARCH64_EOIMODE RT_BIT_64(1)
1030#define ARMV8_ICC_CTLR_EL1_AARCH64_EOIMODE_BIT 1
1031/** Bit 7 - Priority Mask Hint Enable - RW (under circumstances). */
1032#define ARMV8_ICC_CTLR_EL1_AARCH64_PMHE RT_BIT_64(7)
1033#define ARMV8_ICC_CTLR_EL1_AARCH64_PMHE_BIT 7
1034/** Bit 8 - 10 - Priority bits - RO. */
1035#define ARMV8_ICC_CTLR_EL1_AARCH64_PRIBITS (RT_BIT_64(8) | RT_BIT_64(9) | RT_BIT_64(10))
1036#define ARMV8_ICC_CTLR_EL1_AARCH64_PRIBITS_SET(a_PriBits) (((a_PriBits) << 8) & ARMV8_ICC_CTLR_EL1_AARCH64_PRIBITS)
1037/** Bit 11 - 13 - Interrupt identifier bits - RO. */
1038#define ARMV8_ICC_CTLR_EL1_AARCH64_IDBITS (RT_BIT_64(11) | RT_BIT_64(12) | RT_BIT_64(13))
1039#define ARMV8_ICC_CTLR_EL1_AARCH64_IDBITS_SET(a_IdBits) (((a_IdBits) << 11) & ARMV8_ICC_CTLR_EL1_AARCH64_IDBITS)
1040/** INTIDS are 16-bit wide. */
1041# define ARMV8_ICC_CTLR_EL1_AARCH64_IDBITS_16BITS 0
1042/** INTIDS are 24-bit wide. */
1043# define ARMV8_ICC_CTLR_EL1_AARCH64_IDBITS_24BITS 1
1044/** Bit 14 - SEI Supported - RO. */
1045#define ARMV8_ICC_CTLR_EL1_AARCH64_SEIS RT_BIT_64(14)
1046#define ARMV8_ICC_CTLR_EL1_AARCH64_SEIS_BIT 14
1047/** Bit 15 - Affinity 3 Valid - RO. */
1048#define ARMV8_ICC_CTLR_EL1_AARCH64_A3V RT_BIT_64(15)
1049#define ARMV8_ICC_CTLR_EL1_AARCH64_A3V_BIT 15
1050/** Bit 18 - Range Selector Support - RO. */
1051#define ARMV8_ICC_CTLR_EL1_AARCH64_RSS RT_BIT_64(18)
1052#define ARMV8_ICC_CTLR_EL1_AARCH64_RSS_BIT 18
1053/** Bit 19 - Extended INTID range supported - RO. */
1054#define ARMV8_ICC_CTLR_EL1_AARCH64_EXTRANGE RT_BIT_64(19)
1055#define ARMV8_ICC_CTLR_EL1_AARCH64_EXTRANGE_BIT 19
1056/** All RW bits. */
1057#define ARMV8_ICC_CTLR_EL1_RW (ARMV8_ICC_CTLR_EL1_AARCH64_CBPR | ARMV8_ICC_CTLR_EL1_AARCH64_EOIMODE | ARMV8_ICC_CTLR_EL1_AARCH64_PMHE)
1058/** All RO bits (including Res0). */
1059#define ARMV8_ICC_CTLR_EL1_RO ~ARMV8_ICC_CTLR_EL1_RW
1060/** @} */
1061
1062
1063/** @name ICC_IGRPEN0_EL1 - Interrupt Controller Interrupt Group 0 Enable Register (EL1)
1064 * @{ */
1065/** Bit 0 - Enables Group 0 interrupts for the current Security state. */
1066#define ARMV8_ICC_IGRPEN0_EL1_AARCH64_ENABLE RT_BIT_64(0)
1067#define ARMV8_ICC_IGRPEN0_EL1_AARCH64_ENABLE_BIT 0
1068/** @} */
1069
1070/** @name ICC_IGRPEN1_EL1 - Interrupt Controller Interrupt Group 1 Enable Register (EL1)
1071 * @{ */
1072/** Bit 0 - Enables Group 1 interrupts for the current Security state. */
1073#define ARMV8_ICC_IGRPEN1_EL1_AARCH64_ENABLE RT_BIT_64(0)
1074#define ARMV8_ICC_IGRPEN1_EL1_AARCH64_ENABLE_BIT 0
1075/** @} */
1076
1077
1078
1079/** @name CNTV_CTL_EL0 - Counter-timer Virtual Timer Control register.
1080 * @{ */
1081/** Bit 0 - Enables the timer. */
1082#define ARMV8_CNTV_CTL_EL0_AARCH64_ENABLE RT_BIT_64(0)
1083#define ARMV8_CNTV_CTL_EL0_AARCH64_ENABLE_BIT 0
1084/** Bit 1 - Timer interrupt mask bit. */
1085#define ARMV8_CNTV_CTL_EL0_AARCH64_IMASK RT_BIT_64(1)
1086#define ARMV8_CNTV_CTL_EL0_AARCH64_IMASK_BIT 1
1087/** Bit 2 - Timer status bit. */
1088#define ARMV8_CNTV_CTL_EL0_AARCH64_ISTATUS RT_BIT_64(2)
1089#define ARMV8_CNTV_CTL_EL0_AARCH64_ISTATUS_BIT 2
1090/** @} */
1091
1092
1093/** @} */
1094
1095#endif /* !IPRT_INCLUDED_armv8_h */
1096
Note: See TracBrowser for help on using the repository browser.

© 2023 Oracle
Contact – Privacy policy – Terms of Use