1 /* SPDX-License-Identifier: BSD-2-Clause */ 2 /* 3 * Copyright (c) 2015, Linaro Limited 4 * Copyright (c) 2023, Arm Limited 5 */ 6 #ifndef ARM64_H 7 #define ARM64_H 8 9 #include <compiler.h> 10 #include <sys/cdefs.h> 11 #include <stdint.h> 12 #include <util.h> 13 14 #define SCTLR_M BIT64(0) 15 #define SCTLR_A BIT64(1) 16 #define SCTLR_C BIT64(2) 17 #define SCTLR_SA BIT64(3) 18 #define SCTLR_I BIT64(12) 19 #define SCTLR_ENDB BIT64(13) 20 #define SCTLR_WXN BIT64(19) 21 #define SCTLR_SPAN BIT64(23) 22 #define SCTLR_ENDA BIT64(27) 23 #define SCTLR_ENIB BIT64(30) 24 #define SCTLR_ENIA BIT64(31) 25 #define SCTLR_BT0 BIT64(35) 26 #define SCTLR_BT1 BIT64(36) 27 #define SCTLR_ITFSB BIT64(37) 28 29 #define SCTLR_TCF_MASK SHIFT_U64(0x3, 40) 30 #define SCTLR_TCF_NONE SHIFT_U64(0x0, 40) 31 #define SCTLR_TCF_SYNC SHIFT_U64(0x1, 40) 32 #define SCTLR_TCF_ASYNC SHIFT_U64(0x2, 40) 33 #define SCTLR_TCF_ASYMM SHIFT_U64(0x3, 40) 34 35 #define SCTLR_TCF0_MASK SHIFT_U64(0x3, 38) 36 #define SCTLR_TCF0_NONE SHIFT_U64(0x0, 38) 37 #define SCTLR_TCF0_SYNC SHIFT_U64(0x1, 38) 38 #define SCTLR_TCF0_ASYNC SHIFT_U64(0x2, 38) 39 #define SCTLR_TCF0_ASYMM SHIFT_U64(0x3, 38) 40 41 #define SCTLR_ATA0 BIT64(42) 42 #define SCTLR_ATA BIT64(43) 43 44 #define TTBR_ASID_MASK U(0xff) 45 #define TTBR_ASID_SHIFT U(48) 46 47 #define CLIDR_LOUIS_SHIFT U(21) 48 #define CLIDR_LOC_SHIFT U(24) 49 #define CLIDR_FIELD_WIDTH U(3) 50 51 #define CSSELR_LEVEL_SHIFT U(1) 52 53 #define DAIFBIT_FIQ BIT32(0) 54 #define DAIFBIT_IRQ BIT32(1) 55 #define DAIFBIT_ABT BIT32(2) 56 #define DAIFBIT_DBG BIT32(3) 57 #define DAIFBIT_ALL (DAIFBIT_FIQ | DAIFBIT_IRQ | \ 58 DAIFBIT_ABT | DAIFBIT_DBG) 59 60 #define DAIF_F_SHIFT U(6) 61 #define DAIF_F BIT32(6) 62 #define DAIF_I BIT32(7) 63 #define DAIF_A BIT32(8) 64 #define DAIF_D BIT32(9) 65 #define DAIF_AIF (DAIF_A | DAIF_I | DAIF_F) 66 67 #define SPSR_MODE_RW_SHIFT U(4) 68 #define SPSR_MODE_RW_MASK U(0x1) 69 #define SPSR_MODE_RW_64 U(0x0) 70 #define SPSR_MODE_RW_32 U(0x1) 71 72 #define SPSR_64_MODE_SP_SHIFT U(0) 73 #define SPSR_64_MODE_SP_MASK U(0x1) 74 #define SPSR_64_MODE_SP_EL0 U(0x0) 75 #define SPSR_64_MODE_SP_ELX U(0x1) 76 77 #define SPSR_64_MODE_EL_SHIFT U(2) 78 #define SPSR_64_MODE_EL_MASK U(0x3) 79 #define SPSR_64_MODE_EL1 U(0x1) 80 #define SPSR_64_MODE_EL0 U(0x0) 81 82 #define SPSR_64_DAIF_SHIFT U(6) 83 #define SPSR_64_DAIF_MASK U(0xf) 84 85 #define SPSR_32_AIF_SHIFT U(6) 86 #define SPSR_32_AIF_MASK U(0x7) 87 88 #define SPSR_32_E_SHIFT U(9) 89 #define SPSR_32_E_MASK U(0x1) 90 #define SPSR_32_E_LITTLE U(0x0) 91 #define SPSR_32_E_BIG U(0x1) 92 93 #define SPSR_32_T_SHIFT U(5) 94 #define SPSR_32_T_MASK U(0x1) 95 #define SPSR_32_T_ARM U(0x0) 96 #define SPSR_32_T_THUMB U(0x1) 97 98 #define SPSR_32_MODE_SHIFT U(0) 99 #define SPSR_32_MODE_MASK U(0xf) 100 #define SPSR_32_MODE_USR U(0x0) 101 102 103 #define SPSR_64(el, sp, daif) \ 104 (SPSR_MODE_RW_64 << SPSR_MODE_RW_SHIFT | \ 105 ((el) & SPSR_64_MODE_EL_MASK) << SPSR_64_MODE_EL_SHIFT | \ 106 ((sp) & SPSR_64_MODE_SP_MASK) << SPSR_64_MODE_SP_SHIFT | \ 107 ((daif) & SPSR_64_DAIF_MASK) << SPSR_64_DAIF_SHIFT) 108 109 #define SPSR_32(mode, isa, aif) \ 110 (SPSR_MODE_RW_32 << SPSR_MODE_RW_SHIFT | \ 111 SPSR_32_E_LITTLE << SPSR_32_E_SHIFT | \ 112 ((mode) & SPSR_32_MODE_MASK) << SPSR_32_MODE_SHIFT | \ 113 ((isa) & SPSR_32_T_MASK) << SPSR_32_T_SHIFT | \ 114 ((aif) & SPSR_32_AIF_MASK) << SPSR_32_AIF_SHIFT) 115 116 117 #define TCR_T0SZ_SHIFT U(0) 118 #define TCR_EPD0 BIT64(7) 119 #define TCR_IRGN0_SHIFT U(8) 120 #define TCR_ORGN0_SHIFT U(10) 121 #define TCR_SH0_SHIFT U(12) 122 #define TCR_T1SZ_SHIFT U(16) 123 #define TCR_A1 BIT64(22) 124 #define TCR_EPD1 BIT64(23) 125 #define TCR_IRGN1_SHIFT U(24) 126 #define TCR_ORGN1_SHIFT U(26) 127 #define TCR_SH1_SHIFT U(28) 128 #define TCR_EL1_IPS_SHIFT U(32) 129 #define TCR_EL1_IPS_MASK UINT64_C(0x7) 130 #define TCR_TG1_4KB SHIFT_U64(2, 30) 131 #define TCR_RES1 BIT64(31) 132 #define TCR_TBI0 BIT64(37) 133 #define TCR_TBI1 BIT64(38) 134 #define TCR_TCMA0 BIT64(57) 135 #define TCR_TCMA1 BIT64(58) 136 137 138 /* Normal memory, Inner/Outer Non-cacheable */ 139 #define TCR_XRGNX_NC U(0x0) 140 /* Normal memory, Inner/Outer Write-Back Write-Allocate Cacheable */ 141 #define TCR_XRGNX_WB U(0x1) 142 /* Normal memory, Inner/Outer Write-Through Cacheable */ 143 #define TCR_XRGNX_WT U(0x2) 144 /* Normal memory, Inner/Outer Write-Back no Write-Allocate Cacheable */ 145 #define TCR_XRGNX_WBWA U(0x3) 146 147 /* Non-shareable */ 148 #define TCR_SHX_NSH U(0x0) 149 /* Outer Shareable */ 150 #define TCR_SHX_OSH U(0x2) 151 /* Inner Shareable */ 152 #define TCR_SHX_ISH U(0x3) 153 154 #define ESR_EC_SHIFT U(26) 155 #define ESR_EC_MASK U(0x3f) 156 157 #define ESR_EC_UNKNOWN U(0x00) 158 #define ESR_EC_WFI U(0x01) 159 #define ESR_EC_AARCH32_CP15_32 U(0x03) 160 #define ESR_EC_AARCH32_CP15_64 U(0x04) 161 #define ESR_EC_AARCH32_CP14_MR U(0x05) 162 #define ESR_EC_AARCH32_CP14_LS U(0x06) 163 #define ESR_EC_FP_ASIMD U(0x07) 164 #define ESR_EC_AARCH32_CP10_ID U(0x08) 165 #define ESR_EC_PAUTH U(0x09) 166 #define ESR_EC_AARCH32_CP14_64 U(0x0c) 167 #define ESR_EC_BTI U(0x0d) 168 #define ESR_EC_ILLEGAL U(0x0e) 169 #define ESR_EC_AARCH32_SVC U(0x11) 170 #define ESR_EC_AARCH64_SVC U(0x15) 171 #define ESR_EC_AARCH64_SYS U(0x18) 172 #define ESR_EC_ERET U(0x1a) 173 #define ESR_EC_FPAC U(0x1c) 174 #define ESR_EC_IABT_EL0 U(0x20) 175 #define ESR_EC_IABT_EL1 U(0x21) 176 #define ESR_EC_PC_ALIGN U(0x22) 177 #define ESR_EC_DABT_EL0 U(0x24) 178 #define ESR_EC_DABT_EL1 U(0x25) 179 #define ESR_EC_SP_ALIGN U(0x26) 180 #define ESR_EC_AARCH32_FP U(0x28) 181 #define ESR_EC_AARCH64_FP U(0x2c) 182 #define ESR_EC_SERROR U(0x2f) 183 #define ESR_EC_BREAKPT_EL0 U(0x30) 184 #define ESR_EC_BREAKPT_EL1 U(0x31) 185 #define ESR_EC_SOFTSTP_EL0 U(0x32) 186 #define ESR_EC_SOFTSTP_EL1 U(0x33) 187 #define ESR_EC_WATCHPT_EL0 U(0x34) 188 #define ESR_EC_WATCHPT_EL1 U(0x35) 189 #define ESR_EC_AARCH32_BKPT U(0x38) 190 #define ESR_EC_AARCH64_BRK U(0x3c) 191 192 /* Combined defines for DFSC and IFSC */ 193 #define ESR_FSC_MASK U(0x3f) 194 #define ESR_FSC_SIZE_L0 U(0x00) 195 #define ESR_FSC_SIZE_L1 U(0x01) 196 #define ESR_FSC_SIZE_L2 U(0x02) 197 #define ESR_FSC_SIZE_L3 U(0x03) 198 #define ESR_FSC_TRANS_L0 U(0x04) 199 #define ESR_FSC_TRANS_L1 U(0x05) 200 #define ESR_FSC_TRANS_L2 U(0x06) 201 #define ESR_FSC_TRANS_L3 U(0x07) 202 #define ESR_FSC_ACCF_L1 U(0x09) 203 #define ESR_FSC_ACCF_L2 U(0x0a) 204 #define ESR_FSC_ACCF_L3 U(0x0b) 205 #define ESR_FSC_PERMF_L1 U(0x0d) 206 #define ESR_FSC_PERMF_L2 U(0x0e) 207 #define ESR_FSC_PERMF_L3 U(0x0f) 208 #define ESR_FSC_TAG_CHECK U(0x11) 209 #define ESR_FSC_ALIGN U(0x21) 210 211 /* WnR for DABT and RES0 for IABT */ 212 #define ESR_ABT_WNR BIT32(6) 213 214 #define CPACR_EL1_FPEN_SHIFT U(20) 215 #define CPACR_EL1_FPEN_MASK U(0x3) 216 #define CPACR_EL1_FPEN_NONE U(0x0) 217 #define CPACR_EL1_FPEN_EL1 U(0x1) 218 #define CPACR_EL1_FPEN_EL0EL1 U(0x3) 219 #define CPACR_EL1_FPEN(x) ((x) >> CPACR_EL1_FPEN_SHIFT \ 220 & CPACR_EL1_FPEN_MASK) 221 222 223 #define PAR_F BIT32(0) 224 #define PAR_PA_SHIFT U(12) 225 #define PAR_PA_MASK (BIT64(36) - 1) 226 227 #define TLBI_VA_SHIFT U(12) 228 #define TLBI_ASID_SHIFT U(48) 229 #define TLBI_ASID_MASK U(0xff) 230 231 #define ID_AA64PFR1_EL1_BT_MASK ULL(0xf) 232 #define FEAT_BTI_IMPLEMENTED ULL(0x1) 233 234 #define ID_AA64PFR1_EL1_MTE_MASK UL(0xf) 235 #define ID_AA64PFR1_EL1_MTE_SHIFT U(8) 236 #define FEAT_MTE_NOT_IMPLEMENTED U(0x0) 237 #define FEAT_MTE_IMPLEMENTED U(0x1) 238 #define FEAT_MTE2_IMPLEMENTED U(0x2) 239 #define FEAT_MTE3_IMPLEMENTED U(0x3) 240 241 #define ID_AA64ISAR0_EL1_CRC32_MASK UL(0xf) 242 #define ID_AA64ISAR0_EL1_CRC32_SHIFT U(16) 243 #define FEAT_CRC32_NOT_IMPLEMENTED U(0x0) 244 #define FEAT_CRC32_IMPLEMENTED U(0x1) 245 246 #define ID_AA64ISAR1_GPI_SHIFT U(28) 247 #define ID_AA64ISAR1_GPI_MASK U(0xf) 248 #define ID_AA64ISAR1_GPI_NI U(0x0) 249 #define ID_AA64ISAR1_GPI_IMP_DEF U(0x1) 250 251 #define ID_AA64ISAR1_GPA_SHIFT U(24) 252 #define ID_AA64ISAR1_GPA_MASK U(0xf) 253 #define ID_AA64ISAR1_GPA_NI U(0x0) 254 #define ID_AA64ISAR1_GPA_ARCHITECTED U(0x1) 255 256 #define ID_AA64ISAR1_API_SHIFT U(8) 257 #define ID_AA64ISAR1_API_MASK U(0xf) 258 #define ID_AA64ISAR1_API_NI U(0x0) 259 #define ID_AA64ISAR1_API_IMP_DEF U(0x1) 260 #define ID_AA64ISAR1_API_IMP_DEF_EPAC U(0x2) 261 #define ID_AA64ISAR1_API_IMP_DEF_EPAC2 U(0x3) 262 #define ID_AA64ISAR1_API_IMP_DEF_EPAC2_FPAC U(0x4) 263 #define ID_AA64ISAR1_API_IMP_DEF_EPAC2_FPAC_CMB U(0x5) 264 265 #define ID_AA64ISAR1_APA_SHIFT U(4) 266 #define ID_AA64ISAR1_APA_MASK U(0xf) 267 #define ID_AA64ISAR1_APA_NI U(0x0) 268 #define ID_AA64ISAR1_APA_ARCHITECTED U(0x1) 269 #define ID_AA64ISAR1_APA_ARCH_EPAC U(0x2) 270 #define ID_AA64ISAR1_APA_ARCH_EPAC2 U(0x3) 271 #define ID_AA64ISAR1_APA_ARCH_EPAC2_FPAC U(0x4) 272 #define ID_AA64ISAR1_APA_ARCH_EPAC2_FPAC_CMB U(0x5) 273 274 #define GCR_EL1_RRND BIT64(16) 275 276 #ifndef __ASSEMBLER__ 277 static inline __noprof void isb(void) 278 { 279 asm volatile ("isb" : : : "memory"); 280 } 281 282 static inline __noprof void dsb(void) 283 { 284 asm volatile ("dsb sy" : : : "memory"); 285 } 286 287 static inline __noprof void dsb_ish(void) 288 { 289 asm volatile ("dsb ish" : : : "memory"); 290 } 291 292 static inline __noprof void dsb_ishst(void) 293 { 294 asm volatile ("dsb ishst" : : : "memory"); 295 } 296 297 static inline __noprof void sev(void) 298 { 299 asm volatile ("sev" : : : "memory"); 300 } 301 302 static inline __noprof void wfe(void) 303 { 304 asm volatile ("wfe" : : : "memory"); 305 } 306 307 static inline __noprof void wfi(void) 308 { 309 asm volatile ("wfi" : : : "memory"); 310 } 311 312 static inline __noprof void write_at_s1e1r(uint64_t va) 313 { 314 asm volatile ("at S1E1R, %0" : : "r" (va)); 315 } 316 317 static __always_inline __noprof uint64_t read_pc(void) 318 { 319 uint64_t val; 320 321 asm volatile ("adr %0, ." : "=r" (val)); 322 return val; 323 } 324 325 static __always_inline __noprof uint64_t read_fp(void) 326 { 327 uint64_t val; 328 329 asm volatile ("mov %0, x29" : "=r" (val)); 330 return val; 331 } 332 333 static inline __noprof uint64_t read_pmu_ccnt(void) 334 { 335 uint64_t val; 336 337 asm volatile("mrs %0, PMCCNTR_EL0" : "=r"(val)); 338 return val; 339 } 340 341 static inline __noprof void tlbi_vaae1is(uint64_t va) 342 { 343 asm volatile ("tlbi vaae1is, %0" : : "r" (va)); 344 } 345 346 static inline __noprof void tlbi_vale1is(uint64_t va) 347 { 348 asm volatile ("tlbi vale1is, %0" : : "r" (va)); 349 } 350 351 /* 352 * Templates for register read/write functions based on mrs/msr 353 */ 354 355 #define DEFINE_REG_READ_FUNC_(reg, type, asmreg) \ 356 static inline __noprof type read_##reg(void) \ 357 { \ 358 uint64_t val64 = 0; \ 359 \ 360 asm volatile("mrs %0, " #asmreg : "=r" (val64)); \ 361 return val64; \ 362 } 363 364 #define DEFINE_REG_WRITE_FUNC_(reg, type, asmreg) \ 365 static inline __noprof void write_##reg(type val) \ 366 { \ 367 uint64_t val64 = val; \ 368 \ 369 asm volatile("msr " #asmreg ", %0" : : "r" (val64)); \ 370 } 371 372 #define DEFINE_U32_REG_READ_FUNC(reg) \ 373 DEFINE_REG_READ_FUNC_(reg, uint32_t, reg) 374 375 #define DEFINE_U32_REG_WRITE_FUNC(reg) \ 376 DEFINE_REG_WRITE_FUNC_(reg, uint32_t, reg) 377 378 #define DEFINE_U32_REG_READWRITE_FUNCS(reg) \ 379 DEFINE_U32_REG_READ_FUNC(reg) \ 380 DEFINE_U32_REG_WRITE_FUNC(reg) 381 382 #define DEFINE_U64_REG_READ_FUNC(reg) \ 383 DEFINE_REG_READ_FUNC_(reg, uint64_t, reg) 384 385 #define DEFINE_U64_REG_WRITE_FUNC(reg) \ 386 DEFINE_REG_WRITE_FUNC_(reg, uint64_t, reg) 387 388 #define DEFINE_U64_REG_READWRITE_FUNCS(reg) \ 389 DEFINE_U64_REG_READ_FUNC(reg) \ 390 DEFINE_U64_REG_WRITE_FUNC(reg) 391 392 /* 393 * Define register access functions 394 */ 395 396 DEFINE_U32_REG_READWRITE_FUNCS(cpacr_el1) 397 DEFINE_U32_REG_READWRITE_FUNCS(daif) 398 DEFINE_U32_REG_READWRITE_FUNCS(fpcr) 399 DEFINE_U32_REG_READWRITE_FUNCS(fpsr) 400 401 DEFINE_U32_REG_READ_FUNC(ctr_el0) 402 #define read_ctr() read_ctr_el0() 403 DEFINE_U32_REG_READ_FUNC(contextidr_el1) 404 DEFINE_U64_REG_READ_FUNC(sctlr_el1) 405 406 /* ARM Generic timer functions */ 407 DEFINE_REG_READ_FUNC_(cntfrq, uint32_t, cntfrq_el0) 408 DEFINE_REG_READ_FUNC_(cntvct, uint64_t, cntvct_el0) 409 DEFINE_REG_READ_FUNC_(cntpct, uint64_t, cntpct_el0) 410 DEFINE_REG_READ_FUNC_(cntkctl, uint32_t, cntkctl_el1) 411 DEFINE_REG_WRITE_FUNC_(cntkctl, uint32_t, cntkctl_el1) 412 DEFINE_REG_READ_FUNC_(cntps_ctl, uint32_t, cntps_ctl_el1) 413 DEFINE_REG_WRITE_FUNC_(cntps_ctl, uint32_t, cntps_ctl_el1) 414 DEFINE_REG_READ_FUNC_(cntps_tval, uint32_t, cntps_tval_el1) 415 DEFINE_REG_WRITE_FUNC_(cntps_tval, uint32_t, cntps_tval_el1) 416 417 DEFINE_REG_READ_FUNC_(pmccntr, uint64_t, pmccntr_el0) 418 419 DEFINE_U64_REG_READWRITE_FUNCS(ttbr0_el1) 420 DEFINE_U64_REG_READWRITE_FUNCS(ttbr1_el1) 421 DEFINE_U64_REG_READWRITE_FUNCS(tcr_el1) 422 423 DEFINE_U64_REG_READ_FUNC(esr_el1) 424 DEFINE_U64_REG_READ_FUNC(far_el1) 425 DEFINE_U64_REG_READ_FUNC(mpidr_el1) 426 /* Alias for reading this register to avoid ifdefs in code */ 427 #define read_mpidr() read_mpidr_el1() 428 DEFINE_U64_REG_READ_FUNC(midr_el1) 429 /* Alias for reading this register to avoid ifdefs in code */ 430 #define read_midr() read_midr_el1() 431 DEFINE_U64_REG_READ_FUNC(par_el1) 432 433 DEFINE_U64_REG_WRITE_FUNC(mair_el1) 434 435 DEFINE_U64_REG_READ_FUNC(id_aa64pfr1_el1) 436 DEFINE_U64_REG_READ_FUNC(id_aa64isar0_el1) 437 DEFINE_U64_REG_READ_FUNC(id_aa64isar1_el1) 438 DEFINE_REG_READ_FUNC_(apiakeylo, uint64_t, S3_0_c2_c1_0) 439 DEFINE_REG_READ_FUNC_(apiakeyhi, uint64_t, S3_0_c2_c1_1) 440 441 DEFINE_REG_WRITE_FUNC_(apibkeylo, uint64_t, S3_0_c2_c1_2) 442 DEFINE_REG_WRITE_FUNC_(apibkeyhi, uint64_t, S3_0_c2_c1_3) 443 444 DEFINE_REG_READ_FUNC_(apdakeylo, uint64_t, S3_0_c2_c2_0) 445 DEFINE_REG_READ_FUNC_(apdakeyhi, uint64_t, S3_0_c2_c2_1) 446 447 DEFINE_REG_WRITE_FUNC_(apdbkeylo, uint64_t, S3_0_c2_c2_2) 448 DEFINE_REG_WRITE_FUNC_(apdbkeyhi, uint64_t, S3_0_c2_c2_3) 449 450 DEFINE_REG_WRITE_FUNC_(apgakeylo, uint64_t, S3_0_c2_c3_0) 451 DEFINE_REG_WRITE_FUNC_(apgakeyhi, uint64_t, S3_0_c2_c3_1) 452 453 /* Register read/write functions for GICC registers by using system interface */ 454 DEFINE_REG_READ_FUNC_(icc_ctlr, uint32_t, S3_0_C12_C12_4) 455 DEFINE_REG_WRITE_FUNC_(icc_ctlr, uint32_t, S3_0_C12_C12_4) 456 DEFINE_REG_WRITE_FUNC_(icc_pmr, uint32_t, S3_0_C4_C6_0) 457 DEFINE_REG_READ_FUNC_(icc_iar0, uint32_t, S3_0_c12_c8_0) 458 DEFINE_REG_READ_FUNC_(icc_iar1, uint32_t, S3_0_c12_c12_0) 459 DEFINE_REG_WRITE_FUNC_(icc_eoir0, uint32_t, S3_0_c12_c8_1) 460 DEFINE_REG_WRITE_FUNC_(icc_eoir1, uint32_t, S3_0_c12_c12_1) 461 DEFINE_REG_WRITE_FUNC_(icc_igrpen0, uint32_t, S3_0_C12_C12_6) 462 DEFINE_REG_WRITE_FUNC_(icc_igrpen1, uint32_t, S3_0_C12_C12_7) 463 #endif /*__ASSEMBLER__*/ 464 465 #endif /*ARM64_H*/ 466 467