xref: /rk3399_ARM-atf/include/lib/el3_runtime/aarch64/context.h (revision f87e54f73cfee5042df526af6185ac6d9653a8f5)
1532ed618SSoby Mathew /*
2461c0a5dSElizabeth Ho  * Copyright (c) 2013-2023, 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 
10461c0a5dSElizabeth Ho #include <lib/el3_runtime/cpu_data.h>
1109d40e0eSAntonio Nino Diaz #include <lib/utils_def.h>
1276454abfSJeenu Viswambharan 
13532ed618SSoby Mathew /*******************************************************************************
14532ed618SSoby Mathew  * Constants that allow assembler code to access members of and the 'gp_regs'
15532ed618SSoby Mathew  * structure at their correct offsets.
16532ed618SSoby Mathew  ******************************************************************************/
17030567e6SVarun Wadekar #define CTX_GPREGS_OFFSET	U(0x0)
18030567e6SVarun Wadekar #define CTX_GPREG_X0		U(0x0)
19030567e6SVarun Wadekar #define CTX_GPREG_X1		U(0x8)
20030567e6SVarun Wadekar #define CTX_GPREG_X2		U(0x10)
21030567e6SVarun Wadekar #define CTX_GPREG_X3		U(0x18)
22030567e6SVarun Wadekar #define CTX_GPREG_X4		U(0x20)
23030567e6SVarun Wadekar #define CTX_GPREG_X5		U(0x28)
24030567e6SVarun Wadekar #define CTX_GPREG_X6		U(0x30)
25030567e6SVarun Wadekar #define CTX_GPREG_X7		U(0x38)
26030567e6SVarun Wadekar #define CTX_GPREG_X8		U(0x40)
27030567e6SVarun Wadekar #define CTX_GPREG_X9		U(0x48)
28030567e6SVarun Wadekar #define CTX_GPREG_X10		U(0x50)
29030567e6SVarun Wadekar #define CTX_GPREG_X11		U(0x58)
30030567e6SVarun Wadekar #define CTX_GPREG_X12		U(0x60)
31030567e6SVarun Wadekar #define CTX_GPREG_X13		U(0x68)
32030567e6SVarun Wadekar #define CTX_GPREG_X14		U(0x70)
33030567e6SVarun Wadekar #define CTX_GPREG_X15		U(0x78)
34030567e6SVarun Wadekar #define CTX_GPREG_X16		U(0x80)
35030567e6SVarun Wadekar #define CTX_GPREG_X17		U(0x88)
36030567e6SVarun Wadekar #define CTX_GPREG_X18		U(0x90)
37030567e6SVarun Wadekar #define CTX_GPREG_X19		U(0x98)
38030567e6SVarun Wadekar #define CTX_GPREG_X20		U(0xa0)
39030567e6SVarun Wadekar #define CTX_GPREG_X21		U(0xa8)
40030567e6SVarun Wadekar #define CTX_GPREG_X22		U(0xb0)
41030567e6SVarun Wadekar #define CTX_GPREG_X23		U(0xb8)
42030567e6SVarun Wadekar #define CTX_GPREG_X24		U(0xc0)
43030567e6SVarun Wadekar #define CTX_GPREG_X25		U(0xc8)
44030567e6SVarun Wadekar #define CTX_GPREG_X26		U(0xd0)
45030567e6SVarun Wadekar #define CTX_GPREG_X27		U(0xd8)
46030567e6SVarun Wadekar #define CTX_GPREG_X28		U(0xe0)
47030567e6SVarun Wadekar #define CTX_GPREG_X29		U(0xe8)
48030567e6SVarun Wadekar #define CTX_GPREG_LR		U(0xf0)
49030567e6SVarun Wadekar #define CTX_GPREG_SP_EL0	U(0xf8)
50030567e6SVarun Wadekar #define CTX_GPREGS_END		U(0x100)
51532ed618SSoby Mathew 
52532ed618SSoby Mathew /*******************************************************************************
53532ed618SSoby Mathew  * Constants that allow assembler code to access members of and the 'el3_state'
54532ed618SSoby Mathew  * structure at their correct offsets. Note that some of the registers are only
55532ed618SSoby Mathew  * 32-bits wide but are stored as 64-bit values for convenience
56532ed618SSoby Mathew  ******************************************************************************/
57d9bd656cSDimitris Papastamos #define CTX_EL3STATE_OFFSET	(CTX_GPREGS_OFFSET + CTX_GPREGS_END)
58030567e6SVarun Wadekar #define CTX_SCR_EL3		U(0x0)
5976454abfSJeenu Viswambharan #define CTX_ESR_EL3		U(0x8)
6076454abfSJeenu Viswambharan #define CTX_RUNTIME_SP		U(0x10)
6176454abfSJeenu Viswambharan #define CTX_SPSR_EL3		U(0x18)
6276454abfSJeenu Viswambharan #define CTX_ELR_EL3		U(0x20)
63e290a8fcSAlexei Fedorov #define CTX_PMCR_EL0		U(0x28)
64c2d32a5fSMadhukar Pappireddy #define CTX_IS_IN_EL3		U(0x30)
65461c0a5dSElizabeth Ho #define CTX_MPAM3_EL3		U(0x38)
66d04c04a4SManish Pandey /* Constants required in supporting nested exception in EL3 */
67d04c04a4SManish Pandey #define CTX_SAVED_ELR_EL3	U(0x40)
68d04c04a4SManish Pandey /*
69d04c04a4SManish Pandey  * General purpose flag, to save various EL3 states
70d04c04a4SManish Pandey  * FFH mode : Used to identify if handling nested exception
71d04c04a4SManish Pandey  * KFH mode : Used as counter value
72d04c04a4SManish Pandey  */
73d04c04a4SManish Pandey #define CTX_NESTED_EA_FLAG	U(0x48)
74*f87e54f7SManish Pandey #if FFH_SUPPORT
75d04c04a4SManish Pandey  #define CTX_SAVED_ESR_EL3	U(0x50)
76d04c04a4SManish Pandey  #define CTX_SAVED_SPSR_EL3	U(0x58)
77d04c04a4SManish Pandey  #define CTX_SAVED_GPREG_LR	U(0x60)
78d04c04a4SManish Pandey  #define CTX_EL3STATE_END	U(0x70) /* Align to the next 16 byte boundary */
79d04c04a4SManish Pandey #else
80d04c04a4SManish Pandey  #define CTX_EL3STATE_END	U(0x50) /* Align to the next 16 byte boundary */
81d04c04a4SManish Pandey #endif
82532ed618SSoby Mathew 
83532ed618SSoby Mathew /*******************************************************************************
84532ed618SSoby Mathew  * Constants that allow assembler code to access members of and the
85532ed618SSoby Mathew  * 'el1_sys_regs' structure at their correct offsets. Note that some of the
86532ed618SSoby Mathew  * registers are only 32-bits wide but are stored as 64-bit values for
87532ed618SSoby Mathew  * convenience
88532ed618SSoby Mathew  ******************************************************************************/
892825946eSMax Shvetsov #define CTX_EL1_SYSREGS_OFFSET	(CTX_EL3STATE_OFFSET + CTX_EL3STATE_END)
90030567e6SVarun Wadekar #define CTX_SPSR_EL1		U(0x0)
91030567e6SVarun Wadekar #define CTX_ELR_EL1		U(0x8)
92030567e6SVarun Wadekar #define CTX_SCTLR_EL1		U(0x10)
93cb55615cSManish V Badarkhe #define CTX_TCR_EL1		U(0x18)
94030567e6SVarun Wadekar #define CTX_CPACR_EL1		U(0x20)
95030567e6SVarun Wadekar #define CTX_CSSELR_EL1		U(0x28)
96030567e6SVarun Wadekar #define CTX_SP_EL1		U(0x30)
97030567e6SVarun Wadekar #define CTX_ESR_EL1		U(0x38)
98030567e6SVarun Wadekar #define CTX_TTBR0_EL1		U(0x40)
99030567e6SVarun Wadekar #define CTX_TTBR1_EL1		U(0x48)
100030567e6SVarun Wadekar #define CTX_MAIR_EL1		U(0x50)
101030567e6SVarun Wadekar #define CTX_AMAIR_EL1		U(0x58)
102cb55615cSManish V Badarkhe #define CTX_ACTLR_EL1		U(0x60)
103030567e6SVarun Wadekar #define CTX_TPIDR_EL1		U(0x68)
104030567e6SVarun Wadekar #define CTX_TPIDR_EL0		U(0x70)
105030567e6SVarun Wadekar #define CTX_TPIDRRO_EL0		U(0x78)
106030567e6SVarun Wadekar #define CTX_PAR_EL1		U(0x80)
107030567e6SVarun Wadekar #define CTX_FAR_EL1		U(0x88)
108030567e6SVarun Wadekar #define CTX_AFSR0_EL1		U(0x90)
109030567e6SVarun Wadekar #define CTX_AFSR1_EL1		U(0x98)
110030567e6SVarun Wadekar #define CTX_CONTEXTIDR_EL1	U(0xa0)
111030567e6SVarun Wadekar #define CTX_VBAR_EL1		U(0xa8)
112532ed618SSoby Mathew 
113532ed618SSoby Mathew /*
114532ed618SSoby Mathew  * If the platform is AArch64-only, there is no need to save and restore these
115532ed618SSoby Mathew  * AArch32 registers.
116532ed618SSoby Mathew  */
117532ed618SSoby Mathew #if CTX_INCLUDE_AARCH32_REGS
118e290a8fcSAlexei Fedorov #define CTX_SPSR_ABT		U(0xb0)	/* Align to the next 16 byte boundary */
119e290a8fcSAlexei Fedorov #define CTX_SPSR_UND		U(0xb8)
120e290a8fcSAlexei Fedorov #define CTX_SPSR_IRQ		U(0xc0)
121e290a8fcSAlexei Fedorov #define CTX_SPSR_FIQ		U(0xc8)
122e290a8fcSAlexei Fedorov #define CTX_DACR32_EL2		U(0xd0)
123e290a8fcSAlexei Fedorov #define CTX_IFSR32_EL2		U(0xd8)
124e290a8fcSAlexei Fedorov #define CTX_AARCH32_END		U(0xe0) /* Align to the next 16 byte boundary */
125532ed618SSoby Mathew #else
126e290a8fcSAlexei Fedorov #define CTX_AARCH32_END		U(0xb0)	/* Align to the next 16 byte boundary */
1274d1ccf0eSAntonio Nino Diaz #endif /* CTX_INCLUDE_AARCH32_REGS */
128532ed618SSoby Mathew 
129532ed618SSoby Mathew /*
130532ed618SSoby Mathew  * If the timer registers aren't saved and restored, we don't have to reserve
131532ed618SSoby Mathew  * space for them in the context
132532ed618SSoby Mathew  */
133532ed618SSoby Mathew #if NS_TIMER_SWITCH
1344d1ccf0eSAntonio Nino Diaz #define CTX_CNTP_CTL_EL0	(CTX_AARCH32_END + U(0x0))
1354d1ccf0eSAntonio Nino Diaz #define CTX_CNTP_CVAL_EL0	(CTX_AARCH32_END + U(0x8))
1364d1ccf0eSAntonio Nino Diaz #define CTX_CNTV_CTL_EL0	(CTX_AARCH32_END + U(0x10))
1374d1ccf0eSAntonio Nino Diaz #define CTX_CNTV_CVAL_EL0	(CTX_AARCH32_END + U(0x18))
1384d1ccf0eSAntonio Nino Diaz #define CTX_CNTKCTL_EL1		(CTX_AARCH32_END + U(0x20))
1394d1ccf0eSAntonio Nino Diaz #define CTX_TIMER_SYSREGS_END	(CTX_AARCH32_END + U(0x30)) /* Align to the next 16 byte boundary */
140532ed618SSoby Mathew #else
1414d1ccf0eSAntonio Nino Diaz #define CTX_TIMER_SYSREGS_END	CTX_AARCH32_END
1424d1ccf0eSAntonio Nino Diaz #endif /* NS_TIMER_SWITCH */
1434d1ccf0eSAntonio Nino Diaz 
1449dd94382SJustin Chadwell #if CTX_INCLUDE_MTE_REGS
1459dd94382SJustin Chadwell #define CTX_TFSRE0_EL1		(CTX_TIMER_SYSREGS_END + U(0x0))
1469dd94382SJustin Chadwell #define CTX_TFSR_EL1		(CTX_TIMER_SYSREGS_END + U(0x8))
1479dd94382SJustin Chadwell #define CTX_RGSR_EL1		(CTX_TIMER_SYSREGS_END + U(0x10))
1489dd94382SJustin Chadwell #define CTX_GCR_EL1		(CTX_TIMER_SYSREGS_END + U(0x18))
1499dd94382SJustin Chadwell 
1509dd94382SJustin Chadwell /* Align to the next 16 byte boundary */
1519dd94382SJustin Chadwell #define CTX_MTE_REGS_END	(CTX_TIMER_SYSREGS_END + U(0x20))
1529dd94382SJustin Chadwell #else
1539dd94382SJustin Chadwell #define CTX_MTE_REGS_END	CTX_TIMER_SYSREGS_END
1549dd94382SJustin Chadwell #endif /* CTX_INCLUDE_MTE_REGS */
1559dd94382SJustin Chadwell 
1564d1ccf0eSAntonio Nino Diaz /*
1572825946eSMax Shvetsov  * End of system registers.
1582825946eSMax Shvetsov  */
1592825946eSMax Shvetsov #define CTX_EL1_SYSREGS_END		CTX_MTE_REGS_END
1602825946eSMax Shvetsov 
1612825946eSMax Shvetsov /*
1622825946eSMax Shvetsov  * EL2 register set
16328f39f02SMax Shvetsov  */
16428f39f02SMax Shvetsov 
16528f39f02SMax Shvetsov #if CTX_INCLUDE_EL2_REGS
16628f39f02SMax Shvetsov /* For later discussion
16728f39f02SMax Shvetsov  * ICH_AP0R<n>_EL2
16828f39f02SMax Shvetsov  * ICH_AP1R<n>_EL2
16928f39f02SMax Shvetsov  * AMEVCNTVOFF0<n>_EL2
17028f39f02SMax Shvetsov  * AMEVCNTVOFF1<n>_EL2
17128f39f02SMax Shvetsov  * ICH_LR<n>_EL2
17228f39f02SMax Shvetsov  */
1732825946eSMax Shvetsov #define CTX_EL2_SYSREGS_OFFSET	(CTX_EL1_SYSREGS_OFFSET + CTX_EL1_SYSREGS_END)
17428f39f02SMax Shvetsov 
1752825946eSMax Shvetsov #define CTX_ACTLR_EL2		U(0x0)
1762825946eSMax Shvetsov #define CTX_AFSR0_EL2		U(0x8)
1772825946eSMax Shvetsov #define CTX_AFSR1_EL2		U(0x10)
1782825946eSMax Shvetsov #define CTX_AMAIR_EL2		U(0x18)
1792825946eSMax Shvetsov #define CTX_CNTHCTL_EL2		U(0x20)
180a7cf2743SMax Shvetsov #define CTX_CNTVOFF_EL2		U(0x28)
181a7cf2743SMax Shvetsov #define CTX_CPTR_EL2		U(0x30)
182a7cf2743SMax Shvetsov #define CTX_DBGVCR32_EL2	U(0x38)
183a7cf2743SMax Shvetsov #define CTX_ELR_EL2		U(0x40)
184a7cf2743SMax Shvetsov #define CTX_ESR_EL2		U(0x48)
185a7cf2743SMax Shvetsov #define CTX_FAR_EL2		U(0x50)
186a7cf2743SMax Shvetsov #define CTX_HACR_EL2		U(0x58)
187a7cf2743SMax Shvetsov #define CTX_HCR_EL2		U(0x60)
188a7cf2743SMax Shvetsov #define CTX_HPFAR_EL2		U(0x68)
189a7cf2743SMax Shvetsov #define CTX_HSTR_EL2		U(0x70)
190a7cf2743SMax Shvetsov #define CTX_ICC_SRE_EL2		U(0x78)
191a7cf2743SMax Shvetsov #define CTX_ICH_HCR_EL2		U(0x80)
192a7cf2743SMax Shvetsov #define CTX_ICH_VMCR_EL2	U(0x88)
193a7cf2743SMax Shvetsov #define CTX_MAIR_EL2		U(0x90)
194a7cf2743SMax Shvetsov #define CTX_MDCR_EL2		U(0x98)
195a7cf2743SMax Shvetsov #define CTX_PMSCR_EL2		U(0xa0)
196a7cf2743SMax Shvetsov #define CTX_SCTLR_EL2		U(0xa8)
197a7cf2743SMax Shvetsov #define CTX_SPSR_EL2		U(0xb0)
198a7cf2743SMax Shvetsov #define CTX_SP_EL2		U(0xb8)
199a7cf2743SMax Shvetsov #define CTX_TCR_EL2		U(0xc0)
200a7cf2743SMax Shvetsov #define CTX_TPIDR_EL2		U(0xc8)
201a7cf2743SMax Shvetsov #define CTX_TTBR0_EL2		U(0xd0)
202a7cf2743SMax Shvetsov #define CTX_VBAR_EL2		U(0xd8)
203a7cf2743SMax Shvetsov #define CTX_VMPIDR_EL2		U(0xe0)
204a7cf2743SMax Shvetsov #define CTX_VPIDR_EL2		U(0xe8)
205a7cf2743SMax Shvetsov #define CTX_VTCR_EL2		U(0xf0)
206a7cf2743SMax Shvetsov #define CTX_VTTBR_EL2		U(0xf8)
2072825946eSMax Shvetsov 
2082825946eSMax Shvetsov // Only if MTE registers in use
209a7cf2743SMax Shvetsov #define CTX_TFSR_EL2		U(0x100)
2102825946eSMax Shvetsov 
211a7cf2743SMax Shvetsov #define CTX_MPAM2_EL2		U(0x108)
212a7cf2743SMax Shvetsov #define CTX_MPAMHCR_EL2		U(0x110)
213a7cf2743SMax Shvetsov #define CTX_MPAMVPM0_EL2	U(0x118)
214a7cf2743SMax Shvetsov #define CTX_MPAMVPM1_EL2	U(0x120)
215a7cf2743SMax Shvetsov #define CTX_MPAMVPM2_EL2	U(0x128)
216a7cf2743SMax Shvetsov #define CTX_MPAMVPM3_EL2	U(0x130)
217a7cf2743SMax Shvetsov #define CTX_MPAMVPM4_EL2	U(0x138)
218a7cf2743SMax Shvetsov #define CTX_MPAMVPM5_EL2	U(0x140)
219a7cf2743SMax Shvetsov #define CTX_MPAMVPM6_EL2	U(0x148)
220a7cf2743SMax Shvetsov #define CTX_MPAMVPM7_EL2	U(0x150)
221a7cf2743SMax Shvetsov #define CTX_MPAMVPMV_EL2	U(0x158)
2222825946eSMax Shvetsov 
2232825946eSMax Shvetsov // Starting with Armv8.6
224f74cb0beSJayanth Dodderi Chidanand #define CTX_HDFGRTR_EL2		U(0x160)
225f74cb0beSJayanth Dodderi Chidanand #define CTX_HAFGRTR_EL2		U(0x168)
226a7cf2743SMax Shvetsov #define CTX_HDFGWTR_EL2		U(0x170)
227a7cf2743SMax Shvetsov #define CTX_HFGITR_EL2		U(0x178)
228a7cf2743SMax Shvetsov #define CTX_HFGRTR_EL2		U(0x180)
229a7cf2743SMax Shvetsov #define CTX_HFGWTR_EL2		U(0x188)
230a7cf2743SMax Shvetsov #define CTX_CNTPOFF_EL2		U(0x190)
2312825946eSMax Shvetsov 
2322825946eSMax Shvetsov // Starting with Armv8.4
233a7cf2743SMax Shvetsov #define CTX_CONTEXTIDR_EL2	U(0x198)
2340ce220afSJayanth Dodderi Chidanand #define CTX_TTBR1_EL2		U(0x1a0)
2350ce220afSJayanth Dodderi Chidanand #define CTX_VDISR_EL2		U(0x1a8)
2360ce220afSJayanth Dodderi Chidanand #define CTX_VSESR_EL2		U(0x1b0)
2377f41bcc7SZelalem Aweke #define CTX_VNCR_EL2		U(0x1b8)
2387f41bcc7SZelalem Aweke #define CTX_TRFCR_EL2		U(0x1c0)
2392825946eSMax Shvetsov 
2402825946eSMax Shvetsov // Starting with Armv8.5
2417f41bcc7SZelalem Aweke #define CTX_SCXTNUM_EL2		U(0x1c8)
242cb4ec47bSjohpow01 
243cb4ec47bSjohpow01 // Register for FEAT_HCX
2447f41bcc7SZelalem Aweke #define CTX_HCRX_EL2            U(0x1d0)
245cb4ec47bSjohpow01 
246d3331603SMark Brown // Starting with Armv8.9
247d3331603SMark Brown #define CTX_TCR2_EL2            U(0x1d8)
248062b6c6bSMark Brown #define CTX_POR_EL2             U(0x1e0)
249062b6c6bSMark Brown #define CTX_PIRE0_EL2           U(0x1e8)
250062b6c6bSMark Brown #define CTX_PIR_EL2             U(0x1f0)
251062b6c6bSMark Brown #define CTX_S2PIR_EL2		U(0x1f8)
252688ab57bSMark Brown #define CTX_GCSCR_EL2           U(0x200)
253688ab57bSMark Brown #define CTX_GCSPR_EL2           U(0x208)
254d3331603SMark Brown 
25528f39f02SMax Shvetsov /* Align to the next 16 byte boundary */
256688ab57bSMark Brown #define CTX_EL2_SYSREGS_END	U(0x210)
2577f164a83SOlivier Deprez 
25828f39f02SMax Shvetsov #endif /* CTX_INCLUDE_EL2_REGS */
25928f39f02SMax Shvetsov 
260532ed618SSoby Mathew /*******************************************************************************
261532ed618SSoby Mathew  * Constants that allow assembler code to access members of and the 'fp_regs'
262532ed618SSoby Mathew  * structure at their correct offsets.
263532ed618SSoby Mathew  ******************************************************************************/
2642825946eSMax Shvetsov #if CTX_INCLUDE_EL2_REGS
2652825946eSMax Shvetsov # define CTX_FPREGS_OFFSET	(CTX_EL2_SYSREGS_OFFSET + CTX_EL2_SYSREGS_END)
2662825946eSMax Shvetsov #else
2672825946eSMax Shvetsov # define CTX_FPREGS_OFFSET	(CTX_EL1_SYSREGS_OFFSET + CTX_EL1_SYSREGS_END)
2682825946eSMax Shvetsov #endif
269fe007b2eSDimitris Papastamos #if CTX_INCLUDE_FPREGS
270030567e6SVarun Wadekar #define CTX_FP_Q0		U(0x0)
271030567e6SVarun Wadekar #define CTX_FP_Q1		U(0x10)
272030567e6SVarun Wadekar #define CTX_FP_Q2		U(0x20)
273030567e6SVarun Wadekar #define CTX_FP_Q3		U(0x30)
274030567e6SVarun Wadekar #define CTX_FP_Q4		U(0x40)
275030567e6SVarun Wadekar #define CTX_FP_Q5		U(0x50)
276030567e6SVarun Wadekar #define CTX_FP_Q6		U(0x60)
277030567e6SVarun Wadekar #define CTX_FP_Q7		U(0x70)
278030567e6SVarun Wadekar #define CTX_FP_Q8		U(0x80)
279030567e6SVarun Wadekar #define CTX_FP_Q9		U(0x90)
280030567e6SVarun Wadekar #define CTX_FP_Q10		U(0xa0)
281030567e6SVarun Wadekar #define CTX_FP_Q11		U(0xb0)
282030567e6SVarun Wadekar #define CTX_FP_Q12		U(0xc0)
283030567e6SVarun Wadekar #define CTX_FP_Q13		U(0xd0)
284030567e6SVarun Wadekar #define CTX_FP_Q14		U(0xe0)
285030567e6SVarun Wadekar #define CTX_FP_Q15		U(0xf0)
286030567e6SVarun Wadekar #define CTX_FP_Q16		U(0x100)
287030567e6SVarun Wadekar #define CTX_FP_Q17		U(0x110)
288030567e6SVarun Wadekar #define CTX_FP_Q18		U(0x120)
289030567e6SVarun Wadekar #define CTX_FP_Q19		U(0x130)
290030567e6SVarun Wadekar #define CTX_FP_Q20		U(0x140)
291030567e6SVarun Wadekar #define CTX_FP_Q21		U(0x150)
292030567e6SVarun Wadekar #define CTX_FP_Q22		U(0x160)
293030567e6SVarun Wadekar #define CTX_FP_Q23		U(0x170)
294030567e6SVarun Wadekar #define CTX_FP_Q24		U(0x180)
295030567e6SVarun Wadekar #define CTX_FP_Q25		U(0x190)
296030567e6SVarun Wadekar #define CTX_FP_Q26		U(0x1a0)
297030567e6SVarun Wadekar #define CTX_FP_Q27		U(0x1b0)
298030567e6SVarun Wadekar #define CTX_FP_Q28		U(0x1c0)
299030567e6SVarun Wadekar #define CTX_FP_Q29		U(0x1d0)
300030567e6SVarun Wadekar #define CTX_FP_Q30		U(0x1e0)
301030567e6SVarun Wadekar #define CTX_FP_Q31		U(0x1f0)
302030567e6SVarun Wadekar #define CTX_FP_FPSR		U(0x200)
303030567e6SVarun Wadekar #define CTX_FP_FPCR		U(0x208)
30491089f36SDavid Cunado #if CTX_INCLUDE_AARCH32_REGS
30591089f36SDavid Cunado #define CTX_FP_FPEXC32_EL2	U(0x210)
30691089f36SDavid Cunado #define CTX_FPREGS_END		U(0x220) /* Align to the next 16 byte boundary */
30791089f36SDavid Cunado #else
30891089f36SDavid Cunado #define CTX_FPREGS_END		U(0x210) /* Align to the next 16 byte boundary */
30991089f36SDavid Cunado #endif
310fe007b2eSDimitris Papastamos #else
311fe007b2eSDimitris Papastamos #define CTX_FPREGS_END		U(0)
312532ed618SSoby Mathew #endif
313532ed618SSoby Mathew 
3144d1ccf0eSAntonio Nino Diaz /*******************************************************************************
3154d1ccf0eSAntonio Nino Diaz  * Registers related to CVE-2018-3639
3164d1ccf0eSAntonio Nino Diaz  ******************************************************************************/
317fe007b2eSDimitris Papastamos #define CTX_CVE_2018_3639_OFFSET	(CTX_FPREGS_OFFSET + CTX_FPREGS_END)
318fe007b2eSDimitris Papastamos #define CTX_CVE_2018_3639_DISABLE	U(0)
319fe007b2eSDimitris Papastamos #define CTX_CVE_2018_3639_END		U(0x10) /* Align to the next 16 byte boundary */
320fe007b2eSDimitris Papastamos 
3215283962eSAntonio Nino Diaz /*******************************************************************************
3225283962eSAntonio Nino Diaz  * Registers related to ARMv8.3-PAuth.
3235283962eSAntonio Nino Diaz  ******************************************************************************/
3245283962eSAntonio Nino Diaz #define CTX_PAUTH_REGS_OFFSET	(CTX_CVE_2018_3639_OFFSET + CTX_CVE_2018_3639_END)
3255283962eSAntonio Nino Diaz #if CTX_INCLUDE_PAUTH_REGS
3265283962eSAntonio Nino Diaz #define CTX_PACIAKEY_LO		U(0x0)
3275283962eSAntonio Nino Diaz #define CTX_PACIAKEY_HI		U(0x8)
3285283962eSAntonio Nino Diaz #define CTX_PACIBKEY_LO		U(0x10)
3295283962eSAntonio Nino Diaz #define CTX_PACIBKEY_HI		U(0x18)
3305283962eSAntonio Nino Diaz #define CTX_PACDAKEY_LO		U(0x20)
3315283962eSAntonio Nino Diaz #define CTX_PACDAKEY_HI		U(0x28)
3325283962eSAntonio Nino Diaz #define CTX_PACDBKEY_LO		U(0x30)
3335283962eSAntonio Nino Diaz #define CTX_PACDBKEY_HI		U(0x38)
3345283962eSAntonio Nino Diaz #define CTX_PACGAKEY_LO		U(0x40)
3355283962eSAntonio Nino Diaz #define CTX_PACGAKEY_HI		U(0x48)
336ed108b56SAlexei Fedorov #define CTX_PAUTH_REGS_END	U(0x50) /* Align to the next 16 byte boundary */
3375283962eSAntonio Nino Diaz #else
3385283962eSAntonio Nino Diaz #define CTX_PAUTH_REGS_END	U(0)
3395283962eSAntonio Nino Diaz #endif /* CTX_INCLUDE_PAUTH_REGS */
3405283962eSAntonio Nino Diaz 
341461c0a5dSElizabeth Ho /*******************************************************************************
342461c0a5dSElizabeth Ho  * Registers initialised in a per-world context.
343461c0a5dSElizabeth Ho  ******************************************************************************/
344461c0a5dSElizabeth Ho #define CTX_CPTR_EL3		U(0x0)
345461c0a5dSElizabeth Ho #define CTX_ZCR_EL3		U(0x8)
346461c0a5dSElizabeth Ho #define CTX_GLOBAL_EL3STATE_END	U(0x10)
347461c0a5dSElizabeth Ho 
348d5dfdeb6SJulius Werner #ifndef __ASSEMBLER__
349532ed618SSoby Mathew 
350532ed618SSoby Mathew #include <stdint.h>
351532ed618SSoby Mathew 
35209d40e0eSAntonio Nino Diaz #include <lib/cassert.h>
35309d40e0eSAntonio Nino Diaz 
354532ed618SSoby Mathew /*
355532ed618SSoby Mathew  * Common constants to help define the 'cpu_context' structure and its
356532ed618SSoby Mathew  * members below.
357532ed618SSoby Mathew  */
358030567e6SVarun Wadekar #define DWORD_SHIFT		U(3)
359532ed618SSoby Mathew #define DEFINE_REG_STRUCT(name, num_regs)	\
360532ed618SSoby Mathew 	typedef struct name {			\
3612fe75a2dSZelalem 		uint64_t ctx_regs[num_regs];	\
362532ed618SSoby Mathew 	}  __aligned(16) name##_t
363532ed618SSoby Mathew 
364532ed618SSoby Mathew /* Constants to determine the size of individual context structures */
365532ed618SSoby Mathew #define CTX_GPREG_ALL		(CTX_GPREGS_END >> DWORD_SHIFT)
3662825946eSMax Shvetsov #define CTX_EL1_SYSREGS_ALL	(CTX_EL1_SYSREGS_END >> DWORD_SHIFT)
3672825946eSMax Shvetsov #if CTX_INCLUDE_EL2_REGS
3682825946eSMax Shvetsov # define CTX_EL2_SYSREGS_ALL	(CTX_EL2_SYSREGS_END >> DWORD_SHIFT)
3692825946eSMax Shvetsov #endif
370532ed618SSoby Mathew #if CTX_INCLUDE_FPREGS
371532ed618SSoby Mathew # define CTX_FPREG_ALL		(CTX_FPREGS_END >> DWORD_SHIFT)
372532ed618SSoby Mathew #endif
373532ed618SSoby Mathew #define CTX_EL3STATE_ALL	(CTX_EL3STATE_END >> DWORD_SHIFT)
374fe007b2eSDimitris Papastamos #define CTX_CVE_2018_3639_ALL	(CTX_CVE_2018_3639_END >> DWORD_SHIFT)
3755283962eSAntonio Nino Diaz #if CTX_INCLUDE_PAUTH_REGS
3765283962eSAntonio Nino Diaz # define CTX_PAUTH_REGS_ALL	(CTX_PAUTH_REGS_END >> DWORD_SHIFT)
3775283962eSAntonio Nino Diaz #endif
378532ed618SSoby Mathew 
379532ed618SSoby Mathew /*
380532ed618SSoby Mathew  * AArch64 general purpose register context structure. Usually x0-x18,
381532ed618SSoby Mathew  * lr are saved as the compiler is expected to preserve the remaining
382532ed618SSoby Mathew  * callee saved registers if used by the C runtime and the assembler
383532ed618SSoby Mathew  * does not touch the remaining. But in case of world switch during
384532ed618SSoby Mathew  * exception handling, we need to save the callee registers too.
385532ed618SSoby Mathew  */
386532ed618SSoby Mathew DEFINE_REG_STRUCT(gp_regs, CTX_GPREG_ALL);
387532ed618SSoby Mathew 
388532ed618SSoby Mathew /*
3892825946eSMax Shvetsov  * AArch64 EL1 system register context structure for preserving the
39028f39f02SMax Shvetsov  * architectural state during world switches.
391532ed618SSoby Mathew  */
3922825946eSMax Shvetsov DEFINE_REG_STRUCT(el1_sysregs, CTX_EL1_SYSREGS_ALL);
3932825946eSMax Shvetsov 
3942825946eSMax Shvetsov 
3952825946eSMax Shvetsov /*
3962825946eSMax Shvetsov  * AArch64 EL2 system register context structure for preserving the
3972825946eSMax Shvetsov  * architectural state during world switches.
3982825946eSMax Shvetsov  */
3992825946eSMax Shvetsov #if CTX_INCLUDE_EL2_REGS
4002825946eSMax Shvetsov DEFINE_REG_STRUCT(el2_sysregs, CTX_EL2_SYSREGS_ALL);
4012825946eSMax Shvetsov #endif
402532ed618SSoby Mathew 
403532ed618SSoby Mathew /*
404532ed618SSoby Mathew  * AArch64 floating point register context structure for preserving
405532ed618SSoby Mathew  * the floating point state during switches from one security state to
406532ed618SSoby Mathew  * another.
407532ed618SSoby Mathew  */
408532ed618SSoby Mathew #if CTX_INCLUDE_FPREGS
409532ed618SSoby Mathew DEFINE_REG_STRUCT(fp_regs, CTX_FPREG_ALL);
410532ed618SSoby Mathew #endif
411532ed618SSoby Mathew 
412532ed618SSoby Mathew /*
413532ed618SSoby Mathew  * Miscellaneous registers used by EL3 firmware to maintain its state
414532ed618SSoby Mathew  * across exception entries and exits
415532ed618SSoby Mathew  */
416532ed618SSoby Mathew DEFINE_REG_STRUCT(el3_state, CTX_EL3STATE_ALL);
417532ed618SSoby Mathew 
418fe007b2eSDimitris Papastamos /* Function pointer used by CVE-2018-3639 dynamic mitigation */
419fe007b2eSDimitris Papastamos DEFINE_REG_STRUCT(cve_2018_3639, CTX_CVE_2018_3639_ALL);
420fe007b2eSDimitris Papastamos 
4215283962eSAntonio Nino Diaz /* Registers associated to ARMv8.3-PAuth */
4225283962eSAntonio Nino Diaz #if CTX_INCLUDE_PAUTH_REGS
4235283962eSAntonio Nino Diaz DEFINE_REG_STRUCT(pauth, CTX_PAUTH_REGS_ALL);
4245283962eSAntonio Nino Diaz #endif
4255283962eSAntonio Nino Diaz 
426532ed618SSoby Mathew /*
427532ed618SSoby Mathew  * Macros to access members of any of the above structures using their
428532ed618SSoby Mathew  * offsets
429532ed618SSoby Mathew  */
4302fe75a2dSZelalem #define read_ctx_reg(ctx, offset)	((ctx)->ctx_regs[(offset) >> DWORD_SHIFT])
4312fe75a2dSZelalem #define write_ctx_reg(ctx, offset, val)	(((ctx)->ctx_regs[(offset) >> DWORD_SHIFT]) \
432ba6e5ca6SJeenu Viswambharan 					 = (uint64_t) (val))
433532ed618SSoby Mathew 
434532ed618SSoby Mathew /*
435c5ea4f8aSZelalem Aweke  * Top-level context structure which is used by EL3 firmware to preserve
436c5ea4f8aSZelalem Aweke  * the state of a core at the next lower EL in a given security state and
437c5ea4f8aSZelalem Aweke  * save enough EL3 meta data to be able to return to that EL and security
438c5ea4f8aSZelalem Aweke  * state. The context management library will be used to ensure that
439c5ea4f8aSZelalem Aweke  * SP_EL3 always points to an instance of this structure at exception
440c5ea4f8aSZelalem Aweke  * entry and exit.
441532ed618SSoby Mathew  */
442532ed618SSoby Mathew typedef struct cpu_context {
443532ed618SSoby Mathew 	gp_regs_t gpregs_ctx;
444532ed618SSoby Mathew 	el3_state_t el3state_ctx;
4452825946eSMax Shvetsov 	el1_sysregs_t el1_sysregs_ctx;
4462825946eSMax Shvetsov #if CTX_INCLUDE_EL2_REGS
4472825946eSMax Shvetsov 	el2_sysregs_t el2_sysregs_ctx;
4482825946eSMax Shvetsov #endif
449532ed618SSoby Mathew #if CTX_INCLUDE_FPREGS
450532ed618SSoby Mathew 	fp_regs_t fpregs_ctx;
451532ed618SSoby Mathew #endif
452fe007b2eSDimitris Papastamos 	cve_2018_3639_t cve_2018_3639_ctx;
4535283962eSAntonio Nino Diaz #if CTX_INCLUDE_PAUTH_REGS
4545283962eSAntonio Nino Diaz 	pauth_t pauth_ctx;
4555283962eSAntonio Nino Diaz #endif
456532ed618SSoby Mathew } cpu_context_t;
457532ed618SSoby Mathew 
458461c0a5dSElizabeth Ho /*
459461c0a5dSElizabeth Ho  * Per-World Context.
460461c0a5dSElizabeth Ho  * It stores registers whose values can be shared across CPUs.
461461c0a5dSElizabeth Ho  */
462461c0a5dSElizabeth Ho typedef struct per_world_context {
463461c0a5dSElizabeth Ho 	uint64_t ctx_cptr_el3;
464461c0a5dSElizabeth Ho 	uint64_t ctx_zcr_el3;
465461c0a5dSElizabeth Ho } per_world_context_t;
466461c0a5dSElizabeth Ho 
467461c0a5dSElizabeth Ho extern per_world_context_t per_world_context[CPU_DATA_CONTEXT_NUM];
468461c0a5dSElizabeth Ho 
469532ed618SSoby Mathew /* Macros to access members of the 'cpu_context_t' structure */
470532ed618SSoby Mathew #define get_el3state_ctx(h)	(&((cpu_context_t *) h)->el3state_ctx)
471532ed618SSoby Mathew #if CTX_INCLUDE_FPREGS
472532ed618SSoby Mathew # define get_fpregs_ctx(h)	(&((cpu_context_t *) h)->fpregs_ctx)
473532ed618SSoby Mathew #endif
4742825946eSMax Shvetsov #define get_el1_sysregs_ctx(h)	(&((cpu_context_t *) h)->el1_sysregs_ctx)
4752825946eSMax Shvetsov #if CTX_INCLUDE_EL2_REGS
4762825946eSMax Shvetsov # define get_el2_sysregs_ctx(h)	(&((cpu_context_t *) h)->el2_sysregs_ctx)
4772825946eSMax Shvetsov #endif
478532ed618SSoby Mathew #define get_gpregs_ctx(h)	(&((cpu_context_t *) h)->gpregs_ctx)
4796f03bc77SDimitris Papastamos #define get_cve_2018_3639_ctx(h)	(&((cpu_context_t *) h)->cve_2018_3639_ctx)
4805283962eSAntonio Nino Diaz #if CTX_INCLUDE_PAUTH_REGS
4815283962eSAntonio Nino Diaz # define get_pauth_ctx(h)	(&((cpu_context_t *) h)->pauth_ctx)
4825283962eSAntonio Nino Diaz #endif
483532ed618SSoby Mathew 
484532ed618SSoby Mathew /*
485532ed618SSoby Mathew  * Compile time assertions related to the 'cpu_context' structure to
486532ed618SSoby Mathew  * ensure that the assembler and the compiler view of the offsets of
487532ed618SSoby Mathew  * the structure members is the same.
488532ed618SSoby Mathew  */
4899a90d720SElyes Haouas CASSERT(CTX_GPREGS_OFFSET == __builtin_offsetof(cpu_context_t, gpregs_ctx),
490532ed618SSoby Mathew 	assert_core_context_gp_offset_mismatch);
4919a90d720SElyes Haouas CASSERT(CTX_EL1_SYSREGS_OFFSET == __builtin_offsetof(cpu_context_t, el1_sysregs_ctx),
4922825946eSMax Shvetsov 	assert_core_context_el1_sys_offset_mismatch);
4932825946eSMax Shvetsov #if CTX_INCLUDE_EL2_REGS
4949a90d720SElyes Haouas CASSERT(CTX_EL2_SYSREGS_OFFSET == __builtin_offsetof(cpu_context_t, el2_sysregs_ctx),
4952825946eSMax Shvetsov 	assert_core_context_el2_sys_offset_mismatch);
4962825946eSMax Shvetsov #endif
497532ed618SSoby Mathew #if CTX_INCLUDE_FPREGS
4989a90d720SElyes Haouas CASSERT(CTX_FPREGS_OFFSET == __builtin_offsetof(cpu_context_t, fpregs_ctx),
499532ed618SSoby Mathew 	assert_core_context_fp_offset_mismatch);
500532ed618SSoby Mathew #endif
5019a90d720SElyes Haouas CASSERT(CTX_EL3STATE_OFFSET == __builtin_offsetof(cpu_context_t, el3state_ctx),
502532ed618SSoby Mathew 	assert_core_context_el3state_offset_mismatch);
5039a90d720SElyes Haouas CASSERT(CTX_CVE_2018_3639_OFFSET == __builtin_offsetof(cpu_context_t, cve_2018_3639_ctx),
504fe007b2eSDimitris Papastamos 	assert_core_context_cve_2018_3639_offset_mismatch);
5055283962eSAntonio Nino Diaz #if CTX_INCLUDE_PAUTH_REGS
5069a90d720SElyes Haouas CASSERT(CTX_PAUTH_REGS_OFFSET == __builtin_offsetof(cpu_context_t, pauth_ctx),
5075283962eSAntonio Nino Diaz 	assert_core_context_pauth_offset_mismatch);
5085283962eSAntonio Nino Diaz #endif
509532ed618SSoby Mathew 
510532ed618SSoby Mathew /*
511532ed618SSoby Mathew  * Helper macro to set the general purpose registers that correspond to
512532ed618SSoby Mathew  * parameters in an aapcs_64 call i.e. x0-x7
513532ed618SSoby Mathew  */
514532ed618SSoby Mathew #define set_aapcs_args0(ctx, x0)				do {	\
515532ed618SSoby Mathew 		write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X0, x0);	\
516532ed618SSoby Mathew 	} while (0)
517532ed618SSoby Mathew #define set_aapcs_args1(ctx, x0, x1)				do {	\
518532ed618SSoby Mathew 		write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X1, x1);	\
519532ed618SSoby Mathew 		set_aapcs_args0(ctx, x0);				\
520532ed618SSoby Mathew 	} while (0)
521532ed618SSoby Mathew #define set_aapcs_args2(ctx, x0, x1, x2)			do {	\
522532ed618SSoby Mathew 		write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X2, x2);	\
523532ed618SSoby Mathew 		set_aapcs_args1(ctx, x0, x1);				\
524532ed618SSoby Mathew 	} while (0)
525532ed618SSoby Mathew #define set_aapcs_args3(ctx, x0, x1, x2, x3)			do {	\
526532ed618SSoby Mathew 		write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X3, x3);	\
527532ed618SSoby Mathew 		set_aapcs_args2(ctx, x0, x1, x2);			\
528532ed618SSoby Mathew 	} while (0)
529532ed618SSoby Mathew #define set_aapcs_args4(ctx, x0, x1, x2, x3, x4)		do {	\
530532ed618SSoby Mathew 		write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X4, x4);	\
531532ed618SSoby Mathew 		set_aapcs_args3(ctx, x0, x1, x2, x3);			\
532532ed618SSoby Mathew 	} while (0)
533532ed618SSoby Mathew #define set_aapcs_args5(ctx, x0, x1, x2, x3, x4, x5)		do {	\
534532ed618SSoby Mathew 		write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X5, x5);	\
535532ed618SSoby Mathew 		set_aapcs_args4(ctx, x0, x1, x2, x3, x4);		\
536532ed618SSoby Mathew 	} while (0)
537532ed618SSoby Mathew #define set_aapcs_args6(ctx, x0, x1, x2, x3, x4, x5, x6)	do {	\
538532ed618SSoby Mathew 		write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X6, x6);	\
539532ed618SSoby Mathew 		set_aapcs_args5(ctx, x0, x1, x2, x3, x4, x5);		\
540532ed618SSoby Mathew 	} while (0)
541532ed618SSoby Mathew #define set_aapcs_args7(ctx, x0, x1, x2, x3, x4, x5, x6, x7)	do {	\
542532ed618SSoby Mathew 		write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X7, x7);	\
543532ed618SSoby Mathew 		set_aapcs_args6(ctx, x0, x1, x2, x3, x4, x5, x6);	\
544532ed618SSoby Mathew 	} while (0)
545532ed618SSoby Mathew 
546532ed618SSoby Mathew /*******************************************************************************
547532ed618SSoby Mathew  * Function prototypes
548532ed618SSoby Mathew  ******************************************************************************/
5492825946eSMax Shvetsov void el1_sysregs_context_save(el1_sysregs_t *regs);
5502825946eSMax Shvetsov void el1_sysregs_context_restore(el1_sysregs_t *regs);
55128f39f02SMax Shvetsov 
552532ed618SSoby Mathew #if CTX_INCLUDE_FPREGS
553532ed618SSoby Mathew void fpregs_context_save(fp_regs_t *regs);
554532ed618SSoby Mathew void fpregs_context_restore(fp_regs_t *regs);
555532ed618SSoby Mathew #endif
556532ed618SSoby Mathew 
557d5dfdeb6SJulius Werner #endif /* __ASSEMBLER__ */
558532ed618SSoby Mathew 
559a0fee747SAntonio Nino Diaz #endif /* CONTEXT_H */
560