1 /* 2 * QEMU ARM CP Register access and descriptions 3 * 4 * Copyright (c) 2022 Linaro Ltd 5 * 6 * This program is free software; you can redistribute it and/or 7 * modify it under the terms of the GNU General Public License 8 * as published by the Free Software Foundation; either version 2 9 * of the License, or (at your option) any later version. 10 * 11 * This program is distributed in the hope that it will be useful, 12 * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 * GNU General Public License for more details. 15 * 16 * You should have received a copy of the GNU General Public License 17 * along with this program; if not, see 18 * <http://www.gnu.org/licenses/gpl-2.0.html> 19 */ 20 21 #ifndef TARGET_ARM_CPREGS_H 22 #define TARGET_ARM_CPREGS_H 23 24 /* 25 * ARMCPRegInfo type field bits: 26 */ 27 enum { 28 /* 29 * Register must be handled specially during translation. 30 * The method is one of the values below: 31 */ 32 ARM_CP_SPECIAL_MASK = 0x000f, 33 /* Special: no change to PE state: writes ignored, reads ignored. */ 34 ARM_CP_NOP = 0x0001, 35 /* Special: sysreg is WFI, for v5 and v6. */ 36 ARM_CP_WFI = 0x0002, 37 /* Special: sysreg is NZCV. */ 38 ARM_CP_NZCV = 0x0003, 39 /* Special: sysreg is CURRENTEL. */ 40 ARM_CP_CURRENTEL = 0x0004, 41 /* Special: sysreg is DC ZVA or similar. */ 42 ARM_CP_DC_ZVA = 0x0005, 43 ARM_CP_DC_GVA = 0x0006, 44 ARM_CP_DC_GZVA = 0x0007, 45 46 /* Flag: reads produce resetvalue; writes ignored. */ 47 ARM_CP_CONST = 1 << 4, 48 /* Flag: For ARM_CP_STATE_AA32, sysreg is 64-bit. */ 49 ARM_CP_64BIT = 1 << 5, 50 /* 51 * Flag: TB should not be ended after a write to this register 52 * (the default is that the TB ends after cp writes). 53 */ 54 ARM_CP_SUPPRESS_TB_END = 1 << 6, 55 /* 56 * Flag: Permit a register definition to override a previous definition 57 * for the same (cp, is64, crn, crm, opc1, opc2) tuple: either the new 58 * or the old must have the ARM_CP_OVERRIDE bit set. 59 */ 60 ARM_CP_OVERRIDE = 1 << 7, 61 /* 62 * Flag: Register is an alias view of some underlying state which is also 63 * visible via another register, and that the other register is handling 64 * migration and reset; registers marked ARM_CP_ALIAS will not be migrated 65 * but may have their state set by syncing of register state from KVM. 66 */ 67 ARM_CP_ALIAS = 1 << 8, 68 /* 69 * Flag: Register does I/O and therefore its accesses need to be marked 70 * with translator_io_start() and also end the TB. In particular, 71 * registers which implement clocks or timers require this. 72 */ 73 ARM_CP_IO = 1 << 9, 74 /* 75 * Flag: Register has no underlying state and does not support raw access 76 * for state saving/loading; it will not be used for either migration or 77 * KVM state synchronization. Typically this is for "registers" which are 78 * actually used as instructions for cache maintenance and so on. 79 */ 80 ARM_CP_NO_RAW = 1 << 10, 81 /* 82 * Flag: The read or write hook might raise an exception; the generated 83 * code will synchronize the CPU state before calling the hook so that it 84 * is safe for the hook to call raise_exception(). 85 */ 86 ARM_CP_RAISES_EXC = 1 << 11, 87 /* 88 * Flag: Writes to the sysreg might change the exception level - typically 89 * on older ARM chips. For those cases we need to re-read the new el when 90 * recomputing the translation flags. 91 */ 92 ARM_CP_NEWEL = 1 << 12, 93 /* 94 * Flag: Access check for this sysreg is identical to accessing FPU state 95 * from an instruction: use translation fp_access_check(). 96 */ 97 ARM_CP_FPU = 1 << 13, 98 /* 99 * Flag: Access check for this sysreg is identical to accessing SVE state 100 * from an instruction: use translation sve_access_check(). 101 */ 102 ARM_CP_SVE = 1 << 14, 103 /* Flag: Do not expose in gdb sysreg xml. */ 104 ARM_CP_NO_GDB = 1 << 15, 105 /* 106 * Flags: If EL3 but not EL2... 107 * - UNDEF: discard the cpreg, 108 * - KEEP: retain the cpreg as is, 109 * - C_NZ: set const on the cpreg, but retain resetvalue, 110 * - else: set const on the cpreg, zero resetvalue, aka RES0. 111 * See rule RJFFP in section D1.1.3 of DDI0487H.a. 112 */ 113 ARM_CP_EL3_NO_EL2_UNDEF = 1 << 16, 114 ARM_CP_EL3_NO_EL2_KEEP = 1 << 17, 115 ARM_CP_EL3_NO_EL2_C_NZ = 1 << 18, 116 /* 117 * Flag: Access check for this sysreg is constrained by the 118 * ARM pseudocode function CheckSMEAccess(). 119 */ 120 ARM_CP_SME = 1 << 19, 121 /* 122 * Flag: one of the four EL2 registers which redirect to the 123 * equivalent EL1 register when FEAT_NV2 is enabled. 124 */ 125 ARM_CP_NV2_REDIRECT = 1 << 20, 126 }; 127 128 /* 129 * Interface for defining coprocessor registers. 130 * Registers are defined in tables of arm_cp_reginfo structs 131 * which are passed to define_arm_cp_regs(). 132 */ 133 134 /* 135 * When looking up a coprocessor register we look for it 136 * via an integer which encodes all of: 137 * coprocessor number 138 * Crn, Crm, opc1, opc2 fields 139 * 32 or 64 bit register (ie is it accessed via MRC/MCR 140 * or via MRRC/MCRR?) 141 * non-secure/secure bank (AArch32 only) 142 * We allow 4 bits for opc1 because MRRC/MCRR have a 4 bit field. 143 * (In this case crn and opc2 should be zero.) 144 * For AArch64, there is no 32/64 bit size distinction; 145 * instead all registers have a 2 bit op0, 3 bit op1 and op2, 146 * and 4 bit CRn and CRm. The encoding patterns are chosen 147 * to be easy to convert to and from the KVM encodings, and also 148 * so that the hashtable can contain both AArch32 and AArch64 149 * registers (to allow for interprocessing where we might run 150 * 32 bit code on a 64 bit core). 151 */ 152 /* 153 * This bit is private to our hashtable cpreg; in KVM register 154 * IDs the AArch64/32 distinction is the KVM_REG_ARM/ARM64 155 * in the upper bits of the 64 bit ID. 156 */ 157 #define CP_REG_AA64_SHIFT 28 158 #define CP_REG_AA64_MASK (1 << CP_REG_AA64_SHIFT) 159 160 /* 161 * To enable banking of coprocessor registers depending on ns-bit we 162 * add a bit to distinguish between secure and non-secure cpregs in the 163 * hashtable. 164 */ 165 #define CP_REG_NS_SHIFT 29 166 #define CP_REG_NS_MASK (1 << CP_REG_NS_SHIFT) 167 168 #define ENCODE_CP_REG(cp, is64, ns, crn, crm, opc1, opc2) \ 169 ((ns) << CP_REG_NS_SHIFT | ((cp) << 16) | ((is64) << 15) | \ 170 ((crn) << 11) | ((crm) << 7) | ((opc1) << 3) | (opc2)) 171 172 #define ENCODE_AA64_CP_REG(cp, crn, crm, op0, op1, op2) \ 173 (CP_REG_AA64_MASK | \ 174 ((cp) << CP_REG_ARM_COPROC_SHIFT) | \ 175 ((op0) << CP_REG_ARM64_SYSREG_OP0_SHIFT) | \ 176 ((op1) << CP_REG_ARM64_SYSREG_OP1_SHIFT) | \ 177 ((crn) << CP_REG_ARM64_SYSREG_CRN_SHIFT) | \ 178 ((crm) << CP_REG_ARM64_SYSREG_CRM_SHIFT) | \ 179 ((op2) << CP_REG_ARM64_SYSREG_OP2_SHIFT)) 180 181 /* 182 * Convert a full 64 bit KVM register ID to the truncated 32 bit 183 * version used as a key for the coprocessor register hashtable 184 */ 185 static inline uint32_t kvm_to_cpreg_id(uint64_t kvmid) 186 { 187 uint32_t cpregid = kvmid; 188 if ((kvmid & CP_REG_ARCH_MASK) == CP_REG_ARM64) { 189 cpregid |= CP_REG_AA64_MASK; 190 } else { 191 if ((kvmid & CP_REG_SIZE_MASK) == CP_REG_SIZE_U64) { 192 cpregid |= (1 << 15); 193 } 194 195 /* 196 * KVM is always non-secure so add the NS flag on AArch32 register 197 * entries. 198 */ 199 cpregid |= 1 << CP_REG_NS_SHIFT; 200 } 201 return cpregid; 202 } 203 204 /* 205 * Convert a truncated 32 bit hashtable key into the full 206 * 64 bit KVM register ID. 207 */ 208 static inline uint64_t cpreg_to_kvm_id(uint32_t cpregid) 209 { 210 uint64_t kvmid; 211 212 if (cpregid & CP_REG_AA64_MASK) { 213 kvmid = cpregid & ~CP_REG_AA64_MASK; 214 kvmid |= CP_REG_SIZE_U64 | CP_REG_ARM64; 215 } else { 216 kvmid = cpregid & ~(1 << 15); 217 if (cpregid & (1 << 15)) { 218 kvmid |= CP_REG_SIZE_U64 | CP_REG_ARM; 219 } else { 220 kvmid |= CP_REG_SIZE_U32 | CP_REG_ARM; 221 } 222 } 223 return kvmid; 224 } 225 226 /* 227 * Valid values for ARMCPRegInfo state field, indicating which of 228 * the AArch32 and AArch64 execution states this register is visible in. 229 * If the reginfo doesn't explicitly specify then it is AArch32 only. 230 * If the reginfo is declared to be visible in both states then a second 231 * reginfo is synthesised for the AArch32 view of the AArch64 register, 232 * such that the AArch32 view is the lower 32 bits of the AArch64 one. 233 * Note that we rely on the values of these enums as we iterate through 234 * the various states in some places. 235 */ 236 typedef enum { 237 ARM_CP_STATE_AA32 = 0, 238 ARM_CP_STATE_AA64 = 1, 239 ARM_CP_STATE_BOTH = 2, 240 } CPState; 241 242 /* 243 * ARM CP register secure state flags. These flags identify security state 244 * attributes for a given CP register entry. 245 * The existence of both or neither secure and non-secure flags indicates that 246 * the register has both a secure and non-secure hash entry. A single one of 247 * these flags causes the register to only be hashed for the specified 248 * security state. 249 * Although definitions may have any combination of the S/NS bits, each 250 * registered entry will only have one to identify whether the entry is secure 251 * or non-secure. 252 */ 253 typedef enum { 254 ARM_CP_SECSTATE_BOTH = 0, /* define one cpreg for each secstate */ 255 ARM_CP_SECSTATE_S = (1 << 0), /* bit[0]: Secure state register */ 256 ARM_CP_SECSTATE_NS = (1 << 1), /* bit[1]: Non-secure state register */ 257 } CPSecureState; 258 259 /* 260 * Access rights: 261 * We define bits for Read and Write access for what rev C of the v7-AR ARM ARM 262 * defines as PL0 (user), PL1 (fiq/irq/svc/abt/und/sys, ie privileged), and 263 * PL2 (hyp). The other level which has Read and Write bits is Secure PL1 264 * (ie any of the privileged modes in Secure state, or Monitor mode). 265 * If a register is accessible in one privilege level it's always accessible 266 * in higher privilege levels too. Since "Secure PL1" also follows this rule 267 * (ie anything visible in PL2 is visible in S-PL1, some things are only 268 * visible in S-PL1) but "Secure PL1" is a bit of a mouthful, we bend the 269 * terminology a little and call this PL3. 270 * In AArch64 things are somewhat simpler as the PLx bits line up exactly 271 * with the ELx exception levels. 272 * 273 * If access permissions for a register are more complex than can be 274 * described with these bits, then use a laxer set of restrictions, and 275 * do the more restrictive/complex check inside a helper function. 276 */ 277 typedef enum { 278 PL3_R = 0x80, 279 PL3_W = 0x40, 280 PL2_R = 0x20 | PL3_R, 281 PL2_W = 0x10 | PL3_W, 282 PL1_R = 0x08 | PL2_R, 283 PL1_W = 0x04 | PL2_W, 284 PL0_R = 0x02 | PL1_R, 285 PL0_W = 0x01 | PL1_W, 286 287 /* 288 * For user-mode some registers are accessible to EL0 via a kernel 289 * trap-and-emulate ABI. In this case we define the read permissions 290 * as actually being PL0_R. However some bits of any given register 291 * may still be masked. 292 */ 293 #ifdef CONFIG_USER_ONLY 294 PL0U_R = PL0_R, 295 #else 296 PL0U_R = PL1_R, 297 #endif 298 299 PL3_RW = PL3_R | PL3_W, 300 PL2_RW = PL2_R | PL2_W, 301 PL1_RW = PL1_R | PL1_W, 302 PL0_RW = PL0_R | PL0_W, 303 } CPAccessRights; 304 305 typedef enum CPAccessResult { 306 /* Access is permitted */ 307 CP_ACCESS_OK = 0, 308 309 /* 310 * Combined with one of the following, the low 2 bits indicate the 311 * target exception level. If 0, the exception is taken to the usual 312 * target EL (EL1 or PL1 if in EL0, otherwise to the current EL). 313 */ 314 CP_ACCESS_EL_MASK = 3, 315 316 /* 317 * Access fails due to a configurable trap or enable which would 318 * result in a categorized exception syndrome giving information about 319 * the failing instruction (ie syndrome category 0x3, 0x4, 0x5, 0x6, 320 * 0xc or 0x18). 321 */ 322 CP_ACCESS_TRAP = (1 << 2), 323 CP_ACCESS_TRAP_EL2 = CP_ACCESS_TRAP | 2, 324 CP_ACCESS_TRAP_EL3 = CP_ACCESS_TRAP | 3, 325 326 /* 327 * Access fails and results in an exception syndrome 0x0 ("uncategorized"). 328 * Note that this is not a catch-all case -- the set of cases which may 329 * result in this failure is specifically defined by the architecture. 330 * This trap is always to the usual target EL, never directly to a 331 * specified target EL. 332 */ 333 CP_ACCESS_TRAP_UNCATEGORIZED = (2 << 2), 334 } CPAccessResult; 335 336 /* Indexes into fgt_read[] */ 337 #define FGTREG_HFGRTR 0 338 #define FGTREG_HDFGRTR 1 339 /* Indexes into fgt_write[] */ 340 #define FGTREG_HFGWTR 0 341 #define FGTREG_HDFGWTR 1 342 /* Indexes into fgt_exec[] */ 343 #define FGTREG_HFGITR 0 344 345 FIELD(HFGRTR_EL2, AFSR0_EL1, 0, 1) 346 FIELD(HFGRTR_EL2, AFSR1_EL1, 1, 1) 347 FIELD(HFGRTR_EL2, AIDR_EL1, 2, 1) 348 FIELD(HFGRTR_EL2, AMAIR_EL1, 3, 1) 349 FIELD(HFGRTR_EL2, APDAKEY, 4, 1) 350 FIELD(HFGRTR_EL2, APDBKEY, 5, 1) 351 FIELD(HFGRTR_EL2, APGAKEY, 6, 1) 352 FIELD(HFGRTR_EL2, APIAKEY, 7, 1) 353 FIELD(HFGRTR_EL2, APIBKEY, 8, 1) 354 FIELD(HFGRTR_EL2, CCSIDR_EL1, 9, 1) 355 FIELD(HFGRTR_EL2, CLIDR_EL1, 10, 1) 356 FIELD(HFGRTR_EL2, CONTEXTIDR_EL1, 11, 1) 357 FIELD(HFGRTR_EL2, CPACR_EL1, 12, 1) 358 FIELD(HFGRTR_EL2, CSSELR_EL1, 13, 1) 359 FIELD(HFGRTR_EL2, CTR_EL0, 14, 1) 360 FIELD(HFGRTR_EL2, DCZID_EL0, 15, 1) 361 FIELD(HFGRTR_EL2, ESR_EL1, 16, 1) 362 FIELD(HFGRTR_EL2, FAR_EL1, 17, 1) 363 FIELD(HFGRTR_EL2, ISR_EL1, 18, 1) 364 FIELD(HFGRTR_EL2, LORC_EL1, 19, 1) 365 FIELD(HFGRTR_EL2, LOREA_EL1, 20, 1) 366 FIELD(HFGRTR_EL2, LORID_EL1, 21, 1) 367 FIELD(HFGRTR_EL2, LORN_EL1, 22, 1) 368 FIELD(HFGRTR_EL2, LORSA_EL1, 23, 1) 369 FIELD(HFGRTR_EL2, MAIR_EL1, 24, 1) 370 FIELD(HFGRTR_EL2, MIDR_EL1, 25, 1) 371 FIELD(HFGRTR_EL2, MPIDR_EL1, 26, 1) 372 FIELD(HFGRTR_EL2, PAR_EL1, 27, 1) 373 FIELD(HFGRTR_EL2, REVIDR_EL1, 28, 1) 374 FIELD(HFGRTR_EL2, SCTLR_EL1, 29, 1) 375 FIELD(HFGRTR_EL2, SCXTNUM_EL1, 30, 1) 376 FIELD(HFGRTR_EL2, SCXTNUM_EL0, 31, 1) 377 FIELD(HFGRTR_EL2, TCR_EL1, 32, 1) 378 FIELD(HFGRTR_EL2, TPIDR_EL1, 33, 1) 379 FIELD(HFGRTR_EL2, TPIDRRO_EL0, 34, 1) 380 FIELD(HFGRTR_EL2, TPIDR_EL0, 35, 1) 381 FIELD(HFGRTR_EL2, TTBR0_EL1, 36, 1) 382 FIELD(HFGRTR_EL2, TTBR1_EL1, 37, 1) 383 FIELD(HFGRTR_EL2, VBAR_EL1, 38, 1) 384 FIELD(HFGRTR_EL2, ICC_IGRPENN_EL1, 39, 1) 385 FIELD(HFGRTR_EL2, ERRIDR_EL1, 40, 1) 386 FIELD(HFGRTR_EL2, ERRSELR_EL1, 41, 1) 387 FIELD(HFGRTR_EL2, ERXFR_EL1, 42, 1) 388 FIELD(HFGRTR_EL2, ERXCTLR_EL1, 43, 1) 389 FIELD(HFGRTR_EL2, ERXSTATUS_EL1, 44, 1) 390 FIELD(HFGRTR_EL2, ERXMISCN_EL1, 45, 1) 391 FIELD(HFGRTR_EL2, ERXPFGF_EL1, 46, 1) 392 FIELD(HFGRTR_EL2, ERXPFGCTL_EL1, 47, 1) 393 FIELD(HFGRTR_EL2, ERXPFGCDN_EL1, 48, 1) 394 FIELD(HFGRTR_EL2, ERXADDR_EL1, 49, 1) 395 FIELD(HFGRTR_EL2, NACCDATA_EL1, 50, 1) 396 /* 51-53: RES0 */ 397 FIELD(HFGRTR_EL2, NSMPRI_EL1, 54, 1) 398 FIELD(HFGRTR_EL2, NTPIDR2_EL0, 55, 1) 399 /* 56-63: RES0 */ 400 401 /* These match HFGRTR but bits for RO registers are RES0 */ 402 FIELD(HFGWTR_EL2, AFSR0_EL1, 0, 1) 403 FIELD(HFGWTR_EL2, AFSR1_EL1, 1, 1) 404 FIELD(HFGWTR_EL2, AMAIR_EL1, 3, 1) 405 FIELD(HFGWTR_EL2, APDAKEY, 4, 1) 406 FIELD(HFGWTR_EL2, APDBKEY, 5, 1) 407 FIELD(HFGWTR_EL2, APGAKEY, 6, 1) 408 FIELD(HFGWTR_EL2, APIAKEY, 7, 1) 409 FIELD(HFGWTR_EL2, APIBKEY, 8, 1) 410 FIELD(HFGWTR_EL2, CONTEXTIDR_EL1, 11, 1) 411 FIELD(HFGWTR_EL2, CPACR_EL1, 12, 1) 412 FIELD(HFGWTR_EL2, CSSELR_EL1, 13, 1) 413 FIELD(HFGWTR_EL2, ESR_EL1, 16, 1) 414 FIELD(HFGWTR_EL2, FAR_EL1, 17, 1) 415 FIELD(HFGWTR_EL2, LORC_EL1, 19, 1) 416 FIELD(HFGWTR_EL2, LOREA_EL1, 20, 1) 417 FIELD(HFGWTR_EL2, LORN_EL1, 22, 1) 418 FIELD(HFGWTR_EL2, LORSA_EL1, 23, 1) 419 FIELD(HFGWTR_EL2, MAIR_EL1, 24, 1) 420 FIELD(HFGWTR_EL2, PAR_EL1, 27, 1) 421 FIELD(HFGWTR_EL2, SCTLR_EL1, 29, 1) 422 FIELD(HFGWTR_EL2, SCXTNUM_EL1, 30, 1) 423 FIELD(HFGWTR_EL2, SCXTNUM_EL0, 31, 1) 424 FIELD(HFGWTR_EL2, TCR_EL1, 32, 1) 425 FIELD(HFGWTR_EL2, TPIDR_EL1, 33, 1) 426 FIELD(HFGWTR_EL2, TPIDRRO_EL0, 34, 1) 427 FIELD(HFGWTR_EL2, TPIDR_EL0, 35, 1) 428 FIELD(HFGWTR_EL2, TTBR0_EL1, 36, 1) 429 FIELD(HFGWTR_EL2, TTBR1_EL1, 37, 1) 430 FIELD(HFGWTR_EL2, VBAR_EL1, 38, 1) 431 FIELD(HFGWTR_EL2, ICC_IGRPENN_EL1, 39, 1) 432 FIELD(HFGWTR_EL2, ERRSELR_EL1, 41, 1) 433 FIELD(HFGWTR_EL2, ERXCTLR_EL1, 43, 1) 434 FIELD(HFGWTR_EL2, ERXSTATUS_EL1, 44, 1) 435 FIELD(HFGWTR_EL2, ERXMISCN_EL1, 45, 1) 436 FIELD(HFGWTR_EL2, ERXPFGCTL_EL1, 47, 1) 437 FIELD(HFGWTR_EL2, ERXPFGCDN_EL1, 48, 1) 438 FIELD(HFGWTR_EL2, ERXADDR_EL1, 49, 1) 439 FIELD(HFGWTR_EL2, NACCDATA_EL1, 50, 1) 440 FIELD(HFGWTR_EL2, NSMPRI_EL1, 54, 1) 441 FIELD(HFGWTR_EL2, NTPIDR2_EL0, 55, 1) 442 443 FIELD(HFGITR_EL2, ICIALLUIS, 0, 1) 444 FIELD(HFGITR_EL2, ICIALLU, 1, 1) 445 FIELD(HFGITR_EL2, ICIVAU, 2, 1) 446 FIELD(HFGITR_EL2, DCIVAC, 3, 1) 447 FIELD(HFGITR_EL2, DCISW, 4, 1) 448 FIELD(HFGITR_EL2, DCCSW, 5, 1) 449 FIELD(HFGITR_EL2, DCCISW, 6, 1) 450 FIELD(HFGITR_EL2, DCCVAU, 7, 1) 451 FIELD(HFGITR_EL2, DCCVAP, 8, 1) 452 FIELD(HFGITR_EL2, DCCVADP, 9, 1) 453 FIELD(HFGITR_EL2, DCCIVAC, 10, 1) 454 FIELD(HFGITR_EL2, DCZVA, 11, 1) 455 FIELD(HFGITR_EL2, ATS1E1R, 12, 1) 456 FIELD(HFGITR_EL2, ATS1E1W, 13, 1) 457 FIELD(HFGITR_EL2, ATS1E0R, 14, 1) 458 FIELD(HFGITR_EL2, ATS1E0W, 15, 1) 459 FIELD(HFGITR_EL2, ATS1E1RP, 16, 1) 460 FIELD(HFGITR_EL2, ATS1E1WP, 17, 1) 461 FIELD(HFGITR_EL2, TLBIVMALLE1OS, 18, 1) 462 FIELD(HFGITR_EL2, TLBIVAE1OS, 19, 1) 463 FIELD(HFGITR_EL2, TLBIASIDE1OS, 20, 1) 464 FIELD(HFGITR_EL2, TLBIVAAE1OS, 21, 1) 465 FIELD(HFGITR_EL2, TLBIVALE1OS, 22, 1) 466 FIELD(HFGITR_EL2, TLBIVAALE1OS, 23, 1) 467 FIELD(HFGITR_EL2, TLBIRVAE1OS, 24, 1) 468 FIELD(HFGITR_EL2, TLBIRVAAE1OS, 25, 1) 469 FIELD(HFGITR_EL2, TLBIRVALE1OS, 26, 1) 470 FIELD(HFGITR_EL2, TLBIRVAALE1OS, 27, 1) 471 FIELD(HFGITR_EL2, TLBIVMALLE1IS, 28, 1) 472 FIELD(HFGITR_EL2, TLBIVAE1IS, 29, 1) 473 FIELD(HFGITR_EL2, TLBIASIDE1IS, 30, 1) 474 FIELD(HFGITR_EL2, TLBIVAAE1IS, 31, 1) 475 FIELD(HFGITR_EL2, TLBIVALE1IS, 32, 1) 476 FIELD(HFGITR_EL2, TLBIVAALE1IS, 33, 1) 477 FIELD(HFGITR_EL2, TLBIRVAE1IS, 34, 1) 478 FIELD(HFGITR_EL2, TLBIRVAAE1IS, 35, 1) 479 FIELD(HFGITR_EL2, TLBIRVALE1IS, 36, 1) 480 FIELD(HFGITR_EL2, TLBIRVAALE1IS, 37, 1) 481 FIELD(HFGITR_EL2, TLBIRVAE1, 38, 1) 482 FIELD(HFGITR_EL2, TLBIRVAAE1, 39, 1) 483 FIELD(HFGITR_EL2, TLBIRVALE1, 40, 1) 484 FIELD(HFGITR_EL2, TLBIRVAALE1, 41, 1) 485 FIELD(HFGITR_EL2, TLBIVMALLE1, 42, 1) 486 FIELD(HFGITR_EL2, TLBIVAE1, 43, 1) 487 FIELD(HFGITR_EL2, TLBIASIDE1, 44, 1) 488 FIELD(HFGITR_EL2, TLBIVAAE1, 45, 1) 489 FIELD(HFGITR_EL2, TLBIVALE1, 46, 1) 490 FIELD(HFGITR_EL2, TLBIVAALE1, 47, 1) 491 FIELD(HFGITR_EL2, CFPRCTX, 48, 1) 492 FIELD(HFGITR_EL2, DVPRCTX, 49, 1) 493 FIELD(HFGITR_EL2, CPPRCTX, 50, 1) 494 FIELD(HFGITR_EL2, ERET, 51, 1) 495 FIELD(HFGITR_EL2, SVC_EL0, 52, 1) 496 FIELD(HFGITR_EL2, SVC_EL1, 53, 1) 497 FIELD(HFGITR_EL2, DCCVAC, 54, 1) 498 FIELD(HFGITR_EL2, NBRBINJ, 55, 1) 499 FIELD(HFGITR_EL2, NBRBIALL, 56, 1) 500 501 FIELD(HDFGRTR_EL2, DBGBCRN_EL1, 0, 1) 502 FIELD(HDFGRTR_EL2, DBGBVRN_EL1, 1, 1) 503 FIELD(HDFGRTR_EL2, DBGWCRN_EL1, 2, 1) 504 FIELD(HDFGRTR_EL2, DBGWVRN_EL1, 3, 1) 505 FIELD(HDFGRTR_EL2, MDSCR_EL1, 4, 1) 506 FIELD(HDFGRTR_EL2, DBGCLAIM, 5, 1) 507 FIELD(HDFGRTR_EL2, DBGAUTHSTATUS_EL1, 6, 1) 508 FIELD(HDFGRTR_EL2, DBGPRCR_EL1, 7, 1) 509 /* 8: RES0: OSLAR_EL1 is WO */ 510 FIELD(HDFGRTR_EL2, OSLSR_EL1, 9, 1) 511 FIELD(HDFGRTR_EL2, OSECCR_EL1, 10, 1) 512 FIELD(HDFGRTR_EL2, OSDLR_EL1, 11, 1) 513 FIELD(HDFGRTR_EL2, PMEVCNTRN_EL0, 12, 1) 514 FIELD(HDFGRTR_EL2, PMEVTYPERN_EL0, 13, 1) 515 FIELD(HDFGRTR_EL2, PMCCFILTR_EL0, 14, 1) 516 FIELD(HDFGRTR_EL2, PMCCNTR_EL0, 15, 1) 517 FIELD(HDFGRTR_EL2, PMCNTEN, 16, 1) 518 FIELD(HDFGRTR_EL2, PMINTEN, 17, 1) 519 FIELD(HDFGRTR_EL2, PMOVS, 18, 1) 520 FIELD(HDFGRTR_EL2, PMSELR_EL0, 19, 1) 521 /* 20: RES0: PMSWINC_EL0 is WO */ 522 /* 21: RES0: PMCR_EL0 is WO */ 523 FIELD(HDFGRTR_EL2, PMMIR_EL1, 22, 1) 524 FIELD(HDFGRTR_EL2, PMBLIMITR_EL1, 23, 1) 525 FIELD(HDFGRTR_EL2, PMBPTR_EL1, 24, 1) 526 FIELD(HDFGRTR_EL2, PMBSR_EL1, 25, 1) 527 FIELD(HDFGRTR_EL2, PMSCR_EL1, 26, 1) 528 FIELD(HDFGRTR_EL2, PMSEVFR_EL1, 27, 1) 529 FIELD(HDFGRTR_EL2, PMSFCR_EL1, 28, 1) 530 FIELD(HDFGRTR_EL2, PMSICR_EL1, 29, 1) 531 FIELD(HDFGRTR_EL2, PMSIDR_EL1, 30, 1) 532 FIELD(HDFGRTR_EL2, PMSIRR_EL1, 31, 1) 533 FIELD(HDFGRTR_EL2, PMSLATFR_EL1, 32, 1) 534 FIELD(HDFGRTR_EL2, TRC, 33, 1) 535 FIELD(HDFGRTR_EL2, TRCAUTHSTATUS, 34, 1) 536 FIELD(HDFGRTR_EL2, TRCAUXCTLR, 35, 1) 537 FIELD(HDFGRTR_EL2, TRCCLAIM, 36, 1) 538 FIELD(HDFGRTR_EL2, TRCCNTVRn, 37, 1) 539 /* 38, 39: RES0 */ 540 FIELD(HDFGRTR_EL2, TRCID, 40, 1) 541 FIELD(HDFGRTR_EL2, TRCIMSPECN, 41, 1) 542 /* 42: RES0: TRCOSLAR is WO */ 543 FIELD(HDFGRTR_EL2, TRCOSLSR, 43, 1) 544 FIELD(HDFGRTR_EL2, TRCPRGCTLR, 44, 1) 545 FIELD(HDFGRTR_EL2, TRCSEQSTR, 45, 1) 546 FIELD(HDFGRTR_EL2, TRCSSCSRN, 46, 1) 547 FIELD(HDFGRTR_EL2, TRCSTATR, 47, 1) 548 FIELD(HDFGRTR_EL2, TRCVICTLR, 48, 1) 549 /* 49: RES0: TRFCR_EL1 is WO */ 550 FIELD(HDFGRTR_EL2, TRBBASER_EL1, 50, 1) 551 FIELD(HDFGRTR_EL2, TRBIDR_EL1, 51, 1) 552 FIELD(HDFGRTR_EL2, TRBLIMITR_EL1, 52, 1) 553 FIELD(HDFGRTR_EL2, TRBMAR_EL1, 53, 1) 554 FIELD(HDFGRTR_EL2, TRBPTR_EL1, 54, 1) 555 FIELD(HDFGRTR_EL2, TRBSR_EL1, 55, 1) 556 FIELD(HDFGRTR_EL2, TRBTRG_EL1, 56, 1) 557 FIELD(HDFGRTR_EL2, PMUSERENR_EL0, 57, 1) 558 FIELD(HDFGRTR_EL2, PMCEIDN_EL0, 58, 1) 559 FIELD(HDFGRTR_EL2, NBRBIDR, 59, 1) 560 FIELD(HDFGRTR_EL2, NBRBCTL, 60, 1) 561 FIELD(HDFGRTR_EL2, NBRBDATA, 61, 1) 562 FIELD(HDFGRTR_EL2, NPMSNEVFR_EL1, 62, 1) 563 FIELD(HDFGRTR_EL2, PMBIDR_EL1, 63, 1) 564 565 /* 566 * These match HDFGRTR_EL2, but bits for RO registers are RES0. 567 * A few bits are for WO registers, where the HDFGRTR_EL2 bit is RES0. 568 */ 569 FIELD(HDFGWTR_EL2, DBGBCRN_EL1, 0, 1) 570 FIELD(HDFGWTR_EL2, DBGBVRN_EL1, 1, 1) 571 FIELD(HDFGWTR_EL2, DBGWCRN_EL1, 2, 1) 572 FIELD(HDFGWTR_EL2, DBGWVRN_EL1, 3, 1) 573 FIELD(HDFGWTR_EL2, MDSCR_EL1, 4, 1) 574 FIELD(HDFGWTR_EL2, DBGCLAIM, 5, 1) 575 FIELD(HDFGWTR_EL2, DBGPRCR_EL1, 7, 1) 576 FIELD(HDFGWTR_EL2, OSLAR_EL1, 8, 1) 577 FIELD(HDFGWTR_EL2, OSLSR_EL1, 9, 1) 578 FIELD(HDFGWTR_EL2, OSECCR_EL1, 10, 1) 579 FIELD(HDFGWTR_EL2, OSDLR_EL1, 11, 1) 580 FIELD(HDFGWTR_EL2, PMEVCNTRN_EL0, 12, 1) 581 FIELD(HDFGWTR_EL2, PMEVTYPERN_EL0, 13, 1) 582 FIELD(HDFGWTR_EL2, PMCCFILTR_EL0, 14, 1) 583 FIELD(HDFGWTR_EL2, PMCCNTR_EL0, 15, 1) 584 FIELD(HDFGWTR_EL2, PMCNTEN, 16, 1) 585 FIELD(HDFGWTR_EL2, PMINTEN, 17, 1) 586 FIELD(HDFGWTR_EL2, PMOVS, 18, 1) 587 FIELD(HDFGWTR_EL2, PMSELR_EL0, 19, 1) 588 FIELD(HDFGWTR_EL2, PMSWINC_EL0, 20, 1) 589 FIELD(HDFGWTR_EL2, PMCR_EL0, 21, 1) 590 FIELD(HDFGWTR_EL2, PMBLIMITR_EL1, 23, 1) 591 FIELD(HDFGWTR_EL2, PMBPTR_EL1, 24, 1) 592 FIELD(HDFGWTR_EL2, PMBSR_EL1, 25, 1) 593 FIELD(HDFGWTR_EL2, PMSCR_EL1, 26, 1) 594 FIELD(HDFGWTR_EL2, PMSEVFR_EL1, 27, 1) 595 FIELD(HDFGWTR_EL2, PMSFCR_EL1, 28, 1) 596 FIELD(HDFGWTR_EL2, PMSICR_EL1, 29, 1) 597 FIELD(HDFGWTR_EL2, PMSIRR_EL1, 31, 1) 598 FIELD(HDFGWTR_EL2, PMSLATFR_EL1, 32, 1) 599 FIELD(HDFGWTR_EL2, TRC, 33, 1) 600 FIELD(HDFGWTR_EL2, TRCAUXCTLR, 35, 1) 601 FIELD(HDFGWTR_EL2, TRCCLAIM, 36, 1) 602 FIELD(HDFGWTR_EL2, TRCCNTVRn, 37, 1) 603 FIELD(HDFGWTR_EL2, TRCIMSPECN, 41, 1) 604 FIELD(HDFGWTR_EL2, TRCOSLAR, 42, 1) 605 FIELD(HDFGWTR_EL2, TRCPRGCTLR, 44, 1) 606 FIELD(HDFGWTR_EL2, TRCSEQSTR, 45, 1) 607 FIELD(HDFGWTR_EL2, TRCSSCSRN, 46, 1) 608 FIELD(HDFGWTR_EL2, TRCVICTLR, 48, 1) 609 FIELD(HDFGWTR_EL2, TRFCR_EL1, 49, 1) 610 FIELD(HDFGWTR_EL2, TRBBASER_EL1, 50, 1) 611 FIELD(HDFGWTR_EL2, TRBLIMITR_EL1, 52, 1) 612 FIELD(HDFGWTR_EL2, TRBMAR_EL1, 53, 1) 613 FIELD(HDFGWTR_EL2, TRBPTR_EL1, 54, 1) 614 FIELD(HDFGWTR_EL2, TRBSR_EL1, 55, 1) 615 FIELD(HDFGWTR_EL2, TRBTRG_EL1, 56, 1) 616 FIELD(HDFGWTR_EL2, PMUSERENR_EL0, 57, 1) 617 FIELD(HDFGWTR_EL2, NBRBCTL, 60, 1) 618 FIELD(HDFGWTR_EL2, NBRBDATA, 61, 1) 619 FIELD(HDFGWTR_EL2, NPMSNEVFR_EL1, 62, 1) 620 621 /* Which fine-grained trap bit register to check, if any */ 622 FIELD(FGT, TYPE, 10, 3) 623 FIELD(FGT, REV, 9, 1) /* Is bit sense reversed? */ 624 FIELD(FGT, IDX, 6, 3) /* Index within a uint64_t[] array */ 625 FIELD(FGT, BITPOS, 0, 6) /* Bit position within the uint64_t */ 626 627 /* 628 * Macros to define FGT_##bitname enum constants to use in ARMCPRegInfo::fgt 629 * fields. We assume for brevity's sake that there are no duplicated 630 * bit names across the various FGT registers. 631 */ 632 #define DO_BIT(REG, BITNAME) \ 633 FGT_##BITNAME = FGT_##REG | R_##REG##_EL2_##BITNAME##_SHIFT 634 635 /* Some bits have reversed sense, so 0 means trap and 1 means not */ 636 #define DO_REV_BIT(REG, BITNAME) \ 637 FGT_##BITNAME = FGT_##REG | FGT_REV | R_##REG##_EL2_##BITNAME##_SHIFT 638 639 typedef enum FGTBit { 640 /* 641 * These bits tell us which register arrays to use: 642 * if FGT_R is set then reads are checked against fgt_read[]; 643 * if FGT_W is set then writes are checked against fgt_write[]; 644 * if FGT_EXEC is set then all accesses are checked against fgt_exec[]. 645 * 646 * For almost all bits in the R/W register pairs, the bit exists in 647 * both registers for a RW register, in HFGRTR/HDFGRTR for a RO register 648 * with the corresponding HFGWTR/HDFGTWTR bit being RES0, and vice-versa 649 * for a WO register. There are unfortunately a couple of exceptions 650 * (PMCR_EL0, TRFCR_EL1) where the register being trapped is RW but 651 * the FGT system only allows trapping of writes, not reads. 652 * 653 * Note that we arrange these bits so that a 0 FGTBit means "no trap". 654 */ 655 FGT_R = 1 << R_FGT_TYPE_SHIFT, 656 FGT_W = 2 << R_FGT_TYPE_SHIFT, 657 FGT_EXEC = 4 << R_FGT_TYPE_SHIFT, 658 FGT_RW = FGT_R | FGT_W, 659 /* Bit to identify whether trap bit is reversed sense */ 660 FGT_REV = R_FGT_REV_MASK, 661 662 /* 663 * If a bit exists in HFGRTR/HDFGRTR then either the register being 664 * trapped is RO or the bit also exists in HFGWTR/HDFGWTR, so we either 665 * want to trap for both reads and writes or else it's harmless to mark 666 * it as trap-on-writes. 667 * If a bit exists only in HFGWTR/HDFGWTR then either the register being 668 * trapped is WO, or else it is one of the two oddball special cases 669 * which are RW but have only a write trap. We mark these as only 670 * FGT_W so we get the right behaviour for those special cases. 671 * (If a bit was added in future that provided only a read trap for an 672 * RW register we'd need to do something special to get the FGT_R bit 673 * only. But this seems unlikely to happen.) 674 * 675 * So for the DO_BIT/DO_REV_BIT macros: use FGT_HFGRTR/FGT_HDFGRTR if 676 * the bit exists in that register. Otherwise use FGT_HFGWTR/FGT_HDFGWTR. 677 */ 678 FGT_HFGRTR = FGT_RW | (FGTREG_HFGRTR << R_FGT_IDX_SHIFT), 679 FGT_HFGWTR = FGT_W | (FGTREG_HFGWTR << R_FGT_IDX_SHIFT), 680 FGT_HDFGRTR = FGT_RW | (FGTREG_HDFGRTR << R_FGT_IDX_SHIFT), 681 FGT_HDFGWTR = FGT_W | (FGTREG_HDFGWTR << R_FGT_IDX_SHIFT), 682 FGT_HFGITR = FGT_EXEC | (FGTREG_HFGITR << R_FGT_IDX_SHIFT), 683 684 /* Trap bits in HFGRTR_EL2 / HFGWTR_EL2, starting from bit 0. */ 685 DO_BIT(HFGRTR, AFSR0_EL1), 686 DO_BIT(HFGRTR, AFSR1_EL1), 687 DO_BIT(HFGRTR, AIDR_EL1), 688 DO_BIT(HFGRTR, AMAIR_EL1), 689 DO_BIT(HFGRTR, APDAKEY), 690 DO_BIT(HFGRTR, APDBKEY), 691 DO_BIT(HFGRTR, APGAKEY), 692 DO_BIT(HFGRTR, APIAKEY), 693 DO_BIT(HFGRTR, APIBKEY), 694 DO_BIT(HFGRTR, CCSIDR_EL1), 695 DO_BIT(HFGRTR, CLIDR_EL1), 696 DO_BIT(HFGRTR, CONTEXTIDR_EL1), 697 DO_BIT(HFGRTR, CPACR_EL1), 698 DO_BIT(HFGRTR, CSSELR_EL1), 699 DO_BIT(HFGRTR, CTR_EL0), 700 DO_BIT(HFGRTR, DCZID_EL0), 701 DO_BIT(HFGRTR, ESR_EL1), 702 DO_BIT(HFGRTR, FAR_EL1), 703 DO_BIT(HFGRTR, ISR_EL1), 704 DO_BIT(HFGRTR, LORC_EL1), 705 DO_BIT(HFGRTR, LOREA_EL1), 706 DO_BIT(HFGRTR, LORID_EL1), 707 DO_BIT(HFGRTR, LORN_EL1), 708 DO_BIT(HFGRTR, LORSA_EL1), 709 DO_BIT(HFGRTR, MAIR_EL1), 710 DO_BIT(HFGRTR, MIDR_EL1), 711 DO_BIT(HFGRTR, MPIDR_EL1), 712 DO_BIT(HFGRTR, PAR_EL1), 713 DO_BIT(HFGRTR, REVIDR_EL1), 714 DO_BIT(HFGRTR, SCTLR_EL1), 715 DO_BIT(HFGRTR, SCXTNUM_EL1), 716 DO_BIT(HFGRTR, SCXTNUM_EL0), 717 DO_BIT(HFGRTR, TCR_EL1), 718 DO_BIT(HFGRTR, TPIDR_EL1), 719 DO_BIT(HFGRTR, TPIDRRO_EL0), 720 DO_BIT(HFGRTR, TPIDR_EL0), 721 DO_BIT(HFGRTR, TTBR0_EL1), 722 DO_BIT(HFGRTR, TTBR1_EL1), 723 DO_BIT(HFGRTR, VBAR_EL1), 724 DO_BIT(HFGRTR, ICC_IGRPENN_EL1), 725 DO_BIT(HFGRTR, ERRIDR_EL1), 726 DO_REV_BIT(HFGRTR, NSMPRI_EL1), 727 DO_REV_BIT(HFGRTR, NTPIDR2_EL0), 728 729 /* Trap bits in HDFGRTR_EL2 / HDFGWTR_EL2, starting from bit 0. */ 730 DO_BIT(HDFGRTR, DBGBCRN_EL1), 731 DO_BIT(HDFGRTR, DBGBVRN_EL1), 732 DO_BIT(HDFGRTR, DBGWCRN_EL1), 733 DO_BIT(HDFGRTR, DBGWVRN_EL1), 734 DO_BIT(HDFGRTR, MDSCR_EL1), 735 DO_BIT(HDFGRTR, DBGCLAIM), 736 DO_BIT(HDFGWTR, OSLAR_EL1), 737 DO_BIT(HDFGRTR, OSLSR_EL1), 738 DO_BIT(HDFGRTR, OSECCR_EL1), 739 DO_BIT(HDFGRTR, OSDLR_EL1), 740 DO_BIT(HDFGRTR, PMEVCNTRN_EL0), 741 DO_BIT(HDFGRTR, PMEVTYPERN_EL0), 742 DO_BIT(HDFGRTR, PMCCFILTR_EL0), 743 DO_BIT(HDFGRTR, PMCCNTR_EL0), 744 DO_BIT(HDFGRTR, PMCNTEN), 745 DO_BIT(HDFGRTR, PMINTEN), 746 DO_BIT(HDFGRTR, PMOVS), 747 DO_BIT(HDFGRTR, PMSELR_EL0), 748 DO_BIT(HDFGWTR, PMSWINC_EL0), 749 DO_BIT(HDFGWTR, PMCR_EL0), 750 DO_BIT(HDFGRTR, PMMIR_EL1), 751 DO_BIT(HDFGRTR, PMCEIDN_EL0), 752 753 /* Trap bits in HFGITR_EL2, starting from bit 0 */ 754 DO_BIT(HFGITR, ICIALLUIS), 755 DO_BIT(HFGITR, ICIALLU), 756 DO_BIT(HFGITR, ICIVAU), 757 DO_BIT(HFGITR, DCIVAC), 758 DO_BIT(HFGITR, DCISW), 759 DO_BIT(HFGITR, DCCSW), 760 DO_BIT(HFGITR, DCCISW), 761 DO_BIT(HFGITR, DCCVAU), 762 DO_BIT(HFGITR, DCCVAP), 763 DO_BIT(HFGITR, DCCVADP), 764 DO_BIT(HFGITR, DCCIVAC), 765 DO_BIT(HFGITR, DCZVA), 766 DO_BIT(HFGITR, ATS1E1R), 767 DO_BIT(HFGITR, ATS1E1W), 768 DO_BIT(HFGITR, ATS1E0R), 769 DO_BIT(HFGITR, ATS1E0W), 770 DO_BIT(HFGITR, ATS1E1RP), 771 DO_BIT(HFGITR, ATS1E1WP), 772 DO_BIT(HFGITR, TLBIVMALLE1OS), 773 DO_BIT(HFGITR, TLBIVAE1OS), 774 DO_BIT(HFGITR, TLBIASIDE1OS), 775 DO_BIT(HFGITR, TLBIVAAE1OS), 776 DO_BIT(HFGITR, TLBIVALE1OS), 777 DO_BIT(HFGITR, TLBIVAALE1OS), 778 DO_BIT(HFGITR, TLBIRVAE1OS), 779 DO_BIT(HFGITR, TLBIRVAAE1OS), 780 DO_BIT(HFGITR, TLBIRVALE1OS), 781 DO_BIT(HFGITR, TLBIRVAALE1OS), 782 DO_BIT(HFGITR, TLBIVMALLE1IS), 783 DO_BIT(HFGITR, TLBIVAE1IS), 784 DO_BIT(HFGITR, TLBIASIDE1IS), 785 DO_BIT(HFGITR, TLBIVAAE1IS), 786 DO_BIT(HFGITR, TLBIVALE1IS), 787 DO_BIT(HFGITR, TLBIVAALE1IS), 788 DO_BIT(HFGITR, TLBIRVAE1IS), 789 DO_BIT(HFGITR, TLBIRVAAE1IS), 790 DO_BIT(HFGITR, TLBIRVALE1IS), 791 DO_BIT(HFGITR, TLBIRVAALE1IS), 792 DO_BIT(HFGITR, TLBIRVAE1), 793 DO_BIT(HFGITR, TLBIRVAAE1), 794 DO_BIT(HFGITR, TLBIRVALE1), 795 DO_BIT(HFGITR, TLBIRVAALE1), 796 DO_BIT(HFGITR, TLBIVMALLE1), 797 DO_BIT(HFGITR, TLBIVAE1), 798 DO_BIT(HFGITR, TLBIASIDE1), 799 DO_BIT(HFGITR, TLBIVAAE1), 800 DO_BIT(HFGITR, TLBIVALE1), 801 DO_BIT(HFGITR, TLBIVAALE1), 802 DO_BIT(HFGITR, CFPRCTX), 803 DO_BIT(HFGITR, DVPRCTX), 804 DO_BIT(HFGITR, CPPRCTX), 805 DO_BIT(HFGITR, DCCVAC), 806 } FGTBit; 807 808 #undef DO_BIT 809 #undef DO_REV_BIT 810 811 typedef struct ARMCPRegInfo ARMCPRegInfo; 812 813 /* 814 * Access functions for coprocessor registers. These cannot fail and 815 * may not raise exceptions. 816 */ 817 typedef uint64_t CPReadFn(CPUARMState *env, const ARMCPRegInfo *opaque); 818 typedef void CPWriteFn(CPUARMState *env, const ARMCPRegInfo *opaque, 819 uint64_t value); 820 /* Access permission check functions for coprocessor registers. */ 821 typedef CPAccessResult CPAccessFn(CPUARMState *env, 822 const ARMCPRegInfo *opaque, 823 bool isread); 824 /* Hook function for register reset */ 825 typedef void CPResetFn(CPUARMState *env, const ARMCPRegInfo *opaque); 826 827 #define CP_ANY 0xff 828 829 /* Flags in the high bits of nv2_redirect_offset */ 830 #define NV2_REDIR_NV1 0x4000 /* Only redirect when HCR_EL2.NV1 == 1 */ 831 #define NV2_REDIR_NO_NV1 0x8000 /* Only redirect when HCR_EL2.NV1 == 0 */ 832 #define NV2_REDIR_FLAG_MASK 0xc000 833 834 /* Definition of an ARM coprocessor register */ 835 struct ARMCPRegInfo { 836 /* Name of register (useful mainly for debugging, need not be unique) */ 837 const char *name; 838 /* 839 * Location of register: coprocessor number and (crn,crm,opc1,opc2) 840 * tuple. Any of crm, opc1 and opc2 may be CP_ANY to indicate a 841 * 'wildcard' field -- any value of that field in the MRC/MCR insn 842 * will be decoded to this register. The register read and write 843 * callbacks will be passed an ARMCPRegInfo with the crn/crm/opc1/opc2 844 * used by the program, so it is possible to register a wildcard and 845 * then behave differently on read/write if necessary. 846 * For 64 bit registers, only crm and opc1 are relevant; crn and opc2 847 * must both be zero. 848 * For AArch64-visible registers, opc0 is also used. 849 * Since there are no "coprocessors" in AArch64, cp is purely used as a 850 * way to distinguish (for KVM's benefit) guest-visible system registers 851 * from demuxed ones provided to preserve the "no side effects on 852 * KVM register read/write from QEMU" semantics. cp==0x13 is guest 853 * visible (to match KVM's encoding); cp==0 will be converted to 854 * cp==0x13 when the ARMCPRegInfo is registered, for convenience. 855 */ 856 uint8_t cp; 857 uint8_t crn; 858 uint8_t crm; 859 uint8_t opc0; 860 uint8_t opc1; 861 uint8_t opc2; 862 /* Execution state in which this register is visible: ARM_CP_STATE_* */ 863 CPState state; 864 /* Register type: ARM_CP_* bits/values */ 865 int type; 866 /* Access rights: PL*_[RW] */ 867 CPAccessRights access; 868 /* Security state: ARM_CP_SECSTATE_* bits/values */ 869 CPSecureState secure; 870 /* 871 * Which fine-grained trap register bit to check, if any. This 872 * value encodes both the trap register and bit within it. 873 */ 874 FGTBit fgt; 875 876 /* 877 * Offset from VNCR_EL2 when FEAT_NV2 redirects access to memory; 878 * may include an NV2_REDIR_* flag. 879 */ 880 uint32_t nv2_redirect_offset; 881 882 /* 883 * The opaque pointer passed to define_arm_cp_regs_with_opaque() when 884 * this register was defined: can be used to hand data through to the 885 * register read/write functions, since they are passed the ARMCPRegInfo*. 886 */ 887 void *opaque; 888 /* 889 * Value of this register, if it is ARM_CP_CONST. Otherwise, if 890 * fieldoffset is non-zero, the reset value of the register. 891 */ 892 uint64_t resetvalue; 893 /* 894 * Offset of the field in CPUARMState for this register. 895 * This is not needed if either: 896 * 1. type is ARM_CP_CONST or one of the ARM_CP_SPECIALs 897 * 2. both readfn and writefn are specified 898 */ 899 ptrdiff_t fieldoffset; /* offsetof(CPUARMState, field) */ 900 901 /* 902 * Offsets of the secure and non-secure fields in CPUARMState for the 903 * register if it is banked. These fields are only used during the static 904 * registration of a register. During hashing the bank associated 905 * with a given security state is copied to fieldoffset which is used from 906 * there on out. 907 * 908 * It is expected that register definitions use either fieldoffset or 909 * bank_fieldoffsets in the definition but not both. It is also expected 910 * that both bank offsets are set when defining a banked register. This 911 * use indicates that a register is banked. 912 */ 913 ptrdiff_t bank_fieldoffsets[2]; 914 915 /* 916 * Function for making any access checks for this register in addition to 917 * those specified by the 'access' permissions bits. If NULL, no extra 918 * checks required. The access check is performed at runtime, not at 919 * translate time. 920 */ 921 CPAccessFn *accessfn; 922 /* 923 * Function for handling reads of this register. If NULL, then reads 924 * will be done by loading from the offset into CPUARMState specified 925 * by fieldoffset. 926 */ 927 CPReadFn *readfn; 928 /* 929 * Function for handling writes of this register. If NULL, then writes 930 * will be done by writing to the offset into CPUARMState specified 931 * by fieldoffset. 932 */ 933 CPWriteFn *writefn; 934 /* 935 * Function for doing a "raw" read; used when we need to copy 936 * coprocessor state to the kernel for KVM or out for 937 * migration. This only needs to be provided if there is also a 938 * readfn and it has side effects (for instance clear-on-read bits). 939 */ 940 CPReadFn *raw_readfn; 941 /* 942 * Function for doing a "raw" write; used when we need to copy KVM 943 * kernel coprocessor state into userspace, or for inbound 944 * migration. This only needs to be provided if there is also a 945 * writefn and it masks out "unwritable" bits or has write-one-to-clear 946 * or similar behaviour. 947 */ 948 CPWriteFn *raw_writefn; 949 /* 950 * Function for resetting the register. If NULL, then reset will be done 951 * by writing resetvalue to the field specified in fieldoffset. If 952 * fieldoffset is 0 then no reset will be done. 953 */ 954 CPResetFn *resetfn; 955 956 /* 957 * "Original" readfn, writefn, accessfn. 958 * For ARMv8.1-VHE register aliases, we overwrite the read/write 959 * accessor functions of various EL1/EL0 to perform the runtime 960 * check for which sysreg should actually be modified, and then 961 * forwards the operation. Before overwriting the accessors, 962 * the original function is copied here, so that accesses that 963 * really do go to the EL1/EL0 version proceed normally. 964 * (The corresponding EL2 register is linked via opaque.) 965 */ 966 CPReadFn *orig_readfn; 967 CPWriteFn *orig_writefn; 968 CPAccessFn *orig_accessfn; 969 }; 970 971 /* 972 * Macros which are lvalues for the field in CPUARMState for the 973 * ARMCPRegInfo *ri. 974 */ 975 #define CPREG_FIELD32(env, ri) \ 976 (*(uint32_t *)((char *)(env) + (ri)->fieldoffset)) 977 #define CPREG_FIELD64(env, ri) \ 978 (*(uint64_t *)((char *)(env) + (ri)->fieldoffset)) 979 980 void define_one_arm_cp_reg_with_opaque(ARMCPU *cpu, const ARMCPRegInfo *reg, 981 void *opaque); 982 983 static inline void define_one_arm_cp_reg(ARMCPU *cpu, const ARMCPRegInfo *regs) 984 { 985 define_one_arm_cp_reg_with_opaque(cpu, regs, NULL); 986 } 987 988 void define_arm_cp_regs_with_opaque_len(ARMCPU *cpu, const ARMCPRegInfo *regs, 989 void *opaque, size_t len); 990 991 #define define_arm_cp_regs_with_opaque(CPU, REGS, OPAQUE) \ 992 do { \ 993 QEMU_BUILD_BUG_ON(ARRAY_SIZE(REGS) == 0); \ 994 define_arm_cp_regs_with_opaque_len(CPU, REGS, OPAQUE, \ 995 ARRAY_SIZE(REGS)); \ 996 } while (0) 997 998 #define define_arm_cp_regs(CPU, REGS) \ 999 define_arm_cp_regs_with_opaque(CPU, REGS, NULL) 1000 1001 const ARMCPRegInfo *get_arm_cp_reginfo(GHashTable *cpregs, uint32_t encoded_cp); 1002 1003 /* 1004 * Definition of an ARM co-processor register as viewed from 1005 * userspace. This is used for presenting sanitised versions of 1006 * registers to userspace when emulating the Linux AArch64 CPU 1007 * ID/feature ABI (advertised as HWCAP_CPUID). 1008 */ 1009 typedef struct ARMCPRegUserSpaceInfo { 1010 /* Name of register */ 1011 const char *name; 1012 1013 /* Is the name actually a glob pattern */ 1014 bool is_glob; 1015 1016 /* Only some bits are exported to user space */ 1017 uint64_t exported_bits; 1018 1019 /* Fixed bits are applied after the mask */ 1020 uint64_t fixed_bits; 1021 } ARMCPRegUserSpaceInfo; 1022 1023 void modify_arm_cp_regs_with_len(ARMCPRegInfo *regs, size_t regs_len, 1024 const ARMCPRegUserSpaceInfo *mods, 1025 size_t mods_len); 1026 1027 #define modify_arm_cp_regs(REGS, MODS) \ 1028 do { \ 1029 QEMU_BUILD_BUG_ON(ARRAY_SIZE(REGS) == 0); \ 1030 QEMU_BUILD_BUG_ON(ARRAY_SIZE(MODS) == 0); \ 1031 modify_arm_cp_regs_with_len(REGS, ARRAY_SIZE(REGS), \ 1032 MODS, ARRAY_SIZE(MODS)); \ 1033 } while (0) 1034 1035 /* CPWriteFn that can be used to implement writes-ignored behaviour */ 1036 void arm_cp_write_ignore(CPUARMState *env, const ARMCPRegInfo *ri, 1037 uint64_t value); 1038 /* CPReadFn that can be used for read-as-zero behaviour */ 1039 uint64_t arm_cp_read_zero(CPUARMState *env, const ARMCPRegInfo *ri); 1040 1041 /* CPWriteFn that just writes the value to ri->fieldoffset */ 1042 void raw_write(CPUARMState *env, const ARMCPRegInfo *ri, uint64_t value); 1043 1044 /* 1045 * CPResetFn that does nothing, for use if no reset is required even 1046 * if fieldoffset is non zero. 1047 */ 1048 void arm_cp_reset_ignore(CPUARMState *env, const ARMCPRegInfo *opaque); 1049 1050 /* 1051 * Return true if this reginfo struct's field in the cpu state struct 1052 * is 64 bits wide. 1053 */ 1054 static inline bool cpreg_field_is_64bit(const ARMCPRegInfo *ri) 1055 { 1056 return (ri->state == ARM_CP_STATE_AA64) || (ri->type & ARM_CP_64BIT); 1057 } 1058 1059 static inline bool cp_access_ok(int current_el, 1060 const ARMCPRegInfo *ri, int isread) 1061 { 1062 return (ri->access >> ((current_el * 2) + isread)) & 1; 1063 } 1064 1065 /* Raw read of a coprocessor register (as needed for migration, etc) */ 1066 uint64_t read_raw_cp_reg(CPUARMState *env, const ARMCPRegInfo *ri); 1067 1068 /* 1069 * Return true if the cp register encoding is in the "feature ID space" as 1070 * defined by FEAT_IDST (and thus should be reported with ER_ELx.EC 1071 * as EC_SYSTEMREGISTERTRAP rather than EC_UNCATEGORIZED). 1072 */ 1073 static inline bool arm_cpreg_encoding_in_idspace(uint8_t opc0, uint8_t opc1, 1074 uint8_t opc2, 1075 uint8_t crn, uint8_t crm) 1076 { 1077 return opc0 == 3 && (opc1 == 0 || opc1 == 1 || opc1 == 3) && 1078 crn == 0 && crm < 8; 1079 } 1080 1081 /* 1082 * As arm_cpreg_encoding_in_idspace(), but take the encoding from an 1083 * ARMCPRegInfo. 1084 */ 1085 static inline bool arm_cpreg_in_idspace(const ARMCPRegInfo *ri) 1086 { 1087 return ri->state == ARM_CP_STATE_AA64 && 1088 arm_cpreg_encoding_in_idspace(ri->opc0, ri->opc1, ri->opc2, 1089 ri->crn, ri->crm); 1090 } 1091 1092 #ifdef CONFIG_USER_ONLY 1093 static inline void define_cortex_a72_a57_a53_cp_reginfo(ARMCPU *cpu) { } 1094 #else 1095 void define_cortex_a72_a57_a53_cp_reginfo(ARMCPU *cpu); 1096 #endif 1097 1098 CPAccessResult access_tvm_trvm(CPUARMState *, const ARMCPRegInfo *, bool); 1099 1100 /** 1101 * arm_cpreg_trap_in_nv: Return true if cpreg traps in nested virtualization 1102 * 1103 * Return true if this cpreg is one which should be trapped to EL2 if 1104 * it is executed at EL1 when nested virtualization is enabled via HCR_EL2.NV. 1105 */ 1106 static inline bool arm_cpreg_traps_in_nv(const ARMCPRegInfo *ri) 1107 { 1108 /* 1109 * The Arm ARM defines the registers to be trapped in terms of 1110 * their names (I_TZTZL). However the underlying principle is "if 1111 * it would UNDEF at EL1 but work at EL2 then it should trap", and 1112 * the way the encoding of sysregs and system instructions is done 1113 * means that the right set of registers is exactly those where 1114 * the opc1 field is 4 or 5. (You can see this also in the assert 1115 * we do that the opc1 field and the permissions mask line up in 1116 * define_one_arm_cp_reg_with_opaque().) 1117 * Checking the opc1 field is easier for us and avoids the problem 1118 * that we do not consistently use the right architectural names 1119 * for all sysregs, since we treat the name field as largely for debug. 1120 * 1121 * However we do this check, it is going to be at least potentially 1122 * fragile to future new sysregs, but this seems the least likely 1123 * to break. 1124 * 1125 * In particular, note that the released sysreg XML defines that 1126 * the FEAT_MEC sysregs and instructions do not follow this FEAT_NV 1127 * trapping rule, so we will need to add an ARM_CP_* flag to indicate 1128 * "register does not trap on NV" to handle those if/when we implement 1129 * FEAT_MEC. 1130 */ 1131 return ri->opc1 == 4 || ri->opc1 == 5; 1132 } 1133 1134 #endif /* TARGET_ARM_CPREGS_H */ 1135