xref: /rk3399_ARM-atf/include/arch/aarch64/arch.h (revision 5cc8c7ba1b24ace2ef7345e96d933141f3609817)
1 /*
2  * Copyright (c) 2013-2019, ARM Limited and Contributors. All rights reserved.
3  *
4  * SPDX-License-Identifier: BSD-3-Clause
5  */
6 
7 #ifndef ARCH_H
8 #define ARCH_H
9 
10 #include <lib/utils_def.h>
11 
12 /*******************************************************************************
13  * MIDR bit definitions
14  ******************************************************************************/
15 #define MIDR_IMPL_MASK		U(0xff)
16 #define MIDR_IMPL_SHIFT		U(0x18)
17 #define MIDR_VAR_SHIFT		U(20)
18 #define MIDR_VAR_BITS		U(4)
19 #define MIDR_VAR_MASK		U(0xf)
20 #define MIDR_REV_SHIFT		U(0)
21 #define MIDR_REV_BITS		U(4)
22 #define MIDR_REV_MASK		U(0xf)
23 #define MIDR_PN_MASK		U(0xfff)
24 #define MIDR_PN_SHIFT		U(0x4)
25 
26 /*******************************************************************************
27  * MPIDR macros
28  ******************************************************************************/
29 #define MPIDR_MT_MASK		(ULL(1) << 24)
30 #define MPIDR_CPU_MASK		MPIDR_AFFLVL_MASK
31 #define MPIDR_CLUSTER_MASK	(MPIDR_AFFLVL_MASK << MPIDR_AFFINITY_BITS)
32 #define MPIDR_AFFINITY_BITS	U(8)
33 #define MPIDR_AFFLVL_MASK	ULL(0xff)
34 #define MPIDR_AFF0_SHIFT	U(0)
35 #define MPIDR_AFF1_SHIFT	U(8)
36 #define MPIDR_AFF2_SHIFT	U(16)
37 #define MPIDR_AFF3_SHIFT	U(32)
38 #define MPIDR_AFF_SHIFT(_n)	MPIDR_AFF##_n##_SHIFT
39 #define MPIDR_AFFINITY_MASK	ULL(0xff00ffffff)
40 #define MPIDR_AFFLVL_SHIFT	U(3)
41 #define MPIDR_AFFLVL0		ULL(0x0)
42 #define MPIDR_AFFLVL1		ULL(0x1)
43 #define MPIDR_AFFLVL2		ULL(0x2)
44 #define MPIDR_AFFLVL3		ULL(0x3)
45 #define MPIDR_AFFLVL(_n)	MPIDR_AFFLVL##_n
46 #define MPIDR_AFFLVL0_VAL(mpidr) \
47 		(((mpidr) >> MPIDR_AFF0_SHIFT) & MPIDR_AFFLVL_MASK)
48 #define MPIDR_AFFLVL1_VAL(mpidr) \
49 		(((mpidr) >> MPIDR_AFF1_SHIFT) & MPIDR_AFFLVL_MASK)
50 #define MPIDR_AFFLVL2_VAL(mpidr) \
51 		(((mpidr) >> MPIDR_AFF2_SHIFT) & MPIDR_AFFLVL_MASK)
52 #define MPIDR_AFFLVL3_VAL(mpidr) \
53 		(((mpidr) >> MPIDR_AFF3_SHIFT) & MPIDR_AFFLVL_MASK)
54 /*
55  * The MPIDR_MAX_AFFLVL count starts from 0. Take care to
56  * add one while using this macro to define array sizes.
57  * TODO: Support only the first 3 affinity levels for now.
58  */
59 #define MPIDR_MAX_AFFLVL	U(2)
60 
61 #define MPID_MASK		(MPIDR_MT_MASK				 | \
62 				 (MPIDR_AFFLVL_MASK << MPIDR_AFF3_SHIFT) | \
63 				 (MPIDR_AFFLVL_MASK << MPIDR_AFF2_SHIFT) | \
64 				 (MPIDR_AFFLVL_MASK << MPIDR_AFF1_SHIFT) | \
65 				 (MPIDR_AFFLVL_MASK << MPIDR_AFF0_SHIFT))
66 
67 #define MPIDR_AFF_ID(mpid, n)					\
68 	(((mpid) >> MPIDR_AFF_SHIFT(n)) & MPIDR_AFFLVL_MASK)
69 
70 /*
71  * An invalid MPID. This value can be used by functions that return an MPID to
72  * indicate an error.
73  */
74 #define INVALID_MPID		U(0xFFFFFFFF)
75 
76 /*******************************************************************************
77  * Definitions for CPU system register interface to GICv3
78  ******************************************************************************/
79 #define ICC_IGRPEN1_EL1		S3_0_C12_C12_7
80 #define ICC_SGI1R		S3_0_C12_C11_5
81 #define ICC_SRE_EL1		S3_0_C12_C12_5
82 #define ICC_SRE_EL2		S3_4_C12_C9_5
83 #define ICC_SRE_EL3		S3_6_C12_C12_5
84 #define ICC_CTLR_EL1		S3_0_C12_C12_4
85 #define ICC_CTLR_EL3		S3_6_C12_C12_4
86 #define ICC_PMR_EL1		S3_0_C4_C6_0
87 #define ICC_RPR_EL1		S3_0_C12_C11_3
88 #define ICC_IGRPEN1_EL3		S3_6_c12_c12_7
89 #define ICC_IGRPEN0_EL1		S3_0_c12_c12_6
90 #define ICC_HPPIR0_EL1		S3_0_c12_c8_2
91 #define ICC_HPPIR1_EL1		S3_0_c12_c12_2
92 #define ICC_IAR0_EL1		S3_0_c12_c8_0
93 #define ICC_IAR1_EL1		S3_0_c12_c12_0
94 #define ICC_EOIR0_EL1		S3_0_c12_c8_1
95 #define ICC_EOIR1_EL1		S3_0_c12_c12_1
96 #define ICC_SGI0R_EL1		S3_0_c12_c11_7
97 
98 /*******************************************************************************
99  * Generic timer memory mapped registers & offsets
100  ******************************************************************************/
101 #define CNTCR_OFF			U(0x000)
102 #define CNTFID_OFF			U(0x020)
103 
104 #define CNTCR_EN			(U(1) << 0)
105 #define CNTCR_HDBG			(U(1) << 1)
106 #define CNTCR_FCREQ(x)			((x) << 8)
107 
108 /*******************************************************************************
109  * System register bit definitions
110  ******************************************************************************/
111 /* CLIDR definitions */
112 #define LOUIS_SHIFT		U(21)
113 #define LOC_SHIFT		U(24)
114 #define CLIDR_FIELD_WIDTH	U(3)
115 
116 /* CSSELR definitions */
117 #define LEVEL_SHIFT		U(1)
118 
119 /* Data cache set/way op type defines */
120 #define DCISW			U(0x0)
121 #define DCCISW			U(0x1)
122 #define DCCSW			U(0x2)
123 
124 /* ID_AA64PFR0_EL1 definitions */
125 #define ID_AA64PFR0_EL0_SHIFT	U(0)
126 #define ID_AA64PFR0_EL1_SHIFT	U(4)
127 #define ID_AA64PFR0_EL2_SHIFT	U(8)
128 #define ID_AA64PFR0_EL3_SHIFT	U(12)
129 #define ID_AA64PFR0_AMU_SHIFT	U(44)
130 #define ID_AA64PFR0_AMU_LENGTH	U(4)
131 #define ID_AA64PFR0_AMU_MASK	ULL(0xf)
132 #define ID_AA64PFR0_ELX_MASK	ULL(0xf)
133 #define ID_AA64PFR0_SVE_SHIFT	U(32)
134 #define ID_AA64PFR0_SVE_MASK	ULL(0xf)
135 #define ID_AA64PFR0_SVE_LENGTH	U(4)
136 #define ID_AA64PFR0_MPAM_SHIFT	U(40)
137 #define ID_AA64PFR0_MPAM_MASK	ULL(0xf)
138 #define ID_AA64PFR0_DIT_SHIFT	U(48)
139 #define ID_AA64PFR0_DIT_MASK	ULL(0xf)
140 #define ID_AA64PFR0_DIT_LENGTH	U(4)
141 #define ID_AA64PFR0_DIT_SUPPORTED	U(1)
142 #define ID_AA64PFR0_CSV2_SHIFT	U(56)
143 #define ID_AA64PFR0_CSV2_MASK	ULL(0xf)
144 #define ID_AA64PFR0_CSV2_LENGTH	U(4)
145 
146 /* ID_AA64DFR0_EL1.PMS definitions (for ARMv8.2+) */
147 #define ID_AA64DFR0_PMS_SHIFT	U(32)
148 #define ID_AA64DFR0_PMS_LENGTH	U(4)
149 #define ID_AA64DFR0_PMS_MASK	ULL(0xf)
150 
151 #define EL_IMPL_NONE		ULL(0)
152 #define EL_IMPL_A64ONLY		ULL(1)
153 #define EL_IMPL_A64_A32		ULL(2)
154 
155 #define ID_AA64PFR0_GIC_SHIFT	U(24)
156 #define ID_AA64PFR0_GIC_WIDTH	U(4)
157 #define ID_AA64PFR0_GIC_MASK	((ULL(1) << ID_AA64PFR0_GIC_WIDTH) - ULL(1))
158 
159 /* ID_AA64ISAR1_EL1 definitions */
160 #define ID_AA64ISAR1_GPI_SHIFT	U(28)
161 #define ID_AA64ISAR1_GPI_WIDTH	U(4)
162 #define ID_AA64ISAR1_GPA_SHIFT	U(24)
163 #define ID_AA64ISAR1_GPA_WIDTH	U(4)
164 #define ID_AA64ISAR1_API_SHIFT	U(8)
165 #define ID_AA64ISAR1_API_WIDTH	U(4)
166 #define ID_AA64ISAR1_APA_SHIFT	U(4)
167 #define ID_AA64ISAR1_APA_WIDTH	U(4)
168 
169 #define ID_AA64ISAR1_GPI_MASK \
170 	(((ULL(1) << ID_AA64ISAR1_GPI_WIDTH) - ULL(1)) << ID_AA64ISAR1_GPI_SHIFT)
171 #define ID_AA64ISAR1_GPA_MASK \
172 	(((ULL(1) << ID_AA64ISAR1_GPA_WIDTH) - ULL(1)) << ID_AA64ISAR1_GPA_SHIFT)
173 #define ID_AA64ISAR1_API_MASK \
174 	(((ULL(1) << ID_AA64ISAR1_API_WIDTH) - ULL(1)) << ID_AA64ISAR1_API_SHIFT)
175 #define ID_AA64ISAR1_APA_MASK \
176 	(((ULL(1) << ID_AA64ISAR1_APA_WIDTH) - ULL(1)) << ID_AA64ISAR1_APA_SHIFT)
177 
178 /* ID_AA64MMFR0_EL1 definitions */
179 #define ID_AA64MMFR0_EL1_PARANGE_SHIFT	U(0)
180 #define ID_AA64MMFR0_EL1_PARANGE_MASK	ULL(0xf)
181 
182 #define PARANGE_0000	U(32)
183 #define PARANGE_0001	U(36)
184 #define PARANGE_0010	U(40)
185 #define PARANGE_0011	U(42)
186 #define PARANGE_0100	U(44)
187 #define PARANGE_0101	U(48)
188 #define PARANGE_0110	U(52)
189 
190 #define ID_AA64MMFR0_EL1_TGRAN4_SHIFT		U(28)
191 #define ID_AA64MMFR0_EL1_TGRAN4_MASK		ULL(0xf)
192 #define ID_AA64MMFR0_EL1_TGRAN4_SUPPORTED	ULL(0x0)
193 #define ID_AA64MMFR0_EL1_TGRAN4_NOT_SUPPORTED	ULL(0xf)
194 
195 #define ID_AA64MMFR0_EL1_TGRAN64_SHIFT		U(24)
196 #define ID_AA64MMFR0_EL1_TGRAN64_MASK		ULL(0xf)
197 #define ID_AA64MMFR0_EL1_TGRAN64_SUPPORTED	ULL(0x0)
198 #define ID_AA64MMFR0_EL1_TGRAN64_NOT_SUPPORTED	ULL(0xf)
199 
200 #define ID_AA64MMFR0_EL1_TGRAN16_SHIFT		U(20)
201 #define ID_AA64MMFR0_EL1_TGRAN16_MASK		ULL(0xf)
202 #define ID_AA64MMFR0_EL1_TGRAN16_SUPPORTED	ULL(0x1)
203 #define ID_AA64MMFR0_EL1_TGRAN16_NOT_SUPPORTED	ULL(0x0)
204 
205 /* ID_AA64MMFR2_EL1 definitions */
206 #define ID_AA64MMFR2_EL1		S3_0_C0_C7_2
207 
208 #define ID_AA64MMFR2_EL1_ST_SHIFT	U(28)
209 #define ID_AA64MMFR2_EL1_ST_MASK	ULL(0xf)
210 
211 #define ID_AA64MMFR2_EL1_CNP_SHIFT	U(0)
212 #define ID_AA64MMFR2_EL1_CNP_MASK	ULL(0xf)
213 
214 /* ID_AA64PFR1_EL1 definitions */
215 #define ID_AA64PFR1_EL1_SSBS_SHIFT	U(4)
216 #define ID_AA64PFR1_EL1_SSBS_MASK	ULL(0xf)
217 
218 #define SSBS_UNAVAILABLE	ULL(0)	/* No architectural SSBS support */
219 
220 /* ID_PFR1_EL1 definitions */
221 #define ID_PFR1_VIRTEXT_SHIFT	U(12)
222 #define ID_PFR1_VIRTEXT_MASK	U(0xf)
223 #define GET_VIRT_EXT(id)	(((id) >> ID_PFR1_VIRTEXT_SHIFT) \
224 				 & ID_PFR1_VIRTEXT_MASK)
225 
226 /* SCTLR definitions */
227 #define SCTLR_EL2_RES1	((U(1) << 29) | (U(1) << 28) | (U(1) << 23) | \
228 			 (U(1) << 22) | (U(1) << 18) | (U(1) << 16) | \
229 			 (U(1) << 11) | (U(1) << 5) | (U(1) << 4))
230 
231 #define SCTLR_EL1_RES1	((U(1) << 29) | (U(1) << 28) | (U(1) << 23) | \
232 			 (U(1) << 22) | (U(1) << 20) | (U(1) << 11))
233 #define SCTLR_AARCH32_EL1_RES1 \
234 			((U(1) << 23) | (U(1) << 22) | (U(1) << 11) | \
235 			 (U(1) << 4) | (U(1) << 3))
236 
237 #define SCTLR_EL3_RES1	((U(1) << 29) | (U(1) << 28) | (U(1) << 23) | \
238 			(U(1) << 22) | (U(1) << 18) | (U(1) << 16) | \
239 			(U(1) << 11) | (U(1) << 5) | (U(1) << 4))
240 
241 #define SCTLR_M_BIT		(ULL(1) << 0)
242 #define SCTLR_A_BIT		(ULL(1) << 1)
243 #define SCTLR_C_BIT		(ULL(1) << 2)
244 #define SCTLR_SA_BIT		(ULL(1) << 3)
245 #define SCTLR_SA0_BIT		(ULL(1) << 4)
246 #define SCTLR_CP15BEN_BIT	(ULL(1) << 5)
247 #define SCTLR_ITD_BIT		(ULL(1) << 7)
248 #define SCTLR_SED_BIT		(ULL(1) << 8)
249 #define SCTLR_UMA_BIT		(ULL(1) << 9)
250 #define SCTLR_I_BIT		(ULL(1) << 12)
251 #define SCTLR_V_BIT		(ULL(1) << 13)
252 #define SCTLR_DZE_BIT		(ULL(1) << 14)
253 #define SCTLR_UCT_BIT		(ULL(1) << 15)
254 #define SCTLR_NTWI_BIT		(ULL(1) << 16)
255 #define SCTLR_NTWE_BIT		(ULL(1) << 18)
256 #define SCTLR_WXN_BIT		(ULL(1) << 19)
257 #define SCTLR_UWXN_BIT		(ULL(1) << 20)
258 #define SCTLR_IESB_BIT		(ULL(1) << 21)
259 #define SCTLR_E0E_BIT		(ULL(1) << 24)
260 #define SCTLR_EE_BIT		(ULL(1) << 25)
261 #define SCTLR_UCI_BIT		(ULL(1) << 26)
262 #define SCTLR_TRE_BIT		(ULL(1) << 28)
263 #define SCTLR_AFE_BIT		(ULL(1) << 29)
264 #define SCTLR_TE_BIT		(ULL(1) << 30)
265 #define SCTLR_DSSBS_BIT		(ULL(1) << 44)
266 #define SCTLR_RESET_VAL		SCTLR_EL3_RES1
267 
268 /* CPACR_El1 definitions */
269 #define CPACR_EL1_FPEN(x)	((x) << 20)
270 #define CPACR_EL1_FP_TRAP_EL0	U(0x1)
271 #define CPACR_EL1_FP_TRAP_ALL	U(0x2)
272 #define CPACR_EL1_FP_TRAP_NONE	U(0x3)
273 
274 /* SCR definitions */
275 #define SCR_RES1_BITS		((U(1) << 4) | (U(1) << 5))
276 #define SCR_FIEN_BIT		(U(1) << 21)
277 #define SCR_API_BIT		(U(1) << 17)
278 #define SCR_APK_BIT		(U(1) << 16)
279 #define SCR_TWE_BIT		(U(1) << 13)
280 #define SCR_TWI_BIT		(U(1) << 12)
281 #define SCR_ST_BIT		(U(1) << 11)
282 #define SCR_RW_BIT		(U(1) << 10)
283 #define SCR_SIF_BIT		(U(1) << 9)
284 #define SCR_HCE_BIT		(U(1) << 8)
285 #define SCR_SMD_BIT		(U(1) << 7)
286 #define SCR_EA_BIT		(U(1) << 3)
287 #define SCR_FIQ_BIT		(U(1) << 2)
288 #define SCR_IRQ_BIT		(U(1) << 1)
289 #define SCR_NS_BIT		(U(1) << 0)
290 #define SCR_VALID_BIT_MASK	U(0x2f8f)
291 #define SCR_RESET_VAL		SCR_RES1_BITS
292 
293 /* MDCR_EL3 definitions */
294 #define MDCR_SPD32(x)		((x) << 14)
295 #define MDCR_SPD32_LEGACY	U(0x0)
296 #define MDCR_SPD32_DISABLE	U(0x2)
297 #define MDCR_SPD32_ENABLE	U(0x3)
298 #define MDCR_SDD_BIT		(U(1) << 16)
299 #define MDCR_NSPB(x)		((x) << 12)
300 #define MDCR_NSPB_EL1		U(0x3)
301 #define MDCR_TDOSA_BIT		(U(1) << 10)
302 #define MDCR_TDA_BIT		(U(1) << 9)
303 #define MDCR_TPM_BIT		(U(1) << 6)
304 #define MDCR_EL3_RESET_VAL	U(0x0)
305 
306 /* MDCR_EL2 definitions */
307 #define MDCR_EL2_TPMS		(U(1) << 14)
308 #define MDCR_EL2_E2PB(x)	((x) << 12)
309 #define MDCR_EL2_E2PB_EL1	U(0x3)
310 #define MDCR_EL2_TDRA_BIT	(U(1) << 11)
311 #define MDCR_EL2_TDOSA_BIT	(U(1) << 10)
312 #define MDCR_EL2_TDA_BIT	(U(1) << 9)
313 #define MDCR_EL2_TDE_BIT	(U(1) << 8)
314 #define MDCR_EL2_HPME_BIT	(U(1) << 7)
315 #define MDCR_EL2_TPM_BIT	(U(1) << 6)
316 #define MDCR_EL2_TPMCR_BIT	(U(1) << 5)
317 #define MDCR_EL2_RESET_VAL	U(0x0)
318 
319 /* HSTR_EL2 definitions */
320 #define HSTR_EL2_RESET_VAL	U(0x0)
321 #define HSTR_EL2_T_MASK		U(0xff)
322 
323 /* CNTHP_CTL_EL2 definitions */
324 #define CNTHP_CTL_ENABLE_BIT	(U(1) << 0)
325 #define CNTHP_CTL_RESET_VAL	U(0x0)
326 
327 /* VTTBR_EL2 definitions */
328 #define VTTBR_RESET_VAL		ULL(0x0)
329 #define VTTBR_VMID_MASK		ULL(0xff)
330 #define VTTBR_VMID_SHIFT	U(48)
331 #define VTTBR_BADDR_MASK	ULL(0xffffffffffff)
332 #define VTTBR_BADDR_SHIFT	U(0)
333 
334 /* HCR definitions */
335 #define HCR_API_BIT		(ULL(1) << 41)
336 #define HCR_APK_BIT		(ULL(1) << 40)
337 #define HCR_TGE_BIT		(ULL(1) << 27)
338 #define HCR_RW_SHIFT		U(31)
339 #define HCR_RW_BIT		(ULL(1) << HCR_RW_SHIFT)
340 #define HCR_AMO_BIT		(ULL(1) << 5)
341 #define HCR_IMO_BIT		(ULL(1) << 4)
342 #define HCR_FMO_BIT		(ULL(1) << 3)
343 
344 /* ISR definitions */
345 #define ISR_A_SHIFT		U(8)
346 #define ISR_I_SHIFT		U(7)
347 #define ISR_F_SHIFT		U(6)
348 
349 /* CNTHCTL_EL2 definitions */
350 #define CNTHCTL_RESET_VAL	U(0x0)
351 #define EVNTEN_BIT		(U(1) << 2)
352 #define EL1PCEN_BIT		(U(1) << 1)
353 #define EL1PCTEN_BIT		(U(1) << 0)
354 
355 /* CNTKCTL_EL1 definitions */
356 #define EL0PTEN_BIT		(U(1) << 9)
357 #define EL0VTEN_BIT		(U(1) << 8)
358 #define EL0PCTEN_BIT		(U(1) << 0)
359 #define EL0VCTEN_BIT		(U(1) << 1)
360 #define EVNTEN_BIT		(U(1) << 2)
361 #define EVNTDIR_BIT		(U(1) << 3)
362 #define EVNTI_SHIFT		U(4)
363 #define EVNTI_MASK		U(0xf)
364 
365 /* CPTR_EL3 definitions */
366 #define TCPAC_BIT		(U(1) << 31)
367 #define TAM_BIT			(U(1) << 30)
368 #define TTA_BIT			(U(1) << 20)
369 #define TFP_BIT			(U(1) << 10)
370 #define CPTR_EZ_BIT		(U(1) << 8)
371 #define CPTR_EL3_RESET_VAL	U(0x0)
372 
373 /* CPTR_EL2 definitions */
374 #define CPTR_EL2_RES1		((U(1) << 13) | (U(1) << 12) | (U(0x3ff)))
375 #define CPTR_EL2_TCPAC_BIT	(U(1) << 31)
376 #define CPTR_EL2_TAM_BIT	(U(1) << 30)
377 #define CPTR_EL2_TTA_BIT	(U(1) << 20)
378 #define CPTR_EL2_TFP_BIT	(U(1) << 10)
379 #define CPTR_EL2_TZ_BIT		(U(1) << 8)
380 #define CPTR_EL2_RESET_VAL	CPTR_EL2_RES1
381 
382 /* CPSR/SPSR definitions */
383 #define DAIF_FIQ_BIT		(U(1) << 0)
384 #define DAIF_IRQ_BIT		(U(1) << 1)
385 #define DAIF_ABT_BIT		(U(1) << 2)
386 #define DAIF_DBG_BIT		(U(1) << 3)
387 #define SPSR_DAIF_SHIFT		U(6)
388 #define SPSR_DAIF_MASK		U(0xf)
389 
390 #define SPSR_AIF_SHIFT		U(6)
391 #define SPSR_AIF_MASK		U(0x7)
392 
393 #define SPSR_E_SHIFT		U(9)
394 #define SPSR_E_MASK		U(0x1)
395 #define SPSR_E_LITTLE		U(0x0)
396 #define SPSR_E_BIG		U(0x1)
397 
398 #define SPSR_T_SHIFT		U(5)
399 #define SPSR_T_MASK		U(0x1)
400 #define SPSR_T_ARM		U(0x0)
401 #define SPSR_T_THUMB		U(0x1)
402 
403 #define SPSR_M_SHIFT		U(4)
404 #define SPSR_M_MASK		U(0x1)
405 #define SPSR_M_AARCH64		U(0x0)
406 #define SPSR_M_AARCH32		U(0x1)
407 
408 #define DISABLE_ALL_EXCEPTIONS \
409 		(DAIF_FIQ_BIT | DAIF_IRQ_BIT | DAIF_ABT_BIT | DAIF_DBG_BIT)
410 
411 #define DISABLE_INTERRUPTS	(DAIF_FIQ_BIT | DAIF_IRQ_BIT)
412 
413 /*
414  * RMR_EL3 definitions
415  */
416 #define RMR_EL3_RR_BIT		(U(1) << 1)
417 #define RMR_EL3_AA64_BIT	(U(1) << 0)
418 
419 /*
420  * HI-VECTOR address for AArch32 state
421  */
422 #define HI_VECTOR_BASE		U(0xFFFF0000)
423 
424 /*
425  * TCR defintions
426  */
427 #define TCR_EL3_RES1		((ULL(1) << 31) | (ULL(1) << 23))
428 #define TCR_EL2_RES1		((ULL(1) << 31) | (ULL(1) << 23))
429 #define TCR_EL1_IPS_SHIFT	U(32)
430 #define TCR_EL2_PS_SHIFT	U(16)
431 #define TCR_EL3_PS_SHIFT	U(16)
432 
433 #define TCR_TxSZ_MIN		ULL(16)
434 #define TCR_TxSZ_MAX		ULL(39)
435 #define TCR_TxSZ_MAX_TTST	ULL(48)
436 
437 /* (internal) physical address size bits in EL3/EL1 */
438 #define TCR_PS_BITS_4GB		ULL(0x0)
439 #define TCR_PS_BITS_64GB	ULL(0x1)
440 #define TCR_PS_BITS_1TB		ULL(0x2)
441 #define TCR_PS_BITS_4TB		ULL(0x3)
442 #define TCR_PS_BITS_16TB	ULL(0x4)
443 #define TCR_PS_BITS_256TB	ULL(0x5)
444 
445 #define ADDR_MASK_48_TO_63	ULL(0xFFFF000000000000)
446 #define ADDR_MASK_44_TO_47	ULL(0x0000F00000000000)
447 #define ADDR_MASK_42_TO_43	ULL(0x00000C0000000000)
448 #define ADDR_MASK_40_TO_41	ULL(0x0000030000000000)
449 #define ADDR_MASK_36_TO_39	ULL(0x000000F000000000)
450 #define ADDR_MASK_32_TO_35	ULL(0x0000000F00000000)
451 
452 #define TCR_RGN_INNER_NC	(ULL(0x0) << 8)
453 #define TCR_RGN_INNER_WBA	(ULL(0x1) << 8)
454 #define TCR_RGN_INNER_WT	(ULL(0x2) << 8)
455 #define TCR_RGN_INNER_WBNA	(ULL(0x3) << 8)
456 
457 #define TCR_RGN_OUTER_NC	(ULL(0x0) << 10)
458 #define TCR_RGN_OUTER_WBA	(ULL(0x1) << 10)
459 #define TCR_RGN_OUTER_WT	(ULL(0x2) << 10)
460 #define TCR_RGN_OUTER_WBNA	(ULL(0x3) << 10)
461 
462 #define TCR_SH_NON_SHAREABLE	(ULL(0x0) << 12)
463 #define TCR_SH_OUTER_SHAREABLE	(ULL(0x2) << 12)
464 #define TCR_SH_INNER_SHAREABLE	(ULL(0x3) << 12)
465 
466 #define TCR_TG0_SHIFT		U(14)
467 #define TCR_TG0_MASK		ULL(3)
468 #define TCR_TG0_4K		(ULL(0) << TCR_TG0_SHIFT)
469 #define TCR_TG0_64K		(ULL(1) << TCR_TG0_SHIFT)
470 #define TCR_TG0_16K		(ULL(2) << TCR_TG0_SHIFT)
471 
472 #define TCR_EPD0_BIT		(ULL(1) << 7)
473 #define TCR_EPD1_BIT		(ULL(1) << 23)
474 
475 #define MODE_SP_SHIFT		U(0x0)
476 #define MODE_SP_MASK		U(0x1)
477 #define MODE_SP_EL0		U(0x0)
478 #define MODE_SP_ELX		U(0x1)
479 
480 #define MODE_RW_SHIFT		U(0x4)
481 #define MODE_RW_MASK		U(0x1)
482 #define MODE_RW_64		U(0x0)
483 #define MODE_RW_32		U(0x1)
484 
485 #define MODE_EL_SHIFT		U(0x2)
486 #define MODE_EL_MASK		U(0x3)
487 #define MODE_EL3		U(0x3)
488 #define MODE_EL2		U(0x2)
489 #define MODE_EL1		U(0x1)
490 #define MODE_EL0		U(0x0)
491 
492 #define MODE32_SHIFT		U(0)
493 #define MODE32_MASK		U(0xf)
494 #define MODE32_usr		U(0x0)
495 #define MODE32_fiq		U(0x1)
496 #define MODE32_irq		U(0x2)
497 #define MODE32_svc		U(0x3)
498 #define MODE32_mon		U(0x6)
499 #define MODE32_abt		U(0x7)
500 #define MODE32_hyp		U(0xa)
501 #define MODE32_und		U(0xb)
502 #define MODE32_sys		U(0xf)
503 
504 #define GET_RW(mode)		(((mode) >> MODE_RW_SHIFT) & MODE_RW_MASK)
505 #define GET_EL(mode)		(((mode) >> MODE_EL_SHIFT) & MODE_EL_MASK)
506 #define GET_SP(mode)		(((mode) >> MODE_SP_SHIFT) & MODE_SP_MASK)
507 #define GET_M32(mode)		(((mode) >> MODE32_SHIFT) & MODE32_MASK)
508 
509 #define SPSR_64(el, sp, daif)				\
510 	((MODE_RW_64 << MODE_RW_SHIFT) |		\
511 	(((el) & MODE_EL_MASK) << MODE_EL_SHIFT) |	\
512 	(((sp) & MODE_SP_MASK) << MODE_SP_SHIFT) |	\
513 	(((daif) & SPSR_DAIF_MASK) << SPSR_DAIF_SHIFT))
514 
515 #define SPSR_MODE32(mode, isa, endian, aif)		\
516 	((MODE_RW_32 << MODE_RW_SHIFT) |		\
517 	(((mode) & MODE32_MASK) << MODE32_SHIFT) |	\
518 	(((isa) & SPSR_T_MASK) << SPSR_T_SHIFT) |	\
519 	(((endian) & SPSR_E_MASK) << SPSR_E_SHIFT) |	\
520 	(((aif) & SPSR_AIF_MASK) << SPSR_AIF_SHIFT))
521 
522 /*
523  * TTBR Definitions
524  */
525 #define TTBR_CNP_BIT		ULL(0x1)
526 
527 /*
528  * CTR_EL0 definitions
529  */
530 #define CTR_CWG_SHIFT		U(24)
531 #define CTR_CWG_MASK		U(0xf)
532 #define CTR_ERG_SHIFT		U(20)
533 #define CTR_ERG_MASK		U(0xf)
534 #define CTR_DMINLINE_SHIFT	U(16)
535 #define CTR_DMINLINE_MASK	U(0xf)
536 #define CTR_L1IP_SHIFT		U(14)
537 #define CTR_L1IP_MASK		U(0x3)
538 #define CTR_IMINLINE_SHIFT	U(0)
539 #define CTR_IMINLINE_MASK	U(0xf)
540 
541 #define MAX_CACHE_LINE_SIZE	U(0x800) /* 2KB */
542 
543 /* Physical timer control register bit fields shifts and masks */
544 #define CNTP_CTL_ENABLE_SHIFT   U(0)
545 #define CNTP_CTL_IMASK_SHIFT    U(1)
546 #define CNTP_CTL_ISTATUS_SHIFT  U(2)
547 
548 #define CNTP_CTL_ENABLE_MASK    U(1)
549 #define CNTP_CTL_IMASK_MASK     U(1)
550 #define CNTP_CTL_ISTATUS_MASK   U(1)
551 
552 /* Exception Syndrome register bits and bobs */
553 #define ESR_EC_SHIFT			U(26)
554 #define ESR_EC_MASK			U(0x3f)
555 #define ESR_EC_LENGTH			U(6)
556 #define EC_UNKNOWN			U(0x0)
557 #define EC_WFE_WFI			U(0x1)
558 #define EC_AARCH32_CP15_MRC_MCR		U(0x3)
559 #define EC_AARCH32_CP15_MRRC_MCRR	U(0x4)
560 #define EC_AARCH32_CP14_MRC_MCR		U(0x5)
561 #define EC_AARCH32_CP14_LDC_STC		U(0x6)
562 #define EC_FP_SIMD			U(0x7)
563 #define EC_AARCH32_CP10_MRC		U(0x8)
564 #define EC_AARCH32_CP14_MRRC_MCRR	U(0xc)
565 #define EC_ILLEGAL			U(0xe)
566 #define EC_AARCH32_SVC			U(0x11)
567 #define EC_AARCH32_HVC			U(0x12)
568 #define EC_AARCH32_SMC			U(0x13)
569 #define EC_AARCH64_SVC			U(0x15)
570 #define EC_AARCH64_HVC			U(0x16)
571 #define EC_AARCH64_SMC			U(0x17)
572 #define EC_AARCH64_SYS			U(0x18)
573 #define EC_IABORT_LOWER_EL		U(0x20)
574 #define EC_IABORT_CUR_EL		U(0x21)
575 #define EC_PC_ALIGN			U(0x22)
576 #define EC_DABORT_LOWER_EL		U(0x24)
577 #define EC_DABORT_CUR_EL		U(0x25)
578 #define EC_SP_ALIGN			U(0x26)
579 #define EC_AARCH32_FP			U(0x28)
580 #define EC_AARCH64_FP			U(0x2c)
581 #define EC_SERROR			U(0x2f)
582 
583 /*
584  * External Abort bit in Instruction and Data Aborts synchronous exception
585  * syndromes.
586  */
587 #define ESR_ISS_EABORT_EA_BIT		U(9)
588 
589 #define EC_BITS(x)			(((x) >> ESR_EC_SHIFT) & ESR_EC_MASK)
590 
591 /* Reset bit inside the Reset management register for EL3 (RMR_EL3) */
592 #define RMR_RESET_REQUEST_SHIFT 	U(0x1)
593 #define RMR_WARM_RESET_CPU		(U(1) << RMR_RESET_REQUEST_SHIFT)
594 
595 /*******************************************************************************
596  * Definitions of register offsets, fields and macros for CPU system
597  * instructions.
598  ******************************************************************************/
599 
600 #define TLBI_ADDR_SHIFT		U(12)
601 #define TLBI_ADDR_MASK		ULL(0x00000FFFFFFFFFFF)
602 #define TLBI_ADDR(x)		(((x) >> TLBI_ADDR_SHIFT) & TLBI_ADDR_MASK)
603 
604 /*******************************************************************************
605  * Definitions of register offsets and fields in the CNTCTLBase Frame of the
606  * system level implementation of the Generic Timer.
607  ******************************************************************************/
608 #define CNTCTLBASE_CNTFRQ	U(0x0)
609 #define CNTNSAR			U(0x4)
610 #define CNTNSAR_NS_SHIFT(x)	(x)
611 
612 #define CNTACR_BASE(x)		(U(0x40) + ((x) << 2))
613 #define CNTACR_RPCT_SHIFT	U(0x0)
614 #define CNTACR_RVCT_SHIFT	U(0x1)
615 #define CNTACR_RFRQ_SHIFT	U(0x2)
616 #define CNTACR_RVOFF_SHIFT	U(0x3)
617 #define CNTACR_RWVT_SHIFT	U(0x4)
618 #define CNTACR_RWPT_SHIFT	U(0x5)
619 
620 /*******************************************************************************
621  * Definitions of register offsets and fields in the CNTBaseN Frame of the
622  * system level implementation of the Generic Timer.
623  ******************************************************************************/
624 /* Physical Count register. */
625 #define CNTPCT_LO		U(0x0)
626 /* Counter Frequency register. */
627 #define CNTBASEN_CNTFRQ		U(0x10)
628 /* Physical Timer CompareValue register. */
629 #define CNTP_CVAL_LO		U(0x20)
630 /* Physical Timer Control register. */
631 #define CNTP_CTL		U(0x2c)
632 
633 /* PMCR_EL0 definitions */
634 #define PMCR_EL0_RESET_VAL	U(0x0)
635 #define PMCR_EL0_N_SHIFT	U(11)
636 #define PMCR_EL0_N_MASK		U(0x1f)
637 #define PMCR_EL0_N_BITS		(PMCR_EL0_N_MASK << PMCR_EL0_N_SHIFT)
638 #define PMCR_EL0_LC_BIT		(U(1) << 6)
639 #define PMCR_EL0_DP_BIT		(U(1) << 5)
640 #define PMCR_EL0_X_BIT		(U(1) << 4)
641 #define PMCR_EL0_D_BIT		(U(1) << 3)
642 
643 /*******************************************************************************
644  * Definitions for system register interface to SVE
645  ******************************************************************************/
646 #define ZCR_EL3			S3_6_C1_C2_0
647 #define ZCR_EL2			S3_4_C1_C2_0
648 
649 /* ZCR_EL3 definitions */
650 #define ZCR_EL3_LEN_MASK	U(0xf)
651 
652 /* ZCR_EL2 definitions */
653 #define ZCR_EL2_LEN_MASK	U(0xf)
654 
655 /*******************************************************************************
656  * Definitions of MAIR encodings for device and normal memory
657  ******************************************************************************/
658 /*
659  * MAIR encodings for device memory attributes.
660  */
661 #define MAIR_DEV_nGnRnE		ULL(0x0)
662 #define MAIR_DEV_nGnRE		ULL(0x4)
663 #define MAIR_DEV_nGRE		ULL(0x8)
664 #define MAIR_DEV_GRE		ULL(0xc)
665 
666 /*
667  * MAIR encodings for normal memory attributes.
668  *
669  * Cache Policy
670  *  WT:	 Write Through
671  *  WB:	 Write Back
672  *  NC:	 Non-Cacheable
673  *
674  * Transient Hint
675  *  NTR: Non-Transient
676  *  TR:	 Transient
677  *
678  * Allocation Policy
679  *  RA:	 Read Allocate
680  *  WA:	 Write Allocate
681  *  RWA: Read and Write Allocate
682  *  NA:	 No Allocation
683  */
684 #define MAIR_NORM_WT_TR_WA	ULL(0x1)
685 #define MAIR_NORM_WT_TR_RA	ULL(0x2)
686 #define MAIR_NORM_WT_TR_RWA	ULL(0x3)
687 #define MAIR_NORM_NC		ULL(0x4)
688 #define MAIR_NORM_WB_TR_WA	ULL(0x5)
689 #define MAIR_NORM_WB_TR_RA	ULL(0x6)
690 #define MAIR_NORM_WB_TR_RWA	ULL(0x7)
691 #define MAIR_NORM_WT_NTR_NA	ULL(0x8)
692 #define MAIR_NORM_WT_NTR_WA	ULL(0x9)
693 #define MAIR_NORM_WT_NTR_RA	ULL(0xa)
694 #define MAIR_NORM_WT_NTR_RWA	ULL(0xb)
695 #define MAIR_NORM_WB_NTR_NA	ULL(0xc)
696 #define MAIR_NORM_WB_NTR_WA	ULL(0xd)
697 #define MAIR_NORM_WB_NTR_RA	ULL(0xe)
698 #define MAIR_NORM_WB_NTR_RWA	ULL(0xf)
699 
700 #define MAIR_NORM_OUTER_SHIFT	U(4)
701 
702 #define MAKE_MAIR_NORMAL_MEMORY(inner, outer)	\
703 		((inner) | ((outer) << MAIR_NORM_OUTER_SHIFT))
704 
705 /* PAR_EL1 fields */
706 #define PAR_F_SHIFT	U(0)
707 #define PAR_F_MASK	ULL(0x1)
708 #define PAR_ADDR_SHIFT	U(12)
709 #define PAR_ADDR_MASK	(BIT(40) - ULL(1)) /* 40-bits-wide page address */
710 
711 /*******************************************************************************
712  * Definitions for system register interface to SPE
713  ******************************************************************************/
714 #define PMBLIMITR_EL1		S3_0_C9_C10_0
715 
716 /*******************************************************************************
717  * Definitions for system register interface to MPAM
718  ******************************************************************************/
719 #define MPAMIDR_EL1		S3_0_C10_C4_4
720 #define MPAM2_EL2		S3_4_C10_C5_0
721 #define MPAMHCR_EL2		S3_4_C10_C4_0
722 #define MPAM3_EL3		S3_6_C10_C5_0
723 
724 /*******************************************************************************
725  * Definitions for system register interface to AMU for ARMv8.4 onwards
726  ******************************************************************************/
727 #define AMCR_EL0		S3_3_C13_C2_0
728 #define AMCFGR_EL0		S3_3_C13_C2_1
729 #define AMCGCR_EL0		S3_3_C13_C2_2
730 #define AMUSERENR_EL0		S3_3_C13_C2_3
731 #define AMCNTENCLR0_EL0		S3_3_C13_C2_4
732 #define AMCNTENSET0_EL0		S3_3_C13_C2_5
733 #define AMCNTENCLR1_EL0		S3_3_C13_C3_0
734 #define AMCNTENSET1_EL0		S3_3_C13_C3_1
735 
736 /* Activity Monitor Group 0 Event Counter Registers */
737 #define AMEVCNTR00_EL0		S3_3_C13_C4_0
738 #define AMEVCNTR01_EL0		S3_3_C13_C4_1
739 #define AMEVCNTR02_EL0		S3_3_C13_C4_2
740 #define AMEVCNTR03_EL0		S3_3_C13_C4_3
741 
742 /* Activity Monitor Group 0 Event Type Registers */
743 #define AMEVTYPER00_EL0		S3_3_C13_C6_0
744 #define AMEVTYPER01_EL0		S3_3_C13_C6_1
745 #define AMEVTYPER02_EL0		S3_3_C13_C6_2
746 #define AMEVTYPER03_EL0		S3_3_C13_C6_3
747 
748 /* Activity Monitor Group 1 Event Counter Registers */
749 #define AMEVCNTR10_EL0		S3_3_C13_C12_0
750 #define AMEVCNTR11_EL0		S3_3_C13_C12_1
751 #define AMEVCNTR12_EL0		S3_3_C13_C12_2
752 #define AMEVCNTR13_EL0		S3_3_C13_C12_3
753 #define AMEVCNTR14_EL0		S3_3_C13_C12_4
754 #define AMEVCNTR15_EL0		S3_3_C13_C12_5
755 #define AMEVCNTR16_EL0		S3_3_C13_C12_6
756 #define AMEVCNTR17_EL0		S3_3_C13_C12_7
757 #define AMEVCNTR18_EL0		S3_3_C13_C13_0
758 #define AMEVCNTR19_EL0		S3_3_C13_C13_1
759 #define AMEVCNTR1A_EL0		S3_3_C13_C13_2
760 #define AMEVCNTR1B_EL0		S3_3_C13_C13_3
761 #define AMEVCNTR1C_EL0		S3_3_C13_C13_4
762 #define AMEVCNTR1D_EL0		S3_3_C13_C13_5
763 #define AMEVCNTR1E_EL0		S3_3_C13_C13_6
764 #define AMEVCNTR1F_EL0		S3_3_C13_C13_7
765 
766 /* Activity Monitor Group 1 Event Type Registers */
767 #define AMEVTYPER10_EL0		S3_3_C13_C14_0
768 #define AMEVTYPER11_EL0		S3_3_C13_C14_1
769 #define AMEVTYPER12_EL0		S3_3_C13_C14_2
770 #define AMEVTYPER13_EL0		S3_3_C13_C14_3
771 #define AMEVTYPER14_EL0		S3_3_C13_C14_4
772 #define AMEVTYPER15_EL0		S3_3_C13_C14_5
773 #define AMEVTYPER16_EL0		S3_3_C13_C14_6
774 #define AMEVTYPER17_EL0		S3_3_C13_C14_7
775 #define AMEVTYPER18_EL0		S3_3_C13_C15_0
776 #define AMEVTYPER19_EL0		S3_3_C13_C15_1
777 #define AMEVTYPER1A_EL0		S3_3_C13_C15_2
778 #define AMEVTYPER1B_EL0		S3_3_C13_C15_3
779 #define AMEVTYPER1C_EL0		S3_3_C13_C15_4
780 #define AMEVTYPER1D_EL0		S3_3_C13_C15_5
781 #define AMEVTYPER1E_EL0		S3_3_C13_C15_6
782 #define AMEVTYPER1F_EL0		S3_3_C13_C15_7
783 
784 /* AMCGCR_EL0 definitions */
785 #define AMCGCR_EL0_CG1NC_SHIFT	U(8)
786 #define AMCGCR_EL0_CG1NC_LENGTH	U(8)
787 #define AMCGCR_EL0_CG1NC_MASK	U(0xff)
788 
789 /* MPAM register definitions */
790 #define MPAM3_EL3_MPAMEN_BIT		(ULL(1) << 63)
791 
792 #define MPAMIDR_HAS_HCR_BIT		(ULL(1) << 17)
793 
794 /*******************************************************************************
795  * RAS system registers
796  ******************************************************************************/
797 #define DISR_EL1		S3_0_C12_C1_1
798 #define DISR_A_BIT		U(31)
799 
800 #define ERRIDR_EL1		S3_0_C5_C3_0
801 #define ERRIDR_MASK		U(0xffff)
802 
803 #define ERRSELR_EL1		S3_0_C5_C3_1
804 
805 /* System register access to Standard Error Record registers */
806 #define ERXFR_EL1		S3_0_C5_C4_0
807 #define ERXCTLR_EL1		S3_0_C5_C4_1
808 #define ERXSTATUS_EL1		S3_0_C5_C4_2
809 #define ERXADDR_EL1		S3_0_C5_C4_3
810 #define ERXPFGF_EL1		S3_0_C5_C4_4
811 #define ERXPFGCTL_EL1		S3_0_C5_C4_5
812 #define ERXPFGCDN_EL1		S3_0_C5_C4_6
813 #define ERXMISC0_EL1		S3_0_C5_C5_0
814 #define ERXMISC1_EL1		S3_0_C5_C5_1
815 
816 #define ERXCTLR_ED_BIT		(U(1) << 0)
817 #define ERXCTLR_UE_BIT		(U(1) << 4)
818 
819 #define ERXPFGCTL_UC_BIT	(U(1) << 1)
820 #define ERXPFGCTL_UEU_BIT	(U(1) << 2)
821 #define ERXPFGCTL_CDEN_BIT	(U(1) << 31)
822 
823 /*******************************************************************************
824  * Armv8.3 Pointer Authentication Registers
825  ******************************************************************************/
826 #define APGAKeyLo_EL1		S3_0_C2_C3_0
827 
828 /*******************************************************************************
829  * Armv8.4 Data Independent Timing Registers
830  ******************************************************************************/
831 #define DIT			S3_3_C4_C2_5
832 #define DIT_BIT			BIT(24)
833 
834 #endif /* ARCH_H */
835