arch/arm64/include/asm/cpufeature.h

   1 /*
   2  * Copyright (C) 2014 Linaro Ltd. <ard.biesheuvel@linaro.org>
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License version 2 as
   6  * published by the Free Software Foundation.
   7  */
   8
   9 #ifndef __ASM_CPUFEATURE_H
  10 #define __ASM_CPUFEATURE_H
  11
  12 #include <asm/cpucaps.h>
  13 #include <asm/fpsimd.h>
  14 #include <asm/hwcap.h>
  15 #include <asm/sigcontext.h>
  16 #include <asm/sysreg.h>
  17
  18 /*
  19  * In the arm64 world (as in the ARM world), elf_hwcap is used both internally
  20  * in the kernel and for user space to keep track of which optional features
  21  * are supported by the current system. So let's map feature 'x' to HWCAP_x.
  22  * Note that HWCAP_x constants are bit fields so we need to take the log.
  23  */
  24
  25 #define MAX_CPU_FEATURES        (8 * sizeof(elf_hwcap))
  26 #define cpu_feature(x)          ilog2(HWCAP_ ## x)
  27
  28 #ifndef __ASSEMBLY__
  29
  30 #include <linux/bug.h>
  31 #include <linux/jump_label.h>
  32 #include <linux/kernel.h>
  33
  34 /*
  35  * CPU feature register tracking
  36  *
  37  * The safe value of a CPUID feature field is dependent on the implications
  38  * of the values assigned to it by the architecture. Based on the relationship
  39  * between the values, the features are classified into 3 types - LOWER_SAFE,
  40  * HIGHER_SAFE and EXACT.
  41  *
  42  * The lowest value of all the CPUs is chosen for LOWER_SAFE and highest
  43  * for HIGHER_SAFE. It is expected that all CPUs have the same value for
  44  * a field when EXACT is specified, failing which, the safe value specified
  45  * in the table is chosen.
  46  */
  47
  48 enum ftr_type {
  49         FTR_EXACT,      /* Use a predefined safe value */
  50         FTR_LOWER_SAFE, /* Smaller value is safe */
  51         FTR_HIGHER_SAFE,/* Bigger value is safe */
  52 };
  53
  54 #define FTR_STRICT      true    /* SANITY check strict matching required */
  55 #define FTR_NONSTRICT   false   /* SANITY check ignored */
  56
  57 #define FTR_SIGNED      true    /* Value should be treated as signed */
  58 #define FTR_UNSIGNED    false   /* Value should be treated as unsigned */
  59
  60 #define FTR_VISIBLE     true    /* Feature visible to the user space */
  61 #define FTR_HIDDEN      false   /* Feature is hidden from the user */
  62
  63 #define FTR_VISIBLE_IF_IS_ENABLED(config)               \
  64         (IS_ENABLED(config) ? FTR_VISIBLE : FTR_HIDDEN)
  65
  66 struct arm64_ftr_bits {
  67         bool            sign;   /* Value is signed ? */
  68         bool            visible;
  69         bool            strict; /* CPU Sanity check: strict matching required ? */
  70         enum ftr_type   type;
  71         u8              shift;
  72         u8              width;
  73         s64             safe_val; /* safe value for FTR_EXACT features */
  74 };
  75
  76 /*
  77  * @arm64_ftr_reg - Feature register
  78  * @strict_mask         Bits which should match across all CPUs for sanity.
  79  * @sys_val             Safe value across the CPUs (system view)
  80  */
  81 struct arm64_ftr_reg {
  82         const char                      *name;
  83         u64                             strict_mask;
  84         u64                             user_mask;
  85         u64                             sys_val;
  86         u64                             user_val;
  87         const struct arm64_ftr_bits     *ftr_bits;
  88 };
  89
  90 extern struct arm64_ftr_reg arm64_ftr_reg_ctrel0;
  91
  92 /* scope of capability check */
  93 enum {
  94         SCOPE_SYSTEM,
  95         SCOPE_LOCAL_CPU,
  96 };
  97
  98 struct arm64_cpu_capabilities {
  99         const char *desc;
 100         u16 capability;
 101         int def_scope;                  /* default scope */
 102         bool (*matches)(const struct arm64_cpu_capabilities *caps, int scope);
 103         /*
 104          * Take the appropriate actions to enable this capability for this CPU.
 105          * For each successfully booted CPU, this method is called for each
 106          * globally detected capability.
 107          */
 108         void (*cpu_enable)(const struct arm64_cpu_capabilities *cap);
 109         union {
 110                 struct {        /* To be used for erratum handling only */
 111                         u32 midr_model;
 112                         u32 midr_range_min, midr_range_max;
 113                         const struct arm64_midr_revidr {
 114                                 u32 midr_rv;            /* revision/variant */
 115                                 u32 revidr_mask;
 116                         } * const fixed_revs;
 117                 };
 118
 119                 struct {        /* Feature register checking */
 120                         u32 sys_reg;
 121                         u8 field_pos;
 122                         u8 min_field_value;
 123                         u8 hwcap_type;
 124                         bool sign;
 125                         unsigned long hwcap;
 126                 };
 127         };
 128 };
 129
 130 extern DECLARE_BITMAP(cpu_hwcaps, ARM64_NCAPS);
 131 extern struct static_key_false cpu_hwcap_keys[ARM64_NCAPS];
 132 extern struct static_key_false arm64_const_caps_ready;
 133
 134 bool this_cpu_has_cap(unsigned int cap);
 135
 136 static inline bool cpu_have_feature(unsigned int num)
 137 {
 138         return elf_hwcap & (1UL << num);
 139 }
 140
 141 /* System capability check for constant caps */
 142 static inline bool __cpus_have_const_cap(int num)
 143 {
 144         if (num >= ARM64_NCAPS)
 145                 return false;
 146         return static_branch_unlikely(&cpu_hwcap_keys[num]);
 147 }
 148
 149 static inline bool cpus_have_cap(unsigned int num)
 150 {
 151         if (num >= ARM64_NCAPS)
 152                 return false;
 153         return test_bit(num, cpu_hwcaps);
 154 }
 155
 156 static inline bool cpus_have_const_cap(int num)
 157 {
 158         if (static_branch_likely(&arm64_const_caps_ready))
 159                 return __cpus_have_const_cap(num);
 160         else
 161                 return cpus_have_cap(num);
 162 }
 163
 164 static inline void cpus_set_cap(unsigned int num)
 165 {
 166         if (num >= ARM64_NCAPS) {
 167                 pr_warn("Attempt to set an illegal CPU capability (%d >= %d)\n",
 168                         num, ARM64_NCAPS);
 169         } else {
 170                 __set_bit(num, cpu_hwcaps);
 171         }
 172 }
 173
 174 static inline int __attribute_const__
 175 cpuid_feature_extract_signed_field_width(u64 features, int field, int width)
 176 {
 177         return (s64)(features << (64 - width - field)) >> (64 - width);
 178 }
 179
 180 static inline int __attribute_const__
 181 cpuid_feature_extract_signed_field(u64 features, int field)
 182 {
 183         return cpuid_feature_extract_signed_field_width(features, field, 4);
 184 }
 185
 186 static inline unsigned int __attribute_const__
 187 cpuid_feature_extract_unsigned_field_width(u64 features, int field, int width)
 188 {
 189         return (u64)(features << (64 - width - field)) >> (64 - width);
 190 }
 191
 192 static inline unsigned int __attribute_const__
 193 cpuid_feature_extract_unsigned_field(u64 features, int field)
 194 {
 195         return cpuid_feature_extract_unsigned_field_width(features, field, 4);
 196 }
 197
 198 static inline u64 arm64_ftr_mask(const struct arm64_ftr_bits *ftrp)
 199 {
 200         return (u64)GENMASK(ftrp->shift + ftrp->width - 1, ftrp->shift);
 201 }
 202
 203 static inline u64 arm64_ftr_reg_user_value(const struct arm64_ftr_reg *reg)
 204 {
 205         return (reg->user_val | (reg->sys_val & reg->user_mask));
 206 }
 207
 208 static inline int __attribute_const__
 209 cpuid_feature_extract_field_width(u64 features, int field, int width, bool sign)
 210 {
 211         return (sign) ?
 212                 cpuid_feature_extract_signed_field_width(features, field, width) :
 213                 cpuid_feature_extract_unsigned_field_width(features, field, width);
 214 }
 215
 216 static inline int __attribute_const__
 217 cpuid_feature_extract_field(u64 features, int field, bool sign)
 218 {
 219         return cpuid_feature_extract_field_width(features, field, 4, sign);
 220 }
 221
 222 static inline s64 arm64_ftr_value(const struct arm64_ftr_bits *ftrp, u64 val)
 223 {
 224         return (s64)cpuid_feature_extract_field_width(val, ftrp->shift, ftrp->width, ftrp->sign);
 225 }
 226
 227 static inline bool id_aa64mmfr0_mixed_endian_el0(u64 mmfr0)
 228 {
 229         return cpuid_feature_extract_unsigned_field(mmfr0, ID_AA64MMFR0_BIGENDEL_SHIFT) == 0x1 ||
 230                 cpuid_feature_extract_unsigned_field(mmfr0, ID_AA64MMFR0_BIGENDEL0_SHIFT) == 0x1;
 231 }
 232
 233 static inline bool id_aa64pfr0_32bit_el0(u64 pfr0)
 234 {
 235         u32 val = cpuid_feature_extract_unsigned_field(pfr0, ID_AA64PFR0_EL0_SHIFT);
 236
 237         return val == ID_AA64PFR0_EL0_32BIT_64BIT;
 238 }
 239
 240 static inline bool id_aa64pfr0_sve(u64 pfr0)
 241 {
 242         u32 val = cpuid_feature_extract_unsigned_field(pfr0, ID_AA64PFR0_SVE_SHIFT);
 243
 244         return val > 0;
 245 }
 246
 247 void __init setup_cpu_features(void);
 248
 249 void update_cpu_capabilities(const struct arm64_cpu_capabilities *caps,
 250                             const char *info);
 251 void enable_cpu_capabilities(const struct arm64_cpu_capabilities *caps);
 252 void check_local_cpu_capabilities(void);
 253
 254 void update_cpu_errata_workarounds(void);
 255 void __init enable_errata_workarounds(void);
 256 void verify_local_cpu_errata_workarounds(void);
 257
 258 u64 read_sanitised_ftr_reg(u32 id);
 259
 260 static inline bool cpu_supports_mixed_endian_el0(void)
 261 {
 262         return id_aa64mmfr0_mixed_endian_el0(read_cpuid(ID_AA64MMFR0_EL1));
 263 }
 264
 265 static inline bool system_supports_32bit_el0(void)
 266 {
 267         return cpus_have_const_cap(ARM64_HAS_32BIT_EL0);
 268 }
 269
 270 static inline bool system_supports_mixed_endian_el0(void)
 271 {
 272         return id_aa64mmfr0_mixed_endian_el0(read_sanitised_ftr_reg(SYS_ID_AA64MMFR0_EL1));
 273 }
 274
 275 static inline bool system_supports_fpsimd(void)
 276 {
 277         return !cpus_have_const_cap(ARM64_HAS_NO_FPSIMD);
 278 }
 279
 280 static inline bool system_uses_ttbr0_pan(void)
 281 {
 282         return IS_ENABLED(CONFIG_ARM64_SW_TTBR0_PAN) &&
 283                 !cpus_have_const_cap(ARM64_HAS_PAN);
 284 }
 285
 286 static inline bool system_supports_sve(void)
 287 {
 288         return IS_ENABLED(CONFIG_ARM64_SVE) &&
 289                 cpus_have_const_cap(ARM64_SVE);
 290 }
 291
 292 /*
 293  * Read the pseudo-ZCR used by cpufeatures to identify the supported SVE
 294  * vector length.
 295  *
 296  * Use only if SVE is present.
 297  * This function clobbers the SVE vector length.
 298  */
 299 static inline u64 read_zcr_features(void)
 300 {
 301         u64 zcr;
 302         unsigned int vq_max;
 303
 304         /*
 305          * Set the maximum possible VL, and write zeroes to all other
 306          * bits to see if they stick.
 307          */
 308         sve_kernel_enable(NULL);
 309         write_sysreg_s(ZCR_ELx_LEN_MASK, SYS_ZCR_EL1);
 310
 311         zcr = read_sysreg_s(SYS_ZCR_EL1);
 312         zcr &= ~(u64)ZCR_ELx_LEN_MASK; /* find sticky 1s outside LEN field */
 313         vq_max = sve_vq_from_vl(sve_get_vl());
 314         zcr |= vq_max - 1; /* set LEN field to maximum effective value */
 315
 316         return zcr;
 317 }
 318
 319 #endif /* __ASSEMBLY__ */
 320
 321 #endif