xref: /rk3399_ARM-atf/include/lib/el3_runtime/aarch64/context.h (revision 28f39f02ade1bd3ae86c8a472d01873ba0cdacb7)
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  ******************************************************************************/
71532ed618SSoby Mathew #define CTX_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 /*
139*28f39f02SMax Shvetsov  * S-EL2 register set
140*28f39f02SMax Shvetsov  */
141*28f39f02SMax Shvetsov 
142*28f39f02SMax Shvetsov #if CTX_INCLUDE_EL2_REGS
143*28f39f02SMax Shvetsov /* For later discussion
144*28f39f02SMax Shvetsov  * ICH_AP0R<n>_EL2
145*28f39f02SMax Shvetsov  * ICH_AP1R<n>_EL2
146*28f39f02SMax Shvetsov  * AMEVCNTVOFF0<n>_EL2
147*28f39f02SMax Shvetsov  * AMEVCNTVOFF1<n>_EL2
148*28f39f02SMax Shvetsov  * ICH_LR<n>_EL2
149*28f39f02SMax Shvetsov  */
150*28f39f02SMax Shvetsov #define CTX_ACTLR_EL2				(CTX_MTE_REGS_END + U(0x0))
151*28f39f02SMax Shvetsov #define CTX_AFSR0_EL2				(CTX_MTE_REGS_END + U(0x8))
152*28f39f02SMax Shvetsov #define CTX_AFSR1_EL2				(CTX_MTE_REGS_END + U(0x10))
153*28f39f02SMax Shvetsov #define CTX_AMAIR_EL2				(CTX_MTE_REGS_END + U(0x18))
154*28f39f02SMax Shvetsov #define CTX_CNTHCTL_EL2				(CTX_MTE_REGS_END + U(0x20))
155*28f39f02SMax Shvetsov #define CTX_CNTHP_CTL_EL2			(CTX_MTE_REGS_END + U(0x28))
156*28f39f02SMax Shvetsov #define CTX_CNTHP_CVAL_EL2			(CTX_MTE_REGS_END + U(0x30))
157*28f39f02SMax Shvetsov #define CTX_CNTHP_TVAL_EL2			(CTX_MTE_REGS_END + U(0x38))
158*28f39f02SMax Shvetsov #define CTX_CNTPOFF_EL2				(CTX_MTE_REGS_END + U(0x40))
159*28f39f02SMax Shvetsov #define CTX_CNTVOFF_EL2				(CTX_MTE_REGS_END + U(0x48))
160*28f39f02SMax Shvetsov #define CTX_CPTR_EL2				(CTX_MTE_REGS_END + U(0x50))
161*28f39f02SMax Shvetsov #define CTX_DBGVCR32_EL2			(CTX_MTE_REGS_END + U(0x58))
162*28f39f02SMax Shvetsov #define CTX_ELR_EL2				(CTX_MTE_REGS_END + U(0x60))
163*28f39f02SMax Shvetsov #define CTX_ESR_EL2				(CTX_MTE_REGS_END + U(0x68))
164*28f39f02SMax Shvetsov #define CTX_FAR_EL2				(CTX_MTE_REGS_END + U(0x70))
165*28f39f02SMax Shvetsov #define CTX_FPEXC32_EL2				(CTX_MTE_REGS_END + U(0x78))
166*28f39f02SMax Shvetsov #define CTX_HACR_EL2				(CTX_MTE_REGS_END + U(0x80))
167*28f39f02SMax Shvetsov #define CTX_HAFGRTR_EL2				(CTX_MTE_REGS_END + U(0x88))
168*28f39f02SMax Shvetsov #define CTX_HCR_EL2				(CTX_MTE_REGS_END + U(0x90))
169*28f39f02SMax Shvetsov #define CTX_HDFGRTR_EL2				(CTX_MTE_REGS_END + U(0x98))
170*28f39f02SMax Shvetsov #define CTX_HDFGWTR_EL2				(CTX_MTE_REGS_END + U(0xA0))
171*28f39f02SMax Shvetsov #define CTX_HFGITR_EL2				(CTX_MTE_REGS_END + U(0xA8))
172*28f39f02SMax Shvetsov #define CTX_HFGRTR_EL2				(CTX_MTE_REGS_END + U(0xB0))
173*28f39f02SMax Shvetsov #define CTX_HFGWTR_EL2				(CTX_MTE_REGS_END + U(0xB8))
174*28f39f02SMax Shvetsov #define CTX_HPFAR_EL2				(CTX_MTE_REGS_END + U(0xC0))
175*28f39f02SMax Shvetsov #define CTX_HSTR_EL2				(CTX_MTE_REGS_END + U(0xC8))
176*28f39f02SMax Shvetsov #define CTX_ICC_SRE_EL2				(CTX_MTE_REGS_END + U(0xD0))
177*28f39f02SMax Shvetsov #define CTX_ICH_EISR_EL2			(CTX_MTE_REGS_END + U(0xD8))
178*28f39f02SMax Shvetsov #define CTX_ICH_ELRSR_EL2			(CTX_MTE_REGS_END + U(0xE0))
179*28f39f02SMax Shvetsov #define CTX_ICH_HCR_EL2				(CTX_MTE_REGS_END + U(0xE8))
180*28f39f02SMax Shvetsov #define CTX_ICH_MISR_EL2			(CTX_MTE_REGS_END + U(0xF0))
181*28f39f02SMax Shvetsov #define CTX_ICH_VMCR_EL2			(CTX_MTE_REGS_END + U(0xF8))
182*28f39f02SMax Shvetsov #define CTX_ICH_VTR_EL2				(CTX_MTE_REGS_END + U(0x100))
183*28f39f02SMax Shvetsov #define CTX_MAIR_EL2				(CTX_MTE_REGS_END + U(0x108))
184*28f39f02SMax Shvetsov #define CTX_MDCR_EL2				(CTX_MTE_REGS_END + U(0x110))
185*28f39f02SMax Shvetsov #define CTX_MPAM2_EL2				(CTX_MTE_REGS_END + U(0x118))
186*28f39f02SMax Shvetsov #define CTX_MPAMHCR_EL2				(CTX_MTE_REGS_END + U(0x120))
187*28f39f02SMax Shvetsov #define CTX_MPAMVPM0_EL2			(CTX_MTE_REGS_END + U(0x128))
188*28f39f02SMax Shvetsov #define CTX_MPAMVPM1_EL2			(CTX_MTE_REGS_END + U(0x130))
189*28f39f02SMax Shvetsov #define CTX_MPAMVPM2_EL2			(CTX_MTE_REGS_END + U(0x138))
190*28f39f02SMax Shvetsov #define CTX_MPAMVPM3_EL2			(CTX_MTE_REGS_END + U(0x140))
191*28f39f02SMax Shvetsov #define CTX_MPAMVPM4_EL2			(CTX_MTE_REGS_END + U(0x148))
192*28f39f02SMax Shvetsov #define CTX_MPAMVPM5_EL2			(CTX_MTE_REGS_END + U(0x150))
193*28f39f02SMax Shvetsov #define CTX_MPAMVPM6_EL2			(CTX_MTE_REGS_END + U(0x158))
194*28f39f02SMax Shvetsov #define CTX_MPAMVPM7_EL2			(CTX_MTE_REGS_END + U(0x160))
195*28f39f02SMax Shvetsov #define CTX_MPAMVPMV_EL2			(CTX_MTE_REGS_END + U(0x168))
196*28f39f02SMax Shvetsov #define CTX_RMR_EL2				(CTX_MTE_REGS_END + U(0x170))
197*28f39f02SMax Shvetsov #define CTX_SCTLR_EL2				(CTX_MTE_REGS_END + U(0x178))
198*28f39f02SMax Shvetsov #define CTX_SPSR_EL2				(CTX_MTE_REGS_END + U(0x180))
199*28f39f02SMax Shvetsov #define CTX_SP_EL2				(CTX_MTE_REGS_END + U(0x188))
200*28f39f02SMax Shvetsov #define CTX_TCR_EL2				(CTX_MTE_REGS_END + U(0x190))
201*28f39f02SMax Shvetsov #define CTX_TPIDR_EL2				(CTX_MTE_REGS_END + U(0x198))
202*28f39f02SMax Shvetsov #define CTX_TTBR0_EL2				(CTX_MTE_REGS_END + U(0x1A0))
203*28f39f02SMax Shvetsov #define CTX_VBAR_EL2				(CTX_MTE_REGS_END + U(0x1A8))
204*28f39f02SMax Shvetsov #define CTX_VMPIDR_EL2				(CTX_MTE_REGS_END + U(0x1B0))
205*28f39f02SMax Shvetsov #define CTX_VPIDR_EL2				(CTX_MTE_REGS_END + U(0x1B8))
206*28f39f02SMax Shvetsov #define CTX_VTCR_EL2				(CTX_MTE_REGS_END + U(0x1C0))
207*28f39f02SMax Shvetsov #define CTX_VTTBR_EL2				(CTX_MTE_REGS_END + U(0x1C8))
208*28f39f02SMax Shvetsov #define CTX_ZCR_EL2				(CTX_MTE_REGS_END + U(0x1B0))
209*28f39f02SMax Shvetsov 
210*28f39f02SMax Shvetsov /* Align to the next 16 byte boundary */
211*28f39f02SMax Shvetsov #define CTX_EL2_REGS_END			(CTX_MTE_REGS_END + U(0x1C0))
212*28f39f02SMax Shvetsov #else
213*28f39f02SMax Shvetsov #define CTX_EL2_REGS_END			CTX_MTE_REGS_END
214*28f39f02SMax Shvetsov #endif /* CTX_INCLUDE_EL2_REGS */
215*28f39f02SMax Shvetsov 
216*28f39f02SMax Shvetsov /*
2174d1ccf0eSAntonio Nino Diaz  * End of system registers.
2184d1ccf0eSAntonio Nino Diaz  */
219*28f39f02SMax Shvetsov #define CTX_SYSREGS_END				CTX_EL2_REGS_END
220532ed618SSoby Mathew 
221532ed618SSoby Mathew /*******************************************************************************
222532ed618SSoby Mathew  * Constants that allow assembler code to access members of and the 'fp_regs'
223532ed618SSoby Mathew  * structure at their correct offsets.
224532ed618SSoby Mathew  ******************************************************************************/
225532ed618SSoby Mathew #define CTX_FPREGS_OFFSET	(CTX_SYSREGS_OFFSET + CTX_SYSREGS_END)
226fe007b2eSDimitris Papastamos #if CTX_INCLUDE_FPREGS
227030567e6SVarun Wadekar #define CTX_FP_Q0		U(0x0)
228030567e6SVarun Wadekar #define CTX_FP_Q1		U(0x10)
229030567e6SVarun Wadekar #define CTX_FP_Q2		U(0x20)
230030567e6SVarun Wadekar #define CTX_FP_Q3		U(0x30)
231030567e6SVarun Wadekar #define CTX_FP_Q4		U(0x40)
232030567e6SVarun Wadekar #define CTX_FP_Q5		U(0x50)
233030567e6SVarun Wadekar #define CTX_FP_Q6		U(0x60)
234030567e6SVarun Wadekar #define CTX_FP_Q7		U(0x70)
235030567e6SVarun Wadekar #define CTX_FP_Q8		U(0x80)
236030567e6SVarun Wadekar #define CTX_FP_Q9		U(0x90)
237030567e6SVarun Wadekar #define CTX_FP_Q10		U(0xa0)
238030567e6SVarun Wadekar #define CTX_FP_Q11		U(0xb0)
239030567e6SVarun Wadekar #define CTX_FP_Q12		U(0xc0)
240030567e6SVarun Wadekar #define CTX_FP_Q13		U(0xd0)
241030567e6SVarun Wadekar #define CTX_FP_Q14		U(0xe0)
242030567e6SVarun Wadekar #define CTX_FP_Q15		U(0xf0)
243030567e6SVarun Wadekar #define CTX_FP_Q16		U(0x100)
244030567e6SVarun Wadekar #define CTX_FP_Q17		U(0x110)
245030567e6SVarun Wadekar #define CTX_FP_Q18		U(0x120)
246030567e6SVarun Wadekar #define CTX_FP_Q19		U(0x130)
247030567e6SVarun Wadekar #define CTX_FP_Q20		U(0x140)
248030567e6SVarun Wadekar #define CTX_FP_Q21		U(0x150)
249030567e6SVarun Wadekar #define CTX_FP_Q22		U(0x160)
250030567e6SVarun Wadekar #define CTX_FP_Q23		U(0x170)
251030567e6SVarun Wadekar #define CTX_FP_Q24		U(0x180)
252030567e6SVarun Wadekar #define CTX_FP_Q25		U(0x190)
253030567e6SVarun Wadekar #define CTX_FP_Q26		U(0x1a0)
254030567e6SVarun Wadekar #define CTX_FP_Q27		U(0x1b0)
255030567e6SVarun Wadekar #define CTX_FP_Q28		U(0x1c0)
256030567e6SVarun Wadekar #define CTX_FP_Q29		U(0x1d0)
257030567e6SVarun Wadekar #define CTX_FP_Q30		U(0x1e0)
258030567e6SVarun Wadekar #define CTX_FP_Q31		U(0x1f0)
259030567e6SVarun Wadekar #define CTX_FP_FPSR		U(0x200)
260030567e6SVarun Wadekar #define CTX_FP_FPCR		U(0x208)
26191089f36SDavid Cunado #if CTX_INCLUDE_AARCH32_REGS
26291089f36SDavid Cunado #define CTX_FP_FPEXC32_EL2	U(0x210)
26391089f36SDavid Cunado #define CTX_FPREGS_END		U(0x220) /* Align to the next 16 byte boundary */
26491089f36SDavid Cunado #else
26591089f36SDavid Cunado #define CTX_FPREGS_END		U(0x210) /* Align to the next 16 byte boundary */
26691089f36SDavid Cunado #endif
267fe007b2eSDimitris Papastamos #else
268fe007b2eSDimitris Papastamos #define CTX_FPREGS_END		U(0)
269532ed618SSoby Mathew #endif
270532ed618SSoby Mathew 
2714d1ccf0eSAntonio Nino Diaz /*******************************************************************************
2724d1ccf0eSAntonio Nino Diaz  * Registers related to CVE-2018-3639
2734d1ccf0eSAntonio Nino Diaz  ******************************************************************************/
274fe007b2eSDimitris Papastamos #define CTX_CVE_2018_3639_OFFSET	(CTX_FPREGS_OFFSET + CTX_FPREGS_END)
275fe007b2eSDimitris Papastamos #define CTX_CVE_2018_3639_DISABLE	U(0)
276fe007b2eSDimitris Papastamos #define CTX_CVE_2018_3639_END		U(0x10) /* Align to the next 16 byte boundary */
277fe007b2eSDimitris Papastamos 
2785283962eSAntonio Nino Diaz /*******************************************************************************
2795283962eSAntonio Nino Diaz  * Registers related to ARMv8.3-PAuth.
2805283962eSAntonio Nino Diaz  ******************************************************************************/
2815283962eSAntonio Nino Diaz #define CTX_PAUTH_REGS_OFFSET	(CTX_CVE_2018_3639_OFFSET + CTX_CVE_2018_3639_END)
2825283962eSAntonio Nino Diaz #if CTX_INCLUDE_PAUTH_REGS
2835283962eSAntonio Nino Diaz #define CTX_PACIAKEY_LO		U(0x0)
2845283962eSAntonio Nino Diaz #define CTX_PACIAKEY_HI		U(0x8)
2855283962eSAntonio Nino Diaz #define CTX_PACIBKEY_LO		U(0x10)
2865283962eSAntonio Nino Diaz #define CTX_PACIBKEY_HI		U(0x18)
2875283962eSAntonio Nino Diaz #define CTX_PACDAKEY_LO		U(0x20)
2885283962eSAntonio Nino Diaz #define CTX_PACDAKEY_HI		U(0x28)
2895283962eSAntonio Nino Diaz #define CTX_PACDBKEY_LO		U(0x30)
2905283962eSAntonio Nino Diaz #define CTX_PACDBKEY_HI		U(0x38)
2915283962eSAntonio Nino Diaz #define CTX_PACGAKEY_LO		U(0x40)
2925283962eSAntonio Nino Diaz #define CTX_PACGAKEY_HI		U(0x48)
293ed108b56SAlexei Fedorov #define CTX_PAUTH_REGS_END	U(0x50) /* Align to the next 16 byte boundary */
2945283962eSAntonio Nino Diaz #else
2955283962eSAntonio Nino Diaz #define CTX_PAUTH_REGS_END	U(0)
2965283962eSAntonio Nino Diaz #endif /* CTX_INCLUDE_PAUTH_REGS */
2975283962eSAntonio Nino Diaz 
298d5dfdeb6SJulius Werner #ifndef __ASSEMBLER__
299532ed618SSoby Mathew 
300532ed618SSoby Mathew #include <stdint.h>
301532ed618SSoby Mathew 
30209d40e0eSAntonio Nino Diaz #include <lib/cassert.h>
30309d40e0eSAntonio Nino Diaz 
304532ed618SSoby Mathew /*
305532ed618SSoby Mathew  * Common constants to help define the 'cpu_context' structure and its
306532ed618SSoby Mathew  * members below.
307532ed618SSoby Mathew  */
308030567e6SVarun Wadekar #define DWORD_SHIFT		U(3)
309532ed618SSoby Mathew #define DEFINE_REG_STRUCT(name, num_regs)	\
310532ed618SSoby Mathew 	typedef struct name {			\
3112fe75a2dSZelalem 		uint64_t ctx_regs[num_regs];	\
312532ed618SSoby Mathew 	}  __aligned(16) name##_t
313532ed618SSoby Mathew 
314532ed618SSoby Mathew /* Constants to determine the size of individual context structures */
315532ed618SSoby Mathew #define CTX_GPREG_ALL		(CTX_GPREGS_END >> DWORD_SHIFT)
316532ed618SSoby Mathew #define CTX_SYSREG_ALL		(CTX_SYSREGS_END >> DWORD_SHIFT)
317532ed618SSoby Mathew #if CTX_INCLUDE_FPREGS
318532ed618SSoby Mathew # define CTX_FPREG_ALL		(CTX_FPREGS_END >> DWORD_SHIFT)
319532ed618SSoby Mathew #endif
320532ed618SSoby Mathew #define CTX_EL3STATE_ALL	(CTX_EL3STATE_END >> DWORD_SHIFT)
321fe007b2eSDimitris Papastamos #define CTX_CVE_2018_3639_ALL	(CTX_CVE_2018_3639_END >> DWORD_SHIFT)
3225283962eSAntonio Nino Diaz #if CTX_INCLUDE_PAUTH_REGS
3235283962eSAntonio Nino Diaz # define CTX_PAUTH_REGS_ALL	(CTX_PAUTH_REGS_END >> DWORD_SHIFT)
3245283962eSAntonio Nino Diaz #endif
325532ed618SSoby Mathew 
326532ed618SSoby Mathew /*
327532ed618SSoby Mathew  * AArch64 general purpose register context structure. Usually x0-x18,
328532ed618SSoby Mathew  * lr are saved as the compiler is expected to preserve the remaining
329532ed618SSoby Mathew  * callee saved registers if used by the C runtime and the assembler
330532ed618SSoby Mathew  * does not touch the remaining. But in case of world switch during
331532ed618SSoby Mathew  * exception handling, we need to save the callee registers too.
332532ed618SSoby Mathew  */
333532ed618SSoby Mathew DEFINE_REG_STRUCT(gp_regs, CTX_GPREG_ALL);
334532ed618SSoby Mathew 
335532ed618SSoby Mathew /*
336*28f39f02SMax Shvetsov  * AArch64 EL1/EL2 system register context structure for preserving the
337*28f39f02SMax Shvetsov  * architectural state during world switches.
338532ed618SSoby Mathew  */
339*28f39f02SMax Shvetsov DEFINE_REG_STRUCT(sys_regs, CTX_SYSREG_ALL);
340532ed618SSoby Mathew 
341532ed618SSoby Mathew /*
342532ed618SSoby Mathew  * AArch64 floating point register context structure for preserving
343532ed618SSoby Mathew  * the floating point state during switches from one security state to
344532ed618SSoby Mathew  * another.
345532ed618SSoby Mathew  */
346532ed618SSoby Mathew #if CTX_INCLUDE_FPREGS
347532ed618SSoby Mathew DEFINE_REG_STRUCT(fp_regs, CTX_FPREG_ALL);
348532ed618SSoby Mathew #endif
349532ed618SSoby Mathew 
350532ed618SSoby Mathew /*
351532ed618SSoby Mathew  * Miscellaneous registers used by EL3 firmware to maintain its state
352532ed618SSoby Mathew  * across exception entries and exits
353532ed618SSoby Mathew  */
354532ed618SSoby Mathew DEFINE_REG_STRUCT(el3_state, CTX_EL3STATE_ALL);
355532ed618SSoby Mathew 
356fe007b2eSDimitris Papastamos /* Function pointer used by CVE-2018-3639 dynamic mitigation */
357fe007b2eSDimitris Papastamos DEFINE_REG_STRUCT(cve_2018_3639, CTX_CVE_2018_3639_ALL);
358fe007b2eSDimitris Papastamos 
3595283962eSAntonio Nino Diaz /* Registers associated to ARMv8.3-PAuth */
3605283962eSAntonio Nino Diaz #if CTX_INCLUDE_PAUTH_REGS
3615283962eSAntonio Nino Diaz DEFINE_REG_STRUCT(pauth, CTX_PAUTH_REGS_ALL);
3625283962eSAntonio Nino Diaz #endif
3635283962eSAntonio Nino Diaz 
364532ed618SSoby Mathew /*
365532ed618SSoby Mathew  * Macros to access members of any of the above structures using their
366532ed618SSoby Mathew  * offsets
367532ed618SSoby Mathew  */
3682fe75a2dSZelalem #define read_ctx_reg(ctx, offset)	((ctx)->ctx_regs[(offset) >> DWORD_SHIFT])
3692fe75a2dSZelalem #define write_ctx_reg(ctx, offset, val)	(((ctx)->ctx_regs[(offset) >> DWORD_SHIFT]) \
370ba6e5ca6SJeenu Viswambharan 					 = (uint64_t) (val))
371532ed618SSoby Mathew 
372532ed618SSoby Mathew /*
373532ed618SSoby Mathew  * Top-level context structure which is used by EL3 firmware to
374532ed618SSoby Mathew  * preserve the state of a core at EL1 in one of the two security
375532ed618SSoby Mathew  * states and save enough EL3 meta data to be able to return to that
376532ed618SSoby Mathew  * EL and security state. The context management library will be used
377532ed618SSoby Mathew  * to ensure that SP_EL3 always points to an instance of this
378532ed618SSoby Mathew  * structure at exception entry and exit. Each instance will
379532ed618SSoby Mathew  * correspond to either the secure or the non-secure state.
380532ed618SSoby Mathew  */
381532ed618SSoby Mathew typedef struct cpu_context {
382532ed618SSoby Mathew 	gp_regs_t gpregs_ctx;
383532ed618SSoby Mathew 	el3_state_t el3state_ctx;
384*28f39f02SMax Shvetsov 	sys_regs_t sysregs_ctx;
385532ed618SSoby Mathew #if CTX_INCLUDE_FPREGS
386532ed618SSoby Mathew 	fp_regs_t fpregs_ctx;
387532ed618SSoby Mathew #endif
388fe007b2eSDimitris Papastamos 	cve_2018_3639_t cve_2018_3639_ctx;
3895283962eSAntonio Nino Diaz #if CTX_INCLUDE_PAUTH_REGS
3905283962eSAntonio Nino Diaz 	pauth_t pauth_ctx;
3915283962eSAntonio Nino Diaz #endif
392532ed618SSoby Mathew } cpu_context_t;
393532ed618SSoby Mathew 
394532ed618SSoby Mathew /* Macros to access members of the 'cpu_context_t' structure */
395532ed618SSoby Mathew #define get_el3state_ctx(h)	(&((cpu_context_t *) h)->el3state_ctx)
396532ed618SSoby Mathew #if CTX_INCLUDE_FPREGS
397532ed618SSoby Mathew # define get_fpregs_ctx(h)	(&((cpu_context_t *) h)->fpregs_ctx)
398532ed618SSoby Mathew #endif
399532ed618SSoby Mathew #define get_sysregs_ctx(h)	(&((cpu_context_t *) h)->sysregs_ctx)
400532ed618SSoby Mathew #define get_gpregs_ctx(h)	(&((cpu_context_t *) h)->gpregs_ctx)
4016f03bc77SDimitris Papastamos #define get_cve_2018_3639_ctx(h)	(&((cpu_context_t *) h)->cve_2018_3639_ctx)
4025283962eSAntonio Nino Diaz #if CTX_INCLUDE_PAUTH_REGS
4035283962eSAntonio Nino Diaz # define get_pauth_ctx(h)	(&((cpu_context_t *) h)->pauth_ctx)
4045283962eSAntonio Nino Diaz #endif
405532ed618SSoby Mathew 
406532ed618SSoby Mathew /*
407532ed618SSoby Mathew  * Compile time assertions related to the 'cpu_context' structure to
408532ed618SSoby Mathew  * ensure that the assembler and the compiler view of the offsets of
409532ed618SSoby Mathew  * the structure members is the same.
410532ed618SSoby Mathew  */
411532ed618SSoby Mathew CASSERT(CTX_GPREGS_OFFSET == __builtin_offsetof(cpu_context_t, gpregs_ctx), \
412532ed618SSoby Mathew 	assert_core_context_gp_offset_mismatch);
413532ed618SSoby Mathew CASSERT(CTX_SYSREGS_OFFSET == __builtin_offsetof(cpu_context_t, sysregs_ctx), \
414532ed618SSoby Mathew 	assert_core_context_sys_offset_mismatch);
415532ed618SSoby Mathew #if CTX_INCLUDE_FPREGS
416532ed618SSoby Mathew CASSERT(CTX_FPREGS_OFFSET == __builtin_offsetof(cpu_context_t, fpregs_ctx), \
417532ed618SSoby Mathew 	assert_core_context_fp_offset_mismatch);
418532ed618SSoby Mathew #endif
419532ed618SSoby Mathew CASSERT(CTX_EL3STATE_OFFSET == __builtin_offsetof(cpu_context_t, el3state_ctx), \
420532ed618SSoby Mathew 	assert_core_context_el3state_offset_mismatch);
421fe007b2eSDimitris Papastamos CASSERT(CTX_CVE_2018_3639_OFFSET == __builtin_offsetof(cpu_context_t, cve_2018_3639_ctx), \
422fe007b2eSDimitris Papastamos 	assert_core_context_cve_2018_3639_offset_mismatch);
4235283962eSAntonio Nino Diaz #if CTX_INCLUDE_PAUTH_REGS
4245283962eSAntonio Nino Diaz CASSERT(CTX_PAUTH_REGS_OFFSET == __builtin_offsetof(cpu_context_t, pauth_ctx), \
4255283962eSAntonio Nino Diaz 	assert_core_context_pauth_offset_mismatch);
4265283962eSAntonio Nino Diaz #endif
427532ed618SSoby Mathew 
428532ed618SSoby Mathew /*
429532ed618SSoby Mathew  * Helper macro to set the general purpose registers that correspond to
430532ed618SSoby Mathew  * parameters in an aapcs_64 call i.e. x0-x7
431532ed618SSoby Mathew  */
432532ed618SSoby Mathew #define set_aapcs_args0(ctx, x0)				do {	\
433532ed618SSoby Mathew 		write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X0, x0);	\
434532ed618SSoby Mathew 	} while (0)
435532ed618SSoby Mathew #define set_aapcs_args1(ctx, x0, x1)				do {	\
436532ed618SSoby Mathew 		write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X1, x1);	\
437532ed618SSoby Mathew 		set_aapcs_args0(ctx, x0);				\
438532ed618SSoby Mathew 	} while (0)
439532ed618SSoby Mathew #define set_aapcs_args2(ctx, x0, x1, x2)			do {	\
440532ed618SSoby Mathew 		write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X2, x2);	\
441532ed618SSoby Mathew 		set_aapcs_args1(ctx, x0, x1);				\
442532ed618SSoby Mathew 	} while (0)
443532ed618SSoby Mathew #define set_aapcs_args3(ctx, x0, x1, x2, x3)			do {	\
444532ed618SSoby Mathew 		write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X3, x3);	\
445532ed618SSoby Mathew 		set_aapcs_args2(ctx, x0, x1, x2);			\
446532ed618SSoby Mathew 	} while (0)
447532ed618SSoby Mathew #define set_aapcs_args4(ctx, x0, x1, x2, x3, x4)		do {	\
448532ed618SSoby Mathew 		write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X4, x4);	\
449532ed618SSoby Mathew 		set_aapcs_args3(ctx, x0, x1, x2, x3);			\
450532ed618SSoby Mathew 	} while (0)
451532ed618SSoby Mathew #define set_aapcs_args5(ctx, x0, x1, x2, x3, x4, x5)		do {	\
452532ed618SSoby Mathew 		write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X5, x5);	\
453532ed618SSoby Mathew 		set_aapcs_args4(ctx, x0, x1, x2, x3, x4);		\
454532ed618SSoby Mathew 	} while (0)
455532ed618SSoby Mathew #define set_aapcs_args6(ctx, x0, x1, x2, x3, x4, x5, x6)	do {	\
456532ed618SSoby Mathew 		write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X6, x6);	\
457532ed618SSoby Mathew 		set_aapcs_args5(ctx, x0, x1, x2, x3, x4, x5);		\
458532ed618SSoby Mathew 	} while (0)
459532ed618SSoby Mathew #define set_aapcs_args7(ctx, x0, x1, x2, x3, x4, x5, x6, x7)	do {	\
460532ed618SSoby Mathew 		write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X7, x7);	\
461532ed618SSoby Mathew 		set_aapcs_args6(ctx, x0, x1, x2, x3, x4, x5, x6);	\
462532ed618SSoby Mathew 	} while (0)
463532ed618SSoby Mathew 
464532ed618SSoby Mathew /*******************************************************************************
465532ed618SSoby Mathew  * Function prototypes
466532ed618SSoby Mathew  ******************************************************************************/
467*28f39f02SMax Shvetsov void el1_sysregs_context_save(sys_regs_t *regs);
468*28f39f02SMax Shvetsov void el1_sysregs_context_restore(sys_regs_t *regs);
469*28f39f02SMax Shvetsov 
470*28f39f02SMax Shvetsov #if CTX_INCLUDE_EL2_REGS
471*28f39f02SMax Shvetsov void el2_sysregs_context_save(sys_regs_t *regs);
472*28f39f02SMax Shvetsov void el2_sysregs_context_restore(sys_regs_t *regs);
473*28f39f02SMax Shvetsov #endif
474*28f39f02SMax Shvetsov 
475532ed618SSoby Mathew #if CTX_INCLUDE_FPREGS
476532ed618SSoby Mathew void fpregs_context_save(fp_regs_t *regs);
477532ed618SSoby Mathew void fpregs_context_restore(fp_regs_t *regs);
478532ed618SSoby Mathew #endif
479532ed618SSoby Mathew 
480d5dfdeb6SJulius Werner #endif /* __ASSEMBLER__ */
481532ed618SSoby Mathew 
482a0fee747SAntonio Nino Diaz #endif /* CONTEXT_H */
483