xref: /rk3399_ARM-atf/include/lib/el3_runtime/aarch64/context.h (revision 062b6c6bf23f9656332b0aa3fed59c15f34f9361)
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 
196a7cf2743SMax Shvetsov #define CTX_MPAM2_EL2		U(0x108)
197a7cf2743SMax Shvetsov #define CTX_MPAMHCR_EL2		U(0x110)
198a7cf2743SMax Shvetsov #define CTX_MPAMVPM0_EL2	U(0x118)
199a7cf2743SMax Shvetsov #define CTX_MPAMVPM1_EL2	U(0x120)
200a7cf2743SMax Shvetsov #define CTX_MPAMVPM2_EL2	U(0x128)
201a7cf2743SMax Shvetsov #define CTX_MPAMVPM3_EL2	U(0x130)
202a7cf2743SMax Shvetsov #define CTX_MPAMVPM4_EL2	U(0x138)
203a7cf2743SMax Shvetsov #define CTX_MPAMVPM5_EL2	U(0x140)
204a7cf2743SMax Shvetsov #define CTX_MPAMVPM6_EL2	U(0x148)
205a7cf2743SMax Shvetsov #define CTX_MPAMVPM7_EL2	U(0x150)
206a7cf2743SMax Shvetsov #define CTX_MPAMVPMV_EL2	U(0x158)
2072825946eSMax Shvetsov 
2082825946eSMax Shvetsov // Starting with Armv8.6
209f74cb0beSJayanth Dodderi Chidanand #define CTX_HDFGRTR_EL2		U(0x160)
210f74cb0beSJayanth Dodderi Chidanand #define CTX_HAFGRTR_EL2		U(0x168)
211a7cf2743SMax Shvetsov #define CTX_HDFGWTR_EL2		U(0x170)
212a7cf2743SMax Shvetsov #define CTX_HFGITR_EL2		U(0x178)
213a7cf2743SMax Shvetsov #define CTX_HFGRTR_EL2		U(0x180)
214a7cf2743SMax Shvetsov #define CTX_HFGWTR_EL2		U(0x188)
215a7cf2743SMax Shvetsov #define CTX_CNTPOFF_EL2		U(0x190)
2162825946eSMax Shvetsov 
2172825946eSMax Shvetsov // Starting with Armv8.4
218a7cf2743SMax Shvetsov #define CTX_CONTEXTIDR_EL2	U(0x198)
2190ce220afSJayanth Dodderi Chidanand #define CTX_TTBR1_EL2		U(0x1a0)
2200ce220afSJayanth Dodderi Chidanand #define CTX_VDISR_EL2		U(0x1a8)
2210ce220afSJayanth Dodderi Chidanand #define CTX_VSESR_EL2		U(0x1b0)
2227f41bcc7SZelalem Aweke #define CTX_VNCR_EL2		U(0x1b8)
2237f41bcc7SZelalem Aweke #define CTX_TRFCR_EL2		U(0x1c0)
2242825946eSMax Shvetsov 
2252825946eSMax Shvetsov // Starting with Armv8.5
2267f41bcc7SZelalem Aweke #define CTX_SCXTNUM_EL2		U(0x1c8)
227cb4ec47bSjohpow01 
228cb4ec47bSjohpow01 // Register for FEAT_HCX
2297f41bcc7SZelalem Aweke #define CTX_HCRX_EL2            U(0x1d0)
230cb4ec47bSjohpow01 
231d3331603SMark Brown // Starting with Armv8.9
232d3331603SMark Brown #define CTX_TCR2_EL2            U(0x1d8)
233*062b6c6bSMark Brown #define CTX_POR_EL2             U(0x1e0)
234*062b6c6bSMark Brown #define CTX_PIRE0_EL2           U(0x1e8)
235*062b6c6bSMark Brown #define CTX_PIR_EL2             U(0x1f0)
236*062b6c6bSMark Brown #define CTX_S2PIR_EL2		U(0x1f8)
237d3331603SMark Brown 
23828f39f02SMax Shvetsov /* Align to the next 16 byte boundary */
239*062b6c6bSMark Brown #define CTX_EL2_SYSREGS_END	U(0x200)
2407f164a83SOlivier Deprez 
24128f39f02SMax Shvetsov #endif /* CTX_INCLUDE_EL2_REGS */
24228f39f02SMax Shvetsov 
243532ed618SSoby Mathew /*******************************************************************************
244532ed618SSoby Mathew  * Constants that allow assembler code to access members of and the 'fp_regs'
245532ed618SSoby Mathew  * structure at their correct offsets.
246532ed618SSoby Mathew  ******************************************************************************/
2472825946eSMax Shvetsov #if CTX_INCLUDE_EL2_REGS
2482825946eSMax Shvetsov # define CTX_FPREGS_OFFSET	(CTX_EL2_SYSREGS_OFFSET + CTX_EL2_SYSREGS_END)
2492825946eSMax Shvetsov #else
2502825946eSMax Shvetsov # define CTX_FPREGS_OFFSET	(CTX_EL1_SYSREGS_OFFSET + CTX_EL1_SYSREGS_END)
2512825946eSMax Shvetsov #endif
252fe007b2eSDimitris Papastamos #if CTX_INCLUDE_FPREGS
253030567e6SVarun Wadekar #define CTX_FP_Q0		U(0x0)
254030567e6SVarun Wadekar #define CTX_FP_Q1		U(0x10)
255030567e6SVarun Wadekar #define CTX_FP_Q2		U(0x20)
256030567e6SVarun Wadekar #define CTX_FP_Q3		U(0x30)
257030567e6SVarun Wadekar #define CTX_FP_Q4		U(0x40)
258030567e6SVarun Wadekar #define CTX_FP_Q5		U(0x50)
259030567e6SVarun Wadekar #define CTX_FP_Q6		U(0x60)
260030567e6SVarun Wadekar #define CTX_FP_Q7		U(0x70)
261030567e6SVarun Wadekar #define CTX_FP_Q8		U(0x80)
262030567e6SVarun Wadekar #define CTX_FP_Q9		U(0x90)
263030567e6SVarun Wadekar #define CTX_FP_Q10		U(0xa0)
264030567e6SVarun Wadekar #define CTX_FP_Q11		U(0xb0)
265030567e6SVarun Wadekar #define CTX_FP_Q12		U(0xc0)
266030567e6SVarun Wadekar #define CTX_FP_Q13		U(0xd0)
267030567e6SVarun Wadekar #define CTX_FP_Q14		U(0xe0)
268030567e6SVarun Wadekar #define CTX_FP_Q15		U(0xf0)
269030567e6SVarun Wadekar #define CTX_FP_Q16		U(0x100)
270030567e6SVarun Wadekar #define CTX_FP_Q17		U(0x110)
271030567e6SVarun Wadekar #define CTX_FP_Q18		U(0x120)
272030567e6SVarun Wadekar #define CTX_FP_Q19		U(0x130)
273030567e6SVarun Wadekar #define CTX_FP_Q20		U(0x140)
274030567e6SVarun Wadekar #define CTX_FP_Q21		U(0x150)
275030567e6SVarun Wadekar #define CTX_FP_Q22		U(0x160)
276030567e6SVarun Wadekar #define CTX_FP_Q23		U(0x170)
277030567e6SVarun Wadekar #define CTX_FP_Q24		U(0x180)
278030567e6SVarun Wadekar #define CTX_FP_Q25		U(0x190)
279030567e6SVarun Wadekar #define CTX_FP_Q26		U(0x1a0)
280030567e6SVarun Wadekar #define CTX_FP_Q27		U(0x1b0)
281030567e6SVarun Wadekar #define CTX_FP_Q28		U(0x1c0)
282030567e6SVarun Wadekar #define CTX_FP_Q29		U(0x1d0)
283030567e6SVarun Wadekar #define CTX_FP_Q30		U(0x1e0)
284030567e6SVarun Wadekar #define CTX_FP_Q31		U(0x1f0)
285030567e6SVarun Wadekar #define CTX_FP_FPSR		U(0x200)
286030567e6SVarun Wadekar #define CTX_FP_FPCR		U(0x208)
28791089f36SDavid Cunado #if CTX_INCLUDE_AARCH32_REGS
28891089f36SDavid Cunado #define CTX_FP_FPEXC32_EL2	U(0x210)
28991089f36SDavid Cunado #define CTX_FPREGS_END		U(0x220) /* Align to the next 16 byte boundary */
29091089f36SDavid Cunado #else
29191089f36SDavid Cunado #define CTX_FPREGS_END		U(0x210) /* Align to the next 16 byte boundary */
29291089f36SDavid Cunado #endif
293fe007b2eSDimitris Papastamos #else
294fe007b2eSDimitris Papastamos #define CTX_FPREGS_END		U(0)
295532ed618SSoby Mathew #endif
296532ed618SSoby Mathew 
2974d1ccf0eSAntonio Nino Diaz /*******************************************************************************
2984d1ccf0eSAntonio Nino Diaz  * Registers related to CVE-2018-3639
2994d1ccf0eSAntonio Nino Diaz  ******************************************************************************/
300fe007b2eSDimitris Papastamos #define CTX_CVE_2018_3639_OFFSET	(CTX_FPREGS_OFFSET + CTX_FPREGS_END)
301fe007b2eSDimitris Papastamos #define CTX_CVE_2018_3639_DISABLE	U(0)
302fe007b2eSDimitris Papastamos #define CTX_CVE_2018_3639_END		U(0x10) /* Align to the next 16 byte boundary */
303fe007b2eSDimitris Papastamos 
3045283962eSAntonio Nino Diaz /*******************************************************************************
3055283962eSAntonio Nino Diaz  * Registers related to ARMv8.3-PAuth.
3065283962eSAntonio Nino Diaz  ******************************************************************************/
3075283962eSAntonio Nino Diaz #define CTX_PAUTH_REGS_OFFSET	(CTX_CVE_2018_3639_OFFSET + CTX_CVE_2018_3639_END)
3085283962eSAntonio Nino Diaz #if CTX_INCLUDE_PAUTH_REGS
3095283962eSAntonio Nino Diaz #define CTX_PACIAKEY_LO		U(0x0)
3105283962eSAntonio Nino Diaz #define CTX_PACIAKEY_HI		U(0x8)
3115283962eSAntonio Nino Diaz #define CTX_PACIBKEY_LO		U(0x10)
3125283962eSAntonio Nino Diaz #define CTX_PACIBKEY_HI		U(0x18)
3135283962eSAntonio Nino Diaz #define CTX_PACDAKEY_LO		U(0x20)
3145283962eSAntonio Nino Diaz #define CTX_PACDAKEY_HI		U(0x28)
3155283962eSAntonio Nino Diaz #define CTX_PACDBKEY_LO		U(0x30)
3165283962eSAntonio Nino Diaz #define CTX_PACDBKEY_HI		U(0x38)
3175283962eSAntonio Nino Diaz #define CTX_PACGAKEY_LO		U(0x40)
3185283962eSAntonio Nino Diaz #define CTX_PACGAKEY_HI		U(0x48)
319ed108b56SAlexei Fedorov #define CTX_PAUTH_REGS_END	U(0x50) /* Align to the next 16 byte boundary */
3205283962eSAntonio Nino Diaz #else
3215283962eSAntonio Nino Diaz #define CTX_PAUTH_REGS_END	U(0)
3225283962eSAntonio Nino Diaz #endif /* CTX_INCLUDE_PAUTH_REGS */
3235283962eSAntonio Nino Diaz 
324d5dfdeb6SJulius Werner #ifndef __ASSEMBLER__
325532ed618SSoby Mathew 
326532ed618SSoby Mathew #include <stdint.h>
327532ed618SSoby Mathew 
32809d40e0eSAntonio Nino Diaz #include <lib/cassert.h>
32909d40e0eSAntonio Nino Diaz 
330532ed618SSoby Mathew /*
331532ed618SSoby Mathew  * Common constants to help define the 'cpu_context' structure and its
332532ed618SSoby Mathew  * members below.
333532ed618SSoby Mathew  */
334030567e6SVarun Wadekar #define DWORD_SHIFT		U(3)
335532ed618SSoby Mathew #define DEFINE_REG_STRUCT(name, num_regs)	\
336532ed618SSoby Mathew 	typedef struct name {			\
3372fe75a2dSZelalem 		uint64_t ctx_regs[num_regs];	\
338532ed618SSoby Mathew 	}  __aligned(16) name##_t
339532ed618SSoby Mathew 
340532ed618SSoby Mathew /* Constants to determine the size of individual context structures */
341532ed618SSoby Mathew #define CTX_GPREG_ALL		(CTX_GPREGS_END >> DWORD_SHIFT)
3422825946eSMax Shvetsov #define CTX_EL1_SYSREGS_ALL	(CTX_EL1_SYSREGS_END >> DWORD_SHIFT)
3432825946eSMax Shvetsov #if CTX_INCLUDE_EL2_REGS
3442825946eSMax Shvetsov # define CTX_EL2_SYSREGS_ALL	(CTX_EL2_SYSREGS_END >> DWORD_SHIFT)
3452825946eSMax Shvetsov #endif
346532ed618SSoby Mathew #if CTX_INCLUDE_FPREGS
347532ed618SSoby Mathew # define CTX_FPREG_ALL		(CTX_FPREGS_END >> DWORD_SHIFT)
348532ed618SSoby Mathew #endif
349532ed618SSoby Mathew #define CTX_EL3STATE_ALL	(CTX_EL3STATE_END >> DWORD_SHIFT)
350fe007b2eSDimitris Papastamos #define CTX_CVE_2018_3639_ALL	(CTX_CVE_2018_3639_END >> DWORD_SHIFT)
3515283962eSAntonio Nino Diaz #if CTX_INCLUDE_PAUTH_REGS
3525283962eSAntonio Nino Diaz # define CTX_PAUTH_REGS_ALL	(CTX_PAUTH_REGS_END >> DWORD_SHIFT)
3535283962eSAntonio Nino Diaz #endif
354532ed618SSoby Mathew 
355532ed618SSoby Mathew /*
356532ed618SSoby Mathew  * AArch64 general purpose register context structure. Usually x0-x18,
357532ed618SSoby Mathew  * lr are saved as the compiler is expected to preserve the remaining
358532ed618SSoby Mathew  * callee saved registers if used by the C runtime and the assembler
359532ed618SSoby Mathew  * does not touch the remaining. But in case of world switch during
360532ed618SSoby Mathew  * exception handling, we need to save the callee registers too.
361532ed618SSoby Mathew  */
362532ed618SSoby Mathew DEFINE_REG_STRUCT(gp_regs, CTX_GPREG_ALL);
363532ed618SSoby Mathew 
364532ed618SSoby Mathew /*
3652825946eSMax Shvetsov  * AArch64 EL1 system register context structure for preserving the
36628f39f02SMax Shvetsov  * architectural state during world switches.
367532ed618SSoby Mathew  */
3682825946eSMax Shvetsov DEFINE_REG_STRUCT(el1_sysregs, CTX_EL1_SYSREGS_ALL);
3692825946eSMax Shvetsov 
3702825946eSMax Shvetsov 
3712825946eSMax Shvetsov /*
3722825946eSMax Shvetsov  * AArch64 EL2 system register context structure for preserving the
3732825946eSMax Shvetsov  * architectural state during world switches.
3742825946eSMax Shvetsov  */
3752825946eSMax Shvetsov #if CTX_INCLUDE_EL2_REGS
3762825946eSMax Shvetsov DEFINE_REG_STRUCT(el2_sysregs, CTX_EL2_SYSREGS_ALL);
3772825946eSMax Shvetsov #endif
378532ed618SSoby Mathew 
379532ed618SSoby Mathew /*
380532ed618SSoby Mathew  * AArch64 floating point register context structure for preserving
381532ed618SSoby Mathew  * the floating point state during switches from one security state to
382532ed618SSoby Mathew  * another.
383532ed618SSoby Mathew  */
384532ed618SSoby Mathew #if CTX_INCLUDE_FPREGS
385532ed618SSoby Mathew DEFINE_REG_STRUCT(fp_regs, CTX_FPREG_ALL);
386532ed618SSoby Mathew #endif
387532ed618SSoby Mathew 
388532ed618SSoby Mathew /*
389532ed618SSoby Mathew  * Miscellaneous registers used by EL3 firmware to maintain its state
390532ed618SSoby Mathew  * across exception entries and exits
391532ed618SSoby Mathew  */
392532ed618SSoby Mathew DEFINE_REG_STRUCT(el3_state, CTX_EL3STATE_ALL);
393532ed618SSoby Mathew 
394fe007b2eSDimitris Papastamos /* Function pointer used by CVE-2018-3639 dynamic mitigation */
395fe007b2eSDimitris Papastamos DEFINE_REG_STRUCT(cve_2018_3639, CTX_CVE_2018_3639_ALL);
396fe007b2eSDimitris Papastamos 
3975283962eSAntonio Nino Diaz /* Registers associated to ARMv8.3-PAuth */
3985283962eSAntonio Nino Diaz #if CTX_INCLUDE_PAUTH_REGS
3995283962eSAntonio Nino Diaz DEFINE_REG_STRUCT(pauth, CTX_PAUTH_REGS_ALL);
4005283962eSAntonio Nino Diaz #endif
4015283962eSAntonio Nino Diaz 
402532ed618SSoby Mathew /*
403532ed618SSoby Mathew  * Macros to access members of any of the above structures using their
404532ed618SSoby Mathew  * offsets
405532ed618SSoby Mathew  */
4062fe75a2dSZelalem #define read_ctx_reg(ctx, offset)	((ctx)->ctx_regs[(offset) >> DWORD_SHIFT])
4072fe75a2dSZelalem #define write_ctx_reg(ctx, offset, val)	(((ctx)->ctx_regs[(offset) >> DWORD_SHIFT]) \
408ba6e5ca6SJeenu Viswambharan 					 = (uint64_t) (val))
409532ed618SSoby Mathew 
410532ed618SSoby Mathew /*
411c5ea4f8aSZelalem Aweke  * Top-level context structure which is used by EL3 firmware to preserve
412c5ea4f8aSZelalem Aweke  * the state of a core at the next lower EL in a given security state and
413c5ea4f8aSZelalem Aweke  * save enough EL3 meta data to be able to return to that EL and security
414c5ea4f8aSZelalem Aweke  * state. The context management library will be used to ensure that
415c5ea4f8aSZelalem Aweke  * SP_EL3 always points to an instance of this structure at exception
416c5ea4f8aSZelalem Aweke  * entry and exit.
417532ed618SSoby Mathew  */
418532ed618SSoby Mathew typedef struct cpu_context {
419532ed618SSoby Mathew 	gp_regs_t gpregs_ctx;
420532ed618SSoby Mathew 	el3_state_t el3state_ctx;
4212825946eSMax Shvetsov 	el1_sysregs_t el1_sysregs_ctx;
4222825946eSMax Shvetsov #if CTX_INCLUDE_EL2_REGS
4232825946eSMax Shvetsov 	el2_sysregs_t el2_sysregs_ctx;
4242825946eSMax Shvetsov #endif
425532ed618SSoby Mathew #if CTX_INCLUDE_FPREGS
426532ed618SSoby Mathew 	fp_regs_t fpregs_ctx;
427532ed618SSoby Mathew #endif
428fe007b2eSDimitris Papastamos 	cve_2018_3639_t cve_2018_3639_ctx;
4295283962eSAntonio Nino Diaz #if CTX_INCLUDE_PAUTH_REGS
4305283962eSAntonio Nino Diaz 	pauth_t pauth_ctx;
4315283962eSAntonio Nino Diaz #endif
432532ed618SSoby Mathew } cpu_context_t;
433532ed618SSoby Mathew 
434532ed618SSoby Mathew /* Macros to access members of the 'cpu_context_t' structure */
435532ed618SSoby Mathew #define get_el3state_ctx(h)	(&((cpu_context_t *) h)->el3state_ctx)
436532ed618SSoby Mathew #if CTX_INCLUDE_FPREGS
437532ed618SSoby Mathew # define get_fpregs_ctx(h)	(&((cpu_context_t *) h)->fpregs_ctx)
438532ed618SSoby Mathew #endif
4392825946eSMax Shvetsov #define get_el1_sysregs_ctx(h)	(&((cpu_context_t *) h)->el1_sysregs_ctx)
4402825946eSMax Shvetsov #if CTX_INCLUDE_EL2_REGS
4412825946eSMax Shvetsov # define get_el2_sysregs_ctx(h)	(&((cpu_context_t *) h)->el2_sysregs_ctx)
4422825946eSMax Shvetsov #endif
443532ed618SSoby Mathew #define get_gpregs_ctx(h)	(&((cpu_context_t *) h)->gpregs_ctx)
4446f03bc77SDimitris Papastamos #define get_cve_2018_3639_ctx(h)	(&((cpu_context_t *) h)->cve_2018_3639_ctx)
4455283962eSAntonio Nino Diaz #if CTX_INCLUDE_PAUTH_REGS
4465283962eSAntonio Nino Diaz # define get_pauth_ctx(h)	(&((cpu_context_t *) h)->pauth_ctx)
4475283962eSAntonio Nino Diaz #endif
448532ed618SSoby Mathew 
449532ed618SSoby Mathew /*
450532ed618SSoby Mathew  * Compile time assertions related to the 'cpu_context' structure to
451532ed618SSoby Mathew  * ensure that the assembler and the compiler view of the offsets of
452532ed618SSoby Mathew  * the structure members is the same.
453532ed618SSoby Mathew  */
4549a90d720SElyes Haouas CASSERT(CTX_GPREGS_OFFSET == __builtin_offsetof(cpu_context_t, gpregs_ctx),
455532ed618SSoby Mathew 	assert_core_context_gp_offset_mismatch);
4569a90d720SElyes Haouas CASSERT(CTX_EL1_SYSREGS_OFFSET == __builtin_offsetof(cpu_context_t, el1_sysregs_ctx),
4572825946eSMax Shvetsov 	assert_core_context_el1_sys_offset_mismatch);
4582825946eSMax Shvetsov #if CTX_INCLUDE_EL2_REGS
4599a90d720SElyes Haouas CASSERT(CTX_EL2_SYSREGS_OFFSET == __builtin_offsetof(cpu_context_t, el2_sysregs_ctx),
4602825946eSMax Shvetsov 	assert_core_context_el2_sys_offset_mismatch);
4612825946eSMax Shvetsov #endif
462532ed618SSoby Mathew #if CTX_INCLUDE_FPREGS
4639a90d720SElyes Haouas CASSERT(CTX_FPREGS_OFFSET == __builtin_offsetof(cpu_context_t, fpregs_ctx),
464532ed618SSoby Mathew 	assert_core_context_fp_offset_mismatch);
465532ed618SSoby Mathew #endif
4669a90d720SElyes Haouas CASSERT(CTX_EL3STATE_OFFSET == __builtin_offsetof(cpu_context_t, el3state_ctx),
467532ed618SSoby Mathew 	assert_core_context_el3state_offset_mismatch);
4689a90d720SElyes Haouas CASSERT(CTX_CVE_2018_3639_OFFSET == __builtin_offsetof(cpu_context_t, cve_2018_3639_ctx),
469fe007b2eSDimitris Papastamos 	assert_core_context_cve_2018_3639_offset_mismatch);
4705283962eSAntonio Nino Diaz #if CTX_INCLUDE_PAUTH_REGS
4719a90d720SElyes Haouas CASSERT(CTX_PAUTH_REGS_OFFSET == __builtin_offsetof(cpu_context_t, pauth_ctx),
4725283962eSAntonio Nino Diaz 	assert_core_context_pauth_offset_mismatch);
4735283962eSAntonio Nino Diaz #endif
474532ed618SSoby Mathew 
475532ed618SSoby Mathew /*
476532ed618SSoby Mathew  * Helper macro to set the general purpose registers that correspond to
477532ed618SSoby Mathew  * parameters in an aapcs_64 call i.e. x0-x7
478532ed618SSoby Mathew  */
479532ed618SSoby Mathew #define set_aapcs_args0(ctx, x0)				do {	\
480532ed618SSoby Mathew 		write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X0, x0);	\
481532ed618SSoby Mathew 	} while (0)
482532ed618SSoby Mathew #define set_aapcs_args1(ctx, x0, x1)				do {	\
483532ed618SSoby Mathew 		write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X1, x1);	\
484532ed618SSoby Mathew 		set_aapcs_args0(ctx, x0);				\
485532ed618SSoby Mathew 	} while (0)
486532ed618SSoby Mathew #define set_aapcs_args2(ctx, x0, x1, x2)			do {	\
487532ed618SSoby Mathew 		write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X2, x2);	\
488532ed618SSoby Mathew 		set_aapcs_args1(ctx, x0, x1);				\
489532ed618SSoby Mathew 	} while (0)
490532ed618SSoby Mathew #define set_aapcs_args3(ctx, x0, x1, x2, x3)			do {	\
491532ed618SSoby Mathew 		write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X3, x3);	\
492532ed618SSoby Mathew 		set_aapcs_args2(ctx, x0, x1, x2);			\
493532ed618SSoby Mathew 	} while (0)
494532ed618SSoby Mathew #define set_aapcs_args4(ctx, x0, x1, x2, x3, x4)		do {	\
495532ed618SSoby Mathew 		write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X4, x4);	\
496532ed618SSoby Mathew 		set_aapcs_args3(ctx, x0, x1, x2, x3);			\
497532ed618SSoby Mathew 	} while (0)
498532ed618SSoby Mathew #define set_aapcs_args5(ctx, x0, x1, x2, x3, x4, x5)		do {	\
499532ed618SSoby Mathew 		write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X5, x5);	\
500532ed618SSoby Mathew 		set_aapcs_args4(ctx, x0, x1, x2, x3, x4);		\
501532ed618SSoby Mathew 	} while (0)
502532ed618SSoby Mathew #define set_aapcs_args6(ctx, x0, x1, x2, x3, x4, x5, x6)	do {	\
503532ed618SSoby Mathew 		write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X6, x6);	\
504532ed618SSoby Mathew 		set_aapcs_args5(ctx, x0, x1, x2, x3, x4, x5);		\
505532ed618SSoby Mathew 	} while (0)
506532ed618SSoby Mathew #define set_aapcs_args7(ctx, x0, x1, x2, x3, x4, x5, x6, x7)	do {	\
507532ed618SSoby Mathew 		write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X7, x7);	\
508532ed618SSoby Mathew 		set_aapcs_args6(ctx, x0, x1, x2, x3, x4, x5, x6);	\
509532ed618SSoby Mathew 	} while (0)
510532ed618SSoby Mathew 
511532ed618SSoby Mathew /*******************************************************************************
512532ed618SSoby Mathew  * Function prototypes
513532ed618SSoby Mathew  ******************************************************************************/
5142825946eSMax Shvetsov void el1_sysregs_context_save(el1_sysregs_t *regs);
5152825946eSMax Shvetsov void el1_sysregs_context_restore(el1_sysregs_t *regs);
51628f39f02SMax Shvetsov 
51728f39f02SMax Shvetsov #if CTX_INCLUDE_EL2_REGS
518d20052f3SZelalem Aweke void el2_sysregs_context_save_common(el2_sysregs_t *regs);
519d20052f3SZelalem Aweke void el2_sysregs_context_restore_common(el2_sysregs_t *regs);
520d20052f3SZelalem Aweke #if CTX_INCLUDE_MTE_REGS
521d20052f3SZelalem Aweke void el2_sysregs_context_save_mte(el2_sysregs_t *regs);
522d20052f3SZelalem Aweke void el2_sysregs_context_restore_mte(el2_sysregs_t *regs);
523d20052f3SZelalem Aweke #endif /* CTX_INCLUDE_MTE_REGS */
524d20052f3SZelalem Aweke #if RAS_EXTENSION
525d20052f3SZelalem Aweke void el2_sysregs_context_save_ras(el2_sysregs_t *regs);
526d20052f3SZelalem Aweke void el2_sysregs_context_restore_ras(el2_sysregs_t *regs);
527d20052f3SZelalem Aweke #endif /* RAS_EXTENSION */
528d20052f3SZelalem Aweke #endif /* CTX_INCLUDE_EL2_REGS */
52928f39f02SMax Shvetsov 
530532ed618SSoby Mathew #if CTX_INCLUDE_FPREGS
531532ed618SSoby Mathew void fpregs_context_save(fp_regs_t *regs);
532532ed618SSoby Mathew void fpregs_context_restore(fp_regs_t *regs);
533532ed618SSoby Mathew #endif
534532ed618SSoby Mathew 
535d5dfdeb6SJulius Werner #endif /* __ASSEMBLER__ */
536532ed618SSoby Mathew 
537a0fee747SAntonio Nino Diaz #endif /* CONTEXT_H */
538