blob: 5fb56b992780df9ccaf3fa3d7f662a833d5a0c2f [file] [log] [blame]
Jayanth Dodderi Chidanand9461a892022-01-17 18:57:17 +00001/*
2 * Copyright (c) 2022, Arm Limited and Contributors. All rights reserved.
3 *
4 * SPDX-License-Identifier: BSD-3-Clause
5 */
6
Andre Przywara5b005112022-11-14 15:38:58 +00007#include <arch_features.h>
8#include <common/debug.h>
Jayanth Dodderi Chidanand9461a892022-01-17 18:57:17 +00009#include <common/feat_detect.h>
10
Andre Przywaracc4118d2022-11-14 15:42:44 +000011static bool tainted;
12
Jayanth Dodderi Chidanand9461a892022-01-17 18:57:17 +000013/*******************************************************************************
14 * This section lists the wrapper modules for each feature to evaluate the
Andre Przywara5b005112022-11-14 15:38:58 +000015 * feature states (FEAT_STATE_ALWAYS and FEAT_STATE_CHECK) and perform
16 * necessary action as below:
Jayanth Dodderi Chidanand9461a892022-01-17 18:57:17 +000017 *
18 * It verifies whether the FEAT_XXX (eg: FEAT_SB) is supported by the PE or not.
19 * Without this check an exception would occur during context save/restore
20 * routines, if the feature is enabled but not supported by PE.
21 ******************************************************************************/
22
Andre Przywara5b005112022-11-14 15:38:58 +000023#define feat_detect_panic(a, b) ((a) ? (void)0 : feature_panic(b))
24
25/*******************************************************************************
26 * Function : feature_panic
27 * Customised panic function with error logging mechanism to list the feature
28 * not supported by the PE.
29 ******************************************************************************/
30static inline void feature_panic(char *feat_name)
31{
32 ERROR("FEAT_%s not supported by the PE\n", feat_name);
33 panic();
34}
35
Andre Przywaracc4118d2022-11-14 15:42:44 +000036/*******************************************************************************
37 * Function : check_feature
38 * Check for a valid combination of build time flags (ENABLE_FEAT_xxx) and
Andre Przywara2f3e79a2023-02-01 11:46:31 +000039 * feature availability on the hardware. <min> is the smallest feature
40 * ID field value that is required for that feature.
41 * Triggers a panic later if a feature is forcefully enabled, but not
42 * available on the PE. Also will panic if the hardware feature ID field
43 * is larger than the maximum known and supported number, specified by <max>.
Andre Przywaracc4118d2022-11-14 15:42:44 +000044 *
45 * We force inlining here to let the compiler optimise away the whole check
46 * if the feature is disabled at build time (FEAT_STATE_DISABLED).
47 ******************************************************************************/
48static inline void __attribute((__always_inline__))
Andre Przywara2f3e79a2023-02-01 11:46:31 +000049check_feature(int state, unsigned long field, const char *feat_name,
50 unsigned int min, unsigned int max)
Andre Przywaracc4118d2022-11-14 15:42:44 +000051{
Andre Przywara2f3e79a2023-02-01 11:46:31 +000052 if (state == FEAT_STATE_ALWAYS && field < min) {
Andre Przywaracc4118d2022-11-14 15:42:44 +000053 ERROR("FEAT_%s not supported by the PE\n", feat_name);
54 tainted = true;
55 }
Andre Przywara2f3e79a2023-02-01 11:46:31 +000056 if (state >= FEAT_STATE_ALWAYS && field > max) {
57 ERROR("FEAT_%s is version %ld, but is only known up to version %d\n",
58 feat_name, field, max);
59 tainted = true;
60 }
Andre Przywaracc4118d2022-11-14 15:42:44 +000061}
62
Jayanth Dodderi Chidanand9461a892022-01-17 18:57:17 +000063/******************************************
64 * Feature : FEAT_SB (Speculation Barrier)
65 *****************************************/
66static void read_feat_sb(void)
67{
Andre Przywara5b005112022-11-14 15:38:58 +000068#if (ENABLE_FEAT_SB == FEAT_STATE_ALWAYS)
Jayanth Dodderi Chidanand9461a892022-01-17 18:57:17 +000069 feat_detect_panic(is_armv8_0_feat_sb_present(), "SB");
70#endif
71}
72
73/******************************************************
74 * Feature : FEAT_CSV2_2 (Cache Speculation Variant 2)
75 *****************************************************/
76static void read_feat_csv2_2(void)
77{
Andre Przywara5b005112022-11-14 15:38:58 +000078#if (ENABLE_FEAT_CSV2_2 == FEAT_STATE_ALWAYS)
Jayanth Dodderi Chidanand9461a892022-01-17 18:57:17 +000079 feat_detect_panic(is_armv8_0_feat_csv2_2_present(), "CSV2_2");
80#endif
81}
82
83/***********************************************
84 * Feature : FEAT_PAN (Privileged Access Never)
85 **********************************************/
86static void read_feat_pan(void)
87{
Andre Przywara5b005112022-11-14 15:38:58 +000088#if (ENABLE_FEAT_PAN == FEAT_STATE_ALWAYS)
Jayanth Dodderi Chidanand9461a892022-01-17 18:57:17 +000089 feat_detect_panic(is_armv8_1_pan_present(), "PAN");
90#endif
91}
92
93/******************************************************
94 * Feature : FEAT_VHE (Virtualization Host Extensions)
95 *****************************************************/
96static void read_feat_vhe(void)
97{
Andre Przywara5b005112022-11-14 15:38:58 +000098#if (ENABLE_FEAT_VHE == FEAT_STATE_ALWAYS)
Jayanth Dodderi Chidanand9461a892022-01-17 18:57:17 +000099 feat_detect_panic(is_armv8_1_vhe_present(), "VHE");
100#endif
101}
102
103/*******************************************************************************
104 * Feature : FEAT_RAS (Reliability, Availability, and Serviceability Extension)
105 ******************************************************************************/
106static void read_feat_ras(void)
107{
Andre Przywara5b005112022-11-14 15:38:58 +0000108#if (RAS_EXTENSION == FEAT_STATE_ALWAYS)
Jayanth Dodderi Chidanand9461a892022-01-17 18:57:17 +0000109 feat_detect_panic(is_armv8_2_feat_ras_present(), "RAS");
110#endif
111}
112
113/************************************************
114 * Feature : FEAT_PAUTH (Pointer Authentication)
115 ***********************************************/
116static void read_feat_pauth(void)
117{
Andre Przywara5b005112022-11-14 15:38:58 +0000118#if (ENABLE_PAUTH == FEAT_STATE_ALWAYS) || (CTX_INCLUDE_PAUTH_REGS == FEAT_STATE_ALWAYS)
Jayanth Dodderi Chidanand9461a892022-01-17 18:57:17 +0000119 feat_detect_panic(is_armv8_3_pauth_present(), "PAUTH");
120#endif
121}
122
123/************************************************************
124 * Feature : FEAT_DIT (Data Independent Timing Instructions)
125 ***********************************************************/
126static void read_feat_dit(void)
127{
Andre Przywara5b005112022-11-14 15:38:58 +0000128#if (ENABLE_FEAT_DIT == FEAT_STATE_ALWAYS)
Jayanth Dodderi Chidanand9461a892022-01-17 18:57:17 +0000129 feat_detect_panic(is_armv8_4_feat_dit_present(), "DIT");
130#endif
131}
132
Jayanth Dodderi Chidanand9461a892022-01-17 18:57:17 +0000133/****************************************************************************
134 * Feature : FEAT_MPAM (Memory Partitioning and Monitoring (MPAM) Extension)
135 ***************************************************************************/
136static void read_feat_mpam(void)
137{
Andre Przywara5b005112022-11-14 15:38:58 +0000138#if (ENABLE_MPAM_FOR_LOWER_ELS == FEAT_STATE_ALWAYS)
Jayanth Dodderi Chidanand9461a892022-01-17 18:57:17 +0000139 feat_detect_panic(get_mpam_version() != 0U, "MPAM");
140#endif
141}
142
143/**************************************************************
144 * Feature : FEAT_NV2 (Enhanced Nested Virtualization Support)
145 *************************************************************/
146static void read_feat_nv2(void)
147{
Andre Przywara5b005112022-11-14 15:38:58 +0000148#if (CTX_INCLUDE_NEVE_REGS == FEAT_STATE_ALWAYS)
Jayanth Dodderi Chidanand9461a892022-01-17 18:57:17 +0000149 unsigned int nv = get_armv8_4_feat_nv_support();
150
151 feat_detect_panic((nv == ID_AA64MMFR2_EL1_NV2_SUPPORTED), "NV2");
152#endif
153}
154
155/***********************************
156 * Feature : FEAT_SEL2 (Secure EL2)
157 **********************************/
158static void read_feat_sel2(void)
159{
Andre Przywara5b005112022-11-14 15:38:58 +0000160#if (ENABLE_FEAT_SEL2 == FEAT_STATE_ALWAYS)
Jayanth Dodderi Chidanand9461a892022-01-17 18:57:17 +0000161 feat_detect_panic(is_armv8_4_sel2_present(), "SEL2");
162#endif
163}
164
Jayanth Dodderi Chidanand9461a892022-01-17 18:57:17 +0000165/************************************************
166 * Feature : FEAT_MTE (Memory Tagging Extension)
167 ***********************************************/
168static void read_feat_mte(void)
169{
Andre Przywara5b005112022-11-14 15:38:58 +0000170#if (CTX_INCLUDE_MTE_REGS == FEAT_STATE_ALWAYS)
Jayanth Dodderi Chidanand9461a892022-01-17 18:57:17 +0000171 unsigned int mte = get_armv8_5_mte_support();
172
173 feat_detect_panic((mte != MTE_UNIMPLEMENTED), "MTE");
174#endif
175}
176
177/***********************************************
178 * Feature : FEAT_RNG (Random Number Generator)
179 **********************************************/
180static void read_feat_rng(void)
181{
Andre Przywara5b005112022-11-14 15:38:58 +0000182#if (ENABLE_FEAT_RNG == FEAT_STATE_ALWAYS)
Jayanth Dodderi Chidanand9461a892022-01-17 18:57:17 +0000183 feat_detect_panic(is_armv8_5_rng_present(), "RNG");
184#endif
185}
186
187/****************************************************
188 * Feature : FEAT_BTI (Branch Target Identification)
189 ***************************************************/
190static void read_feat_bti(void)
191{
Andre Przywara5b005112022-11-14 15:38:58 +0000192#if (ENABLE_BTI == FEAT_STATE_ALWAYS)
Jayanth Dodderi Chidanand9461a892022-01-17 18:57:17 +0000193 feat_detect_panic(is_armv8_5_bti_present(), "BTI");
194#endif
195}
196
Jayanth Dodderi Chidanand9461a892022-01-17 18:57:17 +0000197/***********************************************
198 * Feature : FEAT_AMUv1p1 (AMU Extensions v1.1)
199 **********************************************/
200static void read_feat_amuv1p1(void)
201{
Andre Przywara5b005112022-11-14 15:38:58 +0000202#if (ENABLE_FEAT_AMUv1p1 == FEAT_STATE_ALWAYS)
Jayanth Dodderi Chidanand9461a892022-01-17 18:57:17 +0000203 feat_detect_panic(is_armv8_6_feat_amuv1p1_present(), "AMUv1p1");
204#endif
205}
206
207/*******************************************************
208 * Feature : FEAT_ECV (Enhanced Counter Virtualization)
209 ******************************************************/
210static void read_feat_ecv(void)
211{
Andre Przywara5b005112022-11-14 15:38:58 +0000212#if (ENABLE_FEAT_ECV == FEAT_STATE_ALWAYS)
Jayanth Dodderi Chidanand9461a892022-01-17 18:57:17 +0000213 unsigned int ecv = get_armv8_6_ecv_support();
214
215 feat_detect_panic(((ecv == ID_AA64MMFR0_EL1_ECV_SUPPORTED) ||
216 (ecv == ID_AA64MMFR0_EL1_ECV_SELF_SYNCH)), "ECV");
217#endif
218}
219
Jayanth Dodderi Chidanand4b5489c2022-03-28 15:28:55 +0100220/***********************************************************
221 * Feature : FEAT_TWED (Delayed Trapping of WFE Instruction)
222 **********************************************************/
223static void read_feat_twed(void)
224{
Andre Przywara5b005112022-11-14 15:38:58 +0000225#if (ENABLE_FEAT_TWED == FEAT_STATE_ALWAYS)
Jayanth Dodderi Chidanand4b5489c2022-03-28 15:28:55 +0100226 feat_detect_panic(is_armv8_6_twed_present(), "TWED");
227#endif
228}
229
Jayanth Dodderi Chidanand9461a892022-01-17 18:57:17 +0000230/**************************************************
231 * Feature : FEAT_RME (Realm Management Extension)
232 *************************************************/
233static void read_feat_rme(void)
234{
Andre Przywara5b005112022-11-14 15:38:58 +0000235#if (ENABLE_RME == FEAT_STATE_ALWAYS)
Jayanth Dodderi Chidanand9461a892022-01-17 18:57:17 +0000236 feat_detect_panic((get_armv9_2_feat_rme_support() !=
237 ID_AA64PFR0_FEAT_RME_NOT_SUPPORTED), "RME");
238#endif
239}
240
Juan Pablo Conde42305f22022-07-12 16:40:29 -0400241/******************************************************************
242 * Feature : FEAT_RNG_TRAP (Trapping support for RNDR/RNDRRS)
243 *****************************************************************/
244static void read_feat_rng_trap(void)
245{
Andre Przywara5b005112022-11-14 15:38:58 +0000246#if (ENABLE_FEAT_RNG_TRAP == FEAT_STATE_ALWAYS)
Juan Pablo Conde42305f22022-07-12 16:40:29 -0400247 feat_detect_panic(is_feat_rng_trap_present(), "RNG_TRAP");
248#endif
249}
250
Jayanth Dodderi Chidanand9461a892022-01-17 18:57:17 +0000251/***********************************************************************************
252 * TF-A supports many Arm architectural features starting from arch version
253 * (8.0 till 8.7+). These features are mostly enabled through build flags. This
254 * mechanism helps in validating these build flags in the early boot phase
255 * either in BL1 or BL31 depending on the platform and assists in identifying
256 * and notifying the features which are enabled but not supported by the PE.
257 *
258 * It reads all the enabled features ID-registers and ensures the features
259 * are supported by the PE.
260 * In case if they aren't it stops booting at an early phase and logs the error
261 * messages, notifying the platforms about the features that are not supported.
262 *
263 * Further the procedure is implemented with a tri-state approach for each feature:
264 * ENABLE_FEAT_xxx = 0 : The feature is disabled statically at compile time
265 * ENABLE_FEAT_xxx = 1 : The feature is enabled and must be present in hardware.
266 * There will be panic if feature is not present at cold boot.
267 * ENABLE_FEAT_xxx = 2 : The feature is enabled but dynamically enabled at runtime
268 * depending on hardware capability.
269 *
Andre Przywara5b005112022-11-14 15:38:58 +0000270 * For better readability, state values are defined with macros, namely:
271 * { FEAT_STATE_DISABLED, FEAT_STATE_ALWAYS, FEAT_STATE_CHECK }, taking values
272 * { 0, 1, 2 }, respectively, as their naming.
Jayanth Dodderi Chidanand9461a892022-01-17 18:57:17 +0000273 **********************************************************************************/
274void detect_arch_features(void)
275{
Andre Przywaracc4118d2022-11-14 15:42:44 +0000276 tainted = false;
277
Jayanth Dodderi Chidanand9461a892022-01-17 18:57:17 +0000278 /* v8.0 features */
279 read_feat_sb();
280 read_feat_csv2_2();
281
282 /* v8.1 features */
283 read_feat_pan();
284 read_feat_vhe();
285
286 /* v8.2 features */
287 read_feat_ras();
288
289 /* v8.3 features */
290 read_feat_pauth();
291
292 /* v8.4 features */
293 read_feat_dit();
Andre Przywara2f3e79a2023-02-01 11:46:31 +0000294 check_feature(ENABLE_FEAT_AMUv1, read_feat_amu_id_field(),
295 "AMUv1", 1, 2);
Jayanth Dodderi Chidanand9461a892022-01-17 18:57:17 +0000296 read_feat_mpam();
297 read_feat_nv2();
298 read_feat_sel2();
Andre Przywara06ea44e2022-11-17 17:30:43 +0000299 check_feature(ENABLE_TRF_FOR_NS, read_feat_trf_id_field(),
300 "TRF", 1, 1);
Jayanth Dodderi Chidanand9461a892022-01-17 18:57:17 +0000301
302 /* v8.5 features */
303 read_feat_mte();
304 read_feat_rng();
305 read_feat_bti();
Juan Pablo Conde42305f22022-07-12 16:40:29 -0400306 read_feat_rng_trap();
Jayanth Dodderi Chidanand9461a892022-01-17 18:57:17 +0000307
308 /* v8.6 features */
309 read_feat_amuv1p1();
Andre Przywara2f3e79a2023-02-01 11:46:31 +0000310 check_feature(ENABLE_FEAT_FGT, read_feat_fgt_id_field(), "FGT", 1, 1);
Jayanth Dodderi Chidanand9461a892022-01-17 18:57:17 +0000311 read_feat_ecv();
Jayanth Dodderi Chidanand4b5489c2022-03-28 15:28:55 +0100312 read_feat_twed();
Jayanth Dodderi Chidanand9461a892022-01-17 18:57:17 +0000313
314 /* v8.7 features */
Andre Przywara2f3e79a2023-02-01 11:46:31 +0000315 check_feature(ENABLE_FEAT_HCX, read_feat_hcx_id_field(), "HCX", 1, 1);
Jayanth Dodderi Chidanand9461a892022-01-17 18:57:17 +0000316
Jayanth Dodderi Chidanand69316752022-05-09 12:33:03 +0100317 /* v9.0 features */
Andre Przywarac97c5512022-11-17 16:42:09 +0000318 check_feature(ENABLE_BRBE_FOR_NS, read_feat_brbe_id_field(),
319 "BRBE", 1, 2);
Andre Przywara191eff62022-11-17 16:42:09 +0000320 check_feature(ENABLE_TRBE_FOR_NS, read_feat_trbe_id_field(),
321 "TRBE", 1, 1);
Jayanth Dodderi Chidanand69316752022-05-09 12:33:03 +0100322
Jayanth Dodderi Chidanand9461a892022-01-17 18:57:17 +0000323 /* v9.2 features */
324 read_feat_rme();
Andre Przywaracc4118d2022-11-14 15:42:44 +0000325
326 if (tainted) {
327 panic();
328 }
Jayanth Dodderi Chidanand9461a892022-01-17 18:57:17 +0000329}