xref: /rk3399_ARM-atf/include/lib/el3_runtime/aarch64/context.h (revision a7cf2743f3eb487912302aafc748c81bbd1fc603)
1532ed618SSoby Mathew /*
2c2d32a5fSMadhukar Pappireddy  * Copyright (c) 2013-2021, 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)
64c2d32a5fSMadhukar Pappireddy #define CTX_EL3STATE_END	U(0x40) /* Align to the next 16 byte boundary */
65532ed618SSoby Mathew 
66532ed618SSoby Mathew /*******************************************************************************
67532ed618SSoby Mathew  * Constants that allow assembler code to access members of and the
68532ed618SSoby Mathew  * 'el1_sys_regs' structure at their correct offsets. Note that some of the
69532ed618SSoby Mathew  * registers are only 32-bits wide but are stored as 64-bit values for
70532ed618SSoby Mathew  * convenience
71532ed618SSoby Mathew  ******************************************************************************/
722825946eSMax Shvetsov #define CTX_EL1_SYSREGS_OFFSET	(CTX_EL3STATE_OFFSET + CTX_EL3STATE_END)
73030567e6SVarun Wadekar #define CTX_SPSR_EL1		U(0x0)
74030567e6SVarun Wadekar #define CTX_ELR_EL1		U(0x8)
75030567e6SVarun Wadekar #define CTX_SCTLR_EL1		U(0x10)
76cb55615cSManish V Badarkhe #define CTX_TCR_EL1		U(0x18)
77030567e6SVarun Wadekar #define CTX_CPACR_EL1		U(0x20)
78030567e6SVarun Wadekar #define CTX_CSSELR_EL1		U(0x28)
79030567e6SVarun Wadekar #define CTX_SP_EL1		U(0x30)
80030567e6SVarun Wadekar #define CTX_ESR_EL1		U(0x38)
81030567e6SVarun Wadekar #define CTX_TTBR0_EL1		U(0x40)
82030567e6SVarun Wadekar #define CTX_TTBR1_EL1		U(0x48)
83030567e6SVarun Wadekar #define CTX_MAIR_EL1		U(0x50)
84030567e6SVarun Wadekar #define CTX_AMAIR_EL1		U(0x58)
85cb55615cSManish V Badarkhe #define CTX_ACTLR_EL1		U(0x60)
86030567e6SVarun Wadekar #define CTX_TPIDR_EL1		U(0x68)
87030567e6SVarun Wadekar #define CTX_TPIDR_EL0		U(0x70)
88030567e6SVarun Wadekar #define CTX_TPIDRRO_EL0		U(0x78)
89030567e6SVarun Wadekar #define CTX_PAR_EL1		U(0x80)
90030567e6SVarun Wadekar #define CTX_FAR_EL1		U(0x88)
91030567e6SVarun Wadekar #define CTX_AFSR0_EL1		U(0x90)
92030567e6SVarun Wadekar #define CTX_AFSR1_EL1		U(0x98)
93030567e6SVarun Wadekar #define CTX_CONTEXTIDR_EL1	U(0xa0)
94030567e6SVarun Wadekar #define CTX_VBAR_EL1		U(0xa8)
95532ed618SSoby Mathew 
96532ed618SSoby Mathew /*
97532ed618SSoby Mathew  * If the platform is AArch64-only, there is no need to save and restore these
98532ed618SSoby Mathew  * AArch32 registers.
99532ed618SSoby Mathew  */
100532ed618SSoby Mathew #if CTX_INCLUDE_AARCH32_REGS
101e290a8fcSAlexei Fedorov #define CTX_SPSR_ABT		U(0xb0)	/* Align to the next 16 byte boundary */
102e290a8fcSAlexei Fedorov #define CTX_SPSR_UND		U(0xb8)
103e290a8fcSAlexei Fedorov #define CTX_SPSR_IRQ		U(0xc0)
104e290a8fcSAlexei Fedorov #define CTX_SPSR_FIQ		U(0xc8)
105e290a8fcSAlexei Fedorov #define CTX_DACR32_EL2		U(0xd0)
106e290a8fcSAlexei Fedorov #define CTX_IFSR32_EL2		U(0xd8)
107e290a8fcSAlexei Fedorov #define CTX_AARCH32_END		U(0xe0) /* Align to the next 16 byte boundary */
108532ed618SSoby Mathew #else
109e290a8fcSAlexei Fedorov #define CTX_AARCH32_END		U(0xb0)	/* Align to the next 16 byte boundary */
1104d1ccf0eSAntonio Nino Diaz #endif /* CTX_INCLUDE_AARCH32_REGS */
111532ed618SSoby Mathew 
112532ed618SSoby Mathew /*
113532ed618SSoby Mathew  * If the timer registers aren't saved and restored, we don't have to reserve
114532ed618SSoby Mathew  * space for them in the context
115532ed618SSoby Mathew  */
116532ed618SSoby Mathew #if NS_TIMER_SWITCH
1174d1ccf0eSAntonio Nino Diaz #define CTX_CNTP_CTL_EL0	(CTX_AARCH32_END + U(0x0))
1184d1ccf0eSAntonio Nino Diaz #define CTX_CNTP_CVAL_EL0	(CTX_AARCH32_END + U(0x8))
1194d1ccf0eSAntonio Nino Diaz #define CTX_CNTV_CTL_EL0	(CTX_AARCH32_END + U(0x10))
1204d1ccf0eSAntonio Nino Diaz #define CTX_CNTV_CVAL_EL0	(CTX_AARCH32_END + U(0x18))
1214d1ccf0eSAntonio Nino Diaz #define CTX_CNTKCTL_EL1		(CTX_AARCH32_END + U(0x20))
1224d1ccf0eSAntonio Nino Diaz #define CTX_TIMER_SYSREGS_END	(CTX_AARCH32_END + U(0x30)) /* Align to the next 16 byte boundary */
123532ed618SSoby Mathew #else
1244d1ccf0eSAntonio Nino Diaz #define CTX_TIMER_SYSREGS_END	CTX_AARCH32_END
1254d1ccf0eSAntonio Nino Diaz #endif /* NS_TIMER_SWITCH */
1264d1ccf0eSAntonio Nino Diaz 
1279dd94382SJustin Chadwell #if CTX_INCLUDE_MTE_REGS
1289dd94382SJustin Chadwell #define CTX_TFSRE0_EL1		(CTX_TIMER_SYSREGS_END + U(0x0))
1299dd94382SJustin Chadwell #define CTX_TFSR_EL1		(CTX_TIMER_SYSREGS_END + U(0x8))
1309dd94382SJustin Chadwell #define CTX_RGSR_EL1		(CTX_TIMER_SYSREGS_END + U(0x10))
1319dd94382SJustin Chadwell #define CTX_GCR_EL1		(CTX_TIMER_SYSREGS_END + U(0x18))
1329dd94382SJustin Chadwell 
1339dd94382SJustin Chadwell /* Align to the next 16 byte boundary */
1349dd94382SJustin Chadwell #define CTX_MTE_REGS_END	(CTX_TIMER_SYSREGS_END + U(0x20))
1359dd94382SJustin Chadwell #else
1369dd94382SJustin Chadwell #define CTX_MTE_REGS_END	CTX_TIMER_SYSREGS_END
1379dd94382SJustin Chadwell #endif /* CTX_INCLUDE_MTE_REGS */
1389dd94382SJustin Chadwell 
1394d1ccf0eSAntonio Nino Diaz /*
1402825946eSMax Shvetsov  * End of system registers.
1412825946eSMax Shvetsov  */
1422825946eSMax Shvetsov #define CTX_EL1_SYSREGS_END		CTX_MTE_REGS_END
1432825946eSMax Shvetsov 
1442825946eSMax Shvetsov /*
1452825946eSMax Shvetsov  * EL2 register set
14628f39f02SMax Shvetsov  */
14728f39f02SMax Shvetsov 
14828f39f02SMax Shvetsov #if CTX_INCLUDE_EL2_REGS
14928f39f02SMax Shvetsov /* For later discussion
15028f39f02SMax Shvetsov  * ICH_AP0R<n>_EL2
15128f39f02SMax Shvetsov  * ICH_AP1R<n>_EL2
15228f39f02SMax Shvetsov  * AMEVCNTVOFF0<n>_EL2
15328f39f02SMax Shvetsov  * AMEVCNTVOFF1<n>_EL2
15428f39f02SMax Shvetsov  * ICH_LR<n>_EL2
15528f39f02SMax Shvetsov  */
1562825946eSMax Shvetsov #define CTX_EL2_SYSREGS_OFFSET	(CTX_EL1_SYSREGS_OFFSET + CTX_EL1_SYSREGS_END)
15728f39f02SMax Shvetsov 
1582825946eSMax Shvetsov #define CTX_ACTLR_EL2		U(0x0)
1592825946eSMax Shvetsov #define CTX_AFSR0_EL2		U(0x8)
1602825946eSMax Shvetsov #define CTX_AFSR1_EL2		U(0x10)
1612825946eSMax Shvetsov #define CTX_AMAIR_EL2		U(0x18)
1622825946eSMax Shvetsov #define CTX_CNTHCTL_EL2		U(0x20)
163*a7cf2743SMax Shvetsov #define CTX_CNTVOFF_EL2		U(0x28)
164*a7cf2743SMax Shvetsov #define CTX_CPTR_EL2		U(0x30)
165*a7cf2743SMax Shvetsov #define CTX_DBGVCR32_EL2	U(0x38)
166*a7cf2743SMax Shvetsov #define CTX_ELR_EL2		U(0x40)
167*a7cf2743SMax Shvetsov #define CTX_ESR_EL2		U(0x48)
168*a7cf2743SMax Shvetsov #define CTX_FAR_EL2		U(0x50)
169*a7cf2743SMax Shvetsov #define CTX_HACR_EL2		U(0x58)
170*a7cf2743SMax Shvetsov #define CTX_HCR_EL2		U(0x60)
171*a7cf2743SMax Shvetsov #define CTX_HPFAR_EL2		U(0x68)
172*a7cf2743SMax Shvetsov #define CTX_HSTR_EL2		U(0x70)
173*a7cf2743SMax Shvetsov #define CTX_ICC_SRE_EL2		U(0x78)
174*a7cf2743SMax Shvetsov #define CTX_ICH_HCR_EL2		U(0x80)
175*a7cf2743SMax Shvetsov #define CTX_ICH_VMCR_EL2	U(0x88)
176*a7cf2743SMax Shvetsov #define CTX_MAIR_EL2		U(0x90)
177*a7cf2743SMax Shvetsov #define CTX_MDCR_EL2		U(0x98)
178*a7cf2743SMax Shvetsov #define CTX_PMSCR_EL2		U(0xa0)
179*a7cf2743SMax Shvetsov #define CTX_SCTLR_EL2		U(0xa8)
180*a7cf2743SMax Shvetsov #define CTX_SPSR_EL2		U(0xb0)
181*a7cf2743SMax Shvetsov #define CTX_SP_EL2		U(0xb8)
182*a7cf2743SMax Shvetsov #define CTX_TCR_EL2		U(0xc0)
183*a7cf2743SMax Shvetsov #define CTX_TPIDR_EL2		U(0xc8)
184*a7cf2743SMax Shvetsov #define CTX_TTBR0_EL2		U(0xd0)
185*a7cf2743SMax Shvetsov #define CTX_VBAR_EL2		U(0xd8)
186*a7cf2743SMax Shvetsov #define CTX_VMPIDR_EL2		U(0xe0)
187*a7cf2743SMax Shvetsov #define CTX_VPIDR_EL2		U(0xe8)
188*a7cf2743SMax Shvetsov #define CTX_VTCR_EL2		U(0xf0)
189*a7cf2743SMax Shvetsov #define CTX_VTTBR_EL2		U(0xf8)
1902825946eSMax Shvetsov 
1912825946eSMax Shvetsov // Only if MTE registers in use
192*a7cf2743SMax Shvetsov #define CTX_TFSR_EL2		U(0x100)
1932825946eSMax Shvetsov 
1942825946eSMax Shvetsov // Only if ENABLE_MPAM_FOR_LOWER_ELS==1
195*a7cf2743SMax Shvetsov #define CTX_MPAM2_EL2		U(0x108)
196*a7cf2743SMax Shvetsov #define CTX_MPAMHCR_EL2		U(0x110)
197*a7cf2743SMax Shvetsov #define CTX_MPAMVPM0_EL2	U(0x118)
198*a7cf2743SMax Shvetsov #define CTX_MPAMVPM1_EL2	U(0x120)
199*a7cf2743SMax Shvetsov #define CTX_MPAMVPM2_EL2	U(0x128)
200*a7cf2743SMax Shvetsov #define CTX_MPAMVPM3_EL2	U(0x130)
201*a7cf2743SMax Shvetsov #define CTX_MPAMVPM4_EL2	U(0x138)
202*a7cf2743SMax Shvetsov #define CTX_MPAMVPM5_EL2	U(0x140)
203*a7cf2743SMax Shvetsov #define CTX_MPAMVPM6_EL2	U(0x148)
204*a7cf2743SMax Shvetsov #define CTX_MPAMVPM7_EL2	U(0x150)
205*a7cf2743SMax Shvetsov #define CTX_MPAMVPMV_EL2	U(0x158)
2062825946eSMax Shvetsov 
2072825946eSMax Shvetsov // Starting with Armv8.6
208*a7cf2743SMax Shvetsov #define CTX_HAFGRTR_EL2		U(0x160)
209*a7cf2743SMax Shvetsov #define CTX_HDFGRTR_EL2		U(0x168)
210*a7cf2743SMax Shvetsov #define CTX_HDFGWTR_EL2		U(0x170)
211*a7cf2743SMax Shvetsov #define CTX_HFGITR_EL2		U(0x178)
212*a7cf2743SMax Shvetsov #define CTX_HFGRTR_EL2		U(0x180)
213*a7cf2743SMax Shvetsov #define CTX_HFGWTR_EL2		U(0x188)
214*a7cf2743SMax Shvetsov #define CTX_CNTPOFF_EL2		U(0x190)
2152825946eSMax Shvetsov 
2162825946eSMax Shvetsov // Starting with Armv8.4
217*a7cf2743SMax Shvetsov #define CTX_CONTEXTIDR_EL2	U(0x198)
218*a7cf2743SMax Shvetsov #define CTX_SDER32_EL2		U(0x1a0)
219*a7cf2743SMax Shvetsov #define CTX_TTBR1_EL2		U(0x1a8)
220*a7cf2743SMax Shvetsov #define CTX_VDISR_EL2		U(0x1b0)
221*a7cf2743SMax Shvetsov #define CTX_VNCR_EL2		U(0x1b8)
222*a7cf2743SMax Shvetsov #define CTX_VSESR_EL2		U(0x1c0)
223*a7cf2743SMax Shvetsov #define CTX_VSTCR_EL2		U(0x1c8)
224*a7cf2743SMax Shvetsov #define CTX_VSTTBR_EL2		U(0x1d0)
225*a7cf2743SMax Shvetsov #define CTX_TRFCR_EL2		U(0x1d8)
2262825946eSMax Shvetsov 
2272825946eSMax Shvetsov // Starting with Armv8.5
228*a7cf2743SMax Shvetsov #define CTX_SCXTNUM_EL2		U(0x1e0)
22928f39f02SMax Shvetsov /* Align to the next 16 byte boundary */
230*a7cf2743SMax Shvetsov #define CTX_EL2_SYSREGS_END	U(0x1f0)
2317f164a83SOlivier Deprez 
23228f39f02SMax Shvetsov #endif /* CTX_INCLUDE_EL2_REGS */
23328f39f02SMax Shvetsov 
234532ed618SSoby Mathew /*******************************************************************************
235532ed618SSoby Mathew  * Constants that allow assembler code to access members of and the 'fp_regs'
236532ed618SSoby Mathew  * structure at their correct offsets.
237532ed618SSoby Mathew  ******************************************************************************/
2382825946eSMax Shvetsov #if CTX_INCLUDE_EL2_REGS
2392825946eSMax Shvetsov # define CTX_FPREGS_OFFSET	(CTX_EL2_SYSREGS_OFFSET + CTX_EL2_SYSREGS_END)
2402825946eSMax Shvetsov #else
2412825946eSMax Shvetsov # define CTX_FPREGS_OFFSET	(CTX_EL1_SYSREGS_OFFSET + CTX_EL1_SYSREGS_END)
2422825946eSMax Shvetsov #endif
243fe007b2eSDimitris Papastamos #if CTX_INCLUDE_FPREGS
244030567e6SVarun Wadekar #define CTX_FP_Q0		U(0x0)
245030567e6SVarun Wadekar #define CTX_FP_Q1		U(0x10)
246030567e6SVarun Wadekar #define CTX_FP_Q2		U(0x20)
247030567e6SVarun Wadekar #define CTX_FP_Q3		U(0x30)
248030567e6SVarun Wadekar #define CTX_FP_Q4		U(0x40)
249030567e6SVarun Wadekar #define CTX_FP_Q5		U(0x50)
250030567e6SVarun Wadekar #define CTX_FP_Q6		U(0x60)
251030567e6SVarun Wadekar #define CTX_FP_Q7		U(0x70)
252030567e6SVarun Wadekar #define CTX_FP_Q8		U(0x80)
253030567e6SVarun Wadekar #define CTX_FP_Q9		U(0x90)
254030567e6SVarun Wadekar #define CTX_FP_Q10		U(0xa0)
255030567e6SVarun Wadekar #define CTX_FP_Q11		U(0xb0)
256030567e6SVarun Wadekar #define CTX_FP_Q12		U(0xc0)
257030567e6SVarun Wadekar #define CTX_FP_Q13		U(0xd0)
258030567e6SVarun Wadekar #define CTX_FP_Q14		U(0xe0)
259030567e6SVarun Wadekar #define CTX_FP_Q15		U(0xf0)
260030567e6SVarun Wadekar #define CTX_FP_Q16		U(0x100)
261030567e6SVarun Wadekar #define CTX_FP_Q17		U(0x110)
262030567e6SVarun Wadekar #define CTX_FP_Q18		U(0x120)
263030567e6SVarun Wadekar #define CTX_FP_Q19		U(0x130)
264030567e6SVarun Wadekar #define CTX_FP_Q20		U(0x140)
265030567e6SVarun Wadekar #define CTX_FP_Q21		U(0x150)
266030567e6SVarun Wadekar #define CTX_FP_Q22		U(0x160)
267030567e6SVarun Wadekar #define CTX_FP_Q23		U(0x170)
268030567e6SVarun Wadekar #define CTX_FP_Q24		U(0x180)
269030567e6SVarun Wadekar #define CTX_FP_Q25		U(0x190)
270030567e6SVarun Wadekar #define CTX_FP_Q26		U(0x1a0)
271030567e6SVarun Wadekar #define CTX_FP_Q27		U(0x1b0)
272030567e6SVarun Wadekar #define CTX_FP_Q28		U(0x1c0)
273030567e6SVarun Wadekar #define CTX_FP_Q29		U(0x1d0)
274030567e6SVarun Wadekar #define CTX_FP_Q30		U(0x1e0)
275030567e6SVarun Wadekar #define CTX_FP_Q31		U(0x1f0)
276030567e6SVarun Wadekar #define CTX_FP_FPSR		U(0x200)
277030567e6SVarun Wadekar #define CTX_FP_FPCR		U(0x208)
27891089f36SDavid Cunado #if CTX_INCLUDE_AARCH32_REGS
27991089f36SDavid Cunado #define CTX_FP_FPEXC32_EL2	U(0x210)
28091089f36SDavid Cunado #define CTX_FPREGS_END		U(0x220) /* Align to the next 16 byte boundary */
28191089f36SDavid Cunado #else
28291089f36SDavid Cunado #define CTX_FPREGS_END		U(0x210) /* Align to the next 16 byte boundary */
28391089f36SDavid Cunado #endif
284fe007b2eSDimitris Papastamos #else
285fe007b2eSDimitris Papastamos #define CTX_FPREGS_END		U(0)
286532ed618SSoby Mathew #endif
287532ed618SSoby Mathew 
2884d1ccf0eSAntonio Nino Diaz /*******************************************************************************
2894d1ccf0eSAntonio Nino Diaz  * Registers related to CVE-2018-3639
2904d1ccf0eSAntonio Nino Diaz  ******************************************************************************/
291fe007b2eSDimitris Papastamos #define CTX_CVE_2018_3639_OFFSET	(CTX_FPREGS_OFFSET + CTX_FPREGS_END)
292fe007b2eSDimitris Papastamos #define CTX_CVE_2018_3639_DISABLE	U(0)
293fe007b2eSDimitris Papastamos #define CTX_CVE_2018_3639_END		U(0x10) /* Align to the next 16 byte boundary */
294fe007b2eSDimitris Papastamos 
2955283962eSAntonio Nino Diaz /*******************************************************************************
2965283962eSAntonio Nino Diaz  * Registers related to ARMv8.3-PAuth.
2975283962eSAntonio Nino Diaz  ******************************************************************************/
2985283962eSAntonio Nino Diaz #define CTX_PAUTH_REGS_OFFSET	(CTX_CVE_2018_3639_OFFSET + CTX_CVE_2018_3639_END)
2995283962eSAntonio Nino Diaz #if CTX_INCLUDE_PAUTH_REGS
3005283962eSAntonio Nino Diaz #define CTX_PACIAKEY_LO		U(0x0)
3015283962eSAntonio Nino Diaz #define CTX_PACIAKEY_HI		U(0x8)
3025283962eSAntonio Nino Diaz #define CTX_PACIBKEY_LO		U(0x10)
3035283962eSAntonio Nino Diaz #define CTX_PACIBKEY_HI		U(0x18)
3045283962eSAntonio Nino Diaz #define CTX_PACDAKEY_LO		U(0x20)
3055283962eSAntonio Nino Diaz #define CTX_PACDAKEY_HI		U(0x28)
3065283962eSAntonio Nino Diaz #define CTX_PACDBKEY_LO		U(0x30)
3075283962eSAntonio Nino Diaz #define CTX_PACDBKEY_HI		U(0x38)
3085283962eSAntonio Nino Diaz #define CTX_PACGAKEY_LO		U(0x40)
3095283962eSAntonio Nino Diaz #define CTX_PACGAKEY_HI		U(0x48)
310ed108b56SAlexei Fedorov #define CTX_PAUTH_REGS_END	U(0x50) /* Align to the next 16 byte boundary */
3115283962eSAntonio Nino Diaz #else
3125283962eSAntonio Nino Diaz #define CTX_PAUTH_REGS_END	U(0)
3135283962eSAntonio Nino Diaz #endif /* CTX_INCLUDE_PAUTH_REGS */
3145283962eSAntonio Nino Diaz 
315d5dfdeb6SJulius Werner #ifndef __ASSEMBLER__
316532ed618SSoby Mathew 
317532ed618SSoby Mathew #include <stdint.h>
318532ed618SSoby Mathew 
31909d40e0eSAntonio Nino Diaz #include <lib/cassert.h>
32009d40e0eSAntonio Nino Diaz 
321532ed618SSoby Mathew /*
322532ed618SSoby Mathew  * Common constants to help define the 'cpu_context' structure and its
323532ed618SSoby Mathew  * members below.
324532ed618SSoby Mathew  */
325030567e6SVarun Wadekar #define DWORD_SHIFT		U(3)
326532ed618SSoby Mathew #define DEFINE_REG_STRUCT(name, num_regs)	\
327532ed618SSoby Mathew 	typedef struct name {			\
3282fe75a2dSZelalem 		uint64_t ctx_regs[num_regs];	\
329532ed618SSoby Mathew 	}  __aligned(16) name##_t
330532ed618SSoby Mathew 
331532ed618SSoby Mathew /* Constants to determine the size of individual context structures */
332532ed618SSoby Mathew #define CTX_GPREG_ALL		(CTX_GPREGS_END >> DWORD_SHIFT)
3332825946eSMax Shvetsov #define CTX_EL1_SYSREGS_ALL	(CTX_EL1_SYSREGS_END >> DWORD_SHIFT)
3342825946eSMax Shvetsov #if CTX_INCLUDE_EL2_REGS
3352825946eSMax Shvetsov # define CTX_EL2_SYSREGS_ALL	(CTX_EL2_SYSREGS_END >> DWORD_SHIFT)
3362825946eSMax Shvetsov #endif
337532ed618SSoby Mathew #if CTX_INCLUDE_FPREGS
338532ed618SSoby Mathew # define CTX_FPREG_ALL		(CTX_FPREGS_END >> DWORD_SHIFT)
339532ed618SSoby Mathew #endif
340532ed618SSoby Mathew #define CTX_EL3STATE_ALL	(CTX_EL3STATE_END >> DWORD_SHIFT)
341fe007b2eSDimitris Papastamos #define CTX_CVE_2018_3639_ALL	(CTX_CVE_2018_3639_END >> DWORD_SHIFT)
3425283962eSAntonio Nino Diaz #if CTX_INCLUDE_PAUTH_REGS
3435283962eSAntonio Nino Diaz # define CTX_PAUTH_REGS_ALL	(CTX_PAUTH_REGS_END >> DWORD_SHIFT)
3445283962eSAntonio Nino Diaz #endif
345532ed618SSoby Mathew 
346532ed618SSoby Mathew /*
347532ed618SSoby Mathew  * AArch64 general purpose register context structure. Usually x0-x18,
348532ed618SSoby Mathew  * lr are saved as the compiler is expected to preserve the remaining
349532ed618SSoby Mathew  * callee saved registers if used by the C runtime and the assembler
350532ed618SSoby Mathew  * does not touch the remaining. But in case of world switch during
351532ed618SSoby Mathew  * exception handling, we need to save the callee registers too.
352532ed618SSoby Mathew  */
353532ed618SSoby Mathew DEFINE_REG_STRUCT(gp_regs, CTX_GPREG_ALL);
354532ed618SSoby Mathew 
355532ed618SSoby Mathew /*
3562825946eSMax Shvetsov  * AArch64 EL1 system register context structure for preserving the
35728f39f02SMax Shvetsov  * architectural state during world switches.
358532ed618SSoby Mathew  */
3592825946eSMax Shvetsov DEFINE_REG_STRUCT(el1_sysregs, CTX_EL1_SYSREGS_ALL);
3602825946eSMax Shvetsov 
3612825946eSMax Shvetsov 
3622825946eSMax Shvetsov /*
3632825946eSMax Shvetsov  * AArch64 EL2 system register context structure for preserving the
3642825946eSMax Shvetsov  * architectural state during world switches.
3652825946eSMax Shvetsov  */
3662825946eSMax Shvetsov #if CTX_INCLUDE_EL2_REGS
3672825946eSMax Shvetsov DEFINE_REG_STRUCT(el2_sysregs, CTX_EL2_SYSREGS_ALL);
3682825946eSMax Shvetsov #endif
369532ed618SSoby Mathew 
370532ed618SSoby Mathew /*
371532ed618SSoby Mathew  * AArch64 floating point register context structure for preserving
372532ed618SSoby Mathew  * the floating point state during switches from one security state to
373532ed618SSoby Mathew  * another.
374532ed618SSoby Mathew  */
375532ed618SSoby Mathew #if CTX_INCLUDE_FPREGS
376532ed618SSoby Mathew DEFINE_REG_STRUCT(fp_regs, CTX_FPREG_ALL);
377532ed618SSoby Mathew #endif
378532ed618SSoby Mathew 
379532ed618SSoby Mathew /*
380532ed618SSoby Mathew  * Miscellaneous registers used by EL3 firmware to maintain its state
381532ed618SSoby Mathew  * across exception entries and exits
382532ed618SSoby Mathew  */
383532ed618SSoby Mathew DEFINE_REG_STRUCT(el3_state, CTX_EL3STATE_ALL);
384532ed618SSoby Mathew 
385fe007b2eSDimitris Papastamos /* Function pointer used by CVE-2018-3639 dynamic mitigation */
386fe007b2eSDimitris Papastamos DEFINE_REG_STRUCT(cve_2018_3639, CTX_CVE_2018_3639_ALL);
387fe007b2eSDimitris Papastamos 
3885283962eSAntonio Nino Diaz /* Registers associated to ARMv8.3-PAuth */
3895283962eSAntonio Nino Diaz #if CTX_INCLUDE_PAUTH_REGS
3905283962eSAntonio Nino Diaz DEFINE_REG_STRUCT(pauth, CTX_PAUTH_REGS_ALL);
3915283962eSAntonio Nino Diaz #endif
3925283962eSAntonio Nino Diaz 
393532ed618SSoby Mathew /*
394532ed618SSoby Mathew  * Macros to access members of any of the above structures using their
395532ed618SSoby Mathew  * offsets
396532ed618SSoby Mathew  */
3972fe75a2dSZelalem #define read_ctx_reg(ctx, offset)	((ctx)->ctx_regs[(offset) >> DWORD_SHIFT])
3982fe75a2dSZelalem #define write_ctx_reg(ctx, offset, val)	(((ctx)->ctx_regs[(offset) >> DWORD_SHIFT]) \
399ba6e5ca6SJeenu Viswambharan 					 = (uint64_t) (val))
400532ed618SSoby Mathew 
401532ed618SSoby Mathew /*
402532ed618SSoby Mathew  * Top-level context structure which is used by EL3 firmware to
403532ed618SSoby Mathew  * preserve the state of a core at EL1 in one of the two security
404532ed618SSoby Mathew  * states and save enough EL3 meta data to be able to return to that
405532ed618SSoby Mathew  * EL and security state. The context management library will be used
406532ed618SSoby Mathew  * to ensure that SP_EL3 always points to an instance of this
407532ed618SSoby Mathew  * structure at exception entry and exit. Each instance will
408532ed618SSoby Mathew  * correspond to either the secure or the non-secure state.
409532ed618SSoby Mathew  */
410532ed618SSoby Mathew typedef struct cpu_context {
411532ed618SSoby Mathew 	gp_regs_t gpregs_ctx;
412532ed618SSoby Mathew 	el3_state_t el3state_ctx;
4132825946eSMax Shvetsov 	el1_sysregs_t el1_sysregs_ctx;
4142825946eSMax Shvetsov #if CTX_INCLUDE_EL2_REGS
4152825946eSMax Shvetsov 	el2_sysregs_t el2_sysregs_ctx;
4162825946eSMax Shvetsov #endif
417532ed618SSoby Mathew #if CTX_INCLUDE_FPREGS
418532ed618SSoby Mathew 	fp_regs_t fpregs_ctx;
419532ed618SSoby Mathew #endif
420fe007b2eSDimitris Papastamos 	cve_2018_3639_t cve_2018_3639_ctx;
4215283962eSAntonio Nino Diaz #if CTX_INCLUDE_PAUTH_REGS
4225283962eSAntonio Nino Diaz 	pauth_t pauth_ctx;
4235283962eSAntonio Nino Diaz #endif
424532ed618SSoby Mathew } cpu_context_t;
425532ed618SSoby Mathew 
426532ed618SSoby Mathew /* Macros to access members of the 'cpu_context_t' structure */
427532ed618SSoby Mathew #define get_el3state_ctx(h)	(&((cpu_context_t *) h)->el3state_ctx)
428532ed618SSoby Mathew #if CTX_INCLUDE_FPREGS
429532ed618SSoby Mathew # define get_fpregs_ctx(h)	(&((cpu_context_t *) h)->fpregs_ctx)
430532ed618SSoby Mathew #endif
4312825946eSMax Shvetsov #define get_el1_sysregs_ctx(h)	(&((cpu_context_t *) h)->el1_sysregs_ctx)
4322825946eSMax Shvetsov #if CTX_INCLUDE_EL2_REGS
4332825946eSMax Shvetsov # define get_el2_sysregs_ctx(h)	(&((cpu_context_t *) h)->el2_sysregs_ctx)
4342825946eSMax Shvetsov #endif
435532ed618SSoby Mathew #define get_gpregs_ctx(h)	(&((cpu_context_t *) h)->gpregs_ctx)
4366f03bc77SDimitris Papastamos #define get_cve_2018_3639_ctx(h)	(&((cpu_context_t *) h)->cve_2018_3639_ctx)
4375283962eSAntonio Nino Diaz #if CTX_INCLUDE_PAUTH_REGS
4385283962eSAntonio Nino Diaz # define get_pauth_ctx(h)	(&((cpu_context_t *) h)->pauth_ctx)
4395283962eSAntonio Nino Diaz #endif
440532ed618SSoby Mathew 
441532ed618SSoby Mathew /*
442532ed618SSoby Mathew  * Compile time assertions related to the 'cpu_context' structure to
443532ed618SSoby Mathew  * ensure that the assembler and the compiler view of the offsets of
444532ed618SSoby Mathew  * the structure members is the same.
445532ed618SSoby Mathew  */
446532ed618SSoby Mathew CASSERT(CTX_GPREGS_OFFSET == __builtin_offsetof(cpu_context_t, gpregs_ctx), \
447532ed618SSoby Mathew 	assert_core_context_gp_offset_mismatch);
4482825946eSMax Shvetsov CASSERT(CTX_EL1_SYSREGS_OFFSET == __builtin_offsetof(cpu_context_t, el1_sysregs_ctx), \
4492825946eSMax Shvetsov 	assert_core_context_el1_sys_offset_mismatch);
4502825946eSMax Shvetsov #if CTX_INCLUDE_EL2_REGS
4512825946eSMax Shvetsov CASSERT(CTX_EL2_SYSREGS_OFFSET == __builtin_offsetof(cpu_context_t, el2_sysregs_ctx), \
4522825946eSMax Shvetsov 	assert_core_context_el2_sys_offset_mismatch);
4532825946eSMax Shvetsov #endif
454532ed618SSoby Mathew #if CTX_INCLUDE_FPREGS
455532ed618SSoby Mathew CASSERT(CTX_FPREGS_OFFSET == __builtin_offsetof(cpu_context_t, fpregs_ctx), \
456532ed618SSoby Mathew 	assert_core_context_fp_offset_mismatch);
457532ed618SSoby Mathew #endif
458532ed618SSoby Mathew CASSERT(CTX_EL3STATE_OFFSET == __builtin_offsetof(cpu_context_t, el3state_ctx), \
459532ed618SSoby Mathew 	assert_core_context_el3state_offset_mismatch);
460fe007b2eSDimitris Papastamos CASSERT(CTX_CVE_2018_3639_OFFSET == __builtin_offsetof(cpu_context_t, cve_2018_3639_ctx), \
461fe007b2eSDimitris Papastamos 	assert_core_context_cve_2018_3639_offset_mismatch);
4625283962eSAntonio Nino Diaz #if CTX_INCLUDE_PAUTH_REGS
4635283962eSAntonio Nino Diaz CASSERT(CTX_PAUTH_REGS_OFFSET == __builtin_offsetof(cpu_context_t, pauth_ctx), \
4645283962eSAntonio Nino Diaz 	assert_core_context_pauth_offset_mismatch);
4655283962eSAntonio Nino Diaz #endif
466532ed618SSoby Mathew 
467532ed618SSoby Mathew /*
468532ed618SSoby Mathew  * Helper macro to set the general purpose registers that correspond to
469532ed618SSoby Mathew  * parameters in an aapcs_64 call i.e. x0-x7
470532ed618SSoby Mathew  */
471532ed618SSoby Mathew #define set_aapcs_args0(ctx, x0)				do {	\
472532ed618SSoby Mathew 		write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X0, x0);	\
473532ed618SSoby Mathew 	} while (0)
474532ed618SSoby Mathew #define set_aapcs_args1(ctx, x0, x1)				do {	\
475532ed618SSoby Mathew 		write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X1, x1);	\
476532ed618SSoby Mathew 		set_aapcs_args0(ctx, x0);				\
477532ed618SSoby Mathew 	} while (0)
478532ed618SSoby Mathew #define set_aapcs_args2(ctx, x0, x1, x2)			do {	\
479532ed618SSoby Mathew 		write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X2, x2);	\
480532ed618SSoby Mathew 		set_aapcs_args1(ctx, x0, x1);				\
481532ed618SSoby Mathew 	} while (0)
482532ed618SSoby Mathew #define set_aapcs_args3(ctx, x0, x1, x2, x3)			do {	\
483532ed618SSoby Mathew 		write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X3, x3);	\
484532ed618SSoby Mathew 		set_aapcs_args2(ctx, x0, x1, x2);			\
485532ed618SSoby Mathew 	} while (0)
486532ed618SSoby Mathew #define set_aapcs_args4(ctx, x0, x1, x2, x3, x4)		do {	\
487532ed618SSoby Mathew 		write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X4, x4);	\
488532ed618SSoby Mathew 		set_aapcs_args3(ctx, x0, x1, x2, x3);			\
489532ed618SSoby Mathew 	} while (0)
490532ed618SSoby Mathew #define set_aapcs_args5(ctx, x0, x1, x2, x3, x4, x5)		do {	\
491532ed618SSoby Mathew 		write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X5, x5);	\
492532ed618SSoby Mathew 		set_aapcs_args4(ctx, x0, x1, x2, x3, x4);		\
493532ed618SSoby Mathew 	} while (0)
494532ed618SSoby Mathew #define set_aapcs_args6(ctx, x0, x1, x2, x3, x4, x5, x6)	do {	\
495532ed618SSoby Mathew 		write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X6, x6);	\
496532ed618SSoby Mathew 		set_aapcs_args5(ctx, x0, x1, x2, x3, x4, x5);		\
497532ed618SSoby Mathew 	} while (0)
498532ed618SSoby Mathew #define set_aapcs_args7(ctx, x0, x1, x2, x3, x4, x5, x6, x7)	do {	\
499532ed618SSoby Mathew 		write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X7, x7);	\
500532ed618SSoby Mathew 		set_aapcs_args6(ctx, x0, x1, x2, x3, x4, x5, x6);	\
501532ed618SSoby Mathew 	} while (0)
502532ed618SSoby Mathew 
503532ed618SSoby Mathew /*******************************************************************************
504532ed618SSoby Mathew  * Function prototypes
505532ed618SSoby Mathew  ******************************************************************************/
5062825946eSMax Shvetsov void el1_sysregs_context_save(el1_sysregs_t *regs);
5072825946eSMax Shvetsov void el1_sysregs_context_restore(el1_sysregs_t *regs);
50828f39f02SMax Shvetsov 
50928f39f02SMax Shvetsov #if CTX_INCLUDE_EL2_REGS
5102825946eSMax Shvetsov void el2_sysregs_context_save(el2_sysregs_t *regs);
5112825946eSMax Shvetsov void el2_sysregs_context_restore(el2_sysregs_t *regs);
51228f39f02SMax Shvetsov #endif
51328f39f02SMax Shvetsov 
514532ed618SSoby Mathew #if CTX_INCLUDE_FPREGS
515532ed618SSoby Mathew void fpregs_context_save(fp_regs_t *regs);
516532ed618SSoby Mathew void fpregs_context_restore(fp_regs_t *regs);
517532ed618SSoby Mathew #endif
518532ed618SSoby Mathew 
519d5dfdeb6SJulius Werner #endif /* __ASSEMBLER__ */
520532ed618SSoby Mathew 
521a0fee747SAntonio Nino Diaz #endif /* CONTEXT_H */
522