cpu.h

Go to the documentation of this file.

/*
 * Copyright (c) 2019 Carlo Caione <ccaione@baylibre.com>
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_ARCH_ARM64_CPU_H_
#define ZEPHYR_INCLUDE_ARCH_ARM64_CPU_H_
 
#include <zephyr/sys/util_macro.h>
#include <stdbool.h>

 
#define DAIFSET_FIQ_BIT         BIT(0)
#define DAIFSET_IRQ_BIT         BIT(1)
#define DAIFSET_ABT_BIT         BIT(2)
#define DAIFSET_DBG_BIT         BIT(3)
 
#define DAIFCLR_FIQ_BIT         BIT(0)
#define DAIFCLR_IRQ_BIT         BIT(1)
#define DAIFCLR_ABT_BIT         BIT(2)
#define DAIFCLR_DBG_BIT         BIT(3)
 
#define DAIF_FIQ_BIT            BIT(6)
#define DAIF_IRQ_BIT            BIT(7)
#define DAIF_ABT_BIT            BIT(8)
#define DAIF_DBG_BIT            BIT(9)
 
#define SPSR_DAIF_SHIFT         (6)
#define SPSR_DAIF_MASK          (0xf << SPSR_DAIF_SHIFT)
 
#define SPSR_MODE_EL0T          (0x0)
#define SPSR_MODE_EL1T          (0x4)
#define SPSR_MODE_EL1H          (0x5)
#define SPSR_MODE_EL2T          (0x8)
#define SPSR_MODE_EL2H          (0x9)
#define SPSR_MODE_MASK          (0xf)
 
 
#define SCTLR_EL3_RES1          (BIT(29) | BIT(28) | BIT(23) | \
                                 BIT(22) | BIT(18) | BIT(16) | \
                                 BIT(11) | BIT(5)  | BIT(4))
 
#define SCTLR_EL2_RES1          (BIT(29) | BIT(28) | BIT(23) | \
                                 BIT(22) | BIT(18) | BIT(16) | \
                                 BIT(11) | BIT(5)  | BIT(4))
 
#define SCTLR_EL1_RES1          (BIT(29) | BIT(28) | BIT(23) | \
                                 BIT(22) | BIT(20) | BIT(11))
 
#define SCTLR_M_BIT             BIT(0)
#define SCTLR_A_BIT             BIT(1)
#define SCTLR_C_BIT             BIT(2)
#define SCTLR_SA_BIT            BIT(3)
#define SCTLR_I_BIT             BIT(12)
#define SCTLR_BR_BIT            BIT(17)
#define SCTLR_EnIA_BIT          BIT(31) /* Enable Instruction address signing using key A */
#define SCTLR_BT0_BIT           BIT(35) /* PAC Branch Type compatibility for EL0 */
#define SCTLR_BT1_BIT           BIT(36) /* PAC Branch Type compatibility for EL1 */
 
#define CPACR_EL1_FPEN          GENMASK(21, 20)
#define CPACR_EL1_ZEN           GENMASK(17, 16)
 
#define SCR_NS_BIT              BIT(0)
#define SCR_IRQ_BIT             BIT(1)
#define SCR_FIQ_BIT             BIT(2)
#define SCR_EA_BIT              BIT(3)
#define SCR_SMD_BIT             BIT(7)
#define SCR_HCE_BIT             BIT(8)
#define SCR_RW_BIT              BIT(10)
#define SCR_ST_BIT              BIT(11)
#define SCR_APK_BIT             BIT(16) /* Do not trap pointer authentication key accesses */
#define SCR_API_BIT             BIT(17) /* Do not trap pointer authentication instructions */
#define SCR_EEL2_BIT            BIT(18)
 
#define SCR_RES1                (BIT(4) | BIT(5))
 
/* MPIDR */
#define MPIDR_AFFLVL_MASK       (0xffULL)
 
#define MPIDR_AFF0_SHIFT        (0)
#define MPIDR_AFF1_SHIFT        (8)
#define MPIDR_AFF2_SHIFT        (16)
#define MPIDR_AFF3_SHIFT        (32)
 
#define MPIDR_AFF_MASK          (GENMASK(23, 0) | GENMASK(39, 32))
 
#define MPIDR_AFFLVL(mpidr, aff_level) \
                (((mpidr) >> MPIDR_AFF##aff_level##_SHIFT) & MPIDR_AFFLVL_MASK)
 
#define GET_MPIDR()             read_sysreg(mpidr_el1)
#define MPIDR_TO_CORE(mpidr)    (mpidr & MPIDR_AFF_MASK)
 
#define MODE_EL_SHIFT           (0x2)
#define MODE_EL_MASK            (0x3)
 
#define MODE_EL3                (0x3)
#define MODE_EL2                (0x2)
#define MODE_EL1                (0x1)
#define MODE_EL0                (0x0)
 
#define GET_EL(_mode)           (((_mode) >> MODE_EL_SHIFT) & MODE_EL_MASK)
 
#define ESR_EC_SHIFT            (26)
#define ESR_EC_MASK             BIT_MASK(6)
#define ESR_ISS_SHIFT           (0)
#define ESR_ISS_MASK            BIT_MASK(25)
#define ESR_IL_SHIFT            (25)
#define ESR_IL_MASK             BIT_MASK(1)
 
#define GET_ESR_EC(esr)         (((esr) >> ESR_EC_SHIFT) & ESR_EC_MASK)
#define GET_ESR_IL(esr)         (((esr) >> ESR_IL_SHIFT) & ESR_IL_MASK)
#define GET_ESR_ISS(esr)        (((esr) >> ESR_ISS_SHIFT) & ESR_ISS_MASK)
 
#define CNTV_CTL_ENABLE_BIT     BIT(0)
#define CNTV_CTL_IMASK_BIT      BIT(1)
 
#define ID_AA64PFR0_EL0_SHIFT   (0)
#define ID_AA64PFR0_EL1_SHIFT   (4)
#define ID_AA64PFR0_EL2_SHIFT   (8)
#define ID_AA64PFR0_EL3_SHIFT   (12)
#define ID_AA64PFR0_ELX_MASK    (0xf)
#define ID_AA64PFR0_FP_SHIFT    (16)
#define ID_AA64PFR0_FP_MASK     (0xf)
#define ID_AA64PFR0_ADVSIMD_SHIFT       (20)
#define ID_AA64PFR0_ADVSIMD_MASK        (0xf)
#define ID_AA64PFR0_SVE_SHIFT   (32)
#define ID_AA64PFR0_SVE_MASK    (0xf)
#define ID_AA64PFR0_SEL2_SHIFT  (36)
#define ID_AA64PFR0_SEL2_MASK   (0xf)
 
/*
 * TODO: ACTLR is of class implementation defined. All core implementations
 * in armv8a have the same implementation so far w.r.t few controls.
 * When there will be differences we have to create core specific headers.
 */
#define ACTLR_EL3_CPUACTLR_BIT  BIT(0)
#define ACTLR_EL3_CPUECTLR_BIT  BIT(1)
#define ACTLR_EL3_L2CTLR_BIT    BIT(4)
#define ACTLR_EL3_L2ECTLR_BIT   BIT(5)
#define ACTLR_EL3_L2ACTLR_BIT   BIT(6)
 
#define CPTR_EZ_BIT             BIT(8)
#define CPTR_TFP_BIT            BIT(10)
#define CPTR_TTA_BIT            BIT(20)
#define CPTR_TCPAC_BIT          BIT(31)
 
/* SVE-specific CPTR_EL2 bits */
#define CPTR_EL2_TZ_BIT         BIT(8)
#define CPTR_EL2_ZEN_SHIFT      16
#define CPTR_EL2_ZEN_MASK       (0x3 << CPTR_EL2_ZEN_SHIFT)
#define CPTR_EL2_ZEN_EL1_EN     BIT(16)
#define CPTR_EL2_ZEN_EL0_EN     BIT(17)
 
#define CPTR_EL2_RES1           BIT(13) | BIT(12) | BIT(9) | (0xff)
 
/* SVE Control Register (ZCR) */
#define ZCR_EL1                 S3_0_C1_C2_0
#define ZCR_EL2                 S3_4_C1_C2_0
#define ZCR_EL3                 S3_6_C1_C2_0
 
#define HCR_FMO_BIT             BIT(3)
#define HCR_IMO_BIT             BIT(4)
#define HCR_AMO_BIT             BIT(5)
#define HCR_TGE_BIT             BIT(27)
#define HCR_RW_BIT              BIT(31)
#define HCR_APK_BIT             BIT(40) /* Trap pointer authentication key registers */
#define HCR_API_BIT             BIT(41) /* Trap pointer authentication instructions */
 
/* PAC Key Registers - System register encodings */
#define APIAKeyLo_EL1           S3_0_C2_C1_0
#define APIAKeyHi_EL1           S3_0_C2_C1_1
#define APIBKeyLo_EL1           S3_0_C2_C1_2
#define APIBKeyHi_EL1           S3_0_C2_C1_3
#define APDAKeyLo_EL1           S3_0_C2_C2_0
#define APDAKeyHi_EL1           S3_0_C2_C2_1
#define APDBKeyLo_EL1           S3_0_C2_C2_2
#define APDBKeyHi_EL1           S3_0_C2_C2_3
#define APGAKeyLo_EL1           S3_0_C2_C3_0
#define APGAKeyHi_EL1           S3_0_C2_C3_1
 
/* System register interface to GICv3 */
#define ICC_IGRPEN1_EL1         S3_0_C12_C12_7
#define ICC_SGI1R               S3_0_C12_C11_5
#define ICC_SRE_EL1             S3_0_C12_C12_5
#define ICC_SRE_EL2             S3_4_C12_C9_5
#define ICC_SRE_EL3             S3_6_C12_C12_5
#define ICC_CTLR_EL1            S3_0_C12_C12_4
#define ICC_CTLR_EL3            S3_6_C12_C12_4
#define ICC_PMR_EL1             S3_0_C4_C6_0
#define ICC_RPR_EL1             S3_0_C12_C11_3
#define ICC_IGRPEN1_EL3         S3_6_C12_C12_7
#define ICC_IGRPEN0_EL1         S3_0_C12_C12_6
#define ICC_HPPIR0_EL1          S3_0_C12_C8_2
#define ICC_HPPIR1_EL1          S3_0_C12_C12_2
#define ICC_IAR0_EL1            S3_0_C12_C8_0
#define ICC_IAR1_EL1            S3_0_C12_C12_0
#define ICC_EOIR0_EL1           S3_0_C12_C8_1
#define ICC_EOIR1_EL1           S3_0_C12_C12_1
#define ICC_SGI0R_EL1           S3_0_C12_C11_7
 
/* register constants */
#define ICC_SRE_ELx_SRE_BIT     BIT(0)
#define ICC_SRE_ELx_DFB_BIT     BIT(1)
#define ICC_SRE_ELx_DIB_BIT     BIT(2)
#define ICC_SRE_ELx_EN_BIT      BIT(3) 
 
/* ICC SGI macros */
#define SGIR_TGT_MASK           (0xffff)
#define SGIR_AFF1_SHIFT         (16)
#define SGIR_AFF2_SHIFT         (32)
#define SGIR_AFF3_SHIFT         (48)
#define SGIR_AFF_MASK           (0xff)
#define SGIR_INTID_SHIFT        (24)
#define SGIR_INTID_MASK         (0xf)
#define SGIR_IRM_SHIFT          (40)
#define SGIR_IRM_MASK           (0x1)
#define SGIR_IRM_TO_AFF         (0)
 
#define GICV3_SGIR_VALUE(_aff3, _aff2, _aff1, _intid, _irm, _tgt)       \
        ((((uint64_t) (_aff3) & SGIR_AFF_MASK) << SGIR_AFF3_SHIFT) |    \
         (((uint64_t) (_irm) & SGIR_IRM_MASK) << SGIR_IRM_SHIFT) |      \
         (((uint64_t) (_aff2) & SGIR_AFF_MASK) << SGIR_AFF2_SHIFT) |    \
         (((_intid) & SGIR_INTID_MASK) << SGIR_INTID_SHIFT) |           \
         (((_aff1) & SGIR_AFF_MASK) << SGIR_AFF1_SHIFT) |               \
         ((_tgt) & SGIR_TGT_MASK))
 
/* Implementation defined register definitions */
#if defined(CONFIG_CPU_CORTEX_A72)
 
#define CORTEX_A72_L2CTLR_EL1                           S3_1_C11_C0_2
#define CORTEX_A72_L2CTLR_DATA_RAM_LATENCY_SHIFT        (0)
#define CORTEX_A72_L2CTLR_DATA_RAM_SETUP_SHIFT          (5)
#define CORTEX_A72_L2CTLR_TAG_RAM_LATENCY_SHIFT         (6)
#define CORTEX_A72_L2CTLR_TAG_RAM_SETUP_SHIFT           (9)
 
#define CORTEX_A72_L2_DATA_RAM_LATENCY_3_CYCLES         (2)
#define CORTEX_A72_L2_DATA_RAM_LATENCY_MASK             (0x7)
#define CORTEX_A72_L2_DATA_RAM_SETUP_1_CYCLE            (1)
#define CORTEX_A72_L2_TAG_RAM_LATENCY_2_CYCLES          (1)
#define CORTEX_A72_L2_TAG_RAM_LATENCY_3_CYCLES          (2)
#define CORTEX_A72_L2_TAG_RAM_LATENCY_MASK              (0x7)
#define CORTEX_A72_L2_TAG_RAM_SETUP_1_CYCLE             (1)
 
#define CORTEX_A72_L2ACTLR_EL1                          S3_1_C15_C0_0
#define CORTEX_A72_L2ACTLR_DISABLE_ACE_SH_OR_CHI_BIT    BIT(6)
 
#endif /* CONFIG_CPU_CORTEX_A72 */
 
#define L1_CACHE_SHIFT          (6)
#define L1_CACHE_BYTES          BIT(L1_CACHE_SHIFT)
#define ARM64_CPU_INIT_SIZE     L1_CACHE_BYTES

 
#endif /* ZEPHYR_INCLUDE_ARCH_ARM64_CPU_H_ */