blob: 57d6ae0efbcee001f1c60f34f272af84bcae571c [file] [log] [blame]
Jayanth Dodderi Chidanand9461a892022-01-17 18:57:17 +00001/*
Govindraj Raja24d3a4e2023-12-21 13:57:49 -06002 * Copyright (c) 2022-2024, Arm Limited and Contributors. All rights reserved.
Jayanth Dodderi Chidanand9461a892022-01-17 18:57:17 +00003 *
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_PAUTH (Pointer Authentication)
65 ***********************************************/
66static void read_feat_pauth(void)
67{
Andre Przywara5b005112022-11-14 15:38:58 +000068#if (ENABLE_PAUTH == FEAT_STATE_ALWAYS) || (CTX_INCLUDE_PAUTH_REGS == FEAT_STATE_ALWAYS)
Jayanth Dodderi Chidanand9461a892022-01-17 18:57:17 +000069 feat_detect_panic(is_armv8_3_pauth_present(), "PAUTH");
70#endif
71}
72
Jayanth Dodderi Chidanand9461a892022-01-17 18:57:17 +000073/****************************************************
74 * Feature : FEAT_BTI (Branch Target Identification)
75 ***************************************************/
76static void read_feat_bti(void)
77{
Andre Przywara5b005112022-11-14 15:38:58 +000078#if (ENABLE_BTI == FEAT_STATE_ALWAYS)
Jayanth Dodderi Chidanand9461a892022-01-17 18:57:17 +000079 feat_detect_panic(is_armv8_5_bti_present(), "BTI");
80#endif
81}
82
Jayanth Dodderi Chidanand9461a892022-01-17 18:57:17 +000083/**************************************************
84 * Feature : FEAT_RME (Realm Management Extension)
85 *************************************************/
86static void read_feat_rme(void)
87{
Andre Przywara5b005112022-11-14 15:38:58 +000088#if (ENABLE_RME == FEAT_STATE_ALWAYS)
Jayanth Dodderi Chidanand9461a892022-01-17 18:57:17 +000089 feat_detect_panic((get_armv9_2_feat_rme_support() !=
90 ID_AA64PFR0_FEAT_RME_NOT_SUPPORTED), "RME");
91#endif
92}
93
Juan Pablo Conde42305f22022-07-12 16:40:29 -040094/******************************************************************
95 * Feature : FEAT_RNG_TRAP (Trapping support for RNDR/RNDRRS)
96 *****************************************************************/
97static void read_feat_rng_trap(void)
98{
Andre Przywara5b005112022-11-14 15:38:58 +000099#if (ENABLE_FEAT_RNG_TRAP == FEAT_STATE_ALWAYS)
Juan Pablo Conde42305f22022-07-12 16:40:29 -0400100 feat_detect_panic(is_feat_rng_trap_present(), "RNG_TRAP");
101#endif
102}
103
Jayanth Dodderi Chidanand9461a892022-01-17 18:57:17 +0000104/***********************************************************************************
105 * TF-A supports many Arm architectural features starting from arch version
106 * (8.0 till 8.7+). These features are mostly enabled through build flags. This
107 * mechanism helps in validating these build flags in the early boot phase
108 * either in BL1 or BL31 depending on the platform and assists in identifying
109 * and notifying the features which are enabled but not supported by the PE.
110 *
111 * It reads all the enabled features ID-registers and ensures the features
112 * are supported by the PE.
113 * In case if they aren't it stops booting at an early phase and logs the error
114 * messages, notifying the platforms about the features that are not supported.
115 *
116 * Further the procedure is implemented with a tri-state approach for each feature:
117 * ENABLE_FEAT_xxx = 0 : The feature is disabled statically at compile time
118 * ENABLE_FEAT_xxx = 1 : The feature is enabled and must be present in hardware.
119 * There will be panic if feature is not present at cold boot.
120 * ENABLE_FEAT_xxx = 2 : The feature is enabled but dynamically enabled at runtime
121 * depending on hardware capability.
122 *
Andre Przywara5b005112022-11-14 15:38:58 +0000123 * For better readability, state values are defined with macros, namely:
124 * { FEAT_STATE_DISABLED, FEAT_STATE_ALWAYS, FEAT_STATE_CHECK }, taking values
125 * { 0, 1, 2 }, respectively, as their naming.
Jayanth Dodderi Chidanand9461a892022-01-17 18:57:17 +0000126 **********************************************************************************/
127void detect_arch_features(void)
128{
Andre Przywaracc4118d2022-11-14 15:42:44 +0000129 tainted = false;
130
Jayanth Dodderi Chidanand9461a892022-01-17 18:57:17 +0000131 /* v8.0 features */
Andre Przywara46880dc2022-11-17 16:42:09 +0000132 check_feature(ENABLE_FEAT_SB, read_feat_sb_id_field(), "SB", 1, 1);
Andre Przywara902c9022022-11-17 17:30:43 +0000133 check_feature(ENABLE_FEAT_CSV2_2, read_feat_csv2_id_field(),
134 "CSV2_2", 2, 3);
Boyan Karatotev05504ba2023-02-15 13:21:50 +0000135 /*
136 * Even though the PMUv3 is an OPTIONAL feature, it is always
137 * implemented and Arm prescribes so. So assume it will be there and do
138 * away with a flag for it. This is used to check minor PMUv3px
139 * revisions so that we catch them as they come along
140 */
141 check_feature(FEAT_STATE_ALWAYS, read_feat_pmuv3_id_field(),
142 "PMUv3", 1, ID_AA64DFR0_PMUVER_PMUV3P7);
Jayanth Dodderi Chidanand9461a892022-01-17 18:57:17 +0000143
144 /* v8.1 features */
Andre Przywara97272942023-01-26 15:27:38 +0000145 check_feature(ENABLE_FEAT_PAN, read_feat_pan_id_field(), "PAN", 1, 3);
Andre Przywara98908b32022-11-17 16:42:09 +0000146 check_feature(ENABLE_FEAT_VHE, read_feat_vhe_id_field(), "VHE", 1, 1);
Jayanth Dodderi Chidanand9461a892022-01-17 18:57:17 +0000147
148 /* v8.2 features */
Jayanth Dodderi Chidanandd62c6812023-03-07 10:43:19 +0000149 check_feature(ENABLE_SVE_FOR_NS, read_feat_sve_id_field(),
150 "SVE", 1, 1);
Andre Przywara870627e2023-01-27 12:25:49 +0000151 check_feature(ENABLE_FEAT_RAS, read_feat_ras_id_field(), "RAS", 1, 2);
Jayanth Dodderi Chidanand9461a892022-01-17 18:57:17 +0000152
153 /* v8.3 features */
154 read_feat_pauth();
155
156 /* v8.4 features */
Andre Przywara1f55c412023-01-26 16:47:52 +0000157 check_feature(ENABLE_FEAT_DIT, read_feat_dit_id_field(), "DIT", 1, 1);
Andre Przywara0b7f1b02023-03-21 13:53:19 +0000158 check_feature(ENABLE_FEAT_AMU, read_feat_amu_id_field(),
Andre Przywara2f3e79a2023-02-01 11:46:31 +0000159 "AMUv1", 1, 2);
Arvind Ram Prakashab28d4b2023-10-11 12:10:56 -0500160 check_feature(ENABLE_FEAT_MPAM, read_feat_mpam_version(),
Andre Przywaraa96d4502023-03-21 14:44:59 +0000161 "MPAM", 1, 17);
Andre Przywaraedc449d2023-01-27 14:09:20 +0000162 check_feature(CTX_INCLUDE_NEVE_REGS, read_feat_nv_id_field(),
163 "NV2", 2, 2);
Andre Przywara6dd2d062023-02-22 16:53:50 +0000164 check_feature(ENABLE_FEAT_SEL2, read_feat_sel2_id_field(),
165 "SEL2", 1, 1);
Andre Przywara06ea44e2022-11-17 17:30:43 +0000166 check_feature(ENABLE_TRF_FOR_NS, read_feat_trf_id_field(),
167 "TRF", 1, 1);
Jayanth Dodderi Chidanand9461a892022-01-17 18:57:17 +0000168
169 /* v8.5 features */
Govindraj Raja24d3a4e2023-12-21 13:57:49 -0600170 check_feature(ENABLE_FEAT_MTE, read_feat_mte_id_field(), "MTE",
171 MTE_IMPLEMENTED_EL0, MTE_IMPLEMENTED_ASY);
Andre Przywara436b4bb2023-02-22 17:55:59 +0000172 check_feature(ENABLE_FEAT_RNG, read_feat_rng_id_field(), "RNG", 1, 1);
Jayanth Dodderi Chidanand9461a892022-01-17 18:57:17 +0000173 read_feat_bti();
Juan Pablo Conde42305f22022-07-12 16:40:29 -0400174 read_feat_rng_trap();
Jayanth Dodderi Chidanand9461a892022-01-17 18:57:17 +0000175
176 /* v8.6 features */
Andre Przywara906776e2023-03-03 10:30:06 +0000177 check_feature(ENABLE_FEAT_AMUv1p1, read_feat_amu_id_field(),
178 "AMUv1p1", 2, 2);
Andre Przywara2f3e79a2023-02-01 11:46:31 +0000179 check_feature(ENABLE_FEAT_FGT, read_feat_fgt_id_field(), "FGT", 1, 1);
Andre Przywarac3464182022-11-17 17:30:43 +0000180 check_feature(ENABLE_FEAT_ECV, read_feat_ecv_id_field(), "ECV", 1, 2);
Andre Przywara0cf77402023-01-27 12:25:49 +0000181 check_feature(ENABLE_FEAT_TWED, read_feat_twed_id_field(),
182 "TWED", 1, 1);
Jayanth Dodderi Chidanand9461a892022-01-17 18:57:17 +0000183
Boyan Karatotev677ed8a2023-02-16 09:45:29 +0000184 /*
185 * even though this is a "DISABLE" it does confusingly perform feature
186 * enablement duties like all other flags here. Check it against the HW
187 * feature when we intend to diverge from the default behaviour
188 */
189 check_feature(DISABLE_MTPMU, read_feat_mtpmu_id_field(), "MTPMU", 1, 1);
190
Jayanth Dodderi Chidanand9461a892022-01-17 18:57:17 +0000191 /* v8.7 features */
Andre Przywara2f3e79a2023-02-01 11:46:31 +0000192 check_feature(ENABLE_FEAT_HCX, read_feat_hcx_id_field(), "HCX", 1, 1);
Jayanth Dodderi Chidanand9461a892022-01-17 18:57:17 +0000193
Mark Brownc37eee72023-03-14 20:13:03 +0000194 /* v8.9 features */
Andre Przywara0dda4242023-04-18 16:58:36 +0100195 check_feature(ENABLE_FEAT_TCR2, read_feat_tcr2_id_field(),
Mark Brownc37eee72023-03-14 20:13:03 +0000196 "TCR2", 1, 1);
Mark Brown293a6612023-03-14 20:48:43 +0000197 check_feature(ENABLE_FEAT_S2PIE, read_feat_s2pie_id_field(),
198 "S2PIE", 1, 1);
199 check_feature(ENABLE_FEAT_S1PIE, read_feat_s1pie_id_field(),
200 "S1PIE", 1, 1);
201 check_feature(ENABLE_FEAT_S2POE, read_feat_s2poe_id_field(),
202 "S2POE", 1, 1);
203 check_feature(ENABLE_FEAT_S1POE, read_feat_s1poe_id_field(),
204 "S1POE", 1, 1);
Maksims Svecovsdf4ad842023-03-24 13:05:09 +0000205 check_feature(ENABLE_FEAT_MTE_PERM, read_feat_mte_perm_id_field(),
206 "MTE_PERM", 1, 1);
Sona Mathew3b84c962023-10-25 16:48:19 -0500207 check_feature(ENABLE_FEAT_CSV2_3, read_feat_csv2_id_field(),
208 "CSV2_3", 3, 3);
Mark Brownc37eee72023-03-14 20:13:03 +0000209
Jayanth Dodderi Chidanand69316752022-05-09 12:33:03 +0100210 /* v9.0 features */
Andre Przywarac97c5512022-11-17 16:42:09 +0000211 check_feature(ENABLE_BRBE_FOR_NS, read_feat_brbe_id_field(),
212 "BRBE", 1, 2);
Andre Przywara191eff62022-11-17 16:42:09 +0000213 check_feature(ENABLE_TRBE_FOR_NS, read_feat_trbe_id_field(),
214 "TRBE", 1, 1);
Jayanth Dodderi Chidanand69316752022-05-09 12:33:03 +0100215
Jayanth Dodderi Chidanand9461a892022-01-17 18:57:17 +0000216 /* v9.2 features */
Jayanth Dodderi Chidanand605419a2023-03-06 23:56:14 +0000217 check_feature(ENABLE_SME_FOR_NS, read_feat_sme_id_field(),
218 "SME", 1, 2);
Jayanth Dodderi Chidanandcfe053a2022-11-08 10:31:07 +0000219 check_feature(ENABLE_SME2_FOR_NS, read_feat_sme_id_field(),
220 "SME2", 2, 2);
Mark Brown326f2952023-03-14 21:33:04 +0000221
222 /* v9.4 features */
223 check_feature(ENABLE_FEAT_GCS, read_feat_gcs_id_field(), "GCS", 1, 1);
224
Jayanth Dodderi Chidanand9461a892022-01-17 18:57:17 +0000225 read_feat_rme();
Andre Przywaracc4118d2022-11-14 15:42:44 +0000226
227 if (tainted) {
228 panic();
229 }
Jayanth Dodderi Chidanand9461a892022-01-17 18:57:17 +0000230}