xref: /rk3399_ARM-atf/include/services/arm_arch_svc.h (revision 714a1a93d10637ed00e087585c6aa625b6c254f8)
1 /*
2  * Copyright (c) 2018-2025, Arm Limited and Contributors. All rights reserved.
3  *
4  * SPDX-License-Identifier: BSD-3-Clause
5  */
6 
7 #ifndef ARM_ARCH_SVC_H
8 #define ARM_ARCH_SVC_H
9 
10 #define SMCCC_VERSION			U(0x80000000)
11 #define SMCCC_ARCH_FEATURES		U(0x80000001)
12 #define SMCCC_ARCH_SOC_ID		U(0x80000002)
13 #define SMCCC_ARCH_WORKAROUND_1		U(0x80008000)
14 #define SMCCC_ARCH_WORKAROUND_2		U(0x80007FFF)
15 #define SMCCC_ARCH_WORKAROUND_3		U(0x80003FFF)
16 #define SMCCC_ARCH_FEATURE_AVAILABILITY		U(0x80000003)
17 #define SMCCC_ARCH_WORKAROUND_4		U(0x80000004)
18 
19 #define SMCCC_GET_SOC_VERSION		U(0)
20 #define SMCCC_GET_SOC_REVISION		U(1)
21 #define SMCCC_GET_SOC_NAME		U(2)
22 
23 #define SMCCC_SOC_NAME_LEN		U(136)
24 
25 #ifndef __ASSEMBLER__
26 #if ARCH_FEATURE_AVAILABILITY
27 #include <lib/cassert.h>
28 
29 #if ENABLE_FEAT_FGT2
30 #define SCR_FEAT_FGT2 SCR_FGTEN2_BIT
31 #else
32 #define SCR_FEAT_FGT2 (0)
33 #endif
34 
35 #if ENABLE_FEAT_FPMR
36 #define SCR_FEAT_FPMR SCR_EnFPM_BIT
37 #else
38 #define SCR_FEAT_FPMR (0)
39 #endif
40 
41 #if ENABLE_FEAT_D128
42 #define SCR_FEAT_D128 SCR_D128En_BIT
43 #else
44 #define SCR_FEAT_D128 (0)
45 #endif
46 
47 #if ENABLE_FEAT_S1PIE
48 #define SCR_FEAT_S1PIE SCR_PIEN_BIT
49 #else
50 #define SCR_FEAT_S1PIE (0)
51 #endif
52 
53 #if ENABLE_FEAT_SCTLR2
54 #define SCR_FEAT_SCTLR2 SCR_SCTLR2En_BIT
55 #else
56 #define SCR_FEAT_SCTLR2 (0)
57 #endif
58 
59 #if ENABLE_FEAT_TCR2
60 #define SCR_FEAT_TCR2 SCR_TCR2EN_BIT
61 #else
62 #define SCR_FEAT_TCR2 (0)
63 #endif
64 
65 #if ENABLE_FEAT_THE
66 #define SCR_FEAT_THE SCR_RCWMASKEn_BIT
67 #else
68 #define SCR_FEAT_THE (0)
69 #endif
70 
71 #if ENABLE_SME_FOR_NS
72 #define SCR_FEAT_SME SCR_ENTP2_BIT
73 #else
74 #define SCR_FEAT_SME (0)
75 #endif
76 
77 #if ENABLE_FEAT_GCS
78 #define SCR_FEAT_GCS SCR_GCSEn_BIT
79 #else
80 #define SCR_FEAT_GCS (0)
81 #endif
82 
83 #if ENABLE_FEAT_HCX
84 #define SCR_FEAT_HCX SCR_HXEn_BIT
85 #else
86 #define SCR_FEAT_HCX (0)
87 #endif
88 
89 #if ENABLE_FEAT_LS64_ACCDATA
90 #define SCR_FEAT_LS64_ACCDATA (SCR_ADEn_BIT | SCR_EnAS0_BIT)
91 #else
92 #define SCR_FEAT_LS64_ACCDATA (0)
93 #endif
94 
95 #if ENABLE_FEAT_AMUv1p1
96 #define SCR_FEAT_AMUv1p1 SCR_AMVOFFEN_BIT
97 #else
98 #define SCR_FEAT_AMUv1p1 (0)
99 #endif
100 
101 #if ENABLE_FEAT_TWED
102 #define SCR_FEAT_TWED SCR_TWEDEn_BIT
103 #else
104 #define SCR_FEAT_TWED (0)
105 #endif
106 
107 #if ENABLE_FEAT_ECV
108 #define SCR_FEAT_ECV SCR_ECVEN_BIT
109 #else
110 #define SCR_FEAT_ECV (0)
111 #endif
112 
113 #if ENABLE_FEAT_FGT
114 #define SCR_FEAT_FGT SCR_FGTEN_BIT
115 #else
116 #define SCR_FEAT_FGT (0)
117 #endif
118 
119 #if ENABLE_FEAT_MTE2
120 #define SCR_FEAT_MTE2 SCR_ATA_BIT
121 #else
122 #define SCR_FEAT_MTE2 (0)
123 #endif
124 
125 #if ENABLE_FEAT_CSV2_2
126 #define SCR_FEAT_CSV2_2 SCR_EnSCXT_BIT
127 #else
128 #define SCR_FEAT_CSV2_2 (0)
129 #endif
130 
131 #if !RAS_TRAP_NS_ERR_REC_ACCESS
132 #define SCR_FEAT_RAS SCR_TERR_BIT
133 #else
134 #define SCR_FEAT_RAS (0)
135 #endif
136 
137 #if ENABLE_FEAT_MEC
138 #define SCR_FEAT_MEC SCR_MECEn_BIT
139 #else
140 #define SCR_FEAT_MEC (0)
141 #endif
142 
143 #if ENABLE_FEAT_AIE
144 #define SCR_FEAT_AIE SCR_AIEn_BIT
145 #else
146 #define SCR_FEAT_AIE (0)
147 #endif
148 
149 #if ENABLE_FEAT_PFAR
150 #define SCR_FEAT_PFAR SCR_PFAREn_BIT
151 #else
152 #define SCR_FEAT_PFAR (0)
153 #endif
154 
155 #ifndef SCR_PLAT_FEATS
156 #define SCR_PLAT_FEATS (0)
157 #endif
158 #ifndef SCR_PLAT_FLIPPED
159 #define SCR_PLAT_FLIPPED (0)
160 #endif
161 #ifndef SCR_PLAT_IGNORED
162 #define SCR_PLAT_IGNORED (0)
163 #endif
164 
165 #ifndef CPTR_PLAT_FEATS
166 #define CPTR_PLAT_FEATS (0)
167 #endif
168 #ifndef CPTR_PLAT_FLIPPED
169 #define CPTR_PLAT_FLIPPED (0)
170 #endif
171 
172 #ifndef MDCR_PLAT_FEATS
173 #define MDCR_PLAT_FEATS (0)
174 #endif
175 #ifndef MDCR_PLAT_FLIPPED
176 #define MDCR_PLAT_FLIPPED (0)
177 #endif
178 #ifndef MDCR_PLAT_IGNORED
179 #define MDCR_PLAT_IGNORED (0)
180 #endif
181 /*
182  * XYZ_EL3_FEATS - list all bits that are relevant for feature enablement. It's
183  * a constant list based on what features are expected. This relies on the fact
184  * that if the feature is in any way disabled, then the relevant bit will not be
185  * written by context management.
186  *
187  * XYZ_EL3_FLIPPED - bits with an active 0, rather than the usual active 1. The
188  * spec always uses active 1 to mean that the feature will not trap.
189  *
190  * XYZ_EL3_IGNORED - list of all bits that are not relevant for feature
191  * enablement and should not be reported to lower ELs
192  */
193 #define SCR_EL3_FEATS (								\
194 	SCR_FEAT_FGT2		|						\
195 	SCR_FEAT_FPMR		|						\
196 	SCR_FEAT_MEC		|						\
197 	SCR_FEAT_D128		|						\
198 	SCR_FEAT_S1PIE		|						\
199 	SCR_FEAT_SCTLR2		|						\
200 	SCR_FEAT_TCR2		|						\
201 	SCR_FEAT_THE		|						\
202 	SCR_FEAT_SME		|						\
203 	SCR_FEAT_GCS		|						\
204 	SCR_FEAT_HCX		|						\
205 	SCR_FEAT_LS64_ACCDATA	|						\
206 	SCR_FEAT_AMUv1p1	|						\
207 	SCR_FEAT_TWED		|						\
208 	SCR_FEAT_ECV		|						\
209 	SCR_FEAT_FGT		|						\
210 	SCR_FEAT_MTE2		|						\
211 	SCR_FEAT_CSV2_2		|						\
212 	SCR_APK_BIT		| /* FEAT_Pauth */				\
213 	SCR_FEAT_RAS		|						\
214 	SCR_FEAT_AIE		|						\
215 	SCR_FEAT_PFAR		|						\
216 	SCR_PLAT_FEATS)
217 #define SCR_EL3_FLIPPED (							\
218 	SCR_FEAT_RAS		|						\
219 	SCR_PLAT_FLIPPED)
220 #define SCR_EL3_IGNORED (							\
221 	SCR_API_BIT		|						\
222 	SCR_RW_BIT		|						\
223 	SCR_SIF_BIT		|						\
224 	SCR_HCE_BIT		|						\
225 	SCR_FIQ_BIT		|						\
226 	SCR_IRQ_BIT		|						\
227 	SCR_NS_BIT		|						\
228 	SCR_NSE_BIT		|						\
229 	SCR_RES1_BITS		|						\
230 	SCR_PLAT_IGNORED)
231 CASSERT((SCR_EL3_FEATS & SCR_EL3_IGNORED) == 0, scr_feat_is_ignored);
232 CASSERT((SCR_EL3_FLIPPED & SCR_EL3_FEATS) == SCR_EL3_FLIPPED, scr_flipped_not_a_feat);
233 
234 #if ENABLE_SYS_REG_TRACE_FOR_NS
235 #define CPTR_SYS_REG_TRACE (TCPAC_BIT | TTA_BIT)
236 #else
237 #define CPTR_SYS_REG_TRACE (0)
238 #endif
239 
240 #if ENABLE_FEAT_AMU
241 #define CPTR_FEAT_AMU TAM_BIT
242 #else
243 #define CPTR_FEAT_AMU (0)
244 #endif
245 
246 #if ENABLE_SME_FOR_NS
247 #define CPTR_FEAT_SME ESM_BIT
248 #else
249 #define CPTR_FEAT_SME (0)
250 #endif
251 
252 #if ENABLE_SVE_FOR_NS
253 #define CPTR_FEAT_SVE CPTR_EZ_BIT
254 #else
255 #define CPTR_FEAT_SVE (0)
256 #endif
257 
258 #define CPTR_EL3_FEATS (							\
259 	CPTR_SYS_REG_TRACE	|						\
260 	CPTR_FEAT_AMU		|						\
261 	CPTR_FEAT_SME		|						\
262 	TFP_BIT			|						\
263 	CPTR_FEAT_SVE		|						\
264 	CPTR_PLAT_FEATS)
265 #define CPTR_EL3_FLIPPED (							\
266 	CPTR_SYS_REG_TRACE	|						\
267 	CPTR_FEAT_AMU		|						\
268 	TFP_BIT			|						\
269 	CPTR_PLAT_FLIPPED)
270 CASSERT((CPTR_EL3_FLIPPED & CPTR_EL3_FEATS) == CPTR_EL3_FLIPPED, cptr_flipped_not_a_feat);
271 
272 /*
273  * Some features enables are expressed with more than 1 bit in order to cater
274  * for multi world enablement. In those cases (BRB, TRB, SPE) only the last bit
275  * is used and reported. This (ab)uses the convenient fact that the last bit
276  * always means "enabled for this world" when context switched correctly.
277  * The per-world values have been adjusted such that this is always true.
278  */
279 #if ENABLE_BRBE_FOR_NS
280 #define MDCR_FEAT_BRBE MDCR_SBRBE(1UL)
281 #else
282 #define MDCR_FEAT_BRBE (0)
283 #endif
284 
285 #if ENABLE_FEAT_FGT
286 #define MDCR_FEAT_FGT MDCR_TDCC_BIT
287 #else
288 #define MDCR_FEAT_FGT (0)
289 #endif
290 
291 #if ENABLE_TRBE_FOR_NS
292 #define MDCR_FEAT_TRBE MDCR_NSTB_EN_BIT
293 #else
294 #define MDCR_FEAT_TRBE (0)
295 #endif
296 
297 #if ENABLE_TRF_FOR_NS
298 #define MDCR_FEAT_TRF MDCR_TTRF_BIT
299 #else
300 #define MDCR_FEAT_TRF (0)
301 #endif
302 
303 #if ENABLE_SPE_FOR_NS
304 #define MDCR_FEAT_SPE MDCR_NSPB_EN_BIT
305 #else
306 #define MDCR_FEAT_SPE (0)
307 #endif
308 
309 #if ENABLE_FEAT_DEBUGV8P9
310 #define MDCR_DEBUGV8P9 MDCR_EBWE_BIT
311 #else
312 #define MDCR_DEBUGV8P9 (0)
313 #endif
314 
315 #if ENABLE_FEAT_EBEP
316 #define MDCR_FEAT_EBEP MDCR_PMEE(MDCR_PMEE_CTRL_EL2)
317 #else
318 #define MDCR_FEAT_EBEP (0)
319 #endif
320 
321 #define MDCR_EL3_FEATS (							\
322 	MDCR_DEBUGV8P9		|						\
323 	MDCR_FEAT_BRBE		|						\
324 	MDCR_FEAT_FGT		|						\
325 	MDCR_FEAT_TRBE		|						\
326 	MDCR_FEAT_TRF		|						\
327 	MDCR_FEAT_SPE		|						\
328 	MDCR_FEAT_EBEP		|						\
329 	MDCR_TDOSA_BIT		|						\
330 	MDCR_TDA_BIT		|						\
331 	MDCR_EnPM2_BIT		|						\
332 	MDCR_TPM_BIT		| /* FEAT_PMUv3 */				\
333 	MDCR_PLAT_FEATS)
334 #define MDCR_EL3_FLIPPED (							\
335 	MDCR_FEAT_FGT		|						\
336 	MDCR_FEAT_TRF		|						\
337 	MDCR_TDOSA_BIT		|						\
338 	MDCR_TDA_BIT		|						\
339 	MDCR_TPM_BIT		|						\
340 	MDCR_PLAT_FLIPPED)
341 #define MDCR_EL3_IGNORED (							\
342 	MDCR_EnPMS3_BIT		|						\
343 	MDCR_EnPMSN_BIT		|						\
344 	MDCR_SBRBE(2UL)		|						\
345 	MDCR_MTPME_BIT		|						\
346 	MDCR_NSTBE_BIT		|						\
347 	MDCR_NSTB_SS_BIT	|						\
348 	MDCR_MCCD_BIT		|						\
349 	MDCR_SCCD_BIT		|						\
350 	MDCR_SDD_BIT		|						\
351 	MDCR_SPD32(3UL)		|						\
352 	MDCR_NSPB_SS_BIT	|						\
353 	MDCR_NSPBE_BIT		|						\
354 	MDCR_PLAT_IGNORED)
355 CASSERT((MDCR_EL3_FEATS & MDCR_EL3_IGNORED) == 0, mdcr_feat_is_ignored);
356 CASSERT((MDCR_EL3_FLIPPED & MDCR_EL3_FEATS) == MDCR_EL3_FLIPPED, mdcr_flipped_not_a_feat);
357 
358 #define MPAM3_EL3_FEATS		(MPAM3_EL3_TRAPLOWER_BIT)
359 #define MPAM3_EL3_FLIPPED	(MPAM3_EL3_TRAPLOWER_BIT)
360 #define MPAM3_EL3_IGNORED	(MPAM3_EL3_MPAMEN_BIT)
361 CASSERT((MPAM3_EL3_FEATS & MPAM3_EL3_IGNORED) == 0, mpam3_feat_is_ignored);
362 CASSERT((MPAM3_EL3_FLIPPED & MPAM3_EL3_FEATS) == MPAM3_EL3_FLIPPED, mpam3_flipped_not_a_feat);
363 
364 /* The hex representations of these registers' S3 encoding */
365 #define SCR_EL3_OPCODE  			U(0x1E1100)
366 #define CPTR_EL3_OPCODE 			U(0x1E1140)
367 #define MDCR_EL3_OPCODE 			U(0x1E1320)
368 #define MPAM3_EL3_OPCODE 			U(0x1EA500)
369 
370 #endif /* ARCH_FEATURE_AVAILABILITY */
371 #endif /* __ASSEMBLER__ */
372 #endif /* ARM_ARCH_SVC_H */
373