xref: /rk3399_ARM-atf/make_helpers/arch_features.mk (revision 38e580e6411c7a2eb2801a6aacb0a19bb9b1ac46)
1#
2# Copyright (c) 2022-2025, Arm Limited. All rights reserved.
3#
4# SPDX-License-Identifier: BSD-3-Clause
5#
6
7# This file lists all of the architectural features, and initializes
8# and enables them based on the configured architecture version.
9
10# This file follows the following format:
11#   - Enable mandatory feature if not updated, as applicable to an Arch Version.
12#   - By default disable any mandatory features if they have not been defined yet.
13#   - Disable or enable any optional feature this would be enabled/disabled if needed by platform.
14
15#
16################################################################################
17# Enable Mandatory features if not updated yet, based on Arch versions.
18################################################################################
19#
20
21# Enable the features which are mandatory from ARCH version 8.1 and upwards.
22ifeq "8.1" "$(word 1, $(sort 8.1 $(ARM_ARCH_MAJOR).$(ARM_ARCH_MINOR)))"
23armv8-1-a-feats         := ENABLE_FEAT_PAN ENABLE_FEAT_VHE
24
25FEAT_LIST               := ${armv8-1-a-feats}
26endif
27
28# Enable the features which are mandatory from ARCH version 8.2 and upwards.
29ifeq "8.2" "$(word 1, $(sort 8.2 $(ARM_ARCH_MAJOR).$(ARM_ARCH_MINOR)))"
30armv8-2-a-feats         := ENABLE_FEAT_RAS
31# 8.1 Compliant
32armv8-2-a-feats         += ${armv8-1-a-feats}
33
34FEAT_LIST               := ${armv8-2-a-feats}
35endif
36
37# Enable the features which are mandatory from ARCH version 8.3 and upwards.
38ifeq "8.3" "$(word 1, $(sort 8.3 $(ARM_ARCH_MAJOR).$(ARM_ARCH_MINOR)))"
39# 8.2 Compliant
40armv8-3-a-feats         += ${armv8-2-a-feats}
41
42FEAT_LIST               := ${armv8-3-a-feats}
43endif
44
45# Enable the features which are mandatory from ARCH version 8.4 and upwards.
46ifeq "8.4" "$(word 1, $(sort 8.4 $(ARM_ARCH_MAJOR).$(ARM_ARCH_MINOR)))"
47armv8-4-a-feats         := ENABLE_FEAT_SEL2 ENABLE_TRF_FOR_NS ENABLE_FEAT_DIT
48# 8.3 Compliant
49armv8-4-a-feats         += ${armv8-3-a-feats}
50
51FEAT_LIST               := ${armv8-4-a-feats}
52endif
53
54# Enable the features which are mandatory from ARCH version 8.5 and upwards.
55ifeq "8.5" "$(word 1, $(sort 8.5 $(ARM_ARCH_MAJOR).$(ARM_ARCH_MINOR)))"
56armv8-5-a-feats         := ENABLE_FEAT_RNG ENABLE_FEAT_SB
57# 8.4 Compliant
58armv8-5-a-feats         += ${armv8-4-a-feats}
59
60FEAT_LIST               := ${armv8-5-a-feats}
61endif
62
63# Enable the features which are mandatory from ARCH version 8.6 and upwards.
64ifeq "8.6" "$(word 1, $(sort 8.6 $(ARM_ARCH_MAJOR).$(ARM_ARCH_MINOR)))"
65armv8-6-a-feats         := ENABLE_FEAT_ECV ENABLE_FEAT_FGT
66# 8.5 Compliant
67armv8-6-a-feats         += ${armv8-5-a-feats}
68FEAT_LIST               := ${armv8-6-a-feats}
69endif
70
71# Enable the features which are mandatory from ARCH version 8.7 and upwards.
72ifeq "8.7" "$(word 1, $(sort 8.7 $(ARM_ARCH_MAJOR).$(ARM_ARCH_MINOR)))"
73armv8-7-a-feats         := ENABLE_FEAT_HCX
74# 8.6 Compliant
75armv8-7-a-feats         += ${armv8-6-a-feats}
76FEAT_LIST               := ${armv8-7-a-feats}
77endif
78
79# Enable the features which are mandatory from ARCH version 8.8 and upwards.
80ifeq "8.8" "$(word 1, $(sort 8.8 $(ARM_ARCH_MAJOR).$(ARM_ARCH_MINOR)))"
81armv8-8-a-feats		:= ENABLE_FEAT_MOPS
82# 8.7 Compliant
83armv8-8-a-feats         += ${armv8-7-a-feats}
84FEAT_LIST               := ${armv8-8-a-feats}
85endif
86
87# Enable the features which are mandatory from ARCH version 8.9 and upwards.
88ifeq "8.9" "$(word 1, $(sort 8.9 $(ARM_ARCH_MAJOR).$(ARM_ARCH_MINOR)))"
89armv8-9-a-feats         := ENABLE_FEAT_TCR2 ENABLE_FEAT_DEBUGV8P9	\
90			   ENABLE_FEAT_SCTLR2 ENABLE_FEAT_CLRBHB
91# 8.8 Compliant
92armv8-9-a-feats         += ${armv8-8-a-feats}
93FEAT_LIST               := ${armv8-9-a-feats}
94endif
95
96# Enable the features which are mandatory from ARCH version 9.0 and upwards.
97ifeq "9.0" "$(word 1, $(sort 9.0 $(ARM_ARCH_MAJOR).$(ARM_ARCH_MINOR)))"
98# 8.5 Compliant
99armv9-0-a-feats         += ${armv8-5-a-feats}
100FEAT_LIST               := ${armv9-0-a-feats}
101endif
102
103# Enable the features which are mandatory from ARCH version 9.1 and upwards.
104ifeq "9.1" "$(word 1, $(sort 9.1 $(ARM_ARCH_MAJOR).$(ARM_ARCH_MINOR)))"
105# 8.6 and 9.0 Compliant
106armv9-1-a-feats         += ${armv8-6-a-feats} ${armv9-0-a-feats}
107FEAT_LIST               := ${armv9-1-a-feats}
108endif
109
110# Enable the features which are mandatory from ARCH version 9.2 and upwards.
111ifeq "9.2" "$(word 1, $(sort 9.2 $(ARM_ARCH_MAJOR).$(ARM_ARCH_MINOR)))"
112# 8.7 and 9.1 Compliant
113armv9-2-a-feats         += ${armv8-7-a-feats} ${armv9-1-a-feats}
114FEAT_LIST               := ${armv9-2-a-feats}
115endif
116
117# Enable the features which are mandatory from ARCH version 9.3 and upwards.
118ifeq "9.3" "$(word 1, $(sort 9.3 $(ARM_ARCH_MAJOR).$(ARM_ARCH_MINOR)))"
119# 8.8 and 9.2 Compliant
120armv9-3-a-feats         += ${armv8-8-a-feats} ${armv9-2-a-feats}
121FEAT_LIST               := ${armv9-3-a-feats}
122endif
123
124# Enable the features which are mandatory from ARCH version 9.4 and upwards.
125ifeq "9.4" "$(word 1, $(sort 9.4 $(ARM_ARCH_MAJOR).$(ARM_ARCH_MINOR)))"
126# 8.9 and 9.3 Compliant
127armv9-4-a-feats         += ${armv8-9-a-feats} ${armv9-3-a-feats}
128FEAT_LIST               := ${armv9-4-a-feats}
129endif
130
131# Enable the features which are mandatory from ARCH version 9.5 and upwards.
132ifeq "9.5" "$(word 1, $(sort 9.5 $(ARM_ARCH_MAJOR).$(ARM_ARCH_MINOR)))"
133# 9.4 Compliant
134armv9-5-a-feats         += ${armv9-4-a-feats}
135FEAT_LIST               := ${armv9-5-a-feats}
136endif
137
138# Enable the features which are mandatory from ARCH version 9.6 and upwards.
139ifeq "9.6" "$(word 1, $(sort 9.6 $(ARM_ARCH_MAJOR).$(ARM_ARCH_MINOR)))"
140# 9.5 Compliant
141armv9-6-a-feats         := ENABLE_FEAT_UINJ
142armv9-6-a-feats         += ${armv9-5-a-feats}
143FEAT_LIST               := ${armv9-6-a-feats}
144endif
145
146# Set all FEAT_* in FEAT_LIST to '1' if they are not yet defined or set
147# from build commandline options or platform makefile.
148$(eval $(call default_ones, ${sort ${FEAT_LIST}}))
149
150#
151################################################################################
152# Set mandatory features by default to zero, if they are not already updated.
153################################################################################
154#
155
156# Flag to enable the spinlock implementation variant using the FEAT_LSE
157# compare-and-swap instruction.
158USE_SPINLOCK_CAS		?=	0
159
160#----
161# 8.1
162#----
163
164# Flag to enable access to Privileged Access Never bit of PSTATE.
165ENABLE_FEAT_PAN			?=	0
166
167# Flag to enable Virtualization Host Extensions.
168ENABLE_FEAT_VHE			?=	0
169
170#----
171# 8.2
172#----
173
174# Enable RAS Support.
175ENABLE_FEAT_RAS			?=	0
176
177#----
178# 8.3
179#----
180
181# Flag to enable Pointer Authentication. Internal flag not meant for
182# direct setting. Use BRANCH_PROTECTION to enable PAUTH.
183ENABLE_PAUTH			?=	0
184
185# FEAT_PAUTH_LR is an optional architectural feature, so this flag must be set
186# manually in addition to the BRANCH_PROTECTION flag which is used for other
187# branch protection and pointer authentication features.
188ENABLE_FEAT_PAUTH_LR		?=	0
189
190# Include pointer authentication (ARMv8.3-PAuth) registers in cpu context. This
191# must be set to 1 if the platform wants to use this feature in the Secure
192# world. It is not necessary for use in the Non-secure world.
193CTX_INCLUDE_PAUTH_REGS		?=	0
194
195
196#----
197# 8.4
198#----
199
200# Flag to enable Secure EL-2 feature.
201ENABLE_FEAT_SEL2		?=	0
202
203# By default, disable trace filter control register access to lower non-secure
204# exception levels, i.e. NS-EL2, or NS-EL1 if NS-EL2 is implemented, but
205# trace filter control register access is unused if FEAT_TRF is implemented.
206ENABLE_TRF_FOR_NS		?=	0
207
208# Flag to enable Data Independent Timing instructions.
209ENABLE_FEAT_DIT			?=	0
210
211#----
212# 8.5
213#----
214
215# Flag to enable Branch Target Identification.
216# Internal flag not meant for direct setting.
217# Use BRANCH_PROTECTION to enable BTI.
218ENABLE_BTI			?=	0
219
220# Flag to enable access to the Random Number Generator registers.
221ENABLE_FEAT_RNG			?=	0
222
223# Flag to enable Speculation Barrier Instruction.
224ENABLE_FEAT_SB			?=	0
225
226#----
227# 8.6
228#----
229
230# Flag to enable access to the CNTPOFF_EL2 register.
231ENABLE_FEAT_ECV			?=	0
232
233# Flag to enable access to the HDFGRTR_EL2 register.
234ENABLE_FEAT_FGT			?=	0
235
236#----
237# 8.7
238#----
239
240# Flag to enable access to the HCRX_EL2 register by setting SCR_EL3.HXEn.
241ENABLE_FEAT_HCX			?=	0
242
243#----
244# 8.8
245#----
246
247# Flag to enable FEAT_MOPS (Standardization of Memory operations)
248# when INIT_UNUSED_NS_EL2 = 1
249ENABLE_FEAT_MOPS		?=	0
250
251#----
252# 8.9
253#----
254
255# Flag to enable access to TCR2 (FEAT_TCR2).
256ENABLE_FEAT_TCR2		?=	0
257
258# Flag to enable access to SCTLR2 (FEAT_SCTLR2).
259ENABLE_FEAT_SCTLR2		?=	0
260
261#
262################################################################################
263# Optional Features defaulted to 0 or 2, if they are not enabled from
264# build option. Can also be disabled or enabled by platform if needed.
265################################################################################
266#
267
268#----
269# 8.0
270#----
271
272# Flag to enable support for clrbhb instruction.
273ENABLE_FEAT_CLRBHB			?=	0
274
275# Flag to enable CSV2_2 extension.
276ENABLE_FEAT_CSV2_2			?=	0
277
278# Flag to enable CSV2_3 extension. FEAT_CSV2_3 enables access to the
279# SCXTNUM_ELx register.
280ENABLE_FEAT_CSV2_3			?=	0
281
282# By default, disable access of trace system registers from NS lower
283# ELs  i.e. NS-EL2, or NS-EL1 if NS-EL2 implemented but unused if
284# system register trace is implemented. This feature is available if
285# trace unit such as ETMv4.x, This feature is OPTIONAL and is only
286# permitted in Armv8 implementations.
287ENABLE_SYS_REG_TRACE_FOR_NS		?=	0
288
289#----
290# 8.2
291#----
292
293# Build option to enable/disable the Statistical Profiling Extension,
294# keep it enabled by default for AArch64.
295ifeq (${ARCH},aarch64)
296       ENABLE_SPE_FOR_NS		?=	2
297else ifeq (${ARCH},aarch32)
298       ENABLE_SPE_FOR_NS		:=	0
299endif
300
301# Enable SVE for non-secure world by default.
302ifeq (${ARCH},aarch64)
303       ENABLE_SVE_FOR_NS		?=	2
304# SVE is only supported on AArch64 so disable it on AArch32.
305else ifeq (${ARCH},aarch32)
306       ENABLE_SVE_FOR_NS		:=	0
307endif
308
309#----
310# 8.4
311#----
312
313# Feature flags for supporting Activity monitor extensions.
314ENABLE_FEAT_AMU				?=	0
315ENABLE_AMU_AUXILIARY_COUNTERS		?=	0
316AMU_RESTRICT_COUNTERS			?=	1
317
318# Build option to enable MPAM for lower ELs.
319# Enabling it by default
320ifeq (${ARCH},aarch64)
321        ENABLE_FEAT_MPAM		?=	2
322else ifeq (${ARCH},aarch32)
323        ENABLE_FEAT_MPAM		:=	0
324endif
325
326# Include nested virtualization control (Armv8.4-NV) registers in cpu context.
327# This must be set to 1 if architecture implements Nested Virtualization
328# Extension and platform wants to use this feature in the Secure world.
329CTX_INCLUDE_NEVE_REGS			?=	0
330
331#----
332# 8.5
333#----
334
335# Flag to enable support for EL3 trapping of reads of the RNDR and RNDRRS
336# registers, by setting SCR_EL3.TRNDR.
337ENABLE_FEAT_RNG_TRAP			?=	0
338
339# Enable FEAT_MTE2. This must be set to 1 if the platform wants
340# to use this feature and is enabled at ELX.
341ENABLE_FEAT_MTE2		        ?=	0
342
343#----
344# 8.6
345#----
346
347# Flag to enable AMUv1p1 extension.
348ENABLE_FEAT_AMUv1p1			?=	0
349
350# Flag to enable delayed trapping of WFE instruction (FEAT_TWED).
351ENABLE_FEAT_TWED			?=	0
352
353# In v8.6+ platforms with delayed trapping of WFE being supported
354# via FEAT_TWED, this flag takes the delay value to be set in the
355# SCR_EL3.TWEDEL(4bit) field, when FEAT_TWED is implemented.
356# By default it takes 0, and need to be updated by the platforms.
357TWED_DELAY				?=	0
358
359# Disable MTPMU if FEAT_MTPMU is supported.
360DISABLE_MTPMU				?=	0
361
362# Flag to enable FEAT_FGT2 (Fine Granular Traps 2)
363ENABLE_FEAT_FGT2			?=	0
364
365# LoadStore64Bytes extension using the ACCDATA_EL1 system register
366ENABLE_FEAT_LS64_ACCDATA		?=	0
367
368#----
369# 8.8
370#----
371
372# Flag to enable FEAT_THE (Translation Hardening Extension)
373ENABLE_FEAT_THE				?=	0
374
375#----
376# 8.9
377#----
378
379# Flag to enable access to Stage 2 Permission Indirection (FEAT_S2PIE).
380ENABLE_FEAT_S2PIE			?=	0
381
382# Flag to enable access to Stage 1 Permission Indirection (FEAT_S1PIE).
383ENABLE_FEAT_S1PIE			?=	0
384
385# Flag to enable access to Stage 2 Permission Overlay (FEAT_S2POE).
386ENABLE_FEAT_S2POE			?=	0
387
388# Flag to enable access to Stage 1 Permission Overlay (FEAT_S1POE).
389ENABLE_FEAT_S1POE			?=	0
390
391# Flag to enable access to Arm v8.9 Debug extension
392ENABLE_FEAT_DEBUGV8P9			?=	0
393
394# AIE extension using the (A)MAIR2 system registers
395ENABLE_FEAT_AIE				?=	0
396
397# PFAR extension using the PFAR system registers
398ENABLE_FEAT_PFAR			?=	0
399
400#----
401# 9.0
402#----
403
404# Scalable Matrix Extension for non-secure world.
405ENABLE_SME_FOR_NS			?=	0
406
407# Scalable Vector Extension for secure world.
408ENABLE_SVE_FOR_SWD			?=	0
409
410# By default, disable access of trace buffer control registers from NS
411# lower ELs  i.e. NS-EL2, or NS-EL1 if NS-EL2 implemented but unused
412# if FEAT_TRBE is implemented.
413# Note FEAT_TRBE is only supported on AArch64 - therefore do not enable in
414# AArch32.
415ifeq (${ARCH},aarch64)
416        ENABLE_TRBE_FOR_NS		?=	0
417else ifeq (${ARCH},aarch32)
418        ifneq ($(or $(ENABLE_TRBE_FOR_NS),0),0)
419               $(error ENABLE_TRBE_FOR_NS is not supported for AArch32)
420        else
421               ENABLE_TRBE_FOR_NS 	:=	0
422        endif
423endif
424
425# Flag that enables hardware injection of undefined exceptions
426ENABLE_FEAT_UINJ			?=	0
427
428#----
429# 9.2
430#----
431
432# Flag to enable Realm Management Extension (FEAT_RME).
433ENABLE_RME				?=	0
434
435# Scalable Matrix Extension version 2 for non-secure world.
436ENABLE_SME2_FOR_NS			?=	0
437
438# Scalable Matrix Extension for secure world.
439ENABLE_SME_FOR_SWD			?=	0
440
441# By default, disable access to branch record buffer control registers from NS
442# lower ELs i.e. NS-EL2, or NS-EL1 if NS-EL2 implemented but unused
443# if FEAT_BRBE is implemented.
444ENABLE_BRBE_FOR_NS			?=	0
445
446# Flag to enable Floating point exception Mode Register Feature (FEAT_FPMR)
447ENABLE_FEAT_FPMR			?=	0
448
449# Flag to enable Memory Encryption Contexts (FEAT_MEC).
450ENABLE_FEAT_MEC				?=	0
451
452#----
453# 9.3
454#----
455# Flag to enable access to Arm v9.3 FEAT_D128 extension
456ENABLE_FEAT_D128			?=	0
457
458# Flag to enable access to GICv5 CPU interface extension (FEAT_GCIE)
459ENABLE_FEAT_GCIE			?=	0
460
461# Enables access to PE-side MPAM bandwidth controls (FEAT_MPAM_PE_BW_CTRL)
462ENABLE_FEAT_MPAM_PE_BW_CTRL		?=	0
463
464# Flag to enable Exception-based Event Profiling (FEAT_EBEP)
465ENABLE_FEAT_EBEP			?=	0
466
467#----
468#9.4
469#----
470
471# Flag to enable FEAT_RME_GDI
472ENABLE_FEAT_RME_GDI			?=	0
473
474# Flag to enable access to Guarded Control Stack (FEAT_GCS).
475ENABLE_FEAT_GCS				?=	0
476
477# Flag to enable Fine Grained Write Traps (FEAT_FGWTE3) for EL3.
478ENABLE_FEAT_FGWTE3			?=	0
479
480# Flag to enable checked pointer arithmetic (FEAT_CPA2) for EL3.
481# We don't have a flag for FEAT_CPA since that has no effect on software
482ENABLE_FEAT_CPA2			?=	0
483
484#----
485#9.6
486#----
487
488# Flag to enable trapping of ID registers to EL3
489ENABLE_FEAT_IDTE3                       ?=      0
490