xref: /rk3399_ARM-atf/include/lib/el3_runtime/aarch64/context.h (revision 30ee3755d0a6f6e2f5aada0dc4b73ea2c3963eee)
1532ed618SSoby Mathew /*
22fe75a2dSZelalem  * Copyright (c) 2013-2020, 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)
6376454abfSJeenu Viswambharan #define CTX_EL3STATE_END	U(0x30)
64532ed618SSoby Mathew 
65532ed618SSoby Mathew /*******************************************************************************
66532ed618SSoby Mathew  * Constants that allow assembler code to access members of and the
67532ed618SSoby Mathew  * 'el1_sys_regs' structure at their correct offsets. Note that some of the
68532ed618SSoby Mathew  * registers are only 32-bits wide but are stored as 64-bit values for
69532ed618SSoby Mathew  * convenience
70532ed618SSoby Mathew  ******************************************************************************/
712825946eSMax Shvetsov #define CTX_EL1_SYSREGS_OFFSET	(CTX_EL3STATE_OFFSET + CTX_EL3STATE_END)
72030567e6SVarun Wadekar #define CTX_SPSR_EL1		U(0x0)
73030567e6SVarun Wadekar #define CTX_ELR_EL1		U(0x8)
74030567e6SVarun Wadekar #define CTX_SCTLR_EL1		U(0x10)
75030567e6SVarun Wadekar #define CTX_ACTLR_EL1		U(0x18)
76030567e6SVarun Wadekar #define CTX_CPACR_EL1		U(0x20)
77030567e6SVarun Wadekar #define CTX_CSSELR_EL1		U(0x28)
78030567e6SVarun Wadekar #define CTX_SP_EL1		U(0x30)
79030567e6SVarun Wadekar #define CTX_ESR_EL1		U(0x38)
80030567e6SVarun Wadekar #define CTX_TTBR0_EL1		U(0x40)
81030567e6SVarun Wadekar #define CTX_TTBR1_EL1		U(0x48)
82030567e6SVarun Wadekar #define CTX_MAIR_EL1		U(0x50)
83030567e6SVarun Wadekar #define CTX_AMAIR_EL1		U(0x58)
84030567e6SVarun Wadekar #define CTX_TCR_EL1		U(0x60)
85030567e6SVarun Wadekar #define CTX_TPIDR_EL1		U(0x68)
86030567e6SVarun Wadekar #define CTX_TPIDR_EL0		U(0x70)
87030567e6SVarun Wadekar #define CTX_TPIDRRO_EL0		U(0x78)
88030567e6SVarun Wadekar #define CTX_PAR_EL1		U(0x80)
89030567e6SVarun Wadekar #define CTX_FAR_EL1		U(0x88)
90030567e6SVarun Wadekar #define CTX_AFSR0_EL1		U(0x90)
91030567e6SVarun Wadekar #define CTX_AFSR1_EL1		U(0x98)
92030567e6SVarun Wadekar #define CTX_CONTEXTIDR_EL1	U(0xa0)
93030567e6SVarun Wadekar #define CTX_VBAR_EL1		U(0xa8)
94532ed618SSoby Mathew 
95532ed618SSoby Mathew /*
96532ed618SSoby Mathew  * If the platform is AArch64-only, there is no need to save and restore these
97532ed618SSoby Mathew  * AArch32 registers.
98532ed618SSoby Mathew  */
99532ed618SSoby Mathew #if CTX_INCLUDE_AARCH32_REGS
100e290a8fcSAlexei Fedorov #define CTX_SPSR_ABT		U(0xb0)	/* Align to the next 16 byte boundary */
101e290a8fcSAlexei Fedorov #define CTX_SPSR_UND		U(0xb8)
102e290a8fcSAlexei Fedorov #define CTX_SPSR_IRQ		U(0xc0)
103e290a8fcSAlexei Fedorov #define CTX_SPSR_FIQ		U(0xc8)
104e290a8fcSAlexei Fedorov #define CTX_DACR32_EL2		U(0xd0)
105e290a8fcSAlexei Fedorov #define CTX_IFSR32_EL2		U(0xd8)
106e290a8fcSAlexei Fedorov #define CTX_AARCH32_END		U(0xe0) /* Align to the next 16 byte boundary */
107532ed618SSoby Mathew #else
108e290a8fcSAlexei Fedorov #define CTX_AARCH32_END		U(0xb0)	/* Align to the next 16 byte boundary */
1094d1ccf0eSAntonio Nino Diaz #endif /* CTX_INCLUDE_AARCH32_REGS */
110532ed618SSoby Mathew 
111532ed618SSoby Mathew /*
112532ed618SSoby Mathew  * If the timer registers aren't saved and restored, we don't have to reserve
113532ed618SSoby Mathew  * space for them in the context
114532ed618SSoby Mathew  */
115532ed618SSoby Mathew #if NS_TIMER_SWITCH
1164d1ccf0eSAntonio Nino Diaz #define CTX_CNTP_CTL_EL0	(CTX_AARCH32_END + U(0x0))
1174d1ccf0eSAntonio Nino Diaz #define CTX_CNTP_CVAL_EL0	(CTX_AARCH32_END + U(0x8))
1184d1ccf0eSAntonio Nino Diaz #define CTX_CNTV_CTL_EL0	(CTX_AARCH32_END + U(0x10))
1194d1ccf0eSAntonio Nino Diaz #define CTX_CNTV_CVAL_EL0	(CTX_AARCH32_END + U(0x18))
1204d1ccf0eSAntonio Nino Diaz #define CTX_CNTKCTL_EL1		(CTX_AARCH32_END + U(0x20))
1214d1ccf0eSAntonio Nino Diaz #define CTX_TIMER_SYSREGS_END	(CTX_AARCH32_END + U(0x30)) /* Align to the next 16 byte boundary */
122532ed618SSoby Mathew #else
1234d1ccf0eSAntonio Nino Diaz #define CTX_TIMER_SYSREGS_END	CTX_AARCH32_END
1244d1ccf0eSAntonio Nino Diaz #endif /* NS_TIMER_SWITCH */
1254d1ccf0eSAntonio Nino Diaz 
1269dd94382SJustin Chadwell #if CTX_INCLUDE_MTE_REGS
1279dd94382SJustin Chadwell #define CTX_TFSRE0_EL1		(CTX_TIMER_SYSREGS_END + U(0x0))
1289dd94382SJustin Chadwell #define CTX_TFSR_EL1		(CTX_TIMER_SYSREGS_END + U(0x8))
1299dd94382SJustin Chadwell #define CTX_RGSR_EL1		(CTX_TIMER_SYSREGS_END + U(0x10))
1309dd94382SJustin Chadwell #define CTX_GCR_EL1		(CTX_TIMER_SYSREGS_END + U(0x18))
1319dd94382SJustin Chadwell 
1329dd94382SJustin Chadwell /* Align to the next 16 byte boundary */
1339dd94382SJustin Chadwell #define CTX_MTE_REGS_END	(CTX_TIMER_SYSREGS_END + U(0x20))
1349dd94382SJustin Chadwell #else
1359dd94382SJustin Chadwell #define CTX_MTE_REGS_END	CTX_TIMER_SYSREGS_END
1369dd94382SJustin Chadwell #endif /* CTX_INCLUDE_MTE_REGS */
1379dd94382SJustin Chadwell 
1384d1ccf0eSAntonio Nino Diaz /*
1392825946eSMax Shvetsov  * End of system registers.
1402825946eSMax Shvetsov  */
1412825946eSMax Shvetsov #define CTX_EL1_SYSREGS_END		CTX_MTE_REGS_END
1422825946eSMax Shvetsov 
1432825946eSMax Shvetsov /*
1442825946eSMax Shvetsov  * EL2 register set
14528f39f02SMax Shvetsov  */
14628f39f02SMax Shvetsov 
14728f39f02SMax Shvetsov #if CTX_INCLUDE_EL2_REGS
14828f39f02SMax Shvetsov /* For later discussion
14928f39f02SMax Shvetsov  * ICH_AP0R<n>_EL2
15028f39f02SMax Shvetsov  * ICH_AP1R<n>_EL2
15128f39f02SMax Shvetsov  * AMEVCNTVOFF0<n>_EL2
15228f39f02SMax Shvetsov  * AMEVCNTVOFF1<n>_EL2
15328f39f02SMax Shvetsov  * ICH_LR<n>_EL2
15428f39f02SMax Shvetsov  */
1552825946eSMax Shvetsov #define CTX_EL2_SYSREGS_OFFSET	(CTX_EL1_SYSREGS_OFFSET + CTX_EL1_SYSREGS_END)
15628f39f02SMax Shvetsov 
1572825946eSMax Shvetsov #define CTX_ACTLR_EL2		U(0x0)
1582825946eSMax Shvetsov #define CTX_AFSR0_EL2		U(0x8)
1592825946eSMax Shvetsov #define CTX_AFSR1_EL2		U(0x10)
1602825946eSMax Shvetsov #define CTX_AMAIR_EL2		U(0x18)
1612825946eSMax Shvetsov #define CTX_CNTHCTL_EL2		U(0x20)
1622825946eSMax Shvetsov #define CTX_CNTHP_CTL_EL2	U(0x28)
1632825946eSMax Shvetsov #define CTX_CNTHP_CVAL_EL2	U(0x30)
1642825946eSMax Shvetsov #define CTX_CNTHP_TVAL_EL2	U(0x38)
1652825946eSMax Shvetsov #define CTX_CNTVOFF_EL2		U(0x40)
1662825946eSMax Shvetsov #define CTX_CPTR_EL2		U(0x48)
1672825946eSMax Shvetsov #define CTX_DBGVCR32_EL2	U(0x50)
1682825946eSMax Shvetsov #define CTX_ELR_EL2		U(0x58)
1692825946eSMax Shvetsov #define CTX_ESR_EL2		U(0x60)
1702825946eSMax Shvetsov #define CTX_FAR_EL2		U(0x68)
171*30ee3755SMax Shvetsov #define CTX_HACR_EL2		U(0x70)
172*30ee3755SMax Shvetsov #define CTX_HCR_EL2		U(0x78)
173*30ee3755SMax Shvetsov #define CTX_HPFAR_EL2		U(0x80)
174*30ee3755SMax Shvetsov #define CTX_HSTR_EL2		U(0x88)
175*30ee3755SMax Shvetsov #define CTX_ICC_SRE_EL2		U(0x90)
176*30ee3755SMax Shvetsov #define CTX_ICH_HCR_EL2		U(0x98)
177*30ee3755SMax Shvetsov #define CTX_ICH_VMCR_EL2	U(0xa0)
178*30ee3755SMax Shvetsov #define CTX_MAIR_EL2		U(0xa8)
179*30ee3755SMax Shvetsov #define CTX_MDCR_EL2		U(0xb0)
180*30ee3755SMax Shvetsov #define CTX_PMSCR_EL2		U(0xb8)
181*30ee3755SMax Shvetsov #define CTX_SCTLR_EL2		U(0xc0)
182*30ee3755SMax Shvetsov #define CTX_SPSR_EL2		U(0xc8)
183*30ee3755SMax Shvetsov #define CTX_SP_EL2		U(0xd0)
184*30ee3755SMax Shvetsov #define CTX_TCR_EL2		U(0xd8)
185*30ee3755SMax Shvetsov #define CTX_TPIDR_EL2		U(0xe0)
186*30ee3755SMax Shvetsov #define CTX_TTBR0_EL2		U(0xe8)
187*30ee3755SMax Shvetsov #define CTX_VBAR_EL2		U(0xf0)
188*30ee3755SMax Shvetsov #define CTX_VMPIDR_EL2		U(0xf8)
189*30ee3755SMax Shvetsov #define CTX_VPIDR_EL2		U(0x100)
190*30ee3755SMax Shvetsov #define CTX_VTCR_EL2		U(0x108)
191*30ee3755SMax Shvetsov #define CTX_VTTBR_EL2		U(0x110)
1922825946eSMax Shvetsov 
1932825946eSMax Shvetsov // Only if MTE registers in use
194*30ee3755SMax Shvetsov #define CTX_TFSR_EL2		U(0x118)
1952825946eSMax Shvetsov 
1962825946eSMax Shvetsov // Only if ENABLE_MPAM_FOR_LOWER_ELS==1
197*30ee3755SMax Shvetsov #define CTX_MPAM2_EL2		U(0x120)
198*30ee3755SMax Shvetsov #define CTX_MPAMHCR_EL2		U(0x128)
199*30ee3755SMax Shvetsov #define CTX_MPAMVPM0_EL2	U(0x130)
200*30ee3755SMax Shvetsov #define CTX_MPAMVPM1_EL2	U(0x138)
201*30ee3755SMax Shvetsov #define CTX_MPAMVPM2_EL2	U(0x140)
202*30ee3755SMax Shvetsov #define CTX_MPAMVPM3_EL2	U(0x148)
203*30ee3755SMax Shvetsov #define CTX_MPAMVPM4_EL2	U(0x150)
204*30ee3755SMax Shvetsov #define CTX_MPAMVPM5_EL2	U(0x158)
205*30ee3755SMax Shvetsov #define CTX_MPAMVPM6_EL2	U(0x160)
206*30ee3755SMax Shvetsov #define CTX_MPAMVPM7_EL2	U(0x168)
207*30ee3755SMax Shvetsov #define CTX_MPAMVPMV_EL2	U(0x170)
2082825946eSMax Shvetsov 
2092825946eSMax Shvetsov // Starting with Armv8.6
210*30ee3755SMax Shvetsov #define CTX_HAFGRTR_EL2		U(0x178)
211*30ee3755SMax Shvetsov #define CTX_HDFGRTR_EL2		U(0x180)
212*30ee3755SMax Shvetsov #define CTX_HDFGWTR_EL2		U(0x188)
213*30ee3755SMax Shvetsov #define CTX_HFGITR_EL2		U(0x190)
214*30ee3755SMax Shvetsov #define CTX_HFGRTR_EL2		U(0x198)
215*30ee3755SMax Shvetsov #define CTX_HFGWTR_EL2		U(0x1a0)
216*30ee3755SMax Shvetsov #define CTX_CNTPOFF_EL2		U(0x1a8)
2172825946eSMax Shvetsov 
2182825946eSMax Shvetsov // Starting with Armv8.4
219*30ee3755SMax Shvetsov #define CTX_CNTHPS_CTL_EL2	U(0x1b0)
220*30ee3755SMax Shvetsov #define CTX_CNTHPS_CVAL_EL2	U(0x1b8)
221*30ee3755SMax Shvetsov #define CTX_CNTHPS_TVAL_EL2	U(0x1c0)
222*30ee3755SMax Shvetsov #define CTX_CNTHVS_CTL_EL2	U(0x1c8)
223*30ee3755SMax Shvetsov #define CTX_CNTHVS_CVAL_EL2	U(0x1d0)
224*30ee3755SMax Shvetsov #define CTX_CNTHVS_TVAL_EL2	U(0x1d8)
225*30ee3755SMax Shvetsov #define CTX_CNTHV_CTL_EL2	U(0x1e0)
226*30ee3755SMax Shvetsov #define CTX_CNTHV_CVAL_EL2	U(0x1e8)
227*30ee3755SMax Shvetsov #define CTX_CNTHV_TVAL_EL2	U(0x1f0)
228*30ee3755SMax Shvetsov #define CTX_CONTEXTIDR_EL2	U(0x1f8)
229*30ee3755SMax Shvetsov #define CTX_SDER32_EL2		U(0x200)
230*30ee3755SMax Shvetsov #define CTX_TTBR1_EL2		U(0x208)
231*30ee3755SMax Shvetsov #define CTX_VDISR_EL2		U(0x210)
232*30ee3755SMax Shvetsov #define CTX_VNCR_EL2		U(0x218)
233*30ee3755SMax Shvetsov #define CTX_VSESR_EL2		U(0x220)
234*30ee3755SMax Shvetsov #define CTX_VSTCR_EL2		U(0x228)
235*30ee3755SMax Shvetsov #define CTX_VSTTBR_EL2		U(0x230)
236*30ee3755SMax Shvetsov #define CTX_TRFCR_EL2		U(0x238)
2372825946eSMax Shvetsov 
2382825946eSMax Shvetsov // Starting with Armv8.5
239*30ee3755SMax Shvetsov #define CTX_SCXTNUM_EL2		U(0x240)
24028f39f02SMax Shvetsov /* Align to the next 16 byte boundary */
2412825946eSMax Shvetsov #define CTX_EL2_SYSREGS_END	U(0x250)
2427f164a83SOlivier Deprez 
24328f39f02SMax Shvetsov #endif /* CTX_INCLUDE_EL2_REGS */
24428f39f02SMax Shvetsov 
245532ed618SSoby Mathew /*******************************************************************************
246532ed618SSoby Mathew  * Constants that allow assembler code to access members of and the 'fp_regs'
247532ed618SSoby Mathew  * structure at their correct offsets.
248532ed618SSoby Mathew  ******************************************************************************/
2492825946eSMax Shvetsov #if CTX_INCLUDE_EL2_REGS
2502825946eSMax Shvetsov # define CTX_FPREGS_OFFSET	(CTX_EL2_SYSREGS_OFFSET + CTX_EL2_SYSREGS_END)
2512825946eSMax Shvetsov #else
2522825946eSMax Shvetsov # define CTX_FPREGS_OFFSET	(CTX_EL1_SYSREGS_OFFSET + CTX_EL1_SYSREGS_END)
2532825946eSMax Shvetsov #endif
254fe007b2eSDimitris Papastamos #if CTX_INCLUDE_FPREGS
255030567e6SVarun Wadekar #define CTX_FP_Q0		U(0x0)
256030567e6SVarun Wadekar #define CTX_FP_Q1		U(0x10)
257030567e6SVarun Wadekar #define CTX_FP_Q2		U(0x20)
258030567e6SVarun Wadekar #define CTX_FP_Q3		U(0x30)
259030567e6SVarun Wadekar #define CTX_FP_Q4		U(0x40)
260030567e6SVarun Wadekar #define CTX_FP_Q5		U(0x50)
261030567e6SVarun Wadekar #define CTX_FP_Q6		U(0x60)
262030567e6SVarun Wadekar #define CTX_FP_Q7		U(0x70)
263030567e6SVarun Wadekar #define CTX_FP_Q8		U(0x80)
264030567e6SVarun Wadekar #define CTX_FP_Q9		U(0x90)
265030567e6SVarun Wadekar #define CTX_FP_Q10		U(0xa0)
266030567e6SVarun Wadekar #define CTX_FP_Q11		U(0xb0)
267030567e6SVarun Wadekar #define CTX_FP_Q12		U(0xc0)
268030567e6SVarun Wadekar #define CTX_FP_Q13		U(0xd0)
269030567e6SVarun Wadekar #define CTX_FP_Q14		U(0xe0)
270030567e6SVarun Wadekar #define CTX_FP_Q15		U(0xf0)
271030567e6SVarun Wadekar #define CTX_FP_Q16		U(0x100)
272030567e6SVarun Wadekar #define CTX_FP_Q17		U(0x110)
273030567e6SVarun Wadekar #define CTX_FP_Q18		U(0x120)
274030567e6SVarun Wadekar #define CTX_FP_Q19		U(0x130)
275030567e6SVarun Wadekar #define CTX_FP_Q20		U(0x140)
276030567e6SVarun Wadekar #define CTX_FP_Q21		U(0x150)
277030567e6SVarun Wadekar #define CTX_FP_Q22		U(0x160)
278030567e6SVarun Wadekar #define CTX_FP_Q23		U(0x170)
279030567e6SVarun Wadekar #define CTX_FP_Q24		U(0x180)
280030567e6SVarun Wadekar #define CTX_FP_Q25		U(0x190)
281030567e6SVarun Wadekar #define CTX_FP_Q26		U(0x1a0)
282030567e6SVarun Wadekar #define CTX_FP_Q27		U(0x1b0)
283030567e6SVarun Wadekar #define CTX_FP_Q28		U(0x1c0)
284030567e6SVarun Wadekar #define CTX_FP_Q29		U(0x1d0)
285030567e6SVarun Wadekar #define CTX_FP_Q30		U(0x1e0)
286030567e6SVarun Wadekar #define CTX_FP_Q31		U(0x1f0)
287030567e6SVarun Wadekar #define CTX_FP_FPSR		U(0x200)
288030567e6SVarun Wadekar #define CTX_FP_FPCR		U(0x208)
28991089f36SDavid Cunado #if CTX_INCLUDE_AARCH32_REGS
29091089f36SDavid Cunado #define CTX_FP_FPEXC32_EL2	U(0x210)
29191089f36SDavid Cunado #define CTX_FPREGS_END		U(0x220) /* Align to the next 16 byte boundary */
29291089f36SDavid Cunado #else
29391089f36SDavid Cunado #define CTX_FPREGS_END		U(0x210) /* Align to the next 16 byte boundary */
29491089f36SDavid Cunado #endif
295fe007b2eSDimitris Papastamos #else
296fe007b2eSDimitris Papastamos #define CTX_FPREGS_END		U(0)
297532ed618SSoby Mathew #endif
298532ed618SSoby Mathew 
2994d1ccf0eSAntonio Nino Diaz /*******************************************************************************
3004d1ccf0eSAntonio Nino Diaz  * Registers related to CVE-2018-3639
3014d1ccf0eSAntonio Nino Diaz  ******************************************************************************/
302fe007b2eSDimitris Papastamos #define CTX_CVE_2018_3639_OFFSET	(CTX_FPREGS_OFFSET + CTX_FPREGS_END)
303fe007b2eSDimitris Papastamos #define CTX_CVE_2018_3639_DISABLE	U(0)
304fe007b2eSDimitris Papastamos #define CTX_CVE_2018_3639_END		U(0x10) /* Align to the next 16 byte boundary */
305fe007b2eSDimitris Papastamos 
3065283962eSAntonio Nino Diaz /*******************************************************************************
3075283962eSAntonio Nino Diaz  * Registers related to ARMv8.3-PAuth.
3085283962eSAntonio Nino Diaz  ******************************************************************************/
3095283962eSAntonio Nino Diaz #define CTX_PAUTH_REGS_OFFSET	(CTX_CVE_2018_3639_OFFSET + CTX_CVE_2018_3639_END)
3105283962eSAntonio Nino Diaz #if CTX_INCLUDE_PAUTH_REGS
3115283962eSAntonio Nino Diaz #define CTX_PACIAKEY_LO		U(0x0)
3125283962eSAntonio Nino Diaz #define CTX_PACIAKEY_HI		U(0x8)
3135283962eSAntonio Nino Diaz #define CTX_PACIBKEY_LO		U(0x10)
3145283962eSAntonio Nino Diaz #define CTX_PACIBKEY_HI		U(0x18)
3155283962eSAntonio Nino Diaz #define CTX_PACDAKEY_LO		U(0x20)
3165283962eSAntonio Nino Diaz #define CTX_PACDAKEY_HI		U(0x28)
3175283962eSAntonio Nino Diaz #define CTX_PACDBKEY_LO		U(0x30)
3185283962eSAntonio Nino Diaz #define CTX_PACDBKEY_HI		U(0x38)
3195283962eSAntonio Nino Diaz #define CTX_PACGAKEY_LO		U(0x40)
3205283962eSAntonio Nino Diaz #define CTX_PACGAKEY_HI		U(0x48)
321ed108b56SAlexei Fedorov #define CTX_PAUTH_REGS_END	U(0x50) /* Align to the next 16 byte boundary */
3225283962eSAntonio Nino Diaz #else
3235283962eSAntonio Nino Diaz #define CTX_PAUTH_REGS_END	U(0)
3245283962eSAntonio Nino Diaz #endif /* CTX_INCLUDE_PAUTH_REGS */
3255283962eSAntonio Nino Diaz 
326d5dfdeb6SJulius Werner #ifndef __ASSEMBLER__
327532ed618SSoby Mathew 
328532ed618SSoby Mathew #include <stdint.h>
329532ed618SSoby Mathew 
33009d40e0eSAntonio Nino Diaz #include <lib/cassert.h>
33109d40e0eSAntonio Nino Diaz 
332532ed618SSoby Mathew /*
333532ed618SSoby Mathew  * Common constants to help define the 'cpu_context' structure and its
334532ed618SSoby Mathew  * members below.
335532ed618SSoby Mathew  */
336030567e6SVarun Wadekar #define DWORD_SHIFT		U(3)
337532ed618SSoby Mathew #define DEFINE_REG_STRUCT(name, num_regs)	\
338532ed618SSoby Mathew 	typedef struct name {			\
3392fe75a2dSZelalem 		uint64_t ctx_regs[num_regs];	\
340532ed618SSoby Mathew 	}  __aligned(16) name##_t
341532ed618SSoby Mathew 
342532ed618SSoby Mathew /* Constants to determine the size of individual context structures */
343532ed618SSoby Mathew #define CTX_GPREG_ALL		(CTX_GPREGS_END >> DWORD_SHIFT)
3442825946eSMax Shvetsov #define CTX_EL1_SYSREGS_ALL	(CTX_EL1_SYSREGS_END >> DWORD_SHIFT)
3452825946eSMax Shvetsov #if CTX_INCLUDE_EL2_REGS
3462825946eSMax Shvetsov # define CTX_EL2_SYSREGS_ALL	(CTX_EL2_SYSREGS_END >> DWORD_SHIFT)
3472825946eSMax Shvetsov #endif
348532ed618SSoby Mathew #if CTX_INCLUDE_FPREGS
349532ed618SSoby Mathew # define CTX_FPREG_ALL		(CTX_FPREGS_END >> DWORD_SHIFT)
350532ed618SSoby Mathew #endif
351532ed618SSoby Mathew #define CTX_EL3STATE_ALL	(CTX_EL3STATE_END >> DWORD_SHIFT)
352fe007b2eSDimitris Papastamos #define CTX_CVE_2018_3639_ALL	(CTX_CVE_2018_3639_END >> DWORD_SHIFT)
3535283962eSAntonio Nino Diaz #if CTX_INCLUDE_PAUTH_REGS
3545283962eSAntonio Nino Diaz # define CTX_PAUTH_REGS_ALL	(CTX_PAUTH_REGS_END >> DWORD_SHIFT)
3555283962eSAntonio Nino Diaz #endif
356532ed618SSoby Mathew 
357532ed618SSoby Mathew /*
358532ed618SSoby Mathew  * AArch64 general purpose register context structure. Usually x0-x18,
359532ed618SSoby Mathew  * lr are saved as the compiler is expected to preserve the remaining
360532ed618SSoby Mathew  * callee saved registers if used by the C runtime and the assembler
361532ed618SSoby Mathew  * does not touch the remaining. But in case of world switch during
362532ed618SSoby Mathew  * exception handling, we need to save the callee registers too.
363532ed618SSoby Mathew  */
364532ed618SSoby Mathew DEFINE_REG_STRUCT(gp_regs, CTX_GPREG_ALL);
365532ed618SSoby Mathew 
366532ed618SSoby Mathew /*
3672825946eSMax Shvetsov  * AArch64 EL1 system register context structure for preserving the
36828f39f02SMax Shvetsov  * architectural state during world switches.
369532ed618SSoby Mathew  */
3702825946eSMax Shvetsov DEFINE_REG_STRUCT(el1_sysregs, CTX_EL1_SYSREGS_ALL);
3712825946eSMax Shvetsov 
3722825946eSMax Shvetsov 
3732825946eSMax Shvetsov /*
3742825946eSMax Shvetsov  * AArch64 EL2 system register context structure for preserving the
3752825946eSMax Shvetsov  * architectural state during world switches.
3762825946eSMax Shvetsov  */
3772825946eSMax Shvetsov #if CTX_INCLUDE_EL2_REGS
3782825946eSMax Shvetsov DEFINE_REG_STRUCT(el2_sysregs, CTX_EL2_SYSREGS_ALL);
3792825946eSMax Shvetsov #endif
380532ed618SSoby Mathew 
381532ed618SSoby Mathew /*
382532ed618SSoby Mathew  * AArch64 floating point register context structure for preserving
383532ed618SSoby Mathew  * the floating point state during switches from one security state to
384532ed618SSoby Mathew  * another.
385532ed618SSoby Mathew  */
386532ed618SSoby Mathew #if CTX_INCLUDE_FPREGS
387532ed618SSoby Mathew DEFINE_REG_STRUCT(fp_regs, CTX_FPREG_ALL);
388532ed618SSoby Mathew #endif
389532ed618SSoby Mathew 
390532ed618SSoby Mathew /*
391532ed618SSoby Mathew  * Miscellaneous registers used by EL3 firmware to maintain its state
392532ed618SSoby Mathew  * across exception entries and exits
393532ed618SSoby Mathew  */
394532ed618SSoby Mathew DEFINE_REG_STRUCT(el3_state, CTX_EL3STATE_ALL);
395532ed618SSoby Mathew 
396fe007b2eSDimitris Papastamos /* Function pointer used by CVE-2018-3639 dynamic mitigation */
397fe007b2eSDimitris Papastamos DEFINE_REG_STRUCT(cve_2018_3639, CTX_CVE_2018_3639_ALL);
398fe007b2eSDimitris Papastamos 
3995283962eSAntonio Nino Diaz /* Registers associated to ARMv8.3-PAuth */
4005283962eSAntonio Nino Diaz #if CTX_INCLUDE_PAUTH_REGS
4015283962eSAntonio Nino Diaz DEFINE_REG_STRUCT(pauth, CTX_PAUTH_REGS_ALL);
4025283962eSAntonio Nino Diaz #endif
4035283962eSAntonio Nino Diaz 
404532ed618SSoby Mathew /*
405532ed618SSoby Mathew  * Macros to access members of any of the above structures using their
406532ed618SSoby Mathew  * offsets
407532ed618SSoby Mathew  */
4082fe75a2dSZelalem #define read_ctx_reg(ctx, offset)	((ctx)->ctx_regs[(offset) >> DWORD_SHIFT])
4092fe75a2dSZelalem #define write_ctx_reg(ctx, offset, val)	(((ctx)->ctx_regs[(offset) >> DWORD_SHIFT]) \
410ba6e5ca6SJeenu Viswambharan 					 = (uint64_t) (val))
411532ed618SSoby Mathew 
412532ed618SSoby Mathew /*
413532ed618SSoby Mathew  * Top-level context structure which is used by EL3 firmware to
414532ed618SSoby Mathew  * preserve the state of a core at EL1 in one of the two security
415532ed618SSoby Mathew  * states and save enough EL3 meta data to be able to return to that
416532ed618SSoby Mathew  * EL and security state. The context management library will be used
417532ed618SSoby Mathew  * to ensure that SP_EL3 always points to an instance of this
418532ed618SSoby Mathew  * structure at exception entry and exit. Each instance will
419532ed618SSoby Mathew  * correspond to either the secure or the non-secure state.
420532ed618SSoby Mathew  */
421532ed618SSoby Mathew typedef struct cpu_context {
422532ed618SSoby Mathew 	gp_regs_t gpregs_ctx;
423532ed618SSoby Mathew 	el3_state_t el3state_ctx;
4242825946eSMax Shvetsov 	el1_sysregs_t el1_sysregs_ctx;
4252825946eSMax Shvetsov #if CTX_INCLUDE_EL2_REGS
4262825946eSMax Shvetsov 	el2_sysregs_t el2_sysregs_ctx;
4272825946eSMax Shvetsov #endif
428532ed618SSoby Mathew #if CTX_INCLUDE_FPREGS
429532ed618SSoby Mathew 	fp_regs_t fpregs_ctx;
430532ed618SSoby Mathew #endif
431fe007b2eSDimitris Papastamos 	cve_2018_3639_t cve_2018_3639_ctx;
4325283962eSAntonio Nino Diaz #if CTX_INCLUDE_PAUTH_REGS
4335283962eSAntonio Nino Diaz 	pauth_t pauth_ctx;
4345283962eSAntonio Nino Diaz #endif
435532ed618SSoby Mathew } cpu_context_t;
436532ed618SSoby Mathew 
437532ed618SSoby Mathew /* Macros to access members of the 'cpu_context_t' structure */
438532ed618SSoby Mathew #define get_el3state_ctx(h)	(&((cpu_context_t *) h)->el3state_ctx)
439532ed618SSoby Mathew #if CTX_INCLUDE_FPREGS
440532ed618SSoby Mathew # define get_fpregs_ctx(h)	(&((cpu_context_t *) h)->fpregs_ctx)
441532ed618SSoby Mathew #endif
4422825946eSMax Shvetsov #define get_el1_sysregs_ctx(h)	(&((cpu_context_t *) h)->el1_sysregs_ctx)
4432825946eSMax Shvetsov #if CTX_INCLUDE_EL2_REGS
4442825946eSMax Shvetsov # define get_el2_sysregs_ctx(h)	(&((cpu_context_t *) h)->el2_sysregs_ctx)
4452825946eSMax Shvetsov #endif
446532ed618SSoby Mathew #define get_gpregs_ctx(h)	(&((cpu_context_t *) h)->gpregs_ctx)
4476f03bc77SDimitris Papastamos #define get_cve_2018_3639_ctx(h)	(&((cpu_context_t *) h)->cve_2018_3639_ctx)
4485283962eSAntonio Nino Diaz #if CTX_INCLUDE_PAUTH_REGS
4495283962eSAntonio Nino Diaz # define get_pauth_ctx(h)	(&((cpu_context_t *) h)->pauth_ctx)
4505283962eSAntonio Nino Diaz #endif
451532ed618SSoby Mathew 
452532ed618SSoby Mathew /*
453532ed618SSoby Mathew  * Compile time assertions related to the 'cpu_context' structure to
454532ed618SSoby Mathew  * ensure that the assembler and the compiler view of the offsets of
455532ed618SSoby Mathew  * the structure members is the same.
456532ed618SSoby Mathew  */
457532ed618SSoby Mathew CASSERT(CTX_GPREGS_OFFSET == __builtin_offsetof(cpu_context_t, gpregs_ctx), \
458532ed618SSoby Mathew 	assert_core_context_gp_offset_mismatch);
4592825946eSMax Shvetsov CASSERT(CTX_EL1_SYSREGS_OFFSET == __builtin_offsetof(cpu_context_t, el1_sysregs_ctx), \
4602825946eSMax Shvetsov 	assert_core_context_el1_sys_offset_mismatch);
4612825946eSMax Shvetsov #if CTX_INCLUDE_EL2_REGS
4622825946eSMax Shvetsov CASSERT(CTX_EL2_SYSREGS_OFFSET == __builtin_offsetof(cpu_context_t, el2_sysregs_ctx), \
4632825946eSMax Shvetsov 	assert_core_context_el2_sys_offset_mismatch);
4642825946eSMax Shvetsov #endif
465532ed618SSoby Mathew #if CTX_INCLUDE_FPREGS
466532ed618SSoby Mathew CASSERT(CTX_FPREGS_OFFSET == __builtin_offsetof(cpu_context_t, fpregs_ctx), \
467532ed618SSoby Mathew 	assert_core_context_fp_offset_mismatch);
468532ed618SSoby Mathew #endif
469532ed618SSoby Mathew CASSERT(CTX_EL3STATE_OFFSET == __builtin_offsetof(cpu_context_t, el3state_ctx), \
470532ed618SSoby Mathew 	assert_core_context_el3state_offset_mismatch);
471fe007b2eSDimitris Papastamos CASSERT(CTX_CVE_2018_3639_OFFSET == __builtin_offsetof(cpu_context_t, cve_2018_3639_ctx), \
472fe007b2eSDimitris Papastamos 	assert_core_context_cve_2018_3639_offset_mismatch);
4735283962eSAntonio Nino Diaz #if CTX_INCLUDE_PAUTH_REGS
4745283962eSAntonio Nino Diaz CASSERT(CTX_PAUTH_REGS_OFFSET == __builtin_offsetof(cpu_context_t, pauth_ctx), \
4755283962eSAntonio Nino Diaz 	assert_core_context_pauth_offset_mismatch);
4765283962eSAntonio Nino Diaz #endif
477532ed618SSoby Mathew 
478532ed618SSoby Mathew /*
479532ed618SSoby Mathew  * Helper macro to set the general purpose registers that correspond to
480532ed618SSoby Mathew  * parameters in an aapcs_64 call i.e. x0-x7
481532ed618SSoby Mathew  */
482532ed618SSoby Mathew #define set_aapcs_args0(ctx, x0)				do {	\
483532ed618SSoby Mathew 		write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X0, x0);	\
484532ed618SSoby Mathew 	} while (0)
485532ed618SSoby Mathew #define set_aapcs_args1(ctx, x0, x1)				do {	\
486532ed618SSoby Mathew 		write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X1, x1);	\
487532ed618SSoby Mathew 		set_aapcs_args0(ctx, x0);				\
488532ed618SSoby Mathew 	} while (0)
489532ed618SSoby Mathew #define set_aapcs_args2(ctx, x0, x1, x2)			do {	\
490532ed618SSoby Mathew 		write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X2, x2);	\
491532ed618SSoby Mathew 		set_aapcs_args1(ctx, x0, x1);				\
492532ed618SSoby Mathew 	} while (0)
493532ed618SSoby Mathew #define set_aapcs_args3(ctx, x0, x1, x2, x3)			do {	\
494532ed618SSoby Mathew 		write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X3, x3);	\
495532ed618SSoby Mathew 		set_aapcs_args2(ctx, x0, x1, x2);			\
496532ed618SSoby Mathew 	} while (0)
497532ed618SSoby Mathew #define set_aapcs_args4(ctx, x0, x1, x2, x3, x4)		do {	\
498532ed618SSoby Mathew 		write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X4, x4);	\
499532ed618SSoby Mathew 		set_aapcs_args3(ctx, x0, x1, x2, x3);			\
500532ed618SSoby Mathew 	} while (0)
501532ed618SSoby Mathew #define set_aapcs_args5(ctx, x0, x1, x2, x3, x4, x5)		do {	\
502532ed618SSoby Mathew 		write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X5, x5);	\
503532ed618SSoby Mathew 		set_aapcs_args4(ctx, x0, x1, x2, x3, x4);		\
504532ed618SSoby Mathew 	} while (0)
505532ed618SSoby Mathew #define set_aapcs_args6(ctx, x0, x1, x2, x3, x4, x5, x6)	do {	\
506532ed618SSoby Mathew 		write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X6, x6);	\
507532ed618SSoby Mathew 		set_aapcs_args5(ctx, x0, x1, x2, x3, x4, x5);		\
508532ed618SSoby Mathew 	} while (0)
509532ed618SSoby Mathew #define set_aapcs_args7(ctx, x0, x1, x2, x3, x4, x5, x6, x7)	do {	\
510532ed618SSoby Mathew 		write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X7, x7);	\
511532ed618SSoby Mathew 		set_aapcs_args6(ctx, x0, x1, x2, x3, x4, x5, x6);	\
512532ed618SSoby Mathew 	} while (0)
513532ed618SSoby Mathew 
514532ed618SSoby Mathew /*******************************************************************************
515532ed618SSoby Mathew  * Function prototypes
516532ed618SSoby Mathew  ******************************************************************************/
5172825946eSMax Shvetsov void el1_sysregs_context_save(el1_sysregs_t *regs);
5182825946eSMax Shvetsov void el1_sysregs_context_restore(el1_sysregs_t *regs);
51928f39f02SMax Shvetsov 
52028f39f02SMax Shvetsov #if CTX_INCLUDE_EL2_REGS
5212825946eSMax Shvetsov void el2_sysregs_context_save(el2_sysregs_t *regs);
5222825946eSMax Shvetsov void el2_sysregs_context_restore(el2_sysregs_t *regs);
52328f39f02SMax Shvetsov #endif
52428f39f02SMax Shvetsov 
525532ed618SSoby Mathew #if CTX_INCLUDE_FPREGS
526532ed618SSoby Mathew void fpregs_context_save(fp_regs_t *regs);
527532ed618SSoby Mathew void fpregs_context_restore(fp_regs_t *regs);
528532ed618SSoby Mathew #endif
529532ed618SSoby Mathew 
530d5dfdeb6SJulius Werner #endif /* __ASSEMBLER__ */
531532ed618SSoby Mathew 
532a0fee747SAntonio Nino Diaz #endif /* CONTEXT_H */
533