xref: /rk3399_ARM-atf/include/arch/aarch64/arch.h (revision 8fcd3d9600bb2cb6809c6fc68f945ce3ad89633d)
1 /*
2  * Copyright (c) 2013-2021, ARM Limited and Contributors. All rights reserved.
3  * Copyright (c) 2020, NVIDIA Corporation. All rights reserved.
4  *
5  * SPDX-License-Identifier: BSD-3-Clause
6  */
7 
8 #ifndef ARCH_H
9 #define ARCH_H
10 
11 #include <lib/utils_def.h>
12 
13 /*******************************************************************************
14  * MIDR bit definitions
15  ******************************************************************************/
16 #define MIDR_IMPL_MASK		U(0xff)
17 #define MIDR_IMPL_SHIFT		U(0x18)
18 #define MIDR_VAR_SHIFT		U(20)
19 #define MIDR_VAR_BITS		U(4)
20 #define MIDR_VAR_MASK		U(0xf)
21 #define MIDR_REV_SHIFT		U(0)
22 #define MIDR_REV_BITS		U(4)
23 #define MIDR_REV_MASK		U(0xf)
24 #define MIDR_PN_MASK		U(0xfff)
25 #define MIDR_PN_SHIFT		U(0x4)
26 
27 /*******************************************************************************
28  * MPIDR macros
29  ******************************************************************************/
30 #define MPIDR_MT_MASK		(ULL(1) << 24)
31 #define MPIDR_CPU_MASK		MPIDR_AFFLVL_MASK
32 #define MPIDR_CLUSTER_MASK	(MPIDR_AFFLVL_MASK << MPIDR_AFFINITY_BITS)
33 #define MPIDR_AFFINITY_BITS	U(8)
34 #define MPIDR_AFFLVL_MASK	ULL(0xff)
35 #define MPIDR_AFF0_SHIFT	U(0)
36 #define MPIDR_AFF1_SHIFT	U(8)
37 #define MPIDR_AFF2_SHIFT	U(16)
38 #define MPIDR_AFF3_SHIFT	U(32)
39 #define MPIDR_AFF_SHIFT(_n)	MPIDR_AFF##_n##_SHIFT
40 #define MPIDR_AFFINITY_MASK	ULL(0xff00ffffff)
41 #define MPIDR_AFFLVL_SHIFT	U(3)
42 #define MPIDR_AFFLVL0		ULL(0x0)
43 #define MPIDR_AFFLVL1		ULL(0x1)
44 #define MPIDR_AFFLVL2		ULL(0x2)
45 #define MPIDR_AFFLVL3		ULL(0x3)
46 #define MPIDR_AFFLVL(_n)	MPIDR_AFFLVL##_n
47 #define MPIDR_AFFLVL0_VAL(mpidr) \
48 		(((mpidr) >> MPIDR_AFF0_SHIFT) & MPIDR_AFFLVL_MASK)
49 #define MPIDR_AFFLVL1_VAL(mpidr) \
50 		(((mpidr) >> MPIDR_AFF1_SHIFT) & MPIDR_AFFLVL_MASK)
51 #define MPIDR_AFFLVL2_VAL(mpidr) \
52 		(((mpidr) >> MPIDR_AFF2_SHIFT) & MPIDR_AFFLVL_MASK)
53 #define MPIDR_AFFLVL3_VAL(mpidr) \
54 		(((mpidr) >> MPIDR_AFF3_SHIFT) & MPIDR_AFFLVL_MASK)
55 /*
56  * The MPIDR_MAX_AFFLVL count starts from 0. Take care to
57  * add one while using this macro to define array sizes.
58  * TODO: Support only the first 3 affinity levels for now.
59  */
60 #define MPIDR_MAX_AFFLVL	U(2)
61 
62 #define MPID_MASK		(MPIDR_MT_MASK				 | \
63 				 (MPIDR_AFFLVL_MASK << MPIDR_AFF3_SHIFT) | \
64 				 (MPIDR_AFFLVL_MASK << MPIDR_AFF2_SHIFT) | \
65 				 (MPIDR_AFFLVL_MASK << MPIDR_AFF1_SHIFT) | \
66 				 (MPIDR_AFFLVL_MASK << MPIDR_AFF0_SHIFT))
67 
68 #define MPIDR_AFF_ID(mpid, n)					\
69 	(((mpid) >> MPIDR_AFF_SHIFT(n)) & MPIDR_AFFLVL_MASK)
70 
71 /*
72  * An invalid MPID. This value can be used by functions that return an MPID to
73  * indicate an error.
74  */
75 #define INVALID_MPID		U(0xFFFFFFFF)
76 
77 /*******************************************************************************
78  * Definitions for CPU system register interface to GICv3
79  ******************************************************************************/
80 #define ICC_IGRPEN1_EL1		S3_0_C12_C12_7
81 #define ICC_SGI1R		S3_0_C12_C11_5
82 #define ICC_SRE_EL1		S3_0_C12_C12_5
83 #define ICC_SRE_EL2		S3_4_C12_C9_5
84 #define ICC_SRE_EL3		S3_6_C12_C12_5
85 #define ICC_CTLR_EL1		S3_0_C12_C12_4
86 #define ICC_CTLR_EL3		S3_6_C12_C12_4
87 #define ICC_PMR_EL1		S3_0_C4_C6_0
88 #define ICC_RPR_EL1		S3_0_C12_C11_3
89 #define ICC_IGRPEN1_EL3		S3_6_c12_c12_7
90 #define ICC_IGRPEN0_EL1		S3_0_c12_c12_6
91 #define ICC_HPPIR0_EL1		S3_0_c12_c8_2
92 #define ICC_HPPIR1_EL1		S3_0_c12_c12_2
93 #define ICC_IAR0_EL1		S3_0_c12_c8_0
94 #define ICC_IAR1_EL1		S3_0_c12_c12_0
95 #define ICC_EOIR0_EL1		S3_0_c12_c8_1
96 #define ICC_EOIR1_EL1		S3_0_c12_c12_1
97 #define ICC_SGI0R_EL1		S3_0_c12_c11_7
98 
99 /*******************************************************************************
100  * Definitions for EL2 system registers for save/restore routine
101  ******************************************************************************/
102 
103 #define CNTPOFF_EL2		S3_4_C14_C0_6
104 #define HAFGRTR_EL2		S3_4_C3_C1_6
105 #define HDFGRTR_EL2		S3_4_C3_C1_4
106 #define HDFGWTR_EL2		S3_4_C3_C1_5
107 #define HFGITR_EL2		S3_4_C1_C1_6
108 #define HFGRTR_EL2		S3_4_C1_C1_4
109 #define HFGWTR_EL2		S3_4_C1_C1_5
110 #define ICH_HCR_EL2		S3_4_C12_C11_0
111 #define ICH_VMCR_EL2		S3_4_C12_C11_7
112 #define MPAMVPM0_EL2		S3_4_C10_C5_0
113 #define MPAMVPM1_EL2		S3_4_C10_C5_1
114 #define MPAMVPM2_EL2		S3_4_C10_C5_2
115 #define MPAMVPM3_EL2		S3_4_C10_C5_3
116 #define MPAMVPM4_EL2		S3_4_C10_C5_4
117 #define MPAMVPM5_EL2		S3_4_C10_C5_5
118 #define MPAMVPM6_EL2		S3_4_C10_C5_6
119 #define MPAMVPM7_EL2		S3_4_C10_C5_7
120 #define MPAMVPMV_EL2		S3_4_C10_C4_1
121 #define TRFCR_EL2		S3_4_C1_C2_1
122 #define PMSCR_EL2		S3_4_C9_C9_0
123 #define TFSR_EL2		S3_4_C5_C6_0
124 
125 /*******************************************************************************
126  * Generic timer memory mapped registers & offsets
127  ******************************************************************************/
128 #define CNTCR_OFF			U(0x000)
129 #define CNTCV_OFF			U(0x008)
130 #define CNTFID_OFF			U(0x020)
131 
132 #define CNTCR_EN			(U(1) << 0)
133 #define CNTCR_HDBG			(U(1) << 1)
134 #define CNTCR_FCREQ(x)			((x) << 8)
135 
136 /*******************************************************************************
137  * System register bit definitions
138  ******************************************************************************/
139 /* CLIDR definitions */
140 #define LOUIS_SHIFT		U(21)
141 #define LOC_SHIFT		U(24)
142 #define CTYPE_SHIFT(n)		U(3 * (n - 1))
143 #define CLIDR_FIELD_WIDTH	U(3)
144 
145 /* CSSELR definitions */
146 #define LEVEL_SHIFT		U(1)
147 
148 /* Data cache set/way op type defines */
149 #define DCISW			U(0x0)
150 #define DCCISW			U(0x1)
151 #if ERRATA_A53_827319
152 #define DCCSW			DCCISW
153 #else
154 #define DCCSW			U(0x2)
155 #endif
156 
157 /* ID_AA64PFR0_EL1 definitions */
158 #define ID_AA64PFR0_EL0_SHIFT	U(0)
159 #define ID_AA64PFR0_EL1_SHIFT	U(4)
160 #define ID_AA64PFR0_EL2_SHIFT	U(8)
161 #define ID_AA64PFR0_EL3_SHIFT	U(12)
162 #define ID_AA64PFR0_AMU_SHIFT	U(44)
163 #define ID_AA64PFR0_AMU_MASK	ULL(0xf)
164 #define ID_AA64PFR0_AMU_NOT_SUPPORTED	U(0x0)
165 #define ID_AA64PFR0_AMU_V1	U(0x1)
166 #define ID_AA64PFR0_AMU_V1P1	U(0x2)
167 #define ID_AA64PFR0_ELX_MASK	ULL(0xf)
168 #define ID_AA64PFR0_GIC_SHIFT	U(24)
169 #define ID_AA64PFR0_GIC_WIDTH	U(4)
170 #define ID_AA64PFR0_GIC_MASK	ULL(0xf)
171 #define ID_AA64PFR0_SVE_SHIFT	U(32)
172 #define ID_AA64PFR0_SVE_MASK	ULL(0xf)
173 #define ID_AA64PFR0_SVE_LENGTH	U(4)
174 #define ID_AA64PFR0_SEL2_SHIFT	U(36)
175 #define ID_AA64PFR0_SEL2_MASK	ULL(0xf)
176 #define ID_AA64PFR0_MPAM_SHIFT	U(40)
177 #define ID_AA64PFR0_MPAM_MASK	ULL(0xf)
178 #define ID_AA64PFR0_DIT_SHIFT	U(48)
179 #define ID_AA64PFR0_DIT_MASK	ULL(0xf)
180 #define ID_AA64PFR0_DIT_LENGTH	U(4)
181 #define ID_AA64PFR0_DIT_SUPPORTED	U(1)
182 #define ID_AA64PFR0_CSV2_SHIFT	U(56)
183 #define ID_AA64PFR0_CSV2_MASK	ULL(0xf)
184 #define ID_AA64PFR0_CSV2_LENGTH	U(4)
185 
186 /* Exception level handling */
187 #define EL_IMPL_NONE		ULL(0)
188 #define EL_IMPL_A64ONLY		ULL(1)
189 #define EL_IMPL_A64_A32		ULL(2)
190 
191 /* ID_AA64DFR0_EL1.TraceVer definitions */
192 #define ID_AA64DFR0_TRACEVER_SHIFT	U(4)
193 #define ID_AA64DFR0_TRACEVER_MASK	ULL(0xf)
194 #define ID_AA64DFR0_TRACEVER_SUPPORTED	ULL(1)
195 #define ID_AA64DFR0_TRACEVER_LENGTH	U(4)
196 #define ID_AA64DFR0_TRACEFILT_SHIFT	U(40)
197 #define ID_AA64DFR0_TRACEFILT_MASK	U(0xf)
198 #define ID_AA64DFR0_TRACEFILT_SUPPORTED	U(1)
199 #define ID_AA64DFR0_TRACEFILT_LENGTH	U(4)
200 
201 /* ID_AA64DFR0_EL1.PMS definitions (for ARMv8.2+) */
202 #define ID_AA64DFR0_PMS_SHIFT	U(32)
203 #define ID_AA64DFR0_PMS_MASK	ULL(0xf)
204 
205 /* ID_AA64DFR0_EL1.TraceBuffer definitions */
206 #define ID_AA64DFR0_TRACEBUFFER_SHIFT		U(44)
207 #define ID_AA64DFR0_TRACEBUFFER_MASK		ULL(0xf)
208 #define ID_AA64DFR0_TRACEBUFFER_SUPPORTED	ULL(1)
209 
210 /* ID_AA64DFR0_EL1.MTPMU definitions (for ARMv8.6+) */
211 #define ID_AA64DFR0_MTPMU_SHIFT		U(48)
212 #define ID_AA64DFR0_MTPMU_MASK		ULL(0xf)
213 #define ID_AA64DFR0_MTPMU_SUPPORTED	ULL(1)
214 
215 /* ID_AA64ISAR0_EL1 definitions */
216 #define ID_AA64ISAR0_RNDR_SHIFT U(60)
217 #define ID_AA64ISAR0_RNDR_MASK  ULL(0xf)
218 
219 /* ID_AA64ISAR1_EL1 definitions */
220 #define ID_AA64ISAR1_EL1	S3_0_C0_C6_1
221 #define ID_AA64ISAR1_GPI_SHIFT	U(28)
222 #define ID_AA64ISAR1_GPI_MASK	ULL(0xf)
223 #define ID_AA64ISAR1_GPA_SHIFT	U(24)
224 #define ID_AA64ISAR1_GPA_MASK	ULL(0xf)
225 #define ID_AA64ISAR1_API_SHIFT	U(8)
226 #define ID_AA64ISAR1_API_MASK	ULL(0xf)
227 #define ID_AA64ISAR1_APA_SHIFT	U(4)
228 #define ID_AA64ISAR1_APA_MASK	ULL(0xf)
229 
230 /* ID_AA64MMFR0_EL1 definitions */
231 #define ID_AA64MMFR0_EL1_PARANGE_SHIFT	U(0)
232 #define ID_AA64MMFR0_EL1_PARANGE_MASK	ULL(0xf)
233 
234 #define PARANGE_0000	U(32)
235 #define PARANGE_0001	U(36)
236 #define PARANGE_0010	U(40)
237 #define PARANGE_0011	U(42)
238 #define PARANGE_0100	U(44)
239 #define PARANGE_0101	U(48)
240 #define PARANGE_0110	U(52)
241 
242 #define ID_AA64MMFR0_EL1_ECV_SHIFT		U(60)
243 #define ID_AA64MMFR0_EL1_ECV_MASK		ULL(0xf)
244 #define ID_AA64MMFR0_EL1_ECV_NOT_SUPPORTED	ULL(0x0)
245 #define ID_AA64MMFR0_EL1_ECV_SUPPORTED		ULL(0x1)
246 #define ID_AA64MMFR0_EL1_ECV_SELF_SYNCH	ULL(0x2)
247 
248 #define ID_AA64MMFR0_EL1_FGT_SHIFT		U(56)
249 #define ID_AA64MMFR0_EL1_FGT_MASK		ULL(0xf)
250 #define ID_AA64MMFR0_EL1_FGT_SUPPORTED		ULL(0x1)
251 #define ID_AA64MMFR0_EL1_FGT_NOT_SUPPORTED	ULL(0x0)
252 
253 #define ID_AA64MMFR0_EL1_TGRAN4_SHIFT		U(28)
254 #define ID_AA64MMFR0_EL1_TGRAN4_MASK		ULL(0xf)
255 #define ID_AA64MMFR0_EL1_TGRAN4_SUPPORTED	ULL(0x0)
256 #define ID_AA64MMFR0_EL1_TGRAN4_NOT_SUPPORTED	ULL(0xf)
257 
258 #define ID_AA64MMFR0_EL1_TGRAN64_SHIFT		U(24)
259 #define ID_AA64MMFR0_EL1_TGRAN64_MASK		ULL(0xf)
260 #define ID_AA64MMFR0_EL1_TGRAN64_SUPPORTED	ULL(0x0)
261 #define ID_AA64MMFR0_EL1_TGRAN64_NOT_SUPPORTED	ULL(0xf)
262 
263 #define ID_AA64MMFR0_EL1_TGRAN16_SHIFT		U(20)
264 #define ID_AA64MMFR0_EL1_TGRAN16_MASK		ULL(0xf)
265 #define ID_AA64MMFR0_EL1_TGRAN16_SUPPORTED	ULL(0x1)
266 #define ID_AA64MMFR0_EL1_TGRAN16_NOT_SUPPORTED	ULL(0x0)
267 
268 /* ID_AA64MMFR1_EL1 definitions */
269 #define ID_AA64MMFR1_EL1_TWED_SHIFT		U(32)
270 #define ID_AA64MMFR1_EL1_TWED_MASK		ULL(0xf)
271 #define ID_AA64MMFR1_EL1_TWED_SUPPORTED		ULL(0x1)
272 #define ID_AA64MMFR1_EL1_TWED_NOT_SUPPORTED	ULL(0x0)
273 
274 #define ID_AA64MMFR1_EL1_PAN_SHIFT		U(20)
275 #define ID_AA64MMFR1_EL1_PAN_MASK		ULL(0xf)
276 #define ID_AA64MMFR1_EL1_PAN_NOT_SUPPORTED	ULL(0x0)
277 #define ID_AA64MMFR1_EL1_PAN_SUPPORTED		ULL(0x1)
278 #define ID_AA64MMFR1_EL1_PAN2_SUPPORTED		ULL(0x2)
279 #define ID_AA64MMFR1_EL1_PAN3_SUPPORTED		ULL(0x3)
280 
281 #define ID_AA64MMFR1_EL1_VHE_SHIFT		U(8)
282 #define ID_AA64MMFR1_EL1_VHE_MASK		ULL(0xf)
283 
284 /* ID_AA64MMFR2_EL1 definitions */
285 #define ID_AA64MMFR2_EL1		S3_0_C0_C7_2
286 
287 #define ID_AA64MMFR2_EL1_ST_SHIFT	U(28)
288 #define ID_AA64MMFR2_EL1_ST_MASK	ULL(0xf)
289 
290 #define ID_AA64MMFR2_EL1_CNP_SHIFT	U(0)
291 #define ID_AA64MMFR2_EL1_CNP_MASK	ULL(0xf)
292 
293 /* ID_AA64PFR1_EL1 definitions */
294 #define ID_AA64PFR1_EL1_SSBS_SHIFT	U(4)
295 #define ID_AA64PFR1_EL1_SSBS_MASK	ULL(0xf)
296 
297 #define SSBS_UNAVAILABLE	ULL(0)	/* No architectural SSBS support */
298 
299 #define ID_AA64PFR1_EL1_BT_SHIFT	U(0)
300 #define ID_AA64PFR1_EL1_BT_MASK		ULL(0xf)
301 
302 #define BTI_IMPLEMENTED		ULL(1)	/* The BTI mechanism is implemented */
303 
304 #define ID_AA64PFR1_EL1_MTE_SHIFT	U(8)
305 #define ID_AA64PFR1_EL1_MTE_MASK	ULL(0xf)
306 
307 /* Memory Tagging Extension is not implemented */
308 #define MTE_UNIMPLEMENTED	U(0)
309 /* FEAT_MTE: MTE instructions accessible at EL0 are implemented */
310 #define MTE_IMPLEMENTED_EL0	U(1)
311 /* FEAT_MTE2: Full MTE is implemented */
312 #define MTE_IMPLEMENTED_ELX	U(2)
313 /*
314  * FEAT_MTE3: MTE is implemented with support for
315  * asymmetric Tag Check Fault handling
316  */
317 #define MTE_IMPLEMENTED_ASY	U(3)
318 
319 #define ID_AA64PFR1_MPAM_FRAC_SHIFT	ULL(16)
320 #define ID_AA64PFR1_MPAM_FRAC_MASK	ULL(0xf)
321 
322 /* ID_PFR1_EL1 definitions */
323 #define ID_PFR1_VIRTEXT_SHIFT	U(12)
324 #define ID_PFR1_VIRTEXT_MASK	U(0xf)
325 #define GET_VIRT_EXT(id)	(((id) >> ID_PFR1_VIRTEXT_SHIFT) \
326 				 & ID_PFR1_VIRTEXT_MASK)
327 
328 /* SCTLR definitions */
329 #define SCTLR_EL2_RES1	((U(1) << 29) | (U(1) << 28) | (U(1) << 23) | \
330 			 (U(1) << 22) | (U(1) << 18) | (U(1) << 16) | \
331 			 (U(1) << 11) | (U(1) << 5) | (U(1) << 4))
332 
333 #define SCTLR_EL1_RES1	((UL(1) << 29) | (UL(1) << 28) | (UL(1) << 23) | \
334 			 (UL(1) << 22) | (UL(1) << 20) | (UL(1) << 11))
335 
336 #define SCTLR_AARCH32_EL1_RES1 \
337 			((U(1) << 23) | (U(1) << 22) | (U(1) << 11) | \
338 			 (U(1) << 4) | (U(1) << 3))
339 
340 #define SCTLR_EL3_RES1	((U(1) << 29) | (U(1) << 28) | (U(1) << 23) | \
341 			(U(1) << 22) | (U(1) << 18) | (U(1) << 16) | \
342 			(U(1) << 11) | (U(1) << 5) | (U(1) << 4))
343 
344 #define SCTLR_M_BIT		(ULL(1) << 0)
345 #define SCTLR_A_BIT		(ULL(1) << 1)
346 #define SCTLR_C_BIT		(ULL(1) << 2)
347 #define SCTLR_SA_BIT		(ULL(1) << 3)
348 #define SCTLR_SA0_BIT		(ULL(1) << 4)
349 #define SCTLR_CP15BEN_BIT	(ULL(1) << 5)
350 #define SCTLR_nAA_BIT		(ULL(1) << 6)
351 #define SCTLR_ITD_BIT		(ULL(1) << 7)
352 #define SCTLR_SED_BIT		(ULL(1) << 8)
353 #define SCTLR_UMA_BIT		(ULL(1) << 9)
354 #define SCTLR_EnRCTX_BIT	(ULL(1) << 10)
355 #define SCTLR_EOS_BIT		(ULL(1) << 11)
356 #define SCTLR_I_BIT		(ULL(1) << 12)
357 #define SCTLR_EnDB_BIT		(ULL(1) << 13)
358 #define SCTLR_DZE_BIT		(ULL(1) << 14)
359 #define SCTLR_UCT_BIT		(ULL(1) << 15)
360 #define SCTLR_NTWI_BIT		(ULL(1) << 16)
361 #define SCTLR_NTWE_BIT		(ULL(1) << 18)
362 #define SCTLR_WXN_BIT		(ULL(1) << 19)
363 #define SCTLR_TSCXT_BIT		(ULL(1) << 20)
364 #define SCTLR_IESB_BIT		(ULL(1) << 21)
365 #define SCTLR_EIS_BIT		(ULL(1) << 22)
366 #define SCTLR_SPAN_BIT		(ULL(1) << 23)
367 #define SCTLR_E0E_BIT		(ULL(1) << 24)
368 #define SCTLR_EE_BIT		(ULL(1) << 25)
369 #define SCTLR_UCI_BIT		(ULL(1) << 26)
370 #define SCTLR_EnDA_BIT		(ULL(1) << 27)
371 #define SCTLR_nTLSMD_BIT	(ULL(1) << 28)
372 #define SCTLR_LSMAOE_BIT	(ULL(1) << 29)
373 #define SCTLR_EnIB_BIT		(ULL(1) << 30)
374 #define SCTLR_EnIA_BIT		(ULL(1) << 31)
375 #define SCTLR_BT0_BIT		(ULL(1) << 35)
376 #define SCTLR_BT1_BIT		(ULL(1) << 36)
377 #define SCTLR_BT_BIT		(ULL(1) << 36)
378 #define SCTLR_ITFSB_BIT		(ULL(1) << 37)
379 #define SCTLR_TCF0_SHIFT	U(38)
380 #define SCTLR_TCF0_MASK		ULL(3)
381 
382 /* Tag Check Faults in EL0 have no effect on the PE */
383 #define	SCTLR_TCF0_NO_EFFECT	U(0)
384 /* Tag Check Faults in EL0 cause a synchronous exception */
385 #define	SCTLR_TCF0_SYNC		U(1)
386 /* Tag Check Faults in EL0 are asynchronously accumulated */
387 #define	SCTLR_TCF0_ASYNC	U(2)
388 /*
389  * Tag Check Faults in EL0 cause a synchronous exception on reads,
390  * and are asynchronously accumulated on writes
391  */
392 #define	SCTLR_TCF0_SYNCR_ASYNCW	U(3)
393 
394 #define SCTLR_TCF_SHIFT		U(40)
395 #define SCTLR_TCF_MASK		ULL(3)
396 
397 /* Tag Check Faults in EL1 have no effect on the PE */
398 #define	SCTLR_TCF_NO_EFFECT	U(0)
399 /* Tag Check Faults in EL1 cause a synchronous exception */
400 #define	SCTLR_TCF_SYNC		U(1)
401 /* Tag Check Faults in EL1 are asynchronously accumulated */
402 #define	SCTLR_TCF_ASYNC		U(2)
403 /*
404  * Tag Check Faults in EL1 cause a synchronous exception on reads,
405  * and are asynchronously accumulated on writes
406  */
407 #define	SCTLR_TCF_SYNCR_ASYNCW	U(3)
408 
409 #define SCTLR_ATA0_BIT		(ULL(1) << 42)
410 #define SCTLR_ATA_BIT		(ULL(1) << 43)
411 #define SCTLR_DSSBS_SHIFT	U(44)
412 #define SCTLR_DSSBS_BIT		(ULL(1) << SCTLR_DSSBS_SHIFT)
413 #define SCTLR_TWEDEn_BIT	(ULL(1) << 45)
414 #define SCTLR_TWEDEL_SHIFT	U(46)
415 #define SCTLR_TWEDEL_MASK	ULL(0xf)
416 #define SCTLR_EnASR_BIT		(ULL(1) << 54)
417 #define SCTLR_EnAS0_BIT		(ULL(1) << 55)
418 #define SCTLR_EnALS_BIT		(ULL(1) << 56)
419 #define SCTLR_EPAN_BIT		(ULL(1) << 57)
420 #define SCTLR_RESET_VAL		SCTLR_EL3_RES1
421 
422 /* CPACR_EL1 definitions */
423 #define CPACR_EL1_FPEN(x)	((x) << 20)
424 #define CPACR_EL1_FP_TRAP_EL0	UL(0x1)
425 #define CPACR_EL1_FP_TRAP_ALL	UL(0x2)
426 #define CPACR_EL1_FP_TRAP_NONE	UL(0x3)
427 
428 /* SCR definitions */
429 #define SCR_RES1_BITS		((U(1) << 4) | (U(1) << 5))
430 #define SCR_TWEDEL_SHIFT	U(30)
431 #define SCR_TWEDEL_MASK		ULL(0xf)
432 #define SCR_AMVOFFEN_BIT	(UL(1) << 35)
433 #define SCR_TWEDEn_BIT		(UL(1) << 29)
434 #define SCR_ECVEN_BIT		(UL(1) << 28)
435 #define SCR_FGTEN_BIT		(UL(1) << 27)
436 #define SCR_ATA_BIT		(UL(1) << 26)
437 #define SCR_FIEN_BIT		(UL(1) << 21)
438 #define SCR_EEL2_BIT		(UL(1) << 18)
439 #define SCR_API_BIT		(UL(1) << 17)
440 #define SCR_APK_BIT		(UL(1) << 16)
441 #define SCR_TERR_BIT		(UL(1) << 15)
442 #define SCR_TWE_BIT		(UL(1) << 13)
443 #define SCR_TWI_BIT		(UL(1) << 12)
444 #define SCR_ST_BIT		(UL(1) << 11)
445 #define SCR_RW_BIT		(UL(1) << 10)
446 #define SCR_SIF_BIT		(UL(1) << 9)
447 #define SCR_HCE_BIT		(UL(1) << 8)
448 #define SCR_SMD_BIT		(UL(1) << 7)
449 #define SCR_EA_BIT		(UL(1) << 3)
450 #define SCR_FIQ_BIT		(UL(1) << 2)
451 #define SCR_IRQ_BIT		(UL(1) << 1)
452 #define SCR_NS_BIT		(UL(1) << 0)
453 #define SCR_VALID_BIT_MASK	U(0x2f8f)
454 #define SCR_RESET_VAL		SCR_RES1_BITS
455 
456 /* MDCR_EL3 definitions */
457 #define MDCR_EnPMSN_BIT		(ULL(1) << 36)
458 #define MDCR_MPMX_BIT		(ULL(1) << 35)
459 #define MDCR_MCCD_BIT		(ULL(1) << 34)
460 #define MDCR_NSTB(x)		((x) << 24)
461 #define MDCR_NSTB_EL1		ULL(0x3)
462 #define MDCR_NSTBE		(ULL(1) << 26)
463 #define MDCR_MTPME_BIT		(ULL(1) << 28)
464 #define MDCR_TDCC_BIT		(ULL(1) << 27)
465 #define MDCR_SCCD_BIT		(ULL(1) << 23)
466 #define MDCR_EPMAD_BIT		(ULL(1) << 21)
467 #define MDCR_EDAD_BIT		(ULL(1) << 20)
468 #define MDCR_TTRF_BIT		(ULL(1) << 19)
469 #define MDCR_STE_BIT		(ULL(1) << 18)
470 #define MDCR_SPME_BIT		(ULL(1) << 17)
471 #define MDCR_SDD_BIT		(ULL(1) << 16)
472 #define MDCR_SPD32(x)		((x) << 14)
473 #define MDCR_SPD32_LEGACY	ULL(0x0)
474 #define MDCR_SPD32_DISABLE	ULL(0x2)
475 #define MDCR_SPD32_ENABLE	ULL(0x3)
476 #define MDCR_NSPB(x)		((x) << 12)
477 #define MDCR_NSPB_EL1		ULL(0x3)
478 #define MDCR_TDOSA_BIT		(ULL(1) << 10)
479 #define MDCR_TDA_BIT		(ULL(1) << 9)
480 #define MDCR_TPM_BIT		(ULL(1) << 6)
481 #define MDCR_EL3_RESET_VAL	ULL(0x0)
482 
483 /* MDCR_EL2 definitions */
484 #define MDCR_EL2_MTPME		(U(1) << 28)
485 #define MDCR_EL2_HLP		(U(1) << 26)
486 #define MDCR_EL2_E2TB(x)	((x) << 24)
487 #define MDCR_EL2_E2TB_EL1	U(0x3)
488 #define MDCR_EL2_HCCD		(U(1) << 23)
489 #define MDCR_EL2_TTRF		(U(1) << 19)
490 #define MDCR_EL2_HPMD		(U(1) << 17)
491 #define MDCR_EL2_TPMS		(U(1) << 14)
492 #define MDCR_EL2_E2PB(x)	((x) << 12)
493 #define MDCR_EL2_E2PB_EL1	U(0x3)
494 #define MDCR_EL2_TDRA_BIT	(U(1) << 11)
495 #define MDCR_EL2_TDOSA_BIT	(U(1) << 10)
496 #define MDCR_EL2_TDA_BIT	(U(1) << 9)
497 #define MDCR_EL2_TDE_BIT	(U(1) << 8)
498 #define MDCR_EL2_HPME_BIT	(U(1) << 7)
499 #define MDCR_EL2_TPM_BIT	(U(1) << 6)
500 #define MDCR_EL2_TPMCR_BIT	(U(1) << 5)
501 #define MDCR_EL2_RESET_VAL	U(0x0)
502 
503 /* HSTR_EL2 definitions */
504 #define HSTR_EL2_RESET_VAL	U(0x0)
505 #define HSTR_EL2_T_MASK		U(0xff)
506 
507 /* CNTHP_CTL_EL2 definitions */
508 #define CNTHP_CTL_ENABLE_BIT	(U(1) << 0)
509 #define CNTHP_CTL_RESET_VAL	U(0x0)
510 
511 /* VTTBR_EL2 definitions */
512 #define VTTBR_RESET_VAL		ULL(0x0)
513 #define VTTBR_VMID_MASK		ULL(0xff)
514 #define VTTBR_VMID_SHIFT	U(48)
515 #define VTTBR_BADDR_MASK	ULL(0xffffffffffff)
516 #define VTTBR_BADDR_SHIFT	U(0)
517 
518 /* HCR definitions */
519 #define HCR_AMVOFFEN_BIT	(ULL(1) << 51)
520 #define HCR_API_BIT		(ULL(1) << 41)
521 #define HCR_APK_BIT		(ULL(1) << 40)
522 #define HCR_E2H_BIT		(ULL(1) << 34)
523 #define HCR_TGE_BIT		(ULL(1) << 27)
524 #define HCR_RW_SHIFT		U(31)
525 #define HCR_RW_BIT		(ULL(1) << HCR_RW_SHIFT)
526 #define HCR_AMO_BIT		(ULL(1) << 5)
527 #define HCR_IMO_BIT		(ULL(1) << 4)
528 #define HCR_FMO_BIT		(ULL(1) << 3)
529 
530 /* ISR definitions */
531 #define ISR_A_SHIFT		U(8)
532 #define ISR_I_SHIFT		U(7)
533 #define ISR_F_SHIFT		U(6)
534 
535 /* CNTHCTL_EL2 definitions */
536 #define CNTHCTL_RESET_VAL	U(0x0)
537 #define EVNTEN_BIT		(U(1) << 2)
538 #define EL1PCEN_BIT		(U(1) << 1)
539 #define EL1PCTEN_BIT		(U(1) << 0)
540 
541 /* CNTKCTL_EL1 definitions */
542 #define EL0PTEN_BIT		(U(1) << 9)
543 #define EL0VTEN_BIT		(U(1) << 8)
544 #define EL0PCTEN_BIT		(U(1) << 0)
545 #define EL0VCTEN_BIT		(U(1) << 1)
546 #define EVNTEN_BIT		(U(1) << 2)
547 #define EVNTDIR_BIT		(U(1) << 3)
548 #define EVNTI_SHIFT		U(4)
549 #define EVNTI_MASK		U(0xf)
550 
551 /* CPTR_EL3 definitions */
552 #define TCPAC_BIT		(U(1) << 31)
553 #define TAM_BIT			(U(1) << 30)
554 #define TTA_BIT			(U(1) << 20)
555 #define TFP_BIT			(U(1) << 10)
556 #define CPTR_EZ_BIT		(U(1) << 8)
557 #define CPTR_EL3_RESET_VAL	(TCPAC_BIT | TAM_BIT | TTA_BIT | TFP_BIT & ~(CPTR_EZ_BIT))
558 
559 /* CPTR_EL2 definitions */
560 #define CPTR_EL2_RES1		((U(1) << 13) | (U(1) << 12) | (U(0x3ff)))
561 #define CPTR_EL2_TCPAC_BIT	(U(1) << 31)
562 #define CPTR_EL2_TAM_BIT	(U(1) << 30)
563 #define CPTR_EL2_TTA_BIT	(U(1) << 20)
564 #define CPTR_EL2_TFP_BIT	(U(1) << 10)
565 #define CPTR_EL2_TZ_BIT		(U(1) << 8)
566 #define CPTR_EL2_RESET_VAL	CPTR_EL2_RES1
567 
568 /* CPSR/SPSR definitions */
569 #define DAIF_FIQ_BIT		(U(1) << 0)
570 #define DAIF_IRQ_BIT		(U(1) << 1)
571 #define DAIF_ABT_BIT		(U(1) << 2)
572 #define DAIF_DBG_BIT		(U(1) << 3)
573 #define SPSR_DAIF_SHIFT		U(6)
574 #define SPSR_DAIF_MASK		U(0xf)
575 
576 #define SPSR_AIF_SHIFT		U(6)
577 #define SPSR_AIF_MASK		U(0x7)
578 
579 #define SPSR_E_SHIFT		U(9)
580 #define SPSR_E_MASK		U(0x1)
581 #define SPSR_E_LITTLE		U(0x0)
582 #define SPSR_E_BIG		U(0x1)
583 
584 #define SPSR_T_SHIFT		U(5)
585 #define SPSR_T_MASK		U(0x1)
586 #define SPSR_T_ARM		U(0x0)
587 #define SPSR_T_THUMB		U(0x1)
588 
589 #define SPSR_M_SHIFT		U(4)
590 #define SPSR_M_MASK		U(0x1)
591 #define SPSR_M_AARCH64		U(0x0)
592 #define SPSR_M_AARCH32		U(0x1)
593 
594 #define SPSR_EL_SHIFT		U(2)
595 #define SPSR_EL_WIDTH		U(2)
596 
597 #define SPSR_SSBS_SHIFT_AARCH64 U(12)
598 #define SPSR_SSBS_BIT_AARCH64	(ULL(1) << SPSR_SSBS_SHIFT_AARCH64)
599 #define SPSR_SSBS_SHIFT_AARCH32 U(23)
600 #define SPSR_SSBS_BIT_AARCH32	(ULL(1) << SPSR_SSBS_SHIFT_AARCH32)
601 
602 #define SPSR_PAN_BIT		BIT_64(22)
603 
604 #define SPSR_DIT_BIT		BIT(24)
605 
606 #define SPSR_TCO_BIT_AARCH64	BIT_64(25)
607 
608 #define DISABLE_ALL_EXCEPTIONS \
609 		(DAIF_FIQ_BIT | DAIF_IRQ_BIT | DAIF_ABT_BIT | DAIF_DBG_BIT)
610 
611 #define DISABLE_INTERRUPTS	(DAIF_FIQ_BIT | DAIF_IRQ_BIT)
612 
613 /*
614  * RMR_EL3 definitions
615  */
616 #define RMR_EL3_RR_BIT		(U(1) << 1)
617 #define RMR_EL3_AA64_BIT	(U(1) << 0)
618 
619 /*
620  * HI-VECTOR address for AArch32 state
621  */
622 #define HI_VECTOR_BASE		U(0xFFFF0000)
623 
624 /*
625  * TCR defintions
626  */
627 #define TCR_EL3_RES1		((ULL(1) << 31) | (ULL(1) << 23))
628 #define TCR_EL2_RES1		((ULL(1) << 31) | (ULL(1) << 23))
629 #define TCR_EL1_IPS_SHIFT	U(32)
630 #define TCR_EL2_PS_SHIFT	U(16)
631 #define TCR_EL3_PS_SHIFT	U(16)
632 
633 #define TCR_TxSZ_MIN		ULL(16)
634 #define TCR_TxSZ_MAX		ULL(39)
635 #define TCR_TxSZ_MAX_TTST	ULL(48)
636 
637 #define TCR_T0SZ_SHIFT		U(0)
638 #define TCR_T1SZ_SHIFT		U(16)
639 
640 /* (internal) physical address size bits in EL3/EL1 */
641 #define TCR_PS_BITS_4GB		ULL(0x0)
642 #define TCR_PS_BITS_64GB	ULL(0x1)
643 #define TCR_PS_BITS_1TB		ULL(0x2)
644 #define TCR_PS_BITS_4TB		ULL(0x3)
645 #define TCR_PS_BITS_16TB	ULL(0x4)
646 #define TCR_PS_BITS_256TB	ULL(0x5)
647 
648 #define ADDR_MASK_48_TO_63	ULL(0xFFFF000000000000)
649 #define ADDR_MASK_44_TO_47	ULL(0x0000F00000000000)
650 #define ADDR_MASK_42_TO_43	ULL(0x00000C0000000000)
651 #define ADDR_MASK_40_TO_41	ULL(0x0000030000000000)
652 #define ADDR_MASK_36_TO_39	ULL(0x000000F000000000)
653 #define ADDR_MASK_32_TO_35	ULL(0x0000000F00000000)
654 
655 #define TCR_RGN_INNER_NC	(ULL(0x0) << 8)
656 #define TCR_RGN_INNER_WBA	(ULL(0x1) << 8)
657 #define TCR_RGN_INNER_WT	(ULL(0x2) << 8)
658 #define TCR_RGN_INNER_WBNA	(ULL(0x3) << 8)
659 
660 #define TCR_RGN_OUTER_NC	(ULL(0x0) << 10)
661 #define TCR_RGN_OUTER_WBA	(ULL(0x1) << 10)
662 #define TCR_RGN_OUTER_WT	(ULL(0x2) << 10)
663 #define TCR_RGN_OUTER_WBNA	(ULL(0x3) << 10)
664 
665 #define TCR_SH_NON_SHAREABLE	(ULL(0x0) << 12)
666 #define TCR_SH_OUTER_SHAREABLE	(ULL(0x2) << 12)
667 #define TCR_SH_INNER_SHAREABLE	(ULL(0x3) << 12)
668 
669 #define TCR_RGN1_INNER_NC	(ULL(0x0) << 24)
670 #define TCR_RGN1_INNER_WBA	(ULL(0x1) << 24)
671 #define TCR_RGN1_INNER_WT	(ULL(0x2) << 24)
672 #define TCR_RGN1_INNER_WBNA	(ULL(0x3) << 24)
673 
674 #define TCR_RGN1_OUTER_NC	(ULL(0x0) << 26)
675 #define TCR_RGN1_OUTER_WBA	(ULL(0x1) << 26)
676 #define TCR_RGN1_OUTER_WT	(ULL(0x2) << 26)
677 #define TCR_RGN1_OUTER_WBNA	(ULL(0x3) << 26)
678 
679 #define TCR_SH1_NON_SHAREABLE	(ULL(0x0) << 28)
680 #define TCR_SH1_OUTER_SHAREABLE	(ULL(0x2) << 28)
681 #define TCR_SH1_INNER_SHAREABLE	(ULL(0x3) << 28)
682 
683 #define TCR_TG0_SHIFT		U(14)
684 #define TCR_TG0_MASK		ULL(3)
685 #define TCR_TG0_4K		(ULL(0) << TCR_TG0_SHIFT)
686 #define TCR_TG0_64K		(ULL(1) << TCR_TG0_SHIFT)
687 #define TCR_TG0_16K		(ULL(2) << TCR_TG0_SHIFT)
688 
689 #define TCR_TG1_SHIFT		U(30)
690 #define TCR_TG1_MASK		ULL(3)
691 #define TCR_TG1_16K		(ULL(1) << TCR_TG1_SHIFT)
692 #define TCR_TG1_4K		(ULL(2) << TCR_TG1_SHIFT)
693 #define TCR_TG1_64K		(ULL(3) << TCR_TG1_SHIFT)
694 
695 #define TCR_EPD0_BIT		(ULL(1) << 7)
696 #define TCR_EPD1_BIT		(ULL(1) << 23)
697 
698 #define MODE_SP_SHIFT		U(0x0)
699 #define MODE_SP_MASK		U(0x1)
700 #define MODE_SP_EL0		U(0x0)
701 #define MODE_SP_ELX		U(0x1)
702 
703 #define MODE_RW_SHIFT		U(0x4)
704 #define MODE_RW_MASK		U(0x1)
705 #define MODE_RW_64		U(0x0)
706 #define MODE_RW_32		U(0x1)
707 
708 #define MODE_EL_SHIFT		U(0x2)
709 #define MODE_EL_MASK		U(0x3)
710 #define MODE_EL_WIDTH		U(0x2)
711 #define MODE_EL3		U(0x3)
712 #define MODE_EL2		U(0x2)
713 #define MODE_EL1		U(0x1)
714 #define MODE_EL0		U(0x0)
715 
716 #define MODE32_SHIFT		U(0)
717 #define MODE32_MASK		U(0xf)
718 #define MODE32_usr		U(0x0)
719 #define MODE32_fiq		U(0x1)
720 #define MODE32_irq		U(0x2)
721 #define MODE32_svc		U(0x3)
722 #define MODE32_mon		U(0x6)
723 #define MODE32_abt		U(0x7)
724 #define MODE32_hyp		U(0xa)
725 #define MODE32_und		U(0xb)
726 #define MODE32_sys		U(0xf)
727 
728 #define GET_RW(mode)		(((mode) >> MODE_RW_SHIFT) & MODE_RW_MASK)
729 #define GET_EL(mode)		(((mode) >> MODE_EL_SHIFT) & MODE_EL_MASK)
730 #define GET_SP(mode)		(((mode) >> MODE_SP_SHIFT) & MODE_SP_MASK)
731 #define GET_M32(mode)		(((mode) >> MODE32_SHIFT) & MODE32_MASK)
732 
733 #define SPSR_64(el, sp, daif)					\
734 	(((MODE_RW_64 << MODE_RW_SHIFT) |			\
735 	(((el) & MODE_EL_MASK) << MODE_EL_SHIFT) |		\
736 	(((sp) & MODE_SP_MASK) << MODE_SP_SHIFT) |		\
737 	(((daif) & SPSR_DAIF_MASK) << SPSR_DAIF_SHIFT)) &	\
738 	(~(SPSR_SSBS_BIT_AARCH64)))
739 
740 #define SPSR_MODE32(mode, isa, endian, aif)		\
741 	(((MODE_RW_32 << MODE_RW_SHIFT) |		\
742 	(((mode) & MODE32_MASK) << MODE32_SHIFT) |	\
743 	(((isa) & SPSR_T_MASK) << SPSR_T_SHIFT) |	\
744 	(((endian) & SPSR_E_MASK) << SPSR_E_SHIFT) |	\
745 	(((aif) & SPSR_AIF_MASK) << SPSR_AIF_SHIFT)) &	\
746 	(~(SPSR_SSBS_BIT_AARCH32)))
747 
748 /*
749  * TTBR Definitions
750  */
751 #define TTBR_CNP_BIT		ULL(0x1)
752 
753 /*
754  * CTR_EL0 definitions
755  */
756 #define CTR_CWG_SHIFT		U(24)
757 #define CTR_CWG_MASK		U(0xf)
758 #define CTR_ERG_SHIFT		U(20)
759 #define CTR_ERG_MASK		U(0xf)
760 #define CTR_DMINLINE_SHIFT	U(16)
761 #define CTR_DMINLINE_MASK	U(0xf)
762 #define CTR_L1IP_SHIFT		U(14)
763 #define CTR_L1IP_MASK		U(0x3)
764 #define CTR_IMINLINE_SHIFT	U(0)
765 #define CTR_IMINLINE_MASK	U(0xf)
766 
767 #define MAX_CACHE_LINE_SIZE	U(0x800) /* 2KB */
768 
769 /* Physical timer control register bit fields shifts and masks */
770 #define CNTP_CTL_ENABLE_SHIFT	U(0)
771 #define CNTP_CTL_IMASK_SHIFT	U(1)
772 #define CNTP_CTL_ISTATUS_SHIFT	U(2)
773 
774 #define CNTP_CTL_ENABLE_MASK	U(1)
775 #define CNTP_CTL_IMASK_MASK	U(1)
776 #define CNTP_CTL_ISTATUS_MASK	U(1)
777 
778 /* Physical timer control macros */
779 #define CNTP_CTL_ENABLE_BIT	(U(1) << CNTP_CTL_ENABLE_SHIFT)
780 #define CNTP_CTL_IMASK_BIT	(U(1) << CNTP_CTL_IMASK_SHIFT)
781 
782 /* Exception Syndrome register bits and bobs */
783 #define ESR_EC_SHIFT			U(26)
784 #define ESR_EC_MASK			U(0x3f)
785 #define ESR_EC_LENGTH			U(6)
786 #define ESR_ISS_SHIFT			U(0)
787 #define ESR_ISS_LENGTH			U(25)
788 #define EC_UNKNOWN			U(0x0)
789 #define EC_WFE_WFI			U(0x1)
790 #define EC_AARCH32_CP15_MRC_MCR		U(0x3)
791 #define EC_AARCH32_CP15_MRRC_MCRR	U(0x4)
792 #define EC_AARCH32_CP14_MRC_MCR		U(0x5)
793 #define EC_AARCH32_CP14_LDC_STC		U(0x6)
794 #define EC_FP_SIMD			U(0x7)
795 #define EC_AARCH32_CP10_MRC		U(0x8)
796 #define EC_AARCH32_CP14_MRRC_MCRR	U(0xc)
797 #define EC_ILLEGAL			U(0xe)
798 #define EC_AARCH32_SVC			U(0x11)
799 #define EC_AARCH32_HVC			U(0x12)
800 #define EC_AARCH32_SMC			U(0x13)
801 #define EC_AARCH64_SVC			U(0x15)
802 #define EC_AARCH64_HVC			U(0x16)
803 #define EC_AARCH64_SMC			U(0x17)
804 #define EC_AARCH64_SYS			U(0x18)
805 #define EC_IABORT_LOWER_EL		U(0x20)
806 #define EC_IABORT_CUR_EL		U(0x21)
807 #define EC_PC_ALIGN			U(0x22)
808 #define EC_DABORT_LOWER_EL		U(0x24)
809 #define EC_DABORT_CUR_EL		U(0x25)
810 #define EC_SP_ALIGN			U(0x26)
811 #define EC_AARCH32_FP			U(0x28)
812 #define EC_AARCH64_FP			U(0x2c)
813 #define EC_SERROR			U(0x2f)
814 #define EC_BRK				U(0x3c)
815 
816 /*
817  * External Abort bit in Instruction and Data Aborts synchronous exception
818  * syndromes.
819  */
820 #define ESR_ISS_EABORT_EA_BIT		U(9)
821 
822 #define EC_BITS(x)			(((x) >> ESR_EC_SHIFT) & ESR_EC_MASK)
823 
824 /* Reset bit inside the Reset management register for EL3 (RMR_EL3) */
825 #define RMR_RESET_REQUEST_SHIFT 	U(0x1)
826 #define RMR_WARM_RESET_CPU		(U(1) << RMR_RESET_REQUEST_SHIFT)
827 
828 /*******************************************************************************
829  * Definitions of register offsets, fields and macros for CPU system
830  * instructions.
831  ******************************************************************************/
832 
833 #define TLBI_ADDR_SHIFT		U(12)
834 #define TLBI_ADDR_MASK		ULL(0x00000FFFFFFFFFFF)
835 #define TLBI_ADDR(x)		(((x) >> TLBI_ADDR_SHIFT) & TLBI_ADDR_MASK)
836 
837 /*******************************************************************************
838  * Definitions of register offsets and fields in the CNTCTLBase Frame of the
839  * system level implementation of the Generic Timer.
840  ******************************************************************************/
841 #define CNTCTLBASE_CNTFRQ	U(0x0)
842 #define CNTNSAR			U(0x4)
843 #define CNTNSAR_NS_SHIFT(x)	(x)
844 
845 #define CNTACR_BASE(x)		(U(0x40) + ((x) << 2))
846 #define CNTACR_RPCT_SHIFT	U(0x0)
847 #define CNTACR_RVCT_SHIFT	U(0x1)
848 #define CNTACR_RFRQ_SHIFT	U(0x2)
849 #define CNTACR_RVOFF_SHIFT	U(0x3)
850 #define CNTACR_RWVT_SHIFT	U(0x4)
851 #define CNTACR_RWPT_SHIFT	U(0x5)
852 
853 /*******************************************************************************
854  * Definitions of register offsets and fields in the CNTBaseN Frame of the
855  * system level implementation of the Generic Timer.
856  ******************************************************************************/
857 /* Physical Count register. */
858 #define CNTPCT_LO		U(0x0)
859 /* Counter Frequency register. */
860 #define CNTBASEN_CNTFRQ		U(0x10)
861 /* Physical Timer CompareValue register. */
862 #define CNTP_CVAL_LO		U(0x20)
863 /* Physical Timer Control register. */
864 #define CNTP_CTL		U(0x2c)
865 
866 /* PMCR_EL0 definitions */
867 #define PMCR_EL0_RESET_VAL	U(0x0)
868 #define PMCR_EL0_N_SHIFT	U(11)
869 #define PMCR_EL0_N_MASK		U(0x1f)
870 #define PMCR_EL0_N_BITS		(PMCR_EL0_N_MASK << PMCR_EL0_N_SHIFT)
871 #define PMCR_EL0_LP_BIT		(U(1) << 7)
872 #define PMCR_EL0_LC_BIT		(U(1) << 6)
873 #define PMCR_EL0_DP_BIT		(U(1) << 5)
874 #define PMCR_EL0_X_BIT		(U(1) << 4)
875 #define PMCR_EL0_D_BIT		(U(1) << 3)
876 #define PMCR_EL0_C_BIT		(U(1) << 2)
877 #define PMCR_EL0_P_BIT		(U(1) << 1)
878 #define PMCR_EL0_E_BIT		(U(1) << 0)
879 
880 /*******************************************************************************
881  * Definitions for system register interface to SVE
882  ******************************************************************************/
883 #define ZCR_EL3			S3_6_C1_C2_0
884 #define ZCR_EL2			S3_4_C1_C2_0
885 
886 /* ZCR_EL3 definitions */
887 #define ZCR_EL3_LEN_MASK	U(0xf)
888 
889 /* ZCR_EL2 definitions */
890 #define ZCR_EL2_LEN_MASK	U(0xf)
891 
892 /*******************************************************************************
893  * Definitions of MAIR encodings for device and normal memory
894  ******************************************************************************/
895 /*
896  * MAIR encodings for device memory attributes.
897  */
898 #define MAIR_DEV_nGnRnE		ULL(0x0)
899 #define MAIR_DEV_nGnRE		ULL(0x4)
900 #define MAIR_DEV_nGRE		ULL(0x8)
901 #define MAIR_DEV_GRE		ULL(0xc)
902 
903 /*
904  * MAIR encodings for normal memory attributes.
905  *
906  * Cache Policy
907  *  WT:	 Write Through
908  *  WB:	 Write Back
909  *  NC:	 Non-Cacheable
910  *
911  * Transient Hint
912  *  NTR: Non-Transient
913  *  TR:	 Transient
914  *
915  * Allocation Policy
916  *  RA:	 Read Allocate
917  *  WA:	 Write Allocate
918  *  RWA: Read and Write Allocate
919  *  NA:	 No Allocation
920  */
921 #define MAIR_NORM_WT_TR_WA	ULL(0x1)
922 #define MAIR_NORM_WT_TR_RA	ULL(0x2)
923 #define MAIR_NORM_WT_TR_RWA	ULL(0x3)
924 #define MAIR_NORM_NC		ULL(0x4)
925 #define MAIR_NORM_WB_TR_WA	ULL(0x5)
926 #define MAIR_NORM_WB_TR_RA	ULL(0x6)
927 #define MAIR_NORM_WB_TR_RWA	ULL(0x7)
928 #define MAIR_NORM_WT_NTR_NA	ULL(0x8)
929 #define MAIR_NORM_WT_NTR_WA	ULL(0x9)
930 #define MAIR_NORM_WT_NTR_RA	ULL(0xa)
931 #define MAIR_NORM_WT_NTR_RWA	ULL(0xb)
932 #define MAIR_NORM_WB_NTR_NA	ULL(0xc)
933 #define MAIR_NORM_WB_NTR_WA	ULL(0xd)
934 #define MAIR_NORM_WB_NTR_RA	ULL(0xe)
935 #define MAIR_NORM_WB_NTR_RWA	ULL(0xf)
936 
937 #define MAIR_NORM_OUTER_SHIFT	U(4)
938 
939 #define MAKE_MAIR_NORMAL_MEMORY(inner, outer)	\
940 		((inner) | ((outer) << MAIR_NORM_OUTER_SHIFT))
941 
942 /* PAR_EL1 fields */
943 #define PAR_F_SHIFT	U(0)
944 #define PAR_F_MASK	ULL(0x1)
945 #define PAR_ADDR_SHIFT	U(12)
946 #define PAR_ADDR_MASK	(BIT(40) - ULL(1)) /* 40-bits-wide page address */
947 
948 /*******************************************************************************
949  * Definitions for system register interface to SPE
950  ******************************************************************************/
951 #define PMBLIMITR_EL1		S3_0_C9_C10_0
952 
953 /*******************************************************************************
954  * Definitions for system register interface to MPAM
955  ******************************************************************************/
956 #define MPAMIDR_EL1		S3_0_C10_C4_4
957 #define MPAM2_EL2		S3_4_C10_C5_0
958 #define MPAMHCR_EL2		S3_4_C10_C4_0
959 #define MPAM3_EL3		S3_6_C10_C5_0
960 
961 /*******************************************************************************
962  * Definitions for system register interface to AMU for FEAT_AMUv1
963  ******************************************************************************/
964 #define AMCR_EL0		S3_3_C13_C2_0
965 #define AMCFGR_EL0		S3_3_C13_C2_1
966 #define AMCGCR_EL0		S3_3_C13_C2_2
967 #define AMUSERENR_EL0		S3_3_C13_C2_3
968 #define AMCNTENCLR0_EL0		S3_3_C13_C2_4
969 #define AMCNTENSET0_EL0		S3_3_C13_C2_5
970 #define AMCNTENCLR1_EL0		S3_3_C13_C3_0
971 #define AMCNTENSET1_EL0		S3_3_C13_C3_1
972 
973 /* Activity Monitor Group 0 Event Counter Registers */
974 #define AMEVCNTR00_EL0		S3_3_C13_C4_0
975 #define AMEVCNTR01_EL0		S3_3_C13_C4_1
976 #define AMEVCNTR02_EL0		S3_3_C13_C4_2
977 #define AMEVCNTR03_EL0		S3_3_C13_C4_3
978 
979 /* Activity Monitor Group 0 Event Type Registers */
980 #define AMEVTYPER00_EL0		S3_3_C13_C6_0
981 #define AMEVTYPER01_EL0		S3_3_C13_C6_1
982 #define AMEVTYPER02_EL0		S3_3_C13_C6_2
983 #define AMEVTYPER03_EL0		S3_3_C13_C6_3
984 
985 /* Activity Monitor Group 1 Event Counter Registers */
986 #define AMEVCNTR10_EL0		S3_3_C13_C12_0
987 #define AMEVCNTR11_EL0		S3_3_C13_C12_1
988 #define AMEVCNTR12_EL0		S3_3_C13_C12_2
989 #define AMEVCNTR13_EL0		S3_3_C13_C12_3
990 #define AMEVCNTR14_EL0		S3_3_C13_C12_4
991 #define AMEVCNTR15_EL0		S3_3_C13_C12_5
992 #define AMEVCNTR16_EL0		S3_3_C13_C12_6
993 #define AMEVCNTR17_EL0		S3_3_C13_C12_7
994 #define AMEVCNTR18_EL0		S3_3_C13_C13_0
995 #define AMEVCNTR19_EL0		S3_3_C13_C13_1
996 #define AMEVCNTR1A_EL0		S3_3_C13_C13_2
997 #define AMEVCNTR1B_EL0		S3_3_C13_C13_3
998 #define AMEVCNTR1C_EL0		S3_3_C13_C13_4
999 #define AMEVCNTR1D_EL0		S3_3_C13_C13_5
1000 #define AMEVCNTR1E_EL0		S3_3_C13_C13_6
1001 #define AMEVCNTR1F_EL0		S3_3_C13_C13_7
1002 
1003 /* Activity Monitor Group 1 Event Type Registers */
1004 #define AMEVTYPER10_EL0		S3_3_C13_C14_0
1005 #define AMEVTYPER11_EL0		S3_3_C13_C14_1
1006 #define AMEVTYPER12_EL0		S3_3_C13_C14_2
1007 #define AMEVTYPER13_EL0		S3_3_C13_C14_3
1008 #define AMEVTYPER14_EL0		S3_3_C13_C14_4
1009 #define AMEVTYPER15_EL0		S3_3_C13_C14_5
1010 #define AMEVTYPER16_EL0		S3_3_C13_C14_6
1011 #define AMEVTYPER17_EL0		S3_3_C13_C14_7
1012 #define AMEVTYPER18_EL0		S3_3_C13_C15_0
1013 #define AMEVTYPER19_EL0		S3_3_C13_C15_1
1014 #define AMEVTYPER1A_EL0		S3_3_C13_C15_2
1015 #define AMEVTYPER1B_EL0		S3_3_C13_C15_3
1016 #define AMEVTYPER1C_EL0		S3_3_C13_C15_4
1017 #define AMEVTYPER1D_EL0		S3_3_C13_C15_5
1018 #define AMEVTYPER1E_EL0		S3_3_C13_C15_6
1019 #define AMEVTYPER1F_EL0		S3_3_C13_C15_7
1020 
1021 /* AMCFGR_EL0 definitions */
1022 #define AMCFGR_EL0_NCG_SHIFT	U(28)
1023 #define AMCFGR_EL0_NCG_MASK	U(0xf)
1024 #define AMCFGR_EL0_N_SHIFT	U(0)
1025 #define AMCFGR_EL0_N_MASK	U(0xff)
1026 
1027 /* AMCGCR_EL0 definitions */
1028 #define AMCGCR_EL0_CG1NC_SHIFT	U(8)
1029 #define AMCGCR_EL0_CG1NC_MASK	U(0xff)
1030 
1031 /* MPAM register definitions */
1032 #define MPAM3_EL3_MPAMEN_BIT		(ULL(1) << 63)
1033 #define MPAMHCR_EL2_TRAP_MPAMIDR_EL1	(ULL(1) << 31)
1034 
1035 #define MPAM2_EL2_TRAPMPAM0EL1		(ULL(1) << 49)
1036 #define MPAM2_EL2_TRAPMPAM1EL1		(ULL(1) << 48)
1037 
1038 #define MPAMIDR_HAS_HCR_BIT		(ULL(1) << 17)
1039 
1040 /*******************************************************************************
1041  * Definitions for system register interface to AMU for FEAT_AMUv1p1
1042  ******************************************************************************/
1043 
1044 /* Definition for register defining which virtual offsets are implemented. */
1045 #define AMCG1IDR_EL0		S3_3_C13_C2_6
1046 #define AMCG1IDR_CTR_MASK	ULL(0xffff)
1047 #define AMCG1IDR_CTR_SHIFT	U(0)
1048 #define AMCG1IDR_VOFF_MASK	ULL(0xffff)
1049 #define AMCG1IDR_VOFF_SHIFT	U(16)
1050 
1051 /* New bit added to AMCR_EL0 */
1052 #define AMCR_CG1RZ_BIT		(ULL(0x1) << 17)
1053 
1054 /*
1055  * Definitions for virtual offset registers for architected activity monitor
1056  * event counters.
1057  * AMEVCNTVOFF01_EL2 intentionally left undefined, as it does not exist.
1058  */
1059 #define AMEVCNTVOFF00_EL2	S3_4_C13_C8_0
1060 #define AMEVCNTVOFF02_EL2	S3_4_C13_C8_2
1061 #define AMEVCNTVOFF03_EL2	S3_4_C13_C8_3
1062 
1063 /*
1064  * Definitions for virtual offset registers for auxiliary activity monitor event
1065  * counters.
1066  */
1067 #define AMEVCNTVOFF10_EL2	S3_4_C13_C10_0
1068 #define AMEVCNTVOFF11_EL2	S3_4_C13_C10_1
1069 #define AMEVCNTVOFF12_EL2	S3_4_C13_C10_2
1070 #define AMEVCNTVOFF13_EL2	S3_4_C13_C10_3
1071 #define AMEVCNTVOFF14_EL2	S3_4_C13_C10_4
1072 #define AMEVCNTVOFF15_EL2	S3_4_C13_C10_5
1073 #define AMEVCNTVOFF16_EL2	S3_4_C13_C10_6
1074 #define AMEVCNTVOFF17_EL2	S3_4_C13_C10_7
1075 #define AMEVCNTVOFF18_EL2	S3_4_C13_C11_0
1076 #define AMEVCNTVOFF19_EL2	S3_4_C13_C11_1
1077 #define AMEVCNTVOFF1A_EL2	S3_4_C13_C11_2
1078 #define AMEVCNTVOFF1B_EL2	S3_4_C13_C11_3
1079 #define AMEVCNTVOFF1C_EL2	S3_4_C13_C11_4
1080 #define AMEVCNTVOFF1D_EL2	S3_4_C13_C11_5
1081 #define AMEVCNTVOFF1E_EL2	S3_4_C13_C11_6
1082 #define AMEVCNTVOFF1F_EL2	S3_4_C13_C11_7
1083 
1084 /*******************************************************************************
1085  * RAS system registers
1086  ******************************************************************************/
1087 #define DISR_EL1		S3_0_C12_C1_1
1088 #define DISR_A_BIT		U(31)
1089 
1090 #define ERRIDR_EL1		S3_0_C5_C3_0
1091 #define ERRIDR_MASK		U(0xffff)
1092 
1093 #define ERRSELR_EL1		S3_0_C5_C3_1
1094 
1095 /* System register access to Standard Error Record registers */
1096 #define ERXFR_EL1		S3_0_C5_C4_0
1097 #define ERXCTLR_EL1		S3_0_C5_C4_1
1098 #define ERXSTATUS_EL1		S3_0_C5_C4_2
1099 #define ERXADDR_EL1		S3_0_C5_C4_3
1100 #define ERXPFGF_EL1		S3_0_C5_C4_4
1101 #define ERXPFGCTL_EL1		S3_0_C5_C4_5
1102 #define ERXPFGCDN_EL1		S3_0_C5_C4_6
1103 #define ERXMISC0_EL1		S3_0_C5_C5_0
1104 #define ERXMISC1_EL1		S3_0_C5_C5_1
1105 
1106 #define ERXCTLR_ED_BIT		(U(1) << 0)
1107 #define ERXCTLR_UE_BIT		(U(1) << 4)
1108 
1109 #define ERXPFGCTL_UC_BIT	(U(1) << 1)
1110 #define ERXPFGCTL_UEU_BIT	(U(1) << 2)
1111 #define ERXPFGCTL_CDEN_BIT	(U(1) << 31)
1112 
1113 /*******************************************************************************
1114  * Armv8.3 Pointer Authentication Registers
1115  ******************************************************************************/
1116 #define APIAKeyLo_EL1		S3_0_C2_C1_0
1117 #define APIAKeyHi_EL1		S3_0_C2_C1_1
1118 #define APIBKeyLo_EL1		S3_0_C2_C1_2
1119 #define APIBKeyHi_EL1		S3_0_C2_C1_3
1120 #define APDAKeyLo_EL1		S3_0_C2_C2_0
1121 #define APDAKeyHi_EL1		S3_0_C2_C2_1
1122 #define APDBKeyLo_EL1		S3_0_C2_C2_2
1123 #define APDBKeyHi_EL1		S3_0_C2_C2_3
1124 #define APGAKeyLo_EL1		S3_0_C2_C3_0
1125 #define APGAKeyHi_EL1		S3_0_C2_C3_1
1126 
1127 /*******************************************************************************
1128  * Armv8.4 Data Independent Timing Registers
1129  ******************************************************************************/
1130 #define DIT			S3_3_C4_C2_5
1131 #define DIT_BIT			BIT(24)
1132 
1133 /*******************************************************************************
1134  * Armv8.5 - new MSR encoding to directly access PSTATE.SSBS field
1135  ******************************************************************************/
1136 #define SSBS			S3_3_C4_C2_6
1137 
1138 /*******************************************************************************
1139  * Armv8.5 - Memory Tagging Extension Registers
1140  ******************************************************************************/
1141 #define TFSRE0_EL1		S3_0_C5_C6_1
1142 #define TFSR_EL1		S3_0_C5_C6_0
1143 #define RGSR_EL1		S3_0_C1_C0_5
1144 #define GCR_EL1			S3_0_C1_C0_6
1145 
1146 /*******************************************************************************
1147  * Definitions for DynamicIQ Shared Unit registers
1148  ******************************************************************************/
1149 #define CLUSTERPWRDN_EL1	S3_0_c15_c3_6
1150 
1151 /* CLUSTERPWRDN_EL1 register definitions */
1152 #define DSU_CLUSTER_PWR_OFF	0
1153 #define DSU_CLUSTER_PWR_ON	1
1154 #define DSU_CLUSTER_PWR_MASK	U(1)
1155 
1156 #endif /* ARCH_H */
1157