/* * Copyright (c) 2016-2017, ARM Limited and Contributors. All rights reserved. * * SPDX-License-Identifier: BSD-3-Clause */ #ifndef __ARCH_H__ #define __ARCH_H__ #include <utils_def.h> /******************************************************************************* * MIDR bit definitions ******************************************************************************/ #define MIDR_IMPL_MASK 0xff #define MIDR_IMPL_SHIFT 24 #define MIDR_VAR_SHIFT 20 #define MIDR_VAR_BITS 4 #define MIDR_REV_SHIFT 0 #define MIDR_REV_BITS 4 #define MIDR_PN_MASK 0xfff #define MIDR_PN_SHIFT 4 /******************************************************************************* * MPIDR macros ******************************************************************************/ #define MPIDR_MT_MASK (1 << 24) #define MPIDR_CPU_MASK MPIDR_AFFLVL_MASK #define MPIDR_CLUSTER_MASK (MPIDR_AFFLVL_MASK << MPIDR_AFFINITY_BITS) #define MPIDR_AFFINITY_BITS 8 #define MPIDR_AFFLVL_MASK 0xff #define MPIDR_AFFLVL_SHIFT 3 #define MPIDR_AFF0_SHIFT 0 #define MPIDR_AFF1_SHIFT 8 #define MPIDR_AFF2_SHIFT 16 #define MPIDR_AFFINITY_MASK 0x00ffffff #define MPIDR_AFFLVL0 0 #define MPIDR_AFFLVL1 1 #define MPIDR_AFFLVL2 2 #define MPIDR_AFFLVL0_VAL(mpidr) \ (((mpidr) >> MPIDR_AFF0_SHIFT) & MPIDR_AFFLVL_MASK) #define MPIDR_AFFLVL1_VAL(mpidr) \ (((mpidr) >> MPIDR_AFF1_SHIFT) & MPIDR_AFFLVL_MASK) #define MPIDR_AFFLVL2_VAL(mpidr) \ (((mpidr) >> MPIDR_AFF2_SHIFT) & MPIDR_AFFLVL_MASK) #define MPIDR_AFFLVL3_VAL(mpidr) 0 /* * The MPIDR_MAX_AFFLVL count starts from 0. Take care to * add one while using this macro to define array sizes. */ #define MPIDR_MAX_AFFLVL 2 /* Data Cache set/way op type defines */ #define DC_OP_ISW 0x0 #define DC_OP_CISW 0x1 #define DC_OP_CSW 0x2 /******************************************************************************* * Generic timer memory mapped registers & offsets ******************************************************************************/ #define CNTCR_OFF 0x000 #define CNTFID_OFF 0x020 #define CNTCR_EN (1 << 0) #define CNTCR_HDBG (1 << 1) #define CNTCR_FCREQ(x) ((x) << 8) /******************************************************************************* * System register bit definitions ******************************************************************************/ /* CLIDR definitions */ #define LOUIS_SHIFT 21 #define LOC_SHIFT 24 #define CLIDR_FIELD_WIDTH 3 /* CSSELR definitions */ #define LEVEL_SHIFT 1 /* ID_PFR1 definitions */ #define ID_PFR1_VIRTEXT_SHIFT 12 #define ID_PFR1_VIRTEXT_MASK 0xf #define GET_VIRT_EXT(id) (((id) >> ID_PFR1_VIRTEXT_SHIFT) \ & ID_PFR1_VIRTEXT_MASK) #define ID_PFR1_GIC_SHIFT 28 #define ID_PFR1_GIC_MASK 0xf /* SCTLR definitions */ #define SCTLR_RES1 ((1 << 23) | (1 << 22) | (1 << 11) | (1 << 4) | \ (1 << 3)) #define SCTLR_M_BIT (1 << 0) #define SCTLR_A_BIT (1 << 1) #define SCTLR_C_BIT (1 << 2) #define SCTLR_CP15BEN_BIT (1 << 5) #define SCTLR_ITD_BIT (1 << 7) #define SCTLR_I_BIT (1 << 12) #define SCTLR_V_BIT (1 << 13) #define SCTLR_NTWI_BIT (1 << 16) #define SCTLR_NTWE_BIT (1 << 18) #define SCTLR_WXN_BIT (1 << 19) #define SCTLR_UWXN_BIT (1 << 20) #define SCTLR_EE_BIT (1 << 25) #define SCTLR_TRE_BIT (1 << 28) #define SCTLR_AFE_BIT (1 << 29) #define SCTLR_TE_BIT (1 << 30) #define SCTLR_RESET_VAL (SCTLR_RES1 | SCTLR_NTWE_BIT | \ SCTLR_NTWI_BIT | SCTLR_CP15BEN_BIT) /* SDCR definitions */ #define SDCR_SPD(x) ((x) << 14) #define SDCR_SPD_LEGACY 0x0 #define SDCR_SPD_DISABLE 0x2 #define SDCR_SPD_ENABLE 0x3 #define SDCR_RESET_VAL 0x0 #if !ERROR_DEPRECATED #define SDCR_DEF_VAL SDCR_SPD(SDCR_SPD_DISABLE) #endif /* HSCTLR definitions */ #define HSCTLR_RES1 ((1 << 29) | (1 << 28) | (1 << 23) | (1 << 22) \ | (1 << 18) | (1 << 16) | (1 << 11) | (1 << 4) \ | (1 << 3)) #define HSCTLR_M_BIT (1 << 0) #define HSCTLR_A_BIT (1 << 1) #define HSCTLR_C_BIT (1 << 2) #define HSCTLR_CP15BEN_BIT (1 << 5) #define HSCTLR_ITD_BIT (1 << 7) #define HSCTLR_SED_BIT (1 << 8) #define HSCTLR_I_BIT (1 << 12) #define HSCTLR_WXN_BIT (1 << 19) #define HSCTLR_EE_BIT (1 << 25) #define HSCTLR_TE_BIT (1 << 30) /* CPACR definitions */ #define CPACR_FPEN(x) ((x) << 20) #define CPACR_FP_TRAP_PL0 0x1 #define CPACR_FP_TRAP_ALL 0x2 #define CPACR_FP_TRAP_NONE 0x3 /* SCR definitions */ #define SCR_TWE_BIT (1 << 13) #define SCR_TWI_BIT (1 << 12) #define SCR_SIF_BIT (1 << 9) #define SCR_HCE_BIT (1 << 8) #define SCR_SCD_BIT (1 << 7) #define SCR_NET_BIT (1 << 6) #define SCR_AW_BIT (1 << 5) #define SCR_FW_BIT (1 << 4) #define SCR_EA_BIT (1 << 3) #define SCR_FIQ_BIT (1 << 2) #define SCR_IRQ_BIT (1 << 1) #define SCR_NS_BIT (1 << 0) #define SCR_VALID_BIT_MASK 0x33ff #define SCR_RESET_VAL 0x0 #define GET_NS_BIT(scr) ((scr) & SCR_NS_BIT) /* HCR definitions */ #define HCR_AMO_BIT (1 << 5) #define HCR_IMO_BIT (1 << 4) #define HCR_FMO_BIT (1 << 3) #define HCR_RESET_VAL 0x0 /* CNTHCTL definitions */ #define CNTHCTL_RESET_VAL 0x0 #define PL1PCEN_BIT (1 << 1) #define PL1PCTEN_BIT (1 << 0) /* CNTKCTL definitions */ #define PL0PTEN_BIT (1 << 9) #define PL0VTEN_BIT (1 << 8) #define PL0PCTEN_BIT (1 << 0) #define PL0VCTEN_BIT (1 << 1) #define EVNTEN_BIT (1 << 2) #define EVNTDIR_BIT (1 << 3) #define EVNTI_SHIFT 4 #define EVNTI_MASK 0xf /* HCPTR definitions */ #define HCPTR_RES1 ((1 << 13) | (1<<12) | 0x3ff) #define TCPAC_BIT (1 << 31) #define TTA_BIT (1 << 20) #define TCP11_BIT (1 << 10) #define TCP10_BIT (1 << 10) #define HCPTR_RESET_VAL HCPTR_RES1 /* VTTBR defintions */ #define VTTBR_RESET_VAL ULL(0x0) #define VTTBR_VMID_MASK ULL(0xff) #define VTTBR_VMID_SHIFT 48 #define VTTBR_BADDR_MASK 0xffffffffffff #define VTTBR_BADDR_SHIFT 0 /* HDCR definitions */ #define HDCR_RESET_VAL 0x0 /* HSTR definitions */ #define HSTR_RESET_VAL 0x0 /* CNTHP_CTL definitions */ #define CNTHP_CTL_RESET_VAL 0x0 /* NASCR definitions */ #define NSASEDIS_BIT (1 << 15) #define NSTRCDIS_BIT (1 << 20) /* NOTE: correct typo in the definitions */ #if !ERROR_DEPRECATED #define NASCR_CP11_BIT (1 << 11) #define NASCR_CP10_BIT (1 << 10) #endif #define NSACR_CP11_BIT (1 << 11) #define NSACR_CP10_BIT (1 << 10) #define NSACR_IMP_DEF_MASK (0x7 << 16) #define NSACR_ENABLE_FP_ACCESS (NSACR_CP11_BIT | NSACR_CP10_BIT) #define NSACR_RESET_VAL 0x0 /* CPACR definitions */ #define ASEDIS_BIT (1 << 31) #define TRCDIS_BIT (1 << 28) #define CPACR_CP11_SHIFT 22 #define CPACR_CP10_SHIFT 20 #define CPACR_ENABLE_FP_ACCESS (0x3 << CPACR_CP11_SHIFT |\ 0x3 << CPACR_CP10_SHIFT) #define CPACR_RESET_VAL 0x0 /* FPEXC definitions */ #define FPEXC_RES1 ((1 << 10) | (1 << 9) | (1 << 8)) #define FPEXC_EN_BIT (1 << 30) #define FPEXC_RESET_VAL FPEXC_RES1 /* SPSR/CPSR definitions */ #define SPSR_FIQ_BIT (1 << 0) #define SPSR_IRQ_BIT (1 << 1) #define SPSR_ABT_BIT (1 << 2) #define SPSR_AIF_SHIFT 6 #define SPSR_AIF_MASK 0x7 #define SPSR_E_SHIFT 9 #define SPSR_E_MASK 0x1 #define SPSR_E_LITTLE 0 #define SPSR_E_BIG 1 #define SPSR_T_SHIFT 5 #define SPSR_T_MASK 0x1 #define SPSR_T_ARM 0 #define SPSR_T_THUMB 1 #define SPSR_MODE_SHIFT 0 #define SPSR_MODE_MASK 0x7 #define DISABLE_ALL_EXCEPTIONS \ (SPSR_FIQ_BIT | SPSR_IRQ_BIT | SPSR_ABT_BIT) /* * TTBCR definitions */ /* The ARM Trusted Firmware uses the long descriptor format */ #define TTBCR_EAE_BIT (1 << 31) #define TTBCR_SH1_NON_SHAREABLE (0x0 << 28) #define TTBCR_SH1_OUTER_SHAREABLE (0x2 << 28) #define TTBCR_SH1_INNER_SHAREABLE (0x3 << 28) #define TTBCR_RGN1_OUTER_NC (0x0 << 26) #define TTBCR_RGN1_OUTER_WBA (0x1 << 26) #define TTBCR_RGN1_OUTER_WT (0x2 << 26) #define TTBCR_RGN1_OUTER_WBNA (0x3 << 26) #define TTBCR_RGN1_INNER_NC (0x0 << 24) #define TTBCR_RGN1_INNER_WBA (0x1 << 24) #define TTBCR_RGN1_INNER_WT (0x2 << 24) #define TTBCR_RGN1_INNER_WBNA (0x3 << 24) #define TTBCR_EPD1_BIT (1 << 23) #define TTBCR_A1_BIT (1 << 22) #define TTBCR_T1SZ_SHIFT 16 #define TTBCR_T1SZ_MASK (0x7) #define TTBCR_TxSZ_MIN 0 #define TTBCR_TxSZ_MAX 7 #define TTBCR_SH0_NON_SHAREABLE (0x0 << 12) #define TTBCR_SH0_OUTER_SHAREABLE (0x2 << 12) #define TTBCR_SH0_INNER_SHAREABLE (0x3 << 12) #define TTBCR_RGN0_OUTER_NC (0x0 << 10) #define TTBCR_RGN0_OUTER_WBA (0x1 << 10) #define TTBCR_RGN0_OUTER_WT (0x2 << 10) #define TTBCR_RGN0_OUTER_WBNA (0x3 << 10) #define TTBCR_RGN0_INNER_NC (0x0 << 8) #define TTBCR_RGN0_INNER_WBA (0x1 << 8) #define TTBCR_RGN0_INNER_WT (0x2 << 8) #define TTBCR_RGN0_INNER_WBNA (0x3 << 8) #define TTBCR_EPD0_BIT (1 << 7) #define TTBCR_T0SZ_SHIFT 0 #define TTBCR_T0SZ_MASK (0x7) #define MODE_RW_SHIFT 0x4 #define MODE_RW_MASK 0x1 #define MODE_RW_32 0x1 #define MODE32_SHIFT 0 #define MODE32_MASK 0x1f #define MODE32_usr 0x10 #define MODE32_fiq 0x11 #define MODE32_irq 0x12 #define MODE32_svc 0x13 #define MODE32_mon 0x16 #define MODE32_abt 0x17 #define MODE32_hyp 0x1a #define MODE32_und 0x1b #define MODE32_sys 0x1f #define GET_M32(mode) (((mode) >> MODE32_SHIFT) & MODE32_MASK) #define SPSR_MODE32(mode, isa, endian, aif) \ (MODE_RW_32 << MODE_RW_SHIFT | \ ((mode) & MODE32_MASK) << MODE32_SHIFT | \ ((isa) & SPSR_T_MASK) << SPSR_T_SHIFT | \ ((endian) & SPSR_E_MASK) << SPSR_E_SHIFT | \ ((aif) & SPSR_AIF_MASK) << SPSR_AIF_SHIFT) /* * TTBR definitions */ #define TTBR_CNP_BIT 0x1 /* * CTR definitions */ #define CTR_CWG_SHIFT 24 #define CTR_CWG_MASK 0xf #define CTR_ERG_SHIFT 20 #define CTR_ERG_MASK 0xf #define CTR_DMINLINE_SHIFT 16 #define CTR_DMINLINE_WIDTH 4 #define CTR_DMINLINE_MASK ((1 << 4) - 1) #define CTR_L1IP_SHIFT 14 #define CTR_L1IP_MASK 0x3 #define CTR_IMINLINE_SHIFT 0 #define CTR_IMINLINE_MASK 0xf #define MAX_CACHE_LINE_SIZE 0x800 /* 2KB */ /* PMCR definitions */ #define PMCR_N_SHIFT 11 #define PMCR_N_MASK 0x1f #define PMCR_N_BITS (PMCR_N_MASK << PMCR_N_SHIFT) #define PMCR_LC_BIT (1 << 6) #define PMCR_DP_BIT (1 << 5) /******************************************************************************* * Definitions of register offsets, fields and macros for CPU system * instructions. ******************************************************************************/ #define TLBI_ADDR_SHIFT 0 #define TLBI_ADDR_MASK 0xFFFFF000 #define TLBI_ADDR(x) (((x) >> TLBI_ADDR_SHIFT) & TLBI_ADDR_MASK) /******************************************************************************* * Definitions of register offsets and fields in the CNTCTLBase Frame of the * system level implementation of the Generic Timer. ******************************************************************************/ #define CNTNSAR 0x4 #define CNTNSAR_NS_SHIFT(x) (x) #define CNTACR_BASE(x) (0x40 + ((x) << 2)) #define CNTACR_RPCT_SHIFT 0x0 #define CNTACR_RVCT_SHIFT 0x1 #define CNTACR_RFRQ_SHIFT 0x2 #define CNTACR_RVOFF_SHIFT 0x3 #define CNTACR_RWVT_SHIFT 0x4 #define CNTACR_RWPT_SHIFT 0x5 /* MAIR macros */ #define MAIR0_ATTR_SET(attr, index) ((attr) << ((index) << 3)) #define MAIR1_ATTR_SET(attr, index) ((attr) << (((index) - 3) << 3)) /* System register defines The format is: coproc, opt1, CRn, CRm, opt2 */ #define SCR p15, 0, c1, c1, 0 #define SCTLR p15, 0, c1, c0, 0 #define SDCR p15, 0, c1, c3, 1 #define MPIDR p15, 0, c0, c0, 5 #define MIDR p15, 0, c0, c0, 0 #define VBAR p15, 0, c12, c0, 0 #define MVBAR p15, 0, c12, c0, 1 #define NSACR p15, 0, c1, c1, 2 #define CPACR p15, 0, c1, c0, 2 #define DCCIMVAC p15, 0, c7, c14, 1 #define DCCMVAC p15, 0, c7, c10, 1 #define DCIMVAC p15, 0, c7, c6, 1 #define DCCISW p15, 0, c7, c14, 2 #define DCCSW p15, 0, c7, c10, 2 #define DCISW p15, 0, c7, c6, 2 #define CTR p15, 0, c0, c0, 1 #define CNTFRQ p15, 0, c14, c0, 0 #define ID_PFR1 p15, 0, c0, c1, 1 #define MAIR0 p15, 0, c10, c2, 0 #define MAIR1 p15, 0, c10, c2, 1 #define TTBCR p15, 0, c2, c0, 2 #define TTBR0 p15, 0, c2, c0, 0 #define TTBR1 p15, 0, c2, c0, 1 #define TLBIALL p15, 0, c8, c7, 0 #define TLBIALLIS p15, 0, c8, c3, 0 #define TLBIMVA p15, 0, c8, c7, 1 #define TLBIMVAA p15, 0, c8, c7, 3 #define TLBIMVAAIS p15, 0, c8, c3, 3 #define BPIALLIS p15, 0, c7, c1, 6 #define HSCTLR p15, 4, c1, c0, 0 #define HCR p15, 4, c1, c1, 0 #define HCPTR p15, 4, c1, c1, 2 #define HSTR p15, 4, c1, c1, 3 #define CNTHCTL p15, 4, c14, c1, 0 #define CNTKCTL p15, 0, c14, c1, 0 #define VPIDR p15, 4, c0, c0, 0 #define VMPIDR p15, 4, c0, c0, 5 #define ISR p15, 0, c12, c1, 0 #define CLIDR p15, 1, c0, c0, 1 #define CSSELR p15, 2, c0, c0, 0 #define CCSIDR p15, 1, c0, c0, 0 #define DBGOSDLR p14, 0, c1, c3, 4 /* Debug register defines. The format is: coproc, opt1, CRn, CRm, opt2 */ #define HDCR p15, 4, c1, c1, 1 #define PMCR p15, 0, c9, c12, 0 #define CNTHP_CTL p15, 4, c14, c2, 1 /* GICv3 CPU Interface system register defines. The format is: coproc, opt1, CRn, CRm, opt2 */ #define ICC_IAR1 p15, 0, c12, c12, 0 #define ICC_IAR0 p15, 0, c12, c8, 0 #define ICC_EOIR1 p15, 0, c12, c12, 1 #define ICC_EOIR0 p15, 0, c12, c8, 1 #define ICC_HPPIR1 p15, 0, c12, c12, 2 #define ICC_HPPIR0 p15, 0, c12, c8, 2 #define ICC_BPR1 p15, 0, c12, c12, 3 #define ICC_BPR0 p15, 0, c12, c8, 3 #define ICC_DIR p15, 0, c12, c11, 1 #define ICC_PMR p15, 0, c4, c6, 0 #define ICC_RPR p15, 0, c12, c11, 3 #define ICC_CTLR p15, 0, c12, c12, 4 #define ICC_MCTLR p15, 6, c12, c12, 4 #define ICC_SRE p15, 0, c12, c12, 5 #define ICC_HSRE p15, 4, c12, c9, 5 #define ICC_MSRE p15, 6, c12, c12, 5 #define ICC_IGRPEN0 p15, 0, c12, c12, 6 #define ICC_IGRPEN1 p15, 0, c12, c12, 7 #define ICC_MGRPEN1 p15, 6, c12, c12, 7 /* 64 bit system register defines The format is: coproc, opt1, CRm */ #define TTBR0_64 p15, 0, c2 #define TTBR1_64 p15, 1, c2 #define CNTVOFF_64 p15, 4, c14 #define VTTBR_64 p15, 6, c2 #define CNTPCT_64 p15, 0, c14 /* 64 bit GICv3 CPU Interface system register defines. The format is: coproc, opt1, CRm */ #define ICC_SGI1R_EL1_64 p15, 0, c12 #define ICC_ASGI1R_EL1_64 p15, 1, c12 #define ICC_SGI0R_EL1_64 p15, 2, c12 /******************************************************************************* * Definitions of MAIR encodings for device and normal memory ******************************************************************************/ /* * MAIR encodings for device memory attributes. */ #define MAIR_DEV_nGnRnE U(0x0) #define MAIR_DEV_nGnRE U(0x4) #define MAIR_DEV_nGRE U(0x8) #define MAIR_DEV_GRE U(0xc) /* * MAIR encodings for normal memory attributes. * * Cache Policy * WT: Write Through * WB: Write Back * NC: Non-Cacheable * * Transient Hint * NTR: Non-Transient * TR: Transient * * Allocation Policy * RA: Read Allocate * WA: Write Allocate * RWA: Read and Write Allocate * NA: No Allocation */ #define MAIR_NORM_WT_TR_WA U(0x1) #define MAIR_NORM_WT_TR_RA U(0x2) #define MAIR_NORM_WT_TR_RWA U(0x3) #define MAIR_NORM_NC U(0x4) #define MAIR_NORM_WB_TR_WA U(0x5) #define MAIR_NORM_WB_TR_RA U(0x6) #define MAIR_NORM_WB_TR_RWA U(0x7) #define MAIR_NORM_WT_NTR_NA U(0x8) #define MAIR_NORM_WT_NTR_WA U(0x9) #define MAIR_NORM_WT_NTR_RA U(0xa) #define MAIR_NORM_WT_NTR_RWA U(0xb) #define MAIR_NORM_WB_NTR_NA U(0xc) #define MAIR_NORM_WB_NTR_WA U(0xd) #define MAIR_NORM_WB_NTR_RA U(0xe) #define MAIR_NORM_WB_NTR_RWA U(0xf) #define MAIR_NORM_OUTER_SHIFT 4 #define MAKE_MAIR_NORMAL_MEMORY(inner, outer) ((inner) | ((outer) << MAIR_NORM_OUTER_SHIFT)) #endif /* __ARCH_H__ */