xref: /rk3399_ARM-atf/include/lib/el3_runtime/aarch64/context.h (revision d20052f33a3ee4ed7e72e6b0aab609a4db06570e)
1532ed618SSoby Mathew /*
20ce220afSJayanth Dodderi Chidanand  * Copyright (c) 2013-2022, Arm Limited and Contributors. All rights reserved.
3532ed618SSoby Mathew  *
482cb2c1aSdp-arm  * SPDX-License-Identifier: BSD-3-Clause
5532ed618SSoby Mathew  */
6532ed618SSoby Mathew 
7a0fee747SAntonio Nino Diaz #ifndef CONTEXT_H
8a0fee747SAntonio Nino Diaz #define CONTEXT_H
9532ed618SSoby Mathew 
1009d40e0eSAntonio Nino Diaz #include <lib/utils_def.h>
1176454abfSJeenu Viswambharan 
12532ed618SSoby Mathew /*******************************************************************************
13532ed618SSoby Mathew  * Constants that allow assembler code to access members of and the 'gp_regs'
14532ed618SSoby Mathew  * structure at their correct offsets.
15532ed618SSoby Mathew  ******************************************************************************/
16030567e6SVarun Wadekar #define CTX_GPREGS_OFFSET	U(0x0)
17030567e6SVarun Wadekar #define CTX_GPREG_X0		U(0x0)
18030567e6SVarun Wadekar #define CTX_GPREG_X1		U(0x8)
19030567e6SVarun Wadekar #define CTX_GPREG_X2		U(0x10)
20030567e6SVarun Wadekar #define CTX_GPREG_X3		U(0x18)
21030567e6SVarun Wadekar #define CTX_GPREG_X4		U(0x20)
22030567e6SVarun Wadekar #define CTX_GPREG_X5		U(0x28)
23030567e6SVarun Wadekar #define CTX_GPREG_X6		U(0x30)
24030567e6SVarun Wadekar #define CTX_GPREG_X7		U(0x38)
25030567e6SVarun Wadekar #define CTX_GPREG_X8		U(0x40)
26030567e6SVarun Wadekar #define CTX_GPREG_X9		U(0x48)
27030567e6SVarun Wadekar #define CTX_GPREG_X10		U(0x50)
28030567e6SVarun Wadekar #define CTX_GPREG_X11		U(0x58)
29030567e6SVarun Wadekar #define CTX_GPREG_X12		U(0x60)
30030567e6SVarun Wadekar #define CTX_GPREG_X13		U(0x68)
31030567e6SVarun Wadekar #define CTX_GPREG_X14		U(0x70)
32030567e6SVarun Wadekar #define CTX_GPREG_X15		U(0x78)
33030567e6SVarun Wadekar #define CTX_GPREG_X16		U(0x80)
34030567e6SVarun Wadekar #define CTX_GPREG_X17		U(0x88)
35030567e6SVarun Wadekar #define CTX_GPREG_X18		U(0x90)
36030567e6SVarun Wadekar #define CTX_GPREG_X19		U(0x98)
37030567e6SVarun Wadekar #define CTX_GPREG_X20		U(0xa0)
38030567e6SVarun Wadekar #define CTX_GPREG_X21		U(0xa8)
39030567e6SVarun Wadekar #define CTX_GPREG_X22		U(0xb0)
40030567e6SVarun Wadekar #define CTX_GPREG_X23		U(0xb8)
41030567e6SVarun Wadekar #define CTX_GPREG_X24		U(0xc0)
42030567e6SVarun Wadekar #define CTX_GPREG_X25		U(0xc8)
43030567e6SVarun Wadekar #define CTX_GPREG_X26		U(0xd0)
44030567e6SVarun Wadekar #define CTX_GPREG_X27		U(0xd8)
45030567e6SVarun Wadekar #define CTX_GPREG_X28		U(0xe0)
46030567e6SVarun Wadekar #define CTX_GPREG_X29		U(0xe8)
47030567e6SVarun Wadekar #define CTX_GPREG_LR		U(0xf0)
48030567e6SVarun Wadekar #define CTX_GPREG_SP_EL0	U(0xf8)
49030567e6SVarun Wadekar #define CTX_GPREGS_END		U(0x100)
50532ed618SSoby Mathew 
51532ed618SSoby Mathew /*******************************************************************************
52532ed618SSoby Mathew  * Constants that allow assembler code to access members of and the 'el3_state'
53532ed618SSoby Mathew  * structure at their correct offsets. Note that some of the registers are only
54532ed618SSoby Mathew  * 32-bits wide but are stored as 64-bit values for convenience
55532ed618SSoby Mathew  ******************************************************************************/
56d9bd656cSDimitris Papastamos #define CTX_EL3STATE_OFFSET	(CTX_GPREGS_OFFSET + CTX_GPREGS_END)
57030567e6SVarun Wadekar #define CTX_SCR_EL3		U(0x0)
5876454abfSJeenu Viswambharan #define CTX_ESR_EL3		U(0x8)
5976454abfSJeenu Viswambharan #define CTX_RUNTIME_SP		U(0x10)
6076454abfSJeenu Viswambharan #define CTX_SPSR_EL3		U(0x18)
6176454abfSJeenu Viswambharan #define CTX_ELR_EL3		U(0x20)
62e290a8fcSAlexei Fedorov #define CTX_PMCR_EL0		U(0x28)
63c2d32a5fSMadhukar Pappireddy #define CTX_IS_IN_EL3		U(0x30)
640c5e7d1cSMax Shvetsov #define CTX_CPTR_EL3		U(0x38)
650c5e7d1cSMax Shvetsov #define CTX_ZCR_EL3		U(0x40)
660c5e7d1cSMax Shvetsov #define CTX_EL3STATE_END	U(0x50) /* Align to the next 16 byte boundary */
67532ed618SSoby Mathew 
68532ed618SSoby Mathew /*******************************************************************************
69532ed618SSoby Mathew  * Constants that allow assembler code to access members of and the
70532ed618SSoby Mathew  * 'el1_sys_regs' structure at their correct offsets. Note that some of the
71532ed618SSoby Mathew  * registers are only 32-bits wide but are stored as 64-bit values for
72532ed618SSoby Mathew  * convenience
73532ed618SSoby Mathew  ******************************************************************************/
742825946eSMax Shvetsov #define CTX_EL1_SYSREGS_OFFSET	(CTX_EL3STATE_OFFSET + CTX_EL3STATE_END)
75030567e6SVarun Wadekar #define CTX_SPSR_EL1		U(0x0)
76030567e6SVarun Wadekar #define CTX_ELR_EL1		U(0x8)
77030567e6SVarun Wadekar #define CTX_SCTLR_EL1		U(0x10)
78cb55615cSManish V Badarkhe #define CTX_TCR_EL1		U(0x18)
79030567e6SVarun Wadekar #define CTX_CPACR_EL1		U(0x20)
80030567e6SVarun Wadekar #define CTX_CSSELR_EL1		U(0x28)
81030567e6SVarun Wadekar #define CTX_SP_EL1		U(0x30)
82030567e6SVarun Wadekar #define CTX_ESR_EL1		U(0x38)
83030567e6SVarun Wadekar #define CTX_TTBR0_EL1		U(0x40)
84030567e6SVarun Wadekar #define CTX_TTBR1_EL1		U(0x48)
85030567e6SVarun Wadekar #define CTX_MAIR_EL1		U(0x50)
86030567e6SVarun Wadekar #define CTX_AMAIR_EL1		U(0x58)
87cb55615cSManish V Badarkhe #define CTX_ACTLR_EL1		U(0x60)
88030567e6SVarun Wadekar #define CTX_TPIDR_EL1		U(0x68)
89030567e6SVarun Wadekar #define CTX_TPIDR_EL0		U(0x70)
90030567e6SVarun Wadekar #define CTX_TPIDRRO_EL0		U(0x78)
91030567e6SVarun Wadekar #define CTX_PAR_EL1		U(0x80)
92030567e6SVarun Wadekar #define CTX_FAR_EL1		U(0x88)
93030567e6SVarun Wadekar #define CTX_AFSR0_EL1		U(0x90)
94030567e6SVarun Wadekar #define CTX_AFSR1_EL1		U(0x98)
95030567e6SVarun Wadekar #define CTX_CONTEXTIDR_EL1	U(0xa0)
96030567e6SVarun Wadekar #define CTX_VBAR_EL1		U(0xa8)
97532ed618SSoby Mathew 
98532ed618SSoby Mathew /*
99532ed618SSoby Mathew  * If the platform is AArch64-only, there is no need to save and restore these
100532ed618SSoby Mathew  * AArch32 registers.
101532ed618SSoby Mathew  */
102532ed618SSoby Mathew #if CTX_INCLUDE_AARCH32_REGS
103e290a8fcSAlexei Fedorov #define CTX_SPSR_ABT		U(0xb0)	/* Align to the next 16 byte boundary */
104e290a8fcSAlexei Fedorov #define CTX_SPSR_UND		U(0xb8)
105e290a8fcSAlexei Fedorov #define CTX_SPSR_IRQ		U(0xc0)
106e290a8fcSAlexei Fedorov #define CTX_SPSR_FIQ		U(0xc8)
107e290a8fcSAlexei Fedorov #define CTX_DACR32_EL2		U(0xd0)
108e290a8fcSAlexei Fedorov #define CTX_IFSR32_EL2		U(0xd8)
109e290a8fcSAlexei Fedorov #define CTX_AARCH32_END		U(0xe0) /* Align to the next 16 byte boundary */
110532ed618SSoby Mathew #else
111e290a8fcSAlexei Fedorov #define CTX_AARCH32_END		U(0xb0)	/* Align to the next 16 byte boundary */
1124d1ccf0eSAntonio Nino Diaz #endif /* CTX_INCLUDE_AARCH32_REGS */
113532ed618SSoby Mathew 
114532ed618SSoby Mathew /*
115532ed618SSoby Mathew  * If the timer registers aren't saved and restored, we don't have to reserve
116532ed618SSoby Mathew  * space for them in the context
117532ed618SSoby Mathew  */
118532ed618SSoby Mathew #if NS_TIMER_SWITCH
1194d1ccf0eSAntonio Nino Diaz #define CTX_CNTP_CTL_EL0	(CTX_AARCH32_END + U(0x0))
1204d1ccf0eSAntonio Nino Diaz #define CTX_CNTP_CVAL_EL0	(CTX_AARCH32_END + U(0x8))
1214d1ccf0eSAntonio Nino Diaz #define CTX_CNTV_CTL_EL0	(CTX_AARCH32_END + U(0x10))
1224d1ccf0eSAntonio Nino Diaz #define CTX_CNTV_CVAL_EL0	(CTX_AARCH32_END + U(0x18))
1234d1ccf0eSAntonio Nino Diaz #define CTX_CNTKCTL_EL1		(CTX_AARCH32_END + U(0x20))
1244d1ccf0eSAntonio Nino Diaz #define CTX_TIMER_SYSREGS_END	(CTX_AARCH32_END + U(0x30)) /* Align to the next 16 byte boundary */
125532ed618SSoby Mathew #else
1264d1ccf0eSAntonio Nino Diaz #define CTX_TIMER_SYSREGS_END	CTX_AARCH32_END
1274d1ccf0eSAntonio Nino Diaz #endif /* NS_TIMER_SWITCH */
1284d1ccf0eSAntonio Nino Diaz 
1299dd94382SJustin Chadwell #if CTX_INCLUDE_MTE_REGS
1309dd94382SJustin Chadwell #define CTX_TFSRE0_EL1		(CTX_TIMER_SYSREGS_END + U(0x0))
1319dd94382SJustin Chadwell #define CTX_TFSR_EL1		(CTX_TIMER_SYSREGS_END + U(0x8))
1329dd94382SJustin Chadwell #define CTX_RGSR_EL1		(CTX_TIMER_SYSREGS_END + U(0x10))
1339dd94382SJustin Chadwell #define CTX_GCR_EL1		(CTX_TIMER_SYSREGS_END + U(0x18))
1349dd94382SJustin Chadwell 
1359dd94382SJustin Chadwell /* Align to the next 16 byte boundary */
1369dd94382SJustin Chadwell #define CTX_MTE_REGS_END	(CTX_TIMER_SYSREGS_END + U(0x20))
1379dd94382SJustin Chadwell #else
1389dd94382SJustin Chadwell #define CTX_MTE_REGS_END	CTX_TIMER_SYSREGS_END
1399dd94382SJustin Chadwell #endif /* CTX_INCLUDE_MTE_REGS */
1409dd94382SJustin Chadwell 
1414d1ccf0eSAntonio Nino Diaz /*
1422825946eSMax Shvetsov  * End of system registers.
1432825946eSMax Shvetsov  */
1442825946eSMax Shvetsov #define CTX_EL1_SYSREGS_END		CTX_MTE_REGS_END
1452825946eSMax Shvetsov 
1462825946eSMax Shvetsov /*
1472825946eSMax Shvetsov  * EL2 register set
14828f39f02SMax Shvetsov  */
14928f39f02SMax Shvetsov 
15028f39f02SMax Shvetsov #if CTX_INCLUDE_EL2_REGS
15128f39f02SMax Shvetsov /* For later discussion
15228f39f02SMax Shvetsov  * ICH_AP0R<n>_EL2
15328f39f02SMax Shvetsov  * ICH_AP1R<n>_EL2
15428f39f02SMax Shvetsov  * AMEVCNTVOFF0<n>_EL2
15528f39f02SMax Shvetsov  * AMEVCNTVOFF1<n>_EL2
15628f39f02SMax Shvetsov  * ICH_LR<n>_EL2
15728f39f02SMax Shvetsov  */
1582825946eSMax Shvetsov #define CTX_EL2_SYSREGS_OFFSET	(CTX_EL1_SYSREGS_OFFSET + CTX_EL1_SYSREGS_END)
15928f39f02SMax Shvetsov 
1602825946eSMax Shvetsov #define CTX_ACTLR_EL2		U(0x0)
1612825946eSMax Shvetsov #define CTX_AFSR0_EL2		U(0x8)
1622825946eSMax Shvetsov #define CTX_AFSR1_EL2		U(0x10)
1632825946eSMax Shvetsov #define CTX_AMAIR_EL2		U(0x18)
1642825946eSMax Shvetsov #define CTX_CNTHCTL_EL2		U(0x20)
165a7cf2743SMax Shvetsov #define CTX_CNTVOFF_EL2		U(0x28)
166a7cf2743SMax Shvetsov #define CTX_CPTR_EL2		U(0x30)
167a7cf2743SMax Shvetsov #define CTX_DBGVCR32_EL2	U(0x38)
168a7cf2743SMax Shvetsov #define CTX_ELR_EL2		U(0x40)
169a7cf2743SMax Shvetsov #define CTX_ESR_EL2		U(0x48)
170a7cf2743SMax Shvetsov #define CTX_FAR_EL2		U(0x50)
171a7cf2743SMax Shvetsov #define CTX_HACR_EL2		U(0x58)
172a7cf2743SMax Shvetsov #define CTX_HCR_EL2		U(0x60)
173a7cf2743SMax Shvetsov #define CTX_HPFAR_EL2		U(0x68)
174a7cf2743SMax Shvetsov #define CTX_HSTR_EL2		U(0x70)
175a7cf2743SMax Shvetsov #define CTX_ICC_SRE_EL2		U(0x78)
176a7cf2743SMax Shvetsov #define CTX_ICH_HCR_EL2		U(0x80)
177a7cf2743SMax Shvetsov #define CTX_ICH_VMCR_EL2	U(0x88)
178a7cf2743SMax Shvetsov #define CTX_MAIR_EL2		U(0x90)
179a7cf2743SMax Shvetsov #define CTX_MDCR_EL2		U(0x98)
180a7cf2743SMax Shvetsov #define CTX_PMSCR_EL2		U(0xa0)
181a7cf2743SMax Shvetsov #define CTX_SCTLR_EL2		U(0xa8)
182a7cf2743SMax Shvetsov #define CTX_SPSR_EL2		U(0xb0)
183a7cf2743SMax Shvetsov #define CTX_SP_EL2		U(0xb8)
184a7cf2743SMax Shvetsov #define CTX_TCR_EL2		U(0xc0)
185a7cf2743SMax Shvetsov #define CTX_TPIDR_EL2		U(0xc8)
186a7cf2743SMax Shvetsov #define CTX_TTBR0_EL2		U(0xd0)
187a7cf2743SMax Shvetsov #define CTX_VBAR_EL2		U(0xd8)
188a7cf2743SMax Shvetsov #define CTX_VMPIDR_EL2		U(0xe0)
189a7cf2743SMax Shvetsov #define CTX_VPIDR_EL2		U(0xe8)
190a7cf2743SMax Shvetsov #define CTX_VTCR_EL2		U(0xf0)
191a7cf2743SMax Shvetsov #define CTX_VTTBR_EL2		U(0xf8)
1922825946eSMax Shvetsov 
1932825946eSMax Shvetsov // Only if MTE registers in use
194a7cf2743SMax Shvetsov #define CTX_TFSR_EL2		U(0x100)
1952825946eSMax Shvetsov 
1962825946eSMax Shvetsov // Only if ENABLE_MPAM_FOR_LOWER_ELS==1
197a7cf2743SMax Shvetsov #define CTX_MPAM2_EL2		U(0x108)
198a7cf2743SMax Shvetsov #define CTX_MPAMHCR_EL2		U(0x110)
199a7cf2743SMax Shvetsov #define CTX_MPAMVPM0_EL2	U(0x118)
200a7cf2743SMax Shvetsov #define CTX_MPAMVPM1_EL2	U(0x120)
201a7cf2743SMax Shvetsov #define CTX_MPAMVPM2_EL2	U(0x128)
202a7cf2743SMax Shvetsov #define CTX_MPAMVPM3_EL2	U(0x130)
203a7cf2743SMax Shvetsov #define CTX_MPAMVPM4_EL2	U(0x138)
204a7cf2743SMax Shvetsov #define CTX_MPAMVPM5_EL2	U(0x140)
205a7cf2743SMax Shvetsov #define CTX_MPAMVPM6_EL2	U(0x148)
206a7cf2743SMax Shvetsov #define CTX_MPAMVPM7_EL2	U(0x150)
207a7cf2743SMax Shvetsov #define CTX_MPAMVPMV_EL2	U(0x158)
2082825946eSMax Shvetsov 
2092825946eSMax Shvetsov // Starting with Armv8.6
210f74cb0beSJayanth Dodderi Chidanand #define CTX_HDFGRTR_EL2		U(0x160)
211f74cb0beSJayanth Dodderi Chidanand #define CTX_HAFGRTR_EL2		U(0x168)
212a7cf2743SMax Shvetsov #define CTX_HDFGWTR_EL2		U(0x170)
213a7cf2743SMax Shvetsov #define CTX_HFGITR_EL2		U(0x178)
214a7cf2743SMax Shvetsov #define CTX_HFGRTR_EL2		U(0x180)
215a7cf2743SMax Shvetsov #define CTX_HFGWTR_EL2		U(0x188)
216a7cf2743SMax Shvetsov #define CTX_CNTPOFF_EL2		U(0x190)
2172825946eSMax Shvetsov 
2182825946eSMax Shvetsov // Starting with Armv8.4
219a7cf2743SMax Shvetsov #define CTX_CONTEXTIDR_EL2	U(0x198)
2200ce220afSJayanth Dodderi Chidanand #define CTX_TTBR1_EL2		U(0x1a0)
2210ce220afSJayanth Dodderi Chidanand #define CTX_VDISR_EL2		U(0x1a8)
2220ce220afSJayanth Dodderi Chidanand #define CTX_VSESR_EL2		U(0x1b0)
2237f41bcc7SZelalem Aweke #define CTX_VNCR_EL2		U(0x1b8)
2247f41bcc7SZelalem Aweke #define CTX_TRFCR_EL2		U(0x1c0)
2252825946eSMax Shvetsov 
2262825946eSMax Shvetsov // Starting with Armv8.5
2277f41bcc7SZelalem Aweke #define CTX_SCXTNUM_EL2		U(0x1c8)
228cb4ec47bSjohpow01 
229cb4ec47bSjohpow01 // Register for FEAT_HCX
2307f41bcc7SZelalem Aweke #define CTX_HCRX_EL2            U(0x1d0)
231cb4ec47bSjohpow01 
23228f39f02SMax Shvetsov /* Align to the next 16 byte boundary */
2337f41bcc7SZelalem Aweke #define CTX_EL2_SYSREGS_END	U(0x1e0)
2347f164a83SOlivier Deprez 
23528f39f02SMax Shvetsov #endif /* CTX_INCLUDE_EL2_REGS */
23628f39f02SMax Shvetsov 
237532ed618SSoby Mathew /*******************************************************************************
238532ed618SSoby Mathew  * Constants that allow assembler code to access members of and the 'fp_regs'
239532ed618SSoby Mathew  * structure at their correct offsets.
240532ed618SSoby Mathew  ******************************************************************************/
2412825946eSMax Shvetsov #if CTX_INCLUDE_EL2_REGS
2422825946eSMax Shvetsov # define CTX_FPREGS_OFFSET	(CTX_EL2_SYSREGS_OFFSET + CTX_EL2_SYSREGS_END)
2432825946eSMax Shvetsov #else
2442825946eSMax Shvetsov # define CTX_FPREGS_OFFSET	(CTX_EL1_SYSREGS_OFFSET + CTX_EL1_SYSREGS_END)
2452825946eSMax Shvetsov #endif
246fe007b2eSDimitris Papastamos #if CTX_INCLUDE_FPREGS
247030567e6SVarun Wadekar #define CTX_FP_Q0		U(0x0)
248030567e6SVarun Wadekar #define CTX_FP_Q1		U(0x10)
249030567e6SVarun Wadekar #define CTX_FP_Q2		U(0x20)
250030567e6SVarun Wadekar #define CTX_FP_Q3		U(0x30)
251030567e6SVarun Wadekar #define CTX_FP_Q4		U(0x40)
252030567e6SVarun Wadekar #define CTX_FP_Q5		U(0x50)
253030567e6SVarun Wadekar #define CTX_FP_Q6		U(0x60)
254030567e6SVarun Wadekar #define CTX_FP_Q7		U(0x70)
255030567e6SVarun Wadekar #define CTX_FP_Q8		U(0x80)
256030567e6SVarun Wadekar #define CTX_FP_Q9		U(0x90)
257030567e6SVarun Wadekar #define CTX_FP_Q10		U(0xa0)
258030567e6SVarun Wadekar #define CTX_FP_Q11		U(0xb0)
259030567e6SVarun Wadekar #define CTX_FP_Q12		U(0xc0)
260030567e6SVarun Wadekar #define CTX_FP_Q13		U(0xd0)
261030567e6SVarun Wadekar #define CTX_FP_Q14		U(0xe0)
262030567e6SVarun Wadekar #define CTX_FP_Q15		U(0xf0)
263030567e6SVarun Wadekar #define CTX_FP_Q16		U(0x100)
264030567e6SVarun Wadekar #define CTX_FP_Q17		U(0x110)
265030567e6SVarun Wadekar #define CTX_FP_Q18		U(0x120)
266030567e6SVarun Wadekar #define CTX_FP_Q19		U(0x130)
267030567e6SVarun Wadekar #define CTX_FP_Q20		U(0x140)
268030567e6SVarun Wadekar #define CTX_FP_Q21		U(0x150)
269030567e6SVarun Wadekar #define CTX_FP_Q22		U(0x160)
270030567e6SVarun Wadekar #define CTX_FP_Q23		U(0x170)
271030567e6SVarun Wadekar #define CTX_FP_Q24		U(0x180)
272030567e6SVarun Wadekar #define CTX_FP_Q25		U(0x190)
273030567e6SVarun Wadekar #define CTX_FP_Q26		U(0x1a0)
274030567e6SVarun Wadekar #define CTX_FP_Q27		U(0x1b0)
275030567e6SVarun Wadekar #define CTX_FP_Q28		U(0x1c0)
276030567e6SVarun Wadekar #define CTX_FP_Q29		U(0x1d0)
277030567e6SVarun Wadekar #define CTX_FP_Q30		U(0x1e0)
278030567e6SVarun Wadekar #define CTX_FP_Q31		U(0x1f0)
279030567e6SVarun Wadekar #define CTX_FP_FPSR		U(0x200)
280030567e6SVarun Wadekar #define CTX_FP_FPCR		U(0x208)
28191089f36SDavid Cunado #if CTX_INCLUDE_AARCH32_REGS
28291089f36SDavid Cunado #define CTX_FP_FPEXC32_EL2	U(0x210)
28391089f36SDavid Cunado #define CTX_FPREGS_END		U(0x220) /* Align to the next 16 byte boundary */
28491089f36SDavid Cunado #else
28591089f36SDavid Cunado #define CTX_FPREGS_END		U(0x210) /* Align to the next 16 byte boundary */
28691089f36SDavid Cunado #endif
287fe007b2eSDimitris Papastamos #else
288fe007b2eSDimitris Papastamos #define CTX_FPREGS_END		U(0)
289532ed618SSoby Mathew #endif
290532ed618SSoby Mathew 
2914d1ccf0eSAntonio Nino Diaz /*******************************************************************************
2924d1ccf0eSAntonio Nino Diaz  * Registers related to CVE-2018-3639
2934d1ccf0eSAntonio Nino Diaz  ******************************************************************************/
294fe007b2eSDimitris Papastamos #define CTX_CVE_2018_3639_OFFSET	(CTX_FPREGS_OFFSET + CTX_FPREGS_END)
295fe007b2eSDimitris Papastamos #define CTX_CVE_2018_3639_DISABLE	U(0)
296fe007b2eSDimitris Papastamos #define CTX_CVE_2018_3639_END		U(0x10) /* Align to the next 16 byte boundary */
297fe007b2eSDimitris Papastamos 
2985283962eSAntonio Nino Diaz /*******************************************************************************
2995283962eSAntonio Nino Diaz  * Registers related to ARMv8.3-PAuth.
3005283962eSAntonio Nino Diaz  ******************************************************************************/
3015283962eSAntonio Nino Diaz #define CTX_PAUTH_REGS_OFFSET	(CTX_CVE_2018_3639_OFFSET + CTX_CVE_2018_3639_END)
3025283962eSAntonio Nino Diaz #if CTX_INCLUDE_PAUTH_REGS
3035283962eSAntonio Nino Diaz #define CTX_PACIAKEY_LO		U(0x0)
3045283962eSAntonio Nino Diaz #define CTX_PACIAKEY_HI		U(0x8)
3055283962eSAntonio Nino Diaz #define CTX_PACIBKEY_LO		U(0x10)
3065283962eSAntonio Nino Diaz #define CTX_PACIBKEY_HI		U(0x18)
3075283962eSAntonio Nino Diaz #define CTX_PACDAKEY_LO		U(0x20)
3085283962eSAntonio Nino Diaz #define CTX_PACDAKEY_HI		U(0x28)
3095283962eSAntonio Nino Diaz #define CTX_PACDBKEY_LO		U(0x30)
3105283962eSAntonio Nino Diaz #define CTX_PACDBKEY_HI		U(0x38)
3115283962eSAntonio Nino Diaz #define CTX_PACGAKEY_LO		U(0x40)
3125283962eSAntonio Nino Diaz #define CTX_PACGAKEY_HI		U(0x48)
313ed108b56SAlexei Fedorov #define CTX_PAUTH_REGS_END	U(0x50) /* Align to the next 16 byte boundary */
3145283962eSAntonio Nino Diaz #else
3155283962eSAntonio Nino Diaz #define CTX_PAUTH_REGS_END	U(0)
3165283962eSAntonio Nino Diaz #endif /* CTX_INCLUDE_PAUTH_REGS */
3175283962eSAntonio Nino Diaz 
318d5dfdeb6SJulius Werner #ifndef __ASSEMBLER__
319532ed618SSoby Mathew 
320532ed618SSoby Mathew #include <stdint.h>
321532ed618SSoby Mathew 
32209d40e0eSAntonio Nino Diaz #include <lib/cassert.h>
32309d40e0eSAntonio Nino Diaz 
324532ed618SSoby Mathew /*
325532ed618SSoby Mathew  * Common constants to help define the 'cpu_context' structure and its
326532ed618SSoby Mathew  * members below.
327532ed618SSoby Mathew  */
328030567e6SVarun Wadekar #define DWORD_SHIFT		U(3)
329532ed618SSoby Mathew #define DEFINE_REG_STRUCT(name, num_regs)	\
330532ed618SSoby Mathew 	typedef struct name {			\
3312fe75a2dSZelalem 		uint64_t ctx_regs[num_regs];	\
332532ed618SSoby Mathew 	}  __aligned(16) name##_t
333532ed618SSoby Mathew 
334532ed618SSoby Mathew /* Constants to determine the size of individual context structures */
335532ed618SSoby Mathew #define CTX_GPREG_ALL		(CTX_GPREGS_END >> DWORD_SHIFT)
3362825946eSMax Shvetsov #define CTX_EL1_SYSREGS_ALL	(CTX_EL1_SYSREGS_END >> DWORD_SHIFT)
3372825946eSMax Shvetsov #if CTX_INCLUDE_EL2_REGS
3382825946eSMax Shvetsov # define CTX_EL2_SYSREGS_ALL	(CTX_EL2_SYSREGS_END >> DWORD_SHIFT)
3392825946eSMax Shvetsov #endif
340532ed618SSoby Mathew #if CTX_INCLUDE_FPREGS
341532ed618SSoby Mathew # define CTX_FPREG_ALL		(CTX_FPREGS_END >> DWORD_SHIFT)
342532ed618SSoby Mathew #endif
343532ed618SSoby Mathew #define CTX_EL3STATE_ALL	(CTX_EL3STATE_END >> DWORD_SHIFT)
344fe007b2eSDimitris Papastamos #define CTX_CVE_2018_3639_ALL	(CTX_CVE_2018_3639_END >> DWORD_SHIFT)
3455283962eSAntonio Nino Diaz #if CTX_INCLUDE_PAUTH_REGS
3465283962eSAntonio Nino Diaz # define CTX_PAUTH_REGS_ALL	(CTX_PAUTH_REGS_END >> DWORD_SHIFT)
3475283962eSAntonio Nino Diaz #endif
348532ed618SSoby Mathew 
349532ed618SSoby Mathew /*
350532ed618SSoby Mathew  * AArch64 general purpose register context structure. Usually x0-x18,
351532ed618SSoby Mathew  * lr are saved as the compiler is expected to preserve the remaining
352532ed618SSoby Mathew  * callee saved registers if used by the C runtime and the assembler
353532ed618SSoby Mathew  * does not touch the remaining. But in case of world switch during
354532ed618SSoby Mathew  * exception handling, we need to save the callee registers too.
355532ed618SSoby Mathew  */
356532ed618SSoby Mathew DEFINE_REG_STRUCT(gp_regs, CTX_GPREG_ALL);
357532ed618SSoby Mathew 
358532ed618SSoby Mathew /*
3592825946eSMax Shvetsov  * AArch64 EL1 system register context structure for preserving the
36028f39f02SMax Shvetsov  * architectural state during world switches.
361532ed618SSoby Mathew  */
3622825946eSMax Shvetsov DEFINE_REG_STRUCT(el1_sysregs, CTX_EL1_SYSREGS_ALL);
3632825946eSMax Shvetsov 
3642825946eSMax Shvetsov 
3652825946eSMax Shvetsov /*
3662825946eSMax Shvetsov  * AArch64 EL2 system register context structure for preserving the
3672825946eSMax Shvetsov  * architectural state during world switches.
3682825946eSMax Shvetsov  */
3692825946eSMax Shvetsov #if CTX_INCLUDE_EL2_REGS
3702825946eSMax Shvetsov DEFINE_REG_STRUCT(el2_sysregs, CTX_EL2_SYSREGS_ALL);
3712825946eSMax Shvetsov #endif
372532ed618SSoby Mathew 
373532ed618SSoby Mathew /*
374532ed618SSoby Mathew  * AArch64 floating point register context structure for preserving
375532ed618SSoby Mathew  * the floating point state during switches from one security state to
376532ed618SSoby Mathew  * another.
377532ed618SSoby Mathew  */
378532ed618SSoby Mathew #if CTX_INCLUDE_FPREGS
379532ed618SSoby Mathew DEFINE_REG_STRUCT(fp_regs, CTX_FPREG_ALL);
380532ed618SSoby Mathew #endif
381532ed618SSoby Mathew 
382532ed618SSoby Mathew /*
383532ed618SSoby Mathew  * Miscellaneous registers used by EL3 firmware to maintain its state
384532ed618SSoby Mathew  * across exception entries and exits
385532ed618SSoby Mathew  */
386532ed618SSoby Mathew DEFINE_REG_STRUCT(el3_state, CTX_EL3STATE_ALL);
387532ed618SSoby Mathew 
388fe007b2eSDimitris Papastamos /* Function pointer used by CVE-2018-3639 dynamic mitigation */
389fe007b2eSDimitris Papastamos DEFINE_REG_STRUCT(cve_2018_3639, CTX_CVE_2018_3639_ALL);
390fe007b2eSDimitris Papastamos 
3915283962eSAntonio Nino Diaz /* Registers associated to ARMv8.3-PAuth */
3925283962eSAntonio Nino Diaz #if CTX_INCLUDE_PAUTH_REGS
3935283962eSAntonio Nino Diaz DEFINE_REG_STRUCT(pauth, CTX_PAUTH_REGS_ALL);
3945283962eSAntonio Nino Diaz #endif
3955283962eSAntonio Nino Diaz 
396532ed618SSoby Mathew /*
397532ed618SSoby Mathew  * Macros to access members of any of the above structures using their
398532ed618SSoby Mathew  * offsets
399532ed618SSoby Mathew  */
4002fe75a2dSZelalem #define read_ctx_reg(ctx, offset)	((ctx)->ctx_regs[(offset) >> DWORD_SHIFT])
4012fe75a2dSZelalem #define write_ctx_reg(ctx, offset, val)	(((ctx)->ctx_regs[(offset) >> DWORD_SHIFT]) \
402ba6e5ca6SJeenu Viswambharan 					 = (uint64_t) (val))
403532ed618SSoby Mathew 
404532ed618SSoby Mathew /*
405c5ea4f8aSZelalem Aweke  * Top-level context structure which is used by EL3 firmware to preserve
406c5ea4f8aSZelalem Aweke  * the state of a core at the next lower EL in a given security state and
407c5ea4f8aSZelalem Aweke  * save enough EL3 meta data to be able to return to that EL and security
408c5ea4f8aSZelalem Aweke  * state. The context management library will be used to ensure that
409c5ea4f8aSZelalem Aweke  * SP_EL3 always points to an instance of this structure at exception
410c5ea4f8aSZelalem Aweke  * entry and exit.
411532ed618SSoby Mathew  */
412532ed618SSoby Mathew typedef struct cpu_context {
413532ed618SSoby Mathew 	gp_regs_t gpregs_ctx;
414532ed618SSoby Mathew 	el3_state_t el3state_ctx;
4152825946eSMax Shvetsov 	el1_sysregs_t el1_sysregs_ctx;
4162825946eSMax Shvetsov #if CTX_INCLUDE_EL2_REGS
4172825946eSMax Shvetsov 	el2_sysregs_t el2_sysregs_ctx;
4182825946eSMax Shvetsov #endif
419532ed618SSoby Mathew #if CTX_INCLUDE_FPREGS
420532ed618SSoby Mathew 	fp_regs_t fpregs_ctx;
421532ed618SSoby Mathew #endif
422fe007b2eSDimitris Papastamos 	cve_2018_3639_t cve_2018_3639_ctx;
4235283962eSAntonio Nino Diaz #if CTX_INCLUDE_PAUTH_REGS
4245283962eSAntonio Nino Diaz 	pauth_t pauth_ctx;
4255283962eSAntonio Nino Diaz #endif
426532ed618SSoby Mathew } cpu_context_t;
427532ed618SSoby Mathew 
428532ed618SSoby Mathew /* Macros to access members of the 'cpu_context_t' structure */
429532ed618SSoby Mathew #define get_el3state_ctx(h)	(&((cpu_context_t *) h)->el3state_ctx)
430532ed618SSoby Mathew #if CTX_INCLUDE_FPREGS
431532ed618SSoby Mathew # define get_fpregs_ctx(h)	(&((cpu_context_t *) h)->fpregs_ctx)
432532ed618SSoby Mathew #endif
4332825946eSMax Shvetsov #define get_el1_sysregs_ctx(h)	(&((cpu_context_t *) h)->el1_sysregs_ctx)
4342825946eSMax Shvetsov #if CTX_INCLUDE_EL2_REGS
4352825946eSMax Shvetsov # define get_el2_sysregs_ctx(h)	(&((cpu_context_t *) h)->el2_sysregs_ctx)
4362825946eSMax Shvetsov #endif
437532ed618SSoby Mathew #define get_gpregs_ctx(h)	(&((cpu_context_t *) h)->gpregs_ctx)
4386f03bc77SDimitris Papastamos #define get_cve_2018_3639_ctx(h)	(&((cpu_context_t *) h)->cve_2018_3639_ctx)
4395283962eSAntonio Nino Diaz #if CTX_INCLUDE_PAUTH_REGS
4405283962eSAntonio Nino Diaz # define get_pauth_ctx(h)	(&((cpu_context_t *) h)->pauth_ctx)
4415283962eSAntonio Nino Diaz #endif
442532ed618SSoby Mathew 
443532ed618SSoby Mathew /*
444532ed618SSoby Mathew  * Compile time assertions related to the 'cpu_context' structure to
445532ed618SSoby Mathew  * ensure that the assembler and the compiler view of the offsets of
446532ed618SSoby Mathew  * the structure members is the same.
447532ed618SSoby Mathew  */
448532ed618SSoby Mathew CASSERT(CTX_GPREGS_OFFSET == __builtin_offsetof(cpu_context_t, gpregs_ctx), \
449532ed618SSoby Mathew 	assert_core_context_gp_offset_mismatch);
4502825946eSMax Shvetsov CASSERT(CTX_EL1_SYSREGS_OFFSET == __builtin_offsetof(cpu_context_t, el1_sysregs_ctx), \
4512825946eSMax Shvetsov 	assert_core_context_el1_sys_offset_mismatch);
4522825946eSMax Shvetsov #if CTX_INCLUDE_EL2_REGS
4532825946eSMax Shvetsov CASSERT(CTX_EL2_SYSREGS_OFFSET == __builtin_offsetof(cpu_context_t, el2_sysregs_ctx), \
4542825946eSMax Shvetsov 	assert_core_context_el2_sys_offset_mismatch);
4552825946eSMax Shvetsov #endif
456532ed618SSoby Mathew #if CTX_INCLUDE_FPREGS
457532ed618SSoby Mathew CASSERT(CTX_FPREGS_OFFSET == __builtin_offsetof(cpu_context_t, fpregs_ctx), \
458532ed618SSoby Mathew 	assert_core_context_fp_offset_mismatch);
459532ed618SSoby Mathew #endif
460532ed618SSoby Mathew CASSERT(CTX_EL3STATE_OFFSET == __builtin_offsetof(cpu_context_t, el3state_ctx), \
461532ed618SSoby Mathew 	assert_core_context_el3state_offset_mismatch);
462fe007b2eSDimitris Papastamos CASSERT(CTX_CVE_2018_3639_OFFSET == __builtin_offsetof(cpu_context_t, cve_2018_3639_ctx), \
463fe007b2eSDimitris Papastamos 	assert_core_context_cve_2018_3639_offset_mismatch);
4645283962eSAntonio Nino Diaz #if CTX_INCLUDE_PAUTH_REGS
4655283962eSAntonio Nino Diaz CASSERT(CTX_PAUTH_REGS_OFFSET == __builtin_offsetof(cpu_context_t, pauth_ctx), \
4665283962eSAntonio Nino Diaz 	assert_core_context_pauth_offset_mismatch);
4675283962eSAntonio Nino Diaz #endif
468532ed618SSoby Mathew 
469532ed618SSoby Mathew /*
470532ed618SSoby Mathew  * Helper macro to set the general purpose registers that correspond to
471532ed618SSoby Mathew  * parameters in an aapcs_64 call i.e. x0-x7
472532ed618SSoby Mathew  */
473532ed618SSoby Mathew #define set_aapcs_args0(ctx, x0)				do {	\
474532ed618SSoby Mathew 		write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X0, x0);	\
475532ed618SSoby Mathew 	} while (0)
476532ed618SSoby Mathew #define set_aapcs_args1(ctx, x0, x1)				do {	\
477532ed618SSoby Mathew 		write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X1, x1);	\
478532ed618SSoby Mathew 		set_aapcs_args0(ctx, x0);				\
479532ed618SSoby Mathew 	} while (0)
480532ed618SSoby Mathew #define set_aapcs_args2(ctx, x0, x1, x2)			do {	\
481532ed618SSoby Mathew 		write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X2, x2);	\
482532ed618SSoby Mathew 		set_aapcs_args1(ctx, x0, x1);				\
483532ed618SSoby Mathew 	} while (0)
484532ed618SSoby Mathew #define set_aapcs_args3(ctx, x0, x1, x2, x3)			do {	\
485532ed618SSoby Mathew 		write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X3, x3);	\
486532ed618SSoby Mathew 		set_aapcs_args2(ctx, x0, x1, x2);			\
487532ed618SSoby Mathew 	} while (0)
488532ed618SSoby Mathew #define set_aapcs_args4(ctx, x0, x1, x2, x3, x4)		do {	\
489532ed618SSoby Mathew 		write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X4, x4);	\
490532ed618SSoby Mathew 		set_aapcs_args3(ctx, x0, x1, x2, x3);			\
491532ed618SSoby Mathew 	} while (0)
492532ed618SSoby Mathew #define set_aapcs_args5(ctx, x0, x1, x2, x3, x4, x5)		do {	\
493532ed618SSoby Mathew 		write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X5, x5);	\
494532ed618SSoby Mathew 		set_aapcs_args4(ctx, x0, x1, x2, x3, x4);		\
495532ed618SSoby Mathew 	} while (0)
496532ed618SSoby Mathew #define set_aapcs_args6(ctx, x0, x1, x2, x3, x4, x5, x6)	do {	\
497532ed618SSoby Mathew 		write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X6, x6);	\
498532ed618SSoby Mathew 		set_aapcs_args5(ctx, x0, x1, x2, x3, x4, x5);		\
499532ed618SSoby Mathew 	} while (0)
500532ed618SSoby Mathew #define set_aapcs_args7(ctx, x0, x1, x2, x3, x4, x5, x6, x7)	do {	\
501532ed618SSoby Mathew 		write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X7, x7);	\
502532ed618SSoby Mathew 		set_aapcs_args6(ctx, x0, x1, x2, x3, x4, x5, x6);	\
503532ed618SSoby Mathew 	} while (0)
504532ed618SSoby Mathew 
505532ed618SSoby Mathew /*******************************************************************************
506532ed618SSoby Mathew  * Function prototypes
507532ed618SSoby Mathew  ******************************************************************************/
5082825946eSMax Shvetsov void el1_sysregs_context_save(el1_sysregs_t *regs);
5092825946eSMax Shvetsov void el1_sysregs_context_restore(el1_sysregs_t *regs);
51028f39f02SMax Shvetsov 
51128f39f02SMax Shvetsov #if CTX_INCLUDE_EL2_REGS
512*d20052f3SZelalem Aweke void el2_sysregs_context_save_common(el2_sysregs_t *regs);
513*d20052f3SZelalem Aweke void el2_sysregs_context_restore_common(el2_sysregs_t *regs);
514*d20052f3SZelalem Aweke #if ENABLE_SPE_FOR_LOWER_ELS
515*d20052f3SZelalem Aweke void el2_sysregs_context_save_spe(el2_sysregs_t *regs);
516*d20052f3SZelalem Aweke void el2_sysregs_context_restore_spe(el2_sysregs_t *regs);
517*d20052f3SZelalem Aweke #endif /* ENABLE_SPE_FOR_LOWER_ELS */
518*d20052f3SZelalem Aweke #if CTX_INCLUDE_MTE_REGS
519*d20052f3SZelalem Aweke void el2_sysregs_context_save_mte(el2_sysregs_t *regs);
520*d20052f3SZelalem Aweke void el2_sysregs_context_restore_mte(el2_sysregs_t *regs);
521*d20052f3SZelalem Aweke #endif /* CTX_INCLUDE_MTE_REGS */
522*d20052f3SZelalem Aweke #if ENABLE_MPAM_FOR_LOWER_ELS
523*d20052f3SZelalem Aweke void el2_sysregs_context_save_mpam(el2_sysregs_t *regs);
524*d20052f3SZelalem Aweke void el2_sysregs_context_restore_mpam(el2_sysregs_t *regs);
525*d20052f3SZelalem Aweke #endif /* ENABLE_MPAM_FOR_LOWER_ELS */
526*d20052f3SZelalem Aweke #if ENABLE_FEAT_FGT
527*d20052f3SZelalem Aweke void el2_sysregs_context_save_fgt(el2_sysregs_t *regs);
528*d20052f3SZelalem Aweke void el2_sysregs_context_restore_fgt(el2_sysregs_t *regs);
529*d20052f3SZelalem Aweke #endif /* ENABLE_FEAT_FGT */
530*d20052f3SZelalem Aweke #if ENABLE_FEAT_ECV
531*d20052f3SZelalem Aweke void el2_sysregs_context_save_ecv(el2_sysregs_t *regs);
532*d20052f3SZelalem Aweke void el2_sysregs_context_restore_ecv(el2_sysregs_t *regs);
533*d20052f3SZelalem Aweke #endif /* ENABLE_FEAT_ECV */
534*d20052f3SZelalem Aweke #if ENABLE_FEAT_VHE
535*d20052f3SZelalem Aweke void el2_sysregs_context_save_vhe(el2_sysregs_t *regs);
536*d20052f3SZelalem Aweke void el2_sysregs_context_restore_vhe(el2_sysregs_t *regs);
537*d20052f3SZelalem Aweke #endif /* ENABLE_FEAT_VHE */
538*d20052f3SZelalem Aweke #if RAS_EXTENSION
539*d20052f3SZelalem Aweke void el2_sysregs_context_save_ras(el2_sysregs_t *regs);
540*d20052f3SZelalem Aweke void el2_sysregs_context_restore_ras(el2_sysregs_t *regs);
541*d20052f3SZelalem Aweke #endif /* RAS_EXTENSION */
542*d20052f3SZelalem Aweke #if CTX_INCLUDE_NEVE_REGS
543*d20052f3SZelalem Aweke void el2_sysregs_context_save_nv2(el2_sysregs_t *regs);
544*d20052f3SZelalem Aweke void el2_sysregs_context_restore_nv2(el2_sysregs_t *regs);
545*d20052f3SZelalem Aweke #endif /* CTX_INCLUDE_NEVE_REGS */
546*d20052f3SZelalem Aweke #if ENABLE_TRF_FOR_NS
547*d20052f3SZelalem Aweke void el2_sysregs_context_save_trf(el2_sysregs_t *regs);
548*d20052f3SZelalem Aweke void el2_sysregs_context_restore_trf(el2_sysregs_t *regs);
549*d20052f3SZelalem Aweke #endif /* ENABLE_TRF_FOR_NS */
550*d20052f3SZelalem Aweke #if ENABLE_FEAT_CSV2_2
551*d20052f3SZelalem Aweke void el2_sysregs_context_save_csv2(el2_sysregs_t *regs);
552*d20052f3SZelalem Aweke void el2_sysregs_context_restore_csv2(el2_sysregs_t *regs);
553*d20052f3SZelalem Aweke #endif /* ENABLE_FEAT_CSV2_2 */
554*d20052f3SZelalem Aweke #if ENABLE_FEAT_HCX
555*d20052f3SZelalem Aweke void el2_sysregs_context_save_hcx(el2_sysregs_t *regs);
556*d20052f3SZelalem Aweke void el2_sysregs_context_restore_hcx(el2_sysregs_t *regs);
557*d20052f3SZelalem Aweke #endif /* ENABLE_FEAT_HCX */
558*d20052f3SZelalem Aweke #endif /* CTX_INCLUDE_EL2_REGS */
55928f39f02SMax Shvetsov 
560532ed618SSoby Mathew #if CTX_INCLUDE_FPREGS
561532ed618SSoby Mathew void fpregs_context_save(fp_regs_t *regs);
562532ed618SSoby Mathew void fpregs_context_restore(fp_regs_t *regs);
563532ed618SSoby Mathew #endif
564532ed618SSoby Mathew 
565d5dfdeb6SJulius Werner #endif /* __ASSEMBLER__ */
566532ed618SSoby Mathew 
567a0fee747SAntonio Nino Diaz #endif /* CONTEXT_H */
568