1 /*
2  * Copyright (c) 2019-2021, Arm Limited. All rights reserved.
3  *
4  * SPDX-License-Identifier: BSD-3-Clause
5  */
6 
7 #ifndef ARCH_FEATURES_H
8 #define ARCH_FEATURES_H
9 
10 #include <stdbool.h>
11 
12 #include <arch_helpers.h>
13 
is_armv7_gentimer_present(void)14 static inline bool is_armv7_gentimer_present(void)
15 {
16 	/* The Generic Timer is always present in an ARMv8-A implementation */
17 	return true;
18 }
19 
is_armv8_1_pan_present(void)20 static inline bool is_armv8_1_pan_present(void)
21 {
22 	return ((read_id_aa64mmfr1_el1() >> ID_AA64MMFR1_EL1_PAN_SHIFT) &
23 		ID_AA64MMFR1_EL1_PAN_MASK) != 0U;
24 }
25 
is_armv8_1_vhe_present(void)26 static inline bool is_armv8_1_vhe_present(void)
27 {
28 	return ((read_id_aa64mmfr1_el1() >> ID_AA64MMFR1_EL1_VHE_SHIFT) &
29 		ID_AA64MMFR1_EL1_VHE_MASK) != 0U;
30 }
31 
is_armv8_2_ttcnp_present(void)32 static inline bool is_armv8_2_ttcnp_present(void)
33 {
34 	return ((read_id_aa64mmfr2_el1() >> ID_AA64MMFR2_EL1_CNP_SHIFT) &
35 		ID_AA64MMFR2_EL1_CNP_MASK) != 0U;
36 }
37 
is_armv8_3_pauth_present(void)38 static inline bool is_armv8_3_pauth_present(void)
39 {
40 	uint64_t mask = (ID_AA64ISAR1_GPI_MASK << ID_AA64ISAR1_GPI_SHIFT) |
41 			(ID_AA64ISAR1_GPA_MASK << ID_AA64ISAR1_GPA_SHIFT) |
42 			(ID_AA64ISAR1_API_MASK << ID_AA64ISAR1_API_SHIFT) |
43 			(ID_AA64ISAR1_APA_MASK << ID_AA64ISAR1_APA_SHIFT);
44 
45 	/* If any of the fields is not zero, PAuth is present */
46 	return (read_id_aa64isar1_el1() & mask) != 0U;
47 }
48 
is_armv8_4_ttst_present(void)49 static inline bool is_armv8_4_ttst_present(void)
50 {
51 	return ((read_id_aa64mmfr2_el1() >> ID_AA64MMFR2_EL1_ST_SHIFT) &
52 		ID_AA64MMFR2_EL1_ST_MASK) == 1U;
53 }
54 
is_armv8_5_bti_present(void)55 static inline bool is_armv8_5_bti_present(void)
56 {
57 	return ((read_id_aa64pfr1_el1() >> ID_AA64PFR1_EL1_BT_SHIFT) &
58 		ID_AA64PFR1_EL1_BT_MASK) == BTI_IMPLEMENTED;
59 }
60 
get_armv8_5_mte_support(void)61 static inline unsigned int get_armv8_5_mte_support(void)
62 {
63 	return ((read_id_aa64pfr1_el1() >> ID_AA64PFR1_EL1_MTE_SHIFT) &
64 		ID_AA64PFR1_EL1_MTE_MASK);
65 }
66 
is_armv8_4_sel2_present(void)67 static inline bool is_armv8_4_sel2_present(void)
68 {
69 	return ((read_id_aa64pfr0_el1() >> ID_AA64PFR0_SEL2_SHIFT) &
70 		ID_AA64PFR0_SEL2_MASK) == 1ULL;
71 }
72 
is_armv8_6_twed_present(void)73 static inline bool is_armv8_6_twed_present(void)
74 {
75 	return (((read_id_aa64mmfr1_el1() >> ID_AA64MMFR1_EL1_TWED_SHIFT) &
76 		ID_AA64MMFR1_EL1_TWED_MASK) == ID_AA64MMFR1_EL1_TWED_SUPPORTED);
77 }
78 
is_armv8_6_fgt_present(void)79 static inline bool is_armv8_6_fgt_present(void)
80 {
81 	return ((read_id_aa64mmfr0_el1() >> ID_AA64MMFR0_EL1_FGT_SHIFT) &
82 		ID_AA64MMFR0_EL1_FGT_MASK) == ID_AA64MMFR0_EL1_FGT_SUPPORTED;
83 }
84 
get_armv8_6_ecv_support(void)85 static inline unsigned long int get_armv8_6_ecv_support(void)
86 {
87 	return ((read_id_aa64mmfr0_el1() >> ID_AA64MMFR0_EL1_ECV_SHIFT) &
88 		ID_AA64MMFR0_EL1_ECV_MASK);
89 }
90 
is_armv8_5_rng_present(void)91 static inline bool is_armv8_5_rng_present(void)
92 {
93 	return ((read_id_aa64isar0_el1() >> ID_AA64ISAR0_RNDR_SHIFT) &
94 		ID_AA64ISAR0_RNDR_MASK);
95 }
96 
is_armv8_6_feat_amuv1p1_present(void)97 static inline bool is_armv8_6_feat_amuv1p1_present(void)
98 {
99 	return (((read_id_aa64pfr0_el1() >> ID_AA64PFR0_AMU_SHIFT) &
100 		ID_AA64PFR0_AMU_MASK) >= ID_AA64PFR0_AMU_V1P1);
101 }
102 
103 /*
104  * Return MPAM version:
105  *
106  * 0x00: None Armv8.0 or later
107  * 0x01: v0.1 Armv8.4 or later
108  * 0x10: v1.0 Armv8.2 or later
109  * 0x11: v1.1 Armv8.4 or later
110  *
111  */
get_mpam_version(void)112 static inline unsigned int get_mpam_version(void)
113 {
114 	return (unsigned int)((((read_id_aa64pfr0_el1() >>
115 		ID_AA64PFR0_MPAM_SHIFT) & ID_AA64PFR0_MPAM_MASK) << 4) |
116 				((read_id_aa64pfr1_el1() >>
117 		ID_AA64PFR1_MPAM_FRAC_SHIFT) & ID_AA64PFR1_MPAM_FRAC_MASK));
118 }
119 
is_feat_hcx_present(void)120 static inline bool is_feat_hcx_present(void)
121 {
122 	return (((read_id_aa64mmfr1_el1() >> ID_AA64MMFR1_EL1_HCX_SHIFT) &
123 		ID_AA64MMFR1_EL1_HCX_MASK) == ID_AA64MMFR1_EL1_HCX_SUPPORTED);
124 }
125 
get_armv9_2_feat_rme_support(void)126 static inline unsigned int get_armv9_2_feat_rme_support(void)
127 {
128 	/*
129 	 * Return the RME version, zero if not supported.  This function can be
130 	 * used as both an integer value for the RME version or compared to zero
131 	 * to detect RME presence.
132 	 */
133 	return (unsigned int)(read_id_aa64pfr0_el1() >>
134 		ID_AA64PFR0_FEAT_RME_SHIFT) & ID_AA64PFR0_FEAT_RME_MASK;
135 }
136 
137 #endif /* ARCH_FEATURES_H */
138